Docs: SPF options
[users/jgh/exim.git] / doc / doc-docbook / spec.xfpt
1 . /////////////////////////////////////////////////////////////////////////////
2 . This is the primary source of the Exim Manual. It is an xfpt document that is
3 . converted into DocBook XML for subsequent conversion into printable and online
4 . formats. The markup used herein is "standard" xfpt markup, with some extras.
5 . The markup is summarized in a file called Markup.txt.
6 .
7 . WARNING: When you use the .new macro, make sure it appears *before* any
8 . adjacent index items; otherwise you get an empty "paragraph" which causes
9 . unwanted vertical space.
10 . /////////////////////////////////////////////////////////////////////////////
11
12 .include stdflags
13 .include stdmacs
14
15 . /////////////////////////////////////////////////////////////////////////////
16 . This outputs the standard DocBook boilerplate.
17 . /////////////////////////////////////////////////////////////////////////////
18
19 .docbook
20
21 . /////////////////////////////////////////////////////////////////////////////
22 . These lines are processing instructions for the Simple DocBook Processor that
23 . Philip Hazel has developed as a less cumbersome way of making PostScript and
24 . PDFs than using xmlto and fop. They will be ignored by all other XML
25 . processors.
26 . /////////////////////////////////////////////////////////////////////////////
27
28 .literal xml
29 <?sdop
30   foot_right_recto="&chaptertitle; (&chapternumber;)"
31   foot_right_verso="&chaptertitle; (&chapternumber;)"
32   toc_chapter_blanks="yes,yes"
33   table_warn_overflow="overprint"
34 ?>
35 .literal off
36
37 . /////////////////////////////////////////////////////////////////////////////
38 . This generates the outermost <book> element that wraps the entire document.
39 . /////////////////////////////////////////////////////////////////////////////
40
41 .book
42
43 . /////////////////////////////////////////////////////////////////////////////
44 . These definitions set some parameters and save some typing.
45 . Update the Copyright year (only) when changing content.
46 . /////////////////////////////////////////////////////////////////////////////
47
48 .set previousversion "4.93"
49 .include ./local_params
50
51 .set ACL "access control lists (ACLs)"
52 .set I   "&nbsp;&nbsp;&nbsp;&nbsp;"
53
54 .macro copyyear
55 2020
56 .endmacro
57
58 . /////////////////////////////////////////////////////////////////////////////
59 . Additional xfpt markup used by this document, over and above the default
60 . provided in the xfpt library.
61 . /////////////////////////////////////////////////////////////////////////////
62
63 . --- Override the &$ flag to automatically insert a $ with the variable name.
64
65 .flag &$  $&   "<varname>$"  "</varname>"
66
67 . --- Short flags for daggers in option headings. They will always be inside
68 . --- an italic string, but we want the daggers to be in Roman.
69
70 .flag &!!      "</emphasis>&dagger;<emphasis>"
71 .flag &!?      "</emphasis>&Dagger;<emphasis>"
72
73 . --- A macro for an Exim option definition heading, generating a one-line
74 . --- table with four columns. For cases when the option name is given with
75 . --- a space, so that it can be split, a fifth argument is used for the
76 . --- index entry.
77
78 .macro option
79 .arg 5
80 .oindex "&%$5%&"
81 .endarg
82 .arg -5
83 .oindex "&%$1%&"
84 .endarg
85 .itable all 0 0 4 8* left 6* center 6* center 6* right
86 .row "&%$1%&" "Use: &'$2'&" "Type: &'$3'&" "Default: &'$4'&"
87 .endtable
88 .endmacro
89
90 . --- A macro for the common 2-column tables. The width of the first column
91 . --- is suitable for the many tables at the start of the main options chapter;
92 . --- a small number of other 2-column tables override it.
93
94 .macro table2 196pt 254pt
95 .itable none 0 0 2 $1 left $2 left
96 .endmacro
97
98 . --- A macro that generates .row, but puts &I; at the start of the first
99 . --- argument, thus indenting it. Assume a minimum of two arguments, and
100 . --- allow up to four arguments, which is as many as we'll ever need.
101
102 .macro irow
103 .arg 4
104 .row "&I;$1" "$2" "$3" "$4"
105 .endarg
106 .arg -4
107 .arg 3
108 .row "&I;$1" "$2" "$3"
109 .endarg
110 .arg -3
111 .row "&I;$1" "$2"
112 .endarg
113 .endarg
114 .endmacro
115
116 . --- Macros for option, variable, and concept index entries. For a "range"
117 . --- style of entry, use .scindex for the start and .ecindex for the end. The
118 . --- first argument of .scindex and the only argument of .ecindex must be the
119 . --- ID that ties them together.
120
121 .macro cindex
122 &<indexterm role="concept">&
123 &<primary>&$1&</primary>&
124 .arg 2
125 &<secondary>&$2&</secondary>&
126 .endarg
127 &</indexterm>&
128 .endmacro
129
130 .macro scindex
131 &<indexterm role="concept" id="$1" class="startofrange">&
132 &<primary>&$2&</primary>&
133 .arg 3
134 &<secondary>&$3&</secondary>&
135 .endarg
136 &</indexterm>&
137 .endmacro
138
139 .macro ecindex
140 &<indexterm role="concept" startref="$1" class="endofrange"/>&
141 .endmacro
142
143 .macro oindex
144 &<indexterm role="option">&
145 &<primary>&$1&</primary>&
146 .arg 2
147 &<secondary>&$2&</secondary>&
148 .endarg
149 &</indexterm>&
150 .endmacro
151
152 .macro vindex
153 &<indexterm role="variable">&
154 &<primary>&$1&</primary>&
155 .arg 2
156 &<secondary>&$2&</secondary>&
157 .endarg
158 &</indexterm>&
159 .endmacro
160
161 .macro index
162 .echo "** Don't use .index; use .cindex or .oindex or .vindex"
163 .endmacro
164 . ////////////////////////////////////////////////////////////////////////////
165
166
167 . ////////////////////////////////////////////////////////////////////////////
168 . The <bookinfo> element is removed from the XML before processing for ASCII
169 . output formats.
170 . ////////////////////////////////////////////////////////////////////////////
171
172 .literal xml
173 <bookinfo>
174 <title>Specification of the Exim Mail Transfer Agent</title>
175 <titleabbrev>The Exim MTA</titleabbrev>
176 <date>
177 .fulldate
178 </date>
179 <author><firstname>Exim</firstname><surname>Maintainers</surname></author>
180 <authorinitials>EM</authorinitials>
181 <revhistory><revision>
182 .versiondatexml
183   <authorinitials>EM</authorinitials>
184 </revision></revhistory>
185 <copyright><year>
186 .copyyear
187            </year><holder>University of Cambridge</holder></copyright>
188 </bookinfo>
189 .literal off
190
191
192 . /////////////////////////////////////////////////////////////////////////////
193 . This chunk of literal XML implements index entries of the form "x, see y" and
194 . "x, see also y". However, the DocBook DTD doesn't allow <indexterm> entries
195 . at the top level, so we have to put the .chapter directive first.
196 . /////////////////////////////////////////////////////////////////////////////
197
198 .chapter "Introduction" "CHID1"
199 .literal xml
200
201 <indexterm role="variable">
202   <primary>$1, $2, etc.</primary>
203   <see><emphasis>numerical variables</emphasis></see>
204 </indexterm>
205 <indexterm role="concept">
206   <primary>address</primary>
207   <secondary>rewriting</secondary>
208   <see><emphasis>rewriting</emphasis></see>
209 </indexterm>
210 <indexterm role="concept">
211   <primary>Bounce Address Tag Validation</primary>
212   <see><emphasis>BATV</emphasis></see>
213 </indexterm>
214 <indexterm role="concept">
215   <primary>Client SMTP Authorization</primary>
216   <see><emphasis>CSA</emphasis></see>
217 </indexterm>
218 <indexterm role="concept">
219   <primary>CR character</primary>
220   <see><emphasis>carriage return</emphasis></see>
221 </indexterm>
222 <indexterm role="concept">
223   <primary>CRL</primary>
224   <see><emphasis>certificate revocation list</emphasis></see>
225 </indexterm>
226 <indexterm role="concept">
227   <primary>delivery</primary>
228   <secondary>failure report</secondary>
229   <see><emphasis>bounce message</emphasis></see>
230 </indexterm>
231 <indexterm role="concept">
232   <primary>dialup</primary>
233   <see><emphasis>intermittently connected hosts</emphasis></see>
234 </indexterm>
235 <indexterm role="concept">
236   <primary>exiscan</primary>
237   <see><emphasis>content scanning</emphasis></see>
238 </indexterm>
239 <indexterm role="concept">
240   <primary>failover</primary>
241   <see><emphasis>fallback</emphasis></see>
242 </indexterm>
243 <indexterm role="concept">
244   <primary>fallover</primary>
245   <see><emphasis>fallback</emphasis></see>
246 </indexterm>
247 <indexterm role="concept">
248   <primary>filter</primary>
249   <secondary>Sieve</secondary>
250   <see><emphasis>Sieve filter</emphasis></see>
251 </indexterm>
252 <indexterm role="concept">
253   <primary>ident</primary>
254   <see><emphasis>RFC 1413</emphasis></see>
255 </indexterm>
256 <indexterm role="concept">
257   <primary>LF character</primary>
258   <see><emphasis>linefeed</emphasis></see>
259 </indexterm>
260 <indexterm role="concept">
261   <primary>maximum</primary>
262   <seealso><emphasis>limit</emphasis></seealso>
263 </indexterm>
264 <indexterm role="concept">
265   <primary>monitor</primary>
266   <see><emphasis>Exim monitor</emphasis></see>
267 </indexterm>
268 <indexterm role="concept">
269   <primary>no_<emphasis>xxx</emphasis></primary>
270   <see>entry for xxx</see>
271 </indexterm>
272 <indexterm role="concept">
273   <primary>NUL</primary>
274   <see><emphasis>binary zero</emphasis></see>
275 </indexterm>
276 <indexterm role="concept">
277   <primary>passwd file</primary>
278   <see><emphasis>/etc/passwd</emphasis></see>
279 </indexterm>
280 <indexterm role="concept">
281   <primary>process id</primary>
282   <see><emphasis>pid</emphasis></see>
283 </indexterm>
284 <indexterm role="concept">
285   <primary>RBL</primary>
286   <see><emphasis>DNS list</emphasis></see>
287 </indexterm>
288 <indexterm role="concept">
289   <primary>redirection</primary>
290   <see><emphasis>address redirection</emphasis></see>
291 </indexterm>
292 <indexterm role="concept">
293   <primary>return path</primary>
294   <seealso><emphasis>envelope sender</emphasis></seealso>
295 </indexterm>
296 <indexterm role="concept">
297   <primary>scanning</primary>
298   <see><emphasis>content scanning</emphasis></see>
299 </indexterm>
300 <indexterm role="concept">
301   <primary>SSL</primary>
302   <see><emphasis>TLS</emphasis></see>
303 </indexterm>
304 <indexterm role="concept">
305   <primary>string</primary>
306   <secondary>expansion</secondary>
307   <see><emphasis>expansion</emphasis></see>
308 </indexterm>
309 <indexterm role="concept">
310   <primary>top bit</primary>
311   <see><emphasis>8-bit characters</emphasis></see>
312 </indexterm>
313 <indexterm role="concept">
314   <primary>variables</primary>
315   <see><emphasis>expansion, variables</emphasis></see>
316 </indexterm>
317 <indexterm role="concept">
318   <primary>zero, binary</primary>
319   <see><emphasis>binary zero</emphasis></see>
320 </indexterm>
321
322 .literal off
323
324
325 . /////////////////////////////////////////////////////////////////////////////
326 . This is the real start of the first chapter. See the comment above as to why
327 . we can't have the .chapter line here.
328 . chapter "Introduction"
329 . /////////////////////////////////////////////////////////////////////////////
330
331 Exim is a mail transfer agent (MTA) for hosts that are running Unix or
332 Unix-like operating systems. It was designed on the assumption that it would be
333 run on hosts that are permanently connected to the Internet. However, it can be
334 used on intermittently connected hosts with suitable configuration adjustments.
335
336 Configuration files currently exist for the following operating systems: AIX,
337 BSD/OS (aka BSDI), Darwin (Mac OS X), DGUX, Dragonfly, FreeBSD, GNU/Hurd,
338 GNU/Linux, HI-OSF (Hitachi), HI-UX, HP-UX, IRIX, MIPS RISCOS, NetBSD, OpenBSD,
339 OpenUNIX, QNX, SCO, SCO SVR4.2 (aka UNIX-SV), Solaris (aka SunOS5), SunOS4,
340 Tru64-Unix (formerly Digital UNIX, formerly DEC-OSF1), Ultrix, and UnixWare.
341 Some of these operating systems are no longer current and cannot easily be
342 tested, so the configuration files may no longer work in practice.
343
344 There are also configuration files for compiling Exim in the Cygwin environment
345 that can be installed on systems running Windows. However, this document does
346 not contain any information about running Exim in the Cygwin environment.
347
348 The terms and conditions for the use and distribution of Exim are contained in
349 the file &_NOTICE_&. Exim is distributed under the terms of the GNU General
350 Public Licence, a copy of which may be found in the file &_LICENCE_&.
351
352 The use, supply, or promotion of Exim for the purpose of sending bulk,
353 unsolicited electronic mail is incompatible with the basic aims of Exim,
354 which revolve around the free provision of a service that enhances the quality
355 of personal communications. The author of Exim regards indiscriminate
356 mass-mailing as an antisocial, irresponsible abuse of the Internet.
357
358 Exim owes a great deal to Smail 3 and its author, Ron Karr. Without the
359 experience of running and working on the Smail 3 code, I could never have
360 contemplated starting to write a new MTA. Many of the ideas and user interfaces
361 were originally taken from Smail 3, though the actual code of Exim is entirely
362 new, and has developed far beyond the initial concept.
363
364 Many people, both in Cambridge and around the world, have contributed to the
365 development and the testing of Exim, and to porting it to various operating
366 systems. I am grateful to them all. The distribution now contains a file called
367 &_ACKNOWLEDGMENTS_&, in which I have started recording the names of
368 contributors.
369
370
371 .section "Exim documentation" "SECID1"
372 . Keep this example change bar when updating the documentation!
373
374 .new
375 .cindex "documentation"
376 This edition of the Exim specification applies to version &version() of Exim.
377 Substantive changes from the &previousversion; edition are marked in some
378 renditions of this document; this paragraph is so marked if the rendition is
379 capable of showing a change indicator.
380 .wen
381
382 This document is very much a reference manual; it is not a tutorial. The reader
383 is expected to have some familiarity with the SMTP mail transfer protocol and
384 with general Unix system administration. Although there are some discussions
385 and examples in places, the information is mostly organized in a way that makes
386 it easy to look up, rather than in a natural order for sequential reading.
387 Furthermore, this manual aims to cover every aspect of Exim in detail, including
388 a number of rarely-used, special-purpose features that are unlikely to be of
389 very wide interest.
390
391 .cindex "books about Exim"
392 An &"easier"& discussion of Exim which provides more in-depth explanatory,
393 introductory, and tutorial material can be found in a book entitled &'The Exim
394 SMTP Mail Server'& (second edition, 2007), published by UIT Cambridge
395 (&url(https://www.uit.co.uk/exim-book/)).
396
397 The book also contains a chapter that gives a general introduction to SMTP and
398 Internet mail. Inevitably, however, the book is unlikely to be fully up-to-date
399 with the latest release of Exim. (Note that the earlier book about Exim,
400 published by O'Reilly, covers Exim 3, and many things have changed in Exim 4.)
401
402 .cindex "Debian" "information sources"
403 If you are using a Debian distribution of Exim, you will find information about
404 Debian-specific features in the file
405 &_/usr/share/doc/exim4-base/README.Debian_&.
406 The command &(man update-exim.conf)& is another source of Debian-specific
407 information.
408
409 .cindex "&_doc/NewStuff_&"
410 .cindex "&_doc/ChangeLog_&"
411 .cindex "change log"
412 As Exim develops, there may be features in newer versions that have not
413 yet made it into this document, which is updated only when the most significant
414 digit of the fractional part of the version number changes. Specifications of
415 new features that are not yet in this manual are placed in the file
416 &_doc/NewStuff_& in the Exim distribution.
417
418 Some features may be classified as &"experimental"&. These may change
419 incompatibly while they are developing, or even be withdrawn. For this reason,
420 they are not documented in this manual. Information about experimental features
421 can be found in the file &_doc/experimental.txt_&.
422
423 All changes to Exim (whether new features, bug fixes, or other kinds of
424 change) are noted briefly in the file called &_doc/ChangeLog_&.
425
426 .cindex "&_doc/spec.txt_&"
427 This specification itself is available as an ASCII file in &_doc/spec.txt_& so
428 that it can easily be searched with a text editor. Other files in the &_doc_&
429 directory are:
430
431 .table2 100pt
432 .row &_OptionLists.txt_&     "list of all options in alphabetical order"
433 .row &_dbm.discuss.txt_&     "discussion about DBM libraries"
434 .row &_exim.8_&              "a man page of Exim's command line options"
435 .row &_experimental.txt_&    "documentation of experimental features"
436 .row &_filter.txt_&          "specification of the filter language"
437 .row &_Exim3.upgrade_&       "upgrade notes from release 2 to release 3"
438 .row &_Exim4.upgrade_&       "upgrade notes from release 3 to release 4"
439 .row &_openssl.txt_&         "installing a current OpenSSL release"
440 .endtable
441
442 The main specification and the specification of the filtering language are also
443 available in other formats (HTML, PostScript, PDF, and Texinfo). Section
444 &<<SECTavail>>& below tells you how to get hold of these.
445
446
447
448 .section "FTP site and websites" "SECID2"
449 .cindex "website"
450 .cindex "FTP site"
451 The primary site for Exim source distributions is the &%exim.org%& FTP site,
452 available over HTTPS, HTTP and FTP.  These services, and the &%exim.org%&
453 website, are hosted at the University of Cambridge.
454
455 .cindex "wiki"
456 .cindex "FAQ"
457 As well as Exim distribution tar files, the Exim website contains a number of
458 differently formatted versions of the documentation. A recent addition to the
459 online information is the Exim wiki (&url(https://wiki.exim.org)),
460 which contains what used to be a separate FAQ, as well as various other
461 examples, tips, and know-how that have been contributed by Exim users.
462 The wiki site should always redirect to the correct place, which is currently
463 provided by GitHub, and is open to editing by anyone with a GitHub account.
464
465 .cindex Bugzilla
466 An Exim Bugzilla exists at &url(https://bugs.exim.org). You can use
467 this to report bugs, and also to add items to the wish list. Please search
468 first to check that you are not duplicating a previous entry.
469 Please do not ask for configuration help in the bug-tracker.
470
471
472 .section "Mailing lists" "SECID3"
473 .cindex "mailing lists" "for Exim users"
474 The following Exim mailing lists exist:
475
476 .table2 140pt
477 .row &'exim-announce@exim.org'&   "Moderated, low volume announcements list"
478 .row &'exim-users@exim.org'&      "General discussion list"
479 .row &'exim-dev@exim.org'&        "Discussion of bugs, enhancements, etc."
480 .row &'exim-cvs@exim.org'&        "Automated commit messages from the VCS"
481 .endtable
482
483 You can subscribe to these lists, change your existing subscriptions, and view
484 or search the archives via the mailing lists link on the Exim home page.
485 .cindex "Debian" "mailing list for"
486 If you are using a Debian distribution of Exim, you may wish to subscribe to
487 the Debian-specific mailing list &'pkg-exim4-users@lists.alioth.debian.org'&
488 via this web page:
489 .display
490 &url(https://alioth-lists.debian.net/cgi-bin/mailman/listinfo/pkg-exim4-users)
491 .endd
492 Please ask Debian-specific questions on that list and not on the general Exim
493 lists.
494
495 .section "Bug reports" "SECID5"
496 .cindex "bug reports"
497 .cindex "reporting bugs"
498 Reports of obvious bugs can be emailed to &'bugs@exim.org'& or reported
499 via the Bugzilla (&url(https://bugs.exim.org)). However, if you are unsure
500 whether some behaviour is a bug or not, the best thing to do is to post a
501 message to the &'exim-dev'& mailing list and have it discussed.
502
503
504
505 .section "Where to find the Exim distribution" "SECTavail"
506 .cindex "FTP site"
507 .cindex "HTTPS download site"
508 .cindex "distribution" "FTP site"
509 .cindex "distribution" "https site"
510 The master distribution site for the Exim distribution is
511 .display
512 &url(https://downloads.exim.org/)
513 .endd
514 The service is available over HTTPS, HTTP and FTP.
515 We encourage people to migrate to HTTPS.
516
517 The content served at &url(https://downloads.exim.org/) is identical to the
518 content served at &url(https://ftp.exim.org/pub/exim) and
519 &url(ftp://ftp.exim.org/pub/exim).
520
521 If accessing via a hostname containing &'ftp'&, then the file references that
522 follow are relative to the &_exim_& directories at these sites.
523 If accessing via the hostname &'downloads'& then the subdirectories described
524 here are top-level directories.
525
526 There are now quite a number of independent mirror sites around
527 the world. Those that I know about are listed in the file called &_Mirrors_&.
528
529 Within the top exim directory there are subdirectories called &_exim3_& (for
530 previous Exim 3 distributions), &_exim4_& (for the latest Exim 4
531 distributions), and &_Testing_& for testing versions. In the &_exim4_&
532 subdirectory, the current release can always be found in files called
533 .display
534 &_exim-n.nn.tar.xz_&
535 &_exim-n.nn.tar.gz_&
536 &_exim-n.nn.tar.bz2_&
537 .endd
538 where &'n.nn'& is the highest such version number in the directory. The three
539 files contain identical data; the only difference is the type of compression.
540 The &_.xz_& file is usually the smallest, while the &_.gz_& file is the
541 most portable to old systems.
542
543 .cindex "distribution" "signing details"
544 .cindex "distribution" "public key"
545 .cindex "public key for signed distribution"
546 The distributions will be PGP signed by an individual key of the Release
547 Coordinator.  This key will have a uid containing an email address in the
548 &'exim.org'& domain and will have signatures from other people, including
549 other Exim maintainers.  We expect that the key will be in the "strong set" of
550 PGP keys.  There should be a trust path to that key from the Exim Maintainer's
551 PGP keys, a version of which can be found in the release directory in the file
552 &_Exim-Maintainers-Keyring.asc_&.  All keys used will be available in public keyserver pools,
553 such as &'pool.sks-keyservers.net'&.
554
555 At the time of the last update, releases were being made by Jeremy Harris and signed
556 with key &'0xBCE58C8CE41F32DF'&.  Other recent keys used for signing are those
557 of Heiko Schlittermann, &'0x26101B62F69376CE'&,
558 and of Phil Pennock, &'0x4D1E900E14C1CC04'&.
559
560 The signatures for the tar bundles are in:
561 .display
562 &_exim-n.nn.tar.xz.asc_&
563 &_exim-n.nn.tar.gz.asc_&
564 &_exim-n.nn.tar.bz2.asc_&
565 .endd
566 For each released version, the log of changes is made available in a
567 separate file in the directory &_ChangeLogs_& so that it is possible to
568 find out what has changed without having to download the entire distribution.
569
570 .cindex "documentation" "available formats"
571 The main distribution contains ASCII versions of this specification and other
572 documentation; other formats of the documents are available in separate files
573 inside the &_exim4_& directory of the FTP site:
574 .display
575 &_exim-html-n.nn.tar.gz_&
576 &_exim-pdf-n.nn.tar.gz_&
577 &_exim-postscript-n.nn.tar.gz_&
578 &_exim-texinfo-n.nn.tar.gz_&
579 .endd
580 These tar files contain only the &_doc_& directory, not the complete
581 distribution, and are also available in &_.bz2_& and &_.xz_& forms.
582
583
584 .section "Limitations" "SECID6"
585 .ilist
586 .cindex "limitations of Exim"
587 .cindex "bang paths" "not handled by Exim"
588 Exim is designed for use as an Internet MTA, and therefore handles addresses in
589 RFC 2822 domain format only. It cannot handle UUCP &"bang paths"&, though
590 simple two-component bang paths can be converted by a straightforward rewriting
591 configuration. This restriction does not prevent Exim from being interfaced to
592 UUCP as a transport mechanism, provided that domain addresses are used.
593 .next
594 .cindex "domainless addresses"
595 .cindex "address" "without domain"
596 Exim insists that every address it handles has a domain attached. For incoming
597 local messages, domainless addresses are automatically qualified with a
598 configured domain value. Configuration options specify from which remote
599 systems unqualified addresses are acceptable. These are then qualified on
600 arrival.
601 .next
602 .cindex "transport" "external"
603 .cindex "external transports"
604 The only external transport mechanisms that are currently implemented are SMTP
605 and LMTP over a TCP/IP network (including support for IPv6). However, a pipe
606 transport is available, and there are facilities for writing messages to files
607 and pipes, optionally in &'batched SMTP'& format; these facilities can be used
608 to send messages to other transport mechanisms such as UUCP, provided they can
609 handle domain-style addresses. Batched SMTP input is also catered for.
610 .next
611 Exim is not designed for storing mail for dial-in hosts. When the volumes of
612 such mail are large, it is better to get the messages &"delivered"& into files
613 (that is, off Exim's queue) and subsequently passed on to the dial-in hosts by
614 other means.
615 .next
616 Although Exim does have basic facilities for scanning incoming messages, these
617 are not comprehensive enough to do full virus or spam scanning. Such operations
618 are best carried out using additional specialized software packages. If you
619 compile Exim with the content-scanning extension, straightforward interfaces to
620 a number of common scanners are provided.
621 .endlist
622
623
624 .section "Runtime configuration" "SECID7"
625 Exim's runtime configuration is held in a single text file that is divided
626 into a number of sections. The entries in this file consist of keywords and
627 values, in the style of Smail 3 configuration files. A default configuration
628 file which is suitable for simple online installations is provided in the
629 distribution, and is described in chapter &<<CHAPdefconfil>>& below.
630
631
632 .section "Calling interface" "SECID8"
633 .cindex "Sendmail compatibility" "command line interface"
634 Like many MTAs, Exim has adopted the Sendmail command line interface so that it
635 can be a straight replacement for &_/usr/lib/sendmail_& or
636 &_/usr/sbin/sendmail_& when sending mail, but you do not need to know anything
637 about Sendmail in order to run Exim. For actions other than sending messages,
638 Sendmail-compatible options also exist, but those that produce output (for
639 example, &%-bp%&, which lists the messages in the queue) do so in Exim's own
640 format. There are also some additional options that are compatible with Smail
641 3, and some further options that are new to Exim. Chapter &<<CHAPcommandline>>&
642 documents all Exim's command line options. This information is automatically
643 made into the man page that forms part of the Exim distribution.
644
645 Control of messages in the queue can be done via certain privileged command
646 line options. There is also an optional monitor program called &'eximon'&,
647 which displays current information in an X window, and which contains a menu
648 interface to Exim's command line administration options.
649
650
651
652 .section "Terminology" "SECID9"
653 .cindex "terminology definitions"
654 .cindex "body of message" "definition of"
655 The &'body'& of a message is the actual data that the sender wants to transmit.
656 It is the last part of a message and is separated from the &'header'& (see
657 below) by a blank line.
658
659 .cindex "bounce message" "definition of"
660 When a message cannot be delivered, it is normally returned to the sender in a
661 delivery failure message or a &"non-delivery report"& (NDR). The term
662 &'bounce'& is commonly used for this action, and the error reports are often
663 called &'bounce messages'&. This is a convenient shorthand for &"delivery
664 failure error report"&. Such messages have an empty sender address in the
665 message's &'envelope'& (see below) to ensure that they cannot themselves give
666 rise to further bounce messages.
667
668 The term &'default'& appears frequently in this manual. It is used to qualify a
669 value which is used in the absence of any setting in the configuration. It may
670 also qualify an action which is taken unless a configuration setting specifies
671 otherwise.
672
673 The term &'defer'& is used when the delivery of a message to a specific
674 destination cannot immediately take place for some reason (a remote host may be
675 down, or a user's local mailbox may be full). Such deliveries are &'deferred'&
676 until a later time.
677
678 The word &'domain'& is sometimes used to mean all but the first component of a
679 host's name. It is &'not'& used in that sense here, where it normally refers to
680 the part of an email address following the @ sign.
681
682 .cindex "envelope, definition of"
683 .cindex "sender" "definition of"
684 A message in transit has an associated &'envelope'&, as well as a header and a
685 body. The envelope contains a sender address (to which bounce messages should
686 be delivered), and any number of recipient addresses. References to the
687 sender or the recipients of a message usually mean the addresses in the
688 envelope. An MTA uses these addresses for delivery, and for returning bounce
689 messages, not the addresses that appear in the header lines.
690
691 .cindex "message" "header, definition of"
692 .cindex "header section" "definition of"
693 The &'header'& of a message is the first part of a message's text, consisting
694 of a number of lines, each of which has a name such as &'From:'&, &'To:'&,
695 &'Subject:'&, etc. Long header lines can be split over several text lines by
696 indenting the continuations. The header is separated from the body by a blank
697 line.
698
699 .cindex "local part" "definition of"
700 .cindex "domain" "definition of"
701 The term &'local part'&, which is taken from RFC 2822, is used to refer to the
702 part of an email address that precedes the @ sign. The part that follows the
703 @ sign is called the &'domain'& or &'mail domain'&.
704
705 .cindex "local delivery" "definition of"
706 .cindex "remote delivery, definition of"
707 The terms &'local delivery'& and &'remote delivery'& are used to distinguish
708 delivery to a file or a pipe on the local host from delivery by SMTP over
709 TCP/IP to another host. As far as Exim is concerned, all hosts other than the
710 host it is running on are &'remote'&.
711
712 .cindex "return path" "definition of"
713 &'Return path'& is another name that is used for the sender address in a
714 message's envelope.
715
716 .cindex "queue" "definition of"
717 The term &'queue'& is used to refer to the set of messages awaiting delivery
718 because this term is in widespread use in the context of MTAs. However, in
719 Exim's case, the reality is more like a pool than a queue, because there is
720 normally no ordering of waiting messages.
721
722 .cindex "queue runner" "definition of"
723 The term &'queue runner'& is used to describe a process that scans the queue
724 and attempts to deliver those messages whose retry times have come. This term
725 is used by other MTAs and also relates to the command &%runq%&, but in Exim
726 the waiting messages are normally processed in an unpredictable order.
727
728 .cindex "spool directory" "definition of"
729 The term &'spool directory'& is used for a directory in which Exim keeps the
730 messages in its queue &-- that is, those that it is in the process of
731 delivering. This should not be confused with the directory in which local
732 mailboxes are stored, which is called a &"spool directory"& by some people. In
733 the Exim documentation, &"spool"& is always used in the first sense.
734
735
736
737
738
739
740 . ////////////////////////////////////////////////////////////////////////////
741 . ////////////////////////////////////////////////////////////////////////////
742
743 .chapter "Incorporated code" "CHID2"
744 .cindex "incorporated code"
745 .cindex "regular expressions" "library"
746 .cindex "PCRE"
747 .cindex "OpenDMARC"
748 A number of pieces of external code are included in the Exim distribution.
749
750 .ilist
751 Regular expressions are supported in the main Exim program and in the
752 Exim monitor using the freely-distributable PCRE library, copyright
753 &copy; University of Cambridge. The source to PCRE is no longer shipped with
754 Exim, so you will need to use the version of PCRE shipped with your system,
755 or obtain and install the full version of the library from
756 &url(ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre).
757 .next
758 .cindex "cdb" "acknowledgment"
759 Support for the cdb (Constant DataBase) lookup method is provided by code
760 contributed by Nigel Metheringham of (at the time he contributed it) Planet
761 Online Ltd. The implementation is completely contained within the code of Exim.
762 It does not link against an external cdb library. The code contains the
763 following statements:
764
765 .blockquote
766 Copyright &copy; 1998 Nigel Metheringham, Planet Online Ltd
767
768 This program is free software; you can redistribute it and/or modify it under
769 the terms of the GNU General Public License as published by the Free Software
770 Foundation; either version 2 of the License, or (at your option) any later
771 version.
772 This code implements Dan Bernstein's Constant DataBase (cdb) spec. Information,
773 the spec and sample code for cdb can be obtained from
774 &url(https://cr.yp.to/cdb.html). This implementation borrows
775 some code from Dan Bernstein's implementation (which has no license
776 restrictions applied to it).
777 .endblockquote
778 .next
779 .cindex "SPA authentication"
780 .cindex "Samba project"
781 .cindex "Microsoft Secure Password Authentication"
782 Client support for Microsoft's &'Secure Password Authentication'& is provided
783 by code contributed by Marc Prud'hommeaux. Server support was contributed by
784 Tom Kistner. This includes code taken from the Samba project, which is released
785 under the Gnu GPL.
786 .next
787 .cindex "Cyrus"
788 .cindex "&'pwcheck'& daemon"
789 .cindex "&'pwauthd'& daemon"
790 Support for calling the Cyrus &'pwcheck'& and &'saslauthd'& daemons is provided
791 by code taken from the Cyrus-SASL library and adapted by Alexander S.
792 Sabourenkov. The permission notice appears below, in accordance with the
793 conditions expressed therein.
794
795 .blockquote
796 Copyright &copy; 2001 Carnegie Mellon University.  All rights reserved.
797
798 Redistribution and use in source and binary forms, with or without
799 modification, are permitted provided that the following conditions
800 are met:
801
802 .olist
803 Redistributions of source code must retain the above copyright
804 notice, this list of conditions and the following disclaimer.
805 .next
806 Redistributions in binary form must reproduce the above copyright
807 notice, this list of conditions and the following disclaimer in
808 the documentation and/or other materials provided with the
809 distribution.
810 .next
811 The name &"Carnegie Mellon University"& must not be used to
812 endorse or promote products derived from this software without
813 prior written permission. For permission or any other legal
814 details, please contact
815 .display
816               Office of Technology Transfer
817               Carnegie Mellon University
818               5000 Forbes Avenue
819               Pittsburgh, PA  15213-3890
820               (412) 268-4387, fax: (412) 268-7395
821               tech-transfer@andrew.cmu.edu
822 .endd
823 .next
824 Redistributions of any form whatsoever must retain the following
825 acknowledgment:
826
827 &"This product includes software developed by Computing Services
828 at Carnegie Mellon University (&url(https://www.cmu.edu/computing/)."&
829
830 CARNEGIE MELLON UNIVERSITY DISCLAIMS ALL WARRANTIES WITH REGARD TO
831 THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
832 AND FITNESS, IN NO EVENT SHALL CARNEGIE MELLON UNIVERSITY BE LIABLE
833 FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
834 WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN
835 AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING
836 OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
837 .endlist
838 .endblockquote
839
840 .next
841 .cindex "Exim monitor" "acknowledgment"
842 .cindex "X-windows"
843 .cindex "Athena"
844 The Exim Monitor program, which is an X-Window application, includes
845 modified versions of the Athena StripChart and TextPop widgets.
846 This code is copyright by DEC and MIT, and their permission notice appears
847 below, in accordance with the conditions expressed therein.
848
849 .blockquote
850 Copyright 1987, 1988 by Digital Equipment Corporation, Maynard, Massachusetts,
851 and the Massachusetts Institute of Technology, Cambridge, Massachusetts.
852
853 All Rights Reserved
854
855 Permission to use, copy, modify, and distribute this software and its
856 documentation for any purpose and without fee is hereby granted,
857 provided that the above copyright notice appear in all copies and that
858 both that copyright notice and this permission notice appear in
859 supporting documentation, and that the names of Digital or MIT not be
860 used in advertising or publicity pertaining to distribution of the
861 software without specific, written prior permission.
862
863 DIGITAL DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING
864 ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL
865 DIGITAL BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR
866 ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
867 WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION,
868 ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
869 SOFTWARE.
870 .endblockquote
871
872 .next
873 .cindex "opendmarc" "acknowledgment"
874 The DMARC implementation uses the OpenDMARC library which is Copyrighted by
875 The Trusted Domain Project. Portions of Exim source which use OpenDMARC
876 derived code are indicated in the respective source files. The full OpenDMARC
877 license is provided in the LICENSE.opendmarc file contained in the distributed
878 source code.
879
880 .next
881 Many people have contributed code fragments, some large, some small, that were
882 not covered by any specific license requirements. It is assumed that the
883 contributors are happy to see their code incorporated into Exim under the GPL.
884 .endlist
885
886
887
888
889
890 . ////////////////////////////////////////////////////////////////////////////
891 . ////////////////////////////////////////////////////////////////////////////
892
893 .chapter "How Exim receives and delivers mail" "CHID11" &&&
894          "Receiving and delivering mail"
895
896
897 .section "Overall philosophy" "SECID10"
898 .cindex "design philosophy"
899 Exim is designed to work efficiently on systems that are permanently connected
900 to the Internet and are handling a general mix of mail. In such circumstances,
901 most messages can be delivered immediately. Consequently, Exim does not
902 maintain independent queues of messages for specific domains or hosts, though
903 it does try to send several messages in a single SMTP connection after a host
904 has been down, and it also maintains per-host retry information.
905
906
907 .section "Policy control" "SECID11"
908 .cindex "policy control" "overview"
909 Policy controls are now an important feature of MTAs that are connected to the
910 Internet. Perhaps their most important job is to stop MTAs from being abused as
911 &"open relays"& by misguided individuals who send out vast amounts of
912 unsolicited junk and want to disguise its source. Exim provides flexible
913 facilities for specifying policy controls on incoming mail:
914
915 .ilist
916 .cindex "&ACL;" "introduction"
917 Exim 4 (unlike previous versions of Exim) implements policy controls on
918 incoming mail by means of &'Access Control Lists'& (ACLs). Each list is a
919 series of statements that may either grant or deny access. ACLs can be used at
920 several places in the SMTP dialogue while receiving a message from a remote
921 host. However, the most common places are after each RCPT command, and at the
922 very end of the message. The sysadmin can specify conditions for accepting or
923 rejecting individual recipients or the entire message, respectively, at these
924 two points (see chapter &<<CHAPACL>>&). Denial of access results in an SMTP
925 error code.
926 .next
927 An ACL is also available for locally generated, non-SMTP messages. In this
928 case, the only available actions are to accept or deny the entire message.
929 .next
930 When Exim is compiled with the content-scanning extension, facilities are
931 provided in the ACL mechanism for passing the message to external virus and/or
932 spam scanning software. The result of such a scan is passed back to the ACL,
933 which can then use it to decide what to do with the message.
934 .next
935 When a message has been received, either from a remote host or from the local
936 host, but before the final acknowledgment has been sent, a locally supplied C
937 function called &[local_scan()]& can be run to inspect the message and decide
938 whether to accept it or not (see chapter &<<CHAPlocalscan>>&). If the message
939 is accepted, the list of recipients can be modified by the function.
940 .next
941 Using the &[local_scan()]& mechanism is another way of calling external scanner
942 software. The &%SA-Exim%& add-on package works this way. It does not require
943 Exim to be compiled with the content-scanning extension.
944 .next
945 After a message has been accepted, a further checking mechanism is available in
946 the form of the &'system filter'& (see chapter &<<CHAPsystemfilter>>&). This
947 runs at the start of every delivery process.
948 .endlist
949
950
951
952 .section "User filters" "SECID12"
953 .cindex "filter" "introduction"
954 .cindex "Sieve filter"
955 In a conventional Exim configuration, users are able to run private filters by
956 setting up appropriate &_.forward_& files in their home directories. See
957 chapter &<<CHAPredirect>>& (about the &(redirect)& router) for the
958 configuration needed to support this, and the separate document entitled
959 &'Exim's interfaces to mail filtering'& for user details. Two different kinds
960 of filtering are available:
961
962 .ilist
963 Sieve filters are written in the standard filtering language that is defined
964 by RFC 3028.
965 .next
966 Exim filters are written in a syntax that is unique to Exim, but which is more
967 powerful than Sieve, which it pre-dates.
968 .endlist
969
970 User filters are run as part of the routing process, described below.
971
972
973
974 .section "Message identification" "SECTmessiden"
975 .cindex "message ids" "details of format"
976 .cindex "format" "of message id"
977 .cindex "id of message"
978 .cindex "base62"
979 .cindex "base36"
980 .cindex "Darwin"
981 .cindex "Cygwin"
982 Every message handled by Exim is given a &'message id'& which is sixteen
983 characters long. It is divided into three parts, separated by hyphens, for
984 example &`16VDhn-0001bo-D3`&. Each part is a sequence of letters and digits,
985 normally encoding numbers in base 62. However, in the Darwin operating
986 system (Mac OS X) and when Exim is compiled to run under Cygwin, base 36
987 (avoiding the use of lower case letters) is used instead, because the message
988 id is used to construct filenames, and the names of files in those systems are
989 not always case-sensitive.
990
991 .cindex "pid (process id)" "re-use of"
992 The detail of the contents of the message id have changed as Exim has evolved.
993 Earlier versions relied on the operating system not re-using a process id (pid)
994 within one second. On modern operating systems, this assumption can no longer
995 be made, so the algorithm had to be changed. To retain backward compatibility,
996 the format of the message id was retained, which is why the following rules are
997 somewhat eccentric:
998
999 .ilist
1000 The first six characters of the message id are the time at which the message
1001 started to be received, to a granularity of one second. That is, this field
1002 contains the number of seconds since the start of the epoch (the normal Unix
1003 way of representing the date and time of day).
1004 .next
1005 After the first hyphen, the next six characters are the id of the process that
1006 received the message.
1007 .next
1008 There are two different possibilities for the final two characters:
1009 .olist
1010 .oindex "&%localhost_number%&"
1011 If &%localhost_number%& is not set, this value is the fractional part of the
1012 time of reception, normally in units of 1/2000 of a second, but for systems
1013 that must use base 36 instead of base 62 (because of case-insensitive file
1014 systems), the units are 1/1000 of a second.
1015 .next
1016 If &%localhost_number%& is set, it is multiplied by 200 (100) and added to
1017 the fractional part of the time, which in this case is in units of 1/200
1018 (1/100) of a second.
1019 .endlist
1020 .endlist
1021
1022 After a message has been received, Exim waits for the clock to tick at the
1023 appropriate resolution before proceeding, so that if another message is
1024 received by the same process, or by another process with the same (re-used)
1025 pid, it is guaranteed that the time will be different. In most cases, the clock
1026 will already have ticked while the message was being received.
1027
1028
1029 .section "Receiving mail" "SECID13"
1030 .cindex "receiving mail"
1031 .cindex "message" "reception"
1032 The only way Exim can receive mail from another host is using SMTP over
1033 TCP/IP, in which case the sender and recipient addresses are transferred using
1034 SMTP commands. However, from a locally running process (such as a user's MUA),
1035 there are several possibilities:
1036
1037 .ilist
1038 If the process runs Exim with the &%-bm%& option, the message is read
1039 non-interactively (usually via a pipe), with the recipients taken from the
1040 command line, or from the body of the message if &%-t%& is also used.
1041 .next
1042 If the process runs Exim with the &%-bS%& option, the message is also read
1043 non-interactively, but in this case the recipients are listed at the start of
1044 the message in a series of SMTP RCPT commands, terminated by a DATA
1045 command. This is called &"batch SMTP"& format,
1046 but it isn't really SMTP. The SMTP commands are just another way of passing
1047 envelope addresses in a non-interactive submission.
1048 .next
1049 If the process runs Exim with the &%-bs%& option, the message is read
1050 interactively, using the SMTP protocol. A two-way pipe is normally used for
1051 passing data between the local process and the Exim process.
1052 This is &"real"& SMTP and is handled in the same way as SMTP over TCP/IP. For
1053 example, the ACLs for SMTP commands are used for this form of submission.
1054 .next
1055 A local process may also make a TCP/IP call to the host's loopback address
1056 (127.0.0.1) or any other of its IP addresses. When receiving messages, Exim
1057 does not treat the loopback address specially. It treats all such connections
1058 in the same way as connections from other hosts.
1059 .endlist
1060
1061
1062 .cindex "message sender, constructed by Exim"
1063 .cindex "sender" "constructed by Exim"
1064 In the three cases that do not involve TCP/IP, the sender address is
1065 constructed from the login name of the user that called Exim and a default
1066 qualification domain (which can be set by the &%qualify_domain%& configuration
1067 option). For local or batch SMTP, a sender address that is passed using the
1068 SMTP MAIL command is ignored. However, the system administrator may allow
1069 certain users (&"trusted users"&) to specify a different sender addresses
1070 unconditionally, or all users to specify certain forms of different sender
1071 address. The &%-f%& option or the SMTP MAIL command is used to specify these
1072 different addresses. See section &<<SECTtrustedadmin>>& for details of trusted
1073 users, and the &%untrusted_set_sender%& option for a way of allowing untrusted
1074 users to change sender addresses.
1075
1076 Messages received by either of the non-interactive mechanisms are subject to
1077 checking by the non-SMTP ACL if one is defined. Messages received using SMTP
1078 (either over TCP/IP or interacting with a local process) can be checked by a
1079 number of ACLs that operate at different times during the SMTP session. Either
1080 individual recipients or the entire message can be rejected if local policy
1081 requirements are not met. The &[local_scan()]& function (see chapter
1082 &<<CHAPlocalscan>>&) is run for all incoming messages.
1083
1084 Exim can be configured not to start a delivery process when a message is
1085 received; this can be unconditional, or depend on the number of incoming SMTP
1086 connections or the system load. In these situations, new messages wait on the
1087 queue until a queue runner process picks them up. However, in standard
1088 configurations under normal conditions, delivery is started as soon as a
1089 message is received.
1090
1091
1092
1093
1094
1095 .section "Handling an incoming message" "SECID14"
1096 .cindex "spool directory" "files that hold a message"
1097 .cindex "file" "how a message is held"
1098 When Exim accepts a message, it writes two files in its spool directory. The
1099 first contains the envelope information, the current status of the message, and
1100 the header lines, and the second contains the body of the message. The names of
1101 the two spool files consist of the message id, followed by &`-H`& for the
1102 file containing the envelope and header, and &`-D`& for the data file.
1103
1104 .cindex "spool directory" "&_input_& sub-directory"
1105 By default, all these message files are held in a single directory called
1106 &_input_& inside the general Exim spool directory. Some operating systems do
1107 not perform very well if the number of files in a directory gets large; to
1108 improve performance in such cases, the &%split_spool_directory%& option can be
1109 used. This causes Exim to split up the input files into 62 sub-directories
1110 whose names are single letters or digits. When this is done, the queue is
1111 processed one sub-directory at a time instead of all at once, which can improve
1112 overall performance even when there are not enough files in each directory to
1113 affect file system performance.
1114
1115 The envelope information consists of the address of the message's sender and
1116 the addresses of the recipients. This information is entirely separate from
1117 any addresses contained in the header lines. The status of the message includes
1118 a list of recipients who have already received the message. The format of the
1119 first spool file is described in chapter &<<CHAPspool>>&.
1120
1121 .cindex "rewriting" "addresses"
1122 Address rewriting that is specified in the rewrite section of the configuration
1123 (see chapter &<<CHAPrewrite>>&) is done once and for all on incoming addresses,
1124 both in the header lines and the envelope, at the time the message is accepted.
1125 If during the course of delivery additional addresses are generated (for
1126 example, via aliasing), these new addresses are rewritten as soon as they are
1127 generated. At the time a message is actually delivered (transported) further
1128 rewriting can take place; because this is a transport option, it can be
1129 different for different forms of delivery. It is also possible to specify the
1130 addition or removal of certain header lines at the time the message is
1131 delivered (see chapters &<<CHAProutergeneric>>& and
1132 &<<CHAPtransportgeneric>>&).
1133
1134
1135
1136 .section "Life of a message" "SECID15"
1137 .cindex "message" "life of"
1138 .cindex "message" "frozen"
1139 A message remains in the spool directory until it is completely delivered to
1140 its recipients or to an error address, or until it is deleted by an
1141 administrator or by the user who originally created it. In cases when delivery
1142 cannot proceed &-- for example when a message can neither be delivered to its
1143 recipients nor returned to its sender, the message is marked &"frozen"& on the
1144 spool, and no more deliveries are attempted.
1145
1146 .cindex "frozen messages" "thawing"
1147 .cindex "message" "thawing frozen"
1148 An administrator can &"thaw"& such messages when the problem has been
1149 corrected, and can also freeze individual messages by hand if necessary. In
1150 addition, an administrator can force a delivery error, causing a bounce message
1151 to be sent.
1152
1153 .oindex "&%timeout_frozen_after%&"
1154 .oindex "&%ignore_bounce_errors_after%&"
1155 There are options called &%ignore_bounce_errors_after%& and
1156 &%timeout_frozen_after%&, which discard frozen messages after a certain time.
1157 The first applies only to frozen bounces, the second to all frozen messages.
1158
1159 .cindex "message" "log file for"
1160 .cindex "log" "file for each message"
1161 While Exim is working on a message, it writes information about each delivery
1162 attempt to its main log file. This includes successful, unsuccessful, and
1163 delayed deliveries for each recipient (see chapter &<<CHAPlog>>&). The log
1164 lines are also written to a separate &'message log'& file for each message.
1165 These logs are solely for the benefit of the administrator and are normally
1166 deleted along with the spool files when processing of a message is complete.
1167 The use of individual message logs can be disabled by setting
1168 &%no_message_logs%&; this might give an improvement in performance on very busy
1169 systems.
1170
1171 .cindex "journal file"
1172 .cindex "file" "journal"
1173 All the information Exim itself needs to set up a delivery is kept in the first
1174 spool file, along with the header lines. When a successful delivery occurs, the
1175 address is immediately written at the end of a journal file, whose name is the
1176 message id followed by &`-J`&. At the end of a delivery run, if there are some
1177 addresses left to be tried again later, the first spool file (the &`-H`& file)
1178 is updated to indicate which these are, and the journal file is then deleted.
1179 Updating the spool file is done by writing a new file and renaming it, to
1180 minimize the possibility of data loss.
1181
1182 Should the system or Exim crash after a successful delivery but before
1183 the spool file has been updated, the journal is left lying around. The next
1184 time Exim attempts to deliver the message, it reads the journal file and
1185 updates the spool file before proceeding. This minimizes the chances of double
1186 deliveries caused by crashes.
1187
1188
1189
1190 .section "Processing an address for delivery" "SECTprocaddress"
1191 .cindex "drivers" "definition of"
1192 .cindex "router" "definition of"
1193 .cindex "transport" "definition of"
1194 The main delivery processing elements of Exim are called &'routers'& and
1195 &'transports'&, and collectively these are known as &'drivers'&. Code for a
1196 number of them is provided in the source distribution, and compile-time options
1197 specify which ones are included in the binary. Runtime options specify which
1198 ones are actually used for delivering messages.
1199
1200 .cindex "drivers" "instance definition"
1201 Each driver that is specified in the runtime configuration is an &'instance'&
1202 of that particular driver type. Multiple instances are allowed; for example,
1203 you can set up several different &(smtp)& transports, each with different
1204 option values that might specify different ports or different timeouts. Each
1205 instance has its own identifying name. In what follows we will normally use the
1206 instance name when discussing one particular instance (that is, one specific
1207 configuration of the driver), and the generic driver name when discussing
1208 the driver's features in general.
1209
1210 A &'router'& is a driver that operates on an address, either determining how
1211 its delivery should happen, by assigning it to a specific transport, or
1212 converting the address into one or more new addresses (for example, via an
1213 alias file). A router may also explicitly choose to fail an address, causing it
1214 to be bounced.
1215
1216 A &'transport'& is a driver that transmits a copy of the message from Exim's
1217 spool to some destination. There are two kinds of transport: for a &'local'&
1218 transport, the destination is a file or a pipe on the local host, whereas for a
1219 &'remote'& transport the destination is some other host. A message is passed
1220 to a specific transport as a result of successful routing. If a message has
1221 several recipients, it may be passed to a number of different transports.
1222
1223 .cindex "preconditions" "definition of"
1224 An address is processed by passing it to each configured router instance in
1225 turn, subject to certain preconditions, until a router accepts the address or
1226 specifies that it should be bounced. We will describe this process in more
1227 detail shortly. First, as a simple example, we consider how each recipient
1228 address in a message is processed in a small configuration of three routers.
1229
1230 To make this a more concrete example, it is described in terms of some actual
1231 routers, but remember, this is only an example. You can configure Exim's
1232 routers in many different ways, and there may be any number of routers in a
1233 configuration.
1234
1235 The first router that is specified in a configuration is often one that handles
1236 addresses in domains that are not recognized specifically by the local host.
1237 Typically these are addresses for arbitrary domains on the Internet. A precondition
1238 is set up which looks for the special domains known to the host (for example,
1239 its own domain name), and the router is run for addresses that do &'not'&
1240 match. Typically, this is a router that looks up domains in the DNS in order to
1241 find the hosts to which this address routes. If it succeeds, the address is
1242 assigned to a suitable SMTP transport; if it does not succeed, the router is
1243 configured to fail the address.
1244
1245 The second router is reached only when the domain is recognized as one that
1246 &"belongs"& to the local host. This router does redirection &-- also known as
1247 aliasing and forwarding. When it generates one or more new addresses from the
1248 original, each of them is routed independently from the start. Otherwise, the
1249 router may cause an address to fail, or it may simply decline to handle the
1250 address, in which case the address is passed to the next router.
1251
1252 The final router in many configurations is one that checks to see if the
1253 address belongs to a local mailbox. The precondition may involve a check to
1254 see if the local part is the name of a login account, or it may look up the
1255 local part in a file or a database. If its preconditions are not met, or if
1256 the router declines, we have reached the end of the routers. When this happens,
1257 the address is bounced.
1258
1259
1260
1261 .section "Processing an address for verification" "SECID16"
1262 .cindex "router" "for verification"
1263 .cindex "verifying address" "overview"
1264 As well as being used to decide how to deliver to an address, Exim's routers
1265 are also used for &'address verification'&. Verification can be requested as
1266 one of the checks to be performed in an ACL for incoming messages, on both
1267 sender and recipient addresses, and it can be tested using the &%-bv%& and
1268 &%-bvs%& command line options.
1269
1270 When an address is being verified, the routers are run in &"verify mode"&. This
1271 does not affect the way the routers work, but it is a state that can be
1272 detected. By this means, a router can be skipped or made to behave differently
1273 when verifying. A common example is a configuration in which the first router
1274 sends all messages to a message-scanning program unless they have been
1275 previously scanned. Thus, the first router accepts all addresses without any
1276 checking, making it useless for verifying. Normally, the &%no_verify%& option
1277 would be set for such a router, causing it to be skipped in verify mode.
1278
1279
1280
1281
1282 .section "Running an individual router" "SECTrunindrou"
1283 .cindex "router" "running details"
1284 .cindex "preconditions" "checking"
1285 .cindex "router" "result of running"
1286 As explained in the example above, a number of preconditions are checked before
1287 running a router. If any are not met, the router is skipped, and the address is
1288 passed to the next router. When all the preconditions on a router &'are'& met,
1289 the router is run. What happens next depends on the outcome, which is one of
1290 the following:
1291
1292 .ilist
1293 &'accept'&: The router accepts the address, and either assigns it to a
1294 transport or generates one or more &"child"& addresses. Processing the
1295 original address ceases
1296 .oindex "&%unseen%&"
1297 unless the &%unseen%& option is set on the router. This option
1298 can be used to set up multiple deliveries with different routing (for example,
1299 for keeping archive copies of messages). When &%unseen%& is set, the address is
1300 passed to the next router. Normally, however, an &'accept'& return marks the
1301 end of routing.
1302
1303 Any child addresses generated by the router are processed independently,
1304 starting with the first router by default. It is possible to change this by
1305 setting the &%redirect_router%& option to specify which router to start at for
1306 child addresses. Unlike &%pass_router%& (see below) the router specified by
1307 &%redirect_router%& may be anywhere in the router configuration.
1308 .next
1309 &'pass'&: The router recognizes the address, but cannot handle it itself. It
1310 requests that the address be passed to another router. By default, the address
1311 is passed to the next router, but this can be changed by setting the
1312 &%pass_router%& option. However, (unlike &%redirect_router%&) the named router
1313 must be below the current router (to avoid loops).
1314 .next
1315 &'decline'&: The router declines to accept the address because it does not
1316 recognize it at all. By default, the address is passed to the next router, but
1317 this can be prevented by setting the &%no_more%& option. When &%no_more%& is
1318 set, all the remaining routers are skipped. In effect, &%no_more%& converts
1319 &'decline'& into &'fail'&.
1320 .next
1321 &'fail'&: The router determines that the address should fail, and queues it for
1322 the generation of a bounce message. There is no further processing of the
1323 original address unless &%unseen%& is set on the router.
1324 .next
1325 &'defer'&: The router cannot handle the address at the present time. (A
1326 database may be offline, or a DNS lookup may have timed out.) No further
1327 processing of the address happens in this delivery attempt. It is tried again
1328 next time the message is considered for delivery.
1329 .next
1330 &'error'&: There is some error in the router (for example, a syntax error in
1331 its configuration). The action is as for defer.
1332 .endlist
1333
1334 If an address reaches the end of the routers without having been accepted by
1335 any of them, it is bounced as unrouteable. The default error message in this
1336 situation is &"unrouteable address"&, but you can set your own message by
1337 making use of the &%cannot_route_message%& option. This can be set for any
1338 router; the value from the last router that &"saw"& the address is used.
1339
1340 Sometimes while routing you want to fail a delivery when some conditions are
1341 met but others are not, instead of passing the address on for further routing.
1342 You can do this by having a second router that explicitly fails the delivery
1343 when the relevant conditions are met. The &(redirect)& router has a &"fail"&
1344 facility for this purpose.
1345
1346
1347 .section "Duplicate addresses" "SECID17"
1348 .cindex "case of local parts"
1349 .cindex "address duplicate, discarding"
1350 .cindex "duplicate addresses"
1351 Once routing is complete, Exim scans the addresses that are assigned to local
1352 and remote transports and discards any duplicates that it finds. During this
1353 check, local parts are treated case-sensitively. This happens only when
1354 actually delivering a message; when testing routers with &%-bt%&, all the
1355 routed addresses are shown.
1356
1357
1358
1359 .section "Router preconditions" "SECTrouprecon"
1360 .cindex "router" "preconditions, order of processing"
1361 .cindex "preconditions" "order of processing"
1362 The preconditions that are tested for each router are listed below, in the
1363 order in which they are tested. The individual configuration options are
1364 described in more detail in chapter &<<CHAProutergeneric>>&.
1365
1366 .ilist
1367 .cindex affix "router precondition"
1368 The &%local_part_prefix%& and &%local_part_suffix%& options can specify that
1369 the local parts handled by the router may or must have certain prefixes and/or
1370 suffixes. If a mandatory affix (prefix or suffix) is not present, the router is
1371 skipped. These conditions are tested first. When an affix is present, it is
1372 removed from the local part before further processing, including the evaluation
1373 of any other conditions.
1374 .next
1375 Routers can be designated for use only when not verifying an address, that is,
1376 only when routing it for delivery (or testing its delivery routing). If the
1377 &%verify%& option is set false, the router is skipped when Exim is verifying an
1378 address.
1379 Setting the &%verify%& option actually sets two options, &%verify_sender%& and
1380 &%verify_recipient%&, which independently control the use of the router for
1381 sender and recipient verification. You can set these options directly if
1382 you want a router to be used for only one type of verification.
1383 Note that cutthrough delivery is classed as a recipient verification for this purpose.
1384 .next
1385 If the &%address_test%& option is set false, the router is skipped when Exim is
1386 run with the &%-bt%& option to test an address routing. This can be helpful
1387 when the first router sends all new messages to a scanner of some sort; it
1388 makes it possible to use &%-bt%& to test subsequent delivery routing without
1389 having to simulate the effect of the scanner.
1390 .next
1391 Routers can be designated for use only when verifying an address, as
1392 opposed to routing it for delivery. The &%verify_only%& option controls this.
1393 Again, cutthrough delivery counts as a verification.
1394 .next
1395 Individual routers can be explicitly skipped when running the routers to
1396 check an address given in the SMTP EXPN command (see the &%expn%& option).
1397 .next
1398 If the &%domains%& option is set, the domain of the address must be in the set
1399 of domains that it defines.
1400 .next
1401 .vindex "&$local_part_prefix$&"
1402 .vindex "&$local_part_prefix_v$&"
1403 .vindex "&$local_part$&"
1404 .vindex "&$local_part_suffix$&"
1405 .vindex "&$local_part_suffix_v$&"
1406 .cindex affix "router precondition"
1407 If the &%local_parts%& option is set, the local part of the address must be in
1408 the set of local parts that it defines. If &%local_part_prefix%& or
1409 &%local_part_suffix%& is in use, the prefix or suffix is removed from the local
1410 part before this check. If you want to do precondition tests on local parts
1411 that include affixes, you can do so by using a &%condition%& option (see below)
1412 .new
1413 that uses the variables &$local_part$&, &$local_part_prefix$&,
1414 &$local_part_prefix_v$&, &$local_part_suffix$&
1415 and &$local_part_suffix_v$& as necessary.
1416 .wen
1417 .next
1418 .vindex "&$local_user_uid$&"
1419 .vindex "&$local_user_gid$&"
1420 .vindex "&$home$&"
1421 If the &%check_local_user%& option is set, the local part must be the name of
1422 an account on the local host. If this check succeeds, the uid and gid of the
1423 local user are placed in &$local_user_uid$& and &$local_user_gid$& and the
1424 user's home directory is placed in &$home$&; these values can be used in the
1425 remaining preconditions.
1426 .next
1427 If the &%router_home_directory%& option is set, it is expanded at this point,
1428 because it overrides the value of &$home$&. If this expansion were left till
1429 later, the value of &$home$& as set by &%check_local_user%& would be used in
1430 subsequent tests. Having two different values of &$home$& in the same router
1431 could lead to confusion.
1432 .next
1433 If the &%senders%& option is set, the envelope sender address must be in the
1434 set of addresses that it defines.
1435 .next
1436 If the &%require_files%& option is set, the existence or non-existence of
1437 specified files is tested.
1438 .next
1439 .cindex "customizing" "precondition"
1440 If the &%condition%& option is set, it is evaluated and tested. This option
1441 uses an expanded string to allow you to set up your own custom preconditions.
1442 Expanded strings are described in chapter &<<CHAPexpand>>&.
1443 .endlist
1444
1445
1446 Note that &%require_files%& comes near the end of the list, so you cannot use
1447 it to check for the existence of a file in which to lookup up a domain, local
1448 part, or sender. However, as these options are all expanded, you can use the
1449 &%exists%& expansion condition to make such tests within each condition. The
1450 &%require_files%& option is intended for checking files that the router may be
1451 going to use internally, or which are needed by a specific transport (for
1452 example, &_.procmailrc_&).
1453
1454
1455
1456 .section "Delivery in detail" "SECID18"
1457 .cindex "delivery" "in detail"
1458 When a message is to be delivered, the sequence of events is as follows:
1459
1460 .ilist
1461 If a system-wide filter file is specified, the message is passed to it. The
1462 filter may add recipients to the message, replace the recipients, discard the
1463 message, cause a new message to be generated, or cause the message delivery to
1464 fail. The format of the system filter file is the same as for Exim user filter
1465 files, described in the separate document entitled &'Exim's interfaces to mail
1466 filtering'&.
1467 .cindex "Sieve filter" "not available for system filter"
1468 (&*Note*&: Sieve cannot be used for system filter files.)
1469
1470 Some additional features are available in system filters &-- see chapter
1471 &<<CHAPsystemfilter>>& for details. Note that a message is passed to the system
1472 filter only once per delivery attempt, however many recipients it has. However,
1473 if there are several delivery attempts because one or more addresses could not
1474 be immediately delivered, the system filter is run each time. The filter
1475 condition &%first_delivery%& can be used to detect the first run of the system
1476 filter.
1477 .next
1478 Each recipient address is offered to each configured router, in turn, subject to
1479 its preconditions, until one is able to handle it. If no router can handle the
1480 address, that is, if they all decline, the address is failed. Because routers
1481 can be targeted at particular domains, several locally handled domains can be
1482 processed entirely independently of each other.
1483 .next
1484 .cindex "routing" "loops in"
1485 .cindex "loop" "while routing"
1486 A router that accepts an address may assign it to a local or a remote
1487 transport. However, the transport is not run at this time. Instead, the address
1488 is placed on a list for the particular transport, which will be run later.
1489 Alternatively, the router may generate one or more new addresses (typically
1490 from alias, forward, or filter files). New addresses are fed back into this
1491 process from the top, but in order to avoid loops, a router ignores any address
1492 which has an identically-named ancestor that was processed by itself.
1493 .next
1494 When all the routing has been done, addresses that have been successfully
1495 handled are passed to their assigned transports. When local transports are
1496 doing real local deliveries, they handle only one address at a time, but if a
1497 local transport is being used as a pseudo-remote transport (for example, to
1498 collect batched SMTP messages for transmission by some other means) multiple
1499 addresses can be handled. Remote transports can always handle more than one
1500 address at a time, but can be configured not to do so, or to restrict multiple
1501 addresses to the same domain.
1502 .next
1503 Each local delivery to a file or a pipe runs in a separate process under a
1504 non-privileged uid, and these deliveries are run one at a time. Remote
1505 deliveries also run in separate processes, normally under a uid that is private
1506 to Exim (&"the Exim user"&), but in this case, several remote deliveries can be
1507 run in parallel. The maximum number of simultaneous remote deliveries for any
1508 one message is set by the &%remote_max_parallel%& option.
1509 The order in which deliveries are done is not defined, except that all local
1510 deliveries happen before any remote deliveries.
1511 .next
1512 .cindex "queue runner"
1513 When it encounters a local delivery during a queue run, Exim checks its retry
1514 database to see if there has been a previous temporary delivery failure for the
1515 address before running the local transport. If there was a previous failure,
1516 Exim does not attempt a new delivery until the retry time for the address is
1517 reached. However, this happens only for delivery attempts that are part of a
1518 queue run. Local deliveries are always attempted when delivery immediately
1519 follows message reception, even if retry times are set for them. This makes for
1520 better behaviour if one particular message is causing problems (for example,
1521 causing quota overflow, or provoking an error in a filter file).
1522 .next
1523 .cindex "delivery" "retry in remote transports"
1524 Remote transports do their own retry handling, since an address may be
1525 deliverable to one of a number of hosts, each of which may have a different
1526 retry time. If there have been previous temporary failures and no host has
1527 reached its retry time, no delivery is attempted, whether in a queue run or
1528 not. See chapter &<<CHAPretry>>& for details of retry strategies.
1529 .next
1530 If there were any permanent errors, a bounce message is returned to an
1531 appropriate address (the sender in the common case), with details of the error
1532 for each failing address. Exim can be configured to send copies of bounce
1533 messages to other addresses.
1534 .next
1535 .cindex "delivery" "deferral"
1536 If one or more addresses suffered a temporary failure, the message is left on
1537 the queue, to be tried again later. Delivery of these addresses is said to be
1538 &'deferred'&.
1539 .next
1540 When all the recipient addresses have either been delivered or bounced,
1541 handling of the message is complete. The spool files and message log are
1542 deleted, though the message log can optionally be preserved if required.
1543 .endlist
1544
1545
1546
1547
1548 .section "Retry mechanism" "SECID19"
1549 .cindex "delivery" "retry mechanism"
1550 .cindex "retry" "description of mechanism"
1551 .cindex "queue runner"
1552 Exim's mechanism for retrying messages that fail to get delivered at the first
1553 attempt is the queue runner process. You must either run an Exim daemon that
1554 uses the &%-q%& option with a time interval to start queue runners at regular
1555 intervals or use some other means (such as &'cron'&) to start them. If you do
1556 not arrange for queue runners to be run, messages that fail temporarily at the
1557 first attempt will remain in your queue forever. A queue runner process works
1558 its way through the queue, one message at a time, trying each delivery that has
1559 passed its retry time.
1560 You can run several queue runners at once.
1561
1562 Exim uses a set of configured rules to determine when next to retry the failing
1563 address (see chapter &<<CHAPretry>>&). These rules also specify when Exim
1564 should give up trying to deliver to the address, at which point it generates a
1565 bounce message. If no retry rules are set for a particular host, address, and
1566 error combination, no retries are attempted, and temporary errors are treated
1567 as permanent.
1568
1569
1570
1571 .section "Temporary delivery failure" "SECID20"
1572 .cindex "delivery" "temporary failure"
1573 There are many reasons why a message may not be immediately deliverable to a
1574 particular address. Failure to connect to a remote machine (because it, or the
1575 connection to it, is down) is one of the most common. Temporary failures may be
1576 detected during routing as well as during the transport stage of delivery.
1577 Local deliveries may be delayed if NFS files are unavailable, or if a mailbox
1578 is on a file system where the user is over quota. Exim can be configured to
1579 impose its own quotas on local mailboxes; where system quotas are set they will
1580 also apply.
1581
1582 If a host is unreachable for a period of time, a number of messages may be
1583 waiting for it by the time it recovers, and sending them in a single SMTP
1584 connection is clearly beneficial. Whenever a delivery to a remote host is
1585 deferred,
1586 .cindex "hints database" "deferred deliveries"
1587 Exim makes a note in its hints database, and whenever a successful
1588 SMTP delivery has happened, it looks to see if any other messages are waiting
1589 for the same host. If any are found, they are sent over the same SMTP
1590 connection, subject to a configuration limit as to the maximum number in any
1591 one connection.
1592
1593
1594
1595 .section "Permanent delivery failure" "SECID21"
1596 .cindex "delivery" "permanent failure"
1597 .cindex "bounce message" "when generated"
1598 When a message cannot be delivered to some or all of its intended recipients, a
1599 bounce message is generated. Temporary delivery failures turn into permanent
1600 errors when their timeout expires. All the addresses that fail in a given
1601 delivery attempt are listed in a single message. If the original message has
1602 many recipients, it is possible for some addresses to fail in one delivery
1603 attempt and others to fail subsequently, giving rise to more than one bounce
1604 message. The wording of bounce messages can be customized by the administrator.
1605 See chapter &<<CHAPemsgcust>>& for details.
1606
1607 .cindex "&'X-Failed-Recipients:'& header line"
1608 Bounce messages contain an &'X-Failed-Recipients:'& header line that lists the
1609 failed addresses, for the benefit of programs that try to analyse such messages
1610 automatically.
1611
1612 .cindex "bounce message" "recipient of"
1613 A bounce message is normally sent to the sender of the original message, as
1614 obtained from the message's envelope. For incoming SMTP messages, this is the
1615 address given in the MAIL command. However, when an address is expanded via a
1616 forward or alias file, an alternative address can be specified for delivery
1617 failures of the generated addresses. For a mailing list expansion (see section
1618 &<<SECTmailinglists>>&) it is common to direct bounce messages to the manager
1619 of the list.
1620
1621
1622
1623 .section "Failures to deliver bounce messages" "SECID22"
1624 .cindex "bounce message" "failure to deliver"
1625 If a bounce message (either locally generated or received from a remote host)
1626 itself suffers a permanent delivery failure, the message is left in the queue,
1627 but it is frozen, awaiting the attention of an administrator. There are options
1628 that can be used to make Exim discard such failed messages, or to keep them
1629 for only a short time (see &%timeout_frozen_after%& and
1630 &%ignore_bounce_errors_after%&).
1631
1632
1633
1634
1635
1636 . ////////////////////////////////////////////////////////////////////////////
1637 . ////////////////////////////////////////////////////////////////////////////
1638
1639 .chapter "Building and installing Exim" "CHID3"
1640 .scindex IIDbuex "building Exim"
1641
1642 .section "Unpacking" "SECID23"
1643 Exim is distributed as a gzipped or bzipped tar file which, when unpacked,
1644 creates a directory with the name of the current release (for example,
1645 &_exim-&version()_&) into which the following files are placed:
1646
1647 .table2 140pt
1648 .irow &_ACKNOWLEDGMENTS_& "contains some acknowledgments"
1649 .irow &_CHANGES_&         "contains a reference to where changes are &&&
1650   documented"
1651 .irow &_LICENCE_&         "the GNU General Public Licence"
1652 .irow &_Makefile_&        "top-level make file"
1653 .irow &_NOTICE_&          "conditions for the use of Exim"
1654 .irow &_README_&          "list of files, directories and simple build &&&
1655   instructions"
1656 .endtable
1657
1658 Other files whose names begin with &_README_& may also be present. The
1659 following subdirectories are created:
1660
1661 .table2 140pt
1662 .irow &_Local_&           "an empty directory for local configuration files"
1663 .irow &_OS_&              "OS-specific files"
1664 .irow &_doc_&             "documentation files"
1665 .irow &_exim_monitor_&    "source files for the Exim monitor"
1666 .irow &_scripts_&         "scripts used in the build process"
1667 .irow &_src_&             "remaining source files"
1668 .irow &_util_&            "independent utilities"
1669 .endtable
1670
1671 The main utility programs are contained in the &_src_& directory and are built
1672 with the Exim binary. The &_util_& directory contains a few optional scripts
1673 that may be useful to some sites.
1674
1675
1676 .section "Multiple machine architectures and operating systems" "SECID24"
1677 .cindex "building Exim" "multiple OS/architectures"
1678 The building process for Exim is arranged to make it easy to build binaries for
1679 a number of different architectures and operating systems from the same set of
1680 source files. Compilation does not take place in the &_src_& directory.
1681 Instead, a &'build directory'& is created for each architecture and operating
1682 system.
1683 .cindex "symbolic link" "to build directory"
1684 Symbolic links to the sources are installed in this directory, which is where
1685 the actual building takes place. In most cases, Exim can discover the machine
1686 architecture and operating system for itself, but the defaults can be
1687 overridden if necessary.
1688 .cindex compiler requirements
1689 .cindex compiler version
1690 A C99-capable compiler will be required for the build.
1691
1692
1693 .section "PCRE library" "SECTpcre"
1694 .cindex "PCRE library"
1695 Exim no longer has an embedded PCRE library as the vast majority of
1696 modern systems include PCRE as a system library, although you may need to
1697 install the PCRE package or the PCRE development package for your operating
1698 system. If your system has a normal PCRE installation the Exim build
1699 process will need no further configuration. If the library or the
1700 headers are in an unusual location you will need to either set the PCRE_LIBS
1701 and INCLUDE directives appropriately,
1702 or set PCRE_CONFIG=yes to use the installed &(pcre-config)& command.
1703 If your operating system has no
1704 PCRE support then you will need to obtain and build the current PCRE
1705 from &url(ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre/).
1706 More information on PCRE is available at &url(https://www.pcre.org/).
1707
1708 .section "DBM libraries" "SECTdb"
1709 .cindex "DBM libraries" "discussion of"
1710 .cindex "hints database" "DBM files used for"
1711 Even if you do not use any DBM files in your configuration, Exim still needs a
1712 DBM library in order to operate, because it uses indexed files for its hints
1713 databases. Unfortunately, there are a number of DBM libraries in existence, and
1714 different operating systems often have different ones installed.
1715
1716 .cindex "Solaris" "DBM library for"
1717 .cindex "IRIX, DBM library for"
1718 .cindex "BSD, DBM library for"
1719 .cindex "Linux, DBM library for"
1720 If you are using Solaris, IRIX, one of the modern BSD systems, or a modern
1721 Linux distribution, the DBM configuration should happen automatically, and you
1722 may be able to ignore this section. Otherwise, you may have to learn more than
1723 you would like about DBM libraries from what follows.
1724
1725 .cindex "&'ndbm'& DBM library"
1726 Licensed versions of Unix normally contain a library of DBM functions operating
1727 via the &'ndbm'& interface, and this is what Exim expects by default. Free
1728 versions of Unix seem to vary in what they contain as standard. In particular,
1729 some early versions of Linux have no default DBM library, and different
1730 distributors have chosen to bundle different libraries with their packaged
1731 versions. However, the more recent releases seem to have standardized on the
1732 Berkeley DB library.
1733
1734 Different DBM libraries have different conventions for naming the files they
1735 use. When a program opens a file called &_dbmfile_&, there are several
1736 possibilities:
1737
1738 .olist
1739 A traditional &'ndbm'& implementation, such as that supplied as part of
1740 Solaris, operates on two files called &_dbmfile.dir_& and &_dbmfile.pag_&.
1741 .next
1742 .cindex "&'gdbm'& DBM library"
1743 The GNU library, &'gdbm'&, operates on a single file. If used via its &'ndbm'&
1744 compatibility interface it makes two different hard links to it with names
1745 &_dbmfile.dir_& and &_dbmfile.pag_&, but if used via its native interface, the
1746 filename is used unmodified.
1747 .next
1748 .cindex "Berkeley DB library"
1749 The Berkeley DB package, if called via its &'ndbm'& compatibility interface,
1750 operates on a single file called &_dbmfile.db_&, but otherwise looks to the
1751 programmer exactly the same as the traditional &'ndbm'& implementation.
1752 .next
1753 If the Berkeley package is used in its native mode, it operates on a single
1754 file called &_dbmfile_&; the programmer's interface is somewhat different to
1755 the traditional &'ndbm'& interface.
1756 .next
1757 To complicate things further, there are several very different versions of the
1758 Berkeley DB package. Version 1.85 was stable for a very long time, releases
1759 2.&'x'& and 3.&'x'& were current for a while, but the latest versions when Exim last revamped support were numbered 4.&'x'&.
1760 Maintenance of some of the earlier releases has ceased. All versions of
1761 Berkeley DB could be obtained from
1762 &url(http://www.sleepycat.com/), which is now a redirect to their new owner's
1763 page with far newer versions listed.
1764 It is probably wise to plan to move your storage configurations away from
1765 Berkeley DB format, as today there are smaller and simpler alternatives more
1766 suited to Exim's usage model.
1767 .next
1768 .cindex "&'tdb'& DBM library"
1769 Yet another DBM library, called &'tdb'&, is available from
1770 &url(https://sourceforge.net/projects/tdb/files/). It has its own interface, and also
1771 operates on a single file.
1772 .endlist
1773
1774 .cindex "USE_DB"
1775 .cindex "DBM libraries" "configuration for building"
1776 Exim and its utilities can be compiled to use any of these interfaces. In order
1777 to use any version of the Berkeley DB package in native mode, you must set
1778 USE_DB in an appropriate configuration file (typically
1779 &_Local/Makefile_&). For example:
1780 .code
1781 USE_DB=yes
1782 .endd
1783 Similarly, for gdbm you set USE_GDBM, and for tdb you set USE_TDB. An
1784 error is diagnosed if you set more than one of these.
1785
1786 At the lowest level, the build-time configuration sets none of these options,
1787 thereby assuming an interface of type (1). However, some operating system
1788 configuration files (for example, those for the BSD operating systems and
1789 Linux) assume type (4) by setting USE_DB as their default, and the
1790 configuration files for Cygwin set USE_GDBM. Anything you set in
1791 &_Local/Makefile_&, however, overrides these system defaults.
1792
1793 As well as setting USE_DB, USE_GDBM, or USE_TDB, it may also be
1794 necessary to set DBMLIB, to cause inclusion of the appropriate library, as
1795 in one of these lines:
1796 .code
1797 DBMLIB = -ldb
1798 DBMLIB = -ltdb
1799 .endd
1800 Settings like that will work if the DBM library is installed in the standard
1801 place. Sometimes it is not, and the library's header file may also not be in
1802 the default path. You may need to set INCLUDE to specify where the header
1803 file is, and to specify the path to the library more fully in DBMLIB, as in
1804 this example:
1805 .code
1806 INCLUDE=-I/usr/local/include/db-4.1
1807 DBMLIB=/usr/local/lib/db-4.1/libdb.a
1808 .endd
1809 There is further detailed discussion about the various DBM libraries in the
1810 file &_doc/dbm.discuss.txt_& in the Exim distribution.
1811
1812
1813
1814 .section "Pre-building configuration" "SECID25"
1815 .cindex "building Exim" "pre-building configuration"
1816 .cindex "configuration for building Exim"
1817 .cindex "&_Local/Makefile_&"
1818 .cindex "&_src/EDITME_&"
1819 Before building Exim, a local configuration file that specifies options
1820 independent of any operating system has to be created with the name
1821 &_Local/Makefile_&. A template for this file is supplied as the file
1822 &_src/EDITME_&, and it contains full descriptions of all the option settings
1823 therein. These descriptions are therefore not repeated here. If you are
1824 building Exim for the first time, the simplest thing to do is to copy
1825 &_src/EDITME_& to &_Local/Makefile_&, then read it and edit it appropriately.
1826
1827 There are three settings that you must supply, because Exim will not build
1828 without them. They are the location of the runtime configuration file
1829 (CONFIGURE_FILE), the directory in which Exim binaries will be installed
1830 (BIN_DIRECTORY), and the identity of the Exim user (EXIM_USER and
1831 maybe EXIM_GROUP as well). The value of CONFIGURE_FILE can in fact be
1832 a colon-separated list of filenames; Exim uses the first of them that exists.
1833
1834 There are a few other parameters that can be specified either at build time or
1835 at runtime, to enable the same binary to be used on a number of different
1836 machines. However, if the locations of Exim's spool directory and log file
1837 directory (if not within the spool directory) are fixed, it is recommended that
1838 you specify them in &_Local/Makefile_& instead of at runtime, so that errors
1839 detected early in Exim's execution (such as a malformed configuration file) can
1840 be logged.
1841
1842 .cindex "content scanning" "specifying at build time"
1843 Exim's interfaces for calling virus and spam scanning software directly from
1844 access control lists are not compiled by default. If you want to include these
1845 facilities, you need to set
1846 .code
1847 WITH_CONTENT_SCAN=yes
1848 .endd
1849 in your &_Local/Makefile_&. For details of the facilities themselves, see
1850 chapter &<<CHAPexiscan>>&.
1851
1852
1853 .cindex "&_Local/eximon.conf_&"
1854 .cindex "&_exim_monitor/EDITME_&"
1855 If you are going to build the Exim monitor, a similar configuration process is
1856 required. The file &_exim_monitor/EDITME_& must be edited appropriately for
1857 your installation and saved under the name &_Local/eximon.conf_&. If you are
1858 happy with the default settings described in &_exim_monitor/EDITME_&,
1859 &_Local/eximon.conf_& can be empty, but it must exist.
1860
1861 This is all the configuration that is needed in straightforward cases for known
1862 operating systems. However, the building process is set up so that it is easy
1863 to override options that are set by default or by operating-system-specific
1864 configuration files, for example, to change the C compiler, which
1865 defaults to &%gcc%&. See section &<<SECToverride>>& below for details of how to
1866 do this.
1867
1868
1869
1870 .section "Support for iconv()" "SECID26"
1871 .cindex "&[iconv()]& support"
1872 .cindex "RFC 2047"
1873 The contents of header lines in messages may be encoded according to the rules
1874 described RFC 2047. This makes it possible to transmit characters that are not
1875 in the ASCII character set, and to label them as being in a particular
1876 character set. When Exim is inspecting header lines by means of the &%$h_%&
1877 mechanism, it decodes them, and translates them into a specified character set
1878 (default is set at build time). The translation is possible only if the operating system
1879 supports the &[iconv()]& function.
1880
1881 However, some of the operating systems that supply &[iconv()]& do not support
1882 very many conversions. The GNU &%libiconv%& library (available from
1883 &url(https://www.gnu.org/software/libiconv/)) can be installed on such
1884 systems to remedy this deficiency, as well as on systems that do not supply
1885 &[iconv()]& at all. After installing &%libiconv%&, you should add
1886 .code
1887 HAVE_ICONV=yes
1888 .endd
1889 to your &_Local/Makefile_& and rebuild Exim.
1890
1891
1892
1893 .section "Including TLS/SSL encryption support" "SECTinctlsssl"
1894 .cindex "TLS" "including support for TLS"
1895 .cindex "encryption" "including support for"
1896 .cindex "OpenSSL" "building Exim with"
1897 .cindex "GnuTLS" "building Exim with"
1898 Exim is usually built to support encrypted SMTP connections, using the STARTTLS
1899 command as per RFC 2487. It can also support clients that expect to
1900 start a TLS session immediately on connection to a non-standard port (see the
1901 &%tls_on_connect_ports%& runtime option and the &%-tls-on-connect%& command
1902 line option).
1903
1904 If you want to build Exim with TLS support, you must first install either the
1905 OpenSSL or GnuTLS library. There is no cryptographic code in Exim itself for
1906 implementing SSL.
1907
1908 If you do not want TLS support you should set
1909 .code
1910 DISABLE_TLS=yes
1911 .endd
1912 in &_Local/Makefile_&.
1913
1914 If OpenSSL is installed, you should set
1915 .code
1916 USE_OPENSL=yes
1917 TLS_LIBS=-lssl -lcrypto
1918 .endd
1919 in &_Local/Makefile_&. You may also need to specify the locations of the
1920 OpenSSL library and include files. For example:
1921 .code
1922 USE_OPENSSL=yes
1923 TLS_LIBS=-L/usr/local/openssl/lib -lssl -lcrypto
1924 TLS_INCLUDE=-I/usr/local/openssl/include/
1925 .endd
1926 .cindex "pkg-config" "OpenSSL"
1927 If you have &'pkg-config'& available, then instead you can just use:
1928 .code
1929 USE_OPENSSL=yes
1930 USE_OPENSSL_PC=openssl
1931 .endd
1932 .cindex "USE_GNUTLS"
1933 If GnuTLS is installed, you should set
1934 .code
1935 USE_GNUTLS=yes
1936 TLS_LIBS=-lgnutls -ltasn1 -lgcrypt
1937 .endd
1938 in &_Local/Makefile_&, and again you may need to specify the locations of the
1939 library and include files. For example:
1940 .code
1941 USE_GNUTLS=yes
1942 TLS_LIBS=-L/usr/gnu/lib -lgnutls -ltasn1 -lgcrypt
1943 TLS_INCLUDE=-I/usr/gnu/include
1944 .endd
1945 .cindex "pkg-config" "GnuTLS"
1946 If you have &'pkg-config'& available, then instead you can just use:
1947 .code
1948 USE_GNUTLS=yes
1949 USE_GNUTLS_PC=gnutls
1950 .endd
1951
1952 You do not need to set TLS_INCLUDE if the relevant directory is already
1953 specified in INCLUDE. Details of how to configure Exim to make use of TLS are
1954 given in chapter &<<CHAPTLS>>&.
1955
1956
1957
1958
1959 .section "Use of tcpwrappers" "SECID27"
1960
1961 .cindex "tcpwrappers, building Exim to support"
1962 .cindex "USE_TCP_WRAPPERS"
1963 .cindex "TCP_WRAPPERS_DAEMON_NAME"
1964 .cindex "tcp_wrappers_daemon_name"
1965 Exim can be linked with the &'tcpwrappers'& library in order to check incoming
1966 SMTP calls using the &'tcpwrappers'& control files. This may be a convenient
1967 alternative to Exim's own checking facilities for installations that are
1968 already making use of &'tcpwrappers'& for other purposes. To do this, you
1969 should set USE_TCP_WRAPPERS in &_Local/Makefile_&, arrange for the file
1970 &_tcpd.h_& to be available at compile time, and also ensure that the library
1971 &_libwrap.a_& is available at link time, typically by including &%-lwrap%& in
1972 EXTRALIBS_EXIM. For example, if &'tcpwrappers'& is installed in &_/usr/local_&,
1973 you might have
1974 .code
1975 USE_TCP_WRAPPERS=yes
1976 CFLAGS=-O -I/usr/local/include
1977 EXTRALIBS_EXIM=-L/usr/local/lib -lwrap
1978 .endd
1979 in &_Local/Makefile_&. The daemon name to use in the &'tcpwrappers'& control
1980 files is &"exim"&. For example, the line
1981 .code
1982 exim : LOCAL  192.168.1.  .friendly.domain.example
1983 .endd
1984 in your &_/etc/hosts.allow_& file allows connections from the local host, from
1985 the subnet 192.168.1.0/24, and from all hosts in &'friendly.domain.example'&.
1986 All other connections are denied. The daemon name used by &'tcpwrappers'&
1987 can be changed at build time by setting TCP_WRAPPERS_DAEMON_NAME in
1988 &_Local/Makefile_&, or by setting tcp_wrappers_daemon_name in the
1989 configure file. Consult the &'tcpwrappers'& documentation for
1990 further details.
1991
1992
1993 .section "Including support for IPv6" "SECID28"
1994 .cindex "IPv6" "including support for"
1995 Exim contains code for use on systems that have IPv6 support. Setting
1996 &`HAVE_IPV6=YES`& in &_Local/Makefile_& causes the IPv6 code to be included;
1997 it may also be necessary to set IPV6_INCLUDE and IPV6_LIBS on systems
1998 where the IPv6 support is not fully integrated into the normal include and
1999 library files.
2000
2001 Two different types of DNS record for handling IPv6 addresses have been
2002 defined. AAAA records (analogous to A records for IPv4) are in use, and are
2003 currently seen as the mainstream. Another record type called A6 was proposed
2004 as better than AAAA because it had more flexibility. However, it was felt to be
2005 over-complex, and its status was reduced to &"experimental"&.
2006 Exim used to
2007 have a compile option for including A6 record support but this has now been
2008 withdrawn.
2009
2010
2011
2012 .section "Dynamically loaded lookup module support" "SECTdynamicmodules"
2013 .cindex "lookup modules"
2014 .cindex "dynamic modules"
2015 .cindex ".so building"
2016 On some platforms, Exim supports not compiling all lookup types directly into
2017 the main binary, instead putting some into external modules which can be loaded
2018 on demand.
2019 This permits packagers to build Exim with support for lookups with extensive
2020 library dependencies without requiring all users to install all of those
2021 dependencies.
2022 Most, but not all, lookup types can be built this way.
2023
2024 Set &`LOOKUP_MODULE_DIR`& to the directory into which the modules will be
2025 installed; Exim will only load modules from that directory, as a security
2026 measure.  You will need to set &`CFLAGS_DYNAMIC`& if not already defined
2027 for your OS; see &_OS/Makefile-Linux_& for an example.
2028 Some other requirements for adjusting &`EXTRALIBS`& may also be necessary,
2029 see &_src/EDITME_& for details.
2030
2031 Then, for each module to be loaded dynamically, define the relevant
2032 &`LOOKUP_`&<&'lookup_type'&> flags to have the value "2" instead of "yes".
2033 For example, this will build in lsearch but load sqlite and mysql support
2034 on demand:
2035 .code
2036 LOOKUP_LSEARCH=yes
2037 LOOKUP_SQLITE=2
2038 LOOKUP_MYSQL=2
2039 .endd
2040
2041
2042 .section "The building process" "SECID29"
2043 .cindex "build directory"
2044 Once &_Local/Makefile_& (and &_Local/eximon.conf_&, if required) have been
2045 created, run &'make'& at the top level. It determines the architecture and
2046 operating system types, and creates a build directory if one does not exist.
2047 For example, on a Sun system running Solaris 8, the directory
2048 &_build-SunOS5-5.8-sparc_& is created.
2049 .cindex "symbolic link" "to source files"
2050 Symbolic links to relevant source files are installed in the build directory.
2051
2052 If this is the first time &'make'& has been run, it calls a script that builds
2053 a make file inside the build directory, using the configuration files from the
2054 &_Local_& directory. The new make file is then passed to another instance of
2055 &'make'&. This does the real work, building a number of utility scripts, and
2056 then compiling and linking the binaries for the Exim monitor (if configured), a
2057 number of utility programs, and finally Exim itself. The command &`make
2058 makefile`& can be used to force a rebuild of the make file in the build
2059 directory, should this ever be necessary.
2060
2061 If you have problems building Exim, check for any comments there may be in the
2062 &_README_& file concerning your operating system, and also take a look at the
2063 FAQ, where some common problems are covered.
2064
2065
2066
2067 .section 'Output from &"make"&' "SECID283"
2068 The output produced by the &'make'& process for compile lines is often very
2069 unreadable, because these lines can be very long. For this reason, the normal
2070 output is suppressed by default, and instead output similar to that which
2071 appears when compiling the 2.6 Linux kernel is generated: just a short line for
2072 each module that is being compiled or linked. However, it is still possible to
2073 get the full output, by calling &'make'& like this:
2074 .code
2075 FULLECHO='' make -e
2076 .endd
2077 The value of FULLECHO defaults to &"@"&, the flag character that suppresses
2078 command reflection in &'make'&. When you ask for the full output, it is
2079 given in addition to the short output.
2080
2081
2082
2083 .section "Overriding build-time options for Exim" "SECToverride"
2084 .cindex "build-time options, overriding"
2085 The main make file that is created at the beginning of the building process
2086 consists of the concatenation of a number of files which set configuration
2087 values, followed by a fixed set of &'make'& instructions. If a value is set
2088 more than once, the last setting overrides any previous ones. This provides a
2089 convenient way of overriding defaults. The files that are concatenated are, in
2090 order:
2091 .display
2092 &_OS/Makefile-Default_&
2093 &_OS/Makefile-_&<&'ostype'&>
2094 &_Local/Makefile_&
2095 &_Local/Makefile-_&<&'ostype'&>
2096 &_Local/Makefile-_&<&'archtype'&>
2097 &_Local/Makefile-_&<&'ostype'&>-<&'archtype'&>
2098 &_OS/Makefile-Base_&
2099 .endd
2100 .cindex "&_Local/Makefile_&"
2101 .cindex "building Exim" "operating system type"
2102 .cindex "building Exim" "architecture type"
2103 where <&'ostype'&> is the operating system type and <&'archtype'&> is the
2104 architecture type. &_Local/Makefile_& is required to exist, and the building
2105 process fails if it is absent. The other three &_Local_& files are optional,
2106 and are often not needed.
2107
2108 The values used for <&'ostype'&> and <&'archtype'&> are obtained from scripts
2109 called &_scripts/os-type_& and &_scripts/arch-type_& respectively. If either of
2110 the environment variables EXIM_OSTYPE or EXIM_ARCHTYPE is set, their
2111 values are used, thereby providing a means of forcing particular settings.
2112 Otherwise, the scripts try to get values from the &%uname%& command. If this
2113 fails, the shell variables OSTYPE and ARCHTYPE are inspected. A number
2114 of &'ad hoc'& transformations are then applied, to produce the standard names
2115 that Exim expects. You can run these scripts directly from the shell in order
2116 to find out what values are being used on your system.
2117
2118
2119 &_OS/Makefile-Default_& contains comments about the variables that are set
2120 therein. Some (but not all) are mentioned below. If there is something that
2121 needs changing, review the contents of this file and the contents of the make
2122 file for your operating system (&_OS/Makefile-<ostype>_&) to see what the
2123 default values are.
2124
2125
2126 .cindex "building Exim" "overriding default settings"
2127 If you need to change any of the values that are set in &_OS/Makefile-Default_&
2128 or in &_OS/Makefile-<ostype>_&, or to add any new definitions, you do not
2129 need to change the original files. Instead, you should make the changes by
2130 putting the new values in an appropriate &_Local_& file. For example,
2131 .cindex "Tru64-Unix build-time settings"
2132 when building Exim in many releases of the Tru64-Unix (formerly Digital UNIX,
2133 formerly DEC-OSF1) operating system, it is necessary to specify that the C
2134 compiler is called &'cc'& rather than &'gcc'&. Also, the compiler must be
2135 called with the option &%-std1%&, to make it recognize some of the features of
2136 Standard C that Exim uses. (Most other compilers recognize Standard C by
2137 default.) To do this, you should create a file called &_Local/Makefile-OSF1_&
2138 containing the lines
2139 .code
2140 CC=cc
2141 CFLAGS=-std1
2142 .endd
2143 If you are compiling for just one operating system, it may be easier to put
2144 these lines directly into &_Local/Makefile_&.
2145
2146 Keeping all your local configuration settings separate from the distributed
2147 files makes it easy to transfer them to new versions of Exim simply by copying
2148 the contents of the &_Local_& directory.
2149
2150
2151 .cindex "NIS lookup type" "including support for"
2152 .cindex "NIS+ lookup type" "including support for"
2153 .cindex "LDAP" "including support for"
2154 .cindex "lookup" "inclusion in binary"
2155 Exim contains support for doing LDAP, NIS, NIS+, and other kinds of file
2156 lookup, but not all systems have these components installed, so the default is
2157 not to include the relevant code in the binary. All the different kinds of file
2158 and database lookup that Exim supports are implemented as separate code modules
2159 which are included only if the relevant compile-time options are set. In the
2160 case of LDAP, NIS, and NIS+, the settings for &_Local/Makefile_& are:
2161 .code
2162 LOOKUP_LDAP=yes
2163 LOOKUP_NIS=yes
2164 LOOKUP_NISPLUS=yes
2165 .endd
2166 and similar settings apply to the other lookup types. They are all listed in
2167 &_src/EDITME_&. In many cases the relevant include files and interface
2168 libraries need to be installed before compiling Exim.
2169 .cindex "cdb" "including support for"
2170 However, there are some optional lookup types (such as cdb) for which
2171 the code is entirely contained within Exim, and no external include
2172 files or libraries are required. When a lookup type is not included in the
2173 binary, attempts to configure Exim to use it cause runtime configuration
2174 errors.
2175
2176 .cindex "pkg-config" "lookups"
2177 .cindex "pkg-config" "authenticators"
2178 Many systems now use a tool called &'pkg-config'& to encapsulate information
2179 about how to compile against a library; Exim has some initial support for
2180 being able to use pkg-config for lookups and authenticators.  For any given
2181 makefile variable which starts &`LOOKUP_`& or &`AUTH_`&, you can add a new
2182 variable with the &`_PC`& suffix in the name and assign as the value the
2183 name of the package to be queried.  The results of querying via the
2184 &'pkg-config'& command will be added to the appropriate Makefile variables
2185 with &`+=`& directives, so your version of &'make'& will need to support that
2186 syntax.  For instance:
2187 .code
2188 LOOKUP_SQLITE=yes
2189 LOOKUP_SQLITE_PC=sqlite3
2190 AUTH_GSASL=yes
2191 AUTH_GSASL_PC=libgsasl
2192 AUTH_HEIMDAL_GSSAPI=yes
2193 AUTH_HEIMDAL_GSSAPI_PC=heimdal-gssapi
2194 .endd
2195
2196 .cindex "Perl" "including support for"
2197 Exim can be linked with an embedded Perl interpreter, allowing Perl
2198 subroutines to be called during string expansion. To enable this facility,
2199 .code
2200 EXIM_PERL=perl.o
2201 .endd
2202 must be defined in &_Local/Makefile_&. Details of this facility are given in
2203 chapter &<<CHAPperl>>&.
2204
2205 .cindex "X11 libraries, location of"
2206 The location of the X11 libraries is something that varies a lot between
2207 operating systems, and there may be different versions of X11 to cope
2208 with. Exim itself makes no use of X11, but if you are compiling the Exim
2209 monitor, the X11 libraries must be available.
2210 The following three variables are set in &_OS/Makefile-Default_&:
2211 .code
2212 X11=/usr/X11R6
2213 XINCLUDE=-I$(X11)/include
2214 XLFLAGS=-L$(X11)/lib
2215 .endd
2216 These are overridden in some of the operating-system configuration files. For
2217 example, in &_OS/Makefile-SunOS5_& there is
2218 .code
2219 X11=/usr/openwin
2220 XINCLUDE=-I$(X11)/include
2221 XLFLAGS=-L$(X11)/lib -R$(X11)/lib
2222 .endd
2223 If you need to override the default setting for your operating system, place a
2224 definition of all three of these variables into your
2225 &_Local/Makefile-<ostype>_& file.
2226
2227 .cindex "EXTRALIBS"
2228 If you need to add any extra libraries to the link steps, these can be put in a
2229 variable called EXTRALIBS, which appears in all the link commands, but by
2230 default is not defined. In contrast, EXTRALIBS_EXIM is used only on the
2231 command for linking the main Exim binary, and not for any associated utilities.
2232
2233 .cindex "DBM libraries" "configuration for building"
2234 There is also DBMLIB, which appears in the link commands for binaries that
2235 use DBM functions (see also section &<<SECTdb>>&). Finally, there is
2236 EXTRALIBS_EXIMON, which appears only in the link step for the Exim monitor
2237 binary, and which can be used, for example, to include additional X11
2238 libraries.
2239
2240 .cindex "configuration file" "editing"
2241 The make file copes with rebuilding Exim correctly if any of the configuration
2242 files are edited. However, if an optional configuration file is deleted, it is
2243 necessary to touch the associated non-optional file (that is,
2244 &_Local/Makefile_& or &_Local/eximon.conf_&) before rebuilding.
2245
2246
2247 .section "OS-specific header files" "SECID30"
2248 .cindex "&_os.h_&"
2249 .cindex "building Exim" "OS-specific C header files"
2250 The &_OS_& directory contains a number of files with names of the form
2251 &_os.h-<ostype>_&. These are system-specific C header files that should not
2252 normally need to be changed. There is a list of macro settings that are
2253 recognized in the file &_OS/os.configuring_&, which should be consulted if you
2254 are porting Exim to a new operating system.
2255
2256
2257
2258 .section "Overriding build-time options for the monitor" "SECID31"
2259 .cindex "building Eximon"
2260 A similar process is used for overriding things when building the Exim monitor,
2261 where the files that are involved are
2262 .display
2263 &_OS/eximon.conf-Default_&
2264 &_OS/eximon.conf-_&<&'ostype'&>
2265 &_Local/eximon.conf_&
2266 &_Local/eximon.conf-_&<&'ostype'&>
2267 &_Local/eximon.conf-_&<&'archtype'&>
2268 &_Local/eximon.conf-_&<&'ostype'&>-<&'archtype'&>
2269 .endd
2270 .cindex "&_Local/eximon.conf_&"
2271 As with Exim itself, the final three files need not exist, and in this case the
2272 &_OS/eximon.conf-<ostype>_& file is also optional. The default values in
2273 &_OS/eximon.conf-Default_& can be overridden dynamically by setting environment
2274 variables of the same name, preceded by EXIMON_. For example, setting
2275 EXIMON_LOG_DEPTH in the environment overrides the value of
2276 LOG_DEPTH at runtime.
2277 .ecindex IIDbuex
2278
2279
2280 .section "Installing Exim binaries and scripts" "SECID32"
2281 .cindex "installing Exim"
2282 .cindex "BIN_DIRECTORY"
2283 The command &`make install`& runs the &(exim_install)& script with no
2284 arguments. The script copies binaries and utility scripts into the directory
2285 whose name is specified by the BIN_DIRECTORY setting in &_Local/Makefile_&.
2286 .cindex "setuid" "installing Exim with"
2287 The install script copies files only if they are newer than the files they are
2288 going to replace. The Exim binary is required to be owned by root and have the
2289 &'setuid'& bit set, for normal configurations. Therefore, you must run &`make
2290 install`& as root so that it can set up the Exim binary in this way. However, in
2291 some special situations (for example, if a host is doing no local deliveries)
2292 it may be possible to run Exim without making the binary setuid root (see
2293 chapter &<<CHAPsecurity>>& for details).
2294
2295 .cindex "CONFIGURE_FILE"
2296 Exim's runtime configuration file is named by the CONFIGURE_FILE setting
2297 in &_Local/Makefile_&. If this names a single file, and the file does not
2298 exist, the default configuration file &_src/configure.default_& is copied there
2299 by the installation script. If a runtime configuration file already exists, it
2300 is left alone. If CONFIGURE_FILE is a colon-separated list, naming several
2301 alternative files, no default is installed.
2302
2303 .cindex "system aliases file"
2304 .cindex "&_/etc/aliases_&"
2305 One change is made to the default configuration file when it is installed: the
2306 default configuration contains a router that references a system aliases file.
2307 The path to this file is set to the value specified by
2308 SYSTEM_ALIASES_FILE in &_Local/Makefile_& (&_/etc/aliases_& by default).
2309 If the system aliases file does not exist, the installation script creates it,
2310 and outputs a comment to the user.
2311
2312 The created file contains no aliases, but it does contain comments about the
2313 aliases a site should normally have. Mail aliases have traditionally been
2314 kept in &_/etc/aliases_&. However, some operating systems are now using
2315 &_/etc/mail/aliases_&. You should check if yours is one of these, and change
2316 Exim's configuration if necessary.
2317
2318 The default configuration uses the local host's name as the only local domain,
2319 and is set up to do local deliveries into the shared directory &_/var/mail_&,
2320 running as the local user. System aliases and &_.forward_& files in users' home
2321 directories are supported, but no NIS or NIS+ support is configured. Domains
2322 other than the name of the local host are routed using the DNS, with delivery
2323 over SMTP.
2324
2325 It is possible to install Exim for special purposes (such as building a binary
2326 distribution) in a private part of the file system. You can do this by a
2327 command such as
2328 .code
2329 make DESTDIR=/some/directory/ install
2330 .endd
2331 This has the effect of pre-pending the specified directory to all the file
2332 paths, except the name of the system aliases file that appears in the default
2333 configuration. (If a default alias file is created, its name &'is'& modified.)
2334 For backwards compatibility, ROOT is used if DESTDIR is not set,
2335 but this usage is deprecated.
2336
2337 .cindex "installing Exim" "what is not installed"
2338 Running &'make install'& does not copy the Exim 4 conversion script
2339 &'convert4r4'&. You will probably run this only once if you are
2340 upgrading from Exim 3. None of the documentation files in the &_doc_&
2341 directory are copied, except for the info files when you have set
2342 INFO_DIRECTORY, as described in section &<<SECTinsinfdoc>>& below.
2343
2344 For the utility programs, old versions are renamed by adding the suffix &_.O_&
2345 to their names. The Exim binary itself, however, is handled differently. It is
2346 installed under a name that includes the version number and the compile number,
2347 for example, &_exim-&version()-1_&. The script then arranges for a symbolic link
2348 called &_exim_& to point to the binary. If you are updating a previous version
2349 of Exim, the script takes care to ensure that the name &_exim_& is never absent
2350 from the directory (as seen by other processes).
2351
2352 .cindex "installing Exim" "testing the script"
2353 If you want to see what the &'make install'& will do before running it for
2354 real, you can pass the &%-n%& option to the installation script by this
2355 command:
2356 .code
2357 make INSTALL_ARG=-n install
2358 .endd
2359 The contents of the variable INSTALL_ARG are passed to the installation
2360 script. You do not need to be root to run this test. Alternatively, you can run
2361 the installation script directly, but this must be from within the build
2362 directory. For example, from the top-level Exim directory you could use this
2363 command:
2364 .code
2365 (cd build-SunOS5-5.5.1-sparc; ../scripts/exim_install -n)
2366 .endd
2367 .cindex "installing Exim" "install script options"
2368 There are two other options that can be supplied to the installation script.
2369
2370 .ilist
2371 &%-no_chown%& bypasses the call to change the owner of the installed binary
2372 to root, and the call to make it a setuid binary.
2373 .next
2374 &%-no_symlink%& bypasses the setting up of the symbolic link &_exim_& to the
2375 installed binary.
2376 .endlist
2377
2378 INSTALL_ARG can be used to pass these options to the script. For example:
2379 .code
2380 make INSTALL_ARG=-no_symlink install
2381 .endd
2382 The installation script can also be given arguments specifying which files are
2383 to be copied. For example, to install just the Exim binary, and nothing else,
2384 without creating the symbolic link, you could use:
2385 .code
2386 make INSTALL_ARG='-no_symlink exim' install
2387 .endd
2388
2389
2390
2391 .section "Installing info documentation" "SECTinsinfdoc"
2392 .cindex "installing Exim" "&'info'& documentation"
2393 Not all systems use the GNU &'info'& system for documentation, and for this
2394 reason, the Texinfo source of Exim's documentation is not included in the main
2395 distribution. Instead it is available separately from the FTP site (see section
2396 &<<SECTavail>>&).
2397
2398 If you have defined INFO_DIRECTORY in &_Local/Makefile_& and the Texinfo
2399 source of the documentation is found in the source tree, running &`make
2400 install`& automatically builds the info files and installs them.
2401
2402
2403
2404 .section "Setting up the spool directory" "SECID33"
2405 .cindex "spool directory" "creating"
2406 When it starts up, Exim tries to create its spool directory if it does not
2407 exist. The Exim uid and gid are used for the owner and group of the spool
2408 directory. Sub-directories are automatically created in the spool directory as
2409 necessary.
2410
2411
2412
2413
2414 .section "Testing" "SECID34"
2415 .cindex "testing" "installation"
2416 Having installed Exim, you can check that the runtime configuration file is
2417 syntactically valid by running the following command, which assumes that the
2418 Exim binary directory is within your PATH environment variable:
2419 .code
2420 exim -bV
2421 .endd
2422 If there are any errors in the configuration file, Exim outputs error messages.
2423 Otherwise it outputs the version number and build date,
2424 the DBM library that is being used, and information about which drivers and
2425 other optional code modules are included in the binary.
2426 Some simple routing tests can be done by using the address testing option. For
2427 example,
2428 .display
2429 &`exim -bt`& <&'local username'&>
2430 .endd
2431 should verify that it recognizes a local mailbox, and
2432 .display
2433 &`exim -bt`& <&'remote address'&>
2434 .endd
2435 a remote one. Then try getting it to deliver mail, both locally and remotely.
2436 This can be done by passing messages directly to Exim, without going through a
2437 user agent. For example:
2438 .code
2439 exim -v postmaster@your.domain.example
2440 From: user@your.domain.example
2441 To: postmaster@your.domain.example
2442 Subject: Testing Exim
2443
2444 This is a test message.
2445 ^D
2446 .endd
2447 The &%-v%& option causes Exim to output some verification of what it is doing.
2448 In this case you should see copies of three log lines, one for the message's
2449 arrival, one for its delivery, and one containing &"Completed"&.
2450
2451 .cindex "delivery" "problems with"
2452 If you encounter problems, look at Exim's log files (&'mainlog'& and
2453 &'paniclog'&) to see if there is any relevant information there. Another source
2454 of information is running Exim with debugging turned on, by specifying the
2455 &%-d%& option. If a message is stuck on Exim's spool, you can force a delivery
2456 with debugging turned on by a command of the form
2457 .display
2458 &`exim -d -M`& <&'exim-message-id'&>
2459 .endd
2460 You must be root or an &"admin user"& in order to do this. The &%-d%& option
2461 produces rather a lot of output, but you can cut this down to specific areas.
2462 For example, if you use &%-d-all+route%& only the debugging information
2463 relevant to routing is included. (See the &%-d%& option in chapter
2464 &<<CHAPcommandline>>& for more details.)
2465
2466 .cindex '&"sticky"& bit'
2467 .cindex "lock files"
2468 One specific problem that has shown up on some sites is the inability to do
2469 local deliveries into a shared mailbox directory, because it does not have the
2470 &"sticky bit"& set on it. By default, Exim tries to create a lock file before
2471 writing to a mailbox file, and if it cannot create the lock file, the delivery
2472 is deferred. You can get round this either by setting the &"sticky bit"& on the
2473 directory, or by setting a specific group for local deliveries and allowing
2474 that group to create files in the directory (see the comments above the
2475 &(local_delivery)& transport in the default configuration file). Another
2476 approach is to configure Exim not to use lock files, but just to rely on
2477 &[fcntl()]& locking instead. However, you should do this only if all user
2478 agents also use &[fcntl()]& locking. For further discussion of locking issues,
2479 see chapter &<<CHAPappendfile>>&.
2480
2481 One thing that cannot be tested on a system that is already running an MTA is
2482 the receipt of incoming SMTP mail on the standard SMTP port. However, the
2483 &%-oX%& option can be used to run an Exim daemon that listens on some other
2484 port, or &'inetd'& can be used to do this. The &%-bh%& option and the
2485 &'exim_checkaccess'& utility can be used to check out policy controls on
2486 incoming SMTP mail.
2487
2488 Testing a new version on a system that is already running Exim can most easily
2489 be done by building a binary with a different CONFIGURE_FILE setting. From
2490 within the runtime configuration, all other file and directory names
2491 that Exim uses can be altered, in order to keep it entirely clear of the
2492 production version.
2493
2494
2495 .section "Replacing another MTA with Exim" "SECID35"
2496 .cindex "replacing another MTA"
2497 Building and installing Exim for the first time does not of itself put it in
2498 general use. The name by which the system's MTA is called by mail user agents
2499 is either &_/usr/sbin/sendmail_&, or &_/usr/lib/sendmail_& (depending on the
2500 operating system), and it is necessary to make this name point to the &'exim'&
2501 binary in order to get the user agents to pass messages to Exim. This is
2502 normally done by renaming any existing file and making &_/usr/sbin/sendmail_&
2503 or &_/usr/lib/sendmail_&
2504 .cindex "symbolic link" "to &'exim'& binary"
2505 a symbolic link to the &'exim'& binary. It is a good idea to remove any setuid
2506 privilege and executable status from the old MTA. It is then necessary to stop
2507 and restart the mailer daemon, if one is running.
2508
2509 .cindex "FreeBSD, MTA indirection"
2510 .cindex "&_/etc/mail/mailer.conf_&"
2511 Some operating systems have introduced alternative ways of switching MTAs. For
2512 example, if you are running FreeBSD, you need to edit the file
2513 &_/etc/mail/mailer.conf_& instead of setting up a symbolic link as just
2514 described. A typical example of the contents of this file for running Exim is
2515 as follows:
2516 .code
2517 sendmail            /usr/exim/bin/exim
2518 send-mail           /usr/exim/bin/exim
2519 mailq               /usr/exim/bin/exim -bp
2520 newaliases          /usr/bin/true
2521 .endd
2522 Once you have set up the symbolic link, or edited &_/etc/mail/mailer.conf_&,
2523 your Exim installation is &"live"&. Check it by sending a message from your
2524 favourite user agent.
2525
2526 You should consider what to tell your users about the change of MTA. Exim may
2527 have different capabilities to what was previously running, and there are
2528 various operational differences such as the text of messages produced by
2529 command line options and in bounce messages. If you allow your users to make
2530 use of Exim's filtering capabilities, you should make the document entitled
2531 &'Exim's interface to mail filtering'& available to them.
2532
2533
2534
2535 .section "Upgrading Exim" "SECID36"
2536 .cindex "upgrading Exim"
2537 If you are already running Exim on your host, building and installing a new
2538 version automatically makes it available to MUAs, or any other programs that
2539 call the MTA directly. However, if you are running an Exim daemon, you do need
2540 .cindex restart "on HUP signal"
2541 .cindex signal "HUP, to restart"
2542 to send it a HUP signal, to make it re-execute itself, and thereby pick up the
2543 new binary. You do not need to stop processing mail in order to install a new
2544 version of Exim. The install script does not modify an existing runtime
2545 configuration file.
2546
2547
2548
2549
2550 .section "Stopping the Exim daemon on Solaris" "SECID37"
2551 .cindex "Solaris" "stopping Exim on"
2552 The standard command for stopping the mailer daemon on Solaris is
2553 .code
2554 /etc/init.d/sendmail stop
2555 .endd
2556 If &_/usr/lib/sendmail_& has been turned into a symbolic link, this script
2557 fails to stop Exim because it uses the command &'ps -e'& and greps the output
2558 for the text &"sendmail"&; this is not present because the actual program name
2559 (that is, &"exim"&) is given by the &'ps'& command with these options. A
2560 solution is to replace the line that finds the process id with something like
2561 .code
2562 pid=`cat /var/spool/exim/exim-daemon.pid`
2563 .endd
2564 to obtain the daemon's pid directly from the file that Exim saves it in.
2565
2566 Note, however, that stopping the daemon does not &"stop Exim"&. Messages can
2567 still be received from local processes, and if automatic delivery is configured
2568 (the normal case), deliveries will still occur.
2569
2570
2571
2572
2573 . ////////////////////////////////////////////////////////////////////////////
2574 . ////////////////////////////////////////////////////////////////////////////
2575
2576 .chapter "The Exim command line" "CHAPcommandline"
2577 .scindex IIDclo1 "command line" "options"
2578 .scindex IIDclo2 "options" "command line"
2579 Exim's command line takes the standard Unix form of a sequence of options,
2580 each starting with a hyphen character, followed by a number of arguments. The
2581 options are compatible with the main options of Sendmail, and there are also
2582 some additional options, some of which are compatible with Smail 3. Certain
2583 combinations of options do not make sense, and provoke an error if used.
2584 The form of the arguments depends on which options are set.
2585
2586
2587 .section "Setting options by program name" "SECID38"
2588 .cindex "&'mailq'&"
2589 If Exim is called under the name &'mailq'&, it behaves as if the option &%-bp%&
2590 were present before any other options.
2591 The &%-bp%& option requests a listing of the contents of the mail queue on the
2592 standard output.
2593 This feature is for compatibility with some systems that contain a command of
2594 that name in one of the standard libraries, symbolically linked to
2595 &_/usr/sbin/sendmail_& or &_/usr/lib/sendmail_&.
2596
2597 .cindex "&'rsmtp'&"
2598 If Exim is called under the name &'rsmtp'& it behaves as if the option &%-bS%&
2599 were present before any other options, for compatibility with Smail. The
2600 &%-bS%& option is used for reading in a number of messages in batched SMTP
2601 format.
2602
2603 .cindex "&'rmail'&"
2604 If Exim is called under the name &'rmail'& it behaves as if the &%-i%& and
2605 &%-oee%& options were present before any other options, for compatibility with
2606 Smail. The name &'rmail'& is used as an interface by some UUCP systems.
2607
2608 .cindex "&'runq'&"
2609 .cindex "queue runner"
2610 If Exim is called under the name &'runq'& it behaves as if the option &%-q%&
2611 were present before any other options, for compatibility with Smail. The &%-q%&
2612 option causes a single queue runner process to be started.
2613
2614 .cindex "&'newaliases'&"
2615 .cindex "alias file" "building"
2616 .cindex "Sendmail compatibility" "calling Exim as &'newaliases'&"
2617 If Exim is called under the name &'newaliases'& it behaves as if the option
2618 &%-bi%& were present before any other options, for compatibility with Sendmail.
2619 This option is used for rebuilding Sendmail's alias file. Exim does not have
2620 the concept of a single alias file, but can be configured to run a given
2621 command if called with the &%-bi%& option.
2622
2623
2624 .section "Trusted and admin users" "SECTtrustedadmin"
2625 Some Exim options are available only to &'trusted users'& and others are
2626 available only to &'admin users'&. In the description below, the phrases &"Exim
2627 user"& and &"Exim group"& mean the user and group defined by EXIM_USER and
2628 EXIM_GROUP in &_Local/Makefile_& or set by the &%exim_user%& and
2629 &%exim_group%& options. These do not necessarily have to use the name &"exim"&.
2630
2631 .ilist
2632 .cindex "trusted users" "definition of"
2633 .cindex "user" "trusted definition of"
2634 The trusted users are root, the Exim user, any user listed in the
2635 &%trusted_users%& configuration option, and any user whose current group or any
2636 supplementary group is one of those listed in the &%trusted_groups%&
2637 configuration option. Note that the Exim group is not automatically trusted.
2638
2639 .cindex '&"From"& line'
2640 .cindex "envelope from"
2641 .cindex "envelope sender"
2642 Trusted users are always permitted to use the &%-f%& option or a leading
2643 &"From&~"& line to specify the envelope sender of a message that is passed to
2644 Exim through the local interface (see the &%-bm%& and &%-f%& options below).
2645 See the &%untrusted_set_sender%& option for a way of permitting non-trusted
2646 users to set envelope senders.
2647
2648 .cindex "&'From:'& header line"
2649 .cindex "&'Sender:'& header line"
2650 .cindex "header lines" "From:"
2651 .cindex "header lines" "Sender:"
2652 For a trusted user, there is never any check on the contents of the &'From:'&
2653 header line, and a &'Sender:'& line is never added. Furthermore, any existing
2654 &'Sender:'& line in incoming local (non-TCP/IP) messages is not removed.
2655
2656 Trusted users may also specify a host name, host address, interface address,
2657 protocol name, ident value, and authentication data when submitting a message
2658 locally. Thus, they are able to insert messages into Exim's queue locally that
2659 have the characteristics of messages received from a remote host. Untrusted
2660 users may in some circumstances use &%-f%&, but can never set the other values
2661 that are available to trusted users.
2662 .next
2663 .cindex "user" "admin definition of"
2664 .cindex "admin user" "definition of"
2665 The admin users are root, the Exim user, and any user that is a member of the
2666 Exim group or of any group listed in the &%admin_groups%& configuration option.
2667 The current group does not have to be one of these groups.
2668
2669 Admin users are permitted to list the queue, and to carry out certain
2670 operations on messages, for example, to force delivery failures. It is also
2671 necessary to be an admin user in order to see the full information provided by
2672 the Exim monitor, and full debugging output.
2673
2674 By default, the use of the &%-M%&, &%-q%&, &%-R%&, and &%-S%& options to cause
2675 Exim to attempt delivery of messages on its queue is restricted to admin users.
2676 However, this restriction can be relaxed by setting the &%prod_requires_admin%&
2677 option false (that is, specifying &%no_prod_requires_admin%&).
2678
2679 Similarly, the use of the &%-bp%& option to list all the messages in the queue
2680 is restricted to admin users unless &%queue_list_requires_admin%& is set
2681 false.
2682 .endlist
2683
2684
2685 &*Warning*&: If you configure your system so that admin users are able to
2686 edit Exim's configuration file, you are giving those users an easy way of
2687 getting root. There is further discussion of this issue at the start of chapter
2688 &<<CHAPconf>>&.
2689
2690
2691
2692
2693 .section "Command line options" "SECID39"
2694 Exim's command line options are described in alphabetical order below. If none
2695 of the options that specifies a specific action (such as starting the daemon or
2696 a queue runner, or testing an address, or receiving a message in a specific
2697 format, or listing the queue) are present, and there is at least one argument
2698 on the command line, &%-bm%& (accept a local message on the standard input,
2699 with the arguments specifying the recipients) is assumed. Otherwise, Exim
2700 outputs a brief message about itself and exits.
2701
2702 . ////////////////////////////////////////////////////////////////////////////
2703 . Insert a stylized XML comment here, to identify the start of the command line
2704 . options. This is for the benefit of the Perl script that automatically
2705 . creates a man page for the options.
2706 . ////////////////////////////////////////////////////////////////////////////
2707
2708 .literal xml
2709 <!-- === Start of command line options === -->
2710 .literal off
2711
2712
2713 .vlist
2714 .vitem &%--%&
2715 .oindex "--"
2716 .cindex "options" "command line; terminating"
2717 This is a pseudo-option whose only purpose is to terminate the options and
2718 therefore to cause subsequent command line items to be treated as arguments
2719 rather than options, even if they begin with hyphens.
2720
2721 .vitem &%--help%&
2722 .oindex "&%--help%&"
2723 This option causes Exim to output a few sentences stating what it is.
2724 The same output is generated if the Exim binary is called with no options and
2725 no arguments.
2726
2727 .vitem &%--version%&
2728 .oindex "&%--version%&"
2729 This option is an alias for &%-bV%& and causes version information to be
2730 displayed.
2731
2732 .vitem &%-Ac%& &&&
2733        &%-Am%&
2734 .oindex "&%-Ac%&"
2735 .oindex "&%-Am%&"
2736 These options are used by Sendmail for selecting configuration files and are
2737 ignored by Exim.
2738
2739 .vitem &%-B%&<&'type'&>
2740 .oindex "&%-B%&"
2741 .cindex "8-bit characters"
2742 .cindex "Sendmail compatibility" "8-bit characters"
2743 This is a Sendmail option for selecting 7 or 8 bit processing. Exim is 8-bit
2744 clean; it ignores this option.
2745
2746 .vitem &%-bd%&
2747 .oindex "&%-bd%&"
2748 .cindex "daemon"
2749 .cindex "SMTP" "listener"
2750 .cindex "queue runner"
2751 This option runs Exim as a daemon, awaiting incoming SMTP connections. Usually
2752 the &%-bd%& option is combined with the &%-q%&<&'time'&> option, to specify
2753 that the daemon should also initiate periodic queue runs.
2754
2755 The &%-bd%& option can be used only by an admin user. If either of the &%-d%&
2756 (debugging) or &%-v%& (verifying) options are set, the daemon does not
2757 disconnect from the controlling terminal. When running this way, it can be
2758 stopped by pressing ctrl-C.
2759
2760 By default, Exim listens for incoming connections to the standard SMTP port on
2761 all the host's running interfaces. However, it is possible to listen on other
2762 ports, on multiple ports, and only on specific interfaces. Chapter
2763 &<<CHAPinterfaces>>& contains a description of the options that control this.
2764
2765 When a listening daemon
2766 .cindex "daemon" "process id (pid)"
2767 .cindex "pid (process id)" "of daemon"
2768 is started without the use of &%-oX%& (that is, without overriding the normal
2769 configuration), it writes its process id to a file called &_exim-daemon.pid_&
2770 in Exim's spool directory. This location can be overridden by setting
2771 PID_FILE_PATH in &_Local/Makefile_&. The file is written while Exim is still
2772 running as root.
2773
2774 When &%-oX%& is used on the command line to start a listening daemon, the
2775 process id is not written to the normal pid file path. However, &%-oP%& can be
2776 used to specify a path on the command line if a pid file is required.
2777
2778 The SIGHUP signal
2779 .cindex "SIGHUP"
2780 .cindex restart "on HUP signal"
2781 .cindex signal "HUP, to restart"
2782 .cindex "daemon" "restarting"
2783 .cindex signal "to reload configuration"
2784 .cindex daemon "reload configuration"
2785 .cindex reload configuration
2786 can be used to cause the daemon to re-execute itself. This should be done
2787 whenever Exim's configuration file, or any file that is incorporated into it by
2788 means of the &%.include%& facility, is changed, and also whenever a new version
2789 of Exim is installed. It is not necessary to do this when other files that are
2790 referenced from the configuration (for example, alias files) are changed,
2791 because these are reread each time they are used.
2792
2793 .vitem &%-bdf%&
2794 .oindex "&%-bdf%&"
2795 This option has the same effect as &%-bd%& except that it never disconnects
2796 from the controlling terminal, even when no debugging is specified.
2797
2798 .vitem &%-be%&
2799 .oindex "&%-be%&"
2800 .cindex "testing" "string expansion"
2801 .cindex "expansion" "testing"
2802 Run Exim in expansion testing mode. Exim discards its root privilege, to
2803 prevent ordinary users from using this mode to read otherwise inaccessible
2804 files. If no arguments are given, Exim runs interactively, prompting for lines
2805 of data. Otherwise, it processes each argument in turn.
2806
2807 If Exim was built with USE_READLINE=yes in &_Local/Makefile_&, it tries
2808 to load the &%libreadline%& library dynamically whenever the &%-be%& option is
2809 used without command line arguments. If successful, it uses the &[readline()]&
2810 function, which provides extensive line-editing facilities, for reading the
2811 test data. A line history is supported.
2812
2813 Long expansion expressions can be split over several lines by using backslash
2814 continuations. As in Exim's runtime configuration, white space at the start of
2815 continuation lines is ignored. Each argument or data line is passed through the
2816 string expansion mechanism, and the result is output. Variable values from the
2817 configuration file (for example, &$qualify_domain$&) are available, but no
2818 message-specific values (such as &$message_exim_id$&) are set, because no message
2819 is being processed (but see &%-bem%& and &%-Mset%&).
2820
2821 &*Note*&: If you use this mechanism to test lookups, and you change the data
2822 files or databases you are using, you must exit and restart Exim before trying
2823 the same lookup again. Otherwise, because each Exim process caches the results
2824 of lookups, you will just get the same result as before.
2825
2826 Macro processing is done on lines before string-expansion: new macros can be
2827 defined and macros will be expanded.
2828 Because macros in the config file are often used for secrets, those are only
2829 available to admin users.
2830
2831 .vitem &%-bem%&&~<&'filename'&>
2832 .oindex "&%-bem%&"
2833 .cindex "testing" "string expansion"
2834 .cindex "expansion" "testing"
2835 This option operates like &%-be%& except that it must be followed by the name
2836 of a file. For example:
2837 .code
2838 exim -bem /tmp/testmessage
2839 .endd
2840 The file is read as a message (as if receiving a locally-submitted non-SMTP
2841 message) before any of the test expansions are done. Thus, message-specific
2842 variables such as &$message_size$& and &$header_from:$& are available. However,
2843 no &'Received:'& header is added to the message. If the &%-t%& option is set,
2844 recipients are read from the headers in the normal way, and are shown in the
2845 &$recipients$& variable. Note that recipients cannot be given on the command
2846 line, because further arguments are taken as strings to expand (just like
2847 &%-be%&).
2848
2849 .vitem &%-bF%&&~<&'filename'&>
2850 .oindex "&%-bF%&"
2851 .cindex "system filter" "testing"
2852 .cindex "testing" "system filter"
2853 This option is the same as &%-bf%& except that it assumes that the filter being
2854 tested is a system filter. The additional commands that are available only in
2855 system filters are recognized.
2856
2857 .vitem &%-bf%&&~<&'filename'&>
2858 .oindex "&%-bf%&"
2859 .cindex "filter" "testing"
2860 .cindex "testing" "filter file"
2861 .cindex "forward file" "testing"
2862 .cindex "testing" "forward file"
2863 .cindex "Sieve filter" "testing"
2864 This option runs Exim in user filter testing mode; the file is the filter file
2865 to be tested, and a test message must be supplied on the standard input. If
2866 there are no message-dependent tests in the filter, an empty file can be
2867 supplied.
2868
2869 If you want to test a system filter file, use &%-bF%& instead of &%-bf%&. You
2870 can use both &%-bF%& and &%-bf%& on the same command, in order to test a system
2871 filter and a user filter in the same run. For example:
2872 .code
2873 exim -bF /system/filter -bf /user/filter </test/message
2874 .endd
2875 This is helpful when the system filter adds header lines or sets filter
2876 variables that are used by the user filter.
2877
2878 If the test filter file does not begin with one of the special lines
2879 .code
2880 # Exim filter
2881 # Sieve filter
2882 .endd
2883 it is taken to be a normal &_.forward_& file, and is tested for validity under
2884 that interpretation. See sections &<<SECTitenonfilred>>& to
2885 &<<SECTspecitredli>>& for a description of the possible contents of non-filter
2886 redirection lists.
2887
2888 The result of an Exim command that uses &%-bf%&, provided no errors are
2889 detected, is a list of the actions that Exim would try to take if presented
2890 with the message for real. More details of filter testing are given in the
2891 separate document entitled &'Exim's interfaces to mail filtering'&.
2892
2893 When testing a filter file,
2894 .cindex "&""From""& line"
2895 .cindex "envelope from"
2896 .cindex "envelope sender"
2897 .oindex "&%-f%&" "for filter testing"
2898 the envelope sender can be set by the &%-f%& option,
2899 or by a &"From&~"& line at the start of the test message. Various parameters
2900 that would normally be taken from the envelope recipient address of the message
2901 can be set by means of additional command line options (see the next four
2902 options).
2903
2904 .vitem &%-bfd%&&~<&'domain'&>
2905 .oindex "&%-bfd%&"
2906 .vindex "&$qualify_domain$&"
2907 This sets the domain of the recipient address when a filter file is being
2908 tested by means of the &%-bf%& option. The default is the value of
2909 &$qualify_domain$&.
2910
2911 .vitem &%-bfl%&&~<&'local&~part'&>
2912 .oindex "&%-bfl%&"
2913 This sets the local part of the recipient address when a filter file is being
2914 tested by means of the &%-bf%& option. The default is the username of the
2915 process that calls Exim. A local part should be specified with any prefix or
2916 suffix stripped, because that is how it appears to the filter when a message is
2917 actually being delivered.
2918
2919 .vitem &%-bfp%&&~<&'prefix'&>
2920 .oindex "&%-bfp%&"
2921 .cindex affix "filter testing"
2922 This sets the prefix of the local part of the recipient address when a filter
2923 file is being tested by means of the &%-bf%& option. The default is an empty
2924 prefix.
2925
2926 .vitem &%-bfs%&&~<&'suffix'&>
2927 .oindex "&%-bfs%&"
2928 .cindex affix "filter testing"
2929 This sets the suffix of the local part of the recipient address when a filter
2930 file is being tested by means of the &%-bf%& option. The default is an empty
2931 suffix.
2932
2933 .vitem &%-bh%&&~<&'IP&~address'&>
2934 .oindex "&%-bh%&"
2935 .cindex "testing" "incoming SMTP"
2936 .cindex "SMTP" "testing incoming"
2937 .cindex "testing" "relay control"
2938 .cindex "relaying" "testing configuration"
2939 .cindex "policy control" "testing"
2940 .cindex "debugging" "&%-bh%& option"
2941 This option runs a fake SMTP session as if from the given IP address, using the
2942 standard input and output. The IP address may include a port number at the end,
2943 after a full stop. For example:
2944 .code
2945 exim -bh 10.9.8.7.1234
2946 exim -bh fe80::a00:20ff:fe86:a061.5678
2947 .endd
2948 When an IPv6 address is given, it is converted into canonical form. In the case
2949 of the second example above, the value of &$sender_host_address$& after
2950 conversion to the canonical form is
2951 &`fe80:0000:0000:0a00:20ff:fe86:a061.5678`&.
2952
2953 Comments as to what is going on are written to the standard error file. These
2954 include lines beginning with &"LOG"& for anything that would have been logged.
2955 This facility is provided for testing configuration options for incoming
2956 messages, to make sure they implement the required policy. For example, you can
2957 test your relay controls using &%-bh%&.
2958
2959 &*Warning 1*&:
2960 .cindex "RFC 1413"
2961 You can test features of the configuration that rely on ident (RFC 1413)
2962 information by using the &%-oMt%& option. However, Exim cannot actually perform
2963 an ident callout when testing using &%-bh%& because there is no incoming SMTP
2964 connection.
2965
2966 &*Warning 2*&: Address verification callouts (see section &<<SECTcallver>>&)
2967 are also skipped when testing using &%-bh%&. If you want these callouts to
2968 occur, use &%-bhc%& instead.
2969
2970 Messages supplied during the testing session are discarded, and nothing is
2971 written to any of the real log files. There may be pauses when DNS (and other)
2972 lookups are taking place, and of course these may time out. The &%-oMi%& option
2973 can be used to specify a specific IP interface and port if this is important,
2974 and &%-oMaa%& and &%-oMai%& can be used to set parameters as if the SMTP
2975 session were authenticated.
2976
2977 The &'exim_checkaccess'& utility is a &"packaged"& version of &%-bh%& whose
2978 output just states whether a given recipient address from a given host is
2979 acceptable or not. See section &<<SECTcheckaccess>>&.
2980
2981 Features such as authentication and encryption, where the client input is not
2982 plain text, cannot easily be tested with &%-bh%&. Instead, you should use a
2983 specialized SMTP test program such as
2984 &url(https://www.jetmore.org/john/code/swaks/,swaks).
2985
2986 .vitem &%-bhc%&&~<&'IP&~address'&>
2987 .oindex "&%-bhc%&"
2988 This option operates in the same way as &%-bh%&, except that address
2989 verification callouts are performed if required. This includes consulting and
2990 updating the callout cache database.
2991
2992 .vitem &%-bi%&
2993 .oindex "&%-bi%&"
2994 .cindex "alias file" "building"
2995 .cindex "building alias file"
2996 .cindex "Sendmail compatibility" "&%-bi%& option"
2997 Sendmail interprets the &%-bi%& option as a request to rebuild its alias file.
2998 Exim does not have the concept of a single alias file, and so it cannot mimic
2999 this behaviour. However, calls to &_/usr/lib/sendmail_& with the &%-bi%& option
3000 tend to appear in various scripts such as NIS make files, so the option must be
3001 recognized.
3002
3003 If &%-bi%& is encountered, the command specified by the &%bi_command%&
3004 configuration option is run, under the uid and gid of the caller of Exim. If
3005 the &%-oA%& option is used, its value is passed to the command as an argument.
3006 The command set by &%bi_command%& may not contain arguments. The command can
3007 use the &'exim_dbmbuild'& utility, or some other means, to rebuild alias files
3008 if this is required. If the &%bi_command%& option is not set, calling Exim with
3009 &%-bi%& is a no-op.
3010
3011 . // Keep :help first, then the rest in alphabetical order
3012 .vitem &%-bI:help%&
3013 .oindex "&%-bI:help%&"
3014 .cindex "querying exim information"
3015 We shall provide various options starting &`-bI:`& for querying Exim for
3016 information.  The output of many of these will be intended for machine
3017 consumption.  This one is not.  The &%-bI:help%& option asks Exim for a
3018 synopsis of supported options beginning &`-bI:`&.  Use of any of these
3019 options shall cause Exim to exit after producing the requested output.
3020
3021 .vitem &%-bI:dscp%&
3022 .oindex "&%-bI:dscp%&"
3023 .cindex "DSCP" "values"
3024 This option causes Exim to emit an alphabetically sorted list of all
3025 recognised DSCP names.
3026
3027 .vitem &%-bI:sieve%&
3028 .oindex "&%-bI:sieve%&"
3029 .cindex "Sieve filter" "capabilities"
3030 This option causes Exim to emit an alphabetically sorted list of all supported
3031 Sieve protocol extensions on stdout, one per line.  This is anticipated to be
3032 useful for ManageSieve (RFC 5804) implementations, in providing that protocol's
3033 &`SIEVE`& capability response line.  As the precise list may depend upon
3034 compile-time build options, which this option will adapt to, this is the only
3035 way to guarantee a correct response.
3036
3037 .vitem &%-bm%&
3038 .oindex "&%-bm%&"
3039 .cindex "local message reception"
3040 This option runs an Exim receiving process that accepts an incoming,
3041 locally-generated message on the standard input. The recipients are given as the
3042 command arguments (except when &%-t%& is also present &-- see below). Each
3043 argument can be a comma-separated list of RFC 2822 addresses. This is the
3044 default option for selecting the overall action of an Exim call; it is assumed
3045 if no other conflicting option is present.
3046
3047 If any addresses in the message are unqualified (have no domain), they are
3048 qualified by the values of the &%qualify_domain%& or &%qualify_recipient%&
3049 options, as appropriate. The &%-bnq%& option (see below) provides a way of
3050 suppressing this for special cases.
3051
3052 Policy checks on the contents of local messages can be enforced by means of
3053 the non-SMTP ACL. See chapter &<<CHAPACL>>& for details.
3054
3055 .cindex "return code" "for &%-bm%&"
3056 The return code is zero if the message is successfully accepted. Otherwise, the
3057 action is controlled by the &%-oe%&&'x'& option setting &-- see below.
3058
3059 The format
3060 .cindex "message" "format"
3061 .cindex "format" "message"
3062 .cindex "&""From""& line"
3063 .cindex "UUCP" "&""From""& line"
3064 .cindex "Sendmail compatibility" "&""From""& line"
3065 of the message must be as defined in RFC 2822, except that, for
3066 compatibility with Sendmail and Smail, a line in one of the forms
3067 .code
3068 From sender Fri Jan  5 12:55 GMT 1997
3069 From sender Fri, 5 Jan 97 12:55:01
3070 .endd
3071 (with the weekday optional, and possibly with additional text after the date)
3072 is permitted to appear at the start of the message. There appears to be no
3073 authoritative specification of the format of this line. Exim recognizes it by
3074 matching against the regular expression defined by the &%uucp_from_pattern%&
3075 option, which can be changed if necessary.
3076
3077 .oindex "&%-f%&" "overriding &""From""& line"
3078 The specified sender is treated as if it were given as the argument to the
3079 &%-f%& option, but if a &%-f%& option is also present, its argument is used in
3080 preference to the address taken from the message. The caller of Exim must be a
3081 trusted user for the sender of a message to be set in this way.
3082
3083 .vitem &%-bmalware%&&~<&'filename'&>
3084 .oindex "&%-bmalware%&"
3085 .cindex "testing", "malware"
3086 .cindex "malware scan test"
3087 This debugging option causes Exim to scan the given file or directory
3088 (depending on the used scanner interface),
3089 using the malware scanning framework.  The option of &%av_scanner%& influences
3090 this option, so if &%av_scanner%&'s value is dependent upon an expansion then
3091 the expansion should have defaults which apply to this invocation.  ACLs are
3092 not invoked, so if &%av_scanner%& references an ACL variable then that variable
3093 will never be populated and &%-bmalware%& will fail.
3094
3095 Exim will have changed working directory before resolving the filename, so
3096 using fully qualified pathnames is advisable.  Exim will be running as the Exim
3097 user when it tries to open the file, rather than as the invoking user.
3098 This option requires admin privileges.
3099
3100 The &%-bmalware%& option will not be extended to be more generally useful,
3101 there are better tools for file-scanning.  This option exists to help
3102 administrators verify their Exim and AV scanner configuration.
3103
3104 .vitem &%-bnq%&
3105 .oindex "&%-bnq%&"
3106 .cindex "address qualification, suppressing"
3107 By default, Exim automatically qualifies unqualified addresses (those
3108 without domains) that appear in messages that are submitted locally (that
3109 is, not over TCP/IP). This qualification applies both to addresses in
3110 envelopes, and addresses in header lines. Sender addresses are qualified using
3111 &%qualify_domain%&, and recipient addresses using &%qualify_recipient%& (which
3112 defaults to the value of &%qualify_domain%&).
3113
3114 Sometimes, qualification is not wanted. For example, if &%-bS%& (batch SMTP) is
3115 being used to re-submit messages that originally came from remote hosts after
3116 content scanning, you probably do not want to qualify unqualified addresses in
3117 header lines. (Such lines will be present only if you have not enabled a header
3118 syntax check in the appropriate ACL.)
3119
3120 The &%-bnq%& option suppresses all qualification of unqualified addresses in
3121 messages that originate on the local host. When this is used, unqualified
3122 addresses in the envelope provoke errors (causing message rejection) and
3123 unqualified addresses in header lines are left alone.
3124
3125
3126 .vitem &%-bP%&
3127 .oindex "&%-bP%&"
3128 .cindex "configuration options" "extracting"
3129 .cindex "options" "configuration &-- extracting"
3130 If this option is given with no arguments, it causes the values of all Exim's
3131 main configuration options to be written to the standard output. The values
3132 of one or more specific options can be requested by giving their names as
3133 arguments, for example:
3134 .code
3135 exim -bP qualify_domain hold_domains
3136 .endd
3137 .cindex "hiding configuration option values"
3138 .cindex "configuration options" "hiding value of"
3139 .cindex "options" "hiding value of"
3140 However, any option setting that is preceded by the word &"hide"& in the
3141 configuration file is not shown in full, except to an admin user. For other
3142 users, the output is as in this example:
3143 .code
3144 mysql_servers = <value not displayable>
3145 .endd
3146 If &%config%& is given as an argument, the config is
3147 output, as it was parsed, any include file resolved, any comment removed.
3148
3149 If &%config_file%& is given as an argument, the name of the runtime
3150 configuration file is output. (&%configure_file%& works too, for
3151 backward compatibility.)
3152 If a list of configuration files was supplied, the value that is output here
3153 is the name of the file that was actually used.
3154
3155 .cindex "options" "hiding name of"
3156 If the &%-n%& flag is given, then for most modes of &%-bP%& operation the
3157 name will not be output.
3158
3159 .cindex "daemon" "process id (pid)"
3160 .cindex "pid (process id)" "of daemon"
3161 If &%log_file_path%& or &%pid_file_path%& are given, the names of the
3162 directories where log files and daemon pid files are written are output,
3163 respectively. If these values are unset, log files are written in a
3164 sub-directory of the spool directory called &%log%&, and the pid file is
3165 written directly into the spool directory.
3166
3167 If &%-bP%& is followed by a name preceded by &`+`&, for example,
3168 .code
3169 exim -bP +local_domains
3170 .endd
3171 it searches for a matching named list of any type (domain, host, address, or
3172 local part) and outputs what it finds.
3173
3174 .cindex "options" "router &-- extracting"
3175 .cindex "options" "transport &-- extracting"
3176 .cindex "options" "authenticator &-- extracting"
3177 If one of the words &%router%&, &%transport%&, or &%authenticator%& is given,
3178 followed by the name of an appropriate driver instance, the option settings for
3179 that driver are output. For example:
3180 .code
3181 exim -bP transport local_delivery
3182 .endd
3183 The generic driver options are output first, followed by the driver's private
3184 options. A list of the names of drivers of a particular type can be obtained by
3185 using one of the words &%router_list%&, &%transport_list%&, or
3186 &%authenticator_list%&, and a complete list of all drivers with their option
3187 settings can be obtained by using &%routers%&, &%transports%&, or
3188 &%authenticators%&.
3189
3190 .cindex "environment"
3191 If &%environment%& is given as an argument, the set of environment
3192 variables is output, line by line. Using the &%-n%& flag suppresses the value of the
3193 variables.
3194
3195 .cindex "options" "macro &-- extracting"
3196 If invoked by an admin user, then &%macro%&, &%macro_list%& and &%macros%&
3197 are available, similarly to the drivers.  Because macros are sometimes used
3198 for storing passwords, this option is restricted.
3199 The output format is one item per line.
3200 For the "-bP macro <name>" form, if no such macro is found
3201 the exit status will be nonzero.
3202
3203 .vitem &%-bp%&
3204 .oindex "&%-bp%&"
3205 .cindex "queue" "listing messages in"
3206 .cindex "listing" "messages in the queue"
3207 This option requests a listing of the contents of the mail queue on the
3208 standard output. If the &%-bp%& option is followed by a list of message ids,
3209 just those messages are listed. By default, this option can be used only by an
3210 admin user. However, the &%queue_list_requires_admin%& option can be set false
3211 to allow any user to see the queue.
3212
3213 Each message in the queue is displayed as in the following example:
3214 .code
3215 25m  2.9K 0t5C6f-0000c8-00 <alice@wonderland.fict.example>
3216           red.king@looking-glass.fict.example
3217           <other addresses>
3218 .endd
3219 .cindex "message" "size in queue listing"
3220 .cindex "size" "of message"
3221 The first line contains the length of time the message has been in the queue
3222 (in this case 25 minutes), the size of the message (2.9K), the unique local
3223 identifier for the message, and the message sender, as contained in the
3224 envelope. For bounce messages, the sender address is empty, and appears as
3225 &"<>"&. If the message was submitted locally by an untrusted user who overrode
3226 the default sender address, the user's login name is shown in parentheses
3227 before the sender address.
3228
3229 .cindex "frozen messages" "in queue listing"
3230 If the message is frozen (attempts to deliver it are suspended) then the text
3231 &"*** frozen ***"& is displayed at the end of this line.
3232
3233 The recipients of the message (taken from the envelope, not the headers) are
3234 displayed on subsequent lines. Those addresses to which the message has already
3235 been delivered are marked with the letter D. If an original address gets
3236 expanded into several addresses via an alias or forward file, the original is
3237 displayed with a D only when deliveries for all of its child addresses are
3238 complete.
3239
3240
3241 .vitem &%-bpa%&
3242 .oindex "&%-bpa%&"
3243 This option operates like &%-bp%&, but in addition it shows delivered addresses
3244 that were generated from the original top level address(es) in each message by
3245 alias or forwarding operations. These addresses are flagged with &"+D"& instead
3246 of just &"D"&.
3247
3248
3249 .vitem &%-bpc%&
3250 .oindex "&%-bpc%&"
3251 .cindex "queue" "count of messages on"
3252 This option counts the number of messages in the queue, and writes the total
3253 to the standard output. It is restricted to admin users, unless
3254 &%queue_list_requires_admin%& is set false.
3255
3256
3257 .vitem &%-bpr%&
3258 .oindex "&%-bpr%&"
3259 This option operates like &%-bp%&, but the output is not sorted into
3260 chronological order of message arrival. This can speed it up when there are
3261 lots of messages in the queue, and is particularly useful if the output is
3262 going to be post-processed in a way that doesn't need the sorting.
3263
3264 .vitem &%-bpra%&
3265 .oindex "&%-bpra%&"
3266 This option is a combination of &%-bpr%& and &%-bpa%&.
3267
3268 .vitem &%-bpru%&
3269 .oindex "&%-bpru%&"
3270 This option is a combination of &%-bpr%& and &%-bpu%&.
3271
3272
3273 .vitem &%-bpu%&
3274 .oindex "&%-bpu%&"
3275 This option operates like &%-bp%& but shows only undelivered top-level
3276 addresses for each message displayed. Addresses generated by aliasing or
3277 forwarding are not shown, unless the message was deferred after processing by a
3278 router with the &%one_time%& option set.
3279
3280
3281 .vitem &%-brt%&
3282 .oindex "&%-brt%&"
3283 .cindex "testing" "retry configuration"
3284 .cindex "retry" "configuration testing"
3285 This option is for testing retry rules, and it must be followed by up to three
3286 arguments. It causes Exim to look for a retry rule that matches the values
3287 and to write it to the standard output. For example:
3288 .code
3289 exim -brt bach.comp.mus.example
3290 Retry rule: *.comp.mus.example  F,2h,15m; F,4d,30m;
3291 .endd
3292 See chapter &<<CHAPretry>>& for a description of Exim's retry rules. The first
3293 argument, which is required, can be a complete address in the form
3294 &'local_part@domain'&, or it can be just a domain name. If the second argument
3295 contains a dot, it is interpreted as an optional second domain name; if no
3296 retry rule is found for the first argument, the second is tried. This ties in
3297 with Exim's behaviour when looking for retry rules for remote hosts &-- if no
3298 rule is found that matches the host, one that matches the mail domain is
3299 sought. Finally, an argument that is the name of a specific delivery error, as
3300 used in setting up retry rules, can be given. For example:
3301 .code
3302 exim -brt haydn.comp.mus.example quota_3d
3303 Retry rule: *@haydn.comp.mus.example quota_3d  F,1h,15m
3304 .endd
3305
3306 .vitem &%-brw%&
3307 .oindex "&%-brw%&"
3308 .cindex "testing" "rewriting"
3309 .cindex "rewriting" "testing"
3310 This option is for testing address rewriting rules, and it must be followed by
3311 a single argument, consisting of either a local part without a domain, or a
3312 complete address with a fully qualified domain. Exim outputs how this address
3313 would be rewritten for each possible place it might appear. See chapter
3314 &<<CHAPrewrite>>& for further details.
3315
3316 .vitem &%-bS%&
3317 .oindex "&%-bS%&"
3318 .cindex "SMTP" "batched incoming"
3319 .cindex "batched SMTP input"
3320 This option is used for batched SMTP input, which is an alternative interface
3321 for non-interactive local message submission. A number of messages can be
3322 submitted in a single run. However, despite its name, this is not really SMTP
3323 input. Exim reads each message's envelope from SMTP commands on the standard
3324 input, but generates no responses. If the caller is trusted, or
3325 &%untrusted_set_sender%& is set, the senders in the SMTP MAIL commands are
3326 believed; otherwise the sender is always the caller of Exim.
3327
3328 The message itself is read from the standard input, in SMTP format (leading
3329 dots doubled), terminated by a line containing just a single dot. An error is
3330 provoked if the terminating dot is missing. A further message may then follow.
3331
3332 As for other local message submissions, the contents of incoming batch SMTP
3333 messages can be checked using the non-SMTP ACL (see chapter &<<CHAPACL>>&).
3334 Unqualified addresses are automatically qualified using &%qualify_domain%& and
3335 &%qualify_recipient%&, as appropriate, unless the &%-bnq%& option is used.
3336
3337 Some other SMTP commands are recognized in the input. HELO and EHLO act
3338 as RSET; VRFY, EXPN, ETRN, and HELP act as NOOP;
3339 QUIT quits, ignoring the rest of the standard input.
3340
3341 .cindex "return code" "for &%-bS%&"
3342 If any error is encountered, reports are written to the standard output and
3343 error streams, and Exim gives up immediately. The return code is 0 if no error
3344 was detected; it is 1 if one or more messages were accepted before the error
3345 was detected; otherwise it is 2.
3346
3347 More details of input using batched SMTP are given in section
3348 &<<SECTincomingbatchedSMTP>>&.
3349
3350 .vitem &%-bs%&
3351 .oindex "&%-bs%&"
3352 .cindex "SMTP" "local input"
3353 .cindex "local SMTP input"
3354 This option causes Exim to accept one or more messages by reading SMTP commands
3355 on the standard input, and producing SMTP replies on the standard output. SMTP
3356 policy controls, as defined in ACLs (see chapter &<<CHAPACL>>&) are applied.
3357 Some user agents use this interface as a way of passing locally-generated
3358 messages to the MTA.
3359
3360 In
3361 .cindex "sender" "source of"
3362 this usage, if the caller of Exim is trusted, or &%untrusted_set_sender%& is
3363 set, the senders of messages are taken from the SMTP MAIL commands.
3364 Otherwise the content of these commands is ignored and the sender is set up as
3365 the calling user. Unqualified addresses are automatically qualified using
3366 &%qualify_domain%& and &%qualify_recipient%&, as appropriate, unless the
3367 &%-bnq%& option is used.
3368
3369 .cindex "inetd"
3370 The
3371 &%-bs%& option is also used to run Exim from &'inetd'&, as an alternative to
3372 using a listening daemon. Exim can distinguish the two cases by checking
3373 whether the standard input is a TCP/IP socket. When Exim is called from
3374 &'inetd'&, the source of the mail is assumed to be remote, and the comments
3375 above concerning senders and qualification do not apply. In this situation,
3376 Exim behaves in exactly the same way as it does when receiving a message via
3377 the listening daemon.
3378
3379 .vitem &%-bt%&
3380 .oindex "&%-bt%&"
3381 .cindex "testing" "addresses"
3382 .cindex "address" "testing"
3383 This option runs Exim in address testing mode, in which each argument is taken
3384 as a recipient address to be tested for deliverability. The results are
3385 written to the standard output. If a test fails, and the caller is not an admin
3386 user, no details of the failure are output, because these might contain
3387 sensitive information such as usernames and passwords for database lookups.
3388
3389 If no arguments are given, Exim runs in an interactive manner, prompting with a
3390 right angle bracket for addresses to be tested.
3391
3392 Unlike the &%-be%& test option, you cannot arrange for Exim to use the
3393 &[readline()]& function, because it is running as &'root'& and there are
3394 security issues.
3395
3396 Each address is handled as if it were the recipient address of a message
3397 (compare the &%-bv%& option). It is passed to the routers and the result is
3398 written to the standard output. However, any router that has
3399 &%no_address_test%& set is bypassed. This can make &%-bt%& easier to use for
3400 genuine routing tests if your first router passes everything to a scanner
3401 program.
3402
3403 .cindex "return code" "for &%-bt%&"
3404 The return code is 2 if any address failed outright; it is 1 if no address
3405 failed outright but at least one could not be resolved for some reason. Return
3406 code 0 is given only when all addresses succeed.
3407
3408 .cindex "duplicate addresses"
3409 &*Note*&: When actually delivering a message, Exim removes duplicate recipient
3410 addresses after routing is complete, so that only one delivery takes place.
3411 This does not happen when testing with &%-bt%&; the full results of routing are
3412 always shown.
3413
3414 &*Warning*&: &%-bt%& can only do relatively simple testing. If any of the
3415 routers in the configuration makes any tests on the sender address of a
3416 message,
3417 .oindex "&%-f%&" "for address testing"
3418 you can use the &%-f%& option to set an appropriate sender when running
3419 &%-bt%& tests. Without it, the sender is assumed to be the calling user at the
3420 default qualifying domain. However, if you have set up (for example) routers
3421 whose behaviour depends on the contents of an incoming message, you cannot test
3422 those conditions using &%-bt%&. The &%-N%& option provides a possible way of
3423 doing such tests.
3424
3425 .vitem &%-bV%&
3426 .oindex "&%-bV%&"
3427 .cindex "version number of Exim"
3428 This option causes Exim to write the current version number, compilation
3429 number, and compilation date of the &'exim'& binary to the standard output.
3430 It also lists the DBM library that is being used, the optional modules (such as
3431 specific lookup types), the drivers that are included in the binary, and the
3432 name of the runtime configuration file that is in use.
3433
3434 As part of its operation, &%-bV%& causes Exim to read and syntax check its
3435 configuration file. However, this is a static check only. It cannot check
3436 values that are to be expanded. For example, although a misspelt ACL verb is
3437 detected, an error in the verb's arguments is not. You cannot rely on &%-bV%&
3438 alone to discover (for example) all the typos in the configuration; some
3439 realistic testing is needed. The &%-bh%& and &%-N%& options provide more
3440 dynamic testing facilities.
3441
3442 .vitem &%-bv%&
3443 .oindex "&%-bv%&"
3444 .cindex "verifying address" "using &%-bv%&"
3445 .cindex "address" "verification"
3446 This option runs Exim in address verification mode, in which each argument is
3447 taken as a recipient address to be verified by the routers. (This does
3448 not involve any verification callouts). During normal operation, verification
3449 happens mostly as a consequence processing a &%verify%& condition in an ACL
3450 (see chapter &<<CHAPACL>>&). If you want to test an entire ACL, possibly
3451 including callouts, see the &%-bh%& and &%-bhc%& options.
3452
3453 If verification fails, and the caller is not an admin user, no details of the
3454 failure are output, because these might contain sensitive information such as
3455 usernames and passwords for database lookups.
3456
3457 If no arguments are given, Exim runs in an interactive manner, prompting with a
3458 right angle bracket for addresses to be verified.
3459
3460 Unlike the &%-be%& test option, you cannot arrange for Exim to use the
3461 &[readline()]& function, because it is running as &'exim'& and there are
3462 security issues.
3463
3464 Verification differs from address testing (the &%-bt%& option) in that routers
3465 that have &%no_verify%& set are skipped, and if the address is accepted by a
3466 router that has &%fail_verify%& set, verification fails. The address is
3467 verified as a recipient if &%-bv%& is used; to test verification for a sender
3468 address, &%-bvs%& should be used.
3469
3470 If the &%-v%& option is not set, the output consists of a single line for each
3471 address, stating whether it was verified or not, and giving a reason in the
3472 latter case. Without &%-v%&, generating more than one address by redirection
3473 causes verification to end successfully, without considering the generated
3474 addresses. However, if just one address is generated, processing continues,
3475 and the generated address must verify successfully for the overall verification
3476 to succeed.
3477
3478 When &%-v%& is set, more details are given of how the address has been handled,
3479 and in the case of address redirection, all the generated addresses are also
3480 considered. Verification may succeed for some and fail for others.
3481
3482 The
3483 .cindex "return code" "for &%-bv%&"
3484 return code is 2 if any address failed outright; it is 1 if no address
3485 failed outright but at least one could not be resolved for some reason. Return
3486 code 0 is given only when all addresses succeed.
3487
3488 If any of the routers in the configuration makes any tests on the sender
3489 address of a message, you should use the &%-f%& option to set an appropriate
3490 sender when running &%-bv%& tests. Without it, the sender is assumed to be the
3491 calling user at the default qualifying domain.
3492
3493 .vitem &%-bvs%&
3494 .oindex "&%-bvs%&"
3495 This option acts like &%-bv%&, but verifies the address as a sender rather
3496 than a recipient address. This affects any rewriting and qualification that
3497 might happen.
3498
3499 .vitem &%-bw%&
3500 .oindex "&%-bw%&"
3501 .cindex "daemon"
3502 .cindex "inetd"
3503 .cindex "inetd" "wait mode"
3504 This option runs Exim as a daemon, awaiting incoming SMTP connections,
3505 similarly to the &%-bd%& option.  All port specifications on the command-line
3506 and in the configuration file are ignored.  Queue-running may not be specified.
3507
3508 In this mode, Exim expects to be passed a socket as fd 0 (stdin) which is
3509 listening for connections.  This permits the system to start up and have
3510 inetd (or equivalent) listen on the SMTP ports, starting an Exim daemon for
3511 each port only when the first connection is received.
3512
3513 If the option is given as &%-bw%&<&'time'&> then the time is a timeout, after
3514 which the daemon will exit, which should cause inetd to listen once more.
3515
3516 .vitem &%-C%&&~<&'filelist'&>
3517 .oindex "&%-C%&"
3518 .cindex "configuration file" "alternate"
3519 .cindex "CONFIGURE_FILE"
3520 .cindex "alternate configuration file"
3521 This option causes Exim to find the runtime configuration file from the given
3522 list instead of from the list specified by the CONFIGURE_FILE
3523 compile-time setting. Usually, the list will consist of just a single filename,
3524 but it can be a colon-separated list of names. In this case, the first
3525 file that exists is used. Failure to open an existing file stops Exim from
3526 proceeding any further along the list, and an error is generated.
3527
3528 When this option is used by a caller other than root, and the list is different
3529 from the compiled-in list, Exim gives up its root privilege immediately, and
3530 runs with the real and effective uid and gid set to those of the caller.
3531 However, if a TRUSTED_CONFIG_LIST file is defined in &_Local/Makefile_&, that
3532 file contains a list of full pathnames, one per line, for configuration files
3533 which are trusted. Root privilege is retained for any configuration file so
3534 listed, as long as the caller is the Exim user (or the user specified in the
3535 CONFIGURE_OWNER option, if any), and as long as the configuration file is
3536 not writeable by inappropriate users or groups.
3537
3538 Leaving TRUSTED_CONFIG_LIST unset precludes the possibility of testing a
3539 configuration using &%-C%& right through message reception and delivery,
3540 even if the caller is root. The reception works, but by that time, Exim is
3541 running as the Exim user, so when it re-executes to regain privilege for the
3542 delivery, the use of &%-C%& causes privilege to be lost. However, root can
3543 test reception and delivery using two separate commands (one to put a message
3544 in the queue, using &%-odq%&, and another to do the delivery, using &%-M%&).
3545
3546 If ALT_CONFIG_PREFIX is defined &_in Local/Makefile_&, it specifies a
3547 prefix string with which any file named in a &%-C%& command line option
3548 must start. In addition, the filename must not contain the sequence &`/../`&.
3549 However, if the value of the &%-C%& option is identical to the value of
3550 CONFIGURE_FILE in &_Local/Makefile_&, Exim ignores &%-C%& and proceeds as
3551 usual. There is no default setting for ALT_CONFIG_PREFIX; when it is
3552 unset, any filename can be used with &%-C%&.
3553
3554 ALT_CONFIG_PREFIX can be used to confine alternative configuration files
3555 to a directory to which only root has access. This prevents someone who has
3556 broken into the Exim account from running a privileged Exim with an arbitrary
3557 configuration file.
3558
3559 The &%-C%& facility is useful for ensuring that configuration files are
3560 syntactically correct, but cannot be used for test deliveries, unless the
3561 caller is privileged, or unless it is an exotic configuration that does not
3562 require privilege. No check is made on the owner or group of the files
3563 specified by this option.
3564
3565
3566 .vitem &%-D%&<&'macro'&>=<&'value'&>
3567 .oindex "&%-D%&"
3568 .cindex "macro" "setting on command line"
3569 This option can be used to override macro definitions in the configuration file
3570 (see section &<<SECTmacrodefs>>&). However, like &%-C%&, if it is used by an
3571 unprivileged caller, it causes Exim to give up its root privilege.
3572 If DISABLE_D_OPTION is defined in &_Local/Makefile_&, the use of &%-D%& is
3573 completely disabled, and its use causes an immediate error exit.
3574
3575 If WHITELIST_D_MACROS is defined in &_Local/Makefile_& then it should be a
3576 colon-separated list of macros which are considered safe and, if &%-D%& only
3577 supplies macros from this list, and the values are acceptable, then Exim will
3578 not give up root privilege if the caller is root, the Exim run-time user, or
3579 the CONFIGURE_OWNER, if set.  This is a transition mechanism and is expected
3580 to be removed in the future.  Acceptable values for the macros satisfy the
3581 regexp: &`^[A-Za-z0-9_/.-]*$`&
3582
3583 The entire option (including equals sign if present) must all be within one
3584 command line item. &%-D%& can be used to set the value of a macro to the empty
3585 string, in which case the equals sign is optional. These two commands are
3586 synonymous:
3587 .code
3588 exim -DABC  ...
3589 exim -DABC= ...
3590 .endd
3591 To include spaces in a macro definition item, quotes must be used. If you use
3592 quotes, spaces are permitted around the macro name and the equals sign. For
3593 example:
3594 .code
3595 exim '-D ABC = something' ...
3596 .endd
3597 &%-D%& may be repeated up to 10 times on a command line.
3598 Only macro names up to 22 letters long can be set.
3599
3600
3601 .vitem &%-d%&<&'debug&~options'&>
3602 .oindex "&%-d%&"
3603 .cindex "debugging" "list of selectors"
3604 .cindex "debugging" "&%-d%& option"
3605 This option causes debugging information to be written to the standard
3606 error stream. It is restricted to admin users because debugging output may show
3607 database queries that contain password information. Also, the details of users'
3608 filter files should be protected. If a non-admin user uses &%-d%&, Exim
3609 writes an error message to the standard error stream and exits with a non-zero
3610 return code.
3611
3612 When &%-d%& is used, &%-v%& is assumed. If &%-d%& is given on its own, a lot of
3613 standard debugging data is output. This can be reduced, or increased to include
3614 some more rarely needed information, by directly following &%-d%& with a string
3615 made up of names preceded by plus or minus characters. These add or remove sets
3616 of debugging data, respectively. For example, &%-d+filter%& adds filter
3617 debugging, whereas &%-d-all+filter%& selects only filter debugging. Note that
3618 no spaces are allowed in the debug setting. The available debugging categories
3619 are:
3620 .display
3621 &`acl            `& ACL interpretation
3622 &`auth           `& authenticators
3623 &`deliver        `& general delivery logic
3624 &`dns            `& DNS lookups (see also resolver)
3625 &`dnsbl          `& DNS black list (aka RBL) code
3626 &`exec           `& arguments for &[execv()]& calls
3627 &`expand         `& detailed debugging for string expansions
3628 &`filter         `& filter handling
3629 &`hints_lookup   `& hints data lookups
3630 &`host_lookup    `& all types of name-to-IP address handling
3631 &`ident          `& ident lookup
3632 &`interface      `& lists of local interfaces
3633 &`lists          `& matching things in lists
3634 &`load           `& system load checks
3635 &`local_scan     `& can be used by &[local_scan()]& (see chapter &&&
3636                     &<<CHAPlocalscan>>&)
3637 &`lookup         `& general lookup code and all lookups
3638 &`memory         `& memory handling
3639 &`noutf8         `& modifier: avoid UTF-8 line-drawing
3640 &`pid            `& modifier: add pid to debug output lines
3641 &`process_info   `& setting info for the process log
3642 &`queue_run      `& queue runs
3643 &`receive        `& general message reception logic
3644 &`resolver       `& turn on the DNS resolver's debugging output
3645 &`retry          `& retry handling
3646 &`rewrite        `& address rewriting
3647 &`route          `& address routing
3648 &`timestamp      `& modifier: add timestamp to debug output lines
3649 &`tls            `& TLS logic
3650 &`transport      `& transports
3651 &`uid            `& changes of uid/gid and looking up uid/gid
3652 &`verify         `& address verification logic
3653 &`all            `& almost all of the above (see below), and also &%-v%&
3654 .endd
3655 The &`all`& option excludes &`memory`& when used as &`+all`&, but includes it
3656 for &`-all`&. The reason for this is that &`+all`& is something that people
3657 tend to use when generating debug output for Exim maintainers. If &`+memory`&
3658 is included, an awful lot of output that is very rarely of interest is
3659 generated, so it now has to be explicitly requested. However, &`-all`& does
3660 turn everything off.
3661
3662 .cindex "resolver, debugging output"
3663 .cindex "DNS resolver, debugging output"
3664 The &`resolver`& option produces output only if the DNS resolver was compiled
3665 with DEBUG enabled. This is not the case in some operating systems. Also,
3666 unfortunately, debugging output from the DNS resolver is written to stdout
3667 rather than stderr.
3668
3669 The default (&%-d%& with no argument) omits &`expand`&, &`filter`&,
3670 &`interface`&, &`load`&, &`memory`&, &`pid`&, &`resolver`&, and &`timestamp`&.
3671 However, the &`pid`& selector is forced when debugging is turned on for a
3672 daemon, which then passes it on to any re-executed Exims. Exim also
3673 automatically adds the pid to debug lines when several remote deliveries are
3674 run in parallel.
3675
3676 The &`timestamp`& selector causes the current time to be inserted at the start
3677 of all debug output lines. This can be useful when trying to track down delays
3678 in processing.
3679
3680 .cindex debugging "UTF-8 in"
3681 .cindex UTF-8 "in debug output"
3682 The &`noutf8`& selector disables the use of
3683 UTF-8 line-drawing characters to group related information.
3684 When disabled. ascii-art is used instead.
3685 Using the &`+all`& option does not set this modifier,
3686
3687 If the &%debug_print%& option is set in any driver, it produces output whenever
3688 any debugging is selected, or if &%-v%& is used.
3689
3690 .vitem &%-dd%&<&'debug&~options'&>
3691 .oindex "&%-dd%&"
3692 This option behaves exactly like &%-d%& except when used on a command that
3693 starts a daemon process. In that case, debugging is turned off for the
3694 subprocesses that the daemon creates. Thus, it is useful for monitoring the
3695 behaviour of the daemon without creating as much output as full debugging does.
3696
3697 .vitem &%-dropcr%&
3698 .oindex "&%-dropcr%&"
3699 This is an obsolete option that is now a no-op. It used to affect the way Exim
3700 handled CR and LF characters in incoming messages. What happens now is
3701 described in section &<<SECTlineendings>>&.
3702
3703 .vitem &%-E%&
3704 .oindex "&%-E%&"
3705 .cindex "bounce message" "generating"
3706 This option specifies that an incoming message is a locally-generated delivery
3707 failure report. It is used internally by Exim when handling delivery failures
3708 and is not intended for external use. Its only effect is to stop Exim
3709 generating certain messages to the postmaster, as otherwise message cascades
3710 could occur in some situations. As part of the same option, a message id may
3711 follow the characters &%-E%&. If it does, the log entry for the receipt of the
3712 new message contains the id, following &"R="&, as a cross-reference.
3713
3714 .vitem &%-e%&&'x'&
3715 .oindex "&%-e%&&'x'&"
3716 There are a number of Sendmail options starting with &%-oe%& which seem to be
3717 called by various programs without the leading &%o%& in the option. For
3718 example, the &%vacation%& program uses &%-eq%&. Exim treats all options of the
3719 form &%-e%&&'x'& as synonymous with the corresponding &%-oe%&&'x'& options.
3720
3721 .vitem &%-F%&&~<&'string'&>
3722 .oindex "&%-F%&"
3723 .cindex "sender" "name"
3724 .cindex "name" "of sender"
3725 This option sets the sender's full name for use when a locally-generated
3726 message is being accepted. In the absence of this option, the user's &'gecos'&
3727 entry from the password data is used. As users are generally permitted to alter
3728 their &'gecos'& entries, no security considerations are involved. White space
3729 between &%-F%& and the <&'string'&> is optional.
3730
3731 .vitem &%-f%&&~<&'address'&>
3732 .oindex "&%-f%&"
3733 .cindex "sender" "address"
3734 .cindex "address" "sender"
3735 .cindex "trusted users"
3736 .cindex "envelope from"
3737 .cindex "envelope sender"
3738 .cindex "user" "trusted"
3739 This option sets the address of the envelope sender of a locally-generated
3740 message (also known as the return path). The option can normally be used only
3741 by a trusted user, but &%untrusted_set_sender%& can be set to allow untrusted
3742 users to use it.
3743
3744 Processes running as root or the Exim user are always trusted. Other
3745 trusted users are defined by the &%trusted_users%& or &%trusted_groups%&
3746 options. In the absence of &%-f%&, or if the caller is not trusted, the sender
3747 of a local message is set to the caller's login name at the default qualify
3748 domain.
3749
3750 There is one exception to the restriction on the use of &%-f%&: an empty sender
3751 can be specified by any user, trusted or not, to create a message that can
3752 never provoke a bounce. An empty sender can be specified either as an empty
3753 string, or as a pair of angle brackets with nothing between them, as in these
3754 examples of shell commands:
3755 .code
3756 exim -f '<>' user@domain
3757 exim -f "" user@domain
3758 .endd
3759 In addition, the use of &%-f%& is not restricted when testing a filter file
3760 with &%-bf%& or when testing or verifying addresses using the &%-bt%& or
3761 &%-bv%& options.
3762
3763 Allowing untrusted users to change the sender address does not of itself make
3764 it possible to send anonymous mail. Exim still checks that the &'From:'& header
3765 refers to the local user, and if it does not, it adds a &'Sender:'& header,
3766 though this can be overridden by setting &%no_local_from_check%&.
3767
3768 White
3769 .cindex "&""From""& line"
3770 space between &%-f%& and the <&'address'&> is optional (that is, they can be
3771 given as two arguments or one combined argument). The sender of a
3772 locally-generated message can also be set (when permitted) by an initial
3773 &"From&~"& line in the message &-- see the description of &%-bm%& above &-- but
3774 if &%-f%& is also present, it overrides &"From&~"&.
3775
3776 .vitem &%-G%&
3777 .oindex "&%-G%&"
3778 .cindex "submission fixups, suppressing (command-line)"
3779 This option is equivalent to an ACL applying:
3780 .code
3781 control = suppress_local_fixups
3782 .endd
3783 for every message received.  Note that Sendmail will complain about such
3784 bad formatting, where Exim silently just does not fix it up.  This may change
3785 in future.
3786
3787 As this affects audit information, the caller must be a trusted user to use
3788 this option.
3789
3790 .vitem &%-h%&&~<&'number'&>
3791 .oindex "&%-h%&"
3792 .cindex "Sendmail compatibility" "&%-h%& option ignored"
3793 This option is accepted for compatibility with Sendmail, but has no effect. (In
3794 Sendmail it overrides the &"hop count"& obtained by counting &'Received:'&
3795 headers.)
3796
3797 .vitem &%-i%&
3798 .oindex "&%-i%&"
3799 .cindex "Solaris" "&'mail'& command"
3800 .cindex "dot" "in incoming non-SMTP message"
3801 This option, which has the same effect as &%-oi%&, specifies that a dot on a
3802 line by itself should not terminate an incoming, non-SMTP message. I can find
3803 no documentation for this option in Solaris 2.4 Sendmail, but the &'mailx'&
3804 command in Solaris 2.4 uses it. See also &%-ti%&.
3805
3806 .vitem &%-L%&&~<&'tag'&>
3807 .oindex "&%-L%&"
3808 .cindex "syslog" "process name; set with flag"
3809 This option is equivalent to setting &%syslog_processname%& in the config
3810 file and setting &%log_file_path%& to &`syslog`&.
3811 Its use is restricted to administrators.  The configuration file has to be
3812 read and parsed, to determine access rights, before this is set and takes
3813 effect, so early configuration file errors will not honour this flag.
3814
3815 The tag should not be longer than 32 characters.
3816
3817 .vitem &%-M%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3818 .oindex "&%-M%&"
3819 .cindex "forcing delivery"
3820 .cindex "delivery" "forcing attempt"
3821 .cindex "frozen messages" "forcing delivery"
3822 This option requests Exim to run a delivery attempt on each message in turn. If
3823 any of the messages are frozen, they are automatically thawed before the
3824 delivery attempt. The settings of &%queue_domains%&, &%queue_smtp_domains%&,
3825 and &%hold_domains%& are ignored.
3826
3827 Retry
3828 .cindex "hints database" "overriding retry hints"
3829 hints for any of the addresses are overridden &-- Exim tries to deliver even if
3830 the normal retry time has not yet been reached. This option requires the caller
3831 to be an admin user. However, there is an option called &%prod_requires_admin%&
3832 which can be set false to relax this restriction (and also the same requirement
3833 for the &%-q%&, &%-R%&, and &%-S%& options).
3834
3835 The deliveries happen synchronously, that is, the original Exim process does
3836 not terminate until all the delivery attempts have finished. No output is
3837 produced unless there is a serious error. If you want to see what is happening,
3838 use the &%-v%& option as well, or inspect Exim's main log.
3839
3840 .vitem &%-Mar%&&~<&'message&~id'&>&~<&'address'&>&~<&'address'&>&~...
3841 .oindex "&%-Mar%&"
3842 .cindex "message" "adding recipients"
3843 .cindex "recipient" "adding"
3844 This option requests Exim to add the addresses to the list of recipients of the
3845 message (&"ar"& for &"add recipients"&). The first argument must be a message
3846 id, and the remaining ones must be email addresses. However, if the message is
3847 active (in the middle of a delivery attempt), it is not altered. This option
3848 can be used only by an admin user.
3849
3850 .vitem "&%-MC%&&~<&'transport'&>&~<&'hostname'&>&~<&'sequence&~number'&>&&&
3851         &~<&'message&~id'&>"
3852 .oindex "&%-MC%&"
3853 .cindex "SMTP" "passed connection"
3854 .cindex "SMTP" "multiple deliveries"
3855 .cindex "multiple SMTP deliveries"
3856 This option is not intended for use by external callers. It is used internally
3857 by Exim to invoke another instance of itself to deliver a waiting message using
3858 an existing SMTP connection, which is passed as the standard input. Details are
3859 given in chapter &<<CHAPSMTP>>&. This must be the final option, and the caller
3860 must be root or the Exim user in order to use it.
3861
3862 .vitem &%-MCA%&
3863 .oindex "&%-MCA%&"
3864 This option is not intended for use by external callers. It is used internally
3865 by Exim in conjunction with the &%-MC%& option. It signifies that the
3866 connection to the remote host has been authenticated.
3867
3868 .vitem &%-MCD%&
3869 .oindex "&%-MCD%&"
3870 This option is not intended for use by external callers. It is used internally
3871 by Exim in conjunction with the &%-MC%& option. It signifies that the
3872 remote host supports the ESMTP &_DSN_& extension.
3873
3874 .new
3875 .vitem &%-MCd%&
3876 .oindex "&%-MCd%&"
3877 This option is not intended for use by external callers. It is used internally
3878 by Exim in conjunction with the &%-d%& option
3879 to pass on an information string on the purpose of the process.
3880 .wen
3881
3882 .vitem &%-MCG%&&~<&'queue&~name'&>
3883 .oindex "&%-MCG%&"
3884 This option is not intended for use by external callers. It is used internally
3885 by Exim in conjunction with the &%-MC%& option. It signifies that an
3886 alternate queue is used, named by the following argument.
3887
3888 .vitem &%-MCK%&
3889 .oindex "&%-MCK%&"
3890 This option is not intended for use by external callers. It is used internally
3891 by Exim in conjunction with the &%-MC%& option. It signifies that a
3892 remote host supports the ESMTP &_CHUNKING_& extension.
3893
3894 .vitem &%-MCP%&
3895 .oindex "&%-MCP%&"
3896 This option is not intended for use by external callers. It is used internally
3897 by Exim in conjunction with the &%-MC%& option. It signifies that the server to
3898 which Exim is connected supports pipelining.
3899
3900 .vitem &%-MCQ%&&~<&'process&~id'&>&~<&'pipe&~fd'&>
3901 .oindex "&%-MCQ%&"
3902 This option is not intended for use by external callers. It is used internally
3903 by Exim in conjunction with the &%-MC%& option when the original delivery was
3904 started by a queue runner. It passes on the process id of the queue runner,
3905 together with the file descriptor number of an open pipe. Closure of the pipe
3906 signals the final completion of the sequence of processes that are passing
3907 messages through the same SMTP connection.
3908
3909 .vitem &%-MCS%&
3910 .oindex "&%-MCS%&"
3911 This option is not intended for use by external callers. It is used internally
3912 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3913 ESMTP SIZE option should be used on messages delivered down the existing
3914 connection.
3915
3916 .vitem &%-MCT%&
3917 .oindex "&%-MCT%&"
3918 This option is not intended for use by external callers. It is used internally
3919 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3920 host to which Exim is connected supports TLS encryption.
3921
3922 .vitem &%-MCt%&&~<&'IP&~address'&>&~<&'port'&>&~<&'cipher'&>
3923 .oindex "&%-MCt%&"
3924 This option is not intended for use by external callers. It is used internally
3925 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3926 connection is being proxied by a parent process for handling TLS encryption.
3927 The arguments give the local address and port being proxied, and the TLS cipher.
3928
3929 .vitem &%-Mc%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3930 .oindex "&%-Mc%&"
3931 .cindex "hints database" "not overridden by &%-Mc%&"
3932 .cindex "delivery" "manually started &-- not forced"
3933 This option requests Exim to run a delivery attempt on each message, in turn,
3934 but unlike the &%-M%& option, it does check for retry hints, and respects any
3935 that are found. This option is not very useful to external callers. It is
3936 provided mainly for internal use by Exim when it needs to re-invoke itself in
3937 order to regain root privilege for a delivery (see chapter &<<CHAPsecurity>>&).
3938 However, &%-Mc%& can be useful when testing, in order to run a delivery that
3939 respects retry times and other options such as &%hold_domains%& that are
3940 overridden when &%-M%& is used. Such a delivery does not count as a queue run.
3941 If you want to run a specific delivery as if in a queue run, you should use
3942 &%-q%& with a message id argument. A distinction between queue run deliveries
3943 and other deliveries is made in one or two places.
3944
3945 .vitem &%-Mes%&&~<&'message&~id'&>&~<&'address'&>
3946 .oindex "&%-Mes%&"
3947 .cindex "message" "changing sender"
3948 .cindex "sender" "changing"
3949 This option requests Exim to change the sender address in the message to the
3950 given address, which must be a fully qualified address or &"<>"& (&"es"& for
3951 &"edit sender"&). There must be exactly two arguments. The first argument must
3952 be a message id, and the second one an email address. However, if the message
3953 is active (in the middle of a delivery attempt), its status is not altered.
3954 This option can be used only by an admin user.
3955
3956 .vitem &%-Mf%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3957 .oindex "&%-Mf%&"
3958 .cindex "freezing messages"
3959 .cindex "message" "manually freezing"
3960 This option requests Exim to mark each listed message as &"frozen"&. This
3961 prevents any delivery attempts taking place until the message is &"thawed"&,
3962 either manually or as a result of the &%auto_thaw%& configuration option.
3963 However, if any of the messages are active (in the middle of a delivery
3964 attempt), their status is not altered. This option can be used only by an admin
3965 user.
3966
3967 .vitem &%-Mg%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3968 .oindex "&%-Mg%&"
3969 .cindex "giving up on messages"
3970 .cindex "message" "abandoning delivery attempts"
3971 .cindex "delivery" "abandoning further attempts"
3972 This option requests Exim to give up trying to deliver the listed messages,
3973 including any that are frozen. However, if any of the messages are active,
3974 their status is not altered. For non-bounce messages, a delivery error message
3975 is sent to the sender, containing the text &"cancelled by administrator"&.
3976 Bounce messages are just discarded. This option can be used only by an admin
3977 user.
3978
3979 .vitem &%-MG%&&~<&'queue&~name'&>&~<&'message&~id'&>&~<&'message&~id'&>&~...
3980 .oindex "&%-MG%&"
3981 .cindex queue named
3982 .cindex "named queues" "moving messages"
3983 .cindex "queue" "moving messages"
3984 This option requests that each listed message be moved from its current
3985 queue to the given named queue.
3986 The destination queue name argument is required, but can be an empty
3987 string to define the default queue.
3988 If the messages are not currently located in the default queue,
3989 a &%-qG<name>%& option will be required to define the source queue.
3990
3991 .vitem &%-Mmad%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3992 .oindex "&%-Mmad%&"
3993 .cindex "delivery" "cancelling all"
3994 This option requests Exim to mark all the recipient addresses in the messages
3995 as already delivered (&"mad"& for &"mark all delivered"&). However, if any
3996 message is active (in the middle of a delivery attempt), its status is not
3997 altered. This option can be used only by an admin user.
3998
3999 .vitem &%-Mmd%&&~<&'message&~id'&>&~<&'address'&>&~<&'address'&>&~...
4000 .oindex "&%-Mmd%&"
4001 .cindex "delivery" "cancelling by address"
4002 .cindex "recipient" "removing"
4003 .cindex "removing recipients"
4004 This option requests Exim to mark the given addresses as already delivered
4005 (&"md"& for &"mark delivered"&). The first argument must be a message id, and
4006 the remaining ones must be email addresses. These are matched to recipient
4007 addresses in the message in a case-sensitive manner. If the message is active
4008 (in the middle of a delivery attempt), its status is not altered. This option
4009 can be used only by an admin user.
4010
4011 .vitem &%-Mrm%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
4012 .oindex "&%-Mrm%&"
4013 .cindex "removing messages"
4014 .cindex "abandoning mail"
4015 .cindex "message" "manually discarding"
4016 This option requests Exim to remove the given messages from the queue. No
4017 bounce messages are sent; each message is simply forgotten. However, if any of
4018 the messages are active, their status is not altered. This option can be used
4019 only by an admin user or by the user who originally caused the message to be
4020 placed in the queue.
4021
4022 . .new
4023 . .vitem &%-MS%&
4024 . .oindex "&%-MS%&"
4025 . .cindex REQUIRETLS
4026 . This option is used to request REQUIRETLS processing on the message.
4027 . It is used internally by Exim in conjunction with -E when generating
4028 . a bounce message.
4029 . .wen
4030
4031 .vitem &%-Mset%&&~<&'message&~id'&>
4032 .oindex "&%-Mset%&"
4033 .cindex "testing" "string expansion"
4034 .cindex "expansion" "testing"
4035 This option is useful only in conjunction with &%-be%& (that is, when testing
4036 string expansions). Exim loads the given message from its spool before doing
4037 the test expansions, thus setting message-specific variables such as
4038 &$message_size$& and the header variables. The &$recipients$& variable is made
4039 available. This feature is provided to make it easier to test expansions that
4040 make use of these variables. However, this option can be used only by an admin
4041 user. See also &%-bem%&.
4042
4043 .vitem &%-Mt%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
4044 .oindex "&%-Mt%&"
4045 .cindex "thawing messages"
4046 .cindex "unfreezing messages"
4047 .cindex "frozen messages" "thawing"
4048 .cindex "message" "thawing frozen"
4049 This option requests Exim to &"thaw"& any of the listed messages that are
4050 &"frozen"&, so that delivery attempts can resume. However, if any of the
4051 messages are active, their status is not altered. This option can be used only
4052 by an admin user.
4053
4054 .vitem &%-Mvb%&&~<&'message&~id'&>
4055 .oindex "&%-Mvb%&"
4056 .cindex "listing" "message body"
4057 .cindex "message" "listing body of"
4058 This option causes the contents of the message body (-D) spool file to be
4059 written to the standard output. This option can be used only by an admin user.
4060
4061 .vitem &%-Mvc%&&~<&'message&~id'&>
4062 .oindex "&%-Mvc%&"
4063 .cindex "message" "listing in RFC 2822 format"
4064 .cindex "listing" "message in RFC 2822 format"
4065 This option causes a copy of the complete message (header lines plus body) to
4066 be written to the standard output in RFC 2822 format. This option can be used
4067 only by an admin user.
4068
4069 .vitem &%-Mvh%&&~<&'message&~id'&>
4070 .oindex "&%-Mvh%&"
4071 .cindex "listing" "message headers"
4072 .cindex "header lines" "listing"
4073 .cindex "message" "listing header lines"
4074 This option causes the contents of the message headers (-H) spool file to be
4075 written to the standard output. This option can be used only by an admin user.
4076
4077 .vitem &%-Mvl%&&~<&'message&~id'&>
4078 .oindex "&%-Mvl%&"
4079 .cindex "listing" "message log"
4080 .cindex "message" "listing message log"
4081 This option causes the contents of the message log spool file to be written to
4082 the standard output. This option can be used only by an admin user.
4083
4084 .vitem &%-m%&
4085 .oindex "&%-m%&"
4086 This is apparently a synonym for &%-om%& that is accepted by Sendmail, so Exim
4087 treats it that way too.
4088
4089 .vitem &%-N%&
4090 .oindex "&%-N%&"
4091 .cindex "debugging" "&%-N%& option"
4092 .cindex "debugging" "suppressing delivery"
4093 This is a debugging option that inhibits delivery of a message at the transport
4094 level. It implies &%-v%&. Exim goes through many of the motions of delivery &--
4095 it just doesn't actually transport the message, but instead behaves as if it
4096 had successfully done so. However, it does not make any updates to the retry
4097 database, and the log entries for deliveries are flagged with &"*>"& rather
4098 than &"=>"&.
4099
4100 Because &%-N%& discards any message to which it applies, only root or the Exim
4101 user are allowed to use it with &%-bd%&, &%-q%&, &%-R%& or &%-M%&. In other
4102 words, an ordinary user can use it only when supplying an incoming message to
4103 which it will apply. Although transportation never fails when &%-N%& is set, an
4104 address may be deferred because of a configuration problem on a transport, or a
4105 routing problem. Once &%-N%& has been used for a delivery attempt, it sticks to
4106 the message, and applies to any subsequent delivery attempts that may happen
4107 for that message.
4108
4109 .vitem &%-n%&
4110 .oindex "&%-n%&"
4111 This option is interpreted by Sendmail to mean &"no aliasing"&.
4112 For normal modes of operation, it is ignored by Exim.
4113 When combined with &%-bP%& it makes the output more terse (suppresses
4114 option names, environment values and config pretty printing).
4115
4116 .vitem &%-O%&&~<&'data'&>
4117 .oindex "&%-O%&"
4118 This option is interpreted by Sendmail to mean &`set option`&. It is ignored by
4119 Exim.
4120
4121 .vitem &%-oA%&&~<&'file&~name'&>
4122 .oindex "&%-oA%&"
4123 .cindex "Sendmail compatibility" "&%-oA%& option"
4124 This option is used by Sendmail in conjunction with &%-bi%& to specify an
4125 alternative alias filename. Exim handles &%-bi%& differently; see the
4126 description above.
4127
4128 .vitem &%-oB%&&~<&'n'&>
4129 .oindex "&%-oB%&"
4130 .cindex "SMTP" "passed connection"
4131 .cindex "SMTP" "multiple deliveries"
4132 .cindex "multiple SMTP deliveries"
4133 This is a debugging option which limits the maximum number of messages that can
4134 be delivered down one SMTP connection, overriding the value set in any &(smtp)&
4135 transport. If <&'n'&> is omitted, the limit is set to 1.
4136
4137 .vitem &%-odb%&
4138 .oindex "&%-odb%&"
4139 .cindex "background delivery"
4140 .cindex "delivery" "in the background"
4141 This option applies to all modes in which Exim accepts incoming messages,
4142 including the listening daemon. It requests &"background"& delivery of such
4143 messages, which means that the accepting process automatically starts a
4144 delivery process for each message received, but does not wait for the delivery
4145 processes to finish.
4146
4147 When all the messages have been received, the reception process exits,
4148 leaving the delivery processes to finish in their own time. The standard output
4149 and error streams are closed at the start of each delivery process.
4150 This is the default action if none of the &%-od%& options are present.
4151
4152 If one of the queueing options in the configuration file
4153 (&%queue_only%& or &%queue_only_file%&, for example) is in effect, &%-odb%&
4154 overrides it if &%queue_only_override%& is set true, which is the default
4155 setting. If &%queue_only_override%& is set false, &%-odb%& has no effect.
4156
4157 .vitem &%-odf%&
4158 .oindex "&%-odf%&"
4159 .cindex "foreground delivery"
4160 .cindex "delivery" "in the foreground"
4161 This option requests &"foreground"& (synchronous) delivery when Exim has
4162 accepted a locally-generated message. (For the daemon it is exactly the same as
4163 &%-odb%&.) A delivery process is automatically started to deliver the message,
4164 and Exim waits for it to complete before proceeding.
4165
4166 The original Exim reception process does not finish until the delivery
4167 process for the final message has ended. The standard error stream is left open
4168 during deliveries.
4169
4170 However, like &%-odb%&, this option has no effect if &%queue_only_override%& is
4171 false and one of the queueing options in the configuration file is in effect.
4172
4173 If there is a temporary delivery error during foreground delivery, the
4174 message is left in the queue for later delivery, and the original reception
4175 process exits. See chapter &<<CHAPnonqueueing>>& for a way of setting up a
4176 restricted configuration that never queues messages.
4177
4178
4179 .vitem &%-odi%&
4180 .oindex "&%-odi%&"
4181 This option is synonymous with &%-odf%&. It is provided for compatibility with
4182 Sendmail.
4183
4184 .vitem &%-odq%&
4185 .oindex "&%-odq%&"
4186 .cindex "non-immediate delivery"
4187 .cindex "delivery" "suppressing immediate"
4188 .cindex "queueing incoming messages"
4189 This option applies to all modes in which Exim accepts incoming messages,
4190 including the listening daemon. It specifies that the accepting process should
4191 not automatically start a delivery process for each message received. Messages
4192 are placed in the queue, and remain there until a subsequent queue runner
4193 process encounters them. There are several configuration options (such as
4194 &%queue_only%&) that can be used to queue incoming messages under certain
4195 conditions. This option overrides all of them and also &%-odqs%&. It always
4196 forces queueing.
4197
4198 .vitem &%-odqs%&
4199 .oindex "&%-odqs%&"
4200 .cindex "SMTP" "delaying delivery"
4201 .cindex "first pass routing"
4202 This option is a hybrid between &%-odb%&/&%-odi%& and &%-odq%&.
4203 However, like &%-odb%& and &%-odi%&, this option has no effect if
4204 &%queue_only_override%& is false and one of the queueing options in the
4205 configuration file is in effect.
4206
4207 When &%-odqs%& does operate, a delivery process is started for each incoming
4208 message, in the background by default, but in the foreground if &%-odi%& is
4209 also present. The recipient addresses are routed, and local deliveries are done
4210 in the normal way. However, if any SMTP deliveries are required, they are not
4211 done at this time, so the message remains in the queue until a subsequent queue
4212 runner process encounters it. Because routing was done, Exim knows which
4213 messages are waiting for which hosts, and so a number of messages for the same
4214 host can be sent in a single SMTP connection. The &%queue_smtp_domains%&
4215 configuration option has the same effect for specific domains. See also the
4216 &%-qq%& option.
4217
4218 .vitem &%-oee%&
4219 .oindex "&%-oee%&"
4220 .cindex "error" "reporting"
4221 If an error is detected while a non-SMTP message is being received (for
4222 example, a malformed address), the error is reported to the sender in a mail
4223 message.
4224
4225 .cindex "return code" "for &%-oee%&"
4226 Provided
4227 this error message is successfully sent, the Exim receiving process
4228 exits with a return code of zero. If not, the return code is 2 if the problem
4229 is that the original message has no recipients, or 1 for any other error.
4230 This is the default &%-oe%&&'x'& option if Exim is called as &'rmail'&.
4231
4232 .vitem &%-oem%&
4233 .oindex "&%-oem%&"
4234 .cindex "error" "reporting"
4235 .cindex "return code" "for &%-oem%&"
4236 This is the same as &%-oee%&, except that Exim always exits with a non-zero
4237 return code, whether or not the error message was successfully sent.
4238 This is the default &%-oe%&&'x'& option, unless Exim is called as &'rmail'&.
4239
4240 .vitem &%-oep%&
4241 .oindex "&%-oep%&"
4242 .cindex "error" "reporting"
4243 If an error is detected while a non-SMTP message is being received, the
4244 error is reported by writing a message to the standard error file (stderr).
4245 .cindex "return code" "for &%-oep%&"
4246 The return code is 1 for all errors.
4247
4248 .vitem &%-oeq%&
4249 .oindex "&%-oeq%&"
4250 .cindex "error" "reporting"
4251 This option is supported for compatibility with Sendmail, but has the same
4252 effect as &%-oep%&.
4253
4254 .vitem &%-oew%&
4255 .oindex "&%-oew%&"
4256 .cindex "error" "reporting"
4257 This option is supported for compatibility with Sendmail, but has the same
4258 effect as &%-oem%&.
4259
4260 .vitem &%-oi%&
4261 .oindex "&%-oi%&"
4262 .cindex "dot" "in incoming non-SMTP message"
4263 This option, which has the same effect as &%-i%&, specifies that a dot on a
4264 line by itself should not terminate an incoming, non-SMTP message. Otherwise, a
4265 single dot does terminate, though Exim does no special processing for other
4266 lines that start with a dot. This option is set by default if Exim is called as
4267 &'rmail'&. See also &%-ti%&.
4268
4269 .vitem &%-oitrue%&
4270 .oindex "&%-oitrue%&"
4271 This option is treated as synonymous with &%-oi%&.
4272
4273 .vitem &%-oMa%&&~<&'host&~address'&>
4274 .oindex "&%-oMa%&"
4275 .cindex "sender" "host address, specifying for local message"
4276 A number of options starting with &%-oM%& can be used to set values associated
4277 with remote hosts on locally-submitted messages (that is, messages not received
4278 over TCP/IP). These options can be used by any caller in conjunction with the
4279 &%-bh%&, &%-be%&, &%-bf%&, &%-bF%&, &%-bt%&, or &%-bv%& testing options. In
4280 other circumstances, they are ignored unless the caller is trusted.
4281
4282 The &%-oMa%& option sets the sender host address. This may include a port
4283 number at the end, after a full stop (period). For example:
4284 .code
4285 exim -bs -oMa 10.9.8.7.1234
4286 .endd
4287 An alternative syntax is to enclose the IP address in square brackets,
4288 followed by a colon and the port number:
4289 .code
4290 exim -bs -oMa [10.9.8.7]:1234
4291 .endd
4292 The IP address is placed in the &$sender_host_address$& variable, and the
4293 port, if present, in &$sender_host_port$&. If both &%-oMa%& and &%-bh%&
4294 are present on the command line, the sender host IP address is taken from
4295 whichever one is last.
4296
4297 .vitem &%-oMaa%&&~<&'name'&>
4298 .oindex "&%-oMaa%&"
4299 .cindex "authentication" "name, specifying for local message"
4300 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMaa%&
4301 option sets the value of &$sender_host_authenticated$& (the authenticator
4302 name). See chapter &<<CHAPSMTPAUTH>>& for a discussion of SMTP authentication.
4303 This option can be used with &%-bh%& and &%-bs%& to set up an
4304 authenticated SMTP session without actually using the SMTP AUTH command.
4305
4306 .vitem &%-oMai%&&~<&'string'&>
4307 .oindex "&%-oMai%&"
4308 .cindex "authentication" "id, specifying for local message"
4309 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMai%&
4310 option sets the value of &$authenticated_id$& (the id that was authenticated).
4311 This overrides the default value (the caller's login id, except with &%-bh%&,
4312 where there is no default) for messages from local sources. See chapter
4313 &<<CHAPSMTPAUTH>>& for a discussion of authenticated ids.
4314
4315 .vitem &%-oMas%&&~<&'address'&>
4316 .oindex "&%-oMas%&"
4317 .cindex "authentication" "sender, specifying for local message"
4318 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMas%&
4319 option sets the authenticated sender value in &$authenticated_sender$&. It
4320 overrides the sender address that is created from the caller's login id for
4321 messages from local sources, except when &%-bh%& is used, when there is no
4322 default. For both &%-bh%& and &%-bs%&, an authenticated sender that is
4323 specified on a MAIL command overrides this value. See chapter
4324 &<<CHAPSMTPAUTH>>& for a discussion of authenticated senders.
4325
4326 .vitem &%-oMi%&&~<&'interface&~address'&>
4327 .oindex "&%-oMi%&"
4328 .cindex "interface" "address, specifying for local message"
4329 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMi%&
4330 option sets the IP interface address value. A port number may be included,
4331 using the same syntax as for &%-oMa%&. The interface address is placed in
4332 &$received_ip_address$& and the port number, if present, in &$received_port$&.
4333
4334 .vitem &%-oMm%&&~<&'message&~reference'&>
4335 .oindex "&%-oMm%&"
4336 .cindex "message reference" "message reference, specifying for local message"
4337 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMm%&
4338 option sets the message reference, e.g. message-id, and is logged during
4339 delivery. This is useful when some kind of audit trail is required to tie
4340 messages together. The format of the message reference is checked and will
4341 abort if the format is invalid. The option will only be accepted if exim is
4342 running in trusted mode, not as any regular user.
4343
4344 The best example of a message reference is when Exim sends a bounce message.
4345 The message reference is the message-id of the original message for which Exim
4346 is sending the bounce.
4347
4348 .vitem &%-oMr%&&~<&'protocol&~name'&>
4349 .oindex "&%-oMr%&"
4350 .cindex "protocol, specifying for local message"
4351 .vindex "&$received_protocol$&"
4352 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMr%&
4353 option sets the received protocol value that is stored in
4354 &$received_protocol$&. However, it does not apply (and is ignored) when &%-bh%&
4355 or &%-bs%& is used. For &%-bh%&, the protocol is forced to one of the standard
4356 SMTP protocol names (see the description of &$received_protocol$& in section
4357 &<<SECTexpvar>>&). For &%-bs%&, the protocol is always &"local-"& followed by
4358 one of those same names. For &%-bS%& (batched SMTP) however, the protocol can
4359 be set by &%-oMr%&. Repeated use of this option is not supported.
4360
4361 .vitem &%-oMs%&&~<&'host&~name'&>
4362 .oindex "&%-oMs%&"
4363 .cindex "sender" "host name, specifying for local message"
4364 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMs%&
4365 option sets the sender host name in &$sender_host_name$&. When this option is
4366 present, Exim does not attempt to look up a host name from an IP address; it
4367 uses the name it is given.
4368
4369 .vitem &%-oMt%&&~<&'ident&~string'&>
4370 .oindex "&%-oMt%&"
4371 .cindex "sender" "ident string, specifying for local message"
4372 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMt%&
4373 option sets the sender ident value in &$sender_ident$&. The default setting for
4374 local callers is the login id of the calling process, except when &%-bh%& is
4375 used, when there is no default.
4376
4377 .vitem &%-om%&
4378 .oindex "&%-om%&"
4379 .cindex "Sendmail compatibility" "&%-om%& option ignored"
4380 In Sendmail, this option means &"me too"&, indicating that the sender of a
4381 message should receive a copy of the message if the sender appears in an alias
4382 expansion. Exim always does this, so the option does nothing.
4383
4384 .vitem &%-oo%&
4385 .oindex "&%-oo%&"
4386 .cindex "Sendmail compatibility" "&%-oo%& option ignored"
4387 This option is ignored. In Sendmail it specifies &"old style headers"&,
4388 whatever that means.
4389
4390 .vitem &%-oP%&&~<&'path'&>
4391 .oindex "&%-oP%&"
4392 .cindex "pid (process id)" "of daemon"
4393 .cindex "daemon" "process id (pid)"
4394 This option is useful only in conjunction with &%-bd%& or &%-q%& with a time
4395 value. The option specifies the file to which the process id of the daemon is
4396 written. When &%-oX%& is used with &%-bd%&, or when &%-q%& with a time is used
4397 without &%-bd%&, this is the only way of causing Exim to write a pid file,
4398 because in those cases, the normal pid file is not used.
4399
4400 .new
4401 .vitem &%-oPX%&
4402 .oindex "&%-oPX%&"
4403 .cindex "pid (process id)" "of daemon"
4404 .cindex "daemon" "process id (pid)"
4405 This option is not intended for general use.
4406 The daemon uses it when terminating due to a SIGTEM, possibly in
4407 combination with &%-oP%&&~<&'path'&>.
4408 It causes the pid file to be removed.
4409 .wen
4410
4411 .vitem &%-or%&&~<&'time'&>
4412 .oindex "&%-or%&"
4413 .cindex "timeout" "for non-SMTP input"
4414 This option sets a timeout value for incoming non-SMTP messages. If it is not
4415 set, Exim will wait forever for the standard input. The value can also be set
4416 by the &%receive_timeout%& option. The format used for specifying times is
4417 described in section &<<SECTtimeformat>>&.
4418
4419 .vitem &%-os%&&~<&'time'&>
4420 .oindex "&%-os%&"
4421 .cindex "timeout" "for SMTP input"
4422 .cindex "SMTP" "input timeout"
4423 This option sets a timeout value for incoming SMTP messages. The timeout
4424 applies to each SMTP command and block of data. The value can also be set by
4425 the &%smtp_receive_timeout%& option; it defaults to 5 minutes. The format used
4426 for specifying times is described in section &<<SECTtimeformat>>&.
4427
4428 .vitem &%-ov%&
4429 .oindex "&%-ov%&"
4430 This option has exactly the same effect as &%-v%&.
4431
4432 .vitem &%-oX%&&~<&'number&~or&~string'&>
4433 .oindex "&%-oX%&"
4434 .cindex "TCP/IP" "setting listening ports"
4435 .cindex "TCP/IP" "setting listening interfaces"
4436 .cindex "port" "receiving TCP/IP"
4437 This option is relevant only when the &%-bd%& (start listening daemon) option
4438 is also given. It controls which ports and interfaces the daemon uses. Details
4439 of the syntax, and how it interacts with configuration file options, are given
4440 in chapter &<<CHAPinterfaces>>&. When &%-oX%& is used to start a daemon, no pid
4441 file is written unless &%-oP%& is also present to specify a pid filename.
4442
4443 .vitem &%-pd%&
4444 .oindex "&%-pd%&"
4445 .cindex "Perl" "starting the interpreter"
4446 This option applies when an embedded Perl interpreter is linked with Exim (see
4447 chapter &<<CHAPperl>>&). It overrides the setting of the &%perl_at_start%&
4448 option, forcing the starting of the interpreter to be delayed until it is
4449 needed.
4450
4451 .vitem &%-ps%&
4452 .oindex "&%-ps%&"
4453 .cindex "Perl" "starting the interpreter"
4454 This option applies when an embedded Perl interpreter is linked with Exim (see
4455 chapter &<<CHAPperl>>&). It overrides the setting of the &%perl_at_start%&
4456 option, forcing the starting of the interpreter to occur as soon as Exim is
4457 started.
4458
4459 .vitem &%-p%&<&'rval'&>:<&'sval'&>
4460 .oindex "&%-p%&"
4461 For compatibility with Sendmail, this option is equivalent to
4462 .display
4463 &`-oMr`& <&'rval'&> &`-oMs`& <&'sval'&>
4464 .endd
4465 It sets the incoming protocol and host name (for trusted callers). The
4466 host name and its colon can be omitted when only the protocol is to be set.
4467 Note the Exim already has two private options, &%-pd%& and &%-ps%&, that refer
4468 to embedded Perl. It is therefore impossible to set a protocol value of &`d`&
4469 or &`s`& using this option (but that does not seem a real limitation).
4470 Repeated use of this option is not supported.
4471
4472 .vitem &%-q%&
4473 .oindex "&%-q%&"
4474 .cindex "queue runner" "starting manually"
4475 This option is normally restricted to admin users. However, there is a
4476 configuration option called &%prod_requires_admin%& which can be set false to
4477 relax this restriction (and also the same requirement for the &%-M%&, &%-R%&,
4478 and &%-S%& options).
4479
4480 .cindex "queue runner" "description of operation"
4481 If other commandline options do not specify an action,
4482 the &%-q%& option starts one queue runner process. This scans the queue of
4483 waiting messages, and runs a delivery process for each one in turn. It waits
4484 for each delivery process to finish before starting the next one. A delivery
4485 process may not actually do any deliveries if the retry times for the addresses
4486 have not been reached. Use &%-qf%& (see below) if you want to override this.
4487
4488 If
4489 .cindex "SMTP" "passed connection"
4490 .cindex "SMTP" "multiple deliveries"
4491 .cindex "multiple SMTP deliveries"
4492 the delivery process spawns other processes to deliver other messages down
4493 passed SMTP connections, the queue runner waits for these to finish before
4494 proceeding.
4495
4496 When all the queued messages have been considered, the original queue runner
4497 process terminates. In other words, a single pass is made over the waiting
4498 mail, one message at a time. Use &%-q%& with a time (see below) if you want
4499 this to be repeated periodically.
4500
4501 Exim processes the waiting messages in an unpredictable order. It isn't very
4502 random, but it is likely to be different each time, which is all that matters.
4503 If one particular message screws up a remote MTA, other messages to the same
4504 MTA have a chance of getting through if they get tried first.
4505
4506 It is possible to cause the messages to be processed in lexical message id
4507 order, which is essentially the order in which they arrived, by setting the
4508 &%queue_run_in_order%& option, but this is not recommended for normal use.
4509
4510 .vitem &%-q%&<&'qflags'&>
4511 The &%-q%& option may be followed by one or more flag letters that change its
4512 behaviour. They are all optional, but if more than one is present, they must
4513 appear in the correct order. Each flag is described in a separate item below.
4514
4515 .vitem &%-qq...%&
4516 .oindex "&%-qq%&"
4517 .cindex "queue" "double scanning"
4518 .cindex "queue" "routing"
4519 .cindex "routing" "whole queue before delivery"
4520 .cindex "first pass routing"
4521 An option starting with &%-qq%& requests a two-stage queue run. In the first
4522 stage, the queue is scanned as if the &%queue_smtp_domains%& option matched
4523 every domain. Addresses are routed, local deliveries happen, but no remote
4524 transports are run.
4525
4526 .new
4527 Performance will be best if the &%queue_run_in_order%& option is false.
4528 .wen
4529
4530 .cindex "hints database" "remembering routing"
4531 The hints database that remembers which messages are waiting for specific hosts
4532 is updated, as if delivery to those hosts had been deferred. After this is
4533 complete, a second, normal queue scan happens, with routing and delivery taking
4534 place as normal. Messages that are routed to the same host should mostly be
4535 delivered down a single SMTP
4536 .cindex "SMTP" "passed connection"
4537 .cindex "SMTP" "multiple deliveries"
4538 .cindex "multiple SMTP deliveries"
4539 connection because of the hints that were set up during the first queue scan.
4540 This option may be useful for hosts that are connected to the Internet
4541 intermittently.
4542
4543 .vitem &%-q[q]i...%&
4544 .oindex "&%-qi%&"
4545 .cindex "queue" "initial delivery"
4546 If the &'i'& flag is present, the queue runner runs delivery processes only for
4547 those messages that haven't previously been tried. (&'i'& stands for &"initial
4548 delivery"&.) This can be helpful if you are putting messages in the queue using
4549 &%-odq%& and want a queue runner just to process the new messages.
4550
4551 .vitem &%-q[q][i]f...%&
4552 .oindex "&%-qf%&"
4553 .cindex "queue" "forcing delivery"
4554 .cindex "delivery" "forcing in queue run"
4555 If one &'f'& flag is present, a delivery attempt is forced for each non-frozen
4556 message, whereas without &'f'& only those non-frozen addresses that have passed
4557 their retry times are tried.
4558
4559 .vitem &%-q[q][i]ff...%&
4560 .oindex "&%-qff%&"
4561 .cindex "frozen messages" "forcing delivery"
4562 If &'ff'& is present, a delivery attempt is forced for every message, whether
4563 frozen or not.
4564
4565 .vitem &%-q[q][i][f[f]]l%&
4566 .oindex "&%-ql%&"
4567 .cindex "queue" "local deliveries only"
4568 The &'l'& (the letter &"ell"&) flag specifies that only local deliveries are to
4569 be done. If a message requires any remote deliveries, it remains in the queue
4570 for later delivery.
4571
4572 .vitem &%-q[q][i][f[f]][l][G<name>[/<time>]]]%&
4573 .oindex "&%-qG%&"
4574 .cindex queue named
4575 .cindex "named queues"  "deliver from"
4576 .cindex "queue" "delivering specific messages"
4577 If the &'G'& flag and a name is present, the queue runner operates on the
4578 queue with the given name rather than the default queue.
4579 The name should not contain a &'/'& character.
4580 For a periodic queue run (see below)
4581 append to the name a slash and a time value.
4582
4583 If other commandline options specify an action, a &'-qG<name>'& option
4584 will specify a queue to operate on.
4585 For example:
4586 .code
4587 exim -bp -qGquarantine
4588 mailq -qGquarantine
4589 exim -qGoffpeak -Rf @special.domain.example
4590 .endd
4591
4592 .vitem &%-q%&<&'qflags'&>&~<&'start&~id'&>&~<&'end&~id'&>
4593 When scanning the queue, Exim can be made to skip over messages whose ids are
4594 lexically less than a given value by following the &%-q%& option with a
4595 starting message id. For example:
4596 .code
4597 exim -q 0t5C6f-0000c8-00
4598 .endd
4599 Messages that arrived earlier than &`0t5C6f-0000c8-00`& are not inspected. If a
4600 second message id is given, messages whose ids are lexically greater than it
4601 are also skipped. If the same id is given twice, for example,
4602 .code
4603 exim -q 0t5C6f-0000c8-00 0t5C6f-0000c8-00
4604 .endd
4605 just one delivery process is started, for that message. This differs from
4606 &%-M%& in that retry data is respected, and it also differs from &%-Mc%& in
4607 that it counts as a delivery from a queue run. Note that the selection
4608 mechanism does not affect the order in which the messages are scanned. There
4609 are also other ways of selecting specific sets of messages for delivery in a
4610 queue run &-- see &%-R%& and &%-S%&.
4611
4612 .vitem &%-q%&<&'qflags'&><&'time'&>
4613 .cindex "queue runner" "starting periodically"
4614 .cindex "periodic queue running"
4615 When a time value is present, the &%-q%& option causes Exim to run as a daemon,
4616 starting a queue runner process at intervals specified by the given time value
4617 (whose format is described in section &<<SECTtimeformat>>&). This form of the
4618 &%-q%& option is commonly combined with the &%-bd%& option, in which case a
4619 single daemon process handles both functions. A common way of starting up a
4620 combined daemon at system boot time is to use a command such as
4621 .code
4622 /usr/exim/bin/exim -bd -q30m
4623 .endd
4624 Such a daemon listens for incoming SMTP calls, and also starts a queue runner
4625 process every 30 minutes.
4626
4627 When a daemon is started by &%-q%& with a time value, but without &%-bd%&, no
4628 pid file is written unless one is explicitly requested by the &%-oP%& option.
4629
4630 .vitem &%-qR%&<&'rsflags'&>&~<&'string'&>
4631 .oindex "&%-qR%&"
4632 This option is synonymous with &%-R%&. It is provided for Sendmail
4633 compatibility.
4634
4635 .vitem &%-qS%&<&'rsflags'&>&~<&'string'&>
4636 .oindex "&%-qS%&"
4637 This option is synonymous with &%-S%&.
4638
4639 .vitem &%-R%&<&'rsflags'&>&~<&'string'&>
4640 .oindex "&%-R%&"
4641 .cindex "queue runner" "for specific recipients"
4642 .cindex "delivery" "to given domain"
4643 .cindex "domain" "delivery to"
4644 The <&'rsflags'&> may be empty, in which case the white space before the string
4645 is optional, unless the string is &'f'&, &'ff'&, &'r'&, &'rf'&, or &'rff'&,
4646 which are the possible values for <&'rsflags'&>. White space is required if
4647 <&'rsflags'&> is not empty.
4648
4649 This option is similar to &%-q%& with no time value, that is, it causes Exim to
4650 perform a single queue run, except that, when scanning the messages on the
4651 queue, Exim processes only those that have at least one undelivered recipient
4652 address containing the given string, which is checked in a case-independent
4653 way. If the <&'rsflags'&> start with &'r'&, <&'string'&> is interpreted as a
4654 regular expression; otherwise it is a literal string.
4655
4656 If you want to do periodic queue runs for messages with specific recipients,
4657 you can combine &%-R%& with &%-q%& and a time value. For example:
4658 .code
4659 exim -q25m -R @special.domain.example
4660 .endd
4661 This example does a queue run for messages with recipients in the given domain
4662 every 25 minutes. Any additional flags that are specified with &%-q%& are
4663 applied to each queue run.
4664
4665 Once a message is selected for delivery by this mechanism, all its addresses
4666 are processed. For the first selected message, Exim overrides any retry
4667 information and forces a delivery attempt for each undelivered address. This
4668 means that if delivery of any address in the first message is successful, any
4669 existing retry information is deleted, and so delivery attempts for that
4670 address in subsequently selected messages (which are processed without forcing)
4671 will run. However, if delivery of any address does not succeed, the retry
4672 information is updated, and in subsequently selected messages, the failing
4673 address will be skipped.
4674
4675 .cindex "frozen messages" "forcing delivery"
4676 If the <&'rsflags'&> contain &'f'& or &'ff'&, the delivery forcing applies to
4677 all selected messages, not just the first; frozen messages are included when
4678 &'ff'& is present.
4679
4680 The &%-R%& option makes it straightforward to initiate delivery of all messages
4681 to a given domain after a host has been down for some time. When the SMTP
4682 command ETRN is accepted by its ACL (see chapter &<<CHAPACL>>&), its default
4683 effect is to run Exim with the &%-R%& option, but it can be configured to run
4684 an arbitrary command instead.
4685
4686 .vitem &%-r%&
4687 .oindex "&%-r%&"
4688 This is a documented (for Sendmail) obsolete alternative name for &%-f%&.
4689
4690 .vitem &%-S%&<&'rsflags'&>&~<&'string'&>
4691 .oindex "&%-S%&"
4692 .cindex "delivery" "from given sender"
4693 .cindex "queue runner" "for specific senders"
4694 This option acts like &%-R%& except that it checks the string against each
4695 message's sender instead of against the recipients. If &%-R%& is also set, both
4696 conditions must be met for a message to be selected. If either of the options
4697 has &'f'& or &'ff'& in its flags, the associated action is taken.
4698
4699 .vitem &%-Tqt%&&~<&'times'&>
4700 .oindex "&%-Tqt%&"
4701 This is an option that is exclusively for use by the Exim testing suite. It is not
4702 recognized when Exim is run normally. It allows for the setting up of explicit
4703 &"queue times"& so that various warning/retry features can be tested.
4704
4705 .vitem &%-t%&
4706 .oindex "&%-t%&"
4707 .cindex "recipient" "extracting from header lines"
4708 .cindex "&'Bcc:'& header line"
4709 .cindex "&'Cc:'& header line"
4710 .cindex "&'To:'& header line"
4711 When Exim is receiving a locally-generated, non-SMTP message on its standard
4712 input, the &%-t%& option causes the recipients of the message to be obtained
4713 from the &'To:'&, &'Cc:'&, and &'Bcc:'& header lines in the message instead of
4714 from the command arguments. The addresses are extracted before any rewriting
4715 takes place and the &'Bcc:'& header line, if present, is then removed.
4716
4717 .cindex "Sendmail compatibility" "&%-t%& option"
4718 If the command has any arguments, they specify addresses to which the message
4719 is &'not'& to be delivered. That is, the argument addresses are removed from
4720 the recipients list obtained from the headers. This is compatible with Smail 3
4721 and in accordance with the documented behaviour of several versions of
4722 Sendmail, as described in man pages on a number of operating systems (e.g.
4723 Solaris 8, IRIX 6.5, HP-UX 11). However, some versions of Sendmail &'add'&
4724 argument addresses to those obtained from the headers, and the O'Reilly
4725 Sendmail book documents it that way. Exim can be made to add argument addresses
4726 instead of subtracting them by setting the option
4727 &%extract_addresses_remove_arguments%& false.
4728
4729 .cindex "&%Resent-%& header lines" "with &%-t%&"
4730 If there are any &%Resent-%& header lines in the message, Exim extracts
4731 recipients from all &'Resent-To:'&, &'Resent-Cc:'&, and &'Resent-Bcc:'& header
4732 lines instead of from &'To:'&, &'Cc:'&, and &'Bcc:'&. This is for compatibility
4733 with Sendmail and other MTAs. (Prior to release 4.20, Exim gave an error if
4734 &%-t%& was used in conjunction with &%Resent-%& header lines.)
4735
4736 RFC 2822 talks about different sets of &%Resent-%& header lines (for when a
4737 message is resent several times). The RFC also specifies that they should be
4738 added at the front of the message, and separated by &'Received:'& lines. It is
4739 not at all clear how &%-t%& should operate in the present of multiple sets,
4740 nor indeed exactly what constitutes a &"set"&.
4741 In practice, it seems that MUAs do not follow the RFC. The &%Resent-%& lines
4742 are often added at the end of the header, and if a message is resent more than
4743 once, it is common for the original set of &%Resent-%& headers to be renamed as
4744 &%X-Resent-%& when a new set is added. This removes any possible ambiguity.
4745
4746 .vitem &%-ti%&
4747 .oindex "&%-ti%&"
4748 This option is exactly equivalent to &%-t%& &%-i%&. It is provided for
4749 compatibility with Sendmail.
4750
4751 .vitem &%-tls-on-connect%&
4752 .oindex "&%-tls-on-connect%&"
4753 .cindex "TLS" "use without STARTTLS"
4754 .cindex "TLS" "automatic start"
4755 This option is available when Exim is compiled with TLS support. It forces all
4756 incoming SMTP connections to behave as if the incoming port is listed in the
4757 &%tls_on_connect_ports%& option. See section &<<SECTsupobssmt>>& and chapter
4758 &<<CHAPTLS>>& for further details.
4759
4760
4761 .vitem &%-U%&
4762 .oindex "&%-U%&"
4763 .cindex "Sendmail compatibility" "&%-U%& option ignored"
4764 Sendmail uses this option for &"initial message submission"&, and its
4765 documentation states that in future releases, it may complain about
4766 syntactically invalid messages rather than fixing them when this flag is not
4767 set. Exim ignores this option.
4768
4769 .vitem &%-v%&
4770 .oindex "&%-v%&"
4771 This option causes Exim to write information to the standard error stream,
4772 describing what it is doing. In particular, it shows the log lines for
4773 receiving and delivering a message, and if an SMTP connection is made, the SMTP
4774 dialogue is shown. Some of the log lines shown may not actually be written to
4775 the log if the setting of &%log_selector%& discards them. Any relevant
4776 selectors are shown with each log line. If none are shown, the logging is
4777 unconditional.
4778
4779 .vitem &%-x%&
4780 .oindex "&%-x%&"
4781 AIX uses &%-x%& for a private purpose (&"mail from a local mail program has
4782 National Language Support extended characters in the body of the mail item"&).
4783 It sets &%-x%& when calling the MTA from its &%mail%& command. Exim ignores
4784 this option.
4785
4786 .vitem &%-X%&&~<&'logfile'&>
4787 .oindex "&%-X%&"
4788 This option is interpreted by Sendmail to cause debug information to be sent
4789 to the named file.  It is ignored by Exim.
4790
4791 .vitem &%-z%&&~<&'log-line'&>
4792 .oindex "&%-z%&"
4793 This option writes its argument to Exim's logfile.
4794 Use is restricted to administrators; the intent is for operational notes.
4795 Quotes should be used to maintain a multi-word item as a single argument,
4796 under most shells.
4797 .endlist
4798
4799 .ecindex IIDclo1
4800 .ecindex IIDclo2
4801
4802
4803 . ////////////////////////////////////////////////////////////////////////////
4804 . Insert a stylized DocBook comment here, to identify the end of the command
4805 . line options. This is for the benefit of the Perl script that automatically
4806 . creates a man page for the options.
4807 . ////////////////////////////////////////////////////////////////////////////
4808
4809 .literal xml
4810 <!-- === End of command line options === -->
4811 .literal off
4812
4813
4814
4815
4816
4817 . ////////////////////////////////////////////////////////////////////////////
4818 . ////////////////////////////////////////////////////////////////////////////
4819
4820
4821 .chapter "The Exim runtime configuration file" "CHAPconf" &&&
4822          "The runtime configuration file"
4823
4824 .cindex "runtime configuration"
4825 .cindex "configuration file" "general description"
4826 .cindex "CONFIGURE_FILE"
4827 .cindex "configuration file" "errors in"
4828 .cindex "error" "in configuration file"
4829 .cindex "return code" "for bad configuration"
4830 Exim uses a single runtime configuration file that is read whenever an Exim
4831 binary is executed. Note that in normal operation, this happens frequently,
4832 because Exim is designed to operate in a distributed manner, without central
4833 control.
4834
4835 If a syntax error is detected while reading the configuration file, Exim
4836 writes a message on the standard error, and exits with a non-zero return code.
4837 The message is also written to the panic log. &*Note*&: Only simple syntax
4838 errors can be detected at this time. The values of any expanded options are
4839 not checked until the expansion happens, even when the expansion does not
4840 actually alter the string.
4841
4842 The name of the configuration file is compiled into the binary for security
4843 reasons, and is specified by the CONFIGURE_FILE compilation option. In
4844 most configurations, this specifies a single file. However, it is permitted to
4845 give a colon-separated list of filenames, in which case Exim uses the first
4846 existing file in the list.
4847
4848 .cindex "EXIM_USER"
4849 .cindex "EXIM_GROUP"
4850 .cindex "CONFIGURE_OWNER"
4851 .cindex "CONFIGURE_GROUP"
4852 .cindex "configuration file" "ownership"
4853 .cindex "ownership" "configuration file"
4854 The runtime configuration file must be owned by root or by the user that is
4855 specified at compile time by the CONFIGURE_OWNER option (if set). The
4856 configuration file must not be world-writeable, or group-writeable unless its
4857 group is the root group or the one specified at compile time by the
4858 CONFIGURE_GROUP option.
4859
4860 &*Warning*&: In a conventional configuration, where the Exim binary is setuid
4861 to root, anybody who is able to edit the runtime configuration file has an
4862 easy way to run commands as root. If you specify a user or group in the
4863 CONFIGURE_OWNER or CONFIGURE_GROUP options, then that user and/or any users
4864 who are members of that group will trivially be able to obtain root privileges.
4865
4866 Up to Exim version 4.72, the runtime configuration file was also permitted to
4867 be writeable by the Exim user and/or group. That has been changed in Exim 4.73
4868 since it offered a simple privilege escalation for any attacker who managed to
4869 compromise the Exim user account.
4870
4871 A default configuration file, which will work correctly in simple situations,
4872 is provided in the file &_src/configure.default_&. If CONFIGURE_FILE
4873 defines just one filename, the installation process copies the default
4874 configuration to a new file of that name if it did not previously exist. If
4875 CONFIGURE_FILE is a list, no default is automatically installed. Chapter
4876 &<<CHAPdefconfil>>& is a &"walk-through"& discussion of the default
4877 configuration.
4878
4879
4880
4881 .section "Using a different configuration file" "SECID40"
4882 .cindex "configuration file" "alternate"
4883 A one-off alternate configuration can be specified by the &%-C%& command line
4884 option, which may specify a single file or a list of files. However, when
4885 &%-C%& is used, Exim gives up its root privilege, unless called by root (or
4886 unless the argument for &%-C%& is identical to the built-in value from
4887 CONFIGURE_FILE), or is listed in the TRUSTED_CONFIG_LIST file and the caller
4888 is the Exim user or the user specified in the CONFIGURE_OWNER setting. &%-C%&
4889 is useful mainly for checking the syntax of configuration files before
4890 installing them. No owner or group checks are done on a configuration file
4891 specified by &%-C%&, if root privilege has been dropped.
4892
4893 Even the Exim user is not trusted to specify an arbitrary configuration file
4894 with the &%-C%& option to be used with root privileges, unless that file is
4895 listed in the TRUSTED_CONFIG_LIST file. This locks out the possibility of
4896 testing a configuration using &%-C%& right through message reception and
4897 delivery, even if the caller is root. The reception works, but by that time,
4898 Exim is running as the Exim user, so when it re-execs to regain privilege for
4899 the delivery, the use of &%-C%& causes privilege to be lost. However, root
4900 can test reception and delivery using two separate commands (one to put a
4901 message in the queue, using &%-odq%&, and another to do the delivery, using
4902 &%-M%&).
4903
4904 If ALT_CONFIG_PREFIX is defined &_in Local/Makefile_&, it specifies a
4905 prefix string with which any file named in a &%-C%& command line option must
4906 start. In addition, the filename must not contain the sequence &"&`/../`&"&.
4907 There is no default setting for ALT_CONFIG_PREFIX; when it is unset, any
4908 filename can be used with &%-C%&.
4909
4910 One-off changes to a configuration can be specified by the &%-D%& command line
4911 option, which defines and overrides values for macros used inside the
4912 configuration file. However, like &%-C%&, the use of this option by a
4913 non-privileged user causes Exim to discard its root privilege.
4914 If DISABLE_D_OPTION is defined in &_Local/Makefile_&, the use of &%-D%& is
4915 completely disabled, and its use causes an immediate error exit.
4916
4917 The WHITELIST_D_MACROS option in &_Local/Makefile_& permits the binary builder
4918 to declare certain macro names trusted, such that root privilege will not
4919 necessarily be discarded.
4920 WHITELIST_D_MACROS defines a colon-separated list of macros which are
4921 considered safe and, if &%-D%& only supplies macros from this list, and the
4922 values are acceptable, then Exim will not give up root privilege if the caller
4923 is root, the Exim run-time user, or the CONFIGURE_OWNER, if set.  This is a
4924 transition mechanism and is expected to be removed in the future.  Acceptable
4925 values for the macros satisfy the regexp: &`^[A-Za-z0-9_/.-]*$`&
4926
4927 Some sites may wish to use the same Exim binary on different machines that
4928 share a file system, but to use different configuration files on each machine.
4929 If CONFIGURE_FILE_USE_NODE is defined in &_Local/Makefile_&, Exim first
4930 looks for a file whose name is the configuration filename followed by a dot
4931 and the machine's node name, as obtained from the &[uname()]& function. If this
4932 file does not exist, the standard name is tried. This processing occurs for
4933 each filename in the list given by CONFIGURE_FILE or &%-C%&.
4934
4935 In some esoteric situations different versions of Exim may be run under
4936 different effective uids and the CONFIGURE_FILE_USE_EUID is defined to
4937 help with this. See the comments in &_src/EDITME_& for details.
4938
4939
4940
4941 .section "Configuration file format" "SECTconffilfor"
4942 .cindex "configuration file" "format of"
4943 .cindex "format" "configuration file"
4944 Exim's configuration file is divided into a number of different parts. General
4945 option settings must always appear at the start of the file. The other parts
4946 are all optional, and may appear in any order. Each part other than the first
4947 is introduced by the word &"begin"& followed by at least one literal
4948 space, and the name of the part. The optional parts are:
4949
4950 .ilist
4951 &'ACL'&: Access control lists for controlling incoming SMTP mail (see chapter
4952 &<<CHAPACL>>&).
4953 .next
4954 .cindex "AUTH" "configuration"
4955 &'authenticators'&: Configuration settings for the authenticator drivers. These
4956 are concerned with the SMTP AUTH command (see chapter &<<CHAPSMTPAUTH>>&).
4957 .next
4958 &'routers'&: Configuration settings for the router drivers. Routers process
4959 addresses and determine how the message is to be delivered (see chapters
4960 &<<CHAProutergeneric>>&&--&<<CHAPredirect>>&).
4961 .next
4962 &'transports'&: Configuration settings for the transport drivers. Transports
4963 define mechanisms for copying messages to destinations (see chapters
4964 &<<CHAPtransportgeneric>>&&--&<<CHAPsmtptrans>>&).
4965 .next
4966 &'retry'&: Retry rules, for use when a message cannot be delivered immediately.
4967 If there is no retry section, or if it is empty (that is, no retry rules are
4968 defined), Exim will not retry deliveries. In this situation, temporary errors
4969 are treated the same as permanent errors. Retry rules are discussed in chapter
4970 &<<CHAPretry>>&.
4971 .next
4972 &'rewrite'&: Global address rewriting rules, for use when a message arrives and
4973 when new addresses are generated during delivery. Rewriting is discussed in
4974 chapter &<<CHAPrewrite>>&.
4975 .next
4976 &'local_scan'&: Private options for the &[local_scan()]& function. If you
4977 want to use this feature, you must set
4978 .code
4979 LOCAL_SCAN_HAS_OPTIONS=yes
4980 .endd
4981 in &_Local/Makefile_& before building Exim. Details of the &[local_scan()]&
4982 facility are given in chapter &<<CHAPlocalscan>>&.
4983 .endlist
4984
4985 .cindex "configuration file" "leading white space in"
4986 .cindex "configuration file" "trailing white space in"
4987 .cindex "white space" "in configuration file"
4988 Leading and trailing white space in configuration lines is always ignored.
4989
4990 Blank lines in the file, and lines starting with a # character (ignoring
4991 leading white space) are treated as comments and are ignored. &*Note*&: A
4992 # character other than at the beginning of a line is not treated specially,
4993 and does not introduce a comment.
4994
4995 Any non-comment line can be continued by ending it with a backslash. Note that
4996 the general rule for white space means that trailing white space after the
4997 backslash and leading white space at the start of continuation
4998 lines is ignored. Comment lines beginning with # (but not empty lines) may
4999 appear in the middle of a sequence of continuation lines.
5000
5001 A convenient way to create a configuration file is to start from the
5002 default, which is supplied in &_src/configure.default_&, and add, delete, or
5003 change settings as required.
5004
5005 The ACLs, retry rules, and rewriting rules have their own syntax which is
5006 described in chapters &<<CHAPACL>>&, &<<CHAPretry>>&, and &<<CHAPrewrite>>&,
5007 respectively. The other parts of the configuration file have some syntactic
5008 items in common, and these are described below, from section &<<SECTcos>>&
5009 onwards. Before that, the inclusion, macro, and conditional facilities are
5010 described.
5011
5012
5013
5014 .section "File inclusions in the configuration file" "SECID41"
5015 .cindex "inclusions in configuration file"
5016 .cindex "configuration file" "including other files"
5017 .cindex "&`.include`& in configuration file"
5018 .cindex "&`.include_if_exists`& in configuration file"
5019 You can include other files inside Exim's runtime configuration file by
5020 using this syntax:
5021 .display
5022 &`.include`& <&'filename'&>
5023 &`.include_if_exists`& <&'filename'&>
5024 .endd
5025 on a line by itself. Double quotes round the filename are optional. If you use
5026 the first form, a configuration error occurs if the file does not exist; the
5027 second form does nothing for non-existent files.
5028 The first form allows a relative name. It is resolved relative to
5029 the directory of the including file. For the second form an absolute filename
5030 is required.
5031
5032 Includes may be nested to any depth, but remember that Exim reads its
5033 configuration file often, so it is a good idea to keep them to a minimum.
5034 If you change the contents of an included file, you must HUP the daemon,
5035 because an included file is read only when the configuration itself is read.
5036
5037 The processing of inclusions happens early, at a physical line level, so, like
5038 comment lines, an inclusion can be used in the middle of an option setting,
5039 for example:
5040 .code
5041 hosts_lookup = a.b.c \
5042                .include /some/file
5043 .endd
5044 Include processing happens after macro processing (see below). Its effect is to
5045 process the lines of the included file as if they occurred inline where the
5046 inclusion appears.
5047
5048
5049
5050 .section "Macros in the configuration file" "SECTmacrodefs"
5051 .cindex "macro" "description of"
5052 .cindex "configuration file" "macros"
5053 If a line in the main part of the configuration (that is, before the first
5054 &"begin"& line) begins with an upper case letter, it is taken as a macro
5055 definition, and must be of the form
5056 .display
5057 <&'name'&> = <&'rest of line'&>
5058 .endd
5059 The name must consist of letters, digits, and underscores, and need not all be
5060 in upper case, though that is recommended. The rest of the line, including any
5061 continuations, is the replacement text, and has leading and trailing white
5062 space removed. Quotes are not removed. The replacement text can never end with
5063 a backslash character, but this doesn't seem to be a serious limitation.
5064
5065 Macros may also be defined between router, transport, authenticator, or ACL
5066 definitions. They may not, however, be defined within an individual driver or
5067 ACL, or in the &%local_scan%&, retry, or rewrite sections of the configuration.
5068
5069 .section "Macro substitution" "SECID42"
5070 Once a macro is defined, all subsequent lines in the file (and any included
5071 files) are scanned for the macro name; if there are several macros, the line is
5072 scanned for each, in turn, in the order in which the macros are defined. The
5073 replacement text is not re-scanned for the current macro, though it is scanned
5074 for subsequently defined macros. For this reason, a macro name may not contain
5075 the name of a previously defined macro as a substring. You could, for example,
5076 define
5077 .display
5078 &`ABCD_XYZ = `&<&'something'&>
5079 &`ABCD = `&<&'something else'&>
5080 .endd
5081 but putting the definitions in the opposite order would provoke a configuration
5082 error. Macro expansion is applied to individual physical lines from the file,
5083 before checking for line continuation or file inclusion (see above). If a line
5084 consists solely of a macro name, and the expansion of the macro is empty, the
5085 line is ignored. A macro at the start of a line may turn the line into a
5086 comment line or a &`.include`& line.
5087
5088
5089 .section "Redefining macros" "SECID43"
5090 Once defined, the value of a macro can be redefined later in the configuration
5091 (or in an included file). Redefinition is specified by using &'=='& instead of
5092 &'='&. For example:
5093 .code
5094 MAC =  initial value
5095 ...
5096 MAC == updated value
5097 .endd
5098 Redefinition does not alter the order in which the macros are applied to the
5099 subsequent lines of the configuration file. It is still the same order in which
5100 the macros were originally defined. All that changes is the macro's value.
5101 Redefinition makes it possible to accumulate values. For example:
5102 .code
5103 MAC =  initial value
5104 ...
5105 MAC == MAC and something added
5106 .endd
5107 This can be helpful in situations where the configuration file is built
5108 from a number of other files.
5109
5110 .section "Overriding macro values" "SECID44"
5111 The values set for macros in the configuration file can be overridden by the
5112 &%-D%& command line option, but Exim gives up its root privilege when &%-D%& is
5113 used, unless called by root or the Exim user. A definition on the command line
5114 using the &%-D%& option causes all definitions and redefinitions within the
5115 file to be ignored.
5116
5117
5118
5119 .section "Example of macro usage" "SECID45"
5120 As an example of macro usage, consider a configuration where aliases are looked
5121 up in a MySQL database. It helps to keep the file less cluttered if long
5122 strings such as SQL statements are defined separately as macros, for example:
5123 .code
5124 ALIAS_QUERY = select mailbox from user where \
5125               login='${quote_mysql:$local_part}';
5126 .endd
5127 This can then be used in a &(redirect)& router setting like this:
5128 .code
5129 data = ${lookup mysql{ALIAS_QUERY}}
5130 .endd
5131 In earlier versions of Exim macros were sometimes used for domain, host, or
5132 address lists. In Exim 4 these are handled better by named lists &-- see
5133 section &<<SECTnamedlists>>&.
5134
5135
5136 .section "Builtin macros" "SECTbuiltinmacros"
5137 Exim defines some macros depending on facilities available, which may
5138 differ due to build-time definitions and from one release to another.
5139 All of these macros start with an underscore.
5140 They can be used to conditionally include parts of a configuration
5141 (see below).
5142
5143 The following classes of macros are defined:
5144 .display
5145 &` _HAVE_*                    `&  build-time defines
5146 &` _DRIVER_ROUTER_*           `&  router drivers
5147 &` _DRIVER_TRANSPORT_*        `&  transport drivers
5148 &` _DRIVER_AUTHENTICATOR_*    `&  authenticator drivers
5149 &` _LOG_*                     `&  log_selector values
5150 &` _OPT_MAIN_*                `&  main config options
5151 &` _OPT_ROUTERS_*             `&  generic router options
5152 &` _OPT_TRANSPORTS_*          `&  generic transport options
5153 &` _OPT_AUTHENTICATORS_*      `&  generic authenticator options
5154 &` _OPT_ROUTER_*_*            `&  private router options
5155 &` _OPT_TRANSPORT_*_*         `&  private transport options
5156 &` _OPT_AUTHENTICATOR_*_*     `&  private authenticator options
5157 .endd
5158
5159 Use an &"exim -bP macros"& command to get the list of macros.
5160
5161
5162 .section "Conditional skips in the configuration file" "SECID46"
5163 .cindex "configuration file" "conditional skips"
5164 .cindex "&`.ifdef`&"
5165 You can use the directives &`.ifdef`&, &`.ifndef`&, &`.elifdef`&,
5166 &`.elifndef`&, &`.else`&, and &`.endif`& to dynamically include or exclude
5167 portions of the configuration file. The processing happens whenever the file is
5168 read (that is, when an Exim binary starts to run).
5169
5170 The implementation is very simple. Instances of the first four directives must
5171 be followed by text that includes the names of one or macros. The condition
5172 that is tested is whether or not any macro substitution has taken place in the
5173 line. Thus:
5174 .code
5175 .ifdef AAA
5176 message_size_limit = 50M
5177 .else
5178 message_size_limit = 100M
5179 .endif
5180 .endd
5181 sets a message size limit of 50M if the macro &`AAA`& is defined
5182 (or &`A`& or &`AA`&), and 100M
5183 otherwise. If there is more than one macro named on the line, the condition
5184 is true if any of them are defined. That is, it is an &"or"& condition. To
5185 obtain an &"and"& condition, you need to use nested &`.ifdef`&s.
5186
5187 Although you can use a macro expansion to generate one of these directives,
5188 it is not very useful, because the condition &"there was a macro substitution
5189 in this line"& will always be true.
5190
5191 Text following &`.else`& and &`.endif`& is ignored, and can be used as comment
5192 to clarify complicated nestings.
5193
5194
5195
5196 .section "Common option syntax" "SECTcos"
5197 .cindex "common option syntax"
5198 .cindex "syntax of common options"
5199 .cindex "configuration file" "common option syntax"
5200 For the main set of options, driver options, and &[local_scan()]& options,
5201 each setting is on a line by itself, and starts with a name consisting of
5202 lower-case letters and underscores. Many options require a data value, and in
5203 these cases the name must be followed by an equals sign (with optional white
5204 space) and then the value. For example:
5205 .code
5206 qualify_domain = mydomain.example.com
5207 .endd
5208 .cindex "hiding configuration option values"
5209 .cindex "configuration options" "hiding value of"
5210 .cindex "options" "hiding value of"
5211 Some option settings may contain sensitive data, for example, passwords for
5212 accessing databases. To stop non-admin users from using the &%-bP%& command
5213 line option to read these values, you can precede the option settings with the
5214 word &"hide"&. For example:
5215 .code
5216 hide mysql_servers = localhost/users/admin/secret-password
5217 .endd
5218 For non-admin users, such options are displayed like this:
5219 .code
5220 mysql_servers = <value not displayable>
5221 .endd
5222 If &"hide"& is used on a driver option, it hides the value of that option on
5223 all instances of the same driver.
5224
5225 The following sections describe the syntax used for the different data types
5226 that are found in option settings.
5227
5228
5229 .section "Boolean options" "SECID47"
5230 .cindex "format" "boolean"
5231 .cindex "boolean configuration values"
5232 .oindex "&%no_%&&'xxx'&"
5233 .oindex "&%not_%&&'xxx'&"
5234 Options whose type is given as boolean are on/off switches. There are two
5235 different ways of specifying such options: with and without a data value. If
5236 the option name is specified on its own without data, the switch is turned on;
5237 if it is preceded by &"no_"& or &"not_"& the switch is turned off. However,
5238 boolean options may be followed by an equals sign and one of the words
5239 &"true"&, &"false"&, &"yes"&, or &"no"&, as an alternative syntax. For example,
5240 the following two settings have exactly the same effect:
5241 .code
5242 queue_only
5243 queue_only = true
5244 .endd
5245 The following two lines also have the same (opposite) effect:
5246 .code
5247 no_queue_only
5248 queue_only = false
5249 .endd
5250 You can use whichever syntax you prefer.
5251
5252
5253
5254
5255 .section "Integer values" "SECID48"
5256 .cindex "integer configuration values"
5257 .cindex "format" "integer"
5258 If an option's type is given as &"integer"&, the value can be given in decimal,
5259 hexadecimal, or octal. If it starts with a digit greater than zero, a decimal
5260 number is assumed. Otherwise, it is treated as an octal number unless it starts
5261 with the characters &"0x"&, in which case the remainder is interpreted as a
5262 hexadecimal number.
5263
5264 If an integer value is followed by the letter K, it is multiplied by 1024; if
5265 it is followed by the letter M, it is multiplied by 1024x1024;
5266 if by the letter G, 1024x1024x1024.
5267 When the values
5268 of integer option settings are output, values which are an exact multiple of
5269 1024 or 1024x1024 are sometimes, but not always, printed using the letters K
5270 and M. The printing style is independent of the actual input format that was
5271 used.
5272
5273
5274 .section "Octal integer values" "SECID49"
5275 .cindex "integer format"
5276 .cindex "format" "octal integer"
5277 If an option's type is given as &"octal integer"&, its value is always
5278 interpreted as an octal number, whether or not it starts with the digit zero.
5279 Such options are always output in octal.
5280
5281
5282 .section "Fixed point numbers" "SECID50"
5283 .cindex "fixed point configuration values"
5284 .cindex "format" "fixed point"
5285 If an option's type is given as &"fixed-point"&, its value must be a decimal
5286 integer, optionally followed by a decimal point and up to three further digits.
5287
5288
5289
5290 .section "Time intervals" "SECTtimeformat"
5291 .cindex "time interval" "specifying in configuration"
5292 .cindex "format" "time interval"
5293 A time interval is specified as a sequence of numbers, each followed by one of
5294 the following letters, with no intervening white space:
5295
5296 .table2 30pt
5297 .irow &%s%& seconds
5298 .irow &%m%& minutes
5299 .irow &%h%& hours
5300 .irow &%d%& days
5301 .irow &%w%& weeks
5302 .endtable
5303
5304 For example, &"3h50m"& specifies 3 hours and 50 minutes. The values of time
5305 intervals are output in the same format. Exim does not restrict the values; it
5306 is perfectly acceptable, for example, to specify &"90m"& instead of &"1h30m"&.
5307
5308
5309
5310 .section "String values" "SECTstrings"
5311 .cindex "string" "format of configuration values"
5312 .cindex "format" "string"
5313 If an option's type is specified as &"string"&, the value can be specified with
5314 or without double-quotes. If it does not start with a double-quote, the value
5315 consists of the remainder of the line plus any continuation lines, starting at
5316 the first character after any leading white space, with trailing white space
5317 removed, and with no interpretation of the characters in the string. Because
5318 Exim removes comment lines (those beginning with #) at an early stage, they can
5319 appear in the middle of a multi-line string. The following two settings are
5320 therefore equivalent:
5321 .code
5322 trusted_users = uucp:mail
5323 trusted_users = uucp:\
5324                 # This comment line is ignored
5325                 mail
5326 .endd
5327 .cindex "string" "quoted"
5328 .cindex "escape characters in quoted strings"
5329 If a string does start with a double-quote, it must end with a closing
5330 double-quote, and any backslash characters other than those used for line
5331 continuation are interpreted as escape characters, as follows:
5332
5333 .table2 100pt
5334 .irow &`\\`&                     "single backslash"
5335 .irow &`\n`&                     "newline"
5336 .irow &`\r`&                     "carriage return"
5337 .irow &`\t`&                     "tab"
5338 .irow "&`\`&<&'octal digits'&>"  "up to 3 octal digits specify one character"
5339 .irow "&`\x`&<&'hex digits'&>"   "up to 2 hexadecimal digits specify one &&&
5340                                    character"
5341 .endtable
5342
5343 If a backslash is followed by some other character, including a double-quote
5344 character, that character replaces the pair.
5345
5346 Quoting is necessary only if you want to make use of the backslash escapes to
5347 insert special characters, or if you need to specify a value with leading or
5348 trailing spaces. These cases are rare, so quoting is almost never needed in
5349 current versions of Exim. In versions of Exim before 3.14, quoting was required
5350 in order to continue lines, so you may come across older configuration files
5351 and examples that apparently quote unnecessarily.
5352
5353
5354 .section "Expanded strings" "SECID51"
5355 .cindex "expansion" "definition of"
5356 Some strings in the configuration file are subjected to &'string expansion'&,
5357 by which means various parts of the string may be changed according to the
5358 circumstances (see chapter &<<CHAPexpand>>&). The input syntax for such strings
5359 is as just described; in particular, the handling of backslashes in quoted
5360 strings is done as part of the input process, before expansion takes place.
5361 However, backslash is also an escape character for the expander, so any
5362 backslashes that are required for that reason must be doubled if they are
5363 within a quoted configuration string.
5364
5365
5366 .section "User and group names" "SECID52"
5367 .cindex "user name" "format of"
5368 .cindex "format" "user name"
5369 .cindex "groups" "name format"
5370 .cindex "format" "group name"
5371 User and group names are specified as strings, using the syntax described
5372 above, but the strings are interpreted specially. A user or group name must
5373 either consist entirely of digits, or be a name that can be looked up using the
5374 &[getpwnam()]& or &[getgrnam()]& function, as appropriate.
5375
5376
5377 .section "List construction" "SECTlistconstruct"
5378 .cindex "list" "syntax of in configuration"
5379 .cindex "format" "list item in configuration"
5380 .cindex "string" "list, definition of"
5381 The data for some configuration options is a list of items, with colon as the
5382 default separator. Many of these options are shown with type &"string list"& in
5383 the descriptions later in this document. Others are listed as &"domain list"&,
5384 &"host list"&, &"address list"&, or &"local part list"&. Syntactically, they
5385 are all the same; however, those other than &"string list"& are subject to
5386 particular kinds of interpretation, as described in chapter
5387 &<<CHAPdomhosaddlists>>&.
5388
5389 In all these cases, the entire list is treated as a single string as far as the
5390 input syntax is concerned. The &%trusted_users%& setting in section
5391 &<<SECTstrings>>& above is an example. If a colon is actually needed in an item
5392 in a list, it must be entered as two colons. Leading and trailing white space
5393 on each item in a list is ignored. This makes it possible to include items that
5394 start with a colon, and in particular, certain forms of IPv6 address. For
5395 example, the list
5396 .code
5397 local_interfaces = 127.0.0.1 : ::::1
5398 .endd
5399 contains two IP addresses, the IPv4 address 127.0.0.1 and the IPv6 address ::1.
5400
5401 &*Note*&: Although leading and trailing white space is ignored in individual
5402 list items, it is not ignored when parsing the list. The space after the first
5403 colon in the example above is necessary. If it were not there, the list would
5404 be interpreted as the two items 127.0.0.1:: and 1.
5405
5406 .section "Changing list separators" "SECTlistsepchange"
5407 .cindex "list separator" "changing"
5408 .cindex "IPv6" "addresses in lists"
5409 Doubling colons in IPv6 addresses is an unwelcome chore, so a mechanism was
5410 introduced to allow the separator character to be changed. If a list begins
5411 with a left angle bracket, followed by any punctuation character, that
5412 character is used instead of colon as the list separator. For example, the list
5413 above can be rewritten to use a semicolon separator like this:
5414 .code
5415 local_interfaces = <; 127.0.0.1 ; ::1
5416 .endd
5417 This facility applies to all lists, with the exception of the list in
5418 &%log_file_path%&. It is recommended that the use of non-colon separators be
5419 confined to circumstances where they really are needed.
5420
5421 .cindex "list separator" "newline as"
5422 .cindex "newline" "as list separator"
5423 It is also possible to use newline and other control characters (those with
5424 code values less than 32, plus DEL) as separators in lists. Such separators
5425 must be provided literally at the time the list is processed. For options that
5426 are string-expanded, you can write the separator using a normal escape
5427 sequence. This will be processed by the expander before the string is
5428 interpreted as a list. For example, if a newline-separated list of domains is
5429 generated by a lookup, you can process it directly by a line such as this:
5430 .code
5431 domains = <\n ${lookup mysql{.....}}
5432 .endd
5433 This avoids having to change the list separator in such data. You are unlikely
5434 to want to use a control character as a separator in an option that is not
5435 expanded, because the value is literal text. However, it can be done by giving
5436 the value in quotes. For example:
5437 .code
5438 local_interfaces = "<\n 127.0.0.1 \n ::1"
5439 .endd
5440 Unlike printing character separators, which can be included in list items by
5441 doubling, it is not possible to include a control character as data when it is
5442 set as the separator. Two such characters in succession are interpreted as
5443 enclosing an empty list item.
5444
5445
5446
5447 .section "Empty items in lists" "SECTempitelis"
5448 .cindex "list" "empty item in"
5449 An empty item at the end of a list is always ignored. In other words, trailing
5450 separator characters are ignored. Thus, the list in
5451 .code
5452 senders = user@domain :
5453 .endd
5454 contains only a single item. If you want to include an empty string as one item
5455 in a list, it must not be the last item. For example, this list contains three
5456 items, the second of which is empty:
5457 .code
5458 senders = user1@domain : : user2@domain
5459 .endd
5460 &*Note*&: There must be white space between the two colons, as otherwise they
5461 are interpreted as representing a single colon data character (and the list
5462 would then contain just one item). If you want to specify a list that contains
5463 just one, empty item, you can do it as in this example:
5464 .code
5465 senders = :
5466 .endd
5467 In this case, the first item is empty, and the second is discarded because it
5468 is at the end of the list.
5469
5470
5471
5472
5473 .section "Format of driver configurations" "SECTfordricon"
5474 .cindex "drivers" "configuration format"
5475 There are separate parts in the configuration for defining routers, transports,
5476 and authenticators. In each part, you are defining a number of driver
5477 instances, each with its own set of options. Each driver instance is defined by
5478 a sequence of lines like this:
5479 .display
5480 <&'instance name'&>:
5481   <&'option'&>
5482   ...
5483   <&'option'&>
5484 .endd
5485 In the following example, the instance name is &(localuser)&, and it is
5486 followed by three options settings:
5487 .code
5488 localuser:
5489   driver = accept
5490   check_local_user
5491   transport = local_delivery
5492 .endd
5493 For each driver instance, you specify which Exim code module it uses &-- by the
5494 setting of the &%driver%& option &-- and (optionally) some configuration
5495 settings. For example, in the case of transports, if you want a transport to
5496 deliver with SMTP you would use the &(smtp)& driver; if you want to deliver to
5497 a local file you would use the &(appendfile)& driver. Each of the drivers is
5498 described in detail in its own separate chapter later in this manual.
5499
5500 You can have several routers, transports, or authenticators that are based on
5501 the same underlying driver (each must have a different instance name).
5502
5503 The order in which routers are defined is important, because addresses are
5504 passed to individual routers one by one, in order. The order in which
5505 transports are defined does not matter at all. The order in which
5506 authenticators are defined is used only when Exim, as a client, is searching
5507 them to find one that matches an authentication mechanism offered by the
5508 server.
5509
5510 .cindex "generic options"
5511 .cindex "options" "generic &-- definition of"
5512 Within a driver instance definition, there are two kinds of option: &'generic'&
5513 and &'private'&. The generic options are those that apply to all drivers of the
5514 same type (that is, all routers, all transports or all authenticators). The
5515 &%driver%& option is a generic option that must appear in every definition.
5516 .cindex "private options"
5517 The private options are special for each driver, and none need appear, because
5518 they all have default values.
5519
5520 The options may appear in any order, except that the &%driver%& option must
5521 precede any private options, since these depend on the particular driver. For
5522 this reason, it is recommended that &%driver%& always be the first option.
5523
5524 Driver instance names, which are used for reference in log entries and
5525 elsewhere, can be any sequence of letters, digits, and underscores (starting
5526 with a letter) and must be unique among drivers of the same type. A router and
5527 a transport (for example) can each have the same name, but no two router
5528 instances can have the same name. The name of a driver instance should not be
5529 confused with the name of the underlying driver module. For example, the
5530 configuration lines:
5531 .code
5532 remote_smtp:
5533   driver = smtp
5534 .endd
5535 create an instance of the &(smtp)& transport driver whose name is
5536 &(remote_smtp)&. The same driver code can be used more than once, with
5537 different instance names and different option settings each time. A second
5538 instance of the &(smtp)& transport, with different options, might be defined
5539 thus:
5540 .code
5541 special_smtp:
5542   driver = smtp
5543   port = 1234
5544   command_timeout = 10s
5545 .endd
5546 The names &(remote_smtp)& and &(special_smtp)& would be used to reference
5547 these transport instances from routers, and these names would appear in log
5548 lines.
5549
5550 Comment lines may be present in the middle of driver specifications. The full
5551 list of option settings for any particular driver instance, including all the
5552 defaulted values, can be extracted by making use of the &%-bP%& command line
5553 option.
5554
5555
5556
5557
5558
5559
5560 . ////////////////////////////////////////////////////////////////////////////
5561 . ////////////////////////////////////////////////////////////////////////////
5562
5563 .chapter "The default configuration file" "CHAPdefconfil"
5564 .scindex IIDconfiwal "configuration file" "default &""walk through""&"
5565 .cindex "default" "configuration file &""walk through""&"
5566 The default configuration file supplied with Exim as &_src/configure.default_&
5567 is sufficient for a host with simple mail requirements. As an introduction to
5568 the way Exim is configured, this chapter &"walks through"& the default
5569 configuration, giving brief explanations of the settings. Detailed descriptions
5570 of the options are given in subsequent chapters. The default configuration file
5571 itself contains extensive comments about ways you might want to modify the
5572 initial settings. However, note that there are many options that are not
5573 mentioned at all in the default configuration.
5574
5575
5576
5577 .section "Macros" "SECTdefconfmacros"
5578 All macros should be defined before any options.
5579
5580 One macro is specified, but commented out, in the default configuration:
5581 .code
5582 # ROUTER_SMARTHOST=MAIL.HOSTNAME.FOR.CENTRAL.SERVER.EXAMPLE
5583 .endd
5584 If all off-site mail is expected to be delivered to a "smarthost", then set the
5585 hostname here and uncomment the macro.  This will affect which router is used
5586 later on.  If this is left commented out, then Exim will perform direct-to-MX
5587 deliveries using a &(dnslookup)& router.
5588
5589 In addition to macros defined here, Exim includes a number of built-in macros
5590 to enable configuration to be guarded by a binary built with support for a
5591 given feature.  See section &<<SECTbuiltinmacros>>& for more details.
5592
5593
5594 .section "Main configuration settings" "SECTdefconfmain"
5595 The main (global) configuration option settings section must always come first
5596 in the file, after the macros.
5597 The first thing you'll see in the file, after some initial comments, is the line
5598 .code
5599 # primary_hostname =
5600 .endd
5601 This is a commented-out setting of the &%primary_hostname%& option. Exim needs
5602 to know the official, fully qualified name of your host, and this is where you
5603 can specify it. However, in most cases you do not need to set this option. When
5604 it is unset, Exim uses the &[uname()]& system function to obtain the host name.
5605
5606 The first three non-comment configuration lines are as follows:
5607 .code
5608 domainlist local_domains    = @
5609 domainlist relay_to_domains =
5610 hostlist   relay_from_hosts = 127.0.0.1
5611 .endd
5612 These are not, in fact, option settings. They are definitions of two named
5613 domain lists and one named host list. Exim allows you to give names to lists of
5614 domains, hosts, and email addresses, in order to make it easier to manage the
5615 configuration file (see section &<<SECTnamedlists>>&).
5616
5617 The first line defines a domain list called &'local_domains'&; this is used
5618 later in the configuration to identify domains that are to be delivered
5619 on the local host.
5620
5621 .cindex "@ in a domain list"
5622 There is just one item in this list, the string &"@"&. This is a special form
5623 of entry which means &"the name of the local host"&. Thus, if the local host is
5624 called &'a.host.example'&, mail to &'any.user@a.host.example'& is expected to
5625 be delivered locally. Because the local host's name is referenced indirectly,
5626 the same configuration file can be used on different hosts.
5627
5628 The second line defines a domain list called &'relay_to_domains'&, but the
5629 list itself is empty. Later in the configuration we will come to the part that
5630 controls mail relaying through the local host; it allows relaying to any
5631 domains in this list. By default, therefore, no relaying on the basis of a mail
5632 domain is permitted.
5633
5634 The third line defines a host list called &'relay_from_hosts'&. This list is
5635 used later in the configuration to permit relaying from any host or IP address
5636 that matches the list. The default contains just the IP address of the IPv4
5637 loopback interface, which means that processes on the local host are able to
5638 submit mail for relaying by sending it over TCP/IP to that interface. No other
5639 hosts are permitted to submit messages for relaying.
5640
5641 Just to be sure there's no misunderstanding: at this point in the configuration
5642 we aren't actually setting up any controls. We are just defining some domains
5643 and hosts that will be used in the controls that are specified later.
5644
5645 The next two configuration lines are genuine option settings:
5646 .code
5647 acl_smtp_rcpt = acl_check_rcpt
5648 acl_smtp_data = acl_check_data
5649 .endd
5650 These options specify &'Access Control Lists'& (ACLs) that are to be used
5651 during an incoming SMTP session for every recipient of a message (every RCPT
5652 command), and after the contents of the message have been received,
5653 respectively. The names of the lists are &'acl_check_rcpt'& and
5654 &'acl_check_data'&, and we will come to their definitions below, in the ACL
5655 section of the configuration. The RCPT ACL controls which recipients are
5656 accepted for an incoming message &-- if a configuration does not provide an ACL
5657 to check recipients, no SMTP mail can be accepted. The DATA ACL allows the
5658 contents of a message to be checked.
5659
5660 Two commented-out option settings are next:
5661 .code
5662 # av_scanner = clamd:/tmp/clamd
5663 # spamd_address = 127.0.0.1 783
5664 .endd
5665 These are example settings that can be used when Exim is compiled with the
5666 content-scanning extension. The first specifies the interface to the virus
5667 scanner, and the second specifies the interface to SpamAssassin. Further
5668 details are given in chapter &<<CHAPexiscan>>&.
5669
5670 Three more commented-out option settings follow:
5671 .code
5672 # tls_advertise_hosts = *
5673 # tls_certificate = /etc/ssl/exim.crt
5674 # tls_privatekey = /etc/ssl/exim.pem
5675 .endd
5676 These are example settings that can be used when Exim is compiled with
5677 support for TLS (aka SSL) as described in section &<<SECTinctlsssl>>&. The
5678 first one specifies the list of clients that are allowed to use TLS when
5679 connecting to this server; in this case, the wildcard means all clients. The
5680 other options specify where Exim should find its TLS certificate and private
5681 key, which together prove the server's identity to any clients that connect.
5682 More details are given in chapter &<<CHAPTLS>>&.
5683
5684 Another two commented-out option settings follow:
5685 .code
5686 # daemon_smtp_ports = 25 : 465 : 587
5687 # tls_on_connect_ports = 465
5688 .endd
5689 .cindex "port" "465 and 587"
5690 .cindex "port" "for message submission"
5691 .cindex "message" "submission, ports for"
5692 .cindex "submissions protocol"
5693 .cindex "smtps protocol"
5694 .cindex "ssmtp protocol"
5695 .cindex "SMTP" "submissions protocol"
5696 .cindex "SMTP" "ssmtp protocol"
5697 .cindex "SMTP" "smtps protocol"
5698 These options provide better support for roaming users who wish to use this
5699 server for message submission. They are not much use unless you have turned on
5700 TLS (as described in the previous paragraph) and authentication (about which
5701 more in section &<<SECTdefconfauth>>&).
5702 Mail submission from mail clients (MUAs) should be separate from inbound mail
5703 to your domain (MX delivery) for various good reasons (eg, ability to impose
5704 much saner TLS protocol and ciphersuite requirements without unintended
5705 consequences).
5706 RFC 6409 (previously 4409) specifies use of port 587 for SMTP Submission,
5707 which uses STARTTLS, so this is the &"submission"& port.
5708 RFC 8314 specifies use of port 465 as the &"submissions"& protocol,
5709 which should be used in preference to 587.
5710 You should also consider deploying SRV records to help clients find
5711 these ports.
5712 Older names for &"submissions"& are &"smtps"& and &"ssmtp"&.
5713
5714 Two more commented-out options settings follow:
5715 .code
5716 # qualify_domain =
5717 # qualify_recipient =
5718 .endd
5719 The first of these specifies a domain that Exim uses when it constructs a
5720 complete email address from a local login name. This is often needed when Exim
5721 receives a message from a local process. If you do not set &%qualify_domain%&,
5722 the value of &%primary_hostname%& is used. If you set both of these options,
5723 you can have different qualification domains for sender and recipient
5724 addresses. If you set only the first one, its value is used in both cases.
5725
5726 .cindex "domain literal" "recognizing format"
5727 The following line must be uncommented if you want Exim to recognize
5728 addresses of the form &'user@[10.11.12.13]'& that is, with a &"domain literal"&
5729 (an IP address within square brackets) instead of a named domain.
5730 .code
5731 # allow_domain_literals
5732 .endd
5733 The RFCs still require this form, but many people think that in the modern
5734 Internet it makes little sense to permit mail to be sent to specific hosts by
5735 quoting their IP addresses. This ancient format has been used by people who
5736 try to abuse hosts by using them for unwanted relaying. However, some
5737 people believe there are circumstances (for example, messages addressed to
5738 &'postmaster'&) where domain literals are still useful.
5739
5740 The next configuration line is a kind of trigger guard:
5741 .code
5742 never_users = root
5743 .endd
5744 It specifies that no delivery must ever be run as the root user. The normal
5745 convention is to set up &'root'& as an alias for the system administrator. This
5746 setting is a guard against slips in the configuration.
5747 The list of users specified by &%never_users%& is not, however, the complete
5748 list; the build-time configuration in &_Local/Makefile_& has an option called
5749 FIXED_NEVER_USERS specifying a list that cannot be overridden. The
5750 contents of &%never_users%& are added to this list. By default
5751 FIXED_NEVER_USERS also specifies root.
5752
5753 When a remote host connects to Exim in order to send mail, the only information
5754 Exim has about the host's identity is its IP address. The next configuration
5755 line,
5756 .code
5757 host_lookup = *
5758 .endd
5759 specifies that Exim should do a reverse DNS lookup on all incoming connections,
5760 in order to get a host name. This improves the quality of the logging
5761 information, but if you feel it is too expensive, you can remove it entirely,
5762 or restrict the lookup to hosts on &"nearby"& networks.
5763 Note that it is not always possible to find a host name from an IP address,
5764 because not all DNS reverse zones are maintained, and sometimes DNS servers are
5765 unreachable.
5766
5767 The next two lines are concerned with &'ident'& callbacks, as defined by RFC
5768 1413 (hence their names):
5769 .code
5770 rfc1413_hosts = *
5771 rfc1413_query_timeout = 0s
5772 .endd
5773 These settings cause Exim to avoid ident callbacks for all incoming SMTP calls.
5774 Few hosts offer RFC1413 service these days; calls have to be
5775 terminated by a timeout and this needlessly delays the startup
5776 of an incoming SMTP connection.
5777 If you have hosts for which you trust RFC1413 and need this
5778 information, you can change this.
5779
5780 This line enables an efficiency SMTP option.  It is negotiated by clients
5781 and not expected to cause problems but can be disabled if needed.
5782 .code
5783 prdr_enable = true
5784 .endd
5785
5786 When Exim receives messages over SMTP connections, it expects all addresses to
5787 be fully qualified with a domain, as required by the SMTP definition. However,
5788 if you are running a server to which simple clients submit messages, you may
5789 find that they send unqualified addresses. The two commented-out options:
5790 .code
5791 # sender_unqualified_hosts =
5792 # recipient_unqualified_hosts =
5793 .endd
5794 show how you can specify hosts that are permitted to send unqualified sender
5795 and recipient addresses, respectively.
5796
5797 The &%log_selector%& option is used to increase the detail of logging
5798 over the default:
5799 .code
5800 log_selector = +smtp_protocol_error +smtp_syntax_error \
5801                +tls_certificate_verified
5802 .endd
5803
5804 The &%percent_hack_domains%& option is also commented out:
5805 .code
5806 # percent_hack_domains =
5807 .endd
5808 It provides a list of domains for which the &"percent hack"& is to operate.
5809 This is an almost obsolete form of explicit email routing. If you do not know
5810 anything about it, you can safely ignore this topic.
5811
5812 The next two settings in the main part of the default configuration are
5813 concerned with messages that have been &"frozen"& on Exim's queue. When a
5814 message is frozen, Exim no longer continues to try to deliver it. Freezing
5815 occurs when a bounce message encounters a permanent failure because the sender
5816 address of the original message that caused the bounce is invalid, so the
5817 bounce cannot be delivered. This is probably the most common case, but there
5818 are also other conditions that cause freezing, and frozen messages are not
5819 always bounce messages.
5820 .code
5821 ignore_bounce_errors_after = 2d
5822 timeout_frozen_after = 7d
5823 .endd
5824 The first of these options specifies that failing bounce messages are to be
5825 discarded after 2 days in the queue. The second specifies that any frozen
5826 message (whether a bounce message or not) is to be timed out (and discarded)
5827 after a week. In this configuration, the first setting ensures that no failing
5828 bounce message ever lasts a week.
5829
5830 Exim queues it's messages in a spool directory. If you expect to have
5831 large queues, you may consider using this option. It splits the spool
5832 directory into subdirectories to avoid file system degradation from
5833 many files in a single directory, resulting in better performance.
5834 Manual manipulation of queued messages becomes more complex (though fortunately
5835 not often needed).
5836 .code
5837 # split_spool_directory = true
5838 .endd
5839
5840 In an ideal world everybody follows the standards. For non-ASCII
5841 messages RFC 2047 is a standard, allowing a maximum line length of 76
5842 characters. Exim adheres that standard and won't process messages which
5843 violate this standard. (Even ${rfc2047:...} expansions will fail.)
5844 In particular, the Exim maintainers have had multiple reports of
5845 problems from Russian administrators of issues until they disable this
5846 check, because of some popular, yet buggy, mail composition software.
5847 .code
5848 # check_rfc2047_length = false
5849 .endd
5850
5851 If you need to be strictly RFC compliant you may wish to disable the
5852 8BITMIME advertisement. Use this, if you exchange mails with systems
5853 that are not 8-bit clean.
5854 .code
5855 # accept_8bitmime = false
5856 .endd
5857
5858 Libraries you use may depend on specific environment settings.  This
5859 imposes a security risk (e.g. PATH). There are two lists:
5860 &%keep_environment%& for the variables to import as they are, and
5861 &%add_environment%& for variables we want to set to a fixed value.
5862 Note that TZ is handled separately, by the $%timezone%$ runtime
5863 option and by the TIMEZONE_DEFAULT buildtime option.
5864 .code
5865 # keep_environment = ^LDAP
5866 # add_environment = PATH=/usr/bin::/bin
5867 .endd
5868
5869
5870 .section "ACL configuration" "SECID54"
5871 .cindex "default" "ACLs"
5872 .cindex "&ACL;" "default configuration"
5873 In the default configuration, the ACL section follows the main configuration.
5874 It starts with the line
5875 .code
5876 begin acl
5877 .endd
5878 and it contains the definitions of two ACLs, called &'acl_check_rcpt'& and
5879 &'acl_check_data'&, that were referenced in the settings of &%acl_smtp_rcpt%&
5880 and &%acl_smtp_data%& above.
5881
5882 .cindex "RCPT" "ACL for"
5883 The first ACL is used for every RCPT command in an incoming SMTP message. Each
5884 RCPT command specifies one of the message's recipients. The ACL statements
5885 are considered in order, until the recipient address is either accepted or
5886 rejected. The RCPT command is then accepted or rejected, according to the
5887 result of the ACL processing.
5888 .code
5889 acl_check_rcpt:
5890 .endd
5891 This line, consisting of a name terminated by a colon, marks the start of the
5892 ACL, and names it.
5893 .code
5894 accept  hosts = :
5895 .endd
5896 This ACL statement accepts the recipient if the sending host matches the list.
5897 But what does that strange list mean? It doesn't actually contain any host
5898 names or IP addresses. The presence of the colon puts an empty item in the
5899 list; Exim matches this only if the incoming message did not come from a remote
5900 host, because in that case, the remote hostname is empty. The colon is
5901 important. Without it, the list itself is empty, and can never match anything.
5902
5903 What this statement is doing is to accept unconditionally all recipients in
5904 messages that are submitted by SMTP from local processes using the standard
5905 input and output (that is, not using TCP/IP). A number of MUAs operate in this
5906 manner.
5907 .code
5908 deny    domains       = +local_domains
5909         local_parts   = ^[.] : ^.*[@%!/|]
5910         message       = Restricted characters in address
5911
5912 deny    domains       = !+local_domains
5913         local_parts   = ^[./|] : ^.*[@%!] : ^.*/\\.\\./
5914         message       = Restricted characters in address
5915 .endd
5916 These statements are concerned with local parts that contain any of the
5917 characters &"@"&, &"%"&, &"!"&, &"/"&, &"|"&, or dots in unusual places.
5918 Although these characters are entirely legal in local parts (in the case of
5919 &"@"& and leading dots, only if correctly quoted), they do not commonly occur
5920 in Internet mail addresses.
5921
5922 The first three have in the past been associated with explicitly routed
5923 addresses (percent is still sometimes used &-- see the &%percent_hack_domains%&
5924 option). Addresses containing these characters are regularly tried by spammers
5925 in an attempt to bypass relaying restrictions, and also by open relay testing
5926 programs. Unless you really need them it is safest to reject these characters
5927 at this early stage. This configuration is heavy-handed in rejecting these
5928 characters for all messages it accepts from remote hosts. This is a deliberate
5929 policy of being as safe as possible.
5930
5931 The first rule above is stricter, and is applied to messages that are addressed
5932 to one of the local domains handled by this host. This is implemented by the
5933 first condition, which restricts it to domains that are listed in the
5934 &'local_domains'& domain list. The &"+"& character is used to indicate a
5935 reference to a named list. In this configuration, there is just one domain in
5936 &'local_domains'&, but in general there may be many.
5937
5938 The second condition on the first statement uses two regular expressions to
5939 block local parts that begin with a dot or contain &"@"&, &"%"&, &"!"&, &"/"&,
5940 or &"|"&. If you have local accounts that include these characters, you will
5941 have to modify this rule.
5942
5943 Empty components (two dots in a row) are not valid in RFC 2822, but Exim
5944 allows them because they have been encountered in practice. (Consider the
5945 common convention of local parts constructed as
5946 &"&'first-initial.second-initial.family-name'&"& when applied to someone like
5947 the author of Exim, who has no second initial.) However, a local part starting
5948 with a dot or containing &"/../"& can cause trouble if it is used as part of a
5949 filename (for example, for a mailing list). This is also true for local parts
5950 that contain slashes. A pipe symbol can also be troublesome if the local part
5951 is incorporated unthinkingly into a shell command line.
5952
5953 The second rule above applies to all other domains, and is less strict. This
5954 allows your own users to send outgoing messages to sites that use slashes
5955 and vertical bars in their local parts. It blocks local parts that begin
5956 with a dot, slash, or vertical bar, but allows these characters within the
5957 local part. However, the sequence &"/../"& is barred. The use of &"@"&, &"%"&,
5958 and &"!"& is blocked, as before. The motivation here is to prevent your users
5959 (or your users' viruses) from mounting certain kinds of attack on remote sites.
5960 .code
5961 accept  local_parts   = postmaster
5962         domains       = +local_domains
5963 .endd
5964 This statement, which has two conditions, accepts an incoming address if the
5965 local part is &'postmaster'& and the domain is one of those listed in the
5966 &'local_domains'& domain list. The &"+"& character is used to indicate a
5967 reference to a named list. In this configuration, there is just one domain in
5968 &'local_domains'&, but in general there may be many.
5969
5970 The presence of this statement means that mail to postmaster is never blocked
5971 by any of the subsequent tests. This can be helpful while sorting out problems
5972 in cases where the subsequent tests are incorrectly denying access.
5973 .code
5974 require verify        = sender
5975 .endd
5976 This statement requires the sender address to be verified before any subsequent
5977 ACL statement can be used. If verification fails, the incoming recipient
5978 address is refused. Verification consists of trying to route the address, to
5979 see if a bounce message could be delivered to it. In the case of remote
5980 addresses, basic verification checks only the domain, but &'callouts'& can be
5981 used for more verification if required. Section &<<SECTaddressverification>>&
5982 discusses the details of address verification.
5983 .code
5984 accept  hosts         = +relay_from_hosts
5985         control       = submission
5986 .endd
5987 This statement accepts the address if the message is coming from one of the
5988 hosts that are defined as being allowed to relay through this host. Recipient
5989 verification is omitted here, because in many cases the clients are dumb MUAs
5990 that do not cope well with SMTP error responses. For the same reason, the
5991 second line specifies &"submission mode"& for messages that are accepted. This
5992 is described in detail in section &<<SECTsubmodnon>>&; it causes Exim to fix
5993 messages that are deficient in some way, for example, because they lack a
5994 &'Date:'& header line. If you are actually relaying out from MTAs, you should
5995 probably add recipient verification here, and disable submission mode.
5996 .code
5997 accept  authenticated = *
5998         control       = submission
5999 .endd
6000 This statement accepts the address if the client host has authenticated itself.
6001 Submission mode is again specified, on the grounds that such messages are most
6002 likely to come from MUAs. The default configuration does not define any
6003 authenticators, though it does include some nearly complete commented-out
6004 examples described in &<<SECTdefconfauth>>&. This means that no client can in
6005 fact authenticate until you complete the authenticator definitions.
6006 .code
6007 require message = relay not permitted
6008         domains = +local_domains : +relay_to_domains
6009 .endd
6010 This statement rejects the address if its domain is neither a local domain nor
6011 one of the domains for which this host is a relay.
6012 .code
6013 require verify = recipient
6014 .endd
6015 This statement requires the recipient address to be verified; if verification
6016 fails, the address is rejected.
6017 .code
6018 # deny    dnslists    = black.list.example
6019 #         message     = rejected because $sender_host_address \
6020 #                       is in a black list at $dnslist_domain\n\
6021 #                       $dnslist_text
6022 #
6023 # warn    dnslists    = black.list.example
6024 #         add_header  = X-Warning: $sender_host_address is in \
6025 #                       a black list at $dnslist_domain
6026 #         log_message = found in $dnslist_domain
6027 .endd
6028 These commented-out lines are examples of how you could configure Exim to check
6029 sending hosts against a DNS black list. The first statement rejects messages
6030 from blacklisted hosts, whereas the second just inserts a warning header
6031 line.
6032 .code
6033 # require verify = csa
6034 .endd
6035 This commented-out line is an example of how you could turn on client SMTP
6036 authorization (CSA) checking. Such checks do DNS lookups for special SRV
6037 records.
6038 .code
6039 accept
6040 .endd
6041 The final statement in the first ACL unconditionally accepts any recipient
6042 address that has successfully passed all the previous tests.
6043 .code
6044 acl_check_data:
6045 .endd
6046 This line marks the start of the second ACL, and names it. Most of the contents
6047 of this ACL are commented out:
6048 .code
6049 # deny    malware   = *
6050 #         message   = This message contains a virus \
6051 #                     ($malware_name).
6052 .endd
6053 These lines are examples of how to arrange for messages to be scanned for
6054 viruses when Exim has been compiled with the content-scanning extension, and a
6055 suitable virus scanner is installed. If the message is found to contain a
6056 virus, it is rejected with the given custom error message.
6057 .code
6058 # warn    spam      = nobody
6059 #         message   = X-Spam_score: $spam_score\n\
6060 #                     X-Spam_score_int: $spam_score_int\n\
6061 #                     X-Spam_bar: $spam_bar\n\
6062 #                     X-Spam_report: $spam_report
6063 .endd
6064 These lines are an example of how to arrange for messages to be scanned by
6065 SpamAssassin when Exim has been compiled with the content-scanning extension,
6066 and SpamAssassin has been installed. The SpamAssassin check is run with
6067 &`nobody`& as its user parameter, and the results are added to the message as a
6068 series of extra header line. In this case, the message is not rejected,
6069 whatever the spam score.
6070 .code
6071 accept
6072 .endd
6073 This final line in the DATA ACL accepts the message unconditionally.
6074
6075
6076 .section "Router configuration" "SECID55"
6077 .cindex "default" "routers"
6078 .cindex "routers" "default"
6079 The router configuration comes next in the default configuration, introduced
6080 by the line
6081 .code
6082 begin routers
6083 .endd
6084 Routers are the modules in Exim that make decisions about where to send
6085 messages. An address is passed to each router, in turn, until it is either
6086 accepted, or failed. This means that the order in which you define the routers
6087 matters. Each router is fully described in its own chapter later in this
6088 manual. Here we give only brief overviews.
6089 .code
6090 # domain_literal:
6091 #   driver = ipliteral
6092 #   domains = !+local_domains
6093 #   transport = remote_smtp
6094 .endd
6095 .cindex "domain literal" "default router"
6096 This router is commented out because the majority of sites do not want to
6097 support domain literal addresses (those of the form &'user@[10.9.8.7]'&). If
6098 you uncomment this router, you also need to uncomment the setting of
6099 &%allow_domain_literals%& in the main part of the configuration.
6100
6101 Which router is used next depends upon whether or not the ROUTER_SMARTHOST
6102 macro has been defined, per
6103 .code
6104 .ifdef ROUTER_SMARTHOST
6105 smarthost:
6106 #...
6107 .else
6108 dnslookup:
6109 #...
6110 .endif
6111 .endd
6112
6113 If ROUTER_SMARTHOST has been defined, either at the top of the file or on the
6114 command-line, then we route all non-local mail to that smarthost; otherwise, we'll
6115 perform DNS lookups for direct-to-MX lookup.  Any mail which is to a local domain will
6116 skip these routers because of the &%domains%& option.
6117
6118 .code
6119 smarthost:
6120   driver = manualroute
6121   domains = ! +local_domains
6122   transport = smarthost_smtp
6123   route_data = ROUTER_SMARTHOST
6124   ignore_target_hosts = <; 0.0.0.0 ; 127.0.0.0/8 ; ::1
6125   no_more
6126 .endd
6127 This router only handles mail which is not to any local domains; this is
6128 specified by the line
6129 .code
6130 domains = ! +local_domains
6131 .endd
6132 The &%domains%& option lists the domains to which this router applies, but the
6133 exclamation mark is a negation sign, so the router is used only for domains
6134 that are not in the domain list called &'local_domains'& (which was defined at
6135 the start of the configuration). The plus sign before &'local_domains'&
6136 indicates that it is referring to a named list. Addresses in other domains are
6137 passed on to the following routers.
6138
6139 The name of the router driver is &(manualroute)& because we are manually
6140 specifying how mail should be routed onwards, instead of using DNS MX.
6141 While the name of this router instance is arbitrary, the &%driver%& option must
6142 be one of the driver modules that is in the Exim binary.
6143
6144 With no pre-conditions other than &%domains%&, all mail for non-local domains
6145 will be handled by this router, and the &%no_more%& setting will ensure that no
6146 other routers will be used for messages matching the pre-conditions.  See
6147 &<<SECTrouprecon>>& for more on how the pre-conditions apply.  For messages which
6148 are handled by this router, we provide a hostname to deliver to in &%route_data%&
6149 and the macro supplies the value; the address is then queued for the
6150 &(smarthost_smtp)& transport.
6151
6152 .code
6153 dnslookup:
6154   driver = dnslookup
6155   domains = ! +local_domains
6156   transport = remote_smtp
6157   ignore_target_hosts = 0.0.0.0 : 127.0.0.0/8
6158   no_more
6159 .endd
6160 The &%domains%& option behaves as per smarthost, above.
6161
6162 The name of the router driver is &(dnslookup)&,
6163 and is specified by the &%driver%& option. Do not be confused by the fact that
6164 the name of this router instance is the same as the name of the driver. The
6165 instance name is arbitrary, but the name set in the &%driver%& option must be
6166 one of the driver modules that is in the Exim binary.
6167
6168 The &(dnslookup)& router routes addresses by looking up their domains in the
6169 DNS in order to obtain a list of hosts to which the address is routed. If the
6170 router succeeds, the address is queued for the &(remote_smtp)& transport, as
6171 specified by the &%transport%& option. If the router does not find the domain
6172 in the DNS, no further routers are tried because of the &%no_more%& setting, so
6173 the address fails and is bounced.
6174
6175 The &%ignore_target_hosts%& option specifies a list of IP addresses that are to
6176 be entirely ignored. This option is present because a number of cases have been
6177 encountered where MX records in the DNS point to host names
6178 whose IP addresses are 0.0.0.0 or are in the 127 subnet (typically 127.0.0.1).
6179 Completely ignoring these IP addresses causes Exim to fail to route the
6180 email address, so it bounces. Otherwise, Exim would log a routing problem, and
6181 continue to try to deliver the message periodically until the address timed
6182 out.
6183 .code
6184 system_aliases:
6185   driver = redirect
6186   allow_fail
6187   allow_defer
6188   data = ${lookup{$local_part}lsearch{/etc/aliases}}
6189 # user = exim
6190   file_transport = address_file
6191   pipe_transport = address_pipe
6192 .endd
6193 Control reaches this and subsequent routers only for addresses in the local
6194 domains. This router checks to see whether the local part is defined as an
6195 alias in the &_/etc/aliases_& file, and if so, redirects it according to the
6196 data that it looks up from that file. If no data is found for the local part,
6197 the value of the &%data%& option is empty, causing the address to be passed to
6198 the next router.
6199
6200 &_/etc/aliases_& is a conventional name for the system aliases file that is
6201 often used. That is why it is referenced by from the default configuration
6202 file. However, you can change this by setting SYSTEM_ALIASES_FILE in
6203 &_Local/Makefile_& before building Exim.
6204 .code
6205 userforward:
6206   driver = redirect
6207   check_local_user
6208 # local_part_suffix = +* : -*
6209 # local_part_suffix_optional
6210   file = $home/.forward
6211 # allow_filter
6212   no_verify
6213   no_expn
6214   check_ancestor
6215   file_transport = address_file
6216   pipe_transport = address_pipe
6217   reply_transport = address_reply
6218 .endd
6219 This is the most complicated router in the default configuration. It is another
6220 redirection router, but this time it is looking for forwarding data set up by
6221 individual users. The &%check_local_user%& setting specifies a check that the
6222 local part of the address is the login name of a local user. If it is not, the
6223 router is skipped. The two commented options that follow &%check_local_user%&,
6224 namely:
6225 .code
6226 # local_part_suffix = +* : -*
6227 # local_part_suffix_optional
6228 .endd
6229 .vindex "&$local_part_suffix$&"
6230 show how you can specify the recognition of local part suffixes. If the first
6231 is uncommented, a suffix beginning with either a plus or a minus sign, followed
6232 by any sequence of characters, is removed from the local part and placed in the
6233 variable &$local_part_suffix$&. The second suffix option specifies that the
6234 presence of a suffix in the local part is optional. When a suffix is present,
6235 the check for a local login uses the local part with the suffix removed.
6236
6237 When a local user account is found, the file called &_.forward_& in the user's
6238 home directory is consulted. If it does not exist, or is empty, the router
6239 declines. Otherwise, the contents of &_.forward_& are interpreted as
6240 redirection data (see chapter &<<CHAPredirect>>& for more details).
6241
6242 .cindex "Sieve filter" "enabling in default router"
6243 Traditional &_.forward_& files contain just a list of addresses, pipes, or
6244 files. Exim supports this by default. However, if &%allow_filter%& is set (it
6245 is commented out by default), the contents of the file are interpreted as a set
6246 of Exim or Sieve filtering instructions, provided the file begins with &"#Exim
6247 filter"& or &"#Sieve filter"&, respectively. User filtering is discussed in the
6248 separate document entitled &'Exim's interfaces to mail filtering'&.
6249
6250 The &%no_verify%& and &%no_expn%& options mean that this router is skipped when
6251 verifying addresses, or when running as a consequence of an SMTP EXPN command.
6252 There are two reasons for doing this:
6253
6254 .olist
6255 Whether or not a local user has a &_.forward_& file is not really relevant when
6256 checking an address for validity; it makes sense not to waste resources doing
6257 unnecessary work.
6258 .next
6259 More importantly, when Exim is verifying addresses or handling an EXPN
6260 command during an SMTP session, it is running as the Exim user, not as root.
6261 The group is the Exim group, and no additional groups are set up.
6262 It may therefore not be possible for Exim to read users' &_.forward_& files at
6263 this time.
6264 .endlist
6265
6266 The setting of &%check_ancestor%& prevents the router from generating a new
6267 address that is the same as any previous address that was redirected. (This
6268 works round a problem concerning a bad interaction between aliasing and
6269 forwarding &-- see section &<<SECTredlocmai>>&).
6270
6271 The final three option settings specify the transports that are to be used when
6272 forwarding generates a direct delivery to a file, or to a pipe, or sets up an
6273 auto-reply, respectively. For example, if a &_.forward_& file contains
6274 .code
6275 a.nother@elsewhere.example, /home/spqr/archive
6276 .endd
6277 the delivery to &_/home/spqr/archive_& is done by running the &%address_file%&
6278 transport.
6279 .code
6280 localuser:
6281   driver = accept
6282   check_local_user
6283 # local_part_suffix = +* : -*
6284 # local_part_suffix_optional
6285   transport = local_delivery
6286 .endd
6287 The final router sets up delivery into local mailboxes, provided that the local
6288 part is the name of a local login, by accepting the address and assigning it to
6289 the &(local_delivery)& transport. Otherwise, we have reached the end of the
6290 routers, so the address is bounced. The commented suffix settings fulfil the
6291 same purpose as they do for the &(userforward)& router.
6292
6293
6294 .section "Transport configuration" "SECID56"
6295 .cindex "default" "transports"
6296 .cindex "transports" "default"
6297 Transports define mechanisms for actually delivering messages. They operate
6298 only when referenced from routers, so the order in which they are defined does
6299 not matter. The transports section of the configuration starts with
6300 .code
6301 begin transports
6302 .endd
6303 Two remote transports and four local transports are defined.
6304 .code
6305 remote_smtp:
6306   driver = smtp
6307   message_size_limit = ${if > {$max_received_linelength}{998} {1}{0}}
6308 .ifdef _HAVE_PRDR
6309   hosts_try_prdr = *
6310 .endif
6311 .endd
6312 This transport is used for delivering messages over SMTP connections.
6313 The list of remote hosts comes from the router.
6314 The &%message_size_limit%& usage is a hack to avoid sending on messages
6315 with over-long lines.
6316
6317 The &%hosts_try_prdr%& option enables an efficiency SMTP option.  It is
6318 negotiated between client and server and not expected to cause problems
6319 but can be disabled if needed.  The built-in macro _HAVE_PRDR guards the
6320 use of the &%hosts_try_prdr%& configuration option.
6321
6322 The other remote transport is used when delivering to a specific smarthost
6323 with whom there must be some kind of existing relationship, instead of the
6324 usual federated system.
6325
6326 .code
6327 smarthost_smtp:
6328   driver = smtp
6329   message_size_limit = ${if > {$max_received_linelength}{998} {1}{0}}
6330   multi_domain
6331   #
6332 .ifdef _HAVE_TLS
6333   # Comment out any of these which you have to, then file a Support
6334   # request with your smarthost provider to get things fixed:
6335   hosts_require_tls = *
6336   tls_verify_hosts = *
6337   # As long as tls_verify_hosts is enabled, this won't matter, but if you
6338   # have to comment it out then this will at least log whether you succeed
6339   # or not:
6340   tls_try_verify_hosts = *
6341   #
6342   # The SNI name should match the name which we'll expect to verify;
6343   # many mail systems don't use SNI and this doesn't matter, but if it does,
6344   # we need to send a name which the remote site will recognize.
6345   # This _should_ be the name which the smarthost operators specified as
6346   # the hostname for sending your mail to.
6347   tls_sni = ROUTER_SMARTHOST
6348   #
6349 .ifdef _HAVE_OPENSSL
6350   tls_require_ciphers = HIGH:!aNULL:@STRENGTH
6351 .endif
6352 .ifdef _HAVE_GNUTLS
6353   tls_require_ciphers = SECURE192:-VERS-SSL3.0:-VERS-TLS1.0:-VERS-TLS1.1
6354 .endif
6355 .endif
6356 .ifdef _HAVE_PRDR
6357   hosts_try_prdr = *
6358 .endif
6359 .endd
6360 After the same &%message_size_limit%& hack, we then specify that this Transport
6361 can handle messages to multiple domains in one run.  The assumption here is
6362 that you're routing all non-local mail to the same place and that place is
6363 happy to take all messages from you as quickly as possible.
6364 All other options depend upon built-in macros; if Exim was built without TLS support
6365 then no other options are defined.
6366 If TLS is available, then we configure "stronger than default" TLS ciphersuites
6367 and versions using the &%tls_require_ciphers%& option, where the value to be
6368 used depends upon the library providing TLS.
6369 Beyond that, the options adopt the stance that you should have TLS support available
6370 from your smarthost on today's Internet, so we turn on requiring TLS for the
6371 mail to be delivered, and requiring that the certificate be valid, and match
6372 the expected hostname.  The &%tls_sni%& option can be used by service providers
6373 to select an appropriate certificate to present to you and here we re-use the
6374 ROUTER_SMARTHOST macro, because that is unaffected by CNAMEs present in DNS.
6375 You want to specify the hostname which you'll expect to validate for, and that
6376 should not be subject to insecure tampering via DNS results.
6377
6378 For the &%hosts_try_prdr%& option see the previous transport.
6379
6380 All other options are defaulted.
6381 .code
6382 local_delivery:
6383   driver = appendfile
6384   file = /var/mail/$local_part_data
6385   delivery_date_add
6386   envelope_to_add
6387   return_path_add
6388 # group = mail
6389 # mode = 0660
6390 .endd
6391 This &(appendfile)& transport is used for local delivery to user mailboxes in
6392 traditional BSD mailbox format.
6393
6394 .new
6395 We prefer to avoid using &$local_part$& directly to define the mailbox filename,
6396 as it is provided by a potential bad actor.
6397 Instead we use &$local_part_data$&,
6398 the result of looking up &$local_part$& in the user database
6399 (done by using &%check_local_user%& in the the router).
6400 .wen
6401
6402 By default &(appendfile)& runs under the uid and gid of the
6403 local user, which requires the sticky bit to be set on the &_/var/mail_&
6404 directory. Some systems use the alternative approach of running mail deliveries
6405 under a particular group instead of using the sticky bit. The commented options
6406 show how this can be done.
6407
6408 Exim adds three headers to the message as it delivers it: &'Delivery-date:'&,
6409 &'Envelope-to:'& and &'Return-path:'&. This action is requested by the three
6410 similarly-named options above.
6411 .code
6412 address_pipe:
6413   driver = pipe
6414   return_output
6415 .endd
6416 This transport is used for handling deliveries to pipes that are generated by
6417 redirection (aliasing or users' &_.forward_& files). The &%return_output%&
6418 option specifies that any output on stdout or stderr generated by the pipe is to
6419 be returned to the sender.
6420 .code
6421 address_file:
6422   driver = appendfile
6423   delivery_date_add
6424   envelope_to_add
6425   return_path_add
6426 .endd
6427 This transport is used for handling deliveries to files that are generated by
6428 redirection. The name of the file is not specified in this instance of
6429 &(appendfile)&, because it comes from the &(redirect)& router.
6430 .code
6431 address_reply:
6432   driver = autoreply
6433 .endd
6434 This transport is used for handling automatic replies generated by users'
6435 filter files.
6436
6437
6438
6439 .section "Default retry rule" "SECID57"
6440 .cindex "retry" "default rule"
6441 .cindex "default" "retry rule"
6442 The retry section of the configuration file contains rules which affect the way
6443 Exim retries deliveries that cannot be completed at the first attempt. It is
6444 introduced by the line
6445 .code
6446 begin retry
6447 .endd
6448 In the default configuration, there is just one rule, which applies to all
6449 errors:
6450 .code
6451 *   *   F,2h,15m; G,16h,1h,1.5; F,4d,6h
6452 .endd
6453 This causes any temporarily failing address to be retried every 15 minutes for
6454 2 hours, then at intervals starting at one hour and increasing by a factor of
6455 1.5 until 16 hours have passed, then every 6 hours up to 4 days. If an address
6456 is not delivered after 4 days of temporary failure, it is bounced. The time is
6457 measured from first failure, not from the time the message was received.
6458
6459 If the retry section is removed from the configuration, or is empty (that is,
6460 if no retry rules are defined), Exim will not retry deliveries. This turns
6461 temporary errors into permanent errors.
6462
6463
6464 .section "Rewriting configuration" "SECID58"
6465 The rewriting section of the configuration, introduced by
6466 .code
6467 begin rewrite
6468 .endd
6469 contains rules for rewriting addresses in messages as they arrive. There are no
6470 rewriting rules in the default configuration file.
6471
6472
6473
6474 .section "Authenticators configuration" "SECTdefconfauth"
6475 .cindex "AUTH" "configuration"
6476 The authenticators section of the configuration, introduced by
6477 .code
6478 begin authenticators
6479 .endd
6480 defines mechanisms for the use of the SMTP AUTH command. The default
6481 configuration file contains two commented-out example authenticators
6482 which support plaintext username/password authentication using the
6483 standard PLAIN mechanism and the traditional but non-standard LOGIN
6484 mechanism, with Exim acting as the server. PLAIN and LOGIN are enough
6485 to support most MUA software.
6486
6487 The example PLAIN authenticator looks like this:
6488 .code
6489 #PLAIN:
6490 #  driver                  = plaintext
6491 #  server_set_id           = $auth2
6492 #  server_prompts          = :
6493 #  server_condition        = Authentication is not yet configured
6494 #  server_advertise_condition = ${if def:tls_in_cipher }
6495 .endd
6496 And the example LOGIN authenticator looks like this:
6497 .code
6498 #LOGIN:
6499 #  driver                  = plaintext
6500 #  server_set_id           = $auth1
6501 #  server_prompts          = <| Username: | Password:
6502 #  server_condition        = Authentication is not yet configured
6503 #  server_advertise_condition = ${if def:tls_in_cipher }
6504 .endd
6505
6506 The &%server_set_id%& option makes Exim remember the authenticated username
6507 in &$authenticated_id$&, which can be used later in ACLs or routers. The
6508 &%server_prompts%& option configures the &(plaintext)& authenticator so
6509 that it implements the details of the specific authentication mechanism,
6510 i.e. PLAIN or LOGIN. The &%server_advertise_condition%& setting controls
6511 when Exim offers authentication to clients; in the examples, this is only
6512 when TLS or SSL has been started, so to enable the authenticators you also
6513 need to add support for TLS as described in section &<<SECTdefconfmain>>&.
6514
6515 The &%server_condition%& setting defines how to verify that the username and
6516 password are correct. In the examples it just produces an error message.
6517 To make the authenticators work, you can use a string expansion
6518 expression like one of the examples in chapter &<<CHAPplaintext>>&.
6519
6520 Beware that the sequence of the parameters to PLAIN and LOGIN differ; the
6521 usercode and password are in different positions.
6522 Chapter &<<CHAPplaintext>>& covers both.
6523
6524 .ecindex IIDconfiwal
6525
6526
6527
6528 . ////////////////////////////////////////////////////////////////////////////
6529 . ////////////////////////////////////////////////////////////////////////////
6530
6531 .chapter "Regular expressions" "CHAPregexp"
6532
6533 .cindex "regular expressions" "library"
6534 .cindex "PCRE"
6535 Exim supports the use of regular expressions in many of its options. It
6536 uses the PCRE regular expression library; this provides regular expression
6537 matching that is compatible with Perl 5. The syntax and semantics of
6538 regular expressions is discussed in
6539 online Perl manpages, in
6540 many Perl reference books, and also in
6541 Jeffrey Friedl's &'Mastering Regular Expressions'&, which is published by
6542 O'Reilly (see &url(http://www.oreilly.com/catalog/regex2/)).
6543 . --- the http: URL here redirects to another page with the ISBN in the URL
6544 . --- where trying to use https: just redirects back to http:, so sticking
6545 . --- to the old URL for now.  2018-09-07.
6546
6547 The documentation for the syntax and semantics of the regular expressions that
6548 are supported by PCRE is included in the PCRE distribution, and no further
6549 description is included here. The PCRE functions are called from Exim using
6550 the default option settings (that is, with no PCRE options set), except that
6551 the PCRE_CASELESS option is set when the matching is required to be
6552 case-insensitive.
6553
6554 In most cases, when a regular expression is required in an Exim configuration,
6555 it has to start with a circumflex, in order to distinguish it from plain text
6556 or an &"ends with"& wildcard. In this example of a configuration setting, the
6557 second item in the colon-separated list is a regular expression.
6558 .code
6559 domains = a.b.c : ^\\d{3} : *.y.z : ...
6560 .endd
6561 The doubling of the backslash is required because of string expansion that
6562 precedes interpretation &-- see section &<<SECTlittext>>& for more discussion
6563 of this issue, and a way of avoiding the need for doubling backslashes. The
6564 regular expression that is eventually used in this example contains just one
6565 backslash. The circumflex is included in the regular expression, and has the
6566 normal effect of &"anchoring"& it to the start of the string that is being
6567 matched.
6568
6569 There are, however, two cases where a circumflex is not required for the
6570 recognition of a regular expression: these are the &%match%& condition in a
6571 string expansion, and the &%matches%& condition in an Exim filter file. In
6572 these cases, the relevant string is always treated as a regular expression; if
6573 it does not start with a circumflex, the expression is not anchored, and can
6574 match anywhere in the subject string.
6575
6576 In all cases, if you want a regular expression to match at the end of a string,
6577 you must code the $ metacharacter to indicate this. For example:
6578 .code
6579 domains = ^\\d{3}\\.example
6580 .endd
6581 matches the domain &'123.example'&, but it also matches &'123.example.com'&.
6582 You need to use:
6583 .code
6584 domains = ^\\d{3}\\.example\$
6585 .endd
6586 if you want &'example'& to be the top-level domain. The backslash before the
6587 $ is needed because string expansion also interprets dollar characters.
6588
6589
6590
6591 . ////////////////////////////////////////////////////////////////////////////
6592 . ////////////////////////////////////////////////////////////////////////////
6593
6594 .chapter "File and database lookups" "CHAPfdlookup"
6595 .scindex IIDfidalo1 "file" "lookups"
6596 .scindex IIDfidalo2 "database" "lookups"
6597 .cindex "lookup" "description of"
6598 Exim can be configured to look up data in files or databases as it processes
6599 messages. Two different kinds of syntax are used:
6600
6601 .olist
6602 A string that is to be expanded may contain explicit lookup requests. These
6603 cause parts of the string to be replaced by data that is obtained from the
6604 lookup. Lookups of this type are conditional expansion items. Different results
6605 can be defined for the cases of lookup success and failure. See chapter
6606 &<<CHAPexpand>>&, where string expansions are described in detail.
6607 The key for the lookup is specified as part of the string expansion.
6608 .next
6609 Lists of domains, hosts, and email addresses can contain lookup requests as a
6610 way of avoiding excessively long linear lists. In this case, the data that is
6611 returned by the lookup is often (but not always) discarded; whether the lookup
6612 succeeds or fails is what really counts. These kinds of list are described in
6613 chapter &<<CHAPdomhosaddlists>>&.
6614 The key for the lookup is given by the context in which the list is expanded.
6615 .endlist
6616
6617 String expansions, lists, and lookups interact with each other in such a way
6618 that there is no order in which to describe any one of them that does not
6619 involve references to the others. Each of these three chapters makes more sense
6620 if you have read the other two first. If you are reading this for the first
6621 time, be aware that some of it will make a lot more sense after you have read
6622 chapters &<<CHAPdomhosaddlists>>& and &<<CHAPexpand>>&.
6623
6624 .section "Examples of different lookup syntax" "SECID60"
6625 It is easy to confuse the two different kinds of lookup, especially as the
6626 lists that may contain the second kind are always expanded before being
6627 processed as lists. Therefore, they may also contain lookups of the first kind.
6628 Be careful to distinguish between the following two examples:
6629 .code
6630 domains = ${lookup{$sender_host_address}lsearch{/some/file}}
6631 domains = lsearch;/some/file
6632 .endd
6633 The first uses a string expansion, the result of which must be a domain list.
6634 No strings have been specified for a successful or a failing lookup; the
6635 defaults in this case are the looked-up data and an empty string, respectively.
6636 The expansion takes place before the string is processed as a list, and the
6637 file that is searched could contain lines like this:
6638 .code
6639 192.168.3.4: domain1:domain2:...
6640 192.168.1.9: domain3:domain4:...
6641 .endd
6642 When the lookup succeeds, the result of the expansion is a list of domains (and
6643 possibly other types of item that are allowed in domain lists).
6644 .cindex "tainted data" "de-tainting"
6645 The result of the expansion is not tainted.
6646
6647 In the second example, the lookup is a single item in a domain list. It causes
6648 Exim to use a lookup to see if the domain that is being processed can be found
6649 in the file. The file could contains lines like this:
6650 .code
6651 domain1:
6652 domain2:
6653 .endd
6654 Any data that follows the keys is not relevant when checking that the domain
6655 matches the list item.
6656
6657 It is possible, though no doubt confusing, to use both kinds of lookup at once.
6658 Consider a file containing lines like this:
6659 .code
6660 192.168.5.6: lsearch;/another/file
6661 .endd
6662 If the value of &$sender_host_address$& is 192.168.5.6, expansion of the
6663 first &%domains%& setting above generates the second setting, which therefore
6664 causes a second lookup to occur.
6665
6666 .new
6667 The lookup type may optionally be followed by a comma
6668 and a comma-separated list of options.
6669 Each option is a &"name=value"& pair.
6670 Whether an option is meaningful depands on the lookup type.
6671 .wen
6672
6673 The rest of this chapter describes the different lookup types that are
6674 available. Any of them can be used in any part of the configuration where a
6675 lookup is permitted.
6676
6677
6678 .section "Lookup types" "SECID61"
6679 .cindex "lookup" "types of"
6680 .cindex "single-key lookup" "definition of"
6681 Two different types of data lookup are implemented:
6682
6683 .ilist
6684 The &'single-key'& type requires the specification of a file in which to look,
6685 and a single key to search for. The key must be a non-empty string for the
6686 lookup to succeed. The lookup type determines how the file is searched.
6687 .new
6688 .cindex "tainted data" "single-key lookups"
6689 The file string may not be tainted
6690
6691 .cindex "tainted data" "de-tainting"
6692 All single-key lookups support the option &"ret=key"&.
6693 If this is given and the lookup
6694 (either underlying implementation or cached value)
6695 returns data, the result is replaced with a non-tainted
6696 version of the lookup key.
6697 .wen
6698 .next
6699 .cindex "query-style lookup" "definition of"
6700 The &'query-style'& type accepts a generalized database query. No particular
6701 key value is assumed by Exim for query-style lookups. You can use whichever
6702 Exim variables you need to construct the database query.
6703 .endlist
6704
6705 The code for each lookup type is in a separate source file that is included in
6706 the binary of Exim only if the corresponding compile-time option is set. The
6707 default settings in &_src/EDITME_& are:
6708 .code
6709 LOOKUP_DBM=yes
6710 LOOKUP_LSEARCH=yes
6711 .endd
6712 which means that only linear searching and DBM lookups are included by default.
6713 For some types of lookup (e.g. SQL databases), you need to install appropriate
6714 libraries and header files before building Exim.
6715
6716
6717
6718
6719 .section "Single-key lookup types" "SECTsinglekeylookups"
6720 .cindex "lookup" "single-key types"
6721 .cindex "single-key lookup" "list of types"
6722 The following single-key lookup types are implemented:
6723
6724 .ilist
6725 .cindex "cdb" "description of"
6726 .cindex "lookup" "cdb"
6727 .cindex "binary zero" "in lookup key"
6728 &(cdb)&: The given file is searched as a Constant DataBase file, using the key
6729 string without a terminating binary zero. The cdb format is designed for
6730 indexed files that are read frequently and never updated, except by total
6731 re-creation. As such, it is particularly suitable for large files containing
6732 aliases or other indexed data referenced by an MTA. Information about cdb and
6733 tools for building the files can be found in several places:
6734 .display
6735 &url(https://cr.yp.to/cdb.html)
6736 &url(https://www.corpit.ru/mjt/tinycdb.html)
6737 &url(https://packages.debian.org/stable/utils/freecdb)
6738 &url(https://github.com/philpennock/cdbtools) (in Go)
6739 .endd
6740 A cdb distribution is not needed in order to build Exim with cdb support,
6741 because the code for reading cdb files is included directly in Exim itself.
6742 However, no means of building or testing cdb files is provided with Exim, so
6743 you need to obtain a cdb distribution in order to do this.
6744 .next
6745 .cindex "DBM" "lookup type"
6746 .cindex "lookup" "dbm"
6747 .cindex "binary zero" "in lookup key"
6748 &(dbm)&: Calls to DBM library functions are used to extract data from the given
6749 DBM file by looking up the record with the given key. A terminating binary
6750 zero is included in the key that is passed to the DBM library. See section
6751 &<<SECTdb>>& for a discussion of DBM libraries.
6752
6753 .cindex "Berkeley DB library" "file format"
6754 For all versions of Berkeley DB, Exim uses the DB_HASH style of database
6755 when building DBM files using the &%exim_dbmbuild%& utility. However, when
6756 using Berkeley DB versions 3 or 4, it opens existing databases for reading with
6757 the DB_UNKNOWN option. This enables it to handle any of the types of database
6758 that the library supports, and can be useful for accessing DBM files created by
6759 other applications. (For earlier DB versions, DB_HASH is always used.)
6760 .next
6761 .cindex "lookup" "dbmjz"
6762 .cindex "lookup" "dbm &-- embedded NULs"
6763 .cindex "sasldb2"
6764 .cindex "dbmjz lookup type"
6765 &(dbmjz)&: This is the same as &(dbm)&, except that the lookup key is
6766 interpreted as an Exim list; the elements of the list are joined together with
6767 ASCII NUL characters to form the lookup key.  An example usage would be to
6768 authenticate incoming SMTP calls using the passwords from Cyrus SASL's
6769 &_/etc/sasldb2_& file with the &(gsasl)& authenticator or Exim's own
6770 &(cram_md5)& authenticator.
6771 .next
6772 .cindex "lookup" "dbmnz"
6773 .cindex "lookup" "dbm &-- terminating zero"
6774 .cindex "binary zero" "in lookup key"
6775 .cindex "Courier"
6776 .cindex "&_/etc/userdbshadow.dat_&"
6777 .cindex "dbmnz lookup type"
6778 &(dbmnz)&: This is the same as &(dbm)&, except that a terminating binary zero
6779 is not included in the key that is passed to the DBM library. You may need this
6780 if you want to look up data in files that are created by or shared with some
6781 other application that does not use terminating zeros. For example, you need to
6782 use &(dbmnz)& rather than &(dbm)& if you want to authenticate incoming SMTP
6783 calls using the passwords from Courier's &_/etc/userdbshadow.dat_& file. Exim's
6784 utility program for creating DBM files (&'exim_dbmbuild'&) includes the zeros
6785 by default, but has an option to omit them (see section &<<SECTdbmbuild>>&).
6786 .next
6787 .cindex "lookup" "dsearch"
6788 .cindex "dsearch lookup type"
6789 &(dsearch)&: The given file must be an
6790 .new
6791 absolute
6792 .wen
6793 directory path; this is searched for an entry
6794 whose name is the key by calling the &[lstat()]& function.
6795 The key may not
6796 contain any forward slash characters.
6797 If &[lstat()]& succeeds then so does the lookup.
6798 .new
6799 .cindex "tainted data" "dsearch result"
6800 The result is regarded as untainted.
6801
6802 Options for the lookup can be given by appending them after the word "dsearch",
6803 separated by a comma.  Options, if present, are a comma-separated list having
6804 each element starting with a tag name and an equals.
6805
6806 Two options are supported, for the return value and for filtering match
6807 candidates.
6808 The "ret" option requests an alternate result value of
6809 the entire path for the entry. Example:
6810 .code
6811 ${lookup {passwd} dsearch,ret=full {/etc}}
6812 .endd
6813 The default result is just the requested entry.
6814 The "filter" option requests that only directory entries of a given type
6815 are matched. The match value is one of "file", "dir" or "subdir" (the latter
6816 not matching "." or ".."). Example:
6817 .code
6818 ${lookup {passwd} dsearch,filter=file {/etc}}
6819 .endd
6820 The default matching is for any entry type, including directories
6821 and symlinks.
6822 .wen
6823
6824 An example of how this
6825 lookup can be used to support virtual domains is given in section
6826 &<<SECTvirtualdomains>>&.
6827 .next
6828 .cindex "lookup" "iplsearch"
6829 .cindex "iplsearch lookup type"
6830 &(iplsearch)&: The given file is a text file containing keys and data. A key is
6831 terminated by a colon or white space or the end of the line. The keys in the
6832 file must be IP addresses, or IP addresses with CIDR masks. Keys that involve
6833 IPv6 addresses must be enclosed in quotes to prevent the first internal colon
6834 being interpreted as a key terminator. For example:
6835 .code
6836 1.2.3.4:           data for 1.2.3.4
6837 192.168.0.0/16:    data for 192.168.0.0/16
6838 "abcd::cdab":      data for abcd::cdab
6839 "abcd:abcd::/32"   data for abcd:abcd::/32
6840 .endd
6841 The key for an &(iplsearch)& lookup must be an IP address (without a mask). The
6842 file is searched linearly, using the CIDR masks where present, until a matching
6843 key is found. The first key that matches is used; there is no attempt to find a
6844 &"best"& match. Apart from the way the keys are matched, the processing for
6845 &(iplsearch)& is the same as for &(lsearch)&.
6846
6847 &*Warning 1*&: Unlike most other single-key lookup types, a file of data for
6848 &(iplsearch)& can &'not'& be turned into a DBM or cdb file, because those
6849 lookup types support only literal keys.
6850
6851 &*Warning 2*&: In a host list, you must always use &(net-iplsearch)& so that
6852 the implicit key is the host's IP address rather than its name (see section
6853 &<<SECThoslispatsikey>>&).
6854
6855 &*Warning 3*&: Do not use an IPv4-mapped IPv6 address for a key; use the
6856 IPv4, in dotted-quad form. (Exim converts IPv4-mapped IPv6 addresses to this
6857 notation before executing the lookup.)
6858 .next
6859 .cindex lookup json
6860 .cindex json "lookup type"
6861 .cindex JSON expansions
6862 &(json)&: The given file is a text file with a JSON structure.
6863 An element of the structure is extracted, defined by the search key.
6864 The key is a list of subelement selectors
6865 (colon-separated by default but changeable in the usual way)
6866 which are applied in turn to select smaller and smaller portions
6867 of the JSON structure.
6868 If a selector is numeric, it must apply to a JSON array; the (zero-based)
6869 nunbered array element is selected.
6870 Otherwise it must apply to a JSON object; the named element is selected.
6871 The final resulting element can be a simple JSON type or a JSON object
6872 or array; for the latter two a string-representation of the JSON
6873 is returned.
6874 For elements of type string, the returned value is de-quoted.
6875 .next
6876 .cindex "linear search"
6877 .cindex "lookup" "lsearch"
6878 .cindex "lsearch lookup type"
6879 .cindex "case sensitivity" "in lsearch lookup"
6880 &(lsearch)&: The given file is a text file that is searched linearly for a
6881 line beginning with the search key, terminated by a colon or white space or the
6882 end of the line. The search is case-insensitive; that is, upper and lower case
6883 letters are treated as the same. The first occurrence of the key that is found
6884 in the file is used.
6885
6886 White space between the key and the colon is permitted. The remainder of the
6887 line, with leading and trailing white space removed, is the data. This can be
6888 continued onto subsequent lines by starting them with any amount of white
6889 space, but only a single space character is included in the data at such a
6890 junction. If the data begins with a colon, the key must be terminated by a
6891 colon, for example:
6892 .code
6893 baduser:  :fail:
6894 .endd
6895 Empty lines and lines beginning with # are ignored, even if they occur in the
6896 middle of an item. This is the traditional textual format of alias files. Note
6897 that the keys in an &(lsearch)& file are literal strings. There is no
6898 wildcarding of any kind.
6899
6900 .cindex "lookup" "lsearch &-- colons in keys"
6901 .cindex "white space" "in lsearch key"
6902 In most &(lsearch)& files, keys are not required to contain colons or #
6903 characters, or white space. However, if you need this feature, it is available.
6904 If a key begins with a doublequote character, it is terminated only by a
6905 matching quote (or end of line), and the normal escaping rules apply to its
6906 contents (see section &<<SECTstrings>>&). An optional colon is permitted after
6907 quoted keys (exactly as for unquoted keys). There is no special handling of
6908 quotes for the data part of an &(lsearch)& line.
6909
6910 .next
6911 .cindex "NIS lookup type"
6912 .cindex "lookup" "NIS"
6913 .cindex "binary zero" "in lookup key"
6914 &(nis)&: The given file is the name of a NIS map, and a NIS lookup is done with
6915 the given key, without a terminating binary zero. There is a variant called
6916 &(nis0)& which does include the terminating binary zero in the key. This is
6917 reportedly needed for Sun-style alias files. Exim does not recognize NIS
6918 aliases; the full map names must be used.
6919
6920 .next
6921 .cindex "wildlsearch lookup type"
6922 .cindex "lookup" "wildlsearch"
6923 .cindex "nwildlsearch lookup type"
6924 .cindex "lookup" "nwildlsearch"
6925 &(wildlsearch)& or &(nwildlsearch)&: These search a file linearly, like
6926 &(lsearch)&, but instead of being interpreted as a literal string, each key in
6927 the file may be wildcarded. The difference between these two lookup types is
6928 that for &(wildlsearch)&, each key in the file is string-expanded before being
6929 used, whereas for &(nwildlsearch)&, no expansion takes place.
6930
6931 .cindex "case sensitivity" "in (n)wildlsearch lookup"
6932 Like &(lsearch)&, the testing is done case-insensitively. However, keys in the
6933 file that are regular expressions can be made case-sensitive by the use of
6934 &`(-i)`& within the pattern. The following forms of wildcard are recognized:
6935
6936 . ==== As this is a nested list, any displays it contains must be indented
6937 . ==== as otherwise they are too far to the left.
6938
6939 .olist
6940 The string may begin with an asterisk to mean &"ends with"&. For example:
6941 .code
6942     *.a.b.c       data for anything.a.b.c
6943     *fish         data for anythingfish
6944 .endd
6945 .next
6946 The string may begin with a circumflex to indicate a regular expression. For
6947 example, for &(wildlsearch)&:
6948 .code
6949     ^\N\d+\.a\.b\N    data for <digits>.a.b
6950 .endd
6951 Note the use of &`\N`& to disable expansion of the contents of the regular
6952 expression. If you are using &(nwildlsearch)&, where the keys are not
6953 string-expanded, the equivalent entry is:
6954 .code
6955     ^\d+\.a\.b        data for <digits>.a.b
6956 .endd
6957 The case-insensitive flag is set at the start of compiling the regular
6958 expression, but it can be turned off by using &`(-i)`& at an appropriate point.
6959 For example, to make the entire pattern case-sensitive:
6960 .code
6961     ^(?-i)\d+\.a\.b        data for <digits>.a.b
6962 .endd
6963
6964 If the regular expression contains white space or colon characters, you must
6965 either quote it (see &(lsearch)& above), or represent these characters in other
6966 ways. For example, &`\s`& can be used for white space and &`\x3A`& for a
6967 colon. This may be easier than quoting, because if you quote, you have to
6968 escape all the backslashes inside the quotes.
6969
6970 &*Note*&: It is not possible to capture substrings in a regular expression
6971 match for later use, because the results of all lookups are cached. If a lookup
6972 is repeated, the result is taken from the cache, and no actual pattern matching
6973 takes place. The values of all the numeric variables are unset after a
6974 &((n)wildlsearch)& match.
6975
6976 .next
6977 Although I cannot see it being of much use, the general matching function that
6978 is used to implement &((n)wildlsearch)& means that the string may begin with a
6979 lookup name terminated by a semicolon, and followed by lookup data. For
6980 example:
6981 .code
6982     cdb;/some/file  data for keys that match the file
6983 .endd
6984 The data that is obtained from the nested lookup is discarded.
6985 .endlist olist
6986
6987 Keys that do not match any of these patterns are interpreted literally. The
6988 continuation rules for the data are the same as for &(lsearch)&, and keys may
6989 be followed by optional colons.
6990
6991 &*Warning*&: Unlike most other single-key lookup types, a file of data for
6992 &((n)wildlsearch)& can &'not'& be turned into a DBM or cdb file, because those
6993 lookup types support only literal keys.
6994
6995 .next
6996 .cindex "spf lookup type"
6997 .cindex "lookup" "spf"
6998 &(spf)&: If Exim is built with SPF support, manual lookups can be done
6999 (as opposed to the standard ACL condition method).
7000 For details see section &<<SECSPF>>&.
7001 .endlist ilist
7002
7003
7004 .section "Query-style lookup types" "SECTquerystylelookups"
7005 .cindex "lookup" "query-style types"
7006 .cindex "query-style lookup" "list of types"
7007 The supported query-style lookup types are listed below. Further details about
7008 many of them are given in later sections.
7009
7010 .ilist
7011 .cindex "DNS" "as a lookup type"
7012 .cindex "lookup" "DNS"
7013 &(dnsdb)&: This does a DNS search for one or more records whose domain names
7014 are given in the supplied query. The resulting data is the contents of the
7015 records. See section &<<SECTdnsdb>>&.
7016 .next
7017 .cindex "InterBase lookup type"
7018 .cindex "lookup" "InterBase"
7019 &(ibase)&: This does a lookup in an InterBase database.
7020 .next
7021 .cindex "LDAP" "lookup type"
7022 .cindex "lookup" "LDAP"
7023 &(ldap)&: This does an LDAP lookup using a query in the form of a URL, and
7024 returns attributes from a single entry. There is a variant called &(ldapm)&
7025 that permits values from multiple entries to be returned. A third variant
7026 called &(ldapdn)& returns the Distinguished Name of a single entry instead of
7027 any attribute values. See section &<<SECTldap>>&.
7028 .next
7029 .cindex "MySQL" "lookup type"
7030 .cindex "lookup" "MySQL"
7031 &(mysql)&: The format of the query is an SQL statement that is passed to a
7032 MySQL database. See section &<<SECTsql>>&.
7033 .next
7034 .cindex "NIS+ lookup type"
7035 .cindex "lookup" "NIS+"
7036 &(nisplus)&: This does a NIS+ lookup using a query that can specify the name of
7037 the field to be returned. See section &<<SECTnisplus>>&.
7038 .next
7039 .cindex "Oracle" "lookup type"
7040 .cindex "lookup" "Oracle"
7041 &(oracle)&: The format of the query is an SQL statement that is passed to an
7042 Oracle database. See section &<<SECTsql>>&.
7043 .next
7044 .cindex "lookup" "passwd"
7045 .cindex "passwd lookup type"
7046 .cindex "&_/etc/passwd_&"
7047 &(passwd)& is a query-style lookup with queries that are just user names. The
7048 lookup calls &[getpwnam()]& to interrogate the system password data, and on
7049 success, the result string is the same as you would get from an &(lsearch)&
7050 lookup on a traditional &_/etc/passwd file_&, though with &`*`& for the
7051 password value. For example:
7052 .code
7053 *:42:42:King Rat:/home/kr:/bin/bash
7054 .endd
7055 .next
7056 .cindex "PostgreSQL lookup type"
7057 .cindex "lookup" "PostgreSQL"
7058 &(pgsql)&: The format of the query is an SQL statement that is passed to a
7059 PostgreSQL database. See section &<<SECTsql>>&.
7060
7061 .next
7062 .cindex "Redis lookup type"
7063 .cindex lookup Redis
7064 &(redis)&: The format of the query is either a simple get or simple set,
7065 passed to a Redis database. See section &<<SECTsql>>&.
7066
7067 .next
7068 .cindex "sqlite lookup type"
7069 .cindex "lookup" "sqlite"
7070 &(sqlite)&: The format of the query is
7071 new
7072 an optional filename
7073 .wen
7074 followed by an SQL statement
7075 that is passed to an SQLite database. See section &<<SECTsqlite>>&.
7076
7077 .next
7078 &(testdb)&: This is a lookup type that is used for testing Exim. It is
7079 not likely to be useful in normal operation.
7080 .next
7081 .cindex "whoson lookup type"
7082 .cindex "lookup" "whoson"
7083 . --- still http:-only, 2018-09-07
7084 &(whoson)&: &'Whoson'& (&url(http://whoson.sourceforge.net)) is a protocol that
7085 allows a server to check whether a particular (dynamically allocated) IP
7086 address is currently allocated to a known (trusted) user and, optionally, to
7087 obtain the identity of the said user. For SMTP servers, &'Whoson'& was popular
7088 at one time for &"POP before SMTP"& authentication, but that approach has been
7089 superseded by SMTP authentication. In Exim, &'Whoson'& can be used to implement
7090 &"POP before SMTP"& checking using ACL statements such as
7091 .code
7092 require condition = \
7093   ${lookup whoson {$sender_host_address}{yes}{no}}
7094 .endd
7095 The query consists of a single IP address. The value returned is the name of
7096 the authenticated user, which is stored in the variable &$value$&. However, in
7097 this example, the data in &$value$& is not used; the result of the lookup is
7098 one of the fixed strings &"yes"& or &"no"&.
7099 .endlist
7100
7101
7102
7103 .section "Temporary errors in lookups" "SECID63"
7104 .cindex "lookup" "temporary error in"
7105 Lookup functions can return temporary error codes if the lookup cannot be
7106 completed. For example, an SQL or LDAP database might be unavailable. For this
7107 reason, it is not advisable to use a lookup that might do this for critical
7108 options such as a list of local domains.
7109
7110 When a lookup cannot be completed in a router or transport, delivery
7111 of the message (to the relevant address) is deferred, as for any other
7112 temporary error. In other circumstances Exim may assume the lookup has failed,
7113 or may give up altogether.
7114
7115
7116
7117 .section "Default values in single-key lookups" "SECTdefaultvaluelookups"
7118 .cindex "wildcard lookups"
7119 .cindex "lookup" "default values"
7120 .cindex "lookup" "wildcard"
7121 .cindex "lookup" "* added to type"
7122 .cindex "default" "in single-key lookups"
7123 In this context, a &"default value"& is a value specified by the administrator
7124 that is to be used if a lookup fails.
7125
7126 &*Note:*& This section applies only to single-key lookups. For query-style
7127 lookups, the facilities of the query language must be used. An attempt to
7128 specify a default for a query-style lookup provokes an error.
7129
7130 If &"*"& is added to a single-key lookup type (for example, &%lsearch*%&)
7131 and the initial lookup fails, the key &"*"& is looked up in the file to
7132 provide a default value. See also the section on partial matching below.
7133
7134 .cindex "*@ with single-key lookup"
7135 .cindex "lookup" "*@ added to type"
7136 .cindex "alias file" "per-domain default"
7137 Alternatively, if &"*@"& is added to a single-key lookup type (for example
7138 &%dbm*@%&) then, if the initial lookup fails and the key contains an @
7139 character, a second lookup is done with everything before the last @ replaced
7140 by *. This makes it possible to provide per-domain defaults in alias files
7141 that include the domains in the keys. If the second lookup fails (or doesn't
7142 take place because there is no @ in the key), &"*"& is looked up.
7143 For example, a &(redirect)& router might contain:
7144 .code
7145 data = ${lookup{$local_part@$domain}lsearch*@{/etc/mix-aliases}}
7146 .endd
7147 Suppose the address that is being processed is &'jane@eyre.example'&. Exim
7148 looks up these keys, in this order:
7149 .code
7150 jane@eyre.example
7151 *@eyre.example
7152 *
7153 .endd
7154 The data is taken from whichever key it finds first. &*Note*&: In an
7155 &(lsearch)& file, this does not mean the first of these keys in the file. A
7156 complete scan is done for each key, and only if it is not found at all does
7157 Exim move on to try the next key.
7158
7159
7160
7161 .section "Partial matching in single-key lookups" "SECTpartiallookup"
7162 .cindex "partial matching"
7163 .cindex "wildcard lookups"
7164 .cindex "lookup" "partial matching"
7165 .cindex "lookup" "wildcard"
7166 .cindex "asterisk" "in search type"
7167 The normal operation of a single-key lookup is to search the file for an exact
7168 match with the given key. However, in a number of situations where domains are
7169 being looked up, it is useful to be able to do partial matching. In this case,
7170 information in the file that has a key starting with &"*."& is matched by any
7171 domain that ends with the components that follow the full stop. For example, if
7172 a key in a DBM file is
7173 .code
7174 *.dates.fict.example
7175 .endd
7176 then when partial matching is enabled this is matched by (amongst others)
7177 &'2001.dates.fict.example'& and &'1984.dates.fict.example'&. It is also matched
7178 by &'dates.fict.example'&, if that does not appear as a separate key in the
7179 file.
7180
7181 &*Note*&: Partial matching is not available for query-style lookups. It is
7182 also not available for any lookup items in address lists (see section
7183 &<<SECTaddresslist>>&).
7184
7185 Partial matching is implemented by doing a series of separate lookups using
7186 keys constructed by modifying the original subject key. This means that it can
7187 be used with any of the single-key lookup types, provided that
7188 partial matching keys
7189 beginning with a special prefix (default &"*."&) are included in the data file.
7190 Keys in the file that do not begin with the prefix are matched only by
7191 unmodified subject keys when partial matching is in use.
7192
7193 Partial matching is requested by adding the string &"partial-"& to the front of
7194 the name of a single-key lookup type, for example, &%partial-dbm%&. When this
7195 is done, the subject key is first looked up unmodified; if that fails, &"*."&
7196 is added at the start of the subject key, and it is looked up again. If that
7197 fails, further lookups are tried with dot-separated components removed from the
7198 start of the subject key, one-by-one, and &"*."& added on the front of what
7199 remains.
7200
7201 A minimum number of two non-* components are required. This can be adjusted
7202 by including a number before the hyphen in the search type. For example,
7203 &%partial3-lsearch%& specifies a minimum of three non-* components in the
7204 modified keys. Omitting the number is equivalent to &"partial2-"&. If the
7205 subject key is &'2250.dates.fict.example'& then the following keys are looked
7206 up when the minimum number of non-* components is two:
7207 .code
7208 2250.dates.fict.example
7209 *.2250.dates.fict.example
7210 *.dates.fict.example
7211 *.fict.example
7212 .endd
7213 As soon as one key in the sequence is successfully looked up, the lookup
7214 finishes.
7215
7216 .cindex "lookup" "partial matching &-- changing prefix"
7217 .cindex "prefix" "for partial matching"
7218 The use of &"*."& as the partial matching prefix is a default that can be
7219 changed. The motivation for this feature is to allow Exim to operate with file
7220 formats that are used by other MTAs. A different prefix can be supplied in
7221 parentheses instead of the hyphen after &"partial"&. For example:
7222 .code
7223 domains = partial(.)lsearch;/some/file
7224 .endd
7225 In this example, if the domain is &'a.b.c'&, the sequence of lookups is
7226 &`a.b.c`&, &`.a.b.c`&, and &`.b.c`& (the default minimum of 2 non-wild
7227 components is unchanged). The prefix may consist of any punctuation characters
7228 other than a closing parenthesis. It may be empty, for example:
7229 .code
7230 domains = partial1()cdb;/some/file
7231 .endd
7232 For this example, if the domain is &'a.b.c'&, the sequence of lookups is
7233 &`a.b.c`&, &`b.c`&, and &`c`&.
7234
7235 If &"partial0"& is specified, what happens at the end (when the lookup with
7236 just one non-wild component has failed, and the original key is shortened right
7237 down to the null string) depends on the prefix:
7238
7239 .ilist
7240 If the prefix has zero length, the whole lookup fails.
7241 .next
7242 If the prefix has length 1, a lookup for just the prefix is done. For
7243 example, the final lookup for &"partial0(.)"& is for &`.`& alone.
7244 .next
7245 Otherwise, if the prefix ends in a dot, the dot is removed, and the
7246 remainder is looked up. With the default prefix, therefore, the final lookup is
7247 for &"*"& on its own.
7248 .next
7249 Otherwise, the whole prefix is looked up.
7250 .endlist
7251
7252
7253 If the search type ends in &"*"& or &"*@"& (see section
7254 &<<SECTdefaultvaluelookups>>& above), the search for an ultimate default that
7255 this implies happens after all partial lookups have failed. If &"partial0"& is
7256 specified, adding &"*"& to the search type has no effect with the default
7257 prefix, because the &"*"& key is already included in the sequence of partial
7258 lookups. However, there might be a use for lookup types such as
7259 &"partial0(.)lsearch*"&.
7260
7261 The use of &"*"& in lookup partial matching differs from its use as a wildcard
7262 in domain lists and the like. Partial matching works only in terms of
7263 dot-separated components; a key such as &`*fict.example`&
7264 in a database file is useless, because the asterisk in a partial matching
7265 subject key is always followed by a dot.
7266
7267
7268
7269
7270 .section "Lookup caching" "SECID64"
7271 .cindex "lookup" "caching"
7272 .cindex "caching" "lookup data"
7273 Exim caches all lookup results in order to avoid needless repetition of
7274 lookups. However, because (apart from the daemon) Exim operates as a collection
7275 of independent, short-lived processes, this caching applies only within a
7276 single Exim process. There is no inter-process lookup caching facility.
7277
7278 For single-key lookups, Exim keeps the relevant files open in case there is
7279 another lookup that needs them. In some types of configuration this can lead to
7280 many files being kept open for messages with many recipients. To avoid hitting
7281 the operating system limit on the number of simultaneously open files, Exim
7282 closes the least recently used file when it needs to open more files than its
7283 own internal limit, which can be changed via the &%lookup_open_max%& option.
7284
7285 The single-key lookup files are closed and the lookup caches are flushed at
7286 strategic points during delivery &-- for example, after all routing is
7287 complete.
7288
7289
7290
7291
7292 .section "Quoting lookup data" "SECID65"
7293 .cindex "lookup" "quoting"
7294 .cindex "quoting" "in lookups"
7295 When data from an incoming message is included in a query-style lookup, there
7296 is the possibility of special characters in the data messing up the syntax of
7297 the query. For example, a NIS+ query that contains
7298 .code
7299 [name=$local_part]
7300 .endd
7301 will be broken if the local part happens to contain a closing square bracket.
7302 For NIS+, data can be enclosed in double quotes like this:
7303 .code
7304 [name="$local_part"]
7305 .endd
7306 but this still leaves the problem of a double quote in the data. The rule for
7307 NIS+ is that double quotes must be doubled. Other lookup types have different
7308 rules, and to cope with the differing requirements, an expansion operator
7309 of the following form is provided:
7310 .code
7311 ${quote_<lookup-type>:<string>}
7312 .endd
7313 For example, the safest way to write the NIS+ query is
7314 .code
7315 [name="${quote_nisplus:$local_part}"]
7316 .endd
7317 See chapter &<<CHAPexpand>>& for full coverage of string expansions. The quote
7318 operator can be used for all lookup types, but has no effect for single-key
7319 lookups, since no quoting is ever needed in their key strings.
7320
7321
7322
7323
7324 .section "More about dnsdb" "SECTdnsdb"
7325 .cindex "dnsdb lookup"
7326 .cindex "lookup" "dnsdb"
7327 .cindex "DNS" "as a lookup type"
7328 The &(dnsdb)& lookup type uses the DNS as its database. A simple query consists
7329 of a record type and a domain name, separated by an equals sign. For example,
7330 an expansion string could contain:
7331 .code
7332 ${lookup dnsdb{mx=a.b.example}{$value}fail}
7333 .endd
7334 If the lookup succeeds, the result is placed in &$value$&, which in this case
7335 is used on its own as the result. If the lookup does not succeed, the
7336 &`fail`& keyword causes a &'forced expansion failure'& &-- see section
7337 &<<SECTforexpfai>>& for an explanation of what this means.
7338
7339 The supported DNS record types are A, CNAME, MX, NS, PTR, SOA, SPF, SRV, TLSA
7340 and TXT, and, when Exim is compiled with IPv6 support, AAAA.
7341 If no type is given, TXT is assumed.
7342
7343 For any record type, if multiple records are found, the data is returned as a
7344 concatenation, with newline as the default separator. The order, of course,
7345 depends on the DNS resolver. You can specify a different separator character
7346 between multiple records by putting a right angle-bracket followed immediately
7347 by the new separator at the start of the query. For example:
7348 .code
7349 ${lookup dnsdb{>: a=host1.example}}
7350 .endd
7351 It is permitted to specify a space as the separator character. Further
7352 white space is ignored.
7353 For lookup types that return multiple fields per record,
7354 an alternate field separator can be specified using a comma after the main
7355 separator character, followed immediately by the field separator.
7356
7357 .cindex "PTR record" "in &(dnsdb)& lookup"
7358 When the type is PTR,
7359 the data can be an IP address, written as normal; inversion and the addition of
7360 &%in-addr.arpa%& or &%ip6.arpa%& happens automatically. For example:
7361 .code
7362 ${lookup dnsdb{ptr=192.168.4.5}{$value}fail}
7363 .endd
7364 If the data for a PTR record is not a syntactically valid IP address, it is not
7365 altered and nothing is added.
7366
7367 .cindex "MX record" "in &(dnsdb)& lookup"
7368 .cindex "SRV record" "in &(dnsdb)& lookup"
7369 For an MX lookup, both the preference value and the host name are returned for
7370 each record, separated by a space. For an SRV lookup, the priority, weight,
7371 port, and host name are returned for each record, separated by spaces.
7372 The field separator can be modified as above.
7373
7374 .cindex "TXT record" "in &(dnsdb)& lookup"
7375 .cindex "SPF record" "in &(dnsdb)& lookup"
7376 For TXT records with multiple items of data, only the first item is returned,
7377 unless a field separator is specified.
7378 To concatenate items without a separator, use a semicolon instead.
7379 For SPF records the
7380 default behaviour is to concatenate multiple items without using a separator.
7381 .code
7382 ${lookup dnsdb{>\n,: txt=a.b.example}}
7383 ${lookup dnsdb{>\n; txt=a.b.example}}
7384 ${lookup dnsdb{spf=example.org}}
7385 .endd
7386 It is permitted to specify a space as the separator character. Further
7387 white space is ignored.
7388
7389 .cindex "SOA record" "in &(dnsdb)& lookup"
7390 For an SOA lookup, while no result is obtained the lookup is redone with
7391 successively more leading components dropped from the given domain.
7392 Only the primary-nameserver field is returned unless a field separator is
7393 specified.
7394 .code
7395 ${lookup dnsdb{>:,; soa=a.b.example.com}}
7396 .endd
7397
7398 .section "Dnsdb lookup modifiers" "SECTdnsdb_mod"
7399 .cindex "dnsdb modifiers"
7400 .cindex "modifiers" "dnsdb"
7401 .cindex "options" "dnsdb"
7402 Modifiers for &(dnsdb)& lookups are given by optional keywords,
7403 each followed by a comma,
7404 that may appear before the record type.
7405
7406 The &(dnsdb)& lookup fails only if all the DNS lookups fail. If there is a
7407 temporary DNS error for any of them, the behaviour is controlled by
7408 a defer-option modifier.
7409 The possible keywords are
7410 &"defer_strict"&, &"defer_never"&, and &"defer_lax"&.
7411 With &"strict"& behaviour, any temporary DNS error causes the
7412 whole lookup to defer. With &"never"& behaviour, a temporary DNS error is
7413 ignored, and the behaviour is as if the DNS lookup failed to find anything.
7414 With &"lax"& behaviour, all the queries are attempted, but a temporary DNS
7415 error causes the whole lookup to defer only if none of the other lookups
7416 succeed. The default is &"lax"&, so the following lookups are equivalent:
7417 .code
7418 ${lookup dnsdb{defer_lax,a=one.host.com:two.host.com}}
7419 ${lookup dnsdb{a=one.host.com:two.host.com}}
7420 .endd
7421 Thus, in the default case, as long as at least one of the DNS lookups
7422 yields some data, the lookup succeeds.
7423
7424 .cindex "DNSSEC" "dns lookup"
7425 Use of &(DNSSEC)& is controlled by a dnssec modifier.
7426 The possible keywords are
7427 &"dnssec_strict"&, &"dnssec_lax"&, and &"dnssec_never"&.
7428 With &"strict"& or &"lax"& DNSSEC information is requested
7429 with the lookup.
7430 With &"strict"& a response from the DNS resolver that
7431 is not labelled as authenticated data
7432 is treated as equivalent to a temporary DNS error.
7433 The default is &"lax"&.
7434
7435 See also the &$lookup_dnssec_authenticated$& variable.
7436
7437 .cindex timeout "dns lookup"
7438 .cindex "DNS" timeout
7439 Timeout for the dnsdb lookup can be controlled by a retrans modifier.
7440 The form is &"retrans_VAL"& where VAL is an Exim time specification
7441 (e.g. &"5s"&).
7442 The default value is set by the main configuration option &%dns_retrans%&.
7443
7444 Retries for the dnsdb lookup can be controlled by a retry modifier.
7445 The form if &"retry_VAL"& where VAL is an integer.
7446 The default count is set by the main configuration option &%dns_retry%&.
7447
7448 .cindex caching "of dns lookup"
7449 .cindex TTL "of dns lookup"
7450 .cindex DNS TTL
7451 Dnsdb lookup results are cached within a single process (and its children).
7452 The cache entry lifetime is limited to the smallest time-to-live (TTL)
7453 value of the set of returned DNS records.
7454
7455
7456 .section "Pseudo dnsdb record types" "SECID66"
7457 .cindex "MX record" "in &(dnsdb)& lookup"
7458 By default, both the preference value and the host name are returned for
7459 each MX record, separated by a space. If you want only host names, you can use
7460 the pseudo-type MXH:
7461 .code
7462 ${lookup dnsdb{mxh=a.b.example}}
7463 .endd
7464 In this case, the preference values are omitted, and just the host names are
7465 returned.
7466
7467 .cindex "name server for enclosing domain"
7468 Another pseudo-type is ZNS (for &"zone NS"&). It performs a lookup for NS
7469 records on the given domain, but if none are found, it removes the first
7470 component of the domain name, and tries again. This process continues until NS
7471 records are found or there are no more components left (or there is a DNS
7472 error). In other words, it may return the name servers for a top-level domain,
7473 but it never returns the root name servers. If there are no NS records for the
7474 top-level domain, the lookup fails. Consider these examples:
7475 .code
7476 ${lookup dnsdb{zns=xxx.quercite.com}}
7477 ${lookup dnsdb{zns=xxx.edu}}
7478 .endd
7479 Assuming that in each case there are no NS records for the full domain name,
7480 the first returns the name servers for &%quercite.com%&, and the second returns
7481 the name servers for &%edu%&.
7482
7483 You should be careful about how you use this lookup because, unless the
7484 top-level domain does not exist, the lookup always returns some host names. The
7485 sort of use to which this might be put is for seeing if the name servers for a
7486 given domain are on a blacklist. You can probably assume that the name servers
7487 for the high-level domains such as &%com%& or &%co.uk%& are not going to be on
7488 such a list.
7489
7490 .cindex "CSA" "in &(dnsdb)& lookup"
7491 A third pseudo-type is CSA (Client SMTP Authorization). This looks up SRV
7492 records according to the CSA rules, which are described in section
7493 &<<SECTverifyCSA>>&. Although &(dnsdb)& supports SRV lookups directly, this is
7494 not sufficient because of the extra parent domain search behaviour of CSA. The
7495 result of a successful lookup such as:
7496 .code
7497 ${lookup dnsdb {csa=$sender_helo_name}}
7498 .endd
7499 has two space-separated fields: an authorization code and a target host name.
7500 The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
7501 authorization required but absent, or &"?"& for unknown.
7502
7503 .cindex "A+" "in &(dnsdb)& lookup"
7504 The pseudo-type A+ performs an AAAA
7505 and then an A lookup.  All results are returned; defer processing
7506 (see below) is handled separately for each lookup.  Example:
7507 .code
7508 ${lookup dnsdb {>; a+=$sender_helo_name}}
7509 .endd
7510
7511
7512 .section "Multiple dnsdb lookups" "SECID67"
7513 In the previous sections, &(dnsdb)& lookups for a single domain are described.
7514 However, you can specify a list of domains or IP addresses in a single
7515 &(dnsdb)& lookup. The list is specified in the normal Exim way, with colon as
7516 the default separator, but with the ability to change this. For example:
7517 .code
7518 ${lookup dnsdb{one.domain.com:two.domain.com}}
7519 ${lookup dnsdb{a=one.host.com:two.host.com}}
7520 ${lookup dnsdb{ptr = <; 1.2.3.4 ; 4.5.6.8}}
7521 .endd
7522 In order to retain backwards compatibility, there is one special case: if
7523 the lookup type is PTR and no change of separator is specified, Exim looks
7524 to see if the rest of the string is precisely one IPv6 address. In this
7525 case, it does not treat it as a list.
7526
7527 The data from each lookup is concatenated, with newline separators by default,
7528 in the same way that multiple DNS records for a single item are handled. A
7529 different separator can be specified, as described above.
7530
7531
7532
7533
7534 .section "More about LDAP" "SECTldap"
7535 .cindex "LDAP" "lookup, more about"
7536 .cindex "lookup" "LDAP"
7537 .cindex "Solaris" "LDAP"
7538 The original LDAP implementation came from the University of Michigan; this has
7539 become &"Open LDAP"&, and there are now two different releases. Another
7540 implementation comes from Netscape, and Solaris 7 and subsequent releases
7541 contain inbuilt LDAP support. Unfortunately, though these are all compatible at
7542 the lookup function level, their error handling is different. For this reason
7543 it is necessary to set a compile-time variable when building Exim with LDAP, to
7544 indicate which LDAP library is in use. One of the following should appear in
7545 your &_Local/Makefile_&:
7546 .code
7547 LDAP_LIB_TYPE=UMICHIGAN
7548 LDAP_LIB_TYPE=OPENLDAP1
7549 LDAP_LIB_TYPE=OPENLDAP2
7550 LDAP_LIB_TYPE=NETSCAPE
7551 LDAP_LIB_TYPE=SOLARIS
7552 .endd
7553 If LDAP_LIB_TYPE is not set, Exim assumes &`OPENLDAP1`&, which has the
7554 same interface as the University of Michigan version.
7555
7556 There are three LDAP lookup types in Exim. These behave slightly differently in
7557 the way they handle the results of a query:
7558
7559 .ilist
7560 &(ldap)& requires the result to contain just one entry; if there are more, it
7561 gives an error.
7562 .next
7563 &(ldapdn)& also requires the result to contain just one entry, but it is the
7564 Distinguished Name that is returned rather than any attribute values.
7565 .next
7566 &(ldapm)& permits the result to contain more than one entry; the attributes
7567 from all of them are returned.
7568 .endlist
7569
7570
7571 For &(ldap)& and &(ldapm)&, if a query finds only entries with no attributes,
7572 Exim behaves as if the entry did not exist, and the lookup fails. The format of
7573 the data returned by a successful lookup is described in the next section.
7574 First we explain how LDAP queries are coded.
7575
7576
7577 .section "Format of LDAP queries" "SECTforldaque"
7578 .cindex "LDAP" "query format"
7579 An LDAP query takes the form of a URL as defined in RFC 2255. For example, in
7580 the configuration of a &(redirect)& router one might have this setting:
7581 .code
7582 data = ${lookup ldap \
7583   {ldap:///cn=$local_part,o=University%20of%20Cambridge,\
7584   c=UK?mailbox?base?}}
7585 .endd
7586 .cindex "LDAP" "with TLS"
7587 The URL may begin with &`ldap`& or &`ldaps`& if your LDAP library supports
7588 secure (encrypted) LDAP connections. The second of these ensures that an
7589 encrypted TLS connection is used.
7590
7591 With sufficiently modern LDAP libraries, Exim supports forcing TLS over regular
7592 LDAP connections, rather than the SSL-on-connect &`ldaps`&.
7593 See the &%ldap_start_tls%& option.
7594
7595 Starting with Exim 4.83, the initialization of LDAP with TLS is more tightly
7596 controlled. Every part of the TLS configuration can be configured by settings in
7597 &_exim.conf_&. Depending on the version of the client libraries installed on
7598 your system, some of the initialization may have required setting options in
7599 &_/etc/ldap.conf_& or &_~/.ldaprc_& to get TLS working with self-signed
7600 certificates. This revealed a nuance where the current UID that exim was
7601 running as could affect which config files it read. With Exim 4.83, these
7602 methods become optional, only taking effect if not specifically set in
7603 &_exim.conf_&.
7604
7605
7606 .section "LDAP quoting" "SECID68"
7607 .cindex "LDAP" "quoting"
7608 Two levels of quoting are required in LDAP queries, the first for LDAP itself
7609 and the second because the LDAP query is represented as a URL. Furthermore,
7610 within an LDAP query, two different kinds of quoting are required. For this
7611 reason, there are two different LDAP-specific quoting operators.
7612
7613 The &%quote_ldap%& operator is designed for use on strings that are part of
7614 filter specifications. Conceptually, it first does the following conversions on
7615 the string:
7616 .code
7617 *   =>   \2A
7618 (   =>   \28
7619 )   =>   \29
7620 \   =>   \5C
7621 .endd
7622 in accordance with RFC 2254. The resulting string is then quoted according
7623 to the rules for URLs, that is, all non-alphanumeric characters except
7624 .code
7625 ! $ ' - . _ ( ) * +
7626 .endd
7627 are converted to their hex values, preceded by a percent sign. For example:
7628 .code
7629 ${quote_ldap: a(bc)*, a<yz>; }
7630 .endd
7631 yields
7632 .code
7633 %20a%5C28bc%5C29%5C2A%2C%20a%3Cyz%3E%3B%20
7634 .endd
7635 Removing the URL quoting, this is (with a leading and a trailing space):
7636 .code
7637 a\28bc\29\2A, a<yz>;
7638 .endd
7639 The &%quote_ldap_dn%& operator is designed for use on strings that are part of
7640 base DN specifications in queries. Conceptually, it first converts the string
7641 by inserting a backslash in front of any of the following characters:
7642 .code
7643 , + " \ < > ;
7644 .endd
7645 It also inserts a backslash before any leading spaces or # characters, and
7646 before any trailing spaces. (These rules are in RFC 2253.) The resulting string
7647 is then quoted according to the rules for URLs. For example:
7648 .code
7649 ${quote_ldap_dn: a(bc)*, a<yz>; }
7650 .endd
7651 yields
7652 .code
7653 %5C%20a(bc)*%5C%2C%20a%5C%3Cyz%5C%3E%5C%3B%5C%20
7654 .endd
7655 Removing the URL quoting, this is (with a trailing space):
7656 .code
7657 \ a(bc)*\, a\<yz\>\;\
7658 .endd
7659 There are some further comments about quoting in the section on LDAP
7660 authentication below.
7661
7662
7663 .section "LDAP connections" "SECID69"
7664 .cindex "LDAP" "connections"
7665 The connection to an LDAP server may either be over TCP/IP, or, when OpenLDAP
7666 is in use, via a Unix domain socket. The example given above does not specify
7667 an LDAP server. A server that is reached by TCP/IP can be specified in a query
7668 by starting it with
7669 .code
7670 ldap://<hostname>:<port>/...
7671 .endd
7672 If the port (and preceding colon) are omitted, the standard LDAP port (389) is
7673 used. When no server is specified in a query, a list of default servers is
7674 taken from the &%ldap_default_servers%& configuration option. This supplies a
7675 colon-separated list of servers which are tried in turn until one successfully
7676 handles a query, or there is a serious error. Successful handling either
7677 returns the requested data, or indicates that it does not exist. Serious errors
7678 are syntactical, or multiple values when only a single value is expected.
7679 Errors which cause the next server to be tried are connection failures, bind
7680 failures, and timeouts.
7681
7682 For each server name in the list, a port number can be given. The standard way
7683 of specifying a host and port is to use a colon separator (RFC 1738). Because
7684 &%ldap_default_servers%& is a colon-separated list, such colons have to be
7685 doubled. For example
7686 .code
7687 ldap_default_servers = ldap1.example.com::145:ldap2.example.com
7688 .endd
7689 If &%ldap_default_servers%& is unset, a URL with no server name is passed
7690 to the LDAP library with no server name, and the library's default (normally
7691 the local host) is used.
7692
7693 If you are using the OpenLDAP library, you can connect to an LDAP server using
7694 a Unix domain socket instead of a TCP/IP connection. This is specified by using
7695 &`ldapi`& instead of &`ldap`& in LDAP queries. What follows here applies only
7696 to OpenLDAP. If Exim is compiled with a different LDAP library, this feature is
7697 not available.
7698
7699 For this type of connection, instead of a host name for the server, a pathname
7700 for the socket is required, and the port number is not relevant. The pathname
7701 can be specified either as an item in &%ldap_default_servers%&, or inline in
7702 the query. In the former case, you can have settings such as
7703 .code
7704 ldap_default_servers = /tmp/ldap.sock : backup.ldap.your.domain
7705 .endd
7706 When the pathname is given in the query, you have to escape the slashes as
7707 &`%2F`& to fit in with the LDAP URL syntax. For example:
7708 .code
7709 ${lookup ldap {ldapi://%2Ftmp%2Fldap.sock/o=...
7710 .endd
7711 When Exim processes an LDAP lookup and finds that the &"hostname"& is really
7712 a pathname, it uses the Unix domain socket code, even if the query actually
7713 specifies &`ldap`& or &`ldaps`&. In particular, no encryption is used for a
7714 socket connection. This behaviour means that you can use a setting of
7715 &%ldap_default_servers%& such as in the example above with traditional &`ldap`&
7716 or &`ldaps`& queries, and it will work. First, Exim tries a connection via
7717 the Unix domain socket; if that fails, it tries a TCP/IP connection to the
7718 backup host.
7719
7720 If an explicit &`ldapi`& type is given in a query when a host name is
7721 specified, an error is diagnosed. However, if there are more items in
7722 &%ldap_default_servers%&, they are tried. In other words:
7723
7724 .ilist
7725 Using a pathname with &`ldap`& or &`ldaps`& forces the use of the Unix domain
7726 interface.
7727 .next
7728 Using &`ldapi`& with a host name causes an error.
7729 .endlist
7730
7731
7732 Using &`ldapi`& with no host or path in the query, and no setting of
7733 &%ldap_default_servers%&, does whatever the library does by default.
7734
7735
7736
7737 .section "LDAP authentication and control information" "SECID70"
7738 .cindex "LDAP" "authentication"
7739 The LDAP URL syntax provides no way of passing authentication and other control
7740 information to the server. To make this possible, the URL in an LDAP query may
7741 be preceded by any number of <&'name'&>=<&'value'&> settings, separated by
7742 spaces. If a value contains spaces it must be enclosed in double quotes, and
7743 when double quotes are used, backslash is interpreted in the usual way inside
7744 them. The following names are recognized:
7745 .display
7746 &`DEREFERENCE`&  set the dereferencing parameter
7747 &`NETTIME    `&  set a timeout for a network operation
7748 &`USER       `&  set the DN, for authenticating the LDAP bind
7749 &`PASS       `&  set the password, likewise
7750 &`REFERRALS  `&  set the referrals parameter
7751 &`SERVERS    `&  set alternate server list for this query only
7752 &`SIZE       `&  set the limit for the number of entries returned
7753 &`TIME       `&  set the maximum waiting time for a query
7754 .endd
7755 The value of the DEREFERENCE parameter must be one of the words &"never"&,
7756 &"searching"&, &"finding"&, or &"always"&. The value of the REFERRALS parameter
7757 must be &"follow"& (the default) or &"nofollow"&. The latter stops the LDAP
7758 library from trying to follow referrals issued by the LDAP server.
7759
7760 .cindex LDAP timeout
7761 .cindex timeout "LDAP lookup"
7762 The name CONNECT is an obsolete name for NETTIME, retained for
7763 backwards compatibility. This timeout (specified as a number of seconds) is
7764 enforced from the client end for operations that can be carried out over a
7765 network. Specifically, it applies to network connections and calls to the
7766 &'ldap_result()'& function. If the value is greater than zero, it is used if
7767 LDAP_OPT_NETWORK_TIMEOUT is defined in the LDAP headers (OpenLDAP), or
7768 if LDAP_X_OPT_CONNECT_TIMEOUT is defined in the LDAP headers (Netscape
7769 SDK 4.1). A value of zero forces an explicit setting of &"no timeout"& for
7770 Netscape SDK; for OpenLDAP no action is taken.
7771
7772 The TIME parameter (also a number of seconds) is passed to the server to
7773 set a server-side limit on the time taken to complete a search.
7774
7775 The SERVERS parameter allows you to specify an alternate list of ldap servers
7776 to use for an individual lookup.  The global &%ldap_default_servers%& option provides a
7777 default list of ldap servers, and a single lookup can specify a single ldap
7778 server to use.  But when you need to do a lookup with a list of servers that is
7779 different than the default list (maybe different order, maybe a completely
7780 different set of servers), the SERVERS parameter allows you to specify this
7781 alternate list (colon-separated).
7782
7783 Here is an example of an LDAP query in an Exim lookup that uses some of these
7784 values. This is a single line, folded to fit on the page:
7785 .code
7786 ${lookup ldap
7787   {user="cn=manager,o=University of Cambridge,c=UK" pass=secret
7788   ldap:///o=University%20of%20Cambridge,c=UK?sn?sub?(cn=foo)}
7789   {$value}fail}
7790 .endd
7791 The encoding of spaces as &`%20`& is a URL thing which should not be done for
7792 any of the auxiliary data. Exim configuration settings that include lookups
7793 which contain password information should be preceded by &"hide"& to prevent
7794 non-admin users from using the &%-bP%& option to see their values.
7795
7796 The auxiliary data items may be given in any order. The default is no
7797 connection timeout (the system timeout is used), no user or password, no limit
7798 on the number of entries returned, and no time limit on queries.
7799
7800 When a DN is quoted in the USER= setting for LDAP authentication, Exim
7801 removes any URL quoting that it may contain before passing it LDAP. Apparently
7802 some libraries do this for themselves, but some do not. Removing the URL
7803 quoting has two advantages:
7804
7805 .ilist
7806 It makes it possible to use the same &%quote_ldap_dn%& expansion for USER=
7807 DNs as with DNs inside actual queries.
7808 .next
7809 It permits spaces inside USER= DNs.
7810 .endlist
7811
7812 For example, a setting such as
7813 .code
7814 USER=cn=${quote_ldap_dn:$1}
7815 .endd
7816 should work even if &$1$& contains spaces.
7817
7818 Expanded data for the PASS= value should be quoted using the &%quote%&
7819 expansion operator, rather than the LDAP quote operators. The only reason this
7820 field needs quoting is to ensure that it conforms to the Exim syntax, which
7821 does not allow unquoted spaces. For example:
7822 .code
7823 PASS=${quote:$3}
7824 .endd
7825 The LDAP authentication mechanism can be used to check passwords as part of
7826 SMTP authentication. See the &%ldapauth%& expansion string condition in chapter
7827 &<<CHAPexpand>>&.
7828
7829
7830
7831 .section "Format of data returned by LDAP" "SECID71"
7832 .cindex "LDAP" "returned data formats"
7833 The &(ldapdn)& lookup type returns the Distinguished Name from a single entry
7834 as a sequence of values, for example
7835 .code
7836 cn=manager,o=University of Cambridge,c=UK
7837 .endd
7838 The &(ldap)& lookup type generates an error if more than one entry matches the
7839 search filter, whereas &(ldapm)& permits this case, and inserts a newline in
7840 the result between the data from different entries. It is possible for multiple
7841 values to be returned for both &(ldap)& and &(ldapm)&, but in the former case
7842 you know that whatever values are returned all came from a single entry in the
7843 directory.
7844
7845 In the common case where you specify a single attribute in your LDAP query, the
7846 result is not quoted, and does not contain the attribute name. If the attribute
7847 has multiple values, they are separated by commas. Any comma that is
7848 part of an attribute's value is doubled.
7849
7850 If you specify multiple attributes, the result contains space-separated, quoted
7851 strings, each preceded by the attribute name and an equals sign. Within the
7852 quotes, the quote character, backslash, and newline are escaped with
7853 backslashes, and commas are used to separate multiple values for the attribute.
7854 Any commas in attribute values are doubled
7855 (permitting treatment of the values as a comma-separated list).
7856 Apart from the escaping, the string within quotes takes the same form as the
7857 output when a single attribute is requested. Specifying no attributes is the
7858 same as specifying all of an entry's attributes.
7859
7860 Here are some examples of the output format. The first line of each pair is an
7861 LDAP query, and the second is the data that is returned. The attribute called
7862 &%attr1%& has two values, one of them with an embedded comma, whereas
7863 &%attr2%& has only one value. Both attributes are derived from &%attr%&
7864 (they have SUP &%attr%& in their schema definitions).
7865
7866 .code
7867 ldap:///o=base?attr1?sub?(uid=fred)
7868 value1.1,value1,,2
7869
7870 ldap:///o=base?attr2?sub?(uid=fred)
7871 value two
7872
7873 ldap:///o=base?attr?sub?(uid=fred)
7874 value1.1,value1,,2,value two
7875
7876 ldap:///o=base?attr1,attr2?sub?(uid=fred)
7877 attr1="value1.1,value1,,2" attr2="value two"
7878
7879 ldap:///o=base??sub?(uid=fred)
7880 objectClass="top" attr1="value1.1,value1,,2" attr2="value two"
7881 .endd
7882 You can
7883 make use of Exim's &%-be%& option to run expansion tests and thereby check the
7884 results of LDAP lookups.
7885 The &%extract%& operator in string expansions can be used to pick out
7886 individual fields from data that consists of &'key'&=&'value'& pairs.
7887 The &%listextract%& operator should be used to pick out individual values
7888 of attributes, even when only a single value is expected.
7889 The doubling of embedded commas allows you to use the returned data as a
7890 comma separated list (using the "<," syntax for changing the input list separator).
7891
7892
7893
7894
7895 .section "More about NIS+" "SECTnisplus"
7896 .cindex "NIS+ lookup type"
7897 .cindex "lookup" "NIS+"
7898 NIS+ queries consist of a NIS+ &'indexed name'& followed by an optional colon
7899 and field name. If this is given, the result of a successful query is the
7900 contents of the named field; otherwise the result consists of a concatenation
7901 of &'field-name=field-value'& pairs, separated by spaces. Empty values and
7902 values containing spaces are quoted. For example, the query
7903 .code
7904 [name=mg1456],passwd.org_dir
7905 .endd
7906 might return the string
7907 .code
7908 name=mg1456 passwd="" uid=999 gid=999 gcos="Martin Guerre"
7909 home=/home/mg1456 shell=/bin/bash shadow=""
7910 .endd
7911 (split over two lines here to fit on the page), whereas
7912 .code
7913 [name=mg1456],passwd.org_dir:gcos
7914 .endd
7915 would just return
7916 .code
7917 Martin Guerre
7918 .endd
7919 with no quotes. A NIS+ lookup fails if NIS+ returns more than one table entry
7920 for the given indexed key. The effect of the &%quote_nisplus%& expansion
7921 operator is to double any quote characters within the text.
7922
7923
7924
7925 .section "SQL lookups" "SECTsql"
7926 .cindex "SQL lookup types"
7927 .cindex "MySQL" "lookup type"
7928 .cindex "PostgreSQL lookup type"
7929 .cindex "lookup" "MySQL"
7930 .cindex "lookup" "PostgreSQL"
7931 .cindex "Oracle" "lookup type"
7932 .cindex "lookup" "Oracle"
7933 .cindex "InterBase lookup type"
7934 .cindex "lookup" "InterBase"
7935 .cindex "Redis lookup type"
7936 .cindex lookup Redis
7937 Exim can support lookups in InterBase, MySQL, Oracle, PostgreSQL, Redis,
7938 and SQLite
7939 databases. Queries for these databases contain SQL statements, so an example
7940 might be
7941 .code
7942 ${lookup mysql{select mailbox from users where id='userx'}\
7943   {$value}fail}
7944 .endd
7945 If the result of the query contains more than one field, the data for each
7946 field in the row is returned, preceded by its name, so the result of
7947 .code
7948 ${lookup pgsql{select home,name from users where id='userx'}\
7949   {$value}}
7950 .endd
7951 might be
7952 .code
7953 home=/home/userx name="Mister X"
7954 .endd
7955 Empty values and values containing spaces are double quoted, with embedded
7956 quotes escaped by a backslash. If the result of the query contains just one
7957 field, the value is passed back verbatim, without a field name, for example:
7958 .code
7959 Mister X
7960 .endd
7961 If the result of the query yields more than one row, it is all concatenated,
7962 with a newline between the data for each row.
7963
7964
7965 .section "More about MySQL, PostgreSQL, Oracle, InterBase, and Redis" "SECID72"
7966 .cindex "MySQL" "lookup type"
7967 .cindex "PostgreSQL lookup type"
7968 .cindex "lookup" "MySQL"
7969 .cindex "lookup" "PostgreSQL"
7970 .cindex "Oracle" "lookup type"
7971 .cindex "lookup" "Oracle"
7972 .cindex "InterBase lookup type"
7973 .cindex "lookup" "InterBase"
7974 .cindex "Redis lookup type"
7975 .cindex lookup Redis
7976 If any MySQL, PostgreSQL, Oracle, InterBase or Redis lookups are used, the
7977 &%mysql_servers%&, &%pgsql_servers%&, &%oracle_servers%&, &%ibase_servers%&,
7978 or &%redis_servers%&
7979 option (as appropriate) must be set to a colon-separated list of server
7980 information.
7981 .oindex &%mysql_servers%&
7982 .oindex &%pgsql_servers%&
7983 .oindex &%oracle_servers%&
7984 .oindex &%ibase_servers%&
7985 .oindex &%redis_servers%&
7986 (For MySQL and PostgreSQL, the global option need not be set if all
7987 queries contain their own server information &-- see section
7988 &<<SECTspeserque>>&.)
7989 For all but Redis
7990 each item in the list is a slash-separated list of four
7991 items: host name, database name, user name, and password. In the case of
7992 Oracle, the host name field is used for the &"service name"&, and the database
7993 name field is not used and should be empty. For example:
7994 .code
7995 hide oracle_servers = oracle.plc.example//userx/abcdwxyz
7996 .endd
7997 Because password data is sensitive, you should always precede the setting with
7998 &"hide"&, to prevent non-admin users from obtaining the setting via the &%-bP%&
7999 option. Here is an example where two MySQL servers are listed:
8000 .code
8001 hide mysql_servers = localhost/users/root/secret:\
8002                      otherhost/users/root/othersecret
8003 .endd
8004 For MySQL and PostgreSQL, a host may be specified as <&'name'&>:<&'port'&> but
8005 because this is a colon-separated list, the colon has to be doubled. For each
8006 query, these parameter groups are tried in order until a connection is made and
8007 a query is successfully processed. The result of a query may be that no data is
8008 found, but that is still a successful query. In other words, the list of
8009 servers provides a backup facility, not a list of different places to look.
8010
8011 For Redis the global option need not be specified if all queries contain their
8012 own server information &-- see section &<<SECTspeserque>>&.
8013 If specified, the option must be set to a colon-separated list of server
8014 information.
8015 Each item in the list is a slash-separated list of three items:
8016 host, database number, and password.
8017 .olist
8018 The host is required and may be either an IPv4 address and optional
8019 port number (separated by a colon, which needs doubling due to the
8020 higher-level list), or a Unix socket pathname enclosed in parentheses
8021 .next
8022 The database number is optional; if present that number is selected in the backend
8023 .next
8024 The password is optional; if present it is used to authenticate to the backend
8025 .endlist
8026
8027 The &%quote_mysql%&, &%quote_pgsql%&, and &%quote_oracle%& expansion operators
8028 convert newline, tab, carriage return, and backspace to \n, \t, \r, and \b
8029 respectively, and the characters single-quote, double-quote, and backslash
8030 itself are escaped with backslashes.
8031
8032 The &%quote_redis%& expansion operator
8033 escapes whitespace and backslash characters with a backslash.
8034
8035 .section "Specifying the server in the query" "SECTspeserque"
8036 .new
8037 For MySQL, PostgreSQL and Redis lookups (but not currently for Oracle and InterBase),
8038 it is possible to specify a list of servers with an individual query. This is
8039 done by appending a comma-separated option to the query type:
8040 .display
8041 .endd
8042 &`,servers=`&&'server1:server2:server3:...'&
8043 .wen
8044 Each item in the list may take one of two forms:
8045 .olist
8046 If it contains no slashes it is assumed to be just a host name. The appropriate
8047 global option (&%mysql_servers%& or &%pgsql_servers%&) is searched for a host
8048 of the same name, and the remaining parameters (database, user, password) are
8049 taken from there.
8050 .next
8051 If it contains any slashes, it is taken as a complete parameter set.
8052 .endlist
8053 The list of servers is used in exactly the same way as the global list.
8054 Once a connection to a server has happened and a query has been
8055 successfully executed, processing of the lookup ceases.
8056
8057 This feature is intended for use in master/slave situations where updates
8058 are occurring and you want to update the master rather than a slave. If the
8059 master is in the list as a backup for reading, you might have a global setting
8060 like this:
8061 .code
8062 mysql_servers = slave1/db/name/pw:\
8063                 slave2/db/name/pw:\
8064                 master/db/name/pw
8065 .endd
8066 In an updating lookup, you could then write:
8067 .code
8068 ${lookup mysql,servers=master {UPDATE ...} }
8069 .endd
8070 That query would then be sent only to the master server. If, on the other hand,
8071 the master is not to be used for reading, and so is not present in the global
8072 option, you can still update it by a query of this form:
8073 .code
8074 ${lookup pgsql,servers=master/db/name/pw {UPDATE ...} }
8075 .endd
8076
8077 .new
8078 An older syntax places the servers speciification before the qury,
8079 semicolon separated:
8080 .code
8081 ${lookup mysql{servers=master; UPDATE ...} }
8082 .endd
8083 The new version avoids potential issues with tainted
8084 arguments in the query, for explicit expansion.
8085 &*Note*&: server specifications in list-style lookups are still problematic.
8086 .wen
8087
8088
8089 .section "Special MySQL features" "SECID73"
8090 For MySQL, an empty host name or the use of &"localhost"& in &%mysql_servers%&
8091 causes a connection to the server on the local host by means of a Unix domain
8092 socket. An alternate socket can be specified in parentheses.
8093 An option group name for MySQL option files can be specified in square brackets;
8094 the default value is &"exim"&.
8095 The full syntax of each item in &%mysql_servers%& is:
8096 .display
8097 <&'hostname'&>::<&'port'&>(<&'socket name'&>)[<&'option group'&>]/&&&
8098   <&'database'&>/<&'user'&>/<&'password'&>
8099 .endd
8100 Any of the four sub-parts of the first field can be omitted. For normal use on
8101 the local host it can be left blank or set to just &"localhost"&.
8102
8103 No database need be supplied &-- but if it is absent here, it must be given in
8104 the queries.
8105
8106 If a MySQL query is issued that does not request any data (an insert, update,
8107 or delete command), the result of the lookup is the number of rows affected.
8108
8109 &*Warning*&: This can be misleading. If an update does not actually change
8110 anything (for example, setting a field to the value it already has), the result
8111 is zero because no rows are affected.
8112
8113
8114 .section "Special PostgreSQL features" "SECID74"
8115 PostgreSQL lookups can also use Unix domain socket connections to the database.
8116 This is usually faster and costs less CPU time than a TCP/IP connection.
8117 However it can be used only if the mail server runs on the same machine as the
8118 database server. A configuration line for PostgreSQL via Unix domain sockets
8119 looks like this:
8120 .code
8121 hide pgsql_servers = (/tmp/.s.PGSQL.5432)/db/user/password : ...
8122 .endd
8123 In other words, instead of supplying a host name, a path to the socket is
8124 given. The path name is enclosed in parentheses so that its slashes aren't
8125 visually confused with the delimiters for the other server parameters.
8126
8127 If a PostgreSQL query is issued that does not request any data (an insert,
8128 update, or delete command), the result of the lookup is the number of rows
8129 affected.
8130
8131 .section "More about SQLite" "SECTsqlite"
8132 .cindex "lookup" "SQLite"
8133 .cindex "sqlite lookup type"
8134 SQLite is different to the other SQL lookups because a filename is required in
8135 addition to the SQL query. An SQLite database is a single file, and there is no
8136 daemon as in the other SQL databases.
8137
8138 .new
8139 .oindex &%sqlite_dbfile%&
8140 The preferred way of specifying the file is by using the
8141 &%sqlite_dbfile%& option, set to
8142 an absolute path.
8143 .wen
8144 A deprecated method is available, prefixing the query with the filename
8145 separated by white space.
8146 This means that the path name cannot contain white space.
8147 .cindex "tainted data" "sqlite file"
8148 It also means that the query cannot use any tainted values, as that taints
8149 the entire query including the filename - resulting in a refusal to open
8150 the file.
8151
8152 .new
8153 Here is a lookup expansion example:
8154 .code
8155 sqlite_dbfile = /some/thing/sqlitedb
8156 ...
8157 ${lookup sqlite {select name from aliases where id='userx';}}
8158 .endd
8159 In a list, the syntax is similar. For example:
8160 .code
8161 domainlist relay_to_domains = sqlite;\
8162    select * from relays where ip='$sender_host_address';
8163 .endd
8164 .wen
8165 The only character affected by the &%quote_sqlite%& operator is a single
8166 quote, which it doubles.
8167
8168 .cindex timeout SQLite
8169 .cindex sqlite "lookup timeout"
8170 The SQLite library handles multiple simultaneous accesses to the database
8171 internally. Multiple readers are permitted, but only one process can
8172 update at once. Attempts to access the database while it is being updated
8173 are rejected after a timeout period, during which the SQLite library
8174 waits for the lock to be released. In Exim, the default timeout is set
8175 to 5 seconds, but it can be changed by means of the &%sqlite_lock_timeout%&
8176 option.
8177
8178 .section "More about Redis" "SECTredis"
8179 .cindex "lookup" "Redis"
8180 .cindex "redis lookup type"
8181 Redis is a non-SQL database. Commands are simple get and set.
8182 Examples:
8183 .code
8184 ${lookup redis{set keyname ${quote_redis:objvalue plus}}}
8185 ${lookup redis{get keyname}}
8186 .endd
8187
8188 As of release 4.91, "lightweight" support for Redis Cluster is available.
8189 Requires &%redis_servers%& list to contain all the servers in the cluster, all
8190 of which must be reachable from the running exim instance. If the cluster has
8191 master/slave replication, the list must contain all the master and slave
8192 servers.
8193
8194 When the Redis Cluster returns a "MOVED" response to a query, Exim does not
8195 immediately follow the redirection but treats the response as a DEFER, moving on
8196 to the next server in the &%redis_servers%& list until the correct server is
8197 reached.
8198
8199 .ecindex IIDfidalo1
8200 .ecindex IIDfidalo2
8201
8202
8203 . ////////////////////////////////////////////////////////////////////////////
8204 . ////////////////////////////////////////////////////////////////////////////
8205
8206 .chapter "Domain, host, address, and local part lists" &&&
8207          "CHAPdomhosaddlists" &&&
8208          "Domain, host, and address lists"
8209 .scindex IIDdohoadli "lists of domains; hosts; etc."
8210 A number of Exim configuration options contain lists of domains, hosts,
8211 email addresses, or local parts. For example, the &%hold_domains%& option
8212 contains a list of domains whose delivery is currently suspended. These lists
8213 are also used as data in ACL statements (see chapter &<<CHAPACL>>&), and as
8214 arguments to expansion conditions such as &%match_domain%&.
8215
8216 Each item in one of these lists is a pattern to be matched against a domain,
8217 host, email address, or local part, respectively. In the sections below, the
8218 different types of pattern for each case are described, but first we cover some
8219 general facilities that apply to all four kinds of list.
8220
8221 Note that other parts of Exim use a &'string list'& which does not
8222 support all the complexity available in
8223 domain, host, address and local part lists.
8224
8225
8226
8227 .section "Expansion of lists" "SECTlistexpand"
8228 .cindex "expansion" "of lists"
8229 Each list is expanded as a single string before it is used.
8230
8231 &'Exception: the router headers_remove option, where list-item
8232 splitting is done before string-expansion.'&
8233
8234 The result of
8235 expansion must be a list, possibly containing empty items, which is split up
8236 into separate items for matching. By default, colon is the separator character,
8237 but this can be varied if necessary. See sections &<<SECTlistconstruct>>& and
8238 &<<SECTempitelis>>& for details of the list syntax; the second of these
8239 discusses the way to specify empty list items.
8240
8241
8242 If the string expansion is forced to fail, Exim behaves as if the item it is
8243 testing (domain, host, address, or local part) is not in the list. Other
8244 expansion failures cause temporary errors.
8245
8246 If an item in a list is a regular expression, backslashes, dollars and possibly
8247 other special characters in the expression must be protected against
8248 misinterpretation by the string expander. The easiest way to do this is to use
8249 the &`\N`& expansion feature to indicate that the contents of the regular
8250 expression should not be expanded. For example, in an ACL you might have:
8251 .code
8252 deny senders = \N^\d{8}\w@.*\.baddomain\.example$\N : \
8253                ${lookup{$domain}lsearch{/badsenders/bydomain}}
8254 .endd
8255 The first item is a regular expression that is protected from expansion by
8256 &`\N`&, whereas the second uses the expansion to obtain a list of unwanted
8257 senders based on the receiving domain.
8258
8259
8260
8261
8262 .section "Negated items in lists" "SECID76"
8263 .cindex "list" "negation"
8264 .cindex "negation" "in lists"
8265 Items in a list may be positive or negative. Negative items are indicated by a
8266 leading exclamation mark, which may be followed by optional white space. A list
8267 defines a set of items (domains, etc). When Exim processes one of these lists,
8268 it is trying to find out whether a domain, host, address, or local part
8269 (respectively) is in the set that is defined by the list. It works like this:
8270
8271 The list is scanned from left to right. If a positive item is matched, the
8272 subject that is being checked is in the set; if a negative item is matched, the
8273 subject is not in the set. If the end of the list is reached without the
8274 subject having matched any of the patterns, it is in the set if the last item
8275 was a negative one, but not if it was a positive one. For example, the list in
8276 .code
8277 domainlist relay_to_domains = !a.b.c : *.b.c
8278 .endd
8279 matches any domain ending in &'.b.c'& except for &'a.b.c'&. Domains that match
8280 neither &'a.b.c'& nor &'*.b.c'& do not match, because the last item in the
8281 list is positive. However, if the setting were
8282 .code
8283 domainlist relay_to_domains = !a.b.c
8284 .endd
8285 then all domains other than &'a.b.c'& would match because the last item in the
8286 list is negative. In other words, a list that ends with a negative item behaves
8287 as if it had an extra item &`:*`& on the end.
8288
8289 Another way of thinking about positive and negative items in lists is to read
8290 the connector as &"or"& after a positive item and as &"and"& after a negative
8291 item.
8292
8293
8294
8295 .section "File names in lists" "SECTfilnamlis"
8296 .cindex "list" "filename in"
8297 If an item in a domain, host, address, or local part list is an absolute
8298 filename (beginning with a slash character), each line of the file is read and
8299 processed as if it were an independent item in the list, except that further
8300 filenames are not allowed,
8301 and no expansion of the data from the file takes place.
8302 Empty lines in the file are ignored, and the file may also contain comment
8303 lines:
8304
8305 .ilist
8306 For domain and host lists, if a # character appears anywhere in a line of the
8307 file, it and all following characters are ignored.
8308 .next
8309 Because local parts may legitimately contain # characters, a comment in an
8310 address list or local part list file is recognized only if # is preceded by
8311 white space or the start of the line. For example:
8312 .code
8313 not#comment@x.y.z   # but this is a comment
8314 .endd
8315 .endlist
8316
8317 Putting a filename in a list has the same effect as inserting each line of the
8318 file as an item in the list (blank lines and comments excepted). However, there
8319 is one important difference: the file is read each time the list is processed,
8320 so if its contents vary over time, Exim's behaviour changes.
8321
8322 If a filename is preceded by an exclamation mark, the sense of any match
8323 within the file is inverted. For example, if
8324 .code
8325 hold_domains = !/etc/nohold-domains
8326 .endd
8327 and the file contains the lines
8328 .code
8329 !a.b.c
8330 *.b.c
8331 .endd
8332 then &'a.b.c'& is in the set of domains defined by &%hold_domains%&, whereas
8333 any domain matching &`*.b.c`& is not.
8334
8335
8336
8337 .section "An lsearch file is not an out-of-line list" "SECID77"
8338 As will be described in the sections that follow, lookups can be used in lists
8339 to provide indexed methods of checking list membership. There has been some
8340 confusion about the way &(lsearch)& lookups work in lists. Because
8341 an &(lsearch)& file contains plain text and is scanned sequentially, it is
8342 sometimes thought that it is allowed to contain wild cards and other kinds of
8343 non-constant pattern. This is not the case. The keys in an &(lsearch)& file are
8344 always fixed strings, just as for any other single-key lookup type.
8345
8346 If you want to use a file to contain wild-card patterns that form part of a
8347 list, just give the filename on its own, without a search type, as described
8348 in the previous section. You could also use the &(wildlsearch)& or
8349 &(nwildlsearch)&, but there is no advantage in doing this.
8350
8351
8352
8353
8354 .new
8355 .section "Results of list checking" SECTlistresults
8356 The primary result of doing a list check is a truth value.
8357 In some contexts additional information is stored
8358 about the list element that matched:
8359 .vlist
8360 .vitem hosts
8361 A &%hosts%& ACL condition
8362 will store a result in the &$host_data$& variable.
8363 .vitem local_parts
8364 A &%local_parts%& router option or &%local_parts%& ACL condition
8365 will store a result in the &$local_part_data$& variable.
8366 .vitem domains
8367 A &%domains%& router option or &%domains%& ACL condition
8368 .vitem senders
8369 A &%senders%& router option or &%senders%& ACL condition
8370 will store a result in the &$sender_data$& variable.
8371 .vitem recipients
8372 A &%recipients%& ACL condition
8373 will store a result in the &$recipient_data$& variable.
8374 .endlist
8375
8376 The detail of the additional information depends on the
8377 type of match and is given below as the &*value*& information.
8378 .wen
8379
8380
8381
8382
8383 .section "Named lists" "SECTnamedlists"
8384 .cindex "named lists"
8385 .cindex "list" "named"
8386 A list of domains, hosts, email addresses, or local parts can be given a name
8387 which is then used to refer to the list elsewhere in the configuration. This is
8388 particularly convenient if the same list is required in several different
8389 places. It also allows lists to be given meaningful names, which can improve
8390 the readability of the configuration. For example, it is conventional to define
8391 a domain list called &'local_domains'& for all the domains that are handled
8392 locally on a host, using a configuration line such as
8393 .code
8394 domainlist local_domains = localhost:my.dom.example
8395 .endd
8396 Named lists are referenced by giving their name preceded by a plus sign, so,
8397 for example, a router that is intended to handle local domains would be
8398 configured with the line
8399 .code
8400 domains = +local_domains
8401 .endd
8402 The first router in a configuration is often one that handles all domains
8403 except the local ones, using a configuration with a negated item like this:
8404 .code
8405 dnslookup:
8406   driver = dnslookup
8407   domains = ! +local_domains
8408   transport = remote_smtp
8409   no_more
8410 .endd
8411 The four kinds of named list are created by configuration lines starting with
8412 the words &%domainlist%&, &%hostlist%&, &%addresslist%&, or &%localpartlist%&,
8413 respectively. Then there follows the name that you are defining, followed by an
8414 equals sign and the list itself. For example:
8415 .code
8416 hostlist    relay_from_hosts = 192.168.23.0/24 : my.friend.example
8417 addresslist bad_senders = cdb;/etc/badsenders
8418 .endd
8419 A named list may refer to other named lists:
8420 .code
8421 domainlist  dom1 = first.example : second.example
8422 domainlist  dom2 = +dom1 : third.example
8423 domainlist  dom3 = fourth.example : +dom2 : fifth.example
8424 .endd
8425 &*Warning*&: If the last item in a referenced list is a negative one, the
8426 effect may not be what you intended, because the negation does not propagate
8427 out to the higher level. For example, consider:
8428 .code
8429 domainlist  dom1 = !a.b
8430 domainlist  dom2 = +dom1 : *.b
8431 .endd
8432 The second list specifies &"either in the &%dom1%& list or &'*.b'&"&. The first
8433 list specifies just &"not &'a.b'&"&, so the domain &'x.y'& matches it. That
8434 means it matches the second list as well. The effect is not the same as
8435 .code
8436 domainlist  dom2 = !a.b : *.b
8437 .endd
8438 where &'x.y'& does not match. It's best to avoid negation altogether in
8439 referenced lists if you can.
8440
8441 .new
8442 .cindex "hiding named list values"
8443 .cindex "named lists" "hiding value of"
8444 Some named list definitions may contain sensitive data, for example, passwords for
8445 accessing databases. To stop non-admin users from using the &%-bP%& command
8446 line option to read these values, you can precede the definition with the
8447 word &"hide"&. For example:
8448 .code
8449 hide domainlist filter_for_domains = ldap;PASS=secret ldap::/// ...
8450 .endd
8451 .wen
8452
8453
8454 Named lists may have a performance advantage. When Exim is routing an
8455 address or checking an incoming message, it caches the result of tests on named
8456 lists. So, if you have a setting such as
8457 .code
8458 domains = +local_domains
8459 .endd
8460 on several of your routers
8461 or in several ACL statements,
8462 the actual test is done only for the first one. However, the caching works only
8463 if there are no expansions within the list itself or any sublists that it
8464 references. In other words, caching happens only for lists that are known to be
8465 the same each time they are referenced.
8466
8467 By default, there may be up to 16 named lists of each type. This limit can be
8468 extended by changing a compile-time variable. The use of domain and host lists
8469 is recommended for concepts such as local domains, relay domains, and relay
8470 hosts. The default configuration is set up like this.
8471
8472
8473
8474 .section "Named lists compared with macros" "SECID78"
8475 .cindex "list" "named compared with macro"
8476 .cindex "macro" "compared with named list"
8477 At first sight, named lists might seem to be no different from macros in the
8478 configuration file. However, macros are just textual substitutions. If you
8479 write
8480 .code
8481 ALIST = host1 : host2
8482 auth_advertise_hosts = !ALIST
8483 .endd
8484 it probably won't do what you want, because that is exactly the same as
8485 .code
8486 auth_advertise_hosts = !host1 : host2
8487 .endd
8488 Notice that the second host name is not negated. However, if you use a host
8489 list, and write
8490 .code
8491 hostlist alist = host1 : host2
8492 auth_advertise_hosts = ! +alist
8493 .endd
8494 the negation applies to the whole list, and so that is equivalent to
8495 .code
8496 auth_advertise_hosts = !host1 : !host2
8497 .endd
8498
8499
8500 .section "Named list caching" "SECID79"
8501 .cindex "list" "caching of named"
8502 .cindex "caching" "named lists"
8503 While processing a message, Exim caches the result of checking a named list if
8504 it is sure that the list is the same each time. In practice, this means that
8505 the cache operates only if the list contains no $ characters, which guarantees
8506 that it will not change when it is expanded. Sometimes, however, you may have
8507 an expanded list that you know will be the same each time within a given
8508 message. For example:
8509 .code
8510 domainlist special_domains = \
8511            ${lookup{$sender_host_address}cdb{/some/file}}
8512 .endd
8513 This provides a list of domains that depends only on the sending host's IP
8514 address. If this domain list is referenced a number of times (for example,
8515 in several ACL lines, or in several routers) the result of the check is not
8516 cached by default, because Exim does not know that it is going to be the
8517 same list each time.
8518
8519 By appending &`_cache`& to &`domainlist`& you can tell Exim to go ahead and
8520 cache the result anyway. For example:
8521 .code
8522 domainlist_cache special_domains = ${lookup{...
8523 .endd
8524 If you do this, you should be absolutely sure that caching is going to do
8525 the right thing in all cases. When in doubt, leave it out.
8526
8527
8528
8529 .section "Domain lists" "SECTdomainlist"
8530 .cindex "domain list" "patterns for"
8531 .cindex "list" "domain list"
8532 Domain lists contain patterns that are to be matched against a mail domain.
8533 The following types of item may appear in domain lists:
8534
8535 .ilist
8536 .cindex "primary host name"
8537 .cindex "host name" "matched in domain list"
8538 .oindex "&%primary_hostname%&"
8539 .cindex "domain list" "matching primary host name"
8540 .cindex "@ in a domain list"
8541 If a pattern consists of a single @ character, it matches the local host name,
8542 as set by the &%primary_hostname%& option (or defaulted). This makes it
8543 possible to use the same configuration file on several different hosts that
8544 differ only in their names.
8545
8546 .new
8547 The value for a match will be the primary host name.
8548 .wen
8549
8550
8551 .next
8552 .cindex "@[] in a domain list"
8553 .cindex "domain list" "matching local IP interfaces"
8554 .cindex "domain literal"
8555 If a pattern consists of the string &`@[]`& it matches an IP address enclosed
8556 in square brackets (as in an email address that contains a domain literal), but
8557 only if that IP address is recognized as local for email routing purposes. The
8558 &%local_interfaces%& and &%extra_local_interfaces%& options can be used to
8559 control which of a host's several IP addresses are treated as local.
8560 In today's Internet, the use of domain literals is controversial;
8561 see the &%allow_domain_literals%& main option.
8562
8563 .new
8564 The value for a match will be the string &`@[]`&.
8565 .wen
8566
8567
8568 .next
8569 .cindex "@mx_any"
8570 .cindex "@mx_primary"
8571 .cindex "@mx_secondary"
8572 .cindex "domain list" "matching MX pointers to local host"
8573 If a pattern consists of the string &`@mx_any`& it matches any domain that
8574 has an MX record pointing to the local host or to any host that is listed in
8575 .oindex "&%hosts_treat_as_local%&"
8576 &%hosts_treat_as_local%&. The items &`@mx_primary`& and &`@mx_secondary`&
8577 are similar, except that the first matches only when a primary MX target is the
8578 local host, and the second only when no primary MX target is the local host,
8579 but a secondary MX target is. &"Primary"& means an MX record with the lowest
8580 preference value &-- there may of course be more than one of them.
8581
8582 The MX lookup that takes place when matching a pattern of this type is
8583 performed with the resolver options for widening names turned off. Thus, for
8584 example, a single-component domain will &'not'& be expanded by adding the
8585 resolver's default domain. See the &%qualify_single%& and &%search_parents%&
8586 options of the &(dnslookup)& router for a discussion of domain widening.
8587
8588 Sometimes you may want to ignore certain IP addresses when using one of these
8589 patterns. You can specify this by following the pattern with &`/ignore=`&<&'ip
8590 list'&>, where <&'ip list'&> is a list of IP addresses. These addresses are
8591 ignored when processing the pattern (compare the &%ignore_target_hosts%& option
8592 on a router). For example:
8593 .code
8594 domains = @mx_any/ignore=127.0.0.1
8595 .endd
8596 This example matches any domain that has an MX record pointing to one of
8597 the local host's IP addresses other than 127.0.0.1.
8598
8599 The list of IP addresses is in fact processed by the same code that processes
8600 host lists, so it may contain CIDR-coded network specifications and it may also
8601 contain negative items.
8602
8603 Because the list of IP addresses is a sublist within a domain list, you have to
8604 be careful about delimiters if there is more than one address. Like any other
8605 list, the default delimiter can be changed. Thus, you might have:
8606 .code
8607 domains = @mx_any/ignore=<;127.0.0.1;0.0.0.0 : \
8608           an.other.domain : ...
8609 .endd
8610 so that the sublist uses semicolons for delimiters. When IPv6 addresses are
8611 involved, it is easiest to change the delimiter for the main list as well:
8612 .code
8613 domains = <? @mx_any/ignore=<;127.0.0.1;::1 ? \
8614           an.other.domain ? ...
8615 .endd
8616 .new
8617 The value for a match will be the list element string (starting &`@mx_`&).
8618 .wen
8619
8620
8621 .next
8622 .cindex "asterisk" "in domain list"
8623 .cindex "domain list" "asterisk in"
8624 .cindex "domain list" "matching &""ends with""&"
8625 If a pattern starts with an asterisk, the remaining characters of the pattern
8626 are compared with the terminating characters of the domain. The use of &"*"& in
8627 domain lists differs from its use in partial matching lookups. In a domain
8628 list, the character following the asterisk need not be a dot, whereas partial
8629 matching works only in terms of dot-separated components. For example, a domain
8630 list item such as &`*key.ex`& matches &'donkey.ex'& as well as
8631 &'cipher.key.ex'&.
8632
8633 .new
8634 The value for a match will be the list element string (starting with the asterisk).
8635 Additionally, &$0$& will be set to the matched string
8636 and &$1$& to the variable portion which the asterisk matched.
8637 .wen
8638
8639 .next
8640 .cindex "regular expressions" "in domain list"
8641 .cindex "domain list" "matching regular expression"
8642 If a pattern starts with a circumflex character, it is treated as a regular
8643 expression, and matched against the domain using a regular expression matching
8644 function. The circumflex is treated as part of the regular expression.
8645 Email domains are case-independent, so this regular expression match is by
8646 default case-independent, but you can make it case-dependent by starting it
8647 with &`(?-i)`&. References to descriptions of the syntax of regular expressions
8648 are given in chapter &<<CHAPregexp>>&.
8649
8650 &*Warning*&: Because domain lists are expanded before being processed, you
8651 must escape any backslash and dollar characters in the regular expression, or
8652 use the special &`\N`& sequence (see chapter &<<CHAPexpand>>&) to specify that
8653 it is not to be expanded (unless you really do want to build a regular
8654 expression by expansion, of course).
8655
8656 .new
8657 The value for a match will be the list element string (starting with the circumflex).
8658 Additionally, &$0$& will be set to the string matching the regular expression,
8659 and &$1$& (onwards) to any submatches identified by parentheses.
8660 .wen
8661
8662
8663
8664 .next
8665 .cindex "lookup" "in domain list"
8666 .cindex "domain list" "matching by lookup"
8667 If a pattern starts with the name of a single-key lookup type followed by a
8668 semicolon (for example, &"dbm;"& or &"lsearch;"&), the remainder of the pattern
8669 must be a filename in a suitable format for the lookup type. For example, for
8670 &"cdb;"& it must be an absolute path:
8671 .code
8672 domains = cdb;/etc/mail/local_domains.cdb
8673 .endd
8674 The appropriate type of lookup is done on the file using the domain name as the
8675 key. In most cases, the value resulting from the lookup is not used; Exim is interested
8676 only in whether or not the key is present in the file. However, when a lookup
8677 is used for the &%domains%& option on a router
8678 or a &%domains%& condition in an ACL statement, the value is preserved in the
8679 &$domain_data$& variable and can be referred to in other router options or
8680 other statements in the same ACL.
8681 .cindex "tainted data" "de-tainting"
8682 The value will be untainted.
8683
8684
8685 .next
8686 Any of the single-key lookup type names may be preceded by
8687 &`partial`&<&'n'&>&`-`&, where the <&'n'&> is optional, for example,
8688 .code
8689 domains = partial-dbm;/partial/domains
8690 .endd
8691 This causes partial matching logic to be invoked; a description of how this
8692 works is given in section &<<SECTpartiallookup>>&.
8693
8694 .next
8695 .cindex "asterisk" "in lookup type"
8696 Any of the single-key lookup types may be followed by an asterisk. This causes
8697 a default lookup for a key consisting of a single asterisk to be done if the
8698 original lookup fails. This is not a useful feature when using a domain list to
8699 select particular domains (because any domain would match), but it might have
8700 value if the result of the lookup is being used via the &$domain_data$&
8701 expansion variable.
8702
8703 .next
8704 If the pattern starts with the name of a query-style lookup type followed by a
8705 semicolon (for example, &"nisplus;"& or &"ldap;"&), the remainder of the
8706 pattern must be an appropriate query for the lookup type, as described in
8707 chapter &<<CHAPfdlookup>>&. For example:
8708 .code
8709 hold_domains = mysql;select domain from holdlist \
8710   where domain = '${quote_mysql:$domain}';
8711 .endd
8712 In most cases, the value resulting from the lookup is not used (so for an SQL query, for
8713 example, it doesn't matter what field you select). Exim is interested only in
8714 whether or not the query succeeds. However, when a lookup is used for the
8715 &%domains%& option on a router, the value is preserved in the &$domain_data$&
8716 variable and can be referred to in other options.
8717 .cindex "tainted data" "de-tainting"
8718 The value will be untainted.
8719
8720 .next
8721 .new
8722 If the pattern starts with the name of a lookup type
8723 of either kind (single-key or query-style) it may be
8724 followed by a comma and options,
8725 The options are lookup-type specific and consist of a comma-separated list.
8726 Each item starts with a tag and and equals "=".
8727 .wen
8728
8729 .next
8730 .cindex "domain list" "matching literal domain name"
8731 If none of the above cases apply, a caseless textual comparison is made
8732 between the pattern and the domain.
8733
8734 The value for a match will be the list element string.
8735 .cindex "tainted data" "de-tainting"
8736 Note that this is commonly untainted
8737 (depending on the way the list was created).
8738 This is a useful way of obtaining an untainted equivalent to
8739 the domain, for later operations.
8740 .endlist
8741
8742
8743 Here is an example that uses several different kinds of pattern:
8744 .code
8745 domainlist funny_domains = \
8746   @ : \
8747   lib.unseen.edu : \
8748   *.foundation.fict.example : \
8749   \N^[1-2]\d{3}\.fict\.example$\N : \
8750   partial-dbm;/opt/data/penguin/book : \
8751   nis;domains.byname : \
8752   nisplus;[name=$domain,status=local],domains.org_dir
8753 .endd
8754 There are obvious processing trade-offs among the various matching modes. Using
8755 an asterisk is faster than a regular expression, and listing a few names
8756 explicitly probably is too. The use of a file or database lookup is expensive,
8757 but may be the only option if hundreds of names are required. Because the
8758 patterns are tested in order, it makes sense to put the most commonly matched
8759 patterns earlier.
8760
8761
8762
8763 .section "Host lists" "SECThostlist"
8764 .cindex "host list" "patterns in"
8765 .cindex "list" "host list"
8766 Host lists are used to control what remote hosts are allowed to do. For
8767 example, some hosts may be allowed to use the local host as a relay, and some
8768 may be permitted to use the SMTP ETRN command. Hosts can be identified in
8769 two different ways, by name or by IP address. In a host list, some types of
8770 pattern are matched to a host name, and some are matched to an IP address.
8771 You need to be particularly careful with this when single-key lookups are
8772 involved, to ensure that the right value is being used as the key.
8773
8774
8775 .section "Special host list patterns" "SECID80"
8776 .cindex "empty item in hosts list"
8777 .cindex "host list" "empty string in"
8778 If a host list item is the empty string, it matches only when no remote host is
8779 involved. This is the case when a message is being received from a local
8780 process using SMTP on the standard input, that is, when a TCP/IP connection is
8781 not used.
8782
8783 .cindex "asterisk" "in host list"
8784 The special pattern &"*"& in a host list matches any host or no host. Neither
8785 the IP address nor the name is actually inspected.
8786
8787
8788
8789 .section "Host list patterns that match by IP address" "SECThoslispatip"
8790 .cindex "host list" "matching IP addresses"
8791 If an IPv4 host calls an IPv6 host and the call is accepted on an IPv6 socket,
8792 the incoming address actually appears in the IPv6 host as
8793 &`::ffff:`&<&'v4address'&>. When such an address is tested against a host
8794 list, it is converted into a traditional IPv4 address first. (Not all operating
8795 systems accept IPv4 calls on IPv6 sockets, as there have been some security
8796 concerns.)
8797
8798 The following types of pattern in a host list check the remote host by
8799 inspecting its IP address:
8800
8801 .ilist
8802 If the pattern is a plain domain name (not a regular expression, not starting
8803 with *, not a lookup of any kind), Exim calls the operating system function
8804 to find the associated IP address(es). Exim uses the newer
8805 &[getipnodebyname()]& function when available, otherwise &[gethostbyname()]&.
8806 This typically causes a forward DNS lookup of the name. The result is compared
8807 with the IP address of the subject host.
8808
8809 If there is a temporary problem (such as a DNS timeout) with the host name
8810 lookup, a temporary error occurs. For example, if the list is being used in an
8811 ACL condition, the ACL gives a &"defer"& response, usually leading to a
8812 temporary SMTP error code. If no IP address can be found for the host name,
8813 what happens is described in section &<<SECTbehipnot>>& below.
8814
8815 .next
8816 .cindex "@ in a host list"
8817 If the pattern is &"@"&, the primary host name is substituted and used as a
8818 domain name, as just described.
8819
8820 .next
8821 If the pattern is an IP address, it is matched against the IP address of the
8822 subject host. IPv4 addresses are given in the normal &"dotted-quad"& notation.
8823 IPv6 addresses can be given in colon-separated format, but the colons have to
8824 be doubled so as not to be taken as item separators when the default list
8825 separator is used. IPv6 addresses are recognized even when Exim is compiled
8826 without IPv6 support. This means that if they appear in a host list on an
8827 IPv4-only host, Exim will not treat them as host names. They are just addresses
8828 that can never match a client host.
8829
8830 .next
8831 .cindex "@[] in a host list"
8832 If the pattern is &"@[]"&, it matches the IP address of any IP interface on
8833 the local host. For example, if the local host is an IPv4 host with one
8834 interface address 10.45.23.56, these two ACL statements have the same effect:
8835 .code
8836 accept hosts = 127.0.0.1 : 10.45.23.56
8837 accept hosts = @[]
8838 .endd
8839 .next
8840 .cindex "CIDR notation"
8841 If the pattern is an IP address followed by a slash and a mask length (for
8842 example 10.11.42.0/24), it is matched against the IP address of the subject
8843 host under the given mask. This allows, an entire network of hosts to be
8844 included (or excluded) by a single item. The mask uses CIDR notation; it
8845 specifies the number of address bits that must match, starting from the most
8846 significant end of the address.
8847
8848 &*Note*&: The mask is &'not'& a count of addresses, nor is it the high number
8849 of a range of addresses. It is the number of bits in the network portion of the
8850 address. The above example specifies a 24-bit netmask, so it matches all 256
8851 addresses in the 10.11.42.0 network. An item such as
8852 .code
8853 192.168.23.236/31
8854 .endd
8855 matches just two addresses, 192.168.23.236 and 192.168.23.237. A mask value of
8856 32 for an IPv4 address is the same as no mask at all; just a single address
8857 matches.
8858
8859 Here is another example which shows an IPv4 and an IPv6 network:
8860 .code
8861 recipient_unqualified_hosts = 192.168.0.0/16: \
8862                               3ffe::ffff::836f::::/48
8863 .endd
8864 The doubling of list separator characters applies only when these items
8865 appear inline in a host list. It is not required when indirecting via a file.
8866 For example:
8867 .code
8868 recipient_unqualified_hosts = /opt/exim/unqualnets
8869 .endd
8870 could make use of a file containing
8871 .code
8872 172.16.0.0/12
8873 3ffe:ffff:836f::/48
8874 .endd
8875 to have exactly the same effect as the previous example. When listing IPv6
8876 addresses inline, it is usually more convenient to use the facility for
8877 changing separator characters. This list contains the same two networks:
8878 .code
8879 recipient_unqualified_hosts = <; 172.16.0.0/12; \
8880                                  3ffe:ffff:836f::/48
8881 .endd
8882 The separator is changed to semicolon by the leading &"<;"& at the start of the
8883 list.
8884 .endlist
8885
8886
8887
8888 .section "Host list patterns for single-key lookups by host address" &&&
8889          "SECThoslispatsikey"
8890 .cindex "host list" "lookup of IP address"
8891 When a host is to be identified by a single-key lookup of its complete IP
8892 address, the pattern takes this form:
8893 .display
8894 &`net-<`&&'single-key-search-type'&&`>;<`&&'search-data'&&`>`&
8895 .endd
8896 For example:
8897 .code
8898 hosts_lookup = net-cdb;/hosts-by-ip.db
8899 .endd
8900 The text form of the IP address of the subject host is used as the lookup key.
8901 IPv6 addresses are converted to an unabbreviated form, using lower case
8902 letters, with dots as separators because colon is the key terminator in
8903 &(lsearch)& files. [Colons can in fact be used in keys in &(lsearch)& files by
8904 quoting the keys, but this is a facility that was added later.] The data
8905 returned by the lookup is not used.
8906
8907 .cindex "IP address" "masking"
8908 .cindex "host list" "masked IP address"
8909 Single-key lookups can also be performed using masked IP addresses, using
8910 patterns of this form:
8911 .display
8912 &`net<`&&'number'&&`>-<`&&'single-key-search-type'&&`>;<`&&'search-data'&&`>`&
8913 .endd
8914 For example:
8915 .code
8916 net24-dbm;/networks.db
8917 .endd
8918 The IP address of the subject host is masked using <&'number'&> as the mask
8919 length. A textual string is constructed from the masked value, followed by the
8920 mask, and this is used as the lookup key. For example, if the host's IP address
8921 is 192.168.34.6, the key that is looked up for the above example is
8922 &"192.168.34.0/24"&.
8923
8924 When an IPv6 address is converted to a string, dots are normally used instead
8925 of colons, so that keys in &(lsearch)& files need not contain colons (which
8926 terminate &(lsearch)& keys). This was implemented some time before the ability
8927 to quote keys was made available in &(lsearch)& files. However, the more
8928 recently implemented &(iplsearch)& files do require colons in IPv6 keys
8929 (notated using the quoting facility) so as to distinguish them from IPv4 keys.
8930 For this reason, when the lookup type is &(iplsearch)&, IPv6 addresses are
8931 converted using colons and not dots.
8932 In all cases except IPv4-mapped IPv6, full, unabbreviated IPv6
8933 addresses are always used.
8934 The latter are converted to IPv4 addresses, in dotted-quad form.
8935
8936 Ideally, it would be nice to tidy up this anomalous situation by changing to
8937 colons in all cases, given that quoting is now available for &(lsearch)&.
8938 However, this would be an incompatible change that might break some existing
8939 configurations.
8940
8941 &*Warning*&: Specifying &%net32-%& (for an IPv4 address) or &%net128-%& (for an
8942 IPv6 address) is not the same as specifying just &%net-%& without a number. In
8943 the former case the key strings include the mask value, whereas in the latter
8944 case the IP address is used on its own.
8945
8946
8947
8948 .section "Host list patterns that match by host name" "SECThoslispatnam"
8949 .cindex "host" "lookup failures"
8950 .cindex "unknown host name"
8951 .cindex "host list" "matching host name"
8952 There are several types of pattern that require Exim to know the name of the
8953 remote host. These are either wildcard patterns or lookups by name. (If a
8954 complete hostname is given without any wildcarding, it is used to find an IP
8955 address to match against, as described in section &<<SECThoslispatip>>&
8956 above.)
8957
8958 If the remote host name is not already known when Exim encounters one of these
8959 patterns, it has to be found from the IP address.
8960 Although many sites on the Internet are conscientious about maintaining reverse
8961 DNS data for their hosts, there are also many that do not do this.
8962 Consequently, a name cannot always be found, and this may lead to unwanted
8963 effects. Take care when configuring host lists with wildcarded name patterns.
8964 Consider what will happen if a name cannot be found.
8965
8966 Because of the problems of determining host names from IP addresses, matching
8967 against host names is not as common as matching against IP addresses.
8968
8969 By default, in order to find a host name, Exim first does a reverse DNS lookup;
8970 if no name is found in the DNS, the system function (&[gethostbyaddr()]& or
8971 &[getipnodebyaddr()]& if available) is tried. The order in which these lookups
8972 are done can be changed by setting the &%host_lookup_order%& option. For
8973 security, once Exim has found one or more names, it looks up the IP addresses
8974 for these names and compares them with the IP address that it started with.
8975 Only those names whose IP addresses match are accepted. Any other names are
8976 discarded. If no names are left, Exim behaves as if the host name cannot be
8977 found. In the most common case there is only one name and one IP address.
8978
8979 There are some options that control what happens if a host name cannot be
8980 found. These are described in section &<<SECTbehipnot>>& below.
8981
8982 .cindex "host" "alias for"
8983 .cindex "alias for host"
8984 As a result of aliasing, hosts may have more than one name. When processing any
8985 of the following types of pattern, all the host's names are checked:
8986
8987 .ilist
8988 .cindex "asterisk" "in host list"
8989 If a pattern starts with &"*"& the remainder of the item must match the end of
8990 the host name. For example, &`*.b.c`& matches all hosts whose names end in
8991 &'.b.c'&. This special simple form is provided because this is a very common
8992 requirement. Other kinds of wildcarding require the use of a regular
8993 expression.
8994 .next
8995 .cindex "regular expressions" "in host list"
8996 .cindex "host list" "regular expression in"
8997 If the item starts with &"^"& it is taken to be a regular expression which is
8998 matched against the host name. Host names are case-independent, so this regular
8999 expression match is by default case-independent, but you can make it
9000 case-dependent by starting it with &`(?-i)`&. References to descriptions of the
9001 syntax of regular expressions are given in chapter &<<CHAPregexp>>&. For
9002 example,
9003 .code
9004 ^(a|b)\.c\.d$
9005 .endd
9006 is a regular expression that matches either of the two hosts &'a.c.d'& or
9007 &'b.c.d'&. When a regular expression is used in a host list, you must take care
9008 that backslash and dollar characters are not misinterpreted as part of the
9009 string expansion. The simplest way to do this is to use &`\N`& to mark that
9010 part of the string as non-expandable. For example:
9011 .code
9012 sender_unqualified_hosts = \N^(a|b)\.c\.d$\N : ....
9013 .endd
9014 &*Warning*&: If you want to match a complete host name, you must include the
9015 &`$`& terminating metacharacter in the regular expression, as in the above
9016 example. Without it, a match at the start of the host name is all that is
9017 required.
9018 .endlist
9019
9020
9021
9022
9023 .section "Behaviour when an IP address or name cannot be found" "SECTbehipnot"
9024 .cindex "host" "lookup failures, permanent"
9025 While processing a host list, Exim may need to look up an IP address from a
9026 name (see section &<<SECThoslispatip>>&), or it may need to look up a host name
9027 from an IP address (see section &<<SECThoslispatnam>>&). In either case, the
9028 behaviour when it fails to find the information it is seeking is the same.
9029
9030 &*Note*&: This section applies to permanent lookup failures. It does &'not'&
9031 apply to temporary DNS errors, whose handling is described in the next section.
9032
9033 .cindex "&`+include_unknown`&"
9034 .cindex "&`+ignore_unknown`&"
9035 Exim parses a host list from left to right. If it encounters a permanent
9036 lookup failure in any item in the host list before it has found a match,
9037 Exim treats it as a failure and the default behavior is as if the host
9038 does not match the list. This may not always be what you want to happen.
9039 To change Exim's behaviour, the special items &`+include_unknown`& or
9040 &`+ignore_unknown`& may appear in the list (at top level &-- they are
9041 not recognized in an indirected file).
9042
9043 .ilist
9044 If any item that follows &`+include_unknown`& requires information that
9045 cannot found, Exim behaves as if the host does match the list. For example,
9046 .code
9047 host_reject_connection = +include_unknown:*.enemy.ex
9048 .endd
9049 rejects connections from any host whose name matches &`*.enemy.ex`&, and also
9050 any hosts whose name it cannot find.
9051
9052 .next
9053 If any item that follows &`+ignore_unknown`& requires information that cannot
9054 be found, Exim ignores that item and proceeds to the rest of the list. For
9055 example:
9056 .code
9057 accept hosts = +ignore_unknown : friend.example : \
9058                192.168.4.5
9059 .endd
9060 accepts from any host whose name is &'friend.example'& and from 192.168.4.5,
9061 whether or not its host name can be found. Without &`+ignore_unknown`&, if no
9062 name can be found for 192.168.4.5, it is rejected.
9063 .endlist
9064
9065 Both &`+include_unknown`& and &`+ignore_unknown`& may appear in the same
9066 list. The effect of each one lasts until the next, or until the end of the
9067 list.
9068
9069 .section "Mixing wildcarded host names and addresses in host lists" &&&
9070          "SECTmixwilhos"
9071 .cindex "host list" "mixing names and addresses in"
9072
9073 This section explains the host/ip processing logic with the same concepts
9074 as the previous section, but specifically addresses what happens when a
9075 wildcarded hostname is one of the items in the hostlist.
9076
9077 .ilist
9078 If you have name lookups or wildcarded host names and
9079 IP addresses in the same host list, you should normally put the IP
9080 addresses first. For example, in an ACL you could have:
9081 .code
9082 accept hosts = 10.9.8.7 : *.friend.example
9083 .endd
9084 The reason you normally would order it this way lies in the
9085 left-to-right way that Exim processes lists.  It can test IP addresses
9086 without doing any DNS lookups, but when it reaches an item that requires
9087 a host name, it fails if it cannot find a host name to compare with the
9088 pattern. If the above list is given in the opposite order, the
9089 &%accept%& statement fails for a host whose name cannot be found, even
9090 if its IP address is 10.9.8.7.
9091
9092 .next
9093 If you really do want to do the name check first, and still recognize the IP
9094 address, you can rewrite the ACL like this:
9095 .code
9096 accept hosts = *.friend.example
9097 accept hosts = 10.9.8.7
9098 .endd
9099 If the first &%accept%& fails, Exim goes on to try the second one. See chapter
9100 &<<CHAPACL>>& for details of ACLs. Alternatively, you can use
9101 &`+ignore_unknown`&, which was discussed in depth in the first example in
9102 this section.
9103 .endlist
9104
9105
9106 .section "Temporary DNS errors when looking up host information" &&&
9107          "SECTtemdnserr"
9108 .cindex "host" "lookup failures, temporary"
9109 .cindex "&`+include_defer`&"
9110 .cindex "&`+ignore_defer`&"
9111 A temporary DNS lookup failure normally causes a defer action (except when
9112 &%dns_again_means_nonexist%& converts it into a permanent error). However,
9113 host lists can include &`+ignore_defer`& and &`+include_defer`&, analogous to
9114 &`+ignore_unknown`& and &`+include_unknown`&, as described in the previous
9115 section. These options should be used with care, probably only in non-critical
9116 host lists such as whitelists.
9117
9118
9119
9120 .section "Host list patterns for single-key lookups by host name" &&&
9121          "SECThoslispatnamsk"
9122 .cindex "unknown host name"
9123 .cindex "host list" "matching host name"
9124 If a pattern is of the form
9125 .display
9126 <&'single-key-search-type'&>;<&'search-data'&>
9127 .endd
9128 for example
9129 .code
9130 dbm;/host/accept/list
9131 .endd
9132 a single-key lookup is performed, using the host name as its key. If the
9133 lookup succeeds, the host matches the item. The actual data that is looked up
9134 is not used.
9135
9136 &*Reminder*&: With this kind of pattern, you must have host &'names'& as
9137 keys in the file, not IP addresses. If you want to do lookups based on IP
9138 addresses, you must precede the search type with &"net-"& (see section
9139 &<<SECThoslispatsikey>>&). There is, however, no reason why you could not use
9140 two items in the same list, one doing an address lookup and one doing a name
9141 lookup, both using the same file.
9142
9143
9144
9145 .section "Host list patterns for query-style lookups" "SECID81"
9146 If a pattern is of the form
9147 .display
9148 <&'query-style-search-type'&>;<&'query'&>
9149 .endd
9150 the query is obeyed, and if it succeeds, the host matches the item. The actual
9151 data that is looked up is not used. The variables &$sender_host_address$& and
9152 &$sender_host_name$& can be used in the query. For example:
9153 .code
9154 hosts_lookup = pgsql;\
9155   select ip from hostlist where ip='$sender_host_address'
9156 .endd
9157 The value of &$sender_host_address$& for an IPv6 address contains colons. You
9158 can use the &%sg%& expansion item to change this if you need to. If you want to
9159 use masked IP addresses in database queries, you can use the &%mask%& expansion
9160 operator.
9161
9162 If the query contains a reference to &$sender_host_name$&, Exim automatically
9163 looks up the host name if it has not already done so. (See section
9164 &<<SECThoslispatnam>>& for comments on finding host names.)
9165
9166 Historical note: prior to release 4.30, Exim would always attempt to find a
9167 host name before running the query, unless the search type was preceded by
9168 &`net-`&. This is no longer the case. For backwards compatibility, &`net-`& is
9169 still recognized for query-style lookups, but its presence or absence has no
9170 effect. (Of course, for single-key lookups, &`net-`& &'is'& important.
9171 See section &<<SECThoslispatsikey>>&.)
9172
9173
9174
9175
9176
9177 .section "Address lists" "SECTaddresslist"
9178 .cindex "list" "address list"
9179 .cindex "address list" "empty item"
9180 .cindex "address list" "patterns"
9181 Address lists contain patterns that are matched against mail addresses. There
9182 is one special case to be considered: the sender address of a bounce message is
9183 always empty. You can test for this by providing an empty item in an address
9184 list. For example, you can set up a router to process bounce messages by
9185 using this option setting:
9186 .code
9187 senders = :
9188 .endd
9189 The presence of the colon creates an empty item. If you do not provide any
9190 data, the list is empty and matches nothing. The empty sender can also be
9191 detected by a regular expression that matches an empty string,
9192 and by a query-style lookup that succeeds when &$sender_address$& is empty.
9193
9194 Non-empty items in an address list can be straightforward email addresses. For
9195 example:
9196 .code
9197 senders = jbc@askone.example : hs@anacreon.example
9198 .endd
9199 A certain amount of wildcarding is permitted. If a pattern contains an @
9200 character, but is not a regular expression and does not begin with a
9201 semicolon-terminated lookup type (described below), the local part of the
9202 subject address is compared with the local part of the pattern, which may start
9203 with an asterisk. If the local parts match, the domain is checked in exactly
9204 the same way as for a pattern in a domain list. For example, the domain can be
9205 wildcarded, refer to a named list, or be a lookup:
9206 .code
9207 deny senders = *@*.spamming.site:\
9208                *@+hostile_domains:\
9209                bozo@partial-lsearch;/list/of/dodgy/sites:\
9210                *@dbm;/bad/domains.db
9211 .endd
9212 .cindex "local part" "starting with !"
9213 .cindex "address list" "local part starting with !"
9214 If a local part that begins with an exclamation mark is required, it has to be
9215 specified using a regular expression, because otherwise the exclamation mark is
9216 treated as a sign of negation, as is standard in lists.
9217
9218 If a non-empty pattern that is not a regular expression or a lookup does not
9219 contain an @ character, it is matched against the domain part of the subject
9220 address. The only two formats that are recognized this way are a literal
9221 domain, or a domain pattern that starts with *. In both these cases, the effect
9222 is the same as if &`*@`& preceded the pattern. For example:
9223 .code
9224 deny senders = enemy.domain : *.enemy.domain
9225 .endd
9226
9227 The following kinds of more complicated address list pattern can match any
9228 address, including the empty address that is characteristic of bounce message
9229 senders:
9230
9231 .ilist
9232 .cindex "regular expressions" "in address list"
9233 .cindex "address list" "regular expression in"
9234 If (after expansion) a pattern starts with &"^"&, a regular expression match is
9235 done against the complete address, with the pattern as the regular expression.
9236 You must take care that backslash and dollar characters are not misinterpreted
9237 as part of the string expansion. The simplest way to do this is to use &`\N`&
9238 to mark that part of the string as non-expandable. For example:
9239 .code
9240 deny senders = \N^.*this.*@example\.com$\N : \
9241                \N^\d{8}.+@spamhaus.example$\N : ...
9242 .endd
9243 The &`\N`& sequences are removed by the expansion, so these items do indeed
9244 start with &"^"& by the time they are being interpreted as address patterns.
9245
9246 .next
9247 .cindex "address list" "lookup for complete address"
9248 Complete addresses can be looked up by using a pattern that starts with a
9249 lookup type terminated by a semicolon, followed by the data for the lookup. For
9250 example:
9251 .code
9252 deny senders = cdb;/etc/blocked.senders : \
9253   mysql;select address from blocked where \
9254   address='${quote_mysql:$sender_address}'
9255 .endd
9256 Both query-style and single-key lookup types can be used. For a single-key
9257 lookup type, Exim uses the complete address as the key. However, empty keys are
9258 not supported for single-key lookups, so a match against the empty address
9259 always fails. This restriction does not apply to query-style lookups.
9260
9261 Partial matching for single-key lookups (section &<<SECTpartiallookup>>&)
9262 cannot be used, and is ignored if specified, with an entry being written to the
9263 panic log.
9264 .cindex "*@ with single-key lookup"
9265 However, you can configure lookup defaults, as described in section
9266 &<<SECTdefaultvaluelookups>>&, but this is useful only for the &"*@"& type of
9267 default. For example, with this lookup:
9268 .code
9269 accept senders = lsearch*@;/some/file
9270 .endd
9271 the file could contains lines like this:
9272 .code
9273 user1@domain1.example
9274 *@domain2.example
9275 .endd
9276 and for the sender address &'nimrod@jaeger.example'&, the sequence of keys
9277 that are tried is:
9278 .code
9279 nimrod@jaeger.example
9280 *@jaeger.example
9281 *
9282 .endd
9283 &*Warning 1*&: Do not include a line keyed by &"*"& in the file, because that
9284 would mean that every address matches, thus rendering the test useless.
9285
9286 &*Warning 2*&: Do not confuse these two kinds of item:
9287 .code
9288 deny recipients = dbm*@;/some/file
9289 deny recipients = *@dbm;/some/file
9290 .endd
9291 The first does a whole address lookup, with defaulting, as just described,
9292 because it starts with a lookup type. The second matches the local part and
9293 domain independently, as described in a bullet point below.
9294 .endlist
9295
9296
9297 The following kinds of address list pattern can match only non-empty addresses.
9298 If the subject address is empty, a match against any of these pattern types
9299 always fails.
9300
9301
9302 .ilist
9303 .cindex "@@ with single-key lookup"
9304 .cindex "address list" "@@ lookup type"
9305 .cindex "address list" "split local part and domain"
9306 If a pattern starts with &"@@"& followed by a single-key lookup item
9307 (for example, &`@@lsearch;/some/file`&), the address that is being checked is
9308 split into a local part and a domain. The domain is looked up in the file. If
9309 it is not found, there is no match. If it is found, the data that is looked up
9310 from the file is treated as a colon-separated list of local part patterns, each
9311 of which is matched against the subject local part in turn.
9312
9313 .cindex "asterisk" "in address list"
9314 The lookup may be a partial one, and/or one involving a search for a default
9315 keyed by &"*"& (see section &<<SECTdefaultvaluelookups>>&). The local part
9316 patterns that are looked up can be regular expressions or begin with &"*"&, or
9317 even be further lookups. They may also be independently negated. For example,
9318 with
9319 .code
9320 deny senders = @@dbm;/etc/reject-by-domain
9321 .endd
9322 the data from which the DBM file is built could contain lines like
9323 .code
9324 baddomain.com:  !postmaster : *
9325 .endd
9326 to reject all senders except &%postmaster%& from that domain.
9327
9328 .cindex "local part" "starting with !"
9329 If a local part that actually begins with an exclamation mark is required, it
9330 has to be specified using a regular expression. In &(lsearch)& files, an entry
9331 may be split over several lines by indenting the second and subsequent lines,
9332 but the separating colon must still be included at line breaks. White space
9333 surrounding the colons is ignored. For example:
9334 .code
9335 aol.com:  spammer1 : spammer2 : ^[0-9]+$ :
9336   spammer3 : spammer4
9337 .endd
9338 As in all colon-separated lists in Exim, a colon can be included in an item by
9339 doubling.
9340
9341 If the last item in the list starts with a right angle-bracket, the remainder
9342 of the item is taken as a new key to look up in order to obtain a continuation
9343 list of local parts. The new key can be any sequence of characters. Thus one
9344 might have entries like
9345 .code
9346 aol.com: spammer1 : spammer 2 : >*
9347 xyz.com: spammer3 : >*
9348 *:       ^\d{8}$
9349 .endd
9350 in a file that was searched with &%@@dbm*%&, to specify a match for 8-digit
9351 local parts for all domains, in addition to the specific local parts listed for
9352 each domain. Of course, using this feature costs another lookup each time a
9353 chain is followed, but the effort needed to maintain the data is reduced.
9354
9355 .cindex "loop" "in lookups"
9356 It is possible to construct loops using this facility, and in order to catch
9357 them, the chains may be no more than fifty items long.
9358
9359 .next
9360 The @@<&'lookup'&> style of item can also be used with a query-style
9361 lookup, but in this case, the chaining facility is not available. The lookup
9362 can only return a single list of local parts.
9363 .endlist
9364
9365 &*Warning*&: There is an important difference between the address list items
9366 in these two examples:
9367 .code
9368 senders = +my_list
9369 senders = *@+my_list
9370 .endd
9371 In the first one, &`my_list`& is a named address list, whereas in the second
9372 example it is a named domain list.
9373
9374
9375
9376
9377 .section "Case of letters in address lists" "SECTcasletadd"
9378 .cindex "case of local parts"
9379 .cindex "address list" "case forcing"
9380 .cindex "case forcing in address lists"
9381 Domains in email addresses are always handled caselessly, but for local parts
9382 case may be significant on some systems (see &%caseful_local_part%& for how
9383 Exim deals with this when routing addresses). However, RFC 2505 (&'Anti-Spam
9384 Recommendations for SMTP MTAs'&) suggests that matching of addresses to
9385 blocking lists should be done in a case-independent manner. Since most address
9386 lists in Exim are used for this kind of control, Exim attempts to do this by
9387 default.
9388
9389 The domain portion of an address is always lowercased before matching it to an
9390 address list. The local part is lowercased by default, and any string
9391 comparisons that take place are done caselessly. This means that the data in
9392 the address list itself, in files included as plain filenames, and in any file
9393 that is looked up using the &"@@"& mechanism, can be in any case. However, the
9394 keys in files that are looked up by a search type other than &(lsearch)& (which
9395 works caselessly) must be in lower case, because these lookups are not
9396 case-independent.
9397
9398 .cindex "&`+caseful`&"
9399 To allow for the possibility of caseful address list matching, if an item in
9400 an address list is the string &"+caseful"&, the original case of the local
9401 part is restored for any comparisons that follow, and string comparisons are no
9402 longer case-independent. This does not affect the domain, which remains in
9403 lower case. However, although independent matches on the domain alone are still
9404 performed caselessly, regular expressions that match against an entire address
9405 become case-sensitive after &"+caseful"& has been seen.
9406
9407
9408
9409 .section "Local part lists" "SECTlocparlis"
9410 .cindex "list" "local part list"
9411 .cindex "local part" "list"
9412 Case-sensitivity in local part lists is handled in the same way as for address
9413 lists, as just described. The &"+caseful"& item can be used if required. In a
9414 setting of the &%local_parts%& option in a router with &%caseful_local_part%&
9415 set false, the subject is lowercased and the matching is initially
9416 case-insensitive. In this case, &"+caseful"& will restore case-sensitive
9417 matching in the local part list, but not elsewhere in the router. If
9418 &%caseful_local_part%& is set true in a router, matching in the &%local_parts%&
9419 option is case-sensitive from the start.
9420
9421 If a local part list is indirected to a file (see section &<<SECTfilnamlis>>&),
9422 comments are handled in the same way as address lists &-- they are recognized
9423 only if the # is preceded by white space or the start of the line.
9424 Otherwise, local part lists are matched in the same way as domain lists, except
9425 that the special items that refer to the local host (&`@`&, &`@[]`&,
9426 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`&) are not recognized.
9427 Refer to section &<<SECTdomainlist>>& for details of the other available item
9428 types.
9429 .ecindex IIDdohoadli
9430
9431
9432
9433
9434 . ////////////////////////////////////////////////////////////////////////////
9435 . ////////////////////////////////////////////////////////////////////////////
9436
9437 .chapter "String expansions" "CHAPexpand"
9438 .scindex IIDstrexp "expansion" "of strings"
9439 Many strings in Exim's runtime configuration are expanded before use. Some of
9440 them are expanded every time they are used; others are expanded only once.
9441
9442 When a string is being expanded it is copied verbatim from left to right except
9443 .cindex expansion "string concatenation"
9444 when a dollar or backslash character is encountered. A dollar specifies the
9445 start of a portion of the string that is interpreted and replaced as described
9446 below in section &<<SECTexpansionitems>>& onwards. Backslash is used as an
9447 escape character, as described in the following section.
9448
9449 Whether a string is expanded depends upon the context.  Usually this is solely
9450 dependent upon the option for which a value is sought; in this documentation,
9451 options for which string expansion is performed are marked with &dagger; after
9452 the data type.  ACL rules always expand strings.  A couple of expansion
9453 conditions do not expand some of the brace-delimited branches, for security
9454 reasons,
9455 .cindex "tainted data" expansion
9456 .cindex expansion "tainted data"
9457 and expansion of data deriving from the sender (&"tainted data"&)
9458 is not permitted.
9459
9460
9461
9462 .section "Literal text in expanded strings" "SECTlittext"
9463 .cindex "expansion" "including literal text"
9464 An uninterpreted dollar can be included in an expanded string by putting a
9465 backslash in front of it. A backslash can be used to prevent any special
9466 character being treated specially in an expansion, including backslash itself.
9467 If the string appears in quotes in the configuration file, two backslashes are
9468 required because the quotes themselves cause interpretation of backslashes when
9469 the string is read in (see section &<<SECTstrings>>&).
9470
9471 .cindex "expansion" "non-expandable substrings"
9472 A portion of the string can specified as non-expandable by placing it between
9473 two occurrences of &`\N`&. This is particularly useful for protecting regular
9474 expressions, which often contain backslashes and dollar signs. For example:
9475 .code
9476 deny senders = \N^\d{8}[a-z]@some\.site\.example$\N
9477 .endd
9478 On encountering the first &`\N`&, the expander copies subsequent characters
9479 without interpretation until it reaches the next &`\N`& or the end of the
9480 string.
9481
9482
9483
9484 .section "Character escape sequences in expanded strings" "SECID82"
9485 .cindex "expansion" "escape sequences"
9486 A backslash followed by one of the letters &"n"&, &"r"&, or &"t"& in an
9487 expanded string is recognized as an escape sequence for the character newline,
9488 carriage return, or tab, respectively. A backslash followed by up to three
9489 octal digits is recognized as an octal encoding for a single character, and a
9490 backslash followed by &"x"& and up to two hexadecimal digits is a hexadecimal
9491 encoding.
9492
9493 These escape sequences are also recognized in quoted strings when they are read
9494 in. Their interpretation in expansions as well is useful for unquoted strings,
9495 and for other cases such as looked-up strings that are then expanded.
9496
9497
9498 .section "Testing string expansions" "SECID83"
9499 .cindex "expansion" "testing"
9500 .cindex "testing" "string expansion"
9501 .oindex "&%-be%&"
9502 Many expansions can be tested by calling Exim with the &%-be%& option. This
9503 takes the command arguments, or lines from the standard input if there are no
9504 arguments, runs them through the string expansion code, and writes the results
9505 to the standard output. Variables based on configuration values are set up, but
9506 since no message is being processed, variables such as &$local_part$& have no
9507 value. Nevertheless the &%-be%& option can be useful for checking out file and
9508 database lookups, and the use of expansion operators such as &%sg%&, &%substr%&
9509 and &%nhash%&.
9510
9511 Exim gives up its root privilege when it is called with the &%-be%& option, and
9512 instead runs under the uid and gid it was called with, to prevent users from
9513 using &%-be%& for reading files to which they do not have access.
9514
9515 .oindex "&%-bem%&"
9516 If you want to test expansions that include variables whose values are taken
9517 from a message, there are two other options that can be used. The &%-bem%&
9518 option is like &%-be%& except that it is followed by a filename. The file is
9519 read as a message before doing the test expansions. For example:
9520 .code
9521 exim -bem /tmp/test.message '$h_subject:'
9522 .endd
9523 The &%-Mset%& option is used in conjunction with &%-be%& and is followed by an
9524 Exim message identifier. For example:
9525 .code
9526 exim -be -Mset 1GrA8W-0004WS-LQ '$recipients'
9527 .endd
9528 This loads the message from Exim's spool before doing the test expansions, and
9529 is therefore restricted to admin users.
9530
9531
9532 .section "Forced expansion failure" "SECTforexpfai"
9533 .cindex "expansion" "forced failure"
9534 A number of expansions that are described in the following section have
9535 alternative &"true"& and &"false"& substrings, enclosed in brace characters
9536 (which are sometimes called &"curly brackets"&). Which of the two strings is
9537 used depends on some condition that is evaluated as part of the expansion. If,
9538 instead of a &"false"& substring, the word &"fail"& is used (not in braces),
9539 the entire string expansion fails in a way that can be detected by the code
9540 that requested the expansion. This is called &"forced expansion failure"&, and
9541 its consequences depend on the circumstances. In some cases it is no different
9542 from any other expansion failure, but in others a different action may be
9543 taken. Such variations are mentioned in the documentation of the option that is
9544 being expanded.
9545
9546
9547
9548
9549 .section "Expansion items" "SECTexpansionitems"
9550 The following items are recognized in expanded strings. White space may be used
9551 between sub-items that are keywords or substrings enclosed in braces inside an
9552 outer set of braces, to improve readability. &*Warning*&: Within braces,
9553 white space is significant.
9554
9555 .vlist
9556 .vitem &*$*&<&'variable&~name'&>&~or&~&*${*&<&'variable&~name'&>&*}*&
9557 .cindex "expansion" "variables"
9558 Substitute the contents of the named variable, for example:
9559 .code
9560 $local_part
9561 ${domain}
9562 .endd
9563 The second form can be used to separate the name from subsequent alphanumeric
9564 characters. This form (using braces) is available only for variables; it does
9565 &'not'& apply to message headers. The names of the variables are given in
9566 section &<<SECTexpvar>>& below. If the name of a non-existent variable is
9567 given, the expansion fails.
9568
9569 .vitem &*${*&<&'op'&>&*:*&<&'string'&>&*}*&
9570 .cindex "expansion" "operators"
9571 The string is first itself expanded, and then the operation specified by
9572 <&'op'&> is applied to it. For example:
9573 .code
9574 ${lc:$local_part}
9575 .endd
9576 The string starts with the first character after the colon, which may be
9577 leading white space. A list of operators is given in section &<<SECTexpop>>&
9578 below. The operator notation is used for simple expansion items that have just
9579 one argument, because it reduces the number of braces and therefore makes the
9580 string easier to understand.
9581
9582 .vitem &*$bheader_*&<&'header&~name'&>&*:*&&~or&~&*$bh_*&<&'header&~name'&>&*:*&
9583 This item inserts &"basic"& header lines. It is described with the &%header%&
9584 expansion item below.
9585
9586
9587 .vitem "&*${acl{*&<&'name'&>&*}{*&<&'arg'&>&*}...}*&"
9588 .cindex "expansion" "calling an acl"
9589 .cindex "&%acl%&" "call from expansion"
9590 The name and zero to nine argument strings are first expanded separately.  The expanded
9591 arguments are assigned to the variables &$acl_arg1$& to &$acl_arg9$& in order.
9592 Any unused are made empty.  The variable &$acl_narg$& is set to the number of
9593 arguments.  The named ACL (see chapter &<<CHAPACL>>&) is called
9594 and may use the variables; if another acl expansion is used the values
9595 are restored after it returns.  If the ACL sets
9596 a value using a "message =" modifier and returns accept or deny, the value becomes
9597 the result of the expansion.
9598 If no message is set and the ACL returns accept or deny
9599 the expansion result is an empty string.
9600 If the ACL returns defer the result is a forced-fail.  Otherwise the expansion fails.
9601
9602
9603 .vitem "&*${authresults{*&<&'authserv-id'&>&*}}*&"
9604 .cindex authentication "results header"
9605 .cindex headers "authentication-results:"
9606 .cindex authentication "expansion item"
9607 This item returns a string suitable for insertion as an
9608 &'Authentication-Results:'&
9609 header line.
9610 The given <&'authserv-id'&> is included in the result; typically this
9611 will be a domain name identifying the system performing the authentications.
9612 Methods that might be present in the result include:
9613 .code
9614 none
9615 iprev
9616 auth
9617 spf
9618 dkim
9619 .endd
9620
9621 Example use (as an ACL modifier):
9622 .code
9623       add_header = :at_start:${authresults {$primary_hostname}}
9624 .endd
9625 This is safe even if no authentication results are available.
9626
9627
9628 .vitem "&*${certextract{*&<&'field'&>&*}{*&<&'certificate'&>&*}&&&
9629        {*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9630 .cindex "expansion" "extracting certificate fields"
9631 .cindex "&%certextract%&" "certificate fields"
9632 .cindex "certificate" "extracting fields"
9633 The <&'certificate'&> must be a variable of type certificate.
9634 The field name is expanded and used to retrieve the relevant field from
9635 the certificate.  Supported fields are:
9636 .display
9637 &`version        `&
9638 &`serial_number  `&
9639 &`subject        `& RFC4514 DN
9640 &`issuer         `& RFC4514 DN
9641 &`notbefore      `& time
9642 &`notafter       `& time
9643 &`sig_algorithm  `&
9644 &`signature      `&
9645 &`subj_altname   `& tagged list
9646 &`ocsp_uri       `& list
9647 &`crl_uri        `& list
9648 .endd
9649 If the field is found,
9650 <&'string2'&> is expanded, and replaces the whole item;
9651 otherwise <&'string3'&> is used. During the expansion of <&'string2'&> the
9652 variable &$value$& contains the value that has been extracted. Afterwards, it
9653 is restored to any previous value it might have had.
9654
9655 If {<&'string3'&>} is omitted, the item is replaced by an empty string if the
9656 key is not found. If {<&'string2'&>} is also omitted, the value that was
9657 extracted is used.
9658
9659 Some field names take optional modifiers, appended and separated by commas.
9660
9661 The field selectors marked as "RFC4514" above
9662 output a Distinguished Name string which is
9663 not quite
9664 parseable by Exim as a comma-separated tagged list
9665 (the exceptions being elements containing commas).
9666 RDN elements of a single type may be selected by
9667 a modifier of the type label; if so the expansion
9668 result is a list (newline-separated by default).
9669 The separator may be changed by another modifier of
9670 a right angle-bracket followed immediately by the new separator.
9671 Recognised RDN type labels include "CN", "O", "OU" and "DC".
9672
9673 The field selectors marked as "time" above
9674 take an optional modifier of "int"
9675 for which the result is the number of seconds since epoch.
9676 Otherwise the result is a human-readable string
9677 in the timezone selected by the main "timezone" option.
9678
9679 The field selectors marked as "list" above return a list,
9680 newline-separated by default,
9681 (embedded separator characters in elements are doubled).
9682 The separator may be changed by a modifier of
9683 a right angle-bracket followed immediately by the new separator.
9684
9685 The field selectors marked as "tagged" above
9686 prefix each list element with a type string and an equals sign.
9687 Elements of only one type may be selected by a modifier
9688 which is one of "dns", "uri" or "mail";
9689 if so the element tags are omitted.
9690
9691 If not otherwise noted field values are presented in human-readable form.
9692
9693 .vitem "&*${dlfunc{*&<&'file'&>&*}{*&<&'function'&>&*}{*&<&'arg'&>&*}&&&
9694        {*&<&'arg'&>&*}...}*&"
9695 .cindex &%dlfunc%&
9696 This expansion dynamically loads and then calls a locally-written C function.
9697 This functionality is available only if Exim is compiled with
9698 .code
9699 EXPAND_DLFUNC=yes
9700 .endd
9701 set in &_Local/Makefile_&. Once loaded, Exim remembers the dynamically loaded
9702 object so that it doesn't reload the same object file in the same Exim process
9703 (but of course Exim does start new processes frequently).
9704
9705 There may be from zero to eight arguments to the function.
9706
9707 When compiling
9708 a local function that is to be called in this way,
9709 first &_DLFUNC_IMPL_& should be defined,
9710 and second &_local_scan.h_& should be included.
9711 The Exim variables and functions that are defined by that API
9712 are also available for dynamically loaded functions. The function itself
9713 must have the following type:
9714 .code
9715 int dlfunction(uschar **yield, int argc, uschar *argv[])
9716 .endd
9717 Where &`uschar`& is a typedef for &`unsigned char`& in &_local_scan.h_&. The
9718 function should return one of the following values:
9719
9720 &`OK`&: Success. The string that is placed in the variable &'yield'& is put
9721 into the expanded string that is being built.
9722
9723 &`FAIL`&: A non-forced expansion failure occurs, with the error message taken
9724 from &'yield'&, if it is set.
9725
9726 &`FAIL_FORCED`&: A forced expansion failure occurs, with the error message
9727 taken from &'yield'& if it is set.
9728
9729 &`ERROR`&: Same as &`FAIL`&, except that a panic log entry is written.
9730
9731 When compiling a function that is to be used in this way with gcc,
9732 you need to add &%-shared%& to the gcc command. Also, in the Exim build-time
9733 configuration, you must add &%-export-dynamic%& to EXTRALIBS.
9734
9735
9736 .vitem "&*${env{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&"
9737 .cindex "expansion" "extracting value from environment"
9738 .cindex "environment" "values from"
9739 The key is first expanded separately, and leading and trailing white space
9740 removed.
9741 This is then searched for as a name in the environment.
9742 If a variable is found then its value is placed in &$value$&
9743 and <&'string1'&> is expanded, otherwise <&'string2'&> is expanded.
9744
9745 Instead of {<&'string2'&>} the word &"fail"& (not in curly brackets) can
9746 appear, for example:
9747 .code
9748 ${env{USER}{$value} fail }
9749 .endd
9750 This forces an expansion failure (see section &<<SECTforexpfai>>&);
9751 {<&'string1'&>} must be present for &"fail"& to be recognized.
9752
9753 If {<&'string2'&>} is omitted an empty string is substituted on
9754 search failure.
9755 If {<&'string1'&>} is omitted the search result is substituted on
9756 search success.
9757
9758 The environment is adjusted by the &%keep_environment%& and
9759 &%add_environment%& main section options.
9760
9761
9762 .vitem "&*${extract{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}&&&
9763        {*&<&'string3'&>&*}}*&"
9764 .cindex "expansion" "extracting substrings by key"
9765 .cindex "&%extract%&" "substrings by key"
9766 The key and <&'string1'&> are first expanded separately. Leading and trailing
9767 white space is removed from the key (but not from any of the strings). The key
9768 must not be empty and must not consist entirely of digits.
9769 The expanded <&'string1'&> must be of the form:
9770 .display
9771 <&'key1'&> = <&'value1'&>  <&'key2'&> = <&'value2'&> ...
9772 .endd
9773 .vindex "&$value$&"
9774 where the equals signs and spaces (but not both) are optional. If any of the
9775 values contain white space, they must be enclosed in double quotes, and any
9776 values that are enclosed in double quotes are subject to escape processing as
9777 described in section &<<SECTstrings>>&. The expanded <&'string1'&> is searched
9778 for the value that corresponds to the key. The search is case-insensitive. If
9779 the key is found, <&'string2'&> is expanded, and replaces the whole item;
9780 otherwise <&'string3'&> is used. During the expansion of <&'string2'&> the
9781 variable &$value$& contains the value that has been extracted. Afterwards, it
9782 is restored to any previous value it might have had.
9783
9784 If {<&'string3'&>} is omitted, the item is replaced by an empty string if the
9785 key is not found. If {<&'string2'&>} is also omitted, the value that was
9786 extracted is used. Thus, for example, these two expansions are identical, and
9787 yield &"2001"&:
9788 .code
9789 ${extract{gid}{uid=1984 gid=2001}}
9790 ${extract{gid}{uid=1984 gid=2001}{$value}}
9791 .endd
9792 Instead of {<&'string3'&>} the word &"fail"& (not in curly brackets) can
9793 appear, for example:
9794 .code
9795 ${extract{Z}{A=... B=...}{$value} fail }
9796 .endd
9797 This forces an expansion failure (see section &<<SECTforexpfai>>&);
9798 {<&'string2'&>} must be present for &"fail"& to be recognized.
9799
9800 .vitem "&*${extract json{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}&&&
9801        {*&<&'string3'&>&*}}*&" &&&
9802        "&*${extract jsons{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}&&&
9803        {*&<&'string3'&>&*}}*&"
9804 .cindex "expansion" "extracting from JSON object"
9805 .cindex JSON expansions
9806 The key and <&'string1'&> are first expanded separately. Leading and trailing
9807 white space is removed from the key (but not from any of the strings). The key
9808 must not be empty and must not consist entirely of digits.
9809 The expanded <&'string1'&> must be of the form:
9810 .display
9811 { <&'"key1"'&> : <&'value1'&> ,  <&'"key2"'&> , <&'value2'&> ... }
9812 .endd
9813 .vindex "&$value$&"
9814 The braces, commas and colons, and the quoting of the member name are required;
9815 the spaces are optional.
9816 Matching of the key against the member names is done case-sensitively.
9817 For the &"json"& variant,
9818 if a returned value is a JSON string, it retains its leading and
9819 trailing quotes.
9820 For the &"jsons"& variant, which is intended for use with JSON strings, the
9821 leading and trailing quotes are removed from the returned value.
9822 . XXX should be a UTF-8 compare
9823
9824 The results of matching are handled as above.
9825
9826
9827 .vitem "&*${extract{*&<&'number'&>&*}{*&<&'separators'&>&*}&&&
9828         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9829 .cindex "expansion" "extracting substrings by number"
9830 .cindex "&%extract%&" "substrings by number"
9831 The <&'number'&> argument must consist entirely of decimal digits,
9832 apart from leading and trailing white space, which is ignored.
9833 This is what distinguishes this form of &%extract%& from the previous kind. It
9834 behaves in the same way, except that, instead of extracting a named field, it
9835 extracts from <&'string1'&> the field whose number is given as the first
9836 argument. You can use &$value$& in <&'string2'&> or &`fail`& instead of
9837 <&'string3'&> as before.
9838
9839 The fields in the string are separated by any one of the characters in the
9840 separator string. These may include space or tab characters.
9841 The first field is numbered one. If the number is negative, the fields are
9842 counted from the end of the string, with the rightmost one numbered -1. If the
9843 number given is zero, the entire string is returned. If the modulus of the
9844 number is greater than the number of fields in the string, the result is the
9845 expansion of <&'string3'&>, or the empty string if <&'string3'&> is not
9846 provided. For example:
9847 .code
9848 ${extract{2}{:}{x:42:99:& Mailer::/bin/bash}}
9849 .endd
9850 yields &"42"&, and
9851 .code
9852 ${extract{-4}{:}{x:42:99:& Mailer::/bin/bash}}
9853 .endd
9854 yields &"99"&. Two successive separators mean that the field between them is
9855 empty (for example, the fifth field above).
9856
9857
9858 .vitem "&*${extract json {*&<&'number'&>&*}}&&&
9859         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&" &&&
9860        "&*${extract jsons{*&<&'number'&>&*}}&&&
9861         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9862 .cindex "expansion" "extracting from JSON array"
9863 .cindex JSON expansions
9864 The <&'number'&> argument must consist entirely of decimal digits,
9865 apart from leading and trailing white space, which is ignored.
9866
9867 Field selection and result handling is as above;
9868 there is no choice of field separator.
9869 For the &"json"& variant,
9870 if a returned value is a JSON string, it retains its leading and
9871 trailing quotes.
9872 For the &"jsons"& variant, which is intended for use with JSON strings, the
9873 leading and trailing quotes are removed from the returned value.
9874
9875
9876 .vitem &*${filter{*&<&'string'&>&*}{*&<&'condition'&>&*}}*&
9877 .cindex "list" "selecting by condition"
9878 .cindex "expansion" "selecting from list by condition"
9879 .vindex "&$item$&"
9880 After expansion, <&'string'&> is interpreted as a list, colon-separated by
9881 default, but the separator can be changed in the usual way (&<<SECTlistsepchange>>&).
9882 For each item
9883 in this list, its value is place in &$item$&, and then the condition is
9884 evaluated. If the condition is true, &$item$& is added to the output as an
9885 item in a new list; if the condition is false, the item is discarded. The
9886 separator used for the output list is the same as the one used for the
9887 input, but a separator setting is not included in the output. For example:
9888 .code
9889 ${filter{a:b:c}{!eq{$item}{b}}}
9890 .endd
9891 yields &`a:c`&. At the end of the expansion, the value of &$item$& is restored
9892 to what it was before. See also the &%map%& and &%reduce%& expansion items.
9893
9894
9895 .vitem &*${hash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9896 .cindex "hash function" "textual"
9897 .cindex "expansion" "textual hash"
9898 This is a textual hashing function, and was the first to be implemented in
9899 early versions of Exim. In current releases, there are other hashing functions
9900 (numeric, MD5, and SHA-1), which are described below.
9901
9902 The first two strings, after expansion, must be numbers. Call them <&'m'&> and
9903 <&'n'&>. If you are using fixed values for these numbers, that is, if
9904 <&'string1'&> and <&'string2'&> do not change when they are expanded, you can
9905 use the simpler operator notation that avoids some of the braces:
9906 .code
9907 ${hash_<n>_<m>:<string>}
9908 .endd
9909 The second number is optional (in both notations). If <&'n'&> is greater than
9910 or equal to the length of the string, the expansion item returns the string.
9911 Otherwise it computes a new string of length <&'n'&> by applying a hashing
9912 function to the string. The new string consists of characters taken from the
9913 first <&'m'&> characters of the string
9914 .code
9915 abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQWRSTUVWXYZ0123456789
9916 .endd
9917 If <&'m'&> is not present the value 26 is used, so that only lower case
9918 letters appear. For example:
9919 .display
9920 &`$hash{3}{monty}}           `&   yields  &`jmg`&
9921 &`$hash{5}{monty}}           `&   yields  &`monty`&
9922 &`$hash{4}{62}{monty python}}`&   yields  &`fbWx`&
9923 .endd
9924
9925 .vitem "&*$header_*&<&'header&~name'&>&*:*&&~or&~&&&
9926         &*$h_*&<&'header&~name'&>&*:*&" &&&
9927        "&*$bheader_*&<&'header&~name'&>&*:*&&~or&~&&&
9928         &*$bh_*&<&'header&~name'&>&*:*&" &&&
9929        "&*$lheader_*&<&'header&~name'&>&*:*&&~or&~&&&
9930         &*$lh_*&<&'header&~name'&>&*:*&" &&&
9931        "&*$rheader_*&<&'header&~name'&>&*:*&&~or&~&&&
9932         &*$rh_*&<&'header&~name'&>&*:*&"
9933 .cindex "expansion" "header insertion"
9934 .vindex "&$header_$&"
9935 .vindex "&$bheader_$&"
9936 .vindex "&$lheader_$&"
9937 .vindex "&$rheader_$&"
9938 .cindex "header lines" "in expansion strings"
9939 .cindex "header lines" "character sets"
9940 .cindex "header lines" "decoding"
9941 Substitute the contents of the named message header line, for example
9942 .code
9943 $header_reply-to:
9944 .endd
9945 The newline that terminates a header line is not included in the expansion, but
9946 internal newlines (caused by splitting the header line over several physical
9947 lines) may be present.
9948
9949 The difference between the four pairs of expansions is in the way
9950 the data in the header line is interpreted.
9951
9952 .ilist
9953 .cindex "white space" "in header lines"
9954 &%rheader%& gives the original &"raw"& content of the header line, with no
9955 processing at all, and without the removal of leading and trailing white space.
9956
9957 .next
9958 .cindex "list" "of header lines"
9959 &%lheader%& gives a colon-separated list, one element per header when there
9960 are multiple headers with a given name.
9961 Any embedded colon characters within an element are doubled, so normal Exim
9962 list-processing facilities can be used.
9963 The terminating newline of each element is removed; in other respects
9964 the content is &"raw"&.
9965
9966 .next
9967 .cindex "base64 encoding" "in header lines"
9968 &%bheader%& removes leading and trailing white space, and then decodes base64
9969 or quoted-printable MIME &"words"& within the header text, but does no
9970 character set translation. If decoding of what looks superficially like a MIME
9971 &"word"& fails, the raw string is returned. If decoding
9972 .cindex "binary zero" "in header line"
9973 produces a binary zero character, it is replaced by a question mark &-- this is
9974 what Exim does for binary zeros that are actually received in header lines.
9975
9976 .next
9977 &%header%& tries to translate the string as decoded by &%bheader%& to a
9978 standard character set. This is an attempt to produce the same string as would
9979 be displayed on a user's MUA. If translation fails, the &%bheader%& string is
9980 returned. Translation is attempted only on operating systems that support the
9981 &[iconv()]& function. This is indicated by the compile-time macro HAVE_ICONV in
9982 a system Makefile or in &_Local/Makefile_&.
9983 .endlist ilist
9984
9985 In a filter file, the target character set for &%header%& can be specified by a
9986 command of the following form:
9987 .code
9988 headers charset "UTF-8"
9989 .endd
9990 This command affects all references to &$h_$& (or &$header_$&) expansions in
9991 subsequently obeyed filter commands. In the absence of this command, the target
9992 character set in a filter is taken from the setting of the &%headers_charset%&
9993 option in the runtime configuration. The value of this option defaults to the
9994 value of HEADERS_CHARSET in &_Local/Makefile_&. The ultimate default is
9995 ISO-8859-1.
9996
9997 Header names follow the syntax of RFC 2822, which states that they may contain
9998 any printing characters except space and colon. Consequently, curly brackets
9999 &'do not'& terminate header names, and should not be used to enclose them as
10000 if they were variables. Attempting to do so causes a syntax error.
10001
10002 Only header lines that are common to all copies of a message are visible to
10003 this mechanism. These are the original header lines that are received with the
10004 message, and any that are added by an ACL statement or by a system
10005 filter. Header lines that are added to a particular copy of a message by a
10006 router or transport are not accessible.
10007
10008 For incoming SMTP messages, no header lines are visible in
10009 ACLs that are obeyed before the data phase completes,
10010 because the header structure is not set up until the message is received.
10011 They are visible in DKIM, PRDR and DATA ACLs.
10012 Header lines that are added in a RCPT ACL (for example)
10013 are saved until the message's incoming header lines are available, at which
10014 point they are added.
10015 When any of the above ACLs ar
10016 running, however, header lines added by earlier ACLs are visible.
10017
10018 Upper case and lower case letters are synonymous in header names. If the
10019 following character is white space, the terminating colon may be omitted, but
10020 this is not recommended, because you may then forget it when it is needed. When
10021 white space terminates the header name, this white space is included in the
10022 expanded string.  If the message does not contain the given header, the
10023 expansion item is replaced by an empty string. (See the &%def%& condition in
10024 section &<<SECTexpcond>>& for a means of testing for the existence of a
10025 header.)
10026
10027 If there is more than one header with the same name, they are all concatenated
10028 to form the substitution string, up to a maximum length of 64K. Unless
10029 &%rheader%& is being used, leading and trailing white space is removed from
10030 each header before concatenation, and a completely empty header is ignored. A
10031 newline character is then inserted between non-empty headers, but there is no
10032 newline at the very end. For the &%header%& and &%bheader%& expansion, for
10033 those headers that contain lists of addresses, a comma is also inserted at the
10034 junctions between headers. This does not happen for the &%rheader%& expansion.
10035
10036 .new
10037 .cindex "tainted data"
10038 When the headers are from an incoming message,
10039 the result of expanding any of these variables is tainted.
10040 .wen
10041
10042
10043 .vitem &*${hmac{*&<&'hashname'&>&*}{*&<&'secret'&>&*}{*&<&'string'&>&*}}*&
10044 .cindex "expansion" "hmac hashing"
10045 .cindex &%hmac%&
10046 This function uses cryptographic hashing (either MD5 or SHA-1) to convert a
10047 shared secret and some text into a message authentication code, as specified in
10048 RFC 2104. This differs from &`${md5:secret_text...}`& or
10049 &`${sha1:secret_text...}`& in that the hmac step adds a signature to the
10050 cryptographic hash, allowing for authentication that is not possible with MD5
10051 or SHA-1 alone. The hash name must expand to either &`md5`& or &`sha1`& at
10052 present. For example:
10053 .code
10054 ${hmac{md5}{somesecret}{$primary_hostname $tod_log}}
10055 .endd
10056 For the hostname &'mail.example.com'& and time 2002-10-17 11:30:59, this
10057 produces:
10058 .code
10059 dd97e3ba5d1a61b5006108f8c8252953
10060 .endd
10061 As an example of how this might be used, you might put in the main part of
10062 an Exim configuration:
10063 .code
10064 SPAMSCAN_SECRET=cohgheeLei2thahw
10065 .endd
10066 In a router or a transport you could then have:
10067 .code
10068 headers_add = \
10069   X-Spam-Scanned: ${primary_hostname} ${message_exim_id} \
10070   ${hmac{md5}{SPAMSCAN_SECRET}\
10071   {${primary_hostname},${message_exim_id},$h_message-id:}}
10072 .endd
10073 Then given a message, you can check where it was scanned by looking at the
10074 &'X-Spam-Scanned:'& header line. If you know the secret, you can check that
10075 this header line is authentic by recomputing the authentication code from the
10076 host name, message ID and the &'Message-id:'& header line. This can be done
10077 using Exim's &%-be%& option, or by other means, for example, by using the
10078 &'hmac_md5_hex()'& function in Perl.
10079
10080
10081 .vitem &*${if&~*&<&'condition'&>&*&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
10082 .cindex "expansion" "conditional"
10083 .cindex "&%if%&, expansion item"
10084 If <&'condition'&> is true, <&'string1'&> is expanded and replaces the whole
10085 item; otherwise <&'string2'&> is used. The available conditions are described
10086 in section &<<SECTexpcond>>& below. For example:
10087 .code
10088 ${if eq {$local_part}{postmaster} {yes}{no} }
10089 .endd
10090 The second string need not be present; if it is not and the condition is not
10091 true, the item is replaced with nothing. Alternatively, the word &"fail"& may
10092 be present instead of the second string (without any curly brackets). In this
10093 case, the expansion is forced to fail if the condition is not true (see section
10094 &<<SECTforexpfai>>&).
10095
10096 If both strings are omitted, the result is the string &`true`& if the condition
10097 is true, and the empty string if the condition is false. This makes it less
10098 cumbersome to write custom ACL and router conditions. For example, instead of
10099 .code
10100 condition = ${if >{$acl_m4}{3}{true}{false}}
10101 .endd
10102 you can use
10103 .code
10104 condition = ${if >{$acl_m4}{3}}
10105 .endd
10106
10107
10108
10109 .vitem &*${imapfolder{*&<&'foldername'&>&*}}*&
10110 .cindex expansion "imap folder"
10111 .cindex "&%imapfolder%& expansion item"
10112 This item converts a (possibly multilevel, or with non-ASCII characters)
10113 folder specification to a Maildir name for filesystem use.
10114 For information on internationalisation support see &<<SECTi18nMDA>>&.
10115
10116
10117
10118 .vitem &*${length{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
10119 .cindex "expansion" "string truncation"
10120 .cindex "&%length%& expansion item"
10121 The &%length%& item is used to extract the initial portion of a string. Both
10122 strings are expanded, and the first one must yield a number, <&'n'&>, say. If
10123 you are using a fixed value for the number, that is, if <&'string1'&> does not
10124 change when expanded, you can use the simpler operator notation that avoids
10125 some of the braces:
10126 .code
10127 ${length_<n>:<string>}
10128 .endd
10129 The result of this item is either the first <&'n'&> bytes or the whole
10130 of <&'string2'&>, whichever is the shorter. Do not confuse &%length%& with
10131 &%strlen%&, which gives the length of a string.
10132 All measurement is done in bytes and is not UTF-8 aware.
10133
10134
10135 .vitem "&*${listextract{*&<&'number'&>&*}&&&
10136         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
10137 .cindex "expansion" "extracting list elements by number"
10138 .cindex "&%listextract%&" "extract list elements by number"
10139 .cindex "list" "extracting elements by number"
10140 The <&'number'&> argument must consist entirely of decimal digits,
10141 apart from an optional leading minus,
10142 and leading and trailing white space (which is ignored).
10143
10144 After expansion, <&'string1'&> is interpreted as a list, colon-separated by
10145 default, but the separator can be changed in the usual way (&<<SECTlistsepchange>>&).
10146
10147 The first field of the list is numbered one.
10148 If the number is negative, the fields are
10149 counted from the end of the list, with the rightmost one numbered -1.
10150 The numbered element of the list is extracted and placed in &$value$&,
10151 then <&'string2'&> is expanded as the result.
10152
10153 If the modulus of the
10154 number is zero or greater than the number of fields in the string,
10155 the result is the expansion of <&'string3'&>.
10156
10157 For example:
10158 .code
10159 ${listextract{2}{x:42:99}}
10160 .endd
10161 yields &"42"&, and
10162 .code
10163 ${listextract{-3}{<, x,42,99,& Mailer,,/bin/bash}{result: $value}}
10164 .endd
10165 yields &"result: 42"&.
10166
10167 If {<&'string3'&>} is omitted, an empty string is used for string3.
10168 If {<&'string2'&>} is also omitted, the value that was
10169 extracted is used.
10170 You can use &`fail`& instead of {<&'string3'&>} as in a string extract.
10171
10172
10173 .vitem "&*${lookup{*&<&'key'&>&*}&~*&<&'search&~type'&>&*&~&&&
10174         {*&<&'file'&>&*}&~{*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&"
10175 This is the first of one of two different types of lookup item, which are both
10176 described in the next item.
10177
10178 .vitem "&*${lookup&~*&<&'search&~type'&>&*&~{*&<&'query'&>&*}&~&&&
10179         {*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&"
10180 .cindex "expansion" "lookup in"
10181 .cindex "file" "lookups"
10182 .cindex "lookup" "in expanded string"
10183 The two forms of lookup item specify data lookups in files and databases, as
10184 discussed in chapter &<<CHAPfdlookup>>&. The first form is used for single-key
10185 lookups, and the second is used for query-style lookups. The <&'key'&>,
10186 <&'file'&>, and <&'query'&> strings are expanded before use.
10187
10188 If there is any white space in a lookup item which is part of a filter command,
10189 a retry or rewrite rule, a routing rule for the &(manualroute)& router, or any
10190 other place where white space is significant, the lookup item must be enclosed
10191 in double quotes. The use of data lookups in users' filter files may be locked
10192 out by the system administrator.
10193
10194 .vindex "&$value$&"
10195 If the lookup succeeds, <&'string1'&> is expanded and replaces the entire item.
10196 During its expansion, the variable &$value$& contains the data returned by the
10197 lookup. Afterwards it reverts to the value it had previously (at the outer
10198 level it is empty). If the lookup fails, <&'string2'&> is expanded and replaces
10199 the entire item. If {<&'string2'&>} is omitted, the replacement is the empty
10200 string on failure. If <&'string2'&> is provided, it can itself be a nested
10201 lookup, thus providing a mechanism for looking up a default value when the
10202 original lookup fails.
10203
10204 If a nested lookup is used as part of <&'string1'&>, &$value$& contains the
10205 data for the outer lookup while the parameters of the second lookup are
10206 expanded, and also while <&'string2'&> of the second lookup is expanded, should
10207 the second lookup fail. Instead of {<&'string2'&>} the word &"fail"& can
10208 appear, and in this case, if the lookup fails, the entire expansion is forced
10209 to fail (see section &<<SECTforexpfai>>&). If both {<&'string1'&>} and
10210 {<&'string2'&>} are omitted, the result is the looked up value in the case of a
10211 successful lookup, and nothing in the case of failure.
10212
10213 For single-key lookups, the string &"partial"& is permitted to precede the
10214 search type in order to do partial matching, and * or *@ may follow a search
10215 type to request default lookups if the key does not match (see sections
10216 &<<SECTdefaultvaluelookups>>& and &<<SECTpartiallookup>>& for details).
10217
10218 .cindex "numerical variables (&$1$& &$2$& etc)" "in lookup expansion"
10219 If a partial search is used, the variables &$1$& and &$2$& contain the wild
10220 and non-wild parts of the key during the expansion of the replacement text.
10221 They return to their previous values at the end of the lookup item.
10222
10223 This example looks up the postmaster alias in the conventional alias file:
10224 .code
10225 ${lookup {postmaster} lsearch {/etc/aliases} {$value}}
10226 .endd
10227 This example uses NIS+ to look up the full name of the user corresponding to
10228 the local part of an address, forcing the expansion to fail if it is not found:
10229 .code
10230 ${lookup nisplus {[name=$local_part],passwd.org_dir:gcos} \
10231   {$value}fail}
10232 .endd
10233
10234
10235 .vitem &*${map{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
10236 .cindex "expansion" "list creation"
10237 .vindex "&$item$&"
10238 After expansion, <&'string1'&> is interpreted as a list, colon-separated by
10239 default, but the separator can be changed in the usual way (&<<SECTlistsepchange>>&).
10240 For each item
10241 in this list, its value is place in &$item$&, and then <&'string2'&> is
10242 expanded and added to the output as an item in a new list. The separator used
10243 for the output list is the same as the one used for the input, but a separator
10244 setting is not included in the output. For example:
10245 .code
10246 ${map{a:b:c}{[$item]}} ${map{<- x-y-z}{($item)}}
10247 .endd
10248 expands to &`[a]:[b]:[c] (x)-(y)-(z)`&. At the end of the expansion, the
10249 value of &$item$& is restored to what it was before. See also the &%filter%&
10250 and &%reduce%& expansion items.
10251
10252 .vitem &*${nhash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
10253 .cindex "expansion" "numeric hash"
10254 .cindex "hash function" "numeric"
10255 The three strings are expanded; the first two must yield numbers. Call them
10256 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
10257 if <&'string1'&> and <&'string2'&> do not change when they are expanded, you
10258 can use the simpler operator notation that avoids some of the braces:
10259 .code
10260 ${nhash_<n>_<m>:<string>}
10261 .endd
10262 The second number is optional (in both notations). If there is only one number,
10263 the result is a number in the range 0&--<&'n'&>-1. Otherwise, the string is
10264 processed by a div/mod hash function that returns two numbers, separated by a
10265 slash, in the ranges 0 to <&'n'&>-1 and 0 to <&'m'&>-1, respectively. For
10266 example,
10267 .code
10268 ${nhash{8}{64}{supercalifragilisticexpialidocious}}
10269 .endd
10270 returns the string &"6/33"&.
10271
10272
10273
10274 .vitem &*${perl{*&<&'subroutine'&>&*}{*&<&'arg'&>&*}{*&<&'arg'&>&*}...}*&
10275 .cindex "Perl" "use in expanded string"
10276 .cindex "expansion" "calling Perl from"
10277 This item is available only if Exim has been built to include an embedded Perl
10278 interpreter. The subroutine name and the arguments are first separately
10279 expanded, and then the Perl subroutine is called with those arguments. No
10280 additional arguments need be given; the maximum number permitted, including the
10281 name of the subroutine, is nine.
10282
10283 The return value of the subroutine is inserted into the expanded string, unless
10284 the return value is &%undef%&. In that case, the expansion fails in the same
10285 way as an explicit &"fail"& on a lookup item. The return value is a scalar.
10286 Whatever you return is evaluated in a scalar context. For example, if you
10287 return the name of a Perl vector, the return value is the size of the vector,
10288 not its contents.
10289
10290 If the subroutine exits by calling Perl's &%die%& function, the expansion fails
10291 with the error message that was passed to &%die%&. More details of the embedded
10292 Perl facility are given in chapter &<<CHAPperl>>&.
10293
10294 The &(redirect)& router has an option called &%forbid_filter_perl%& which locks
10295 out the use of this expansion item in filter files.
10296
10297
10298 .vitem &*${prvs{*&<&'address'&>&*}{*&<&'secret'&>&*}{*&<&'keynumber'&>&*}}*&
10299 .cindex "&%prvs%& expansion item"
10300 The first argument is a complete email address and the second is secret
10301 keystring. The third argument, specifying a key number, is optional. If absent,
10302 it defaults to 0. The result of the expansion is a prvs-signed email address,
10303 to be typically used with the &%return_path%& option on an &(smtp)& transport
10304 as part of a bounce address tag validation (BATV) scheme. For more discussion
10305 and an example, see section &<<SECTverifyPRVS>>&.
10306
10307 .vitem "&*${prvscheck{*&<&'address'&>&*}{*&<&'secret'&>&*}&&&
10308         {*&<&'string'&>&*}}*&"
10309 .cindex "&%prvscheck%& expansion item"
10310 This expansion item is the complement of the &%prvs%& item. It is used for
10311 checking prvs-signed addresses. If the expansion of the first argument does not
10312 yield a syntactically valid prvs-signed address, the whole item expands to the
10313 empty string. When the first argument does expand to a syntactically valid
10314 prvs-signed address, the second argument is expanded, with the prvs-decoded
10315 version of the address and the key number extracted from the address in the
10316 variables &$prvscheck_address$& and &$prvscheck_keynum$&, respectively.
10317
10318 These two variables can be used in the expansion of the second argument to
10319 retrieve the secret. The validity of the prvs-signed address is then checked
10320 against the secret. The result is stored in the variable &$prvscheck_result$&,
10321 which is empty for failure or &"1"& for success.
10322
10323 The third argument is optional; if it is missing, it defaults to an empty
10324 string. This argument is now expanded. If the result is an empty string, the
10325 result of the expansion is the decoded version of the address. This is the case
10326 whether or not the signature was valid. Otherwise, the result of the expansion
10327 is the expansion of the third argument.
10328
10329 All three variables can be used in the expansion of the third argument.
10330 However, once the expansion is complete, only &$prvscheck_result$& remains set.
10331 For more discussion and an example, see section &<<SECTverifyPRVS>>&.
10332
10333 .vitem &*${readfile{*&<&'file&~name'&>&*}{*&<&'eol&~string'&>&*}}*&
10334 .cindex "expansion" "inserting an entire file"
10335 .cindex "file" "inserting into expansion"
10336 .cindex "&%readfile%& expansion item"
10337 The filename and end-of-line string are first expanded separately. The file is
10338 then read, and its contents replace the entire item. All newline characters in
10339 the file are replaced by the end-of-line string if it is present. Otherwise,
10340 newlines are left in the string.
10341 String expansion is not applied to the contents of the file. If you want this,
10342 you must wrap the item in an &%expand%& operator. If the file cannot be read,
10343 the string expansion fails.
10344
10345 The &(redirect)& router has an option called &%forbid_filter_readfile%& which
10346 locks out the use of this expansion item in filter files.
10347
10348
10349
10350 .vitem "&*${readsocket{*&<&'name'&>&*}{*&<&'request'&>&*}&&&
10351         {*&<&'options'&>&*}{*&<&'eol&~string'&>&*}{*&<&'fail&~string'&>&*}}*&"
10352 .cindex "expansion" "inserting from a socket"
10353 .cindex "socket, use of in expansion"
10354 .cindex "&%readsocket%& expansion item"
10355 This item inserts data from a Unix domain or TCP socket into the expanded
10356 string. The minimal way of using it uses just two arguments, as in these
10357 examples:
10358 .code
10359 ${readsocket{/socket/name}{request string}}
10360 ${readsocket{inet:some.host:1234}{request string}}
10361 .endd
10362 For a Unix domain socket, the first substring must be the path to the socket.
10363 For an Internet socket, the first substring must contain &`inet:`& followed by
10364 a host name or IP address, followed by a colon and a port, which can be a
10365 number or the name of a TCP port in &_/etc/services_&. An IP address may
10366 optionally be enclosed in square brackets. This is best for IPv6 addresses. For
10367 example:
10368 .code
10369 ${readsocket{inet:[::1]:1234}{request string}}
10370 .endd
10371 Only a single host name may be given, but if looking it up yields more than
10372 one IP address, they are each tried in turn until a connection is made. For
10373 both kinds of socket, Exim makes a connection, writes the request string
10374 unless it is an empty string; and no terminating NUL is ever sent)
10375 and reads from the socket until an end-of-file
10376 is read. A timeout of 5 seconds is applied. Additional, optional arguments
10377 extend what can be done. Firstly, you can vary the timeout. For example:
10378 .code
10379 ${readsocket{/socket/name}{request string}{3s}}
10380 .endd
10381
10382 The third argument is a list of options, of which the first element is the timeout
10383 and must be present if any options are given.
10384 Further elements are options of form &'name=value'&.
10385 Example:
10386 .code
10387 ${readsocket{/socket/name}{request string}{3s:shutdown=no}}
10388 .endd
10389
10390 .new
10391 The following option names are recognised:
10392 .ilist
10393 &*cache*&
10394 Defines if the result data can be cached for use by a later identical
10395 request in the same process.
10396 Values are &"yes"& or &"no"& (the default).
10397 If not, all cached results for this connection specification
10398 will be invalidated.
10399
10400 .next
10401 &*shutdown*&
10402 Defines whether or not a write-shutdown is done on the connection after
10403 sending the request. Values are &"yes"& (the default) or &"no"&
10404 (preferred, eg. by some webservers).
10405
10406 .next
10407 &*tls*&
10408 Controls the use of TLS on the connection.
10409 Values are &"yes"& or &"no"& (the default).
10410 If it is enabled, a shutdown as descripbed above is never done.
10411 .endlist
10412 .wen
10413
10414
10415 A fourth argument allows you to change any newlines that are in the data
10416 that is read, in the same way as for &%readfile%& (see above). This example
10417 turns them into spaces:
10418 .code
10419 ${readsocket{inet:127.0.0.1:3294}{request string}{3s}{ }}
10420 .endd
10421 As with all expansions, the substrings are expanded before the processing
10422 happens. Errors in these sub-expansions cause the expansion to fail. In
10423 addition, the following errors can occur:
10424
10425 .ilist
10426 Failure to create a socket file descriptor;
10427 .next
10428 Failure to connect the socket;
10429 .next
10430 Failure to write the request string;
10431 .next
10432 Timeout on reading from the socket.
10433 .endlist
10434
10435 By default, any of these errors causes the expansion to fail. However, if
10436 you supply a fifth substring, it is expanded and used when any of the above
10437 errors occurs. For example:
10438 .code
10439 ${readsocket{/socket/name}{request string}{3s}{\n}\
10440   {socket failure}}
10441 .endd
10442 You can test for the existence of a Unix domain socket by wrapping this
10443 expansion in &`${if exists`&, but there is a race condition between that test
10444 and the actual opening of the socket, so it is safer to use the fifth argument
10445 if you want to be absolutely sure of avoiding an expansion error for a
10446 non-existent Unix domain socket, or a failure to connect to an Internet socket.
10447
10448 The &(redirect)& router has an option called &%forbid_filter_readsocket%& which
10449 locks out the use of this expansion item in filter files.
10450
10451
10452 .vitem &*${reduce{*&<&'string1'&>}{<&'string2'&>&*}{*&<&'string3'&>&*}}*&
10453 .cindex "expansion" "reducing a list to a scalar"
10454 .cindex "list" "reducing to a scalar"
10455 .vindex "&$value$&"
10456 .vindex "&$item$&"
10457 This operation reduces a list to a single, scalar string. After expansion,
10458 <&'string1'&> is interpreted as a list, colon-separated by default, but the
10459 separator can be changed in the usual way (&<<SECTlistsepchange>>&).
10460 Then <&'string2'&> is expanded and
10461 assigned to the &$value$& variable. After this, each item in the <&'string1'&>
10462 list is assigned to &$item$&, in turn, and <&'string3'&> is expanded for each of
10463 them. The result of that expansion is assigned to &$value$& before the next
10464 iteration. When the end of the list is reached, the final value of &$value$& is
10465 added to the expansion output. The &%reduce%& expansion item can be used in a
10466 number of ways. For example, to add up a list of numbers:
10467 .code
10468 ${reduce {<, 1,2,3}{0}{${eval:$value+$item}}}
10469 .endd
10470 The result of that expansion would be &`6`&. The maximum of a list of numbers
10471 can be found:
10472 .code
10473 ${reduce {3:0:9:4:6}{0}{${if >{$item}{$value}{$item}{$value}}}}
10474 .endd
10475 At the end of a &*reduce*& expansion, the values of &$item$& and &$value$& are
10476 restored to what they were before. See also the &%filter%& and &%map%&
10477 expansion items.
10478
10479 .vitem &*$rheader_*&<&'header&~name'&>&*:*&&~or&~&*$rh_*&<&'header&~name'&>&*:*&
10480 This item inserts &"raw"& header lines. It is described with the &%header%&
10481 expansion item in section &<<SECTexpansionitems>>& above.
10482
10483 .vitem "&*${run{*&<&'command'&>&*&~*&<&'args'&>&*}{*&<&'string1'&>&*}&&&
10484         {*&<&'string2'&>&*}}*&"
10485 .cindex "expansion" "running a command"
10486 .cindex "&%run%& expansion item"
10487 The command and its arguments are first expanded as one string. The string is
10488 split apart into individual arguments by spaces, and then the command is run
10489 in a separate process, but under the same uid and gid.  As in other command
10490 executions from Exim, a shell is not used by default. If the command requires
10491 a shell, you must explicitly code it.
10492
10493 Since the arguments are split by spaces, when there is a variable expansion
10494 which has an empty result, it will cause the situation that the argument will
10495 simply be omitted when the program is actually executed by Exim. If the
10496 script/program requires a specific number of arguments and the expanded
10497 variable could possibly result in this empty expansion, the variable must be
10498 quoted. This is more difficult if the expanded variable itself could result
10499 in a string containing quotes, because it would interfere with the quotes
10500 around the command arguments. A possible guard against this is to wrap the
10501 variable in the &%sg%& operator to change any quote marks to some other
10502 character.
10503
10504 The standard input for the command exists, but is empty. The standard output
10505 and standard error are set to the same file descriptor.
10506 .cindex "return code" "from &%run%& expansion"
10507 .vindex "&$value$&"
10508 If the command succeeds (gives a zero return code) <&'string1'&> is expanded
10509 and replaces the entire item; during this expansion, the standard output/error
10510 from the command is in the variable &$value$&. If the command fails,
10511 <&'string2'&>, if present, is expanded and used. Once again, during the
10512 expansion, the standard output/error from the command is in the variable
10513 &$value$&.
10514
10515 If <&'string2'&> is absent, the result is empty. Alternatively, <&'string2'&>
10516 can be the word &"fail"& (not in braces) to force expansion failure if the
10517 command does not succeed. If both strings are omitted, the result is contents
10518 of the standard output/error on success, and nothing on failure.
10519
10520 .vindex "&$run_in_acl$&"
10521 The standard output/error of the command is put in the variable &$value$&.
10522 In this ACL example, the output of a command is logged for the admin to
10523 troubleshoot:
10524 .code
10525 warn  condition    = ${run{/usr/bin/id}{yes}{no}}
10526       log_message  = Output of id: $value
10527 .endd
10528 If the command requires shell idioms, such as the > redirect operator, the
10529 shell must be invoked directly, such as with:
10530 .code
10531 ${run{/bin/bash -c "/usr/bin/id >/tmp/id"}{yes}{yes}}
10532 .endd
10533
10534 .vindex "&$runrc$&"
10535 The return code from the command is put in the variable &$runrc$&, and this
10536 remains set afterwards, so in a filter file you can do things like this:
10537 .code
10538 if "${run{x y z}{}}$runrc" is 1 then ...
10539   elif $runrc is 2 then ...
10540   ...
10541 endif
10542 .endd
10543 If execution of the command fails (for example, the command does not exist),
10544 the return code is 127 &-- the same code that shells use for non-existent
10545 commands.
10546
10547 &*Warning*&: In a router or transport, you cannot assume the order in which
10548 option values are expanded, except for those preconditions whose order of
10549 testing is documented. Therefore, you cannot reliably expect to set &$runrc$&
10550 by the expansion of one option, and use it in another.
10551
10552 The &(redirect)& router has an option called &%forbid_filter_run%& which locks
10553 out the use of this expansion item in filter files.
10554
10555
10556 .vitem &*${sg{*&<&'subject'&>&*}{*&<&'regex'&>&*}{*&<&'replacement'&>&*}}*&
10557 .cindex "expansion" "string substitution"
10558 .cindex "&%sg%& expansion item"
10559 This item works like Perl's substitution operator (s) with the global (/g)
10560 option; hence its name. However, unlike the Perl equivalent, Exim does not
10561 modify the subject string; instead it returns the modified string for insertion
10562 into the overall expansion. The item takes three arguments: the subject string,
10563 a regular expression, and a substitution string. For example:
10564 .code
10565 ${sg{abcdefabcdef}{abc}{xyz}}
10566 .endd
10567 yields &"xyzdefxyzdef"&. Because all three arguments are expanded before use,
10568 if any $, } or \ characters are required in the regular expression or in the
10569 substitution string, they have to be escaped. For example:
10570 .code
10571 ${sg{abcdef}{^(...)(...)\$}{\$2\$1}}
10572 .endd
10573 yields &"defabc"&, and
10574 .code
10575 ${sg{1=A 4=D 3=C}{\N(\d+)=\N}{K\$1=}}
10576 .endd
10577 yields &"K1=A K4=D K3=C"&. Note the use of &`\N`& to protect the contents of
10578 the regular expression from string expansion.
10579
10580 The regular expression is compiled in 8-bit mode, working against bytes
10581 rather than any Unicode-aware character handling.
10582
10583
10584 .vitem &*${sort{*&<&'string'&>&*}{*&<&'comparator'&>&*}{*&<&'extractor'&>&*}}*&
10585 .cindex sorting "a list"
10586 .cindex list sorting
10587 .cindex expansion "list sorting"
10588 After expansion, <&'string'&> is interpreted as a list, colon-separated by
10589 default, but the separator can be changed in the usual way (&<<SECTlistsepchange>>&).
10590 The <&'comparator'&> argument is interpreted as the operator
10591 of a two-argument expansion condition.
10592 The numeric operators plus ge, gt, le, lt (and ~i variants) are supported.
10593 The comparison should return true when applied to two values
10594 if the first value should sort before the second value.
10595 The <&'extractor'&> expansion is applied repeatedly to elements of the list,
10596 the element being placed in &$item$&,
10597 to give values for comparison.
10598
10599 The item result is a sorted list,
10600 with the original list separator,
10601 of the list elements (in full) of the original.
10602
10603 Examples:
10604 .code
10605 ${sort{3:2:1:4}{<}{$item}}
10606 .endd
10607 sorts a list of numbers, and
10608 .code
10609 ${sort {${lookup dnsdb{>:,,mx=example.com}}} {<} {${listextract{1}{<,$item}}}}
10610 .endd
10611 will sort an MX lookup into priority order.
10612
10613
10614 .vitem &*${substr{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
10615 .cindex "&%substr%& expansion item"
10616 .cindex "substring extraction"
10617 .cindex "expansion" "substring extraction"
10618 The three strings are expanded; the first two must yield numbers. Call them
10619 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
10620 if <&'string1'&> and <&'string2'&> do not change when they are expanded, you
10621 can use the simpler operator notation that avoids some of the braces:
10622 .code
10623 ${substr_<n>_<m>:<string>}
10624 .endd
10625 The second number is optional (in both notations).
10626 If it is absent in the simpler format, the preceding underscore must also be
10627 omitted.
10628
10629 The &%substr%& item can be used to extract more general substrings than
10630 &%length%&. The first number, <&'n'&>, is a starting offset, and <&'m'&> is the
10631 length required. For example
10632 .code
10633 ${substr{3}{2}{$local_part}}
10634 .endd
10635 If the starting offset is greater than the string length the result is the
10636 null string; if the length plus starting offset is greater than the string
10637 length, the result is the right-hand part of the string, starting from the
10638 given offset. The first byte (character) in the string has offset zero.
10639
10640 The &%substr%& expansion item can take negative offset values to count
10641 from the right-hand end of its operand. The last byte (character) is offset -1,
10642 the second-last is offset -2, and so on. Thus, for example,
10643 .code
10644 ${substr{-5}{2}{1234567}}
10645 .endd
10646 yields &"34"&. If the absolute value of a negative offset is greater than the
10647 length of the string, the substring starts at the beginning of the string, and
10648 the length is reduced by the amount of overshoot. Thus, for example,
10649 .code
10650 ${substr{-5}{2}{12}}
10651 .endd
10652 yields an empty string, but
10653 .code
10654 ${substr{-3}{2}{12}}
10655 .endd
10656 yields &"1"&.
10657
10658 When the second number is omitted from &%substr%&, the remainder of the string
10659 is taken if the offset is positive. If it is negative, all bytes (characters) in the
10660 string preceding the offset point are taken. For example, an offset of -1 and
10661 no length, as in these semantically identical examples:
10662 .code
10663 ${substr_-1:abcde}
10664 ${substr{-1}{abcde}}
10665 .endd
10666 yields all but the last character of the string, that is, &"abcd"&.
10667
10668 All measurement is done in bytes and is not UTF-8 aware.
10669
10670
10671
10672 .vitem "&*${tr{*&<&'subject'&>&*}{*&<&'characters'&>&*}&&&
10673         {*&<&'replacements'&>&*}}*&"
10674 .cindex "expansion" "character translation"
10675 .cindex "&%tr%& expansion item"
10676 This item does single-character (in bytes) translation on its subject string. The second
10677 argument is a list of characters to be translated in the subject string. Each
10678 matching character is replaced by the corresponding character from the
10679 replacement list. For example
10680 .code
10681 ${tr{abcdea}{ac}{13}}
10682 .endd
10683 yields &`1b3de1`&. If there are duplicates in the second character string, the
10684 last occurrence is used. If the third string is shorter than the second, its
10685 last character is replicated. However, if it is empty, no translation takes
10686 place.
10687
10688 All character handling is done in bytes and is not UTF-8 aware.
10689
10690 .endlist
10691
10692
10693
10694 .section "Expansion operators" "SECTexpop"
10695 .cindex "expansion" "operators"
10696 For expansion items that perform transformations on a single argument string,
10697 the &"operator"& notation is used because it is simpler and uses fewer braces.
10698 The substring is first expanded before the operation is applied to it. The
10699 following operations can be performed:
10700
10701 .vlist
10702 .vitem &*${address:*&<&'string'&>&*}*&
10703 .cindex "expansion" "RFC 2822 address handling"
10704 .cindex "&%address%& expansion item"
10705 The string is interpreted as an RFC 2822 address, as it might appear in a
10706 header line, and the effective address is extracted from it. If the string does
10707 not parse successfully, the result is empty.
10708
10709 The parsing correctly handles SMTPUTF8 Unicode in the string.
10710
10711
10712 .vitem &*${addresses:*&<&'string'&>&*}*&
10713 .cindex "expansion" "RFC 2822 address handling"
10714 .cindex "&%addresses%& expansion item"
10715 The string (after expansion) is interpreted as a list of addresses in RFC
10716 2822 format, such as can be found in a &'To:'& or &'Cc:'& header line. The
10717 operative address (&'local-part@domain'&) is extracted from each item, and the
10718 result of the expansion is a colon-separated list, with appropriate
10719 doubling of colons should any happen to be present in the email addresses.
10720 Syntactically invalid RFC2822 address items are omitted from the output.
10721
10722 It is possible to specify a character other than colon for the output
10723 separator by starting the string with > followed by the new separator
10724 character. For example:
10725 .code
10726 ${addresses:>& Chief <ceo@up.stairs>, sec@base.ment (dogsbody)}
10727 .endd
10728 expands to &`ceo@up.stairs&&sec@base.ment`&. The string is expanded
10729 first, so if the expanded string starts with >, it may change the output
10730 separator unintentionally. This can be avoided by setting the output
10731 separator explicitly:
10732 .code
10733 ${addresses:>:$h_from:}
10734 .endd
10735
10736 Compare the &%address%& (singular)
10737 expansion item, which extracts the working address from a single RFC2822
10738 address. See the &%filter%&, &%map%&, and &%reduce%& items for ways of
10739 processing lists.
10740
10741 To clarify "list of addresses in RFC 2822 format" mentioned above, Exim follows
10742 a strict interpretation of header line formatting.  Exim parses the bare,
10743 unquoted portion of an email address and if it finds a comma, treats it as an
10744 email address separator. For the example header line:
10745 .code
10746 From: =?iso-8859-2?Q?Last=2C_First?= <user@example.com>
10747 .endd
10748 The first example below demonstrates that Q-encoded email addresses are parsed
10749 properly if it is given the raw header (in this example, &`$rheader_from:`&).
10750 It does not see the comma because it's still encoded as "=2C".  The second
10751 example below is passed the contents of &`$header_from:`&, meaning it gets
10752 de-mimed. Exim sees the decoded "," so it treats it as &*two*& email addresses.
10753 The third example shows that the presence of a comma is skipped when it is
10754 quoted.  The fourth example shows SMTPUTF8 handling.
10755 .code
10756 # exim -be '${addresses:From: \
10757 =?iso-8859-2?Q?Last=2C_First?= <user@example.com>}'
10758 user@example.com
10759 # exim -be '${addresses:From: Last, First <user@example.com>}'
10760 Last:user@example.com
10761 # exim -be '${addresses:From: "Last, First" <user@example.com>}'
10762 user@example.com
10763 # exim -be '${addresses:フィル <フィリップ@example.jp>}'
10764 フィリップ@example.jp
10765 .endd
10766
10767 .vitem &*${base32:*&<&'digits'&>&*}*&
10768 .cindex "&%base32%& expansion item"
10769 .cindex "expansion" "conversion to base 32"
10770 The string must consist entirely of decimal digits. The number is converted to
10771 base 32 and output as a (empty, for zero) string of characters.
10772 Only lowercase letters are used.
10773
10774 .vitem &*${base32d:*&<&'base-32&~digits'&>&*}*&
10775 .cindex "&%base32d%& expansion item"
10776 .cindex "expansion" "conversion to base 32"
10777 The string must consist entirely of base-32 digits.
10778 The number is converted to decimal and output as a string.
10779
10780 .vitem &*${base62:*&<&'digits'&>&*}*&
10781 .cindex "&%base62%& expansion item"
10782 .cindex "expansion" "conversion to base 62"
10783 The string must consist entirely of decimal digits. The number is converted to
10784 base 62 and output as a string of six characters, including leading zeros. In
10785 the few operating environments where Exim uses base 36 instead of base 62 for
10786 its message identifiers (because those systems do not have case-sensitive
10787 filenames), base 36 is used by this operator, despite its name. &*Note*&: Just
10788 to be absolutely clear: this is &'not'& base64 encoding.
10789
10790 .vitem &*${base62d:*&<&'base-62&~digits'&>&*}*&
10791 .cindex "&%base62d%& expansion item"
10792 .cindex "expansion" "conversion to base 62"
10793 The string must consist entirely of base-62 digits, or, in operating
10794 environments where Exim uses base 36 instead of base 62 for its message
10795 identifiers, base-36 digits. The number is converted to decimal and output as a
10796 string.
10797
10798 .vitem &*${base64:*&<&'string'&>&*}*&
10799 .cindex "expansion" "base64 encoding"
10800 .cindex "base64 encoding" "in string expansion"
10801 .cindex "&%base64%& expansion item"
10802 .cindex certificate "base64 of DER"
10803 This operator converts a string into one that is base64 encoded.
10804
10805 If the string is a single variable of type certificate,
10806 returns the base64 encoding of the DER form of the certificate.
10807
10808
10809 .vitem &*${base64d:*&<&'string'&>&*}*&
10810 .cindex "expansion" "base64 decoding"
10811 .cindex "base64 decoding" "in string expansion"
10812 .cindex "&%base64d%& expansion item"
10813 This operator converts a base64-encoded string into the un-coded form.
10814
10815
10816 .vitem &*${domain:*&<&'string'&>&*}*&
10817 .cindex "domain" "extraction"
10818 .cindex "expansion" "domain extraction"
10819 The string is interpreted as an RFC 2822 address and the domain is extracted
10820 from it. If the string does not parse successfully, the result is empty.
10821
10822
10823 .vitem &*${escape:*&<&'string'&>&*}*&
10824 .cindex "expansion" "escaping non-printing characters"
10825 .cindex "&%escape%& expansion item"
10826 If the string contains any non-printing characters, they are converted to
10827 escape sequences starting with a backslash. Whether characters with the most
10828 significant bit set (so-called &"8-bit characters"&) count as printing or not
10829 is controlled by the &%print_topbitchars%& option.
10830
10831 .vitem &*${escape8bit:*&<&'string'&>&*}*&
10832 .cindex "expansion" "escaping 8-bit characters"
10833 .cindex "&%escape8bit%& expansion item"
10834 If the string contains and characters with the most significant bit set,
10835 they are converted to escape sequences starting with a backslash.
10836 Backslashes and DEL characters are also converted.
10837
10838
10839 .vitem &*${eval:*&<&'string'&>&*}*&&~and&~&*${eval10:*&<&'string'&>&*}*&
10840 .cindex "expansion" "expression evaluation"
10841 .cindex "expansion" "arithmetic expression"
10842 .cindex "&%eval%& expansion item"
10843 These items supports simple arithmetic and bitwise logical operations in
10844 expansion strings. The string (after expansion) must be a conventional
10845 arithmetic expression, but it is limited to basic arithmetic operators, bitwise
10846 logical operators, and parentheses. All operations are carried out using
10847 integer arithmetic. The operator priorities are as follows (the same as in the
10848 C programming language):
10849 .table2 70pt 300pt
10850 .irow &'highest:'& "not (~), negate (-)"
10851 .irow ""   "multiply (*), divide (/), remainder (%)"
10852 .irow ""   "plus (+), minus (-)"
10853 .irow ""   "shift-left (<<), shift-right (>>)"
10854 .irow ""   "and (&&)"
10855 .irow ""   "xor (^)"
10856 .irow &'lowest:'&  "or (|)"
10857 .endtable
10858 Binary operators with the same priority are evaluated from left to right. White
10859 space is permitted before or after operators.
10860
10861 For &%eval%&, numbers may be decimal, octal (starting with &"0"&) or
10862 hexadecimal (starting with &"0x"&). For &%eval10%&, all numbers are taken as
10863 decimal, even if they start with a leading zero; hexadecimal numbers are not
10864 permitted. This can be useful when processing numbers extracted from dates or
10865 times, which often do have leading zeros.
10866
10867 A number may be followed by &"K"&, &"M"& or &"G"& to multiply it by 1024, 1024*1024
10868 or 1024*1024*1024,
10869 respectively. Negative numbers are supported. The result of the computation is
10870 a decimal representation of the answer (without &"K"&, &"M"& or &"G"&). For example:
10871
10872 .display
10873 &`${eval:1+1}            `&  yields 2
10874 &`${eval:1+2*3}          `&  yields 7
10875 &`${eval:(1+2)*3}        `&  yields 9
10876 &`${eval:2+42%5}         `&  yields 4
10877 &`${eval:0xc&amp;5}          `&  yields 4
10878 &`${eval:0xc|5}          `&  yields 13
10879 &`${eval:0xc^5}          `&  yields 9
10880 &`${eval:0xc>>1}         `&  yields 6
10881 &`${eval:0xc<<1}         `&  yields 24
10882 &`${eval:~255&amp;0x1234}    `&  yields 4608
10883 &`${eval:-(~255&amp;0x1234)} `&  yields -4608
10884 .endd
10885
10886 As a more realistic example, in an ACL you might have
10887 .code
10888 deny   condition =                    \
10889          ${if and {                   \
10890            {>{$rcpt_count}{10}}       \
10891            {                          \
10892            <                          \
10893              {$recipients_count}      \
10894              {${eval:$rcpt_count/2}}  \
10895            }                          \
10896          }{yes}{no}}
10897        message = Too many bad recipients
10898 .endd
10899 The condition is true if there have been more than 10 RCPT commands and
10900 fewer than half of them have resulted in a valid recipient.
10901
10902
10903 .vitem &*${expand:*&<&'string'&>&*}*&
10904 .cindex "expansion" "re-expansion of substring"
10905 The &%expand%& operator causes a string to be expanded for a second time. For
10906 example,
10907 .code
10908 ${expand:${lookup{$domain}dbm{/some/file}{$value}}}
10909 .endd
10910 first looks up a string in a file while expanding the operand for &%expand%&,
10911 and then re-expands what it has found.
10912
10913
10914 .vitem &*${from_utf8:*&<&'string'&>&*}*&
10915 .cindex "Unicode"
10916 .cindex "UTF-8" "conversion from"
10917 .cindex "expansion" "UTF-8 conversion"
10918 .cindex "&%from_utf8%& expansion item"
10919 The world is slowly moving towards Unicode, although there are no standards for
10920 email yet. However, other applications (including some databases) are starting
10921 to store data in Unicode, using UTF-8 encoding. This operator converts from a
10922 UTF-8 string to an ISO-8859-1 string. UTF-8 code values greater than 255 are
10923 converted to underscores. The input must be a valid UTF-8 string. If it is not,
10924 the result is an undefined sequence of bytes.
10925
10926 Unicode code points with values less than 256 are compatible with ASCII and
10927 ISO-8859-1 (also known as Latin-1).
10928 For example, character 169 is the copyright symbol in both cases, though the
10929 way it is encoded is different. In UTF-8, more than one byte is needed for
10930 characters with code values greater than 127, whereas ISO-8859-1 is a
10931 single-byte encoding (but thereby limited to 256 characters). This makes
10932 translation from UTF-8 to ISO-8859-1 straightforward.
10933
10934
10935 .vitem &*${hash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
10936 .cindex "hash function" "textual"
10937 .cindex "expansion" "textual hash"
10938 The &%hash%& operator is a simpler interface to the hashing function that can
10939 be used when the two parameters are fixed numbers (as opposed to strings that
10940 change when expanded). The effect is the same as
10941 .code
10942 ${hash{<n>}{<m>}{<string>}}
10943 .endd
10944 See the description of the general &%hash%& item above for details. The
10945 abbreviation &%h%& can be used when &%hash%& is used as an operator.
10946
10947
10948
10949 .vitem &*${hex2b64:*&<&'hexstring'&>&*}*&
10950 .cindex "base64 encoding" "conversion from hex"
10951 .cindex "expansion" "hex to base64"
10952 .cindex "&%hex2b64%& expansion item"
10953 This operator converts a hex string into one that is base64 encoded. This can
10954 be useful for processing the output of the various hashing functions.
10955
10956
10957
10958 .vitem &*${hexquote:*&<&'string'&>&*}*&
10959 .cindex "quoting" "hex-encoded unprintable characters"
10960 .cindex "&%hexquote%& expansion item"
10961 This operator converts non-printable characters in a string into a hex
10962 escape form. Byte values between 33 (!) and 126 (~) inclusive are left
10963 as is, and other byte values are converted to &`\xNN`&, for example, a
10964 byte value 127 is converted to &`\x7f`&.
10965
10966
10967 .vitem &*${ipv6denorm:*&<&'string'&>&*}*&
10968 .cindex "&%ipv6denorm%& expansion item"
10969 .cindex "IP address" normalisation
10970 This expands an IPv6 address to a full eight-element colon-separated set
10971 of hex digits including leading zeroes.
10972 A trailing ipv4-style dotted-decimal set is converted to hex.
10973 Pure IPv4 addresses are converted to IPv4-mapped IPv6.
10974
10975 .vitem &*${ipv6norm:*&<&'string'&>&*}*&
10976 .cindex "&%ipv6norm%& expansion item"
10977 .cindex "IP address" normalisation
10978 .cindex "IP address" "canonical form"
10979 This converts an IPv6 address to canonical form.
10980 Leading zeroes of groups are omitted, and the longest
10981 set of zero-valued groups is replaced with a double colon.
10982 A trailing ipv4-style dotted-decimal set is converted to hex.
10983 Pure IPv4 addresses are converted to IPv4-mapped IPv6.
10984
10985
10986 .vitem &*${lc:*&<&'string'&>&*}*&
10987 .cindex "case forcing in strings"
10988 .cindex "string" "case forcing"
10989 .cindex "lower casing"
10990 .cindex "expansion" "case forcing"
10991 .cindex "&%lc%& expansion item"
10992 This forces the letters in the string into lower-case, for example:
10993 .code
10994 ${lc:$local_part}
10995 .endd
10996 Case is defined per the system C locale.
10997
10998 .vitem &*${length_*&<&'number'&>&*:*&<&'string'&>&*}*&
10999 .cindex "expansion" "string truncation"
11000 .cindex "&%length%& expansion item"
11001 The &%length%& operator is a simpler interface to the &%length%& function that
11002 can be used when the parameter is a fixed number (as opposed to a string that
11003 changes when expanded). The effect is the same as
11004 .code
11005 ${length{<number>}{<string>}}
11006 .endd
11007 See the description of the general &%length%& item above for details. Note that
11008 &%length%& is not the same as &%strlen%&. The abbreviation &%l%& can be used
11009 when &%length%& is used as an operator.
11010 All measurement is done in bytes and is not UTF-8 aware.
11011
11012
11013 .vitem &*${listcount:*&<&'string'&>&*}*&
11014 .cindex "expansion" "list item count"
11015 .cindex "list" "item count"
11016 .cindex "list" "count of items"
11017 .cindex "&%listcount%& expansion item"
11018 The string is interpreted as a list and the number of items is returned.
11019
11020
11021 .vitem &*${listnamed:*&<&'name'&>&*}*&&~and&~&*${listnamed_*&<&'type'&>&*:*&<&'name'&>&*}*&
11022 .cindex "expansion" "named list"
11023 .cindex "&%listnamed%& expansion item"
11024 The name is interpreted as a named list and the content of the list is returned,
11025 expanding any referenced lists, re-quoting as needed for colon-separation.
11026 If the optional type is given it must be one of "a", "d", "h" or "l"
11027 and selects address-, domain-, host- or localpart- lists to search among respectively.
11028 Otherwise all types are searched in an undefined order and the first
11029 matching list is returned.
11030
11031
11032 .vitem &*${local_part:*&<&'string'&>&*}*&
11033 .cindex "expansion" "local part extraction"
11034 .cindex "&%local_part%& expansion item"
11035 The string is interpreted as an RFC 2822 address and the local part is
11036 extracted from it. If the string does not parse successfully, the result is
11037 empty.
11038 The parsing correctly handles SMTPUTF8 Unicode in the string.
11039
11040
11041 .vitem &*${mask:*&<&'IP&~address'&>&*/*&<&'bit&~count'&>&*}*&
11042 .cindex "masked IP address"
11043 .cindex "IP address" "masking"
11044 .cindex "CIDR notation"
11045 .cindex "expansion" "IP address masking"
11046 .cindex "&%mask%& expansion item"
11047 If the form of the string to be operated on is not an IP address followed by a
11048 slash and an integer (that is, a network address in CIDR notation), the
11049 expansion fails. Otherwise, this operator converts the IP address to binary,
11050 masks off the least significant bits according to the bit count, and converts
11051 the result back to text, with mask appended. For example,
11052 .code
11053 ${mask:10.111.131.206/28}
11054 .endd
11055 returns the string &"10.111.131.192/28"&. Since this operation is expected to
11056 be mostly used for looking up masked addresses in files, the result for an IPv6
11057 address uses dots to separate components instead of colons, because colon
11058 terminates a key string in lsearch files. So, for example,
11059 .code
11060 ${mask:3ffe:ffff:836f:0a00:000a:0800:200a:c031/99}
11061 .endd
11062 returns the string
11063 .code
11064 3ffe.ffff.836f.0a00.000a.0800.2000.0000/99
11065 .endd
11066 Letters in IPv6 addresses are always output in lower case.
11067
11068
11069 .vitem &*${md5:*&<&'string'&>&*}*&
11070 .cindex "MD5 hash"
11071 .cindex "expansion" "MD5 hash"
11072 .cindex certificate fingerprint
11073 .cindex "&%md5%& expansion item"
11074 The &%md5%& operator computes the MD5 hash value of the string, and returns it
11075 as a 32-digit hexadecimal number, in which any letters are in lower case.
11076
11077 If the string is a single variable of type certificate,
11078 returns the MD5 hash fingerprint of the certificate.
11079
11080
11081 .vitem &*${nhash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
11082 .cindex "expansion" "numeric hash"
11083 .cindex "hash function" "numeric"
11084 The &%nhash%& operator is a simpler interface to the numeric hashing function
11085 that can be used when the two parameters are fixed numbers (as opposed to
11086 strings that change when expanded). The effect is the same as
11087 .code
11088 ${nhash{<n>}{<m>}{<string>}}
11089 .endd
11090 See the description of the general &%nhash%& item above for details.
11091
11092
11093 .vitem &*${quote:*&<&'string'&>&*}*&
11094 .cindex "quoting" "in string expansions"
11095 .cindex "expansion" "quoting"
11096 .cindex "&%quote%& expansion item"
11097 The &%quote%& operator puts its argument into double quotes if it
11098 is an empty string or
11099 contains anything other than letters, digits, underscores, dots, and hyphens.
11100 Any occurrences of double quotes and backslashes are escaped with a backslash.
11101 Newlines and carriage returns are converted to &`\n`& and &`\r`&,
11102 respectively For example,
11103 .code
11104 ${quote:ab"*"cd}
11105 .endd
11106 becomes
11107 .code
11108 "ab\"*\"cd"
11109 .endd
11110 The place where this is useful is when the argument is a substitution from a
11111 variable or a message header.
11112
11113 .vitem &*${quote_local_part:*&<&'string'&>&*}*&
11114 .cindex "&%quote_local_part%& expansion item"
11115 This operator is like &%quote%&, except that it quotes the string only if
11116 required to do so by the rules of RFC 2822 for quoting local parts. For
11117 example, a plus sign would not cause quoting (but it would for &%quote%&).
11118 If you are creating a new email address from the contents of &$local_part$&
11119 (or any other unknown data), you should always use this operator.
11120
11121 This quoting determination is not SMTPUTF8-aware, thus quoting non-ASCII data
11122 will likely use the quoting form.
11123 Thus &'${quote_local_part:フィル}'& will always become &'"フィル"'&.
11124
11125
11126 .vitem &*${quote_*&<&'lookup-type'&>&*:*&<&'string'&>&*}*&
11127 .cindex "quoting" "lookup-specific"
11128 This operator applies lookup-specific quoting rules to the string. Each
11129 query-style lookup type has its own quoting rules which are described with
11130 the lookups in chapter &<<CHAPfdlookup>>&. For example,
11131 .code
11132 ${quote_ldap:two * two}
11133 .endd
11134 returns
11135 .code
11136 two%20%5C2A%20two
11137 .endd
11138 For single-key lookup types, no quoting is ever necessary and this operator
11139 yields an unchanged string.
11140
11141
11142 .vitem &*${randint:*&<&'n'&>&*}*&
11143 .cindex "random number"
11144 This operator returns a somewhat random number which is less than the
11145 supplied number and is at least 0.  The quality of this randomness depends
11146 on how Exim was built; the values are not suitable for keying material.
11147 If Exim is linked against OpenSSL then RAND_pseudo_bytes() is used.
11148 If Exim is linked against GnuTLS then gnutls_rnd(GNUTLS_RND_NONCE) is used,
11149 for versions of GnuTLS with that function.
11150 Otherwise, the implementation may be arc4random(), random() seeded by
11151 srandomdev() or srandom(), or a custom implementation even weaker than
11152 random().
11153
11154
11155 .vitem &*${reverse_ip:*&<&'ipaddr'&>&*}*&
11156 .cindex "expansion" "IP address"
11157 This operator reverses an IP address; for IPv4 addresses, the result is in
11158 dotted-quad decimal form, while for IPv6 addresses the result is in
11159 dotted-nibble hexadecimal form.  In both cases, this is the "natural" form
11160 for DNS.  For example,
11161 .code
11162 ${reverse_ip:192.0.2.4}
11163 ${reverse_ip:2001:0db8:c42:9:1:abcd:192.0.2.127}
11164 .endd
11165 returns
11166 .code
11167 4.2.0.192
11168 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
11169 .endd
11170
11171
11172 .vitem &*${rfc2047:*&<&'string'&>&*}*&
11173 .cindex "expansion" "RFC 2047"
11174 .cindex "RFC 2047" "expansion operator"
11175 .cindex "&%rfc2047%& expansion item"
11176 This operator encodes text according to the rules of RFC 2047. This is an
11177 encoding that is used in header lines to encode non-ASCII characters. It is
11178 assumed that the input string is in the encoding specified by the
11179 &%headers_charset%& option, which gets its default at build time. If the string
11180 contains only characters in the range 33&--126, and no instances of the
11181 characters
11182 .code
11183 ? = ( ) < > @ , ; : \ " . [ ] _
11184 .endd
11185 it is not modified. Otherwise, the result is the RFC 2047 encoding of the
11186 string, using as many &"encoded words"& as necessary to encode all the
11187 characters.
11188
11189
11190 .vitem &*${rfc2047d:*&<&'string'&>&*}*&
11191 .cindex "expansion" "RFC 2047"
11192 .cindex "RFC 2047" "decoding"
11193 .cindex "&%rfc2047d%& expansion item"
11194 This operator decodes strings that are encoded as per RFC 2047. Binary zero
11195 bytes are replaced by question marks. Characters are converted into the
11196 character set defined by &%headers_charset%&. Overlong RFC 2047 &"words"& are
11197 not recognized unless &%check_rfc2047_length%& is set false.
11198
11199 &*Note*&: If you use &%$header%&_&'xxx'&&*:*& (or &%$h%&_&'xxx'&&*:*&) to
11200 access a header line, RFC 2047 decoding is done automatically. You do not need
11201 to use this operator as well.
11202
11203
11204
11205 .vitem &*${rxquote:*&<&'string'&>&*}*&
11206 .cindex "quoting" "in regular expressions"
11207 .cindex "regular expressions" "quoting"
11208 .cindex "&%rxquote%& expansion item"
11209 The &%rxquote%& operator inserts a backslash before any non-alphanumeric
11210 characters in its argument. This is useful when substituting the values of
11211 variables or headers inside regular expressions.
11212
11213
11214 .vitem &*${sha1:*&<&'string'&>&*}*&
11215 .cindex "SHA-1 hash"
11216 .cindex "expansion" "SHA-1 hashing"
11217 .cindex certificate fingerprint
11218 .cindex "&%sha1%& expansion item"
11219 The &%sha1%& operator computes the SHA-1 hash value of the string, and returns
11220 it as a 40-digit hexadecimal number, in which any letters are in upper case.
11221
11222 If the string is a single variable of type certificate,
11223 returns the SHA-1 hash fingerprint of the certificate.
11224
11225
11226 .vitem &*${sha256:*&<&'string'&>&*}*& &&&
11227        &*${sha2:*&<&'string'&>&*}*& &&&
11228        &*${sha2_<n>:*&<&'string'&>&*}*&
11229 .cindex "SHA-256 hash"
11230 .cindex "SHA-2 hash"
11231 .cindex certificate fingerprint
11232 .cindex "expansion" "SHA-256 hashing"
11233 .cindex "&%sha256%& expansion item"
11234 .cindex "&%sha2%& expansion item"
11235 The &%sha256%& operator computes the SHA-256 hash value of the string
11236 and returns
11237 it as a 64-digit hexadecimal number, in which any letters are in upper case.
11238
11239 If the string is a single variable of type certificate,
11240 returns the SHA-256 hash fingerprint of the certificate.
11241
11242 The operator can also be spelled &%sha2%& and does the same as &%sha256%&
11243 (except for certificates, which are not supported).
11244 Finally, if an underbar
11245 and a number is appended it specifies the output length, selecting a
11246 member of the SHA-2 family of hash functions.
11247 Values of 256, 384 and 512 are accepted, with 256 being the default.
11248
11249
11250 .vitem &*${sha3:*&<&'string'&>&*}*& &&&
11251        &*${sha3_<n>:*&<&'string'&>&*}*&
11252 .cindex "SHA3 hash"
11253 .cindex "expansion" "SHA3 hashing"
11254 .cindex "&%sha3%& expansion item"
11255 The &%sha3%& operator computes the SHA3-256 hash value of the string
11256 and returns
11257 it as a 64-digit hexadecimal number, in which any letters are in upper case.
11258
11259 If a number is appended, separated by an underbar, it specifies
11260 the output length.  Values of 224, 256, 384 and 512 are accepted;
11261 with 256 being the default.
11262
11263 The &%sha3%& expansion item is only supported if Exim has been
11264 compiled with GnuTLS 3.5.0 or later,
11265 or OpenSSL 1.1.1 or later.
11266 The macro "_CRYPTO_HASH_SHA3" will be defined if it is supported.
11267
11268
11269 .vitem &*${stat:*&<&'string'&>&*}*&
11270 .cindex "expansion" "statting a file"
11271 .cindex "file" "extracting characteristics"
11272 .cindex "&%stat%& expansion item"
11273 The string, after expansion, must be a file path. A call to the &[stat()]&
11274 function is made for this path. If &[stat()]& fails, an error occurs and the
11275 expansion fails. If it succeeds, the data from the stat replaces the item, as a
11276 series of <&'name'&>=<&'value'&> pairs, where the values are all numerical,
11277 except for the value of &"smode"&. The names are: &"mode"& (giving the mode as
11278 a 4-digit octal number), &"smode"& (giving the mode in symbolic format as a
11279 10-character string, as for the &'ls'& command), &"inode"&, &"device"&,
11280 &"links"&, &"uid"&, &"gid"&, &"size"&, &"atime"&, &"mtime"&, and &"ctime"&. You
11281 can extract individual fields using the &%extract%& expansion item.
11282
11283 The use of the &%stat%& expansion in users' filter files can be locked out by
11284 the system administrator. &*Warning*&: The file size may be incorrect on 32-bit
11285 systems for files larger than 2GB.
11286
11287 .vitem &*${str2b64:*&<&'string'&>&*}*&
11288 .cindex "&%str2b64%& expansion item"
11289 Now deprecated, a synonym for the &%base64%& expansion operator.
11290
11291
11292
11293 .vitem &*${strlen:*&<&'string'&>&*}*&
11294 .cindex "expansion" "string length"
11295 .cindex "string" "length in expansion"
11296 .cindex "&%strlen%& expansion item"
11297 The item is replace by the length of the expanded string, expressed as a
11298 decimal number. &*Note*&: Do not confuse &%strlen%& with &%length%&.
11299 All measurement is done in bytes and is not UTF-8 aware.
11300
11301
11302 .vitem &*${substr_*&<&'start'&>&*_*&<&'length'&>&*:*&<&'string'&>&*}*&
11303 .cindex "&%substr%& expansion item"
11304 .cindex "substring extraction"
11305 .cindex "expansion" "substring expansion"
11306 The &%substr%& operator is a simpler interface to the &%substr%& function that
11307 can be used when the two parameters are fixed numbers (as opposed to strings
11308 that change when expanded). The effect is the same as
11309 .code
11310 ${substr{<start>}{<length>}{<string>}}
11311 .endd
11312 See the description of the general &%substr%& item above for details. The
11313 abbreviation &%s%& can be used when &%substr%& is used as an operator.
11314 All measurement is done in bytes and is not UTF-8 aware.
11315
11316 .vitem &*${time_eval:*&<&'string'&>&*}*&
11317 .cindex "&%time_eval%& expansion item"
11318 .cindex "time interval" "decoding"
11319 This item converts an Exim time interval such as &`2d4h5m`& into a number of
11320 seconds.
11321
11322 .vitem &*${time_interval:*&<&'string'&>&*}*&
11323 .cindex "&%time_interval%& expansion item"
11324 .cindex "time interval" "formatting"
11325 The argument (after sub-expansion) must be a sequence of decimal digits that
11326 represents an interval of time as a number of seconds. It is converted into a
11327 number of larger units and output in Exim's normal time format, for example,
11328 &`1w3d4h2m6s`&.
11329
11330 .vitem &*${uc:*&<&'string'&>&*}*&
11331 .cindex "case forcing in strings"
11332 .cindex "string" "case forcing"
11333 .cindex "upper casing"
11334 .cindex "expansion" "case forcing"
11335 .cindex "&%uc%& expansion item"
11336 This forces the letters in the string into upper-case.
11337 Case is defined per the system C locale.
11338
11339 .vitem &*${utf8clean:*&<&'string'&>&*}*&
11340 .cindex "correction of invalid utf-8 sequences in strings"
11341 .cindex "utf-8" "utf-8 sequences"
11342 .cindex "incorrect utf-8"
11343 .cindex "expansion" "utf-8 forcing"
11344 .cindex "&%utf8clean%& expansion item"
11345 This replaces any invalid utf-8 sequence in the string by the character &`?`&.
11346 In versions of Exim before 4.92, this did not correctly do so for a truncated
11347 final codepoint's encoding, and the character would be silently dropped.
11348 If you must handle detection of this scenario across both sets of Exim behavior,
11349 the complexity will depend upon the task.
11350 For instance, to detect if the first character is multibyte and a 1-byte
11351 extraction can be successfully used as a path component (as is common for
11352 dividing up delivery folders), you might use:
11353 .code
11354 condition = ${if inlist{${utf8clean:${length_1:$local_part}}}{:?}{yes}{no}}
11355 .endd
11356 (which will false-positive if the first character of the local part is a
11357 literal question mark).
11358
11359 .vitem "&*${utf8_domain_to_alabel:*&<&'string'&>&*}*&" &&&
11360        "&*${utf8_domain_from_alabel:*&<&'string'&>&*}*&" &&&
11361        "&*${utf8_localpart_to_alabel:*&<&'string'&>&*}*&" &&&
11362        "&*${utf8_localpart_from_alabel:*&<&'string'&>&*}*&"
11363 .cindex expansion UTF-8
11364 .cindex UTF-8 expansion
11365 .cindex EAI
11366 .cindex internationalisation
11367 .cindex "&%utf8_domain_to_alabel%& expansion item"
11368 .cindex "&%utf8_domain_from_alabel%& expansion item"
11369 .cindex "&%utf8_localpart_to_alabel%& expansion item"
11370 .cindex "&%utf8_localpart_from_alabel%& expansion item"
11371 These convert EAI mail name components between UTF-8 and a-label forms.
11372 For information on internationalisation support see &<<SECTi18nMTA>>&.
11373 .endlist
11374
11375
11376
11377
11378
11379
11380 .section "Expansion conditions" "SECTexpcond"
11381 .scindex IIDexpcond "expansion" "conditions"
11382 The following conditions are available for testing by the &%${if%& construct
11383 while expanding strings:
11384
11385 .vlist
11386 .vitem &*!*&<&'condition'&>
11387 .cindex "expansion" "negating a condition"
11388 .cindex "negation" "in expansion condition"
11389 Preceding any condition with an exclamation mark negates the result of the
11390 condition.
11391
11392 .vitem <&'symbolic&~operator'&>&~&*{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11393 .cindex "numeric comparison"
11394 .cindex "expansion" "numeric comparison"
11395 There are a number of symbolic operators for doing numeric comparisons. They
11396 are:
11397 .display
11398 &`=   `&   equal
11399 &`==  `&   equal
11400 &`>   `&   greater
11401 &`>=  `&   greater or equal
11402 &`<   `&   less
11403 &`<=  `&   less or equal
11404 .endd
11405 For example:
11406 .code
11407 ${if >{$message_size}{10M} ...
11408 .endd
11409 Note that the general negation operator provides for inequality testing. The
11410 two strings must take the form of optionally signed decimal integers,
11411 optionally followed by one of the letters &"K"&, &"M"& or &"G"& (in either upper or
11412 lower case), signifying multiplication by 1024, 1024*1024 or 1024*1024*1024, respectively.
11413 As a special case, the numerical value of an empty string is taken as
11414 zero.
11415
11416 In all cases, a relative comparator OP is testing if <&'string1'&> OP
11417 <&'string2'&>; the above example is checking if &$message_size$& is larger than
11418 10M, not if 10M is larger than &$message_size$&.
11419
11420
11421 .vitem &*acl&~{{*&<&'name'&>&*}{*&<&'arg1'&>&*}&&&
11422         {*&<&'arg2'&>&*}...}*&
11423 .cindex "expansion" "calling an acl"
11424 .cindex "&%acl%&" "expansion condition"
11425 The name and zero to nine argument strings are first expanded separately.  The expanded
11426 arguments are assigned to the variables &$acl_arg1$& to &$acl_arg9$& in order.
11427 Any unused are made empty.  The variable &$acl_narg$& is set to the number of
11428 arguments.  The named ACL (see chapter &<<CHAPACL>>&) is called
11429 and may use the variables; if another acl expansion is used the values
11430 are restored after it returns.  If the ACL sets
11431 a value using a "message =" modifier the variable $value becomes
11432 the result of the expansion, otherwise it is empty.
11433 If the ACL returns accept the condition is true; if deny, false.
11434 If the ACL returns defer the result is a forced-fail.
11435
11436 .vitem &*bool&~{*&<&'string'&>&*}*&
11437 .cindex "expansion" "boolean parsing"
11438 .cindex "&%bool%& expansion condition"
11439 This condition turns a string holding a true or false representation into
11440 a boolean state.  It parses &"true"&, &"false"&, &"yes"& and &"no"&
11441 (case-insensitively); also integer numbers map to true if non-zero,
11442 false if zero.
11443 An empty string is treated as false.
11444 Leading and trailing whitespace is ignored;
11445 thus a string consisting only of whitespace is false.
11446 All other string values will result in expansion failure.
11447
11448 When combined with ACL variables, this expansion condition will let you
11449 make decisions in one place and act on those decisions in another place.
11450 For example:
11451 .code
11452 ${if bool{$acl_m_privileged_sender} ...
11453 .endd
11454
11455
11456 .vitem &*bool_lax&~{*&<&'string'&>&*}*&
11457 .cindex "expansion" "boolean parsing"
11458 .cindex "&%bool_lax%& expansion condition"
11459 Like &%bool%&, this condition turns a string into a boolean state.  But
11460 where &%bool%& accepts a strict set of strings, &%bool_lax%& uses the same
11461 loose definition that the Router &%condition%& option uses.  The empty string
11462 and the values &"false"&, &"no"& and &"0"& map to false, all others map to
11463 true.  Leading and trailing whitespace is ignored.
11464
11465 Note that where &"bool{00}"& is false, &"bool_lax{00}"& is true.
11466
11467 .vitem &*crypteq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11468 .cindex "expansion" "encrypted comparison"
11469 .cindex "encrypted strings, comparing"
11470 .cindex "&%crypteq%& expansion condition"
11471 This condition is included in the Exim binary if it is built to support any
11472 authentication mechanisms (see chapter &<<CHAPSMTPAUTH>>&). Otherwise, it is
11473 necessary to define SUPPORT_CRYPTEQ in &_Local/Makefile_& to get &%crypteq%&
11474 included in the binary.
11475
11476 The &%crypteq%& condition has two arguments. The first is encrypted and
11477 compared against the second, which is already encrypted. The second string may
11478 be in the LDAP form for storing encrypted strings, which starts with the
11479 encryption type in curly brackets, followed by the data. If the second string
11480 does not begin with &"{"& it is assumed to be encrypted with &[crypt()]& or
11481 &[crypt16()]& (see below), since such strings cannot begin with &"{"&.
11482 Typically this will be a field from a password file. An example of an encrypted
11483 string in LDAP form is:
11484 .code
11485 {md5}CY9rzUYh03PK3k6DJie09g==
11486 .endd
11487 If such a string appears directly in an expansion, the curly brackets have to
11488 be quoted, because they are part of the expansion syntax. For example:
11489 .code
11490 ${if crypteq {test}{\{md5\}CY9rzUYh03PK3k6DJie09g==}{yes}{no}}
11491 .endd
11492 The following encryption types (whose names are matched case-independently) are
11493 supported:
11494
11495 .ilist
11496 .cindex "MD5 hash"
11497 .cindex "base64 encoding" "in encrypted password"
11498 &%{md5}%& computes the MD5 digest of the first string, and expresses this as
11499 printable characters to compare with the remainder of the second string. If the
11500 length of the comparison string is 24, Exim assumes that it is base64 encoded
11501 (as in the above example). If the length is 32, Exim assumes that it is a
11502 hexadecimal encoding of the MD5 digest. If the length not 24 or 32, the
11503 comparison fails.
11504
11505 .next
11506 .cindex "SHA-1 hash"
11507 &%{sha1}%& computes the SHA-1 digest of the first string, and expresses this as
11508 printable characters to compare with the remainder of the second string. If the
11509 length of the comparison string is 28, Exim assumes that it is base64 encoded.
11510 If the length is 40, Exim assumes that it is a hexadecimal encoding of the
11511 SHA-1 digest. If the length is not 28 or 40, the comparison fails.
11512
11513 .next
11514 .cindex "&[crypt()]&"
11515 &%{crypt}%& calls the &[crypt()]& function, which traditionally used to use
11516 only the first eight characters of the password. However, in modern operating
11517 systems this is no longer true, and in many cases the entire password is used,
11518 whatever its length.
11519
11520 .next
11521 .cindex "&[crypt16()]&"
11522 &%{crypt16}%& calls the &[crypt16()]& function, which was originally created to
11523 use up to 16 characters of the password in some operating systems. Again, in
11524 modern operating systems, more characters may be used.
11525 .endlist
11526 Exim has its own version of &[crypt16()]&, which is just a double call to
11527 &[crypt()]&. For operating systems that have their own version, setting
11528 HAVE_CRYPT16 in &_Local/Makefile_& when building Exim causes it to use the
11529 operating system version instead of its own. This option is set by default in
11530 the OS-dependent &_Makefile_& for those operating systems that are known to
11531 support &[crypt16()]&.
11532
11533 Some years after Exim's &[crypt16()]& was implemented, a user discovered that
11534 it was not using the same algorithm as some operating systems' versions. It
11535 turns out that as well as &[crypt16()]& there is a function called
11536 &[bigcrypt()]& in some operating systems. This may or may not use the same
11537 algorithm, and both of them may be different to Exim's built-in &[crypt16()]&.
11538
11539 However, since there is now a move away from the traditional &[crypt()]&
11540 functions towards using SHA1 and other algorithms, tidying up this area of
11541 Exim is seen as very low priority.
11542
11543 If you do not put a encryption type (in curly brackets) in a &%crypteq%&
11544 comparison, the default is usually either &`{crypt}`& or &`{crypt16}`&, as
11545 determined by the setting of DEFAULT_CRYPT in &_Local/Makefile_&. The default
11546 default is &`{crypt}`&. Whatever the default, you can always use either
11547 function by specifying it explicitly in curly brackets.
11548
11549 .vitem &*def:*&<&'variable&~name'&>
11550 .cindex "expansion" "checking for empty variable"
11551 .cindex "&%def%& expansion condition"
11552 The &%def%& condition must be followed by the name of one of the expansion
11553 variables defined in section &<<SECTexpvar>>&. The condition is true if the
11554 variable does not contain the empty string. For example:
11555 .code
11556 ${if def:sender_ident {from $sender_ident}}
11557 .endd
11558 Note that the variable name is given without a leading &%$%& character. If the
11559 variable does not exist, the expansion fails.
11560
11561 .vitem "&*def:header_*&<&'header&~name'&>&*:*&&~&~or&~&&&
11562         &~&*def:h_*&<&'header&~name'&>&*:*&"
11563 .cindex "expansion" "checking header line existence"
11564 This condition is true if a message is being processed and the named header
11565 exists in the message. For example,
11566 .code
11567 ${if def:header_reply-to:{$h_reply-to:}{$h_from:}}
11568 .endd
11569 &*Note*&: No &%$%& appears before &%header_%& or &%h_%& in the condition, and
11570 the header name must be terminated by a colon if white space does not follow.
11571
11572 .vitem &*eq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11573        &*eqi&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11574 .cindex "string" "comparison"
11575 .cindex "expansion" "string comparison"
11576 .cindex "&%eq%& expansion condition"
11577 .cindex "&%eqi%& expansion condition"
11578 The two substrings are first expanded. The condition is true if the two
11579 resulting strings are identical. For &%eq%& the comparison includes the case of
11580 letters, whereas for &%eqi%& the comparison is case-independent, where
11581 case is defined per the system C locale.
11582
11583 .vitem &*exists&~{*&<&'file&~name'&>&*}*&
11584 .cindex "expansion" "file existence test"
11585 .cindex "file" "existence test"
11586 .cindex "&%exists%&, expansion condition"
11587 The substring is first expanded and then interpreted as an absolute path. The
11588 condition is true if the named file (or directory) exists. The existence test
11589 is done by calling the &[stat()]& function. The use of the &%exists%& test in
11590 users' filter files may be locked out by the system administrator.
11591
11592 .vitem &*first_delivery*&
11593 .cindex "delivery" "first"
11594 .cindex "first delivery"
11595 .cindex "expansion" "first delivery test"
11596 .cindex "&%first_delivery%& expansion condition"
11597 This condition, which has no data, is true during a message's first delivery
11598 attempt. It is false during any subsequent delivery attempts.
11599
11600
11601 .vitem "&*forall{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&" &&&
11602        "&*forany{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&"
11603 .cindex "list" "iterative conditions"
11604 .cindex "expansion" "&*forall*& condition"
11605 .cindex "expansion" "&*forany*& condition"
11606 .vindex "&$item$&"
11607 These conditions iterate over a list. The first argument is expanded to form
11608 the list. By default, the list separator is a colon, but it can be changed by
11609 the normal method (&<<SECTlistsepchange>>&).
11610 The second argument is interpreted as a condition that is to
11611 be applied to each item in the list in turn. During the interpretation of the
11612 condition, the current list item is placed in a variable called &$item$&.
11613 .ilist
11614 For &*forany*&, interpretation stops if the condition is true for any item, and
11615 the result of the whole condition is true. If the condition is false for all
11616 items in the list, the overall condition is false.
11617 .next
11618 For &*forall*&, interpretation stops if the condition is false for any item,
11619 and the result of the whole condition is false. If the condition is true for
11620 all items in the list, the overall condition is true.
11621 .endlist
11622 Note that negation of &*forany*& means that the condition must be false for all
11623 items for the overall condition to succeed, and negation of &*forall*& means
11624 that the condition must be false for at least one item. In this example, the
11625 list separator is changed to a comma:
11626 .code
11627 ${if forany{<, $recipients}{match{$item}{^user3@}}{yes}{no}}
11628 .endd
11629 The value of &$item$& is saved and restored while &%forany%& or &%forall%& is
11630 being processed, to enable these expansion items to be nested.
11631
11632 To scan a named list, expand it with the &*listnamed*& operator.
11633
11634 .vitem "&*forall_json{*&<&'a JSON array'&>&*}{*&<&'a condition'&>&*}*&" &&&
11635        "&*forany_json{*&<&'a JSON array'&>&*}{*&<&'a condition'&>&*}*&" &&&
11636        "&*forall_jsons{*&<&'a JSON array'&>&*}{*&<&'a condition'&>&*}*&" &&&
11637        "&*forany_jsons{*&<&'a JSON array'&>&*}{*&<&'a condition'&>&*}*&"
11638 .cindex JSON "iterative conditions"
11639 .cindex JSON expansions
11640 .cindex expansion "&*forall_json*& condition"
11641 .cindex expansion "&*forany_json*& condition"
11642 .cindex expansion "&*forall_jsons*& condition"
11643 .cindex expansion "&*forany_jsons*& condition"
11644 As for the above, except that the first argument must, after expansion,
11645 be a JSON array.
11646 The array separator is not changeable.
11647 For the &"jsons"& variants the elements are expected to be JSON strings
11648 and have their quotes removed before the evaluation of the condition.
11649
11650
11651
11652 .vitem &*ge&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11653        &*gei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11654 .cindex "string" "comparison"
11655 .cindex "expansion" "string comparison"
11656 .cindex "&%ge%& expansion condition"
11657 .cindex "&%gei%& expansion condition"
11658 The two substrings are first expanded. The condition is true if the first
11659 string is lexically greater than or equal to the second string. For &%ge%& the
11660 comparison includes the case of letters, whereas for &%gei%& the comparison is
11661 case-independent.
11662 Case and collation order are defined per the system C locale.
11663
11664 .vitem &*gt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11665        &*gti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11666 .cindex "string" "comparison"
11667 .cindex "expansion" "string comparison"
11668 .cindex "&%gt%& expansion condition"
11669 .cindex "&%gti%& expansion condition"
11670 The two substrings are first expanded. The condition is true if the first
11671 string is lexically greater than the second string. For &%gt%& the comparison
11672 includes the case of letters, whereas for &%gti%& the comparison is
11673 case-independent.
11674 Case and collation order are defined per the system C locale.
11675
11676 .vitem &*inlist&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11677        &*inlisti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11678 .cindex "string" "comparison"
11679 .cindex "list" "iterative conditions"
11680 Both strings are expanded; the second string is treated as a list of simple
11681 strings; if the first string is a member of the second, then the condition
11682 is true.
11683 For the case-independent &%inlisti%& condition, case is defined per the system C locale.
11684
11685 These are simpler to use versions of the more powerful &*forany*& condition.
11686 Examples, and the &*forany*& equivalents:
11687 .code
11688 ${if inlist{needle}{foo:needle:bar}}
11689   ${if forany{foo:needle:bar}{eq{$item}{needle}}}
11690 ${if inlisti{Needle}{fOo:NeeDLE:bAr}}
11691   ${if forany{fOo:NeeDLE:bAr}{eqi{$item}{Needle}}}
11692 .endd
11693
11694 .vitem &*isip&~{*&<&'string'&>&*}*&  &&&
11695        &*isip4&~{*&<&'string'&>&*}*& &&&
11696        &*isip6&~{*&<&'string'&>&*}*&
11697 .cindex "IP address" "testing string format"
11698 .cindex "string" "testing for IP address"
11699 .cindex "&%isip%& expansion condition"
11700 .cindex "&%isip4%& expansion condition"
11701 .cindex "&%isip6%& expansion condition"
11702 The substring is first expanded, and then tested to see if it has the form of
11703 an IP address. Both IPv4 and IPv6 addresses are valid for &%isip%&, whereas
11704 &%isip4%& and &%isip6%& test specifically for IPv4 or IPv6 addresses.
11705
11706 For an IPv4 address, the test is for four dot-separated components, each of
11707 which consists of from one to three digits. For an IPv6 address, up to eight
11708 colon-separated components are permitted, each containing from one to four
11709 hexadecimal digits. There may be fewer than eight components if an empty
11710 component (adjacent colons) is present. Only one empty component is permitted.
11711
11712 &*Note*&: The checks used to be just on the form of the address; actual numerical
11713 values were not considered. Thus, for example, 999.999.999.999 passed the IPv4
11714 check.
11715 This is no longer the case.
11716
11717 The main use of these tests is to distinguish between IP addresses and
11718 host names, or between IPv4 and IPv6 addresses. For example, you could use
11719 .code
11720 ${if isip4{$sender_host_address}...
11721 .endd
11722 to test which IP version an incoming SMTP connection is using.
11723
11724 .vitem &*ldapauth&~{*&<&'ldap&~query'&>&*}*&
11725 .cindex "LDAP" "use for authentication"
11726 .cindex "expansion" "LDAP authentication test"
11727 .cindex "&%ldapauth%& expansion condition"
11728 This condition supports user authentication using LDAP. See section
11729 &<<SECTldap>>& for details of how to use LDAP in lookups and the syntax of
11730 queries. For this use, the query must contain a user name and password. The
11731 query itself is not used, and can be empty. The condition is true if the
11732 password is not empty, and the user name and password are accepted by the LDAP
11733 server. An empty password is rejected without calling LDAP because LDAP binds
11734 with an empty password are considered anonymous regardless of the username, and
11735 will succeed in most configurations. See chapter &<<CHAPSMTPAUTH>>& for details
11736 of SMTP authentication, and chapter &<<CHAPplaintext>>& for an example of how
11737 this can be used.
11738
11739
11740 .vitem &*le&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11741        &*lei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11742 .cindex "string" "comparison"
11743 .cindex "expansion" "string comparison"
11744 .cindex "&%le%& expansion condition"
11745 .cindex "&%lei%& expansion condition"
11746 The two substrings are first expanded. The condition is true if the first
11747 string is lexically less than or equal to the second string. For &%le%& the
11748 comparison includes the case of letters, whereas for &%lei%& the comparison is
11749 case-independent.
11750 Case and collation order are defined per the system C locale.
11751
11752 .vitem &*lt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11753        &*lti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11754 .cindex "string" "comparison"
11755 .cindex "expansion" "string comparison"
11756 .cindex "&%lt%& expansion condition"
11757 .cindex "&%lti%& expansion condition"
11758 The two substrings are first expanded. The condition is true if the first
11759 string is lexically less than the second string. For &%lt%& the comparison
11760 includes the case of letters, whereas for &%lti%& the comparison is
11761 case-independent.
11762 Case and collation order are defined per the system C locale.
11763
11764
11765 .vitem &*match&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11766 .cindex "expansion" "regular expression comparison"
11767 .cindex "regular expressions" "match in expanded string"
11768 .cindex "&%match%& expansion condition"
11769 The two substrings are first expanded. The second is then treated as a regular
11770 expression and applied to the first. Because of the pre-expansion, if the
11771 regular expression contains dollar, or backslash characters, they must be
11772 escaped. Care must also be taken if the regular expression contains braces
11773 (curly brackets). A closing brace must be escaped so that it is not taken as a
11774 premature termination of <&'string2'&>. The easiest approach is to use the
11775 &`\N`& feature to disable expansion of the regular expression.
11776 For example,
11777 .code
11778 ${if match {$local_part}{\N^\d{3}\N} ...
11779 .endd
11780 If the whole expansion string is in double quotes, further escaping of
11781 backslashes is also required.
11782
11783 The condition is true if the regular expression match succeeds.
11784 The regular expression is not required to begin with a circumflex
11785 metacharacter, but if there is no circumflex, the expression is not anchored,
11786 and it may match anywhere in the subject, not just at the start. If you want
11787 the pattern to match at the end of the subject, you must include the &`$`&
11788 metacharacter at an appropriate point.
11789 All character handling is done in bytes and is not UTF-8 aware,
11790 but we might change this in a future Exim release.
11791
11792 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%if%& expansion"
11793 At the start of an &%if%& expansion the values of the numeric variable
11794 substitutions &$1$& etc. are remembered. Obeying a &%match%& condition that
11795 succeeds causes them to be reset to the substrings of that condition and they
11796 will have these values during the expansion of the success string. At the end
11797 of the &%if%& expansion, the previous values are restored. After testing a
11798 combination of conditions using &%or%&, the subsequent values of the numeric
11799 variables are those of the condition that succeeded.
11800
11801 .vitem &*match_address&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11802 .cindex "&%match_address%& expansion condition"
11803 See &*match_local_part*&.
11804
11805 .vitem &*match_domain&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11806 .cindex "&%match_domain%& expansion condition"
11807 See &*match_local_part*&.
11808
11809 .vitem &*match_ip&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11810 .cindex "&%match_ip%& expansion condition"
11811 This condition matches an IP address to a list of IP address patterns. It must
11812 be followed by two argument strings. The first (after expansion) must be an IP
11813 address or an empty string. The second (not expanded) is a restricted host
11814 list that can match only an IP address, not a host name. For example:
11815 .code
11816 ${if match_ip{$sender_host_address}{1.2.3.4:5.6.7.8}{...}{...}}
11817 .endd
11818 The specific types of host list item that are permitted in the list are:
11819
11820 .ilist
11821 An IP address, optionally with a CIDR mask.
11822 .next
11823 A single asterisk, which matches any IP address.
11824 .next
11825 An empty item, which matches only if the IP address is empty. This could be
11826 useful for testing for a locally submitted message or one from specific hosts
11827 in a single test such as
11828 . ==== As this is a nested list, any displays it contains must be indented
11829 . ==== as otherwise they are too far to the left. This comment applies to
11830 . ==== the use of xmlto plus fop. There's no problem when formatting with
11831 . ==== sdop, with or without the extra indent.
11832 .code
11833   ${if match_ip{$sender_host_address}{:4.3.2.1:...}{...}{...}}
11834 .endd
11835 where the first item in the list is the empty string.
11836 .next
11837 The item @[] matches any of the local host's interface addresses.
11838 .next
11839 Single-key lookups are assumed to be like &"net-"& style lookups in host lists,
11840 even if &`net-`& is not specified. There is never any attempt to turn the IP
11841 address into a host name. The most common type of linear search for
11842 &*match_ip*& is likely to be &*iplsearch*&, in which the file can contain CIDR
11843 masks. For example:
11844 .code
11845   ${if match_ip{$sender_host_address}{iplsearch;/some/file}...
11846 .endd
11847 It is of course possible to use other kinds of lookup, and in such a case, you
11848 do need to specify the &`net-`& prefix if you want to specify a specific
11849 address mask, for example:
11850 .code
11851   ${if match_ip{$sender_host_address}{net24-dbm;/some/file}...
11852 .endd
11853 However, unless you are combining a &%match_ip%& condition with others, it is
11854 just as easy to use the fact that a lookup is itself a condition, and write:
11855 .code
11856   ${lookup{${mask:$sender_host_address/24}}dbm{/a/file}...
11857 .endd
11858 .endlist ilist
11859
11860 Note that <&'string2'&> is not itself subject to string expansion, unless
11861 Exim was built with the EXPAND_LISTMATCH_RHS option.
11862
11863 Consult section &<<SECThoslispatip>>& for further details of these patterns.
11864
11865 .vitem &*match_local_part&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11866 .cindex "domain list" "in expansion condition"
11867 .cindex "address list" "in expansion condition"
11868 .cindex "local part" "list, in expansion condition"
11869 .cindex "&%match_local_part%& expansion condition"
11870 This condition, together with &%match_address%& and &%match_domain%&, make it
11871 possible to test domain, address, and local part lists within expansions. Each
11872 condition requires two arguments: an item and a list to match. A trivial
11873 example is:
11874 .code
11875 ${if match_domain{a.b.c}{x.y.z:a.b.c:p.q.r}{yes}{no}}
11876 .endd
11877 In each case, the second argument may contain any of the allowable items for a
11878 list of the appropriate type. Also, because the second argument
11879 is a standard form of list, it is possible to refer to a named list.
11880 Thus, you can use conditions like this:
11881 .code
11882 ${if match_domain{$domain}{+local_domains}{...
11883 .endd
11884 .cindex "&`+caseful`&"
11885 For address lists, the matching starts off caselessly, but the &`+caseful`&
11886 item can be used, as in all address lists, to cause subsequent items to
11887 have their local parts matched casefully. Domains are always matched
11888 caselessly.
11889
11890 Note that <&'string2'&> is not itself subject to string expansion, unless
11891 Exim was built with the EXPAND_LISTMATCH_RHS option.
11892
11893 &*Note*&: Host lists are &'not'& supported in this way. This is because
11894 hosts have two identities: a name and an IP address, and it is not clear
11895 how to specify cleanly how such a test would work. However, IP addresses can be
11896 matched using &%match_ip%&.
11897
11898 .vitem &*pam&~{*&<&'string1'&>&*:*&<&'string2'&>&*:...}*&
11899 .cindex "PAM authentication"
11900 .cindex "AUTH" "with PAM"
11901 .cindex "Solaris" "PAM support"
11902 .cindex "expansion" "PAM authentication test"
11903 .cindex "&%pam%& expansion condition"
11904 &'Pluggable Authentication Modules'&
11905 (&url(https://mirrors.edge.kernel.org/pub/linux/libs/pam/)) are a facility that is
11906 available in the latest releases of Solaris and in some GNU/Linux
11907 distributions. The Exim support, which is intended for use in conjunction with
11908 the SMTP AUTH command, is available only if Exim is compiled with
11909 .code
11910 SUPPORT_PAM=yes
11911 .endd
11912 in &_Local/Makefile_&. You probably need to add &%-lpam%& to EXTRALIBS, and
11913 in some releases of GNU/Linux &%-ldl%& is also needed.
11914
11915 The argument string is first expanded, and the result must be a
11916 colon-separated list of strings. Leading and trailing white space is ignored.
11917 The PAM module is initialized with the service name &"exim"& and the user name
11918 taken from the first item in the colon-separated data string (<&'string1'&>).
11919 The remaining items in the data string are passed over in response to requests
11920 from the authentication function. In the simple case there will only be one
11921 request, for a password, so the data consists of just two strings.
11922
11923 There can be problems if any of the strings are permitted to contain colon
11924 characters. In the usual way, these have to be doubled to avoid being taken as
11925 separators. If the data is being inserted from a variable, the &%sg%& expansion
11926 item can be used to double any existing colons. For example, the configuration
11927 of a LOGIN authenticator might contain this setting:
11928 .code
11929 server_condition = ${if pam{$auth1:${sg{$auth2}{:}{::}}}}
11930 .endd
11931 For a PLAIN authenticator you could use:
11932 .code
11933 server_condition = ${if pam{$auth2:${sg{$auth3}{:}{::}}}}
11934 .endd
11935 In some operating systems, PAM authentication can be done only from a process
11936 running as root. Since Exim is running as the Exim user when receiving
11937 messages, this means that PAM cannot be used directly in those systems.
11938 . --- 2018-09-07: the pam_exim modified variant has gone, removed claims re using Exim via that
11939
11940
11941 .vitem &*pwcheck&~{*&<&'string1'&>&*:*&<&'string2'&>&*}*&
11942 .cindex "&'pwcheck'& daemon"
11943 .cindex "Cyrus"
11944 .cindex "expansion" "&'pwcheck'& authentication test"
11945 .cindex "&%pwcheck%& expansion condition"
11946 This condition supports user authentication using the Cyrus &'pwcheck'& daemon.
11947 This is one way of making it possible for passwords to be checked by a process
11948 that is not running as root. &*Note*&: The use of &'pwcheck'& is now
11949 deprecated. Its replacement is &'saslauthd'& (see below).
11950
11951 The pwcheck support is not included in Exim by default. You need to specify
11952 the location of the pwcheck daemon's socket in &_Local/Makefile_& before
11953 building Exim. For example:
11954 .code
11955 CYRUS_PWCHECK_SOCKET=/var/pwcheck/pwcheck
11956 .endd
11957 You do not need to install the full Cyrus software suite in order to use
11958 the pwcheck daemon. You can compile and install just the daemon alone
11959 from the Cyrus SASL library. Ensure that &'exim'& is the only user that has
11960 access to the &_/var/pwcheck_& directory.
11961
11962 The &%pwcheck%& condition takes one argument, which must be the user name and
11963 password, separated by a colon. For example, in a LOGIN authenticator
11964 configuration, you might have this:
11965 .code
11966 server_condition = ${if pwcheck{$auth1:$auth2}}
11967 .endd
11968 Again, for a PLAIN authenticator configuration, this would be:
11969 .code
11970 server_condition = ${if pwcheck{$auth2:$auth3}}
11971 .endd
11972 .vitem &*queue_running*&
11973 .cindex "queue runner" "detecting when delivering from"
11974 .cindex "expansion" "queue runner test"
11975 .cindex "&%queue_running%& expansion condition"
11976 This condition, which has no data, is true during delivery attempts that are
11977 initiated by queue runner processes, and false otherwise.
11978
11979
11980 .vitem &*radius&~{*&<&'authentication&~string'&>&*}*&
11981 .cindex "Radius"
11982 .cindex "expansion" "Radius authentication"
11983 .cindex "&%radius%& expansion condition"
11984 Radius authentication (RFC 2865) is supported in a similar way to PAM. You must
11985 set RADIUS_CONFIG_FILE in &_Local/Makefile_& to specify the location of
11986 the Radius client configuration file in order to build Exim with Radius
11987 support.
11988
11989 With just that one setting, Exim expects to be linked with the &%radiusclient%&
11990 library, using the original API. If you are using release 0.4.0 or later of
11991 this library, you need to set
11992 .code
11993 RADIUS_LIB_TYPE=RADIUSCLIENTNEW
11994 .endd
11995 in &_Local/Makefile_& when building Exim. You can also link Exim with the
11996 &%libradius%& library that comes with FreeBSD. To do this, set
11997 .code
11998 RADIUS_LIB_TYPE=RADLIB
11999 .endd
12000 in &_Local/Makefile_&, in addition to setting RADIUS_CONFIGURE_FILE.
12001 You may also have to supply a suitable setting in EXTRALIBS so that the
12002 Radius library can be found when Exim is linked.
12003
12004 The string specified by RADIUS_CONFIG_FILE is expanded and passed to the
12005 Radius client library, which calls the Radius server. The condition is true if
12006 the authentication is successful. For example:
12007 .code
12008 server_condition = ${if radius{<arguments>}}
12009 .endd
12010
12011
12012 .vitem "&*saslauthd&~{{*&<&'user'&>&*}{*&<&'password'&>&*}&&&
12013         {*&<&'service'&>&*}{*&<&'realm'&>&*}}*&"
12014 .cindex "&'saslauthd'& daemon"
12015 .cindex "Cyrus"
12016 .cindex "expansion" "&'saslauthd'& authentication test"
12017 .cindex "&%saslauthd%& expansion condition"
12018 This condition supports user authentication using the Cyrus &'saslauthd'&
12019 daemon. This replaces the older &'pwcheck'& daemon, which is now deprecated.
12020 Using this daemon is one way of making it possible for passwords to be checked
12021 by a process that is not running as root.
12022
12023 The saslauthd support is not included in Exim by default. You need to specify
12024 the location of the saslauthd daemon's socket in &_Local/Makefile_& before
12025 building Exim. For example:
12026 .code
12027 CYRUS_SASLAUTHD_SOCKET=/var/state/saslauthd/mux
12028 .endd
12029 You do not need to install the full Cyrus software suite in order to use
12030 the saslauthd daemon. You can compile and install just the daemon alone
12031 from the Cyrus SASL library.
12032
12033 Up to four arguments can be supplied to the &%saslauthd%& condition, but only
12034 two are mandatory. For example:
12035 .code
12036 server_condition = ${if saslauthd{{$auth1}{$auth2}}}
12037 .endd
12038 The service and the realm are optional (which is why the arguments are enclosed
12039 in their own set of braces). For details of the meaning of the service and
12040 realm, and how to run the daemon, consult the Cyrus documentation.
12041 .endlist vlist
12042
12043
12044
12045 .section "Combining expansion conditions" "SECID84"
12046 .cindex "expansion" "combining conditions"
12047 Several conditions can be tested at once by combining them using the &%and%&
12048 and &%or%& combination conditions. Note that &%and%& and &%or%& are complete
12049 conditions on their own, and precede their lists of sub-conditions. Each
12050 sub-condition must be enclosed in braces within the overall braces that contain
12051 the list. No repetition of &%if%& is used.
12052
12053
12054 .vlist
12055 .vitem &*or&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
12056 .cindex "&""or""& expansion condition"
12057 .cindex "expansion" "&""or""& of conditions"
12058 The sub-conditions are evaluated from left to right. The condition is true if
12059 any one of the sub-conditions is true.
12060 For example,
12061 .code
12062 ${if or {{eq{$local_part}{spqr}}{eq{$domain}{testing.com}}}...
12063 .endd
12064 When a true sub-condition is found, the following ones are parsed but not
12065 evaluated. If there are several &"match"& sub-conditions the values of the
12066 numeric variables afterwards are taken from the first one that succeeds.
12067
12068 .vitem &*and&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
12069 .cindex "&""and""& expansion condition"
12070 .cindex "expansion" "&""and""& of conditions"
12071 The sub-conditions are evaluated from left to right. The condition is true if
12072 all of the sub-conditions are true. If there are several &"match"&
12073 sub-conditions, the values of the numeric variables afterwards are taken from
12074 the last one. When a false sub-condition is found, the following ones are
12075 parsed but not evaluated.
12076 .endlist
12077 .ecindex IIDexpcond
12078
12079
12080
12081
12082 .section "Expansion variables" "SECTexpvar"
12083 .cindex "expansion" "variables, list of"
12084 This section contains an alphabetical list of all the expansion variables. Some
12085 of them are available only when Exim is compiled with specific options such as
12086 support for TLS or the content scanning extension.
12087
12088 .vlist
12089 .vitem "&$0$&, &$1$&, etc"
12090 .cindex "numerical variables (&$1$& &$2$& etc)"
12091 When a &%match%& expansion condition succeeds, these variables contain the
12092 captured substrings identified by the regular expression during subsequent
12093 processing of the success string of the containing &%if%& expansion item.
12094 In the expansion condition case
12095 they do not retain their values afterwards; in fact, their previous
12096 values are restored at the end of processing an &%if%& item. The numerical
12097 variables may also be set externally by some other matching process which
12098 precedes the expansion of the string. For example, the commands available in
12099 Exim filter files include an &%if%& command with its own regular expression
12100 matching condition.
12101
12102 .vitem "&$acl_arg1$&, &$acl_arg2$&, etc"
12103 Within an acl condition, expansion condition or expansion item
12104 any arguments are copied to these variables,
12105 any unused variables being made empty.
12106
12107 .vitem "&$acl_c...$&"
12108 Values can be placed in these variables by the &%set%& modifier in an ACL. They
12109 can be given any name that starts with &$acl_c$& and is at least six characters
12110 long, but the sixth character must be either a digit or an underscore. For
12111 example: &$acl_c5$&, &$acl_c_mycount$&. The values of the &$acl_c...$&
12112 variables persist throughout the lifetime of an SMTP connection. They can be
12113 used to pass information between ACLs and between different invocations of the
12114 same ACL. When a message is received, the values of these variables are saved
12115 with the message, and can be accessed by filters, routers, and transports
12116 during subsequent delivery.
12117
12118 .vitem "&$acl_m...$&"
12119 These variables are like the &$acl_c...$& variables, except that their values
12120 are reset after a message has been received. Thus, if several messages are
12121 received in one SMTP connection, &$acl_m...$& values are not passed on from one
12122 message to the next, as &$acl_c...$& values are. The &$acl_m...$& variables are
12123 also reset by MAIL, RSET, EHLO, HELO, and after starting a TLS session. When a
12124 message is received, the values of these variables are saved with the message,
12125 and can be accessed by filters, routers, and transports during subsequent
12126 delivery.
12127
12128 .vitem &$acl_narg$&
12129 Within an acl condition, expansion condition or expansion item
12130 this variable has the number of arguments.
12131
12132 .vitem &$acl_verify_message$&
12133 .vindex "&$acl_verify_message$&"
12134 After an address verification has failed, this variable contains the failure
12135 message. It retains its value for use in subsequent modifiers. The message can
12136 be preserved by coding like this:
12137 .code
12138 warn !verify = sender
12139      set acl_m0 = $acl_verify_message
12140 .endd
12141 You can use &$acl_verify_message$& during the expansion of the &%message%& or
12142 &%log_message%& modifiers, to include information about the verification
12143 failure.
12144
12145 .vitem &$address_data$&
12146 .vindex "&$address_data$&"
12147 This variable is set by means of the &%address_data%& option in routers. The
12148 value then remains with the address while it is processed by subsequent routers
12149 and eventually a transport. If the transport is handling multiple addresses,
12150 the value from the first address is used. See chapter &<<CHAProutergeneric>>&
12151 for more details. &*Note*&: The contents of &$address_data$& are visible in
12152 user filter files.
12153
12154 If &$address_data$& is set when the routers are called from an ACL to verify
12155 a recipient address, the final value is still in the variable for subsequent
12156 conditions and modifiers of the ACL statement. If routing the address caused it
12157 to be redirected to just one address, the child address is also routed as part
12158 of the verification, and in this case the final value of &$address_data$& is
12159 from the child's routing.
12160
12161 If &$address_data$& is set when the routers are called from an ACL to verify a
12162 sender address, the final value is also preserved, but this time in
12163 &$sender_address_data$&, to distinguish it from data from a recipient
12164 address.
12165
12166 In both cases (recipient and sender verification), the value does not persist
12167 after the end of the current ACL statement. If you want to preserve
12168 these values for longer, you can save them in ACL variables.
12169
12170 .vitem &$address_file$&
12171 .vindex "&$address_file$&"
12172 When, as a result of aliasing, forwarding, or filtering, a message is directed
12173 to a specific file, this variable holds the name of the file when the transport
12174 is running. At other times, the variable is empty. For example, using the
12175 default configuration, if user &%r2d2%& has a &_.forward_& file containing
12176 .code
12177 /home/r2d2/savemail
12178 .endd
12179 then when the &(address_file)& transport is running, &$address_file$&
12180 contains the text string &`/home/r2d2/savemail`&.
12181 .cindex "Sieve filter" "value of &$address_file$&"
12182 For Sieve filters, the value may be &"inbox"& or a relative folder name. It is
12183 then up to the transport configuration to generate an appropriate absolute path
12184 to the relevant file.
12185
12186 .vitem &$address_pipe$&
12187 .vindex "&$address_pipe$&"
12188 When, as a result of aliasing or forwarding, a message is directed to a pipe,
12189 this variable holds the pipe command when the transport is running.
12190
12191 .vitem "&$auth1$& &-- &$auth3$&"
12192 .vindex "&$auth1$&, &$auth2$&, etc"
12193 These variables are used in SMTP authenticators (see chapters
12194 &<<CHAPplaintext>>&&--&<<CHAPtlsauth>>&). Elsewhere, they are empty.
12195
12196 .vitem &$authenticated_id$&
12197 .cindex "authentication" "id"
12198 .vindex "&$authenticated_id$&"
12199 When a server successfully authenticates a client it may be configured to
12200 preserve some of the authentication information in the variable
12201 &$authenticated_id$& (see chapter &<<CHAPSMTPAUTH>>&). For example, a
12202 user/password authenticator configuration might preserve the user name for use
12203 in the routers. Note that this is not the same information that is saved in
12204 &$sender_host_authenticated$&.
12205
12206 When a message is submitted locally (that is, not over a TCP connection)
12207 the value of &$authenticated_id$& is normally the login name of the calling
12208 process. However, a trusted user can override this by means of the &%-oMai%&
12209 command line option.
12210 This second case also sets up information used by the
12211 &$authresults$& expansion item.
12212
12213 .vitem &$authenticated_fail_id$&
12214 .cindex "authentication" "fail" "id"
12215 .vindex "&$authenticated_fail_id$&"
12216 When an authentication attempt fails, the variable &$authenticated_fail_id$&
12217 will contain the failed authentication id. If more than one authentication
12218 id is attempted, it will contain only the last one. The variable is
12219 available for processing in the ACL's, generally the quit or notquit ACL.
12220 A message to a local recipient could still be accepted without requiring
12221 authentication, which means this variable could also be visible in all of
12222 the ACL's as well.
12223
12224
12225 .vitem &$authenticated_sender$&
12226 .cindex "sender" "authenticated"
12227 .cindex "authentication" "sender"
12228 .cindex "AUTH" "on MAIL command"
12229 .vindex "&$authenticated_sender$&"
12230 When acting as a server, Exim takes note of the AUTH= parameter on an incoming
12231 SMTP MAIL command if it believes the sender is sufficiently trusted, as
12232 described in section &<<SECTauthparamail>>&. Unless the data is the string
12233 &"<>"&, it is set as the authenticated sender of the message, and the value is
12234 available during delivery in the &$authenticated_sender$& variable. If the
12235 sender is not trusted, Exim accepts the syntax of AUTH=, but ignores the data.
12236
12237 .vindex "&$qualify_domain$&"
12238 When a message is submitted locally (that is, not over a TCP connection), the
12239 value of &$authenticated_sender$& is an address constructed from the login
12240 name of the calling process and &$qualify_domain$&, except that a trusted user
12241 can override this by means of the &%-oMas%& command line option.
12242
12243
12244 .vitem &$authentication_failed$&
12245 .cindex "authentication" "failure"
12246 .vindex "&$authentication_failed$&"
12247 This variable is set to &"1"& in an Exim server if a client issues an AUTH
12248 command that does not succeed. Otherwise it is set to &"0"&. This makes it
12249 possible to distinguish between &"did not try to authenticate"&
12250 (&$sender_host_authenticated$& is empty and &$authentication_failed$& is set to
12251 &"0"&) and &"tried to authenticate but failed"& (&$sender_host_authenticated$&
12252 is empty and &$authentication_failed$& is set to &"1"&). Failure includes any
12253 negative response to an AUTH command, including (for example) an attempt to use
12254 an undefined mechanism.
12255
12256 .vitem &$av_failed$&
12257 .cindex "content scanning" "AV scanner failure"
12258 This variable is available when Exim is compiled with the content-scanning
12259 extension. It is set to &"0"& by default, but will be set to &"1"& if any
12260 problem occurs with the virus scanner (specified by &%av_scanner%&) during
12261 the ACL malware condition.
12262
12263 .vitem &$body_linecount$&
12264 .cindex "message body" "line count"
12265 .cindex "body of message" "line count"
12266 .vindex "&$body_linecount$&"
12267 When a message is being received or delivered, this variable contains the
12268 number of lines in the message's body. See also &$message_linecount$&.
12269
12270 .vitem &$body_zerocount$&
12271 .cindex "message body" "binary zero count"
12272 .cindex "body of message" "binary zero count"
12273 .cindex "binary zero" "in message body"
12274 .vindex "&$body_zerocount$&"
12275 When a message is being received or delivered, this variable contains the
12276 number of binary zero bytes (ASCII NULs) in the message's body.
12277
12278 .vitem &$bounce_recipient$&
12279 .vindex "&$bounce_recipient$&"
12280 This is set to the recipient address of a bounce message while Exim is creating
12281 it. It is useful if a customized bounce message text file is in use (see
12282 chapter &<<CHAPemsgcust>>&).
12283
12284 .vitem &$bounce_return_size_limit$&
12285 .vindex "&$bounce_return_size_limit$&"
12286 This contains the value set in the &%bounce_return_size_limit%& option, rounded
12287 up to a multiple of 1000. It is useful when a customized error message text
12288 file is in use (see chapter &<<CHAPemsgcust>>&).
12289
12290 .vitem &$caller_gid$&
12291 .cindex "gid (group id)" "caller"
12292 .vindex "&$caller_gid$&"
12293 The real group id under which the process that called Exim was running. This is
12294 not the same as the group id of the originator of a message (see
12295 &$originator_gid$&). If Exim re-execs itself, this variable in the new
12296 incarnation normally contains the Exim gid.
12297
12298 .vitem &$caller_uid$&
12299 .cindex "uid (user id)" "caller"
12300 .vindex "&$caller_uid$&"
12301 The real user id under which the process that called Exim was running. This is
12302 not the same as the user id of the originator of a message (see
12303 &$originator_uid$&). If Exim re-execs itself, this variable in the new
12304 incarnation normally contains the Exim uid.
12305
12306 .vitem &$callout_address$&
12307 .vindex "&$callout_address$&"
12308 After a callout for verification, spamd or malware daemon service, the
12309 address that was connected to.
12310
12311 .vitem &$compile_number$&
12312 .vindex "&$compile_number$&"
12313 The building process for Exim keeps a count of the number
12314 of times it has been compiled. This serves to distinguish different
12315 compilations of the same version of Exim.
12316
12317 .vitem &$config_dir$&
12318 .vindex "&$config_dir$&"
12319 The directory name of the main configuration file. That is, the content of
12320 &$config_file$& with the last component stripped. The value does not
12321 contain the trailing slash. If &$config_file$& does not contain a slash,
12322 &$config_dir$& is ".".
12323
12324 .vitem &$config_file$&
12325 .vindex "&$config_file$&"
12326 The name of the main configuration file Exim is using.
12327
12328 .vitem &$dkim_verify_status$&
12329 Results of DKIM verification.
12330 For details see section &<<SECDKIMVFY>>&.
12331
12332 .vitem &$dkim_cur_signer$& &&&
12333        &$dkim_verify_reason$& &&&
12334        &$dkim_domain$& &&&
12335        &$dkim_identity$& &&&
12336        &$dkim_selector$& &&&
12337        &$dkim_algo$& &&&
12338        &$dkim_canon_body$& &&&
12339        &$dkim_canon_headers$& &&&
12340        &$dkim_copiedheaders$& &&&
12341        &$dkim_bodylength$& &&&
12342        &$dkim_created$& &&&
12343        &$dkim_expires$& &&&
12344        &$dkim_headernames$& &&&
12345        &$dkim_key_testing$& &&&
12346        &$dkim_key_nosubdomains$& &&&
12347        &$dkim_key_srvtype$& &&&
12348        &$dkim_key_granularity$& &&&
12349        &$dkim_key_notes$& &&&
12350        &$dkim_key_length$&
12351 These variables are only available within the DKIM ACL.
12352 For details see section &<<SECDKIMVFY>>&.
12353
12354 .vitem &$dkim_signers$&
12355 .vindex &$dkim_signers$&
12356 When a message has been received this variable contains
12357 a colon-separated list of signer domains and identities for the message.
12358 For details see section &<<SECDKIMVFY>>&.
12359
12360 .vitem &$dmarc_domain_policy$& &&&
12361        &$dmarc_status$& &&&
12362        &$dmarc_status_text$& &&&
12363        &$dmarc_used_domains$&
12364 Results of DMARC verification.
12365 For details see section &<<SECDMARC>>&.
12366
12367 .vitem &$dnslist_domain$& &&&
12368        &$dnslist_matched$& &&&
12369        &$dnslist_text$& &&&
12370        &$dnslist_value$&
12371 .vindex "&$dnslist_domain$&"
12372 .vindex "&$dnslist_matched$&"
12373 .vindex "&$dnslist_text$&"
12374 .vindex "&$dnslist_value$&"
12375 .cindex "black list (DNS)"
12376 When a DNS (black) list lookup succeeds, these variables are set to contain
12377 the following data from the lookup: the list's domain name, the key that was
12378 looked up, the contents of any associated TXT record, and the value from the
12379 main A record. See section &<<SECID204>>& for more details.
12380
12381 .vitem &$domain$&
12382 .vindex "&$domain$&"
12383 When an address is being routed, or delivered on its own, this variable
12384 contains the domain. Uppercase letters in the domain are converted into lower
12385 case for &$domain$&.
12386
12387 Global address rewriting happens when a message is received, so the value of
12388 &$domain$& during routing and delivery is the value after rewriting. &$domain$&
12389 is set during user filtering, but not during system filtering, because a
12390 message may have many recipients and the system filter is called just once.
12391
12392 When more than one address is being delivered at once (for example, several
12393 RCPT commands in one SMTP delivery), &$domain$& is set only if they all
12394 have the same domain. Transports can be restricted to handling only one domain
12395 at a time if the value of &$domain$& is required at transport time &-- this is
12396 the default for local transports. For further details of the environment in
12397 which local transports are run, see chapter &<<CHAPenvironment>>&.
12398
12399 .oindex "&%delay_warning_condition%&"
12400 At the end of a delivery, if all deferred addresses have the same domain, it is
12401 set in &$domain$& during the expansion of &%delay_warning_condition%&.
12402
12403 The &$domain$& variable is also used in some other circumstances:
12404
12405 .ilist
12406 When an ACL is running for a RCPT command, &$domain$& contains the domain of
12407 the recipient address. The domain of the &'sender'& address is in
12408 &$sender_address_domain$& at both MAIL time and at RCPT time. &$domain$& is not
12409 normally set during the running of the MAIL ACL. However, if the sender address
12410 is verified with a callout during the MAIL ACL, the sender domain is placed in
12411 &$domain$& during the expansions of &%hosts%&, &%interface%&, and &%port%& in
12412 the &(smtp)& transport.
12413
12414 .next
12415 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
12416 &$domain$& contains the domain portion of the address that is being rewritten;
12417 it can be used in the expansion of the replacement address, for example, to
12418 rewrite domains by file lookup.
12419
12420 .next
12421 With one important exception, whenever a domain list is being scanned,
12422 &$domain$& contains the subject domain. &*Exception*&: When a domain list in
12423 a &%sender_domains%& condition in an ACL is being processed, the subject domain
12424 is in &$sender_address_domain$& and not in &$domain$&. It works this way so
12425 that, in a RCPT ACL, the sender domain list can be dependent on the
12426 recipient domain (which is what is in &$domain$& at this time).
12427
12428 .next
12429 .cindex "ETRN" "value of &$domain$&"
12430 .oindex "&%smtp_etrn_command%&"
12431 When the &%smtp_etrn_command%& option is being expanded, &$domain$& contains
12432 the complete argument of the ETRN command (see section &<<SECTETRN>>&).
12433 .endlist
12434
12435 .new
12436 .cindex "tainted data"
12437 If the origin of the data is an incoming message,
12438 the result of expanding this variable is tainted.
12439 When un untainted version is needed, one should be obtained from
12440 looking up the value in a local (therefore trusted) database.
12441 Often &$domain_data$& is usable in this role.
12442 .wen
12443
12444
12445 .vitem &$domain_data$&
12446 .vindex "&$domain_data$&"
12447 When the &%domains%& option on a router matches a domain by
12448 means of a lookup, the data read by the lookup is available during the running
12449 of the router as &$domain_data$&. In addition, if the driver routes the
12450 address to a transport, the value is available in that transport. If the
12451 transport is handling multiple addresses, the value from the first address is
12452 used.
12453
12454 &$domain_data$& is also set when the &%domains%& condition in an ACL matches a
12455 domain by means of a lookup. The data read by the lookup is available during
12456 the rest of the ACL statement. In all other situations, this variable expands
12457 to nothing.
12458
12459 .vitem &$exim_gid$&
12460 .vindex "&$exim_gid$&"
12461 This variable contains the numerical value of the Exim group id.
12462
12463 .vitem &$exim_path$&
12464 .vindex "&$exim_path$&"
12465 This variable contains the path to the Exim binary.
12466
12467 .vitem &$exim_uid$&
12468 .vindex "&$exim_uid$&"
12469 This variable contains the numerical value of the Exim user id.
12470
12471 .vitem &$exim_version$&
12472 .vindex "&$exim_version$&"
12473 This variable contains the version string of the Exim build.
12474 The first character is a major version number, currently 4.
12475 Then after a dot, the next group of digits is a minor version number.
12476 There may be other characters following the minor version.
12477 This value may be overridden by the &%exim_version%& main config option.
12478
12479 .vitem &$header_$&<&'name'&>
12480 This is not strictly an expansion variable. It is expansion syntax for
12481 inserting the message header line with the given name. Note that the name must
12482 be terminated by colon or white space, because it may contain a wide variety of
12483 characters. Note also that braces must &'not'& be used.
12484 See the full description in section &<<SECTexpansionitems>>& above.
12485
12486 .vitem &$headers_added$&
12487 .vindex "&$headers_added$&"
12488 Within an ACL this variable contains the headers added so far by
12489 the ACL modifier add_header (section &<<SECTaddheadacl>>&).
12490 The headers are a newline-separated list.
12491
12492 .vitem &$home$&
12493 .vindex "&$home$&"
12494 When the &%check_local_user%& option is set for a router, the user's home
12495 directory is placed in &$home$& when the check succeeds. In particular, this
12496 means it is set during the running of users' filter files. A router may also
12497 explicitly set a home directory for use by a transport; this can be overridden
12498 by a setting on the transport itself.
12499
12500 When running a filter test via the &%-bf%& option, &$home$& is set to the value
12501 of the environment variable HOME, which is subject to the
12502 &%keep_environment%& and &%add_environment%& main config options.
12503
12504 .vitem &$host$&
12505 .vindex "&$host$&"
12506 If a router assigns an address to a transport (any transport), and passes a
12507 list of hosts with the address, the value of &$host$& when the transport starts
12508 to run is the name of the first host on the list. Note that this applies both
12509 to local and remote transports.
12510
12511 .cindex "transport" "filter"
12512 .cindex "filter" "transport filter"
12513 For the &(smtp)& transport, if there is more than one host, the value of
12514 &$host$& changes as the transport works its way through the list. In
12515 particular, when the &(smtp)& transport is expanding its options for encryption
12516 using TLS, or for specifying a transport filter (see chapter
12517 &<<CHAPtransportgeneric>>&), &$host$& contains the name of the host to which it
12518 is connected.
12519
12520 When used in the client part of an authenticator configuration (see chapter
12521 &<<CHAPSMTPAUTH>>&), &$host$& contains the name of the server to which the
12522 client is connected.
12523
12524
12525 .vitem &$host_address$&
12526 .vindex "&$host_address$&"
12527 This variable is set to the remote host's IP address whenever &$host$& is set
12528 for a remote connection. It is also set to the IP address that is being checked
12529 when the &%ignore_target_hosts%& option is being processed.
12530
12531 .vitem &$host_data$&
12532 .vindex "&$host_data$&"
12533 If a &%hosts%& condition in an ACL is satisfied by means of a lookup, the
12534 result of the lookup is made available in the &$host_data$& variable. This
12535 allows you, for example, to do things like this:
12536 .code
12537 deny  hosts = net-lsearch;/some/file
12538       message = $host_data
12539 .endd
12540 .vitem &$host_lookup_deferred$&
12541 .cindex "host name" "lookup, failure of"
12542 .vindex "&$host_lookup_deferred$&"
12543 This variable normally contains &"0"&, as does &$host_lookup_failed$&. When a
12544 message comes from a remote host and there is an attempt to look up the host's
12545 name from its IP address, and the attempt is not successful, one of these
12546 variables is set to &"1"&.
12547
12548 .ilist
12549 If the lookup receives a definite negative response (for example, a DNS lookup
12550 succeeded, but no records were found), &$host_lookup_failed$& is set to &"1"&.
12551
12552 .next
12553 If there is any kind of problem during the lookup, such that Exim cannot
12554 tell whether or not the host name is defined (for example, a timeout for a DNS
12555 lookup), &$host_lookup_deferred$& is set to &"1"&.
12556 .endlist ilist
12557
12558 Looking up a host's name from its IP address consists of more than just a
12559 single reverse lookup. Exim checks that a forward lookup of at least one of the
12560 names it receives from a reverse lookup yields the original IP address. If this
12561 is not the case, Exim does not accept the looked up name(s), and
12562 &$host_lookup_failed$& is set to &"1"&. Thus, being able to find a name from an
12563 IP address (for example, the existence of a PTR record in the DNS) is not
12564 sufficient on its own for the success of a host name lookup. If the reverse
12565 lookup succeeds, but there is a lookup problem such as a timeout when checking
12566 the result, the name is not accepted, and &$host_lookup_deferred$& is set to
12567 &"1"&. See also &$sender_host_name$&.
12568
12569 .cindex authentication "expansion item"
12570 Performing these checks sets up information used by the
12571 &%authresults%& expansion item.
12572
12573
12574 .vitem &$host_lookup_failed$&
12575 .vindex "&$host_lookup_failed$&"
12576 See &$host_lookup_deferred$&.
12577
12578 .vitem &$host_port$&
12579 .vindex "&$host_port$&"
12580 This variable is set to the remote host's TCP port whenever &$host$& is set
12581 for an outbound connection.
12582
12583 .vitem &$initial_cwd$&
12584 .vindex "&$initial_cwd$&
12585 This variable contains the full path name of the initial working
12586 directory of the current Exim process. This may differ from the current
12587 working directory, as Exim changes this to "/" during early startup, and
12588 to &$spool_directory$& later.
12589
12590 .vitem &$inode$&
12591 .vindex "&$inode$&"
12592 The only time this variable is set is while expanding the &%directory_file%&
12593 option in the &(appendfile)& transport. The variable contains the inode number
12594 of the temporary file which is about to be renamed. It can be used to construct
12595 a unique name for the file.
12596
12597 .vitem &$interface_address$&
12598 .vindex "&$interface_address$&"
12599 This is an obsolete name for &$received_ip_address$&.
12600
12601 .vitem &$interface_port$&
12602 .vindex "&$interface_port$&"
12603 This is an obsolete name for &$received_port$&.
12604
12605 .vitem &$item$&
12606 .vindex "&$item$&"
12607 This variable is used during the expansion of &*forall*& and &*forany*&
12608 conditions (see section &<<SECTexpcond>>&), and &*filter*&, &*map*&, and
12609 &*reduce*& items (see section &<<SECTexpcond>>&). In other circumstances, it is
12610 empty.
12611
12612 .vitem &$ldap_dn$&
12613 .vindex "&$ldap_dn$&"
12614 This variable, which is available only when Exim is compiled with LDAP support,
12615 contains the DN from the last entry in the most recently successful LDAP
12616 lookup.
12617
12618 .vitem &$load_average$&
12619 .vindex "&$load_average$&"
12620 This variable contains the system load average, multiplied by 1000 so that it
12621 is an integer. For example, if the load average is 0.21, the value of the
12622 variable is 210. The value is recomputed every time the variable is referenced.
12623
12624 .vitem &$local_part$&
12625 .vindex "&$local_part$&"
12626 When an address is being routed, or delivered on its own, this
12627 variable contains the local part. When a number of addresses are being
12628 delivered together (for example, multiple RCPT commands in an SMTP
12629 session), &$local_part$& is not set.
12630
12631 Global address rewriting happens when a message is received, so the value of
12632 &$local_part$& during routing and delivery is the value after rewriting.
12633 &$local_part$& is set during user filtering, but not during system filtering,
12634 because a message may have many recipients and the system filter is called just
12635 once.
12636
12637 .new
12638 .cindex "tainted data"
12639 If the origin of the data is an incoming message,
12640 the result of expanding this variable is tainted.
12641
12642 &*Warning*&: the content of this variable is usually provided by a potential
12643 attacker.
12644 Consider carefully the implications of using it unvalidated as a name
12645 for file access.
12646 This presents issues for users' &_.forward_& and filter files.
12647 For traditional full user accounts, use &%check_local_users%& and the
12648 &$local_part_data$& variable rather than this one.
12649 For virtual users, store a suitable pathname component in the database
12650 which is used for account name validation, and use that retrieved value
12651 rather than this variable.
12652 Often &$local_part_data$& is usable in this role.
12653 If needed, use a router &%address_data%& or &%set%& option for
12654 the retrieved data.
12655 .wen
12656
12657 When a message is being delivered to a file, pipe, or autoreply transport as a
12658 result of aliasing or forwarding, &$local_part$& is set to the local part of
12659 the parent address, not to the filename or command (see &$address_file$& and
12660 &$address_pipe$&).
12661
12662 When an ACL is running for a RCPT command, &$local_part$& contains the
12663 local part of the recipient address.
12664
12665 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
12666 &$local_part$& contains the local part of the address that is being rewritten;
12667 it can be used in the expansion of the replacement address, for example.
12668
12669 In all cases, all quoting is removed from the local part. For example, for both
12670 the addresses
12671 .code
12672 "abc:xyz"@test.example
12673 abc\:xyz@test.example
12674 .endd
12675 the value of &$local_part$& is
12676 .code
12677 abc:xyz
12678 .endd
12679 If you use &$local_part$& to create another address, you should always wrap it
12680 inside a quoting operator. For example, in a &(redirect)& router you could
12681 have:
12682 .code
12683 data = ${quote_local_part:$local_part}@new.domain.example
12684 .endd
12685 &*Note*&: The value of &$local_part$& is normally lower cased. If you want
12686 to process local parts in a case-dependent manner in a router, you can set the
12687 &%caseful_local_part%& option (see chapter &<<CHAProutergeneric>>&).
12688
12689 .vitem &$local_part_data$&
12690 .vindex "&$local_part_data$&"
12691 When the &%local_parts%& option on a router matches a local part by means of a
12692 lookup, the data read by the lookup is available during the running of the
12693 router as &$local_part_data$&. In addition, if the driver routes the address
12694 to a transport, the value is available in that transport. If the transport is
12695 handling multiple addresses, the value from the first address is used.
12696
12697 .new
12698 The &%check_local_user%& router option also sets this variable.
12699 .wen
12700
12701 &$local_part_data$& is also set when the &%local_parts%& condition in an ACL
12702 matches a local part by means of a lookup. The data read by the lookup is
12703 available during the rest of the ACL statement. In all other situations, this
12704 variable expands to nothing.
12705
12706 .vindex &$local_part_prefix$& &&&
12707         &$local_part_prefix_v$& &&&
12708         &$local_part_suffix$& &&&
12709         &$local_part_suffix_v$&
12710 .cindex affix variables
12711 If a local part prefix or suffix has been recognized, it is not included in the
12712 value of &$local_part$& during routing and subsequent delivery. The values of
12713 any prefix or suffix are in &$local_part_prefix$& and
12714 &$local_part_suffix$&, respectively.
12715 .new
12716 .cindex "tainted data"
12717 If the specification did not include a wildcard then
12718 the affix variable value is not tainted.
12719
12720 If the affix specification included a wildcard then the portion of
12721 the affix matched by the wildcard is in
12722 &$local_part_prefix_v$& or &$local_part_suffix_v$& as appropriate,
12723 and both the whole and varying values are tainted.
12724 .wen
12725
12726 .vitem &$local_scan_data$&
12727 .vindex "&$local_scan_data$&"
12728 This variable contains the text returned by the &[local_scan()]& function when
12729 a message is received. See chapter &<<CHAPlocalscan>>& for more details.
12730
12731 .vitem &$local_user_gid$&
12732 .vindex "&$local_user_gid$&"
12733 See &$local_user_uid$&.
12734
12735 .vitem &$local_user_uid$&
12736 .vindex "&$local_user_uid$&"
12737 This variable and &$local_user_gid$& are set to the uid and gid after the
12738 &%check_local_user%& router precondition succeeds. This means that their values
12739 are available for the remaining preconditions (&%senders%&, &%require_files%&,
12740 and &%condition%&), for the &%address_data%& expansion, and for any
12741 router-specific expansions. At all other times, the values in these variables
12742 are &`(uid_t)(-1)`& and &`(gid_t)(-1)`&, respectively.
12743
12744 .vitem &$localhost_number$&
12745 .vindex "&$localhost_number$&"
12746 This contains the expanded value of the
12747 &%localhost_number%& option. The expansion happens after the main options have
12748 been read.
12749
12750 .vitem &$log_inodes$&
12751 .vindex "&$log_inodes$&"
12752 The number of free inodes in the disk partition where Exim's
12753 log files are being written. The value is recalculated whenever the variable is
12754 referenced. If the relevant file system does not have the concept of inodes,
12755 the value of is -1. See also the &%check_log_inodes%& option.
12756
12757 .vitem &$log_space$&
12758 .vindex "&$log_space$&"
12759 The amount of free space (as a number of kilobytes) in the disk
12760 partition where Exim's log files are being written. The value is recalculated
12761 whenever the variable is referenced. If the operating system does not have the
12762 ability to find the amount of free space (only true for experimental systems),
12763 the space value is -1. See also the &%check_log_space%& option.
12764
12765
12766 .vitem &$lookup_dnssec_authenticated$&
12767 .vindex "&$lookup_dnssec_authenticated$&"
12768 This variable is set after a DNS lookup done by
12769 a dnsdb lookup expansion, dnslookup router or smtp transport.
12770 .cindex "DNS" "DNSSEC"
12771 It will be empty if &(DNSSEC)& was not requested,
12772 &"no"& if the result was not labelled as authenticated data
12773 and &"yes"& if it was.
12774 Results that are labelled as authoritative answer that match
12775 the &%dns_trust_aa%& configuration variable count also
12776 as authenticated data.
12777
12778 .vitem &$mailstore_basename$&
12779 .vindex "&$mailstore_basename$&"
12780 This variable is set only when doing deliveries in &"mailstore"& format in the
12781 &(appendfile)& transport. During the expansion of the &%mailstore_prefix%&,
12782 &%mailstore_suffix%&, &%message_prefix%&, and &%message_suffix%& options, it
12783 contains the basename of the files that are being written, that is, the name
12784 without the &".tmp"&, &".env"&, or &".msg"& suffix. At all other times, this
12785 variable is empty.
12786
12787 .vitem &$malware_name$&
12788 .vindex "&$malware_name$&"
12789 This variable is available when Exim is compiled with the
12790 content-scanning extension. It is set to the name of the virus that was found
12791 when the ACL &%malware%& condition is true (see section &<<SECTscanvirus>>&).
12792
12793 .vitem &$max_received_linelength$&
12794 .vindex "&$max_received_linelength$&"
12795 .cindex "maximum" "line length"
12796 .cindex "line length" "maximum"
12797 This variable contains the number of bytes in the longest line that was
12798 received as part of the message, not counting the line termination
12799 character(s).
12800 It is not valid if the &%spool_files_wireformat%& option is used.
12801
12802 .vitem &$message_age$&
12803 .cindex "message" "age of"
12804 .vindex "&$message_age$&"
12805 This variable is set at the start of a delivery attempt to contain the number
12806 of seconds since the message was received. It does not change during a single
12807 delivery attempt.
12808
12809 .vitem &$message_body$&
12810 .cindex "body of message" "expansion variable"
12811 .cindex "message body" "in expansion"
12812 .cindex "binary zero" "in message body"
12813 .vindex "&$message_body$&"
12814 .oindex "&%message_body_visible%&"
12815 This variable contains the initial portion of a message's body while it is
12816 being delivered, and is intended mainly for use in filter files. The maximum
12817 number of characters of the body that are put into the variable is set by the
12818 &%message_body_visible%& configuration option; the default is 500.
12819
12820 .oindex "&%message_body_newlines%&"
12821 By default, newlines are converted into spaces in &$message_body$&, to make it
12822 easier to search for phrases that might be split over a line break. However,
12823 this can be disabled by setting &%message_body_newlines%& to be true. Binary
12824 zeros are always converted into spaces.
12825
12826 .vitem &$message_body_end$&
12827 .cindex "body of message" "expansion variable"
12828 .cindex "message body" "in expansion"
12829 .vindex "&$message_body_end$&"
12830 This variable contains the final portion of a message's
12831 body while it is being delivered. The format and maximum size are as for
12832 &$message_body$&.
12833
12834 .vitem &$message_body_size$&
12835 .cindex "body of message" "size"
12836 .cindex "message body" "size"
12837 .vindex "&$message_body_size$&"
12838 When a message is being delivered, this variable contains the size of the body
12839 in bytes. The count starts from the character after the blank line that
12840 separates the body from the header. Newlines are included in the count. See
12841 also &$message_size$&, &$body_linecount$&, and &$body_zerocount$&.
12842
12843 If the spool file is wireformat
12844 (see the &%spool_files_wireformat%& main option)
12845 the CRLF line-terminators are included in the count.
12846
12847 .vitem &$message_exim_id$&
12848 .vindex "&$message_exim_id$&"
12849 When a message is being received or delivered, this variable contains the
12850 unique message id that is generated and used by Exim to identify the message.
12851 An id is not created for a message until after its header has been successfully
12852 received. &*Note*&: This is &'not'& the contents of the &'Message-ID:'& header
12853 line; it is the local id that Exim assigns to the message, for example:
12854 &`1BXTIK-0001yO-VA`&.
12855
12856 .vitem &$message_headers$&
12857 .vindex &$message_headers$&
12858 This variable contains a concatenation of all the header lines when a message
12859 is being processed, except for lines added by routers or transports. The header
12860 lines are separated by newline characters. Their contents are decoded in the
12861 same way as a header line that is inserted by &%bheader%&.
12862
12863 .vitem &$message_headers_raw$&
12864 .vindex &$message_headers_raw$&
12865 This variable is like &$message_headers$& except that no processing of the
12866 contents of header lines is done.
12867
12868 .vitem &$message_id$&
12869 This is an old name for &$message_exim_id$&. It is now deprecated.
12870
12871 .vitem &$message_linecount$&
12872 .vindex "&$message_linecount$&"
12873 This variable contains the total number of lines in the header and body of the
12874 message. Compare &$body_linecount$&, which is the count for the body only.
12875 During the DATA and content-scanning ACLs, &$message_linecount$& contains the
12876 number of lines received. Before delivery happens (that is, before filters,
12877 routers, and transports run) the count is increased to include the
12878 &'Received:'& header line that Exim standardly adds, and also any other header
12879 lines that are added by ACLs. The blank line that separates the message header
12880 from the body is not counted.
12881
12882 As with the special case of &$message_size$&, during the expansion of the
12883 appendfile transport's maildir_tag option in maildir format, the value of
12884 &$message_linecount$& is the precise size of the number of newlines in the
12885 file that has been written (minus one for the blank line between the
12886 header and the body).
12887
12888 Here is an example of the use of this variable in a DATA ACL:
12889 .code
12890 deny condition = \
12891       ${if <{250}{${eval:$message_linecount - $body_linecount}}}
12892      message   = Too many lines in message header
12893 .endd
12894 In the MAIL and RCPT ACLs, the value is zero because at that stage the
12895 message has not yet been received.
12896
12897 This variable is not valid if the &%spool_files_wireformat%& option is used.
12898
12899 .vitem &$message_size$&
12900 .cindex "size" "of message"
12901 .cindex "message" "size"
12902 .vindex "&$message_size$&"
12903 When a message is being processed, this variable contains its size in bytes. In
12904 most cases, the size includes those headers that were received with the
12905 message, but not those (such as &'Envelope-to:'&) that are added to individual
12906 deliveries as they are written. However, there is one special case: during the
12907 expansion of the &%maildir_tag%& option in the &(appendfile)& transport while
12908 doing a delivery in maildir format, the value of &$message_size$& is the
12909 precise size of the file that has been written. See also
12910 &$message_body_size$&, &$body_linecount$&, and &$body_zerocount$&.
12911
12912 .cindex "RCPT" "value of &$message_size$&"
12913 While running a per message ACL (mail/rcpt/predata), &$message_size$&
12914 contains the size supplied on the MAIL command, or -1 if no size was given. The
12915 value may not, of course, be truthful.
12916
12917 .vitem &$mime_$&&'xxx'&
12918 A number of variables whose names start with &$mime$& are
12919 available when Exim is compiled with the content-scanning extension. For
12920 details, see section &<<SECTscanmimepart>>&.
12921
12922 .vitem "&$n0$& &-- &$n9$&"
12923 These variables are counters that can be incremented by means
12924 of the &%add%& command in filter files.
12925
12926 .vitem &$original_domain$&
12927 .vindex "&$domain$&"
12928 .vindex "&$original_domain$&"
12929 When a top-level address is being processed for delivery, this contains the
12930 same value as &$domain$&. However, if a &"child"& address (for example,
12931 generated by an alias, forward, or filter file) is being processed, this
12932 variable contains the domain of the original address (lower cased). This
12933 differs from &$parent_domain$& only when there is more than one level of
12934 aliasing or forwarding. When more than one address is being delivered in a
12935 single transport run, &$original_domain$& is not set.
12936
12937 If a new address is created by means of a &%deliver%& command in a system
12938 filter, it is set up with an artificial &"parent"& address. This has the local
12939 part &'system-filter'& and the default qualify domain.
12940
12941 .vitem &$original_local_part$&
12942 .vindex "&$local_part$&"
12943 .vindex "&$original_local_part$&"
12944 When a top-level address is being processed for delivery, this contains the
12945 same value as &$local_part$&, unless a prefix or suffix was removed from the
12946 local part, because &$original_local_part$& always contains the full local
12947 part. When a &"child"& address (for example, generated by an alias, forward, or
12948 filter file) is being processed, this variable contains the full local part of
12949 the original address.
12950
12951 If the router that did the redirection processed the local part
12952 case-insensitively, the value in &$original_local_part$& is in lower case.
12953 This variable differs from &$parent_local_part$& only when there is more than
12954 one level of aliasing or forwarding. When more than one address is being
12955 delivered in a single transport run, &$original_local_part$& is not set.
12956
12957 If a new address is created by means of a &%deliver%& command in a system
12958 filter, it is set up with an artificial &"parent"& address. This has the local
12959 part &'system-filter'& and the default qualify domain.
12960
12961 .vitem &$originator_gid$&
12962 .cindex "gid (group id)" "of originating user"
12963 .cindex "sender" "gid"
12964 .vindex "&$caller_gid$&"
12965 .vindex "&$originator_gid$&"
12966 This variable contains the value of &$caller_gid$& that was set when the
12967 message was received. For messages received via the command line, this is the
12968 gid of the sending user. For messages received by SMTP over TCP/IP, this is
12969 normally the gid of the Exim user.
12970
12971 .vitem &$originator_uid$&
12972 .cindex "uid (user id)" "of originating user"
12973 .cindex "sender" "uid"
12974 .vindex "&$caller_uid$&"
12975 .vindex "&$originator_uid$&"
12976 The value of &$caller_uid$& that was set when the message was received. For
12977 messages received via the command line, this is the uid of the sending user.
12978 For messages received by SMTP over TCP/IP, this is normally the uid of the Exim
12979 user.
12980
12981 .vitem &$parent_domain$&
12982 .vindex "&$parent_domain$&"
12983 This variable is similar to &$original_domain$& (see
12984 above), except that it refers to the immediately preceding parent address.
12985
12986 .vitem &$parent_local_part$&
12987 .vindex "&$parent_local_part$&"
12988 This variable is similar to &$original_local_part$&
12989 (see above), except that it refers to the immediately preceding parent address.
12990
12991 .vitem &$pid$&
12992 .cindex "pid (process id)" "of current process"
12993 .vindex "&$pid$&"
12994 This variable contains the current process id.
12995
12996 .vitem &$pipe_addresses$&
12997 .cindex "filter" "transport filter"
12998 .cindex "transport" "filter"
12999 .vindex "&$pipe_addresses$&"
13000 This is not an expansion variable, but is mentioned here because the string
13001 &`$pipe_addresses`& is handled specially in the command specification for the
13002 &(pipe)& transport (chapter &<<CHAPpipetransport>>&) and in transport filters
13003 (described under &%transport_filter%& in chapter &<<CHAPtransportgeneric>>&).
13004 It cannot be used in general expansion strings, and provokes an &"unknown
13005 variable"& error if encountered.
13006
13007 .vitem &$primary_hostname$&
13008 .vindex "&$primary_hostname$&"
13009 This variable contains the value set by &%primary_hostname%& in the
13010 configuration file, or read by the &[uname()]& function. If &[uname()]& returns
13011 a single-component name, Exim calls &[gethostbyname()]& (or
13012 &[getipnodebyname()]& where available) in an attempt to acquire a fully
13013 qualified host name. See also &$smtp_active_hostname$&.
13014
13015
13016 .vitem &$proxy_external_address$& &&&
13017        &$proxy_external_port$& &&&
13018        &$proxy_local_address$& &&&
13019        &$proxy_local_port$& &&&
13020        &$proxy_session$&
13021 These variables are only available when built with Proxy Protocol
13022 or SOCKS5 support.
13023 For details see chapter &<<SECTproxyInbound>>&.
13024
13025 .vitem &$prdr_requested$&
13026 .cindex "PRDR" "variable for"
13027 This variable is set to &"yes"& if PRDR was requested by the client for the
13028 current message, otherwise &"no"&.
13029
13030 .vitem &$prvscheck_address$&
13031 This variable is used in conjunction with the &%prvscheck%& expansion item,
13032 which is described in sections &<<SECTexpansionitems>>& and
13033 &<<SECTverifyPRVS>>&.
13034
13035 .vitem &$prvscheck_keynum$&
13036 This variable is used in conjunction with the &%prvscheck%& expansion item,
13037 which is described in sections &<<SECTexpansionitems>>& and
13038 &<<SECTverifyPRVS>>&.
13039
13040 .vitem &$prvscheck_result$&
13041 This variable is used in conjunction with the &%prvscheck%& expansion item,
13042 which is described in sections &<<SECTexpansionitems>>& and
13043 &<<SECTverifyPRVS>>&.
13044
13045 .vitem &$qualify_domain$&
13046 .vindex "&$qualify_domain$&"
13047 The value set for the &%qualify_domain%& option in the configuration file.
13048
13049 .vitem &$qualify_recipient$&
13050 .vindex "&$qualify_recipient$&"
13051 The value set for the &%qualify_recipient%& option in the configuration file,
13052 or if not set, the value of &$qualify_domain$&.
13053
13054 .vitem &$queue_name$&
13055 .vindex &$queue_name$&
13056 .cindex "named queues" variable
13057 .cindex queues named
13058 The name of the spool queue in use; empty for the default queue.
13059
13060 .vitem &$queue_size$&
13061 .vindex "&$queue_size$&"
13062 .cindex "queue" "size of"
13063 .cindex "spool" "number of messages"
13064 This variable contains the number of messages queued.
13065 It is evaluated on demand, but no more often than once every minute.
13066
13067 .vitem &$r_...$&
13068 .vindex &$r_...$&
13069 .cindex router variables
13070 Values can be placed in these variables by the &%set%& option of a router.
13071 They can be given any name that starts with &$r_$&.
13072 The values persist for the address being handled through subsequent routers
13073 and the eventual transport.
13074
13075 .vitem &$rcpt_count$&
13076 .vindex "&$rcpt_count$&"
13077 When a message is being received by SMTP, this variable contains the number of
13078 RCPT commands received for the current message. If this variable is used in a
13079 RCPT ACL, its value includes the current command.
13080
13081 .vitem &$rcpt_defer_count$&
13082 .vindex "&$rcpt_defer_count$&"
13083 .cindex "4&'xx'& responses" "count of"
13084 When a message is being received by SMTP, this variable contains the number of
13085 RCPT commands in the current message that have previously been rejected with a
13086 temporary (4&'xx'&) response.
13087
13088 .vitem &$rcpt_fail_count$&
13089 .vindex "&$rcpt_fail_count$&"
13090 When a message is being received by SMTP, this variable contains the number of
13091 RCPT commands in the current message that have previously been rejected with a
13092 permanent (5&'xx'&) response.
13093
13094 .vitem &$received_count$&
13095 .vindex "&$received_count$&"
13096 This variable contains the number of &'Received:'& header lines in the message,
13097 including the one added by Exim (so its value is always greater than zero). It
13098 is available in the DATA ACL, the non-SMTP ACL, and while routing and
13099 delivering.
13100
13101 .vitem &$received_for$&
13102 .vindex "&$received_for$&"
13103 If there is only a single recipient address in an incoming message, this
13104 variable contains that address when the &'Received:'& header line is being
13105 built. The value is copied after recipient rewriting has happened, but before
13106 the &[local_scan()]& function is run.
13107
13108 .vitem &$received_ip_address$&
13109 .vindex "&$received_ip_address$&"
13110 As soon as an Exim server starts processing an incoming TCP/IP connection, this
13111 variable is set to the address of the local IP interface, and &$received_port$&
13112 is set to the local port number. (The remote IP address and port are in
13113 &$sender_host_address$& and &$sender_host_port$&.) When testing with &%-bh%&,
13114 the port value is -1 unless it has been set using the &%-oMi%& command line
13115 option.
13116
13117 As well as being useful in ACLs (including the &"connect"& ACL), these variable
13118 could be used, for example, to make the filename for a TLS certificate depend
13119 on which interface and/or port is being used for the incoming connection. The
13120 values of &$received_ip_address$& and &$received_port$& are saved with any
13121 messages that are received, thus making these variables available at delivery
13122 time.
13123 For outbound connections see &$sending_ip_address$&.
13124
13125 .vitem &$received_port$&
13126 .vindex "&$received_port$&"
13127 See &$received_ip_address$&.
13128
13129 .vitem &$received_protocol$&
13130 .vindex "&$received_protocol$&"
13131 When a message is being processed, this variable contains the name of the
13132 protocol by which it was received. Most of the names used by Exim are defined
13133 by RFCs 821, 2821, and 3848. They start with &"smtp"& (the client used HELO) or
13134 &"esmtp"& (the client used EHLO). This can be followed by &"s"& for secure
13135 (encrypted) and/or &"a"& for authenticated. Thus, for example, if the protocol
13136 is set to &"esmtpsa"&, the message was received over an encrypted SMTP
13137 connection and the client was successfully authenticated.
13138
13139 Exim uses the protocol name &"smtps"& for the case when encryption is
13140 automatically set up on connection without the use of STARTTLS (see
13141 &%tls_on_connect_ports%&), and the client uses HELO to initiate the
13142 encrypted SMTP session. The name &"smtps"& is also used for the rare situation
13143 where the client initially uses EHLO, sets up an encrypted connection using
13144 STARTTLS, and then uses HELO afterwards.
13145
13146 The &%-oMr%& option provides a way of specifying a custom protocol name for
13147 messages that are injected locally by trusted callers. This is commonly used to
13148 identify messages that are being re-injected after some kind of scanning.
13149
13150 .vitem &$received_time$&
13151 .vindex "&$received_time$&"
13152 This variable contains the date and time when the current message was received,
13153 as a number of seconds since the start of the Unix epoch.
13154
13155 .vitem &$recipient_data$&
13156 .vindex "&$recipient_data$&"
13157 This variable is set after an indexing lookup success in an ACL &%recipients%&
13158 condition. It contains the data from the lookup, and the value remains set
13159 until the next &%recipients%& test. Thus, you can do things like this:
13160 .display
13161 &`require recipients  = cdb*@;/some/file`&
13162 &`deny    `&&'some further test involving'& &`$recipient_data`&
13163 .endd
13164 &*Warning*&: This variable is set only when a lookup is used as an indexing
13165 method in the address list, using the semicolon syntax as in the example above.
13166 The variable is not set for a lookup that is used as part of the string
13167 expansion that all such lists undergo before being interpreted.
13168
13169 .vitem &$recipient_verify_failure$&
13170 .vindex "&$recipient_verify_failure$&"
13171 In an ACL, when a recipient verification fails, this variable contains
13172 information about the failure. It is set to one of the following words:
13173
13174 .ilist
13175 &"qualify"&: The address was unqualified (no domain), and the message
13176 was neither local nor came from an exempted host.
13177
13178 .next
13179 &"route"&: Routing failed.
13180
13181 .next
13182 &"mail"&: Routing succeeded, and a callout was attempted; rejection occurred at
13183 or before the MAIL command (that is, on initial connection, HELO, or
13184 MAIL).
13185
13186 .next
13187 &"recipient"&: The RCPT command in a callout was rejected.
13188 .next
13189
13190 &"postmaster"&: The postmaster check in a callout was rejected.
13191 .endlist
13192
13193 The main use of this variable is expected to be to distinguish between
13194 rejections of MAIL and rejections of RCPT.
13195
13196 .vitem &$recipients$&
13197 .vindex "&$recipients$&"
13198 This variable contains a list of envelope recipients for a message. A comma and
13199 a space separate the addresses in the replacement text. However, the variable
13200 is not generally available, to prevent exposure of Bcc recipients in
13201 unprivileged users' filter files. You can use &$recipients$& only in these
13202 cases:
13203
13204 .olist
13205 In a system filter file.
13206 .next
13207 In the ACLs associated with the DATA command and with non-SMTP messages, that
13208 is, the ACLs defined by &%acl_smtp_predata%&, &%acl_smtp_data%&,
13209 &%acl_smtp_mime%&, &%acl_not_smtp_start%&, &%acl_not_smtp%&, and
13210 &%acl_not_smtp_mime%&.
13211 .next
13212 From within a &[local_scan()]& function.
13213 .endlist
13214
13215
13216 .vitem &$recipients_count$&
13217 .vindex "&$recipients_count$&"
13218 When a message is being processed, this variable contains the number of
13219 envelope recipients that came with the message. Duplicates are not excluded
13220 from the count. While a message is being received over SMTP, the number
13221 increases for each accepted recipient. It can be referenced in an ACL.
13222
13223
13224 .vitem &$regex_match_string$&
13225 .vindex "&$regex_match_string$&"
13226 This variable is set to contain the matching regular expression after a
13227 &%regex%& ACL condition has matched (see section &<<SECTscanregex>>&).
13228
13229 .vitem "&$regex1$&, &$regex2$&, etc"
13230 .cindex "regex submatch variables (&$1regex$& &$2regex$& etc)"
13231 When a &%regex%& or &%mime_regex%& ACL condition succeeds,
13232 these variables contain the
13233 captured substrings identified by the regular expression.
13234
13235
13236 .vitem &$reply_address$&
13237 .vindex "&$reply_address$&"
13238 When a message is being processed, this variable contains the contents of the
13239 &'Reply-To:'& header line if one exists and it is not empty, or otherwise the
13240 contents of the &'From:'& header line. Apart from the removal of leading
13241 white space, the value is not processed in any way. In particular, no RFC 2047
13242 decoding or character code translation takes place.
13243
13244 .vitem &$return_path$&
13245 .vindex "&$return_path$&"
13246 When a message is being delivered, this variable contains the return path &--
13247 the sender field that will be sent as part of the envelope. It is not enclosed
13248 in <> characters. At the start of routing an address, &$return_path$& has the
13249 same value as &$sender_address$&, but if, for example, an incoming message to a
13250 mailing list has been expanded by a router which specifies a different address
13251 for bounce messages, &$return_path$& subsequently contains the new bounce
13252 address, whereas &$sender_address$& always contains the original sender address
13253 that was received with the message. In other words, &$sender_address$& contains
13254 the incoming envelope sender, and &$return_path$& contains the outgoing
13255 envelope sender.
13256
13257 .vitem &$return_size_limit$&
13258 .vindex "&$return_size_limit$&"
13259 This is an obsolete name for &$bounce_return_size_limit$&.
13260
13261 .vitem &$router_name$&
13262 .cindex "router" "name"
13263 .cindex "name" "of router"
13264 .vindex "&$router_name$&"
13265 During the running of a router this variable contains its name.
13266
13267 .vitem &$runrc$&
13268 .cindex "return code" "from &%run%& expansion"
13269 .vindex "&$runrc$&"
13270 This variable contains the return code from a command that is run by the
13271 &%${run...}%& expansion item. &*Warning*&: In a router or transport, you cannot
13272 assume the order in which option values are expanded, except for those
13273 preconditions whose order of testing is documented. Therefore, you cannot
13274 reliably expect to set &$runrc$& by the expansion of one option, and use it in
13275 another.
13276
13277 .vitem &$self_hostname$&
13278 .oindex "&%self%&" "value of host name"
13279 .vindex "&$self_hostname$&"
13280 When an address is routed to a supposedly remote host that turns out to be the
13281 local host, what happens is controlled by the &%self%& generic router option.
13282 One of its values causes the address to be passed to another router. When this
13283 happens, &$self_hostname$& is set to the name of the local host that the
13284 original router encountered. In other circumstances its contents are null.
13285
13286 .vitem &$sender_address$&
13287 .vindex "&$sender_address$&"
13288 When a message is being processed, this variable contains the sender's address
13289 that was received in the message's envelope. The case of letters in the address
13290 is retained, in both the local part and the domain. For bounce messages, the
13291 value of this variable is the empty string. See also &$return_path$&.
13292
13293 .vitem &$sender_address_data$&
13294 .vindex "&$address_data$&"
13295 .vindex "&$sender_address_data$&"
13296 If &$address_data$& is set when the routers are called from an ACL to verify a
13297 sender address, the final value is preserved in &$sender_address_data$&, to
13298 distinguish it from data from a recipient address. The value does not persist
13299 after the end of the current ACL statement. If you want to preserve it for
13300 longer, you can save it in an ACL variable.
13301
13302 .vitem &$sender_address_domain$&
13303 .vindex "&$sender_address_domain$&"
13304 The domain portion of &$sender_address$&.
13305
13306 .vitem &$sender_address_local_part$&
13307 .vindex "&$sender_address_local_part$&"
13308 The local part portion of &$sender_address$&.
13309
13310 .vitem &$sender_data$&
13311 .vindex "&$sender_data$&"
13312 This variable is set after a lookup success in an ACL &%senders%& condition or
13313 in a router &%senders%& option. It contains the data from the lookup, and the
13314 value remains set until the next &%senders%& test. Thus, you can do things like
13315 this:
13316 .display
13317 &`require senders      = cdb*@;/some/file`&
13318 &`deny    `&&'some further test involving'& &`$sender_data`&
13319 .endd
13320 &*Warning*&: This variable is set only when a lookup is used as an indexing
13321 method in the address list, using the semicolon syntax as in the example above.
13322 The variable is not set for a lookup that is used as part of the string
13323 expansion that all such lists undergo before being interpreted.
13324
13325 .vitem &$sender_fullhost$&
13326 .vindex "&$sender_fullhost$&"
13327 When a message is received from a remote host, this variable contains the host
13328 name and IP address in a single string. It ends with the IP address in square
13329 brackets, followed by a colon and a port number if the logging of ports is
13330 enabled. The format of the rest of the string depends on whether the host
13331 issued a HELO or EHLO SMTP command, and whether the host name was verified by
13332 looking up its IP address. (Looking up the IP address can be forced by the
13333 &%host_lookup%& option, independent of verification.) A plain host name at the
13334 start of the string is a verified host name; if this is not present,
13335 verification either failed or was not requested. A host name in parentheses is
13336 the argument of a HELO or EHLO command. This is omitted if it is identical to
13337 the verified host name or to the host's IP address in square brackets.
13338
13339 .vitem &$sender_helo_dnssec$&
13340 .vindex "&$sender_helo_dnssec$&"
13341 This boolean variable is true if a successful HELO verification was
13342 .cindex "DNS" "DNSSEC"
13343 done using DNS information the resolver library stated was authenticated data.
13344
13345 .vitem &$sender_helo_name$&
13346 .vindex "&$sender_helo_name$&"
13347 When a message is received from a remote host that has issued a HELO or EHLO
13348 command, the argument of that command is placed in this variable. It is also
13349 set if HELO or EHLO is used when a message is received using SMTP locally via
13350 the &%-bs%& or &%-bS%& options.
13351
13352 .vitem &$sender_host_address$&
13353 .vindex "&$sender_host_address$&"
13354 When a message is received from a remote host using SMTP,
13355 this variable contains that
13356 host's IP address. For locally non-SMTP submitted messages, it is empty.
13357
13358 .vitem &$sender_host_authenticated$&
13359 .vindex "&$sender_host_authenticated$&"
13360 This variable contains the name (not the public name) of the authenticator
13361 driver that successfully authenticated the client from which the message was
13362 received. It is empty if there was no successful authentication. See also
13363 &$authenticated_id$&.
13364
13365 .vitem &$sender_host_dnssec$&
13366 .vindex "&$sender_host_dnssec$&"
13367 If an attempt to populate &$sender_host_name$& has been made
13368 (by reference, &%hosts_lookup%& or
13369 otherwise) then this boolean will have been set true if, and only if, the
13370 resolver library states that both
13371 the reverse and forward DNS were authenticated data.  At all
13372 other times, this variable is false.
13373
13374 .cindex "DNS" "DNSSEC"
13375 It is likely that you will need to coerce DNSSEC support on in the resolver
13376 library, by setting:
13377 .code
13378 dns_dnssec_ok = 1
13379 .endd
13380
13381 .new
13382 In addition, on Linux with glibc 2.31 or newer the resolver library will
13383 default to stripping out a successful validation status.
13384 This will break a previously working Exim installation.
13385 Provided that you do trust the resolver (ie, is on localhost) you can tell
13386 glibc to pass through any successful validation with a new option in
13387 &_/etc/resolv.conf_&:
13388 .code
13389 options trust-ad
13390 .endd
13391 .wen
13392
13393 Exim does not perform DNSSEC validation itself, instead leaving that to a
13394 validating resolver (e.g. unbound, or bind with suitable configuration).
13395
13396 If you have changed &%host_lookup_order%& so that &`bydns`& is not the first
13397 mechanism in the list, then this variable will be false.
13398
13399 This requires that your system resolver library support EDNS0 (and that
13400 DNSSEC flags exist in the system headers).  If the resolver silently drops
13401 all EDNS0 options, then this will have no effect.  OpenBSD's asr resolver
13402 is known to currently ignore EDNS0, documented in CAVEATS of asr_run(3).
13403
13404
13405 .vitem &$sender_host_name$&
13406 .vindex "&$sender_host_name$&"
13407 When a message is received from a remote host, this variable contains the
13408 host's name as obtained by looking up its IP address. For messages received by
13409 other means, this variable is empty.
13410
13411 .vindex "&$host_lookup_failed$&"
13412 If the host name has not previously been looked up, a reference to
13413 &$sender_host_name$& triggers a lookup (for messages from remote hosts).
13414 A looked up name is accepted only if it leads back to the original IP address
13415 via a forward lookup. If either the reverse or the forward lookup fails to find
13416 any data, or if the forward lookup does not yield the original IP address,
13417 &$sender_host_name$& remains empty, and &$host_lookup_failed$& is set to &"1"&.
13418
13419 .vindex "&$host_lookup_deferred$&"
13420 However, if either of the lookups cannot be completed (for example, there is a
13421 DNS timeout), &$host_lookup_deferred$& is set to &"1"&, and
13422 &$host_lookup_failed$& remains set to &"0"&.
13423
13424 Once &$host_lookup_failed$& is set to &"1"&, Exim does not try to look up the
13425 host name again if there is a subsequent reference to &$sender_host_name$&
13426 in the same Exim process, but it does try again if &$host_lookup_deferred$&
13427 is set to &"1"&.
13428
13429 Exim does not automatically look up every calling host's name. If you want
13430 maximum efficiency, you should arrange your configuration so that it avoids
13431 these lookups altogether. The lookup happens only if one or more of the
13432 following are true:
13433
13434 .ilist
13435 A string containing &$sender_host_name$& is expanded.
13436 .next
13437 The calling host matches the list in &%host_lookup%&. In the default
13438 configuration, this option is set to *, so it must be changed if lookups are
13439 to be avoided. (In the code, the default for &%host_lookup%& is unset.)
13440 .next
13441 Exim needs the host name in order to test an item in a host list. The items
13442 that require this are described in sections &<<SECThoslispatnam>>& and
13443 &<<SECThoslispatnamsk>>&.
13444 .next
13445 The calling host matches &%helo_try_verify_hosts%& or &%helo_verify_hosts%&.
13446 In this case, the host name is required to compare with the name quoted in any
13447 EHLO or HELO commands that the client issues.
13448 .next
13449 The remote host issues a EHLO or HELO command that quotes one of the
13450 domains in &%helo_lookup_domains%&. The default value of this option is
13451 . ==== As this is a nested list, any displays it contains must be indented
13452 . ==== as otherwise they are too far to the left.
13453 .code
13454   helo_lookup_domains = @ : @[]
13455 .endd
13456 which causes a lookup if a remote host (incorrectly) gives the server's name or
13457 IP address in an EHLO or HELO command.
13458 .endlist
13459
13460
13461 .vitem &$sender_host_port$&
13462 .vindex "&$sender_host_port$&"
13463 When a message is received from a remote host, this variable contains the port
13464 number that was used on the remote host.
13465
13466 .vitem &$sender_ident$&
13467 .vindex "&$sender_ident$&"
13468 When a message is received from a remote host, this variable contains the
13469 identification received in response to an RFC 1413 request. When a message has
13470 been received locally, this variable contains the login name of the user that
13471 called Exim.
13472
13473 .vitem &$sender_rate_$&&'xxx'&
13474 A number of variables whose names begin &$sender_rate_$& are set as part of the
13475 &%ratelimit%& ACL condition. Details are given in section
13476 &<<SECTratelimiting>>&.
13477
13478 .vitem &$sender_rcvhost$&
13479 .cindex "DNS" "reverse lookup"
13480 .cindex "reverse DNS lookup"
13481 .vindex "&$sender_rcvhost$&"
13482 This is provided specifically for use in &'Received:'& headers. It starts with
13483 either the verified host name (as obtained from a reverse DNS lookup) or, if
13484 there is no verified host name, the IP address in square brackets. After that
13485 there may be text in parentheses. When the first item is a verified host name,
13486 the first thing in the parentheses is the IP address in square brackets,
13487 followed by a colon and a port number if port logging is enabled. When the
13488 first item is an IP address, the port is recorded as &"port=&'xxxx'&"& inside
13489 the parentheses.
13490
13491 There may also be items of the form &"helo=&'xxxx'&"& if HELO or EHLO
13492 was used and its argument was not identical to the real host name or IP
13493 address, and &"ident=&'xxxx'&"& if an RFC 1413 ident string is available. If
13494 all three items are present in the parentheses, a newline and tab are inserted
13495 into the string, to improve the formatting of the &'Received:'& header.
13496
13497 .vitem &$sender_verify_failure$&
13498 .vindex "&$sender_verify_failure$&"
13499 In an ACL, when a sender verification fails, this variable contains information
13500 about the failure. The details are the same as for
13501 &$recipient_verify_failure$&.
13502
13503 .vitem &$sending_ip_address$&
13504 .vindex "&$sending_ip_address$&"
13505 This variable is set whenever an outgoing SMTP connection to another host has
13506 been set up. It contains the IP address of the local interface that is being
13507 used. This is useful if a host that has more than one IP address wants to take
13508 on different personalities depending on which one is being used. For incoming
13509 connections, see &$received_ip_address$&.
13510
13511 .vitem &$sending_port$&
13512 .vindex "&$sending_port$&"
13513 This variable is set whenever an outgoing SMTP connection to another host has
13514 been set up. It contains the local port that is being used. For incoming
13515 connections, see &$received_port$&.
13516
13517 .vitem &$smtp_active_hostname$&
13518 .vindex "&$smtp_active_hostname$&"
13519 During an incoming SMTP session, this variable contains the value of the active
13520 host name, as specified by the &%smtp_active_hostname%& option. The value of
13521 &$smtp_active_hostname$& is saved with any message that is received, so its
13522 value can be consulted during routing and delivery.
13523
13524 .vitem &$smtp_command$&
13525 .vindex "&$smtp_command$&"
13526 During the processing of an incoming SMTP command, this variable contains the
13527 entire command. This makes it possible to distinguish between HELO and EHLO in
13528 the HELO ACL, and also to distinguish between commands such as these:
13529 .code
13530 MAIL FROM:<>
13531 MAIL FROM: <>
13532 .endd
13533 For a MAIL command, extra parameters such as SIZE can be inspected. For a RCPT
13534 command, the address in &$smtp_command$& is the original address before any
13535 rewriting, whereas the values in &$local_part$& and &$domain$& are taken from
13536 the address after SMTP-time rewriting.
13537
13538 .vitem &$smtp_command_argument$&
13539 .cindex "SMTP" "command, argument for"
13540 .vindex "&$smtp_command_argument$&"
13541 While an ACL is running to check an SMTP command, this variable contains the
13542 argument, that is, the text that follows the command name, with leading white
13543 space removed. Following the introduction of &$smtp_command$&, this variable is
13544 somewhat redundant, but is retained for backwards compatibility.
13545
13546 .vitem &$smtp_command_history$&
13547 .cindex SMTP "command history"
13548 .vindex "&$smtp_command_history$&"
13549 A comma-separated list (with no whitespace) of the most-recent SMTP commands
13550 received, in time-order left to right.  Only a limited number of commands
13551 are remembered.
13552
13553 .vitem &$smtp_count_at_connection_start$&
13554 .vindex "&$smtp_count_at_connection_start$&"
13555 This variable is set greater than zero only in processes spawned by the Exim
13556 daemon for handling incoming SMTP connections. The name is deliberately long,
13557 in order to emphasize what the contents are. When the daemon accepts a new
13558 connection, it increments this variable. A copy of the variable is passed to
13559 the child process that handles the connection, but its value is fixed, and
13560 never changes. It is only an approximation of how many incoming connections
13561 there actually are, because many other connections may come and go while a
13562 single connection is being processed. When a child process terminates, the
13563 daemon decrements its copy of the variable.
13564
13565 .vitem "&$sn0$& &-- &$sn9$&"
13566 These variables are copies of the values of the &$n0$& &-- &$n9$& accumulators
13567 that were current at the end of the system filter file. This allows a system
13568 filter file to set values that can be tested in users' filter files. For
13569 example, a system filter could set a value indicating how likely it is that a
13570 message is junk mail.
13571
13572 .vitem &$spam_$&&'xxx'&
13573 A number of variables whose names start with &$spam$& are available when Exim
13574 is compiled with the content-scanning extension. For details, see section
13575 &<<SECTscanspamass>>&.
13576
13577 .vitem &$spf_header_comment$& &&&
13578        &$spf_received$& &&&
13579        &$spf_result$& &&&
13580        &$spf_result_guessed$& &&&
13581        &$spf_smtp_comment$&
13582 These variables are only available if Exim is built with SPF support.
13583 For details see section &<<SECSPF>>&.
13584
13585 .vitem &$spool_directory$&
13586 .vindex "&$spool_directory$&"
13587 The name of Exim's spool directory.
13588
13589 .vitem &$spool_inodes$&
13590 .vindex "&$spool_inodes$&"
13591 The number of free inodes in the disk partition where Exim's spool files are
13592 being written. The value is recalculated whenever the variable is referenced.
13593 If the relevant file system does not have the concept of inodes, the value of
13594 is -1. See also the &%check_spool_inodes%& option.
13595
13596 .vitem &$spool_space$&
13597 .vindex "&$spool_space$&"
13598 The amount of free space (as a number of kilobytes) in the disk partition where
13599 Exim's spool files are being written. The value is recalculated whenever the
13600 variable is referenced. If the operating system does not have the ability to
13601 find the amount of free space (only true for experimental systems), the space
13602 value is -1. For example, to check in an ACL that there is at least 50
13603 megabytes free on the spool, you could write:
13604 .code
13605 condition = ${if > {$spool_space}{50000}}
13606 .endd
13607 See also the &%check_spool_space%& option.
13608
13609
13610 .vitem &$thisaddress$&
13611 .vindex "&$thisaddress$&"
13612 This variable is set only during the processing of the &%foranyaddress%&
13613 command in a filter file. Its use is explained in the description of that
13614 command, which can be found in the separate document entitled &'Exim's
13615 interfaces to mail filtering'&.
13616
13617 .vitem &$tls_in_bits$&
13618 .vindex "&$tls_in_bits$&"
13619 Contains an approximation of the TLS cipher's bit-strength
13620 on the inbound connection; the meaning of
13621 this depends upon the TLS implementation used.
13622 If TLS has not been negotiated, the value will be 0.
13623 The value of this is automatically fed into the Cyrus SASL authenticator
13624 when acting as a server, to specify the "external SSF" (a SASL term).
13625
13626 The deprecated &$tls_bits$& variable refers to the inbound side
13627 except when used in the context of an outbound SMTP delivery, when it refers to
13628 the outbound.
13629
13630 .vitem &$tls_out_bits$&
13631 .vindex "&$tls_out_bits$&"
13632 Contains an approximation of the TLS cipher's bit-strength
13633 on an outbound SMTP connection; the meaning of
13634 this depends upon the TLS implementation used.
13635 If TLS has not been negotiated, the value will be 0.
13636
13637 .vitem &$tls_in_ourcert$&
13638 .vindex "&$tls_in_ourcert$&"
13639 .cindex certificate variables
13640 This variable refers to the certificate presented to the peer of an
13641 inbound connection when the message was received.
13642 It is only useful as the argument of a
13643 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
13644 or a &%def%& condition.
13645
13646 &*Note*&: Under versions of OpenSSL preceding 1.1.1,
13647 when a list of more than one
13648 file is used for &%tls_certificate%&, this variable is not reliable.
13649 The macro "_TLS_BAD_MULTICERT_IN_OURCERT" will be defined for those versions.
13650
13651 .vitem &$tls_in_peercert$&
13652 .vindex "&$tls_in_peercert$&"
13653 This variable refers to the certificate presented by the peer of an
13654 inbound connection when the message was received.
13655 It is only useful as the argument of a
13656 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
13657 or a &%def%& condition.
13658 If certificate verification fails it may refer to a failing chain element
13659 which is not the leaf.
13660
13661 .vitem &$tls_out_ourcert$&
13662 .vindex "&$tls_out_ourcert$&"
13663 This variable refers to the certificate presented to the peer of an
13664 outbound connection.  It is only useful as the argument of a
13665 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
13666 or a &%def%& condition.
13667
13668 .vitem &$tls_out_peercert$&
13669 .vindex "&$tls_out_peercert$&"
13670 This variable refers to the certificate presented by the peer of an
13671 outbound connection.  It is only useful as the argument of a
13672 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
13673 or a &%def%& condition.
13674 If certificate verification fails it may refer to a failing chain element
13675 which is not the leaf.
13676
13677 .vitem &$tls_in_certificate_verified$&
13678 .vindex "&$tls_in_certificate_verified$&"
13679 This variable is set to &"1"& if a TLS certificate was verified when the
13680 message was received, and &"0"& otherwise.
13681
13682 The deprecated &$tls_certificate_verified$& variable refers to the inbound side
13683 except when used in the context of an outbound SMTP delivery, when it refers to
13684 the outbound.
13685
13686 .vitem &$tls_out_certificate_verified$&
13687 .vindex "&$tls_out_certificate_verified$&"
13688 This variable is set to &"1"& if a TLS certificate was verified when an
13689 outbound SMTP connection was made,
13690 and &"0"& otherwise.
13691
13692 .vitem &$tls_in_cipher$&
13693 .vindex "&$tls_in_cipher$&"
13694 .vindex "&$tls_cipher$&"
13695 When a message is received from a remote host over an encrypted SMTP
13696 connection, this variable is set to the cipher suite that was negotiated, for
13697 example DES-CBC3-SHA. In other circumstances, in particular, for message
13698 received over unencrypted connections, the variable is empty. Testing
13699 &$tls_in_cipher$& for emptiness is one way of distinguishing between encrypted and
13700 non-encrypted connections during ACL processing.
13701
13702 The deprecated &$tls_cipher$& variable is the same as &$tls_in_cipher$& during message reception,
13703 but in the context of an outward SMTP delivery taking place via the &(smtp)& transport
13704 becomes the same as &$tls_out_cipher$&.
13705
13706 .vitem &$tls_in_cipher_std$&
13707 .vindex "&$tls_in_cipher_std$&"
13708 As above, but returning the RFC standard name for the cipher suite.
13709
13710 .vitem &$tls_out_cipher$&
13711 .vindex "&$tls_out_cipher$&"
13712 This variable is
13713 cleared before any outgoing SMTP connection is made,
13714 and then set to the outgoing cipher suite if one is negotiated. See chapter
13715 &<<CHAPTLS>>& for details of TLS support and chapter &<<CHAPsmtptrans>>& for
13716 details of the &(smtp)& transport.
13717
13718 .vitem &$tls_out_cipher_std$&
13719 .vindex "&$tls_out_cipher_std$&"
13720 As above, but returning the RFC standard name for the cipher suite.
13721
13722 .vitem &$tls_out_dane$&
13723 .vindex &$tls_out_dane$&
13724 DANE active status.  See section &<<SECDANE>>&.
13725
13726 .vitem &$tls_in_ocsp$&
13727 .vindex "&$tls_in_ocsp$&"
13728 When a message is received from a remote client connection
13729 the result of any OCSP request from the client is encoded in this variable:
13730 .code
13731 0 OCSP proof was not requested (default value)
13732 1 No response to request
13733 2 Response not verified
13734 3 Verification failed
13735 4 Verification succeeded
13736 .endd
13737
13738 .vitem &$tls_out_ocsp$&
13739 .vindex "&$tls_out_ocsp$&"
13740 When a message is sent to a remote host connection
13741 the result of any OCSP request made is encoded in this variable.
13742 See &$tls_in_ocsp$& for values.
13743
13744 .vitem &$tls_in_peerdn$&
13745 .vindex "&$tls_in_peerdn$&"
13746 .vindex "&$tls_peerdn$&"
13747 .cindex certificate "extracting fields"
13748 When a message is received from a remote host over an encrypted SMTP
13749 connection, and Exim is configured to request a certificate from the client,
13750 the value of the Distinguished Name of the certificate is made available in the
13751 &$tls_in_peerdn$& during subsequent processing.
13752 If certificate verification fails it may refer to a failing chain element
13753 which is not the leaf.
13754
13755 The deprecated &$tls_peerdn$& variable refers to the inbound side
13756 except when used in the context of an outbound SMTP delivery, when it refers to
13757 the outbound.
13758
13759 .vitem &$tls_out_peerdn$&
13760 .vindex "&$tls_out_peerdn$&"
13761 When a message is being delivered to a remote host over an encrypted SMTP
13762 connection, and Exim is configured to request a certificate from the server,
13763 the value of the Distinguished Name of the certificate is made available in the
13764 &$tls_out_peerdn$& during subsequent processing.
13765 If certificate verification fails it may refer to a failing chain element
13766 which is not the leaf.
13767
13768 .vitem &$tls_in_sni$&
13769 .vindex "&$tls_in_sni$&"
13770 .vindex "&$tls_sni$&"
13771 .cindex "TLS" "Server Name Indication"
13772 When a TLS session is being established, if the client sends the Server
13773 Name Indication extension, the value will be placed in this variable.
13774 If the variable appears in &%tls_certificate%& then this option and
13775 some others, described in &<<SECTtlssni>>&,
13776 will be re-expanded early in the TLS session, to permit
13777 a different certificate to be presented (and optionally a different key to be
13778 used) to the client, based upon the value of the SNI extension.
13779
13780 The deprecated &$tls_sni$& variable refers to the inbound side
13781 except when used in the context of an outbound SMTP delivery, when it refers to
13782 the outbound.
13783
13784 .vitem &$tls_out_sni$&
13785 .vindex "&$tls_out_sni$&"
13786 .cindex "TLS" "Server Name Indication"
13787 During outbound
13788 SMTP deliveries, this variable reflects the value of the &%tls_sni%& option on
13789 the transport.
13790
13791 .vitem &$tls_out_tlsa_usage$&
13792 .vindex &$tls_out_tlsa_usage$&
13793 Bitfield of TLSA record types found.  See section &<<SECDANE>>&.
13794
13795 .vitem &$tls_in_ver$&
13796 .vindex "&$tls_in_ver$&"
13797 When a message is received from a remote host over an encrypted SMTP connection
13798 this variable is set to the protocol version, eg &'TLS1.2'&.
13799
13800 .vitem &$tls_out_ver$&
13801 .vindex "&$tls_out_ver$&"
13802 When a message is being delivered to a remote host over an encrypted SMTP connection
13803 this variable is set to the protocol version.
13804
13805
13806 .vitem &$tod_bsdinbox$&
13807 .vindex "&$tod_bsdinbox$&"
13808 The time of day and the date, in the format required for BSD-style mailbox
13809 files, for example: Thu Oct 17 17:14:09 1995.
13810
13811 .vitem &$tod_epoch$&
13812 .vindex "&$tod_epoch$&"
13813 The time and date as a number of seconds since the start of the Unix epoch.
13814
13815 .vitem &$tod_epoch_l$&
13816 .vindex "&$tod_epoch_l$&"
13817 The time and date as a number of microseconds since the start of the Unix epoch.
13818
13819 .vitem &$tod_full$&
13820 .vindex "&$tod_full$&"
13821 A full version of the time and date, for example: Wed, 16 Oct 1995 09:51:40
13822 +0100. The timezone is always given as a numerical offset from UTC, with
13823 positive values used for timezones that are ahead (east) of UTC, and negative
13824 values for those that are behind (west).
13825
13826 .vitem &$tod_log$&
13827 .vindex "&$tod_log$&"
13828 The time and date in the format used for writing Exim's log files, for example:
13829 1995-10-12 15:32:29, but without a timezone.
13830
13831 .vitem &$tod_logfile$&
13832 .vindex "&$tod_logfile$&"
13833 This variable contains the date in the format yyyymmdd. This is the format that
13834 is used for datestamping log files when &%log_file_path%& contains the &`%D`&
13835 flag.
13836
13837 .vitem &$tod_zone$&
13838 .vindex "&$tod_zone$&"
13839 This variable contains the numerical value of the local timezone, for example:
13840 -0500.
13841
13842 .vitem &$tod_zulu$&
13843 .vindex "&$tod_zulu$&"
13844 This variable contains the UTC date and time in &"Zulu"& format, as specified
13845 by ISO 8601, for example: 20030221154023Z.
13846
13847 .vitem &$transport_name$&
13848 .cindex "transport" "name"
13849 .cindex "name" "of transport"
13850 .vindex "&$transport_name$&"
13851 During the running of a transport, this variable contains its name.
13852
13853 .vitem &$value$&
13854 .vindex "&$value$&"
13855 This variable contains the result of an expansion lookup, extraction operation,
13856 or external command, as described above. It is also used during a
13857 &*reduce*& expansion.
13858
13859 .vitem &$verify_mode$&
13860 .vindex "&$verify_mode$&"
13861 While a router or transport is being run in verify mode or for cutthrough delivery,
13862 contains "S" for sender-verification or "R" for recipient-verification.
13863 Otherwise, empty.
13864
13865 .vitem &$version_number$&
13866 .vindex "&$version_number$&"
13867 The version number of Exim. Same as &$exim_version$&, may be overridden
13868 by the &%exim_version%& main config option.
13869
13870 .vitem &$warn_message_delay$&
13871 .vindex "&$warn_message_delay$&"
13872 This variable is set only during the creation of a message warning about a
13873 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
13874
13875 .vitem &$warn_message_recipients$&
13876 .vindex "&$warn_message_recipients$&"
13877 This variable is set only during the creation of a message warning about a
13878 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
13879 .endlist
13880 .ecindex IIDstrexp
13881
13882
13883
13884 . ////////////////////////////////////////////////////////////////////////////
13885 . ////////////////////////////////////////////////////////////////////////////
13886
13887 .chapter "Embedded Perl" "CHAPperl"
13888 .scindex IIDperl "Perl" "calling from Exim"
13889 Exim can be built to include an embedded Perl interpreter. When this is done,
13890 Perl subroutines can be called as part of the string expansion process. To make
13891 use of the Perl support, you need version 5.004 or later of Perl installed on
13892 your system. To include the embedded interpreter in the Exim binary, include
13893 the line
13894 .code
13895 EXIM_PERL = perl.o
13896 .endd
13897 in your &_Local/Makefile_& and then build Exim in the normal way.
13898
13899
13900 .section "Setting up so Perl can be used" "SECID85"
13901 .oindex "&%perl_startup%&"
13902 Access to Perl subroutines is via a global configuration option called
13903 &%perl_startup%& and an expansion string operator &%${perl ...}%&. If there is
13904 no &%perl_startup%& option in the Exim configuration file then no Perl
13905 interpreter is started and there is almost no overhead for Exim (since none of
13906 the Perl library will be paged in unless used). If there is a &%perl_startup%&
13907 option then the associated value is taken to be Perl code which is executed in
13908 a newly created Perl interpreter.
13909
13910 The value of &%perl_startup%& is not expanded in the Exim sense, so you do not
13911 need backslashes before any characters to escape special meanings. The option
13912 should usually be something like
13913 .code
13914 perl_startup = do '/etc/exim.pl'
13915 .endd
13916 where &_/etc/exim.pl_& is Perl code which defines any subroutines you want to
13917 use from Exim. Exim can be configured either to start up a Perl interpreter as
13918 soon as it is entered, or to wait until the first time it is needed. Starting
13919 the interpreter at the beginning ensures that it is done while Exim still has
13920 its setuid privilege, but can impose an unnecessary overhead if Perl is not in
13921 fact used in a particular run. Also, note that this does not mean that Exim is
13922 necessarily running as root when Perl is called at a later time. By default,
13923 the interpreter is started only when it is needed, but this can be changed in
13924 two ways:
13925
13926 .ilist
13927 .oindex "&%perl_at_start%&"
13928 Setting &%perl_at_start%& (a boolean option) in the configuration requests
13929 a startup when Exim is entered.
13930 .next
13931 The command line option &%-ps%& also requests a startup when Exim is entered,
13932 overriding the setting of &%perl_at_start%&.
13933 .endlist
13934
13935 There is also a command line option &%-pd%& (for delay) which suppresses the
13936 initial startup, even if &%perl_at_start%& is set.
13937
13938 .ilist
13939 .oindex "&%perl_taintmode%&"
13940 .cindex "Perl" "taintmode"
13941 To provide more security executing Perl code via the embedded Perl
13942 interpreter, the &%perl_taintmode%& option can be set. This enables the
13943 taint mode of the Perl interpreter. You are encouraged to set this
13944 option to a true value. To avoid breaking existing installations, it
13945 defaults to false.
13946
13947
13948 .section "Calling Perl subroutines" "SECID86"
13949 When the configuration file includes a &%perl_startup%& option you can make use
13950 of the string expansion item to call the Perl subroutines that are defined
13951 by the &%perl_startup%& code. The operator is used in any of the following
13952 forms:
13953 .code
13954 ${perl{foo}}
13955 ${perl{foo}{argument}}
13956 ${perl{foo}{argument1}{argument2} ... }
13957 .endd
13958 which calls the subroutine &%foo%& with the given arguments. A maximum of eight
13959 arguments may be passed. Passing more than this results in an expansion failure
13960 with an error message of the form
13961 .code
13962 Too many arguments passed to Perl subroutine "foo" (max is 8)
13963 .endd
13964 The return value of the Perl subroutine is evaluated in a scalar context before
13965 it is passed back to Exim to be inserted into the expanded string. If the
13966 return value is &'undef'&, the expansion is forced to fail in the same way as
13967 an explicit &"fail"& on an &%if%& or &%lookup%& item. If the subroutine aborts
13968 by obeying Perl's &%die%& function, the expansion fails with the error message
13969 that was passed to &%die%&.
13970
13971
13972 .section "Calling Exim functions from Perl" "SECID87"
13973 Within any Perl code called from Exim, the function &'Exim::expand_string()'&
13974 is available to call back into Exim's string expansion function. For example,
13975 the Perl code
13976 .code
13977 my $lp = Exim::expand_string('$local_part');
13978 .endd
13979 makes the current Exim &$local_part$& available in the Perl variable &$lp$&.
13980 Note those are single quotes and not double quotes to protect against
13981 &$local_part$& being interpolated as a Perl variable.
13982
13983 If the string expansion is forced to fail by a &"fail"& item, the result of
13984 &'Exim::expand_string()'& is &%undef%&. If there is a syntax error in the
13985 expansion string, the Perl call from the original expansion string fails with
13986 an appropriate error message, in the same way as if &%die%& were used.
13987
13988 .cindex "debugging" "from embedded Perl"
13989 .cindex "log" "writing from embedded Perl"
13990 Two other Exim functions are available for use from within Perl code.
13991 &'Exim::debug_write()'& writes a string to the standard error stream if Exim's
13992 debugging is enabled. If you want a newline at the end, you must supply it.
13993 &'Exim::log_write()'& writes a string to Exim's main log, adding a leading
13994 timestamp. In this case, you should not supply a terminating newline.
13995
13996
13997 .section "Use of standard output and error by Perl" "SECID88"
13998 .cindex "Perl" "standard output and error"
13999 You should not write to the standard error or output streams from within your
14000 Perl code, as it is not defined how these are set up. In versions of Exim
14001 before 4.50, it is possible for the standard output or error to refer to the
14002 SMTP connection during message reception via the daemon. Writing to this stream
14003 is certain to cause chaos. From Exim 4.50 onwards, the standard output and
14004 error streams are connected to &_/dev/null_& in the daemon. The chaos is
14005 avoided, but the output is lost.
14006
14007 .cindex "Perl" "use of &%warn%&"
14008 The Perl &%warn%& statement writes to the standard error stream by default.
14009 Calls to &%warn%& may be embedded in Perl modules that you use, but over which
14010 you have no control. When Exim starts up the Perl interpreter, it arranges for
14011 output from the &%warn%& statement to be written to the Exim main log. You can
14012 change this by including appropriate Perl magic somewhere in your Perl code.
14013 For example, to discard &%warn%& output completely, you need this:
14014 .code
14015 $SIG{__WARN__} = sub { };
14016 .endd
14017 Whenever a &%warn%& is obeyed, the anonymous subroutine is called. In this
14018 example, the code for the subroutine is empty, so it does nothing, but you can
14019 include any Perl code that you like. The text of the &%warn%& message is passed
14020 as the first subroutine argument.
14021 .ecindex IIDperl
14022
14023
14024 . ////////////////////////////////////////////////////////////////////////////
14025 . ////////////////////////////////////////////////////////////////////////////
14026
14027 .chapter "Starting the daemon and the use of network interfaces" &&&
14028          "CHAPinterfaces" &&&
14029          "Starting the daemon"
14030 .cindex "daemon" "starting"
14031 .cindex "interface" "listening"
14032 .cindex "network interface"
14033 .cindex "interface" "network"
14034 .cindex "IP address" "for listening"
14035 .cindex "daemon" "listening IP addresses"
14036 .cindex "TCP/IP" "setting listening interfaces"
14037 .cindex "TCP/IP" "setting listening ports"
14038 A host that is connected to a TCP/IP network may have one or more physical
14039 hardware network interfaces. Each of these interfaces may be configured as one
14040 or more &"logical"& interfaces, which are the entities that a program actually
14041 works with. Each of these logical interfaces is associated with an IP address.
14042 In addition, TCP/IP software supports &"loopback"& interfaces (127.0.0.1 in
14043 IPv4 and ::1 in IPv6), which do not use any physical hardware. Exim requires
14044 knowledge about the host's interfaces for use in three different circumstances:
14045
14046 .olist
14047 When a listening daemon is started, Exim needs to know which interfaces
14048 and ports to listen on.
14049 .next
14050 When Exim is routing an address, it needs to know which IP addresses
14051 are associated with local interfaces. This is required for the correct
14052 processing of MX lists by removing the local host and others with the
14053 same or higher priority values. Also, Exim needs to detect cases
14054 when an address is routed to an IP address that in fact belongs to the
14055 local host. Unless the &%self%& router option or the &%allow_localhost%&
14056 option of the smtp transport is set (as appropriate), this is treated
14057 as an error situation.
14058 .next
14059 When Exim connects to a remote host, it may need to know which interface to use
14060 for the outgoing connection.
14061 .endlist
14062
14063
14064 Exim's default behaviour is likely to be appropriate in the vast majority
14065 of cases. If your host has only one interface, and you want all its IP
14066 addresses to be treated in the same way, and you are using only the
14067 standard SMTP port, you should not need to take any special action. The
14068 rest of this chapter does not apply to you.
14069
14070 In a more complicated situation you may want to listen only on certain
14071 interfaces, or on different ports, and for this reason there are a number of
14072 options that can be used to influence Exim's behaviour. The rest of this
14073 chapter describes how they operate.
14074
14075 When a message is received over TCP/IP, the interface and port that were
14076 actually used are set in &$received_ip_address$& and &$received_port$&.
14077
14078
14079
14080 .section "Starting a listening daemon" "SECID89"
14081 When a listening daemon is started (by means of the &%-bd%& command line
14082 option), the interfaces and ports on which it listens are controlled by the
14083 following options:
14084
14085 .ilist
14086 &%daemon_smtp_ports%& contains a list of default ports
14087 or service names.
14088 (For backward compatibility, this option can also be specified in the singular.)
14089 .next
14090 &%local_interfaces%& contains list of interface IP addresses on which to
14091 listen. Each item may optionally also specify a port.
14092 .endlist
14093
14094 The default list separator in both cases is a colon, but this can be changed as
14095 described in section &<<SECTlistsepchange>>&. When IPv6 addresses are involved,
14096 it is usually best to change the separator to avoid having to double all the
14097 colons. For example:
14098 .code
14099 local_interfaces = <; 127.0.0.1 ; \
14100                       192.168.23.65 ; \
14101                       ::1 ; \
14102                       3ffe:ffff:836f::fe86:a061
14103 .endd
14104 There are two different formats for specifying a port along with an IP address
14105 in &%local_interfaces%&:
14106
14107 .olist
14108 The port is added onto the address with a dot separator. For example, to listen
14109 on port 1234 on two different IP addresses:
14110 .code
14111 local_interfaces = <; 192.168.23.65.1234 ; \
14112                       3ffe:ffff:836f::fe86:a061.1234
14113 .endd
14114 .next
14115 The IP address is enclosed in square brackets, and the port is added
14116 with a colon separator, for example:
14117 .code
14118 local_interfaces = <; [192.168.23.65]:1234 ; \
14119                       [3ffe:ffff:836f::fe86:a061]:1234
14120 .endd
14121 .endlist
14122
14123 When a port is not specified, the value of &%daemon_smtp_ports%& is used. The
14124 default setting contains just one port:
14125 .code
14126 daemon_smtp_ports = smtp
14127 .endd
14128 If more than one port is listed, each interface that does not have its own port
14129 specified listens on all of them. Ports that are listed in
14130 &%daemon_smtp_ports%& can be identified either by name (defined in
14131 &_/etc/services_&) or by number. However, when ports are given with individual
14132 IP addresses in &%local_interfaces%&, only numbers (not names) can be used.
14133
14134
14135
14136 .section "Special IP listening addresses" "SECID90"
14137 The addresses 0.0.0.0 and ::0 are treated specially. They are interpreted
14138 as &"all IPv4 interfaces"& and &"all IPv6 interfaces"&, respectively. In each
14139 case, Exim tells the TCP/IP stack to &"listen on all IPv&'x'& interfaces"&
14140 instead of setting up separate listening sockets for each interface. The
14141 default value of &%local_interfaces%& is
14142 .code
14143 local_interfaces = 0.0.0.0
14144 .endd
14145 when Exim is built without IPv6 support; otherwise it is:
14146 .code
14147 local_interfaces = <; ::0 ; 0.0.0.0
14148 .endd
14149 Thus, by default, Exim listens on all available interfaces, on the SMTP port.
14150
14151
14152
14153 .section "Overriding local_interfaces and daemon_smtp_ports" "SECID91"
14154 The &%-oX%& command line option can be used to override the values of
14155 &%daemon_smtp_ports%& and/or &%local_interfaces%& for a particular daemon
14156 instance. Another way of doing this would be to use macros and the &%-D%&
14157 option. However, &%-oX%& can be used by any admin user, whereas modification of
14158 the runtime configuration by &%-D%& is allowed only when the caller is root or
14159 exim.
14160
14161 The value of &%-oX%& is a list of items. The default colon separator can be
14162 changed in the usual way (&<<SECTlistsepchange>>&) if required.
14163 If there are any items that do not
14164 contain dots or colons (that is, are not IP addresses), the value of
14165 &%daemon_smtp_ports%& is replaced by the list of those items. If there are any
14166 items that do contain dots or colons, the value of &%local_interfaces%& is
14167 replaced by those items. Thus, for example,
14168 .code
14169 -oX 1225
14170 .endd
14171 overrides &%daemon_smtp_ports%&, but leaves &%local_interfaces%& unchanged,
14172 whereas
14173 .code
14174 -oX 192.168.34.5.1125
14175 .endd
14176 overrides &%local_interfaces%&, leaving &%daemon_smtp_ports%& unchanged.
14177 (However, since &%local_interfaces%& now contains no items without ports, the
14178 value of &%daemon_smtp_ports%& is no longer relevant in this example.)
14179
14180
14181
14182 .section "Support for the submissions (aka SSMTP or SMTPS) protocol" "SECTsupobssmt"
14183 .cindex "submissions protocol"
14184 .cindex "ssmtp protocol"
14185 .cindex "smtps protocol"
14186 .cindex "SMTP" "ssmtp protocol"
14187 .cindex "SMTP" "smtps protocol"
14188 Exim supports the use of TLS-on-connect, used by mail clients in the
14189 &"submissions"& protocol, historically also known as SMTPS or SSMTP.
14190 For some years, IETF Standards Track documents only blessed the
14191 STARTTLS-based Submission service (port 587) while common practice was to support
14192 the same feature set on port 465, but using TLS-on-connect.
14193 If your installation needs to provide service to mail clients
14194 (Mail User Agents, MUAs) then you should provide service on both the 587 and
14195 the 465 TCP ports.
14196
14197 If the &%tls_on_connect_ports%& option is set to a list of port numbers or
14198 service names, connections to those ports must first establish TLS, before
14199 proceeding to the application layer use of the SMTP protocol.
14200
14201 The common use of this option is expected to be
14202 .code
14203 tls_on_connect_ports = 465
14204 .endd
14205 per RFC 8314.
14206 There is also a command line option &%-tls-on-connect%&, which forces all ports
14207 to behave in this way when a daemon is started.
14208
14209 &*Warning*&: Setting &%tls_on_connect_ports%& does not of itself cause the
14210 daemon to listen on those ports. You must still specify them in
14211 &%daemon_smtp_ports%&, &%local_interfaces%&, or the &%-oX%& option. (This is
14212 because &%tls_on_connect_ports%& applies to &%inetd%& connections as well as to
14213 connections via the daemon.)
14214
14215
14216
14217
14218 .section "IPv6 address scopes" "SECID92"
14219 .cindex "IPv6" "address scopes"
14220 IPv6 addresses have &"scopes"&, and a host with multiple hardware interfaces
14221 can, in principle, have the same link-local IPv6 address on different
14222 interfaces. Thus, additional information is needed, over and above the IP
14223 address, to distinguish individual interfaces. A convention of using a
14224 percent sign followed by something (often the interface name) has been
14225 adopted in some cases, leading to addresses like this:
14226 .code
14227 fe80::202:b3ff:fe03:45c1%eth0
14228 .endd
14229 To accommodate this usage, a percent sign followed by an arbitrary string is
14230 allowed at the end of an IPv6 address. By default, Exim calls &[getaddrinfo()]&
14231 to convert a textual IPv6 address for actual use. This function recognizes the
14232 percent convention in operating systems that support it, and it processes the
14233 address appropriately. Unfortunately, some older libraries have problems with
14234 &[getaddrinfo()]&. If
14235 .code
14236 IPV6_USE_INET_PTON=yes
14237 .endd
14238 is set in &_Local/Makefile_& (or an OS-dependent Makefile) when Exim is built,
14239 Exim uses &'inet_pton()'& to convert a textual IPv6 address for actual use,
14240 instead of &[getaddrinfo()]&. (Before version 4.14, it always used this
14241 function.) Of course, this means that the additional functionality of
14242 &[getaddrinfo()]& &-- recognizing scoped addresses &-- is lost.
14243
14244 .section "Disabling IPv6" "SECID93"
14245 .cindex "IPv6" "disabling"
14246 Sometimes it happens that an Exim binary that was compiled with IPv6 support is
14247 run on a host whose kernel does not support IPv6. The binary will fall back to
14248 using IPv4, but it may waste resources looking up AAAA records, and trying to
14249 connect to IPv6 addresses, causing delays to mail delivery. If you set the
14250 .oindex "&%disable_ipv6%&"
14251 &%disable_ipv6%& option true, even if the Exim binary has IPv6 support, no IPv6
14252 activities take place. AAAA records are never looked up, and any IPv6 addresses
14253 that are listed in &%local_interfaces%&, data for the &(manualroute)& router,
14254 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
14255 to handle IPv6 literal addresses.
14256
14257 On the other hand, when IPv6 is in use, there may be times when you want to
14258 disable it for certain hosts or domains. You can use the &%dns_ipv4_lookup%&
14259 option to globally suppress the lookup of AAAA records for specified domains,
14260 and you can use the &%ignore_target_hosts%& generic router option to ignore
14261 IPv6 addresses in an individual router.
14262
14263
14264
14265 .section "Examples of starting a listening daemon" "SECID94"
14266 The default case in an IPv6 environment is
14267 .code
14268 daemon_smtp_ports = smtp
14269 local_interfaces = <; ::0 ; 0.0.0.0
14270 .endd
14271 This specifies listening on the smtp port on all IPv6 and IPv4 interfaces.
14272 Either one or two sockets may be used, depending on the characteristics of
14273 the TCP/IP stack. (This is complicated and messy; for more information,
14274 read the comments in the &_daemon.c_& source file.)
14275
14276 To specify listening on ports 25 and 26 on all interfaces:
14277 .code
14278 daemon_smtp_ports = 25 : 26
14279 .endd
14280 (leaving &%local_interfaces%& at the default setting) or, more explicitly:
14281 .code
14282 local_interfaces = <; ::0.25     ; ::0.26 \
14283                       0.0.0.0.25 ; 0.0.0.0.26
14284 .endd
14285 To listen on the default port on all IPv4 interfaces, and on port 26 on the
14286 IPv4 loopback address only:
14287 .code
14288 local_interfaces = 0.0.0.0 : 127.0.0.1.26
14289 .endd
14290 To specify listening on the default port on specific interfaces only:
14291 .code
14292 local_interfaces = 10.0.0.67 : 192.168.34.67
14293 .endd
14294 &*Warning*&: Such a setting excludes listening on the loopback interfaces.
14295
14296
14297
14298 .section "Recognizing the local host" "SECTreclocipadd"
14299 The &%local_interfaces%& option is also used when Exim needs to determine
14300 whether or not an IP address refers to the local host. That is, the IP
14301 addresses of all the interfaces on which a daemon is listening are always
14302 treated as local.
14303
14304 For this usage, port numbers in &%local_interfaces%& are ignored. If either of
14305 the items 0.0.0.0 or ::0 are encountered, Exim gets a complete list of
14306 available interfaces from the operating system, and extracts the relevant
14307 (that is, IPv4 or IPv6) addresses to use for checking.
14308
14309 Some systems set up large numbers of virtual interfaces in order to provide
14310 many virtual web servers. In this situation, you may want to listen for
14311 email on only a few of the available interfaces, but nevertheless treat all
14312 interfaces as local when routing. You can do this by setting
14313 &%extra_local_interfaces%& to a list of IP addresses, possibly including the
14314 &"all"& wildcard values. These addresses are recognized as local, but are not
14315 used for listening. Consider this example:
14316 .code
14317 local_interfaces = <; 127.0.0.1 ; ::1 ; \
14318                       192.168.53.235 ; \
14319                       3ffe:2101:12:1:a00:20ff:fe86:a061
14320
14321 extra_local_interfaces = <; ::0 ; 0.0.0.0
14322 .endd
14323 The daemon listens on the loopback interfaces and just one IPv4 and one IPv6
14324 address, but all available interface addresses are treated as local when
14325 Exim is routing.
14326
14327 In some environments the local host name may be in an MX list, but with an IP
14328 address that is not assigned to any local interface. In other cases it may be
14329 desirable to treat other host names as if they referred to the local host. Both
14330 these cases can be handled by setting the &%hosts_treat_as_local%& option.
14331 This contains host names rather than IP addresses. When a host is referenced
14332 during routing, either via an MX record or directly, it is treated as the local
14333 host if its name matches &%hosts_treat_as_local%&, or if any of its IP
14334 addresses match &%local_interfaces%& or &%extra_local_interfaces%&.
14335
14336
14337
14338 .section "Delivering to a remote host" "SECID95"
14339 Delivery to a remote host is handled by the smtp transport. By default, it
14340 allows the system's TCP/IP functions to choose which interface to use (if
14341 there is more than one) when connecting to a remote host. However, the
14342 &%interface%& option can be set to specify which interface is used. See the
14343 description of the smtp transport in chapter &<<CHAPsmtptrans>>& for more
14344 details.
14345
14346
14347
14348
14349 . ////////////////////////////////////////////////////////////////////////////
14350 . ////////////////////////////////////////////////////////////////////////////
14351
14352 .chapter "Main configuration" "CHAPmainconfig"
14353 .scindex IIDconfima "configuration file" "main section"
14354 .scindex IIDmaiconf "main configuration"
14355 The first part of the runtime configuration file contains three types of item:
14356
14357 .ilist
14358 Macro definitions: These lines start with an upper case letter. See section
14359 &<<SECTmacrodefs>>& for details of macro processing.
14360 .next
14361 Named list definitions: These lines start with one of the words &"domainlist"&,
14362 &"hostlist"&, &"addresslist"&, or &"localpartlist"&. Their use is described in
14363 section &<<SECTnamedlists>>&.
14364 .next
14365 Main configuration settings: Each setting occupies one line of the file
14366 (with possible continuations). If any setting is preceded by the word
14367 &"hide"&, the &%-bP%& command line option displays its value to admin users
14368 only. See section &<<SECTcos>>& for a description of the syntax of these option
14369 settings.
14370 .endlist
14371
14372 This chapter specifies all the main configuration options, along with their
14373 types and default values. For ease of finding a particular option, they appear
14374 in alphabetical order in section &<<SECTalomo>>& below. However, because there
14375 are now so many options, they are first listed briefly in functional groups, as
14376 an aid to finding the name of the option you are looking for. Some options are
14377 listed in more than one group.
14378
14379 .section "Miscellaneous" "SECID96"
14380 .table2
14381 .row &%bi_command%&                  "to run for &%-bi%& command line option"
14382 .row &%debug_store%&                 "do extra internal checks"
14383 .row &%disable_ipv6%&                "do no IPv6 processing"
14384 .row &%keep_malformed%&              "for broken files &-- should not happen"
14385 .row &%localhost_number%&            "for unique message ids in clusters"
14386 .row &%message_body_newlines%&       "retain newlines in &$message_body$&"
14387 .row &%message_body_visible%&        "how much to show in &$message_body$&"
14388 .row &%mua_wrapper%&                 "run in &""MUA wrapper""& mode"
14389 .row &%print_topbitchars%&           "top-bit characters are printing"
14390 .row &%spool_wireformat%&            "use wire-format spool data files when possible"
14391 .row &%timezone%&                    "force time zone"
14392 .endtable
14393
14394
14395 .section "Exim parameters" "SECID97"
14396 .table2
14397 .row &%exim_group%&                  "override compiled-in value"
14398 .row &%exim_path%&                   "override compiled-in value"
14399 .row &%exim_user%&                   "override compiled-in value"
14400 .row &%primary_hostname%&            "default from &[uname()]&"
14401 .row &%split_spool_directory%&       "use multiple directories"
14402 .row &%spool_directory%&             "override compiled-in value"
14403 .endtable
14404
14405
14406
14407 .section "Privilege controls" "SECID98"
14408 .table2
14409 .row &%admin_groups%&                "groups that are Exim admin users"
14410 .row &%commandline_checks_require_admin%& "require admin for various checks"
14411 .row &%deliver_drop_privilege%&      "drop root for delivery processes"
14412 .row &%local_from_check%&            "insert &'Sender:'& if necessary"
14413 .row &%local_from_prefix%&           "for testing &'From:'& for local sender"
14414 .row &%local_from_suffix%&           "for testing &'From:'& for local sender"
14415 .row &%local_sender_retain%&         "keep &'Sender:'& from untrusted user"
14416 .row &%never_users%&                 "do not run deliveries as these"
14417 .row &%prod_requires_admin%&         "forced delivery requires admin user"
14418 .row &%queue_list_requires_admin%&   "queue listing requires admin user"
14419 .row &%trusted_groups%&              "groups that are trusted"
14420 .row &%trusted_users%&               "users that are trusted"
14421 .endtable
14422
14423
14424
14425 .section "Logging" "SECID99"
14426 .table2
14427 .row &%event_action%&                "custom logging"
14428 .row &%hosts_connection_nolog%&      "exemption from connect logging"
14429 .row &%log_file_path%&               "override compiled-in value"
14430 .row &%log_selector%&                "set/unset optional logging"
14431 .row &%log_timezone%&                "add timezone to log lines"
14432 .row &%message_logs%&                "create per-message logs"
14433 .row &%preserve_message_logs%&       "after message completion"
14434 .row &%process_log_path%&            "for SIGUSR1 and &'exiwhat'&"
14435 .row &%slow_lookup_log%&             "control logging of slow DNS lookups"
14436 .row &%syslog_duplication%&          "controls duplicate log lines on syslog"
14437 .row &%syslog_facility%&             "set syslog &""facility""& field"
14438 .row &%syslog_pid%&                  "pid in syslog lines"
14439 .row &%syslog_processname%&          "set syslog &""ident""& field"
14440 .row &%syslog_timestamp%&            "timestamp syslog lines"
14441 .row &%write_rejectlog%&             "control use of message log"
14442 .endtable
14443
14444
14445
14446 .section "Frozen messages" "SECID100"
14447 .table2
14448 .row &%auto_thaw%&                   "sets time for retrying frozen messages"
14449 .row &%freeze_tell%&                 "send message when freezing"
14450 .row &%move_frozen_messages%&        "to another directory"
14451 .row &%timeout_frozen_after%&        "keep frozen messages only so long"
14452 .endtable
14453
14454
14455
14456 .section "Data lookups" "SECID101"
14457 .table2
14458 .row &%ibase_servers%&               "InterBase servers"
14459 .row &%ldap_ca_cert_dir%&            "dir of CA certs to verify LDAP server's"
14460 .row &%ldap_ca_cert_file%&           "file of CA certs to verify LDAP server's"
14461 .row &%ldap_cert_file%&              "client cert file for LDAP"
14462 .row &%ldap_cert_key%&               "client key file for LDAP"
14463 .row &%ldap_cipher_suite%&           "TLS negotiation preference control"
14464 .row &%ldap_default_servers%&        "used if no server in query"
14465 .row &%ldap_require_cert%&           "action to take without LDAP server cert"
14466 .row &%ldap_start_tls%&              "require TLS within LDAP"
14467 .row &%ldap_version%&                "set protocol version"
14468 .row &%lookup_open_max%&             "lookup files held open"
14469 .row &%mysql_servers%&               "default MySQL servers"
14470 .row &%oracle_servers%&              "Oracle servers"
14471 .row &%pgsql_servers%&               "default PostgreSQL servers"
14472 .row &%sqlite_lock_timeout%&         "as it says"
14473 .endtable
14474
14475
14476
14477 .section "Message ids" "SECID102"
14478 .table2
14479 .row &%message_id_header_domain%&    "used to build &'Message-ID:'& header"
14480 .row &%message_id_header_text%&      "ditto"
14481 .endtable
14482
14483
14484
14485 .section "Embedded Perl Startup" "SECID103"
14486 .table2
14487 .row &%perl_at_start%&               "always start the interpreter"
14488 .row &%perl_startup%&                "code to obey when starting Perl"
14489 .row &%perl_taintmode%&              "enable taint mode in Perl"
14490 .endtable
14491
14492
14493
14494 .section "Daemon" "SECID104"
14495 .table2
14496 .row &%daemon_smtp_ports%&           "default ports"
14497 .row &%daemon_startup_retries%&      "number of times to retry"
14498 .row &%daemon_startup_sleep%&        "time to sleep between tries"
14499 .row &%extra_local_interfaces%&      "not necessarily listened on"
14500 .row &%local_interfaces%&            "on which to listen, with optional ports"
14501 .row &%notifier_socket%&             "override compiled-in value"
14502 .row &%pid_file_path%&               "override compiled-in value"
14503 .row &%queue_run_max%&               "maximum simultaneous queue runners"
14504 .endtable
14505
14506
14507
14508 .section "Resource control" "SECID105"
14509 .table2
14510 .row &%check_log_inodes%&            "before accepting a message"
14511 .row &%check_log_space%&             "before accepting a message"
14512 .row &%check_spool_inodes%&          "before accepting a message"
14513 .row &%check_spool_space%&           "before accepting a message"
14514 .row &%deliver_queue_load_max%&      "no queue deliveries if load high"
14515 .row &%queue_only_load%&             "queue incoming if load high"
14516 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
14517 .row &%queue_run_max%&               "maximum simultaneous queue runners"
14518 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
14519 .row &%smtp_accept_max%&             "simultaneous incoming connections"
14520 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
14521 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
14522 .row &%smtp_accept_max_per_connection%& "messages per connection"
14523 .row &%smtp_accept_max_per_host%&    "connections from one host"
14524 .row &%smtp_accept_queue%&           "queue mail if more connections"
14525 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
14526                                            connection"
14527 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
14528 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
14529 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
14530 .row &%smtp_load_reserve%&           "SMTP from reserved hosts if load high"
14531 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
14532 .endtable
14533
14534
14535
14536 .section "Policy controls" "SECID106"
14537 .table2
14538 .row &%acl_not_smtp%&                "ACL for non-SMTP messages"
14539 .row &%acl_not_smtp_mime%&           "ACL for non-SMTP MIME parts"
14540 .row &%acl_not_smtp_start%&          "ACL for start of non-SMTP message"
14541 .row &%acl_smtp_auth%&               "ACL for AUTH"
14542 .row &%acl_smtp_connect%&            "ACL for connection"
14543 .row &%acl_smtp_data%&               "ACL for DATA"
14544 .row &%acl_smtp_data_prdr%&          "ACL for DATA, per-recipient"
14545 .row &%acl_smtp_dkim%&               "ACL for DKIM verification"
14546 .row &%acl_smtp_etrn%&               "ACL for ETRN"
14547 .row &%acl_smtp_expn%&               "ACL for EXPN"
14548 .row &%acl_smtp_helo%&               "ACL for EHLO or HELO"
14549 .row &%acl_smtp_mail%&               "ACL for MAIL"
14550 .row &%acl_smtp_mailauth%&           "ACL for AUTH on MAIL command"
14551 .row &%acl_smtp_mime%&               "ACL for MIME parts"
14552 .row &%acl_smtp_notquit%&            "ACL for non-QUIT terminations"
14553 .row &%acl_smtp_predata%&            "ACL for start of data"
14554 .row &%acl_smtp_quit%&               "ACL for QUIT"
14555 .row &%acl_smtp_rcpt%&               "ACL for RCPT"
14556 .row &%acl_smtp_starttls%&           "ACL for STARTTLS"
14557 .row &%acl_smtp_vrfy%&               "ACL for VRFY"
14558 .row &%av_scanner%&                  "specify virus scanner"
14559 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
14560                                       words""&"
14561 .row &%dns_cname_loops%&             "follow CNAMEs returned by resolver"
14562 .row &%dns_csa_search_limit%&        "control CSA parent search depth"
14563 .row &%dns_csa_use_reverse%&         "en/disable CSA IP reverse search"
14564 .row &%header_maxsize%&              "total size of message header"
14565 .row &%header_line_maxsize%&         "individual header line limit"
14566 .row &%helo_accept_junk_hosts%&      "allow syntactic junk from these hosts"
14567 .row &%helo_allow_chars%&            "allow illegal chars in HELO names"
14568 .row &%helo_lookup_domains%&         "lookup hostname for these HELO names"
14569 .row &%helo_try_verify_hosts%&       "HELO soft-checked for these hosts"
14570 .row &%helo_verify_hosts%&           "HELO hard-checked for these hosts"
14571 .row &%host_lookup%&                 "host name looked up for these hosts"
14572 .row &%host_lookup_order%&           "order of DNS and local name lookups"
14573 .row &%hosts_proxy%&                 "use proxy protocol for these hosts"
14574 .row &%host_reject_connection%&      "reject connection from these hosts"
14575 .row &%hosts_treat_as_local%&        "useful in some cluster configurations"
14576 .row &%local_scan_timeout%&          "timeout for &[local_scan()]&"
14577 .row &%message_size_limit%&          "for all messages"
14578 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
14579 .row &%spamd_address%&               "set interface to SpamAssassin"
14580 .row &%strict_acl_vars%&             "object to unset ACL variables"
14581 .row &%spf_smtp_comment_template%&   "template for &$spf_smtp_comment$&"
14582 .endtable
14583
14584
14585
14586 .section "Callout cache" "SECID107"
14587 .table2
14588 .row &%callout_domain_negative_expire%& "timeout for negative domain cache &&&
14589                                          item"
14590 .row &%callout_domain_positive_expire%& "timeout for positive domain cache &&&
14591                                          item"
14592 .row &%callout_negative_expire%&     "timeout for negative address cache item"
14593 .row &%callout_positive_expire%&     "timeout for positive address cache item"
14594 .row &%callout_random_local_part%&   "string to use for &""random""& testing"
14595 .endtable
14596
14597
14598
14599 .section "TLS" "SECID108"
14600 .table2
14601 .row &%gnutls_compat_mode%&          "use GnuTLS compatibility mode"
14602 .row &%gnutls_allow_auto_pkcs11%&    "allow GnuTLS to autoload PKCS11 modules"
14603 .row &%openssl_options%&             "adjust OpenSSL compatibility options"
14604 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
14605 .row &%tls_certificate%&             "location of server certificate"
14606 .row &%tls_crl%&                     "certificate revocation list"
14607 .row &%tls_dh_max_bits%&             "clamp D-H bit count suggestion"
14608 .row &%tls_dhparam%&                 "DH parameters for server"
14609 .row &%tls_eccurve%&                 "EC curve selection for server"
14610 .row &%tls_ocsp_file%&               "location of server certificate status proof"
14611 .row &%tls_on_connect_ports%&        "specify SSMTP (SMTPS) ports"
14612 .row &%tls_privatekey%&              "location of server private key"
14613 .row &%tls_remember_esmtp%&          "don't reset after starting TLS"
14614 .row &%tls_require_ciphers%&         "specify acceptable ciphers"
14615 .row &%tls_try_verify_hosts%&        "try to verify client certificate"
14616 .row &%tls_verify_certificates%&     "expected client certificates"
14617 .row &%tls_verify_hosts%&            "insist on client certificate verify"
14618 .endtable
14619
14620
14621
14622 .section "Local user handling" "SECID109"
14623 .table2
14624 .row &%finduser_retries%&            "useful in NIS environments"
14625 .row &%gecos_name%&                  "used when creating &'Sender:'&"
14626 .row &%gecos_pattern%&               "ditto"
14627 .row &%max_username_length%&         "for systems that truncate"
14628 .row &%unknown_login%&               "used when no login name found"
14629 .row &%unknown_username%&            "ditto"
14630 .row &%uucp_from_pattern%&           "for recognizing &""From ""& lines"
14631 .row &%uucp_from_sender%&            "ditto"
14632 .endtable
14633
14634
14635
14636 .section "All incoming messages (SMTP and non-SMTP)" "SECID110"
14637 .table2
14638 .row &%header_maxsize%&              "total size of message header"
14639 .row &%header_line_maxsize%&         "individual header line limit"
14640 .row &%message_size_limit%&          "applies to all messages"
14641 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
14642 .row &%received_header_text%&        "expanded to make &'Received:'&"
14643 .row &%received_headers_max%&        "for mail loop detection"
14644 .row &%recipients_max%&              "limit per message"
14645 .row &%recipients_max_reject%&       "permanently reject excess recipients"
14646 .endtable
14647
14648
14649
14650
14651 .section "Non-SMTP incoming messages" "SECID111"
14652 .table2
14653 .row &%receive_timeout%&             "for non-SMTP messages"
14654 .endtable
14655
14656
14657
14658
14659
14660 .section "Incoming SMTP messages" "SECID112"
14661 See also the &'Policy controls'& section above.
14662
14663 .table2
14664 .row &%dkim_verify_hashes%&          "DKIM hash methods accepted for signatures"
14665 .row &%dkim_verify_keytypes%&        "DKIM key types accepted for signatures"
14666 .row &%dkim_verify_min_keysizes%&    "DKIM key sizes accepted for signatures"
14667 .row &%dkim_verify_signers%&         "DKIM domains for which DKIM ACL is run"
14668 .row &%dmarc_forensic_sender%&       "DMARC sender for report messages"
14669 .row &%dmarc_history_file%&          "DMARC results log"
14670 .row &%dmarc_tld_file%&              "DMARC toplevel domains file"
14671 .row &%host_lookup%&                 "host name looked up for these hosts"
14672 .row &%host_lookup_order%&           "order of DNS and local name lookups"
14673 .row &%recipient_unqualified_hosts%& "may send unqualified recipients"
14674 .row &%rfc1413_hosts%&               "make ident calls to these hosts"
14675 .row &%rfc1413_query_timeout%&       "zero disables ident calls"
14676 .row &%sender_unqualified_hosts%&    "may send unqualified senders"
14677 .row &%smtp_accept_keepalive%&       "some TCP/IP magic"
14678 .row &%smtp_accept_max%&             "simultaneous incoming connections"
14679 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
14680 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
14681 .row &%smtp_accept_max_per_connection%& "messages per connection"
14682 .row &%smtp_accept_max_per_host%&    "connections from one host"
14683 .row &%smtp_accept_queue%&           "queue mail if more connections"
14684 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
14685                                            connection"
14686 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
14687 .row &%smtp_active_hostname%&        "host name to use in messages"
14688 .row &%smtp_banner%&                 "text for welcome banner"
14689 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
14690 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
14691 .row &%smtp_enforce_sync%&           "of SMTP command/responses"
14692 .row &%smtp_etrn_command%&           "what to run for ETRN"
14693 .row &%smtp_etrn_serialize%&         "only one at once"
14694 .row &%smtp_load_reserve%&           "only reserve hosts if this load"
14695 .row &%smtp_max_unknown_commands%&   "before dropping connection"
14696 .row &%smtp_ratelimit_hosts%&        "apply ratelimiting to these hosts"
14697 .row &%smtp_ratelimit_mail%&         "ratelimit for MAIL commands"
14698 .row &%smtp_ratelimit_rcpt%&         "ratelimit for RCPT commands"
14699 .row &%smtp_receive_timeout%&        "per command or data line"
14700 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
14701 .row &%smtp_return_error_details%&   "give detail on rejections"
14702 .endtable
14703
14704
14705
14706 .section "SMTP extensions" "SECID113"
14707 .table2
14708 .row &%accept_8bitmime%&             "advertise 8BITMIME"
14709 .row &%auth_advertise_hosts%&        "advertise AUTH to these hosts"
14710 .row &%chunking_advertise_hosts%&    "advertise CHUNKING to these hosts"
14711 .row &%dsn_advertise_hosts%&         "advertise DSN extensions to these hosts"
14712 .row &%ignore_fromline_hosts%&       "allow &""From ""& from these hosts"
14713 .row &%ignore_fromline_local%&       "allow &""From ""& from local SMTP"
14714 .row &%pipelining_advertise_hosts%&  "advertise pipelining to these hosts"
14715 .row &%pipelining_connect_advertise_hosts%& "advertise pipelining to these hosts"
14716 .row &%prdr_enable%&                 "advertise PRDR to all hosts"
14717 .row &%smtputf8_advertise_hosts%&    "advertise SMTPUTF8 to these hosts"
14718 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
14719 .endtable
14720
14721
14722
14723 .section "Processing messages" "SECID114"
14724 .table2
14725 .row &%allow_domain_literals%&       "recognize domain literal syntax"
14726 .row &%allow_mx_to_ip%&              "allow MX to point to IP address"
14727 .row &%allow_utf8_domains%&          "in addresses"
14728 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
14729                                       words""&"
14730 .row &%delivery_date_remove%&        "from incoming messages"
14731 .row &%envelope_to_remove%&          "from incoming messages"
14732 .row &%extract_addresses_remove_arguments%& "affects &%-t%& processing"
14733 .row &%headers_charset%&             "default for translations"
14734 .row &%qualify_domain%&              "default for senders"
14735 .row &%qualify_recipient%&           "default for recipients"
14736 .row &%return_path_remove%&          "from incoming messages"
14737 .row &%strip_excess_angle_brackets%& "in addresses"
14738 .row &%strip_trailing_dot%&          "at end of addresses"
14739 .row &%untrusted_set_sender%&        "untrusted can set envelope sender"
14740 .endtable
14741
14742
14743
14744 .section "System filter" "SECID115"
14745 .table2
14746 .row &%system_filter%&               "locate system filter"
14747 .row &%system_filter_directory_transport%& "transport for delivery to a &&&
14748                                             directory"
14749 .row &%system_filter_file_transport%& "transport for delivery to a file"
14750 .row &%system_filter_group%&         "group for filter running"
14751 .row &%system_filter_pipe_transport%& "transport for delivery to a pipe"
14752 .row &%system_filter_reply_transport%& "transport for autoreply delivery"
14753 .row &%system_filter_user%&          "user for filter running"
14754 .endtable
14755
14756
14757
14758 .section "Routing and delivery" "SECID116"
14759 .table2
14760 .row &%disable_ipv6%&                "do no IPv6 processing"
14761 .row &%dns_again_means_nonexist%&    "for broken domains"
14762 .row &%dns_check_names_pattern%&     "pre-DNS syntax check"
14763 .row &%dns_dnssec_ok%&               "parameter for resolver"
14764 .row &%dns_ipv4_lookup%&             "only v4 lookup for these domains"
14765 .row &%dns_retrans%&                 "parameter for resolver"
14766 .row &%dns_retry%&                   "parameter for resolver"
14767 .row &%dns_trust_aa%&                "DNS zones trusted as authentic"
14768 .row &%dns_use_edns0%&               "parameter for resolver"
14769 .row &%hold_domains%&                "hold delivery for these domains"
14770 .row &%local_interfaces%&            "for routing checks"
14771 .row &%queue_domains%&               "no immediate delivery for these"
14772 .row &%queue_only%&                  "no immediate delivery at all"
14773 .row &%queue_only_file%&             "no immediate delivery if file exists"
14774 .row &%queue_only_load%&             "no immediate delivery if load is high"
14775 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
14776 .row &%queue_only_override%&         "allow command line to override"
14777 .row &%queue_run_in_order%&          "order of arrival"
14778 .row &%queue_run_max%&               "of simultaneous queue runners"
14779 .row &%queue_smtp_domains%&          "no immediate SMTP delivery for these"
14780 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
14781 .row &%remote_sort_domains%&         "order of remote deliveries"
14782 .row &%retry_data_expire%&           "timeout for retry data"
14783 .row &%retry_interval_max%&          "safety net for retry rules"
14784 .endtable
14785
14786
14787
14788 .section "Bounce and warning messages" "SECID117"
14789 .table2
14790 .row &%bounce_message_file%&         "content of bounce"
14791 .row &%bounce_message_text%&         "content of bounce"
14792 .row &%bounce_return_body%&          "include body if returning message"
14793 .row &%bounce_return_linesize_limit%& "limit on returned message line length"
14794 .row &%bounce_return_message%&       "include original message in bounce"
14795 .row &%bounce_return_size_limit%&    "limit on returned message"
14796 .row &%bounce_sender_authentication%& "send authenticated sender with bounce"
14797 .row &%dsn_from%&                    "set &'From:'& contents in bounces"
14798 .row &%errors_copy%&                 "copy bounce messages"
14799 .row &%errors_reply_to%&             "&'Reply-to:'& in bounces"
14800 .row &%delay_warning%&               "time schedule"
14801 .row &%delay_warning_condition%&     "condition for warning messages"
14802 .row &%ignore_bounce_errors_after%&  "discard undeliverable bounces"
14803 .row &%smtp_return_error_details%&   "give detail on rejections"
14804 .row &%warn_message_file%&           "content of warning message"
14805 .endtable
14806
14807
14808
14809 .section "Alphabetical list of main options" "SECTalomo"
14810 Those options that undergo string expansion before use are marked with
14811 &dagger;.
14812
14813 .option accept_8bitmime main boolean true
14814 .cindex "8BITMIME"
14815 .cindex "8-bit characters"
14816 .cindex "log" "selectors"
14817 .cindex "log" "8BITMIME"
14818 .cindex "ESMTP extensions" 8BITMIME
14819 This option causes Exim to send 8BITMIME in its response to an SMTP
14820 EHLO command, and to accept the BODY= parameter on MAIL commands.
14821 However, though Exim is 8-bit clean, it is not a protocol converter, and it
14822 takes no steps to do anything special with messages received by this route.
14823
14824 Historically Exim kept this option off by default, but the maintainers
14825 feel that in today's Internet, this causes more problems than it solves.
14826 It now defaults to true.
14827 A more detailed analysis of the issues is provided by Dan Bernstein:
14828 .display
14829 &url(https://cr.yp.to/smtp/8bitmime.html)
14830 .endd
14831
14832 To log received 8BITMIME status use
14833 .code
14834 log_selector = +8bitmime
14835 .endd
14836
14837 .option acl_not_smtp main string&!! unset
14838 .cindex "&ACL;" "for non-SMTP messages"
14839 .cindex "non-SMTP messages" "ACLs for"
14840 This option defines the ACL that is run when a non-SMTP message has been
14841 read and is on the point of being accepted. See chapter &<<CHAPACL>>& for
14842 further details.
14843
14844 .option acl_not_smtp_mime main string&!! unset
14845 This option defines the ACL that is run for individual MIME parts of non-SMTP
14846 messages. It operates in exactly the same way as &%acl_smtp_mime%& operates for
14847 SMTP messages.
14848
14849 .option acl_not_smtp_start main string&!! unset
14850 .cindex "&ACL;" "at start of non-SMTP message"
14851 .cindex "non-SMTP messages" "ACLs for"
14852 This option defines the ACL that is run before Exim starts reading a
14853 non-SMTP message. See chapter &<<CHAPACL>>& for further details.
14854
14855 .option acl_smtp_auth main string&!! unset
14856 .cindex "&ACL;" "setting up for SMTP commands"
14857 .cindex "AUTH" "ACL for"
14858 This option defines the ACL that is run when an SMTP AUTH command is
14859 received. See chapter &<<CHAPACL>>& for further details.
14860
14861 .option acl_smtp_connect main string&!! unset
14862 .cindex "&ACL;" "on SMTP connection"
14863 This option defines the ACL that is run when an SMTP connection is received.
14864 See chapter &<<CHAPACL>>& for further details.
14865
14866 .option acl_smtp_data main string&!! unset
14867 .cindex "DATA" "ACL for"
14868 This option defines the ACL that is run after an SMTP DATA command has been
14869 processed and the message itself has been received, but before the final
14870 acknowledgment is sent. See chapter &<<CHAPACL>>& for further details.
14871
14872 .option acl_smtp_data_prdr main string&!! accept
14873 .cindex "PRDR" "ACL for"
14874 .cindex "DATA" "PRDR ACL for"
14875 .cindex "&ACL;" "PRDR-related"
14876 .cindex "&ACL;" "per-user data processing"
14877 This option defines the ACL that,
14878 if the PRDR feature has been negotiated,
14879 is run for each recipient after an SMTP DATA command has been
14880 processed and the message itself has been received, but before the
14881 acknowledgment is sent. See chapter &<<CHAPACL>>& for further details.
14882
14883 .option acl_smtp_dkim main string&!! unset
14884 .cindex DKIM "ACL for"
14885 This option defines the ACL that is run for each DKIM signature
14886 (by default, or as specified in the dkim_verify_signers option)
14887 of a received message.
14888 See section &<<SECDKIMVFY>>& for further details.
14889
14890 .option acl_smtp_etrn main string&!! unset
14891 .cindex "ETRN" "ACL for"
14892 This option defines the ACL that is run when an SMTP ETRN command is
14893 received. See chapter &<<CHAPACL>>& for further details.
14894
14895 .option acl_smtp_expn main string&!! unset
14896 .cindex "EXPN" "ACL for"
14897 This option defines the ACL that is run when an SMTP EXPN command is
14898 received. See chapter &<<CHAPACL>>& for further details.
14899
14900 .option acl_smtp_helo main string&!! unset
14901 .cindex "EHLO" "ACL for"
14902 .cindex "HELO" "ACL for"
14903 This option defines the ACL that is run when an SMTP EHLO or HELO
14904 command is received. See chapter &<<CHAPACL>>& for further details.
14905
14906
14907 .option acl_smtp_mail main string&!! unset
14908 .cindex "MAIL" "ACL for"
14909 This option defines the ACL that is run when an SMTP MAIL command is
14910 received. See chapter &<<CHAPACL>>& for further details.
14911
14912 .option acl_smtp_mailauth main string&!! unset
14913 .cindex "AUTH" "on MAIL command"
14914 This option defines the ACL that is run when there is an AUTH parameter on
14915 a MAIL command. See chapter &<<CHAPACL>>& for details of ACLs, and chapter
14916 &<<CHAPSMTPAUTH>>& for details of authentication.
14917
14918 .option acl_smtp_mime main string&!! unset
14919 .cindex "MIME content scanning" "ACL for"
14920 This option is available when Exim is built with the content-scanning
14921 extension. It defines the ACL that is run for each MIME part in a message. See
14922 section &<<SECTscanmimepart>>& for details.
14923
14924 .option acl_smtp_notquit main string&!! unset
14925 .cindex "not-QUIT, ACL for"
14926 This option defines the ACL that is run when an SMTP session
14927 ends without a QUIT command being received.
14928 See chapter &<<CHAPACL>>& for further details.
14929
14930 .option acl_smtp_predata main string&!! unset
14931 This option defines the ACL that is run when an SMTP DATA command is
14932 received, before the message itself is received. See chapter &<<CHAPACL>>& for
14933 further details.
14934
14935 .option acl_smtp_quit main string&!! unset
14936 .cindex "QUIT, ACL for"
14937 This option defines the ACL that is run when an SMTP QUIT command is
14938 received. See chapter &<<CHAPACL>>& for further details.
14939
14940 .option acl_smtp_rcpt main string&!! unset
14941 .cindex "RCPT" "ACL for"
14942 This option defines the ACL that is run when an SMTP RCPT command is
14943 received. See chapter &<<CHAPACL>>& for further details.
14944
14945 .option acl_smtp_starttls main string&!! unset
14946 .cindex "STARTTLS, ACL for"
14947 This option defines the ACL that is run when an SMTP STARTTLS command is
14948 received. See chapter &<<CHAPACL>>& for further details.
14949
14950 .option acl_smtp_vrfy main string&!! unset
14951 .cindex "VRFY" "ACL for"
14952 This option defines the ACL that is run when an SMTP VRFY command is
14953 received. See chapter &<<CHAPACL>>& for further details.
14954
14955 .option add_environment main "string list" empty
14956 .cindex "environment" "set values"
14957 This option adds individual environment variables that the
14958 currently linked libraries and programs in child processes may use.
14959 Each list element should be of the form &"name=value"&.
14960
14961 See &<<SECTpipeenv>>& for the environment of &(pipe)& transports.
14962
14963 .option admin_groups main "string list&!!" unset
14964 .cindex "admin user"
14965 This option is expanded just once, at the start of Exim's processing. If the
14966 current group or any of the supplementary groups of an Exim caller is in this
14967 colon-separated list, the caller has admin privileges. If all your system
14968 programmers are in a specific group, for example, you can give them all Exim
14969 admin privileges by putting that group in &%admin_groups%&. However, this does
14970 not permit them to read Exim's spool files (whose group owner is the Exim gid).
14971 To permit this, you have to add individuals to the Exim group.
14972
14973 .option allow_domain_literals main boolean false
14974 .cindex "domain literal"
14975 If this option is set, the RFC 2822 domain literal format is permitted in
14976 email addresses. The option is not set by default, because the domain literal
14977 format is not normally required these days, and few people know about it. It
14978 has, however, been exploited by mail abusers.
14979
14980 Unfortunately, it seems that some DNS black list maintainers are using this
14981 format to report black listing to postmasters. If you want to accept messages
14982 addressed to your hosts by IP address, you need to set
14983 &%allow_domain_literals%& true, and also to add &`@[]`& to the list of local
14984 domains (defined in the named domain list &%local_domains%& in the default
14985 configuration). This &"magic string"& matches the domain literal form of all
14986 the local host's IP addresses.
14987
14988
14989 .option allow_mx_to_ip main boolean false
14990 .cindex "MX record" "pointing to IP address"
14991 It appears that more and more DNS zone administrators are breaking the rules
14992 and putting domain names that look like IP addresses on the right hand side of
14993 MX records. Exim follows the rules and rejects this, giving an error message
14994 that explains the misconfiguration. However, some other MTAs support this
14995 practice, so to avoid &"Why can't Exim do this?"& complaints,
14996 &%allow_mx_to_ip%& exists, in order to enable this heinous activity. It is not
14997 recommended, except when you have no other choice.
14998
14999 .option allow_utf8_domains main boolean false
15000 .cindex "domain" "UTF-8 characters in"
15001 .cindex "UTF-8" "in domain name"
15002 Lots of discussion is going on about internationalized domain names. One
15003 camp is strongly in favour of just using UTF-8 characters, and it seems
15004 that at least two other MTAs permit this.
15005 This option allows Exim users to experiment if they wish.
15006
15007 If it is set true, Exim's domain parsing function allows valid
15008 UTF-8 multicharacters to appear in domain name components, in addition to
15009 letters, digits, and hyphens.
15010
15011 If Exim is built with internationalization support
15012 and the SMTPUTF8 ESMTP option is in use (see chapter &<<CHAPi18n>>&)
15013 this option can be left as default.
15014 Without that,
15015 if you want to look up such domain names in the DNS, you must also
15016 adjust the value of &%dns_check_names_pattern%& to match the extended form. A
15017 suitable setting is:
15018 .code
15019 dns_check_names_pattern = (?i)^(?>(?(1)\.|())[a-z0-9\xc0-\xff]\
15020   (?>[-a-z0-9\x80-\xff]*[a-z0-9\x80-\xbf])?)+$
15021 .endd
15022 Alternatively, you can just disable this feature by setting
15023 .code
15024 dns_check_names_pattern =
15025 .endd
15026 That is, set the option to an empty string so that no check is done.
15027
15028
15029 .option auth_advertise_hosts main "host list&!!" *
15030 .cindex "authentication" "advertising"
15031 .cindex "AUTH" "advertising"
15032 .cindex "ESMTP extensions" AUTH
15033 If any server authentication mechanisms are configured, Exim advertises them in
15034 response to an EHLO command only if the calling host matches this list.
15035 Otherwise, Exim does not advertise AUTH.
15036 Exim does not accept AUTH commands from clients to which it has not
15037 advertised the availability of AUTH. The advertising of individual
15038 authentication mechanisms can be controlled by the use of the
15039 &%server_advertise_condition%& generic authenticator option on the individual
15040 authenticators. See chapter &<<CHAPSMTPAUTH>>& for further details.
15041
15042 Certain mail clients (for example, Netscape) require the user to provide a name
15043 and password for authentication if AUTH is advertised, even though it may
15044 not be needed (the host may accept messages from hosts on its local LAN without
15045 authentication, for example). The &%auth_advertise_hosts%& option can be used
15046 to make these clients more friendly by excluding them from the set of hosts to
15047 which Exim advertises AUTH.
15048
15049 .cindex "AUTH" "advertising when encrypted"
15050 If you want to advertise the availability of AUTH only when the connection
15051 is encrypted using TLS, you can make use of the fact that the value of this
15052 option is expanded, with a setting like this:
15053 .code
15054 auth_advertise_hosts = ${if eq{$tls_in_cipher}{}{}{*}}
15055 .endd
15056 .vindex "&$tls_in_cipher$&"
15057 If &$tls_in_cipher$& is empty, the session is not encrypted, and the result of
15058 the expansion is empty, thus matching no hosts. Otherwise, the result of the
15059 expansion is *, which matches all hosts.
15060
15061
15062 .option auto_thaw main time 0s
15063 .cindex "thawing messages"
15064 .cindex "unfreezing messages"
15065 If this option is set to a time greater than zero, a queue runner will try a
15066 new delivery attempt on any frozen message, other than a bounce message, if
15067 this much time has passed since it was frozen. This may result in the message
15068 being re-frozen if nothing has changed since the last attempt. It is a way of
15069 saying &"keep on trying, even though there are big problems"&.
15070
15071 &*Note*&: This is an old option, which predates &%timeout_frozen_after%& and
15072 &%ignore_bounce_errors_after%&. It is retained for compatibility, but it is not
15073 thought to be very useful any more, and its use should probably be avoided.
15074
15075
15076 .option av_scanner main string "see below"
15077 This option is available if Exim is built with the content-scanning extension.
15078 It specifies which anti-virus scanner to use. The default value is:
15079 .code
15080 sophie:/var/run/sophie
15081 .endd
15082 If the value of &%av_scanner%& starts with a dollar character, it is expanded
15083 before use. See section &<<SECTscanvirus>>& for further details.
15084
15085
15086 .option bi_command main string unset
15087 .oindex "&%-bi%&"
15088 This option supplies the name of a command that is run when Exim is called with
15089 the &%-bi%& option (see chapter &<<CHAPcommandline>>&). The string value is
15090 just the command name, it is not a complete command line. If an argument is
15091 required, it must come from the &%-oA%& command line option.
15092
15093
15094 .option bounce_message_file main string&!! unset
15095 .cindex "bounce message" "customizing"
15096 .cindex "customizing" "bounce message"
15097 This option defines a template file containing paragraphs of text to be used
15098 for constructing bounce messages.  Details of the file's contents are given in
15099 chapter &<<CHAPemsgcust>>&.
15100 .new
15101 .cindex bounce_message_file "tainted data"
15102 The option is expanded to give the file path, which must be
15103 absolute and untainted.
15104 .wen
15105 See also &%warn_message_file%&.
15106
15107
15108 .option bounce_message_text main string unset
15109 When this option is set, its contents are included in the default bounce
15110 message immediately after &"This message was created automatically by mail
15111 delivery software."& It is not used if &%bounce_message_file%& is set.
15112
15113 .option bounce_return_body main boolean true
15114 .cindex "bounce message" "including body"
15115 This option controls whether the body of an incoming message is included in a
15116 bounce message when &%bounce_return_message%& is true. The default setting
15117 causes the entire message, both header and body, to be returned (subject to the
15118 value of &%bounce_return_size_limit%&). If this option is false, only the
15119 message header is included. In the case of a non-SMTP message containing an
15120 error that is detected during reception, only those header lines preceding the
15121 point at which the error was detected are returned.
15122 .cindex "bounce message" "including original"
15123
15124 .option bounce_return_linesize_limit main integer 998
15125 .cindex "size" "of bounce lines, limit"
15126 .cindex "bounce message" "line length limit"
15127 .cindex "limit" "bounce message line length"
15128 This option sets a limit in bytes on the line length of messages
15129 that are returned to senders due to delivery problems,
15130 when &%bounce_return_message%& is true.
15131 The default value corresponds to RFC limits.
15132 If the message being returned has lines longer than this value it is
15133 treated as if the &%bounce_return_size_limit%& (below) restriction was exceeded.
15134
15135 The option also applies to bounces returned when an error is detected
15136 during reception of a message.
15137 In this case lines from the original are truncated.
15138
15139 The option does not apply to messages generated by an &(autoreply)& transport.
15140
15141
15142 .option bounce_return_message main boolean true
15143 If this option is set false, none of the original message is included in
15144 bounce messages generated by Exim. See also &%bounce_return_size_limit%& and
15145 &%bounce_return_body%&.
15146
15147
15148 .option bounce_return_size_limit main integer 100K
15149 .cindex "size" "of bounce, limit"
15150 .cindex "bounce message" "size limit"
15151 .cindex "limit" "bounce message size"
15152 This option sets a limit in bytes on the size of messages that are returned to
15153 senders as part of bounce messages when &%bounce_return_message%& is true. The
15154 limit should be less than the value of the global &%message_size_limit%& and of
15155 any &%message_size_limit%& settings on transports, to allow for the bounce text
15156 that Exim generates. If this option is set to zero there is no limit.
15157
15158 When the body of any message that is to be included in a bounce message is
15159 greater than the limit, it is truncated, and a comment pointing this out is
15160 added at the top. The actual cutoff may be greater than the value given, owing
15161 to the use of buffering for transferring the message in chunks (typically 8K in
15162 size). The idea is to save bandwidth on those undeliverable 15-megabyte
15163 messages.
15164
15165 .option bounce_sender_authentication main string unset
15166 .cindex "bounce message" "sender authentication"
15167 .cindex "authentication" "bounce message"
15168 .cindex "AUTH" "on bounce message"
15169 This option provides an authenticated sender address that is sent with any
15170 bounce messages generated by Exim that are sent over an authenticated SMTP
15171 connection. A typical setting might be:
15172 .code
15173 bounce_sender_authentication = mailer-daemon@my.domain.example
15174 .endd
15175 which would cause bounce messages to be sent using the SMTP command:
15176 .code
15177 MAIL FROM:<> AUTH=mailer-daemon@my.domain.example
15178 .endd
15179 The value of &%bounce_sender_authentication%& must always be a complete email
15180 address.
15181
15182 .option callout_domain_negative_expire main time 3h
15183 .cindex "caching" "callout timeouts"
15184 .cindex "callout" "caching timeouts"
15185 This option specifies the expiry time for negative callout cache data for a
15186 domain. See section &<<SECTcallver>>& for details of callout verification, and
15187 section &<<SECTcallvercache>>& for details of the caching.
15188
15189
15190 .option callout_domain_positive_expire main time 7d
15191 This option specifies the expiry time for positive callout cache data for a
15192 domain. See section &<<SECTcallver>>& for details of callout verification, and
15193 section &<<SECTcallvercache>>& for details of the caching.
15194
15195
15196 .option callout_negative_expire main time 2h
15197 This option specifies the expiry time for negative callout cache data for an
15198 address. See section &<<SECTcallver>>& for details of callout verification, and
15199 section &<<SECTcallvercache>>& for details of the caching.
15200
15201
15202 .option callout_positive_expire main time 24h
15203 This option specifies the expiry time for positive callout cache data for an
15204 address. See section &<<SECTcallver>>& for details of callout verification, and
15205 section &<<SECTcallvercache>>& for details of the caching.
15206
15207
15208 .option callout_random_local_part main string&!! "see below"
15209 This option defines the &"random"& local part that can be used as part of
15210 callout verification. The default value is
15211 .code
15212 $primary_hostname-$tod_epoch-testing
15213 .endd
15214 See section &<<CALLaddparcall>>& for details of how this value is used.
15215
15216
15217 .option check_log_inodes main integer 100
15218 See &%check_spool_space%& below.
15219
15220
15221 .option check_log_space main integer 10M
15222 See &%check_spool_space%& below.
15223
15224 .oindex "&%check_rfc2047_length%&"
15225 .cindex "RFC 2047" "disabling length check"
15226 .option check_rfc2047_length main boolean true
15227 RFC 2047 defines a way of encoding non-ASCII characters in headers using a
15228 system of &"encoded words"&. The RFC specifies a maximum length for an encoded
15229 word; strings to be encoded that exceed this length are supposed to use
15230 multiple encoded words. By default, Exim does not recognize encoded words that
15231 exceed the maximum length. However, it seems that some software, in violation
15232 of the RFC, generates overlong encoded words. If &%check_rfc2047_length%& is
15233 set false, Exim recognizes encoded words of any length.
15234
15235
15236 .option check_spool_inodes main integer 100
15237 See &%check_spool_space%& below.
15238
15239
15240 .option check_spool_space main integer 10M
15241 .cindex "checking disk space"
15242 .cindex "disk space, checking"
15243 .cindex "spool directory" "checking space"
15244 The four &%check_...%& options allow for checking of disk resources before a
15245 message is accepted.
15246
15247 .vindex "&$log_inodes$&"
15248 .vindex "&$log_space$&"
15249 .vindex "&$spool_inodes$&"
15250 .vindex "&$spool_space$&"
15251 When any of these options are nonzero, they apply to all incoming messages. If you
15252 want to apply different checks to different kinds of message, you can do so by
15253 testing the variables &$log_inodes$&, &$log_space$&, &$spool_inodes$&, and
15254 &$spool_space$& in an ACL with appropriate additional conditions.
15255
15256
15257 &%check_spool_space%& and &%check_spool_inodes%& check the spool partition if
15258 either value is greater than zero, for example:
15259 .code
15260 check_spool_space = 100M
15261 check_spool_inodes = 100
15262 .endd
15263 The spool partition is the one that contains the directory defined by
15264 SPOOL_DIRECTORY in &_Local/Makefile_&. It is used for holding messages in
15265 transit.
15266
15267 &%check_log_space%& and &%check_log_inodes%&  check the partition in which log
15268 files are written if either is greater than zero. These should be set only if
15269 &%log_file_path%& and &%spool_directory%& refer to different partitions.
15270
15271 If there is less space or fewer inodes than requested, Exim refuses to accept
15272 incoming mail. In the case of SMTP input this is done by giving a 452 temporary
15273 error response to the MAIL command. If ESMTP is in use and there was a
15274 SIZE parameter on the MAIL command, its value is added to the
15275 &%check_spool_space%& value, and the check is performed even if
15276 &%check_spool_space%& is zero, unless &%no_smtp_check_spool_space%& is set.
15277
15278 The values for &%check_spool_space%& and &%check_log_space%& are held as a
15279 number of kilobytes (though specified in bytes).
15280 If a non-multiple of 1024 is specified, it is rounded up.
15281
15282 For non-SMTP input and for batched SMTP input, the test is done at start-up; on
15283 failure a message is written to stderr and Exim exits with a non-zero code, as
15284 it obviously cannot send an error message of any kind.
15285
15286 There is a slight performance penalty for these checks.
15287 Versions of Exim preceding 4.88 had these disabled by default;
15288 high-rate installations confident they will never run out of resources
15289 may wish to deliberately disable them.
15290
15291 .option chunking_advertise_hosts main "host list&!!" *
15292 .cindex CHUNKING advertisement
15293 .cindex "RFC 3030" "CHUNKING"
15294 .cindex "ESMTP extensions" CHUNKING
15295 The CHUNKING extension (RFC3030) will be advertised in the EHLO message to
15296 these hosts.
15297 Hosts may use the BDAT command as an alternate to DATA.
15298
15299 .option commandline_checks_require_admin main boolean &`false`&
15300 .cindex "restricting access to features"
15301 This option restricts various basic checking features to require an
15302 administrative user.
15303 This affects most of the &%-b*%& options, such as &%-be%&.
15304
15305 .option debug_store main boolean &`false`&
15306 .cindex debugging "memory corruption"
15307 .cindex memory debugging
15308 This option, when true, enables extra checking in Exim's internal memory
15309 management.  For use when a memory corruption issue is being investigated,
15310 it should normally be left as default.
15311
15312 .option daemon_smtp_ports main string &`smtp`&
15313 .cindex "port" "for daemon"
15314 .cindex "TCP/IP" "setting listening ports"
15315 This option specifies one or more default SMTP ports on which the Exim daemon
15316 listens. See chapter &<<CHAPinterfaces>>& for details of how it is used. For
15317 backward compatibility, &%daemon_smtp_port%& (singular) is a synonym.
15318
15319 .option daemon_startup_retries main integer 9
15320 .cindex "daemon startup, retrying"
15321 This option, along with &%daemon_startup_sleep%&, controls the retrying done by
15322 the daemon at startup when it cannot immediately bind a listening socket
15323 (typically because the socket is already in use): &%daemon_startup_retries%&
15324 defines the number of retries after the first failure, and
15325 &%daemon_startup_sleep%& defines the length of time to wait between retries.
15326
15327 .option daemon_startup_sleep main time 30s
15328 See &%daemon_startup_retries%&.
15329
15330 .option delay_warning main "time list" 24h
15331 .cindex "warning of delay"
15332 .cindex "delay warning, specifying"
15333 .cindex "queue" "delay warning"
15334 When a message is delayed, Exim sends a warning message to the sender at
15335 intervals specified by this option. The data is a colon-separated list of times
15336 after which to send warning messages. If the value of the option is an empty
15337 string or a zero time, no warnings are sent. Up to 10 times may be given. If a
15338 message has been in the queue for longer than the last time, the last interval
15339 between the times is used to compute subsequent warning times. For example,
15340 with
15341 .code
15342 delay_warning = 4h:8h:24h
15343 .endd
15344 the first message is sent after 4 hours, the second after 8 hours, and
15345 the third one after 24 hours. After that, messages are sent every 16 hours,
15346 because that is the interval between the last two times on the list. If you set
15347 just one time, it specifies the repeat interval. For example, with:
15348 .code
15349 delay_warning = 6h
15350 .endd
15351 messages are repeated every six hours. To stop warnings after a given time, set
15352 a very large time at the end of the list. For example:
15353 .code
15354 delay_warning = 2h:12h:99d
15355 .endd
15356 Note that the option is only evaluated at the time a delivery attempt fails,
15357 which depends on retry and queue-runner configuration.
15358 Typically retries will be configured more frequently than warning messages.
15359
15360 .option delay_warning_condition main string&!! "see below"
15361 .vindex "&$domain$&"
15362 The string is expanded at the time a warning message might be sent. If all the
15363 deferred addresses have the same domain, it is set in &$domain$& during the
15364 expansion. Otherwise &$domain$& is empty. If the result of the expansion is a
15365 forced failure, an empty string, or a string matching any of &"0"&, &"no"& or
15366 &"false"& (the comparison being done caselessly) then the warning message is
15367 not sent. The default is:
15368 .code
15369 delay_warning_condition = ${if or {\
15370   { !eq{$h_list-id:$h_list-post:$h_list-subscribe:}{} }\
15371   { match{$h_precedence:}{(?i)bulk|list|junk} }\
15372   { match{$h_auto-submitted:}{(?i)auto-generated|auto-replied} }\
15373   } {no}{yes}}
15374 .endd
15375 This suppresses the sending of warnings for messages that contain &'List-ID:'&,
15376 &'List-Post:'&, or &'List-Subscribe:'& headers, or have &"bulk"&, &"list"& or
15377 &"junk"& in a &'Precedence:'& header, or have &"auto-generated"& or
15378 &"auto-replied"& in an &'Auto-Submitted:'& header.
15379
15380 .option deliver_drop_privilege main boolean false
15381 .cindex "unprivileged delivery"
15382 .cindex "delivery" "unprivileged"
15383 If this option is set true, Exim drops its root privilege at the start of a
15384 delivery process, and runs as the Exim user throughout. This severely restricts
15385 the kinds of local delivery that are possible, but is viable in certain types
15386 of configuration. There is a discussion about the use of root privilege in
15387 chapter &<<CHAPsecurity>>&.
15388
15389 .option deliver_queue_load_max main fixed-point unset
15390 .cindex "load average"
15391 .cindex "queue runner" "abandoning"
15392 When this option is set, a queue run is abandoned if the system load average
15393 becomes greater than the value of the option. The option has no effect on
15394 ancient operating systems on which Exim cannot determine the load average.
15395 See also &%queue_only_load%& and &%smtp_load_reserve%&.
15396
15397
15398 .option delivery_date_remove main boolean true
15399 .cindex "&'Delivery-date:'& header line"
15400 Exim's transports have an option for adding a &'Delivery-date:'& header to a
15401 message when it is delivered, in exactly the same way as &'Return-path:'& is
15402 handled. &'Delivery-date:'& records the actual time of delivery. Such headers
15403 should not be present in incoming messages, and this option causes them to be
15404 removed at the time the message is received, to avoid any problems that might
15405 occur when a delivered message is subsequently sent on to some other recipient.
15406
15407 .option disable_fsync main boolean false
15408 .cindex "&[fsync()]&, disabling"
15409 This option is available only if Exim was built with the compile-time option
15410 ENABLE_DISABLE_FSYNC. When this is not set, a reference to &%disable_fsync%& in
15411 a runtime configuration generates an &"unknown option"& error. You should not
15412 build Exim with ENABLE_DISABLE_FSYNC or set &%disable_fsync%& unless you
15413 really, really, really understand what you are doing. &'No pre-compiled
15414 distributions of Exim should ever make this option available.'&
15415
15416 When &%disable_fsync%& is set true, Exim no longer calls &[fsync()]& to force
15417 updated files' data to be written to disc before continuing. Unexpected events
15418 such as crashes and power outages may cause data to be lost or scrambled.
15419 Here be Dragons. &*Beware.*&
15420
15421
15422 .option disable_ipv6 main boolean false
15423 .cindex "IPv6" "disabling"
15424 If this option is set true, even if the Exim binary has IPv6 support, no IPv6
15425 activities take place. AAAA records are never looked up, and any IPv6 addresses
15426 that are listed in &%local_interfaces%&, data for the &%manualroute%& router,
15427 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
15428 to handle IPv6 literal addresses.
15429
15430
15431 .new
15432 .option dkim_verify_hashes main "string list" "sha256 : sha512"
15433 .cindex DKIM "selecting signature algorithms"
15434 This option gives a list of hash types which are acceptable in signatures,
15435 .wen
15436 and an order of processing.
15437 Signatures with algorithms not in the list will be ignored.
15438
15439 Acceptable values include:
15440 .code
15441 sha1
15442 sha256
15443 sha512
15444 .endd
15445
15446 Note that the acceptance of sha1 violates RFC 8301.
15447
15448 .option dkim_verify_keytypes main "string list" "ed25519 : rsa"
15449 This option gives a list of key types which are acceptable in signatures,
15450 and an order of processing.
15451 Signatures with algorithms not in the list will be ignored.
15452
15453
15454 .new
15455 .option dkim_verify_min_keysizes main "string list" "rsa=1024 ed25519=250"
15456 This option gives a list of key sizes which are acceptable in signatures.
15457 The list is keyed by the algorithm type for the key; the values are in bits.
15458 Signatures with keys smaller than given by this option will fail verification.
15459
15460 The default enforces the RFC 8301 minimum key size for RSA signatures.
15461 .wen
15462
15463 .option dkim_verify_minimal main boolean false
15464 If set to true, verification of signatures will terminate after the
15465 first success.
15466
15467 .option dkim_verify_signers main "domain list&!!" $dkim_signers
15468 .cindex DKIM "controlling calls to the ACL"
15469 This option gives a list of DKIM domains for which the DKIM ACL is run.
15470 It is expanded after the message is received; by default it runs
15471 the ACL once for each signature in the message.
15472 See section &<<SECDKIMVFY>>&.
15473
15474
15475 .option dmarc_forensic_sender main string&!! unset
15476 .option dmarc_history_file main string unset
15477 .option dmarc_tld_file main string unset
15478 .cindex DMARC "main section options"
15479 These options control DMARC processing.
15480 See section &<<SECDMARC>>& for details.
15481
15482
15483 .option dns_again_means_nonexist main "domain list&!!" unset
15484 .cindex "DNS" "&""try again""& response; overriding"
15485 DNS lookups give a &"try again"& response for the DNS errors
15486 &"non-authoritative host not found"& and &"SERVERFAIL"&. This can cause Exim to
15487 keep trying to deliver a message, or to give repeated temporary errors to
15488 incoming mail. Sometimes the effect is caused by a badly set up name server and
15489 may persist for a long time. If a domain which exhibits this problem matches
15490 anything in &%dns_again_means_nonexist%&, it is treated as if it did not exist.
15491 This option should be used with care. You can make it apply to reverse lookups
15492 by a setting such as this:
15493 .code
15494 dns_again_means_nonexist = *.in-addr.arpa
15495 .endd
15496 This option applies to all DNS lookups that Exim does. It also applies when the
15497 &[gethostbyname()]& or &[getipnodebyname()]& functions give temporary errors,
15498 since these are most likely to be caused by DNS lookup problems. The
15499 &(dnslookup)& router has some options of its own for controlling what happens
15500 when lookups for MX or SRV records give temporary errors. These more specific
15501 options are applied after this global option.
15502
15503 .option dns_check_names_pattern main string "see below"
15504 .cindex "DNS" "pre-check of name syntax"
15505 When this option is set to a non-empty string, it causes Exim to check domain
15506 names for characters that are not allowed in host names before handing them to
15507 the DNS resolver, because some resolvers give temporary errors for names that
15508 contain unusual characters. If a domain name contains any unwanted characters,
15509 a &"not found"& result is forced, and the resolver is not called. The check is
15510 done by matching the domain name against a regular expression, which is the
15511 value of this option. The default pattern is
15512 .code
15513 dns_check_names_pattern = \
15514   (?i)^(?>(?(1)\.|())[^\W_](?>[a-z0-9/-]*[^\W_])?)+$
15515 .endd
15516 which permits only letters, digits, slashes, and hyphens in components, but
15517 they must start and end with a letter or digit. Slashes are not, in fact,
15518 permitted in host names, but they are found in certain NS records (which can be
15519 accessed in Exim by using a &%dnsdb%& lookup). If you set
15520 &%allow_utf8_domains%&, you must modify this pattern, or set the option to an
15521 empty string.
15522
15523 .option dns_csa_search_limit main integer 5
15524 This option controls the depth of parental searching for CSA SRV records in the
15525 DNS, as described in more detail in section &<<SECTverifyCSA>>&.
15526
15527 .option dns_csa_use_reverse main boolean true
15528 This option controls whether or not an IP address, given as a CSA domain, is
15529 reversed and looked up in the reverse DNS, as described in more detail in
15530 section &<<SECTverifyCSA>>&.
15531
15532 .option dns_cname_loops main integer 1
15533 .cindex DNS "CNAME following"
15534 This option controls the following of CNAME chains, needed if the resolver does
15535 not do it internally.
15536 As of 2018 most should, and the default can be left.
15537 If you have an ancient one, a value of 10 is likely needed.
15538
15539 The default value of one CNAME-follow is needed
15540 thanks to the observed return for an MX request,
15541 given no MX presence but a CNAME to an A, of the CNAME.
15542
15543
15544 .option dns_dnssec_ok main integer -1
15545 .cindex "DNS" "resolver options"
15546 .cindex "DNS" "DNSSEC"
15547 If this option is set to a non-negative number then Exim will initialise the
15548 DNS resolver library to either use or not use DNSSEC, overriding the system
15549 default. A value of 0 coerces DNSSEC off, a value of 1 coerces DNSSEC on.
15550
15551 If the resolver library does not support DNSSEC then this option has no effect.
15552
15553 .new
15554 On Linux with glibc 2.31 or newer this is insufficient, the resolver library
15555 will default to stripping out a successful validation status.
15556 This will break a previously working Exim installation.
15557 Provided that you do trust the resolver (ie, is on localhost) you can tell
15558 glibc to pass through any successful validation with a new option in
15559 &_/etc/resolv.conf_&:
15560 .code
15561 options trust-ad
15562 .endd
15563 .wen
15564
15565
15566 .option dns_ipv4_lookup main "domain list&!!" unset
15567 .cindex "IPv6" "DNS lookup for AAAA records"
15568 .cindex "DNS" "IPv6 lookup for AAAA records"
15569 .cindex DNS "IPv6 disabling"
15570 When Exim is compiled with IPv6 support and &%disable_ipv6%& is not set, it
15571 looks for IPv6 address records (AAAA records) as well as IPv4 address records
15572 (A records) when trying to find IP addresses for hosts, unless the host's
15573 domain matches this list.
15574
15575 This is a fudge to help with name servers that give big delays or otherwise do
15576 not work for the AAAA record type. In due course, when the world's name
15577 servers have all been upgraded, there should be no need for this option.
15578 Note that all lookups, including those done for verification, are affected;
15579 this will result in verify failure for IPv6 connections or ones using names
15580 only valid for IPv6 addresses.
15581
15582
15583 .option dns_retrans main time 0s
15584 .cindex "DNS" "resolver options"
15585 .cindex timeout "dns lookup"
15586 .cindex "DNS" timeout
15587 The options &%dns_retrans%& and &%dns_retry%& can be used to set the
15588 retransmission and retry parameters for DNS lookups. Values of zero (the
15589 defaults) leave the system default settings unchanged. The first value is the
15590 time between retries, and the second is the number of retries. It isn't
15591 totally clear exactly how these settings affect the total time a DNS lookup may
15592 take. I haven't found any documentation about timeouts on DNS lookups; these
15593 parameter values are available in the external resolver interface structure,
15594 but nowhere does it seem to describe how they are used or what you might want
15595 to set in them.
15596 See also the &%slow_lookup_log%& option.
15597
15598
15599 .option dns_retry main integer 0
15600 See &%dns_retrans%& above.
15601
15602
15603 .option dns_trust_aa main "domain list&!!" unset
15604 .cindex "DNS" "resolver options"
15605 .cindex "DNS" "DNSSEC"
15606 If this option is set then lookup results marked with the AA bit
15607 (Authoritative Answer) are trusted the same way as if they were
15608 DNSSEC-verified. The authority section's name of the answer must
15609 match with this expanded domain list.
15610
15611 Use this option only if you talk directly to a resolver that is
15612 authoritative for some zones and does not set the AD (Authentic Data)
15613 bit in the answer. Some DNS servers may have an configuration option to
15614 mark the answers from their own zones as verified (they set the AD bit).
15615 Others do not have this option. It is considered as poor practice using
15616 a resolver that is an authoritative server for some zones.
15617
15618 Use this option only if you really have to (e.g. if you want
15619 to use DANE for remote delivery to a server that is listed in the DNS
15620 zones that your resolver is authoritative for).
15621
15622 If the DNS answer packet has the AA bit set and contains resource record
15623 in the answer section, the name of the first NS record appearing in the
15624 authority section is compared against the list. If the answer packet is
15625 authoritative but the answer section is empty, the name of the first SOA
15626 record in the authoritative section is used instead.
15627
15628 .cindex "DNS" "resolver options"
15629 .option dns_use_edns0 main integer -1
15630 .cindex "DNS" "resolver options"
15631 .cindex "DNS" "EDNS0"
15632 .cindex "DNS" "OpenBSD
15633 If this option is set to a non-negative number then Exim will initialise the
15634 DNS resolver library to either use or not use EDNS0 extensions, overriding
15635 the system default. A value of 0 coerces EDNS0 off, a value of 1 coerces EDNS0
15636 on.
15637
15638 If the resolver library does not support EDNS0 then this option has no effect.
15639
15640 OpenBSD's asr resolver routines are known to ignore the EDNS0 option; this
15641 means that DNSSEC will not work with Exim on that platform either, unless Exim
15642 is linked against an alternative DNS client library.
15643
15644
15645 .option drop_cr main boolean false
15646 This is an obsolete option that is now a no-op. It used to affect the way Exim
15647 handled CR and LF characters in incoming messages. What happens now is
15648 described in section &<<SECTlineendings>>&.
15649
15650 .option dsn_advertise_hosts main "host list&!!" unset
15651 .cindex "bounce messages" "success"
15652 .cindex "DSN" "success"
15653 .cindex "Delivery Status Notification" "success"
15654 .cindex "ESMTP extensions" DSN
15655 DSN extensions (RFC3461) will be advertised in the EHLO message to,
15656 and accepted from, these hosts.
15657 Hosts may use the NOTIFY and ENVID options on RCPT TO commands,
15658 and RET and ORCPT options on MAIL FROM commands.
15659 A NOTIFY=SUCCESS option requests success-DSN messages.
15660 A NOTIFY= option with no argument requests that no delay or failure DSNs
15661 are sent.
15662 .new
15663 &*Note*&: Supplying success-DSN messages has been criticised
15664 on privacy grounds; it can leak details of internal forwarding.
15665 .wen
15666
15667 .option dsn_from main "string&!!" "see below"
15668 .cindex "&'From:'& header line" "in bounces"
15669 .cindex "bounce messages" "&'From:'& line, specifying"
15670 This option can be used to vary the contents of &'From:'& header lines in
15671 bounces and other automatically generated messages (&"Delivery Status
15672 Notifications"& &-- hence the name of the option). The default setting is:
15673 .code
15674 dsn_from = Mail Delivery System <Mailer-Daemon@$qualify_domain>
15675 .endd
15676 The value is expanded every time it is needed. If the expansion fails, a
15677 panic is logged, and the default value is used.
15678
15679 .option envelope_to_remove main boolean true
15680 .cindex "&'Envelope-to:'& header line"
15681 Exim's transports have an option for adding an &'Envelope-to:'& header to a
15682 message when it is delivered, in exactly the same way as &'Return-path:'& is
15683 handled. &'Envelope-to:'& records the original recipient address from the
15684 message's envelope that caused the delivery to happen. Such headers should not
15685 be present in incoming messages, and this option causes them to be removed at
15686 the time the message is received, to avoid any problems that might occur when a
15687 delivered message is subsequently sent on to some other recipient.
15688
15689
15690 .option errors_copy main "string list&!!" unset
15691 .cindex "bounce message" "copy to other address"
15692 .cindex "copy of bounce message"
15693 Setting this option causes Exim to send bcc copies of bounce messages that it
15694 generates to other addresses. &*Note*&: This does not apply to bounce messages
15695 coming from elsewhere. The value of the option is a colon-separated list of
15696 items. Each item consists of a pattern, terminated by white space, followed by
15697 a comma-separated list of email addresses. If a pattern contains spaces, it
15698 must be enclosed in double quotes.
15699
15700 Each pattern is processed in the same way as a single item in an address list
15701 (see section &<<SECTaddresslist>>&). When a pattern matches the recipient of
15702 the bounce message, the message is copied to the addresses on the list. The
15703 items are scanned in order, and once a matching one is found, no further items
15704 are examined. For example:
15705 .code
15706 errors_copy = spqr@mydomain   postmaster@mydomain.example :\
15707               rqps@mydomain   hostmaster@mydomain.example,\
15708                               postmaster@mydomain.example
15709 .endd
15710 .vindex "&$domain$&"
15711 .vindex "&$local_part$&"
15712 The address list is expanded before use. The expansion variables &$local_part$&
15713 and &$domain$& are set from the original recipient of the error message, and if
15714 there was any wildcard matching in the pattern, the expansion
15715 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%errors_copy%&"
15716 variables &$0$&, &$1$&, etc. are set in the normal way.
15717
15718
15719 .option errors_reply_to main string unset
15720 .cindex "bounce message" "&'Reply-to:'& in"
15721 By default, Exim's bounce and delivery warning messages contain the header line
15722 .display
15723 &`From: Mail Delivery System <Mailer-Daemon@`&&'qualify-domain'&&`>`&
15724 .endd
15725 .oindex &%quota_warn_message%&
15726 where &'qualify-domain'& is the value of the &%qualify_domain%& option.
15727 A warning message that is generated by the &%quota_warn_message%& option in an
15728 &(appendfile)& transport may contain its own &'From:'& header line that
15729 overrides the default.
15730
15731 Experience shows that people reply to bounce messages. If the
15732 &%errors_reply_to%& option is set, a &'Reply-To:'& header is added to bounce
15733 and warning messages. For example:
15734 .code
15735 errors_reply_to = postmaster@my.domain.example
15736 .endd
15737 The value of the option is not expanded. It must specify a valid RFC 2822
15738 address. However, if a warning message that is generated by the
15739 &%quota_warn_message%& option in an &(appendfile)& transport contain its
15740 own &'Reply-To:'& header line, the value of the &%errors_reply_to%& option is
15741 not used.
15742
15743
15744 .option event_action main string&!! unset
15745 .cindex events
15746 This option declares a string to be expanded for Exim's events mechanism.
15747 For details see chapter &<<CHAPevents>>&.
15748
15749
15750 .option exim_group main string "compile-time configured"
15751 .cindex "gid (group id)" "Exim's own"
15752 .cindex "Exim group"
15753 This option changes the gid under which Exim runs when it gives up root
15754 privilege. The default value is compiled into the binary. The value of this
15755 option is used only when &%exim_user%& is also set. Unless it consists entirely
15756 of digits, the string is looked up using &[getgrnam()]&, and failure causes a
15757 configuration error. See chapter &<<CHAPsecurity>>& for a discussion of
15758 security issues.
15759
15760
15761 .option exim_path main string "see below"
15762 .cindex "Exim binary, path name"
15763 This option specifies the path name of the Exim binary, which is used when Exim
15764 needs to re-exec itself. The default is set up to point to the file &'exim'& in
15765 the directory configured at compile time by the BIN_DIRECTORY setting. It
15766 is necessary to change &%exim_path%& if, exceptionally, Exim is run from some
15767 other place.
15768 &*Warning*&: Do not use a macro to define the value of this option, because
15769 you will break those Exim utilities that scan the configuration file to find
15770 where the binary is. (They then use the &%-bP%& option to extract option
15771 settings such as the value of &%spool_directory%&.)
15772
15773
15774 .option exim_user main string "compile-time configured"
15775 .cindex "uid (user id)" "Exim's own"
15776 .cindex "Exim user"
15777 This option changes the uid under which Exim runs when it gives up root
15778 privilege. The default value is compiled into the binary. Ownership of the run
15779 time configuration file and the use of the &%-C%& and &%-D%& command line
15780 options is checked against the values in the binary, not what is set here.
15781
15782 Unless it consists entirely of digits, the string is looked up using
15783 &[getpwnam()]&, and failure causes a configuration error. If &%exim_group%& is
15784 not also supplied, the gid is taken from the result of &[getpwnam()]& if it is
15785 used. See chapter &<<CHAPsecurity>>& for a discussion of security issues.
15786
15787
15788 .option exim_version main string "current version"
15789 .cindex "Exim version"
15790 .cindex customizing "version number"
15791 .cindex "version number of Exim" override
15792 This option overrides the &$version_number$&/&$exim_version$& that Exim reports in
15793 various places.  Use with care; this may fool stupid security scanners.
15794
15795
15796 .option extra_local_interfaces main "string list" unset
15797 This option defines network interfaces that are to be considered local when
15798 routing, but which are not used for listening by the daemon. See section
15799 &<<SECTreclocipadd>>& for details.
15800
15801
15802 . Allow this long option name to split; give it unsplit as a fifth argument
15803 . for the automatic .oindex that is generated by .option.
15804
15805 .option "extract_addresses_remove_arguments" main boolean true &&&
15806          extract_addresses_remove_arguments
15807 .oindex "&%-t%&"
15808 .cindex "command line" "addresses with &%-t%&"
15809 .cindex "Sendmail compatibility" "&%-t%& option"
15810 According to some Sendmail documentation (Sun, IRIX, HP-UX), if any addresses
15811 are present on the command line when the &%-t%& option is used to build an
15812 envelope from a message's &'To:'&, &'Cc:'& and &'Bcc:'& headers, the command
15813 line addresses are removed from the recipients list. This is also how Smail
15814 behaves. However, other Sendmail documentation (the O'Reilly book) states that
15815 command line addresses are added to those obtained from the header lines. When
15816 &%extract_addresses_remove_arguments%& is true (the default), Exim subtracts
15817 argument headers. If it is set false, Exim adds rather than removes argument
15818 addresses.
15819
15820
15821 .option finduser_retries main integer 0
15822 .cindex "NIS, retrying user lookups"
15823 On systems running NIS or other schemes in which user and group information is
15824 distributed from a remote system, there can be times when &[getpwnam()]& and
15825 related functions fail, even when given valid data, because things time out.
15826 Unfortunately these failures cannot be distinguished from genuine &"not found"&
15827 errors. If &%finduser_retries%& is set greater than zero, Exim will try that
15828 many extra times to find a user or a group, waiting for one second between
15829 retries.
15830
15831 .cindex "&_/etc/passwd_&" "multiple reading of"
15832 You should not set this option greater than zero if your user information is in
15833 a traditional &_/etc/passwd_& file, because it will cause Exim needlessly to
15834 search the file multiple times for non-existent users, and also cause delay.
15835
15836
15837
15838 .option freeze_tell main "string list, comma separated" unset
15839 .cindex "freezing messages" "sending a message when freezing"
15840 On encountering certain errors, or when configured to do so in a system filter,
15841 ACL, or special router, Exim freezes a message. This means that no further
15842 delivery attempts take place until an administrator thaws the message, or the
15843 &%auto_thaw%&, &%ignore_bounce_errors_after%&, or &%timeout_frozen_after%&
15844 feature cause it to be processed. If &%freeze_tell%& is set, Exim generates a
15845 warning message whenever it freezes something, unless the message it is
15846 freezing is a locally-generated bounce message. (Without this exception there
15847 is the possibility of looping.) The warning message is sent to the addresses
15848 supplied as the comma-separated value of this option. If several of the
15849 message's addresses cause freezing, only a single message is sent. If the
15850 freezing was automatic, the reason(s) for freezing can be found in the message
15851 log. If you configure freezing in a filter or ACL, you must arrange for any
15852 logging that you require.
15853
15854
15855 .option gecos_name main string&!! unset
15856 .cindex "HP-UX"
15857 .cindex "&""gecos""& field, parsing"
15858 Some operating systems, notably HP-UX, use the &"gecos"& field in the system
15859 password file to hold other information in addition to users' real names. Exim
15860 looks up this field for use when it is creating &'Sender:'& or &'From:'&
15861 headers. If either &%gecos_pattern%& or &%gecos_name%& are unset, the contents
15862 of the field are used unchanged, except that, if an ampersand is encountered,
15863 it is replaced by the user's login name with the first character forced to
15864 upper case, since this is a convention that is observed on many systems.
15865
15866 When these options are set, &%gecos_pattern%& is treated as a regular
15867 expression that is to be applied to the field (again with && replaced by the
15868 login name), and if it matches, &%gecos_name%& is expanded and used as the
15869 user's name.
15870
15871 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%gecos_name%&"
15872 Numeric variables such as &$1$&, &$2$&, etc. can be used in the expansion to
15873 pick up sub-fields that were matched by the pattern. In HP-UX, where the user's
15874 name terminates at the first comma, the following can be used:
15875 .code
15876 gecos_pattern = ([^,]*)
15877 gecos_name = $1
15878 .endd
15879
15880 .option gecos_pattern main string unset
15881 See &%gecos_name%& above.
15882
15883
15884 .option gnutls_compat_mode main boolean unset
15885 This option controls whether GnuTLS is used in compatibility mode in an Exim
15886 server. This reduces security slightly, but improves interworking with older
15887 implementations of TLS.
15888
15889
15890 .option gnutls_allow_auto_pkcs11 main boolean unset
15891 This option will let GnuTLS (2.12.0 or later) autoload PKCS11 modules with
15892 the p11-kit configuration files in &_/etc/pkcs11/modules/_&.
15893
15894 See
15895 &url(https://www.gnutls.org/manual/gnutls.html#Smart-cards-and-HSMs)
15896 for documentation.
15897
15898
15899
15900 .option headers_charset main string "see below"
15901 This option sets a default character set for translating from encoded MIME
15902 &"words"& in header lines, when referenced by an &$h_xxx$& expansion item. The
15903 default is the value of HEADERS_CHARSET in &_Local/Makefile_&. The
15904 ultimate default is ISO-8859-1. For more details see the description of header
15905 insertions in section &<<SECTexpansionitems>>&.
15906
15907
15908
15909 .option header_maxsize main integer "see below"
15910 .cindex "header section" "maximum size of"
15911 .cindex "limit" "size of message header section"
15912 This option controls the overall maximum size of a message's header
15913 section. The default is the value of HEADER_MAXSIZE in
15914 &_Local/Makefile_&; the default for that is 1M. Messages with larger header
15915 sections are rejected.
15916
15917
15918 .option header_line_maxsize main integer 0
15919 .cindex "header lines" "maximum size of"
15920 .cindex "limit" "size of one header line"
15921 This option limits the length of any individual header line in a message, after
15922 all the continuations have been joined together. Messages with individual
15923 header lines that are longer than the limit are rejected. The default value of
15924 zero means &"no limit"&.
15925
15926
15927
15928
15929 .option helo_accept_junk_hosts main "host list&!!" unset
15930 .cindex "HELO" "accepting junk data"
15931 .cindex "EHLO" "accepting junk data"
15932 Exim checks the syntax of HELO and EHLO commands for incoming SMTP
15933 mail, and gives an error response for invalid data. Unfortunately, there are
15934 some SMTP clients that send syntactic junk. They can be accommodated by setting
15935 this option. Note that this is a syntax check only. See &%helo_verify_hosts%&
15936 if you want to do semantic checking.
15937 See also &%helo_allow_chars%& for a way of extending the permitted character
15938 set.
15939
15940
15941 .option helo_allow_chars main string unset
15942 .cindex "HELO" "underscores in"
15943 .cindex "EHLO" "underscores in"
15944 .cindex "underscore in EHLO/HELO"
15945 This option can be set to a string of rogue characters that are permitted in
15946 all EHLO and HELO names in addition to the standard letters, digits,
15947 hyphens, and dots. If you really must allow underscores, you can set
15948 .code
15949 helo_allow_chars = _
15950 .endd
15951 Note that the value is one string, not a list.
15952
15953
15954 .option helo_lookup_domains main "domain list&!!" &`@:@[]`&
15955 .cindex "HELO" "forcing reverse lookup"
15956 .cindex "EHLO" "forcing reverse lookup"
15957 If the domain given by a client in a HELO or EHLO command matches this
15958 list, a reverse lookup is done in order to establish the host's true name. The
15959 default forces a lookup if the client host gives the server's name or any of
15960 its IP addresses (in brackets), something that broken clients have been seen to
15961 do.
15962
15963
15964 .option helo_try_verify_hosts main "host list&!!" unset
15965 .cindex "HELO verifying" "optional"
15966 .cindex "EHLO" "verifying, optional"
15967 By default, Exim just checks the syntax of HELO and EHLO commands (see
15968 &%helo_accept_junk_hosts%& and &%helo_allow_chars%&). However, some sites like
15969 to do more extensive checking of the data supplied by these commands. The ACL
15970 condition &`verify = helo`& is provided to make this possible.
15971 Formerly, it was necessary also to set this option (&%helo_try_verify_hosts%&)
15972 to force the check to occur. From release 4.53 onwards, this is no longer
15973 necessary. If the check has not been done before &`verify = helo`& is
15974 encountered, it is done at that time. Consequently, this option is obsolete.
15975 Its specification is retained here for backwards compatibility.
15976
15977 When an EHLO or HELO command is received, if the calling host matches
15978 &%helo_try_verify_hosts%&, Exim checks that the host name given in the HELO or
15979 EHLO command either:
15980
15981 .ilist
15982 is an IP literal matching the calling address of the host, or
15983 .next
15984 .cindex "DNS" "reverse lookup"
15985 .cindex "reverse DNS lookup"
15986 matches the host name that Exim obtains by doing a reverse lookup of the
15987 calling host address, or
15988 .next
15989 when looked up in DNS yields the calling host address.
15990 .endlist
15991
15992 However, the EHLO or HELO command is not rejected if any of the checks
15993 fail. Processing continues, but the result of the check is remembered, and can
15994 be detected later in an ACL by the &`verify = helo`& condition.
15995
15996 If DNS was used for successful verification, the variable
15997 .cindex "DNS" "DNSSEC"
15998 &$helo_verify_dnssec$& records the DNSSEC status of the lookups.
15999
16000 .option helo_verify_hosts main "host list&!!" unset
16001 .cindex "HELO verifying" "mandatory"
16002 .cindex "EHLO" "verifying, mandatory"
16003 Like &%helo_try_verify_hosts%&, this option is obsolete, and retained only for
16004 backwards compatibility. For hosts that match this option, Exim checks the host
16005 name given in the HELO or EHLO in the same way as for
16006 &%helo_try_verify_hosts%&. If the check fails, the HELO or EHLO command is
16007 rejected with a 550 error, and entries are written to the main and reject logs.
16008 If a MAIL command is received before EHLO or HELO, it is rejected with a 503
16009 error.
16010
16011 .option hold_domains main "domain list&!!" unset
16012 .cindex "domain" "delaying delivery"
16013 .cindex "delivery" "delaying certain domains"
16014 This option allows mail for particular domains to be held in the queue
16015 manually. The option is overridden if a message delivery is forced with the
16016 &%-M%&, &%-qf%&, &%-Rf%& or &%-Sf%& options, and also while testing or
16017 verifying addresses using &%-bt%& or &%-bv%&. Otherwise, if a domain matches an
16018 item in &%hold_domains%&, no routing or delivery for that address is done, and
16019 it is deferred every time the message is looked at.
16020
16021 This option is intended as a temporary operational measure for delaying the
16022 delivery of mail while some problem is being sorted out, or some new
16023 configuration tested. If you just want to delay the processing of some
16024 domains until a queue run occurs, you should use &%queue_domains%& or
16025 &%queue_smtp_domains%&, not &%hold_domains%&.
16026
16027 A setting of &%hold_domains%& does not override Exim's code for removing
16028 messages from the queue if they have been there longer than the longest retry
16029 time in any retry rule. If you want to hold messages for longer than the normal
16030 retry times, insert a dummy retry rule with a long retry time.
16031
16032
16033 .option host_lookup main "host list&!!" unset
16034 .cindex "host name" "lookup, forcing"
16035 Exim does not look up the name of a calling host from its IP address unless it
16036 is required to compare against some host list, or the host matches
16037 &%helo_try_verify_hosts%& or &%helo_verify_hosts%&, or the host matches this
16038 option (which normally contains IP addresses rather than host names). The
16039 default configuration file contains
16040 .code
16041 host_lookup = *
16042 .endd
16043 which causes a lookup to happen for all hosts. If the expense of these lookups
16044 is felt to be too great, the setting can be changed or removed.
16045
16046 After a successful reverse lookup, Exim does a forward lookup on the name it
16047 has obtained, to verify that it yields the IP address that it started with. If
16048 this check fails, Exim behaves as if the name lookup failed.
16049
16050 .vindex "&$host_lookup_failed$&"
16051 .vindex "&$sender_host_name$&"
16052 After any kind of failure, the host name (in &$sender_host_name$&) remains
16053 unset, and &$host_lookup_failed$& is set to the string &"1"&. See also
16054 &%dns_again_means_nonexist%&, &%helo_lookup_domains%&, and
16055 &`verify = reverse_host_lookup`& in ACLs.
16056
16057
16058 .option host_lookup_order main "string list" &`bydns:byaddr`&
16059 This option specifies the order of different lookup methods when Exim is trying
16060 to find a host name from an IP address. The default is to do a DNS lookup
16061 first, and then to try a local lookup (using &[gethostbyaddr()]& or equivalent)
16062 if that fails. You can change the order of these lookups, or omit one entirely,
16063 if you want.
16064
16065 &*Warning*&: The &"byaddr"& method does not always yield aliases when there are
16066 multiple PTR records in the DNS and the IP address is not listed in
16067 &_/etc/hosts_&. Different operating systems give different results in this
16068 case. That is why the default tries a DNS lookup first.
16069
16070
16071
16072 .option host_reject_connection main "host list&!!" unset
16073 .cindex "host" "rejecting connections from"
16074 If this option is set, incoming SMTP calls from the hosts listed are rejected
16075 as soon as the connection is made.
16076 This option is obsolete, and retained only for backward compatibility, because
16077 nowadays the ACL specified by &%acl_smtp_connect%& can also reject incoming
16078 connections immediately.
16079
16080 The ability to give an immediate rejection (either by this option or using an
16081 ACL) is provided for use in unusual cases. Many hosts will just try again,
16082 sometimes without much delay. Normally, it is better to use an ACL to reject
16083 incoming messages at a later stage, such as after RCPT commands. See
16084 chapter &<<CHAPACL>>&.
16085
16086
16087 .option hosts_connection_nolog main "host list&!!" unset
16088 .cindex "host" "not logging connections from"
16089 This option defines a list of hosts for which connection logging does not
16090 happen, even though the &%smtp_connection%& log selector is set. For example,
16091 you might want not to log SMTP connections from local processes, or from
16092 127.0.0.1, or from your local LAN. This option is consulted in the main loop of
16093 the daemon; you should therefore strive to restrict its value to a short inline
16094 list of IP addresses and networks. To disable logging SMTP connections from
16095 local processes, you must create a host list with an empty item. For example:
16096 .code
16097 hosts_connection_nolog = :
16098 .endd
16099 If the &%smtp_connection%& log selector is not set, this option has no effect.
16100
16101
16102
16103 .option hosts_proxy main "host list&!!" unset
16104 .cindex proxy "proxy protocol"
16105 This option enables use of Proxy Protocol proxies for incoming
16106 connections.  For details see section &<<SECTproxyInbound>>&.
16107
16108
16109 .option hosts_treat_as_local main "domain list&!!" unset
16110 .cindex "local host" "domains treated as"
16111 .cindex "host" "treated as local"
16112 If this option is set, any host names that match the domain list are treated as
16113 if they were the local host when Exim is scanning host lists obtained from MX
16114 records
16115 or other sources. Note that the value of this option is a domain list, not a
16116 host list, because it is always used to check host names, not IP addresses.
16117
16118 This option also applies when Exim is matching the special items
16119 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`& in a domain list (see
16120 section &<<SECTdomainlist>>&), and when checking the &%hosts%& option in the
16121 &(smtp)& transport for the local host (see the &%allow_localhost%& option in
16122 that transport). See also &%local_interfaces%&, &%extra_local_interfaces%&, and
16123 chapter &<<CHAPinterfaces>>&, which contains a discussion about local network
16124 interfaces and recognizing the local host.
16125
16126
16127 .option ibase_servers main "string list" unset
16128 .cindex "InterBase" "server list"
16129 This option provides a list of InterBase servers and associated connection data,
16130 to be used in conjunction with &(ibase)& lookups (see section &<<SECID72>>&).
16131 The option is available only if Exim has been built with InterBase support.
16132
16133
16134
16135 .option ignore_bounce_errors_after main time 10w
16136 .cindex "bounce message" "discarding"
16137 .cindex "discarding bounce message"
16138 This option affects the processing of bounce messages that cannot be delivered,
16139 that is, those that suffer a permanent delivery failure. (Bounce messages that
16140 suffer temporary delivery failures are of course retried in the usual way.)
16141
16142 After a permanent delivery failure, bounce messages are frozen,
16143 because there is no sender to whom they can be returned. When a frozen bounce
16144 message has been in the queue for more than the given time, it is unfrozen at
16145 the next queue run, and a further delivery is attempted. If delivery fails
16146 again, the bounce message is discarded. This makes it possible to keep failed
16147 bounce messages around for a shorter time than the normal maximum retry time
16148 for frozen messages. For example,
16149 .code
16150 ignore_bounce_errors_after = 12h
16151 .endd
16152 retries failed bounce message deliveries after 12 hours, discarding any further
16153 failures. If the value of this option is set to a zero time period, bounce
16154 failures are discarded immediately. Setting a very long time (as in the default
16155 value) has the effect of disabling this option. For ways of automatically
16156 dealing with other kinds of frozen message, see &%auto_thaw%& and
16157 &%timeout_frozen_after%&.
16158
16159
16160 .option ignore_fromline_hosts main "host list&!!" unset
16161 .cindex "&""From""& line"
16162 .cindex "UUCP" "&""From""& line"
16163 Some broken SMTP clients insist on sending a UUCP-like &"From&~"& line before
16164 the headers of a message. By default this is treated as the start of the
16165 message's body, which means that any following headers are not recognized as
16166 such. Exim can be made to ignore it by setting &%ignore_fromline_hosts%& to
16167 match those hosts that insist on sending it. If the sender is actually a local
16168 process rather than a remote host, and is using &%-bs%& to inject the messages,
16169 &%ignore_fromline_local%& must be set to achieve this effect.
16170
16171
16172 .option ignore_fromline_local main boolean false
16173 See &%ignore_fromline_hosts%& above.
16174
16175 .option keep_environment main "string list" unset
16176 .cindex "environment" "values from"
16177 This option contains a string list of environment variables to keep.
16178 You have to trust these variables or you have to be sure that
16179 these variables do not impose any security risk. Keep in mind that
16180 during the startup phase Exim is running with an effective UID 0 in most
16181 installations. As the default value is an empty list, the default
16182 environment for using libraries, running embedded Perl code, or running
16183 external binaries is empty, and does not not even contain PATH or HOME.
16184
16185 Actually the list is interpreted as a list of patterns
16186 (&<<SECTlistexpand>>&), except that it is not expanded first.
16187
16188 WARNING: Macro substitution is still done first, so having a macro
16189 FOO and having FOO_HOME in your &%keep_environment%& option may have
16190 unexpected results. You may work around this using a regular expression
16191 that does not match the macro name: ^[F]OO_HOME$.
16192
16193 Current versions of Exim issue a warning during startup if you do not mention
16194 &%keep_environment%& in your runtime configuration file and if your
16195 current environment is not empty. Future versions may not issue that warning
16196 anymore.
16197
16198 See the &%add_environment%& main config option for a way to set
16199 environment variables to a fixed value.  The environment for &(pipe)&
16200 transports is handled separately, see section &<<SECTpipeenv>>& for
16201 details.
16202
16203
16204 .option keep_malformed main time 4d
16205 This option specifies the length of time to keep messages whose spool files
16206 have been corrupted in some way. This should, of course, never happen. At the
16207 next attempt to deliver such a message, it gets removed. The incident is
16208 logged.
16209
16210
16211 .option ldap_ca_cert_dir main string unset
16212 .cindex "LDAP", "TLS CA certificate directory"
16213 .cindex certificate "directory for LDAP"
16214 This option indicates which directory contains CA certificates for verifying
16215 a TLS certificate presented by an LDAP server.
16216 While Exim does not provide a default value, your SSL library may.
16217 Analogous to &%tls_verify_certificates%& but as a client-side option for LDAP
16218 and constrained to be a directory.
16219
16220
16221 .option ldap_ca_cert_file main string unset
16222 .cindex "LDAP", "TLS CA certificate file"
16223 .cindex certificate "file for LDAP"
16224 This option indicates which file contains CA certificates for verifying
16225 a TLS certificate presented by an LDAP server.
16226 While Exim does not provide a default value, your SSL library may.
16227 Analogous to &%tls_verify_certificates%& but as a client-side option for LDAP
16228 and constrained to be a file.
16229
16230
16231 .option ldap_cert_file main string unset
16232 .cindex "LDAP" "TLS client certificate file"
16233 .cindex certificate "file for LDAP"
16234 This option indicates which file contains an TLS client certificate which
16235 Exim should present to the LDAP server during TLS negotiation.
16236 Should be used together with &%ldap_cert_key%&.
16237
16238
16239 .option ldap_cert_key main string unset
16240 .cindex "LDAP" "TLS client key file"
16241 .cindex certificate "key for LDAP"
16242 This option indicates which file contains the secret/private key to use
16243 to prove identity to the LDAP server during TLS negotiation.
16244 Should be used together with &%ldap_cert_file%&, which contains the
16245 identity to be proven.
16246
16247
16248 .option ldap_cipher_suite main string unset
16249 .cindex "LDAP" "TLS cipher suite"
16250 This controls the TLS cipher-suite negotiation during TLS negotiation with
16251 the LDAP server.  See &<<SECTreqciphssl>>& for more details of the format of
16252 cipher-suite options with OpenSSL (as used by LDAP client libraries).
16253
16254
16255 .option ldap_default_servers main "string list" unset
16256 .cindex "LDAP" "default servers"
16257 This option provides a list of LDAP servers which are tried in turn when an
16258 LDAP query does not contain a server. See section &<<SECTforldaque>>& for
16259 details of LDAP queries. This option is available only when Exim has been built
16260 with LDAP support.
16261
16262
16263 .option ldap_require_cert main string unset.
16264 .cindex "LDAP" "policy for LDAP server TLS cert presentation"
16265 This should be one of the values "hard", "demand", "allow", "try" or "never".
16266 A value other than one of these is interpreted as "never".
16267 See the entry "TLS_REQCERT" in your system man page for ldap.conf(5).
16268 Although Exim does not set a default, the LDAP library probably defaults
16269 to hard/demand.
16270
16271
16272 .option ldap_start_tls main boolean false
16273 .cindex "LDAP" "whether or not to negotiate TLS"
16274 If set, Exim will attempt to negotiate TLS with the LDAP server when
16275 connecting on a regular LDAP port.  This is the LDAP equivalent of SMTP's
16276 "STARTTLS".  This is distinct from using "ldaps", which is the LDAP form
16277 of SSL-on-connect.
16278 In the event of failure to negotiate TLS, the action taken is controlled
16279 by &%ldap_require_cert%&.
16280 This option is ignored for &`ldapi`& connections.
16281
16282
16283 .option ldap_version main integer unset
16284 .cindex "LDAP" "protocol version, forcing"
16285 This option can be used to force Exim to set a specific protocol version for
16286 LDAP. If it option is unset, it is shown by the &%-bP%& command line option as
16287 -1. When this is the case, the default is 3 if LDAP_VERSION3 is defined in
16288 the LDAP headers; otherwise it is 2. This option is available only when Exim
16289 has been built with LDAP support.
16290
16291
16292
16293 .option local_from_check main boolean true
16294 .cindex "&'Sender:'& header line" "disabling addition of"
16295 .cindex "&'From:'& header line" "disabling checking of"
16296 When a message is submitted locally (that is, not over a TCP/IP connection) by
16297 an untrusted user, Exim removes any existing &'Sender:'& header line, and
16298 checks that the &'From:'& header line matches the login of the calling user and
16299 the domain specified by &%qualify_domain%&.
16300
16301 &*Note*&: An unqualified address (no domain) in the &'From:'& header in a
16302 locally submitted message is automatically qualified by Exim, unless the
16303 &%-bnq%& command line option is used.
16304
16305 You can use &%local_from_prefix%& and &%local_from_suffix%& to permit affixes
16306 on the local part. If the &'From:'& header line does not match, Exim adds a
16307 &'Sender:'& header with an address constructed from the calling user's login
16308 and the default qualify domain.
16309
16310 If &%local_from_check%& is set false, the &'From:'& header check is disabled,
16311 and no &'Sender:'& header is ever added. If, in addition, you want to retain
16312 &'Sender:'& header lines supplied by untrusted users, you must also set
16313 &%local_sender_retain%& to be true.
16314
16315 .cindex "envelope from"
16316 .cindex "envelope sender"
16317 These options affect only the header lines in the message. The envelope sender
16318 is still forced to be the login id at the qualify domain unless
16319 &%untrusted_set_sender%& permits the user to supply an envelope sender.
16320
16321 For messages received over TCP/IP, an ACL can specify &"submission mode"& to
16322 request similar header line checking. See section &<<SECTthesenhea>>&, which
16323 has more details about &'Sender:'& processing.
16324
16325
16326
16327
16328 .option local_from_prefix main string unset
16329 When Exim checks the &'From:'& header line of locally submitted messages for
16330 matching the login id (see &%local_from_check%& above), it can be configured to
16331 ignore certain prefixes and suffixes in the local part of the address. This is
16332 done by setting &%local_from_prefix%& and/or &%local_from_suffix%& to
16333 appropriate lists, in the same form as the &%local_part_prefix%& and
16334 &%local_part_suffix%& router options (see chapter &<<CHAProutergeneric>>&). For
16335 example, if
16336 .code
16337 local_from_prefix = *-
16338 .endd
16339 is set, a &'From:'& line containing
16340 .code
16341 From: anything-user@your.domain.example
16342 .endd
16343 will not cause a &'Sender:'& header to be added if &'user@your.domain.example'&
16344 matches the actual sender address that is constructed from the login name and
16345 qualify domain.
16346
16347
16348 .option local_from_suffix main string unset
16349 See &%local_from_prefix%& above.
16350
16351
16352 .option local_interfaces main "string list" "see below"
16353 This option controls which network interfaces are used by the daemon for
16354 listening; they are also used to identify the local host when routing. Chapter
16355 &<<CHAPinterfaces>>& contains a full description of this option and the related
16356 options &%daemon_smtp_ports%&, &%extra_local_interfaces%&,
16357 &%hosts_treat_as_local%&, and &%tls_on_connect_ports%&. The default value for
16358 &%local_interfaces%& is
16359 .code
16360 local_interfaces = 0.0.0.0
16361 .endd
16362 when Exim is built without IPv6 support; otherwise it is
16363 .code
16364 local_interfaces = <; ::0 ; 0.0.0.0
16365 .endd
16366
16367 .option local_scan_timeout main time 5m
16368 .cindex "timeout" "for &[local_scan()]& function"
16369 .cindex "&[local_scan()]& function" "timeout"
16370 This timeout applies to the &[local_scan()]& function (see chapter
16371 &<<CHAPlocalscan>>&). Zero means &"no timeout"&. If the timeout is exceeded,
16372 the incoming message is rejected with a temporary error if it is an SMTP
16373 message. For a non-SMTP message, the message is dropped and Exim ends with a
16374 non-zero code. The incident is logged on the main and reject logs.
16375
16376
16377
16378 .option local_sender_retain main boolean false
16379 .cindex "&'Sender:'& header line" "retaining from local submission"
16380 When a message is submitted locally (that is, not over a TCP/IP connection) by
16381 an untrusted user, Exim removes any existing &'Sender:'& header line. If you
16382 do not want this to happen, you must set &%local_sender_retain%&, and you must
16383 also set &%local_from_check%& to be false (Exim will complain if you do not).
16384 See also the ACL modifier &`control = suppress_local_fixups`&. Section
16385 &<<SECTthesenhea>>& has more details about &'Sender:'& processing.
16386
16387
16388
16389
16390 .option localhost_number main string&!! unset
16391 .cindex "host" "locally unique number for"
16392 .cindex "message ids" "with multiple hosts"
16393 .vindex "&$localhost_number$&"
16394 Exim's message ids are normally unique only within the local host. If
16395 uniqueness among a set of hosts is required, each host must set a different
16396 value for the &%localhost_number%& option. The string is expanded immediately
16397 after reading the configuration file (so that a number can be computed from the
16398 host name, for example) and the result of the expansion must be a number in the
16399 range 0&--16 (or 0&--10 on operating systems with case-insensitive file
16400 systems). This is available in subsequent string expansions via the variable
16401 &$localhost_number$&. When &%localhost_number is set%&, the final two
16402 characters of the message id, instead of just being a fractional part of the
16403 time, are computed from the time and the local host number as described in
16404 section &<<SECTmessiden>>&.
16405
16406
16407
16408 .option log_file_path main "string list&!!" "set at compile time"
16409 .cindex "log" "file path for"
16410 This option sets the path which is used to determine the names of Exim's log
16411 files, or indicates that logging is to be to syslog, or both. It is expanded
16412 when Exim is entered, so it can, for example, contain a reference to the host
16413 name. If no specific path is set for the log files at compile or runtime,
16414 or if the option is unset at runtime (i.e.  &`log_file_path = `&)
16415 they are written in a sub-directory called &_log_& in Exim's spool directory.
16416 A path must start with a slash.
16417 To send to syslog, use the word &"syslog"&.
16418 Chapter &<<CHAPlog>>& contains further details about Exim's logging, and
16419 section &<<SECTwhelogwri>>& describes how the contents of &%log_file_path%& are
16420 used. If this string is fixed at your installation (contains no expansion
16421 variables) it is recommended that you do not set this option in the
16422 configuration file, but instead supply the path using LOG_FILE_PATH in
16423 &_Local/Makefile_& so that it is available to Exim for logging errors detected
16424 early on &-- in particular, failure to read the configuration file.
16425
16426
16427 .option log_selector main string unset
16428 .cindex "log" "selectors"
16429 This option can be used to reduce or increase the number of things that Exim
16430 writes to its log files. Its argument is made up of names preceded by plus or
16431 minus characters. For example:
16432 .code
16433 log_selector = +arguments -retry_defer
16434 .endd
16435 A list of possible names and what they control is given in the chapter on
16436 logging, in section &<<SECTlogselector>>&.
16437
16438
16439 .option log_timezone main boolean false
16440 .cindex "log" "timezone for entries"
16441 .vindex "&$tod_log$&"
16442 .vindex "&$tod_zone$&"
16443 By default, the timestamps on log lines are in local time without the
16444 timezone. This means that if your timezone changes twice a year, the timestamps
16445 in log lines are ambiguous for an hour when the clocks go back. One way of
16446 avoiding this problem is to set the timezone to UTC. An alternative is to set
16447 &%log_timezone%& true. This turns on the addition of the timezone offset to
16448 timestamps in log lines. Turning on this option can add quite a lot to the size
16449 of log files because each line is extended by 6 characters. Note that the
16450 &$tod_log$& variable contains the log timestamp without the zone, but there is
16451 another variable called &$tod_zone$& that contains just the timezone offset.
16452
16453
16454 .option lookup_open_max main integer 25
16455 .cindex "too many open files"
16456 .cindex "open files, too many"
16457 .cindex "file" "too many open"
16458 .cindex "lookup" "maximum open files"
16459 .cindex "limit" "open files for lookups"
16460 This option limits the number of simultaneously open files for single-key
16461 lookups that use regular files (that is, &(lsearch)&, &(dbm)&, and &(cdb)&).
16462 Exim normally keeps these files open during routing, because often the same
16463 file is required several times. If the limit is reached, Exim closes the least
16464 recently used file. Note that if you are using the &'ndbm'& library, it
16465 actually opens two files for each logical DBM database, though it still counts
16466 as one for the purposes of &%lookup_open_max%&. If you are getting &"too many
16467 open files"& errors with NDBM, you need to reduce the value of
16468 &%lookup_open_max%&.
16469
16470
16471 .option max_username_length main integer 0
16472 .cindex "length of login name"
16473 .cindex "user name" "maximum length"
16474 .cindex "limit" "user name length"
16475 Some operating systems are broken in that they truncate long arguments to
16476 &[getpwnam()]& to eight characters, instead of returning &"no such user"&. If
16477 this option is set greater than zero, any attempt to call &[getpwnam()]& with
16478 an argument that is longer behaves as if &[getpwnam()]& failed.
16479
16480
16481 .option message_body_newlines main bool false
16482 .cindex "message body" "newlines in variables"
16483 .cindex "newline" "in message body variables"
16484 .vindex "&$message_body$&"
16485 .vindex "&$message_body_end$&"
16486 By default, newlines in the message body are replaced by spaces when setting
16487 the &$message_body$& and &$message_body_end$& expansion variables. If this
16488 option is set true, this no longer happens.
16489
16490
16491 .option message_body_visible main integer 500
16492 .cindex "body of message" "visible size"
16493 .cindex "message body" "visible size"
16494 .vindex "&$message_body$&"
16495 .vindex "&$message_body_end$&"
16496 This option specifies how much of a message's body is to be included in the
16497 &$message_body$& and &$message_body_end$& expansion variables.
16498
16499
16500 .option message_id_header_domain main string&!! unset
16501 .cindex "&'Message-ID:'& header line"
16502 If this option is set, the string is expanded and used as the right hand side
16503 (domain) of the &'Message-ID:'& header that Exim creates if a
16504 locally-originated incoming message does not have one. &"Locally-originated"&
16505 means &"not received over TCP/IP."&
16506 Otherwise, the primary host name is used.
16507 Only letters, digits, dot and hyphen are accepted; any other characters are
16508 replaced by hyphens. If the expansion is forced to fail, or if the result is an
16509 empty string, the option is ignored.
16510
16511
16512 .option message_id_header_text main string&!! unset
16513 If this variable is set, the string is expanded and used to augment the text of
16514 the &'Message-id:'& header that Exim creates if a locally-originated incoming
16515 message does not have one. The text of this header is required by RFC 2822 to
16516 take the form of an address. By default, Exim uses its internal message id as
16517 the local part, and the primary host name as the domain. If this option is set,
16518 it is expanded, and provided the expansion is not forced to fail, and does not
16519 yield an empty string, the result is inserted into the header immediately
16520 before the @, separated from the internal message id by a dot. Any characters
16521 that are illegal in an address are automatically converted into hyphens. This
16522 means that variables such as &$tod_log$& can be used, because the spaces and
16523 colons will become hyphens.
16524
16525
16526 .option message_logs main boolean true
16527 .cindex "message logs" "disabling"
16528 .cindex "log" "message log; disabling"
16529 If this option is turned off, per-message log files are not created in the
16530 &_msglog_& spool sub-directory. This reduces the amount of disk I/O required by
16531 Exim, by reducing the number of files involved in handling a message from a
16532 minimum of four (header spool file, body spool file, delivery journal, and
16533 per-message log) to three. The other major I/O activity is Exim's main log,
16534 which is not affected by this option.
16535
16536
16537 .option message_size_limit main string&!! 50M
16538 .cindex "message" "size limit"
16539 .cindex "limit" "message size"
16540 .cindex "size" "of message, limit"
16541 This option limits the maximum size of message that Exim will process. The
16542 value is expanded for each incoming connection so, for example, it can be made
16543 to depend on the IP address of the remote host for messages arriving via
16544 TCP/IP. After expansion, the value must be a sequence of decimal digits,
16545 optionally followed by K or M.
16546
16547 .cindex "SIZE" "ESMTP extension, advertising"
16548 .cindex "ESMTP extensions" SIZE
16549 If nonzero the value will be advertised as a parameter to the ESMTP SIZE
16550 service extension keyword.
16551
16552 &*Note*&: This limit cannot be made to depend on a message's sender or any
16553 other properties of an individual message, because it has to be advertised in
16554 the server's response to EHLO. String expansion failure causes a temporary
16555 error. A value of zero means no limit, but its use is not recommended. See also
16556 &%bounce_return_size_limit%&.
16557
16558 Incoming SMTP messages are failed with a 552 error if the limit is
16559 exceeded; locally-generated messages either get a stderr message or a delivery
16560 failure message to the sender, depending on the &%-oe%& setting. Rejection of
16561 an oversized message is logged in both the main and the reject logs. See also
16562 the generic transport option &%message_size_limit%&, which limits the size of
16563 message that an individual transport can process.
16564
16565 If you use a virus-scanner and set this option to to a value larger than the
16566 maximum size that your virus-scanner is configured to support, you may get
16567 failures triggered by large mails.  The right size to configure for the
16568 virus-scanner depends upon what data is passed and the options in use but it's
16569 probably safest to just set it to a little larger than this value.  E.g., with a
16570 default Exim message size of 50M and a default ClamAV StreamMaxLength of 10M,
16571 some problems may result.
16572
16573 A value of 0 will disable size limit checking; Exim will still advertise the
16574 SIZE extension in an EHLO response, but without a limit, so as to permit
16575 SMTP clients to still indicate the message size along with the MAIL verb.
16576
16577
16578 .option move_frozen_messages main boolean false
16579 .cindex "frozen messages" "moving"
16580 This option, which is available only if Exim has been built with the setting
16581 .code
16582 SUPPORT_MOVE_FROZEN_MESSAGES=yes
16583 .endd
16584 in &_Local/Makefile_&, causes frozen messages and their message logs to be
16585 moved from the &_input_& and &_msglog_& directories on the spool to &_Finput_&
16586 and &_Fmsglog_&, respectively. There is currently no support in Exim or the
16587 standard utilities for handling such moved messages, and they do not show up in
16588 lists generated by &%-bp%& or by the Exim monitor.
16589
16590
16591 .option mua_wrapper main boolean false
16592 Setting this option true causes Exim to run in a very restrictive mode in which
16593 it passes messages synchronously to a smart host. Chapter &<<CHAPnonqueueing>>&
16594 contains a full description of this facility.
16595
16596
16597
16598 .option mysql_servers main "string list" unset
16599 .cindex "MySQL" "server list"
16600 This option provides a list of MySQL servers and associated connection data, to
16601 be used in conjunction with &(mysql)& lookups (see section &<<SECID72>>&). The
16602 option is available only if Exim has been built with MySQL support.
16603
16604
16605 .option never_users main "string list&!!" unset
16606 This option is expanded just once, at the start of Exim's processing. Local
16607 message deliveries are normally run in processes that are setuid to the
16608 recipient, and remote deliveries are normally run under Exim's own uid and gid.
16609 It is usually desirable to prevent any deliveries from running as root, as a
16610 safety precaution.
16611
16612 When Exim is built, an option called FIXED_NEVER_USERS can be set to a
16613 list of users that must not be used for local deliveries. This list is fixed in
16614 the binary and cannot be overridden by the configuration file. By default, it
16615 contains just the single user name &"root"&. The &%never_users%& runtime option
16616 can be used to add more users to the fixed list.
16617
16618 If a message is to be delivered as one of the users on the fixed list or the
16619 &%never_users%& list, an error occurs, and delivery is deferred. A common
16620 example is
16621 .code
16622 never_users = root:daemon:bin
16623 .endd
16624 Including root is redundant if it is also on the fixed list, but it does no
16625 harm. This option overrides the &%pipe_as_creator%& option of the &(pipe)&
16626 transport driver.
16627
16628
16629 .new
16630 .option notifier_socket main string "$spool_directory/exim_daemon_notify"
16631 This option gives the name for a unix-domain socket on which the daemon
16632 listens for work and information-requests.
16633 Only installations running multiple daemons sharing a spool directory
16634 should need to modify the default.
16635
16636 The option is expanded before use.
16637 If the platform supports Linux-style abstract socket names, the result
16638 is used with a nul byte prefixed.
16639 Otherwise, it should be a full path name and use a directory accessible
16640 to Exim.
16641
16642 If the Exim command line uses a &%-oX%& option and does not use &%-oP%&
16643 then a notifier socket is not created.
16644 .wen
16645
16646
16647 .option openssl_options main "string list" "+no_sslv2 +no_sslv3 +single_dh_use +no_ticket +no_renegotiation"
16648 .cindex "OpenSSL "compatibility options"
16649 This option allows an administrator to adjust the SSL options applied
16650 by OpenSSL to connections.  It is given as a space-separated list of items,
16651 each one to be +added or -subtracted from the current value.
16652
16653 This option is only available if Exim is built against OpenSSL.  The values
16654 available for this option vary according to the age of your OpenSSL install.
16655 The &"all"& value controls a subset of flags which are available, typically
16656 the bug workaround options.  The &'SSL_CTX_set_options'& man page will
16657 list the values known on your system and Exim should support all the
16658 &"bug workaround"& options and many of the &"modifying"& options.  The Exim
16659 names lose the leading &"SSL_OP_"& and are lower-cased.
16660
16661 Note that adjusting the options can have severe impact upon the security of
16662 SSL as used by Exim.  It is possible to disable safety checks and shoot
16663 yourself in the foot in various unpleasant ways.  This option should not be
16664 adjusted lightly.  An unrecognised item will be detected at startup, by
16665 invoking Exim with the &%-bV%& flag.
16666
16667 The option affects Exim operating both as a server and as a client.
16668
16669 Historical note: prior to release 4.80, Exim defaulted this value to
16670 "+dont_insert_empty_fragments", which may still be needed for compatibility
16671 with some clients, but which lowers security by increasing exposure to
16672 some now infamous attacks.
16673
16674 Examples:
16675 .code
16676 # Make both old MS and old Eudora happy:
16677 openssl_options = -all +microsoft_big_sslv3_buffer \
16678                        +dont_insert_empty_fragments
16679
16680 # Disable older protocol versions:
16681 openssl_options = +no_sslv2 +no_sslv3
16682 .endd
16683
16684 Possible options may include:
16685 .ilist
16686 &`all`&
16687 .next
16688 &`allow_unsafe_legacy_renegotiation`&
16689 .next
16690 &`cipher_server_preference`&
16691 .next
16692 &`dont_insert_empty_fragments`&
16693 .next
16694 &`ephemeral_rsa`&
16695 .next
16696 &`legacy_server_connect`&
16697 .next
16698 &`microsoft_big_sslv3_buffer`&
16699 .next
16700 &`microsoft_sess_id_bug`&
16701 .next
16702 &`msie_sslv2_rsa_padding`&
16703 .next
16704 &`netscape_challenge_bug`&
16705 .next
16706 &`netscape_reuse_cipher_change_bug`&
16707 .next
16708 &`no_compression`&
16709 .next
16710 &`no_session_resumption_on_renegotiation`&
16711 .next
16712 &`no_sslv2`&
16713 .next
16714 &`no_sslv3`&
16715 .next
16716 &`no_ticket`&
16717 .next
16718 &`no_tlsv1`&
16719 .next
16720 &`no_tlsv1_1`&
16721 .next
16722 &`no_tlsv1_2`&
16723 .next
16724 &`safari_ecdhe_ecdsa_bug`&
16725 .next
16726 &`single_dh_use`&
16727 .next
16728 &`single_ecdh_use`&
16729 .next
16730 &`ssleay_080_client_dh_bug`&
16731 .next
16732 &`sslref2_reuse_cert_type_bug`&
16733 .next
16734 &`tls_block_padding_bug`&
16735 .next
16736 &`tls_d5_bug`&
16737 .next
16738 &`tls_rollback_bug`&
16739 .endlist
16740
16741 As an aside, the &`safari_ecdhe_ecdsa_bug`& item is a misnomer and affects
16742 all clients connecting using the MacOS SecureTransport TLS facility prior
16743 to MacOS 10.8.4, including email clients.  If you see old MacOS clients failing
16744 to negotiate TLS then this option value might help, provided that your OpenSSL
16745 release is new enough to contain this work-around.  This may be a situation
16746 where you have to upgrade OpenSSL to get buggy clients working.
16747
16748
16749 .option oracle_servers main "string list" unset
16750 .cindex "Oracle" "server list"
16751 This option provides a list of Oracle servers and associated connection data,
16752 to be used in conjunction with &(oracle)& lookups (see section &<<SECID72>>&).
16753 The option is available only if Exim has been built with Oracle support.
16754
16755
16756 .option percent_hack_domains main "domain list&!!" unset
16757 .cindex "&""percent hack""&"
16758 .cindex "source routing" "in email address"
16759 .cindex "address" "source-routed"
16760 The &"percent hack"& is the convention whereby a local part containing a
16761 percent sign is re-interpreted as a new email address, with the percent
16762 replaced by @. This is sometimes called &"source routing"&, though that term is
16763 also applied to RFC 2822 addresses that begin with an @ character. If this
16764 option is set, Exim implements the percent facility for those domains listed,
16765 but no others. This happens before an incoming SMTP address is tested against
16766 an ACL.
16767
16768 &*Warning*&: The &"percent hack"& has often been abused by people who are
16769 trying to get round relaying restrictions. For this reason, it is best avoided
16770 if at all possible. Unfortunately, a number of less security-conscious MTAs
16771 implement it unconditionally. If you are running Exim on a gateway host, and
16772 routing mail through to internal MTAs without processing the local parts, it is
16773 a good idea to reject recipient addresses with percent characters in their
16774 local parts. Exim's default configuration does this.
16775
16776
16777 .option perl_at_start main boolean false
16778 .cindex "Perl"
16779 This option is available only when Exim is built with an embedded Perl
16780 interpreter. See chapter &<<CHAPperl>>& for details of its use.
16781
16782
16783 .option perl_startup main string unset
16784 .cindex "Perl"
16785 This option is available only when Exim is built with an embedded Perl
16786 interpreter. See chapter &<<CHAPperl>>& for details of its use.
16787
16788 .option perl_taintmode main boolean false
16789 .cindex "Perl"
16790 This option enables the taint mode of the embedded Perl interpreter.
16791
16792
16793 .option pgsql_servers main "string list" unset
16794 .cindex "PostgreSQL lookup type" "server list"
16795 This option provides a list of PostgreSQL servers and associated connection
16796 data, to be used in conjunction with &(pgsql)& lookups (see section
16797 &<<SECID72>>&). The option is available only if Exim has been built with
16798 PostgreSQL support.
16799
16800
16801 .option pid_file_path main string&!! "set at compile time"
16802 .cindex "daemon" "pid file path"
16803 .cindex "pid file, path for"
16804 This option sets the name of the file to which the Exim daemon writes its
16805 process id. The string is expanded, so it can contain, for example, references
16806 to the host name:
16807 .code
16808 pid_file_path = /var/log/$primary_hostname/exim.pid
16809 .endd
16810 If no path is set, the pid is written to the file &_exim-daemon.pid_& in Exim's
16811 spool directory.
16812 The value set by the option can be overridden by the &%-oP%& command line
16813 option. A pid file is not written if a &"non-standard"& daemon is run by means
16814 of the &%-oX%& option, unless a path is explicitly supplied by &%-oP%&.
16815
16816
16817 .option pipelining_advertise_hosts main "host list&!!" *
16818 .cindex "PIPELINING" "suppressing advertising"
16819 .cindex "ESMTP extensions" PIPELINING
16820 This option can be used to suppress the advertisement of the SMTP
16821 PIPELINING extension to specific hosts. See also the &*no_pipelining*&
16822 control in section &<<SECTcontrols>>&. When PIPELINING is not advertised and
16823 &%smtp_enforce_sync%& is true, an Exim server enforces strict synchronization
16824 for each SMTP command and response. When PIPELINING is advertised, Exim assumes
16825 that clients will use it; &"out of order"& commands that are &"expected"& do
16826 not count as protocol errors (see &%smtp_max_synprot_errors%&).
16827
16828 .option pipelining_connect_advertise_hosts main "host list&!!" *
16829 .cindex "pipelining" "early connection"
16830 .cindex "pipelining" PIPE_CONNECT
16831 .cindex "ESMTP extensions" X_PIPE_CONNECT
16832 If Exim is built with the SUPPORT_PIPE_CONNECT build option
16833 this option controls which hosts the facility is advertised to
16834 and from which pipeline early-connection (before MAIL) SMTP
16835 commands are acceptable.
16836 When used, the pipelining saves on roundtrip times.
16837
16838 See also the &%hosts_pipe_connect%& smtp transport option.
16839
16840 Currently the option name &"X_PIPE_CONNECT"& is used.
16841
16842
16843 .option prdr_enable main boolean false
16844 .cindex "PRDR" "enabling on server"
16845 .cindex "ESMTP extensions" PRDR
16846 This option can be used to enable the Per-Recipient Data Response extension
16847 to SMTP, defined by Eric Hall.
16848 If the option is set, PRDR is advertised by Exim when operating as a server.
16849 If the client requests PRDR, and more than one recipient, for a message
16850 an additional ACL is called for each recipient after the message content
16851 is received.  See section &<<SECTPRDRACL>>&.
16852
16853 .option preserve_message_logs main boolean false
16854 .cindex "message logs" "preserving"
16855 If this option is set, message log files are not deleted when messages are
16856 completed. Instead, they are moved to a sub-directory of the spool directory
16857 called &_msglog.OLD_&, where they remain available for statistical or debugging
16858 purposes. This is a dangerous option to set on systems with any appreciable
16859 volume of mail. Use with care!
16860
16861
16862 .option primary_hostname main string "see below"
16863 .cindex "name" "of local host"
16864 .cindex "host" "name of local"
16865 .cindex "local host" "name of"
16866 .vindex "&$primary_hostname$&"
16867 This specifies the name of the current host. It is used in the default EHLO or
16868 HELO command for outgoing SMTP messages (changeable via the &%helo_data%&
16869 option in the &(smtp)& transport), and as the default for &%qualify_domain%&.
16870 The value is also used by default in some SMTP response messages from an Exim
16871 server. This can be changed dynamically by setting &%smtp_active_hostname%&.
16872
16873 If &%primary_hostname%& is not set, Exim calls &[uname()]& to find the host
16874 name. If this fails, Exim panics and dies. If the name returned by &[uname()]&
16875 contains only one component, Exim passes it to &[gethostbyname()]& (or
16876 &[getipnodebyname()]& when available) in order to obtain the fully qualified
16877 version. The variable &$primary_hostname$& contains the host name, whether set
16878 explicitly by this option, or defaulted.
16879
16880
16881 .option print_topbitchars main boolean false
16882 .cindex "printing characters"
16883 .cindex "8-bit characters"
16884 By default, Exim considers only those characters whose codes lie in the range
16885 32&--126 to be printing characters. In a number of circumstances (for example,
16886 when writing log entries) non-printing characters are converted into escape
16887 sequences, primarily to avoid messing up the layout. If &%print_topbitchars%&
16888 is set, code values of 128 and above are also considered to be printing
16889 characters.
16890
16891 This option also affects the header syntax checks performed by the
16892 &(autoreply)& transport, and whether Exim uses RFC 2047 encoding of
16893 the user's full name when constructing From: and Sender: addresses (as
16894 described in section &<<SECTconstr>>&). Setting this option can cause
16895 Exim to generate eight bit message headers that do not conform to the
16896 standards.
16897
16898
16899 .option process_log_path main string unset
16900 .cindex "process log path"
16901 .cindex "log" "process log"
16902 .cindex "&'exiwhat'&"
16903 This option sets the name of the file to which an Exim process writes its
16904 &"process log"& when sent a USR1 signal. This is used by the &'exiwhat'&
16905 utility script. If this option is unset, the file called &_exim-process.info_&
16906 in Exim's spool directory is used. The ability to specify the name explicitly
16907 can be useful in environments where two different Exims are running, using
16908 different spool directories.
16909
16910
16911 .option prod_requires_admin main boolean true
16912 .cindex "restricting access to features"
16913 .oindex "&%-M%&"
16914 .oindex "&%-R%&"
16915 .oindex "&%-q%&"
16916 The &%-M%&, &%-R%&, and &%-q%& command-line options require the caller to be an
16917 admin user unless &%prod_requires_admin%& is set false. See also
16918 &%queue_list_requires_admin%& and &%commandline_checks_require_admin%&.
16919
16920
16921 .option qualify_domain main string "see below"
16922 .cindex "domain" "for qualifying addresses"
16923 .cindex "address" "qualification"
16924 This option specifies the domain name that is added to any envelope sender
16925 addresses that do not have a domain qualification. It also applies to
16926 recipient addresses if &%qualify_recipient%& is not set. Unqualified addresses
16927 are accepted by default only for locally-generated messages. Qualification is
16928 also applied to addresses in header lines such as &'From:'& and &'To:'& for
16929 locally-generated messages, unless the &%-bnq%& command line option is used.
16930
16931 Messages from external sources must always contain fully qualified addresses,
16932 unless the sending host matches &%sender_unqualified_hosts%& or
16933 &%recipient_unqualified_hosts%& (as appropriate), in which case incoming
16934 addresses are qualified with &%qualify_domain%& or &%qualify_recipient%& as
16935 necessary. Internally, Exim always works with fully qualified envelope
16936 addresses. If &%qualify_domain%& is not set, it defaults to the
16937 &%primary_hostname%& value.
16938
16939
16940 .option qualify_recipient main string "see below"
16941 This option allows you to specify a different domain for qualifying recipient
16942 addresses to the one that is used for senders. See &%qualify_domain%& above.
16943
16944
16945
16946 .option queue_domains main "domain list&!!" unset
16947 .cindex "domain" "specifying non-immediate delivery"
16948 .cindex "queueing incoming messages"
16949 .cindex "message" "queueing certain domains"
16950 This option lists domains for which immediate delivery is not required.
16951 A delivery process is started whenever a message is received, but only those
16952 domains that do not match are processed. All other deliveries wait until the
16953 next queue run. See also &%hold_domains%& and &%queue_smtp_domains%&.
16954
16955
16956 .option queue_list_requires_admin main boolean true
16957 .cindex "restricting access to features"
16958 .oindex "&%-bp%&"
16959 The &%-bp%& command-line option, which lists the messages that are on the
16960 queue, requires the caller to be an admin user unless
16961 &%queue_list_requires_admin%& is set false.
16962 See also &%prod_requires_admin%& and &%commandline_checks_require_admin%&.
16963
16964
16965 .option queue_only main boolean false
16966 .cindex "queueing incoming messages"
16967 .cindex "message" "queueing unconditionally"
16968 If &%queue_only%& is set, a delivery process is not automatically started
16969 whenever a message is received. Instead, the message waits in the queue for the
16970 next queue run. Even if &%queue_only%& is false, incoming messages may not get
16971 delivered immediately when certain conditions (such as heavy load) occur.
16972
16973 The &%-odq%& command line has the same effect as &%queue_only%&. The &%-odb%&
16974 and &%-odi%& command line options override &%queue_only%& unless
16975 &%queue_only_override%& is set false. See also &%queue_only_file%&,
16976 &%queue_only_load%&, and &%smtp_accept_queue%&.
16977
16978
16979 .option queue_only_file main string unset
16980 .cindex "queueing incoming messages"
16981 .cindex "message" "queueing by file existence"
16982 This option can be set to a colon-separated list of absolute path names, each
16983 one optionally preceded by &"smtp"&. When Exim is receiving a message,
16984 it tests for the existence of each listed path using a call to &[stat()]&. For
16985 each path that exists, the corresponding queueing option is set.
16986 For paths with no prefix, &%queue_only%& is set; for paths prefixed by
16987 &"smtp"&, &%queue_smtp_domains%& is set to match all domains. So, for example,
16988 .code
16989 queue_only_file = smtp/some/file
16990 .endd
16991 causes Exim to behave as if &%queue_smtp_domains%& were set to &"*"& whenever
16992 &_/some/file_& exists.
16993
16994
16995 .option queue_only_load main fixed-point unset
16996 .cindex "load average"
16997 .cindex "queueing incoming messages"
16998 .cindex "message" "queueing by load"
16999 If the system load average is higher than this value, incoming messages from
17000 all sources are queued, and no automatic deliveries are started. If this
17001 happens during local or remote SMTP input, all subsequent messages received on
17002 the same SMTP connection are queued by default, whatever happens to the load in
17003 the meantime, but this can be changed by setting &%queue_only_load_latch%&
17004 false.
17005
17006 Deliveries will subsequently be performed by queue runner processes. This
17007 option has no effect on ancient operating systems on which Exim cannot
17008 determine the load average. See also &%deliver_queue_load_max%& and
17009 &%smtp_load_reserve%&.
17010
17011
17012 .option queue_only_load_latch main boolean true
17013 .cindex "load average" "re-evaluating per message"
17014 When this option is true (the default), once one message has been queued
17015 because the load average is higher than the value set by &%queue_only_load%&,
17016 all subsequent messages received on the same SMTP connection are also queued.
17017 This is a deliberate choice; even though the load average may fall below the
17018 threshold, it doesn't seem right to deliver later messages on the same
17019 connection when not delivering earlier ones. However, there are special
17020 circumstances such as very long-lived connections from scanning appliances
17021 where this is not the best strategy. In such cases, &%queue_only_load_latch%&
17022 should be set false. This causes the value of the load average to be
17023 re-evaluated for each message.
17024
17025
17026 .option queue_only_override main boolean true
17027 .cindex "queueing incoming messages"
17028 When this option is true, the &%-od%&&'x'& command line options override the
17029 setting of &%queue_only%& or &%queue_only_file%& in the configuration file. If
17030 &%queue_only_override%& is set false, the &%-od%&&'x'& options cannot be used
17031 to override; they are accepted, but ignored.
17032
17033
17034 .option queue_run_in_order main boolean false
17035 .cindex "queue runner" "processing messages in order"
17036 If this option is set, queue runs happen in order of message arrival instead of
17037 in an arbitrary order. For this to happen, a complete list of the entire queue
17038 must be set up before the deliveries start. When the queue is all held in a
17039 single directory (the default), a single list is created for both the ordered
17040 and the non-ordered cases. However, if &%split_spool_directory%& is set, a
17041 single list is not created when &%queue_run_in_order%& is false. In this case,
17042 the sub-directories are processed one at a time (in a random order), and this
17043 avoids setting up one huge list for the whole queue. Thus, setting
17044 &%queue_run_in_order%& with &%split_spool_directory%& may degrade performance
17045 when the queue is large, because of the extra work in setting up the single,
17046 large list. In most situations, &%queue_run_in_order%& should not be set.
17047
17048
17049
17050 .option queue_run_max main integer&!! 5
17051 .cindex "queue runner" "maximum number of"
17052 This controls the maximum number of queue runner processes that an Exim daemon
17053 can run simultaneously. This does not mean that it starts them all at once,
17054 but rather that if the maximum number are still running when the time comes to
17055 start another one, it refrains from starting another one. This can happen with
17056 very large queues and/or very sluggish deliveries. This option does not,
17057 however, interlock with other processes, so additional queue runners can be
17058 started by other means, or by killing and restarting the daemon.
17059
17060 Setting this option to zero does not suppress queue runs; rather, it disables
17061 the limit, allowing any number of simultaneous queue runner processes to be
17062 run. If you do not want queue runs to occur, omit the &%-q%&&'xx'& setting on
17063 the daemon's command line.
17064
17065 .cindex queues named
17066 .cindex "named queues" "resource limit"
17067 To set limits for different named queues use
17068 an expansion depending on the &$queue_name$& variable.
17069
17070 .option queue_smtp_domains main "domain list&!!" unset
17071 .cindex "queueing incoming messages"
17072 .cindex "message" "queueing remote deliveries"
17073 .cindex "first pass routing"
17074 When this option is set, a delivery process is started whenever a message is
17075 received, routing is performed, and local deliveries take place.
17076 However, if any SMTP deliveries are required for domains that match
17077 &%queue_smtp_domains%&, they are not immediately delivered, but instead the
17078 message waits in the queue for the next queue run. Since routing of the message
17079 has taken place, Exim knows to which remote hosts it must be delivered, and so
17080 when the queue run happens, multiple messages for the same host are delivered
17081 over a single SMTP connection. The &%-odqs%& command line option causes all
17082 SMTP deliveries to be queued in this way, and is equivalent to setting
17083 &%queue_smtp_domains%& to &"*"&. See also &%hold_domains%& and
17084 &%queue_domains%&.
17085
17086
17087 .option receive_timeout main time 0s
17088 .cindex "timeout" "for non-SMTP input"
17089 This option sets the timeout for accepting a non-SMTP message, that is, the
17090 maximum time that Exim waits when reading a message on the standard input. If
17091 the value is zero, it will wait forever. This setting is overridden by the
17092 &%-or%& command line option. The timeout for incoming SMTP messages is
17093 controlled by &%smtp_receive_timeout%&.
17094
17095 .option received_header_text main string&!! "see below"
17096 .cindex "customizing" "&'Received:'& header"
17097 .cindex "&'Received:'& header line" "customizing"
17098 This string defines the contents of the &'Received:'& message header that is
17099 added to each message, except for the timestamp, which is automatically added
17100 on at the end (preceded by a semicolon). The string is expanded each time it is
17101 used. If the expansion yields an empty string, no &'Received:'& header line is
17102 added to the message. Otherwise, the string should start with the text
17103 &"Received:"& and conform to the RFC 2822 specification for &'Received:'&
17104 header lines.
17105 The default setting is:
17106
17107 .code
17108 received_header_text = Received: \
17109   ${if def:sender_rcvhost {from $sender_rcvhost\n\t}\
17110     {${if def:sender_ident \
17111       {from ${quote_local_part:$sender_ident} }}\
17112         ${if def:sender_helo_name {(helo=$sender_helo_name)\n\t}}}}\
17113   by $primary_hostname \
17114   ${if def:received_protocol {with $received_protocol }}\
17115   ${if def:tls_in_ver        { ($tls_in_ver)}}\
17116   ${if def:tls_in_cipher_std { tls $tls_in_cipher_std\n\t}}\
17117   (Exim $version_number)\n\t\
17118   ${if def:sender_address \
17119   {(envelope-from <$sender_address>)\n\t}}\
17120   id $message_exim_id\
17121   ${if def:received_for {\n\tfor $received_for}}
17122 .endd
17123
17124 The references to the TLS version and cipher are
17125 omitted when Exim is built without TLS
17126 support. The use of conditional expansions ensures that this works for both
17127 locally generated messages and messages received from remote hosts, giving
17128 header lines such as the following:
17129 .code
17130 Received: from scrooge.carol.example ([192.168.12.25] ident=root)
17131 by marley.carol.example with esmtp (Exim 4.00)
17132 (envelope-from <bob@carol.example>)
17133 id 16IOWa-00019l-00
17134 for chas@dickens.example; Tue, 25 Dec 2001 14:43:44 +0000
17135 Received: by scrooge.carol.example with local (Exim 4.00)
17136 id 16IOWW-000083-00; Tue, 25 Dec 2001 14:43:41 +0000
17137 .endd
17138 Until the body of the message has been received, the timestamp is the time when
17139 the message started to be received. Once the body has arrived, and all policy
17140 checks have taken place, the timestamp is updated to the time at which the
17141 message was accepted.
17142
17143
17144 .option received_headers_max main integer 30
17145 .cindex "loop" "prevention"
17146 .cindex "mail loop prevention"
17147 .cindex "&'Received:'& header line" "counting"
17148 When a message is to be delivered, the number of &'Received:'& headers is
17149 counted, and if it is greater than this parameter, a mail loop is assumed to
17150 have occurred, the delivery is abandoned, and an error message is generated.
17151 This applies to both local and remote deliveries.
17152
17153
17154 .option recipient_unqualified_hosts main "host list&!!" unset
17155 .cindex "unqualified addresses"
17156 .cindex "host" "unqualified addresses from"
17157 This option lists those hosts from which Exim is prepared to accept unqualified
17158 recipient addresses in message envelopes. The addresses are made fully
17159 qualified by the addition of the &%qualify_recipient%& value. This option also
17160 affects message header lines. Exim does not reject unqualified recipient
17161 addresses in headers, but it qualifies them only if the message came from a
17162 host that matches &%recipient_unqualified_hosts%&,
17163 or if the message was submitted locally (not using TCP/IP), and the &%-bnq%&
17164 option was not set.
17165
17166
17167 .option recipients_max main integer 0
17168 .cindex "limit" "number of recipients"
17169 .cindex "recipient" "maximum number"
17170 If this option is set greater than zero, it specifies the maximum number of
17171 original recipients for any message. Additional recipients that are generated
17172 by aliasing or forwarding do not count. SMTP messages get a 452 response for
17173 all recipients over the limit; earlier recipients are delivered as normal.
17174 Non-SMTP messages with too many recipients are failed, and no deliveries are
17175 done.
17176
17177 .cindex "RCPT" "maximum number of incoming"
17178 &*Note*&: The RFCs specify that an SMTP server should accept at least 100
17179 RCPT commands in a single message.
17180
17181
17182 .option recipients_max_reject main boolean false
17183 If this option is set true, Exim rejects SMTP messages containing too many
17184 recipients by giving 552 errors to the surplus RCPT commands, and a 554
17185 error to the eventual DATA command. Otherwise (the default) it gives a 452
17186 error to the surplus RCPT commands and accepts the message on behalf of the
17187 initial set of recipients. The remote server should then re-send the message
17188 for the remaining recipients at a later time.
17189
17190
17191 .option remote_max_parallel main integer 2
17192 .cindex "delivery" "parallelism for remote"
17193 This option controls parallel delivery of one message to a number of remote
17194 hosts. If the value is less than 2, parallel delivery is disabled, and Exim
17195 does all the remote deliveries for a message one by one. Otherwise, if a single
17196 message has to be delivered to more than one remote host, or if several copies
17197 have to be sent to the same remote host, up to &%remote_max_parallel%&
17198 deliveries are done simultaneously. If more than &%remote_max_parallel%&
17199 deliveries are required, the maximum number of processes are started, and as
17200 each one finishes, another is begun. The order of starting processes is the
17201 same as if sequential delivery were being done, and can be controlled by the
17202 &%remote_sort_domains%& option. If parallel delivery takes place while running
17203 with debugging turned on, the debugging output from each delivery process is
17204 tagged with its process id.
17205
17206 This option controls only the maximum number of parallel deliveries for one
17207 message in one Exim delivery process. Because Exim has no central queue
17208 manager, there is no way of controlling the total number of simultaneous
17209 deliveries if the configuration allows a delivery attempt as soon as a message
17210 is received.
17211
17212 .cindex "number of deliveries"
17213 .cindex "delivery" "maximum number of"
17214 If you want to control the total number of deliveries on the system, you
17215 need to set the &%queue_only%& option. This ensures that all incoming messages
17216 are added to the queue without starting a delivery process. Then set up an Exim
17217 daemon to start queue runner processes at appropriate intervals (probably
17218 fairly often, for example, every minute), and limit the total number of queue
17219 runners by setting the &%queue_run_max%& parameter. Because each queue runner
17220 delivers only one message at a time, the maximum number of deliveries that can
17221 then take place at once is &%queue_run_max%& multiplied by
17222 &%remote_max_parallel%&.
17223
17224 If it is purely remote deliveries you want to control, use
17225 &%queue_smtp_domains%& instead of &%queue_only%&. This has the added benefit of
17226 doing the SMTP routing before queueing, so that several messages for the same
17227 host will eventually get delivered down the same connection.
17228
17229
17230 .option remote_sort_domains main "domain list&!!" unset
17231 .cindex "sorting remote deliveries"
17232 .cindex "delivery" "sorting remote"
17233 When there are a number of remote deliveries for a message, they are sorted by
17234 domain into the order given by this list. For example,
17235 .code
17236 remote_sort_domains = *.cam.ac.uk:*.uk
17237 .endd
17238 would attempt to deliver to all addresses in the &'cam.ac.uk'& domain first,
17239 then to those in the &%uk%& domain, then to any others.
17240
17241
17242 .option retry_data_expire main time 7d
17243 .cindex "hints database" "data expiry"
17244 This option sets a &"use before"& time on retry information in Exim's hints
17245 database. Any older retry data is ignored. This means that, for example, once a
17246 host has not been tried for 7 days, Exim behaves as if it has no knowledge of
17247 past failures.
17248
17249
17250 .option retry_interval_max main time 24h
17251 .cindex "retry" "limit on interval"
17252 .cindex "limit" "on retry interval"
17253 Chapter &<<CHAPretry>>& describes Exim's mechanisms for controlling the
17254 intervals between delivery attempts for messages that cannot be delivered
17255 straight away. This option sets an overall limit to the length of time between
17256 retries. It cannot be set greater than 24 hours; any attempt to do so forces
17257 the default value.
17258
17259
17260 .option return_path_remove main boolean true
17261 .cindex "&'Return-path:'& header line" "removing"
17262 RFC 2821, section 4.4, states that an SMTP server must insert a
17263 &'Return-path:'& header line into a message when it makes a &"final delivery"&.
17264 The &'Return-path:'& header preserves the sender address as received in the
17265 MAIL command. This description implies that this header should not be present
17266 in an incoming message. If &%return_path_remove%& is true, any existing
17267 &'Return-path:'& headers are removed from messages at the time they are
17268 received. Exim's transports have options for adding &'Return-path:'& headers at
17269 the time of delivery. They are normally used only for final local deliveries.
17270
17271
17272 .option return_size_limit main integer 100K
17273 This option is an obsolete synonym for &%bounce_return_size_limit%&.
17274
17275
17276 .option rfc1413_hosts main "host list&!!" @[]
17277 .cindex "RFC 1413"
17278 .cindex "host" "for RFC 1413 calls"
17279 RFC 1413 identification calls are made to any client host which matches
17280 an item in the list.
17281 The default value specifies just this host, being any local interface
17282 for the system.
17283
17284 .option rfc1413_query_timeout main time 0s
17285 .cindex "RFC 1413" "query timeout"
17286 .cindex "timeout" "for RFC 1413 call"
17287 This sets the timeout on RFC 1413 identification calls. If it is set to zero,
17288 no RFC 1413 calls are ever made.
17289
17290
17291 .option sender_unqualified_hosts main "host list&!!" unset
17292 .cindex "unqualified addresses"
17293 .cindex "host" "unqualified addresses from"
17294 This option lists those hosts from which Exim is prepared to accept unqualified
17295 sender addresses. The addresses are made fully qualified by the addition of
17296 &%qualify_domain%&. This option also affects message header lines. Exim does
17297 not reject unqualified addresses in headers that contain sender addresses, but
17298 it qualifies them only if the message came from a host that matches
17299 &%sender_unqualified_hosts%&, or if the message was submitted locally (not
17300 using TCP/IP), and the &%-bnq%& option was not set.
17301
17302
17303 .option slow_lookup_log main integer 0
17304 .cindex "logging" "slow lookups"
17305 .cindex "dns" "logging slow lookups"
17306 This option controls logging of slow lookups.
17307 If the value is nonzero it is taken as a number of milliseconds
17308 and lookups taking longer than this are logged.
17309 Currently this applies only to DNS lookups.
17310
17311
17312
17313 .option smtp_accept_keepalive main boolean true
17314 .cindex "keepalive" "on incoming connection"
17315 This option controls the setting of the SO_KEEPALIVE option on incoming
17316 TCP/IP socket connections. When set, it causes the kernel to probe idle
17317 connections periodically, by sending packets with &"old"& sequence numbers. The
17318 other end of the connection should send an acknowledgment if the connection is
17319 still okay or a reset if the connection has been aborted. The reason for doing
17320 this is that it has the beneficial effect of freeing up certain types of
17321 connection that can get stuck when the remote host is disconnected without
17322 tidying up the TCP/IP call properly. The keepalive mechanism takes several
17323 hours to detect unreachable hosts.
17324
17325
17326
17327 .option smtp_accept_max main integer 20
17328 .cindex "limit" "incoming SMTP connections"
17329 .cindex "SMTP" "incoming connection count"
17330 .cindex "inetd"
17331 This option specifies the maximum number of simultaneous incoming SMTP calls
17332 that Exim will accept. It applies only to the listening daemon; there is no
17333 control (in Exim) when incoming SMTP is being handled by &'inetd'&. If the
17334 value is set to zero, no limit is applied. However, it is required to be
17335 non-zero if either &%smtp_accept_max_per_host%& or &%smtp_accept_queue%& is
17336 set. See also &%smtp_accept_reserve%& and &%smtp_load_reserve%&.
17337
17338 A new SMTP connection is immediately rejected if the &%smtp_accept_max%& limit
17339 has been reached. If not, Exim first checks &%smtp_accept_max_per_host%&. If
17340 that limit has not been reached for the client host, &%smtp_accept_reserve%&
17341 and &%smtp_load_reserve%& are then checked before accepting the connection.
17342
17343
17344 .option smtp_accept_max_nonmail main integer 10
17345 .cindex "limit" "non-mail SMTP commands"
17346 .cindex "SMTP" "limiting non-mail commands"
17347 Exim counts the number of &"non-mail"& commands in an SMTP session, and drops
17348 the connection if there are too many. This option defines &"too many"&. The
17349 check catches some denial-of-service attacks, repeated failing AUTHs, or a mad
17350 client looping sending EHLO, for example. The check is applied only if the
17351 client host matches &%smtp_accept_max_nonmail_hosts%&.
17352
17353 When a new message is expected, one occurrence of RSET is not counted. This
17354 allows a client to send one RSET between messages (this is not necessary,
17355 but some clients do it). Exim also allows one uncounted occurrence of HELO
17356 or EHLO, and one occurrence of STARTTLS between messages. After
17357 starting up a TLS session, another EHLO is expected, and so it too is not
17358 counted. The first occurrence of AUTH in a connection, or immediately
17359 following STARTTLS is not counted. Otherwise, all commands other than
17360 MAIL, RCPT, DATA, and QUIT are counted.
17361
17362
17363 .option smtp_accept_max_nonmail_hosts main "host list&!!" *
17364 You can control which hosts are subject to the &%smtp_accept_max_nonmail%&
17365 check by setting this option. The default value makes it apply to all hosts. By
17366 changing the value, you can exclude any badly-behaved hosts that you have to
17367 live with.
17368
17369
17370 . Allow this long option name to split; give it unsplit as a fifth argument
17371 . for the automatic .oindex that is generated by .option.
17372 . We insert " &~&~" which is both pretty nasty visually and results in
17373 . non-searchable text.  HowItWorks.txt mentions an option for inserting
17374 . zero-width-space, which would be nicer visually and results in (at least)
17375 . html that Firefox will split on when it's forced to reflow (rather than
17376 . inserting a horizontal scrollbar).  However, the text is still not
17377 . searchable.  NM changed this occurrence for bug 1197 to no longer allow
17378 . the option name to split.
17379
17380 .option "smtp_accept_max_per_connection" main integer 1000 &&&
17381          smtp_accept_max_per_connection
17382 .cindex "SMTP" "limiting incoming message count"
17383 .cindex "limit" "messages per SMTP connection"
17384 The value of this option limits the number of MAIL commands that Exim is
17385 prepared to accept over a single SMTP connection, whether or not each command
17386 results in the transfer of a message. After the limit is reached, a 421
17387 response is given to subsequent MAIL commands. This limit is a safety
17388 precaution against a client that goes mad (incidents of this type have been
17389 seen).
17390
17391
17392 .option smtp_accept_max_per_host main string&!! unset
17393 .cindex "limit" "SMTP connections from one host"
17394 .cindex "host" "limiting SMTP connections from"
17395 This option restricts the number of simultaneous IP connections from a single
17396 host (strictly, from a single IP address) to the Exim daemon. The option is
17397 expanded, to enable different limits to be applied to different hosts by
17398 reference to &$sender_host_address$&. Once the limit is reached, additional
17399 connection attempts from the same host are rejected with error code 421. This
17400 is entirely independent of &%smtp_accept_reserve%&. The option's default value
17401 of zero imposes no limit. If this option is set greater than zero, it is
17402 required that &%smtp_accept_max%& be non-zero.
17403
17404 &*Warning*&: When setting this option you should not use any expansion
17405 constructions that take an appreciable amount of time. The expansion and test
17406 happen in the main daemon loop, in order to reject additional connections
17407 without forking additional processes (otherwise a denial-of-service attack
17408 could cause a vast number or processes to be created). While the daemon is
17409 doing this processing, it cannot accept any other incoming connections.
17410
17411
17412
17413 .option smtp_accept_queue main integer 0
17414 .cindex "SMTP" "incoming connection count"
17415 .cindex "queueing incoming messages"
17416 .cindex "message" "queueing by SMTP connection count"
17417 If the number of simultaneous incoming SMTP connections being handled via the
17418 listening daemon exceeds this value, messages received by SMTP are just placed
17419 in the queue; no delivery processes are started automatically. The count is
17420 fixed at the start of an SMTP connection. It cannot be updated in the
17421 subprocess that receives messages, and so the queueing or not queueing applies
17422 to all messages received in the same connection.
17423
17424 A value of zero implies no limit, and clearly any non-zero value is useful only
17425 if it is less than the &%smtp_accept_max%& value (unless that is zero). See
17426 also &%queue_only%&, &%queue_only_load%&, &%queue_smtp_domains%&, and the
17427 various &%-od%&&'x'& command line options.
17428
17429
17430 . See the comment on smtp_accept_max_per_connection
17431
17432 .option "smtp_accept_queue_per_connection" main integer 10 &&&
17433          smtp_accept_queue_per_connection
17434 .cindex "queueing incoming messages"
17435 .cindex "message" "queueing by message count"
17436 This option limits the number of delivery processes that Exim starts
17437 automatically when receiving messages via SMTP, whether via the daemon or by
17438 the use of &%-bs%& or &%-bS%&. If the value of the option is greater than zero,
17439 and the number of messages received in a single SMTP session exceeds this
17440 number, subsequent messages are placed in the queue, but no delivery processes
17441 are started. This helps to limit the number of Exim processes when a server
17442 restarts after downtime and there is a lot of mail waiting for it on other
17443 systems. On large systems, the default should probably be increased, and on
17444 dial-in client systems it should probably be set to zero (that is, disabled).
17445
17446
17447 .option smtp_accept_reserve main integer 0
17448 .cindex "SMTP" "incoming call count"
17449 .cindex "host" "reserved"
17450 When &%smtp_accept_max%& is set greater than zero, this option specifies a
17451 number of SMTP connections that are reserved for connections from the hosts
17452 that are specified in &%smtp_reserve_hosts%&. The value set in
17453 &%smtp_accept_max%& includes this reserve pool. The specified hosts are not
17454 restricted to this number of connections; the option specifies a minimum number
17455 of connection slots for them, not a maximum. It is a guarantee that this group
17456 of hosts can always get at least &%smtp_accept_reserve%& connections. However,
17457 the limit specified by &%smtp_accept_max_per_host%& is still applied to each
17458 individual host.
17459
17460 For example, if &%smtp_accept_max%& is set to 50 and &%smtp_accept_reserve%& is
17461 set to 5, once there are 45 active connections (from any hosts), new
17462 connections are accepted only from hosts listed in &%smtp_reserve_hosts%&,
17463 provided the other criteria for acceptance are met.
17464
17465
17466 .option smtp_active_hostname main string&!! unset
17467 .cindex "host" "name in SMTP responses"
17468 .cindex "SMTP" "host name in responses"
17469 .vindex "&$primary_hostname$&"
17470 This option is provided for multi-homed servers that want to masquerade as
17471 several different hosts. At the start of an incoming SMTP connection, its value
17472 is expanded and used instead of the value of &$primary_hostname$& in SMTP
17473 responses. For example, it is used as domain name in the response to an
17474 incoming HELO or EHLO command.
17475
17476 .vindex "&$smtp_active_hostname$&"
17477 The active hostname is placed in the &$smtp_active_hostname$& variable, which
17478 is saved with any messages that are received. It is therefore available for use
17479 in routers and transports when the message is later delivered.
17480
17481 If this option is unset, or if its expansion is forced to fail, or if the
17482 expansion results in an empty string, the value of &$primary_hostname$& is
17483 used. Other expansion failures cause a message to be written to the main and
17484 panic logs, and the SMTP command receives a temporary error. Typically, the
17485 value of &%smtp_active_hostname%& depends on the incoming interface address.
17486 For example:
17487 .code
17488 smtp_active_hostname = ${if eq{$received_ip_address}{10.0.0.1}\
17489   {cox.mydomain}{box.mydomain}}
17490 .endd
17491
17492 Although &$smtp_active_hostname$& is primarily concerned with incoming
17493 messages, it is also used as the default for HELO commands in callout
17494 verification if there is no remote transport from which to obtain a
17495 &%helo_data%& value.
17496
17497 .option smtp_banner main string&!! "see below"
17498 .cindex "SMTP" "welcome banner"
17499 .cindex "banner for SMTP"
17500 .cindex "welcome banner for SMTP"
17501 .cindex "customizing" "SMTP banner"
17502 This string, which is expanded every time it is used, is output as the initial
17503 positive response to an SMTP connection. The default setting is:
17504 .code
17505 smtp_banner = $smtp_active_hostname ESMTP Exim \
17506   $version_number $tod_full
17507 .endd
17508 Failure to expand the string causes a panic error. If you want to create a
17509 multiline response to the initial SMTP connection, use &"\n"& in the string at
17510 appropriate points, but not at the end. Note that the 220 code is not included
17511 in this string. Exim adds it automatically (several times in the case of a
17512 multiline response).
17513
17514
17515 .option smtp_check_spool_space main boolean true
17516 .cindex "checking disk space"
17517 .cindex "disk space, checking"
17518 .cindex "spool directory" "checking space"
17519 When this option is set, if an incoming SMTP session encounters the SIZE
17520 option on a MAIL command, it checks that there is enough space in the
17521 spool directory's partition to accept a message of that size, while still
17522 leaving free the amount specified by &%check_spool_space%& (even if that value
17523 is zero). If there isn't enough space, a temporary error code is returned.
17524
17525
17526 .option smtp_connect_backlog main integer 20
17527 .cindex "connection backlog"
17528 .cindex "SMTP" "connection backlog"
17529 .cindex "backlog of connections"
17530 This option specifies a maximum number of waiting SMTP connections. Exim passes
17531 this value to the TCP/IP system when it sets up its listener. Once this number
17532 of connections are waiting for the daemon's attention, subsequent connection
17533 attempts are refused at the TCP/IP level. At least, that is what the manuals
17534 say; in some circumstances such connection attempts have been observed to time
17535 out instead. For large systems it is probably a good idea to increase the
17536 value (to 50, say). It also gives some protection against denial-of-service
17537 attacks by SYN flooding.
17538
17539
17540 .option smtp_enforce_sync main boolean true
17541 .cindex "SMTP" "synchronization checking"
17542 .cindex "synchronization checking in SMTP"
17543 The SMTP protocol specification requires the client to wait for a response from
17544 the server at certain points in the dialogue. Without PIPELINING these
17545 synchronization points are after every command; with PIPELINING they are
17546 fewer, but they still exist.
17547
17548 Some spamming sites send out a complete set of SMTP commands without waiting
17549 for any response. Exim protects against this by rejecting a message if the
17550 client has sent further input when it should not have. The error response &"554
17551 SMTP synchronization error"& is sent, and the connection is dropped. Testing
17552 for this error cannot be perfect because of transmission delays (unexpected
17553 input may be on its way but not yet received when Exim checks). However, it
17554 does detect many instances.
17555
17556 The check can be globally disabled by setting &%smtp_enforce_sync%& false.
17557 If you want to disable the check selectively (for example, only for certain
17558 hosts), you can do so by an appropriate use of a &%control%& modifier in an ACL
17559 (see section &<<SECTcontrols>>&). See also &%pipelining_advertise_hosts%&.
17560
17561
17562
17563 .option smtp_etrn_command main string&!! unset
17564 .cindex "ETRN" "command to be run"
17565 .cindex "ESMTP extensions" ETRN
17566 .vindex "&$domain$&"
17567 If this option is set, the given command is run whenever an SMTP ETRN
17568 command is received from a host that is permitted to issue such commands (see
17569 chapter &<<CHAPACL>>&). The string is split up into separate arguments which
17570 are independently expanded. The expansion variable &$domain$& is set to the
17571 argument of the ETRN command, and no syntax checking is done on it. For
17572 example:
17573 .code
17574 smtp_etrn_command = /etc/etrn_command $domain \
17575                     $sender_host_address
17576 .endd
17577 .new
17578 If the option is not set, the argument for the ETRN command must
17579 be a &'#'& followed by an address string.
17580 In this case an &'exim -R <string>'& command is used;
17581 if the ETRN ACL has set up a named-queue then &'-MCG <queue>'& is appended.
17582 .wen
17583
17584 A new process is created to run the command, but Exim does not wait for it to
17585 complete. Consequently, its status cannot be checked. If the command cannot be
17586 run, a line is written to the panic log, but the ETRN caller still receives
17587 a 250 success response. Exim is normally running under its own uid when
17588 receiving SMTP, so it is not possible for it to change the uid before running
17589 the command.
17590
17591
17592 .option smtp_etrn_serialize main boolean true
17593 .cindex "ETRN" "serializing"
17594 When this option is set, it prevents the simultaneous execution of more than
17595 one identical command as a result of ETRN in an SMTP connection. See
17596 section &<<SECTETRN>>& for details.
17597
17598
17599 .option smtp_load_reserve main fixed-point unset
17600 .cindex "load average"
17601 If the system load average ever gets higher than this, incoming SMTP calls are
17602 accepted only from those hosts that match an entry in &%smtp_reserve_hosts%&.
17603 If &%smtp_reserve_hosts%& is not set, no incoming SMTP calls are accepted when
17604 the load is over the limit. The option has no effect on ancient operating
17605 systems on which Exim cannot determine the load average. See also
17606 &%deliver_queue_load_max%& and &%queue_only_load%&.
17607
17608
17609
17610 .option smtp_max_synprot_errors main integer 3
17611 .cindex "SMTP" "limiting syntax and protocol errors"
17612 .cindex "limit" "SMTP syntax and protocol errors"
17613 Exim rejects SMTP commands that contain syntax or protocol errors. In
17614 particular, a syntactically invalid email address, as in this command:
17615 .code
17616 RCPT TO:<abc xyz@a.b.c>
17617 .endd
17618 causes immediate rejection of the command, before any other tests are done.
17619 (The ACL cannot be run if there is no valid address to set up for it.) An
17620 example of a protocol error is receiving RCPT before MAIL. If there are
17621 too many syntax or protocol errors in one SMTP session, the connection is
17622 dropped. The limit is set by this option.
17623
17624 .cindex "PIPELINING" "expected errors"
17625 When the PIPELINING extension to SMTP is in use, some protocol errors are
17626 &"expected"&, for instance, a RCPT command after a rejected MAIL command.
17627 Exim assumes that PIPELINING will be used if it advertises it (see
17628 &%pipelining_advertise_hosts%&), and in this situation, &"expected"& errors do
17629 not count towards the limit.
17630
17631
17632
17633 .option smtp_max_unknown_commands main integer 3
17634 .cindex "SMTP" "limiting unknown commands"
17635 .cindex "limit" "unknown SMTP commands"
17636 If there are too many unrecognized commands in an incoming SMTP session, an
17637 Exim server drops the connection. This is a defence against some kinds of abuse
17638 that subvert web
17639 clients
17640 into making connections to SMTP ports; in these circumstances, a number of
17641 non-SMTP command lines are sent first.
17642
17643
17644
17645 .option smtp_ratelimit_hosts main "host list&!!" unset
17646 .cindex "SMTP" "rate limiting"
17647 .cindex "limit" "rate of message arrival"
17648 .cindex "RCPT" "rate limiting"
17649 Some sites find it helpful to be able to limit the rate at which certain hosts
17650 can send them messages, and the rate at which an individual message can specify
17651 recipients.
17652
17653 Exim has two rate-limiting facilities. This section describes the older
17654 facility, which can limit rates within a single connection. The newer
17655 &%ratelimit%& ACL condition can limit rates across all connections. See section
17656 &<<SECTratelimiting>>& for details of the newer facility.
17657
17658 When a host matches &%smtp_ratelimit_hosts%&, the values of
17659 &%smtp_ratelimit_mail%& and &%smtp_ratelimit_rcpt%& are used to control the
17660 rate of acceptance of MAIL and RCPT commands in a single SMTP session,
17661 respectively. Each option, if set, must contain a set of four comma-separated
17662 values:
17663
17664 .ilist
17665 A threshold, before which there is no rate limiting.
17666 .next
17667 An initial time delay. Unlike other times in Exim, numbers with decimal
17668 fractional parts are allowed here.
17669 .next
17670 A factor by which to increase the delay each time.
17671 .next
17672 A maximum value for the delay. This should normally be less than 5 minutes,
17673 because after that time, the client is liable to timeout the SMTP command.
17674 .endlist
17675
17676 For example, these settings have been used successfully at the site which
17677 first suggested this feature, for controlling mail from their customers:
17678 .code
17679 smtp_ratelimit_mail = 2,0.5s,1.05,4m
17680 smtp_ratelimit_rcpt = 4,0.25s,1.015,4m
17681 .endd
17682 The first setting specifies delays that are applied to MAIL commands after
17683 two have been received over a single connection. The initial delay is 0.5
17684 seconds, increasing by a factor of 1.05 each time. The second setting applies
17685 delays to RCPT commands when more than four occur in a single message.
17686
17687
17688 .option smtp_ratelimit_mail main string unset
17689 See &%smtp_ratelimit_hosts%& above.
17690
17691
17692 .option smtp_ratelimit_rcpt main string unset
17693 See &%smtp_ratelimit_hosts%& above.
17694
17695
17696 .option smtp_receive_timeout main time&!! 5m
17697 .cindex "timeout" "for SMTP input"
17698 .cindex "SMTP" "input timeout"
17699 This sets a timeout value for SMTP reception. It applies to all forms of SMTP
17700 input, including batch SMTP. If a line of input (either an SMTP command or a
17701 data line) is not received within this time, the SMTP connection is dropped and
17702 the message is abandoned.
17703 A line is written to the log containing one of the following messages:
17704 .code
17705 SMTP command timeout on connection from...
17706 SMTP data timeout on connection from...
17707 .endd
17708 The former means that Exim was expecting to read an SMTP command; the latter
17709 means that it was in the DATA phase, reading the contents of a message.
17710
17711 If the first character of the option is a &"$"& the option is
17712 expanded before use and may depend on
17713 &$sender_host_name$&, &$sender_host_address$& and &$sender_host_port$&.
17714
17715
17716 .oindex "&%-os%&"
17717 The value set by this option can be overridden by the
17718 &%-os%& command-line option. A setting of zero time disables the timeout, but
17719 this should never be used for SMTP over TCP/IP. (It can be useful in some cases
17720 of local input using &%-bs%& or &%-bS%&.) For non-SMTP input, the reception
17721 timeout is controlled by &%receive_timeout%& and &%-or%&.
17722
17723
17724 .option smtp_reserve_hosts main "host list&!!" unset
17725 This option defines hosts for which SMTP connections are reserved; see
17726 &%smtp_accept_reserve%& and &%smtp_load_reserve%& above.
17727
17728
17729 .option smtp_return_error_details main boolean false
17730 .cindex "SMTP" "details policy failures"
17731 .cindex "policy control" "rejection, returning details"
17732 In the default state, Exim uses bland messages such as
17733 &"Administrative prohibition"& when it rejects SMTP commands for policy
17734 reasons. Many sysadmins like this because it gives away little information
17735 to spammers. However, some other sysadmins who are applying strict checking
17736 policies want to give out much fuller information about failures. Setting
17737 &%smtp_return_error_details%& true causes Exim to be more forthcoming. For
17738 example, instead of &"Administrative prohibition"&, it might give:
17739 .code
17740 550-Rejected after DATA: '>' missing at end of address:
17741 550 failing address in "From" header is: <user@dom.ain
17742 .endd
17743
17744
17745 .option smtputf8_advertise_hosts main "host list&!!" *
17746 .cindex "SMTPUTF8" "ESMTP extension, advertising"
17747 .cindex "ESMTP extensions" SMTPUTF8
17748 When Exim is built with support for internationalised mail names,
17749 the availability thereof is advertised in
17750 response to EHLO only to those client hosts that match this option. See
17751 chapter &<<CHAPi18n>>& for details of Exim's support for internationalisation.
17752
17753
17754 .option spamd_address main string "127.0.0.1 783"
17755 This option is available when Exim is compiled with the content-scanning
17756 extension. It specifies how Exim connects to SpamAssassin's &%spamd%& daemon.
17757 See section &<<SECTscanspamass>>& for more details.
17758
17759
17760
17761 .option spf_guess main string "v=spf1 a/24 mx/24 ptr ?all"
17762 This option is available when Exim is compiled with SPF support.
17763 See section &<<SECSPF>>& for more details.
17764
17765 .new
17766 .option spf_smtp_comment_template main string&!! "Please%_see%_http://www.open-spf.org/Why"
17767 This option is available when Exim is compiled with SPF support.  It
17768 allows the customisation of the SMTP comment that the SPF library
17769 generates.  You are strongly encouraged to link to your own explanative
17770 site. The template must not contain spaces. If you need spaces in the
17771 output, use the proper placeholder. If libspf2 can not parse the
17772 template, it uses a built-in default broken link. The following placeholders
17773 (along with Exim variables (but see below)) are allowed in the template:
17774 .ilist
17775 &*%_*&: A space.
17776 .next
17777 &*%{L}*&: Envelope sender's local part.
17778 .next
17779 &*%{S}*&: Envelope sender.
17780 .next
17781 &*%{O}*&: Envelope sender's domain.
17782 .next
17783 &*%{D}*&: Current(?) domain.
17784 .next
17785 &*%{I}*&: SMTP client Ip.
17786 .next
17787 &*%{C}*&: SMTP client pretty IP.
17788 .next
17789 &*%{T}*&: Epoch time (UTC).
17790 .next
17791 &*%{P}*&: SMTP client domain name.
17792 .next
17793 &*%{V}*&: IP version.
17794 .next
17795 &*%{H}*&: EHLO/HELO domain.
17796 .next
17797 &*%{R}*&: Receiving domain.
17798 .endlist
17799 The capitalized placeholders do proper URL encoding, if you use them
17800 lowercased, no encoding takes place.  This list was compiled from the
17801 libspf2 sources.
17802
17803 A note on using Exim variables: As
17804 currently the SPF library is initialized before the SMTP EHLO phase,
17805 the variables useful for expansion are quite limited.
17806 .wen
17807
17808
17809 .option split_spool_directory main boolean false
17810 .cindex "multiple spool directories"
17811 .cindex "spool directory" "split"
17812 .cindex "directories, multiple"
17813 If this option is set, it causes Exim to split its input directory into 62
17814 subdirectories, each with a single alphanumeric character as its name. The
17815 sixth character of the message id is used to allocate messages to
17816 subdirectories; this is the least significant base-62 digit of the time of
17817 arrival of the message.
17818
17819 Splitting up the spool in this way may provide better performance on systems
17820 where there are long mail queues, by reducing the number of files in any one
17821 directory. The msglog directory is also split up in a similar way to the input
17822 directory; however, if &%preserve_message_logs%& is set, all old msglog files
17823 are still placed in the single directory &_msglog.OLD_&.
17824
17825 It is not necessary to take any special action for existing messages when
17826 changing &%split_spool_directory%&. Exim notices messages that are in the
17827 &"wrong"& place, and continues to process them. If the option is turned off
17828 after a period of being on, the subdirectories will eventually empty and be
17829 automatically deleted.
17830
17831 When &%split_spool_directory%& is set, the behaviour of queue runner processes
17832 changes. Instead of creating a list of all messages in the queue, and then
17833 trying to deliver each one, in turn, it constructs a list of those in one
17834 sub-directory and tries to deliver them, before moving on to the next
17835 sub-directory. The sub-directories are processed in a random order. This
17836 spreads out the scanning of the input directories, and uses less memory. It is
17837 particularly beneficial when there are lots of messages in the queue. However,
17838 if &%queue_run_in_order%& is set, none of this new processing happens. The
17839 entire queue has to be scanned and sorted before any deliveries can start.
17840
17841
17842 .option spool_directory main string&!! "set at compile time"
17843 .cindex "spool directory" "path to"
17844 This defines the directory in which Exim keeps its spool, that is, the messages
17845 it is waiting to deliver. The default value is taken from the compile-time
17846 configuration setting, if there is one. If not, this option must be set. The
17847 string is expanded, so it can contain, for example, a reference to
17848 &$primary_hostname$&.
17849
17850 If the spool directory name is fixed on your installation, it is recommended
17851 that you set it at build time rather than from this option, particularly if the
17852 log files are being written to the spool directory (see &%log_file_path%&).
17853 Otherwise log files cannot be used for errors that are detected early on, such
17854 as failures in the configuration file.
17855
17856 By using this option to override the compiled-in path, it is possible to run
17857 tests of Exim without using the standard spool.
17858
17859 .option spool_wireformat main boolean false
17860 .cindex "spool directory" "file formats"
17861 If this option is set, Exim may for some messages use an alternative format
17862 for data-files in the spool which matches the wire format.
17863 Doing this permits more efficient message reception and transmission.
17864 Currently it is only done for messages received using the ESMTP CHUNKING
17865 option.
17866
17867 The following variables will not have useful values:
17868 .code
17869 $max_received_linelength
17870 $body_linecount
17871 $body_zerocount
17872 .endd
17873
17874 Users of the local_scan() API (see &<<CHAPlocalscan>>&),
17875 and any external programs which are passed a reference to a message data file
17876 (except via the &"regex"&, &"malware"& or &"spam"&) ACL conditions)
17877 will need to be aware of the different formats potentially available.
17878
17879 Using any of the ACL conditions noted will negate the reception benefit
17880 (as a Unix-mbox-format file is constructed for them).
17881 The transmission benefit is maintained.
17882
17883 .option sqlite_lock_timeout main time 5s
17884 .cindex "sqlite lookup type" "lock timeout"
17885 This option controls the timeout that the &(sqlite)& lookup uses when trying to
17886 access an SQLite database. See section &<<SECTsqlite>>& for more details.
17887
17888 .option strict_acl_vars main boolean false
17889 .cindex "&ACL;" "variables, handling unset"
17890 This option controls what happens if a syntactically valid but undefined ACL
17891 variable is referenced. If it is false (the default), an empty string
17892 is substituted; if it is true, an error is generated. See section
17893 &<<SECTaclvariables>>& for details of ACL variables.
17894
17895 .option strip_excess_angle_brackets main boolean false
17896 .cindex "angle brackets, excess"
17897 If this option is set, redundant pairs of angle brackets round &"route-addr"&
17898 items in addresses are stripped. For example, &'<<xxx@a.b.c.d>>'& is
17899 treated as &'<xxx@a.b.c.d>'&. If this is in the envelope and the message is
17900 passed on to another MTA, the excess angle brackets are not passed on. If this
17901 option is not set, multiple pairs of angle brackets cause a syntax error.
17902
17903
17904 .option strip_trailing_dot main boolean false
17905 .cindex "trailing dot on domain"
17906 .cindex "dot" "trailing on domain"
17907 If this option is set, a trailing dot at the end of a domain in an address is
17908 ignored. If this is in the envelope and the message is passed on to another
17909 MTA, the dot is not passed on. If this option is not set, a dot at the end of a
17910 domain causes a syntax error.
17911 However, addresses in header lines are checked only when an ACL requests header
17912 syntax checking.
17913
17914
17915 .option syslog_duplication main boolean true
17916 .cindex "syslog" "duplicate log lines; suppressing"
17917 When Exim is logging to syslog, it writes the log lines for its three
17918 separate logs at different syslog priorities so that they can in principle
17919 be separated on the logging hosts. Some installations do not require this
17920 separation, and in those cases, the duplication of certain log lines is a
17921 nuisance. If &%syslog_duplication%& is set false, only one copy of any
17922 particular log line is written to syslog. For lines that normally go to
17923 both the main log and the reject log, the reject log version (possibly
17924 containing message header lines) is written, at LOG_NOTICE priority.
17925 Lines that normally go to both the main and the panic log are written at
17926 the LOG_ALERT priority.
17927
17928
17929 .option syslog_facility main string unset
17930 .cindex "syslog" "facility; setting"
17931 This option sets the syslog &"facility"& name, used when Exim is logging to
17932 syslog. The value must be one of the strings &"mail"&, &"user"&, &"news"&,
17933 &"uucp"&, &"daemon"&, or &"local&'x'&"& where &'x'& is a digit between 0 and 7.
17934 If this option is unset, &"mail"& is used. See chapter &<<CHAPlog>>& for
17935 details of Exim's logging.
17936
17937
17938 .option syslog_pid main boolean true
17939 .cindex "syslog" "pid"
17940 If &%syslog_pid%& is set false, the PID on Exim's log lines are
17941 omitted when these lines are sent to syslog. (Syslog normally prefixes
17942 the log lines with the PID of the logging process automatically.) You need
17943 to enable the &`+pid`& log selector item, if you want Exim to write it's PID
17944 into the logs.) See chapter &<<CHAPlog>>& for details of Exim's logging.
17945
17946
17947
17948 .option syslog_processname main string &`exim`&
17949 .cindex "syslog" "process name; setting"
17950 This option sets the syslog &"ident"& name, used when Exim is logging to
17951 syslog. The value must be no longer than 32 characters. See chapter
17952 &<<CHAPlog>>& for details of Exim's logging.
17953
17954
17955
17956 .option syslog_timestamp main boolean true
17957 .cindex "syslog" "timestamps"
17958 If &%syslog_timestamp%& is set false, the timestamps on Exim's log lines are
17959 omitted when these lines are sent to syslog. See chapter &<<CHAPlog>>& for
17960 details of Exim's logging.
17961
17962
17963 .option system_filter main string&!! unset
17964 .cindex "filter" "system filter"
17965 .cindex "system filter" "specifying"
17966 .cindex "Sieve filter" "not available for system filter"
17967 This option specifies an Exim filter file that is applied to all messages at
17968 the start of each delivery attempt, before any routing is done. System filters
17969 must be Exim filters; they cannot be Sieve filters. If the system filter
17970 generates any deliveries to files or pipes, or any new mail messages, the
17971 appropriate &%system_filter_..._transport%& option(s) must be set, to define
17972 which transports are to be used. Details of this facility are given in chapter
17973 &<<CHAPsystemfilter>>&.
17974 A forced expansion failure results in no filter operation.
17975
17976
17977 .option system_filter_directory_transport main string&!! unset
17978 .vindex "&$address_file$&"
17979 This sets the name of the transport driver that is to be used when the
17980 &%save%& command in a system message filter specifies a path ending in &"/"&,
17981 implying delivery of each message into a separate file in some directory.
17982 During the delivery, the variable &$address_file$& contains the path name.
17983
17984
17985 .option system_filter_file_transport main string&!! unset
17986 .cindex "file" "transport for system filter"
17987 This sets the name of the transport driver that is to be used when the &%save%&
17988 command in a system message filter specifies a path not ending in &"/"&. During
17989 the delivery, the variable &$address_file$& contains the path name.
17990
17991 .option system_filter_group main string unset
17992 .cindex "gid (group id)" "system filter"
17993 This option is used only when &%system_filter_user%& is also set. It sets the
17994 gid under which the system filter is run, overriding any gid that is associated
17995 with the user. The value may be numerical or symbolic.
17996
17997 .option system_filter_pipe_transport main string&!! unset
17998 .cindex "&(pipe)& transport" "for system filter"
17999 .vindex "&$address_pipe$&"
18000 This specifies the transport driver that is to be used when a &%pipe%& command
18001 is used in a system filter. During the delivery, the variable &$address_pipe$&
18002 contains the pipe command.
18003
18004
18005 .option system_filter_reply_transport main string&!! unset
18006 .cindex "&(autoreply)& transport" "for system filter"
18007 This specifies the transport driver that is to be used when a &%mail%& command
18008 is used in a system filter.
18009
18010
18011 .option system_filter_user main string unset
18012 .cindex "uid (user id)" "system filter"
18013 If this option is set to root, the system filter is run in the main Exim
18014 delivery process, as root.  Otherwise, the system filter runs in a separate
18015 process, as the given user, defaulting to the Exim run-time user.
18016 Unless the string consists entirely of digits, it
18017 is looked up in the password data. Failure to find the named user causes a
18018 configuration error. The gid is either taken from the password data, or
18019 specified by &%system_filter_group%&. When the uid is specified numerically,
18020 &%system_filter_group%& is required to be set.
18021
18022 If the system filter generates any pipe, file, or reply deliveries, the uid
18023 under which the filter is run is used when transporting them, unless a
18024 transport option overrides.
18025
18026
18027 .option tcp_nodelay main boolean true
18028 .cindex "daemon" "TCP_NODELAY on sockets"
18029 .cindex "Nagle algorithm"
18030 .cindex "TCP_NODELAY on listening sockets"
18031 If this option is set false, it stops the Exim daemon setting the
18032 TCP_NODELAY option on its listening sockets. Setting TCP_NODELAY
18033 turns off the &"Nagle algorithm"&, which is a way of improving network
18034 performance in interactive (character-by-character) situations. Turning it off
18035 should improve Exim's performance a bit, so that is what happens by default.
18036 However, it appears that some broken clients cannot cope, and time out. Hence
18037 this option. It affects only those sockets that are set up for listening by the
18038 daemon. Sockets created by the smtp transport for delivering mail always set
18039 TCP_NODELAY.
18040
18041
18042 .option timeout_frozen_after main time 0s
18043 .cindex "frozen messages" "timing out"
18044 .cindex "timeout" "frozen messages"
18045 If &%timeout_frozen_after%& is set to a time greater than zero, a frozen
18046 message of any kind that has been in the queue for longer than the given time
18047 is automatically cancelled at the next queue run. If the frozen message is a
18048 bounce message, it is just discarded; otherwise, a bounce is sent to the
18049 sender, in a similar manner to cancellation by the &%-Mg%& command line option.
18050 If you want to timeout frozen bounce messages earlier than other kinds of
18051 frozen message, see &%ignore_bounce_errors_after%&.
18052
18053 &*Note:*& the default value of zero means no timeouts; with this setting,
18054 frozen messages remain in the queue forever (except for any frozen bounce
18055 messages that are released by &%ignore_bounce_errors_after%&).
18056
18057
18058 .option timezone main string unset
18059 .cindex "timezone, setting"
18060 .cindex "environment" "values from"
18061 The value of &%timezone%& is used to set the environment variable TZ while
18062 running Exim (if it is different on entry). This ensures that all timestamps
18063 created by Exim are in the required timezone. If you want all your timestamps
18064 to be in UTC (aka GMT) you should set
18065 .code
18066 timezone = UTC
18067 .endd
18068 The default value is taken from TIMEZONE_DEFAULT in &_Local/Makefile_&,
18069 or, if that is not set, from the value of the TZ environment variable when Exim
18070 is built. If &%timezone%& is set to the empty string, either at build or run
18071 time, any existing TZ variable is removed from the environment when Exim
18072 runs. This is appropriate behaviour for obtaining wall-clock time on some, but
18073 unfortunately not all, operating systems.
18074
18075
18076 .option tls_advertise_hosts main "host list&!!" *
18077 .cindex "TLS" "advertising"
18078 .cindex "encryption" "on SMTP connection"
18079 .cindex "SMTP" "encrypted connection"
18080 .cindex "ESMTP extensions" STARTTLS
18081 When Exim is built with support for TLS encrypted connections, the availability
18082 of the STARTTLS command to set up an encrypted session is advertised in
18083 response to EHLO only to those client hosts that match this option. See
18084 chapter &<<CHAPTLS>>& for details of Exim's support for TLS.
18085 Note that the default value requires that a certificate be supplied
18086 using the &%tls_certificate%& option.  If TLS support for incoming connections
18087 is not required the &%tls_advertise_hosts%& option should be set empty.
18088
18089
18090 .option tls_certificate main string list&!! unset
18091 .cindex "TLS" "server certificate; location of"
18092 .cindex "certificate" "server, location of"
18093 The value of this option is expanded, and must then be a list of absolute paths to
18094 files which contain the server's certificates (in PEM format).
18095 Commonly only one file is needed.
18096 The server's private key is also
18097 assumed to be in this file if &%tls_privatekey%& is unset. See chapter
18098 &<<CHAPTLS>>& for further details.
18099
18100 &*Note*&: The certificates defined by this option are used only when Exim is
18101 receiving incoming messages as a server. If you want to supply certificates for
18102 use when sending messages as a client, you must set the &%tls_certificate%&
18103 option in the relevant &(smtp)& transport.
18104
18105 &*Note*&: If you use filenames based on IP addresses, change the list
18106 separator in the usual way (&<<SECTlistsepchange>>&) to avoid confusion under IPv6.
18107
18108 &*Note*&: Under versions of OpenSSL preceding 1.1.1,
18109 when a list of more than one
18110 file is used, the &$tls_in_ourcert$& variable is unreliable.
18111 The macro "_TLS_BAD_MULTICERT_IN_OURCERT" will be defined for those versions.
18112
18113 If the option contains &$tls_out_sni$& and Exim is built against OpenSSL, then
18114 if the OpenSSL build supports TLS extensions and the TLS client sends the
18115 Server Name Indication extension, then this option and others documented in
18116 &<<SECTtlssni>>& will be re-expanded.
18117
18118 If this option is unset or empty a fresh self-signed certificate will be
18119 generated for every connection.
18120
18121 .option tls_crl main string&!! unset
18122 .cindex "TLS" "server certificate revocation list"
18123 .cindex "certificate" "revocation list for server"
18124 This option specifies a certificate revocation list. The expanded value must
18125 be the name of a file that contains CRLs in PEM format.
18126
18127 Under OpenSSL the option can specify a directory with CRL files.
18128
18129 &*Note:*& Under OpenSSL the option must, if given, supply a CRL
18130 for each signing element of the certificate chain (i.e. all but the leaf).
18131 For the file variant this can be multiple PEM blocks in the one file.
18132
18133 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
18134
18135
18136 .option tls_dh_max_bits main integer 2236
18137 .cindex "TLS" "D-H bit count"
18138 The number of bits used for Diffie-Hellman key-exchange may be suggested by
18139 the chosen TLS library.  That value might prove to be too high for
18140 interoperability.  This option provides a maximum clamp on the value
18141 suggested, trading off security for interoperability.
18142
18143 The value must be at least 1024.
18144
18145 The value 2236 was chosen because, at time of adding the option, it was the
18146 hard-coded maximum value supported by the NSS cryptographic library, as used
18147 by Thunderbird, while GnuTLS was suggesting 2432 bits as normal.
18148
18149 If you prefer more security and are willing to break some clients, raise this
18150 number.
18151
18152 Note that the value passed to GnuTLS for *generating* a new prime may be a
18153 little less than this figure, because GnuTLS is inexact and may produce a
18154 larger prime than requested.
18155
18156
18157 .option tls_dhparam main string&!! unset
18158 .cindex "TLS" "D-H parameters for server"
18159 The value of this option is expanded and indicates the source of DH parameters
18160 to be used by Exim.
18161
18162 This option is ignored for GnuTLS version 3.6.0 and later.
18163 The library manages parameter negotiation internally.
18164
18165 &*Note: The Exim Maintainers strongly recommend,
18166 for other TLS library versions,
18167 using a filename with site-generated
18168 local DH parameters*&, which has been supported across all versions of Exim.  The
18169 other specific constants available are a fallback so that even when
18170 "unconfigured", Exim can offer Perfect Forward Secrecy in older ciphersuites in TLS.
18171
18172 If &%tls_dhparam%& is a filename starting with a &`/`&,
18173 then it names a file from which DH
18174 parameters should be loaded.  If the file exists, it should hold a PEM-encoded
18175 PKCS#3 representation of the DH prime.  If the file does not exist, for
18176 OpenSSL it is an error.  For GnuTLS, Exim will attempt to create the file and
18177 fill it with a generated DH prime.  For OpenSSL, if the DH bit-count from
18178 loading the file is greater than &%tls_dh_max_bits%& then it will be ignored,
18179 and treated as though the &%tls_dhparam%& were set to "none".
18180
18181 If this option expands to the string "none", then no DH parameters will be
18182 loaded by Exim.
18183
18184 If this option expands to the string "historic" and Exim is using GnuTLS, then
18185 Exim will attempt to load a file from inside the spool directory.  If the file
18186 does not exist, Exim will attempt to create it.
18187 See section &<<SECTgnutlsparam>>& for further details.
18188
18189 If Exim is using OpenSSL and this option is empty or unset, then Exim will load
18190 a default DH prime; the default is Exim-specific but lacks verifiable provenance.
18191
18192 In older versions of Exim the default was the 2048 bit prime described in section
18193 2.2 of RFC 5114, "2048-bit MODP Group with 224-bit Prime Order Subgroup", which
18194 in IKE is assigned number 23.
18195
18196 Otherwise, the option must expand to the name used by Exim for any of a number
18197 of DH primes specified in RFC 2409, RFC 3526, RFC 5114, RFC 7919, or from other
18198 sources.  As names, Exim uses a standard specified name, else "ike" followed by
18199 the number used by IKE, or "default" which corresponds to
18200 &`exim.dev.20160529.3`&.
18201
18202 The available standard primes are:
18203 &`ffdhe2048`&, &`ffdhe3072`&, &`ffdhe4096`&, &`ffdhe6144`&, &`ffdhe8192`&,
18204 &`ike1`&, &`ike2`&, &`ike5`&,
18205 &`ike14`&, &`ike15`&, &`ike16`&, &`ike17`&, &`ike18`&,
18206 &`ike22`&, &`ike23`& and &`ike24`&.
18207
18208 The available additional primes are:
18209 &`exim.dev.20160529.1`&, &`exim.dev.20160529.2`& and &`exim.dev.20160529.3`&.
18210
18211 Some of these will be too small to be accepted by clients.
18212 Some may be too large to be accepted by clients.
18213 The open cryptographic community has suspicions about the integrity of some
18214 of the later IKE values, which led into RFC7919 providing new fixed constants
18215 (the "ffdhe" identifiers).
18216
18217 At this point, all of the "ike" values should be considered obsolete;
18218 they're still in Exim to avoid breaking unusual configurations, but are
18219 candidates for removal the next time we have backwards-incompatible changes.
18220
18221 The TLS protocol does not negotiate an acceptable size for this; clients tend
18222 to hard-drop connections if what is offered by the server is unacceptable,
18223 whether too large or too small, and there's no provision for the client to
18224 tell the server what these constraints are.  Thus, as a server operator, you
18225 need to make an educated guess as to what is most likely to work for your
18226 userbase.
18227
18228 Some known size constraints suggest that a bit-size in the range 2048 to 2236
18229 is most likely to maximise interoperability.  The upper bound comes from
18230 applications using the Mozilla Network Security Services (NSS) library, which
18231 used to set its &`DH_MAX_P_BITS`& upper-bound to 2236.  This affects many
18232 mail user agents (MUAs). The lower bound comes from Debian installs of Exim4
18233 prior to the 4.80 release, as Debian used to patch Exim to raise the minimum
18234 acceptable bound from 1024 to 2048.
18235
18236
18237 .option tls_eccurve main string&!! &`auto`&
18238 .cindex TLS "EC cryptography"
18239 This option selects a EC curve for use by Exim when used with OpenSSL.
18240 It has no effect when Exim is used with GnuTLS.
18241
18242 After expansion it must contain a valid EC curve parameter, such as
18243 &`prime256v1`&, &`secp384r1`&, or &`P-512`&. Consult your OpenSSL manual
18244 for valid selections.
18245
18246 For OpenSSL versions before (and not including) 1.0.2, the string
18247 &`auto`& selects &`prime256v1`&. For more recent OpenSSL versions
18248 &`auto`& tells the library to choose.
18249
18250 If the option expands to an empty string, no EC curves will be enabled.
18251
18252
18253 .option tls_ocsp_file main string&!! unset
18254 .cindex TLS "certificate status"
18255 .cindex TLS "OCSP proof file"
18256 This option
18257 must if set expand to the absolute path to a file which contains a current
18258 status proof for the server's certificate, as obtained from the
18259 Certificate Authority.
18260
18261 Usable for GnuTLS 3.4.4 or 3.3.17 or OpenSSL 1.1.0 (or later).
18262 The macro "_HAVE_TLS_OCSP" will be defined for those versions.
18263
18264 For OpenSSL 1.1.0 or later, and
18265 for GnuTLS 3.5.6 or later the expanded value of this option can be a list
18266 of files, to match a list given for the &%tls_certificate%& option.
18267 The ordering of the two lists must match.
18268 The macro "_HAVE_TLS_OCSP_LIST" will be defined for those versions.
18269
18270 The file(s) should be in DER format,
18271 except for GnuTLS 3.6.3 or later
18272 or for OpenSSL,
18273 when an optional filetype prefix can be used.
18274 The prefix must be one of "DER" or "PEM", followed by
18275 a single space.  If one is used it sets the format for subsequent
18276 files in the list; the initial format is DER.
18277 If multiple proofs are wanted, for multiple chain elements
18278 (this only works under TLS1.3)
18279 they must be coded as a combined OCSP response.
18280
18281 Although GnuTLS will accept PEM files with multiple separate
18282 PEM blobs (ie. separate OCSP responses), it sends them in the
18283 TLS Certificate record interleaved with the certificates of the chain;
18284 although a GnuTLS client is happy with that, an OpenSSL client is not.
18285
18286 .option tls_on_connect_ports main "string list" unset
18287 .cindex SSMTP
18288 .cindex SMTPS
18289 This option specifies a list of incoming SSMTP (aka SMTPS) ports that should
18290 operate the SSMTP (SMTPS) protocol, where a TLS session is immediately
18291 set up without waiting for the client to issue a STARTTLS command. For
18292 further details, see section &<<SECTsupobssmt>>&.
18293
18294
18295
18296 .option tls_privatekey main string list&!! unset
18297 .cindex "TLS" "server private key; location of"
18298 The value of this option is expanded, and must then be a list of absolute paths to
18299 files which contains the server's private keys.
18300 If this option is unset, or if
18301 the expansion is forced to fail, or the result is an empty string, the private
18302 key is assumed to be in the same file as the server's certificates. See chapter
18303 &<<CHAPTLS>>& for further details.
18304
18305 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
18306
18307
18308 .option tls_remember_esmtp main boolean false
18309 .cindex "TLS" "esmtp state; remembering"
18310 .cindex "TLS" "broken clients"
18311 If this option is set true, Exim violates the RFCs by remembering that it is in
18312 &"esmtp"& state after successfully negotiating a TLS session. This provides
18313 support for broken clients that fail to send a new EHLO after starting a
18314 TLS session.
18315
18316
18317 .option tls_require_ciphers main string&!! unset
18318 .cindex "TLS" "requiring specific ciphers"
18319 .cindex "cipher" "requiring specific"
18320 This option controls which ciphers can be used for incoming TLS connections.
18321 The &(smtp)& transport has an option of the same name for controlling outgoing
18322 connections. This option is expanded for each connection, so can be varied for
18323 different clients if required. The value of this option must be a list of
18324 permitted cipher suites. The OpenSSL and GnuTLS libraries handle cipher control
18325 in somewhat different ways. If GnuTLS is being used, the client controls the
18326 preference order of the available ciphers. Details are given in sections
18327 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
18328
18329
18330 .option tls_try_verify_hosts main "host list&!!" unset
18331 .cindex "TLS" "client certificate verification"
18332 .cindex "certificate" "verification of client"
18333 See &%tls_verify_hosts%& below.
18334
18335
18336 .option tls_verify_certificates main string&!! system
18337 .cindex "TLS" "client certificate verification"
18338 .cindex "certificate" "verification of client"
18339 The value of this option is expanded, and must then be either the
18340 word "system"
18341 or the absolute path to
18342 a file or directory containing permitted certificates for clients that
18343 match &%tls_verify_hosts%& or &%tls_try_verify_hosts%&.
18344
18345 The "system" value for the option will use a
18346 system default location compiled into the SSL library.
18347 This is not available for GnuTLS versions preceding 3.0.20,
18348 and will be taken as empty; an explicit location
18349 must be specified.
18350
18351 The use of a directory for the option value is not available for GnuTLS versions
18352 preceding 3.3.6 and a single file must be used.
18353
18354 With OpenSSL the certificates specified
18355 explicitly
18356 either by file or directory
18357 are added to those given by the system default location.
18358
18359 These certificates should be for the certificate authorities trusted, rather
18360 than the public cert of individual clients.  With both OpenSSL and GnuTLS, if
18361 the value is a file then the certificates are sent by Exim as a server to
18362 connecting clients, defining the list of accepted certificate authorities.
18363 Thus the values defined should be considered public data.  To avoid this,
18364 use the explicit directory version.
18365
18366 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
18367
18368 A forced expansion failure or setting to an empty string is equivalent to
18369 being unset.
18370
18371
18372 .option tls_verify_hosts main "host list&!!" unset
18373 .cindex "TLS" "client certificate verification"
18374 .cindex "certificate" "verification of client"
18375 This option, along with &%tls_try_verify_hosts%&, controls the checking of
18376 certificates from clients. The expected certificates are defined by
18377 &%tls_verify_certificates%&, which must be set. A configuration error occurs if
18378 either &%tls_verify_hosts%& or &%tls_try_verify_hosts%& is set and
18379 &%tls_verify_certificates%& is not set.
18380
18381 Any client that matches &%tls_verify_hosts%& is constrained by
18382 &%tls_verify_certificates%&. When the client initiates a TLS session, it must
18383 present one of the listed certificates. If it does not, the connection is
18384 aborted. &*Warning*&: Including a host in &%tls_verify_hosts%& does not require
18385 the host to use TLS. It can still send SMTP commands through unencrypted
18386 connections. Forcing a client to use TLS has to be done separately using an
18387 ACL to reject inappropriate commands when the connection is not encrypted.
18388
18389 A weaker form of checking is provided by &%tls_try_verify_hosts%&. If a client
18390 matches this option (but not &%tls_verify_hosts%&), Exim requests a
18391 certificate and checks it against &%tls_verify_certificates%&, but does not
18392 abort the connection if there is no certificate or if it does not match. This
18393 state can be detected in an ACL, which makes it possible to implement policies
18394 such as &"accept for relay only if a verified certificate has been received,
18395 but accept for local delivery if encrypted, even without a verified
18396 certificate"&.
18397
18398 Client hosts that match neither of these lists are not asked to present
18399 certificates.
18400
18401
18402 .option trusted_groups main "string list&!!" unset
18403 .cindex "trusted groups"
18404 .cindex "groups" "trusted"
18405 This option is expanded just once, at the start of Exim's processing. If this
18406 option is set, any process that is running in one of the listed groups, or
18407 which has one of them as a supplementary group, is trusted. The groups can be
18408 specified numerically or by name. See section &<<SECTtrustedadmin>>& for
18409 details of what trusted callers are permitted to do. If neither
18410 &%trusted_groups%& nor &%trusted_users%& is set, only root and the Exim user
18411 are trusted.
18412
18413 .option trusted_users main "string list&!!" unset
18414 .cindex "trusted users"
18415 .cindex "user" "trusted"
18416 This option is expanded just once, at the start of Exim's processing. If this
18417 option is set, any process that is running as one of the listed users is
18418 trusted. The users can be specified numerically or by name. See section
18419 &<<SECTtrustedadmin>>& for details of what trusted callers are permitted to do.
18420 If neither &%trusted_groups%& nor &%trusted_users%& is set, only root and the
18421 Exim user are trusted.
18422
18423 .option unknown_login main string&!! unset
18424 .cindex "uid (user id)" "unknown caller"
18425 .vindex "&$caller_uid$&"
18426 This is a specialized feature for use in unusual configurations. By default, if
18427 the uid of the caller of Exim cannot be looked up using &[getpwuid()]&, Exim
18428 gives up. The &%unknown_login%& option can be used to set a login name to be
18429 used in this circumstance. It is expanded, so values like &%user$caller_uid%&
18430 can be set. When &%unknown_login%& is used, the value of &%unknown_username%&
18431 is used for the user's real name (gecos field), unless this has been set by the
18432 &%-F%& option.
18433
18434 .option unknown_username main string unset
18435 See &%unknown_login%&.
18436
18437 .option untrusted_set_sender main "address list&!!" unset
18438 .cindex "trusted users"
18439 .cindex "sender" "setting by untrusted user"
18440 .cindex "untrusted user setting sender"
18441 .cindex "user" "untrusted setting sender"
18442 .cindex "envelope from"
18443 .cindex "envelope sender"
18444 When an untrusted user submits a message to Exim using the standard input, Exim
18445 normally creates an envelope sender address from the user's login and the
18446 default qualification domain. Data from the &%-f%& option (for setting envelope
18447 senders on non-SMTP messages) or the SMTP MAIL command (if &%-bs%& or &%-bS%&
18448 is used) is ignored.
18449
18450 However, untrusted users are permitted to set an empty envelope sender address,
18451 to declare that a message should never generate any bounces. For example:
18452 .code
18453 exim -f '<>' user@domain.example
18454 .endd
18455 .vindex "&$sender_ident$&"
18456 The &%untrusted_set_sender%& option allows you to permit untrusted users to set
18457 other envelope sender addresses in a controlled way. When it is set, untrusted
18458 users are allowed to set envelope sender addresses that match any of the
18459 patterns in the list. Like all address lists, the string is expanded. The
18460 identity of the user is in &$sender_ident$&, so you can, for example, restrict
18461 users to setting senders that start with their login ids
18462 followed by a hyphen
18463 by a setting like this:
18464 .code
18465 untrusted_set_sender = ^$sender_ident-
18466 .endd
18467 If you want to allow untrusted users to set envelope sender addresses without
18468 restriction, you can use
18469 .code
18470 untrusted_set_sender = *
18471 .endd
18472 The &%untrusted_set_sender%& option applies to all forms of local input, but
18473 only to the setting of the envelope sender. It does not permit untrusted users
18474 to use the other options which trusted user can use to override message
18475 parameters. Furthermore, it does not stop Exim from removing an existing
18476 &'Sender:'& header in the message, or from adding a &'Sender:'& header if
18477 necessary. See &%local_sender_retain%& and &%local_from_check%& for ways of
18478 overriding these actions. The handling of the &'Sender:'& header is also
18479 described in section &<<SECTthesenhea>>&.
18480
18481 The log line for a message's arrival shows the envelope sender following
18482 &"<="&. For local messages, the user's login always follows, after &"U="&. In
18483 &%-bp%& displays, and in the Exim monitor, if an untrusted user sets an
18484 envelope sender address, the user's login is shown in parentheses after the
18485 sender address.
18486
18487
18488 .option uucp_from_pattern main string "see below"
18489 .cindex "&""From""& line"
18490 .cindex "UUCP" "&""From""& line"
18491 Some applications that pass messages to an MTA via a command line interface use
18492 an initial line starting with &"From&~"& to pass the envelope sender. In
18493 particular, this is used by UUCP software. Exim recognizes such a line by means
18494 of a regular expression that is set in &%uucp_from_pattern%&. When the pattern
18495 matches, the sender address is constructed by expanding the contents of
18496 &%uucp_from_sender%&, provided that the caller of Exim is a trusted user. The
18497 default pattern recognizes lines in the following two forms:
18498 .code
18499 From ph10 Fri Jan  5 12:35 GMT 1996
18500 From ph10 Fri, 7 Jan 97 14:00:00 GMT
18501 .endd
18502 The pattern can be seen by running
18503 .code
18504 exim -bP uucp_from_pattern
18505 .endd
18506 It checks only up to the hours and minutes, and allows for a 2-digit or 4-digit
18507 year in the second case. The first word after &"From&~"& is matched in the
18508 regular expression by a parenthesized subpattern. The default value for
18509 &%uucp_from_sender%& is &"$1"&, which therefore just uses this first word
18510 (&"ph10"& in the example above) as the message's sender. See also
18511 &%ignore_fromline_hosts%&.
18512
18513
18514 .option uucp_from_sender main string&!! &`$1`&
18515 See &%uucp_from_pattern%& above.
18516
18517
18518 .option warn_message_file main string&!! unset
18519 .cindex "warning of delay" "customizing the message"
18520 .cindex "customizing" "warning message"
18521 This option defines a template file containing paragraphs of text to be used
18522 for constructing the warning message which is sent by Exim when a message has
18523 been in the queue for a specified amount of time, as specified by
18524 &%delay_warning%&. Details of the file's contents are given in chapter
18525 &<<CHAPemsgcust>>&.
18526 .new
18527 .cindex warn_message_file "tainted data"
18528 The option is expanded to give the file path, which must be
18529 absolute and untainted.
18530 .wen
18531 See also &%bounce_message_file%&.
18532
18533
18534 .option write_rejectlog main boolean true
18535 .cindex "reject log" "disabling"
18536 If this option is set false, Exim no longer writes anything to the reject log.
18537 See chapter &<<CHAPlog>>& for details of what Exim writes to its logs.
18538 .ecindex IIDconfima
18539 .ecindex IIDmaiconf
18540
18541
18542
18543
18544 . ////////////////////////////////////////////////////////////////////////////
18545 . ////////////////////////////////////////////////////////////////////////////
18546
18547 .chapter "Generic options for routers" "CHAProutergeneric"
18548 .scindex IIDgenoprou1 "options" "generic; for routers"
18549 .scindex IIDgenoprou2 "generic options" "router"
18550 This chapter describes the generic options that apply to all routers.
18551 Those that are preconditions are marked with &Dagger; in the &"use"& field.
18552
18553 For a general description of how a router operates, see sections
18554 &<<SECTrunindrou>>& and &<<SECTrouprecon>>&. The latter specifies the order in
18555 which the preconditions are tested. The order of expansion of the options that
18556 provide data for a transport is: &%errors_to%&, &%headers_add%&,
18557 &%headers_remove%&, &%transport%&.
18558
18559
18560
18561 .option address_data routers string&!! unset
18562 .cindex "router" "data attached to address"
18563 The string is expanded just before the router is run, that is, after all the
18564 precondition tests have succeeded. If the expansion is forced to fail, the
18565 router declines, the value of &%address_data%& remains unchanged, and the
18566 &%more%& option controls what happens next. Other expansion failures cause
18567 delivery of the address to be deferred.
18568
18569 .vindex "&$address_data$&"
18570 When the expansion succeeds, the value is retained with the address, and can be
18571 accessed using the variable &$address_data$& in the current router, subsequent
18572 routers, and the eventual transport.
18573
18574 &*Warning*&: If the current or any subsequent router is a &(redirect)& router
18575 that runs a user's filter file, the contents of &$address_data$& are accessible
18576 in the filter. This is not normally a problem, because such data is usually
18577 either not confidential or it &"belongs"& to the current user, but if you do
18578 put confidential data into &$address_data$& you need to remember this point.
18579
18580 Even if the router declines or passes, the value of &$address_data$& remains
18581 with the address, though it can be changed by another &%address_data%& setting
18582 on a subsequent router. If a router generates child addresses, the value of
18583 &$address_data$& propagates to them. This also applies to the special kind of
18584 &"child"& that is generated by a router with the &%unseen%& option.
18585
18586 The idea of &%address_data%& is that you can use it to look up a lot of data
18587 for the address once, and then pick out parts of the data later. For example,
18588 you could use a single LDAP lookup to return a string of the form
18589 .code
18590 uid=1234 gid=5678 mailbox=/mail/xyz forward=/home/xyz/.forward
18591 .endd
18592 In the transport you could pick out the mailbox by a setting such as
18593 .code
18594 file = ${extract{mailbox}{$address_data}}
18595 .endd
18596 This makes the configuration file less messy, and also reduces the number of
18597 lookups (though Exim does cache lookups).
18598
18599 See also the &%set%& option below.
18600
18601 .vindex "&$sender_address_data$&"
18602 .vindex "&$address_data$&"
18603 The &%address_data%& facility is also useful as a means of passing information
18604 from one router to another, and from a router to a transport. In addition, if
18605 &$address_data$& is set by a router when verifying a recipient address from an
18606 ACL, it remains available for use in the rest of the ACL statement. After
18607 verifying a sender, the value is transferred to &$sender_address_data$&.
18608
18609
18610
18611 .option address_test routers&!? boolean true
18612 .oindex "&%-bt%&"
18613 .cindex "router" "skipping when address testing"
18614 If this option is set false, the router is skipped when routing is being tested
18615 by means of the &%-bt%& command line option. This can be a convenience when
18616 your first router sends messages to an external scanner, because it saves you
18617 having to set the &"already scanned"& indicator when testing real address
18618 routing.
18619
18620
18621
18622 .option cannot_route_message routers string&!! unset
18623 .cindex "router" "customizing &""cannot route""& message"
18624 .cindex "customizing" "&""cannot route""& message"
18625 This option specifies a text message that is used when an address cannot be
18626 routed because Exim has run out of routers. The default message is
18627 &"Unrouteable address"&. This option is useful only on routers that have
18628 &%more%& set false, or on the very last router in a configuration, because the
18629 value that is used is taken from the last router that is considered. This
18630 includes a router that is skipped because its preconditions are not met, as
18631 well as a router that declines. For example, using the default configuration,
18632 you could put:
18633 .code
18634 cannot_route_message = Remote domain not found in DNS
18635 .endd
18636 on the first router, which is a &(dnslookup)& router with &%more%& set false,
18637 and
18638 .code
18639 cannot_route_message = Unknown local user
18640 .endd
18641 on the final router that checks for local users. If string expansion fails for
18642 this option, the default message is used. Unless the expansion failure was
18643 explicitly forced, a message about the failure is written to the main and panic
18644 logs, in addition to the normal message about the routing failure.
18645
18646
18647 .option caseful_local_part routers boolean false
18648 .cindex "case of local parts"
18649 .cindex "router" "case of local parts"
18650 By default, routers handle the local parts of addresses in a case-insensitive
18651 manner, though the actual case is preserved for transmission with the message.
18652 If you want the case of letters to be significant in a router, you must set
18653 this option true. For individual router options that contain address or local
18654 part lists (for example, &%local_parts%&), case-sensitive matching can be
18655 turned on by &"+caseful"& as a list item. See section &<<SECTcasletadd>>& for
18656 more details.
18657
18658 .vindex "&$local_part$&"
18659 .vindex "&$original_local_part$&"
18660 .vindex "&$parent_local_part$&"
18661 The value of the &$local_part$& variable is forced to lower case while a
18662 router is running unless &%caseful_local_part%& is set. When a router assigns
18663 an address to a transport, the value of &$local_part$& when the transport runs
18664 is the same as it was in the router. Similarly, when a router generates child
18665 addresses by aliasing or forwarding, the values of &$original_local_part$&
18666 and &$parent_local_part$& are those that were used by the redirecting router.
18667
18668 This option applies to the processing of an address by a router. When a
18669 recipient address is being processed in an ACL, there is a separate &%control%&
18670 modifier that can be used to specify case-sensitive processing within the ACL
18671 (see section &<<SECTcontrols>>&).
18672
18673
18674
18675 .option check_local_user routers&!? boolean false
18676 .cindex "local user, checking in router"
18677 .cindex "router" "checking for local user"
18678 .cindex "&_/etc/passwd_&"
18679 .vindex "&$home$&"
18680 When this option is true, Exim checks that the local part of the recipient
18681 address (with affixes removed if relevant) is the name of an account on the
18682 local system. The check is done by calling the &[getpwnam()]& function rather
18683 than trying to read &_/etc/passwd_& directly. This means that other methods of
18684 holding password data (such as NIS) are supported. If the local part is a local
18685 user, &$home$& is set from the password data, and can be tested in other
18686 preconditions that are evaluated after this one (the order of evaluation is
18687 given in section &<<SECTrouprecon>>&). However, the value of &$home$& can be
18688 overridden by &%router_home_directory%&. If the local part is not a local user,
18689 the router is skipped.
18690
18691 If you want to check that the local part is either the name of a local user
18692 or matches something else, you cannot combine &%check_local_user%& with a
18693 setting of &%local_parts%&, because that specifies the logical &'and'& of the
18694 two conditions. However, you can use a &(passwd)& lookup in a &%local_parts%&
18695 setting to achieve this. For example:
18696 .code
18697 local_parts = passwd;$local_part : lsearch;/etc/other/users
18698 .endd
18699 Note, however, that the side effects of &%check_local_user%& (such as setting
18700 up a home directory) do not occur when a &(passwd)& lookup is used in a
18701 &%local_parts%& (or any other) precondition.
18702
18703
18704
18705 .option condition routers&!? string&!! unset
18706 .cindex "router" "customized precondition"
18707 This option specifies a general precondition test that has to succeed for the
18708 router to be called. The &%condition%& option is the last precondition to be
18709 evaluated (see section &<<SECTrouprecon>>&). The string is expanded, and if the
18710 result is a forced failure, or an empty string, or one of the strings &"0"& or
18711 &"no"& or &"false"& (checked without regard to the case of the letters), the
18712 router is skipped, and the address is offered to the next one.
18713
18714 If the result is any other value, the router is run (as this is the last
18715 precondition to be evaluated, all the other preconditions must be true).
18716
18717 This option is unusual in that multiple &%condition%& options may be present.
18718 All &%condition%& options must succeed.
18719
18720 The &%condition%& option provides a means of applying custom conditions to the
18721 running of routers. Note that in the case of a simple conditional expansion,
18722 the default expansion values are exactly what is wanted. For example:
18723 .code
18724 condition = ${if >{$message_age}{600}}
18725 .endd
18726 Because of the default behaviour of the string expansion, this is equivalent to
18727 .code
18728 condition = ${if >{$message_age}{600}{true}{}}
18729 .endd
18730
18731 A multiple condition example, which succeeds:
18732 .code
18733 condition = ${if >{$message_age}{600}}
18734 condition = ${if !eq{${lc:$local_part}}{postmaster}}
18735 condition = foobar
18736 .endd
18737
18738 If the expansion fails (other than forced failure) delivery is deferred. Some
18739 of the other precondition options are common special cases that could in fact
18740 be specified using &%condition%&.
18741
18742 Historical note: We have &%condition%& on ACLs and on Routers.  Routers
18743 are far older, and use one set of semantics.  ACLs are newer and when
18744 they were created, the ACL &%condition%& process was given far stricter
18745 parse semantics.  The &%bool{}%& expansion condition uses the same rules as
18746 ACLs.  The &%bool_lax{}%& expansion condition uses the same rules as
18747 Routers.  More pointedly, the &%bool_lax{}%& was written to match the existing
18748 Router rules processing behavior.
18749
18750 This is best illustrated in an example:
18751 .code
18752 # If used in an ACL condition will fail with a syntax error, but
18753 # in a router condition any extra characters are treated as a string
18754
18755 $ exim -be '${if eq {${lc:GOOGLE.com}} {google.com}} {yes} {no}}'
18756 true {yes} {no}}
18757
18758 $ exim -be '${if eq {${lc:WHOIS.com}} {google.com}} {yes} {no}}'
18759  {yes} {no}}
18760 .endd
18761 In each example above, the &%if%& statement actually ends after
18762 &"{google.com}}"&.  Since no true or false braces were defined, the
18763 default &%if%& behavior is to return a boolean true or a null answer
18764 (which evaluates to false). The rest of the line is then treated as a
18765 string. So the first example resulted in the boolean answer &"true"&
18766 with the string &" {yes} {no}}"& appended to it. The second example
18767 resulted in the null output (indicating false) with the string
18768 &" {yes} {no}}"& appended to it.
18769
18770 In fact you can put excess forward braces in too.  In the router
18771 &%condition%&, Exim's parser only looks for &"{"& symbols when they
18772 mean something, like after a &"$"& or when required as part of a
18773 conditional.  But otherwise &"{"& and &"}"& are treated as ordinary
18774 string characters.
18775
18776 Thus, in a Router, the above expansion strings will both always evaluate
18777 true, as the result of expansion is a non-empty string which doesn't
18778 match an explicit false value.  This can be tricky to debug.  By
18779 contrast, in an ACL either of those strings will always result in an
18780 expansion error because the result doesn't look sufficiently boolean.
18781
18782
18783 .option debug_print routers string&!! unset
18784 .cindex "testing" "variables in drivers"
18785 If this option is set and debugging is enabled (see the &%-d%& command line
18786 option) or in address-testing mode (see the &%-bt%& command line option),
18787 the string is expanded and included in the debugging output.
18788 If expansion of the string fails, the error message is written to the debugging
18789 output, and Exim carries on processing.
18790 This option is provided to help with checking out the values of variables and
18791 so on when debugging router configurations. For example, if a &%condition%&
18792 option appears not to be working, &%debug_print%& can be used to output the
18793 variables it references. The output happens after checks for &%domains%&,
18794 &%local_parts%&, and &%check_local_user%& but before any other preconditions
18795 are tested. A newline is added to the text if it does not end with one.
18796 The variable &$router_name$& contains the name of the router.
18797
18798
18799
18800 .option disable_logging routers boolean false
18801 If this option is set true, nothing is logged for any routing errors
18802 or for any deliveries caused by this router. You should not set this option
18803 unless you really, really know what you are doing. See also the generic
18804 transport option of the same name.
18805
18806 .option dnssec_request_domains routers "domain list&!!" *
18807 .cindex "MX record" "security"
18808 .cindex "DNSSEC" "MX lookup"
18809 .cindex "security" "MX lookup"
18810 .cindex "DNS" "DNSSEC"
18811 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
18812 the dnssec request bit set.
18813 This applies to all of the SRV, MX, AAAA, A lookup sequence.
18814
18815 .option dnssec_require_domains routers "domain list&!!" unset
18816 .cindex "MX record" "security"
18817 .cindex "DNSSEC" "MX lookup"
18818 .cindex "security" "MX lookup"
18819 .cindex "DNS" "DNSSEC"
18820 DNS lookups for domains matching &%dnssec_require_domains%& will be done with
18821 the dnssec request bit set.  Any returns not having the Authenticated Data bit
18822 (AD bit) set will be ignored and logged as a host-lookup failure.
18823 This applies to all of the SRV, MX, AAAA, A lookup sequence.
18824
18825
18826 .option domains routers&!? "domain list&!!" unset
18827 .cindex "router" "restricting to specific domains"
18828 .vindex "&$domain_data$&"
18829 If this option is set, the router is skipped unless the current domain matches
18830 the list. If the match is achieved by means of a file lookup, the data that the
18831 lookup returned for the domain is placed in &$domain_data$& for use in string
18832 expansions of the driver's private options. See section &<<SECTrouprecon>>& for
18833 a list of the order in which preconditions are evaluated.
18834
18835
18836
18837 .option driver routers string unset
18838 This option must always be set. It specifies which of the available routers is
18839 to be used.
18840
18841
18842 .option dsn_lasthop routers boolean false
18843 .cindex "DSN" "success"
18844 .cindex "Delivery Status Notification" "success"
18845 If this option is set true, and extended DSN (RFC3461) processing is in effect,
18846 Exim will not pass on DSN requests to downstream DSN-aware hosts but will
18847 instead send a success DSN as if the next hop does not support DSN.
18848 Not effective on redirect routers.
18849
18850
18851
18852 .option errors_to routers string&!! unset
18853 .cindex "envelope from"
18854 .cindex "envelope sender"
18855 .cindex "router" "changing address for errors"
18856 If a router successfully handles an address, it may assign the address to a
18857 transport for delivery or it may generate child addresses. In both cases, if
18858 there is a delivery problem during later processing, the resulting bounce
18859 message is sent to the address that results from expanding this string,
18860 provided that the address verifies successfully. The &%errors_to%& option is
18861 expanded before &%headers_add%&, &%headers_remove%&, and &%transport%&.
18862
18863 The &%errors_to%& setting associated with an address can be overridden if it
18864 subsequently passes through other routers that have their own &%errors_to%&
18865 settings, or if the message is delivered by a transport with a &%return_path%&
18866 setting.
18867
18868 If &%errors_to%& is unset, or the expansion is forced to fail, or the result of
18869 the expansion fails to verify, the errors address associated with the incoming
18870 address is used. At top level, this is the envelope sender. A non-forced
18871 expansion failure causes delivery to be deferred.
18872
18873 If an address for which &%errors_to%& has been set ends up being delivered over
18874 SMTP, the envelope sender for that delivery is the &%errors_to%& value, so that
18875 any bounces that are generated by other MTAs on the delivery route are also
18876 sent there. You can set &%errors_to%& to the empty string by either of these
18877 settings:
18878 .code
18879 errors_to =
18880 errors_to = ""
18881 .endd
18882 An expansion item that yields an empty string has the same effect. If you do
18883 this, a locally detected delivery error for addresses processed by this router
18884 no longer gives rise to a bounce message; the error is discarded. If the
18885 address is delivered to a remote host, the return path is set to &`<>`&, unless
18886 overridden by the &%return_path%& option on the transport.
18887
18888 .vindex "&$address_data$&"
18889 If for some reason you want to discard local errors, but use a non-empty
18890 MAIL command for remote delivery, you can preserve the original return
18891 path in &$address_data$& in the router, and reinstate it in the transport by
18892 setting &%return_path%&.
18893
18894 The most common use of &%errors_to%& is to direct mailing list bounces to the
18895 manager of the list, as described in section &<<SECTmailinglists>>&, or to
18896 implement VERP (Variable Envelope Return Paths) (see section &<<SECTverp>>&).
18897
18898
18899
18900 .option expn routers&!? boolean true
18901 .cindex "address" "testing"
18902 .cindex "testing" "addresses"
18903 .cindex "EXPN" "router skipping"
18904 .cindex "router" "skipping for EXPN"
18905 If this option is turned off, the router is skipped when testing an address
18906 as a result of processing an SMTP EXPN command. You might, for example,
18907 want to turn it off on a router for users' &_.forward_& files, while leaving it
18908 on for the system alias file.
18909 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
18910 are evaluated.
18911
18912 The use of the SMTP EXPN command is controlled by an ACL (see chapter
18913 &<<CHAPACL>>&). When Exim is running an EXPN command, it is similar to testing
18914 an address with &%-bt%&. Compare VRFY, whose counterpart is &%-bv%&.
18915
18916
18917
18918 .option fail_verify routers boolean false
18919 .cindex "router" "forcing verification failure"
18920 Setting this option has the effect of setting both &%fail_verify_sender%& and
18921 &%fail_verify_recipient%& to the same value.
18922
18923
18924
18925 .option fail_verify_recipient routers boolean false
18926 If this option is true and an address is accepted by this router when
18927 verifying a recipient, verification fails.
18928
18929
18930
18931 .option fail_verify_sender routers boolean false
18932 If this option is true and an address is accepted by this router when
18933 verifying a sender, verification fails.
18934
18935
18936
18937 .option fallback_hosts routers "string list" unset
18938 .cindex "router" "fallback hosts"
18939 .cindex "fallback" "hosts specified on router"
18940 String expansion is not applied to this option. The argument must be a
18941 colon-separated list of host names or IP addresses. The list separator can be
18942 changed (see section &<<SECTlistsepchange>>&), and a port can be specified with
18943 each name or address. In fact, the format of each item is exactly the same as
18944 defined for the list of hosts in a &(manualroute)& router (see section
18945 &<<SECTformatonehostitem>>&).
18946
18947 If a router queues an address for a remote transport, this host list is
18948 associated with the address, and used instead of the transport's fallback host
18949 list. If &%hosts_randomize%& is set on the transport, the order of the list is
18950 randomized for each use. See the &%fallback_hosts%& option of the &(smtp)&
18951 transport for further details.
18952
18953
18954 .option group routers string&!! "see below"
18955 .cindex "gid (group id)" "local delivery"
18956 .cindex "local transports" "uid and gid"
18957 .cindex "transport" "local"
18958 .cindex "router" "setting group"
18959 When a router queues an address for a transport, and the transport does not
18960 specify a group, the group given here is used when running the delivery
18961 process.
18962 The group may be specified numerically or by name. If expansion fails, the
18963 error is logged and delivery is deferred.
18964 The default is unset, unless &%check_local_user%& is set, when the default
18965 is taken from the password information. See also &%initgroups%& and &%user%&
18966 and the discussion in chapter &<<CHAPenvironment>>&.
18967
18968
18969
18970 .option headers_add routers list&!! unset
18971 .cindex "header lines" "adding"
18972 .cindex "router" "adding header lines"
18973 This option specifies a list of text headers,
18974 newline-separated (by default, changeable in the usual way &<<SECTlistsepchange>>&),
18975 that is associated with any addresses that are accepted by the router.
18976 Each item is separately expanded, at routing time.  However, this
18977 option has no effect when an address is just being verified. The way in which
18978 the text is used to add header lines at transport time is described in section
18979 &<<SECTheadersaddrem>>&. New header lines are not actually added until the
18980 message is in the process of being transported. This means that references to
18981 header lines in string expansions in the transport's configuration do not
18982 &"see"& the added header lines.
18983
18984 The &%headers_add%& option is expanded after &%errors_to%&, but before
18985 &%headers_remove%& and &%transport%&. If an item is empty, or if
18986 an item expansion is forced to fail, the item has no effect. Other expansion
18987 failures are treated as configuration errors.
18988
18989 Unlike most options, &%headers_add%& can be specified multiple times
18990 for a router; all listed headers are added.
18991
18992 &*Warning 1*&: The &%headers_add%& option cannot be used for a &(redirect)&
18993 router that has the &%one_time%& option set.
18994
18995 .cindex "duplicate addresses"
18996 .oindex "&%unseen%&"
18997 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
18998 additions are deleted when the address is passed on to subsequent routers.
18999 For a &%redirect%& router, if a generated address is the same as the incoming
19000 address, this can lead to duplicate addresses with different header
19001 modifications. Exim does not do duplicate deliveries (except, in certain
19002 circumstances, to pipes -- see section &<<SECTdupaddr>>&), but it is undefined
19003 which of the duplicates is discarded, so this ambiguous situation should be
19004 avoided. The &%repeat_use%& option of the &%redirect%& router may be of help.
19005
19006
19007
19008 .option headers_remove routers list&!! unset
19009 .cindex "header lines" "removing"
19010 .cindex "router" "removing header lines"
19011 This option specifies a list of text headers,
19012 colon-separated (by default, changeable in the usual way &<<SECTlistsepchange>>&),
19013 that is associated with any addresses that are accepted by the router.
19014 However, the option has no effect when an address is just being verified.
19015 Each list item is separately expanded, at transport time.
19016 .new
19017 If an item ends in *, it will match any header with the given prefix.
19018 .wen
19019 The way in which
19020 the text is used to remove header lines at transport time is described in
19021 section &<<SECTheadersaddrem>>&. Header lines are not actually removed until
19022 the message is in the process of being transported. This means that references
19023 to header lines in string expansions in the transport's configuration still
19024 &"see"& the original header lines.
19025
19026 The &%headers_remove%& option is handled after &%errors_to%& and
19027 &%headers_add%&, but before &%transport%&. If an item expansion is forced to fail,
19028 the item has no effect. Other expansion failures are treated as configuration
19029 errors.
19030
19031 Unlike most options, &%headers_remove%& can be specified multiple times
19032 for a router; all listed headers are removed.
19033
19034 &*Warning 1*&: The &%headers_remove%& option cannot be used for a &(redirect)&
19035 router that has the &%one_time%& option set.
19036
19037 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
19038 removal requests are deleted when the address is passed on to subsequent
19039 routers, and this can lead to problems with duplicates -- see the similar
19040 warning for &%headers_add%& above.
19041
19042 &*Warning 3*&: Because of the separate expansion of the list items,
19043 items that contain a list separator must have it doubled.
19044 To avoid this, change the list separator (&<<SECTlistsepchange>>&).
19045
19046
19047
19048 .option ignore_target_hosts routers "host list&!!" unset
19049 .cindex "IP address" "discarding"
19050 .cindex "router" "discarding IP addresses"
19051 Although this option is a host list, it should normally contain IP address
19052 entries rather than names. If any host that is looked up by the router has an
19053 IP address that matches an item in this list, Exim behaves as if that IP
19054 address did not exist. This option allows you to cope with rogue DNS entries
19055 like
19056 .code
19057 remote.domain.example.  A  127.0.0.1
19058 .endd
19059 by setting
19060 .code
19061 ignore_target_hosts = 127.0.0.1
19062 .endd
19063 on the relevant router. If all the hosts found by a &(dnslookup)& router are
19064 discarded in this way, the router declines. In a conventional configuration, an
19065 attempt to mail to such a domain would normally provoke the &"unrouteable
19066 domain"& error, and an attempt to verify an address in the domain would fail.
19067 Similarly, if &%ignore_target_hosts%& is set on an &(ipliteral)& router, the
19068 router declines if presented with one of the listed addresses.
19069
19070 You can use this option to disable the use of IPv4 or IPv6 for mail delivery by
19071 means of the first or the second of the following settings, respectively:
19072 .code
19073 ignore_target_hosts = 0.0.0.0/0
19074 ignore_target_hosts = <; 0::0/0
19075 .endd
19076 The pattern in the first line matches all IPv4 addresses, whereas the pattern
19077 in the second line matches all IPv6 addresses.
19078
19079 This option may also be useful for ignoring link-local and site-local IPv6
19080 addresses. Because, like all host lists, the value of &%ignore_target_hosts%&
19081 is expanded before use as a list, it is possible to make it dependent on the
19082 domain that is being routed.
19083
19084 .vindex "&$host_address$&"
19085 During its expansion, &$host_address$& is set to the IP address that is being
19086 checked.
19087
19088 .option initgroups routers boolean false
19089 .cindex "additional groups"
19090 .cindex "groups" "additional"
19091 .cindex "local transports" "uid and gid"
19092 .cindex "transport" "local"
19093 If the router queues an address for a transport, and this option is true, and
19094 the uid supplied by the router is not overridden by the transport, the
19095 &[initgroups()]& function is called when running the transport to ensure that
19096 any additional groups associated with the uid are set up. See also &%group%&
19097 and &%user%& and the discussion in chapter &<<CHAPenvironment>>&.
19098
19099
19100
19101 .option local_part_prefix routers&!? "string list" unset
19102 .cindex affix "router precondition"
19103 .cindex "router" "prefix for local part"
19104 .cindex "prefix" "for local part, used in router"
19105 If this option is set, the router is skipped unless the local part starts with
19106 one of the given strings, or &%local_part_prefix_optional%& is true. See
19107 section &<<SECTrouprecon>>& for a list of the order in which preconditions are
19108 evaluated.
19109
19110 The list is scanned from left to right, and the first prefix that matches is
19111 used. A limited form of wildcard is available; if the prefix begins with an
19112 asterisk, it matches the longest possible sequence of arbitrary characters at
19113 the start of the local part. An asterisk should therefore always be followed by
19114 some character that does not occur in normal local parts.
19115 .cindex "multiple mailboxes"
19116 .cindex "mailbox" "multiple"
19117 Wildcarding can be used to set up multiple user mailboxes, as described in
19118 section &<<SECTmulbox>>&.
19119
19120 .vindex "&$local_part$&"
19121 .vindex "&$local_part_prefix$&"
19122 During the testing of the &%local_parts%& option, and while the router is
19123 running, the prefix is removed from the local part, and is available in the
19124 expansion variable &$local_part_prefix$&. When a message is being delivered, if
19125 the router accepts the address, this remains true during subsequent delivery by
19126 a transport. In particular, the local part that is transmitted in the RCPT
19127 command for LMTP, SMTP, and BSMTP deliveries has the prefix removed by default.
19128 This behaviour can be overridden by setting &%rcpt_include_affixes%& true on
19129 the relevant transport.
19130
19131 .new
19132 .vindex &$local_part_prefix_v$&
19133 If wildcarding (above) was used then the part of the prefix matching the
19134 wildcard is available in &$local_part_prefix_v$&.
19135 .wen
19136
19137 When an address is being verified, &%local_part_prefix%& affects only the
19138 behaviour of the router. If the callout feature of verification is in use, this
19139 means that the full address, including the prefix, will be used during the
19140 callout.
19141
19142 The prefix facility is commonly used to handle local parts of the form
19143 &%owner-something%&. Another common use is to support local parts of the form
19144 &%real-username%& to bypass a user's &_.forward_& file &-- helpful when trying
19145 to tell a user their forwarding is broken &-- by placing a router like this one
19146 immediately before the router that handles &_.forward_& files:
19147 .code
19148 real_localuser:
19149   driver = accept
19150   local_part_prefix = real-
19151   check_local_user
19152   transport = local_delivery
19153 .endd
19154 For security, it would probably be a good idea to restrict the use of this
19155 router to locally-generated messages, using a condition such as this:
19156 .code
19157   condition = ${if match {$sender_host_address}\
19158                          {\N^(|127\.0\.0\.1)$\N}}
19159 .endd
19160
19161 If both &%local_part_prefix%& and &%local_part_suffix%& are set for a router,
19162 both conditions must be met if not optional. Care must be taken if wildcards
19163 are used in both a prefix and a suffix on the same router. Different
19164 separator characters must be used to avoid ambiguity.
19165
19166
19167 .option local_part_prefix_optional routers boolean false
19168 See &%local_part_prefix%& above.
19169
19170
19171
19172 .option local_part_suffix routers&!? "string list" unset
19173 .cindex "router" "suffix for local part"
19174 .cindex "suffix for local part" "used in router"
19175 This option operates in the same way as &%local_part_prefix%&, except that the
19176 local part must end (rather than start) with the given string, the
19177 &%local_part_suffix_optional%& option determines whether the suffix is
19178 mandatory, and the wildcard * character, if present, must be the last
19179 character of the suffix. This option facility is commonly used to handle local
19180 parts of the form &%something-request%& and multiple user mailboxes of the form
19181 &%username-foo%&.
19182
19183
19184 .option local_part_suffix_optional routers boolean false
19185 See &%local_part_suffix%& above.
19186
19187
19188
19189 .option local_parts routers&!? "local part list&!!" unset
19190 .cindex "router" "restricting to specific local parts"
19191 .cindex "local part" "checking in router"
19192 The router is run only if the local part of the address matches the list.
19193 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
19194 are evaluated, and
19195 section &<<SECTlocparlis>>& for a discussion of local part lists. Because the
19196 string is expanded, it is possible to make it depend on the domain, for
19197 example:
19198 .code
19199 local_parts = dbm;/usr/local/specials/$domain
19200 .endd
19201 .vindex "&$local_part_data$&"
19202 If the match is achieved by a lookup, the data that the lookup returned
19203 for the local part is placed in the variable &$local_part_data$& for use in
19204 expansions of the router's private options. You might use this option, for
19205 example, if you have a large number of local virtual domains, and you want to
19206 send all postmaster mail to the same place without having to set up an alias in
19207 each virtual domain:
19208 .code
19209 postmaster:
19210   driver = redirect
19211   local_parts = postmaster
19212   data = postmaster@real.domain.example
19213 .endd
19214
19215
19216 .option log_as_local routers boolean "see below"
19217 .cindex "log" "delivery line"
19218 .cindex "delivery" "log line format"
19219 Exim has two logging styles for delivery, the idea being to make local
19220 deliveries stand out more visibly from remote ones. In the &"local"& style, the
19221 recipient address is given just as the local part, without a domain. The use of
19222 this style is controlled by this option. It defaults to true for the &(accept)&
19223 router, and false for all the others. This option applies only when a
19224 router assigns an address to a transport. It has no effect on routers that
19225 redirect addresses.
19226
19227
19228
19229 .option more routers boolean&!! true
19230 The result of string expansion for this option must be a valid boolean value,
19231 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
19232 result causes an error, and delivery is deferred. If the expansion is forced to
19233 fail, the default value for the option (true) is used. Other failures cause
19234 delivery to be deferred.
19235
19236 If this option is set false, and the router declines to handle the address, no
19237 further routers are tried, routing fails, and the address is bounced.
19238 .oindex "&%self%&"
19239 However, if the router explicitly passes an address to the following router by
19240 means of the setting
19241 .code
19242 self = pass
19243 .endd
19244 or otherwise, the setting of &%more%& is ignored. Also, the setting of &%more%&
19245 does not affect the behaviour if one of the precondition tests fails. In that
19246 case, the address is always passed to the next router.
19247
19248 Note that &%address_data%& is not considered to be a precondition. If its
19249 expansion is forced to fail, the router declines, and the value of &%more%&
19250 controls what happens next.
19251
19252
19253 .option pass_on_timeout routers boolean false
19254 .cindex "timeout" "of router"
19255 .cindex "router" "timeout"
19256 If a router times out during a host lookup, it normally causes deferral of the
19257 address. If &%pass_on_timeout%& is set, the address is passed on to the next
19258 router, overriding &%no_more%&. This may be helpful for systems that are
19259 intermittently connected to the Internet, or those that want to pass to a smart
19260 host any messages that cannot immediately be delivered.
19261
19262 There are occasional other temporary errors that can occur while doing DNS
19263 lookups. They are treated in the same way as a timeout, and this option
19264 applies to all of them.
19265
19266
19267
19268 .option pass_router routers string unset
19269 .cindex "router" "go to after &""pass""&"
19270 Routers that recognize the generic &%self%& option (&(dnslookup)&,
19271 &(ipliteral)&, and &(manualroute)&) are able to return &"pass"&, forcing
19272 routing to continue, and overriding a false setting of &%more%&. When one of
19273 these routers returns &"pass"&, the address is normally handed on to the next
19274 router in sequence. This can be changed by setting &%pass_router%& to the name
19275 of another router. However (unlike &%redirect_router%&) the named router must
19276 be below the current router, to avoid loops. Note that this option applies only
19277 to the special case of &"pass"&. It does not apply when a router returns
19278 &"decline"& because it cannot handle an address.
19279
19280
19281
19282 .option redirect_router routers string unset
19283 .cindex "router" "start at after redirection"
19284 Sometimes an administrator knows that it is pointless to reprocess addresses
19285 generated from alias or forward files with the same router again. For
19286 example, if an alias file translates real names into login ids there is no
19287 point searching the alias file a second time, especially if it is a large file.
19288
19289 The &%redirect_router%& option can be set to the name of any router instance.
19290 It causes the routing of any generated addresses to start at the named router
19291 instead of at the first router. This option has no effect if the router in
19292 which it is set does not generate new addresses.
19293
19294
19295
19296 .option require_files routers&!? "string list&!!" unset
19297 .cindex "file" "requiring for router"
19298 .cindex "router" "requiring file existence"
19299 This option provides a general mechanism for predicating the running of a
19300 router on the existence or non-existence of certain files or directories.
19301 Before running a router, as one of its precondition tests, Exim works its way
19302 through the &%require_files%& list, expanding each item separately.
19303
19304 Because the list is split before expansion, any colons in expansion items must
19305 be doubled, or the facility for using a different list separator must be used
19306 (&<<SECTlistsepchange>>&).
19307 If any expansion is forced to fail, the item is ignored. Other expansion
19308 failures cause routing of the address to be deferred.
19309
19310 If any expanded string is empty, it is ignored. Otherwise, except as described
19311 below, each string must be a fully qualified file path, optionally preceded by
19312 &"!"&. The paths are passed to the &[stat()]& function to test for the
19313 existence of the files or directories. The router is skipped if any paths not
19314 preceded by &"!"& do not exist, or if any paths preceded by &"!"& do exist.
19315
19316 .cindex "NFS"
19317 If &[stat()]& cannot determine whether a file exists or not, delivery of
19318 the message is deferred. This can happen when NFS-mounted filesystems are
19319 unavailable.
19320
19321 This option is checked after the &%domains%&, &%local_parts%&, and &%senders%&
19322 options, so you cannot use it to check for the existence of a file in which to
19323 look up a domain, local part, or sender. (See section &<<SECTrouprecon>>& for a
19324 full list of the order in which preconditions are evaluated.) However, as
19325 these options are all expanded, you can use the &%exists%& expansion condition
19326 to make such tests. The &%require_files%& option is intended for checking files
19327 that the router may be going to use internally, or which are needed by a
19328 transport (e.g., &_.procmailrc_&).
19329
19330 During delivery, the &[stat()]& function is run as root, but there is a
19331 facility for some checking of the accessibility of a file by another user.
19332 This is not a proper permissions check, but just a &"rough"& check that
19333 operates as follows:
19334
19335 If an item in a &%require_files%& list does not contain any forward slash
19336 characters, it is taken to be the user (and optional group, separated by a
19337 comma) to be checked for subsequent files in the list. If no group is specified
19338 but the user is specified symbolically, the gid associated with the uid is
19339 used. For example:
19340 .code
19341 require_files = mail:/some/file
19342 require_files = $local_part_data:$home/.procmailrc
19343 .endd
19344 If a user or group name in a &%require_files%& list does not exist, the
19345 &%require_files%& condition fails.
19346
19347 Exim performs the check by scanning along the components of the file path, and
19348 checking the access for the given uid and gid. It checks for &"x"& access on
19349 directories, and &"r"& access on the final file. Note that this means that file
19350 access control lists, if the operating system has them, are ignored.
19351
19352 &*Warning 1*&: When the router is being run to verify addresses for an
19353 incoming SMTP message, Exim is not running as root, but under its own uid. This
19354 may affect the result of a &%require_files%& check. In particular, &[stat()]&
19355 may yield the error EACCES (&"Permission denied"&). This means that the Exim
19356 user is not permitted to read one of the directories on the file's path.
19357
19358 &*Warning 2*&: Even when Exim is running as root while delivering a message,
19359 &[stat()]& can yield EACCES for a file in an NFS directory that is mounted
19360 without root access. In this case, if a check for access by a particular user
19361 is requested, Exim creates a subprocess that runs as that user, and tries the
19362 check again in that process.
19363
19364 The default action for handling an unresolved EACCES is to consider it to
19365 be caused by a configuration error, and routing is deferred because the
19366 existence or non-existence of the file cannot be determined. However, in some
19367 circumstances it may be desirable to treat this condition as if the file did
19368 not exist. If the filename (or the exclamation mark that precedes the filename
19369 for non-existence) is preceded by a plus sign, the EACCES error is treated
19370 as if the file did not exist. For example:
19371 .code
19372 require_files = +/some/file
19373 .endd
19374 If the router is not an essential part of verification (for example, it
19375 handles users' &_.forward_& files), another solution is to set the &%verify%&
19376 option false so that the router is skipped when verifying.
19377
19378
19379
19380 .option retry_use_local_part routers boolean "see below"
19381 .cindex "hints database" "retry keys"
19382 .cindex "local part" "in retry keys"
19383 When a delivery suffers a temporary routing failure, a retry record is created
19384 in Exim's hints database. For addresses whose routing depends only on the
19385 domain, the key for the retry record should not involve the local part, but for
19386 other addresses, both the domain and the local part should be included.
19387 Usually, remote routing is of the former kind, and local routing is of the
19388 latter kind.
19389
19390 This option controls whether the local part is used to form the key for retry
19391 hints for addresses that suffer temporary errors while being handled by this
19392 router. The default value is true for any router that has any of
19393 &%check_local_user%&,
19394 &%local_parts%&,
19395 &%condition%&,
19396 &%local_part_prefix%&,
19397 &%local_part_suffix%&,
19398 &%senders%& or
19399 &%require_files%&
19400 set, and false otherwise. Note that this option does not apply to hints keys
19401 for transport delays; they are controlled by a generic transport option of the
19402 same name.
19403
19404 Failing to set this option when it is needed
19405 (because a remote router handles only some of the local-parts for a domain)
19406 can result in incorrect error messages being generated.
19407
19408 The setting of &%retry_use_local_part%& applies only to the router on which it
19409 appears. If the router generates child addresses, they are routed
19410 independently; this setting does not become attached to them.
19411
19412
19413
19414 .option router_home_directory routers string&!! unset
19415 .cindex "router" "home directory for"
19416 .cindex "home directory" "for router"
19417 .vindex "&$home$&"
19418 This option sets a home directory for use while the router is running. (Compare
19419 &%transport_home_directory%&, which sets a home directory for later
19420 transporting.) In particular, if used on a &(redirect)& router, this option
19421 sets a value for &$home$& while a filter is running. The value is expanded;
19422 forced expansion failure causes the option to be ignored &-- other failures
19423 cause the router to defer.
19424
19425 Expansion of &%router_home_directory%& happens immediately after the
19426 &%check_local_user%& test (if configured), before any further expansions take
19427 place.
19428 (See section &<<SECTrouprecon>>& for a list of the order in which preconditions
19429 are evaluated.)
19430 While the router is running, &%router_home_directory%& overrides the value of
19431 &$home$& that came from &%check_local_user%&.
19432
19433 When a router accepts an address and assigns it to a local transport (including
19434 the cases when a &(redirect)& router generates a pipe, file, or autoreply
19435 delivery), the home directory setting for the transport is taken from the first
19436 of these values that is set:
19437
19438 .ilist
19439 The &%home_directory%& option on the transport;
19440 .next
19441 The &%transport_home_directory%& option on the router;
19442 .next
19443 The password data if &%check_local_user%& is set on the router;
19444 .next
19445 The &%router_home_directory%& option on the router.
19446 .endlist
19447
19448 In other words, &%router_home_directory%& overrides the password data for the
19449 router, but not for the transport.
19450
19451
19452
19453 .option self routers string freeze
19454 .cindex "MX record" "pointing to local host"
19455 .cindex "local host" "MX pointing to"
19456 This option applies to those routers that use a recipient address to find a
19457 list of remote hosts. Currently, these are the &(dnslookup)&, &(ipliteral)&,
19458 and &(manualroute)& routers.
19459 Certain configurations of the &(queryprogram)& router can also specify a list
19460 of remote hosts.
19461 Usually such routers are configured to send the message to a remote host via an
19462 &(smtp)& transport. The &%self%& option specifies what happens when the first
19463 host on the list turns out to be the local host.
19464 The way in which Exim checks for the local host is described in section
19465 &<<SECTreclocipadd>>&.
19466
19467 Normally this situation indicates either an error in Exim's configuration (for
19468 example, the router should be configured not to process this domain), or an
19469 error in the DNS (for example, the MX should not point to this host). For this
19470 reason, the default action is to log the incident, defer the address, and
19471 freeze the message. The following alternatives are provided for use in special
19472 cases:
19473
19474 .vlist
19475 .vitem &%defer%&
19476 Delivery of the message is tried again later, but the message is not frozen.
19477
19478 .vitem "&%reroute%&: <&'domain'&>"
19479 The domain is changed to the given domain, and the address is passed back to
19480 be reprocessed by the routers. No rewriting of headers takes place. This
19481 behaviour is essentially a redirection.
19482
19483 .vitem "&%reroute: rewrite:%& <&'domain'&>"
19484 The domain is changed to the given domain, and the address is passed back to be
19485 reprocessed by the routers. Any headers that contain the original domain are
19486 rewritten.
19487
19488 .vitem &%pass%&
19489 .oindex "&%more%&"
19490 .vindex "&$self_hostname$&"
19491 The router passes the address to the next router, or to the router named in the
19492 &%pass_router%& option if it is set. This overrides &%no_more%&. During
19493 subsequent routing and delivery, the variable &$self_hostname$& contains the
19494 name of the local host that the router encountered. This can be used to
19495 distinguish between different cases for hosts with multiple names. The
19496 combination
19497 .code
19498 self = pass
19499 no_more
19500 .endd
19501 ensures that only those addresses that routed to the local host are passed on.
19502 Without &%no_more%&, addresses that were declined for other reasons would also
19503 be passed to the next router.
19504
19505 .vitem &%fail%&
19506 Delivery fails and an error report is generated.
19507
19508 .vitem &%send%&
19509 .cindex "local host" "sending to"
19510 The anomaly is ignored and the address is queued for the transport. This
19511 setting should be used with extreme caution. For an &(smtp)& transport, it
19512 makes sense only in cases where the program that is listening on the SMTP port
19513 is not this version of Exim. That is, it must be some other MTA, or Exim with a
19514 different configuration file that handles the domain in another way.
19515 .endlist
19516
19517
19518
19519 .option senders routers&!? "address list&!!" unset
19520 .cindex "router" "checking senders"
19521 If this option is set, the router is skipped unless the message's sender
19522 address matches something on the list.
19523 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
19524 are evaluated.
19525
19526 There are issues concerning verification when the running of routers is
19527 dependent on the sender. When Exim is verifying the address in an &%errors_to%&
19528 setting, it sets the sender to the null string. When using the &%-bt%& option
19529 to check a configuration file, it is necessary also to use the &%-f%& option to
19530 set an appropriate sender. For incoming mail, the sender is unset when
19531 verifying the sender, but is available when verifying any recipients. If the
19532 SMTP VRFY command is enabled, it must be used after MAIL if the sender address
19533 matters.
19534
19535
19536 .option set routers "string list" unset
19537 .cindex router variables
19538 This option may be used multiple times on a router;
19539 because of this the list aspect is mostly irrelevant.
19540 The list separator is a semicolon but can be changed in the
19541 usual way.
19542
19543 Each list-element given must be of the form &"name = value"&
19544 and the names used must start with the string &"r_"&.
19545 Values containing a list-separator should have them doubled.
19546 When a router runs, the strings are evaluated in order,
19547 to create variables which are added to the set associated with
19548 the address.
19549 The variable is set with the expansion of the value.
19550 The variables can be used by the router options
19551 (not including any preconditions)
19552 and by the transport.
19553 Later definitions of a given named variable will override former ones.
19554 Variable use is via the usual &$r_...$& syntax.
19555
19556 This is similar to the &%address_data%& option, except that
19557 many independent variables can be used, with choice of naming.
19558
19559
19560 .option translate_ip_address routers string&!! unset
19561 .cindex "IP address" "translating"
19562 .cindex "packet radio"
19563 .cindex "router" "IP address translation"
19564 There exist some rare networking situations (for example, packet radio) where
19565 it is helpful to be able to translate IP addresses generated by normal routing
19566 mechanisms into other IP addresses, thus performing a kind of manual IP
19567 routing. This should be done only if the normal IP routing of the TCP/IP stack
19568 is inadequate or broken. Because this is an extremely uncommon requirement, the
19569 code to support this option is not included in the Exim binary unless
19570 SUPPORT_TRANSLATE_IP_ADDRESS=yes is set in &_Local/Makefile_&.
19571
19572 .vindex "&$host_address$&"
19573 The &%translate_ip_address%& string is expanded for every IP address generated
19574 by the router, with the generated address set in &$host_address$&. If the
19575 expansion is forced to fail, no action is taken.
19576 For any other expansion error, delivery of the message is deferred.
19577 If the result of the expansion is an IP address, that replaces the original
19578 address; otherwise the result is assumed to be a host name &-- this is looked
19579 up using &[gethostbyname()]& (or &[getipnodebyname()]& when available) to
19580 produce one or more replacement IP addresses. For example, to subvert all IP
19581 addresses in some specific networks, this could be added to a router:
19582 .code
19583 translate_ip_address = \
19584   ${lookup{${mask:$host_address/26}}lsearch{/some/file}\
19585     {$value}fail}}
19586 .endd
19587 The file would contain lines like
19588 .code
19589 10.2.3.128/26    some.host
19590 10.8.4.34/26     10.44.8.15
19591 .endd
19592 You should not make use of this facility unless you really understand what you
19593 are doing.
19594
19595
19596
19597 .option transport routers string&!! unset
19598 This option specifies the transport to be used when a router accepts an address
19599 and sets it up for delivery. A transport is never needed if a router is used
19600 only for verification. The value of the option is expanded at routing time,
19601 after the expansion of &%errors_to%&, &%headers_add%&, and &%headers_remove%&,
19602 and result must be the name of one of the configured transports. If it is not,
19603 delivery is deferred.
19604
19605 The &%transport%& option is not used by the &(redirect)& router, but it does
19606 have some private options that set up transports for pipe and file deliveries
19607 (see chapter &<<CHAPredirect>>&).
19608
19609
19610
19611 .option transport_current_directory routers string&!! unset
19612 .cindex "current directory for local transport"
19613 This option associates a current directory with any address that is routed
19614 to a local transport. This can happen either because a transport is
19615 explicitly configured for the router, or because it generates a delivery to a
19616 file or a pipe. During the delivery process (that is, at transport time), this
19617 option string is expanded and is set as the current directory, unless
19618 overridden by a setting on the transport.
19619 If the expansion fails for any reason, including forced failure, an error is
19620 logged, and delivery is deferred.
19621 See chapter &<<CHAPenvironment>>& for details of the local delivery
19622 environment.
19623
19624
19625
19626
19627 .option transport_home_directory routers string&!! "see below"
19628 .cindex "home directory" "for local transport"
19629 This option associates a home directory with any address that is routed to a
19630 local transport. This can happen either because a transport is explicitly
19631 configured for the router, or because it generates a delivery to a file or a
19632 pipe. During the delivery process (that is, at transport time), the option
19633 string is expanded and is set as the home directory, unless overridden by a
19634 setting of &%home_directory%& on the transport.
19635 If the expansion fails for any reason, including forced failure, an error is
19636 logged, and delivery is deferred.
19637
19638 If the transport does not specify a home directory, and
19639 &%transport_home_directory%& is not set for the router, the home directory for
19640 the transport is taken from the password data if &%check_local_user%& is set for
19641 the router. Otherwise it is taken from &%router_home_directory%& if that option
19642 is set; if not, no home directory is set for the transport.
19643
19644 See chapter &<<CHAPenvironment>>& for further details of the local delivery
19645 environment.
19646
19647
19648
19649
19650 .option unseen routers boolean&!! false
19651 .cindex "router" "carrying on after success"
19652 The result of string expansion for this option must be a valid boolean value,
19653 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
19654 result causes an error, and delivery is deferred. If the expansion is forced to
19655 fail, the default value for the option (false) is used. Other failures cause
19656 delivery to be deferred.
19657
19658 When this option is set true, routing does not cease if the router accepts the
19659 address. Instead, a copy of the incoming address is passed to the next router,
19660 overriding a false setting of &%more%&. There is little point in setting
19661 &%more%& false if &%unseen%& is always true, but it may be useful in cases when
19662 the value of &%unseen%& contains expansion items (and therefore, presumably, is
19663 sometimes true and sometimes false).
19664
19665 .cindex "copy of message (&%unseen%& option)"
19666 Setting the &%unseen%& option has a similar effect to the &%unseen%& command
19667 qualifier in filter files. It can be used to cause copies of messages to be
19668 delivered to some other destination, while also carrying out a normal delivery.
19669 In effect, the current address is made into a &"parent"& that has two children
19670 &-- one that is delivered as specified by this router, and a clone that goes on
19671 to be routed further. For this reason, &%unseen%& may not be combined with the
19672 &%one_time%& option in a &(redirect)& router.
19673
19674 &*Warning*&: Header lines added to the address (or specified for removal) by
19675 this router or by previous routers affect the &"unseen"& copy of the message
19676 only. The clone that continues to be processed by further routers starts with
19677 no added headers and none specified for removal. For a &%redirect%& router, if
19678 a generated address is the same as the incoming address, this can lead to
19679 duplicate addresses with different header modifications. Exim does not do
19680 duplicate deliveries (except, in certain circumstances, to pipes -- see section
19681 &<<SECTdupaddr>>&), but it is undefined which of the duplicates is discarded,
19682 so this ambiguous situation should be avoided. The &%repeat_use%& option of the
19683 &%redirect%& router may be of help.
19684
19685 Unlike the handling of header modifications, any data that was set by the
19686 &%address_data%& option in the current or previous routers &'is'& passed on to
19687 subsequent routers.
19688
19689
19690 .option user routers string&!! "see below"
19691 .cindex "uid (user id)" "local delivery"
19692 .cindex "local transports" "uid and gid"
19693 .cindex "transport" "local"
19694 .cindex "router" "user for filter processing"
19695 .cindex "filter" "user for processing"
19696 When a router queues an address for a transport, and the transport does not
19697 specify a user, the user given here is used when running the delivery process.
19698 The user may be specified numerically or by name. If expansion fails, the
19699 error is logged and delivery is deferred.
19700 This user is also used by the &(redirect)& router when running a filter file.
19701 The default is unset, except when &%check_local_user%& is set. In this case,
19702 the default is taken from the password information. If the user is specified as
19703 a name, and &%group%& is not set, the group associated with the user is used.
19704 See also &%initgroups%& and &%group%& and the discussion in chapter
19705 &<<CHAPenvironment>>&.
19706
19707
19708
19709 .option verify routers&!? boolean true
19710 Setting this option has the effect of setting &%verify_sender%& and
19711 &%verify_recipient%& to the same value.
19712
19713
19714 .option verify_only routers&!? boolean false
19715 .cindex "EXPN" "with &%verify_only%&"
19716 .oindex "&%-bv%&"
19717 .cindex "router" "used only when verifying"
19718 If this option is set, the router is used only when verifying an address,
19719 delivering in cutthrough mode or
19720 testing with the &%-bv%& option, not when actually doing a delivery, testing
19721 with the &%-bt%& option, or running the SMTP EXPN command. It can be further
19722 restricted to verifying only senders or recipients by means of
19723 &%verify_sender%& and &%verify_recipient%&.
19724
19725 &*Warning*&: When the router is being run to verify addresses for an incoming
19726 SMTP message, Exim is not running as root, but under its own uid. If the router
19727 accesses any files, you need to make sure that they are accessible to the Exim
19728 user or group.
19729
19730
19731 .option verify_recipient routers&!? boolean true
19732 If this option is false, the router is skipped when verifying recipient
19733 addresses,
19734 delivering in cutthrough mode
19735 or testing recipient verification using &%-bv%&.
19736 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
19737 are evaluated.
19738 See also the &$verify_mode$& variable.
19739
19740
19741 .option verify_sender routers&!? boolean true
19742 If this option is false, the router is skipped when verifying sender addresses
19743 or testing sender verification using &%-bvs%&.
19744 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
19745 are evaluated.
19746 See also the &$verify_mode$& variable.
19747 .ecindex IIDgenoprou1
19748 .ecindex IIDgenoprou2
19749
19750
19751
19752
19753
19754
19755 . ////////////////////////////////////////////////////////////////////////////
19756 . ////////////////////////////////////////////////////////////////////////////
19757
19758 .chapter "The accept router" "CHID4"
19759 .cindex "&(accept)& router"
19760 .cindex "routers" "&(accept)&"
19761 The &(accept)& router has no private options of its own. Unless it is being
19762 used purely for verification (see &%verify_only%&) a transport is required to
19763 be defined by the generic &%transport%& option. If the preconditions that are
19764 specified by generic options are met, the router accepts the address and queues
19765 it for the given transport. The most common use of this router is for setting
19766 up deliveries to local mailboxes. For example:
19767 .code
19768 localusers:
19769   driver = accept
19770   domains = mydomain.example
19771   check_local_user
19772   transport = local_delivery
19773 .endd
19774 The &%domains%& condition in this example checks the domain of the address, and
19775 &%check_local_user%& checks that the local part is the login of a local user.
19776 When both preconditions are met, the &(accept)& router runs, and queues the
19777 address for the &(local_delivery)& transport.
19778
19779
19780
19781
19782
19783
19784 . ////////////////////////////////////////////////////////////////////////////
19785 . ////////////////////////////////////////////////////////////////////////////
19786
19787 .chapter "The dnslookup router" "CHAPdnslookup"
19788 .scindex IIDdnsrou1 "&(dnslookup)& router"
19789 .scindex IIDdnsrou2 "routers" "&(dnslookup)&"
19790 The &(dnslookup)& router looks up the hosts that handle mail for the
19791 recipient's domain in the DNS. A transport must always be set for this router,
19792 unless &%verify_only%& is set.
19793
19794 If SRV support is configured (see &%check_srv%& below), Exim first searches for
19795 SRV records. If none are found, or if SRV support is not configured,
19796 MX records are looked up. If no MX records exist, address records are sought.
19797 However, &%mx_domains%& can be set to disable the direct use of address
19798 records.
19799
19800 MX records of equal priority are sorted by Exim into a random order. Exim then
19801 looks for address records for the host names obtained from MX or SRV records.
19802 When a host has more than one IP address, they are sorted into a random order,
19803 except that IPv6 addresses are sorted before IPv4 addresses. If all the
19804 IP addresses found are discarded by a setting of the &%ignore_target_hosts%&
19805 generic option, the router declines.
19806
19807 Unless they have the highest priority (lowest MX value), MX records that point
19808 to the local host, or to any host name that matches &%hosts_treat_as_local%&,
19809 are discarded, together with any other MX records of equal or lower priority.
19810
19811 .cindex "MX record" "pointing to local host"
19812 .cindex "local host" "MX pointing to"
19813 .oindex "&%self%&" "in &(dnslookup)& router"
19814 If the host pointed to by the highest priority MX record, or looked up as an
19815 address record, is the local host, or matches &%hosts_treat_as_local%&, what
19816 happens is controlled by the generic &%self%& option.
19817
19818
19819 .section "Problems with DNS lookups" "SECTprowitdnsloo"
19820 There have been problems with DNS servers when SRV records are looked up.
19821 Some misbehaving servers return a DNS error or timeout when a non-existent
19822 SRV record is sought. Similar problems have in the past been reported for
19823 MX records. The global &%dns_again_means_nonexist%& option can help with this
19824 problem, but it is heavy-handed because it is a global option.
19825
19826 For this reason, there are two options, &%srv_fail_domains%& and
19827 &%mx_fail_domains%&, that control what happens when a DNS lookup in a
19828 &(dnslookup)& router results in a DNS failure or a &"try again"& response. If
19829 an attempt to look up an SRV or MX record causes one of these results, and the
19830 domain matches the relevant list, Exim behaves as if the DNS had responded &"no
19831 such record"&. In the case of an SRV lookup, this means that the router
19832 proceeds to look for MX records; in the case of an MX lookup, it proceeds to
19833 look for A or AAAA records, unless the domain matches &%mx_domains%&, in which
19834 case routing fails.
19835
19836
19837 .section "Declining addresses by dnslookup" "SECTdnslookupdecline"
19838 .cindex "&(dnslookup)& router" "declines"
19839 There are a few cases where a &(dnslookup)& router will decline to accept
19840 an address; if such a router is expected to handle "all remaining non-local
19841 domains", then it is important to set &%no_more%&.
19842
19843 The router will defer rather than decline if the domain
19844 is found in the &%fail_defer_domains%& router option.
19845
19846 Reasons for a &(dnslookup)& router to decline currently include:
19847 .ilist
19848 The domain does not exist in DNS
19849 .next
19850 The domain exists but the MX record's host part is just "."; this is a common
19851 convention (borrowed from SRV) used to indicate that there is no such service
19852 for this domain and to not fall back to trying A/AAAA records.
19853 .next
19854 Ditto, but for SRV records, when &%check_srv%& is set on this router.
19855 .next
19856 MX record points to a non-existent host.
19857 .next
19858 MX record points to an IP address and the main section option
19859 &%allow_mx_to_ip%& is not set.
19860 .next
19861 MX records exist and point to valid hosts, but all hosts resolve only to
19862 addresses blocked by the &%ignore_target_hosts%& generic option on this router.
19863 .next
19864 The domain is not syntactically valid (see also &%allow_utf8_domains%& and
19865 &%dns_check_names_pattern%& for handling one variant of this)
19866 .next
19867 &%check_secondary_mx%& is set on this router but the local host can
19868 not be found in the MX records (see below)
19869 .endlist
19870
19871
19872
19873
19874 .section "Private options for dnslookup" "SECID118"
19875 .cindex "options" "&(dnslookup)& router"
19876 The private options for the &(dnslookup)& router are as follows:
19877
19878 .option check_secondary_mx dnslookup boolean false
19879 .cindex "MX record" "checking for secondary"
19880 If this option is set, the router declines unless the local host is found in
19881 (and removed from) the list of hosts obtained by MX lookup. This can be used to
19882 process domains for which the local host is a secondary mail exchanger
19883 differently to other domains. The way in which Exim decides whether a host is
19884 the local host is described in section &<<SECTreclocipadd>>&.
19885
19886
19887 .option check_srv dnslookup string&!! unset
19888 .cindex "SRV record" "enabling use of"
19889 The &(dnslookup)& router supports the use of SRV records (see RFC 2782) in
19890 addition to MX and address records. The support is disabled by default. To
19891 enable SRV support, set the &%check_srv%& option to the name of the service
19892 required. For example,
19893 .code
19894 check_srv = smtp
19895 .endd
19896 looks for SRV records that refer to the normal smtp service. The option is
19897 expanded, so the service name can vary from message to message or address
19898 to address. This might be helpful if SRV records are being used for a
19899 submission service. If the expansion is forced to fail, the &%check_srv%&
19900 option is ignored, and the router proceeds to look for MX records in the
19901 normal way.
19902
19903 When the expansion succeeds, the router searches first for SRV records for
19904 the given service (it assumes TCP protocol). A single SRV record with a
19905 host name that consists of just a single dot indicates &"no such service for
19906 this domain"&; if this is encountered, the router declines. If other kinds of
19907 SRV record are found, they are used to construct a host list for delivery
19908 according to the rules of RFC 2782. MX records are not sought in this case.
19909
19910 When no SRV records are found, MX records (and address records) are sought in
19911 the traditional way. In other words, SRV records take precedence over MX
19912 records, just as MX records take precedence over address records. Note that
19913 this behaviour is not sanctioned by RFC 2782, though a previous draft RFC
19914 defined it. It is apparently believed that MX records are sufficient for email
19915 and that SRV records should not be used for this purpose. However, SRV records
19916 have an additional &"weight"& feature which some people might find useful when
19917 trying to split an SMTP load between hosts of different power.
19918
19919 See section &<<SECTprowitdnsloo>>& above for a discussion of Exim's behaviour
19920 when there is a DNS lookup error.
19921
19922
19923
19924
19925 .option fail_defer_domains dnslookup "domain list&!!" unset
19926 .cindex "MX record" "not found"
19927 DNS lookups for domains matching &%fail_defer_domains%&
19928 which find no matching record will cause the router to defer
19929 rather than the default behaviour of decline.
19930 This maybe be useful for queueing messages for a newly created
19931 domain while the DNS configuration is not ready.
19932 However, it will result in any message with mistyped domains
19933 also being queued.
19934
19935
19936 .option ipv4_only "string&!!" unset
19937 .cindex IPv6 disabling
19938 .cindex DNS "IPv6 disabling"
19939 The string is expanded, and if the result is anything but a forced failure,
19940 or an empty string, or one of the strings “0” or “no” or “false”
19941 (checked without regard to the case of the letters),
19942 only A records are used.
19943
19944 .option ipv4_prefer "string&!!" unset
19945 .cindex IPv4 preference
19946 .cindex DNS "IPv4 preference"
19947 The string is expanded, and if the result is anything but a forced failure,
19948 or an empty string, or one of the strings “0” or “no” or “false”
19949 (checked without regard to the case of the letters),
19950 A records are sorted before AAAA records (inverting the default).
19951
19952 .option mx_domains dnslookup "domain list&!!" unset
19953 .cindex "MX record" "required to exist"
19954 .cindex "SRV record" "required to exist"
19955 A domain that matches &%mx_domains%& is required to have either an MX or an SRV
19956 record in order to be recognized. (The name of this option could be improved.)
19957 For example, if all the mail hosts in &'fict.example'& are known to have MX
19958 records, except for those in &'discworld.fict.example'&, you could use this
19959 setting:
19960 .code
19961 mx_domains = ! *.discworld.fict.example : *.fict.example
19962 .endd
19963 This specifies that messages addressed to a domain that matches the list but
19964 has no MX record should be bounced immediately instead of being routed using
19965 the address record.
19966
19967
19968 .option mx_fail_domains dnslookup "domain list&!!" unset
19969 If the DNS lookup for MX records for one of the domains in this list causes a
19970 DNS lookup error, Exim behaves as if no MX records were found. See section
19971 &<<SECTprowitdnsloo>>& for more discussion.
19972
19973
19974
19975
19976 .option qualify_single dnslookup boolean true
19977 .cindex "DNS" "resolver options"
19978 .cindex "DNS" "qualifying single-component names"
19979 When this option is true, the resolver option RES_DEFNAMES is set for DNS
19980 lookups. Typically, but not standardly, this causes the resolver to qualify
19981 single-component names with the default domain. For example, on a machine
19982 called &'dictionary.ref.example'&, the domain &'thesaurus'& would be changed to
19983 &'thesaurus.ref.example'& inside the resolver. For details of what your
19984 resolver actually does, consult your man pages for &'resolver'& and
19985 &'resolv.conf'&.
19986
19987
19988
19989 .option rewrite_headers dnslookup boolean true
19990 .cindex "rewriting" "header lines"
19991 .cindex "header lines" "rewriting"
19992 If the domain name in the address that is being processed is not fully
19993 qualified, it may be expanded to its full form by a DNS lookup. For example, if
19994 an address is specified as &'dormouse@teaparty'&, the domain might be
19995 expanded to &'teaparty.wonderland.fict.example'&. Domain expansion can also
19996 occur as a result of setting the &%widen_domains%& option. If
19997 &%rewrite_headers%& is true, all occurrences of the abbreviated domain name in
19998 any &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-to:'&, &'Sender:'&, and &'To:'&
19999 header lines of the message are rewritten with the full domain name.
20000
20001 This option should be turned off only when it is known that no message is
20002 ever going to be sent outside an environment where the abbreviation makes
20003 sense.
20004
20005 When an MX record is looked up in the DNS and matches a wildcard record, name
20006 servers normally return a record containing the name that has been looked up,
20007 making it impossible to detect whether a wildcard was present or not. However,
20008 some name servers have recently been seen to return the wildcard entry. If the
20009 name returned by a DNS lookup begins with an asterisk, it is not used for
20010 header rewriting.
20011
20012
20013 .option same_domain_copy_routing dnslookup boolean false
20014 .cindex "address" "copying routing"
20015 Addresses with the same domain are normally routed by the &(dnslookup)& router
20016 to the same list of hosts. However, this cannot be presumed, because the router
20017 options and preconditions may refer to the local part of the address. By
20018 default, therefore, Exim routes each address in a message independently. DNS
20019 servers run caches, so repeated DNS lookups are not normally expensive, and in
20020 any case, personal messages rarely have more than a few recipients.
20021
20022 If you are running mailing lists with large numbers of subscribers at the same
20023 domain, and you are using a &(dnslookup)& router which is independent of the
20024 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
20025 lookups for identical domains in one message. In this case, when &(dnslookup)&
20026 routes an address to a remote transport, any other unrouted addresses in the
20027 message that have the same domain are automatically given the same routing
20028 without processing them independently,
20029 provided the following conditions are met:
20030
20031 .ilist
20032 No router that processed the address specified &%headers_add%& or
20033 &%headers_remove%&.
20034 .next
20035 The router did not change the address in any way, for example, by &"widening"&
20036 the domain.
20037 .endlist
20038
20039
20040
20041
20042 .option search_parents dnslookup boolean false
20043 .cindex "DNS" "resolver options"
20044 When this option is true, the resolver option RES_DNSRCH is set for DNS
20045 lookups. This is different from the &%qualify_single%& option in that it
20046 applies to domains containing dots. Typically, but not standardly, it causes
20047 the resolver to search for the name in the current domain and in parent
20048 domains. For example, on a machine in the &'fict.example'& domain, if looking
20049 up &'teaparty.wonderland'& failed, the resolver would try
20050 &'teaparty.wonderland.fict.example'&. For details of what your resolver
20051 actually does, consult your man pages for &'resolver'& and &'resolv.conf'&.
20052
20053 Setting this option true can cause problems in domains that have a wildcard MX
20054 record, because any domain that does not have its own MX record matches the
20055 local wildcard.
20056
20057
20058
20059 .option srv_fail_domains dnslookup "domain list&!!" unset
20060 If the DNS lookup for SRV records for one of the domains in this list causes a
20061 DNS lookup error, Exim behaves as if no SRV records were found. See section
20062 &<<SECTprowitdnsloo>>& for more discussion.
20063
20064
20065
20066
20067 .option widen_domains dnslookup "string list" unset
20068 .cindex "domain" "partial; widening"
20069 If a DNS lookup fails and this option is set, each of its strings in turn is
20070 added onto the end of the domain, and the lookup is tried again. For example,
20071 if
20072 .code
20073 widen_domains = fict.example:ref.example
20074 .endd
20075 is set and a lookup of &'klingon.dictionary'& fails,
20076 &'klingon.dictionary.fict.example'& is looked up, and if this fails,
20077 &'klingon.dictionary.ref.example'& is tried. Note that the &%qualify_single%&
20078 and &%search_parents%& options can cause some widening to be undertaken inside
20079 the DNS resolver. &%widen_domains%& is not applied to sender addresses
20080 when verifying, unless &%rewrite_headers%& is false (not the default).
20081
20082
20083 .section "Effect of qualify_single and search_parents" "SECID119"
20084 When a domain from an envelope recipient is changed by the resolver as a result
20085 of the &%qualify_single%& or &%search_parents%& options, Exim rewrites the
20086 corresponding address in the message's header lines unless &%rewrite_headers%&
20087 is set false. Exim then re-routes the address, using the full domain.
20088
20089 These two options affect only the DNS lookup that takes place inside the router
20090 for the domain of the address that is being routed. They do not affect lookups
20091 such as that implied by
20092 .code
20093 domains = @mx_any
20094 .endd
20095 that may happen while processing a router precondition before the router is
20096 entered. No widening ever takes place for these lookups.
20097 .ecindex IIDdnsrou1
20098 .ecindex IIDdnsrou2
20099
20100
20101
20102
20103
20104
20105
20106
20107
20108 . ////////////////////////////////////////////////////////////////////////////
20109 . ////////////////////////////////////////////////////////////////////////////
20110
20111 .chapter "The ipliteral router" "CHID5"
20112 .cindex "&(ipliteral)& router"
20113 .cindex "domain literal" "routing"
20114 .cindex "routers" "&(ipliteral)&"
20115 This router has no private options. Unless it is being used purely for
20116 verification (see &%verify_only%&) a transport is required to be defined by the
20117 generic &%transport%& option. The router accepts the address if its domain part
20118 takes the form of an RFC 2822 domain literal. For example, the &(ipliteral)&
20119 router handles the address
20120 .code
20121 root@[192.168.1.1]
20122 .endd
20123 by setting up delivery to the host with that IP address. IPv4 domain literals
20124 consist of an IPv4 address enclosed in square brackets. IPv6 domain literals
20125 are similar, but the address is preceded by &`ipv6:`&. For example:
20126 .code
20127 postmaster@[ipv6:fe80::a00:20ff:fe86:a061.5678]
20128 .endd
20129 Exim allows &`ipv4:`& before IPv4 addresses, for consistency, and on the
20130 grounds that sooner or later somebody will try it.
20131
20132 .oindex "&%self%&" "in &(ipliteral)& router"
20133 If the IP address matches something in &%ignore_target_hosts%&, the router
20134 declines. If an IP literal turns out to refer to the local host, the generic
20135 &%self%& option determines what happens.
20136
20137 The RFCs require support for domain literals; however, their use is
20138 controversial in today's Internet. If you want to use this router, you must
20139 also set the main configuration option &%allow_domain_literals%&. Otherwise,
20140 Exim will not recognize the domain literal syntax in addresses.
20141
20142
20143
20144 . ////////////////////////////////////////////////////////////////////////////
20145 . ////////////////////////////////////////////////////////////////////////////
20146
20147 .chapter "The iplookup router" "CHID6"
20148 .cindex "&(iplookup)& router"
20149 .cindex "routers" "&(iplookup)&"
20150 The &(iplookup)& router was written to fulfil a specific requirement in
20151 Cambridge University (which in fact no longer exists). For this reason, it is
20152 not included in the binary of Exim by default. If you want to include it, you
20153 must set
20154 .code
20155 ROUTER_IPLOOKUP=yes
20156 .endd
20157 in your &_Local/Makefile_& configuration file.
20158
20159 The &(iplookup)& router routes an address by sending it over a TCP or UDP
20160 connection to one or more specific hosts. The host can then return the same or
20161 a different address &-- in effect rewriting the recipient address in the
20162 message's envelope. The new address is then passed on to subsequent routers. If
20163 this process fails, the address can be passed on to other routers, or delivery
20164 can be deferred. Since &(iplookup)& is just a rewriting router, a transport
20165 must not be specified for it.
20166
20167 .cindex "options" "&(iplookup)& router"
20168 .option hosts iplookup string unset
20169 This option must be supplied. Its value is a colon-separated list of host
20170 names. The hosts are looked up using &[gethostbyname()]&
20171 (or &[getipnodebyname()]& when available)
20172 and are tried in order until one responds to the query. If none respond, what
20173 happens is controlled by &%optional%&.
20174
20175
20176 .option optional iplookup boolean false
20177 If &%optional%& is true, if no response is obtained from any host, the address
20178 is passed to the next router, overriding &%no_more%&. If &%optional%& is false,
20179 delivery to the address is deferred.
20180
20181
20182 .option port iplookup integer 0
20183 .cindex "port" "&(iplookup)& router"
20184 This option must be supplied. It specifies the port number for the TCP or UDP
20185 call.
20186
20187
20188 .option protocol iplookup string udp
20189 This option can be set to &"udp"& or &"tcp"& to specify which of the two
20190 protocols is to be used.
20191
20192
20193 .option query iplookup string&!! "see below"
20194 This defines the content of the query that is sent to the remote hosts. The
20195 default value is:
20196 .code
20197 $local_part@$domain $local_part@$domain
20198 .endd
20199 The repetition serves as a way of checking that a response is to the correct
20200 query in the default case (see &%response_pattern%& below).
20201
20202
20203 .option reroute iplookup string&!! unset
20204 If this option is not set, the rerouted address is precisely the byte string
20205 returned by the remote host, up to the first white space, if any. If set, the
20206 string is expanded to form the rerouted address. It can include parts matched
20207 in the response by &%response_pattern%& by means of numeric variables such as
20208 &$1$&, &$2$&, etc. The variable &$0$& refers to the entire input string,
20209 whether or not a pattern is in use. In all cases, the rerouted address must end
20210 up in the form &'local_part@domain'&.
20211
20212
20213 .option response_pattern iplookup string unset
20214 This option can be set to a regular expression that is applied to the string
20215 returned from the remote host. If the pattern does not match the response, the
20216 router declines. If &%response_pattern%& is not set, no checking of the
20217 response is done, unless the query was defaulted, in which case there is a
20218 check that the text returned after the first white space is the original
20219 address. This checks that the answer that has been received is in response to
20220 the correct question. For example, if the response is just a new domain, the
20221 following could be used:
20222 .code
20223 response_pattern = ^([^@]+)$
20224 reroute = $local_part@$1
20225 .endd
20226
20227 .option timeout iplookup time 5s
20228 This specifies the amount of time to wait for a response from the remote
20229 machine. The same timeout is used for the &[connect()]& function for a TCP
20230 call. It does not apply to UDP.
20231
20232
20233
20234
20235 . ////////////////////////////////////////////////////////////////////////////
20236 . ////////////////////////////////////////////////////////////////////////////
20237
20238 .chapter "The manualroute router" "CHID7"
20239 .scindex IIDmanrou1 "&(manualroute)& router"
20240 .scindex IIDmanrou2 "routers" "&(manualroute)&"
20241 .cindex "domain" "manually routing"
20242 The &(manualroute)& router is so-called because it provides a way of manually
20243 routing an address according to its domain. It is mainly used when you want to
20244 route addresses to remote hosts according to your own rules, bypassing the
20245 normal DNS routing that looks up MX records. However, &(manualroute)& can also
20246 route to local transports, a facility that may be useful if you want to save
20247 messages for dial-in hosts in local files.
20248
20249 The &(manualroute)& router compares a list of domain patterns with the domain
20250 it is trying to route. If there is no match, the router declines. Each pattern
20251 has associated with it a list of hosts and some other optional data, which may
20252 include a transport. The combination of a pattern and its data is called a
20253 &"routing rule"&. For patterns that do not have an associated transport, the
20254 generic &%transport%& option must specify a transport, unless the router is
20255 being used purely for verification (see &%verify_only%&).
20256
20257 .vindex "&$host$&"
20258 In the case of verification, matching the domain pattern is sufficient for the
20259 router to accept the address. When actually routing an address for delivery,
20260 an address that matches a domain pattern is queued for the associated
20261 transport. If the transport is not a local one, a host list must be associated
20262 with the pattern; IP addresses are looked up for the hosts, and these are
20263 passed to the transport along with the mail address. For local transports, a
20264 host list is optional. If it is present, it is passed in &$host$& as a single
20265 text string.
20266
20267 The list of routing rules can be provided as an inline string in
20268 &%route_list%&, or the data can be obtained by looking up the domain in a file
20269 or database by setting &%route_data%&. Only one of these settings may appear in
20270 any one instance of &(manualroute)&. The format of routing rules is described
20271 below, following the list of private options.
20272
20273
20274 .section "Private options for manualroute" "SECTprioptman"
20275
20276 .cindex "options" "&(manualroute)& router"
20277 The private options for the &(manualroute)& router are as follows:
20278
20279 .option host_all_ignored manualroute string defer
20280 See &%host_find_failed%&.
20281
20282 .option host_find_failed manualroute string freeze
20283 This option controls what happens when &(manualroute)& tries to find an IP
20284 address for a host, and the host does not exist. The option can be set to one
20285 of the following values:
20286 .code
20287 decline
20288 defer
20289 fail
20290 freeze
20291 ignore
20292 pass
20293 .endd
20294 The default (&"freeze"&) assumes that this state is a serious configuration
20295 error. The difference between &"pass"& and &"decline"& is that the former
20296 forces the address to be passed to the next router (or the router defined by
20297 &%pass_router%&),
20298 .oindex "&%more%&"
20299 overriding &%no_more%&, whereas the latter passes the address to the next
20300 router only if &%more%& is true.
20301
20302 The value &"ignore"& causes Exim to completely ignore a host whose IP address
20303 cannot be found. If all the hosts in the list are ignored, the behaviour is
20304 controlled by the &%host_all_ignored%& option. This takes the same values
20305 as &%host_find_failed%&, except that it cannot be set to &"ignore"&.
20306
20307 The &%host_find_failed%& option applies only to a definite &"does not exist"&
20308 state; if a host lookup gets a temporary error, delivery is deferred unless the
20309 generic &%pass_on_timeout%& option is set.
20310
20311
20312 .option hosts_randomize manualroute boolean false
20313 .cindex "randomized host list"
20314 .cindex "host" "list of; randomized"
20315 If this option is set, the order of the items in a host list in a routing rule
20316 is randomized each time the list is used, unless an option in the routing rule
20317 overrides (see below). Randomizing the order of a host list can be used to do
20318 crude load sharing. However, if more than one mail address is routed by the
20319 same router to the same host list, the host lists are considered to be the same
20320 (even though they may be randomized into different orders) for the purpose of
20321 deciding whether to batch the deliveries into a single SMTP transaction.
20322
20323 When &%hosts_randomize%& is true, a host list may be split
20324 into groups whose order is separately randomized. This makes it possible to
20325 set up MX-like behaviour. The boundaries between groups are indicated by an
20326 item that is just &`+`& in the host list. For example:
20327 .code
20328 route_list = * host1:host2:host3:+:host4:host5
20329 .endd
20330 The order of the first three hosts and the order of the last two hosts is
20331 randomized for each use, but the first three always end up before the last two.
20332 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored. If a
20333 randomized host list is passed to an &(smtp)& transport that also has
20334 &%hosts_randomize set%&, the list is not re-randomized.
20335
20336
20337 .option route_data manualroute string&!! unset
20338 If this option is set, it must expand to yield the data part of a routing rule.
20339 Typically, the expansion string includes a lookup based on the domain. For
20340 example:
20341 .code
20342 route_data = ${lookup{$domain}dbm{/etc/routes}}
20343 .endd
20344 If the expansion is forced to fail, or the result is an empty string, the
20345 router declines. Other kinds of expansion failure cause delivery to be
20346 deferred.
20347
20348
20349 .option route_list manualroute "string list" unset
20350 This string is a list of routing rules, in the form defined below. Note that,
20351 unlike most string lists, the items are separated by semicolons. This is so
20352 that they may contain colon-separated host lists.
20353
20354
20355 .option same_domain_copy_routing manualroute boolean false
20356 .cindex "address" "copying routing"
20357 Addresses with the same domain are normally routed by the &(manualroute)&
20358 router to the same list of hosts. However, this cannot be presumed, because the
20359 router options and preconditions may refer to the local part of the address. By
20360 default, therefore, Exim routes each address in a message independently. DNS
20361 servers run caches, so repeated DNS lookups are not normally expensive, and in
20362 any case, personal messages rarely have more than a few recipients.
20363
20364 If you are running mailing lists with large numbers of subscribers at the same
20365 domain, and you are using a &(manualroute)& router which is independent of the
20366 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
20367 lookups for identical domains in one message. In this case, when
20368 &(manualroute)& routes an address to a remote transport, any other unrouted
20369 addresses in the message that have the same domain are automatically given the
20370 same routing without processing them independently. However, this is only done
20371 if &%headers_add%& and &%headers_remove%& are unset.
20372
20373
20374
20375
20376 .section "Routing rules in route_list" "SECID120"
20377 The value of &%route_list%& is a string consisting of a sequence of routing
20378 rules, separated by semicolons. If a semicolon is needed in a rule, it can be
20379 entered as two semicolons. Alternatively, the list separator can be changed as
20380 described (for colon-separated lists) in section &<<SECTlistconstruct>>&.
20381 Empty rules are ignored. The format of each rule is
20382 .display
20383 <&'domain pattern'&>  <&'list of hosts'&>  <&'options'&>
20384 .endd
20385 The following example contains two rules, each with a simple domain pattern and
20386 no options:
20387 .code
20388 route_list = \
20389   dict.ref.example  mail-1.ref.example:mail-2.ref.example ; \
20390   thes.ref.example  mail-3.ref.example:mail-4.ref.example
20391 .endd
20392 The three parts of a rule are separated by white space. The pattern and the
20393 list of hosts can be enclosed in quotes if necessary, and if they are, the
20394 usual quoting rules apply. Each rule in a &%route_list%& must start with a
20395 single domain pattern, which is the only mandatory item in the rule. The
20396 pattern is in the same format as one item in a domain list (see section
20397 &<<SECTdomainlist>>&),
20398 except that it may not be the name of an interpolated file.
20399 That is, it may be wildcarded, or a regular expression, or a file or database
20400 lookup (with semicolons doubled, because of the use of semicolon as a separator
20401 in a &%route_list%&).
20402
20403 The rules in &%route_list%& are searched in order until one of the patterns
20404 matches the domain that is being routed. The list of hosts and then options are
20405 then used as described below. If there is no match, the router declines. When
20406 &%route_list%& is set, &%route_data%& must not be set.
20407
20408
20409
20410 .section "Routing rules in route_data" "SECID121"
20411 The use of &%route_list%& is convenient when there are only a small number of
20412 routing rules. For larger numbers, it is easier to use a file or database to
20413 hold the routing information, and use the &%route_data%& option instead.
20414 The value of &%route_data%& is a list of hosts, followed by (optional) options.
20415 Most commonly, &%route_data%& is set as a string that contains an
20416 expansion lookup. For example, suppose we place two routing rules in a file
20417 like this:
20418 .code
20419 dict.ref.example:  mail-1.ref.example:mail-2.ref.example
20420 thes.ref.example:  mail-3.ref.example:mail-4.ref.example
20421 .endd
20422 This data can be accessed by setting
20423 .code
20424 route_data = ${lookup{$domain}lsearch{/the/file/name}}
20425 .endd
20426 Failure of the lookup results in an empty string, causing the router to
20427 decline. However, you do not have to use a lookup in &%route_data%&. The only
20428 requirement is that the result of expanding the string is a list of hosts,
20429 possibly followed by options, separated by white space. The list of hosts must
20430 be enclosed in quotes if it contains white space.
20431
20432
20433
20434
20435 .section "Format of the list of hosts" "SECID122"
20436 A list of hosts, whether obtained via &%route_data%& or &%route_list%&, is
20437 always separately expanded before use. If the expansion fails, the router
20438 declines. The result of the expansion must be a colon-separated list of names
20439 and/or IP addresses, optionally also including ports.
20440 If the list is written with spaces, it must be protected with quotes.
20441 The format of each item
20442 in the list is described in the next section. The list separator can be changed
20443 as described in section &<<SECTlistsepchange>>&.
20444
20445 If the list of hosts was obtained from a &%route_list%& item, the following
20446 variables are set during its expansion:
20447
20448 .ilist
20449 .cindex "numerical variables (&$1$& &$2$&  etc)" "in &(manualroute)& router"
20450 If the domain was matched against a regular expression, the numeric variables
20451 &$1$&, &$2$&, etc. may be set. For example:
20452 .code
20453 route_list = ^domain(\d+)   host-$1.text.example
20454 .endd
20455 .next
20456 &$0$& is always set to the entire domain.
20457 .next
20458 &$1$& is also set when partial matching is done in a file lookup.
20459
20460 .next
20461 .vindex "&$value$&"
20462 If the pattern that matched the domain was a lookup item, the data that was
20463 looked up is available in the expansion variable &$value$&. For example:
20464 .code
20465 route_list = lsearch;;/some/file.routes  $value
20466 .endd
20467 .endlist
20468
20469 Note the doubling of the semicolon in the pattern that is necessary because
20470 semicolon is the default route list separator.
20471
20472
20473
20474 .section "Format of one host item" "SECTformatonehostitem"
20475 Each item in the list of hosts can be either a host name or an IP address,
20476 optionally with an attached port number, or it can be a single "+"
20477 (see &%hosts_randomize%&).
20478 When no port is given, an IP address
20479 is not enclosed in brackets. When a port is specified, it overrides the port
20480 specification on the transport. The port is separated from the name or address
20481 by a colon. This leads to some complications:
20482
20483 .ilist
20484 Because colon is the default separator for the list of hosts, either
20485 the colon that specifies a port must be doubled, or the list separator must
20486 be changed. The following two examples have the same effect:
20487 .code
20488 route_list = * "host1.tld::1225 : host2.tld::1226"
20489 route_list = * "<+ host1.tld:1225 + host2.tld:1226"
20490 .endd
20491 .next
20492 When IPv6 addresses are involved, it gets worse, because they contain
20493 colons of their own. To make this case easier, it is permitted to
20494 enclose an IP address (either v4 or v6) in square brackets if a port
20495 number follows. For example:
20496 .code
20497 route_list = * "</ [10.1.1.1]:1225 / [::1]:1226"
20498 .endd
20499 .endlist
20500
20501 .section "How the list of hosts is used" "SECThostshowused"
20502 When an address is routed to an &(smtp)& transport by &(manualroute)&, each of
20503 the hosts is tried, in the order specified, when carrying out the SMTP
20504 delivery. However, the order can be changed by setting the &%hosts_randomize%&
20505 option, either on the router (see section &<<SECTprioptman>>& above), or on the
20506 transport.
20507
20508 Hosts may be listed by name or by IP address. An unadorned name in the list of
20509 hosts is interpreted as a host name. A name that is followed by &`/MX`& is
20510 interpreted as an indirection to a sublist of hosts obtained by looking up MX
20511 records in the DNS. For example:
20512 .code
20513 route_list = *  x.y.z:p.q.r/MX:e.f.g
20514 .endd
20515 If this feature is used with a port specifier, the port must come last. For
20516 example:
20517 .code
20518 route_list = *  dom1.tld/mx::1225
20519 .endd
20520 If the &%hosts_randomize%& option is set, the order of the items in the list is
20521 randomized before any lookups are done. Exim then scans the list; for any name
20522 that is not followed by &`/MX`& it looks up an IP address. If this turns out to
20523 be an interface on the local host and the item is not the first in the list,
20524 Exim discards it and any subsequent items. If it is the first item, what
20525 happens is controlled by the
20526 .oindex "&%self%&" "in &(manualroute)& router"
20527 &%self%& option of the router.
20528
20529 A name on the list that is followed by &`/MX`& is replaced with the list of
20530 hosts obtained by looking up MX records for the name. This is always a DNS
20531 lookup; the &%bydns%& and &%byname%& options (see section &<<SECThowoptused>>&
20532 below) are not relevant here. The order of these hosts is determined by the
20533 preference values in the MX records, according to the usual rules. Because
20534 randomizing happens before the MX lookup, it does not affect the order that is
20535 defined by MX preferences.
20536
20537 If the local host is present in the sublist obtained from MX records, but is
20538 not the most preferred host in that list, it and any equally or less
20539 preferred hosts are removed before the sublist is inserted into the main list.
20540
20541 If the local host is the most preferred host in the MX list, what happens
20542 depends on where in the original list of hosts the &`/MX`& item appears. If it
20543 is not the first item (that is, there are previous hosts in the main list),
20544 Exim discards this name and any subsequent items in the main list.
20545
20546 If the MX item is first in the list of hosts, and the local host is the
20547 most preferred host, what happens is controlled by the &%self%& option of the
20548 router.
20549
20550 DNS failures when lookup up the MX records are treated in the same way as DNS
20551 failures when looking up IP addresses: &%pass_on_timeout%& and
20552 &%host_find_failed%& are used when relevant.
20553
20554 The generic &%ignore_target_hosts%& option applies to all hosts in the list,
20555 whether obtained from an MX lookup or not.
20556
20557
20558
20559 .section "How the options are used" "SECThowoptused"
20560 The options are a sequence of words, space-separated.
20561 One of the words can be the name of a transport; this overrides the
20562 &%transport%& option on the router for this particular routing rule only. The
20563 other words (if present) control randomization of the list of hosts on a
20564 per-rule basis, and how the IP addresses of the hosts are to be found when
20565 routing to a remote transport. These options are as follows:
20566
20567 .ilist
20568 &%randomize%&: randomize the order of the hosts in this list, overriding the
20569 setting of &%hosts_randomize%& for this routing rule only.
20570 .next
20571 &%no_randomize%&: do not randomize the order of the hosts in this list,
20572 overriding the setting of &%hosts_randomize%& for this routing rule only.
20573 .next
20574 &%byname%&: use &[getipnodebyname()]& (&[gethostbyname()]& on older systems) to
20575 find IP addresses. This function may ultimately cause a DNS lookup, but it may
20576 also look in &_/etc/hosts_& or other sources of information.
20577 .next
20578 &%bydns%&: look up address records for the hosts directly in the DNS; fail if
20579 no address records are found. If there is a temporary DNS error (such as a
20580 timeout), delivery is deferred.
20581 .next
20582 &%ipv4_only%&: in direct DNS lookups, look up only A records.
20583 .next
20584 &%ipv4_prefer%&: in direct DNS lookups, sort A records before AAAA records.
20585 .endlist
20586
20587 For example:
20588 .code
20589 route_list = domain1  host1:host2:host3  randomize bydns;\
20590              domain2  host4:host5
20591 .endd
20592 If neither &%byname%& nor &%bydns%& is given, Exim behaves as follows: First, a
20593 DNS lookup is done. If this yields anything other than HOST_NOT_FOUND, that
20594 result is used. Otherwise, Exim goes on to try a call to &[getipnodebyname()]&
20595 or &[gethostbyname()]&, and the result of the lookup is the result of that
20596 call.
20597
20598 &*Warning*&: It has been discovered that on some systems, if a DNS lookup
20599 called via &[getipnodebyname()]& times out, HOST_NOT_FOUND is returned
20600 instead of TRY_AGAIN. That is why the default action is to try a DNS
20601 lookup first. Only if that gives a definite &"no such host"& is the local
20602 function called.
20603
20604 &*Compatibility*&: From Exim 4.85 until fixed for 4.90, there was an
20605 inadvertent constraint that a transport name as an option had to be the last
20606 option specified.
20607
20608
20609
20610 If no IP address for a host can be found, what happens is controlled by the
20611 &%host_find_failed%& option.
20612
20613 .vindex "&$host$&"
20614 When an address is routed to a local transport, IP addresses are not looked up.
20615 The host list is passed to the transport in the &$host$& variable.
20616
20617
20618
20619 .section "Manualroute examples" "SECID123"
20620 In some of the examples that follow, the presence of the &%remote_smtp%&
20621 transport, as defined in the default configuration file, is assumed:
20622
20623 .ilist
20624 .cindex "smart host" "example router"
20625 The &(manualroute)& router can be used to forward all external mail to a
20626 &'smart host'&. If you have set up, in the main part of the configuration, a
20627 named domain list that contains your local domains, for example:
20628 .code
20629 domainlist local_domains = my.domain.example
20630 .endd
20631 You can arrange for all other domains to be routed to a smart host by making
20632 your first router something like this:
20633 .code
20634 smart_route:
20635   driver = manualroute
20636   domains = !+local_domains
20637   transport = remote_smtp
20638   route_list = * smarthost.ref.example
20639 .endd
20640 This causes all non-local addresses to be sent to the single host
20641 &'smarthost.ref.example'&. If a colon-separated list of smart hosts is given,
20642 they are tried in order
20643 (but you can use &%hosts_randomize%& to vary the order each time).
20644 Another way of configuring the same thing is this:
20645 .code
20646 smart_route:
20647   driver = manualroute
20648   transport = remote_smtp
20649   route_list = !+local_domains  smarthost.ref.example
20650 .endd
20651 There is no difference in behaviour between these two routers as they stand.
20652 However, they behave differently if &%no_more%& is added to them. In the first
20653 example, the router is skipped if the domain does not match the &%domains%&
20654 precondition; the following router is always tried. If the router runs, it
20655 always matches the domain and so can never decline. Therefore, &%no_more%&
20656 would have no effect. In the second case, the router is never skipped; it
20657 always runs. However, if it doesn't match the domain, it declines. In this case
20658 &%no_more%& would prevent subsequent routers from running.
20659
20660 .next
20661 .cindex "mail hub example"
20662 A &'mail hub'& is a host which receives mail for a number of domains via MX
20663 records in the DNS and delivers it via its own private routing mechanism. Often
20664 the final destinations are behind a firewall, with the mail hub being the one
20665 machine that can connect to machines both inside and outside the firewall. The
20666 &(manualroute)& router is usually used on a mail hub to route incoming messages
20667 to the correct hosts. For a small number of domains, the routing can be inline,
20668 using the &%route_list%& option, but for a larger number a file or database
20669 lookup is easier to manage.
20670
20671 If the domain names are in fact the names of the machines to which the mail is
20672 to be sent by the mail hub, the configuration can be quite simple. For
20673 example:
20674 .code
20675 hub_route:
20676   driver = manualroute
20677   transport = remote_smtp
20678   route_list = *.rhodes.tvs.example  $domain
20679 .endd
20680 This configuration routes domains that match &`*.rhodes.tvs.example`& to hosts
20681 whose names are the same as the mail domains. A similar approach can be taken
20682 if the host name can be obtained from the domain name by a string manipulation
20683 that the expansion facilities can handle. Otherwise, a lookup based on the
20684 domain can be used to find the host:
20685 .code
20686 through_firewall:
20687   driver = manualroute
20688   transport = remote_smtp
20689   route_data = ${lookup {$domain} cdb {/internal/host/routes}}
20690 .endd
20691 The result of the lookup must be the name or IP address of the host (or
20692 hosts) to which the address is to be routed. If the lookup fails, the route
20693 data is empty, causing the router to decline. The address then passes to the
20694 next router.
20695
20696 .next
20697 .cindex "batched SMTP output example"
20698 .cindex "SMTP" "batched outgoing; example"
20699 You can use &(manualroute)& to deliver messages to pipes or files in batched
20700 SMTP format for onward transportation by some other means. This is one way of
20701 storing mail for a dial-up host when it is not connected. The route list entry
20702 can be as simple as a single domain name in a configuration like this:
20703 .code
20704 save_in_file:
20705   driver = manualroute
20706   transport = batchsmtp_appendfile
20707   route_list = saved.domain.example
20708 .endd
20709 though often a pattern is used to pick up more than one domain. If there are
20710 several domains or groups of domains with different transport requirements,
20711 different transports can be listed in the routing information:
20712 .code
20713 save_in_file:
20714   driver = manualroute
20715   route_list = \
20716     *.saved.domain1.example  $domain  batch_appendfile; \
20717     *.saved.domain2.example  \
20718       ${lookup{$domain}dbm{/domain2/hosts}{$value}fail} \
20719       batch_pipe
20720 .endd
20721 .vindex "&$domain$&"
20722 .vindex "&$host$&"
20723 The first of these just passes the domain in the &$host$& variable, which
20724 doesn't achieve much (since it is also in &$domain$&), but the second does a
20725 file lookup to find a value to pass, causing the router to decline to handle
20726 the address if the lookup fails.
20727
20728 .next
20729 .cindex "UUCP" "example of router for"
20730 Routing mail directly to UUCP software is a specific case of the use of
20731 &(manualroute)& in a gateway to another mail environment. This is an example of
20732 one way it can be done:
20733 .code
20734 # Transport
20735 uucp:
20736   driver = pipe
20737   user = nobody
20738   command = /usr/local/bin/uux -r - \
20739     ${substr_-5:$host}!rmail ${local_part}
20740   return_fail_output = true
20741
20742 # Router
20743 uucphost:
20744   transport = uucp
20745   driver = manualroute
20746   route_data = \
20747     ${lookup{$domain}lsearch{/usr/local/exim/uucphosts}}
20748 .endd
20749 The file &_/usr/local/exim/uucphosts_& contains entries like
20750 .code
20751 darksite.ethereal.example:           darksite.UUCP
20752 .endd
20753 It can be set up more simply without adding and removing &".UUCP"& but this way
20754 makes clear the distinction between the domain name
20755 &'darksite.ethereal.example'& and the UUCP host name &'darksite'&.
20756 .endlist
20757 .ecindex IIDmanrou1
20758 .ecindex IIDmanrou2
20759
20760
20761
20762
20763
20764
20765
20766
20767 . ////////////////////////////////////////////////////////////////////////////
20768 . ////////////////////////////////////////////////////////////////////////////
20769
20770 .chapter "The queryprogram router" "CHAPdriverlast"
20771 .scindex IIDquerou1 "&(queryprogram)& router"
20772 .scindex IIDquerou2 "routers" "&(queryprogram)&"
20773 .cindex "routing" "by external program"
20774 The &(queryprogram)& router routes an address by running an external command
20775 and acting on its output. This is an expensive way to route, and is intended
20776 mainly for use in lightly-loaded systems, or for performing experiments.
20777 However, if it is possible to use the precondition options (&%domains%&,
20778 &%local_parts%&, etc) to skip this router for most addresses, it could sensibly
20779 be used in special cases, even on a busy host. There are the following private
20780 options:
20781 .cindex "options" "&(queryprogram)& router"
20782
20783 .option command queryprogram string&!! unset
20784 This option must be set. It specifies the command that is to be run. The
20785 command is split up into a command name and arguments, and then each is
20786 expanded separately (exactly as for a &(pipe)& transport, described in chapter
20787 &<<CHAPpipetransport>>&).
20788
20789
20790 .option command_group queryprogram string unset
20791 .cindex "gid (group id)" "in &(queryprogram)& router"
20792 This option specifies a gid to be set when running the command while routing an
20793 address for deliver. It must be set if &%command_user%& specifies a numerical
20794 uid. If it begins with a digit, it is interpreted as the numerical value of the
20795 gid. Otherwise it is looked up using &[getgrnam()]&.
20796
20797
20798 .option command_user queryprogram string unset
20799 .cindex "uid (user id)" "for &(queryprogram)&"
20800 This option must be set. It specifies the uid which is set when running the
20801 command while routing an address for delivery. If the value begins with a digit,
20802 it is interpreted as the numerical value of the uid. Otherwise, it is looked up
20803 using &[getpwnam()]& to obtain a value for the uid and, if &%command_group%& is
20804 not set, a value for the gid also.
20805
20806 &*Warning:*& Changing uid and gid is possible only when Exim is running as
20807 root, which it does during a normal delivery in a conventional configuration.
20808 However, when an address is being verified during message reception, Exim is
20809 usually running as the Exim user, not as root. If the &(queryprogram)& router
20810 is called from a non-root process, Exim cannot change uid or gid before running
20811 the command. In this circumstance the command runs under the current uid and
20812 gid.
20813
20814
20815 .option current_directory queryprogram string /
20816 This option specifies an absolute path which is made the current directory
20817 before running the command.
20818
20819
20820 .option timeout queryprogram time 1h
20821 If the command does not complete within the timeout period, its process group
20822 is killed and the message is frozen. A value of zero time specifies no
20823 timeout.
20824
20825
20826 The standard output of the command is connected to a pipe, which is read when
20827 the command terminates. It should consist of a single line of output,
20828 containing up to five fields, separated by white space. The maximum length of
20829 the line is 1023 characters. Longer lines are silently truncated. The first
20830 field is one of the following words (case-insensitive):
20831
20832 .ilist
20833 &'Accept'&: routing succeeded; the remaining fields specify what to do (see
20834 below).
20835 .next
20836 &'Decline'&: the router declines; pass the address to the next router, unless
20837 &%no_more%& is set.
20838 .next
20839 &'Fail'&: routing failed; do not pass the address to any more routers. Any
20840 subsequent text on the line is an error message. If the router is run as part
20841 of address verification during an incoming SMTP message, the message is
20842 included in the SMTP response.
20843 .next
20844 &'Defer'&: routing could not be completed at this time; try again later. Any
20845 subsequent text on the line is an error message which is logged. It is not
20846 included in any SMTP response.
20847 .next
20848 &'Freeze'&: the same as &'defer'&, except that the message is frozen.
20849 .next
20850 &'Pass'&: pass the address to the next router (or the router specified by
20851 &%pass_router%&), overriding &%no_more%&.
20852 .next
20853 &'Redirect'&: the message is redirected. The remainder of the line is a list of
20854 new addresses, which are routed independently, starting with the first router,
20855 or the router specified by &%redirect_router%&, if set.
20856 .endlist
20857
20858 When the first word is &'accept'&, the remainder of the line consists of a
20859 number of keyed data values, as follows (split into two lines here, to fit on
20860 the page):
20861 .code
20862 ACCEPT TRANSPORT=<transport> HOSTS=<list of hosts>
20863 LOOKUP=byname|bydns DATA=<text>
20864 .endd
20865 The data items can be given in any order, and all are optional. If no transport
20866 is included, the transport specified by the generic &%transport%& option is
20867 used. The list of hosts and the lookup type are needed only if the transport is
20868 an &(smtp)& transport that does not itself supply a list of hosts.
20869
20870 The format of the list of hosts is the same as for the &(manualroute)& router.
20871 As well as host names and IP addresses with optional port numbers, as described
20872 in section &<<SECTformatonehostitem>>&, it may contain names followed by
20873 &`/MX`& to specify sublists of hosts that are obtained by looking up MX records
20874 (see section &<<SECThostshowused>>&).
20875
20876 If the lookup type is not specified, Exim behaves as follows when trying to
20877 find an IP address for each host: First, a DNS lookup is done. If this yields
20878 anything other than HOST_NOT_FOUND, that result is used. Otherwise, Exim
20879 goes on to try a call to &[getipnodebyname()]& or &[gethostbyname()]&, and the
20880 result of the lookup is the result of that call.
20881
20882 .vindex "&$address_data$&"
20883 If the DATA field is set, its value is placed in the &$address_data$&
20884 variable. For example, this return line
20885 .code
20886 accept hosts=x1.y.example:x2.y.example data="rule1"
20887 .endd
20888 routes the address to the default transport, passing a list of two hosts. When
20889 the transport runs, the string &"rule1"& is in &$address_data$&.
20890 .ecindex IIDquerou1
20891 .ecindex IIDquerou2
20892
20893
20894
20895
20896 . ////////////////////////////////////////////////////////////////////////////
20897 . ////////////////////////////////////////////////////////////////////////////
20898
20899 .chapter "The redirect router" "CHAPredirect"
20900 .scindex IIDredrou1 "&(redirect)& router"
20901 .scindex IIDredrou2 "routers" "&(redirect)&"
20902 .cindex "alias file" "in a &(redirect)& router"
20903 .cindex "address redirection" "&(redirect)& router"
20904 The &(redirect)& router handles several kinds of address redirection. Its most
20905 common uses are for resolving local part aliases from a central alias file
20906 (usually called &_/etc/aliases_&) and for handling users' personal &_.forward_&
20907 files, but it has many other potential uses. The incoming address can be
20908 redirected in several different ways:
20909
20910 .ilist
20911 It can be replaced by one or more new addresses which are themselves routed
20912 independently.
20913 .next
20914 It can be routed to be delivered to a given file or directory.
20915 .next
20916 It can be routed to be delivered to a specified pipe command.
20917 .next
20918 It can cause an automatic reply to be generated.
20919 .next
20920 It can be forced to fail, optionally with a custom error message.
20921 .next
20922 It can be temporarily deferred, optionally with a custom message.
20923 .next
20924 It can be discarded.
20925 .endlist
20926
20927 The generic &%transport%& option must not be set for &(redirect)& routers.
20928 However, there are some private options which define transports for delivery to
20929 files and pipes, and for generating autoreplies. See the &%file_transport%&,
20930 &%pipe_transport%& and &%reply_transport%& descriptions below.
20931
20932 If success DSNs have been requested
20933 .cindex "DSN" "success"
20934 .cindex "Delivery Status Notification" "success"
20935 redirection triggers one and the DSN options are not passed any further.
20936
20937
20938
20939 .section "Redirection data" "SECID124"
20940 The router operates by interpreting a text string which it obtains either by
20941 expanding the contents of the &%data%& option, or by reading the entire
20942 contents of a file whose name is given in the &%file%& option. These two
20943 options are mutually exclusive. The first is commonly used for handling system
20944 aliases, in a configuration like this:
20945 .code
20946 system_aliases:
20947   driver = redirect
20948   data = ${lookup{$local_part}lsearch{/etc/aliases}}
20949 .endd
20950 If the lookup fails, the expanded string in this example is empty. When the
20951 expansion of &%data%& results in an empty string, the router declines. A forced
20952 expansion failure also causes the router to decline; other expansion failures
20953 cause delivery to be deferred.
20954
20955 A configuration using &%file%& is commonly used for handling users'
20956 &_.forward_& files, like this:
20957 .code
20958 userforward:
20959   driver = redirect
20960   check_local_user
20961   file = $home/.forward
20962   no_verify
20963 .endd
20964 If the file does not exist, or causes no action to be taken (for example, it is
20965 empty or consists only of comments), the router declines. &*Warning*&: This
20966 is not the case when the file contains syntactically valid items that happen to
20967 yield empty addresses, for example, items containing only RFC 2822 address
20968 comments.
20969
20970 .new
20971 .cindex "tainted data" "in filenames"
20972 .cindex redirect "tainted data"
20973 Tainted data may not be used for a filename.
20974
20975 &*Warning*&: It is unwise to use &$local_part$& or &$domain$&
20976 directly for redirection,
20977 as they are provided by a potential attacker.
20978 In the examples above, &$local_part$& is used for looking up data held locally
20979 on the system, and not used directly (the second example derives &$home$& via
20980 the passsword file or database, using &$local_part$&).
20981 .wen
20982
20983
20984
20985 .section "Forward files and address verification" "SECID125"
20986 .cindex "address redirection" "while verifying"
20987 It is usual to set &%no_verify%& on &(redirect)& routers which handle users'
20988 &_.forward_& files, as in the example above. There are two reasons for this:
20989
20990 .ilist
20991 When Exim is receiving an incoming SMTP message from a remote host, it is
20992 running under the Exim uid, not as root. Exim is unable to change uid to read
20993 the file as the user, and it may not be able to read it as the Exim user. So in
20994 practice the router may not be able to operate.
20995 .next
20996 However, even when the router can operate, the existence of a &_.forward_& file
20997 is unimportant when verifying an address. What should be checked is whether the
20998 local part is a valid user name or not. Cutting out the redirection processing
20999 saves some resources.
21000 .endlist
21001
21002
21003
21004
21005
21006
21007 .section "Interpreting redirection data" "SECID126"
21008 .cindex "Sieve filter" "specifying in redirection data"
21009 .cindex "filter" "specifying in redirection data"
21010 The contents of the data string, whether obtained from &%data%& or &%file%&,
21011 can be interpreted in two different ways:
21012
21013 .ilist
21014 If the &%allow_filter%& option is set true, and the data begins with the text
21015 &"#Exim filter"& or &"#Sieve filter"&, it is interpreted as a list of
21016 &'filtering'& instructions in the form of an Exim or Sieve filter file,
21017 respectively. Details of the syntax and semantics of filter files are described
21018 in a separate document entitled &'Exim's interfaces to mail filtering'&; this
21019 document is intended for use by end users.
21020 .next
21021 Otherwise, the data must be a comma-separated list of redirection items, as
21022 described in the next section.
21023 .endlist
21024
21025 When a message is redirected to a file (a &"mail folder"&), the filename given
21026 in a non-filter redirection list must always be an absolute path. A filter may
21027 generate a relative path &-- how this is handled depends on the transport's
21028 configuration. See section &<<SECTfildiropt>>& for a discussion of this issue
21029 for the &(appendfile)& transport.
21030
21031
21032
21033 .section "Items in a non-filter redirection list" "SECTitenonfilred"
21034 .cindex "address redirection" "non-filter list items"
21035 When the redirection data is not an Exim or Sieve filter, for example, if it
21036 comes from a conventional alias or forward file, it consists of a list of
21037 addresses, filenames, pipe commands, or certain special items (see section
21038 &<<SECTspecitredli>>& below). The special items can be individually enabled or
21039 disabled by means of options whose names begin with &%allow_%& or &%forbid_%&,
21040 depending on their default values. The items in the list are separated by
21041 commas or newlines.
21042 If a comma is required in an item, the entire item must be enclosed in double
21043 quotes.
21044
21045 Lines starting with a # character are comments, and are ignored, and # may
21046 also appear following a comma, in which case everything between the # and the
21047 next newline character is ignored.
21048
21049 If an item is entirely enclosed in double quotes, these are removed. Otherwise
21050 double quotes are retained because some forms of mail address require their use
21051 (but never to enclose the entire address). In the following description,
21052 &"item"& refers to what remains after any surrounding double quotes have been
21053 removed.
21054
21055 .vindex "&$local_part$&"
21056 &*Warning*&: If you use an Exim expansion to construct a redirection address,
21057 and the expansion contains a reference to &$local_part$&, you should make use
21058 of the &%quote_local_part%& expansion operator, in case the local part contains
21059 special characters. For example, to redirect all mail for the domain
21060 &'obsolete.example'&, retaining the existing local part, you could use this
21061 setting:
21062 .code
21063 data = ${quote_local_part:$local_part}@newdomain.example
21064 .endd
21065
21066
21067 .section "Redirecting to a local mailbox" "SECTredlocmai"
21068 .cindex "routing" "loops in"
21069 .cindex "loop" "while routing, avoidance of"
21070 .cindex "address redirection" "to local mailbox"
21071 A redirection item may safely be the same as the address currently under
21072 consideration. This does not cause a routing loop, because a router is
21073 automatically skipped if any ancestor of the address that is being processed
21074 is the same as the current address and was processed by the current router.
21075 Such an address is therefore passed to the following routers, so it is handled
21076 as if there were no redirection. When making this loop-avoidance test, the
21077 complete local part, including any prefix or suffix, is used.
21078
21079 .cindex "address redirection" "local part without domain"
21080 Specifying the same local part without a domain is a common usage in personal
21081 filter files when the user wants to have messages delivered to the local
21082 mailbox and also forwarded elsewhere. For example, the user whose login is
21083 &'cleo'& might have a &_.forward_& file containing this:
21084 .code
21085 cleo, cleopatra@egypt.example
21086 .endd
21087 .cindex "backslash in alias file"
21088 .cindex "alias file" "backslash in"
21089 For compatibility with other MTAs, such unqualified local parts may be
21090 preceded by &"\"&, but this is not a requirement for loop prevention. However,
21091 it does make a difference if more than one domain is being handled
21092 synonymously.
21093
21094 If an item begins with &"\"& and the rest of the item parses as a valid RFC
21095 2822 address that does not include a domain, the item is qualified using the
21096 domain of the incoming address. In the absence of a leading &"\"&, unqualified
21097 addresses are qualified using the value in &%qualify_recipient%&, but you can
21098 force the incoming domain to be used by setting &%qualify_preserve_domain%&.
21099
21100 Care must be taken if there are alias names for local users.
21101 Consider an MTA handling a single local domain where the system alias file
21102 contains:
21103 .code
21104 Sam.Reman: spqr
21105 .endd
21106 Now suppose that Sam (whose login id is &'spqr'&) wants to save copies of
21107 messages in the local mailbox, and also forward copies elsewhere. He creates
21108 this forward file:
21109 .code
21110 Sam.Reman, spqr@reme.elsewhere.example
21111 .endd
21112 With these settings, an incoming message addressed to &'Sam.Reman'& fails. The
21113 &(redirect)& router for system aliases does not process &'Sam.Reman'& the
21114 second time round, because it has previously routed it,
21115 and the following routers presumably cannot handle the alias. The forward file
21116 should really contain
21117 .code
21118 spqr, spqr@reme.elsewhere.example
21119 .endd
21120 but because this is such a common error, the &%check_ancestor%& option (see
21121 below) exists to provide a way to get round it. This is normally set on a
21122 &(redirect)& router that is handling users' &_.forward_& files.
21123
21124
21125
21126 .section "Special items in redirection lists" "SECTspecitredli"
21127 In addition to addresses, the following types of item may appear in redirection
21128 lists (that is, in non-filter redirection data):
21129
21130 .ilist
21131 .cindex "pipe" "in redirection list"
21132 .cindex "address redirection" "to pipe"
21133 An item is treated as a pipe command if it begins with &"|"& and does not parse
21134 as a valid RFC 2822 address that includes a domain. A transport for running the
21135 command must be specified by the &%pipe_transport%& option.
21136 Normally, either the router or the transport specifies a user and a group under
21137 which to run the delivery. The default is to use the Exim user and group.
21138
21139 Single or double quotes can be used for enclosing the individual arguments of
21140 the pipe command; no interpretation of escapes is done for single quotes. If
21141 the command contains a comma character, it is necessary to put the whole item
21142 in double quotes, for example:
21143 .code
21144 "|/some/command ready,steady,go"
21145 .endd
21146 since items in redirection lists are terminated by commas. Do not, however,
21147 quote just the command. An item such as
21148 .code
21149 |"/some/command ready,steady,go"
21150 .endd
21151 is interpreted as a pipe with a rather strange command name, and no arguments.
21152
21153 Note that the above example assumes that the text comes from a lookup source
21154 of some sort, so that the quotes are part of the data.  If composing a
21155 redirect router with a &%data%& option directly specifying this command, the
21156 quotes will be used by the configuration parser to define the extent of one
21157 string, but will not be passed down into the redirect router itself.  There
21158 are two main approaches to get around this: escape quotes to be part of the
21159 data itself, or avoid using this mechanism and instead create a custom
21160 transport with the &%command%& option set and reference that transport from
21161 an &%accept%& router.
21162
21163 .next
21164 .cindex "file" "in redirection list"
21165 .cindex "address redirection" "to file"
21166 An item is interpreted as a path name if it begins with &"/"& and does not
21167 parse as a valid RFC 2822 address that includes a domain. For example,
21168 .code
21169 /home/world/minbari
21170 .endd
21171 is treated as a filename, but
21172 .code
21173 /s=molari/o=babylon/@x400gate.way
21174 .endd
21175 is treated as an address. For a filename, a transport must be specified using
21176 the &%file_transport%& option. However, if the generated path name ends with a
21177 forward slash character, it is interpreted as a directory name rather than a
21178 filename, and &%directory_transport%& is used instead.
21179
21180 Normally, either the router or the transport specifies a user and a group under
21181 which to run the delivery. The default is to use the Exim user and group.
21182
21183 .cindex "&_/dev/null_&"
21184 However, if a redirection item is the path &_/dev/null_&, delivery to it is
21185 bypassed at a high level, and the log entry shows &"**bypassed**"&
21186 instead of a transport name. In this case the user and group are not used.
21187
21188 .next
21189 .cindex "included address list"
21190 .cindex "address redirection" "included external list"
21191 If an item is of the form
21192 .code
21193 :include:<path name>
21194 .endd
21195 a list of further items is taken from the given file and included at that
21196 point. &*Note*&: Such a file can not be a filter file; it is just an
21197 out-of-line addition to the list. The items in the included list are separated
21198 by commas or newlines and are not subject to expansion. If this is the first
21199 item in an alias list in an &(lsearch)& file, a colon must be used to terminate
21200 the alias name. This example is incorrect:
21201 .code
21202 list1    :include:/opt/lists/list1
21203 .endd
21204 It must be given as
21205 .code
21206 list1:   :include:/opt/lists/list1
21207 .endd
21208 .new
21209 .cindex "tainted data" "in filenames"
21210 .cindex redirect "tainted data"
21211 Tainted data may not be used for a filename.
21212 .wen
21213 .next
21214 .cindex "address redirection" "to black hole"
21215 .cindex "delivery" "discard"
21216 .cindex "delivery" "blackhole"
21217 .cindex "black hole"
21218 .cindex "abandoning mail"
21219 Sometimes you want to throw away mail to a particular local part.  Making the
21220 &%data%& option expand to an empty string does not work, because that causes
21221 the router to decline. Instead, the alias item
21222 .code
21223 :blackhole:
21224 .endd
21225 can be used. It does what its name implies. No delivery is
21226 done, and no error message is generated. This has the same effect as specifying
21227 &_/dev/null_& as a destination, but it can be independently disabled.
21228
21229 &*Warning*&: If &':blackhole:'& appears anywhere in a redirection list, no
21230 delivery is done for the original local part, even if other redirection items
21231 are present. If you are generating a multi-item list (for example, by reading a
21232 database) and need the ability to provide a no-op item, you must use
21233 &_/dev/null_&.
21234
21235 .next
21236 .cindex "delivery" "forcing failure"
21237 .cindex "delivery" "forcing deferral"
21238 .cindex "failing delivery" "forcing"
21239 .cindex "deferred delivery, forcing"
21240 .cindex "customizing" "failure message"
21241 An attempt to deliver a particular address can be deferred or forced to fail by
21242 redirection items of the form
21243 .code
21244 :defer:
21245 :fail:
21246 .endd
21247 respectively. When a redirection list contains such an item, it applies
21248 to the entire redirection; any other items in the list are ignored. Any
21249 text following &':fail:'& or &':defer:'& is placed in the error text
21250 associated with the failure. For example, an alias file might contain:
21251 .code
21252 X.Employee:  :fail: Gone away, no forwarding address
21253 .endd
21254 In the case of an address that is being verified from an ACL or as the subject
21255 of a
21256 .cindex "VRFY" "error text, display of"
21257 VRFY command, the text is included in the SMTP error response by
21258 default.
21259 .cindex "EXPN" "error text, display of"
21260 The text is not included in the response to an EXPN command. In non-SMTP cases
21261 the text is included in the error message that Exim generates.
21262
21263 .cindex "SMTP" "error codes"
21264 By default, Exim sends a 451 SMTP code for a &':defer:'&, and 550 for
21265 &':fail:'&. However, if the message starts with three digits followed by a
21266 space, optionally followed by an extended code of the form &'n.n.n'&, also
21267 followed by a space, and the very first digit is the same as the default error
21268 code, the code from the message is used instead. If the very first digit is
21269 incorrect, a panic error is logged, and the default code is used. You can
21270 suppress the use of the supplied code in a redirect router by setting the
21271 &%forbid_smtp_code%& option true. In this case, any SMTP code is quietly
21272 ignored.
21273
21274 .vindex "&$acl_verify_message$&"
21275 In an ACL, an explicitly provided message overrides the default, but the
21276 default message is available in the variable &$acl_verify_message$& and can
21277 therefore be included in a custom message if this is desired.
21278
21279 Normally the error text is the rest of the redirection list &-- a comma does
21280 not terminate it &-- but a newline does act as a terminator. Newlines are not
21281 normally present in alias expansions. In &(lsearch)& lookups they are removed
21282 as part of the continuation process, but they may exist in other kinds of
21283 lookup and in &':include:'& files.
21284
21285 During routing for message delivery (as opposed to verification), a redirection
21286 containing &':fail:'& causes an immediate failure of the incoming address,
21287 whereas &':defer:'& causes the message to remain in the queue so that a
21288 subsequent delivery attempt can happen at a later time. If an address is
21289 deferred for too long, it will ultimately fail, because the normal retry
21290 rules still apply.
21291
21292 .next
21293 .cindex "alias file" "exception to default"
21294 Sometimes it is useful to use a single-key search type with a default (see
21295 chapter &<<CHAPfdlookup>>&) to look up aliases. However, there may be a need
21296 for exceptions to the default. These can be handled by aliasing them to
21297 &':unknown:'&. This differs from &':fail:'& in that it causes the &(redirect)&
21298 router to decline, whereas &':fail:'& forces routing to fail. A lookup which
21299 results in an empty redirection list has the same effect.
21300 .endlist
21301
21302
21303 .section "Duplicate addresses" "SECTdupaddr"
21304 .cindex "duplicate addresses"
21305 .cindex "address duplicate, discarding"
21306 .cindex "pipe" "duplicated"
21307 Exim removes duplicate addresses from the list to which it is delivering, so as
21308 to deliver just one copy to each address. This does not apply to deliveries
21309 routed to pipes by different immediate parent addresses, but an indirect
21310 aliasing scheme of the type
21311 .code
21312 pipe:       |/some/command $local_part
21313 localpart1: pipe
21314 localpart2: pipe
21315 .endd
21316 does not work with a message that is addressed to both local parts, because
21317 when the second is aliased to the intermediate local part &"pipe"& it gets
21318 discarded as being the same as a previously handled address. However, a scheme
21319 such as
21320 .code
21321 localpart1: |/some/command $local_part
21322 localpart2: |/some/command $local_part
21323 .endd
21324 does result in two different pipe deliveries, because the immediate parents of
21325 the pipes are distinct.
21326
21327
21328
21329 .section "Repeated redirection expansion" "SECID128"
21330 .cindex "repeated redirection expansion"
21331 .cindex "address redirection" "repeated for each delivery attempt"
21332 When a message cannot be delivered to all of its recipients immediately,
21333 leading to two or more delivery attempts, redirection expansion is carried out
21334 afresh each time for those addresses whose children were not all previously
21335 delivered. If redirection is being used as a mailing list, this can lead to new
21336 members of the list receiving copies of old messages. The &%one_time%& option
21337 can be used to avoid this.
21338
21339
21340 .section "Errors in redirection lists" "SECID129"
21341 .cindex "address redirection" "errors"
21342 If &%skip_syntax_errors%& is set, a malformed address that causes a parsing
21343 error is skipped, and an entry is written to the main log. This may be useful
21344 for mailing lists that are automatically managed. Otherwise, if an error is
21345 detected while generating the list of new addresses, the original address is
21346 deferred. See also &%syntax_errors_to%&.
21347
21348
21349
21350 .section "Private options for the redirect router" "SECID130"
21351
21352 .cindex "options" "&(redirect)& router"
21353 The private options for the &(redirect)& router are as follows:
21354
21355
21356 .option allow_defer redirect boolean false
21357 Setting this option allows the use of &':defer:'& in non-filter redirection
21358 data, or the &%defer%& command in an Exim filter file.
21359
21360
21361 .option allow_fail redirect boolean false
21362 .cindex "failing delivery" "from filter"
21363 If this option is true, the &':fail:'& item can be used in a redirection list,
21364 and the &%fail%& command may be used in an Exim filter file.
21365
21366
21367 .option allow_filter redirect boolean false
21368 .cindex "filter" "enabling use of"
21369 .cindex "Sieve filter" "enabling use of"
21370 Setting this option allows Exim to interpret redirection data that starts with
21371 &"#Exim filter"& or &"#Sieve filter"& as a set of filtering instructions. There
21372 are some features of Exim filter files that some administrators may wish to
21373 lock out; see the &%forbid_filter_%&&'xxx'& options below.
21374
21375 It is also possible to lock out Exim filters or Sieve filters while allowing
21376 the other type; see &%forbid_exim_filter%& and &%forbid_sieve_filter%&.
21377
21378
21379 The filter is run using the uid and gid set by the generic &%user%& and
21380 &%group%& options. These take their defaults from the password data if
21381 &%check_local_user%& is set, so in the normal case of users' personal filter
21382 files, the filter is run as the relevant user. When &%allow_filter%& is set
21383 true, Exim insists that either &%check_local_user%& or &%user%& is set.
21384
21385
21386
21387 .option allow_freeze redirect boolean false
21388 .cindex "freezing messages" "allowing in filter"
21389 Setting this option allows the use of the &%freeze%& command in an Exim filter.
21390 This command is more normally encountered in system filters, and is disabled by
21391 default for redirection filters because it isn't something you usually want to
21392 let ordinary users do.
21393
21394
21395
21396 .option check_ancestor redirect boolean false
21397 This option is concerned with handling generated addresses that are the same
21398 as some address in the list of redirection ancestors of the current address.
21399 Although it is turned off by default in the code, it is set in the default
21400 configuration file for handling users' &_.forward_& files. It is recommended
21401 for this use of the &(redirect)& router.
21402
21403 When &%check_ancestor%& is set, if a generated address (including the domain)
21404 is the same as any ancestor of the current address, it is replaced by a copy of
21405 the current address. This helps in the case where local part A is aliased to B,
21406 and B has a &_.forward_& file pointing back to A. For example, within a single
21407 domain, the local part &"Joe.Bloggs"& is aliased to &"jb"& and
21408 &_&~jb/.forward_& contains:
21409 .code
21410 \Joe.Bloggs, <other item(s)>
21411 .endd
21412 Without the &%check_ancestor%& setting, either local part (&"jb"& or
21413 &"joe.bloggs"&) gets processed once by each router and so ends up as it was
21414 originally. If &"jb"& is the real mailbox name, mail to &"jb"& gets delivered
21415 (having been turned into &"joe.bloggs"& by the &_.forward_& file and back to
21416 &"jb"& by the alias), but mail to &"joe.bloggs"& fails. Setting
21417 &%check_ancestor%& on the &(redirect)& router that handles the &_.forward_&
21418 file prevents it from turning &"jb"& back into &"joe.bloggs"& when that was the
21419 original address. See also the &%repeat_use%& option below.
21420
21421
21422 .option check_group redirect boolean "see below"
21423 When the &%file%& option is used, the group owner of the file is checked only
21424 when this option is set. The permitted groups are those listed in the
21425 &%owngroups%& option, together with the user's default group if
21426 &%check_local_user%& is set. If the file has the wrong group, routing is
21427 deferred. The default setting for this option is true if &%check_local_user%&
21428 is set and the &%modemask%& option permits the group write bit, or if the
21429 &%owngroups%& option is set. Otherwise it is false, and no group check occurs.
21430
21431
21432
21433 .option check_owner redirect boolean "see below"
21434 When the &%file%& option is used, the owner of the file is checked only when
21435 this option is set. If &%check_local_user%& is set, the local user is
21436 permitted; otherwise the owner must be one of those listed in the &%owners%&
21437 option. The default value for this option is true if &%check_local_user%& or
21438 &%owners%& is set. Otherwise the default is false, and no owner check occurs.
21439
21440
21441 .option data redirect string&!! unset
21442 This option is mutually exclusive with &%file%&. One or other of them must be
21443 set, but not both. The contents of &%data%& are expanded, and then used as the
21444 list of forwarding items, or as a set of filtering instructions. If the
21445 expansion is forced to fail, or the result is an empty string or a string that
21446 has no effect (consists entirely of comments), the router declines.
21447
21448 When filtering instructions are used, the string must begin with &"#Exim
21449 filter"&, and all comments in the string, including this initial one, must be
21450 terminated with newline characters. For example:
21451 .code
21452 data = #Exim filter\n\
21453        if $h_to: contains Exim then save $home/mail/exim endif
21454 .endd
21455 If you are reading the data from a database where newlines cannot be included,
21456 you can use the &${sg}$& expansion item to turn the escape string of your
21457 choice into a newline.
21458
21459
21460 .option directory_transport redirect string&!! unset
21461 A &(redirect)& router sets up a direct delivery to a directory when a path name
21462 ending with a slash is specified as a new &"address"&. The transport used is
21463 specified by this option, which, after expansion, must be the name of a
21464 configured transport. This should normally be an &(appendfile)& transport.
21465
21466
21467 .option file redirect string&!! unset
21468 This option specifies the name of a file that contains the redirection data. It
21469 is mutually exclusive with the &%data%& option. The string is expanded before
21470 use; if the expansion is forced to fail, the router declines. Other expansion
21471 failures cause delivery to be deferred. The result of a successful expansion
21472 must be an absolute path. The entire file is read and used as the redirection
21473 data. If the data is an empty string or a string that has no effect (consists
21474 entirely of comments), the router declines.
21475
21476 .cindex "NFS" "checking for file existence"
21477 If the attempt to open the file fails with a &"does not exist"& error, Exim
21478 runs a check on the containing directory,
21479 unless &%ignore_enotdir%& is true (see below).
21480 If the directory does not appear to exist, delivery is deferred. This can
21481 happen when users' &_.forward_& files are in NFS-mounted directories, and there
21482 is a mount problem. If the containing directory does exist, but the file does
21483 not, the router declines.
21484
21485
21486 .option file_transport redirect string&!! unset
21487 .vindex "&$address_file$&"
21488 A &(redirect)& router sets up a direct delivery to a file when a path name not
21489 ending in a slash is specified as a new &"address"&. The transport used is
21490 specified by this option, which, after expansion, must be the name of a
21491 configured transport. This should normally be an &(appendfile)& transport. When
21492 it is running, the filename is in &$address_file$&.
21493
21494
21495 .option filter_prepend_home redirect boolean true
21496 When this option is true, if a &(save)& command in an Exim filter specifies a
21497 relative path, and &$home$& is defined, it is automatically prepended to the
21498 relative path. If this option is set false, this action does not happen. The
21499 relative path is then passed to the transport unmodified.
21500
21501
21502 .option forbid_blackhole redirect boolean false
21503 .cindex "restricting access to features"
21504 .cindex "filter" "locking out certain features"
21505 If this option is true, the &':blackhole:'& item may not appear in a
21506 redirection list.
21507
21508
21509 .option forbid_exim_filter redirect boolean false
21510 .cindex "restricting access to features"
21511 .cindex "filter" "locking out certain features"
21512 If this option is set true, only Sieve filters are permitted when
21513 &%allow_filter%& is true.
21514
21515
21516
21517
21518 .option forbid_file redirect boolean false
21519 .cindex "restricting access to features"
21520 .cindex "delivery" "to file; forbidding"
21521 .cindex "filter" "locking out certain features"
21522 .cindex "Sieve filter" "forbidding delivery to a file"
21523 .cindex "Sieve filter" "&""keep""& facility; disabling"
21524 If this option is true, this router may not generate a new address that
21525 specifies delivery to a local file or directory, either from a filter or from a
21526 conventional forward file. This option is forced to be true if &%one_time%& is
21527 set. It applies to Sieve filters as well as to Exim filters, but if true, it
21528 locks out the Sieve's &"keep"& facility.
21529
21530
21531 .option forbid_filter_dlfunc redirect boolean false
21532 .cindex "restricting access to features"
21533 .cindex "filter" "locking out certain features"
21534 If this option is true, string expansions in Exim filters are not allowed to
21535 make use of the &%dlfunc%& expansion facility to run dynamically loaded
21536 functions.
21537
21538 .option forbid_filter_existstest redirect boolean false
21539 .cindex "restricting access to features"
21540 .cindex "filter" "locking out certain features"
21541 .cindex "expansion" "statting a file"
21542 If this option is true, string expansions in Exim filters are not allowed to
21543 make use of the &%exists%& condition or the &%stat%& expansion item.
21544
21545 .option forbid_filter_logwrite redirect boolean false
21546 .cindex "restricting access to features"
21547 .cindex "filter" "locking out certain features"
21548 If this option is true, use of the logging facility in Exim filters is not
21549 permitted. Logging is in any case available only if the filter is being run
21550 under some unprivileged uid (which is normally the case for ordinary users'
21551 &_.forward_& files).
21552
21553
21554 .option forbid_filter_lookup redirect boolean false
21555 .cindex "restricting access to features"
21556 .cindex "filter" "locking out certain features"
21557 If this option is true, string expansions in Exim filter files are not allowed
21558 to make use of &%lookup%& items.
21559
21560
21561 .option forbid_filter_perl redirect boolean false
21562 .cindex "restricting access to features"
21563 .cindex "filter" "locking out certain features"
21564 This option has an effect only if Exim is built with embedded Perl support. If
21565 it is true, string expansions in Exim filter files are not allowed to make use
21566 of the embedded Perl support.
21567
21568
21569 .option forbid_filter_readfile redirect boolean false
21570 .cindex "restricting access to features"
21571 .cindex "filter" "locking out certain features"
21572 If this option is true, string expansions in Exim filter files are not allowed
21573 to make use of &%readfile%& items.
21574
21575
21576 .option forbid_filter_readsocket redirect boolean false
21577 .cindex "restricting access to features"
21578 .cindex "filter" "locking out certain features"
21579 If this option is true, string expansions in Exim filter files are not allowed
21580 to make use of &%readsocket%& items.
21581
21582
21583 .option forbid_filter_reply redirect boolean false
21584 .cindex "restricting access to features"
21585 .cindex "filter" "locking out certain features"
21586 If this option is true, this router may not generate an automatic reply
21587 message. Automatic replies can be generated only from Exim or Sieve filter
21588 files, not from traditional forward files. This option is forced to be true if
21589 &%one_time%& is set.
21590
21591
21592 .option forbid_filter_run redirect boolean false
21593 .cindex "restricting access to features"
21594 .cindex "filter" "locking out certain features"
21595 If this option is true, string expansions in Exim filter files are not allowed
21596 to make use of &%run%& items.
21597
21598
21599 .option forbid_include redirect boolean false
21600 .cindex "restricting access to features"
21601 .cindex "filter" "locking out certain features"
21602 If this option is true, items of the form
21603 .code
21604 :include:<path name>
21605 .endd
21606 are not permitted in non-filter redirection lists.
21607
21608
21609 .option forbid_pipe redirect boolean false
21610 .cindex "restricting access to features"
21611 .cindex "filter" "locking out certain features"
21612 .cindex "delivery" "to pipe; forbidding"
21613 If this option is true, this router may not generate a new address which
21614 specifies delivery to a pipe, either from an Exim filter or from a conventional
21615 forward file. This option is forced to be true if &%one_time%& is set.
21616
21617
21618 .option forbid_sieve_filter redirect boolean false
21619 .cindex "restricting access to features"
21620 .cindex "filter" "locking out certain features"
21621 If this option is set true, only Exim filters are permitted when
21622 &%allow_filter%& is true.
21623
21624
21625 .cindex "SMTP" "error codes"
21626 .option forbid_smtp_code redirect boolean false
21627 If this option is set true, any SMTP error codes that are present at the start
21628 of messages specified for &`:defer:`& or &`:fail:`& are quietly ignored, and
21629 the default codes (451 and 550, respectively) are always used.
21630
21631
21632
21633
21634 .option hide_child_in_errmsg redirect boolean false
21635 .cindex "bounce message" "redirection details; suppressing"
21636 If this option is true, it prevents Exim from quoting a child address if it
21637 generates a bounce or delay message for it. Instead it says &"an address
21638 generated from <&'the top level address'&>"&. Of course, this applies only to
21639 bounces generated locally. If a message is forwarded to another host, &'its'&
21640 bounce may well quote the generated address.
21641
21642
21643 .option ignore_eacces redirect boolean false
21644 .cindex "EACCES"
21645 If this option is set and an attempt to open a redirection file yields the
21646 EACCES error (permission denied), the &(redirect)& router behaves as if the
21647 file did not exist.
21648
21649
21650 .option ignore_enotdir redirect boolean false
21651 .cindex "ENOTDIR"
21652 If this option is set and an attempt to open a redirection file yields the
21653 ENOTDIR error (something on the path is not a directory), the &(redirect)&
21654 router behaves as if the file did not exist.
21655
21656 Setting &%ignore_enotdir%& has another effect as well: When a &(redirect)&
21657 router that has the &%file%& option set discovers that the file does not exist
21658 (the ENOENT error), it tries to &[stat()]& the parent directory, as a check
21659 against unmounted NFS directories. If the parent can not be statted, delivery
21660 is deferred. However, it seems wrong to do this check when &%ignore_enotdir%&
21661 is set, because that option tells Exim to ignore &"something on the path is not
21662 a directory"& (the ENOTDIR error). This is a confusing area, because it seems
21663 that some operating systems give ENOENT where others give ENOTDIR.
21664
21665
21666
21667 .option include_directory redirect string unset
21668 If this option is set, the path names of any &':include:'& items in a
21669 redirection list must start with this directory.
21670
21671
21672 .option modemask redirect "octal integer" 022
21673 This specifies mode bits which must not be set for a file specified by the
21674 &%file%& option. If any of the forbidden bits are set, delivery is deferred.
21675
21676
21677 .option one_time redirect boolean false
21678 .cindex "one-time aliasing/forwarding expansion"
21679 .cindex "alias file" "one-time expansion"
21680 .cindex "forward file" "one-time expansion"
21681 .cindex "mailing lists" "one-time expansion"
21682 .cindex "address redirection" "one-time expansion"
21683 Sometimes the fact that Exim re-evaluates aliases and reprocesses redirection
21684 files each time it tries to deliver a message causes a problem when one or more
21685 of the generated addresses fails be delivered at the first attempt. The problem
21686 is not one of duplicate delivery &-- Exim is clever enough to handle that &--
21687 but of what happens when the redirection list changes during the time that the
21688 message is on Exim's queue. This is particularly true in the case of mailing
21689 lists, where new subscribers might receive copies of messages that were posted
21690 before they subscribed.
21691
21692 If &%one_time%& is set and any addresses generated by the router fail to
21693 deliver at the first attempt, the failing addresses are added to the message as
21694 &"top level"& addresses, and the parent address that generated them is marked
21695 &"delivered"&. Thus, redirection does not happen again at the next delivery
21696 attempt.
21697
21698 &*Warning 1*&: Any header line addition or removal that is specified by this
21699 router would be lost if delivery did not succeed at the first attempt. For this
21700 reason, the &%headers_add%& and &%headers_remove%& generic options are not
21701 permitted when &%one_time%& is set.
21702
21703 &*Warning 2*&: To ensure that the router generates only addresses (as opposed
21704 to pipe or file deliveries or auto-replies) &%forbid_file%&, &%forbid_pipe%&,
21705 and &%forbid_filter_reply%& are forced to be true when &%one_time%& is set.
21706
21707 &*Warning 3*&: The &%unseen%& generic router option may not be set with
21708 &%one_time%&.
21709
21710 The original top-level address is remembered with each of the generated
21711 addresses, and is output in any log messages. However, any intermediate parent
21712 addresses are not recorded. This makes a difference to the log only if
21713 &%all_parents%& log selector is set. It is expected that &%one_time%& will
21714 typically be used for mailing lists, where there is normally just one level of
21715 expansion.
21716
21717
21718 .option owners redirect "string list" unset
21719 .cindex "ownership" "alias file"
21720 .cindex "ownership" "forward file"
21721 .cindex "alias file" "ownership"
21722 .cindex "forward file" "ownership"
21723 This specifies a list of permitted owners for the file specified by &%file%&.
21724 This list is in addition to the local user when &%check_local_user%& is set.
21725 See &%check_owner%& above.
21726
21727
21728 .option owngroups redirect "string list" unset
21729 This specifies a list of permitted groups for the file specified by &%file%&.
21730 The list is in addition to the local user's primary group when
21731 &%check_local_user%& is set. See &%check_group%& above.
21732
21733
21734 .option pipe_transport redirect string&!! unset
21735 .vindex "&$address_pipe$&"
21736 A &(redirect)& router sets up a direct delivery to a pipe when a string
21737 starting with a vertical bar character is specified as a new &"address"&. The
21738 transport used is specified by this option, which, after expansion, must be the
21739 name of a configured transport. This should normally be a &(pipe)& transport.
21740 When the transport is run, the pipe command is in &$address_pipe$&.
21741
21742
21743 .option qualify_domain redirect string&!! unset
21744 .vindex "&$qualify_recipient$&"
21745 If this option is set, and an unqualified address (one without a domain) is
21746 generated, and that address would normally be qualified by the global setting
21747 in &%qualify_recipient%&, it is instead qualified with the domain specified by
21748 expanding this string. If the expansion fails, the router declines. If you want
21749 to revert to the default, you can have the expansion generate
21750 &$qualify_recipient$&.
21751
21752 This option applies to all unqualified addresses generated by Exim filters,
21753 but for traditional &_.forward_& files, it applies only to addresses that are
21754 not preceded by a backslash. Sieve filters cannot generate unqualified
21755 addresses.
21756
21757 .option qualify_preserve_domain redirect boolean false
21758 .cindex "domain" "in redirection; preserving"
21759 .cindex "preserving domain in redirection"
21760 .cindex "address redirection" "domain; preserving"
21761 If this option is set, the router's local &%qualify_domain%& option must not be
21762 set (a configuration error occurs if it is). If an unqualified address (one
21763 without a domain) is generated, it is qualified with the domain of the parent
21764 address (the immediately preceding ancestor) instead of the global
21765 &%qualify_recipient%& value. In the case of a traditional &_.forward_& file,
21766 this applies whether or not the address is preceded by a backslash.
21767
21768
21769 .option repeat_use redirect boolean true
21770 If this option is set false, the router is skipped for a child address that has
21771 any ancestor that was routed by this router. This test happens before any of
21772 the other preconditions are tested. Exim's default anti-looping rules skip
21773 only when the ancestor is the same as the current address. See also
21774 &%check_ancestor%& above and the generic &%redirect_router%& option.
21775
21776
21777 .option reply_transport redirect string&!! unset
21778 A &(redirect)& router sets up an automatic reply when a &%mail%& or
21779 &%vacation%& command is used in a filter file. The transport used is specified
21780 by this option, which, after expansion, must be the name of a configured
21781 transport. This should normally be an &(autoreply)& transport. Other transports
21782 are unlikely to do anything sensible or useful.
21783
21784
21785 .option rewrite redirect boolean true
21786 .cindex "address redirection" "disabling rewriting"
21787 If this option is set false, addresses generated by the router are not
21788 subject to address rewriting. Otherwise, they are treated like new addresses
21789 and are rewritten according to the global rewriting rules.
21790
21791
21792 .option sieve_subaddress redirect string&!! unset
21793 The value of this option is passed to a Sieve filter to specify the
21794 :subaddress part of an address.
21795
21796 .option sieve_useraddress redirect string&!! unset
21797 The value of this option is passed to a Sieve filter to specify the :user part
21798 of an address. However, if it is unset, the entire original local part
21799 (including any prefix or suffix) is used for :user.
21800
21801
21802 .option sieve_vacation_directory redirect string&!! unset
21803 .cindex "Sieve filter" "vacation directory"
21804 To enable the &"vacation"& extension for Sieve filters, you must set
21805 &%sieve_vacation_directory%& to the directory where vacation databases are held
21806 (do not put anything else in that directory), and ensure that the
21807 &%reply_transport%& option refers to an &(autoreply)& transport. Each user
21808 needs their own directory; Exim will create it if necessary.
21809
21810
21811
21812 .option skip_syntax_errors redirect boolean false
21813 .cindex "forward file" "broken"
21814 .cindex "address redirection" "broken files"
21815 .cindex "alias file" "broken"
21816 .cindex "broken alias or forward files"
21817 .cindex "ignoring faulty addresses"
21818 .cindex "skipping faulty addresses"
21819 .cindex "error" "skipping bad syntax"
21820 If &%skip_syntax_errors%& is set, syntactically malformed addresses in
21821 non-filter redirection data are skipped, and each failing address is logged. If
21822 &%syntax_errors_to%& is set, a message is sent to the address it defines,
21823 giving details of the failures. If &%syntax_errors_text%& is set, its contents
21824 are expanded and placed at the head of the error message generated by
21825 &%syntax_errors_to%&. Usually it is appropriate to set &%syntax_errors_to%& to
21826 be the same address as the generic &%errors_to%& option. The
21827 &%skip_syntax_errors%& option is often used when handling mailing lists.
21828
21829 If all the addresses in a redirection list are skipped because of syntax
21830 errors, the router declines to handle the original address, and it is passed to
21831 the following routers.
21832
21833 If &%skip_syntax_errors%& is set when an Exim filter is interpreted, any syntax
21834 error in the filter causes filtering to be abandoned without any action being
21835 taken. The incident is logged, and the router declines to handle the address,
21836 so it is passed to the following routers.
21837
21838 .cindex "Sieve filter" "syntax errors in"
21839 Syntax errors in a Sieve filter file cause the &"keep"& action to occur. This
21840 action is specified by RFC 3028. The values of &%skip_syntax_errors%&,
21841 &%syntax_errors_to%&, and &%syntax_errors_text%& are not used.
21842
21843 &%skip_syntax_errors%& can be used to specify that errors in users' forward
21844 lists or filter files should not prevent delivery. The &%syntax_errors_to%&
21845 option, used with an address that does not get redirected, can be used to
21846 notify users of these errors, by means of a router like this:
21847 .code
21848 userforward:
21849   driver = redirect
21850   allow_filter
21851   check_local_user
21852   file = $home/.forward
21853   file_transport = address_file
21854   pipe_transport = address_pipe
21855   reply_transport = address_reply
21856   no_verify
21857   skip_syntax_errors
21858   syntax_errors_to = real-$local_part@$domain
21859   syntax_errors_text = \
21860    This is an automatically generated message. An error has\n\
21861    been found in your .forward file. Details of the error are\n\
21862    reported below. While this error persists, you will receive\n\
21863    a copy of this message for every message that is addressed\n\
21864    to you. If your .forward file is a filter file, or if it is\n\
21865    a non-filter file containing no valid forwarding addresses,\n\
21866    a copy of each incoming message will be put in your normal\n\
21867    mailbox. If a non-filter file contains at least one valid\n\
21868    forwarding address, forwarding to the valid addresses will\n\
21869    happen, and those will be the only deliveries that occur.
21870 .endd
21871 You also need a router to ensure that local addresses that are prefixed by
21872 &`real-`& are recognized, but not forwarded or filtered. For example, you could
21873 put this immediately before the &(userforward)& router:
21874 .code
21875 real_localuser:
21876   driver = accept
21877   check_local_user
21878   local_part_prefix = real-
21879   transport = local_delivery
21880 .endd
21881 For security, it would probably be a good idea to restrict the use of this
21882 router to locally-generated messages, using a condition such as this:
21883 .code
21884   condition = ${if match {$sender_host_address}\
21885                          {\N^(|127\.0\.0\.1)$\N}}
21886 .endd
21887
21888
21889 .option syntax_errors_text redirect string&!! unset
21890 See &%skip_syntax_errors%& above.
21891
21892
21893 .option syntax_errors_to redirect string unset
21894 See &%skip_syntax_errors%& above.
21895 .ecindex IIDredrou1
21896 .ecindex IIDredrou2
21897
21898
21899
21900
21901
21902
21903 . ////////////////////////////////////////////////////////////////////////////
21904 . ////////////////////////////////////////////////////////////////////////////
21905
21906 .chapter "Environment for running local transports" "CHAPenvironment" &&&
21907          "Environment for local transports"
21908 .scindex IIDenvlotra1 "local transports" "environment for"
21909 .scindex IIDenvlotra2 "environment" "local transports"
21910 .scindex IIDenvlotra3 "transport" "local; environment for"
21911 Local transports handle deliveries to files and pipes. (The &(autoreply)&
21912 transport can be thought of as similar to a pipe.) Exim always runs transports
21913 in subprocesses, under specified uids and gids. Typical deliveries to local
21914 mailboxes run under the uid and gid of the local user.
21915
21916 Exim also sets a specific current directory while running the transport; for
21917 some transports a home directory setting is also relevant. The &(pipe)&
21918 transport is the only one that sets up environment variables; see section
21919 &<<SECTpipeenv>>& for details.
21920
21921 The values used for the uid, gid, and the directories may come from several
21922 different places. In many cases, the router that handles the address associates
21923 settings with that address as a result of its &%check_local_user%&, &%group%&,
21924 or &%user%& options. However, values may also be given in the transport's own
21925 configuration, and these override anything that comes from the router.
21926
21927
21928
21929 .section "Concurrent deliveries" "SECID131"
21930 .cindex "concurrent deliveries"
21931 .cindex "simultaneous deliveries"
21932 If two different messages for the same local recipient arrive more or less
21933 simultaneously, the two delivery processes are likely to run concurrently. When
21934 the &(appendfile)& transport is used to write to a file, Exim applies locking
21935 rules to stop concurrent processes from writing to the same file at the same
21936 time.
21937
21938 However, when you use a &(pipe)& transport, it is up to you to arrange any
21939 locking that is needed. Here is a silly example:
21940 .code
21941 my_transport:
21942   driver = pipe
21943   command = /bin/sh -c 'cat >>/some/file'
21944 .endd
21945 This is supposed to write the message at the end of the file. However, if two
21946 messages arrive at the same time, the file will be scrambled. You can use the
21947 &%exim_lock%& utility program (see section &<<SECTmailboxmaint>>&) to lock a
21948 file using the same algorithm that Exim itself uses.
21949
21950
21951
21952
21953 .section "Uids and gids" "SECTenvuidgid"
21954 .cindex "local transports" "uid and gid"
21955 .cindex "transport" "local; uid and gid"
21956 All transports have the options &%group%& and &%user%&. If &%group%& is set, it
21957 overrides any group that the router set in the address, even if &%user%& is not
21958 set for the transport. This makes it possible, for example, to run local mail
21959 delivery under the uid of the recipient (set by the router), but in a special
21960 group (set by the transport). For example:
21961 .code
21962 # Routers ...
21963 # User/group are set by check_local_user in this router
21964 local_users:
21965   driver = accept
21966   check_local_user
21967   transport = group_delivery
21968
21969 # Transports ...
21970 # This transport overrides the group
21971 group_delivery:
21972   driver = appendfile
21973   file = /var/spool/mail/$local_part_data
21974   group = mail
21975 .endd
21976 If &%user%& is set for a transport, its value overrides what is set in the
21977 address by the router. If &%user%& is non-numeric and &%group%& is not set, the
21978 gid associated with the user is used. If &%user%& is numeric, &%group%& must be
21979 set.
21980
21981 .oindex "&%initgroups%&"
21982 When the uid is taken from the transport's configuration, the &[initgroups()]&
21983 function is called for the groups associated with that uid if the
21984 &%initgroups%& option is set for the transport. When the uid is not specified
21985 by the transport, but is associated with the address by a router, the option
21986 for calling &[initgroups()]& is taken from the router configuration.
21987
21988 .cindex "&(pipe)& transport" "uid for"
21989 The &(pipe)& transport contains the special option &%pipe_as_creator%&. If this
21990 is set and &%user%& is not set, the uid of the process that called Exim to
21991 receive the message is used, and if &%group%& is not set, the corresponding
21992 original gid is also used.
21993
21994 This is the detailed preference order for obtaining a gid; the first of the
21995 following that is set is used:
21996
21997 .ilist
21998 A &%group%& setting of the transport;
21999 .next
22000 A &%group%& setting of the router;
22001 .next
22002 A gid associated with a user setting of the router, either as a result of
22003 &%check_local_user%& or an explicit non-numeric &%user%& setting;
22004 .next
22005 The group associated with a non-numeric &%user%& setting of the transport;
22006 .next
22007 In a &(pipe)& transport, the creator's gid if &%deliver_as_creator%& is set and
22008 the uid is the creator's uid;
22009 .next
22010 The Exim gid if the Exim uid is being used as a default.
22011 .endlist
22012
22013 If, for example, the user is specified numerically on the router and there are
22014 no group settings, no gid is available. In this situation, an error occurs.
22015 This is different for the uid, for which there always is an ultimate default.
22016 The first of the following that is set is used:
22017
22018 .ilist
22019 A &%user%& setting of the transport;
22020 .next
22021 In a &(pipe)& transport, the creator's uid if &%deliver_as_creator%& is set;
22022 .next
22023 A &%user%& setting of the router;
22024 .next
22025 A &%check_local_user%& setting of the router;
22026 .next
22027 The Exim uid.
22028 .endlist
22029
22030 Of course, an error will still occur if the uid that is chosen is on the
22031 &%never_users%& list.
22032
22033
22034
22035
22036
22037 .section "Current and home directories" "SECID132"
22038 .cindex "current directory for local transport"
22039 .cindex "home directory" "for local transport"
22040 .cindex "transport" "local; home directory for"
22041 .cindex "transport" "local; current directory for"
22042 Routers may set current and home directories for local transports by means of
22043 the &%transport_current_directory%& and &%transport_home_directory%& options.
22044 However, if the transport's &%current_directory%& or &%home_directory%& options
22045 are set, they override the router's values. In detail, the home directory
22046 for a local transport is taken from the first of these values that is set:
22047
22048 .ilist
22049 The &%home_directory%& option on the transport;
22050 .next
22051 The &%transport_home_directory%& option on the router;
22052 .next
22053 The password data if &%check_local_user%& is set on the router;
22054 .next
22055 The &%router_home_directory%& option on the router.
22056 .endlist
22057
22058 The current directory is taken from the first of these values that is set:
22059
22060 .ilist
22061 The &%current_directory%& option on the transport;
22062 .next
22063 The &%transport_current_directory%& option on the router.
22064 .endlist
22065
22066
22067 If neither the router nor the transport sets a current directory, Exim uses the
22068 value of the home directory, if it is set. Otherwise it sets the current
22069 directory to &_/_& before running a local transport.
22070
22071
22072
22073 .section "Expansion variables derived from the address" "SECID133"
22074 .vindex "&$domain$&"
22075 .vindex "&$local_part$&"
22076 .vindex "&$original_domain$&"
22077 Normally a local delivery is handling a single address, and in that case the
22078 variables such as &$domain$& and &$local_part$& are set during local
22079 deliveries. However, in some circumstances more than one address may be handled
22080 at once (for example, while writing batch SMTP for onward transmission by some
22081 other means). In this case, the variables associated with the local part are
22082 never set, &$domain$& is set only if all the addresses have the same domain,
22083 and &$original_domain$& is never set.
22084 .ecindex IIDenvlotra1
22085 .ecindex IIDenvlotra2
22086 .ecindex IIDenvlotra3
22087
22088
22089
22090
22091
22092
22093
22094 . ////////////////////////////////////////////////////////////////////////////
22095 . ////////////////////////////////////////////////////////////////////////////
22096
22097 .chapter "Generic options for transports" "CHAPtransportgeneric"
22098 .scindex IIDgenoptra1 "generic options" "transport"
22099 .scindex IIDgenoptra2 "options" "generic; for transports"
22100 .scindex IIDgenoptra3 "transport" "generic options for"
22101 The following generic options apply to all transports:
22102
22103
22104 .option body_only transports boolean false
22105 .cindex "transport" "body only"
22106 .cindex "message" "transporting body only"
22107 .cindex "body of message" "transporting"
22108 If this option is set, the message's headers are not transported. It is
22109 mutually exclusive with &%headers_only%&. If it is used with the &(appendfile)&
22110 or &(pipe)& transports, the settings of &%message_prefix%& and
22111 &%message_suffix%& should be checked, because this option does not
22112 automatically suppress them.
22113
22114
22115 .option current_directory transports string&!! unset
22116 .cindex "transport" "current directory for"
22117 This specifies the current directory that is to be set while running the
22118 transport, overriding any value that may have been set by the router.
22119 If the expansion fails for any reason, including forced failure, an error is
22120 logged, and delivery is deferred.
22121
22122
22123 .option disable_logging transports boolean false
22124 If this option is set true, nothing is logged for any
22125 deliveries by the transport or for any
22126 transport errors. You should not set this option unless you really, really know
22127 what you are doing.
22128
22129
22130 .option debug_print transports string&!! unset
22131 .cindex "testing" "variables in drivers"
22132 If this option is set and debugging is enabled (see the &%-d%& command line
22133 option), the string is expanded and included in the debugging output when the
22134 transport is run.
22135 If expansion of the string fails, the error message is written to the debugging
22136 output, and Exim carries on processing.
22137 This facility is provided to help with checking out the values of variables and
22138 so on when debugging driver configurations. For example, if a &%headers_add%&
22139 option is not working properly, &%debug_print%& could be used to output the
22140 variables it references. A newline is added to the text if it does not end with
22141 one.
22142 The variables &$transport_name$& and &$router_name$& contain the name of the
22143 transport and the router that called it.
22144
22145 .option delivery_date_add transports boolean false
22146 .cindex "&'Delivery-date:'& header line"
22147 If this option is true, a &'Delivery-date:'& header is added to the message.
22148 This gives the actual time the delivery was made. As this is not a standard
22149 header, Exim has a configuration option (&%delivery_date_remove%&) which
22150 requests its removal from incoming messages, so that delivered messages can
22151 safely be resent to other recipients.
22152
22153
22154 .option driver transports string unset
22155 This specifies which of the available transport drivers is to be used.
22156 There is no default, and this option must be set for every transport.
22157
22158
22159 .option envelope_to_add transports boolean false
22160 .cindex "&'Envelope-to:'& header line"
22161 If this option is true, an &'Envelope-to:'& header is added to the message.
22162 This gives the original address(es) in the incoming envelope that caused this
22163 delivery to happen. More than one address may be present if the transport is
22164 configured to handle several addresses at once, or if more than one original
22165 address was redirected to the same final address. As this is not a standard
22166 header, Exim has a configuration option (&%envelope_to_remove%&) which requests
22167 its removal from incoming messages, so that delivered messages can safely be
22168 resent to other recipients.
22169
22170
22171 .option event_action transports string&!! unset
22172 .cindex events
22173 This option declares a string to be expanded for Exim's events mechanism.
22174 For details see chapter &<<CHAPevents>>&.
22175
22176
22177 .option group transports string&!! "Exim group"
22178 .cindex "transport" "group; specifying"
22179 This option specifies a gid for running the transport process, overriding any
22180 value that the router supplies, and also overriding any value associated with
22181 &%user%& (see below).
22182
22183
22184 .option headers_add transports list&!! unset
22185 .cindex "header lines" "adding in transport"
22186 .cindex "transport" "header lines; adding"
22187 This option specifies a list of text headers,
22188 newline-separated (by default, changeable in the usual way &<<SECTlistsepchange>>&),
22189 which are (separately) expanded and added to the header
22190 portion of a message as it is transported, as described in section
22191 &<<SECTheadersaddrem>>&. Additional header lines can also be specified by
22192 routers. If the result of the expansion is an empty string, or if the expansion
22193 is forced to fail, no action is taken. Other expansion failures are treated as
22194 errors and cause the delivery to be deferred.
22195
22196 Unlike most options, &%headers_add%& can be specified multiple times
22197 for a transport; all listed headers are added.
22198
22199
22200 .option headers_only transports boolean false
22201 .cindex "transport" "header lines only"
22202 .cindex "message" "transporting headers only"
22203 .cindex "header lines" "transporting"
22204 If this option is set, the message's body is not transported. It is mutually
22205 exclusive with &%body_only%&. If it is used with the &(appendfile)& or &(pipe)&
22206 transports, the settings of &%message_prefix%& and &%message_suffix%& should be
22207 checked, since this option does not automatically suppress them.
22208
22209
22210 .option headers_remove transports list&!! unset
22211 .cindex "header lines" "removing"
22212 .cindex "transport" "header lines; removing"
22213 This option specifies a list of text headers,
22214 colon-separated (by default, changeable in the usual way &<<SECTlistsepchange>>&),
22215 to be removed from the message.
22216 However, the option has no effect when an address is just being verified.
22217 Each list item is separately expanded.
22218 If the result of the expansion is an empty string, or if the expansion
22219 is forced to fail, no action is taken. Other expansion failures are treated as
22220 errors and cause the delivery to be deferred.
22221 .new
22222 If an item ends in *, it will match any header with the given prefix.
22223 .wen
22224
22225 Matching headers are omitted from the message as it is transported, as described
22226 in section &<<SECTheadersaddrem>>&. Header removal can also be specified by
22227 routers.
22228
22229 Unlike most options, &%headers_remove%& can be specified multiple times
22230 for a transport; all listed headers are removed.
22231
22232 &*Warning*&: Because of the separate expansion of the list items,
22233 items that contain a list separator must have it doubled.
22234 To avoid this, change the list separator (&<<SECTlistsepchange>>&).
22235
22236
22237
22238 .option headers_rewrite transports string unset
22239 .cindex "transport" "header lines; rewriting"
22240 .cindex "rewriting" "at transport time"
22241 This option allows addresses in header lines to be rewritten at transport time,
22242 that is, as the message is being copied to its destination. The contents of the
22243 option are a colon-separated list of rewriting rules. Each rule is in exactly
22244 the same form as one of the general rewriting rules that are applied when a
22245 message is received. These are described in chapter &<<CHAPrewrite>>&. For
22246 example,
22247 .code
22248 headers_rewrite = a@b c@d f : \
22249                   x@y w@z
22250 .endd
22251 changes &'a@b'& into &'c@d'& in &'From:'& header lines, and &'x@y'& into
22252 &'w@z'& in all address-bearing header lines. The rules are applied to the
22253 header lines just before they are written out at transport time, so they affect
22254 only those copies of the message that pass through the transport. However, only
22255 the message's original header lines, and any that were added by a system
22256 filter, are rewritten. If a router or transport adds header lines, they are not
22257 affected by this option. These rewriting rules are &'not'& applied to the
22258 envelope. You can change the return path using &%return_path%&, but you cannot
22259 change envelope recipients at this time.
22260
22261
22262 .option home_directory transports string&!! unset
22263 .cindex "transport" "home directory for"
22264 .vindex "&$home$&"
22265 This option specifies a home directory setting for a local transport,
22266 overriding any value that may be set by the router. The home directory is
22267 placed in &$home$& while expanding the transport's private options. It is also
22268 used as the current directory if no current directory is set by the
22269 &%current_directory%& option on the transport or the
22270 &%transport_current_directory%& option on the router. If the expansion fails
22271 for any reason, including forced failure, an error is logged, and delivery is
22272 deferred.
22273
22274
22275 .option initgroups transports boolean false
22276 .cindex "additional groups"
22277 .cindex "groups" "additional"
22278 .cindex "transport" "group; additional"
22279 If this option is true and the uid for the delivery process is provided by the
22280 transport, the &[initgroups()]& function is called when running the transport
22281 to ensure that any additional groups associated with the uid are set up.
22282
22283
22284 .option max_parallel transports integer&!! unset
22285 .cindex limit "transport parallelism"
22286 .cindex transport "parallel processes"
22287 .cindex transport "concurrency limit"
22288 .cindex "delivery" "parallelism for transport"
22289 If this option is set and expands to an integer greater than zero
22290 it limits the number of concurrent runs of the transport.
22291 The control does not apply to shadow transports.
22292
22293 .cindex "hints database" "transport concurrency control"
22294 Exim implements this control by means of a hints database in which a record is
22295 incremented whenever a transport process is being created. The record
22296 is decremented and possibly removed when the process terminates.
22297 Obviously there is scope for
22298 records to get left lying around if there is a system or program crash. To
22299 guard against this, Exim ignores any records that are more than six hours old.
22300
22301 If you use this option, you should also arrange to delete the
22302 relevant hints database whenever your system reboots. The names of the files
22303 start with &_misc_& and they are kept in the &_spool/db_& directory. There
22304 may be one or two files, depending on the type of DBM in use. The same files
22305 are used for ETRN and smtp transport serialization.
22306
22307
22308 .option message_size_limit transports string&!! 0
22309 .cindex "limit" "message size per transport"
22310 .cindex "size" "of message, limit"
22311 .cindex "transport" "message size; limiting"
22312 This option controls the size of messages passed through the transport. It is
22313 expanded before use; the result of the expansion must be a sequence of decimal
22314 digits, optionally followed by K or M. If the expansion fails for any reason,
22315 including forced failure, or if the result is not of the required form,
22316 delivery is deferred. If the value is greater than zero and the size of a
22317 message exceeds this limit, the address is failed. If there is any chance that
22318 the resulting bounce message could be routed to the same transport, you should
22319 ensure that &%return_size_limit%& is less than the transport's
22320 &%message_size_limit%&, as otherwise the bounce message will fail to get
22321 delivered.
22322
22323
22324
22325 .option rcpt_include_affixes transports boolean false
22326 .cindex "prefix" "for local part, including in envelope"
22327 .cindex "suffix for local part" "including in envelope"
22328 .cindex "local part" "prefix"
22329 .cindex "local part" "suffix"
22330 When this option is false (the default), and an address that has had any
22331 affixes (prefixes or suffixes) removed from the local part is delivered by any
22332 form of SMTP or LMTP, the affixes are not included. For example, if a router
22333 that contains
22334 .code
22335 local_part_prefix = *-
22336 .endd
22337 routes the address &'abc-xyz@some.domain'& to an SMTP transport, the envelope
22338 is delivered with
22339 .code
22340 RCPT TO:<xyz@some.domain>
22341 .endd
22342 This is also the case when an ACL-time callout is being used to verify a
22343 recipient address. However, if &%rcpt_include_affixes%& is set true, the
22344 whole local part is included in the RCPT command. This option applies to BSMTP
22345 deliveries by the &(appendfile)& and &(pipe)& transports as well as to the
22346 &(lmtp)& and &(smtp)& transports.
22347
22348
22349 .option retry_use_local_part transports boolean "see below"
22350 .cindex "hints database" "retry keys"
22351 When a delivery suffers a temporary failure, a retry record is created
22352 in Exim's hints database. For remote deliveries, the key for the retry record
22353 is based on the name and/or IP address of the failing remote host. For local
22354 deliveries, the key is normally the entire address, including both the local
22355 part and the domain. This is suitable for most common cases of local delivery
22356 temporary failure &-- for example, exceeding a mailbox quota should delay only
22357 deliveries to that mailbox, not to the whole domain.
22358
22359 However, in some special cases you may want to treat a temporary local delivery
22360 as a failure associated with the domain, and not with a particular local part.
22361 (For example, if you are storing all mail for some domain in files.) You can do
22362 this by setting &%retry_use_local_part%& false.
22363
22364 For all the local transports, its default value is true. For remote transports,
22365 the default value is false for tidiness, but changing the value has no effect
22366 on a remote transport in the current implementation.
22367
22368
22369 .option return_path transports string&!! unset
22370 .cindex "envelope sender"
22371 .cindex "envelope from"
22372 .cindex "transport" "return path; changing"
22373 .cindex "return path" "changing in transport"
22374 If this option is set, the string is expanded at transport time and replaces
22375 the existing return path (envelope sender) value in the copy of the message
22376 that is being delivered. An empty return path is permitted. This feature is
22377 designed for remote deliveries, where the value of this option is used in the
22378 SMTP MAIL command. If you set &%return_path%& for a local transport, the
22379 only effect is to change the address that is placed in the &'Return-path:'&
22380 header line, if one is added to the message (see the next option).
22381
22382 &*Note:*& A changed return path is not logged unless you add
22383 &%return_path_on_delivery%& to the log selector.
22384
22385 .vindex "&$return_path$&"
22386 The expansion can refer to the existing value via &$return_path$&. This is
22387 either the message's envelope sender, or an address set by the
22388 &%errors_to%& option on a router. If the expansion is forced to fail, no
22389 replacement occurs; if it fails for another reason, delivery is deferred. This
22390 option can be used to support VERP (Variable Envelope Return Paths) &-- see
22391 section &<<SECTverp>>&.
22392
22393 &*Note*&: If a delivery error is detected locally, including the case when a
22394 remote server rejects a message at SMTP time, the bounce message is not sent to
22395 the value of this option. It is sent to the previously set errors address.
22396 This defaults to the incoming sender address, but can be changed by setting
22397 &%errors_to%& in a router.
22398
22399
22400
22401 .option return_path_add transports boolean false
22402 .cindex "&'Return-path:'& header line"
22403 If this option is true, a &'Return-path:'& header is added to the message.
22404 Although the return path is normally available in the prefix line of BSD
22405 mailboxes, this is commonly not displayed by MUAs, and so the user does not
22406 have easy access to it.
22407
22408 RFC 2821 states that the &'Return-path:'& header is added to a message &"when
22409 the delivery SMTP server makes the final delivery"&. This implies that this
22410 header should not be present in incoming messages. Exim has a configuration
22411 option, &%return_path_remove%&, which requests removal of this header from
22412 incoming messages, so that delivered messages can safely be resent to other
22413 recipients.
22414
22415
22416 .option shadow_condition transports string&!! unset
22417 See &%shadow_transport%& below.
22418
22419
22420 .option shadow_transport transports string unset
22421 .cindex "shadow transport"
22422 .cindex "transport" "shadow"
22423 A local transport may set the &%shadow_transport%& option to the name of
22424 another local transport. Shadow remote transports are not supported.
22425
22426 Whenever a delivery to the main transport succeeds, and either
22427 &%shadow_condition%& is unset, or its expansion does not result in the empty
22428 string or one of the strings &"0"& or &"no"& or &"false"&, the message is also
22429 passed to the shadow transport, with the same delivery address or addresses. If
22430 expansion fails, no action is taken except that non-forced expansion failures
22431 cause a log line to be written.
22432
22433 The result of the shadow transport is discarded and does not affect the
22434 subsequent processing of the message. Only a single level of shadowing is
22435 provided; the &%shadow_transport%& option is ignored on any transport when it
22436 is running as a shadow. Options concerned with output from pipes are also
22437 ignored. The log line for the successful delivery has an item added on the end,
22438 of the form
22439 .code
22440 ST=<shadow transport name>
22441 .endd
22442 If the shadow transport did not succeed, the error message is put in
22443 parentheses afterwards. Shadow transports can be used for a number of different
22444 purposes, including keeping more detailed log information than Exim normally
22445 provides, and implementing automatic acknowledgment policies based on message
22446 headers that some sites insist on.
22447
22448
22449 .option transport_filter transports string&!! unset
22450 .cindex "transport" "filter"
22451 .cindex "filter" "transport filter"
22452 This option sets up a filtering (in the Unix shell sense) process for messages
22453 at transport time. It should not be confused with mail filtering as set up by
22454 individual users or via a system filter.
22455 If unset, or expanding to an empty string, no filtering is done.
22456
22457 When the message is about to be written out, the command specified by
22458 &%transport_filter%& is started up in a separate, parallel process, and
22459 the entire message, including the header lines, is passed to it on its standard
22460 input (this in fact is done from a third process, to avoid deadlock). The
22461 command must be specified as an absolute path.
22462
22463 The lines of the message that are written to the transport filter are
22464 terminated by newline (&"\n"&). The message is passed to the filter before any
22465 SMTP-specific processing, such as turning &"\n"& into &"\r\n"& and escaping
22466 lines beginning with a dot, and also before any processing implied by the
22467 settings of &%check_string%& and &%escape_string%& in the &(appendfile)& or
22468 &(pipe)& transports.
22469
22470 The standard error for the filter process is set to the same destination as its
22471 standard output; this is read and written to the message's ultimate
22472 destination. The process that writes the message to the filter, the
22473 filter itself, and the original process that reads the result and delivers it
22474 are all run in parallel, like a shell pipeline.
22475
22476 The filter can perform any transformations it likes, but of course should take
22477 care not to break RFC 2822 syntax. Exim does not check the result, except to
22478 test for a final newline when SMTP is in use. All messages transmitted over
22479 SMTP must end with a newline, so Exim supplies one if it is missing.
22480
22481 .cindex "content scanning" "per user"
22482 A transport filter can be used to provide content-scanning on a per-user basis
22483 at delivery time if the only required effect of the scan is to modify the
22484 message. For example, a content scan could insert a new header line containing
22485 a spam score. This could be interpreted by a filter in the user's MUA. It is
22486 not possible to discard a message at this stage.
22487
22488 .cindex "SIZE" "ESMTP extension"
22489 A problem might arise if the filter increases the size of a message that is
22490 being sent down an SMTP connection. If the receiving SMTP server has indicated
22491 support for the SIZE parameter, Exim will have sent the size of the message
22492 at the start of the SMTP session. If what is actually sent is substantially
22493 more, the server might reject the message. This can be worked round by setting
22494 the &%size_addition%& option on the &(smtp)& transport, either to allow for
22495 additions to the message, or to disable the use of SIZE altogether.
22496
22497 .vindex "&$pipe_addresses$&"
22498 The value of the &%transport_filter%& option is the command string for starting
22499 the filter, which is run directly from Exim, not under a shell. The string is
22500 parsed by Exim in the same way as a command string for the &(pipe)& transport:
22501 Exim breaks it up into arguments and then expands each argument separately (see
22502 section &<<SECThowcommandrun>>&). Any kind of expansion failure causes delivery
22503 to be deferred. The special argument &$pipe_addresses$& is replaced by a number
22504 of arguments, one for each address that applies to this delivery. (This isn't
22505 an ideal name for this feature here, but as it was already implemented for the
22506 &(pipe)& transport, it seemed sensible not to change it.)
22507
22508 .vindex "&$host$&"
22509 .vindex "&$host_address$&"
22510 The expansion variables &$host$& and &$host_address$& are available when the
22511 transport is a remote one. They contain the name and IP address of the host to
22512 which the message is being sent. For example:
22513 .code
22514 transport_filter = /some/directory/transport-filter.pl \
22515   $host $host_address $sender_address $pipe_addresses
22516 .endd
22517
22518 Two problems arise if you want to use more complicated expansion items to
22519 generate transport filter commands, both of which due to the fact that the
22520 command is split up &'before'& expansion.
22521 .ilist
22522 If an expansion item contains white space, you must quote it, so that it is all
22523 part of the same command item. If the entire option setting is one such
22524 expansion item, you have to take care what kind of quoting you use. For
22525 example:
22526 .code
22527 transport_filter = '/bin/cmd${if eq{$host}{a.b.c}{1}{2}}'
22528 .endd
22529 This runs the command &(/bin/cmd1)& if the host name is &'a.b.c'&, and
22530 &(/bin/cmd2)& otherwise. If double quotes had been used, they would have been
22531 stripped by Exim when it read the option's value. When the value is used, if
22532 the single quotes were missing, the line would be split into two items,
22533 &`/bin/cmd${if`& and &`eq{$host}{a.b.c}{1}{2}`&, and an error would occur when
22534 Exim tried to expand the first one.
22535 .next
22536 Except for the special case of &$pipe_addresses$& that is mentioned above, an
22537 expansion cannot generate multiple arguments, or a command name followed by
22538 arguments. Consider this example:
22539 .code
22540 transport_filter = ${lookup{$host}lsearch{/a/file}\
22541                     {$value}{/bin/cat}}
22542 .endd
22543 The result of the lookup is interpreted as the name of the command, even
22544 if it contains white space. The simplest way round this is to use a shell:
22545 .code
22546 transport_filter = /bin/sh -c ${lookup{$host}lsearch{/a/file}\
22547                                {$value}{/bin/cat}}
22548 .endd
22549 .endlist
22550
22551 The filter process is run under the same uid and gid as the normal delivery.
22552 For remote deliveries this is the Exim uid/gid by default. The command should
22553 normally yield a zero return code. Transport filters are not supposed to fail.
22554 A non-zero code is taken to mean that the transport filter encountered some
22555 serious problem. Delivery of the message is deferred; the message remains on
22556 the queue and is tried again later. It is not possible to cause a message to be
22557 bounced from a transport filter.
22558
22559 If a transport filter is set on an autoreply transport, the original message is
22560 passed through the filter as it is being copied into the newly generated
22561 message, which happens if the &%return_message%& option is set.
22562
22563
22564 .option transport_filter_timeout transports time 5m
22565 .cindex "transport" "filter, timeout"
22566 When Exim is reading the output of a transport filter, it applies a timeout
22567 that can be set by this option. Exceeding the timeout is normally treated as a
22568 temporary delivery failure. However, if a transport filter is used with a
22569 &(pipe)& transport, a timeout in the transport filter is treated in the same
22570 way as a timeout in the pipe command itself. By default, a timeout is a hard
22571 error, but if the &(pipe)& transport's &%timeout_defer%& option is set true, it
22572 becomes a temporary error.
22573
22574
22575 .option user transports string&!! "Exim user"
22576 .cindex "uid (user id)" "local delivery"
22577 .cindex "transport" "user, specifying"
22578 This option specifies the user under whose uid the delivery process is to be
22579 run, overriding any uid that may have been set by the router. If the user is
22580 given as a name, the uid is looked up from the password data, and the
22581 associated group is taken as the value of the gid to be used if the &%group%&
22582 option is not set.
22583
22584 For deliveries that use local transports, a user and group are normally
22585 specified explicitly or implicitly (for example, as a result of
22586 &%check_local_user%&) by the router or transport.
22587
22588 .cindex "hints database" "access by remote transport"
22589 For remote transports, you should leave this option unset unless you really are
22590 sure you know what you are doing. When a remote transport is running, it needs
22591 to be able to access Exim's hints databases, because each host may have its own
22592 retry data.
22593 .ecindex IIDgenoptra1
22594 .ecindex IIDgenoptra2
22595 .ecindex IIDgenoptra3
22596
22597
22598
22599
22600
22601
22602 . ////////////////////////////////////////////////////////////////////////////
22603 . ////////////////////////////////////////////////////////////////////////////
22604
22605 .chapter "Address batching in local transports" "CHAPbatching" &&&
22606          "Address batching"
22607 .cindex "transport" "local; address batching in"
22608 The only remote transport (&(smtp)&) is normally configured to handle more than
22609 one address at a time, so that when several addresses are routed to the same
22610 remote host, just one copy of the message is sent. Local transports, however,
22611 normally handle one address at a time. That is, a separate instance of the
22612 transport is run for each address that is routed to the transport. A separate
22613 copy of the message is delivered each time.
22614
22615 .cindex "batched local delivery"
22616 .oindex "&%batch_max%&"
22617 .oindex "&%batch_id%&"
22618 In special cases, it may be desirable to handle several addresses at once in a
22619 local transport, for example:
22620
22621 .ilist
22622 In an &(appendfile)& transport, when storing messages in files for later
22623 delivery by some other means, a single copy of the message with multiple
22624 recipients saves space.
22625 .next
22626 In an &(lmtp)& transport, when delivering over &"local SMTP"& to some process,
22627 a single copy saves time, and is the normal way LMTP is expected to work.
22628 .next
22629 In a &(pipe)& transport, when passing the message
22630 to a scanner program or
22631 to some other delivery mechanism such as UUCP, multiple recipients may be
22632 acceptable.
22633 .endlist
22634
22635 These three local transports all have the same options for controlling multiple
22636 (&"batched"&) deliveries, namely &%batch_max%& and &%batch_id%&. To save
22637 repeating the information for each transport, these options are described here.
22638
22639 The &%batch_max%& option specifies the maximum number of addresses that can be
22640 delivered together in a single run of the transport. Its default value is one
22641 (no batching). When more than one address is routed to a transport that has a
22642 &%batch_max%& value greater than one, the addresses are delivered in a batch
22643 (that is, in a single run of the transport with multiple recipients), subject
22644 to certain conditions:
22645
22646 .ilist
22647 .vindex "&$local_part$&"
22648 If any of the transport's options contain a reference to &$local_part$&, no
22649 batching is possible.
22650 .next
22651 .vindex "&$domain$&"
22652 If any of the transport's options contain a reference to &$domain$&, only
22653 addresses with the same domain are batched.
22654 .next
22655 .cindex "customizing" "batching condition"
22656 If &%batch_id%& is set, it is expanded for each address, and only those
22657 addresses with the same expanded value are batched. This allows you to specify
22658 customized batching conditions. Failure of the expansion for any reason,
22659 including forced failure, disables batching, but it does not stop the delivery
22660 from taking place.
22661 .next
22662 Batched addresses must also have the same errors address (where to send
22663 delivery errors), the same header additions and removals, the same user and
22664 group for the transport, and if a host list is present, the first host must
22665 be the same.
22666 .endlist
22667
22668 In the case of the &(appendfile)& and &(pipe)& transports, batching applies
22669 both when the file or pipe command is specified in the transport, and when it
22670 is specified by a &(redirect)& router, but all the batched addresses must of
22671 course be routed to the same file or pipe command. These two transports have an
22672 option called &%use_bsmtp%&, which causes them to deliver the message in
22673 &"batched SMTP"& format, with the envelope represented as SMTP commands. The
22674 &%check_string%& and &%escape_string%& options are forced to the values
22675 .code
22676 check_string = "."
22677 escape_string = ".."
22678 .endd
22679 when batched SMTP is in use. A full description of the batch SMTP mechanism is
22680 given in section &<<SECTbatchSMTP>>&. The &(lmtp)& transport does not have a
22681 &%use_bsmtp%& option, because it always delivers using the SMTP protocol.
22682
22683 .cindex "&'Envelope-to:'& header line"
22684 If the generic &%envelope_to_add%& option is set for a batching transport, the
22685 &'Envelope-to:'& header that is added to the message contains all the addresses
22686 that are being processed together. If you are using a batching &(appendfile)&
22687 transport without &%use_bsmtp%&, the only way to preserve the recipient
22688 addresses is to set the &%envelope_to_add%& option.
22689
22690 .cindex "&(pipe)& transport" "with multiple addresses"
22691 .vindex "&$pipe_addresses$&"
22692 If you are using a &(pipe)& transport without BSMTP, and setting the
22693 transport's &%command%& option, you can include &$pipe_addresses$& as part of
22694 the command. This is not a true variable; it is a bit of magic that causes each
22695 of the recipient addresses to be inserted into the command as a separate
22696 argument. This provides a way of accessing all the addresses that are being
22697 delivered in the batch. &*Note:*& This is not possible for pipe commands that
22698 are specified by a &(redirect)& router.
22699
22700
22701
22702
22703 . ////////////////////////////////////////////////////////////////////////////
22704 . ////////////////////////////////////////////////////////////////////////////
22705
22706 .chapter "The appendfile transport" "CHAPappendfile"
22707 .scindex IIDapptra1 "&(appendfile)& transport"
22708 .scindex IIDapptra2 "transports" "&(appendfile)&"
22709 .cindex "directory creation"
22710 .cindex "creating directories"
22711 The &(appendfile)& transport delivers a message by appending it to an existing
22712 file, or by creating an entirely new file in a specified directory. Single
22713 files to which messages are appended can be in the traditional Unix mailbox
22714 format, or optionally in the MBX format supported by the Pine MUA and
22715 University of Washington IMAP daemon, &'inter alia'&. When each message is
22716 being delivered as a separate file, &"maildir"& format can optionally be used
22717 to give added protection against failures that happen part-way through the
22718 delivery. A third form of separate-file delivery known as &"mailstore"& is also
22719 supported. For all file formats, Exim attempts to create as many levels of
22720 directory as necessary, provided that &%create_directory%& is set.
22721
22722 The code for the optional formats is not included in the Exim binary by
22723 default. It is necessary to set SUPPORT_MBX, SUPPORT_MAILDIR and/or
22724 SUPPORT_MAILSTORE in &_Local/Makefile_& to have the appropriate code
22725 included.
22726
22727 .cindex "quota" "system"
22728 Exim recognizes system quota errors, and generates an appropriate message. Exim
22729 also supports its own quota control within the transport, for use when the
22730 system facility is unavailable or cannot be used for some reason.
22731
22732 If there is an error while appending to a file (for example, quota exceeded or
22733 partition filled), Exim attempts to reset the file's length and last
22734 modification time back to what they were before. If there is an error while
22735 creating an entirely new file, the new file is removed.
22736
22737 Before appending to a file, a number of security checks are made, and the
22738 file is locked. A detailed description is given below, after the list of
22739 private options.
22740
22741 The &(appendfile)& transport is most commonly used for local deliveries to
22742 users' mailboxes. However, it can also be used as a pseudo-remote transport for
22743 putting messages into files for remote delivery by some means other than Exim.
22744 &"Batch SMTP"& format is often used in this case (see the &%use_bsmtp%&
22745 option).
22746
22747
22748
22749 .section "The file and directory options" "SECTfildiropt"
22750 The &%file%& option specifies a single file, to which the message is appended;
22751 the &%directory%& option specifies a directory, in which a new file containing
22752 the message is created. Only one of these two options can be set, and for
22753 normal deliveries to mailboxes, one of them &'must'& be set.
22754
22755 .vindex "&$address_file$&"
22756 .vindex "&$local_part$&"
22757 However, &(appendfile)& is also used for delivering messages to files or
22758 directories whose names (or parts of names) are obtained from alias,
22759 forwarding, or filtering operations (for example, a &%save%& command in a
22760 user's Exim filter). When such a transport is running, &$local_part$& contains
22761 the local part that was aliased or forwarded, and &$address_file$& contains the
22762 name (or partial name) of the file or directory generated by the redirection
22763 operation. There are two cases:
22764
22765 .ilist
22766 If neither &%file%& nor &%directory%& is set, the redirection operation
22767 must specify an absolute path (one that begins with &`/`&). This is the most
22768 common case when users with local accounts use filtering to sort mail into
22769 different folders. See for example, the &(address_file)& transport in the
22770 default configuration. If the path ends with a slash, it is assumed to be the
22771 name of a directory. A delivery to a directory can also be forced by setting
22772 &%maildir_format%& or &%mailstore_format%&.
22773 .next
22774 If &%file%& or &%directory%& is set for a delivery from a redirection, it is
22775 used to determine the file or directory name for the delivery. Normally, the
22776 contents of &$address_file$& are used in some way in the string expansion.
22777 .endlist
22778 .new
22779 .cindex "tainted data" "in filenames"
22780 .cindex appendfile "tainted data"
22781 Tainted data may not be used for a file or directory name.
22782 This means that, for instance, &$local_part$& cannot be used directly
22783 as a component of a path.  It can however be used as the key for a lookup
22784 which returns a path (or component).
22785 .wen
22786
22787
22788 .cindex "Sieve filter" "configuring &(appendfile)&"
22789 .cindex "Sieve filter" "relative mailbox path handling"
22790 As an example of the second case, consider an environment where users do not
22791 have home directories. They may be permitted to use Exim filter commands of the
22792 form:
22793 .code
22794 save folder23
22795 .endd
22796 or Sieve filter commands of the form:
22797 .code
22798 require "fileinto";
22799 fileinto "folder23";
22800 .endd
22801 In this situation, the expansion of &%file%& or &%directory%& in the transport
22802 must transform the relative path into an appropriate absolute filename. In the
22803 case of Sieve filters, the name &'inbox'& must be handled. It is the name that
22804 is used as a result of a &"keep"& action in the filter. This example shows one
22805 way of handling this requirement:
22806 .code
22807 file = ${if eq{$address_file}{inbox} \
22808             {/var/mail/$local_part_data} \
22809             {${if eq{${substr_0_1:$address_file}}{/} \
22810                   {$address_file} \
22811                   {$home/mail/$address_file} \
22812             }} \
22813        }
22814 .endd
22815 With this setting of &%file%&, &'inbox'& refers to the standard mailbox
22816 location, absolute paths are used without change, and other folders are in the
22817 &_mail_& directory within the home directory.
22818
22819 &*Note 1*&: While processing an Exim filter, a relative path such as
22820 &_folder23_& is turned into an absolute path if a home directory is known to
22821 the router. In particular, this is the case if &%check_local_user%& is set. If
22822 you want to prevent this happening at routing time, you can set
22823 &%router_home_directory%& empty. This forces the router to pass the relative
22824 path to the transport.
22825
22826 &*Note 2*&: An absolute path in &$address_file$& is not treated specially;
22827 the &%file%& or &%directory%& option is still used if it is set.
22828
22829
22830
22831
22832 .section "Private options for appendfile" "SECID134"
22833 .cindex "options" "&(appendfile)& transport"
22834
22835
22836
22837 .option allow_fifo appendfile boolean false
22838 .cindex "fifo (named pipe)"
22839 .cindex "named pipe (fifo)"
22840 .cindex "pipe" "named (fifo)"
22841 Setting this option permits delivery to named pipes (FIFOs) as well as to
22842 regular files. If no process is reading the named pipe at delivery time, the
22843 delivery is deferred.
22844
22845
22846 .option allow_symlink appendfile boolean false
22847 .cindex "symbolic link" "to mailbox"
22848 .cindex "mailbox" "symbolic link"
22849 By default, &(appendfile)& will not deliver if the path name for the file is
22850 that of a symbolic link. Setting this option relaxes that constraint, but there
22851 are security issues involved in the use of symbolic links. Be sure you know
22852 what you are doing if you set this. Details of exactly what this option affects
22853 are included in the discussion which follows this list of options.
22854
22855
22856 .option batch_id appendfile string&!! unset
22857 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
22858 However, batching is automatically disabled for &(appendfile)& deliveries that
22859 happen as a result of forwarding or aliasing or other redirection directly to a
22860 file.
22861
22862
22863 .option batch_max appendfile integer 1
22864 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
22865
22866
22867 .option check_group appendfile boolean false
22868 When this option is set, the group owner of the file defined by the &%file%&
22869 option is checked to see that it is the same as the group under which the
22870 delivery process is running. The default setting is false because the default
22871 file mode is 0600, which means that the group is irrelevant.
22872
22873
22874 .option check_owner appendfile boolean true
22875 When this option is set, the owner of the file defined by the &%file%& option
22876 is checked to ensure that it is the same as the user under which the delivery
22877 process is running.
22878
22879
22880 .option check_string appendfile string "see below"
22881 .cindex "&""From""& line"
22882 As &(appendfile)& writes the message, the start of each line is tested for
22883 matching &%check_string%&, and if it does, the initial matching characters are
22884 replaced by the contents of &%escape_string%&. The value of &%check_string%& is
22885 a literal string, not a regular expression, and the case of any letters it
22886 contains is significant.
22887
22888 If &%use_bsmtp%& is set the values of &%check_string%& and &%escape_string%&
22889 are forced to &"."& and &".."& respectively, and any settings in the
22890 configuration are ignored. Otherwise, they default to &"From&~"& and
22891 &">From&~"& when the &%file%& option is set, and unset when any of the
22892 &%directory%&, &%maildir%&, or &%mailstore%& options are set.
22893
22894 The default settings, along with &%message_prefix%& and &%message_suffix%&, are
22895 suitable for traditional &"BSD"& mailboxes, where a line beginning with
22896 &"From&~"& indicates the start of a new message. All four options need changing
22897 if another format is used. For example, to deliver to mailboxes in MMDF format:
22898 .cindex "MMDF format mailbox"
22899 .cindex "mailbox" "MMDF format"
22900 .code
22901 check_string = "\1\1\1\1\n"
22902 escape_string = "\1\1\1\1 \n"
22903 message_prefix = "\1\1\1\1\n"
22904 message_suffix = "\1\1\1\1\n"
22905 .endd
22906 .option create_directory appendfile boolean true
22907 .cindex "directory creation"
22908 When this option is true, Exim attempts to create any missing superior
22909 directories for the file that it is about to write. A created directory's mode
22910 is given by the &%directory_mode%& option.
22911
22912 The group ownership of a newly created directory is highly dependent on the
22913 operating system (and possibly the file system) that is being used. For
22914 example, in Solaris, if the parent directory has the setgid bit set, its group
22915 is propagated to the child; if not, the currently set group is used. However,
22916 in FreeBSD, the parent's group is always used.
22917
22918
22919
22920 .option create_file appendfile string anywhere
22921 This option constrains the location of files and directories that are created
22922 by this transport. It applies to files defined by the &%file%& option and
22923 directories defined by the &%directory%& option. In the case of maildir
22924 delivery, it applies to the top level directory, not the maildir directories
22925 beneath.
22926
22927 The option must be set to one of the words &"anywhere"&, &"inhome"&, or
22928 &"belowhome"&. In the second and third cases, a home directory must have been
22929 set for the transport. This option is not useful when an explicit filename is
22930 given for normal mailbox deliveries. It is intended for the case when filenames
22931 are generated from users' &_.forward_& files. These are usually handled
22932 by an &(appendfile)& transport called &%address_file%&. See also
22933 &%file_must_exist%&.
22934
22935
22936 .option directory appendfile string&!! unset
22937 This option is mutually exclusive with the &%file%& option, but one of &%file%&
22938 or &%directory%& must be set, unless the delivery is the direct result of a
22939 redirection (see section &<<SECTfildiropt>>&).
22940
22941 When &%directory%& is set, the string is expanded, and the message is delivered
22942 into a new file or files in or below the given directory, instead of being
22943 appended to a single mailbox file. A number of different formats are provided
22944 (see &%maildir_format%& and &%mailstore_format%&), and see section
22945 &<<SECTopdir>>& for further details of this form of delivery.
22946
22947
22948 .option directory_file appendfile string&!! "see below"
22949 .cindex "base62"
22950 .vindex "&$inode$&"
22951 When &%directory%& is set, but neither &%maildir_format%& nor
22952 &%mailstore_format%& is set, &(appendfile)& delivers each message into a file
22953 whose name is obtained by expanding this string. The default value is:
22954 .code
22955 q${base62:$tod_epoch}-$inode
22956 .endd
22957 This generates a unique name from the current time, in base 62 form, and the
22958 inode of the file. The variable &$inode$& is available only when expanding this
22959 option.
22960
22961
22962 .option directory_mode appendfile "octal integer" 0700
22963 If &(appendfile)& creates any directories as a result of the
22964 &%create_directory%& option, their mode is specified by this option.
22965
22966
22967 .option escape_string appendfile string "see description"
22968 See &%check_string%& above.
22969
22970
22971 .option file appendfile string&!! unset
22972 This option is mutually exclusive with the &%directory%& option, but one of
22973 &%file%& or &%directory%& must be set, unless the delivery is the direct result
22974 of a redirection (see section &<<SECTfildiropt>>&). The &%file%& option
22975 specifies a single file, to which the message is appended. One or more of
22976 &%use_fcntl_lock%&, &%use_flock_lock%&, or &%use_lockfile%& must be set with
22977 &%file%&.
22978
22979 .cindex "NFS" "lock file"
22980 .cindex "locking files"
22981 .cindex "lock files"
22982 If you are using more than one host to deliver over NFS into the same
22983 mailboxes, you should always use lock files.
22984
22985 The string value is expanded for each delivery, and must yield an absolute
22986 path. The most common settings of this option are variations on one of these
22987 examples:
22988 .code
22989 file = /var/spool/mail/$local_part_data
22990 file = /home/$local_part_data/inbox
22991 file = $home/inbox
22992 .endd
22993 .cindex "&""sticky""& bit"
22994 In the first example, all deliveries are done into the same directory. If Exim
22995 is configured to use lock files (see &%use_lockfile%& below) it must be able to
22996 create a file in the directory, so the &"sticky"& bit must be turned on for
22997 deliveries to be possible, or alternatively the &%group%& option can be used to
22998 run the delivery under a group id which has write access to the directory.
22999
23000
23001
23002 .option file_format appendfile string unset
23003 .cindex "file" "mailbox; checking existing format"
23004 This option requests the transport to check the format of an existing file
23005 before adding to it. The check consists of matching a specific string at the
23006 start of the file. The value of the option consists of an even number of
23007 colon-separated strings. The first of each pair is the test string, and the
23008 second is the name of a transport. If the transport associated with a matched
23009 string is not the current transport, control is passed over to the other
23010 transport. For example, suppose the standard &(local_delivery)& transport has
23011 this added to it:
23012 .code
23013 file_format = "From       : local_delivery :\
23014                \1\1\1\1\n : local_mmdf_delivery"
23015 .endd
23016 Mailboxes that begin with &"From"& are still handled by this transport, but if
23017 a mailbox begins with four binary ones followed by a newline, control is passed
23018 to a transport called &%local_mmdf_delivery%&, which presumably is configured
23019 to do the delivery in MMDF format. If a mailbox does not exist or is empty, it
23020 is assumed to match the current transport. If the start of a mailbox doesn't
23021 match any string, or if the transport named for a given string is not defined,
23022 delivery is deferred.
23023
23024
23025 .option file_must_exist appendfile boolean false
23026 If this option is true, the file specified by the &%file%& option must exist.
23027 A temporary error occurs if it does not, causing delivery to be deferred.
23028 If this option is false, the file is created if it does not exist.
23029
23030
23031 .option lock_fcntl_timeout appendfile time 0s
23032 .cindex "timeout" "mailbox locking"
23033 .cindex "mailbox" "locking, blocking and non-blocking"
23034 .cindex "locking files"
23035 By default, the &(appendfile)& transport uses non-blocking calls to &[fcntl()]&
23036 when locking an open mailbox file. If the call fails, the delivery process
23037 sleeps for &%lock_interval%& and tries again, up to &%lock_retries%& times.
23038 Non-blocking calls are used so that the file is not kept open during the wait
23039 for the lock; the reason for this is to make it as safe as possible for
23040 deliveries over NFS in the case when processes might be accessing an NFS
23041 mailbox without using a lock file. This should not be done, but
23042 misunderstandings and hence misconfigurations are not unknown.
23043
23044 On a busy system, however, the performance of a non-blocking lock approach is
23045 not as good as using a blocking lock with a timeout. In this case, the waiting
23046 is done inside the system call, and Exim's delivery process acquires the lock
23047 and can proceed as soon as the previous lock holder releases it.
23048
23049 If &%lock_fcntl_timeout%& is set to a non-zero time, blocking locks, with that
23050 timeout, are used. There may still be some retrying: the maximum number of
23051 retries is
23052 .code
23053 (lock_retries * lock_interval) / lock_fcntl_timeout
23054 .endd
23055 rounded up to the next whole number. In other words, the total time during
23056 which &(appendfile)& is trying to get a lock is roughly the same, unless
23057 &%lock_fcntl_timeout%& is set very large.
23058
23059 You should consider setting this option if you are getting a lot of delayed
23060 local deliveries because of errors of the form
23061 .code
23062 failed to lock mailbox /some/file (fcntl)
23063 .endd
23064
23065 .option lock_flock_timeout appendfile time 0s
23066 This timeout applies to file locking when using &[flock()]& (see
23067 &%use_flock%&); the timeout operates in a similar manner to
23068 &%lock_fcntl_timeout%&.
23069
23070
23071 .option lock_interval appendfile time 3s
23072 This specifies the time to wait between attempts to lock the file. See below
23073 for details of locking.
23074
23075
23076 .option lock_retries appendfile integer 10
23077 This specifies the maximum number of attempts to lock the file. A value of zero
23078 is treated as 1. See below for details of locking.
23079
23080
23081 .option lockfile_mode appendfile "octal integer" 0600
23082 This specifies the mode of the created lock file, when a lock file is being
23083 used (see &%use_lockfile%& and &%use_mbx_lock%&).
23084
23085
23086 .option lockfile_timeout appendfile time 30m
23087 .cindex "timeout" "mailbox locking"
23088 When a lock file is being used (see &%use_lockfile%&), if a lock file already
23089 exists and is older than this value, it is assumed to have been left behind by
23090 accident, and Exim attempts to remove it.
23091
23092
23093 .option mailbox_filecount appendfile string&!! unset
23094 .cindex "mailbox" "specifying size of"
23095 .cindex "size" "of mailbox"
23096 If this option is set, it is expanded, and the result is taken as the current
23097 number of files in the mailbox. It must be a decimal number, optionally
23098 followed by K or M. This provides a way of obtaining this information from an
23099 external source that maintains the data.
23100
23101
23102 .option mailbox_size appendfile string&!! unset
23103 .cindex "mailbox" "specifying size of"
23104 .cindex "size" "of mailbox"
23105 If this option is set, it is expanded, and the result is taken as the current
23106 size the mailbox. It must be a decimal number, optionally followed by K or M.
23107 This provides a way of obtaining this information from an external source that
23108 maintains the data. This is likely to be helpful for maildir deliveries where
23109 it is computationally expensive to compute the size of a mailbox.
23110
23111
23112
23113 .option maildir_format appendfile boolean false
23114 .cindex "maildir format" "specifying"
23115 If this option is set with the &%directory%& option, the delivery is into a new
23116 file, in the &"maildir"& format that is used by other mail software. When the
23117 transport is activated directly from a &(redirect)& router (for example, the
23118 &(address_file)& transport in the default configuration), setting
23119 &%maildir_format%& causes the path received from the router to be treated as a
23120 directory, whether or not it ends with &`/`&. This option is available only if
23121 SUPPORT_MAILDIR is present in &_Local/Makefile_&. See section
23122 &<<SECTmaildirdelivery>>& below for further details.
23123
23124
23125 .option maildir_quota_directory_regex appendfile string "See below"
23126 .cindex "maildir format" "quota; directories included in"
23127 .cindex "quota" "maildir; directories included in"
23128 This option is relevant only when &%maildir_use_size_file%& is set. It defines
23129 a regular expression for specifying directories, relative to the quota
23130 directory (see &%quota_directory%&), that should be included in the quota
23131 calculation. The default value is:
23132 .code
23133 maildir_quota_directory_regex = ^(?:cur|new|\..*)$
23134 .endd
23135 This includes the &_cur_& and &_new_& directories, and any maildir++ folders
23136 (directories whose names begin with a dot). If you want to exclude the
23137 &_Trash_&
23138 folder from the count (as some sites do), you need to change this setting to
23139 .code
23140 maildir_quota_directory_regex = ^(?:cur|new|\.(?!Trash).*)$
23141 .endd
23142 This uses a negative lookahead in the regular expression to exclude the
23143 directory whose name is &_.Trash_&. When a directory is excluded from quota
23144 calculations, quota processing is bypassed for any messages that are delivered
23145 directly into that directory.
23146
23147
23148 .option maildir_retries appendfile integer 10
23149 This option specifies the number of times to retry when writing a file in
23150 &"maildir"& format. See section &<<SECTmaildirdelivery>>& below.
23151
23152
23153 .option maildir_tag appendfile string&!! unset
23154 This option applies only to deliveries in maildir format, and is described in
23155 section &<<SECTmaildirdelivery>>& below.
23156
23157
23158 .option maildir_use_size_file appendfile&!! boolean false
23159 .cindex "maildir format" "&_maildirsize_& file"
23160 The result of string expansion for this option must be a valid boolean value.
23161 If it is true, it enables support for &_maildirsize_& files. Exim
23162 creates a &_maildirsize_& file in a maildir if one does not exist, taking the
23163 quota from the &%quota%& option of the transport. If &%quota%& is unset, the
23164 value is zero. See &%maildir_quota_directory_regex%& above and section
23165 &<<SECTmaildirdelivery>>& below for further details.
23166
23167 .option maildirfolder_create_regex appendfile string unset
23168 .cindex "maildir format" "&_maildirfolder_& file"
23169 .cindex "&_maildirfolder_&, creating"
23170 The value of this option is a regular expression. If it is unset, it has no
23171 effect. Otherwise, before a maildir delivery takes place, the pattern is
23172 matched against the name of the maildir directory, that is, the directory
23173 containing the &_new_& and &_tmp_& subdirectories that will be used for the
23174 delivery. If there is a match, Exim checks for the existence of a file called
23175 &_maildirfolder_& in the directory, and creates it if it does not exist.
23176 See section &<<SECTmaildirdelivery>>& for more details.
23177
23178
23179 .option mailstore_format appendfile boolean false
23180 .cindex "mailstore format" "specifying"
23181 If this option is set with the &%directory%& option, the delivery is into two
23182 new files in  &"mailstore"& format. The option is available only if
23183 SUPPORT_MAILSTORE is present in &_Local/Makefile_&. See section &<<SECTopdir>>&
23184 below for further details.
23185
23186
23187 .option mailstore_prefix appendfile string&!! unset
23188 This option applies only to deliveries in mailstore format, and is described in
23189 section &<<SECTopdir>>& below.
23190
23191
23192 .option mailstore_suffix appendfile string&!! unset
23193 This option applies only to deliveries in mailstore format, and is described in
23194 section &<<SECTopdir>>& below.
23195
23196
23197 .option mbx_format appendfile boolean false
23198 .cindex "locking files"
23199 .cindex "file" "locking"
23200 .cindex "file" "MBX format"
23201 .cindex "MBX format, specifying"
23202 This option is available only if Exim has been compiled with SUPPORT_MBX
23203 set in &_Local/Makefile_&. If &%mbx_format%& is set with the &%file%& option,
23204 the message is appended to the mailbox file in MBX format instead of
23205 traditional Unix format. This format is supported by Pine4 and its associated
23206 IMAP and POP daemons, by means of the &'c-client'& library that they all use.
23207
23208 &*Note*&: The &%message_prefix%& and &%message_suffix%& options are not
23209 automatically changed by the use of &%mbx_format%&. They should normally be set
23210 empty when using MBX format, so this option almost always appears in this
23211 combination:
23212 .code
23213 mbx_format = true
23214 message_prefix =
23215 message_suffix =
23216 .endd
23217 If none of the locking options are mentioned in the configuration,
23218 &%use_mbx_lock%& is assumed and the other locking options default to false. It
23219 is possible to specify the other kinds of locking with &%mbx_format%&, but
23220 &%use_fcntl_lock%& and &%use_mbx_lock%& are mutually exclusive. MBX locking
23221 interworks with &'c-client'&, providing for shared access to the mailbox. It
23222 should not be used if any program that does not use this form of locking is
23223 going to access the mailbox, nor should it be used if the mailbox file is NFS
23224 mounted, because it works only when the mailbox is accessed from a single host.
23225
23226 If you set &%use_fcntl_lock%& with an MBX-format mailbox, you cannot use
23227 the standard version of &'c-client'&, because as long as it has a mailbox open
23228 (this means for the whole of a Pine or IMAP session), Exim will not be able to
23229 append messages to it.
23230
23231
23232 .option message_prefix appendfile string&!! "see below"
23233 .cindex "&""From""& line"
23234 The string specified here is expanded and output at the start of every message.
23235 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
23236 in which case it is:
23237 .code
23238 message_prefix = "From ${if def:return_path{$return_path}\
23239   {MAILER-DAEMON}} $tod_bsdinbox\n"
23240 .endd
23241 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
23242 &`\n`& to &`\r\n`& in &%message_prefix%&.
23243
23244 .option message_suffix appendfile string&!! "see below"
23245 The string specified here is expanded and output at the end of every message.
23246 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
23247 in which case it is a single newline character. The suffix can be suppressed by
23248 setting
23249 .code
23250 message_suffix =
23251 .endd
23252 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
23253 &`\n`& to &`\r\n`& in &%message_suffix%&.
23254
23255 .option mode appendfile "octal integer" 0600
23256 If the output file is created, it is given this mode. If it already exists and
23257 has wider permissions, they are reduced to this mode. If it has narrower
23258 permissions, an error occurs unless &%mode_fail_narrower%& is false. However,
23259 if the delivery is the result of a &%save%& command in a filter file specifying
23260 a particular mode, the mode of the output file is always forced to take that
23261 value, and this option is ignored.
23262
23263
23264 .option mode_fail_narrower appendfile boolean true
23265 This option applies in the case when an existing mailbox file has a narrower
23266 mode than that specified by the &%mode%& option. If &%mode_fail_narrower%& is
23267 true, the delivery is deferred (&"mailbox has the wrong mode"&); otherwise Exim
23268 continues with the delivery attempt, using the existing mode of the file.
23269
23270
23271 .option notify_comsat appendfile boolean false
23272 If this option is true, the &'comsat'& daemon is notified after every
23273 successful delivery to a user mailbox. This is the daemon that notifies logged
23274 on users about incoming mail.
23275
23276
23277 .option quota appendfile string&!! unset
23278 .cindex "quota" "imposed by Exim"
23279 This option imposes a limit on the size of the file to which Exim is appending,
23280 or to the total space used in the directory tree when the &%directory%& option
23281 is set. In the latter case, computation of the space used is expensive, because
23282 all the files in the directory (and any sub-directories) have to be
23283 individually inspected and their sizes summed. (See &%quota_size_regex%& and
23284 &%maildir_use_size_file%& for ways to avoid this in environments where users
23285 have no shell access to their mailboxes).
23286
23287 As there is no interlock against two simultaneous deliveries into a
23288 multi-file mailbox, it is possible for the quota to be overrun in this case.
23289 For single-file mailboxes, of course, an interlock is a necessity.
23290
23291 A file's size is taken as its &'used'& value. Because of blocking effects, this
23292 may be a lot less than the actual amount of disk space allocated to the file.
23293 If the sizes of a number of files are being added up, the rounding effect can
23294 become quite noticeable, especially on systems that have large block sizes.
23295 Nevertheless, it seems best to stick to the &'used'& figure, because this is
23296 the obvious value which users understand most easily.
23297
23298 The value of the option is expanded, and must then be a numerical value
23299 (decimal point allowed), optionally followed by one of the letters K, M, or G,
23300 for kilobytes, megabytes, or gigabytes, optionally followed by a slash
23301 and further option modifiers. If Exim is running on a system with
23302 large file support (Linux and FreeBSD have this), mailboxes larger than 2G can
23303 be handled.
23304
23305 The option modifier &%no_check%& can be used to force delivery even if the over
23306 quota condition is met. The quota gets updated as usual.
23307
23308 &*Note*&: A value of zero is interpreted as &"no quota"&.
23309
23310 The expansion happens while Exim is running as root, before it changes uid for
23311 the delivery. This means that files that are inaccessible to the end user can
23312 be used to hold quota values that are looked up in the expansion. When delivery
23313 fails because this quota is exceeded, the handling of the error is as for
23314 system quota failures.
23315
23316 By default, Exim's quota checking mimics system quotas, and restricts the
23317 mailbox to the specified maximum size, though the value is not accurate to the
23318 last byte, owing to separator lines and additional headers that may get added
23319 during message delivery. When a mailbox is nearly full, large messages may get
23320 refused even though small ones are accepted, because the size of the current
23321 message is added to the quota when the check is made. This behaviour can be
23322 changed by setting &%quota_is_inclusive%& false. When this is done, the check
23323 for exceeding the quota does not include the current message. Thus, deliveries
23324 continue until the quota has been exceeded; thereafter, no further messages are
23325 delivered. See also &%quota_warn_threshold%&.
23326
23327
23328 .option quota_directory appendfile string&!! unset
23329 This option defines the directory to check for quota purposes when delivering
23330 into individual files. The default is the delivery directory, or, if a file
23331 called &_maildirfolder_& exists in a maildir directory, the parent of the
23332 delivery directory.
23333
23334
23335 .option quota_filecount appendfile string&!! 0
23336 This option applies when the &%directory%& option is set. It limits the total
23337 number of files in the directory (compare the inode limit in system quotas). It
23338 can only be used if &%quota%& is also set. The value is expanded; an expansion
23339 failure causes delivery to be deferred. A value of zero is interpreted as
23340 &"no quota"&.
23341
23342 The option modifier &%no_check%& can be used to force delivery even if the over
23343 quota condition is met. The quota gets updated as usual.
23344
23345 .option quota_is_inclusive appendfile boolean true
23346 See &%quota%& above.
23347
23348
23349 .option quota_size_regex appendfile string unset
23350 This option applies when one of the delivery modes that writes a separate file
23351 for each message is being used. When Exim wants to find the size of one of
23352 these files in order to test the quota, it first checks &%quota_size_regex%&.
23353 If this is set to a regular expression that matches the filename, and it
23354 captures one string, that string is interpreted as a representation of the
23355 file's size. The value of &%quota_size_regex%& is not expanded.
23356
23357 This feature is useful only when users have no shell access to their mailboxes
23358 &-- otherwise they could defeat the quota simply by renaming the files. This
23359 facility can be used with maildir deliveries, by setting &%maildir_tag%& to add
23360 the file length to the filename. For example:
23361 .code
23362 maildir_tag = ,S=$message_size
23363 quota_size_regex = ,S=(\d+)
23364 .endd
23365 An alternative to &$message_size$& is &$message_linecount$&, which contains the
23366 number of lines in the message.
23367
23368 The regular expression should not assume that the length is at the end of the
23369 filename (even though &%maildir_tag%& puts it there) because maildir MUAs
23370 sometimes add other information onto the ends of message filenames.
23371
23372 Section &<<SECID136>>& contains further information.
23373
23374 This option should not be used when other message-handling software
23375 may duplicate messages by making hardlinks to the files.  When that is done Exim
23376 will count the message size once for each filename, in contrast with the actual
23377 disk usage.  When the option is not set, calculating total usage requires
23378 a system-call per file to get the size; the number of links is then available also
23379 as is used to adjust the effective size.
23380
23381
23382 .option quota_warn_message appendfile string&!! "see below"
23383 See below for the use of this option. If it is not set when
23384 &%quota_warn_threshold%& is set, it defaults to
23385 .code
23386 quota_warn_message = "\
23387   To: $local_part@$domain\n\
23388   Subject: Your mailbox\n\n\
23389   This message is automatically created \
23390   by mail delivery software.\n\n\
23391   The size of your mailbox has exceeded \
23392   a warning threshold that is\n\
23393   set by the system administrator.\n"
23394 .endd
23395
23396
23397 .option quota_warn_threshold appendfile string&!! 0
23398 .cindex "quota" "warning threshold"
23399 .cindex "mailbox" "size warning"
23400 .cindex "size" "of mailbox"
23401 This option is expanded in the same way as &%quota%& (see above). If the
23402 resulting value is greater than zero, and delivery of the message causes the
23403 size of the file or total space in the directory tree to cross the given
23404 threshold, a warning message is sent. If &%quota%& is also set, the threshold
23405 may be specified as a percentage of it by following the value with a percent
23406 sign. For example:
23407 .code
23408 quota = 10M
23409 quota_warn_threshold = 75%
23410 .endd
23411 If &%quota%& is not set, a setting of &%quota_warn_threshold%& that ends with a
23412 percent sign is ignored.
23413
23414 The warning message itself is specified by the &%quota_warn_message%& option,
23415 and it must start with a &'To:'& header line containing the recipient(s) of the
23416 warning message. These do not necessarily have to include the recipient(s) of
23417 the original message. A &'Subject:'& line should also normally be supplied. You
23418 can include any other header lines that you want. If you do not include a
23419 &'From:'& line, the default is:
23420 .code
23421 From: Mail Delivery System <mailer-daemon@$qualify_domain_sender>
23422 .endd
23423 .oindex &%errors_reply_to%&
23424 If you supply a &'Reply-To:'& line, it overrides the global &%errors_reply_to%&
23425 option.
23426
23427 The &%quota%& option does not have to be set in order to use this option; they
23428 are independent of one another except when the threshold is specified as a
23429 percentage.
23430
23431
23432 .option use_bsmtp appendfile boolean false
23433 .cindex "envelope from"
23434 .cindex "envelope sender"
23435 If this option is set true, &(appendfile)& writes messages in &"batch SMTP"&
23436 format, with the envelope sender and recipient(s) included as SMTP commands. If
23437 you want to include a leading HELO command with such messages, you can do
23438 so by setting the &%message_prefix%& option. See section &<<SECTbatchSMTP>>&
23439 for details of batch SMTP.
23440
23441
23442 .option use_crlf appendfile boolean false
23443 .cindex "carriage return"
23444 .cindex "linefeed"
23445 This option causes lines to be terminated with the two-character CRLF sequence
23446 (carriage return, linefeed) instead of just a linefeed character. In the case
23447 of batched SMTP, the byte sequence written to the file is then an exact image
23448 of what would be sent down a real SMTP connection.
23449
23450 &*Note:*& The contents of the &%message_prefix%& and &%message_suffix%& options
23451 (which are used to supply the traditional &"From&~"& and blank line separators
23452 in Berkeley-style mailboxes) are written verbatim, so must contain their own
23453 carriage return characters if these are needed. In cases where these options
23454 have non-empty defaults, the values end with a single linefeed, so they must be
23455 changed to end with &`\r\n`& if &%use_crlf%& is set.
23456
23457
23458 .option use_fcntl_lock appendfile boolean "see below"
23459 This option controls the use of the &[fcntl()]& function to lock a file for
23460 exclusive use when a message is being appended. It is set by default unless
23461 &%use_flock_lock%& is set. Otherwise, it should be turned off only if you know
23462 that all your MUAs use lock file locking. When both &%use_fcntl_lock%& and
23463 &%use_flock_lock%& are unset, &%use_lockfile%& must be set.
23464
23465
23466 .option use_flock_lock appendfile boolean false
23467 This option is provided to support the use of &[flock()]& for file locking, for
23468 the few situations where it is needed. Most modern operating systems support
23469 &[fcntl()]& and &[lockf()]& locking, and these two functions interwork with
23470 each other. Exim uses &[fcntl()]& locking by default.
23471
23472 This option is required only if you are using an operating system where
23473 &[flock()]& is used by programs that access mailboxes (typically MUAs), and
23474 where &[flock()]& does not correctly interwork with &[fcntl()]&. You can use
23475 both &[fcntl()]& and &[flock()]& locking simultaneously if you want.
23476
23477 .cindex "Solaris" "&[flock()]& support"
23478 Not all operating systems provide &[flock()]&. Some versions of Solaris do not
23479 have it (and some, I think, provide a not quite right version built on top of
23480 &[lockf()]&). If the OS does not have &[flock()]&, Exim will be built without
23481 the ability to use it, and any attempt to do so will cause a configuration
23482 error.
23483
23484 &*Warning*&: &[flock()]& locks do not work on NFS files (unless &[flock()]&
23485 is just being mapped onto &[fcntl()]& by the OS).
23486
23487
23488 .option use_lockfile appendfile boolean "see below"
23489 If this option is turned off, Exim does not attempt to create a lock file when
23490 appending to a mailbox file. In this situation, the only locking is by
23491 &[fcntl()]&. You should only turn &%use_lockfile%& off if you are absolutely
23492 sure that every MUA that is ever going to look at your users' mailboxes uses
23493 &[fcntl()]& rather than a lock file, and even then only when you are not
23494 delivering over NFS from more than one host.
23495
23496 .cindex "NFS" "lock file"
23497 In order to append to an NFS file safely from more than one host, it is
23498 necessary to take out a lock &'before'& opening the file, and the lock file
23499 achieves this. Otherwise, even with &[fcntl()]& locking, there is a risk of
23500 file corruption.
23501
23502 The &%use_lockfile%& option is set by default unless &%use_mbx_lock%& is set.
23503 It is not possible to turn both &%use_lockfile%& and &%use_fcntl_lock%& off,
23504 except when &%mbx_format%& is set.
23505
23506
23507 .option use_mbx_lock appendfile boolean "see below"
23508 This option is available only if Exim has been compiled with SUPPORT_MBX
23509 set in &_Local/Makefile_&. Setting the option specifies that special MBX
23510 locking rules be used. It is set by default if &%mbx_format%& is set and none
23511 of the locking options are mentioned in the configuration. The locking rules
23512 are the same as are used by the &'c-client'& library that underlies Pine and
23513 the IMAP4 and POP daemons that come with it (see the discussion below). The
23514 rules allow for shared access to the mailbox. However, this kind of locking
23515 does not work when the mailbox is NFS mounted.
23516
23517 You can set &%use_mbx_lock%& with either (or both) of &%use_fcntl_lock%& and
23518 &%use_flock_lock%& to control what kind of locking is used in implementing the
23519 MBX locking rules. The default is to use &[fcntl()]& if &%use_mbx_lock%& is set
23520 without &%use_fcntl_lock%& or &%use_flock_lock%&.
23521
23522
23523
23524
23525 .section "Operational details for appending" "SECTopappend"
23526 .cindex "appending to a file"
23527 .cindex "file" "appending"
23528 Before appending to a file, the following preparations are made:
23529
23530 .ilist
23531 If the name of the file is &_/dev/null_&, no action is taken, and a success
23532 return is given.
23533
23534 .next
23535 .cindex "directory creation"
23536 If any directories on the file's path are missing, Exim creates them if the
23537 &%create_directory%& option is set. A created directory's mode is given by the
23538 &%directory_mode%& option.
23539
23540 .next
23541 If &%file_format%& is set, the format of an existing file is checked. If this
23542 indicates that a different transport should be used, control is passed to that
23543 transport.
23544
23545 .next
23546 .cindex "file" "locking"
23547 .cindex "locking files"
23548 .cindex "NFS" "lock file"
23549 If &%use_lockfile%& is set, a lock file is built in a way that will work
23550 reliably over NFS, as follows:
23551
23552 .olist
23553 Create a &"hitching post"& file whose name is that of the lock file with the
23554 current time, primary host name, and process id added, by opening for writing
23555 as a new file. If this fails with an access error, delivery is deferred.
23556 .next
23557 Close the hitching post file, and hard link it to the lock filename.
23558 .next
23559 If the call to &[link()]& succeeds, creation of the lock file has succeeded.
23560 Unlink the hitching post name.
23561 .next
23562 Otherwise, use &[stat()]& to get information about the hitching post file, and
23563 then unlink hitching post name. If the number of links is exactly two, creation
23564 of the lock file succeeded but something (for example, an NFS server crash and
23565 restart) caused this fact not to be communicated to the &[link()]& call.
23566 .next
23567 If creation of the lock file failed, wait for &%lock_interval%& and try again,
23568 up to &%lock_retries%& times. However, since any program that writes to a
23569 mailbox should complete its task very quickly, it is reasonable to time out old
23570 lock files that are normally the result of user agent and system crashes. If an
23571 existing lock file is older than &%lockfile_timeout%& Exim attempts to unlink
23572 it before trying again.
23573 .endlist olist
23574
23575 .next
23576 A call is made to &[lstat()]& to discover whether the main file exists, and if
23577 so, what its characteristics are. If &[lstat()]& fails for any reason other
23578 than non-existence, delivery is deferred.
23579
23580 .next
23581 .cindex "symbolic link" "to mailbox"
23582 .cindex "mailbox" "symbolic link"
23583 If the file does exist and is a symbolic link, delivery is deferred, unless the
23584 &%allow_symlink%& option is set, in which case the ownership of the link is
23585 checked, and then &[stat()]& is called to find out about the real file, which
23586 is then subjected to the checks below. The check on the top-level link
23587 ownership prevents one user creating a link for another's mailbox in a sticky
23588 directory, though allowing symbolic links in this case is definitely not a good
23589 idea. If there is a chain of symbolic links, the intermediate ones are not
23590 checked.
23591
23592 .next
23593 If the file already exists but is not a regular file, or if the file's owner
23594 and group (if the group is being checked &-- see &%check_group%& above) are
23595 different from the user and group under which the delivery is running,
23596 delivery is deferred.
23597
23598 .next
23599 If the file's permissions are more generous than specified, they are reduced.
23600 If they are insufficient, delivery is deferred, unless &%mode_fail_narrower%&
23601 is set false, in which case the delivery is tried using the existing
23602 permissions.
23603
23604 .next
23605 The file's inode number is saved, and the file is then opened for appending.
23606 If this fails because the file has vanished, &(appendfile)& behaves as if it
23607 hadn't existed (see below). For any other failures, delivery is deferred.
23608
23609 .next
23610 If the file is opened successfully, check that the inode number hasn't
23611 changed, that it is still a regular file, and that the owner and permissions
23612 have not changed. If anything is wrong, defer delivery and freeze the message.
23613
23614 .next
23615 If the file did not exist originally, defer delivery if the &%file_must_exist%&
23616 option is set. Otherwise, check that the file is being created in a permitted
23617 directory if the &%create_file%& option is set (deferring on failure), and then
23618 open for writing as a new file, with the O_EXCL and O_CREAT options,
23619 except when dealing with a symbolic link (the &%allow_symlink%& option must be
23620 set). In this case, which can happen if the link points to a non-existent file,
23621 the file is opened for writing using O_CREAT but not O_EXCL, because
23622 that prevents link following.
23623
23624 .next
23625 .cindex "loop" "while file testing"
23626 If opening fails because the file exists, obey the tests given above for
23627 existing files. However, to avoid looping in a situation where the file is
23628 being continuously created and destroyed, the exists/not-exists loop is broken
23629 after 10 repetitions, and the message is then frozen.
23630
23631 .next
23632 If opening fails with any other error, defer delivery.
23633
23634 .next
23635 .cindex "file" "locking"
23636 .cindex "locking files"
23637 Once the file is open, unless both &%use_fcntl_lock%& and &%use_flock_lock%&
23638 are false, it is locked using &[fcntl()]& or &[flock()]& or both. If
23639 &%use_mbx_lock%& is false, an exclusive lock is requested in each case.
23640 However, if &%use_mbx_lock%& is true, Exim takes out a shared lock on the open
23641 file, and an exclusive lock on the file whose name is
23642 .code
23643 /tmp/.<device-number>.<inode-number>
23644 .endd
23645 using the device and inode numbers of the open mailbox file, in accordance with
23646 the MBX locking rules. This file is created with a mode that is specified by
23647 the &%lockfile_mode%& option.
23648
23649 If Exim fails to lock the file, there are two possible courses of action,
23650 depending on the value of the locking timeout. This is obtained from
23651 &%lock_fcntl_timeout%& or &%lock_flock_timeout%&, as appropriate.
23652
23653 If the timeout value is zero, the file is closed, Exim waits for
23654 &%lock_interval%&, and then goes back and re-opens the file as above and tries
23655 to lock it again. This happens up to &%lock_retries%& times, after which the
23656 delivery is deferred.
23657
23658 If the timeout has a value greater than zero, blocking calls to &[fcntl()]& or
23659 &[flock()]& are used (with the given timeout), so there has already been some
23660 waiting involved by the time locking fails. Nevertheless, Exim does not give up
23661 immediately. It retries up to
23662 .code
23663 (lock_retries * lock_interval) / <timeout>
23664 .endd
23665 times (rounded up).
23666 .endlist
23667
23668 At the end of delivery, Exim closes the file (which releases the &[fcntl()]&
23669 and/or &[flock()]& locks) and then deletes the lock file if one was created.
23670
23671
23672 .section "Operational details for delivery to a new file" "SECTopdir"
23673 .cindex "delivery" "to single file"
23674 .cindex "&""From""& line"
23675 When the &%directory%& option is set instead of &%file%&, each message is
23676 delivered into a newly-created file or set of files. When &(appendfile)& is
23677 activated directly from a &(redirect)& router, neither &%file%& nor
23678 &%directory%& is normally set, because the path for delivery is supplied by the
23679 router. (See for example, the &(address_file)& transport in the default
23680 configuration.) In this case, delivery is to a new file if either the path name
23681 ends in &`/`&, or the &%maildir_format%& or &%mailstore_format%& option is set.
23682
23683 No locking is required while writing the message to a new file, so the various
23684 locking options of the transport are ignored. The &"From"& line that by default
23685 separates messages in a single file is not normally needed, nor is the escaping
23686 of message lines that start with &"From"&, and there is no need to ensure a
23687 newline at the end of each message. Consequently, the default values for
23688 &%check_string%&, &%message_prefix%&, and &%message_suffix%& are all unset when
23689 any of &%directory%&, &%maildir_format%&, or &%mailstore_format%& is set.
23690
23691 If Exim is required to check a &%quota%& setting, it adds up the sizes of all
23692 the files in the delivery directory by default. However, you can specify a
23693 different directory by setting &%quota_directory%&. Also, for maildir
23694 deliveries (see below) the &_maildirfolder_& convention is honoured.
23695
23696
23697 .cindex "maildir format"
23698 .cindex "mailstore format"
23699 There are three different ways in which delivery to individual files can be
23700 done, controlled by the settings of the &%maildir_format%& and
23701 &%mailstore_format%& options. Note that code to support maildir or mailstore
23702 formats is not included in the binary unless SUPPORT_MAILDIR or
23703 SUPPORT_MAILSTORE, respectively, is set in &_Local/Makefile_&.
23704
23705 .cindex "directory creation"
23706 In all three cases an attempt is made to create the directory and any necessary
23707 sub-directories if they do not exist, provided that the &%create_directory%&
23708 option is set (the default). The location of a created directory can be
23709 constrained by setting &%create_file%&. A created directory's mode is given by
23710 the &%directory_mode%& option. If creation fails, or if the
23711 &%create_directory%& option is not set when creation is required, delivery is
23712 deferred.
23713
23714
23715
23716 .section "Maildir delivery" "SECTmaildirdelivery"
23717 .cindex "maildir format" "description of"
23718 If the &%maildir_format%& option is true, Exim delivers each message by writing
23719 it to a file whose name is &_tmp/<stime>.H<mtime>P<pid>.<host>_& in the
23720 directory that is defined by the &%directory%& option (the &"delivery
23721 directory"&). If the delivery is successful, the file is renamed into the
23722 &_new_& subdirectory.
23723
23724 In the filename, <&'stime'&> is the current time of day in seconds, and
23725 <&'mtime'&> is the microsecond fraction of the time. After a maildir delivery,
23726 Exim checks that the time-of-day clock has moved on by at least one microsecond
23727 before terminating the delivery process. This guarantees uniqueness for the
23728 filename. However, as a precaution, Exim calls &[stat()]& for the file before
23729 opening it. If any response other than ENOENT (does not exist) is given,
23730 Exim waits 2 seconds and tries again, up to &%maildir_retries%& times.
23731
23732 Before Exim carries out a maildir delivery, it ensures that subdirectories
23733 called &_new_&, &_cur_&, and &_tmp_& exist in the delivery directory. If they
23734 do not exist, Exim tries to create them and any superior directories in their
23735 path, subject to the &%create_directory%& and &%create_file%& options. If the
23736 &%maildirfolder_create_regex%& option is set, and the regular expression it
23737 contains matches the delivery directory, Exim also ensures that a file called
23738 &_maildirfolder_& exists in the delivery directory. If a missing directory or
23739 &_maildirfolder_& file cannot be created, delivery is deferred.
23740
23741 These features make it possible to use Exim to create all the necessary files
23742 and directories in a maildir mailbox, including subdirectories for maildir++
23743 folders. Consider this example:
23744 .code
23745 maildir_format = true
23746 directory = /var/mail/$local_part_data\
23747            ${if eq{$local_part_suffix}{}{}\
23748            {/.${substr_1:$local_part_suffix}}}
23749 maildirfolder_create_regex = /\.[^/]+$
23750 .endd
23751 If &$local_part_suffix$& is empty (there was no suffix for the local part),
23752 delivery is into a toplevel maildir with a name like &_/var/mail/pimbo_& (for
23753 the user called &'pimbo'&). The pattern in &%maildirfolder_create_regex%& does
23754 not match this name, so Exim will not look for or create the file
23755 &_/var/mail/pimbo/maildirfolder_&, though it will create
23756 &_/var/mail/pimbo/{cur,new,tmp}_& if necessary.
23757
23758 However, if &$local_part_suffix$& contains &`-eximusers`& (for example),
23759 delivery is into the maildir++ folder &_/var/mail/pimbo/.eximusers_&, which
23760 does match &%maildirfolder_create_regex%&. In this case, Exim will create
23761 &_/var/mail/pimbo/.eximusers/maildirfolder_& as well as the three maildir
23762 directories &_/var/mail/pimbo/.eximusers/{cur,new,tmp}_&.
23763
23764 &*Warning:*& Take care when setting &%maildirfolder_create_regex%& that it does
23765 not inadvertently match the toplevel maildir directory, because a
23766 &_maildirfolder_& file at top level would completely break quota calculations.
23767
23768 .cindex "quota" "in maildir delivery"
23769 .cindex "maildir++"
23770 If Exim is required to check a &%quota%& setting before a maildir delivery, and
23771 &%quota_directory%& is not set, it looks for a file called &_maildirfolder_& in
23772 the maildir directory (alongside &_new_&, &_cur_&, &_tmp_&). If this exists,
23773 Exim assumes the directory is a maildir++ folder directory, which is one level
23774 down from the user's top level mailbox directory. This causes it to start at
23775 the parent directory instead of the current directory when calculating the
23776 amount of space used.
23777
23778 One problem with delivering into a multi-file mailbox is that it is
23779 computationally expensive to compute the size of the mailbox for quota
23780 checking. Various approaches have been taken to reduce the amount of work
23781 needed. The next two sections describe two of them. A third alternative is to
23782 use some external process for maintaining the size data, and use the expansion
23783 of the &%mailbox_size%& option as a way of importing it into Exim.
23784
23785
23786
23787
23788 .section "Using tags to record message sizes" "SECID135"
23789 If &%maildir_tag%& is set, the string is expanded for each delivery.
23790 When the maildir file is renamed into the &_new_& sub-directory, the
23791 tag is added to its name. However, if adding the tag takes the length of the
23792 name to the point where the test &[stat()]& call fails with ENAMETOOLONG,
23793 the tag is dropped and the maildir file is created with no tag.
23794
23795
23796 .vindex "&$message_size$&"
23797 Tags can be used to encode the size of files in their names; see
23798 &%quota_size_regex%& above for an example. The expansion of &%maildir_tag%&
23799 happens after the message has been written. The value of the &$message_size$&
23800 variable is set to the number of bytes actually written. If the expansion is
23801 forced to fail, the tag is ignored, but a non-forced failure causes delivery to
23802 be deferred. The expanded tag may contain any printing characters except &"/"&.
23803 Non-printing characters in the string are ignored; if the resulting string is
23804 empty, it is ignored. If it starts with an alphanumeric character, a leading
23805 colon is inserted; this default has not proven to be the path that popular
23806 maildir implementations have chosen (but changing it in Exim would break
23807 backwards compatibility).
23808
23809 For one common implementation, you might set:
23810 .code
23811 maildir_tag = ,S=${message_size}
23812 .endd
23813 but you should check the documentation of the other software to be sure.
23814
23815 It is advisable to also set &%quota_size_regex%& when setting &%maildir_tag%&
23816 as this allows Exim to extract the size from your tag, instead of having to
23817 &[stat()]& each message file.
23818
23819
23820 .section "Using a maildirsize file" "SECID136"
23821 .cindex "quota" "in maildir delivery"
23822 .cindex "maildir format" "&_maildirsize_& file"
23823 If &%maildir_use_size_file%& is true, Exim implements the maildir++ rules for
23824 storing quota and message size information in a file called &_maildirsize_&
23825 within the toplevel maildir directory. If this file does not exist, Exim
23826 creates it, setting the quota from the &%quota%& option of the transport. If
23827 the maildir directory itself does not exist, it is created before any attempt
23828 to write a &_maildirsize_& file.
23829
23830 The &_maildirsize_& file is used to hold information about the sizes of
23831 messages in the maildir, thus speeding up quota calculations. The quota value
23832 in the file is just a cache; if the quota is changed in the transport, the new
23833 value overrides the cached value when the next message is delivered. The cache
23834 is maintained for the benefit of other programs that access the maildir and
23835 need to know the quota.
23836
23837 If the &%quota%& option in the transport is unset or zero, the &_maildirsize_&
23838 file is maintained (with a zero quota setting), but no quota is imposed.
23839
23840 A regular expression is available for controlling which directories in the
23841 maildir participate in quota calculations when a &_maildirsizefile_& is in use.
23842 See the description of the &%maildir_quota_directory_regex%& option above for
23843 details.
23844
23845
23846 .section "Mailstore delivery" "SECID137"
23847 .cindex "mailstore format" "description of"
23848 If the &%mailstore_format%& option is true, each message is written as two
23849 files in the given directory. A unique base name is constructed from the
23850 message id and the current delivery process, and the files that are written use
23851 this base name plus the suffixes &_.env_& and &_.msg_&. The &_.env_& file
23852 contains the message's envelope, and the &_.msg_& file contains the message
23853 itself. The base name is placed in the variable &$mailstore_basename$&.
23854
23855 During delivery, the envelope is first written to a file with the suffix
23856 &_.tmp_&. The &_.msg_& file is then written, and when it is complete, the
23857 &_.tmp_& file is renamed as the &_.env_& file. Programs that access messages in
23858 mailstore format should wait for the presence of both a &_.msg_& and a &_.env_&
23859 file before accessing either of them. An alternative approach is to wait for
23860 the absence of a &_.tmp_& file.
23861
23862 The envelope file starts with any text defined by the &%mailstore_prefix%&
23863 option, expanded and terminated by a newline if there isn't one. Then follows
23864 the sender address on one line, then all the recipient addresses, one per line.
23865 There can be more than one recipient only if the &%batch_max%& option is set
23866 greater than one. Finally, &%mailstore_suffix%& is expanded and the result
23867 appended to the file, followed by a newline if it does not end with one.
23868
23869 If expansion of &%mailstore_prefix%& or &%mailstore_suffix%& ends with a forced
23870 failure, it is ignored. Other expansion errors are treated as serious
23871 configuration errors, and delivery is deferred. The variable
23872 &$mailstore_basename$& is available for use during these expansions.
23873
23874
23875 .section "Non-special new file delivery" "SECID138"
23876 If neither &%maildir_format%& nor &%mailstore_format%& is set, a single new
23877 file is created directly in the named directory. For example, when delivering
23878 messages into files in batched SMTP format for later delivery to some host (see
23879 section &<<SECTbatchSMTP>>&), a setting such as
23880 .code
23881 directory = /var/bsmtp/$host
23882 .endd
23883 might be used. A message is written to a file with a temporary name, which is
23884 then renamed when the delivery is complete. The final name is obtained by
23885 expanding the contents of the &%directory_file%& option.
23886 .ecindex IIDapptra1
23887 .ecindex IIDapptra2
23888
23889
23890
23891
23892
23893
23894 . ////////////////////////////////////////////////////////////////////////////
23895 . ////////////////////////////////////////////////////////////////////////////
23896
23897 .chapter "The autoreply transport" "CHID8"
23898 .scindex IIDauttra1 "transports" "&(autoreply)&"
23899 .scindex IIDauttra2 "&(autoreply)& transport"
23900 The &(autoreply)& transport is not a true transport in that it does not cause
23901 the message to be transmitted. Instead, it generates a new mail message as an
23902 automatic reply to the incoming message. &'References:'& and
23903 &'Auto-Submitted:'& header lines are included. These are constructed according
23904 to the rules in RFCs 2822 and 3834, respectively.
23905
23906 If the router that passes the message to this transport does not have the
23907 &%unseen%& option set, the original message (for the current recipient) is not
23908 delivered anywhere. However, when the &%unseen%& option is set on the router
23909 that passes the message to this transport, routing of the address continues, so
23910 another router can set up a normal message delivery.
23911
23912
23913 The &(autoreply)& transport is usually run as the result of mail filtering, a
23914 &"vacation"& message being the standard example. However, it can also be run
23915 directly from a router like any other transport. To reduce the possibility of
23916 message cascades, messages created by the &(autoreply)& transport always have
23917 empty envelope sender addresses, like bounce messages.
23918
23919 The parameters of the message to be sent can be specified in the configuration
23920 by options described below. However, these are used only when the address
23921 passed to the transport does not contain its own reply information. When the
23922 transport is run as a consequence of a
23923 &%mail%&
23924 or &%vacation%& command in a filter file, the parameters of the message are
23925 supplied by the filter, and passed with the address. The transport's options
23926 that define the message are then ignored (so they are not usually set in this
23927 case). The message is specified entirely by the filter or by the transport; it
23928 is never built from a mixture of options. However, the &%file_optional%&,
23929 &%mode%&, and &%return_message%& options apply in all cases.
23930
23931 &(Autoreply)& is implemented as a local transport. When used as a result of a
23932 command in a user's filter file, &(autoreply)& normally runs under the uid and
23933 gid of the user, and with appropriate current and home directories (see chapter
23934 &<<CHAPenvironment>>&).
23935
23936 There is a subtle difference between routing a message to a &(pipe)& transport
23937 that generates some text to be returned to the sender, and routing it to an
23938 &(autoreply)& transport. This difference is noticeable only if more than one
23939 address from the same message is so handled. In the case of a pipe, the
23940 separate outputs from the different addresses are gathered up and returned to
23941 the sender in a single message, whereas if &(autoreply)& is used, a separate
23942 message is generated for each address that is passed to it.
23943
23944 Non-printing characters are not permitted in the header lines generated for the
23945 message that &(autoreply)& creates, with the exception of newlines that are
23946 immediately followed by white space. If any non-printing characters are found,
23947 the transport defers.
23948 Whether characters with the top bit set count as printing characters or not is
23949 controlled by the &%print_topbitchars%& global option.
23950
23951 If any of the generic options for manipulating headers (for example,
23952 &%headers_add%&) are set on an &(autoreply)& transport, they apply to the copy
23953 of the original message that is included in the generated message when
23954 &%return_message%& is set. They do not apply to the generated message itself.
23955
23956 .vindex "&$sender_address$&"
23957 If the &(autoreply)& transport receives return code 2 from Exim when it submits
23958 the message, indicating that there were no recipients, it does not treat this
23959 as an error. This means that autoreplies sent to &$sender_address$& when this
23960 is empty (because the incoming message is a bounce message) do not cause
23961 problems. They are just discarded.
23962
23963
23964
23965 .section "Private options for autoreply" "SECID139"
23966 .cindex "options" "&(autoreply)& transport"
23967
23968 .option bcc autoreply string&!! unset
23969 This specifies the addresses that are to receive &"blind carbon copies"& of the
23970 message when the message is specified by the transport.
23971
23972
23973 .option cc autoreply string&!! unset
23974 This specifies recipients of the message and the contents of the &'Cc:'& header
23975 when the message is specified by the transport.
23976
23977
23978 .option file autoreply string&!! unset
23979 The contents of the file are sent as the body of the message when the message
23980 is specified by the transport. If both &%file%& and &%text%& are set, the text
23981 string comes first.
23982
23983
23984 .option file_expand autoreply boolean false
23985 If this is set, the contents of the file named by the &%file%& option are
23986 subjected to string expansion as they are added to the message.
23987
23988
23989 .option file_optional autoreply boolean false
23990 If this option is true, no error is generated if the file named by the &%file%&
23991 option or passed with the address does not exist or cannot be read.
23992
23993
23994 .option from autoreply string&!! unset
23995 This specifies the contents of the &'From:'& header when the message is
23996 specified by the transport.
23997
23998
23999 .option headers autoreply string&!! unset
24000 This specifies additional RFC 2822 headers that are to be added to the message
24001 when the message is specified by the transport. Several can be given by using
24002 &"\n"& to separate them. There is no check on the format.
24003
24004
24005 .option log autoreply string&!! unset
24006 This option names a file in which a record of every message sent is logged when
24007 the message is specified by the transport.
24008
24009
24010 .option mode autoreply "octal integer" 0600
24011 If either the log file or the &"once"& file has to be created, this mode is
24012 used.
24013
24014
24015 .option never_mail autoreply "address list&!!" unset
24016 If any run of the transport creates a message with a recipient that matches any
24017 item in the list, that recipient is quietly discarded. If all recipients are
24018 discarded, no message is created. This applies both when the recipients are
24019 generated by a filter and when they are specified in the transport.
24020
24021
24022
24023 .option once autoreply string&!! unset
24024 This option names a file or DBM database in which a record of each &'To:'&
24025 recipient is kept when the message is specified by the transport. &*Note*&:
24026 This does not apply to &'Cc:'& or &'Bcc:'& recipients.
24027
24028 If &%once%& is unset, or is set to an empty string, the message is always sent.
24029 By default, if &%once%& is set to a non-empty filename, the message
24030 is not sent if a potential recipient is already listed in the database.
24031 However, if the &%once_repeat%& option specifies a time greater than zero, the
24032 message is sent if that much time has elapsed since a message was last sent to
24033 this recipient. A setting of zero time for &%once_repeat%& (the default)
24034 prevents a message from being sent a second time &-- in this case, zero means
24035 infinity.
24036
24037 If &%once_file_size%& is zero, a DBM database is used to remember recipients,
24038 and it is allowed to grow as large as necessary. If &%once_file_size%& is set
24039 greater than zero, it changes the way Exim implements the &%once%& option.
24040 Instead of using a DBM file to record every recipient it sends to, it uses a
24041 regular file, whose size will never get larger than the given value.
24042
24043 In the file, Exim keeps a linear list of recipient addresses and the times at
24044 which they were sent messages. If the file is full when a new address needs to
24045 be added, the oldest address is dropped. If &%once_repeat%& is not set, this
24046 means that a given recipient may receive multiple messages, but at
24047 unpredictable intervals that depend on the rate of turnover of addresses in the
24048 file. If &%once_repeat%& is set, it specifies a maximum time between repeats.
24049
24050
24051 .option once_file_size autoreply integer 0
24052 See &%once%& above.
24053
24054
24055 .option once_repeat autoreply time&!! 0s
24056 See &%once%& above.
24057 After expansion, the value of this option must be a valid time value.
24058
24059
24060 .option reply_to autoreply string&!! unset
24061 This specifies the contents of the &'Reply-To:'& header when the message is
24062 specified by the transport.
24063
24064
24065 .option return_message autoreply boolean false
24066 If this is set, a copy of the original message is returned with the new
24067 message, subject to the maximum size set in the &%return_size_limit%& global
24068 configuration option.
24069
24070
24071 .option subject autoreply string&!! unset
24072 This specifies the contents of the &'Subject:'& header when the message is
24073 specified by the transport. It is tempting to quote the original subject in
24074 automatic responses. For example:
24075 .code
24076 subject = Re: $h_subject:
24077 .endd
24078 There is a danger in doing this, however. It may allow a third party to
24079 subscribe your users to an opt-in mailing list, provided that the list accepts
24080 bounce messages as subscription confirmations. Well-managed lists require a
24081 non-bounce message to confirm a subscription, so the danger is relatively
24082 small.
24083
24084
24085
24086 .option text autoreply string&!! unset
24087 This specifies a single string to be used as the body of the message when the
24088 message is specified by the transport. If both &%text%& and &%file%& are set,
24089 the text comes first.
24090
24091
24092 .option to autoreply string&!! unset
24093 This specifies recipients of the message and the contents of the &'To:'& header
24094 when the message is specified by the transport.
24095 .ecindex IIDauttra1
24096 .ecindex IIDauttra2
24097
24098
24099
24100
24101 . ////////////////////////////////////////////////////////////////////////////
24102 . ////////////////////////////////////////////////////////////////////////////
24103
24104 .chapter "The lmtp transport" "CHAPLMTP"
24105 .cindex "transports" "&(lmtp)&"
24106 .cindex "&(lmtp)& transport"
24107 .cindex "LMTP" "over a pipe"
24108 .cindex "LMTP" "over a socket"
24109 The &(lmtp)& transport runs the LMTP protocol (RFC 2033) over a pipe to a
24110 specified command
24111 or by interacting with a Unix domain socket.
24112 This transport is something of a cross between the &(pipe)& and &(smtp)&
24113 transports. Exim also has support for using LMTP over TCP/IP; this is
24114 implemented as an option for the &(smtp)& transport. Because LMTP is expected
24115 to be of minority interest, the default build-time configure in &_src/EDITME_&
24116 has it commented out. You need to ensure that
24117 .code
24118 TRANSPORT_LMTP=yes
24119 .endd
24120 .cindex "options" "&(lmtp)& transport"
24121 is present in your &_Local/Makefile_& in order to have the &(lmtp)& transport
24122 included in the Exim binary. The private options of the &(lmtp)& transport are
24123 as follows:
24124
24125 .option batch_id lmtp string&!! unset
24126 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
24127
24128
24129 .option batch_max lmtp integer 1
24130 This limits the number of addresses that can be handled in a single delivery.
24131 Most LMTP servers can handle several addresses at once, so it is normally a
24132 good idea to increase this value. See the description of local delivery
24133 batching in chapter &<<CHAPbatching>>&.
24134
24135
24136 .option command lmtp string&!! unset
24137 This option must be set if &%socket%& is not set. The string is a command which
24138 is run in a separate process. It is split up into a command name and list of
24139 arguments, each of which is separately expanded (so expansion cannot change the
24140 number of arguments). The command is run directly, not via a shell. The message
24141 is passed to the new process using the standard input and output to operate the
24142 LMTP protocol.
24143
24144 .option ignore_quota lmtp boolean false
24145 .cindex "LMTP" "ignoring quota errors"
24146 If this option is set true, the string &`IGNOREQUOTA`& is added to RCPT
24147 commands, provided that the LMTP server has advertised support for IGNOREQUOTA
24148 in its response to the LHLO command.
24149
24150 .option socket lmtp string&!! unset
24151 This option must be set if &%command%& is not set. The result of expansion must
24152 be the name of a Unix domain socket. The transport connects to the socket and
24153 delivers the message to it using the LMTP protocol.
24154
24155
24156 .option timeout lmtp time 5m
24157 The transport is aborted if the created process or Unix domain socket does not
24158 respond to LMTP commands or message input within this timeout. Delivery
24159 is deferred, and will be tried again later. Here is an example of a typical
24160 LMTP transport:
24161 .code
24162 lmtp:
24163   driver = lmtp
24164   command = /some/local/lmtp/delivery/program
24165   batch_max = 20
24166   user = exim
24167 .endd
24168 This delivers up to 20 addresses at a time, in a mixture of domains if
24169 necessary, running as the user &'exim'&.
24170
24171
24172
24173 . ////////////////////////////////////////////////////////////////////////////
24174 . ////////////////////////////////////////////////////////////////////////////
24175
24176 .chapter "The pipe transport" "CHAPpipetransport"
24177 .scindex IIDpiptra1 "transports" "&(pipe)&"
24178 .scindex IIDpiptra2 "&(pipe)& transport"
24179 The &(pipe)& transport is used to deliver messages via a pipe to a command
24180 running in another process. One example is the use of &(pipe)& as a
24181 pseudo-remote transport for passing messages to some other delivery mechanism
24182 (such as UUCP). Another is the use by individual users to automatically process
24183 their incoming messages. The &(pipe)& transport can be used in one of the
24184 following ways:
24185
24186 .ilist
24187 .vindex "&$local_part$&"
24188 A router routes one address to a transport in the normal way, and the
24189 transport is configured as a &(pipe)& transport. In this case, &$local_part$&
24190 contains the local part of the address (as usual), and the command that is run
24191 is specified by the &%command%& option on the transport.
24192 .next
24193 .vindex "&$pipe_addresses$&"
24194 If the &%batch_max%& option is set greater than 1 (the default is 1), the
24195 transport can handle more than one address in a single run. In this case, when
24196 more than one address is routed to the transport, &$local_part$& is not set
24197 (because it is not unique). However, the pseudo-variable &$pipe_addresses$&
24198 (described in section &<<SECThowcommandrun>>& below) contains all the addresses
24199 that are routed to the transport.
24200 .next
24201 .vindex "&$address_pipe$&"
24202 A router redirects an address directly to a pipe command (for example, from an
24203 alias or forward file). In this case, &$address_pipe$& contains the text of the
24204 pipe command, and the &%command%& option on the transport is ignored unless
24205 &%force_command%& is set. If only one address is being transported
24206 (&%batch_max%& is not greater than one, or only one address was redirected to
24207 this pipe command), &$local_part$& contains the local part that was redirected.
24208 .endlist
24209
24210
24211 The &(pipe)& transport is a non-interactive delivery method. Exim can also
24212 deliver messages over pipes using the LMTP interactive protocol. This is
24213 implemented by the &(lmtp)& transport.
24214
24215 In the case when &(pipe)& is run as a consequence of an entry in a local user's
24216 &_.forward_& file, the command runs under the uid and gid of that user. In
24217 other cases, the uid and gid have to be specified explicitly, either on the
24218 transport or on the router that handles the address. Current and &"home"&
24219 directories are also controllable. See chapter &<<CHAPenvironment>>& for
24220 details of the local delivery environment and chapter &<<CHAPbatching>>&
24221 for a discussion of local delivery batching.
24222
24223 .new
24224 .cindex "tainted data" "in pipe command"
24225 .cindex pipe "tainted data"
24226 Tainted data may not be used for the command name.
24227 .wen
24228
24229
24230 .section "Concurrent delivery" "SECID140"
24231 If two messages arrive at almost the same time, and both are routed to a pipe
24232 delivery, the two pipe transports may be run concurrently. You must ensure that
24233 any pipe commands you set up are robust against this happening. If the commands
24234 write to a file, the &%exim_lock%& utility might be of use.
24235 Alternatively the &%max_parallel%& option could be used with a value
24236 of "1" to enforce serialization.
24237
24238
24239
24240
24241 .section "Returned status and data" "SECID141"
24242 .cindex "&(pipe)& transport" "returned data"
24243 If the command exits with a non-zero return code, the delivery is deemed to
24244 have failed, unless either the &%ignore_status%& option is set (in which case
24245 the return code is treated as zero), or the return code is one of those listed
24246 in the &%temp_errors%& option, which are interpreted as meaning &"try again
24247 later"&. In this case, delivery is deferred. Details of a permanent failure are
24248 logged, but are not included in the bounce message, which merely contains
24249 &"local delivery failed"&.
24250
24251 If the command exits on a signal and the &%freeze_signal%& option is set then
24252 the message will be frozen in the queue. If that option is not set, a bounce
24253 will be sent as normal.
24254
24255 If the return code is greater than 128 and the command being run is a shell
24256 script, it normally means that the script was terminated by a signal whose
24257 value is the return code minus 128. The &%freeze_signal%& option does not
24258 apply in this case.
24259
24260 If Exim is unable to run the command (that is, if &[execve()]& fails), the
24261 return code is set to 127. This is the value that a shell returns if it is
24262 asked to run a non-existent command. The wording for the log line suggests that
24263 a non-existent command may be the problem.
24264
24265 The &%return_output%& option can affect the result of a pipe delivery. If it is
24266 set and the command produces any output on its standard output or standard
24267 error streams, the command is considered to have failed, even if it gave a zero
24268 return code or if &%ignore_status%& is set. The output from the command is
24269 included as part of the bounce message. The &%return_fail_output%& option is
24270 similar, except that output is returned only when the command exits with a
24271 failure return code, that is, a value other than zero or a code that matches
24272 &%temp_errors%&.
24273
24274
24275
24276 .section "How the command is run" "SECThowcommandrun"
24277 .cindex "&(pipe)& transport" "path for command"
24278 The command line is (by default) broken down into a command name and arguments
24279 by the &(pipe)& transport itself. The &%allow_commands%& and
24280 &%restrict_to_path%& options can be used to restrict the commands that may be
24281 run.
24282
24283 .cindex "quoting" "in pipe command"
24284 Unquoted arguments are delimited by white space. If an argument appears in
24285 double quotes, backslash is interpreted as an escape character in the usual
24286 way. If an argument appears in single quotes, no escaping is done.
24287
24288 String expansion is applied to the command line except when it comes from a
24289 traditional &_.forward_& file (commands from a filter file are expanded). The
24290 expansion is applied to each argument in turn rather than to the whole line.
24291 For this reason, any string expansion item that contains white space must be
24292 quoted so as to be contained within a single argument. A setting such as
24293 .code
24294 command = /some/path ${if eq{$local_part}{postmaster}{xx}{yy}}
24295 .endd
24296 will not work, because the expansion item gets split between several
24297 arguments. You have to write
24298 .code
24299 command = /some/path "${if eq{$local_part}{postmaster}{xx}{yy}}"
24300 .endd
24301 to ensure that it is all in one argument. The expansion is done in this way,
24302 argument by argument, so that the number of arguments cannot be changed as a
24303 result of expansion, and quotes or backslashes in inserted variables do not
24304 interact with external quoting. However, this leads to problems if you want to
24305 generate multiple arguments (or the command name plus arguments) from a single
24306 expansion. In this situation, the simplest solution is to use a shell. For
24307 example:
24308 .code
24309 command = /bin/sh -c ${lookup{$local_part}lsearch{/some/file}}
24310 .endd
24311
24312 .cindex "transport" "filter"
24313 .cindex "filter" "transport filter"
24314 .vindex "&$pipe_addresses$&"
24315 Special handling takes place when an argument consists of precisely the text
24316 &`$pipe_addresses`& (no quotes).
24317 This is not a general expansion variable; the only
24318 place this string is recognized is when it appears as an argument for a pipe or
24319 transport filter command. It causes each address that is being handled to be
24320 inserted in the argument list at that point &'as a separate argument'&. This
24321 avoids any problems with spaces or shell metacharacters, and is of use when a
24322 &(pipe)& transport is handling groups of addresses in a batch.
24323
24324 If &%force_command%& is enabled on the transport, special handling takes place
24325 for an argument that consists of precisely the text &`$address_pipe`&.  It
24326 is handled similarly to &$pipe_addresses$& above.  It is expanded and each
24327 argument is inserted in the argument list at that point
24328 &'as a separate argument'&.  The &`$address_pipe`& item does not need to be
24329 the only item in the argument; in fact, if it were then &%force_command%&
24330 should behave as a no-op.  Rather, it should be used to adjust the command
24331 run while preserving the argument vector separation.
24332
24333 After splitting up into arguments and expansion, the resulting command is run
24334 in a subprocess directly from the transport, &'not'& under a shell. The
24335 message that is being delivered is supplied on the standard input, and the
24336 standard output and standard error are both connected to a single pipe that is
24337 read by Exim. The &%max_output%& option controls how much output the command
24338 may produce, and the &%return_output%& and &%return_fail_output%& options
24339 control what is done with it.
24340
24341 Not running the command under a shell (by default) lessens the security risks
24342 in cases when a command from a user's filter file is built out of data that was
24343 taken from an incoming message. If a shell is required, it can of course be
24344 explicitly specified as the command to be run. However, there are circumstances
24345 where existing commands (for example, in &_.forward_& files) expect to be run
24346 under a shell and cannot easily be modified. To allow for these cases, there is
24347 an option called &%use_shell%&, which changes the way the &(pipe)& transport
24348 works. Instead of breaking up the command line as just described, it expands it
24349 as a single string and passes the result to &_/bin/sh_&. The
24350 &%restrict_to_path%& option and the &$pipe_addresses$& facility cannot be used
24351 with &%use_shell%&, and the whole mechanism is inherently less secure.
24352
24353
24354
24355 .section "Environment variables" "SECTpipeenv"
24356 .cindex "&(pipe)& transport" "environment for command"
24357 .cindex "environment" "&(pipe)& transport"
24358 The environment variables listed below are set up when the command is invoked.
24359 This list is a compromise for maximum compatibility with other MTAs. Note that
24360 the &%environment%& option can be used to add additional variables to this
24361 environment. The environment for the &(pipe)& transport is not subject
24362 to the &%add_environment%& and &%keep_environment%& main config options.
24363 .display
24364 &`DOMAIN            `&   the domain of the address
24365 &`HOME              `&   the home directory, if set
24366 &`HOST              `&   the host name when called from a router (see below)
24367 &`LOCAL_PART        `&   see below
24368 &`LOCAL_PART_PREFIX `&   see below
24369 &`LOCAL_PART_SUFFIX `&   see below
24370 &`LOGNAME           `&   see below
24371 &`MESSAGE_ID        `&   Exim's local ID for the message
24372 &`PATH              `&   as specified by the &%path%& option below
24373 &`QUALIFY_DOMAIN    `&   the sender qualification domain
24374 &`RECIPIENT         `&   the complete recipient address
24375 &`SENDER            `&   the sender of the message (empty if a bounce)
24376 &`SHELL             `&   &`/bin/sh`&
24377 &`TZ                `&   the value of the &%timezone%& option, if set
24378 &`USER              `&   see below
24379 .endd
24380 When a &(pipe)& transport is called directly from (for example) an &(accept)&
24381 router, LOCAL_PART is set to the local part of the address. When it is
24382 called as a result of a forward or alias expansion, LOCAL_PART is set to
24383 the local part of the address that was expanded. In both cases, any affixes are
24384 removed from the local part, and made available in LOCAL_PART_PREFIX and
24385 LOCAL_PART_SUFFIX, respectively. LOGNAME and USER are set to the
24386 same value as LOCAL_PART for compatibility with other MTAs.
24387
24388 .cindex "HOST"
24389 HOST is set only when a &(pipe)& transport is called from a router that
24390 associates hosts with an address, typically when using &(pipe)& as a
24391 pseudo-remote transport. HOST is set to the first host name specified by
24392 the router.
24393
24394 .cindex "HOME"
24395 If the transport's generic &%home_directory%& option is set, its value is used
24396 for the HOME environment variable. Otherwise, a home directory may be set
24397 by the router's &%transport_home_directory%& option, which defaults to the
24398 user's home directory if &%check_local_user%& is set.
24399
24400
24401 .section "Private options for pipe" "SECID142"
24402 .cindex "options" "&(pipe)& transport"
24403
24404
24405
24406 .option allow_commands pipe "string list&!!" unset
24407 .cindex "&(pipe)& transport" "permitted commands"
24408 The string is expanded, and is then interpreted as a colon-separated list of
24409 permitted commands. If &%restrict_to_path%& is not set, the only commands
24410 permitted are those in the &%allow_commands%& list. They need not be absolute
24411 paths; the &%path%& option is still used for relative paths. If
24412 &%restrict_to_path%& is set with &%allow_commands%&, the command must either be
24413 in the &%allow_commands%& list, or a name without any slashes that is found on
24414 the path. In other words, if neither &%allow_commands%& nor
24415 &%restrict_to_path%& is set, there is no restriction on the command, but
24416 otherwise only commands that are permitted by one or the other are allowed. For
24417 example, if
24418 .code
24419 allow_commands = /usr/bin/vacation
24420 .endd
24421 and &%restrict_to_path%& is not set, the only permitted command is
24422 &_/usr/bin/vacation_&. The &%allow_commands%& option may not be set if
24423 &%use_shell%& is set.
24424
24425
24426 .option batch_id pipe string&!! unset
24427 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
24428
24429
24430 .option batch_max pipe integer 1
24431 This limits the number of addresses that can be handled in a single delivery.
24432 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
24433
24434
24435 .option check_string pipe string unset
24436 As &(pipe)& writes the message, the start of each line is tested for matching
24437 &%check_string%&, and if it does, the initial matching characters are replaced
24438 by the contents of &%escape_string%&, provided both are set. The value of
24439 &%check_string%& is a literal string, not a regular expression, and the case of
24440 any letters it contains is significant. When &%use_bsmtp%& is set, the contents
24441 of &%check_string%& and &%escape_string%& are forced to values that implement
24442 the SMTP escaping protocol. Any settings made in the configuration file are
24443 ignored.
24444
24445
24446 .option command pipe string&!! unset
24447 This option need not be set when &(pipe)& is being used to deliver to pipes
24448 obtained directly from address redirections. In other cases, the option must be
24449 set, to provide a command to be run. It need not yield an absolute path (see
24450 the &%path%& option below). The command is split up into separate arguments by
24451 Exim, and each argument is separately expanded, as described in section
24452 &<<SECThowcommandrun>>& above.
24453
24454
24455 .option environment pipe string&!! unset
24456 .cindex "&(pipe)& transport" "environment for command"
24457 .cindex "environment" "&(pipe)& transport"
24458 This option is used to add additional variables to the environment in which the
24459 command runs (see section &<<SECTpipeenv>>& for the default list). Its value is
24460 a string which is expanded, and then interpreted as a colon-separated list of
24461 environment settings of the form <&'name'&>=<&'value'&>.
24462
24463
24464 .option escape_string pipe string unset
24465 See &%check_string%& above.
24466
24467
24468 .option freeze_exec_fail pipe boolean false
24469 .cindex "exec failure"
24470 .cindex "failure of exec"
24471 .cindex "&(pipe)& transport" "failure of exec"
24472 Failure to exec the command in a pipe transport is by default treated like
24473 any other failure while running the command. However, if &%freeze_exec_fail%&
24474 is set, failure to exec is treated specially, and causes the message to be
24475 frozen, whatever the setting of &%ignore_status%&.
24476
24477
24478 .option freeze_signal pipe boolean false
24479 .cindex "signal exit"
24480 .cindex "&(pipe)& transport", "signal exit"
24481 Normally if the process run by a command in a pipe transport exits on a signal,
24482 a bounce message is sent. If &%freeze_signal%& is set, the message will be
24483 frozen in Exim's queue instead.
24484
24485
24486 .option force_command pipe boolean false
24487 .cindex "force command"
24488 .cindex "&(pipe)& transport", "force command"
24489 Normally when a router redirects an address directly to a pipe command
24490 the &%command%& option on the transport is ignored.  If &%force_command%&
24491 is set, the &%command%& option will used. This is especially
24492 useful for forcing a wrapper or additional argument to be added to the
24493 command. For example:
24494 .code
24495 command = /usr/bin/remote_exec myhost -- $address_pipe
24496 force_command
24497 .endd
24498
24499 Note that &$address_pipe$& is handled specially in &%command%& when
24500 &%force_command%& is set, expanding out to the original argument vector as
24501 separate items, similarly to a Unix shell &`"$@"`& construct.
24502
24503
24504 .option ignore_status pipe boolean false
24505 If this option is true, the status returned by the subprocess that is set up to
24506 run the command is ignored, and Exim behaves as if zero had been returned.
24507 Otherwise, a non-zero status or termination by signal causes an error return
24508 from the transport unless the status value is one of those listed in
24509 &%temp_errors%&; these cause the delivery to be deferred and tried again later.
24510
24511 &*Note*&: This option does not apply to timeouts, which do not return a status.
24512 See the &%timeout_defer%& option for how timeouts are handled.
24513
24514
24515 .option log_defer_output pipe boolean false
24516 .cindex "&(pipe)& transport" "logging output"
24517 If this option is set, and the status returned by the command is
24518 one of the codes listed in &%temp_errors%& (that is, delivery was deferred),
24519 and any output was produced on stdout or stderr, the first line of it is
24520 written to the main log.
24521
24522
24523 .option log_fail_output pipe boolean false
24524 If this option is set, and the command returns any output on stdout or
24525 stderr, and also ends with a return code that is neither zero nor one of
24526 the return codes listed in &%temp_errors%& (that is, the delivery
24527 failed), the first line of output is written to the main log. This
24528 option and &%log_output%& are mutually exclusive.  Only one of them may
24529 be set.
24530
24531
24532 .option log_output pipe boolean false
24533 If this option is set and the command returns any output on stdout or
24534 stderr, the first line of output is written to the main log, whatever
24535 the return code. This option and &%log_fail_output%& are mutually
24536 exclusive. Only one of them may be set.
24537
24538
24539 .option max_output pipe integer 20K
24540 This specifies the maximum amount of output that the command may produce on its
24541 standard output and standard error file combined. If the limit is exceeded, the
24542 process running the command is killed. This is intended as a safety measure to
24543 catch runaway processes. The limit is applied independently of the settings of
24544 the options that control what is done with such output (for example,
24545 &%return_output%&). Because of buffering effects, the amount of output may
24546 exceed the limit by a small amount before Exim notices.
24547
24548
24549 .option message_prefix pipe string&!! "see below"
24550 The string specified here is expanded and output at the start of every message.
24551 The default is unset if &%use_bsmtp%& is set. Otherwise it is
24552 .code
24553 message_prefix = \
24554   From ${if def:return_path{$return_path}{MAILER-DAEMON}}\
24555   ${tod_bsdinbox}\n
24556 .endd
24557 .cindex "Cyrus"
24558 .cindex "&%tmail%&"
24559 .cindex "&""From""& line"
24560 This is required by the commonly used &_/usr/bin/vacation_& program.
24561 However, it must &'not'& be present if delivery is to the Cyrus IMAP server,
24562 or to the &%tmail%& local delivery agent. The prefix can be suppressed by
24563 setting
24564 .code
24565 message_prefix =
24566 .endd
24567 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
24568 &`\n`& to &`\r\n`& in &%message_prefix%&.
24569
24570
24571 .option message_suffix pipe string&!! "see below"
24572 The string specified here is expanded and output at the end of every message.
24573 The default is unset if &%use_bsmtp%& is set. Otherwise it is a single newline.
24574 The suffix can be suppressed by setting
24575 .code
24576 message_suffix =
24577 .endd
24578 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
24579 &`\n`& to &`\r\n`& in &%message_suffix%&.
24580
24581
24582 .option path pipe string&!! "/bin:/usr/bin"
24583 This option is expanded and
24584 specifies the string that is set up in the PATH environment
24585 variable of the subprocess.
24586 If the &%command%& option does not yield an absolute path name, the command is
24587 sought in the PATH directories, in the usual way. &*Warning*&: This does not
24588 apply to a command specified as a transport filter.
24589
24590
24591 .option permit_coredump pipe boolean false
24592 Normally Exim inhibits core-dumps during delivery.  If you have a need to get
24593 a core-dump of a pipe command, enable this command.  This enables core-dumps
24594 during delivery and affects both the Exim binary and the pipe command run.
24595 It is recommended that this option remain off unless and until you have a need
24596 for it and that this only be enabled when needed, as the risk of excessive
24597 resource consumption can be quite high.  Note also that Exim is typically
24598 installed as a setuid binary and most operating systems will inhibit coredumps
24599 of these by default, so further OS-specific action may be required.
24600
24601
24602 .option pipe_as_creator pipe boolean false
24603 .cindex "uid (user id)" "local delivery"
24604 If the generic &%user%& option is not set and this option is true, the delivery
24605 process is run under the uid that was in force when Exim was originally called
24606 to accept the message. If the group id is not otherwise set (via the generic
24607 &%group%& option), the gid that was in force when Exim was originally called to
24608 accept the message is used.
24609
24610
24611 .option restrict_to_path pipe boolean false
24612 When this option is set, any command name not listed in &%allow_commands%& must
24613 contain no slashes. The command is searched for only in the directories listed
24614 in the &%path%& option. This option is intended for use in the case when a pipe
24615 command has been generated from a user's &_.forward_& file. This is usually
24616 handled by a &(pipe)& transport called &%address_pipe%&.
24617
24618
24619 .option return_fail_output pipe boolean false
24620 If this option is true, and the command produced any output and ended with a
24621 return code other than zero or one of the codes listed in &%temp_errors%& (that
24622 is, the delivery failed), the output is returned in the bounce message.
24623 However, if the message has a null sender (that is, it is itself a bounce
24624 message), output from the command is discarded. This option and
24625 &%return_output%& are mutually exclusive. Only one of them may be set.
24626
24627
24628
24629 .option return_output pipe boolean false
24630 If this option is true, and the command produced any output, the delivery is
24631 deemed to have failed whatever the return code from the command, and the output
24632 is returned in the bounce message. Otherwise, the output is just discarded.
24633 However, if the message has a null sender (that is, it is a bounce message),
24634 output from the command is always discarded, whatever the setting of this
24635 option. This option and &%return_fail_output%& are mutually exclusive. Only one
24636 of them may be set.
24637
24638
24639
24640 .option temp_errors pipe "string list" "see below"
24641 .cindex "&(pipe)& transport" "temporary failure"
24642 This option contains either a colon-separated list of numbers, or a single
24643 asterisk. If &%ignore_status%& is false
24644 and &%return_output%& is not set,
24645 and the command exits with a non-zero return code, the failure is treated as
24646 temporary and the delivery is deferred if the return code matches one of the
24647 numbers, or if the setting is a single asterisk. Otherwise, non-zero return
24648 codes are treated as permanent errors. The default setting contains the codes
24649 defined by EX_TEMPFAIL and EX_CANTCREAT in &_sysexits.h_&. If Exim is
24650 compiled on a system that does not define these macros, it assumes values of 75
24651 and 73, respectively.
24652
24653
24654 .option timeout pipe time 1h
24655 If the command fails to complete within this time, it is killed. This normally
24656 causes the delivery to fail (but see &%timeout_defer%&). A zero time interval
24657 specifies no timeout. In order to ensure that any subprocesses created by the
24658 command are also killed, Exim makes the initial process a process group leader,
24659 and kills the whole process group on a timeout. However, this can be defeated
24660 if one of the processes starts a new process group.
24661
24662 .option timeout_defer pipe boolean false
24663 A timeout in a &(pipe)& transport, either in the command that the transport
24664 runs, or in a transport filter that is associated with it, is by default
24665 treated as a hard error, and the delivery fails. However, if &%timeout_defer%&
24666 is set true, both kinds of timeout become temporary errors, causing the
24667 delivery to be deferred.
24668
24669 .option umask pipe "octal integer" 022
24670 This specifies the umask setting for the subprocess that runs the command.
24671
24672
24673 .option use_bsmtp pipe boolean false
24674 .cindex "envelope sender"
24675 If this option is set true, the &(pipe)& transport writes messages in &"batch
24676 SMTP"& format, with the envelope sender and recipient(s) included as SMTP
24677 commands. If you want to include a leading HELO command with such messages,
24678 you can do so by setting the &%message_prefix%& option. See section
24679 &<<SECTbatchSMTP>>& for details of batch SMTP.
24680
24681 .option use_classresources pipe boolean false
24682 .cindex "class resources (BSD)"
24683 This option is available only when Exim is running on FreeBSD, NetBSD, or
24684 BSD/OS. If it is set true, the &[setclassresources()]& function is used to set
24685 resource limits when a &(pipe)& transport is run to perform a delivery. The
24686 limits for the uid under which the pipe is to run are obtained from the login
24687 class database.
24688
24689
24690 .option use_crlf pipe boolean false
24691 .cindex "carriage return"
24692 .cindex "linefeed"
24693 This option causes lines to be terminated with the two-character CRLF sequence
24694 (carriage return, linefeed) instead of just a linefeed character. In the case
24695 of batched SMTP, the byte sequence written to the pipe is then an exact image
24696 of what would be sent down a real SMTP connection.
24697
24698 The contents of the &%message_prefix%& and &%message_suffix%& options are
24699 written verbatim, so must contain their own carriage return characters if these
24700 are needed. When &%use_bsmtp%& is not set, the default values for both
24701 &%message_prefix%& and &%message_suffix%& end with a single linefeed, so their
24702 values must be changed to end with &`\r\n`& if &%use_crlf%& is set.
24703
24704
24705 .option use_shell pipe boolean false
24706 .vindex "&$pipe_addresses$&"
24707 If this option is set, it causes the command to be passed to &_/bin/sh_&
24708 instead of being run directly from the transport, as described in section
24709 &<<SECThowcommandrun>>&. This is less secure, but is needed in some situations
24710 where the command is expected to be run under a shell and cannot easily be
24711 modified. The &%allow_commands%& and &%restrict_to_path%& options, and the
24712 &`$pipe_addresses`& facility are incompatible with &%use_shell%&. The
24713 command is expanded as a single string, and handed to &_/bin/sh_& as data for
24714 its &%-c%& option.
24715
24716
24717
24718 .section "Using an external local delivery agent" "SECID143"
24719 .cindex "local delivery" "using an external agent"
24720 .cindex "&'procmail'&"
24721 .cindex "external local delivery"
24722 .cindex "delivery" "&'procmail'&"
24723 .cindex "delivery" "by external agent"
24724 The &(pipe)& transport can be used to pass all messages that require local
24725 delivery to a separate local delivery agent such as &%procmail%&. When doing
24726 this, care must be taken to ensure that the pipe is run under an appropriate
24727 uid and gid. In some configurations one wants this to be a uid that is trusted
24728 by the delivery agent to supply the correct sender of the message. It may be
24729 necessary to recompile or reconfigure the delivery agent so that it trusts an
24730 appropriate user. The following is an example transport and router
24731 configuration for &%procmail%&:
24732 .code
24733 # transport
24734 procmail_pipe:
24735   driver = pipe
24736   command = /usr/local/bin/procmail -d $local_part_data
24737   return_path_add
24738   delivery_date_add
24739   envelope_to_add
24740   check_string = "From "
24741   escape_string = ">From "
24742   umask = 077
24743   user = $local_part_data
24744   group = mail
24745
24746 # router
24747 procmail:
24748   driver = accept
24749   check_local_user
24750   transport = procmail_pipe
24751 .endd
24752 In this example, the pipe is run as the local user, but with the group set to
24753 &'mail'&. An alternative is to run the pipe as a specific user such as &'mail'&
24754 or &'exim'&, but in this case you must arrange for &%procmail%& to trust that
24755 user to supply a correct sender address. If you do not specify either a
24756 &%group%& or a &%user%& option, the pipe command is run as the local user. The
24757 home directory is the user's home directory by default.
24758
24759 &*Note*&: The command that the pipe transport runs does &'not'& begin with
24760 .code
24761 IFS=" "
24762 .endd
24763 as shown in some &%procmail%& documentation, because Exim does not by default
24764 use a shell to run pipe commands.
24765
24766 .cindex "Cyrus"
24767 The next example shows a transport and a router for a system where local
24768 deliveries are handled by the Cyrus IMAP server.
24769 .code
24770 # transport
24771 local_delivery_cyrus:
24772   driver = pipe
24773   command = /usr/cyrus/bin/deliver \
24774             -m ${substr_1:$local_part_suffix} -- $local_part
24775   user = cyrus
24776   group = mail
24777   return_output
24778   log_output
24779   message_prefix =
24780   message_suffix =
24781
24782 # router
24783 local_user_cyrus:
24784   driver = accept
24785   check_local_user
24786   local_part_suffix = .*
24787   transport = local_delivery_cyrus
24788 .endd
24789 Note the unsetting of &%message_prefix%& and &%message_suffix%&, and the use of
24790 &%return_output%& to cause any text written by Cyrus to be returned to the
24791 sender.
24792 .ecindex IIDpiptra1
24793 .ecindex IIDpiptra2
24794
24795
24796 . ////////////////////////////////////////////////////////////////////////////
24797 . ////////////////////////////////////////////////////////////////////////////
24798
24799 .chapter "The smtp transport" "CHAPsmtptrans"
24800 .scindex IIDsmttra1 "transports" "&(smtp)&"
24801 .scindex IIDsmttra2 "&(smtp)& transport"
24802 The &(smtp)& transport delivers messages over TCP/IP connections using the SMTP
24803 or LMTP protocol. The list of hosts to try can either be taken from the address
24804 that is being processed (having been set up by the router), or specified
24805 explicitly for the transport. Timeout and retry processing (see chapter
24806 &<<CHAPretry>>&) is applied to each IP address independently.
24807
24808
24809 .section "Multiple messages on a single connection" "SECID144"
24810 The sending of multiple messages over a single TCP/IP connection can arise in
24811 two ways:
24812
24813 .ilist
24814 If a message contains more than &%max_rcpt%& (see below) addresses that are
24815 routed to the same host, more than one copy of the message has to be sent to
24816 that host. In this situation, multiple copies may be sent in a single run of
24817 the &(smtp)& transport over a single TCP/IP connection. (What Exim actually
24818 does when it has too many addresses to send in one message also depends on the
24819 value of the global &%remote_max_parallel%& option. Details are given in
24820 section &<<SECToutSMTPTCP>>&.)
24821 .next
24822 .cindex "hints database" "remembering routing"
24823 When a message has been successfully delivered over a TCP/IP connection, Exim
24824 looks in its hints database to see if there are any other messages awaiting a
24825 connection to the same host. If there are, a new delivery process is started
24826 for one of them, and the current TCP/IP connection is passed on to it. The new
24827 process may in turn send multiple copies and possibly create yet another
24828 process.
24829 .endlist
24830
24831
24832 For each copy sent over the same TCP/IP connection, a sequence counter is
24833 incremented, and if it ever gets to the value of &%connection_max_messages%&,
24834 no further messages are sent over that connection.
24835
24836
24837
24838 .section "Use of the $host and $host_address variables" "SECID145"
24839 .vindex "&$host$&"
24840 .vindex "&$host_address$&"
24841 At the start of a run of the &(smtp)& transport, the values of &$host$& and
24842 &$host_address$& are the name and IP address of the first host on the host list
24843 passed by the router. However, when the transport is about to connect to a
24844 specific host, and while it is connected to that host, &$host$& and
24845 &$host_address$& are set to the values for that host. These are the values
24846 that are in force when the &%helo_data%&, &%hosts_try_auth%&, &%interface%&,
24847 &%serialize_hosts%&, and the various TLS options are expanded.
24848
24849
24850 .section "Use of $tls_cipher and $tls_peerdn" "usecippeer"
24851 .vindex &$tls_bits$&
24852 .vindex &$tls_cipher$&
24853 .vindex &$tls_peerdn$&
24854 .vindex &$tls_sni$&
24855 At the start of a run of the &(smtp)& transport, the values of &$tls_bits$&,
24856 &$tls_cipher$&, &$tls_peerdn$& and &$tls_sni$&
24857 are the values that were set when the message was received.
24858 These are the values that are used for options that are expanded before any
24859 SMTP connections are made. Just before each connection is made, these four
24860 variables are emptied. If TLS is subsequently started, they are set to the
24861 appropriate values for the outgoing connection, and these are the values that
24862 are in force when any authenticators are run and when the
24863 &%authenticated_sender%& option is expanded.
24864
24865 These variables are deprecated in favour of &$tls_in_cipher$& et. al.
24866 and will be removed in a future release.
24867
24868
24869 .section "Private options for smtp" "SECID146"
24870 .cindex "options" "&(smtp)& transport"
24871 The private options of the &(smtp)& transport are as follows:
24872
24873
24874 .option address_retry_include_sender smtp boolean true
24875 .cindex "4&'xx'& responses" "retrying after"
24876 When an address is delayed because of a 4&'xx'& response to a RCPT command, it
24877 is the combination of sender and recipient that is delayed in subsequent queue
24878 runs until the retry time is reached. You can delay the recipient without
24879 reference to the sender (which is what earlier versions of Exim did), by
24880 setting &%address_retry_include_sender%& false. However, this can lead to
24881 problems with servers that regularly issue 4&'xx'& responses to RCPT commands.
24882
24883 .option allow_localhost smtp boolean false
24884 .cindex "local host" "sending to"
24885 .cindex "fallback" "hosts specified on transport"
24886 When a host specified in &%hosts%& or &%fallback_hosts%& (see below) turns out
24887 to be the local host, or is listed in &%hosts_treat_as_local%&, delivery is
24888 deferred by default. However, if &%allow_localhost%& is set, Exim goes on to do
24889 the delivery anyway. This should be used only in special cases when the
24890 configuration ensures that no looping will result (for example, a differently
24891 configured Exim is listening on the port to which the message is sent).
24892
24893
24894 .option authenticated_sender smtp string&!! unset
24895 .cindex "Cyrus"
24896 When Exim has authenticated as a client, or if &%authenticated_sender_force%&
24897 is true, this option sets a value for the AUTH= item on outgoing MAIL commands,
24898 overriding any existing authenticated sender value. If the string expansion is
24899 forced to fail, the option is ignored. Other expansion failures cause delivery
24900 to be deferred. If the result of expansion is an empty string, that is also
24901 ignored.
24902
24903 The expansion happens after the outgoing connection has been made and TLS
24904 started, if required. This means that the &$host$&, &$host_address$&,
24905 &$tls_out_cipher$&, and &$tls_out_peerdn$& variables are set according to the
24906 particular connection.
24907
24908 If the SMTP session is not authenticated, the expansion of
24909 &%authenticated_sender%& still happens (and can cause the delivery to be
24910 deferred if it fails), but no AUTH= item is added to MAIL commands
24911 unless &%authenticated_sender_force%& is true.
24912
24913 This option allows you to use the &(smtp)& transport in LMTP mode to
24914 deliver mail to Cyrus IMAP and provide the proper local part as the
24915 &"authenticated sender"&, via a setting such as:
24916 .code
24917 authenticated_sender = $local_part
24918 .endd
24919 This removes the need for IMAP subfolders to be assigned special ACLs to
24920 allow direct delivery to those subfolders.
24921
24922 Because of expected uses such as that just described for Cyrus (when no
24923 domain is involved), there is no checking on the syntax of the provided
24924 value.
24925
24926
24927 .option authenticated_sender_force smtp boolean false
24928 If this option is set true, the &%authenticated_sender%& option's value
24929 is used for the AUTH= item on outgoing MAIL commands, even if Exim has not
24930 authenticated as a client.
24931
24932
24933 .option command_timeout smtp time 5m
24934 This sets a timeout for receiving a response to an SMTP command that has been
24935 sent out. It is also used when waiting for the initial banner line from the
24936 remote host. Its value must not be zero.
24937
24938
24939 .option connect_timeout smtp time 5m
24940 This sets a timeout for the &[connect()]& function, which sets up a TCP/IP call
24941 to a remote host. A setting of zero allows the system timeout (typically
24942 several minutes) to act. To have any effect, the value of this option must be
24943 less than the system timeout. However, it has been observed that on some
24944 systems there is no system timeout, which is why the default value for this
24945 option is 5 minutes, a value recommended by RFC 1123.
24946
24947
24948 .option connection_max_messages smtp integer 500
24949 .cindex "SMTP" "passed connection"
24950 .cindex "SMTP" "multiple deliveries"
24951 .cindex "multiple SMTP deliveries"
24952 This controls the maximum number of separate message deliveries that are sent
24953 over a single TCP/IP connection. If the value is zero, there is no limit.
24954 For testing purposes, this value can be overridden by the &%-oB%& command line
24955 option.
24956
24957
24958 .option dane_require_tls_ciphers smtp string&!! unset
24959 .cindex "TLS" "requiring specific ciphers for DANE"
24960 .cindex "cipher" "requiring specific"
24961 .cindex DANE "TLS ciphers"
24962 This option may be used to override &%tls_require_ciphers%& for connections
24963 where DANE has been determined to be in effect.
24964 If not set, then &%tls_require_ciphers%& will be used.
24965 Normal SMTP delivery is not able to make strong demands of TLS cipher
24966 configuration, because delivery will fall back to plaintext.  Once DANE has
24967 been determined to be in effect, there is no plaintext fallback and making the
24968 TLS cipherlist configuration stronger will increase security, rather than
24969 counter-intuitively decreasing it.
24970 If the option expands to be empty or is forced to fail, then it will
24971 be treated as unset and &%tls_require_ciphers%& will be used instead.
24972
24973
24974 .option data_timeout smtp time 5m
24975 This sets a timeout for the transmission of each block in the data portion of
24976 the message. As a result, the overall timeout for a message depends on the size
24977 of the message. Its value must not be zero. See also &%final_timeout%&.
24978
24979
24980 .option dkim_canon smtp string&!! unset
24981 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
24982 .option dkim_domain smtp string list&!! unset
24983 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
24984 .option dkim_hash smtp string&!! sha256
24985 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
24986 .option dkim_identity smtp string&!! unset
24987 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
24988 .option dkim_private_key smtp string&!! unset
24989 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
24990 .option dkim_selector smtp string&!! unset
24991 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
24992 .option dkim_strict smtp string&!! unset
24993 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
24994 .option dkim_sign_headers smtp string&!! "per RFC"
24995 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
24996 .option dkim_timestamps smtp string&!! unset
24997 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
24998
24999
25000 .option delay_after_cutoff smtp boolean true
25001 .cindex "final cutoff" "retries, controlling"
25002 .cindex retry "final cutoff"
25003 This option controls what happens when all remote IP addresses for a given
25004 domain have been inaccessible for so long that they have passed their retry
25005 cutoff times.
25006
25007 In the default state, if the next retry time has not been reached for any of
25008 them, the address is bounced without trying any deliveries. In other words,
25009 Exim delays retrying an IP address after the final cutoff time until a new
25010 retry time is reached, and can therefore bounce an address without ever trying
25011 a delivery, when machines have been down for a long time. Some people are
25012 unhappy at this prospect, so...
25013
25014 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
25015 addresses are past their final cutoff time, Exim tries to deliver to those
25016 IP addresses that have not been tried since the message arrived. If there are
25017 none, of if they all fail, the address is bounced. In other words, it does not
25018 delay when a new message arrives, but immediately tries those expired IP
25019 addresses that haven't been tried since the message arrived. If there is a
25020 continuous stream of messages for the dead hosts, unsetting
25021 &%delay_after_cutoff%& means that there will be many more attempts to deliver
25022 to them.
25023
25024
25025 .option dns_qualify_single smtp boolean true
25026 If the &%hosts%& or &%fallback_hosts%& option is being used,
25027 and the &%gethostbyname%& option is false,
25028 the RES_DEFNAMES resolver option is set. See the &%qualify_single%& option
25029 in chapter &<<CHAPdnslookup>>& for more details.
25030
25031
25032 .option dns_search_parents smtp boolean false
25033 If the &%hosts%& or &%fallback_hosts%& option is being used, and the
25034 &%gethostbyname%& option is false, the RES_DNSRCH resolver option is set.
25035 See the &%search_parents%& option in chapter &<<CHAPdnslookup>>& for more
25036 details.
25037
25038
25039 .option dnssec_request_domains smtp "domain list&!!" *
25040 .cindex "MX record" "security"
25041 .cindex "DNSSEC" "MX lookup"
25042 .cindex "security" "MX lookup"
25043 .cindex "DNS" "DNSSEC"
25044 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
25045 the dnssec request bit set. Setting this transport option is only useful if the
25046 transport overrides or sets the host names. See the &%dnssec_request_domains%&
25047 router option.
25048
25049
25050
25051 .option dnssec_require_domains smtp "domain list&!!" unset
25052 .cindex "MX record" "security"
25053 .cindex "DNSSEC" "MX lookup"
25054 .cindex "security" "MX lookup"
25055 .cindex "DNS" "DNSSEC"
25056 DNS lookups for domains matching &%dnssec_require_domains%& will be done with
25057 the dnssec request bit set.  Setting this transport option is only
25058 useful if the transport overrides or sets the host names. See the
25059 &%dnssec_require_domains%& router option.
25060
25061
25062
25063 .option dscp smtp string&!! unset
25064 .cindex "DCSP" "outbound"
25065 This option causes the DSCP value associated with a socket to be set to one
25066 of a number of fixed strings or to numeric value.
25067 The &%-bI:dscp%& option may be used to ask Exim which names it knows of.
25068 Common values include &`throughput`&, &`mincost`&, and on newer systems
25069 &`ef`&, &`af41`&, etc.  Numeric values may be in the range 0 to 0x3F.
25070
25071 The outbound packets from Exim will be marked with this value in the header
25072 (for IPv4, the TOS field; for IPv6, the TCLASS field); there is no guarantee
25073 that these values will have any effect, not be stripped by networking
25074 equipment, or do much of anything without cooperation with your Network
25075 Engineer and those of all network operators between the source and destination.
25076
25077
25078 .option fallback_hosts smtp "string list" unset
25079 .cindex "fallback" "hosts specified on transport"
25080 String expansion is not applied to this option. The argument must be a
25081 colon-separated list of host names or IP addresses, optionally also including
25082 port numbers, though the separator can be changed, as described in section
25083 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
25084 item in a &%route_list%& setting for the &(manualroute)& router, as described
25085 in section &<<SECTformatonehostitem>>&.
25086
25087 Fallback hosts can also be specified on routers, which associate them with the
25088 addresses they process. As for the &%hosts%& option without &%hosts_override%&,
25089 &%fallback_hosts%& specified on the transport is used only if the address does
25090 not have its own associated fallback host list. Unlike &%hosts%&, a setting of
25091 &%fallback_hosts%& on an address is not overridden by &%hosts_override%&.
25092 However, &%hosts_randomize%& does apply to fallback host lists.
25093
25094 If Exim is unable to deliver to any of the hosts for a particular address, and
25095 the errors are not permanent rejections, the address is put on a separate
25096 transport queue with its host list replaced by the fallback hosts, unless the
25097 address was routed via MX records and the current host was in the original MX
25098 list. In that situation, the fallback host list is not used.
25099
25100 Once normal deliveries are complete, the fallback queue is delivered by
25101 re-running the same transports with the new host lists. If several failing
25102 addresses have the same fallback hosts (and &%max_rcpt%& permits it), a single
25103 copy of the message is sent.
25104
25105 The resolution of the host names on the fallback list is controlled by the
25106 &%gethostbyname%& option, as for the &%hosts%& option. Fallback hosts apply
25107 both to cases when the host list comes with the address and when it is taken
25108 from &%hosts%&. This option provides a &"use a smart host only if delivery
25109 fails"& facility.
25110
25111
25112 .option final_timeout smtp time 10m
25113 This is the timeout that applies while waiting for the response to the final
25114 line containing just &"."& that terminates a message. Its value must not be
25115 zero.
25116
25117 .option gethostbyname smtp boolean false
25118 If this option is true when the &%hosts%& and/or &%fallback_hosts%& options are
25119 being used, names are looked up using &[gethostbyname()]&
25120 (or &[getipnodebyname()]& when available)
25121 instead of using the DNS. Of course, that function may in fact use the DNS, but
25122 it may also consult other sources of information such as &_/etc/hosts_&.
25123
25124 .option gnutls_compat_mode smtp boolean unset
25125 This option controls whether GnuTLS is used in compatibility mode in an Exim
25126 server. This reduces security slightly, but improves interworking with older
25127 implementations of TLS.
25128
25129 .option helo_data smtp string&!! "see below"
25130 .cindex "HELO" "argument, setting"
25131 .cindex "EHLO" "argument, setting"
25132 .cindex "LHLO argument setting"
25133 The value of this option is expanded after a connection to a another host has
25134 been set up. The result is used as the argument for the EHLO, HELO, or LHLO
25135 command that starts the outgoing SMTP or LMTP session. The default value of the
25136 option is:
25137 .code
25138 $primary_hostname
25139 .endd
25140 During the expansion, the variables &$host$& and &$host_address$& are set to
25141 the identity of the remote host, and the variables &$sending_ip_address$& and
25142 &$sending_port$& are set to the local IP address and port number that are being
25143 used. These variables can be used to generate different values for different
25144 servers or different local IP addresses. For example, if you want the string
25145 that is used for &%helo_data%& to be obtained by a DNS lookup of the outgoing
25146 interface address, you could use this:
25147 .code
25148 helo_data = ${lookup dnsdb{ptr=$sending_ip_address}{$value}\
25149   {$primary_hostname}}
25150 .endd
25151 The use of &%helo_data%& applies both to sending messages and when doing
25152 callouts.
25153
25154 .option hosts smtp "string list&!!" unset
25155 Hosts are associated with an address by a router such as &(dnslookup)&, which
25156 finds the hosts by looking up the address domain in the DNS, or by
25157 &(manualroute)&, which has lists of hosts in its configuration. However,
25158 email addresses can be passed to the &(smtp)& transport by any router, and not
25159 all of them can provide an associated list of hosts.
25160
25161 The &%hosts%& option specifies a list of hosts to be used if the address being
25162 processed does not have any hosts associated with it. The hosts specified by
25163 &%hosts%& are also used, whether or not the address has its own hosts, if
25164 &%hosts_override%& is set.
25165
25166 The string is first expanded, before being interpreted as a colon-separated
25167 list of host names or IP addresses, possibly including port numbers. The
25168 separator may be changed to something other than colon, as described in section
25169 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
25170 item in a &%route_list%& setting for the &(manualroute)& router, as described
25171 in section &<<SECTformatonehostitem>>&. However, note that the &`/MX`& facility
25172 of the &(manualroute)& router is not available here.
25173
25174 If the expansion fails, delivery is deferred. Unless the failure was caused by
25175 the inability to complete a lookup, the error is logged to the panic log as
25176 well as the main log. Host names are looked up either by searching directly for
25177 address records in the DNS or by calling &[gethostbyname()]& (or
25178 &[getipnodebyname()]& when available), depending on the setting of the
25179 &%gethostbyname%& option. When Exim is compiled with IPv6 support, if a host
25180 that is looked up in the DNS has both IPv4 and IPv6 addresses, both types of
25181 address are used.
25182
25183 During delivery, the hosts are tried in order, subject to their retry status,
25184 unless &%hosts_randomize%& is set.
25185
25186
25187 .option hosts_avoid_esmtp smtp "host list&!!" unset
25188 .cindex "ESMTP, avoiding use of"
25189 .cindex "HELO" "forcing use of"
25190 .cindex "EHLO" "avoiding use of"
25191 .cindex "PIPELINING" "avoiding the use of"
25192 This option is for use with broken hosts that announce ESMTP facilities (for
25193 example, PIPELINING) and then fail to implement them properly. When a host
25194 matches &%hosts_avoid_esmtp%&, Exim sends HELO rather than EHLO at the
25195 start of the SMTP session. This means that it cannot use any of the ESMTP
25196 facilities such as AUTH, PIPELINING, SIZE, and STARTTLS.
25197
25198
25199 .option hosts_avoid_pipelining smtp "host list&!!" unset
25200 .cindex "PIPELINING" "avoiding the use of"
25201 .cindex "ESMTP extensions" PIPELINING
25202 Exim will not use the ESMTP PIPELINING extension when delivering to any host
25203 that matches this list, even if the server host advertises PIPELINING support.
25204
25205 .option hosts_pipe_connect smtp "host list&!!" unset
25206 .cindex "pipelining" "early connection"
25207 .cindex "pipelining" PIPE_CONNECT
25208 If Exim is built with the SUPPORT_PIPE_CONNECT build option
25209 this option controls which to hosts the facility watched for
25210 and recorded, and used for subsequent connections.
25211
25212 The retry hints database is used for the record,
25213 and records are subject to the &%retry_data_expire%& option.
25214 When used, the pipelining saves on roundtrip times.
25215 It also turns SMTP into a client-first protocol
25216 so combines well with TCP Fast Open.
25217
25218 See also the &%pipelining_connect_advertise_hosts%& main option.
25219
25220 Note:
25221 When the facility is used, the transport &%helo_data%& option
25222 will be expanded before the &$sending_ip_address$& variable
25223 is filled in.
25224 A check is made for the use of that variable, without the
25225 presence of a &"def:"& test on it, but suitably complex coding
25226 can avoid the check and produce unexpected results.
25227 You have been warned.
25228
25229
25230 .option hosts_avoid_tls smtp "host list&!!" unset
25231 .cindex "TLS" "avoiding for certain hosts"
25232 Exim will not try to start a TLS session when delivering to any host that
25233 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
25234
25235 .option hosts_verify_avoid_tls smtp "host list&!!" unset
25236 .cindex "TLS" "avoiding for certain hosts"
25237 Exim will not try to start a TLS session for a verify callout,
25238 or when delivering in cutthrough mode,
25239 to any host that matches this list.
25240
25241
25242 .option hosts_max_try smtp integer 5
25243 .cindex "host" "maximum number to try"
25244 .cindex "limit" "number of hosts tried"
25245 .cindex "limit" "number of MX tried"
25246 .cindex "MX record" "maximum tried"
25247 This option limits the number of IP addresses that are tried for any one
25248 delivery in cases where there are temporary delivery errors. Section
25249 &<<SECTvalhosmax>>& describes in detail how the value of this option is used.
25250
25251
25252 .option hosts_max_try_hardlimit smtp integer 50
25253 This is an additional check on the maximum number of IP addresses that Exim
25254 tries for any one delivery. Section &<<SECTvalhosmax>>& describes its use and
25255 why it exists.
25256
25257
25258
25259 .option hosts_nopass_tls smtp "host list&!!" unset
25260 .cindex "TLS" "passing connection"
25261 .cindex "multiple SMTP deliveries"
25262 .cindex "TLS" "multiple message deliveries"
25263 For any host that matches this list, a connection on which a TLS session has
25264 been started will not be passed to a new delivery process for sending another
25265 message on the same connection. See section &<<SECTmulmessam>>& for an
25266 explanation of when this might be needed.
25267
25268 .option hosts_noproxy_tls smtp "host list&!!" unset
25269 .cindex "TLS" "passing connection"
25270 .cindex "multiple SMTP deliveries"
25271 .cindex "TLS" "multiple message deliveries"
25272 For any host that matches this list, a TLS session which has
25273 been started will not be passed to a new delivery process for sending another
25274 message on the same session.
25275
25276 The traditional implementation closes down TLS and re-starts it in the new
25277 process, on the same open TCP connection, for each successive message
25278 sent.  If permitted by this option a pipe to to the new process is set up
25279 instead, and the original process maintains the TLS connection and proxies
25280 the SMTP connection from and to the new process and any subsequents.
25281 The new process has no access to TLS information, so cannot include it in
25282 logging.
25283
25284
25285
25286 .option hosts_override smtp boolean false
25287 If this option is set and the &%hosts%& option is also set, any hosts that are
25288 attached to the address are ignored, and instead the hosts specified by the
25289 &%hosts%& option are always used. This option does not apply to
25290 &%fallback_hosts%&.
25291
25292
25293 .option hosts_randomize smtp boolean false
25294 .cindex "randomized host list"
25295 .cindex "host" "list of; randomized"
25296 .cindex "fallback" "randomized hosts"
25297 If this option is set, and either the list of hosts is taken from the
25298 &%hosts%& or the &%fallback_hosts%& option, or the hosts supplied by the router
25299 were not obtained from MX records (this includes fallback hosts from the
25300 router), and were not randomized by the router, the order of trying the hosts
25301 is randomized each time the transport runs. Randomizing the order of a host
25302 list can be used to do crude load sharing.
25303
25304 When &%hosts_randomize%& is true, a host list may be split into groups whose
25305 order is separately randomized. This makes it possible to set up MX-like
25306 behaviour. The boundaries between groups are indicated by an item that is just
25307 &`+`& in the host list. For example:
25308 .code
25309 hosts = host1:host2:host3:+:host4:host5
25310 .endd
25311 The order of the first three hosts and the order of the last two hosts is
25312 randomized for each use, but the first three always end up before the last two.
25313 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored.
25314
25315 .option hosts_require_auth smtp "host list&!!" unset
25316 .cindex "authentication" "required by client"
25317 This option provides a list of servers for which authentication must succeed
25318 before Exim will try to transfer a message. If authentication fails for
25319 servers which are not in this list, Exim tries to send unauthenticated. If
25320 authentication fails for one of these servers, delivery is deferred. This
25321 temporary error is detectable in the retry rules, so it can be turned into a
25322 hard failure if required. See also &%hosts_try_auth%&, and chapter
25323 &<<CHAPSMTPAUTH>>& for details of authentication.
25324
25325
25326 .option hosts_request_ocsp smtp "host list&!!" *
25327 .cindex "TLS" "requiring for certain servers"
25328 Exim will request a Certificate Status on a
25329 TLS session for any host that matches this list.
25330 &%tls_verify_certificates%& should also be set for the transport.
25331
25332 .option hosts_require_dane smtp "host list&!!" unset
25333 .cindex DANE "transport options"
25334 .cindex DANE "requiring for certain servers"
25335 If built with DANE support, Exim  will require that a DNSSEC-validated
25336 TLSA record is present for any host matching the list,
25337 and that a DANE-verified TLS connection is made. See
25338 the &%dnssec_request_domains%& router and transport options.
25339 There will be no fallback to in-clear communication.
25340 See section &<<SECDANE>>&.
25341
25342 .option hosts_require_ocsp smtp "host list&!!" unset
25343 .cindex "TLS" "requiring for certain servers"
25344 Exim will request, and check for a valid Certificate Status being given, on a
25345 TLS session for any host that matches this list.
25346 &%tls_verify_certificates%& should also be set for the transport.
25347
25348 .option hosts_require_tls smtp "host list&!!" unset
25349 .cindex "TLS" "requiring for certain servers"
25350 Exim will insist on using a TLS session when delivering to any host that
25351 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
25352 &*Note*&: This option affects outgoing mail only. To insist on TLS for
25353 incoming messages, use an appropriate ACL.
25354
25355 .option hosts_try_auth smtp "host list&!!" unset
25356 .cindex "authentication" "optional in client"
25357 This option provides a list of servers to which, provided they announce
25358 authentication support, Exim will attempt to authenticate as a client when it
25359 connects. If authentication fails, Exim will try to transfer the message
25360 unauthenticated. See also &%hosts_require_auth%&, and chapter
25361 &<<CHAPSMTPAUTH>>& for details of authentication.
25362
25363 .option hosts_try_chunking smtp "host list&!!" *
25364 .cindex CHUNKING "enabling, in client"
25365 .cindex BDAT "SMTP command"
25366 .cindex "RFC 3030" "CHUNKING"
25367 This option provides a list of servers to which, provided they announce
25368 CHUNKING support, Exim will attempt to use BDAT commands rather than DATA.
25369 .new
25370 Unless DKIM signing is being done,
25371 .wen
25372 BDAT will not be used in conjunction with a transport filter.
25373
25374 .option hosts_try_dane smtp "host list&!!" *
25375 .cindex DANE "transport options"
25376 .cindex DANE "attempting for certain servers"
25377 If built with DANE support, Exim  will require that a DNSSEC-validated
25378 TLSA record is present for any host matching the list,
25379 and that a DANE-verified TLS connection is made. See
25380 the &%dnssec_request_domains%& router and transport options.
25381 There will be no fallback to in-clear communication.
25382 See section &<<SECDANE>>&.
25383
25384 .option hosts_try_fastopen smtp "host list&!!" *
25385 .cindex "fast open, TCP" "enabling, in client"
25386 .cindex "TCP Fast Open" "enabling, in client"
25387 .cindex "RFC 7413" "TCP Fast Open"
25388 This option provides a list of servers to which, provided
25389 the facility is supported by this system, Exim will attempt to
25390 perform a TCP Fast Open.
25391 No data is sent on the SYN segment but, if the remote server also
25392 supports the facility, it can send its SMTP banner immediately after
25393 the SYN,ACK segment.  This can save up to one round-trip time.
25394
25395 The facility is only active for previously-contacted servers,
25396 as the initiator must present a cookie in the SYN segment.
25397
25398 On (at least some) current Linux distributions the facility must be enabled
25399 in the kernel by the sysadmin before the support is usable.
25400 There is no option for control of the server side; if the system supports
25401 it it is always enabled.  Note that lengthy operations in the connect ACL,
25402 such as DNSBL lookups, will still delay the emission of the SMTP banner.
25403
25404 .option hosts_try_prdr smtp "host list&!!" *
25405 .cindex "PRDR" "enabling, optional in client"
25406 .cindex "ESMTP extensions" PRDR
25407 This option provides a list of servers to which, provided they announce
25408 PRDR support, Exim will attempt to negotiate PRDR
25409 for multi-recipient messages.
25410 The option can usually be left as default.
25411
25412 .option interface smtp "string list&!!" unset
25413 .cindex "bind IP address"
25414 .cindex "IP address" "binding"
25415 .vindex "&$host$&"
25416 .vindex "&$host_address$&"
25417 This option specifies which interface to bind to when making an outgoing SMTP
25418 call. The value is an IP address, not an interface name such as
25419 &`eth0`&. Do not confuse this with the interface address that was used when a
25420 message was received, which is in &$received_ip_address$&, formerly known as
25421 &$interface_address$&. The name was changed to minimize confusion with the
25422 outgoing interface address. There is no variable that contains an outgoing
25423 interface address because, unless it is set by this option, its value is
25424 unknown.
25425
25426 During the expansion of the &%interface%& option the variables &$host$& and
25427 &$host_address$& refer to the host to which a connection is about to be made
25428 during the expansion of the string. Forced expansion failure, or an empty
25429 string result causes the option to be ignored. Otherwise, after expansion, the
25430 string must be a list of IP addresses, colon-separated by default, but the
25431 separator can be changed in the usual way (&<<SECTlistsepchange>>&).
25432 For example:
25433 .code
25434 interface = <; 192.168.123.123 ; 3ffe:ffff:836f::fe86:a061
25435 .endd
25436 The first interface of the correct type (IPv4 or IPv6) is used for the outgoing
25437 connection. If none of them are the correct type, the option is ignored. If
25438 &%interface%& is not set, or is ignored, the system's IP functions choose which
25439 interface to use if the host has more than one.
25440
25441
25442 .option keepalive smtp boolean true
25443 .cindex "keepalive" "on outgoing connection"
25444 This option controls the setting of SO_KEEPALIVE on outgoing TCP/IP socket
25445 connections. When set, it causes the kernel to probe idle connections
25446 periodically, by sending packets with &"old"& sequence numbers. The other end
25447 of the connection should send a acknowledgment if the connection is still okay
25448 or a reset if the connection has been aborted. The reason for doing this is
25449 that it has the beneficial effect of freeing up certain types of connection
25450 that can get stuck when the remote host is disconnected without tidying up the
25451 TCP/IP call properly. The keepalive mechanism takes several hours to detect
25452 unreachable hosts.
25453
25454
25455 .option lmtp_ignore_quota smtp boolean false
25456 .cindex "LMTP" "ignoring quota errors"
25457 If this option is set true when the &%protocol%& option is set to &"lmtp"&, the
25458 string &`IGNOREQUOTA`& is added to RCPT commands, provided that the LMTP server
25459 has advertised support for IGNOREQUOTA in its response to the LHLO command.
25460
25461 .option max_rcpt smtp integer 100
25462 .cindex "RCPT" "maximum number of outgoing"
25463 This option limits the number of RCPT commands that are sent in a single
25464 SMTP message transaction. Each set of addresses is treated independently, and
25465 so can cause parallel connections to the same host if &%remote_max_parallel%&
25466 permits this.
25467
25468
25469 .option multi_domain smtp boolean&!! true
25470 .vindex "&$domain$&"
25471 When this option is set, the &(smtp)& transport can handle a number of
25472 addresses containing a mixture of different domains provided they all resolve
25473 to the same list of hosts. Turning the option off restricts the transport to
25474 handling only one domain at a time. This is useful if you want to use
25475 &$domain$& in an expansion for the transport, because it is set only when there
25476 is a single domain involved in a remote delivery.
25477
25478 It is expanded per-address and can depend on any of
25479 &$address_data$&, &$domain_data$&, &$local_part_data$&,
25480 &$host$&, &$host_address$& and &$host_port$&.
25481
25482 .option port smtp string&!! "see below"
25483 .cindex "port" "sending TCP/IP"
25484 .cindex "TCP/IP" "setting outgoing port"
25485 This option specifies the TCP/IP port on the server to which Exim connects.
25486 &*Note:*& Do not confuse this with the port that was used when a message was
25487 received, which is in &$received_port$&, formerly known as &$interface_port$&.
25488 The name was changed to minimize confusion with the outgoing port. There is no
25489 variable that contains an outgoing port.
25490
25491 If the value of this option begins with a digit it is taken as a port number;
25492 otherwise it is looked up using &[getservbyname()]&. The default value is
25493 normally &"smtp"&,
25494 but if &%protocol%& is set to &"lmtp"& the default is &"lmtp"&
25495 and if &%protocol%& is set to &"smtps"& the default is &"smtps"&.
25496 If the expansion fails, or if a port number cannot be found, delivery
25497 is deferred.
25498
25499 Note that at least one Linux distribution has been seen failing
25500 to put &"smtps"& in its &"/etc/services"& file, resulting is such deferrals.
25501
25502
25503
25504 .option protocol smtp string smtp
25505 .cindex "LMTP" "over TCP/IP"
25506 .cindex "ssmtp protocol" "outbound"
25507 .cindex "TLS" "SSL-on-connect outbound"
25508 .vindex "&$port$&"
25509 If this option is set to &"lmtp"& instead of &"smtp"&, the default value for
25510 the &%port%& option changes to &"lmtp"&, and the transport operates the LMTP
25511 protocol (RFC 2033) instead of SMTP. This protocol is sometimes used for local
25512 deliveries into closed message stores. Exim also has support for running LMTP
25513 over a pipe to a local process &-- see chapter &<<CHAPLMTP>>&.
25514
25515 If this option is set to &"smtps"&, the default value for the &%port%& option
25516 changes to &"smtps"&, and the transport initiates TLS immediately after
25517 connecting, as an outbound SSL-on-connect, instead of using STARTTLS to upgrade.
25518 The Internet standards bodies used to strongly discourage use of this mode,
25519 but as of RFC 8314 it is perferred over STARTTLS for message submission
25520 (as distinct from MTA-MTA communication).
25521
25522
25523 .option retry_include_ip_address smtp boolean&!! true
25524 Exim normally includes both the host name and the IP address in the key it
25525 constructs for indexing retry data after a temporary delivery failure. This
25526 means that when one of several IP addresses for a host is failing, it gets
25527 tried periodically (controlled by the retry rules), but use of the other IP
25528 addresses is not affected.
25529
25530 However, in some dialup environments hosts are assigned a different IP address
25531 each time they connect. In this situation the use of the IP address as part of
25532 the retry key leads to undesirable behaviour. Setting this option false causes
25533 Exim to use only the host name.
25534 Since it is expanded it can be made to depend on the host or domain.
25535
25536
25537 .option serialize_hosts smtp "host list&!!" unset
25538 .cindex "serializing connections"
25539 .cindex "host" "serializing connections"
25540 Because Exim operates in a distributed manner, if several messages for the same
25541 host arrive at around the same time, more than one simultaneous connection to
25542 the remote host can occur. This is not usually a problem except when there is a
25543 slow link between the hosts. In that situation it may be helpful to restrict
25544 Exim to one connection at a time. This can be done by setting
25545 &%serialize_hosts%& to match the relevant hosts.
25546
25547 .cindex "hints database" "serializing deliveries to a host"
25548 Exim implements serialization by means of a hints database in which a record is
25549 written whenever a process connects to one of the restricted hosts. The record
25550 is deleted when the connection is completed. Obviously there is scope for
25551 records to get left lying around if there is a system or program crash. To
25552 guard against this, Exim ignores any records that are more than six hours old.
25553
25554 If you set up this kind of serialization, you should also arrange to delete the
25555 relevant hints database whenever your system reboots. The names of the files
25556 start with &_misc_& and they are kept in the &_spool/db_& directory. There
25557 may be one or two files, depending on the type of DBM in use. The same files
25558 are used for ETRN serialization.
25559
25560 See also the &%max_parallel%& generic transport option.
25561
25562
25563 .option size_addition smtp integer 1024
25564 .cindex "SIZE" "ESMTP extension"
25565 .cindex "message" "size issue for transport filter"
25566 .cindex "size" "of message"
25567 .cindex "transport" "filter"
25568 .cindex "filter" "transport filter"
25569 If a remote SMTP server indicates that it supports the SIZE option of the
25570 MAIL command, Exim uses this to pass over the message size at the start of
25571 an SMTP transaction. It adds the value of &%size_addition%& to the value it
25572 sends, to allow for headers and other text that may be added during delivery by
25573 configuration options or in a transport filter. It may be necessary to increase
25574 this if a lot of text is added to messages.
25575
25576 Alternatively, if the value of &%size_addition%& is set negative, it disables
25577 the use of the SIZE option altogether.
25578
25579
25580 .option socks_proxy smtp string&!! unset
25581 .cindex proxy SOCKS
25582 This option enables use of SOCKS proxies for connections made by the
25583 transport.  For details see section &<<SECTproxySOCKS>>&.
25584
25585
25586 .option tls_certificate smtp string&!! unset
25587 .cindex "TLS" "client certificate, location of"
25588 .cindex "certificate" "client, location of"
25589 .vindex "&$host$&"
25590 .vindex "&$host_address$&"
25591 The value of this option must be the absolute path to a file which contains the
25592 client's certificate, for possible use when sending a message over an encrypted
25593 connection. The values of &$host$& and &$host_address$& are set to the name and
25594 address of the server during the expansion. See chapter &<<CHAPTLS>>& for
25595 details of TLS.
25596
25597 &*Note*&: This option must be set if you want Exim to be able to use a TLS
25598 certificate when sending messages as a client. The global option of the same
25599 name specifies the certificate for Exim as a server; it is not automatically
25600 assumed that the same certificate should be used when Exim is operating as a
25601 client.
25602
25603
25604 .option tls_crl smtp string&!! unset
25605 .cindex "TLS" "client certificate revocation list"
25606 .cindex "certificate" "revocation list for client"
25607 This option specifies a certificate revocation list. The expanded value must
25608 be the name of a file that contains a CRL in PEM format.
25609
25610
25611 .option tls_dh_min_bits smtp integer 1024
25612 .cindex "TLS" "Diffie-Hellman minimum acceptable size"
25613 When establishing a TLS session, if a ciphersuite which uses Diffie-Hellman
25614 key agreement is negotiated, the server will provide a large prime number
25615 for use.  This option establishes the minimum acceptable size of that number.
25616 If the parameter offered by the server is too small, then the TLS handshake
25617 will fail.
25618
25619 Only supported when using GnuTLS.
25620
25621
25622 .option tls_privatekey smtp string&!! unset
25623 .cindex "TLS" "client private key, location of"
25624 .vindex "&$host$&"
25625 .vindex "&$host_address$&"
25626 The value of this option must be the absolute path to a file which contains the
25627 client's private key. This is used when sending a message over an encrypted
25628 connection using a client certificate. The values of &$host$& and
25629 &$host_address$& are set to the name and address of the server during the
25630 expansion. If this option is unset, or the expansion is forced to fail, or the
25631 result is an empty string, the private key is assumed to be in the same file as
25632 the certificate. See chapter &<<CHAPTLS>>& for details of TLS.
25633
25634
25635 .option tls_require_ciphers smtp string&!! unset
25636 .cindex "TLS" "requiring specific ciphers"
25637 .cindex "cipher" "requiring specific"
25638 .vindex "&$host$&"
25639 .vindex "&$host_address$&"
25640 The value of this option must be a list of permitted cipher suites, for use
25641 when setting up an outgoing encrypted connection. (There is a global option of
25642 the same name for controlling incoming connections.) The values of &$host$& and
25643 &$host_address$& are set to the name and address of the server during the
25644 expansion. See chapter &<<CHAPTLS>>& for details of TLS; note that this option
25645 is used in different ways by OpenSSL and GnuTLS (see sections
25646 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&). For GnuTLS, the order of the
25647 ciphers is a preference order.
25648
25649
25650
25651 .option tls_sni smtp string&!! unset
25652 .cindex "TLS" "Server Name Indication"
25653 .vindex "&$tls_sni$&"
25654 If this option is set then it sets the $tls_out_sni variable and causes any
25655 TLS session to pass this value as the Server Name Indication extension to
25656 the remote side, which can be used by the remote side to select an appropriate
25657 certificate and private key for the session.
25658
25659 See &<<SECTtlssni>>& for more information.
25660
25661 Note that for OpenSSL, this feature requires a build of OpenSSL that supports
25662 TLS extensions.
25663
25664
25665
25666
25667 .option tls_tempfail_tryclear smtp boolean true
25668 .cindex "4&'xx'& responses" "to STARTTLS"
25669 When the server host is not in &%hosts_require_tls%&, and there is a problem in
25670 setting up a TLS session, this option determines whether or not Exim should try
25671 to deliver the message unencrypted. If it is set false, delivery to the
25672 current host is deferred; if there are other hosts, they are tried. If this
25673 option is set true, Exim attempts to deliver unencrypted after a 4&'xx'&
25674 response to STARTTLS. Also, if STARTTLS is accepted, but the subsequent
25675 TLS negotiation fails, Exim closes the current connection (because it is in an
25676 unknown state), opens a new one to the same host, and then tries the delivery
25677 in clear.
25678
25679
25680 .option tls_try_verify_hosts smtp "host list&!!" *
25681 .cindex "TLS" "server certificate verification"
25682 .cindex "certificate" "verification of server"
25683 This option gives a list of hosts for which, on encrypted connections,
25684 certificate verification will be tried but need not succeed.
25685 The &%tls_verify_certificates%& option must also be set.
25686 Note that unless the host is in this list
25687 TLS connections will be denied to hosts using self-signed certificates
25688 when &%tls_verify_certificates%& is matched.
25689 The &$tls_out_certificate_verified$& variable is set when
25690 certificate verification succeeds.
25691
25692
25693 .option tls_verify_cert_hostnames smtp "host list&!!" *
25694 .cindex "TLS" "server certificate hostname verification"
25695 .cindex "certificate" "verification of server"
25696 This option give a list of hosts for which,
25697 while verifying the server certificate,
25698 checks will be included on the host name
25699 (note that this will generally be the result of a DNS MX lookup)
25700 versus Subject and Subject-Alternate-Name fields.  Wildcard names are permitted
25701 limited to being the initial component of a 3-or-more component FQDN.
25702
25703 There is no equivalent checking on client certificates.
25704
25705
25706 .option tls_verify_certificates smtp string&!! system
25707 .cindex "TLS" "server certificate verification"
25708 .cindex "certificate" "verification of server"
25709 .vindex "&$host$&"
25710 .vindex "&$host_address$&"
25711 The value of this option must be either the
25712 word "system"
25713 or the absolute path to
25714 a file or directory containing permitted certificates for servers,
25715 for use when setting up an encrypted connection.
25716
25717 The "system" value for the option will use a location compiled into the SSL library.
25718 This is not available for GnuTLS versions preceding 3.0.20; a value of "system"
25719 is taken as empty and an explicit location
25720 must be specified.
25721
25722 The use of a directory for the option value is not available for GnuTLS versions
25723 preceding 3.3.6 and a single file must be used.
25724
25725 With OpenSSL the certificates specified
25726 explicitly
25727 either by file or directory
25728 are added to those given by the system default location.
25729
25730 The values of &$host$& and
25731 &$host_address$& are set to the name and address of the server during the
25732 expansion of this option. See chapter &<<CHAPTLS>>& for details of TLS.
25733
25734 For back-compatibility,
25735 if neither tls_verify_hosts nor tls_try_verify_hosts are set
25736 (a single-colon empty list counts as being set)
25737 and certificate verification fails the TLS connection is closed.
25738
25739
25740 .option tls_verify_hosts smtp "host list&!!" unset
25741 .cindex "TLS" "server certificate verification"
25742 .cindex "certificate" "verification of server"
25743 This option gives a list of hosts for which, on encrypted connections,
25744 certificate verification must succeed.
25745 The &%tls_verify_certificates%& option must also be set.
25746 If both this option and &%tls_try_verify_hosts%& are unset
25747 operation is as if this option selected all hosts.
25748
25749 .option utf8_downconvert smtp integer&!! -1
25750 .cindex utf8 "address downconversion"
25751 .cindex i18n "utf8 address downconversion"
25752 If built with internationalization support,
25753 this option controls conversion of UTF-8 in message envelope addresses
25754 to a-label form.
25755 If, after expansion, the value is 1, 0, or -1 then this value overrides
25756 any value previously set for the message.  Otherwise, any previously
25757 set value is used.  To permit use of a previous value,
25758 set this option to an empty string.
25759 For details on the values see section &<<SECTi18nMTA>>&.
25760
25761
25762
25763
25764 .section "How the limits for the number of hosts to try are used" &&&
25765          "SECTvalhosmax"
25766 .cindex "host" "maximum number to try"
25767 .cindex "limit" "hosts; maximum number tried"
25768 There are two options that are concerned with the number of hosts that are
25769 tried when an SMTP delivery takes place. They are &%hosts_max_try%& and
25770 &%hosts_max_try_hardlimit%&.
25771
25772
25773 The &%hosts_max_try%& option limits the number of hosts that are tried
25774 for a single delivery. However, despite the term &"host"& in its name, the
25775 option actually applies to each IP address independently. In other words, a
25776 multihomed host is treated as several independent hosts, just as it is for
25777 retrying.
25778
25779 Many of the larger ISPs have multiple MX records which often point to
25780 multihomed hosts. As a result, a list of a dozen or more IP addresses may be
25781 created as a result of routing one of these domains.
25782
25783 Trying every single IP address on such a long list does not seem sensible; if
25784 several at the top of the list fail, it is reasonable to assume there is some
25785 problem that is likely to affect all of them. Roughly speaking, the value of
25786 &%hosts_max_try%& is the maximum number that are tried before deferring the
25787 delivery. However, the logic cannot be quite that simple.
25788
25789 Firstly, IP addresses that are skipped because their retry times have not
25790 arrived do not count, and in addition, addresses that are past their retry
25791 limits are also not counted, even when they are tried. This means that when
25792 some IP addresses are past their retry limits, more than the value of
25793 &%hosts_max_retry%& may be tried. The reason for this behaviour is to ensure
25794 that all IP addresses are considered before timing out an email address (but
25795 see below for an exception).
25796
25797 Secondly, when the &%hosts_max_try%& limit is reached, Exim looks down the host
25798 list to see if there is a subsequent host with a different (higher valued) MX.
25799 If there is, that host is considered next, and the current IP address is used
25800 but not counted. This behaviour helps in the case of a domain with a retry rule
25801 that hardly ever delays any hosts, as is now explained:
25802
25803 Consider the case of a long list of hosts with one MX value, and a few with a
25804 higher MX value. If &%hosts_max_try%& is small (the default is 5) only a few
25805 hosts at the top of the list are tried at first. With the default retry rule,
25806 which specifies increasing retry times, the higher MX hosts are eventually
25807 tried when those at the top of the list are skipped because they have not
25808 reached their retry times.
25809
25810 However, it is common practice to put a fixed short retry time on domains for
25811 large ISPs, on the grounds that their servers are rarely down for very long.
25812 Unfortunately, these are exactly the domains that tend to resolve to long lists
25813 of hosts. The short retry time means that the lowest MX hosts are tried every
25814 time. The attempts may be in a different order because of random sorting, but
25815 without the special MX check, the higher MX hosts would never be tried until
25816 all the lower MX hosts had timed out (which might be several days), because
25817 there are always some lower MX hosts that have reached their retry times. With
25818 the special check, Exim considers at least one IP address from each MX value at
25819 every delivery attempt, even if the &%hosts_max_try%& limit has already been
25820 reached.
25821
25822 The above logic means that &%hosts_max_try%& is not a hard limit, and in
25823 particular, Exim normally eventually tries all the IP addresses before timing
25824 out an email address. When &%hosts_max_try%& was implemented, this seemed a
25825 reasonable thing to do. Recently, however, some lunatic DNS configurations have
25826 been set up with hundreds of IP addresses for some domains. It can
25827 take a very long time indeed for an address to time out in these cases.
25828
25829 The &%hosts_max_try_hardlimit%& option was added to help with this problem.
25830 Exim never tries more than this number of IP addresses; if it hits this limit
25831 and they are all timed out, the email address is bounced, even though not all
25832 possible IP addresses have been tried.
25833 .ecindex IIDsmttra1
25834 .ecindex IIDsmttra2
25835
25836
25837
25838
25839
25840 . ////////////////////////////////////////////////////////////////////////////
25841 . ////////////////////////////////////////////////////////////////////////////
25842
25843 .chapter "Address rewriting" "CHAPrewrite"
25844 .scindex IIDaddrew "rewriting" "addresses"
25845 There are some circumstances in which Exim automatically rewrites domains in
25846 addresses. The two most common are when an address is given without a domain
25847 (referred to as an &"unqualified address"&) or when an address contains an
25848 abbreviated domain that is expanded by DNS lookup.
25849
25850 Unqualified envelope addresses are accepted only for locally submitted
25851 messages, or for messages that are received from hosts matching
25852 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
25853 appropriate. Unqualified addresses in header lines are qualified if they are in
25854 locally submitted messages, or messages from hosts that are permitted to send
25855 unqualified envelope addresses. Otherwise, unqualified addresses in header
25856 lines are neither qualified nor rewritten.
25857
25858 One situation in which Exim does &'not'& automatically rewrite a domain is
25859 when it is the name of a CNAME record in the DNS. The older RFCs suggest that
25860 such a domain should be rewritten using the &"canonical"& name, and some MTAs
25861 do this. The new RFCs do not contain this suggestion.
25862
25863
25864 .section "Explicitly configured address rewriting" "SECID147"
25865 This chapter describes the rewriting rules that can be used in the
25866 main rewrite section of the configuration file, and also in the generic
25867 &%headers_rewrite%& option that can be set on any transport.
25868
25869 Some people believe that configured address rewriting is a Mortal Sin.
25870 Others believe that life is not possible without it. Exim provides the
25871 facility; you do not have to use it.
25872
25873 The main rewriting rules that appear in the &"rewrite"& section of the
25874 configuration file are applied to addresses in incoming messages, both envelope
25875 addresses and addresses in header lines. Each rule specifies the types of
25876 address to which it applies.
25877
25878 Whether or not addresses in header lines are rewritten depends on the origin of
25879 the headers and the type of rewriting. Global rewriting, that is, rewriting
25880 rules from the rewrite section of the configuration file, is applied only to
25881 those headers that were received with the message. Header lines that are added
25882 by ACLs or by a system filter or by individual routers or transports (which
25883 are specific to individual recipient addresses) are not rewritten by the global
25884 rules.
25885
25886 Rewriting at transport time, by means of the &%headers_rewrite%& option,
25887 applies all headers except those added by routers and transports. That is, as
25888 well as the headers that were received with the message, it also applies to
25889 headers that were added by an ACL or a system filter.
25890
25891
25892 In general, rewriting addresses from your own system or domain has some
25893 legitimacy. Rewriting other addresses should be done only with great care and
25894 in special circumstances. The author of Exim believes that rewriting should be
25895 used sparingly, and mainly for &"regularizing"& addresses in your own domains.
25896 Although it can sometimes be used as a routing tool, this is very strongly
25897 discouraged.
25898
25899 There are two commonly encountered circumstances where rewriting is used, as
25900 illustrated by these examples:
25901
25902 .ilist
25903 The company whose domain is &'hitch.fict.example'& has a number of hosts that
25904 exchange mail with each other behind a firewall, but there is only a single
25905 gateway to the outer world. The gateway rewrites &'*.hitch.fict.example'& as
25906 &'hitch.fict.example'& when sending mail off-site.
25907 .next
25908 A host rewrites the local parts of its own users so that, for example,
25909 &'fp42@hitch.fict.example'& becomes &'Ford.Prefect@hitch.fict.example'&.
25910 .endlist
25911
25912
25913
25914 .section "When does rewriting happen?" "SECID148"
25915 .cindex "rewriting" "timing of"
25916 .cindex "&ACL;" "rewriting addresses in"
25917 Configured address rewriting can take place at several different stages of a
25918 message's processing.
25919
25920 .vindex "&$sender_address$&"
25921 At the start of an ACL for MAIL, the sender address may have been rewritten
25922 by a special SMTP-time rewrite rule (see section &<<SECTrewriteS>>&), but no
25923 ordinary rewrite rules have yet been applied. If, however, the sender address
25924 is verified in the ACL, it is rewritten before verification, and remains
25925 rewritten thereafter. The subsequent value of &$sender_address$& is the
25926 rewritten address. This also applies if sender verification happens in a
25927 RCPT ACL. Otherwise, when the sender address is not verified, it is
25928 rewritten as soon as a message's header lines have been received.
25929
25930 .vindex "&$domain$&"
25931 .vindex "&$local_part$&"
25932 Similarly, at the start of an ACL for RCPT, the current recipient's address
25933 may have been rewritten by a special SMTP-time rewrite rule, but no ordinary
25934 rewrite rules have yet been applied to it. However, the behaviour is different
25935 from the sender address when a recipient is verified. The address is rewritten
25936 for the verification, but the rewriting is not remembered at this stage. The
25937 value of &$local_part$& and &$domain$& after verification are always the same
25938 as they were before (that is, they contain the unrewritten &-- except for
25939 SMTP-time rewriting &-- address).
25940
25941 As soon as a message's header lines have been received, all the envelope
25942 recipient addresses are permanently rewritten, and rewriting is also applied to
25943 the addresses in the header lines (if configured). This happens before adding
25944 any header lines that were specified in MAIL or RCPT ACLs, and
25945 .cindex "&[local_scan()]& function" "address rewriting; timing of"
25946 before the DATA ACL and &[local_scan()]& functions are run.
25947
25948 When an address is being routed, either for delivery or for verification,
25949 rewriting is applied immediately to child addresses that are generated by
25950 redirection, unless &%no_rewrite%& is set on the router.
25951
25952 .cindex "envelope from"
25953 .cindex "envelope sender" "rewriting at transport time"
25954 .cindex "rewriting" "at transport time"
25955 .cindex "header lines" "rewriting at transport time"
25956 At transport time, additional rewriting of addresses in header lines can be
25957 specified by setting the generic &%headers_rewrite%& option on a transport.
25958 This option contains rules that are identical in form to those in the rewrite
25959 section of the configuration file. They are applied to the original message
25960 header lines and any that were added by ACLs or a system filter. They are not
25961 applied to header lines that are added by routers or the transport.
25962
25963 The outgoing envelope sender can be rewritten by means of the &%return_path%&
25964 transport option. However, it is not possible to rewrite envelope recipients at
25965 transport time.
25966
25967
25968
25969
25970 .section "Testing the rewriting rules that apply on input" "SECID149"
25971 .cindex "rewriting" "testing"
25972 .cindex "testing" "rewriting"
25973 Exim's input rewriting configuration appears in a part of the runtime
25974 configuration file headed by &"begin rewrite"&. It can be tested by the
25975 &%-brw%& command line option. This takes an address (which can be a full RFC
25976 2822 address) as its argument. The output is a list of how the address would be
25977 transformed by the rewriting rules for each of the different places it might
25978 appear in an incoming message, that is, for each different header and for the
25979 envelope sender and recipient fields. For example,
25980 .code
25981 exim -brw ph10@exim.workshop.example
25982 .endd
25983 might produce the output
25984 .code
25985 sender: Philip.Hazel@exim.workshop.example
25986 from: Philip.Hazel@exim.workshop.example
25987 to: ph10@exim.workshop.example
25988 cc: ph10@exim.workshop.example
25989 bcc: ph10@exim.workshop.example
25990 reply-to: Philip.Hazel@exim.workshop.example
25991 env-from: Philip.Hazel@exim.workshop.example
25992 env-to: ph10@exim.workshop.example
25993 .endd
25994 which shows that rewriting has been set up for that address when used in any of
25995 the source fields, but not when it appears as a recipient address. At the
25996 present time, there is no equivalent way of testing rewriting rules that are
25997 set for a particular transport.
25998
25999
26000 .section "Rewriting rules" "SECID150"
26001 .cindex "rewriting" "rules"
26002 The rewrite section of the configuration file consists of lines of rewriting
26003 rules in the form
26004 .display
26005 <&'source pattern'&>  <&'replacement'&>  <&'flags'&>
26006 .endd
26007 Rewriting rules that are specified for the &%headers_rewrite%& generic
26008 transport option are given as a colon-separated list. Each item in the list
26009 takes the same form as a line in the main rewriting configuration (except that
26010 any colons must be doubled, of course).
26011
26012 The formats of source patterns and replacement strings are described below.
26013 Each is terminated by white space, unless enclosed in double quotes, in which
26014 case normal quoting conventions apply inside the quotes. The flags are single
26015 characters which may appear in any order. Spaces and tabs between them are
26016 ignored.
26017
26018 For each address that could potentially be rewritten, the rules are scanned in
26019 order, and replacements for the address from earlier rules can themselves be
26020 replaced by later rules (but see the &"q"& and &"R"& flags).
26021
26022 The order in which addresses are rewritten is undefined, may change between
26023 releases, and must not be relied on, with one exception: when a message is
26024 received, the envelope sender is always rewritten first, before any header
26025 lines are rewritten. For example, the replacement string for a rewrite of an
26026 address in &'To:'& must not assume that the message's address in &'From:'& has
26027 (or has not) already been rewritten. However, a rewrite of &'From:'& may assume
26028 that the envelope sender has already been rewritten.
26029
26030 .vindex "&$domain$&"
26031 .vindex "&$local_part$&"
26032 The variables &$local_part$& and &$domain$& can be used in the replacement
26033 string to refer to the address that is being rewritten. Note that lookup-driven
26034 rewriting can be done by a rule of the form
26035 .code
26036 *@*   ${lookup ...
26037 .endd
26038 where the lookup key uses &$1$& and &$2$& or &$local_part$& and &$domain$& to
26039 refer to the address that is being rewritten.
26040
26041
26042 .section "Rewriting patterns" "SECID151"
26043 .cindex "rewriting" "patterns"
26044 .cindex "address list" "in a rewriting pattern"
26045 The source pattern in a rewriting rule is any item which may appear in an
26046 address list (see section &<<SECTaddresslist>>&). It is in fact processed as a
26047 single-item address list, which means that it is expanded before being tested
26048 against the address. As always, if you use a regular expression as a pattern,
26049 you must take care to escape dollar and backslash characters, or use the &`\N`&
26050 facility to suppress string expansion within the regular expression.
26051
26052 Domains in patterns should be given in lower case. Local parts in patterns are
26053 case-sensitive. If you want to do case-insensitive matching of local parts, you
26054 can use a regular expression that starts with &`^(?i)`&.
26055
26056 .cindex "numerical variables (&$1$& &$2$& etc)" "in rewriting rules"
26057 After matching, the numerical variables &$1$&, &$2$&, etc. may be set,
26058 depending on the type of match which occurred. These can be used in the
26059 replacement string to insert portions of the incoming address. &$0$& always
26060 refers to the complete incoming address. When a regular expression is used, the
26061 numerical variables are set from its capturing subexpressions. For other types
26062 of pattern they are set as follows:
26063
26064 .ilist
26065 If a local part or domain starts with an asterisk, the numerical variables
26066 refer to the character strings matched by asterisks, with &$1$& associated with
26067 the first asterisk, and &$2$& with the second, if present. For example, if the
26068 pattern
26069 .code
26070 *queen@*.fict.example
26071 .endd
26072 is matched against the address &'hearts-queen@wonderland.fict.example'& then
26073 .code
26074 $0 = hearts-queen@wonderland.fict.example
26075 $1 = hearts-
26076 $2 = wonderland
26077 .endd
26078 Note that if the local part does not start with an asterisk, but the domain
26079 does, it is &$1$& that contains the wild part of the domain.
26080
26081 .next
26082 If the domain part of the pattern is a partial lookup, the wild and fixed parts
26083 of the domain are placed in the next available numerical variables. Suppose,
26084 for example, that the address &'foo@bar.baz.example'& is processed by a
26085 rewriting rule of the form
26086 .display
26087 &`*@partial-dbm;/some/dbm/file`&    <&'replacement string'&>
26088 .endd
26089 and the key in the file that matches the domain is &`*.baz.example`&. Then
26090 .code
26091 $1 = foo
26092 $2 = bar
26093 $3 = baz.example
26094 .endd
26095 If the address &'foo@baz.example'& is looked up, this matches the same
26096 wildcard file entry, and in this case &$2$& is set to the empty string, but
26097 &$3$& is still set to &'baz.example'&. If a non-wild key is matched in a
26098 partial lookup, &$2$& is again set to the empty string and &$3$& is set to the
26099 whole domain. For non-partial domain lookups, no numerical variables are set.
26100 .endlist
26101
26102
26103 .section "Rewriting replacements" "SECID152"
26104 .cindex "rewriting" "replacements"
26105 If the replacement string for a rule is a single asterisk, addresses that
26106 match the pattern and the flags are &'not'& rewritten, and no subsequent
26107 rewriting rules are scanned. For example,
26108 .code
26109 hatta@lookingglass.fict.example  *  f
26110 .endd
26111 specifies that &'hatta@lookingglass.fict.example'& is never to be rewritten in
26112 &'From:'& headers.
26113
26114 .vindex "&$domain$&"
26115 .vindex "&$local_part$&"
26116 If the replacement string is not a single asterisk, it is expanded, and must
26117 yield a fully qualified address. Within the expansion, the variables
26118 &$local_part$& and &$domain$& refer to the address that is being rewritten.
26119 Any letters they contain retain their original case &-- they are not lower
26120 cased. The numerical variables are set up according to the type of pattern that
26121 matched the address, as described above. If the expansion is forced to fail by
26122 the presence of &"fail"& in a conditional or lookup item, rewriting by the
26123 current rule is abandoned, but subsequent rules may take effect. Any other
26124 expansion failure causes the entire rewriting operation to be abandoned, and an
26125 entry written to the panic log.
26126
26127
26128
26129 .section "Rewriting flags" "SECID153"
26130 There are three different kinds of flag that may appear on rewriting rules:
26131
26132 .ilist
26133 Flags that specify which headers and envelope addresses to rewrite: E, F, T, b,
26134 c, f, h, r, s, t.
26135 .next
26136 A flag that specifies rewriting at SMTP time: S.
26137 .next
26138 Flags that control the rewriting process: Q, q, R, w.
26139 .endlist
26140
26141 For rules that are part of the &%headers_rewrite%& generic transport option,
26142 E, F, T, and S are not permitted.
26143
26144
26145
26146 .section "Flags specifying which headers and envelope addresses to rewrite" &&&
26147          "SECID154"
26148 .cindex "rewriting" "flags"
26149 If none of the following flag letters, nor the &"S"& flag (see section
26150 &<<SECTrewriteS>>&) are present, a main rewriting rule applies to all headers
26151 and to both the sender and recipient fields of the envelope, whereas a
26152 transport-time rewriting rule just applies to all headers. Otherwise, the
26153 rewriting rule is skipped unless the relevant addresses are being processed.
26154 .display
26155 &`E`&       rewrite all envelope fields
26156 &`F`&       rewrite the envelope From field
26157 &`T`&       rewrite the envelope To field
26158 &`b`&       rewrite the &'Bcc:'& header
26159 &`c`&       rewrite the &'Cc:'& header
26160 &`f`&       rewrite the &'From:'& header
26161 &`h`&       rewrite all headers
26162 &`r`&       rewrite the &'Reply-To:'& header
26163 &`s`&       rewrite the &'Sender:'& header
26164 &`t`&       rewrite the &'To:'& header
26165 .endd
26166 "All headers" means all of the headers listed above that can be selected
26167 individually, plus their &'Resent-'& versions. It does not include
26168 other headers such as &'Subject:'& etc.
26169
26170 You should be particularly careful about rewriting &'Sender:'& headers, and
26171 restrict this to special known cases in your own domains.
26172
26173
26174 .section "The SMTP-time rewriting flag" "SECTrewriteS"
26175 .cindex "SMTP" "rewriting malformed addresses"
26176 .cindex "RCPT" "rewriting argument of"
26177 .cindex "MAIL" "rewriting argument of"
26178 The rewrite flag &"S"& specifies a rewrite of incoming envelope addresses at
26179 SMTP time, as soon as an address is received in a MAIL or RCPT command, and
26180 before any other processing; even before syntax checking. The pattern is
26181 required to be a regular expression, and it is matched against the whole of the
26182 data for the command, including any surrounding angle brackets.
26183
26184 .vindex "&$domain$&"
26185 .vindex "&$local_part$&"
26186 This form of rewrite rule allows for the handling of addresses that are not
26187 compliant with RFCs 2821 and 2822 (for example, &"bang paths"& in batched SMTP
26188 input). Because the input is not required to be a syntactically valid address,
26189 the variables &$local_part$& and &$domain$& are not available during the
26190 expansion of the replacement string. The result of rewriting replaces the
26191 original address in the MAIL or RCPT command.
26192
26193
26194 .section "Flags controlling the rewriting process" "SECID155"
26195 There are four flags which control the way the rewriting process works. These
26196 take effect only when a rule is invoked, that is, when the address is of the
26197 correct type (matches the flags) and matches the pattern:
26198
26199 .ilist
26200 If the &"Q"& flag is set on a rule, the rewritten address is permitted to be an
26201 unqualified local part. It is qualified with &%qualify_recipient%&. In the
26202 absence of &"Q"& the rewritten address must always include a domain.
26203 .next
26204 If the &"q"& flag is set on a rule, no further rewriting rules are considered,
26205 even if no rewriting actually takes place because of a &"fail"& in the
26206 expansion. The &"q"& flag is not effective if the address is of the wrong type
26207 (does not match the flags) or does not match the pattern.
26208 .next
26209 The &"R"& flag causes a successful rewriting rule to be re-applied to the new
26210 address, up to ten times. It can be combined with the &"q"& flag, to stop
26211 rewriting once it fails to match (after at least one successful rewrite).
26212 .next
26213 .cindex "rewriting" "whole addresses"
26214 When an address in a header is rewritten, the rewriting normally applies only
26215 to the working part of the address, with any comments and RFC 2822 &"phrase"&
26216 left unchanged. For example, rewriting might change
26217 .code
26218 From: Ford Prefect <fp42@restaurant.hitch.fict.example>
26219 .endd
26220 into
26221 .code
26222 From: Ford Prefect <prefectf@hitch.fict.example>
26223 .endd
26224 .cindex "RFC 2047"
26225 Sometimes there is a need to replace the whole address item, and this can be
26226 done by adding the flag letter &"w"& to a rule. If this is set on a rule that
26227 causes an address in a header line to be rewritten, the entire address is
26228 replaced, not just the working part. The replacement must be a complete RFC
26229 2822 address, including the angle brackets if necessary. If text outside angle
26230 brackets contains a character whose value is greater than 126 or less than 32
26231 (except for tab), the text is encoded according to RFC 2047. The character set
26232 is taken from &%headers_charset%&, which gets its default at build time.
26233
26234 When the &"w"& flag is set on a rule that causes an envelope address to be
26235 rewritten, all but the working part of the replacement address is discarded.
26236 .endlist
26237
26238
26239 .section "Rewriting examples" "SECID156"
26240 Here is an example of the two common rewriting paradigms:
26241 .code
26242 *@*.hitch.fict.example  $1@hitch.fict.example
26243 *@hitch.fict.example    ${lookup{$1}dbm{/etc/realnames}\
26244                      {$value}fail}@hitch.fict.example bctfrF
26245 .endd
26246 Note the use of &"fail"& in the lookup expansion in the second rule, forcing
26247 the string expansion to fail if the lookup does not succeed. In this context it
26248 has the effect of leaving the original address unchanged, but Exim goes on to
26249 consider subsequent rewriting rules, if any, because the &"q"& flag is not
26250 present in that rule. An alternative to &"fail"& would be to supply &$1$&
26251 explicitly, which would cause the rewritten address to be the same as before,
26252 at the cost of a small bit of processing. Not supplying either of these is an
26253 error, since the rewritten address would then contain no local part.
26254
26255 The first example above replaces the domain with a superior, more general
26256 domain. This may not be desirable for certain local parts. If the rule
26257 .code
26258 root@*.hitch.fict.example  *
26259 .endd
26260 were inserted before the first rule, rewriting would be suppressed for the
26261 local part &'root'& at any domain ending in &'hitch.fict.example'&.
26262
26263 Rewriting can be made conditional on a number of tests, by making use of
26264 &${if$& in the expansion item. For example, to apply a rewriting rule only to
26265 messages that originate outside the local host:
26266 .code
26267 *@*.hitch.fict.example  "${if !eq {$sender_host_address}{}\
26268                          {$1@hitch.fict.example}fail}"
26269 .endd
26270 The replacement string is quoted in this example because it contains white
26271 space.
26272
26273 .cindex "rewriting" "bang paths"
26274 .cindex "bang paths" "rewriting"
26275 Exim does not handle addresses in the form of &"bang paths"&. If it sees such
26276 an address it treats it as an unqualified local part which it qualifies with
26277 the local qualification domain (if the source of the message is local or if the
26278 remote host is permitted to send unqualified addresses). Rewriting can
26279 sometimes be used to handle simple bang paths with a fixed number of
26280 components. For example, the rule
26281 .code
26282 \N^([^!]+)!(.*)@your.domain.example$\N   $2@$1
26283 .endd
26284 rewrites a two-component bang path &'host.name!user'& as the domain address
26285 &'user@host.name'&. However, there is a security implication in using this as
26286 a global rewriting rule for envelope addresses. It can provide a backdoor
26287 method for using your system as a relay, because the incoming addresses appear
26288 to be local. If the bang path addresses are received via SMTP, it is safer to
26289 use the &"S"& flag to rewrite them as they are received, so that relay checking
26290 can be done on the rewritten addresses.
26291 .ecindex IIDaddrew
26292
26293
26294
26295
26296
26297 . ////////////////////////////////////////////////////////////////////////////
26298 . ////////////////////////////////////////////////////////////////////////////
26299
26300 .chapter "Retry configuration" "CHAPretry"
26301 .scindex IIDretconf1 "retry" "configuration, description of"
26302 .scindex IIDregconf2 "configuration file" "retry section"
26303 The &"retry"& section of the runtime configuration file contains a list of
26304 retry rules that control how often Exim tries to deliver messages that cannot
26305 be delivered at the first attempt. If there are no retry rules (the section is
26306 empty or not present), there are no retries. In this situation, temporary
26307 errors are treated as permanent. The default configuration contains a single,
26308 general-purpose retry rule (see section &<<SECID57>>&). The &%-brt%& command
26309 line option can be used to test which retry rule will be used for a given
26310 address, domain and error.
26311
26312 The most common cause of retries is temporary failure to deliver to a remote
26313 host because the host is down, or inaccessible because of a network problem.
26314 Exim's retry processing in this case is applied on a per-host (strictly, per IP
26315 address) basis, not on a per-message basis. Thus, if one message has recently
26316 been delayed, delivery of a new message to the same host is not immediately
26317 tried, but waits for the host's retry time to arrive. If the &%retry_defer%&
26318 log selector is set, the message
26319 .cindex "retry" "time not reached"
26320 &"retry time not reached"& is written to the main log whenever a delivery is
26321 skipped for this reason. Section &<<SECToutSMTPerr>>& contains more details of
26322 the handling of errors during remote deliveries.
26323
26324 Retry processing applies to routing as well as to delivering, except as covered
26325 in the next paragraph. The retry rules do not distinguish between these
26326 actions. It is not possible, for example, to specify different behaviour for
26327 failures to route the domain &'snark.fict.example'& and failures to deliver to
26328 the host &'snark.fict.example'&. I didn't think anyone would ever need this
26329 added complication, so did not implement it. However, although they share the
26330 same retry rule, the actual retry times for routing and transporting a given
26331 domain are maintained independently.
26332
26333 When a delivery is not part of a queue run (typically an immediate delivery on
26334 receipt of a message), the routers are always run, and local deliveries are
26335 always attempted, even if retry times are set for them. This makes for better
26336 behaviour if one particular message is causing problems (for example, causing
26337 quota overflow, or provoking an error in a filter file). If such a delivery
26338 suffers a temporary failure, the retry data is updated as normal, and
26339 subsequent delivery attempts from queue runs occur only when the retry time for
26340 the local address is reached.
26341
26342 .section "Changing retry rules" "SECID157"
26343 If you change the retry rules in your configuration, you should consider
26344 whether or not to delete the retry data that is stored in Exim's spool area in
26345 files with names like &_db/retry_&. Deleting any of Exim's hints files is
26346 always safe; that is why they are called &"hints"&.
26347
26348 The hints retry data contains suggested retry times based on the previous
26349 rules. In the case of a long-running problem with a remote host, it might
26350 record the fact that the host has timed out. If your new rules increase the
26351 timeout time for such a host, you should definitely remove the old retry data
26352 and let Exim recreate it, based on the new rules. Otherwise Exim might bounce
26353 messages that it should now be retaining.
26354
26355
26356
26357 .section "Format of retry rules" "SECID158"
26358 .cindex "retry" "rules"
26359 Each retry rule occupies one line and consists of three or four parts,
26360 separated by white space: a pattern, an error name, an optional list of sender
26361 addresses, and a list of retry parameters. The pattern and sender lists must be
26362 enclosed in double quotes if they contain white space. The rules are searched
26363 in order until one is found where the pattern, error name, and sender list (if
26364 present) match the failing host or address, the error that occurred, and the
26365 message's sender, respectively.
26366
26367
26368 The pattern is any single item that may appear in an address list (see section
26369 &<<SECTaddresslist>>&). It is in fact processed as a one-item address list,
26370 which means that it is expanded before being tested against the address that
26371 has been delayed. A negated address list item is permitted. Address
26372 list processing treats a plain domain name as if it were preceded by &"*@"&,
26373 which makes it possible for many retry rules to start with just a domain. For
26374 example,
26375 .code
26376 lookingglass.fict.example        *  F,24h,30m;
26377 .endd
26378 provides a rule for any address in the &'lookingglass.fict.example'& domain,
26379 whereas
26380 .code
26381 alice@lookingglass.fict.example  *  F,24h,30m;
26382 .endd
26383 applies only to temporary failures involving the local part &%alice%&.
26384 In practice, almost all rules start with a domain name pattern without a local
26385 part.
26386
26387 .cindex "regular expressions" "in retry rules"
26388 &*Warning*&: If you use a regular expression in a retry rule pattern, it
26389 must match a complete address, not just a domain, because that is how regular
26390 expressions work in address lists.
26391 .display
26392 &`^\Nxyz\d+\.abc\.example$\N        *  G,1h,10m,2`&     &%Wrong%&
26393 &`^\N[^@]+@xyz\d+\.abc\.example$\N  *  G,1h,10m,2`&     &%Right%&
26394 .endd
26395
26396
26397 .section "Choosing which retry rule to use for address errors" "SECID159"
26398 When Exim is looking for a retry rule after a routing attempt has failed (for
26399 example, after a DNS timeout), each line in the retry configuration is tested
26400 against the complete address only if &%retry_use_local_part%& is set for the
26401 router. Otherwise, only the domain is used, except when matching against a
26402 regular expression, when the local part of the address is replaced with &"*"&.
26403 A domain on its own can match a domain pattern, or a pattern that starts with
26404 &"*@"&. By default, &%retry_use_local_part%& is true for routers where
26405 &%check_local_user%& is true, and false for other routers.
26406
26407 Similarly, when Exim is looking for a retry rule after a local delivery has
26408 failed (for example, after a mailbox full error), each line in the retry
26409 configuration is tested against the complete address only if
26410 &%retry_use_local_part%& is set for the transport (it defaults true for all
26411 local transports).
26412
26413 .cindex "4&'xx'& responses" "retry rules for"
26414 However, when Exim is looking for a retry rule after a remote delivery attempt
26415 suffers an address error (a 4&'xx'& SMTP response for a recipient address), the
26416 whole address is always used as the key when searching the retry rules. The
26417 rule that is found is used to create a retry time for the combination of the
26418 failing address and the message's sender. It is the combination of sender and
26419 recipient that is delayed in subsequent queue runs until its retry time is
26420 reached. You can delay the recipient without regard to the sender by setting
26421 &%address_retry_include_sender%& false in the &(smtp)& transport but this can
26422 lead to problems with servers that regularly issue 4&'xx'& responses to RCPT
26423 commands.
26424
26425
26426
26427 .section "Choosing which retry rule to use for host and message errors" &&&
26428          "SECID160"
26429 For a temporary error that is not related to an individual address (for
26430 example, a connection timeout), each line in the retry configuration is checked
26431 twice. First, the name of the remote host is used as a domain name (preceded by
26432 &"*@"& when matching a regular expression). If this does not match the line,
26433 the domain from the email address is tried in a similar fashion. For example,
26434 suppose the MX records for &'a.b.c.example'& are
26435 .code
26436 a.b.c.example  MX  5  x.y.z.example
26437                MX  6  p.q.r.example
26438                MX  7  m.n.o.example
26439 .endd
26440 and the retry rules are
26441 .code
26442 p.q.r.example    *      F,24h,30m;
26443 a.b.c.example    *      F,4d,45m;
26444 .endd
26445 and a delivery to the host &'x.y.z.example'& suffers a connection failure. The
26446 first rule matches neither the host nor the domain, so Exim looks at the second
26447 rule. This does not match the host, but it does match the domain, so it is used
26448 to calculate the retry time for the host &'x.y.z.example'&. Meanwhile, Exim
26449 tries to deliver to &'p.q.r.example'&. If this also suffers a host error, the
26450 first retry rule is used, because it matches the host.
26451
26452 In other words, temporary failures to deliver to host &'p.q.r.example'& use the
26453 first rule to determine retry times, but for all the other hosts for the domain
26454 &'a.b.c.example'&, the second rule is used. The second rule is also used if
26455 routing to &'a.b.c.example'& suffers a temporary failure.
26456
26457 &*Note*&: The host name is used when matching the patterns, not its IP address.
26458 However, if a message is routed directly to an IP address without the use of a
26459 host name, for example, if a &(manualroute)& router contains a setting such as:
26460 .code
26461 route_list = *.a.example  192.168.34.23
26462 .endd
26463 then the &"host name"& that is used when searching for a retry rule is the
26464 textual form of the IP address.
26465
26466 .section "Retry rules for specific errors" "SECID161"
26467 .cindex "retry" "specific errors; specifying"
26468 The second field in a retry rule is the name of a particular error, or an
26469 asterisk, which matches any error. The errors that can be tested for are:
26470
26471 .vlist
26472 .vitem &%auth_failed%&
26473 Authentication failed when trying to send to a host in the
26474 &%hosts_require_auth%& list in an &(smtp)& transport.
26475
26476 .vitem &%data_4xx%&
26477 A 4&'xx'& error was received for an outgoing DATA command, either immediately
26478 after the command, or after sending the message's data.
26479
26480 .vitem &%mail_4xx%&
26481 A 4&'xx'& error was received for an outgoing MAIL command.
26482
26483 .vitem &%rcpt_4xx%&
26484 A 4&'xx'& error was received for an outgoing RCPT command.
26485 .endlist
26486
26487 For the three 4&'xx'& errors, either the first or both of the x's can be given
26488 as specific digits, for example: &`mail_45x`& or &`rcpt_436`&. For example, to
26489 recognize 452 errors given to RCPT commands for addresses in a certain domain,
26490 and have retries every ten minutes with a one-hour timeout, you could set up a
26491 retry rule of this form:
26492 .code
26493 the.domain.name  rcpt_452   F,1h,10m
26494 .endd
26495 These errors apply to both outgoing SMTP (the &(smtp)& transport) and outgoing
26496 LMTP (either the &(lmtp)& transport, or the &(smtp)& transport in LMTP mode).
26497
26498 .vlist
26499 .vitem &%lost_connection%&
26500 A server unexpectedly closed the SMTP connection. There may, of course,
26501 legitimate reasons for this (host died, network died), but if it repeats a lot
26502 for the same host, it indicates something odd.
26503
26504 .vitem &%lookup%&
26505 A DNS lookup for a host failed.
26506 Note that a &%dnslookup%& router will need to have matched
26507 its &%fail_defer_domains%& option for this retry type to be usable.
26508 Also note that a &%manualroute%& router will probably need
26509 its &%host_find_failed%& option set to &%defer%&.
26510
26511 .vitem &%refused_MX%&
26512 A connection to a host obtained from an MX record was refused.
26513
26514 .vitem &%refused_A%&
26515 A connection to a host not obtained from an MX record was refused.
26516
26517 .vitem &%refused%&
26518 A connection was refused.
26519
26520 .vitem &%timeout_connect_MX%&
26521 A connection attempt to a host obtained from an MX record timed out.
26522
26523 .vitem &%timeout_connect_A%&
26524 A connection attempt to a host not obtained from an MX record timed out.
26525
26526 .vitem &%timeout_connect%&
26527 A connection attempt timed out.
26528
26529 .vitem &%timeout_MX%&
26530 There was a timeout while connecting or during an SMTP session with a host
26531 obtained from an MX record.
26532
26533 .vitem &%timeout_A%&
26534 There was a timeout while connecting or during an SMTP session with a host not
26535 obtained from an MX record.
26536
26537 .vitem &%timeout%&
26538 There was a timeout while connecting or during an SMTP session.
26539
26540 .vitem &%tls_required%&
26541 The server was required to use TLS (it matched &%hosts_require_tls%& in the
26542 &(smtp)& transport), but either did not offer TLS, or it responded with 4&'xx'&
26543 to STARTTLS, or there was a problem setting up the TLS connection.
26544
26545 .vitem &%quota%&
26546 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
26547 transport.
26548
26549 .vitem &%quota_%&<&'time'&>
26550 .cindex "quota" "error testing in retry rule"
26551 .cindex "retry" "quota error testing"
26552 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
26553 transport, and the mailbox has not been accessed for <&'time'&>. For example,
26554 &'quota_4d'& applies to a quota error when the mailbox has not been accessed
26555 for four days.
26556 .endlist
26557
26558 .cindex "mailbox" "time of last read"
26559 The idea of &%quota_%&<&'time'&> is to make it possible to have shorter
26560 timeouts when the mailbox is full and is not being read by its owner. Ideally,
26561 it should be based on the last time that the user accessed the mailbox.
26562 However, it is not always possible to determine this. Exim uses the following
26563 heuristic rules:
26564
26565 .ilist
26566 If the mailbox is a single file, the time of last access (the &"atime"&) is
26567 used. As no new messages are being delivered (because the mailbox is over
26568 quota), Exim does not access the file, so this is the time of last user access.
26569 .next
26570 .cindex "maildir format" "time of last read"
26571 For a maildir delivery, the time of last modification of the &_new_&
26572 subdirectory is used. As the mailbox is over quota, no new files are created in
26573 the &_new_& subdirectory, because no new messages are being delivered. Any
26574 change to the &_new_& subdirectory is therefore assumed to be the result of an
26575 MUA moving a new message to the &_cur_& directory when it is first read. The
26576 time that is used is therefore the last time that the user read a new message.
26577 .next
26578 For other kinds of multi-file mailbox, the time of last access cannot be
26579 obtained, so a retry rule that uses this type of error field is never matched.
26580 .endlist
26581
26582 The quota errors apply both to system-enforced quotas and to Exim's own quota
26583 mechanism in the &(appendfile)& transport. The &'quota'& error also applies
26584 when a local delivery is deferred because a partition is full (the ENOSPC
26585 error).
26586
26587
26588
26589 .section "Retry rules for specified senders" "SECID162"
26590 .cindex "retry" "rules; sender-specific"
26591 You can specify retry rules that apply only when the failing message has a
26592 specific sender. In particular, this can be used to define retry rules that
26593 apply only to bounce messages. The third item in a retry rule can be of this
26594 form:
26595 .display
26596 &`senders=`&<&'address list'&>
26597 .endd
26598 The retry timings themselves are then the fourth item. For example:
26599 .code
26600 *   rcpt_4xx   senders=:   F,1h,30m
26601 .endd
26602 matches recipient 4&'xx'& errors for bounce messages sent to any address at any
26603 host. If the address list contains white space, it must be enclosed in quotes.
26604 For example:
26605 .code
26606 a.domain  rcpt_452  senders="xb.dom : yc.dom"  G,8h,10m,1.5
26607 .endd
26608 &*Warning*&: This facility can be unhelpful if it is used for host errors
26609 (which do not depend on the recipient). The reason is that the sender is used
26610 only to match the retry rule. Once the rule has been found for a host error,
26611 its contents are used to set a retry time for the host, and this will apply to
26612 all messages, not just those with specific senders.
26613
26614 When testing retry rules using &%-brt%&, you can supply a sender using the
26615 &%-f%& command line option, like this:
26616 .code
26617 exim -f "" -brt user@dom.ain
26618 .endd
26619 If you do not set &%-f%& with &%-brt%&, a retry rule that contains a senders
26620 list is never matched.
26621
26622
26623
26624
26625
26626 .section "Retry parameters" "SECID163"
26627 .cindex "retry" "parameters in rules"
26628 The third (or fourth, if a senders list is present) field in a retry rule is a
26629 sequence of retry parameter sets, separated by semicolons. Each set consists of
26630 .display
26631 <&'letter'&>,<&'cutoff time'&>,<&'arguments'&>
26632 .endd
26633 The letter identifies the algorithm for computing a new retry time; the cutoff
26634 time is the time beyond which this algorithm no longer applies, and the
26635 arguments vary the algorithm's action. The cutoff time is measured from the
26636 time that the first failure for the domain (combined with the local part if
26637 relevant) was detected, not from the time the message was received.
26638
26639 .cindex "retry" "algorithms"
26640 .cindex "retry" "fixed intervals"
26641 .cindex "retry" "increasing intervals"
26642 .cindex "retry" "random intervals"
26643 The available algorithms are:
26644
26645 .ilist
26646 &'F'&: retry at fixed intervals. There is a single time parameter specifying
26647 the interval.
26648 .next
26649 &'G'&: retry at geometrically increasing intervals. The first argument
26650 specifies a starting value for the interval, and the second a multiplier, which
26651 is used to increase the size of the interval at each retry.
26652 .next
26653 &'H'&: retry at randomized intervals. The arguments are as for &'G'&. For each
26654 retry, the previous interval is multiplied by the factor in order to get a
26655 maximum for the next interval. The minimum interval is the first argument of
26656 the parameter, and an actual interval is chosen randomly between them. Such a
26657 rule has been found to be helpful in cluster configurations when all the
26658 members of the cluster restart at once, and may therefore synchronize their
26659 queue processing times.
26660 .endlist
26661
26662 When computing the next retry time, the algorithm definitions are scanned in
26663 order until one whose cutoff time has not yet passed is reached. This is then
26664 used to compute a new retry time that is later than the current time. In the
26665 case of fixed interval retries, this simply means adding the interval to the
26666 current time. For geometrically increasing intervals, retry intervals are
26667 computed from the rule's parameters until one that is greater than the previous
26668 interval is found. The main configuration variable
26669 .cindex "limit" "retry interval"
26670 .cindex "retry" "interval, maximum"
26671 .oindex "&%retry_interval_max%&"
26672 &%retry_interval_max%& limits the maximum interval between retries. It
26673 cannot be set greater than &`24h`&, which is its default value.
26674
26675 A single remote domain may have a number of hosts associated with it, and each
26676 host may have more than one IP address. Retry algorithms are selected on the
26677 basis of the domain name, but are applied to each IP address independently. If,
26678 for example, a host has two IP addresses and one is unusable, Exim will
26679 generate retry times for it and will not try to use it until its next retry
26680 time comes. Thus the good IP address is likely to be tried first most of the
26681 time.
26682
26683 .cindex "hints database" "use for retrying"
26684 Retry times are hints rather than promises. Exim does not make any attempt to
26685 run deliveries exactly at the computed times. Instead, a queue runner process
26686 starts delivery processes for delayed messages periodically, and these attempt
26687 new deliveries only for those addresses that have passed their next retry time.
26688 If a new message arrives for a deferred address, an immediate delivery attempt
26689 occurs only if the address has passed its retry time. In the absence of new
26690 messages, the minimum time between retries is the interval between queue runner
26691 processes. There is not much point in setting retry times of five minutes if
26692 your queue runners happen only once an hour, unless there are a significant
26693 number of incoming messages (which might be the case on a system that is
26694 sending everything to a smart host, for example).
26695
26696 The data in the retry hints database can be inspected by using the
26697 &'exim_dumpdb'& or &'exim_fixdb'& utility programs (see chapter
26698 &<<CHAPutils>>&). The latter utility can also be used to change the data. The
26699 &'exinext'& utility script can be used to find out what the next retry times
26700 are for the hosts associated with a particular mail domain, and also for local
26701 deliveries that have been deferred.
26702
26703
26704 .section "Retry rule examples" "SECID164"
26705 Here are some example retry rules:
26706 .code
26707 alice@wonderland.fict.example quota_5d  F,7d,3h
26708 wonderland.fict.example       quota_5d
26709 wonderland.fict.example       *         F,1h,15m; G,2d,1h,2;
26710 lookingglass.fict.example     *         F,24h,30m;
26711 *                 refused_A   F,2h,20m;
26712 *                 *           F,2h,15m; G,16h,1h,1.5; F,5d,8h
26713 .endd
26714 The first rule sets up special handling for mail to
26715 &'alice@wonderland.fict.example'& when there is an over-quota error and the
26716 mailbox has not been read for at least 5 days. Retries continue every three
26717 hours for 7 days. The second rule handles over-quota errors for all other local
26718 parts at &'wonderland.fict.example'&; the absence of a local part has the same
26719 effect as supplying &"*@"&. As no retry algorithms are supplied, messages that
26720 fail are bounced immediately if the mailbox has not been read for at least 5
26721 days.
26722
26723 The third rule handles all other errors at &'wonderland.fict.example'&; retries
26724 happen every 15 minutes for an hour, then with geometrically increasing
26725 intervals until two days have passed since a delivery first failed. After the
26726 first hour there is a delay of one hour, then two hours, then four hours, and
26727 so on (this is a rather extreme example).
26728
26729 The fourth rule controls retries for the domain &'lookingglass.fict.example'&.
26730 They happen every 30 minutes for 24 hours only. The remaining two rules handle
26731 all other domains, with special action for connection refusal from hosts that
26732 were not obtained from an MX record.
26733
26734 The final rule in a retry configuration should always have asterisks in the
26735 first two fields so as to provide a general catch-all for any addresses that do
26736 not have their own special handling. This example tries every 15 minutes for 2
26737 hours, then with intervals starting at one hour and increasing by a factor of
26738 1.5 up to 16 hours, then every 8 hours up to 5 days.
26739
26740
26741
26742 .section "Timeout of retry data" "SECID165"
26743 .cindex "timeout" "of retry data"
26744 .oindex "&%retry_data_expire%&"
26745 .cindex "hints database" "data expiry"
26746 .cindex "retry" "timeout of data"
26747 Exim timestamps the data that it writes to its retry hints database. When it
26748 consults the data during a delivery it ignores any that is older than the value
26749 set in &%retry_data_expire%& (default 7 days). If, for example, a host hasn't
26750 been tried for 7 days, Exim will try to deliver to it immediately a message
26751 arrives, and if that fails, it will calculate a retry time as if it were
26752 failing for the first time.
26753
26754 This improves the behaviour for messages routed to rarely-used hosts such as MX
26755 backups. If such a host was down at one time, and happens to be down again when
26756 Exim tries a month later, using the old retry data would imply that it had been
26757 down all the time, which is not a justified assumption.
26758
26759 If a host really is permanently dead, this behaviour causes a burst of retries
26760 every now and again, but only if messages routed to it are rare. If there is a
26761 message at least once every 7 days the retry data never expires.
26762
26763
26764
26765
26766 .section "Long-term failures" "SECID166"
26767 .cindex "delivery failure, long-term"
26768 .cindex "retry" "after long-term failure"
26769 Special processing happens when an email address has been failing for so long
26770 that the cutoff time for the last algorithm is reached. For example, using the
26771 default retry rule:
26772 .code
26773 * * F,2h,15m; G,16h,1h,1.5; F,4d,6h
26774 .endd
26775 the cutoff time is four days. Reaching the retry cutoff is independent of how
26776 long any specific message has been failing; it is the length of continuous
26777 failure for the recipient address that counts.
26778
26779 When the cutoff time is reached for a local delivery, or for all the IP
26780 addresses associated with a remote delivery, a subsequent delivery failure
26781 causes Exim to give up on the address, and a bounce message is generated.
26782 In order to cater for new messages that use the failing address, a next retry
26783 time is still computed from the final algorithm, and is used as follows:
26784
26785 For local deliveries, one delivery attempt is always made for any subsequent
26786 messages. If this delivery fails, the address fails immediately. The
26787 post-cutoff retry time is not used.
26788
26789 .cindex "final cutoff" "retries, controlling"
26790 .cindex retry "final cutoff"
26791 If the delivery is remote, there are two possibilities, controlled by the
26792 .oindex "&%delay_after_cutoff%&"
26793 &%delay_after_cutoff%& option of the &(smtp)& transport. The option is true by
26794 default. Until the post-cutoff retry time for one of the IP addresses,
26795 as set by the &%retry_data_expire%& option, is
26796 reached, the failing email address is bounced immediately, without a delivery
26797 attempt taking place. After that time, one new delivery attempt is made to
26798 those IP addresses that are past their retry times, and if that still fails,
26799 the address is bounced and new retry times are computed.
26800
26801 In other words, when all the hosts for a given email address have been failing
26802 for a long time, Exim bounces rather then defers until one of the hosts' retry
26803 times is reached. Then it tries once, and bounces if that attempt fails. This
26804 behaviour ensures that few resources are wasted in repeatedly trying to deliver
26805 to a broken destination, but if the host does recover, Exim will eventually
26806 notice.
26807
26808 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
26809 addresses are past their final cutoff time, Exim tries to deliver to those IP
26810 addresses that have not been tried since the message arrived. If there are
26811 no suitable IP addresses, or if they all fail, the address is bounced. In other
26812 words, it does not delay when a new message arrives, but tries the expired
26813 addresses immediately, unless they have been tried since the message arrived.
26814 If there is a continuous stream of messages for the failing domains, setting
26815 &%delay_after_cutoff%& false means that there will be many more attempts to
26816 deliver to permanently failing IP addresses than when &%delay_after_cutoff%& is
26817 true.
26818
26819 .section "Deliveries that work intermittently" "SECID167"
26820 .cindex "retry" "intermittently working deliveries"
26821 Some additional logic is needed to cope with cases where a host is
26822 intermittently available, or when a message has some attribute that prevents
26823 its delivery when others to the same address get through. In this situation,
26824 because some messages are successfully delivered, the &"retry clock"& for the
26825 host or address keeps getting reset by the successful deliveries, and so
26826 failing messages remain in the queue for ever because the cutoff time is never
26827 reached.
26828
26829 Two exceptional actions are applied to prevent this happening. The first
26830 applies to errors that are related to a message rather than a remote host.
26831 Section &<<SECToutSMTPerr>>& has a discussion of the different kinds of error;
26832 examples of message-related errors are 4&'xx'& responses to MAIL or DATA
26833 commands, and quota failures. For this type of error, if a message's arrival
26834 time is earlier than the &"first failed"& time for the error, the earlier time
26835 is used when scanning the retry rules to decide when to try next and when to
26836 time out the address.
26837
26838 The exceptional second action applies in all cases. If a message has been on
26839 the queue for longer than the cutoff time of any applicable retry rule for a
26840 given address, a delivery is attempted for that address, even if it is not yet
26841 time, and if this delivery fails, the address is timed out. A new retry time is
26842 not computed in this case, so that other messages for the same address are
26843 considered immediately.
26844 .ecindex IIDretconf1
26845 .ecindex IIDregconf2
26846
26847
26848
26849
26850
26851
26852 . ////////////////////////////////////////////////////////////////////////////
26853 . ////////////////////////////////////////////////////////////////////////////
26854
26855 .chapter "SMTP authentication" "CHAPSMTPAUTH"
26856 .scindex IIDauthconf1 "SMTP" "authentication configuration"
26857 .scindex IIDauthconf2 "authentication"
26858 The &"authenticators"& section of Exim's runtime configuration is concerned
26859 with SMTP authentication. This facility is an extension to the SMTP protocol,
26860 described in RFC 2554, which allows a client SMTP host to authenticate itself
26861 to a server. This is a common way for a server to recognize clients that are
26862 permitted to use it as a relay. SMTP authentication is not of relevance to the
26863 transfer of mail between servers that have no managerial connection with each
26864 other.
26865
26866 .cindex "AUTH" "description of"
26867 .cindex "ESMTP extensions" AUTH
26868 Very briefly, the way SMTP authentication works is as follows:
26869
26870 .ilist
26871 The server advertises a number of authentication &'mechanisms'& in response to
26872 the client's EHLO command.
26873 .next
26874 The client issues an AUTH command, naming a specific mechanism. The command
26875 may, optionally, contain some authentication data.
26876 .next
26877 The server may issue one or more &'challenges'&, to which the client must send
26878 appropriate responses. In simple authentication mechanisms, the challenges are
26879 just prompts for user names and passwords. The server does not have to issue
26880 any challenges &-- in some mechanisms the relevant data may all be transmitted
26881 with the AUTH command.
26882 .next
26883 The server either accepts or denies authentication.
26884 .next
26885 If authentication succeeds, the client may optionally make use of the AUTH
26886 option on the MAIL command to pass an authenticated sender in subsequent
26887 mail transactions. Authentication lasts for the remainder of the SMTP
26888 connection.
26889 .next
26890 If authentication fails, the client may give up, or it may try a different
26891 authentication mechanism, or it may try transferring mail over the
26892 unauthenticated connection.
26893 .endlist
26894
26895 If you are setting up a client, and want to know which authentication
26896 mechanisms the server supports, you can use Telnet to connect to port 25 (the
26897 SMTP port) on the server, and issue an EHLO command. The response to this
26898 includes the list of supported mechanisms. For example:
26899 .display
26900 &`$ `&&*&`telnet server.example 25`&*&
26901 &`Trying 192.168.34.25...`&
26902 &`Connected to server.example.`&
26903 &`Escape character is &#x0027;^]&#x0027;.`&
26904 &`220 server.example ESMTP Exim 4.20 ...`&
26905 &*&`ehlo client.example`&*&
26906 &`250-server.example Hello client.example [10.8.4.5]`&
26907 &`250-SIZE 52428800`&
26908 &`250-PIPELINING`&
26909 &`250-AUTH PLAIN`&
26910 &`250 HELP`&
26911 .endd
26912 The second-last line of this example output shows that the server supports
26913 authentication using the PLAIN mechanism. In Exim, the different authentication
26914 mechanisms are configured by specifying &'authenticator'& drivers. Like the
26915 routers and transports, which authenticators are included in the binary is
26916 controlled by build-time definitions. The following are currently available,
26917 included by setting
26918 .code
26919 AUTH_CRAM_MD5=yes
26920 AUTH_CYRUS_SASL=yes
26921 AUTH_DOVECOT=yes
26922 AUTH_EXTERNAL=yes
26923 AUTH_GSASL=yes
26924 AUTH_HEIMDAL_GSSAPI=yes
26925 AUTH_PLAINTEXT=yes
26926 AUTH_SPA=yes
26927 AUTH_TLS=yes
26928 .endd
26929 in &_Local/Makefile_&, respectively. The first of these supports the CRAM-MD5
26930 authentication mechanism (RFC 2195), and the second provides an interface to
26931 the Cyrus SASL authentication library.
26932 The third is an interface to Dovecot's authentication system, delegating the
26933 work via a socket interface.
26934 The fourth provides for negotiation of authentication done via non-SMTP means,
26935 as defined by RFC 4422 Appendix A.
26936 The fifth provides an interface to the GNU SASL authentication library, which
26937 provides mechanisms but typically not data sources.
26938 The sixth provides direct access to Heimdal GSSAPI, geared for Kerberos, but
26939 supporting setting a server keytab.
26940 The seventh can be configured to support
26941 the PLAIN authentication mechanism (RFC 2595) or the LOGIN mechanism, which is
26942 not formally documented, but used by several MUAs.
26943 The eighth authenticator
26944 supports Microsoft's &'Secure Password Authentication'& mechanism.
26945 The last is an Exim authenticator but not an SMTP one;
26946 instead it can use information from a TLS negotiation.
26947
26948 The authenticators are configured using the same syntax as other drivers (see
26949 section &<<SECTfordricon>>&). If no authenticators are required, no
26950 authentication section need be present in the configuration file. Each
26951 authenticator can in principle have both server and client functions. When Exim
26952 is receiving SMTP mail, it is acting as a server; when it is sending out
26953 messages over SMTP, it is acting as a client. Authenticator configuration
26954 options are provided for use in both these circumstances.
26955
26956 To make it clear which options apply to which situation, the prefixes
26957 &%server_%& and &%client_%& are used on option names that are specific to
26958 either the server or the client function, respectively. Server and client
26959 functions are disabled if none of their options are set. If an authenticator is
26960 to be used for both server and client functions, a single definition, using
26961 both sets of options, is required. For example:
26962 .code
26963 cram:
26964   driver = cram_md5
26965   public_name = CRAM-MD5
26966   server_secret = ${if eq{$auth1}{ph10}{secret1}fail}
26967   client_name = ph10
26968   client_secret = secret2
26969 .endd
26970 The &%server_%& option is used when Exim is acting as a server, and the
26971 &%client_%& options when it is acting as a client.
26972
26973 Descriptions of the individual authenticators are given in subsequent chapters.
26974 The remainder of this chapter covers the generic options for the
26975 authenticators, followed by general discussion of the way authentication works
26976 in Exim.
26977
26978 &*Beware:*& the meaning of &$auth1$&, &$auth2$&, ... varies on a per-driver and
26979 per-mechanism basis.  Please read carefully to determine which variables hold
26980 account labels such as usercodes and which hold passwords or other
26981 authenticating data.
26982
26983 Note that some mechanisms support two different identifiers for accounts: the
26984 &'authentication id'& and the &'authorization id'&.  The contractions &'authn'&
26985 and &'authz'& are commonly encountered.  The American spelling is standard here.
26986 Conceptually, authentication data such as passwords are tied to the identifier
26987 used to authenticate; servers may have rules to permit one user to act as a
26988 second user, so that after login the session is treated as though that second
26989 user had logged in.  That second user is the &'authorization id'&.  A robust
26990 configuration might confirm that the &'authz'& field is empty or matches the
26991 &'authn'& field.  Often this is just ignored.  The &'authn'& can be considered
26992 as verified data, the &'authz'& as an unverified request which the server might
26993 choose to honour.
26994
26995 A &'realm'& is a text string, typically a domain name, presented by a server
26996 to a client to help it select an account and credentials to use.  In some
26997 mechanisms, the client and server provably agree on the realm, but clients
26998 typically can not treat the realm as secure data to be blindly trusted.
26999
27000
27001
27002 .section "Generic options for authenticators" "SECID168"
27003 .cindex "authentication" "generic options"
27004 .cindex "options" "generic; for authenticators"
27005
27006 .option client_condition authenticators string&!! unset
27007 When Exim is authenticating as a client, it skips any authenticator whose
27008 &%client_condition%& expansion yields &"0"&, &"no"&, or &"false"&. This can be
27009 used, for example, to skip plain text authenticators when the connection is not
27010 encrypted by a setting such as:
27011 .code
27012 client_condition = ${if !eq{$tls_out_cipher}{}}
27013 .endd
27014
27015
27016 .option client_set_id authenticators string&!! unset
27017 When client authentication succeeds, this condition is expanded; the
27018 result is used in the log lines for outbound messages.
27019 Typically it will be the user name used for authentication.
27020
27021
27022 .option driver authenticators string unset
27023 This option must always be set. It specifies which of the available
27024 authenticators is to be used.
27025
27026
27027 .option public_name authenticators string unset
27028 This option specifies the name of the authentication mechanism that the driver
27029 implements, and by which it is known to the outside world. These names should
27030 contain only upper case letters, digits, underscores, and hyphens (RFC 2222),
27031 but Exim in fact matches them caselessly. If &%public_name%& is not set, it
27032 defaults to the driver's instance name.
27033
27034
27035 .option server_advertise_condition authenticators string&!! unset
27036 When a server is about to advertise an authentication mechanism, the condition
27037 is expanded. If it yields the empty string, &"0"&, &"no"&, or &"false"&, the
27038 mechanism is not advertised.
27039 If the expansion fails, the mechanism is not advertised. If the failure was not
27040 forced, and was not caused by a lookup defer, the incident is logged.
27041 See section &<<SECTauthexiser>>& below for further discussion.
27042
27043
27044 .option server_condition authenticators string&!! unset
27045 This option must be set for a &%plaintext%& server authenticator, where it
27046 is used directly to control authentication. See section &<<SECTplainserver>>&
27047 for details.
27048
27049 For the &(gsasl)& authenticator, this option is required for various
27050 mechanisms; see chapter &<<CHAPgsasl>>& for details.
27051
27052 For the other authenticators, &%server_condition%& can be used as an additional
27053 authentication or authorization mechanism that is applied after the other
27054 authenticator conditions succeed. If it is set, it is expanded when the
27055 authenticator would otherwise return a success code. If the expansion is forced
27056 to fail, authentication fails. Any other expansion failure causes a temporary
27057 error code to be returned. If the result of a successful expansion is an empty
27058 string, &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
27059 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds. For any
27060 other result, a temporary error code is returned, with the expanded string as
27061 the error text.
27062
27063
27064 .option server_debug_print authenticators string&!! unset
27065 If this option is set and authentication debugging is enabled (see the &%-d%&
27066 command line option), the string is expanded and included in the debugging
27067 output when the authenticator is run as a server. This can help with checking
27068 out the values of variables.
27069 If expansion of the string fails, the error message is written to the debugging
27070 output, and Exim carries on processing.
27071
27072
27073 .option server_set_id authenticators string&!! unset
27074 .vindex "&$authenticated_id$&"
27075 .vindex "&$authenticated_fail_id$&"
27076 When an Exim server successfully authenticates a client, this string is
27077 expanded using data from the authentication, and preserved for any incoming
27078 messages in the variable &$authenticated_id$&. It is also included in the log
27079 lines for incoming messages. For example, a user/password authenticator
27080 configuration might preserve the user name that was used to authenticate, and
27081 refer to it subsequently during delivery of the message.
27082 On a failing authentication the expansion result is instead saved in
27083 the &$authenticated_fail_id$& variable.
27084 If expansion fails, the option is ignored.
27085
27086
27087 .option server_mail_auth_condition authenticators string&!! unset
27088 This option allows a server to discard authenticated sender addresses supplied
27089 as part of MAIL commands in SMTP connections that are authenticated by the
27090 driver on which &%server_mail_auth_condition%& is set. The option is not used
27091 as part of the authentication process; instead its (unexpanded) value is
27092 remembered for later use.
27093 How it is used is described in the following section.
27094
27095
27096
27097
27098
27099 .section "The AUTH parameter on MAIL commands" "SECTauthparamail"
27100 .cindex "authentication" "sender; authenticated"
27101 .cindex "AUTH" "on MAIL command"
27102 When a client supplied an AUTH= item on a MAIL command, Exim applies
27103 the following checks before accepting it as the authenticated sender of the
27104 message:
27105
27106 .ilist
27107 If the connection is not using extended SMTP (that is, HELO was used rather
27108 than EHLO), the use of AUTH= is a syntax error.
27109 .next
27110 If the value of the AUTH= parameter is &"<>"&, it is ignored.
27111 .next
27112 .vindex "&$authenticated_sender$&"
27113 If &%acl_smtp_mailauth%& is defined, the ACL it specifies is run. While it is
27114 running, the value of &$authenticated_sender$& is set to the value obtained
27115 from the AUTH= parameter. If the ACL does not yield &"accept"&, the value of
27116 &$authenticated_sender$& is deleted. The &%acl_smtp_mailauth%& ACL may not
27117 return &"drop"& or &"discard"&. If it defers, a temporary error code (451) is
27118 given for the MAIL command.
27119 .next
27120 If &%acl_smtp_mailauth%& is not defined, the value of the AUTH= parameter
27121 is accepted and placed in &$authenticated_sender$& only if the client has
27122 authenticated.
27123 .next
27124 If the AUTH= value was accepted by either of the two previous rules, and
27125 the client has authenticated, and the authenticator has a setting for the
27126 &%server_mail_auth_condition%&, the condition is checked at this point. The
27127 valued that was saved from the authenticator is expanded. If the expansion
27128 fails, or yields an empty string, &"0"&, &"no"&, or &"false"&, the value of
27129 &$authenticated_sender$& is deleted. If the expansion yields any other value,
27130 the value of &$authenticated_sender$& is retained and passed on with the
27131 message.
27132 .endlist
27133
27134
27135 When &$authenticated_sender$& is set for a message, it is passed on to other
27136 hosts to which Exim authenticates as a client. Do not confuse this value with
27137 &$authenticated_id$&, which is a string obtained from the authentication
27138 process, and which is not usually a complete email address.
27139
27140 .vindex "&$sender_address$&"
27141 Whenever an AUTH= value is ignored, the incident is logged. The ACL for
27142 MAIL, if defined, is run after AUTH= is accepted or ignored. It can
27143 therefore make use of &$authenticated_sender$&. The converse is not true: the
27144 value of &$sender_address$& is not yet set up when the &%acl_smtp_mailauth%&
27145 ACL is run.
27146
27147
27148
27149 .section "Authentication on an Exim server" "SECTauthexiser"
27150 .cindex "authentication" "on an Exim server"
27151 When Exim receives an EHLO command, it advertises the public names of those
27152 authenticators that are configured as servers, subject to the following
27153 conditions:
27154
27155 .ilist
27156 The client host must match &%auth_advertise_hosts%& (default *).
27157 .next
27158 It the &%server_advertise_condition%& option is set, its expansion must not
27159 yield the empty string, &"0"&, &"no"&, or &"false"&.
27160 .endlist
27161
27162 The order in which the authenticators are defined controls the order in which
27163 the mechanisms are advertised.
27164
27165 Some mail clients (for example, some versions of Netscape) require the user to
27166 provide a name and password for authentication whenever AUTH is advertised,
27167 even though authentication may not in fact be needed (for example, Exim may be
27168 set up to allow unconditional relaying from the client by an IP address check).
27169 You can make such clients more friendly by not advertising AUTH to them.
27170 For example, if clients on the 10.9.8.0/24 network are permitted (by the ACL
27171 that runs for RCPT) to relay without authentication, you should set
27172 .code
27173 auth_advertise_hosts = ! 10.9.8.0/24
27174 .endd
27175 so that no authentication mechanisms are advertised to them.
27176
27177 The &%server_advertise_condition%& controls the advertisement of individual
27178 authentication mechanisms. For example, it can be used to restrict the
27179 advertisement of a particular mechanism to encrypted connections, by a setting
27180 such as:
27181 .code
27182 server_advertise_condition = ${if eq{$tls_in_cipher}{}{no}{yes}}
27183 .endd
27184 .vindex "&$tls_in_cipher$&"
27185 If the session is encrypted, &$tls_in_cipher$& is not empty, and so the expansion
27186 yields &"yes"&, which allows the advertisement to happen.
27187
27188 When an Exim server receives an AUTH command from a client, it rejects it
27189 immediately if AUTH was not advertised in response to an earlier EHLO
27190 command. This is the case if
27191
27192 .ilist
27193 The client host does not match &%auth_advertise_hosts%&; or
27194 .next
27195 No authenticators are configured with server options; or
27196 .next
27197 Expansion of &%server_advertise_condition%& blocked the advertising of all the
27198 server authenticators.
27199 .endlist
27200
27201
27202 Otherwise, Exim runs the ACL specified by &%acl_smtp_auth%& in order
27203 to decide whether to accept the command. If &%acl_smtp_auth%& is not set,
27204 AUTH is accepted from any client host.
27205
27206 If AUTH is not rejected by the ACL, Exim searches its configuration for a
27207 server authentication mechanism that was advertised in response to EHLO and
27208 that matches the one named in the AUTH command. If it finds one, it runs
27209 the appropriate authentication protocol, and authentication either succeeds or
27210 fails. If there is no matching advertised mechanism, the AUTH command is
27211 rejected with a 504 error.
27212
27213 .vindex "&$received_protocol$&"
27214 .vindex "&$sender_host_authenticated$&"
27215 When a message is received from an authenticated host, the value of
27216 &$received_protocol$& is set to &"esmtpa"& or &"esmtpsa"& instead of &"esmtp"&
27217 or &"esmtps"&, and &$sender_host_authenticated$& contains the name (not the
27218 public name) of the authenticator driver that successfully authenticated the
27219 client from which the message was received. This variable is empty if there was
27220 no successful authentication.
27221
27222 .cindex authentication "expansion item"
27223 Successful authentication sets up information used by the
27224 &%authresults%& expansion item.
27225
27226
27227
27228
27229 .section "Testing server authentication" "SECID169"
27230 .cindex "authentication" "testing a server"
27231 .cindex "AUTH" "testing a server"
27232 .cindex "base64 encoding" "creating authentication test data"
27233 Exim's &%-bh%& option can be useful for testing server authentication
27234 configurations. The data for the AUTH command has to be sent using base64
27235 encoding. A quick way to produce such data for testing is the following Perl
27236 script:
27237 .code
27238 use MIME::Base64;
27239 printf ("%s", encode_base64(eval "\"$ARGV[0]\""));
27240 .endd
27241 .cindex "binary zero" "in authentication data"
27242 This interprets its argument as a Perl string, and then encodes it. The
27243 interpretation as a Perl string allows binary zeros, which are required for
27244 some kinds of authentication, to be included in the data. For example, a
27245 command line to run this script on such data might be
27246 .code
27247 encode '\0user\0password'
27248 .endd
27249 Note the use of single quotes to prevent the shell interpreting the
27250 backslashes, so that they can be interpreted by Perl to specify characters
27251 whose code value is zero.
27252
27253 &*Warning 1*&: If either of the user or password strings starts with an octal
27254 digit, you must use three zeros instead of one after the leading backslash. If
27255 you do not, the octal digit that starts your string will be incorrectly
27256 interpreted as part of the code for the first character.
27257
27258 &*Warning 2*&: If there are characters in the strings that Perl interprets
27259 specially, you must use a Perl escape to prevent them being misinterpreted. For
27260 example, a command such as
27261 .code
27262 encode '\0user@domain.com\0pas$$word'
27263 .endd
27264 gives an incorrect answer because of the unescaped &"@"& and &"$"& characters.
27265
27266 If you have the &%mimencode%& command installed, another way to do produce
27267 base64-encoded strings is to run the command
27268 .code
27269 echo -e -n `\0user\0password' | mimencode
27270 .endd
27271 The &%-e%& option of &%echo%& enables the interpretation of backslash escapes
27272 in the argument, and the &%-n%& option specifies no newline at the end of its
27273 output. However, not all versions of &%echo%& recognize these options, so you
27274 should check your version before relying on this suggestion.
27275
27276
27277
27278 .section "Authentication by an Exim client" "SECID170"
27279 .cindex "authentication" "on an Exim client"
27280 The &(smtp)& transport has two options called &%hosts_require_auth%& and
27281 &%hosts_try_auth%&. When the &(smtp)& transport connects to a server that
27282 announces support for authentication, and the host matches an entry in either
27283 of these options, Exim (as a client) tries to authenticate as follows:
27284
27285 .ilist
27286 For each authenticator that is configured as a client, in the order in which
27287 they are defined in the configuration, it searches the authentication
27288 mechanisms announced by the server for one whose name matches the public name
27289 of the authenticator.
27290 .next
27291 .vindex "&$host$&"
27292 .vindex "&$host_address$&"
27293 When it finds one that matches, it runs the authenticator's client code. The
27294 variables &$host$& and &$host_address$& are available for any string expansions
27295 that the client might do. They are set to the server's name and IP address. If
27296 any expansion is forced to fail, the authentication attempt is abandoned, and
27297 Exim moves on to the next authenticator. Otherwise an expansion failure causes
27298 delivery to be deferred.
27299 .next
27300 If the result of the authentication attempt is a temporary error or a timeout,
27301 Exim abandons trying to send the message to the host for the moment. It will
27302 try again later. If there are any backup hosts available, they are tried in the
27303 usual way.
27304 .next
27305 If the response to authentication is a permanent error (5&'xx'& code), Exim
27306 carries on searching the list of authenticators and tries another one if
27307 possible. If all authentication attempts give permanent errors, or if there are
27308 no attempts because no mechanisms match (or option expansions force failure),
27309 what happens depends on whether the host matches &%hosts_require_auth%& or
27310 &%hosts_try_auth%&. In the first case, a temporary error is generated, and
27311 delivery is deferred. The error can be detected in the retry rules, and thereby
27312 turned into a permanent error if you wish. In the second case, Exim tries to
27313 deliver the message unauthenticated.
27314 .endlist
27315
27316 Note that the hostlist test for whether to do authentication can be
27317 confused if name-IP lookups change between the time the peer is decided
27318 upon and the time that the transport runs.  For example, with a manualroute
27319 router given a host name, and with DNS "round-robin" used by that name: if
27320 the local resolver cache times out between the router and the transport
27321 running, the transport may get an IP for the name for its authentication
27322 check which does not match the connection peer IP.
27323 No authentication will then be done, despite the names being identical.
27324
27325 For such cases use a separate transport which always authenticates.
27326
27327 .cindex "AUTH" "on MAIL command"
27328 When Exim has authenticated itself to a remote server, it adds the AUTH
27329 parameter to the MAIL commands it sends, if it has an authenticated sender for
27330 the message. If the message came from a remote host, the authenticated sender
27331 is the one that was receiving on an incoming MAIL command, provided that the
27332 incoming connection was authenticated and the &%server_mail_auth%& condition
27333 allowed the authenticated sender to be retained. If a local process calls Exim
27334 to send a message, the sender address that is built from the login name and
27335 &%qualify_domain%& is treated as authenticated. However, if the
27336 &%authenticated_sender%& option is set on the &(smtp)& transport, it overrides
27337 the authenticated sender that was received with the message.
27338 .ecindex IIDauthconf1
27339 .ecindex IIDauthconf2
27340
27341
27342
27343
27344
27345
27346 . ////////////////////////////////////////////////////////////////////////////
27347 . ////////////////////////////////////////////////////////////////////////////
27348
27349 .chapter "The plaintext authenticator" "CHAPplaintext"
27350 .scindex IIDplaiauth1 "&(plaintext)& authenticator"
27351 .scindex IIDplaiauth2 "authenticators" "&(plaintext)&"
27352 The &(plaintext)& authenticator can be configured to support the PLAIN and
27353 LOGIN authentication mechanisms, both of which transfer authentication data as
27354 plain (unencrypted) text (though base64 encoded). The use of plain text is a
27355 security risk; you are strongly advised to insist on the use of SMTP encryption
27356 (see chapter &<<CHAPTLS>>&) if you use the PLAIN or LOGIN mechanisms. If you do
27357 use unencrypted plain text, you should not use the same passwords for SMTP
27358 connections as you do for login accounts.
27359
27360 .section "Avoiding cleartext use" "SECTplain_TLS"
27361 The following generic option settings will disable &(plaintext)& authenticators when
27362 TLS is not being used:
27363 .code
27364   server_advertise_condition = ${if def:tls_in_cipher }
27365   client_condition =           ${if def:tls_out_cipher}
27366 .endd
27367
27368 &*Note*&: a plaintext SMTP AUTH done inside TLS is not vulnerable to casual snooping,
27369 but is still vulnerable to a Man In The Middle attack unless certificates
27370 (including their names) have been properly verified.
27371
27372 .section "Plaintext server options" "SECID171"
27373 .cindex "options" "&(plaintext)& authenticator (server)"
27374 When configured as a server, &(plaintext)& uses the following options:
27375
27376 .option server_condition authenticators string&!! unset
27377 This is actually a global authentication option, but it must be set in order to
27378 configure the &(plaintext)& driver as a server. Its use is described below.
27379
27380 .option server_prompts plaintext "string list&!!" unset
27381 The contents of this option, after expansion, must be a colon-separated list of
27382 prompt strings. If expansion fails, a temporary authentication rejection is
27383 given.
27384
27385 .section "Using plaintext in a server" "SECTplainserver"
27386 .cindex "AUTH" "in &(plaintext)& authenticator"
27387 .cindex "binary zero" "in &(plaintext)& authenticator"
27388 .cindex "numerical variables (&$1$& &$2$& etc)" &&&
27389         "in &(plaintext)& authenticator"
27390 .vindex "&$auth1$&, &$auth2$&, etc"
27391 .cindex "base64 encoding" "in &(plaintext)& authenticator"
27392
27393 When running as a server, &(plaintext)& performs the authentication test by
27394 expanding a string. The data sent by the client with the AUTH command, or in
27395 response to subsequent prompts, is base64 encoded, and so may contain any byte
27396 values when decoded. If any data is supplied with the command, it is treated as
27397 a list of strings, separated by NULs (binary zeros), the first three of which
27398 are placed in the expansion variables &$auth1$&, &$auth2$&, and &$auth3$&
27399 (neither LOGIN nor PLAIN uses more than three strings).
27400
27401 For compatibility with previous releases of Exim, the values are also placed in
27402 the expansion variables &$1$&, &$2$&, and &$3$&. However, the use of these
27403 variables for this purpose is now deprecated, as it can lead to confusion in
27404 string expansions that also use them for other things.
27405
27406 If there are more strings in &%server_prompts%& than the number of strings
27407 supplied with the AUTH command, the remaining prompts are used to obtain more
27408 data. Each response from the client may be a list of NUL-separated strings.
27409
27410 .vindex "&$authenticated_id$&"
27411 Once a sufficient number of data strings have been received,
27412 &%server_condition%& is expanded. If the expansion is forced to fail,
27413 authentication fails. Any other expansion failure causes a temporary error code
27414 to be returned. If the result of a successful expansion is an empty string,
27415 &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
27416 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds and the
27417 generic &%server_set_id%& option is expanded and saved in &$authenticated_id$&.
27418 For any other result, a temporary error code is returned, with the expanded
27419 string as the error text.
27420
27421 &*Warning*&: If you use a lookup in the expansion to find the user's
27422 password, be sure to make the authentication fail if the user is unknown.
27423 There are good and bad examples at the end of the next section.
27424
27425
27426
27427 .section "The PLAIN authentication mechanism" "SECID172"
27428 .cindex "PLAIN authentication mechanism"
27429 .cindex authentication PLAIN
27430 .cindex "binary zero" "in &(plaintext)& authenticator"
27431 The PLAIN authentication mechanism (RFC 2595) specifies that three strings be
27432 sent as one item of data (that is, one combined string containing two NUL
27433 separators). The data is sent either as part of the AUTH command, or
27434 subsequently in response to an empty prompt from the server.
27435
27436 The second and third strings are a user name and a corresponding password.
27437 Using a single fixed user name and password as an example, this could be
27438 configured as follows:
27439 .code
27440 fixed_plain:
27441   driver = plaintext
27442   public_name = PLAIN
27443   server_prompts = :
27444   server_condition = \
27445     ${if and {{eq{$auth2}{username}}{eq{$auth3}{mysecret}}}}
27446   server_set_id = $auth2
27447 .endd
27448 Note that the default result strings from &%if%& (&"true"& or an empty string)
27449 are exactly what we want here, so they need not be specified. Obviously, if the
27450 password contains expansion-significant characters such as dollar, backslash,
27451 or closing brace, they have to be escaped.
27452
27453 The &%server_prompts%& setting specifies a single, empty prompt (empty items at
27454 the end of a string list are ignored). If all the data comes as part of the
27455 AUTH command, as is commonly the case, the prompt is not used. This
27456 authenticator is advertised in the response to EHLO as
27457 .code
27458 250-AUTH PLAIN
27459 .endd
27460 and a client host can authenticate itself by sending the command
27461 .code
27462 AUTH PLAIN AHVzZXJuYW1lAG15c2VjcmV0
27463 .endd
27464 As this contains three strings (more than the number of prompts), no further
27465 data is required from the client. Alternatively, the client may just send
27466 .code
27467 AUTH PLAIN
27468 .endd
27469 to initiate authentication, in which case the server replies with an empty
27470 prompt. The client must respond with the combined data string.
27471
27472 The data string is base64 encoded, as required by the RFC. This example,
27473 when decoded, is <&'NUL'&>&`username`&<&'NUL'&>&`mysecret`&, where <&'NUL'&>
27474 represents a zero byte. This is split up into three strings, the first of which
27475 is empty. The &%server_condition%& option in the authenticator checks that the
27476 second two are &`username`& and &`mysecret`& respectively.
27477
27478 Having just one fixed user name and password, as in this example, is not very
27479 realistic, though for a small organization with only a handful of
27480 authenticating clients it could make sense.
27481
27482 A more sophisticated instance of this authenticator could use the user name in
27483 &$auth2$& to look up a password in a file or database, and maybe do an encrypted
27484 comparison (see &%crypteq%& in chapter &<<CHAPexpand>>&). Here is a example of
27485 this approach, where the passwords are looked up in a DBM file. &*Warning*&:
27486 This is an incorrect example:
27487 .code
27488 server_condition = \
27489   ${if eq{$auth3}{${lookup{$auth2}dbm{/etc/authpwd}}}}
27490 .endd
27491 The expansion uses the user name (&$auth2$&) as the key to look up a password,
27492 which it then compares to the supplied password (&$auth3$&). Why is this example
27493 incorrect? It works fine for existing users, but consider what happens if a
27494 non-existent user name is given. The lookup fails, but as no success/failure
27495 strings are given for the lookup, it yields an empty string. Thus, to defeat
27496 the authentication, all a client has to do is to supply a non-existent user
27497 name and an empty password. The correct way of writing this test is:
27498 .code
27499 server_condition = ${lookup{$auth2}dbm{/etc/authpwd}\
27500   {${if eq{$value}{$auth3}}} {false}}
27501 .endd
27502 In this case, if the lookup succeeds, the result is checked; if the lookup
27503 fails, &"false"& is returned and authentication fails. If &%crypteq%& is being
27504 used instead of &%eq%&, the first example is in fact safe, because &%crypteq%&
27505 always fails if its second argument is empty. However, the second way of
27506 writing the test makes the logic clearer.
27507
27508
27509 .section "The LOGIN authentication mechanism" "SECID173"
27510 .cindex "LOGIN authentication mechanism"
27511 .cindex authentication LOGIN
27512 The LOGIN authentication mechanism is not documented in any RFC, but is in use
27513 in a number of programs. No data is sent with the AUTH command. Instead, a
27514 user name and password are supplied separately, in response to prompts. The
27515 plaintext authenticator can be configured to support this as in this example:
27516 .code
27517 fixed_login:
27518   driver = plaintext
27519   public_name = LOGIN
27520   server_prompts = User Name : Password
27521   server_condition = \
27522     ${if and {{eq{$auth1}{username}}{eq{$auth2}{mysecret}}}}
27523   server_set_id = $auth1
27524 .endd
27525 Because of the way plaintext operates, this authenticator accepts data supplied
27526 with the AUTH command (in contravention of the specification of LOGIN), but
27527 if the client does not supply it (as is the case for LOGIN clients), the prompt
27528 strings are used to obtain two data items.
27529
27530 Some clients are very particular about the precise text of the prompts. For
27531 example, Outlook Express is reported to recognize only &"Username:"& and
27532 &"Password:"&. Here is an example of a LOGIN authenticator that uses those
27533 strings. It uses the &%ldapauth%& expansion condition to check the user
27534 name and password by binding to an LDAP server:
27535 .code
27536 login:
27537   driver = plaintext
27538   public_name = LOGIN
27539   server_prompts = Username:: : Password::
27540   server_condition = ${if and{{ \
27541     !eq{}{$auth1} }{ \
27542     ldapauth{\
27543       user="uid=${quote_ldap_dn:$auth1},ou=people,o=example.org" \
27544       pass=${quote:$auth2} \
27545       ldap://ldap.example.org/} }} }
27546   server_set_id = uid=$auth1,ou=people,o=example.org
27547 .endd
27548 We have to check that the username is not empty before using it, because LDAP
27549 does not permit empty DN components. We must also use the &%quote_ldap_dn%&
27550 operator to correctly quote the DN for authentication. However, the basic
27551 &%quote%& operator, rather than any of the LDAP quoting operators, is the
27552 correct one to use for the password, because quoting is needed only to make
27553 the password conform to the Exim syntax. At the LDAP level, the password is an
27554 uninterpreted string.
27555
27556
27557 .section "Support for different kinds of authentication" "SECID174"
27558 A number of string expansion features are provided for the purpose of
27559 interfacing to different ways of user authentication. These include checking
27560 traditionally encrypted passwords from &_/etc/passwd_& (or equivalent), PAM,
27561 Radius, &%ldapauth%&, &'pwcheck'&, and &'saslauthd'&. For details see section
27562 &<<SECTexpcond>>&.
27563
27564
27565
27566
27567 .section "Using plaintext in a client" "SECID175"
27568 .cindex "options" "&(plaintext)& authenticator (client)"
27569 The &(plaintext)& authenticator has two client options:
27570
27571 .option client_ignore_invalid_base64 plaintext boolean false
27572 If the client receives a server prompt that is not a valid base64 string,
27573 authentication is abandoned by default. However, if this option is set true,
27574 the error in the challenge is ignored and the client sends the response as
27575 usual.
27576
27577 .option client_send plaintext string&!! unset
27578 The string is a colon-separated list of authentication data strings. Each
27579 string is independently expanded before being sent to the server. The first
27580 string is sent with the AUTH command; any more strings are sent in response
27581 to prompts from the server. Before each string is expanded, the value of the
27582 most recent prompt is placed in the next &$auth$&<&'n'&> variable, starting
27583 with &$auth1$& for the first prompt. Up to three prompts are stored in this
27584 way. Thus, the prompt that is received in response to sending the first string
27585 (with the AUTH command) can be used in the expansion of the second string, and
27586 so on. If an invalid base64 string is received when
27587 &%client_ignore_invalid_base64%& is set, an empty string is put in the
27588 &$auth$&<&'n'&> variable.
27589
27590 &*Note*&: You cannot use expansion to create multiple strings, because
27591 splitting takes priority and happens first.
27592
27593 Because the PLAIN authentication mechanism requires NUL (binary zero) bytes in
27594 the data, further processing is applied to each string before it is sent. If
27595 there are any single circumflex characters in the string, they are converted to
27596 NULs. Should an actual circumflex be required as data, it must be doubled in
27597 the string.
27598
27599 This is an example of a client configuration that implements the PLAIN
27600 authentication mechanism with a fixed user name and password:
27601 .code
27602 fixed_plain:
27603   driver = plaintext
27604   public_name = PLAIN
27605   client_send = ^username^mysecret
27606 .endd
27607 The lack of colons means that the entire text is sent with the AUTH
27608 command, with the circumflex characters converted to NULs. A similar example
27609 that uses the LOGIN mechanism is:
27610 .code
27611 fixed_login:
27612   driver = plaintext
27613   public_name = LOGIN
27614   client_send = : username : mysecret
27615 .endd
27616 The initial colon means that the first string is empty, so no data is sent with
27617 the AUTH command itself. The remaining strings are sent in response to
27618 prompts.
27619 .ecindex IIDplaiauth1
27620 .ecindex IIDplaiauth2
27621
27622
27623
27624
27625 . ////////////////////////////////////////////////////////////////////////////
27626 . ////////////////////////////////////////////////////////////////////////////
27627
27628 .chapter "The cram_md5 authenticator" "CHID9"
27629 .scindex IIDcramauth1 "&(cram_md5)& authenticator"
27630 .scindex IIDcramauth2 "authenticators" "&(cram_md5)&"
27631 .cindex "CRAM-MD5 authentication mechanism"
27632 .cindex authentication CRAM-MD5
27633 The CRAM-MD5 authentication mechanism is described in RFC 2195. The server
27634 sends a challenge string to the client, and the response consists of a user
27635 name and the CRAM-MD5 digest of the challenge string combined with a secret
27636 string (password) which is known to both server and client. Thus, the secret
27637 is not sent over the network as plain text, which makes this authenticator more
27638 secure than &(plaintext)&. However, the downside is that the secret has to be
27639 available in plain text at either end.
27640
27641
27642 .section "Using cram_md5 as a server" "SECID176"
27643 .cindex "options" "&(cram_md5)& authenticator (server)"
27644 This authenticator has one server option, which must be set to configure the
27645 authenticator as a server:
27646
27647 .option server_secret cram_md5 string&!! unset
27648 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(cram_md5)& authenticator"
27649 When the server receives the client's response, the user name is placed in
27650 the expansion variable &$auth1$&, and &%server_secret%& is expanded to
27651 obtain the password for that user. The server then computes the CRAM-MD5 digest
27652 that the client should have sent, and checks that it received the correct
27653 string. If the expansion of &%server_secret%& is forced to fail, authentication
27654 fails. If the expansion fails for some other reason, a temporary error code is
27655 returned to the client.
27656
27657 For compatibility with previous releases of Exim, the user name is also placed
27658 in &$1$&. However, the use of this variables for this purpose is now
27659 deprecated, as it can lead to confusion in string expansions that also use
27660 numeric variables for other things.
27661
27662 For example, the following authenticator checks that the user name given by the
27663 client is &"ph10"&, and if so, uses &"secret"& as the password. For any other
27664 user name, authentication fails.
27665 .code
27666 fixed_cram:
27667   driver = cram_md5
27668   public_name = CRAM-MD5
27669   server_secret = ${if eq{$auth1}{ph10}{secret}fail}
27670   server_set_id = $auth1
27671 .endd
27672 .vindex "&$authenticated_id$&"
27673 If authentication succeeds, the setting of &%server_set_id%& preserves the user
27674 name in &$authenticated_id$&. A more typical configuration might look up the
27675 secret string in a file, using the user name as the key. For example:
27676 .code
27677 lookup_cram:
27678   driver = cram_md5
27679   public_name = CRAM-MD5
27680   server_secret = ${lookup{$auth1}lsearch{/etc/authpwd}\
27681                   {$value}fail}
27682   server_set_id = $auth1
27683 .endd
27684 Note that this expansion explicitly forces failure if the lookup fails
27685 because &$auth1$& contains an unknown user name.
27686
27687 As another example, if you wish to re-use a Cyrus SASL sasldb2 file without
27688 using the relevant libraries, you need to know the realm to specify in the
27689 lookup and then ask for the &"userPassword"& attribute for that user in that
27690 realm, with:
27691 .code
27692 cyrusless_crammd5:
27693   driver = cram_md5
27694   public_name = CRAM-MD5
27695   server_secret = ${lookup{$auth1:mail.example.org:userPassword}\
27696                   dbmjz{/etc/sasldb2}{$value}fail}
27697   server_set_id = $auth1
27698 .endd
27699
27700 .section "Using cram_md5 as a client" "SECID177"
27701 .cindex "options" "&(cram_md5)& authenticator (client)"
27702 When used as a client, the &(cram_md5)& authenticator has two options:
27703
27704
27705
27706 .option client_name cram_md5 string&!! "the primary host name"
27707 This string is expanded, and the result used as the user name data when
27708 computing the response to the server's challenge.
27709
27710
27711 .option client_secret cram_md5 string&!! unset
27712 This option must be set for the authenticator to work as a client. Its value is
27713 expanded and the result used as the secret string when computing the response.
27714
27715
27716 .vindex "&$host$&"
27717 .vindex "&$host_address$&"
27718 Different user names and secrets can be used for different servers by referring
27719 to &$host$& or &$host_address$& in the options. Forced failure of either
27720 expansion string is treated as an indication that this authenticator is not
27721 prepared to handle this case. Exim moves on to the next configured client
27722 authenticator. Any other expansion failure causes Exim to give up trying to
27723 send the message to the current server.
27724
27725 A simple example configuration of a &(cram_md5)& authenticator, using fixed
27726 strings, is:
27727 .code
27728 fixed_cram:
27729   driver = cram_md5
27730   public_name = CRAM-MD5
27731   client_name = ph10
27732   client_secret = secret
27733 .endd
27734 .ecindex IIDcramauth1
27735 .ecindex IIDcramauth2
27736
27737
27738
27739 . ////////////////////////////////////////////////////////////////////////////
27740 . ////////////////////////////////////////////////////////////////////////////
27741
27742 .chapter "The cyrus_sasl authenticator" "CHID10"
27743 .scindex IIDcyrauth1 "&(cyrus_sasl)& authenticator"
27744 .scindex IIDcyrauth2 "authenticators" "&(cyrus_sasl)&"
27745 .cindex "Cyrus" "SASL library"
27746 .cindex "Kerberos"
27747 The code for this authenticator was provided by Matthew Byng-Maddick while
27748 at A L Digital Ltd.
27749
27750 The &(cyrus_sasl)& authenticator provides server support for the Cyrus SASL
27751 library implementation of the RFC 2222 (&"Simple Authentication and Security
27752 Layer"&). This library supports a number of authentication mechanisms,
27753 including PLAIN and LOGIN, but also several others that Exim does not support
27754 directly. In particular, there is support for Kerberos authentication.
27755
27756 The &(cyrus_sasl)& authenticator provides a gatewaying mechanism directly to
27757 the Cyrus interface, so if your Cyrus library can do, for example, CRAM-MD5,
27758 then so can the &(cyrus_sasl)& authenticator. By default it uses the public
27759 name of the driver to determine which mechanism to support.
27760
27761 Where access to some kind of secret file is required, for example, in GSSAPI
27762 or CRAM-MD5, it is worth noting that the authenticator runs as the Exim
27763 user, and that the Cyrus SASL library has no way of escalating privileges
27764 by default. You may also find you need to set environment variables,
27765 depending on the driver you are using.
27766
27767 The application name provided by Exim is &"exim"&, so various SASL options may
27768 be set in &_exim.conf_& in your SASL directory. If you are using GSSAPI for
27769 Kerberos, note that because of limitations in the GSSAPI interface,
27770 changing the server keytab might need to be communicated down to the Kerberos
27771 layer independently. The mechanism for doing so is dependent upon the Kerberos
27772 implementation.
27773
27774 For example, for older releases of Heimdal, the environment variable KRB5_KTNAME
27775 may be set to point to an alternative keytab file. Exim will pass this
27776 variable through from its own inherited environment when started as root or the
27777 Exim user. The keytab file needs to be readable by the Exim user.
27778 With newer releases of Heimdal, a setuid Exim may cause Heimdal to discard the
27779 environment variable.  In practice, for those releases, the Cyrus authenticator
27780 is not a suitable interface for GSSAPI (Kerberos) support.  Instead, consider
27781 the &(heimdal_gssapi)& authenticator, described in chapter &<<CHAPheimdalgss>>&
27782
27783
27784 .section "Using cyrus_sasl as a server" "SECID178"
27785 The &(cyrus_sasl)& authenticator has four private options. It puts the username
27786 (on a successful authentication) into &$auth1$&. For compatibility with
27787 previous releases of Exim, the username is also placed in &$1$&. However, the
27788 use of this variable for this purpose is now deprecated, as it can lead to
27789 confusion in string expansions that also use numeric variables for other
27790 things.
27791
27792
27793 .option server_hostname cyrus_sasl string&!! "see below"
27794 This option selects the hostname that is used when communicating with the
27795 library. The default value is &`$primary_hostname`&. It is up to the underlying
27796 SASL plug-in what it does with this data.
27797
27798
27799 .option server_mech cyrus_sasl string "see below"
27800 This option selects the authentication mechanism this driver should use. The
27801 default is the value of the generic &%public_name%& option. This option allows
27802 you to use a different underlying mechanism from the advertised name. For
27803 example:
27804 .code
27805 sasl:
27806   driver = cyrus_sasl
27807   public_name = X-ANYTHING
27808   server_mech = CRAM-MD5
27809   server_set_id = $auth1
27810 .endd
27811
27812 .option server_realm cyrus_sasl string&!! unset
27813 This specifies the SASL realm that the server claims to be in.
27814
27815
27816 .option server_service cyrus_sasl string &`smtp`&
27817 This is the SASL service that the server claims to implement.
27818
27819
27820 For straightforward cases, you do not need to set any of the authenticator's
27821 private options. All you need to do is to specify an appropriate mechanism as
27822 the public name. Thus, if you have a SASL library that supports CRAM-MD5 and
27823 PLAIN, you could have two authenticators as follows:
27824 .code
27825 sasl_cram_md5:
27826   driver = cyrus_sasl
27827   public_name = CRAM-MD5
27828   server_set_id = $auth1
27829
27830 sasl_plain:
27831   driver = cyrus_sasl
27832   public_name = PLAIN
27833   server_set_id = $auth2
27834 .endd
27835 Cyrus SASL does implement the LOGIN authentication method, even though it is
27836 not a standard method. It is disabled by default in the source distribution,
27837 but it is present in many binary distributions.
27838 .ecindex IIDcyrauth1
27839 .ecindex IIDcyrauth2
27840
27841
27842
27843
27844 . ////////////////////////////////////////////////////////////////////////////
27845 . ////////////////////////////////////////////////////////////////////////////
27846 .chapter "The dovecot authenticator" "CHAPdovecot"
27847 .scindex IIDdcotauth1 "&(dovecot)& authenticator"
27848 .scindex IIDdcotauth2 "authenticators" "&(dovecot)&"
27849 This authenticator is an interface to the authentication facility of the
27850 Dovecot 2 POP/IMAP server, which can support a number of authentication methods.
27851 Note that Dovecot must be configured to use auth-client not auth-userdb.
27852 If you are using Dovecot to authenticate POP/IMAP clients, it might be helpful
27853 to use the same mechanisms for SMTP authentication. This is a server
27854 authenticator only. There is only one option:
27855
27856 .option server_socket dovecot string unset
27857
27858 This option must specify the UNIX socket that is the interface to Dovecot
27859 authentication. The &%public_name%& option must specify an authentication
27860 mechanism that Dovecot is configured to support. You can have several
27861 authenticators for different mechanisms. For example:
27862 .code
27863 dovecot_plain:
27864   driver = dovecot
27865   public_name = PLAIN
27866   server_socket = /var/run/dovecot/auth-client
27867   server_set_id = $auth1
27868
27869 dovecot_ntlm:
27870   driver = dovecot
27871   public_name = NTLM
27872   server_socket = /var/run/dovecot/auth-client
27873   server_set_id = $auth1
27874 .endd
27875 If the SMTP connection is encrypted, or if &$sender_host_address$& is equal to
27876 &$received_ip_address$& (that is, the connection is local), the &"secured"&
27877 option is passed in the Dovecot authentication command. If, for a TLS
27878 connection, a client certificate has been verified, the &"valid-client-cert"&
27879 option is passed. When authentication succeeds, the identity of the user
27880 who authenticated is placed in &$auth1$&.
27881
27882 .new
27883 The Dovecot configuration to match the above wil look
27884 something like:
27885 .code
27886 conf.d/10-master.conf :-
27887
27888 service auth {
27889 ...
27890 #SASL
27891   unix_listener auth-client {
27892     mode = 0660
27893     user = mail
27894   }
27895 ...
27896 }
27897
27898 conf.d/10-auth.conf :-
27899
27900 auth_mechanisms = plain login ntlm
27901 .endd
27902 .wen
27903
27904 .ecindex IIDdcotauth1
27905 .ecindex IIDdcotauth2
27906
27907
27908 . ////////////////////////////////////////////////////////////////////////////
27909 . ////////////////////////////////////////////////////////////////////////////
27910 .chapter "The gsasl authenticator" "CHAPgsasl"
27911 .scindex IIDgsaslauth1 "&(gsasl)& authenticator"
27912 .scindex IIDgsaslauth2 "authenticators" "&(gsasl)&"
27913 .cindex "authentication" "GNU SASL"
27914 .cindex "authentication" "SASL"
27915 .cindex "authentication" "EXTERNAL"
27916 .cindex "authentication" "ANONYMOUS"
27917 .cindex "authentication" "PLAIN"
27918 .cindex "authentication" "LOGIN"
27919 .cindex "authentication" "DIGEST-MD5"
27920 .cindex "authentication" "CRAM-MD5"
27921 .cindex "authentication" "SCRAM family"
27922 The &(gsasl)& authenticator provides integration for the GNU SASL
27923 library and the mechanisms it provides.  This is new as of the 4.80 release
27924 and there are a few areas where the library does not let Exim smoothly
27925 scale to handle future authentication mechanisms, so no guarantee can be
27926 made that any particular new authentication mechanism will be supported
27927 without code changes in Exim.
27928
27929 .new
27930 The library is expected to add support in an upcoming
27931 realease for the SCRAM-SHA-256 method.
27932 The macro _HAVE_AUTH_GSASL_SCRAM_SHA_256 will be defined
27933 when this happens.
27934
27935
27936 .option client_authz gsasl string&!! unset
27937 This option can be used to supply an &'authorization id'&
27938 which is different to the &'authentication_id'& provided
27939 by &%client_username%& option.
27940 If unset or (after expansion) empty it is not used,
27941 which is the common case.
27942
27943 .option client_channelbinding gsasl boolean false
27944 See &%server_channelbinding%& below.
27945
27946 .option client_password gsasl string&!! unset
27947 This option is exapanded before use, and should result in
27948 the password to be used, in clear.
27949
27950 .option client_username gsasl string&!! unset
27951 This option is exapanded before use, and should result in
27952 the account name to be used.
27953 .wen
27954
27955 .new
27956 .option client_spassword gsasl string&!! unset
27957 If a SCRAM mechanism is being used and this option is set
27958 it is used in preference to &%client_password%&.
27959 The value after expansion should be
27960 a 40 (for SHA-1) or 64 (for SHA-256) character string
27961 with the PBKDF2-prepared password, hex-encoded.
27962 Note that this value will depend on the salt and iteration-count
27963 supplied by the server.
27964 .wen
27965
27966
27967
27968 .option server_channelbinding gsasl boolean false
27969 Do not set this true and rely on the properties
27970 without consulting a cryptographic engineer.
27971
27972 Some authentication mechanisms are able to use external context at both ends
27973 of the session to bind the authentication to that context, and fail the
27974 authentication process if that context differs.  Specifically, some TLS
27975 ciphersuites can provide identifying information about the cryptographic
27976 context.
27977
27978 This should have meant that certificate identity and verification becomes a
27979 non-issue, as a man-in-the-middle attack will cause the correct client and
27980 server to see different identifiers and authentication will fail.
27981
27982 .new
27983 This is
27984 only usable by mechanisms which support "channel binding"; at time of
27985 writing, that's the SCRAM family.
27986 When using this feature the "-PLUS" variants of the method names need to be used.
27987 .wen
27988
27989 This defaults off to ensure smooth upgrade across Exim releases, in case
27990 this option causes some clients to start failing.  Some future release
27991 of Exim might have switched the default to be true.
27992
27993 However, Channel Binding in TLS has proven to be vulnerable in current versions.
27994 Do not plan to rely upon this feature for security, ever, without consulting
27995 with a subject matter expert (a cryptographic engineer).
27996
27997
27998 .option server_hostname gsasl string&!! "see below"
27999 This option selects the hostname that is used when communicating with the
28000 library. The default value is &`$primary_hostname`&.
28001 Some mechanisms will use this data.
28002
28003
28004 .option server_mech gsasl string "see below"
28005 This option selects the authentication mechanism this driver should use. The
28006 default is the value of the generic &%public_name%& option. This option allows
28007 you to use a different underlying mechanism from the advertised name. For
28008 example:
28009 .code
28010 sasl:
28011   driver = gsasl
28012   public_name = X-ANYTHING
28013   server_mech = CRAM-MD5
28014   server_set_id = $auth1
28015 .endd
28016
28017
28018 .option server_password gsasl string&!! unset
28019 Various mechanisms need access to the cleartext password on the server, so
28020 that proof-of-possession can be demonstrated on the wire, without sending
28021 the password itself.
28022
28023 The data available for lookup varies per mechanism.
28024 In all cases, &$auth1$& is set to the &'authentication id'&.
28025 The &$auth2$& variable will always be the &'authorization id'& (&'authz'&)
28026 if available, else the empty string.
28027 The &$auth3$& variable will always be the &'realm'& if available,
28028 else the empty string.
28029
28030 A forced failure will cause authentication to defer.
28031
28032 If using this option, it may make sense to set the &%server_condition%&
28033 option to be simply "true".
28034
28035
28036 .option server_realm gsasl string&!! unset
28037 This specifies the SASL realm that the server claims to be in.
28038 Some mechanisms will use this data.
28039
28040
28041 .option server_scram_iter gsasl string&!! 4096
28042 This option provides data for the SCRAM family of mechanisms.
28043 .new
28044 The &$auth1$&, &$auth2$& and &$auth3$& variables are available
28045 when this option is expanded.
28046
28047 The result of expansion should be a decimal number,
28048 and represents both a lower-bound on the security, and
28049 a compute cost factor imposed on the client
28050 (if it does not cache results, or the server changes
28051 either the iteration count or the salt).
28052 A minimum value of 4096 is required by the standards
28053 for all current SCRAM mechanism variants.
28054 .wen
28055
28056 .option server_scram_salt gsasl string&!! unset
28057 This option provides data for the SCRAM family of mechanisms.
28058 .new
28059 The &$auth1$&, &$auth2$& and &$auth3$& variables are available
28060 when this option is expanded.
28061 The value should be a base64-encoded string,
28062 of random data typically 4-to-16 bytes long.
28063 If unset or empty after expansion the library will provides a value for the
28064 protocol conversation.
28065 .wen
28066
28067
28068 .new
28069 .option server_key gsasl string&!! unset
28070 .option server_skey gsasl string&!! unset
28071 These options can be used for the SCRAM family of mechanisms
28072 to provide stored information related to a password,
28073 the storage of which is preferable to plaintext.
28074
28075 &%server_key%& is the value defined in the SCRAM standards as ServerKey;
28076 &%server_skey%& is StoredKey.
28077
28078 They are only available for version 1.9.0 (or later) of the gsasl library.
28079 When this is so, the macros
28080 _OPT_AUTHENTICATOR_GSASL_SERVER_KEY
28081 and _HAVE_AUTH_GSASL_SCRAM_S_KEY
28082 will be defined.
28083
28084 The &$authN$& variables are available when these options are expanded.
28085
28086 If set, the results of expansion should for each
28087 should be a 28 (for SHA-1) or 44 (for SHA-256) character string
28088 of base64-coded data, and will be used in preference to the
28089 &%server_password%& option.
28090 If unset or not of the right length, &%server_password%& will be used.
28091
28092 The libgsasl library release includes a utility &'gsasl'& which can be used
28093 to generate these values.
28094 .wen
28095
28096
28097 .option server_service gsasl string &`smtp`&
28098 This is the SASL service that the server claims to implement.
28099 Some mechanisms will use this data.
28100
28101
28102 .section "&(gsasl)& auth variables" "SECTgsaslauthvar"
28103 .vindex "&$auth1$&, &$auth2$&, etc"
28104 These may be set when evaluating specific options, as detailed above.
28105 They will also be set when evaluating &%server_condition%&.
28106
28107 Unless otherwise stated below, the &(gsasl)& integration will use the following
28108 meanings for these variables:
28109
28110 .ilist
28111 .vindex "&$auth1$&"
28112 &$auth1$&: the &'authentication id'&
28113 .next
28114 .vindex "&$auth2$&"
28115 &$auth2$&: the &'authorization id'&
28116 .next
28117 .vindex "&$auth3$&"
28118 &$auth3$&: the &'realm'&
28119 .endlist
28120
28121 On a per-mechanism basis:
28122
28123 .ilist
28124 .cindex "authentication" "EXTERNAL"
28125 EXTERNAL: only &$auth1$& is set, to the possibly empty &'authorization id'&;
28126 the &%server_condition%& option must be present.
28127 .next
28128 .cindex "authentication" "ANONYMOUS"
28129 ANONYMOUS: only &$auth1$& is set, to the possibly empty &'anonymous token'&;
28130 the &%server_condition%& option must be present.
28131 .next
28132 .cindex "authentication" "GSSAPI"
28133 GSSAPI: &$auth1$& will be set to the &'GSSAPI Display Name'&;
28134 &$auth2$& will be set to the &'authorization id'&,
28135 the &%server_condition%& option must be present.
28136 .endlist
28137
28138 An &'anonymous token'& is something passed along as an unauthenticated
28139 identifier; this is analogous to FTP anonymous authentication passing an
28140 email address, or software-identifier@, as the "password".
28141
28142
28143 An example showing the password having the realm specified in the callback
28144 and demonstrating a Cyrus SASL to GSASL migration approach is:
28145 .code
28146 gsasl_cyrusless_crammd5:
28147   driver = gsasl
28148   public_name = CRAM-MD5
28149   server_realm = imap.example.org
28150   server_password = ${lookup{$auth1:$auth3:userPassword}\
28151                     dbmjz{/etc/sasldb2}{$value}fail}
28152   server_set_id = ${quote:$auth1}
28153   server_condition = yes
28154 .endd
28155
28156
28157 . ////////////////////////////////////////////////////////////////////////////
28158 . ////////////////////////////////////////////////////////////////////////////
28159
28160 .chapter "The heimdal_gssapi authenticator" "CHAPheimdalgss"
28161 .scindex IIDheimdalgssauth1 "&(heimdal_gssapi)& authenticator"
28162 .scindex IIDheimdalgssauth2 "authenticators" "&(heimdal_gssapi)&"
28163 .cindex "authentication" "GSSAPI"
28164 .cindex "authentication" "Kerberos"
28165 The &(heimdal_gssapi)& authenticator provides server integration for the
28166 Heimdal GSSAPI/Kerberos library, permitting Exim to set a keytab pathname
28167 reliably.
28168
28169 .option server_hostname heimdal_gssapi string&!! "see below"
28170 This option selects the hostname that is used, with &%server_service%&,
28171 for constructing the GSS server name, as a &'GSS_C_NT_HOSTBASED_SERVICE'&
28172 identifier.  The default value is &`$primary_hostname`&.
28173
28174 .option server_keytab heimdal_gssapi string&!! unset
28175 If set, then Heimdal will not use the system default keytab (typically
28176 &_/etc/krb5.keytab_&) but instead the pathname given in this option.
28177 The value should be a pathname, with no &"file:"& prefix.
28178
28179 .option server_service heimdal_gssapi string&!! "smtp"
28180 This option specifies the service identifier used, in conjunction with
28181 &%server_hostname%&, for building the identifier for finding credentials
28182 from the keytab.
28183
28184
28185 .section "&(heimdal_gssapi)& auth variables" "SECTheimdalgssauthvar"
28186 Beware that these variables will typically include a realm, thus will appear
28187 to be roughly like an email address already.  The &'authzid'& in &$auth2$& is
28188 not verified, so a malicious client can set it to anything.
28189
28190 The &$auth1$& field should be safely trustable as a value from the Key
28191 Distribution Center.  Note that these are not quite email addresses.
28192 Each identifier is for a role, and so the left-hand-side may include a
28193 role suffix.  For instance, &"joe/admin@EXAMPLE.ORG"&.
28194
28195 .vindex "&$auth1$&, &$auth2$&, etc"
28196 .ilist
28197 .vindex "&$auth1$&"
28198 &$auth1$&: the &'authentication id'&, set to the GSS Display Name.
28199 .next
28200 .vindex "&$auth2$&"
28201 &$auth2$&: the &'authorization id'&, sent within SASL encapsulation after
28202 authentication.  If that was empty, this will also be set to the
28203 GSS Display Name.
28204 .endlist
28205
28206
28207 . ////////////////////////////////////////////////////////////////////////////
28208 . ////////////////////////////////////////////////////////////////////////////
28209
28210 .chapter "The spa authenticator" "CHAPspa"
28211 .scindex IIDspaauth1 "&(spa)& authenticator"
28212 .scindex IIDspaauth2 "authenticators" "&(spa)&"
28213 .cindex "authentication" "Microsoft Secure Password"
28214 .cindex "authentication" "NTLM"
28215 .cindex "Microsoft Secure Password Authentication"
28216 .cindex "NTLM authentication"
28217 The &(spa)& authenticator provides client support for Microsoft's &'Secure
28218 Password Authentication'& mechanism,
28219 which is also sometimes known as NTLM (NT LanMan). The code for client side of
28220 this authenticator was contributed by Marc Prud'hommeaux, and much of it is
28221 taken from the Samba project (&url(https://www.samba.org/)). The code for the
28222 server side was subsequently contributed by Tom Kistner. The mechanism works as
28223 follows:
28224
28225 .ilist
28226 After the AUTH command has been accepted, the client sends an SPA
28227 authentication request based on the user name and optional domain.
28228 .next
28229 The server sends back a challenge.
28230 .next
28231 The client builds a challenge response which makes use of the user's password
28232 and sends it to the server, which then accepts or rejects it.
28233 .endlist
28234
28235 Encryption is used to protect the password in transit.
28236
28237
28238
28239 .section "Using spa as a server" "SECID179"
28240 .cindex "options" "&(spa)& authenticator (server)"
28241 The &(spa)& authenticator has just one server option:
28242
28243 .option server_password spa string&!! unset
28244 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(spa)& authenticator"
28245 This option is expanded, and the result must be the cleartext password for the
28246 authenticating user, whose name is at this point in &$auth1$&. For
28247 compatibility with previous releases of Exim, the user name is also placed in
28248 &$1$&. However, the use of this variable for this purpose is now deprecated, as
28249 it can lead to confusion in string expansions that also use numeric variables
28250 for other things. For example:
28251 .code
28252 spa:
28253   driver = spa
28254   public_name = NTLM
28255   server_password = \
28256     ${lookup{$auth1}lsearch{/etc/exim/spa_clearpass}{$value}fail}
28257 .endd
28258 If the expansion is forced to fail, authentication fails. Any other expansion
28259 failure causes a temporary error code to be returned.
28260
28261
28262
28263
28264
28265 .section "Using spa as a client" "SECID180"
28266 .cindex "options" "&(spa)& authenticator (client)"
28267 The &(spa)& authenticator has the following client options:
28268
28269
28270
28271 .option client_domain spa string&!! unset
28272 This option specifies an optional domain for the authentication.
28273
28274
28275 .option client_password spa string&!! unset
28276 This option specifies the user's password, and must be set.
28277
28278
28279 .option client_username spa string&!! unset
28280 This option specifies the user name, and must be set. Here is an example of a
28281 configuration of this authenticator for use with the mail servers at
28282 &'msn.com'&:
28283 .code
28284 msn:
28285   driver = spa
28286   public_name = MSN
28287   client_username = msn/msn_username
28288   client_password = msn_plaintext_password
28289   client_domain = DOMAIN_OR_UNSET
28290 .endd
28291 .ecindex IIDspaauth1
28292 .ecindex IIDspaauth2
28293
28294
28295
28296
28297
28298 . ////////////////////////////////////////////////////////////////////////////
28299 . ////////////////////////////////////////////////////////////////////////////
28300
28301 .chapter "The external authenticator" "CHAPexternauth"
28302 .scindex IIDexternauth1 "&(external)& authenticator"
28303 .scindex IIDexternauth2 "authenticators" "&(external)&"
28304 .cindex "authentication" "Client Certificate"
28305 .cindex "authentication" "X509"
28306 .cindex "Certificate-based authentication"
28307 The &(external)& authenticator provides support for
28308 authentication based on non-SMTP information.
28309 The specification is in RFC 4422 Appendix A
28310 (&url(https://tools.ietf.org/html/rfc4422)).
28311 It is only a transport and negotiation mechanism;
28312 the process of authentication is entirely controlled
28313 by the server configuration.
28314
28315 The client presents an identity in-clear.
28316 It is probably wise for a server to only advertise,
28317 and for clients to only attempt,
28318 this authentication method on a secure (eg. under TLS) connection.
28319
28320 One possible use, compatible with the
28321 K-9 Mail Andoid client (&url(https://k9mail.github.io/)),
28322 is for using X509 client certificates.
28323
28324 It thus overlaps in function with the TLS authenticator
28325 (see &<<CHAPtlsauth>>&)
28326 but is a full SMTP SASL authenticator
28327 rather than being implicit for TLS-connection carried
28328 client certificates only.
28329
28330 The examples and discussion in this chapter assume that
28331 client-certificate authentication is being done.
28332
28333 The client must present a certificate,
28334 for which it must have been requested via the
28335 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& main options
28336 (see &<<CHAPTLS>>&).
28337 For authentication to be effective the certificate should be
28338 verifiable against a trust-anchor certificate known to the server.
28339
28340 .section "External options" "SECTexternsoptions"
28341 .cindex "options" "&(external)& authenticator (server)"
28342 The &(external)& authenticator has two server options:
28343
28344 .option server_param2 external string&!! unset
28345 .option server_param3 external string&!! unset
28346 .cindex "variables (&$auth1$& &$auth2$& etc)" "in &(external)& authenticator"
28347 These options are expanded before the &%server_condition%& option
28348 and the result are placed in &$auth2$& and &$auth3$& resectively.
28349 If the expansion is forced to fail, authentication fails. Any other expansion
28350 failure causes a temporary error code to be returned.
28351
28352 They can be used to clarify the coding of a complex &%server_condition%&.
28353
28354 .section "Using external in a server" "SECTexternserver"
28355 .cindex "AUTH" "in &(external)& authenticator"
28356 .cindex "numerical variables (&$1$& &$2$& etc)" &&&
28357         "in &(external)& authenticator"
28358 .vindex "&$auth1$&, &$auth2$&, etc"
28359 .cindex "base64 encoding" "in &(external)& authenticator"
28360
28361 When running as a server, &(external)& performs the authentication test by
28362 expanding a string. The data sent by the client with the AUTH command, or in
28363 response to subsequent prompts, is base64 encoded, and so may contain any byte
28364 values when decoded. The decoded value is treated as
28365 an identity for authentication and
28366 placed in the expansion variable &$auth1$&.
28367
28368 For compatibility with previous releases of Exim, the value is also placed in
28369 the expansion variable &$1$&. However, the use of this
28370 variable for this purpose is now deprecated, as it can lead to confusion in
28371 string expansions that also use them for other things.
28372
28373 .vindex "&$authenticated_id$&"
28374 Once an identity has been received,
28375 &%server_condition%& is expanded. If the expansion is forced to fail,
28376 authentication fails. Any other expansion failure causes a temporary error code
28377 to be returned. If the result of a successful expansion is an empty string,
28378 &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
28379 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds and the
28380 generic &%server_set_id%& option is expanded and saved in &$authenticated_id$&.
28381 For any other result, a temporary error code is returned, with the expanded
28382 string as the error text.
28383
28384 Example:
28385 .code
28386 ext_ccert_san_mail:
28387   driver =            external
28388   public_name =       EXTERNAL
28389
28390   server_advertise_condition = $tls_in_certificate_verified
28391   server_param2 =     ${certextract {subj_altname,mail,>:} \
28392                                     {$tls_in_peercert}}
28393   server_condition =  ${if forany {$auth2} \
28394                             {eq {$item}{$auth1}}}
28395   server_set_id =     $auth1
28396 .endd
28397 This accepts a client certificate that is verifiable against any
28398 of your configured trust-anchors
28399 (which usually means the full set of public CAs)
28400 and which has a mail-SAN matching the claimed identity sent by the client.
28401
28402 &*Note*&: up to TLS1.2, the client cert is on the wire in-clear, including the SAN.
28403 The account name is therefore guessable by an opponent.
28404 TLS 1.3 protects both server and client certificates, and is not vulnerable
28405 in this way.
28406
28407
28408 .section "Using external in a client" "SECTexternclient"
28409 .cindex "options" "&(external)& authenticator (client)"
28410 The &(external)& authenticator has one client option:
28411
28412 .option client_send external string&!! unset
28413 This option is expanded and sent with the AUTH command as the
28414 identity being asserted.
28415
28416 Example:
28417 .code
28418 ext_ccert:
28419   driver =      external
28420   public_name = EXTERNAL
28421
28422   client_condition = ${if !eq{$tls_out_cipher}{}}
28423   client_send = myaccount@smarthost.example.net
28424 .endd
28425
28426
28427 .ecindex IIDexternauth1
28428 .ecindex IIDexternauth2
28429
28430
28431
28432
28433
28434 . ////////////////////////////////////////////////////////////////////////////
28435 . ////////////////////////////////////////////////////////////////////////////
28436
28437 .chapter "The tls authenticator" "CHAPtlsauth"
28438 .scindex IIDtlsauth1 "&(tls)& authenticator"
28439 .scindex IIDtlsauth2 "authenticators" "&(tls)&"
28440 .cindex "authentication" "Client Certificate"
28441 .cindex "authentication" "X509"
28442 .cindex "Certificate-based authentication"
28443 The &(tls)& authenticator provides server support for
28444 authentication based on client certificates.
28445
28446 It is not an SMTP authentication mechanism and is not
28447 advertised by the server as part of the SMTP EHLO response.
28448 It is an Exim authenticator in the sense that it affects
28449 the protocol element of the log line, can be tested for
28450 by the &%authenticated%& ACL condition, and can set
28451 the &$authenticated_id$& variable.
28452
28453 The client must present a verifiable certificate,
28454 for which it must have been requested via the
28455 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& main options
28456 (see &<<CHAPTLS>>&).
28457
28458 If an authenticator of this type is configured it is
28459 run before any SMTP-level communication is done,
28460 and can authenticate the connection.
28461 If it does, SMTP authentication is not offered.
28462
28463 A maximum of one authenticator of this type may be present.
28464
28465
28466 .cindex "options" "&(tls)& authenticator (server)"
28467 The &(tls)& authenticator has three server options:
28468
28469 .option server_param1 tls string&!! unset
28470 .cindex "variables (&$auth1$& &$auth2$& etc)" "in &(tls)& authenticator"
28471 This option is expanded after the TLS negotiation and
28472 the result is placed in &$auth1$&.
28473 If the expansion is forced to fail, authentication fails. Any other expansion
28474 failure causes a temporary error code to be returned.
28475
28476 .option server_param2 tls string&!! unset
28477 .option server_param3 tls string&!! unset
28478 As above, for &$auth2$& and &$auth3$&.
28479
28480 &%server_param1%& may also be spelled &%server_param%&.
28481
28482
28483 Example:
28484 .code
28485 tls:
28486   driver = tls
28487   server_param1 =     ${certextract {subj_altname,mail,>:} \
28488                                     {$tls_in_peercert}}
28489   server_condition =  ${if and { {eq{$tls_in_certificate_verified}{1}} \
28490                                  {forany {$auth1} \
28491                             {!= {0} \
28492                                 {${lookup ldap{ldap:///\
28493                          mailname=${quote_ldap_dn:${lc:$item}},\
28494                          ou=users,LDAP_DC?mailid} {$value}{0} \
28495                        }    }  } }}}
28496   server_set_id =     ${if = {1}{${listcount:$auth1}} {$auth1}{}}
28497 .endd
28498 This accepts a client certificate that is verifiable against any
28499 of your configured trust-anchors
28500 (which usually means the full set of public CAs)
28501 and which has a SAN with a good account name.
28502
28503 Note that, up to TLS1.2, the client cert is on the wire in-clear, including the SAN,
28504 The account name is therefore guessable by an opponent.
28505 TLS 1.3 protects both server and client certificates, and is not vulnerable
28506 in this way.
28507 Likewise, a traditional plaintext SMTP AUTH done inside TLS is not.
28508
28509 . An alternative might use
28510 . .code
28511 .   server_param1 = ${sha256:$tls_in_peercert}
28512 . .endd
28513 . to require one of a set of specific certs that define a given account
28514 . (the verification is still required, but mostly irrelevant).
28515 . This would help for per-device use.
28516 .
28517 . However, for the future we really need support for checking a
28518 . user cert in LDAP - which probably wants a base-64 DER.
28519
28520 .ecindex IIDtlsauth1
28521 .ecindex IIDtlsauth2
28522
28523
28524 Note that because authentication is traditionally an SMTP operation,
28525 the &%authenticated%& ACL condition cannot be used in
28526 a connect- or helo-ACL.
28527
28528
28529
28530 . ////////////////////////////////////////////////////////////////////////////
28531 . ////////////////////////////////////////////////////////////////////////////
28532
28533 .chapter "Encrypted SMTP connections using TLS/SSL" "CHAPTLS" &&&
28534          "Encrypted SMTP connections"
28535 .scindex IIDencsmtp1 "encryption" "on SMTP connection"
28536 .scindex IIDencsmtp2 "SMTP" "encryption"
28537 .cindex "TLS" "on SMTP connection"
28538 .cindex "OpenSSL"
28539 .cindex "GnuTLS"
28540 Support for TLS (Transport Layer Security), formerly known as SSL (Secure
28541 Sockets Layer), is implemented by making use of the OpenSSL library or the
28542 GnuTLS library (Exim requires GnuTLS release 1.0 or later). There is no
28543 cryptographic code in the Exim distribution itself for implementing TLS. In
28544 order to use this feature you must install OpenSSL or GnuTLS, and then build a
28545 version of Exim that includes TLS support (see section &<<SECTinctlsssl>>&).
28546 You also need to understand the basic concepts of encryption at a managerial
28547 level, and in particular, the way that public keys, private keys, and
28548 certificates are used.
28549
28550 RFC 3207 defines how SMTP connections can make use of encryption. Once a
28551 connection is established, the client issues a STARTTLS command. If the
28552 server accepts this, the client and the server negotiate an encryption
28553 mechanism. If the negotiation succeeds, the data that subsequently passes
28554 between them is encrypted.
28555
28556 Exim's ACLs can detect whether the current SMTP session is encrypted or not,
28557 and if so, what cipher suite is in use, whether the client supplied a
28558 certificate, and whether or not that certificate was verified. This makes it
28559 possible for an Exim server to deny or accept certain commands based on the
28560 encryption state.
28561
28562 &*Warning*&: Certain types of firewall and certain anti-virus products can
28563 disrupt TLS connections. You need to turn off SMTP scanning for these products
28564 in order to get TLS to work.
28565
28566
28567
28568 .section "Support for the &""submissions""& (aka &""ssmtp""& and &""smtps""&) protocol" &&&
28569          "SECID284"
28570 .cindex "submissions protocol"
28571 .cindex "ssmtp protocol"
28572 .cindex "smtps protocol"
28573 .cindex "SMTP" "submissions protocol"
28574 .cindex "SMTP" "ssmtp protocol"
28575 .cindex "SMTP" "smtps protocol"
28576 The history of port numbers for TLS in SMTP is a little messy and has been
28577 contentious.  As of RFC 8314, the common practice of using the historically
28578 allocated port 465 for "email submission but with TLS immediately upon connect
28579 instead of using STARTTLS" is officially blessed by the IETF, and recommended
28580 by them in preference to STARTTLS.
28581
28582 The name originally assigned to the port was &"ssmtp"& or &"smtps"&, but as
28583 clarity emerged over the dual roles of SMTP, for MX delivery and Email
28584 Submission, nomenclature has shifted.  The modern name is now &"submissions"&.
28585
28586 This approach was, for a while, officially abandoned when encrypted SMTP was
28587 standardized, but many clients kept using it, even as the TCP port number was
28588 reassigned for other use.
28589 Thus you may encounter guidance claiming that you shouldn't enable use of
28590 this port.
28591 In practice, a number of mail-clients have only ever supported submissions,
28592 not submission with STARTTLS upgrade.
28593 Ideally, offer both submission (587) and submissions (465) service.
28594
28595 Exim supports TLS-on-connect by means of the &%tls_on_connect_ports%&
28596 global option. Its value must be a list of port numbers;
28597 the most common use is expected to be:
28598 .code
28599 tls_on_connect_ports = 465
28600 .endd
28601 The port numbers specified by this option apply to all SMTP connections, both
28602 via the daemon and via &'inetd'&. You still need to specify all the ports that
28603 the daemon uses (by setting &%daemon_smtp_ports%& or &%local_interfaces%& or
28604 the &%-oX%& command line option) because &%tls_on_connect_ports%& does not add
28605 an extra port &-- rather, it specifies different behaviour on a port that is
28606 defined elsewhere.
28607
28608 There is also a &%-tls-on-connect%& command line option. This overrides
28609 &%tls_on_connect_ports%&; it forces the TLS-only behaviour for all ports.
28610
28611
28612
28613
28614
28615
28616 .section "OpenSSL vs GnuTLS" "SECTopenvsgnu"
28617 .cindex "TLS" "OpenSSL &'vs'& GnuTLS"
28618 TLS is supported in Exim using either the OpenSSL or GnuTLS library.
28619 To build Exim to use OpenSSL you need to set
28620 .code
28621 USE_OPENSSL=yes
28622 .endd
28623 in Local/Makefile.
28624
28625 To build Exim to use GnuTLS, you need to set
28626 .code
28627 USE_GNUTLS=yes
28628 .endd
28629 in Local/Makefile.
28630
28631 You must also set TLS_LIBS and TLS_INCLUDE appropriately, so that the
28632 include files and libraries for GnuTLS can be found.
28633
28634 There are some differences in usage when using GnuTLS instead of OpenSSL:
28635
28636 .ilist
28637 The &%tls_verify_certificates%& option
28638 cannot be the path of a directory
28639 for GnuTLS versions before 3.3.6
28640 (for later versions, or OpenSSL, it can be either).
28641 .next
28642 The default value for &%tls_dhparam%& differs for historical reasons.
28643 .next
28644 .vindex "&$tls_in_peerdn$&"
28645 .vindex "&$tls_out_peerdn$&"
28646 Distinguished Name (DN) strings reported by the OpenSSL library use a slash for
28647 separating fields; GnuTLS uses commas, in accordance with RFC 2253. This
28648 affects the value of the &$tls_in_peerdn$& and &$tls_out_peerdn$& variables.
28649 .next
28650 OpenSSL identifies cipher suites using hyphens as separators, for example:
28651 DES-CBC3-SHA. GnuTLS historically used underscores, for example:
28652 RSA_ARCFOUR_SHA. What is more, OpenSSL complains if underscores are present
28653 in a cipher list. To make life simpler, Exim changes underscores to hyphens
28654 for OpenSSL and passes the string unchanged to GnuTLS (expecting the library
28655 to handle its own older variants) when processing lists of cipher suites in the
28656 &%tls_require_ciphers%& options (the global option and the &(smtp)& transport
28657 option).
28658 .next
28659 The &%tls_require_ciphers%& options operate differently, as described in the
28660 sections &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
28661 .next
28662 The &%tls_dh_min_bits%& SMTP transport option is only honoured by GnuTLS.
28663 When using OpenSSL, this option is ignored.
28664 (If an API is found to let OpenSSL be configured in this way,
28665 let the Exim Maintainers know and we'll likely use it).
28666 .next
28667 With GnuTLS, if an explicit list is used for the &%tls_privatekey%& main option
28668 main option, it must be ordered to match the &%tls_certificate%& list.
28669 .next
28670 Some other recently added features may only be available in one or the other.
28671 This should be documented with the feature.  If the documentation does not
28672 explicitly state that the feature is infeasible in the other TLS
28673 implementation, then patches are welcome.
28674 .endlist
28675
28676
28677 .section "GnuTLS parameter computation" "SECTgnutlsparam"
28678 This section only applies if &%tls_dhparam%& is set to &`historic`& or to
28679 an explicit path; if the latter, then the text about generation still applies,
28680 but not the chosen filename.
28681 By default, as of Exim 4.80 a hard-coded D-H prime is used.
28682 See the documentation of &%tls_dhparam%& for more information.
28683
28684 GnuTLS uses D-H parameters that may take a substantial amount of time
28685 to compute. It is unreasonable to re-compute them for every TLS session.
28686 Therefore, Exim keeps this data in a file in its spool directory, called
28687 &_gnutls-params-NNNN_& for some value of NNNN, corresponding to the number
28688 of bits requested.
28689 The file is owned by the Exim user and is readable only by
28690 its owner. Every Exim process that start up GnuTLS reads the D-H
28691 parameters from this file. If the file does not exist, the first Exim process
28692 that needs it computes the data and writes it to a temporary file which is
28693 renamed once it is complete. It does not matter if several Exim processes do
28694 this simultaneously (apart from wasting a few resources). Once a file is in
28695 place, new Exim processes immediately start using it.
28696
28697 For maximum security, the parameters that are stored in this file should be
28698 recalculated periodically, the frequency depending on your paranoia level.
28699 If you are avoiding using the fixed D-H primes published in RFCs, then you
28700 are concerned about some advanced attacks and will wish to do this; if you do
28701 not regenerate then you might as well stick to the standard primes.
28702
28703 Arranging this is easy in principle; just delete the file when you want new
28704 values to be computed. However, there may be a problem. The calculation of new
28705 parameters needs random numbers, and these are obtained from &_/dev/random_&.
28706 If the system is not very active, &_/dev/random_& may delay returning data
28707 until enough randomness (entropy) is available. This may cause Exim to hang for
28708 a substantial amount of time, causing timeouts on incoming connections.
28709
28710 The solution is to generate the parameters externally to Exim. They are stored
28711 in &_gnutls-params-N_& in PEM format, which means that they can be
28712 generated externally using the &(certtool)& command that is part of GnuTLS.
28713
28714 To replace the parameters with new ones, instead of deleting the file
28715 and letting Exim re-create it, you can generate new parameters using
28716 &(certtool)& and, when this has been done, replace Exim's cache file by
28717 renaming. The relevant commands are something like this:
28718 .code
28719 # ls
28720 [ look for file; assume gnutls-params-2236 is the most recent ]
28721 # rm -f new-params
28722 # touch new-params
28723 # chown exim:exim new-params
28724 # chmod 0600 new-params
28725 # certtool --generate-dh-params --bits 2236 >>new-params
28726 # openssl dhparam -noout -text -in new-params | head
28727 [ check the first line, make sure it's not more than 2236;
28728   if it is, then go back to the start ("rm") and repeat
28729   until the size generated is at most the size requested ]
28730 # chmod 0400 new-params
28731 # mv new-params gnutls-params-2236
28732 .endd
28733 If Exim never has to generate the parameters itself, the possibility of
28734 stalling is removed.
28735
28736 The filename changed in Exim 4.80, to gain the -bits suffix.  The value which
28737 Exim will choose depends upon the version of GnuTLS in use.  For older GnuTLS,
28738 the value remains hard-coded in Exim as 1024.  As of GnuTLS 2.12.x, there is
28739 a way for Exim to ask for the "normal" number of bits for D-H public-key usage,
28740 and Exim does so.  This attempt to remove Exim from TLS policy decisions
28741 failed, as GnuTLS 2.12 returns a value higher than the current hard-coded limit
28742 of the NSS library.  Thus Exim gains the &%tls_dh_max_bits%& global option,
28743 which applies to all D-H usage, client or server.  If the value returned by
28744 GnuTLS is greater than &%tls_dh_max_bits%& then the value will be clamped down
28745 to &%tls_dh_max_bits%&.  The default value has been set at the current NSS
28746 limit, which is still much higher than Exim historically used.
28747
28748 The filename and bits used will change as the GnuTLS maintainers change the
28749 value for their parameter &`GNUTLS_SEC_PARAM_NORMAL`&, as clamped by
28750 &%tls_dh_max_bits%&.  At the time of writing (mid 2012), GnuTLS 2.12 recommends
28751 2432 bits, while NSS is limited to 2236 bits.
28752
28753 In fact, the requested value will be *lower* than &%tls_dh_max_bits%&, to
28754 increase the chance of the generated prime actually being within acceptable
28755 bounds, as GnuTLS has been observed to overshoot.  Note the check step in the
28756 procedure above.  There is no sane procedure available to Exim to double-check
28757 the size of the generated prime, so it might still be too large.
28758
28759
28760 .section "Requiring specific ciphers in OpenSSL" "SECTreqciphssl"
28761 .cindex "TLS" "requiring specific ciphers (OpenSSL)"
28762 .oindex "&%tls_require_ciphers%&" "OpenSSL"
28763 There is a function in the OpenSSL library that can be passed a list of cipher
28764 suites before the cipher negotiation takes place. This specifies which ciphers
28765 are acceptable for TLS versions prior to 1.3.
28766 The list is colon separated and may contain names like
28767 DES-CBC3-SHA. Exim passes the expanded value of &%tls_require_ciphers%&
28768 directly to this function call.
28769 Many systems will install the OpenSSL manual-pages, so you may have
28770 &'ciphers(1)'& available to you.
28771 The following quotation from the OpenSSL
28772 documentation specifies what forms of item are allowed in the cipher string:
28773
28774 .ilist
28775 It can consist of a single cipher suite such as RC4-SHA.
28776 .next
28777 It can represent a list of cipher suites containing a certain algorithm,
28778 or cipher suites of a certain type. For example SHA1 represents all
28779 ciphers suites using the digest algorithm SHA1 and SSLv3 represents all
28780 SSL v3 algorithms.
28781 .next
28782 Lists of cipher suites can be combined in a single cipher string using
28783 the + character. This is used as a logical and operation. For example
28784 SHA1+DES represents all cipher suites containing the SHA1 and the DES
28785 algorithms.
28786 .endlist
28787
28788 Each cipher string can be optionally preceded by one of the characters &`!`&,
28789 &`-`& or &`+`&.
28790 .ilist
28791 If &`!`& is used, the ciphers are permanently deleted from the list. The
28792 ciphers deleted can never reappear in the list even if they are explicitly
28793 stated.
28794 .next
28795 If &`-`& is used, the ciphers are deleted from the list, but some or all
28796 of the ciphers can be added again by later options.
28797 .next
28798 If &`+`& is used, the ciphers are moved to the end of the list. This
28799 option does not add any new ciphers; it just moves matching existing ones.
28800 .endlist
28801
28802 If none of these characters is present, the string is interpreted as
28803 a list of ciphers to be appended to the current preference list. If the list
28804 includes any ciphers already present they will be ignored: that is, they will
28805 not be moved to the end of the list.
28806 .endlist
28807
28808 The OpenSSL &'ciphers(1)'& command may be used to test the results of a given
28809 string:
28810 .code
28811 # note single-quotes to get ! past any shell history expansion
28812 $ openssl ciphers 'HIGH:!MD5:!SHA1'
28813 .endd
28814
28815 This example will let the library defaults be permitted on the MX port, where
28816 there's probably no identity verification anyway, but ups the ante on the
28817 submission ports where the administrator might have some influence on the
28818 choice of clients used:
28819 .code
28820 # OpenSSL variant; see man ciphers(1)
28821 tls_require_ciphers = ${if =={$received_port}{25}\
28822                            {DEFAULT}\
28823                            {HIGH:!MD5:!SHA1}}
28824 .endd
28825
28826 This example will prefer ECDSA-authenticated ciphers over RSA ones:
28827 .code
28828 tls_require_ciphers = ECDSA:RSA:!COMPLEMENTOFDEFAULT
28829 .endd
28830
28831 For TLS version 1.3 the control available is less fine-grained
28832 and Exim does not provide access to it at present.
28833 The value of the &%tls_require_ciphers%& option is ignored when
28834 TLS version 1.3 is negotiated.
28835
28836 As of writing the library default cipher suite list for TLSv1.3 is
28837 .code
28838 TLS_AES_256_GCM_SHA384:TLS_CHACHA20_POLY1305_SHA256:TLS_AES_128_GCM_SHA256
28839 .endd
28840
28841
28842 .section "Requiring specific ciphers or other parameters in GnuTLS" &&&
28843          "SECTreqciphgnu"
28844 .cindex "GnuTLS" "specifying parameters for"
28845 .cindex "TLS" "specifying ciphers (GnuTLS)"
28846 .cindex "TLS" "specifying key exchange methods (GnuTLS)"
28847 .cindex "TLS" "specifying MAC algorithms (GnuTLS)"
28848 .cindex "TLS" "specifying protocols (GnuTLS)"
28849 .cindex "TLS" "specifying priority string (GnuTLS)"
28850 .oindex "&%tls_require_ciphers%&" "GnuTLS"
28851 The GnuTLS library allows the caller to provide a "priority string", documented
28852 as part of the &[gnutls_priority_init]& function.  This is very similar to the
28853 ciphersuite specification in OpenSSL.
28854
28855 The &%tls_require_ciphers%& option is treated as the GnuTLS priority string
28856 and controls both protocols and ciphers.
28857
28858 The &%tls_require_ciphers%& option is available both as an global option,
28859 controlling how Exim behaves as a server, and also as an option of the
28860 &(smtp)& transport, controlling how Exim behaves as a client.  In both cases
28861 the value is string expanded.  The resulting string is not an Exim list and
28862 the string is given to the GnuTLS library, so that Exim does not need to be
28863 aware of future feature enhancements of GnuTLS.
28864
28865 Documentation of the strings accepted may be found in the GnuTLS manual, under
28866 "Priority strings".  This is online as
28867 &url(https://www.gnutls.org/manual/html_node/Priority-Strings.html),
28868 but beware that this relates to GnuTLS 3, which may be newer than the version
28869 installed on your system.  If you are using GnuTLS 3,
28870 then the example code
28871 &url(https://www.gnutls.org/manual/gnutls.html#Listing-the-ciphersuites-in-a-priority-string)
28872 on that site can be used to test a given string.
28873
28874 For example:
28875 .code
28876 # Disable older versions of protocols
28877 tls_require_ciphers = NORMAL:%LATEST_RECORD_VERSION:-VERS-SSL3.0
28878 .endd
28879
28880 Prior to Exim 4.80, an older API of GnuTLS was used, and Exim supported three
28881 additional options, "&%gnutls_require_kx%&", "&%gnutls_require_mac%&" and
28882 "&%gnutls_require_protocols%&".  &%tls_require_ciphers%& was an Exim list.
28883
28884 This example will let the library defaults be permitted on the MX port, where
28885 there's probably no identity verification anyway, and lowers security further
28886 by increasing compatibility; but this ups the ante on the submission ports
28887 where the administrator might have some influence on the choice of clients
28888 used:
28889 .code
28890 # GnuTLS variant
28891 tls_require_ciphers = ${if =={$received_port}{25}\
28892                            {NORMAL:%COMPAT}\
28893                            {SECURE128}}
28894 .endd
28895
28896
28897 .section "Configuring an Exim server to use TLS" "SECID182"
28898 .cindex "TLS" "configuring an Exim server"
28899 .cindex "ESMTP extensions" STARTTLS
28900 When Exim has been built with TLS support, it advertises the availability of
28901 the STARTTLS command to client hosts that match &%tls_advertise_hosts%&,
28902 but not to any others. The default value of this option is *, which means
28903 that STARTTLS is always advertised.  Set it to blank to never advertise;
28904 this is reasonable for systems that want to use TLS only as a client.
28905
28906 If STARTTLS is to be used you
28907 need to set some other options in order to make TLS available.
28908
28909 If a client issues a STARTTLS command and there is some configuration
28910 problem in the server, the command is rejected with a 454 error. If the client
28911 persists in trying to issue SMTP commands, all except QUIT are rejected
28912 with the error
28913 .code
28914 554 Security failure
28915 .endd
28916 If a STARTTLS command is issued within an existing TLS session, it is
28917 rejected with a 554 error code.
28918
28919 To enable TLS operations on a server, the &%tls_advertise_hosts%& option
28920 must be set to match some hosts. The default is * which matches all hosts.
28921
28922 If this is all you do, TLS encryption will be enabled but not authentication -
28923 meaning that the peer has no assurance it is actually you he is talking to.
28924 You gain protection from a passive sniffer listening on the wire but not
28925 from someone able to intercept the communication.
28926
28927 Further protection requires some further configuration at the server end.
28928
28929 To make TLS work you need to set, in the server,
28930 .code
28931 tls_certificate = /some/file/name
28932 tls_privatekey = /some/file/name
28933 .endd
28934 These options are, in fact, expanded strings, so you can make them depend on
28935 the identity of the client that is connected if you wish. The first file
28936 contains the server's X509 certificate, and the second contains the private key
28937 that goes with it. These files need to be
28938 PEM format and readable by the Exim user, and must
28939 always be given as full path names.
28940 The key must not be password-protected.
28941 They can be the same file if both the
28942 certificate and the key are contained within it. If &%tls_privatekey%& is not
28943 set, or if its expansion is forced to fail or results in an empty string, this
28944 is assumed to be the case. The certificate file may also contain intermediate
28945 certificates that need to be sent to the client to enable it to authenticate
28946 the server's certificate.
28947
28948 For dual-stack (eg. RSA and ECDSA) configurations, these options can be
28949 colon-separated lists of file paths.  Ciphers using given authentication
28950 algorithms require the presence of a suitable certificate to supply the
28951 public-key.  The server selects among the certificates to present to the
28952 client depending on the selected cipher, hence the priority ordering for
28953 ciphers will affect which certificate is used.
28954
28955 If you do not understand about certificates and keys, please try to find a
28956 source of this background information, which is not Exim-specific. (There are a
28957 few comments below in section &<<SECTcerandall>>&.)
28958
28959 &*Note*&: These options do not apply when Exim is operating as a client &--
28960 they apply only in the case of a server. If you need to use a certificate in an
28961 Exim client, you must set the options of the same names in an &(smtp)&
28962 transport.
28963
28964 With just these options, an Exim server will be able to use TLS. It does not
28965 require the client to have a certificate (but see below for how to insist on
28966 this). There is one other option that may be needed in other situations. If
28967 .code
28968 tls_dhparam = /some/file/name
28969 .endd
28970 is set, the SSL library is initialized for the use of Diffie-Hellman ciphers
28971 with the parameters contained in the file.
28972 Set this to &`none`& to disable use of DH entirely, by making no prime
28973 available:
28974 .code
28975 tls_dhparam = none
28976 .endd
28977 This may also be set to a string identifying a standard prime to be used for
28978 DH; if it is set to &`default`& or, for OpenSSL, is unset, then the prime
28979 used is &`ike23`&.  There are a few standard primes available, see the
28980 documentation for &%tls_dhparam%& for the complete list.
28981
28982 See the command
28983 .code
28984 openssl dhparam
28985 .endd
28986 for a way of generating file data.
28987
28988 The strings supplied for these three options are expanded every time a client
28989 host connects. It is therefore possible to use different certificates and keys
28990 for different hosts, if you so wish, by making use of the client's IP address
28991 in &$sender_host_address$& to control the expansion. If a string expansion is
28992 forced to fail, Exim behaves as if the option is not set.
28993
28994 .cindex "cipher" "logging"
28995 .cindex "log" "TLS cipher"
28996 .vindex "&$tls_in_cipher$&"
28997 The variable &$tls_in_cipher$& is set to the cipher suite that was negotiated for
28998 an incoming TLS connection. It is included in the &'Received:'& header of an
28999 incoming message (by default &-- you can, of course, change this), and it is
29000 also included in the log line that records a message's arrival, keyed by
29001 &"X="&, unless the &%tls_cipher%& log selector is turned off. The &%encrypted%&
29002 condition can be used to test for specific cipher suites in ACLs.
29003
29004 Once TLS has been established, the ACLs that run for subsequent SMTP commands
29005 can check the name of the cipher suite and vary their actions accordingly. The
29006 cipher suite names vary, depending on which TLS library is being used. For
29007 example, OpenSSL uses the name DES-CBC3-SHA for the cipher suite which in other
29008 contexts is known as TLS_RSA_WITH_3DES_EDE_CBC_SHA. Check the OpenSSL or GnuTLS
29009 documentation for more details.
29010
29011 For outgoing SMTP deliveries, &$tls_out_cipher$& is used and logged
29012 (again depending on the &%tls_cipher%& log selector).
29013
29014
29015 .section "Requesting and verifying client certificates" "SECID183"
29016 .cindex "certificate" "verification of client"
29017 .cindex "TLS" "client certificate verification"
29018 If you want an Exim server to request a certificate when negotiating a TLS
29019 session with a client, you must set either &%tls_verify_hosts%& or
29020 &%tls_try_verify_hosts%&. You can, of course, set either of them to * to
29021 apply to all TLS connections. For any host that matches one of these options,
29022 Exim requests a certificate as part of the setup of the TLS session. The
29023 contents of the certificate are verified by comparing it with a list of
29024 expected trust-anchors or certificates.
29025 These may be the system default set (depending on library version),
29026 an explicit file or,
29027 depending on library version, a directory, identified by
29028 &%tls_verify_certificates%&.
29029
29030 A file can contain multiple certificates, concatenated end to end. If a
29031 directory is used
29032 (OpenSSL only),
29033 each certificate must be in a separate file, with a name (or a symbolic link)
29034 of the form <&'hash'&>.0, where <&'hash'&> is a hash value constructed from the
29035 certificate. You can compute the relevant hash by running the command
29036 .code
29037 openssl x509 -hash -noout -in /cert/file
29038 .endd
29039 where &_/cert/file_& contains a single certificate.
29040
29041 There is no checking of names of the client against the certificate
29042 Subject Name or Subject Alternate Names.
29043
29044 The difference between &%tls_verify_hosts%& and &%tls_try_verify_hosts%& is
29045 what happens if the client does not supply a certificate, or if the certificate
29046 does not match any of the certificates in the collection named by
29047 &%tls_verify_certificates%&. If the client matches &%tls_verify_hosts%&, the
29048 attempt to set up a TLS session is aborted, and the incoming connection is
29049 dropped. If the client matches &%tls_try_verify_hosts%&, the (encrypted) SMTP
29050 session continues. ACLs that run for subsequent SMTP commands can detect the
29051 fact that no certificate was verified, and vary their actions accordingly. For
29052 example, you can insist on a certificate before accepting a message for
29053 relaying, but not when the message is destined for local delivery.
29054
29055 .vindex "&$tls_in_peerdn$&"
29056 When a client supplies a certificate (whether it verifies or not), the value of
29057 the Distinguished Name of the certificate is made available in the variable
29058 &$tls_in_peerdn$& during subsequent processing of the message.
29059
29060 .cindex "log" "distinguished name"
29061 Because it is often a long text string, it is not included in the log line or
29062 &'Received:'& header by default. You can arrange for it to be logged, keyed by
29063 &"DN="&, by setting the &%tls_peerdn%& log selector, and you can use
29064 &%received_header_text%& to change the &'Received:'& header. When no
29065 certificate is supplied, &$tls_in_peerdn$& is empty.
29066
29067
29068 .section "Revoked certificates" "SECID184"
29069 .cindex "TLS" "revoked certificates"
29070 .cindex "revocation list"
29071 .cindex "certificate" "revocation list"
29072 .cindex "OCSP" "stapling"
29073 Certificate issuing authorities issue Certificate Revocation Lists (CRLs) when
29074 certificates are revoked. If you have such a list, you can pass it to an Exim
29075 server using the global option called &%tls_crl%& and to an Exim client using
29076 an identically named option for the &(smtp)& transport. In each case, the value
29077 of the option is expanded and must then be the name of a file that contains a
29078 CRL in PEM format.
29079 The downside is that clients have to periodically re-download a potentially huge
29080 file from every certificate authority they know of.
29081
29082 The way with most moving parts at query time is Online Certificate
29083 Status Protocol (OCSP), where the client verifies the certificate
29084 against an OCSP server run by the CA.  This lets the CA track all
29085 usage of the certs.  It requires running software with access to the
29086 private key of the CA, to sign the responses to the OCSP queries.  OCSP
29087 is based on HTTP and can be proxied accordingly.
29088
29089 The only widespread OCSP server implementation (known to this writer)
29090 comes as part of OpenSSL and aborts on an invalid request, such as
29091 connecting to the port and then disconnecting.  This requires
29092 re-entering the passphrase each time some random client does this.
29093
29094 The third way is OCSP Stapling; in this, the server using a certificate
29095 issued by the CA periodically requests an OCSP proof of validity from
29096 the OCSP server, then serves it up inline as part of the TLS
29097 negotiation.   This approach adds no extra round trips, does not let the
29098 CA track users, scales well with number of certs issued by the CA and is
29099 resilient to temporary OCSP server failures, as long as the server
29100 starts retrying to fetch an OCSP proof some time before its current
29101 proof expires.  The downside is that it requires server support.
29102
29103 Unless Exim is built with the support disabled,
29104 or with GnuTLS earlier than version 3.3.16 / 3.4.8
29105 support for OCSP stapling is included.
29106
29107 There is a global option called &%tls_ocsp_file%&.
29108 The file specified therein is expected to be in DER format, and contain
29109 an OCSP proof.  Exim will serve it as part of the TLS handshake.  This
29110 option will be re-expanded for SNI, if the &%tls_certificate%& option
29111 contains &`tls_in_sni`&, as per other TLS options.
29112
29113 Exim does not at this time implement any support for fetching a new OCSP
29114 proof.  The burden is on the administrator to handle this, outside of
29115 Exim.  The file specified should be replaced atomically, so that the
29116 contents are always valid.  Exim will expand the &%tls_ocsp_file%& option
29117 on each connection, so a new file will be handled transparently on the
29118 next connection.
29119
29120 When built with OpenSSL Exim will check for a valid next update timestamp
29121 in the OCSP proof; if not present, or if the proof has expired, it will be
29122 ignored.
29123
29124 For the client to be able to verify the stapled OCSP the server must
29125 also supply, in its stapled information, any intermediate
29126 certificates for the chain leading to the OCSP proof from the signer
29127 of the server certificate.  There may be zero or one such. These
29128 intermediate certificates should be added to the server OCSP stapling
29129 file named by &%tls_ocsp_file%&.
29130
29131 Note that the proof only covers the terminal server certificate,
29132 not any of the chain from CA to it.
29133
29134 There is no current way to staple a proof for a client certificate.
29135
29136 .code
29137   A helper script "ocsp_fetch.pl" for fetching a proof from a CA
29138   OCSP server is supplied.  The server URL may be included in the
29139   server certificate, if the CA is helpful.
29140
29141   One failure mode seen was the OCSP Signer cert expiring before the end
29142   of validity of the OCSP proof. The checking done by Exim/OpenSSL
29143   noted this as invalid overall, but the re-fetch script did not.
29144 .endd
29145
29146
29147
29148
29149 .section "Configuring an Exim client to use TLS" "SECTclientTLS"
29150 .cindex "cipher" "logging"
29151 .cindex "log" "TLS cipher"
29152 .cindex "log" "distinguished name"
29153 .cindex "TLS" "configuring an Exim client"
29154 The &%tls_cipher%& and &%tls_peerdn%& log selectors apply to outgoing SMTP
29155 deliveries as well as to incoming, the latter one causing logging of the
29156 server certificate's DN. The remaining client configuration for TLS is all
29157 within the &(smtp)& transport.
29158
29159 .cindex "ESMTP extensions" STARTTLS
29160 It is not necessary to set any options to have TLS work in the &(smtp)&
29161 transport. If Exim is built with TLS support, and TLS is advertised by a
29162 server, the &(smtp)& transport always tries to start a TLS session. However,
29163 this can be prevented by setting &%hosts_avoid_tls%& (an option of the
29164 transport) to a list of server hosts for which TLS should not be used.
29165
29166 If you do not want Exim to attempt to send messages unencrypted when an attempt
29167 to set up an encrypted connection fails in any way, you can set
29168 &%hosts_require_tls%& to a list of hosts for which encryption is mandatory. For
29169 those hosts, delivery is always deferred if an encrypted connection cannot be
29170 set up. If there are any other hosts for the address, they are tried in the
29171 usual way.
29172
29173 When the server host is not in &%hosts_require_tls%&, Exim may try to deliver
29174 the message unencrypted. It always does this if the response to STARTTLS is
29175 a 5&'xx'& code. For a temporary error code, or for a failure to negotiate a TLS
29176 session after a success response code, what happens is controlled by the
29177 &%tls_tempfail_tryclear%& option of the &(smtp)& transport. If it is false,
29178 delivery to this host is deferred, and other hosts (if available) are tried. If
29179 it is true, Exim attempts to deliver unencrypted after a 4&'xx'& response to
29180 STARTTLS, and if STARTTLS is accepted, but the subsequent TLS
29181 negotiation fails, Exim closes the current connection (because it is in an
29182 unknown state), opens a new one to the same host, and then tries the delivery
29183 unencrypted.
29184
29185 The &%tls_certificate%& and &%tls_privatekey%& options of the &(smtp)&
29186 transport provide the client with a certificate, which is passed to the server
29187 if it requests it. If the server is Exim, it will request a certificate only if
29188 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& matches the client.
29189
29190 &*Note*&: Do not use a certificate which has the OCSP-must-staple extension,
29191 for client use (they are usable for server use).
29192 As the TLS protocol has no means for the client to staple before TLS 1.3 it will result
29193 in failed connections.
29194
29195 If the &%tls_verify_certificates%& option is set on the &(smtp)& transport, it
29196 specifies a collection of expected server certificates.
29197 These may be
29198 the system default set (depending on library version),
29199 a file,
29200 or (depending on library version) a directory.
29201 The client verifies the server's certificate
29202 against this collection, taking into account any revoked certificates that are
29203 in the list defined by &%tls_crl%&.
29204 Failure to verify fails the TLS connection unless either of the
29205 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& options are set.
29206
29207 The &%tls_verify_hosts%& and &%tls_try_verify_hosts%& options restrict
29208 certificate verification to the listed servers.  Verification either must
29209 or need not succeed respectively.
29210
29211 The &%tls_verify_cert_hostnames%& option lists hosts for which additional
29212 checks are made: that the host name (the one in the DNS A record)
29213 is valid for the certificate.
29214 The option defaults to always checking.
29215
29216 The &(smtp)& transport has two OCSP-related options:
29217 &%hosts_require_ocsp%&; a host-list for which a Certificate Status
29218 is requested and required for the connection to proceed.  The default
29219 value is empty.
29220 &%hosts_request_ocsp%&; a host-list for which (additionally)
29221 a Certificate Status is requested (but not necessarily verified).  The default
29222 value is "*" meaning that requests are made unless configured
29223 otherwise.
29224
29225 The host(s) should also be in &%hosts_require_tls%&, and
29226 &%tls_verify_certificates%& configured for the transport,
29227 for OCSP to be relevant.
29228
29229 If
29230 &%tls_require_ciphers%& is set on the &(smtp)& transport, it must contain a
29231 list of permitted cipher suites. If either of these checks fails, delivery to
29232 the current host is abandoned, and the &(smtp)& transport tries to deliver to
29233 alternative hosts, if any.
29234
29235  &*Note*&:
29236 These options must be set in the &(smtp)& transport for Exim to use TLS when it
29237 is operating as a client. Exim does not assume that a server certificate (set
29238 by the global options of the same name) should also be used when operating as a
29239 client.
29240
29241 .vindex "&$host$&"
29242 .vindex "&$host_address$&"
29243 All the TLS options in the &(smtp)& transport are expanded before use, with
29244 &$host$& and &$host_address$& containing the name and address of the server to
29245 which the client is connected. Forced failure of an expansion causes Exim to
29246 behave as if the relevant option were unset.
29247
29248 .vindex &$tls_out_bits$&
29249 .vindex &$tls_out_cipher$&
29250 .vindex &$tls_out_peerdn$&
29251 .vindex &$tls_out_sni$&
29252 Before an SMTP connection is established, the
29253 &$tls_out_bits$&, &$tls_out_cipher$&, &$tls_out_peerdn$& and &$tls_out_sni$&
29254 variables are emptied. (Until the first connection, they contain the values
29255 that were set when the message was received.) If STARTTLS is subsequently
29256 successfully obeyed, these variables are set to the relevant values for the
29257 outgoing connection.
29258
29259
29260
29261 .section "Use of TLS Server Name Indication" "SECTtlssni"
29262 .cindex "TLS" "Server Name Indication"
29263 .vindex "&$tls_in_sni$&"
29264 .oindex "&%tls_in_sni%&"
29265 With TLS1.0 or above, there is an extension mechanism by which extra
29266 information can be included at various points in the protocol.  One of these
29267 extensions, documented in RFC 6066 (and before that RFC 4366) is
29268 &"Server Name Indication"&, commonly &"SNI"&.  This extension is sent by the
29269 client in the initial handshake, so that the server can examine the servername
29270 within and possibly choose to use different certificates and keys (and more)
29271 for this session.
29272
29273 This is analogous to HTTP's &"Host:"& header, and is the main mechanism by
29274 which HTTPS-enabled web-sites can be virtual-hosted, many sites to one IP
29275 address.
29276
29277 With SMTP to MX, there are the same problems here as in choosing the identity
29278 against which to validate a certificate: you can't rely on insecure DNS to
29279 provide the identity which you then cryptographically verify.  So this will
29280 be of limited use in that environment.
29281
29282 With SMTP to Submission, there is a well-defined hostname which clients are
29283 connecting to and can validate certificates against.  Thus clients &*can*&
29284 choose to include this information in the TLS negotiation.  If this becomes
29285 wide-spread, then hosters can choose to present different certificates to
29286 different clients.  Or even negotiate different cipher suites.
29287
29288 The &%tls_sni%& option on an SMTP transport is an expanded string; the result,
29289 if not empty, will be sent on a TLS session as part of the handshake.  There's
29290 nothing more to it.  Choosing a sensible value not derived insecurely is the
29291 only point of caution.  The &$tls_out_sni$& variable will be set to this string
29292 for the lifetime of the client connection (including during authentication).
29293
29294 Except during SMTP client sessions, if &$tls_in_sni$& is set then it is a string
29295 received from a client.
29296 It can be logged with the &%log_selector%& item &`+tls_sni`&.
29297
29298 If the string &`tls_in_sni`& appears in the main section's &%tls_certificate%&
29299 option (prior to expansion) then the following options will be re-expanded
29300 during TLS session handshake, to permit alternative values to be chosen:
29301
29302 .ilist
29303 &%tls_certificate%&
29304 .next
29305 &%tls_crl%&
29306 .next
29307 &%tls_privatekey%&
29308 .next
29309 &%tls_verify_certificates%&
29310 .next
29311 &%tls_ocsp_file%&
29312 .endlist
29313
29314 Great care should be taken to deal with matters of case, various injection
29315 attacks in the string (&`../`& or SQL), and ensuring that a valid filename
29316 can always be referenced; it is important to remember that &$tls_in_sni$& is
29317 arbitrary unverified data provided prior to authentication.
29318 Further, the initial certificate is loaded before SNI has arrived, so
29319 an expansion for &%tls_certificate%& must have a default which is used
29320 when &$tls_in_sni$& is empty.
29321
29322 The Exim developers are proceeding cautiously and so far no other TLS options
29323 are re-expanded.
29324
29325 When Exim is built against OpenSSL, OpenSSL must have been built with support
29326 for TLS Extensions.  This holds true for OpenSSL 1.0.0+ and 0.9.8+ with
29327 enable-tlsext in EXTRACONFIGURE.  If you invoke &(openssl s_client -h)& and
29328 see &`-servername`& in the output, then OpenSSL has support.
29329
29330 When Exim is built against GnuTLS, SNI support is available as of GnuTLS
29331 0.5.10.  (Its presence predates the current API which Exim uses, so if Exim
29332 built, then you have SNI support).
29333
29334
29335
29336 .section "Multiple messages on the same encrypted TCP/IP connection" &&&
29337          "SECTmulmessam"
29338 .cindex "multiple SMTP deliveries with TLS"
29339 .cindex "TLS" "multiple message deliveries"
29340 Exim sends multiple messages down the same TCP/IP connection by starting up
29341 an entirely new delivery process for each message, passing the socket from
29342 one process to the next. This implementation does not fit well with the use
29343 of TLS, because there is quite a lot of state information associated with a TLS
29344 connection, not just a socket identification. Passing all the state information
29345 to a new process is not feasible. Consequently, for sending using TLS Exim
29346 starts an additional proxy process for handling the encryption, piping the
29347 unencrypted data stream from and to the delivery processes.
29348
29349 An older mode of operation can be enabled on a per-host basis by the
29350 &%hosts_noproxy_tls%& option on the &(smtp)& transport.  If the host matches
29351 this list the proxy process described above is not used; instead Exim
29352 shuts down an existing TLS session being run by the delivery process
29353 before passing the socket to a new process. The new process may then
29354 try to start a new TLS session, and if successful, may try to re-authenticate
29355 if AUTH is in use, before sending the next message.
29356
29357 The RFC is not clear as to whether or not an SMTP session continues in clear
29358 after TLS has been shut down, or whether TLS may be restarted again later, as
29359 just described. However, if the server is Exim, this shutdown and
29360 reinitialization works. It is not known which (if any) other servers operate
29361 successfully if the client closes a TLS session and continues with unencrypted
29362 SMTP, but there are certainly some that do not work. For such servers, Exim
29363 should not pass the socket to another process, because the failure of the
29364 subsequent attempt to use it would cause Exim to record a temporary host error,
29365 and delay other deliveries to that host.
29366
29367 To test for this case, Exim sends an EHLO command to the server after
29368 closing down the TLS session. If this fails in any way, the connection is
29369 closed instead of being passed to a new delivery process, but no retry
29370 information is recorded.
29371
29372 There is also a manual override; you can set &%hosts_nopass_tls%& on the
29373 &(smtp)& transport to match those hosts for which Exim should not pass
29374 connections to new processes if TLS has been used.
29375
29376
29377
29378
29379 .section "Certificates and all that" "SECTcerandall"
29380 .cindex "certificate" "references to discussion"
29381 In order to understand fully how TLS works, you need to know about
29382 certificates, certificate signing, and certificate authorities.
29383 This is a large topic and an introductory guide is unsuitable for the Exim
29384 reference manual, so instead we provide pointers to existing documentation.
29385
29386 The Apache web-server was for a long time the canonical guide, so their
29387 documentation is a good place to start; their SSL module's Introduction
29388 document is currently at
29389 .display
29390 &url(https://httpd.apache.org/docs/current/ssl/ssl_intro.html)
29391 .endd
29392 and their FAQ is at
29393 .display
29394 &url(https://httpd.apache.org/docs/current/ssl/ssl_faq.html)
29395 .endd
29396
29397 Eric Rescorla's book, &'SSL and TLS'&, published by Addison-Wesley (ISBN
29398 0-201-61598-3) in 2001, contains both introductory and more in-depth
29399 descriptions.
29400 More recently Ivan Ristić's book &'Bulletproof SSL and TLS'&,
29401 published by Feisty Duck (ISBN 978-1907117046) in 2013 is good.
29402 Ivan is the author of the popular TLS testing tools at
29403 &url(https://www.ssllabs.com/).
29404
29405
29406 .section "Certificate chains" "SECID186"
29407 The file named by &%tls_certificate%& may contain more than one
29408 certificate. This is useful in the case where the certificate that is being
29409 sent is validated by an intermediate certificate which the other end does
29410 not have. Multiple certificates must be in the correct order in the file.
29411 First the host's certificate itself, then the first intermediate
29412 certificate to validate the issuer of the host certificate, then the next
29413 intermediate certificate to validate the issuer of the first intermediate
29414 certificate, and so on, until finally (optionally) the root certificate.
29415 The root certificate must already be trusted by the recipient for
29416 validation to succeed, of course, but if it's not preinstalled, sending the
29417 root certificate along with the rest makes it available for the user to
29418 install if the receiving end is a client MUA that can interact with a user.
29419
29420 Note that certificates using MD5 are unlikely to work on today's Internet;
29421 even if your libraries allow loading them for use in Exim when acting as a
29422 server, increasingly clients will not accept such certificates.  The error
29423 diagnostics in such a case can be frustratingly vague.
29424
29425
29426
29427 .section "Self-signed certificates" "SECID187"
29428 .cindex "certificate" "self-signed"
29429 You can create a self-signed certificate using the &'req'& command provided
29430 with OpenSSL, like this:
29431 . ==== Do not shorten the duration here without reading and considering
29432 . ==== the text below.  Please leave it at 9999 days.
29433 .code
29434 openssl req -x509 -newkey rsa:1024 -keyout file1 -out file2 \
29435             -days 9999 -nodes
29436 .endd
29437 &_file1_& and &_file2_& can be the same file; the key and the certificate are
29438 delimited and so can be identified independently. The &%-days%& option
29439 specifies a period for which the certificate is valid. The &%-nodes%& option is
29440 important: if you do not set it, the key is encrypted with a passphrase
29441 that you are prompted for, and any use that is made of the key causes more
29442 prompting for the passphrase. This is not helpful if you are going to use
29443 this certificate and key in an MTA, where prompting is not possible.
29444
29445 . ==== I expect to still be working 26 years from now.  The less technical
29446 . ==== debt I create, in terms of storing up trouble for my later years, the
29447 . ==== happier I will be then.  We really have reached the point where we
29448 . ==== should start, at the very least, provoking thought and making folks
29449 . ==== pause before proceeding, instead of leaving all the fixes until two
29450 . ==== years before 2^31 seconds after the 1970 Unix epoch.
29451 . ==== -pdp, 2012
29452 NB: we are now past the point where 9999 days takes us past the 32-bit Unix
29453 epoch.  If your system uses unsigned time_t (most do) and is 32-bit, then
29454 the above command might produce a date in the past.  Think carefully about
29455 the lifetime of the systems you're deploying, and either reduce the duration
29456 of the certificate or reconsider your platform deployment.  (At time of
29457 writing, reducing the duration is the most likely choice, but the inexorable
29458 progression of time takes us steadily towards an era where this will not
29459 be a sensible resolution).
29460
29461 A self-signed certificate made in this way is sufficient for testing, and
29462 may be adequate for all your requirements if you are mainly interested in
29463 encrypting transfers, and not in secure identification.
29464
29465 However, many clients require that the certificate presented by the server be a
29466 user (also called &"leaf"& or &"site"&) certificate, and not a self-signed
29467 certificate. In this situation, the self-signed certificate described above
29468 must be installed on the client host as a trusted root &'certification
29469 authority'& (CA), and the certificate used by Exim must be a user certificate
29470 signed with that self-signed certificate.
29471
29472 For information on creating self-signed CA certificates and using them to sign
29473 user certificates, see the &'General implementation overview'& chapter of the
29474 Open-source PKI book, available online at
29475 &url(https://sourceforge.net/projects/ospkibook/).
29476 .ecindex IIDencsmtp1
29477 .ecindex IIDencsmtp2
29478
29479
29480
29481 .section DANE "SECDANE"
29482 .cindex DANE
29483 DNS-based Authentication of Named Entities, as applied to SMTP over TLS, provides assurance to a client that
29484 it is actually talking to the server it wants to rather than some attacker operating a Man In The Middle (MITM)
29485 operation.  The latter can terminate the TLS connection you make, and make another one to the server (so both
29486 you and the server still think you have an encrypted connection) and, if one of the "well known" set of
29487 Certificate Authorities has been suborned - something which *has* been seen already (2014), a verifiable
29488 certificate (if you're using normal root CAs, eg. the Mozilla set, as your trust anchors).
29489
29490 What DANE does is replace the CAs with the DNS as the trust anchor.  The assurance is limited to a) the possibility
29491 that the DNS has been suborned, b) mistakes made by the admins of the target server.   The attack surface presented
29492 by (a) is thought to be smaller than that of the set of root CAs.
29493
29494 It also allows the server to declare (implicitly) that connections to it should use TLS.  An MITM could simply
29495 fail to pass on a server's STARTTLS.
29496
29497 DANE scales better than having to maintain (and side-channel communicate) copies of server certificates
29498 for every possible target server.  It also scales (slightly) better than having to maintain on an SMTP
29499 client a copy of the standard CAs bundle.  It also means not having to pay a CA for certificates.
29500
29501 DANE requires a server operator to do three things: 1) run DNSSEC.  This provides assurance to clients
29502 that DNS lookups they do for the server have not been tampered with.  The domain MX record applying
29503 to this server, its A record, its TLSA record and any associated CNAME records must all be covered by
29504 DNSSEC.
29505 2) add TLSA DNS records.  These say what the server certificate for a TLS connection should be.
29506 3) offer a server certificate, or certificate chain, in TLS connections which is is anchored by one of the TLSA records.
29507
29508 There are no changes to Exim specific to server-side operation of DANE.
29509 Support for client-side operation of DANE can be included at compile time by defining SUPPORT_DANE=yes
29510 in &_Local/Makefile_&.
29511 If it has been included, the macro "_HAVE_DANE" will be defined.
29512
29513 A TLSA record consist of 4 fields, the "Certificate Usage", the
29514 "Selector", the "Matching type", and the "Certificate Association Data".
29515 For a detailed description of the TLSA record see
29516 &url(https://tools.ietf.org/html/rfc7671#page-5,RFC 7671).
29517
29518 The TLSA record for the server may have "Certificate Usage" (1st) field of DANE-TA(2) or DANE-EE(3).
29519 These are the "Trust Anchor" and "End Entity" variants.
29520 The latter specifies the End Entity directly, i.e. the certificate involved is that of the server
29521 (and if only DANE-EE is used then it should be the sole one transmitted during the TLS handshake);
29522 this is appropriate for a single system, using a self-signed certificate.
29523 DANE-TA usage is effectively declaring a specific CA to be used; this might be a private CA or a public,
29524 well-known one.
29525 A private CA at simplest is just a self-signed certificate (with certain
29526 attributes) which is used to sign server certificates, but running one securely
29527 does require careful arrangement.
29528 With DANE-TA, as implemented in Exim and commonly in other MTAs,
29529 the server TLS handshake must transmit the entire certificate chain from CA to server-certificate.
29530 DANE-TA is commonly used for several services and/or servers, each having a TLSA query-domain CNAME record,
29531 all of which point to a single TLSA record.
29532 DANE-TA and DANE-EE can both be used together.
29533
29534 Our recommendation is to use DANE with a certificate from a public CA,
29535 because this enables a variety of strategies for remote clients to verify
29536 your certificate.
29537 You can then publish information both via DANE and another technology,
29538 "MTA-STS", described below.
29539
29540 When you use DANE-TA to publish trust anchor information, you ask entities
29541 outside your administrative control to trust the Certificate Authority for
29542 connections to you.
29543 If using a private CA then you should expect others to still apply the
29544 technical criteria they'd use for a public CA to your certificates.
29545 In particular, you should probably try to follow current best practices for CA
29546 operation around hash algorithms and key sizes.
29547 Do not expect other organizations to lower their security expectations just
29548 because a particular profile might be reasonable for your own internal use.
29549
29550 When this text was last updated, this in practice means to avoid use of SHA-1
29551 and MD5; if using RSA to use key sizes of at least 2048 bits (and no larger
29552 than 4096, for interoperability); to use keyUsage fields correctly; to use
29553 random serial numbers.
29554 The list of requirements is subject to change as best practices evolve.
29555 If you're not already using a private CA, or it doesn't meet these
29556 requirements, then we encourage you to avoid all these issues and use a public
29557 CA such as &url(https://letsencrypt.org/,Let's Encrypt) instead.
29558
29559 The TLSA record should have a "Selector" (2nd) field of SPKI(1) and
29560 a "Matching Type" (3rd) field of SHA2-512(2).
29561
29562 For the "Certificate Authority Data" (4th) field, commands like
29563
29564 .code
29565   openssl x509 -pubkey -noout <certificate.pem \
29566   | openssl rsa -outform der -pubin 2>/dev/null \
29567   | openssl sha512 \
29568   | awk '{print $2}'
29569 .endd
29570
29571 are workable to create a hash of the certificate's public key.
29572
29573 An example TLSA record for DANE-EE(3), SPKI(1), and SHA-512 (2) looks like
29574
29575 .code
29576   _25._tcp.mail.example.com. TLSA 3 1 2 8BA8A336E...
29577 .endd
29578
29579 At the time of writing, &url(https://www.huque.com/bin/gen_tlsa)
29580 is useful for quickly generating TLSA records.
29581
29582
29583 For use with the DANE-TA model, server certificates must have a correct name (SubjectName or SubjectAltName).
29584
29585 The Certificate issued by the CA published in the DANE-TA model should be
29586 issued using a strong hash algorithm.
29587 Exim, and importantly various other MTAs sending to you, will not
29588 re-enable hash algorithms which have been disabled by default in TLS
29589 libraries.
29590 This means no MD5 and no SHA-1.  SHA2-256 is the minimum for reliable
29591 interoperability (and probably the maximum too, in 2018).
29592
29593 The use of OCSP-stapling should be considered, allowing for fast revocation of certificates (which would otherwise
29594 be limited by the DNS TTL on the TLSA records).  However, this is likely to only be usable with DANE-TA.  NOTE: the
29595 default of requesting OCSP for all hosts is modified iff DANE is in use, to:
29596
29597 .code
29598   hosts_request_ocsp = ${if or { {= {0}{$tls_out_tlsa_usage}} \
29599                                  {= {4}{$tls_out_tlsa_usage}} } \
29600                          {*}{}}
29601 .endd
29602
29603 The (new) variable &$tls_out_tlsa_usage$& is a bitfield with numbered bits set for TLSA record usage codes.
29604 The zero above means DANE was not in use, the four means that only DANE-TA usage TLSA records were
29605 found. If the definition of &%hosts_request_ocsp%& includes the
29606 string "tls_out_tlsa_usage", they are re-expanded in time to
29607 control the OCSP request.
29608
29609 This modification of hosts_request_ocsp is only done if it has the default value of "*".  Admins who change it, and
29610 those who use &%hosts_require_ocsp%&, should consider the interaction with DANE in their OCSP settings.
29611
29612
29613 For client-side DANE there are three new smtp transport options, &%hosts_try_dane%&, &%hosts_require_dane%&
29614 and &%dane_require_tls_ciphers%&.
29615 The &"require"& variant will result in failure if the target host is not
29616 DNSSEC-secured. To get DNSSEC-secured hostname resolution, use
29617 the &%dnssec_request_domains%& router or transport option.
29618
29619 DANE will only be usable if the target host has DNSSEC-secured MX, A and TLSA records.
29620
29621 A TLSA lookup will be done if either of the above options match and the host-lookup succeeded using dnssec.
29622 If a TLSA lookup is done and succeeds, a DANE-verified TLS connection
29623 will be required for the host.  If it does not, the host will not
29624 be used; there is no fallback to non-DANE or non-TLS.
29625
29626 If DANE is requested and usable, then the TLS cipher list configuration
29627 prefers to use the option &%dane_require_tls_ciphers%& and falls
29628 back to &%tls_require_ciphers%& only if that is unset.
29629 This lets you configure "decent crypto" for DANE and "better than nothing
29630 crypto" as the default.  Note though that while GnuTLS lets the string control
29631 which versions of TLS/SSL will be negotiated, OpenSSL does not and you're
29632 limited to ciphersuite constraints.
29633
29634 If DANE is requested and useable (see above) the following transport options are ignored:
29635 .code
29636   hosts_require_tls
29637   tls_verify_hosts
29638   tls_try_verify_hosts
29639   tls_verify_certificates
29640   tls_crl
29641   tls_verify_cert_hostnames
29642 .endd
29643
29644 If DANE is not usable, whether requested or not, and CA-anchored
29645 verification evaluation is wanted, the above variables should be set appropriately.
29646
29647 The router and transport option &%dnssec_request_domains%& must not be
29648 set to &"never"&, and &%dnssec_require_domains%& is ignored.
29649
29650 If verification was successful using DANE then the "CV" item in the delivery log line will show as "CV=dane".
29651
29652 There is a new variable &$tls_out_dane$& which will have "yes" if
29653 verification succeeded using DANE and "no" otherwise (only useful
29654 in combination with events; see &<<CHAPevents>>&),
29655 and a new variable &$tls_out_tlsa_usage$& (detailed above).
29656
29657 .cindex DANE reporting
29658 An event (see &<<CHAPevents>>&) of type "dane:fail" will be raised on failures
29659 to achieve DANE-verified connection, if one was either requested and offered, or
29660 required.  This is intended to support TLS-reporting as defined in
29661 &url(https://tools.ietf.org/html/draft-ietf-uta-smtp-tlsrpt-17).
29662 The &$event_data$& will be one of the Result Types defined in
29663 Section 4.3 of that document.
29664
29665 Under GnuTLS, DANE is only supported from version 3.0.0 onwards.
29666
29667 DANE is specified in published RFCs and decouples certificate authority trust
29668 selection from a "race to the bottom" of "you must trust everything for mail
29669 to get through".  There is an alternative technology called MTA-STS, which
29670 instead publishes MX trust anchor information on an HTTPS website.  At the
29671 time this text was last updated, MTA-STS was still a draft, not yet an RFC.
29672 Exim has no support for MTA-STS as a client, but Exim mail server operators
29673 can choose to publish information describing their TLS configuration using
29674 MTA-STS to let those clients who do use that protocol derive trust
29675 information.
29676
29677 The MTA-STS design requires a certificate from a public Certificate Authority
29678 which is recognized by clients sending to you.
29679 That selection of which CAs are trusted by others is outside your control.
29680
29681 The most interoperable course of action is probably to use
29682 &url(https://letsencrypt.org/,Let's Encrypt), with automated certificate
29683 renewal; to publish the anchor information in DNSSEC-secured DNS via TLSA
29684 records for DANE clients (such as Exim and Postfix) and to publish anchor
29685 information for MTA-STS as well.  This is what is done for the &'exim.org'&
29686 domain itself (with caveats around occasionally broken MTA-STS because of
29687 incompatible specification changes prior to reaching RFC status).
29688
29689
29690
29691 . ////////////////////////////////////////////////////////////////////////////
29692 . ////////////////////////////////////////////////////////////////////////////
29693
29694 .chapter "Access control lists" "CHAPACL"
29695 .scindex IIDacl "&ACL;" "description"
29696 .cindex "control of incoming mail"
29697 .cindex "message" "controlling incoming"
29698 .cindex "policy control" "access control lists"
29699 Access Control Lists (ACLs) are defined in a separate section of the runtime
29700 configuration file, headed by &"begin acl"&. Each ACL definition starts with a
29701 name, terminated by a colon. Here is a complete ACL section that contains just
29702 one very small ACL:
29703 .code
29704 begin acl
29705 small_acl:
29706   accept   hosts = one.host.only
29707 .endd
29708 You can have as many lists as you like in the ACL section, and the order in
29709 which they appear does not matter. The lists are self-terminating.
29710
29711 The majority of ACLs are used to control Exim's behaviour when it receives
29712 certain SMTP commands. This applies both to incoming TCP/IP connections, and
29713 when a local process submits a message using SMTP by specifying the &%-bs%&
29714 option. The most common use is for controlling which recipients are accepted
29715 in incoming messages. In addition, you can define an ACL that is used to check
29716 local non-SMTP messages. The default configuration file contains an example of
29717 a realistic ACL for checking RCPT commands. This is discussed in chapter
29718 &<<CHAPdefconfil>>&.
29719
29720
29721 .section "Testing ACLs" "SECID188"
29722 The &%-bh%& command line option provides a way of testing your ACL
29723 configuration locally by running a fake SMTP session with which you interact.
29724
29725
29726 .section "Specifying when ACLs are used" "SECID189"
29727 .cindex "&ACL;" "options for specifying"
29728 In order to cause an ACL to be used, you have to name it in one of the relevant
29729 options in the main part of the configuration. These options are:
29730 .cindex "AUTH" "ACL for"
29731 .cindex "DATA" "ACLs for"
29732 .cindex "ETRN" "ACL for"
29733 .cindex "EXPN" "ACL for"
29734 .cindex "HELO" "ACL for"
29735 .cindex "EHLO" "ACL for"
29736 .cindex "DKIM" "ACL for"
29737 .cindex "MAIL" "ACL for"
29738 .cindex "QUIT, ACL for"
29739 .cindex "RCPT" "ACL for"
29740 .cindex "STARTTLS, ACL for"
29741 .cindex "VRFY" "ACL for"
29742 .cindex "SMTP" "connection, ACL for"
29743 .cindex "non-SMTP messages" "ACLs for"
29744 .cindex "MIME content scanning" "ACL for"
29745 .cindex "PRDR" "ACL for"
29746
29747 .table2 140pt
29748 .irow &%acl_not_smtp%&         "ACL for non-SMTP messages"
29749 .irow &%acl_not_smtp_mime%&    "ACL for non-SMTP MIME parts"
29750 .irow &%acl_not_smtp_start%&   "ACL at start of non-SMTP message"
29751 .irow &%acl_smtp_auth%&        "ACL for AUTH"
29752 .irow &%acl_smtp_connect%&     "ACL for start of SMTP connection"
29753 .irow &%acl_smtp_data%&        "ACL after DATA is complete"
29754 .irow &%acl_smtp_data_prdr%&   "ACL for each recipient, after DATA is complete"
29755 .irow &%acl_smtp_dkim%&        "ACL for each DKIM signer"
29756 .irow &%acl_smtp_etrn%&        "ACL for ETRN"
29757 .irow &%acl_smtp_expn%&        "ACL for EXPN"
29758 .irow &%acl_smtp_helo%&        "ACL for HELO or EHLO"
29759 .irow &%acl_smtp_mail%&        "ACL for MAIL"
29760 .irow &%acl_smtp_mailauth%&    "ACL for the AUTH parameter of MAIL"
29761 .irow &%acl_smtp_mime%&        "ACL for content-scanning MIME parts"
29762 .irow &%acl_smtp_notquit%&     "ACL for non-QUIT terminations"
29763 .irow &%acl_smtp_predata%&     "ACL at start of DATA command"
29764 .irow &%acl_smtp_quit%&        "ACL for QUIT"
29765 .irow &%acl_smtp_rcpt%&        "ACL for RCPT"
29766 .irow &%acl_smtp_starttls%&    "ACL for STARTTLS"
29767 .irow &%acl_smtp_vrfy%&        "ACL for VRFY"
29768 .endtable
29769
29770 For example, if you set
29771 .code
29772 acl_smtp_rcpt = small_acl
29773 .endd
29774 the little ACL defined above is used whenever Exim receives a RCPT command
29775 in an SMTP dialogue. The majority of policy tests on incoming messages can be
29776 done when RCPT commands arrive. A rejection of RCPT should cause the
29777 sending MTA to give up on the recipient address contained in the RCPT
29778 command, whereas rejection at other times may cause the client MTA to keep on
29779 trying to deliver the message. It is therefore recommended that you do as much
29780 testing as possible at RCPT time.
29781
29782
29783 .section "The non-SMTP ACLs" "SECID190"
29784 .cindex "non-SMTP messages" "ACLs for"
29785 The non-SMTP ACLs apply to all non-interactive incoming messages, that is, they
29786 apply to batched SMTP as well as to non-SMTP messages. (Batched SMTP is not
29787 really SMTP.) Many of the ACL conditions (for example, host tests, and tests on
29788 the state of the SMTP connection such as encryption and authentication) are not
29789 relevant and are forbidden in these ACLs. However, the sender and recipients
29790 are known, so the &%senders%& and &%sender_domains%& conditions and the
29791 &$sender_address$& and &$recipients$& variables can be used. Variables such as
29792 &$authenticated_sender$& are also available. You can specify added header lines
29793 in any of these ACLs.
29794
29795 The &%acl_not_smtp_start%& ACL is run right at the start of receiving a
29796 non-SMTP message, before any of the message has been read. (This is the
29797 analogue of the &%acl_smtp_predata%& ACL for SMTP input.) In the case of
29798 batched SMTP input, it runs after the DATA command has been reached. The
29799 result of this ACL is ignored; it cannot be used to reject a message. If you
29800 really need to, you could set a value in an ACL variable here and reject based
29801 on that in the &%acl_not_smtp%& ACL. However, this ACL can be used to set
29802 controls, and in particular, it can be used to set
29803 .code
29804 control = suppress_local_fixups
29805 .endd
29806 This cannot be used in the other non-SMTP ACLs because by the time they are
29807 run, it is too late.
29808
29809 The &%acl_not_smtp_mime%& ACL is available only when Exim is compiled with the
29810 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
29811
29812 The &%acl_not_smtp%& ACL is run just before the &[local_scan()]& function. Any
29813 kind of rejection is treated as permanent, because there is no way of sending a
29814 temporary error for these kinds of message.
29815
29816
29817 .section "The SMTP connect ACL" "SECID191"
29818 .cindex "SMTP" "connection, ACL for"
29819 .oindex &%smtp_banner%&
29820 The ACL test specified by &%acl_smtp_connect%& happens at the start of an SMTP
29821 session, after the test specified by &%host_reject_connection%& (which is now
29822 an anomaly) and any TCP Wrappers testing (if configured). If the connection is
29823 accepted by an &%accept%& verb that has a &%message%& modifier, the contents of
29824 the message override the banner message that is otherwise specified by the
29825 &%smtp_banner%& option.
29826
29827
29828 .section "The EHLO/HELO ACL" "SECID192"
29829 .cindex "EHLO" "ACL for"
29830 .cindex "HELO" "ACL for"
29831 The ACL test specified by &%acl_smtp_helo%& happens when the client issues an
29832 EHLO or HELO command, after the tests specified by &%helo_accept_junk_hosts%&,
29833 &%helo_allow_chars%&, &%helo_verify_hosts%&, and &%helo_try_verify_hosts%&.
29834 Note that a client may issue more than one EHLO or HELO command in an SMTP
29835 session, and indeed is required to issue a new EHLO or HELO after successfully
29836 setting up encryption following a STARTTLS command.
29837
29838 Note also that a deny neither forces the client to go away nor means that
29839 mail will be refused on the connection.  Consider checking for
29840 &$sender_helo_name$& being defined in a MAIL or RCPT ACL to do that.
29841
29842 If the command is accepted by an &%accept%& verb that has a &%message%&
29843 modifier, the message may not contain more than one line (it will be truncated
29844 at the first newline and a panic logged if it does). Such a message cannot
29845 affect the EHLO options that are listed on the second and subsequent lines of
29846 an EHLO response.
29847
29848
29849 .section "The DATA ACLs" "SECID193"
29850 .cindex "DATA" "ACLs for"
29851 Two ACLs are associated with the DATA command, because it is two-stage
29852 command, with two responses being sent to the client.
29853 When the DATA command is received, the ACL defined by &%acl_smtp_predata%&
29854 is obeyed. This gives you control after all the RCPT commands, but before
29855 the message itself is received. It offers the opportunity to give a negative
29856 response to the DATA command before the data is transmitted. Header lines
29857 added by MAIL or RCPT ACLs are not visible at this time, but any that
29858 are defined here are visible when the &%acl_smtp_data%& ACL is run.
29859
29860 You cannot test the contents of the message, for example, to verify addresses
29861 in the headers, at RCPT time or when the DATA command is received. Such
29862 tests have to appear in the ACL that is run after the message itself has been
29863 received, before the final response to the DATA command is sent. This is
29864 the ACL specified by &%acl_smtp_data%&, which is the second ACL that is
29865 associated with the DATA command.
29866
29867 .cindex CHUNKING "BDAT command"
29868 .cindex BDAT "SMTP command"
29869 .cindex "RFC 3030" CHUNKING
29870 If CHUNKING was advertised and a BDAT command sequence is received,
29871 the &%acl_smtp_predata%& ACL is not run.
29872 . XXX why not?  It should be possible, for the first BDAT.
29873 The &%acl_smtp_data%& is run after the last BDAT command and all of
29874 the data specified is received.
29875
29876 For both of these ACLs, it is not possible to reject individual recipients. An
29877 error response rejects the entire message. Unfortunately, it is known that some
29878 MTAs do not treat hard (5&'xx'&) responses to the DATA command (either
29879 before or after the data) correctly &-- they keep the message on their queues
29880 and try again later, but that is their problem, though it does waste some of
29881 your resources.
29882
29883 The &%acl_smtp_data%& ACL is run after
29884 the &%acl_smtp_data_prdr%&,
29885 the &%acl_smtp_dkim%&
29886 and the &%acl_smtp_mime%& ACLs.
29887
29888 .section "The SMTP DKIM ACL" "SECTDKIMACL"
29889 The &%acl_smtp_dkim%& ACL is available only when Exim is compiled with DKIM support
29890 enabled (which is the default).
29891
29892 The ACL test specified by &%acl_smtp_dkim%& happens after a message has been
29893 received, and is executed for each DKIM signature found in a message.  If not
29894 otherwise specified, the default action is to accept.
29895
29896 This ACL is evaluated before &%acl_smtp_mime%& and &%acl_smtp_data%&.
29897
29898 For details on the operation of DKIM, see section &<<SECDKIM>>&.
29899
29900
29901 .section "The SMTP MIME ACL" "SECID194"
29902 The &%acl_smtp_mime%& option is available only when Exim is compiled with the
29903 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
29904
29905 This ACL is evaluated after &%acl_smtp_dkim%& but before &%acl_smtp_data%&.
29906
29907
29908 .section "The SMTP PRDR ACL" "SECTPRDRACL"
29909 .cindex "PRDR" "ACL for"
29910 .oindex "&%prdr_enable%&"
29911 The &%acl_smtp_data_prdr%& ACL is available only when Exim is compiled
29912 with PRDR support enabled (which is the default).
29913 It becomes active only when the PRDR feature is negotiated between
29914 client and server for a message, and more than one recipient
29915 has been accepted.
29916
29917 The ACL test specified by &%acl_smtp_data_prdr%& happens after a message
29918 has been received, and is executed once for each recipient of the message
29919 with &$local_part$& and &$domain$& valid.
29920 The test may accept, defer or deny for individual recipients.
29921 The &%acl_smtp_data%& will still be called after this ACL and
29922 can reject the message overall, even if this ACL has accepted it
29923 for some or all recipients.
29924
29925 PRDR may be used to support per-user content filtering.  Without it
29926 one must defer any recipient after the first that has a different
29927 content-filter configuration.  With PRDR, the RCPT-time check
29928 .cindex "PRDR" "variable for"
29929 for this can be disabled when the variable &$prdr_requested$&
29930 is &"yes"&.
29931 Any required difference in behaviour of the main DATA-time
29932 ACL should however depend on the PRDR-time ACL having run, as Exim
29933 will avoid doing so in some situations (e.g. single-recipient mails).
29934
29935 See also the &%prdr_enable%& global option
29936 and the &%hosts_try_prdr%& smtp transport option.
29937
29938 This ACL is evaluated after &%acl_smtp_dkim%& but before &%acl_smtp_data%&.
29939 If the ACL is not defined, processing completes as if
29940 the feature was not requested by the client.
29941
29942 .section "The QUIT ACL" "SECTQUITACL"
29943 .cindex "QUIT, ACL for"
29944 The ACL for the SMTP QUIT command is anomalous, in that the outcome of the ACL
29945 does not affect the response code to QUIT, which is always 221. Thus, the ACL
29946 does not in fact control any access.
29947 For this reason, it may only accept
29948 or warn as its final result.
29949
29950 This ACL can be used for tasks such as custom logging at the end of an SMTP
29951 session. For example, you can use ACL variables in other ACLs to count
29952 messages, recipients, etc., and log the totals at QUIT time using one or
29953 more &%logwrite%& modifiers on a &%warn%& verb.
29954
29955 &*Warning*&: Only the &$acl_c$&&'x'& variables can be used for this, because
29956 the &$acl_m$&&'x'& variables are reset at the end of each incoming message.
29957
29958 You do not need to have a final &%accept%&, but if you do, you can use a
29959 &%message%& modifier to specify custom text that is sent as part of the 221
29960 response to QUIT.
29961
29962 This ACL is run only for a &"normal"& QUIT. For certain kinds of disastrous
29963 failure (for example, failure to open a log file, or when Exim is bombing out
29964 because it has detected an unrecoverable error), all SMTP commands from the
29965 client are given temporary error responses until QUIT is received or the
29966 connection is closed. In these special cases, the QUIT ACL does not run.
29967
29968
29969 .section "The not-QUIT ACL" "SECTNOTQUITACL"
29970 .vindex &$acl_smtp_notquit$&
29971 The not-QUIT ACL, specified by &%acl_smtp_notquit%&, is run in most cases when
29972 an SMTP session ends without sending QUIT. However, when Exim itself is in bad
29973 trouble, such as being unable to write to its log files, this ACL is not run,
29974 because it might try to do things (such as write to log files) that make the
29975 situation even worse.
29976
29977 Like the QUIT ACL, this ACL is provided to make it possible to do customized
29978 logging or to gather statistics, and its outcome is ignored. The &%delay%&
29979 modifier is forbidden in this ACL, and the only permitted verbs are &%accept%&
29980 and &%warn%&.
29981
29982 .vindex &$smtp_notquit_reason$&
29983 When the not-QUIT ACL is running, the variable &$smtp_notquit_reason$& is set
29984 to a string that indicates the reason for the termination of the SMTP
29985 connection. The possible values are:
29986 .table2
29987 .irow &`acl-drop`&                 "Another ACL issued a &%drop%& command"
29988 .irow &`bad-commands`&             "Too many unknown or non-mail commands"
29989 .irow &`command-timeout`&          "Timeout while reading SMTP commands"
29990 .irow &`connection-lost`&          "The SMTP connection has been lost"
29991 .irow &`data-timeout`&             "Timeout while reading message data"
29992 .irow &`local-scan-error`&         "The &[local_scan()]& function crashed"
29993 .irow &`local-scan-timeout`&       "The &[local_scan()]& function timed out"
29994 .irow &`signal-exit`&              "SIGTERM or SIGINT"
29995 .irow &`synchronization-error`&    "SMTP synchronization error"
29996 .irow &`tls-failed`&               "TLS failed to start"
29997 .endtable
29998 In most cases when an SMTP connection is closed without having received QUIT,
29999 Exim sends an SMTP response message before actually closing the connection.
30000 With the exception of the &`acl-drop`& case, the default message can be
30001 overridden by the &%message%& modifier in the not-QUIT ACL. In the case of a
30002 &%drop%& verb in another ACL, it is the message from the other ACL that is
30003 used.
30004
30005
30006 .section "Finding an ACL to use" "SECID195"
30007 .cindex "&ACL;" "finding which to use"
30008 The value of an &%acl_smtp_%&&'xxx'& option is expanded before use, so
30009 you can use different ACLs in different circumstances. For example,
30010 .code
30011 acl_smtp_rcpt = ${if ={25}{$interface_port} \
30012                      {acl_check_rcpt} {acl_check_rcpt_submit} }
30013 .endd
30014 In the default configuration file there are some example settings for
30015 providing an RFC 4409 message &"submission"& service on port 587 and
30016 an RFC 8314 &"submissions"& service on port 465. You can use a string
30017 expansion like this to choose an ACL for MUAs on these ports which is
30018 more appropriate for this purpose than the default ACL on port 25.
30019
30020 The expanded string does not have to be the name of an ACL in the
30021 configuration file; there are other possibilities. Having expanded the
30022 string, Exim searches for an ACL as follows:
30023
30024 .ilist
30025 If the string begins with a slash, Exim uses it as a filename, and reads its
30026 contents as an ACL. The lines are processed in the same way as lines in the
30027 Exim configuration file. In particular, continuation lines are supported, blank
30028 lines are ignored, as are lines whose first non-whitespace character is &"#"&.
30029 If the file does not exist or cannot be read, an error occurs (typically
30030 causing a temporary failure of whatever caused the ACL to be run). For example:
30031 .code
30032 acl_smtp_data = /etc/acls/\
30033   ${lookup{$sender_host_address}lsearch\
30034   {/etc/acllist}{$value}{default}}
30035 .endd
30036 This looks up an ACL file to use on the basis of the host's IP address, falling
30037 back to a default if the lookup fails. If an ACL is successfully read from a
30038 file, it is retained in memory for the duration of the Exim process, so that it
30039 can be re-used without having to re-read the file.
30040 .next
30041 If the string does not start with a slash, and does not contain any spaces,
30042 Exim searches the ACL section of the configuration for an ACL whose name
30043 matches the string.
30044 .next
30045 If no named ACL is found, or if the string contains spaces, Exim parses
30046 the string as an inline ACL. This can save typing in cases where you just
30047 want to have something like
30048 .code
30049 acl_smtp_vrfy = accept
30050 .endd
30051 in order to allow free use of the VRFY command. Such a string may contain
30052 newlines; it is processed in the same way as an ACL that is read from a file.
30053 .endlist
30054
30055
30056
30057
30058 .section "ACL return codes" "SECID196"
30059 .cindex "&ACL;" "return codes"
30060 Except for the QUIT ACL, which does not affect the SMTP return code (see
30061 section &<<SECTQUITACL>>& above), the result of running an ACL is either
30062 &"accept"& or &"deny"&, or, if some test cannot be completed (for example, if a
30063 database is down), &"defer"&. These results cause 2&'xx'&, 5&'xx'&, and 4&'xx'&
30064 return codes, respectively, to be used in the SMTP dialogue. A fourth return,
30065 &"error"&, occurs when there is an error such as invalid syntax in the ACL.
30066 This also causes a 4&'xx'& return code.
30067
30068 For the non-SMTP ACL, &"defer"& and &"error"& are treated in the same way as
30069 &"deny"&, because there is no mechanism for passing temporary errors to the
30070 submitters of non-SMTP messages.
30071
30072
30073 ACLs that are relevant to message reception may also return &"discard"&. This
30074 has the effect of &"accept"&, but causes either the entire message or an
30075 individual recipient address to be discarded. In other words, it is a
30076 blackholing facility. Use it with care.
30077
30078 If the ACL for MAIL returns &"discard"&, all recipients are discarded, and no
30079 ACL is run for subsequent RCPT commands. The effect of &"discard"& in a
30080 RCPT ACL is to discard just the one recipient address. If there are no
30081 recipients left when the message's data is received, the DATA ACL is not
30082 run. A &"discard"& return from the DATA or the non-SMTP ACL discards all the
30083 remaining recipients. The &"discard"& return is not permitted for the
30084 &%acl_smtp_predata%& ACL.
30085
30086 If the ACL for VRFY returns &"accept"&, a recipient verify (without callout)
30087 is done on the address and the result determines the SMTP response.
30088
30089
30090 .cindex "&[local_scan()]& function" "when all recipients discarded"
30091 The &[local_scan()]& function is always run, even if there are no remaining
30092 recipients; it may create new recipients.
30093
30094
30095
30096 .section "Unset ACL options" "SECID197"
30097 .cindex "&ACL;" "unset options"
30098 The default actions when any of the &%acl_%&&'xxx'& options are unset are not
30099 all the same. &*Note*&: These defaults apply only when the relevant ACL is
30100 not defined at all. For any defined ACL, the default action when control
30101 reaches the end of the ACL statements is &"deny"&.
30102
30103 For &%acl_smtp_quit%& and &%acl_not_smtp_start%& there is no default because
30104 these two are ACLs that are used only for their side effects. They cannot be
30105 used to accept or reject anything.
30106
30107 For &%acl_not_smtp%&, &%acl_smtp_auth%&, &%acl_smtp_connect%&,
30108 &%acl_smtp_data%&, &%acl_smtp_helo%&, &%acl_smtp_mail%&, &%acl_smtp_mailauth%&,
30109 &%acl_smtp_mime%&, &%acl_smtp_predata%&, and &%acl_smtp_starttls%&, the action
30110 when the ACL is not defined is &"accept"&.
30111
30112 For the others (&%acl_smtp_etrn%&, &%acl_smtp_expn%&, &%acl_smtp_rcpt%&, and
30113 &%acl_smtp_vrfy%&), the action when the ACL is not defined is &"deny"&.
30114 This means that &%acl_smtp_rcpt%& must be defined in order to receive any
30115 messages over an SMTP connection. For an example, see the ACL in the default
30116 configuration file.
30117
30118
30119
30120
30121 .section "Data for message ACLs" "SECID198"
30122 .cindex "&ACL;" "data for message ACL"
30123 .vindex &$domain$&
30124 .vindex &$local_part$&
30125 .vindex &$sender_address$&
30126 .vindex &$sender_host_address$&
30127 .vindex &$smtp_command$&
30128 When a MAIL or RCPT ACL, or either of the DATA ACLs, is running, the variables
30129 that contain information about the host and the message's sender (for example,
30130 &$sender_host_address$& and &$sender_address$&) are set, and can be used in ACL
30131 statements. In the case of RCPT (but not MAIL or DATA), &$domain$& and
30132 &$local_part$& are set from the argument address. The entire SMTP command
30133 is available in &$smtp_command$&.
30134
30135 When an ACL for the AUTH parameter of MAIL is running, the variables that
30136 contain information about the host are set, but &$sender_address$& is not yet
30137 set. Section &<<SECTauthparamail>>& contains a discussion of this parameter and
30138 how it is used.
30139
30140 .vindex "&$message_size$&"
30141 The &$message_size$& variable is set to the value of the SIZE parameter on
30142 the MAIL command at MAIL, RCPT and pre-data time, or to -1 if
30143 that parameter is not given. The value is updated to the true message size by
30144 the time the final DATA ACL is run (after the message data has been
30145 received).
30146
30147 .vindex "&$rcpt_count$&"
30148 .vindex "&$recipients_count$&"
30149 The &$rcpt_count$& variable increases by one for each RCPT command received.
30150 The &$recipients_count$& variable increases by one each time a RCPT command is
30151 accepted, so while an ACL for RCPT is being processed, it contains the number
30152 of previously accepted recipients. At DATA time (for both the DATA ACLs),
30153 &$rcpt_count$& contains the total number of RCPT commands, and
30154 &$recipients_count$& contains the total number of accepted recipients.
30155
30156
30157
30158
30159
30160 .section "Data for non-message ACLs" "SECTdatfornon"
30161 .cindex "&ACL;" "data for non-message ACL"
30162 .vindex &$smtp_command_argument$&
30163 .vindex &$smtp_command$&
30164 When an ACL is being run for AUTH, EHLO, ETRN, EXPN, HELO, STARTTLS, or VRFY,
30165 the remainder of the SMTP command line is placed in &$smtp_command_argument$&,
30166 and the entire SMTP command is available in &$smtp_command$&.
30167 These variables can be tested using a &%condition%& condition. For example,
30168 here is an ACL for use with AUTH, which insists that either the session is
30169 encrypted, or the CRAM-MD5 authentication method is used. In other words, it
30170 does not permit authentication methods that use cleartext passwords on
30171 unencrypted connections.
30172 .code
30173 acl_check_auth:
30174   accept encrypted = *
30175   accept condition = ${if eq{${uc:$smtp_command_argument}}\
30176                      {CRAM-MD5}}
30177   deny   message   = TLS encryption or CRAM-MD5 required
30178 .endd
30179 (Another way of applying this restriction is to arrange for the authenticators
30180 that use cleartext passwords not to be advertised when the connection is not
30181 encrypted. You can use the generic &%server_advertise_condition%& authenticator
30182 option to do this.)
30183
30184
30185
30186 .section "Format of an ACL" "SECID199"
30187 .cindex "&ACL;" "format of"
30188 .cindex "&ACL;" "verbs, definition of"
30189 An individual ACL consists of a number of statements. Each statement starts
30190 with a verb, optionally followed by a number of conditions and &"modifiers"&.
30191 Modifiers can change the way the verb operates, define error and log messages,
30192 set variables, insert delays, and vary the processing of accepted messages.
30193
30194 If all the conditions are met, the verb is obeyed. The same condition may be
30195 used (with different arguments) more than once in the same statement. This
30196 provides a means of specifying an &"and"& conjunction between conditions. For
30197 example:
30198 .code
30199 deny  dnslists = list1.example
30200       dnslists = list2.example
30201 .endd
30202 If there are no conditions, the verb is always obeyed. Exim stops evaluating
30203 the conditions and modifiers when it reaches a condition that fails. What
30204 happens then depends on the verb (and in one case, on a special modifier). Not
30205 all the conditions make sense at every testing point. For example, you cannot
30206 test a sender address in the ACL that is run for a VRFY command.
30207
30208
30209 .section "ACL verbs" "SECID200"
30210 The ACL verbs are as follows:
30211
30212 .ilist
30213 .cindex "&%accept%& ACL verb"
30214 &%accept%&: If all the conditions are met, the ACL returns &"accept"&. If any
30215 of the conditions are not met, what happens depends on whether &%endpass%&
30216 appears among the conditions (for syntax see below). If the failing condition
30217 is before &%endpass%&, control is passed to the next ACL statement; if it is
30218 after &%endpass%&, the ACL returns &"deny"&. Consider this statement, used to
30219 check a RCPT command:
30220 .code
30221 accept domains = +local_domains
30222        endpass
30223        verify = recipient
30224 .endd
30225 If the recipient domain does not match the &%domains%& condition, control
30226 passes to the next statement. If it does match, the recipient is verified, and
30227 the command is accepted if verification succeeds. However, if verification
30228 fails, the ACL yields &"deny"&, because the failing condition is after
30229 &%endpass%&.
30230
30231 The &%endpass%& feature has turned out to be confusing to many people, so its
30232 use is not recommended nowadays. It is always possible to rewrite an ACL so
30233 that &%endpass%& is not needed, and it is no longer used in the default
30234 configuration.
30235
30236 .cindex "&%message%& ACL modifier" "with &%accept%&"
30237 If a &%message%& modifier appears on an &%accept%& statement, its action
30238 depends on whether or not &%endpass%& is present. In the absence of &%endpass%&
30239 (when an &%accept%& verb either accepts or passes control to the next
30240 statement), &%message%& can be used to vary the message that is sent when an
30241 SMTP command is accepted. For example, in a RCPT ACL you could have:
30242 .display
30243 &`accept  `&<&'some conditions'&>
30244 &`        message = OK, I will allow you through today`&
30245 .endd
30246 You can specify an SMTP response code, optionally followed by an &"extended
30247 response code"& at the start of the message, but the first digit must be the
30248 same as would be sent by default, which is 2 for an &%accept%& verb.
30249
30250 If &%endpass%& is present in an &%accept%& statement, &%message%& specifies
30251 an error message that is used when access is denied. This behaviour is retained
30252 for backward compatibility, but current &"best practice"& is to avoid the use
30253 of &%endpass%&.
30254
30255
30256 .next
30257 .cindex "&%defer%& ACL verb"
30258 &%defer%&: If all the conditions are true, the ACL returns &"defer"& which, in
30259 an SMTP session, causes a 4&'xx'& response to be given. For a non-SMTP ACL,
30260 &%defer%& is the same as &%deny%&, because there is no way of sending a
30261 temporary error. For a RCPT command, &%defer%& is much the same as using a
30262 &(redirect)& router and &`:defer:`& while verifying, but the &%defer%& verb can
30263 be used in any ACL, and even for a recipient it might be a simpler approach.
30264
30265
30266 .next
30267 .cindex "&%deny%& ACL verb"
30268 &%deny%&: If all the conditions are met, the ACL returns &"deny"&. If any of
30269 the conditions are not met, control is passed to the next ACL statement. For
30270 example,
30271 .code
30272 deny dnslists = blackholes.mail-abuse.org
30273 .endd
30274 rejects commands from hosts that are on a DNS black list.
30275
30276
30277 .next
30278 .cindex "&%discard%& ACL verb"
30279 &%discard%&: This verb behaves like &%accept%&, except that it returns
30280 &"discard"& from the ACL instead of &"accept"&. It is permitted only on ACLs
30281 that are concerned with receiving messages. When all the conditions are true,
30282 the sending entity receives a &"success"& response. However, &%discard%& causes
30283 recipients to be discarded. If it is used in an ACL for RCPT, just the one
30284 recipient is discarded; if used for MAIL, DATA or in the non-SMTP ACL, all the
30285 message's recipients are discarded. Recipients that are discarded before DATA
30286 do not appear in the log line when the &%received_recipients%& log selector is set.
30287
30288 If the &%log_message%& modifier is set when &%discard%& operates,
30289 its contents are added to the line that is automatically written to the log.
30290 The &%message%& modifier operates exactly as it does for &%accept%&.
30291
30292
30293 .next
30294 .cindex "&%drop%& ACL verb"
30295 &%drop%&: This verb behaves like &%deny%&, except that an SMTP connection is
30296 forcibly closed after the 5&'xx'& error message has been sent. For example:
30297 .code
30298 drop   condition = ${if > {$rcpt_count}{20}}
30299        message   = I don't take more than 20 RCPTs
30300 .endd
30301 There is no difference between &%deny%& and &%drop%& for the connect-time ACL.
30302 The connection is always dropped after sending a 550 response.
30303
30304 .next
30305 .cindex "&%require%& ACL verb"
30306 &%require%&: If all the conditions are met, control is passed to the next ACL
30307 statement. If any of the conditions are not met, the ACL returns &"deny"&. For
30308 example, when checking a RCPT command,
30309 .code
30310 require message = Sender did not verify
30311         verify  = sender
30312 .endd
30313 passes control to subsequent statements only if the message's sender can be
30314 verified. Otherwise, it rejects the command. Note the positioning of the
30315 &%message%& modifier, before the &%verify%& condition. The reason for this is
30316 discussed in section &<<SECTcondmodproc>>&.
30317
30318 .next
30319 .cindex "&%warn%& ACL verb"
30320 &%warn%&: If all the conditions are true, a line specified by the
30321 &%log_message%& modifier is written to Exim's main log. Control always passes
30322 to the next ACL statement. If any condition is false, the log line is not
30323 written. If an identical log line is requested several times in the same
30324 message, only one copy is actually written to the log. If you want to force
30325 duplicates to be written, use the &%logwrite%& modifier instead.
30326
30327 If &%log_message%& is not present, a &%warn%& verb just checks its conditions
30328 and obeys any &"immediate"& modifiers (such as &%control%&, &%set%&,
30329 &%logwrite%&, &%add_header%&, and &%remove_header%&) that appear before the
30330 first failing condition. There is more about adding header lines in section
30331 &<<SECTaddheadacl>>&.
30332
30333 If any condition on a &%warn%& statement cannot be completed (that is, there is
30334 some sort of defer), the log line specified by &%log_message%& is not written.
30335 This does not include the case of a forced failure from a lookup, which
30336 is considered to be a successful completion. After a defer, no further
30337 conditions or modifiers in the &%warn%& statement are processed. The incident
30338 is logged, and the ACL continues to be processed, from the next statement
30339 onwards.
30340
30341
30342 .vindex "&$acl_verify_message$&"
30343 When one of the &%warn%& conditions is an address verification that fails, the
30344 text of the verification failure message is in &$acl_verify_message$&. If you
30345 want this logged, you must set it up explicitly. For example:
30346 .code
30347 warn   !verify = sender
30348        log_message = sender verify failed: $acl_verify_message
30349 .endd
30350 .endlist
30351
30352 At the end of each ACL there is an implicit unconditional &%deny%&.
30353
30354 As you can see from the examples above, the conditions and modifiers are
30355 written one to a line, with the first one on the same line as the verb, and
30356 subsequent ones on following lines. If you have a very long condition, you can
30357 continue it onto several physical lines by the usual backslash continuation
30358 mechanism. It is conventional to align the conditions vertically.
30359
30360
30361
30362 .section "ACL variables" "SECTaclvariables"
30363 .cindex "&ACL;" "variables"
30364 There are some special variables that can be set during ACL processing. They
30365 can be used to pass information between different ACLs, different invocations
30366 of the same ACL in the same SMTP connection, and between ACLs and the routers,
30367 transports, and filters that are used to deliver a message. The names of these
30368 variables must begin with &$acl_c$& or &$acl_m$&, followed either by a digit or
30369 an underscore, but the remainder of the name can be any sequence of
30370 alphanumeric characters and underscores that you choose. There is no limit on
30371 the number of ACL variables. The two sets act as follows:
30372 .ilist
30373 The values of those variables whose names begin with &$acl_c$& persist
30374 throughout an SMTP connection. They are never reset. Thus, a value that is set
30375 while receiving one message is still available when receiving the next message
30376 on the same SMTP connection.
30377 .next
30378 The values of those variables whose names begin with &$acl_m$& persist only
30379 while a message is being received. They are reset afterwards. They are also
30380 reset by MAIL, RSET, EHLO, HELO, and after starting up a TLS session.
30381 .endlist
30382
30383 When a message is accepted, the current values of all the ACL variables are
30384 preserved with the message and are subsequently made available at delivery
30385 time. The ACL variables are set by a modifier called &%set%&. For example:
30386 .code
30387 accept hosts = whatever
30388        set acl_m4 = some value
30389 accept authenticated = *
30390        set acl_c_auth = yes
30391 .endd
30392 &*Note*&: A leading dollar sign is not used when naming a variable that is to
30393 be set. If you want to set a variable without taking any action, you can use a
30394 &%warn%& verb without any other modifiers or conditions.
30395
30396 .oindex &%strict_acl_vars%&
30397 What happens if a syntactically valid but undefined ACL variable is
30398 referenced depends on the setting of the &%strict_acl_vars%& option. If it is
30399 false (the default), an empty string is substituted; if it is true, an
30400 error is generated.
30401
30402 Versions of Exim before 4.64 have a limited set of numbered variables, but
30403 their names are compatible, so there is no problem with upgrading.
30404
30405
30406 .section "Condition and modifier processing" "SECTcondmodproc"
30407 .cindex "&ACL;" "conditions; processing"
30408 .cindex "&ACL;" "modifiers; processing"
30409 An exclamation mark preceding a condition negates its result. For example:
30410 .code
30411 deny   domains = *.dom.example
30412       !verify  = recipient
30413 .endd
30414 causes the ACL to return &"deny"& if the recipient domain ends in
30415 &'dom.example'& and the recipient address cannot be verified. Sometimes
30416 negation can be used on the right-hand side of a condition. For example, these
30417 two statements are equivalent:
30418 .code
30419 deny  hosts = !192.168.3.4
30420 deny !hosts =  192.168.3.4
30421 .endd
30422 However, for many conditions (&%verify%& being a good example), only left-hand
30423 side negation of the whole condition is possible.
30424
30425 The arguments of conditions and modifiers are expanded. A forced failure
30426 of an expansion causes a condition to be ignored, that is, it behaves as if the
30427 condition is true. Consider these two statements:
30428 .code
30429 accept  senders = ${lookup{$host_name}lsearch\
30430                   {/some/file}{$value}fail}
30431 accept  senders = ${lookup{$host_name}lsearch\
30432                   {/some/file}{$value}{}}
30433 .endd
30434 Each attempts to look up a list of acceptable senders. If the lookup succeeds,
30435 the returned list is searched, but if the lookup fails the behaviour is
30436 different in the two cases. The &%fail%& in the first statement causes the
30437 condition to be ignored, leaving no further conditions. The &%accept%& verb
30438 therefore succeeds. The second statement, however, generates an empty list when
30439 the lookup fails. No sender can match an empty list, so the condition fails,
30440 and therefore the &%accept%& also fails.
30441
30442 ACL modifiers appear mixed in with conditions in ACL statements. Some of them
30443 specify actions that are taken as the conditions for a statement are checked;
30444 others specify text for messages that are used when access is denied or a
30445 warning is generated. The &%control%& modifier affects the way an incoming
30446 message is handled.
30447
30448 The positioning of the modifiers in an ACL statement is important, because the
30449 processing of a verb ceases as soon as its outcome is known. Only those
30450 modifiers that have already been encountered will take effect. For example,
30451 consider this use of the &%message%& modifier:
30452 .code
30453 require message = Can't verify sender
30454         verify  = sender
30455         message = Can't verify recipient
30456         verify  = recipient
30457         message = This message cannot be used
30458 .endd
30459 If sender verification fails, Exim knows that the result of the statement is
30460 &"deny"&, so it goes no further. The first &%message%& modifier has been seen,
30461 so its text is used as the error message. If sender verification succeeds, but
30462 recipient verification fails, the second message is used. If recipient
30463 verification succeeds, the third message becomes &"current"&, but is never used
30464 because there are no more conditions to cause failure.
30465
30466 For the &%deny%& verb, on the other hand, it is always the last &%message%&
30467 modifier that is used, because all the conditions must be true for rejection to
30468 happen. Specifying more than one &%message%& modifier does not make sense, and
30469 the message can even be specified after all the conditions. For example:
30470 .code
30471 deny   hosts = ...
30472       !senders = *@my.domain.example
30473        message = Invalid sender from client host
30474 .endd
30475 The &"deny"& result does not happen until the end of the statement is reached,
30476 by which time Exim has set up the message.
30477
30478
30479
30480 .section "ACL modifiers" "SECTACLmodi"
30481 .cindex "&ACL;" "modifiers; list of"
30482 The ACL modifiers are as follows:
30483
30484 .vlist
30485 .vitem &*add_header*&&~=&~<&'text'&>
30486 This modifier specifies one or more header lines that are to be added to an
30487 incoming message, assuming, of course, that the message is ultimately
30488 accepted. For details, see section &<<SECTaddheadacl>>&.
30489
30490 .vitem &*continue*&&~=&~<&'text'&>
30491 .cindex "&%continue%& ACL modifier"
30492 .cindex "database" "updating in ACL"
30493 This modifier does nothing of itself, and processing of the ACL always
30494 continues with the next condition or modifier. The value of &%continue%& is in
30495 the side effects of expanding its argument. Typically this could be used to
30496 update a database. It is really just a syntactic tidiness, to avoid having to
30497 write rather ugly lines like this:
30498 .display
30499 &`condition = ${if eq{0}{`&<&'some expansion'&>&`}{true}{true}}`&
30500 .endd
30501 Instead, all you need is
30502 .display
30503 &`continue = `&<&'some expansion'&>
30504 .endd
30505
30506 .vitem &*control*&&~=&~<&'text'&>
30507 .cindex "&%control%& ACL modifier"
30508 This modifier affects the subsequent processing of the SMTP connection or of an
30509 incoming message that is accepted. The effect of the first type of control
30510 lasts for the duration of the connection, whereas the effect of the second type
30511 lasts only until the current message has been received. The message-specific
30512 controls always apply to the whole message, not to individual recipients,
30513 even if the &%control%& modifier appears in a RCPT ACL.
30514
30515 As there are now quite a few controls that can be applied, they are described
30516 separately in section &<<SECTcontrols>>&. The &%control%& modifier can be used
30517 in several different ways. For example:
30518
30519 . ==== As this is a nested list, any displays it contains must be indented
30520 . ==== as otherwise they are too far to the left. That comment applies only
30521 . ==== when xmlto and fop are used; formatting with sdop gets it right either
30522 . ==== way.
30523
30524 .ilist
30525 It can be at the end of an &%accept%& statement:
30526 .code
30527     accept  ...some conditions
30528             control = queue
30529 .endd
30530 In this case, the control is applied when this statement yields &"accept"&, in
30531 other words, when the conditions are all true.
30532
30533 .next
30534 It can be in the middle of an &%accept%& statement:
30535 .code
30536     accept  ...some conditions...
30537             control = queue
30538             ...some more conditions...
30539 .endd
30540 If the first set of conditions are true, the control is applied, even if the
30541 statement does not accept because one of the second set of conditions is false.
30542 In this case, some subsequent statement must yield &"accept"& for the control
30543 to be relevant.
30544
30545 .next
30546 It can be used with &%warn%& to apply the control, leaving the
30547 decision about accepting or denying to a subsequent verb. For
30548 example:
30549 .code
30550     warn    ...some conditions...
30551             control = freeze
30552     accept  ...
30553 .endd
30554 This example of &%warn%& does not contain &%message%&, &%log_message%&, or
30555 &%logwrite%&, so it does not add anything to the message and does not write a
30556 log entry.
30557
30558 .next
30559 If you want to apply a control unconditionally, you can use it with a
30560 &%require%& verb. For example:
30561 .code
30562     require  control = no_multiline_responses
30563 .endd
30564 .endlist
30565
30566 .vitem &*delay*&&~=&~<&'time'&>
30567 .cindex "&%delay%& ACL modifier"
30568 .oindex "&%-bh%&"
30569 This modifier may appear in any ACL except notquit. It causes Exim to wait for
30570 the time interval before proceeding. However, when testing Exim using the
30571 &%-bh%& option, the delay is not actually imposed (an appropriate message is
30572 output instead). The time is given in the usual Exim notation, and the delay
30573 happens as soon as the modifier is processed. In an SMTP session, pending
30574 output is flushed before the delay is imposed.
30575
30576 Like &%control%&, &%delay%& can be used with &%accept%& or &%deny%&, for
30577 example:
30578 .code
30579 deny    ...some conditions...
30580         delay = 30s
30581 .endd
30582 The delay happens if all the conditions are true, before the statement returns
30583 &"deny"&. Compare this with:
30584 .code
30585 deny    delay = 30s
30586         ...some conditions...
30587 .endd
30588 which waits for 30s before processing the conditions. The &%delay%& modifier
30589 can also be used with &%warn%& and together with &%control%&:
30590 .code
30591 warn    ...some conditions...
30592         delay = 2m
30593         control = freeze
30594 accept  ...
30595 .endd
30596
30597 If &%delay%& is encountered when the SMTP PIPELINING extension is in use,
30598 responses to several commands are no longer buffered and sent in one packet (as
30599 they would normally be) because all output is flushed before imposing the
30600 delay. This optimization is disabled so that a number of small delays do not
30601 appear to the client as one large aggregated delay that might provoke an
30602 unwanted timeout. You can, however, disable output flushing for &%delay%& by
30603 using a &%control%& modifier to set &%no_delay_flush%&.
30604
30605
30606 .vitem &*endpass*&
30607 .cindex "&%endpass%& ACL modifier"
30608 This modifier, which has no argument, is recognized only in &%accept%& and
30609 &%discard%& statements. It marks the boundary between the conditions whose
30610 failure causes control to pass to the next statement, and the conditions whose
30611 failure causes the ACL to return &"deny"&. This concept has proved to be
30612 confusing to some people, so the use of &%endpass%& is no longer recommended as
30613 &"best practice"&. See the description of &%accept%& above for more details.
30614
30615
30616 .vitem &*log_message*&&~=&~<&'text'&>
30617 .cindex "&%log_message%& ACL modifier"
30618 This modifier sets up a message that is used as part of the log message if the
30619 ACL denies access or a &%warn%& statement's conditions are true. For example:
30620 .code
30621 require log_message = wrong cipher suite $tls_in_cipher
30622         encrypted   = DES-CBC3-SHA
30623 .endd
30624 &%log_message%& is also used when recipients are discarded by &%discard%&. For
30625 example:
30626 .display
30627 &`discard `&<&'some conditions'&>
30628 &`        log_message = Discarded $local_part@$domain because...`&
30629 .endd
30630 When access is denied, &%log_message%& adds to any underlying error message
30631 that may exist because of a condition failure. For example, while verifying a
30632 recipient address, a &':fail:'& redirection might have already set up a
30633 message.
30634
30635 The message may be defined before the conditions to which it applies, because
30636 the string expansion does not happen until Exim decides that access is to be
30637 denied. This means that any variables that are set by the condition are
30638 available for inclusion in the message. For example, the &$dnslist_$&<&'xxx'&>
30639 variables are set after a DNS black list lookup succeeds. If the expansion of
30640 &%log_message%& fails, or if the result is an empty string, the modifier is
30641 ignored.
30642
30643 .vindex "&$acl_verify_message$&"
30644 If you want to use a &%warn%& statement to log the result of an address
30645 verification, you can use &$acl_verify_message$& to include the verification
30646 error message.
30647
30648 If &%log_message%& is used with a &%warn%& statement, &"Warning:"& is added to
30649 the start of the logged message. If the same warning log message is requested
30650 more than once while receiving  a single email message, only one copy is
30651 actually logged. If you want to log multiple copies, use &%logwrite%& instead
30652 of &%log_message%&. In the absence of &%log_message%& and &%logwrite%&, nothing
30653 is logged for a successful &%warn%& statement.
30654
30655 If &%log_message%& is not present and there is no underlying error message (for
30656 example, from the failure of address verification), but &%message%& is present,
30657 the &%message%& text is used for logging rejections. However, if any text for
30658 logging contains newlines, only the first line is logged. In the absence of
30659 both &%log_message%& and &%message%&, a default built-in message is used for
30660 logging rejections.
30661
30662
30663 .vitem "&*log_reject_target*&&~=&~<&'log name list'&>"
30664 .cindex "&%log_reject_target%& ACL modifier"
30665 .cindex "logging in ACL" "specifying which log"
30666 This modifier makes it possible to specify which logs are used for messages
30667 about ACL rejections. Its argument is a colon-separated list of words that can
30668 be &"main"&, &"reject"&, or &"panic"&. The default is &`main:reject`&. The list
30669 may be empty, in which case a rejection is not logged at all. For example, this
30670 ACL fragment writes no logging information when access is denied:
30671 .display
30672 &`deny `&<&'some conditions'&>
30673 &`     log_reject_target =`&
30674 .endd
30675 This modifier can be used in SMTP and non-SMTP ACLs. It applies to both
30676 permanent and temporary rejections. Its effect lasts for the rest of the
30677 current ACL.
30678
30679
30680 .vitem &*logwrite*&&~=&~<&'text'&>
30681 .cindex "&%logwrite%& ACL modifier"
30682 .cindex "logging in ACL" "immediate"
30683 This modifier writes a message to a log file as soon as it is encountered when
30684 processing an ACL. (Compare &%log_message%&, which, except in the case of
30685 &%warn%& and &%discard%&, is used only if the ACL statement denies
30686 access.) The &%logwrite%& modifier can be used to log special incidents in
30687 ACLs. For example:
30688 .display
30689 &`accept `&<&'some special conditions'&>
30690 &`       control  = freeze`&
30691 &`       logwrite = froze message because ...`&
30692 .endd
30693 By default, the message is written to the main log. However, it may begin
30694 with a colon, followed by a comma-separated list of log names, and then
30695 another colon, to specify exactly which logs are to be written. For
30696 example:
30697 .code
30698 logwrite = :main,reject: text for main and reject logs
30699 logwrite = :panic: text for panic log only
30700 .endd
30701
30702
30703 .vitem &*message*&&~=&~<&'text'&>
30704 .cindex "&%message%& ACL modifier"
30705 This modifier sets up a text string that is expanded and used as a response
30706 message when an ACL statement terminates the ACL with an &"accept"&, &"deny"&,
30707 or &"defer"& response. (In the case of the &%accept%& and &%discard%& verbs,
30708 there is some complication if &%endpass%& is involved; see the description of
30709 &%accept%& for details.)
30710
30711 The expansion of the message happens at the time Exim decides that the ACL is
30712 to end, not at the time it processes &%message%&. If the expansion fails, or
30713 generates an empty string, the modifier is ignored. Here is an example where
30714 &%message%& must be specified first, because the ACL ends with a rejection if
30715 the &%hosts%& condition fails:
30716 .code
30717 require  message = Host not recognized
30718          hosts = 10.0.0.0/8
30719 .endd
30720 (Once a condition has failed, no further conditions or modifiers are
30721 processed.)
30722
30723 .cindex "SMTP" "error codes"
30724 .oindex "&%smtp_banner%&
30725 For ACLs that are triggered by SMTP commands, the message is returned as part
30726 of the SMTP response. The use of &%message%& with &%accept%& (or &%discard%&)
30727 is meaningful only for SMTP, as no message is returned when a non-SMTP message
30728 is accepted. In the case of the connect ACL, accepting with a message modifier
30729 overrides the value of &%smtp_banner%&. For the EHLO/HELO ACL, a customized
30730 accept message may not contain more than one line (otherwise it will be
30731 truncated at the first newline and a panic logged), and it cannot affect the
30732 EHLO options.
30733
30734 When SMTP is involved, the message may begin with an overriding response code,
30735 consisting of three digits optionally followed by an &"extended response code"&
30736 of the form &'n.n.n'&, each code being followed by a space. For example:
30737 .code
30738 deny  message = 599 1.2.3 Host not welcome
30739       hosts = 192.168.34.0/24
30740 .endd
30741 The first digit of the supplied response code must be the same as would be sent
30742 by default. A panic occurs if it is not. Exim uses a 550 code when it denies
30743 access, but for the predata ACL, note that the default success code is 354, not
30744 2&'xx'&.
30745
30746 Notwithstanding the previous paragraph, for the QUIT ACL, unlike the others,
30747 the message modifier cannot override the 221 response code.
30748
30749 The text in a &%message%& modifier is literal; any quotes are taken as
30750 literals, but because the string is expanded, backslash escapes are processed
30751 anyway. If the message contains newlines, this gives rise to a multi-line SMTP
30752 response.
30753
30754 .vindex "&$acl_verify_message$&"
30755 For ACLs that are called by an &%acl =%& ACL condition, the message is
30756 stored in &$acl_verify_message$&, from which the calling ACL may use it.
30757
30758 If &%message%& is used on a statement that verifies an address, the message
30759 specified overrides any message that is generated by the verification process.
30760 However, the original message is available in the variable
30761 &$acl_verify_message$&, so you can incorporate it into your message if you
30762 wish. In particular, if you want the text from &%:fail:%& items in &(redirect)&
30763 routers to be passed back as part of the SMTP response, you should either not
30764 use a &%message%& modifier, or make use of &$acl_verify_message$&.
30765
30766 For compatibility with previous releases of Exim, a &%message%& modifier that
30767 is used with a &%warn%& verb behaves in a similar way to the &%add_header%&
30768 modifier, but this usage is now deprecated. However, &%message%& acts only when
30769 all the conditions are true, wherever it appears in an ACL command, whereas
30770 &%add_header%& acts as soon as it is encountered. If &%message%& is used with
30771 &%warn%& in an ACL that is not concerned with receiving a message, it has no
30772 effect.
30773
30774
30775 .vitem &*queue*&&~=&~<&'text'&>
30776 .cindex "&%queue%& ACL modifier"
30777 .cindex "named queues" "selecting in ACL"
30778 This modifier specifies the use of a named queue for spool files
30779 for the message.
30780 It can only be used before the message is received (i.e. not in
30781 the DATA ACL).
30782 This could be used, for example, for known high-volume burst sources
30783 of traffic, or for quarantine of messages.
30784 Separate queue-runner processes will be needed for named queues.
30785 If the text after expansion is empty, the default queue is used.
30786
30787
30788 .vitem &*remove_header*&&~=&~<&'text'&>
30789 This modifier specifies one or more header names in a colon-separated list
30790  that are to be removed from an incoming message, assuming, of course, that
30791 the message is ultimately accepted. For details, see section &<<SECTremoveheadacl>>&.
30792
30793
30794 .vitem &*set*&&~<&'acl_name'&>&~=&~<&'value'&>
30795 .cindex "&%set%& ACL modifier"
30796 This modifier puts a value into one of the ACL variables (see section
30797 &<<SECTaclvariables>>&).
30798
30799
30800 .vitem &*udpsend*&&~=&~<&'parameters'&>
30801 .cindex "UDP communications"
30802 This modifier sends a UDP packet, for purposes such as statistics
30803 collection or behaviour monitoring. The parameters are expanded, and
30804 the result of the expansion must be a colon-separated list consisting
30805 of a destination server, port number, and the packet contents. The
30806 server can be specified as a host name or IPv4 or IPv6 address. The
30807 separator can be changed with the usual angle bracket syntax. For
30808 example, you might want to collect information on which hosts connect
30809 when:
30810 .code
30811 udpsend = <; 2001:dB8::dead:beef ; 1234 ;\
30812              $tod_zulu $sender_host_address
30813 .endd
30814 .endlist
30815
30816
30817
30818
30819 .section "Use of the control modifier" "SECTcontrols"
30820 .cindex "&%control%& ACL modifier"
30821 The &%control%& modifier supports the following settings:
30822
30823 .vlist
30824 .vitem &*control&~=&~allow_auth_unadvertised*&
30825 This modifier allows a client host to use the SMTP AUTH command even when it
30826 has not been advertised in response to EHLO. Furthermore, because there are
30827 apparently some really broken clients that do this, Exim will accept AUTH after
30828 HELO (rather than EHLO) when this control is set. It should be used only if you
30829 really need it, and you should limit its use to those broken clients that do
30830 not work without it. For example:
30831 .code
30832 warn hosts   = 192.168.34.25
30833      control = allow_auth_unadvertised
30834 .endd
30835 Normally, when an Exim server receives an AUTH command, it checks the name of
30836 the authentication mechanism that is given in the command to ensure that it
30837 matches an advertised mechanism. When this control is set, the check that a
30838 mechanism has been advertised is bypassed. Any configured mechanism can be used
30839 by the client. This control is permitted only in the connection and HELO ACLs.
30840
30841
30842 .vitem &*control&~=&~caseful_local_part*& &&&
30843        &*control&~=&~caselower_local_part*&
30844 .cindex "&ACL;" "case of local part in"
30845 .cindex "case of local parts"
30846 .vindex "&$local_part$&"
30847 These two controls are permitted only in the ACL specified by &%acl_smtp_rcpt%&
30848 (that is, during RCPT processing). By default, the contents of &$local_part$&
30849 are lower cased before ACL processing. If &"caseful_local_part"& is specified,
30850 any uppercase letters in the original local part are restored in &$local_part$&
30851 for the rest of the ACL, or until a control that sets &"caselower_local_part"&
30852 is encountered.
30853
30854 These controls affect only the current recipient. Moreover, they apply only to
30855 local part handling that takes place directly in the ACL (for example, as a key
30856 in lookups). If a test to verify the recipient is obeyed, the case-related
30857 handling of the local part during the verification is controlled by the router
30858 configuration (see the &%caseful_local_part%& generic router option).
30859
30860 This facility could be used, for example, to add a spam score to local parts
30861 containing upper case letters. For example, using &$acl_m4$& to accumulate the
30862 spam score:
30863 .code
30864 warn  control = caseful_local_part
30865       set acl_m4 = ${eval:\
30866                      $acl_m4 + \
30867                      ${if match{$local_part}{[A-Z]}{1}{0}}\
30868                     }
30869       control = caselower_local_part
30870 .endd
30871 Notice that we put back the lower cased version afterwards, assuming that
30872 is what is wanted for subsequent tests.
30873
30874
30875 .vitem &*control&~=&~cutthrough_delivery/*&<&'options'&>
30876 .cindex "&ACL;" "cutthrough routing"
30877 .cindex "cutthrough" "requesting"
30878 This option requests delivery be attempted while the item is being received.
30879
30880 The option is usable in the RCPT ACL.
30881 If enabled for a message received via smtp and routed to an smtp transport,
30882 and only one transport, interface, destination host and port combination
30883 is used for all recipients of the message,
30884 then the delivery connection is made while the receiving connection is open
30885 and data is copied from one to the other.
30886
30887 An attempt to set this option for any recipient but the first
30888 for a mail will be quietly ignored.
30889 If a recipient-verify callout
30890 (with use_sender)
30891 connection is subsequently
30892 requested in the same ACL it is held open and used for
30893 any subsequent recipients and the data,
30894 otherwise one is made after the initial RCPT ACL completes.
30895
30896 Note that routers are used in verify mode,
30897 and cannot depend on content of received headers.
30898 Note also that headers cannot be
30899 modified by any of the post-data ACLs (DATA, MIME and DKIM).
30900 Headers may be modified by routers (subject to the above) and transports.
30901 The &'Received-By:'& header is generated as soon as the body reception starts,
30902 rather than the traditional time after the full message is received;
30903 this will affect the timestamp.
30904
30905 All the usual ACLs are called; if one results in the message being
30906 rejected, all effort spent in delivery (including the costs on
30907 the ultimate destination) will be wasted.
30908 Note that in the case of data-time ACLs this includes the entire
30909 message body.
30910
30911 Cutthrough delivery is not supported via transport-filters or when DKIM signing
30912 of outgoing messages is done, because it sends data to the ultimate destination
30913 before the entire message has been received from the source.
30914 It is not supported for messages received with the SMTP PRDR
30915 or CHUNKING
30916 options in use.
30917
30918 Should the ultimate destination system positively accept or reject the mail,
30919 a corresponding indication is given to the source system and nothing is queued.
30920 If the item is successfully delivered in cutthrough mode
30921 the delivery log lines are tagged with ">>" rather than "=>" and appear
30922 before the acceptance "<=" line.
30923
30924 If there is a temporary error the item is queued for later delivery in the
30925 usual fashion.
30926 This behaviour can be adjusted by appending the option &*defer=*&<&'value'&>
30927 to the control; the default value is &"spool"& and the alternate value
30928 &"pass"& copies an SMTP defer response from the target back to the initiator
30929 and does not queue the message.
30930 Note that this is independent of any recipient verify conditions in the ACL.
30931
30932 Delivery in this mode avoids the generation of a bounce mail to a
30933 (possibly faked)
30934 sender when the destination system is doing content-scan based rejection.
30935
30936
30937 .vitem &*control&~=&~debug/*&<&'options'&>
30938 .cindex "&ACL;" "enabling debug logging"
30939 .cindex "debugging" "enabling from an ACL"
30940 This control turns on debug logging, almost as though Exim had been invoked
30941 with &`-d`&, with the output going to a new logfile in the usual logs directory,
30942 by default called &'debuglog'&.
30943 The filename can be adjusted with the &'tag'& option, which
30944 may access any variables already defined.  The logging may be adjusted with
30945 the &'opts'& option, which takes the same values as the &`-d`& command-line
30946 option.
30947 Logging started this way may be stopped, and the file removed,
30948 with the &'kill'& option.
30949 Some examples (which depend on variables that don't exist in all
30950 contexts):
30951 .code
30952       control = debug
30953       control = debug/tag=.$sender_host_address
30954       control = debug/opts=+expand+acl
30955       control = debug/tag=.$message_exim_id/opts=+expand
30956       control = debug/kill
30957 .endd
30958
30959
30960 .vitem &*control&~=&~dkim_disable_verify*&
30961 .cindex "disable DKIM verify"
30962 .cindex "DKIM" "disable verify"
30963 This control turns off DKIM verification processing entirely.  For details on
30964 the operation and configuration of DKIM, see section &<<SECDKIM>>&.
30965
30966
30967 .vitem &*control&~=&~dmarc_disable_verify*&
30968 .cindex "disable DMARC verify"
30969 .cindex "DMARC" "disable verify"
30970 This control turns off DMARC verification processing entirely.  For details on
30971 the operation and configuration of DMARC, see section &<<SECDMARC>>&.
30972
30973
30974 .vitem &*control&~=&~dscp/*&<&'value'&>
30975 .cindex "&ACL;" "setting DSCP value"
30976 .cindex "DSCP" "inbound"
30977 This option causes the DSCP value associated with the socket for the inbound
30978 connection to be adjusted to a given value, given as one of a number of fixed
30979 strings or to numeric value.
30980 The &%-bI:dscp%& option may be used to ask Exim which names it knows of.
30981 Common values include &`throughput`&, &`mincost`&, and on newer systems
30982 &`ef`&, &`af41`&, etc.  Numeric values may be in the range 0 to 0x3F.
30983
30984 The outbound packets from Exim will be marked with this value in the header
30985 (for IPv4, the TOS field; for IPv6, the TCLASS field); there is no guarantee
30986 that these values will have any effect, not be stripped by networking
30987 equipment, or do much of anything without cooperation with your Network
30988 Engineer and those of all network operators between the source and destination.
30989
30990
30991 .vitem &*control&~=&~enforce_sync*& &&&
30992        &*control&~=&~no_enforce_sync*&
30993 .cindex "SMTP" "synchronization checking"
30994 .cindex "synchronization checking in SMTP"
30995 These controls make it possible to be selective about when SMTP synchronization
30996 is enforced. The global option &%smtp_enforce_sync%& specifies the initial
30997 state of the switch (it is true by default). See the description of this option
30998 in chapter &<<CHAPmainconfig>>& for details of SMTP synchronization checking.
30999
31000 The effect of these two controls lasts for the remainder of the SMTP
31001 connection. They can appear in any ACL except the one for the non-SMTP
31002 messages. The most straightforward place to put them is in the ACL defined by
31003 &%acl_smtp_connect%&, which is run at the start of an incoming SMTP connection,
31004 before the first synchronization check. The expected use is to turn off the
31005 synchronization checks for badly-behaved hosts that you nevertheless need to
31006 work with.
31007
31008
31009 .vitem &*control&~=&~fakedefer/*&<&'message'&>
31010 .cindex "fake defer"
31011 .cindex "defer, fake"
31012 This control works in exactly the same way as &%fakereject%& (described below)
31013 except that it causes an SMTP 450 response after the message data instead of a
31014 550 response. You must take care when using &%fakedefer%& because it causes the
31015 messages to be duplicated when the sender retries. Therefore, you should not
31016 use &%fakedefer%& if the message is to be delivered normally.
31017
31018 .vitem &*control&~=&~fakereject/*&<&'message'&>
31019 .cindex "fake rejection"
31020 .cindex "rejection, fake"
31021 This control is permitted only for the MAIL, RCPT, and DATA ACLs, in other
31022 words, only when an SMTP message is being received. If Exim accepts the
31023 message, instead the final 250 response, a 550 rejection message is sent.
31024 However, Exim proceeds to deliver the message as normal. The control applies
31025 only to the current message, not to any subsequent ones that may be received in
31026 the same SMTP connection.
31027
31028 The text for the 550 response is taken from the &%control%& modifier. If no
31029 message is supplied, the following is used:
31030 .code
31031 550-Your message has been rejected but is being
31032 550-kept for evaluation.
31033 550-If it was a legitimate message, it may still be
31034 550 delivered to the target recipient(s).
31035 .endd
31036 This facility should be used with extreme caution.
31037
31038 .vitem &*control&~=&~freeze*&
31039 .cindex "frozen messages" "forcing in ACL"
31040 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
31041 other words, only when a message is being received. If the message is accepted,
31042 it is placed on Exim's queue and frozen. The control applies only to the
31043 current message, not to any subsequent ones that may be received in the same
31044 SMTP connection.
31045
31046 This modifier can optionally be followed by &`/no_tell`&. If the global option
31047 &%freeze_tell%& is set, it is ignored for the current message (that is, nobody
31048 is told about the freezing), provided all the &*control=freeze*& modifiers that
31049 are obeyed for the current message have the &`/no_tell`& option.
31050
31051 .vitem &*control&~=&~no_delay_flush*&
31052 .cindex "SMTP" "output flushing, disabling for delay"
31053 Exim normally flushes SMTP output before implementing a delay in an ACL, to
31054 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
31055 use. This control, as long as it is encountered before the &%delay%& modifier,
31056 disables such output flushing.
31057
31058 .vitem &*control&~=&~no_callout_flush*&
31059 .cindex "SMTP" "output flushing, disabling for callout"
31060 Exim normally flushes SMTP output before performing a callout in an ACL, to
31061 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
31062 use. This control, as long as it is encountered before the &%verify%& condition
31063 that causes the callout, disables such output flushing.
31064
31065 .vitem &*control&~=&~no_mbox_unspool*&
31066 This control is available when Exim is compiled with the content scanning
31067 extension. Content scanning may require a copy of the current message, or parts
31068 of it, to be written in &"mbox format"& to a spool file, for passing to a virus
31069 or spam scanner. Normally, such copies are deleted when they are no longer
31070 needed. If this control is set, the copies are not deleted. The control applies
31071 only to the current message, not to any subsequent ones that may be received in
31072 the same SMTP connection. It is provided for debugging purposes and is unlikely
31073 to be useful in production.
31074
31075 .vitem &*control&~=&~no_multiline_responses*&
31076 .cindex "multiline responses, suppressing"
31077 This control is permitted for any ACL except the one for non-SMTP messages.
31078 It seems that there are broken clients in use that cannot handle multiline
31079 SMTP responses, despite the fact that RFC 821 defined them over 20 years ago.
31080
31081 If this control is set, multiline SMTP responses from ACL rejections are
31082 suppressed. One way of doing this would have been to put out these responses as
31083 one long line. However, RFC 2821 specifies a maximum of 512 bytes per response
31084 (&"use multiline responses for more"& it says &-- ha!), and some of the
31085 responses might get close to that. So this facility, which is after all only a
31086 sop to broken clients, is implemented by doing two very easy things:
31087
31088 .ilist
31089 Extra information that is normally output as part of a rejection caused by
31090 sender verification failure is omitted. Only the final line (typically &"sender
31091 verification failed"&) is sent.
31092 .next
31093 If a &%message%& modifier supplies a multiline response, only the first
31094 line is output.
31095 .endlist
31096
31097 The setting of the switch can, of course, be made conditional on the
31098 calling host. Its effect lasts until the end of the SMTP connection.
31099
31100 .vitem &*control&~=&~no_pipelining*&
31101 .cindex "PIPELINING" "suppressing advertising"
31102 .cindex "ESMTP extensions" PIPELINING
31103 This control turns off the advertising of the PIPELINING extension to SMTP in
31104 the current session. To be useful, it must be obeyed before Exim sends its
31105 response to an EHLO command. Therefore, it should normally appear in an ACL
31106 controlled by &%acl_smtp_connect%& or &%acl_smtp_helo%&. See also
31107 &%pipelining_advertise_hosts%&.
31108
31109 .new
31110 .vitem &*control&~=&~queue/*&<&'options'&>* &&&
31111        &*control&~=&~queue_only*&
31112 .oindex "&%queue%&"
31113 .oindex "&%queue_only%&"
31114 .cindex "queueing incoming messages"
31115 .cindex queueing "forcing in ACL"
31116 .cindex "first pass routing"
31117 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
31118 other words, only when a message is being received. If the message is accepted,
31119 it is placed on Exim's queue and left there for delivery by a subsequent queue
31120 runner.
31121 If used with no options set,
31122 no immediate delivery process is started. In other words, it has the
31123 effect as the &%queue_only%& global option or &'-odq'& command-line option.
31124
31125 If the &'first_pass_route'& option is given then
31126 the behaviour is like the command-line &'-oqds'& option;
31127 a delivery process is started which stops short of making
31128 any SMTP delivery.  The benefit is that the hints database will be updated for
31129 the message being waiting for a specific host, and a later queue run will be
31130 able to send all such messages on a single connection.
31131
31132 The control only applies to the current message, not to any subsequent ones that
31133  may be received in the same SMTP connection.
31134 .wen
31135
31136 .vitem &*control&~=&~submission/*&<&'options'&>
31137 .cindex "message" "submission"
31138 .cindex "submission mode"
31139 This control is permitted only for the MAIL, RCPT, and start of data ACLs (the
31140 latter is the one defined by &%acl_smtp_predata%&). Setting it tells Exim that
31141 the current message is a submission from a local MUA. In this case, Exim
31142 operates in &"submission mode"&, and applies certain fixups to the message if
31143 necessary. For example, it adds a &'Date:'& header line if one is not present.
31144 This control is not permitted in the &%acl_smtp_data%& ACL, because that is too
31145 late (the message has already been created).
31146
31147 Chapter &<<CHAPmsgproc>>& describes the processing that Exim applies to
31148 messages. Section &<<SECTsubmodnon>>& covers the processing that happens in
31149 submission mode; the available options for this control are described there.
31150 The control applies only to the current message, not to any subsequent ones
31151 that may be received in the same SMTP connection.
31152
31153 .vitem &*control&~=&~suppress_local_fixups*&
31154 .cindex "submission fixups, suppressing"
31155 This control applies to locally submitted (non TCP/IP) messages, and is the
31156 complement of &`control = submission`&. It disables the fixups that are
31157 normally applied to locally-submitted messages. Specifically:
31158
31159 .ilist
31160 Any &'Sender:'& header line is left alone (in this respect, it is a
31161 dynamic version of &%local_sender_retain%&).
31162 .next
31163 No &'Message-ID:'&, &'From:'&, or &'Date:'& header lines are added.
31164 .next
31165 There is no check that &'From:'& corresponds to the actual sender.
31166 .endlist ilist
31167
31168 This control may be useful when a remotely-originated message is accepted,
31169 passed to some scanning program, and then re-submitted for delivery. It can be
31170 used only in the &%acl_smtp_mail%&, &%acl_smtp_rcpt%&, &%acl_smtp_predata%&,
31171 and &%acl_not_smtp_start%& ACLs, because it has to be set before the message's
31172 data is read.
31173
31174 &*Note:*& This control applies only to the current message, not to any others
31175 that are being submitted at the same time using &%-bs%& or &%-bS%&.
31176
31177 .vitem &*control&~=&~utf8_downconvert*&
31178 This control enables conversion of UTF-8 in message envelope addresses
31179 to a-label form.
31180 For details see section &<<SECTi18nMTA>>&.
31181 .endlist vlist
31182
31183
31184 .section "Summary of message fixup control" "SECTsummesfix"
31185 All four possibilities for message fixups can be specified:
31186
31187 .ilist
31188 Locally submitted, fixups applied: the default.
31189 .next
31190 Locally submitted, no fixups applied: use
31191 &`control = suppress_local_fixups`&.
31192 .next
31193 Remotely submitted, no fixups applied: the default.
31194 .next
31195 Remotely submitted, fixups applied: use &`control = submission`&.
31196 .endlist
31197
31198
31199
31200 .section "Adding header lines in ACLs" "SECTaddheadacl"
31201 .cindex "header lines" "adding in an ACL"
31202 .cindex "header lines" "position of added lines"
31203 .cindex "&%add_header%& ACL modifier"
31204 The &%add_header%& modifier can be used to add one or more extra header lines
31205 to an incoming message, as in this example:
31206 .code
31207 warn dnslists = sbl.spamhaus.org : \
31208                 dialup.mail-abuse.org
31209      add_header = X-blacklisted-at: $dnslist_domain
31210 .endd
31211 The &%add_header%& modifier is permitted in the MAIL, RCPT, PREDATA, DATA,
31212 MIME, DKIM, and non-SMTP ACLs (in other words, those that are concerned with
31213 receiving a message). The message must ultimately be accepted for
31214 &%add_header%& to have any significant effect. You can use &%add_header%& with
31215 any ACL verb, including &%deny%& (though this is potentially useful only in a
31216 RCPT ACL).
31217
31218 Headers will not be added to the message if the modifier is used in
31219 DATA, MIME or DKIM ACLs for a message delivered by cutthrough routing.
31220
31221 Leading and trailing newlines are removed from
31222 the data for the &%add_header%& modifier; if it then
31223 contains one or more newlines that
31224 are not followed by a space or a tab, it is assumed to contain multiple header
31225 lines. Each one is checked for valid syntax; &`X-ACL-Warn:`& is added to the
31226 front of any line that is not a valid header line.
31227
31228 Added header lines are accumulated during the MAIL, RCPT, and predata ACLs.
31229 They are added to the message before processing the DATA and MIME ACLs.
31230 However, if an identical header line is requested more than once, only one copy
31231 is actually added to the message. Further header lines may be accumulated
31232 during the DATA and MIME ACLs, after which they are added to the message, again
31233 with duplicates suppressed. Thus, it is possible to add two identical header
31234 lines to an SMTP message, but only if one is added before DATA and one after.
31235 In the case of non-SMTP messages, new headers are accumulated during the
31236 non-SMTP ACLs, and are added to the message after all the ACLs have run. If a
31237 message is rejected after DATA or by the non-SMTP ACL, all added header lines
31238 are included in the entry that is written to the reject log.
31239
31240 .cindex "header lines" "added; visibility of"
31241 Header lines are not visible in string expansions
31242 of message headers
31243 until they are added to the
31244 message. It follows that header lines defined in the MAIL, RCPT, and predata
31245 ACLs are not visible until the DATA ACL and MIME ACLs are run. Similarly,
31246 header lines that are added by the DATA or MIME ACLs are not visible in those
31247 ACLs. Because of this restriction, you cannot use header lines as a way of
31248 passing data between (for example) the MAIL and RCPT ACLs. If you want to do
31249 this, you can use ACL variables, as described in section
31250 &<<SECTaclvariables>>&.
31251
31252 The list of headers yet to be added is given by the &%$headers_added%& variable.
31253
31254 The &%add_header%& modifier acts immediately as it is encountered during the
31255 processing of an ACL. Notice the difference between these two cases:
31256 .display
31257 &`accept add_header = ADDED: some text`&
31258 &`       `&<&'some condition'&>
31259
31260 &`accept `&<&'some condition'&>
31261 &`       add_header = ADDED: some text`&
31262 .endd
31263 In the first case, the header line is always added, whether or not the
31264 condition is true. In the second case, the header line is added only if the
31265 condition is true. Multiple occurrences of &%add_header%& may occur in the same
31266 ACL statement. All those that are encountered before a condition fails are
31267 honoured.
31268
31269 .cindex "&%warn%& ACL verb"
31270 For compatibility with previous versions of Exim, a &%message%& modifier for a
31271 &%warn%& verb acts in the same way as &%add_header%&, except that it takes
31272 effect only if all the conditions are true, even if it appears before some of
31273 them. Furthermore, only the last occurrence of &%message%& is honoured. This
31274 usage of &%message%& is now deprecated. If both &%add_header%& and &%message%&
31275 are present on a &%warn%& verb, both are processed according to their
31276 specifications.
31277
31278 By default, new header lines are added to a message at the end of the existing
31279 header lines. However, you can specify that any particular header line should
31280 be added right at the start (before all the &'Received:'& lines), immediately
31281 after the first block of &'Received:'& lines, or immediately before any line
31282 that is not a &'Received:'& or &'Resent-something:'& header.
31283
31284 This is done by specifying &":at_start:"&, &":after_received:"&, or
31285 &":at_start_rfc:"& (or, for completeness, &":at_end:"&) before the text of the
31286 header line, respectively. (Header text cannot start with a colon, as there has
31287 to be a header name first.) For example:
31288 .code
31289 warn add_header = \
31290        :after_received:X-My-Header: something or other...
31291 .endd
31292 If more than one header line is supplied in a single &%add_header%& modifier,
31293 each one is treated independently and can therefore be placed differently. If
31294 you add more than one line at the start, or after the Received: block, they end
31295 up in reverse order.
31296
31297 &*Warning*&: This facility currently applies only to header lines that are
31298 added in an ACL. It does NOT work for header lines that are added in a
31299 system filter or in a router or transport.
31300
31301
31302
31303 .section "Removing header lines in ACLs" "SECTremoveheadacl"
31304 .cindex "header lines" "removing in an ACL"
31305 .cindex "header lines" "position of removed lines"
31306 .cindex "&%remove_header%& ACL modifier"
31307 The &%remove_header%& modifier can be used to remove one or more header lines
31308 from an incoming message, as in this example:
31309 .code
31310 warn   message        = Remove internal headers
31311        remove_header  = x-route-mail1 : x-route-mail2
31312 .endd
31313 The &%remove_header%& modifier is permitted in the MAIL, RCPT, PREDATA, DATA,
31314 MIME, DKIM, and non-SMTP ACLs (in other words, those that are concerned with
31315 receiving a message). The message must ultimately be accepted for
31316 &%remove_header%& to have any significant effect. You can use &%remove_header%&
31317 with any ACL verb, including &%deny%&, though this is really not useful for
31318 any verb that doesn't result in a delivered message.
31319
31320 Headers will not be removed from the message if the modifier is used in
31321 DATA, MIME or DKIM ACLs for a message delivered by cutthrough routing.
31322
31323 More than one header can be removed at the same time by using a colon separated
31324 list of header names. The header matching is case insensitive. Wildcards are
31325 not permitted, nor is list expansion performed, so you cannot use hostlists to
31326 create a list of headers, however both connection and message variable expansion
31327 are performed (&%$acl_c_*%& and &%$acl_m_*%&), illustrated in this example:
31328 .code
31329 warn   hosts           = +internal_hosts
31330        set acl_c_ihdrs = x-route-mail1 : x-route-mail2
31331 warn   message         = Remove internal headers
31332        remove_header   = $acl_c_ihdrs
31333 .endd
31334 Header names for removal are accumulated during the MAIL, RCPT, and predata ACLs.
31335 Matching header lines are removed from the message before processing the DATA and MIME ACLs.
31336 If multiple header lines match, all are removed.
31337 There is no harm in attempting to remove the same header twice nor in removing
31338 a non-existent header. Further header lines to be removed may be accumulated
31339 during the DATA and MIME ACLs, after which they are removed from the message,
31340 if present. In the case of non-SMTP messages, headers to be removed are
31341 accumulated during the non-SMTP ACLs, and are removed from the message after
31342 all the ACLs have run. If a message is rejected after DATA or by the non-SMTP
31343 ACL, there really is no effect because there is no logging of what headers
31344 would have been removed.
31345
31346 .cindex "header lines" "removed; visibility of"
31347 Header lines are not visible in string expansions until the DATA phase when it
31348 is received. Any header lines removed in the MAIL, RCPT, and predata ACLs are
31349 not visible in the DATA ACL and MIME ACLs. Similarly, header lines that are
31350 removed by the DATA or MIME ACLs are still visible in those ACLs. Because of
31351 this restriction, you cannot use header lines as a way of controlling data
31352 passed between (for example) the MAIL and RCPT ACLs. If you want to do this,
31353 you should instead use ACL variables, as described in section
31354 &<<SECTaclvariables>>&.
31355
31356 The &%remove_header%& modifier acts immediately as it is encountered during the
31357 processing of an ACL. Notice the difference between these two cases:
31358 .display
31359 &`accept remove_header = X-Internal`&
31360 &`       `&<&'some condition'&>
31361
31362 &`accept `&<&'some condition'&>
31363 &`       remove_header = X-Internal`&
31364 .endd
31365 In the first case, the header line is always removed, whether or not the
31366 condition is true. In the second case, the header line is removed only if the
31367 condition is true. Multiple occurrences of &%remove_header%& may occur in the
31368 same ACL statement. All those that are encountered before a condition fails
31369 are honoured.
31370
31371 &*Warning*&: This facility currently applies only to header lines that are
31372 present during ACL processing. It does NOT remove header lines that are added
31373 in a system filter or in a router or transport.
31374
31375
31376
31377
31378 .section "ACL conditions" "SECTaclconditions"
31379 .cindex "&ACL;" "conditions; list of"
31380 Some of the conditions listed in this section are available only when Exim is
31381 compiled with the content-scanning extension. They are included here briefly
31382 for completeness. More detailed descriptions can be found in the discussion on
31383 content scanning in chapter &<<CHAPexiscan>>&.
31384
31385 Not all conditions are relevant in all circumstances. For example, testing
31386 senders and recipients does not make sense in an ACL that is being run as the
31387 result of the arrival of an ETRN command, and checks on message headers can be
31388 done only in the ACLs specified by &%acl_smtp_data%& and &%acl_not_smtp%&. You
31389 can use the same condition (with different parameters) more than once in the
31390 same ACL statement. This provides a way of specifying an &"and"& conjunction.
31391 The conditions are as follows:
31392
31393
31394 .vlist
31395 .vitem &*acl&~=&~*&<&'name&~of&~acl&~or&~ACL&~string&~or&~file&~name&~'&>
31396 .cindex "&ACL;" "nested"
31397 .cindex "&ACL;" "indirect"
31398 .cindex "&ACL;" "arguments"
31399 .cindex "&%acl%& ACL condition"
31400 The possible values of the argument are the same as for the
31401 &%acl_smtp_%&&'xxx'& options. The named or inline ACL is run. If it returns
31402 &"accept"& the condition is true; if it returns &"deny"& the condition is
31403 false. If it returns &"defer"&, the current ACL returns &"defer"& unless the
31404 condition is on a &%warn%& verb. In that case, a &"defer"& return makes the
31405 condition false. This means that further processing of the &%warn%& verb
31406 ceases, but processing of the ACL continues.
31407
31408 If the argument is a named ACL, up to nine space-separated optional values
31409 can be appended; they appear within the called ACL in $acl_arg1 to $acl_arg9,
31410 and $acl_narg is set to the count of values.
31411 Previous values of these variables are restored after the call returns.
31412 The name and values are expanded separately.
31413 Note that spaces in complex expansions which are used as arguments
31414 will act as argument separators.
31415
31416 If the nested &%acl%& returns &"drop"& and the outer condition denies access,
31417 the connection is dropped. If it returns &"discard"&, the verb must be
31418 &%accept%& or &%discard%&, and the action is taken immediately &-- no further
31419 conditions are tested.
31420
31421 ACLs may be nested up to 20 deep; the limit exists purely to catch runaway
31422 loops. This condition allows you to use different ACLs in different
31423 circumstances. For example, different ACLs can be used to handle RCPT commands
31424 for different local users or different local domains.
31425
31426 .vitem &*authenticated&~=&~*&<&'string&~list'&>
31427 .cindex "&%authenticated%& ACL condition"
31428 .cindex "authentication" "ACL checking"
31429 .cindex "&ACL;" "testing for authentication"
31430 If the SMTP connection is not authenticated, the condition is false. Otherwise,
31431 the name of the authenticator is tested against the list. To test for
31432 authentication by any authenticator, you can set
31433 .code
31434 authenticated = *
31435 .endd
31436
31437 .vitem &*condition&~=&~*&<&'string'&>
31438 .cindex "&%condition%& ACL condition"
31439 .cindex "customizing" "ACL condition"
31440 .cindex "&ACL;" "customized test"
31441 .cindex "&ACL;" "testing, customized"
31442 This feature allows you to make up custom conditions. If the result of
31443 expanding the string is an empty string, the number zero, or one of the strings
31444 &"no"& or &"false"&, the condition is false. If the result is any non-zero
31445 number, or one of the strings &"yes"& or &"true"&, the condition is true. For
31446 any other value, some error is assumed to have occurred, and the ACL returns
31447 &"defer"&. However, if the expansion is forced to fail, the condition is
31448 ignored. The effect is to treat it as true, whether it is positive or
31449 negative.
31450
31451 .vitem &*decode&~=&~*&<&'location'&>
31452 .cindex "&%decode%& ACL condition"
31453 This condition is available only when Exim is compiled with the
31454 content-scanning extension, and it is allowed only in the ACL defined by
31455 &%acl_smtp_mime%&. It causes the current MIME part to be decoded into a file.
31456 If all goes well, the condition is true. It is false only if there are
31457 problems such as a syntax error or a memory shortage. For more details, see
31458 chapter &<<CHAPexiscan>>&.
31459
31460 .vitem &*dnslists&~=&~*&<&'list&~of&~domain&~names&~and&~other&~data'&>
31461 .cindex "&%dnslists%& ACL condition"
31462 .cindex "DNS list" "in ACL"
31463 .cindex "black list (DNS)"
31464 .cindex "&ACL;" "testing a DNS list"
31465 This condition checks for entries in DNS black lists. These are also known as
31466 &"RBL lists"&, after the original Realtime Blackhole List, but note that the
31467 use of the lists at &'mail-abuse.org'& now carries a charge. There are too many
31468 different variants of this condition to describe briefly here. See sections
31469 &<<SECTmorednslists>>&&--&<<SECTmorednslistslast>>& for details.
31470
31471 .vitem &*domains&~=&~*&<&'domain&~list'&>
31472 .cindex "&%domains%& ACL condition"
31473 .cindex "domain" "ACL checking"
31474 .cindex "&ACL;" "testing a recipient domain"
31475 .vindex "&$domain_data$&"
31476 This condition is relevant only after a RCPT command. It checks that the domain
31477 of the recipient address is in the domain list. If percent-hack processing is
31478 enabled, it is done before this test is done. If the check succeeds with a
31479 lookup, the result of the lookup is placed in &$domain_data$& until the next
31480 &%domains%& test.
31481
31482 &*Note carefully*& (because many people seem to fall foul of this): you cannot
31483 use &%domains%& in a DATA ACL.
31484
31485
31486 .vitem &*encrypted&~=&~*&<&'string&~list'&>
31487 .cindex "&%encrypted%& ACL condition"
31488 .cindex "encryption" "checking in an ACL"
31489 .cindex "&ACL;" "testing for encryption"
31490 If the SMTP connection is not encrypted, the condition is false. Otherwise, the
31491 name of the cipher suite in use is tested against the list. To test for
31492 encryption without testing for any specific cipher suite(s), set
31493 .code
31494 encrypted = *
31495 .endd
31496
31497
31498 .vitem &*hosts&~=&~*&<&'host&~list'&>
31499 .cindex "&%hosts%& ACL condition"
31500 .cindex "host" "ACL checking"
31501 .cindex "&ACL;" "testing the client host"
31502 This condition tests that the calling host matches the host list. If you have
31503 name lookups or wildcarded host names and IP addresses in the same host list,
31504 you should normally put the IP addresses first. For example, you could have:
31505 .code
31506 accept hosts = 10.9.8.7 : dbm;/etc/friendly/hosts
31507 .endd
31508 The lookup in this example uses the host name for its key. This is implied by
31509 the lookup type &"dbm"&. (For a host address lookup you would use &"net-dbm"&
31510 and it wouldn't matter which way round you had these two items.)
31511
31512 The reason for the problem with host names lies in the left-to-right way that
31513 Exim processes lists. It can test IP addresses without doing any DNS lookups,
31514 but when it reaches an item that requires a host name, it fails if it cannot
31515 find a host name to compare with the pattern. If the above list is given in the
31516 opposite order, the &%accept%& statement fails for a host whose name cannot be
31517 found, even if its IP address is 10.9.8.7.
31518
31519 If you really do want to do the name check first, and still recognize the IP
31520 address even if the name lookup fails, you can rewrite the ACL like this:
31521 .code
31522 accept hosts = dbm;/etc/friendly/hosts
31523 accept hosts = 10.9.8.7
31524 .endd
31525 The default action on failing to find the host name is to assume that the host
31526 is not in the list, so the first &%accept%& statement fails. The second
31527 statement can then check the IP address.
31528
31529 .vindex "&$host_data$&"
31530 If a &%hosts%& condition is satisfied by means of a lookup, the result
31531 of the lookup is made available in the &$host_data$& variable. This
31532 allows you, for example, to set up a statement like this:
31533 .code
31534 deny  hosts = net-lsearch;/some/file
31535       message = $host_data
31536 .endd
31537 which gives a custom error message for each denied host.
31538
31539 .vitem &*local_parts&~=&~*&<&'local&~part&~list'&>
31540 .cindex "&%local_parts%& ACL condition"
31541 .cindex "local part" "ACL checking"
31542 .cindex "&ACL;" "testing a local part"
31543 .vindex "&$local_part_data$&"
31544 This condition is relevant only after a RCPT command. It checks that the local
31545 part of the recipient address is in the list. If percent-hack processing is
31546 enabled, it is done before this test. If the check succeeds with a lookup, the
31547 result of the lookup is placed in &$local_part_data$&, which remains set until
31548 the next &%local_parts%& test.
31549
31550 .vitem &*malware&~=&~*&<&'option'&>
31551 .cindex "&%malware%& ACL condition"
31552 .cindex "&ACL;" "virus scanning"
31553 .cindex "&ACL;" "scanning for viruses"
31554 This condition is available only when Exim is compiled with the
31555 content-scanning extension
31556 and only after a DATA command.
31557 It causes the incoming message to be scanned for
31558 viruses. For details, see chapter &<<CHAPexiscan>>&.
31559
31560 .vitem &*mime_regex&~=&~*&<&'list&~of&~regular&~expressions'&>
31561 .cindex "&%mime_regex%& ACL condition"
31562 .cindex "&ACL;" "testing by regex matching"
31563 This condition is available only when Exim is compiled with the
31564 content-scanning extension, and it is allowed only in the ACL defined by
31565 &%acl_smtp_mime%&. It causes the current MIME part to be scanned for a match
31566 with any of the regular expressions. For details, see chapter
31567 &<<CHAPexiscan>>&.
31568
31569 .vitem &*ratelimit&~=&~*&<&'parameters'&>
31570 .cindex "rate limiting"
31571 This condition can be used to limit the rate at which a user or host submits
31572 messages. Details are given in section &<<SECTratelimiting>>&.
31573
31574 .vitem &*recipients&~=&~*&<&'address&~list'&>
31575 .cindex "&%recipients%& ACL condition"
31576 .cindex "recipient" "ACL checking"
31577 .cindex "&ACL;" "testing a recipient"
31578 This condition is relevant only after a RCPT command. It checks the entire
31579 recipient address against a list of recipients.
31580
31581 .vitem &*regex&~=&~*&<&'list&~of&~regular&~expressions'&>
31582 .cindex "&%regex%& ACL condition"
31583 .cindex "&ACL;" "testing by regex matching"
31584 This condition is available only when Exim is compiled with the
31585 content-scanning extension, and is available only in the DATA, MIME, and
31586 non-SMTP ACLs. It causes the incoming message to be scanned for a match with
31587 any of the regular expressions. For details, see chapter &<<CHAPexiscan>>&.
31588
31589 .vitem &*sender_domains&~=&~*&<&'domain&~list'&>
31590 .cindex "&%sender_domains%& ACL condition"
31591 .cindex "sender" "ACL checking"
31592 .cindex "&ACL;" "testing a sender domain"
31593 .vindex "&$domain$&"
31594 .vindex "&$sender_address_domain$&"
31595 This condition tests the domain of the sender of the message against the given
31596 domain list. &*Note*&: The domain of the sender address is in
31597 &$sender_address_domain$&. It is &'not'& put in &$domain$& during the testing
31598 of this condition. This is an exception to the general rule for testing domain
31599 lists. It is done this way so that, if this condition is used in an ACL for a
31600 RCPT command, the recipient's domain (which is in &$domain$&) can be used to
31601 influence the sender checking.
31602
31603 &*Warning*&: It is a bad idea to use this condition on its own as a control on
31604 relaying, because sender addresses are easily, and commonly, forged.
31605
31606 .vitem &*senders&~=&~*&<&'address&~list'&>
31607 .cindex "&%senders%& ACL condition"
31608 .cindex "sender" "ACL checking"
31609 .cindex "&ACL;" "testing a sender"
31610 This condition tests the sender of the message against the given list. To test
31611 for a bounce message, which has an empty sender, set
31612 .code
31613 senders = :
31614 .endd
31615 &*Warning*&: It is a bad idea to use this condition on its own as a control on
31616 relaying, because sender addresses are easily, and commonly, forged.
31617
31618 .vitem &*spam&~=&~*&<&'username'&>
31619 .cindex "&%spam%& ACL condition"
31620 .cindex "&ACL;" "scanning for spam"
31621 This condition is available only when Exim is compiled with the
31622 content-scanning extension. It causes the incoming message to be scanned by
31623 SpamAssassin. For details, see chapter &<<CHAPexiscan>>&.
31624
31625 .vitem &*verify&~=&~certificate*&
31626 .cindex "&%verify%& ACL condition"
31627 .cindex "TLS" "client certificate verification"
31628 .cindex "certificate" "verification of client"
31629 .cindex "&ACL;" "certificate verification"
31630 .cindex "&ACL;" "testing a TLS certificate"
31631 This condition is true in an SMTP session if the session is encrypted, and a
31632 certificate was received from the client, and the certificate was verified. The
31633 server requests a certificate only if the client matches &%tls_verify_hosts%&
31634 or &%tls_try_verify_hosts%& (see chapter &<<CHAPTLS>>&).
31635
31636 .vitem &*verify&~=&~csa*&
31637 .cindex "CSA verification"
31638 This condition checks whether the sending host (the client) is authorized to
31639 send email. Details of how this works are given in section
31640 &<<SECTverifyCSA>>&.
31641
31642 .vitem &*verify&~=&~header_names_ascii*&
31643 .cindex "&%verify%& ACL condition"
31644 .cindex "&ACL;" "verifying header names only ASCII"
31645 .cindex "header lines" "verifying header names only ASCII"
31646 .cindex "verifying" "header names only ASCII"
31647 This condition is relevant only in an ACL that is run after a message has been
31648 received, that is, in an ACL specified by &%acl_smtp_data%& or
31649 &%acl_not_smtp%&.  It checks all header names (not the content) to make sure
31650 there are no non-ASCII characters, also excluding control characters.  The
31651 allowable characters are decimal ASCII values 33 through 126.
31652
31653 Exim itself will handle headers with non-ASCII characters, but it can cause
31654 problems for downstream applications, so this option will allow their
31655 detection and rejection in the DATA ACL's.
31656
31657 .vitem &*verify&~=&~header_sender/*&<&'options'&>
31658 .cindex "&%verify%& ACL condition"
31659 .cindex "&ACL;" "verifying sender in the header"
31660 .cindex "header lines" "verifying the sender in"
31661 .cindex "sender" "verifying in header"
31662 .cindex "verifying" "sender in header"
31663 This condition is relevant only in an ACL that is run after a message has been
31664 received, that is, in an ACL specified by &%acl_smtp_data%& or
31665 &%acl_not_smtp%&. It checks that there is a verifiable address in at least one
31666 of the &'Sender:'&, &'Reply-To:'&, or &'From:'& header lines. Such an address
31667 is loosely thought of as a &"sender"& address (hence the name of the test).
31668 However, an address that appears in one of these headers need not be an address
31669 that accepts bounce messages; only sender addresses in envelopes are required
31670 to accept bounces. Therefore, if you use the callout option on this check, you
31671 might want to arrange for a non-empty address in the MAIL command.
31672
31673 Details of address verification and the options are given later, starting at
31674 section &<<SECTaddressverification>>& (callouts are described in section
31675 &<<SECTcallver>>&). You can combine this condition with the &%senders%&
31676 condition to restrict it to bounce messages only:
31677 .code
31678 deny    senders = :
31679        !verify  = header_sender
31680         message = A valid sender header is required for bounces
31681 .endd
31682
31683 .vitem &*verify&~=&~header_syntax*&
31684 .cindex "&%verify%& ACL condition"
31685 .cindex "&ACL;" "verifying header syntax"
31686 .cindex "header lines" "verifying syntax"
31687 .cindex "verifying" "header syntax"
31688 This condition is relevant only in an ACL that is run after a message has been
31689 received, that is, in an ACL specified by &%acl_smtp_data%& or
31690 &%acl_not_smtp%&. It checks the syntax of all header lines that can contain
31691 lists of addresses (&'Sender:'&, &'From:'&, &'Reply-To:'&, &'To:'&, &'Cc:'&,
31692 and &'Bcc:'&), returning true if there are no problems.
31693 Unqualified addresses (local parts without domains) are
31694 permitted only in locally generated messages and from hosts that match
31695 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
31696 appropriate.
31697
31698 Note that this condition is a syntax check only. However, a common spamming
31699 ploy used to be to send syntactically invalid headers such as
31700 .code
31701 To: @
31702 .endd
31703 and this condition can be used to reject such messages, though they are not as
31704 common as they used to be.
31705
31706 .vitem &*verify&~=&~helo*&
31707 .cindex "&%verify%& ACL condition"
31708 .cindex "&ACL;" "verifying HELO/EHLO"
31709 .cindex "HELO" "verifying"
31710 .cindex "EHLO" "verifying"
31711 .cindex "verifying" "EHLO"
31712 .cindex "verifying" "HELO"
31713 This condition is true if a HELO or EHLO command has been received from the
31714 client host, and its contents have been verified. If there has been no previous
31715 attempt to verify the HELO/EHLO contents, it is carried out when this
31716 condition is encountered. See the description of the &%helo_verify_hosts%& and
31717 &%helo_try_verify_hosts%& options for details of how to request verification
31718 independently of this condition, and for detail of the verification.
31719
31720 For SMTP input that does not come over TCP/IP (the &%-bs%& command line
31721 option), this condition is always true.
31722
31723
31724 .vitem &*verify&~=&~not_blind/*&<&'options'&>
31725 .cindex "verifying" "not blind"
31726 .cindex "bcc recipients, verifying none"
31727 This condition checks that there are no blind (bcc) recipients in the message.
31728 Every envelope recipient must appear either in a &'To:'& header line or in a
31729 &'Cc:'& header line for this condition to be true. Local parts are checked
31730 case-sensitively; domains are checked case-insensitively. If &'Resent-To:'& or
31731 &'Resent-Cc:'& header lines exist, they are also checked. This condition can be
31732 used only in a DATA or non-SMTP ACL.
31733
31734 There is one possible option, &`case_insensitive`&.  If this is present then
31735 local parts are checked case-insensitively.
31736
31737 There are, of course, many legitimate messages that make use of blind (bcc)
31738 recipients. This check should not be used on its own for blocking messages.
31739
31740
31741 .vitem &*verify&~=&~recipient/*&<&'options'&>
31742 .cindex "&%verify%& ACL condition"
31743 .cindex "&ACL;" "verifying recipient"
31744 .cindex "recipient" "verifying"
31745 .cindex "verifying" "recipient"
31746 .vindex "&$address_data$&"
31747 This condition is relevant only after a RCPT command. It verifies the current
31748 recipient. Details of address verification are given later, starting at section
31749 &<<SECTaddressverification>>&. After a recipient has been verified, the value
31750 of &$address_data$& is the last value that was set while routing the address.
31751 This applies even if the verification fails. When an address that is being
31752 verified is redirected to a single address, verification continues with the new
31753 address, and in that case, the subsequent value of &$address_data$& is the
31754 value for the child address.
31755
31756 .vitem &*verify&~=&~reverse_host_lookup/*&<&'options'&>
31757 .cindex "&%verify%& ACL condition"
31758 .cindex "&ACL;" "verifying host reverse lookup"
31759 .cindex "host" "verifying reverse lookup"
31760 This condition ensures that a verified host name has been looked up from the IP
31761 address of the client host. (This may have happened already if the host name
31762 was needed for checking a host list, or if the host matched &%host_lookup%&.)
31763 Verification ensures that the host name obtained from a reverse DNS lookup, or
31764 one of its aliases, does, when it is itself looked up in the DNS, yield the
31765 original IP address.
31766
31767 There is one possible option, &`defer_ok`&.  If this is present and a
31768 DNS operation returns a temporary error, the verify condition succeeds.
31769
31770 If this condition is used for a locally generated message (that is, when there
31771 is no client host involved), it always succeeds.
31772
31773 .vitem &*verify&~=&~sender/*&<&'options'&>
31774 .cindex "&%verify%& ACL condition"
31775 .cindex "&ACL;" "verifying sender"
31776 .cindex "sender" "verifying"
31777 .cindex "verifying" "sender"
31778 This condition is relevant only after a MAIL or RCPT command, or after a
31779 message has been received (the &%acl_smtp_data%& or &%acl_not_smtp%& ACLs). If
31780 the message's sender is empty (that is, this is a bounce message), the
31781 condition is true. Otherwise, the sender address is verified.
31782
31783 .vindex "&$address_data$&"
31784 .vindex "&$sender_address_data$&"
31785 If there is data in the &$address_data$& variable at the end of routing, its
31786 value is placed in &$sender_address_data$& at the end of verification. This
31787 value can be used in subsequent conditions and modifiers in the same ACL
31788 statement. It does not persist after the end of the current statement. If you
31789 want to preserve the value for longer, you can save it in an ACL variable.
31790
31791 Details of verification are given later, starting at section
31792 &<<SECTaddressverification>>&. Exim caches the result of sender verification,
31793 to avoid doing it more than once per message.
31794
31795 .vitem &*verify&~=&~sender=*&<&'address'&>&*/*&<&'options'&>
31796 .cindex "&%verify%& ACL condition"
31797 This is a variation of the previous option, in which a modified address is
31798 verified as a sender.
31799
31800 Note that '/' is legal in local-parts; if the address may have such
31801 (eg. is generated from the received message)
31802 they must be protected from the options parsing by doubling:
31803 .code
31804 verify = sender=${sg{${address:$h_sender:}}{/}{//}}
31805 .endd
31806 .endlist
31807
31808
31809
31810 .section "Using DNS lists" "SECTmorednslists"
31811 .cindex "DNS list" "in ACL"
31812 .cindex "black list (DNS)"
31813 .cindex "&ACL;" "testing a DNS list"
31814 In its simplest form, the &%dnslists%& condition tests whether the calling host
31815 is on at least one of a number of DNS lists by looking up the inverted IP
31816 address in one or more DNS domains. (Note that DNS list domains are not mail
31817 domains, so the &`+`& syntax for named lists doesn't work - it is used for
31818 special options instead.) For example, if the calling host's IP
31819 address is 192.168.62.43, and the ACL statement is
31820 .code
31821 deny dnslists = blackholes.mail-abuse.org : \
31822                 dialups.mail-abuse.org
31823 .endd
31824 the following records are looked up:
31825 .code
31826 43.62.168.192.blackholes.mail-abuse.org
31827 43.62.168.192.dialups.mail-abuse.org
31828 .endd
31829 As soon as Exim finds an existing DNS record, processing of the list stops.
31830 Thus, multiple entries on the list provide an &"or"& conjunction. If you want
31831 to test that a host is on more than one list (an &"and"& conjunction), you can
31832 use two separate conditions:
31833 .code
31834 deny dnslists = blackholes.mail-abuse.org
31835      dnslists = dialups.mail-abuse.org
31836 .endd
31837 If a DNS lookup times out or otherwise fails to give a decisive answer, Exim
31838 behaves as if the host does not match the list item, that is, as if the DNS
31839 record does not exist. If there are further items in the DNS list, they are
31840 processed.
31841
31842 This is usually the required action when &%dnslists%& is used with &%deny%&
31843 (which is the most common usage), because it prevents a DNS failure from
31844 blocking mail. However, you can change this behaviour by putting one of the
31845 following special items in the list:
31846 .display
31847 &`+include_unknown `&   behave as if the item is on the list
31848 &`+exclude_unknown `&   behave as if the item is not on the list (default)
31849 &`+defer_unknown   `&   give a temporary error
31850 .endd
31851 .cindex "&`+include_unknown`&"
31852 .cindex "&`+exclude_unknown`&"
31853 .cindex "&`+defer_unknown`&"
31854 Each of these applies to any subsequent items on the list. For example:
31855 .code
31856 deny dnslists = +defer_unknown : foo.bar.example
31857 .endd
31858 Testing the list of domains stops as soon as a match is found. If you want to
31859 warn for one list and block for another, you can use two different statements:
31860 .code
31861 deny  dnslists = blackholes.mail-abuse.org
31862 warn  dnslists = dialups.mail-abuse.org
31863       message  = X-Warn: sending host is on dialups list
31864 .endd
31865 .cindex caching "of dns lookup"
31866 .cindex DNS TTL
31867 DNS list lookups are cached by Exim for the duration of the SMTP session
31868 (but limited by the DNS return TTL value),
31869 so a lookup based on the IP address is done at most once for any incoming
31870 connection (assuming long-enough TTL).
31871 Exim does not share information between multiple incoming
31872 connections (but your local name server cache should be active).
31873
31874 There are a number of DNS lists to choose from, some commercial, some free,
31875 or free for small deployments.  An overview can be found at
31876 &url(https://en.wikipedia.org/wiki/Comparison_of_DNS_blacklists).
31877
31878
31879
31880 .section "Specifying the IP address for a DNS list lookup" "SECID201"
31881 .cindex "DNS list" "keyed by explicit IP address"
31882 By default, the IP address that is used in a DNS list lookup is the IP address
31883 of the calling host. However, you can specify another IP address by listing it
31884 after the domain name, introduced by a slash. For example:
31885 .code
31886 deny dnslists = black.list.tld/192.168.1.2
31887 .endd
31888 This feature is not very helpful with explicit IP addresses; it is intended for
31889 use with IP addresses that are looked up, for example, the IP addresses of the
31890 MX hosts or nameservers of an email sender address. For an example, see section
31891 &<<SECTmulkeyfor>>& below.
31892
31893
31894
31895
31896 .section "DNS lists keyed on domain names" "SECID202"
31897 .cindex "DNS list" "keyed by domain name"
31898 There are some lists that are keyed on domain names rather than inverted IP
31899 addresses (see, e.g., the &'domain based zones'& link at
31900 &url(http://www.rfc-ignorant.org/)). No reversing of components is used
31901 with these lists. You can change the name that is looked up in a DNS list by
31902 listing it after the domain name, introduced by a slash. For example,
31903 .code
31904 deny  dnslists = dsn.rfc-ignorant.org/$sender_address_domain
31905       message  = Sender's domain is listed at $dnslist_domain
31906 .endd
31907 This particular example is useful only in ACLs that are obeyed after the
31908 RCPT or DATA commands, when a sender address is available. If (for
31909 example) the message's sender is &'user@tld.example'& the name that is looked
31910 up by this example is
31911 .code
31912 tld.example.dsn.rfc-ignorant.org
31913 .endd
31914 A single &%dnslists%& condition can contain entries for both names and IP
31915 addresses. For example:
31916 .code
31917 deny dnslists = sbl.spamhaus.org : \
31918                 dsn.rfc-ignorant.org/$sender_address_domain
31919 .endd
31920 The first item checks the sending host's IP address; the second checks a domain
31921 name. The whole condition is true if either of the DNS lookups succeeds.
31922
31923
31924
31925
31926 .section "Multiple explicit keys for a DNS list" "SECTmulkeyfor"
31927 .cindex "DNS list" "multiple keys for"
31928 The syntax described above for looking up explicitly-defined values (either
31929 names or IP addresses) in a DNS blacklist is a simplification. After the domain
31930 name for the DNS list, what follows the slash can in fact be a list of items.
31931 As with all lists in Exim, the default separator is a colon. However, because
31932 this is a sublist within the list of DNS blacklist domains, it is necessary
31933 either to double the separators like this:
31934 .code
31935 dnslists = black.list.tld/name.1::name.2
31936 .endd
31937 or to change the separator character, like this:
31938 .code
31939 dnslists = black.list.tld/<;name.1;name.2
31940 .endd
31941 If an item in the list is an IP address, it is inverted before the DNS
31942 blacklist domain is appended. If it is not an IP address, no inversion
31943 occurs. Consider this condition:
31944 .code
31945 dnslists = black.list.tld/<;192.168.1.2;a.domain
31946 .endd
31947 The DNS lookups that occur are:
31948 .code
31949 2.1.168.192.black.list.tld
31950 a.domain.black.list.tld
31951 .endd
31952 Once a DNS record has been found (that matches a specific IP return
31953 address, if specified &-- see section &<<SECTaddmatcon>>&), no further lookups
31954 are done. If there is a temporary DNS error, the rest of the sublist of domains
31955 or IP addresses is tried. A temporary error for the whole dnslists item occurs
31956 only if no other DNS lookup in this sublist succeeds. In other words, a
31957 successful lookup for any of the items in the sublist overrides a temporary
31958 error for a previous item.
31959
31960 The ability to supply a list of items after the slash is in some sense just a
31961 syntactic convenience. These two examples have the same effect:
31962 .code
31963 dnslists = black.list.tld/a.domain : black.list.tld/b.domain
31964 dnslists = black.list.tld/a.domain::b.domain
31965 .endd
31966 However, when the data for the list is obtained from a lookup, the second form
31967 is usually much more convenient. Consider this example:
31968 .code
31969 deny dnslists = sbl.spamhaus.org/<|${lookup dnsdb {>|a=<|\
31970                                    ${lookup dnsdb {>|mxh=\
31971                                    $sender_address_domain} }} }
31972      message  = The mail servers for the domain \
31973                 $sender_address_domain \
31974                 are listed at $dnslist_domain ($dnslist_value); \
31975                 see $dnslist_text.
31976 .endd
31977 Note the use of &`>|`& in the dnsdb lookup to specify the separator for
31978 multiple DNS records. The inner dnsdb lookup produces a list of MX hosts
31979 and the outer dnsdb lookup finds the IP addresses for these hosts. The result
31980 of expanding the condition might be something like this:
31981 .code
31982 dnslists = sbl.spamhaus.org/<|192.168.2.3|192.168.5.6|...
31983 .endd
31984 Thus, this example checks whether or not the IP addresses of the sender
31985 domain's mail servers are on the Spamhaus black list.
31986
31987 The key that was used for a successful DNS list lookup is put into the variable
31988 &$dnslist_matched$& (see section &<<SECID204>>&).
31989
31990
31991
31992
31993 .section "Data returned by DNS lists" "SECID203"
31994 .cindex "DNS list" "data returned from"
31995 DNS lists are constructed using address records in the DNS. The original RBL
31996 just used the address 127.0.0.1 on the right hand side of each record, but the
31997 RBL+ list and some other lists use a number of values with different meanings.
31998 The values used on the RBL+ list are:
31999 .display
32000 127.1.0.1  RBL
32001 127.1.0.2  DUL
32002 127.1.0.3  DUL and RBL
32003 127.1.0.4  RSS
32004 127.1.0.5  RSS and RBL
32005 127.1.0.6  RSS and DUL
32006 127.1.0.7  RSS and DUL and RBL
32007 .endd
32008 Section &<<SECTaddmatcon>>& below describes how you can distinguish between
32009 different values. Some DNS lists may return more than one address record;
32010 see section &<<SECThanmuldnsrec>>& for details of how they are checked.
32011
32012
32013 .section "Variables set from DNS lists" "SECID204"
32014 .cindex "expansion" "variables, set from DNS list"
32015 .cindex "DNS list" "variables set from"
32016 .vindex "&$dnslist_domain$&"
32017 .vindex "&$dnslist_matched$&"
32018 .vindex "&$dnslist_text$&"
32019 .vindex "&$dnslist_value$&"
32020 When an entry is found in a DNS list, the variable &$dnslist_domain$& contains
32021 the name of the overall domain that matched (for example,
32022 &`spamhaus.example`&), &$dnslist_matched$& contains the key within that domain
32023 (for example, &`192.168.5.3`&), and &$dnslist_value$& contains the data from
32024 the DNS record. When the key is an IP address, it is not reversed in
32025 &$dnslist_matched$& (though it is, of course, in the actual lookup). In simple
32026 cases, for example:
32027 .code
32028 deny dnslists = spamhaus.example
32029 .endd
32030 the key is also available in another variable (in this case,
32031 &$sender_host_address$&). In more complicated cases, however, this is not true.
32032 For example, using a data lookup (as described in section &<<SECTmulkeyfor>>&)
32033 might generate a dnslists lookup like this:
32034 .code
32035 deny dnslists = spamhaus.example/<|192.168.1.2|192.168.6.7|...
32036 .endd
32037 If this condition succeeds, the value in &$dnslist_matched$& might be
32038 &`192.168.6.7`& (for example).
32039
32040 If more than one address record is returned by the DNS lookup, all the IP
32041 addresses are included in &$dnslist_value$&, separated by commas and spaces.
32042 The variable &$dnslist_text$& contains the contents of any associated TXT
32043 record. For lists such as RBL+ the TXT record for a merged entry is often not
32044 very meaningful. See section &<<SECTmordetinf>>& for a way of obtaining more
32045 information.
32046
32047 You can use the DNS list variables in &%message%& or &%log_message%& modifiers
32048 &-- even if these appear before the condition in the ACL, they are not
32049 expanded until after it has failed. For example:
32050 .code
32051 deny    hosts = !+local_networks
32052         message = $sender_host_address is listed \
32053                   at $dnslist_domain
32054         dnslists = rbl-plus.mail-abuse.example
32055 .endd
32056
32057
32058
32059 .section "Additional matching conditions for DNS lists" "SECTaddmatcon"
32060 .cindex "DNS list" "matching specific returned data"
32061 You can add an equals sign and an IP address after a &%dnslists%& domain name
32062 in order to restrict its action to DNS records with a matching right hand side.
32063 For example,
32064 .code
32065 deny dnslists = rblplus.mail-abuse.org=127.0.0.2
32066 .endd
32067 rejects only those hosts that yield 127.0.0.2. Without this additional data,
32068 any address record is considered to be a match. For the moment, we assume
32069 that the DNS lookup returns just one record. Section &<<SECThanmuldnsrec>>&
32070 describes how multiple records are handled.
32071
32072 More than one IP address may be given for checking, using a comma as a
32073 separator. These are alternatives &-- if any one of them matches, the
32074 &%dnslists%& condition is true. For example:
32075 .code
32076 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
32077 .endd
32078 If you want to specify a constraining address list and also specify names or IP
32079 addresses to be looked up, the constraining address list must be specified
32080 first. For example:
32081 .code
32082 deny dnslists = dsn.rfc-ignorant.org\
32083                 =127.0.0.2/$sender_address_domain
32084 .endd
32085
32086 If the character &`&&`& is used instead of &`=`&, the comparison for each
32087 listed IP address is done by a bitwise &"and"& instead of by an equality test.
32088 In other words, the listed addresses are used as bit masks. The comparison is
32089 true if all the bits in the mask are present in the address that is being
32090 tested. For example:
32091 .code
32092 dnslists = a.b.c&0.0.0.3
32093 .endd
32094 matches if the address is &'x.x.x.'&3, &'x.x.x.'&7, &'x.x.x.'&11, etc. If you
32095 want to test whether one bit or another bit is present (as opposed to both
32096 being present), you must use multiple values. For example:
32097 .code
32098 dnslists = a.b.c&0.0.0.1,0.0.0.2
32099 .endd
32100 matches if the final component of the address is an odd number or two times
32101 an odd number.
32102
32103
32104
32105 .section "Negated DNS matching conditions" "SECID205"
32106 You can supply a negative list of IP addresses as part of a &%dnslists%&
32107 condition. Whereas
32108 .code
32109 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
32110 .endd
32111 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
32112 IP address yielded by the list is either 127.0.0.2 or 127.0.0.3"&,
32113 .code
32114 deny  dnslists = a.b.c!=127.0.0.2,127.0.0.3
32115 .endd
32116 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
32117 IP address yielded by the list is not 127.0.0.2 and not 127.0.0.3"&. In other
32118 words, the result of the test is inverted if an exclamation mark appears before
32119 the &`=`& (or the &`&&`&) sign.
32120
32121 &*Note*&: This kind of negation is not the same as negation in a domain,
32122 host, or address list (which is why the syntax is different).
32123
32124 If you are using just one list, the negation syntax does not gain you much. The
32125 previous example is precisely equivalent to
32126 .code
32127 deny  dnslists = a.b.c
32128      !dnslists = a.b.c=127.0.0.2,127.0.0.3
32129 .endd
32130 However, if you are using multiple lists, the negation syntax is clearer.
32131 Consider this example:
32132 .code
32133 deny  dnslists = sbl.spamhaus.org : \
32134                  list.dsbl.org : \
32135                  dnsbl.njabl.org!=127.0.0.3 : \
32136                  relays.ordb.org
32137 .endd
32138 Using only positive lists, this would have to be:
32139 .code
32140 deny  dnslists = sbl.spamhaus.org : \
32141                  list.dsbl.org
32142 deny  dnslists = dnsbl.njabl.org
32143      !dnslists = dnsbl.njabl.org=127.0.0.3
32144 deny  dnslists = relays.ordb.org
32145 .endd
32146 which is less clear, and harder to maintain.
32147
32148
32149
32150
32151 .section "Handling multiple DNS records from a DNS list" "SECThanmuldnsrec"
32152 A DNS lookup for a &%dnslists%& condition may return more than one DNS record,
32153 thereby providing more than one IP address. When an item in a &%dnslists%& list
32154 is followed by &`=`& or &`&&`& and a list of IP addresses, in order to restrict
32155 the match to specific results from the DNS lookup, there are two ways in which
32156 the checking can be handled. For example, consider the condition:
32157 .code
32158 dnslists = a.b.c=127.0.0.1
32159 .endd
32160 What happens if the DNS lookup for the incoming IP address yields both
32161 127.0.0.1 and 127.0.0.2 by means of two separate DNS records? Is the
32162 condition true because at least one given value was found, or is it false
32163 because at least one of the found values was not listed? And how does this
32164 affect negated conditions? Both possibilities are provided for with the help of
32165 additional separators &`==`& and &`=&&`&.
32166
32167 .ilist
32168 If &`=`& or &`&&`& is used, the condition is true if any one of the looked up
32169 IP addresses matches one of the listed addresses. For the example above, the
32170 condition is true because 127.0.0.1 matches.
32171 .next
32172 If &`==`& or &`=&&`& is used, the condition is true only if every one of the
32173 looked up IP addresses matches one of the listed addresses. If the condition is
32174 changed to:
32175 .code
32176 dnslists = a.b.c==127.0.0.1
32177 .endd
32178 and the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
32179 false because 127.0.0.2 is not listed. You would need to have:
32180 .code
32181 dnslists = a.b.c==127.0.0.1,127.0.0.2
32182 .endd
32183 for the condition to be true.
32184 .endlist
32185
32186 When &`!`& is used to negate IP address matching, it inverts the result, giving
32187 the precise opposite of the behaviour above. Thus:
32188 .ilist
32189 If &`!=`& or &`!&&`& is used, the condition is true if none of the looked up IP
32190 addresses matches one of the listed addresses. Consider:
32191 .code
32192 dnslists = a.b.c!&0.0.0.1
32193 .endd
32194 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
32195 false because 127.0.0.1 matches.
32196 .next
32197 If &`!==`& or &`!=&&`& is used, the condition is true if there is at least one
32198 looked up IP address that does not match. Consider:
32199 .code
32200 dnslists = a.b.c!=&0.0.0.1
32201 .endd
32202 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
32203 true, because 127.0.0.2 does not match. You would need to have:
32204 .code
32205 dnslists = a.b.c!=&0.0.0.1,0.0.0.2
32206 .endd
32207 for the condition to be false.
32208 .endlist
32209 When the DNS lookup yields only a single IP address, there is no difference
32210 between &`=`& and &`==`& and between &`&&`& and &`=&&`&.
32211
32212
32213
32214
32215 .section "Detailed information from merged DNS lists" "SECTmordetinf"
32216 .cindex "DNS list" "information from merged"
32217 When the facility for restricting the matching IP values in a DNS list is used,
32218 the text from the TXT record that is set in &$dnslist_text$& may not reflect
32219 the true reason for rejection. This happens when lists are merged and the IP
32220 address in the A record is used to distinguish them; unfortunately there is
32221 only one TXT record. One way round this is not to use merged lists, but that
32222 can be inefficient because it requires multiple DNS lookups where one would do
32223 in the vast majority of cases when the host of interest is not on any of the
32224 lists.
32225
32226 A less inefficient way of solving this problem is available. If
32227 two domain names, comma-separated, are given, the second is used first to
32228 do an initial check, making use of any IP value restrictions that are set.
32229 If there is a match, the first domain is used, without any IP value
32230 restrictions, to get the TXT record. As a byproduct of this, there is also
32231 a check that the IP being tested is indeed on the first list. The first
32232 domain is the one that is put in &$dnslist_domain$&. For example:
32233 .code
32234 deny   dnslists = \
32235          sbl.spamhaus.org,sbl-xbl.spamhaus.org=127.0.0.2 : \
32236          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
32237        message  = \
32238          rejected because $sender_host_address is blacklisted \
32239          at $dnslist_domain\n$dnslist_text
32240 .endd
32241 For the first blacklist item, this starts by doing a lookup in
32242 &'sbl-xbl.spamhaus.org'& and testing for a 127.0.0.2 return. If there is a
32243 match, it then looks in &'sbl.spamhaus.org'&, without checking the return
32244 value, and as long as something is found, it looks for the corresponding TXT
32245 record. If there is no match in &'sbl-xbl.spamhaus.org'&, nothing more is done.
32246 The second blacklist item is processed similarly.
32247
32248 If you are interested in more than one merged list, the same list must be
32249 given several times, but because the results of the DNS lookups are cached,
32250 the DNS calls themselves are not repeated. For example:
32251 .code
32252 deny dnslists = \
32253          http.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.2 : \
32254          socks.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.3 : \
32255          misc.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.4 : \
32256          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
32257 .endd
32258 In this case there is one lookup in &'dnsbl.sorbs.net'&, and if none of the IP
32259 values matches (or if no record is found), this is the only lookup that is
32260 done. Only if there is a match is one of the more specific lists consulted.
32261
32262
32263
32264 .section "DNS lists and IPv6" "SECTmorednslistslast"
32265 .cindex "IPv6" "DNS black lists"
32266 .cindex "DNS list" "IPv6 usage"
32267 If Exim is asked to do a dnslist lookup for an IPv6 address, it inverts it
32268 nibble by nibble. For example, if the calling host's IP address is
32269 3ffe:ffff:836f:0a00:000a:0800:200a:c031, Exim might look up
32270 .code
32271 1.3.0.c.a.0.0.2.0.0.8.0.a.0.0.0.0.0.a.0.f.6.3.8.
32272   f.f.f.f.e.f.f.3.blackholes.mail-abuse.org
32273 .endd
32274 (split over two lines here to fit on the page). Unfortunately, some of the DNS
32275 lists contain wildcard records, intended for IPv4, that interact badly with
32276 IPv6. For example, the DNS entry
32277 .code
32278 *.3.some.list.example.    A    127.0.0.1
32279 .endd
32280 is probably intended to put the entire 3.0.0.0/8 IPv4 network on the list.
32281 Unfortunately, it also matches the entire 3::/4 IPv6 network.
32282
32283 You can exclude IPv6 addresses from DNS lookups by making use of a suitable
32284 &%condition%& condition, as in this example:
32285 .code
32286 deny   condition = ${if isip4{$sender_host_address}}
32287        dnslists  = some.list.example
32288 .endd
32289
32290 If an explicit key is being used for a DNS lookup and it may be an IPv6
32291 address you should specify alternate list separators for both the outer
32292 (DNS list name) list and inner (lookup keys) list:
32293 .code
32294        dnslists = <; dnsbl.example.com/<|$acl_m_addrslist
32295 .endd
32296
32297 .section "Rate limiting incoming messages" "SECTratelimiting"
32298 .cindex "rate limiting" "client sending"
32299 .cindex "limiting client sending rates"
32300 .oindex "&%smtp_ratelimit_*%&"
32301 The &%ratelimit%& ACL condition can be used to measure and control the rate at
32302 which clients can send email. This is more powerful than the
32303 &%smtp_ratelimit_*%& options, because those options control the rate of
32304 commands in a single SMTP session only, whereas the &%ratelimit%& condition
32305 works across all connections (concurrent and sequential) from the same client
32306 host. The syntax of the &%ratelimit%& condition is:
32307 .display
32308 &`ratelimit =`& <&'m'&> &`/`& <&'p'&> &`/`& <&'options'&> &`/`& <&'key'&>
32309 .endd
32310 If the average client sending rate is less than &'m'& messages per time
32311 period &'p'& then the condition is false; otherwise it is true.
32312
32313 As a side-effect, the &%ratelimit%& condition sets the expansion variable
32314 &$sender_rate$& to the client's computed rate, &$sender_rate_limit$& to the
32315 configured value of &'m'&, and &$sender_rate_period$& to the configured value
32316 of &'p'&.
32317
32318 The parameter &'p'& is the smoothing time constant, in the form of an Exim
32319 time interval, for example, &`8h`& for eight hours. A larger time constant
32320 means that it takes Exim longer to forget a client's past behaviour. The
32321 parameter &'m'& is the maximum number of messages that a client is permitted to
32322 send in each time interval. It also specifies the number of messages permitted
32323 in a fast burst. By increasing both &'m'& and &'p'& but keeping &'m/p'&
32324 constant, you can allow a client to send more messages in a burst without
32325 changing its long-term sending rate limit. Conversely, if &'m'& and &'p'& are
32326 both small, messages must be sent at an even rate.
32327
32328 There is a script in &_util/ratelimit.pl_& which extracts sending rates from
32329 log files, to assist with choosing appropriate settings for &'m'& and &'p'&
32330 when deploying the &%ratelimit%& ACL condition. The script prints usage
32331 instructions when it is run with no arguments.
32332
32333 The key is used to look up the data for calculating the client's average
32334 sending rate. This data is stored in Exim's spool directory, alongside the
32335 retry and other hints databases. The default key is &$sender_host_address$&,
32336 which means Exim computes the sending rate of each client host IP address.
32337 By changing the key you can change how Exim identifies clients for the purpose
32338 of ratelimiting. For example, to limit the sending rate of each authenticated
32339 user, independent of the computer they are sending from, set the key to
32340 &$authenticated_id$&. You must ensure that the lookup key is meaningful; for
32341 example, &$authenticated_id$& is only meaningful if the client has
32342 authenticated (which you can check with the &%authenticated%& ACL condition).
32343
32344 The lookup key does not have to identify clients: If you want to limit the
32345 rate at which a recipient receives messages, you can use the key
32346 &`$local_part@$domain`& with the &%per_rcpt%& option (see below) in a RCPT
32347 ACL.
32348
32349 Each &%ratelimit%& condition can have up to four options. A &%per_*%& option
32350 specifies what Exim measures the rate of, for example, messages or recipients
32351 or bytes. You can adjust the measurement using the &%unique=%& and/or
32352 &%count=%& options. You can also control when Exim updates the recorded rate
32353 using a &%strict%&, &%leaky%&, or &%readonly%& option. The options are
32354 separated by a slash, like the other parameters. They may appear in any order.
32355
32356 Internally, Exim appends the smoothing constant &'p'& onto the lookup key with
32357 any options that alter the meaning of the stored data. The limit &'m'& is not
32358 stored, so you can alter the configured maximum rate and Exim will still
32359 remember clients' past behaviour. If you change the &%per_*%& mode or add or
32360 remove the &%unique=%& option, the lookup key changes so Exim will forget past
32361 behaviour. The lookup key is not affected by changes to the update mode and
32362 the &%count=%& option.
32363
32364
32365 .section "Ratelimit options for what is being measured" "ratoptmea"
32366 .cindex "rate limiting" "per_* options"
32367 The &%per_conn%& option limits the client's connection rate. It is not
32368 normally used in the &%acl_not_smtp%&, &%acl_not_smtp_mime%&, or
32369 &%acl_not_smtp_start%& ACLs.
32370
32371 The &%per_mail%& option limits the client's rate of sending messages. This is
32372 the default if none of the &%per_*%& options is specified. It can be used in
32373 &%acl_smtp_mail%&, &%acl_smtp_rcpt%&, &%acl_smtp_predata%&, &%acl_smtp_mime%&,
32374 &%acl_smtp_data%&, or &%acl_not_smtp%&.
32375
32376 The &%per_byte%& option limits the sender's email bandwidth. It can be used in
32377 the same ACLs as the &%per_mail%& option, though it is best to use this option
32378 in the &%acl_smtp_mime%&, &%acl_smtp_data%& or &%acl_not_smtp%& ACLs; if it is
32379 used in an earlier ACL, Exim relies on the SIZE parameter given by the client
32380 in its MAIL command, which may be inaccurate or completely missing. You can
32381 follow the limit &'m'& in the configuration with K, M, or G to specify limits
32382 in kilobytes, megabytes, or gigabytes, respectively.
32383
32384 The &%per_rcpt%& option causes Exim to limit the rate at which recipients are
32385 accepted. It can be used in the &%acl_smtp_rcpt%&, &%acl_smtp_predata%&,
32386 &%acl_smtp_mime%&, &%acl_smtp_data%&, or &%acl_smtp_rcpt%& ACLs. In
32387 &%acl_smtp_rcpt%& the rate is updated one recipient at a time; in the other
32388 ACLs the rate is updated with the total (accepted) recipient count in one go. Note that
32389 in either case the rate limiting engine will see a message with many
32390 recipients as a large high-speed burst.
32391
32392 The &%per_addr%& option is like the &%per_rcpt%& option, except it counts the
32393 number of different recipients that the client has sent messages to in the
32394 last time period. That is, if the client repeatedly sends messages to the same
32395 recipient, its measured rate is not increased. This option can only be used in
32396 &%acl_smtp_rcpt%&.
32397
32398 The &%per_cmd%& option causes Exim to recompute the rate every time the
32399 condition is processed. This can be used to limit the rate of any SMTP
32400 command. If it is used in multiple ACLs it can limit the aggregate rate of
32401 multiple different commands.
32402
32403 The &%count=%& option can be used to alter how much Exim adds to the client's
32404 measured rate. For example, the &%per_byte%& option is equivalent to
32405 &`per_mail/count=$message_size`&. If there is no &%count=%& option, Exim
32406 increases the measured rate by one (except for the &%per_rcpt%& option in ACLs
32407 other than &%acl_smtp_rcpt%&). The count does not have to be an integer.
32408
32409 The &%unique=%& option is described in section &<<ratoptuniq>>& below.
32410
32411
32412 .section "Ratelimit update modes" "ratoptupd"
32413 .cindex "rate limiting" "reading data without updating"
32414 You can specify one of three options with the &%ratelimit%& condition to
32415 control when its database is updated. This section describes the &%readonly%&
32416 mode, and the next section describes the &%strict%& and &%leaky%& modes.
32417
32418 If the &%ratelimit%& condition is used in &%readonly%& mode, Exim looks up a
32419 previously-computed rate to check against the limit.
32420
32421 For example, you can test the client's sending rate and deny it access (when
32422 it is too fast) in the connect ACL. If the client passes this check then it
32423 can go on to send a message, in which case its recorded rate will be updated
32424 in the MAIL ACL. Subsequent connections from the same client will check this
32425 new rate.
32426 .code
32427 acl_check_connect:
32428  deny ratelimit = 100 / 5m / readonly
32429       log_message = RATE CHECK: $sender_rate/$sender_rate_period \
32430                   (max $sender_rate_limit)
32431 # ...
32432 acl_check_mail:
32433  warn ratelimit = 100 / 5m / strict
32434       log_message = RATE UPDATE: $sender_rate/$sender_rate_period \
32435                   (max $sender_rate_limit)
32436 .endd
32437
32438 If Exim encounters multiple &%ratelimit%& conditions with the same key when
32439 processing a message then it may increase the client's measured rate more than
32440 it should. For example, this will happen if you check the &%per_rcpt%& option
32441 in both &%acl_smtp_rcpt%& and &%acl_smtp_data%&. However it's OK to check the
32442 same &%ratelimit%& condition multiple times in the same ACL. You can avoid any
32443 multiple update problems by using the &%readonly%& option on later ratelimit
32444 checks.
32445
32446 The &%per_*%& options described above do not make sense in some ACLs. If you
32447 use a &%per_*%& option in an ACL where it is not normally permitted then the
32448 update mode defaults to &%readonly%& and you cannot specify the &%strict%& or
32449 &%leaky%& modes. In other ACLs the default update mode is &%leaky%& (see the
32450 next section) so you must specify the &%readonly%& option explicitly.
32451
32452
32453 .section "Ratelimit options for handling fast clients" "ratoptfast"
32454 .cindex "rate limiting" "strict and leaky modes"
32455 If a client's average rate is greater than the maximum, the rate limiting
32456 engine can react in two possible ways, depending on the presence of the
32457 &%strict%& or &%leaky%& update modes. This is independent of the other
32458 counter-measures (such as rejecting the message) that may be specified by the
32459 rest of the ACL.
32460
32461 The &%leaky%& (default) option means that the client's recorded rate is not
32462 updated if it is above the limit. The effect of this is that Exim measures the
32463 client's average rate of successfully sent email,
32464 up to the given limit.
32465 This is appropriate if the countermeasure when the condition is true
32466 consists of refusing the message, and
32467 is generally the better choice if you have clients that retry automatically.
32468 If the action when true is anything more complex then this option is
32469 likely not what is wanted.
32470
32471 The &%strict%& option means that the client's recorded rate is always
32472 updated. The effect of this is that Exim measures the client's average rate
32473 of attempts to send email, which can be much higher than the maximum it is
32474 actually allowed. If the client is over the limit it may be subjected to
32475 counter-measures by the ACL. It must slow down and allow sufficient time to
32476 pass that its computed rate falls below the maximum before it can send email
32477 again. The time (the number of smoothing periods) it must wait and not
32478 attempt to send mail can be calculated with this formula:
32479 .code
32480         ln(peakrate/maxrate)
32481 .endd
32482
32483
32484 .section "Limiting the rate of different events" "ratoptuniq"
32485 .cindex "rate limiting" "counting unique events"
32486 The &%ratelimit%& &%unique=%& option controls a mechanism for counting the
32487 rate of different events. For example, the &%per_addr%& option uses this
32488 mechanism to count the number of different recipients that the client has
32489 sent messages to in the last time period; it is equivalent to
32490 &`per_rcpt/unique=$local_part@$domain`&. You could use this feature to
32491 measure the rate that a client uses different sender addresses with the
32492 options &`per_mail/unique=$sender_address`&.
32493
32494 For each &%ratelimit%& key Exim stores the set of &%unique=%& values that it
32495 has seen for that key. The whole set is thrown away when it is older than the
32496 rate smoothing period &'p'&, so each different event is counted at most once
32497 per period. In the &%leaky%& update mode, an event that causes the client to
32498 go over the limit is not added to the set, in the same way that the client's
32499 recorded rate is not updated in the same situation.
32500
32501 When you combine the &%unique=%& and &%readonly%& options, the specific
32502 &%unique=%& value is ignored, and Exim just retrieves the client's stored
32503 rate.
32504
32505 The &%unique=%& mechanism needs more space in the ratelimit database than the
32506 other &%ratelimit%& options in order to store the event set. The number of
32507 unique values is potentially as large as the rate limit, so the extra space
32508 required increases with larger limits.
32509
32510 The uniqueification is not perfect: there is a small probability that Exim
32511 will think a new event has happened before. If the sender's rate is less than
32512 the limit, Exim should be more than 99.9% correct. However in &%strict%& mode
32513 the measured rate can go above the limit, in which case Exim may under-count
32514 events by a significant margin. Fortunately, if the rate is high enough (2.7
32515 times the limit) that the false positive rate goes above 9%, then Exim will
32516 throw away the over-full event set before the measured rate falls below the
32517 limit. Therefore the only harm should be that exceptionally high sending rates
32518 are logged incorrectly; any countermeasures you configure will be as effective
32519 as intended.
32520
32521
32522 .section "Using rate limiting" "useratlim"
32523 Exim's other ACL facilities are used to define what counter-measures are taken
32524 when the rate limit is exceeded. This might be anything from logging a warning
32525 (for example, while measuring existing sending rates in order to define
32526 policy), through time delays to slow down fast senders, up to rejecting the
32527 message. For example:
32528 .code
32529 # Log all senders' rates
32530 warn ratelimit = 0 / 1h / strict
32531      log_message = Sender rate $sender_rate / $sender_rate_period
32532
32533 # Slow down fast senders; note the need to truncate $sender_rate
32534 # at the decimal point.
32535 warn ratelimit = 100 / 1h / per_rcpt / strict
32536      delay     = ${eval: ${sg{$sender_rate}{[.].*}{}} - \
32537                    $sender_rate_limit }s
32538
32539 # Keep authenticated users under control
32540 deny authenticated = *
32541      ratelimit = 100 / 1d / strict / $authenticated_id
32542
32543 # System-wide rate limit
32544 defer ratelimit = 10 / 1s / $primary_hostname
32545       message = Sorry, too busy. Try again later.
32546
32547 # Restrict incoming rate from each host, with a default
32548 # set using a macro and special cases looked up in a table.
32549 defer ratelimit = ${lookup {$sender_host_address} \
32550                    cdb {DB/ratelimits.cdb} \
32551                    {$value} {RATELIMIT} }
32552       message = Sender rate exceeds $sender_rate_limit \
32553                messages per $sender_rate_period
32554 .endd
32555 &*Warning*&: If you have a busy server with a lot of &%ratelimit%& tests,
32556 especially with the &%per_rcpt%& option, you may suffer from a performance
32557 bottleneck caused by locking on the ratelimit hints database. Apart from
32558 making your ACLs less complicated, you can reduce the problem by using a
32559 RAM disk for Exim's hints directory (usually &_/var/spool/exim/db/_&). However
32560 this means that Exim will lose its hints data after a reboot (including retry
32561 hints, the callout cache, and ratelimit data).
32562
32563
32564
32565 .section "Address verification" "SECTaddressverification"
32566 .cindex "verifying address" "options for"
32567 .cindex "policy control" "address verification"
32568 Several of the &%verify%& conditions described in section
32569 &<<SECTaclconditions>>& cause addresses to be verified. Section
32570 &<<SECTsenaddver>>& discusses the reporting of sender verification failures.
32571 The verification conditions can be followed by options that modify the
32572 verification process. The options are separated from the keyword and from each
32573 other by slashes, and some of them contain parameters. For example:
32574 .code
32575 verify = sender/callout
32576 verify = recipient/defer_ok/callout=10s,defer_ok
32577 .endd
32578 The first stage of address verification, which always happens, is to run the
32579 address through the routers, in &"verify mode"&. Routers can detect the
32580 difference between verification and routing for delivery, and their actions can
32581 be varied by a number of generic options such as &%verify%& and &%verify_only%&
32582 (see chapter &<<CHAProutergeneric>>&). If routing fails, verification fails.
32583 The available options are as follows:
32584
32585 .ilist
32586 If the &%callout%& option is specified, successful routing to one or more
32587 remote hosts is followed by a &"callout"& to those hosts as an additional
32588 check. Callouts and their sub-options are discussed in the next section.
32589 .next
32590 If there is a defer error while doing verification routing, the ACL
32591 normally returns &"defer"&. However, if you include &%defer_ok%& in the
32592 options, the condition is forced to be true instead. Note that this is a main
32593 verification option as well as a suboption for callouts.
32594 .next
32595 The &%no_details%& option is covered in section &<<SECTsenaddver>>&, which
32596 discusses the reporting of sender address verification failures.
32597 .next
32598 The &%success_on_redirect%& option causes verification always to succeed
32599 immediately after a successful redirection. By default, if a redirection
32600 generates just one address, that address is also verified. See further
32601 discussion in section &<<SECTredirwhilveri>>&.
32602 .endlist
32603
32604 .cindex "verifying address" "differentiating failures"
32605 .vindex "&$recipient_verify_failure$&"
32606 .vindex "&$sender_verify_failure$&"
32607 .vindex "&$acl_verify_message$&"
32608 After an address verification failure, &$acl_verify_message$& contains the
32609 error message that is associated with the failure. It can be preserved by
32610 coding like this:
32611 .code
32612 warn  !verify = sender
32613        set acl_m0 = $acl_verify_message
32614 .endd
32615 If you are writing your own custom rejection message or log message when
32616 denying access, you can use this variable to include information about the
32617 verification failure.
32618
32619 In addition, &$sender_verify_failure$& or &$recipient_verify_failure$& (as
32620 appropriate) contains one of the following words:
32621
32622 .ilist
32623 &%qualify%&: The address was unqualified (no domain), and the message
32624 was neither local nor came from an exempted host.
32625 .next
32626 &%route%&: Routing failed.
32627 .next
32628 &%mail%&: Routing succeeded, and a callout was attempted; rejection
32629 occurred at or before the MAIL command (that is, on initial
32630 connection, HELO, or MAIL).
32631 .next
32632 &%recipient%&: The RCPT command in a callout was rejected.
32633 .next
32634 &%postmaster%&: The postmaster check in a callout was rejected.
32635 .endlist
32636
32637 The main use of these variables is expected to be to distinguish between
32638 rejections of MAIL and rejections of RCPT in callouts.
32639
32640 The above variables may also be set after a &*successful*&
32641 address verification to:
32642
32643 .ilist
32644 &%random%&: A random local-part callout succeeded
32645 .endlist
32646
32647
32648
32649
32650 .section "Callout verification" "SECTcallver"
32651 .cindex "verifying address" "by callout"
32652 .cindex "callout" "verification"
32653 .cindex "SMTP" "callout verification"
32654 For non-local addresses, routing verifies the domain, but is unable to do any
32655 checking of the local part. There are situations where some means of verifying
32656 the local part is desirable. One way this can be done is to make an SMTP
32657 &'callback'& to a delivery host for the sender address or a &'callforward'& to
32658 a subsequent host for a recipient address, to see if the host accepts the
32659 address. We use the term &'callout'& to cover both cases. Note that for a
32660 sender address, the callback is not to the client host that is trying to
32661 deliver the message, but to one of the hosts that accepts incoming mail for the
32662 sender's domain.
32663
32664 Exim does not do callouts by default. If you want them to happen, you must
32665 request them by setting appropriate options on the &%verify%& condition, as
32666 described below. This facility should be used with care, because it can add a
32667 lot of resource usage to the cost of verifying an address. However, Exim does
32668 cache the results of callouts, which helps to reduce the cost. Details of
32669 caching are in section &<<SECTcallvercache>>&.
32670
32671 Recipient callouts are usually used only between hosts that are controlled by
32672 the same administration. For example, a corporate gateway host could use
32673 callouts to check for valid recipients on an internal mailserver. A successful
32674 callout does not guarantee that a real delivery to the address would succeed;
32675 on the other hand, a failing callout does guarantee that a delivery would fail.
32676
32677 If the &%callout%& option is present on a condition that verifies an address, a
32678 second stage of verification occurs if the address is successfully routed to
32679 one or more remote hosts. The usual case is routing by a &(dnslookup)& or a
32680 &(manualroute)& router, where the router specifies the hosts. However, if a
32681 router that does not set up hosts routes to an &(smtp)& transport with a
32682 &%hosts%& setting, the transport's hosts are used. If an &(smtp)& transport has
32683 &%hosts_override%& set, its hosts are always used, whether or not the router
32684 supplies a host list.
32685 Callouts are only supported on &(smtp)& transports.
32686
32687 The port that is used is taken from the transport, if it is specified and is a
32688 remote transport. (For routers that do verification only, no transport need be
32689 specified.) Otherwise, the default SMTP port is used. If a remote transport
32690 specifies an outgoing interface, this is used; otherwise the interface is not
32691 specified. Likewise, the text that is used for the HELO command is taken from
32692 the transport's &%helo_data%& option; if there is no transport, the value of
32693 &$smtp_active_hostname$& is used.
32694
32695 For a sender callout check, Exim makes SMTP connections to the remote hosts, to
32696 test whether a bounce message could be delivered to the sender address. The
32697 following SMTP commands are sent:
32698 .display
32699 &`HELO `&<&'local host name'&>
32700 &`MAIL FROM:<>`&
32701 &`RCPT TO:`&<&'the address to be tested'&>
32702 &`QUIT`&
32703 .endd
32704 LHLO is used instead of HELO if the transport's &%protocol%& option is
32705 set to &"lmtp"&.
32706
32707 The callout may use EHLO, AUTH and/or STARTTLS given appropriate option
32708 settings.
32709
32710 A recipient callout check is similar. By default, it also uses an empty address
32711 for the sender. This default is chosen because most hosts do not make use of
32712 the sender address when verifying a recipient. Using the same address means
32713 that a single cache entry can be used for each recipient. Some sites, however,
32714 do make use of the sender address when verifying. These are catered for by the
32715 &%use_sender%& and &%use_postmaster%& options, described in the next section.
32716
32717 If the response to the RCPT command is a 2&'xx'& code, the verification
32718 succeeds. If it is 5&'xx'&, the verification fails. For any other condition,
32719 Exim tries the next host, if any. If there is a problem with all the remote
32720 hosts, the ACL yields &"defer"&, unless the &%defer_ok%& parameter of the
32721 &%callout%& option is given, in which case the condition is forced to succeed.
32722
32723 .cindex "SMTP" "output flushing, disabling for callout"
32724 A callout may take a little time. For this reason, Exim normally flushes SMTP
32725 output before performing a callout in an ACL, to avoid unexpected timeouts in
32726 clients when the SMTP PIPELINING extension is in use. The flushing can be
32727 disabled by using a &%control%& modifier to set &%no_callout_flush%&.
32728
32729
32730
32731
32732 .section "Additional parameters for callouts" "CALLaddparcall"
32733 .cindex "callout" "additional parameters for"
32734 The &%callout%& option can be followed by an equals sign and a number of
32735 optional parameters, separated by commas. For example:
32736 .code
32737 verify = recipient/callout=10s,defer_ok
32738 .endd
32739 The old syntax, which had &%callout_defer_ok%& and &%check_postmaster%& as
32740 separate verify options, is retained for backwards compatibility, but is now
32741 deprecated. The additional parameters for &%callout%& are as follows:
32742
32743
32744 .vlist
32745 .vitem <&'a&~time&~interval'&>
32746 .cindex "callout" "timeout, specifying"
32747 This specifies the timeout that applies for the callout attempt to each host.
32748 For example:
32749 .code
32750 verify = sender/callout=5s
32751 .endd
32752 The default is 30 seconds. The timeout is used for each response from the
32753 remote host. It is also used for the initial connection, unless overridden by
32754 the &%connect%& parameter.
32755
32756
32757 .vitem &*connect&~=&~*&<&'time&~interval'&>
32758 .cindex "callout" "connection timeout, specifying"
32759 This parameter makes it possible to set a different (usually smaller) timeout
32760 for making the SMTP connection. For example:
32761 .code
32762 verify = sender/callout=5s,connect=1s
32763 .endd
32764 If not specified, this timeout defaults to the general timeout value.
32765
32766 .vitem &*defer_ok*&
32767 .cindex "callout" "defer, action on"
32768 When this parameter is present, failure to contact any host, or any other kind
32769 of temporary error, is treated as success by the ACL. However, the cache is not
32770 updated in this circumstance.
32771
32772 .vitem &*fullpostmaster*&
32773 .cindex "callout" "full postmaster check"
32774 This operates like the &%postmaster%& option (see below), but if the check for
32775 &'postmaster@domain'& fails, it tries just &'postmaster'&, without a domain, in
32776 accordance with the specification in RFC 2821. The RFC states that the
32777 unqualified address &'postmaster'& should be accepted.
32778
32779
32780 .vitem &*mailfrom&~=&~*&<&'email&~address'&>
32781 .cindex "callout" "sender when verifying header"
32782 When verifying addresses in header lines using the &%header_sender%&
32783 verification option, Exim behaves by default as if the addresses are envelope
32784 sender addresses from a message. Callout verification therefore tests to see
32785 whether a bounce message could be delivered, by using an empty address in the
32786 MAIL command. However, it is arguable that these addresses might never be used
32787 as envelope senders, and could therefore justifiably reject bounce messages
32788 (empty senders). The &%mailfrom%& callout parameter allows you to specify what
32789 address to use in the MAIL command. For example:
32790 .code
32791 require  verify = header_sender/callout=mailfrom=abcd@x.y.z
32792 .endd
32793 This parameter is available only for the &%header_sender%& verification option.
32794
32795
32796 .vitem &*maxwait&~=&~*&<&'time&~interval'&>
32797 .cindex "callout" "overall timeout, specifying"
32798 This parameter sets an overall timeout for performing a callout verification.
32799 For example:
32800 .code
32801 verify = sender/callout=5s,maxwait=30s
32802 .endd
32803 This timeout defaults to four times the callout timeout for individual SMTP
32804 commands. The overall timeout applies when there is more than one host that can
32805 be tried. The timeout is checked before trying the next host. This prevents
32806 very long delays if there are a large number of hosts and all are timing out
32807 (for example, when network connections are timing out).
32808
32809
32810 .vitem &*no_cache*&
32811 .cindex "callout" "cache, suppressing"
32812 .cindex "caching callout, suppressing"
32813 When this parameter is given, the callout cache is neither read nor updated.
32814
32815 .vitem &*postmaster*&
32816 .cindex "callout" "postmaster; checking"
32817 When this parameter is set, a successful callout check is followed by a similar
32818 check for the local part &'postmaster'& at the same domain. If this address is
32819 rejected, the callout fails (but see &%fullpostmaster%& above). The result of
32820 the postmaster check is recorded in a cache record; if it is a failure, this is
32821 used to fail subsequent callouts for the domain without a connection being
32822 made, until the cache record expires.
32823
32824 .vitem &*postmaster_mailfrom&~=&~*&<&'email&~address'&>
32825 The postmaster check uses an empty sender in the MAIL command by default.
32826 You can use this parameter to do a postmaster check using a different address.
32827 For example:
32828 .code
32829 require  verify = sender/callout=postmaster_mailfrom=abc@x.y.z
32830 .endd
32831 If both &%postmaster%& and &%postmaster_mailfrom%& are present, the rightmost
32832 one overrides. The &%postmaster%& parameter is equivalent to this example:
32833 .code
32834 require  verify = sender/callout=postmaster_mailfrom=
32835 .endd
32836 &*Warning*&: The caching arrangements for postmaster checking do not take
32837 account of the sender address. It is assumed that either the empty address or
32838 a fixed non-empty address will be used. All that Exim remembers is that the
32839 postmaster check for the domain succeeded or failed.
32840
32841
32842 .vitem &*random*&
32843 .cindex "callout" "&""random""& check"
32844 When this parameter is set, before doing the normal callout check, Exim does a
32845 check for a &"random"& local part at the same domain. The local part is not
32846 really random &-- it is defined by the expansion of the option
32847 &%callout_random_local_part%&, which defaults to
32848 .code
32849 $primary_hostname-$tod_epoch-testing
32850 .endd
32851 The idea here is to try to determine whether the remote host accepts all local
32852 parts without checking. If it does, there is no point in doing callouts for
32853 specific local parts. If the &"random"& check succeeds, the result is saved in
32854 a cache record, and used to force the current and subsequent callout checks to
32855 succeed without a connection being made, until the cache record expires.
32856
32857 .vitem &*use_postmaster*&
32858 .cindex "callout" "sender for recipient check"
32859 This parameter applies to recipient callouts only. For example:
32860 .code
32861 deny  !verify = recipient/callout=use_postmaster
32862 .endd
32863 .vindex "&$qualify_domain$&"
32864 It causes a non-empty postmaster address to be used in the MAIL command when
32865 performing the callout for the recipient, and also for a &"random"& check if
32866 that is configured. The local part of the address is &`postmaster`& and the
32867 domain is the contents of &$qualify_domain$&.
32868
32869 .vitem &*use_sender*&
32870 This option applies to recipient callouts only. For example:
32871 .code
32872 require  verify = recipient/callout=use_sender
32873 .endd
32874 It causes the message's actual sender address to be used in the MAIL
32875 command when performing the callout, instead of an empty address. There is no
32876 need to use this option unless you know that the called hosts make use of the
32877 sender when checking recipients. If used indiscriminately, it reduces the
32878 usefulness of callout caching.
32879
32880 .vitem &*hold*&
32881 This option applies to recipient callouts only. For example:
32882 .code
32883 require  verify = recipient/callout=use_sender,hold
32884 .endd
32885 It causes the connection to be held open and used for any further recipients
32886 and for eventual delivery (should that be done quickly).
32887 Doing this saves on TCP and SMTP startup costs, and TLS costs also
32888 when that is used for the connections.
32889 The advantage is only gained if there are no callout cache hits
32890 (which could be enforced by the no_cache option),
32891 if the use_sender option is used,
32892 if neither the random nor the use_postmaster option is used,
32893 and if no other callouts intervene.
32894 .endlist
32895
32896 If you use any of the parameters that set a non-empty sender for the MAIL
32897 command (&%mailfrom%&, &%postmaster_mailfrom%&, &%use_postmaster%&, or
32898 &%use_sender%&), you should think about possible loops. Recipient checking is
32899 usually done between two hosts that are under the same management, and the host
32900 that receives the callouts is not normally configured to do callouts itself.
32901 Therefore, it is normally safe to use &%use_postmaster%& or &%use_sender%& in
32902 these circumstances.
32903
32904 However, if you use a non-empty sender address for a callout to an arbitrary
32905 host, there is the likelihood that the remote host will itself initiate a
32906 callout check back to your host. As it is checking what appears to be a message
32907 sender, it is likely to use an empty address in MAIL, thus avoiding a
32908 callout loop. However, to be on the safe side it would be best to set up your
32909 own ACLs so that they do not do sender verification checks when the recipient
32910 is the address you use for header sender or postmaster callout checking.
32911
32912 Another issue to think about when using non-empty senders for callouts is
32913 caching. When you set &%mailfrom%& or &%use_sender%&, the cache record is keyed
32914 by the sender/recipient combination; thus, for any given recipient, many more
32915 actual callouts are performed than when an empty sender or postmaster is used.
32916
32917
32918
32919
32920 .section "Callout caching" "SECTcallvercache"
32921 .cindex "hints database" "callout cache"
32922 .cindex "callout" "cache, description of"
32923 .cindex "caching" "callout"
32924 Exim caches the results of callouts in order to reduce the amount of resources
32925 used, unless you specify the &%no_cache%& parameter with the &%callout%&
32926 option. A hints database called &"callout"& is used for the cache. Two
32927 different record types are used: one records the result of a callout check for
32928 a specific address, and the other records information that applies to the
32929 entire domain (for example, that it accepts the local part &'postmaster'&).
32930
32931 When an original callout fails, a detailed SMTP error message is given about
32932 the failure. However, for subsequent failures use the cache data, this message
32933 is not available.
32934
32935 The expiry times for negative and positive address cache records are
32936 independent, and can be set by the global options &%callout_negative_expire%&
32937 (default 2h) and &%callout_positive_expire%& (default 24h), respectively.
32938
32939 If a host gives a negative response to an SMTP connection, or rejects any
32940 commands up to and including
32941 .code
32942 MAIL FROM:<>
32943 .endd
32944 (but not including the MAIL command with a non-empty address),
32945 any callout attempt is bound to fail. Exim remembers such failures in a
32946 domain cache record, which it uses to fail callouts for the domain without
32947 making new connections, until the domain record times out. There are two
32948 separate expiry times for domain cache records:
32949 &%callout_domain_negative_expire%& (default 3h) and
32950 &%callout_domain_positive_expire%& (default 7d).
32951
32952 Domain records expire when the negative expiry time is reached if callouts
32953 cannot be made for the domain, or if the postmaster check failed.
32954 Otherwise, they expire when the positive expiry time is reached. This
32955 ensures that, for example, a host that stops accepting &"random"& local parts
32956 will eventually be noticed.
32957
32958 The callout caching mechanism is based on the domain of the address that is
32959 being tested. If the domain routes to several hosts, it is assumed that their
32960 behaviour will be the same.
32961
32962
32963
32964 .section "Sender address verification reporting" "SECTsenaddver"
32965 .cindex "verifying" "suppressing error details"
32966 See section &<<SECTaddressverification>>& for a general discussion of
32967 verification. When sender verification fails in an ACL, the details of the
32968 failure are given as additional output lines before the 550 response to the
32969 relevant SMTP command (RCPT or DATA). For example, if sender callout is in use,
32970 you might see:
32971 .code
32972 MAIL FROM:<xyz@abc.example>
32973 250 OK
32974 RCPT TO:<pqr@def.example>
32975 550-Verification failed for <xyz@abc.example>
32976 550-Called:   192.168.34.43
32977 550-Sent:     RCPT TO:<xyz@abc.example>
32978 550-Response: 550 Unknown local part xyz in <xyz@abc.example>
32979 550 Sender verification failed
32980 .endd
32981 If more than one RCPT command fails in the same way, the details are given
32982 only for the first of them. However, some administrators do not want to send
32983 out this much information. You can suppress the details by adding
32984 &`/no_details`& to the ACL statement that requests sender verification. For
32985 example:
32986 .code
32987 verify = sender/no_details
32988 .endd
32989
32990 .section "Redirection while verifying" "SECTredirwhilveri"
32991 .cindex "verifying" "redirection while"
32992 .cindex "address redirection" "while verifying"
32993 A dilemma arises when a local address is redirected by aliasing or forwarding
32994 during verification: should the generated addresses themselves be verified,
32995 or should the successful expansion of the original address be enough to verify
32996 it? By default, Exim takes the following pragmatic approach:
32997
32998 .ilist
32999 When an incoming address is redirected to just one child address, verification
33000 continues with the child address, and if that fails to verify, the original
33001 verification also fails.
33002 .next
33003 When an incoming address is redirected to more than one child address,
33004 verification does not continue. A success result is returned.
33005 .endlist
33006
33007 This seems the most reasonable behaviour for the common use of aliasing as a
33008 way of redirecting different local parts to the same mailbox. It means, for
33009 example, that a pair of alias entries of the form
33010 .code
33011 A.Wol:   aw123
33012 aw123:   :fail: Gone away, no forwarding address
33013 .endd
33014 work as expected, with both local parts causing verification failure. When a
33015 redirection generates more than one address, the behaviour is more like a
33016 mailing list, where the existence of the alias itself is sufficient for
33017 verification to succeed.
33018
33019 It is possible, however, to change the default behaviour so that all successful
33020 redirections count as successful verifications, however many new addresses are
33021 generated. This is specified by the &%success_on_redirect%& verification
33022 option. For example:
33023 .code
33024 require verify = recipient/success_on_redirect/callout=10s
33025 .endd
33026 In this example, verification succeeds if a router generates a new address, and
33027 the callout does not occur, because no address was routed to a remote host.
33028
33029 When verification is being tested via the &%-bv%& option, the treatment of
33030 redirections is as just described, unless the &%-v%& or any debugging option is
33031 also specified. In that case, full verification is done for every generated
33032 address and a report is output for each of them.
33033
33034
33035
33036 .section "Client SMTP authorization (CSA)" "SECTverifyCSA"
33037 .cindex "CSA" "verifying"
33038 Client SMTP Authorization is a system that allows a site to advertise
33039 which machines are and are not permitted to send email. This is done by placing
33040 special SRV records in the DNS; these are looked up using the client's HELO
33041 domain. At the time of writing, CSA is still an Internet Draft. Client SMTP
33042 Authorization checks in Exim are performed by the ACL condition:
33043 .code
33044 verify = csa
33045 .endd
33046 This fails if the client is not authorized. If there is a DNS problem, or if no
33047 valid CSA SRV record is found, or if the client is authorized, the condition
33048 succeeds. These three cases can be distinguished using the expansion variable
33049 &$csa_status$&, which can take one of the values &"fail"&, &"defer"&,
33050 &"unknown"&, or &"ok"&. The condition does not itself defer because that would
33051 be likely to cause problems for legitimate email.
33052
33053 The error messages produced by the CSA code include slightly more
33054 detail. If &$csa_status$& is &"defer"&, this may be because of problems
33055 looking up the CSA SRV record, or problems looking up the CSA target
33056 address record. There are four reasons for &$csa_status$& being &"fail"&:
33057
33058 .ilist
33059 The client's host name is explicitly not authorized.
33060 .next
33061 The client's IP address does not match any of the CSA target IP addresses.
33062 .next
33063 The client's host name is authorized but it has no valid target IP addresses
33064 (for example, the target's addresses are IPv6 and the client is using IPv4).
33065 .next
33066 The client's host name has no CSA SRV record but a parent domain has asserted
33067 that all subdomains must be explicitly authorized.
33068 .endlist
33069
33070 The &%csa%& verification condition can take an argument which is the domain to
33071 use for the DNS query. The default is:
33072 .code
33073 verify = csa/$sender_helo_name
33074 .endd
33075 This implementation includes an extension to CSA. If the query domain
33076 is an address literal such as [192.0.2.95], or if it is a bare IP
33077 address, Exim searches for CSA SRV records in the reverse DNS as if
33078 the HELO domain was (for example) &'95.2.0.192.in-addr.arpa'&. Therefore it is
33079 meaningful to say:
33080 .code
33081 verify = csa/$sender_host_address
33082 .endd
33083 In fact, this is the check that Exim performs if the client does not say HELO.
33084 This extension can be turned off by setting the main configuration option
33085 &%dns_csa_use_reverse%& to be false.
33086
33087 If a CSA SRV record is not found for the domain itself, a search
33088 is performed through its parent domains for a record which might be
33089 making assertions about subdomains. The maximum depth of this search is limited
33090 using the main configuration option &%dns_csa_search_limit%&, which is 5 by
33091 default. Exim does not look for CSA SRV records in a top level domain, so the
33092 default settings handle HELO domains as long as seven
33093 (&'hostname.five.four.three.two.one.com'&). This encompasses the vast majority
33094 of legitimate HELO domains.
33095
33096 The &'dnsdb'& lookup also has support for CSA. Although &'dnsdb'& also supports
33097 direct SRV lookups, this is not sufficient because of the extra parent domain
33098 search behaviour of CSA, and (as with PTR lookups) &'dnsdb'& also turns IP
33099 addresses into lookups in the reverse DNS space. The result of a successful
33100 lookup such as:
33101 .code
33102 ${lookup dnsdb {csa=$sender_helo_name}}
33103 .endd
33104 has two space-separated fields: an authorization code and a target host name.
33105 The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
33106 authorization required but absent, or &"?"& for unknown.
33107
33108
33109
33110
33111 .section "Bounce address tag validation" "SECTverifyPRVS"
33112 .cindex "BATV, verifying"
33113 Bounce address tag validation (BATV) is a scheme whereby the envelope senders
33114 of outgoing messages have a cryptographic, timestamped &"tag"& added to them.
33115 Genuine incoming bounce messages should therefore always be addressed to
33116 recipients that have a valid tag. This scheme is a way of detecting unwanted
33117 bounce messages caused by sender address forgeries (often called &"collateral
33118 spam"&), because the recipients of such messages do not include valid tags.
33119
33120 There are two expansion items to help with the implementation of the BATV
33121 &"prvs"& (private signature) scheme in an Exim configuration. This scheme signs
33122 the original envelope sender address by using a simple key to add a hash of the
33123 address and some time-based randomizing information. The &%prvs%& expansion
33124 item creates a signed address, and the &%prvscheck%& expansion item checks one.
33125 The syntax of these expansion items is described in section
33126 &<<SECTexpansionitems>>&.
33127 The validity period on signed addresses is seven days.
33128
33129 As an example, suppose the secret per-address keys are stored in an MySQL
33130 database. A query to look up the key for an address could be defined as a macro
33131 like this:
33132 .code
33133 PRVSCHECK_SQL = ${lookup mysql{SELECT secret FROM batv_prvs \
33134                 WHERE sender='${quote_mysql:$prvscheck_address}'\
33135                 }{$value}}
33136 .endd
33137 Suppose also that the senders who make use of BATV are defined by an address
33138 list called &%batv_senders%&. Then, in the ACL for RCPT commands, you could
33139 use this:
33140 .code
33141 # Bounces: drop unsigned addresses for BATV senders
33142 deny senders = :
33143      recipients = +batv_senders
33144      message = This address does not send an unsigned reverse path
33145
33146 # Bounces: In case of prvs-signed address, check signature.
33147 deny senders = :
33148      condition  = ${prvscheck {$local_part@$domain}\
33149                   {PRVSCHECK_SQL}{1}}
33150      !condition = $prvscheck_result
33151      message = Invalid reverse path signature.
33152 .endd
33153 The first statement rejects recipients for bounce messages that are addressed
33154 to plain BATV sender addresses, because it is known that BATV senders do not
33155 send out messages with plain sender addresses. The second statement rejects
33156 recipients that are prvs-signed, but with invalid signatures (either because
33157 the key is wrong, or the signature has timed out).
33158
33159 A non-prvs-signed address is not rejected by the second statement, because the
33160 &%prvscheck%& expansion yields an empty string if its first argument is not a
33161 prvs-signed address, thus causing the &%condition%& condition to be false. If
33162 the first argument is a syntactically valid prvs-signed address, the yield is
33163 the third string (in this case &"1"&), whether or not the cryptographic and
33164 timeout checks succeed. The &$prvscheck_result$& variable contains the result
33165 of the checks (empty for failure, &"1"& for success).
33166
33167 There is one more issue you must consider when implementing prvs-signing:
33168 you have to ensure that the routers accept prvs-signed addresses and
33169 deliver them correctly. The easiest way to handle this is to use a &(redirect)&
33170 router to remove the signature with a configuration along these lines:
33171 .code
33172 batv_redirect:
33173   driver = redirect
33174   data = ${prvscheck {$local_part@$domain}{PRVSCHECK_SQL}}
33175 .endd
33176 This works because, if the third argument of &%prvscheck%& is empty, the result
33177 of the expansion of a prvs-signed address is the decoded value of the original
33178 address. This router should probably be the first of your routers that handles
33179 local addresses.
33180
33181 To create BATV-signed addresses in the first place, a transport of this form
33182 can be used:
33183 .code
33184 external_smtp_batv:
33185   driver = smtp
33186   return_path = ${prvs {$return_path} \
33187                        {${lookup mysql{SELECT \
33188                        secret FROM batv_prvs WHERE \
33189                        sender='${quote_mysql:$sender_address}'} \
33190                        {$value}fail}}}
33191 .endd
33192 If no key can be found for the existing return path, no signing takes place.
33193
33194
33195
33196 .section "Using an ACL to control relaying" "SECTrelaycontrol"
33197 .cindex "&ACL;" "relay control"
33198 .cindex "relaying" "control by ACL"
33199 .cindex "policy control" "relay control"
33200 An MTA is said to &'relay'& a message if it receives it from some host and
33201 delivers it directly to another host as a result of a remote address contained
33202 within it. Redirecting a local address via an alias or forward file and then
33203 passing the message on to another host is not relaying,
33204 .cindex "&""percent hack""&"
33205 but a redirection as a result of the &"percent hack"& is.
33206
33207 Two kinds of relaying exist, which are termed &"incoming"& and &"outgoing"&.
33208 A host which is acting as a gateway or an MX backup is concerned with incoming
33209 relaying from arbitrary hosts to a specific set of domains. On the other hand,
33210 a host which is acting as a smart host for a number of clients is concerned
33211 with outgoing relaying from those clients to the Internet at large. Often the
33212 same host is fulfilling both functions,
33213 . ///
33214 . as illustrated in the diagram below,
33215 . ///
33216 but in principle these two kinds of relaying are entirely independent. What is
33217 not wanted is the transmission of mail from arbitrary remote hosts through your
33218 system to arbitrary domains.
33219
33220
33221 You can implement relay control by means of suitable statements in the ACL that
33222 runs for each RCPT command. For convenience, it is often easiest to use
33223 Exim's named list facility to define the domains and hosts involved. For
33224 example, suppose you want to do the following:
33225
33226 .ilist
33227 Deliver a number of domains to mailboxes on the local host (or process them
33228 locally in some other way). Let's say these are &'my.dom1.example'& and
33229 &'my.dom2.example'&.
33230 .next
33231 Relay mail for a number of other domains for which you are the secondary MX.
33232 These might be &'friend1.example'& and &'friend2.example'&.
33233 .next
33234 Relay mail from the hosts on your local LAN, to whatever domains are involved.
33235 Suppose your LAN is 192.168.45.0/24.
33236 .endlist
33237
33238
33239 In the main part of the configuration, you put the following definitions:
33240 .code
33241 domainlist local_domains    = my.dom1.example : my.dom2.example
33242 domainlist relay_to_domains = friend1.example : friend2.example
33243 hostlist   relay_from_hosts = 192.168.45.0/24
33244 .endd
33245 Now you can use these definitions in the ACL that is run for every RCPT
33246 command:
33247 .code
33248 acl_check_rcpt:
33249   accept domains = +local_domains : +relay_to_domains
33250   accept hosts   = +relay_from_hosts
33251 .endd
33252 The first statement accepts any RCPT command that contains an address in
33253 the local or relay domains. For any other domain, control passes to the second
33254 statement, which accepts the command only if it comes from one of the relay
33255 hosts. In practice, you will probably want to make your ACL more sophisticated
33256 than this, for example, by including sender and recipient verification. The
33257 default configuration includes a more comprehensive example, which is described
33258 in chapter &<<CHAPdefconfil>>&.
33259
33260
33261
33262 .section "Checking a relay configuration" "SECTcheralcon"
33263 .cindex "relaying" "checking control of"
33264 You can check the relay characteristics of your configuration in the same way
33265 that you can test any ACL behaviour for an incoming SMTP connection, by using
33266 the &%-bh%& option to run a fake SMTP session with which you interact.
33267 .ecindex IIDacl
33268
33269
33270
33271 . ////////////////////////////////////////////////////////////////////////////
33272 . ////////////////////////////////////////////////////////////////////////////
33273
33274 .chapter "Content scanning at ACL time" "CHAPexiscan"
33275 .scindex IIDcosca "content scanning" "at ACL time"
33276 The extension of Exim to include content scanning at ACL time, formerly known
33277 as &"exiscan"&, was originally implemented as a patch by Tom Kistner. The code
33278 was integrated into the main source for Exim release 4.50, and Tom continues to
33279 maintain it. Most of the wording of this chapter is taken from Tom's
33280 specification.
33281
33282 It is also possible to scan the content of messages at other times. The
33283 &[local_scan()]& function (see chapter &<<CHAPlocalscan>>&) allows for content
33284 scanning after all the ACLs have run. A transport filter can be used to scan
33285 messages at delivery time (see the &%transport_filter%& option, described in
33286 chapter &<<CHAPtransportgeneric>>&).
33287
33288 If you want to include the ACL-time content-scanning features when you compile
33289 Exim, you need to arrange for WITH_CONTENT_SCAN to be defined in your
33290 &_Local/Makefile_&. When you do that, the Exim binary is built with:
33291
33292 .ilist
33293 Two additional ACLs (&%acl_smtp_mime%& and &%acl_not_smtp_mime%&) that are run
33294 for all MIME parts for SMTP and non-SMTP messages, respectively.
33295 .next
33296 Additional ACL conditions and modifiers: &%decode%&, &%malware%&,
33297 &%mime_regex%&, &%regex%&, and &%spam%&. These can be used in the ACL that is
33298 run at the end of message reception (the &%acl_smtp_data%& ACL).
33299 .next
33300 An additional control feature (&"no_mbox_unspool"&) that saves spooled copies
33301 of messages, or parts of messages, for debugging purposes.
33302 .next
33303 Additional expansion variables that are set in the new ACL and by the new
33304 conditions.
33305 .next
33306 Two new main configuration options: &%av_scanner%& and &%spamd_address%&.
33307 .endlist
33308
33309 Content-scanning is continually evolving, and new features are still being
33310 added. While such features are still unstable and liable to incompatible
33311 changes, they are made available in Exim by setting options whose names begin
33312 EXPERIMENTAL_ in &_Local/Makefile_&. Such features are not documented in
33313 this manual. You can find out about them by reading the file called
33314 &_doc/experimental.txt_&.
33315
33316 All the content-scanning facilities work on a MBOX copy of the message that is
33317 temporarily created in a file called:
33318 .display
33319 <&'spool_directory'&>&`/scan/`&<&'message_id'&>/<&'message_id'&>&`.eml`&
33320 .endd
33321 The &_.eml_& extension is a friendly hint to virus scanners that they can
33322 expect an MBOX-like structure inside that file. The file is created when the
33323 first content scanning facility is called. Subsequent calls to content
33324 scanning conditions open the same file again. The directory is recursively
33325 removed when the &%acl_smtp_data%& ACL has finished running, unless
33326 .code
33327 control = no_mbox_unspool
33328 .endd
33329 has been encountered. When the MIME ACL decodes files, they are put into the
33330 same directory by default.
33331
33332
33333
33334 .section "Scanning for viruses" "SECTscanvirus"
33335 .cindex "virus scanning"
33336 .cindex "content scanning" "for viruses"
33337 .cindex "content scanning" "the &%malware%& condition"
33338 The &%malware%& ACL condition lets you connect virus scanner software to Exim.
33339 It supports a &"generic"& interface to scanners called via the shell, and
33340 specialized interfaces for &"daemon"& type virus scanners, which are resident
33341 in memory and thus are much faster.
33342
33343 Since message data needs to have arrived,
33344 the condition may be only called in ACL defined by
33345 &%acl_smtp_data%&,
33346 &%acl_smtp_data_prdr%&,
33347 &%acl_smtp_mime%& or
33348 &%acl_smtp_dkim%&
33349
33350 A timeout of 2 minutes is applied to a scanner call (by default);
33351 if it expires then a defer action is taken.
33352
33353 .oindex "&%av_scanner%&"
33354 You can set the &%av_scanner%& option in the main part of the configuration
33355 to specify which scanner to use, together with any additional options that
33356 are needed. The basic syntax is as follows:
33357 .display
33358 &`av_scanner = <`&&'scanner-type'&&`>:<`&&'option1'&&`>:<`&&'option2'&&`>:[...]`&
33359 .endd
33360 If you do not set &%av_scanner%&, it defaults to
33361 .code
33362 av_scanner = sophie:/var/run/sophie
33363 .endd
33364 If the value of &%av_scanner%& starts with a dollar character, it is expanded
33365 before use.
33366 The usual list-parsing of the content (see &<<SECTlistconstruct>>&) applies.
33367 The following scanner types are supported in this release,
33368 though individual ones can be included or not at build time:
33369
33370 .vlist
33371 .vitem &%avast%&
33372 .cindex "virus scanners" "avast"
33373 This is the scanner daemon of Avast. It has been tested with Avast Core
33374 Security (currently at version 2.2.0).
33375 You can get a trial version at &url(https://www.avast.com) or for Linux
33376 at &url(https://www.avast.com/linux-server-antivirus).
33377 This scanner type takes one option,
33378 which can be either a full path to a UNIX socket,
33379 or host and port specifiers separated by white space.
33380 The host may be a name or an IP address; the port is either a
33381 single number or a pair of numbers with a dash between.
33382 A list of options may follow. These options are interpreted on the
33383 Exim's side of the malware scanner, or are given on separate lines to
33384 the daemon as options before the main scan command.
33385
33386 .cindex &`pass_unscanned`& "avast"
33387 If &`pass_unscanned`&
33388 is set, any files the Avast scanner can't scan (e.g.
33389 decompression bombs, or invalid archives) are considered clean. Use with
33390 care.
33391
33392 For example:
33393 .code
33394 av_scanner = avast:/var/run/avast/scan.sock:FLAGS -fullfiles:SENSITIVITY -pup
33395 av_scanner = avast:/var/run/avast/scan.sock:pass_unscanned:FLAGS -fullfiles:SENSITIVITY -pup
33396 av_scanner = avast:192.168.2.22 5036
33397 .endd
33398 If you omit the argument, the default path
33399 &_/var/run/avast/scan.sock_&
33400 is used.
33401 If you use a remote host,
33402 you need to make Exim's spool directory available to it,
33403 as the scanner is passed a file path, not file contents.
33404 For information about available commands and their options you may use
33405 .code
33406 $ socat UNIX:/var/run/avast/scan.sock STDIO:
33407     FLAGS
33408     SENSITIVITY
33409     PACK
33410 .endd
33411
33412 If the scanner returns a temporary failure (e.g. license issues, or
33413 permission problems), the message is deferred and a paniclog entry is
33414 written.  The usual &`defer_ok`& option is available.
33415
33416 .vitem &%aveserver%&
33417 .cindex "virus scanners" "Kaspersky"
33418 This is the scanner daemon of Kaspersky Version 5. You can get a trial version
33419 at &url(https://www.kaspersky.com/). This scanner type takes one option,
33420 which is the path to the daemon's UNIX socket. The default is shown in this
33421 example:
33422 .code
33423 av_scanner = aveserver:/var/run/aveserver
33424 .endd
33425
33426
33427 .vitem &%clamd%&
33428 .cindex "virus scanners" "clamd"
33429 This daemon-type scanner is GPL and free. You can get it at
33430 &url(https://www.clamav.net/). Some older versions of clamd do not seem to
33431 unpack MIME containers, so it used to be recommended to unpack MIME attachments
33432 in the MIME ACL. This is no longer believed to be necessary.
33433
33434 The options are a list of server specifiers, which may be
33435 a UNIX socket specification,
33436 a TCP socket specification,
33437 or a (global) option.
33438
33439 A socket specification consists of a space-separated list.
33440 For a Unix socket the first element is a full path for the socket,
33441 for a TCP socket the first element is the IP address
33442 and the second a port number,
33443 Any further elements are per-server (non-global) options.
33444 These per-server options are supported:
33445 .code
33446 retry=<timespec>        Retry on connect fail
33447 .endd
33448
33449 The &`retry`& option specifies a time after which a single retry for
33450 a failed connect is made.  The default is to not retry.
33451
33452 If a Unix socket file is specified, only one server is supported.
33453
33454 Examples:
33455 .code
33456 av_scanner = clamd:/opt/clamd/socket
33457 av_scanner = clamd:192.0.2.3 1234
33458 av_scanner = clamd:192.0.2.3 1234:local
33459 av_scanner = clamd:192.0.2.3 1234 retry=10s
33460 av_scanner = clamd:192.0.2.3 1234 : 192.0.2.4 1234
33461 .endd
33462 If the value of av_scanner points to a UNIX socket file or contains the
33463 &`local`&
33464 option, then the ClamAV interface will pass a filename containing the data
33465 to be scanned, which should normally result in less I/O happening and be
33466 more efficient.  Normally in the TCP case, the data is streamed to ClamAV as
33467 Exim does not assume that there is a common filesystem with the remote host.
33468
33469 The final example shows that multiple TCP targets can be specified.  Exim will
33470 randomly use one for each incoming email (i.e. it load balances them).  Note
33471 that only TCP targets may be used if specifying a list of scanners; a UNIX
33472 socket cannot be mixed in with TCP targets.  If one of the servers becomes
33473 unavailable, Exim will try the remaining one(s) until it finds one that works.
33474 When a clamd server becomes unreachable, Exim will log a message.  Exim does
33475 not keep track of scanner state between multiple messages, and the scanner
33476 selection is random, so the message will get logged in the mainlog for each
33477 email that the down scanner gets chosen first (message wrapped to be readable):
33478 .code
33479 2013-10-09 14:30:39 1VTumd-0000Y8-BQ malware acl condition:
33480    clamd: connection to localhost, port 3310 failed
33481    (Connection refused)
33482 .endd
33483
33484 If the option is unset, the default is &_/tmp/clamd_&. Thanks to David Saez for
33485 contributing the code for this scanner.
33486
33487 .vitem &%cmdline%&
33488 .cindex "virus scanners" "command line interface"
33489 This is the keyword for the generic command line scanner interface. It can be
33490 used to attach virus scanners that are invoked from the shell. This scanner
33491 type takes 3 mandatory options:
33492
33493 .olist
33494 The full path and name of the scanner binary, with all command line options,
33495 and a placeholder (&`%s`&) for the directory to scan.
33496
33497 .next
33498 A regular expression to match against the STDOUT and STDERR output of the
33499 virus scanner. If the expression matches, a virus was found. You must make
33500 absolutely sure that this expression matches on &"virus found"&. This is called
33501 the &"trigger"& expression.
33502
33503 .next
33504 Another regular expression, containing exactly one pair of parentheses, to
33505 match the name of the virus found in the scanners output. This is called the
33506 &"name"& expression.
33507 .endlist olist
33508
33509 For example, Sophos Sweep reports a virus on a line like this:
33510 .code
33511 Virus 'W32/Magistr-B' found in file ./those.bat
33512 .endd
33513 For the trigger expression, we can match the phrase &"found in file"&. For the
33514 name expression, we want to extract the W32/Magistr-B string, so we can match
33515 for the single quotes left and right of it. Altogether, this makes the
33516 configuration setting:
33517 .code
33518 av_scanner = cmdline:\
33519              /path/to/sweep -ss -all -rec -archive %s:\
33520              found in file:'(.+)'
33521 .endd
33522 .vitem &%drweb%&
33523 .cindex "virus scanners" "DrWeb"
33524 The DrWeb daemon scanner (&url(https://www.sald.ru/)) interface
33525 takes one option,
33526 either a full path to a UNIX socket,
33527 or host and port specifiers separated by white space.
33528 The host may be a name or an IP address; the port is either a
33529 single number or a pair of numbers with a dash between.
33530 For example:
33531 .code
33532 av_scanner = drweb:/var/run/drwebd.sock
33533 av_scanner = drweb:192.168.2.20 31337
33534 .endd
33535 If you omit the argument, the default path &_/usr/local/drweb/run/drwebd.sock_&
33536 is used. Thanks to Alex Miller for contributing the code for this scanner.
33537
33538 .vitem &%f-protd%&
33539 .cindex "virus scanners" "f-protd"
33540 The f-protd scanner is accessed via HTTP over TCP.
33541 One argument is taken, being a space-separated hostname and port number
33542 (or port-range).
33543 For example:
33544 .code
33545 av_scanner = f-protd:localhost 10200-10204
33546 .endd
33547 If you omit the argument, the default values shown above are used.
33548
33549 .vitem &%f-prot6d%&
33550 .cindex "virus scanners" "f-prot6d"
33551 The f-prot6d scanner is accessed using the FPSCAND protocol over TCP.
33552 One argument is taken, being a space-separated hostname and port number.
33553 For example:
33554 .code
33555 av_scanner = f-prot6d:localhost 10200
33556 .endd
33557 If you omit the argument, the default values show above are used.
33558
33559 .vitem &%fsecure%&
33560 .cindex "virus scanners" "F-Secure"
33561 The F-Secure daemon scanner (&url(https://www.f-secure.com/)) takes one
33562 argument which is the path to a UNIX socket. For example:
33563 .code
33564 av_scanner = fsecure:/path/to/.fsav
33565 .endd
33566 If no argument is given, the default is &_/var/run/.fsav_&. Thanks to Johan
33567 Thelmen for contributing the code for this scanner.
33568
33569 .vitem &%kavdaemon%&
33570 .cindex "virus scanners" "Kaspersky"
33571 This is the scanner daemon of Kaspersky Version 4. This version of the
33572 Kaspersky scanner is outdated. Please upgrade (see &%aveserver%& above). This
33573 scanner type takes one option, which is the path to the daemon's UNIX socket.
33574 For example:
33575 .code
33576 av_scanner = kavdaemon:/opt/AVP/AvpCtl
33577 .endd
33578 The default path is &_/var/run/AvpCtl_&.
33579
33580 .vitem &%mksd%&
33581 .cindex "virus scanners" "mksd"
33582 This was a daemon type scanner that is aimed mainly at Polish users,
33583 though some documentation was available in English.
33584 The history can be shown at &url(https://en.wikipedia.org/wiki/Mks_vir)
33585 and this appears to be a candidate for removal from Exim, unless
33586 we are informed of other virus scanners which use the same protocol
33587 to integrate.
33588 The only option for this scanner type is
33589 the maximum number of processes used simultaneously to scan the attachments,
33590 provided that mksd has
33591 been run with at least the same number of child processes. For example:
33592 .code
33593 av_scanner = mksd:2
33594 .endd
33595 You can safely omit this option (the default value is 1).
33596
33597 .vitem &%sock%&
33598 .cindex "virus scanners" "simple socket-connected"
33599 This is a general-purpose way of talking to simple scanner daemons
33600 running on the local machine.
33601 There are four options:
33602 an address (which may be an IP address and port, or the path of a Unix socket),
33603 a commandline to send (may include a single %s which will be replaced with
33604 the path to the mail file to be scanned),
33605 an RE to trigger on from the returned data,
33606 and an RE to extract malware_name from the returned data.
33607 For example:
33608 .code
33609 av_scanner = sock:127.0.0.1 6001:%s:(SPAM|VIRUS):(.*)$
33610 .endd
33611 Note that surrounding whitespace is stripped from each option, meaning
33612 there is no way to specify a trailing newline.
33613 The socket specifier and both regular-expressions are required.
33614 Default for the commandline is &_%s\n_& (note this does have a trailing newline);
33615 specify an empty element to get this.
33616
33617 .vitem &%sophie%&
33618 .cindex "virus scanners" "Sophos and Sophie"
33619 Sophie is a daemon that uses Sophos' &%libsavi%& library to scan for viruses.
33620 You can get Sophie at &url(http://sophie.sourceforge.net/). The only option
33621 for this scanner type is the path to the UNIX socket that Sophie uses for
33622 client communication. For example:
33623 .code
33624 av_scanner = sophie:/tmp/sophie
33625 .endd
33626 The default path is &_/var/run/sophie_&, so if you are using this, you can omit
33627 the option.
33628 .endlist
33629
33630 When &%av_scanner%& is correctly set, you can use the &%malware%& condition in
33631 the DATA ACL. &*Note*&: You cannot use the &%malware%& condition in the MIME
33632 ACL.
33633
33634 The &%av_scanner%& option is expanded each time &%malware%& is called. This
33635 makes it possible to use different scanners. See further below for an example.
33636 The &%malware%& condition caches its results, so when you use it multiple times
33637 for the same message, the actual scanning process is only carried out once.
33638 However, using expandable items in &%av_scanner%& disables this caching, in
33639 which case each use of the &%malware%& condition causes a new scan of the
33640 message.
33641
33642 The &%malware%& condition takes a right-hand argument that is expanded before
33643 use and taken as a list, slash-separated by default.
33644 The first element can then be one of
33645
33646 .ilist
33647 &"true"&, &"*"&, or &"1"&, in which case the message is scanned for viruses.
33648 The condition succeeds if a virus was found, and fail otherwise. This is the
33649 recommended usage.
33650 .next
33651 &"false"& or &"0"& or an empty string, in which case no scanning is done and
33652 the condition fails immediately.
33653 .next
33654 A regular expression, in which case the message is scanned for viruses. The
33655 condition succeeds if a virus is found and its name matches the regular
33656 expression. This allows you to take special actions on certain types of virus.
33657 Note that &"/"& characters in the RE must be doubled due to the list-processing,
33658 unless the separator is changed (in the usual way &<<SECTlistsepchange>>&).
33659 .endlist
33660
33661 You can append a &`defer_ok`& element to the &%malware%& argument list to accept
33662 messages even if there is a problem with the virus scanner.
33663 Otherwise, such a problem causes the ACL to defer.
33664
33665 You can append a &`tmo=<val>`& element to the &%malware%& argument list to
33666 specify a non-default timeout.  The default is two minutes.
33667 For example:
33668 .code
33669 malware = * / defer_ok / tmo=10s
33670 .endd
33671 A timeout causes the ACL to defer.
33672
33673 .vindex "&$callout_address$&"
33674 When a connection is made to the scanner the expansion variable &$callout_address$&
33675 is set to record the actual address used.
33676
33677 .vindex "&$malware_name$&"
33678 When a virus is found, the condition sets up an expansion variable called
33679 &$malware_name$& that contains the name of the virus. You can use it in a
33680 &%message%& modifier that specifies the error returned to the sender, and/or in
33681 logging data.
33682
33683 Beware the interaction of Exim's &%message_size_limit%& with any size limits
33684 imposed by your anti-virus scanner.
33685
33686 Here is a very simple scanning example:
33687 .code
33688 deny malware = *
33689      message = This message contains malware ($malware_name)
33690 .endd
33691 The next example accepts messages when there is a problem with the scanner:
33692 .code
33693 deny malware = */defer_ok
33694      message = This message contains malware ($malware_name)
33695 .endd
33696 The next example shows how to use an ACL variable to scan with both sophie and
33697 aveserver. It assumes you have set:
33698 .code
33699 av_scanner = $acl_m0
33700 .endd
33701 in the main Exim configuration.
33702 .code
33703 deny set acl_m0 = sophie
33704      malware = *
33705      message = This message contains malware ($malware_name)
33706
33707 deny set acl_m0 = aveserver
33708      malware = *
33709      message = This message contains malware ($malware_name)
33710 .endd
33711
33712
33713 .section "Scanning with SpamAssassin and Rspamd" "SECTscanspamass"
33714 .cindex "content scanning" "for spam"
33715 .cindex "spam scanning"
33716 .cindex "SpamAssassin"
33717 .cindex "Rspamd"
33718 The &%spam%& ACL condition calls SpamAssassin's &%spamd%& daemon to get a spam
33719 score and a report for the message.
33720 Support is also provided for Rspamd.
33721
33722 For more information about installation and configuration of SpamAssassin or
33723 Rspamd refer to their respective websites at
33724 &url(https://spamassassin.apache.org/) and &url(https://www.rspamd.com/)
33725
33726 SpamAssassin can be installed with CPAN by running:
33727 .code
33728 perl -MCPAN -e 'install Mail::SpamAssassin'
33729 .endd
33730 SpamAssassin has its own set of configuration files. Please review its
33731 documentation to see how you can tweak it. The default installation should work
33732 nicely, however.
33733
33734 .oindex "&%spamd_address%&"
33735 By default, SpamAssassin listens on 127.0.0.1, TCP port 783 and if you
33736 intend to use an instance running on the local host you do not need to set
33737 &%spamd_address%&. If you intend to use another host or port for SpamAssassin,
33738 you must set the &%spamd_address%& option in the global part of the Exim
33739 configuration as follows (example):
33740 .code
33741 spamd_address = 192.168.99.45 783
33742 .endd
33743 The SpamAssassin protocol relies on a TCP half-close from the client.
33744 If your SpamAssassin client side is running a Linux system with an
33745 iptables firewall, consider setting
33746 &%net.netfilter.nf_conntrack_tcp_timeout_close_wait%& to at least the
33747 timeout, Exim uses when waiting for a response from the SpamAssassin
33748 server (currently defaulting to 120s).  With a lower value the Linux
33749 connection tracking may consider your half-closed connection as dead too
33750 soon.
33751
33752
33753 To use Rspamd (which by default listens on all local addresses
33754 on TCP port 11333)
33755 you should add &%variant=rspamd%& after the address/port pair, for example:
33756 .code
33757 spamd_address = 127.0.0.1 11333 variant=rspamd
33758 .endd
33759
33760 As of version 2.60, &%SpamAssassin%& also supports communication over UNIX
33761 sockets. If you want to us these, supply &%spamd_address%& with an absolute
33762 filename instead of an address/port pair:
33763 .code
33764 spamd_address = /var/run/spamd_socket
33765 .endd
33766 You can have multiple &%spamd%& servers to improve scalability. These can
33767 reside on other hardware reachable over the network. To specify multiple
33768 &%spamd%& servers, put multiple address/port pairs in the &%spamd_address%&
33769 option, separated with colons (the separator can be changed in the usual way &<<SECTlistsepchange>>&):
33770 .code
33771 spamd_address = 192.168.2.10 783 : \
33772                 192.168.2.11 783 : \
33773                 192.168.2.12 783
33774 .endd
33775 Up to 32 &%spamd%& servers are supported.
33776 When a server fails to respond to the connection attempt, all other
33777 servers are tried until one succeeds. If no server responds, the &%spam%&
33778 condition defers.
33779
33780 Unix and TCP socket specifications may be mixed in any order.
33781 Each element of the list is a list itself, space-separated by default
33782 and changeable in the usual way (&<<SECTlistsepchange>>&);
33783 take care to not double the separator.
33784
33785 For TCP socket specifications a host name or IP (v4 or v6, but
33786 subject to list-separator quoting rules) address can be used,
33787 and the port can be one or a dash-separated pair.
33788 In the latter case, the range is tried in strict order.
33789
33790 Elements after the first for Unix sockets, or second for TCP socket,
33791 are options.
33792 The supported options are:
33793 .code
33794 pri=<priority>      Selection priority
33795 weight=<value>      Selection bias
33796 time=<start>-<end>  Use only between these times of day
33797 retry=<timespec>    Retry on connect fail
33798 tmo=<timespec>      Connection time limit
33799 variant=rspamd      Use Rspamd rather than SpamAssassin protocol
33800 .endd
33801
33802 The &`pri`& option specifies a priority for the server within the list,
33803 higher values being tried first.
33804 The default priority is 1.
33805
33806 The &`weight`& option specifies a selection bias.
33807 Within a priority set
33808 servers are queried in a random fashion, weighted by this value.
33809 The default value for selection bias is 1.
33810
33811 Time specifications for the &`time`& option are <hour>.<minute>.<second>
33812 in the local time zone; each element being one or more digits.
33813 Either the seconds or both minutes and seconds, plus the leading &`.`&
33814 characters, may be omitted and will be taken as zero.
33815
33816 Timeout specifications for the &`retry`& and &`tmo`& options
33817 are the usual Exim time interval standard, e.g. &`20s`& or &`1m`&.
33818
33819 The &`tmo`& option specifies an overall timeout for communication.
33820 The default value is two minutes.
33821
33822 The &`retry`& option specifies a time after which a single retry for
33823 a failed connect is made.
33824 The default is to not retry.
33825
33826 The &%spamd_address%& variable is expanded before use if it starts with
33827 a dollar sign. In this case, the expansion may return a string that is
33828 used as the list so that multiple spamd servers can be the result of an
33829 expansion.
33830
33831 .vindex "&$callout_address$&"
33832 When a connection is made to the server the expansion variable &$callout_address$&
33833 is set to record the actual address used.
33834
33835 .section "Calling SpamAssassin from an Exim ACL" "SECID206"
33836 Here is a simple example of the use of the &%spam%& condition in a DATA ACL:
33837 .code
33838 deny spam = joe
33839      message = This message was classified as SPAM
33840 .endd
33841 The right-hand side of the &%spam%& condition specifies a name. This is
33842 relevant if you have set up multiple SpamAssassin profiles. If you do not want
33843 to scan using a specific profile, but rather use the SpamAssassin system-wide
33844 default profile, you can scan for an unknown name, or simply use &"nobody"&.
33845 Rspamd does not use this setting. However, you must put something on the
33846 right-hand side.
33847
33848 The name allows you to use per-domain or per-user antispam profiles in
33849 principle, but this is not straightforward in practice, because a message may
33850 have multiple recipients, not necessarily all in the same domain. Because the
33851 &%spam%& condition has to be called from a DATA-time ACL in order to be able to
33852 read the contents of the message, the variables &$local_part$& and &$domain$&
33853 are not set.
33854 Careful enforcement of single-recipient messages
33855 (e.g. by responding with defer in the recipient ACL for all recipients
33856 after the first),
33857 or the use of PRDR,
33858 .cindex "PRDR" "use for per-user SpamAssassin profiles"
33859 are needed to use this feature.
33860
33861 The right-hand side of the &%spam%& condition is expanded before being used, so
33862 you can put lookups or conditions there. When the right-hand side evaluates to
33863 &"0"& or &"false"&, no scanning is done and the condition fails immediately.
33864
33865
33866 Scanning with SpamAssassin uses a lot of resources. If you scan every message,
33867 large ones may cause significant performance degradation. As most spam messages
33868 are quite small, it is recommended that you do not scan the big ones. For
33869 example:
33870 .code
33871 deny condition = ${if < {$message_size}{10K}}
33872      spam = nobody
33873      message = This message was classified as SPAM
33874 .endd
33875
33876 The &%spam%& condition returns true if the threshold specified in the user's
33877 SpamAssassin profile has been matched or exceeded. If you want to use the
33878 &%spam%& condition for its side effects (see the variables below), you can make
33879 it always return &"true"& by appending &`:true`& to the username.
33880
33881 .cindex "spam scanning" "returned variables"
33882 When the &%spam%& condition is run, it sets up a number of expansion
33883 variables.
33884 Except for &$spam_report$&,
33885 these variables are saved with the received message so are
33886 available for use at delivery time.
33887
33888 .vlist
33889 .vitem &$spam_score$&
33890 The spam score of the message, for example, &"3.4"& or &"30.5"&. This is useful
33891 for inclusion in log or reject messages.
33892
33893 .vitem &$spam_score_int$&
33894 The spam score of the message, multiplied by ten, as an integer value. For
33895 example &"34"& or &"305"&. It may appear to disagree with &$spam_score$&
33896 because &$spam_score$& is rounded and &$spam_score_int$& is truncated.
33897 The integer value is useful for numeric comparisons in conditions.
33898
33899 .vitem &$spam_bar$&
33900 A string consisting of a number of &"+"& or &"-"& characters, representing the
33901 integer part of the spam score value. A spam score of 4.4 would have a
33902 &$spam_bar$& value of &"++++"&. This is useful for inclusion in warning
33903 headers, since MUAs can match on such strings. The maximum length of the
33904 spam bar is 50 characters.
33905
33906 .vitem &$spam_report$&
33907 A multiline text table, containing the full SpamAssassin report for the
33908 message. Useful for inclusion in headers or reject messages.
33909 This variable is only usable in a DATA-time ACL.
33910 Beware that SpamAssassin may return non-ASCII characters, especially
33911 when running in country-specific locales, which are not legal
33912 unencoded in headers.
33913
33914 .vitem &$spam_action$&
33915 For SpamAssassin either 'reject' or 'no action' depending on the
33916 spam score versus threshold.
33917 For Rspamd, the recommended action.
33918
33919 .endlist
33920
33921 The &%spam%& condition caches its results unless expansion in
33922 spamd_address was used. If you call it again with the same user name, it
33923 does not scan again, but rather returns the same values as before.
33924
33925 The &%spam%& condition returns DEFER if there is any error while running
33926 the message through SpamAssassin or if the expansion of spamd_address
33927 failed. If you want to treat DEFER as FAIL (to pass on to the next ACL
33928 statement block), append &`/defer_ok`& to the right-hand side of the
33929 spam condition, like this:
33930 .code
33931 deny spam    = joe/defer_ok
33932      message = This message was classified as SPAM
33933 .endd
33934 This causes messages to be accepted even if there is a problem with &%spamd%&.
33935
33936 Here is a longer, commented example of the use of the &%spam%&
33937 condition:
33938 .code
33939 # put headers in all messages (no matter if spam or not)
33940 warn  spam = nobody:true
33941       add_header = X-Spam-Score: $spam_score ($spam_bar)
33942       add_header = X-Spam-Report: $spam_report
33943
33944 # add second subject line with *SPAM* marker when message
33945 # is over threshold
33946 warn  spam = nobody
33947       add_header = Subject: *SPAM* $h_Subject:
33948
33949 # reject spam at high scores (> 12)
33950 deny  spam = nobody:true
33951       condition = ${if >{$spam_score_int}{120}{1}{0}}
33952       message = This message scored $spam_score spam points.
33953 .endd
33954
33955
33956
33957 .section "Scanning MIME parts" "SECTscanmimepart"
33958 .cindex "content scanning" "MIME parts"
33959 .cindex "MIME content scanning"
33960 .oindex "&%acl_smtp_mime%&"
33961 .oindex "&%acl_not_smtp_mime%&"
33962 The &%acl_smtp_mime%& global option specifies an ACL that is called once for
33963 each MIME part of an SMTP message, including multipart types, in the sequence
33964 of their position in the message. Similarly, the &%acl_not_smtp_mime%& option
33965 specifies an ACL that is used for the MIME parts of non-SMTP messages. These
33966 options may both refer to the same ACL if you want the same processing in both
33967 cases.
33968
33969 These ACLs are called (possibly many times) just before the &%acl_smtp_data%&
33970 ACL in the case of an SMTP message, or just before the &%acl_not_smtp%& ACL in
33971 the case of a non-SMTP message. However, a MIME ACL is called only if the
33972 message contains a &'Content-Type:'& header line. When a call to a MIME
33973 ACL does not yield &"accept"&, ACL processing is aborted and the appropriate
33974 result code is sent to the client. In the case of an SMTP message, the
33975 &%acl_smtp_data%& ACL is not called when this happens.
33976
33977 You cannot use the &%malware%& or &%spam%& conditions in a MIME ACL; these can
33978 only be used in the DATA or non-SMTP ACLs. However, you can use the &%regex%&
33979 condition to match against the raw MIME part. You can also use the
33980 &%mime_regex%& condition to match against the decoded MIME part (see section
33981 &<<SECTscanregex>>&).
33982
33983 At the start of a MIME ACL, a number of variables are set from the header
33984 information for the relevant MIME part. These are described below. The contents
33985 of the MIME part are not by default decoded into a disk file except for MIME
33986 parts whose content-type is &"message/rfc822"&. If you want to decode a MIME
33987 part into a disk file, you can use the &%decode%& condition. The general
33988 syntax is:
33989 .display
33990 &`decode = [/`&<&'path'&>&`/]`&<&'filename'&>
33991 .endd
33992 The right hand side is expanded before use. After expansion,
33993 the value can be:
33994
33995 .olist
33996 &"0"& or &"false"&, in which case no decoding is done.
33997 .next
33998 The string &"default"&. In that case, the file is put in the temporary
33999 &"default"& directory <&'spool_directory'&>&_/scan/_&<&'message_id'&>&_/_& with
34000 a sequential filename consisting of the message id and a sequence number. The
34001 full path and name is available in &$mime_decoded_filename$& after decoding.
34002 .next
34003 A full path name starting with a slash. If the full name is an existing
34004 directory, it is used as a replacement for the default directory. The filename
34005 is then sequentially assigned. If the path does not exist, it is used as
34006 the full path and filename.
34007 .next
34008 If the string does not start with a slash, it is used as the
34009 filename, and the default path is then used.
34010 .endlist
34011 The &%decode%& condition normally succeeds. It is only false for syntax
34012 errors or unusual circumstances such as memory shortages. You can easily decode
34013 a file with its original, proposed filename using
34014 .code
34015 decode = $mime_filename
34016 .endd
34017 However, you should keep in mind that &$mime_filename$& might contain
34018 anything. If you place files outside of the default path, they are not
34019 automatically unlinked.
34020
34021 For RFC822 attachments (these are messages attached to messages, with a
34022 content-type of &"message/rfc822"&), the ACL is called again in the same manner
34023 as for the primary message, only that the &$mime_is_rfc822$& expansion
34024 variable is set (see below). Attached messages are always decoded to disk
34025 before being checked, and the files are unlinked once the check is done.
34026
34027 The MIME ACL supports the &%regex%& and &%mime_regex%& conditions. These can be
34028 used to match regular expressions against raw and decoded MIME parts,
34029 respectively. They are described in section &<<SECTscanregex>>&.
34030
34031 .cindex "MIME content scanning" "returned variables"
34032 The following list describes all expansion variables that are
34033 available in the MIME ACL:
34034
34035 .vlist
34036 .vitem &$mime_anomaly_level$& &&&
34037        &$mime_anomaly_text$&
34038 .vindex &$mime_anomaly_level$&
34039 .vindex &$mime_anomaly_text$&
34040 If there are problems decoding, these variables contain information on
34041 the detected issue.
34042
34043 .vitem &$mime_boundary$&
34044 .vindex &$mime_boundary$&
34045 If the current part is a multipart (see &$mime_is_multipart$& below), it should
34046 have a boundary string, which is stored in this variable. If the current part
34047 has no boundary parameter in the &'Content-Type:'& header, this variable
34048 contains the empty string.
34049
34050 .vitem &$mime_charset$&
34051 .vindex &$mime_charset$&
34052 This variable contains the character set identifier, if one was found in the
34053 &'Content-Type:'& header. Examples for charset identifiers are:
34054 .code
34055 us-ascii
34056 gb2312 (Chinese)
34057 iso-8859-1
34058 .endd
34059 Please note that this value is not normalized, so you should do matches
34060 case-insensitively.
34061
34062 .vitem &$mime_content_description$&
34063 .vindex &$mime_content_description$&
34064 This variable contains the normalized content of the &'Content-Description:'&
34065 header. It can contain a human-readable description of the parts content. Some
34066 implementations repeat the filename for attachments here, but they are usually
34067 only used for display purposes.
34068
34069 .vitem &$mime_content_disposition$&
34070 .vindex &$mime_content_disposition$&
34071 This variable contains the normalized content of the &'Content-Disposition:'&
34072 header. You can expect strings like &"attachment"& or &"inline"& here.
34073
34074 .vitem &$mime_content_id$&
34075 .vindex &$mime_content_id$&
34076 This variable contains the normalized content of the &'Content-ID:'& header.
34077 This is a unique ID that can be used to reference a part from another part.
34078
34079 .vitem &$mime_content_size$&
34080 .vindex &$mime_content_size$&
34081 This variable is set only after the &%decode%& modifier (see above) has been
34082 successfully run. It contains the size of the decoded part in kilobytes. The
34083 size is always rounded up to full kilobytes, so only a completely empty part
34084 has a &$mime_content_size$& of zero.
34085
34086 .vitem &$mime_content_transfer_encoding$&
34087 .vindex &$mime_content_transfer_encoding$&
34088 This variable contains the normalized content of the
34089 &'Content-transfer-encoding:'& header. This is a symbolic name for an encoding
34090 type. Typical values are &"base64"& and &"quoted-printable"&.
34091
34092 .vitem &$mime_content_type$&
34093 .vindex &$mime_content_type$&
34094 If the MIME part has a &'Content-Type:'& header, this variable contains its
34095 value, lowercased, and without any options (like &"name"& or &"charset"&). Here
34096 are some examples of popular MIME types, as they may appear in this variable:
34097 .code
34098 text/plain
34099 text/html
34100 application/octet-stream
34101 image/jpeg
34102 audio/midi
34103 .endd
34104 If the MIME part has no &'Content-Type:'& header, this variable contains the
34105 empty string.
34106
34107 .vitem &$mime_decoded_filename$&
34108 .vindex &$mime_decoded_filename$&
34109 This variable is set only after the &%decode%& modifier (see above) has been
34110 successfully run. It contains the full path and filename of the file
34111 containing the decoded data.
34112 .endlist
34113
34114 .cindex "RFC 2047"
34115 .vlist
34116 .vitem &$mime_filename$&
34117 .vindex &$mime_filename$&
34118 This is perhaps the most important of the MIME variables. It contains a
34119 proposed filename for an attachment, if one was found in either the
34120 &'Content-Type:'& or &'Content-Disposition:'& headers. The filename will be
34121 RFC2047
34122 or RFC2231
34123 decoded, but no additional sanity checks are done.
34124  If no filename was
34125 found, this variable contains the empty string.
34126
34127 .vitem &$mime_is_coverletter$&
34128 .vindex &$mime_is_coverletter$&
34129 This variable attempts to differentiate the &"cover letter"& of an e-mail from
34130 attached data. It can be used to clamp down on flashy or unnecessarily encoded
34131 content in the cover letter, while not restricting attachments at all.
34132
34133 The variable contains 1 (true) for a MIME part believed to be part of the
34134 cover letter, and 0 (false) for an attachment. At present, the algorithm is as
34135 follows:
34136
34137 .olist
34138 The outermost MIME part of a message is always a cover letter.
34139
34140 .next
34141 If a multipart/alternative or multipart/related MIME part is a cover letter,
34142 so are all MIME subparts within that multipart.
34143
34144 .next
34145 If any other multipart is a cover letter, the first subpart is a cover letter,
34146 and the rest are attachments.
34147
34148 .next
34149 All parts contained within an attachment multipart are attachments.
34150 .endlist olist
34151
34152 As an example, the following will ban &"HTML mail"& (including that sent with
34153 alternative plain text), while allowing HTML files to be attached. HTML
34154 coverletter mail attached to non-HTML coverletter mail will also be allowed:
34155 .code
34156 deny !condition = $mime_is_rfc822
34157      condition = $mime_is_coverletter
34158      condition = ${if eq{$mime_content_type}{text/html}{1}{0}}
34159      message = HTML mail is not accepted here
34160 .endd
34161
34162 .vitem &$mime_is_multipart$&
34163 .vindex &$mime_is_multipart$&
34164 This variable has the value 1 (true) when the current part has the main type
34165 &"multipart"&, for example, &"multipart/alternative"& or &"multipart/mixed"&.
34166 Since multipart entities only serve as containers for other parts, you may not
34167 want to carry out specific actions on them.
34168
34169 .vitem &$mime_is_rfc822$&
34170 .vindex &$mime_is_rfc822$&
34171 This variable has the value 1 (true) if the current part is not a part of the
34172 checked message itself, but part of an attached message. Attached message
34173 decoding is fully recursive.
34174
34175 .vitem &$mime_part_count$&
34176 .vindex &$mime_part_count$&
34177 This variable is a counter that is raised for each processed MIME part. It
34178 starts at zero for the very first part (which is usually a multipart). The
34179 counter is per-message, so it is reset when processing RFC822 attachments (see
34180 &$mime_is_rfc822$&). The counter stays set after &%acl_smtp_mime%& is
34181 complete, so you can use it in the DATA ACL to determine the number of MIME
34182 parts of a message. For non-MIME messages, this variable contains the value -1.
34183 .endlist
34184
34185
34186
34187 .section "Scanning with regular expressions" "SECTscanregex"
34188 .cindex "content scanning" "with regular expressions"
34189 .cindex "regular expressions" "content scanning with"
34190 You can specify your own custom regular expression matches on the full body of
34191 the message, or on individual MIME parts.
34192
34193 The &%regex%& condition takes one or more regular expressions as arguments and
34194 matches them against the full message (when called in the DATA ACL) or a raw
34195 MIME part (when called in the MIME ACL). The &%regex%& condition matches
34196 linewise, with a maximum line length of 32K characters. That means you cannot
34197 have multiline matches with the &%regex%& condition.
34198
34199 The &%mime_regex%& condition can be called only in the MIME ACL. It matches up
34200 to 32K of decoded content (the whole content at once, not linewise). If the
34201 part has not been decoded with the &%decode%& modifier earlier in the ACL, it
34202 is decoded automatically when &%mime_regex%& is executed (using default path
34203 and filename values). If the decoded data is larger than  32K, only the first
34204 32K characters are checked.
34205
34206 The regular expressions are passed as a colon-separated list. To include a
34207 literal colon, you must double it. Since the whole right-hand side string is
34208 expanded before being used, you must also escape dollar signs and backslashes
34209 with more backslashes, or use the &`\N`& facility to disable expansion.
34210 Here is a simple example that contains two regular expressions:
34211 .code
34212 deny regex = [Mm]ortgage : URGENT BUSINESS PROPOSAL
34213      message = contains blacklisted regex ($regex_match_string)
34214 .endd
34215 The conditions returns true if any one of the regular expressions matches. The
34216 &$regex_match_string$& expansion variable is then set up and contains the
34217 matching regular expression.
34218 The expansion variables &$regex1$& &$regex2$& etc
34219 are set to any substrings captured by the regular expression.
34220
34221 &*Warning*&: With large messages, these conditions can be fairly
34222 CPU-intensive.
34223
34224 .ecindex IIDcosca
34225
34226
34227
34228
34229 . ////////////////////////////////////////////////////////////////////////////
34230 . ////////////////////////////////////////////////////////////////////////////
34231
34232 .chapter "Adding a local scan function to Exim" "CHAPlocalscan" &&&
34233          "Local scan function"
34234 .scindex IIDlosca "&[local_scan()]& function" "description of"
34235 .cindex "customizing" "input scan using C function"
34236 .cindex "policy control" "by local scan function"
34237 In these days of email worms, viruses, and ever-increasing spam, some sites
34238 want to apply a lot of checking to messages before accepting them.
34239
34240 The content scanning extension (chapter &<<CHAPexiscan>>&) has facilities for
34241 passing messages to external virus and spam scanning software. You can also do
34242 a certain amount in Exim itself through string expansions and the &%condition%&
34243 condition in the ACL that runs after the SMTP DATA command or the ACL for
34244 non-SMTP messages (see chapter &<<CHAPACL>>&), but this has its limitations.
34245
34246 To allow for further customization to a site's own requirements, there is the
34247 possibility of linking Exim with a private message scanning function, written
34248 in C. If you want to run code that is written in something other than C, you
34249 can of course use a little C stub to call it.
34250
34251 The local scan function is run once for every incoming message, at the point
34252 when Exim is just about to accept the message.
34253 It can therefore be used to control non-SMTP messages from local processes as
34254 well as messages arriving via SMTP.
34255
34256 Exim applies a timeout to calls of the local scan function, and there is an
34257 option called &%local_scan_timeout%& for setting it. The default is 5 minutes.
34258 Zero means &"no timeout"&.
34259 Exim also sets up signal handlers for SIGSEGV, SIGILL, SIGFPE, and SIGBUS
34260 before calling the local scan function, so that the most common types of crash
34261 are caught. If the timeout is exceeded or one of those signals is caught, the
34262 incoming message is rejected with a temporary error if it is an SMTP message.
34263 For a non-SMTP message, the message is dropped and Exim ends with a non-zero
34264 code. The incident is logged on the main and reject logs.
34265
34266
34267
34268 .section "Building Exim to use a local scan function" "SECID207"
34269 .cindex "&[local_scan()]& function" "building Exim to use"
34270 To make use of the local scan function feature, you must tell Exim where your
34271 function is before building Exim, by setting
34272 both HAVE_LOCAL_SCAN and
34273 LOCAL_SCAN_SOURCE in your
34274 &_Local/Makefile_&. A recommended place to put it is in the &_Local_&
34275 directory, so you might set
34276 .code
34277 HAVE_LOCAL_SCAN=yes
34278 LOCAL_SCAN_SOURCE=Local/local_scan.c
34279 .endd
34280 for example. The function must be called &[local_scan()]&;
34281 .new
34282 the source file(s) for it should first #define LOCAL_SCAN
34283 and then #include "local_scan.h".
34284 .wen
34285 It is called by
34286 Exim after it has received a message, when the success return code is about to
34287 be sent. This is after all the ACLs have been run. The return code from your
34288 function controls whether the message is actually accepted or not. There is a
34289 commented template function (that just accepts the message) in the file
34290 _src/local_scan.c_.
34291
34292 If you want to make use of Exim's runtime configuration file to set options
34293 for your &[local_scan()]& function, you must also set
34294 .code
34295 LOCAL_SCAN_HAS_OPTIONS=yes
34296 .endd
34297 in &_Local/Makefile_& (see section &<<SECTconoptloc>>& below).
34298
34299
34300
34301
34302 .section "API for local_scan()" "SECTapiforloc"
34303 .cindex "&[local_scan()]& function" "API description"
34304 .cindex &%dlfunc%& "API description"
34305 You must include this line near the start of your code:
34306 .code
34307 #define LOCAL_SCAN
34308 #include "local_scan.h"
34309 .endd
34310 This header file defines a number of variables and other values, and the
34311 prototype for the function itself. Exim is coded to use unsigned char values
34312 almost exclusively, and one of the things this header defines is a shorthand
34313 for &`unsigned char`& called &`uschar`&.
34314 It also makes available the following macro definitions, to simplify casting character
34315 strings and pointers to character strings:
34316 .code
34317 #define CS   (char *)
34318 #define CCS  (const char *)
34319 #define CSS  (char **)
34320 #define US   (unsigned char *)
34321 #define CUS  (const unsigned char *)
34322 #define USS  (unsigned char **)
34323 .endd
34324 The function prototype for &[local_scan()]& is:
34325 .code
34326 extern int local_scan(int fd, uschar **return_text);
34327 .endd
34328 The arguments are as follows:
34329
34330 .ilist
34331 &%fd%& is a file descriptor for the file that contains the body of the message
34332 (the -D file). The file is open for reading and writing, but updating it is not
34333 recommended. &*Warning*&: You must &'not'& close this file descriptor.
34334
34335 The descriptor is positioned at character 19 of the file, which is the first
34336 character of the body itself, because the first 19 characters are the message
34337 id followed by &`-D`& and a newline. If you rewind the file, you should use the
34338 macro SPOOL_DATA_START_OFFSET to reset to the start of the data, just in
34339 case this changes in some future version.
34340 .next
34341 &%return_text%& is an address which you can use to return a pointer to a text
34342 string at the end of the function. The value it points to on entry is NULL.
34343 .endlist
34344
34345 The function must return an &%int%& value which is one of the following macros:
34346
34347 .vlist
34348 .vitem &`LOCAL_SCAN_ACCEPT`&
34349 .vindex "&$local_scan_data$&"
34350 The message is accepted. If you pass back a string of text, it is saved with
34351 the message, and made available in the variable &$local_scan_data$&. No
34352 newlines are permitted (if there are any, they are turned into spaces) and the
34353 maximum length of text is 1000 characters.
34354
34355 .vitem &`LOCAL_SCAN_ACCEPT_FREEZE`&
34356 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
34357 queued without immediate delivery, and is frozen.
34358
34359 .vitem &`LOCAL_SCAN_ACCEPT_QUEUE`&
34360 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
34361 queued without immediate delivery.
34362
34363 .vitem &`LOCAL_SCAN_REJECT`&
34364 The message is rejected; the returned text is used as an error message which is
34365 passed back to the sender and which is also logged. Newlines are permitted &--
34366 they cause a multiline response for SMTP rejections, but are converted to
34367 &`\n`& in log lines. If no message is given, &"Administrative prohibition"& is
34368 used.
34369
34370 .vitem &`LOCAL_SCAN_TEMPREJECT`&
34371 The message is temporarily rejected; the returned text is used as an error
34372 message as for LOCAL_SCAN_REJECT. If no message is given, &"Temporary local
34373 problem"& is used.
34374
34375 .vitem &`LOCAL_SCAN_REJECT_NOLOGHDR`&
34376 This behaves as LOCAL_SCAN_REJECT, except that the header of the rejected
34377 message is not written to the reject log. It has the effect of unsetting the
34378 &%rejected_header%& log selector for just this rejection. If
34379 &%rejected_header%& is already unset (see the discussion of the
34380 &%log_selection%& option in section &<<SECTlogselector>>&), this code is the
34381 same as LOCAL_SCAN_REJECT.
34382
34383 .vitem &`LOCAL_SCAN_TEMPREJECT_NOLOGHDR`&
34384 This code is a variation of LOCAL_SCAN_TEMPREJECT in the same way that
34385 LOCAL_SCAN_REJECT_NOLOGHDR is a variation of LOCAL_SCAN_REJECT.
34386 .endlist
34387
34388 If the message is not being received by interactive SMTP, rejections are
34389 reported by writing to &%stderr%& or by sending an email, as configured by the
34390 &%-oe%& command line options.
34391
34392
34393
34394 .section "Configuration options for local_scan()" "SECTconoptloc"
34395 .cindex "&[local_scan()]& function" "configuration options"
34396 It is possible to have option settings in the main configuration file
34397 that set values in static variables in the &[local_scan()]& module. If you
34398 want to do this, you must have the line
34399 .code
34400 LOCAL_SCAN_HAS_OPTIONS=yes
34401 .endd
34402 in your &_Local/Makefile_& when you build Exim. (This line is in
34403 &_OS/Makefile-Default_&, commented out). Then, in the &[local_scan()]& source
34404 file, you must define static variables to hold the option values, and a table
34405 to define them.
34406
34407 The table must be a vector called &%local_scan_options%&, of type
34408 &`optionlist`&. Each entry is a triplet, consisting of a name, an option type,
34409 and a pointer to the variable that holds the value. The entries must appear in
34410 alphabetical order. Following &%local_scan_options%& you must also define a
34411 variable called &%local_scan_options_count%& that contains the number of
34412 entries in the table. Here is a short example, showing two kinds of option:
34413 .code
34414 static int my_integer_option = 42;
34415 static uschar *my_string_option = US"a default string";
34416
34417 optionlist local_scan_options[] = {
34418   { "my_integer", opt_int,       &my_integer_option },
34419   { "my_string",  opt_stringptr, &my_string_option }
34420 };
34421
34422 int local_scan_options_count =
34423   sizeof(local_scan_options)/sizeof(optionlist);
34424 .endd
34425 The values of the variables can now be changed from Exim's runtime
34426 configuration file by including a local scan section as in this example:
34427 .code
34428 begin local_scan
34429 my_integer = 99
34430 my_string = some string of text...
34431 .endd
34432 The available types of option data are as follows:
34433
34434 .vlist
34435 .vitem &*opt_bool*&
34436 This specifies a boolean (true/false) option. The address should point to a
34437 variable of type &`BOOL`&, which will be set to TRUE or FALSE, which are macros
34438 that are defined as &"1"& and &"0"&, respectively. If you want to detect
34439 whether such a variable has been set at all, you can initialize it to
34440 TRUE_UNSET. (BOOL variables are integers underneath, so can hold more than two
34441 values.)
34442
34443 .vitem &*opt_fixed*&
34444 This specifies a fixed point number, such as is used for load averages.
34445 The address should point to a variable of type &`int`&. The value is stored
34446 multiplied by 1000, so, for example, 1.4142 is truncated and stored as 1414.
34447
34448 .vitem &*opt_int*&
34449 This specifies an integer; the address should point to a variable of type
34450 &`int`&. The value may be specified in any of the integer formats accepted by
34451 Exim.
34452
34453 .vitem &*opt_mkint*&
34454 This is the same as &%opt_int%&, except that when such a value is output in a
34455 &%-bP%& listing, if it is an exact number of kilobytes or megabytes, it is
34456 printed with the suffix K or M.
34457
34458 .vitem &*opt_octint*&
34459 This also specifies an integer, but the value is always interpreted as an
34460 octal integer, whether or not it starts with the digit zero, and it is
34461 always output in octal.
34462
34463 .vitem &*opt_stringptr*&
34464 This specifies a string value; the address must be a pointer to a
34465 variable that points to a string (for example, of type &`uschar *`&).
34466
34467 .vitem &*opt_time*&
34468 This specifies a time interval value. The address must point to a variable of
34469 type &`int`&. The value that is placed there is a number of seconds.
34470 .endlist
34471
34472 If the &%-bP%& command line option is followed by &`local_scan`&, Exim prints
34473 out the values of all the &[local_scan()]& options.
34474
34475
34476
34477 .section "Available Exim variables" "SECID208"
34478 .cindex "&[local_scan()]& function" "available Exim variables"
34479 The header &_local_scan.h_& gives you access to a number of C variables. These
34480 are the only ones that are guaranteed to be maintained from release to release.
34481 Note, however, that you can obtain the value of any Exim expansion variable,
34482 including &$recipients$&, by calling &'expand_string()'&. The exported
34483 C variables are as follows:
34484
34485 .vlist
34486 .vitem &*int&~body_linecount*&
34487 This variable contains the number of lines in the message's body.
34488 It is not valid if the &%spool_files_wireformat%& option is used.
34489
34490 .vitem &*int&~body_zerocount*&
34491 This variable contains the number of binary zero bytes in the message's body.
34492 It is not valid if the &%spool_files_wireformat%& option is used.
34493
34494 .vitem &*unsigned&~int&~debug_selector*&
34495 This variable is set to zero when no debugging is taking place. Otherwise, it
34496 is a bitmap of debugging selectors. Two bits are identified for use in
34497 &[local_scan()]&; they are defined as macros:
34498
34499 .ilist
34500 The &`D_v`& bit is set when &%-v%& was present on the command line. This is a
34501 testing option that is not privileged &-- any caller may set it. All the
34502 other selector bits can be set only by admin users.
34503
34504 .next
34505 The &`D_local_scan`& bit is provided for use by &[local_scan()]&; it is set
34506 by the &`+local_scan`& debug selector. It is not included in the default set
34507 of debugging bits.
34508 .endlist ilist
34509
34510 Thus, to write to the debugging output only when &`+local_scan`& has been
34511 selected, you should use code like this:
34512 .code
34513 if ((debug_selector & D_local_scan) != 0)
34514   debug_printf("xxx", ...);
34515 .endd
34516 .vitem &*uschar&~*expand_string_message*&
34517 After a failing call to &'expand_string()'& (returned value NULL), the
34518 variable &%expand_string_message%& contains the error message, zero-terminated.
34519
34520 .vitem &*header_line&~*header_list*&
34521 A pointer to a chain of header lines. The &%header_line%& structure is
34522 discussed below.
34523
34524 .vitem &*header_line&~*header_last*&
34525 A pointer to the last of the header lines.
34526
34527 .vitem &*uschar&~*headers_charset*&
34528 The value of the &%headers_charset%& configuration option.
34529
34530 .vitem &*BOOL&~host_checking*&
34531 This variable is TRUE during a host checking session that is initiated by the
34532 &%-bh%& command line option.
34533
34534 .vitem &*uschar&~*interface_address*&
34535 The IP address of the interface that received the message, as a string. This
34536 is NULL for locally submitted messages.
34537
34538 .vitem &*int&~interface_port*&
34539 The port on which this message was received. When testing with the &%-bh%&
34540 command line option, the value of this variable is -1 unless a port has been
34541 specified via the &%-oMi%& option.
34542
34543 .vitem &*uschar&~*message_id*&
34544 This variable contains Exim's message id for the incoming message (the value of
34545 &$message_exim_id$&) as a zero-terminated string.
34546
34547 .vitem &*uschar&~*received_protocol*&
34548 The name of the protocol by which the message was received.
34549
34550 .vitem &*int&~recipients_count*&
34551 The number of accepted recipients.
34552
34553 .vitem &*recipient_item&~*recipients_list*&
34554 .cindex "recipient" "adding in local scan"
34555 .cindex "recipient" "removing in local scan"
34556 The list of accepted recipients, held in a vector of length
34557 &%recipients_count%&. The &%recipient_item%& structure is discussed below. You
34558 can add additional recipients by calling &'receive_add_recipient()'& (see
34559 below). You can delete recipients by removing them from the vector and
34560 adjusting the value in &%recipients_count%&. In particular, by setting
34561 &%recipients_count%& to zero you remove all recipients. If you then return the
34562 value &`LOCAL_SCAN_ACCEPT`&, the message is accepted, but immediately
34563 blackholed. To replace the recipients, you can set &%recipients_count%& to zero
34564 and then call &'receive_add_recipient()'& as often as needed.
34565
34566 .vitem &*uschar&~*sender_address*&
34567 The envelope sender address. For bounce messages this is the empty string.
34568
34569 .vitem &*uschar&~*sender_host_address*&
34570 The IP address of the sending host, as a string. This is NULL for
34571 locally-submitted messages.
34572
34573 .vitem &*uschar&~*sender_host_authenticated*&
34574 The name of the authentication mechanism that was used, or NULL if the message
34575 was not received over an authenticated SMTP connection.
34576
34577 .vitem &*uschar&~*sender_host_name*&
34578 The name of the sending host, if known.
34579
34580 .vitem &*int&~sender_host_port*&
34581 The port on the sending host.
34582
34583 .vitem &*BOOL&~smtp_input*&
34584 This variable is TRUE for all SMTP input, including BSMTP.
34585
34586 .vitem &*BOOL&~smtp_batched_input*&
34587 This variable is TRUE for BSMTP input.
34588
34589 .vitem &*int&~store_pool*&
34590 The contents of this variable control which pool of memory is used for new
34591 requests. See section &<<SECTmemhanloc>>& for details.
34592 .endlist
34593
34594
34595 .section "Structure of header lines" "SECID209"
34596 The &%header_line%& structure contains the members listed below.
34597 You can add additional header lines by calling the &'header_add()'& function
34598 (see below). You can cause header lines to be ignored (deleted) by setting
34599 their type to *.
34600
34601
34602 .vlist
34603 .vitem &*struct&~header_line&~*next*&
34604 A pointer to the next header line, or NULL for the last line.
34605
34606 .vitem &*int&~type*&
34607 A code identifying certain headers that Exim recognizes. The codes are printing
34608 characters, and are documented in chapter &<<CHAPspool>>& of this manual.
34609 Notice in particular that any header line whose type is * is not transmitted
34610 with the message. This flagging is used for header lines that have been
34611 rewritten, or are to be removed (for example, &'Envelope-sender:'& header
34612 lines.) Effectively, * means &"deleted"&.
34613
34614 .vitem &*int&~slen*&
34615 The number of characters in the header line, including the terminating and any
34616 internal newlines.
34617
34618 .vitem &*uschar&~*text*&
34619 A pointer to the text of the header. It always ends with a newline, followed by
34620 a zero byte. Internal newlines are preserved.
34621 .endlist
34622
34623
34624
34625 .section "Structure of recipient items" "SECID210"
34626 The &%recipient_item%& structure contains these members:
34627
34628 .vlist
34629 .vitem &*uschar&~*address*&
34630 This is a pointer to the recipient address as it was received.
34631
34632 .vitem &*int&~pno*&
34633 This is used in later Exim processing when top level addresses are created by
34634 the &%one_time%& option. It is not relevant at the time &[local_scan()]& is run
34635 and must always contain -1 at this stage.
34636
34637 .vitem &*uschar&~*errors_to*&
34638 If this value is not NULL, bounce messages caused by failing to deliver to the
34639 recipient are sent to the address it contains. In other words, it overrides the
34640 envelope sender for this one recipient. (Compare the &%errors_to%& generic
34641 router option.) If a &[local_scan()]& function sets an &%errors_to%& field to
34642 an unqualified address, Exim qualifies it using the domain from
34643 &%qualify_recipient%&. When &[local_scan()]& is called, the &%errors_to%& field
34644 is NULL for all recipients.
34645 .endlist
34646
34647
34648
34649 .section "Available Exim functions" "SECID211"
34650 .cindex "&[local_scan()]& function" "available Exim functions"
34651 The header &_local_scan.h_& gives you access to a number of Exim functions.
34652 These are the only ones that are guaranteed to be maintained from release to
34653 release:
34654
34655 .vlist
34656 .vitem "&*pid_t&~child_open(uschar&~**argv,&~uschar&~**envp,&~int&~newumask,&&&
34657        &~int&~*infdptr,&~int&~*outfdptr, &~&~BOOL&~make_leader)*&"
34658
34659 This function creates a child process that runs the command specified by
34660 &%argv%&. The environment for the process is specified by &%envp%&, which can
34661 be NULL if no environment variables are to be passed. A new umask is supplied
34662 for the process in &%newumask%&.
34663
34664 Pipes to the standard input and output of the new process are set up
34665 and returned to the caller via the &%infdptr%& and &%outfdptr%& arguments. The
34666 standard error is cloned to the standard output. If there are any file
34667 descriptors &"in the way"& in the new process, they are closed. If the final
34668 argument is TRUE, the new process is made into a process group leader.
34669
34670 The function returns the pid of the new process, or -1 if things go wrong.
34671
34672 .vitem &*int&~child_close(pid_t&~pid,&~int&~timeout)*&
34673 This function waits for a child process to terminate, or for a timeout (in
34674 seconds) to expire. A timeout value of zero means wait as long as it takes. The
34675 return value is as follows:
34676
34677 .ilist
34678 >= 0
34679
34680 The process terminated by a normal exit and the value is the process
34681 ending status.
34682
34683 .next
34684 < 0 and > &--256
34685
34686 The process was terminated by a signal and the value is the negation of the
34687 signal number.
34688
34689 .next
34690 &--256
34691
34692 The process timed out.
34693 .next
34694 &--257
34695
34696 The was some other error in wait(); &%errno%& is still set.
34697 .endlist
34698
34699 .vitem &*pid_t&~child_open_exim(int&~*fd)*&
34700 This function provide you with a means of submitting a new message to
34701 Exim. (Of course, you can also call &_/usr/sbin/sendmail_& yourself if you
34702 want, but this packages it all up for you.) The function creates a pipe,
34703 forks a subprocess that is running
34704 .code
34705 exim -t -oem -oi -f <>
34706 .endd
34707 and returns to you (via the &`int *`& argument) a file descriptor for the pipe
34708 that is connected to the standard input. The yield of the function is the PID
34709 of the subprocess. You can then write a message to the file descriptor, with
34710 recipients in &'To:'&, &'Cc:'&, and/or &'Bcc:'& header lines.
34711
34712 When you have finished, call &'child_close()'& to wait for the process to
34713 finish and to collect its ending status. A timeout value of zero is usually
34714 fine in this circumstance. Unless you have made a mistake with the recipient
34715 addresses, you should get a return code of zero.
34716
34717
34718 .vitem &*pid_t&~child_open_exim2(int&~*fd,&~uschar&~*sender,&~uschar&~&&&
34719        *sender_authentication)*&
34720 This function is a more sophisticated version of &'child_open()'&. The command
34721 that it runs is:
34722 .display
34723 &`exim -t -oem -oi -f `&&'sender'&&` -oMas `&&'sender_authentication'&
34724 .endd
34725 The third argument may be NULL, in which case the &%-oMas%& option is omitted.
34726
34727
34728 .vitem &*void&~debug_printf(char&~*,&~...)*&
34729 This is Exim's debugging function, with arguments as for &'(printf()'&. The
34730 output is written to the standard error stream. If no debugging is selected,
34731 calls to &'debug_printf()'& have no effect. Normally, you should make calls
34732 conditional on the &`local_scan`& debug selector by coding like this:
34733 .code
34734 if ((debug_selector & D_local_scan) != 0)
34735   debug_printf("xxx", ...);
34736 .endd
34737
34738 .vitem &*uschar&~*expand_string(uschar&~*string)*&
34739 This is an interface to Exim's string expansion code. The return value is the
34740 expanded string, or NULL if there was an expansion failure.
34741 The C variable &%expand_string_message%& contains an error message after an
34742 expansion failure. If expansion does not change the string, the return value is
34743 the pointer to the input string. Otherwise, the return value points to a new
34744 block of memory that was obtained by a call to &'store_get()'&. See section
34745 &<<SECTmemhanloc>>& below for a discussion of memory handling.
34746
34747 .vitem &*void&~header_add(int&~type,&~char&~*format,&~...)*&
34748 This function allows you to an add additional header line at the end of the
34749 existing ones. The first argument is the type, and should normally be a space
34750 character. The second argument is a format string and any number of
34751 substitution arguments as for &[sprintf()]&. You may include internal newlines
34752 if you want, and you must ensure that the string ends with a newline.
34753
34754 .vitem "&*void&~header_add_at_position(BOOL&~after,&~uschar&~*name,&~&&&
34755         BOOL&~topnot,&~int&~type,&~char&~*format, &~&~...)*&"
34756 This function adds a new header line at a specified point in the header
34757 chain. The header itself is specified as for &'header_add()'&.
34758
34759 If &%name%& is NULL, the new header is added at the end of the chain if
34760 &%after%& is true, or at the start if &%after%& is false. If &%name%& is not
34761 NULL, the header lines are searched for the first non-deleted header that
34762 matches the name. If one is found, the new header is added before it if
34763 &%after%& is false. If &%after%& is true, the new header is added after the
34764 found header and any adjacent subsequent ones with the same name (even if
34765 marked &"deleted"&). If no matching non-deleted header is found, the &%topnot%&
34766 option controls where the header is added. If it is true, addition is at the
34767 top; otherwise at the bottom. Thus, to add a header after all the &'Received:'&
34768 headers, or at the top if there are no &'Received:'& headers, you could use
34769 .code
34770 header_add_at_position(TRUE, US"Received", TRUE,
34771   ' ', "X-xxx: ...");
34772 .endd
34773 Normally, there is always at least one non-deleted &'Received:'& header, but
34774 there may not be if &%received_header_text%& expands to an empty string.
34775
34776
34777 .vitem &*void&~header_remove(int&~occurrence,&~uschar&~*name)*&
34778 This function removes header lines. If &%occurrence%& is zero or negative, all
34779 occurrences of the header are removed. If occurrence is greater than zero, that
34780 particular instance of the header is removed. If no header(s) can be found that
34781 match the specification, the function does nothing.
34782
34783
34784 .vitem "&*BOOL&~header_testname(header_line&~*hdr,&~uschar&~*name,&~&&&
34785         int&~length,&~BOOL&~notdel)*&"
34786 This function tests whether the given header has the given name. It is not just
34787 a string comparison, because white space is permitted between the name and the
34788 colon. If the &%notdel%& argument is true, a false return is forced for all
34789 &"deleted"& headers; otherwise they are not treated specially. For example:
34790 .code
34791 if (header_testname(h, US"X-Spam", 6, TRUE)) ...
34792 .endd
34793 .vitem &*uschar&~*lss_b64encode(uschar&~*cleartext,&~int&~length)*&
34794 .cindex "base64 encoding" "functions for &[local_scan()]& use"
34795 This function base64-encodes a string, which is passed by address and length.
34796 The text may contain bytes of any value, including zero. The result is passed
34797 back in dynamic memory that is obtained by calling &'store_get()'&. It is
34798 zero-terminated.
34799
34800 .vitem &*int&~lss_b64decode(uschar&~*codetext,&~uschar&~**cleartext)*&
34801 This function decodes a base64-encoded string. Its arguments are a
34802 zero-terminated base64-encoded string and the address of a variable that is set
34803 to point to the result, which is in dynamic memory. The length of the decoded
34804 string is the yield of the function. If the input is invalid base64 data, the
34805 yield is -1. A zero byte is added to the end of the output string to make it
34806 easy to interpret as a C string (assuming it contains no zeros of its own). The
34807 added zero byte is not included in the returned count.
34808
34809 .vitem &*int&~lss_match_domain(uschar&~*domain,&~uschar&~*list)*&
34810 This function checks for a match in a domain list. Domains are always
34811 matched caselessly. The return value is one of the following:
34812 .display
34813 &`OK     `& match succeeded
34814 &`FAIL   `& match failed
34815 &`DEFER  `& match deferred
34816 .endd
34817 DEFER is usually caused by some kind of lookup defer, such as the
34818 inability to contact a database.
34819
34820 .vitem "&*int&~lss_match_local_part(uschar&~*localpart,&~uschar&~*list,&~&&&
34821         BOOL&~caseless)*&"
34822 This function checks for a match in a local part list. The third argument
34823 controls case-sensitivity. The return values are as for
34824 &'lss_match_domain()'&.
34825
34826 .vitem "&*int&~lss_match_address(uschar&~*address,&~uschar&~*list,&~&&&
34827         BOOL&~caseless)*&"
34828 This function checks for a match in an address list. The third argument
34829 controls the case-sensitivity of the local part match. The domain is always
34830 matched caselessly. The return values are as for &'lss_match_domain()'&.
34831
34832 .vitem "&*int&~lss_match_host(uschar&~*host_name,&~uschar&~*host_address,&~&&&
34833         uschar&~*list)*&"
34834 This function checks for a match in a host list. The most common usage is
34835 expected to be
34836 .code
34837 lss_match_host(sender_host_name, sender_host_address, ...)
34838 .endd
34839 .vindex "&$sender_host_address$&"
34840 An empty address field matches an empty item in the host list. If the host name
34841 is NULL, the name corresponding to &$sender_host_address$& is automatically
34842 looked up if a host name is required to match an item in the list. The return
34843 values are as for &'lss_match_domain()'&, but in addition, &'lss_match_host()'&
34844 returns ERROR in the case when it had to look up a host name, but the lookup
34845 failed.
34846
34847 .vitem "&*void&~log_write(unsigned&~int&~selector,&~int&~which,&~char&~&&&
34848         *format,&~...)*&"
34849 This function writes to Exim's log files. The first argument should be zero (it
34850 is concerned with &%log_selector%&). The second argument can be &`LOG_MAIN`& or
34851 &`LOG_REJECT`& or &`LOG_PANIC`& or the inclusive &"or"& of any combination of
34852 them. It specifies to which log or logs the message is written. The remaining
34853 arguments are a format and relevant insertion arguments. The string should not
34854 contain any newlines, not even at the end.
34855
34856
34857 .vitem &*void&~receive_add_recipient(uschar&~*address,&~int&~pno)*&
34858 This function adds an additional recipient to the message. The first argument
34859 is the recipient address. If it is unqualified (has no domain), it is qualified
34860 with the &%qualify_recipient%& domain. The second argument must always be -1.
34861
34862 This function does not allow you to specify a private &%errors_to%& address (as
34863 described with the structure of &%recipient_item%& above), because it pre-dates
34864 the addition of that field to the structure. However, it is easy to add such a
34865 value afterwards. For example:
34866 .code
34867  receive_add_recipient(US"monitor@mydom.example", -1);
34868  recipients_list[recipients_count-1].errors_to =
34869    US"postmaster@mydom.example";
34870 .endd
34871
34872 .vitem &*BOOL&~receive_remove_recipient(uschar&~*recipient)*&
34873 This is a convenience function to remove a named recipient from the list of
34874 recipients. It returns true if a recipient was removed, and false if no
34875 matching recipient could be found. The argument must be a complete email
34876 address.
34877 .endlist
34878
34879
34880 .cindex "RFC 2047"
34881 .vlist
34882 .vitem "&*uschar&~rfc2047_decode(uschar&~*string,&~BOOL&~lencheck,&&&
34883   &~uschar&~*target,&~int&~zeroval,&~int&~*lenptr, &~&~uschar&~**error)*&"
34884 This function decodes strings that are encoded according to RFC 2047. Typically
34885 these are the contents of header lines. First, each &"encoded word"& is decoded
34886 from the Q or B encoding into a byte-string. Then, if provided with the name of
34887 a charset encoding, and if the &[iconv()]& function is available, an attempt is
34888 made  to translate the result to the named character set. If this fails, the
34889 binary string is returned with an error message.
34890
34891 The first argument is the string to be decoded. If &%lencheck%& is TRUE, the
34892 maximum MIME word length is enforced. The third argument is the target
34893 encoding, or NULL if no translation is wanted.
34894
34895 .cindex "binary zero" "in RFC 2047 decoding"
34896 .cindex "RFC 2047" "binary zero in"
34897 If a binary zero is encountered in the decoded string, it is replaced by the
34898 contents of the &%zeroval%& argument. For use with Exim headers, the value must
34899 not be 0 because header lines are handled as zero-terminated strings.
34900
34901 The function returns the result of processing the string, zero-terminated; if
34902 &%lenptr%& is not NULL, the length of the result is set in the variable to
34903 which it points. When &%zeroval%& is 0, &%lenptr%& should not be NULL.
34904
34905 If an error is encountered, the function returns NULL and uses the &%error%&
34906 argument to return an error message. The variable pointed to by &%error%& is
34907 set to NULL if there is no error; it may be set non-NULL even when the function
34908 returns a non-NULL value if decoding was successful, but there was a problem
34909 with translation.
34910
34911
34912 .vitem &*int&~smtp_fflush(void)*&
34913 This function is used in conjunction with &'smtp_printf()'&, as described
34914 below.
34915
34916 .vitem &*void&~smtp_printf(char&~*,BOOL,&~...)*&
34917 The arguments of this function are almost like &[printf()]&; it writes to the SMTP
34918 output stream. You should use this function only when there is an SMTP output
34919 stream, that is, when the incoming message is being received via interactive
34920 SMTP. This is the case when &%smtp_input%& is TRUE and &%smtp_batched_input%&
34921 is FALSE. If you want to test for an incoming message from another host (as
34922 opposed to a local process that used the &%-bs%& command line option), you can
34923 test the value of &%sender_host_address%&, which is non-NULL when a remote host
34924 is involved.
34925
34926 If an SMTP TLS connection is established, &'smtp_printf()'& uses the TLS
34927 output function, so it can be used for all forms of SMTP connection.
34928
34929 The second argument is used to request that the data be buffered
34930 (when TRUE) or flushed (along with any previously buffered, when FALSE).
34931 This is advisory only, but likely to save on system-calls and packets
34932 sent when a sequence of calls to the function are made.
34933
34934 The argument was added in Exim version 4.90 - changing the API/ABI.
34935 Nobody noticed until 4.93 was imminent, at which point the
34936 ABI version number was incremented.
34937
34938 Strings that are written by &'smtp_printf()'& from within &[local_scan()]&
34939 must start with an appropriate response code: 550 if you are going to return
34940 LOCAL_SCAN_REJECT, 451 if you are going to return
34941 LOCAL_SCAN_TEMPREJECT, and 250 otherwise. Because you are writing the
34942 initial lines of a multi-line response, the code must be followed by a hyphen
34943 to indicate that the line is not the final response line. You must also ensure
34944 that the lines you write terminate with CRLF. For example:
34945 .code
34946 smtp_printf("550-this is some extra info\r\n");
34947 return LOCAL_SCAN_REJECT;
34948 .endd
34949 Note that you can also create multi-line responses by including newlines in
34950 the data returned via the &%return_text%& argument. The added value of using
34951 &'smtp_printf()'& is that, for instance, you could introduce delays between
34952 multiple output lines.
34953
34954 The &'smtp_printf()'& function does not return any error indication, because it
34955 does not
34956 guarantee a flush of
34957 pending output, and therefore does not test
34958 the state of the stream. (In the main code of Exim, flushing and error
34959 detection is done when Exim is ready for the next SMTP input command.) If
34960 you want to flush the output and check for an error (for example, the
34961 dropping of a TCP/IP connection), you can call &'smtp_fflush()'&, which has no
34962 arguments. It flushes the output stream, and returns a non-zero value if there
34963 is an error.
34964
34965 .new
34966 .vitem &*void&~*store_get(int,BOOL)*&
34967 This function accesses Exim's internal store (memory) manager. It gets a new
34968 chunk of memory whose size is given by the first argument.
34969 The second argument should be given as TRUE if the memory will be used for
34970 data possibly coming from an attacker (eg. the message content),
34971 FALSE if it is locally-sourced.
34972 Exim bombs out if it ever
34973 runs out of memory. See the next section for a discussion of memory handling.
34974 .wen
34975
34976 .vitem &*void&~*store_get_perm(int,BOOL)*&
34977 This function is like &'store_get()'&, but it always gets memory from the
34978 permanent pool. See the next section for a discussion of memory handling.
34979
34980 .vitem &*uschar&~*string_copy(uschar&~*string)*&
34981 See below.
34982
34983 .vitem &*uschar&~*string_copyn(uschar&~*string,&~int&~length)*&
34984 See below.
34985
34986 .vitem &*uschar&~*string_sprintf(char&~*format,&~...)*&
34987 These three functions create strings using Exim's dynamic memory facilities.
34988 The first makes a copy of an entire string. The second copies up to a maximum
34989 number of characters, indicated by the second argument. The third uses a format
34990 and insertion arguments to create a new string. In each case, the result is a
34991 pointer to a new string in the current memory pool. See the next section for
34992 more discussion.
34993 .endlist
34994
34995
34996
34997 .section "More about Exim's memory handling" "SECTmemhanloc"
34998 .cindex "&[local_scan()]& function" "memory handling"
34999 No function is provided for freeing memory, because that is never needed.
35000 The dynamic memory that Exim uses when receiving a message is automatically
35001 recycled if another message is received by the same process (this applies only
35002 to incoming SMTP connections &-- other input methods can supply only one
35003 message at a time). After receiving the last message, a reception process
35004 terminates.
35005
35006 Because it is recycled, the normal dynamic memory cannot be used for holding
35007 data that must be preserved over a number of incoming messages on the same SMTP
35008 connection. However, Exim in fact uses two pools of dynamic memory; the second
35009 one is not recycled, and can be used for this purpose.
35010
35011 If you want to allocate memory that remains available for subsequent messages
35012 in the same SMTP connection, you should set
35013 .code
35014 store_pool = POOL_PERM
35015 .endd
35016 before calling the function that does the allocation. There is no need to
35017 restore the value if you do not need to; however, if you do want to revert to
35018 the normal pool, you can either restore the previous value of &%store_pool%& or
35019 set it explicitly to POOL_MAIN.
35020
35021 The pool setting applies to all functions that get dynamic memory, including
35022 &'expand_string()'&, &'store_get()'&, and the &'string_xxx()'& functions.
35023 There is also a convenience function called &'store_get_perm()'& that gets a
35024 block of memory from the permanent pool while preserving the value of
35025 &%store_pool%&.
35026 .ecindex IIDlosca
35027
35028
35029
35030
35031 . ////////////////////////////////////////////////////////////////////////////
35032 . ////////////////////////////////////////////////////////////////////////////
35033
35034 .chapter "System-wide message filtering" "CHAPsystemfilter"
35035 .scindex IIDsysfil1 "filter" "system filter"
35036 .scindex IIDsysfil2 "filtering all mail"
35037 .scindex IIDsysfil3 "system filter"
35038 The previous chapters (on ACLs and the local scan function) describe checks
35039 that can be applied to messages before they are accepted by a host. There is
35040 also a mechanism for checking messages once they have been received, but before
35041 they are delivered. This is called the &'system filter'&.
35042
35043 The system filter operates in a similar manner to users' filter files, but it
35044 is run just once per message (however many recipients the message has).
35045 It should not normally be used as a substitute for routing, because &%deliver%&
35046 commands in a system router provide new envelope recipient addresses.
35047 The system filter must be an Exim filter. It cannot be a Sieve filter.
35048
35049 The system filter is run at the start of a delivery attempt, before any routing
35050 is done. If a message fails to be completely delivered at the first attempt,
35051 the system filter is run again at the start of every retry.
35052 If you want your filter to do something only once per message, you can make use
35053 of the &%first_delivery%& condition in an &%if%& command in the filter to
35054 prevent it happening on retries.
35055
35056 .vindex "&$domain$&"
35057 .vindex "&$local_part$&"
35058 &*Warning*&: Because the system filter runs just once, variables that are
35059 specific to individual recipient addresses, such as &$local_part$& and
35060 &$domain$&, are not set, and the &"personal"& condition is not meaningful. If
35061 you want to run a centrally-specified filter for each recipient address
35062 independently, you can do so by setting up a suitable &(redirect)& router, as
35063 described in section &<<SECTperaddfil>>& below.
35064
35065
35066 .section "Specifying a system filter" "SECID212"
35067 .cindex "uid (user id)" "system filter"
35068 .cindex "gid (group id)" "system filter"
35069 The name of the file that contains the system filter must be specified by
35070 setting &%system_filter%&. If you want the filter to run under a uid and gid
35071 other than root, you must also set &%system_filter_user%& and
35072 &%system_filter_group%& as appropriate. For example:
35073 .code
35074 system_filter = /etc/mail/exim.filter
35075 system_filter_user = exim
35076 .endd
35077 If a system filter generates any deliveries directly to files or pipes (via the
35078 &%save%& or &%pipe%& commands), transports to handle these deliveries must be
35079 specified by setting &%system_filter_file_transport%& and
35080 &%system_filter_pipe_transport%&, respectively. Similarly,
35081 &%system_filter_reply_transport%& must be set to handle any messages generated
35082 by the &%reply%& command.
35083
35084
35085 .section "Testing a system filter" "SECID213"
35086 You can run simple tests of a system filter in the same way as for a user
35087 filter, but you should use &%-bF%& rather than &%-bf%&, so that features that
35088 are permitted only in system filters are recognized.
35089
35090 If you want to test the combined effect of a system filter and a user filter,
35091 you can use both &%-bF%& and &%-bf%& on the same command line.
35092
35093
35094
35095 .section "Contents of a system filter" "SECID214"
35096 The language used to specify system filters is the same as for users' filter
35097 files. It is described in the separate end-user document &'Exim's interface to
35098 mail filtering'&. However, there are some additional features that are
35099 available only in system filters; these are described in subsequent sections.
35100 If they are encountered in a user's filter file or when testing with &%-bf%&,
35101 they cause errors.
35102
35103 .cindex "frozen messages" "manual thaw; testing in filter"
35104 There are two special conditions which, though available in users' filter
35105 files, are designed for use in system filters. The condition &%first_delivery%&
35106 is true only for the first attempt at delivering a message, and
35107 &%manually_thawed%& is true only if the message has been frozen, and
35108 subsequently thawed by an admin user. An explicit forced delivery counts as a
35109 manual thaw, but thawing as a result of the &%auto_thaw%& setting does not.
35110
35111 &*Warning*&: If a system filter uses the &%first_delivery%& condition to
35112 specify an &"unseen"& (non-significant) delivery, and that delivery does not
35113 succeed, it will not be tried again.
35114 If you want Exim to retry an unseen delivery until it succeeds, you should
35115 arrange to set it up every time the filter runs.
35116
35117 When a system filter finishes running, the values of the variables &$n0$& &--
35118 &$n9$& are copied into &$sn0$& &-- &$sn9$& and are thereby made available to
35119 users' filter files. Thus a system filter can, for example, set up &"scores"&
35120 to which users' filter files can refer.
35121
35122
35123
35124 .section "Additional variable for system filters" "SECID215"
35125 .vindex "&$recipients$&"
35126 The expansion variable &$recipients$&, containing a list of all the recipients
35127 of the message (separated by commas and white space), is available in system
35128 filters. It is not available in users' filters for privacy reasons.
35129
35130
35131
35132 .section "Defer, freeze, and fail commands for system filters" "SECID216"
35133 .cindex "freezing messages"
35134 .cindex "message" "freezing"
35135 .cindex "message" "forced failure"
35136 .cindex "&%fail%&" "in system filter"
35137 .cindex "&%freeze%& in system filter"
35138 .cindex "&%defer%& in system filter"
35139 There are three extra commands (&%defer%&, &%freeze%& and &%fail%&) which are
35140 always available in system filters, but are not normally enabled in users'
35141 filters. (See the &%allow_defer%&, &%allow_freeze%& and &%allow_fail%& options
35142 for the &(redirect)& router.) These commands can optionally be followed by the
35143 word &%text%& and a string containing an error message, for example:
35144 .code
35145 fail text "this message looks like spam to me"
35146 .endd
35147 The keyword &%text%& is optional if the next character is a double quote.
35148
35149 The &%defer%& command defers delivery of the original recipients of the
35150 message. The &%fail%& command causes all the original recipients to be failed,
35151 and a bounce message to be created. The &%freeze%& command suspends all
35152 delivery attempts for the original recipients. In all cases, any new deliveries
35153 that are specified by the filter are attempted as normal after the filter has
35154 run.
35155
35156 The &%freeze%& command is ignored if the message has been manually unfrozen and
35157 not manually frozen since. This means that automatic freezing by a system
35158 filter can be used as a way of checking out suspicious messages. If a message
35159 is found to be all right, manually unfreezing it allows it to be delivered.
35160
35161 .cindex "log" "&%fail%& command log line"
35162 .cindex "&%fail%&" "log line; reducing"
35163 The text given with a fail command is used as part of the bounce message as
35164 well as being written to the log. If the message is quite long, this can fill
35165 up a lot of log space when such failures are common. To reduce the size of the
35166 log message, Exim interprets the text in a special way if it starts with the
35167 two characters &`<<`& and contains &`>>`& later. The text between these two
35168 strings is written to the log, and the rest of the text is used in the bounce
35169 message. For example:
35170 .code
35171 fail "<<filter test 1>>Your message is rejected \
35172      because it contains attachments that we are \
35173      not prepared to receive."
35174 .endd
35175
35176 .cindex "loop" "caused by &%fail%&"
35177 Take great care with the &%fail%& command when basing the decision to fail on
35178 the contents of the message, because the bounce message will of course include
35179 the contents of the original message and will therefore trigger the &%fail%&
35180 command again (causing a mail loop) unless steps are taken to prevent this.
35181 Testing the &%error_message%& condition is one way to prevent this. You could
35182 use, for example
35183 .code
35184 if $message_body contains "this is spam" and not error_message
35185 then fail text "spam is not wanted here" endif
35186 .endd
35187 though of course that might let through unwanted bounce messages. The
35188 alternative is clever checking of the body and/or headers to detect bounces
35189 generated by the filter.
35190
35191 The interpretation of a system filter file ceases after a
35192 &%defer%&,
35193 &%freeze%&, or &%fail%& command is obeyed. However, any deliveries that were
35194 set up earlier in the filter file are honoured, so you can use a sequence such
35195 as
35196 .code
35197 mail ...
35198 freeze
35199 .endd
35200 to send a specified message when the system filter is freezing (or deferring or
35201 failing) a message. The normal deliveries for the message do not, of course,
35202 take place.
35203
35204
35205
35206 .section "Adding and removing headers in a system filter" "SECTaddremheasys"
35207 .cindex "header lines" "adding; in system filter"
35208 .cindex "header lines" "removing; in system filter"
35209 .cindex "filter" "header lines; adding/removing"
35210 Two filter commands that are available only in system filters are:
35211 .code
35212 headers add <string>
35213 headers remove <string>
35214 .endd
35215 The argument for the &%headers add%& is a string that is expanded and then
35216 added to the end of the message's headers. It is the responsibility of the
35217 filter maintainer to make sure it conforms to RFC 2822 syntax. Leading white
35218 space is ignored, and if the string is otherwise empty, or if the expansion is
35219 forced to fail, the command has no effect.
35220
35221 You can use &"\n"& within the string, followed by white space, to specify
35222 continued header lines. More than one header may be added in one command by
35223 including &"\n"& within the string without any following white space. For
35224 example:
35225 .code
35226 headers add "X-header-1: ....\n  \
35227              continuation of X-header-1 ...\n\
35228              X-header-2: ...."
35229 .endd
35230 Note that the header line continuation white space after the first newline must
35231 be placed before the backslash that continues the input string, because white
35232 space after input continuations is ignored.
35233
35234 The argument for &%headers remove%& is a colon-separated list of header names.
35235 This command applies only to those headers that are stored with the message;
35236 those that are added at delivery time (such as &'Envelope-To:'& and
35237 &'Return-Path:'&) cannot be removed by this means. If there is more than one
35238 header with the same name, they are all removed.
35239
35240 The &%headers%& command in a system filter makes an immediate change to the set
35241 of header lines that was received with the message (with possible additions
35242 from ACL processing). Subsequent commands in the system filter operate on the
35243 modified set, which also forms the basis for subsequent message delivery.
35244 Unless further modified during routing or transporting, this set of headers is
35245 used for all recipients of the message.
35246
35247 During routing and transporting, the variables that refer to the contents of
35248 header lines refer only to those lines that are in this set. Thus, header lines
35249 that are added by a system filter are visible to users' filter files and to all
35250 routers and transports. This contrasts with the manipulation of header lines by
35251 routers and transports, which is not immediate, but which instead is saved up
35252 until the message is actually being written (see section
35253 &<<SECTheadersaddrem>>&).
35254
35255 If the message is not delivered at the first attempt, header lines that were
35256 added by the system filter are stored with the message, and so are still
35257 present at the next delivery attempt. Header lines that were removed are still
35258 present, but marked &"deleted"& so that they are not transported with the
35259 message. For this reason, it is usual to make the &%headers%& command
35260 conditional on &%first_delivery%& so that the set of header lines is not
35261 modified more than once.
35262
35263 Because header modification in a system filter acts immediately, you have to
35264 use an indirect approach if you want to modify the contents of a header line.
35265 For example:
35266 .code
35267 headers add "Old-Subject: $h_subject:"
35268 headers remove "Subject"
35269 headers add "Subject: new subject (was: $h_old-subject:)"
35270 headers remove "Old-Subject"
35271 .endd
35272
35273
35274
35275 .section "Setting an errors address in a system filter" "SECID217"
35276 .cindex "envelope from"
35277 .cindex "envelope sender"
35278 In a system filter, if a &%deliver%& command is followed by
35279 .code
35280 errors_to <some address>
35281 .endd
35282 in order to change the envelope sender (and hence the error reporting) for that
35283 delivery, any address may be specified. (In a user filter, only the current
35284 user's address can be set.) For example, if some mail is being monitored, you
35285 might use
35286 .code
35287 unseen deliver monitor@spying.example errors_to root@local.example
35288 .endd
35289 to take a copy which would not be sent back to the normal error reporting
35290 address if its delivery failed.
35291
35292
35293
35294 .section "Per-address filtering" "SECTperaddfil"
35295 .vindex "&$domain$&"
35296 .vindex "&$local_part$&"
35297 In contrast to the system filter, which is run just once per message for each
35298 delivery attempt, it is also possible to set up a system-wide filtering
35299 operation that runs once for each recipient address. In this case, variables
35300 such as &$local_part$& and &$domain$& can be used, and indeed, the choice of
35301 filter file could be made dependent on them. This is an example of a router
35302 which implements such a filter:
35303 .code
35304 central_filter:
35305   check_local_user
35306   driver = redirect
35307   domains = +local_domains
35308   file = /central/filters/$local_part_data
35309   no_verify
35310   allow_filter
35311   allow_freeze
35312 .endd
35313 The filter is run in a separate process under its own uid. Therefore, either
35314 &%check_local_user%& must be set (as above), in which case the filter is run as
35315 the local user, or the &%user%& option must be used to specify which user to
35316 use. If both are set, &%user%& overrides.
35317
35318 Care should be taken to ensure that none of the commands in the filter file
35319 specify a significant delivery if the message is to go on to be delivered to
35320 its intended recipient. The router will not then claim to have dealt with the
35321 address, so it will be passed on to subsequent routers to be delivered in the
35322 normal way.
35323 .ecindex IIDsysfil1
35324 .ecindex IIDsysfil2
35325 .ecindex IIDsysfil3
35326
35327
35328
35329
35330
35331
35332 . ////////////////////////////////////////////////////////////////////////////
35333 . ////////////////////////////////////////////////////////////////////////////
35334
35335 .chapter "Message processing" "CHAPmsgproc"
35336 .scindex IIDmesproc "message" "general processing"
35337 Exim performs various transformations on the sender and recipient addresses of
35338 all messages that it handles, and also on the messages' header lines. Some of
35339 these are optional and configurable, while others always take place. All of
35340 this processing, except rewriting as a result of routing, and the addition or
35341 removal of header lines while delivering, happens when a message is received,
35342 before it is placed on Exim's queue.
35343
35344 Some of the automatic processing takes place by default only for
35345 &"locally-originated"& messages. This adjective is used to describe messages
35346 that are not received over TCP/IP, but instead are passed to an Exim process on
35347 its standard input. This includes the interactive &"local SMTP"& case that is
35348 set up by the &%-bs%& command line option.
35349
35350 &*Note*&: Messages received over TCP/IP on the loopback interface (127.0.0.1
35351 or ::1) are not considered to be locally-originated. Exim does not treat the
35352 loopback interface specially in any way.
35353
35354 If you want the loopback interface to be treated specially, you must ensure
35355 that there are appropriate entries in your ACLs.
35356
35357
35358
35359
35360 .section "Submission mode for non-local messages" "SECTsubmodnon"
35361 .cindex "message" "submission"
35362 .cindex "submission mode"
35363 Processing that happens automatically for locally-originated messages (unless
35364 &%suppress_local_fixups%& is set) can also be requested for messages that are
35365 received over TCP/IP. The term &"submission mode"& is used to describe this
35366 state. Submission mode is set by the modifier
35367 .code
35368 control = submission
35369 .endd
35370 in a MAIL, RCPT, or pre-data ACL for an incoming message (see sections
35371 &<<SECTACLmodi>>& and &<<SECTcontrols>>&). This makes Exim treat the message as
35372 a local submission, and is normally used when the source of the message is
35373 known to be an MUA running on a client host (as opposed to an MTA). For
35374 example, to set submission mode for messages originating on the IPv4 loopback
35375 interface, you could include the following in the MAIL ACL:
35376 .code
35377 warn  hosts = 127.0.0.1
35378       control = submission
35379 .endd
35380 .cindex "&%sender_retain%& submission option"
35381 There are some options that can be used when setting submission mode. A slash
35382 is used to separate options. For example:
35383 .code
35384 control = submission/sender_retain
35385 .endd
35386 Specifying &%sender_retain%& has the effect of setting &%local_sender_retain%&
35387 true and &%local_from_check%& false for the current incoming message. The first
35388 of these allows an existing &'Sender:'& header in the message to remain, and
35389 the second suppresses the check to ensure that &'From:'& matches the
35390 authenticated sender. With this setting, Exim still fixes up messages by adding
35391 &'Date:'& and &'Message-ID:'& header lines if they are missing, but makes no
35392 attempt to check sender authenticity in header lines.
35393
35394 When &%sender_retain%& is not set, a submission mode setting may specify a
35395 domain to be used when generating a &'From:'& or &'Sender:'& header line. For
35396 example:
35397 .code
35398 control = submission/domain=some.domain
35399 .endd
35400 The domain may be empty. How this value is used is described in sections
35401 &<<SECTthefrohea>>& and &<<SECTthesenhea>>&. There is also a &%name%& option
35402 that allows you to specify the user's full name for inclusion in a created
35403 &'Sender:'& or &'From:'& header line. For example:
35404 .code
35405 accept authenticated = *
35406        control = submission/domain=wonderland.example/\
35407                             name=${lookup {$authenticated_id} \
35408                                    lsearch {/etc/exim/namelist}}
35409 .endd
35410 Because the name may contain any characters, including slashes, the &%name%&
35411 option must be given last. The remainder of the string is used as the name. For
35412 the example above, if &_/etc/exim/namelist_& contains:
35413 .code
35414 bigegg:  Humpty Dumpty
35415 .endd
35416 then when the sender has authenticated as &'bigegg'&, the generated &'Sender:'&
35417 line would be:
35418 .code
35419 Sender: Humpty Dumpty <bigegg@wonderland.example>
35420 .endd
35421 .cindex "return path" "in submission mode"
35422 By default, submission mode forces the return path to the same address as is
35423 used to create the &'Sender:'& header. However, if &%sender_retain%& is
35424 specified, the return path is also left unchanged.
35425
35426 &*Note*&: The changes caused by submission mode take effect after the predata
35427 ACL. This means that any sender checks performed before the fix-ups use the
35428 untrusted sender address specified by the user, not the trusted sender address
35429 specified by submission mode. Although this might be slightly unexpected, it
35430 does mean that you can configure ACL checks to spot that a user is trying to
35431 spoof another's address.
35432
35433 .section "Line endings" "SECTlineendings"
35434 .cindex "line endings"
35435 .cindex "carriage return"
35436 .cindex "linefeed"
35437 RFC 2821 specifies that CRLF (two characters: carriage-return, followed by
35438 linefeed) is the line ending for messages transmitted over the Internet using
35439 SMTP over TCP/IP. However, within individual operating systems, different
35440 conventions are used. For example, Unix-like systems use just LF, but others
35441 use CRLF or just CR.
35442
35443 Exim was designed for Unix-like systems, and internally, it stores messages
35444 using the system's convention of a single LF as a line terminator. When
35445 receiving a message, all line endings are translated to this standard format.
35446 Originally, it was thought that programs that passed messages directly to an
35447 MTA within an operating system would use that system's convention. Experience
35448 has shown that this is not the case; for example, there are Unix applications
35449 that use CRLF in this circumstance. For this reason, and for compatibility with
35450 other MTAs, the way Exim handles line endings for all messages is now as
35451 follows:
35452
35453 .ilist
35454 LF not preceded by CR is treated as a line ending.
35455 .next
35456 CR is treated as a line ending; if it is immediately followed by LF, the LF
35457 is ignored.
35458 .next
35459 The sequence &"CR, dot, CR"& does not terminate an incoming SMTP message,
35460 nor a local message in the state where a line containing only a dot is a
35461 terminator.
35462 .next
35463 If a bare CR is encountered within a header line, an extra space is added after
35464 the line terminator so as not to end the header line. The reasoning behind this
35465 is that bare CRs in header lines are most likely either to be mistakes, or
35466 people trying to play silly games.
35467 .next
35468 If the first header line received in a message ends with CRLF, a subsequent
35469 bare LF in a header line is treated in the same way as a bare CR in a header
35470 line.
35471 .endlist
35472
35473
35474
35475
35476
35477 .section "Unqualified addresses" "SECID218"
35478 .cindex "unqualified addresses"
35479 .cindex "address" "qualification"
35480 By default, Exim expects every envelope address it receives from an external
35481 host to be fully qualified. Unqualified addresses cause negative responses to
35482 SMTP commands. However, because SMTP is used as a means of transporting
35483 messages from MUAs running on personal workstations, there is sometimes a
35484 requirement to accept unqualified addresses from specific hosts or IP networks.
35485
35486 Exim has two options that separately control which hosts may send unqualified
35487 sender or recipient addresses in SMTP commands, namely
35488 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&. In both
35489 cases, if an unqualified address is accepted, it is qualified by adding the
35490 value of &%qualify_domain%& or &%qualify_recipient%&, as appropriate.
35491
35492 .oindex "&%qualify_domain%&"
35493 .oindex "&%qualify_recipient%&"
35494 Unqualified addresses in header lines are automatically qualified for messages
35495 that are locally originated, unless the &%-bnq%& option is given on the command
35496 line. For messages received over SMTP, unqualified addresses in header lines
35497 are qualified only if unqualified addresses are permitted in SMTP commands. In
35498 other words, such qualification is also controlled by
35499 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&,
35500
35501
35502
35503
35504 .section "The UUCP From line" "SECID219"
35505 .cindex "&""From""& line"
35506 .cindex "UUCP" "&""From""& line"
35507 .cindex "sender" "address"
35508 .oindex "&%uucp_from_pattern%&"
35509 .oindex "&%uucp_from_sender%&"
35510 .cindex "envelope from"
35511 .cindex "envelope sender"
35512 .cindex "Sendmail compatibility" "&""From""& line"
35513 Messages that have come from UUCP (and some other applications) often begin
35514 with a line containing the envelope sender and a timestamp, following the word
35515 &"From"&. Examples of two common formats are:
35516 .code
35517 From a.oakley@berlin.mus Fri Jan  5 12:35 GMT 1996
35518 From f.butler@berlin.mus Fri, 7 Jan 97 14:00:00 GMT
35519 .endd
35520 This line precedes the RFC 2822 header lines. For compatibility with Sendmail,
35521 Exim recognizes such lines at the start of messages that are submitted to it
35522 via the command line (that is, on the standard input). It does not recognize
35523 such lines in incoming SMTP messages, unless the sending host matches
35524 &%ignore_fromline_hosts%& or the &%-bs%& option was used for a local message
35525 and &%ignore_fromline_local%& is set. The recognition is controlled by a
35526 regular expression that is defined by the &%uucp_from_pattern%& option, whose
35527 default value matches the two common cases shown above and puts the address
35528 that follows &"From"& into &$1$&.
35529
35530 .cindex "numerical variables (&$1$& &$2$& etc)" "in &""From ""& line handling"
35531 When the caller of Exim for a non-SMTP message that contains a &"From"& line is
35532 a trusted user, the message's sender address is constructed by expanding the
35533 contents of &%uucp_sender_address%&, whose default value is &"$1"&. This is
35534 then parsed as an RFC 2822 address. If there is no domain, the local part is
35535 qualified with &%qualify_domain%& unless it is the empty string. However, if
35536 the command line &%-f%& option is used, it overrides the &"From"& line.
35537
35538 If the caller of Exim is not trusted, the &"From"& line is recognized, but the
35539 sender address is not changed. This is also the case for incoming SMTP messages
35540 that are permitted to contain &"From"& lines.
35541
35542 Only one &"From"& line is recognized. If there is more than one, the second is
35543 treated as a data line that starts the body of the message, as it is not valid
35544 as a header line. This also happens if a &"From"& line is present in an
35545 incoming SMTP message from a source that is not permitted to send them.
35546
35547
35548
35549 .section "Resent- header lines" "SECID220"
35550 .cindex "&%Resent-%& header lines"
35551 .cindex "header lines" "Resent-"
35552 RFC 2822 makes provision for sets of header lines starting with the string
35553 &`Resent-`& to be added to a message when it is resent by the original
35554 recipient to somebody else. These headers are &'Resent-Date:'&,
35555 &'Resent-From:'&, &'Resent-Sender:'&, &'Resent-To:'&, &'Resent-Cc:'&,
35556 &'Resent-Bcc:'& and &'Resent-Message-ID:'&. The RFC says:
35557
35558 .blockquote
35559 &'Resent fields are strictly informational. They MUST NOT be used in the normal
35560 processing of replies or other such automatic actions on messages.'&
35561 .endblockquote
35562
35563 This leaves things a bit vague as far as other processing actions such as
35564 address rewriting are concerned. Exim treats &%Resent-%& header lines as
35565 follows:
35566
35567 .ilist
35568 A &'Resent-From:'& line that just contains the login id of the submitting user
35569 is automatically rewritten in the same way as &'From:'& (see below).
35570 .next
35571 If there's a rewriting rule for a particular header line, it is also applied to
35572 &%Resent-%& header lines of the same type. For example, a rule that rewrites
35573 &'From:'& also rewrites &'Resent-From:'&.
35574 .next
35575 For local messages, if &'Sender:'& is removed on input, &'Resent-Sender:'& is
35576 also removed.
35577 .next
35578 For a locally-submitted message,
35579 if there are any &%Resent-%& header lines but no &'Resent-Date:'&,
35580 &'Resent-From:'&, or &'Resent-Message-Id:'&, they are added as necessary. It is
35581 the contents of &'Resent-Message-Id:'& (rather than &'Message-Id:'&) which are
35582 included in log lines in this case.
35583 .next
35584 The logic for adding &'Sender:'& is duplicated for &'Resent-Sender:'& when any
35585 &%Resent-%& header lines are present.
35586 .endlist
35587
35588
35589
35590
35591 .section "The Auto-Submitted: header line" "SECID221"
35592 Whenever Exim generates an autoreply, a bounce, or a delay warning message, it
35593 includes the header line:
35594 .code
35595 Auto-Submitted: auto-replied
35596 .endd
35597
35598 .section "The Bcc: header line" "SECID222"
35599 .cindex "&'Bcc:'& header line"
35600 If Exim is called with the &%-t%& option, to take recipient addresses from a
35601 message's header, it removes any &'Bcc:'& header line that may exist (after
35602 extracting its addresses). If &%-t%& is not present on the command line, any
35603 existing &'Bcc:'& is not removed.
35604
35605
35606 .section "The Date: header line" "SECID223"
35607 .cindex "&'Date:'& header line"
35608 .cindex "header lines" "Date:"
35609 If a locally-generated or submission-mode message has no &'Date:'& header line,
35610 Exim adds one, using the current date and time, unless the
35611 &%suppress_local_fixups%& control has been specified.
35612
35613 .section "The Delivery-date: header line" "SECID224"
35614 .cindex "&'Delivery-date:'& header line"
35615 .oindex "&%delivery_date_remove%&"
35616 &'Delivery-date:'& header lines are not part of the standard RFC 2822 header
35617 set. Exim can be configured to add them to the final delivery of messages. (See
35618 the generic &%delivery_date_add%& transport option.) They should not be present
35619 in messages in transit. If the &%delivery_date_remove%& configuration option is
35620 set (the default), Exim removes &'Delivery-date:'& header lines from incoming
35621 messages.
35622
35623
35624 .section "The Envelope-to: header line" "SECID225"
35625 .cindex "&'Envelope-to:'& header line"
35626 .cindex "header lines" "Envelope-to:"
35627 .oindex "&%envelope_to_remove%&"
35628 &'Envelope-to:'& header lines are not part of the standard RFC 2822 header set.
35629 Exim can be configured to add them to the final delivery of messages. (See the
35630 generic &%envelope_to_add%& transport option.) They should not be present in
35631 messages in transit. If the &%envelope_to_remove%& configuration option is set
35632 (the default), Exim removes &'Envelope-to:'& header lines from incoming
35633 messages.
35634
35635
35636 .section "The From: header line" "SECTthefrohea"
35637 .cindex "&'From:'& header line"
35638 .cindex "header lines" "From:"
35639 .cindex "Sendmail compatibility" "&""From""& line"
35640 .cindex "message" "submission"
35641 .cindex "submission mode"
35642 If a submission-mode message does not contain a &'From:'& header line, Exim
35643 adds one if either of the following conditions is true:
35644
35645 .ilist
35646 The envelope sender address is not empty (that is, this is not a bounce
35647 message). The added header line copies the envelope sender address.
35648 .next
35649 .vindex "&$authenticated_id$&"
35650 The SMTP session is authenticated and &$authenticated_id$& is not empty.
35651 .olist
35652 .vindex "&$qualify_domain$&"
35653 If no domain is specified by the submission control, the local part is
35654 &$authenticated_id$& and the domain is &$qualify_domain$&.
35655 .next
35656 If a non-empty domain is specified by the submission control, the local
35657 part is &$authenticated_id$&, and the domain is the specified domain.
35658 .next
35659 If an empty domain is specified by the submission control,
35660 &$authenticated_id$& is assumed to be the complete address.
35661 .endlist
35662 .endlist
35663
35664 A non-empty envelope sender takes precedence.
35665
35666 If a locally-generated incoming message does not contain a &'From:'& header
35667 line, and the &%suppress_local_fixups%& control is not set, Exim adds one
35668 containing the sender's address. The calling user's login name and full name
35669 are used to construct the address, as described in section &<<SECTconstr>>&.
35670 They are obtained from the password data by calling &[getpwuid()]& (but see the
35671 &%unknown_login%& configuration option). The address is qualified with
35672 &%qualify_domain%&.
35673
35674 For compatibility with Sendmail, if an incoming, non-SMTP message has a
35675 &'From:'& header line containing just the unqualified login name of the calling
35676 user, this is replaced by an address containing the user's login name and full
35677 name as described in section &<<SECTconstr>>&.
35678
35679
35680 .section "The Message-ID: header line" "SECID226"
35681 .cindex "&'Message-ID:'& header line"
35682 .cindex "header lines" "Message-ID:"
35683 .cindex "message" "submission"
35684 .oindex "&%message_id_header_text%&"
35685 If a locally-generated or submission-mode incoming message does not contain a
35686 &'Message-ID:'& or &'Resent-Message-ID:'& header line, and the
35687 &%suppress_local_fixups%& control is not set, Exim adds a suitable header line
35688 to the message. If there are any &'Resent-:'& headers in the message, it
35689 creates &'Resent-Message-ID:'&. The id is constructed from Exim's internal
35690 message id, preceded by the letter E to ensure it starts with a letter, and
35691 followed by @ and the primary host name. Additional information can be included
35692 in this header line by setting the &%message_id_header_text%& and/or
35693 &%message_id_header_domain%& options.
35694
35695
35696 .section "The Received: header line" "SECID227"
35697 .cindex "&'Received:'& header line"
35698 .cindex "header lines" "Received:"
35699 A &'Received:'& header line is added at the start of every message. The
35700 contents are defined by the &%received_header_text%& configuration option, and
35701 Exim automatically adds a semicolon and a timestamp to the configured string.
35702
35703 The &'Received:'& header is generated as soon as the message's header lines
35704 have been received. At this stage, the timestamp in the &'Received:'& header
35705 line is the time that the message started to be received. This is the value
35706 that is seen by the DATA ACL and by the &[local_scan()]& function.
35707
35708 Once a message is accepted, the timestamp in the &'Received:'& header line is
35709 changed to the time of acceptance, which is (apart from a small delay while the
35710 -H spool file is written) the earliest time at which delivery could start.
35711
35712
35713 .section "The References: header line" "SECID228"
35714 .cindex "&'References:'& header line"
35715 .cindex "header lines" "References:"
35716 Messages created by the &(autoreply)& transport include a &'References:'&
35717 header line. This is constructed according to the rules that are described in
35718 section 3.64 of RFC 2822 (which states that replies should contain such a
35719 header line), and section 3.14 of RFC 3834 (which states that automatic
35720 responses are not different in this respect). However, because some mail
35721 processing software does not cope well with very long header lines, no more
35722 than 12 message IDs are copied from the &'References:'& header line in the
35723 incoming message. If there are more than 12, the first one and then the final
35724 11 are copied, before adding the message ID of the incoming message.
35725
35726
35727
35728 .section "The Return-path: header line" "SECID229"
35729 .cindex "&'Return-path:'& header line"
35730 .cindex "header lines" "Return-path:"
35731 .oindex "&%return_path_remove%&"
35732 &'Return-path:'& header lines are defined as something an MTA may insert when
35733 it does the final delivery of messages. (See the generic &%return_path_add%&
35734 transport option.) Therefore, they should not be present in messages in
35735 transit. If the &%return_path_remove%& configuration option is set (the
35736 default), Exim removes &'Return-path:'& header lines from incoming messages.
35737
35738
35739
35740 .section "The Sender: header line" "SECTthesenhea"
35741 .cindex "&'Sender:'& header line"
35742 .cindex "message" "submission"
35743 .cindex "header lines" "Sender:"
35744 For a locally-originated message from an untrusted user, Exim may remove an
35745 existing &'Sender:'& header line, and it may add a new one. You can modify
35746 these actions by setting the &%local_sender_retain%& option true, the
35747 &%local_from_check%& option false, or by using the &%suppress_local_fixups%&
35748 control setting.
35749
35750 When a local message is received from an untrusted user and
35751 &%local_from_check%& is true (the default), and the &%suppress_local_fixups%&
35752 control has not been set, a check is made to see if the address given in the
35753 &'From:'& header line is the correct (local) sender of the message. The address
35754 that is expected has the login name as the local part and the value of
35755 &%qualify_domain%& as the domain. Prefixes and suffixes for the local part can
35756 be permitted by setting &%local_from_prefix%& and &%local_from_suffix%&
35757 appropriately. If &'From:'& does not contain the correct sender, a &'Sender:'&
35758 line is added to the message.
35759
35760 If you set &%local_from_check%& false, this checking does not occur. However,
35761 the removal of an existing &'Sender:'& line still happens, unless you also set
35762 &%local_sender_retain%& to be true. It is not possible to set both of these
35763 options true at the same time.
35764
35765 .cindex "submission mode"
35766 By default, no processing of &'Sender:'& header lines is done for messages
35767 received over TCP/IP or for messages submitted by trusted users. However, when
35768 a message is received over TCP/IP in submission mode, and &%sender_retain%& is
35769 not specified on the submission control, the following processing takes place:
35770
35771 .vindex "&$authenticated_id$&"
35772 First, any existing &'Sender:'& lines are removed. Then, if the SMTP session is
35773 authenticated, and &$authenticated_id$& is not empty, a sender address is
35774 created as follows:
35775
35776 .ilist
35777 .vindex "&$qualify_domain$&"
35778 If no domain is specified by the submission control, the local part is
35779 &$authenticated_id$& and the domain is &$qualify_domain$&.
35780 .next
35781 If a non-empty domain is specified by the submission control, the local part
35782 is &$authenticated_id$&, and the domain is the specified domain.
35783 .next
35784 If an empty domain is specified by the submission control,
35785 &$authenticated_id$& is assumed to be the complete address.
35786 .endlist
35787
35788 This address is compared with the address in the &'From:'& header line. If they
35789 are different, a &'Sender:'& header line containing the created address is
35790 added. Prefixes and suffixes for the local part in &'From:'& can be permitted
35791 by setting &%local_from_prefix%& and &%local_from_suffix%& appropriately.
35792
35793 .cindex "return path" "created from &'Sender:'&"
35794 &*Note*&: Whenever a &'Sender:'& header line is created, the return path for
35795 the message (the envelope sender address) is changed to be the same address,
35796 except in the case of submission mode when &%sender_retain%& is specified.
35797
35798
35799
35800 .section "Adding and removing header lines in routers and transports" &&&
35801          "SECTheadersaddrem"
35802 .cindex "header lines" "adding; in router or transport"
35803 .cindex "header lines" "removing; in router or transport"
35804 When a message is delivered, the addition and removal of header lines can be
35805 specified in a system filter, or on any of the routers and transports that
35806 process the message. Section &<<SECTaddremheasys>>& contains details about
35807 modifying headers in a system filter. Header lines can also be added in an ACL
35808 as a message is received (see section &<<SECTaddheadacl>>&).
35809
35810 In contrast to what happens in a system filter, header modifications that are
35811 specified on routers and transports apply only to the particular recipient
35812 addresses that are being processed by those routers and transports. These
35813 changes do not actually take place until a copy of the message is being
35814 transported. Therefore, they do not affect the basic set of header lines, and
35815 they do not affect the values of the variables that refer to header lines.
35816
35817 &*Note*&: In particular, this means that any expansions in the configuration of
35818 the transport cannot refer to the modified header lines, because such
35819 expansions all occur before the message is actually transported.
35820
35821 For both routers and transports, the argument of a &%headers_add%&
35822 option must be in the form of one or more RFC 2822 header lines, separated by
35823 newlines (coded as &"\n"&). For example:
35824 .code
35825 headers_add = X-added-header: added by $primary_hostname\n\
35826               X-added-second: another added header line
35827 .endd
35828 Exim does not check the syntax of these added header lines.
35829
35830 Multiple &%headers_add%& options for a single router or transport can be
35831 specified; the values will append to a single list of header lines.
35832 Each header-line is separately expanded.
35833
35834 The argument of a &%headers_remove%& option must consist of a colon-separated
35835 list of header names. This is confusing, because header names themselves are
35836 often terminated by colons. In this case, the colons are the list separators,
35837 not part of the names. For example:
35838 .code
35839 headers_remove = return-receipt-to:acknowledge-to
35840 .endd
35841
35842 Multiple &%headers_remove%& options for a single router or transport can be
35843 specified; the arguments will append to a single header-names list.
35844 Each item is separately expanded.
35845 Note that colons in complex expansions which are used to
35846 form all or part of a &%headers_remove%& list
35847 will act as list separators.
35848
35849 When &%headers_add%& or &%headers_remove%& is specified on a router,
35850 items are expanded at routing time,
35851 and then associated with all addresses that are
35852 accepted by that router, and also with any new addresses that it generates. If
35853 an address passes through several routers as a result of aliasing or
35854 forwarding, the changes are cumulative.
35855
35856 .oindex "&%unseen%&"
35857 However, this does not apply to multiple routers that result from the use of
35858 the &%unseen%& option. Any header modifications that were specified by the
35859 &"unseen"& router or its predecessors apply only to the &"unseen"& delivery.
35860
35861 Addresses that end up with different &%headers_add%& or &%headers_remove%&
35862 settings cannot be delivered together in a batch, so a transport is always
35863 dealing with a set of addresses that have the same header-processing
35864 requirements.
35865
35866 The transport starts by writing the original set of header lines that arrived
35867 with the message, possibly modified by the system filter. As it writes out
35868 these lines, it consults the list of header names that were attached to the
35869 recipient address(es) by &%headers_remove%& options in routers, and it also
35870 consults the transport's own &%headers_remove%& option. Header lines whose
35871 names are on either of these lists are not written out. If there are multiple
35872 instances of any listed header, they are all skipped.
35873
35874 After the remaining original header lines have been written, new header
35875 lines that were specified by routers' &%headers_add%& options are written, in
35876 the order in which they were attached to the address. These are followed by any
35877 header lines specified by the transport's &%headers_add%& option.
35878
35879 This way of handling header line modifications in routers and transports has
35880 the following consequences:
35881
35882 .ilist
35883 The original set of header lines, possibly modified by the system filter,
35884 remains &"visible"&, in the sense that the &$header_$&&'xxx'& variables refer
35885 to it, at all times.
35886 .next
35887 Header lines that are added by a router's
35888 &%headers_add%& option are not accessible by means of the &$header_$&&'xxx'&
35889 expansion syntax in subsequent routers or the transport.
35890 .next
35891 Conversely, header lines that are specified for removal by &%headers_remove%&
35892 in a router remain visible to subsequent routers and the transport.
35893 .next
35894 Headers added to an address by &%headers_add%& in a router cannot be removed by
35895 a later router or by a transport.
35896 .next
35897 An added header can refer to the contents of an original header that is to be
35898 removed, even it has the same name as the added header. For example:
35899 .code
35900 headers_remove = subject
35901 headers_add = Subject: new subject (was: $h_subject:)
35902 .endd
35903 .endlist
35904
35905 &*Warning*&: The &%headers_add%& and &%headers_remove%& options cannot be used
35906 for a &(redirect)& router that has the &%one_time%& option set.
35907
35908
35909
35910
35911
35912 .section "Constructed addresses" "SECTconstr"
35913 .cindex "address" "constructed"
35914 .cindex "constructed address"
35915 When Exim constructs a sender address for a locally-generated message, it uses
35916 the form
35917 .display
35918 <&'user name'&>&~&~<&'login'&&`@`&&'qualify_domain'&>
35919 .endd
35920 For example:
35921 .code
35922 Zaphod Beeblebrox <zaphod@end.univ.example>
35923 .endd
35924 The user name is obtained from the &%-F%& command line option if set, or
35925 otherwise by looking up the calling user by &[getpwuid()]& and extracting the
35926 &"gecos"& field from the password entry. If the &"gecos"& field contains an
35927 ampersand character, this is replaced by the login name with the first letter
35928 upper cased, as is conventional in a number of operating systems. See the
35929 &%gecos_name%& option for a way to tailor the handling of the &"gecos"& field.
35930 The &%unknown_username%& option can be used to specify user names in cases when
35931 there is no password file entry.
35932
35933 .cindex "RFC 2047"
35934 In all cases, the user name is made to conform to RFC 2822 by quoting all or
35935 parts of it if necessary. In addition, if it contains any non-printing
35936 characters, it is encoded as described in RFC 2047, which defines a way of
35937 including non-ASCII characters in header lines. The value of the
35938 &%headers_charset%& option specifies the name of the encoding that is used (the
35939 characters are assumed to be in this encoding). The setting of
35940 &%print_topbitchars%& controls whether characters with the top bit set (that
35941 is, with codes greater than 127) count as printing characters or not.
35942
35943
35944
35945 .section "Case of local parts" "SECID230"
35946 .cindex "case of local parts"
35947 .cindex "local part" "case of"
35948 RFC 2822 states that the case of letters in the local parts of addresses cannot
35949 be assumed to be non-significant. Exim preserves the case of local parts of
35950 addresses, but by default it uses a lower-cased form when it is routing,
35951 because on most Unix systems, usernames are in lower case and case-insensitive
35952 routing is required. However, any particular router can be made to use the
35953 original case for local parts by setting the &%caseful_local_part%& generic
35954 router option.
35955
35956 .cindex "mixed-case login names"
35957 If you must have mixed-case user names on your system, the best way to proceed,
35958 assuming you want case-independent handling of incoming email, is to set up
35959 your first router to convert incoming local parts in your domains to the
35960 correct case by means of a file lookup. For example:
35961 .code
35962 correct_case:
35963   driver = redirect
35964   domains = +local_domains
35965   data = ${lookup{$local_part}cdb\
35966               {/etc/usercased.cdb}{$value}fail}\
35967               @$domain
35968 .endd
35969 For this router, the local part is forced to lower case by the default action
35970 (&%caseful_local_part%& is not set). The lower-cased local part is used to look
35971 up a new local part in the correct case. If you then set &%caseful_local_part%&
35972 on any subsequent routers which process your domains, they will operate on
35973 local parts with the correct case in a case-sensitive manner.
35974
35975
35976
35977 .section "Dots in local parts" "SECID231"
35978 .cindex "dot" "in local part"
35979 .cindex "local part" "dots in"
35980 RFC 2822 forbids empty components in local parts. That is, an unquoted local
35981 part may not begin or end with a dot, nor have two consecutive dots in the
35982 middle. However, it seems that many MTAs do not enforce this, so Exim permits
35983 empty components for compatibility.
35984
35985
35986
35987 .section "Rewriting addresses" "SECID232"
35988 .cindex "rewriting" "addresses"
35989 Rewriting of sender and recipient addresses, and addresses in headers, can
35990 happen automatically, or as the result of configuration options, as described
35991 in chapter &<<CHAPrewrite>>&. The headers that may be affected by this are
35992 &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-To:'&, &'Sender:'&, and &'To:'&.
35993
35994 Automatic rewriting includes qualification, as mentioned above. The other case
35995 in which it can happen is when an incomplete non-local domain is given. The
35996 routing process may cause this to be expanded into the full domain name. For
35997 example, a header such as
35998 .code
35999 To: hare@teaparty
36000 .endd
36001 might get rewritten as
36002 .code
36003 To: hare@teaparty.wonderland.fict.example
36004 .endd
36005 Rewriting as a result of routing is the one kind of message processing that
36006 does not happen at input time, as it cannot be done until the address has
36007 been routed.
36008
36009 Strictly, one should not do &'any'& deliveries of a message until all its
36010 addresses have been routed, in case any of the headers get changed as a
36011 result of routing. However, doing this in practice would hold up many
36012 deliveries for unreasonable amounts of time, just because one address could not
36013 immediately be routed. Exim therefore does not delay other deliveries when
36014 routing of one or more addresses is deferred.
36015 .ecindex IIDmesproc
36016
36017
36018
36019 . ////////////////////////////////////////////////////////////////////////////
36020 . ////////////////////////////////////////////////////////////////////////////
36021
36022 .chapter "SMTP processing" "CHAPSMTP"
36023 .scindex IIDsmtpproc1 "SMTP" "processing details"
36024 .scindex IIDsmtpproc2 "LMTP" "processing details"
36025 Exim supports a number of different ways of using the SMTP protocol, and its
36026 LMTP variant, which is an interactive protocol for transferring messages into a
36027 closed mail store application. This chapter contains details of how SMTP is
36028 processed. For incoming mail, the following are available:
36029
36030 .ilist
36031 SMTP over TCP/IP (Exim daemon or &'inetd'&);
36032 .next
36033 SMTP over the standard input and output (the &%-bs%& option);
36034 .next
36035 Batched SMTP on the standard input (the &%-bS%& option).
36036 .endlist
36037
36038 For mail delivery, the following are available:
36039
36040 .ilist
36041 SMTP over TCP/IP (the &(smtp)& transport);
36042 .next
36043 LMTP over TCP/IP (the &(smtp)& transport with the &%protocol%& option set to
36044 &"lmtp"&);
36045 .next
36046 LMTP over a pipe to a process running in the local host (the &(lmtp)&
36047 transport);
36048 .next
36049 Batched SMTP to a file or pipe (the &(appendfile)& and &(pipe)& transports with
36050 the &%use_bsmtp%& option set).
36051 .endlist
36052
36053 &'Batched SMTP'& is the name for a process in which batches of messages are
36054 stored in or read from files (or pipes), in a format in which SMTP commands are
36055 used to contain the envelope information.
36056
36057
36058
36059 .section "Outgoing SMTP and LMTP over TCP/IP" "SECToutSMTPTCP"
36060 .cindex "SMTP" "outgoing over TCP/IP"
36061 .cindex "outgoing SMTP over TCP/IP"
36062 .cindex "LMTP" "over TCP/IP"
36063 .cindex "outgoing LMTP over TCP/IP"
36064 .cindex "EHLO"
36065 .cindex "HELO"
36066 .cindex "SIZE" "option on MAIL command"
36067 Outgoing SMTP and LMTP over TCP/IP is implemented by the &(smtp)& transport.
36068 The &%protocol%& option selects which protocol is to be used, but the actual
36069 processing is the same in both cases.
36070
36071 .cindex "ESMTP extensions" SIZE
36072 If, in response to its EHLO command, Exim is told that the SIZE
36073 extension is supported, it adds SIZE=<&'n'&> to each subsequent MAIL
36074 command. The value of <&'n'&> is the message size plus the value of the
36075 &%size_addition%& option (default 1024) to allow for additions to the message
36076 such as per-transport header lines, or changes made in a
36077 .cindex "transport" "filter"
36078 .cindex "filter" "transport filter"
36079 transport filter. If &%size_addition%& is set negative, the use of SIZE is
36080 suppressed.
36081
36082 If the remote server advertises support for PIPELINING, Exim uses the
36083 pipelining extension to SMTP (RFC 2197) to reduce the number of TCP/IP packets
36084 required for the transaction.
36085
36086 If the remote server advertises support for the STARTTLS command, and Exim
36087 was built to support TLS encryption, it tries to start a TLS session unless the
36088 server matches &%hosts_avoid_tls%&. See chapter &<<CHAPTLS>>& for more details.
36089 Either a match in that or &%hosts_verify_avoid_tls%& apply when the transport
36090 is called for verification.
36091
36092 If the remote server advertises support for the AUTH command, Exim scans
36093 the authenticators configuration for any suitable client settings, as described
36094 in chapter &<<CHAPSMTPAUTH>>&.
36095
36096 .cindex "carriage return"
36097 .cindex "linefeed"
36098 Responses from the remote host are supposed to be terminated by CR followed by
36099 LF. However, there are known to be hosts that do not send CR characters, so in
36100 order to be able to interwork with such hosts, Exim treats LF on its own as a
36101 line terminator.
36102
36103 If a message contains a number of different addresses, all those with the same
36104 characteristics (for example, the same envelope sender) that resolve to the
36105 same set of hosts, in the same order, are sent in a single SMTP transaction,
36106 even if they are for different domains, unless there are more than the setting
36107 of the &%max_rcpt%&s option in the &(smtp)& transport allows, in which case
36108 they are split into groups containing no more than &%max_rcpt%&s addresses
36109 each. If &%remote_max_parallel%& is greater than one, such groups may be sent
36110 in parallel sessions. The order of hosts with identical MX values is not
36111 significant when checking whether addresses can be batched in this way.
36112
36113 When the &(smtp)& transport suffers a temporary failure that is not
36114 message-related, Exim updates its transport-specific database, which contains
36115 records indexed by host name that remember which messages are waiting for each
36116 particular host. It also updates the retry database with new retry times.
36117
36118 .cindex "hints database" "retry keys"
36119 Exim's retry hints are based on host name plus IP address, so if one address of
36120 a multi-homed host is broken, it will soon be skipped most of the time.
36121 See the next section for more detail about error handling.
36122
36123 .cindex "SMTP" "passed connection"
36124 .cindex "SMTP" "batching over TCP/IP"
36125 When a message is successfully delivered over a TCP/IP SMTP connection, Exim
36126 looks in the hints database for the transport to see if there are any queued
36127 messages waiting for the host to which it is connected. If it finds one, it
36128 creates a new Exim process using the &%-MC%& option (which can only be used by
36129 a process running as root or the Exim user) and passes the TCP/IP socket to it
36130 so that it can deliver another message using the same socket. The new process
36131 does only those deliveries that are routed to the connected host, and may in
36132 turn pass the socket on to a third process, and so on.
36133
36134 The &%connection_max_messages%& option of the &(smtp)& transport can be used to
36135 limit the number of messages sent down a single TCP/IP connection.
36136
36137 .cindex "asterisk" "after IP address"
36138 The second and subsequent messages delivered down an existing connection are
36139 identified in the main log by the addition of an asterisk after the closing
36140 square bracket of the IP address.
36141
36142
36143
36144
36145 .section "Errors in outgoing SMTP" "SECToutSMTPerr"
36146 .cindex "error" "in outgoing SMTP"
36147 .cindex "SMTP" "errors in outgoing"
36148 .cindex "host" "error"
36149 Three different kinds of error are recognized for outgoing SMTP: host errors,
36150 message errors, and recipient errors.
36151
36152 .vlist
36153 .vitem "&*Host errors*&"
36154 A host error is not associated with a particular message or with a
36155 particular recipient of a message. The host errors are:
36156
36157 .ilist
36158 Connection refused or timed out,
36159 .next
36160 Any error response code on connection,
36161 .next
36162 Any error response code to EHLO or HELO,
36163 .next
36164 Loss of connection at any time, except after &"."&,
36165 .next
36166 I/O errors at any time,
36167 .next
36168 Timeouts during the session, other than in response to MAIL, RCPT or
36169 the &"."& at the end of the data.
36170 .endlist ilist
36171
36172 For a host error, a permanent error response on connection, or in response to
36173 EHLO, causes all addresses routed to the host to be failed. Any other host
36174 error causes all addresses to be deferred, and retry data to be created for the
36175 host. It is not tried again, for any message, until its retry time arrives. If
36176 the current set of addresses are not all delivered in this run (to some
36177 alternative host), the message is added to the list of those waiting for this
36178 host, so if it is still undelivered when a subsequent successful delivery is
36179 made to the host, it will be sent down the same SMTP connection.
36180
36181 .vitem "&*Message errors*&"
36182 .cindex "message" "error"
36183 A message error is associated with a particular message when sent to a
36184 particular host, but not with a particular recipient of the message. The
36185 message errors are:
36186
36187 .ilist
36188 Any error response code to MAIL, DATA, or the &"."& that terminates
36189 the data,
36190 .next
36191 Timeout after MAIL,
36192 .next
36193 Timeout or loss of connection after the &"."& that terminates the data. A
36194 timeout after the DATA command itself is treated as a host error, as is loss of
36195 connection at any other time.
36196 .endlist ilist
36197
36198 For a message error, a permanent error response (5&'xx'&) causes all addresses
36199 to be failed, and a delivery error report to be returned to the sender. A
36200 temporary error response (4&'xx'&), or one of the timeouts, causes all
36201 addresses to be deferred. Retry data is not created for the host, but instead,
36202 a retry record for the combination of host plus message id is created. The
36203 message is not added to the list of those waiting for this host. This ensures
36204 that the failing message will not be sent to this host again until the retry
36205 time arrives. However, other messages that are routed to the host are not
36206 affected, so if it is some property of the message that is causing the error,
36207 it will not stop the delivery of other mail.
36208
36209 If the remote host specified support for the SIZE parameter in its response
36210 to EHLO, Exim adds SIZE=&'nnn'& to the MAIL command, so an
36211 over-large message will cause a message error because the error arrives as a
36212 response to MAIL.
36213
36214 .vitem "&*Recipient errors*&"
36215 .cindex "recipient" "error"
36216 A recipient error is associated with a particular recipient of a message. The
36217 recipient errors are:
36218
36219 .ilist
36220 Any error response to RCPT,
36221 .next
36222 Timeout after RCPT.
36223 .endlist
36224
36225 For a recipient error, a permanent error response (5&'xx'&) causes the
36226 recipient address to be failed, and a bounce message to be returned to the
36227 sender. A temporary error response (4&'xx'&) or a timeout causes the failing
36228 address to be deferred, and routing retry data to be created for it. This is
36229 used to delay processing of the address in subsequent queue runs, until its
36230 routing retry time arrives. This applies to all messages, but because it
36231 operates only in queue runs, one attempt will be made to deliver a new message
36232 to the failing address before the delay starts to operate. This ensures that,
36233 if the failure is really related to the message rather than the recipient
36234 (&"message too big for this recipient"& is a possible example), other messages
36235 have a chance of getting delivered. If a delivery to the address does succeed,
36236 the retry information gets cleared, so all stuck messages get tried again, and
36237 the retry clock is reset.
36238
36239 The message is not added to the list of those waiting for this host. Use of the
36240 host for other messages is unaffected, and except in the case of a timeout,
36241 other recipients are processed independently, and may be successfully delivered
36242 in the current SMTP session. After a timeout it is of course impossible to
36243 proceed with the session, so all addresses get deferred. However, those other
36244 than the one that failed do not suffer any subsequent retry delays. Therefore,
36245 if one recipient is causing trouble, the others have a chance of getting
36246 through when a subsequent delivery attempt occurs before the failing
36247 recipient's retry time.
36248 .endlist
36249
36250 In all cases, if there are other hosts (or IP addresses) available for the
36251 current set of addresses (for example, from multiple MX records), they are
36252 tried in this run for any undelivered addresses, subject of course to their
36253 own retry data. In other words, recipient error retry data does not take effect
36254 until the next delivery attempt.
36255
36256 Some hosts have been observed to give temporary error responses to every
36257 MAIL command at certain times (&"insufficient space"& has been seen). It
36258 would be nice if such circumstances could be recognized, and defer data for the
36259 host itself created, but this is not possible within the current Exim design.
36260 What actually happens is that retry data for every (host, message) combination
36261 is created.
36262
36263 The reason that timeouts after MAIL and RCPT are treated specially is that
36264 these can sometimes arise as a result of the remote host's verification
36265 procedures. Exim makes this assumption, and treats them as if a temporary error
36266 response had been received. A timeout after &"."& is treated specially because
36267 it is known that some broken implementations fail to recognize the end of the
36268 message if the last character of the last line is a binary zero. Thus, it is
36269 helpful to treat this case as a message error.
36270
36271 Timeouts at other times are treated as host errors, assuming a problem with the
36272 host, or the connection to it. If a timeout after MAIL, RCPT,
36273 or &"."& is really a connection problem, the assumption is that at the next try
36274 the timeout is likely to occur at some other point in the dialogue, causing it
36275 then to be treated as a host error.
36276
36277 There is experimental evidence that some MTAs drop the connection after the
36278 terminating &"."& if they do not like the contents of the message for some
36279 reason, in contravention of the RFC, which indicates that a 5&'xx'& response
36280 should be given. That is why Exim treats this case as a message rather than a
36281 host error, in order not to delay other messages to the same host.
36282
36283
36284
36285
36286 .section "Incoming SMTP messages over TCP/IP" "SECID233"
36287 .cindex "SMTP" "incoming over TCP/IP"
36288 .cindex "incoming SMTP over TCP/IP"
36289 .cindex "inetd"
36290 .cindex "daemon"
36291 Incoming SMTP messages can be accepted in one of two ways: by running a
36292 listening daemon, or by using &'inetd'&. In the latter case, the entry in
36293 &_/etc/inetd.conf_& should be like this:
36294 .code
36295 smtp stream tcp nowait exim /opt/exim/bin/exim in.exim -bs
36296 .endd
36297 Exim distinguishes between this case and the case of a locally running user
36298 agent using the &%-bs%& option by checking whether or not the standard input is
36299 a socket. When it is, either the port must be privileged (less than 1024), or
36300 the caller must be root or the Exim user. If any other user passes a socket
36301 with an unprivileged port number, Exim prints a message on the standard error
36302 stream and exits with an error code.
36303
36304 By default, Exim does not make a log entry when a remote host connects or
36305 disconnects (either via the daemon or &'inetd'&), unless the disconnection is
36306 unexpected. It can be made to write such log entries by setting the
36307 &%smtp_connection%& log selector.
36308
36309 .cindex "carriage return"
36310 .cindex "linefeed"
36311 Commands from the remote host are supposed to be terminated by CR followed by
36312 LF. However, there are known to be hosts that do not send CR characters. In
36313 order to be able to interwork with such hosts, Exim treats LF on its own as a
36314 line terminator.
36315 Furthermore, because common code is used for receiving messages from all
36316 sources, a CR on its own is also interpreted as a line terminator. However, the
36317 sequence &"CR, dot, CR"& does not terminate incoming SMTP data.
36318
36319 .cindex "EHLO" "invalid data"
36320 .cindex "HELO" "invalid data"
36321 One area that sometimes gives rise to problems concerns the EHLO or
36322 HELO commands. Some clients send syntactically invalid versions of these
36323 commands, which Exim rejects by default. (This is nothing to do with verifying
36324 the data that is sent, so &%helo_verify_hosts%& is not relevant.) You can tell
36325 Exim not to apply a syntax check by setting &%helo_accept_junk_hosts%& to
36326 match the broken hosts that send invalid commands.
36327
36328 .cindex "SIZE option on MAIL command"
36329 .cindex "MAIL" "SIZE option"
36330 The amount of disk space available is checked whenever SIZE is received on
36331 a MAIL command, independently of whether &%message_size_limit%& or
36332 &%check_spool_space%& is configured, unless &%smtp_check_spool_space%& is set
36333 false. A temporary error is given if there is not enough space. If
36334 &%check_spool_space%& is set, the check is for that amount of space plus the
36335 value given with SIZE, that is, it checks that the addition of the incoming
36336 message will not reduce the space below the threshold.
36337
36338 When a message is successfully received, Exim includes the local message id in
36339 its response to the final &"."& that terminates the data. If the remote host
36340 logs this text it can help with tracing what has happened to a message.
36341
36342 The Exim daemon can limit the number of simultaneous incoming connections it is
36343 prepared to handle (see the &%smtp_accept_max%& option). It can also limit the
36344 number of simultaneous incoming connections from a single remote host (see the
36345 &%smtp_accept_max_per_host%& option). Additional connection attempts are
36346 rejected using the SMTP temporary error code 421.
36347
36348 The Exim daemon does not rely on the SIGCHLD signal to detect when a
36349 subprocess has finished, as this can get lost at busy times. Instead, it looks
36350 for completed subprocesses every time it wakes up. Provided there are other
36351 things happening (new incoming calls, starts of queue runs), completed
36352 processes will be noticed and tidied away. On very quiet systems you may
36353 sometimes see a &"defunct"& Exim process hanging about. This is not a problem;
36354 it will be noticed when the daemon next wakes up.
36355
36356 When running as a daemon, Exim can reserve some SMTP slots for specific hosts,
36357 and can also be set up to reject SMTP calls from non-reserved hosts at times of
36358 high system load &-- for details see the &%smtp_accept_reserve%&,
36359 &%smtp_load_reserve%&, and &%smtp_reserve_hosts%& options. The load check
36360 applies in both the daemon and &'inetd'& cases.
36361
36362 Exim normally starts a delivery process for each message received, though this
36363 can be varied by means of the &%-odq%& command line option and the
36364 &%queue_only%&, &%queue_only_file%&, and &%queue_only_load%& options. The
36365 number of simultaneously running delivery processes started in this way from
36366 SMTP input can be limited by the &%smtp_accept_queue%& and
36367 &%smtp_accept_queue_per_connection%& options. When either limit is reached,
36368 subsequently received messages are just put on the input queue without starting
36369 a delivery process.
36370
36371 The controls that involve counts of incoming SMTP calls (&%smtp_accept_max%&,
36372 &%smtp_accept_queue%&, &%smtp_accept_reserve%&) are not available when Exim is
36373 started up from the &'inetd'& daemon, because in that case each connection is
36374 handled by an entirely independent Exim process. Control by load average is,
36375 however, available with &'inetd'&.
36376
36377 Exim can be configured to verify addresses in incoming SMTP commands as they
36378 are received. See chapter &<<CHAPACL>>& for details. It can also be configured
36379 to rewrite addresses at this time &-- before any syntax checking is done. See
36380 section &<<SECTrewriteS>>&.
36381
36382 Exim can also be configured to limit the rate at which a client host submits
36383 MAIL and RCPT commands in a single SMTP session. See the
36384 &%smtp_ratelimit_hosts%& option.
36385
36386
36387
36388 .section "Unrecognized SMTP commands" "SECID234"
36389 .cindex "SMTP" "unrecognized commands"
36390 If Exim receives more than &%smtp_max_unknown_commands%& unrecognized SMTP
36391 commands during a single SMTP connection, it drops the connection after sending
36392 the error response to the last command. The default value for
36393 &%smtp_max_unknown_commands%& is 3. This is a defence against some kinds of
36394 abuse that subvert web servers into making connections to SMTP ports; in these
36395 circumstances, a number of non-SMTP lines are sent first.
36396
36397
36398 .section "Syntax and protocol errors in SMTP commands" "SECID235"
36399 .cindex "SMTP" "syntax errors"
36400 .cindex "SMTP" "protocol errors"
36401 A syntax error is detected if an SMTP command is recognized, but there is
36402 something syntactically wrong with its data, for example, a malformed email
36403 address in a RCPT command. Protocol errors include invalid command
36404 sequencing such as RCPT before MAIL. If Exim receives more than
36405 &%smtp_max_synprot_errors%& such commands during a single SMTP connection, it
36406 drops the connection after sending the error response to the last command. The
36407 default value for &%smtp_max_synprot_errors%& is 3. This is a defence against
36408 broken clients that loop sending bad commands (yes, it has been seen).
36409
36410
36411
36412 .section "Use of non-mail SMTP commands" "SECID236"
36413 .cindex "SMTP" "non-mail commands"
36414 The &"non-mail"& SMTP commands are those other than MAIL, RCPT, and
36415 DATA. Exim counts such commands, and drops the connection if there are too
36416 many of them in a single SMTP session. This action catches some
36417 denial-of-service attempts and things like repeated failing AUTHs, or a mad
36418 client looping sending EHLO. The global option &%smtp_accept_max_nonmail%&
36419 defines what &"too many"& means. Its default value is 10.
36420
36421 When a new message is expected, one occurrence of RSET is not counted. This
36422 allows a client to send one RSET between messages (this is not necessary,
36423 but some clients do it). Exim also allows one uncounted occurrence of HELO
36424 or EHLO, and one occurrence of STARTTLS between messages. After
36425 starting up a TLS session, another EHLO is expected, and so it too is not
36426 counted.
36427
36428 The first occurrence of AUTH in a connection, or immediately following
36429 STARTTLS is also not counted. Otherwise, all commands other than MAIL,
36430 RCPT, DATA, and QUIT are counted.
36431
36432 You can control which hosts are subject to the limit set by
36433 &%smtp_accept_max_nonmail%& by setting
36434 &%smtp_accept_max_nonmail_hosts%&. The default value is &`*`&, which makes
36435 the limit apply to all hosts. This option means that you can exclude any
36436 specific badly-behaved hosts that you have to live with.
36437
36438
36439
36440
36441 .section "The VRFY and EXPN commands" "SECID237"
36442 When Exim receives a VRFY or EXPN command on a TCP/IP connection, it
36443 runs the ACL specified by &%acl_smtp_vrfy%& or &%acl_smtp_expn%& (as
36444 appropriate) in order to decide whether the command should be accepted or not.
36445
36446 .cindex "VRFY" "processing"
36447 When no ACL is defined for VRFY, or if it rejects without
36448 setting an explicit response code, the command is accepted
36449 (with a 252 SMTP response code)
36450 in order to support awkward clients that do a VRFY before every RCPT.
36451 When VRFY is accepted, it runs exactly the same code as when Exim is
36452 called with the &%-bv%& option, and returns 250/451/550
36453 SMTP response codes.
36454
36455 .cindex "EXPN" "processing"
36456 If no ACL for EXPN is defined, the command is rejected.
36457 When EXPN is accepted, a single-level expansion of the address is done.
36458 EXPN is treated as an &"address test"& (similar to the &%-bt%& option) rather
36459 than a verification (the &%-bv%& option). If an unqualified local part is given
36460 as the argument to EXPN, it is qualified with &%qualify_domain%&. Rejections
36461 of VRFY and EXPN commands are logged on the main and reject logs, and
36462 VRFY verification failures are logged on the main log for consistency with
36463 RCPT failures.
36464
36465
36466
36467 .section "The ETRN command" "SECTETRN"
36468 .cindex "ETRN" "processing"
36469 .cindex "ESMTP extensions" ETRN
36470 RFC 1985 describes an ESMTP command called ETRN that is designed to
36471 overcome the security problems of the TURN command (which has fallen into
36472 disuse). When Exim receives an ETRN command on a TCP/IP connection, it runs
36473 the ACL specified by &%acl_smtp_etrn%& in order to decide whether the command
36474 should be accepted or not. If no ACL is defined, the command is rejected.
36475
36476 The ETRN command is concerned with &"releasing"& messages that are awaiting
36477 delivery to certain hosts. As Exim does not organize its message queue by host,
36478 the only form of ETRN that is supported by default is the one where the
36479 text starts with the &"#"& prefix, in which case the remainder of the text is
36480 specific to the SMTP server. A valid ETRN command causes a run of Exim with
36481 the &%-R%& option to happen, with the remainder of the ETRN text as its
36482 argument. For example,
36483 .code
36484 ETRN #brigadoon
36485 .endd
36486 runs the command
36487 .code
36488 exim -R brigadoon
36489 .endd
36490 which causes a delivery attempt on all messages with undelivered addresses
36491 containing the text &"brigadoon"&. When &%smtp_etrn_serialize%& is set (the
36492 default), Exim prevents the simultaneous execution of more than one queue run
36493 for the same argument string as a result of an ETRN command. This stops
36494 a misbehaving client from starting more than one queue runner at once.
36495
36496 .cindex "hints database" "ETRN serialization"
36497 Exim implements the serialization by means of a hints database in which a
36498 record is written whenever a process is started by ETRN, and deleted when
36499 the process completes. However, Exim does not keep the SMTP session waiting for
36500 the ETRN process to complete. Once ETRN is accepted, the client is sent
36501 a &"success"& return code. Obviously there is scope for hints records to get
36502 left lying around if there is a system or program crash. To guard against this,
36503 Exim ignores any records that are more than six hours old.
36504
36505 .oindex "&%smtp_etrn_command%&"
36506 For more control over what ETRN does, the &%smtp_etrn_command%& option can
36507 used. This specifies a command that is run whenever ETRN is received,
36508 whatever the form of its argument. For
36509 example:
36510 .code
36511 smtp_etrn_command = /etc/etrn_command $domain \
36512                     $sender_host_address
36513 .endd
36514 .vindex "&$domain$&"
36515 The string is split up into arguments which are independently expanded. The
36516 expansion variable &$domain$& is set to the argument of the ETRN command,
36517 and no syntax checking is done on the contents of this argument. Exim does not
36518 wait for the command to complete, so its status code is not checked. Exim runs
36519 under its own uid and gid when receiving incoming SMTP, so it is not possible
36520 for it to change them before running the command.
36521
36522
36523
36524 .section "Incoming local SMTP" "SECID238"
36525 .cindex "SMTP" "local incoming"
36526 Some user agents use SMTP to pass messages to their local MTA using the
36527 standard input and output, as opposed to passing the envelope on the command
36528 line and writing the message to the standard input. This is supported by the
36529 &%-bs%& option. This form of SMTP is handled in the same way as incoming
36530 messages over TCP/IP (including the use of ACLs), except that the envelope
36531 sender given in a MAIL command is ignored unless the caller is trusted. In
36532 an ACL you can detect this form of SMTP input by testing for an empty host
36533 identification. It is common to have this as the first line in the ACL that
36534 runs for RCPT commands:
36535 .code
36536 accept hosts = :
36537 .endd
36538 This accepts SMTP messages from local processes without doing any other tests.
36539
36540
36541
36542 .section "Outgoing batched SMTP" "SECTbatchSMTP"
36543 .cindex "SMTP" "batched outgoing"
36544 .cindex "batched SMTP output"
36545 Both the &(appendfile)& and &(pipe)& transports can be used for handling
36546 batched SMTP. Each has an option called &%use_bsmtp%& which causes messages to
36547 be output in BSMTP format. No SMTP responses are possible for this form of
36548 delivery. All it is doing is using SMTP commands as a way of transmitting the
36549 envelope along with the message.
36550
36551 The message is written to the file or pipe preceded by the SMTP commands
36552 MAIL and RCPT, and followed by a line containing a single dot. Lines in
36553 the message that start with a dot have an extra dot added. The SMTP command
36554 HELO is not normally used. If it is required, the &%message_prefix%& option
36555 can be used to specify it.
36556
36557 Because &(appendfile)& and &(pipe)& are both local transports, they accept only
36558 one recipient address at a time by default. However, you can arrange for them
36559 to handle several addresses at once by setting the &%batch_max%& option. When
36560 this is done for BSMTP, messages may contain multiple RCPT commands. See
36561 chapter &<<CHAPbatching>>& for more details.
36562
36563 .vindex "&$host$&"
36564 When one or more addresses are routed to a BSMTP transport by a router that
36565 sets up a host list, the name of the first host on the list is available to the
36566 transport in the variable &$host$&. Here is an example of such a transport and
36567 router:
36568 .code
36569 begin routers
36570 route_append:
36571   driver = manualroute
36572   transport = smtp_appendfile
36573   route_list = domain.example  batch.host.example
36574
36575 begin transports
36576 smtp_appendfile:
36577   driver = appendfile
36578   directory = /var/bsmtp/$host
36579   batch_max = 1000
36580   use_bsmtp
36581   user = exim
36582 .endd
36583 This causes messages addressed to &'domain.example'& to be written in BSMTP
36584 format to &_/var/bsmtp/batch.host.example_&, with only a single copy of each
36585 message (unless there are more than 1000 recipients).
36586
36587
36588
36589 .section "Incoming batched SMTP" "SECTincomingbatchedSMTP"
36590 .cindex "SMTP" "batched incoming"
36591 .cindex "batched SMTP input"
36592 The &%-bS%& command line option causes Exim to accept one or more messages by
36593 reading SMTP on the standard input, but to generate no responses. If the caller
36594 is trusted, the senders in the MAIL commands are believed; otherwise the
36595 sender is always the caller of Exim. Unqualified senders and receivers are not
36596 rejected (there seems little point) but instead just get qualified. HELO
36597 and EHLO act as RSET; VRFY, EXPN, ETRN and  HELP, act
36598 as NOOP; QUIT quits.
36599
36600 Minimal policy checking is done for BSMTP input. Only the non-SMTP
36601 ACL is run in the same way as for non-SMTP local input.
36602
36603 If an error is detected while reading a message, including a missing &"."& at
36604 the end, Exim gives up immediately. It writes details of the error to the
36605 standard output in a stylized way that the calling program should be able to
36606 make some use of automatically, for example:
36607 .code
36608 554 Unexpected end of file
36609 Transaction started in line 10
36610 Error detected in line 14
36611 .endd
36612 It writes a more verbose version, for human consumption, to the standard error
36613 file, for example:
36614 .code
36615 An error was detected while processing a file of BSMTP input.
36616 The error message was:
36617
36618 501 '>' missing at end of address
36619
36620 The SMTP transaction started in line 10.
36621 The error was detected in line 12.
36622 The SMTP command at fault was:
36623
36624 rcpt to:<malformed@in.com.plete
36625
36626 1 previous message was successfully processed.
36627 The rest of the batch was abandoned.
36628 .endd
36629 The return code from Exim is zero only if there were no errors. It is 1 if some
36630 messages were accepted before an error was detected, and 2 if no messages were
36631 accepted.
36632 .ecindex IIDsmtpproc1
36633 .ecindex IIDsmtpproc2
36634
36635
36636
36637 . ////////////////////////////////////////////////////////////////////////////
36638 . ////////////////////////////////////////////////////////////////////////////
36639
36640 .chapter "Customizing bounce and warning messages" "CHAPemsgcust" &&&
36641          "Customizing messages"
36642 When a message fails to be delivered, or remains in the queue for more than a
36643 configured amount of time, Exim sends a message to the original sender, or
36644 to an alternative configured address. The text of these messages is built into
36645 the code of Exim, but it is possible to change it, either by adding a single
36646 string, or by replacing each of the paragraphs by text supplied in a file.
36647
36648 The &'From:'& and &'To:'& header lines are automatically generated; you can
36649 cause a &'Reply-To:'& line to be added by setting the &%errors_reply_to%&
36650 option. Exim also adds the line
36651 .code
36652 Auto-Submitted: auto-generated
36653 .endd
36654 to all warning and bounce messages,
36655
36656
36657 .section "Customizing bounce messages" "SECID239"
36658 .cindex "customizing" "bounce message"
36659 .cindex "bounce message" "customizing"
36660 If &%bounce_message_text%& is set, its contents are included in the default
36661 message immediately after &"This message was created automatically by mail
36662 delivery software."& The string is not expanded. It is not used if
36663 &%bounce_message_file%& is set.
36664
36665 When &%bounce_message_file%& is set, it must point to a template file for
36666 constructing error messages. The file consists of a series of text items,
36667 separated by lines consisting of exactly four asterisks. If the file cannot be
36668 opened, default text is used and a message is written to the main and panic
36669 logs. If any text item in the file is empty, default text is used for that
36670 item.
36671
36672 .vindex "&$bounce_recipient$&"
36673 .vindex "&$bounce_return_size_limit$&"
36674 Each item of text that is read from the file is expanded, and there are two
36675 expansion variables which can be of use here: &$bounce_recipient$& is set to
36676 the recipient of an error message while it is being created, and
36677 &$bounce_return_size_limit$& contains the value of the &%return_size_limit%&
36678 option, rounded to a whole number.
36679
36680 The items must appear in the file in the following order:
36681
36682 .ilist
36683 The first item is included in the headers, and should include at least a
36684 &'Subject:'& header. Exim does not check the syntax of these headers.
36685 .next
36686 The second item forms the start of the error message. After it, Exim lists the
36687 failing addresses with their error messages.
36688 .next
36689 The third item is used to introduce any text from pipe transports that is to be
36690 returned to the sender. It is omitted if there is no such text.
36691 .next
36692 The fourth, fifth and sixth items will be ignored and may be empty.
36693 The fields exist for back-compatibility
36694 .endlist
36695
36696 The default state (&%bounce_message_file%& unset) is equivalent to the
36697 following file, in which the sixth item is empty. The &'Subject:'& and some
36698 other lines have been split in order to fit them on the page:
36699 .code
36700 Subject: Mail delivery failed
36701   ${if eq{$sender_address}{$bounce_recipient}
36702   {: returning message to sender}}
36703 ****
36704 This message was created automatically by mail delivery software.
36705
36706 A message ${if eq{$sender_address}{$bounce_recipient}
36707   {that you sent }{sent by
36708
36709 <$sender_address>
36710
36711 }}could not be delivered to all of its recipients.
36712 This is a permanent error. The following address(es) failed:
36713 ****
36714 The following text was generated during the delivery attempt(s):
36715 ****
36716 ------ This is a copy of the message, including all the headers.
36717   ------
36718 ****
36719 ------ The body of the message is $message_size characters long;
36720   only the first
36721 ------ $bounce_return_size_limit or so are included here.
36722 ****
36723 .endd
36724 .section "Customizing warning messages" "SECTcustwarn"
36725 .cindex "customizing" "warning message"
36726 .cindex "warning of delay" "customizing the message"
36727 The option &%warn_message_file%& can be pointed at a template file for use when
36728 warnings about message delays are created. In this case there are only three
36729 text sections:
36730
36731 .ilist
36732 The first item is included in the headers, and should include at least a
36733 &'Subject:'& header. Exim does not check the syntax of these headers.
36734 .next
36735 The second item forms the start of the warning message. After it, Exim lists
36736 the delayed addresses.
36737 .next
36738 The third item then ends the message.
36739 .endlist
36740
36741 The default state is equivalent to the following file, except that some lines
36742 have been split here, in order to fit them on the page:
36743 .code
36744 Subject: Warning: message $message_exim_id delayed
36745   $warn_message_delay
36746 ****
36747 This message was created automatically by mail delivery software.
36748
36749 A message ${if eq{$sender_address}{$warn_message_recipients}
36750 {that you sent }{sent by
36751
36752 <$sender_address>
36753
36754 }}has not been delivered to all of its recipients after
36755 more than $warn_message_delay in the queue on $primary_hostname.
36756
36757 The message identifier is:     $message_exim_id
36758 The subject of the message is: $h_subject
36759 The date of the message is:    $h_date
36760
36761 The following address(es) have not yet been delivered:
36762 ****
36763 No action is required on your part. Delivery attempts will
36764 continue for some time, and this warning may be repeated at
36765 intervals if the message remains undelivered. Eventually the
36766 mail delivery software will give up, and when that happens,
36767 the message will be returned to you.
36768 .endd
36769 .vindex "&$warn_message_delay$&"
36770 .vindex "&$warn_message_recipients$&"
36771 However, in the default state the subject and date lines are omitted if no
36772 appropriate headers exist. During the expansion of this file,
36773 &$warn_message_delay$& is set to the delay time in one of the forms &"<&'n'&>
36774 minutes"& or &"<&'n'&> hours"&, and &$warn_message_recipients$& contains a list
36775 of recipients for the warning message. There may be more than one if there are
36776 multiple addresses with different &%errors_to%& settings on the routers that
36777 handled them.
36778
36779
36780
36781
36782 . ////////////////////////////////////////////////////////////////////////////
36783 . ////////////////////////////////////////////////////////////////////////////
36784
36785 .chapter "Some common configuration settings" "CHAPcomconreq"
36786 This chapter discusses some configuration settings that seem to be fairly
36787 common. More examples and discussion can be found in the Exim book.
36788
36789
36790
36791 .section "Sending mail to a smart host" "SECID240"
36792 .cindex "smart host" "example router"
36793 If you want to send all mail for non-local domains to a &"smart host"&, you
36794 should replace the default &(dnslookup)& router with a router which does the
36795 routing explicitly:
36796 .code
36797 send_to_smart_host:
36798   driver = manualroute
36799   route_list = !+local_domains smart.host.name
36800   transport = remote_smtp
36801 .endd
36802 You can use the smart host's IP address instead of the name if you wish.
36803 If you are using Exim only to submit messages to a smart host, and not for
36804 receiving incoming messages, you can arrange for it to do the submission
36805 synchronously by setting the &%mua_wrapper%& option (see chapter
36806 &<<CHAPnonqueueing>>&).
36807
36808
36809
36810
36811 .section "Using Exim to handle mailing lists" "SECTmailinglists"
36812 .cindex "mailing lists"
36813 Exim can be used to run simple mailing lists, but for large and/or complicated
36814 requirements, the use of additional specialized mailing list software such as
36815 Majordomo or Mailman is recommended.
36816
36817 The &(redirect)& router can be used to handle mailing lists where each list
36818 is maintained in a separate file, which can therefore be managed by an
36819 independent manager. The &%domains%& router option can be used to run these
36820 lists in a separate domain from normal mail. For example:
36821 .code
36822 lists:
36823   driver = redirect
36824   domains = lists.example
36825   file = ${lookup {$local_part} dsearch,ret=full {/usr/lists}}
36826   forbid_pipe
36827   forbid_file
36828   errors_to = ${quote_local_part:$local_part-request}@lists.example
36829   no_more
36830 .endd
36831 This router is skipped for domains other than &'lists.example'&. For addresses
36832 in that domain, it looks for a file that matches the local part. If there is no
36833 such file, the router declines, but because &%no_more%& is set, no subsequent
36834 routers are tried, and so the whole delivery fails.
36835
36836 The &%forbid_pipe%& and &%forbid_file%& options prevent a local part from being
36837 expanded into a filename or a pipe delivery, which is usually inappropriate in
36838 a mailing list.
36839
36840 .oindex "&%errors_to%&"
36841 The &%errors_to%& option specifies that any delivery errors caused by addresses
36842 taken from a mailing list are to be sent to the given address rather than the
36843 original sender of the message. However, before acting on this, Exim verifies
36844 the error address, and ignores it if verification fails.
36845
36846 For example, using the configuration above, mail sent to
36847 &'dicts@lists.example'& is passed on to those addresses contained in
36848 &_/usr/lists/dicts_&, with error reports directed to
36849 &'dicts-request@lists.example'&, provided that this address can be verified.
36850 There could be a file called &_/usr/lists/dicts-request_& containing
36851 the address(es) of this particular list's manager(s), but other approaches,
36852 such as setting up an earlier router (possibly using the &%local_part_prefix%&
36853 or &%local_part_suffix%& options) to handle addresses of the form
36854 &%owner-%&&'xxx'& or &%xxx-%&&'request'&, are also possible.
36855
36856
36857
36858 .section "Syntax errors in mailing lists" "SECID241"
36859 .cindex "mailing lists" "syntax errors in"
36860 If an entry in redirection data contains a syntax error, Exim normally defers
36861 delivery of the original address. That means that a syntax error in a mailing
36862 list holds up all deliveries to the list. This may not be appropriate when a
36863 list is being maintained automatically from data supplied by users, and the
36864 addresses are not rigorously checked.
36865
36866 If the &%skip_syntax_errors%& option is set, the &(redirect)& router just skips
36867 entries that fail to parse, noting the incident in the log. If in addition
36868 &%syntax_errors_to%& is set to a verifiable address, a message is sent to it
36869 whenever a broken address is skipped. It is usually appropriate to set
36870 &%syntax_errors_to%& to the same address as &%errors_to%&.
36871
36872
36873
36874 .section "Re-expansion of mailing lists" "SECID242"
36875 .cindex "mailing lists" "re-expansion of"
36876 Exim remembers every individual address to which a message has been delivered,
36877 in order to avoid duplication, but it normally stores only the original
36878 recipient addresses with a message. If all the deliveries to a mailing list
36879 cannot be done at the first attempt, the mailing list is re-expanded when the
36880 delivery is next tried. This means that alterations to the list are taken into
36881 account at each delivery attempt, so addresses that have been added to
36882 the list since the message arrived will therefore receive a copy of the
36883 message, even though it pre-dates their subscription.
36884
36885 If this behaviour is felt to be undesirable, the &%one_time%& option can be set
36886 on the &(redirect)& router. If this is done, any addresses generated by the
36887 router that fail to deliver at the first attempt are added to the message as
36888 &"top level"& addresses, and the parent address that generated them is marked
36889 &"delivered"&. Thus, expansion of the mailing list does not happen again at the
36890 subsequent delivery attempts. The disadvantage of this is that if any of the
36891 failing addresses are incorrect, correcting them in the file has no effect on
36892 pre-existing messages.
36893
36894 The original top-level address is remembered with each of the generated
36895 addresses, and is output in any log messages. However, any intermediate parent
36896 addresses are not recorded. This makes a difference to the log only if the
36897 &%all_parents%& selector is set, but for mailing lists there is normally only
36898 one level of expansion anyway.
36899
36900
36901
36902 .section "Closed mailing lists" "SECID243"
36903 .cindex "mailing lists" "closed"
36904 The examples so far have assumed open mailing lists, to which anybody may
36905 send mail. It is also possible to set up closed lists, where mail is accepted
36906 from specified senders only. This is done by making use of the generic
36907 &%senders%& option to restrict the router that handles the list.
36908
36909 The following example uses the same file as a list of recipients and as a list
36910 of permitted senders. It requires three routers:
36911 .code
36912 lists_request:
36913   driver = redirect
36914   domains = lists.example
36915   local_part_suffix = -request
36916   local_parts = ${lookup {$local_part} dsearch,filter=file {/usr/lists}}
36917   file = /usr/lists/${local_part_data}-request
36918   no_more
36919
36920 lists_post:
36921   driver = redirect
36922   domains = lists.example
36923   senders = ${if exists {/usr/lists/$local_part}\
36924              {lsearch;/usr/lists/$local_part}{*}}
36925   file = ${lookup {$local_part} dsearch,ret=full {/usr/lists}}
36926   forbid_pipe
36927   forbid_file
36928   errors_to = ${quote_local_part:$local_part-request}@lists.example
36929   no_more
36930
36931 lists_closed:
36932   driver = redirect
36933   domains = lists.example
36934   allow_fail
36935   data = :fail: $local_part@lists.example is a closed mailing list
36936 .endd
36937 All three routers have the same &%domains%& setting, so for any other domains,
36938 they are all skipped. The first router runs only if the local part ends in
36939 &%-request%&. It handles messages to the list manager(s) by means of an open
36940 mailing list.
36941
36942 The second router runs only if the &%senders%& precondition is satisfied. It
36943 checks for the existence of a list that corresponds to the local part, and then
36944 checks that the sender is on the list by means of a linear search. It is
36945 necessary to check for the existence of the file before trying to search it,
36946 because otherwise Exim thinks there is a configuration error. If the file does
36947 not exist, the expansion of &%senders%& is *, which matches all senders. This
36948 means that the router runs, but because there is no list, declines, and
36949 &%no_more%& ensures that no further routers are run. The address fails with an
36950 &"unrouteable address"& error.
36951
36952 The third router runs only if the second router is skipped, which happens when
36953 a mailing list exists, but the sender is not on it. This router forcibly fails
36954 the address, giving a suitable error message.
36955
36956
36957
36958
36959 .section "Variable Envelope Return Paths (VERP)" "SECTverp"
36960 .cindex "VERP"
36961 .cindex "Variable Envelope Return Paths"
36962 .cindex "envelope from"
36963 .cindex "envelope sender"
36964 Variable Envelope Return Paths &-- see &url(https://cr.yp.to/proto/verp.txt) &--
36965 are a way of helping mailing list administrators discover which subscription
36966 address is the cause of a particular delivery failure. The idea is to encode
36967 the original recipient address in the outgoing envelope sender address, so that
36968 if the message is forwarded by another host and then subsequently bounces, the
36969 original recipient can be extracted from the recipient address of the bounce.
36970
36971 .oindex &%errors_to%&
36972 .oindex &%return_path%&
36973 Envelope sender addresses can be modified by Exim using two different
36974 facilities: the &%errors_to%& option on a router (as shown in previous mailing
36975 list examples), or the &%return_path%& option on a transport. The second of
36976 these is effective only if the message is successfully delivered to another
36977 host; it is not used for errors detected on the local host (see the description
36978 of &%return_path%& in chapter &<<CHAPtransportgeneric>>&). Here is an example
36979 of the use of &%return_path%& to implement VERP on an &(smtp)& transport:
36980 .code
36981 verp_smtp:
36982   driver = smtp
36983   max_rcpt = 1
36984   return_path = \
36985     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
36986       {${quote_local_part:$1-request+$local_part=$domain}@your.dom.example}fail}
36987 .endd
36988 This has the effect of rewriting the return path (envelope sender) on outgoing
36989 SMTP messages, if the local part of the original return path ends in
36990 &"-request"&, and the domain is &'your.dom.example'&. The rewriting inserts the
36991 local part and domain of the recipient into the return path. Suppose, for
36992 example, that a message whose return path has been set to
36993 &'somelist-request@your.dom.example'& is sent to
36994 &'subscriber@other.dom.example'&. In the transport, the return path is
36995 rewritten as
36996 .code
36997 somelist-request+subscriber=other.dom.example@your.dom.example
36998 .endd
36999 .vindex "&$local_part$&"
37000 For this to work, you must tell Exim to send multiple copies of messages that
37001 have more than one recipient, so that each copy has just one recipient. This is
37002 achieved by setting &%max_rcpt%& to 1. Without this, a single copy of a message
37003 might be sent to several different recipients in the same domain, in which case
37004 &$local_part$& is not available in the transport, because it is not unique.
37005
37006 Unless your host is doing nothing but mailing list deliveries, you should
37007 probably use a separate transport for the VERP deliveries, so as not to use
37008 extra resources in making one-per-recipient copies for other deliveries. This
37009 can easily be done by expanding the &%transport%& option in the router:
37010 .code
37011 dnslookup:
37012   driver = dnslookup
37013   domains = ! +local_domains
37014   transport = \
37015     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
37016       {verp_smtp}{remote_smtp}}
37017   no_more
37018 .endd
37019 If you want to change the return path using &%errors_to%& in a router instead
37020 of using &%return_path%& in the transport, you need to set &%errors_to%& on all
37021 routers that handle mailing list addresses. This will ensure that all delivery
37022 errors, including those detected on the local host, are sent to the VERP
37023 address.
37024
37025 On a host that does no local deliveries and has no manual routing, only the
37026 &(dnslookup)& router needs to be changed. A special transport is not needed for
37027 SMTP deliveries. Every mailing list recipient has its own return path value,
37028 and so Exim must hand them to the transport one at a time. Here is an example
37029 of a &(dnslookup)& router that implements VERP:
37030 .code
37031 verp_dnslookup:
37032   driver = dnslookup
37033   domains = ! +local_domains
37034   transport = remote_smtp
37035   errors_to = \
37036     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}}
37037      {${quote_local_part:$1-request+$local_part=$domain}@your.dom.example}fail}
37038   no_more
37039 .endd
37040 Before you start sending out messages with VERPed return paths, you must also
37041 configure Exim to accept the bounce messages that come back to those paths.
37042 Typically this is done by setting a &%local_part_suffix%& option for a
37043 router, and using this to route the messages to wherever you want to handle
37044 them.
37045
37046 The overhead incurred in using VERP depends very much on the size of the
37047 message, the number of recipient addresses that resolve to the same remote
37048 host, and the speed of the connection over which the message is being sent. If
37049 a lot of addresses resolve to the same host and the connection is slow, sending
37050 a separate copy of the message for each address may take substantially longer
37051 than sending a single copy with many recipients (for which VERP cannot be
37052 used).
37053
37054
37055
37056
37057
37058
37059 .section "Virtual domains" "SECTvirtualdomains"
37060 .cindex "virtual domains"
37061 .cindex "domain" "virtual"
37062 The phrase &'virtual domain'& is unfortunately used with two rather different
37063 meanings:
37064
37065 .ilist
37066 A domain for which there are no real mailboxes; all valid local parts are
37067 aliases for other email addresses. Common examples are organizational
37068 top-level domains and &"vanity"& domains.
37069 .next
37070 One of a number of independent domains that are all handled by the same host,
37071 with mailboxes on that host, but where the mailbox owners do not necessarily
37072 have login accounts on that host.
37073 .endlist
37074
37075 The first usage is probably more common, and does seem more &"virtual"& than
37076 the second. This kind of domain can be handled in Exim with a straightforward
37077 aliasing router. One approach is to create a separate alias file for each
37078 virtual domain. Exim can test for the existence of the alias file to determine
37079 whether the domain exists. The &(dsearch)& lookup type is useful here, leading
37080 to a router of this form:
37081 .code
37082 virtual:
37083   driver = redirect
37084   domains = dsearch;/etc/mail/virtual
37085   data = ${lookup{$local_part}lsearch{/etc/mail/virtual/$domain_data}}
37086   no_more
37087 .endd
37088 .new
37089 The &%domains%& option specifies that the router is to be skipped, unless there
37090 is a file in the &_/etc/mail/virtual_& directory whose name is the same as the
37091 domain that is being processed.
37092 The &(dsearch)& lookup used results in an untainted version of &$domain$&
37093 being placed into the &$domain_data$& variable.
37094 .wen
37095
37096 When the router runs, it looks up the local
37097 part in the file to find a new address (or list of addresses). The &%no_more%&
37098 setting ensures that if the lookup fails (leading to &%data%& being an empty
37099 string), Exim gives up on the address without trying any subsequent routers.
37100
37101 This one router can handle all the virtual domains because the alias filenames
37102 follow a fixed pattern. Permissions can be arranged so that appropriate people
37103 can edit the different alias files. A successful aliasing operation results in
37104 a new envelope recipient address, which is then routed from scratch.
37105
37106 The other kind of &"virtual"& domain can also be handled in a straightforward
37107 way. One approach is to create a file for each domain containing a list of
37108 valid local parts, and use it in a router like this:
37109 .code
37110 my_domains:
37111   driver = accept
37112   domains = dsearch;/etc/mail/domains
37113   local_parts = lsearch;/etc/mail/domains/$domain
37114   transport = my_mailboxes
37115 .endd
37116 The address is accepted if there is a file for the domain, and the local part
37117 can be found in the file. The &%domains%& option is used to check for the
37118 file's existence because &%domains%& is tested before the &%local_parts%&
37119 option (see section &<<SECTrouprecon>>&). You cannot use &%require_files%&,
37120 because that option is tested after &%local_parts%&. The transport is as
37121 follows:
37122 .code
37123 my_mailboxes:
37124   driver = appendfile
37125   file = /var/mail/$domain/$local_part_data
37126   user = mail
37127 .endd
37128 This uses a directory of mailboxes for each domain. The &%user%& setting is
37129 required, to specify which uid is to be used for writing to the mailboxes.
37130
37131 The configuration shown here is just one example of how you might support this
37132 requirement. There are many other ways this kind of configuration can be set
37133 up, for example, by using a database instead of separate files to hold all the
37134 information about the domains.
37135
37136
37137
37138 .section "Multiple user mailboxes" "SECTmulbox"
37139 .cindex "multiple mailboxes"
37140 .cindex "mailbox" "multiple"
37141 .cindex "local part" "prefix"
37142 .cindex "local part" "suffix"
37143 Heavy email users often want to operate with multiple mailboxes, into which
37144 incoming mail is automatically sorted. A popular way of handling this is to
37145 allow users to use multiple sender addresses, so that replies can easily be
37146 identified. Users are permitted to add prefixes or suffixes to their local
37147 parts for this purpose. The wildcard facility of the generic router options
37148 &%local_part_prefix%& and &%local_part_suffix%& can be used for this. For
37149 example, consider this router:
37150 .code
37151 userforward:
37152   driver = redirect
37153   check_local_user
37154   file = $home/.forward
37155   local_part_suffix = -*
37156   local_part_suffix_optional
37157   allow_filter
37158 .endd
37159 .vindex "&$local_part_suffix$&"
37160 It runs a user's &_.forward_& file for all local parts of the form
37161 &'username-*'&. Within the filter file the user can distinguish different
37162 cases by testing the variable &$local_part_suffix$&. For example:
37163 .code
37164 if $local_part_suffix contains -special then
37165 save /home/$local_part/Mail/special
37166 endif
37167 .endd
37168 If the filter file does not exist, or does not deal with such addresses, they
37169 fall through to subsequent routers, and, assuming no subsequent use of the
37170 &%local_part_suffix%& option is made, they presumably fail. Thus, users have
37171 control over which suffixes are valid.
37172
37173 Alternatively, a suffix can be used to trigger the use of a different
37174 &_.forward_& file &-- which is the way a similar facility is implemented in
37175 another MTA:
37176 .code
37177 userforward:
37178   driver = redirect
37179   check_local_user
37180   local_part_suffix = -*
37181   local_part_suffix_optional
37182   file = ${lookup {.forward$local_part_suffix} dsearch,ret=full {$home} {$value}fail}
37183   allow_filter
37184 .endd
37185 If there is no suffix, &_.forward_& is used; if the suffix is &'-special'&, for
37186 example, &_.forward-special_& is used. Once again, if the appropriate file
37187 does not exist, or does not deal with the address, it is passed on to
37188 subsequent routers, which could, if required, look for an unqualified
37189 &_.forward_& file to use as a default.
37190
37191
37192
37193 .section "Simplified vacation processing" "SECID244"
37194 .cindex "vacation processing"
37195 The traditional way of running the &'vacation'& program is for a user to set up
37196 a pipe command in a &_.forward_& file
37197 (see section &<<SECTspecitredli>>& for syntax details).
37198 This is prone to error by inexperienced users. There are two features of Exim
37199 that can be used to make this process simpler for users:
37200
37201 .ilist
37202 A local part prefix such as &"vacation-"& can be specified on a router which
37203 can cause the message to be delivered directly to the &'vacation'& program, or
37204 alternatively can use Exim's &(autoreply)& transport. The contents of a user's
37205 &_.forward_& file are then much simpler. For example:
37206 .code
37207 spqr, vacation-spqr
37208 .endd
37209 .next
37210 The &%require_files%& generic router option can be used to trigger a
37211 vacation delivery by checking for the existence of a certain file in the
37212 user's home directory. The &%unseen%& generic option should also be used, to
37213 ensure that the original delivery also proceeds. In this case, all the user has
37214 to do is to create a file called, say, &_.vacation_&, containing a vacation
37215 message.
37216 .endlist
37217
37218 Another advantage of both these methods is that they both work even when the
37219 use of arbitrary pipes by users is locked out.
37220
37221
37222
37223 .section "Taking copies of mail" "SECID245"
37224 .cindex "message" "copying every"
37225 Some installations have policies that require archive copies of all messages to
37226 be made. A single copy of each message can easily be taken by an appropriate
37227 command in a system filter, which could, for example, use a different file for
37228 each day's messages.
37229
37230 There is also a shadow transport mechanism that can be used to take copies of
37231 messages that are successfully delivered by local transports, one copy per
37232 delivery. This could be used, &'inter alia'&, to implement automatic
37233 notification of delivery by sites that insist on doing such things.
37234
37235
37236
37237 .section "Intermittently connected hosts" "SECID246"
37238 .cindex "intermittently connected hosts"
37239 It has become quite common (because it is cheaper) for hosts to connect to the
37240 Internet periodically rather than remain connected all the time. The normal
37241 arrangement is that mail for such hosts accumulates on a system that is
37242 permanently connected.
37243
37244 Exim was designed for use on permanently connected hosts, and so it is not
37245 particularly well-suited to use in an intermittently connected environment.
37246 Nevertheless there are some features that can be used.
37247
37248
37249 .section "Exim on the upstream server host" "SECID247"
37250 It is tempting to arrange for incoming mail for the intermittently connected
37251 host to remain in Exim's queue until the client connects. However, this
37252 approach does not scale very well. Two different kinds of waiting message are
37253 being mixed up in the same queue &-- those that cannot be delivered because of
37254 some temporary problem, and those that are waiting for their destination host
37255 to connect. This makes it hard to manage the queue, as well as wasting
37256 resources, because each queue runner scans the entire queue.
37257
37258 A better approach is to separate off those messages that are waiting for an
37259 intermittently connected host. This can be done by delivering these messages
37260 into local files in batch SMTP, &"mailstore"&, or other envelope-preserving
37261 format, from where they are transmitted by other software when their
37262 destination connects. This makes it easy to collect all the mail for one host
37263 in a single directory, and to apply local timeout rules on a per-message basis
37264 if required.
37265
37266 On a very small scale, leaving the mail on Exim's queue can be made to work. If
37267 you are doing this, you should configure Exim with a long retry period for the
37268 intermittent host. For example:
37269 .code
37270 cheshire.wonderland.fict.example    *   F,5d,24h
37271 .endd
37272 This stops a lot of failed delivery attempts from occurring, but Exim remembers
37273 which messages it has queued up for that host. Once the intermittent host comes
37274 online, forcing delivery of one message (either by using the &%-M%& or &%-R%&
37275 options, or by using the ETRN SMTP command (see section &<<SECTETRN>>&)
37276 causes all the queued up messages to be delivered, often down a single SMTP
37277 connection. While the host remains connected, any new messages get delivered
37278 immediately.
37279
37280 If the connecting hosts do not have fixed IP addresses, that is, if a host is
37281 issued with a different IP address each time it connects, Exim's retry
37282 mechanisms on the holding host get confused, because the IP address is normally
37283 used as part of the key string for holding retry information. This can be
37284 avoided by unsetting &%retry_include_ip_address%& on the &(smtp)& transport.
37285 Since this has disadvantages for permanently connected hosts, it is best to
37286 arrange a separate transport for the intermittently connected ones.
37287
37288
37289
37290 .section "Exim on the intermittently connected client host" "SECID248"
37291 The value of &%smtp_accept_queue_per_connection%& should probably be
37292 increased, or even set to zero (that is, disabled) on the intermittently
37293 connected host, so that all incoming messages down a single connection get
37294 delivered immediately.
37295
37296 .cindex "SMTP" "passed connection"
37297 .cindex "SMTP" "multiple deliveries"
37298 .cindex "multiple SMTP deliveries"
37299 .cindex "first pass routing"
37300 Mail waiting to be sent from an intermittently connected host will probably
37301 not have been routed, because without a connection DNS lookups are not
37302 possible. This means that if a normal queue run is done at connection time,
37303 each message is likely to be sent in a separate SMTP session. This can be
37304 avoided by starting the queue run with a command line option beginning with
37305 &%-qq%& instead of &%-q%&. In this case, the queue is scanned twice. In the
37306 first pass, routing is done but no deliveries take place. The second pass is a
37307 normal queue run; since all the messages have been previously routed, those
37308 destined for the same host are likely to get sent as multiple deliveries in a
37309 single SMTP connection.
37310
37311
37312
37313 . ////////////////////////////////////////////////////////////////////////////
37314 . ////////////////////////////////////////////////////////////////////////////
37315
37316 .chapter "Using Exim as a non-queueing client" "CHAPnonqueueing" &&&
37317          "Exim as a non-queueing client"
37318 .cindex "client, non-queueing"
37319 .cindex "smart host" "suppressing queueing"
37320 On a personal computer, it is a common requirement for all
37321 email to be sent to a &"smart host"&. There are plenty of MUAs that can be
37322 configured to operate that way, for all the popular operating systems.
37323 However, there are some MUAs for Unix-like systems that cannot be so
37324 configured: they submit messages using the command line interface of
37325 &_/usr/sbin/sendmail_&. Furthermore, utility programs such as &'cron'& submit
37326 messages this way.
37327
37328 If the personal computer runs continuously, there is no problem, because it can
37329 run a conventional MTA that handles delivery to the smart host, and deal with
37330 any delays via its queueing mechanism. However, if the computer does not run
37331 continuously or runs different operating systems at different times, queueing
37332 email is not desirable.
37333
37334 There is therefore a requirement for something that can provide the
37335 &_/usr/sbin/sendmail_& interface but deliver messages to a smart host without
37336 any queueing or retrying facilities. Furthermore, the delivery to the smart
37337 host should be synchronous, so that if it fails, the sending MUA is immediately
37338 informed. In other words, we want something that extends an MUA that submits
37339 to a local MTA via the command line so that it behaves like one that submits
37340 to a remote smart host using TCP/SMTP.
37341
37342 There are a number of applications (for example, there is one called &'ssmtp'&)
37343 that do this job. However, people have found them to be lacking in various
37344 ways. For instance, you might want to allow aliasing and forwarding to be done
37345 before sending a message to the smart host.
37346
37347 Exim already had the necessary infrastructure for doing this job. Just a few
37348 tweaks were needed to make it behave as required, though it is somewhat of an
37349 overkill to use a fully-featured MTA for this purpose.
37350
37351 .oindex "&%mua_wrapper%&"
37352 There is a Boolean global option called &%mua_wrapper%&, defaulting false.
37353 Setting &%mua_wrapper%& true causes Exim to run in a special mode where it
37354 assumes that it is being used to &"wrap"& a command-line MUA in the manner
37355 just described. As well as setting &%mua_wrapper%&, you also need to provide a
37356 compatible router and transport configuration. Typically there will be just one
37357 router and one transport, sending everything to a smart host.
37358
37359 When run in MUA wrapping mode, the behaviour of Exim changes in the
37360 following ways:
37361
37362 .ilist
37363 A daemon cannot be run, nor will Exim accept incoming messages from &'inetd'&.
37364 In other words, the only way to submit messages is via the command line.
37365 .next
37366 Each message is synchronously delivered as soon as it is received (&%-odi%& is
37367 assumed). All queueing options (&%queue_only%&, &%queue_smtp_domains%&,
37368 &%control%& in an ACL, etc.) are quietly ignored. The Exim reception process
37369 does not finish until the delivery attempt is complete. If the delivery is
37370 successful, a zero return code is given.
37371 .next
37372 Address redirection is permitted, but the final routing for all addresses must
37373 be to the same remote transport, and to the same list of hosts. Furthermore,
37374 the return address (envelope sender) must be the same for all recipients, as
37375 must any added or deleted header lines. In other words, it must be possible to
37376 deliver the message in a single SMTP transaction, however many recipients there
37377 are.
37378 .next
37379 If these conditions are not met, or if routing any address results in a
37380 failure or defer status, or if Exim is unable to deliver all the recipients
37381 successfully to one of the smart hosts, delivery of the entire message fails.
37382 .next
37383 Because no queueing is allowed, all failures are treated as permanent; there
37384 is no distinction between 4&'xx'& and 5&'xx'& SMTP response codes from the
37385 smart host. Furthermore, because only a single yes/no response can be given to
37386 the caller, it is not possible to deliver to some recipients and not others. If
37387 there is an error (temporary or permanent) for any recipient, all are failed.
37388 .next
37389 If more than one smart host is listed, Exim will try another host after a
37390 connection failure or a timeout, in the normal way. However, if this kind of
37391 failure happens for all the hosts, the delivery fails.
37392 .next
37393 When delivery fails, an error message is written to the standard error stream
37394 (as well as to Exim's log), and Exim exits to the caller with a return code
37395 value 1. The message is expunged from Exim's spool files. No bounce messages
37396 are ever generated.
37397 .next
37398 No retry data is maintained, and any retry rules are ignored.
37399 .next
37400 A number of Exim options are overridden: &%deliver_drop_privilege%& is forced
37401 true, &%max_rcpt%& in the &(smtp)& transport is forced to &"unlimited"&,
37402 &%remote_max_parallel%& is forced to one, and fallback hosts are ignored.
37403 .endlist
37404
37405 The overall effect is that Exim makes a single synchronous attempt to deliver
37406 the message, failing if there is any kind of problem. Because no local
37407 deliveries are done and no daemon can be run, Exim does not need root
37408 privilege. It should be possible to run it setuid to &'exim'& instead of setuid
37409 to &'root'&. See section &<<SECTrunexiwitpri>>& for a general discussion about
37410 the advantages and disadvantages of running without root privilege.
37411
37412
37413
37414
37415 . ////////////////////////////////////////////////////////////////////////////
37416 . ////////////////////////////////////////////////////////////////////////////
37417
37418 .chapter "Log files" "CHAPlog"
37419 .scindex IIDloggen "log" "general description"
37420 .cindex "log" "types of"
37421 Exim writes three different logs, referred to as the main log, the reject log,
37422 and the panic log:
37423
37424 .ilist
37425 .cindex "main log"
37426 The main log records the arrival of each message and each delivery in a single
37427 line in each case. The format is as compact as possible, in an attempt to keep
37428 down the size of log files. Two-character flag sequences make it easy to pick
37429 out these lines. A number of other events are recorded in the main log. Some of
37430 them are optional, in which case the &%log_selector%& option controls whether
37431 they are included or not. A Perl script called &'eximstats'&, which does simple
37432 analysis of main log files, is provided in the Exim distribution (see section
37433 &<<SECTmailstat>>&).
37434 .next
37435 .cindex "reject log"
37436 The reject log records information from messages that are rejected as a result
37437 of a configuration option (that is, for policy reasons).
37438 The first line of each rejection is a copy of the line that is also written to
37439 the main log. Then, if the message's header has been read at the time the log
37440 is written, its contents are written to this log. Only the original header
37441 lines are available; header lines added by ACLs are not logged. You can use the
37442 reject log to check that your policy controls are working correctly; on a busy
37443 host this may be easier than scanning the main log for rejection messages. You
37444 can suppress the writing of the reject log by setting &%write_rejectlog%&
37445 false.
37446 .next
37447 .cindex "panic log"
37448 .cindex "system log"
37449 When certain serious errors occur, Exim writes entries to its panic log. If the
37450 error is sufficiently disastrous, Exim bombs out afterwards. Panic log entries
37451 are usually written to the main log as well, but can get lost amid the mass of
37452 other entries. The panic log should be empty under normal circumstances. It is
37453 therefore a good idea to check it (or to have a &'cron'& script check it)
37454 regularly, in order to become aware of any problems. When Exim cannot open its
37455 panic log, it tries as a last resort to write to the system log (syslog). This
37456 is opened with LOG_PID+LOG_CONS and the facility code of LOG_MAIL. The
37457 message itself is written at priority LOG_CRIT.
37458 .endlist
37459
37460 Every log line starts with a timestamp, in the format shown in the following
37461 example. Note that many of the examples shown in this chapter are line-wrapped.
37462 In the log file, this would be all on one line:
37463 .code
37464 2001-09-16 16:09:47 SMTP connection from [127.0.0.1] closed
37465   by QUIT
37466 .endd
37467 By default, the timestamps are in the local timezone. There are two
37468 ways of changing this:
37469
37470 .ilist
37471 You can set the &%timezone%& option to a different time zone; in particular, if
37472 you set
37473 .code
37474 timezone = UTC
37475 .endd
37476 the timestamps will be in UTC (aka GMT).
37477 .next
37478 If you set &%log_timezone%& true, the time zone is added to the timestamp, for
37479 example:
37480 .code
37481 2003-04-25 11:17:07 +0100 Start queue run: pid=12762
37482 .endd
37483 .endlist
37484
37485 .cindex "log" "process ids in"
37486 .cindex "pid (process id)" "in log lines"
37487 Exim does not include its process id in log lines by default, but you can
37488 request that it does so by specifying the &`pid`& log selector (see section
37489 &<<SECTlogselector>>&). When this is set, the process id is output, in square
37490 brackets, immediately after the time and date.
37491
37492
37493
37494
37495 .section "Where the logs are written" "SECTwhelogwri"
37496 .cindex "log" "destination"
37497 .cindex "log" "to file"
37498 .cindex "log" "to syslog"
37499 .cindex "syslog"
37500 The logs may be written to local files, or to syslog, or both. However, it
37501 should be noted that many syslog implementations use UDP as a transport, and
37502 are therefore unreliable in the sense that messages are not guaranteed to
37503 arrive at the loghost, nor is the ordering of messages necessarily maintained.
37504 It has also been reported that on large log files (tens of megabytes) you may
37505 need to tweak syslog to prevent it syncing the file with each write &-- on
37506 Linux this has been seen to make syslog take 90% plus of CPU time.
37507
37508 The destination for Exim's logs is configured by setting LOG_FILE_PATH in
37509 &_Local/Makefile_& or by setting &%log_file_path%& in the runtime
37510 configuration. This latter string is expanded, so it can contain, for example,
37511 references to the host name:
37512 .code
37513 log_file_path = /var/log/$primary_hostname/exim_%slog
37514 .endd
37515 It is generally advisable, however, to set the string in &_Local/Makefile_&
37516 rather than at runtime, because then the setting is available right from the
37517 start of Exim's execution. Otherwise, if there's something it wants to log
37518 before it has read the configuration file (for example, an error in the
37519 configuration file) it will not use the path you want, and may not be able to
37520 log at all.
37521
37522 The value of LOG_FILE_PATH or &%log_file_path%& is a colon-separated
37523 list, currently limited to at most two items. This is one option where the
37524 facility for changing a list separator may not be used. The list must always be
37525 colon-separated. If an item in the list is &"syslog"& then syslog is used;
37526 otherwise the item must either be an absolute path, containing &`%s`& at the
37527 point where &"main"&, &"reject"&, or &"panic"& is to be inserted, or be empty,
37528 implying the use of a default path.
37529
37530 When Exim encounters an empty item in the list, it searches the list defined by
37531 LOG_FILE_PATH, and uses the first item it finds that is neither empty nor
37532 &"syslog"&. This means that an empty item in &%log_file_path%& can be used to
37533 mean &"use the path specified at build time"&. It no such item exists, log
37534 files are written in the &_log_& subdirectory of the spool directory. This is
37535 equivalent to the setting:
37536 .code
37537 log_file_path = $spool_directory/log/%slog
37538 .endd
37539 If you do not specify anything at build time or runtime,
37540 or if you unset the option at runtime (i.e. &`log_file_path = `&),
37541 that is where the logs are written.
37542
37543 A log file path may also contain &`%D`& or &`%M`& if datestamped log filenames
37544 are in use &-- see section &<<SECTdatlogfil>>& below.
37545
37546 Here are some examples of possible settings:
37547 .display
37548 &`LOG_FILE_PATH=syslog                    `& syslog only
37549 &`LOG_FILE_PATH=:syslog                   `& syslog and default path
37550 &`LOG_FILE_PATH=syslog : /usr/log/exim_%s `& syslog and specified path
37551 &`LOG_FILE_PATH=/usr/log/exim_%s          `& specified path only
37552 .endd
37553 If there are more than two paths in the list, the first is used and a panic
37554 error is logged.
37555
37556
37557
37558 .section "Logging to local files that are periodically &""cycled""&" "SECID285"
37559 .cindex "log" "cycling local files"
37560 .cindex "cycling logs"
37561 .cindex "&'exicyclog'&"
37562 .cindex "log" "local files; writing to"
37563 Some operating systems provide centralized and standardized methods for cycling
37564 log files. For those that do not, a utility script called &'exicyclog'& is
37565 provided (see section &<<SECTcyclogfil>>&). This renames and compresses the
37566 main and reject logs each time it is called. The maximum number of old logs to
37567 keep can be set. It is suggested this script is run as a daily &'cron'& job.
37568
37569 An Exim delivery process opens the main log when it first needs to write to it,
37570 and it keeps the file open in case subsequent entries are required &-- for
37571 example, if a number of different deliveries are being done for the same
37572 message. However, remote SMTP deliveries can take a long time, and this means
37573 that the file may be kept open long after it is renamed if &'exicyclog'& or
37574 something similar is being used to rename log files on a regular basis. To
37575 ensure that a switch of log files is noticed as soon as possible, Exim calls
37576 &[stat()]& on the main log's name before reusing an open file, and if the file
37577 does not exist, or its inode has changed, the old file is closed and Exim
37578 tries to open the main log from scratch. Thus, an old log file may remain open
37579 for quite some time, but no Exim processes should write to it once it has been
37580 renamed.
37581
37582
37583
37584 .section "Datestamped log files" "SECTdatlogfil"
37585 .cindex "log" "datestamped files"
37586 Instead of cycling the main and reject log files by renaming them
37587 periodically, some sites like to use files whose names contain a datestamp,
37588 for example, &_mainlog-20031225_&. The datestamp is in the form &_yyyymmdd_& or
37589 &_yyyymm_&. Exim has support for this way of working. It is enabled by setting
37590 the &%log_file_path%& option to a path that includes &`%D`& or &`%M`& at the
37591 point where the datestamp is required. For example:
37592 .code
37593 log_file_path = /var/spool/exim/log/%slog-%D
37594 log_file_path = /var/log/exim-%s-%D.log
37595 log_file_path = /var/spool/exim/log/%D-%slog
37596 log_file_path = /var/log/exim/%s.%M
37597 .endd
37598 As before, &`%s`& is replaced by &"main"& or &"reject"&; the following are
37599 examples of names generated by the above examples:
37600 .code
37601 /var/spool/exim/log/mainlog-20021225
37602 /var/log/exim-reject-20021225.log
37603 /var/spool/exim/log/20021225-mainlog
37604 /var/log/exim/main.200212
37605 .endd
37606 When this form of log file is specified, Exim automatically switches to new
37607 files at midnight. It does not make any attempt to compress old logs; you
37608 will need to write your own script if you require this. You should not
37609 run &'exicyclog'& with this form of logging.
37610
37611 The location of the panic log is also determined by &%log_file_path%&, but it
37612 is not datestamped, because rotation of the panic log does not make sense.
37613 When generating the name of the panic log, &`%D`& or &`%M`& are removed from
37614 the string. In addition, if it immediately follows a slash, a following
37615 non-alphanumeric character is removed; otherwise a preceding non-alphanumeric
37616 character is removed. Thus, the four examples above would give these panic
37617 log names:
37618 .code
37619 /var/spool/exim/log/paniclog
37620 /var/log/exim-panic.log
37621 /var/spool/exim/log/paniclog
37622 /var/log/exim/panic
37623 .endd
37624
37625
37626 .section "Logging to syslog" "SECID249"
37627 .cindex "log" "syslog; writing to"
37628 The use of syslog does not change what Exim logs or the format of its messages,
37629 except in one respect. If &%syslog_timestamp%& is set false, the timestamps on
37630 Exim's log lines are omitted when these lines are sent to syslog. Apart from
37631 that, the same strings are written to syslog as to log files. The syslog
37632 &"facility"& is set to LOG_MAIL, and the program name to &"exim"&
37633 by default, but you can change these by setting the &%syslog_facility%& and
37634 &%syslog_processname%& options, respectively. If Exim was compiled with
37635 SYSLOG_LOG_PID set in &_Local/Makefile_& (this is the default in
37636 &_src/EDITME_&), then, on systems that permit it (all except ULTRIX), the
37637 LOG_PID flag is set so that the &[syslog()]& call adds the pid as well as
37638 the time and host name to each line.
37639 The three log streams are mapped onto syslog priorities as follows:
37640
37641 .ilist
37642 &'mainlog'& is mapped to LOG_INFO
37643 .next
37644 &'rejectlog'& is mapped to LOG_NOTICE
37645 .next
37646 &'paniclog'& is mapped to LOG_ALERT
37647 .endlist
37648
37649 Many log lines are written to both &'mainlog'& and &'rejectlog'&, and some are
37650 written to both &'mainlog'& and &'paniclog'&, so there will be duplicates if
37651 these are routed by syslog to the same place. You can suppress this duplication
37652 by setting &%syslog_duplication%& false.
37653
37654 Exim's log lines can sometimes be very long, and some of its &'rejectlog'&
37655 entries contain multiple lines when headers are included. To cope with both
37656 these cases, entries written to syslog are split into separate &[syslog()]&
37657 calls at each internal newline, and also after a maximum of
37658 870 data characters. (This allows for a total syslog line length of 1024, when
37659 additions such as timestamps are added.) If you are running a syslog
37660 replacement that can handle lines longer than the 1024 characters allowed by
37661 RFC 3164, you should set
37662 .code
37663 SYSLOG_LONG_LINES=yes
37664 .endd
37665 in &_Local/Makefile_& before building Exim. That stops Exim from splitting long
37666 lines, but it still splits at internal newlines in &'reject'& log entries.
37667
37668 To make it easy to re-assemble split lines later, each component of a split
37669 entry starts with a string of the form [<&'n'&>/<&'m'&>] or [<&'n'&>\<&'m'&>]
37670 where <&'n'&> is the component number and <&'m'&> is the total number of
37671 components in the entry. The / delimiter is used when the line was split
37672 because it was too long; if it was split because of an internal newline, the \
37673 delimiter is used. For example, supposing the length limit to be 50 instead of
37674 870, the following would be the result of a typical rejection message to
37675 &'mainlog'& (LOG_INFO), each line in addition being preceded by the time, host
37676 name, and pid as added by syslog:
37677 .code
37678 [1/5] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected from
37679 [2/5]  [127.0.0.1] (ph10): syntax error in 'From' header
37680 [3/5]  when scanning for sender: missing or malformed lo
37681 [4/5] cal part in "<>" (envelope sender is <ph10@cam.exa
37682 [5/5] mple>)
37683 .endd
37684 The same error might cause the following lines to be written to &"rejectlog"&
37685 (LOG_NOTICE):
37686 .code
37687 [1/18] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected fro
37688 [2/18] m [127.0.0.1] (ph10): syntax error in 'From' head
37689 [3/18] er when scanning for sender: missing or malformed
37690 [4/18]  local part in "<>" (envelope sender is <ph10@cam
37691 [5\18] .example>)
37692 [6\18] Recipients: ph10@some.domain.cam.example
37693 [7\18] P Received: from [127.0.0.1] (ident=ph10)
37694 [8\18]        by xxxxx.cam.example with smtp (Exim 4.00)
37695 [9\18]        id 16RdAL-0006pc-00
37696 [10/18]        for ph10@cam.example; Mon, 16 Sep 2002 16:
37697 [11\18] 09:43 +0100
37698 [12\18] F From: <>
37699 [13\18]   Subject: this is a test header
37700 [18\18]   X-something: this is another header
37701 [15/18] I Message-Id: <E16RdAL-0006pc-00@xxxxx.cam.examp
37702 [16\18] le>
37703 [17\18] B Bcc:
37704 [18/18]   Date: Mon, 16 Sep 2002 16:09:43 +0100
37705 .endd
37706 Log lines that are neither too long nor contain newlines are written to syslog
37707 without modification.
37708
37709 If only syslog is being used, the Exim monitor is unable to provide a log tail
37710 display, unless syslog is routing &'mainlog'& to a file on the local host and
37711 the environment variable EXIMON_LOG_FILE_PATH is set to tell the monitor
37712 where it is.
37713
37714
37715
37716 .section "Log line flags" "SECID250"
37717 One line is written to the main log for each message received, and for each
37718 successful, unsuccessful, and delayed delivery. These lines can readily be
37719 picked out by the distinctive two-character flags that immediately follow the
37720 timestamp. The flags are:
37721 .display
37722 &`<=`&     message arrival
37723 &`(=`&     message fakereject
37724 &`=>`&     normal message delivery
37725 &`->`&     additional address in same delivery
37726 &`>>`&     cutthrough message delivery
37727 &`*>`&     delivery suppressed by &%-N%&
37728 &`**`&     delivery failed; address bounced
37729 &`==`&     delivery deferred; temporary problem
37730 .endd
37731
37732
37733 .section "Logging message reception" "SECID251"
37734 .cindex "log" "reception line"
37735 The format of the single-line entry in the main log that is written for every
37736 message received is shown in the basic example below, which is split over
37737 several lines in order to fit it on the page:
37738 .code
37739 2002-10-31 08:57:53 16ZCW1-0005MB-00 <= kryten@dwarf.fict.example
37740   H=mailer.fict.example [192.168.123.123] U=exim
37741   P=smtp S=5678 id=<incoming message id>
37742 .endd
37743 The address immediately following &"<="& is the envelope sender address. A
37744 bounce message is shown with the sender address &"<>"&, and if it is locally
37745 generated, this is followed by an item of the form
37746 .code
37747 R=<message id>
37748 .endd
37749 which is a reference to the message that caused the bounce to be sent.
37750
37751 .cindex "HELO"
37752 .cindex "EHLO"
37753 For messages from other hosts, the H and U fields identify the remote host and
37754 record the RFC 1413 identity of the user that sent the message, if one was
37755 received. The number given in square brackets is the IP address of the sending
37756 host. If there is a single, unparenthesized  host name in the H field, as
37757 above, it has been verified to correspond to the IP address (see the
37758 &%host_lookup%& option). If the name is in parentheses, it was the name quoted
37759 by the remote host in the SMTP HELO or EHLO command, and has not been
37760 verified. If verification yields a different name to that given for HELO or
37761 EHLO, the verified name appears first, followed by the HELO or EHLO
37762 name in parentheses.
37763
37764 Misconfigured hosts (and mail forgers) sometimes put an IP address, with or
37765 without brackets, in the HELO or EHLO command, leading to entries in
37766 the log containing text like these examples:
37767 .code
37768 H=(10.21.32.43) [192.168.8.34]
37769 H=([10.21.32.43]) [192.168.8.34]
37770 .endd
37771 This can be confusing. Only the final address in square brackets can be relied
37772 on.
37773
37774 For locally generated messages (that is, messages not received over TCP/IP),
37775 the H field is omitted, and the U field contains the login name of the caller
37776 of Exim.
37777
37778 .cindex "authentication" "logging"
37779 .cindex "AUTH" "logging"
37780 For all messages, the P field specifies the protocol used to receive the
37781 message. This is the value that is stored in &$received_protocol$&. In the case
37782 of incoming SMTP messages, the value indicates whether or not any SMTP
37783 extensions (ESMTP), encryption, or authentication were used. If the SMTP
37784 session was encrypted, there is an additional X field that records the cipher
37785 suite that was used.
37786
37787 .cindex log protocol
37788 The protocol is set to &"esmtpsa"& or &"esmtpa"& for messages received from
37789 hosts that have authenticated themselves using the SMTP AUTH command. The first
37790 value is used when the SMTP connection was encrypted (&"secure"&). In this case
37791 there is an additional item A= followed by the name of the authenticator that
37792 was used. If an authenticated identification was set up by the authenticator's
37793 &%server_set_id%& option, this is logged too, separated by a colon from the
37794 authenticator name.
37795
37796 .cindex "size" "of message"
37797 The id field records the existing message id, if present. The size of the
37798 received message is given by the S field. When the message is delivered,
37799 headers may be removed or added, so that the size of delivered copies of the
37800 message may not correspond with this value (and indeed may be different to each
37801 other).
37802
37803 The &%log_selector%& option can be used to request the logging of additional
37804 data when a message is received. See section &<<SECTlogselector>>& below.
37805
37806
37807
37808 .section "Logging deliveries" "SECID252"
37809 .cindex "log" "delivery line"
37810 The format of the single-line entry in the main log that is written for every
37811 delivery is shown in one of the examples below, for local and remote
37812 deliveries, respectively. Each example has been split into multiple lines in order
37813 to fit it on the page:
37814 .code
37815 2002-10-31 08:59:13 16ZCW1-0005MB-00 => marv
37816   <marv@hitch.fict.example> R=localuser T=local_delivery
37817 2002-10-31 09:00:10 16ZCW1-0005MB-00 =>
37818   monk@holistic.fict.example R=dnslookup T=remote_smtp
37819   H=holistic.fict.example [192.168.234.234]
37820 .endd
37821 For ordinary local deliveries, the original address is given in angle brackets
37822 after the final delivery address, which might be a pipe or a file. If
37823 intermediate address(es) exist between the original and the final address, the
37824 last of these is given in parentheses after the final address. The R and T
37825 fields record the router and transport that were used to process the address.
37826
37827 If SMTP AUTH was used for the delivery there is an additional item A=
37828 followed by the name of the authenticator that was used.
37829 If an authenticated identification was set up by the authenticator's &%client_set_id%&
37830 option, this is logged too, separated by a colon from the authenticator name.
37831
37832 If a shadow transport was run after a successful local delivery, the log line
37833 for the successful delivery has an item added on the end, of the form
37834 .display
37835 &`ST=<`&&'shadow transport name'&&`>`&
37836 .endd
37837 If the shadow transport did not succeed, the error message is put in
37838 parentheses afterwards.
37839
37840 .cindex "asterisk" "after IP address"
37841 When more than one address is included in a single delivery (for example, two
37842 SMTP RCPT commands in one transaction) the second and subsequent addresses are
37843 flagged with &`->`& instead of &`=>`&. When two or more messages are delivered
37844 down a single SMTP connection, an asterisk follows the IP address in the log
37845 lines for the second and subsequent messages.
37846 When two or more messages are delivered down a single TLS connection, the
37847 DNS and some TLS-related information logged for the first message delivered
37848 will not be present in the log lines for the second and subsequent messages.
37849 TLS cipher information is still available.
37850
37851 .cindex "delivery" "cutthrough; logging"
37852 .cindex "cutthrough" "logging"
37853 When delivery is done in cutthrough mode it is flagged with &`>>`& and the log
37854 line precedes the reception line, since cutthrough waits for a possible
37855 rejection from the destination in case it can reject the sourced item.
37856
37857 The generation of a reply message by a filter file gets logged as a
37858 &"delivery"& to the addressee, preceded by &">"&.
37859
37860 The &%log_selector%& option can be used to request the logging of additional
37861 data when a message is delivered. See section &<<SECTlogselector>>& below.
37862
37863
37864 .section "Discarded deliveries" "SECID253"
37865 .cindex "discarded messages"
37866 .cindex "message" "discarded"
37867 .cindex "delivery" "discarded; logging"
37868 When a message is discarded as a result of the command &"seen finish"& being
37869 obeyed in a filter file which generates no deliveries, a log entry of the form
37870 .code
37871 2002-12-10 00:50:49 16auJc-0001UB-00 => discarded
37872   <low.club@bridge.example> R=userforward
37873 .endd
37874 is written, to record why no deliveries are logged. When a message is discarded
37875 because it is aliased to &":blackhole:"& the log line is like this:
37876 .code
37877 1999-03-02 09:44:33 10HmaX-0005vi-00 => :blackhole:
37878   <hole@nowhere.example> R=blackhole_router
37879 .endd
37880
37881
37882 .section "Deferred deliveries" "SECID254"
37883 When a delivery is deferred, a line of the following form is logged:
37884 .code
37885 2002-12-19 16:20:23 16aiQz-0002Q5-00 == marvin@endrest.example
37886   R=dnslookup T=smtp defer (146): Connection refused
37887 .endd
37888 In the case of remote deliveries, the error is the one that was given for the
37889 last IP address that was tried. Details of individual SMTP failures are also
37890 written to the log, so the above line would be preceded by something like
37891 .code
37892 2002-12-19 16:20:23 16aiQz-0002Q5-00 Failed to connect to
37893   mail1.endrest.example [192.168.239.239]: Connection refused
37894 .endd
37895 When a deferred address is skipped because its retry time has not been reached,
37896 a message is written to the log, but this can be suppressed by setting an
37897 appropriate value in &%log_selector%&.
37898
37899
37900
37901 .section "Delivery failures" "SECID255"
37902 .cindex "delivery" "failure; logging"
37903 If a delivery fails because an address cannot be routed, a line of the
37904 following form is logged:
37905 .code
37906 1995-12-19 16:20:23 0tRiQz-0002Q5-00 ** jim@trek99.example
37907   <jim@trek99.example>: unknown mail domain
37908 .endd
37909 If a delivery fails at transport time, the router and transport are shown, and
37910 the response from the remote host is included, as in this example:
37911 .code
37912 2002-07-11 07:14:17 17SXDU-000189-00 ** ace400@pb.example
37913   R=dnslookup T=remote_smtp: SMTP error from remote mailer
37914   after pipelined RCPT TO:<ace400@pb.example>: host
37915   pbmail3.py.example [192.168.63.111]: 553 5.3.0
37916   <ace400@pb.example>...Addressee unknown
37917 .endd
37918 The word &"pipelined"& indicates that the SMTP PIPELINING extension was being
37919 used. See &%hosts_avoid_esmtp%& in the &(smtp)& transport for a way of
37920 disabling PIPELINING. The log lines for all forms of delivery failure are
37921 flagged with &`**`&.
37922
37923
37924
37925 .section "Fake deliveries" "SECID256"
37926 .cindex "delivery" "fake; logging"
37927 If a delivery does not actually take place because the &%-N%& option has been
37928 used to suppress it, a normal delivery line is written to the log, except that
37929 &"=>"& is replaced by &"*>"&.
37930
37931
37932
37933 .section "Completion" "SECID257"
37934 A line of the form
37935 .code
37936 2002-10-31 09:00:11 16ZCW1-0005MB-00 Completed
37937 .endd
37938 is written to the main log when a message is about to be removed from the spool
37939 at the end of its processing.
37940
37941
37942
37943
37944 .section "Summary of Fields in Log Lines" "SECID258"
37945 .cindex "log" "summary of fields"
37946 A summary of the field identifiers that are used in log lines is shown in
37947 the following table:
37948 .display
37949 &`A   `&        authenticator name (and optional id and sender)
37950 &`C   `&        SMTP confirmation on delivery
37951 &`    `&        command list for &"no mail in SMTP session"&
37952 &`CV  `&        certificate verification status
37953 &`D   `&        duration of &"no mail in SMTP session"&
37954 &`DKIM`&        domain verified in incoming message
37955 &`DN  `&        distinguished name from peer certificate
37956 &`DS  `&        DNSSEC secured lookups
37957 &`DT  `&        on &`=>`&, &'=='& and &'**'& lines: time taken for, or to attempt, a delivery
37958 &`F   `&        sender address (on delivery lines)
37959 &`H   `&        host name and IP address
37960 &`I   `&        local interface used
37961 &`id  `&        message id (from header) for incoming message
37962 &`K   `&        CHUNKING extension used
37963 &`L   `&        on &`<=`& and &`=>`& lines: PIPELINING extension used
37964 &`M8S `&        8BITMIME status for incoming message
37965 &`P   `&        on &`<=`& lines: protocol used
37966 &`    `&        on &`=>`& and &`**`& lines: return path
37967 &`PRDR`&        PRDR extension used
37968 &`PRX `&        on &`<=`& and &`=>`& lines: proxy address
37969 &`Q   `&        alternate queue name
37970 &`QT  `&        on &`=>`& lines: time spent on queue so far
37971 &`    `&        on &"Completed"& lines: time spent on queue
37972 &`R   `&        on &`<=`& lines: reference for local bounce
37973 &`    `&        on &`=>`&  &`>>`& &`**`& and &`==`& lines: router name
37974 &`RT  `&        on &`<=`& lines: time taken for reception
37975 &`S   `&        size of message in bytes
37976 &`SNI `&        server name indication from TLS client hello
37977 &`ST  `&        shadow transport name
37978 &`T   `&        on &`<=`& lines: message subject (topic)
37979 &`TFO `&        connection took advantage of TCP Fast Open
37980 &`    `&        on &`=>`& &`**`& and &`==`& lines: transport name
37981 &`U   `&        local user or RFC 1413 identity
37982 &`X   `&        TLS cipher suite
37983 .endd
37984
37985
37986 .section "Other log entries" "SECID259"
37987 Various other types of log entry are written from time to time. Most should be
37988 self-explanatory. Among the more common are:
37989
37990 .ilist
37991 .cindex "retry" "time not reached"
37992 &'retry time not reached'&&~&~An address previously suffered a temporary error
37993 during routing or local delivery, and the time to retry has not yet arrived.
37994 This message is not written to an individual message log file unless it happens
37995 during the first delivery attempt.
37996 .next
37997 &'retry time not reached for any host'&&~&~An address previously suffered
37998 temporary errors during remote delivery, and the retry time has not yet arrived
37999 for any of the hosts to which it is routed.
38000 .next
38001 .cindex "spool directory" "file locked"
38002 &'spool file locked'&&~&~An attempt to deliver a message cannot proceed because
38003 some other Exim process is already working on the message. This can be quite
38004 common if queue running processes are started at frequent intervals. The
38005 &'exiwhat'& utility script can be used to find out what Exim processes are
38006 doing.
38007 .next
38008 .cindex "error" "ignored"
38009 &'error ignored'&&~&~There are several circumstances that give rise to this
38010 message:
38011 .olist
38012 Exim failed to deliver a bounce message whose age was greater than
38013 &%ignore_bounce_errors_after%&. The bounce was discarded.
38014 .next
38015 A filter file set up a delivery using the &"noerror"& option, and the delivery
38016 failed. The delivery was discarded.
38017 .next
38018 A delivery set up by a router configured with
38019 . ==== As this is a nested list, any displays it contains must be indented
38020 . ==== as otherwise they are too far to the left.
38021 .code
38022     errors_to = <>
38023 .endd
38024 failed. The delivery was discarded.
38025 .endlist olist
38026 .next
38027 .cindex DKIM "log line"
38028 &'DKIM: d='&&~&~Verbose results of a DKIM verification attempt, if enabled for
38029 logging and the message has a DKIM signature header.
38030 .endlist ilist
38031
38032
38033
38034
38035
38036 .section "Reducing or increasing what is logged" "SECTlogselector"
38037 .cindex "log" "selectors"
38038 By setting the &%log_selector%& global option, you can disable some of Exim's
38039 default logging, or you can request additional logging. The value of
38040 &%log_selector%& is made up of names preceded by plus or minus characters. For
38041 example:
38042 .code
38043 log_selector = +arguments -retry_defer
38044 .endd
38045 The list of optional log items is in the following table, with the default
38046 selection marked by asterisks:
38047 .display
38048 &` 8bitmime                   `&  received 8BITMIME status
38049 &`*acl_warn_skipped           `&  skipped &%warn%& statement in ACL
38050 &` address_rewrite            `&  address rewriting
38051 &` all_parents                `&  all parents in => lines
38052 &` arguments                  `&  command line arguments
38053 &`*connection_reject          `&  connection rejections
38054 &`*delay_delivery             `&  immediate delivery delayed
38055 &` deliver_time               `&  time taken to attempt delivery
38056 &` delivery_size              `&  add &`S=`&&'nnn'& to => lines
38057 &`*dkim                       `&  DKIM verified domain on <= lines
38058 &` dkim_verbose               `&  separate full DKIM verification result line, per signature
38059 &`*dnslist_defer              `&  defers of DNS list (aka RBL) lookups
38060 &` dnssec                     `&  DNSSEC secured lookups
38061 &`*etrn                       `&  ETRN commands
38062 &`*host_lookup_failed         `&  as it says
38063 &` ident_timeout              `&  timeout for ident connection
38064 &` incoming_interface         `&  local interface on <= and => lines
38065 &` incoming_port              `&  remote port on <= lines
38066 &`*lost_incoming_connection   `&  as it says (includes timeouts)
38067 &` millisec                   `&  millisecond timestamps and RT,QT,DT,D times
38068 &`*msg_id                     `&  on <= lines, Message-ID: header value
38069 &` msg_id_created             `&  on <= lines, Message-ID: header value when one had to be added
38070 &` outgoing_interface         `&  local interface on => lines
38071 &` outgoing_port              `&  add remote port to => lines
38072 &`*queue_run                  `&  start and end queue runs
38073 &` queue_time                 `&  time on queue for one recipient
38074 &` queue_time_overall         `&  time on queue for whole message
38075 &` pid                        `&  Exim process id
38076 &` pipelining                 `&  PIPELINING use, on <= and => lines
38077 &` proxy                      `&  proxy address on <= and => lines
38078 &` receive_time               `&  time taken to receive message
38079 &` received_recipients        `&  recipients on <= lines
38080 &` received_sender            `&  sender on <= lines
38081 &`*rejected_header            `&  header contents on reject log
38082 &`*retry_defer                `&  &"retry time not reached"&
38083 &` return_path_on_delivery    `&  put return path on => and ** lines
38084 &` sender_on_delivery         `&  add sender to => lines
38085 &`*sender_verify_fail         `&  sender verification failures
38086 &`*size_reject                `&  rejection because too big
38087 &`*skip_delivery              `&  delivery skipped in a queue run
38088 &`*smtp_confirmation          `&  SMTP confirmation on => lines
38089 &` smtp_connection            `&  incoming SMTP connections
38090 &` smtp_incomplete_transaction`&  incomplete SMTP transactions
38091 &` smtp_mailauth              `&  AUTH argument to MAIL commands
38092 &` smtp_no_mail               `&  session with no MAIL commands
38093 &` smtp_protocol_error        `&  SMTP protocol errors
38094 &` smtp_syntax_error          `&  SMTP syntax errors
38095 &` subject                    `&  contents of &'Subject:'& on <= lines
38096 &`*tls_certificate_verified   `&  certificate verification status
38097 &`*tls_cipher                 `&  TLS cipher suite on <= and => lines
38098 &` tls_peerdn                 `&  TLS peer DN on <= and => lines
38099 &` tls_sni                    `&  TLS SNI on <= lines
38100 &` unknown_in_list            `&  DNS lookup failed in list match
38101
38102 &` all                        `&  all of the above
38103 .endd
38104 See also the &%slow_lookup_log%& main configuration option,
38105 section &<<SECID99>>&
38106
38107 More details on each of these items follows:
38108
38109 .ilist
38110 .cindex "8BITMIME"
38111 .cindex "log" "8BITMIME"
38112 &%8bitmime%&: This causes Exim to log any 8BITMIME status of received messages,
38113 which may help in tracking down interoperability issues with ancient MTAs
38114 that are not 8bit clean.  This is added to the &"<="& line, tagged with
38115 &`M8S=`& and a value of &`0`&, &`7`& or &`8`&, corresponding to "not given",
38116 &`7BIT`& and &`8BITMIME`& respectively.
38117 .next
38118 .cindex "&%warn%& ACL verb" "log when skipping"
38119 &%acl_warn_skipped%&: When an ACL &%warn%& statement is skipped because one of
38120 its conditions cannot be evaluated, a log line to this effect is written if
38121 this log selector is set.
38122 .next
38123 .cindex "log" "rewriting"
38124 .cindex "rewriting" "logging"
38125 &%address_rewrite%&: This applies both to global rewrites and per-transport
38126 rewrites, but not to rewrites in filters run as an unprivileged user (because
38127 such users cannot access the log).
38128 .next
38129 .cindex "log" "full parentage"
38130 &%all_parents%&: Normally only the original and final addresses are logged on
38131 delivery lines; with this selector, intermediate parents are given in
38132 parentheses between them.
38133 .next
38134 .cindex "log" "Exim arguments"
38135 .cindex "Exim arguments, logging"
38136 &%arguments%&: This causes Exim to write the arguments with which it was called
38137 to the main log, preceded by the current working directory. This is a debugging
38138 feature, added to make it easier to find out how certain MUAs call
38139 &_/usr/sbin/sendmail_&. The logging does not happen if Exim has given up root
38140 privilege because it was called with the &%-C%& or &%-D%& options. Arguments
38141 that are empty or that contain white space are quoted. Non-printing characters
38142 are shown as escape sequences. This facility cannot log unrecognized arguments,
38143 because the arguments are checked before the configuration file is read. The
38144 only way to log such cases is to interpose a script such as &_util/logargs.sh_&
38145 between the caller and Exim.
38146 .next
38147 .cindex "log" "connection rejections"
38148 &%connection_reject%&: A log entry is written whenever an incoming SMTP
38149 connection is rejected, for whatever reason.
38150 .next
38151 .cindex "log" "delayed delivery"
38152 .cindex "delayed delivery, logging"
38153 &%delay_delivery%&: A log entry is written whenever a delivery process is not
38154 started for an incoming message because the load is too high or too many
38155 messages were received on one connection. Logging does not occur if no delivery
38156 process is started because &%queue_only%& is set or &%-odq%& was used.
38157 .next
38158 .cindex "log" "delivery duration"
38159 &%deliver_time%&: For each delivery, the amount of real time it has taken to
38160 perform the actual delivery is logged as DT=<&'time'&>, for example, &`DT=1s`&.
38161 If millisecond logging is enabled, short times will be shown with greater
38162 precision, eg. &`DT=0.304s`&.
38163 .next
38164 .cindex "log" "message size on delivery"
38165 .cindex "size" "of message"
38166 &%delivery_size%&: For each delivery, the size of message delivered is added to
38167 the &"=>"& line, tagged with S=.
38168 .next
38169 .cindex log "DKIM verification"
38170 .cindex DKIM "verification logging"
38171 &%dkim%&: For message acceptance log lines, when an DKIM signature in the header
38172 verifies successfully a tag of DKIM is added, with one of the verified domains.
38173 .next
38174 .cindex log "DKIM verification"
38175 .cindex DKIM "verification logging"
38176 &%dkim_verbose%&: A log entry is written for each attempted DKIM verification.
38177 .next
38178 .cindex "log" "dnslist defer"
38179 .cindex "DNS list" "logging defer"
38180 .cindex "black list (DNS)"
38181 &%dnslist_defer%&: A log entry is written if an attempt to look up a host in a
38182 DNS black list suffers a temporary error.
38183 .next
38184 .cindex log dnssec
38185 .cindex dnssec logging
38186 &%dnssec%&: For message acceptance and (attempted) delivery log lines, when
38187 dns lookups gave secure results a tag of DS is added.
38188 For acceptance this covers the reverse and forward lookups for host name verification.
38189 It does not cover helo-name verification.
38190 For delivery this covers the SRV, MX, A and/or AAAA lookups.
38191 .next
38192 .cindex "log" "ETRN commands"
38193 .cindex "ETRN" "logging"
38194 &%etrn%&: Every valid ETRN command that is received is logged, before the ACL
38195 is run to determine whether or not it is actually accepted. An invalid ETRN
38196 command, or one received within a message transaction is not logged by this
38197 selector (see &%smtp_syntax_error%& and &%smtp_protocol_error%&).
38198 .next
38199 .cindex "log" "host lookup failure"
38200 &%host_lookup_failed%&: When a lookup of a host's IP addresses fails to find
38201 any addresses, or when a lookup of an IP address fails to find a host name, a
38202 log line is written. This logging does not apply to direct DNS lookups when
38203 routing email addresses, but it does apply to &"byname"& lookups.
38204 .next
38205 .cindex "log" "ident timeout"
38206 .cindex "RFC 1413" "logging timeout"
38207 &%ident_timeout%&: A log line is written whenever an attempt to connect to a
38208 client's ident port times out.
38209 .next
38210 .cindex "log" "incoming interface"
38211 .cindex "log" "local interface"
38212 .cindex "log" "local address and port"
38213 .cindex "TCP/IP" "logging local address and port"
38214 .cindex "interface" "logging"
38215 &%incoming_interface%&: The interface on which a message was received is added
38216 to the &"<="& line as an IP address in square brackets, tagged by I= and
38217 followed by a colon and the port number. The local interface and port are also
38218 added to other SMTP log lines, for example, &"SMTP connection from"&, to
38219 rejection lines, and (despite the name) to outgoing &"=>"& and &"->"& lines.
38220 The latter can be disabled by turning off the &%outgoing_interface%& option.
38221 .next
38222 .cindex log "incoming proxy address"
38223 .cindex proxy "logging proxy address"
38224 .cindex "TCP/IP" "logging proxy address"
38225 &%proxy%&: The internal (closest to the system running Exim) IP address
38226 of the proxy, tagged by PRX=, on the &"<="& line for a message accepted
38227 on a proxied connection
38228 or the &"=>"& line for a message delivered on a proxied connection.
38229 See &<<SECTproxyInbound>>& for more information.
38230 .next
38231 .cindex "log" "incoming remote port"
38232 .cindex "port" "logging remote"
38233 .cindex "TCP/IP" "logging incoming remote port"
38234 .vindex "&$sender_fullhost$&"
38235 .vindex "&$sender_rcvhost$&"
38236 &%incoming_port%&: The remote port number from which a message was received is
38237 added to log entries and &'Received:'& header lines, following the IP address
38238 in square brackets, and separated from it by a colon. This is implemented by
38239 changing the value that is put in the &$sender_fullhost$& and
38240 &$sender_rcvhost$& variables. Recording the remote port number has become more
38241 important with the widening use of NAT (see RFC 2505).
38242 .next
38243 .cindex "log" "dropped connection"
38244 &%lost_incoming_connection%&: A log line is written when an incoming SMTP
38245 connection is unexpectedly dropped.
38246 .next
38247 .cindex "log" "millisecond timestamps"
38248 .cindex millisecond logging
38249 .cindex timestamps "millisecond, in logs"
38250 &%millisec%&: Timestamps have a period and three decimal places of finer granularity
38251 appended to the seconds value.
38252 .next
38253 .cindex "log" "message id"
38254 &%msg_id%&: The value of the Message-ID: header.
38255 .next
38256 &%msg_id_created%&: The value of the Message-ID: header, when one had to be created.
38257 This will be either because the message is a bounce, or was submitted locally
38258 (submission mode) without one.
38259 The field identifier will have an asterix appended: &"id*="&.
38260 .next
38261 .cindex "log" "outgoing interface"
38262 .cindex "log" "local interface"
38263 .cindex "log" "local address and port"
38264 .cindex "TCP/IP" "logging local address and port"
38265 .cindex "interface" "logging"
38266 &%outgoing_interface%&: If &%incoming_interface%& is turned on, then the
38267 interface on which a message was sent is added to delivery lines as an I= tag
38268 followed by IP address in square brackets. You can disable this by turning
38269 off the &%outgoing_interface%& option.
38270 .next
38271 .cindex "log" "outgoing remote port"
38272 .cindex "port" "logging outgoing remote"
38273 .cindex "TCP/IP" "logging outgoing remote port"
38274 &%outgoing_port%&: The remote port number is added to delivery log lines (those
38275 containing => tags) following the IP address.
38276 The local port is also added if &%incoming_interface%& and
38277 &%outgoing_interface%& are both enabled.
38278 This option is not included in the default setting, because for most ordinary
38279 configurations, the remote port number is always 25 (the SMTP port), and the
38280 local port is a random ephemeral port.
38281 .next
38282 .cindex "log" "process ids in"
38283 .cindex "pid (process id)" "in log lines"
38284 &%pid%&: The current process id is added to every log line, in square brackets,
38285 immediately after the time and date.
38286 .next
38287 .cindex log pipelining
38288 .cindex pipelining "logging outgoing"
38289 &%pipelining%&: A field is added to delivery and accept
38290 log lines when the ESMTP PIPELINING extension was used.
38291 The field is a single "L".
38292
38293 On accept lines, where PIPELINING was offered but not used by the client,
38294 the field has a minus appended.
38295
38296 .cindex "pipelining" "early connection"
38297 If Exim is built with the SUPPORT_PIPE_CONNECT build option
38298 accept "L" fields have a period appended if the feature was
38299 offered but not used, or an asterisk appended if used.
38300 Delivery "L" fields have an asterisk appended if used.
38301
38302 .next
38303 .cindex "log" "queue run"
38304 .cindex "queue runner" "logging"
38305 &%queue_run%&: The start and end of every queue run are logged.
38306 .next
38307 .cindex "log" "queue time"
38308 &%queue_time%&: The amount of time the message has been in the queue on the
38309 local host is logged as QT=<&'time'&> on delivery (&`=>`&) lines, for example,
38310 &`QT=3m45s`&. The clock starts when Exim starts to receive the message, so it
38311 includes reception time as well as the delivery time for the current address.
38312 This means that it may be longer than the difference between the arrival and
38313 delivery log line times, because the arrival log line is not written until the
38314 message has been successfully received.
38315 If millisecond logging is enabled, short times will be shown with greater
38316 precision, eg. &`QT=1.578s`&.
38317 .next
38318 &%queue_time_overall%&: The amount of time the message has been in the queue on
38319 the local host is logged as QT=<&'time'&> on &"Completed"& lines, for
38320 example, &`QT=3m45s`&. The clock starts when Exim starts to receive the
38321 message, so it includes reception time as well as the total delivery time.
38322 .next
38323 .cindex "log" "receive duration"
38324 &%receive_time%&: For each message, the amount of real time it has taken to
38325 perform the reception is logged as RT=<&'time'&>, for example, &`RT=1s`&.
38326 If millisecond logging is enabled, short times will be shown with greater
38327 precision, eg. &`RT=0.204s`&.
38328 .next
38329 .cindex "log" "recipients"
38330 &%received_recipients%&: The recipients of a message are listed in the main log
38331 as soon as the message is received. The list appears at the end of the log line
38332 that is written when a message is received, preceded by the word &"for"&. The
38333 addresses are listed after they have been qualified, but before any rewriting
38334 has taken place.
38335 Recipients that were discarded by an ACL for MAIL or RCPT do not appear
38336 in the list.
38337 .next
38338 .cindex "log" "sender reception"
38339 &%received_sender%&: The unrewritten original sender of a message is added to
38340 the end of the log line that records the message's arrival, after the word
38341 &"from"& (before the recipients if &%received_recipients%& is also set).
38342 .next
38343 .cindex "log" "header lines for rejection"
38344 &%rejected_header%&: If a message's header has been received at the time a
38345 rejection is written to the reject log, the complete header is added to the
38346 log. Header logging can be turned off individually for messages that are
38347 rejected by the &[local_scan()]& function (see section &<<SECTapiforloc>>&).
38348 .next
38349 .cindex "log" "retry defer"
38350 &%retry_defer%&: A log line is written if a delivery is deferred because a
38351 retry time has not yet been reached. However, this &"retry time not reached"&
38352 message is always omitted from individual message logs after the first delivery
38353 attempt.
38354 .next
38355 .cindex "log" "return path"
38356 &%return_path_on_delivery%&: The return path that is being transmitted with
38357 the message is included in delivery and bounce lines, using the tag P=.
38358 This is omitted if no delivery actually happens, for example, if routing fails,
38359 or if delivery is to &_/dev/null_& or to &`:blackhole:`&.
38360 .next
38361 .cindex "log" "sender on delivery"
38362 &%sender_on_delivery%&: The message's sender address is added to every delivery
38363 and bounce line, tagged by F= (for &"from"&).
38364 This is the original sender that was received with the message; it is not
38365 necessarily the same as the outgoing return path.
38366 .next
38367 .cindex "log" "sender verify failure"
38368 &%sender_verify_fail%&: If this selector is unset, the separate log line that
38369 gives details of a sender verification failure is not written. Log lines for
38370 the rejection of SMTP commands contain just &"sender verify failed"&, so some
38371 detail is lost.
38372 .next
38373 .cindex "log" "size rejection"
38374 &%size_reject%&: A log line is written whenever a message is rejected because
38375 it is too big.
38376 .next
38377 .cindex "log" "frozen messages; skipped"
38378 .cindex "frozen messages" "logging skipping"
38379 &%skip_delivery%&: A log line is written whenever a message is skipped during a
38380 queue run because it is frozen or because another process is already delivering
38381 it.
38382 .cindex "&""spool file is locked""&"
38383 The message that is written is &"spool file is locked"&.
38384 .next
38385 .cindex "log" "smtp confirmation"
38386 .cindex "SMTP" "logging confirmation"
38387 .cindex "LMTP" "logging confirmation"
38388 &%smtp_confirmation%&: The response to the final &"."& in the SMTP or LMTP dialogue for
38389 outgoing messages is added to delivery log lines in the form &`C=`&<&'text'&>.
38390 A number of MTAs (including Exim) return an identifying string in this
38391 response.
38392 .next
38393 .cindex "log" "SMTP connections"
38394 .cindex "SMTP" "logging connections"
38395 &%smtp_connection%&: A log line is written whenever an incoming SMTP connection is
38396 established or closed, unless the connection is from a host that matches
38397 &%hosts_connection_nolog%&. (In contrast, &%lost_incoming_connection%& applies
38398 only when the closure is unexpected.) This applies to connections from local
38399 processes that use &%-bs%& as well as to TCP/IP connections. If a connection is
38400 dropped in the middle of a message, a log line is always written, whether or
38401 not this selector is set, but otherwise nothing is written at the start and end
38402 of connections unless this selector is enabled.
38403
38404 For TCP/IP connections to an Exim daemon, the current number of connections is
38405 included in the log message for each new connection, but note that the count is
38406 reset if the daemon is restarted.
38407 Also, because connections are closed (and the closure is logged) in
38408 subprocesses, the count may not include connections that have been closed but
38409 whose termination the daemon has not yet noticed. Thus, while it is possible to
38410 match up the opening and closing of connections in the log, the value of the
38411 logged counts may not be entirely accurate.
38412 .next
38413 .cindex "log" "SMTP transaction; incomplete"
38414 .cindex "SMTP" "logging incomplete transactions"
38415 &%smtp_incomplete_transaction%&: When a mail transaction is aborted by
38416 RSET, QUIT, loss of connection, or otherwise, the incident is logged,
38417 and the message sender plus any accepted recipients are included in the log
38418 line. This can provide evidence of dictionary attacks.
38419 .next
38420 .cindex "log" "non-MAIL SMTP sessions"
38421 .cindex "MAIL" "logging session without"
38422 &%smtp_no_mail%&: A line is written to the main log whenever an accepted SMTP
38423 connection terminates without having issued a MAIL command. This includes both
38424 the case when the connection is dropped, and the case when QUIT is used. It
38425 does not include cases where the connection is rejected right at the start (by
38426 an ACL, or because there are too many connections, or whatever). These cases
38427 already have their own log lines.
38428
38429 The log line that is written contains the identity of the client in the usual
38430 way, followed by D= and a time, which records the duration of the connection.
38431 If the connection was authenticated, this fact is logged exactly as it is for
38432 an incoming message, with an A= item. If the connection was encrypted, CV=,
38433 DN=, and X= items may appear as they do for an incoming message, controlled by
38434 the same logging options.
38435
38436 Finally, if any SMTP commands were issued during the connection, a C= item
38437 is added to the line, listing the commands that were used. For example,
38438 .code
38439 C=EHLO,QUIT
38440 .endd
38441 shows that the client issued QUIT straight after EHLO. If there were fewer
38442 than 20 commands, they are all listed. If there were more than 20 commands,
38443 the last 20 are listed, preceded by &"..."&. However, with the default
38444 setting of 10 for &%smtp_accept_max_nonmail%&, the connection will in any case
38445 have been aborted before 20 non-mail commands are processed.
38446 .next
38447 &%smtp_mailauth%&: A third subfield with the authenticated sender,
38448 colon-separated, is appended to the A= item for a message arrival or delivery
38449 log line, if an AUTH argument to the SMTP MAIL command (see &<<SECTauthparamail>>&)
38450 was accepted or used.
38451 .next
38452 .cindex "log" "SMTP protocol error"
38453 .cindex "SMTP" "logging protocol error"
38454 &%smtp_protocol_error%&: A log line is written for every SMTP protocol error
38455 encountered. Exim does not have perfect detection of all protocol errors
38456 because of transmission delays and the use of pipelining. If PIPELINING has
38457 been advertised to a client, an Exim server assumes that the client will use
38458 it, and therefore it does not count &"expected"& errors (for example, RCPT
38459 received after rejecting MAIL) as protocol errors.
38460 .next
38461 .cindex "SMTP" "logging syntax errors"
38462 .cindex "SMTP" "syntax errors; logging"
38463 .cindex "SMTP" "unknown command; logging"
38464 .cindex "log" "unknown SMTP command"
38465 .cindex "log" "SMTP syntax error"
38466 &%smtp_syntax_error%&: A log line is written for every SMTP syntax error
38467 encountered. An unrecognized command is treated as a syntax error. For an
38468 external connection, the host identity is given; for an internal connection
38469 using &%-bs%& the sender identification (normally the calling user) is given.
38470 .next
38471 .cindex "log" "subject"
38472 .cindex "subject, logging"
38473 &%subject%&: The subject of the message is added to the arrival log line,
38474 preceded by &"T="& (T for &"topic"&, since S is already used for &"size"&).
38475 Any MIME &"words"& in the subject are decoded. The &%print_topbitchars%& option
38476 specifies whether characters with values greater than 127 should be logged
38477 unchanged, or whether they should be rendered as escape sequences.
38478 .next
38479 .cindex "log" "certificate verification"
38480 .cindex log DANE
38481 .cindex DANE logging
38482 &%tls_certificate_verified%&: An extra item is added to <= and => log lines
38483 when TLS is in use. The item is &`CV=yes`& if the peer's certificate was
38484 verified
38485 using a CA trust anchor,
38486 &`CA=dane`& if using a DNS trust anchor,
38487 and &`CV=no`& if not.
38488 .next
38489 .cindex "log" "TLS cipher"
38490 .cindex "TLS" "logging cipher"
38491 &%tls_cipher%&: When a message is sent or received over an encrypted
38492 connection, the cipher suite used is added to the log line, preceded by X=.
38493 .next
38494 .cindex "log" "TLS peer DN"
38495 .cindex "TLS" "logging peer DN"
38496 &%tls_peerdn%&: When a message is sent or received over an encrypted
38497 connection, and a certificate is supplied by the remote host, the peer DN is
38498 added to the log line, preceded by DN=.
38499 .next
38500 .cindex "log" "TLS SNI"
38501 .cindex "TLS" "logging SNI"
38502 &%tls_sni%&: When a message is received over an encrypted connection, and
38503 the remote host provided the Server Name Indication extension, the SNI is
38504 added to the log line, preceded by SNI=.
38505 .next
38506 .cindex "log" "DNS failure in list"
38507 &%unknown_in_list%&: This setting causes a log entry to be written when the
38508 result of a list match is failure because a DNS lookup failed.
38509 .endlist
38510
38511
38512 .section "Message log" "SECID260"
38513 .cindex "message" "log file for"
38514 .cindex "log" "message log; description of"
38515 .cindex "&_msglog_& directory"
38516 .oindex "&%preserve_message_logs%&"
38517 In addition to the general log files, Exim writes a log file for each message
38518 that it handles. The names of these per-message logs are the message ids, and
38519 they are kept in the &_msglog_& sub-directory of the spool directory. Each
38520 message log contains copies of the log lines that apply to the message. This
38521 makes it easier to inspect the status of an individual message without having
38522 to search the main log. A message log is deleted when processing of the message
38523 is complete, unless &%preserve_message_logs%& is set, but this should be used
38524 only with great care because they can fill up your disk very quickly.
38525
38526 On a heavily loaded system, it may be desirable to disable the use of
38527 per-message logs, in order to reduce disk I/O. This can be done by setting the
38528 &%message_logs%& option false.
38529 .ecindex IIDloggen
38530
38531
38532
38533
38534 . ////////////////////////////////////////////////////////////////////////////
38535 . ////////////////////////////////////////////////////////////////////////////
38536
38537 .chapter "Exim utilities" "CHAPutils"
38538 .scindex IIDutils "utilities"
38539 A number of utility scripts and programs are supplied with Exim and are
38540 described in this chapter. There is also the Exim Monitor, which is covered in
38541 the next chapter. The utilities described here are:
38542
38543 .itable none 0 0 3  7* left  15* left  40* left
38544 .irow &<<SECTfinoutwha>>&     &'exiwhat'&       &&&
38545   "list what Exim processes are doing"
38546 .irow &<<SECTgreptheque>>&    &'exiqgrep'&      "grep the queue"
38547 .irow &<<SECTsumtheque>>&     &'exiqsumm'&      "summarize the queue"
38548 .irow &<<SECTextspeinf>>&     &'exigrep'&       "search the main log"
38549 .irow &<<SECTexipick>>&       &'exipick'&       "select messages on &&&
38550                                                 various criteria"
38551 .irow &<<SECTcyclogfil>>&     &'exicyclog'&     "cycle (rotate) log files"
38552 .irow &<<SECTmailstat>>&      &'eximstats'&     &&&
38553   "extract statistics from the log"
38554 .irow &<<SECTcheckaccess>>&   &'exim_checkaccess'& &&&
38555   "check address acceptance from given IP"
38556 .irow &<<SECTdbmbuild>>&      &'exim_dbmbuild'& "build a DBM file"
38557 .irow &<<SECTfinindret>>&     &'exinext'&       "extract retry information"
38558 .irow &<<SECThindatmai>>&     &'exim_dumpdb'&   "dump a hints database"
38559 .irow &<<SECThindatmai>>&     &'exim_tidydb'&   "clean up a hints database"
38560 .irow &<<SECThindatmai>>&     &'exim_fixdb'&    "patch a hints database"
38561 .irow &<<SECTmailboxmaint>>&  &'exim_lock'&     "lock a mailbox file"
38562 .endtable
38563
38564 Another utility that might be of use to sites with many MTAs is Tom Kistner's
38565 &'exilog'&. It provides log visualizations across multiple Exim servers. See
38566 &url(https://duncanthrax.net/exilog/) for details.
38567
38568
38569
38570
38571 .section "Finding out what Exim processes are doing (exiwhat)" "SECTfinoutwha"
38572 .cindex "&'exiwhat'&"
38573 .cindex "process, querying"
38574 .cindex "SIGUSR1"
38575 On operating systems that can restart a system call after receiving a signal
38576 (most modern OS), an Exim process responds to the SIGUSR1 signal by writing
38577 a line describing what it is doing to the file &_exim-process.info_& in the
38578 Exim spool directory. The &'exiwhat'& script sends the signal to all Exim
38579 processes it can find, having first emptied the file. It then waits for one
38580 second to allow the Exim processes to react before displaying the results. In
38581 order to run &'exiwhat'& successfully you have to have sufficient privilege to
38582 send the signal to the Exim processes, so it is normally run as root.
38583
38584 &*Warning*&: This is not an efficient process. It is intended for occasional
38585 use by system administrators. It is not sensible, for example, to set up a
38586 script that sends SIGUSR1 signals to Exim processes at short intervals.
38587
38588
38589 Unfortunately, the &'ps'& command that &'exiwhat'& uses to find Exim processes
38590 varies in different operating systems. Not only are different options used,
38591 but the format of the output is different. For this reason, there are some
38592 system configuration options that configure exactly how &'exiwhat'& works. If
38593 it doesn't seem to be working for you, check the following compile-time
38594 options:
38595 .display
38596 &`EXIWHAT_PS_CMD    `& the command for running &'ps'&
38597 &`EXIWHAT_PS_ARG    `& the argument for &'ps'&
38598 &`EXIWHAT_EGREP_ARG `& the argument for &'egrep'& to select from &'ps'& output
38599 &`EXIWHAT_KILL_ARG  `& the argument for the &'kill'& command
38600 .endd
38601 An example of typical output from &'exiwhat'& is
38602 .code
38603 164 daemon: -q1h, listening on port 25
38604 10483 running queue: waiting for 0tAycK-0002ij-00 (10492)
38605 10492 delivering 0tAycK-0002ij-00 to mail.ref.example
38606   [10.19.42.42] (editor@ref.example)
38607 10592 handling incoming call from [192.168.243.242]
38608 10628 accepting a local non-SMTP message
38609 .endd
38610 The first number in the output line is the process number. The third line has
38611 been split here, in order to fit it on the page.
38612
38613
38614
38615 .section "Selective queue listing (exiqgrep)" "SECTgreptheque"
38616 .cindex "&'exiqgrep'&"
38617 .cindex "queue" "grepping"
38618 This utility is a Perl script contributed by Matt Hubbard. It runs
38619 .code
38620 exim -bpu
38621 .endd
38622 or (in case &*-a*& switch is specified)
38623 .code
38624 exim -bp
38625 .endd
38626 The &*-C*& option is used to specify an alternate &_exim.conf_& which might
38627 contain alternate exim configuration the queue management might be using.
38628
38629 to obtain a queue listing, and then greps the output to select messages
38630 that match given criteria. The following selection options are available:
38631
38632 .vlist
38633 .vitem &*-f*&&~<&'regex'&>
38634 Match the sender address using a case-insensitive search. The field that is
38635 tested is enclosed in angle brackets, so you can test for bounce messages with
38636 .code
38637 exiqgrep -f '^<>$'
38638 .endd
38639 .vitem &*-r*&&~<&'regex'&>
38640 Match a recipient address using a case-insensitive search. The field that is
38641 tested is not enclosed in angle brackets.
38642
38643 .vitem &*-s*&&~<&'regex'&>
38644 Match against the size field.
38645
38646 .vitem &*-y*&&~<&'seconds'&>
38647 Match messages that are younger than the given time.
38648
38649 .vitem &*-o*&&~<&'seconds'&>
38650 Match messages that are older than the given time.
38651
38652 .vitem &*-z*&
38653 Match only frozen messages.
38654
38655 .vitem &*-x*&
38656 Match only non-frozen messages.
38657
38658 .vitem &*-G*&&~<&'queuename'&>
38659 Match only messages in the given queue.  Without this, the default queue is searched.
38660 .endlist
38661
38662 The following options control the format of the output:
38663
38664 .vlist
38665 .vitem &*-c*&
38666 Display only the count of matching messages.
38667
38668 .vitem &*-l*&
38669 Long format &-- display the full message information as output by Exim. This is
38670 the default.
38671
38672 .vitem &*-i*&
38673 Display message ids only.
38674
38675 .vitem &*-b*&
38676 Brief format &-- one line per message.
38677
38678 .vitem &*-R*&
38679 Display messages in reverse order.
38680
38681 .vitem &*-a*&
38682 Include delivered recipients in queue listing.
38683 .endlist
38684
38685 There is one more option, &%-h%&, which outputs a list of options.
38686
38687
38688
38689 .section "Summarizing the queue (exiqsumm)" "SECTsumtheque"
38690 .cindex "&'exiqsumm'&"
38691 .cindex "queue" "summary"
38692 The &'exiqsumm'& utility is a Perl script which reads the output of &`exim
38693 -bp`& and produces a summary of the messages in the queue. Thus, you use it by
38694 running a command such as
38695 .code
38696 exim -bp | exiqsumm
38697 .endd
38698 The output consists of one line for each domain that has messages waiting for
38699 it, as in the following example:
38700 .code
38701 3   2322   74m   66m  msn.com.example
38702 .endd
38703 Each line lists the number of pending deliveries for a domain, their total
38704 volume, and the length of time that the oldest and the newest messages have
38705 been waiting. Note that the number of pending deliveries is greater than the
38706 number of messages when messages have more than one recipient.
38707
38708 A summary line is output at the end. By default the output is sorted on the
38709 domain name, but &'exiqsumm'& has the options &%-a%& and &%-c%&, which cause
38710 the output to be sorted by oldest message and by count of messages,
38711 respectively. There are also three options that split the messages for each
38712 domain into two or more subcounts: &%-b%& separates bounce messages, &%-f%&
38713 separates frozen messages, and &%-s%& separates messages according to their
38714 sender.
38715
38716 The output of &'exim -bp'& contains the original addresses in the message, so
38717 this also applies to the output from &'exiqsumm'&. No domains from addresses
38718 generated by aliasing or forwarding are included (unless the &%one_time%&
38719 option of the &(redirect)& router has been used to convert them into &"top
38720 level"& addresses).
38721
38722
38723
38724
38725 .section "Extracting specific information from the log (exigrep)" &&&
38726          "SECTextspeinf"
38727 .cindex "&'exigrep'&"
38728 .cindex "log" "extracts; grepping for"
38729 The &'exigrep'& utility is a Perl script that searches one or more main log
38730 files for entries that match a given pattern. When it finds a match, it
38731 extracts all the log entries for the relevant message, not just those that
38732 match the pattern. Thus, &'exigrep'& can extract complete log entries for a
38733 given message, or all mail for a given user, or for a given host, for example.
38734 The input files can be in Exim log format or syslog format.
38735 If a matching log line is not associated with a specific message, it is
38736 included in &'exigrep'&'s output without any additional lines. The usage is:
38737 .display
38738 &`exigrep [-t<`&&'n'&&`>] [-I] [-l] [-M] [-v] <`&&'pattern'&&`> [<`&&'log file'&&`>] ...`&
38739 .endd
38740 If no log filenames are given on the command line, the standard input is read.
38741
38742 The &%-t%& argument specifies a number of seconds. It adds an additional
38743 condition for message selection. Messages that are complete are shown only if
38744 they spent more than <&'n'&> seconds in the queue.
38745
38746 By default, &'exigrep'& does case-insensitive matching. The &%-I%& option
38747 makes it case-sensitive. This may give a performance improvement when searching
38748 large log files. Without &%-I%&, the Perl pattern matches use Perl's &`/i`&
38749 option; with &%-I%& they do not. In both cases it is possible to change the
38750 case sensitivity within the pattern by using &`(?i)`& or &`(?-i)`&.
38751
38752 The &%-l%& option means &"literal"&, that is, treat all characters in the
38753 pattern as standing for themselves. Otherwise the pattern must be a Perl
38754 regular expression.
38755
38756 The &%-v%& option inverts the matching condition. That is, a line is selected
38757 if it does &'not'& match the pattern.
38758
38759 The &%-M%& options means &"related messages"&. &'exigrep'& will show messages
38760 that are generated as a result/response to a message that &'exigrep'& matched
38761 normally.
38762
38763 Example of &%-M%&:
38764 user_a sends a message to user_b, which generates a bounce back to user_b. If
38765 &'exigrep'& is used to search for &"user_a"&, only the first message will be
38766 displayed.  But if &'exigrep'& is used to search for &"user_b"&, the first and
38767 the second (bounce) message will be displayed. Using &%-M%& with &'exigrep'&
38768 when searching for &"user_a"& will show both messages since the bounce is
38769 &"related"& to or a &"result"& of the first message that was found by the
38770 search term.
38771
38772 If the location of a &'zcat'& command is known from the definition of
38773 ZCAT_COMMAND in &_Local/Makefile_&, &'exigrep'& automatically passes any file
38774 whose name ends in COMPRESS_SUFFIX through &'zcat'& as it searches it.
38775 If the ZCAT_COMMAND is not executable, &'exigrep'& tries to use
38776 autodetection of some well known compression extensions.
38777
38778
38779 .section "Selecting messages by various criteria (exipick)" "SECTexipick"
38780 .cindex "&'exipick'&"
38781 John Jetmore's &'exipick'& utility is included in the Exim distribution. It
38782 lists messages from the queue according to a variety of criteria. For details
38783 of &'exipick'&'s facilities, run &'exipick'& with
38784 the &%--help%& option.
38785
38786
38787 .section "Cycling log files (exicyclog)" "SECTcyclogfil"
38788 .cindex "log" "cycling local files"
38789 .cindex "cycling logs"
38790 .cindex "&'exicyclog'&"
38791 The &'exicyclog'& script can be used to cycle (rotate) &'mainlog'& and
38792 &'rejectlog'& files. This is not necessary if only syslog is being used, or if
38793 you are using log files with datestamps in their names (see section
38794 &<<SECTdatlogfil>>&). Some operating systems have their own standard mechanisms
38795 for log cycling, and these can be used instead of &'exicyclog'& if preferred.
38796 There are two command line options for &'exicyclog'&:
38797 .ilist
38798 &%-k%& <&'count'&> specifies the number of log files to keep, overriding the
38799 default that is set when Exim is built. The default default is 10.
38800 .next
38801 &%-l%& <&'path'&> specifies the log file path, in the same format as Exim's
38802 &%log_file_path%& option (for example, &`/var/log/exim_%slog`&), again
38803 overriding the script's default, which is to find the setting from Exim's
38804 configuration.
38805 .endlist
38806
38807 Each time &'exicyclog'& is run the filenames get &"shuffled down"& by one. If
38808 the main log filename is &_mainlog_& (the default) then when &'exicyclog'& is
38809 run &_mainlog_& becomes &_mainlog.01_&, the previous &_mainlog.01_& becomes
38810 &_mainlog.02_& and so on, up to the limit that is set in the script or by the
38811 &%-k%& option. Log files whose numbers exceed the limit are discarded. Reject
38812 logs are handled similarly.
38813
38814 If the limit is greater than 99, the script uses 3-digit numbers such as
38815 &_mainlog.001_&, &_mainlog.002_&, etc. If you change from a number less than 99
38816 to one that is greater, or &'vice versa'&, you will have to fix the names of
38817 any existing log files.
38818
38819 If no &_mainlog_& file exists, the script does nothing. Files that &"drop off"&
38820 the end are deleted. All files with numbers greater than 01 are compressed,
38821 using a compression command which is configured by the COMPRESS_COMMAND
38822 setting in &_Local/Makefile_&. It is usual to run &'exicyclog'& daily from a
38823 root &%crontab%& entry of the form
38824 .code
38825 1 0 * * * su exim -c /usr/exim/bin/exicyclog
38826 .endd
38827 assuming you have used the name &"exim"& for the Exim user. You can run
38828 &'exicyclog'& as root if you wish, but there is no need.
38829
38830
38831
38832 .section "Mail statistics (eximstats)" "SECTmailstat"
38833 .cindex "statistics"
38834 .cindex "&'eximstats'&"
38835 A Perl script called &'eximstats'& is provided for extracting statistical
38836 information from log files. The output is either plain text, or HTML.
38837 . --- 2018-09-07: LogReport's Lire appears to be dead; website is a Yahoo Japan
38838 . --- 404 error and everything else points to that.
38839
38840 The &'eximstats'& script has been hacked about quite a bit over time. The
38841 latest version is the result of some extensive revision by Steve Campbell. A
38842 lot of information is given by default, but there are options for suppressing
38843 various parts of it. Following any options, the arguments to the script are a
38844 list of files, which should be main log files. For example:
38845 .code
38846 eximstats -nr /var/spool/exim/log/mainlog.01
38847 .endd
38848 By default, &'eximstats'& extracts information about the number and volume of
38849 messages received from or delivered to various hosts. The information is sorted
38850 both by message count and by volume, and the top fifty hosts in each category
38851 are listed on the standard output. Similar information, based on email
38852 addresses or domains instead of hosts can be requested by means of various
38853 options. For messages delivered and received locally, similar statistics are
38854 also produced per user.
38855
38856 The output also includes total counts and statistics about delivery errors, and
38857 histograms showing the number of messages received and deliveries made in each
38858 hour of the day. A delivery with more than one address in its envelope (for
38859 example, an SMTP transaction with more than one RCPT command) is counted
38860 as a single delivery by &'eximstats'&.
38861
38862 Though normally more deliveries than receipts are reported (as messages may
38863 have multiple recipients), it is possible for &'eximstats'& to report more
38864 messages received than delivered, even though the queue is empty at the start
38865 and end of the period in question. If an incoming message contains no valid
38866 recipients, no deliveries are recorded for it. A bounce message is handled as
38867 an entirely separate message.
38868
38869 &'eximstats'& always outputs a grand total summary giving the volume and number
38870 of messages received and deliveries made, and the number of hosts involved in
38871 each case. It also outputs the number of messages that were delayed (that is,
38872 not completely delivered at the first attempt), and the number that had at
38873 least one address that failed.
38874
38875 The remainder of the output is in sections that can be independently disabled
38876 or modified by various options. It consists of a summary of deliveries by
38877 transport, histograms of messages received and delivered per time interval
38878 (default per hour), information about the time messages spent in the queue,
38879 a list of relayed messages, lists of the top fifty sending hosts, local
38880 senders, destination hosts, and destination local users by count and by volume,
38881 and a list of delivery errors that occurred.
38882
38883 The relay information lists messages that were actually relayed, that is, they
38884 came from a remote host and were directly delivered to some other remote host,
38885 without being processed (for example, for aliasing or forwarding) locally.
38886
38887 There are quite a few options for &'eximstats'& to control exactly what it
38888 outputs. These are documented in the Perl script itself, and can be extracted
38889 by running the command &(perldoc)& on the script. For example:
38890 .code
38891 perldoc /usr/exim/bin/eximstats
38892 .endd
38893
38894 .section "Checking access policy (exim_checkaccess)" "SECTcheckaccess"
38895 .cindex "&'exim_checkaccess'&"
38896 .cindex "policy control" "checking access"
38897 .cindex "checking access"
38898 The &%-bh%& command line argument allows you to run a fake SMTP session with
38899 debugging output, in order to check what Exim is doing when it is applying
38900 policy controls to incoming SMTP mail. However, not everybody is sufficiently
38901 familiar with the SMTP protocol to be able to make full use of &%-bh%&, and
38902 sometimes you just want to answer the question &"Does this address have
38903 access?"& without bothering with any further details.
38904
38905 The &'exim_checkaccess'& utility is a &"packaged"& version of &%-bh%&. It takes
38906 two arguments, an IP address and an email address:
38907 .code
38908 exim_checkaccess 10.9.8.7 A.User@a.domain.example
38909 .endd
38910 The utility runs a call to Exim with the &%-bh%& option, to test whether the
38911 given email address would be accepted in a RCPT command in a TCP/IP
38912 connection from the host with the given IP address. The output of the utility
38913 is either the word &"accepted"&, or the SMTP error response, for example:
38914 .code
38915 Rejected:
38916 550 Relay not permitted
38917 .endd
38918 When running this test, the utility uses &`<>`& as the envelope sender address
38919 for the MAIL command, but you can change this by providing additional
38920 options. These are passed directly to the Exim command. For example, to specify
38921 that the test is to be run with the sender address &'himself@there.example'&
38922 you can use:
38923 .code
38924 exim_checkaccess 10.9.8.7 A.User@a.domain.example \
38925                  -f himself@there.example
38926 .endd
38927 Note that these additional Exim command line items must be given after the two
38928 mandatory arguments.
38929
38930 Because the &%exim_checkaccess%& uses &%-bh%&, it does not perform callouts
38931 while running its checks. You can run checks that include callouts by using
38932 &%-bhc%&, but this is not yet available in a &"packaged"& form.
38933
38934
38935
38936 .section "Making DBM files (exim_dbmbuild)" "SECTdbmbuild"
38937 .cindex "DBM" "building dbm files"
38938 .cindex "building DBM files"
38939 .cindex "&'exim_dbmbuild'&"
38940 .cindex "lower casing"
38941 .cindex "binary zero" "in lookup key"
38942 The &'exim_dbmbuild'& program reads an input file containing keys and data in
38943 the format used by the &(lsearch)& lookup (see section
38944 &<<SECTsinglekeylookups>>&). It writes a DBM file using the lower-cased alias
38945 names as keys and the remainder of the information as data. The lower-casing
38946 can be prevented by calling the program with the &%-nolc%& option.
38947
38948 A terminating zero is included as part of the key string. This is expected by
38949 the &(dbm)& lookup type. However, if the option &%-nozero%& is given,
38950 &'exim_dbmbuild'& creates files without terminating zeroes in either the key
38951 strings or the data strings. The &(dbmnz)& lookup type can be used with such
38952 files.
38953
38954 The program requires two arguments: the name of the input file (which can be a
38955 single hyphen to indicate the standard input), and the name of the output file.
38956 It creates the output under a temporary name, and then renames it if all went
38957 well.
38958
38959 .cindex "USE_DB"
38960 If the native DB interface is in use (USE_DB is set in a compile-time
38961 configuration file &-- this is common in free versions of Unix) the two
38962 filenames must be different, because in this mode the Berkeley DB functions
38963 create a single output file using exactly the name given. For example,
38964 .code
38965 exim_dbmbuild /etc/aliases /etc/aliases.db
38966 .endd
38967 reads the system alias file and creates a DBM version of it in
38968 &_/etc/aliases.db_&.
38969
38970 In systems that use the &'ndbm'& routines (mostly proprietary versions of
38971 Unix), two files are used, with the suffixes &_.dir_& and &_.pag_&. In this
38972 environment, the suffixes are added to the second argument of
38973 &'exim_dbmbuild'&, so it can be the same as the first. This is also the case
38974 when the Berkeley functions are used in compatibility mode (though this is not
38975 recommended), because in that case it adds a &_.db_& suffix to the filename.
38976
38977 If a duplicate key is encountered, the program outputs a warning, and when it
38978 finishes, its return code is 1 rather than zero, unless the &%-noduperr%&
38979 option is used. By default, only the first of a set of duplicates is used &--
38980 this makes it compatible with &(lsearch)& lookups. There is an option
38981 &%-lastdup%& which causes it to use the data for the last duplicate instead.
38982 There is also an option &%-nowarn%&, which stops it listing duplicate keys to
38983 &%stderr%&. For other errors, where it doesn't actually make a new file, the
38984 return code is 2.
38985
38986
38987
38988
38989 .section "Finding individual retry times (exinext)" "SECTfinindret"
38990 .cindex "retry" "times"
38991 .cindex "&'exinext'&"
38992 A utility called &'exinext'& (mostly a Perl script) provides the ability to
38993 fish specific information out of the retry database. Given a mail domain (or a
38994 complete address), it looks up the hosts for that domain, and outputs any retry
38995 information for the hosts or for the domain. At present, the retry information
38996 is obtained by running &'exim_dumpdb'& (see below) and post-processing the
38997 output. For example:
38998 .code
38999 $ exinext piglet@milne.fict.example
39000 kanga.milne.example:192.168.8.1 error 146: Connection refused
39001   first failed: 21-Feb-1996 14:57:34
39002   last tried:   21-Feb-1996 14:57:34
39003   next try at:  21-Feb-1996 15:02:34
39004 roo.milne.example:192.168.8.3 error 146: Connection refused
39005   first failed: 20-Jan-1996 13:12:08
39006   last tried:   21-Feb-1996 11:42:03
39007   next try at:  21-Feb-1996 19:42:03
39008   past final cutoff time
39009 .endd
39010 You can also give &'exinext'& a local part, without a domain, and it
39011 will give any retry information for that local part in your default domain.
39012 A message id can be used to obtain retry information pertaining to a specific
39013 message. This exists only when an attempt to deliver a message to a remote host
39014 suffers a message-specific error (see section &<<SECToutSMTPerr>>&).
39015 &'exinext'& is not particularly efficient, but then it is not expected to be
39016 run very often.
39017
39018 The &'exinext'& utility calls Exim to find out information such as the location
39019 of the spool directory. The utility has &%-C%& and &%-D%& options, which are
39020 passed on to the &'exim'& commands. The first specifies an alternate Exim
39021 configuration file, and the second sets macros for use within the configuration
39022 file. These features are mainly to help in testing, but might also be useful in
39023 environments where more than one configuration file is in use.
39024
39025
39026
39027 .section "Hints database maintenance" "SECThindatmai"
39028 .cindex "hints database" "maintenance"
39029 .cindex "maintaining Exim's hints database"
39030 Three utility programs are provided for maintaining the DBM files that Exim
39031 uses to contain its delivery hint information. Each program requires two
39032 arguments. The first specifies the name of Exim's spool directory, and the
39033 second is the name of the database it is to operate on. These are as follows:
39034
39035 .ilist
39036 &'retry'&: the database of retry information
39037 .next
39038 &'wait-'&<&'transport name'&>: databases of information about messages waiting
39039 for remote hosts
39040 .next
39041 &'callout'&: the callout cache
39042 .next
39043 &'ratelimit'&: the data for implementing the ratelimit ACL condition
39044 .next
39045 &'misc'&: other hints data
39046 .endlist
39047
39048 The &'misc'& database is used for
39049
39050 .ilist
39051 Serializing ETRN runs (when &%smtp_etrn_serialize%& is set)
39052 .next
39053 Serializing delivery to a specific host (when &%serialize_hosts%& is set in an
39054 &(smtp)& transport)
39055 .next
39056 Limiting the concurrency of specific transports (when &%max_parallel%& is set
39057 in a transport)
39058 .endlist
39059
39060
39061
39062 .section "exim_dumpdb" "SECID261"
39063 .cindex "&'exim_dumpdb'&"
39064 The entire contents of a database are written to the standard output by the
39065 &'exim_dumpdb'& program, which has no options or arguments other than the
39066 spool and database names. For example, to dump the retry database:
39067 .code
39068 exim_dumpdb /var/spool/exim retry
39069 .endd
39070 Two lines of output are produced for each entry:
39071 .code
39072 T:mail.ref.example:192.168.242.242 146 77 Connection refused
39073 31-Oct-1995 12:00:12 02-Nov-1995 12:21:39 02-Nov-1995 20:21:39 *
39074 .endd
39075 The first item on the first line is the key of the record. It starts with one
39076 of the letters R, or T, depending on whether it refers to a routing or
39077 transport retry. For a local delivery, the next part is the local address; for
39078 a remote delivery it is the name of the remote host, followed by its failing IP
39079 address (unless &%retry_include_ip_address%& is set false on the &(smtp)&
39080 transport). If the remote port is not the standard one (port 25), it is added
39081 to the IP address. Then there follows an error code, an additional error code,
39082 and a textual description of the error.
39083
39084 The three times on the second line are the time of first failure, the time of
39085 the last delivery attempt, and the computed time for the next attempt. The line
39086 ends with an asterisk if the cutoff time for the last retry rule has been
39087 exceeded.
39088
39089 Each output line from &'exim_dumpdb'& for the &'wait-xxx'& databases
39090 consists of a host name followed by a list of ids for messages that are or were
39091 waiting to be delivered to that host. If there are a very large number for any
39092 one host, continuation records, with a sequence number added to the host name,
39093 may be seen. The data in these records is often out of date, because a message
39094 may be routed to several alternative hosts, and Exim makes no effort to keep
39095 cross-references.
39096
39097
39098
39099 .section "exim_tidydb" "SECID262"
39100 .cindex "&'exim_tidydb'&"
39101 The &'exim_tidydb'& utility program is used to tidy up the contents of a hints
39102 database. If run with no options, it removes all records that are more than 30
39103 days old. The age is calculated from the date and time that the record was last
39104 updated. Note that, in the case of the retry database, it is &'not'& the time
39105 since the first delivery failure. Information about a host that has been down
39106 for more than 30 days will remain in the database, provided that the record is
39107 updated sufficiently often.
39108
39109 The cutoff date can be altered by means of the &%-t%& option, which must be
39110 followed by a time. For example, to remove all records older than a week from
39111 the retry database:
39112 .code
39113 exim_tidydb -t 7d /var/spool/exim retry
39114 .endd
39115 Both the &'wait-xxx'& and &'retry'& databases contain items that involve
39116 message ids. In the former these appear as data in records keyed by host &--
39117 they were messages that were waiting for that host &-- and in the latter they
39118 are the keys for retry information for messages that have suffered certain
39119 types of error. When &'exim_tidydb'& is run, a check is made to ensure that
39120 message ids in database records are those of messages that are still on the
39121 queue. Message ids for messages that no longer exist are removed from
39122 &'wait-xxx'& records, and if this leaves any records empty, they are deleted.
39123 For the &'retry'& database, records whose keys are non-existent message ids are
39124 removed. The &'exim_tidydb'& utility outputs comments on the standard output
39125 whenever it removes information from the database.
39126
39127 Certain records are automatically removed by Exim when they are no longer
39128 needed, but others are not. For example, if all the MX hosts for a domain are
39129 down, a retry record is created for each one. If the primary MX host comes back
39130 first, its record is removed when Exim successfully delivers to it, but the
39131 records for the others remain because Exim has not tried to use those hosts.
39132
39133 It is important, therefore, to run &'exim_tidydb'& periodically on all the
39134 hints databases. You should do this at a quiet time of day, because it requires
39135 a database to be locked (and therefore inaccessible to Exim) while it does its
39136 work. Removing records from a DBM file does not normally make the file smaller,
39137 but all the common DBM libraries are able to re-use the space that is released.
39138 After an initial phase of increasing in size, the databases normally reach a
39139 point at which they no longer get any bigger, as long as they are regularly
39140 tidied.
39141
39142 &*Warning*&: If you never run &'exim_tidydb'&, the space used by the hints
39143 databases is likely to keep on increasing.
39144
39145
39146
39147
39148 .section "exim_fixdb" "SECID263"
39149 .cindex "&'exim_fixdb'&"
39150 The &'exim_fixdb'& program is a utility for interactively modifying databases.
39151 Its main use is for testing Exim, but it might also be occasionally useful for
39152 getting round problems in a live system. It has no options, and its interface
39153 is somewhat crude. On entry, it prompts for input with a right angle-bracket. A
39154 key of a database record can then be entered, and the data for that record is
39155 displayed.
39156
39157 If &"d"& is typed at the next prompt, the entire record is deleted. For all
39158 except the &'retry'& database, that is the only operation that can be carried
39159 out. For the &'retry'& database, each field is output preceded by a number, and
39160 data for individual fields can be changed by typing the field number followed
39161 by new data, for example:
39162 .code
39163 > 4 951102:1000
39164 .endd
39165 resets the time of the next delivery attempt. Time values are given as a
39166 sequence of digit pairs for year, month, day, hour, and minute. Colons can be
39167 used as optional separators.
39168
39169
39170
39171
39172 .section "Mailbox maintenance (exim_lock)" "SECTmailboxmaint"
39173 .cindex "mailbox" "maintenance"
39174 .cindex "&'exim_lock'&"
39175 .cindex "locking mailboxes"
39176 The &'exim_lock'& utility locks a mailbox file using the same algorithm as
39177 Exim. For a discussion of locking issues, see section &<<SECTopappend>>&.
39178 &'Exim_lock'& can be used to prevent any modification of a mailbox by Exim or
39179 a user agent while investigating a problem. The utility requires the name of
39180 the file as its first argument. If the locking is successful, the second
39181 argument is run as a command (using C's &[system()]& function); if there is no
39182 second argument, the value of the SHELL environment variable is used; if this
39183 is unset or empty, &_/bin/sh_& is run. When the command finishes, the mailbox
39184 is unlocked and the utility ends. The following options are available:
39185
39186 .vlist
39187 .vitem &%-fcntl%&
39188 Use &[fcntl()]& locking on the open mailbox.
39189
39190 .vitem &%-flock%&
39191 Use &[flock()]& locking on the open mailbox, provided the operating system
39192 supports it.
39193
39194 .vitem &%-interval%&
39195 This must be followed by a number, which is a number of seconds; it sets the
39196 interval to sleep between retries (default 3).
39197
39198 .vitem &%-lockfile%&
39199 Create a lock file before opening the mailbox.
39200
39201 .vitem &%-mbx%&
39202 Lock the mailbox using MBX rules.
39203
39204 .vitem &%-q%&
39205 Suppress verification output.
39206
39207 .vitem &%-retries%&
39208 This must be followed by a number; it sets the number of times to try to get
39209 the lock (default 10).
39210
39211 .vitem &%-restore_time%&
39212 This option causes &%exim_lock%& to restore the modified and read times to the
39213 locked file before exiting. This allows you to access a locked mailbox (for
39214 example, to take a backup copy) without disturbing the times that the user
39215 subsequently sees.
39216
39217 .vitem &%-timeout%&
39218 This must be followed by a number, which is a number of seconds; it sets a
39219 timeout to be used with a blocking &[fcntl()]& lock. If it is not set (the
39220 default), a non-blocking call is used.
39221
39222 .vitem &%-v%&
39223 Generate verbose output.
39224 .endlist
39225
39226 If none of &%-fcntl%&, &%-flock%&, &%-lockfile%& or &%-mbx%& are given, the
39227 default is to create a lock file and also to use &[fcntl()]& locking on the
39228 mailbox, which is the same as Exim's default. The use of &%-flock%& or
39229 &%-fcntl%& requires that the file be writeable; the use of &%-lockfile%&
39230 requires that the directory containing the file be writeable. Locking by lock
39231 file does not last forever; Exim assumes that a lock file is expired if it is
39232 more than 30 minutes old.
39233
39234 The &%-mbx%& option can be used with either or both of &%-fcntl%& or
39235 &%-flock%&. It assumes &%-fcntl%& by default. MBX locking causes a shared lock
39236 to be taken out on the open mailbox, and an exclusive lock on the file
39237 &_/tmp/.n.m_& where &'n'& and &'m'& are the device number and inode
39238 number of the mailbox file. When the locking is released, if an exclusive lock
39239 can be obtained for the mailbox, the file in &_/tmp_& is deleted.
39240
39241 The default output contains verification of the locking that takes place. The
39242 &%-v%& option causes some additional information to be given. The &%-q%& option
39243 suppresses all output except error messages.
39244
39245 A command such as
39246 .code
39247 exim_lock /var/spool/mail/spqr
39248 .endd
39249 runs an interactive shell while the file is locked, whereas
39250 .display
39251 &`exim_lock -q /var/spool/mail/spqr <<End`&
39252 <&'some commands'&>
39253 &`End`&
39254 .endd
39255 runs a specific non-interactive sequence of commands while the file is locked,
39256 suppressing all verification output. A single command can be run by a command
39257 such as
39258 .code
39259 exim_lock -q /var/spool/mail/spqr \
39260   "cp /var/spool/mail/spqr /some/where"
39261 .endd
39262 Note that if a command is supplied, it must be entirely contained within the
39263 second argument &-- hence the quotes.
39264 .ecindex IIDutils
39265
39266
39267 . ////////////////////////////////////////////////////////////////////////////
39268 . ////////////////////////////////////////////////////////////////////////////
39269
39270 .chapter "The Exim monitor" "CHAPeximon"
39271 .scindex IIDeximon "Exim monitor" "description"
39272 .cindex "X-windows"
39273 .cindex "&'eximon'&"
39274 .cindex "Local/eximon.conf"
39275 .cindex "&_exim_monitor/EDITME_&"
39276 The Exim monitor is an application which displays in an X window information
39277 about the state of Exim's queue and what Exim is doing. An admin user can
39278 perform certain operations on messages from this GUI interface; however all
39279 such facilities are also available from the command line, and indeed, the
39280 monitor itself makes use of the command line to perform any actions requested.
39281
39282
39283
39284 .section "Running the monitor" "SECID264"
39285 The monitor is started by running the script called &'eximon'&. This is a shell
39286 script that sets up a number of environment variables, and then runs the
39287 binary called &_eximon.bin_&. The default appearance of the monitor window can
39288 be changed by editing the &_Local/eximon.conf_& file created by editing
39289 &_exim_monitor/EDITME_&. Comments in that file describe what the various
39290 parameters are for.
39291
39292 The parameters that get built into the &'eximon'& script can be overridden for
39293 a particular invocation by setting up environment variables of the same names,
39294 preceded by &`EXIMON_`&. For example, a shell command such as
39295 .code
39296 EXIMON_LOG_DEPTH=400 eximon
39297 .endd
39298 (in a Bourne-compatible shell) runs &'eximon'& with an overriding setting of
39299 the LOG_DEPTH parameter. If EXIMON_LOG_FILE_PATH is set in the environment, it
39300 overrides the Exim log file configuration. This makes it possible to have
39301 &'eximon'& tailing log data that is written to syslog, provided that MAIL.INFO
39302 syslog messages are routed to a file on the local host.
39303
39304 X resources can be used to change the appearance of the window in the normal
39305 way. For example, a resource setting of the form
39306 .code
39307 Eximon*background: gray94
39308 .endd
39309 changes the colour of the background to light grey rather than white. The
39310 stripcharts are drawn with both the data lines and the reference lines in
39311 black. This means that the reference lines are not visible when on top of the
39312 data. However, their colour can be changed by setting a resource called
39313 &"highlight"& (an odd name, but that's what the Athena stripchart widget uses).
39314 For example, if your X server is running Unix, you could set up lighter
39315 reference lines in the stripcharts by obeying
39316 .code
39317 xrdb -merge <<End
39318 Eximon*highlight: gray
39319 End
39320 .endd
39321 .cindex "admin user"
39322 In order to see the contents of messages in the queue, and to operate on them,
39323 &'eximon'& must either be run as root or by an admin user.
39324
39325 The command-line parameters of &'eximon'& are passed to &_eximon.bin_& and may
39326 contain X11 resource parameters interpreted by the X11 library.  In addition,
39327 if the first parameter starts with the string "gdb" then it is removed and the
39328 binary is invoked under gdb (the parameter is used as the gdb command-name, so
39329 versioned variants of gdb can be invoked).
39330
39331 The monitor's window is divided into three parts. The first contains one or
39332 more stripcharts and two action buttons, the second contains a &"tail"& of the
39333 main log file, and the third is a display of the queue of messages awaiting
39334 delivery, with two more action buttons. The following sections describe these
39335 different parts of the display.
39336
39337
39338
39339
39340 .section "The stripcharts" "SECID265"
39341 .cindex "stripchart"
39342 The first stripchart is always a count of messages in the queue. Its name can
39343 be configured by setting QUEUE_STRIPCHART_NAME in the
39344 &_Local/eximon.conf_& file. The remaining stripcharts are defined in the
39345 configuration script by regular expression matches on log file entries, making
39346 it possible to display, for example, counts of messages delivered to certain
39347 hosts or using certain transports. The supplied defaults display counts of
39348 received and delivered messages, and of local and SMTP deliveries. The default
39349 period between stripchart updates is one minute; this can be adjusted by a
39350 parameter in the &_Local/eximon.conf_& file.
39351
39352 The stripchart displays rescale themselves automatically as the value they are
39353 displaying changes. There are always 10 horizontal lines in each chart; the
39354 title string indicates the value of each division when it is greater than one.
39355 For example, &"x2"& means that each division represents a value of 2.
39356
39357 It is also possible to have a stripchart which shows the percentage fullness of
39358 a particular disk partition, which is useful when local deliveries are confined
39359 to a single partition.
39360
39361 .cindex "&%statvfs%& function"
39362 This relies on the availability of the &[statvfs()]& function or equivalent in
39363 the operating system. Most, but not all versions of Unix that support Exim have
39364 this. For this particular stripchart, the top of the chart always represents
39365 100%, and the scale is given as &"x10%"&. This chart is configured by setting
39366 SIZE_STRIPCHART and (optionally) SIZE_STRIPCHART_NAME in the
39367 &_Local/eximon.conf_& file.
39368
39369
39370
39371
39372 .section "Main action buttons" "SECID266"
39373 .cindex "size" "of monitor window"
39374 .cindex "Exim monitor" "window size"
39375 .cindex "window size"
39376 Below the stripcharts there is an action button for quitting the monitor. Next
39377 to this is another button marked &"Size"&. They are placed here so that
39378 shrinking the window to its default minimum size leaves just the queue count
39379 stripchart and these two buttons visible. Pressing the &"Size"& button causes
39380 the window to expand to its maximum size, unless it is already at the maximum,
39381 in which case it is reduced to its minimum.
39382
39383 When expanding to the maximum, if the window cannot be fully seen where it
39384 currently is, it is moved back to where it was the last time it was at full
39385 size. When it is expanding from its minimum size, the old position is
39386 remembered, and next time it is reduced to the minimum it is moved back there.
39387
39388 The idea is that you can keep a reduced window just showing one or two
39389 stripcharts at a convenient place on your screen, easily expand it to show
39390 the full window when required, and just as easily put it back to what it was.
39391 The idea is copied from what the &'twm'& window manager does for its
39392 &'f.fullzoom'& action. The minimum size of the window can be changed by setting
39393 the MIN_HEIGHT and MIN_WIDTH values in &_Local/eximon.conf_&.
39394
39395 Normally, the monitor starts up with the window at its full size, but it can be
39396 built so that it starts up with the window at its smallest size, by setting
39397 START_SMALL=yes in &_Local/eximon.conf_&.
39398
39399
39400
39401 .section "The log display" "SECID267"
39402 .cindex "log" "tail of; in monitor"
39403 The second section of the window is an area in which a display of the tail of
39404 the main log is maintained.
39405 To save space on the screen, the timestamp on each log line is shortened by
39406 removing the date and, if &%log_timezone%& is set, the timezone.
39407 The log tail is not available when the only destination for logging data is
39408 syslog, unless the syslog lines are routed to a local file whose name is passed
39409 to &'eximon'& via the EXIMON_LOG_FILE_PATH environment variable.
39410
39411 The log sub-window has a scroll bar at its lefthand side which can be used to
39412 move back to look at earlier text, and the up and down arrow keys also have a
39413 scrolling effect. The amount of log that is kept depends on the setting of
39414 LOG_BUFFER in &_Local/eximon.conf_&, which specifies the amount of memory
39415 to use. When this is full, the earlier 50% of data is discarded &-- this is
39416 much more efficient than throwing it away line by line. The sub-window also has
39417 a horizontal scroll bar for accessing the ends of long log lines. This is the
39418 only means of horizontal scrolling; the right and left arrow keys are not
39419 available. Text can be cut from this part of the window using the mouse in the
39420 normal way. The size of this subwindow is controlled by parameters in the
39421 configuration file &_Local/eximon.conf_&.
39422
39423 Searches of the text in the log window can be carried out by means of the ^R
39424 and ^S keystrokes, which default to a reverse and a forward search,
39425 respectively. The search covers only the text that is displayed in the window.
39426 It cannot go further back up the log.
39427
39428 The point from which the search starts is indicated by a caret marker. This is
39429 normally at the end of the text in the window, but can be positioned explicitly
39430 by pointing and clicking with the left mouse button, and is moved automatically
39431 by a successful search. If new text arrives in the window when it is scrolled
39432 back, the caret remains where it is, but if the window is not scrolled back,
39433 the caret is moved to the end of the new text.
39434
39435 Pressing ^R or ^S pops up a window into which the search text can be typed.
39436 There are buttons for selecting forward or reverse searching, for carrying out
39437 the search, and for cancelling. If the &"Search"& button is pressed, the search
39438 happens and the window remains so that further searches can be done. If the
39439 &"Return"& key is pressed, a single search is done and the window is closed. If
39440 ^C is typed the search is cancelled.
39441
39442 The searching facility is implemented using the facilities of the Athena text
39443 widget. By default this pops up a window containing both &"search"& and
39444 &"replace"& options. In order to suppress the unwanted &"replace"& portion for
39445 eximon, a modified version of the &%TextPop%& widget is distributed with Exim.
39446 However, the linkers in BSDI and HP-UX seem unable to handle an externally
39447 provided version of &%TextPop%& when the remaining parts of the text widget
39448 come from the standard libraries. The compile-time option EXIMON_TEXTPOP can be
39449 unset to cut out the modified &%TextPop%&, making it possible to build Eximon
39450 on these systems, at the expense of having unwanted items in the search popup
39451 window.
39452
39453
39454
39455 .section "The queue display" "SECID268"
39456 .cindex "queue" "display in monitor"
39457 The bottom section of the monitor window contains a list of all messages that
39458 are in the queue, which includes those currently being received or delivered,
39459 as well as those awaiting delivery. The size of this subwindow is controlled by
39460 parameters in the configuration file &_Local/eximon.conf_&, and the frequency
39461 at which it is updated is controlled by another parameter in the same file &--
39462 the default is 5 minutes, since queue scans can be quite expensive. However,
39463 there is an &"Update"& action button just above the display which can be used
39464 to force an update of the queue display at any time.
39465
39466 When a host is down for some time, a lot of pending mail can build up for it,
39467 and this can make it hard to deal with other messages in the queue. To help
39468 with this situation there is a button next to &"Update"& called &"Hide"&. If
39469 pressed, a dialogue box called &"Hide addresses ending with"& is put up. If you
39470 type anything in here and press &"Return"&, the text is added to a chain of
39471 such texts, and if every undelivered address in a message matches at least one
39472 of the texts, the message is not displayed.
39473
39474 If there is an address that does not match any of the texts, all the addresses
39475 are displayed as normal. The matching happens on the ends of addresses so, for
39476 example, &'cam.ac.uk'& specifies all addresses in Cambridge, while
39477 &'xxx@foo.com.example'& specifies just one specific address. When any hiding
39478 has been set up, a button called &"Unhide"& is displayed. If pressed, it
39479 cancels all hiding. Also, to ensure that hidden messages do not get forgotten,
39480 a hide request is automatically cancelled after one hour.
39481
39482 While the dialogue box is displayed, you can't press any buttons or do anything
39483 else to the monitor window. For this reason, if you want to cut text from the
39484 queue display to use in the dialogue box, you have to do the cutting before
39485 pressing the &"Hide"& button.
39486
39487 The queue display contains, for each unhidden queued message, the length of
39488 time it has been in the queue, the size of the message, the message id, the
39489 message sender, and the first undelivered recipient, all on one line. If it is
39490 a bounce message, the sender is shown as &"<>"&. If there is more than one
39491 recipient to which the message has not yet been delivered, subsequent ones are
39492 listed on additional lines, up to a maximum configured number, following which
39493 an ellipsis is displayed. Recipients that have already received the message are
39494 not shown.
39495
39496 .cindex "frozen messages" "display"
39497 If a message is frozen, an asterisk is displayed at the left-hand side.
39498
39499 The queue display has a vertical scroll bar, and can also be scrolled by means
39500 of the arrow keys. Text can be cut from it using the mouse in the normal way.
39501 The text searching facilities, as described above for the log window, are also
39502 available, but the caret is always moved to the end of the text when the queue
39503 display is updated.
39504
39505
39506
39507 .section "The queue menu" "SECID269"
39508 .cindex "queue" "menu in monitor"
39509 If the &%shift%& key is held down and the left button is clicked when the mouse
39510 pointer is over the text for any message, an action menu pops up, and the first
39511 line of the queue display for the message is highlighted. This does not affect
39512 any selected text.
39513
39514 If you want to use some other event for popping up the menu, you can set the
39515 MENU_EVENT parameter in &_Local/eximon.conf_& to change the default, or
39516 set EXIMON_MENU_EVENT in the environment before starting the monitor. The
39517 value set in this parameter is a standard X event description. For example, to
39518 run eximon using &%ctrl%& rather than &%shift%& you could use
39519 .code
39520 EXIMON_MENU_EVENT='Ctrl<Btn1Down>' eximon
39521 .endd
39522 The title of the menu is the message id, and it contains entries which act as
39523 follows:
39524
39525 .ilist
39526 &'message log'&: The contents of the message log for the message are displayed
39527 in a new text window.
39528 .next
39529 &'headers'&: Information from the spool file that contains the envelope
39530 information and headers is displayed in a new text window. See chapter
39531 &<<CHAPspool>>& for a description of the format of spool files.
39532 .next
39533 &'body'&: The contents of the spool file containing the body of the message are
39534 displayed in a new text window. There is a default limit of 20,000 bytes to the
39535 amount of data displayed. This can be changed by setting the BODY_MAX
39536 option at compile time, or the EXIMON_BODY_MAX option at runtime.
39537 .next
39538 &'deliver message'&: A call to Exim is made using the &%-M%& option to request
39539 delivery of the message. This causes an automatic thaw if the message is
39540 frozen. The &%-v%& option is also set, and the output from Exim is displayed in
39541 a new text window. The delivery is run in a separate process, to avoid holding
39542 up the monitor while the delivery proceeds.
39543 .next
39544 &'freeze message'&: A call to Exim is made using the &%-Mf%& option to request
39545 that the message be frozen.
39546 .next
39547 .cindex "thawing messages"
39548 .cindex "unfreezing messages"
39549 .cindex "frozen messages" "thawing"
39550 &'thaw message'&: A call to Exim is made using the &%-Mt%& option to request
39551 that the message be thawed.
39552 .next
39553 .cindex "delivery" "forcing failure"
39554 &'give up on msg'&: A call to Exim is made using the &%-Mg%& option to request
39555 that Exim gives up trying to deliver the message. A bounce message is generated
39556 for any remaining undelivered addresses.
39557 .next
39558 &'remove message'&: A call to Exim is made using the &%-Mrm%& option to request
39559 that the message be deleted from the system without generating a bounce
39560 message.
39561 .next
39562 &'add recipient'&: A dialog box is displayed into which a recipient address can
39563 be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
39564 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
39565 Otherwise it must be entered as a fully qualified address. Pressing RETURN
39566 causes a call to Exim to be made using the &%-Mar%& option to request that an
39567 additional recipient be added to the message, unless the entry box is empty, in
39568 which case no action is taken.
39569 .next
39570 &'mark delivered'&: A dialog box is displayed into which a recipient address
39571 can be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
39572 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
39573 Otherwise it must be entered as a fully qualified address. Pressing RETURN
39574 causes a call to Exim to be made using the &%-Mmd%& option to mark the given
39575 recipient address as already delivered, unless the entry box is empty, in which
39576 case no action is taken.
39577 .next
39578 &'mark all delivered'&: A call to Exim is made using the &%-Mmad%& option to
39579 mark all recipient addresses as already delivered.
39580 .next
39581 &'edit sender'&: A dialog box is displayed initialized with the current
39582 sender's address. Pressing RETURN causes a call to Exim to be made using the
39583 &%-Mes%& option to replace the sender address, unless the entry box is empty,
39584 in which case no action is taken. If you want to set an empty sender (as in
39585 bounce messages), you must specify it as &"<>"&. Otherwise, if the address is
39586 not qualified and the QUALIFY_DOMAIN parameter is set in &_Local/eximon.conf_&,
39587 the address is qualified with that domain.
39588 .endlist
39589
39590 When a delivery is forced, a window showing the &%-v%& output is displayed. In
39591 other cases when a call to Exim is made, if there is any output from Exim (in
39592 particular, if the command fails) a window containing the command and the
39593 output is displayed. Otherwise, the results of the action are normally apparent
39594 from the log and queue displays. However, if you set ACTION_OUTPUT=yes in
39595 &_Local/eximon.conf_&, a window showing the Exim command is always opened, even
39596 if no output is generated.
39597
39598 The queue display is automatically updated for actions such as freezing and
39599 thawing, unless ACTION_QUEUE_UPDATE=no has been set in
39600 &_Local/eximon.conf_&. In this case the &"Update"& button has to be used to
39601 force an update of the display after one of these actions.
39602
39603 In any text window that is displayed as result of a menu action, the normal
39604 cut-and-paste facility is available, and searching can be carried out using ^R
39605 and ^S, as described above for the log tail window.
39606 .ecindex IIDeximon
39607
39608
39609
39610
39611
39612 . ////////////////////////////////////////////////////////////////////////////
39613 . ////////////////////////////////////////////////////////////////////////////
39614
39615 .chapter "Security considerations" "CHAPsecurity"
39616 .scindex IIDsecurcon "security" "discussion of"
39617 This chapter discusses a number of issues concerned with security, some of
39618 which are also covered in other parts of this manual.
39619
39620 For reasons that this author does not understand, some people have promoted
39621 Exim as a &"particularly secure"& mailer. Perhaps it is because of the
39622 existence of this chapter in the documentation. However, the intent of the
39623 chapter is simply to describe the way Exim works in relation to certain
39624 security concerns, not to make any specific claims about the effectiveness of
39625 its security as compared with other MTAs.
39626
39627 What follows is a description of the way Exim is supposed to be. Best efforts
39628 have been made to try to ensure that the code agrees with the theory, but an
39629 absence of bugs can never be guaranteed. Any that are reported will get fixed
39630 as soon as possible.
39631
39632
39633 .section "Building a more &""hardened""& Exim" "SECID286"
39634 .cindex "security" "build-time features"
39635 There are a number of build-time options that can be set in &_Local/Makefile_&
39636 to create Exim binaries that are &"harder"& to attack, in particular by a rogue
39637 Exim administrator who does not have the root password, or by someone who has
39638 penetrated the Exim (but not the root) account. These options are as follows:
39639
39640 .ilist
39641 ALT_CONFIG_PREFIX can be set to a string that is required to match the
39642 start of any filenames used with the &%-C%& option. When it is set, these
39643 filenames are also not allowed to contain the sequence &"/../"&. (However, if
39644 the value of the &%-C%& option is identical to the value of CONFIGURE_FILE in
39645 &_Local/Makefile_&, Exim ignores &%-C%& and proceeds as usual.) There is no
39646 default setting for &%ALT_CONFIG_PREFIX%&.
39647
39648 If the permitted configuration files are confined to a directory to
39649 which only root has access, this guards against someone who has broken
39650 into the Exim account from running a privileged Exim with an arbitrary
39651 configuration file, and using it to break into other accounts.
39652 .next
39653
39654 If a non-trusted configuration file (i.e. not the default configuration file
39655 or one which is trusted by virtue of being listed in the TRUSTED_CONFIG_LIST
39656 file) is specified with &%-C%&, or if macros are given with &%-D%& (but see
39657 the next item), then root privilege is retained only if the caller of Exim is
39658 root. This locks out the possibility of testing a configuration using &%-C%&
39659 right through message reception and delivery, even if the caller is root. The
39660 reception works, but by that time, Exim is running as the Exim user, so when
39661 it re-execs to regain privilege for the delivery, the use of &%-C%& causes
39662 privilege to be lost. However, root can test reception and delivery using two
39663 separate commands.
39664
39665 .next
39666 The WHITELIST_D_MACROS build option declares some macros to be safe to override
39667 with &%-D%& if the real uid is one of root, the Exim run-time user or the
39668 CONFIGURE_OWNER, if defined.  The potential impact of this option is limited by
39669 requiring the run-time value supplied to &%-D%& to match a regex that errs on
39670 the restrictive side.  Requiring build-time selection of safe macros is onerous
39671 but this option is intended solely as a transition mechanism to permit
39672 previously-working configurations to continue to work after release 4.73.
39673 .next
39674 If DISABLE_D_OPTION is defined, the use of the &%-D%& command line option
39675 is disabled.
39676 .next
39677 FIXED_NEVER_USERS can be set to a colon-separated list of users that are
39678 never to be used for any deliveries. This is like the &%never_users%& runtime
39679 option, but it cannot be overridden; the runtime option adds additional users
39680 to the list. The default setting is &"root"&; this prevents a non-root user who
39681 is permitted to modify the runtime file from using Exim as a way to get root.
39682 .endlist
39683
39684
39685
39686 .section "Root privilege" "SECID270"
39687 .cindex "setuid"
39688 .cindex "root privilege"
39689 The Exim binary is normally setuid to root, which means that it gains root
39690 privilege (runs as root) when it starts execution. In some special cases (for
39691 example, when the daemon is not in use and there are no local deliveries), it
39692 may be possible to run Exim setuid to some user other than root. This is
39693 discussed in the next section. However, in most installations, root privilege
39694 is required for two things:
39695
39696 .ilist
39697 To set up a socket connected to the standard SMTP port (25) when initialising
39698 the listening daemon. If Exim is run from &'inetd'&, this privileged action is
39699 not required.
39700 .next
39701 To be able to change uid and gid in order to read users' &_.forward_& files and
39702 perform local deliveries as the receiving user or as specified in the
39703 configuration.
39704 .endlist
39705
39706 It is not necessary to be root to do any of the other things Exim does, such as
39707 receiving messages and delivering them externally over SMTP, and it is
39708 obviously more secure if Exim does not run as root except when necessary.
39709 For this reason, a user and group for Exim to use must be defined in
39710 &_Local/Makefile_&. These are known as &"the Exim user"& and &"the Exim
39711 group"&. Their values can be changed by the runtime configuration, though this
39712 is not recommended. Often a user called &'exim'& is used, but some sites use
39713 &'mail'& or another user name altogether.
39714
39715 Exim uses &[setuid()]& whenever it gives up root privilege. This is a permanent
39716 abdication; the process cannot regain root afterwards. Prior to release 4.00,
39717 &[seteuid()]& was used in some circumstances, but this is no longer the case.
39718
39719 After a new Exim process has interpreted its command line options, it changes
39720 uid and gid in the following cases:
39721
39722 .ilist
39723 .oindex "&%-C%&"
39724 .oindex "&%-D%&"
39725 If the &%-C%& option is used to specify an alternate configuration file, or if
39726 the &%-D%& option is used to define macro values for the configuration, and the
39727 calling process is not running as root, the uid and gid are changed to those of
39728 the calling process.
39729 However, if DISABLE_D_OPTION is defined in &_Local/Makefile_&, the &%-D%&
39730 option may not be used at all.
39731 If WHITELIST_D_MACROS is defined in &_Local/Makefile_&, then some macro values
39732 can be supplied if the calling process is running as root, the Exim run-time
39733 user or CONFIGURE_OWNER, if defined.
39734 .next
39735 .oindex "&%-be%&"
39736 .oindex "&%-bf%&"
39737 .oindex "&%-bF%&"
39738 If the expansion test option (&%-be%&) or one of the filter testing options
39739 (&%-bf%& or &%-bF%&) are used, the uid and gid are changed to those of the
39740 calling process.
39741 .next
39742 If the process is not a daemon process or a queue runner process or a delivery
39743 process or a process for testing address routing (started with &%-bt%&), the
39744 uid and gid are changed to the Exim user and group. This means that Exim always
39745 runs under its own uid and gid when receiving messages. This also applies when
39746 testing address verification
39747 .oindex "&%-bv%&"
39748 .oindex "&%-bh%&"
39749 (the &%-bv%& option) and testing incoming message policy controls (the &%-bh%&
39750 option).
39751 .next
39752 For a daemon, queue runner, delivery, or address testing process, the uid
39753 remains as root at this stage, but the gid is changed to the Exim group.
39754 .endlist
39755
39756 The processes that initially retain root privilege behave as follows:
39757
39758 .ilist
39759 A daemon process changes the gid to the Exim group and the uid to the Exim
39760 user after setting up one or more listening sockets. The &[initgroups()]&
39761 function is called, so that if the Exim user is in any additional groups, they
39762 will be used during message reception.
39763 .next
39764 A queue runner process retains root privilege throughout its execution. Its
39765 job is to fork a controlled sequence of delivery processes.
39766 .next
39767 A delivery process retains root privilege throughout most of its execution,
39768 but any actual deliveries (that is, the transports themselves) are run in
39769 subprocesses which always change to a non-root uid and gid. For local
39770 deliveries this is typically the uid and gid of the owner of the mailbox; for
39771 remote deliveries, the Exim uid and gid are used. Once all the delivery
39772 subprocesses have been run, a delivery process changes to the Exim uid and gid
39773 while doing post-delivery tidying up such as updating the retry database and
39774 generating bounce and warning messages.
39775
39776 While the recipient addresses in a message are being routed, the delivery
39777 process runs as root. However, if a user's filter file has to be processed,
39778 this is done in a subprocess that runs under the individual user's uid and
39779 gid. A system filter is run as root unless &%system_filter_user%& is set.
39780 .next
39781 A process that is testing addresses (the &%-bt%& option) runs as root so that
39782 the routing is done in the same environment as a message delivery.
39783 .endlist
39784
39785
39786
39787
39788 .section "Running Exim without privilege" "SECTrunexiwitpri"
39789 .cindex "privilege, running without"
39790 .cindex "unprivileged running"
39791 .cindex "root privilege" "running without"
39792 Some installations like to run Exim in an unprivileged state for more of its
39793 operation, for added security. Support for this mode of operation is provided
39794 by the global option &%deliver_drop_privilege%&. When this is set, the uid and
39795 gid are changed to the Exim user and group at the start of a delivery process
39796 (and also queue runner and address testing processes). This means that address
39797 routing is no longer run as root, and the deliveries themselves cannot change
39798 to any other uid.
39799
39800 .cindex SIGHUP
39801 .cindex "daemon" "restarting"
39802 Leaving the binary setuid to root, but setting &%deliver_drop_privilege%& means
39803 that the daemon can still be started in the usual way, and it can respond
39804 correctly to SIGHUP because the re-invocation regains root privilege.
39805
39806 An alternative approach is to make Exim setuid to the Exim user and also setgid
39807 to the Exim group. If you do this, the daemon must be started from a root
39808 process. (Calling Exim from a root process makes it behave in the way it does
39809 when it is setuid root.) However, the daemon cannot restart itself after a
39810 SIGHUP signal because it cannot regain privilege.
39811
39812 It is still useful to set &%deliver_drop_privilege%& in this case, because it
39813 stops Exim from trying to re-invoke itself to do a delivery after a message has
39814 been received. Such a re-invocation is a waste of resources because it has no
39815 effect.
39816
39817 If restarting the daemon is not an issue (for example, if &%mua_wrapper%& is
39818 set, or &'inetd'& is being used instead of a daemon), having the binary setuid
39819 to the Exim user seems a clean approach, but there is one complication:
39820
39821 In this style of operation, Exim is running with the real uid and gid set to
39822 those of the calling process, and the effective uid/gid set to Exim's values.
39823 Ideally, any association with the calling process' uid/gid should be dropped,
39824 that is, the real uid/gid should be reset to the effective values so as to
39825 discard any privileges that the caller may have. While some operating systems
39826 have a function that permits this action for a non-root effective uid, quite a
39827 number of them do not. Because of this lack of standardization, Exim does not
39828 address this problem at this time.
39829
39830 For this reason, the recommended approach for &"mostly unprivileged"& running
39831 is to keep the Exim binary setuid to root, and to set
39832 &%deliver_drop_privilege%&. This also has the advantage of allowing a daemon to
39833 be used in the most straightforward way.
39834
39835 If you configure Exim not to run delivery processes as root, there are a
39836 number of restrictions on what you can do:
39837
39838 .ilist
39839 You can deliver only as the Exim user/group. You should  explicitly use the
39840 &%user%& and &%group%& options to override routers or local transports that
39841 normally deliver as the recipient. This makes sure that configurations that
39842 work in this mode function the same way in normal mode. Any implicit or
39843 explicit specification of another user causes an error.
39844 .next
39845 Use of &_.forward_& files is severely restricted, such that it is usually
39846 not worthwhile to include them in the configuration.
39847 .next
39848 Users who wish to use &_.forward_& would have to make their home directory and
39849 the file itself accessible to the Exim user. Pipe and append-to-file entries,
39850 and their equivalents in Exim filters, cannot be used. While they could be
39851 enabled in the Exim user's name, that would be insecure and not very useful.
39852 .next
39853 Unless the local user mailboxes are all owned by the Exim user (possible in
39854 some POP3 or IMAP-only environments):
39855
39856 .olist
39857 They must be owned by the Exim group and be writeable by that group. This
39858 implies you must set &%mode%& in the appendfile configuration, as well as the
39859 mode of the mailbox files themselves.
39860 .next
39861 You must set &%no_check_owner%&, since most or all of the files will not be
39862 owned by the Exim user.
39863 .next
39864 You must set &%file_must_exist%&, because Exim cannot set the owner correctly
39865 on a newly created mailbox when unprivileged. This also implies that new
39866 mailboxes need to be created manually.
39867 .endlist olist
39868 .endlist ilist
39869
39870
39871 These restrictions severely restrict what can be done in local deliveries.
39872 However, there are no restrictions on remote deliveries. If you are running a
39873 gateway host that does no local deliveries, setting &%deliver_drop_privilege%&
39874 gives more security at essentially no cost.
39875
39876 If you are using the &%mua_wrapper%& facility (see chapter
39877 &<<CHAPnonqueueing>>&), &%deliver_drop_privilege%& is forced to be true.
39878
39879
39880
39881
39882 .section "Delivering to local files" "SECID271"
39883 Full details of the checks applied by &(appendfile)& before it writes to a file
39884 are given in chapter &<<CHAPappendfile>>&.
39885
39886
39887
39888 .section "Running local commands" "SECTsecconslocalcmds"
39889 .cindex "security" "local commands"
39890 .cindex "security" "command injection attacks"
39891 There are a number of ways in which an administrator can configure Exim to run
39892 commands based upon received, untrustworthy, data. Further, in some
39893 configurations a user who can control a &_.forward_& file can also arrange to
39894 run commands. Configuration to check includes, but is not limited to:
39895
39896 .ilist
39897 Use of &%use_shell%& in the pipe transport: various forms of shell command
39898 injection may be possible with this option present. It is dangerous and should
39899 be used only with considerable caution. Consider constraints which whitelist
39900 allowed characters in a variable which is to be used in a pipe transport that
39901 has &%use_shell%& enabled.
39902 .next
39903 A number of options such as &%forbid_filter_run%&, &%forbid_filter_perl%&,
39904 &%forbid_filter_dlfunc%& and so forth which restrict facilities available to
39905 &_.forward_& files in a redirect router. If Exim is running on a central mail
39906 hub to which ordinary users do not have shell access, but home directories are
39907 NFS mounted (for instance) then administrators should review the list of these
39908 forbid options available, and should bear in mind that the options that may
39909 need forbidding can change as new features are added between releases.
39910 .next
39911 The &%${run...}%& expansion item does not use a shell by default, but
39912 administrators can configure use of &_/bin/sh_& as part of the command.
39913 Such invocations should be viewed with prejudicial suspicion.
39914 .next
39915 Administrators who use embedded Perl are advised to explore how Perl's
39916 taint checking might apply to their usage.
39917 .next
39918 Use of &%${expand...}%& is somewhat analogous to shell's eval builtin and
39919 administrators are well advised to view its use with suspicion, in case (for
39920 instance) it allows a local-part to contain embedded Exim directives.
39921 .next
39922 Use of &%${match_local_part...}%& and friends becomes more dangerous if
39923 Exim was built with EXPAND_LISTMATCH_RHS defined: the second string in
39924 each can reference arbitrary lists and files, rather than just being a list
39925 of opaque strings.
39926 The EXPAND_LISTMATCH_RHS option was added and set false by default because of
39927 real-world security vulnerabilities caused by its use with untrustworthy data
39928 injected in, for SQL injection attacks.
39929 Consider the use of the &%inlisti%& expansion condition instead.
39930 .endlist
39931
39932
39933
39934
39935 .section "Trust in configuration data" "SECTsecconfdata"
39936 .cindex "security" "data sources"
39937 .cindex "security" "regular expressions"
39938 .cindex "regular expressions" "security"
39939 .cindex "PCRE" "security"
39940 If configuration data for Exim can come from untrustworthy sources, there
39941 are some issues to be aware of:
39942
39943 .ilist
39944 Use of &%${expand...}%& may provide a path for shell injection attacks.
39945 .next
39946 Letting untrusted data provide a regular expression is unwise.
39947 .next
39948 Using &%${match...}%& to apply a fixed regular expression against untrusted
39949 data may result in pathological behaviour within PCRE.  Be aware of what
39950 "backtracking" means and consider options for being more strict with a regular
39951 expression. Avenues to explore include limiting what can match (avoiding &`.`&
39952 when &`[a-z0-9]`& or other character class will do), use of atomic grouping and
39953 possessive quantifiers or just not using regular expressions against untrusted
39954 data.
39955 .next
39956 It can be important to correctly use &%${quote:...}%&,
39957 &%${quote_local_part:...}%& and &%${quote_%&<&'lookup-type'&>&%:...}%& expansion
39958 items to ensure that data is correctly constructed.
39959 .next
39960 Some lookups might return multiple results, even though normal usage is only
39961 expected to yield one result.
39962 .endlist
39963
39964
39965
39966
39967 .section "IPv4 source routing" "SECID272"
39968 .cindex "source routing" "in IP packets"
39969 .cindex "IP source routing"
39970 Many operating systems suppress IP source-routed packets in the kernel, but
39971 some cannot be made to do this, so Exim does its own check. It logs incoming
39972 IPv4 source-routed TCP calls, and then drops them. Things are all different in
39973 IPv6. No special checking is currently done.
39974
39975
39976
39977 .section "The VRFY, EXPN, and ETRN commands in SMTP" "SECID273"
39978 Support for these SMTP commands is disabled by default. If required, they can
39979 be enabled by defining suitable ACLs.
39980
39981
39982
39983
39984 .section "Privileged users" "SECID274"
39985 .cindex "trusted users"
39986 .cindex "admin user"
39987 .cindex "privileged user"
39988 .cindex "user" "trusted"
39989 .cindex "user" "admin"
39990 Exim recognizes two sets of users with special privileges. Trusted users are
39991 able to submit new messages to Exim locally, but supply their own sender
39992 addresses and information about a sending host. For other users submitting
39993 local messages, Exim sets up the sender address from the uid, and doesn't
39994 permit a remote host to be specified.
39995
39996 .oindex "&%-f%&"
39997 However, an untrusted user is permitted to use the &%-f%& command line option
39998 in the special form &%-f <>%& to indicate that a delivery failure for the
39999 message should not cause an error report. This affects the message's envelope,
40000 but it does not affect the &'Sender:'& header. Untrusted users may also be
40001 permitted to use specific forms of address with the &%-f%& option by setting
40002 the &%untrusted_set_sender%& option.
40003
40004 Trusted users are used to run processes that receive mail messages from some
40005 other mail domain and pass them on to Exim for delivery either locally, or over
40006 the Internet. Exim trusts a caller that is running as root, as the Exim user,
40007 as any user listed in the &%trusted_users%& configuration option, or under any
40008 group listed in the &%trusted_groups%& option.
40009
40010 Admin users are permitted to do things to the messages on Exim's queue. They
40011 can freeze or thaw messages, cause them to be returned to their senders, remove
40012 them entirely, or modify them in various ways. In addition, admin users can run
40013 the Exim monitor and see all the information it is capable of providing, which
40014 includes the contents of files on the spool.
40015
40016 .oindex "&%-M%&"
40017 .oindex "&%-q%&"
40018 By default, the use of the &%-M%& and &%-q%& options to cause Exim to attempt
40019 delivery of messages on its queue is restricted to admin users. This
40020 restriction can be relaxed by setting the &%no_prod_requires_admin%& option.
40021 Similarly, the use of &%-bp%& (and its variants) to list the contents of the
40022 queue is also restricted to admin users. This restriction can be relaxed by
40023 setting &%no_queue_list_requires_admin%&.
40024
40025 Exim recognizes an admin user if the calling process is running as root or as
40026 the Exim user or if any of the groups associated with the calling process is
40027 the Exim group. It is not necessary actually to be running under the Exim
40028 group. However, if admin users who are not root or the Exim user are to access
40029 the contents of files on the spool via the Exim monitor (which runs
40030 unprivileged), Exim must be built to allow group read access to its spool
40031 files.
40032
40033 By default, regular users are trusted to perform basic testing and
40034 introspection commands, as themselves.  This setting can be tightened by
40035 setting the &%commandline_checks_require_admin%& option.
40036 This affects most of the checking options,
40037 such as &%-be%& and anything else &%-b*%&.
40038
40039
40040 .section "Spool files" "SECID275"
40041 .cindex "spool directory" "files"
40042 Exim's spool directory and everything it contains is owned by the Exim user and
40043 set to the Exim group. The mode for spool files is defined in the
40044 &_Local/Makefile_& configuration file, and defaults to 0640. This means that
40045 any user who is a member of the Exim group can access these files.
40046
40047
40048
40049 .section "Use of argv[0]" "SECID276"
40050 Exim examines the last component of &%argv[0]%&, and if it matches one of a set
40051 of specific strings, Exim assumes certain options. For example, calling Exim
40052 with the last component of &%argv[0]%& set to &"rsmtp"& is exactly equivalent
40053 to calling it with the option &%-bS%&. There are no security implications in
40054 this.
40055
40056
40057
40058 .section "Use of %f formatting" "SECID277"
40059 The only use made of &"%f"& by Exim is in formatting load average values. These
40060 are actually stored in integer variables as 1000 times the load average.
40061 Consequently, their range is limited and so therefore is the length of the
40062 converted output.
40063
40064
40065
40066 .section "Embedded Exim path" "SECID278"
40067 Exim uses its own path name, which is embedded in the code, only when it needs
40068 to re-exec in order to regain root privilege. Therefore, it is not root when it
40069 does so. If some bug allowed the path to get overwritten, it would lead to an
40070 arbitrary program's being run as exim, not as root.
40071
40072
40073
40074 .section "Dynamic module directory" "SECTdynmoddir"
40075 Any dynamically loadable modules must be installed into the directory
40076 defined in &`LOOKUP_MODULE_DIR`& in &_Local/Makefile_& for Exim to permit
40077 loading it.
40078
40079
40080 .section "Use of sprintf()" "SECID279"
40081 .cindex "&[sprintf()]&"
40082 A large number of occurrences of &"sprintf"& in the code are actually calls to
40083 &'string_sprintf()'&, a function that returns the result in malloc'd store.
40084 The intermediate formatting is done into a large fixed buffer by a function
40085 that runs through the format string itself, and checks the length of each
40086 conversion before performing it, thus preventing buffer overruns.
40087
40088 The remaining uses of &[sprintf()]& happen in controlled circumstances where
40089 the output buffer is known to be sufficiently long to contain the converted
40090 string.
40091
40092
40093
40094 .section "Use of debug_printf() and log_write()" "SECID280"
40095 Arbitrary strings are passed to both these functions, but they do their
40096 formatting by calling the function &'string_vformat()'&, which runs through
40097 the format string itself, and checks the length of each conversion.
40098
40099
40100
40101 .section "Use of strcat() and strcpy()" "SECID281"
40102 These are used only in cases where the output buffer is known to be large
40103 enough to hold the result.
40104 .ecindex IIDsecurcon
40105
40106
40107
40108
40109 . ////////////////////////////////////////////////////////////////////////////
40110 . ////////////////////////////////////////////////////////////////////////////
40111
40112 .chapter "Format of spool files" "CHAPspool"
40113 .scindex IIDforspo1 "format" "spool files"
40114 .scindex IIDforspo2 "spool directory" "format of files"
40115 .scindex IIDforspo3 "spool files" "format of"
40116 .cindex "spool files" "editing"
40117 A message on Exim's queue consists of two files, whose names are the message id
40118 followed by -D and -H, respectively. The data portion of the message is kept in
40119 the -D file on its own. The message's envelope, status, and headers are all
40120 kept in the -H file, whose format is described in this chapter. Each of these
40121 two files contains the final component of its own name as its first line. This
40122 is insurance against disk crashes where the directory is lost but the files
40123 themselves are recoverable.
40124
40125 The file formats may be changed, or new formats added, at any release.
40126 Spool files are not intended as an interface to other programs
40127 and should not be used as such.
40128
40129 Some people are tempted into editing -D files in order to modify messages. You
40130 need to be extremely careful if you do this; it is not recommended and you are
40131 on your own if you do it. Here are some of the pitfalls:
40132
40133 .ilist
40134 You must ensure that Exim does not try to deliver the message while you are
40135 fiddling with it. The safest way is to take out a write lock on the -D file,
40136 which is what Exim itself does, using &[fcntl()]&. If you update the file in
40137 place, the lock will be retained. If you write a new file and rename it, the
40138 lock will be lost at the instant of rename.
40139 .next
40140 .vindex "&$body_linecount$&"
40141 If you change the number of lines in the file, the value of
40142 &$body_linecount$&, which is stored in the -H file, will be incorrect and can
40143 cause incomplete transmission of messages or undeliverable messages.
40144 .next
40145 If the message is in MIME format, you must take care not to break it.
40146 .next
40147 If the message is cryptographically signed, any change will invalidate the
40148 signature.
40149 .endlist
40150 All in all, modifying -D files is fraught with danger.
40151
40152 Files whose names end with -J may also be seen in the &_input_& directory (or
40153 its subdirectories when &%split_spool_directory%& is set). These are journal
40154 files, used to record addresses to which the message has been delivered during
40155 the course of a delivery attempt. If there are still undelivered recipients at
40156 the end, the -H file is updated, and the -J file is deleted. If, however, there
40157 is some kind of crash (for example, a power outage) before this happens, the -J
40158 file remains in existence. When Exim next processes the message, it notices the
40159 -J file and uses it to update the -H file before starting the next delivery
40160 attempt.
40161
40162 Files whose names end with -K or .eml may also be seen in the spool.
40163 These are temporaries used for DKIM or malware processing, when that is used.
40164 They should be tidied up by normal operations; any old ones are probably
40165 relics of crashes and can be removed.
40166
40167 .section "Format of the -H file" "SECID282"
40168 .cindex "uid (user id)" "in spool file"
40169 .cindex "gid (group id)" "in spool file"
40170 The second line of the -H file contains the login name for the uid of the
40171 process that called Exim to read the message, followed by the numerical uid and
40172 gid. For a locally generated message, this is normally the user who sent the
40173 message. For a message received over TCP/IP via the daemon, it is
40174 normally the Exim user.
40175
40176 The third line of the file contains the address of the message's sender as
40177 transmitted in the envelope, contained in angle brackets. The sender address is
40178 empty for bounce messages. For incoming SMTP mail, the sender address is given
40179 in the MAIL command. For locally generated mail, the sender address is
40180 created by Exim from the login name of the current user and the configured
40181 &%qualify_domain%&. However, this can be overridden by the &%-f%& option or a
40182 leading &"From&~"& line if the caller is trusted, or if the supplied address is
40183 &"<>"& or an address that matches &%untrusted_set_senders%&.
40184
40185 The fourth line contains two numbers. The first is the time that the message
40186 was received, in the conventional Unix form &-- the number of seconds since the
40187 start of the epoch. The second number is a count of the number of messages
40188 warning of delayed delivery that have been sent to the sender.
40189
40190 There follow a number of lines starting with a hyphen. These can appear in any
40191 order, and are omitted when not relevant:
40192
40193 .vlist
40194 .vitem "&%-acl%&&~<&'number'&>&~<&'length'&>"
40195 This item is obsolete, and is not generated from Exim release 4.61 onwards;
40196 &%-aclc%& and &%-aclm%& are used instead. However, &%-acl%& is still
40197 recognized, to provide backward compatibility. In the old format, a line of
40198 this form is present for every ACL variable that is not empty. The number
40199 identifies the variable; the &%acl_c%&&*x*& variables are numbered 0&--9 and
40200 the &%acl_m%&&*x*& variables are numbered 10&--19. The length is the length of
40201 the data string for the variable. The string itself starts at the beginning of
40202 the next line, and is followed by a newline character. It may contain internal
40203 newlines.
40204
40205 .vitem "&%-aclc%&&~<&'rest-of-name'&>&~<&'length'&>"
40206 A line of this form is present for every ACL connection variable that is
40207 defined. Note that there is a space between &%-aclc%& and the rest of the name.
40208 The length is the length of the data string for the variable. The string itself
40209 starts at the beginning of the next line, and is followed by a newline
40210 character. It may contain internal newlines.
40211
40212 .vitem "&%-aclm%&&~<&'rest-of-name'&>&~<&'length'&>"
40213 A line of this form is present for every ACL message variable that is defined.
40214 Note that there is a space between &%-aclm%& and the rest of the name. The
40215 length is the length of the data string for the variable. The string itself
40216 starts at the beginning of the next line, and is followed by a newline
40217 character. It may contain internal newlines.
40218
40219 .vitem "&%-active_hostname%&&~<&'hostname'&>"
40220 This is present if, when the message was received over SMTP, the value of
40221 &$smtp_active_hostname$& was different to the value of &$primary_hostname$&.
40222
40223 .vitem &%-allow_unqualified_recipient%&
40224 This is present if unqualified recipient addresses are permitted in header
40225 lines (to stop such addresses from being qualified if rewriting occurs at
40226 transport time). Local messages that were input using &%-bnq%& and remote
40227 messages from hosts that match &%recipient_unqualified_hosts%& set this flag.
40228
40229 .vitem &%-allow_unqualified_sender%&
40230 This is present if unqualified sender addresses are permitted in header lines
40231 (to stop such addresses from being qualified if rewriting occurs at transport
40232 time). Local messages that were input using &%-bnq%& and remote messages from
40233 hosts that match &%sender_unqualified_hosts%& set this flag.
40234
40235 .vitem "&%-auth_id%&&~<&'text'&>"
40236 The id information for a message received on an authenticated SMTP connection
40237 &-- the value of the &$authenticated_id$& variable.
40238
40239 .vitem "&%-auth_sender%&&~<&'address'&>"
40240 The address of an authenticated sender &-- the value of the
40241 &$authenticated_sender$& variable.
40242
40243 .vitem "&%-body_linecount%&&~<&'number'&>"
40244 This records the number of lines in the body of the message, and is
40245 present unless &%-spool_file_wireformat%& is.
40246
40247 .vitem "&%-body_zerocount%&&~<&'number'&>"
40248 This records the number of binary zero bytes in the body of the message, and is
40249 present if the number is greater than zero.
40250
40251 .vitem &%-deliver_firsttime%&
40252 This is written when a new message is first added to the spool. When the spool
40253 file is updated after a deferral, it is omitted.
40254
40255 .vitem "&%-frozen%&&~<&'time'&>"
40256 .cindex "frozen messages" "spool data"
40257 The message is frozen, and the freezing happened at <&'time'&>.
40258
40259 .vitem "&%-helo_name%&&~<&'text'&>"
40260 This records the host name as specified by a remote host in a HELO or EHLO
40261 command.
40262
40263 .vitem "&%-host_address%&&~<&'address'&>.<&'port'&>"
40264 This records the IP address of the host from which the message was received and
40265 the remote port number that was used. It is omitted for locally generated
40266 messages.
40267
40268 .vitem "&%-host_auth%&&~<&'text'&>"
40269 If the message was received on an authenticated SMTP connection, this records
40270 the name of the authenticator &-- the value of the
40271 &$sender_host_authenticated$& variable.
40272
40273 .vitem &%-host_lookup_failed%&
40274 This is present if an attempt to look up the sending host's name from its IP
40275 address failed. It corresponds to the &$host_lookup_failed$& variable.
40276
40277 .vitem "&%-host_name%&&~<&'text'&>"
40278 .cindex "reverse DNS lookup"
40279 .cindex "DNS" "reverse lookup"
40280 This records the name of the remote host from which the message was received,
40281 if the host name was looked up from the IP address when the message was being
40282 received. It is not present if no reverse lookup was done.
40283
40284 .vitem "&%-ident%&&~<&'text'&>"
40285 For locally submitted messages, this records the login of the originating user,
40286 unless it was a trusted user and the &%-oMt%& option was used to specify an
40287 ident value. For messages received over TCP/IP, this records the ident string
40288 supplied by the remote host, if any.
40289
40290 .vitem "&%-interface_address%&&~<&'address'&>.<&'port'&>"
40291 This records the IP address of the local interface and the port number through
40292 which a message was received from a remote host. It is omitted for locally
40293 generated messages.
40294
40295 .vitem &%-local%&
40296 The message is from a local sender.
40297
40298 .vitem &%-localerror%&
40299 The message is a locally-generated bounce message.
40300
40301 .vitem "&%-local_scan%&&~<&'string'&>"
40302 This records the data string that was returned by the &[local_scan()]& function
40303 when the message was received &-- the value of the &$local_scan_data$&
40304 variable. It is omitted if no data was returned.
40305
40306 .vitem &%-manual_thaw%&
40307 The message was frozen but has been thawed manually, that is, by an explicit
40308 Exim command rather than via the auto-thaw process.
40309
40310 .vitem &%-N%&
40311 A testing delivery process was started using the &%-N%& option to suppress any
40312 actual deliveries, but delivery was deferred. At any further delivery attempts,
40313 &%-N%& is assumed.
40314
40315 .vitem &%-received_protocol%&
40316 This records the value of the &$received_protocol$& variable, which contains
40317 the name of the protocol by which the message was received.
40318
40319 .vitem &%-sender_set_untrusted%&
40320 The envelope sender of this message was set by an untrusted local caller (used
40321 to ensure that the caller is displayed in queue listings).
40322
40323 .vitem "&%-spam_score_int%&&~<&'number'&>"
40324 If a message was scanned by SpamAssassin, this is present. It records the value
40325 of &$spam_score_int$&.
40326
40327 .vitem &%-spool_file_wireformat%&
40328 The -D file for this message is in wire-format (for ESMTP CHUNKING)
40329 rather than Unix-format.
40330 The line-ending is CRLF rather than newline.
40331 There is still, however, no leading-dot-stuffing.
40332
40333 .vitem &%-tls_certificate_verified%&
40334 A TLS certificate was received from the client that sent this message, and the
40335 certificate was verified by the server.
40336
40337 .vitem "&%-tls_cipher%&&~<&'cipher name'&>"
40338 When the message was received over an encrypted connection, this records the
40339 name of the cipher suite that was used.
40340
40341 .vitem "&%-tls_peerdn%&&~<&'peer DN'&>"
40342 When the message was received over an encrypted connection, and a certificate
40343 was received from the client, this records the Distinguished Name from that
40344 certificate.
40345 .endlist
40346
40347 Any of the above may have an extra hyphen prepended, to indicate the the
40348 corresponding data is untrusted.
40349
40350 Following the options there is a list of those addresses to which the message
40351 is not to be delivered. This set of addresses is initialized from the command
40352 line when the &%-t%& option is used and &%extract_addresses_remove_arguments%&
40353 is set; otherwise it starts out empty. Whenever a successful delivery is made,
40354 the address is added to this set. The addresses are kept internally as a
40355 balanced binary tree, and it is a representation of that tree which is written
40356 to the spool file. If an address is expanded via an alias or forward file, the
40357 original address is added to the tree when deliveries to all its child
40358 addresses are complete.
40359
40360 If the tree is empty, there is a single line in the spool file containing just
40361 the text &"XX"&. Otherwise, each line consists of two letters, which are either
40362 Y or N, followed by an address. The address is the value for the node of the
40363 tree, and the letters indicate whether the node has a left branch and/or a
40364 right branch attached to it, respectively. If branches exist, they immediately
40365 follow. Here is an example of a three-node tree:
40366 .code
40367 YY darcy@austen.fict.example
40368 NN alice@wonderland.fict.example
40369 NN editor@thesaurus.ref.example
40370 .endd
40371 After the non-recipients tree, there is a list of the message's recipients.
40372 This is a simple list, preceded by a count. It includes all the original
40373 recipients of the message, including those to whom the message has already been
40374 delivered. In the simplest case, the list contains one address per line. For
40375 example:
40376 .code
40377 4
40378 editor@thesaurus.ref.example
40379 darcy@austen.fict.example
40380 rdo@foundation
40381 alice@wonderland.fict.example
40382 .endd
40383 However, when a child address has been added to the top-level addresses as a
40384 result of the use of the &%one_time%& option on a &(redirect)& router, each
40385 line is of the following form:
40386 .display
40387 <&'top-level address'&> <&'errors_to address'&> &&&
40388   <&'length'&>,<&'parent number'&>#<&'flag bits'&>
40389 .endd
40390 The 01 flag bit indicates the presence of the three other fields that follow
40391 the top-level address. Other bits may be used in future to support additional
40392 fields. The <&'parent number'&> is the offset in the recipients list of the
40393 original parent of the &"one time"& address. The first two fields are the
40394 envelope sender that is associated with this address and its length. If the
40395 length is zero, there is no special envelope sender (there are then two space
40396 characters in the line). A non-empty field can arise from a &(redirect)& router
40397 that has an &%errors_to%& setting.
40398
40399
40400 A blank line separates the envelope and status information from the headers
40401 which follow. A header may occupy several lines of the file, and to save effort
40402 when reading it in, each header is preceded by a number and an identifying
40403 character. The number is the number of characters in the header, including any
40404 embedded newlines and the terminating newline. The character is one of the
40405 following:
40406
40407 .table2 50pt
40408 .row <&'blank'&>         "header in which Exim has no special interest"
40409 .row &`B`&               "&'Bcc:'& header"
40410 .row &`C`&               "&'Cc:'& header"
40411 .row &`F`&               "&'From:'& header"
40412 .row &`I`&               "&'Message-id:'& header"
40413 .row &`P`&               "&'Received:'& header &-- P for &""postmark""&"
40414 .row &`R`&               "&'Reply-To:'& header"
40415 .row &`S`&               "&'Sender:'& header"
40416 .row &`T`&               "&'To:'& header"
40417 .row &`*`&               "replaced or deleted header"
40418 .endtable
40419
40420 Deleted or replaced (rewritten) headers remain in the spool file for debugging
40421 purposes. They are not transmitted when the message is delivered. Here is a
40422 typical set of headers:
40423 .code
40424 111P Received: by hobbit.fict.example with local (Exim 4.00)
40425 id 14y9EI-00026G-00; Fri, 11 May 2001 10:28:59 +0100
40426 049  Message-Id: <E14y9EI-00026G-00@hobbit.fict.example>
40427 038* X-rewrote-sender: bb@hobbit.fict.example
40428 042* From: Bilbo Baggins <bb@hobbit.fict.example>
40429 049F From: Bilbo Baggins <B.Baggins@hobbit.fict.example>
40430 099* To: alice@wonderland.fict.example, rdo@foundation,
40431 darcy@austen.fict.example, editor@thesaurus.ref.example
40432 104T To: alice@wonderland.fict.example, rdo@foundation.example,
40433 darcy@austen.fict.example, editor@thesaurus.ref.example
40434 038  Date: Fri, 11 May 2001 10:28:59 +0100
40435 .endd
40436 The asterisked headers indicate that the envelope sender, &'From:'& header, and
40437 &'To:'& header have been rewritten, the last one because routing expanded the
40438 unqualified domain &'foundation'&.
40439 .ecindex IIDforspo1
40440 .ecindex IIDforspo2
40441 .ecindex IIDforspo3
40442
40443 .section "Format of the -D file" "SECID282a"
40444 The data file is traditionally in Unix-standard format: lines are ended with
40445 an ASCII newline character.
40446 However, when the &%spool_wireformat%& main option is used some -D files
40447 can have an alternate format.
40448 This is flagged by a &%-spool_file_wireformat%& line in the corresponding -H file.
40449 The -D file lines (not including the first name-component line) are
40450 suitable for direct copying to the wire when transmitting using the
40451 ESMTP CHUNKING option, meaning lower processing overhead.
40452 Lines are terminated with an ASCII CRLF pair.
40453 There is no dot-stuffing (and no dot-termination).
40454
40455 . ////////////////////////////////////////////////////////////////////////////
40456 . ////////////////////////////////////////////////////////////////////////////
40457
40458 .chapter "DKIM, SPF and DMARC" "CHAPdkim" &&&
40459          "DKIM, SPF and DMARC Support"
40460
40461 .section "DKIM (DomainKeys Identified Mail)" SECDKIM
40462 .cindex "DKIM"
40463
40464 DKIM is a mechanism by which messages sent by some entity can be provably
40465 linked to a domain which that entity controls.  It permits reputation to
40466 be tracked on a per-domain basis, rather than merely upon source IP address.
40467 DKIM is documented in RFC 6376.
40468
40469 As DKIM relies on the message being unchanged in transit, messages handled
40470 by a mailing-list (which traditionally adds to the message) will not match
40471 any original DKIM signature.
40472
40473 DKIM support is compiled into Exim by default if TLS support is present.
40474 It can be disabled by setting DISABLE_DKIM=yes in &_Local/Makefile_&.
40475
40476 Exim's DKIM implementation allows for
40477 .olist
40478 Signing outgoing messages: This function is implemented in the SMTP transport.
40479 It can co-exist with all other Exim features
40480 (including transport filters)
40481 except cutthrough delivery.
40482 .next
40483 Verifying signatures in incoming messages: This is implemented by an additional
40484 ACL (acl_smtp_dkim), which can be called several times per message, with
40485 different signature contexts.
40486 .endlist
40487
40488 In typical Exim style, the verification implementation does not include any
40489 default "policy". Instead it enables you to build your own policy using
40490 Exim's standard controls.
40491
40492 Please note that verification of DKIM signatures in incoming mail is turned
40493 on by default for logging (in the <= line) purposes.
40494
40495 Additional log detail can be enabled using the &%dkim_verbose%& log_selector.
40496 When set, for each signature in incoming email,
40497 exim will log a line displaying the most important signature details, and the
40498 signature status. Here is an example (with line-breaks added for clarity):
40499 .code
40500 2009-09-09 10:22:28 1MlIRf-0003LU-U3 DKIM:
40501     d=facebookmail.com s=q1-2009b
40502     c=relaxed/relaxed a=rsa-sha1
40503     i=@facebookmail.com t=1252484542 [verification succeeded]
40504 .endd
40505
40506 You might want to turn off DKIM verification processing entirely for internal
40507 or relay mail sources. To do that, set the &%dkim_disable_verify%& ACL
40508 control modifier. This should typically be done in the RCPT ACL, at points
40509 where you accept mail from relay sources (internal hosts or authenticated
40510 senders).
40511
40512
40513 .section "Signing outgoing messages" "SECDKIMSIGN"
40514 .cindex "DKIM" "signing"
40515
40516 For signing to be usable you must have published a DKIM record in DNS.
40517 Note that RFC 8301 (which does not cover EC keys) says:
40518 .code
40519 rsa-sha1 MUST NOT be used for signing or verifying.
40520
40521 Signers MUST use RSA keys of at least 1024 bits for all keys.
40522 Signers SHOULD use RSA keys of at least 2048 bits.
40523 .endd
40524
40525 Note also that the key content (the 'p=' field)
40526 in the DNS record is different between RSA and EC keys;
40527 for the former it is the base64 of the ASN.1 for the RSA public key
40528 (equivalent to the private-key .pem with the header/trailer stripped)
40529 but for EC keys it is the base64 of the pure key; no ASN.1 wrapping.
40530
40531 Signing is enabled by setting private options on the SMTP transport.
40532 These options take (expandable) strings as arguments.
40533
40534 .option dkim_domain smtp string list&!! unset
40535 The domain(s) you want to sign with.
40536 After expansion, this can be a list.
40537 Each element in turn,
40538 lowercased,
40539 is put into the &%$dkim_domain%& expansion variable
40540 while expanding the remaining signing options.
40541 If it is empty after expansion, DKIM signing is not done,
40542 and no error will result even if &%dkim_strict%& is set.
40543
40544 .option dkim_selector smtp string list&!! unset
40545 This sets the key selector string.
40546 After expansion, which can use &$dkim_domain$&, this can be a list.
40547 Each element in turn is put in the expansion
40548 variable &%$dkim_selector%& which may be used in the &%dkim_private_key%&
40549 option along with &%$dkim_domain%&.
40550 If the option is empty after expansion, DKIM signing is not done for this domain,
40551 and no error will result even if &%dkim_strict%& is set.
40552
40553 .option dkim_private_key smtp string&!! unset
40554 This sets the private key to use.
40555 You can use the &%$dkim_domain%& and
40556 &%$dkim_selector%& expansion variables to determine the private key to use.
40557 The result can either
40558 .ilist
40559 be a valid RSA private key in ASCII armor (.pem file), including line breaks
40560 .next
40561 with GnuTLS 3.6.0 or OpenSSL 1.1.1 or later,
40562 be a valid Ed25519 private key (same format as above)
40563 .next
40564 start with a slash, in which case it is treated as a file that contains
40565 the private key
40566 .next
40567 be "0", "false" or the empty string, in which case the message will not
40568 be signed. This case will not result in an error, even if &%dkim_strict%&
40569 is set.
40570 .endlist
40571
40572 To generate keys under OpenSSL:
40573 .code
40574 openssl genrsa -out dkim_rsa.private 2048
40575 openssl rsa -in dkim_rsa.private -out /dev/stdout -pubout -outform PEM
40576 .endd
40577 The result file from the first command should be retained, and
40578 this option set to use it.
40579 Take the base-64 lines from the output of the second command, concatenated,
40580 for the DNS TXT record.
40581 See section 3.6 of RFC6376 for the record specification.
40582
40583 Under GnuTLS:
40584 .code
40585 certtool --generate-privkey --rsa --bits=2048 --password='' -8 --outfile=dkim_rsa.private
40586 certtool --load-privkey=dkim_rsa.private --pubkey-info
40587 .endd
40588
40589 Note that RFC 8301 says:
40590 .code
40591 Signers MUST use RSA keys of at least 1024 bits for all keys.
40592 Signers SHOULD use RSA keys of at least 2048 bits.
40593 .endd
40594
40595 EC keys for DKIM are defined by RFC 8463.
40596 They are considerably smaller than RSA keys for equivalent protection.
40597 As they are a recent development, users should consider dual-signing
40598 (by setting a list of selectors, and an expansion for this option)
40599 for some transition period.
40600 The "_CRYPTO_SIGN_ED25519" macro will be defined if support is present
40601 for EC keys.
40602
40603 OpenSSL 1.1.1 and GnuTLS 3.6.0 can create Ed25519 private keys:
40604 .code
40605 openssl genpkey -algorithm ed25519 -out dkim_ed25519.private
40606 certtool --generate-privkey --key-type=ed25519 --outfile=dkim_ed25519.private
40607 .endd
40608
40609 To produce the required public key value for a DNS record:
40610 .code
40611 openssl pkey -outform DER -pubout -in dkim_ed25519.private | tail -c +13 | base64
40612 certtool --load_privkey=dkim_ed25519.private --pubkey_info --outder | tail -c +13 | base64
40613 .endd
40614
40615 Exim also supports an alternate format
40616 of Ed25519 keys in DNS which was a candidate during development
40617 of the standard, but not adopted.
40618 A future release will probably drop that support.
40619
40620 .option dkim_hash smtp string&!! sha256
40621 Can be set to any one of the supported hash methods, which are:
40622 .ilist
40623 &`sha1`& &-- should not be used, is old and insecure
40624 .next
40625 &`sha256`& &-- the default
40626 .next
40627 &`sha512`& &-- possibly more secure but less well supported
40628 .endlist
40629
40630 Note that RFC 8301 says:
40631 .code
40632 rsa-sha1 MUST NOT be used for signing or verifying.
40633 .endd
40634
40635 .option dkim_identity smtp string&!! unset
40636 If set after expansion, the value is used to set an "i=" tag in
40637 the signing header.  The DKIM standards restrict the permissible
40638 syntax of this optional tag to a mail address, with possibly-empty
40639 local part, an @, and a domain identical to or subdomain of the "d="
40640 tag value.  Note that Exim does not check the value.
40641
40642 .option dkim_canon smtp string&!! unset
40643 This option sets the canonicalization method used when signing a message.
40644 The DKIM RFC currently supports two methods: "simple" and "relaxed".
40645 The option defaults to "relaxed" when unset. Note: the current implementation
40646 only supports signing with the same canonicalization method for both headers and body.
40647
40648 .option dkim_strict smtp string&!! unset
40649 This  option  defines  how  Exim  behaves  when  signing a message that
40650 should be signed fails for some reason.  When the expansion evaluates to
40651 either &"1"& or &"true"&, Exim will defer. Otherwise Exim will send the message
40652 unsigned. You can use the &%$dkim_domain%& and &%$dkim_selector%& expansion
40653 variables here.
40654
40655 .option dkim_sign_headers smtp string&!! "see below"
40656 If set, this option must expand to a colon-separated
40657 list of header names.
40658 Headers with these names, or the absence or such a header, will be included
40659 in the message signature.
40660 When unspecified, the header names listed in RFC4871 will be used,
40661 whether or not each header is present in the message.
40662 The default list is available for the expansion in the macro
40663 &"_DKIM_SIGN_HEADERS"&
40664 .new
40665 and an oversigning variant is in &"_DKIM_OVERSIGN_HEADERS"&.
40666 .wen
40667
40668 If a name is repeated, multiple headers by that name (or the absence thereof)
40669 will be signed.  The textually later headers in the headers part of the
40670 message are signed first, if there are multiples.
40671
40672 A name can be prefixed with either an &"="& or a &"+"& character.
40673 If an &"="& prefix is used, all headers that are present with this name
40674 will be signed.
40675 If a &"+"& prefix if used, all headers that are present with this name
40676 will be signed, and one signature added for a missing header with the
40677 name will be appended.
40678
40679 .option dkim_timestamps smtp integer&!! unset
40680 This option controls the inclusion of timestamp information in the signature.
40681 If not set, no such information will be included.
40682 Otherwise, must be an unsigned number giving an offset in seconds from the current time
40683 for the expiry tag
40684 (eg. 1209600 for two weeks);
40685 both creation (t=) and expiry (x=) tags will be included.
40686
40687 RFC 6376 lists these tags as RECOMMENDED.
40688
40689
40690 .section "Verifying DKIM signatures in incoming mail" "SECDKIMVFY"
40691 .cindex "DKIM" "verification"
40692
40693 Verification of DKIM signatures in SMTP incoming email is done for all
40694 messages for which an ACL control &%dkim_disable_verify%& has not been set.
40695 .cindex DKIM "selecting signature algorithms"
40696 Individual classes of signature algorithm can be ignored by changing
40697 the main options &%dkim_verify_hashes%& or &%dkim_verify_keytypes%&.
40698 The &%dkim_verify_minimal%& option can be set to cease verification
40699 processing for a message once the first passing signature is found.
40700
40701 .cindex authentication "expansion item"
40702 Performing verification sets up information used by the
40703 &%authresults%& expansion item.
40704
40705 For most purposes the default option settings suffice and the remainder
40706 of this section can be ignored.
40707
40708 The results of verification are made available to the
40709 &%acl_smtp_dkim%& ACL, which can examine and modify them.
40710 A missing ACL definition defaults to accept.
40711 By default, the ACL is called once for each
40712 syntactically(!) correct signature in the incoming message.
40713 If any ACL call does not accept, the message is not accepted.
40714 If a cutthrough delivery was in progress for the message, that is
40715 summarily dropped (having wasted the transmission effort).
40716
40717 To evaluate the verification result in the ACL
40718 a large number of expansion variables
40719 containing the signature status and its details are set up during the
40720 runtime of the ACL.
40721
40722 Calling the ACL only for existing signatures is not sufficient to build
40723 more advanced policies. For that reason, the main option
40724 &%dkim_verify_signers%&, and an expansion variable
40725 &%$dkim_signers%& exist.
40726
40727 The main option &%dkim_verify_signers%& can be set to a colon-separated
40728 list of DKIM domains or identities for which the ACL &%acl_smtp_dkim%& is
40729 called. It is expanded when the message has been received. At this point,
40730 the expansion variable &%$dkim_signers%& already contains a colon-separated
40731 list of signer domains and identities for the message. When
40732 &%dkim_verify_signers%& is not specified in the main configuration,
40733 it defaults as:
40734 .code
40735 dkim_verify_signers = $dkim_signers
40736 .endd
40737 This leads to the default behaviour of calling &%acl_smtp_dkim%& for each
40738 DKIM signature in the message. Current DKIM verifiers may want to explicitly
40739 call the ACL for known domains or identities. This would be achieved as follows:
40740 .code
40741 dkim_verify_signers = paypal.com:ebay.com:$dkim_signers
40742 .endd
40743 This would result in &%acl_smtp_dkim%& always being called for "paypal.com"
40744 and "ebay.com", plus all domains and identities that have signatures in the message.
40745 You can also be more creative in constructing your policy. For example:
40746 .code
40747 dkim_verify_signers = $sender_address_domain:$dkim_signers
40748 .endd
40749
40750 If a domain or identity is listed several times in the (expanded) value of
40751 &%dkim_verify_signers%&, the ACL is only called once for that domain or identity.
40752
40753 Note that if the option is set using untrustworthy data
40754 (such as the From: header)
40755 care should be taken to force lowercase for domains
40756 and for the domain part if identities.
40757 The default setting can be regarded as trustworthy in this respect.
40758
40759 If multiple signatures match a domain (or identity), the ACL is called once
40760 for each matching signature.
40761
40762
40763 Inside the DKIM ACL, the following expansion variables are
40764 available (from most to least important):
40765
40766
40767 .vlist
40768 .vitem &%$dkim_cur_signer%&
40769 The signer that is being evaluated in this ACL run. This can be a domain or
40770 an identity. This is one of the list items from the expanded main option
40771 &%dkim_verify_signers%& (see above).
40772
40773 .vitem &%$dkim_verify_status%&
40774 Within the DKIM ACL,
40775 a string describing the general status of the signature. One of
40776 .ilist
40777 &%none%&: There is no signature in the message for the current domain or
40778 identity (as reflected by &%$dkim_cur_signer%&).
40779 .next
40780 &%invalid%&: The signature could not be verified due to a processing error.
40781 More detail is available in &%$dkim_verify_reason%&.
40782 .next
40783 &%fail%&: Verification of the signature failed.  More detail is
40784 available in &%$dkim_verify_reason%&.
40785 .next
40786 &%pass%&: The signature passed verification. It is valid.
40787 .endlist
40788
40789 This variable can be overwritten using an ACL 'set' modifier.
40790 This might, for instance, be done to enforce a policy restriction on
40791 hash-method or key-size:
40792 .code
40793   warn condition       = ${if eq {$dkim_verify_status}{pass}}
40794        condition       = ${if eq {${length_3:$dkim_algo}}{rsa}}
40795        condition       = ${if or {{eq {$dkim_algo}{rsa-sha1}} \
40796                                   {< {$dkim_key_length}{1024}}}}
40797        logwrite        = NOTE: forcing DKIM verify fail (was pass)
40798        set dkim_verify_status = fail
40799        set dkim_verify_reason = hash too weak or key too short
40800 .endd
40801
40802 So long as a DKIM ACL is defined (it need do no more than accept),
40803 after all the DKIM ACL runs have completed, the value becomes a
40804 colon-separated list of the values after each run.
40805 This is maintained for the mime, prdr and data ACLs.
40806
40807 .vitem &%$dkim_verify_reason%&
40808 A string giving a little bit more detail when &%$dkim_verify_status%& is either
40809 "fail" or "invalid". One of
40810 .ilist
40811 &%pubkey_unavailable%& (when &%$dkim_verify_status%&="invalid"): The public
40812 key for the domain could not be retrieved. This may be a temporary problem.
40813 .next
40814 &%pubkey_syntax%& (when &%$dkim_verify_status%&="invalid"): The public key
40815 record for the domain is syntactically invalid.
40816 .next
40817 &%bodyhash_mismatch%& (when &%$dkim_verify_status%&="fail"): The calculated
40818 body hash does not match the one specified in the signature header. This
40819 means that the message body was modified in transit.
40820 .next
40821 &%signature_incorrect%& (when &%$dkim_verify_status%&="fail"): The signature
40822 could not be verified. This may mean that headers were modified,
40823 re-written or otherwise changed in a way which is incompatible with
40824 DKIM verification. It may of course also mean that the signature is forged.
40825 .endlist
40826
40827 This variable can be overwritten, with any value, using an ACL 'set' modifier.
40828
40829 .vitem &%$dkim_domain%&
40830 The signing domain. IMPORTANT: This variable is only populated if there is
40831 an actual signature in the message for the current domain or identity (as
40832 reflected by &%$dkim_cur_signer%&).
40833
40834 .vitem &%$dkim_identity%&
40835 The signing identity, if present. IMPORTANT: This variable is only populated
40836 if there is an actual signature in the message for the current domain or
40837 identity (as reflected by &%$dkim_cur_signer%&).
40838
40839 .vitem &%$dkim_selector%&
40840 The key record selector string.
40841
40842 .vitem &%$dkim_algo%&
40843 The algorithm used. One of 'rsa-sha1' or 'rsa-sha256'.
40844 If running under GnuTLS 3.6.0 or OpenSSL 1.1.1 or later,
40845 may also be 'ed25519-sha256'.
40846 The "_CRYPTO_SIGN_ED25519" macro will be defined if support is present
40847 for EC keys.
40848
40849 Note that RFC 8301 says:
40850 .code
40851 rsa-sha1 MUST NOT be used for signing or verifying.
40852
40853 DKIM signatures identified as having been signed with historic
40854 algorithms (currently, rsa-sha1) have permanently failed evaluation
40855 .endd
40856
40857 To enforce this you must either have a DKIM ACL which checks this variable
40858 and overwrites the &$dkim_verify_status$& variable as discussed above,
40859 or have set the main option &%dkim_verify_hashes%& to exclude
40860 processing of such signatures.
40861
40862 .vitem &%$dkim_canon_body%&
40863 The body canonicalization method. One of 'relaxed' or 'simple'.
40864
40865 .vitem &%$dkim_canon_headers%&
40866 The header canonicalization method. One of 'relaxed' or 'simple'.
40867
40868 .vitem &%$dkim_copiedheaders%&
40869 A transcript of headers and their values which are included in the signature
40870 (copied from the 'z=' tag of the signature).
40871 Note that RFC6376 requires that verification fail if the From: header is
40872 not included in the signature.  Exim does not enforce this; sites wishing
40873 strict enforcement should code the check explicitly.
40874
40875 .vitem &%$dkim_bodylength%&
40876 The number of signed body bytes. If zero ("0"), the body is unsigned. If no
40877 limit was set by the signer, "9999999999999" is returned. This makes sure
40878 that this variable always expands to an integer value.
40879 &*Note:*& The presence of the signature tag specifying a signing body length
40880 is one possible route to spoofing of valid DKIM signatures.
40881 A paranoid implementation might wish to regard signature where this variable
40882 shows less than the "no limit" return as being invalid.
40883
40884 .vitem &%$dkim_created%&
40885 UNIX timestamp reflecting the date and time when the signature was created.
40886 When this was not specified by the signer, "0" is returned.
40887
40888 .vitem &%$dkim_expires%&
40889 UNIX timestamp reflecting the date and time when the signer wants the
40890 signature to be treated as "expired". When this was not specified by the
40891 signer, "9999999999999" is returned. This makes it possible to do useful
40892 integer size comparisons against this value.
40893 Note that Exim does not check this value.
40894
40895 .vitem &%$dkim_headernames%&
40896 A colon-separated list of names of headers included in the signature.
40897
40898 .vitem &%$dkim_key_testing%&
40899 "1" if the key record has the "testing" flag set, "0" if not.
40900
40901 .vitem &%$dkim_key_nosubdomains%&
40902 "1" if the key record forbids subdomaining, "0" otherwise.
40903
40904 .vitem &%$dkim_key_srvtype%&
40905 Service type (tag s=) from the key record. Defaults to "*" if not specified
40906 in the key record.
40907
40908 .vitem &%$dkim_key_granularity%&
40909 Key granularity (tag g=) from the key record. Defaults to "*" if not specified
40910 in the key record.
40911
40912 .vitem &%$dkim_key_notes%&
40913 Notes from the key record (tag n=).
40914
40915 .vitem &%$dkim_key_length%&
40916 Number of bits in the key.
40917 .new
40918 Valid only once the key is loaded, which is at the time the header signature
40919 is verified, which is after the body hash is.
40920 .wen
40921
40922 Note that RFC 8301 says:
40923 .code
40924 Verifiers MUST NOT consider signatures using RSA keys of
40925 less than 1024 bits as valid signatures.
40926 .endd
40927
40928 This is enforced by the default setting for the &%dkim_verify_min_keysizes%&
40929 option.
40930
40931 .endlist
40932
40933 In addition, two ACL conditions are provided:
40934
40935 .vlist
40936 .vitem &%dkim_signers%&
40937 ACL condition that checks a colon-separated list of domains or identities
40938 for a match against the domain or identity that the ACL is currently verifying
40939 (reflected by &%$dkim_cur_signer%&). This is typically used to restrict an ACL
40940 verb to a group of domains or identities. For example:
40941
40942 .code
40943 # Warn when Mail purportedly from GMail has no gmail signature
40944 warn sender_domains = gmail.com
40945      dkim_signers = gmail.com
40946      dkim_status = none
40947      log_message = GMail sender without gmail.com DKIM signature
40948 .endd
40949
40950 Note that the above does not check for a total lack of DKIM signing;
40951 for that check for empty &$h_DKIM-Signature:$& in the data ACL.
40952
40953 .vitem &%dkim_status%&
40954 ACL condition that checks a colon-separated list of possible DKIM verification
40955 results against the actual result of verification. This is typically used
40956 to restrict an ACL verb to a list of verification outcomes, for example:
40957
40958 .code
40959 deny sender_domains = paypal.com:paypal.de
40960      dkim_signers = paypal.com:paypal.de
40961      dkim_status = none:invalid:fail
40962      message = Mail from Paypal with invalid/missing signature
40963 .endd
40964
40965 The possible status keywords are: 'none','invalid','fail' and 'pass'. Please
40966 see the documentation of the &%$dkim_verify_status%& expansion variable above
40967 for more information of what they mean.
40968 .endlist
40969
40970
40971
40972
40973 .section "SPF (Sender Policy Framework)" SECSPF
40974 .cindex SPF verification
40975
40976 SPF is a mechanism whereby a domain may assert which IP addresses may transmit
40977 messages with its domain in the envelope from, documented by RFC 7208.
40978 For more information on SPF see &url(http://www.open-spf.org), a static copy of
40979 the &url(http://openspf.org).
40980 . --- 2019-10-28: still not https, open-spf.org is told to be a
40981 . --- web-archive copy of the now dead openspf.org site
40982 . --- See https://www.mail-archive.com/mailop@mailop.org/msg08019.html for a
40983 . --- discussion.
40984
40985 Messages sent by a system not authorised will fail checking of such assertions.
40986 This includes retransmissions done by traditional forwarders.
40987
40988 SPF verification support is built into Exim if SUPPORT_SPF=yes is set in
40989 &_Local/Makefile_&.  The support uses the &_libspf2_& library
40990 &url(https://www.libspf2.org/).
40991 There is no Exim involvement in the transmission of messages;
40992 publishing certain DNS records is all that is required.
40993
40994 For verification, an ACL condition and an expansion lookup are provided.
40995 .cindex authentication "expansion item"
40996 Performing verification sets up information used by the
40997 &%authresults%& expansion item.
40998
40999
41000 .cindex SPF "ACL condition"
41001 .cindex ACL "spf condition"
41002 The ACL condition "spf" can be used at or after the MAIL ACL.
41003 It takes as an argument a list of strings giving the outcome of the SPF check,
41004 and will succeed for any matching outcome.
41005 Valid strings are:
41006 .vlist
41007 .vitem &%pass%&
41008 The SPF check passed, the sending host is positively verified by SPF.
41009
41010 .vitem &%fail%&
41011 The SPF check failed, the sending host is NOT allowed to send mail for the
41012 domain in the envelope-from address.
41013
41014 .vitem &%softfail%&
41015 The SPF check failed, but the queried domain can't absolutely confirm that this
41016 is a forgery.
41017
41018 .vitem &%none%&
41019 The queried domain does not publish SPF records.
41020
41021 .vitem &%neutral%&
41022 The SPF check returned a "neutral" state.  This means the queried domain has
41023 published a SPF record, but wants to allow outside servers to send mail under
41024 its domain as well.  This should be treated like "none".
41025
41026 .vitem &%permerror%&
41027 This indicates a syntax error in the SPF record of the queried domain.
41028 You may deny messages when this occurs.
41029
41030 .vitem &%temperror%&
41031 This indicates a temporary error during all processing, including Exim's
41032 SPF processing.  You may defer messages when this occurs.
41033 .endlist
41034
41035 You can prefix each string with an exclamation mark to  invert
41036 its meaning,  for example  "!fail" will  match all  results but
41037 "fail".  The  string  list is  evaluated  left-to-right,  in a
41038 short-circuit fashion.
41039
41040 Example:
41041 .code
41042 deny spf = fail
41043      message = $sender_host_address is not allowed to send mail from \
41044                ${if def:sender_address_domain \
41045                     {$sender_address_domain}{$sender_helo_name}}.  \
41046                Please see http://www.open-spf.org/Why;\
41047                identity=${if def:sender_address_domain \
41048                              {$sender_address}{$sender_helo_name}};\
41049                ip=$sender_host_address
41050 .endd
41051
41052 Note: The above mentioned URL may not be as helpful as expected. You are
41053 encouraged to replace the link with a link to a site with more
41054 explanations.
41055
41056 When the spf condition has run, it sets up several expansion
41057 variables:
41058
41059 .cindex SPF "verification variables"
41060 .vlist
41061 .vitem &$spf_header_comment$&
41062 .vindex &$spf_header_comment$&
41063   This contains a human-readable string describing the outcome
41064   of the SPF check. You can add it to a custom header or use
41065   it for logging purposes.
41066
41067 .vitem &$spf_received$&
41068 .vindex &$spf_received$&
41069   This contains a complete Received-SPF: header that can be
41070   added to the message. Please note that according to the SPF
41071   draft, this header must be added at the top of the header
41072   list. Please see section 10 on how you can do this.
41073
41074   Note: in case of "Best-guess" (see below), the convention is
41075   to put this string in a header called X-SPF-Guess: instead.
41076
41077 .vitem &$spf_result$&
41078 .vindex &$spf_result$&
41079   This contains the outcome of the SPF check in string form,
41080   one of pass, fail, softfail, none, neutral, permerror or
41081   temperror.
41082
41083 .vitem &$spf_result_guessed$&
41084 .vindex &$spf_result_guessed$&
41085   This boolean is true only if a best-guess operation was used
41086   and required in order to obtain a result.
41087
41088 .vitem &$spf_smtp_comment$&
41089 .vindex &$spf_smtp_comment$&
41090 .vindex &%spf_smtp_comment_template%&
41091   This contains a string that can be used in a SMTP response
41092   to the calling party. Useful for "fail".
41093 .new
41094   The string is generated by the SPF library from the template configured in the main config
41095   option &%spf_smtp_comment_template%&.
41096 .wen
41097 .endlist
41098
41099
41100 .cindex SPF "ACL condition"
41101 .cindex ACL "spf_guess condition"
41102 .cindex SPF "best guess"
41103 In addition to SPF, you can also perform checks for so-called
41104 "Best-guess".  Strictly speaking, "Best-guess" is not standard
41105 SPF, but it is supported by the same framework that enables SPF
41106 capability.
41107 Refer to &url(http://www.open-spf.org/FAQ/Best_guess_record)
41108 for a description of what it means.
41109 . --- 2019-10-28: still not https:
41110
41111 To access this feature, simply use the spf_guess condition in place
41112 of the spf one.  For example:
41113
41114 .code
41115 deny spf_guess = fail
41116      message = $sender_host_address doesn't look trustworthy to me
41117 .endd
41118
41119 In case you decide to reject messages based on this check, you
41120 should note that although it uses the same framework, "Best-guess"
41121 is not SPF, and therefore you should not mention SPF at all in your
41122 reject message.
41123
41124 When the spf_guess condition has run, it sets up the same expansion
41125 variables as when spf condition is run, described above.
41126
41127 Additionally, since Best-guess is not standardized, you may redefine
41128 what "Best-guess" means to you by redefining the main configuration
41129 &%spf_guess%& option.
41130 For example, the following:
41131
41132 .code
41133 spf_guess = v=spf1 a/16 mx/16 ptr ?all
41134 .endd
41135
41136 would relax host matching rules to a broader network range.
41137
41138
41139 .cindex SPF "lookup expansion"
41140 .cindex lookup spf
41141 A lookup expansion is also available. It takes an email
41142 address as the key and an IP address
41143 (v4 or v6)
41144 as the database:
41145
41146 .code
41147   ${lookup {username@domain} spf {ip.ip.ip.ip}}
41148 .endd
41149
41150 The lookup will return the same result strings as can appear in
41151 &$spf_result$& (pass,fail,softfail,neutral,none,err_perm,err_temp).
41152
41153
41154
41155
41156
41157 .section DMARC SECDMARC
41158 .cindex DMARC verification
41159
41160 DMARC combines feedback from SPF, DKIM, and header From: in order
41161 to attempt to provide better indicators of the authenticity of an
41162 email.  This document does not explain the fundamentals; you
41163 should read and understand how it works by visiting the website at
41164 &url(http://www.dmarc.org/).
41165
41166 If Exim is built with DMARC support,
41167 the libopendmarc library is used.
41168
41169 For building Exim yourself, obtain the library from
41170 &url(http://sourceforge.net/projects/opendmarc/)
41171 to obtain a copy, or find it in your favorite package
41172 repository.  You will need to attend to the local/Makefile feature
41173 SUPPORT_DMARC and the associated LDFLAGS addition.
41174 This description assumes
41175 that headers will be in /usr/local/include, and that the libraries
41176 are in /usr/local/lib.
41177
41178 . subsection
41179
41180 There are three main-configuration options:
41181 .cindex DMARC "configuration options"
41182
41183 The &%dmarc_tld_file%& option
41184 .oindex &%dmarc_tld_file%&
41185 defines the location of a text file of valid
41186 top level domains the opendmarc library uses
41187 during domain parsing. Maintained by Mozilla,
41188 the most current version can be downloaded
41189 from a link at &url(https://publicsuffix.org/list/public_suffix_list.dat).
41190 See also the util/renew-opendmarc-tlds.sh script.
41191 .new
41192 The default for the option is unset.
41193 If not set, DMARC processing is disabled.
41194 .wen
41195
41196
41197 The &%dmarc_history_file%& option, if set
41198 .oindex &%dmarc_history_file%&
41199 defines the location of a file to log results
41200 of dmarc verification on inbound emails. The
41201 contents are importable by the opendmarc tools
41202 which will manage the data, send out DMARC
41203 reports, and expire the data. Make sure the
41204 directory of this file is writable by the user
41205 exim runs as.
41206 The default is unset.
41207
41208 The &%dmarc_forensic_sender%& option
41209 .oindex &%dmarc_forensic_sender%&
41210 defines an alternate email address to use when sending a
41211 forensic report detailing alignment failures
41212 if a sender domain's dmarc record specifies it
41213 and you have configured Exim to send them.
41214 If set, this is expanded and used for the
41215 From: header line; the address is extracted
41216 from it and used for the envelope from.
41217 If not set (the default), the From: header is expanded from
41218 the dsn_from option, and <> is used for the
41219 envelope from.
41220
41221 . I wish we had subsections...
41222
41223 .cindex DMARC controls
41224 By default, the DMARC processing will run for any remote,
41225 non-authenticated user.  It makes sense to only verify DMARC
41226 status of messages coming from remote, untrusted sources.  You can
41227 use standard conditions such as hosts, senders, etc, to decide that
41228 DMARC verification should *not* be performed for them and disable
41229 DMARC with an ACL control modifier:
41230 .code
41231   control = dmarc_disable_verify
41232 .endd
41233 A DMARC record can also specify a "forensic address", which gives
41234 exim an email address to submit reports about failed alignment.
41235 Exim does not do this by default because in certain conditions it
41236 results in unintended information leakage (what lists a user might
41237 be subscribed to, etc).  You must configure exim to submit forensic
41238 reports to the owner of the domain.  If the DMARC record contains a
41239 forensic address and you specify the control statement below, then
41240 exim will send these forensic emails.  It is also advised that you
41241 configure a &%dmarc_forensic_sender%& because the default sender address
41242 construction might be inadequate.
41243 .code
41244   control = dmarc_enable_forensic
41245 .endd
41246 (AGAIN: You can choose not to send these forensic reports by simply
41247 not putting the dmarc_enable_forensic control line at any point in
41248 your exim config.  If you don't tell exim to send them, it will not
41249 send them.)
41250
41251 There are no options to either control.  Both must appear before
41252 the DATA acl.
41253
41254 . subsection
41255
41256 DMARC checks cam be run on incoming SMTP  messages by using the
41257 &"dmarc_status"& ACL condition in the DATA ACL.  You are required to
41258 call the &"spf"& condition first in the ACLs, then the &"dmarc_status"&
41259 condition.  Putting this condition in the ACLs is required in order
41260 for a DMARC check to actually occur.  All of the variables are set
41261 up before the DATA ACL, but there is no actual DMARC check that
41262 occurs until a &"dmarc_status"& condition is encountered in the ACLs.
41263
41264 The &"dmarc_status"& condition takes a list of strings on its
41265 right-hand side.  These strings describe recommended action based
41266 on the DMARC check.  To understand what the policy recommendations
41267 mean, refer to the DMARC website above.  Valid strings are:
41268 .display
41269 &'accept      '& The DMARC check passed and the library recommends accepting the email.
41270 &'reject      '& The DMARC check failed and the library recommends rejecting the email.
41271 &'quarantine  '& The DMARC check failed and the library recommends keeping it for further inspection.
41272 &'none        '& The DMARC check passed and the library recommends no specific action, neutral.
41273 &'norecord    '& No policy section in the DMARC record for this sender domain.
41274 &'nofrom      '& Unable to determine the domain of the sender.
41275 &'temperror   '& Library error or dns error.
41276 &'off         '& The DMARC check was disabled for this email.
41277 .endd
41278 You can prefix each string with an exclamation mark to invert its
41279 meaning, for example "!accept" will match all results but
41280 "accept".  The string list is evaluated left-to-right in a
41281 short-circuit fashion.  When a string matches the outcome of the
41282 DMARC check, the condition succeeds.  If none of the listed
41283 strings matches the outcome of the DMARC check, the condition
41284 fails.
41285
41286 Of course, you can also use any other lookup method that Exim
41287 supports, including LDAP, Postgres, MySQL, etc, as long as the
41288 result is a list of colon-separated strings.
41289
41290 Performing the check sets up information used by the
41291 &%authresults%& expansion item.
41292
41293 Several expansion variables are set before the DATA ACL is
41294 processed, and you can use them in this ACL.  The following
41295 expansion variables are available:
41296
41297 .vlist
41298 .vitem &$dmarc_status$&
41299 .vindex &$dmarc_status$&
41300 .cindex DMARC result
41301 A one word status indicating what the DMARC library
41302 thinks of the email.  It is a combination of the results of
41303 DMARC record lookup and the SPF/DKIM/DMARC processing results
41304 (if a DMARC record was found).  The actual policy declared
41305 in the DMARC record is in a separate expansion variable.
41306
41307 .vitem &$dmarc_status_text$&
41308 .vindex &$dmarc_status_text$&
41309 Slightly longer, human readable status.
41310
41311 .vitem &$dmarc_used_domain$&
41312 .vindex &$dmarc_used_domain$&
41313 The domain which DMARC used to look up the DMARC policy record.
41314
41315 .vitem &$dmarc_domain_policy$&
41316 .vindex &$dmarc_domain_policy$&
41317 The policy declared in the DMARC record.  Valid values
41318 are "none", "reject" and "quarantine".  It is blank when there
41319 is any error, including no DMARC record.
41320 .endlist
41321
41322 . subsection
41323
41324 By default, Exim's DMARC configuration is intended to be
41325 non-intrusive and conservative.  To facilitate this, Exim will not
41326 create any type of logging files without explicit configuration by
41327 you, the admin.  Nor will Exim send out any emails/reports about
41328 DMARC issues without explicit configuration by you, the admin (other
41329 than typical bounce messages that may come about due to ACL
41330 processing or failure delivery issues).
41331
41332 In order to log statistics suitable to be imported by the opendmarc
41333 tools, you need to:
41334 .ilist
41335 Configure the global option &%dmarc_history_file%&
41336 .next
41337 Configure cron jobs to call the appropriate opendmarc history
41338 import scripts and truncating the dmarc_history_file
41339 .endlist
41340
41341 In order to send forensic reports, you need to:
41342 .ilist
41343 Configure the global option &%dmarc_forensic_sender%&
41344 .next
41345 Configure, somewhere before the DATA ACL, the control option to
41346 enable sending DMARC forensic reports
41347 .endlist
41348
41349 . subsection
41350
41351 Example usage:
41352 .code
41353 (RCPT ACL)
41354   warn    domains        = +local_domains
41355           hosts          = +local_hosts
41356           control        = dmarc_disable_verify
41357
41358   warn    !domains       = +screwed_up_dmarc_records
41359           control        = dmarc_enable_forensic
41360
41361   warn    condition      = (lookup if destined to mailing list)
41362           set acl_m_mailing_list = 1
41363
41364 (DATA ACL)
41365   warn    dmarc_status   = accept : none : off
41366           !authenticated = *
41367           log_message    = DMARC DEBUG: $dmarc_status $dmarc_used_domain
41368
41369   warn    dmarc_status   = !accept
41370           !authenticated = *
41371           log_message    = DMARC DEBUG: '$dmarc_status' for $dmarc_used_domain
41372
41373   warn    dmarc_status   = quarantine
41374           !authenticated = *
41375           set $acl_m_quarantine = 1
41376           # Do something in a transport with this flag variable
41377
41378   deny    condition      = ${if eq{$dmarc_domain_policy}{reject}}
41379           condition      = ${if eq{$acl_m_mailing_list}{1}}
41380           message        = Messages from $dmarc_used_domain break mailing lists
41381
41382   deny    dmarc_status   = reject
41383           !authenticated = *
41384           message        = Message from $dmarc_used_domain failed sender's DMARC policy, REJECT
41385
41386   warn    add_header     = :at_start:${authresults {$primary_hostname}}
41387 .endd
41388
41389
41390
41391
41392
41393 . ////////////////////////////////////////////////////////////////////////////
41394 . ////////////////////////////////////////////////////////////////////////////
41395
41396 .chapter "Proxies" "CHAPproxies" &&&
41397          "Proxy support"
41398 .cindex "proxy support"
41399 .cindex "proxy" "access via"
41400
41401 A proxy is an intermediate system through which communication is passed.
41402 Proxies may provide a security, availability or load-distribution function.
41403
41404
41405 .section "Inbound proxies" SECTproxyInbound
41406 .cindex proxy inbound
41407 .cindex proxy "server side"
41408 .cindex proxy "Proxy protocol"
41409 .cindex "Proxy protocol" proxy
41410
41411 Exim has support for receiving inbound SMTP connections via a proxy
41412 that uses &"Proxy Protocol"& to speak to it.
41413 To include this support, include &"SUPPORT_PROXY=yes"&
41414 in Local/Makefile.
41415
41416 It was built on the HAProxy specification, found at
41417 &url(https://www.haproxy.org/download/1.8/doc/proxy-protocol.txt).
41418
41419 The purpose of this facility is so that an application load balancer,
41420 such as HAProxy, can sit in front of several Exim servers
41421 to distribute load.
41422 Exim uses the local protocol communication with the proxy to obtain
41423 the remote SMTP system IP address and port information.
41424 There is no logging if a host passes or
41425 fails Proxy Protocol negotiation, but it can easily be determined and
41426 recorded in an ACL (example is below).
41427
41428 Use of a proxy is enabled by setting the &%hosts_proxy%&
41429 main configuration option to a hostlist; connections from these
41430 hosts will use Proxy Protocol.
41431 Exim supports both version 1 and version 2 of the Proxy Protocol and
41432 automatically determines which version is in use.
41433
41434 The Proxy Protocol header is the first data received on a TCP connection
41435 and is inserted before any TLS-on-connect handshake from the client; Exim
41436 negotiates TLS between Exim-as-server and the remote client, not between
41437 Exim and the proxy server.
41438
41439 The following expansion variables are usable
41440 (&"internal"& and &"external"& here refer to the interfaces
41441 of the proxy):
41442 .display
41443 &'proxy_external_address   '& IP of host being proxied or IP of remote interface of proxy
41444 &'proxy_external_port      '& Port of host being proxied or Port on remote interface of proxy
41445 &'proxy_local_address      '& IP of proxy server inbound or IP of local interface of proxy
41446 &'proxy_local_port         '& Port of proxy server inbound or Port on local interface of proxy
41447 &'proxy_session            '& boolean: SMTP connection via proxy
41448 .endd
41449 If &$proxy_session$& is set but &$proxy_external_address$& is empty
41450 there was a protocol error.
41451 The variables &$sender_host_address$& and &$sender_host_port$&
41452 will have values for the actual client system, not the proxy.
41453
41454 Since the real connections are all coming from the proxy, and the
41455 per host connection tracking is done before Proxy Protocol is
41456 evaluated, &%smtp_accept_max_per_host%& must be set high enough to
41457 handle all of the parallel volume you expect per inbound proxy.
41458 With the option set so high, you lose the ability
41459 to protect your server from many connections from one IP.
41460 In order to prevent your server from overload, you
41461 need to add a per connection ratelimit to your connect ACL.
41462 A possible solution is:
41463 .display
41464   # Set max number of connections per host
41465   LIMIT   = 5
41466   # Or do some kind of IP lookup in a flat file or database
41467   # LIMIT = ${lookup{$sender_host_address}iplsearch{/etc/exim/proxy_limits}}
41468
41469   defer   ratelimit      = LIMIT / 5s / per_conn / strict
41470           message        = Too many connections from this IP right now
41471 .endd
41472
41473
41474
41475 .section "Outbound proxies" SECTproxySOCKS
41476 .cindex proxy outbound
41477 .cindex proxy "client side"
41478 .cindex proxy SOCKS
41479 .cindex SOCKS proxy
41480 Exim has support for sending outbound SMTP via a proxy
41481 using a protocol called SOCKS5 (defined by RFC1928).
41482 The support can be optionally included by defining SUPPORT_SOCKS=yes in
41483 Local/Makefile.
41484
41485 Use of a proxy is enabled by setting the &%socks_proxy%& option
41486 on an smtp transport.
41487 The option value is expanded and should then be a list
41488 (colon-separated by default) of proxy specifiers.
41489 Each proxy specifier is a list
41490 (space-separated by default) where the initial element
41491 is an IP address and any subsequent elements are options.
41492
41493 Options are a string <name>=<value>.
41494 The list of options is in the following table:
41495 .display
41496 &'auth   '& authentication method
41497 &'name   '& authentication username
41498 &'pass   '& authentication password
41499 &'port   '& tcp port
41500 &'tmo    '& connection timeout
41501 &'pri    '& priority
41502 &'weight '& selection bias
41503 .endd
41504
41505 More details on each of these options follows:
41506
41507 .ilist
41508 .cindex authentication "to proxy"
41509 .cindex proxy authentication
41510 &%auth%&: Either &"none"& (default) or &"name"&.
41511 Using &"name"& selects username/password authentication per RFC 1929
41512 for access to the proxy.
41513 Default is &"none"&.
41514 .next
41515 &%name%&: sets the username for the &"name"& authentication method.
41516 Default is empty.
41517 .next
41518 &%pass%&: sets the password for the &"name"& authentication method.
41519 Default is empty.
41520 .next
41521 &%port%&: the TCP port number to use for the connection to the proxy.
41522 Default is 1080.
41523 .next
41524 &%tmo%&: sets a connection timeout in seconds for this proxy.
41525 Default is 5.
41526 .next
41527 &%pri%&: specifies a priority for the proxy within the list,
41528 higher values being tried first.
41529 The default priority is 1.
41530 .next
41531 &%weight%&: specifies a selection bias.
41532 Within a priority set servers are queried in a random fashion,
41533 weighted by this value.
41534 The default value for selection bias is 1.
41535 .endlist
41536
41537 Proxies from the list are tried according to their priority
41538 and weight settings until one responds.  The timeout for the
41539 overall connection applies to the set of proxied attempts.
41540
41541 .section Logging SECTproxyLog
41542 To log the (local) IP of a proxy in the incoming or delivery logline,
41543 add &"+proxy"& to the &%log_selector%& option.
41544 This will add a component tagged with &"PRX="& to the line.
41545
41546 . ////////////////////////////////////////////////////////////////////////////
41547 . ////////////////////////////////////////////////////////////////////////////
41548
41549 .chapter "Internationalisation" "CHAPi18n" &&&
41550          "Internationalisation""
41551 .cindex internationalisation "email address"
41552 .cindex EAI
41553 .cindex i18n
41554 .cindex utf8 "mail name handling"
41555
41556 Exim has support for Internationalised mail names.
41557 To include this it must be built with SUPPORT_I18N and the libidn library.
41558 Standards supported are RFCs 2060, 5890, 6530 and 6533.
41559
41560 If Exim is built with SUPPORT_I18N_2008 (in addition to SUPPORT_I18N, not
41561 instead of it) then IDNA2008 is supported; this adds an extra library
41562 requirement, upon libidn2.
41563
41564 .section "MTA operations" SECTi18nMTA
41565 .cindex SMTPUTF8 "ESMTP option"
41566 .cindex "ESMTP extensions" SMTPUTF8
41567 The main configuration option &%smtputf8_advertise_hosts%& specifies
41568 a host list.  If this matches the sending host and
41569 accept_8bitmime is true (the default) then the ESMTP option
41570 SMTPUTF8 will be advertised.
41571
41572 If the sender specifies the SMTPUTF8 option on a MAIL command
41573 international handling for the message is enabled and
41574 the expansion variable &$message_smtputf8$& will have value TRUE.
41575
41576 The option &%allow_utf8_domains%& is set to true for this
41577 message. All DNS lookups are converted to a-label form
41578 whatever the setting of &%allow_utf8_domains%&
41579 when Exim is built with SUPPORT_I18N.
41580
41581 Both localparts and domain are maintained as the original
41582 UTF-8 form internally; any comparison or regular-expression use will
41583 require appropriate care.  Filenames created, eg. by
41584 the appendfile transport, will have UTF-8 names.
41585
41586 HELO names sent by the smtp transport will have any UTF-8
41587 components expanded to a-label form,
41588 and any certificate name checks will be done using the a-label
41589 form of the name.
41590
41591 .cindex log protocol
41592 .cindex SMTPUTF8 logging
41593 .cindex i18n logging
41594 Log lines and Received-by: header lines will acquire a "utf8"
41595 prefix on the protocol element, eg. utf8esmtp.
41596
41597 The following expansion operators can be used:
41598 .code
41599 ${utf8_domain_to_alabel:str}
41600 ${utf8_domain_from_alabel:str}
41601 ${utf8_localpart_to_alabel:str}
41602 ${utf8_localpart_from_alabel:str}
41603 .endd
41604
41605 .cindex utf8 "address downconversion"
41606 .cindex i18n "utf8 address downconversion"
41607 The RCPT ACL
41608 may use the following modifier:
41609 .display
41610 control = utf8_downconvert
41611 control = utf8_downconvert/<value>
41612 .endd
41613 This sets a flag requiring that envelope addresses are converted to
41614 a-label form before smtp delivery.
41615 This is usually for use in a Message Submission Agent context,
41616 but could be used for any message.
41617
41618 If a value is appended it may be:
41619 .display
41620 &`1  `& mandatory downconversion
41621 &`0  `& no downconversion
41622 &`-1 `& if SMTPUTF8 not supported by destination host
41623 .endd
41624 If no value is given, 1 is used.
41625
41626 If mua_wrapper is set, the utf8_downconvert control
41627 is initially set to -1.
41628
41629 The smtp transport has an option &%utf8_downconvert%&.
41630 If set it must expand to one of the three values described above,
41631 or an empty string.
41632 If non-empty it overrides value previously set
41633 (due to mua_wrapper or by an ACL control).
41634
41635
41636 There is no explicit support for VRFY and EXPN.
41637 Configurations supporting these should inspect
41638 &$smtp_command_argument$& for an SMTPUTF8 argument.
41639
41640 There is no support for LMTP on Unix sockets.
41641 Using the "lmtp" protocol option on an smtp transport,
41642 for LMTP over TCP, should work as expected.
41643
41644 There is no support for DSN unitext handling,
41645 and no provision for converting logging from or to UTF-8.
41646
41647
41648
41649 .section "MDA operations" SECTi18nMDA
41650 To aid in constructing names suitable for IMAP folders
41651 the following expansion operator can be used:
41652 .code
41653 ${imapfolder {<string>} {<sep>} {<specials>}}
41654 .endd
41655
41656 The string is converted from the charset specified by
41657 the "headers charset" command (in a filter file)
41658 or &%headers_charset%& main configuration option (otherwise),
41659 to the
41660 modified UTF-7 encoding specified by RFC 2060,
41661 with the following exception: All occurrences of <sep>
41662 (which has to be a single character)
41663 are replaced with periods ("."), and all periods and slashes that are not
41664 <sep> and are not in the <specials> string are BASE64 encoded.
41665
41666 The third argument can be omitted, defaulting to an empty string.
41667 The second argument can be omitted, defaulting to "/".
41668
41669 This is the encoding used by Courier for Maildir names on disk, and followed
41670 by many other IMAP servers.
41671
41672 Examples:
41673 .display
41674 &`${imapfolder {Foo/Bar}}       `& yields &`Foo.Bar`&
41675 &`${imapfolder {Foo/Bar}{.}{/}} `& yields &`Foo&&AC8-Bar`&
41676 &`${imapfolder {Räksmörgås}}    `& yields &`R&&AOQ-ksm&&APY-rg&&AOU-s`&
41677 .endd
41678
41679 Note that the source charset setting is vital, and also that characters
41680 must be representable in UTF-16.
41681
41682
41683 . ////////////////////////////////////////////////////////////////////////////
41684 . ////////////////////////////////////////////////////////////////////////////
41685
41686 .chapter "Events" "CHAPevents" &&&
41687          "Events"
41688 .cindex events
41689
41690 The events mechanism in Exim can be used to intercept processing at a number
41691 of points.  It was originally invented to give a way to do customised logging
41692 actions (for example, to a database) but can also be used to modify some
41693 processing actions.
41694
41695 Most installations will never need to use Events.
41696 The support can be left out of a build by defining DISABLE_EVENT=yes
41697 in &_Local/Makefile_&.
41698
41699 There are two major classes of events: main and transport.
41700 The main configuration option &%event_action%& controls reception events;
41701 a transport option &%event_action%& controls delivery events.
41702
41703 Both options are a string which is expanded when the event fires.
41704 An example might look like:
41705 .cindex logging custom
41706 .code
41707 event_action = ${if eq {msg:delivery}{$event_name} \
41708 {${lookup pgsql {SELECT * FROM record_Delivery( \
41709     '${quote_pgsql:$sender_address_domain}',\
41710     '${quote_pgsql:${lc:$sender_address_local_part}}', \
41711     '${quote_pgsql:$domain}', \
41712     '${quote_pgsql:${lc:$local_part}}', \
41713     '${quote_pgsql:$host_address}', \
41714     '${quote_pgsql:${lc:$host}}', \
41715     '${quote_pgsql:$message_exim_id}')}} \
41716 } {}}
41717 .endd
41718
41719 Events have names which correspond to the point in process at which they fire.
41720 The name is placed in the variable &$event_name$& and the event action
41721 expansion must check this, as it will be called for every possible event type.
41722
41723 .new
41724 The current list of events is:
41725 .wen
41726 .display
41727 &`dane:fail              after    transport  `& per connection
41728 &`msg:complete           after    main       `& per message
41729 &`msg:defer              after    transport  `& per message per delivery try
41730 &`msg:delivery           after    transport  `& per recipient
41731 &`msg:rcpt:host:defer    after    transport  `& per recipient per host
41732 &`msg:rcpt:defer         after    transport  `& per recipient
41733 &`msg:host:defer         after    transport  `& per host per delivery try; host errors
41734 &`msg:fail:delivery      after    transport  `& per recipient
41735 &`msg:fail:internal      after    main       `& per recipient
41736 &`tcp:connect            before   transport  `& per connection
41737 &`tcp:close              after    transport  `& per connection
41738 &`tls:cert               before   both       `& per certificate in verification chain
41739 &`smtp:connect           after    transport  `& per connection
41740 &`smtp:ehlo              after    transport  `& per connection
41741 .endd
41742 New event types may be added in future.
41743
41744 The event name is a colon-separated list, defining the type of
41745 event in a tree of possibilities.  It may be used as a list
41746 or just matched on as a whole.  There will be no spaces in the name.
41747
41748 The second column in the table above describes whether the event fires
41749 before or after the action is associates with.  Those which fire before
41750 can be used to affect that action (more on this below).
41751
41752 The third column in the table above says what section of the configuration
41753 should define the event action.
41754
41755 An additional variable, &$event_data$&, is filled with information varying
41756 with the event type:
41757 .display
41758 &`dane:fail            `& failure reason
41759 &`msg:defer            `& error string
41760 &`msg:delivery         `& smtp confirmation message
41761 &`msg:fail:internal    `& failure reason
41762 &`msg:fail:delivery    `& smtp error message
41763 &`msg:host:defer       `& error string
41764 &`msg:rcpt:host:defer  `& error string
41765 &`msg:rcpt:defer       `& error string
41766 &`tls:cert             `& verification chain depth
41767 &`smtp:connect         `& smtp banner
41768 &`smtp:ehlo            `& smtp ehlo response
41769 .endd
41770
41771 The :defer events populate one extra variable: &$event_defer_errno$&.
41772
41773 For complex operations an ACL expansion can be used in &%event_action%&
41774 however due to the multiple contexts that Exim operates in during
41775 the course of its processing:
41776 .ilist
41777 variables set in transport events will not be visible outside that
41778 transport call
41779 .next
41780 acl_m variables in a server context are lost on a new connection,
41781 and after smtp helo/ehlo/mail/starttls/rset commands
41782 .endlist
41783 Using an ACL expansion with the logwrite modifier can be
41784 a useful way of writing to the main log.
41785
41786 The expansion of the event_action option should normally
41787 return an empty string.  Should it return anything else the
41788 following will be forced:
41789 .display
41790 &`tcp:connect      `&  do not connect
41791 &`tls:cert         `&  refuse verification
41792 &`smtp:connect     `&  close connection
41793 .endd
41794 All other message types ignore the result string, and
41795 no other use is made of it.
41796
41797 For a tcp:connect event, if the connection is being made to a proxy
41798 then the address and port variables will be that of the proxy and not
41799 the target system.
41800
41801 For tls:cert events, if GnuTLS is in use this will trigger only per
41802 chain element received on the connection.
41803 For OpenSSL it will trigger for every chain element including those
41804 loaded locally.
41805
41806 . ////////////////////////////////////////////////////////////////////////////
41807 . ////////////////////////////////////////////////////////////////////////////
41808
41809 .chapter "Adding new drivers or lookup types" "CHID13" &&&
41810          "Adding drivers or lookups"
41811 .cindex "adding drivers"
41812 .cindex "new drivers, adding"
41813 .cindex "drivers" "adding new"
41814 The following actions have to be taken in order to add a new router, transport,
41815 authenticator, or lookup type to Exim:
41816
41817 .olist
41818 Choose a name for the driver or lookup type that does not conflict with any
41819 existing name; I will use &"newdriver"& in what follows.
41820 .next
41821 Add to &_src/EDITME_& the line:
41822 .display
41823 <&'type'&>&`_NEWDRIVER=yes`&
41824 .endd
41825 where <&'type'&> is ROUTER, TRANSPORT, AUTH, or LOOKUP. If the
41826 code is not to be included in the binary by default, comment this line out. You
41827 should also add any relevant comments about the driver or lookup type.
41828 .next
41829 Add to &_src/config.h.defaults_& the line:
41830 .code
41831 #define <type>_NEWDRIVER
41832 .endd
41833 .next
41834 Edit &_src/drtables.c_&, adding conditional code to pull in the private header
41835 and create a table entry as is done for all the other drivers and lookup types.
41836 .next
41837 Edit &_scripts/lookups-Makefile_& if this is a new lookup; there is a for-loop
41838 near the bottom, ranging the &`name_mod`& variable over a list of all lookups.
41839 Add your &`NEWDRIVER`& to that list.
41840 As long as the dynamic module would be named &_newdriver.so_&, you can use the
41841 simple form that most lookups have.
41842 .next
41843 Edit &_Makefile_& in the appropriate sub-directory (&_src/routers_&,
41844 &_src/transports_&, &_src/auths_&, or &_src/lookups_&); add a line for the new
41845 driver or lookup type and add it to the definition of OBJ.
41846 .next
41847 Edit &_OS/Makefile-Base_& adding a &_.o_& file for the predefined-macros, to the
41848 definition of OBJ_MACRO.  Add a set of line to do the compile also.
41849 .next
41850 Create &_newdriver.h_& and &_newdriver.c_& in the appropriate sub-directory of
41851 &_src_&.
41852 .next
41853 Edit &_scripts/MakeLinks_& and add commands to link the &_.h_& and &_.c_& files
41854 as for other drivers and lookups.
41855 .endlist
41856
41857 Then all you need to do is write the code! A good way to start is to make a
41858 proforma by copying an existing module of the same type, globally changing all
41859 occurrences of the name, and cutting out most of the code. Note that any
41860 options you create must be listed in alphabetical order, because the tables are
41861 searched using a binary chop procedure.
41862
41863 There is a &_README_& file in each of the sub-directories of &_src_& describing
41864 the interface that is expected.
41865
41866
41867
41868
41869 . ////////////////////////////////////////////////////////////////////////////
41870 . ////////////////////////////////////////////////////////////////////////////
41871
41872 . /////////////////////////////////////////////////////////////////////////////
41873 . These lines are processing instructions for the Simple DocBook Processor that
41874 . Philip Hazel has developed as a less cumbersome way of making PostScript and
41875 . PDFs than using xmlto and fop. They will be ignored by all other XML
41876 . processors.
41877 . /////////////////////////////////////////////////////////////////////////////
41878
41879 .literal xml
41880 <?sdop
41881   format="newpage"
41882   foot_right_recto="&chaptertitle;"
41883   foot_right_verso="&chaptertitle;"
41884 ?>
41885 .literal off
41886
41887 .makeindex "Options index"   "option"
41888 .makeindex "Variables index" "variable"
41889 .makeindex "Concept index"   "concept"
41890
41891
41892 . /////////////////////////////////////////////////////////////////////////////
41893 . /////////////////////////////////////////////////////////////////////////////