testcases for value return
[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 SMTP 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    message       = Restricted characters in address
5909         domains       = +local_domains
5910         local_parts   = ^[.] : ^.*[@%!/|]
5911
5912 deny    message       = Restricted characters in address
5913         domains       = !+local_domains
5914         local_parts   = ^[./|] : ^.*[@%!] : ^.*/\\.\\./
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    message     = rejected because $sender_host_address \
6019 #                       is in a black list at $dnslist_domain\n\
6020 #                       $dnslist_text
6021 #         dnslists    = black.list.example
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
6645 In the second example, the lookup is a single item in a domain list. It causes
6646 Exim to use a lookup to see if the domain that is being processed can be found
6647 in the file. The file could contains lines like this:
6648 .code
6649 domain1:
6650 domain2:
6651 .endd
6652 Any data that follows the keys is not relevant when checking that the domain
6653 matches the list item.
6654
6655 It is possible, though no doubt confusing, to use both kinds of lookup at once.
6656 Consider a file containing lines like this:
6657 .code
6658 192.168.5.6: lsearch;/another/file
6659 .endd
6660 If the value of &$sender_host_address$& is 192.168.5.6, expansion of the
6661 first &%domains%& setting above generates the second setting, which therefore
6662 causes a second lookup to occur.
6663
6664 The rest of this chapter describes the different lookup types that are
6665 available. Any of them can be used in any part of the configuration where a
6666 lookup is permitted.
6667
6668
6669 .section "Lookup types" "SECID61"
6670 .cindex "lookup" "types of"
6671 .cindex "single-key lookup" "definition of"
6672 Two different types of data lookup are implemented:
6673
6674 .ilist
6675 The &'single-key'& type requires the specification of a file in which to look,
6676 and a single key to search for. The key must be a non-empty string for the
6677 lookup to succeed. The lookup type determines how the file is searched.
6678 .new
6679 .cindex "tainted data" "single-key lookups"
6680 The file string may not be tainted
6681 .wen
6682 .next
6683 .cindex "query-style lookup" "definition of"
6684 The &'query-style'& type accepts a generalized database query. No particular
6685 key value is assumed by Exim for query-style lookups. You can use whichever
6686 Exim variables you need to construct the database query.
6687 .endlist
6688
6689 The code for each lookup type is in a separate source file that is included in
6690 the binary of Exim only if the corresponding compile-time option is set. The
6691 default settings in &_src/EDITME_& are:
6692 .code
6693 LOOKUP_DBM=yes
6694 LOOKUP_LSEARCH=yes
6695 .endd
6696 which means that only linear searching and DBM lookups are included by default.
6697 For some types of lookup (e.g. SQL databases), you need to install appropriate
6698 libraries and header files before building Exim.
6699
6700
6701
6702
6703 .section "Single-key lookup types" "SECTsinglekeylookups"
6704 .cindex "lookup" "single-key types"
6705 .cindex "single-key lookup" "list of types"
6706 The following single-key lookup types are implemented:
6707
6708 .ilist
6709 .cindex "cdb" "description of"
6710 .cindex "lookup" "cdb"
6711 .cindex "binary zero" "in lookup key"
6712 &(cdb)&: The given file is searched as a Constant DataBase file, using the key
6713 string without a terminating binary zero. The cdb format is designed for
6714 indexed files that are read frequently and never updated, except by total
6715 re-creation. As such, it is particularly suitable for large files containing
6716 aliases or other indexed data referenced by an MTA. Information about cdb and
6717 tools for building the files can be found in several places:
6718 .display
6719 &url(https://cr.yp.to/cdb.html)
6720 &url(https://www.corpit.ru/mjt/tinycdb.html)
6721 &url(https://packages.debian.org/stable/utils/freecdb)
6722 &url(https://github.com/philpennock/cdbtools) (in Go)
6723 .endd
6724 A cdb distribution is not needed in order to build Exim with cdb support,
6725 because the code for reading cdb files is included directly in Exim itself.
6726 However, no means of building or testing cdb files is provided with Exim, so
6727 you need to obtain a cdb distribution in order to do this.
6728 .next
6729 .cindex "DBM" "lookup type"
6730 .cindex "lookup" "dbm"
6731 .cindex "binary zero" "in lookup key"
6732 &(dbm)&: Calls to DBM library functions are used to extract data from the given
6733 DBM file by looking up the record with the given key. A terminating binary
6734 zero is included in the key that is passed to the DBM library. See section
6735 &<<SECTdb>>& for a discussion of DBM libraries.
6736
6737 .cindex "Berkeley DB library" "file format"
6738 For all versions of Berkeley DB, Exim uses the DB_HASH style of database
6739 when building DBM files using the &%exim_dbmbuild%& utility. However, when
6740 using Berkeley DB versions 3 or 4, it opens existing databases for reading with
6741 the DB_UNKNOWN option. This enables it to handle any of the types of database
6742 that the library supports, and can be useful for accessing DBM files created by
6743 other applications. (For earlier DB versions, DB_HASH is always used.)
6744 .next
6745 .cindex "lookup" "dbmjz"
6746 .cindex "lookup" "dbm &-- embedded NULs"
6747 .cindex "sasldb2"
6748 .cindex "dbmjz lookup type"
6749 &(dbmjz)&: This is the same as &(dbm)&, except that the lookup key is
6750 interpreted as an Exim list; the elements of the list are joined together with
6751 ASCII NUL characters to form the lookup key.  An example usage would be to
6752 authenticate incoming SMTP calls using the passwords from Cyrus SASL's
6753 &_/etc/sasldb2_& file with the &(gsasl)& authenticator or Exim's own
6754 &(cram_md5)& authenticator.
6755 .next
6756 .cindex "lookup" "dbmnz"
6757 .cindex "lookup" "dbm &-- terminating zero"
6758 .cindex "binary zero" "in lookup key"
6759 .cindex "Courier"
6760 .cindex "&_/etc/userdbshadow.dat_&"
6761 .cindex "dbmnz lookup type"
6762 &(dbmnz)&: This is the same as &(dbm)&, except that a terminating binary zero
6763 is not included in the key that is passed to the DBM library. You may need this
6764 if you want to look up data in files that are created by or shared with some
6765 other application that does not use terminating zeros. For example, you need to
6766 use &(dbmnz)& rather than &(dbm)& if you want to authenticate incoming SMTP
6767 calls using the passwords from Courier's &_/etc/userdbshadow.dat_& file. Exim's
6768 utility program for creating DBM files (&'exim_dbmbuild'&) includes the zeros
6769 by default, but has an option to omit them (see section &<<SECTdbmbuild>>&).
6770 .next
6771 .cindex "lookup" "dsearch"
6772 .cindex "dsearch lookup type"
6773 &(dsearch)&: The given file must be an
6774 .new
6775 absolute
6776 .wen
6777 directory path; this is searched for an entry
6778 whose name is the key by calling the &[lstat()]& function.
6779 The key may not
6780 contain any forward slash characters.
6781 If &[lstat()]& succeeds then so does the lookup.
6782 .new
6783 .cindex "tainted data" "dsearch result"
6784 The result is regarded as untainted.
6785
6786 Options for the lookup can be given by appending them after the word "dsearch",
6787 separated by a comma.  Options, if present, are a comma-separated list having
6788 each element starting with a tag name and an equals.
6789
6790 Two options are supported, for the return value and for filtering match
6791 candidates.
6792 The "ret" option requests an alternate result value of
6793 the entire path for the entry. Example:
6794 .code
6795 ${lookup {passwd} dsearch,ret=full {/etc}}
6796 .endd
6797 The default result is just the requested entry.
6798 The "filter" option requests that only directory entries of a given type
6799 are matched. The match value is one of "file", "dir" or "subdir" (the latter
6800 not matching "." or ".."). Example:
6801 .code
6802 ${lookup {passwd} dsearch,filter=file {/etc}}
6803 .endd
6804 The default matching is for any entry type, including directories
6805 and symlinks.
6806 .wen
6807
6808 An example of how this
6809 lookup can be used to support virtual domains is given in section
6810 &<<SECTvirtualdomains>>&.
6811 .next
6812 .cindex "lookup" "iplsearch"
6813 .cindex "iplsearch lookup type"
6814 &(iplsearch)&: The given file is a text file containing keys and data. A key is
6815 terminated by a colon or white space or the end of the line. The keys in the
6816 file must be IP addresses, or IP addresses with CIDR masks. Keys that involve
6817 IPv6 addresses must be enclosed in quotes to prevent the first internal colon
6818 being interpreted as a key terminator. For example:
6819 .code
6820 1.2.3.4:           data for 1.2.3.4
6821 192.168.0.0/16:    data for 192.168.0.0/16
6822 "abcd::cdab":      data for abcd::cdab
6823 "abcd:abcd::/32"   data for abcd:abcd::/32
6824 .endd
6825 The key for an &(iplsearch)& lookup must be an IP address (without a mask). The
6826 file is searched linearly, using the CIDR masks where present, until a matching
6827 key is found. The first key that matches is used; there is no attempt to find a
6828 &"best"& match. Apart from the way the keys are matched, the processing for
6829 &(iplsearch)& is the same as for &(lsearch)&.
6830
6831 &*Warning 1*&: Unlike most other single-key lookup types, a file of data for
6832 &(iplsearch)& can &'not'& be turned into a DBM or cdb file, because those
6833 lookup types support only literal keys.
6834
6835 &*Warning 2*&: In a host list, you must always use &(net-iplsearch)& so that
6836 the implicit key is the host's IP address rather than its name (see section
6837 &<<SECThoslispatsikey>>&).
6838
6839 &*Warning 3*&: Do not use an IPv4-mapped IPv6 address for a key; use the
6840 IPv4, in dotted-quad form. (Exim converts IPv4-mapped IPv6 addresses to this
6841 notation before executing the lookup.)
6842 .next
6843 .cindex lookup json
6844 .cindex json "lookup type"
6845 .cindex JSON expansions
6846 &(json)&: The given file is a text file with a JSON structure.
6847 An element of the structure is extracted, defined by the search key.
6848 The key is a list of subelement selectors
6849 (colon-separated by default but changeable in the usual way)
6850 which are applied in turn to select smaller and smaller portions
6851 of the JSON structure.
6852 If a selector is numeric, it must apply to a JSON array; the (zero-based)
6853 nunbered array element is selected.
6854 Otherwise it must apply to a JSON object; the named element is selected.
6855 The final resulting element can be a simple JSON type or a JSON object
6856 or array; for the latter two a string-representation of the JSON
6857 is returned.
6858 For elements of type string, the returned value is de-quoted.
6859 .next
6860 .cindex "linear search"
6861 .cindex "lookup" "lsearch"
6862 .cindex "lsearch lookup type"
6863 .cindex "case sensitivity" "in lsearch lookup"
6864 &(lsearch)&: The given file is a text file that is searched linearly for a
6865 line beginning with the search key, terminated by a colon or white space or the
6866 end of the line. The search is case-insensitive; that is, upper and lower case
6867 letters are treated as the same. The first occurrence of the key that is found
6868 in the file is used.
6869
6870 White space between the key and the colon is permitted. The remainder of the
6871 line, with leading and trailing white space removed, is the data. This can be
6872 continued onto subsequent lines by starting them with any amount of white
6873 space, but only a single space character is included in the data at such a
6874 junction. If the data begins with a colon, the key must be terminated by a
6875 colon, for example:
6876 .code
6877 baduser:  :fail:
6878 .endd
6879 Empty lines and lines beginning with # are ignored, even if they occur in the
6880 middle of an item. This is the traditional textual format of alias files. Note
6881 that the keys in an &(lsearch)& file are literal strings. There is no
6882 wildcarding of any kind.
6883
6884 .cindex "lookup" "lsearch &-- colons in keys"
6885 .cindex "white space" "in lsearch key"
6886 In most &(lsearch)& files, keys are not required to contain colons or #
6887 characters, or white space. However, if you need this feature, it is available.
6888 If a key begins with a doublequote character, it is terminated only by a
6889 matching quote (or end of line), and the normal escaping rules apply to its
6890 contents (see section &<<SECTstrings>>&). An optional colon is permitted after
6891 quoted keys (exactly as for unquoted keys). There is no special handling of
6892 quotes for the data part of an &(lsearch)& line.
6893
6894 .next
6895 .cindex "NIS lookup type"
6896 .cindex "lookup" "NIS"
6897 .cindex "binary zero" "in lookup key"
6898 &(nis)&: The given file is the name of a NIS map, and a NIS lookup is done with
6899 the given key, without a terminating binary zero. There is a variant called
6900 &(nis0)& which does include the terminating binary zero in the key. This is
6901 reportedly needed for Sun-style alias files. Exim does not recognize NIS
6902 aliases; the full map names must be used.
6903
6904 .next
6905 .cindex "wildlsearch lookup type"
6906 .cindex "lookup" "wildlsearch"
6907 .cindex "nwildlsearch lookup type"
6908 .cindex "lookup" "nwildlsearch"
6909 &(wildlsearch)& or &(nwildlsearch)&: These search a file linearly, like
6910 &(lsearch)&, but instead of being interpreted as a literal string, each key in
6911 the file may be wildcarded. The difference between these two lookup types is
6912 that for &(wildlsearch)&, each key in the file is string-expanded before being
6913 used, whereas for &(nwildlsearch)&, no expansion takes place.
6914
6915 .cindex "case sensitivity" "in (n)wildlsearch lookup"
6916 Like &(lsearch)&, the testing is done case-insensitively. However, keys in the
6917 file that are regular expressions can be made case-sensitive by the use of
6918 &`(-i)`& within the pattern. The following forms of wildcard are recognized:
6919
6920 . ==== As this is a nested list, any displays it contains must be indented
6921 . ==== as otherwise they are too far to the left.
6922
6923 .olist
6924 The string may begin with an asterisk to mean &"ends with"&. For example:
6925 .code
6926     *.a.b.c       data for anything.a.b.c
6927     *fish         data for anythingfish
6928 .endd
6929 .next
6930 The string may begin with a circumflex to indicate a regular expression. For
6931 example, for &(wildlsearch)&:
6932 .code
6933     ^\N\d+\.a\.b\N    data for <digits>.a.b
6934 .endd
6935 Note the use of &`\N`& to disable expansion of the contents of the regular
6936 expression. If you are using &(nwildlsearch)&, where the keys are not
6937 string-expanded, the equivalent entry is:
6938 .code
6939     ^\d+\.a\.b        data for <digits>.a.b
6940 .endd
6941 The case-insensitive flag is set at the start of compiling the regular
6942 expression, but it can be turned off by using &`(-i)`& at an appropriate point.
6943 For example, to make the entire pattern case-sensitive:
6944 .code
6945     ^(?-i)\d+\.a\.b        data for <digits>.a.b
6946 .endd
6947
6948 If the regular expression contains white space or colon characters, you must
6949 either quote it (see &(lsearch)& above), or represent these characters in other
6950 ways. For example, &`\s`& can be used for white space and &`\x3A`& for a
6951 colon. This may be easier than quoting, because if you quote, you have to
6952 escape all the backslashes inside the quotes.
6953
6954 &*Note*&: It is not possible to capture substrings in a regular expression
6955 match for later use, because the results of all lookups are cached. If a lookup
6956 is repeated, the result is taken from the cache, and no actual pattern matching
6957 takes place. The values of all the numeric variables are unset after a
6958 &((n)wildlsearch)& match.
6959
6960 .next
6961 Although I cannot see it being of much use, the general matching function that
6962 is used to implement &((n)wildlsearch)& means that the string may begin with a
6963 lookup name terminated by a semicolon, and followed by lookup data. For
6964 example:
6965 .code
6966     cdb;/some/file  data for keys that match the file
6967 .endd
6968 The data that is obtained from the nested lookup is discarded.
6969 .endlist olist
6970
6971 Keys that do not match any of these patterns are interpreted literally. The
6972 continuation rules for the data are the same as for &(lsearch)&, and keys may
6973 be followed by optional colons.
6974
6975 &*Warning*&: Unlike most other single-key lookup types, a file of data for
6976 &((n)wildlsearch)& can &'not'& be turned into a DBM or cdb file, because those
6977 lookup types support only literal keys.
6978
6979 .next
6980 .cindex "spf lookup type"
6981 .cindex "lookup" "spf"
6982 &(spf)&: If Exim is built with SPF support, manual lookups can be done
6983 (as opposed to the standard ACL condition method).
6984 For details see section &<<SECSPF>>&.
6985 .endlist ilist
6986
6987
6988 .section "Query-style lookup types" "SECTquerystylelookups"
6989 .cindex "lookup" "query-style types"
6990 .cindex "query-style lookup" "list of types"
6991 The supported query-style lookup types are listed below. Further details about
6992 many of them are given in later sections.
6993
6994 .ilist
6995 .cindex "DNS" "as a lookup type"
6996 .cindex "lookup" "DNS"
6997 &(dnsdb)&: This does a DNS search for one or more records whose domain names
6998 are given in the supplied query. The resulting data is the contents of the
6999 records. See section &<<SECTdnsdb>>&.
7000 .next
7001 .cindex "InterBase lookup type"
7002 .cindex "lookup" "InterBase"
7003 &(ibase)&: This does a lookup in an InterBase database.
7004 .next
7005 .cindex "LDAP" "lookup type"
7006 .cindex "lookup" "LDAP"
7007 &(ldap)&: This does an LDAP lookup using a query in the form of a URL, and
7008 returns attributes from a single entry. There is a variant called &(ldapm)&
7009 that permits values from multiple entries to be returned. A third variant
7010 called &(ldapdn)& returns the Distinguished Name of a single entry instead of
7011 any attribute values. See section &<<SECTldap>>&.
7012 .next
7013 .cindex "MySQL" "lookup type"
7014 .cindex "lookup" "MySQL"
7015 &(mysql)&: The format of the query is an SQL statement that is passed to a
7016 MySQL database. See section &<<SECTsql>>&.
7017 .next
7018 .cindex "NIS+ lookup type"
7019 .cindex "lookup" "NIS+"
7020 &(nisplus)&: This does a NIS+ lookup using a query that can specify the name of
7021 the field to be returned. See section &<<SECTnisplus>>&.
7022 .next
7023 .cindex "Oracle" "lookup type"
7024 .cindex "lookup" "Oracle"
7025 &(oracle)&: The format of the query is an SQL statement that is passed to an
7026 Oracle database. See section &<<SECTsql>>&.
7027 .next
7028 .cindex "lookup" "passwd"
7029 .cindex "passwd lookup type"
7030 .cindex "&_/etc/passwd_&"
7031 &(passwd)& is a query-style lookup with queries that are just user names. The
7032 lookup calls &[getpwnam()]& to interrogate the system password data, and on
7033 success, the result string is the same as you would get from an &(lsearch)&
7034 lookup on a traditional &_/etc/passwd file_&, though with &`*`& for the
7035 password value. For example:
7036 .code
7037 *:42:42:King Rat:/home/kr:/bin/bash
7038 .endd
7039 .next
7040 .cindex "PostgreSQL lookup type"
7041 .cindex "lookup" "PostgreSQL"
7042 &(pgsql)&: The format of the query is an SQL statement that is passed to a
7043 PostgreSQL database. See section &<<SECTsql>>&.
7044
7045 .next
7046 .cindex "Redis lookup type"
7047 .cindex lookup Redis
7048 &(redis)&: The format of the query is either a simple get or simple set,
7049 passed to a Redis database. See section &<<SECTsql>>&.
7050
7051 .next
7052 .cindex "sqlite lookup type"
7053 .cindex "lookup" "sqlite"
7054 &(sqlite)&: The format of the query is
7055 new
7056 an optional filename
7057 .wen
7058 followed by an SQL statement
7059 that is passed to an SQLite database. See section &<<SECTsqlite>>&.
7060
7061 .next
7062 &(testdb)&: This is a lookup type that is used for testing Exim. It is
7063 not likely to be useful in normal operation.
7064 .next
7065 .cindex "whoson lookup type"
7066 .cindex "lookup" "whoson"
7067 . --- still http:-only, 2018-09-07
7068 &(whoson)&: &'Whoson'& (&url(http://whoson.sourceforge.net)) is a protocol that
7069 allows a server to check whether a particular (dynamically allocated) IP
7070 address is currently allocated to a known (trusted) user and, optionally, to
7071 obtain the identity of the said user. For SMTP servers, &'Whoson'& was popular
7072 at one time for &"POP before SMTP"& authentication, but that approach has been
7073 superseded by SMTP authentication. In Exim, &'Whoson'& can be used to implement
7074 &"POP before SMTP"& checking using ACL statements such as
7075 .code
7076 require condition = \
7077   ${lookup whoson {$sender_host_address}{yes}{no}}
7078 .endd
7079 The query consists of a single IP address. The value returned is the name of
7080 the authenticated user, which is stored in the variable &$value$&. However, in
7081 this example, the data in &$value$& is not used; the result of the lookup is
7082 one of the fixed strings &"yes"& or &"no"&.
7083 .endlist
7084
7085
7086
7087 .section "Temporary errors in lookups" "SECID63"
7088 .cindex "lookup" "temporary error in"
7089 Lookup functions can return temporary error codes if the lookup cannot be
7090 completed. For example, an SQL or LDAP database might be unavailable. For this
7091 reason, it is not advisable to use a lookup that might do this for critical
7092 options such as a list of local domains.
7093
7094 When a lookup cannot be completed in a router or transport, delivery
7095 of the message (to the relevant address) is deferred, as for any other
7096 temporary error. In other circumstances Exim may assume the lookup has failed,
7097 or may give up altogether.
7098
7099
7100
7101 .section "Default values in single-key lookups" "SECTdefaultvaluelookups"
7102 .cindex "wildcard lookups"
7103 .cindex "lookup" "default values"
7104 .cindex "lookup" "wildcard"
7105 .cindex "lookup" "* added to type"
7106 .cindex "default" "in single-key lookups"
7107 In this context, a &"default value"& is a value specified by the administrator
7108 that is to be used if a lookup fails.
7109
7110 &*Note:*& This section applies only to single-key lookups. For query-style
7111 lookups, the facilities of the query language must be used. An attempt to
7112 specify a default for a query-style lookup provokes an error.
7113
7114 If &"*"& is added to a single-key lookup type (for example, &%lsearch*%&)
7115 and the initial lookup fails, the key &"*"& is looked up in the file to
7116 provide a default value. See also the section on partial matching below.
7117
7118 .cindex "*@ with single-key lookup"
7119 .cindex "lookup" "*@ added to type"
7120 .cindex "alias file" "per-domain default"
7121 Alternatively, if &"*@"& is added to a single-key lookup type (for example
7122 &%dbm*@%&) then, if the initial lookup fails and the key contains an @
7123 character, a second lookup is done with everything before the last @ replaced
7124 by *. This makes it possible to provide per-domain defaults in alias files
7125 that include the domains in the keys. If the second lookup fails (or doesn't
7126 take place because there is no @ in the key), &"*"& is looked up.
7127 For example, a &(redirect)& router might contain:
7128 .code
7129 data = ${lookup{$local_part@$domain}lsearch*@{/etc/mix-aliases}}
7130 .endd
7131 Suppose the address that is being processed is &'jane@eyre.example'&. Exim
7132 looks up these keys, in this order:
7133 .code
7134 jane@eyre.example
7135 *@eyre.example
7136 *
7137 .endd
7138 The data is taken from whichever key it finds first. &*Note*&: In an
7139 &(lsearch)& file, this does not mean the first of these keys in the file. A
7140 complete scan is done for each key, and only if it is not found at all does
7141 Exim move on to try the next key.
7142
7143
7144
7145 .section "Partial matching in single-key lookups" "SECTpartiallookup"
7146 .cindex "partial matching"
7147 .cindex "wildcard lookups"
7148 .cindex "lookup" "partial matching"
7149 .cindex "lookup" "wildcard"
7150 .cindex "asterisk" "in search type"
7151 The normal operation of a single-key lookup is to search the file for an exact
7152 match with the given key. However, in a number of situations where domains are
7153 being looked up, it is useful to be able to do partial matching. In this case,
7154 information in the file that has a key starting with &"*."& is matched by any
7155 domain that ends with the components that follow the full stop. For example, if
7156 a key in a DBM file is
7157 .code
7158 *.dates.fict.example
7159 .endd
7160 then when partial matching is enabled this is matched by (amongst others)
7161 &'2001.dates.fict.example'& and &'1984.dates.fict.example'&. It is also matched
7162 by &'dates.fict.example'&, if that does not appear as a separate key in the
7163 file.
7164
7165 &*Note*&: Partial matching is not available for query-style lookups. It is
7166 also not available for any lookup items in address lists (see section
7167 &<<SECTaddresslist>>&).
7168
7169 Partial matching is implemented by doing a series of separate lookups using
7170 keys constructed by modifying the original subject key. This means that it can
7171 be used with any of the single-key lookup types, provided that
7172 partial matching keys
7173 beginning with a special prefix (default &"*."&) are included in the data file.
7174 Keys in the file that do not begin with the prefix are matched only by
7175 unmodified subject keys when partial matching is in use.
7176
7177 Partial matching is requested by adding the string &"partial-"& to the front of
7178 the name of a single-key lookup type, for example, &%partial-dbm%&. When this
7179 is done, the subject key is first looked up unmodified; if that fails, &"*."&
7180 is added at the start of the subject key, and it is looked up again. If that
7181 fails, further lookups are tried with dot-separated components removed from the
7182 start of the subject key, one-by-one, and &"*."& added on the front of what
7183 remains.
7184
7185 A minimum number of two non-* components are required. This can be adjusted
7186 by including a number before the hyphen in the search type. For example,
7187 &%partial3-lsearch%& specifies a minimum of three non-* components in the
7188 modified keys. Omitting the number is equivalent to &"partial2-"&. If the
7189 subject key is &'2250.dates.fict.example'& then the following keys are looked
7190 up when the minimum number of non-* components is two:
7191 .code
7192 2250.dates.fict.example
7193 *.2250.dates.fict.example
7194 *.dates.fict.example
7195 *.fict.example
7196 .endd
7197 As soon as one key in the sequence is successfully looked up, the lookup
7198 finishes.
7199
7200 .cindex "lookup" "partial matching &-- changing prefix"
7201 .cindex "prefix" "for partial matching"
7202 The use of &"*."& as the partial matching prefix is a default that can be
7203 changed. The motivation for this feature is to allow Exim to operate with file
7204 formats that are used by other MTAs. A different prefix can be supplied in
7205 parentheses instead of the hyphen after &"partial"&. For example:
7206 .code
7207 domains = partial(.)lsearch;/some/file
7208 .endd
7209 In this example, if the domain is &'a.b.c'&, the sequence of lookups is
7210 &`a.b.c`&, &`.a.b.c`&, and &`.b.c`& (the default minimum of 2 non-wild
7211 components is unchanged). The prefix may consist of any punctuation characters
7212 other than a closing parenthesis. It may be empty, for example:
7213 .code
7214 domains = partial1()cdb;/some/file
7215 .endd
7216 For this example, if the domain is &'a.b.c'&, the sequence of lookups is
7217 &`a.b.c`&, &`b.c`&, and &`c`&.
7218
7219 If &"partial0"& is specified, what happens at the end (when the lookup with
7220 just one non-wild component has failed, and the original key is shortened right
7221 down to the null string) depends on the prefix:
7222
7223 .ilist
7224 If the prefix has zero length, the whole lookup fails.
7225 .next
7226 If the prefix has length 1, a lookup for just the prefix is done. For
7227 example, the final lookup for &"partial0(.)"& is for &`.`& alone.
7228 .next
7229 Otherwise, if the prefix ends in a dot, the dot is removed, and the
7230 remainder is looked up. With the default prefix, therefore, the final lookup is
7231 for &"*"& on its own.
7232 .next
7233 Otherwise, the whole prefix is looked up.
7234 .endlist
7235
7236
7237 If the search type ends in &"*"& or &"*@"& (see section
7238 &<<SECTdefaultvaluelookups>>& above), the search for an ultimate default that
7239 this implies happens after all partial lookups have failed. If &"partial0"& is
7240 specified, adding &"*"& to the search type has no effect with the default
7241 prefix, because the &"*"& key is already included in the sequence of partial
7242 lookups. However, there might be a use for lookup types such as
7243 &"partial0(.)lsearch*"&.
7244
7245 The use of &"*"& in lookup partial matching differs from its use as a wildcard
7246 in domain lists and the like. Partial matching works only in terms of
7247 dot-separated components; a key such as &`*fict.example`&
7248 in a database file is useless, because the asterisk in a partial matching
7249 subject key is always followed by a dot.
7250
7251
7252
7253
7254 .section "Lookup caching" "SECID64"
7255 .cindex "lookup" "caching"
7256 .cindex "caching" "lookup data"
7257 Exim caches all lookup results in order to avoid needless repetition of
7258 lookups. However, because (apart from the daemon) Exim operates as a collection
7259 of independent, short-lived processes, this caching applies only within a
7260 single Exim process. There is no inter-process lookup caching facility.
7261
7262 For single-key lookups, Exim keeps the relevant files open in case there is
7263 another lookup that needs them. In some types of configuration this can lead to
7264 many files being kept open for messages with many recipients. To avoid hitting
7265 the operating system limit on the number of simultaneously open files, Exim
7266 closes the least recently used file when it needs to open more files than its
7267 own internal limit, which can be changed via the &%lookup_open_max%& option.
7268
7269 The single-key lookup files are closed and the lookup caches are flushed at
7270 strategic points during delivery &-- for example, after all routing is
7271 complete.
7272
7273
7274
7275
7276 .section "Quoting lookup data" "SECID65"
7277 .cindex "lookup" "quoting"
7278 .cindex "quoting" "in lookups"
7279 When data from an incoming message is included in a query-style lookup, there
7280 is the possibility of special characters in the data messing up the syntax of
7281 the query. For example, a NIS+ query that contains
7282 .code
7283 [name=$local_part]
7284 .endd
7285 will be broken if the local part happens to contain a closing square bracket.
7286 For NIS+, data can be enclosed in double quotes like this:
7287 .code
7288 [name="$local_part"]
7289 .endd
7290 but this still leaves the problem of a double quote in the data. The rule for
7291 NIS+ is that double quotes must be doubled. Other lookup types have different
7292 rules, and to cope with the differing requirements, an expansion operator
7293 of the following form is provided:
7294 .code
7295 ${quote_<lookup-type>:<string>}
7296 .endd
7297 For example, the safest way to write the NIS+ query is
7298 .code
7299 [name="${quote_nisplus:$local_part}"]
7300 .endd
7301 See chapter &<<CHAPexpand>>& for full coverage of string expansions. The quote
7302 operator can be used for all lookup types, but has no effect for single-key
7303 lookups, since no quoting is ever needed in their key strings.
7304
7305
7306
7307
7308 .section "More about dnsdb" "SECTdnsdb"
7309 .cindex "dnsdb lookup"
7310 .cindex "lookup" "dnsdb"
7311 .cindex "DNS" "as a lookup type"
7312 The &(dnsdb)& lookup type uses the DNS as its database. A simple query consists
7313 of a record type and a domain name, separated by an equals sign. For example,
7314 an expansion string could contain:
7315 .code
7316 ${lookup dnsdb{mx=a.b.example}{$value}fail}
7317 .endd
7318 If the lookup succeeds, the result is placed in &$value$&, which in this case
7319 is used on its own as the result. If the lookup does not succeed, the
7320 &`fail`& keyword causes a &'forced expansion failure'& &-- see section
7321 &<<SECTforexpfai>>& for an explanation of what this means.
7322
7323 The supported DNS record types are A, CNAME, MX, NS, PTR, SOA, SPF, SRV, TLSA
7324 and TXT, and, when Exim is compiled with IPv6 support, AAAA.
7325 If no type is given, TXT is assumed.
7326
7327 For any record type, if multiple records are found, the data is returned as a
7328 concatenation, with newline as the default separator. The order, of course,
7329 depends on the DNS resolver. You can specify a different separator character
7330 between multiple records by putting a right angle-bracket followed immediately
7331 by the new separator at the start of the query. For example:
7332 .code
7333 ${lookup dnsdb{>: a=host1.example}}
7334 .endd
7335 It is permitted to specify a space as the separator character. Further
7336 white space is ignored.
7337 For lookup types that return multiple fields per record,
7338 an alternate field separator can be specified using a comma after the main
7339 separator character, followed immediately by the field separator.
7340
7341 .cindex "PTR record" "in &(dnsdb)& lookup"
7342 When the type is PTR,
7343 the data can be an IP address, written as normal; inversion and the addition of
7344 &%in-addr.arpa%& or &%ip6.arpa%& happens automatically. For example:
7345 .code
7346 ${lookup dnsdb{ptr=192.168.4.5}{$value}fail}
7347 .endd
7348 If the data for a PTR record is not a syntactically valid IP address, it is not
7349 altered and nothing is added.
7350
7351 .cindex "MX record" "in &(dnsdb)& lookup"
7352 .cindex "SRV record" "in &(dnsdb)& lookup"
7353 For an MX lookup, both the preference value and the host name are returned for
7354 each record, separated by a space. For an SRV lookup, the priority, weight,
7355 port, and host name are returned for each record, separated by spaces.
7356 The field separator can be modified as above.
7357
7358 .cindex "TXT record" "in &(dnsdb)& lookup"
7359 .cindex "SPF record" "in &(dnsdb)& lookup"
7360 For TXT records with multiple items of data, only the first item is returned,
7361 unless a field separator is specified.
7362 To concatenate items without a separator, use a semicolon instead.
7363 For SPF records the
7364 default behaviour is to concatenate multiple items without using a separator.
7365 .code
7366 ${lookup dnsdb{>\n,: txt=a.b.example}}
7367 ${lookup dnsdb{>\n; txt=a.b.example}}
7368 ${lookup dnsdb{spf=example.org}}
7369 .endd
7370 It is permitted to specify a space as the separator character. Further
7371 white space is ignored.
7372
7373 .cindex "SOA record" "in &(dnsdb)& lookup"
7374 For an SOA lookup, while no result is obtained the lookup is redone with
7375 successively more leading components dropped from the given domain.
7376 Only the primary-nameserver field is returned unless a field separator is
7377 specified.
7378 .code
7379 ${lookup dnsdb{>:,; soa=a.b.example.com}}
7380 .endd
7381
7382 .section "Dnsdb lookup modifiers" "SECTdnsdb_mod"
7383 .cindex "dnsdb modifiers"
7384 .cindex "modifiers" "dnsdb"
7385 .cindex "options" "dnsdb"
7386 Modifiers for &(dnsdb)& lookups are given by optional keywords,
7387 each followed by a comma,
7388 that may appear before the record type.
7389
7390 The &(dnsdb)& lookup fails only if all the DNS lookups fail. If there is a
7391 temporary DNS error for any of them, the behaviour is controlled by
7392 a defer-option modifier.
7393 The possible keywords are
7394 &"defer_strict"&, &"defer_never"&, and &"defer_lax"&.
7395 With &"strict"& behaviour, any temporary DNS error causes the
7396 whole lookup to defer. With &"never"& behaviour, a temporary DNS error is
7397 ignored, and the behaviour is as if the DNS lookup failed to find anything.
7398 With &"lax"& behaviour, all the queries are attempted, but a temporary DNS
7399 error causes the whole lookup to defer only if none of the other lookups
7400 succeed. The default is &"lax"&, so the following lookups are equivalent:
7401 .code
7402 ${lookup dnsdb{defer_lax,a=one.host.com:two.host.com}}
7403 ${lookup dnsdb{a=one.host.com:two.host.com}}
7404 .endd
7405 Thus, in the default case, as long as at least one of the DNS lookups
7406 yields some data, the lookup succeeds.
7407
7408 .cindex "DNSSEC" "dns lookup"
7409 Use of &(DNSSEC)& is controlled by a dnssec modifier.
7410 The possible keywords are
7411 &"dnssec_strict"&, &"dnssec_lax"&, and &"dnssec_never"&.
7412 With &"strict"& or &"lax"& DNSSEC information is requested
7413 with the lookup.
7414 With &"strict"& a response from the DNS resolver that
7415 is not labelled as authenticated data
7416 is treated as equivalent to a temporary DNS error.
7417 The default is &"lax"&.
7418
7419 See also the &$lookup_dnssec_authenticated$& variable.
7420
7421 .cindex timeout "dns lookup"
7422 .cindex "DNS" timeout
7423 Timeout for the dnsdb lookup can be controlled by a retrans modifier.
7424 The form is &"retrans_VAL"& where VAL is an Exim time specification
7425 (e.g. &"5s"&).
7426 The default value is set by the main configuration option &%dns_retrans%&.
7427
7428 Retries for the dnsdb lookup can be controlled by a retry modifier.
7429 The form if &"retry_VAL"& where VAL is an integer.
7430 The default count is set by the main configuration option &%dns_retry%&.
7431
7432 .cindex caching "of dns lookup"
7433 .cindex TTL "of dns lookup"
7434 .cindex DNS TTL
7435 Dnsdb lookup results are cached within a single process (and its children).
7436 The cache entry lifetime is limited to the smallest time-to-live (TTL)
7437 value of the set of returned DNS records.
7438
7439
7440 .section "Pseudo dnsdb record types" "SECID66"
7441 .cindex "MX record" "in &(dnsdb)& lookup"
7442 By default, both the preference value and the host name are returned for
7443 each MX record, separated by a space. If you want only host names, you can use
7444 the pseudo-type MXH:
7445 .code
7446 ${lookup dnsdb{mxh=a.b.example}}
7447 .endd
7448 In this case, the preference values are omitted, and just the host names are
7449 returned.
7450
7451 .cindex "name server for enclosing domain"
7452 Another pseudo-type is ZNS (for &"zone NS"&). It performs a lookup for NS
7453 records on the given domain, but if none are found, it removes the first
7454 component of the domain name, and tries again. This process continues until NS
7455 records are found or there are no more components left (or there is a DNS
7456 error). In other words, it may return the name servers for a top-level domain,
7457 but it never returns the root name servers. If there are no NS records for the
7458 top-level domain, the lookup fails. Consider these examples:
7459 .code
7460 ${lookup dnsdb{zns=xxx.quercite.com}}
7461 ${lookup dnsdb{zns=xxx.edu}}
7462 .endd
7463 Assuming that in each case there are no NS records for the full domain name,
7464 the first returns the name servers for &%quercite.com%&, and the second returns
7465 the name servers for &%edu%&.
7466
7467 You should be careful about how you use this lookup because, unless the
7468 top-level domain does not exist, the lookup always returns some host names. The
7469 sort of use to which this might be put is for seeing if the name servers for a
7470 given domain are on a blacklist. You can probably assume that the name servers
7471 for the high-level domains such as &%com%& or &%co.uk%& are not going to be on
7472 such a list.
7473
7474 .cindex "CSA" "in &(dnsdb)& lookup"
7475 A third pseudo-type is CSA (Client SMTP Authorization). This looks up SRV
7476 records according to the CSA rules, which are described in section
7477 &<<SECTverifyCSA>>&. Although &(dnsdb)& supports SRV lookups directly, this is
7478 not sufficient because of the extra parent domain search behaviour of CSA. The
7479 result of a successful lookup such as:
7480 .code
7481 ${lookup dnsdb {csa=$sender_helo_name}}
7482 .endd
7483 has two space-separated fields: an authorization code and a target host name.
7484 The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
7485 authorization required but absent, or &"?"& for unknown.
7486
7487 .cindex "A+" "in &(dnsdb)& lookup"
7488 The pseudo-type A+ performs an AAAA
7489 and then an A lookup.  All results are returned; defer processing
7490 (see below) is handled separately for each lookup.  Example:
7491 .code
7492 ${lookup dnsdb {>; a+=$sender_helo_name}}
7493 .endd
7494
7495
7496 .section "Multiple dnsdb lookups" "SECID67"
7497 In the previous sections, &(dnsdb)& lookups for a single domain are described.
7498 However, you can specify a list of domains or IP addresses in a single
7499 &(dnsdb)& lookup. The list is specified in the normal Exim way, with colon as
7500 the default separator, but with the ability to change this. For example:
7501 .code
7502 ${lookup dnsdb{one.domain.com:two.domain.com}}
7503 ${lookup dnsdb{a=one.host.com:two.host.com}}
7504 ${lookup dnsdb{ptr = <; 1.2.3.4 ; 4.5.6.8}}
7505 .endd
7506 In order to retain backwards compatibility, there is one special case: if
7507 the lookup type is PTR and no change of separator is specified, Exim looks
7508 to see if the rest of the string is precisely one IPv6 address. In this
7509 case, it does not treat it as a list.
7510
7511 The data from each lookup is concatenated, with newline separators by default,
7512 in the same way that multiple DNS records for a single item are handled. A
7513 different separator can be specified, as described above.
7514
7515
7516
7517
7518 .section "More about LDAP" "SECTldap"
7519 .cindex "LDAP" "lookup, more about"
7520 .cindex "lookup" "LDAP"
7521 .cindex "Solaris" "LDAP"
7522 The original LDAP implementation came from the University of Michigan; this has
7523 become &"Open LDAP"&, and there are now two different releases. Another
7524 implementation comes from Netscape, and Solaris 7 and subsequent releases
7525 contain inbuilt LDAP support. Unfortunately, though these are all compatible at
7526 the lookup function level, their error handling is different. For this reason
7527 it is necessary to set a compile-time variable when building Exim with LDAP, to
7528 indicate which LDAP library is in use. One of the following should appear in
7529 your &_Local/Makefile_&:
7530 .code
7531 LDAP_LIB_TYPE=UMICHIGAN
7532 LDAP_LIB_TYPE=OPENLDAP1
7533 LDAP_LIB_TYPE=OPENLDAP2
7534 LDAP_LIB_TYPE=NETSCAPE
7535 LDAP_LIB_TYPE=SOLARIS
7536 .endd
7537 If LDAP_LIB_TYPE is not set, Exim assumes &`OPENLDAP1`&, which has the
7538 same interface as the University of Michigan version.
7539
7540 There are three LDAP lookup types in Exim. These behave slightly differently in
7541 the way they handle the results of a query:
7542
7543 .ilist
7544 &(ldap)& requires the result to contain just one entry; if there are more, it
7545 gives an error.
7546 .next
7547 &(ldapdn)& also requires the result to contain just one entry, but it is the
7548 Distinguished Name that is returned rather than any attribute values.
7549 .next
7550 &(ldapm)& permits the result to contain more than one entry; the attributes
7551 from all of them are returned.
7552 .endlist
7553
7554
7555 For &(ldap)& and &(ldapm)&, if a query finds only entries with no attributes,
7556 Exim behaves as if the entry did not exist, and the lookup fails. The format of
7557 the data returned by a successful lookup is described in the next section.
7558 First we explain how LDAP queries are coded.
7559
7560
7561 .section "Format of LDAP queries" "SECTforldaque"
7562 .cindex "LDAP" "query format"
7563 An LDAP query takes the form of a URL as defined in RFC 2255. For example, in
7564 the configuration of a &(redirect)& router one might have this setting:
7565 .code
7566 data = ${lookup ldap \
7567   {ldap:///cn=$local_part,o=University%20of%20Cambridge,\
7568   c=UK?mailbox?base?}}
7569 .endd
7570 .cindex "LDAP" "with TLS"
7571 The URL may begin with &`ldap`& or &`ldaps`& if your LDAP library supports
7572 secure (encrypted) LDAP connections. The second of these ensures that an
7573 encrypted TLS connection is used.
7574
7575 With sufficiently modern LDAP libraries, Exim supports forcing TLS over regular
7576 LDAP connections, rather than the SSL-on-connect &`ldaps`&.
7577 See the &%ldap_start_tls%& option.
7578
7579 Starting with Exim 4.83, the initialization of LDAP with TLS is more tightly
7580 controlled. Every part of the TLS configuration can be configured by settings in
7581 &_exim.conf_&. Depending on the version of the client libraries installed on
7582 your system, some of the initialization may have required setting options in
7583 &_/etc/ldap.conf_& or &_~/.ldaprc_& to get TLS working with self-signed
7584 certificates. This revealed a nuance where the current UID that exim was
7585 running as could affect which config files it read. With Exim 4.83, these
7586 methods become optional, only taking effect if not specifically set in
7587 &_exim.conf_&.
7588
7589
7590 .section "LDAP quoting" "SECID68"
7591 .cindex "LDAP" "quoting"
7592 Two levels of quoting are required in LDAP queries, the first for LDAP itself
7593 and the second because the LDAP query is represented as a URL. Furthermore,
7594 within an LDAP query, two different kinds of quoting are required. For this
7595 reason, there are two different LDAP-specific quoting operators.
7596
7597 The &%quote_ldap%& operator is designed for use on strings that are part of
7598 filter specifications. Conceptually, it first does the following conversions on
7599 the string:
7600 .code
7601 *   =>   \2A
7602 (   =>   \28
7603 )   =>   \29
7604 \   =>   \5C
7605 .endd
7606 in accordance with RFC 2254. The resulting string is then quoted according
7607 to the rules for URLs, that is, all non-alphanumeric characters except
7608 .code
7609 ! $ ' - . _ ( ) * +
7610 .endd
7611 are converted to their hex values, preceded by a percent sign. For example:
7612 .code
7613 ${quote_ldap: a(bc)*, a<yz>; }
7614 .endd
7615 yields
7616 .code
7617 %20a%5C28bc%5C29%5C2A%2C%20a%3Cyz%3E%3B%20
7618 .endd
7619 Removing the URL quoting, this is (with a leading and a trailing space):
7620 .code
7621 a\28bc\29\2A, a<yz>;
7622 .endd
7623 The &%quote_ldap_dn%& operator is designed for use on strings that are part of
7624 base DN specifications in queries. Conceptually, it first converts the string
7625 by inserting a backslash in front of any of the following characters:
7626 .code
7627 , + " \ < > ;
7628 .endd
7629 It also inserts a backslash before any leading spaces or # characters, and
7630 before any trailing spaces. (These rules are in RFC 2253.) The resulting string
7631 is then quoted according to the rules for URLs. For example:
7632 .code
7633 ${quote_ldap_dn: a(bc)*, a<yz>; }
7634 .endd
7635 yields
7636 .code
7637 %5C%20a(bc)*%5C%2C%20a%5C%3Cyz%5C%3E%5C%3B%5C%20
7638 .endd
7639 Removing the URL quoting, this is (with a trailing space):
7640 .code
7641 \ a(bc)*\, a\<yz\>\;\
7642 .endd
7643 There are some further comments about quoting in the section on LDAP
7644 authentication below.
7645
7646
7647 .section "LDAP connections" "SECID69"
7648 .cindex "LDAP" "connections"
7649 The connection to an LDAP server may either be over TCP/IP, or, when OpenLDAP
7650 is in use, via a Unix domain socket. The example given above does not specify
7651 an LDAP server. A server that is reached by TCP/IP can be specified in a query
7652 by starting it with
7653 .code
7654 ldap://<hostname>:<port>/...
7655 .endd
7656 If the port (and preceding colon) are omitted, the standard LDAP port (389) is
7657 used. When no server is specified in a query, a list of default servers is
7658 taken from the &%ldap_default_servers%& configuration option. This supplies a
7659 colon-separated list of servers which are tried in turn until one successfully
7660 handles a query, or there is a serious error. Successful handling either
7661 returns the requested data, or indicates that it does not exist. Serious errors
7662 are syntactical, or multiple values when only a single value is expected.
7663 Errors which cause the next server to be tried are connection failures, bind
7664 failures, and timeouts.
7665
7666 For each server name in the list, a port number can be given. The standard way
7667 of specifying a host and port is to use a colon separator (RFC 1738). Because
7668 &%ldap_default_servers%& is a colon-separated list, such colons have to be
7669 doubled. For example
7670 .code
7671 ldap_default_servers = ldap1.example.com::145:ldap2.example.com
7672 .endd
7673 If &%ldap_default_servers%& is unset, a URL with no server name is passed
7674 to the LDAP library with no server name, and the library's default (normally
7675 the local host) is used.
7676
7677 If you are using the OpenLDAP library, you can connect to an LDAP server using
7678 a Unix domain socket instead of a TCP/IP connection. This is specified by using
7679 &`ldapi`& instead of &`ldap`& in LDAP queries. What follows here applies only
7680 to OpenLDAP. If Exim is compiled with a different LDAP library, this feature is
7681 not available.
7682
7683 For this type of connection, instead of a host name for the server, a pathname
7684 for the socket is required, and the port number is not relevant. The pathname
7685 can be specified either as an item in &%ldap_default_servers%&, or inline in
7686 the query. In the former case, you can have settings such as
7687 .code
7688 ldap_default_servers = /tmp/ldap.sock : backup.ldap.your.domain
7689 .endd
7690 When the pathname is given in the query, you have to escape the slashes as
7691 &`%2F`& to fit in with the LDAP URL syntax. For example:
7692 .code
7693 ${lookup ldap {ldapi://%2Ftmp%2Fldap.sock/o=...
7694 .endd
7695 When Exim processes an LDAP lookup and finds that the &"hostname"& is really
7696 a pathname, it uses the Unix domain socket code, even if the query actually
7697 specifies &`ldap`& or &`ldaps`&. In particular, no encryption is used for a
7698 socket connection. This behaviour means that you can use a setting of
7699 &%ldap_default_servers%& such as in the example above with traditional &`ldap`&
7700 or &`ldaps`& queries, and it will work. First, Exim tries a connection via
7701 the Unix domain socket; if that fails, it tries a TCP/IP connection to the
7702 backup host.
7703
7704 If an explicit &`ldapi`& type is given in a query when a host name is
7705 specified, an error is diagnosed. However, if there are more items in
7706 &%ldap_default_servers%&, they are tried. In other words:
7707
7708 .ilist
7709 Using a pathname with &`ldap`& or &`ldaps`& forces the use of the Unix domain
7710 interface.
7711 .next
7712 Using &`ldapi`& with a host name causes an error.
7713 .endlist
7714
7715
7716 Using &`ldapi`& with no host or path in the query, and no setting of
7717 &%ldap_default_servers%&, does whatever the library does by default.
7718
7719
7720
7721 .section "LDAP authentication and control information" "SECID70"
7722 .cindex "LDAP" "authentication"
7723 The LDAP URL syntax provides no way of passing authentication and other control
7724 information to the server. To make this possible, the URL in an LDAP query may
7725 be preceded by any number of <&'name'&>=<&'value'&> settings, separated by
7726 spaces. If a value contains spaces it must be enclosed in double quotes, and
7727 when double quotes are used, backslash is interpreted in the usual way inside
7728 them. The following names are recognized:
7729 .display
7730 &`DEREFERENCE`&  set the dereferencing parameter
7731 &`NETTIME    `&  set a timeout for a network operation
7732 &`USER       `&  set the DN, for authenticating the LDAP bind
7733 &`PASS       `&  set the password, likewise
7734 &`REFERRALS  `&  set the referrals parameter
7735 &`SERVERS    `&  set alternate server list for this query only
7736 &`SIZE       `&  set the limit for the number of entries returned
7737 &`TIME       `&  set the maximum waiting time for a query
7738 .endd
7739 The value of the DEREFERENCE parameter must be one of the words &"never"&,
7740 &"searching"&, &"finding"&, or &"always"&. The value of the REFERRALS parameter
7741 must be &"follow"& (the default) or &"nofollow"&. The latter stops the LDAP
7742 library from trying to follow referrals issued by the LDAP server.
7743
7744 .cindex LDAP timeout
7745 .cindex timeout "LDAP lookup"
7746 The name CONNECT is an obsolete name for NETTIME, retained for
7747 backwards compatibility. This timeout (specified as a number of seconds) is
7748 enforced from the client end for operations that can be carried out over a
7749 network. Specifically, it applies to network connections and calls to the
7750 &'ldap_result()'& function. If the value is greater than zero, it is used if
7751 LDAP_OPT_NETWORK_TIMEOUT is defined in the LDAP headers (OpenLDAP), or
7752 if LDAP_X_OPT_CONNECT_TIMEOUT is defined in the LDAP headers (Netscape
7753 SDK 4.1). A value of zero forces an explicit setting of &"no timeout"& for
7754 Netscape SDK; for OpenLDAP no action is taken.
7755
7756 The TIME parameter (also a number of seconds) is passed to the server to
7757 set a server-side limit on the time taken to complete a search.
7758
7759 The SERVERS parameter allows you to specify an alternate list of ldap servers
7760 to use for an individual lookup.  The global &%ldap_default_servers%& option provides a
7761 default list of ldap servers, and a single lookup can specify a single ldap
7762 server to use.  But when you need to do a lookup with a list of servers that is
7763 different than the default list (maybe different order, maybe a completely
7764 different set of servers), the SERVERS parameter allows you to specify this
7765 alternate list (colon-separated).
7766
7767 Here is an example of an LDAP query in an Exim lookup that uses some of these
7768 values. This is a single line, folded to fit on the page:
7769 .code
7770 ${lookup ldap
7771   {user="cn=manager,o=University of Cambridge,c=UK" pass=secret
7772   ldap:///o=University%20of%20Cambridge,c=UK?sn?sub?(cn=foo)}
7773   {$value}fail}
7774 .endd
7775 The encoding of spaces as &`%20`& is a URL thing which should not be done for
7776 any of the auxiliary data. Exim configuration settings that include lookups
7777 which contain password information should be preceded by &"hide"& to prevent
7778 non-admin users from using the &%-bP%& option to see their values.
7779
7780 The auxiliary data items may be given in any order. The default is no
7781 connection timeout (the system timeout is used), no user or password, no limit
7782 on the number of entries returned, and no time limit on queries.
7783
7784 When a DN is quoted in the USER= setting for LDAP authentication, Exim
7785 removes any URL quoting that it may contain before passing it LDAP. Apparently
7786 some libraries do this for themselves, but some do not. Removing the URL
7787 quoting has two advantages:
7788
7789 .ilist
7790 It makes it possible to use the same &%quote_ldap_dn%& expansion for USER=
7791 DNs as with DNs inside actual queries.
7792 .next
7793 It permits spaces inside USER= DNs.
7794 .endlist
7795
7796 For example, a setting such as
7797 .code
7798 USER=cn=${quote_ldap_dn:$1}
7799 .endd
7800 should work even if &$1$& contains spaces.
7801
7802 Expanded data for the PASS= value should be quoted using the &%quote%&
7803 expansion operator, rather than the LDAP quote operators. The only reason this
7804 field needs quoting is to ensure that it conforms to the Exim syntax, which
7805 does not allow unquoted spaces. For example:
7806 .code
7807 PASS=${quote:$3}
7808 .endd
7809 The LDAP authentication mechanism can be used to check passwords as part of
7810 SMTP authentication. See the &%ldapauth%& expansion string condition in chapter
7811 &<<CHAPexpand>>&.
7812
7813
7814
7815 .section "Format of data returned by LDAP" "SECID71"
7816 .cindex "LDAP" "returned data formats"
7817 The &(ldapdn)& lookup type returns the Distinguished Name from a single entry
7818 as a sequence of values, for example
7819 .code
7820 cn=manager,o=University of Cambridge,c=UK
7821 .endd
7822 The &(ldap)& lookup type generates an error if more than one entry matches the
7823 search filter, whereas &(ldapm)& permits this case, and inserts a newline in
7824 the result between the data from different entries. It is possible for multiple
7825 values to be returned for both &(ldap)& and &(ldapm)&, but in the former case
7826 you know that whatever values are returned all came from a single entry in the
7827 directory.
7828
7829 In the common case where you specify a single attribute in your LDAP query, the
7830 result is not quoted, and does not contain the attribute name. If the attribute
7831 has multiple values, they are separated by commas. Any comma that is
7832 part of an attribute's value is doubled.
7833
7834 If you specify multiple attributes, the result contains space-separated, quoted
7835 strings, each preceded by the attribute name and an equals sign. Within the
7836 quotes, the quote character, backslash, and newline are escaped with
7837 backslashes, and commas are used to separate multiple values for the attribute.
7838 Any commas in attribute values are doubled
7839 (permitting treatment of the values as a comma-separated list).
7840 Apart from the escaping, the string within quotes takes the same form as the
7841 output when a single attribute is requested. Specifying no attributes is the
7842 same as specifying all of an entry's attributes.
7843
7844 Here are some examples of the output format. The first line of each pair is an
7845 LDAP query, and the second is the data that is returned. The attribute called
7846 &%attr1%& has two values, one of them with an embedded comma, whereas
7847 &%attr2%& has only one value. Both attributes are derived from &%attr%&
7848 (they have SUP &%attr%& in their schema definitions).
7849
7850 .code
7851 ldap:///o=base?attr1?sub?(uid=fred)
7852 value1.1,value1,,2
7853
7854 ldap:///o=base?attr2?sub?(uid=fred)
7855 value two
7856
7857 ldap:///o=base?attr?sub?(uid=fred)
7858 value1.1,value1,,2,value two
7859
7860 ldap:///o=base?attr1,attr2?sub?(uid=fred)
7861 attr1="value1.1,value1,,2" attr2="value two"
7862
7863 ldap:///o=base??sub?(uid=fred)
7864 objectClass="top" attr1="value1.1,value1,,2" attr2="value two"
7865 .endd
7866 You can
7867 make use of Exim's &%-be%& option to run expansion tests and thereby check the
7868 results of LDAP lookups.
7869 The &%extract%& operator in string expansions can be used to pick out
7870 individual fields from data that consists of &'key'&=&'value'& pairs.
7871 The &%listextract%& operator should be used to pick out individual values
7872 of attributes, even when only a single value is expected.
7873 The doubling of embedded commas allows you to use the returned data as a
7874 comma separated list (using the "<," syntax for changing the input list separator).
7875
7876
7877
7878
7879 .section "More about NIS+" "SECTnisplus"
7880 .cindex "NIS+ lookup type"
7881 .cindex "lookup" "NIS+"
7882 NIS+ queries consist of a NIS+ &'indexed name'& followed by an optional colon
7883 and field name. If this is given, the result of a successful query is the
7884 contents of the named field; otherwise the result consists of a concatenation
7885 of &'field-name=field-value'& pairs, separated by spaces. Empty values and
7886 values containing spaces are quoted. For example, the query
7887 .code
7888 [name=mg1456],passwd.org_dir
7889 .endd
7890 might return the string
7891 .code
7892 name=mg1456 passwd="" uid=999 gid=999 gcos="Martin Guerre"
7893 home=/home/mg1456 shell=/bin/bash shadow=""
7894 .endd
7895 (split over two lines here to fit on the page), whereas
7896 .code
7897 [name=mg1456],passwd.org_dir:gcos
7898 .endd
7899 would just return
7900 .code
7901 Martin Guerre
7902 .endd
7903 with no quotes. A NIS+ lookup fails if NIS+ returns more than one table entry
7904 for the given indexed key. The effect of the &%quote_nisplus%& expansion
7905 operator is to double any quote characters within the text.
7906
7907
7908
7909 .section "SQL lookups" "SECTsql"
7910 .cindex "SQL lookup types"
7911 .cindex "MySQL" "lookup type"
7912 .cindex "PostgreSQL lookup type"
7913 .cindex "lookup" "MySQL"
7914 .cindex "lookup" "PostgreSQL"
7915 .cindex "Oracle" "lookup type"
7916 .cindex "lookup" "Oracle"
7917 .cindex "InterBase lookup type"
7918 .cindex "lookup" "InterBase"
7919 .cindex "Redis lookup type"
7920 .cindex lookup Redis
7921 Exim can support lookups in InterBase, MySQL, Oracle, PostgreSQL, Redis,
7922 and SQLite
7923 databases. Queries for these databases contain SQL statements, so an example
7924 might be
7925 .code
7926 ${lookup mysql{select mailbox from users where id='userx'}\
7927   {$value}fail}
7928 .endd
7929 If the result of the query contains more than one field, the data for each
7930 field in the row is returned, preceded by its name, so the result of
7931 .code
7932 ${lookup pgsql{select home,name from users where id='userx'}\
7933   {$value}}
7934 .endd
7935 might be
7936 .code
7937 home=/home/userx name="Mister X"
7938 .endd
7939 Empty values and values containing spaces are double quoted, with embedded
7940 quotes escaped by a backslash. If the result of the query contains just one
7941 field, the value is passed back verbatim, without a field name, for example:
7942 .code
7943 Mister X
7944 .endd
7945 If the result of the query yields more than one row, it is all concatenated,
7946 with a newline between the data for each row.
7947
7948
7949 .section "More about MySQL, PostgreSQL, Oracle, InterBase, and Redis" "SECID72"
7950 .cindex "MySQL" "lookup type"
7951 .cindex "PostgreSQL lookup type"
7952 .cindex "lookup" "MySQL"
7953 .cindex "lookup" "PostgreSQL"
7954 .cindex "Oracle" "lookup type"
7955 .cindex "lookup" "Oracle"
7956 .cindex "InterBase lookup type"
7957 .cindex "lookup" "InterBase"
7958 .cindex "Redis lookup type"
7959 .cindex lookup Redis
7960 If any MySQL, PostgreSQL, Oracle, InterBase or Redis lookups are used, the
7961 &%mysql_servers%&, &%pgsql_servers%&, &%oracle_servers%&, &%ibase_servers%&,
7962 or &%redis_servers%&
7963 option (as appropriate) must be set to a colon-separated list of server
7964 information.
7965 .oindex &%mysql_servers%&
7966 .oindex &%pgsql_servers%&
7967 .oindex &%oracle_servers%&
7968 .oindex &%ibase_servers%&
7969 .oindex &%redis_servers%&
7970 (For MySQL and PostgreSQL, the global option need not be set if all
7971 queries contain their own server information &-- see section
7972 &<<SECTspeserque>>&.)
7973 For all but Redis
7974 each item in the list is a slash-separated list of four
7975 items: host name, database name, user name, and password. In the case of
7976 Oracle, the host name field is used for the &"service name"&, and the database
7977 name field is not used and should be empty. For example:
7978 .code
7979 hide oracle_servers = oracle.plc.example//userx/abcdwxyz
7980 .endd
7981 Because password data is sensitive, you should always precede the setting with
7982 &"hide"&, to prevent non-admin users from obtaining the setting via the &%-bP%&
7983 option. Here is an example where two MySQL servers are listed:
7984 .code
7985 hide mysql_servers = localhost/users/root/secret:\
7986                      otherhost/users/root/othersecret
7987 .endd
7988 For MySQL and PostgreSQL, a host may be specified as <&'name'&>:<&'port'&> but
7989 because this is a colon-separated list, the colon has to be doubled. For each
7990 query, these parameter groups are tried in order until a connection is made and
7991 a query is successfully processed. The result of a query may be that no data is
7992 found, but that is still a successful query. In other words, the list of
7993 servers provides a backup facility, not a list of different places to look.
7994
7995 For Redis the global option need not be specified if all queries contain their
7996 own server information &-- see section &<<SECTspeserque>>&.
7997 If specified, the option must be set to a colon-separated list of server
7998 information.
7999 Each item in the list is a slash-separated list of three items:
8000 host, database number, and password.
8001 .olist
8002 The host is required and may be either an IPv4 address and optional
8003 port number (separated by a colon, which needs doubling due to the
8004 higher-level list), or a Unix socket pathname enclosed in parentheses
8005 .next
8006 The database number is optional; if present that number is selected in the backend
8007 .next
8008 The password is optional; if present it is used to authenticate to the backend
8009 .endlist
8010
8011 The &%quote_mysql%&, &%quote_pgsql%&, and &%quote_oracle%& expansion operators
8012 convert newline, tab, carriage return, and backspace to \n, \t, \r, and \b
8013 respectively, and the characters single-quote, double-quote, and backslash
8014 itself are escaped with backslashes.
8015
8016 The &%quote_redis%& expansion operator
8017 escapes whitespace and backslash characters with a backslash.
8018
8019 .section "Specifying the server in the query" "SECTspeserque"
8020 .new
8021 For MySQL, PostgreSQL and Redis lookups (but not currently for Oracle and InterBase),
8022 it is possible to specify a list of servers with an individual query. This is
8023 done by appending a comma-separated option to the query type:
8024 .display
8025 .endd
8026 &`,servers=`&&'server1:server2:server3:...'&
8027 .wen
8028 Each item in the list may take one of two forms:
8029 .olist
8030 If it contains no slashes it is assumed to be just a host name. The appropriate
8031 global option (&%mysql_servers%& or &%pgsql_servers%&) is searched for a host
8032 of the same name, and the remaining parameters (database, user, password) are
8033 taken from there.
8034 .next
8035 If it contains any slashes, it is taken as a complete parameter set.
8036 .endlist
8037 The list of servers is used in exactly the same way as the global list.
8038 Once a connection to a server has happened and a query has been
8039 successfully executed, processing of the lookup ceases.
8040
8041 This feature is intended for use in master/slave situations where updates
8042 are occurring and you want to update the master rather than a slave. If the
8043 master is in the list as a backup for reading, you might have a global setting
8044 like this:
8045 .code
8046 mysql_servers = slave1/db/name/pw:\
8047                 slave2/db/name/pw:\
8048                 master/db/name/pw
8049 .endd
8050 In an updating lookup, you could then write:
8051 .code
8052 ${lookup mysql,servers=master {UPDATE ...} }
8053 .endd
8054 That query would then be sent only to the master server. If, on the other hand,
8055 the master is not to be used for reading, and so is not present in the global
8056 option, you can still update it by a query of this form:
8057 .code
8058 ${lookup pgsql,servers=master/db/name/pw {UPDATE ...} }
8059 .endd
8060
8061 .new
8062 An older syntax places the servers speciification before the qury,
8063 semicolon separated:
8064 .code
8065 ${lookup mysql{servers=master; UPDATE ...} }
8066 .endd
8067 The new version avoids potential issues with tainted
8068 arguments in the query, for explicit expansion.
8069 &*Note*&: server specifications in list-style lookups are still problematic.
8070 .wen
8071
8072
8073 .section "Special MySQL features" "SECID73"
8074 For MySQL, an empty host name or the use of &"localhost"& in &%mysql_servers%&
8075 causes a connection to the server on the local host by means of a Unix domain
8076 socket. An alternate socket can be specified in parentheses.
8077 An option group name for MySQL option files can be specified in square brackets;
8078 the default value is &"exim"&.
8079 The full syntax of each item in &%mysql_servers%& is:
8080 .display
8081 <&'hostname'&>::<&'port'&>(<&'socket name'&>)[<&'option group'&>]/&&&
8082   <&'database'&>/<&'user'&>/<&'password'&>
8083 .endd
8084 Any of the four sub-parts of the first field can be omitted. For normal use on
8085 the local host it can be left blank or set to just &"localhost"&.
8086
8087 No database need be supplied &-- but if it is absent here, it must be given in
8088 the queries.
8089
8090 If a MySQL query is issued that does not request any data (an insert, update,
8091 or delete command), the result of the lookup is the number of rows affected.
8092
8093 &*Warning*&: This can be misleading. If an update does not actually change
8094 anything (for example, setting a field to the value it already has), the result
8095 is zero because no rows are affected.
8096
8097
8098 .section "Special PostgreSQL features" "SECID74"
8099 PostgreSQL lookups can also use Unix domain socket connections to the database.
8100 This is usually faster and costs less CPU time than a TCP/IP connection.
8101 However it can be used only if the mail server runs on the same machine as the
8102 database server. A configuration line for PostgreSQL via Unix domain sockets
8103 looks like this:
8104 .code
8105 hide pgsql_servers = (/tmp/.s.PGSQL.5432)/db/user/password : ...
8106 .endd
8107 In other words, instead of supplying a host name, a path to the socket is
8108 given. The path name is enclosed in parentheses so that its slashes aren't
8109 visually confused with the delimiters for the other server parameters.
8110
8111 If a PostgreSQL query is issued that does not request any data (an insert,
8112 update, or delete command), the result of the lookup is the number of rows
8113 affected.
8114
8115 .section "More about SQLite" "SECTsqlite"
8116 .cindex "lookup" "SQLite"
8117 .cindex "sqlite lookup type"
8118 SQLite is different to the other SQL lookups because a filename is required in
8119 addition to the SQL query. An SQLite database is a single file, and there is no
8120 daemon as in the other SQL databases.
8121
8122 .new
8123 .oindex &%sqlite_dbfile%&
8124 The preferred way of specifying the file is by using the
8125 &%sqlite_dbfile%& option, set to
8126 an absolute path.
8127 .wen
8128 A deprecated method is available, prefixing the query with the filename
8129 separated by white space.
8130 This means that the path name cannot contain white space.
8131 .cindex "tainted data" "sqlite file"
8132 It also means that the query cannot use any tainted values, as that taints
8133 the entire query including the filename - resulting in a refusal to open
8134 the file.
8135
8136 .new
8137 Here is a lookup expansion example:
8138 .code
8139 sqlite_dbfile = /some/thing/sqlitedb
8140 ...
8141 ${lookup sqlite {select name from aliases where id='userx';}}
8142 .endd
8143 In a list, the syntax is similar. For example:
8144 .code
8145 domainlist relay_to_domains = sqlite;\
8146    select * from relays where ip='$sender_host_address';
8147 .endd
8148 .wen
8149 The only character affected by the &%quote_sqlite%& operator is a single
8150 quote, which it doubles.
8151
8152 .cindex timeout SQLite
8153 .cindex sqlite "lookup timeout"
8154 The SQLite library handles multiple simultaneous accesses to the database
8155 internally. Multiple readers are permitted, but only one process can
8156 update at once. Attempts to access the database while it is being updated
8157 are rejected after a timeout period, during which the SQLite library
8158 waits for the lock to be released. In Exim, the default timeout is set
8159 to 5 seconds, but it can be changed by means of the &%sqlite_lock_timeout%&
8160 option.
8161
8162 .section "More about Redis" "SECTredis"
8163 .cindex "lookup" "Redis"
8164 .cindex "redis lookup type"
8165 Redis is a non-SQL database. Commands are simple get and set.
8166 Examples:
8167 .code
8168 ${lookup redis{set keyname ${quote_redis:objvalue plus}}}
8169 ${lookup redis{get keyname}}
8170 .endd
8171
8172 As of release 4.91, "lightweight" support for Redis Cluster is available.
8173 Requires &%redis_servers%& list to contain all the servers in the cluster, all
8174 of which must be reachable from the running exim instance. If the cluster has
8175 master/slave replication, the list must contain all the master and slave
8176 servers.
8177
8178 When the Redis Cluster returns a "MOVED" response to a query, Exim does not
8179 immediately follow the redirection but treats the response as a DEFER, moving on
8180 to the next server in the &%redis_servers%& list until the correct server is
8181 reached.
8182
8183 .ecindex IIDfidalo1
8184 .ecindex IIDfidalo2
8185
8186
8187 . ////////////////////////////////////////////////////////////////////////////
8188 . ////////////////////////////////////////////////////////////////////////////
8189
8190 .chapter "Domain, host, address, and local part lists" &&&
8191          "CHAPdomhosaddlists" &&&
8192          "Domain, host, and address lists"
8193 .scindex IIDdohoadli "lists of domains; hosts; etc."
8194 A number of Exim configuration options contain lists of domains, hosts,
8195 email addresses, or local parts. For example, the &%hold_domains%& option
8196 contains a list of domains whose delivery is currently suspended. These lists
8197 are also used as data in ACL statements (see chapter &<<CHAPACL>>&), and as
8198 arguments to expansion conditions such as &%match_domain%&.
8199
8200 Each item in one of these lists is a pattern to be matched against a domain,
8201 host, email address, or local part, respectively. In the sections below, the
8202 different types of pattern for each case are described, but first we cover some
8203 general facilities that apply to all four kinds of list.
8204
8205 Note that other parts of Exim use a &'string list'& which does not
8206 support all the complexity available in
8207 domain, host, address and local part lists.
8208
8209
8210
8211 .section "Expansion of lists" "SECTlistexpand"
8212 .cindex "expansion" "of lists"
8213 Each list is expanded as a single string before it is used.
8214
8215 &'Exception: the router headers_remove option, where list-item
8216 splitting is done before string-expansion.'&
8217
8218 The result of
8219 expansion must be a list, possibly containing empty items, which is split up
8220 into separate items for matching. By default, colon is the separator character,
8221 but this can be varied if necessary. See sections &<<SECTlistconstruct>>& and
8222 &<<SECTempitelis>>& for details of the list syntax; the second of these
8223 discusses the way to specify empty list items.
8224
8225
8226 If the string expansion is forced to fail, Exim behaves as if the item it is
8227 testing (domain, host, address, or local part) is not in the list. Other
8228 expansion failures cause temporary errors.
8229
8230 If an item in a list is a regular expression, backslashes, dollars and possibly
8231 other special characters in the expression must be protected against
8232 misinterpretation by the string expander. The easiest way to do this is to use
8233 the &`\N`& expansion feature to indicate that the contents of the regular
8234 expression should not be expanded. For example, in an ACL you might have:
8235 .code
8236 deny senders = \N^\d{8}\w@.*\.baddomain\.example$\N : \
8237                ${lookup{$domain}lsearch{/badsenders/bydomain}}
8238 .endd
8239 The first item is a regular expression that is protected from expansion by
8240 &`\N`&, whereas the second uses the expansion to obtain a list of unwanted
8241 senders based on the receiving domain.
8242
8243
8244
8245
8246 .section "Negated items in lists" "SECID76"
8247 .cindex "list" "negation"
8248 .cindex "negation" "in lists"
8249 Items in a list may be positive or negative. Negative items are indicated by a
8250 leading exclamation mark, which may be followed by optional white space. A list
8251 defines a set of items (domains, etc). When Exim processes one of these lists,
8252 it is trying to find out whether a domain, host, address, or local part
8253 (respectively) is in the set that is defined by the list. It works like this:
8254
8255 The list is scanned from left to right. If a positive item is matched, the
8256 subject that is being checked is in the set; if a negative item is matched, the
8257 subject is not in the set. If the end of the list is reached without the
8258 subject having matched any of the patterns, it is in the set if the last item
8259 was a negative one, but not if it was a positive one. For example, the list in
8260 .code
8261 domainlist relay_to_domains = !a.b.c : *.b.c
8262 .endd
8263 matches any domain ending in &'.b.c'& except for &'a.b.c'&. Domains that match
8264 neither &'a.b.c'& nor &'*.b.c'& do not match, because the last item in the
8265 list is positive. However, if the setting were
8266 .code
8267 domainlist relay_to_domains = !a.b.c
8268 .endd
8269 then all domains other than &'a.b.c'& would match because the last item in the
8270 list is negative. In other words, a list that ends with a negative item behaves
8271 as if it had an extra item &`:*`& on the end.
8272
8273 Another way of thinking about positive and negative items in lists is to read
8274 the connector as &"or"& after a positive item and as &"and"& after a negative
8275 item.
8276
8277
8278
8279 .section "File names in lists" "SECTfilnamlis"
8280 .cindex "list" "filename in"
8281 If an item in a domain, host, address, or local part list is an absolute
8282 filename (beginning with a slash character), each line of the file is read and
8283 processed as if it were an independent item in the list, except that further
8284 filenames are not allowed,
8285 and no expansion of the data from the file takes place.
8286 Empty lines in the file are ignored, and the file may also contain comment
8287 lines:
8288
8289 .ilist
8290 For domain and host lists, if a # character appears anywhere in a line of the
8291 file, it and all following characters are ignored.
8292 .next
8293 Because local parts may legitimately contain # characters, a comment in an
8294 address list or local part list file is recognized only if # is preceded by
8295 white space or the start of the line. For example:
8296 .code
8297 not#comment@x.y.z   # but this is a comment
8298 .endd
8299 .endlist
8300
8301 Putting a filename in a list has the same effect as inserting each line of the
8302 file as an item in the list (blank lines and comments excepted). However, there
8303 is one important difference: the file is read each time the list is processed,
8304 so if its contents vary over time, Exim's behaviour changes.
8305
8306 If a filename is preceded by an exclamation mark, the sense of any match
8307 within the file is inverted. For example, if
8308 .code
8309 hold_domains = !/etc/nohold-domains
8310 .endd
8311 and the file contains the lines
8312 .code
8313 !a.b.c
8314 *.b.c
8315 .endd
8316 then &'a.b.c'& is in the set of domains defined by &%hold_domains%&, whereas
8317 any domain matching &`*.b.c`& is not.
8318
8319
8320
8321 .section "An lsearch file is not an out-of-line list" "SECID77"
8322 As will be described in the sections that follow, lookups can be used in lists
8323 to provide indexed methods of checking list membership. There has been some
8324 confusion about the way &(lsearch)& lookups work in lists. Because
8325 an &(lsearch)& file contains plain text and is scanned sequentially, it is
8326 sometimes thought that it is allowed to contain wild cards and other kinds of
8327 non-constant pattern. This is not the case. The keys in an &(lsearch)& file are
8328 always fixed strings, just as for any other single-key lookup type.
8329
8330 If you want to use a file to contain wild-card patterns that form part of a
8331 list, just give the filename on its own, without a search type, as described
8332 in the previous section. You could also use the &(wildlsearch)& or
8333 &(nwildlsearch)&, but there is no advantage in doing this.
8334
8335
8336
8337
8338 .new
8339 .section "Results of list checking" SECTlistresults
8340 The primary result of doing a list check is a truth value.
8341 In some contexts additional information is stored
8342 about the list element that matched:
8343 .vlist
8344 .vitem hosts
8345 A &%hosts%& ACL condition
8346 will store a result in the &$host_data$& variable.
8347 .vitem local_parts
8348 A &%local_parts%& router option or &%local_parts%& ACL condition
8349 will store a result in the &$local_part_data$& variable.
8350 .vitem domains
8351 A &%domains%& router option or &%domains%& ACL condition
8352 .vitem senders
8353 A &%senders%& router option or &%senders%& ACL condition
8354 will store a result in the &$sender_data$& variable.
8355 .vitem recipients
8356 A &%recipients%& ACL condition
8357 will store a result in the &$recipient_data$& variable.
8358 .endlist
8359
8360 The detail of the additional information depends on the
8361 type of match and is given below as the &*value*& information.
8362 .wen
8363
8364
8365
8366
8367 .section "Named lists" "SECTnamedlists"
8368 .cindex "named lists"
8369 .cindex "list" "named"
8370 A list of domains, hosts, email addresses, or local parts can be given a name
8371 which is then used to refer to the list elsewhere in the configuration. This is
8372 particularly convenient if the same list is required in several different
8373 places. It also allows lists to be given meaningful names, which can improve
8374 the readability of the configuration. For example, it is conventional to define
8375 a domain list called &'local_domains'& for all the domains that are handled
8376 locally on a host, using a configuration line such as
8377 .code
8378 domainlist local_domains = localhost:my.dom.example
8379 .endd
8380 Named lists are referenced by giving their name preceded by a plus sign, so,
8381 for example, a router that is intended to handle local domains would be
8382 configured with the line
8383 .code
8384 domains = +local_domains
8385 .endd
8386 The first router in a configuration is often one that handles all domains
8387 except the local ones, using a configuration with a negated item like this:
8388 .code
8389 dnslookup:
8390   driver = dnslookup
8391   domains = ! +local_domains
8392   transport = remote_smtp
8393   no_more
8394 .endd
8395 The four kinds of named list are created by configuration lines starting with
8396 the words &%domainlist%&, &%hostlist%&, &%addresslist%&, or &%localpartlist%&,
8397 respectively. Then there follows the name that you are defining, followed by an
8398 equals sign and the list itself. For example:
8399 .code
8400 hostlist    relay_from_hosts = 192.168.23.0/24 : my.friend.example
8401 addresslist bad_senders = cdb;/etc/badsenders
8402 .endd
8403 A named list may refer to other named lists:
8404 .code
8405 domainlist  dom1 = first.example : second.example
8406 domainlist  dom2 = +dom1 : third.example
8407 domainlist  dom3 = fourth.example : +dom2 : fifth.example
8408 .endd
8409 &*Warning*&: If the last item in a referenced list is a negative one, the
8410 effect may not be what you intended, because the negation does not propagate
8411 out to the higher level. For example, consider:
8412 .code
8413 domainlist  dom1 = !a.b
8414 domainlist  dom2 = +dom1 : *.b
8415 .endd
8416 The second list specifies &"either in the &%dom1%& list or &'*.b'&"&. The first
8417 list specifies just &"not &'a.b'&"&, so the domain &'x.y'& matches it. That
8418 means it matches the second list as well. The effect is not the same as
8419 .code
8420 domainlist  dom2 = !a.b : *.b
8421 .endd
8422 where &'x.y'& does not match. It's best to avoid negation altogether in
8423 referenced lists if you can.
8424
8425 .new
8426 .cindex "hiding named list values"
8427 .cindex "named lists" "hiding value of"
8428 Some named list definitions may contain sensitive data, for example, passwords for
8429 accessing databases. To stop non-admin users from using the &%-bP%& command
8430 line option to read these values, you can precede the definition with the
8431 word &"hide"&. For example:
8432 .code
8433 hide domainlist filter_for_domains = ldap;PASS=secret ldap::/// ...
8434 .endd
8435 .wen
8436
8437
8438 Named lists may have a performance advantage. When Exim is routing an
8439 address or checking an incoming message, it caches the result of tests on named
8440 lists. So, if you have a setting such as
8441 .code
8442 domains = +local_domains
8443 .endd
8444 on several of your routers
8445 or in several ACL statements,
8446 the actual test is done only for the first one. However, the caching works only
8447 if there are no expansions within the list itself or any sublists that it
8448 references. In other words, caching happens only for lists that are known to be
8449 the same each time they are referenced.
8450
8451 By default, there may be up to 16 named lists of each type. This limit can be
8452 extended by changing a compile-time variable. The use of domain and host lists
8453 is recommended for concepts such as local domains, relay domains, and relay
8454 hosts. The default configuration is set up like this.
8455
8456
8457
8458 .section "Named lists compared with macros" "SECID78"
8459 .cindex "list" "named compared with macro"
8460 .cindex "macro" "compared with named list"
8461 At first sight, named lists might seem to be no different from macros in the
8462 configuration file. However, macros are just textual substitutions. If you
8463 write
8464 .code
8465 ALIST = host1 : host2
8466 auth_advertise_hosts = !ALIST
8467 .endd
8468 it probably won't do what you want, because that is exactly the same as
8469 .code
8470 auth_advertise_hosts = !host1 : host2
8471 .endd
8472 Notice that the second host name is not negated. However, if you use a host
8473 list, and write
8474 .code
8475 hostlist alist = host1 : host2
8476 auth_advertise_hosts = ! +alist
8477 .endd
8478 the negation applies to the whole list, and so that is equivalent to
8479 .code
8480 auth_advertise_hosts = !host1 : !host2
8481 .endd
8482
8483
8484 .section "Named list caching" "SECID79"
8485 .cindex "list" "caching of named"
8486 .cindex "caching" "named lists"
8487 While processing a message, Exim caches the result of checking a named list if
8488 it is sure that the list is the same each time. In practice, this means that
8489 the cache operates only if the list contains no $ characters, which guarantees
8490 that it will not change when it is expanded. Sometimes, however, you may have
8491 an expanded list that you know will be the same each time within a given
8492 message. For example:
8493 .code
8494 domainlist special_domains = \
8495            ${lookup{$sender_host_address}cdb{/some/file}}
8496 .endd
8497 This provides a list of domains that depends only on the sending host's IP
8498 address. If this domain list is referenced a number of times (for example,
8499 in several ACL lines, or in several routers) the result of the check is not
8500 cached by default, because Exim does not know that it is going to be the
8501 same list each time.
8502
8503 By appending &`_cache`& to &`domainlist`& you can tell Exim to go ahead and
8504 cache the result anyway. For example:
8505 .code
8506 domainlist_cache special_domains = ${lookup{...
8507 .endd
8508 If you do this, you should be absolutely sure that caching is going to do
8509 the right thing in all cases. When in doubt, leave it out.
8510
8511
8512
8513 .section "Domain lists" "SECTdomainlist"
8514 .cindex "domain list" "patterns for"
8515 .cindex "list" "domain list"
8516 Domain lists contain patterns that are to be matched against a mail domain.
8517 The following types of item may appear in domain lists:
8518
8519 .ilist
8520 .cindex "primary host name"
8521 .cindex "host name" "matched in domain list"
8522 .oindex "&%primary_hostname%&"
8523 .cindex "domain list" "matching primary host name"
8524 .cindex "@ in a domain list"
8525 If a pattern consists of a single @ character, it matches the local host name,
8526 as set by the &%primary_hostname%& option (or defaulted). This makes it
8527 possible to use the same configuration file on several different hosts that
8528 differ only in their names.
8529
8530 .new
8531 The value for a match will be the primary host name.
8532 .wen
8533
8534
8535 .next
8536 .cindex "@[] in a domain list"
8537 .cindex "domain list" "matching local IP interfaces"
8538 .cindex "domain literal"
8539 If a pattern consists of the string &`@[]`& it matches an IP address enclosed
8540 in square brackets (as in an email address that contains a domain literal), but
8541 only if that IP address is recognized as local for email routing purposes. The
8542 &%local_interfaces%& and &%extra_local_interfaces%& options can be used to
8543 control which of a host's several IP addresses are treated as local.
8544 In today's Internet, the use of domain literals is controversial;
8545 see the &%allow_domain_literals%& main option.
8546
8547 .new
8548 The value for a match will be the &`@[]`& string.
8549 .wen
8550
8551
8552 .next
8553 .cindex "@mx_any"
8554 .cindex "@mx_primary"
8555 .cindex "@mx_secondary"
8556 .cindex "domain list" "matching MX pointers to local host"
8557 If a pattern consists of the string &`@mx_any`& it matches any domain that
8558 has an MX record pointing to the local host or to any host that is listed in
8559 .oindex "&%hosts_treat_as_local%&"
8560 &%hosts_treat_as_local%&. The items &`@mx_primary`& and &`@mx_secondary`&
8561 are similar, except that the first matches only when a primary MX target is the
8562 local host, and the second only when no primary MX target is the local host,
8563 but a secondary MX target is. &"Primary"& means an MX record with the lowest
8564 preference value &-- there may of course be more than one of them.
8565
8566 The MX lookup that takes place when matching a pattern of this type is
8567 performed with the resolver options for widening names turned off. Thus, for
8568 example, a single-component domain will &'not'& be expanded by adding the
8569 resolver's default domain. See the &%qualify_single%& and &%search_parents%&
8570 options of the &(dnslookup)& router for a discussion of domain widening.
8571
8572 Sometimes you may want to ignore certain IP addresses when using one of these
8573 patterns. You can specify this by following the pattern with &`/ignore=`&<&'ip
8574 list'&>, where <&'ip list'&> is a list of IP addresses. These addresses are
8575 ignored when processing the pattern (compare the &%ignore_target_hosts%& option
8576 on a router). For example:
8577 .code
8578 domains = @mx_any/ignore=127.0.0.1
8579 .endd
8580 This example matches any domain that has an MX record pointing to one of
8581 the local host's IP addresses other than 127.0.0.1.
8582
8583 The list of IP addresses is in fact processed by the same code that processes
8584 host lists, so it may contain CIDR-coded network specifications and it may also
8585 contain negative items.
8586
8587 Because the list of IP addresses is a sublist within a domain list, you have to
8588 be careful about delimiters if there is more than one address. Like any other
8589 list, the default delimiter can be changed. Thus, you might have:
8590 .code
8591 domains = @mx_any/ignore=<;127.0.0.1;0.0.0.0 : \
8592           an.other.domain : ...
8593 .endd
8594 so that the sublist uses semicolons for delimiters. When IPv6 addresses are
8595 involved, it is easiest to change the delimiter for the main list as well:
8596 .code
8597 domains = <? @mx_any/ignore=<;127.0.0.1;::1 ? \
8598           an.other.domain ? ...
8599 .endd
8600 .new
8601 The value for a match will be the list element string (starting &`@mx_`&).
8602 .wen
8603
8604
8605 .next
8606 .cindex "asterisk" "in domain list"
8607 .cindex "domain list" "asterisk in"
8608 .cindex "domain list" "matching &""ends with""&"
8609 If a pattern starts with an asterisk, the remaining characters of the pattern
8610 are compared with the terminating characters of the domain. The use of &"*"& in
8611 domain lists differs from its use in partial matching lookups. In a domain
8612 list, the character following the asterisk need not be a dot, whereas partial
8613 matching works only in terms of dot-separated components. For example, a domain
8614 list item such as &`*key.ex`& matches &'donkey.ex'& as well as
8615 &'cipher.key.ex'&.
8616
8617 .new
8618 The value for a match will be the list element string (starting with the asterisk).
8619 .wen
8620
8621 .next
8622 .cindex "regular expressions" "in domain list"
8623 .cindex "domain list" "matching regular expression"
8624 If a pattern starts with a circumflex character, it is treated as a regular
8625 expression, and matched against the domain using a regular expression matching
8626 function. The circumflex is treated as part of the regular expression.
8627 Email domains are case-independent, so this regular expression match is by
8628 default case-independent, but you can make it case-dependent by starting it
8629 with &`(?-i)`&. References to descriptions of the syntax of regular expressions
8630 are given in chapter &<<CHAPregexp>>&.
8631
8632 &*Warning*&: Because domain lists are expanded before being processed, you
8633 must escape any backslash and dollar characters in the regular expression, or
8634 use the special &`\N`& sequence (see chapter &<<CHAPexpand>>&) to specify that
8635 it is not to be expanded (unless you really do want to build a regular
8636 expression by expansion, of course).
8637
8638 .new
8639 The value for a match will be the list element string (starting with the circumflex).
8640 .wen
8641
8642
8643
8644 .next
8645 .cindex "lookup" "in domain list"
8646 .cindex "domain list" "matching by lookup"
8647 If a pattern starts with the name of a single-key lookup type followed by a
8648 semicolon (for example, &"dbm;"& or &"lsearch;"&), the remainder of the pattern
8649 must be a filename in a suitable format for the lookup type. For example, for
8650 &"cdb;"& it must be an absolute path:
8651 .code
8652 domains = cdb;/etc/mail/local_domains.cdb
8653 .endd
8654 The appropriate type of lookup is done on the file using the domain name as the
8655 key. In most cases, the value resulting from the lookup is not used; Exim is interested
8656 only in whether or not the key is present in the file. However, when a lookup
8657 is used for the &%domains%& option on a router
8658 or a &%domains%& condition in an ACL statement, the value is preserved in the
8659 &$domain_data$& variable and can be referred to in other router options or
8660 other statements in the same ACL.
8661 .cindex "tainted data" "de-tainting"
8662 The value will be untainted.
8663
8664
8665 .next
8666 Any of the single-key lookup type names may be preceded by
8667 &`partial`&<&'n'&>&`-`&, where the <&'n'&> is optional, for example,
8668 .code
8669 domains = partial-dbm;/partial/domains
8670 .endd
8671 This causes partial matching logic to be invoked; a description of how this
8672 works is given in section &<<SECTpartiallookup>>&.
8673
8674 .next
8675 .cindex "asterisk" "in lookup type"
8676 Any of the single-key lookup types may be followed by an asterisk. This causes
8677 a default lookup for a key consisting of a single asterisk to be done if the
8678 original lookup fails. This is not a useful feature when using a domain list to
8679 select particular domains (because any domain would match), but it might have
8680 value if the result of the lookup is being used via the &$domain_data$&
8681 expansion variable.
8682
8683 .next
8684 If the pattern starts with the name of a query-style lookup type followed by a
8685 semicolon (for example, &"nisplus;"& or &"ldap;"&), the remainder of the
8686 pattern must be an appropriate query for the lookup type, as described in
8687 chapter &<<CHAPfdlookup>>&. For example:
8688 .code
8689 hold_domains = mysql;select domain from holdlist \
8690   where domain = '${quote_mysql:$domain}';
8691 .endd
8692 In most cases, the value resulting from the lookup is not used (so for an SQL query, for
8693 example, it doesn't matter what field you select). Exim is interested only in
8694 whether or not the query succeeds. However, when a lookup is used for the
8695 &%domains%& option on a router, the value is preserved in the &$domain_data$&
8696 variable and can be referred to in other options.
8697 .cindex "tainted data" "de-tainting"
8698 The value will be untainted.
8699
8700 .next
8701 .new
8702 If the pattern starts with the name of a lookup type
8703 of either kind (single-key or query-style) it may be
8704 followed by a comma and options,
8705 The options are lookup-type specific and consist of a comma-separated list.
8706 Each item starts with a tag and and equals "=".
8707 .wen
8708
8709 .next
8710 .cindex "domain list" "matching literal domain name"
8711 If none of the above cases apply, a caseless textual comparison is made
8712 between the pattern and the domain.
8713
8714 The value for a match will be the list element string.
8715 .cindex "tainted data" "de-tainting"
8716 Note that this is commonly untainted
8717 (depending on the way the list was created).
8718 This is a useful way of obtaining an untainted equivalent to
8719 the domain, for later operations.
8720 .endlist
8721
8722
8723 Here is an example that uses several different kinds of pattern:
8724 .code
8725 domainlist funny_domains = \
8726   @ : \
8727   lib.unseen.edu : \
8728   *.foundation.fict.example : \
8729   \N^[1-2]\d{3}\.fict\.example$\N : \
8730   partial-dbm;/opt/data/penguin/book : \
8731   nis;domains.byname : \
8732   nisplus;[name=$domain,status=local],domains.org_dir
8733 .endd
8734 There are obvious processing trade-offs among the various matching modes. Using
8735 an asterisk is faster than a regular expression, and listing a few names
8736 explicitly probably is too. The use of a file or database lookup is expensive,
8737 but may be the only option if hundreds of names are required. Because the
8738 patterns are tested in order, it makes sense to put the most commonly matched
8739 patterns earlier.
8740
8741
8742
8743 .section "Host lists" "SECThostlist"
8744 .cindex "host list" "patterns in"
8745 .cindex "list" "host list"
8746 Host lists are used to control what remote hosts are allowed to do. For
8747 example, some hosts may be allowed to use the local host as a relay, and some
8748 may be permitted to use the SMTP ETRN command. Hosts can be identified in
8749 two different ways, by name or by IP address. In a host list, some types of
8750 pattern are matched to a host name, and some are matched to an IP address.
8751 You need to be particularly careful with this when single-key lookups are
8752 involved, to ensure that the right value is being used as the key.
8753
8754
8755 .section "Special host list patterns" "SECID80"
8756 .cindex "empty item in hosts list"
8757 .cindex "host list" "empty string in"
8758 If a host list item is the empty string, it matches only when no remote host is
8759 involved. This is the case when a message is being received from a local
8760 process using SMTP on the standard input, that is, when a TCP/IP connection is
8761 not used.
8762
8763 .cindex "asterisk" "in host list"
8764 The special pattern &"*"& in a host list matches any host or no host. Neither
8765 the IP address nor the name is actually inspected.
8766
8767
8768
8769 .section "Host list patterns that match by IP address" "SECThoslispatip"
8770 .cindex "host list" "matching IP addresses"
8771 If an IPv4 host calls an IPv6 host and the call is accepted on an IPv6 socket,
8772 the incoming address actually appears in the IPv6 host as
8773 &`::ffff:`&<&'v4address'&>. When such an address is tested against a host
8774 list, it is converted into a traditional IPv4 address first. (Not all operating
8775 systems accept IPv4 calls on IPv6 sockets, as there have been some security
8776 concerns.)
8777
8778 The following types of pattern in a host list check the remote host by
8779 inspecting its IP address:
8780
8781 .ilist
8782 If the pattern is a plain domain name (not a regular expression, not starting
8783 with *, not a lookup of any kind), Exim calls the operating system function
8784 to find the associated IP address(es). Exim uses the newer
8785 &[getipnodebyname()]& function when available, otherwise &[gethostbyname()]&.
8786 This typically causes a forward DNS lookup of the name. The result is compared
8787 with the IP address of the subject host.
8788
8789 If there is a temporary problem (such as a DNS timeout) with the host name
8790 lookup, a temporary error occurs. For example, if the list is being used in an
8791 ACL condition, the ACL gives a &"defer"& response, usually leading to a
8792 temporary SMTP error code. If no IP address can be found for the host name,
8793 what happens is described in section &<<SECTbehipnot>>& below.
8794
8795 .next
8796 .cindex "@ in a host list"
8797 If the pattern is &"@"&, the primary host name is substituted and used as a
8798 domain name, as just described.
8799
8800 .next
8801 If the pattern is an IP address, it is matched against the IP address of the
8802 subject host. IPv4 addresses are given in the normal &"dotted-quad"& notation.
8803 IPv6 addresses can be given in colon-separated format, but the colons have to
8804 be doubled so as not to be taken as item separators when the default list
8805 separator is used. IPv6 addresses are recognized even when Exim is compiled
8806 without IPv6 support. This means that if they appear in a host list on an
8807 IPv4-only host, Exim will not treat them as host names. They are just addresses
8808 that can never match a client host.
8809
8810 .next
8811 .cindex "@[] in a host list"
8812 If the pattern is &"@[]"&, it matches the IP address of any IP interface on
8813 the local host. For example, if the local host is an IPv4 host with one
8814 interface address 10.45.23.56, these two ACL statements have the same effect:
8815 .code
8816 accept hosts = 127.0.0.1 : 10.45.23.56
8817 accept hosts = @[]
8818 .endd
8819 .next
8820 .cindex "CIDR notation"
8821 If the pattern is an IP address followed by a slash and a mask length (for
8822 example 10.11.42.0/24), it is matched against the IP address of the subject
8823 host under the given mask. This allows, an entire network of hosts to be
8824 included (or excluded) by a single item. The mask uses CIDR notation; it
8825 specifies the number of address bits that must match, starting from the most
8826 significant end of the address.
8827
8828 &*Note*&: The mask is &'not'& a count of addresses, nor is it the high number
8829 of a range of addresses. It is the number of bits in the network portion of the
8830 address. The above example specifies a 24-bit netmask, so it matches all 256
8831 addresses in the 10.11.42.0 network. An item such as
8832 .code
8833 192.168.23.236/31
8834 .endd
8835 matches just two addresses, 192.168.23.236 and 192.168.23.237. A mask value of
8836 32 for an IPv4 address is the same as no mask at all; just a single address
8837 matches.
8838
8839 Here is another example which shows an IPv4 and an IPv6 network:
8840 .code
8841 recipient_unqualified_hosts = 192.168.0.0/16: \
8842                               3ffe::ffff::836f::::/48
8843 .endd
8844 The doubling of list separator characters applies only when these items
8845 appear inline in a host list. It is not required when indirecting via a file.
8846 For example:
8847 .code
8848 recipient_unqualified_hosts = /opt/exim/unqualnets
8849 .endd
8850 could make use of a file containing
8851 .code
8852 172.16.0.0/12
8853 3ffe:ffff:836f::/48
8854 .endd
8855 to have exactly the same effect as the previous example. When listing IPv6
8856 addresses inline, it is usually more convenient to use the facility for
8857 changing separator characters. This list contains the same two networks:
8858 .code
8859 recipient_unqualified_hosts = <; 172.16.0.0/12; \
8860                                  3ffe:ffff:836f::/48
8861 .endd
8862 The separator is changed to semicolon by the leading &"<;"& at the start of the
8863 list.
8864 .endlist
8865
8866
8867
8868 .section "Host list patterns for single-key lookups by host address" &&&
8869          "SECThoslispatsikey"
8870 .cindex "host list" "lookup of IP address"
8871 When a host is to be identified by a single-key lookup of its complete IP
8872 address, the pattern takes this form:
8873 .display
8874 &`net-<`&&'single-key-search-type'&&`>;<`&&'search-data'&&`>`&
8875 .endd
8876 For example:
8877 .code
8878 hosts_lookup = net-cdb;/hosts-by-ip.db
8879 .endd
8880 The text form of the IP address of the subject host is used as the lookup key.
8881 IPv6 addresses are converted to an unabbreviated form, using lower case
8882 letters, with dots as separators because colon is the key terminator in
8883 &(lsearch)& files. [Colons can in fact be used in keys in &(lsearch)& files by
8884 quoting the keys, but this is a facility that was added later.] The data
8885 returned by the lookup is not used.
8886
8887 .cindex "IP address" "masking"
8888 .cindex "host list" "masked IP address"
8889 Single-key lookups can also be performed using masked IP addresses, using
8890 patterns of this form:
8891 .display
8892 &`net<`&&'number'&&`>-<`&&'single-key-search-type'&&`>;<`&&'search-data'&&`>`&
8893 .endd
8894 For example:
8895 .code
8896 net24-dbm;/networks.db
8897 .endd
8898 The IP address of the subject host is masked using <&'number'&> as the mask
8899 length. A textual string is constructed from the masked value, followed by the
8900 mask, and this is used as the lookup key. For example, if the host's IP address
8901 is 192.168.34.6, the key that is looked up for the above example is
8902 &"192.168.34.0/24"&.
8903
8904 When an IPv6 address is converted to a string, dots are normally used instead
8905 of colons, so that keys in &(lsearch)& files need not contain colons (which
8906 terminate &(lsearch)& keys). This was implemented some time before the ability
8907 to quote keys was made available in &(lsearch)& files. However, the more
8908 recently implemented &(iplsearch)& files do require colons in IPv6 keys
8909 (notated using the quoting facility) so as to distinguish them from IPv4 keys.
8910 For this reason, when the lookup type is &(iplsearch)&, IPv6 addresses are
8911 converted using colons and not dots.
8912 In all cases except IPv4-mapped IPv6, full, unabbreviated IPv6
8913 addresses are always used.
8914 The latter are converted to IPv4 addresses, in dotted-quad form.
8915
8916 Ideally, it would be nice to tidy up this anomalous situation by changing to
8917 colons in all cases, given that quoting is now available for &(lsearch)&.
8918 However, this would be an incompatible change that might break some existing
8919 configurations.
8920
8921 &*Warning*&: Specifying &%net32-%& (for an IPv4 address) or &%net128-%& (for an
8922 IPv6 address) is not the same as specifying just &%net-%& without a number. In
8923 the former case the key strings include the mask value, whereas in the latter
8924 case the IP address is used on its own.
8925
8926
8927
8928 .section "Host list patterns that match by host name" "SECThoslispatnam"
8929 .cindex "host" "lookup failures"
8930 .cindex "unknown host name"
8931 .cindex "host list" "matching host name"
8932 There are several types of pattern that require Exim to know the name of the
8933 remote host. These are either wildcard patterns or lookups by name. (If a
8934 complete hostname is given without any wildcarding, it is used to find an IP
8935 address to match against, as described in section &<<SECThoslispatip>>&
8936 above.)
8937
8938 If the remote host name is not already known when Exim encounters one of these
8939 patterns, it has to be found from the IP address.
8940 Although many sites on the Internet are conscientious about maintaining reverse
8941 DNS data for their hosts, there are also many that do not do this.
8942 Consequently, a name cannot always be found, and this may lead to unwanted
8943 effects. Take care when configuring host lists with wildcarded name patterns.
8944 Consider what will happen if a name cannot be found.
8945
8946 Because of the problems of determining host names from IP addresses, matching
8947 against host names is not as common as matching against IP addresses.
8948
8949 By default, in order to find a host name, Exim first does a reverse DNS lookup;
8950 if no name is found in the DNS, the system function (&[gethostbyaddr()]& or
8951 &[getipnodebyaddr()]& if available) is tried. The order in which these lookups
8952 are done can be changed by setting the &%host_lookup_order%& option. For
8953 security, once Exim has found one or more names, it looks up the IP addresses
8954 for these names and compares them with the IP address that it started with.
8955 Only those names whose IP addresses match are accepted. Any other names are
8956 discarded. If no names are left, Exim behaves as if the host name cannot be
8957 found. In the most common case there is only one name and one IP address.
8958
8959 There are some options that control what happens if a host name cannot be
8960 found. These are described in section &<<SECTbehipnot>>& below.
8961
8962 .cindex "host" "alias for"
8963 .cindex "alias for host"
8964 As a result of aliasing, hosts may have more than one name. When processing any
8965 of the following types of pattern, all the host's names are checked:
8966
8967 .ilist
8968 .cindex "asterisk" "in host list"
8969 If a pattern starts with &"*"& the remainder of the item must match the end of
8970 the host name. For example, &`*.b.c`& matches all hosts whose names end in
8971 &'.b.c'&. This special simple form is provided because this is a very common
8972 requirement. Other kinds of wildcarding require the use of a regular
8973 expression.
8974 .next
8975 .cindex "regular expressions" "in host list"
8976 .cindex "host list" "regular expression in"
8977 If the item starts with &"^"& it is taken to be a regular expression which is
8978 matched against the host name. Host names are case-independent, so this regular
8979 expression match is by default case-independent, but you can make it
8980 case-dependent by starting it with &`(?-i)`&. References to descriptions of the
8981 syntax of regular expressions are given in chapter &<<CHAPregexp>>&. For
8982 example,
8983 .code
8984 ^(a|b)\.c\.d$
8985 .endd
8986 is a regular expression that matches either of the two hosts &'a.c.d'& or
8987 &'b.c.d'&. When a regular expression is used in a host list, you must take care
8988 that backslash and dollar characters are not misinterpreted as part of the
8989 string expansion. The simplest way to do this is to use &`\N`& to mark that
8990 part of the string as non-expandable. For example:
8991 .code
8992 sender_unqualified_hosts = \N^(a|b)\.c\.d$\N : ....
8993 .endd
8994 &*Warning*&: If you want to match a complete host name, you must include the
8995 &`$`& terminating metacharacter in the regular expression, as in the above
8996 example. Without it, a match at the start of the host name is all that is
8997 required.
8998 .endlist
8999
9000
9001
9002
9003 .section "Behaviour when an IP address or name cannot be found" "SECTbehipnot"
9004 .cindex "host" "lookup failures, permanent"
9005 While processing a host list, Exim may need to look up an IP address from a
9006 name (see section &<<SECThoslispatip>>&), or it may need to look up a host name
9007 from an IP address (see section &<<SECThoslispatnam>>&). In either case, the
9008 behaviour when it fails to find the information it is seeking is the same.
9009
9010 &*Note*&: This section applies to permanent lookup failures. It does &'not'&
9011 apply to temporary DNS errors, whose handling is described in the next section.
9012
9013 .cindex "&`+include_unknown`&"
9014 .cindex "&`+ignore_unknown`&"
9015 Exim parses a host list from left to right. If it encounters a permanent
9016 lookup failure in any item in the host list before it has found a match,
9017 Exim treats it as a failure and the default behavior is as if the host
9018 does not match the list. This may not always be what you want to happen.
9019 To change Exim's behaviour, the special items &`+include_unknown`& or
9020 &`+ignore_unknown`& may appear in the list (at top level &-- they are
9021 not recognized in an indirected file).
9022
9023 .ilist
9024 If any item that follows &`+include_unknown`& requires information that
9025 cannot found, Exim behaves as if the host does match the list. For example,
9026 .code
9027 host_reject_connection = +include_unknown:*.enemy.ex
9028 .endd
9029 rejects connections from any host whose name matches &`*.enemy.ex`&, and also
9030 any hosts whose name it cannot find.
9031
9032 .next
9033 If any item that follows &`+ignore_unknown`& requires information that cannot
9034 be found, Exim ignores that item and proceeds to the rest of the list. For
9035 example:
9036 .code
9037 accept hosts = +ignore_unknown : friend.example : \
9038                192.168.4.5
9039 .endd
9040 accepts from any host whose name is &'friend.example'& and from 192.168.4.5,
9041 whether or not its host name can be found. Without &`+ignore_unknown`&, if no
9042 name can be found for 192.168.4.5, it is rejected.
9043 .endlist
9044
9045 Both &`+include_unknown`& and &`+ignore_unknown`& may appear in the same
9046 list. The effect of each one lasts until the next, or until the end of the
9047 list.
9048
9049 .section "Mixing wildcarded host names and addresses in host lists" &&&
9050          "SECTmixwilhos"
9051 .cindex "host list" "mixing names and addresses in"
9052
9053 This section explains the host/ip processing logic with the same concepts
9054 as the previous section, but specifically addresses what happens when a
9055 wildcarded hostname is one of the items in the hostlist.
9056
9057 .ilist
9058 If you have name lookups or wildcarded host names and
9059 IP addresses in the same host list, you should normally put the IP
9060 addresses first. For example, in an ACL you could have:
9061 .code
9062 accept hosts = 10.9.8.7 : *.friend.example
9063 .endd
9064 The reason you normally would order it this way lies in the
9065 left-to-right way that Exim processes lists.  It can test IP addresses
9066 without doing any DNS lookups, but when it reaches an item that requires
9067 a host name, it fails if it cannot find a host name to compare with the
9068 pattern. If the above list is given in the opposite order, the
9069 &%accept%& statement fails for a host whose name cannot be found, even
9070 if its IP address is 10.9.8.7.
9071
9072 .next
9073 If you really do want to do the name check first, and still recognize the IP
9074 address, you can rewrite the ACL like this:
9075 .code
9076 accept hosts = *.friend.example
9077 accept hosts = 10.9.8.7
9078 .endd
9079 If the first &%accept%& fails, Exim goes on to try the second one. See chapter
9080 &<<CHAPACL>>& for details of ACLs. Alternatively, you can use
9081 &`+ignore_unknown`&, which was discussed in depth in the first example in
9082 this section.
9083 .endlist
9084
9085
9086 .section "Temporary DNS errors when looking up host information" &&&
9087          "SECTtemdnserr"
9088 .cindex "host" "lookup failures, temporary"
9089 .cindex "&`+include_defer`&"
9090 .cindex "&`+ignore_defer`&"
9091 A temporary DNS lookup failure normally causes a defer action (except when
9092 &%dns_again_means_nonexist%& converts it into a permanent error). However,
9093 host lists can include &`+ignore_defer`& and &`+include_defer`&, analogous to
9094 &`+ignore_unknown`& and &`+include_unknown`&, as described in the previous
9095 section. These options should be used with care, probably only in non-critical
9096 host lists such as whitelists.
9097
9098
9099
9100 .section "Host list patterns for single-key lookups by host name" &&&
9101          "SECThoslispatnamsk"
9102 .cindex "unknown host name"
9103 .cindex "host list" "matching host name"
9104 If a pattern is of the form
9105 .display
9106 <&'single-key-search-type'&>;<&'search-data'&>
9107 .endd
9108 for example
9109 .code
9110 dbm;/host/accept/list
9111 .endd
9112 a single-key lookup is performed, using the host name as its key. If the
9113 lookup succeeds, the host matches the item. The actual data that is looked up
9114 is not used.
9115
9116 &*Reminder*&: With this kind of pattern, you must have host &'names'& as
9117 keys in the file, not IP addresses. If you want to do lookups based on IP
9118 addresses, you must precede the search type with &"net-"& (see section
9119 &<<SECThoslispatsikey>>&). There is, however, no reason why you could not use
9120 two items in the same list, one doing an address lookup and one doing a name
9121 lookup, both using the same file.
9122
9123
9124
9125 .section "Host list patterns for query-style lookups" "SECID81"
9126 If a pattern is of the form
9127 .display
9128 <&'query-style-search-type'&>;<&'query'&>
9129 .endd
9130 the query is obeyed, and if it succeeds, the host matches the item. The actual
9131 data that is looked up is not used. The variables &$sender_host_address$& and
9132 &$sender_host_name$& can be used in the query. For example:
9133 .code
9134 hosts_lookup = pgsql;\
9135   select ip from hostlist where ip='$sender_host_address'
9136 .endd
9137 The value of &$sender_host_address$& for an IPv6 address contains colons. You
9138 can use the &%sg%& expansion item to change this if you need to. If you want to
9139 use masked IP addresses in database queries, you can use the &%mask%& expansion
9140 operator.
9141
9142 If the query contains a reference to &$sender_host_name$&, Exim automatically
9143 looks up the host name if it has not already done so. (See section
9144 &<<SECThoslispatnam>>& for comments on finding host names.)
9145
9146 Historical note: prior to release 4.30, Exim would always attempt to find a
9147 host name before running the query, unless the search type was preceded by
9148 &`net-`&. This is no longer the case. For backwards compatibility, &`net-`& is
9149 still recognized for query-style lookups, but its presence or absence has no
9150 effect. (Of course, for single-key lookups, &`net-`& &'is'& important.
9151 See section &<<SECThoslispatsikey>>&.)
9152
9153
9154
9155
9156
9157 .section "Address lists" "SECTaddresslist"
9158 .cindex "list" "address list"
9159 .cindex "address list" "empty item"
9160 .cindex "address list" "patterns"
9161 Address lists contain patterns that are matched against mail addresses. There
9162 is one special case to be considered: the sender address of a bounce message is
9163 always empty. You can test for this by providing an empty item in an address
9164 list. For example, you can set up a router to process bounce messages by
9165 using this option setting:
9166 .code
9167 senders = :
9168 .endd
9169 The presence of the colon creates an empty item. If you do not provide any
9170 data, the list is empty and matches nothing. The empty sender can also be
9171 detected by a regular expression that matches an empty string,
9172 and by a query-style lookup that succeeds when &$sender_address$& is empty.
9173
9174 Non-empty items in an address list can be straightforward email addresses. For
9175 example:
9176 .code
9177 senders = jbc@askone.example : hs@anacreon.example
9178 .endd
9179 A certain amount of wildcarding is permitted. If a pattern contains an @
9180 character, but is not a regular expression and does not begin with a
9181 semicolon-terminated lookup type (described below), the local part of the
9182 subject address is compared with the local part of the pattern, which may start
9183 with an asterisk. If the local parts match, the domain is checked in exactly
9184 the same way as for a pattern in a domain list. For example, the domain can be
9185 wildcarded, refer to a named list, or be a lookup:
9186 .code
9187 deny senders = *@*.spamming.site:\
9188                *@+hostile_domains:\
9189                bozo@partial-lsearch;/list/of/dodgy/sites:\
9190                *@dbm;/bad/domains.db
9191 .endd
9192 .cindex "local part" "starting with !"
9193 .cindex "address list" "local part starting with !"
9194 If a local part that begins with an exclamation mark is required, it has to be
9195 specified using a regular expression, because otherwise the exclamation mark is
9196 treated as a sign of negation, as is standard in lists.
9197
9198 If a non-empty pattern that is not a regular expression or a lookup does not
9199 contain an @ character, it is matched against the domain part of the subject
9200 address. The only two formats that are recognized this way are a literal
9201 domain, or a domain pattern that starts with *. In both these cases, the effect
9202 is the same as if &`*@`& preceded the pattern. For example:
9203 .code
9204 deny senders = enemy.domain : *.enemy.domain
9205 .endd
9206
9207 The following kinds of more complicated address list pattern can match any
9208 address, including the empty address that is characteristic of bounce message
9209 senders:
9210
9211 .ilist
9212 .cindex "regular expressions" "in address list"
9213 .cindex "address list" "regular expression in"
9214 If (after expansion) a pattern starts with &"^"&, a regular expression match is
9215 done against the complete address, with the pattern as the regular expression.
9216 You must take care that backslash and dollar characters are not misinterpreted
9217 as part of the string expansion. The simplest way to do this is to use &`\N`&
9218 to mark that part of the string as non-expandable. For example:
9219 .code
9220 deny senders = \N^.*this.*@example\.com$\N : \
9221                \N^\d{8}.+@spamhaus.example$\N : ...
9222 .endd
9223 The &`\N`& sequences are removed by the expansion, so these items do indeed
9224 start with &"^"& by the time they are being interpreted as address patterns.
9225
9226 .next
9227 .cindex "address list" "lookup for complete address"
9228 Complete addresses can be looked up by using a pattern that starts with a
9229 lookup type terminated by a semicolon, followed by the data for the lookup. For
9230 example:
9231 .code
9232 deny senders = cdb;/etc/blocked.senders : \
9233   mysql;select address from blocked where \
9234   address='${quote_mysql:$sender_address}'
9235 .endd
9236 Both query-style and single-key lookup types can be used. For a single-key
9237 lookup type, Exim uses the complete address as the key. However, empty keys are
9238 not supported for single-key lookups, so a match against the empty address
9239 always fails. This restriction does not apply to query-style lookups.
9240
9241 Partial matching for single-key lookups (section &<<SECTpartiallookup>>&)
9242 cannot be used, and is ignored if specified, with an entry being written to the
9243 panic log.
9244 .cindex "*@ with single-key lookup"
9245 However, you can configure lookup defaults, as described in section
9246 &<<SECTdefaultvaluelookups>>&, but this is useful only for the &"*@"& type of
9247 default. For example, with this lookup:
9248 .code
9249 accept senders = lsearch*@;/some/file
9250 .endd
9251 the file could contains lines like this:
9252 .code
9253 user1@domain1.example
9254 *@domain2.example
9255 .endd
9256 and for the sender address &'nimrod@jaeger.example'&, the sequence of keys
9257 that are tried is:
9258 .code
9259 nimrod@jaeger.example
9260 *@jaeger.example
9261 *
9262 .endd
9263 &*Warning 1*&: Do not include a line keyed by &"*"& in the file, because that
9264 would mean that every address matches, thus rendering the test useless.
9265
9266 &*Warning 2*&: Do not confuse these two kinds of item:
9267 .code
9268 deny recipients = dbm*@;/some/file
9269 deny recipients = *@dbm;/some/file
9270 .endd
9271 The first does a whole address lookup, with defaulting, as just described,
9272 because it starts with a lookup type. The second matches the local part and
9273 domain independently, as described in a bullet point below.
9274 .endlist
9275
9276
9277 The following kinds of address list pattern can match only non-empty addresses.
9278 If the subject address is empty, a match against any of these pattern types
9279 always fails.
9280
9281
9282 .ilist
9283 .cindex "@@ with single-key lookup"
9284 .cindex "address list" "@@ lookup type"
9285 .cindex "address list" "split local part and domain"
9286 If a pattern starts with &"@@"& followed by a single-key lookup item
9287 (for example, &`@@lsearch;/some/file`&), the address that is being checked is
9288 split into a local part and a domain. The domain is looked up in the file. If
9289 it is not found, there is no match. If it is found, the data that is looked up
9290 from the file is treated as a colon-separated list of local part patterns, each
9291 of which is matched against the subject local part in turn.
9292
9293 .cindex "asterisk" "in address list"
9294 The lookup may be a partial one, and/or one involving a search for a default
9295 keyed by &"*"& (see section &<<SECTdefaultvaluelookups>>&). The local part
9296 patterns that are looked up can be regular expressions or begin with &"*"&, or
9297 even be further lookups. They may also be independently negated. For example,
9298 with
9299 .code
9300 deny senders = @@dbm;/etc/reject-by-domain
9301 .endd
9302 the data from which the DBM file is built could contain lines like
9303 .code
9304 baddomain.com:  !postmaster : *
9305 .endd
9306 to reject all senders except &%postmaster%& from that domain.
9307
9308 .cindex "local part" "starting with !"
9309 If a local part that actually begins with an exclamation mark is required, it
9310 has to be specified using a regular expression. In &(lsearch)& files, an entry
9311 may be split over several lines by indenting the second and subsequent lines,
9312 but the separating colon must still be included at line breaks. White space
9313 surrounding the colons is ignored. For example:
9314 .code
9315 aol.com:  spammer1 : spammer2 : ^[0-9]+$ :
9316   spammer3 : spammer4
9317 .endd
9318 As in all colon-separated lists in Exim, a colon can be included in an item by
9319 doubling.
9320
9321 If the last item in the list starts with a right angle-bracket, the remainder
9322 of the item is taken as a new key to look up in order to obtain a continuation
9323 list of local parts. The new key can be any sequence of characters. Thus one
9324 might have entries like
9325 .code
9326 aol.com: spammer1 : spammer 2 : >*
9327 xyz.com: spammer3 : >*
9328 *:       ^\d{8}$
9329 .endd
9330 in a file that was searched with &%@@dbm*%&, to specify a match for 8-digit
9331 local parts for all domains, in addition to the specific local parts listed for
9332 each domain. Of course, using this feature costs another lookup each time a
9333 chain is followed, but the effort needed to maintain the data is reduced.
9334
9335 .cindex "loop" "in lookups"
9336 It is possible to construct loops using this facility, and in order to catch
9337 them, the chains may be no more than fifty items long.
9338
9339 .next
9340 The @@<&'lookup'&> style of item can also be used with a query-style
9341 lookup, but in this case, the chaining facility is not available. The lookup
9342 can only return a single list of local parts.
9343 .endlist
9344
9345 &*Warning*&: There is an important difference between the address list items
9346 in these two examples:
9347 .code
9348 senders = +my_list
9349 senders = *@+my_list
9350 .endd
9351 In the first one, &`my_list`& is a named address list, whereas in the second
9352 example it is a named domain list.
9353
9354
9355
9356
9357 .section "Case of letters in address lists" "SECTcasletadd"
9358 .cindex "case of local parts"
9359 .cindex "address list" "case forcing"
9360 .cindex "case forcing in address lists"
9361 Domains in email addresses are always handled caselessly, but for local parts
9362 case may be significant on some systems (see &%caseful_local_part%& for how
9363 Exim deals with this when routing addresses). However, RFC 2505 (&'Anti-Spam
9364 Recommendations for SMTP MTAs'&) suggests that matching of addresses to
9365 blocking lists should be done in a case-independent manner. Since most address
9366 lists in Exim are used for this kind of control, Exim attempts to do this by
9367 default.
9368
9369 The domain portion of an address is always lowercased before matching it to an
9370 address list. The local part is lowercased by default, and any string
9371 comparisons that take place are done caselessly. This means that the data in
9372 the address list itself, in files included as plain filenames, and in any file
9373 that is looked up using the &"@@"& mechanism, can be in any case. However, the
9374 keys in files that are looked up by a search type other than &(lsearch)& (which
9375 works caselessly) must be in lower case, because these lookups are not
9376 case-independent.
9377
9378 .cindex "&`+caseful`&"
9379 To allow for the possibility of caseful address list matching, if an item in
9380 an address list is the string &"+caseful"&, the original case of the local
9381 part is restored for any comparisons that follow, and string comparisons are no
9382 longer case-independent. This does not affect the domain, which remains in
9383 lower case. However, although independent matches on the domain alone are still
9384 performed caselessly, regular expressions that match against an entire address
9385 become case-sensitive after &"+caseful"& has been seen.
9386
9387
9388
9389 .section "Local part lists" "SECTlocparlis"
9390 .cindex "list" "local part list"
9391 .cindex "local part" "list"
9392 Case-sensitivity in local part lists is handled in the same way as for address
9393 lists, as just described. The &"+caseful"& item can be used if required. In a
9394 setting of the &%local_parts%& option in a router with &%caseful_local_part%&
9395 set false, the subject is lowercased and the matching is initially
9396 case-insensitive. In this case, &"+caseful"& will restore case-sensitive
9397 matching in the local part list, but not elsewhere in the router. If
9398 &%caseful_local_part%& is set true in a router, matching in the &%local_parts%&
9399 option is case-sensitive from the start.
9400
9401 If a local part list is indirected to a file (see section &<<SECTfilnamlis>>&),
9402 comments are handled in the same way as address lists &-- they are recognized
9403 only if the # is preceded by white space or the start of the line.
9404 Otherwise, local part lists are matched in the same way as domain lists, except
9405 that the special items that refer to the local host (&`@`&, &`@[]`&,
9406 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`&) are not recognized.
9407 Refer to section &<<SECTdomainlist>>& for details of the other available item
9408 types.
9409 .ecindex IIDdohoadli
9410
9411
9412
9413
9414 . ////////////////////////////////////////////////////////////////////////////
9415 . ////////////////////////////////////////////////////////////////////////////
9416
9417 .chapter "String expansions" "CHAPexpand"
9418 .scindex IIDstrexp "expansion" "of strings"
9419 Many strings in Exim's runtime configuration are expanded before use. Some of
9420 them are expanded every time they are used; others are expanded only once.
9421
9422 When a string is being expanded it is copied verbatim from left to right except
9423 .cindex expansion "string concatenation"
9424 when a dollar or backslash character is encountered. A dollar specifies the
9425 start of a portion of the string that is interpreted and replaced as described
9426 below in section &<<SECTexpansionitems>>& onwards. Backslash is used as an
9427 escape character, as described in the following section.
9428
9429 Whether a string is expanded depends upon the context.  Usually this is solely
9430 dependent upon the option for which a value is sought; in this documentation,
9431 options for which string expansion is performed are marked with &dagger; after
9432 the data type.  ACL rules always expand strings.  A couple of expansion
9433 conditions do not expand some of the brace-delimited branches, for security
9434 reasons,
9435 .cindex "tainted data" expansion
9436 .cindex expansion "tainted data"
9437 and expansion of data deriving from the sender (&"tainted data"&)
9438 is not permitted.
9439
9440
9441
9442 .section "Literal text in expanded strings" "SECTlittext"
9443 .cindex "expansion" "including literal text"
9444 An uninterpreted dollar can be included in an expanded string by putting a
9445 backslash in front of it. A backslash can be used to prevent any special
9446 character being treated specially in an expansion, including backslash itself.
9447 If the string appears in quotes in the configuration file, two backslashes are
9448 required because the quotes themselves cause interpretation of backslashes when
9449 the string is read in (see section &<<SECTstrings>>&).
9450
9451 .cindex "expansion" "non-expandable substrings"
9452 A portion of the string can specified as non-expandable by placing it between
9453 two occurrences of &`\N`&. This is particularly useful for protecting regular
9454 expressions, which often contain backslashes and dollar signs. For example:
9455 .code
9456 deny senders = \N^\d{8}[a-z]@some\.site\.example$\N
9457 .endd
9458 On encountering the first &`\N`&, the expander copies subsequent characters
9459 without interpretation until it reaches the next &`\N`& or the end of the
9460 string.
9461
9462
9463
9464 .section "Character escape sequences in expanded strings" "SECID82"
9465 .cindex "expansion" "escape sequences"
9466 A backslash followed by one of the letters &"n"&, &"r"&, or &"t"& in an
9467 expanded string is recognized as an escape sequence for the character newline,
9468 carriage return, or tab, respectively. A backslash followed by up to three
9469 octal digits is recognized as an octal encoding for a single character, and a
9470 backslash followed by &"x"& and up to two hexadecimal digits is a hexadecimal
9471 encoding.
9472
9473 These escape sequences are also recognized in quoted strings when they are read
9474 in. Their interpretation in expansions as well is useful for unquoted strings,
9475 and for other cases such as looked-up strings that are then expanded.
9476
9477
9478 .section "Testing string expansions" "SECID83"
9479 .cindex "expansion" "testing"
9480 .cindex "testing" "string expansion"
9481 .oindex "&%-be%&"
9482 Many expansions can be tested by calling Exim with the &%-be%& option. This
9483 takes the command arguments, or lines from the standard input if there are no
9484 arguments, runs them through the string expansion code, and writes the results
9485 to the standard output. Variables based on configuration values are set up, but
9486 since no message is being processed, variables such as &$local_part$& have no
9487 value. Nevertheless the &%-be%& option can be useful for checking out file and
9488 database lookups, and the use of expansion operators such as &%sg%&, &%substr%&
9489 and &%nhash%&.
9490
9491 Exim gives up its root privilege when it is called with the &%-be%& option, and
9492 instead runs under the uid and gid it was called with, to prevent users from
9493 using &%-be%& for reading files to which they do not have access.
9494
9495 .oindex "&%-bem%&"
9496 If you want to test expansions that include variables whose values are taken
9497 from a message, there are two other options that can be used. The &%-bem%&
9498 option is like &%-be%& except that it is followed by a filename. The file is
9499 read as a message before doing the test expansions. For example:
9500 .code
9501 exim -bem /tmp/test.message '$h_subject:'
9502 .endd
9503 The &%-Mset%& option is used in conjunction with &%-be%& and is followed by an
9504 Exim message identifier. For example:
9505 .code
9506 exim -be -Mset 1GrA8W-0004WS-LQ '$recipients'
9507 .endd
9508 This loads the message from Exim's spool before doing the test expansions, and
9509 is therefore restricted to admin users.
9510
9511
9512 .section "Forced expansion failure" "SECTforexpfai"
9513 .cindex "expansion" "forced failure"
9514 A number of expansions that are described in the following section have
9515 alternative &"true"& and &"false"& substrings, enclosed in brace characters
9516 (which are sometimes called &"curly brackets"&). Which of the two strings is
9517 used depends on some condition that is evaluated as part of the expansion. If,
9518 instead of a &"false"& substring, the word &"fail"& is used (not in braces),
9519 the entire string expansion fails in a way that can be detected by the code
9520 that requested the expansion. This is called &"forced expansion failure"&, and
9521 its consequences depend on the circumstances. In some cases it is no different
9522 from any other expansion failure, but in others a different action may be
9523 taken. Such variations are mentioned in the documentation of the option that is
9524 being expanded.
9525
9526
9527
9528
9529 .section "Expansion items" "SECTexpansionitems"
9530 The following items are recognized in expanded strings. White space may be used
9531 between sub-items that are keywords or substrings enclosed in braces inside an
9532 outer set of braces, to improve readability. &*Warning*&: Within braces,
9533 white space is significant.
9534
9535 .vlist
9536 .vitem &*$*&<&'variable&~name'&>&~or&~&*${*&<&'variable&~name'&>&*}*&
9537 .cindex "expansion" "variables"
9538 Substitute the contents of the named variable, for example:
9539 .code
9540 $local_part
9541 ${domain}
9542 .endd
9543 The second form can be used to separate the name from subsequent alphanumeric
9544 characters. This form (using braces) is available only for variables; it does
9545 &'not'& apply to message headers. The names of the variables are given in
9546 section &<<SECTexpvar>>& below. If the name of a non-existent variable is
9547 given, the expansion fails.
9548
9549 .vitem &*${*&<&'op'&>&*:*&<&'string'&>&*}*&
9550 .cindex "expansion" "operators"
9551 The string is first itself expanded, and then the operation specified by
9552 <&'op'&> is applied to it. For example:
9553 .code
9554 ${lc:$local_part}
9555 .endd
9556 The string starts with the first character after the colon, which may be
9557 leading white space. A list of operators is given in section &<<SECTexpop>>&
9558 below. The operator notation is used for simple expansion items that have just
9559 one argument, because it reduces the number of braces and therefore makes the
9560 string easier to understand.
9561
9562 .vitem &*$bheader_*&<&'header&~name'&>&*:*&&~or&~&*$bh_*&<&'header&~name'&>&*:*&
9563 This item inserts &"basic"& header lines. It is described with the &%header%&
9564 expansion item below.
9565
9566
9567 .vitem "&*${acl{*&<&'name'&>&*}{*&<&'arg'&>&*}...}*&"
9568 .cindex "expansion" "calling an acl"
9569 .cindex "&%acl%&" "call from expansion"
9570 The name and zero to nine argument strings are first expanded separately.  The expanded
9571 arguments are assigned to the variables &$acl_arg1$& to &$acl_arg9$& in order.
9572 Any unused are made empty.  The variable &$acl_narg$& is set to the number of
9573 arguments.  The named ACL (see chapter &<<CHAPACL>>&) is called
9574 and may use the variables; if another acl expansion is used the values
9575 are restored after it returns.  If the ACL sets
9576 a value using a "message =" modifier and returns accept or deny, the value becomes
9577 the result of the expansion.
9578 If no message is set and the ACL returns accept or deny
9579 the expansion result is an empty string.
9580 If the ACL returns defer the result is a forced-fail.  Otherwise the expansion fails.
9581
9582
9583 .vitem "&*${authresults{*&<&'authserv-id'&>&*}}*&"
9584 .cindex authentication "results header"
9585 .cindex headers "authentication-results:"
9586 .cindex authentication "expansion item"
9587 This item returns a string suitable for insertion as an
9588 &'Authentication-Results:'&
9589 header line.
9590 The given <&'authserv-id'&> is included in the result; typically this
9591 will be a domain name identifying the system performing the authentications.
9592 Methods that might be present in the result include:
9593 .code
9594 none
9595 iprev
9596 auth
9597 spf
9598 dkim
9599 .endd
9600
9601 Example use (as an ACL modifier):
9602 .code
9603       add_header = :at_start:${authresults {$primary_hostname}}
9604 .endd
9605 This is safe even if no authentication results are available.
9606
9607
9608 .vitem "&*${certextract{*&<&'field'&>&*}{*&<&'certificate'&>&*}&&&
9609        {*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9610 .cindex "expansion" "extracting certificate fields"
9611 .cindex "&%certextract%&" "certificate fields"
9612 .cindex "certificate" "extracting fields"
9613 The <&'certificate'&> must be a variable of type certificate.
9614 The field name is expanded and used to retrieve the relevant field from
9615 the certificate.  Supported fields are:
9616 .display
9617 &`version        `&
9618 &`serial_number  `&
9619 &`subject        `& RFC4514 DN
9620 &`issuer         `& RFC4514 DN
9621 &`notbefore      `& time
9622 &`notafter       `& time
9623 &`sig_algorithm  `&
9624 &`signature      `&
9625 &`subj_altname   `& tagged list
9626 &`ocsp_uri       `& list
9627 &`crl_uri        `& list
9628 .endd
9629 If the field is found,
9630 <&'string2'&> is expanded, and replaces the whole item;
9631 otherwise <&'string3'&> is used. During the expansion of <&'string2'&> the
9632 variable &$value$& contains the value that has been extracted. Afterwards, it
9633 is restored to any previous value it might have had.
9634
9635 If {<&'string3'&>} is omitted, the item is replaced by an empty string if the
9636 key is not found. If {<&'string2'&>} is also omitted, the value that was
9637 extracted is used.
9638
9639 Some field names take optional modifiers, appended and separated by commas.
9640
9641 The field selectors marked as "RFC4514" above
9642 output a Distinguished Name string which is
9643 not quite
9644 parseable by Exim as a comma-separated tagged list
9645 (the exceptions being elements containing commas).
9646 RDN elements of a single type may be selected by
9647 a modifier of the type label; if so the expansion
9648 result is a list (newline-separated by default).
9649 The separator may be changed by another modifier of
9650 a right angle-bracket followed immediately by the new separator.
9651 Recognised RDN type labels include "CN", "O", "OU" and "DC".
9652
9653 The field selectors marked as "time" above
9654 take an optional modifier of "int"
9655 for which the result is the number of seconds since epoch.
9656 Otherwise the result is a human-readable string
9657 in the timezone selected by the main "timezone" option.
9658
9659 The field selectors marked as "list" above return a list,
9660 newline-separated by default,
9661 (embedded separator characters in elements are doubled).
9662 The separator may be changed by a modifier of
9663 a right angle-bracket followed immediately by the new separator.
9664
9665 The field selectors marked as "tagged" above
9666 prefix each list element with a type string and an equals sign.
9667 Elements of only one type may be selected by a modifier
9668 which is one of "dns", "uri" or "mail";
9669 if so the element tags are omitted.
9670
9671 If not otherwise noted field values are presented in human-readable form.
9672
9673 .vitem "&*${dlfunc{*&<&'file'&>&*}{*&<&'function'&>&*}{*&<&'arg'&>&*}&&&
9674        {*&<&'arg'&>&*}...}*&"
9675 .cindex &%dlfunc%&
9676 This expansion dynamically loads and then calls a locally-written C function.
9677 This functionality is available only if Exim is compiled with
9678 .code
9679 EXPAND_DLFUNC=yes
9680 .endd
9681 set in &_Local/Makefile_&. Once loaded, Exim remembers the dynamically loaded
9682 object so that it doesn't reload the same object file in the same Exim process
9683 (but of course Exim does start new processes frequently).
9684
9685 There may be from zero to eight arguments to the function.
9686
9687 When compiling
9688 a local function that is to be called in this way,
9689 first &_DLFUNC_IMPL_& should be defined,
9690 and second &_local_scan.h_& should be included.
9691 The Exim variables and functions that are defined by that API
9692 are also available for dynamically loaded functions. The function itself
9693 must have the following type:
9694 .code
9695 int dlfunction(uschar **yield, int argc, uschar *argv[])
9696 .endd
9697 Where &`uschar`& is a typedef for &`unsigned char`& in &_local_scan.h_&. The
9698 function should return one of the following values:
9699
9700 &`OK`&: Success. The string that is placed in the variable &'yield'& is put
9701 into the expanded string that is being built.
9702
9703 &`FAIL`&: A non-forced expansion failure occurs, with the error message taken
9704 from &'yield'&, if it is set.
9705
9706 &`FAIL_FORCED`&: A forced expansion failure occurs, with the error message
9707 taken from &'yield'& if it is set.
9708
9709 &`ERROR`&: Same as &`FAIL`&, except that a panic log entry is written.
9710
9711 When compiling a function that is to be used in this way with gcc,
9712 you need to add &%-shared%& to the gcc command. Also, in the Exim build-time
9713 configuration, you must add &%-export-dynamic%& to EXTRALIBS.
9714
9715
9716 .vitem "&*${env{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&"
9717 .cindex "expansion" "extracting value from environment"
9718 .cindex "environment" "values from"
9719 The key is first expanded separately, and leading and trailing white space
9720 removed.
9721 This is then searched for as a name in the environment.
9722 If a variable is found then its value is placed in &$value$&
9723 and <&'string1'&> is expanded, otherwise <&'string2'&> is expanded.
9724
9725 Instead of {<&'string2'&>} the word &"fail"& (not in curly brackets) can
9726 appear, for example:
9727 .code
9728 ${env{USER}{$value} fail }
9729 .endd
9730 This forces an expansion failure (see section &<<SECTforexpfai>>&);
9731 {<&'string1'&>} must be present for &"fail"& to be recognized.
9732
9733 If {<&'string2'&>} is omitted an empty string is substituted on
9734 search failure.
9735 If {<&'string1'&>} is omitted the search result is substituted on
9736 search success.
9737
9738 The environment is adjusted by the &%keep_environment%& and
9739 &%add_environment%& main section options.
9740
9741
9742 .vitem "&*${extract{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}&&&
9743        {*&<&'string3'&>&*}}*&"
9744 .cindex "expansion" "extracting substrings by key"
9745 .cindex "&%extract%&" "substrings by key"
9746 The key and <&'string1'&> are first expanded separately. Leading and trailing
9747 white space is removed from the key (but not from any of the strings). The key
9748 must not be empty and must not consist entirely of digits.
9749 The expanded <&'string1'&> must be of the form:
9750 .display
9751 <&'key1'&> = <&'value1'&>  <&'key2'&> = <&'value2'&> ...
9752 .endd
9753 .vindex "&$value$&"
9754 where the equals signs and spaces (but not both) are optional. If any of the
9755 values contain white space, they must be enclosed in double quotes, and any
9756 values that are enclosed in double quotes are subject to escape processing as
9757 described in section &<<SECTstrings>>&. The expanded <&'string1'&> is searched
9758 for the value that corresponds to the key. The search is case-insensitive. If
9759 the key is found, <&'string2'&> is expanded, and replaces the whole item;
9760 otherwise <&'string3'&> is used. During the expansion of <&'string2'&> the
9761 variable &$value$& contains the value that has been extracted. Afterwards, it
9762 is restored to any previous value it might have had.
9763
9764 If {<&'string3'&>} is omitted, the item is replaced by an empty string if the
9765 key is not found. If {<&'string2'&>} is also omitted, the value that was
9766 extracted is used. Thus, for example, these two expansions are identical, and
9767 yield &"2001"&:
9768 .code
9769 ${extract{gid}{uid=1984 gid=2001}}
9770 ${extract{gid}{uid=1984 gid=2001}{$value}}
9771 .endd
9772 Instead of {<&'string3'&>} the word &"fail"& (not in curly brackets) can
9773 appear, for example:
9774 .code
9775 ${extract{Z}{A=... B=...}{$value} fail }
9776 .endd
9777 This forces an expansion failure (see section &<<SECTforexpfai>>&);
9778 {<&'string2'&>} must be present for &"fail"& to be recognized.
9779
9780 .vitem "&*${extract json{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}&&&
9781        {*&<&'string3'&>&*}}*&" &&&
9782        "&*${extract jsons{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}&&&
9783        {*&<&'string3'&>&*}}*&"
9784 .cindex "expansion" "extracting from JSON object"
9785 .cindex JSON expansions
9786 The key and <&'string1'&> are first expanded separately. Leading and trailing
9787 white space is removed from the key (but not from any of the strings). The key
9788 must not be empty and must not consist entirely of digits.
9789 The expanded <&'string1'&> must be of the form:
9790 .display
9791 { <&'"key1"'&> : <&'value1'&> ,  <&'"key2"'&> , <&'value2'&> ... }
9792 .endd
9793 .vindex "&$value$&"
9794 The braces, commas and colons, and the quoting of the member name are required;
9795 the spaces are optional.
9796 Matching of the key against the member names is done case-sensitively.
9797 For the &"json"& variant,
9798 if a returned value is a JSON string, it retains its leading and
9799 trailing quotes.
9800 For the &"jsons"& variant, which is intended for use with JSON strings, the
9801 leading and trailing quotes are removed from the returned value.
9802 . XXX should be a UTF-8 compare
9803
9804 The results of matching are handled as above.
9805
9806
9807 .vitem "&*${extract{*&<&'number'&>&*}{*&<&'separators'&>&*}&&&
9808         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9809 .cindex "expansion" "extracting substrings by number"
9810 .cindex "&%extract%&" "substrings by number"
9811 The <&'number'&> argument must consist entirely of decimal digits,
9812 apart from leading and trailing white space, which is ignored.
9813 This is what distinguishes this form of &%extract%& from the previous kind. It
9814 behaves in the same way, except that, instead of extracting a named field, it
9815 extracts from <&'string1'&> the field whose number is given as the first
9816 argument. You can use &$value$& in <&'string2'&> or &`fail`& instead of
9817 <&'string3'&> as before.
9818
9819 The fields in the string are separated by any one of the characters in the
9820 separator string. These may include space or tab characters.
9821 The first field is numbered one. If the number is negative, the fields are
9822 counted from the end of the string, with the rightmost one numbered -1. If the
9823 number given is zero, the entire string is returned. If the modulus of the
9824 number is greater than the number of fields in the string, the result is the
9825 expansion of <&'string3'&>, or the empty string if <&'string3'&> is not
9826 provided. For example:
9827 .code
9828 ${extract{2}{:}{x:42:99:& Mailer::/bin/bash}}
9829 .endd
9830 yields &"42"&, and
9831 .code
9832 ${extract{-4}{:}{x:42:99:& Mailer::/bin/bash}}
9833 .endd
9834 yields &"99"&. Two successive separators mean that the field between them is
9835 empty (for example, the fifth field above).
9836
9837
9838 .vitem "&*${extract json {*&<&'number'&>&*}}&&&
9839         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&" &&&
9840        "&*${extract jsons{*&<&'number'&>&*}}&&&
9841         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9842 .cindex "expansion" "extracting from JSON array"
9843 .cindex JSON expansions
9844 The <&'number'&> argument must consist entirely of decimal digits,
9845 apart from leading and trailing white space, which is ignored.
9846
9847 Field selection and result handling is as above;
9848 there is no choice of field separator.
9849 For the &"json"& variant,
9850 if a returned value is a JSON string, it retains its leading and
9851 trailing quotes.
9852 For the &"jsons"& variant, which is intended for use with JSON strings, the
9853 leading and trailing quotes are removed from the returned value.
9854
9855
9856 .vitem &*${filter{*&<&'string'&>&*}{*&<&'condition'&>&*}}*&
9857 .cindex "list" "selecting by condition"
9858 .cindex "expansion" "selecting from list by condition"
9859 .vindex "&$item$&"
9860 After expansion, <&'string'&> is interpreted as a list, colon-separated by
9861 default, but the separator can be changed in the usual way (&<<SECTlistsepchange>>&).
9862 For each item
9863 in this list, its value is place in &$item$&, and then the condition is
9864 evaluated. If the condition is true, &$item$& is added to the output as an
9865 item in a new list; if the condition is false, the item is discarded. The
9866 separator used for the output list is the same as the one used for the
9867 input, but a separator setting is not included in the output. For example:
9868 .code
9869 ${filter{a:b:c}{!eq{$item}{b}}}
9870 .endd
9871 yields &`a:c`&. At the end of the expansion, the value of &$item$& is restored
9872 to what it was before. See also the &%map%& and &%reduce%& expansion items.
9873
9874
9875 .vitem &*${hash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9876 .cindex "hash function" "textual"
9877 .cindex "expansion" "textual hash"
9878 This is a textual hashing function, and was the first to be implemented in
9879 early versions of Exim. In current releases, there are other hashing functions
9880 (numeric, MD5, and SHA-1), which are described below.
9881
9882 The first two strings, after expansion, must be numbers. Call them <&'m'&> and
9883 <&'n'&>. If you are using fixed values for these numbers, that is, if
9884 <&'string1'&> and <&'string2'&> do not change when they are expanded, you can
9885 use the simpler operator notation that avoids some of the braces:
9886 .code
9887 ${hash_<n>_<m>:<string>}
9888 .endd
9889 The second number is optional (in both notations). If <&'n'&> is greater than
9890 or equal to the length of the string, the expansion item returns the string.
9891 Otherwise it computes a new string of length <&'n'&> by applying a hashing
9892 function to the string. The new string consists of characters taken from the
9893 first <&'m'&> characters of the string
9894 .code
9895 abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQWRSTUVWXYZ0123456789
9896 .endd
9897 If <&'m'&> is not present the value 26 is used, so that only lower case
9898 letters appear. For example:
9899 .display
9900 &`$hash{3}{monty}}           `&   yields  &`jmg`&
9901 &`$hash{5}{monty}}           `&   yields  &`monty`&
9902 &`$hash{4}{62}{monty python}}`&   yields  &`fbWx`&
9903 .endd
9904
9905 .vitem "&*$header_*&<&'header&~name'&>&*:*&&~or&~&&&
9906         &*$h_*&<&'header&~name'&>&*:*&" &&&
9907        "&*$bheader_*&<&'header&~name'&>&*:*&&~or&~&&&
9908         &*$bh_*&<&'header&~name'&>&*:*&" &&&
9909        "&*$lheader_*&<&'header&~name'&>&*:*&&~or&~&&&
9910         &*$lh_*&<&'header&~name'&>&*:*&" &&&
9911        "&*$rheader_*&<&'header&~name'&>&*:*&&~or&~&&&
9912         &*$rh_*&<&'header&~name'&>&*:*&"
9913 .cindex "expansion" "header insertion"
9914 .vindex "&$header_$&"
9915 .vindex "&$bheader_$&"
9916 .vindex "&$lheader_$&"
9917 .vindex "&$rheader_$&"
9918 .cindex "header lines" "in expansion strings"
9919 .cindex "header lines" "character sets"
9920 .cindex "header lines" "decoding"
9921 Substitute the contents of the named message header line, for example
9922 .code
9923 $header_reply-to:
9924 .endd
9925 The newline that terminates a header line is not included in the expansion, but
9926 internal newlines (caused by splitting the header line over several physical
9927 lines) may be present.
9928
9929 The difference between the four pairs of expansions is in the way
9930 the data in the header line is interpreted.
9931
9932 .ilist
9933 .cindex "white space" "in header lines"
9934 &%rheader%& gives the original &"raw"& content of the header line, with no
9935 processing at all, and without the removal of leading and trailing white space.
9936
9937 .next
9938 .cindex "list" "of header lines"
9939 &%lheader%& gives a colon-separated list, one element per header when there
9940 are multiple headers with a given name.
9941 Any embedded colon characters within an element are doubled, so normal Exim
9942 list-processing facilities can be used.
9943 The terminating newline of each element is removed; in other respects
9944 the content is &"raw"&.
9945
9946 .next
9947 .cindex "base64 encoding" "in header lines"
9948 &%bheader%& removes leading and trailing white space, and then decodes base64
9949 or quoted-printable MIME &"words"& within the header text, but does no
9950 character set translation. If decoding of what looks superficially like a MIME
9951 &"word"& fails, the raw string is returned. If decoding
9952 .cindex "binary zero" "in header line"
9953 produces a binary zero character, it is replaced by a question mark &-- this is
9954 what Exim does for binary zeros that are actually received in header lines.
9955
9956 .next
9957 &%header%& tries to translate the string as decoded by &%bheader%& to a
9958 standard character set. This is an attempt to produce the same string as would
9959 be displayed on a user's MUA. If translation fails, the &%bheader%& string is
9960 returned. Translation is attempted only on operating systems that support the
9961 &[iconv()]& function. This is indicated by the compile-time macro HAVE_ICONV in
9962 a system Makefile or in &_Local/Makefile_&.
9963 .endlist ilist
9964
9965 In a filter file, the target character set for &%header%& can be specified by a
9966 command of the following form:
9967 .code
9968 headers charset "UTF-8"
9969 .endd
9970 This command affects all references to &$h_$& (or &$header_$&) expansions in
9971 subsequently obeyed filter commands. In the absence of this command, the target
9972 character set in a filter is taken from the setting of the &%headers_charset%&
9973 option in the runtime configuration. The value of this option defaults to the
9974 value of HEADERS_CHARSET in &_Local/Makefile_&. The ultimate default is
9975 ISO-8859-1.
9976
9977 Header names follow the syntax of RFC 2822, which states that they may contain
9978 any printing characters except space and colon. Consequently, curly brackets
9979 &'do not'& terminate header names, and should not be used to enclose them as
9980 if they were variables. Attempting to do so causes a syntax error.
9981
9982 Only header lines that are common to all copies of a message are visible to
9983 this mechanism. These are the original header lines that are received with the
9984 message, and any that are added by an ACL statement or by a system
9985 filter. Header lines that are added to a particular copy of a message by a
9986 router or transport are not accessible.
9987
9988 For incoming SMTP messages, no header lines are visible in
9989 ACLs that are obeyed before the data phase completes,
9990 because the header structure is not set up until the message is received.
9991 They are visible in DKIM, PRDR and DATA ACLs.
9992 Header lines that are added in a RCPT ACL (for example)
9993 are saved until the message's incoming header lines are available, at which
9994 point they are added.
9995 When any of the above ACLs ar
9996 running, however, header lines added by earlier ACLs are visible.
9997
9998 Upper case and lower case letters are synonymous in header names. If the
9999 following character is white space, the terminating colon may be omitted, but
10000 this is not recommended, because you may then forget it when it is needed. When
10001 white space terminates the header name, this white space is included in the
10002 expanded string.  If the message does not contain the given header, the
10003 expansion item is replaced by an empty string. (See the &%def%& condition in
10004 section &<<SECTexpcond>>& for a means of testing for the existence of a
10005 header.)
10006
10007 If there is more than one header with the same name, they are all concatenated
10008 to form the substitution string, up to a maximum length of 64K. Unless
10009 &%rheader%& is being used, leading and trailing white space is removed from
10010 each header before concatenation, and a completely empty header is ignored. A
10011 newline character is then inserted between non-empty headers, but there is no
10012 newline at the very end. For the &%header%& and &%bheader%& expansion, for
10013 those headers that contain lists of addresses, a comma is also inserted at the
10014 junctions between headers. This does not happen for the &%rheader%& expansion.
10015
10016 .new
10017 .cindex "tainted data"
10018 When the headers are from an incoming message,
10019 the result of expanding any of these variables is tainted.
10020 .wen
10021
10022
10023 .vitem &*${hmac{*&<&'hashname'&>&*}{*&<&'secret'&>&*}{*&<&'string'&>&*}}*&
10024 .cindex "expansion" "hmac hashing"
10025 .cindex &%hmac%&
10026 This function uses cryptographic hashing (either MD5 or SHA-1) to convert a
10027 shared secret and some text into a message authentication code, as specified in
10028 RFC 2104. This differs from &`${md5:secret_text...}`& or
10029 &`${sha1:secret_text...}`& in that the hmac step adds a signature to the
10030 cryptographic hash, allowing for authentication that is not possible with MD5
10031 or SHA-1 alone. The hash name must expand to either &`md5`& or &`sha1`& at
10032 present. For example:
10033 .code
10034 ${hmac{md5}{somesecret}{$primary_hostname $tod_log}}
10035 .endd
10036 For the hostname &'mail.example.com'& and time 2002-10-17 11:30:59, this
10037 produces:
10038 .code
10039 dd97e3ba5d1a61b5006108f8c8252953
10040 .endd
10041 As an example of how this might be used, you might put in the main part of
10042 an Exim configuration:
10043 .code
10044 SPAMSCAN_SECRET=cohgheeLei2thahw
10045 .endd
10046 In a router or a transport you could then have:
10047 .code
10048 headers_add = \
10049   X-Spam-Scanned: ${primary_hostname} ${message_exim_id} \
10050   ${hmac{md5}{SPAMSCAN_SECRET}\
10051   {${primary_hostname},${message_exim_id},$h_message-id:}}
10052 .endd
10053 Then given a message, you can check where it was scanned by looking at the
10054 &'X-Spam-Scanned:'& header line. If you know the secret, you can check that
10055 this header line is authentic by recomputing the authentication code from the
10056 host name, message ID and the &'Message-id:'& header line. This can be done
10057 using Exim's &%-be%& option, or by other means, for example, by using the
10058 &'hmac_md5_hex()'& function in Perl.
10059
10060
10061 .vitem &*${if&~*&<&'condition'&>&*&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
10062 .cindex "expansion" "conditional"
10063 .cindex "&%if%&, expansion item"
10064 If <&'condition'&> is true, <&'string1'&> is expanded and replaces the whole
10065 item; otherwise <&'string2'&> is used. The available conditions are described
10066 in section &<<SECTexpcond>>& below. For example:
10067 .code
10068 ${if eq {$local_part}{postmaster} {yes}{no} }
10069 .endd
10070 The second string need not be present; if it is not and the condition is not
10071 true, the item is replaced with nothing. Alternatively, the word &"fail"& may
10072 be present instead of the second string (without any curly brackets). In this
10073 case, the expansion is forced to fail if the condition is not true (see section
10074 &<<SECTforexpfai>>&).
10075
10076 If both strings are omitted, the result is the string &`true`& if the condition
10077 is true, and the empty string if the condition is false. This makes it less
10078 cumbersome to write custom ACL and router conditions. For example, instead of
10079 .code
10080 condition = ${if >{$acl_m4}{3}{true}{false}}
10081 .endd
10082 you can use
10083 .code
10084 condition = ${if >{$acl_m4}{3}}
10085 .endd
10086
10087
10088
10089 .vitem &*${imapfolder{*&<&'foldername'&>&*}}*&
10090 .cindex expansion "imap folder"
10091 .cindex "&%imapfolder%& expansion item"
10092 This item converts a (possibly multilevel, or with non-ASCII characters)
10093 folder specification to a Maildir name for filesystem use.
10094 For information on internationalisation support see &<<SECTi18nMDA>>&.
10095
10096
10097
10098 .vitem &*${length{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
10099 .cindex "expansion" "string truncation"
10100 .cindex "&%length%& expansion item"
10101 The &%length%& item is used to extract the initial portion of a string. Both
10102 strings are expanded, and the first one must yield a number, <&'n'&>, say. If
10103 you are using a fixed value for the number, that is, if <&'string1'&> does not
10104 change when expanded, you can use the simpler operator notation that avoids
10105 some of the braces:
10106 .code
10107 ${length_<n>:<string>}
10108 .endd
10109 The result of this item is either the first <&'n'&> bytes or the whole
10110 of <&'string2'&>, whichever is the shorter. Do not confuse &%length%& with
10111 &%strlen%&, which gives the length of a string.
10112 All measurement is done in bytes and is not UTF-8 aware.
10113
10114
10115 .vitem "&*${listextract{*&<&'number'&>&*}&&&
10116         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
10117 .cindex "expansion" "extracting list elements by number"
10118 .cindex "&%listextract%&" "extract list elements by number"
10119 .cindex "list" "extracting elements by number"
10120 The <&'number'&> argument must consist entirely of decimal digits,
10121 apart from an optional leading minus,
10122 and leading and trailing white space (which is ignored).
10123
10124 After expansion, <&'string1'&> is interpreted as a list, colon-separated by
10125 default, but the separator can be changed in the usual way (&<<SECTlistsepchange>>&).
10126
10127 The first field of the list is numbered one.
10128 If the number is negative, the fields are
10129 counted from the end of the list, with the rightmost one numbered -1.
10130 The numbered element of the list is extracted and placed in &$value$&,
10131 then <&'string2'&> is expanded as the result.
10132
10133 If the modulus of the
10134 number is zero or greater than the number of fields in the string,
10135 the result is the expansion of <&'string3'&>.
10136
10137 For example:
10138 .code
10139 ${listextract{2}{x:42:99}}
10140 .endd
10141 yields &"42"&, and
10142 .code
10143 ${listextract{-3}{<, x,42,99,& Mailer,,/bin/bash}{result: $value}}
10144 .endd
10145 yields &"result: 42"&.
10146
10147 If {<&'string3'&>} is omitted, an empty string is used for string3.
10148 If {<&'string2'&>} is also omitted, the value that was
10149 extracted is used.
10150 You can use &`fail`& instead of {<&'string3'&>} as in a string extract.
10151
10152
10153 .vitem "&*${lookup{*&<&'key'&>&*}&~*&<&'search&~type'&>&*&~&&&
10154         {*&<&'file'&>&*}&~{*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&"
10155 This is the first of one of two different types of lookup item, which are both
10156 described in the next item.
10157
10158 .vitem "&*${lookup&~*&<&'search&~type'&>&*&~{*&<&'query'&>&*}&~&&&
10159         {*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&"
10160 .cindex "expansion" "lookup in"
10161 .cindex "file" "lookups"
10162 .cindex "lookup" "in expanded string"
10163 The two forms of lookup item specify data lookups in files and databases, as
10164 discussed in chapter &<<CHAPfdlookup>>&. The first form is used for single-key
10165 lookups, and the second is used for query-style lookups. The <&'key'&>,
10166 <&'file'&>, and <&'query'&> strings are expanded before use.
10167
10168 If there is any white space in a lookup item which is part of a filter command,
10169 a retry or rewrite rule, a routing rule for the &(manualroute)& router, or any
10170 other place where white space is significant, the lookup item must be enclosed
10171 in double quotes. The use of data lookups in users' filter files may be locked
10172 out by the system administrator.
10173
10174 .vindex "&$value$&"
10175 If the lookup succeeds, <&'string1'&> is expanded and replaces the entire item.
10176 During its expansion, the variable &$value$& contains the data returned by the
10177 lookup. Afterwards it reverts to the value it had previously (at the outer
10178 level it is empty). If the lookup fails, <&'string2'&> is expanded and replaces
10179 the entire item. If {<&'string2'&>} is omitted, the replacement is the empty
10180 string on failure. If <&'string2'&> is provided, it can itself be a nested
10181 lookup, thus providing a mechanism for looking up a default value when the
10182 original lookup fails.
10183
10184 If a nested lookup is used as part of <&'string1'&>, &$value$& contains the
10185 data for the outer lookup while the parameters of the second lookup are
10186 expanded, and also while <&'string2'&> of the second lookup is expanded, should
10187 the second lookup fail. Instead of {<&'string2'&>} the word &"fail"& can
10188 appear, and in this case, if the lookup fails, the entire expansion is forced
10189 to fail (see section &<<SECTforexpfai>>&). If both {<&'string1'&>} and
10190 {<&'string2'&>} are omitted, the result is the looked up value in the case of a
10191 successful lookup, and nothing in the case of failure.
10192
10193 For single-key lookups, the string &"partial"& is permitted to precede the
10194 search type in order to do partial matching, and * or *@ may follow a search
10195 type to request default lookups if the key does not match (see sections
10196 &<<SECTdefaultvaluelookups>>& and &<<SECTpartiallookup>>& for details).
10197
10198 .cindex "numerical variables (&$1$& &$2$& etc)" "in lookup expansion"
10199 If a partial search is used, the variables &$1$& and &$2$& contain the wild
10200 and non-wild parts of the key during the expansion of the replacement text.
10201 They return to their previous values at the end of the lookup item.
10202
10203 This example looks up the postmaster alias in the conventional alias file:
10204 .code
10205 ${lookup {postmaster} lsearch {/etc/aliases} {$value}}
10206 .endd
10207 This example uses NIS+ to look up the full name of the user corresponding to
10208 the local part of an address, forcing the expansion to fail if it is not found:
10209 .code
10210 ${lookup nisplus {[name=$local_part],passwd.org_dir:gcos} \
10211   {$value}fail}
10212 .endd
10213
10214
10215 .vitem &*${map{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
10216 .cindex "expansion" "list creation"
10217 .vindex "&$item$&"
10218 After expansion, <&'string1'&> is interpreted as a list, colon-separated by
10219 default, but the separator can be changed in the usual way (&<<SECTlistsepchange>>&).
10220 For each item
10221 in this list, its value is place in &$item$&, and then <&'string2'&> is
10222 expanded and added to the output as an item in a new list. The separator used
10223 for the output list is the same as the one used for the input, but a separator
10224 setting is not included in the output. For example:
10225 .code
10226 ${map{a:b:c}{[$item]}} ${map{<- x-y-z}{($item)}}
10227 .endd
10228 expands to &`[a]:[b]:[c] (x)-(y)-(z)`&. At the end of the expansion, the
10229 value of &$item$& is restored to what it was before. See also the &%filter%&
10230 and &%reduce%& expansion items.
10231
10232 .vitem &*${nhash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
10233 .cindex "expansion" "numeric hash"
10234 .cindex "hash function" "numeric"
10235 The three strings are expanded; the first two must yield numbers. Call them
10236 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
10237 if <&'string1'&> and <&'string2'&> do not change when they are expanded, you
10238 can use the simpler operator notation that avoids some of the braces:
10239 .code
10240 ${nhash_<n>_<m>:<string>}
10241 .endd
10242 The second number is optional (in both notations). If there is only one number,
10243 the result is a number in the range 0&--<&'n'&>-1. Otherwise, the string is
10244 processed by a div/mod hash function that returns two numbers, separated by a
10245 slash, in the ranges 0 to <&'n'&>-1 and 0 to <&'m'&>-1, respectively. For
10246 example,
10247 .code
10248 ${nhash{8}{64}{supercalifragilisticexpialidocious}}
10249 .endd
10250 returns the string &"6/33"&.
10251
10252
10253
10254 .vitem &*${perl{*&<&'subroutine'&>&*}{*&<&'arg'&>&*}{*&<&'arg'&>&*}...}*&
10255 .cindex "Perl" "use in expanded string"
10256 .cindex "expansion" "calling Perl from"
10257 This item is available only if Exim has been built to include an embedded Perl
10258 interpreter. The subroutine name and the arguments are first separately
10259 expanded, and then the Perl subroutine is called with those arguments. No
10260 additional arguments need be given; the maximum number permitted, including the
10261 name of the subroutine, is nine.
10262
10263 The return value of the subroutine is inserted into the expanded string, unless
10264 the return value is &%undef%&. In that case, the expansion fails in the same
10265 way as an explicit &"fail"& on a lookup item. The return value is a scalar.
10266 Whatever you return is evaluated in a scalar context. For example, if you
10267 return the name of a Perl vector, the return value is the size of the vector,
10268 not its contents.
10269
10270 If the subroutine exits by calling Perl's &%die%& function, the expansion fails
10271 with the error message that was passed to &%die%&. More details of the embedded
10272 Perl facility are given in chapter &<<CHAPperl>>&.
10273
10274 The &(redirect)& router has an option called &%forbid_filter_perl%& which locks
10275 out the use of this expansion item in filter files.
10276
10277
10278 .vitem &*${prvs{*&<&'address'&>&*}{*&<&'secret'&>&*}{*&<&'keynumber'&>&*}}*&
10279 .cindex "&%prvs%& expansion item"
10280 The first argument is a complete email address and the second is secret
10281 keystring. The third argument, specifying a key number, is optional. If absent,
10282 it defaults to 0. The result of the expansion is a prvs-signed email address,
10283 to be typically used with the &%return_path%& option on an &(smtp)& transport
10284 as part of a bounce address tag validation (BATV) scheme. For more discussion
10285 and an example, see section &<<SECTverifyPRVS>>&.
10286
10287 .vitem "&*${prvscheck{*&<&'address'&>&*}{*&<&'secret'&>&*}&&&
10288         {*&<&'string'&>&*}}*&"
10289 .cindex "&%prvscheck%& expansion item"
10290 This expansion item is the complement of the &%prvs%& item. It is used for
10291 checking prvs-signed addresses. If the expansion of the first argument does not
10292 yield a syntactically valid prvs-signed address, the whole item expands to the
10293 empty string. When the first argument does expand to a syntactically valid
10294 prvs-signed address, the second argument is expanded, with the prvs-decoded
10295 version of the address and the key number extracted from the address in the
10296 variables &$prvscheck_address$& and &$prvscheck_keynum$&, respectively.
10297
10298 These two variables can be used in the expansion of the second argument to
10299 retrieve the secret. The validity of the prvs-signed address is then checked
10300 against the secret. The result is stored in the variable &$prvscheck_result$&,
10301 which is empty for failure or &"1"& for success.
10302
10303 The third argument is optional; if it is missing, it defaults to an empty
10304 string. This argument is now expanded. If the result is an empty string, the
10305 result of the expansion is the decoded version of the address. This is the case
10306 whether or not the signature was valid. Otherwise, the result of the expansion
10307 is the expansion of the third argument.
10308
10309 All three variables can be used in the expansion of the third argument.
10310 However, once the expansion is complete, only &$prvscheck_result$& remains set.
10311 For more discussion and an example, see section &<<SECTverifyPRVS>>&.
10312
10313 .vitem &*${readfile{*&<&'file&~name'&>&*}{*&<&'eol&~string'&>&*}}*&
10314 .cindex "expansion" "inserting an entire file"
10315 .cindex "file" "inserting into expansion"
10316 .cindex "&%readfile%& expansion item"
10317 The filename and end-of-line string are first expanded separately. The file is
10318 then read, and its contents replace the entire item. All newline characters in
10319 the file are replaced by the end-of-line string if it is present. Otherwise,
10320 newlines are left in the string.
10321 String expansion is not applied to the contents of the file. If you want this,
10322 you must wrap the item in an &%expand%& operator. If the file cannot be read,
10323 the string expansion fails.
10324
10325 The &(redirect)& router has an option called &%forbid_filter_readfile%& which
10326 locks out the use of this expansion item in filter files.
10327
10328
10329
10330 .vitem "&*${readsocket{*&<&'name'&>&*}{*&<&'request'&>&*}&&&
10331         {*&<&'options'&>&*}{*&<&'eol&~string'&>&*}{*&<&'fail&~string'&>&*}}*&"
10332 .cindex "expansion" "inserting from a socket"
10333 .cindex "socket, use of in expansion"
10334 .cindex "&%readsocket%& expansion item"
10335 This item inserts data from a Unix domain or TCP socket into the expanded
10336 string. The minimal way of using it uses just two arguments, as in these
10337 examples:
10338 .code
10339 ${readsocket{/socket/name}{request string}}
10340 ${readsocket{inet:some.host:1234}{request string}}
10341 .endd
10342 For a Unix domain socket, the first substring must be the path to the socket.
10343 For an Internet socket, the first substring must contain &`inet:`& followed by
10344 a host name or IP address, followed by a colon and a port, which can be a
10345 number or the name of a TCP port in &_/etc/services_&. An IP address may
10346 optionally be enclosed in square brackets. This is best for IPv6 addresses. For
10347 example:
10348 .code
10349 ${readsocket{inet:[::1]:1234}{request string}}
10350 .endd
10351 Only a single host name may be given, but if looking it up yields more than
10352 one IP address, they are each tried in turn until a connection is made. For
10353 both kinds of socket, Exim makes a connection, writes the request string
10354 unless it is an empty string; and no terminating NUL is ever sent)
10355 and reads from the socket until an end-of-file
10356 is read. A timeout of 5 seconds is applied. Additional, optional arguments
10357 extend what can be done. Firstly, you can vary the timeout. For example:
10358 .code
10359 ${readsocket{/socket/name}{request string}{3s}}
10360 .endd
10361
10362 The third argument is a list of options, of which the first element is the timeout
10363 and must be present if any options are given.
10364 Further elements are options of form &'name=value'&.
10365 Example:
10366 .code
10367 ${readsocket{/socket/name}{request string}{3s:shutdown=no}}
10368 .endd
10369
10370 .new
10371 The following option names are recognised:
10372 .ilist
10373 &*cache*&
10374 Defines if the result data can be cached for use by a later identical
10375 request in the same process.
10376 Values are &"yes"& or &"no"& (the default).
10377 If not, all cached results for this connection specification
10378 will be invalidated.
10379
10380 .next
10381 &*shutdown*&
10382 Defines whether or not a write-shutdown is done on the connection after
10383 sending the request. Values are &"yes"& (the default) or &"no"&
10384 (preferred, eg. by some webservers).
10385
10386 .next
10387 &*tls*&
10388 Controls the use of TLS on the connection.
10389 Values are &"yes"& or &"no"& (the default).
10390 If it is enabled, a shutdown as descripbed above is never done.
10391 .endlist
10392 .wen
10393
10394
10395 A fourth argument allows you to change any newlines that are in the data
10396 that is read, in the same way as for &%readfile%& (see above). This example
10397 turns them into spaces:
10398 .code
10399 ${readsocket{inet:127.0.0.1:3294}{request string}{3s}{ }}
10400 .endd
10401 As with all expansions, the substrings are expanded before the processing
10402 happens. Errors in these sub-expansions cause the expansion to fail. In
10403 addition, the following errors can occur:
10404
10405 .ilist
10406 Failure to create a socket file descriptor;
10407 .next
10408 Failure to connect the socket;
10409 .next
10410 Failure to write the request string;
10411 .next
10412 Timeout on reading from the socket.
10413 .endlist
10414
10415 By default, any of these errors causes the expansion to fail. However, if
10416 you supply a fifth substring, it is expanded and used when any of the above
10417 errors occurs. For example:
10418 .code
10419 ${readsocket{/socket/name}{request string}{3s}{\n}\
10420   {socket failure}}
10421 .endd
10422 You can test for the existence of a Unix domain socket by wrapping this
10423 expansion in &`${if exists`&, but there is a race condition between that test
10424 and the actual opening of the socket, so it is safer to use the fifth argument
10425 if you want to be absolutely sure of avoiding an expansion error for a
10426 non-existent Unix domain socket, or a failure to connect to an Internet socket.
10427
10428 The &(redirect)& router has an option called &%forbid_filter_readsocket%& which
10429 locks out the use of this expansion item in filter files.
10430
10431
10432 .vitem &*${reduce{*&<&'string1'&>}{<&'string2'&>&*}{*&<&'string3'&>&*}}*&
10433 .cindex "expansion" "reducing a list to a scalar"
10434 .cindex "list" "reducing to a scalar"
10435 .vindex "&$value$&"
10436 .vindex "&$item$&"
10437 This operation reduces a list to a single, scalar string. After expansion,
10438 <&'string1'&> is interpreted as a list, colon-separated by default, but the
10439 separator can be changed in the usual way (&<<SECTlistsepchange>>&).
10440 Then <&'string2'&> is expanded and
10441 assigned to the &$value$& variable. After this, each item in the <&'string1'&>
10442 list is assigned to &$item$&, in turn, and <&'string3'&> is expanded for each of
10443 them. The result of that expansion is assigned to &$value$& before the next
10444 iteration. When the end of the list is reached, the final value of &$value$& is
10445 added to the expansion output. The &%reduce%& expansion item can be used in a
10446 number of ways. For example, to add up a list of numbers:
10447 .code
10448 ${reduce {<, 1,2,3}{0}{${eval:$value+$item}}}
10449 .endd
10450 The result of that expansion would be &`6`&. The maximum of a list of numbers
10451 can be found:
10452 .code
10453 ${reduce {3:0:9:4:6}{0}{${if >{$item}{$value}{$item}{$value}}}}
10454 .endd
10455 At the end of a &*reduce*& expansion, the values of &$item$& and &$value$& are
10456 restored to what they were before. See also the &%filter%& and &%map%&
10457 expansion items.
10458
10459 .vitem &*$rheader_*&<&'header&~name'&>&*:*&&~or&~&*$rh_*&<&'header&~name'&>&*:*&
10460 This item inserts &"raw"& header lines. It is described with the &%header%&
10461 expansion item in section &<<SECTexpansionitems>>& above.
10462
10463 .vitem "&*${run{*&<&'command'&>&*&~*&<&'args'&>&*}{*&<&'string1'&>&*}&&&
10464         {*&<&'string2'&>&*}}*&"
10465 .cindex "expansion" "running a command"
10466 .cindex "&%run%& expansion item"
10467 The command and its arguments are first expanded as one string. The string is
10468 split apart into individual arguments by spaces, and then the command is run
10469 in a separate process, but under the same uid and gid.  As in other command
10470 executions from Exim, a shell is not used by default. If the command requires
10471 a shell, you must explicitly code it.
10472
10473 Since the arguments are split by spaces, when there is a variable expansion
10474 which has an empty result, it will cause the situation that the argument will
10475 simply be omitted when the program is actually executed by Exim. If the
10476 script/program requires a specific number of arguments and the expanded
10477 variable could possibly result in this empty expansion, the variable must be
10478 quoted. This is more difficult if the expanded variable itself could result
10479 in a string containing quotes, because it would interfere with the quotes
10480 around the command arguments. A possible guard against this is to wrap the
10481 variable in the &%sg%& operator to change any quote marks to some other
10482 character.
10483
10484 The standard input for the command exists, but is empty. The standard output
10485 and standard error are set to the same file descriptor.
10486 .cindex "return code" "from &%run%& expansion"
10487 .vindex "&$value$&"
10488 If the command succeeds (gives a zero return code) <&'string1'&> is expanded
10489 and replaces the entire item; during this expansion, the standard output/error
10490 from the command is in the variable &$value$&. If the command fails,
10491 <&'string2'&>, if present, is expanded and used. Once again, during the
10492 expansion, the standard output/error from the command is in the variable
10493 &$value$&.
10494
10495 If <&'string2'&> is absent, the result is empty. Alternatively, <&'string2'&>
10496 can be the word &"fail"& (not in braces) to force expansion failure if the
10497 command does not succeed. If both strings are omitted, the result is contents
10498 of the standard output/error on success, and nothing on failure.
10499
10500 .vindex "&$run_in_acl$&"
10501 The standard output/error of the command is put in the variable &$value$&.
10502 In this ACL example, the output of a command is logged for the admin to
10503 troubleshoot:
10504 .code
10505 warn  condition    = ${run{/usr/bin/id}{yes}{no}}
10506       log_message  = Output of id: $value
10507 .endd
10508 If the command requires shell idioms, such as the > redirect operator, the
10509 shell must be invoked directly, such as with:
10510 .code
10511 ${run{/bin/bash -c "/usr/bin/id >/tmp/id"}{yes}{yes}}
10512 .endd
10513
10514 .vindex "&$runrc$&"
10515 The return code from the command is put in the variable &$runrc$&, and this
10516 remains set afterwards, so in a filter file you can do things like this:
10517 .code
10518 if "${run{x y z}{}}$runrc" is 1 then ...
10519   elif $runrc is 2 then ...
10520   ...
10521 endif
10522 .endd
10523 If execution of the command fails (for example, the command does not exist),
10524 the return code is 127 &-- the same code that shells use for non-existent
10525 commands.
10526
10527 &*Warning*&: In a router or transport, you cannot assume the order in which
10528 option values are expanded, except for those preconditions whose order of
10529 testing is documented. Therefore, you cannot reliably expect to set &$runrc$&
10530 by the expansion of one option, and use it in another.
10531
10532 The &(redirect)& router has an option called &%forbid_filter_run%& which locks
10533 out the use of this expansion item in filter files.
10534
10535
10536 .vitem &*${sg{*&<&'subject'&>&*}{*&<&'regex'&>&*}{*&<&'replacement'&>&*}}*&
10537 .cindex "expansion" "string substitution"
10538 .cindex "&%sg%& expansion item"
10539 This item works like Perl's substitution operator (s) with the global (/g)
10540 option; hence its name. However, unlike the Perl equivalent, Exim does not
10541 modify the subject string; instead it returns the modified string for insertion
10542 into the overall expansion. The item takes three arguments: the subject string,
10543 a regular expression, and a substitution string. For example:
10544 .code
10545 ${sg{abcdefabcdef}{abc}{xyz}}
10546 .endd
10547 yields &"xyzdefxyzdef"&. Because all three arguments are expanded before use,
10548 if any $, } or \ characters are required in the regular expression or in the
10549 substitution string, they have to be escaped. For example:
10550 .code
10551 ${sg{abcdef}{^(...)(...)\$}{\$2\$1}}
10552 .endd
10553 yields &"defabc"&, and
10554 .code
10555 ${sg{1=A 4=D 3=C}{\N(\d+)=\N}{K\$1=}}
10556 .endd
10557 yields &"K1=A K4=D K3=C"&. Note the use of &`\N`& to protect the contents of
10558 the regular expression from string expansion.
10559
10560 The regular expression is compiled in 8-bit mode, working against bytes
10561 rather than any Unicode-aware character handling.
10562
10563
10564 .vitem &*${sort{*&<&'string'&>&*}{*&<&'comparator'&>&*}{*&<&'extractor'&>&*}}*&
10565 .cindex sorting "a list"
10566 .cindex list sorting
10567 .cindex expansion "list sorting"
10568 After expansion, <&'string'&> is interpreted as a list, colon-separated by
10569 default, but the separator can be changed in the usual way (&<<SECTlistsepchange>>&).
10570 The <&'comparator'&> argument is interpreted as the operator
10571 of a two-argument expansion condition.
10572 The numeric operators plus ge, gt, le, lt (and ~i variants) are supported.
10573 The comparison should return true when applied to two values
10574 if the first value should sort before the second value.
10575 The <&'extractor'&> expansion is applied repeatedly to elements of the list,
10576 the element being placed in &$item$&,
10577 to give values for comparison.
10578
10579 The item result is a sorted list,
10580 with the original list separator,
10581 of the list elements (in full) of the original.
10582
10583 Examples:
10584 .code
10585 ${sort{3:2:1:4}{<}{$item}}
10586 .endd
10587 sorts a list of numbers, and
10588 .code
10589 ${sort {${lookup dnsdb{>:,,mx=example.com}}} {<} {${listextract{1}{<,$item}}}}
10590 .endd
10591 will sort an MX lookup into priority order.
10592
10593
10594 .vitem &*${substr{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
10595 .cindex "&%substr%& expansion item"
10596 .cindex "substring extraction"
10597 .cindex "expansion" "substring extraction"
10598 The three strings are expanded; the first two must yield numbers. Call them
10599 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
10600 if <&'string1'&> and <&'string2'&> do not change when they are expanded, you
10601 can use the simpler operator notation that avoids some of the braces:
10602 .code
10603 ${substr_<n>_<m>:<string>}
10604 .endd
10605 The second number is optional (in both notations).
10606 If it is absent in the simpler format, the preceding underscore must also be
10607 omitted.
10608
10609 The &%substr%& item can be used to extract more general substrings than
10610 &%length%&. The first number, <&'n'&>, is a starting offset, and <&'m'&> is the
10611 length required. For example
10612 .code
10613 ${substr{3}{2}{$local_part}}
10614 .endd
10615 If the starting offset is greater than the string length the result is the
10616 null string; if the length plus starting offset is greater than the string
10617 length, the result is the right-hand part of the string, starting from the
10618 given offset. The first byte (character) in the string has offset zero.
10619
10620 The &%substr%& expansion item can take negative offset values to count
10621 from the right-hand end of its operand. The last byte (character) is offset -1,
10622 the second-last is offset -2, and so on. Thus, for example,
10623 .code
10624 ${substr{-5}{2}{1234567}}
10625 .endd
10626 yields &"34"&. If the absolute value of a negative offset is greater than the
10627 length of the string, the substring starts at the beginning of the string, and
10628 the length is reduced by the amount of overshoot. Thus, for example,
10629 .code
10630 ${substr{-5}{2}{12}}
10631 .endd
10632 yields an empty string, but
10633 .code
10634 ${substr{-3}{2}{12}}
10635 .endd
10636 yields &"1"&.
10637
10638 When the second number is omitted from &%substr%&, the remainder of the string
10639 is taken if the offset is positive. If it is negative, all bytes (characters) in the
10640 string preceding the offset point are taken. For example, an offset of -1 and
10641 no length, as in these semantically identical examples:
10642 .code
10643 ${substr_-1:abcde}
10644 ${substr{-1}{abcde}}
10645 .endd
10646 yields all but the last character of the string, that is, &"abcd"&.
10647
10648 All measurement is done in bytes and is not UTF-8 aware.
10649
10650
10651
10652 .vitem "&*${tr{*&<&'subject'&>&*}{*&<&'characters'&>&*}&&&
10653         {*&<&'replacements'&>&*}}*&"
10654 .cindex "expansion" "character translation"
10655 .cindex "&%tr%& expansion item"
10656 This item does single-character (in bytes) translation on its subject string. The second
10657 argument is a list of characters to be translated in the subject string. Each
10658 matching character is replaced by the corresponding character from the
10659 replacement list. For example
10660 .code
10661 ${tr{abcdea}{ac}{13}}
10662 .endd
10663 yields &`1b3de1`&. If there are duplicates in the second character string, the
10664 last occurrence is used. If the third string is shorter than the second, its
10665 last character is replicated. However, if it is empty, no translation takes
10666 place.
10667
10668 All character handling is done in bytes and is not UTF-8 aware.
10669
10670 .endlist
10671
10672
10673
10674 .section "Expansion operators" "SECTexpop"
10675 .cindex "expansion" "operators"
10676 For expansion items that perform transformations on a single argument string,
10677 the &"operator"& notation is used because it is simpler and uses fewer braces.
10678 The substring is first expanded before the operation is applied to it. The
10679 following operations can be performed:
10680
10681 .vlist
10682 .vitem &*${address:*&<&'string'&>&*}*&
10683 .cindex "expansion" "RFC 2822 address handling"
10684 .cindex "&%address%& expansion item"
10685 The string is interpreted as an RFC 2822 address, as it might appear in a
10686 header line, and the effective address is extracted from it. If the string does
10687 not parse successfully, the result is empty.
10688
10689 The parsing correctly handles SMTPUTF8 Unicode in the string.
10690
10691
10692 .vitem &*${addresses:*&<&'string'&>&*}*&
10693 .cindex "expansion" "RFC 2822 address handling"
10694 .cindex "&%addresses%& expansion item"
10695 The string (after expansion) is interpreted as a list of addresses in RFC
10696 2822 format, such as can be found in a &'To:'& or &'Cc:'& header line. The
10697 operative address (&'local-part@domain'&) is extracted from each item, and the
10698 result of the expansion is a colon-separated list, with appropriate
10699 doubling of colons should any happen to be present in the email addresses.
10700 Syntactically invalid RFC2822 address items are omitted from the output.
10701
10702 It is possible to specify a character other than colon for the output
10703 separator by starting the string with > followed by the new separator
10704 character. For example:
10705 .code
10706 ${addresses:>& Chief <ceo@up.stairs>, sec@base.ment (dogsbody)}
10707 .endd
10708 expands to &`ceo@up.stairs&&sec@base.ment`&. The string is expanded
10709 first, so if the expanded string starts with >, it may change the output
10710 separator unintentionally. This can be avoided by setting the output
10711 separator explicitly:
10712 .code
10713 ${addresses:>:$h_from:}
10714 .endd
10715
10716 Compare the &%address%& (singular)
10717 expansion item, which extracts the working address from a single RFC2822
10718 address. See the &%filter%&, &%map%&, and &%reduce%& items for ways of
10719 processing lists.
10720
10721 To clarify "list of addresses in RFC 2822 format" mentioned above, Exim follows
10722 a strict interpretation of header line formatting.  Exim parses the bare,
10723 unquoted portion of an email address and if it finds a comma, treats it as an
10724 email address separator. For the example header line:
10725 .code
10726 From: =?iso-8859-2?Q?Last=2C_First?= <user@example.com>
10727 .endd
10728 The first example below demonstrates that Q-encoded email addresses are parsed
10729 properly if it is given the raw header (in this example, &`$rheader_from:`&).
10730 It does not see the comma because it's still encoded as "=2C".  The second
10731 example below is passed the contents of &`$header_from:`&, meaning it gets
10732 de-mimed. Exim sees the decoded "," so it treats it as &*two*& email addresses.
10733 The third example shows that the presence of a comma is skipped when it is
10734 quoted.  The fourth example shows SMTPUTF8 handling.
10735 .code
10736 # exim -be '${addresses:From: \
10737 =?iso-8859-2?Q?Last=2C_First?= <user@example.com>}'
10738 user@example.com
10739 # exim -be '${addresses:From: Last, First <user@example.com>}'
10740 Last:user@example.com
10741 # exim -be '${addresses:From: "Last, First" <user@example.com>}'
10742 user@example.com
10743 # exim -be '${addresses:フィル <フィリップ@example.jp>}'
10744 フィリップ@example.jp
10745 .endd
10746
10747 .vitem &*${base32:*&<&'digits'&>&*}*&
10748 .cindex "&%base32%& expansion item"
10749 .cindex "expansion" "conversion to base 32"
10750 The string must consist entirely of decimal digits. The number is converted to
10751 base 32 and output as a (empty, for zero) string of characters.
10752 Only lowercase letters are used.
10753
10754 .vitem &*${base32d:*&<&'base-32&~digits'&>&*}*&
10755 .cindex "&%base32d%& expansion item"
10756 .cindex "expansion" "conversion to base 32"
10757 The string must consist entirely of base-32 digits.
10758 The number is converted to decimal and output as a string.
10759
10760 .vitem &*${base62:*&<&'digits'&>&*}*&
10761 .cindex "&%base62%& expansion item"
10762 .cindex "expansion" "conversion to base 62"
10763 The string must consist entirely of decimal digits. The number is converted to
10764 base 62 and output as a string of six characters, including leading zeros. In
10765 the few operating environments where Exim uses base 36 instead of base 62 for
10766 its message identifiers (because those systems do not have case-sensitive
10767 filenames), base 36 is used by this operator, despite its name. &*Note*&: Just
10768 to be absolutely clear: this is &'not'& base64 encoding.
10769
10770 .vitem &*${base62d:*&<&'base-62&~digits'&>&*}*&
10771 .cindex "&%base62d%& expansion item"
10772 .cindex "expansion" "conversion to base 62"
10773 The string must consist entirely of base-62 digits, or, in operating
10774 environments where Exim uses base 36 instead of base 62 for its message
10775 identifiers, base-36 digits. The number is converted to decimal and output as a
10776 string.
10777
10778 .vitem &*${base64:*&<&'string'&>&*}*&
10779 .cindex "expansion" "base64 encoding"
10780 .cindex "base64 encoding" "in string expansion"
10781 .cindex "&%base64%& expansion item"
10782 .cindex certificate "base64 of DER"
10783 This operator converts a string into one that is base64 encoded.
10784
10785 If the string is a single variable of type certificate,
10786 returns the base64 encoding of the DER form of the certificate.
10787
10788
10789 .vitem &*${base64d:*&<&'string'&>&*}*&
10790 .cindex "expansion" "base64 decoding"
10791 .cindex "base64 decoding" "in string expansion"
10792 .cindex "&%base64d%& expansion item"
10793 This operator converts a base64-encoded string into the un-coded form.
10794
10795
10796 .vitem &*${domain:*&<&'string'&>&*}*&
10797 .cindex "domain" "extraction"
10798 .cindex "expansion" "domain extraction"
10799 The string is interpreted as an RFC 2822 address and the domain is extracted
10800 from it. If the string does not parse successfully, the result is empty.
10801
10802
10803 .vitem &*${escape:*&<&'string'&>&*}*&
10804 .cindex "expansion" "escaping non-printing characters"
10805 .cindex "&%escape%& expansion item"
10806 If the string contains any non-printing characters, they are converted to
10807 escape sequences starting with a backslash. Whether characters with the most
10808 significant bit set (so-called &"8-bit characters"&) count as printing or not
10809 is controlled by the &%print_topbitchars%& option.
10810
10811 .vitem &*${escape8bit:*&<&'string'&>&*}*&
10812 .cindex "expansion" "escaping 8-bit characters"
10813 .cindex "&%escape8bit%& expansion item"
10814 If the string contains and characters with the most significant bit set,
10815 they are converted to escape sequences starting with a backslash.
10816 Backslashes and DEL characters are also converted.
10817
10818
10819 .vitem &*${eval:*&<&'string'&>&*}*&&~and&~&*${eval10:*&<&'string'&>&*}*&
10820 .cindex "expansion" "expression evaluation"
10821 .cindex "expansion" "arithmetic expression"
10822 .cindex "&%eval%& expansion item"
10823 These items supports simple arithmetic and bitwise logical operations in
10824 expansion strings. The string (after expansion) must be a conventional
10825 arithmetic expression, but it is limited to basic arithmetic operators, bitwise
10826 logical operators, and parentheses. All operations are carried out using
10827 integer arithmetic. The operator priorities are as follows (the same as in the
10828 C programming language):
10829 .table2 70pt 300pt
10830 .irow &'highest:'& "not (~), negate (-)"
10831 .irow ""   "multiply (*), divide (/), remainder (%)"
10832 .irow ""   "plus (+), minus (-)"
10833 .irow ""   "shift-left (<<), shift-right (>>)"
10834 .irow ""   "and (&&)"
10835 .irow ""   "xor (^)"
10836 .irow &'lowest:'&  "or (|)"
10837 .endtable
10838 Binary operators with the same priority are evaluated from left to right. White
10839 space is permitted before or after operators.
10840
10841 For &%eval%&, numbers may be decimal, octal (starting with &"0"&) or
10842 hexadecimal (starting with &"0x"&). For &%eval10%&, all numbers are taken as
10843 decimal, even if they start with a leading zero; hexadecimal numbers are not
10844 permitted. This can be useful when processing numbers extracted from dates or
10845 times, which often do have leading zeros.
10846
10847 A number may be followed by &"K"&, &"M"& or &"G"& to multiply it by 1024, 1024*1024
10848 or 1024*1024*1024,
10849 respectively. Negative numbers are supported. The result of the computation is
10850 a decimal representation of the answer (without &"K"&, &"M"& or &"G"&). For example:
10851
10852 .display
10853 &`${eval:1+1}            `&  yields 2
10854 &`${eval:1+2*3}          `&  yields 7
10855 &`${eval:(1+2)*3}        `&  yields 9
10856 &`${eval:2+42%5}         `&  yields 4
10857 &`${eval:0xc&amp;5}          `&  yields 4
10858 &`${eval:0xc|5}          `&  yields 13
10859 &`${eval:0xc^5}          `&  yields 9
10860 &`${eval:0xc>>1}         `&  yields 6
10861 &`${eval:0xc<<1}         `&  yields 24
10862 &`${eval:~255&amp;0x1234}    `&  yields 4608
10863 &`${eval:-(~255&amp;0x1234)} `&  yields -4608
10864 .endd
10865
10866 As a more realistic example, in an ACL you might have
10867 .code
10868 deny   message = Too many bad recipients
10869        condition =                    \
10870          ${if and {                   \
10871            {>{$rcpt_count}{10}}       \
10872            {                          \
10873            <                          \
10874              {$recipients_count}      \
10875              {${eval:$rcpt_count/2}}  \
10876            }                          \
10877          }{yes}{no}}
10878 .endd
10879 The condition is true if there have been more than 10 RCPT commands and
10880 fewer than half of them have resulted in a valid recipient.
10881
10882
10883 .vitem &*${expand:*&<&'string'&>&*}*&
10884 .cindex "expansion" "re-expansion of substring"
10885 The &%expand%& operator causes a string to be expanded for a second time. For
10886 example,
10887 .code
10888 ${expand:${lookup{$domain}dbm{/some/file}{$value}}}
10889 .endd
10890 first looks up a string in a file while expanding the operand for &%expand%&,
10891 and then re-expands what it has found.
10892
10893
10894 .vitem &*${from_utf8:*&<&'string'&>&*}*&
10895 .cindex "Unicode"
10896 .cindex "UTF-8" "conversion from"
10897 .cindex "expansion" "UTF-8 conversion"
10898 .cindex "&%from_utf8%& expansion item"
10899 The world is slowly moving towards Unicode, although there are no standards for
10900 email yet. However, other applications (including some databases) are starting
10901 to store data in Unicode, using UTF-8 encoding. This operator converts from a
10902 UTF-8 string to an ISO-8859-1 string. UTF-8 code values greater than 255 are
10903 converted to underscores. The input must be a valid UTF-8 string. If it is not,
10904 the result is an undefined sequence of bytes.
10905
10906 Unicode code points with values less than 256 are compatible with ASCII and
10907 ISO-8859-1 (also known as Latin-1).
10908 For example, character 169 is the copyright symbol in both cases, though the
10909 way it is encoded is different. In UTF-8, more than one byte is needed for
10910 characters with code values greater than 127, whereas ISO-8859-1 is a
10911 single-byte encoding (but thereby limited to 256 characters). This makes
10912 translation from UTF-8 to ISO-8859-1 straightforward.
10913
10914
10915 .vitem &*${hash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
10916 .cindex "hash function" "textual"
10917 .cindex "expansion" "textual hash"
10918 The &%hash%& operator is a simpler interface to the hashing function that can
10919 be used when the two parameters are fixed numbers (as opposed to strings that
10920 change when expanded). The effect is the same as
10921 .code
10922 ${hash{<n>}{<m>}{<string>}}
10923 .endd
10924 See the description of the general &%hash%& item above for details. The
10925 abbreviation &%h%& can be used when &%hash%& is used as an operator.
10926
10927
10928
10929 .vitem &*${hex2b64:*&<&'hexstring'&>&*}*&
10930 .cindex "base64 encoding" "conversion from hex"
10931 .cindex "expansion" "hex to base64"
10932 .cindex "&%hex2b64%& expansion item"
10933 This operator converts a hex string into one that is base64 encoded. This can
10934 be useful for processing the output of the various hashing functions.
10935
10936
10937
10938 .vitem &*${hexquote:*&<&'string'&>&*}*&
10939 .cindex "quoting" "hex-encoded unprintable characters"
10940 .cindex "&%hexquote%& expansion item"
10941 This operator converts non-printable characters in a string into a hex
10942 escape form. Byte values between 33 (!) and 126 (~) inclusive are left
10943 as is, and other byte values are converted to &`\xNN`&, for example, a
10944 byte value 127 is converted to &`\x7f`&.
10945
10946
10947 .vitem &*${ipv6denorm:*&<&'string'&>&*}*&
10948 .cindex "&%ipv6denorm%& expansion item"
10949 .cindex "IP address" normalisation
10950 This expands an IPv6 address to a full eight-element colon-separated set
10951 of hex digits including leading zeroes.
10952 A trailing ipv4-style dotted-decimal set is converted to hex.
10953 Pure IPv4 addresses are converted to IPv4-mapped IPv6.
10954
10955 .vitem &*${ipv6norm:*&<&'string'&>&*}*&
10956 .cindex "&%ipv6norm%& expansion item"
10957 .cindex "IP address" normalisation
10958 .cindex "IP address" "canonical form"
10959 This converts an IPv6 address to canonical form.
10960 Leading zeroes of groups are omitted, and the longest
10961 set of zero-valued groups is replaced with a double colon.
10962 A trailing ipv4-style dotted-decimal set is converted to hex.
10963 Pure IPv4 addresses are converted to IPv4-mapped IPv6.
10964
10965
10966 .vitem &*${lc:*&<&'string'&>&*}*&
10967 .cindex "case forcing in strings"
10968 .cindex "string" "case forcing"
10969 .cindex "lower casing"
10970 .cindex "expansion" "case forcing"
10971 .cindex "&%lc%& expansion item"
10972 This forces the letters in the string into lower-case, for example:
10973 .code
10974 ${lc:$local_part}
10975 .endd
10976 Case is defined per the system C locale.
10977
10978 .vitem &*${length_*&<&'number'&>&*:*&<&'string'&>&*}*&
10979 .cindex "expansion" "string truncation"
10980 .cindex "&%length%& expansion item"
10981 The &%length%& operator is a simpler interface to the &%length%& function that
10982 can be used when the parameter is a fixed number (as opposed to a string that
10983 changes when expanded). The effect is the same as
10984 .code
10985 ${length{<number>}{<string>}}
10986 .endd
10987 See the description of the general &%length%& item above for details. Note that
10988 &%length%& is not the same as &%strlen%&. The abbreviation &%l%& can be used
10989 when &%length%& is used as an operator.
10990 All measurement is done in bytes and is not UTF-8 aware.
10991
10992
10993 .vitem &*${listcount:*&<&'string'&>&*}*&
10994 .cindex "expansion" "list item count"
10995 .cindex "list" "item count"
10996 .cindex "list" "count of items"
10997 .cindex "&%listcount%& expansion item"
10998 The string is interpreted as a list and the number of items is returned.
10999
11000
11001 .vitem &*${listnamed:*&<&'name'&>&*}*&&~and&~&*${listnamed_*&<&'type'&>&*:*&<&'name'&>&*}*&
11002 .cindex "expansion" "named list"
11003 .cindex "&%listnamed%& expansion item"
11004 The name is interpreted as a named list and the content of the list is returned,
11005 expanding any referenced lists, re-quoting as needed for colon-separation.
11006 If the optional type is given it must be one of "a", "d", "h" or "l"
11007 and selects address-, domain-, host- or localpart- lists to search among respectively.
11008 Otherwise all types are searched in an undefined order and the first
11009 matching list is returned.
11010
11011
11012 .vitem &*${local_part:*&<&'string'&>&*}*&
11013 .cindex "expansion" "local part extraction"
11014 .cindex "&%local_part%& expansion item"
11015 The string is interpreted as an RFC 2822 address and the local part is
11016 extracted from it. If the string does not parse successfully, the result is
11017 empty.
11018 The parsing correctly handles SMTPUTF8 Unicode in the string.
11019
11020
11021 .vitem &*${mask:*&<&'IP&~address'&>&*/*&<&'bit&~count'&>&*}*&
11022 .cindex "masked IP address"
11023 .cindex "IP address" "masking"
11024 .cindex "CIDR notation"
11025 .cindex "expansion" "IP address masking"
11026 .cindex "&%mask%& expansion item"
11027 If the form of the string to be operated on is not an IP address followed by a
11028 slash and an integer (that is, a network address in CIDR notation), the
11029 expansion fails. Otherwise, this operator converts the IP address to binary,
11030 masks off the least significant bits according to the bit count, and converts
11031 the result back to text, with mask appended. For example,
11032 .code
11033 ${mask:10.111.131.206/28}
11034 .endd
11035 returns the string &"10.111.131.192/28"&. Since this operation is expected to
11036 be mostly used for looking up masked addresses in files, the result for an IPv6
11037 address uses dots to separate components instead of colons, because colon
11038 terminates a key string in lsearch files. So, for example,
11039 .code
11040 ${mask:3ffe:ffff:836f:0a00:000a:0800:200a:c031/99}
11041 .endd
11042 returns the string
11043 .code
11044 3ffe.ffff.836f.0a00.000a.0800.2000.0000/99
11045 .endd
11046 Letters in IPv6 addresses are always output in lower case.
11047
11048
11049 .vitem &*${md5:*&<&'string'&>&*}*&
11050 .cindex "MD5 hash"
11051 .cindex "expansion" "MD5 hash"
11052 .cindex certificate fingerprint
11053 .cindex "&%md5%& expansion item"
11054 The &%md5%& operator computes the MD5 hash value of the string, and returns it
11055 as a 32-digit hexadecimal number, in which any letters are in lower case.
11056
11057 If the string is a single variable of type certificate,
11058 returns the MD5 hash fingerprint of the certificate.
11059
11060
11061 .vitem &*${nhash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
11062 .cindex "expansion" "numeric hash"
11063 .cindex "hash function" "numeric"
11064 The &%nhash%& operator is a simpler interface to the numeric hashing function
11065 that can be used when the two parameters are fixed numbers (as opposed to
11066 strings that change when expanded). The effect is the same as
11067 .code
11068 ${nhash{<n>}{<m>}{<string>}}
11069 .endd
11070 See the description of the general &%nhash%& item above for details.
11071
11072
11073 .vitem &*${quote:*&<&'string'&>&*}*&
11074 .cindex "quoting" "in string expansions"
11075 .cindex "expansion" "quoting"
11076 .cindex "&%quote%& expansion item"
11077 The &%quote%& operator puts its argument into double quotes if it
11078 is an empty string or
11079 contains anything other than letters, digits, underscores, dots, and hyphens.
11080 Any occurrences of double quotes and backslashes are escaped with a backslash.
11081 Newlines and carriage returns are converted to &`\n`& and &`\r`&,
11082 respectively For example,
11083 .code
11084 ${quote:ab"*"cd}
11085 .endd
11086 becomes
11087 .code
11088 "ab\"*\"cd"
11089 .endd
11090 The place where this is useful is when the argument is a substitution from a
11091 variable or a message header.
11092
11093 .vitem &*${quote_local_part:*&<&'string'&>&*}*&
11094 .cindex "&%quote_local_part%& expansion item"
11095 This operator is like &%quote%&, except that it quotes the string only if
11096 required to do so by the rules of RFC 2822 for quoting local parts. For
11097 example, a plus sign would not cause quoting (but it would for &%quote%&).
11098 If you are creating a new email address from the contents of &$local_part$&
11099 (or any other unknown data), you should always use this operator.
11100
11101 This quoting determination is not SMTPUTF8-aware, thus quoting non-ASCII data
11102 will likely use the quoting form.
11103 Thus &'${quote_local_part:フィル}'& will always become &'"フィル"'&.
11104
11105
11106 .vitem &*${quote_*&<&'lookup-type'&>&*:*&<&'string'&>&*}*&
11107 .cindex "quoting" "lookup-specific"
11108 This operator applies lookup-specific quoting rules to the string. Each
11109 query-style lookup type has its own quoting rules which are described with
11110 the lookups in chapter &<<CHAPfdlookup>>&. For example,
11111 .code
11112 ${quote_ldap:two * two}
11113 .endd
11114 returns
11115 .code
11116 two%20%5C2A%20two
11117 .endd
11118 For single-key lookup types, no quoting is ever necessary and this operator
11119 yields an unchanged string.
11120
11121
11122 .vitem &*${randint:*&<&'n'&>&*}*&
11123 .cindex "random number"
11124 This operator returns a somewhat random number which is less than the
11125 supplied number and is at least 0.  The quality of this randomness depends
11126 on how Exim was built; the values are not suitable for keying material.
11127 If Exim is linked against OpenSSL then RAND_pseudo_bytes() is used.
11128 If Exim is linked against GnuTLS then gnutls_rnd(GNUTLS_RND_NONCE) is used,
11129 for versions of GnuTLS with that function.
11130 Otherwise, the implementation may be arc4random(), random() seeded by
11131 srandomdev() or srandom(), or a custom implementation even weaker than
11132 random().
11133
11134
11135 .vitem &*${reverse_ip:*&<&'ipaddr'&>&*}*&
11136 .cindex "expansion" "IP address"
11137 This operator reverses an IP address; for IPv4 addresses, the result is in
11138 dotted-quad decimal form, while for IPv6 addresses the result is in
11139 dotted-nibble hexadecimal form.  In both cases, this is the "natural" form
11140 for DNS.  For example,
11141 .code
11142 ${reverse_ip:192.0.2.4}
11143 ${reverse_ip:2001:0db8:c42:9:1:abcd:192.0.2.127}
11144 .endd
11145 returns
11146 .code
11147 4.2.0.192
11148 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
11149 .endd
11150
11151
11152 .vitem &*${rfc2047:*&<&'string'&>&*}*&
11153 .cindex "expansion" "RFC 2047"
11154 .cindex "RFC 2047" "expansion operator"
11155 .cindex "&%rfc2047%& expansion item"
11156 This operator encodes text according to the rules of RFC 2047. This is an
11157 encoding that is used in header lines to encode non-ASCII characters. It is
11158 assumed that the input string is in the encoding specified by the
11159 &%headers_charset%& option, which gets its default at build time. If the string
11160 contains only characters in the range 33&--126, and no instances of the
11161 characters
11162 .code
11163 ? = ( ) < > @ , ; : \ " . [ ] _
11164 .endd
11165 it is not modified. Otherwise, the result is the RFC 2047 encoding of the
11166 string, using as many &"encoded words"& as necessary to encode all the
11167 characters.
11168
11169
11170 .vitem &*${rfc2047d:*&<&'string'&>&*}*&
11171 .cindex "expansion" "RFC 2047"
11172 .cindex "RFC 2047" "decoding"
11173 .cindex "&%rfc2047d%& expansion item"
11174 This operator decodes strings that are encoded as per RFC 2047. Binary zero
11175 bytes are replaced by question marks. Characters are converted into the
11176 character set defined by &%headers_charset%&. Overlong RFC 2047 &"words"& are
11177 not recognized unless &%check_rfc2047_length%& is set false.
11178
11179 &*Note*&: If you use &%$header%&_&'xxx'&&*:*& (or &%$h%&_&'xxx'&&*:*&) to
11180 access a header line, RFC 2047 decoding is done automatically. You do not need
11181 to use this operator as well.
11182
11183
11184
11185 .vitem &*${rxquote:*&<&'string'&>&*}*&
11186 .cindex "quoting" "in regular expressions"
11187 .cindex "regular expressions" "quoting"
11188 .cindex "&%rxquote%& expansion item"
11189 The &%rxquote%& operator inserts a backslash before any non-alphanumeric
11190 characters in its argument. This is useful when substituting the values of
11191 variables or headers inside regular expressions.
11192
11193
11194 .vitem &*${sha1:*&<&'string'&>&*}*&
11195 .cindex "SHA-1 hash"
11196 .cindex "expansion" "SHA-1 hashing"
11197 .cindex certificate fingerprint
11198 .cindex "&%sha1%& expansion item"
11199 The &%sha1%& operator computes the SHA-1 hash value of the string, and returns
11200 it as a 40-digit hexadecimal number, in which any letters are in upper case.
11201
11202 If the string is a single variable of type certificate,
11203 returns the SHA-1 hash fingerprint of the certificate.
11204
11205
11206 .vitem &*${sha256:*&<&'string'&>&*}*& &&&
11207        &*${sha2:*&<&'string'&>&*}*& &&&
11208        &*${sha2_<n>:*&<&'string'&>&*}*&
11209 .cindex "SHA-256 hash"
11210 .cindex "SHA-2 hash"
11211 .cindex certificate fingerprint
11212 .cindex "expansion" "SHA-256 hashing"
11213 .cindex "&%sha256%& expansion item"
11214 .cindex "&%sha2%& expansion item"
11215 The &%sha256%& operator computes the SHA-256 hash value of the string
11216 and returns
11217 it as a 64-digit hexadecimal number, in which any letters are in upper case.
11218
11219 If the string is a single variable of type certificate,
11220 returns the SHA-256 hash fingerprint of the certificate.
11221
11222 The operator can also be spelled &%sha2%& and does the same as &%sha256%&
11223 (except for certificates, which are not supported).
11224 Finally, if an underbar
11225 and a number is appended it specifies the output length, selecting a
11226 member of the SHA-2 family of hash functions.
11227 Values of 256, 384 and 512 are accepted, with 256 being the default.
11228
11229
11230 .vitem &*${sha3:*&<&'string'&>&*}*& &&&
11231        &*${sha3_<n>:*&<&'string'&>&*}*&
11232 .cindex "SHA3 hash"
11233 .cindex "expansion" "SHA3 hashing"
11234 .cindex "&%sha3%& expansion item"
11235 The &%sha3%& operator computes the SHA3-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 a number is appended, separated by an underbar, it specifies
11240 the output length.  Values of 224, 256, 384 and 512 are accepted;
11241 with 256 being the default.
11242
11243 The &%sha3%& expansion item is only supported if Exim has been
11244 compiled with GnuTLS 3.5.0 or later,
11245 or OpenSSL 1.1.1 or later.
11246 The macro "_CRYPTO_HASH_SHA3" will be defined if it is supported.
11247
11248
11249 .vitem &*${stat:*&<&'string'&>&*}*&
11250 .cindex "expansion" "statting a file"
11251 .cindex "file" "extracting characteristics"
11252 .cindex "&%stat%& expansion item"
11253 The string, after expansion, must be a file path. A call to the &[stat()]&
11254 function is made for this path. If &[stat()]& fails, an error occurs and the
11255 expansion fails. If it succeeds, the data from the stat replaces the item, as a
11256 series of <&'name'&>=<&'value'&> pairs, where the values are all numerical,
11257 except for the value of &"smode"&. The names are: &"mode"& (giving the mode as
11258 a 4-digit octal number), &"smode"& (giving the mode in symbolic format as a
11259 10-character string, as for the &'ls'& command), &"inode"&, &"device"&,
11260 &"links"&, &"uid"&, &"gid"&, &"size"&, &"atime"&, &"mtime"&, and &"ctime"&. You
11261 can extract individual fields using the &%extract%& expansion item.
11262
11263 The use of the &%stat%& expansion in users' filter files can be locked out by
11264 the system administrator. &*Warning*&: The file size may be incorrect on 32-bit
11265 systems for files larger than 2GB.
11266
11267 .vitem &*${str2b64:*&<&'string'&>&*}*&
11268 .cindex "&%str2b64%& expansion item"
11269 Now deprecated, a synonym for the &%base64%& expansion operator.
11270
11271
11272
11273 .vitem &*${strlen:*&<&'string'&>&*}*&
11274 .cindex "expansion" "string length"
11275 .cindex "string" "length in expansion"
11276 .cindex "&%strlen%& expansion item"
11277 The item is replace by the length of the expanded string, expressed as a
11278 decimal number. &*Note*&: Do not confuse &%strlen%& with &%length%&.
11279 All measurement is done in bytes and is not UTF-8 aware.
11280
11281
11282 .vitem &*${substr_*&<&'start'&>&*_*&<&'length'&>&*:*&<&'string'&>&*}*&
11283 .cindex "&%substr%& expansion item"
11284 .cindex "substring extraction"
11285 .cindex "expansion" "substring expansion"
11286 The &%substr%& operator is a simpler interface to the &%substr%& function that
11287 can be used when the two parameters are fixed numbers (as opposed to strings
11288 that change when expanded). The effect is the same as
11289 .code
11290 ${substr{<start>}{<length>}{<string>}}
11291 .endd
11292 See the description of the general &%substr%& item above for details. The
11293 abbreviation &%s%& can be used when &%substr%& is used as an operator.
11294 All measurement is done in bytes and is not UTF-8 aware.
11295
11296 .vitem &*${time_eval:*&<&'string'&>&*}*&
11297 .cindex "&%time_eval%& expansion item"
11298 .cindex "time interval" "decoding"
11299 This item converts an Exim time interval such as &`2d4h5m`& into a number of
11300 seconds.
11301
11302 .vitem &*${time_interval:*&<&'string'&>&*}*&
11303 .cindex "&%time_interval%& expansion item"
11304 .cindex "time interval" "formatting"
11305 The argument (after sub-expansion) must be a sequence of decimal digits that
11306 represents an interval of time as a number of seconds. It is converted into a
11307 number of larger units and output in Exim's normal time format, for example,
11308 &`1w3d4h2m6s`&.
11309
11310 .vitem &*${uc:*&<&'string'&>&*}*&
11311 .cindex "case forcing in strings"
11312 .cindex "string" "case forcing"
11313 .cindex "upper casing"
11314 .cindex "expansion" "case forcing"
11315 .cindex "&%uc%& expansion item"
11316 This forces the letters in the string into upper-case.
11317 Case is defined per the system C locale.
11318
11319 .vitem &*${utf8clean:*&<&'string'&>&*}*&
11320 .cindex "correction of invalid utf-8 sequences in strings"
11321 .cindex "utf-8" "utf-8 sequences"
11322 .cindex "incorrect utf-8"
11323 .cindex "expansion" "utf-8 forcing"
11324 .cindex "&%utf8clean%& expansion item"
11325 This replaces any invalid utf-8 sequence in the string by the character &`?`&.
11326 In versions of Exim before 4.92, this did not correctly do so for a truncated
11327 final codepoint's encoding, and the character would be silently dropped.
11328 If you must handle detection of this scenario across both sets of Exim behavior,
11329 the complexity will depend upon the task.
11330 For instance, to detect if the first character is multibyte and a 1-byte
11331 extraction can be successfully used as a path component (as is common for
11332 dividing up delivery folders), you might use:
11333 .code
11334 condition = ${if inlist{${utf8clean:${length_1:$local_part}}}{:?}{yes}{no}}
11335 .endd
11336 (which will false-positive if the first character of the local part is a
11337 literal question mark).
11338
11339 .vitem "&*${utf8_domain_to_alabel:*&<&'string'&>&*}*&" &&&
11340        "&*${utf8_domain_from_alabel:*&<&'string'&>&*}*&" &&&
11341        "&*${utf8_localpart_to_alabel:*&<&'string'&>&*}*&" &&&
11342        "&*${utf8_localpart_from_alabel:*&<&'string'&>&*}*&"
11343 .cindex expansion UTF-8
11344 .cindex UTF-8 expansion
11345 .cindex EAI
11346 .cindex internationalisation
11347 .cindex "&%utf8_domain_to_alabel%& expansion item"
11348 .cindex "&%utf8_domain_from_alabel%& expansion item"
11349 .cindex "&%utf8_localpart_to_alabel%& expansion item"
11350 .cindex "&%utf8_localpart_from_alabel%& expansion item"
11351 These convert EAI mail name components between UTF-8 and a-label forms.
11352 For information on internationalisation support see &<<SECTi18nMTA>>&.
11353 .endlist
11354
11355
11356
11357
11358
11359
11360 .section "Expansion conditions" "SECTexpcond"
11361 .scindex IIDexpcond "expansion" "conditions"
11362 The following conditions are available for testing by the &%${if%& construct
11363 while expanding strings:
11364
11365 .vlist
11366 .vitem &*!*&<&'condition'&>
11367 .cindex "expansion" "negating a condition"
11368 .cindex "negation" "in expansion condition"
11369 Preceding any condition with an exclamation mark negates the result of the
11370 condition.
11371
11372 .vitem <&'symbolic&~operator'&>&~&*{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11373 .cindex "numeric comparison"
11374 .cindex "expansion" "numeric comparison"
11375 There are a number of symbolic operators for doing numeric comparisons. They
11376 are:
11377 .display
11378 &`=   `&   equal
11379 &`==  `&   equal
11380 &`>   `&   greater
11381 &`>=  `&   greater or equal
11382 &`<   `&   less
11383 &`<=  `&   less or equal
11384 .endd
11385 For example:
11386 .code
11387 ${if >{$message_size}{10M} ...
11388 .endd
11389 Note that the general negation operator provides for inequality testing. The
11390 two strings must take the form of optionally signed decimal integers,
11391 optionally followed by one of the letters &"K"&, &"M"& or &"G"& (in either upper or
11392 lower case), signifying multiplication by 1024, 1024*1024 or 1024*1024*1024, respectively.
11393 As a special case, the numerical value of an empty string is taken as
11394 zero.
11395
11396 In all cases, a relative comparator OP is testing if <&'string1'&> OP
11397 <&'string2'&>; the above example is checking if &$message_size$& is larger than
11398 10M, not if 10M is larger than &$message_size$&.
11399
11400
11401 .vitem &*acl&~{{*&<&'name'&>&*}{*&<&'arg1'&>&*}&&&
11402         {*&<&'arg2'&>&*}...}*&
11403 .cindex "expansion" "calling an acl"
11404 .cindex "&%acl%&" "expansion condition"
11405 The name and zero to nine argument strings are first expanded separately.  The expanded
11406 arguments are assigned to the variables &$acl_arg1$& to &$acl_arg9$& in order.
11407 Any unused are made empty.  The variable &$acl_narg$& is set to the number of
11408 arguments.  The named ACL (see chapter &<<CHAPACL>>&) is called
11409 and may use the variables; if another acl expansion is used the values
11410 are restored after it returns.  If the ACL sets
11411 a value using a "message =" modifier the variable $value becomes
11412 the result of the expansion, otherwise it is empty.
11413 If the ACL returns accept the condition is true; if deny, false.
11414 If the ACL returns defer the result is a forced-fail.
11415
11416 .vitem &*bool&~{*&<&'string'&>&*}*&
11417 .cindex "expansion" "boolean parsing"
11418 .cindex "&%bool%& expansion condition"
11419 This condition turns a string holding a true or false representation into
11420 a boolean state.  It parses &"true"&, &"false"&, &"yes"& and &"no"&
11421 (case-insensitively); also integer numbers map to true if non-zero,
11422 false if zero.
11423 An empty string is treated as false.
11424 Leading and trailing whitespace is ignored;
11425 thus a string consisting only of whitespace is false.
11426 All other string values will result in expansion failure.
11427
11428 When combined with ACL variables, this expansion condition will let you
11429 make decisions in one place and act on those decisions in another place.
11430 For example:
11431 .code
11432 ${if bool{$acl_m_privileged_sender} ...
11433 .endd
11434
11435
11436 .vitem &*bool_lax&~{*&<&'string'&>&*}*&
11437 .cindex "expansion" "boolean parsing"
11438 .cindex "&%bool_lax%& expansion condition"
11439 Like &%bool%&, this condition turns a string into a boolean state.  But
11440 where &%bool%& accepts a strict set of strings, &%bool_lax%& uses the same
11441 loose definition that the Router &%condition%& option uses.  The empty string
11442 and the values &"false"&, &"no"& and &"0"& map to false, all others map to
11443 true.  Leading and trailing whitespace is ignored.
11444
11445 Note that where &"bool{00}"& is false, &"bool_lax{00}"& is true.
11446
11447 .vitem &*crypteq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11448 .cindex "expansion" "encrypted comparison"
11449 .cindex "encrypted strings, comparing"
11450 .cindex "&%crypteq%& expansion condition"
11451 This condition is included in the Exim binary if it is built to support any
11452 authentication mechanisms (see chapter &<<CHAPSMTPAUTH>>&). Otherwise, it is
11453 necessary to define SUPPORT_CRYPTEQ in &_Local/Makefile_& to get &%crypteq%&
11454 included in the binary.
11455
11456 The &%crypteq%& condition has two arguments. The first is encrypted and
11457 compared against the second, which is already encrypted. The second string may
11458 be in the LDAP form for storing encrypted strings, which starts with the
11459 encryption type in curly brackets, followed by the data. If the second string
11460 does not begin with &"{"& it is assumed to be encrypted with &[crypt()]& or
11461 &[crypt16()]& (see below), since such strings cannot begin with &"{"&.
11462 Typically this will be a field from a password file. An example of an encrypted
11463 string in LDAP form is:
11464 .code
11465 {md5}CY9rzUYh03PK3k6DJie09g==
11466 .endd
11467 If such a string appears directly in an expansion, the curly brackets have to
11468 be quoted, because they are part of the expansion syntax. For example:
11469 .code
11470 ${if crypteq {test}{\{md5\}CY9rzUYh03PK3k6DJie09g==}{yes}{no}}
11471 .endd
11472 The following encryption types (whose names are matched case-independently) are
11473 supported:
11474
11475 .ilist
11476 .cindex "MD5 hash"
11477 .cindex "base64 encoding" "in encrypted password"
11478 &%{md5}%& computes the MD5 digest of the first string, and expresses this as
11479 printable characters to compare with the remainder of the second string. If the
11480 length of the comparison string is 24, Exim assumes that it is base64 encoded
11481 (as in the above example). If the length is 32, Exim assumes that it is a
11482 hexadecimal encoding of the MD5 digest. If the length not 24 or 32, the
11483 comparison fails.
11484
11485 .next
11486 .cindex "SHA-1 hash"
11487 &%{sha1}%& computes the SHA-1 digest of the first string, and expresses this as
11488 printable characters to compare with the remainder of the second string. If the
11489 length of the comparison string is 28, Exim assumes that it is base64 encoded.
11490 If the length is 40, Exim assumes that it is a hexadecimal encoding of the
11491 SHA-1 digest. If the length is not 28 or 40, the comparison fails.
11492
11493 .next
11494 .cindex "&[crypt()]&"
11495 &%{crypt}%& calls the &[crypt()]& function, which traditionally used to use
11496 only the first eight characters of the password. However, in modern operating
11497 systems this is no longer true, and in many cases the entire password is used,
11498 whatever its length.
11499
11500 .next
11501 .cindex "&[crypt16()]&"
11502 &%{crypt16}%& calls the &[crypt16()]& function, which was originally created to
11503 use up to 16 characters of the password in some operating systems. Again, in
11504 modern operating systems, more characters may be used.
11505 .endlist
11506 Exim has its own version of &[crypt16()]&, which is just a double call to
11507 &[crypt()]&. For operating systems that have their own version, setting
11508 HAVE_CRYPT16 in &_Local/Makefile_& when building Exim causes it to use the
11509 operating system version instead of its own. This option is set by default in
11510 the OS-dependent &_Makefile_& for those operating systems that are known to
11511 support &[crypt16()]&.
11512
11513 Some years after Exim's &[crypt16()]& was implemented, a user discovered that
11514 it was not using the same algorithm as some operating systems' versions. It
11515 turns out that as well as &[crypt16()]& there is a function called
11516 &[bigcrypt()]& in some operating systems. This may or may not use the same
11517 algorithm, and both of them may be different to Exim's built-in &[crypt16()]&.
11518
11519 However, since there is now a move away from the traditional &[crypt()]&
11520 functions towards using SHA1 and other algorithms, tidying up this area of
11521 Exim is seen as very low priority.
11522
11523 If you do not put a encryption type (in curly brackets) in a &%crypteq%&
11524 comparison, the default is usually either &`{crypt}`& or &`{crypt16}`&, as
11525 determined by the setting of DEFAULT_CRYPT in &_Local/Makefile_&. The default
11526 default is &`{crypt}`&. Whatever the default, you can always use either
11527 function by specifying it explicitly in curly brackets.
11528
11529 .vitem &*def:*&<&'variable&~name'&>
11530 .cindex "expansion" "checking for empty variable"
11531 .cindex "&%def%& expansion condition"
11532 The &%def%& condition must be followed by the name of one of the expansion
11533 variables defined in section &<<SECTexpvar>>&. The condition is true if the
11534 variable does not contain the empty string. For example:
11535 .code
11536 ${if def:sender_ident {from $sender_ident}}
11537 .endd
11538 Note that the variable name is given without a leading &%$%& character. If the
11539 variable does not exist, the expansion fails.
11540
11541 .vitem "&*def:header_*&<&'header&~name'&>&*:*&&~&~or&~&&&
11542         &~&*def:h_*&<&'header&~name'&>&*:*&"
11543 .cindex "expansion" "checking header line existence"
11544 This condition is true if a message is being processed and the named header
11545 exists in the message. For example,
11546 .code
11547 ${if def:header_reply-to:{$h_reply-to:}{$h_from:}}
11548 .endd
11549 &*Note*&: No &%$%& appears before &%header_%& or &%h_%& in the condition, and
11550 the header name must be terminated by a colon if white space does not follow.
11551
11552 .vitem &*eq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11553        &*eqi&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11554 .cindex "string" "comparison"
11555 .cindex "expansion" "string comparison"
11556 .cindex "&%eq%& expansion condition"
11557 .cindex "&%eqi%& expansion condition"
11558 The two substrings are first expanded. The condition is true if the two
11559 resulting strings are identical. For &%eq%& the comparison includes the case of
11560 letters, whereas for &%eqi%& the comparison is case-independent, where
11561 case is defined per the system C locale.
11562
11563 .vitem &*exists&~{*&<&'file&~name'&>&*}*&
11564 .cindex "expansion" "file existence test"
11565 .cindex "file" "existence test"
11566 .cindex "&%exists%&, expansion condition"
11567 The substring is first expanded and then interpreted as an absolute path. The
11568 condition is true if the named file (or directory) exists. The existence test
11569 is done by calling the &[stat()]& function. The use of the &%exists%& test in
11570 users' filter files may be locked out by the system administrator.
11571
11572 .vitem &*first_delivery*&
11573 .cindex "delivery" "first"
11574 .cindex "first delivery"
11575 .cindex "expansion" "first delivery test"
11576 .cindex "&%first_delivery%& expansion condition"
11577 This condition, which has no data, is true during a message's first delivery
11578 attempt. It is false during any subsequent delivery attempts.
11579
11580
11581 .vitem "&*forall{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&" &&&
11582        "&*forany{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&"
11583 .cindex "list" "iterative conditions"
11584 .cindex "expansion" "&*forall*& condition"
11585 .cindex "expansion" "&*forany*& condition"
11586 .vindex "&$item$&"
11587 These conditions iterate over a list. The first argument is expanded to form
11588 the list. By default, the list separator is a colon, but it can be changed by
11589 the normal method (&<<SECTlistsepchange>>&).
11590 The second argument is interpreted as a condition that is to
11591 be applied to each item in the list in turn. During the interpretation of the
11592 condition, the current list item is placed in a variable called &$item$&.
11593 .ilist
11594 For &*forany*&, interpretation stops if the condition is true for any item, and
11595 the result of the whole condition is true. If the condition is false for all
11596 items in the list, the overall condition is false.
11597 .next
11598 For &*forall*&, interpretation stops if the condition is false for any item,
11599 and the result of the whole condition is false. If the condition is true for
11600 all items in the list, the overall condition is true.
11601 .endlist
11602 Note that negation of &*forany*& means that the condition must be false for all
11603 items for the overall condition to succeed, and negation of &*forall*& means
11604 that the condition must be false for at least one item. In this example, the
11605 list separator is changed to a comma:
11606 .code
11607 ${if forany{<, $recipients}{match{$item}{^user3@}}{yes}{no}}
11608 .endd
11609 The value of &$item$& is saved and restored while &%forany%& or &%forall%& is
11610 being processed, to enable these expansion items to be nested.
11611
11612 To scan a named list, expand it with the &*listnamed*& operator.
11613
11614 .vitem "&*forall_json{*&<&'a JSON array'&>&*}{*&<&'a condition'&>&*}*&" &&&
11615        "&*forany_json{*&<&'a JSON array'&>&*}{*&<&'a condition'&>&*}*&" &&&
11616        "&*forall_jsons{*&<&'a JSON array'&>&*}{*&<&'a condition'&>&*}*&" &&&
11617        "&*forany_jsons{*&<&'a JSON array'&>&*}{*&<&'a condition'&>&*}*&"
11618 .cindex JSON "iterative conditions"
11619 .cindex JSON expansions
11620 .cindex expansion "&*forall_json*& condition"
11621 .cindex expansion "&*forany_json*& condition"
11622 .cindex expansion "&*forall_jsons*& condition"
11623 .cindex expansion "&*forany_jsons*& condition"
11624 As for the above, except that the first argument must, after expansion,
11625 be a JSON array.
11626 The array separator is not changeable.
11627 For the &"jsons"& variants the elements are expected to be JSON strings
11628 and have their quotes removed before the evaluation of the condition.
11629
11630
11631
11632 .vitem &*ge&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11633        &*gei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11634 .cindex "string" "comparison"
11635 .cindex "expansion" "string comparison"
11636 .cindex "&%ge%& expansion condition"
11637 .cindex "&%gei%& expansion condition"
11638 The two substrings are first expanded. The condition is true if the first
11639 string is lexically greater than or equal to the second string. For &%ge%& the
11640 comparison includes the case of letters, whereas for &%gei%& the comparison is
11641 case-independent.
11642 Case and collation order are defined per the system C locale.
11643
11644 .vitem &*gt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11645        &*gti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11646 .cindex "string" "comparison"
11647 .cindex "expansion" "string comparison"
11648 .cindex "&%gt%& expansion condition"
11649 .cindex "&%gti%& expansion condition"
11650 The two substrings are first expanded. The condition is true if the first
11651 string is lexically greater than the second string. For &%gt%& the comparison
11652 includes the case of letters, whereas for &%gti%& the comparison is
11653 case-independent.
11654 Case and collation order are defined per the system C locale.
11655
11656 .vitem &*inlist&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11657        &*inlisti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11658 .cindex "string" "comparison"
11659 .cindex "list" "iterative conditions"
11660 Both strings are expanded; the second string is treated as a list of simple
11661 strings; if the first string is a member of the second, then the condition
11662 is true.
11663 For the case-independent &%inlisti%& condition, case is defined per the system C locale.
11664
11665 These are simpler to use versions of the more powerful &*forany*& condition.
11666 Examples, and the &*forany*& equivalents:
11667 .code
11668 ${if inlist{needle}{foo:needle:bar}}
11669   ${if forany{foo:needle:bar}{eq{$item}{needle}}}
11670 ${if inlisti{Needle}{fOo:NeeDLE:bAr}}
11671   ${if forany{fOo:NeeDLE:bAr}{eqi{$item}{Needle}}}
11672 .endd
11673
11674 .vitem &*isip&~{*&<&'string'&>&*}*&  &&&
11675        &*isip4&~{*&<&'string'&>&*}*& &&&
11676        &*isip6&~{*&<&'string'&>&*}*&
11677 .cindex "IP address" "testing string format"
11678 .cindex "string" "testing for IP address"
11679 .cindex "&%isip%& expansion condition"
11680 .cindex "&%isip4%& expansion condition"
11681 .cindex "&%isip6%& expansion condition"
11682 The substring is first expanded, and then tested to see if it has the form of
11683 an IP address. Both IPv4 and IPv6 addresses are valid for &%isip%&, whereas
11684 &%isip4%& and &%isip6%& test specifically for IPv4 or IPv6 addresses.
11685
11686 For an IPv4 address, the test is for four dot-separated components, each of
11687 which consists of from one to three digits. For an IPv6 address, up to eight
11688 colon-separated components are permitted, each containing from one to four
11689 hexadecimal digits. There may be fewer than eight components if an empty
11690 component (adjacent colons) is present. Only one empty component is permitted.
11691
11692 &*Note*&: The checks used to be just on the form of the address; actual numerical
11693 values were not considered. Thus, for example, 999.999.999.999 passed the IPv4
11694 check.
11695 This is no longer the case.
11696
11697 The main use of these tests is to distinguish between IP addresses and
11698 host names, or between IPv4 and IPv6 addresses. For example, you could use
11699 .code
11700 ${if isip4{$sender_host_address}...
11701 .endd
11702 to test which IP version an incoming SMTP connection is using.
11703
11704 .vitem &*ldapauth&~{*&<&'ldap&~query'&>&*}*&
11705 .cindex "LDAP" "use for authentication"
11706 .cindex "expansion" "LDAP authentication test"
11707 .cindex "&%ldapauth%& expansion condition"
11708 This condition supports user authentication using LDAP. See section
11709 &<<SECTldap>>& for details of how to use LDAP in lookups and the syntax of
11710 queries. For this use, the query must contain a user name and password. The
11711 query itself is not used, and can be empty. The condition is true if the
11712 password is not empty, and the user name and password are accepted by the LDAP
11713 server. An empty password is rejected without calling LDAP because LDAP binds
11714 with an empty password are considered anonymous regardless of the username, and
11715 will succeed in most configurations. See chapter &<<CHAPSMTPAUTH>>& for details
11716 of SMTP authentication, and chapter &<<CHAPplaintext>>& for an example of how
11717 this can be used.
11718
11719
11720 .vitem &*le&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11721        &*lei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11722 .cindex "string" "comparison"
11723 .cindex "expansion" "string comparison"
11724 .cindex "&%le%& expansion condition"
11725 .cindex "&%lei%& expansion condition"
11726 The two substrings are first expanded. The condition is true if the first
11727 string is lexically less than or equal to the second string. For &%le%& the
11728 comparison includes the case of letters, whereas for &%lei%& the comparison is
11729 case-independent.
11730 Case and collation order are defined per the system C locale.
11731
11732 .vitem &*lt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11733        &*lti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11734 .cindex "string" "comparison"
11735 .cindex "expansion" "string comparison"
11736 .cindex "&%lt%& expansion condition"
11737 .cindex "&%lti%& expansion condition"
11738 The two substrings are first expanded. The condition is true if the first
11739 string is lexically less than the second string. For &%lt%& the comparison
11740 includes the case of letters, whereas for &%lti%& the comparison is
11741 case-independent.
11742 Case and collation order are defined per the system C locale.
11743
11744
11745 .vitem &*match&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11746 .cindex "expansion" "regular expression comparison"
11747 .cindex "regular expressions" "match in expanded string"
11748 .cindex "&%match%& expansion condition"
11749 The two substrings are first expanded. The second is then treated as a regular
11750 expression and applied to the first. Because of the pre-expansion, if the
11751 regular expression contains dollar, or backslash characters, they must be
11752 escaped. Care must also be taken if the regular expression contains braces
11753 (curly brackets). A closing brace must be escaped so that it is not taken as a
11754 premature termination of <&'string2'&>. The easiest approach is to use the
11755 &`\N`& feature to disable expansion of the regular expression.
11756 For example,
11757 .code
11758 ${if match {$local_part}{\N^\d{3}\N} ...
11759 .endd
11760 If the whole expansion string is in double quotes, further escaping of
11761 backslashes is also required.
11762
11763 The condition is true if the regular expression match succeeds.
11764 The regular expression is not required to begin with a circumflex
11765 metacharacter, but if there is no circumflex, the expression is not anchored,
11766 and it may match anywhere in the subject, not just at the start. If you want
11767 the pattern to match at the end of the subject, you must include the &`$`&
11768 metacharacter at an appropriate point.
11769 All character handling is done in bytes and is not UTF-8 aware,
11770 but we might change this in a future Exim release.
11771
11772 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%if%& expansion"
11773 At the start of an &%if%& expansion the values of the numeric variable
11774 substitutions &$1$& etc. are remembered. Obeying a &%match%& condition that
11775 succeeds causes them to be reset to the substrings of that condition and they
11776 will have these values during the expansion of the success string. At the end
11777 of the &%if%& expansion, the previous values are restored. After testing a
11778 combination of conditions using &%or%&, the subsequent values of the numeric
11779 variables are those of the condition that succeeded.
11780
11781 .vitem &*match_address&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11782 .cindex "&%match_address%& expansion condition"
11783 See &*match_local_part*&.
11784
11785 .vitem &*match_domain&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11786 .cindex "&%match_domain%& expansion condition"
11787 See &*match_local_part*&.
11788
11789 .vitem &*match_ip&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11790 .cindex "&%match_ip%& expansion condition"
11791 This condition matches an IP address to a list of IP address patterns. It must
11792 be followed by two argument strings. The first (after expansion) must be an IP
11793 address or an empty string. The second (not expanded) is a restricted host
11794 list that can match only an IP address, not a host name. For example:
11795 .code
11796 ${if match_ip{$sender_host_address}{1.2.3.4:5.6.7.8}{...}{...}}
11797 .endd
11798 The specific types of host list item that are permitted in the list are:
11799
11800 .ilist
11801 An IP address, optionally with a CIDR mask.
11802 .next
11803 A single asterisk, which matches any IP address.
11804 .next
11805 An empty item, which matches only if the IP address is empty. This could be
11806 useful for testing for a locally submitted message or one from specific hosts
11807 in a single test such as
11808 . ==== As this is a nested list, any displays it contains must be indented
11809 . ==== as otherwise they are too far to the left. This comment applies to
11810 . ==== the use of xmlto plus fop. There's no problem when formatting with
11811 . ==== sdop, with or without the extra indent.
11812 .code
11813   ${if match_ip{$sender_host_address}{:4.3.2.1:...}{...}{...}}
11814 .endd
11815 where the first item in the list is the empty string.
11816 .next
11817 The item @[] matches any of the local host's interface addresses.
11818 .next
11819 Single-key lookups are assumed to be like &"net-"& style lookups in host lists,
11820 even if &`net-`& is not specified. There is never any attempt to turn the IP
11821 address into a host name. The most common type of linear search for
11822 &*match_ip*& is likely to be &*iplsearch*&, in which the file can contain CIDR
11823 masks. For example:
11824 .code
11825   ${if match_ip{$sender_host_address}{iplsearch;/some/file}...
11826 .endd
11827 It is of course possible to use other kinds of lookup, and in such a case, you
11828 do need to specify the &`net-`& prefix if you want to specify a specific
11829 address mask, for example:
11830 .code
11831   ${if match_ip{$sender_host_address}{net24-dbm;/some/file}...
11832 .endd
11833 However, unless you are combining a &%match_ip%& condition with others, it is
11834 just as easy to use the fact that a lookup is itself a condition, and write:
11835 .code
11836   ${lookup{${mask:$sender_host_address/24}}dbm{/a/file}...
11837 .endd
11838 .endlist ilist
11839
11840 Note that <&'string2'&> is not itself subject to string expansion, unless
11841 Exim was built with the EXPAND_LISTMATCH_RHS option.
11842
11843 Consult section &<<SECThoslispatip>>& for further details of these patterns.
11844
11845 .vitem &*match_local_part&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11846 .cindex "domain list" "in expansion condition"
11847 .cindex "address list" "in expansion condition"
11848 .cindex "local part" "list, in expansion condition"
11849 .cindex "&%match_local_part%& expansion condition"
11850 This condition, together with &%match_address%& and &%match_domain%&, make it
11851 possible to test domain, address, and local part lists within expansions. Each
11852 condition requires two arguments: an item and a list to match. A trivial
11853 example is:
11854 .code
11855 ${if match_domain{a.b.c}{x.y.z:a.b.c:p.q.r}{yes}{no}}
11856 .endd
11857 In each case, the second argument may contain any of the allowable items for a
11858 list of the appropriate type. Also, because the second argument
11859 is a standard form of list, it is possible to refer to a named list.
11860 Thus, you can use conditions like this:
11861 .code
11862 ${if match_domain{$domain}{+local_domains}{...
11863 .endd
11864 .cindex "&`+caseful`&"
11865 For address lists, the matching starts off caselessly, but the &`+caseful`&
11866 item can be used, as in all address lists, to cause subsequent items to
11867 have their local parts matched casefully. Domains are always matched
11868 caselessly.
11869
11870 Note that <&'string2'&> is not itself subject to string expansion, unless
11871 Exim was built with the EXPAND_LISTMATCH_RHS option.
11872
11873 &*Note*&: Host lists are &'not'& supported in this way. This is because
11874 hosts have two identities: a name and an IP address, and it is not clear
11875 how to specify cleanly how such a test would work. However, IP addresses can be
11876 matched using &%match_ip%&.
11877
11878 .vitem &*pam&~{*&<&'string1'&>&*:*&<&'string2'&>&*:...}*&
11879 .cindex "PAM authentication"
11880 .cindex "AUTH" "with PAM"
11881 .cindex "Solaris" "PAM support"
11882 .cindex "expansion" "PAM authentication test"
11883 .cindex "&%pam%& expansion condition"
11884 &'Pluggable Authentication Modules'&
11885 (&url(https://mirrors.edge.kernel.org/pub/linux/libs/pam/)) are a facility that is
11886 available in the latest releases of Solaris and in some GNU/Linux
11887 distributions. The Exim support, which is intended for use in conjunction with
11888 the SMTP AUTH command, is available only if Exim is compiled with
11889 .code
11890 SUPPORT_PAM=yes
11891 .endd
11892 in &_Local/Makefile_&. You probably need to add &%-lpam%& to EXTRALIBS, and
11893 in some releases of GNU/Linux &%-ldl%& is also needed.
11894
11895 The argument string is first expanded, and the result must be a
11896 colon-separated list of strings. Leading and trailing white space is ignored.
11897 The PAM module is initialized with the service name &"exim"& and the user name
11898 taken from the first item in the colon-separated data string (<&'string1'&>).
11899 The remaining items in the data string are passed over in response to requests
11900 from the authentication function. In the simple case there will only be one
11901 request, for a password, so the data consists of just two strings.
11902
11903 There can be problems if any of the strings are permitted to contain colon
11904 characters. In the usual way, these have to be doubled to avoid being taken as
11905 separators. If the data is being inserted from a variable, the &%sg%& expansion
11906 item can be used to double any existing colons. For example, the configuration
11907 of a LOGIN authenticator might contain this setting:
11908 .code
11909 server_condition = ${if pam{$auth1:${sg{$auth2}{:}{::}}}}
11910 .endd
11911 For a PLAIN authenticator you could use:
11912 .code
11913 server_condition = ${if pam{$auth2:${sg{$auth3}{:}{::}}}}
11914 .endd
11915 In some operating systems, PAM authentication can be done only from a process
11916 running as root. Since Exim is running as the Exim user when receiving
11917 messages, this means that PAM cannot be used directly in those systems.
11918 . --- 2018-09-07: the pam_exim modified variant has gone, removed claims re using Exim via that
11919
11920
11921 .vitem &*pwcheck&~{*&<&'string1'&>&*:*&<&'string2'&>&*}*&
11922 .cindex "&'pwcheck'& daemon"
11923 .cindex "Cyrus"
11924 .cindex "expansion" "&'pwcheck'& authentication test"
11925 .cindex "&%pwcheck%& expansion condition"
11926 This condition supports user authentication using the Cyrus &'pwcheck'& daemon.
11927 This is one way of making it possible for passwords to be checked by a process
11928 that is not running as root. &*Note*&: The use of &'pwcheck'& is now
11929 deprecated. Its replacement is &'saslauthd'& (see below).
11930
11931 The pwcheck support is not included in Exim by default. You need to specify
11932 the location of the pwcheck daemon's socket in &_Local/Makefile_& before
11933 building Exim. For example:
11934 .code
11935 CYRUS_PWCHECK_SOCKET=/var/pwcheck/pwcheck
11936 .endd
11937 You do not need to install the full Cyrus software suite in order to use
11938 the pwcheck daemon. You can compile and install just the daemon alone
11939 from the Cyrus SASL library. Ensure that &'exim'& is the only user that has
11940 access to the &_/var/pwcheck_& directory.
11941
11942 The &%pwcheck%& condition takes one argument, which must be the user name and
11943 password, separated by a colon. For example, in a LOGIN authenticator
11944 configuration, you might have this:
11945 .code
11946 server_condition = ${if pwcheck{$auth1:$auth2}}
11947 .endd
11948 Again, for a PLAIN authenticator configuration, this would be:
11949 .code
11950 server_condition = ${if pwcheck{$auth2:$auth3}}
11951 .endd
11952 .vitem &*queue_running*&
11953 .cindex "queue runner" "detecting when delivering from"
11954 .cindex "expansion" "queue runner test"
11955 .cindex "&%queue_running%& expansion condition"
11956 This condition, which has no data, is true during delivery attempts that are
11957 initiated by queue runner processes, and false otherwise.
11958
11959
11960 .vitem &*radius&~{*&<&'authentication&~string'&>&*}*&
11961 .cindex "Radius"
11962 .cindex "expansion" "Radius authentication"
11963 .cindex "&%radius%& expansion condition"
11964 Radius authentication (RFC 2865) is supported in a similar way to PAM. You must
11965 set RADIUS_CONFIG_FILE in &_Local/Makefile_& to specify the location of
11966 the Radius client configuration file in order to build Exim with Radius
11967 support.
11968
11969 With just that one setting, Exim expects to be linked with the &%radiusclient%&
11970 library, using the original API. If you are using release 0.4.0 or later of
11971 this library, you need to set
11972 .code
11973 RADIUS_LIB_TYPE=RADIUSCLIENTNEW
11974 .endd
11975 in &_Local/Makefile_& when building Exim. You can also link Exim with the
11976 &%libradius%& library that comes with FreeBSD. To do this, set
11977 .code
11978 RADIUS_LIB_TYPE=RADLIB
11979 .endd
11980 in &_Local/Makefile_&, in addition to setting RADIUS_CONFIGURE_FILE.
11981 You may also have to supply a suitable setting in EXTRALIBS so that the
11982 Radius library can be found when Exim is linked.
11983
11984 The string specified by RADIUS_CONFIG_FILE is expanded and passed to the
11985 Radius client library, which calls the Radius server. The condition is true if
11986 the authentication is successful. For example:
11987 .code
11988 server_condition = ${if radius{<arguments>}}
11989 .endd
11990
11991
11992 .vitem "&*saslauthd&~{{*&<&'user'&>&*}{*&<&'password'&>&*}&&&
11993         {*&<&'service'&>&*}{*&<&'realm'&>&*}}*&"
11994 .cindex "&'saslauthd'& daemon"
11995 .cindex "Cyrus"
11996 .cindex "expansion" "&'saslauthd'& authentication test"
11997 .cindex "&%saslauthd%& expansion condition"
11998 This condition supports user authentication using the Cyrus &'saslauthd'&
11999 daemon. This replaces the older &'pwcheck'& daemon, which is now deprecated.
12000 Using this daemon is one way of making it possible for passwords to be checked
12001 by a process that is not running as root.
12002
12003 The saslauthd support is not included in Exim by default. You need to specify
12004 the location of the saslauthd daemon's socket in &_Local/Makefile_& before
12005 building Exim. For example:
12006 .code
12007 CYRUS_SASLAUTHD_SOCKET=/var/state/saslauthd/mux
12008 .endd
12009 You do not need to install the full Cyrus software suite in order to use
12010 the saslauthd daemon. You can compile and install just the daemon alone
12011 from the Cyrus SASL library.
12012
12013 Up to four arguments can be supplied to the &%saslauthd%& condition, but only
12014 two are mandatory. For example:
12015 .code
12016 server_condition = ${if saslauthd{{$auth1}{$auth2}}}
12017 .endd
12018 The service and the realm are optional (which is why the arguments are enclosed
12019 in their own set of braces). For details of the meaning of the service and
12020 realm, and how to run the daemon, consult the Cyrus documentation.
12021 .endlist vlist
12022
12023
12024
12025 .section "Combining expansion conditions" "SECID84"
12026 .cindex "expansion" "combining conditions"
12027 Several conditions can be tested at once by combining them using the &%and%&
12028 and &%or%& combination conditions. Note that &%and%& and &%or%& are complete
12029 conditions on their own, and precede their lists of sub-conditions. Each
12030 sub-condition must be enclosed in braces within the overall braces that contain
12031 the list. No repetition of &%if%& is used.
12032
12033
12034 .vlist
12035 .vitem &*or&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
12036 .cindex "&""or""& expansion condition"
12037 .cindex "expansion" "&""or""& of conditions"
12038 The sub-conditions are evaluated from left to right. The condition is true if
12039 any one of the sub-conditions is true.
12040 For example,
12041 .code
12042 ${if or {{eq{$local_part}{spqr}}{eq{$domain}{testing.com}}}...
12043 .endd
12044 When a true sub-condition is found, the following ones are parsed but not
12045 evaluated. If there are several &"match"& sub-conditions the values of the
12046 numeric variables afterwards are taken from the first one that succeeds.
12047
12048 .vitem &*and&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
12049 .cindex "&""and""& expansion condition"
12050 .cindex "expansion" "&""and""& of conditions"
12051 The sub-conditions are evaluated from left to right. The condition is true if
12052 all of the sub-conditions are true. If there are several &"match"&
12053 sub-conditions, the values of the numeric variables afterwards are taken from
12054 the last one. When a false sub-condition is found, the following ones are
12055 parsed but not evaluated.
12056 .endlist
12057 .ecindex IIDexpcond
12058
12059
12060
12061
12062 .section "Expansion variables" "SECTexpvar"
12063 .cindex "expansion" "variables, list of"
12064 This section contains an alphabetical list of all the expansion variables. Some
12065 of them are available only when Exim is compiled with specific options such as
12066 support for TLS or the content scanning extension.
12067
12068 .vlist
12069 .vitem "&$0$&, &$1$&, etc"
12070 .cindex "numerical variables (&$1$& &$2$& etc)"
12071 When a &%match%& expansion condition succeeds, these variables contain the
12072 captured substrings identified by the regular expression during subsequent
12073 processing of the success string of the containing &%if%& expansion item.
12074 In the expansion condition case
12075 they do not retain their values afterwards; in fact, their previous
12076 values are restored at the end of processing an &%if%& item. The numerical
12077 variables may also be set externally by some other matching process which
12078 precedes the expansion of the string. For example, the commands available in
12079 Exim filter files include an &%if%& command with its own regular expression
12080 matching condition.
12081
12082 .vitem "&$acl_arg1$&, &$acl_arg2$&, etc"
12083 Within an acl condition, expansion condition or expansion item
12084 any arguments are copied to these variables,
12085 any unused variables being made empty.
12086
12087 .vitem "&$acl_c...$&"
12088 Values can be placed in these variables by the &%set%& modifier in an ACL. They
12089 can be given any name that starts with &$acl_c$& and is at least six characters
12090 long, but the sixth character must be either a digit or an underscore. For
12091 example: &$acl_c5$&, &$acl_c_mycount$&. The values of the &$acl_c...$&
12092 variables persist throughout the lifetime of an SMTP connection. They can be
12093 used to pass information between ACLs and between different invocations of the
12094 same ACL. When a message is received, the values of these variables are saved
12095 with the message, and can be accessed by filters, routers, and transports
12096 during subsequent delivery.
12097
12098 .vitem "&$acl_m...$&"
12099 These variables are like the &$acl_c...$& variables, except that their values
12100 are reset after a message has been received. Thus, if several messages are
12101 received in one SMTP connection, &$acl_m...$& values are not passed on from one
12102 message to the next, as &$acl_c...$& values are. The &$acl_m...$& variables are
12103 also reset by MAIL, RSET, EHLO, HELO, and after starting a TLS session. When a
12104 message is received, the values of these variables are saved with the message,
12105 and can be accessed by filters, routers, and transports during subsequent
12106 delivery.
12107
12108 .vitem &$acl_narg$&
12109 Within an acl condition, expansion condition or expansion item
12110 this variable has the number of arguments.
12111
12112 .vitem &$acl_verify_message$&
12113 .vindex "&$acl_verify_message$&"
12114 After an address verification has failed, this variable contains the failure
12115 message. It retains its value for use in subsequent modifiers. The message can
12116 be preserved by coding like this:
12117 .code
12118 warn !verify = sender
12119      set acl_m0 = $acl_verify_message
12120 .endd
12121 You can use &$acl_verify_message$& during the expansion of the &%message%& or
12122 &%log_message%& modifiers, to include information about the verification
12123 failure.
12124
12125 .vitem &$address_data$&
12126 .vindex "&$address_data$&"
12127 This variable is set by means of the &%address_data%& option in routers. The
12128 value then remains with the address while it is processed by subsequent routers
12129 and eventually a transport. If the transport is handling multiple addresses,
12130 the value from the first address is used. See chapter &<<CHAProutergeneric>>&
12131 for more details. &*Note*&: The contents of &$address_data$& are visible in
12132 user filter files.
12133
12134 If &$address_data$& is set when the routers are called from an ACL to verify
12135 a recipient address, the final value is still in the variable for subsequent
12136 conditions and modifiers of the ACL statement. If routing the address caused it
12137 to be redirected to just one address, the child address is also routed as part
12138 of the verification, and in this case the final value of &$address_data$& is
12139 from the child's routing.
12140
12141 If &$address_data$& is set when the routers are called from an ACL to verify a
12142 sender address, the final value is also preserved, but this time in
12143 &$sender_address_data$&, to distinguish it from data from a recipient
12144 address.
12145
12146 In both cases (recipient and sender verification), the value does not persist
12147 after the end of the current ACL statement. If you want to preserve
12148 these values for longer, you can save them in ACL variables.
12149
12150 .vitem &$address_file$&
12151 .vindex "&$address_file$&"
12152 When, as a result of aliasing, forwarding, or filtering, a message is directed
12153 to a specific file, this variable holds the name of the file when the transport
12154 is running. At other times, the variable is empty. For example, using the
12155 default configuration, if user &%r2d2%& has a &_.forward_& file containing
12156 .code
12157 /home/r2d2/savemail
12158 .endd
12159 then when the &(address_file)& transport is running, &$address_file$&
12160 contains the text string &`/home/r2d2/savemail`&.
12161 .cindex "Sieve filter" "value of &$address_file$&"
12162 For Sieve filters, the value may be &"inbox"& or a relative folder name. It is
12163 then up to the transport configuration to generate an appropriate absolute path
12164 to the relevant file.
12165
12166 .vitem &$address_pipe$&
12167 .vindex "&$address_pipe$&"
12168 When, as a result of aliasing or forwarding, a message is directed to a pipe,
12169 this variable holds the pipe command when the transport is running.
12170
12171 .vitem "&$auth1$& &-- &$auth3$&"
12172 .vindex "&$auth1$&, &$auth2$&, etc"
12173 These variables are used in SMTP authenticators (see chapters
12174 &<<CHAPplaintext>>&&--&<<CHAPtlsauth>>&). Elsewhere, they are empty.
12175
12176 .vitem &$authenticated_id$&
12177 .cindex "authentication" "id"
12178 .vindex "&$authenticated_id$&"
12179 When a server successfully authenticates a client it may be configured to
12180 preserve some of the authentication information in the variable
12181 &$authenticated_id$& (see chapter &<<CHAPSMTPAUTH>>&). For example, a
12182 user/password authenticator configuration might preserve the user name for use
12183 in the routers. Note that this is not the same information that is saved in
12184 &$sender_host_authenticated$&.
12185
12186 When a message is submitted locally (that is, not over a TCP connection)
12187 the value of &$authenticated_id$& is normally the login name of the calling
12188 process. However, a trusted user can override this by means of the &%-oMai%&
12189 command line option.
12190 This second case also sets up information used by the
12191 &$authresults$& expansion item.
12192
12193 .vitem &$authenticated_fail_id$&
12194 .cindex "authentication" "fail" "id"
12195 .vindex "&$authenticated_fail_id$&"
12196 When an authentication attempt fails, the variable &$authenticated_fail_id$&
12197 will contain the failed authentication id. If more than one authentication
12198 id is attempted, it will contain only the last one. The variable is
12199 available for processing in the ACL's, generally the quit or notquit ACL.
12200 A message to a local recipient could still be accepted without requiring
12201 authentication, which means this variable could also be visible in all of
12202 the ACL's as well.
12203
12204
12205 .vitem &$authenticated_sender$&
12206 .cindex "sender" "authenticated"
12207 .cindex "authentication" "sender"
12208 .cindex "AUTH" "on MAIL command"
12209 .vindex "&$authenticated_sender$&"
12210 When acting as a server, Exim takes note of the AUTH= parameter on an incoming
12211 SMTP MAIL command if it believes the sender is sufficiently trusted, as
12212 described in section &<<SECTauthparamail>>&. Unless the data is the string
12213 &"<>"&, it is set as the authenticated sender of the message, and the value is
12214 available during delivery in the &$authenticated_sender$& variable. If the
12215 sender is not trusted, Exim accepts the syntax of AUTH=, but ignores the data.
12216
12217 .vindex "&$qualify_domain$&"
12218 When a message is submitted locally (that is, not over a TCP connection), the
12219 value of &$authenticated_sender$& is an address constructed from the login
12220 name of the calling process and &$qualify_domain$&, except that a trusted user
12221 can override this by means of the &%-oMas%& command line option.
12222
12223
12224 .vitem &$authentication_failed$&
12225 .cindex "authentication" "failure"
12226 .vindex "&$authentication_failed$&"
12227 This variable is set to &"1"& in an Exim server if a client issues an AUTH
12228 command that does not succeed. Otherwise it is set to &"0"&. This makes it
12229 possible to distinguish between &"did not try to authenticate"&
12230 (&$sender_host_authenticated$& is empty and &$authentication_failed$& is set to
12231 &"0"&) and &"tried to authenticate but failed"& (&$sender_host_authenticated$&
12232 is empty and &$authentication_failed$& is set to &"1"&). Failure includes any
12233 negative response to an AUTH command, including (for example) an attempt to use
12234 an undefined mechanism.
12235
12236 .vitem &$av_failed$&
12237 .cindex "content scanning" "AV scanner failure"
12238 This variable is available when Exim is compiled with the content-scanning
12239 extension. It is set to &"0"& by default, but will be set to &"1"& if any
12240 problem occurs with the virus scanner (specified by &%av_scanner%&) during
12241 the ACL malware condition.
12242
12243 .vitem &$body_linecount$&
12244 .cindex "message body" "line count"
12245 .cindex "body of message" "line count"
12246 .vindex "&$body_linecount$&"
12247 When a message is being received or delivered, this variable contains the
12248 number of lines in the message's body. See also &$message_linecount$&.
12249
12250 .vitem &$body_zerocount$&
12251 .cindex "message body" "binary zero count"
12252 .cindex "body of message" "binary zero count"
12253 .cindex "binary zero" "in message body"
12254 .vindex "&$body_zerocount$&"
12255 When a message is being received or delivered, this variable contains the
12256 number of binary zero bytes (ASCII NULs) in the message's body.
12257
12258 .vitem &$bounce_recipient$&
12259 .vindex "&$bounce_recipient$&"
12260 This is set to the recipient address of a bounce message while Exim is creating
12261 it. It is useful if a customized bounce message text file is in use (see
12262 chapter &<<CHAPemsgcust>>&).
12263
12264 .vitem &$bounce_return_size_limit$&
12265 .vindex "&$bounce_return_size_limit$&"
12266 This contains the value set in the &%bounce_return_size_limit%& option, rounded
12267 up to a multiple of 1000. It is useful when a customized error message text
12268 file is in use (see chapter &<<CHAPemsgcust>>&).
12269
12270 .vitem &$caller_gid$&
12271 .cindex "gid (group id)" "caller"
12272 .vindex "&$caller_gid$&"
12273 The real group id under which the process that called Exim was running. This is
12274 not the same as the group id of the originator of a message (see
12275 &$originator_gid$&). If Exim re-execs itself, this variable in the new
12276 incarnation normally contains the Exim gid.
12277
12278 .vitem &$caller_uid$&
12279 .cindex "uid (user id)" "caller"
12280 .vindex "&$caller_uid$&"
12281 The real user id under which the process that called Exim was running. This is
12282 not the same as the user id of the originator of a message (see
12283 &$originator_uid$&). If Exim re-execs itself, this variable in the new
12284 incarnation normally contains the Exim uid.
12285
12286 .vitem &$callout_address$&
12287 .vindex "&$callout_address$&"
12288 After a callout for verification, spamd or malware daemon service, the
12289 address that was connected to.
12290
12291 .vitem &$compile_number$&
12292 .vindex "&$compile_number$&"
12293 The building process for Exim keeps a count of the number
12294 of times it has been compiled. This serves to distinguish different
12295 compilations of the same version of Exim.
12296
12297 .vitem &$config_dir$&
12298 .vindex "&$config_dir$&"
12299 The directory name of the main configuration file. That is, the content of
12300 &$config_file$& with the last component stripped. The value does not
12301 contain the trailing slash. If &$config_file$& does not contain a slash,
12302 &$config_dir$& is ".".
12303
12304 .vitem &$config_file$&
12305 .vindex "&$config_file$&"
12306 The name of the main configuration file Exim is using.
12307
12308 .vitem &$dmarc_domain_policy$& &&&
12309        &$dmarc_status$& &&&
12310        &$dmarc_status_text$& &&&
12311        &$dmarc_used_domains$&
12312 Results of DMARC verification.
12313 For details see section &<<SECDMARC>>&.
12314
12315 .vitem &$dkim_verify_status$&
12316 Results of DKIM verification.
12317 For details see section &<<SECDKIMVFY>>&.
12318
12319 .vitem &$dkim_cur_signer$& &&&
12320        &$dkim_verify_reason$& &&&
12321        &$dkim_domain$& &&&
12322        &$dkim_identity$& &&&
12323        &$dkim_selector$& &&&
12324        &$dkim_algo$& &&&
12325        &$dkim_canon_body$& &&&
12326        &$dkim_canon_headers$& &&&
12327        &$dkim_copiedheaders$& &&&
12328        &$dkim_bodylength$& &&&
12329        &$dkim_created$& &&&
12330        &$dkim_expires$& &&&
12331        &$dkim_headernames$& &&&
12332        &$dkim_key_testing$& &&&
12333        &$dkim_key_nosubdomains$& &&&
12334        &$dkim_key_srvtype$& &&&
12335        &$dkim_key_granularity$& &&&
12336        &$dkim_key_notes$& &&&
12337        &$dkim_key_length$&
12338 These variables are only available within the DKIM ACL.
12339 For details see section &<<SECDKIMVFY>>&.
12340
12341 .vitem &$dkim_signers$&
12342 .vindex &$dkim_signers$&
12343 When a message has been received this variable contains
12344 a colon-separated list of signer domains and identities for the message.
12345 For details see section &<<SECDKIMVFY>>&.
12346
12347 .vitem &$dnslist_domain$& &&&
12348        &$dnslist_matched$& &&&
12349        &$dnslist_text$& &&&
12350        &$dnslist_value$&
12351 .vindex "&$dnslist_domain$&"
12352 .vindex "&$dnslist_matched$&"
12353 .vindex "&$dnslist_text$&"
12354 .vindex "&$dnslist_value$&"
12355 .cindex "black list (DNS)"
12356 When a DNS (black) list lookup succeeds, these variables are set to contain
12357 the following data from the lookup: the list's domain name, the key that was
12358 looked up, the contents of any associated TXT record, and the value from the
12359 main A record. See section &<<SECID204>>& for more details.
12360
12361 .vitem &$domain$&
12362 .vindex "&$domain$&"
12363 When an address is being routed, or delivered on its own, this variable
12364 contains the domain. Uppercase letters in the domain are converted into lower
12365 case for &$domain$&.
12366
12367 Global address rewriting happens when a message is received, so the value of
12368 &$domain$& during routing and delivery is the value after rewriting. &$domain$&
12369 is set during user filtering, but not during system filtering, because a
12370 message may have many recipients and the system filter is called just once.
12371
12372 When more than one address is being delivered at once (for example, several
12373 RCPT commands in one SMTP delivery), &$domain$& is set only if they all
12374 have the same domain. Transports can be restricted to handling only one domain
12375 at a time if the value of &$domain$& is required at transport time &-- this is
12376 the default for local transports. For further details of the environment in
12377 which local transports are run, see chapter &<<CHAPenvironment>>&.
12378
12379 .oindex "&%delay_warning_condition%&"
12380 At the end of a delivery, if all deferred addresses have the same domain, it is
12381 set in &$domain$& during the expansion of &%delay_warning_condition%&.
12382
12383 The &$domain$& variable is also used in some other circumstances:
12384
12385 .ilist
12386 When an ACL is running for a RCPT command, &$domain$& contains the domain of
12387 the recipient address. The domain of the &'sender'& address is in
12388 &$sender_address_domain$& at both MAIL time and at RCPT time. &$domain$& is not
12389 normally set during the running of the MAIL ACL. However, if the sender address
12390 is verified with a callout during the MAIL ACL, the sender domain is placed in
12391 &$domain$& during the expansions of &%hosts%&, &%interface%&, and &%port%& in
12392 the &(smtp)& transport.
12393
12394 .next
12395 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
12396 &$domain$& contains the domain portion of the address that is being rewritten;
12397 it can be used in the expansion of the replacement address, for example, to
12398 rewrite domains by file lookup.
12399
12400 .next
12401 With one important exception, whenever a domain list is being scanned,
12402 &$domain$& contains the subject domain. &*Exception*&: When a domain list in
12403 a &%sender_domains%& condition in an ACL is being processed, the subject domain
12404 is in &$sender_address_domain$& and not in &$domain$&. It works this way so
12405 that, in a RCPT ACL, the sender domain list can be dependent on the
12406 recipient domain (which is what is in &$domain$& at this time).
12407
12408 .next
12409 .cindex "ETRN" "value of &$domain$&"
12410 .oindex "&%smtp_etrn_command%&"
12411 When the &%smtp_etrn_command%& option is being expanded, &$domain$& contains
12412 the complete argument of the ETRN command (see section &<<SECTETRN>>&).
12413 .endlist
12414
12415 .new
12416 .cindex "tainted data"
12417 If the origin of the data is an incoming message,
12418 the result of expanding this variable is tainted.
12419 When un untainted version is needed, one should be obtained from
12420 looking up the value in a local (therefore trusted) database.
12421 Often &$domain_data$& is usable in this role.
12422 .wen
12423
12424
12425 .vitem &$domain_data$&
12426 .vindex "&$domain_data$&"
12427 When the &%domains%& option on a router matches a domain by
12428 means of a lookup, the data read by the lookup is available during the running
12429 of the router as &$domain_data$&. In addition, if the driver routes the
12430 address to a transport, the value is available in that transport. If the
12431 transport is handling multiple addresses, the value from the first address is
12432 used.
12433
12434 &$domain_data$& is also set when the &%domains%& condition in an ACL matches a
12435 domain by means of a lookup. The data read by the lookup is available during
12436 the rest of the ACL statement. In all other situations, this variable expands
12437 to nothing.
12438
12439 .vitem &$exim_gid$&
12440 .vindex "&$exim_gid$&"
12441 This variable contains the numerical value of the Exim group id.
12442
12443 .vitem &$exim_path$&
12444 .vindex "&$exim_path$&"
12445 This variable contains the path to the Exim binary.
12446
12447 .vitem &$exim_uid$&
12448 .vindex "&$exim_uid$&"
12449 This variable contains the numerical value of the Exim user id.
12450
12451 .vitem &$exim_version$&
12452 .vindex "&$exim_version$&"
12453 This variable contains the version string of the Exim build.
12454 The first character is a major version number, currently 4.
12455 Then after a dot, the next group of digits is a minor version number.
12456 There may be other characters following the minor version.
12457 This value may be overridden by the &%exim_version%& main config option.
12458
12459 .vitem &$header_$&<&'name'&>
12460 This is not strictly an expansion variable. It is expansion syntax for
12461 inserting the message header line with the given name. Note that the name must
12462 be terminated by colon or white space, because it may contain a wide variety of
12463 characters. Note also that braces must &'not'& be used.
12464 See the full description in section &<<SECTexpansionitems>>& above.
12465
12466 .vitem &$headers_added$&
12467 .vindex "&$headers_added$&"
12468 Within an ACL this variable contains the headers added so far by
12469 the ACL modifier add_header (section &<<SECTaddheadacl>>&).
12470 The headers are a newline-separated list.
12471
12472 .vitem &$home$&
12473 .vindex "&$home$&"
12474 When the &%check_local_user%& option is set for a router, the user's home
12475 directory is placed in &$home$& when the check succeeds. In particular, this
12476 means it is set during the running of users' filter files. A router may also
12477 explicitly set a home directory for use by a transport; this can be overridden
12478 by a setting on the transport itself.
12479
12480 When running a filter test via the &%-bf%& option, &$home$& is set to the value
12481 of the environment variable HOME, which is subject to the
12482 &%keep_environment%& and &%add_environment%& main config options.
12483
12484 .vitem &$host$&
12485 .vindex "&$host$&"
12486 If a router assigns an address to a transport (any transport), and passes a
12487 list of hosts with the address, the value of &$host$& when the transport starts
12488 to run is the name of the first host on the list. Note that this applies both
12489 to local and remote transports.
12490
12491 .cindex "transport" "filter"
12492 .cindex "filter" "transport filter"
12493 For the &(smtp)& transport, if there is more than one host, the value of
12494 &$host$& changes as the transport works its way through the list. In
12495 particular, when the &(smtp)& transport is expanding its options for encryption
12496 using TLS, or for specifying a transport filter (see chapter
12497 &<<CHAPtransportgeneric>>&), &$host$& contains the name of the host to which it
12498 is connected.
12499
12500 When used in the client part of an authenticator configuration (see chapter
12501 &<<CHAPSMTPAUTH>>&), &$host$& contains the name of the server to which the
12502 client is connected.
12503
12504
12505 .vitem &$host_address$&
12506 .vindex "&$host_address$&"
12507 This variable is set to the remote host's IP address whenever &$host$& is set
12508 for a remote connection. It is also set to the IP address that is being checked
12509 when the &%ignore_target_hosts%& option is being processed.
12510
12511 .vitem &$host_data$&
12512 .vindex "&$host_data$&"
12513 If a &%hosts%& condition in an ACL is satisfied by means of a lookup, the
12514 result of the lookup is made available in the &$host_data$& variable. This
12515 allows you, for example, to do things like this:
12516 .code
12517 deny  hosts = net-lsearch;/some/file
12518 message = $host_data
12519 .endd
12520 .vitem &$host_lookup_deferred$&
12521 .cindex "host name" "lookup, failure of"
12522 .vindex "&$host_lookup_deferred$&"
12523 This variable normally contains &"0"&, as does &$host_lookup_failed$&. When a
12524 message comes from a remote host and there is an attempt to look up the host's
12525 name from its IP address, and the attempt is not successful, one of these
12526 variables is set to &"1"&.
12527
12528 .ilist
12529 If the lookup receives a definite negative response (for example, a DNS lookup
12530 succeeded, but no records were found), &$host_lookup_failed$& is set to &"1"&.
12531
12532 .next
12533 If there is any kind of problem during the lookup, such that Exim cannot
12534 tell whether or not the host name is defined (for example, a timeout for a DNS
12535 lookup), &$host_lookup_deferred$& is set to &"1"&.
12536 .endlist ilist
12537
12538 Looking up a host's name from its IP address consists of more than just a
12539 single reverse lookup. Exim checks that a forward lookup of at least one of the
12540 names it receives from a reverse lookup yields the original IP address. If this
12541 is not the case, Exim does not accept the looked up name(s), and
12542 &$host_lookup_failed$& is set to &"1"&. Thus, being able to find a name from an
12543 IP address (for example, the existence of a PTR record in the DNS) is not
12544 sufficient on its own for the success of a host name lookup. If the reverse
12545 lookup succeeds, but there is a lookup problem such as a timeout when checking
12546 the result, the name is not accepted, and &$host_lookup_deferred$& is set to
12547 &"1"&. See also &$sender_host_name$&.
12548
12549 .cindex authentication "expansion item"
12550 Performing these checks sets up information used by the
12551 &%authresults%& expansion item.
12552
12553
12554 .vitem &$host_lookup_failed$&
12555 .vindex "&$host_lookup_failed$&"
12556 See &$host_lookup_deferred$&.
12557
12558 .vitem &$host_port$&
12559 .vindex "&$host_port$&"
12560 This variable is set to the remote host's TCP port whenever &$host$& is set
12561 for an outbound connection.
12562
12563 .vitem &$initial_cwd$&
12564 .vindex "&$initial_cwd$&
12565 This variable contains the full path name of the initial working
12566 directory of the current Exim process. This may differ from the current
12567 working directory, as Exim changes this to "/" during early startup, and
12568 to &$spool_directory$& later.
12569
12570 .vitem &$inode$&
12571 .vindex "&$inode$&"
12572 The only time this variable is set is while expanding the &%directory_file%&
12573 option in the &(appendfile)& transport. The variable contains the inode number
12574 of the temporary file which is about to be renamed. It can be used to construct
12575 a unique name for the file.
12576
12577 .vitem &$interface_address$&
12578 .vindex "&$interface_address$&"
12579 This is an obsolete name for &$received_ip_address$&.
12580
12581 .vitem &$interface_port$&
12582 .vindex "&$interface_port$&"
12583 This is an obsolete name for &$received_port$&.
12584
12585 .vitem &$item$&
12586 .vindex "&$item$&"
12587 This variable is used during the expansion of &*forall*& and &*forany*&
12588 conditions (see section &<<SECTexpcond>>&), and &*filter*&, &*map*&, and
12589 &*reduce*& items (see section &<<SECTexpcond>>&). In other circumstances, it is
12590 empty.
12591
12592 .vitem &$ldap_dn$&
12593 .vindex "&$ldap_dn$&"
12594 This variable, which is available only when Exim is compiled with LDAP support,
12595 contains the DN from the last entry in the most recently successful LDAP
12596 lookup.
12597
12598 .vitem &$load_average$&
12599 .vindex "&$load_average$&"
12600 This variable contains the system load average, multiplied by 1000 so that it
12601 is an integer. For example, if the load average is 0.21, the value of the
12602 variable is 210. The value is recomputed every time the variable is referenced.
12603
12604 .vitem &$local_part$&
12605 .vindex "&$local_part$&"
12606 When an address is being routed, or delivered on its own, this
12607 variable contains the local part. When a number of addresses are being
12608 delivered together (for example, multiple RCPT commands in an SMTP
12609 session), &$local_part$& is not set.
12610
12611 Global address rewriting happens when a message is received, so the value of
12612 &$local_part$& during routing and delivery is the value after rewriting.
12613 &$local_part$& is set during user filtering, but not during system filtering,
12614 because a message may have many recipients and the system filter is called just
12615 once.
12616
12617 .new
12618 .cindex "tainted data"
12619 If the origin of the data is an incoming message,
12620 the result of expanding this variable is tainted.
12621
12622 &*Warning*&: the content of this variable is usually provided by a potential
12623 attacker.
12624 Consider carefully the implications of using it unvalidated as a name
12625 for file access.
12626 This presents issues for users' &_.forward_& and filter files.
12627 For traditional full user accounts, use &%check_local_users%& and the
12628 &$local_part_data$& variable rather than this one.
12629 For virtual users, store a suitable pathname component in the database
12630 which is used for account name validation, and use that retrieved value
12631 rather than this variable.
12632 Often &$local_part_data$& is usable in this role.
12633 If needed, use a router &%address_data%& or &%set%& option for
12634 the retrieved data.
12635 .wen
12636
12637 When a message is being delivered to a file, pipe, or autoreply transport as a
12638 result of aliasing or forwarding, &$local_part$& is set to the local part of
12639 the parent address, not to the filename or command (see &$address_file$& and
12640 &$address_pipe$&).
12641
12642 When an ACL is running for a RCPT command, &$local_part$& contains the
12643 local part of the recipient address.
12644
12645 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
12646 &$local_part$& contains the local part of the address that is being rewritten;
12647 it can be used in the expansion of the replacement address, for example.
12648
12649 In all cases, all quoting is removed from the local part. For example, for both
12650 the addresses
12651 .code
12652 "abc:xyz"@test.example
12653 abc\:xyz@test.example
12654 .endd
12655 the value of &$local_part$& is
12656 .code
12657 abc:xyz
12658 .endd
12659 If you use &$local_part$& to create another address, you should always wrap it
12660 inside a quoting operator. For example, in a &(redirect)& router you could
12661 have:
12662 .code
12663 data = ${quote_local_part:$local_part}@new.domain.example
12664 .endd
12665 &*Note*&: The value of &$local_part$& is normally lower cased. If you want
12666 to process local parts in a case-dependent manner in a router, you can set the
12667 &%caseful_local_part%& option (see chapter &<<CHAProutergeneric>>&).
12668
12669 .vitem &$local_part_data$&
12670 .vindex "&$local_part_data$&"
12671 When the &%local_parts%& option on a router matches a local part by means of a
12672 lookup, the data read by the lookup is available during the running of the
12673 router as &$local_part_data$&. In addition, if the driver routes the address
12674 to a transport, the value is available in that transport. If the transport is
12675 handling multiple addresses, the value from the first address is used.
12676
12677 .new
12678 The &%check_local_user%& router option also sets this variable.
12679 .wen
12680
12681 &$local_part_data$& is also set when the &%local_parts%& condition in an ACL
12682 matches a local part by means of a lookup. The data read by the lookup is
12683 available during the rest of the ACL statement. In all other situations, this
12684 variable expands to nothing.
12685
12686 .vindex &$local_part_prefix$& &&&
12687         &$local_part_prefix_v$& &&&
12688         &$local_part_suffix$& &&&
12689         &$local_part_suffix_v$&
12690 .cindex affix variables
12691 If a local part prefix or suffix has been recognized, it is not included in the
12692 value of &$local_part$& during routing and subsequent delivery. The values of
12693 any prefix or suffix are in &$local_part_prefix$& and
12694 &$local_part_suffix$&, respectively.
12695 .new
12696 .cindex "tainted data"
12697 If the specification did not include a wildcard then
12698 the affix variable value is not tainted.
12699
12700 If the affix specification included a wildcard then the portion of
12701 the affix matched by the wildcard is in
12702 &$local_part_prefix_v$& or &$local_part_suffix_v$& as appropriate,
12703 and both the whole and varying values are tainted.
12704 .wen
12705
12706 .vitem &$local_scan_data$&
12707 .vindex "&$local_scan_data$&"
12708 This variable contains the text returned by the &[local_scan()]& function when
12709 a message is received. See chapter &<<CHAPlocalscan>>& for more details.
12710
12711 .vitem &$local_user_gid$&
12712 .vindex "&$local_user_gid$&"
12713 See &$local_user_uid$&.
12714
12715 .vitem &$local_user_uid$&
12716 .vindex "&$local_user_uid$&"
12717 This variable and &$local_user_gid$& are set to the uid and gid after the
12718 &%check_local_user%& router precondition succeeds. This means that their values
12719 are available for the remaining preconditions (&%senders%&, &%require_files%&,
12720 and &%condition%&), for the &%address_data%& expansion, and for any
12721 router-specific expansions. At all other times, the values in these variables
12722 are &`(uid_t)(-1)`& and &`(gid_t)(-1)`&, respectively.
12723
12724 .vitem &$localhost_number$&
12725 .vindex "&$localhost_number$&"
12726 This contains the expanded value of the
12727 &%localhost_number%& option. The expansion happens after the main options have
12728 been read.
12729
12730 .vitem &$log_inodes$&
12731 .vindex "&$log_inodes$&"
12732 The number of free inodes in the disk partition where Exim's
12733 log files are being written. The value is recalculated whenever the variable is
12734 referenced. If the relevant file system does not have the concept of inodes,
12735 the value of is -1. See also the &%check_log_inodes%& option.
12736
12737 .vitem &$log_space$&
12738 .vindex "&$log_space$&"
12739 The amount of free space (as a number of kilobytes) in the disk
12740 partition where Exim's log files are being written. The value is recalculated
12741 whenever the variable is referenced. If the operating system does not have the
12742 ability to find the amount of free space (only true for experimental systems),
12743 the space value is -1. See also the &%check_log_space%& option.
12744
12745
12746 .vitem &$lookup_dnssec_authenticated$&
12747 .vindex "&$lookup_dnssec_authenticated$&"
12748 This variable is set after a DNS lookup done by
12749 a dnsdb lookup expansion, dnslookup router or smtp transport.
12750 .cindex "DNS" "DNSSEC"
12751 It will be empty if &(DNSSEC)& was not requested,
12752 &"no"& if the result was not labelled as authenticated data
12753 and &"yes"& if it was.
12754 Results that are labelled as authoritative answer that match
12755 the &%dns_trust_aa%& configuration variable count also
12756 as authenticated data.
12757
12758 .vitem &$mailstore_basename$&
12759 .vindex "&$mailstore_basename$&"
12760 This variable is set only when doing deliveries in &"mailstore"& format in the
12761 &(appendfile)& transport. During the expansion of the &%mailstore_prefix%&,
12762 &%mailstore_suffix%&, &%message_prefix%&, and &%message_suffix%& options, it
12763 contains the basename of the files that are being written, that is, the name
12764 without the &".tmp"&, &".env"&, or &".msg"& suffix. At all other times, this
12765 variable is empty.
12766
12767 .vitem &$malware_name$&
12768 .vindex "&$malware_name$&"
12769 This variable is available when Exim is compiled with the
12770 content-scanning extension. It is set to the name of the virus that was found
12771 when the ACL &%malware%& condition is true (see section &<<SECTscanvirus>>&).
12772
12773 .vitem &$max_received_linelength$&
12774 .vindex "&$max_received_linelength$&"
12775 .cindex "maximum" "line length"
12776 .cindex "line length" "maximum"
12777 This variable contains the number of bytes in the longest line that was
12778 received as part of the message, not counting the line termination
12779 character(s).
12780 It is not valid if the &%spool_files_wireformat%& option is used.
12781
12782 .vitem &$message_age$&
12783 .cindex "message" "age of"
12784 .vindex "&$message_age$&"
12785 This variable is set at the start of a delivery attempt to contain the number
12786 of seconds since the message was received. It does not change during a single
12787 delivery attempt.
12788
12789 .vitem &$message_body$&
12790 .cindex "body of message" "expansion variable"
12791 .cindex "message body" "in expansion"
12792 .cindex "binary zero" "in message body"
12793 .vindex "&$message_body$&"
12794 .oindex "&%message_body_visible%&"
12795 This variable contains the initial portion of a message's body while it is
12796 being delivered, and is intended mainly for use in filter files. The maximum
12797 number of characters of the body that are put into the variable is set by the
12798 &%message_body_visible%& configuration option; the default is 500.
12799
12800 .oindex "&%message_body_newlines%&"
12801 By default, newlines are converted into spaces in &$message_body$&, to make it
12802 easier to search for phrases that might be split over a line break. However,
12803 this can be disabled by setting &%message_body_newlines%& to be true. Binary
12804 zeros are always converted into spaces.
12805
12806 .vitem &$message_body_end$&
12807 .cindex "body of message" "expansion variable"
12808 .cindex "message body" "in expansion"
12809 .vindex "&$message_body_end$&"
12810 This variable contains the final portion of a message's
12811 body while it is being delivered. The format and maximum size are as for
12812 &$message_body$&.
12813
12814 .vitem &$message_body_size$&
12815 .cindex "body of message" "size"
12816 .cindex "message body" "size"
12817 .vindex "&$message_body_size$&"
12818 When a message is being delivered, this variable contains the size of the body
12819 in bytes. The count starts from the character after the blank line that
12820 separates the body from the header. Newlines are included in the count. See
12821 also &$message_size$&, &$body_linecount$&, and &$body_zerocount$&.
12822
12823 If the spool file is wireformat
12824 (see the &%spool_files_wireformat%& main option)
12825 the CRLF line-terminators are included in the count.
12826
12827 .vitem &$message_exim_id$&
12828 .vindex "&$message_exim_id$&"
12829 When a message is being received or delivered, this variable contains the
12830 unique message id that is generated and used by Exim to identify the message.
12831 An id is not created for a message until after its header has been successfully
12832 received. &*Note*&: This is &'not'& the contents of the &'Message-ID:'& header
12833 line; it is the local id that Exim assigns to the message, for example:
12834 &`1BXTIK-0001yO-VA`&.
12835
12836 .vitem &$message_headers$&
12837 .vindex &$message_headers$&
12838 This variable contains a concatenation of all the header lines when a message
12839 is being processed, except for lines added by routers or transports. The header
12840 lines are separated by newline characters. Their contents are decoded in the
12841 same way as a header line that is inserted by &%bheader%&.
12842
12843 .vitem &$message_headers_raw$&
12844 .vindex &$message_headers_raw$&
12845 This variable is like &$message_headers$& except that no processing of the
12846 contents of header lines is done.
12847
12848 .vitem &$message_id$&
12849 This is an old name for &$message_exim_id$&. It is now deprecated.
12850
12851 .vitem &$message_linecount$&
12852 .vindex "&$message_linecount$&"
12853 This variable contains the total number of lines in the header and body of the
12854 message. Compare &$body_linecount$&, which is the count for the body only.
12855 During the DATA and content-scanning ACLs, &$message_linecount$& contains the
12856 number of lines received. Before delivery happens (that is, before filters,
12857 routers, and transports run) the count is increased to include the
12858 &'Received:'& header line that Exim standardly adds, and also any other header
12859 lines that are added by ACLs. The blank line that separates the message header
12860 from the body is not counted.
12861
12862 As with the special case of &$message_size$&, during the expansion of the
12863 appendfile transport's maildir_tag option in maildir format, the value of
12864 &$message_linecount$& is the precise size of the number of newlines in the
12865 file that has been written (minus one for the blank line between the
12866 header and the body).
12867
12868 Here is an example of the use of this variable in a DATA ACL:
12869 .code
12870 deny message   = Too many lines in message header
12871      condition = \
12872       ${if <{250}{${eval:$message_linecount - $body_linecount}}}
12873 .endd
12874 In the MAIL and RCPT ACLs, the value is zero because at that stage the
12875 message has not yet been received.
12876
12877 This variable is not valid if the &%spool_files_wireformat%& option is used.
12878
12879 .vitem &$message_size$&
12880 .cindex "size" "of message"
12881 .cindex "message" "size"
12882 .vindex "&$message_size$&"
12883 When a message is being processed, this variable contains its size in bytes. In
12884 most cases, the size includes those headers that were received with the
12885 message, but not those (such as &'Envelope-to:'&) that are added to individual
12886 deliveries as they are written. However, there is one special case: during the
12887 expansion of the &%maildir_tag%& option in the &(appendfile)& transport while
12888 doing a delivery in maildir format, the value of &$message_size$& is the
12889 precise size of the file that has been written. See also
12890 &$message_body_size$&, &$body_linecount$&, and &$body_zerocount$&.
12891
12892 .cindex "RCPT" "value of &$message_size$&"
12893 While running a per message ACL (mail/rcpt/predata), &$message_size$&
12894 contains the size supplied on the MAIL command, or -1 if no size was given. The
12895 value may not, of course, be truthful.
12896
12897 .vitem &$mime_$&&'xxx'&
12898 A number of variables whose names start with &$mime$& are
12899 available when Exim is compiled with the content-scanning extension. For
12900 details, see section &<<SECTscanmimepart>>&.
12901
12902 .vitem "&$n0$& &-- &$n9$&"
12903 These variables are counters that can be incremented by means
12904 of the &%add%& command in filter files.
12905
12906 .vitem &$original_domain$&
12907 .vindex "&$domain$&"
12908 .vindex "&$original_domain$&"
12909 When a top-level address is being processed for delivery, this contains the
12910 same value as &$domain$&. However, if a &"child"& address (for example,
12911 generated by an alias, forward, or filter file) is being processed, this
12912 variable contains the domain of the original address (lower cased). This
12913 differs from &$parent_domain$& only when there is more than one level of
12914 aliasing or forwarding. When more than one address is being delivered in a
12915 single transport run, &$original_domain$& is not set.
12916
12917 If a new address is created by means of a &%deliver%& command in a system
12918 filter, it is set up with an artificial &"parent"& address. This has the local
12919 part &'system-filter'& and the default qualify domain.
12920
12921 .vitem &$original_local_part$&
12922 .vindex "&$local_part$&"
12923 .vindex "&$original_local_part$&"
12924 When a top-level address is being processed for delivery, this contains the
12925 same value as &$local_part$&, unless a prefix or suffix was removed from the
12926 local part, because &$original_local_part$& always contains the full local
12927 part. When a &"child"& address (for example, generated by an alias, forward, or
12928 filter file) is being processed, this variable contains the full local part of
12929 the original address.
12930
12931 If the router that did the redirection processed the local part
12932 case-insensitively, the value in &$original_local_part$& is in lower case.
12933 This variable differs from &$parent_local_part$& only when there is more than
12934 one level of aliasing or forwarding. When more than one address is being
12935 delivered in a single transport run, &$original_local_part$& 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 &$originator_gid$&
12942 .cindex "gid (group id)" "of originating user"
12943 .cindex "sender" "gid"
12944 .vindex "&$caller_gid$&"
12945 .vindex "&$originator_gid$&"
12946 This variable contains the value of &$caller_gid$& that was set when the
12947 message was received. For messages received via the command line, this is the
12948 gid of the sending user. For messages received by SMTP over TCP/IP, this is
12949 normally the gid of the Exim user.
12950
12951 .vitem &$originator_uid$&
12952 .cindex "uid (user id)" "of originating user"
12953 .cindex "sender" "uid"
12954 .vindex "&$caller_uid$&"
12955 .vindex "&$originator_uid$&"
12956 The value of &$caller_uid$& that was set when the message was received. For
12957 messages received via the command line, this is the uid of the sending user.
12958 For messages received by SMTP over TCP/IP, this is normally the uid of the Exim
12959 user.
12960
12961 .vitem &$parent_domain$&
12962 .vindex "&$parent_domain$&"
12963 This variable is similar to &$original_domain$& (see
12964 above), except that it refers to the immediately preceding parent address.
12965
12966 .vitem &$parent_local_part$&
12967 .vindex "&$parent_local_part$&"
12968 This variable is similar to &$original_local_part$&
12969 (see above), except that it refers to the immediately preceding parent address.
12970
12971 .vitem &$pid$&
12972 .cindex "pid (process id)" "of current process"
12973 .vindex "&$pid$&"
12974 This variable contains the current process id.
12975
12976 .vitem &$pipe_addresses$&
12977 .cindex "filter" "transport filter"
12978 .cindex "transport" "filter"
12979 .vindex "&$pipe_addresses$&"
12980 This is not an expansion variable, but is mentioned here because the string
12981 &`$pipe_addresses`& is handled specially in the command specification for the
12982 &(pipe)& transport (chapter &<<CHAPpipetransport>>&) and in transport filters
12983 (described under &%transport_filter%& in chapter &<<CHAPtransportgeneric>>&).
12984 It cannot be used in general expansion strings, and provokes an &"unknown
12985 variable"& error if encountered.
12986
12987 .vitem &$primary_hostname$&
12988 .vindex "&$primary_hostname$&"
12989 This variable contains the value set by &%primary_hostname%& in the
12990 configuration file, or read by the &[uname()]& function. If &[uname()]& returns
12991 a single-component name, Exim calls &[gethostbyname()]& (or
12992 &[getipnodebyname()]& where available) in an attempt to acquire a fully
12993 qualified host name. See also &$smtp_active_hostname$&.
12994
12995
12996 .vitem &$proxy_external_address$& &&&
12997        &$proxy_external_port$& &&&
12998        &$proxy_local_address$& &&&
12999        &$proxy_local_port$& &&&
13000        &$proxy_session$&
13001 These variables are only available when built with Proxy Protocol
13002 or SOCKS5 support.
13003 For details see chapter &<<SECTproxyInbound>>&.
13004
13005 .vitem &$prdr_requested$&
13006 .cindex "PRDR" "variable for"
13007 This variable is set to &"yes"& if PRDR was requested by the client for the
13008 current message, otherwise &"no"&.
13009
13010 .vitem &$prvscheck_address$&
13011 This variable is used in conjunction with the &%prvscheck%& expansion item,
13012 which is described in sections &<<SECTexpansionitems>>& and
13013 &<<SECTverifyPRVS>>&.
13014
13015 .vitem &$prvscheck_keynum$&
13016 This variable is used in conjunction with the &%prvscheck%& expansion item,
13017 which is described in sections &<<SECTexpansionitems>>& and
13018 &<<SECTverifyPRVS>>&.
13019
13020 .vitem &$prvscheck_result$&
13021 This variable is used in conjunction with the &%prvscheck%& expansion item,
13022 which is described in sections &<<SECTexpansionitems>>& and
13023 &<<SECTverifyPRVS>>&.
13024
13025 .vitem &$qualify_domain$&
13026 .vindex "&$qualify_domain$&"
13027 The value set for the &%qualify_domain%& option in the configuration file.
13028
13029 .vitem &$qualify_recipient$&
13030 .vindex "&$qualify_recipient$&"
13031 The value set for the &%qualify_recipient%& option in the configuration file,
13032 or if not set, the value of &$qualify_domain$&.
13033
13034 .vitem &$queue_name$&
13035 .vindex &$queue_name$&
13036 .cindex "named queues" variable
13037 .cindex queues named
13038 The name of the spool queue in use; empty for the default queue.
13039
13040 .vitem &$queue_size$&
13041 .vindex "&$queue_size$&"
13042 .cindex "queue" "size of"
13043 .cindex "spool" "number of messages"
13044 This variable contains the number of messages queued.
13045 It is evaluated on demand, but no more often than once every minute.
13046
13047 .vitem &$r_...$&
13048 .vindex &$r_...$&
13049 .cindex router variables
13050 Values can be placed in these variables by the &%set%& option of a router.
13051 They can be given any name that starts with &$r_$&.
13052 The values persist for the address being handled through subsequent routers
13053 and the eventual transport.
13054
13055 .vitem &$rcpt_count$&
13056 .vindex "&$rcpt_count$&"
13057 When a message is being received by SMTP, this variable contains the number of
13058 RCPT commands received for the current message. If this variable is used in a
13059 RCPT ACL, its value includes the current command.
13060
13061 .vitem &$rcpt_defer_count$&
13062 .vindex "&$rcpt_defer_count$&"
13063 .cindex "4&'xx'& responses" "count of"
13064 When a message is being received by SMTP, this variable contains the number of
13065 RCPT commands in the current message that have previously been rejected with a
13066 temporary (4&'xx'&) response.
13067
13068 .vitem &$rcpt_fail_count$&
13069 .vindex "&$rcpt_fail_count$&"
13070 When a message is being received by SMTP, this variable contains the number of
13071 RCPT commands in the current message that have previously been rejected with a
13072 permanent (5&'xx'&) response.
13073
13074 .vitem &$received_count$&
13075 .vindex "&$received_count$&"
13076 This variable contains the number of &'Received:'& header lines in the message,
13077 including the one added by Exim (so its value is always greater than zero). It
13078 is available in the DATA ACL, the non-SMTP ACL, and while routing and
13079 delivering.
13080
13081 .vitem &$received_for$&
13082 .vindex "&$received_for$&"
13083 If there is only a single recipient address in an incoming message, this
13084 variable contains that address when the &'Received:'& header line is being
13085 built. The value is copied after recipient rewriting has happened, but before
13086 the &[local_scan()]& function is run.
13087
13088 .vitem &$received_ip_address$&
13089 .vindex "&$received_ip_address$&"
13090 As soon as an Exim server starts processing an incoming TCP/IP connection, this
13091 variable is set to the address of the local IP interface, and &$received_port$&
13092 is set to the local port number. (The remote IP address and port are in
13093 &$sender_host_address$& and &$sender_host_port$&.) When testing with &%-bh%&,
13094 the port value is -1 unless it has been set using the &%-oMi%& command line
13095 option.
13096
13097 As well as being useful in ACLs (including the &"connect"& ACL), these variable
13098 could be used, for example, to make the filename for a TLS certificate depend
13099 on which interface and/or port is being used for the incoming connection. The
13100 values of &$received_ip_address$& and &$received_port$& are saved with any
13101 messages that are received, thus making these variables available at delivery
13102 time.
13103 For outbound connections see &$sending_ip_address$&.
13104
13105 .vitem &$received_port$&
13106 .vindex "&$received_port$&"
13107 See &$received_ip_address$&.
13108
13109 .vitem &$received_protocol$&
13110 .vindex "&$received_protocol$&"
13111 When a message is being processed, this variable contains the name of the
13112 protocol by which it was received. Most of the names used by Exim are defined
13113 by RFCs 821, 2821, and 3848. They start with &"smtp"& (the client used HELO) or
13114 &"esmtp"& (the client used EHLO). This can be followed by &"s"& for secure
13115 (encrypted) and/or &"a"& for authenticated. Thus, for example, if the protocol
13116 is set to &"esmtpsa"&, the message was received over an encrypted SMTP
13117 connection and the client was successfully authenticated.
13118
13119 Exim uses the protocol name &"smtps"& for the case when encryption is
13120 automatically set up on connection without the use of STARTTLS (see
13121 &%tls_on_connect_ports%&), and the client uses HELO to initiate the
13122 encrypted SMTP session. The name &"smtps"& is also used for the rare situation
13123 where the client initially uses EHLO, sets up an encrypted connection using
13124 STARTTLS, and then uses HELO afterwards.
13125
13126 The &%-oMr%& option provides a way of specifying a custom protocol name for
13127 messages that are injected locally by trusted callers. This is commonly used to
13128 identify messages that are being re-injected after some kind of scanning.
13129
13130 .vitem &$received_time$&
13131 .vindex "&$received_time$&"
13132 This variable contains the date and time when the current message was received,
13133 as a number of seconds since the start of the Unix epoch.
13134
13135 .vitem &$recipient_data$&
13136 .vindex "&$recipient_data$&"
13137 This variable is set after an indexing lookup success in an ACL &%recipients%&
13138 condition. It contains the data from the lookup, and the value remains set
13139 until the next &%recipients%& test. Thus, you can do things like this:
13140 .display
13141 &`require recipients  = cdb*@;/some/file`&
13142 &`deny    `&&'some further test involving'& &`$recipient_data`&
13143 .endd
13144 &*Warning*&: This variable is set only when a lookup is used as an indexing
13145 method in the address list, using the semicolon syntax as in the example above.
13146 The variable is not set for a lookup that is used as part of the string
13147 expansion that all such lists undergo before being interpreted.
13148
13149 .vitem &$recipient_verify_failure$&
13150 .vindex "&$recipient_verify_failure$&"
13151 In an ACL, when a recipient verification fails, this variable contains
13152 information about the failure. It is set to one of the following words:
13153
13154 .ilist
13155 &"qualify"&: The address was unqualified (no domain), and the message
13156 was neither local nor came from an exempted host.
13157
13158 .next
13159 &"route"&: Routing failed.
13160
13161 .next
13162 &"mail"&: Routing succeeded, and a callout was attempted; rejection occurred at
13163 or before the MAIL command (that is, on initial connection, HELO, or
13164 MAIL).
13165
13166 .next
13167 &"recipient"&: The RCPT command in a callout was rejected.
13168 .next
13169
13170 &"postmaster"&: The postmaster check in a callout was rejected.
13171 .endlist
13172
13173 The main use of this variable is expected to be to distinguish between
13174 rejections of MAIL and rejections of RCPT.
13175
13176 .vitem &$recipients$&
13177 .vindex "&$recipients$&"
13178 This variable contains a list of envelope recipients for a message. A comma and
13179 a space separate the addresses in the replacement text. However, the variable
13180 is not generally available, to prevent exposure of Bcc recipients in
13181 unprivileged users' filter files. You can use &$recipients$& only in these
13182 cases:
13183
13184 .olist
13185 In a system filter file.
13186 .next
13187 In the ACLs associated with the DATA command and with non-SMTP messages, that
13188 is, the ACLs defined by &%acl_smtp_predata%&, &%acl_smtp_data%&,
13189 &%acl_smtp_mime%&, &%acl_not_smtp_start%&, &%acl_not_smtp%&, and
13190 &%acl_not_smtp_mime%&.
13191 .next
13192 From within a &[local_scan()]& function.
13193 .endlist
13194
13195
13196 .vitem &$recipients_count$&
13197 .vindex "&$recipients_count$&"
13198 When a message is being processed, this variable contains the number of
13199 envelope recipients that came with the message. Duplicates are not excluded
13200 from the count. While a message is being received over SMTP, the number
13201 increases for each accepted recipient. It can be referenced in an ACL.
13202
13203
13204 .vitem &$regex_match_string$&
13205 .vindex "&$regex_match_string$&"
13206 This variable is set to contain the matching regular expression after a
13207 &%regex%& ACL condition has matched (see section &<<SECTscanregex>>&).
13208
13209 .vitem "&$regex1$&, &$regex2$&, etc"
13210 .cindex "regex submatch variables (&$1regex$& &$2regex$& etc)"
13211 When a &%regex%& or &%mime_regex%& ACL condition succeeds,
13212 these variables contain the
13213 captured substrings identified by the regular expression.
13214
13215
13216 .vitem &$reply_address$&
13217 .vindex "&$reply_address$&"
13218 When a message is being processed, this variable contains the contents of the
13219 &'Reply-To:'& header line if one exists and it is not empty, or otherwise the
13220 contents of the &'From:'& header line. Apart from the removal of leading
13221 white space, the value is not processed in any way. In particular, no RFC 2047
13222 decoding or character code translation takes place.
13223
13224 .vitem &$return_path$&
13225 .vindex "&$return_path$&"
13226 When a message is being delivered, this variable contains the return path &--
13227 the sender field that will be sent as part of the envelope. It is not enclosed
13228 in <> characters. At the start of routing an address, &$return_path$& has the
13229 same value as &$sender_address$&, but if, for example, an incoming message to a
13230 mailing list has been expanded by a router which specifies a different address
13231 for bounce messages, &$return_path$& subsequently contains the new bounce
13232 address, whereas &$sender_address$& always contains the original sender address
13233 that was received with the message. In other words, &$sender_address$& contains
13234 the incoming envelope sender, and &$return_path$& contains the outgoing
13235 envelope sender.
13236
13237 .vitem &$return_size_limit$&
13238 .vindex "&$return_size_limit$&"
13239 This is an obsolete name for &$bounce_return_size_limit$&.
13240
13241 .vitem &$router_name$&
13242 .cindex "router" "name"
13243 .cindex "name" "of router"
13244 .vindex "&$router_name$&"
13245 During the running of a router this variable contains its name.
13246
13247 .vitem &$runrc$&
13248 .cindex "return code" "from &%run%& expansion"
13249 .vindex "&$runrc$&"
13250 This variable contains the return code from a command that is run by the
13251 &%${run...}%& expansion item. &*Warning*&: In a router or transport, you cannot
13252 assume the order in which option values are expanded, except for those
13253 preconditions whose order of testing is documented. Therefore, you cannot
13254 reliably expect to set &$runrc$& by the expansion of one option, and use it in
13255 another.
13256
13257 .vitem &$self_hostname$&
13258 .oindex "&%self%&" "value of host name"
13259 .vindex "&$self_hostname$&"
13260 When an address is routed to a supposedly remote host that turns out to be the
13261 local host, what happens is controlled by the &%self%& generic router option.
13262 One of its values causes the address to be passed to another router. When this
13263 happens, &$self_hostname$& is set to the name of the local host that the
13264 original router encountered. In other circumstances its contents are null.
13265
13266 .vitem &$sender_address$&
13267 .vindex "&$sender_address$&"
13268 When a message is being processed, this variable contains the sender's address
13269 that was received in the message's envelope. The case of letters in the address
13270 is retained, in both the local part and the domain. For bounce messages, the
13271 value of this variable is the empty string. See also &$return_path$&.
13272
13273 .vitem &$sender_address_data$&
13274 .vindex "&$address_data$&"
13275 .vindex "&$sender_address_data$&"
13276 If &$address_data$& is set when the routers are called from an ACL to verify a
13277 sender address, the final value is preserved in &$sender_address_data$&, to
13278 distinguish it from data from a recipient address. The value does not persist
13279 after the end of the current ACL statement. If you want to preserve it for
13280 longer, you can save it in an ACL variable.
13281
13282 .vitem &$sender_address_domain$&
13283 .vindex "&$sender_address_domain$&"
13284 The domain portion of &$sender_address$&.
13285
13286 .vitem &$sender_address_local_part$&
13287 .vindex "&$sender_address_local_part$&"
13288 The local part portion of &$sender_address$&.
13289
13290 .vitem &$sender_data$&
13291 .vindex "&$sender_data$&"
13292 This variable is set after a lookup success in an ACL &%senders%& condition or
13293 in a router &%senders%& option. It contains the data from the lookup, and the
13294 value remains set until the next &%senders%& test. Thus, you can do things like
13295 this:
13296 .display
13297 &`require senders      = cdb*@;/some/file`&
13298 &`deny    `&&'some further test involving'& &`$sender_data`&
13299 .endd
13300 &*Warning*&: This variable is set only when a lookup is used as an indexing
13301 method in the address list, using the semicolon syntax as in the example above.
13302 The variable is not set for a lookup that is used as part of the string
13303 expansion that all such lists undergo before being interpreted.
13304
13305 .vitem &$sender_fullhost$&
13306 .vindex "&$sender_fullhost$&"
13307 When a message is received from a remote host, this variable contains the host
13308 name and IP address in a single string. It ends with the IP address in square
13309 brackets, followed by a colon and a port number if the logging of ports is
13310 enabled. The format of the rest of the string depends on whether the host
13311 issued a HELO or EHLO SMTP command, and whether the host name was verified by
13312 looking up its IP address. (Looking up the IP address can be forced by the
13313 &%host_lookup%& option, independent of verification.) A plain host name at the
13314 start of the string is a verified host name; if this is not present,
13315 verification either failed or was not requested. A host name in parentheses is
13316 the argument of a HELO or EHLO command. This is omitted if it is identical to
13317 the verified host name or to the host's IP address in square brackets.
13318
13319 .vitem &$sender_helo_dnssec$&
13320 .vindex "&$sender_helo_dnssec$&"
13321 This boolean variable is true if a successful HELO verification was
13322 .cindex "DNS" "DNSSEC"
13323 done using DNS information the resolver library stated was authenticated data.
13324
13325 .vitem &$sender_helo_name$&
13326 .vindex "&$sender_helo_name$&"
13327 When a message is received from a remote host that has issued a HELO or EHLO
13328 command, the argument of that command is placed in this variable. It is also
13329 set if HELO or EHLO is used when a message is received using SMTP locally via
13330 the &%-bs%& or &%-bS%& options.
13331
13332 .vitem &$sender_host_address$&
13333 .vindex "&$sender_host_address$&"
13334 When a message is received from a remote host using SMTP,
13335 this variable contains that
13336 host's IP address. For locally non-SMTP submitted messages, it is empty.
13337
13338 .vitem &$sender_host_authenticated$&
13339 .vindex "&$sender_host_authenticated$&"
13340 This variable contains the name (not the public name) of the authenticator
13341 driver that successfully authenticated the client from which the message was
13342 received. It is empty if there was no successful authentication. See also
13343 &$authenticated_id$&.
13344
13345 .vitem &$sender_host_dnssec$&
13346 .vindex "&$sender_host_dnssec$&"
13347 If an attempt to populate &$sender_host_name$& has been made
13348 (by reference, &%hosts_lookup%& or
13349 otherwise) then this boolean will have been set true if, and only if, the
13350 resolver library states that both
13351 the reverse and forward DNS were authenticated data.  At all
13352 other times, this variable is false.
13353
13354 .cindex "DNS" "DNSSEC"
13355 It is likely that you will need to coerce DNSSEC support on in the resolver
13356 library, by setting:
13357 .code
13358 dns_dnssec_ok = 1
13359 .endd
13360
13361 .new
13362 In addition, on Linux with glibc 2.31 or newer the resolver library will
13363 default to stripping out a successful validation status.
13364 This will break a previously working Exim installation.
13365 Provided that you do trust the resolver (ie, is on localhost) you can tell
13366 glibc to pass through any successful validation with a new option in
13367 &_/etc/resolv.conf_&:
13368 .code
13369 options trust-ad
13370 .endd
13371 .wen
13372
13373 Exim does not perform DNSSEC validation itself, instead leaving that to a
13374 validating resolver (e.g. unbound, or bind with suitable configuration).
13375
13376 If you have changed &%host_lookup_order%& so that &`bydns`& is not the first
13377 mechanism in the list, then this variable will be false.
13378
13379 This requires that your system resolver library support EDNS0 (and that
13380 DNSSEC flags exist in the system headers).  If the resolver silently drops
13381 all EDNS0 options, then this will have no effect.  OpenBSD's asr resolver
13382 is known to currently ignore EDNS0, documented in CAVEATS of asr_run(3).
13383
13384
13385 .vitem &$sender_host_name$&
13386 .vindex "&$sender_host_name$&"
13387 When a message is received from a remote host, this variable contains the
13388 host's name as obtained by looking up its IP address. For messages received by
13389 other means, this variable is empty.
13390
13391 .vindex "&$host_lookup_failed$&"
13392 If the host name has not previously been looked up, a reference to
13393 &$sender_host_name$& triggers a lookup (for messages from remote hosts).
13394 A looked up name is accepted only if it leads back to the original IP address
13395 via a forward lookup. If either the reverse or the forward lookup fails to find
13396 any data, or if the forward lookup does not yield the original IP address,
13397 &$sender_host_name$& remains empty, and &$host_lookup_failed$& is set to &"1"&.
13398
13399 .vindex "&$host_lookup_deferred$&"
13400 However, if either of the lookups cannot be completed (for example, there is a
13401 DNS timeout), &$host_lookup_deferred$& is set to &"1"&, and
13402 &$host_lookup_failed$& remains set to &"0"&.
13403
13404 Once &$host_lookup_failed$& is set to &"1"&, Exim does not try to look up the
13405 host name again if there is a subsequent reference to &$sender_host_name$&
13406 in the same Exim process, but it does try again if &$host_lookup_deferred$&
13407 is set to &"1"&.
13408
13409 Exim does not automatically look up every calling host's name. If you want
13410 maximum efficiency, you should arrange your configuration so that it avoids
13411 these lookups altogether. The lookup happens only if one or more of the
13412 following are true:
13413
13414 .ilist
13415 A string containing &$sender_host_name$& is expanded.
13416 .next
13417 The calling host matches the list in &%host_lookup%&. In the default
13418 configuration, this option is set to *, so it must be changed if lookups are
13419 to be avoided. (In the code, the default for &%host_lookup%& is unset.)
13420 .next
13421 Exim needs the host name in order to test an item in a host list. The items
13422 that require this are described in sections &<<SECThoslispatnam>>& and
13423 &<<SECThoslispatnamsk>>&.
13424 .next
13425 The calling host matches &%helo_try_verify_hosts%& or &%helo_verify_hosts%&.
13426 In this case, the host name is required to compare with the name quoted in any
13427 EHLO or HELO commands that the client issues.
13428 .next
13429 The remote host issues a EHLO or HELO command that quotes one of the
13430 domains in &%helo_lookup_domains%&. The default value of this option is
13431 . ==== As this is a nested list, any displays it contains must be indented
13432 . ==== as otherwise they are too far to the left.
13433 .code
13434   helo_lookup_domains = @ : @[]
13435 .endd
13436 which causes a lookup if a remote host (incorrectly) gives the server's name or
13437 IP address in an EHLO or HELO command.
13438 .endlist
13439
13440
13441 .vitem &$sender_host_port$&
13442 .vindex "&$sender_host_port$&"
13443 When a message is received from a remote host, this variable contains the port
13444 number that was used on the remote host.
13445
13446 .vitem &$sender_ident$&
13447 .vindex "&$sender_ident$&"
13448 When a message is received from a remote host, this variable contains the
13449 identification received in response to an RFC 1413 request. When a message has
13450 been received locally, this variable contains the login name of the user that
13451 called Exim.
13452
13453 .vitem &$sender_rate_$&&'xxx'&
13454 A number of variables whose names begin &$sender_rate_$& are set as part of the
13455 &%ratelimit%& ACL condition. Details are given in section
13456 &<<SECTratelimiting>>&.
13457
13458 .vitem &$sender_rcvhost$&
13459 .cindex "DNS" "reverse lookup"
13460 .cindex "reverse DNS lookup"
13461 .vindex "&$sender_rcvhost$&"
13462 This is provided specifically for use in &'Received:'& headers. It starts with
13463 either the verified host name (as obtained from a reverse DNS lookup) or, if
13464 there is no verified host name, the IP address in square brackets. After that
13465 there may be text in parentheses. When the first item is a verified host name,
13466 the first thing in the parentheses is the IP address in square brackets,
13467 followed by a colon and a port number if port logging is enabled. When the
13468 first item is an IP address, the port is recorded as &"port=&'xxxx'&"& inside
13469 the parentheses.
13470
13471 There may also be items of the form &"helo=&'xxxx'&"& if HELO or EHLO
13472 was used and its argument was not identical to the real host name or IP
13473 address, and &"ident=&'xxxx'&"& if an RFC 1413 ident string is available. If
13474 all three items are present in the parentheses, a newline and tab are inserted
13475 into the string, to improve the formatting of the &'Received:'& header.
13476
13477 .vitem &$sender_verify_failure$&
13478 .vindex "&$sender_verify_failure$&"
13479 In an ACL, when a sender verification fails, this variable contains information
13480 about the failure. The details are the same as for
13481 &$recipient_verify_failure$&.
13482
13483 .vitem &$sending_ip_address$&
13484 .vindex "&$sending_ip_address$&"
13485 This variable is set whenever an outgoing SMTP connection to another host has
13486 been set up. It contains the IP address of the local interface that is being
13487 used. This is useful if a host that has more than one IP address wants to take
13488 on different personalities depending on which one is being used. For incoming
13489 connections, see &$received_ip_address$&.
13490
13491 .vitem &$sending_port$&
13492 .vindex "&$sending_port$&"
13493 This variable is set whenever an outgoing SMTP connection to another host has
13494 been set up. It contains the local port that is being used. For incoming
13495 connections, see &$received_port$&.
13496
13497 .vitem &$smtp_active_hostname$&
13498 .vindex "&$smtp_active_hostname$&"
13499 During an incoming SMTP session, this variable contains the value of the active
13500 host name, as specified by the &%smtp_active_hostname%& option. The value of
13501 &$smtp_active_hostname$& is saved with any message that is received, so its
13502 value can be consulted during routing and delivery.
13503
13504 .vitem &$smtp_command$&
13505 .vindex "&$smtp_command$&"
13506 During the processing of an incoming SMTP command, this variable contains the
13507 entire command. This makes it possible to distinguish between HELO and EHLO in
13508 the HELO ACL, and also to distinguish between commands such as these:
13509 .code
13510 MAIL FROM:<>
13511 MAIL FROM: <>
13512 .endd
13513 For a MAIL command, extra parameters such as SIZE can be inspected. For a RCPT
13514 command, the address in &$smtp_command$& is the original address before any
13515 rewriting, whereas the values in &$local_part$& and &$domain$& are taken from
13516 the address after SMTP-time rewriting.
13517
13518 .vitem &$smtp_command_argument$&
13519 .cindex "SMTP" "command, argument for"
13520 .vindex "&$smtp_command_argument$&"
13521 While an ACL is running to check an SMTP command, this variable contains the
13522 argument, that is, the text that follows the command name, with leading white
13523 space removed. Following the introduction of &$smtp_command$&, this variable is
13524 somewhat redundant, but is retained for backwards compatibility.
13525
13526 .vitem &$smtp_command_history$&
13527 .cindex SMTP "command history"
13528 .vindex "&$smtp_command_history$&"
13529 A comma-separated list (with no whitespace) of the most-recent SMTP commands
13530 received, in time-order left to right.  Only a limited number of commands
13531 are remembered.
13532
13533 .vitem &$smtp_count_at_connection_start$&
13534 .vindex "&$smtp_count_at_connection_start$&"
13535 This variable is set greater than zero only in processes spawned by the Exim
13536 daemon for handling incoming SMTP connections. The name is deliberately long,
13537 in order to emphasize what the contents are. When the daemon accepts a new
13538 connection, it increments this variable. A copy of the variable is passed to
13539 the child process that handles the connection, but its value is fixed, and
13540 never changes. It is only an approximation of how many incoming connections
13541 there actually are, because many other connections may come and go while a
13542 single connection is being processed. When a child process terminates, the
13543 daemon decrements its copy of the variable.
13544
13545 .vitem "&$sn0$& &-- &$sn9$&"
13546 These variables are copies of the values of the &$n0$& &-- &$n9$& accumulators
13547 that were current at the end of the system filter file. This allows a system
13548 filter file to set values that can be tested in users' filter files. For
13549 example, a system filter could set a value indicating how likely it is that a
13550 message is junk mail.
13551
13552 .vitem &$spam_$&&'xxx'&
13553 A number of variables whose names start with &$spam$& are available when Exim
13554 is compiled with the content-scanning extension. For details, see section
13555 &<<SECTscanspamass>>&.
13556
13557 .vitem &$spf_header_comment$& &&&
13558        &$spf_received$& &&&
13559        &$spf_result$& &&&
13560        &$spf_result_guessed$& &&&
13561        &$spf_smtp_comment$&
13562 These variables are only available if Exim is built with SPF support.
13563 For details see section &<<SECSPF>>&.
13564
13565 .vitem &$spool_directory$&
13566 .vindex "&$spool_directory$&"
13567 The name of Exim's spool directory.
13568
13569 .vitem &$spool_inodes$&
13570 .vindex "&$spool_inodes$&"
13571 The number of free inodes in the disk partition where Exim's spool files are
13572 being written. The value is recalculated whenever the variable is referenced.
13573 If the relevant file system does not have the concept of inodes, the value of
13574 is -1. See also the &%check_spool_inodes%& option.
13575
13576 .vitem &$spool_space$&
13577 .vindex "&$spool_space$&"
13578 The amount of free space (as a number of kilobytes) in the disk partition where
13579 Exim's spool files are being written. The value is recalculated whenever the
13580 variable is referenced. If the operating system does not have the ability to
13581 find the amount of free space (only true for experimental systems), the space
13582 value is -1. For example, to check in an ACL that there is at least 50
13583 megabytes free on the spool, you could write:
13584 .code
13585 condition = ${if > {$spool_space}{50000}}
13586 .endd
13587 See also the &%check_spool_space%& option.
13588
13589
13590 .vitem &$thisaddress$&
13591 .vindex "&$thisaddress$&"
13592 This variable is set only during the processing of the &%foranyaddress%&
13593 command in a filter file. Its use is explained in the description of that
13594 command, which can be found in the separate document entitled &'Exim's
13595 interfaces to mail filtering'&.
13596
13597 .vitem &$tls_in_bits$&
13598 .vindex "&$tls_in_bits$&"
13599 Contains an approximation of the TLS cipher's bit-strength
13600 on the inbound connection; the meaning of
13601 this depends upon the TLS implementation used.
13602 If TLS has not been negotiated, the value will be 0.
13603 The value of this is automatically fed into the Cyrus SASL authenticator
13604 when acting as a server, to specify the "external SSF" (a SASL term).
13605
13606 The deprecated &$tls_bits$& variable refers to the inbound side
13607 except when used in the context of an outbound SMTP delivery, when it refers to
13608 the outbound.
13609
13610 .vitem &$tls_out_bits$&
13611 .vindex "&$tls_out_bits$&"
13612 Contains an approximation of the TLS cipher's bit-strength
13613 on an outbound SMTP connection; the meaning of
13614 this depends upon the TLS implementation used.
13615 If TLS has not been negotiated, the value will be 0.
13616
13617 .vitem &$tls_in_ourcert$&
13618 .vindex "&$tls_in_ourcert$&"
13619 .cindex certificate variables
13620 This variable refers to the certificate presented to the peer of an
13621 inbound connection when the message was received.
13622 It is only useful as the argument of a
13623 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
13624 or a &%def%& condition.
13625
13626 &*Note*&: Under versions of OpenSSL preceding 1.1.1,
13627 when a list of more than one
13628 file is used for &%tls_certificate%&, this variable is not reliable.
13629 The macro "_TLS_BAD_MULTICERT_IN_OURCERT" will be defined for those versions.
13630
13631 .vitem &$tls_in_peercert$&
13632 .vindex "&$tls_in_peercert$&"
13633 This variable refers to the certificate presented by the peer of an
13634 inbound connection when the message was received.
13635 It is only useful as the argument of a
13636 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
13637 or a &%def%& condition.
13638 If certificate verification fails it may refer to a failing chain element
13639 which is not the leaf.
13640
13641 .vitem &$tls_out_ourcert$&
13642 .vindex "&$tls_out_ourcert$&"
13643 This variable refers to the certificate presented to the peer of an
13644 outbound connection.  It is only useful as the argument of a
13645 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
13646 or a &%def%& condition.
13647
13648 .vitem &$tls_out_peercert$&
13649 .vindex "&$tls_out_peercert$&"
13650 This variable refers to the certificate presented by the peer of an
13651 outbound connection.  It is only useful as the argument of a
13652 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
13653 or a &%def%& condition.
13654 If certificate verification fails it may refer to a failing chain element
13655 which is not the leaf.
13656
13657 .vitem &$tls_in_certificate_verified$&
13658 .vindex "&$tls_in_certificate_verified$&"
13659 This variable is set to &"1"& if a TLS certificate was verified when the
13660 message was received, and &"0"& otherwise.
13661
13662 The deprecated &$tls_certificate_verified$& variable refers to the inbound side
13663 except when used in the context of an outbound SMTP delivery, when it refers to
13664 the outbound.
13665
13666 .vitem &$tls_out_certificate_verified$&
13667 .vindex "&$tls_out_certificate_verified$&"
13668 This variable is set to &"1"& if a TLS certificate was verified when an
13669 outbound SMTP connection was made,
13670 and &"0"& otherwise.
13671
13672 .vitem &$tls_in_cipher$&
13673 .vindex "&$tls_in_cipher$&"
13674 .vindex "&$tls_cipher$&"
13675 When a message is received from a remote host over an encrypted SMTP
13676 connection, this variable is set to the cipher suite that was negotiated, for
13677 example DES-CBC3-SHA. In other circumstances, in particular, for message
13678 received over unencrypted connections, the variable is empty. Testing
13679 &$tls_in_cipher$& for emptiness is one way of distinguishing between encrypted and
13680 non-encrypted connections during ACL processing.
13681
13682 The deprecated &$tls_cipher$& variable is the same as &$tls_in_cipher$& during message reception,
13683 but in the context of an outward SMTP delivery taking place via the &(smtp)& transport
13684 becomes the same as &$tls_out_cipher$&.
13685
13686 .vitem &$tls_in_cipher_std$&
13687 .vindex "&$tls_in_cipher_std$&"
13688 As above, but returning the RFC standard name for the cipher suite.
13689
13690 .vitem &$tls_out_cipher$&
13691 .vindex "&$tls_out_cipher$&"
13692 This variable is
13693 cleared before any outgoing SMTP connection is made,
13694 and then set to the outgoing cipher suite if one is negotiated. See chapter
13695 &<<CHAPTLS>>& for details of TLS support and chapter &<<CHAPsmtptrans>>& for
13696 details of the &(smtp)& transport.
13697
13698 .vitem &$tls_out_cipher_std$&
13699 .vindex "&$tls_out_cipher_std$&"
13700 As above, but returning the RFC standard name for the cipher suite.
13701
13702 .vitem &$tls_out_dane$&
13703 .vindex &$tls_out_dane$&
13704 DANE active status.  See section &<<SECDANE>>&.
13705
13706 .vitem &$tls_in_ocsp$&
13707 .vindex "&$tls_in_ocsp$&"
13708 When a message is received from a remote client connection
13709 the result of any OCSP request from the client is encoded in this variable:
13710 .code
13711 0 OCSP proof was not requested (default value)
13712 1 No response to request
13713 2 Response not verified
13714 3 Verification failed
13715 4 Verification succeeded
13716 .endd
13717
13718 .vitem &$tls_out_ocsp$&
13719 .vindex "&$tls_out_ocsp$&"
13720 When a message is sent to a remote host connection
13721 the result of any OCSP request made is encoded in this variable.
13722 See &$tls_in_ocsp$& for values.
13723
13724 .vitem &$tls_in_peerdn$&
13725 .vindex "&$tls_in_peerdn$&"
13726 .vindex "&$tls_peerdn$&"
13727 .cindex certificate "extracting fields"
13728 When a message is received from a remote host over an encrypted SMTP
13729 connection, and Exim is configured to request a certificate from the client,
13730 the value of the Distinguished Name of the certificate is made available in the
13731 &$tls_in_peerdn$& during subsequent processing.
13732 If certificate verification fails it may refer to a failing chain element
13733 which is not the leaf.
13734
13735 The deprecated &$tls_peerdn$& variable refers to the inbound side
13736 except when used in the context of an outbound SMTP delivery, when it refers to
13737 the outbound.
13738
13739 .vitem &$tls_out_peerdn$&
13740 .vindex "&$tls_out_peerdn$&"
13741 When a message is being delivered to a remote host over an encrypted SMTP
13742 connection, and Exim is configured to request a certificate from the server,
13743 the value of the Distinguished Name of the certificate is made available in the
13744 &$tls_out_peerdn$& during subsequent processing.
13745 If certificate verification fails it may refer to a failing chain element
13746 which is not the leaf.
13747
13748 .vitem &$tls_in_sni$&
13749 .vindex "&$tls_in_sni$&"
13750 .vindex "&$tls_sni$&"
13751 .cindex "TLS" "Server Name Indication"
13752 When a TLS session is being established, if the client sends the Server
13753 Name Indication extension, the value will be placed in this variable.
13754 If the variable appears in &%tls_certificate%& then this option and
13755 some others, described in &<<SECTtlssni>>&,
13756 will be re-expanded early in the TLS session, to permit
13757 a different certificate to be presented (and optionally a different key to be
13758 used) to the client, based upon the value of the SNI extension.
13759
13760 The deprecated &$tls_sni$& variable refers to the inbound side
13761 except when used in the context of an outbound SMTP delivery, when it refers to
13762 the outbound.
13763
13764 .vitem &$tls_out_sni$&
13765 .vindex "&$tls_out_sni$&"
13766 .cindex "TLS" "Server Name Indication"
13767 During outbound
13768 SMTP deliveries, this variable reflects the value of the &%tls_sni%& option on
13769 the transport.
13770
13771 .vitem &$tls_out_tlsa_usage$&
13772 .vindex &$tls_out_tlsa_usage$&
13773 Bitfield of TLSA record types found.  See section &<<SECDANE>>&.
13774
13775 .vitem &$tls_in_ver$&
13776 .vindex "&$tls_in_ver$&"
13777 When a message is received from a remote host over an encrypted SMTP connection
13778 this variable is set to the protocol version, eg &'TLS1.2'&.
13779
13780 .vitem &$tls_out_ver$&
13781 .vindex "&$tls_out_ver$&"
13782 When a message is being delivered to a remote host over an encrypted SMTP connection
13783 this variable is set to the protocol version.
13784
13785
13786 .vitem &$tod_bsdinbox$&
13787 .vindex "&$tod_bsdinbox$&"
13788 The time of day and the date, in the format required for BSD-style mailbox
13789 files, for example: Thu Oct 17 17:14:09 1995.
13790
13791 .vitem &$tod_epoch$&
13792 .vindex "&$tod_epoch$&"
13793 The time and date as a number of seconds since the start of the Unix epoch.
13794
13795 .vitem &$tod_epoch_l$&
13796 .vindex "&$tod_epoch_l$&"
13797 The time and date as a number of microseconds since the start of the Unix epoch.
13798
13799 .vitem &$tod_full$&
13800 .vindex "&$tod_full$&"
13801 A full version of the time and date, for example: Wed, 16 Oct 1995 09:51:40
13802 +0100. The timezone is always given as a numerical offset from UTC, with
13803 positive values used for timezones that are ahead (east) of UTC, and negative
13804 values for those that are behind (west).
13805
13806 .vitem &$tod_log$&
13807 .vindex "&$tod_log$&"
13808 The time and date in the format used for writing Exim's log files, for example:
13809 1995-10-12 15:32:29, but without a timezone.
13810
13811 .vitem &$tod_logfile$&
13812 .vindex "&$tod_logfile$&"
13813 This variable contains the date in the format yyyymmdd. This is the format that
13814 is used for datestamping log files when &%log_file_path%& contains the &`%D`&
13815 flag.
13816
13817 .vitem &$tod_zone$&
13818 .vindex "&$tod_zone$&"
13819 This variable contains the numerical value of the local timezone, for example:
13820 -0500.
13821
13822 .vitem &$tod_zulu$&
13823 .vindex "&$tod_zulu$&"
13824 This variable contains the UTC date and time in &"Zulu"& format, as specified
13825 by ISO 8601, for example: 20030221154023Z.
13826
13827 .vitem &$transport_name$&
13828 .cindex "transport" "name"
13829 .cindex "name" "of transport"
13830 .vindex "&$transport_name$&"
13831 During the running of a transport, this variable contains its name.
13832
13833 .vitem &$value$&
13834 .vindex "&$value$&"
13835 This variable contains the result of an expansion lookup, extraction operation,
13836 or external command, as described above. It is also used during a
13837 &*reduce*& expansion.
13838
13839 .vitem &$verify_mode$&
13840 .vindex "&$verify_mode$&"
13841 While a router or transport is being run in verify mode or for cutthrough delivery,
13842 contains "S" for sender-verification or "R" for recipient-verification.
13843 Otherwise, empty.
13844
13845 .vitem &$version_number$&
13846 .vindex "&$version_number$&"
13847 The version number of Exim. Same as &$exim_version$&, may be overridden
13848 by the &%exim_version%& main config option.
13849
13850 .vitem &$warn_message_delay$&
13851 .vindex "&$warn_message_delay$&"
13852 This variable is set only during the creation of a message warning about a
13853 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
13854
13855 .vitem &$warn_message_recipients$&
13856 .vindex "&$warn_message_recipients$&"
13857 This variable is set only during the creation of a message warning about a
13858 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
13859 .endlist
13860 .ecindex IIDstrexp
13861
13862
13863
13864 . ////////////////////////////////////////////////////////////////////////////
13865 . ////////////////////////////////////////////////////////////////////////////
13866
13867 .chapter "Embedded Perl" "CHAPperl"
13868 .scindex IIDperl "Perl" "calling from Exim"
13869 Exim can be built to include an embedded Perl interpreter. When this is done,
13870 Perl subroutines can be called as part of the string expansion process. To make
13871 use of the Perl support, you need version 5.004 or later of Perl installed on
13872 your system. To include the embedded interpreter in the Exim binary, include
13873 the line
13874 .code
13875 EXIM_PERL = perl.o
13876 .endd
13877 in your &_Local/Makefile_& and then build Exim in the normal way.
13878
13879
13880 .section "Setting up so Perl can be used" "SECID85"
13881 .oindex "&%perl_startup%&"
13882 Access to Perl subroutines is via a global configuration option called
13883 &%perl_startup%& and an expansion string operator &%${perl ...}%&. If there is
13884 no &%perl_startup%& option in the Exim configuration file then no Perl
13885 interpreter is started and there is almost no overhead for Exim (since none of
13886 the Perl library will be paged in unless used). If there is a &%perl_startup%&
13887 option then the associated value is taken to be Perl code which is executed in
13888 a newly created Perl interpreter.
13889
13890 The value of &%perl_startup%& is not expanded in the Exim sense, so you do not
13891 need backslashes before any characters to escape special meanings. The option
13892 should usually be something like
13893 .code
13894 perl_startup = do '/etc/exim.pl'
13895 .endd
13896 where &_/etc/exim.pl_& is Perl code which defines any subroutines you want to
13897 use from Exim. Exim can be configured either to start up a Perl interpreter as
13898 soon as it is entered, or to wait until the first time it is needed. Starting
13899 the interpreter at the beginning ensures that it is done while Exim still has
13900 its setuid privilege, but can impose an unnecessary overhead if Perl is not in
13901 fact used in a particular run. Also, note that this does not mean that Exim is
13902 necessarily running as root when Perl is called at a later time. By default,
13903 the interpreter is started only when it is needed, but this can be changed in
13904 two ways:
13905
13906 .ilist
13907 .oindex "&%perl_at_start%&"
13908 Setting &%perl_at_start%& (a boolean option) in the configuration requests
13909 a startup when Exim is entered.
13910 .next
13911 The command line option &%-ps%& also requests a startup when Exim is entered,
13912 overriding the setting of &%perl_at_start%&.
13913 .endlist
13914
13915 There is also a command line option &%-pd%& (for delay) which suppresses the
13916 initial startup, even if &%perl_at_start%& is set.
13917
13918 .ilist
13919 .oindex "&%perl_taintmode%&"
13920 .cindex "Perl" "taintmode"
13921 To provide more security executing Perl code via the embedded Perl
13922 interpreter, the &%perl_taintmode%& option can be set. This enables the
13923 taint mode of the Perl interpreter. You are encouraged to set this
13924 option to a true value. To avoid breaking existing installations, it
13925 defaults to false.
13926
13927
13928 .section "Calling Perl subroutines" "SECID86"
13929 When the configuration file includes a &%perl_startup%& option you can make use
13930 of the string expansion item to call the Perl subroutines that are defined
13931 by the &%perl_startup%& code. The operator is used in any of the following
13932 forms:
13933 .code
13934 ${perl{foo}}
13935 ${perl{foo}{argument}}
13936 ${perl{foo}{argument1}{argument2} ... }
13937 .endd
13938 which calls the subroutine &%foo%& with the given arguments. A maximum of eight
13939 arguments may be passed. Passing more than this results in an expansion failure
13940 with an error message of the form
13941 .code
13942 Too many arguments passed to Perl subroutine "foo" (max is 8)
13943 .endd
13944 The return value of the Perl subroutine is evaluated in a scalar context before
13945 it is passed back to Exim to be inserted into the expanded string. If the
13946 return value is &'undef'&, the expansion is forced to fail in the same way as
13947 an explicit &"fail"& on an &%if%& or &%lookup%& item. If the subroutine aborts
13948 by obeying Perl's &%die%& function, the expansion fails with the error message
13949 that was passed to &%die%&.
13950
13951
13952 .section "Calling Exim functions from Perl" "SECID87"
13953 Within any Perl code called from Exim, the function &'Exim::expand_string()'&
13954 is available to call back into Exim's string expansion function. For example,
13955 the Perl code
13956 .code
13957 my $lp = Exim::expand_string('$local_part');
13958 .endd
13959 makes the current Exim &$local_part$& available in the Perl variable &$lp$&.
13960 Note those are single quotes and not double quotes to protect against
13961 &$local_part$& being interpolated as a Perl variable.
13962
13963 If the string expansion is forced to fail by a &"fail"& item, the result of
13964 &'Exim::expand_string()'& is &%undef%&. If there is a syntax error in the
13965 expansion string, the Perl call from the original expansion string fails with
13966 an appropriate error message, in the same way as if &%die%& were used.
13967
13968 .cindex "debugging" "from embedded Perl"
13969 .cindex "log" "writing from embedded Perl"
13970 Two other Exim functions are available for use from within Perl code.
13971 &'Exim::debug_write()'& writes a string to the standard error stream if Exim's
13972 debugging is enabled. If you want a newline at the end, you must supply it.
13973 &'Exim::log_write()'& writes a string to Exim's main log, adding a leading
13974 timestamp. In this case, you should not supply a terminating newline.
13975
13976
13977 .section "Use of standard output and error by Perl" "SECID88"
13978 .cindex "Perl" "standard output and error"
13979 You should not write to the standard error or output streams from within your
13980 Perl code, as it is not defined how these are set up. In versions of Exim
13981 before 4.50, it is possible for the standard output or error to refer to the
13982 SMTP connection during message reception via the daemon. Writing to this stream
13983 is certain to cause chaos. From Exim 4.50 onwards, the standard output and
13984 error streams are connected to &_/dev/null_& in the daemon. The chaos is
13985 avoided, but the output is lost.
13986
13987 .cindex "Perl" "use of &%warn%&"
13988 The Perl &%warn%& statement writes to the standard error stream by default.
13989 Calls to &%warn%& may be embedded in Perl modules that you use, but over which
13990 you have no control. When Exim starts up the Perl interpreter, it arranges for
13991 output from the &%warn%& statement to be written to the Exim main log. You can
13992 change this by including appropriate Perl magic somewhere in your Perl code.
13993 For example, to discard &%warn%& output completely, you need this:
13994 .code
13995 $SIG{__WARN__} = sub { };
13996 .endd
13997 Whenever a &%warn%& is obeyed, the anonymous subroutine is called. In this
13998 example, the code for the subroutine is empty, so it does nothing, but you can
13999 include any Perl code that you like. The text of the &%warn%& message is passed
14000 as the first subroutine argument.
14001 .ecindex IIDperl
14002
14003
14004 . ////////////////////////////////////////////////////////////////////////////
14005 . ////////////////////////////////////////////////////////////////////////////
14006
14007 .chapter "Starting the daemon and the use of network interfaces" &&&
14008          "CHAPinterfaces" &&&
14009          "Starting the daemon"
14010 .cindex "daemon" "starting"
14011 .cindex "interface" "listening"
14012 .cindex "network interface"
14013 .cindex "interface" "network"
14014 .cindex "IP address" "for listening"
14015 .cindex "daemon" "listening IP addresses"
14016 .cindex "TCP/IP" "setting listening interfaces"
14017 .cindex "TCP/IP" "setting listening ports"
14018 A host that is connected to a TCP/IP network may have one or more physical
14019 hardware network interfaces. Each of these interfaces may be configured as one
14020 or more &"logical"& interfaces, which are the entities that a program actually
14021 works with. Each of these logical interfaces is associated with an IP address.
14022 In addition, TCP/IP software supports &"loopback"& interfaces (127.0.0.1 in
14023 IPv4 and ::1 in IPv6), which do not use any physical hardware. Exim requires
14024 knowledge about the host's interfaces for use in three different circumstances:
14025
14026 .olist
14027 When a listening daemon is started, Exim needs to know which interfaces
14028 and ports to listen on.
14029 .next
14030 When Exim is routing an address, it needs to know which IP addresses
14031 are associated with local interfaces. This is required for the correct
14032 processing of MX lists by removing the local host and others with the
14033 same or higher priority values. Also, Exim needs to detect cases
14034 when an address is routed to an IP address that in fact belongs to the
14035 local host. Unless the &%self%& router option or the &%allow_localhost%&
14036 option of the smtp transport is set (as appropriate), this is treated
14037 as an error situation.
14038 .next
14039 When Exim connects to a remote host, it may need to know which interface to use
14040 for the outgoing connection.
14041 .endlist
14042
14043
14044 Exim's default behaviour is likely to be appropriate in the vast majority
14045 of cases. If your host has only one interface, and you want all its IP
14046 addresses to be treated in the same way, and you are using only the
14047 standard SMTP port, you should not need to take any special action. The
14048 rest of this chapter does not apply to you.
14049
14050 In a more complicated situation you may want to listen only on certain
14051 interfaces, or on different ports, and for this reason there are a number of
14052 options that can be used to influence Exim's behaviour. The rest of this
14053 chapter describes how they operate.
14054
14055 When a message is received over TCP/IP, the interface and port that were
14056 actually used are set in &$received_ip_address$& and &$received_port$&.
14057
14058
14059
14060 .section "Starting a listening daemon" "SECID89"
14061 When a listening daemon is started (by means of the &%-bd%& command line
14062 option), the interfaces and ports on which it listens are controlled by the
14063 following options:
14064
14065 .ilist
14066 &%daemon_smtp_ports%& contains a list of default ports
14067 or service names.
14068 (For backward compatibility, this option can also be specified in the singular.)
14069 .next
14070 &%local_interfaces%& contains list of interface IP addresses on which to
14071 listen. Each item may optionally also specify a port.
14072 .endlist
14073
14074 The default list separator in both cases is a colon, but this can be changed as
14075 described in section &<<SECTlistsepchange>>&. When IPv6 addresses are involved,
14076 it is usually best to change the separator to avoid having to double all the
14077 colons. For example:
14078 .code
14079 local_interfaces = <; 127.0.0.1 ; \
14080                       192.168.23.65 ; \
14081                       ::1 ; \
14082                       3ffe:ffff:836f::fe86:a061
14083 .endd
14084 There are two different formats for specifying a port along with an IP address
14085 in &%local_interfaces%&:
14086
14087 .olist
14088 The port is added onto the address with a dot separator. For example, to listen
14089 on port 1234 on two different IP addresses:
14090 .code
14091 local_interfaces = <; 192.168.23.65.1234 ; \
14092                       3ffe:ffff:836f::fe86:a061.1234
14093 .endd
14094 .next
14095 The IP address is enclosed in square brackets, and the port is added
14096 with a colon separator, for example:
14097 .code
14098 local_interfaces = <; [192.168.23.65]:1234 ; \
14099                       [3ffe:ffff:836f::fe86:a061]:1234
14100 .endd
14101 .endlist
14102
14103 When a port is not specified, the value of &%daemon_smtp_ports%& is used. The
14104 default setting contains just one port:
14105 .code
14106 daemon_smtp_ports = smtp
14107 .endd
14108 If more than one port is listed, each interface that does not have its own port
14109 specified listens on all of them. Ports that are listed in
14110 &%daemon_smtp_ports%& can be identified either by name (defined in
14111 &_/etc/services_&) or by number. However, when ports are given with individual
14112 IP addresses in &%local_interfaces%&, only numbers (not names) can be used.
14113
14114
14115
14116 .section "Special IP listening addresses" "SECID90"
14117 The addresses 0.0.0.0 and ::0 are treated specially. They are interpreted
14118 as &"all IPv4 interfaces"& and &"all IPv6 interfaces"&, respectively. In each
14119 case, Exim tells the TCP/IP stack to &"listen on all IPv&'x'& interfaces"&
14120 instead of setting up separate listening sockets for each interface. The
14121 default value of &%local_interfaces%& is
14122 .code
14123 local_interfaces = 0.0.0.0
14124 .endd
14125 when Exim is built without IPv6 support; otherwise it is:
14126 .code
14127 local_interfaces = <; ::0 ; 0.0.0.0
14128 .endd
14129 Thus, by default, Exim listens on all available interfaces, on the SMTP port.
14130
14131
14132
14133 .section "Overriding local_interfaces and daemon_smtp_ports" "SECID91"
14134 The &%-oX%& command line option can be used to override the values of
14135 &%daemon_smtp_ports%& and/or &%local_interfaces%& for a particular daemon
14136 instance. Another way of doing this would be to use macros and the &%-D%&
14137 option. However, &%-oX%& can be used by any admin user, whereas modification of
14138 the runtime configuration by &%-D%& is allowed only when the caller is root or
14139 exim.
14140
14141 The value of &%-oX%& is a list of items. The default colon separator can be
14142 changed in the usual way (&<<SECTlistsepchange>>&) if required.
14143 If there are any items that do not
14144 contain dots or colons (that is, are not IP addresses), the value of
14145 &%daemon_smtp_ports%& is replaced by the list of those items. If there are any
14146 items that do contain dots or colons, the value of &%local_interfaces%& is
14147 replaced by those items. Thus, for example,
14148 .code
14149 -oX 1225
14150 .endd
14151 overrides &%daemon_smtp_ports%&, but leaves &%local_interfaces%& unchanged,
14152 whereas
14153 .code
14154 -oX 192.168.34.5.1125
14155 .endd
14156 overrides &%local_interfaces%&, leaving &%daemon_smtp_ports%& unchanged.
14157 (However, since &%local_interfaces%& now contains no items without ports, the
14158 value of &%daemon_smtp_ports%& is no longer relevant in this example.)
14159
14160
14161
14162 .section "Support for the submissions (aka SSMTP or SMTPS) protocol" "SECTsupobssmt"
14163 .cindex "submissions protocol"
14164 .cindex "ssmtp protocol"
14165 .cindex "smtps protocol"
14166 .cindex "SMTP" "ssmtp protocol"
14167 .cindex "SMTP" "smtps protocol"
14168 Exim supports the use of TLS-on-connect, used by mail clients in the
14169 &"submissions"& protocol, historically also known as SMTPS or SSMTP.
14170 For some years, IETF Standards Track documents only blessed the
14171 STARTTLS-based Submission service (port 587) while common practice was to support
14172 the same feature set on port 465, but using TLS-on-connect.
14173 If your installation needs to provide service to mail clients
14174 (Mail User Agents, MUAs) then you should provide service on both the 587 and
14175 the 465 TCP ports.
14176
14177 If the &%tls_on_connect_ports%& option is set to a list of port numbers or
14178 service names, connections to those ports must first establish TLS, before
14179 proceeding to the application layer use of the SMTP protocol.
14180
14181 The common use of this option is expected to be
14182 .code
14183 tls_on_connect_ports = 465
14184 .endd
14185 per RFC 8314.
14186 There is also a command line option &%-tls-on-connect%&, which forces all ports
14187 to behave in this way when a daemon is started.
14188
14189 &*Warning*&: Setting &%tls_on_connect_ports%& does not of itself cause the
14190 daemon to listen on those ports. You must still specify them in
14191 &%daemon_smtp_ports%&, &%local_interfaces%&, or the &%-oX%& option. (This is
14192 because &%tls_on_connect_ports%& applies to &%inetd%& connections as well as to
14193 connections via the daemon.)
14194
14195
14196
14197
14198 .section "IPv6 address scopes" "SECID92"
14199 .cindex "IPv6" "address scopes"
14200 IPv6 addresses have &"scopes"&, and a host with multiple hardware interfaces
14201 can, in principle, have the same link-local IPv6 address on different
14202 interfaces. Thus, additional information is needed, over and above the IP
14203 address, to distinguish individual interfaces. A convention of using a
14204 percent sign followed by something (often the interface name) has been
14205 adopted in some cases, leading to addresses like this:
14206 .code
14207 fe80::202:b3ff:fe03:45c1%eth0
14208 .endd
14209 To accommodate this usage, a percent sign followed by an arbitrary string is
14210 allowed at the end of an IPv6 address. By default, Exim calls &[getaddrinfo()]&
14211 to convert a textual IPv6 address for actual use. This function recognizes the
14212 percent convention in operating systems that support it, and it processes the
14213 address appropriately. Unfortunately, some older libraries have problems with
14214 &[getaddrinfo()]&. If
14215 .code
14216 IPV6_USE_INET_PTON=yes
14217 .endd
14218 is set in &_Local/Makefile_& (or an OS-dependent Makefile) when Exim is built,
14219 Exim uses &'inet_pton()'& to convert a textual IPv6 address for actual use,
14220 instead of &[getaddrinfo()]&. (Before version 4.14, it always used this
14221 function.) Of course, this means that the additional functionality of
14222 &[getaddrinfo()]& &-- recognizing scoped addresses &-- is lost.
14223
14224 .section "Disabling IPv6" "SECID93"
14225 .cindex "IPv6" "disabling"
14226 Sometimes it happens that an Exim binary that was compiled with IPv6 support is
14227 run on a host whose kernel does not support IPv6. The binary will fall back to
14228 using IPv4, but it may waste resources looking up AAAA records, and trying to
14229 connect to IPv6 addresses, causing delays to mail delivery. If you set the
14230 .oindex "&%disable_ipv6%&"
14231 &%disable_ipv6%& option true, even if the Exim binary has IPv6 support, no IPv6
14232 activities take place. AAAA records are never looked up, and any IPv6 addresses
14233 that are listed in &%local_interfaces%&, data for the &(manualroute)& router,
14234 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
14235 to handle IPv6 literal addresses.
14236
14237 On the other hand, when IPv6 is in use, there may be times when you want to
14238 disable it for certain hosts or domains. You can use the &%dns_ipv4_lookup%&
14239 option to globally suppress the lookup of AAAA records for specified domains,
14240 and you can use the &%ignore_target_hosts%& generic router option to ignore
14241 IPv6 addresses in an individual router.
14242
14243
14244
14245 .section "Examples of starting a listening daemon" "SECID94"
14246 The default case in an IPv6 environment is
14247 .code
14248 daemon_smtp_ports = smtp
14249 local_interfaces = <; ::0 ; 0.0.0.0
14250 .endd
14251 This specifies listening on the smtp port on all IPv6 and IPv4 interfaces.
14252 Either one or two sockets may be used, depending on the characteristics of
14253 the TCP/IP stack. (This is complicated and messy; for more information,
14254 read the comments in the &_daemon.c_& source file.)
14255
14256 To specify listening on ports 25 and 26 on all interfaces:
14257 .code
14258 daemon_smtp_ports = 25 : 26
14259 .endd
14260 (leaving &%local_interfaces%& at the default setting) or, more explicitly:
14261 .code
14262 local_interfaces = <; ::0.25     ; ::0.26 \
14263                       0.0.0.0.25 ; 0.0.0.0.26
14264 .endd
14265 To listen on the default port on all IPv4 interfaces, and on port 26 on the
14266 IPv4 loopback address only:
14267 .code
14268 local_interfaces = 0.0.0.0 : 127.0.0.1.26
14269 .endd
14270 To specify listening on the default port on specific interfaces only:
14271 .code
14272 local_interfaces = 10.0.0.67 : 192.168.34.67
14273 .endd
14274 &*Warning*&: Such a setting excludes listening on the loopback interfaces.
14275
14276
14277
14278 .section "Recognizing the local host" "SECTreclocipadd"
14279 The &%local_interfaces%& option is also used when Exim needs to determine
14280 whether or not an IP address refers to the local host. That is, the IP
14281 addresses of all the interfaces on which a daemon is listening are always
14282 treated as local.
14283
14284 For this usage, port numbers in &%local_interfaces%& are ignored. If either of
14285 the items 0.0.0.0 or ::0 are encountered, Exim gets a complete list of
14286 available interfaces from the operating system, and extracts the relevant
14287 (that is, IPv4 or IPv6) addresses to use for checking.
14288
14289 Some systems set up large numbers of virtual interfaces in order to provide
14290 many virtual web servers. In this situation, you may want to listen for
14291 email on only a few of the available interfaces, but nevertheless treat all
14292 interfaces as local when routing. You can do this by setting
14293 &%extra_local_interfaces%& to a list of IP addresses, possibly including the
14294 &"all"& wildcard values. These addresses are recognized as local, but are not
14295 used for listening. Consider this example:
14296 .code
14297 local_interfaces = <; 127.0.0.1 ; ::1 ; \
14298                       192.168.53.235 ; \
14299                       3ffe:2101:12:1:a00:20ff:fe86:a061
14300
14301 extra_local_interfaces = <; ::0 ; 0.0.0.0
14302 .endd
14303 The daemon listens on the loopback interfaces and just one IPv4 and one IPv6
14304 address, but all available interface addresses are treated as local when
14305 Exim is routing.
14306
14307 In some environments the local host name may be in an MX list, but with an IP
14308 address that is not assigned to any local interface. In other cases it may be
14309 desirable to treat other host names as if they referred to the local host. Both
14310 these cases can be handled by setting the &%hosts_treat_as_local%& option.
14311 This contains host names rather than IP addresses. When a host is referenced
14312 during routing, either via an MX record or directly, it is treated as the local
14313 host if its name matches &%hosts_treat_as_local%&, or if any of its IP
14314 addresses match &%local_interfaces%& or &%extra_local_interfaces%&.
14315
14316
14317
14318 .section "Delivering to a remote host" "SECID95"
14319 Delivery to a remote host is handled by the smtp transport. By default, it
14320 allows the system's TCP/IP functions to choose which interface to use (if
14321 there is more than one) when connecting to a remote host. However, the
14322 &%interface%& option can be set to specify which interface is used. See the
14323 description of the smtp transport in chapter &<<CHAPsmtptrans>>& for more
14324 details.
14325
14326
14327
14328
14329 . ////////////////////////////////////////////////////////////////////////////
14330 . ////////////////////////////////////////////////////////////////////////////
14331
14332 .chapter "Main configuration" "CHAPmainconfig"
14333 .scindex IIDconfima "configuration file" "main section"
14334 .scindex IIDmaiconf "main configuration"
14335 The first part of the runtime configuration file contains three types of item:
14336
14337 .ilist
14338 Macro definitions: These lines start with an upper case letter. See section
14339 &<<SECTmacrodefs>>& for details of macro processing.
14340 .next
14341 Named list definitions: These lines start with one of the words &"domainlist"&,
14342 &"hostlist"&, &"addresslist"&, or &"localpartlist"&. Their use is described in
14343 section &<<SECTnamedlists>>&.
14344 .next
14345 Main configuration settings: Each setting occupies one line of the file
14346 (with possible continuations). If any setting is preceded by the word
14347 &"hide"&, the &%-bP%& command line option displays its value to admin users
14348 only. See section &<<SECTcos>>& for a description of the syntax of these option
14349 settings.
14350 .endlist
14351
14352 This chapter specifies all the main configuration options, along with their
14353 types and default values. For ease of finding a particular option, they appear
14354 in alphabetical order in section &<<SECTalomo>>& below. However, because there
14355 are now so many options, they are first listed briefly in functional groups, as
14356 an aid to finding the name of the option you are looking for. Some options are
14357 listed in more than one group.
14358
14359 .section "Miscellaneous" "SECID96"
14360 .table2
14361 .row &%bi_command%&                  "to run for &%-bi%& command line option"
14362 .row &%debug_store%&                 "do extra internal checks"
14363 .row &%disable_ipv6%&                "do no IPv6 processing"
14364 .row &%keep_malformed%&              "for broken files &-- should not happen"
14365 .row &%localhost_number%&            "for unique message ids in clusters"
14366 .row &%message_body_newlines%&       "retain newlines in &$message_body$&"
14367 .row &%message_body_visible%&        "how much to show in &$message_body$&"
14368 .row &%mua_wrapper%&                 "run in &""MUA wrapper""& mode"
14369 .row &%print_topbitchars%&           "top-bit characters are printing"
14370 .row &%spool_wireformat%&            "use wire-format spool data files when possible"
14371 .row &%timezone%&                    "force time zone"
14372 .endtable
14373
14374
14375 .section "Exim parameters" "SECID97"
14376 .table2
14377 .row &%exim_group%&                  "override compiled-in value"
14378 .row &%exim_path%&                   "override compiled-in value"
14379 .row &%exim_user%&                   "override compiled-in value"
14380 .row &%primary_hostname%&            "default from &[uname()]&"
14381 .row &%split_spool_directory%&       "use multiple directories"
14382 .row &%spool_directory%&             "override compiled-in value"
14383 .endtable
14384
14385
14386
14387 .section "Privilege controls" "SECID98"
14388 .table2
14389 .row &%admin_groups%&                "groups that are Exim admin users"
14390 .row &%commandline_checks_require_admin%& "require admin for various checks"
14391 .row &%deliver_drop_privilege%&      "drop root for delivery processes"
14392 .row &%local_from_check%&            "insert &'Sender:'& if necessary"
14393 .row &%local_from_prefix%&           "for testing &'From:'& for local sender"
14394 .row &%local_from_suffix%&           "for testing &'From:'& for local sender"
14395 .row &%local_sender_retain%&         "keep &'Sender:'& from untrusted user"
14396 .row &%never_users%&                 "do not run deliveries as these"
14397 .row &%prod_requires_admin%&         "forced delivery requires admin user"
14398 .row &%queue_list_requires_admin%&   "queue listing requires admin user"
14399 .row &%trusted_groups%&              "groups that are trusted"
14400 .row &%trusted_users%&               "users that are trusted"
14401 .endtable
14402
14403
14404
14405 .section "Logging" "SECID99"
14406 .table2
14407 .row &%event_action%&                "custom logging"
14408 .row &%hosts_connection_nolog%&      "exemption from connect logging"
14409 .row &%log_file_path%&               "override compiled-in value"
14410 .row &%log_selector%&                "set/unset optional logging"
14411 .row &%log_timezone%&                "add timezone to log lines"
14412 .row &%message_logs%&                "create per-message logs"
14413 .row &%preserve_message_logs%&       "after message completion"
14414 .row &%process_log_path%&            "for SIGUSR1 and &'exiwhat'&"
14415 .row &%slow_lookup_log%&             "control logging of slow DNS lookups"
14416 .row &%syslog_duplication%&          "controls duplicate log lines on syslog"
14417 .row &%syslog_facility%&             "set syslog &""facility""& field"
14418 .row &%syslog_pid%&                  "pid in syslog lines"
14419 .row &%syslog_processname%&          "set syslog &""ident""& field"
14420 .row &%syslog_timestamp%&            "timestamp syslog lines"
14421 .row &%write_rejectlog%&             "control use of message log"
14422 .endtable
14423
14424
14425
14426 .section "Frozen messages" "SECID100"
14427 .table2
14428 .row &%auto_thaw%&                   "sets time for retrying frozen messages"
14429 .row &%freeze_tell%&                 "send message when freezing"
14430 .row &%move_frozen_messages%&        "to another directory"
14431 .row &%timeout_frozen_after%&        "keep frozen messages only so long"
14432 .endtable
14433
14434
14435
14436 .section "Data lookups" "SECID101"
14437 .table2
14438 .row &%ibase_servers%&               "InterBase servers"
14439 .row &%ldap_ca_cert_dir%&            "dir of CA certs to verify LDAP server's"
14440 .row &%ldap_ca_cert_file%&           "file of CA certs to verify LDAP server's"
14441 .row &%ldap_cert_file%&              "client cert file for LDAP"
14442 .row &%ldap_cert_key%&               "client key file for LDAP"
14443 .row &%ldap_cipher_suite%&           "TLS negotiation preference control"
14444 .row &%ldap_default_servers%&        "used if no server in query"
14445 .row &%ldap_require_cert%&           "action to take without LDAP server cert"
14446 .row &%ldap_start_tls%&              "require TLS within LDAP"
14447 .row &%ldap_version%&                "set protocol version"
14448 .row &%lookup_open_max%&             "lookup files held open"
14449 .row &%mysql_servers%&               "default MySQL servers"
14450 .row &%oracle_servers%&              "Oracle servers"
14451 .row &%pgsql_servers%&               "default PostgreSQL servers"
14452 .row &%sqlite_lock_timeout%&         "as it says"
14453 .endtable
14454
14455
14456
14457 .section "Message ids" "SECID102"
14458 .table2
14459 .row &%message_id_header_domain%&    "used to build &'Message-ID:'& header"
14460 .row &%message_id_header_text%&      "ditto"
14461 .endtable
14462
14463
14464
14465 .section "Embedded Perl Startup" "SECID103"
14466 .table2
14467 .row &%perl_at_start%&               "always start the interpreter"
14468 .row &%perl_startup%&                "code to obey when starting Perl"
14469 .row &%perl_taintmode%&              "enable taint mode in Perl"
14470 .endtable
14471
14472
14473
14474 .section "Daemon" "SECID104"
14475 .table2
14476 .row &%daemon_smtp_ports%&           "default ports"
14477 .row &%daemon_startup_retries%&      "number of times to retry"
14478 .row &%daemon_startup_sleep%&        "time to sleep between tries"
14479 .row &%extra_local_interfaces%&      "not necessarily listened on"
14480 .row &%local_interfaces%&            "on which to listen, with optional ports"
14481 .row &%notifier_socket%&             "override compiled-in value"
14482 .row &%pid_file_path%&               "override compiled-in value"
14483 .row &%queue_run_max%&               "maximum simultaneous queue runners"
14484 .endtable
14485
14486
14487
14488 .section "Resource control" "SECID105"
14489 .table2
14490 .row &%check_log_inodes%&            "before accepting a message"
14491 .row &%check_log_space%&             "before accepting a message"
14492 .row &%check_spool_inodes%&          "before accepting a message"
14493 .row &%check_spool_space%&           "before accepting a message"
14494 .row &%deliver_queue_load_max%&      "no queue deliveries if load high"
14495 .row &%queue_only_load%&             "queue incoming if load high"
14496 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
14497 .row &%queue_run_max%&               "maximum simultaneous queue runners"
14498 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
14499 .row &%smtp_accept_max%&             "simultaneous incoming connections"
14500 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
14501 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
14502 .row &%smtp_accept_max_per_connection%& "messages per connection"
14503 .row &%smtp_accept_max_per_host%&    "connections from one host"
14504 .row &%smtp_accept_queue%&           "queue mail if more connections"
14505 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
14506                                            connection"
14507 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
14508 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
14509 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
14510 .row &%smtp_load_reserve%&           "SMTP from reserved hosts if load high"
14511 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
14512 .endtable
14513
14514
14515
14516 .section "Policy controls" "SECID106"
14517 .table2
14518 .row &%acl_not_smtp%&                "ACL for non-SMTP messages"
14519 .row &%acl_not_smtp_mime%&           "ACL for non-SMTP MIME parts"
14520 .row &%acl_not_smtp_start%&          "ACL for start of non-SMTP message"
14521 .row &%acl_smtp_auth%&               "ACL for AUTH"
14522 .row &%acl_smtp_connect%&            "ACL for connection"
14523 .row &%acl_smtp_data%&               "ACL for DATA"
14524 .row &%acl_smtp_data_prdr%&          "ACL for DATA, per-recipient"
14525 .row &%acl_smtp_dkim%&               "ACL for DKIM verification"
14526 .row &%acl_smtp_etrn%&               "ACL for ETRN"
14527 .row &%acl_smtp_expn%&               "ACL for EXPN"
14528 .row &%acl_smtp_helo%&               "ACL for EHLO or HELO"
14529 .row &%acl_smtp_mail%&               "ACL for MAIL"
14530 .row &%acl_smtp_mailauth%&           "ACL for AUTH on MAIL command"
14531 .row &%acl_smtp_mime%&               "ACL for MIME parts"
14532 .row &%acl_smtp_notquit%&            "ACL for non-QUIT terminations"
14533 .row &%acl_smtp_predata%&            "ACL for start of data"
14534 .row &%acl_smtp_quit%&               "ACL for QUIT"
14535 .row &%acl_smtp_rcpt%&               "ACL for RCPT"
14536 .row &%acl_smtp_starttls%&           "ACL for STARTTLS"
14537 .row &%acl_smtp_vrfy%&               "ACL for VRFY"
14538 .row &%av_scanner%&                  "specify virus scanner"
14539 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
14540                                       words""&"
14541 .row &%dns_cname_loops%&             "follow CNAMEs returned by resolver"
14542 .row &%dns_csa_search_limit%&        "control CSA parent search depth"
14543 .row &%dns_csa_use_reverse%&         "en/disable CSA IP reverse search"
14544 .row &%header_maxsize%&              "total size of message header"
14545 .row &%header_line_maxsize%&         "individual header line limit"
14546 .row &%helo_accept_junk_hosts%&      "allow syntactic junk from these hosts"
14547 .row &%helo_allow_chars%&            "allow illegal chars in HELO names"
14548 .row &%helo_lookup_domains%&         "lookup hostname for these HELO names"
14549 .row &%helo_try_verify_hosts%&       "HELO soft-checked for these hosts"
14550 .row &%helo_verify_hosts%&           "HELO hard-checked for these hosts"
14551 .row &%host_lookup%&                 "host name looked up for these hosts"
14552 .row &%host_lookup_order%&           "order of DNS and local name lookups"
14553 .row &%hosts_proxy%&                 "use proxy protocol for these hosts"
14554 .row &%host_reject_connection%&      "reject connection from these hosts"
14555 .row &%hosts_treat_as_local%&        "useful in some cluster configurations"
14556 .row &%local_scan_timeout%&          "timeout for &[local_scan()]&"
14557 .row &%message_size_limit%&          "for all messages"
14558 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
14559 .row &%spamd_address%&               "set interface to SpamAssassin"
14560 .row &%strict_acl_vars%&             "object to unset ACL variables"
14561 .endtable
14562
14563
14564
14565 .section "Callout cache" "SECID107"
14566 .table2
14567 .row &%callout_domain_negative_expire%& "timeout for negative domain cache &&&
14568                                          item"
14569 .row &%callout_domain_positive_expire%& "timeout for positive domain cache &&&
14570                                          item"
14571 .row &%callout_negative_expire%&     "timeout for negative address cache item"
14572 .row &%callout_positive_expire%&     "timeout for positive address cache item"
14573 .row &%callout_random_local_part%&   "string to use for &""random""& testing"
14574 .endtable
14575
14576
14577
14578 .section "TLS" "SECID108"
14579 .table2
14580 .row &%gnutls_compat_mode%&          "use GnuTLS compatibility mode"
14581 .row &%gnutls_allow_auto_pkcs11%&    "allow GnuTLS to autoload PKCS11 modules"
14582 .row &%openssl_options%&             "adjust OpenSSL compatibility options"
14583 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
14584 .row &%tls_certificate%&             "location of server certificate"
14585 .row &%tls_crl%&                     "certificate revocation list"
14586 .row &%tls_dh_max_bits%&             "clamp D-H bit count suggestion"
14587 .row &%tls_dhparam%&                 "DH parameters for server"
14588 .row &%tls_eccurve%&                 "EC curve selection for server"
14589 .row &%tls_ocsp_file%&               "location of server certificate status proof"
14590 .row &%tls_on_connect_ports%&        "specify SSMTP (SMTPS) ports"
14591 .row &%tls_privatekey%&              "location of server private key"
14592 .row &%tls_remember_esmtp%&          "don't reset after starting TLS"
14593 .row &%tls_require_ciphers%&         "specify acceptable ciphers"
14594 .row &%tls_try_verify_hosts%&        "try to verify client certificate"
14595 .row &%tls_verify_certificates%&     "expected client certificates"
14596 .row &%tls_verify_hosts%&            "insist on client certificate verify"
14597 .endtable
14598
14599
14600
14601 .section "Local user handling" "SECID109"
14602 .table2
14603 .row &%finduser_retries%&            "useful in NIS environments"
14604 .row &%gecos_name%&                  "used when creating &'Sender:'&"
14605 .row &%gecos_pattern%&               "ditto"
14606 .row &%max_username_length%&         "for systems that truncate"
14607 .row &%unknown_login%&               "used when no login name found"
14608 .row &%unknown_username%&            "ditto"
14609 .row &%uucp_from_pattern%&           "for recognizing &""From ""& lines"
14610 .row &%uucp_from_sender%&            "ditto"
14611 .endtable
14612
14613
14614
14615 .section "All incoming messages (SMTP and non-SMTP)" "SECID110"
14616 .table2
14617 .row &%header_maxsize%&              "total size of message header"
14618 .row &%header_line_maxsize%&         "individual header line limit"
14619 .row &%message_size_limit%&          "applies to all messages"
14620 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
14621 .row &%received_header_text%&        "expanded to make &'Received:'&"
14622 .row &%received_headers_max%&        "for mail loop detection"
14623 .row &%recipients_max%&              "limit per message"
14624 .row &%recipients_max_reject%&       "permanently reject excess recipients"
14625 .endtable
14626
14627
14628
14629
14630 .section "Non-SMTP incoming messages" "SECID111"
14631 .table2
14632 .row &%receive_timeout%&             "for non-SMTP messages"
14633 .endtable
14634
14635
14636
14637
14638
14639 .section "Incoming SMTP messages" "SECID112"
14640 See also the &'Policy controls'& section above.
14641
14642 .table2
14643 .row &%dkim_verify_hashes%&          "DKIM hash methods accepted for signatures"
14644 .row &%dkim_verify_keytypes%&        "DKIM key types accepted for signatures"
14645 .row &%dkim_verify_min_keysizes%&    "DKIM key sizes accepted for signatures"
14646 .row &%dkim_verify_signers%&         "DKIM domains for which DKIM ACL is run"
14647 .row &%host_lookup%&                 "host name looked up for these hosts"
14648 .row &%host_lookup_order%&           "order of DNS and local name lookups"
14649 .row &%recipient_unqualified_hosts%& "may send unqualified recipients"
14650 .row &%rfc1413_hosts%&               "make ident calls to these hosts"
14651 .row &%rfc1413_query_timeout%&       "zero disables ident calls"
14652 .row &%sender_unqualified_hosts%&    "may send unqualified senders"
14653 .row &%smtp_accept_keepalive%&       "some TCP/IP magic"
14654 .row &%smtp_accept_max%&             "simultaneous incoming connections"
14655 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
14656 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
14657 .row &%smtp_accept_max_per_connection%& "messages per connection"
14658 .row &%smtp_accept_max_per_host%&    "connections from one host"
14659 .row &%smtp_accept_queue%&           "queue mail if more connections"
14660 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
14661                                            connection"
14662 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
14663 .row &%smtp_active_hostname%&        "host name to use in messages"
14664 .row &%smtp_banner%&                 "text for welcome banner"
14665 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
14666 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
14667 .row &%smtp_enforce_sync%&           "of SMTP command/responses"
14668 .row &%smtp_etrn_command%&           "what to run for ETRN"
14669 .row &%smtp_etrn_serialize%&         "only one at once"
14670 .row &%smtp_load_reserve%&           "only reserve hosts if this load"
14671 .row &%smtp_max_unknown_commands%&   "before dropping connection"
14672 .row &%smtp_ratelimit_hosts%&        "apply ratelimiting to these hosts"
14673 .row &%smtp_ratelimit_mail%&         "ratelimit for MAIL commands"
14674 .row &%smtp_ratelimit_rcpt%&         "ratelimit for RCPT commands"
14675 .row &%smtp_receive_timeout%&        "per command or data line"
14676 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
14677 .row &%smtp_return_error_details%&   "give detail on rejections"
14678 .endtable
14679
14680
14681
14682 .section "SMTP extensions" "SECID113"
14683 .table2
14684 .row &%accept_8bitmime%&             "advertise 8BITMIME"
14685 .row &%auth_advertise_hosts%&        "advertise AUTH to these hosts"
14686 .row &%chunking_advertise_hosts%&    "advertise CHUNKING to these hosts"
14687 .row &%dsn_advertise_hosts%&         "advertise DSN extensions to these hosts"
14688 .row &%ignore_fromline_hosts%&       "allow &""From ""& from these hosts"
14689 .row &%ignore_fromline_local%&       "allow &""From ""& from local SMTP"
14690 .row &%pipelining_advertise_hosts%&  "advertise pipelining to these hosts"
14691 .row &%pipelining_connect_advertise_hosts%& "advertise pipelining to these hosts"
14692 .row &%prdr_enable%&                 "advertise PRDR to all hosts"
14693 .row &%smtputf8_advertise_hosts%&    "advertise SMTPUTF8 to these hosts"
14694 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
14695 .endtable
14696
14697
14698
14699 .section "Processing messages" "SECID114"
14700 .table2
14701 .row &%allow_domain_literals%&       "recognize domain literal syntax"
14702 .row &%allow_mx_to_ip%&              "allow MX to point to IP address"
14703 .row &%allow_utf8_domains%&          "in addresses"
14704 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
14705                                       words""&"
14706 .row &%delivery_date_remove%&        "from incoming messages"
14707 .row &%envelope_to_remove%&          "from incoming messages"
14708 .row &%extract_addresses_remove_arguments%& "affects &%-t%& processing"
14709 .row &%headers_charset%&             "default for translations"
14710 .row &%qualify_domain%&              "default for senders"
14711 .row &%qualify_recipient%&           "default for recipients"
14712 .row &%return_path_remove%&          "from incoming messages"
14713 .row &%strip_excess_angle_brackets%& "in addresses"
14714 .row &%strip_trailing_dot%&          "at end of addresses"
14715 .row &%untrusted_set_sender%&        "untrusted can set envelope sender"
14716 .endtable
14717
14718
14719
14720 .section "System filter" "SECID115"
14721 .table2
14722 .row &%system_filter%&               "locate system filter"
14723 .row &%system_filter_directory_transport%& "transport for delivery to a &&&
14724                                             directory"
14725 .row &%system_filter_file_transport%& "transport for delivery to a file"
14726 .row &%system_filter_group%&         "group for filter running"
14727 .row &%system_filter_pipe_transport%& "transport for delivery to a pipe"
14728 .row &%system_filter_reply_transport%& "transport for autoreply delivery"
14729 .row &%system_filter_user%&          "user for filter running"
14730 .endtable
14731
14732
14733
14734 .section "Routing and delivery" "SECID116"
14735 .table2
14736 .row &%disable_ipv6%&                "do no IPv6 processing"
14737 .row &%dns_again_means_nonexist%&    "for broken domains"
14738 .row &%dns_check_names_pattern%&     "pre-DNS syntax check"
14739 .row &%dns_dnssec_ok%&               "parameter for resolver"
14740 .row &%dns_ipv4_lookup%&             "only v4 lookup for these domains"
14741 .row &%dns_retrans%&                 "parameter for resolver"
14742 .row &%dns_retry%&                   "parameter for resolver"
14743 .row &%dns_trust_aa%&                "DNS zones trusted as authentic"
14744 .row &%dns_use_edns0%&               "parameter for resolver"
14745 .row &%hold_domains%&                "hold delivery for these domains"
14746 .row &%local_interfaces%&            "for routing checks"
14747 .row &%queue_domains%&               "no immediate delivery for these"
14748 .row &%queue_only%&                  "no immediate delivery at all"
14749 .row &%queue_only_file%&             "no immediate delivery if file exists"
14750 .row &%queue_only_load%&             "no immediate delivery if load is high"
14751 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
14752 .row &%queue_only_override%&         "allow command line to override"
14753 .row &%queue_run_in_order%&          "order of arrival"
14754 .row &%queue_run_max%&               "of simultaneous queue runners"
14755 .row &%queue_smtp_domains%&          "no immediate SMTP delivery for these"
14756 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
14757 .row &%remote_sort_domains%&         "order of remote deliveries"
14758 .row &%retry_data_expire%&           "timeout for retry data"
14759 .row &%retry_interval_max%&          "safety net for retry rules"
14760 .endtable
14761
14762
14763
14764 .section "Bounce and warning messages" "SECID117"
14765 .table2
14766 .row &%bounce_message_file%&         "content of bounce"
14767 .row &%bounce_message_text%&         "content of bounce"
14768 .row &%bounce_return_body%&          "include body if returning message"
14769 .row &%bounce_return_linesize_limit%& "limit on returned message line length"
14770 .row &%bounce_return_message%&       "include original message in bounce"
14771 .row &%bounce_return_size_limit%&    "limit on returned message"
14772 .row &%bounce_sender_authentication%& "send authenticated sender with bounce"
14773 .row &%dsn_from%&                    "set &'From:'& contents in bounces"
14774 .row &%errors_copy%&                 "copy bounce messages"
14775 .row &%errors_reply_to%&             "&'Reply-to:'& in bounces"
14776 .row &%delay_warning%&               "time schedule"
14777 .row &%delay_warning_condition%&     "condition for warning messages"
14778 .row &%ignore_bounce_errors_after%&  "discard undeliverable bounces"
14779 .row &%smtp_return_error_details%&   "give detail on rejections"
14780 .row &%warn_message_file%&           "content of warning message"
14781 .endtable
14782
14783
14784
14785 .section "Alphabetical list of main options" "SECTalomo"
14786 Those options that undergo string expansion before use are marked with
14787 &dagger;.
14788
14789 .option accept_8bitmime main boolean true
14790 .cindex "8BITMIME"
14791 .cindex "8-bit characters"
14792 .cindex "log" "selectors"
14793 .cindex "log" "8BITMIME"
14794 This option causes Exim to send 8BITMIME in its response to an SMTP
14795 EHLO command, and to accept the BODY= parameter on MAIL commands.
14796 However, though Exim is 8-bit clean, it is not a protocol converter, and it
14797 takes no steps to do anything special with messages received by this route.
14798
14799 Historically Exim kept this option off by default, but the maintainers
14800 feel that in today's Internet, this causes more problems than it solves.
14801 It now defaults to true.
14802 A more detailed analysis of the issues is provided by Dan Bernstein:
14803 .display
14804 &url(https://cr.yp.to/smtp/8bitmime.html)
14805 .endd
14806
14807 To log received 8BITMIME status use
14808 .code
14809 log_selector = +8bitmime
14810 .endd
14811
14812 .option acl_not_smtp main string&!! unset
14813 .cindex "&ACL;" "for non-SMTP messages"
14814 .cindex "non-SMTP messages" "ACLs for"
14815 This option defines the ACL that is run when a non-SMTP message has been
14816 read and is on the point of being accepted. See chapter &<<CHAPACL>>& for
14817 further details.
14818
14819 .option acl_not_smtp_mime main string&!! unset
14820 This option defines the ACL that is run for individual MIME parts of non-SMTP
14821 messages. It operates in exactly the same way as &%acl_smtp_mime%& operates for
14822 SMTP messages.
14823
14824 .option acl_not_smtp_start main string&!! unset
14825 .cindex "&ACL;" "at start of non-SMTP message"
14826 .cindex "non-SMTP messages" "ACLs for"
14827 This option defines the ACL that is run before Exim starts reading a
14828 non-SMTP message. See chapter &<<CHAPACL>>& for further details.
14829
14830 .option acl_smtp_auth main string&!! unset
14831 .cindex "&ACL;" "setting up for SMTP commands"
14832 .cindex "AUTH" "ACL for"
14833 This option defines the ACL that is run when an SMTP AUTH command is
14834 received. See chapter &<<CHAPACL>>& for further details.
14835
14836 .option acl_smtp_connect main string&!! unset
14837 .cindex "&ACL;" "on SMTP connection"
14838 This option defines the ACL that is run when an SMTP connection is received.
14839 See chapter &<<CHAPACL>>& for further details.
14840
14841 .option acl_smtp_data main string&!! unset
14842 .cindex "DATA" "ACL for"
14843 This option defines the ACL that is run after an SMTP DATA command has been
14844 processed and the message itself has been received, but before the final
14845 acknowledgment is sent. See chapter &<<CHAPACL>>& for further details.
14846
14847 .option acl_smtp_data_prdr main string&!! accept
14848 .cindex "PRDR" "ACL for"
14849 .cindex "DATA" "PRDR ACL for"
14850 .cindex "&ACL;" "PRDR-related"
14851 .cindex "&ACL;" "per-user data processing"
14852 This option defines the ACL that,
14853 if the PRDR feature has been negotiated,
14854 is run for each recipient after an SMTP DATA command has been
14855 processed and the message itself has been received, but before the
14856 acknowledgment is sent. See chapter &<<CHAPACL>>& for further details.
14857
14858 .option acl_smtp_dkim main string&!! unset
14859 .cindex DKIM "ACL for"
14860 This option defines the ACL that is run for each DKIM signature
14861 (by default, or as specified in the dkim_verify_signers option)
14862 of a received message.
14863 See section &<<SECDKIMVFY>>& for further details.
14864
14865 .option acl_smtp_etrn main string&!! unset
14866 .cindex "ETRN" "ACL for"
14867 This option defines the ACL that is run when an SMTP ETRN command is
14868 received. See chapter &<<CHAPACL>>& for further details.
14869
14870 .option acl_smtp_expn main string&!! unset
14871 .cindex "EXPN" "ACL for"
14872 This option defines the ACL that is run when an SMTP EXPN command is
14873 received. See chapter &<<CHAPACL>>& for further details.
14874
14875 .option acl_smtp_helo main string&!! unset
14876 .cindex "EHLO" "ACL for"
14877 .cindex "HELO" "ACL for"
14878 This option defines the ACL that is run when an SMTP EHLO or HELO
14879 command is received. See chapter &<<CHAPACL>>& for further details.
14880
14881
14882 .option acl_smtp_mail main string&!! unset
14883 .cindex "MAIL" "ACL for"
14884 This option defines the ACL that is run when an SMTP MAIL command is
14885 received. See chapter &<<CHAPACL>>& for further details.
14886
14887 .option acl_smtp_mailauth main string&!! unset
14888 .cindex "AUTH" "on MAIL command"
14889 This option defines the ACL that is run when there is an AUTH parameter on
14890 a MAIL command. See chapter &<<CHAPACL>>& for details of ACLs, and chapter
14891 &<<CHAPSMTPAUTH>>& for details of authentication.
14892
14893 .option acl_smtp_mime main string&!! unset
14894 .cindex "MIME content scanning" "ACL for"
14895 This option is available when Exim is built with the content-scanning
14896 extension. It defines the ACL that is run for each MIME part in a message. See
14897 section &<<SECTscanmimepart>>& for details.
14898
14899 .option acl_smtp_notquit main string&!! unset
14900 .cindex "not-QUIT, ACL for"
14901 This option defines the ACL that is run when an SMTP session
14902 ends without a QUIT command being received.
14903 See chapter &<<CHAPACL>>& for further details.
14904
14905 .option acl_smtp_predata main string&!! unset
14906 This option defines the ACL that is run when an SMTP DATA command is
14907 received, before the message itself is received. See chapter &<<CHAPACL>>& for
14908 further details.
14909
14910 .option acl_smtp_quit main string&!! unset
14911 .cindex "QUIT, ACL for"
14912 This option defines the ACL that is run when an SMTP QUIT command is
14913 received. See chapter &<<CHAPACL>>& for further details.
14914
14915 .option acl_smtp_rcpt main string&!! unset
14916 .cindex "RCPT" "ACL for"
14917 This option defines the ACL that is run when an SMTP RCPT command is
14918 received. See chapter &<<CHAPACL>>& for further details.
14919
14920 .option acl_smtp_starttls main string&!! unset
14921 .cindex "STARTTLS, ACL for"
14922 This option defines the ACL that is run when an SMTP STARTTLS command is
14923 received. See chapter &<<CHAPACL>>& for further details.
14924
14925 .option acl_smtp_vrfy main string&!! unset
14926 .cindex "VRFY" "ACL for"
14927 This option defines the ACL that is run when an SMTP VRFY command is
14928 received. See chapter &<<CHAPACL>>& for further details.
14929
14930 .option add_environment main "string list" empty
14931 .cindex "environment" "set values"
14932 This option adds individual environment variables that the
14933 currently linked libraries and programs in child processes may use.
14934 Each list element should be of the form &"name=value"&.
14935
14936 See &<<SECTpipeenv>>& for the environment of &(pipe)& transports.
14937
14938 .option admin_groups main "string list&!!" unset
14939 .cindex "admin user"
14940 This option is expanded just once, at the start of Exim's processing. If the
14941 current group or any of the supplementary groups of an Exim caller is in this
14942 colon-separated list, the caller has admin privileges. If all your system
14943 programmers are in a specific group, for example, you can give them all Exim
14944 admin privileges by putting that group in &%admin_groups%&. However, this does
14945 not permit them to read Exim's spool files (whose group owner is the Exim gid).
14946 To permit this, you have to add individuals to the Exim group.
14947
14948 .option allow_domain_literals main boolean false
14949 .cindex "domain literal"
14950 If this option is set, the RFC 2822 domain literal format is permitted in
14951 email addresses. The option is not set by default, because the domain literal
14952 format is not normally required these days, and few people know about it. It
14953 has, however, been exploited by mail abusers.
14954
14955 Unfortunately, it seems that some DNS black list maintainers are using this
14956 format to report black listing to postmasters. If you want to accept messages
14957 addressed to your hosts by IP address, you need to set
14958 &%allow_domain_literals%& true, and also to add &`@[]`& to the list of local
14959 domains (defined in the named domain list &%local_domains%& in the default
14960 configuration). This &"magic string"& matches the domain literal form of all
14961 the local host's IP addresses.
14962
14963
14964 .option allow_mx_to_ip main boolean false
14965 .cindex "MX record" "pointing to IP address"
14966 It appears that more and more DNS zone administrators are breaking the rules
14967 and putting domain names that look like IP addresses on the right hand side of
14968 MX records. Exim follows the rules and rejects this, giving an error message
14969 that explains the misconfiguration. However, some other MTAs support this
14970 practice, so to avoid &"Why can't Exim do this?"& complaints,
14971 &%allow_mx_to_ip%& exists, in order to enable this heinous activity. It is not
14972 recommended, except when you have no other choice.
14973
14974 .option allow_utf8_domains main boolean false
14975 .cindex "domain" "UTF-8 characters in"
14976 .cindex "UTF-8" "in domain name"
14977 Lots of discussion is going on about internationalized domain names. One
14978 camp is strongly in favour of just using UTF-8 characters, and it seems
14979 that at least two other MTAs permit this.
14980 This option allows Exim users to experiment if they wish.
14981
14982 If it is set true, Exim's domain parsing function allows valid
14983 UTF-8 multicharacters to appear in domain name components, in addition to
14984 letters, digits, and hyphens.
14985
14986 If Exim is built with internationalization support
14987 and the SMTPUTF8 ESMTP option is in use (see chapter &<<CHAPi18n>>&)
14988 this option can be left as default.
14989 Without that,
14990 if you want to look up such domain names in the DNS, you must also
14991 adjust the value of &%dns_check_names_pattern%& to match the extended form. A
14992 suitable setting is:
14993 .code
14994 dns_check_names_pattern = (?i)^(?>(?(1)\.|())[a-z0-9\xc0-\xff]\
14995   (?>[-a-z0-9\x80-\xff]*[a-z0-9\x80-\xbf])?)+$
14996 .endd
14997 Alternatively, you can just disable this feature by setting
14998 .code
14999 dns_check_names_pattern =
15000 .endd
15001 That is, set the option to an empty string so that no check is done.
15002
15003
15004 .option auth_advertise_hosts main "host list&!!" *
15005 .cindex "authentication" "advertising"
15006 .cindex "AUTH" "advertising"
15007 If any server authentication mechanisms are configured, Exim advertises them in
15008 response to an EHLO command only if the calling host matches this list.
15009 Otherwise, Exim does not advertise AUTH.
15010 Exim does not accept AUTH commands from clients to which it has not
15011 advertised the availability of AUTH. The advertising of individual
15012 authentication mechanisms can be controlled by the use of the
15013 &%server_advertise_condition%& generic authenticator option on the individual
15014 authenticators. See chapter &<<CHAPSMTPAUTH>>& for further details.
15015
15016 Certain mail clients (for example, Netscape) require the user to provide a name
15017 and password for authentication if AUTH is advertised, even though it may
15018 not be needed (the host may accept messages from hosts on its local LAN without
15019 authentication, for example). The &%auth_advertise_hosts%& option can be used
15020 to make these clients more friendly by excluding them from the set of hosts to
15021 which Exim advertises AUTH.
15022
15023 .cindex "AUTH" "advertising when encrypted"
15024 If you want to advertise the availability of AUTH only when the connection
15025 is encrypted using TLS, you can make use of the fact that the value of this
15026 option is expanded, with a setting like this:
15027 .code
15028 auth_advertise_hosts = ${if eq{$tls_in_cipher}{}{}{*}}
15029 .endd
15030 .vindex "&$tls_in_cipher$&"
15031 If &$tls_in_cipher$& is empty, the session is not encrypted, and the result of
15032 the expansion is empty, thus matching no hosts. Otherwise, the result of the
15033 expansion is *, which matches all hosts.
15034
15035
15036 .option auto_thaw main time 0s
15037 .cindex "thawing messages"
15038 .cindex "unfreezing messages"
15039 If this option is set to a time greater than zero, a queue runner will try a
15040 new delivery attempt on any frozen message, other than a bounce message, if
15041 this much time has passed since it was frozen. This may result in the message
15042 being re-frozen if nothing has changed since the last attempt. It is a way of
15043 saying &"keep on trying, even though there are big problems"&.
15044
15045 &*Note*&: This is an old option, which predates &%timeout_frozen_after%& and
15046 &%ignore_bounce_errors_after%&. It is retained for compatibility, but it is not
15047 thought to be very useful any more, and its use should probably be avoided.
15048
15049
15050 .option av_scanner main string "see below"
15051 This option is available if Exim is built with the content-scanning extension.
15052 It specifies which anti-virus scanner to use. The default value is:
15053 .code
15054 sophie:/var/run/sophie
15055 .endd
15056 If the value of &%av_scanner%& starts with a dollar character, it is expanded
15057 before use. See section &<<SECTscanvirus>>& for further details.
15058
15059
15060 .option bi_command main string unset
15061 .oindex "&%-bi%&"
15062 This option supplies the name of a command that is run when Exim is called with
15063 the &%-bi%& option (see chapter &<<CHAPcommandline>>&). The string value is
15064 just the command name, it is not a complete command line. If an argument is
15065 required, it must come from the &%-oA%& command line option.
15066
15067
15068 .option bounce_message_file main string&!! unset
15069 .cindex "bounce message" "customizing"
15070 .cindex "customizing" "bounce message"
15071 This option defines a template file containing paragraphs of text to be used
15072 for constructing bounce messages.  Details of the file's contents are given in
15073 chapter &<<CHAPemsgcust>>&.
15074 .new
15075 .cindex bounce_message_file "tainted data"
15076 The option is expanded to give the file path, which must be
15077 absolute and untainted.
15078 .wen
15079 See also &%warn_message_file%&.
15080
15081
15082 .option bounce_message_text main string unset
15083 When this option is set, its contents are included in the default bounce
15084 message immediately after &"This message was created automatically by mail
15085 delivery software."& It is not used if &%bounce_message_file%& is set.
15086
15087 .option bounce_return_body main boolean true
15088 .cindex "bounce message" "including body"
15089 This option controls whether the body of an incoming message is included in a
15090 bounce message when &%bounce_return_message%& is true. The default setting
15091 causes the entire message, both header and body, to be returned (subject to the
15092 value of &%bounce_return_size_limit%&). If this option is false, only the
15093 message header is included. In the case of a non-SMTP message containing an
15094 error that is detected during reception, only those header lines preceding the
15095 point at which the error was detected are returned.
15096 .cindex "bounce message" "including original"
15097
15098 .option bounce_return_linesize_limit main integer 998
15099 .cindex "size" "of bounce lines, limit"
15100 .cindex "bounce message" "line length limit"
15101 .cindex "limit" "bounce message line length"
15102 This option sets a limit in bytes on the line length of messages
15103 that are returned to senders due to delivery problems,
15104 when &%bounce_return_message%& is true.
15105 The default value corresponds to RFC limits.
15106 If the message being returned has lines longer than this value it is
15107 treated as if the &%bounce_return_size_limit%& (below) restriction was exceeded.
15108
15109 The option also applies to bounces returned when an error is detected
15110 during reception of a message.
15111 In this case lines from the original are truncated.
15112
15113 The option does not apply to messages generated by an &(autoreply)& transport.
15114
15115
15116 .option bounce_return_message main boolean true
15117 If this option is set false, none of the original message is included in
15118 bounce messages generated by Exim. See also &%bounce_return_size_limit%& and
15119 &%bounce_return_body%&.
15120
15121
15122 .option bounce_return_size_limit main integer 100K
15123 .cindex "size" "of bounce, limit"
15124 .cindex "bounce message" "size limit"
15125 .cindex "limit" "bounce message size"
15126 This option sets a limit in bytes on the size of messages that are returned to
15127 senders as part of bounce messages when &%bounce_return_message%& is true. The
15128 limit should be less than the value of the global &%message_size_limit%& and of
15129 any &%message_size_limit%& settings on transports, to allow for the bounce text
15130 that Exim generates. If this option is set to zero there is no limit.
15131
15132 When the body of any message that is to be included in a bounce message is
15133 greater than the limit, it is truncated, and a comment pointing this out is
15134 added at the top. The actual cutoff may be greater than the value given, owing
15135 to the use of buffering for transferring the message in chunks (typically 8K in
15136 size). The idea is to save bandwidth on those undeliverable 15-megabyte
15137 messages.
15138
15139 .option bounce_sender_authentication main string unset
15140 .cindex "bounce message" "sender authentication"
15141 .cindex "authentication" "bounce message"
15142 .cindex "AUTH" "on bounce message"
15143 This option provides an authenticated sender address that is sent with any
15144 bounce messages generated by Exim that are sent over an authenticated SMTP
15145 connection. A typical setting might be:
15146 .code
15147 bounce_sender_authentication = mailer-daemon@my.domain.example
15148 .endd
15149 which would cause bounce messages to be sent using the SMTP command:
15150 .code
15151 MAIL FROM:<> AUTH=mailer-daemon@my.domain.example
15152 .endd
15153 The value of &%bounce_sender_authentication%& must always be a complete email
15154 address.
15155
15156 .option callout_domain_negative_expire main time 3h
15157 .cindex "caching" "callout timeouts"
15158 .cindex "callout" "caching timeouts"
15159 This option specifies the expiry time for negative callout cache data for a
15160 domain. See section &<<SECTcallver>>& for details of callout verification, and
15161 section &<<SECTcallvercache>>& for details of the caching.
15162
15163
15164 .option callout_domain_positive_expire main time 7d
15165 This option specifies the expiry time for positive callout cache data for a
15166 domain. See section &<<SECTcallver>>& for details of callout verification, and
15167 section &<<SECTcallvercache>>& for details of the caching.
15168
15169
15170 .option callout_negative_expire main time 2h
15171 This option specifies the expiry time for negative callout cache data for an
15172 address. See section &<<SECTcallver>>& for details of callout verification, and
15173 section &<<SECTcallvercache>>& for details of the caching.
15174
15175
15176 .option callout_positive_expire main time 24h
15177 This option specifies the expiry time for positive callout cache data for an
15178 address. See section &<<SECTcallver>>& for details of callout verification, and
15179 section &<<SECTcallvercache>>& for details of the caching.
15180
15181
15182 .option callout_random_local_part main string&!! "see below"
15183 This option defines the &"random"& local part that can be used as part of
15184 callout verification. The default value is
15185 .code
15186 $primary_hostname-$tod_epoch-testing
15187 .endd
15188 See section &<<CALLaddparcall>>& for details of how this value is used.
15189
15190
15191 .option check_log_inodes main integer 100
15192 See &%check_spool_space%& below.
15193
15194
15195 .option check_log_space main integer 10M
15196 See &%check_spool_space%& below.
15197
15198 .oindex "&%check_rfc2047_length%&"
15199 .cindex "RFC 2047" "disabling length check"
15200 .option check_rfc2047_length main boolean true
15201 RFC 2047 defines a way of encoding non-ASCII characters in headers using a
15202 system of &"encoded words"&. The RFC specifies a maximum length for an encoded
15203 word; strings to be encoded that exceed this length are supposed to use
15204 multiple encoded words. By default, Exim does not recognize encoded words that
15205 exceed the maximum length. However, it seems that some software, in violation
15206 of the RFC, generates overlong encoded words. If &%check_rfc2047_length%& is
15207 set false, Exim recognizes encoded words of any length.
15208
15209
15210 .option check_spool_inodes main integer 100
15211 See &%check_spool_space%& below.
15212
15213
15214 .option check_spool_space main integer 10M
15215 .cindex "checking disk space"
15216 .cindex "disk space, checking"
15217 .cindex "spool directory" "checking space"
15218 The four &%check_...%& options allow for checking of disk resources before a
15219 message is accepted.
15220
15221 .vindex "&$log_inodes$&"
15222 .vindex "&$log_space$&"
15223 .vindex "&$spool_inodes$&"
15224 .vindex "&$spool_space$&"
15225 When any of these options are nonzero, they apply to all incoming messages. If you
15226 want to apply different checks to different kinds of message, you can do so by
15227 testing the variables &$log_inodes$&, &$log_space$&, &$spool_inodes$&, and
15228 &$spool_space$& in an ACL with appropriate additional conditions.
15229
15230
15231 &%check_spool_space%& and &%check_spool_inodes%& check the spool partition if
15232 either value is greater than zero, for example:
15233 .code
15234 check_spool_space = 100M
15235 check_spool_inodes = 100
15236 .endd
15237 The spool partition is the one that contains the directory defined by
15238 SPOOL_DIRECTORY in &_Local/Makefile_&. It is used for holding messages in
15239 transit.
15240
15241 &%check_log_space%& and &%check_log_inodes%&  check the partition in which log
15242 files are written if either is greater than zero. These should be set only if
15243 &%log_file_path%& and &%spool_directory%& refer to different partitions.
15244
15245 If there is less space or fewer inodes than requested, Exim refuses to accept
15246 incoming mail. In the case of SMTP input this is done by giving a 452 temporary
15247 error response to the MAIL command. If ESMTP is in use and there was a
15248 SIZE parameter on the MAIL command, its value is added to the
15249 &%check_spool_space%& value, and the check is performed even if
15250 &%check_spool_space%& is zero, unless &%no_smtp_check_spool_space%& is set.
15251
15252 The values for &%check_spool_space%& and &%check_log_space%& are held as a
15253 number of kilobytes (though specified in bytes).
15254 If a non-multiple of 1024 is specified, it is rounded up.
15255
15256 For non-SMTP input and for batched SMTP input, the test is done at start-up; on
15257 failure a message is written to stderr and Exim exits with a non-zero code, as
15258 it obviously cannot send an error message of any kind.
15259
15260 There is a slight performance penalty for these checks.
15261 Versions of Exim preceding 4.88 had these disabled by default;
15262 high-rate installations confident they will never run out of resources
15263 may wish to deliberately disable them.
15264
15265 .option chunking_advertise_hosts main "host list&!!" *
15266 .cindex CHUNKING advertisement
15267 .cindex "RFC 3030" "CHUNKING"
15268 The CHUNKING extension (RFC3030) will be advertised in the EHLO message to
15269 these hosts.
15270 Hosts may use the BDAT command as an alternate to DATA.
15271
15272 .option commandline_checks_require_admin main boolean &`false`&
15273 .cindex "restricting access to features"
15274 This option restricts various basic checking features to require an
15275 administrative user.
15276 This affects most of the &%-b*%& options, such as &%-be%&.
15277
15278 .option debug_store main boolean &`false`&
15279 .cindex debugging "memory corruption"
15280 .cindex memory debugging
15281 This option, when true, enables extra checking in Exim's internal memory
15282 management.  For use when a memory corruption issue is being investigated,
15283 it should normally be left as default.
15284
15285 .option daemon_smtp_ports main string &`smtp`&
15286 .cindex "port" "for daemon"
15287 .cindex "TCP/IP" "setting listening ports"
15288 This option specifies one or more default SMTP ports on which the Exim daemon
15289 listens. See chapter &<<CHAPinterfaces>>& for details of how it is used. For
15290 backward compatibility, &%daemon_smtp_port%& (singular) is a synonym.
15291
15292 .option daemon_startup_retries main integer 9
15293 .cindex "daemon startup, retrying"
15294 This option, along with &%daemon_startup_sleep%&, controls the retrying done by
15295 the daemon at startup when it cannot immediately bind a listening socket
15296 (typically because the socket is already in use): &%daemon_startup_retries%&
15297 defines the number of retries after the first failure, and
15298 &%daemon_startup_sleep%& defines the length of time to wait between retries.
15299
15300 .option daemon_startup_sleep main time 30s
15301 See &%daemon_startup_retries%&.
15302
15303 .option delay_warning main "time list" 24h
15304 .cindex "warning of delay"
15305 .cindex "delay warning, specifying"
15306 .cindex "queue" "delay warning"
15307 When a message is delayed, Exim sends a warning message to the sender at
15308 intervals specified by this option. The data is a colon-separated list of times
15309 after which to send warning messages. If the value of the option is an empty
15310 string or a zero time, no warnings are sent. Up to 10 times may be given. If a
15311 message has been in the queue for longer than the last time, the last interval
15312 between the times is used to compute subsequent warning times. For example,
15313 with
15314 .code
15315 delay_warning = 4h:8h:24h
15316 .endd
15317 the first message is sent after 4 hours, the second after 8 hours, and
15318 the third one after 24 hours. After that, messages are sent every 16 hours,
15319 because that is the interval between the last two times on the list. If you set
15320 just one time, it specifies the repeat interval. For example, with:
15321 .code
15322 delay_warning = 6h
15323 .endd
15324 messages are repeated every six hours. To stop warnings after a given time, set
15325 a very large time at the end of the list. For example:
15326 .code
15327 delay_warning = 2h:12h:99d
15328 .endd
15329 Note that the option is only evaluated at the time a delivery attempt fails,
15330 which depends on retry and queue-runner configuration.
15331 Typically retries will be configured more frequently than warning messages.
15332
15333 .option delay_warning_condition main string&!! "see below"
15334 .vindex "&$domain$&"
15335 The string is expanded at the time a warning message might be sent. If all the
15336 deferred addresses have the same domain, it is set in &$domain$& during the
15337 expansion. Otherwise &$domain$& is empty. If the result of the expansion is a
15338 forced failure, an empty string, or a string matching any of &"0"&, &"no"& or
15339 &"false"& (the comparison being done caselessly) then the warning message is
15340 not sent. The default is:
15341 .code
15342 delay_warning_condition = ${if or {\
15343   { !eq{$h_list-id:$h_list-post:$h_list-subscribe:}{} }\
15344   { match{$h_precedence:}{(?i)bulk|list|junk} }\
15345   { match{$h_auto-submitted:}{(?i)auto-generated|auto-replied} }\
15346   } {no}{yes}}
15347 .endd
15348 This suppresses the sending of warnings for messages that contain &'List-ID:'&,
15349 &'List-Post:'&, or &'List-Subscribe:'& headers, or have &"bulk"&, &"list"& or
15350 &"junk"& in a &'Precedence:'& header, or have &"auto-generated"& or
15351 &"auto-replied"& in an &'Auto-Submitted:'& header.
15352
15353 .option deliver_drop_privilege main boolean false
15354 .cindex "unprivileged delivery"
15355 .cindex "delivery" "unprivileged"
15356 If this option is set true, Exim drops its root privilege at the start of a
15357 delivery process, and runs as the Exim user throughout. This severely restricts
15358 the kinds of local delivery that are possible, but is viable in certain types
15359 of configuration. There is a discussion about the use of root privilege in
15360 chapter &<<CHAPsecurity>>&.
15361
15362 .option deliver_queue_load_max main fixed-point unset
15363 .cindex "load average"
15364 .cindex "queue runner" "abandoning"
15365 When this option is set, a queue run is abandoned if the system load average
15366 becomes greater than the value of the option. The option has no effect on
15367 ancient operating systems on which Exim cannot determine the load average.
15368 See also &%queue_only_load%& and &%smtp_load_reserve%&.
15369
15370
15371 .option delivery_date_remove main boolean true
15372 .cindex "&'Delivery-date:'& header line"
15373 Exim's transports have an option for adding a &'Delivery-date:'& header to a
15374 message when it is delivered, in exactly the same way as &'Return-path:'& is
15375 handled. &'Delivery-date:'& records the actual time of delivery. Such headers
15376 should not be present in incoming messages, and this option causes them to be
15377 removed at the time the message is received, to avoid any problems that might
15378 occur when a delivered message is subsequently sent on to some other recipient.
15379
15380 .option disable_fsync main boolean false
15381 .cindex "&[fsync()]&, disabling"
15382 This option is available only if Exim was built with the compile-time option
15383 ENABLE_DISABLE_FSYNC. When this is not set, a reference to &%disable_fsync%& in
15384 a runtime configuration generates an &"unknown option"& error. You should not
15385 build Exim with ENABLE_DISABLE_FSYNC or set &%disable_fsync%& unless you
15386 really, really, really understand what you are doing. &'No pre-compiled
15387 distributions of Exim should ever make this option available.'&
15388
15389 When &%disable_fsync%& is set true, Exim no longer calls &[fsync()]& to force
15390 updated files' data to be written to disc before continuing. Unexpected events
15391 such as crashes and power outages may cause data to be lost or scrambled.
15392 Here be Dragons. &*Beware.*&
15393
15394
15395 .option disable_ipv6 main boolean false
15396 .cindex "IPv6" "disabling"
15397 If this option is set true, even if the Exim binary has IPv6 support, no IPv6
15398 activities take place. AAAA records are never looked up, and any IPv6 addresses
15399 that are listed in &%local_interfaces%&, data for the &%manualroute%& router,
15400 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
15401 to handle IPv6 literal addresses.
15402
15403
15404 .new
15405 .option dkim_verify_hashes main "string list" "sha256 : sha512"
15406 .cindex DKIM "selecting signature algorithms"
15407 This option gives a list of hash types which are acceptable in signatures,
15408 .wen
15409 and an order of processing.
15410 Signatures with algorithms not in the list will be ignored.
15411
15412 Acceptable values include:
15413 .code
15414 sha1
15415 sha256
15416 sha512
15417 .endd
15418
15419 Note that the acceptance of sha1 violates RFC 8301.
15420
15421 .option dkim_verify_keytypes main "string list" "ed25519 : rsa"
15422 This option gives a list of key types which are acceptable in signatures,
15423 and an order of processing.
15424 Signatures with algorithms not in the list will be ignored.
15425
15426
15427 .new
15428 .option dkim_verify_min_keysizes main "string list" "rsa=1024 ed25519=250"
15429 This option gives a list of key sizes which are acceptable in signatures.
15430 The list is keyed by the algorithm type for the key; the values are in bits.
15431 Signatures with keys smaller than given by this option will fail verification.
15432
15433 The default enforces the RFC 8301 minimum key size for RSA signatures.
15434 .wen
15435
15436 .option dkim_verify_minimal main boolean false
15437 If set to true, verification of signatures will terminate after the
15438 first success.
15439
15440 .option dkim_verify_signers main "domain list&!!" $dkim_signers
15441 .cindex DKIM "controlling calls to the ACL"
15442 This option gives a list of DKIM domains for which the DKIM ACL is run.
15443 It is expanded after the message is received; by default it runs
15444 the ACL once for each signature in the message.
15445 See section &<<SECDKIMVFY>>&.
15446
15447
15448 .option dns_again_means_nonexist main "domain list&!!" unset
15449 .cindex "DNS" "&""try again""& response; overriding"
15450 DNS lookups give a &"try again"& response for the DNS errors
15451 &"non-authoritative host not found"& and &"SERVERFAIL"&. This can cause Exim to
15452 keep trying to deliver a message, or to give repeated temporary errors to
15453 incoming mail. Sometimes the effect is caused by a badly set up name server and
15454 may persist for a long time. If a domain which exhibits this problem matches
15455 anything in &%dns_again_means_nonexist%&, it is treated as if it did not exist.
15456 This option should be used with care. You can make it apply to reverse lookups
15457 by a setting such as this:
15458 .code
15459 dns_again_means_nonexist = *.in-addr.arpa
15460 .endd
15461 This option applies to all DNS lookups that Exim does. It also applies when the
15462 &[gethostbyname()]& or &[getipnodebyname()]& functions give temporary errors,
15463 since these are most likely to be caused by DNS lookup problems. The
15464 &(dnslookup)& router has some options of its own for controlling what happens
15465 when lookups for MX or SRV records give temporary errors. These more specific
15466 options are applied after this global option.
15467
15468 .option dns_check_names_pattern main string "see below"
15469 .cindex "DNS" "pre-check of name syntax"
15470 When this option is set to a non-empty string, it causes Exim to check domain
15471 names for characters that are not allowed in host names before handing them to
15472 the DNS resolver, because some resolvers give temporary errors for names that
15473 contain unusual characters. If a domain name contains any unwanted characters,
15474 a &"not found"& result is forced, and the resolver is not called. The check is
15475 done by matching the domain name against a regular expression, which is the
15476 value of this option. The default pattern is
15477 .code
15478 dns_check_names_pattern = \
15479   (?i)^(?>(?(1)\.|())[^\W_](?>[a-z0-9/-]*[^\W_])?)+$
15480 .endd
15481 which permits only letters, digits, slashes, and hyphens in components, but
15482 they must start and end with a letter or digit. Slashes are not, in fact,
15483 permitted in host names, but they are found in certain NS records (which can be
15484 accessed in Exim by using a &%dnsdb%& lookup). If you set
15485 &%allow_utf8_domains%&, you must modify this pattern, or set the option to an
15486 empty string.
15487
15488 .option dns_csa_search_limit main integer 5
15489 This option controls the depth of parental searching for CSA SRV records in the
15490 DNS, as described in more detail in section &<<SECTverifyCSA>>&.
15491
15492 .option dns_csa_use_reverse main boolean true
15493 This option controls whether or not an IP address, given as a CSA domain, is
15494 reversed and looked up in the reverse DNS, as described in more detail in
15495 section &<<SECTverifyCSA>>&.
15496
15497 .option dns_cname_loops main integer 1
15498 .cindex DNS "CNAME following"
15499 This option controls the following of CNAME chains, needed if the resolver does
15500 not do it internally.
15501 As of 2018 most should, and the default can be left.
15502 If you have an ancient one, a value of 10 is likely needed.
15503
15504 The default value of one CNAME-follow is needed
15505 thanks to the observed return for an MX request,
15506 given no MX presence but a CNAME to an A, of the CNAME.
15507
15508
15509 .option dns_dnssec_ok main integer -1
15510 .cindex "DNS" "resolver options"
15511 .cindex "DNS" "DNSSEC"
15512 If this option is set to a non-negative number then Exim will initialise the
15513 DNS resolver library to either use or not use DNSSEC, overriding the system
15514 default. A value of 0 coerces DNSSEC off, a value of 1 coerces DNSSEC on.
15515
15516 If the resolver library does not support DNSSEC then this option has no effect.
15517
15518 .new
15519 On Linux with glibc 2.31 or newer this is insufficient, the resolver library
15520 will default to stripping out a successful validation status.
15521 This will break a previously working Exim installation.
15522 Provided that you do trust the resolver (ie, is on localhost) you can tell
15523 glibc to pass through any successful validation with a new option in
15524 &_/etc/resolv.conf_&:
15525 .code
15526 options trust-ad
15527 .endd
15528 .wen
15529
15530
15531 .option dns_ipv4_lookup main "domain list&!!" unset
15532 .cindex "IPv6" "DNS lookup for AAAA records"
15533 .cindex "DNS" "IPv6 lookup for AAAA records"
15534 .cindex DNS "IPv6 disabling"
15535 When Exim is compiled with IPv6 support and &%disable_ipv6%& is not set, it
15536 looks for IPv6 address records (AAAA records) as well as IPv4 address records
15537 (A records) when trying to find IP addresses for hosts, unless the host's
15538 domain matches this list.
15539
15540 This is a fudge to help with name servers that give big delays or otherwise do
15541 not work for the AAAA record type. In due course, when the world's name
15542 servers have all been upgraded, there should be no need for this option.
15543 Note that all lookups, including those done for verification, are affected;
15544 this will result in verify failure for IPv6 connections or ones using names
15545 only valid for IPv6 addresses.
15546
15547
15548 .option dns_retrans main time 0s
15549 .cindex "DNS" "resolver options"
15550 .cindex timeout "dns lookup"
15551 .cindex "DNS" timeout
15552 The options &%dns_retrans%& and &%dns_retry%& can be used to set the
15553 retransmission and retry parameters for DNS lookups. Values of zero (the
15554 defaults) leave the system default settings unchanged. The first value is the
15555 time between retries, and the second is the number of retries. It isn't
15556 totally clear exactly how these settings affect the total time a DNS lookup may
15557 take. I haven't found any documentation about timeouts on DNS lookups; these
15558 parameter values are available in the external resolver interface structure,
15559 but nowhere does it seem to describe how they are used or what you might want
15560 to set in them.
15561 See also the &%slow_lookup_log%& option.
15562
15563
15564 .option dns_retry main integer 0
15565 See &%dns_retrans%& above.
15566
15567
15568 .option dns_trust_aa main "domain list&!!" unset
15569 .cindex "DNS" "resolver options"
15570 .cindex "DNS" "DNSSEC"
15571 If this option is set then lookup results marked with the AA bit
15572 (Authoritative Answer) are trusted the same way as if they were
15573 DNSSEC-verified. The authority section's name of the answer must
15574 match with this expanded domain list.
15575
15576 Use this option only if you talk directly to a resolver that is
15577 authoritative for some zones and does not set the AD (Authentic Data)
15578 bit in the answer. Some DNS servers may have an configuration option to
15579 mark the answers from their own zones as verified (they set the AD bit).
15580 Others do not have this option. It is considered as poor practice using
15581 a resolver that is an authoritative server for some zones.
15582
15583 Use this option only if you really have to (e.g. if you want
15584 to use DANE for remote delivery to a server that is listed in the DNS
15585 zones that your resolver is authoritative for).
15586
15587 If the DNS answer packet has the AA bit set and contains resource record
15588 in the answer section, the name of the first NS record appearing in the
15589 authority section is compared against the list. If the answer packet is
15590 authoritative but the answer section is empty, the name of the first SOA
15591 record in the authoritative section is used instead.
15592
15593 .cindex "DNS" "resolver options"
15594 .option dns_use_edns0 main integer -1
15595 .cindex "DNS" "resolver options"
15596 .cindex "DNS" "EDNS0"
15597 .cindex "DNS" "OpenBSD
15598 If this option is set to a non-negative number then Exim will initialise the
15599 DNS resolver library to either use or not use EDNS0 extensions, overriding
15600 the system default. A value of 0 coerces EDNS0 off, a value of 1 coerces EDNS0
15601 on.
15602
15603 If the resolver library does not support EDNS0 then this option has no effect.
15604
15605 OpenBSD's asr resolver routines are known to ignore the EDNS0 option; this
15606 means that DNSSEC will not work with Exim on that platform either, unless Exim
15607 is linked against an alternative DNS client library.
15608
15609
15610 .option drop_cr main boolean false
15611 This is an obsolete option that is now a no-op. It used to affect the way Exim
15612 handled CR and LF characters in incoming messages. What happens now is
15613 described in section &<<SECTlineendings>>&.
15614
15615 .option dsn_advertise_hosts main "host list&!!" unset
15616 .cindex "bounce messages" "success"
15617 .cindex "DSN" "success"
15618 .cindex "Delivery Status Notification" "success"
15619 DSN extensions (RFC3461) will be advertised in the EHLO message to,
15620 and accepted from, these hosts.
15621 Hosts may use the NOTIFY and ENVID options on RCPT TO commands,
15622 and RET and ORCPT options on MAIL FROM commands.
15623 A NOTIFY=SUCCESS option requests success-DSN messages.
15624 A NOTIFY= option with no argument requests that no delay or failure DSNs
15625 are sent.
15626
15627 .option dsn_from main "string&!!" "see below"
15628 .cindex "&'From:'& header line" "in bounces"
15629 .cindex "bounce messages" "&'From:'& line, specifying"
15630 This option can be used to vary the contents of &'From:'& header lines in
15631 bounces and other automatically generated messages (&"Delivery Status
15632 Notifications"& &-- hence the name of the option). The default setting is:
15633 .code
15634 dsn_from = Mail Delivery System <Mailer-Daemon@$qualify_domain>
15635 .endd
15636 The value is expanded every time it is needed. If the expansion fails, a
15637 panic is logged, and the default value is used.
15638
15639 .option envelope_to_remove main boolean true
15640 .cindex "&'Envelope-to:'& header line"
15641 Exim's transports have an option for adding an &'Envelope-to:'& header to a
15642 message when it is delivered, in exactly the same way as &'Return-path:'& is
15643 handled. &'Envelope-to:'& records the original recipient address from the
15644 message's envelope that caused the delivery to happen. Such headers should not
15645 be present in incoming messages, and this option causes them to be removed at
15646 the time the message is received, to avoid any problems that might occur when a
15647 delivered message is subsequently sent on to some other recipient.
15648
15649
15650 .option errors_copy main "string list&!!" unset
15651 .cindex "bounce message" "copy to other address"
15652 .cindex "copy of bounce message"
15653 Setting this option causes Exim to send bcc copies of bounce messages that it
15654 generates to other addresses. &*Note*&: This does not apply to bounce messages
15655 coming from elsewhere. The value of the option is a colon-separated list of
15656 items. Each item consists of a pattern, terminated by white space, followed by
15657 a comma-separated list of email addresses. If a pattern contains spaces, it
15658 must be enclosed in double quotes.
15659
15660 Each pattern is processed in the same way as a single item in an address list
15661 (see section &<<SECTaddresslist>>&). When a pattern matches the recipient of
15662 the bounce message, the message is copied to the addresses on the list. The
15663 items are scanned in order, and once a matching one is found, no further items
15664 are examined. For example:
15665 .code
15666 errors_copy = spqr@mydomain   postmaster@mydomain.example :\
15667               rqps@mydomain   hostmaster@mydomain.example,\
15668                               postmaster@mydomain.example
15669 .endd
15670 .vindex "&$domain$&"
15671 .vindex "&$local_part$&"
15672 The address list is expanded before use. The expansion variables &$local_part$&
15673 and &$domain$& are set from the original recipient of the error message, and if
15674 there was any wildcard matching in the pattern, the expansion
15675 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%errors_copy%&"
15676 variables &$0$&, &$1$&, etc. are set in the normal way.
15677
15678
15679 .option errors_reply_to main string unset
15680 .cindex "bounce message" "&'Reply-to:'& in"
15681 By default, Exim's bounce and delivery warning messages contain the header line
15682 .display
15683 &`From: Mail Delivery System <Mailer-Daemon@`&&'qualify-domain'&&`>`&
15684 .endd
15685 .oindex &%quota_warn_message%&
15686 where &'qualify-domain'& is the value of the &%qualify_domain%& option.
15687 A warning message that is generated by the &%quota_warn_message%& option in an
15688 &(appendfile)& transport may contain its own &'From:'& header line that
15689 overrides the default.
15690
15691 Experience shows that people reply to bounce messages. If the
15692 &%errors_reply_to%& option is set, a &'Reply-To:'& header is added to bounce
15693 and warning messages. For example:
15694 .code
15695 errors_reply_to = postmaster@my.domain.example
15696 .endd
15697 The value of the option is not expanded. It must specify a valid RFC 2822
15698 address. However, if a warning message that is generated by the
15699 &%quota_warn_message%& option in an &(appendfile)& transport contain its
15700 own &'Reply-To:'& header line, the value of the &%errors_reply_to%& option is
15701 not used.
15702
15703
15704 .option event_action main string&!! unset
15705 .cindex events
15706 This option declares a string to be expanded for Exim's events mechanism.
15707 For details see chapter &<<CHAPevents>>&.
15708
15709
15710 .option exim_group main string "compile-time configured"
15711 .cindex "gid (group id)" "Exim's own"
15712 .cindex "Exim group"
15713 This option changes the gid under which Exim runs when it gives up root
15714 privilege. The default value is compiled into the binary. The value of this
15715 option is used only when &%exim_user%& is also set. Unless it consists entirely
15716 of digits, the string is looked up using &[getgrnam()]&, and failure causes a
15717 configuration error. See chapter &<<CHAPsecurity>>& for a discussion of
15718 security issues.
15719
15720
15721 .option exim_path main string "see below"
15722 .cindex "Exim binary, path name"
15723 This option specifies the path name of the Exim binary, which is used when Exim
15724 needs to re-exec itself. The default is set up to point to the file &'exim'& in
15725 the directory configured at compile time by the BIN_DIRECTORY setting. It
15726 is necessary to change &%exim_path%& if, exceptionally, Exim is run from some
15727 other place.
15728 &*Warning*&: Do not use a macro to define the value of this option, because
15729 you will break those Exim utilities that scan the configuration file to find
15730 where the binary is. (They then use the &%-bP%& option to extract option
15731 settings such as the value of &%spool_directory%&.)
15732
15733
15734 .option exim_user main string "compile-time configured"
15735 .cindex "uid (user id)" "Exim's own"
15736 .cindex "Exim user"
15737 This option changes the uid under which Exim runs when it gives up root
15738 privilege. The default value is compiled into the binary. Ownership of the run
15739 time configuration file and the use of the &%-C%& and &%-D%& command line
15740 options is checked against the values in the binary, not what is set here.
15741
15742 Unless it consists entirely of digits, the string is looked up using
15743 &[getpwnam()]&, and failure causes a configuration error. If &%exim_group%& is
15744 not also supplied, the gid is taken from the result of &[getpwnam()]& if it is
15745 used. See chapter &<<CHAPsecurity>>& for a discussion of security issues.
15746
15747
15748 .option exim_version main string "current version"
15749 .cindex "Exim version"
15750 .cindex customizing "version number"
15751 .cindex "version number of Exim" override
15752 This option overrides the &$version_number$&/&$exim_version$& that Exim reports in
15753 various places.  Use with care; this may fool stupid security scanners.
15754
15755
15756 .option extra_local_interfaces main "string list" unset
15757 This option defines network interfaces that are to be considered local when
15758 routing, but which are not used for listening by the daemon. See section
15759 &<<SECTreclocipadd>>& for details.
15760
15761
15762 . Allow this long option name to split; give it unsplit as a fifth argument
15763 . for the automatic .oindex that is generated by .option.
15764
15765 .option "extract_addresses_remove_arguments" main boolean true &&&
15766          extract_addresses_remove_arguments
15767 .oindex "&%-t%&"
15768 .cindex "command line" "addresses with &%-t%&"
15769 .cindex "Sendmail compatibility" "&%-t%& option"
15770 According to some Sendmail documentation (Sun, IRIX, HP-UX), if any addresses
15771 are present on the command line when the &%-t%& option is used to build an
15772 envelope from a message's &'To:'&, &'Cc:'& and &'Bcc:'& headers, the command
15773 line addresses are removed from the recipients list. This is also how Smail
15774 behaves. However, other Sendmail documentation (the O'Reilly book) states that
15775 command line addresses are added to those obtained from the header lines. When
15776 &%extract_addresses_remove_arguments%& is true (the default), Exim subtracts
15777 argument headers. If it is set false, Exim adds rather than removes argument
15778 addresses.
15779
15780
15781 .option finduser_retries main integer 0
15782 .cindex "NIS, retrying user lookups"
15783 On systems running NIS or other schemes in which user and group information is
15784 distributed from a remote system, there can be times when &[getpwnam()]& and
15785 related functions fail, even when given valid data, because things time out.
15786 Unfortunately these failures cannot be distinguished from genuine &"not found"&
15787 errors. If &%finduser_retries%& is set greater than zero, Exim will try that
15788 many extra times to find a user or a group, waiting for one second between
15789 retries.
15790
15791 .cindex "&_/etc/passwd_&" "multiple reading of"
15792 You should not set this option greater than zero if your user information is in
15793 a traditional &_/etc/passwd_& file, because it will cause Exim needlessly to
15794 search the file multiple times for non-existent users, and also cause delay.
15795
15796
15797
15798 .option freeze_tell main "string list, comma separated" unset
15799 .cindex "freezing messages" "sending a message when freezing"
15800 On encountering certain errors, or when configured to do so in a system filter,
15801 ACL, or special router, Exim freezes a message. This means that no further
15802 delivery attempts take place until an administrator thaws the message, or the
15803 &%auto_thaw%&, &%ignore_bounce_errors_after%&, or &%timeout_frozen_after%&
15804 feature cause it to be processed. If &%freeze_tell%& is set, Exim generates a
15805 warning message whenever it freezes something, unless the message it is
15806 freezing is a locally-generated bounce message. (Without this exception there
15807 is the possibility of looping.) The warning message is sent to the addresses
15808 supplied as the comma-separated value of this option. If several of the
15809 message's addresses cause freezing, only a single message is sent. If the
15810 freezing was automatic, the reason(s) for freezing can be found in the message
15811 log. If you configure freezing in a filter or ACL, you must arrange for any
15812 logging that you require.
15813
15814
15815 .option gecos_name main string&!! unset
15816 .cindex "HP-UX"
15817 .cindex "&""gecos""& field, parsing"
15818 Some operating systems, notably HP-UX, use the &"gecos"& field in the system
15819 password file to hold other information in addition to users' real names. Exim
15820 looks up this field for use when it is creating &'Sender:'& or &'From:'&
15821 headers. If either &%gecos_pattern%& or &%gecos_name%& are unset, the contents
15822 of the field are used unchanged, except that, if an ampersand is encountered,
15823 it is replaced by the user's login name with the first character forced to
15824 upper case, since this is a convention that is observed on many systems.
15825
15826 When these options are set, &%gecos_pattern%& is treated as a regular
15827 expression that is to be applied to the field (again with && replaced by the
15828 login name), and if it matches, &%gecos_name%& is expanded and used as the
15829 user's name.
15830
15831 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%gecos_name%&"
15832 Numeric variables such as &$1$&, &$2$&, etc. can be used in the expansion to
15833 pick up sub-fields that were matched by the pattern. In HP-UX, where the user's
15834 name terminates at the first comma, the following can be used:
15835 .code
15836 gecos_pattern = ([^,]*)
15837 gecos_name = $1
15838 .endd
15839
15840 .option gecos_pattern main string unset
15841 See &%gecos_name%& above.
15842
15843
15844 .option gnutls_compat_mode main boolean unset
15845 This option controls whether GnuTLS is used in compatibility mode in an Exim
15846 server. This reduces security slightly, but improves interworking with older
15847 implementations of TLS.
15848
15849
15850 .option gnutls_allow_auto_pkcs11 main boolean unset
15851 This option will let GnuTLS (2.12.0 or later) autoload PKCS11 modules with
15852 the p11-kit configuration files in &_/etc/pkcs11/modules/_&.
15853
15854 See
15855 &url(https://www.gnutls.org/manual/gnutls.html#Smart-cards-and-HSMs)
15856 for documentation.
15857
15858
15859
15860 .option headers_charset main string "see below"
15861 This option sets a default character set for translating from encoded MIME
15862 &"words"& in header lines, when referenced by an &$h_xxx$& expansion item. The
15863 default is the value of HEADERS_CHARSET in &_Local/Makefile_&. The
15864 ultimate default is ISO-8859-1. For more details see the description of header
15865 insertions in section &<<SECTexpansionitems>>&.
15866
15867
15868
15869 .option header_maxsize main integer "see below"
15870 .cindex "header section" "maximum size of"
15871 .cindex "limit" "size of message header section"
15872 This option controls the overall maximum size of a message's header
15873 section. The default is the value of HEADER_MAXSIZE in
15874 &_Local/Makefile_&; the default for that is 1M. Messages with larger header
15875 sections are rejected.
15876
15877
15878 .option header_line_maxsize main integer 0
15879 .cindex "header lines" "maximum size of"
15880 .cindex "limit" "size of one header line"
15881 This option limits the length of any individual header line in a message, after
15882 all the continuations have been joined together. Messages with individual
15883 header lines that are longer than the limit are rejected. The default value of
15884 zero means &"no limit"&.
15885
15886
15887
15888
15889 .option helo_accept_junk_hosts main "host list&!!" unset
15890 .cindex "HELO" "accepting junk data"
15891 .cindex "EHLO" "accepting junk data"
15892 Exim checks the syntax of HELO and EHLO commands for incoming SMTP
15893 mail, and gives an error response for invalid data. Unfortunately, there are
15894 some SMTP clients that send syntactic junk. They can be accommodated by setting
15895 this option. Note that this is a syntax check only. See &%helo_verify_hosts%&
15896 if you want to do semantic checking.
15897 See also &%helo_allow_chars%& for a way of extending the permitted character
15898 set.
15899
15900
15901 .option helo_allow_chars main string unset
15902 .cindex "HELO" "underscores in"
15903 .cindex "EHLO" "underscores in"
15904 .cindex "underscore in EHLO/HELO"
15905 This option can be set to a string of rogue characters that are permitted in
15906 all EHLO and HELO names in addition to the standard letters, digits,
15907 hyphens, and dots. If you really must allow underscores, you can set
15908 .code
15909 helo_allow_chars = _
15910 .endd
15911 Note that the value is one string, not a list.
15912
15913
15914 .option helo_lookup_domains main "domain list&!!" &`@:@[]`&
15915 .cindex "HELO" "forcing reverse lookup"
15916 .cindex "EHLO" "forcing reverse lookup"
15917 If the domain given by a client in a HELO or EHLO command matches this
15918 list, a reverse lookup is done in order to establish the host's true name. The
15919 default forces a lookup if the client host gives the server's name or any of
15920 its IP addresses (in brackets), something that broken clients have been seen to
15921 do.
15922
15923
15924 .option helo_try_verify_hosts main "host list&!!" unset
15925 .cindex "HELO verifying" "optional"
15926 .cindex "EHLO" "verifying, optional"
15927 By default, Exim just checks the syntax of HELO and EHLO commands (see
15928 &%helo_accept_junk_hosts%& and &%helo_allow_chars%&). However, some sites like
15929 to do more extensive checking of the data supplied by these commands. The ACL
15930 condition &`verify = helo`& is provided to make this possible.
15931 Formerly, it was necessary also to set this option (&%helo_try_verify_hosts%&)
15932 to force the check to occur. From release 4.53 onwards, this is no longer
15933 necessary. If the check has not been done before &`verify = helo`& is
15934 encountered, it is done at that time. Consequently, this option is obsolete.
15935 Its specification is retained here for backwards compatibility.
15936
15937 When an EHLO or HELO command is received, if the calling host matches
15938 &%helo_try_verify_hosts%&, Exim checks that the host name given in the HELO or
15939 EHLO command either:
15940
15941 .ilist
15942 is an IP literal matching the calling address of the host, or
15943 .next
15944 .cindex "DNS" "reverse lookup"
15945 .cindex "reverse DNS lookup"
15946 matches the host name that Exim obtains by doing a reverse lookup of the
15947 calling host address, or
15948 .next
15949 when looked up in DNS yields the calling host address.
15950 .endlist
15951
15952 However, the EHLO or HELO command is not rejected if any of the checks
15953 fail. Processing continues, but the result of the check is remembered, and can
15954 be detected later in an ACL by the &`verify = helo`& condition.
15955
15956 If DNS was used for successful verification, the variable
15957 .cindex "DNS" "DNSSEC"
15958 &$helo_verify_dnssec$& records the DNSSEC status of the lookups.
15959
15960 .option helo_verify_hosts main "host list&!!" unset
15961 .cindex "HELO verifying" "mandatory"
15962 .cindex "EHLO" "verifying, mandatory"
15963 Like &%helo_try_verify_hosts%&, this option is obsolete, and retained only for
15964 backwards compatibility. For hosts that match this option, Exim checks the host
15965 name given in the HELO or EHLO in the same way as for
15966 &%helo_try_verify_hosts%&. If the check fails, the HELO or EHLO command is
15967 rejected with a 550 error, and entries are written to the main and reject logs.
15968 If a MAIL command is received before EHLO or HELO, it is rejected with a 503
15969 error.
15970
15971 .option hold_domains main "domain list&!!" unset
15972 .cindex "domain" "delaying delivery"
15973 .cindex "delivery" "delaying certain domains"
15974 This option allows mail for particular domains to be held in the queue
15975 manually. The option is overridden if a message delivery is forced with the
15976 &%-M%&, &%-qf%&, &%-Rf%& or &%-Sf%& options, and also while testing or
15977 verifying addresses using &%-bt%& or &%-bv%&. Otherwise, if a domain matches an
15978 item in &%hold_domains%&, no routing or delivery for that address is done, and
15979 it is deferred every time the message is looked at.
15980
15981 This option is intended as a temporary operational measure for delaying the
15982 delivery of mail while some problem is being sorted out, or some new
15983 configuration tested. If you just want to delay the processing of some
15984 domains until a queue run occurs, you should use &%queue_domains%& or
15985 &%queue_smtp_domains%&, not &%hold_domains%&.
15986
15987 A setting of &%hold_domains%& does not override Exim's code for removing
15988 messages from the queue if they have been there longer than the longest retry
15989 time in any retry rule. If you want to hold messages for longer than the normal
15990 retry times, insert a dummy retry rule with a long retry time.
15991
15992
15993 .option host_lookup main "host list&!!" unset
15994 .cindex "host name" "lookup, forcing"
15995 Exim does not look up the name of a calling host from its IP address unless it
15996 is required to compare against some host list, or the host matches
15997 &%helo_try_verify_hosts%& or &%helo_verify_hosts%&, or the host matches this
15998 option (which normally contains IP addresses rather than host names). The
15999 default configuration file contains
16000 .code
16001 host_lookup = *
16002 .endd
16003 which causes a lookup to happen for all hosts. If the expense of these lookups
16004 is felt to be too great, the setting can be changed or removed.
16005
16006 After a successful reverse lookup, Exim does a forward lookup on the name it
16007 has obtained, to verify that it yields the IP address that it started with. If
16008 this check fails, Exim behaves as if the name lookup failed.
16009
16010 .vindex "&$host_lookup_failed$&"
16011 .vindex "&$sender_host_name$&"
16012 After any kind of failure, the host name (in &$sender_host_name$&) remains
16013 unset, and &$host_lookup_failed$& is set to the string &"1"&. See also
16014 &%dns_again_means_nonexist%&, &%helo_lookup_domains%&, and
16015 &`verify = reverse_host_lookup`& in ACLs.
16016
16017
16018 .option host_lookup_order main "string list" &`bydns:byaddr`&
16019 This option specifies the order of different lookup methods when Exim is trying
16020 to find a host name from an IP address. The default is to do a DNS lookup
16021 first, and then to try a local lookup (using &[gethostbyaddr()]& or equivalent)
16022 if that fails. You can change the order of these lookups, or omit one entirely,
16023 if you want.
16024
16025 &*Warning*&: The &"byaddr"& method does not always yield aliases when there are
16026 multiple PTR records in the DNS and the IP address is not listed in
16027 &_/etc/hosts_&. Different operating systems give different results in this
16028 case. That is why the default tries a DNS lookup first.
16029
16030
16031
16032 .option host_reject_connection main "host list&!!" unset
16033 .cindex "host" "rejecting connections from"
16034 If this option is set, incoming SMTP calls from the hosts listed are rejected
16035 as soon as the connection is made.
16036 This option is obsolete, and retained only for backward compatibility, because
16037 nowadays the ACL specified by &%acl_smtp_connect%& can also reject incoming
16038 connections immediately.
16039
16040 The ability to give an immediate rejection (either by this option or using an
16041 ACL) is provided for use in unusual cases. Many hosts will just try again,
16042 sometimes without much delay. Normally, it is better to use an ACL to reject
16043 incoming messages at a later stage, such as after RCPT commands. See
16044 chapter &<<CHAPACL>>&.
16045
16046
16047 .option hosts_connection_nolog main "host list&!!" unset
16048 .cindex "host" "not logging connections from"
16049 This option defines a list of hosts for which connection logging does not
16050 happen, even though the &%smtp_connection%& log selector is set. For example,
16051 you might want not to log SMTP connections from local processes, or from
16052 127.0.0.1, or from your local LAN. This option is consulted in the main loop of
16053 the daemon; you should therefore strive to restrict its value to a short inline
16054 list of IP addresses and networks. To disable logging SMTP connections from
16055 local processes, you must create a host list with an empty item. For example:
16056 .code
16057 hosts_connection_nolog = :
16058 .endd
16059 If the &%smtp_connection%& log selector is not set, this option has no effect.
16060
16061
16062
16063 .option hosts_proxy main "host list&!!" unset
16064 .cindex proxy "proxy protocol"
16065 This option enables use of Proxy Protocol proxies for incoming
16066 connections.  For details see section &<<SECTproxyInbound>>&.
16067
16068
16069 .option hosts_treat_as_local main "domain list&!!" unset
16070 .cindex "local host" "domains treated as"
16071 .cindex "host" "treated as local"
16072 If this option is set, any host names that match the domain list are treated as
16073 if they were the local host when Exim is scanning host lists obtained from MX
16074 records
16075 or other sources. Note that the value of this option is a domain list, not a
16076 host list, because it is always used to check host names, not IP addresses.
16077
16078 This option also applies when Exim is matching the special items
16079 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`& in a domain list (see
16080 section &<<SECTdomainlist>>&), and when checking the &%hosts%& option in the
16081 &(smtp)& transport for the local host (see the &%allow_localhost%& option in
16082 that transport). See also &%local_interfaces%&, &%extra_local_interfaces%&, and
16083 chapter &<<CHAPinterfaces>>&, which contains a discussion about local network
16084 interfaces and recognizing the local host.
16085
16086
16087 .option ibase_servers main "string list" unset
16088 .cindex "InterBase" "server list"
16089 This option provides a list of InterBase servers and associated connection data,
16090 to be used in conjunction with &(ibase)& lookups (see section &<<SECID72>>&).
16091 The option is available only if Exim has been built with InterBase support.
16092
16093
16094
16095 .option ignore_bounce_errors_after main time 10w
16096 .cindex "bounce message" "discarding"
16097 .cindex "discarding bounce message"
16098 This option affects the processing of bounce messages that cannot be delivered,
16099 that is, those that suffer a permanent delivery failure. (Bounce messages that
16100 suffer temporary delivery failures are of course retried in the usual way.)
16101
16102 After a permanent delivery failure, bounce messages are frozen,
16103 because there is no sender to whom they can be returned. When a frozen bounce
16104 message has been in the queue for more than the given time, it is unfrozen at
16105 the next queue run, and a further delivery is attempted. If delivery fails
16106 again, the bounce message is discarded. This makes it possible to keep failed
16107 bounce messages around for a shorter time than the normal maximum retry time
16108 for frozen messages. For example,
16109 .code
16110 ignore_bounce_errors_after = 12h
16111 .endd
16112 retries failed bounce message deliveries after 12 hours, discarding any further
16113 failures. If the value of this option is set to a zero time period, bounce
16114 failures are discarded immediately. Setting a very long time (as in the default
16115 value) has the effect of disabling this option. For ways of automatically
16116 dealing with other kinds of frozen message, see &%auto_thaw%& and
16117 &%timeout_frozen_after%&.
16118
16119
16120 .option ignore_fromline_hosts main "host list&!!" unset
16121 .cindex "&""From""& line"
16122 .cindex "UUCP" "&""From""& line"
16123 Some broken SMTP clients insist on sending a UUCP-like &"From&~"& line before
16124 the headers of a message. By default this is treated as the start of the
16125 message's body, which means that any following headers are not recognized as
16126 such. Exim can be made to ignore it by setting &%ignore_fromline_hosts%& to
16127 match those hosts that insist on sending it. If the sender is actually a local
16128 process rather than a remote host, and is using &%-bs%& to inject the messages,
16129 &%ignore_fromline_local%& must be set to achieve this effect.
16130
16131
16132 .option ignore_fromline_local main boolean false
16133 See &%ignore_fromline_hosts%& above.
16134
16135 .option keep_environment main "string list" unset
16136 .cindex "environment" "values from"
16137 This option contains a string list of environment variables to keep.
16138 You have to trust these variables or you have to be sure that
16139 these variables do not impose any security risk. Keep in mind that
16140 during the startup phase Exim is running with an effective UID 0 in most
16141 installations. As the default value is an empty list, the default
16142 environment for using libraries, running embedded Perl code, or running
16143 external binaries is empty, and does not not even contain PATH or HOME.
16144
16145 Actually the list is interpreted as a list of patterns
16146 (&<<SECTlistexpand>>&), except that it is not expanded first.
16147
16148 WARNING: Macro substitution is still done first, so having a macro
16149 FOO and having FOO_HOME in your &%keep_environment%& option may have
16150 unexpected results. You may work around this using a regular expression
16151 that does not match the macro name: ^[F]OO_HOME$.
16152
16153 Current versions of Exim issue a warning during startup if you do not mention
16154 &%keep_environment%& in your runtime configuration file and if your
16155 current environment is not empty. Future versions may not issue that warning
16156 anymore.
16157
16158 See the &%add_environment%& main config option for a way to set
16159 environment variables to a fixed value.  The environment for &(pipe)&
16160 transports is handled separately, see section &<<SECTpipeenv>>& for
16161 details.
16162
16163
16164 .option keep_malformed main time 4d
16165 This option specifies the length of time to keep messages whose spool files
16166 have been corrupted in some way. This should, of course, never happen. At the
16167 next attempt to deliver such a message, it gets removed. The incident is
16168 logged.
16169
16170
16171 .option ldap_ca_cert_dir main string unset
16172 .cindex "LDAP", "TLS CA certificate directory"
16173 .cindex certificate "directory for LDAP"
16174 This option indicates which directory contains CA certificates for verifying
16175 a TLS certificate presented by an LDAP server.
16176 While Exim does not provide a default value, your SSL library may.
16177 Analogous to &%tls_verify_certificates%& but as a client-side option for LDAP
16178 and constrained to be a directory.
16179
16180
16181 .option ldap_ca_cert_file main string unset
16182 .cindex "LDAP", "TLS CA certificate file"
16183 .cindex certificate "file for LDAP"
16184 This option indicates which file contains CA certificates for verifying
16185 a TLS certificate presented by an LDAP server.
16186 While Exim does not provide a default value, your SSL library may.
16187 Analogous to &%tls_verify_certificates%& but as a client-side option for LDAP
16188 and constrained to be a file.
16189
16190
16191 .option ldap_cert_file main string unset
16192 .cindex "LDAP" "TLS client certificate file"
16193 .cindex certificate "file for LDAP"
16194 This option indicates which file contains an TLS client certificate which
16195 Exim should present to the LDAP server during TLS negotiation.
16196 Should be used together with &%ldap_cert_key%&.
16197
16198
16199 .option ldap_cert_key main string unset
16200 .cindex "LDAP" "TLS client key file"
16201 .cindex certificate "key for LDAP"
16202 This option indicates which file contains the secret/private key to use
16203 to prove identity to the LDAP server during TLS negotiation.
16204 Should be used together with &%ldap_cert_file%&, which contains the
16205 identity to be proven.
16206
16207
16208 .option ldap_cipher_suite main string unset
16209 .cindex "LDAP" "TLS cipher suite"
16210 This controls the TLS cipher-suite negotiation during TLS negotiation with
16211 the LDAP server.  See &<<SECTreqciphssl>>& for more details of the format of
16212 cipher-suite options with OpenSSL (as used by LDAP client libraries).
16213
16214
16215 .option ldap_default_servers main "string list" unset
16216 .cindex "LDAP" "default servers"
16217 This option provides a list of LDAP servers which are tried in turn when an
16218 LDAP query does not contain a server. See section &<<SECTforldaque>>& for
16219 details of LDAP queries. This option is available only when Exim has been built
16220 with LDAP support.
16221
16222
16223 .option ldap_require_cert main string unset.
16224 .cindex "LDAP" "policy for LDAP server TLS cert presentation"
16225 This should be one of the values "hard", "demand", "allow", "try" or "never".
16226 A value other than one of these is interpreted as "never".
16227 See the entry "TLS_REQCERT" in your system man page for ldap.conf(5).
16228 Although Exim does not set a default, the LDAP library probably defaults
16229 to hard/demand.
16230
16231
16232 .option ldap_start_tls main boolean false
16233 .cindex "LDAP" "whether or not to negotiate TLS"
16234 If set, Exim will attempt to negotiate TLS with the LDAP server when
16235 connecting on a regular LDAP port.  This is the LDAP equivalent of SMTP's
16236 "STARTTLS".  This is distinct from using "ldaps", which is the LDAP form
16237 of SSL-on-connect.
16238 In the event of failure to negotiate TLS, the action taken is controlled
16239 by &%ldap_require_cert%&.
16240 This option is ignored for &`ldapi`& connections.
16241
16242
16243 .option ldap_version main integer unset
16244 .cindex "LDAP" "protocol version, forcing"
16245 This option can be used to force Exim to set a specific protocol version for
16246 LDAP. If it option is unset, it is shown by the &%-bP%& command line option as
16247 -1. When this is the case, the default is 3 if LDAP_VERSION3 is defined in
16248 the LDAP headers; otherwise it is 2. This option is available only when Exim
16249 has been built with LDAP support.
16250
16251
16252
16253 .option local_from_check main boolean true
16254 .cindex "&'Sender:'& header line" "disabling addition of"
16255 .cindex "&'From:'& header line" "disabling checking of"
16256 When a message is submitted locally (that is, not over a TCP/IP connection) by
16257 an untrusted user, Exim removes any existing &'Sender:'& header line, and
16258 checks that the &'From:'& header line matches the login of the calling user and
16259 the domain specified by &%qualify_domain%&.
16260
16261 &*Note*&: An unqualified address (no domain) in the &'From:'& header in a
16262 locally submitted message is automatically qualified by Exim, unless the
16263 &%-bnq%& command line option is used.
16264
16265 You can use &%local_from_prefix%& and &%local_from_suffix%& to permit affixes
16266 on the local part. If the &'From:'& header line does not match, Exim adds a
16267 &'Sender:'& header with an address constructed from the calling user's login
16268 and the default qualify domain.
16269
16270 If &%local_from_check%& is set false, the &'From:'& header check is disabled,
16271 and no &'Sender:'& header is ever added. If, in addition, you want to retain
16272 &'Sender:'& header lines supplied by untrusted users, you must also set
16273 &%local_sender_retain%& to be true.
16274
16275 .cindex "envelope from"
16276 .cindex "envelope sender"
16277 These options affect only the header lines in the message. The envelope sender
16278 is still forced to be the login id at the qualify domain unless
16279 &%untrusted_set_sender%& permits the user to supply an envelope sender.
16280
16281 For messages received over TCP/IP, an ACL can specify &"submission mode"& to
16282 request similar header line checking. See section &<<SECTthesenhea>>&, which
16283 has more details about &'Sender:'& processing.
16284
16285
16286
16287
16288 .option local_from_prefix main string unset
16289 When Exim checks the &'From:'& header line of locally submitted messages for
16290 matching the login id (see &%local_from_check%& above), it can be configured to
16291 ignore certain prefixes and suffixes in the local part of the address. This is
16292 done by setting &%local_from_prefix%& and/or &%local_from_suffix%& to
16293 appropriate lists, in the same form as the &%local_part_prefix%& and
16294 &%local_part_suffix%& router options (see chapter &<<CHAProutergeneric>>&). For
16295 example, if
16296 .code
16297 local_from_prefix = *-
16298 .endd
16299 is set, a &'From:'& line containing
16300 .code
16301 From: anything-user@your.domain.example
16302 .endd
16303 will not cause a &'Sender:'& header to be added if &'user@your.domain.example'&
16304 matches the actual sender address that is constructed from the login name and
16305 qualify domain.
16306
16307
16308 .option local_from_suffix main string unset
16309 See &%local_from_prefix%& above.
16310
16311
16312 .option local_interfaces main "string list" "see below"
16313 This option controls which network interfaces are used by the daemon for
16314 listening; they are also used to identify the local host when routing. Chapter
16315 &<<CHAPinterfaces>>& contains a full description of this option and the related
16316 options &%daemon_smtp_ports%&, &%extra_local_interfaces%&,
16317 &%hosts_treat_as_local%&, and &%tls_on_connect_ports%&. The default value for
16318 &%local_interfaces%& is
16319 .code
16320 local_interfaces = 0.0.0.0
16321 .endd
16322 when Exim is built without IPv6 support; otherwise it is
16323 .code
16324 local_interfaces = <; ::0 ; 0.0.0.0
16325 .endd
16326
16327 .option local_scan_timeout main time 5m
16328 .cindex "timeout" "for &[local_scan()]& function"
16329 .cindex "&[local_scan()]& function" "timeout"
16330 This timeout applies to the &[local_scan()]& function (see chapter
16331 &<<CHAPlocalscan>>&). Zero means &"no timeout"&. If the timeout is exceeded,
16332 the incoming message is rejected with a temporary error if it is an SMTP
16333 message. For a non-SMTP message, the message is dropped and Exim ends with a
16334 non-zero code. The incident is logged on the main and reject logs.
16335
16336
16337
16338 .option local_sender_retain main boolean false
16339 .cindex "&'Sender:'& header line" "retaining from local submission"
16340 When a message is submitted locally (that is, not over a TCP/IP connection) by
16341 an untrusted user, Exim removes any existing &'Sender:'& header line. If you
16342 do not want this to happen, you must set &%local_sender_retain%&, and you must
16343 also set &%local_from_check%& to be false (Exim will complain if you do not).
16344 See also the ACL modifier &`control = suppress_local_fixups`&. Section
16345 &<<SECTthesenhea>>& has more details about &'Sender:'& processing.
16346
16347
16348
16349
16350 .option localhost_number main string&!! unset
16351 .cindex "host" "locally unique number for"
16352 .cindex "message ids" "with multiple hosts"
16353 .vindex "&$localhost_number$&"
16354 Exim's message ids are normally unique only within the local host. If
16355 uniqueness among a set of hosts is required, each host must set a different
16356 value for the &%localhost_number%& option. The string is expanded immediately
16357 after reading the configuration file (so that a number can be computed from the
16358 host name, for example) and the result of the expansion must be a number in the
16359 range 0&--16 (or 0&--10 on operating systems with case-insensitive file
16360 systems). This is available in subsequent string expansions via the variable
16361 &$localhost_number$&. When &%localhost_number is set%&, the final two
16362 characters of the message id, instead of just being a fractional part of the
16363 time, are computed from the time and the local host number as described in
16364 section &<<SECTmessiden>>&.
16365
16366
16367
16368 .option log_file_path main "string list&!!" "set at compile time"
16369 .cindex "log" "file path for"
16370 This option sets the path which is used to determine the names of Exim's log
16371 files, or indicates that logging is to be to syslog, or both. It is expanded
16372 when Exim is entered, so it can, for example, contain a reference to the host
16373 name. If no specific path is set for the log files at compile or runtime,
16374 or if the option is unset at runtime (i.e.  &`log_file_path = `&)
16375 they are written in a sub-directory called &_log_& in Exim's spool directory.
16376 A path must start with a slash.
16377 To send to syslog, use the word &"syslog"&.
16378 Chapter &<<CHAPlog>>& contains further details about Exim's logging, and
16379 section &<<SECTwhelogwri>>& describes how the contents of &%log_file_path%& are
16380 used. If this string is fixed at your installation (contains no expansion
16381 variables) it is recommended that you do not set this option in the
16382 configuration file, but instead supply the path using LOG_FILE_PATH in
16383 &_Local/Makefile_& so that it is available to Exim for logging errors detected
16384 early on &-- in particular, failure to read the configuration file.
16385
16386
16387 .option log_selector main string unset
16388 .cindex "log" "selectors"
16389 This option can be used to reduce or increase the number of things that Exim
16390 writes to its log files. Its argument is made up of names preceded by plus or
16391 minus characters. For example:
16392 .code
16393 log_selector = +arguments -retry_defer
16394 .endd
16395 A list of possible names and what they control is given in the chapter on
16396 logging, in section &<<SECTlogselector>>&.
16397
16398
16399 .option log_timezone main boolean false
16400 .cindex "log" "timezone for entries"
16401 .vindex "&$tod_log$&"
16402 .vindex "&$tod_zone$&"
16403 By default, the timestamps on log lines are in local time without the
16404 timezone. This means that if your timezone changes twice a year, the timestamps
16405 in log lines are ambiguous for an hour when the clocks go back. One way of
16406 avoiding this problem is to set the timezone to UTC. An alternative is to set
16407 &%log_timezone%& true. This turns on the addition of the timezone offset to
16408 timestamps in log lines. Turning on this option can add quite a lot to the size
16409 of log files because each line is extended by 6 characters. Note that the
16410 &$tod_log$& variable contains the log timestamp without the zone, but there is
16411 another variable called &$tod_zone$& that contains just the timezone offset.
16412
16413
16414 .option lookup_open_max main integer 25
16415 .cindex "too many open files"
16416 .cindex "open files, too many"
16417 .cindex "file" "too many open"
16418 .cindex "lookup" "maximum open files"
16419 .cindex "limit" "open files for lookups"
16420 This option limits the number of simultaneously open files for single-key
16421 lookups that use regular files (that is, &(lsearch)&, &(dbm)&, and &(cdb)&).
16422 Exim normally keeps these files open during routing, because often the same
16423 file is required several times. If the limit is reached, Exim closes the least
16424 recently used file. Note that if you are using the &'ndbm'& library, it
16425 actually opens two files for each logical DBM database, though it still counts
16426 as one for the purposes of &%lookup_open_max%&. If you are getting &"too many
16427 open files"& errors with NDBM, you need to reduce the value of
16428 &%lookup_open_max%&.
16429
16430
16431 .option max_username_length main integer 0
16432 .cindex "length of login name"
16433 .cindex "user name" "maximum length"
16434 .cindex "limit" "user name length"
16435 Some operating systems are broken in that they truncate long arguments to
16436 &[getpwnam()]& to eight characters, instead of returning &"no such user"&. If
16437 this option is set greater than zero, any attempt to call &[getpwnam()]& with
16438 an argument that is longer behaves as if &[getpwnam()]& failed.
16439
16440
16441 .option message_body_newlines main bool false
16442 .cindex "message body" "newlines in variables"
16443 .cindex "newline" "in message body variables"
16444 .vindex "&$message_body$&"
16445 .vindex "&$message_body_end$&"
16446 By default, newlines in the message body are replaced by spaces when setting
16447 the &$message_body$& and &$message_body_end$& expansion variables. If this
16448 option is set true, this no longer happens.
16449
16450
16451 .option message_body_visible main integer 500
16452 .cindex "body of message" "visible size"
16453 .cindex "message body" "visible size"
16454 .vindex "&$message_body$&"
16455 .vindex "&$message_body_end$&"
16456 This option specifies how much of a message's body is to be included in the
16457 &$message_body$& and &$message_body_end$& expansion variables.
16458
16459
16460 .option message_id_header_domain main string&!! unset
16461 .cindex "&'Message-ID:'& header line"
16462 If this option is set, the string is expanded and used as the right hand side
16463 (domain) of the &'Message-ID:'& header that Exim creates if a
16464 locally-originated incoming message does not have one. &"Locally-originated"&
16465 means &"not received over TCP/IP."&
16466 Otherwise, the primary host name is used.
16467 Only letters, digits, dot and hyphen are accepted; any other characters are
16468 replaced by hyphens. If the expansion is forced to fail, or if the result is an
16469 empty string, the option is ignored.
16470
16471
16472 .option message_id_header_text main string&!! unset
16473 If this variable is set, the string is expanded and used to augment the text of
16474 the &'Message-id:'& header that Exim creates if a locally-originated incoming
16475 message does not have one. The text of this header is required by RFC 2822 to
16476 take the form of an address. By default, Exim uses its internal message id as
16477 the local part, and the primary host name as the domain. If this option is set,
16478 it is expanded, and provided the expansion is not forced to fail, and does not
16479 yield an empty string, the result is inserted into the header immediately
16480 before the @, separated from the internal message id by a dot. Any characters
16481 that are illegal in an address are automatically converted into hyphens. This
16482 means that variables such as &$tod_log$& can be used, because the spaces and
16483 colons will become hyphens.
16484
16485
16486 .option message_logs main boolean true
16487 .cindex "message logs" "disabling"
16488 .cindex "log" "message log; disabling"
16489 If this option is turned off, per-message log files are not created in the
16490 &_msglog_& spool sub-directory. This reduces the amount of disk I/O required by
16491 Exim, by reducing the number of files involved in handling a message from a
16492 minimum of four (header spool file, body spool file, delivery journal, and
16493 per-message log) to three. The other major I/O activity is Exim's main log,
16494 which is not affected by this option.
16495
16496
16497 .option message_size_limit main string&!! 50M
16498 .cindex "message" "size limit"
16499 .cindex "limit" "message size"
16500 .cindex "size" "of message, limit"
16501 This option limits the maximum size of message that Exim will process. The
16502 value is expanded for each incoming connection so, for example, it can be made
16503 to depend on the IP address of the remote host for messages arriving via
16504 TCP/IP. After expansion, the value must be a sequence of decimal digits,
16505 optionally followed by K or M.
16506
16507 &*Note*&: This limit cannot be made to depend on a message's sender or any
16508 other properties of an individual message, because it has to be advertised in
16509 the server's response to EHLO. String expansion failure causes a temporary
16510 error. A value of zero means no limit, but its use is not recommended. See also
16511 &%bounce_return_size_limit%&.
16512
16513 Incoming SMTP messages are failed with a 552 error if the limit is
16514 exceeded; locally-generated messages either get a stderr message or a delivery
16515 failure message to the sender, depending on the &%-oe%& setting. Rejection of
16516 an oversized message is logged in both the main and the reject logs. See also
16517 the generic transport option &%message_size_limit%&, which limits the size of
16518 message that an individual transport can process.
16519
16520 If you use a virus-scanner and set this option to to a value larger than the
16521 maximum size that your virus-scanner is configured to support, you may get
16522 failures triggered by large mails.  The right size to configure for the
16523 virus-scanner depends upon what data is passed and the options in use but it's
16524 probably safest to just set it to a little larger than this value.  E.g., with a
16525 default Exim message size of 50M and a default ClamAV StreamMaxLength of 10M,
16526 some problems may result.
16527
16528 A value of 0 will disable size limit checking; Exim will still advertise the
16529 SIZE extension in an EHLO response, but without a limit, so as to permit
16530 SMTP clients to still indicate the message size along with the MAIL verb.
16531
16532
16533 .option move_frozen_messages main boolean false
16534 .cindex "frozen messages" "moving"
16535 This option, which is available only if Exim has been built with the setting
16536 .code
16537 SUPPORT_MOVE_FROZEN_MESSAGES=yes
16538 .endd
16539 in &_Local/Makefile_&, causes frozen messages and their message logs to be
16540 moved from the &_input_& and &_msglog_& directories on the spool to &_Finput_&
16541 and &_Fmsglog_&, respectively. There is currently no support in Exim or the
16542 standard utilities for handling such moved messages, and they do not show up in
16543 lists generated by &%-bp%& or by the Exim monitor.
16544
16545
16546 .option mua_wrapper main boolean false
16547 Setting this option true causes Exim to run in a very restrictive mode in which
16548 it passes messages synchronously to a smart host. Chapter &<<CHAPnonqueueing>>&
16549 contains a full description of this facility.
16550
16551
16552
16553 .option mysql_servers main "string list" unset
16554 .cindex "MySQL" "server list"
16555 This option provides a list of MySQL servers and associated connection data, to
16556 be used in conjunction with &(mysql)& lookups (see section &<<SECID72>>&). The
16557 option is available only if Exim has been built with MySQL support.
16558
16559
16560 .option never_users main "string list&!!" unset
16561 This option is expanded just once, at the start of Exim's processing. Local
16562 message deliveries are normally run in processes that are setuid to the
16563 recipient, and remote deliveries are normally run under Exim's own uid and gid.
16564 It is usually desirable to prevent any deliveries from running as root, as a
16565 safety precaution.
16566
16567 When Exim is built, an option called FIXED_NEVER_USERS can be set to a
16568 list of users that must not be used for local deliveries. This list is fixed in
16569 the binary and cannot be overridden by the configuration file. By default, it
16570 contains just the single user name &"root"&. The &%never_users%& runtime option
16571 can be used to add more users to the fixed list.
16572
16573 If a message is to be delivered as one of the users on the fixed list or the
16574 &%never_users%& list, an error occurs, and delivery is deferred. A common
16575 example is
16576 .code
16577 never_users = root:daemon:bin
16578 .endd
16579 Including root is redundant if it is also on the fixed list, but it does no
16580 harm. This option overrides the &%pipe_as_creator%& option of the &(pipe)&
16581 transport driver.
16582
16583
16584 .new
16585 .option notifier_socket main string "$spool_directory/exim_daemon_notify"
16586 This option gives the name for a unix-domain socket on which the daemon
16587 listens for work and information-requests.
16588 Only installations running multiple daemons sharing a spool directory
16589 should need to modify the default.
16590
16591 The option is expanded before use.
16592 If the platform supports Linux-style abstract socket names, the result
16593 is used with a nul byte prefixed.
16594 Otherwise, it should be a full path name and use a directory accessible
16595 to Exim.
16596
16597 If the Exim command line uses a &%-oX%& option and does not use &%-oP%&
16598 then a notifier socket is not created.
16599 .wen
16600
16601
16602 .option openssl_options main "string list" "+no_sslv2 +no_sslv3 +single_dh_use +no_ticket +no_renegotiation"
16603 .cindex "OpenSSL "compatibility options"
16604 This option allows an administrator to adjust the SSL options applied
16605 by OpenSSL to connections.  It is given as a space-separated list of items,
16606 each one to be +added or -subtracted from the current value.
16607
16608 This option is only available if Exim is built against OpenSSL.  The values
16609 available for this option vary according to the age of your OpenSSL install.
16610 The &"all"& value controls a subset of flags which are available, typically
16611 the bug workaround options.  The &'SSL_CTX_set_options'& man page will
16612 list the values known on your system and Exim should support all the
16613 &"bug workaround"& options and many of the &"modifying"& options.  The Exim
16614 names lose the leading &"SSL_OP_"& and are lower-cased.
16615
16616 Note that adjusting the options can have severe impact upon the security of
16617 SSL as used by Exim.  It is possible to disable safety checks and shoot
16618 yourself in the foot in various unpleasant ways.  This option should not be
16619 adjusted lightly.  An unrecognised item will be detected at startup, by
16620 invoking Exim with the &%-bV%& flag.
16621
16622 The option affects Exim operating both as a server and as a client.
16623
16624 Historical note: prior to release 4.80, Exim defaulted this value to
16625 "+dont_insert_empty_fragments", which may still be needed for compatibility
16626 with some clients, but which lowers security by increasing exposure to
16627 some now infamous attacks.
16628
16629 Examples:
16630 .code
16631 # Make both old MS and old Eudora happy:
16632 openssl_options = -all +microsoft_big_sslv3_buffer \
16633                        +dont_insert_empty_fragments
16634
16635 # Disable older protocol versions:
16636 openssl_options = +no_sslv2 +no_sslv3
16637 .endd
16638
16639 Possible options may include:
16640 .ilist
16641 &`all`&
16642 .next
16643 &`allow_unsafe_legacy_renegotiation`&
16644 .next
16645 &`cipher_server_preference`&
16646 .next
16647 &`dont_insert_empty_fragments`&
16648 .next
16649 &`ephemeral_rsa`&
16650 .next
16651 &`legacy_server_connect`&
16652 .next
16653 &`microsoft_big_sslv3_buffer`&
16654 .next
16655 &`microsoft_sess_id_bug`&
16656 .next
16657 &`msie_sslv2_rsa_padding`&
16658 .next
16659 &`netscape_challenge_bug`&
16660 .next
16661 &`netscape_reuse_cipher_change_bug`&
16662 .next
16663 &`no_compression`&
16664 .next
16665 &`no_session_resumption_on_renegotiation`&
16666 .next
16667 &`no_sslv2`&
16668 .next
16669 &`no_sslv3`&
16670 .next
16671 &`no_ticket`&
16672 .next
16673 &`no_tlsv1`&
16674 .next
16675 &`no_tlsv1_1`&
16676 .next
16677 &`no_tlsv1_2`&
16678 .next
16679 &`safari_ecdhe_ecdsa_bug`&
16680 .next
16681 &`single_dh_use`&
16682 .next
16683 &`single_ecdh_use`&
16684 .next
16685 &`ssleay_080_client_dh_bug`&
16686 .next
16687 &`sslref2_reuse_cert_type_bug`&
16688 .next
16689 &`tls_block_padding_bug`&
16690 .next
16691 &`tls_d5_bug`&
16692 .next
16693 &`tls_rollback_bug`&
16694 .endlist
16695
16696 As an aside, the &`safari_ecdhe_ecdsa_bug`& item is a misnomer and affects
16697 all clients connecting using the MacOS SecureTransport TLS facility prior
16698 to MacOS 10.8.4, including email clients.  If you see old MacOS clients failing
16699 to negotiate TLS then this option value might help, provided that your OpenSSL
16700 release is new enough to contain this work-around.  This may be a situation
16701 where you have to upgrade OpenSSL to get buggy clients working.
16702
16703
16704 .option oracle_servers main "string list" unset
16705 .cindex "Oracle" "server list"
16706 This option provides a list of Oracle servers and associated connection data,
16707 to be used in conjunction with &(oracle)& lookups (see section &<<SECID72>>&).
16708 The option is available only if Exim has been built with Oracle support.
16709
16710
16711 .option percent_hack_domains main "domain list&!!" unset
16712 .cindex "&""percent hack""&"
16713 .cindex "source routing" "in email address"
16714 .cindex "address" "source-routed"
16715 The &"percent hack"& is the convention whereby a local part containing a
16716 percent sign is re-interpreted as a new email address, with the percent
16717 replaced by @. This is sometimes called &"source routing"&, though that term is
16718 also applied to RFC 2822 addresses that begin with an @ character. If this
16719 option is set, Exim implements the percent facility for those domains listed,
16720 but no others. This happens before an incoming SMTP address is tested against
16721 an ACL.
16722
16723 &*Warning*&: The &"percent hack"& has often been abused by people who are
16724 trying to get round relaying restrictions. For this reason, it is best avoided
16725 if at all possible. Unfortunately, a number of less security-conscious MTAs
16726 implement it unconditionally. If you are running Exim on a gateway host, and
16727 routing mail through to internal MTAs without processing the local parts, it is
16728 a good idea to reject recipient addresses with percent characters in their
16729 local parts. Exim's default configuration does this.
16730
16731
16732 .option perl_at_start main boolean false
16733 .cindex "Perl"
16734 This option is available only when Exim is built with an embedded Perl
16735 interpreter. See chapter &<<CHAPperl>>& for details of its use.
16736
16737
16738 .option perl_startup main string unset
16739 .cindex "Perl"
16740 This option is available only when Exim is built with an embedded Perl
16741 interpreter. See chapter &<<CHAPperl>>& for details of its use.
16742
16743 .option perl_taintmode main boolean false
16744 .cindex "Perl"
16745 This option enables the taint mode of the embedded Perl interpreter.
16746
16747
16748 .option pgsql_servers main "string list" unset
16749 .cindex "PostgreSQL lookup type" "server list"
16750 This option provides a list of PostgreSQL servers and associated connection
16751 data, to be used in conjunction with &(pgsql)& lookups (see section
16752 &<<SECID72>>&). The option is available only if Exim has been built with
16753 PostgreSQL support.
16754
16755
16756 .option pid_file_path main string&!! "set at compile time"
16757 .cindex "daemon" "pid file path"
16758 .cindex "pid file, path for"
16759 This option sets the name of the file to which the Exim daemon writes its
16760 process id. The string is expanded, so it can contain, for example, references
16761 to the host name:
16762 .code
16763 pid_file_path = /var/log/$primary_hostname/exim.pid
16764 .endd
16765 If no path is set, the pid is written to the file &_exim-daemon.pid_& in Exim's
16766 spool directory.
16767 The value set by the option can be overridden by the &%-oP%& command line
16768 option. A pid file is not written if a &"non-standard"& daemon is run by means
16769 of the &%-oX%& option, unless a path is explicitly supplied by &%-oP%&.
16770
16771
16772 .option pipelining_advertise_hosts main "host list&!!" *
16773 .cindex "PIPELINING" "suppressing advertising"
16774 This option can be used to suppress the advertisement of the SMTP
16775 PIPELINING extension to specific hosts. See also the &*no_pipelining*&
16776 control in section &<<SECTcontrols>>&. When PIPELINING is not advertised and
16777 &%smtp_enforce_sync%& is true, an Exim server enforces strict synchronization
16778 for each SMTP command and response. When PIPELINING is advertised, Exim assumes
16779 that clients will use it; &"out of order"& commands that are &"expected"& do
16780 not count as protocol errors (see &%smtp_max_synprot_errors%&).
16781
16782 .option pipelining_connect_advertise_hosts main "host list&!!" *
16783 .cindex "pipelining" "early connection"
16784 .cindex "pipelining" PIPE_CONNECT
16785 If Exim is built with the SUPPORT_PIPE_CONNECT build option
16786 this option controls which hosts the facility is advertised to
16787 and from which pipeline early-connection (before MAIL) SMTP
16788 commands are acceptable.
16789 When used, the pipelining saves on roundtrip times.
16790
16791 See also the &%hosts_pipe_connect%& smtp transport option.
16792
16793 Currently the option name &"X_PIPE_CONNECT"& is used.
16794
16795
16796 .option prdr_enable main boolean false
16797 .cindex "PRDR" "enabling on server"
16798 This option can be used to enable the Per-Recipient Data Response extension
16799 to SMTP, defined by Eric Hall.
16800 If the option is set, PRDR is advertised by Exim when operating as a server.
16801 If the client requests PRDR, and more than one recipient, for a message
16802 an additional ACL is called for each recipient after the message content
16803 is received.  See section &<<SECTPRDRACL>>&.
16804
16805 .option preserve_message_logs main boolean false
16806 .cindex "message logs" "preserving"
16807 If this option is set, message log files are not deleted when messages are
16808 completed. Instead, they are moved to a sub-directory of the spool directory
16809 called &_msglog.OLD_&, where they remain available for statistical or debugging
16810 purposes. This is a dangerous option to set on systems with any appreciable
16811 volume of mail. Use with care!
16812
16813
16814 .option primary_hostname main string "see below"
16815 .cindex "name" "of local host"
16816 .cindex "host" "name of local"
16817 .cindex "local host" "name of"
16818 .vindex "&$primary_hostname$&"
16819 This specifies the name of the current host. It is used in the default EHLO or
16820 HELO command for outgoing SMTP messages (changeable via the &%helo_data%&
16821 option in the &(smtp)& transport), and as the default for &%qualify_domain%&.
16822 The value is also used by default in some SMTP response messages from an Exim
16823 server. This can be changed dynamically by setting &%smtp_active_hostname%&.
16824
16825 If &%primary_hostname%& is not set, Exim calls &[uname()]& to find the host
16826 name. If this fails, Exim panics and dies. If the name returned by &[uname()]&
16827 contains only one component, Exim passes it to &[gethostbyname()]& (or
16828 &[getipnodebyname()]& when available) in order to obtain the fully qualified
16829 version. The variable &$primary_hostname$& contains the host name, whether set
16830 explicitly by this option, or defaulted.
16831
16832
16833 .option print_topbitchars main boolean false
16834 .cindex "printing characters"
16835 .cindex "8-bit characters"
16836 By default, Exim considers only those characters whose codes lie in the range
16837 32&--126 to be printing characters. In a number of circumstances (for example,
16838 when writing log entries) non-printing characters are converted into escape
16839 sequences, primarily to avoid messing up the layout. If &%print_topbitchars%&
16840 is set, code values of 128 and above are also considered to be printing
16841 characters.
16842
16843 This option also affects the header syntax checks performed by the
16844 &(autoreply)& transport, and whether Exim uses RFC 2047 encoding of
16845 the user's full name when constructing From: and Sender: addresses (as
16846 described in section &<<SECTconstr>>&). Setting this option can cause
16847 Exim to generate eight bit message headers that do not conform to the
16848 standards.
16849
16850
16851 .option process_log_path main string unset
16852 .cindex "process log path"
16853 .cindex "log" "process log"
16854 .cindex "&'exiwhat'&"
16855 This option sets the name of the file to which an Exim process writes its
16856 &"process log"& when sent a USR1 signal. This is used by the &'exiwhat'&
16857 utility script. If this option is unset, the file called &_exim-process.info_&
16858 in Exim's spool directory is used. The ability to specify the name explicitly
16859 can be useful in environments where two different Exims are running, using
16860 different spool directories.
16861
16862
16863 .option prod_requires_admin main boolean true
16864 .cindex "restricting access to features"
16865 .oindex "&%-M%&"
16866 .oindex "&%-R%&"
16867 .oindex "&%-q%&"
16868 The &%-M%&, &%-R%&, and &%-q%& command-line options require the caller to be an
16869 admin user unless &%prod_requires_admin%& is set false. See also
16870 &%queue_list_requires_admin%& and &%commandline_checks_require_admin%&.
16871
16872
16873 .option qualify_domain main string "see below"
16874 .cindex "domain" "for qualifying addresses"
16875 .cindex "address" "qualification"
16876 This option specifies the domain name that is added to any envelope sender
16877 addresses that do not have a domain qualification. It also applies to
16878 recipient addresses if &%qualify_recipient%& is not set. Unqualified addresses
16879 are accepted by default only for locally-generated messages. Qualification is
16880 also applied to addresses in header lines such as &'From:'& and &'To:'& for
16881 locally-generated messages, unless the &%-bnq%& command line option is used.
16882
16883 Messages from external sources must always contain fully qualified addresses,
16884 unless the sending host matches &%sender_unqualified_hosts%& or
16885 &%recipient_unqualified_hosts%& (as appropriate), in which case incoming
16886 addresses are qualified with &%qualify_domain%& or &%qualify_recipient%& as
16887 necessary. Internally, Exim always works with fully qualified envelope
16888 addresses. If &%qualify_domain%& is not set, it defaults to the
16889 &%primary_hostname%& value.
16890
16891
16892 .option qualify_recipient main string "see below"
16893 This option allows you to specify a different domain for qualifying recipient
16894 addresses to the one that is used for senders. See &%qualify_domain%& above.
16895
16896
16897
16898 .option queue_domains main "domain list&!!" unset
16899 .cindex "domain" "specifying non-immediate delivery"
16900 .cindex "queueing incoming messages"
16901 .cindex "message" "queueing certain domains"
16902 This option lists domains for which immediate delivery is not required.
16903 A delivery process is started whenever a message is received, but only those
16904 domains that do not match are processed. All other deliveries wait until the
16905 next queue run. See also &%hold_domains%& and &%queue_smtp_domains%&.
16906
16907
16908 .option queue_list_requires_admin main boolean true
16909 .cindex "restricting access to features"
16910 .oindex "&%-bp%&"
16911 The &%-bp%& command-line option, which lists the messages that are on the
16912 queue, requires the caller to be an admin user unless
16913 &%queue_list_requires_admin%& is set false.
16914 See also &%prod_requires_admin%& and &%commandline_checks_require_admin%&.
16915
16916
16917 .option queue_only main boolean false
16918 .cindex "queueing incoming messages"
16919 .cindex "message" "queueing unconditionally"
16920 If &%queue_only%& is set, a delivery process is not automatically started
16921 whenever a message is received. Instead, the message waits in the queue for the
16922 next queue run. Even if &%queue_only%& is false, incoming messages may not get
16923 delivered immediately when certain conditions (such as heavy load) occur.
16924
16925 The &%-odq%& command line has the same effect as &%queue_only%&. The &%-odb%&
16926 and &%-odi%& command line options override &%queue_only%& unless
16927 &%queue_only_override%& is set false. See also &%queue_only_file%&,
16928 &%queue_only_load%&, and &%smtp_accept_queue%&.
16929
16930
16931 .option queue_only_file main string unset
16932 .cindex "queueing incoming messages"
16933 .cindex "message" "queueing by file existence"
16934 This option can be set to a colon-separated list of absolute path names, each
16935 one optionally preceded by &"smtp"&. When Exim is receiving a message,
16936 it tests for the existence of each listed path using a call to &[stat()]&. For
16937 each path that exists, the corresponding queueing option is set.
16938 For paths with no prefix, &%queue_only%& is set; for paths prefixed by
16939 &"smtp"&, &%queue_smtp_domains%& is set to match all domains. So, for example,
16940 .code
16941 queue_only_file = smtp/some/file
16942 .endd
16943 causes Exim to behave as if &%queue_smtp_domains%& were set to &"*"& whenever
16944 &_/some/file_& exists.
16945
16946
16947 .option queue_only_load main fixed-point unset
16948 .cindex "load average"
16949 .cindex "queueing incoming messages"
16950 .cindex "message" "queueing by load"
16951 If the system load average is higher than this value, incoming messages from
16952 all sources are queued, and no automatic deliveries are started. If this
16953 happens during local or remote SMTP input, all subsequent messages received on
16954 the same SMTP connection are queued by default, whatever happens to the load in
16955 the meantime, but this can be changed by setting &%queue_only_load_latch%&
16956 false.
16957
16958 Deliveries will subsequently be performed by queue runner processes. This
16959 option has no effect on ancient operating systems on which Exim cannot
16960 determine the load average. See also &%deliver_queue_load_max%& and
16961 &%smtp_load_reserve%&.
16962
16963
16964 .option queue_only_load_latch main boolean true
16965 .cindex "load average" "re-evaluating per message"
16966 When this option is true (the default), once one message has been queued
16967 because the load average is higher than the value set by &%queue_only_load%&,
16968 all subsequent messages received on the same SMTP connection are also queued.
16969 This is a deliberate choice; even though the load average may fall below the
16970 threshold, it doesn't seem right to deliver later messages on the same
16971 connection when not delivering earlier ones. However, there are special
16972 circumstances such as very long-lived connections from scanning appliances
16973 where this is not the best strategy. In such cases, &%queue_only_load_latch%&
16974 should be set false. This causes the value of the load average to be
16975 re-evaluated for each message.
16976
16977
16978 .option queue_only_override main boolean true
16979 .cindex "queueing incoming messages"
16980 When this option is true, the &%-od%&&'x'& command line options override the
16981 setting of &%queue_only%& or &%queue_only_file%& in the configuration file. If
16982 &%queue_only_override%& is set false, the &%-od%&&'x'& options cannot be used
16983 to override; they are accepted, but ignored.
16984
16985
16986 .option queue_run_in_order main boolean false
16987 .cindex "queue runner" "processing messages in order"
16988 If this option is set, queue runs happen in order of message arrival instead of
16989 in an arbitrary order. For this to happen, a complete list of the entire queue
16990 must be set up before the deliveries start. When the queue is all held in a
16991 single directory (the default), a single list is created for both the ordered
16992 and the non-ordered cases. However, if &%split_spool_directory%& is set, a
16993 single list is not created when &%queue_run_in_order%& is false. In this case,
16994 the sub-directories are processed one at a time (in a random order), and this
16995 avoids setting up one huge list for the whole queue. Thus, setting
16996 &%queue_run_in_order%& with &%split_spool_directory%& may degrade performance
16997 when the queue is large, because of the extra work in setting up the single,
16998 large list. In most situations, &%queue_run_in_order%& should not be set.
16999
17000
17001
17002 .option queue_run_max main integer&!! 5
17003 .cindex "queue runner" "maximum number of"
17004 This controls the maximum number of queue runner processes that an Exim daemon
17005 can run simultaneously. This does not mean that it starts them all at once,
17006 but rather that if the maximum number are still running when the time comes to
17007 start another one, it refrains from starting another one. This can happen with
17008 very large queues and/or very sluggish deliveries. This option does not,
17009 however, interlock with other processes, so additional queue runners can be
17010 started by other means, or by killing and restarting the daemon.
17011
17012 Setting this option to zero does not suppress queue runs; rather, it disables
17013 the limit, allowing any number of simultaneous queue runner processes to be
17014 run. If you do not want queue runs to occur, omit the &%-q%&&'xx'& setting on
17015 the daemon's command line.
17016
17017 .cindex queues named
17018 .cindex "named queues" "resource limit"
17019 To set limits for different named queues use
17020 an expansion depending on the &$queue_name$& variable.
17021
17022 .option queue_smtp_domains main "domain list&!!" unset
17023 .cindex "queueing incoming messages"
17024 .cindex "message" "queueing remote deliveries"
17025 .cindex "first pass routing"
17026 When this option is set, a delivery process is started whenever a message is
17027 received, routing is performed, and local deliveries take place.
17028 However, if any SMTP deliveries are required for domains that match
17029 &%queue_smtp_domains%&, they are not immediately delivered, but instead the
17030 message waits in the queue for the next queue run. Since routing of the message
17031 has taken place, Exim knows to which remote hosts it must be delivered, and so
17032 when the queue run happens, multiple messages for the same host are delivered
17033 over a single SMTP connection. The &%-odqs%& command line option causes all
17034 SMTP deliveries to be queued in this way, and is equivalent to setting
17035 &%queue_smtp_domains%& to &"*"&. See also &%hold_domains%& and
17036 &%queue_domains%&.
17037
17038
17039 .option receive_timeout main time 0s
17040 .cindex "timeout" "for non-SMTP input"
17041 This option sets the timeout for accepting a non-SMTP message, that is, the
17042 maximum time that Exim waits when reading a message on the standard input. If
17043 the value is zero, it will wait forever. This setting is overridden by the
17044 &%-or%& command line option. The timeout for incoming SMTP messages is
17045 controlled by &%smtp_receive_timeout%&.
17046
17047 .option received_header_text main string&!! "see below"
17048 .cindex "customizing" "&'Received:'& header"
17049 .cindex "&'Received:'& header line" "customizing"
17050 This string defines the contents of the &'Received:'& message header that is
17051 added to each message, except for the timestamp, which is automatically added
17052 on at the end (preceded by a semicolon). The string is expanded each time it is
17053 used. If the expansion yields an empty string, no &'Received:'& header line is
17054 added to the message. Otherwise, the string should start with the text
17055 &"Received:"& and conform to the RFC 2822 specification for &'Received:'&
17056 header lines.
17057 The default setting is:
17058
17059 .code
17060 received_header_text = Received: \
17061   ${if def:sender_rcvhost {from $sender_rcvhost\n\t}\
17062     {${if def:sender_ident \
17063       {from ${quote_local_part:$sender_ident} }}\
17064         ${if def:sender_helo_name {(helo=$sender_helo_name)\n\t}}}}\
17065   by $primary_hostname \
17066   ${if def:received_protocol {with $received_protocol }}\
17067   ${if def:tls_in_ver        { ($tls_in_ver)}}\
17068   ${if def:tls_in_cipher_std { tls $tls_in_cipher_std\n\t}}\
17069   (Exim $version_number)\n\t\
17070   ${if def:sender_address \
17071   {(envelope-from <$sender_address>)\n\t}}\
17072   id $message_exim_id\
17073   ${if def:received_for {\n\tfor $received_for}}
17074 .endd
17075
17076 The references to the TLS version and cipher are
17077 omitted when Exim is built without TLS
17078 support. The use of conditional expansions ensures that this works for both
17079 locally generated messages and messages received from remote hosts, giving
17080 header lines such as the following:
17081 .code
17082 Received: from scrooge.carol.example ([192.168.12.25] ident=root)
17083 by marley.carol.example with esmtp (Exim 4.00)
17084 (envelope-from <bob@carol.example>)
17085 id 16IOWa-00019l-00
17086 for chas@dickens.example; Tue, 25 Dec 2001 14:43:44 +0000
17087 Received: by scrooge.carol.example with local (Exim 4.00)
17088 id 16IOWW-000083-00; Tue, 25 Dec 2001 14:43:41 +0000
17089 .endd
17090 Until the body of the message has been received, the timestamp is the time when
17091 the message started to be received. Once the body has arrived, and all policy
17092 checks have taken place, the timestamp is updated to the time at which the
17093 message was accepted.
17094
17095
17096 .option received_headers_max main integer 30
17097 .cindex "loop" "prevention"
17098 .cindex "mail loop prevention"
17099 .cindex "&'Received:'& header line" "counting"
17100 When a message is to be delivered, the number of &'Received:'& headers is
17101 counted, and if it is greater than this parameter, a mail loop is assumed to
17102 have occurred, the delivery is abandoned, and an error message is generated.
17103 This applies to both local and remote deliveries.
17104
17105
17106 .option recipient_unqualified_hosts main "host list&!!" unset
17107 .cindex "unqualified addresses"
17108 .cindex "host" "unqualified addresses from"
17109 This option lists those hosts from which Exim is prepared to accept unqualified
17110 recipient addresses in message envelopes. The addresses are made fully
17111 qualified by the addition of the &%qualify_recipient%& value. This option also
17112 affects message header lines. Exim does not reject unqualified recipient
17113 addresses in headers, but it qualifies them only if the message came from a
17114 host that matches &%recipient_unqualified_hosts%&,
17115 or if the message was submitted locally (not using TCP/IP), and the &%-bnq%&
17116 option was not set.
17117
17118
17119 .option recipients_max main integer 0
17120 .cindex "limit" "number of recipients"
17121 .cindex "recipient" "maximum number"
17122 If this option is set greater than zero, it specifies the maximum number of
17123 original recipients for any message. Additional recipients that are generated
17124 by aliasing or forwarding do not count. SMTP messages get a 452 response for
17125 all recipients over the limit; earlier recipients are delivered as normal.
17126 Non-SMTP messages with too many recipients are failed, and no deliveries are
17127 done.
17128
17129 .cindex "RCPT" "maximum number of incoming"
17130 &*Note*&: The RFCs specify that an SMTP server should accept at least 100
17131 RCPT commands in a single message.
17132
17133
17134 .option recipients_max_reject main boolean false
17135 If this option is set true, Exim rejects SMTP messages containing too many
17136 recipients by giving 552 errors to the surplus RCPT commands, and a 554
17137 error to the eventual DATA command. Otherwise (the default) it gives a 452
17138 error to the surplus RCPT commands and accepts the message on behalf of the
17139 initial set of recipients. The remote server should then re-send the message
17140 for the remaining recipients at a later time.
17141
17142
17143 .option remote_max_parallel main integer 2
17144 .cindex "delivery" "parallelism for remote"
17145 This option controls parallel delivery of one message to a number of remote
17146 hosts. If the value is less than 2, parallel delivery is disabled, and Exim
17147 does all the remote deliveries for a message one by one. Otherwise, if a single
17148 message has to be delivered to more than one remote host, or if several copies
17149 have to be sent to the same remote host, up to &%remote_max_parallel%&
17150 deliveries are done simultaneously. If more than &%remote_max_parallel%&
17151 deliveries are required, the maximum number of processes are started, and as
17152 each one finishes, another is begun. The order of starting processes is the
17153 same as if sequential delivery were being done, and can be controlled by the
17154 &%remote_sort_domains%& option. If parallel delivery takes place while running
17155 with debugging turned on, the debugging output from each delivery process is
17156 tagged with its process id.
17157
17158 This option controls only the maximum number of parallel deliveries for one
17159 message in one Exim delivery process. Because Exim has no central queue
17160 manager, there is no way of controlling the total number of simultaneous
17161 deliveries if the configuration allows a delivery attempt as soon as a message
17162 is received.
17163
17164 .cindex "number of deliveries"
17165 .cindex "delivery" "maximum number of"
17166 If you want to control the total number of deliveries on the system, you
17167 need to set the &%queue_only%& option. This ensures that all incoming messages
17168 are added to the queue without starting a delivery process. Then set up an Exim
17169 daemon to start queue runner processes at appropriate intervals (probably
17170 fairly often, for example, every minute), and limit the total number of queue
17171 runners by setting the &%queue_run_max%& parameter. Because each queue runner
17172 delivers only one message at a time, the maximum number of deliveries that can
17173 then take place at once is &%queue_run_max%& multiplied by
17174 &%remote_max_parallel%&.
17175
17176 If it is purely remote deliveries you want to control, use
17177 &%queue_smtp_domains%& instead of &%queue_only%&. This has the added benefit of
17178 doing the SMTP routing before queueing, so that several messages for the same
17179 host will eventually get delivered down the same connection.
17180
17181
17182 .option remote_sort_domains main "domain list&!!" unset
17183 .cindex "sorting remote deliveries"
17184 .cindex "delivery" "sorting remote"
17185 When there are a number of remote deliveries for a message, they are sorted by
17186 domain into the order given by this list. For example,
17187 .code
17188 remote_sort_domains = *.cam.ac.uk:*.uk
17189 .endd
17190 would attempt to deliver to all addresses in the &'cam.ac.uk'& domain first,
17191 then to those in the &%uk%& domain, then to any others.
17192
17193
17194 .option retry_data_expire main time 7d
17195 .cindex "hints database" "data expiry"
17196 This option sets a &"use before"& time on retry information in Exim's hints
17197 database. Any older retry data is ignored. This means that, for example, once a
17198 host has not been tried for 7 days, Exim behaves as if it has no knowledge of
17199 past failures.
17200
17201
17202 .option retry_interval_max main time 24h
17203 .cindex "retry" "limit on interval"
17204 .cindex "limit" "on retry interval"
17205 Chapter &<<CHAPretry>>& describes Exim's mechanisms for controlling the
17206 intervals between delivery attempts for messages that cannot be delivered
17207 straight away. This option sets an overall limit to the length of time between
17208 retries. It cannot be set greater than 24 hours; any attempt to do so forces
17209 the default value.
17210
17211
17212 .option return_path_remove main boolean true
17213 .cindex "&'Return-path:'& header line" "removing"
17214 RFC 2821, section 4.4, states that an SMTP server must insert a
17215 &'Return-path:'& header line into a message when it makes a &"final delivery"&.
17216 The &'Return-path:'& header preserves the sender address as received in the
17217 MAIL command. This description implies that this header should not be present
17218 in an incoming message. If &%return_path_remove%& is true, any existing
17219 &'Return-path:'& headers are removed from messages at the time they are
17220 received. Exim's transports have options for adding &'Return-path:'& headers at
17221 the time of delivery. They are normally used only for final local deliveries.
17222
17223
17224 .option return_size_limit main integer 100K
17225 This option is an obsolete synonym for &%bounce_return_size_limit%&.
17226
17227
17228 .option rfc1413_hosts main "host list&!!" @[]
17229 .cindex "RFC 1413"
17230 .cindex "host" "for RFC 1413 calls"
17231 RFC 1413 identification calls are made to any client host which matches
17232 an item in the list.
17233 The default value specifies just this host, being any local interface
17234 for the system.
17235
17236 .option rfc1413_query_timeout main time 0s
17237 .cindex "RFC 1413" "query timeout"
17238 .cindex "timeout" "for RFC 1413 call"
17239 This sets the timeout on RFC 1413 identification calls. If it is set to zero,
17240 no RFC 1413 calls are ever made.
17241
17242
17243 .option sender_unqualified_hosts main "host list&!!" unset
17244 .cindex "unqualified addresses"
17245 .cindex "host" "unqualified addresses from"
17246 This option lists those hosts from which Exim is prepared to accept unqualified
17247 sender addresses. The addresses are made fully qualified by the addition of
17248 &%qualify_domain%&. This option also affects message header lines. Exim does
17249 not reject unqualified addresses in headers that contain sender addresses, but
17250 it qualifies them only if the message came from a host that matches
17251 &%sender_unqualified_hosts%&, or if the message was submitted locally (not
17252 using TCP/IP), and the &%-bnq%& option was not set.
17253
17254
17255 .option slow_lookup_log main integer 0
17256 .cindex "logging" "slow lookups"
17257 .cindex "dns" "logging slow lookups"
17258 This option controls logging of slow lookups.
17259 If the value is nonzero it is taken as a number of milliseconds
17260 and lookups taking longer than this are logged.
17261 Currently this applies only to DNS lookups.
17262
17263
17264
17265 .option smtp_accept_keepalive main boolean true
17266 .cindex "keepalive" "on incoming connection"
17267 This option controls the setting of the SO_KEEPALIVE option on incoming
17268 TCP/IP socket connections. When set, it causes the kernel to probe idle
17269 connections periodically, by sending packets with &"old"& sequence numbers. The
17270 other end of the connection should send an acknowledgment if the connection is
17271 still okay or a reset if the connection has been aborted. The reason for doing
17272 this is that it has the beneficial effect of freeing up certain types of
17273 connection that can get stuck when the remote host is disconnected without
17274 tidying up the TCP/IP call properly. The keepalive mechanism takes several
17275 hours to detect unreachable hosts.
17276
17277
17278
17279 .option smtp_accept_max main integer 20
17280 .cindex "limit" "incoming SMTP connections"
17281 .cindex "SMTP" "incoming connection count"
17282 .cindex "inetd"
17283 This option specifies the maximum number of simultaneous incoming SMTP calls
17284 that Exim will accept. It applies only to the listening daemon; there is no
17285 control (in Exim) when incoming SMTP is being handled by &'inetd'&. If the
17286 value is set to zero, no limit is applied. However, it is required to be
17287 non-zero if either &%smtp_accept_max_per_host%& or &%smtp_accept_queue%& is
17288 set. See also &%smtp_accept_reserve%& and &%smtp_load_reserve%&.
17289
17290 A new SMTP connection is immediately rejected if the &%smtp_accept_max%& limit
17291 has been reached. If not, Exim first checks &%smtp_accept_max_per_host%&. If
17292 that limit has not been reached for the client host, &%smtp_accept_reserve%&
17293 and &%smtp_load_reserve%& are then checked before accepting the connection.
17294
17295
17296 .option smtp_accept_max_nonmail main integer 10
17297 .cindex "limit" "non-mail SMTP commands"
17298 .cindex "SMTP" "limiting non-mail commands"
17299 Exim counts the number of &"non-mail"& commands in an SMTP session, and drops
17300 the connection if there are too many. This option defines &"too many"&. The
17301 check catches some denial-of-service attacks, repeated failing AUTHs, or a mad
17302 client looping sending EHLO, for example. The check is applied only if the
17303 client host matches &%smtp_accept_max_nonmail_hosts%&.
17304
17305 When a new message is expected, one occurrence of RSET is not counted. This
17306 allows a client to send one RSET between messages (this is not necessary,
17307 but some clients do it). Exim also allows one uncounted occurrence of HELO
17308 or EHLO, and one occurrence of STARTTLS between messages. After
17309 starting up a TLS session, another EHLO is expected, and so it too is not
17310 counted. The first occurrence of AUTH in a connection, or immediately
17311 following STARTTLS is not counted. Otherwise, all commands other than
17312 MAIL, RCPT, DATA, and QUIT are counted.
17313
17314
17315 .option smtp_accept_max_nonmail_hosts main "host list&!!" *
17316 You can control which hosts are subject to the &%smtp_accept_max_nonmail%&
17317 check by setting this option. The default value makes it apply to all hosts. By
17318 changing the value, you can exclude any badly-behaved hosts that you have to
17319 live with.
17320
17321
17322 . Allow this long option name to split; give it unsplit as a fifth argument
17323 . for the automatic .oindex that is generated by .option.
17324 . We insert " &~&~" which is both pretty nasty visually and results in
17325 . non-searchable text.  HowItWorks.txt mentions an option for inserting
17326 . zero-width-space, which would be nicer visually and results in (at least)
17327 . html that Firefox will split on when it's forced to reflow (rather than
17328 . inserting a horizontal scrollbar).  However, the text is still not
17329 . searchable.  NM changed this occurrence for bug 1197 to no longer allow
17330 . the option name to split.
17331
17332 .option "smtp_accept_max_per_connection" main integer 1000 &&&
17333          smtp_accept_max_per_connection
17334 .cindex "SMTP" "limiting incoming message count"
17335 .cindex "limit" "messages per SMTP connection"
17336 The value of this option limits the number of MAIL commands that Exim is
17337 prepared to accept over a single SMTP connection, whether or not each command
17338 results in the transfer of a message. After the limit is reached, a 421
17339 response is given to subsequent MAIL commands. This limit is a safety
17340 precaution against a client that goes mad (incidents of this type have been
17341 seen).
17342
17343
17344 .option smtp_accept_max_per_host main string&!! unset
17345 .cindex "limit" "SMTP connections from one host"
17346 .cindex "host" "limiting SMTP connections from"
17347 This option restricts the number of simultaneous IP connections from a single
17348 host (strictly, from a single IP address) to the Exim daemon. The option is
17349 expanded, to enable different limits to be applied to different hosts by
17350 reference to &$sender_host_address$&. Once the limit is reached, additional
17351 connection attempts from the same host are rejected with error code 421. This
17352 is entirely independent of &%smtp_accept_reserve%&. The option's default value
17353 of zero imposes no limit. If this option is set greater than zero, it is
17354 required that &%smtp_accept_max%& be non-zero.
17355
17356 &*Warning*&: When setting this option you should not use any expansion
17357 constructions that take an appreciable amount of time. The expansion and test
17358 happen in the main daemon loop, in order to reject additional connections
17359 without forking additional processes (otherwise a denial-of-service attack
17360 could cause a vast number or processes to be created). While the daemon is
17361 doing this processing, it cannot accept any other incoming connections.
17362
17363
17364
17365 .option smtp_accept_queue main integer 0
17366 .cindex "SMTP" "incoming connection count"
17367 .cindex "queueing incoming messages"
17368 .cindex "message" "queueing by SMTP connection count"
17369 If the number of simultaneous incoming SMTP connections being handled via the
17370 listening daemon exceeds this value, messages received by SMTP are just placed
17371 in the queue; no delivery processes are started automatically. The count is
17372 fixed at the start of an SMTP connection. It cannot be updated in the
17373 subprocess that receives messages, and so the queueing or not queueing applies
17374 to all messages received in the same connection.
17375
17376 A value of zero implies no limit, and clearly any non-zero value is useful only
17377 if it is less than the &%smtp_accept_max%& value (unless that is zero). See
17378 also &%queue_only%&, &%queue_only_load%&, &%queue_smtp_domains%&, and the
17379 various &%-od%&&'x'& command line options.
17380
17381
17382 . See the comment on smtp_accept_max_per_connection
17383
17384 .option "smtp_accept_queue_per_connection" main integer 10 &&&
17385          smtp_accept_queue_per_connection
17386 .cindex "queueing incoming messages"
17387 .cindex "message" "queueing by message count"
17388 This option limits the number of delivery processes that Exim starts
17389 automatically when receiving messages via SMTP, whether via the daemon or by
17390 the use of &%-bs%& or &%-bS%&. If the value of the option is greater than zero,
17391 and the number of messages received in a single SMTP session exceeds this
17392 number, subsequent messages are placed in the queue, but no delivery processes
17393 are started. This helps to limit the number of Exim processes when a server
17394 restarts after downtime and there is a lot of mail waiting for it on other
17395 systems. On large systems, the default should probably be increased, and on
17396 dial-in client systems it should probably be set to zero (that is, disabled).
17397
17398
17399 .option smtp_accept_reserve main integer 0
17400 .cindex "SMTP" "incoming call count"
17401 .cindex "host" "reserved"
17402 When &%smtp_accept_max%& is set greater than zero, this option specifies a
17403 number of SMTP connections that are reserved for connections from the hosts
17404 that are specified in &%smtp_reserve_hosts%&. The value set in
17405 &%smtp_accept_max%& includes this reserve pool. The specified hosts are not
17406 restricted to this number of connections; the option specifies a minimum number
17407 of connection slots for them, not a maximum. It is a guarantee that this group
17408 of hosts can always get at least &%smtp_accept_reserve%& connections. However,
17409 the limit specified by &%smtp_accept_max_per_host%& is still applied to each
17410 individual host.
17411
17412 For example, if &%smtp_accept_max%& is set to 50 and &%smtp_accept_reserve%& is
17413 set to 5, once there are 45 active connections (from any hosts), new
17414 connections are accepted only from hosts listed in &%smtp_reserve_hosts%&,
17415 provided the other criteria for acceptance are met.
17416
17417
17418 .option smtp_active_hostname main string&!! unset
17419 .cindex "host" "name in SMTP responses"
17420 .cindex "SMTP" "host name in responses"
17421 .vindex "&$primary_hostname$&"
17422 This option is provided for multi-homed servers that want to masquerade as
17423 several different hosts. At the start of an incoming SMTP connection, its value
17424 is expanded and used instead of the value of &$primary_hostname$& in SMTP
17425 responses. For example, it is used as domain name in the response to an
17426 incoming HELO or EHLO command.
17427
17428 .vindex "&$smtp_active_hostname$&"
17429 The active hostname is placed in the &$smtp_active_hostname$& variable, which
17430 is saved with any messages that are received. It is therefore available for use
17431 in routers and transports when the message is later delivered.
17432
17433 If this option is unset, or if its expansion is forced to fail, or if the
17434 expansion results in an empty string, the value of &$primary_hostname$& is
17435 used. Other expansion failures cause a message to be written to the main and
17436 panic logs, and the SMTP command receives a temporary error. Typically, the
17437 value of &%smtp_active_hostname%& depends on the incoming interface address.
17438 For example:
17439 .code
17440 smtp_active_hostname = ${if eq{$received_ip_address}{10.0.0.1}\
17441   {cox.mydomain}{box.mydomain}}
17442 .endd
17443
17444 Although &$smtp_active_hostname$& is primarily concerned with incoming
17445 messages, it is also used as the default for HELO commands in callout
17446 verification if there is no remote transport from which to obtain a
17447 &%helo_data%& value.
17448
17449 .option smtp_banner main string&!! "see below"
17450 .cindex "SMTP" "welcome banner"
17451 .cindex "banner for SMTP"
17452 .cindex "welcome banner for SMTP"
17453 .cindex "customizing" "SMTP banner"
17454 This string, which is expanded every time it is used, is output as the initial
17455 positive response to an SMTP connection. The default setting is:
17456 .code
17457 smtp_banner = $smtp_active_hostname ESMTP Exim \
17458   $version_number $tod_full
17459 .endd
17460 Failure to expand the string causes a panic error. If you want to create a
17461 multiline response to the initial SMTP connection, use &"\n"& in the string at
17462 appropriate points, but not at the end. Note that the 220 code is not included
17463 in this string. Exim adds it automatically (several times in the case of a
17464 multiline response).
17465
17466
17467 .option smtp_check_spool_space main boolean true
17468 .cindex "checking disk space"
17469 .cindex "disk space, checking"
17470 .cindex "spool directory" "checking space"
17471 When this option is set, if an incoming SMTP session encounters the SIZE
17472 option on a MAIL command, it checks that there is enough space in the
17473 spool directory's partition to accept a message of that size, while still
17474 leaving free the amount specified by &%check_spool_space%& (even if that value
17475 is zero). If there isn't enough space, a temporary error code is returned.
17476
17477
17478 .option smtp_connect_backlog main integer 20
17479 .cindex "connection backlog"
17480 .cindex "SMTP" "connection backlog"
17481 .cindex "backlog of connections"
17482 This option specifies a maximum number of waiting SMTP connections. Exim passes
17483 this value to the TCP/IP system when it sets up its listener. Once this number
17484 of connections are waiting for the daemon's attention, subsequent connection
17485 attempts are refused at the TCP/IP level. At least, that is what the manuals
17486 say; in some circumstances such connection attempts have been observed to time
17487 out instead. For large systems it is probably a good idea to increase the
17488 value (to 50, say). It also gives some protection against denial-of-service
17489 attacks by SYN flooding.
17490
17491
17492 .option smtp_enforce_sync main boolean true
17493 .cindex "SMTP" "synchronization checking"
17494 .cindex "synchronization checking in SMTP"
17495 The SMTP protocol specification requires the client to wait for a response from
17496 the server at certain points in the dialogue. Without PIPELINING these
17497 synchronization points are after every command; with PIPELINING they are
17498 fewer, but they still exist.
17499
17500 Some spamming sites send out a complete set of SMTP commands without waiting
17501 for any response. Exim protects against this by rejecting a message if the
17502 client has sent further input when it should not have. The error response &"554
17503 SMTP synchronization error"& is sent, and the connection is dropped. Testing
17504 for this error cannot be perfect because of transmission delays (unexpected
17505 input may be on its way but not yet received when Exim checks). However, it
17506 does detect many instances.
17507
17508 The check can be globally disabled by setting &%smtp_enforce_sync%& false.
17509 If you want to disable the check selectively (for example, only for certain
17510 hosts), you can do so by an appropriate use of a &%control%& modifier in an ACL
17511 (see section &<<SECTcontrols>>&). See also &%pipelining_advertise_hosts%&.
17512
17513
17514
17515 .option smtp_etrn_command main string&!! unset
17516 .cindex "ETRN" "command to be run"
17517 .vindex "&$domain$&"
17518 If this option is set, the given command is run whenever an SMTP ETRN
17519 command is received from a host that is permitted to issue such commands (see
17520 chapter &<<CHAPACL>>&). The string is split up into separate arguments which
17521 are independently expanded. The expansion variable &$domain$& is set to the
17522 argument of the ETRN command, and no syntax checking is done on it. For
17523 example:
17524 .code
17525 smtp_etrn_command = /etc/etrn_command $domain \
17526                     $sender_host_address
17527 .endd
17528 .new
17529 If the option is not set, the argument for the ETRN command must
17530 be a &'#'& followed by an address string.
17531 In this case an &'exim -R <string>'& command is used;
17532 if the ETRN ACL has set up a named-queue then &'-MCG <queue>'& is appended.
17533 .wen
17534
17535 A new process is created to run the command, but Exim does not wait for it to
17536 complete. Consequently, its status cannot be checked. If the command cannot be
17537 run, a line is written to the panic log, but the ETRN caller still receives
17538 a 250 success response. Exim is normally running under its own uid when
17539 receiving SMTP, so it is not possible for it to change the uid before running
17540 the command.
17541
17542
17543 .option smtp_etrn_serialize main boolean true
17544 .cindex "ETRN" "serializing"
17545 When this option is set, it prevents the simultaneous execution of more than
17546 one identical command as a result of ETRN in an SMTP connection. See
17547 section &<<SECTETRN>>& for details.
17548
17549
17550 .option smtp_load_reserve main fixed-point unset
17551 .cindex "load average"
17552 If the system load average ever gets higher than this, incoming SMTP calls are
17553 accepted only from those hosts that match an entry in &%smtp_reserve_hosts%&.
17554 If &%smtp_reserve_hosts%& is not set, no incoming SMTP calls are accepted when
17555 the load is over the limit. The option has no effect on ancient operating
17556 systems on which Exim cannot determine the load average. See also
17557 &%deliver_queue_load_max%& and &%queue_only_load%&.
17558
17559
17560
17561 .option smtp_max_synprot_errors main integer 3
17562 .cindex "SMTP" "limiting syntax and protocol errors"
17563 .cindex "limit" "SMTP syntax and protocol errors"
17564 Exim rejects SMTP commands that contain syntax or protocol errors. In
17565 particular, a syntactically invalid email address, as in this command:
17566 .code
17567 RCPT TO:<abc xyz@a.b.c>
17568 .endd
17569 causes immediate rejection of the command, before any other tests are done.
17570 (The ACL cannot be run if there is no valid address to set up for it.) An
17571 example of a protocol error is receiving RCPT before MAIL. If there are
17572 too many syntax or protocol errors in one SMTP session, the connection is
17573 dropped. The limit is set by this option.
17574
17575 .cindex "PIPELINING" "expected errors"
17576 When the PIPELINING extension to SMTP is in use, some protocol errors are
17577 &"expected"&, for instance, a RCPT command after a rejected MAIL command.
17578 Exim assumes that PIPELINING will be used if it advertises it (see
17579 &%pipelining_advertise_hosts%&), and in this situation, &"expected"& errors do
17580 not count towards the limit.
17581
17582
17583
17584 .option smtp_max_unknown_commands main integer 3
17585 .cindex "SMTP" "limiting unknown commands"
17586 .cindex "limit" "unknown SMTP commands"
17587 If there are too many unrecognized commands in an incoming SMTP session, an
17588 Exim server drops the connection. This is a defence against some kinds of abuse
17589 that subvert web
17590 clients
17591 into making connections to SMTP ports; in these circumstances, a number of
17592 non-SMTP command lines are sent first.
17593
17594
17595
17596 .option smtp_ratelimit_hosts main "host list&!!" unset
17597 .cindex "SMTP" "rate limiting"
17598 .cindex "limit" "rate of message arrival"
17599 .cindex "RCPT" "rate limiting"
17600 Some sites find it helpful to be able to limit the rate at which certain hosts
17601 can send them messages, and the rate at which an individual message can specify
17602 recipients.
17603
17604 Exim has two rate-limiting facilities. This section describes the older
17605 facility, which can limit rates within a single connection. The newer
17606 &%ratelimit%& ACL condition can limit rates across all connections. See section
17607 &<<SECTratelimiting>>& for details of the newer facility.
17608
17609 When a host matches &%smtp_ratelimit_hosts%&, the values of
17610 &%smtp_ratelimit_mail%& and &%smtp_ratelimit_rcpt%& are used to control the
17611 rate of acceptance of MAIL and RCPT commands in a single SMTP session,
17612 respectively. Each option, if set, must contain a set of four comma-separated
17613 values:
17614
17615 .ilist
17616 A threshold, before which there is no rate limiting.
17617 .next
17618 An initial time delay. Unlike other times in Exim, numbers with decimal
17619 fractional parts are allowed here.
17620 .next
17621 A factor by which to increase the delay each time.
17622 .next
17623 A maximum value for the delay. This should normally be less than 5 minutes,
17624 because after that time, the client is liable to timeout the SMTP command.
17625 .endlist
17626
17627 For example, these settings have been used successfully at the site which
17628 first suggested this feature, for controlling mail from their customers:
17629 .code
17630 smtp_ratelimit_mail = 2,0.5s,1.05,4m
17631 smtp_ratelimit_rcpt = 4,0.25s,1.015,4m
17632 .endd
17633 The first setting specifies delays that are applied to MAIL commands after
17634 two have been received over a single connection. The initial delay is 0.5
17635 seconds, increasing by a factor of 1.05 each time. The second setting applies
17636 delays to RCPT commands when more than four occur in a single message.
17637
17638
17639 .option smtp_ratelimit_mail main string unset
17640 See &%smtp_ratelimit_hosts%& above.
17641
17642
17643 .option smtp_ratelimit_rcpt main string unset
17644 See &%smtp_ratelimit_hosts%& above.
17645
17646
17647 .option smtp_receive_timeout main time&!! 5m
17648 .cindex "timeout" "for SMTP input"
17649 .cindex "SMTP" "input timeout"
17650 This sets a timeout value for SMTP reception. It applies to all forms of SMTP
17651 input, including batch SMTP. If a line of input (either an SMTP command or a
17652 data line) is not received within this time, the SMTP connection is dropped and
17653 the message is abandoned.
17654 A line is written to the log containing one of the following messages:
17655 .code
17656 SMTP command timeout on connection from...
17657 SMTP data timeout on connection from...
17658 .endd
17659 The former means that Exim was expecting to read an SMTP command; the latter
17660 means that it was in the DATA phase, reading the contents of a message.
17661
17662 If the first character of the option is a &"$"& the option is
17663 expanded before use and may depend on
17664 &$sender_host_name$&, &$sender_host_address$& and &$sender_host_port$&.
17665
17666
17667 .oindex "&%-os%&"
17668 The value set by this option can be overridden by the
17669 &%-os%& command-line option. A setting of zero time disables the timeout, but
17670 this should never be used for SMTP over TCP/IP. (It can be useful in some cases
17671 of local input using &%-bs%& or &%-bS%&.) For non-SMTP input, the reception
17672 timeout is controlled by &%receive_timeout%& and &%-or%&.
17673
17674
17675 .option smtp_reserve_hosts main "host list&!!" unset
17676 This option defines hosts for which SMTP connections are reserved; see
17677 &%smtp_accept_reserve%& and &%smtp_load_reserve%& above.
17678
17679
17680 .option smtp_return_error_details main boolean false
17681 .cindex "SMTP" "details policy failures"
17682 .cindex "policy control" "rejection, returning details"
17683 In the default state, Exim uses bland messages such as
17684 &"Administrative prohibition"& when it rejects SMTP commands for policy
17685 reasons. Many sysadmins like this because it gives away little information
17686 to spammers. However, some other sysadmins who are applying strict checking
17687 policies want to give out much fuller information about failures. Setting
17688 &%smtp_return_error_details%& true causes Exim to be more forthcoming. For
17689 example, instead of &"Administrative prohibition"&, it might give:
17690 .code
17691 550-Rejected after DATA: '>' missing at end of address:
17692 550 failing address in "From" header is: <user@dom.ain
17693 .endd
17694
17695
17696 .option smtputf8_advertise_hosts main "host list&!!" *
17697 .cindex "SMTPUTF8" "advertising"
17698 When Exim is built with support for internationalised mail names,
17699 the availability thereof is advertised in
17700 response to EHLO only to those client hosts that match this option. See
17701 chapter &<<CHAPi18n>>& for details of Exim's support for internationalisation.
17702
17703
17704 .option spamd_address main string "127.0.0.1 783"
17705 This option is available when Exim is compiled with the content-scanning
17706 extension. It specifies how Exim connects to SpamAssassin's &%spamd%& daemon.
17707 See section &<<SECTscanspamass>>& for more details.
17708
17709
17710
17711 .option spf_guess main string "v=spf1 a/24 mx/24 ptr ?all"
17712 This option is available when Exim is compiled with SPF support.
17713 See section &<<SECSPF>>& for more details.
17714
17715
17716
17717 .option split_spool_directory main boolean false
17718 .cindex "multiple spool directories"
17719 .cindex "spool directory" "split"
17720 .cindex "directories, multiple"
17721 If this option is set, it causes Exim to split its input directory into 62
17722 subdirectories, each with a single alphanumeric character as its name. The
17723 sixth character of the message id is used to allocate messages to
17724 subdirectories; this is the least significant base-62 digit of the time of
17725 arrival of the message.
17726
17727 Splitting up the spool in this way may provide better performance on systems
17728 where there are long mail queues, by reducing the number of files in any one
17729 directory. The msglog directory is also split up in a similar way to the input
17730 directory; however, if &%preserve_message_logs%& is set, all old msglog files
17731 are still placed in the single directory &_msglog.OLD_&.
17732
17733 It is not necessary to take any special action for existing messages when
17734 changing &%split_spool_directory%&. Exim notices messages that are in the
17735 &"wrong"& place, and continues to process them. If the option is turned off
17736 after a period of being on, the subdirectories will eventually empty and be
17737 automatically deleted.
17738
17739 When &%split_spool_directory%& is set, the behaviour of queue runner processes
17740 changes. Instead of creating a list of all messages in the queue, and then
17741 trying to deliver each one, in turn, it constructs a list of those in one
17742 sub-directory and tries to deliver them, before moving on to the next
17743 sub-directory. The sub-directories are processed in a random order. This
17744 spreads out the scanning of the input directories, and uses less memory. It is
17745 particularly beneficial when there are lots of messages in the queue. However,
17746 if &%queue_run_in_order%& is set, none of this new processing happens. The
17747 entire queue has to be scanned and sorted before any deliveries can start.
17748
17749
17750 .option spool_directory main string&!! "set at compile time"
17751 .cindex "spool directory" "path to"
17752 This defines the directory in which Exim keeps its spool, that is, the messages
17753 it is waiting to deliver. The default value is taken from the compile-time
17754 configuration setting, if there is one. If not, this option must be set. The
17755 string is expanded, so it can contain, for example, a reference to
17756 &$primary_hostname$&.
17757
17758 If the spool directory name is fixed on your installation, it is recommended
17759 that you set it at build time rather than from this option, particularly if the
17760 log files are being written to the spool directory (see &%log_file_path%&).
17761 Otherwise log files cannot be used for errors that are detected early on, such
17762 as failures in the configuration file.
17763
17764 By using this option to override the compiled-in path, it is possible to run
17765 tests of Exim without using the standard spool.
17766
17767 .option spool_wireformat main boolean false
17768 .cindex "spool directory" "file formats"
17769 If this option is set, Exim may for some messages use an alternative format
17770 for data-files in the spool which matches the wire format.
17771 Doing this permits more efficient message reception and transmission.
17772 Currently it is only done for messages received using the ESMTP CHUNKING
17773 option.
17774
17775 The following variables will not have useful values:
17776 .code
17777 $max_received_linelength
17778 $body_linecount
17779 $body_zerocount
17780 .endd
17781
17782 Users of the local_scan() API (see &<<CHAPlocalscan>>&),
17783 and any external programs which are passed a reference to a message data file
17784 (except via the &"regex"&, &"malware"& or &"spam"&) ACL conditions)
17785 will need to be aware of the different formats potentially available.
17786
17787 Using any of the ACL conditions noted will negate the reception benefit
17788 (as a Unix-mbox-format file is constructed for them).
17789 The transmission benefit is maintained.
17790
17791 .option sqlite_lock_timeout main time 5s
17792 .cindex "sqlite lookup type" "lock timeout"
17793 This option controls the timeout that the &(sqlite)& lookup uses when trying to
17794 access an SQLite database. See section &<<SECTsqlite>>& for more details.
17795
17796 .option strict_acl_vars main boolean false
17797 .cindex "&ACL;" "variables, handling unset"
17798 This option controls what happens if a syntactically valid but undefined ACL
17799 variable is referenced. If it is false (the default), an empty string
17800 is substituted; if it is true, an error is generated. See section
17801 &<<SECTaclvariables>>& for details of ACL variables.
17802
17803 .option strip_excess_angle_brackets main boolean false
17804 .cindex "angle brackets, excess"
17805 If this option is set, redundant pairs of angle brackets round &"route-addr"&
17806 items in addresses are stripped. For example, &'<<xxx@a.b.c.d>>'& is
17807 treated as &'<xxx@a.b.c.d>'&. If this is in the envelope and the message is
17808 passed on to another MTA, the excess angle brackets are not passed on. If this
17809 option is not set, multiple pairs of angle brackets cause a syntax error.
17810
17811
17812 .option strip_trailing_dot main boolean false
17813 .cindex "trailing dot on domain"
17814 .cindex "dot" "trailing on domain"
17815 If this option is set, a trailing dot at the end of a domain in an address is
17816 ignored. If this is in the envelope and the message is passed on to another
17817 MTA, the dot is not passed on. If this option is not set, a dot at the end of a
17818 domain causes a syntax error.
17819 However, addresses in header lines are checked only when an ACL requests header
17820 syntax checking.
17821
17822
17823 .option syslog_duplication main boolean true
17824 .cindex "syslog" "duplicate log lines; suppressing"
17825 When Exim is logging to syslog, it writes the log lines for its three
17826 separate logs at different syslog priorities so that they can in principle
17827 be separated on the logging hosts. Some installations do not require this
17828 separation, and in those cases, the duplication of certain log lines is a
17829 nuisance. If &%syslog_duplication%& is set false, only one copy of any
17830 particular log line is written to syslog. For lines that normally go to
17831 both the main log and the reject log, the reject log version (possibly
17832 containing message header lines) is written, at LOG_NOTICE priority.
17833 Lines that normally go to both the main and the panic log are written at
17834 the LOG_ALERT priority.
17835
17836
17837 .option syslog_facility main string unset
17838 .cindex "syslog" "facility; setting"
17839 This option sets the syslog &"facility"& name, used when Exim is logging to
17840 syslog. The value must be one of the strings &"mail"&, &"user"&, &"news"&,
17841 &"uucp"&, &"daemon"&, or &"local&'x'&"& where &'x'& is a digit between 0 and 7.
17842 If this option is unset, &"mail"& is used. See chapter &<<CHAPlog>>& for
17843 details of Exim's logging.
17844
17845
17846 .option syslog_pid main boolean true
17847 .cindex "syslog" "pid"
17848 If &%syslog_pid%& is set false, the PID on Exim's log lines are
17849 omitted when these lines are sent to syslog. (Syslog normally prefixes
17850 the log lines with the PID of the logging process automatically.) You need
17851 to enable the &`+pid`& log selector item, if you want Exim to write it's PID
17852 into the logs.) See chapter &<<CHAPlog>>& for details of Exim's logging.
17853
17854
17855
17856 .option syslog_processname main string &`exim`&
17857 .cindex "syslog" "process name; setting"
17858 This option sets the syslog &"ident"& name, used when Exim is logging to
17859 syslog. The value must be no longer than 32 characters. See chapter
17860 &<<CHAPlog>>& for details of Exim's logging.
17861
17862
17863
17864 .option syslog_timestamp main boolean true
17865 .cindex "syslog" "timestamps"
17866 If &%syslog_timestamp%& is set false, the timestamps on Exim's log lines are
17867 omitted when these lines are sent to syslog. See chapter &<<CHAPlog>>& for
17868 details of Exim's logging.
17869
17870
17871 .option system_filter main string&!! unset
17872 .cindex "filter" "system filter"
17873 .cindex "system filter" "specifying"
17874 .cindex "Sieve filter" "not available for system filter"
17875 This option specifies an Exim filter file that is applied to all messages at
17876 the start of each delivery attempt, before any routing is done. System filters
17877 must be Exim filters; they cannot be Sieve filters. If the system filter
17878 generates any deliveries to files or pipes, or any new mail messages, the
17879 appropriate &%system_filter_..._transport%& option(s) must be set, to define
17880 which transports are to be used. Details of this facility are given in chapter
17881 &<<CHAPsystemfilter>>&.
17882 A forced expansion failure results in no filter operation.
17883
17884
17885 .option system_filter_directory_transport main string&!! unset
17886 .vindex "&$address_file$&"
17887 This sets the name of the transport driver that is to be used when the
17888 &%save%& command in a system message filter specifies a path ending in &"/"&,
17889 implying delivery of each message into a separate file in some directory.
17890 During the delivery, the variable &$address_file$& contains the path name.
17891
17892
17893 .option system_filter_file_transport main string&!! unset
17894 .cindex "file" "transport for system filter"
17895 This sets the name of the transport driver that is to be used when the &%save%&
17896 command in a system message filter specifies a path not ending in &"/"&. During
17897 the delivery, the variable &$address_file$& contains the path name.
17898
17899 .option system_filter_group main string unset
17900 .cindex "gid (group id)" "system filter"
17901 This option is used only when &%system_filter_user%& is also set. It sets the
17902 gid under which the system filter is run, overriding any gid that is associated
17903 with the user. The value may be numerical or symbolic.
17904
17905 .option system_filter_pipe_transport main string&!! unset
17906 .cindex "&(pipe)& transport" "for system filter"
17907 .vindex "&$address_pipe$&"
17908 This specifies the transport driver that is to be used when a &%pipe%& command
17909 is used in a system filter. During the delivery, the variable &$address_pipe$&
17910 contains the pipe command.
17911
17912
17913 .option system_filter_reply_transport main string&!! unset
17914 .cindex "&(autoreply)& transport" "for system filter"
17915 This specifies the transport driver that is to be used when a &%mail%& command
17916 is used in a system filter.
17917
17918
17919 .option system_filter_user main string unset
17920 .cindex "uid (user id)" "system filter"
17921 If this option is set to root, the system filter is run in the main Exim
17922 delivery process, as root.  Otherwise, the system filter runs in a separate
17923 process, as the given user, defaulting to the Exim run-time user.
17924 Unless the string consists entirely of digits, it
17925 is looked up in the password data. Failure to find the named user causes a
17926 configuration error. The gid is either taken from the password data, or
17927 specified by &%system_filter_group%&. When the uid is specified numerically,
17928 &%system_filter_group%& is required to be set.
17929
17930 If the system filter generates any pipe, file, or reply deliveries, the uid
17931 under which the filter is run is used when transporting them, unless a
17932 transport option overrides.
17933
17934
17935 .option tcp_nodelay main boolean true
17936 .cindex "daemon" "TCP_NODELAY on sockets"
17937 .cindex "Nagle algorithm"
17938 .cindex "TCP_NODELAY on listening sockets"
17939 If this option is set false, it stops the Exim daemon setting the
17940 TCP_NODELAY option on its listening sockets. Setting TCP_NODELAY
17941 turns off the &"Nagle algorithm"&, which is a way of improving network
17942 performance in interactive (character-by-character) situations. Turning it off
17943 should improve Exim's performance a bit, so that is what happens by default.
17944 However, it appears that some broken clients cannot cope, and time out. Hence
17945 this option. It affects only those sockets that are set up for listening by the
17946 daemon. Sockets created by the smtp transport for delivering mail always set
17947 TCP_NODELAY.
17948
17949
17950 .option timeout_frozen_after main time 0s
17951 .cindex "frozen messages" "timing out"
17952 .cindex "timeout" "frozen messages"
17953 If &%timeout_frozen_after%& is set to a time greater than zero, a frozen
17954 message of any kind that has been in the queue for longer than the given time
17955 is automatically cancelled at the next queue run. If the frozen message is a
17956 bounce message, it is just discarded; otherwise, a bounce is sent to the
17957 sender, in a similar manner to cancellation by the &%-Mg%& command line option.
17958 If you want to timeout frozen bounce messages earlier than other kinds of
17959 frozen message, see &%ignore_bounce_errors_after%&.
17960
17961 &*Note:*& the default value of zero means no timeouts; with this setting,
17962 frozen messages remain in the queue forever (except for any frozen bounce
17963 messages that are released by &%ignore_bounce_errors_after%&).
17964
17965
17966 .option timezone main string unset
17967 .cindex "timezone, setting"
17968 .cindex "environment" "values from"
17969 The value of &%timezone%& is used to set the environment variable TZ while
17970 running Exim (if it is different on entry). This ensures that all timestamps
17971 created by Exim are in the required timezone. If you want all your timestamps
17972 to be in UTC (aka GMT) you should set
17973 .code
17974 timezone = UTC
17975 .endd
17976 The default value is taken from TIMEZONE_DEFAULT in &_Local/Makefile_&,
17977 or, if that is not set, from the value of the TZ environment variable when Exim
17978 is built. If &%timezone%& is set to the empty string, either at build or run
17979 time, any existing TZ variable is removed from the environment when Exim
17980 runs. This is appropriate behaviour for obtaining wall-clock time on some, but
17981 unfortunately not all, operating systems.
17982
17983
17984 .option tls_advertise_hosts main "host list&!!" *
17985 .cindex "TLS" "advertising"
17986 .cindex "encryption" "on SMTP connection"
17987 .cindex "SMTP" "encrypted connection"
17988 When Exim is built with support for TLS encrypted connections, the availability
17989 of the STARTTLS command to set up an encrypted session is advertised in
17990 response to EHLO only to those client hosts that match this option. See
17991 chapter &<<CHAPTLS>>& for details of Exim's support for TLS.
17992 Note that the default value requires that a certificate be supplied
17993 using the &%tls_certificate%& option.  If TLS support for incoming connections
17994 is not required the &%tls_advertise_hosts%& option should be set empty.
17995
17996
17997 .option tls_certificate main string list&!! unset
17998 .cindex "TLS" "server certificate; location of"
17999 .cindex "certificate" "server, location of"
18000 The value of this option is expanded, and must then be a list of absolute paths to
18001 files which contain the server's certificates (in PEM format).
18002 Commonly only one file is needed.
18003 The server's private key is also
18004 assumed to be in this file if &%tls_privatekey%& is unset. See chapter
18005 &<<CHAPTLS>>& for further details.
18006
18007 &*Note*&: The certificates defined by this option are used only when Exim is
18008 receiving incoming messages as a server. If you want to supply certificates for
18009 use when sending messages as a client, you must set the &%tls_certificate%&
18010 option in the relevant &(smtp)& transport.
18011
18012 &*Note*&: If you use filenames based on IP addresses, change the list
18013 separator in the usual way (&<<SECTlistsepchange>>&) to avoid confusion under IPv6.
18014
18015 &*Note*&: Under versions of OpenSSL preceding 1.1.1,
18016 when a list of more than one
18017 file is used, the &$tls_in_ourcert$& variable is unreliable.
18018 The macro "_TLS_BAD_MULTICERT_IN_OURCERT" will be defined for those versions.
18019
18020 If the option contains &$tls_out_sni$& and Exim is built against OpenSSL, then
18021 if the OpenSSL build supports TLS extensions and the TLS client sends the
18022 Server Name Indication extension, then this option and others documented in
18023 &<<SECTtlssni>>& will be re-expanded.
18024
18025 If this option is unset or empty a fresh self-signed certificate will be
18026 generated for every connection.
18027
18028 .option tls_crl main string&!! unset
18029 .cindex "TLS" "server certificate revocation list"
18030 .cindex "certificate" "revocation list for server"
18031 This option specifies a certificate revocation list. The expanded value must
18032 be the name of a file that contains CRLs in PEM format.
18033
18034 Under OpenSSL the option can specify a directory with CRL files.
18035
18036 &*Note:*& Under OpenSSL the option must, if given, supply a CRL
18037 for each signing element of the certificate chain (i.e. all but the leaf).
18038 For the file variant this can be multiple PEM blocks in the one file.
18039
18040 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
18041
18042
18043 .option tls_dh_max_bits main integer 2236
18044 .cindex "TLS" "D-H bit count"
18045 The number of bits used for Diffie-Hellman key-exchange may be suggested by
18046 the chosen TLS library.  That value might prove to be too high for
18047 interoperability.  This option provides a maximum clamp on the value
18048 suggested, trading off security for interoperability.
18049
18050 The value must be at least 1024.
18051
18052 The value 2236 was chosen because, at time of adding the option, it was the
18053 hard-coded maximum value supported by the NSS cryptographic library, as used
18054 by Thunderbird, while GnuTLS was suggesting 2432 bits as normal.
18055
18056 If you prefer more security and are willing to break some clients, raise this
18057 number.
18058
18059 Note that the value passed to GnuTLS for *generating* a new prime may be a
18060 little less than this figure, because GnuTLS is inexact and may produce a
18061 larger prime than requested.
18062
18063
18064 .option tls_dhparam main string&!! unset
18065 .cindex "TLS" "D-H parameters for server"
18066 The value of this option is expanded and indicates the source of DH parameters
18067 to be used by Exim.
18068
18069 This option is ignored for GnuTLS version 3.6.0 and later.
18070 The library manages parameter negotiation internally.
18071
18072 &*Note: The Exim Maintainers strongly recommend,
18073 for other TLS library versions,
18074 using a filename with site-generated
18075 local DH parameters*&, which has been supported across all versions of Exim.  The
18076 other specific constants available are a fallback so that even when
18077 "unconfigured", Exim can offer Perfect Forward Secrecy in older ciphersuites in TLS.
18078
18079 If &%tls_dhparam%& is a filename starting with a &`/`&,
18080 then it names a file from which DH
18081 parameters should be loaded.  If the file exists, it should hold a PEM-encoded
18082 PKCS#3 representation of the DH prime.  If the file does not exist, for
18083 OpenSSL it is an error.  For GnuTLS, Exim will attempt to create the file and
18084 fill it with a generated DH prime.  For OpenSSL, if the DH bit-count from
18085 loading the file is greater than &%tls_dh_max_bits%& then it will be ignored,
18086 and treated as though the &%tls_dhparam%& were set to "none".
18087
18088 If this option expands to the string "none", then no DH parameters will be
18089 loaded by Exim.
18090
18091 If this option expands to the string "historic" and Exim is using GnuTLS, then
18092 Exim will attempt to load a file from inside the spool directory.  If the file
18093 does not exist, Exim will attempt to create it.
18094 See section &<<SECTgnutlsparam>>& for further details.
18095
18096 If Exim is using OpenSSL and this option is empty or unset, then Exim will load
18097 a default DH prime; the default is Exim-specific but lacks verifiable provenance.
18098
18099 In older versions of Exim the default was the 2048 bit prime described in section
18100 2.2 of RFC 5114, "2048-bit MODP Group with 224-bit Prime Order Subgroup", which
18101 in IKE is assigned number 23.
18102
18103 Otherwise, the option must expand to the name used by Exim for any of a number
18104 of DH primes specified in RFC 2409, RFC 3526, RFC 5114, RFC 7919, or from other
18105 sources.  As names, Exim uses a standard specified name, else "ike" followed by
18106 the number used by IKE, or "default" which corresponds to
18107 &`exim.dev.20160529.3`&.
18108
18109 The available standard primes are:
18110 &`ffdhe2048`&, &`ffdhe3072`&, &`ffdhe4096`&, &`ffdhe6144`&, &`ffdhe8192`&,
18111 &`ike1`&, &`ike2`&, &`ike5`&,
18112 &`ike14`&, &`ike15`&, &`ike16`&, &`ike17`&, &`ike18`&,
18113 &`ike22`&, &`ike23`& and &`ike24`&.
18114
18115 The available additional primes are:
18116 &`exim.dev.20160529.1`&, &`exim.dev.20160529.2`& and &`exim.dev.20160529.3`&.
18117
18118 Some of these will be too small to be accepted by clients.
18119 Some may be too large to be accepted by clients.
18120 The open cryptographic community has suspicions about the integrity of some
18121 of the later IKE values, which led into RFC7919 providing new fixed constants
18122 (the "ffdhe" identifiers).
18123
18124 At this point, all of the "ike" values should be considered obsolete;
18125 they're still in Exim to avoid breaking unusual configurations, but are
18126 candidates for removal the next time we have backwards-incompatible changes.
18127
18128 The TLS protocol does not negotiate an acceptable size for this; clients tend
18129 to hard-drop connections if what is offered by the server is unacceptable,
18130 whether too large or too small, and there's no provision for the client to
18131 tell the server what these constraints are.  Thus, as a server operator, you
18132 need to make an educated guess as to what is most likely to work for your
18133 userbase.
18134
18135 Some known size constraints suggest that a bit-size in the range 2048 to 2236
18136 is most likely to maximise interoperability.  The upper bound comes from
18137 applications using the Mozilla Network Security Services (NSS) library, which
18138 used to set its &`DH_MAX_P_BITS`& upper-bound to 2236.  This affects many
18139 mail user agents (MUAs). The lower bound comes from Debian installs of Exim4
18140 prior to the 4.80 release, as Debian used to patch Exim to raise the minimum
18141 acceptable bound from 1024 to 2048.
18142
18143
18144 .option tls_eccurve main string&!! &`auto`&
18145 .cindex TLS "EC cryptography"
18146 This option selects a EC curve for use by Exim when used with OpenSSL.
18147 It has no effect when Exim is used with GnuTLS.
18148
18149 After expansion it must contain a valid EC curve parameter, such as
18150 &`prime256v1`&, &`secp384r1`&, or &`P-512`&. Consult your OpenSSL manual
18151 for valid selections.
18152
18153 For OpenSSL versions before (and not including) 1.0.2, the string
18154 &`auto`& selects &`prime256v1`&. For more recent OpenSSL versions
18155 &`auto`& tells the library to choose.
18156
18157 If the option expands to an empty string, no EC curves will be enabled.
18158
18159
18160 .option tls_ocsp_file main string&!! unset
18161 .cindex TLS "certificate status"
18162 .cindex TLS "OCSP proof file"
18163 This option
18164 must if set expand to the absolute path to a file which contains a current
18165 status proof for the server's certificate, as obtained from the
18166 Certificate Authority.
18167
18168 Usable for GnuTLS 3.4.4 or 3.3.17 or OpenSSL 1.1.0 (or later).
18169 The macro "_HAVE_TLS_OCSP" will be defined for those versions.
18170
18171 For OpenSSL 1.1.0 or later, and
18172 for GnuTLS 3.5.6 or later the expanded value of this option can be a list
18173 of files, to match a list given for the &%tls_certificate%& option.
18174 The ordering of the two lists must match.
18175 The macro "_HAVE_TLS_OCSP_LIST" will be defined for those versions.
18176
18177 The file(s) should be in DER format,
18178 except for GnuTLS 3.6.3 or later
18179 or for OpenSSL,
18180 when an optional filetype prefix can be used.
18181 The prefix must be one of "DER" or "PEM", followed by
18182 a single space.  If one is used it sets the format for subsequent
18183 files in the list; the initial format is DER.
18184 If multiple proofs are wanted, for multiple chain elements
18185 (this only works under TLS1.3)
18186 they must be coded as a combined OCSP response.
18187
18188 Although GnuTLS will accept PEM files with multiple separate
18189 PEM blobs (ie. separate OCSP responses), it sends them in the
18190 TLS Certificate record interleaved with the certificates of the chain;
18191 although a GnuTLS client is happy with that, an OpenSSL client is not.
18192
18193 .option tls_on_connect_ports main "string list" unset
18194 .cindex SSMTP
18195 .cindex SMTPS
18196 This option specifies a list of incoming SSMTP (aka SMTPS) ports that should
18197 operate the SSMTP (SMTPS) protocol, where a TLS session is immediately
18198 set up without waiting for the client to issue a STARTTLS command. For
18199 further details, see section &<<SECTsupobssmt>>&.
18200
18201
18202
18203 .option tls_privatekey main string list&!! unset
18204 .cindex "TLS" "server private key; location of"
18205 The value of this option is expanded, and must then be a list of absolute paths to
18206 files which contains the server's private keys.
18207 If this option is unset, or if
18208 the expansion is forced to fail, or the result is an empty string, the private
18209 key is assumed to be in the same file as the server's certificates. See chapter
18210 &<<CHAPTLS>>& for further details.
18211
18212 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
18213
18214
18215 .option tls_remember_esmtp main boolean false
18216 .cindex "TLS" "esmtp state; remembering"
18217 .cindex "TLS" "broken clients"
18218 If this option is set true, Exim violates the RFCs by remembering that it is in
18219 &"esmtp"& state after successfully negotiating a TLS session. This provides
18220 support for broken clients that fail to send a new EHLO after starting a
18221 TLS session.
18222
18223
18224 .option tls_require_ciphers main string&!! unset
18225 .cindex "TLS" "requiring specific ciphers"
18226 .cindex "cipher" "requiring specific"
18227 This option controls which ciphers can be used for incoming TLS connections.
18228 The &(smtp)& transport has an option of the same name for controlling outgoing
18229 connections. This option is expanded for each connection, so can be varied for
18230 different clients if required. The value of this option must be a list of
18231 permitted cipher suites. The OpenSSL and GnuTLS libraries handle cipher control
18232 in somewhat different ways. If GnuTLS is being used, the client controls the
18233 preference order of the available ciphers. Details are given in sections
18234 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
18235
18236
18237 .option tls_try_verify_hosts main "host list&!!" unset
18238 .cindex "TLS" "client certificate verification"
18239 .cindex "certificate" "verification of client"
18240 See &%tls_verify_hosts%& below.
18241
18242
18243 .option tls_verify_certificates main string&!! system
18244 .cindex "TLS" "client certificate verification"
18245 .cindex "certificate" "verification of client"
18246 The value of this option is expanded, and must then be either the
18247 word "system"
18248 or the absolute path to
18249 a file or directory containing permitted certificates for clients that
18250 match &%tls_verify_hosts%& or &%tls_try_verify_hosts%&.
18251
18252 The "system" value for the option will use a
18253 system default location compiled into the SSL library.
18254 This is not available for GnuTLS versions preceding 3.0.20,
18255 and will be taken as empty; an explicit location
18256 must be specified.
18257
18258 The use of a directory for the option value is not available for GnuTLS versions
18259 preceding 3.3.6 and a single file must be used.
18260
18261 With OpenSSL the certificates specified
18262 explicitly
18263 either by file or directory
18264 are added to those given by the system default location.
18265
18266 These certificates should be for the certificate authorities trusted, rather
18267 than the public cert of individual clients.  With both OpenSSL and GnuTLS, if
18268 the value is a file then the certificates are sent by Exim as a server to
18269 connecting clients, defining the list of accepted certificate authorities.
18270 Thus the values defined should be considered public data.  To avoid this,
18271 use the explicit directory version.
18272
18273 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
18274
18275 A forced expansion failure or setting to an empty string is equivalent to
18276 being unset.
18277
18278
18279 .option tls_verify_hosts main "host list&!!" unset
18280 .cindex "TLS" "client certificate verification"
18281 .cindex "certificate" "verification of client"
18282 This option, along with &%tls_try_verify_hosts%&, controls the checking of
18283 certificates from clients. The expected certificates are defined by
18284 &%tls_verify_certificates%&, which must be set. A configuration error occurs if
18285 either &%tls_verify_hosts%& or &%tls_try_verify_hosts%& is set and
18286 &%tls_verify_certificates%& is not set.
18287
18288 Any client that matches &%tls_verify_hosts%& is constrained by
18289 &%tls_verify_certificates%&. When the client initiates a TLS session, it must
18290 present one of the listed certificates. If it does not, the connection is
18291 aborted. &*Warning*&: Including a host in &%tls_verify_hosts%& does not require
18292 the host to use TLS. It can still send SMTP commands through unencrypted
18293 connections. Forcing a client to use TLS has to be done separately using an
18294 ACL to reject inappropriate commands when the connection is not encrypted.
18295
18296 A weaker form of checking is provided by &%tls_try_verify_hosts%&. If a client
18297 matches this option (but not &%tls_verify_hosts%&), Exim requests a
18298 certificate and checks it against &%tls_verify_certificates%&, but does not
18299 abort the connection if there is no certificate or if it does not match. This
18300 state can be detected in an ACL, which makes it possible to implement policies
18301 such as &"accept for relay only if a verified certificate has been received,
18302 but accept for local delivery if encrypted, even without a verified
18303 certificate"&.
18304
18305 Client hosts that match neither of these lists are not asked to present
18306 certificates.
18307
18308
18309 .option trusted_groups main "string list&!!" unset
18310 .cindex "trusted groups"
18311 .cindex "groups" "trusted"
18312 This option is expanded just once, at the start of Exim's processing. If this
18313 option is set, any process that is running in one of the listed groups, or
18314 which has one of them as a supplementary group, is trusted. The groups can be
18315 specified numerically or by name. See section &<<SECTtrustedadmin>>& for
18316 details of what trusted callers are permitted to do. If neither
18317 &%trusted_groups%& nor &%trusted_users%& is set, only root and the Exim user
18318 are trusted.
18319
18320 .option trusted_users main "string list&!!" unset
18321 .cindex "trusted users"
18322 .cindex "user" "trusted"
18323 This option is expanded just once, at the start of Exim's processing. If this
18324 option is set, any process that is running as one of the listed users is
18325 trusted. The users can be specified numerically or by name. See section
18326 &<<SECTtrustedadmin>>& for details of what trusted callers are permitted to do.
18327 If neither &%trusted_groups%& nor &%trusted_users%& is set, only root and the
18328 Exim user are trusted.
18329
18330 .option unknown_login main string&!! unset
18331 .cindex "uid (user id)" "unknown caller"
18332 .vindex "&$caller_uid$&"
18333 This is a specialized feature for use in unusual configurations. By default, if
18334 the uid of the caller of Exim cannot be looked up using &[getpwuid()]&, Exim
18335 gives up. The &%unknown_login%& option can be used to set a login name to be
18336 used in this circumstance. It is expanded, so values like &%user$caller_uid%&
18337 can be set. When &%unknown_login%& is used, the value of &%unknown_username%&
18338 is used for the user's real name (gecos field), unless this has been set by the
18339 &%-F%& option.
18340
18341 .option unknown_username main string unset
18342 See &%unknown_login%&.
18343
18344 .option untrusted_set_sender main "address list&!!" unset
18345 .cindex "trusted users"
18346 .cindex "sender" "setting by untrusted user"
18347 .cindex "untrusted user setting sender"
18348 .cindex "user" "untrusted setting sender"
18349 .cindex "envelope from"
18350 .cindex "envelope sender"
18351 When an untrusted user submits a message to Exim using the standard input, Exim
18352 normally creates an envelope sender address from the user's login and the
18353 default qualification domain. Data from the &%-f%& option (for setting envelope
18354 senders on non-SMTP messages) or the SMTP MAIL command (if &%-bs%& or &%-bS%&
18355 is used) is ignored.
18356
18357 However, untrusted users are permitted to set an empty envelope sender address,
18358 to declare that a message should never generate any bounces. For example:
18359 .code
18360 exim -f '<>' user@domain.example
18361 .endd
18362 .vindex "&$sender_ident$&"
18363 The &%untrusted_set_sender%& option allows you to permit untrusted users to set
18364 other envelope sender addresses in a controlled way. When it is set, untrusted
18365 users are allowed to set envelope sender addresses that match any of the
18366 patterns in the list. Like all address lists, the string is expanded. The
18367 identity of the user is in &$sender_ident$&, so you can, for example, restrict
18368 users to setting senders that start with their login ids
18369 followed by a hyphen
18370 by a setting like this:
18371 .code
18372 untrusted_set_sender = ^$sender_ident-
18373 .endd
18374 If you want to allow untrusted users to set envelope sender addresses without
18375 restriction, you can use
18376 .code
18377 untrusted_set_sender = *
18378 .endd
18379 The &%untrusted_set_sender%& option applies to all forms of local input, but
18380 only to the setting of the envelope sender. It does not permit untrusted users
18381 to use the other options which trusted user can use to override message
18382 parameters. Furthermore, it does not stop Exim from removing an existing
18383 &'Sender:'& header in the message, or from adding a &'Sender:'& header if
18384 necessary. See &%local_sender_retain%& and &%local_from_check%& for ways of
18385 overriding these actions. The handling of the &'Sender:'& header is also
18386 described in section &<<SECTthesenhea>>&.
18387
18388 The log line for a message's arrival shows the envelope sender following
18389 &"<="&. For local messages, the user's login always follows, after &"U="&. In
18390 &%-bp%& displays, and in the Exim monitor, if an untrusted user sets an
18391 envelope sender address, the user's login is shown in parentheses after the
18392 sender address.
18393
18394
18395 .option uucp_from_pattern main string "see below"
18396 .cindex "&""From""& line"
18397 .cindex "UUCP" "&""From""& line"
18398 Some applications that pass messages to an MTA via a command line interface use
18399 an initial line starting with &"From&~"& to pass the envelope sender. In
18400 particular, this is used by UUCP software. Exim recognizes such a line by means
18401 of a regular expression that is set in &%uucp_from_pattern%&. When the pattern
18402 matches, the sender address is constructed by expanding the contents of
18403 &%uucp_from_sender%&, provided that the caller of Exim is a trusted user. The
18404 default pattern recognizes lines in the following two forms:
18405 .code
18406 From ph10 Fri Jan  5 12:35 GMT 1996
18407 From ph10 Fri, 7 Jan 97 14:00:00 GMT
18408 .endd
18409 The pattern can be seen by running
18410 .code
18411 exim -bP uucp_from_pattern
18412 .endd
18413 It checks only up to the hours and minutes, and allows for a 2-digit or 4-digit
18414 year in the second case. The first word after &"From&~"& is matched in the
18415 regular expression by a parenthesized subpattern. The default value for
18416 &%uucp_from_sender%& is &"$1"&, which therefore just uses this first word
18417 (&"ph10"& in the example above) as the message's sender. See also
18418 &%ignore_fromline_hosts%&.
18419
18420
18421 .option uucp_from_sender main string&!! &`$1`&
18422 See &%uucp_from_pattern%& above.
18423
18424
18425 .option warn_message_file main string&!! unset
18426 .cindex "warning of delay" "customizing the message"
18427 .cindex "customizing" "warning message"
18428 This option defines a template file containing paragraphs of text to be used
18429 for constructing the warning message which is sent by Exim when a message has
18430 been in the queue for a specified amount of time, as specified by
18431 &%delay_warning%&. Details of the file's contents are given in chapter
18432 &<<CHAPemsgcust>>&.
18433 .new
18434 .cindex warn_message_file "tainted data"
18435 The option is expanded to give the file path, which must be
18436 absolute and untainted.
18437 .wen
18438 See also &%bounce_message_file%&.
18439
18440
18441 .option write_rejectlog main boolean true
18442 .cindex "reject log" "disabling"
18443 If this option is set false, Exim no longer writes anything to the reject log.
18444 See chapter &<<CHAPlog>>& for details of what Exim writes to its logs.
18445 .ecindex IIDconfima
18446 .ecindex IIDmaiconf
18447
18448
18449
18450
18451 . ////////////////////////////////////////////////////////////////////////////
18452 . ////////////////////////////////////////////////////////////////////////////
18453
18454 .chapter "Generic options for routers" "CHAProutergeneric"
18455 .scindex IIDgenoprou1 "options" "generic; for routers"
18456 .scindex IIDgenoprou2 "generic options" "router"
18457 This chapter describes the generic options that apply to all routers.
18458 Those that are preconditions are marked with &Dagger; in the &"use"& field.
18459
18460 For a general description of how a router operates, see sections
18461 &<<SECTrunindrou>>& and &<<SECTrouprecon>>&. The latter specifies the order in
18462 which the preconditions are tested. The order of expansion of the options that
18463 provide data for a transport is: &%errors_to%&, &%headers_add%&,
18464 &%headers_remove%&, &%transport%&.
18465
18466
18467
18468 .option address_data routers string&!! unset
18469 .cindex "router" "data attached to address"
18470 The string is expanded just before the router is run, that is, after all the
18471 precondition tests have succeeded. If the expansion is forced to fail, the
18472 router declines, the value of &%address_data%& remains unchanged, and the
18473 &%more%& option controls what happens next. Other expansion failures cause
18474 delivery of the address to be deferred.
18475
18476 .vindex "&$address_data$&"
18477 When the expansion succeeds, the value is retained with the address, and can be
18478 accessed using the variable &$address_data$& in the current router, subsequent
18479 routers, and the eventual transport.
18480
18481 &*Warning*&: If the current or any subsequent router is a &(redirect)& router
18482 that runs a user's filter file, the contents of &$address_data$& are accessible
18483 in the filter. This is not normally a problem, because such data is usually
18484 either not confidential or it &"belongs"& to the current user, but if you do
18485 put confidential data into &$address_data$& you need to remember this point.
18486
18487 Even if the router declines or passes, the value of &$address_data$& remains
18488 with the address, though it can be changed by another &%address_data%& setting
18489 on a subsequent router. If a router generates child addresses, the value of
18490 &$address_data$& propagates to them. This also applies to the special kind of
18491 &"child"& that is generated by a router with the &%unseen%& option.
18492
18493 The idea of &%address_data%& is that you can use it to look up a lot of data
18494 for the address once, and then pick out parts of the data later. For example,
18495 you could use a single LDAP lookup to return a string of the form
18496 .code
18497 uid=1234 gid=5678 mailbox=/mail/xyz forward=/home/xyz/.forward
18498 .endd
18499 In the transport you could pick out the mailbox by a setting such as
18500 .code
18501 file = ${extract{mailbox}{$address_data}}
18502 .endd
18503 This makes the configuration file less messy, and also reduces the number of
18504 lookups (though Exim does cache lookups).
18505
18506 See also the &%set%& option below.
18507
18508 .vindex "&$sender_address_data$&"
18509 .vindex "&$address_data$&"
18510 The &%address_data%& facility is also useful as a means of passing information
18511 from one router to another, and from a router to a transport. In addition, if
18512 &$address_data$& is set by a router when verifying a recipient address from an
18513 ACL, it remains available for use in the rest of the ACL statement. After
18514 verifying a sender, the value is transferred to &$sender_address_data$&.
18515
18516
18517
18518 .option address_test routers&!? boolean true
18519 .oindex "&%-bt%&"
18520 .cindex "router" "skipping when address testing"
18521 If this option is set false, the router is skipped when routing is being tested
18522 by means of the &%-bt%& command line option. This can be a convenience when
18523 your first router sends messages to an external scanner, because it saves you
18524 having to set the &"already scanned"& indicator when testing real address
18525 routing.
18526
18527
18528
18529 .option cannot_route_message routers string&!! unset
18530 .cindex "router" "customizing &""cannot route""& message"
18531 .cindex "customizing" "&""cannot route""& message"
18532 This option specifies a text message that is used when an address cannot be
18533 routed because Exim has run out of routers. The default message is
18534 &"Unrouteable address"&. This option is useful only on routers that have
18535 &%more%& set false, or on the very last router in a configuration, because the
18536 value that is used is taken from the last router that is considered. This
18537 includes a router that is skipped because its preconditions are not met, as
18538 well as a router that declines. For example, using the default configuration,
18539 you could put:
18540 .code
18541 cannot_route_message = Remote domain not found in DNS
18542 .endd
18543 on the first router, which is a &(dnslookup)& router with &%more%& set false,
18544 and
18545 .code
18546 cannot_route_message = Unknown local user
18547 .endd
18548 on the final router that checks for local users. If string expansion fails for
18549 this option, the default message is used. Unless the expansion failure was
18550 explicitly forced, a message about the failure is written to the main and panic
18551 logs, in addition to the normal message about the routing failure.
18552
18553
18554 .option caseful_local_part routers boolean false
18555 .cindex "case of local parts"
18556 .cindex "router" "case of local parts"
18557 By default, routers handle the local parts of addresses in a case-insensitive
18558 manner, though the actual case is preserved for transmission with the message.
18559 If you want the case of letters to be significant in a router, you must set
18560 this option true. For individual router options that contain address or local
18561 part lists (for example, &%local_parts%&), case-sensitive matching can be
18562 turned on by &"+caseful"& as a list item. See section &<<SECTcasletadd>>& for
18563 more details.
18564
18565 .vindex "&$local_part$&"
18566 .vindex "&$original_local_part$&"
18567 .vindex "&$parent_local_part$&"
18568 The value of the &$local_part$& variable is forced to lower case while a
18569 router is running unless &%caseful_local_part%& is set. When a router assigns
18570 an address to a transport, the value of &$local_part$& when the transport runs
18571 is the same as it was in the router. Similarly, when a router generates child
18572 addresses by aliasing or forwarding, the values of &$original_local_part$&
18573 and &$parent_local_part$& are those that were used by the redirecting router.
18574
18575 This option applies to the processing of an address by a router. When a
18576 recipient address is being processed in an ACL, there is a separate &%control%&
18577 modifier that can be used to specify case-sensitive processing within the ACL
18578 (see section &<<SECTcontrols>>&).
18579
18580
18581
18582 .option check_local_user routers&!? boolean false
18583 .cindex "local user, checking in router"
18584 .cindex "router" "checking for local user"
18585 .cindex "&_/etc/passwd_&"
18586 .vindex "&$home$&"
18587 When this option is true, Exim checks that the local part of the recipient
18588 address (with affixes removed if relevant) is the name of an account on the
18589 local system. The check is done by calling the &[getpwnam()]& function rather
18590 than trying to read &_/etc/passwd_& directly. This means that other methods of
18591 holding password data (such as NIS) are supported. If the local part is a local
18592 user, &$home$& is set from the password data, and can be tested in other
18593 preconditions that are evaluated after this one (the order of evaluation is
18594 given in section &<<SECTrouprecon>>&). However, the value of &$home$& can be
18595 overridden by &%router_home_directory%&. If the local part is not a local user,
18596 the router is skipped.
18597
18598 If you want to check that the local part is either the name of a local user
18599 or matches something else, you cannot combine &%check_local_user%& with a
18600 setting of &%local_parts%&, because that specifies the logical &'and'& of the
18601 two conditions. However, you can use a &(passwd)& lookup in a &%local_parts%&
18602 setting to achieve this. For example:
18603 .code
18604 local_parts = passwd;$local_part : lsearch;/etc/other/users
18605 .endd
18606 Note, however, that the side effects of &%check_local_user%& (such as setting
18607 up a home directory) do not occur when a &(passwd)& lookup is used in a
18608 &%local_parts%& (or any other) precondition.
18609
18610
18611
18612 .option condition routers&!? string&!! unset
18613 .cindex "router" "customized precondition"
18614 This option specifies a general precondition test that has to succeed for the
18615 router to be called. The &%condition%& option is the last precondition to be
18616 evaluated (see section &<<SECTrouprecon>>&). The string is expanded, and if the
18617 result is a forced failure, or an empty string, or one of the strings &"0"& or
18618 &"no"& or &"false"& (checked without regard to the case of the letters), the
18619 router is skipped, and the address is offered to the next one.
18620
18621 If the result is any other value, the router is run (as this is the last
18622 precondition to be evaluated, all the other preconditions must be true).
18623
18624 This option is unusual in that multiple &%condition%& options may be present.
18625 All &%condition%& options must succeed.
18626
18627 The &%condition%& option provides a means of applying custom conditions to the
18628 running of routers. Note that in the case of a simple conditional expansion,
18629 the default expansion values are exactly what is wanted. For example:
18630 .code
18631 condition = ${if >{$message_age}{600}}
18632 .endd
18633 Because of the default behaviour of the string expansion, this is equivalent to
18634 .code
18635 condition = ${if >{$message_age}{600}{true}{}}
18636 .endd
18637
18638 A multiple condition example, which succeeds:
18639 .code
18640 condition = ${if >{$message_age}{600}}
18641 condition = ${if !eq{${lc:$local_part}}{postmaster}}
18642 condition = foobar
18643 .endd
18644
18645 If the expansion fails (other than forced failure) delivery is deferred. Some
18646 of the other precondition options are common special cases that could in fact
18647 be specified using &%condition%&.
18648
18649 Historical note: We have &%condition%& on ACLs and on Routers.  Routers
18650 are far older, and use one set of semantics.  ACLs are newer and when
18651 they were created, the ACL &%condition%& process was given far stricter
18652 parse semantics.  The &%bool{}%& expansion condition uses the same rules as
18653 ACLs.  The &%bool_lax{}%& expansion condition uses the same rules as
18654 Routers.  More pointedly, the &%bool_lax{}%& was written to match the existing
18655 Router rules processing behavior.
18656
18657 This is best illustrated in an example:
18658 .code
18659 # If used in an ACL condition will fail with a syntax error, but
18660 # in a router condition any extra characters are treated as a string
18661
18662 $ exim -be '${if eq {${lc:GOOGLE.com}} {google.com}} {yes} {no}}'
18663 true {yes} {no}}
18664
18665 $ exim -be '${if eq {${lc:WHOIS.com}} {google.com}} {yes} {no}}'
18666  {yes} {no}}
18667 .endd
18668 In each example above, the &%if%& statement actually ends after
18669 &"{google.com}}"&.  Since no true or false braces were defined, the
18670 default &%if%& behavior is to return a boolean true or a null answer
18671 (which evaluates to false). The rest of the line is then treated as a
18672 string. So the first example resulted in the boolean answer &"true"&
18673 with the string &" {yes} {no}}"& appended to it. The second example
18674 resulted in the null output (indicating false) with the string
18675 &" {yes} {no}}"& appended to it.
18676
18677 In fact you can put excess forward braces in too.  In the router
18678 &%condition%&, Exim's parser only looks for &"{"& symbols when they
18679 mean something, like after a &"$"& or when required as part of a
18680 conditional.  But otherwise &"{"& and &"}"& are treated as ordinary
18681 string characters.
18682
18683 Thus, in a Router, the above expansion strings will both always evaluate
18684 true, as the result of expansion is a non-empty string which doesn't
18685 match an explicit false value.  This can be tricky to debug.  By
18686 contrast, in an ACL either of those strings will always result in an
18687 expansion error because the result doesn't look sufficiently boolean.
18688
18689
18690 .option debug_print routers string&!! unset
18691 .cindex "testing" "variables in drivers"
18692 If this option is set and debugging is enabled (see the &%-d%& command line
18693 option) or in address-testing mode (see the &%-bt%& command line option),
18694 the string is expanded and included in the debugging output.
18695 If expansion of the string fails, the error message is written to the debugging
18696 output, and Exim carries on processing.
18697 This option is provided to help with checking out the values of variables and
18698 so on when debugging router configurations. For example, if a &%condition%&
18699 option appears not to be working, &%debug_print%& can be used to output the
18700 variables it references. The output happens after checks for &%domains%&,
18701 &%local_parts%&, and &%check_local_user%& but before any other preconditions
18702 are tested. A newline is added to the text if it does not end with one.
18703 The variable &$router_name$& contains the name of the router.
18704
18705
18706
18707 .option disable_logging routers boolean false
18708 If this option is set true, nothing is logged for any routing errors
18709 or for any deliveries caused by this router. You should not set this option
18710 unless you really, really know what you are doing. See also the generic
18711 transport option of the same name.
18712
18713 .option dnssec_request_domains routers "domain list&!!" *
18714 .cindex "MX record" "security"
18715 .cindex "DNSSEC" "MX lookup"
18716 .cindex "security" "MX lookup"
18717 .cindex "DNS" "DNSSEC"
18718 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
18719 the dnssec request bit set.
18720 This applies to all of the SRV, MX, AAAA, A lookup sequence.
18721
18722 .option dnssec_require_domains routers "domain list&!!" unset
18723 .cindex "MX record" "security"
18724 .cindex "DNSSEC" "MX lookup"
18725 .cindex "security" "MX lookup"
18726 .cindex "DNS" "DNSSEC"
18727 DNS lookups for domains matching &%dnssec_require_domains%& will be done with
18728 the dnssec request bit set.  Any returns not having the Authenticated Data bit
18729 (AD bit) set will be ignored and logged as a host-lookup failure.
18730 This applies to all of the SRV, MX, AAAA, A lookup sequence.
18731
18732
18733 .option domains routers&!? "domain list&!!" unset
18734 .cindex "router" "restricting to specific domains"
18735 .vindex "&$domain_data$&"
18736 If this option is set, the router is skipped unless the current domain matches
18737 the list. If the match is achieved by means of a file lookup, the data that the
18738 lookup returned for the domain is placed in &$domain_data$& for use in string
18739 expansions of the driver's private options. See section &<<SECTrouprecon>>& for
18740 a list of the order in which preconditions are evaluated.
18741
18742
18743
18744 .option driver routers string unset
18745 This option must always be set. It specifies which of the available routers is
18746 to be used.
18747
18748
18749 .option dsn_lasthop routers boolean false
18750 .cindex "DSN" "success"
18751 .cindex "Delivery Status Notification" "success"
18752 If this option is set true, and extended DSN (RFC3461) processing is in effect,
18753 Exim will not pass on DSN requests to downstream DSN-aware hosts but will
18754 instead send a success DSN as if the next hop does not support DSN.
18755 Not effective on redirect routers.
18756
18757
18758
18759 .option errors_to routers string&!! unset
18760 .cindex "envelope from"
18761 .cindex "envelope sender"
18762 .cindex "router" "changing address for errors"
18763 If a router successfully handles an address, it may assign the address to a
18764 transport for delivery or it may generate child addresses. In both cases, if
18765 there is a delivery problem during later processing, the resulting bounce
18766 message is sent to the address that results from expanding this string,
18767 provided that the address verifies successfully. The &%errors_to%& option is
18768 expanded before &%headers_add%&, &%headers_remove%&, and &%transport%&.
18769
18770 The &%errors_to%& setting associated with an address can be overridden if it
18771 subsequently passes through other routers that have their own &%errors_to%&
18772 settings, or if the message is delivered by a transport with a &%return_path%&
18773 setting.
18774
18775 If &%errors_to%& is unset, or the expansion is forced to fail, or the result of
18776 the expansion fails to verify, the errors address associated with the incoming
18777 address is used. At top level, this is the envelope sender. A non-forced
18778 expansion failure causes delivery to be deferred.
18779
18780 If an address for which &%errors_to%& has been set ends up being delivered over
18781 SMTP, the envelope sender for that delivery is the &%errors_to%& value, so that
18782 any bounces that are generated by other MTAs on the delivery route are also
18783 sent there. You can set &%errors_to%& to the empty string by either of these
18784 settings:
18785 .code
18786 errors_to =
18787 errors_to = ""
18788 .endd
18789 An expansion item that yields an empty string has the same effect. If you do
18790 this, a locally detected delivery error for addresses processed by this router
18791 no longer gives rise to a bounce message; the error is discarded. If the
18792 address is delivered to a remote host, the return path is set to &`<>`&, unless
18793 overridden by the &%return_path%& option on the transport.
18794
18795 .vindex "&$address_data$&"
18796 If for some reason you want to discard local errors, but use a non-empty
18797 MAIL command for remote delivery, you can preserve the original return
18798 path in &$address_data$& in the router, and reinstate it in the transport by
18799 setting &%return_path%&.
18800
18801 The most common use of &%errors_to%& is to direct mailing list bounces to the
18802 manager of the list, as described in section &<<SECTmailinglists>>&, or to
18803 implement VERP (Variable Envelope Return Paths) (see section &<<SECTverp>>&).
18804
18805
18806
18807 .option expn routers&!? boolean true
18808 .cindex "address" "testing"
18809 .cindex "testing" "addresses"
18810 .cindex "EXPN" "router skipping"
18811 .cindex "router" "skipping for EXPN"
18812 If this option is turned off, the router is skipped when testing an address
18813 as a result of processing an SMTP EXPN command. You might, for example,
18814 want to turn it off on a router for users' &_.forward_& files, while leaving it
18815 on for the system alias file.
18816 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
18817 are evaluated.
18818
18819 The use of the SMTP EXPN command is controlled by an ACL (see chapter
18820 &<<CHAPACL>>&). When Exim is running an EXPN command, it is similar to testing
18821 an address with &%-bt%&. Compare VRFY, whose counterpart is &%-bv%&.
18822
18823
18824
18825 .option fail_verify routers boolean false
18826 .cindex "router" "forcing verification failure"
18827 Setting this option has the effect of setting both &%fail_verify_sender%& and
18828 &%fail_verify_recipient%& to the same value.
18829
18830
18831
18832 .option fail_verify_recipient routers boolean false
18833 If this option is true and an address is accepted by this router when
18834 verifying a recipient, verification fails.
18835
18836
18837
18838 .option fail_verify_sender routers boolean false
18839 If this option is true and an address is accepted by this router when
18840 verifying a sender, verification fails.
18841
18842
18843
18844 .option fallback_hosts routers "string list" unset
18845 .cindex "router" "fallback hosts"
18846 .cindex "fallback" "hosts specified on router"
18847 String expansion is not applied to this option. The argument must be a
18848 colon-separated list of host names or IP addresses. The list separator can be
18849 changed (see section &<<SECTlistsepchange>>&), and a port can be specified with
18850 each name or address. In fact, the format of each item is exactly the same as
18851 defined for the list of hosts in a &(manualroute)& router (see section
18852 &<<SECTformatonehostitem>>&).
18853
18854 If a router queues an address for a remote transport, this host list is
18855 associated with the address, and used instead of the transport's fallback host
18856 list. If &%hosts_randomize%& is set on the transport, the order of the list is
18857 randomized for each use. See the &%fallback_hosts%& option of the &(smtp)&
18858 transport for further details.
18859
18860
18861 .option group routers string&!! "see below"
18862 .cindex "gid (group id)" "local delivery"
18863 .cindex "local transports" "uid and gid"
18864 .cindex "transport" "local"
18865 .cindex "router" "setting group"
18866 When a router queues an address for a transport, and the transport does not
18867 specify a group, the group given here is used when running the delivery
18868 process.
18869 The group may be specified numerically or by name. If expansion fails, the
18870 error is logged and delivery is deferred.
18871 The default is unset, unless &%check_local_user%& is set, when the default
18872 is taken from the password information. See also &%initgroups%& and &%user%&
18873 and the discussion in chapter &<<CHAPenvironment>>&.
18874
18875
18876
18877 .option headers_add routers list&!! unset
18878 .cindex "header lines" "adding"
18879 .cindex "router" "adding header lines"
18880 This option specifies a list of text headers,
18881 newline-separated (by default, changeable in the usual way &<<SECTlistsepchange>>&),
18882 that is associated with any addresses that are accepted by the router.
18883 Each item is separately expanded, at routing time.  However, this
18884 option has no effect when an address is just being verified. The way in which
18885 the text is used to add header lines at transport time is described in section
18886 &<<SECTheadersaddrem>>&. New header lines are not actually added until the
18887 message is in the process of being transported. This means that references to
18888 header lines in string expansions in the transport's configuration do not
18889 &"see"& the added header lines.
18890
18891 The &%headers_add%& option is expanded after &%errors_to%&, but before
18892 &%headers_remove%& and &%transport%&. If an item is empty, or if
18893 an item expansion is forced to fail, the item has no effect. Other expansion
18894 failures are treated as configuration errors.
18895
18896 Unlike most options, &%headers_add%& can be specified multiple times
18897 for a router; all listed headers are added.
18898
18899 &*Warning 1*&: The &%headers_add%& option cannot be used for a &(redirect)&
18900 router that has the &%one_time%& option set.
18901
18902 .cindex "duplicate addresses"
18903 .oindex "&%unseen%&"
18904 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
18905 additions are deleted when the address is passed on to subsequent routers.
18906 For a &%redirect%& router, if a generated address is the same as the incoming
18907 address, this can lead to duplicate addresses with different header
18908 modifications. Exim does not do duplicate deliveries (except, in certain
18909 circumstances, to pipes -- see section &<<SECTdupaddr>>&), but it is undefined
18910 which of the duplicates is discarded, so this ambiguous situation should be
18911 avoided. The &%repeat_use%& option of the &%redirect%& router may be of help.
18912
18913
18914
18915 .option headers_remove routers list&!! unset
18916 .cindex "header lines" "removing"
18917 .cindex "router" "removing header lines"
18918 This option specifies a list of text headers,
18919 colon-separated (by default, changeable in the usual way &<<SECTlistsepchange>>&),
18920 that is associated with any addresses that are accepted by the router.
18921 However, the option has no effect when an address is just being verified.
18922 Each list item is separately expanded, at transport time.
18923 .new
18924 If an item ends in *, it will match any header with the given prefix.
18925 .wen
18926 The way in which
18927 the text is used to remove header lines at transport time is described in
18928 section &<<SECTheadersaddrem>>&. Header lines are not actually removed until
18929 the message is in the process of being transported. This means that references
18930 to header lines in string expansions in the transport's configuration still
18931 &"see"& the original header lines.
18932
18933 The &%headers_remove%& option is handled after &%errors_to%& and
18934 &%headers_add%&, but before &%transport%&. If an item expansion is forced to fail,
18935 the item has no effect. Other expansion failures are treated as configuration
18936 errors.
18937
18938 Unlike most options, &%headers_remove%& can be specified multiple times
18939 for a router; all listed headers are removed.
18940
18941 &*Warning 1*&: The &%headers_remove%& option cannot be used for a &(redirect)&
18942 router that has the &%one_time%& option set.
18943
18944 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
18945 removal requests are deleted when the address is passed on to subsequent
18946 routers, and this can lead to problems with duplicates -- see the similar
18947 warning for &%headers_add%& above.
18948
18949 &*Warning 3*&: Because of the separate expansion of the list items,
18950 items that contain a list separator must have it doubled.
18951 To avoid this, change the list separator (&<<SECTlistsepchange>>&).
18952
18953
18954
18955 .option ignore_target_hosts routers "host list&!!" unset
18956 .cindex "IP address" "discarding"
18957 .cindex "router" "discarding IP addresses"
18958 Although this option is a host list, it should normally contain IP address
18959 entries rather than names. If any host that is looked up by the router has an
18960 IP address that matches an item in this list, Exim behaves as if that IP
18961 address did not exist. This option allows you to cope with rogue DNS entries
18962 like
18963 .code
18964 remote.domain.example.  A  127.0.0.1
18965 .endd
18966 by setting
18967 .code
18968 ignore_target_hosts = 127.0.0.1
18969 .endd
18970 on the relevant router. If all the hosts found by a &(dnslookup)& router are
18971 discarded in this way, the router declines. In a conventional configuration, an
18972 attempt to mail to such a domain would normally provoke the &"unrouteable
18973 domain"& error, and an attempt to verify an address in the domain would fail.
18974 Similarly, if &%ignore_target_hosts%& is set on an &(ipliteral)& router, the
18975 router declines if presented with one of the listed addresses.
18976
18977 You can use this option to disable the use of IPv4 or IPv6 for mail delivery by
18978 means of the first or the second of the following settings, respectively:
18979 .code
18980 ignore_target_hosts = 0.0.0.0/0
18981 ignore_target_hosts = <; 0::0/0
18982 .endd
18983 The pattern in the first line matches all IPv4 addresses, whereas the pattern
18984 in the second line matches all IPv6 addresses.
18985
18986 This option may also be useful for ignoring link-local and site-local IPv6
18987 addresses. Because, like all host lists, the value of &%ignore_target_hosts%&
18988 is expanded before use as a list, it is possible to make it dependent on the
18989 domain that is being routed.
18990
18991 .vindex "&$host_address$&"
18992 During its expansion, &$host_address$& is set to the IP address that is being
18993 checked.
18994
18995 .option initgroups routers boolean false
18996 .cindex "additional groups"
18997 .cindex "groups" "additional"
18998 .cindex "local transports" "uid and gid"
18999 .cindex "transport" "local"
19000 If the router queues an address for a transport, and this option is true, and
19001 the uid supplied by the router is not overridden by the transport, the
19002 &[initgroups()]& function is called when running the transport to ensure that
19003 any additional groups associated with the uid are set up. See also &%group%&
19004 and &%user%& and the discussion in chapter &<<CHAPenvironment>>&.
19005
19006
19007
19008 .option local_part_prefix routers&!? "string list" unset
19009 .cindex affix "router precondition"
19010 .cindex "router" "prefix for local part"
19011 .cindex "prefix" "for local part, used in router"
19012 If this option is set, the router is skipped unless the local part starts with
19013 one of the given strings, or &%local_part_prefix_optional%& is true. See
19014 section &<<SECTrouprecon>>& for a list of the order in which preconditions are
19015 evaluated.
19016
19017 The list is scanned from left to right, and the first prefix that matches is
19018 used. A limited form of wildcard is available; if the prefix begins with an
19019 asterisk, it matches the longest possible sequence of arbitrary characters at
19020 the start of the local part. An asterisk should therefore always be followed by
19021 some character that does not occur in normal local parts.
19022 .cindex "multiple mailboxes"
19023 .cindex "mailbox" "multiple"
19024 Wildcarding can be used to set up multiple user mailboxes, as described in
19025 section &<<SECTmulbox>>&.
19026
19027 .vindex "&$local_part$&"
19028 .vindex "&$local_part_prefix$&"
19029 During the testing of the &%local_parts%& option, and while the router is
19030 running, the prefix is removed from the local part, and is available in the
19031 expansion variable &$local_part_prefix$&. When a message is being delivered, if
19032 the router accepts the address, this remains true during subsequent delivery by
19033 a transport. In particular, the local part that is transmitted in the RCPT
19034 command for LMTP, SMTP, and BSMTP deliveries has the prefix removed by default.
19035 This behaviour can be overridden by setting &%rcpt_include_affixes%& true on
19036 the relevant transport.
19037
19038 .new
19039 .vindex &$local_part_prefix_v$&
19040 If wildcarding (above) was used then the part of the prefix matching the
19041 wildcard is available in &$local_part_prefix_v$&.
19042 .wen
19043
19044 When an address is being verified, &%local_part_prefix%& affects only the
19045 behaviour of the router. If the callout feature of verification is in use, this
19046 means that the full address, including the prefix, will be used during the
19047 callout.
19048
19049 The prefix facility is commonly used to handle local parts of the form
19050 &%owner-something%&. Another common use is to support local parts of the form
19051 &%real-username%& to bypass a user's &_.forward_& file &-- helpful when trying
19052 to tell a user their forwarding is broken &-- by placing a router like this one
19053 immediately before the router that handles &_.forward_& files:
19054 .code
19055 real_localuser:
19056   driver = accept
19057   local_part_prefix = real-
19058   check_local_user
19059   transport = local_delivery
19060 .endd
19061 For security, it would probably be a good idea to restrict the use of this
19062 router to locally-generated messages, using a condition such as this:
19063 .code
19064   condition = ${if match {$sender_host_address}\
19065                          {\N^(|127\.0\.0\.1)$\N}}
19066 .endd
19067
19068 If both &%local_part_prefix%& and &%local_part_suffix%& are set for a router,
19069 both conditions must be met if not optional. Care must be taken if wildcards
19070 are used in both a prefix and a suffix on the same router. Different
19071 separator characters must be used to avoid ambiguity.
19072
19073
19074 .option local_part_prefix_optional routers boolean false
19075 See &%local_part_prefix%& above.
19076
19077
19078
19079 .option local_part_suffix routers&!? "string list" unset
19080 .cindex "router" "suffix for local part"
19081 .cindex "suffix for local part" "used in router"
19082 This option operates in the same way as &%local_part_prefix%&, except that the
19083 local part must end (rather than start) with the given string, the
19084 &%local_part_suffix_optional%& option determines whether the suffix is
19085 mandatory, and the wildcard * character, if present, must be the last
19086 character of the suffix. This option facility is commonly used to handle local
19087 parts of the form &%something-request%& and multiple user mailboxes of the form
19088 &%username-foo%&.
19089
19090
19091 .option local_part_suffix_optional routers boolean false
19092 See &%local_part_suffix%& above.
19093
19094
19095
19096 .option local_parts routers&!? "local part list&!!" unset
19097 .cindex "router" "restricting to specific local parts"
19098 .cindex "local part" "checking in router"
19099 The router is run only if the local part of the address matches the list.
19100 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
19101 are evaluated, and
19102 section &<<SECTlocparlis>>& for a discussion of local part lists. Because the
19103 string is expanded, it is possible to make it depend on the domain, for
19104 example:
19105 .code
19106 local_parts = dbm;/usr/local/specials/$domain
19107 .endd
19108 .vindex "&$local_part_data$&"
19109 If the match is achieved by a lookup, the data that the lookup returned
19110 for the local part is placed in the variable &$local_part_data$& for use in
19111 expansions of the router's private options. You might use this option, for
19112 example, if you have a large number of local virtual domains, and you want to
19113 send all postmaster mail to the same place without having to set up an alias in
19114 each virtual domain:
19115 .code
19116 postmaster:
19117   driver = redirect
19118   local_parts = postmaster
19119   data = postmaster@real.domain.example
19120 .endd
19121
19122
19123 .option log_as_local routers boolean "see below"
19124 .cindex "log" "delivery line"
19125 .cindex "delivery" "log line format"
19126 Exim has two logging styles for delivery, the idea being to make local
19127 deliveries stand out more visibly from remote ones. In the &"local"& style, the
19128 recipient address is given just as the local part, without a domain. The use of
19129 this style is controlled by this option. It defaults to true for the &(accept)&
19130 router, and false for all the others. This option applies only when a
19131 router assigns an address to a transport. It has no effect on routers that
19132 redirect addresses.
19133
19134
19135
19136 .option more routers boolean&!! true
19137 The result of string expansion for this option must be a valid boolean value,
19138 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
19139 result causes an error, and delivery is deferred. If the expansion is forced to
19140 fail, the default value for the option (true) is used. Other failures cause
19141 delivery to be deferred.
19142
19143 If this option is set false, and the router declines to handle the address, no
19144 further routers are tried, routing fails, and the address is bounced.
19145 .oindex "&%self%&"
19146 However, if the router explicitly passes an address to the following router by
19147 means of the setting
19148 .code
19149 self = pass
19150 .endd
19151 or otherwise, the setting of &%more%& is ignored. Also, the setting of &%more%&
19152 does not affect the behaviour if one of the precondition tests fails. In that
19153 case, the address is always passed to the next router.
19154
19155 Note that &%address_data%& is not considered to be a precondition. If its
19156 expansion is forced to fail, the router declines, and the value of &%more%&
19157 controls what happens next.
19158
19159
19160 .option pass_on_timeout routers boolean false
19161 .cindex "timeout" "of router"
19162 .cindex "router" "timeout"
19163 If a router times out during a host lookup, it normally causes deferral of the
19164 address. If &%pass_on_timeout%& is set, the address is passed on to the next
19165 router, overriding &%no_more%&. This may be helpful for systems that are
19166 intermittently connected to the Internet, or those that want to pass to a smart
19167 host any messages that cannot immediately be delivered.
19168
19169 There are occasional other temporary errors that can occur while doing DNS
19170 lookups. They are treated in the same way as a timeout, and this option
19171 applies to all of them.
19172
19173
19174
19175 .option pass_router routers string unset
19176 .cindex "router" "go to after &""pass""&"
19177 Routers that recognize the generic &%self%& option (&(dnslookup)&,
19178 &(ipliteral)&, and &(manualroute)&) are able to return &"pass"&, forcing
19179 routing to continue, and overriding a false setting of &%more%&. When one of
19180 these routers returns &"pass"&, the address is normally handed on to the next
19181 router in sequence. This can be changed by setting &%pass_router%& to the name
19182 of another router. However (unlike &%redirect_router%&) the named router must
19183 be below the current router, to avoid loops. Note that this option applies only
19184 to the special case of &"pass"&. It does not apply when a router returns
19185 &"decline"& because it cannot handle an address.
19186
19187
19188
19189 .option redirect_router routers string unset
19190 .cindex "router" "start at after redirection"
19191 Sometimes an administrator knows that it is pointless to reprocess addresses
19192 generated from alias or forward files with the same router again. For
19193 example, if an alias file translates real names into login ids there is no
19194 point searching the alias file a second time, especially if it is a large file.
19195
19196 The &%redirect_router%& option can be set to the name of any router instance.
19197 It causes the routing of any generated addresses to start at the named router
19198 instead of at the first router. This option has no effect if the router in
19199 which it is set does not generate new addresses.
19200
19201
19202
19203 .option require_files routers&!? "string list&!!" unset
19204 .cindex "file" "requiring for router"
19205 .cindex "router" "requiring file existence"
19206 This option provides a general mechanism for predicating the running of a
19207 router on the existence or non-existence of certain files or directories.
19208 Before running a router, as one of its precondition tests, Exim works its way
19209 through the &%require_files%& list, expanding each item separately.
19210
19211 Because the list is split before expansion, any colons in expansion items must
19212 be doubled, or the facility for using a different list separator must be used
19213 (&<<SECTlistsepchange>>&).
19214 If any expansion is forced to fail, the item is ignored. Other expansion
19215 failures cause routing of the address to be deferred.
19216
19217 If any expanded string is empty, it is ignored. Otherwise, except as described
19218 below, each string must be a fully qualified file path, optionally preceded by
19219 &"!"&. The paths are passed to the &[stat()]& function to test for the
19220 existence of the files or directories. The router is skipped if any paths not
19221 preceded by &"!"& do not exist, or if any paths preceded by &"!"& do exist.
19222
19223 .cindex "NFS"
19224 If &[stat()]& cannot determine whether a file exists or not, delivery of
19225 the message is deferred. This can happen when NFS-mounted filesystems are
19226 unavailable.
19227
19228 This option is checked after the &%domains%&, &%local_parts%&, and &%senders%&
19229 options, so you cannot use it to check for the existence of a file in which to
19230 look up a domain, local part, or sender. (See section &<<SECTrouprecon>>& for a
19231 full list of the order in which preconditions are evaluated.) However, as
19232 these options are all expanded, you can use the &%exists%& expansion condition
19233 to make such tests. The &%require_files%& option is intended for checking files
19234 that the router may be going to use internally, or which are needed by a
19235 transport (e.g., &_.procmailrc_&).
19236
19237 During delivery, the &[stat()]& function is run as root, but there is a
19238 facility for some checking of the accessibility of a file by another user.
19239 This is not a proper permissions check, but just a &"rough"& check that
19240 operates as follows:
19241
19242 If an item in a &%require_files%& list does not contain any forward slash
19243 characters, it is taken to be the user (and optional group, separated by a
19244 comma) to be checked for subsequent files in the list. If no group is specified
19245 but the user is specified symbolically, the gid associated with the uid is
19246 used. For example:
19247 .code
19248 require_files = mail:/some/file
19249 require_files = $local_part_data:$home/.procmailrc
19250 .endd
19251 If a user or group name in a &%require_files%& list does not exist, the
19252 &%require_files%& condition fails.
19253
19254 Exim performs the check by scanning along the components of the file path, and
19255 checking the access for the given uid and gid. It checks for &"x"& access on
19256 directories, and &"r"& access on the final file. Note that this means that file
19257 access control lists, if the operating system has them, are ignored.
19258
19259 &*Warning 1*&: When the router is being run to verify addresses for an
19260 incoming SMTP message, Exim is not running as root, but under its own uid. This
19261 may affect the result of a &%require_files%& check. In particular, &[stat()]&
19262 may yield the error EACCES (&"Permission denied"&). This means that the Exim
19263 user is not permitted to read one of the directories on the file's path.
19264
19265 &*Warning 2*&: Even when Exim is running as root while delivering a message,
19266 &[stat()]& can yield EACCES for a file in an NFS directory that is mounted
19267 without root access. In this case, if a check for access by a particular user
19268 is requested, Exim creates a subprocess that runs as that user, and tries the
19269 check again in that process.
19270
19271 The default action for handling an unresolved EACCES is to consider it to
19272 be caused by a configuration error, and routing is deferred because the
19273 existence or non-existence of the file cannot be determined. However, in some
19274 circumstances it may be desirable to treat this condition as if the file did
19275 not exist. If the filename (or the exclamation mark that precedes the filename
19276 for non-existence) is preceded by a plus sign, the EACCES error is treated
19277 as if the file did not exist. For example:
19278 .code
19279 require_files = +/some/file
19280 .endd
19281 If the router is not an essential part of verification (for example, it
19282 handles users' &_.forward_& files), another solution is to set the &%verify%&
19283 option false so that the router is skipped when verifying.
19284
19285
19286
19287 .option retry_use_local_part routers boolean "see below"
19288 .cindex "hints database" "retry keys"
19289 .cindex "local part" "in retry keys"
19290 When a delivery suffers a temporary routing failure, a retry record is created
19291 in Exim's hints database. For addresses whose routing depends only on the
19292 domain, the key for the retry record should not involve the local part, but for
19293 other addresses, both the domain and the local part should be included.
19294 Usually, remote routing is of the former kind, and local routing is of the
19295 latter kind.
19296
19297 This option controls whether the local part is used to form the key for retry
19298 hints for addresses that suffer temporary errors while being handled by this
19299 router. The default value is true for any router that has any of
19300 &%check_local_user%&,
19301 &%local_parts%&,
19302 &%condition%&,
19303 &%local_part_prefix%&,
19304 &%local_part_suffix%&,
19305 &%senders%& or
19306 &%require_files%&
19307 set, and false otherwise. Note that this option does not apply to hints keys
19308 for transport delays; they are controlled by a generic transport option of the
19309 same name.
19310
19311 Failing to set this option when it is needed
19312 (because a remote router handles only some of the local-parts for a domain)
19313 can result in incorrect error messages being generated.
19314
19315 The setting of &%retry_use_local_part%& applies only to the router on which it
19316 appears. If the router generates child addresses, they are routed
19317 independently; this setting does not become attached to them.
19318
19319
19320
19321 .option router_home_directory routers string&!! unset
19322 .cindex "router" "home directory for"
19323 .cindex "home directory" "for router"
19324 .vindex "&$home$&"
19325 This option sets a home directory for use while the router is running. (Compare
19326 &%transport_home_directory%&, which sets a home directory for later
19327 transporting.) In particular, if used on a &(redirect)& router, this option
19328 sets a value for &$home$& while a filter is running. The value is expanded;
19329 forced expansion failure causes the option to be ignored &-- other failures
19330 cause the router to defer.
19331
19332 Expansion of &%router_home_directory%& happens immediately after the
19333 &%check_local_user%& test (if configured), before any further expansions take
19334 place.
19335 (See section &<<SECTrouprecon>>& for a list of the order in which preconditions
19336 are evaluated.)
19337 While the router is running, &%router_home_directory%& overrides the value of
19338 &$home$& that came from &%check_local_user%&.
19339
19340 When a router accepts an address and assigns it to a local transport (including
19341 the cases when a &(redirect)& router generates a pipe, file, or autoreply
19342 delivery), the home directory setting for the transport is taken from the first
19343 of these values that is set:
19344
19345 .ilist
19346 The &%home_directory%& option on the transport;
19347 .next
19348 The &%transport_home_directory%& option on the router;
19349 .next
19350 The password data if &%check_local_user%& is set on the router;
19351 .next
19352 The &%router_home_directory%& option on the router.
19353 .endlist
19354
19355 In other words, &%router_home_directory%& overrides the password data for the
19356 router, but not for the transport.
19357
19358
19359
19360 .option self routers string freeze
19361 .cindex "MX record" "pointing to local host"
19362 .cindex "local host" "MX pointing to"
19363 This option applies to those routers that use a recipient address to find a
19364 list of remote hosts. Currently, these are the &(dnslookup)&, &(ipliteral)&,
19365 and &(manualroute)& routers.
19366 Certain configurations of the &(queryprogram)& router can also specify a list
19367 of remote hosts.
19368 Usually such routers are configured to send the message to a remote host via an
19369 &(smtp)& transport. The &%self%& option specifies what happens when the first
19370 host on the list turns out to be the local host.
19371 The way in which Exim checks for the local host is described in section
19372 &<<SECTreclocipadd>>&.
19373
19374 Normally this situation indicates either an error in Exim's configuration (for
19375 example, the router should be configured not to process this domain), or an
19376 error in the DNS (for example, the MX should not point to this host). For this
19377 reason, the default action is to log the incident, defer the address, and
19378 freeze the message. The following alternatives are provided for use in special
19379 cases:
19380
19381 .vlist
19382 .vitem &%defer%&
19383 Delivery of the message is tried again later, but the message is not frozen.
19384
19385 .vitem "&%reroute%&: <&'domain'&>"
19386 The domain is changed to the given domain, and the address is passed back to
19387 be reprocessed by the routers. No rewriting of headers takes place. This
19388 behaviour is essentially a redirection.
19389
19390 .vitem "&%reroute: rewrite:%& <&'domain'&>"
19391 The domain is changed to the given domain, and the address is passed back to be
19392 reprocessed by the routers. Any headers that contain the original domain are
19393 rewritten.
19394
19395 .vitem &%pass%&
19396 .oindex "&%more%&"
19397 .vindex "&$self_hostname$&"
19398 The router passes the address to the next router, or to the router named in the
19399 &%pass_router%& option if it is set. This overrides &%no_more%&. During
19400 subsequent routing and delivery, the variable &$self_hostname$& contains the
19401 name of the local host that the router encountered. This can be used to
19402 distinguish between different cases for hosts with multiple names. The
19403 combination
19404 .code
19405 self = pass
19406 no_more
19407 .endd
19408 ensures that only those addresses that routed to the local host are passed on.
19409 Without &%no_more%&, addresses that were declined for other reasons would also
19410 be passed to the next router.
19411
19412 .vitem &%fail%&
19413 Delivery fails and an error report is generated.
19414
19415 .vitem &%send%&
19416 .cindex "local host" "sending to"
19417 The anomaly is ignored and the address is queued for the transport. This
19418 setting should be used with extreme caution. For an &(smtp)& transport, it
19419 makes sense only in cases where the program that is listening on the SMTP port
19420 is not this version of Exim. That is, it must be some other MTA, or Exim with a
19421 different configuration file that handles the domain in another way.
19422 .endlist
19423
19424
19425
19426 .option senders routers&!? "address list&!!" unset
19427 .cindex "router" "checking senders"
19428 If this option is set, the router is skipped unless the message's sender
19429 address matches something on the list.
19430 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
19431 are evaluated.
19432
19433 There are issues concerning verification when the running of routers is
19434 dependent on the sender. When Exim is verifying the address in an &%errors_to%&
19435 setting, it sets the sender to the null string. When using the &%-bt%& option
19436 to check a configuration file, it is necessary also to use the &%-f%& option to
19437 set an appropriate sender. For incoming mail, the sender is unset when
19438 verifying the sender, but is available when verifying any recipients. If the
19439 SMTP VRFY command is enabled, it must be used after MAIL if the sender address
19440 matters.
19441
19442
19443 .option set routers "string list" unset
19444 .cindex router variables
19445 This option may be used multiple times on a router;
19446 because of this the list aspect is mostly irrelevant.
19447 The list separator is a semicolon but can be changed in the
19448 usual way.
19449
19450 Each list-element given must be of the form &"name = value"&
19451 and the names used must start with the string &"r_"&.
19452 Values containing a list-separator should have them doubled.
19453 When a router runs, the strings are evaluated in order,
19454 to create variables which are added to the set associated with
19455 the address.
19456 The variable is set with the expansion of the value.
19457 The variables can be used by the router options
19458 (not including any preconditions)
19459 and by the transport.
19460 Later definitions of a given named variable will override former ones.
19461 Variable use is via the usual &$r_...$& syntax.
19462
19463 This is similar to the &%address_data%& option, except that
19464 many independent variables can be used, with choice of naming.
19465
19466
19467 .option translate_ip_address routers string&!! unset
19468 .cindex "IP address" "translating"
19469 .cindex "packet radio"
19470 .cindex "router" "IP address translation"
19471 There exist some rare networking situations (for example, packet radio) where
19472 it is helpful to be able to translate IP addresses generated by normal routing
19473 mechanisms into other IP addresses, thus performing a kind of manual IP
19474 routing. This should be done only if the normal IP routing of the TCP/IP stack
19475 is inadequate or broken. Because this is an extremely uncommon requirement, the
19476 code to support this option is not included in the Exim binary unless
19477 SUPPORT_TRANSLATE_IP_ADDRESS=yes is set in &_Local/Makefile_&.
19478
19479 .vindex "&$host_address$&"
19480 The &%translate_ip_address%& string is expanded for every IP address generated
19481 by the router, with the generated address set in &$host_address$&. If the
19482 expansion is forced to fail, no action is taken.
19483 For any other expansion error, delivery of the message is deferred.
19484 If the result of the expansion is an IP address, that replaces the original
19485 address; otherwise the result is assumed to be a host name &-- this is looked
19486 up using &[gethostbyname()]& (or &[getipnodebyname()]& when available) to
19487 produce one or more replacement IP addresses. For example, to subvert all IP
19488 addresses in some specific networks, this could be added to a router:
19489 .code
19490 translate_ip_address = \
19491   ${lookup{${mask:$host_address/26}}lsearch{/some/file}\
19492     {$value}fail}}
19493 .endd
19494 The file would contain lines like
19495 .code
19496 10.2.3.128/26    some.host
19497 10.8.4.34/26     10.44.8.15
19498 .endd
19499 You should not make use of this facility unless you really understand what you
19500 are doing.
19501
19502
19503
19504 .option transport routers string&!! unset
19505 This option specifies the transport to be used when a router accepts an address
19506 and sets it up for delivery. A transport is never needed if a router is used
19507 only for verification. The value of the option is expanded at routing time,
19508 after the expansion of &%errors_to%&, &%headers_add%&, and &%headers_remove%&,
19509 and result must be the name of one of the configured transports. If it is not,
19510 delivery is deferred.
19511
19512 The &%transport%& option is not used by the &(redirect)& router, but it does
19513 have some private options that set up transports for pipe and file deliveries
19514 (see chapter &<<CHAPredirect>>&).
19515
19516
19517
19518 .option transport_current_directory routers string&!! unset
19519 .cindex "current directory for local transport"
19520 This option associates a current directory with any address that is routed
19521 to a local transport. This can happen either because a transport is
19522 explicitly configured for the router, or because it generates a delivery to a
19523 file or a pipe. During the delivery process (that is, at transport time), this
19524 option string is expanded and is set as the current directory, unless
19525 overridden by a setting on the transport.
19526 If the expansion fails for any reason, including forced failure, an error is
19527 logged, and delivery is deferred.
19528 See chapter &<<CHAPenvironment>>& for details of the local delivery
19529 environment.
19530
19531
19532
19533
19534 .option transport_home_directory routers string&!! "see below"
19535 .cindex "home directory" "for local transport"
19536 This option associates a home directory with any address that is routed to a
19537 local transport. This can happen either because a transport is explicitly
19538 configured for the router, or because it generates a delivery to a file or a
19539 pipe. During the delivery process (that is, at transport time), the option
19540 string is expanded and is set as the home directory, unless overridden by a
19541 setting of &%home_directory%& on the transport.
19542 If the expansion fails for any reason, including forced failure, an error is
19543 logged, and delivery is deferred.
19544
19545 If the transport does not specify a home directory, and
19546 &%transport_home_directory%& is not set for the router, the home directory for
19547 the transport is taken from the password data if &%check_local_user%& is set for
19548 the router. Otherwise it is taken from &%router_home_directory%& if that option
19549 is set; if not, no home directory is set for the transport.
19550
19551 See chapter &<<CHAPenvironment>>& for further details of the local delivery
19552 environment.
19553
19554
19555
19556
19557 .option unseen routers boolean&!! false
19558 .cindex "router" "carrying on after success"
19559 The result of string expansion for this option must be a valid boolean value,
19560 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
19561 result causes an error, and delivery is deferred. If the expansion is forced to
19562 fail, the default value for the option (false) is used. Other failures cause
19563 delivery to be deferred.
19564
19565 When this option is set true, routing does not cease if the router accepts the
19566 address. Instead, a copy of the incoming address is passed to the next router,
19567 overriding a false setting of &%more%&. There is little point in setting
19568 &%more%& false if &%unseen%& is always true, but it may be useful in cases when
19569 the value of &%unseen%& contains expansion items (and therefore, presumably, is
19570 sometimes true and sometimes false).
19571
19572 .cindex "copy of message (&%unseen%& option)"
19573 Setting the &%unseen%& option has a similar effect to the &%unseen%& command
19574 qualifier in filter files. It can be used to cause copies of messages to be
19575 delivered to some other destination, while also carrying out a normal delivery.
19576 In effect, the current address is made into a &"parent"& that has two children
19577 &-- one that is delivered as specified by this router, and a clone that goes on
19578 to be routed further. For this reason, &%unseen%& may not be combined with the
19579 &%one_time%& option in a &(redirect)& router.
19580
19581 &*Warning*&: Header lines added to the address (or specified for removal) by
19582 this router or by previous routers affect the &"unseen"& copy of the message
19583 only. The clone that continues to be processed by further routers starts with
19584 no added headers and none specified for removal. For a &%redirect%& router, if
19585 a generated address is the same as the incoming address, this can lead to
19586 duplicate addresses with different header modifications. Exim does not do
19587 duplicate deliveries (except, in certain circumstances, to pipes -- see section
19588 &<<SECTdupaddr>>&), but it is undefined which of the duplicates is discarded,
19589 so this ambiguous situation should be avoided. The &%repeat_use%& option of the
19590 &%redirect%& router may be of help.
19591
19592 Unlike the handling of header modifications, any data that was set by the
19593 &%address_data%& option in the current or previous routers &'is'& passed on to
19594 subsequent routers.
19595
19596
19597 .option user routers string&!! "see below"
19598 .cindex "uid (user id)" "local delivery"
19599 .cindex "local transports" "uid and gid"
19600 .cindex "transport" "local"
19601 .cindex "router" "user for filter processing"
19602 .cindex "filter" "user for processing"
19603 When a router queues an address for a transport, and the transport does not
19604 specify a user, the user given here is used when running the delivery process.
19605 The user may be specified numerically or by name. If expansion fails, the
19606 error is logged and delivery is deferred.
19607 This user is also used by the &(redirect)& router when running a filter file.
19608 The default is unset, except when &%check_local_user%& is set. In this case,
19609 the default is taken from the password information. If the user is specified as
19610 a name, and &%group%& is not set, the group associated with the user is used.
19611 See also &%initgroups%& and &%group%& and the discussion in chapter
19612 &<<CHAPenvironment>>&.
19613
19614
19615
19616 .option verify routers&!? boolean true
19617 Setting this option has the effect of setting &%verify_sender%& and
19618 &%verify_recipient%& to the same value.
19619
19620
19621 .option verify_only routers&!? boolean false
19622 .cindex "EXPN" "with &%verify_only%&"
19623 .oindex "&%-bv%&"
19624 .cindex "router" "used only when verifying"
19625 If this option is set, the router is used only when verifying an address,
19626 delivering in cutthrough mode or
19627 testing with the &%-bv%& option, not when actually doing a delivery, testing
19628 with the &%-bt%& option, or running the SMTP EXPN command. It can be further
19629 restricted to verifying only senders or recipients by means of
19630 &%verify_sender%& and &%verify_recipient%&.
19631
19632 &*Warning*&: When the router is being run to verify addresses for an incoming
19633 SMTP message, Exim is not running as root, but under its own uid. If the router
19634 accesses any files, you need to make sure that they are accessible to the Exim
19635 user or group.
19636
19637
19638 .option verify_recipient routers&!? boolean true
19639 If this option is false, the router is skipped when verifying recipient
19640 addresses,
19641 delivering in cutthrough mode
19642 or testing recipient verification using &%-bv%&.
19643 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
19644 are evaluated.
19645 See also the &$verify_mode$& variable.
19646
19647
19648 .option verify_sender routers&!? boolean true
19649 If this option is false, the router is skipped when verifying sender addresses
19650 or testing sender verification using &%-bvs%&.
19651 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
19652 are evaluated.
19653 See also the &$verify_mode$& variable.
19654 .ecindex IIDgenoprou1
19655 .ecindex IIDgenoprou2
19656
19657
19658
19659
19660
19661
19662 . ////////////////////////////////////////////////////////////////////////////
19663 . ////////////////////////////////////////////////////////////////////////////
19664
19665 .chapter "The accept router" "CHID4"
19666 .cindex "&(accept)& router"
19667 .cindex "routers" "&(accept)&"
19668 The &(accept)& router has no private options of its own. Unless it is being
19669 used purely for verification (see &%verify_only%&) a transport is required to
19670 be defined by the generic &%transport%& option. If the preconditions that are
19671 specified by generic options are met, the router accepts the address and queues
19672 it for the given transport. The most common use of this router is for setting
19673 up deliveries to local mailboxes. For example:
19674 .code
19675 localusers:
19676   driver = accept
19677   domains = mydomain.example
19678   check_local_user
19679   transport = local_delivery
19680 .endd
19681 The &%domains%& condition in this example checks the domain of the address, and
19682 &%check_local_user%& checks that the local part is the login of a local user.
19683 When both preconditions are met, the &(accept)& router runs, and queues the
19684 address for the &(local_delivery)& transport.
19685
19686
19687
19688
19689
19690
19691 . ////////////////////////////////////////////////////////////////////////////
19692 . ////////////////////////////////////////////////////////////////////////////
19693
19694 .chapter "The dnslookup router" "CHAPdnslookup"
19695 .scindex IIDdnsrou1 "&(dnslookup)& router"
19696 .scindex IIDdnsrou2 "routers" "&(dnslookup)&"
19697 The &(dnslookup)& router looks up the hosts that handle mail for the
19698 recipient's domain in the DNS. A transport must always be set for this router,
19699 unless &%verify_only%& is set.
19700
19701 If SRV support is configured (see &%check_srv%& below), Exim first searches for
19702 SRV records. If none are found, or if SRV support is not configured,
19703 MX records are looked up. If no MX records exist, address records are sought.
19704 However, &%mx_domains%& can be set to disable the direct use of address
19705 records.
19706
19707 MX records of equal priority are sorted by Exim into a random order. Exim then
19708 looks for address records for the host names obtained from MX or SRV records.
19709 When a host has more than one IP address, they are sorted into a random order,
19710 except that IPv6 addresses are sorted before IPv4 addresses. If all the
19711 IP addresses found are discarded by a setting of the &%ignore_target_hosts%&
19712 generic option, the router declines.
19713
19714 Unless they have the highest priority (lowest MX value), MX records that point
19715 to the local host, or to any host name that matches &%hosts_treat_as_local%&,
19716 are discarded, together with any other MX records of equal or lower priority.
19717
19718 .cindex "MX record" "pointing to local host"
19719 .cindex "local host" "MX pointing to"
19720 .oindex "&%self%&" "in &(dnslookup)& router"
19721 If the host pointed to by the highest priority MX record, or looked up as an
19722 address record, is the local host, or matches &%hosts_treat_as_local%&, what
19723 happens is controlled by the generic &%self%& option.
19724
19725
19726 .section "Problems with DNS lookups" "SECTprowitdnsloo"
19727 There have been problems with DNS servers when SRV records are looked up.
19728 Some misbehaving servers return a DNS error or timeout when a non-existent
19729 SRV record is sought. Similar problems have in the past been reported for
19730 MX records. The global &%dns_again_means_nonexist%& option can help with this
19731 problem, but it is heavy-handed because it is a global option.
19732
19733 For this reason, there are two options, &%srv_fail_domains%& and
19734 &%mx_fail_domains%&, that control what happens when a DNS lookup in a
19735 &(dnslookup)& router results in a DNS failure or a &"try again"& response. If
19736 an attempt to look up an SRV or MX record causes one of these results, and the
19737 domain matches the relevant list, Exim behaves as if the DNS had responded &"no
19738 such record"&. In the case of an SRV lookup, this means that the router
19739 proceeds to look for MX records; in the case of an MX lookup, it proceeds to
19740 look for A or AAAA records, unless the domain matches &%mx_domains%&, in which
19741 case routing fails.
19742
19743
19744 .section "Declining addresses by dnslookup" "SECTdnslookupdecline"
19745 .cindex "&(dnslookup)& router" "declines"
19746 There are a few cases where a &(dnslookup)& router will decline to accept
19747 an address; if such a router is expected to handle "all remaining non-local
19748 domains", then it is important to set &%no_more%&.
19749
19750 The router will defer rather than decline if the domain
19751 is found in the &%fail_defer_domains%& router option.
19752
19753 Reasons for a &(dnslookup)& router to decline currently include:
19754 .ilist
19755 The domain does not exist in DNS
19756 .next
19757 The domain exists but the MX record's host part is just "."; this is a common
19758 convention (borrowed from SRV) used to indicate that there is no such service
19759 for this domain and to not fall back to trying A/AAAA records.
19760 .next
19761 Ditto, but for SRV records, when &%check_srv%& is set on this router.
19762 .next
19763 MX record points to a non-existent host.
19764 .next
19765 MX record points to an IP address and the main section option
19766 &%allow_mx_to_ip%& is not set.
19767 .next
19768 MX records exist and point to valid hosts, but all hosts resolve only to
19769 addresses blocked by the &%ignore_target_hosts%& generic option on this router.
19770 .next
19771 The domain is not syntactically valid (see also &%allow_utf8_domains%& and
19772 &%dns_check_names_pattern%& for handling one variant of this)
19773 .next
19774 &%check_secondary_mx%& is set on this router but the local host can
19775 not be found in the MX records (see below)
19776 .endlist
19777
19778
19779
19780
19781 .section "Private options for dnslookup" "SECID118"
19782 .cindex "options" "&(dnslookup)& router"
19783 The private options for the &(dnslookup)& router are as follows:
19784
19785 .option check_secondary_mx dnslookup boolean false
19786 .cindex "MX record" "checking for secondary"
19787 If this option is set, the router declines unless the local host is found in
19788 (and removed from) the list of hosts obtained by MX lookup. This can be used to
19789 process domains for which the local host is a secondary mail exchanger
19790 differently to other domains. The way in which Exim decides whether a host is
19791 the local host is described in section &<<SECTreclocipadd>>&.
19792
19793
19794 .option check_srv dnslookup string&!! unset
19795 .cindex "SRV record" "enabling use of"
19796 The &(dnslookup)& router supports the use of SRV records (see RFC 2782) in
19797 addition to MX and address records. The support is disabled by default. To
19798 enable SRV support, set the &%check_srv%& option to the name of the service
19799 required. For example,
19800 .code
19801 check_srv = smtp
19802 .endd
19803 looks for SRV records that refer to the normal smtp service. The option is
19804 expanded, so the service name can vary from message to message or address
19805 to address. This might be helpful if SRV records are being used for a
19806 submission service. If the expansion is forced to fail, the &%check_srv%&
19807 option is ignored, and the router proceeds to look for MX records in the
19808 normal way.
19809
19810 When the expansion succeeds, the router searches first for SRV records for
19811 the given service (it assumes TCP protocol). A single SRV record with a
19812 host name that consists of just a single dot indicates &"no such service for
19813 this domain"&; if this is encountered, the router declines. If other kinds of
19814 SRV record are found, they are used to construct a host list for delivery
19815 according to the rules of RFC 2782. MX records are not sought in this case.
19816
19817 When no SRV records are found, MX records (and address records) are sought in
19818 the traditional way. In other words, SRV records take precedence over MX
19819 records, just as MX records take precedence over address records. Note that
19820 this behaviour is not sanctioned by RFC 2782, though a previous draft RFC
19821 defined it. It is apparently believed that MX records are sufficient for email
19822 and that SRV records should not be used for this purpose. However, SRV records
19823 have an additional &"weight"& feature which some people might find useful when
19824 trying to split an SMTP load between hosts of different power.
19825
19826 See section &<<SECTprowitdnsloo>>& above for a discussion of Exim's behaviour
19827 when there is a DNS lookup error.
19828
19829
19830
19831
19832 .option fail_defer_domains dnslookup "domain list&!!" unset
19833 .cindex "MX record" "not found"
19834 DNS lookups for domains matching &%fail_defer_domains%&
19835 which find no matching record will cause the router to defer
19836 rather than the default behaviour of decline.
19837 This maybe be useful for queueing messages for a newly created
19838 domain while the DNS configuration is not ready.
19839 However, it will result in any message with mistyped domains
19840 also being queued.
19841
19842
19843 .option ipv4_only "string&!!" unset
19844 .cindex IPv6 disabling
19845 .cindex DNS "IPv6 disabling"
19846 The string is expanded, and if the result is anything but a forced failure,
19847 or an empty string, or one of the strings “0” or “no” or “false”
19848 (checked without regard to the case of the letters),
19849 only A records are used.
19850
19851 .option ipv4_prefer "string&!!" unset
19852 .cindex IPv4 preference
19853 .cindex DNS "IPv4 preference"
19854 The string is expanded, and if the result is anything but a forced failure,
19855 or an empty string, or one of the strings “0” or “no” or “false”
19856 (checked without regard to the case of the letters),
19857 A records are sorted before AAAA records (inverting the default).
19858
19859 .option mx_domains dnslookup "domain list&!!" unset
19860 .cindex "MX record" "required to exist"
19861 .cindex "SRV record" "required to exist"
19862 A domain that matches &%mx_domains%& is required to have either an MX or an SRV
19863 record in order to be recognized. (The name of this option could be improved.)
19864 For example, if all the mail hosts in &'fict.example'& are known to have MX
19865 records, except for those in &'discworld.fict.example'&, you could use this
19866 setting:
19867 .code
19868 mx_domains = ! *.discworld.fict.example : *.fict.example
19869 .endd
19870 This specifies that messages addressed to a domain that matches the list but
19871 has no MX record should be bounced immediately instead of being routed using
19872 the address record.
19873
19874
19875 .option mx_fail_domains dnslookup "domain list&!!" unset
19876 If the DNS lookup for MX records for one of the domains in this list causes a
19877 DNS lookup error, Exim behaves as if no MX records were found. See section
19878 &<<SECTprowitdnsloo>>& for more discussion.
19879
19880
19881
19882
19883 .option qualify_single dnslookup boolean true
19884 .cindex "DNS" "resolver options"
19885 .cindex "DNS" "qualifying single-component names"
19886 When this option is true, the resolver option RES_DEFNAMES is set for DNS
19887 lookups. Typically, but not standardly, this causes the resolver to qualify
19888 single-component names with the default domain. For example, on a machine
19889 called &'dictionary.ref.example'&, the domain &'thesaurus'& would be changed to
19890 &'thesaurus.ref.example'& inside the resolver. For details of what your
19891 resolver actually does, consult your man pages for &'resolver'& and
19892 &'resolv.conf'&.
19893
19894
19895
19896 .option rewrite_headers dnslookup boolean true
19897 .cindex "rewriting" "header lines"
19898 .cindex "header lines" "rewriting"
19899 If the domain name in the address that is being processed is not fully
19900 qualified, it may be expanded to its full form by a DNS lookup. For example, if
19901 an address is specified as &'dormouse@teaparty'&, the domain might be
19902 expanded to &'teaparty.wonderland.fict.example'&. Domain expansion can also
19903 occur as a result of setting the &%widen_domains%& option. If
19904 &%rewrite_headers%& is true, all occurrences of the abbreviated domain name in
19905 any &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-to:'&, &'Sender:'&, and &'To:'&
19906 header lines of the message are rewritten with the full domain name.
19907
19908 This option should be turned off only when it is known that no message is
19909 ever going to be sent outside an environment where the abbreviation makes
19910 sense.
19911
19912 When an MX record is looked up in the DNS and matches a wildcard record, name
19913 servers normally return a record containing the name that has been looked up,
19914 making it impossible to detect whether a wildcard was present or not. However,
19915 some name servers have recently been seen to return the wildcard entry. If the
19916 name returned by a DNS lookup begins with an asterisk, it is not used for
19917 header rewriting.
19918
19919
19920 .option same_domain_copy_routing dnslookup boolean false
19921 .cindex "address" "copying routing"
19922 Addresses with the same domain are normally routed by the &(dnslookup)& router
19923 to the same list of hosts. However, this cannot be presumed, because the router
19924 options and preconditions may refer to the local part of the address. By
19925 default, therefore, Exim routes each address in a message independently. DNS
19926 servers run caches, so repeated DNS lookups are not normally expensive, and in
19927 any case, personal messages rarely have more than a few recipients.
19928
19929 If you are running mailing lists with large numbers of subscribers at the same
19930 domain, and you are using a &(dnslookup)& router which is independent of the
19931 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
19932 lookups for identical domains in one message. In this case, when &(dnslookup)&
19933 routes an address to a remote transport, any other unrouted addresses in the
19934 message that have the same domain are automatically given the same routing
19935 without processing them independently,
19936 provided the following conditions are met:
19937
19938 .ilist
19939 No router that processed the address specified &%headers_add%& or
19940 &%headers_remove%&.
19941 .next
19942 The router did not change the address in any way, for example, by &"widening"&
19943 the domain.
19944 .endlist
19945
19946
19947
19948
19949 .option search_parents dnslookup boolean false
19950 .cindex "DNS" "resolver options"
19951 When this option is true, the resolver option RES_DNSRCH is set for DNS
19952 lookups. This is different from the &%qualify_single%& option in that it
19953 applies to domains containing dots. Typically, but not standardly, it causes
19954 the resolver to search for the name in the current domain and in parent
19955 domains. For example, on a machine in the &'fict.example'& domain, if looking
19956 up &'teaparty.wonderland'& failed, the resolver would try
19957 &'teaparty.wonderland.fict.example'&. For details of what your resolver
19958 actually does, consult your man pages for &'resolver'& and &'resolv.conf'&.
19959
19960 Setting this option true can cause problems in domains that have a wildcard MX
19961 record, because any domain that does not have its own MX record matches the
19962 local wildcard.
19963
19964
19965
19966 .option srv_fail_domains dnslookup "domain list&!!" unset
19967 If the DNS lookup for SRV records for one of the domains in this list causes a
19968 DNS lookup error, Exim behaves as if no SRV records were found. See section
19969 &<<SECTprowitdnsloo>>& for more discussion.
19970
19971
19972
19973
19974 .option widen_domains dnslookup "string list" unset
19975 .cindex "domain" "partial; widening"
19976 If a DNS lookup fails and this option is set, each of its strings in turn is
19977 added onto the end of the domain, and the lookup is tried again. For example,
19978 if
19979 .code
19980 widen_domains = fict.example:ref.example
19981 .endd
19982 is set and a lookup of &'klingon.dictionary'& fails,
19983 &'klingon.dictionary.fict.example'& is looked up, and if this fails,
19984 &'klingon.dictionary.ref.example'& is tried. Note that the &%qualify_single%&
19985 and &%search_parents%& options can cause some widening to be undertaken inside
19986 the DNS resolver. &%widen_domains%& is not applied to sender addresses
19987 when verifying, unless &%rewrite_headers%& is false (not the default).
19988
19989
19990 .section "Effect of qualify_single and search_parents" "SECID119"
19991 When a domain from an envelope recipient is changed by the resolver as a result
19992 of the &%qualify_single%& or &%search_parents%& options, Exim rewrites the
19993 corresponding address in the message's header lines unless &%rewrite_headers%&
19994 is set false. Exim then re-routes the address, using the full domain.
19995
19996 These two options affect only the DNS lookup that takes place inside the router
19997 for the domain of the address that is being routed. They do not affect lookups
19998 such as that implied by
19999 .code
20000 domains = @mx_any
20001 .endd
20002 that may happen while processing a router precondition before the router is
20003 entered. No widening ever takes place for these lookups.
20004 .ecindex IIDdnsrou1
20005 .ecindex IIDdnsrou2
20006
20007
20008
20009
20010
20011
20012
20013
20014
20015 . ////////////////////////////////////////////////////////////////////////////
20016 . ////////////////////////////////////////////////////////////////////////////
20017
20018 .chapter "The ipliteral router" "CHID5"
20019 .cindex "&(ipliteral)& router"
20020 .cindex "domain literal" "routing"
20021 .cindex "routers" "&(ipliteral)&"
20022 This router has no private options. Unless it is being used purely for
20023 verification (see &%verify_only%&) a transport is required to be defined by the
20024 generic &%transport%& option. The router accepts the address if its domain part
20025 takes the form of an RFC 2822 domain literal. For example, the &(ipliteral)&
20026 router handles the address
20027 .code
20028 root@[192.168.1.1]
20029 .endd
20030 by setting up delivery to the host with that IP address. IPv4 domain literals
20031 consist of an IPv4 address enclosed in square brackets. IPv6 domain literals
20032 are similar, but the address is preceded by &`ipv6:`&. For example:
20033 .code
20034 postmaster@[ipv6:fe80::a00:20ff:fe86:a061.5678]
20035 .endd
20036 Exim allows &`ipv4:`& before IPv4 addresses, for consistency, and on the
20037 grounds that sooner or later somebody will try it.
20038
20039 .oindex "&%self%&" "in &(ipliteral)& router"
20040 If the IP address matches something in &%ignore_target_hosts%&, the router
20041 declines. If an IP literal turns out to refer to the local host, the generic
20042 &%self%& option determines what happens.
20043
20044 The RFCs require support for domain literals; however, their use is
20045 controversial in today's Internet. If you want to use this router, you must
20046 also set the main configuration option &%allow_domain_literals%&. Otherwise,
20047 Exim will not recognize the domain literal syntax in addresses.
20048
20049
20050
20051 . ////////////////////////////////////////////////////////////////////////////
20052 . ////////////////////////////////////////////////////////////////////////////
20053
20054 .chapter "The iplookup router" "CHID6"
20055 .cindex "&(iplookup)& router"
20056 .cindex "routers" "&(iplookup)&"
20057 The &(iplookup)& router was written to fulfil a specific requirement in
20058 Cambridge University (which in fact no longer exists). For this reason, it is
20059 not included in the binary of Exim by default. If you want to include it, you
20060 must set
20061 .code
20062 ROUTER_IPLOOKUP=yes
20063 .endd
20064 in your &_Local/Makefile_& configuration file.
20065
20066 The &(iplookup)& router routes an address by sending it over a TCP or UDP
20067 connection to one or more specific hosts. The host can then return the same or
20068 a different address &-- in effect rewriting the recipient address in the
20069 message's envelope. The new address is then passed on to subsequent routers. If
20070 this process fails, the address can be passed on to other routers, or delivery
20071 can be deferred. Since &(iplookup)& is just a rewriting router, a transport
20072 must not be specified for it.
20073
20074 .cindex "options" "&(iplookup)& router"
20075 .option hosts iplookup string unset
20076 This option must be supplied. Its value is a colon-separated list of host
20077 names. The hosts are looked up using &[gethostbyname()]&
20078 (or &[getipnodebyname()]& when available)
20079 and are tried in order until one responds to the query. If none respond, what
20080 happens is controlled by &%optional%&.
20081
20082
20083 .option optional iplookup boolean false
20084 If &%optional%& is true, if no response is obtained from any host, the address
20085 is passed to the next router, overriding &%no_more%&. If &%optional%& is false,
20086 delivery to the address is deferred.
20087
20088
20089 .option port iplookup integer 0
20090 .cindex "port" "&(iplookup)& router"
20091 This option must be supplied. It specifies the port number for the TCP or UDP
20092 call.
20093
20094
20095 .option protocol iplookup string udp
20096 This option can be set to &"udp"& or &"tcp"& to specify which of the two
20097 protocols is to be used.
20098
20099
20100 .option query iplookup string&!! "see below"
20101 This defines the content of the query that is sent to the remote hosts. The
20102 default value is:
20103 .code
20104 $local_part@$domain $local_part@$domain
20105 .endd
20106 The repetition serves as a way of checking that a response is to the correct
20107 query in the default case (see &%response_pattern%& below).
20108
20109
20110 .option reroute iplookup string&!! unset
20111 If this option is not set, the rerouted address is precisely the byte string
20112 returned by the remote host, up to the first white space, if any. If set, the
20113 string is expanded to form the rerouted address. It can include parts matched
20114 in the response by &%response_pattern%& by means of numeric variables such as
20115 &$1$&, &$2$&, etc. The variable &$0$& refers to the entire input string,
20116 whether or not a pattern is in use. In all cases, the rerouted address must end
20117 up in the form &'local_part@domain'&.
20118
20119
20120 .option response_pattern iplookup string unset
20121 This option can be set to a regular expression that is applied to the string
20122 returned from the remote host. If the pattern does not match the response, the
20123 router declines. If &%response_pattern%& is not set, no checking of the
20124 response is done, unless the query was defaulted, in which case there is a
20125 check that the text returned after the first white space is the original
20126 address. This checks that the answer that has been received is in response to
20127 the correct question. For example, if the response is just a new domain, the
20128 following could be used:
20129 .code
20130 response_pattern = ^([^@]+)$
20131 reroute = $local_part@$1
20132 .endd
20133
20134 .option timeout iplookup time 5s
20135 This specifies the amount of time to wait for a response from the remote
20136 machine. The same timeout is used for the &[connect()]& function for a TCP
20137 call. It does not apply to UDP.
20138
20139
20140
20141
20142 . ////////////////////////////////////////////////////////////////////////////
20143 . ////////////////////////////////////////////////////////////////////////////
20144
20145 .chapter "The manualroute router" "CHID7"
20146 .scindex IIDmanrou1 "&(manualroute)& router"
20147 .scindex IIDmanrou2 "routers" "&(manualroute)&"
20148 .cindex "domain" "manually routing"
20149 The &(manualroute)& router is so-called because it provides a way of manually
20150 routing an address according to its domain. It is mainly used when you want to
20151 route addresses to remote hosts according to your own rules, bypassing the
20152 normal DNS routing that looks up MX records. However, &(manualroute)& can also
20153 route to local transports, a facility that may be useful if you want to save
20154 messages for dial-in hosts in local files.
20155
20156 The &(manualroute)& router compares a list of domain patterns with the domain
20157 it is trying to route. If there is no match, the router declines. Each pattern
20158 has associated with it a list of hosts and some other optional data, which may
20159 include a transport. The combination of a pattern and its data is called a
20160 &"routing rule"&. For patterns that do not have an associated transport, the
20161 generic &%transport%& option must specify a transport, unless the router is
20162 being used purely for verification (see &%verify_only%&).
20163
20164 .vindex "&$host$&"
20165 In the case of verification, matching the domain pattern is sufficient for the
20166 router to accept the address. When actually routing an address for delivery,
20167 an address that matches a domain pattern is queued for the associated
20168 transport. If the transport is not a local one, a host list must be associated
20169 with the pattern; IP addresses are looked up for the hosts, and these are
20170 passed to the transport along with the mail address. For local transports, a
20171 host list is optional. If it is present, it is passed in &$host$& as a single
20172 text string.
20173
20174 The list of routing rules can be provided as an inline string in
20175 &%route_list%&, or the data can be obtained by looking up the domain in a file
20176 or database by setting &%route_data%&. Only one of these settings may appear in
20177 any one instance of &(manualroute)&. The format of routing rules is described
20178 below, following the list of private options.
20179
20180
20181 .section "Private options for manualroute" "SECTprioptman"
20182
20183 .cindex "options" "&(manualroute)& router"
20184 The private options for the &(manualroute)& router are as follows:
20185
20186 .option host_all_ignored manualroute string defer
20187 See &%host_find_failed%&.
20188
20189 .option host_find_failed manualroute string freeze
20190 This option controls what happens when &(manualroute)& tries to find an IP
20191 address for a host, and the host does not exist. The option can be set to one
20192 of the following values:
20193 .code
20194 decline
20195 defer
20196 fail
20197 freeze
20198 ignore
20199 pass
20200 .endd
20201 The default (&"freeze"&) assumes that this state is a serious configuration
20202 error. The difference between &"pass"& and &"decline"& is that the former
20203 forces the address to be passed to the next router (or the router defined by
20204 &%pass_router%&),
20205 .oindex "&%more%&"
20206 overriding &%no_more%&, whereas the latter passes the address to the next
20207 router only if &%more%& is true.
20208
20209 The value &"ignore"& causes Exim to completely ignore a host whose IP address
20210 cannot be found. If all the hosts in the list are ignored, the behaviour is
20211 controlled by the &%host_all_ignored%& option. This takes the same values
20212 as &%host_find_failed%&, except that it cannot be set to &"ignore"&.
20213
20214 The &%host_find_failed%& option applies only to a definite &"does not exist"&
20215 state; if a host lookup gets a temporary error, delivery is deferred unless the
20216 generic &%pass_on_timeout%& option is set.
20217
20218
20219 .option hosts_randomize manualroute boolean false
20220 .cindex "randomized host list"
20221 .cindex "host" "list of; randomized"
20222 If this option is set, the order of the items in a host list in a routing rule
20223 is randomized each time the list is used, unless an option in the routing rule
20224 overrides (see below). Randomizing the order of a host list can be used to do
20225 crude load sharing. However, if more than one mail address is routed by the
20226 same router to the same host list, the host lists are considered to be the same
20227 (even though they may be randomized into different orders) for the purpose of
20228 deciding whether to batch the deliveries into a single SMTP transaction.
20229
20230 When &%hosts_randomize%& is true, a host list may be split
20231 into groups whose order is separately randomized. This makes it possible to
20232 set up MX-like behaviour. The boundaries between groups are indicated by an
20233 item that is just &`+`& in the host list. For example:
20234 .code
20235 route_list = * host1:host2:host3:+:host4:host5
20236 .endd
20237 The order of the first three hosts and the order of the last two hosts is
20238 randomized for each use, but the first three always end up before the last two.
20239 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored. If a
20240 randomized host list is passed to an &(smtp)& transport that also has
20241 &%hosts_randomize set%&, the list is not re-randomized.
20242
20243
20244 .option route_data manualroute string&!! unset
20245 If this option is set, it must expand to yield the data part of a routing rule.
20246 Typically, the expansion string includes a lookup based on the domain. For
20247 example:
20248 .code
20249 route_data = ${lookup{$domain}dbm{/etc/routes}}
20250 .endd
20251 If the expansion is forced to fail, or the result is an empty string, the
20252 router declines. Other kinds of expansion failure cause delivery to be
20253 deferred.
20254
20255
20256 .option route_list manualroute "string list" unset
20257 This string is a list of routing rules, in the form defined below. Note that,
20258 unlike most string lists, the items are separated by semicolons. This is so
20259 that they may contain colon-separated host lists.
20260
20261
20262 .option same_domain_copy_routing manualroute boolean false
20263 .cindex "address" "copying routing"
20264 Addresses with the same domain are normally routed by the &(manualroute)&
20265 router to the same list of hosts. However, this cannot be presumed, because the
20266 router options and preconditions may refer to the local part of the address. By
20267 default, therefore, Exim routes each address in a message independently. DNS
20268 servers run caches, so repeated DNS lookups are not normally expensive, and in
20269 any case, personal messages rarely have more than a few recipients.
20270
20271 If you are running mailing lists with large numbers of subscribers at the same
20272 domain, and you are using a &(manualroute)& router which is independent of the
20273 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
20274 lookups for identical domains in one message. In this case, when
20275 &(manualroute)& routes an address to a remote transport, any other unrouted
20276 addresses in the message that have the same domain are automatically given the
20277 same routing without processing them independently. However, this is only done
20278 if &%headers_add%& and &%headers_remove%& are unset.
20279
20280
20281
20282
20283 .section "Routing rules in route_list" "SECID120"
20284 The value of &%route_list%& is a string consisting of a sequence of routing
20285 rules, separated by semicolons. If a semicolon is needed in a rule, it can be
20286 entered as two semicolons. Alternatively, the list separator can be changed as
20287 described (for colon-separated lists) in section &<<SECTlistconstruct>>&.
20288 Empty rules are ignored. The format of each rule is
20289 .display
20290 <&'domain pattern'&>  <&'list of hosts'&>  <&'options'&>
20291 .endd
20292 The following example contains two rules, each with a simple domain pattern and
20293 no options:
20294 .code
20295 route_list = \
20296   dict.ref.example  mail-1.ref.example:mail-2.ref.example ; \
20297   thes.ref.example  mail-3.ref.example:mail-4.ref.example
20298 .endd
20299 The three parts of a rule are separated by white space. The pattern and the
20300 list of hosts can be enclosed in quotes if necessary, and if they are, the
20301 usual quoting rules apply. Each rule in a &%route_list%& must start with a
20302 single domain pattern, which is the only mandatory item in the rule. The
20303 pattern is in the same format as one item in a domain list (see section
20304 &<<SECTdomainlist>>&),
20305 except that it may not be the name of an interpolated file.
20306 That is, it may be wildcarded, or a regular expression, or a file or database
20307 lookup (with semicolons doubled, because of the use of semicolon as a separator
20308 in a &%route_list%&).
20309
20310 The rules in &%route_list%& are searched in order until one of the patterns
20311 matches the domain that is being routed. The list of hosts and then options are
20312 then used as described below. If there is no match, the router declines. When
20313 &%route_list%& is set, &%route_data%& must not be set.
20314
20315
20316
20317 .section "Routing rules in route_data" "SECID121"
20318 The use of &%route_list%& is convenient when there are only a small number of
20319 routing rules. For larger numbers, it is easier to use a file or database to
20320 hold the routing information, and use the &%route_data%& option instead.
20321 The value of &%route_data%& is a list of hosts, followed by (optional) options.
20322 Most commonly, &%route_data%& is set as a string that contains an
20323 expansion lookup. For example, suppose we place two routing rules in a file
20324 like this:
20325 .code
20326 dict.ref.example:  mail-1.ref.example:mail-2.ref.example
20327 thes.ref.example:  mail-3.ref.example:mail-4.ref.example
20328 .endd
20329 This data can be accessed by setting
20330 .code
20331 route_data = ${lookup{$domain}lsearch{/the/file/name}}
20332 .endd
20333 Failure of the lookup results in an empty string, causing the router to
20334 decline. However, you do not have to use a lookup in &%route_data%&. The only
20335 requirement is that the result of expanding the string is a list of hosts,
20336 possibly followed by options, separated by white space. The list of hosts must
20337 be enclosed in quotes if it contains white space.
20338
20339
20340
20341
20342 .section "Format of the list of hosts" "SECID122"
20343 A list of hosts, whether obtained via &%route_data%& or &%route_list%&, is
20344 always separately expanded before use. If the expansion fails, the router
20345 declines. The result of the expansion must be a colon-separated list of names
20346 and/or IP addresses, optionally also including ports.
20347 If the list is written with spaces, it must be protected with quotes.
20348 The format of each item
20349 in the list is described in the next section. The list separator can be changed
20350 as described in section &<<SECTlistsepchange>>&.
20351
20352 If the list of hosts was obtained from a &%route_list%& item, the following
20353 variables are set during its expansion:
20354
20355 .ilist
20356 .cindex "numerical variables (&$1$& &$2$&  etc)" "in &(manualroute)& router"
20357 If the domain was matched against a regular expression, the numeric variables
20358 &$1$&, &$2$&, etc. may be set. For example:
20359 .code
20360 route_list = ^domain(\d+)   host-$1.text.example
20361 .endd
20362 .next
20363 &$0$& is always set to the entire domain.
20364 .next
20365 &$1$& is also set when partial matching is done in a file lookup.
20366
20367 .next
20368 .vindex "&$value$&"
20369 If the pattern that matched the domain was a lookup item, the data that was
20370 looked up is available in the expansion variable &$value$&. For example:
20371 .code
20372 route_list = lsearch;;/some/file.routes  $value
20373 .endd
20374 .endlist
20375
20376 Note the doubling of the semicolon in the pattern that is necessary because
20377 semicolon is the default route list separator.
20378
20379
20380
20381 .section "Format of one host item" "SECTformatonehostitem"
20382 Each item in the list of hosts can be either a host name or an IP address,
20383 optionally with an attached port number, or it can be a single "+"
20384 (see &%hosts_randomize%&).
20385 When no port is given, an IP address
20386 is not enclosed in brackets. When a port is specified, it overrides the port
20387 specification on the transport. The port is separated from the name or address
20388 by a colon. This leads to some complications:
20389
20390 .ilist
20391 Because colon is the default separator for the list of hosts, either
20392 the colon that specifies a port must be doubled, or the list separator must
20393 be changed. The following two examples have the same effect:
20394 .code
20395 route_list = * "host1.tld::1225 : host2.tld::1226"
20396 route_list = * "<+ host1.tld:1225 + host2.tld:1226"
20397 .endd
20398 .next
20399 When IPv6 addresses are involved, it gets worse, because they contain
20400 colons of their own. To make this case easier, it is permitted to
20401 enclose an IP address (either v4 or v6) in square brackets if a port
20402 number follows. For example:
20403 .code
20404 route_list = * "</ [10.1.1.1]:1225 / [::1]:1226"
20405 .endd
20406 .endlist
20407
20408 .section "How the list of hosts is used" "SECThostshowused"
20409 When an address is routed to an &(smtp)& transport by &(manualroute)&, each of
20410 the hosts is tried, in the order specified, when carrying out the SMTP
20411 delivery. However, the order can be changed by setting the &%hosts_randomize%&
20412 option, either on the router (see section &<<SECTprioptman>>& above), or on the
20413 transport.
20414
20415 Hosts may be listed by name or by IP address. An unadorned name in the list of
20416 hosts is interpreted as a host name. A name that is followed by &`/MX`& is
20417 interpreted as an indirection to a sublist of hosts obtained by looking up MX
20418 records in the DNS. For example:
20419 .code
20420 route_list = *  x.y.z:p.q.r/MX:e.f.g
20421 .endd
20422 If this feature is used with a port specifier, the port must come last. For
20423 example:
20424 .code
20425 route_list = *  dom1.tld/mx::1225
20426 .endd
20427 If the &%hosts_randomize%& option is set, the order of the items in the list is
20428 randomized before any lookups are done. Exim then scans the list; for any name
20429 that is not followed by &`/MX`& it looks up an IP address. If this turns out to
20430 be an interface on the local host and the item is not the first in the list,
20431 Exim discards it and any subsequent items. If it is the first item, what
20432 happens is controlled by the
20433 .oindex "&%self%&" "in &(manualroute)& router"
20434 &%self%& option of the router.
20435
20436 A name on the list that is followed by &`/MX`& is replaced with the list of
20437 hosts obtained by looking up MX records for the name. This is always a DNS
20438 lookup; the &%bydns%& and &%byname%& options (see section &<<SECThowoptused>>&
20439 below) are not relevant here. The order of these hosts is determined by the
20440 preference values in the MX records, according to the usual rules. Because
20441 randomizing happens before the MX lookup, it does not affect the order that is
20442 defined by MX preferences.
20443
20444 If the local host is present in the sublist obtained from MX records, but is
20445 not the most preferred host in that list, it and any equally or less
20446 preferred hosts are removed before the sublist is inserted into the main list.
20447
20448 If the local host is the most preferred host in the MX list, what happens
20449 depends on where in the original list of hosts the &`/MX`& item appears. If it
20450 is not the first item (that is, there are previous hosts in the main list),
20451 Exim discards this name and any subsequent items in the main list.
20452
20453 If the MX item is first in the list of hosts, and the local host is the
20454 most preferred host, what happens is controlled by the &%self%& option of the
20455 router.
20456
20457 DNS failures when lookup up the MX records are treated in the same way as DNS
20458 failures when looking up IP addresses: &%pass_on_timeout%& and
20459 &%host_find_failed%& are used when relevant.
20460
20461 The generic &%ignore_target_hosts%& option applies to all hosts in the list,
20462 whether obtained from an MX lookup or not.
20463
20464
20465
20466 .section "How the options are used" "SECThowoptused"
20467 The options are a sequence of words, space-separated.
20468 One of the words can be the name of a transport; this overrides the
20469 &%transport%& option on the router for this particular routing rule only. The
20470 other words (if present) control randomization of the list of hosts on a
20471 per-rule basis, and how the IP addresses of the hosts are to be found when
20472 routing to a remote transport. These options are as follows:
20473
20474 .ilist
20475 &%randomize%&: randomize the order of the hosts in this list, overriding the
20476 setting of &%hosts_randomize%& for this routing rule only.
20477 .next
20478 &%no_randomize%&: do not randomize the order of the hosts in this list,
20479 overriding the setting of &%hosts_randomize%& for this routing rule only.
20480 .next
20481 &%byname%&: use &[getipnodebyname()]& (&[gethostbyname()]& on older systems) to
20482 find IP addresses. This function may ultimately cause a DNS lookup, but it may
20483 also look in &_/etc/hosts_& or other sources of information.
20484 .next
20485 &%bydns%&: look up address records for the hosts directly in the DNS; fail if
20486 no address records are found. If there is a temporary DNS error (such as a
20487 timeout), delivery is deferred.
20488 .next
20489 &%ipv4_only%&: in direct DNS lookups, look up only A records.
20490 .next
20491 &%ipv4_prefer%&: in direct DNS lookups, sort A records before AAAA records.
20492 .endlist
20493
20494 For example:
20495 .code
20496 route_list = domain1  host1:host2:host3  randomize bydns;\
20497              domain2  host4:host5
20498 .endd
20499 If neither &%byname%& nor &%bydns%& is given, Exim behaves as follows: First, a
20500 DNS lookup is done. If this yields anything other than HOST_NOT_FOUND, that
20501 result is used. Otherwise, Exim goes on to try a call to &[getipnodebyname()]&
20502 or &[gethostbyname()]&, and the result of the lookup is the result of that
20503 call.
20504
20505 &*Warning*&: It has been discovered that on some systems, if a DNS lookup
20506 called via &[getipnodebyname()]& times out, HOST_NOT_FOUND is returned
20507 instead of TRY_AGAIN. That is why the default action is to try a DNS
20508 lookup first. Only if that gives a definite &"no such host"& is the local
20509 function called.
20510
20511 &*Compatibility*&: From Exim 4.85 until fixed for 4.90, there was an
20512 inadvertent constraint that a transport name as an option had to be the last
20513 option specified.
20514
20515
20516
20517 If no IP address for a host can be found, what happens is controlled by the
20518 &%host_find_failed%& option.
20519
20520 .vindex "&$host$&"
20521 When an address is routed to a local transport, IP addresses are not looked up.
20522 The host list is passed to the transport in the &$host$& variable.
20523
20524
20525
20526 .section "Manualroute examples" "SECID123"
20527 In some of the examples that follow, the presence of the &%remote_smtp%&
20528 transport, as defined in the default configuration file, is assumed:
20529
20530 .ilist
20531 .cindex "smart host" "example router"
20532 The &(manualroute)& router can be used to forward all external mail to a
20533 &'smart host'&. If you have set up, in the main part of the configuration, a
20534 named domain list that contains your local domains, for example:
20535 .code
20536 domainlist local_domains = my.domain.example
20537 .endd
20538 You can arrange for all other domains to be routed to a smart host by making
20539 your first router something like this:
20540 .code
20541 smart_route:
20542   driver = manualroute
20543   domains = !+local_domains
20544   transport = remote_smtp
20545   route_list = * smarthost.ref.example
20546 .endd
20547 This causes all non-local addresses to be sent to the single host
20548 &'smarthost.ref.example'&. If a colon-separated list of smart hosts is given,
20549 they are tried in order
20550 (but you can use &%hosts_randomize%& to vary the order each time).
20551 Another way of configuring the same thing is this:
20552 .code
20553 smart_route:
20554   driver = manualroute
20555   transport = remote_smtp
20556   route_list = !+local_domains  smarthost.ref.example
20557 .endd
20558 There is no difference in behaviour between these two routers as they stand.
20559 However, they behave differently if &%no_more%& is added to them. In the first
20560 example, the router is skipped if the domain does not match the &%domains%&
20561 precondition; the following router is always tried. If the router runs, it
20562 always matches the domain and so can never decline. Therefore, &%no_more%&
20563 would have no effect. In the second case, the router is never skipped; it
20564 always runs. However, if it doesn't match the domain, it declines. In this case
20565 &%no_more%& would prevent subsequent routers from running.
20566
20567 .next
20568 .cindex "mail hub example"
20569 A &'mail hub'& is a host which receives mail for a number of domains via MX
20570 records in the DNS and delivers it via its own private routing mechanism. Often
20571 the final destinations are behind a firewall, with the mail hub being the one
20572 machine that can connect to machines both inside and outside the firewall. The
20573 &(manualroute)& router is usually used on a mail hub to route incoming messages
20574 to the correct hosts. For a small number of domains, the routing can be inline,
20575 using the &%route_list%& option, but for a larger number a file or database
20576 lookup is easier to manage.
20577
20578 If the domain names are in fact the names of the machines to which the mail is
20579 to be sent by the mail hub, the configuration can be quite simple. For
20580 example:
20581 .code
20582 hub_route:
20583   driver = manualroute
20584   transport = remote_smtp
20585   route_list = *.rhodes.tvs.example  $domain
20586 .endd
20587 This configuration routes domains that match &`*.rhodes.tvs.example`& to hosts
20588 whose names are the same as the mail domains. A similar approach can be taken
20589 if the host name can be obtained from the domain name by a string manipulation
20590 that the expansion facilities can handle. Otherwise, a lookup based on the
20591 domain can be used to find the host:
20592 .code
20593 through_firewall:
20594   driver = manualroute
20595   transport = remote_smtp
20596   route_data = ${lookup {$domain} cdb {/internal/host/routes}}
20597 .endd
20598 The result of the lookup must be the name or IP address of the host (or
20599 hosts) to which the address is to be routed. If the lookup fails, the route
20600 data is empty, causing the router to decline. The address then passes to the
20601 next router.
20602
20603 .next
20604 .cindex "batched SMTP output example"
20605 .cindex "SMTP" "batched outgoing; example"
20606 You can use &(manualroute)& to deliver messages to pipes or files in batched
20607 SMTP format for onward transportation by some other means. This is one way of
20608 storing mail for a dial-up host when it is not connected. The route list entry
20609 can be as simple as a single domain name in a configuration like this:
20610 .code
20611 save_in_file:
20612   driver = manualroute
20613   transport = batchsmtp_appendfile
20614   route_list = saved.domain.example
20615 .endd
20616 though often a pattern is used to pick up more than one domain. If there are
20617 several domains or groups of domains with different transport requirements,
20618 different transports can be listed in the routing information:
20619 .code
20620 save_in_file:
20621   driver = manualroute
20622   route_list = \
20623     *.saved.domain1.example  $domain  batch_appendfile; \
20624     *.saved.domain2.example  \
20625       ${lookup{$domain}dbm{/domain2/hosts}{$value}fail} \
20626       batch_pipe
20627 .endd
20628 .vindex "&$domain$&"
20629 .vindex "&$host$&"
20630 The first of these just passes the domain in the &$host$& variable, which
20631 doesn't achieve much (since it is also in &$domain$&), but the second does a
20632 file lookup to find a value to pass, causing the router to decline to handle
20633 the address if the lookup fails.
20634
20635 .next
20636 .cindex "UUCP" "example of router for"
20637 Routing mail directly to UUCP software is a specific case of the use of
20638 &(manualroute)& in a gateway to another mail environment. This is an example of
20639 one way it can be done:
20640 .code
20641 # Transport
20642 uucp:
20643   driver = pipe
20644   user = nobody
20645   command = /usr/local/bin/uux -r - \
20646     ${substr_-5:$host}!rmail ${local_part}
20647   return_fail_output = true
20648
20649 # Router
20650 uucphost:
20651   transport = uucp
20652   driver = manualroute
20653   route_data = \
20654     ${lookup{$domain}lsearch{/usr/local/exim/uucphosts}}
20655 .endd
20656 The file &_/usr/local/exim/uucphosts_& contains entries like
20657 .code
20658 darksite.ethereal.example:           darksite.UUCP
20659 .endd
20660 It can be set up more simply without adding and removing &".UUCP"& but this way
20661 makes clear the distinction between the domain name
20662 &'darksite.ethereal.example'& and the UUCP host name &'darksite'&.
20663 .endlist
20664 .ecindex IIDmanrou1
20665 .ecindex IIDmanrou2
20666
20667
20668
20669
20670
20671
20672
20673
20674 . ////////////////////////////////////////////////////////////////////////////
20675 . ////////////////////////////////////////////////////////////////////////////
20676
20677 .chapter "The queryprogram router" "CHAPdriverlast"
20678 .scindex IIDquerou1 "&(queryprogram)& router"
20679 .scindex IIDquerou2 "routers" "&(queryprogram)&"
20680 .cindex "routing" "by external program"
20681 The &(queryprogram)& router routes an address by running an external command
20682 and acting on its output. This is an expensive way to route, and is intended
20683 mainly for use in lightly-loaded systems, or for performing experiments.
20684 However, if it is possible to use the precondition options (&%domains%&,
20685 &%local_parts%&, etc) to skip this router for most addresses, it could sensibly
20686 be used in special cases, even on a busy host. There are the following private
20687 options:
20688 .cindex "options" "&(queryprogram)& router"
20689
20690 .option command queryprogram string&!! unset
20691 This option must be set. It specifies the command that is to be run. The
20692 command is split up into a command name and arguments, and then each is
20693 expanded separately (exactly as for a &(pipe)& transport, described in chapter
20694 &<<CHAPpipetransport>>&).
20695
20696
20697 .option command_group queryprogram string unset
20698 .cindex "gid (group id)" "in &(queryprogram)& router"
20699 This option specifies a gid to be set when running the command while routing an
20700 address for deliver. It must be set if &%command_user%& specifies a numerical
20701 uid. If it begins with a digit, it is interpreted as the numerical value of the
20702 gid. Otherwise it is looked up using &[getgrnam()]&.
20703
20704
20705 .option command_user queryprogram string unset
20706 .cindex "uid (user id)" "for &(queryprogram)&"
20707 This option must be set. It specifies the uid which is set when running the
20708 command while routing an address for delivery. If the value begins with a digit,
20709 it is interpreted as the numerical value of the uid. Otherwise, it is looked up
20710 using &[getpwnam()]& to obtain a value for the uid and, if &%command_group%& is
20711 not set, a value for the gid also.
20712
20713 &*Warning:*& Changing uid and gid is possible only when Exim is running as
20714 root, which it does during a normal delivery in a conventional configuration.
20715 However, when an address is being verified during message reception, Exim is
20716 usually running as the Exim user, not as root. If the &(queryprogram)& router
20717 is called from a non-root process, Exim cannot change uid or gid before running
20718 the command. In this circumstance the command runs under the current uid and
20719 gid.
20720
20721
20722 .option current_directory queryprogram string /
20723 This option specifies an absolute path which is made the current directory
20724 before running the command.
20725
20726
20727 .option timeout queryprogram time 1h
20728 If the command does not complete within the timeout period, its process group
20729 is killed and the message is frozen. A value of zero time specifies no
20730 timeout.
20731
20732
20733 The standard output of the command is connected to a pipe, which is read when
20734 the command terminates. It should consist of a single line of output,
20735 containing up to five fields, separated by white space. The maximum length of
20736 the line is 1023 characters. Longer lines are silently truncated. The first
20737 field is one of the following words (case-insensitive):
20738
20739 .ilist
20740 &'Accept'&: routing succeeded; the remaining fields specify what to do (see
20741 below).
20742 .next
20743 &'Decline'&: the router declines; pass the address to the next router, unless
20744 &%no_more%& is set.
20745 .next
20746 &'Fail'&: routing failed; do not pass the address to any more routers. Any
20747 subsequent text on the line is an error message. If the router is run as part
20748 of address verification during an incoming SMTP message, the message is
20749 included in the SMTP response.
20750 .next
20751 &'Defer'&: routing could not be completed at this time; try again later. Any
20752 subsequent text on the line is an error message which is logged. It is not
20753 included in any SMTP response.
20754 .next
20755 &'Freeze'&: the same as &'defer'&, except that the message is frozen.
20756 .next
20757 &'Pass'&: pass the address to the next router (or the router specified by
20758 &%pass_router%&), overriding &%no_more%&.
20759 .next
20760 &'Redirect'&: the message is redirected. The remainder of the line is a list of
20761 new addresses, which are routed independently, starting with the first router,
20762 or the router specified by &%redirect_router%&, if set.
20763 .endlist
20764
20765 When the first word is &'accept'&, the remainder of the line consists of a
20766 number of keyed data values, as follows (split into two lines here, to fit on
20767 the page):
20768 .code
20769 ACCEPT TRANSPORT=<transport> HOSTS=<list of hosts>
20770 LOOKUP=byname|bydns DATA=<text>
20771 .endd
20772 The data items can be given in any order, and all are optional. If no transport
20773 is included, the transport specified by the generic &%transport%& option is
20774 used. The list of hosts and the lookup type are needed only if the transport is
20775 an &(smtp)& transport that does not itself supply a list of hosts.
20776
20777 The format of the list of hosts is the same as for the &(manualroute)& router.
20778 As well as host names and IP addresses with optional port numbers, as described
20779 in section &<<SECTformatonehostitem>>&, it may contain names followed by
20780 &`/MX`& to specify sublists of hosts that are obtained by looking up MX records
20781 (see section &<<SECThostshowused>>&).
20782
20783 If the lookup type is not specified, Exim behaves as follows when trying to
20784 find an IP address for each host: First, a DNS lookup is done. If this yields
20785 anything other than HOST_NOT_FOUND, that result is used. Otherwise, Exim
20786 goes on to try a call to &[getipnodebyname()]& or &[gethostbyname()]&, and the
20787 result of the lookup is the result of that call.
20788
20789 .vindex "&$address_data$&"
20790 If the DATA field is set, its value is placed in the &$address_data$&
20791 variable. For example, this return line
20792 .code
20793 accept hosts=x1.y.example:x2.y.example data="rule1"
20794 .endd
20795 routes the address to the default transport, passing a list of two hosts. When
20796 the transport runs, the string &"rule1"& is in &$address_data$&.
20797 .ecindex IIDquerou1
20798 .ecindex IIDquerou2
20799
20800
20801
20802
20803 . ////////////////////////////////////////////////////////////////////////////
20804 . ////////////////////////////////////////////////////////////////////////////
20805
20806 .chapter "The redirect router" "CHAPredirect"
20807 .scindex IIDredrou1 "&(redirect)& router"
20808 .scindex IIDredrou2 "routers" "&(redirect)&"
20809 .cindex "alias file" "in a &(redirect)& router"
20810 .cindex "address redirection" "&(redirect)& router"
20811 The &(redirect)& router handles several kinds of address redirection. Its most
20812 common uses are for resolving local part aliases from a central alias file
20813 (usually called &_/etc/aliases_&) and for handling users' personal &_.forward_&
20814 files, but it has many other potential uses. The incoming address can be
20815 redirected in several different ways:
20816
20817 .ilist
20818 It can be replaced by one or more new addresses which are themselves routed
20819 independently.
20820 .next
20821 It can be routed to be delivered to a given file or directory.
20822 .next
20823 It can be routed to be delivered to a specified pipe command.
20824 .next
20825 It can cause an automatic reply to be generated.
20826 .next
20827 It can be forced to fail, optionally with a custom error message.
20828 .next
20829 It can be temporarily deferred, optionally with a custom message.
20830 .next
20831 It can be discarded.
20832 .endlist
20833
20834 The generic &%transport%& option must not be set for &(redirect)& routers.
20835 However, there are some private options which define transports for delivery to
20836 files and pipes, and for generating autoreplies. See the &%file_transport%&,
20837 &%pipe_transport%& and &%reply_transport%& descriptions below.
20838
20839 If success DSNs have been requested
20840 .cindex "DSN" "success"
20841 .cindex "Delivery Status Notification" "success"
20842 redirection triggers one and the DSN options are not passed any further.
20843
20844
20845
20846 .section "Redirection data" "SECID124"
20847 The router operates by interpreting a text string which it obtains either by
20848 expanding the contents of the &%data%& option, or by reading the entire
20849 contents of a file whose name is given in the &%file%& option. These two
20850 options are mutually exclusive. The first is commonly used for handling system
20851 aliases, in a configuration like this:
20852 .code
20853 system_aliases:
20854   driver = redirect
20855   data = ${lookup{$local_part}lsearch{/etc/aliases}}
20856 .endd
20857 If the lookup fails, the expanded string in this example is empty. When the
20858 expansion of &%data%& results in an empty string, the router declines. A forced
20859 expansion failure also causes the router to decline; other expansion failures
20860 cause delivery to be deferred.
20861
20862 A configuration using &%file%& is commonly used for handling users'
20863 &_.forward_& files, like this:
20864 .code
20865 userforward:
20866   driver = redirect
20867   check_local_user
20868   file = $home/.forward
20869   no_verify
20870 .endd
20871 If the file does not exist, or causes no action to be taken (for example, it is
20872 empty or consists only of comments), the router declines. &*Warning*&: This
20873 is not the case when the file contains syntactically valid items that happen to
20874 yield empty addresses, for example, items containing only RFC 2822 address
20875 comments.
20876
20877 .new
20878 .cindex "tainted data" "in filenames"
20879 .cindex redirect "tainted data"
20880 Tainted data may not be used for a filename.
20881
20882 &*Warning*&: It is unwise to use &$local_part$& or &$domain$&
20883 directly for redirection,
20884 as they are provided by a potential attacker.
20885 In the examples above, &$local_part$& is used for looking up data held locally
20886 on the system, and not used directly (the second example derives &$home$& via
20887 the passsword file or database, using &$local_part$&).
20888 .wen
20889
20890
20891
20892 .section "Forward files and address verification" "SECID125"
20893 .cindex "address redirection" "while verifying"
20894 It is usual to set &%no_verify%& on &(redirect)& routers which handle users'
20895 &_.forward_& files, as in the example above. There are two reasons for this:
20896
20897 .ilist
20898 When Exim is receiving an incoming SMTP message from a remote host, it is
20899 running under the Exim uid, not as root. Exim is unable to change uid to read
20900 the file as the user, and it may not be able to read it as the Exim user. So in
20901 practice the router may not be able to operate.
20902 .next
20903 However, even when the router can operate, the existence of a &_.forward_& file
20904 is unimportant when verifying an address. What should be checked is whether the
20905 local part is a valid user name or not. Cutting out the redirection processing
20906 saves some resources.
20907 .endlist
20908
20909
20910
20911
20912
20913
20914 .section "Interpreting redirection data" "SECID126"
20915 .cindex "Sieve filter" "specifying in redirection data"
20916 .cindex "filter" "specifying in redirection data"
20917 The contents of the data string, whether obtained from &%data%& or &%file%&,
20918 can be interpreted in two different ways:
20919
20920 .ilist
20921 If the &%allow_filter%& option is set true, and the data begins with the text
20922 &"#Exim filter"& or &"#Sieve filter"&, it is interpreted as a list of
20923 &'filtering'& instructions in the form of an Exim or Sieve filter file,
20924 respectively. Details of the syntax and semantics of filter files are described
20925 in a separate document entitled &'Exim's interfaces to mail filtering'&; this
20926 document is intended for use by end users.
20927 .next
20928 Otherwise, the data must be a comma-separated list of redirection items, as
20929 described in the next section.
20930 .endlist
20931
20932 When a message is redirected to a file (a &"mail folder"&), the filename given
20933 in a non-filter redirection list must always be an absolute path. A filter may
20934 generate a relative path &-- how this is handled depends on the transport's
20935 configuration. See section &<<SECTfildiropt>>& for a discussion of this issue
20936 for the &(appendfile)& transport.
20937
20938
20939
20940 .section "Items in a non-filter redirection list" "SECTitenonfilred"
20941 .cindex "address redirection" "non-filter list items"
20942 When the redirection data is not an Exim or Sieve filter, for example, if it
20943 comes from a conventional alias or forward file, it consists of a list of
20944 addresses, filenames, pipe commands, or certain special items (see section
20945 &<<SECTspecitredli>>& below). The special items can be individually enabled or
20946 disabled by means of options whose names begin with &%allow_%& or &%forbid_%&,
20947 depending on their default values. The items in the list are separated by
20948 commas or newlines.
20949 If a comma is required in an item, the entire item must be enclosed in double
20950 quotes.
20951
20952 Lines starting with a # character are comments, and are ignored, and # may
20953 also appear following a comma, in which case everything between the # and the
20954 next newline character is ignored.
20955
20956 If an item is entirely enclosed in double quotes, these are removed. Otherwise
20957 double quotes are retained because some forms of mail address require their use
20958 (but never to enclose the entire address). In the following description,
20959 &"item"& refers to what remains after any surrounding double quotes have been
20960 removed.
20961
20962 .vindex "&$local_part$&"
20963 &*Warning*&: If you use an Exim expansion to construct a redirection address,
20964 and the expansion contains a reference to &$local_part$&, you should make use
20965 of the &%quote_local_part%& expansion operator, in case the local part contains
20966 special characters. For example, to redirect all mail for the domain
20967 &'obsolete.example'&, retaining the existing local part, you could use this
20968 setting:
20969 .code
20970 data = ${quote_local_part:$local_part}@newdomain.example
20971 .endd
20972
20973
20974 .section "Redirecting to a local mailbox" "SECTredlocmai"
20975 .cindex "routing" "loops in"
20976 .cindex "loop" "while routing, avoidance of"
20977 .cindex "address redirection" "to local mailbox"
20978 A redirection item may safely be the same as the address currently under
20979 consideration. This does not cause a routing loop, because a router is
20980 automatically skipped if any ancestor of the address that is being processed
20981 is the same as the current address and was processed by the current router.
20982 Such an address is therefore passed to the following routers, so it is handled
20983 as if there were no redirection. When making this loop-avoidance test, the
20984 complete local part, including any prefix or suffix, is used.
20985
20986 .cindex "address redirection" "local part without domain"
20987 Specifying the same local part without a domain is a common usage in personal
20988 filter files when the user wants to have messages delivered to the local
20989 mailbox and also forwarded elsewhere. For example, the user whose login is
20990 &'cleo'& might have a &_.forward_& file containing this:
20991 .code
20992 cleo, cleopatra@egypt.example
20993 .endd
20994 .cindex "backslash in alias file"
20995 .cindex "alias file" "backslash in"
20996 For compatibility with other MTAs, such unqualified local parts may be
20997 preceded by &"\"&, but this is not a requirement for loop prevention. However,
20998 it does make a difference if more than one domain is being handled
20999 synonymously.
21000
21001 If an item begins with &"\"& and the rest of the item parses as a valid RFC
21002 2822 address that does not include a domain, the item is qualified using the
21003 domain of the incoming address. In the absence of a leading &"\"&, unqualified
21004 addresses are qualified using the value in &%qualify_recipient%&, but you can
21005 force the incoming domain to be used by setting &%qualify_preserve_domain%&.
21006
21007 Care must be taken if there are alias names for local users.
21008 Consider an MTA handling a single local domain where the system alias file
21009 contains:
21010 .code
21011 Sam.Reman: spqr
21012 .endd
21013 Now suppose that Sam (whose login id is &'spqr'&) wants to save copies of
21014 messages in the local mailbox, and also forward copies elsewhere. He creates
21015 this forward file:
21016 .code
21017 Sam.Reman, spqr@reme.elsewhere.example
21018 .endd
21019 With these settings, an incoming message addressed to &'Sam.Reman'& fails. The
21020 &(redirect)& router for system aliases does not process &'Sam.Reman'& the
21021 second time round, because it has previously routed it,
21022 and the following routers presumably cannot handle the alias. The forward file
21023 should really contain
21024 .code
21025 spqr, spqr@reme.elsewhere.example
21026 .endd
21027 but because this is such a common error, the &%check_ancestor%& option (see
21028 below) exists to provide a way to get round it. This is normally set on a
21029 &(redirect)& router that is handling users' &_.forward_& files.
21030
21031
21032
21033 .section "Special items in redirection lists" "SECTspecitredli"
21034 In addition to addresses, the following types of item may appear in redirection
21035 lists (that is, in non-filter redirection data):
21036
21037 .ilist
21038 .cindex "pipe" "in redirection list"
21039 .cindex "address redirection" "to pipe"
21040 An item is treated as a pipe command if it begins with &"|"& and does not parse
21041 as a valid RFC 2822 address that includes a domain. A transport for running the
21042 command must be specified by the &%pipe_transport%& option.
21043 Normally, either the router or the transport specifies a user and a group under
21044 which to run the delivery. The default is to use the Exim user and group.
21045
21046 Single or double quotes can be used for enclosing the individual arguments of
21047 the pipe command; no interpretation of escapes is done for single quotes. If
21048 the command contains a comma character, it is necessary to put the whole item
21049 in double quotes, for example:
21050 .code
21051 "|/some/command ready,steady,go"
21052 .endd
21053 since items in redirection lists are terminated by commas. Do not, however,
21054 quote just the command. An item such as
21055 .code
21056 |"/some/command ready,steady,go"
21057 .endd
21058 is interpreted as a pipe with a rather strange command name, and no arguments.
21059
21060 Note that the above example assumes that the text comes from a lookup source
21061 of some sort, so that the quotes are part of the data.  If composing a
21062 redirect router with a &%data%& option directly specifying this command, the
21063 quotes will be used by the configuration parser to define the extent of one
21064 string, but will not be passed down into the redirect router itself.  There
21065 are two main approaches to get around this: escape quotes to be part of the
21066 data itself, or avoid using this mechanism and instead create a custom
21067 transport with the &%command%& option set and reference that transport from
21068 an &%accept%& router.
21069
21070 .next
21071 .cindex "file" "in redirection list"
21072 .cindex "address redirection" "to file"
21073 An item is interpreted as a path name if it begins with &"/"& and does not
21074 parse as a valid RFC 2822 address that includes a domain. For example,
21075 .code
21076 /home/world/minbari
21077 .endd
21078 is treated as a filename, but
21079 .code
21080 /s=molari/o=babylon/@x400gate.way
21081 .endd
21082 is treated as an address. For a filename, a transport must be specified using
21083 the &%file_transport%& option. However, if the generated path name ends with a
21084 forward slash character, it is interpreted as a directory name rather than a
21085 filename, and &%directory_transport%& is used instead.
21086
21087 Normally, either the router or the transport specifies a user and a group under
21088 which to run the delivery. The default is to use the Exim user and group.
21089
21090 .cindex "&_/dev/null_&"
21091 However, if a redirection item is the path &_/dev/null_&, delivery to it is
21092 bypassed at a high level, and the log entry shows &"**bypassed**"&
21093 instead of a transport name. In this case the user and group are not used.
21094
21095 .next
21096 .cindex "included address list"
21097 .cindex "address redirection" "included external list"
21098 If an item is of the form
21099 .code
21100 :include:<path name>
21101 .endd
21102 a list of further items is taken from the given file and included at that
21103 point. &*Note*&: Such a file can not be a filter file; it is just an
21104 out-of-line addition to the list. The items in the included list are separated
21105 by commas or newlines and are not subject to expansion. If this is the first
21106 item in an alias list in an &(lsearch)& file, a colon must be used to terminate
21107 the alias name. This example is incorrect:
21108 .code
21109 list1    :include:/opt/lists/list1
21110 .endd
21111 It must be given as
21112 .code
21113 list1:   :include:/opt/lists/list1
21114 .endd
21115 .new
21116 .cindex "tainted data" "in filenames"
21117 .cindex redirect "tainted data"
21118 Tainted data may not be used for a filename.
21119 .wen
21120 .next
21121 .cindex "address redirection" "to black hole"
21122 .cindex "delivery" "discard"
21123 .cindex "delivery" "blackhole"
21124 .cindex "black hole"
21125 .cindex "abandoning mail"
21126 Sometimes you want to throw away mail to a particular local part.  Making the
21127 &%data%& option expand to an empty string does not work, because that causes
21128 the router to decline. Instead, the alias item
21129 .code
21130 :blackhole:
21131 .endd
21132 can be used. It does what its name implies. No delivery is
21133 done, and no error message is generated. This has the same effect as specifying
21134 &_/dev/null_& as a destination, but it can be independently disabled.
21135
21136 &*Warning*&: If &':blackhole:'& appears anywhere in a redirection list, no
21137 delivery is done for the original local part, even if other redirection items
21138 are present. If you are generating a multi-item list (for example, by reading a
21139 database) and need the ability to provide a no-op item, you must use
21140 &_/dev/null_&.
21141
21142 .next
21143 .cindex "delivery" "forcing failure"
21144 .cindex "delivery" "forcing deferral"
21145 .cindex "failing delivery" "forcing"
21146 .cindex "deferred delivery, forcing"
21147 .cindex "customizing" "failure message"
21148 An attempt to deliver a particular address can be deferred or forced to fail by
21149 redirection items of the form
21150 .code
21151 :defer:
21152 :fail:
21153 .endd
21154 respectively. When a redirection list contains such an item, it applies
21155 to the entire redirection; any other items in the list are ignored. Any
21156 text following &':fail:'& or &':defer:'& is placed in the error text
21157 associated with the failure. For example, an alias file might contain:
21158 .code
21159 X.Employee:  :fail: Gone away, no forwarding address
21160 .endd
21161 In the case of an address that is being verified from an ACL or as the subject
21162 of a
21163 .cindex "VRFY" "error text, display of"
21164 VRFY command, the text is included in the SMTP error response by
21165 default.
21166 .cindex "EXPN" "error text, display of"
21167 The text is not included in the response to an EXPN command. In non-SMTP cases
21168 the text is included in the error message that Exim generates.
21169
21170 .cindex "SMTP" "error codes"
21171 By default, Exim sends a 451 SMTP code for a &':defer:'&, and 550 for
21172 &':fail:'&. However, if the message starts with three digits followed by a
21173 space, optionally followed by an extended code of the form &'n.n.n'&, also
21174 followed by a space, and the very first digit is the same as the default error
21175 code, the code from the message is used instead. If the very first digit is
21176 incorrect, a panic error is logged, and the default code is used. You can
21177 suppress the use of the supplied code in a redirect router by setting the
21178 &%forbid_smtp_code%& option true. In this case, any SMTP code is quietly
21179 ignored.
21180
21181 .vindex "&$acl_verify_message$&"
21182 In an ACL, an explicitly provided message overrides the default, but the
21183 default message is available in the variable &$acl_verify_message$& and can
21184 therefore be included in a custom message if this is desired.
21185
21186 Normally the error text is the rest of the redirection list &-- a comma does
21187 not terminate it &-- but a newline does act as a terminator. Newlines are not
21188 normally present in alias expansions. In &(lsearch)& lookups they are removed
21189 as part of the continuation process, but they may exist in other kinds of
21190 lookup and in &':include:'& files.
21191
21192 During routing for message delivery (as opposed to verification), a redirection
21193 containing &':fail:'& causes an immediate failure of the incoming address,
21194 whereas &':defer:'& causes the message to remain in the queue so that a
21195 subsequent delivery attempt can happen at a later time. If an address is
21196 deferred for too long, it will ultimately fail, because the normal retry
21197 rules still apply.
21198
21199 .next
21200 .cindex "alias file" "exception to default"
21201 Sometimes it is useful to use a single-key search type with a default (see
21202 chapter &<<CHAPfdlookup>>&) to look up aliases. However, there may be a need
21203 for exceptions to the default. These can be handled by aliasing them to
21204 &':unknown:'&. This differs from &':fail:'& in that it causes the &(redirect)&
21205 router to decline, whereas &':fail:'& forces routing to fail. A lookup which
21206 results in an empty redirection list has the same effect.
21207 .endlist
21208
21209
21210 .section "Duplicate addresses" "SECTdupaddr"
21211 .cindex "duplicate addresses"
21212 .cindex "address duplicate, discarding"
21213 .cindex "pipe" "duplicated"
21214 Exim removes duplicate addresses from the list to which it is delivering, so as
21215 to deliver just one copy to each address. This does not apply to deliveries
21216 routed to pipes by different immediate parent addresses, but an indirect
21217 aliasing scheme of the type
21218 .code
21219 pipe:       |/some/command $local_part
21220 localpart1: pipe
21221 localpart2: pipe
21222 .endd
21223 does not work with a message that is addressed to both local parts, because
21224 when the second is aliased to the intermediate local part &"pipe"& it gets
21225 discarded as being the same as a previously handled address. However, a scheme
21226 such as
21227 .code
21228 localpart1: |/some/command $local_part
21229 localpart2: |/some/command $local_part
21230 .endd
21231 does result in two different pipe deliveries, because the immediate parents of
21232 the pipes are distinct.
21233
21234
21235
21236 .section "Repeated redirection expansion" "SECID128"
21237 .cindex "repeated redirection expansion"
21238 .cindex "address redirection" "repeated for each delivery attempt"
21239 When a message cannot be delivered to all of its recipients immediately,
21240 leading to two or more delivery attempts, redirection expansion is carried out
21241 afresh each time for those addresses whose children were not all previously
21242 delivered. If redirection is being used as a mailing list, this can lead to new
21243 members of the list receiving copies of old messages. The &%one_time%& option
21244 can be used to avoid this.
21245
21246
21247 .section "Errors in redirection lists" "SECID129"
21248 .cindex "address redirection" "errors"
21249 If &%skip_syntax_errors%& is set, a malformed address that causes a parsing
21250 error is skipped, and an entry is written to the main log. This may be useful
21251 for mailing lists that are automatically managed. Otherwise, if an error is
21252 detected while generating the list of new addresses, the original address is
21253 deferred. See also &%syntax_errors_to%&.
21254
21255
21256
21257 .section "Private options for the redirect router" "SECID130"
21258
21259 .cindex "options" "&(redirect)& router"
21260 The private options for the &(redirect)& router are as follows:
21261
21262
21263 .option allow_defer redirect boolean false
21264 Setting this option allows the use of &':defer:'& in non-filter redirection
21265 data, or the &%defer%& command in an Exim filter file.
21266
21267
21268 .option allow_fail redirect boolean false
21269 .cindex "failing delivery" "from filter"
21270 If this option is true, the &':fail:'& item can be used in a redirection list,
21271 and the &%fail%& command may be used in an Exim filter file.
21272
21273
21274 .option allow_filter redirect boolean false
21275 .cindex "filter" "enabling use of"
21276 .cindex "Sieve filter" "enabling use of"
21277 Setting this option allows Exim to interpret redirection data that starts with
21278 &"#Exim filter"& or &"#Sieve filter"& as a set of filtering instructions. There
21279 are some features of Exim filter files that some administrators may wish to
21280 lock out; see the &%forbid_filter_%&&'xxx'& options below.
21281
21282 It is also possible to lock out Exim filters or Sieve filters while allowing
21283 the other type; see &%forbid_exim_filter%& and &%forbid_sieve_filter%&.
21284
21285
21286 The filter is run using the uid and gid set by the generic &%user%& and
21287 &%group%& options. These take their defaults from the password data if
21288 &%check_local_user%& is set, so in the normal case of users' personal filter
21289 files, the filter is run as the relevant user. When &%allow_filter%& is set
21290 true, Exim insists that either &%check_local_user%& or &%user%& is set.
21291
21292
21293
21294 .option allow_freeze redirect boolean false
21295 .cindex "freezing messages" "allowing in filter"
21296 Setting this option allows the use of the &%freeze%& command in an Exim filter.
21297 This command is more normally encountered in system filters, and is disabled by
21298 default for redirection filters because it isn't something you usually want to
21299 let ordinary users do.
21300
21301
21302
21303 .option check_ancestor redirect boolean false
21304 This option is concerned with handling generated addresses that are the same
21305 as some address in the list of redirection ancestors of the current address.
21306 Although it is turned off by default in the code, it is set in the default
21307 configuration file for handling users' &_.forward_& files. It is recommended
21308 for this use of the &(redirect)& router.
21309
21310 When &%check_ancestor%& is set, if a generated address (including the domain)
21311 is the same as any ancestor of the current address, it is replaced by a copy of
21312 the current address. This helps in the case where local part A is aliased to B,
21313 and B has a &_.forward_& file pointing back to A. For example, within a single
21314 domain, the local part &"Joe.Bloggs"& is aliased to &"jb"& and
21315 &_&~jb/.forward_& contains:
21316 .code
21317 \Joe.Bloggs, <other item(s)>
21318 .endd
21319 Without the &%check_ancestor%& setting, either local part (&"jb"& or
21320 &"joe.bloggs"&) gets processed once by each router and so ends up as it was
21321 originally. If &"jb"& is the real mailbox name, mail to &"jb"& gets delivered
21322 (having been turned into &"joe.bloggs"& by the &_.forward_& file and back to
21323 &"jb"& by the alias), but mail to &"joe.bloggs"& fails. Setting
21324 &%check_ancestor%& on the &(redirect)& router that handles the &_.forward_&
21325 file prevents it from turning &"jb"& back into &"joe.bloggs"& when that was the
21326 original address. See also the &%repeat_use%& option below.
21327
21328
21329 .option check_group redirect boolean "see below"
21330 When the &%file%& option is used, the group owner of the file is checked only
21331 when this option is set. The permitted groups are those listed in the
21332 &%owngroups%& option, together with the user's default group if
21333 &%check_local_user%& is set. If the file has the wrong group, routing is
21334 deferred. The default setting for this option is true if &%check_local_user%&
21335 is set and the &%modemask%& option permits the group write bit, or if the
21336 &%owngroups%& option is set. Otherwise it is false, and no group check occurs.
21337
21338
21339
21340 .option check_owner redirect boolean "see below"
21341 When the &%file%& option is used, the owner of the file is checked only when
21342 this option is set. If &%check_local_user%& is set, the local user is
21343 permitted; otherwise the owner must be one of those listed in the &%owners%&
21344 option. The default value for this option is true if &%check_local_user%& or
21345 &%owners%& is set. Otherwise the default is false, and no owner check occurs.
21346
21347
21348 .option data redirect string&!! unset
21349 This option is mutually exclusive with &%file%&. One or other of them must be
21350 set, but not both. The contents of &%data%& are expanded, and then used as the
21351 list of forwarding items, or as a set of filtering instructions. If the
21352 expansion is forced to fail, or the result is an empty string or a string that
21353 has no effect (consists entirely of comments), the router declines.
21354
21355 When filtering instructions are used, the string must begin with &"#Exim
21356 filter"&, and all comments in the string, including this initial one, must be
21357 terminated with newline characters. For example:
21358 .code
21359 data = #Exim filter\n\
21360        if $h_to: contains Exim then save $home/mail/exim endif
21361 .endd
21362 If you are reading the data from a database where newlines cannot be included,
21363 you can use the &${sg}$& expansion item to turn the escape string of your
21364 choice into a newline.
21365
21366
21367 .option directory_transport redirect string&!! unset
21368 A &(redirect)& router sets up a direct delivery to a directory when a path name
21369 ending with a slash is specified as a new &"address"&. The transport used is
21370 specified by this option, which, after expansion, must be the name of a
21371 configured transport. This should normally be an &(appendfile)& transport.
21372
21373
21374 .option file redirect string&!! unset
21375 This option specifies the name of a file that contains the redirection data. It
21376 is mutually exclusive with the &%data%& option. The string is expanded before
21377 use; if the expansion is forced to fail, the router declines. Other expansion
21378 failures cause delivery to be deferred. The result of a successful expansion
21379 must be an absolute path. The entire file is read and used as the redirection
21380 data. If the data is an empty string or a string that has no effect (consists
21381 entirely of comments), the router declines.
21382
21383 .cindex "NFS" "checking for file existence"
21384 If the attempt to open the file fails with a &"does not exist"& error, Exim
21385 runs a check on the containing directory,
21386 unless &%ignore_enotdir%& is true (see below).
21387 If the directory does not appear to exist, delivery is deferred. This can
21388 happen when users' &_.forward_& files are in NFS-mounted directories, and there
21389 is a mount problem. If the containing directory does exist, but the file does
21390 not, the router declines.
21391
21392
21393 .option file_transport redirect string&!! unset
21394 .vindex "&$address_file$&"
21395 A &(redirect)& router sets up a direct delivery to a file when a path name not
21396 ending in a slash is specified as a new &"address"&. The transport used is
21397 specified by this option, which, after expansion, must be the name of a
21398 configured transport. This should normally be an &(appendfile)& transport. When
21399 it is running, the filename is in &$address_file$&.
21400
21401
21402 .option filter_prepend_home redirect boolean true
21403 When this option is true, if a &(save)& command in an Exim filter specifies a
21404 relative path, and &$home$& is defined, it is automatically prepended to the
21405 relative path. If this option is set false, this action does not happen. The
21406 relative path is then passed to the transport unmodified.
21407
21408
21409 .option forbid_blackhole redirect boolean false
21410 .cindex "restricting access to features"
21411 .cindex "filter" "locking out certain features"
21412 If this option is true, the &':blackhole:'& item may not appear in a
21413 redirection list.
21414
21415
21416 .option forbid_exim_filter redirect boolean false
21417 .cindex "restricting access to features"
21418 .cindex "filter" "locking out certain features"
21419 If this option is set true, only Sieve filters are permitted when
21420 &%allow_filter%& is true.
21421
21422
21423
21424
21425 .option forbid_file redirect boolean false
21426 .cindex "restricting access to features"
21427 .cindex "delivery" "to file; forbidding"
21428 .cindex "filter" "locking out certain features"
21429 .cindex "Sieve filter" "forbidding delivery to a file"
21430 .cindex "Sieve filter" "&""keep""& facility; disabling"
21431 If this option is true, this router may not generate a new address that
21432 specifies delivery to a local file or directory, either from a filter or from a
21433 conventional forward file. This option is forced to be true if &%one_time%& is
21434 set. It applies to Sieve filters as well as to Exim filters, but if true, it
21435 locks out the Sieve's &"keep"& facility.
21436
21437
21438 .option forbid_filter_dlfunc redirect boolean false
21439 .cindex "restricting access to features"
21440 .cindex "filter" "locking out certain features"
21441 If this option is true, string expansions in Exim filters are not allowed to
21442 make use of the &%dlfunc%& expansion facility to run dynamically loaded
21443 functions.
21444
21445 .option forbid_filter_existstest redirect boolean false
21446 .cindex "restricting access to features"
21447 .cindex "filter" "locking out certain features"
21448 .cindex "expansion" "statting a file"
21449 If this option is true, string expansions in Exim filters are not allowed to
21450 make use of the &%exists%& condition or the &%stat%& expansion item.
21451
21452 .option forbid_filter_logwrite redirect boolean false
21453 .cindex "restricting access to features"
21454 .cindex "filter" "locking out certain features"
21455 If this option is true, use of the logging facility in Exim filters is not
21456 permitted. Logging is in any case available only if the filter is being run
21457 under some unprivileged uid (which is normally the case for ordinary users'
21458 &_.forward_& files).
21459
21460
21461 .option forbid_filter_lookup redirect boolean false
21462 .cindex "restricting access to features"
21463 .cindex "filter" "locking out certain features"
21464 If this option is true, string expansions in Exim filter files are not allowed
21465 to make use of &%lookup%& items.
21466
21467
21468 .option forbid_filter_perl redirect boolean false
21469 .cindex "restricting access to features"
21470 .cindex "filter" "locking out certain features"
21471 This option has an effect only if Exim is built with embedded Perl support. If
21472 it is true, string expansions in Exim filter files are not allowed to make use
21473 of the embedded Perl support.
21474
21475
21476 .option forbid_filter_readfile redirect boolean false
21477 .cindex "restricting access to features"
21478 .cindex "filter" "locking out certain features"
21479 If this option is true, string expansions in Exim filter files are not allowed
21480 to make use of &%readfile%& items.
21481
21482
21483 .option forbid_filter_readsocket redirect boolean false
21484 .cindex "restricting access to features"
21485 .cindex "filter" "locking out certain features"
21486 If this option is true, string expansions in Exim filter files are not allowed
21487 to make use of &%readsocket%& items.
21488
21489
21490 .option forbid_filter_reply redirect boolean false
21491 .cindex "restricting access to features"
21492 .cindex "filter" "locking out certain features"
21493 If this option is true, this router may not generate an automatic reply
21494 message. Automatic replies can be generated only from Exim or Sieve filter
21495 files, not from traditional forward files. This option is forced to be true if
21496 &%one_time%& is set.
21497
21498
21499 .option forbid_filter_run redirect boolean false
21500 .cindex "restricting access to features"
21501 .cindex "filter" "locking out certain features"
21502 If this option is true, string expansions in Exim filter files are not allowed
21503 to make use of &%run%& items.
21504
21505
21506 .option forbid_include redirect boolean false
21507 .cindex "restricting access to features"
21508 .cindex "filter" "locking out certain features"
21509 If this option is true, items of the form
21510 .code
21511 :include:<path name>
21512 .endd
21513 are not permitted in non-filter redirection lists.
21514
21515
21516 .option forbid_pipe redirect boolean false
21517 .cindex "restricting access to features"
21518 .cindex "filter" "locking out certain features"
21519 .cindex "delivery" "to pipe; forbidding"
21520 If this option is true, this router may not generate a new address which
21521 specifies delivery to a pipe, either from an Exim filter or from a conventional
21522 forward file. This option is forced to be true if &%one_time%& is set.
21523
21524
21525 .option forbid_sieve_filter redirect boolean false
21526 .cindex "restricting access to features"
21527 .cindex "filter" "locking out certain features"
21528 If this option is set true, only Exim filters are permitted when
21529 &%allow_filter%& is true.
21530
21531
21532 .cindex "SMTP" "error codes"
21533 .option forbid_smtp_code redirect boolean false
21534 If this option is set true, any SMTP error codes that are present at the start
21535 of messages specified for &`:defer:`& or &`:fail:`& are quietly ignored, and
21536 the default codes (451 and 550, respectively) are always used.
21537
21538
21539
21540
21541 .option hide_child_in_errmsg redirect boolean false
21542 .cindex "bounce message" "redirection details; suppressing"
21543 If this option is true, it prevents Exim from quoting a child address if it
21544 generates a bounce or delay message for it. Instead it says &"an address
21545 generated from <&'the top level address'&>"&. Of course, this applies only to
21546 bounces generated locally. If a message is forwarded to another host, &'its'&
21547 bounce may well quote the generated address.
21548
21549
21550 .option ignore_eacces redirect boolean false
21551 .cindex "EACCES"
21552 If this option is set and an attempt to open a redirection file yields the
21553 EACCES error (permission denied), the &(redirect)& router behaves as if the
21554 file did not exist.
21555
21556
21557 .option ignore_enotdir redirect boolean false
21558 .cindex "ENOTDIR"
21559 If this option is set and an attempt to open a redirection file yields the
21560 ENOTDIR error (something on the path is not a directory), the &(redirect)&
21561 router behaves as if the file did not exist.
21562
21563 Setting &%ignore_enotdir%& has another effect as well: When a &(redirect)&
21564 router that has the &%file%& option set discovers that the file does not exist
21565 (the ENOENT error), it tries to &[stat()]& the parent directory, as a check
21566 against unmounted NFS directories. If the parent can not be statted, delivery
21567 is deferred. However, it seems wrong to do this check when &%ignore_enotdir%&
21568 is set, because that option tells Exim to ignore &"something on the path is not
21569 a directory"& (the ENOTDIR error). This is a confusing area, because it seems
21570 that some operating systems give ENOENT where others give ENOTDIR.
21571
21572
21573
21574 .option include_directory redirect string unset
21575 If this option is set, the path names of any &':include:'& items in a
21576 redirection list must start with this directory.
21577
21578
21579 .option modemask redirect "octal integer" 022
21580 This specifies mode bits which must not be set for a file specified by the
21581 &%file%& option. If any of the forbidden bits are set, delivery is deferred.
21582
21583
21584 .option one_time redirect boolean false
21585 .cindex "one-time aliasing/forwarding expansion"
21586 .cindex "alias file" "one-time expansion"
21587 .cindex "forward file" "one-time expansion"
21588 .cindex "mailing lists" "one-time expansion"
21589 .cindex "address redirection" "one-time expansion"
21590 Sometimes the fact that Exim re-evaluates aliases and reprocesses redirection
21591 files each time it tries to deliver a message causes a problem when one or more
21592 of the generated addresses fails be delivered at the first attempt. The problem
21593 is not one of duplicate delivery &-- Exim is clever enough to handle that &--
21594 but of what happens when the redirection list changes during the time that the
21595 message is on Exim's queue. This is particularly true in the case of mailing
21596 lists, where new subscribers might receive copies of messages that were posted
21597 before they subscribed.
21598
21599 If &%one_time%& is set and any addresses generated by the router fail to
21600 deliver at the first attempt, the failing addresses are added to the message as
21601 &"top level"& addresses, and the parent address that generated them is marked
21602 &"delivered"&. Thus, redirection does not happen again at the next delivery
21603 attempt.
21604
21605 &*Warning 1*&: Any header line addition or removal that is specified by this
21606 router would be lost if delivery did not succeed at the first attempt. For this
21607 reason, the &%headers_add%& and &%headers_remove%& generic options are not
21608 permitted when &%one_time%& is set.
21609
21610 &*Warning 2*&: To ensure that the router generates only addresses (as opposed
21611 to pipe or file deliveries or auto-replies) &%forbid_file%&, &%forbid_pipe%&,
21612 and &%forbid_filter_reply%& are forced to be true when &%one_time%& is set.
21613
21614 &*Warning 3*&: The &%unseen%& generic router option may not be set with
21615 &%one_time%&.
21616
21617 The original top-level address is remembered with each of the generated
21618 addresses, and is output in any log messages. However, any intermediate parent
21619 addresses are not recorded. This makes a difference to the log only if
21620 &%all_parents%& log selector is set. It is expected that &%one_time%& will
21621 typically be used for mailing lists, where there is normally just one level of
21622 expansion.
21623
21624
21625 .option owners redirect "string list" unset
21626 .cindex "ownership" "alias file"
21627 .cindex "ownership" "forward file"
21628 .cindex "alias file" "ownership"
21629 .cindex "forward file" "ownership"
21630 This specifies a list of permitted owners for the file specified by &%file%&.
21631 This list is in addition to the local user when &%check_local_user%& is set.
21632 See &%check_owner%& above.
21633
21634
21635 .option owngroups redirect "string list" unset
21636 This specifies a list of permitted groups for the file specified by &%file%&.
21637 The list is in addition to the local user's primary group when
21638 &%check_local_user%& is set. See &%check_group%& above.
21639
21640
21641 .option pipe_transport redirect string&!! unset
21642 .vindex "&$address_pipe$&"
21643 A &(redirect)& router sets up a direct delivery to a pipe when a string
21644 starting with a vertical bar character is specified as a new &"address"&. The
21645 transport used is specified by this option, which, after expansion, must be the
21646 name of a configured transport. This should normally be a &(pipe)& transport.
21647 When the transport is run, the pipe command is in &$address_pipe$&.
21648
21649
21650 .option qualify_domain redirect string&!! unset
21651 .vindex "&$qualify_recipient$&"
21652 If this option is set, and an unqualified address (one without a domain) is
21653 generated, and that address would normally be qualified by the global setting
21654 in &%qualify_recipient%&, it is instead qualified with the domain specified by
21655 expanding this string. If the expansion fails, the router declines. If you want
21656 to revert to the default, you can have the expansion generate
21657 &$qualify_recipient$&.
21658
21659 This option applies to all unqualified addresses generated by Exim filters,
21660 but for traditional &_.forward_& files, it applies only to addresses that are
21661 not preceded by a backslash. Sieve filters cannot generate unqualified
21662 addresses.
21663
21664 .option qualify_preserve_domain redirect boolean false
21665 .cindex "domain" "in redirection; preserving"
21666 .cindex "preserving domain in redirection"
21667 .cindex "address redirection" "domain; preserving"
21668 If this option is set, the router's local &%qualify_domain%& option must not be
21669 set (a configuration error occurs if it is). If an unqualified address (one
21670 without a domain) is generated, it is qualified with the domain of the parent
21671 address (the immediately preceding ancestor) instead of the global
21672 &%qualify_recipient%& value. In the case of a traditional &_.forward_& file,
21673 this applies whether or not the address is preceded by a backslash.
21674
21675
21676 .option repeat_use redirect boolean true
21677 If this option is set false, the router is skipped for a child address that has
21678 any ancestor that was routed by this router. This test happens before any of
21679 the other preconditions are tested. Exim's default anti-looping rules skip
21680 only when the ancestor is the same as the current address. See also
21681 &%check_ancestor%& above and the generic &%redirect_router%& option.
21682
21683
21684 .option reply_transport redirect string&!! unset
21685 A &(redirect)& router sets up an automatic reply when a &%mail%& or
21686 &%vacation%& command is used in a filter file. The transport used is specified
21687 by this option, which, after expansion, must be the name of a configured
21688 transport. This should normally be an &(autoreply)& transport. Other transports
21689 are unlikely to do anything sensible or useful.
21690
21691
21692 .option rewrite redirect boolean true
21693 .cindex "address redirection" "disabling rewriting"
21694 If this option is set false, addresses generated by the router are not
21695 subject to address rewriting. Otherwise, they are treated like new addresses
21696 and are rewritten according to the global rewriting rules.
21697
21698
21699 .option sieve_subaddress redirect string&!! unset
21700 The value of this option is passed to a Sieve filter to specify the
21701 :subaddress part of an address.
21702
21703 .option sieve_useraddress redirect string&!! unset
21704 The value of this option is passed to a Sieve filter to specify the :user part
21705 of an address. However, if it is unset, the entire original local part
21706 (including any prefix or suffix) is used for :user.
21707
21708
21709 .option sieve_vacation_directory redirect string&!! unset
21710 .cindex "Sieve filter" "vacation directory"
21711 To enable the &"vacation"& extension for Sieve filters, you must set
21712 &%sieve_vacation_directory%& to the directory where vacation databases are held
21713 (do not put anything else in that directory), and ensure that the
21714 &%reply_transport%& option refers to an &(autoreply)& transport. Each user
21715 needs their own directory; Exim will create it if necessary.
21716
21717
21718
21719 .option skip_syntax_errors redirect boolean false
21720 .cindex "forward file" "broken"
21721 .cindex "address redirection" "broken files"
21722 .cindex "alias file" "broken"
21723 .cindex "broken alias or forward files"
21724 .cindex "ignoring faulty addresses"
21725 .cindex "skipping faulty addresses"
21726 .cindex "error" "skipping bad syntax"
21727 If &%skip_syntax_errors%& is set, syntactically malformed addresses in
21728 non-filter redirection data are skipped, and each failing address is logged. If
21729 &%syntax_errors_to%& is set, a message is sent to the address it defines,
21730 giving details of the failures. If &%syntax_errors_text%& is set, its contents
21731 are expanded and placed at the head of the error message generated by
21732 &%syntax_errors_to%&. Usually it is appropriate to set &%syntax_errors_to%& to
21733 be the same address as the generic &%errors_to%& option. The
21734 &%skip_syntax_errors%& option is often used when handling mailing lists.
21735
21736 If all the addresses in a redirection list are skipped because of syntax
21737 errors, the router declines to handle the original address, and it is passed to
21738 the following routers.
21739
21740 If &%skip_syntax_errors%& is set when an Exim filter is interpreted, any syntax
21741 error in the filter causes filtering to be abandoned without any action being
21742 taken. The incident is logged, and the router declines to handle the address,
21743 so it is passed to the following routers.
21744
21745 .cindex "Sieve filter" "syntax errors in"
21746 Syntax errors in a Sieve filter file cause the &"keep"& action to occur. This
21747 action is specified by RFC 3028. The values of &%skip_syntax_errors%&,
21748 &%syntax_errors_to%&, and &%syntax_errors_text%& are not used.
21749
21750 &%skip_syntax_errors%& can be used to specify that errors in users' forward
21751 lists or filter files should not prevent delivery. The &%syntax_errors_to%&
21752 option, used with an address that does not get redirected, can be used to
21753 notify users of these errors, by means of a router like this:
21754 .code
21755 userforward:
21756   driver = redirect
21757   allow_filter
21758   check_local_user
21759   file = $home/.forward
21760   file_transport = address_file
21761   pipe_transport = address_pipe
21762   reply_transport = address_reply
21763   no_verify
21764   skip_syntax_errors
21765   syntax_errors_to = real-$local_part@$domain
21766   syntax_errors_text = \
21767    This is an automatically generated message. An error has\n\
21768    been found in your .forward file. Details of the error are\n\
21769    reported below. While this error persists, you will receive\n\
21770    a copy of this message for every message that is addressed\n\
21771    to you. If your .forward file is a filter file, or if it is\n\
21772    a non-filter file containing no valid forwarding addresses,\n\
21773    a copy of each incoming message will be put in your normal\n\
21774    mailbox. If a non-filter file contains at least one valid\n\
21775    forwarding address, forwarding to the valid addresses will\n\
21776    happen, and those will be the only deliveries that occur.
21777 .endd
21778 You also need a router to ensure that local addresses that are prefixed by
21779 &`real-`& are recognized, but not forwarded or filtered. For example, you could
21780 put this immediately before the &(userforward)& router:
21781 .code
21782 real_localuser:
21783   driver = accept
21784   check_local_user
21785   local_part_prefix = real-
21786   transport = local_delivery
21787 .endd
21788 For security, it would probably be a good idea to restrict the use of this
21789 router to locally-generated messages, using a condition such as this:
21790 .code
21791   condition = ${if match {$sender_host_address}\
21792                          {\N^(|127\.0\.0\.1)$\N}}
21793 .endd
21794
21795
21796 .option syntax_errors_text redirect string&!! unset
21797 See &%skip_syntax_errors%& above.
21798
21799
21800 .option syntax_errors_to redirect string unset
21801 See &%skip_syntax_errors%& above.
21802 .ecindex IIDredrou1
21803 .ecindex IIDredrou2
21804
21805
21806
21807
21808
21809
21810 . ////////////////////////////////////////////////////////////////////////////
21811 . ////////////////////////////////////////////////////////////////////////////
21812
21813 .chapter "Environment for running local transports" "CHAPenvironment" &&&
21814          "Environment for local transports"
21815 .scindex IIDenvlotra1 "local transports" "environment for"
21816 .scindex IIDenvlotra2 "environment" "local transports"
21817 .scindex IIDenvlotra3 "transport" "local; environment for"
21818 Local transports handle deliveries to files and pipes. (The &(autoreply)&
21819 transport can be thought of as similar to a pipe.) Exim always runs transports
21820 in subprocesses, under specified uids and gids. Typical deliveries to local
21821 mailboxes run under the uid and gid of the local user.
21822
21823 Exim also sets a specific current directory while running the transport; for
21824 some transports a home directory setting is also relevant. The &(pipe)&
21825 transport is the only one that sets up environment variables; see section
21826 &<<SECTpipeenv>>& for details.
21827
21828 The values used for the uid, gid, and the directories may come from several
21829 different places. In many cases, the router that handles the address associates
21830 settings with that address as a result of its &%check_local_user%&, &%group%&,
21831 or &%user%& options. However, values may also be given in the transport's own
21832 configuration, and these override anything that comes from the router.
21833
21834
21835
21836 .section "Concurrent deliveries" "SECID131"
21837 .cindex "concurrent deliveries"
21838 .cindex "simultaneous deliveries"
21839 If two different messages for the same local recipient arrive more or less
21840 simultaneously, the two delivery processes are likely to run concurrently. When
21841 the &(appendfile)& transport is used to write to a file, Exim applies locking
21842 rules to stop concurrent processes from writing to the same file at the same
21843 time.
21844
21845 However, when you use a &(pipe)& transport, it is up to you to arrange any
21846 locking that is needed. Here is a silly example:
21847 .code
21848 my_transport:
21849   driver = pipe
21850   command = /bin/sh -c 'cat >>/some/file'
21851 .endd
21852 This is supposed to write the message at the end of the file. However, if two
21853 messages arrive at the same time, the file will be scrambled. You can use the
21854 &%exim_lock%& utility program (see section &<<SECTmailboxmaint>>&) to lock a
21855 file using the same algorithm that Exim itself uses.
21856
21857
21858
21859
21860 .section "Uids and gids" "SECTenvuidgid"
21861 .cindex "local transports" "uid and gid"
21862 .cindex "transport" "local; uid and gid"
21863 All transports have the options &%group%& and &%user%&. If &%group%& is set, it
21864 overrides any group that the router set in the address, even if &%user%& is not
21865 set for the transport. This makes it possible, for example, to run local mail
21866 delivery under the uid of the recipient (set by the router), but in a special
21867 group (set by the transport). For example:
21868 .code
21869 # Routers ...
21870 # User/group are set by check_local_user in this router
21871 local_users:
21872   driver = accept
21873   check_local_user
21874   transport = group_delivery
21875
21876 # Transports ...
21877 # This transport overrides the group
21878 group_delivery:
21879   driver = appendfile
21880   file = /var/spool/mail/$local_part_data
21881   group = mail
21882 .endd
21883 If &%user%& is set for a transport, its value overrides what is set in the
21884 address by the router. If &%user%& is non-numeric and &%group%& is not set, the
21885 gid associated with the user is used. If &%user%& is numeric, &%group%& must be
21886 set.
21887
21888 .oindex "&%initgroups%&"
21889 When the uid is taken from the transport's configuration, the &[initgroups()]&
21890 function is called for the groups associated with that uid if the
21891 &%initgroups%& option is set for the transport. When the uid is not specified
21892 by the transport, but is associated with the address by a router, the option
21893 for calling &[initgroups()]& is taken from the router configuration.
21894
21895 .cindex "&(pipe)& transport" "uid for"
21896 The &(pipe)& transport contains the special option &%pipe_as_creator%&. If this
21897 is set and &%user%& is not set, the uid of the process that called Exim to
21898 receive the message is used, and if &%group%& is not set, the corresponding
21899 original gid is also used.
21900
21901 This is the detailed preference order for obtaining a gid; the first of the
21902 following that is set is used:
21903
21904 .ilist
21905 A &%group%& setting of the transport;
21906 .next
21907 A &%group%& setting of the router;
21908 .next
21909 A gid associated with a user setting of the router, either as a result of
21910 &%check_local_user%& or an explicit non-numeric &%user%& setting;
21911 .next
21912 The group associated with a non-numeric &%user%& setting of the transport;
21913 .next
21914 In a &(pipe)& transport, the creator's gid if &%deliver_as_creator%& is set and
21915 the uid is the creator's uid;
21916 .next
21917 The Exim gid if the Exim uid is being used as a default.
21918 .endlist
21919
21920 If, for example, the user is specified numerically on the router and there are
21921 no group settings, no gid is available. In this situation, an error occurs.
21922 This is different for the uid, for which there always is an ultimate default.
21923 The first of the following that is set is used:
21924
21925 .ilist
21926 A &%user%& setting of the transport;
21927 .next
21928 In a &(pipe)& transport, the creator's uid if &%deliver_as_creator%& is set;
21929 .next
21930 A &%user%& setting of the router;
21931 .next
21932 A &%check_local_user%& setting of the router;
21933 .next
21934 The Exim uid.
21935 .endlist
21936
21937 Of course, an error will still occur if the uid that is chosen is on the
21938 &%never_users%& list.
21939
21940
21941
21942
21943
21944 .section "Current and home directories" "SECID132"
21945 .cindex "current directory for local transport"
21946 .cindex "home directory" "for local transport"
21947 .cindex "transport" "local; home directory for"
21948 .cindex "transport" "local; current directory for"
21949 Routers may set current and home directories for local transports by means of
21950 the &%transport_current_directory%& and &%transport_home_directory%& options.
21951 However, if the transport's &%current_directory%& or &%home_directory%& options
21952 are set, they override the router's values. In detail, the home directory
21953 for a local transport is taken from the first of these values that is set:
21954
21955 .ilist
21956 The &%home_directory%& option on the transport;
21957 .next
21958 The &%transport_home_directory%& option on the router;
21959 .next
21960 The password data if &%check_local_user%& is set on the router;
21961 .next
21962 The &%router_home_directory%& option on the router.
21963 .endlist
21964
21965 The current directory is taken from the first of these values that is set:
21966
21967 .ilist
21968 The &%current_directory%& option on the transport;
21969 .next
21970 The &%transport_current_directory%& option on the router.
21971 .endlist
21972
21973
21974 If neither the router nor the transport sets a current directory, Exim uses the
21975 value of the home directory, if it is set. Otherwise it sets the current
21976 directory to &_/_& before running a local transport.
21977
21978
21979
21980 .section "Expansion variables derived from the address" "SECID133"
21981 .vindex "&$domain$&"
21982 .vindex "&$local_part$&"
21983 .vindex "&$original_domain$&"
21984 Normally a local delivery is handling a single address, and in that case the
21985 variables such as &$domain$& and &$local_part$& are set during local
21986 deliveries. However, in some circumstances more than one address may be handled
21987 at once (for example, while writing batch SMTP for onward transmission by some
21988 other means). In this case, the variables associated with the local part are
21989 never set, &$domain$& is set only if all the addresses have the same domain,
21990 and &$original_domain$& is never set.
21991 .ecindex IIDenvlotra1
21992 .ecindex IIDenvlotra2
21993 .ecindex IIDenvlotra3
21994
21995
21996
21997
21998
21999
22000
22001 . ////////////////////////////////////////////////////////////////////////////
22002 . ////////////////////////////////////////////////////////////////////////////
22003
22004 .chapter "Generic options for transports" "CHAPtransportgeneric"
22005 .scindex IIDgenoptra1 "generic options" "transport"
22006 .scindex IIDgenoptra2 "options" "generic; for transports"
22007 .scindex IIDgenoptra3 "transport" "generic options for"
22008 The following generic options apply to all transports:
22009
22010
22011 .option body_only transports boolean false
22012 .cindex "transport" "body only"
22013 .cindex "message" "transporting body only"
22014 .cindex "body of message" "transporting"
22015 If this option is set, the message's headers are not transported. It is
22016 mutually exclusive with &%headers_only%&. If it is used with the &(appendfile)&
22017 or &(pipe)& transports, the settings of &%message_prefix%& and
22018 &%message_suffix%& should be checked, because this option does not
22019 automatically suppress them.
22020
22021
22022 .option current_directory transports string&!! unset
22023 .cindex "transport" "current directory for"
22024 This specifies the current directory that is to be set while running the
22025 transport, overriding any value that may have been set by the router.
22026 If the expansion fails for any reason, including forced failure, an error is
22027 logged, and delivery is deferred.
22028
22029
22030 .option disable_logging transports boolean false
22031 If this option is set true, nothing is logged for any
22032 deliveries by the transport or for any
22033 transport errors. You should not set this option unless you really, really know
22034 what you are doing.
22035
22036
22037 .option debug_print transports string&!! unset
22038 .cindex "testing" "variables in drivers"
22039 If this option is set and debugging is enabled (see the &%-d%& command line
22040 option), the string is expanded and included in the debugging output when the
22041 transport is run.
22042 If expansion of the string fails, the error message is written to the debugging
22043 output, and Exim carries on processing.
22044 This facility is provided to help with checking out the values of variables and
22045 so on when debugging driver configurations. For example, if a &%headers_add%&
22046 option is not working properly, &%debug_print%& could be used to output the
22047 variables it references. A newline is added to the text if it does not end with
22048 one.
22049 The variables &$transport_name$& and &$router_name$& contain the name of the
22050 transport and the router that called it.
22051
22052 .option delivery_date_add transports boolean false
22053 .cindex "&'Delivery-date:'& header line"
22054 If this option is true, a &'Delivery-date:'& header is added to the message.
22055 This gives the actual time the delivery was made. As this is not a standard
22056 header, Exim has a configuration option (&%delivery_date_remove%&) which
22057 requests its removal from incoming messages, so that delivered messages can
22058 safely be resent to other recipients.
22059
22060
22061 .option driver transports string unset
22062 This specifies which of the available transport drivers is to be used.
22063 There is no default, and this option must be set for every transport.
22064
22065
22066 .option envelope_to_add transports boolean false
22067 .cindex "&'Envelope-to:'& header line"
22068 If this option is true, an &'Envelope-to:'& header is added to the message.
22069 This gives the original address(es) in the incoming envelope that caused this
22070 delivery to happen. More than one address may be present if the transport is
22071 configured to handle several addresses at once, or if more than one original
22072 address was redirected to the same final address. As this is not a standard
22073 header, Exim has a configuration option (&%envelope_to_remove%&) which requests
22074 its removal from incoming messages, so that delivered messages can safely be
22075 resent to other recipients.
22076
22077
22078 .option event_action transports string&!! unset
22079 .cindex events
22080 This option declares a string to be expanded for Exim's events mechanism.
22081 For details see chapter &<<CHAPevents>>&.
22082
22083
22084 .option group transports string&!! "Exim group"
22085 .cindex "transport" "group; specifying"
22086 This option specifies a gid for running the transport process, overriding any
22087 value that the router supplies, and also overriding any value associated with
22088 &%user%& (see below).
22089
22090
22091 .option headers_add transports list&!! unset
22092 .cindex "header lines" "adding in transport"
22093 .cindex "transport" "header lines; adding"
22094 This option specifies a list of text headers,
22095 newline-separated (by default, changeable in the usual way &<<SECTlistsepchange>>&),
22096 which are (separately) expanded and added to the header
22097 portion of a message as it is transported, as described in section
22098 &<<SECTheadersaddrem>>&. Additional header lines can also be specified by
22099 routers. If the result of the expansion is an empty string, or if the expansion
22100 is forced to fail, no action is taken. Other expansion failures are treated as
22101 errors and cause the delivery to be deferred.
22102
22103 Unlike most options, &%headers_add%& can be specified multiple times
22104 for a transport; all listed headers are added.
22105
22106
22107 .option headers_only transports boolean false
22108 .cindex "transport" "header lines only"
22109 .cindex "message" "transporting headers only"
22110 .cindex "header lines" "transporting"
22111 If this option is set, the message's body is not transported. It is mutually
22112 exclusive with &%body_only%&. If it is used with the &(appendfile)& or &(pipe)&
22113 transports, the settings of &%message_prefix%& and &%message_suffix%& should be
22114 checked, since this option does not automatically suppress them.
22115
22116
22117 .option headers_remove transports list&!! unset
22118 .cindex "header lines" "removing"
22119 .cindex "transport" "header lines; removing"
22120 This option specifies a list of text headers,
22121 colon-separated (by default, changeable in the usual way &<<SECTlistsepchange>>&),
22122 to be removed from the message.
22123 However, the option has no effect when an address is just being verified.
22124 Each list item is separately expanded.
22125 If the result of the expansion is an empty string, or if the expansion
22126 is forced to fail, no action is taken. Other expansion failures are treated as
22127 errors and cause the delivery to be deferred.
22128 .new
22129 If an item ends in *, it will match any header with the given prefix.
22130 .wen
22131
22132 Matching headers are omitted from the message as it is transported, as described
22133 in section &<<SECTheadersaddrem>>&. Header removal can also be specified by
22134 routers.
22135
22136 Unlike most options, &%headers_remove%& can be specified multiple times
22137 for a transport; all listed headers are removed.
22138
22139 &*Warning*&: Because of the separate expansion of the list items,
22140 items that contain a list separator must have it doubled.
22141 To avoid this, change the list separator (&<<SECTlistsepchange>>&).
22142
22143
22144
22145 .option headers_rewrite transports string unset
22146 .cindex "transport" "header lines; rewriting"
22147 .cindex "rewriting" "at transport time"
22148 This option allows addresses in header lines to be rewritten at transport time,
22149 that is, as the message is being copied to its destination. The contents of the
22150 option are a colon-separated list of rewriting rules. Each rule is in exactly
22151 the same form as one of the general rewriting rules that are applied when a
22152 message is received. These are described in chapter &<<CHAPrewrite>>&. For
22153 example,
22154 .code
22155 headers_rewrite = a@b c@d f : \
22156                   x@y w@z
22157 .endd
22158 changes &'a@b'& into &'c@d'& in &'From:'& header lines, and &'x@y'& into
22159 &'w@z'& in all address-bearing header lines. The rules are applied to the
22160 header lines just before they are written out at transport time, so they affect
22161 only those copies of the message that pass through the transport. However, only
22162 the message's original header lines, and any that were added by a system
22163 filter, are rewritten. If a router or transport adds header lines, they are not
22164 affected by this option. These rewriting rules are &'not'& applied to the
22165 envelope. You can change the return path using &%return_path%&, but you cannot
22166 change envelope recipients at this time.
22167
22168
22169 .option home_directory transports string&!! unset
22170 .cindex "transport" "home directory for"
22171 .vindex "&$home$&"
22172 This option specifies a home directory setting for a local transport,
22173 overriding any value that may be set by the router. The home directory is
22174 placed in &$home$& while expanding the transport's private options. It is also
22175 used as the current directory if no current directory is set by the
22176 &%current_directory%& option on the transport or the
22177 &%transport_current_directory%& option on the router. If the expansion fails
22178 for any reason, including forced failure, an error is logged, and delivery is
22179 deferred.
22180
22181
22182 .option initgroups transports boolean false
22183 .cindex "additional groups"
22184 .cindex "groups" "additional"
22185 .cindex "transport" "group; additional"
22186 If this option is true and the uid for the delivery process is provided by the
22187 transport, the &[initgroups()]& function is called when running the transport
22188 to ensure that any additional groups associated with the uid are set up.
22189
22190
22191 .option max_parallel transports integer&!! unset
22192 .cindex limit "transport parallelism"
22193 .cindex transport "parallel processes"
22194 .cindex transport "concurrency limit"
22195 .cindex "delivery" "parallelism for transport"
22196 If this option is set and expands to an integer greater than zero
22197 it limits the number of concurrent runs of the transport.
22198 The control does not apply to shadow transports.
22199
22200 .cindex "hints database" "transport concurrency control"
22201 Exim implements this control by means of a hints database in which a record is
22202 incremented whenever a transport process is being created. The record
22203 is decremented and possibly removed when the process terminates.
22204 Obviously there is scope for
22205 records to get left lying around if there is a system or program crash. To
22206 guard against this, Exim ignores any records that are more than six hours old.
22207
22208 If you use this option, you should also arrange to delete the
22209 relevant hints database whenever your system reboots. The names of the files
22210 start with &_misc_& and they are kept in the &_spool/db_& directory. There
22211 may be one or two files, depending on the type of DBM in use. The same files
22212 are used for ETRN and smtp transport serialization.
22213
22214
22215 .option message_size_limit transports string&!! 0
22216 .cindex "limit" "message size per transport"
22217 .cindex "size" "of message, limit"
22218 .cindex "transport" "message size; limiting"
22219 This option controls the size of messages passed through the transport. It is
22220 expanded before use; the result of the expansion must be a sequence of decimal
22221 digits, optionally followed by K or M. If the expansion fails for any reason,
22222 including forced failure, or if the result is not of the required form,
22223 delivery is deferred. If the value is greater than zero and the size of a
22224 message exceeds this limit, the address is failed. If there is any chance that
22225 the resulting bounce message could be routed to the same transport, you should
22226 ensure that &%return_size_limit%& is less than the transport's
22227 &%message_size_limit%&, as otherwise the bounce message will fail to get
22228 delivered.
22229
22230
22231
22232 .option rcpt_include_affixes transports boolean false
22233 .cindex "prefix" "for local part, including in envelope"
22234 .cindex "suffix for local part" "including in envelope"
22235 .cindex "local part" "prefix"
22236 .cindex "local part" "suffix"
22237 When this option is false (the default), and an address that has had any
22238 affixes (prefixes or suffixes) removed from the local part is delivered by any
22239 form of SMTP or LMTP, the affixes are not included. For example, if a router
22240 that contains
22241 .code
22242 local_part_prefix = *-
22243 .endd
22244 routes the address &'abc-xyz@some.domain'& to an SMTP transport, the envelope
22245 is delivered with
22246 .code
22247 RCPT TO:<xyz@some.domain>
22248 .endd
22249 This is also the case when an ACL-time callout is being used to verify a
22250 recipient address. However, if &%rcpt_include_affixes%& is set true, the
22251 whole local part is included in the RCPT command. This option applies to BSMTP
22252 deliveries by the &(appendfile)& and &(pipe)& transports as well as to the
22253 &(lmtp)& and &(smtp)& transports.
22254
22255
22256 .option retry_use_local_part transports boolean "see below"
22257 .cindex "hints database" "retry keys"
22258 When a delivery suffers a temporary failure, a retry record is created
22259 in Exim's hints database. For remote deliveries, the key for the retry record
22260 is based on the name and/or IP address of the failing remote host. For local
22261 deliveries, the key is normally the entire address, including both the local
22262 part and the domain. This is suitable for most common cases of local delivery
22263 temporary failure &-- for example, exceeding a mailbox quota should delay only
22264 deliveries to that mailbox, not to the whole domain.
22265
22266 However, in some special cases you may want to treat a temporary local delivery
22267 as a failure associated with the domain, and not with a particular local part.
22268 (For example, if you are storing all mail for some domain in files.) You can do
22269 this by setting &%retry_use_local_part%& false.
22270
22271 For all the local transports, its default value is true. For remote transports,
22272 the default value is false for tidiness, but changing the value has no effect
22273 on a remote transport in the current implementation.
22274
22275
22276 .option return_path transports string&!! unset
22277 .cindex "envelope sender"
22278 .cindex "envelope from"
22279 .cindex "transport" "return path; changing"
22280 .cindex "return path" "changing in transport"
22281 If this option is set, the string is expanded at transport time and replaces
22282 the existing return path (envelope sender) value in the copy of the message
22283 that is being delivered. An empty return path is permitted. This feature is
22284 designed for remote deliveries, where the value of this option is used in the
22285 SMTP MAIL command. If you set &%return_path%& for a local transport, the
22286 only effect is to change the address that is placed in the &'Return-path:'&
22287 header line, if one is added to the message (see the next option).
22288
22289 &*Note:*& A changed return path is not logged unless you add
22290 &%return_path_on_delivery%& to the log selector.
22291
22292 .vindex "&$return_path$&"
22293 The expansion can refer to the existing value via &$return_path$&. This is
22294 either the message's envelope sender, or an address set by the
22295 &%errors_to%& option on a router. If the expansion is forced to fail, no
22296 replacement occurs; if it fails for another reason, delivery is deferred. This
22297 option can be used to support VERP (Variable Envelope Return Paths) &-- see
22298 section &<<SECTverp>>&.
22299
22300 &*Note*&: If a delivery error is detected locally, including the case when a
22301 remote server rejects a message at SMTP time, the bounce message is not sent to
22302 the value of this option. It is sent to the previously set errors address.
22303 This defaults to the incoming sender address, but can be changed by setting
22304 &%errors_to%& in a router.
22305
22306
22307
22308 .option return_path_add transports boolean false
22309 .cindex "&'Return-path:'& header line"
22310 If this option is true, a &'Return-path:'& header is added to the message.
22311 Although the return path is normally available in the prefix line of BSD
22312 mailboxes, this is commonly not displayed by MUAs, and so the user does not
22313 have easy access to it.
22314
22315 RFC 2821 states that the &'Return-path:'& header is added to a message &"when
22316 the delivery SMTP server makes the final delivery"&. This implies that this
22317 header should not be present in incoming messages. Exim has a configuration
22318 option, &%return_path_remove%&, which requests removal of this header from
22319 incoming messages, so that delivered messages can safely be resent to other
22320 recipients.
22321
22322
22323 .option shadow_condition transports string&!! unset
22324 See &%shadow_transport%& below.
22325
22326
22327 .option shadow_transport transports string unset
22328 .cindex "shadow transport"
22329 .cindex "transport" "shadow"
22330 A local transport may set the &%shadow_transport%& option to the name of
22331 another local transport. Shadow remote transports are not supported.
22332
22333 Whenever a delivery to the main transport succeeds, and either
22334 &%shadow_condition%& is unset, or its expansion does not result in the empty
22335 string or one of the strings &"0"& or &"no"& or &"false"&, the message is also
22336 passed to the shadow transport, with the same delivery address or addresses. If
22337 expansion fails, no action is taken except that non-forced expansion failures
22338 cause a log line to be written.
22339
22340 The result of the shadow transport is discarded and does not affect the
22341 subsequent processing of the message. Only a single level of shadowing is
22342 provided; the &%shadow_transport%& option is ignored on any transport when it
22343 is running as a shadow. Options concerned with output from pipes are also
22344 ignored. The log line for the successful delivery has an item added on the end,
22345 of the form
22346 .code
22347 ST=<shadow transport name>
22348 .endd
22349 If the shadow transport did not succeed, the error message is put in
22350 parentheses afterwards. Shadow transports can be used for a number of different
22351 purposes, including keeping more detailed log information than Exim normally
22352 provides, and implementing automatic acknowledgment policies based on message
22353 headers that some sites insist on.
22354
22355
22356 .option transport_filter transports string&!! unset
22357 .cindex "transport" "filter"
22358 .cindex "filter" "transport filter"
22359 This option sets up a filtering (in the Unix shell sense) process for messages
22360 at transport time. It should not be confused with mail filtering as set up by
22361 individual users or via a system filter.
22362 If unset, or expanding to an empty string, no filtering is done.
22363
22364 When the message is about to be written out, the command specified by
22365 &%transport_filter%& is started up in a separate, parallel process, and
22366 the entire message, including the header lines, is passed to it on its standard
22367 input (this in fact is done from a third process, to avoid deadlock). The
22368 command must be specified as an absolute path.
22369
22370 The lines of the message that are written to the transport filter are
22371 terminated by newline (&"\n"&). The message is passed to the filter before any
22372 SMTP-specific processing, such as turning &"\n"& into &"\r\n"& and escaping
22373 lines beginning with a dot, and also before any processing implied by the
22374 settings of &%check_string%& and &%escape_string%& in the &(appendfile)& or
22375 &(pipe)& transports.
22376
22377 The standard error for the filter process is set to the same destination as its
22378 standard output; this is read and written to the message's ultimate
22379 destination. The process that writes the message to the filter, the
22380 filter itself, and the original process that reads the result and delivers it
22381 are all run in parallel, like a shell pipeline.
22382
22383 The filter can perform any transformations it likes, but of course should take
22384 care not to break RFC 2822 syntax. Exim does not check the result, except to
22385 test for a final newline when SMTP is in use. All messages transmitted over
22386 SMTP must end with a newline, so Exim supplies one if it is missing.
22387
22388 .cindex "content scanning" "per user"
22389 A transport filter can be used to provide content-scanning on a per-user basis
22390 at delivery time if the only required effect of the scan is to modify the
22391 message. For example, a content scan could insert a new header line containing
22392 a spam score. This could be interpreted by a filter in the user's MUA. It is
22393 not possible to discard a message at this stage.
22394
22395 .cindex "SMTP" "SIZE"
22396 A problem might arise if the filter increases the size of a message that is
22397 being sent down an SMTP connection. If the receiving SMTP server has indicated
22398 support for the SIZE parameter, Exim will have sent the size of the message
22399 at the start of the SMTP session. If what is actually sent is substantially
22400 more, the server might reject the message. This can be worked round by setting
22401 the &%size_addition%& option on the &(smtp)& transport, either to allow for
22402 additions to the message, or to disable the use of SIZE altogether.
22403
22404 .vindex "&$pipe_addresses$&"
22405 The value of the &%transport_filter%& option is the command string for starting
22406 the filter, which is run directly from Exim, not under a shell. The string is
22407 parsed by Exim in the same way as a command string for the &(pipe)& transport:
22408 Exim breaks it up into arguments and then expands each argument separately (see
22409 section &<<SECThowcommandrun>>&). Any kind of expansion failure causes delivery
22410 to be deferred. The special argument &$pipe_addresses$& is replaced by a number
22411 of arguments, one for each address that applies to this delivery. (This isn't
22412 an ideal name for this feature here, but as it was already implemented for the
22413 &(pipe)& transport, it seemed sensible not to change it.)
22414
22415 .vindex "&$host$&"
22416 .vindex "&$host_address$&"
22417 The expansion variables &$host$& and &$host_address$& are available when the
22418 transport is a remote one. They contain the name and IP address of the host to
22419 which the message is being sent. For example:
22420 .code
22421 transport_filter = /some/directory/transport-filter.pl \
22422   $host $host_address $sender_address $pipe_addresses
22423 .endd
22424
22425 Two problems arise if you want to use more complicated expansion items to
22426 generate transport filter commands, both of which due to the fact that the
22427 command is split up &'before'& expansion.
22428 .ilist
22429 If an expansion item contains white space, you must quote it, so that it is all
22430 part of the same command item. If the entire option setting is one such
22431 expansion item, you have to take care what kind of quoting you use. For
22432 example:
22433 .code
22434 transport_filter = '/bin/cmd${if eq{$host}{a.b.c}{1}{2}}'
22435 .endd
22436 This runs the command &(/bin/cmd1)& if the host name is &'a.b.c'&, and
22437 &(/bin/cmd2)& otherwise. If double quotes had been used, they would have been
22438 stripped by Exim when it read the option's value. When the value is used, if
22439 the single quotes were missing, the line would be split into two items,
22440 &`/bin/cmd${if`& and &`eq{$host}{a.b.c}{1}{2}`&, and an error would occur when
22441 Exim tried to expand the first one.
22442 .next
22443 Except for the special case of &$pipe_addresses$& that is mentioned above, an
22444 expansion cannot generate multiple arguments, or a command name followed by
22445 arguments. Consider this example:
22446 .code
22447 transport_filter = ${lookup{$host}lsearch{/a/file}\
22448                     {$value}{/bin/cat}}
22449 .endd
22450 The result of the lookup is interpreted as the name of the command, even
22451 if it contains white space. The simplest way round this is to use a shell:
22452 .code
22453 transport_filter = /bin/sh -c ${lookup{$host}lsearch{/a/file}\
22454                                {$value}{/bin/cat}}
22455 .endd
22456 .endlist
22457
22458 The filter process is run under the same uid and gid as the normal delivery.
22459 For remote deliveries this is the Exim uid/gid by default. The command should
22460 normally yield a zero return code. Transport filters are not supposed to fail.
22461 A non-zero code is taken to mean that the transport filter encountered some
22462 serious problem. Delivery of the message is deferred; the message remains on
22463 the queue and is tried again later. It is not possible to cause a message to be
22464 bounced from a transport filter.
22465
22466 If a transport filter is set on an autoreply transport, the original message is
22467 passed through the filter as it is being copied into the newly generated
22468 message, which happens if the &%return_message%& option is set.
22469
22470
22471 .option transport_filter_timeout transports time 5m
22472 .cindex "transport" "filter, timeout"
22473 When Exim is reading the output of a transport filter, it applies a timeout
22474 that can be set by this option. Exceeding the timeout is normally treated as a
22475 temporary delivery failure. However, if a transport filter is used with a
22476 &(pipe)& transport, a timeout in the transport filter is treated in the same
22477 way as a timeout in the pipe command itself. By default, a timeout is a hard
22478 error, but if the &(pipe)& transport's &%timeout_defer%& option is set true, it
22479 becomes a temporary error.
22480
22481
22482 .option user transports string&!! "Exim user"
22483 .cindex "uid (user id)" "local delivery"
22484 .cindex "transport" "user, specifying"
22485 This option specifies the user under whose uid the delivery process is to be
22486 run, overriding any uid that may have been set by the router. If the user is
22487 given as a name, the uid is looked up from the password data, and the
22488 associated group is taken as the value of the gid to be used if the &%group%&
22489 option is not set.
22490
22491 For deliveries that use local transports, a user and group are normally
22492 specified explicitly or implicitly (for example, as a result of
22493 &%check_local_user%&) by the router or transport.
22494
22495 .cindex "hints database" "access by remote transport"
22496 For remote transports, you should leave this option unset unless you really are
22497 sure you know what you are doing. When a remote transport is running, it needs
22498 to be able to access Exim's hints databases, because each host may have its own
22499 retry data.
22500 .ecindex IIDgenoptra1
22501 .ecindex IIDgenoptra2
22502 .ecindex IIDgenoptra3
22503
22504
22505
22506
22507
22508
22509 . ////////////////////////////////////////////////////////////////////////////
22510 . ////////////////////////////////////////////////////////////////////////////
22511
22512 .chapter "Address batching in local transports" "CHAPbatching" &&&
22513          "Address batching"
22514 .cindex "transport" "local; address batching in"
22515 The only remote transport (&(smtp)&) is normally configured to handle more than
22516 one address at a time, so that when several addresses are routed to the same
22517 remote host, just one copy of the message is sent. Local transports, however,
22518 normally handle one address at a time. That is, a separate instance of the
22519 transport is run for each address that is routed to the transport. A separate
22520 copy of the message is delivered each time.
22521
22522 .cindex "batched local delivery"
22523 .oindex "&%batch_max%&"
22524 .oindex "&%batch_id%&"
22525 In special cases, it may be desirable to handle several addresses at once in a
22526 local transport, for example:
22527
22528 .ilist
22529 In an &(appendfile)& transport, when storing messages in files for later
22530 delivery by some other means, a single copy of the message with multiple
22531 recipients saves space.
22532 .next
22533 In an &(lmtp)& transport, when delivering over &"local SMTP"& to some process,
22534 a single copy saves time, and is the normal way LMTP is expected to work.
22535 .next
22536 In a &(pipe)& transport, when passing the message
22537 to a scanner program or
22538 to some other delivery mechanism such as UUCP, multiple recipients may be
22539 acceptable.
22540 .endlist
22541
22542 These three local transports all have the same options for controlling multiple
22543 (&"batched"&) deliveries, namely &%batch_max%& and &%batch_id%&. To save
22544 repeating the information for each transport, these options are described here.
22545
22546 The &%batch_max%& option specifies the maximum number of addresses that can be
22547 delivered together in a single run of the transport. Its default value is one
22548 (no batching). When more than one address is routed to a transport that has a
22549 &%batch_max%& value greater than one, the addresses are delivered in a batch
22550 (that is, in a single run of the transport with multiple recipients), subject
22551 to certain conditions:
22552
22553 .ilist
22554 .vindex "&$local_part$&"
22555 If any of the transport's options contain a reference to &$local_part$&, no
22556 batching is possible.
22557 .next
22558 .vindex "&$domain$&"
22559 If any of the transport's options contain a reference to &$domain$&, only
22560 addresses with the same domain are batched.
22561 .next
22562 .cindex "customizing" "batching condition"
22563 If &%batch_id%& is set, it is expanded for each address, and only those
22564 addresses with the same expanded value are batched. This allows you to specify
22565 customized batching conditions. Failure of the expansion for any reason,
22566 including forced failure, disables batching, but it does not stop the delivery
22567 from taking place.
22568 .next
22569 Batched addresses must also have the same errors address (where to send
22570 delivery errors), the same header additions and removals, the same user and
22571 group for the transport, and if a host list is present, the first host must
22572 be the same.
22573 .endlist
22574
22575 In the case of the &(appendfile)& and &(pipe)& transports, batching applies
22576 both when the file or pipe command is specified in the transport, and when it
22577 is specified by a &(redirect)& router, but all the batched addresses must of
22578 course be routed to the same file or pipe command. These two transports have an
22579 option called &%use_bsmtp%&, which causes them to deliver the message in
22580 &"batched SMTP"& format, with the envelope represented as SMTP commands. The
22581 &%check_string%& and &%escape_string%& options are forced to the values
22582 .code
22583 check_string = "."
22584 escape_string = ".."
22585 .endd
22586 when batched SMTP is in use. A full description of the batch SMTP mechanism is
22587 given in section &<<SECTbatchSMTP>>&. The &(lmtp)& transport does not have a
22588 &%use_bsmtp%& option, because it always delivers using the SMTP protocol.
22589
22590 .cindex "&'Envelope-to:'& header line"
22591 If the generic &%envelope_to_add%& option is set for a batching transport, the
22592 &'Envelope-to:'& header that is added to the message contains all the addresses
22593 that are being processed together. If you are using a batching &(appendfile)&
22594 transport without &%use_bsmtp%&, the only way to preserve the recipient
22595 addresses is to set the &%envelope_to_add%& option.
22596
22597 .cindex "&(pipe)& transport" "with multiple addresses"
22598 .vindex "&$pipe_addresses$&"
22599 If you are using a &(pipe)& transport without BSMTP, and setting the
22600 transport's &%command%& option, you can include &$pipe_addresses$& as part of
22601 the command. This is not a true variable; it is a bit of magic that causes each
22602 of the recipient addresses to be inserted into the command as a separate
22603 argument. This provides a way of accessing all the addresses that are being
22604 delivered in the batch. &*Note:*& This is not possible for pipe commands that
22605 are specified by a &(redirect)& router.
22606
22607
22608
22609
22610 . ////////////////////////////////////////////////////////////////////////////
22611 . ////////////////////////////////////////////////////////////////////////////
22612
22613 .chapter "The appendfile transport" "CHAPappendfile"
22614 .scindex IIDapptra1 "&(appendfile)& transport"
22615 .scindex IIDapptra2 "transports" "&(appendfile)&"
22616 .cindex "directory creation"
22617 .cindex "creating directories"
22618 The &(appendfile)& transport delivers a message by appending it to an existing
22619 file, or by creating an entirely new file in a specified directory. Single
22620 files to which messages are appended can be in the traditional Unix mailbox
22621 format, or optionally in the MBX format supported by the Pine MUA and
22622 University of Washington IMAP daemon, &'inter alia'&. When each message is
22623 being delivered as a separate file, &"maildir"& format can optionally be used
22624 to give added protection against failures that happen part-way through the
22625 delivery. A third form of separate-file delivery known as &"mailstore"& is also
22626 supported. For all file formats, Exim attempts to create as many levels of
22627 directory as necessary, provided that &%create_directory%& is set.
22628
22629 The code for the optional formats is not included in the Exim binary by
22630 default. It is necessary to set SUPPORT_MBX, SUPPORT_MAILDIR and/or
22631 SUPPORT_MAILSTORE in &_Local/Makefile_& to have the appropriate code
22632 included.
22633
22634 .cindex "quota" "system"
22635 Exim recognizes system quota errors, and generates an appropriate message. Exim
22636 also supports its own quota control within the transport, for use when the
22637 system facility is unavailable or cannot be used for some reason.
22638
22639 If there is an error while appending to a file (for example, quota exceeded or
22640 partition filled), Exim attempts to reset the file's length and last
22641 modification time back to what they were before. If there is an error while
22642 creating an entirely new file, the new file is removed.
22643
22644 Before appending to a file, a number of security checks are made, and the
22645 file is locked. A detailed description is given below, after the list of
22646 private options.
22647
22648 The &(appendfile)& transport is most commonly used for local deliveries to
22649 users' mailboxes. However, it can also be used as a pseudo-remote transport for
22650 putting messages into files for remote delivery by some means other than Exim.
22651 &"Batch SMTP"& format is often used in this case (see the &%use_bsmtp%&
22652 option).
22653
22654
22655
22656 .section "The file and directory options" "SECTfildiropt"
22657 The &%file%& option specifies a single file, to which the message is appended;
22658 the &%directory%& option specifies a directory, in which a new file containing
22659 the message is created. Only one of these two options can be set, and for
22660 normal deliveries to mailboxes, one of them &'must'& be set.
22661
22662 .vindex "&$address_file$&"
22663 .vindex "&$local_part$&"
22664 However, &(appendfile)& is also used for delivering messages to files or
22665 directories whose names (or parts of names) are obtained from alias,
22666 forwarding, or filtering operations (for example, a &%save%& command in a
22667 user's Exim filter). When such a transport is running, &$local_part$& contains
22668 the local part that was aliased or forwarded, and &$address_file$& contains the
22669 name (or partial name) of the file or directory generated by the redirection
22670 operation. There are two cases:
22671
22672 .ilist
22673 If neither &%file%& nor &%directory%& is set, the redirection operation
22674 must specify an absolute path (one that begins with &`/`&). This is the most
22675 common case when users with local accounts use filtering to sort mail into
22676 different folders. See for example, the &(address_file)& transport in the
22677 default configuration. If the path ends with a slash, it is assumed to be the
22678 name of a directory. A delivery to a directory can also be forced by setting
22679 &%maildir_format%& or &%mailstore_format%&.
22680 .next
22681 If &%file%& or &%directory%& is set for a delivery from a redirection, it is
22682 used to determine the file or directory name for the delivery. Normally, the
22683 contents of &$address_file$& are used in some way in the string expansion.
22684 .endlist
22685 .new
22686 .cindex "tainted data" "in filenames"
22687 .cindex appendfile "tainted data"
22688 Tainted data may not be used for a file or directory name.
22689 This means that, for instance, &$local_part$& cannot be used directly
22690 as a component of a path.  It can however be used as the key for a lookup
22691 which returns a path (or component).
22692 .wen
22693
22694
22695 .cindex "Sieve filter" "configuring &(appendfile)&"
22696 .cindex "Sieve filter" "relative mailbox path handling"
22697 As an example of the second case, consider an environment where users do not
22698 have home directories. They may be permitted to use Exim filter commands of the
22699 form:
22700 .code
22701 save folder23
22702 .endd
22703 or Sieve filter commands of the form:
22704 .code
22705 require "fileinto";
22706 fileinto "folder23";
22707 .endd
22708 In this situation, the expansion of &%file%& or &%directory%& in the transport
22709 must transform the relative path into an appropriate absolute filename. In the
22710 case of Sieve filters, the name &'inbox'& must be handled. It is the name that
22711 is used as a result of a &"keep"& action in the filter. This example shows one
22712 way of handling this requirement:
22713 .code
22714 file = ${if eq{$address_file}{inbox} \
22715             {/var/mail/$local_part_data} \
22716             {${if eq{${substr_0_1:$address_file}}{/} \
22717                   {$address_file} \
22718                   {$home/mail/$address_file} \
22719             }} \
22720        }
22721 .endd
22722 With this setting of &%file%&, &'inbox'& refers to the standard mailbox
22723 location, absolute paths are used without change, and other folders are in the
22724 &_mail_& directory within the home directory.
22725
22726 &*Note 1*&: While processing an Exim filter, a relative path such as
22727 &_folder23_& is turned into an absolute path if a home directory is known to
22728 the router. In particular, this is the case if &%check_local_user%& is set. If
22729 you want to prevent this happening at routing time, you can set
22730 &%router_home_directory%& empty. This forces the router to pass the relative
22731 path to the transport.
22732
22733 &*Note 2*&: An absolute path in &$address_file$& is not treated specially;
22734 the &%file%& or &%directory%& option is still used if it is set.
22735
22736
22737
22738
22739 .section "Private options for appendfile" "SECID134"
22740 .cindex "options" "&(appendfile)& transport"
22741
22742
22743
22744 .option allow_fifo appendfile boolean false
22745 .cindex "fifo (named pipe)"
22746 .cindex "named pipe (fifo)"
22747 .cindex "pipe" "named (fifo)"
22748 Setting this option permits delivery to named pipes (FIFOs) as well as to
22749 regular files. If no process is reading the named pipe at delivery time, the
22750 delivery is deferred.
22751
22752
22753 .option allow_symlink appendfile boolean false
22754 .cindex "symbolic link" "to mailbox"
22755 .cindex "mailbox" "symbolic link"
22756 By default, &(appendfile)& will not deliver if the path name for the file is
22757 that of a symbolic link. Setting this option relaxes that constraint, but there
22758 are security issues involved in the use of symbolic links. Be sure you know
22759 what you are doing if you set this. Details of exactly what this option affects
22760 are included in the discussion which follows this list of options.
22761
22762
22763 .option batch_id appendfile string&!! unset
22764 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
22765 However, batching is automatically disabled for &(appendfile)& deliveries that
22766 happen as a result of forwarding or aliasing or other redirection directly to a
22767 file.
22768
22769
22770 .option batch_max appendfile integer 1
22771 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
22772
22773
22774 .option check_group appendfile boolean false
22775 When this option is set, the group owner of the file defined by the &%file%&
22776 option is checked to see that it is the same as the group under which the
22777 delivery process is running. The default setting is false because the default
22778 file mode is 0600, which means that the group is irrelevant.
22779
22780
22781 .option check_owner appendfile boolean true
22782 When this option is set, the owner of the file defined by the &%file%& option
22783 is checked to ensure that it is the same as the user under which the delivery
22784 process is running.
22785
22786
22787 .option check_string appendfile string "see below"
22788 .cindex "&""From""& line"
22789 As &(appendfile)& writes the message, the start of each line is tested for
22790 matching &%check_string%&, and if it does, the initial matching characters are
22791 replaced by the contents of &%escape_string%&. The value of &%check_string%& is
22792 a literal string, not a regular expression, and the case of any letters it
22793 contains is significant.
22794
22795 If &%use_bsmtp%& is set the values of &%check_string%& and &%escape_string%&
22796 are forced to &"."& and &".."& respectively, and any settings in the
22797 configuration are ignored. Otherwise, they default to &"From&~"& and
22798 &">From&~"& when the &%file%& option is set, and unset when any of the
22799 &%directory%&, &%maildir%&, or &%mailstore%& options are set.
22800
22801 The default settings, along with &%message_prefix%& and &%message_suffix%&, are
22802 suitable for traditional &"BSD"& mailboxes, where a line beginning with
22803 &"From&~"& indicates the start of a new message. All four options need changing
22804 if another format is used. For example, to deliver to mailboxes in MMDF format:
22805 .cindex "MMDF format mailbox"
22806 .cindex "mailbox" "MMDF format"
22807 .code
22808 check_string = "\1\1\1\1\n"
22809 escape_string = "\1\1\1\1 \n"
22810 message_prefix = "\1\1\1\1\n"
22811 message_suffix = "\1\1\1\1\n"
22812 .endd
22813 .option create_directory appendfile boolean true
22814 .cindex "directory creation"
22815 When this option is true, Exim attempts to create any missing superior
22816 directories for the file that it is about to write. A created directory's mode
22817 is given by the &%directory_mode%& option.
22818
22819 The group ownership of a newly created directory is highly dependent on the
22820 operating system (and possibly the file system) that is being used. For
22821 example, in Solaris, if the parent directory has the setgid bit set, its group
22822 is propagated to the child; if not, the currently set group is used. However,
22823 in FreeBSD, the parent's group is always used.
22824
22825
22826
22827 .option create_file appendfile string anywhere
22828 This option constrains the location of files and directories that are created
22829 by this transport. It applies to files defined by the &%file%& option and
22830 directories defined by the &%directory%& option. In the case of maildir
22831 delivery, it applies to the top level directory, not the maildir directories
22832 beneath.
22833
22834 The option must be set to one of the words &"anywhere"&, &"inhome"&, or
22835 &"belowhome"&. In the second and third cases, a home directory must have been
22836 set for the transport. This option is not useful when an explicit filename is
22837 given for normal mailbox deliveries. It is intended for the case when filenames
22838 are generated from users' &_.forward_& files. These are usually handled
22839 by an &(appendfile)& transport called &%address_file%&. See also
22840 &%file_must_exist%&.
22841
22842
22843 .option directory appendfile string&!! unset
22844 This option is mutually exclusive with the &%file%& option, but one of &%file%&
22845 or &%directory%& must be set, unless the delivery is the direct result of a
22846 redirection (see section &<<SECTfildiropt>>&).
22847
22848 When &%directory%& is set, the string is expanded, and the message is delivered
22849 into a new file or files in or below the given directory, instead of being
22850 appended to a single mailbox file. A number of different formats are provided
22851 (see &%maildir_format%& and &%mailstore_format%&), and see section
22852 &<<SECTopdir>>& for further details of this form of delivery.
22853
22854
22855 .option directory_file appendfile string&!! "see below"
22856 .cindex "base62"
22857 .vindex "&$inode$&"
22858 When &%directory%& is set, but neither &%maildir_format%& nor
22859 &%mailstore_format%& is set, &(appendfile)& delivers each message into a file
22860 whose name is obtained by expanding this string. The default value is:
22861 .code
22862 q${base62:$tod_epoch}-$inode
22863 .endd
22864 This generates a unique name from the current time, in base 62 form, and the
22865 inode of the file. The variable &$inode$& is available only when expanding this
22866 option.
22867
22868
22869 .option directory_mode appendfile "octal integer" 0700
22870 If &(appendfile)& creates any directories as a result of the
22871 &%create_directory%& option, their mode is specified by this option.
22872
22873
22874 .option escape_string appendfile string "see description"
22875 See &%check_string%& above.
22876
22877
22878 .option file appendfile string&!! unset
22879 This option is mutually exclusive with the &%directory%& option, but one of
22880 &%file%& or &%directory%& must be set, unless the delivery is the direct result
22881 of a redirection (see section &<<SECTfildiropt>>&). The &%file%& option
22882 specifies a single file, to which the message is appended. One or more of
22883 &%use_fcntl_lock%&, &%use_flock_lock%&, or &%use_lockfile%& must be set with
22884 &%file%&.
22885
22886 .cindex "NFS" "lock file"
22887 .cindex "locking files"
22888 .cindex "lock files"
22889 If you are using more than one host to deliver over NFS into the same
22890 mailboxes, you should always use lock files.
22891
22892 The string value is expanded for each delivery, and must yield an absolute
22893 path. The most common settings of this option are variations on one of these
22894 examples:
22895 .code
22896 file = /var/spool/mail/$local_part_data
22897 file = /home/$local_part_data/inbox
22898 file = $home/inbox
22899 .endd
22900 .cindex "&""sticky""& bit"
22901 In the first example, all deliveries are done into the same directory. If Exim
22902 is configured to use lock files (see &%use_lockfile%& below) it must be able to
22903 create a file in the directory, so the &"sticky"& bit must be turned on for
22904 deliveries to be possible, or alternatively the &%group%& option can be used to
22905 run the delivery under a group id which has write access to the directory.
22906
22907
22908
22909 .option file_format appendfile string unset
22910 .cindex "file" "mailbox; checking existing format"
22911 This option requests the transport to check the format of an existing file
22912 before adding to it. The check consists of matching a specific string at the
22913 start of the file. The value of the option consists of an even number of
22914 colon-separated strings. The first of each pair is the test string, and the
22915 second is the name of a transport. If the transport associated with a matched
22916 string is not the current transport, control is passed over to the other
22917 transport. For example, suppose the standard &(local_delivery)& transport has
22918 this added to it:
22919 .code
22920 file_format = "From       : local_delivery :\
22921                \1\1\1\1\n : local_mmdf_delivery"
22922 .endd
22923 Mailboxes that begin with &"From"& are still handled by this transport, but if
22924 a mailbox begins with four binary ones followed by a newline, control is passed
22925 to a transport called &%local_mmdf_delivery%&, which presumably is configured
22926 to do the delivery in MMDF format. If a mailbox does not exist or is empty, it
22927 is assumed to match the current transport. If the start of a mailbox doesn't
22928 match any string, or if the transport named for a given string is not defined,
22929 delivery is deferred.
22930
22931
22932 .option file_must_exist appendfile boolean false
22933 If this option is true, the file specified by the &%file%& option must exist.
22934 A temporary error occurs if it does not, causing delivery to be deferred.
22935 If this option is false, the file is created if it does not exist.
22936
22937
22938 .option lock_fcntl_timeout appendfile time 0s
22939 .cindex "timeout" "mailbox locking"
22940 .cindex "mailbox" "locking, blocking and non-blocking"
22941 .cindex "locking files"
22942 By default, the &(appendfile)& transport uses non-blocking calls to &[fcntl()]&
22943 when locking an open mailbox file. If the call fails, the delivery process
22944 sleeps for &%lock_interval%& and tries again, up to &%lock_retries%& times.
22945 Non-blocking calls are used so that the file is not kept open during the wait
22946 for the lock; the reason for this is to make it as safe as possible for
22947 deliveries over NFS in the case when processes might be accessing an NFS
22948 mailbox without using a lock file. This should not be done, but
22949 misunderstandings and hence misconfigurations are not unknown.
22950
22951 On a busy system, however, the performance of a non-blocking lock approach is
22952 not as good as using a blocking lock with a timeout. In this case, the waiting
22953 is done inside the system call, and Exim's delivery process acquires the lock
22954 and can proceed as soon as the previous lock holder releases it.
22955
22956 If &%lock_fcntl_timeout%& is set to a non-zero time, blocking locks, with that
22957 timeout, are used. There may still be some retrying: the maximum number of
22958 retries is
22959 .code
22960 (lock_retries * lock_interval) / lock_fcntl_timeout
22961 .endd
22962 rounded up to the next whole number. In other words, the total time during
22963 which &(appendfile)& is trying to get a lock is roughly the same, unless
22964 &%lock_fcntl_timeout%& is set very large.
22965
22966 You should consider setting this option if you are getting a lot of delayed
22967 local deliveries because of errors of the form
22968 .code
22969 failed to lock mailbox /some/file (fcntl)
22970 .endd
22971
22972 .option lock_flock_timeout appendfile time 0s
22973 This timeout applies to file locking when using &[flock()]& (see
22974 &%use_flock%&); the timeout operates in a similar manner to
22975 &%lock_fcntl_timeout%&.
22976
22977
22978 .option lock_interval appendfile time 3s
22979 This specifies the time to wait between attempts to lock the file. See below
22980 for details of locking.
22981
22982
22983 .option lock_retries appendfile integer 10
22984 This specifies the maximum number of attempts to lock the file. A value of zero
22985 is treated as 1. See below for details of locking.
22986
22987
22988 .option lockfile_mode appendfile "octal integer" 0600
22989 This specifies the mode of the created lock file, when a lock file is being
22990 used (see &%use_lockfile%& and &%use_mbx_lock%&).
22991
22992
22993 .option lockfile_timeout appendfile time 30m
22994 .cindex "timeout" "mailbox locking"
22995 When a lock file is being used (see &%use_lockfile%&), if a lock file already
22996 exists and is older than this value, it is assumed to have been left behind by
22997 accident, and Exim attempts to remove it.
22998
22999
23000 .option mailbox_filecount appendfile string&!! unset
23001 .cindex "mailbox" "specifying size of"
23002 .cindex "size" "of mailbox"
23003 If this option is set, it is expanded, and the result is taken as the current
23004 number of files in the mailbox. It must be a decimal number, optionally
23005 followed by K or M. This provides a way of obtaining this information from an
23006 external source that maintains the data.
23007
23008
23009 .option mailbox_size appendfile string&!! unset
23010 .cindex "mailbox" "specifying size of"
23011 .cindex "size" "of mailbox"
23012 If this option is set, it is expanded, and the result is taken as the current
23013 size the mailbox. It must be a decimal number, optionally followed by K or M.
23014 This provides a way of obtaining this information from an external source that
23015 maintains the data. This is likely to be helpful for maildir deliveries where
23016 it is computationally expensive to compute the size of a mailbox.
23017
23018
23019
23020 .option maildir_format appendfile boolean false
23021 .cindex "maildir format" "specifying"
23022 If this option is set with the &%directory%& option, the delivery is into a new
23023 file, in the &"maildir"& format that is used by other mail software. When the
23024 transport is activated directly from a &(redirect)& router (for example, the
23025 &(address_file)& transport in the default configuration), setting
23026 &%maildir_format%& causes the path received from the router to be treated as a
23027 directory, whether or not it ends with &`/`&. This option is available only if
23028 SUPPORT_MAILDIR is present in &_Local/Makefile_&. See section
23029 &<<SECTmaildirdelivery>>& below for further details.
23030
23031
23032 .option maildir_quota_directory_regex appendfile string "See below"
23033 .cindex "maildir format" "quota; directories included in"
23034 .cindex "quota" "maildir; directories included in"
23035 This option is relevant only when &%maildir_use_size_file%& is set. It defines
23036 a regular expression for specifying directories, relative to the quota
23037 directory (see &%quota_directory%&), that should be included in the quota
23038 calculation. The default value is:
23039 .code
23040 maildir_quota_directory_regex = ^(?:cur|new|\..*)$
23041 .endd
23042 This includes the &_cur_& and &_new_& directories, and any maildir++ folders
23043 (directories whose names begin with a dot). If you want to exclude the
23044 &_Trash_&
23045 folder from the count (as some sites do), you need to change this setting to
23046 .code
23047 maildir_quota_directory_regex = ^(?:cur|new|\.(?!Trash).*)$
23048 .endd
23049 This uses a negative lookahead in the regular expression to exclude the
23050 directory whose name is &_.Trash_&. When a directory is excluded from quota
23051 calculations, quota processing is bypassed for any messages that are delivered
23052 directly into that directory.
23053
23054
23055 .option maildir_retries appendfile integer 10
23056 This option specifies the number of times to retry when writing a file in
23057 &"maildir"& format. See section &<<SECTmaildirdelivery>>& below.
23058
23059
23060 .option maildir_tag appendfile string&!! unset
23061 This option applies only to deliveries in maildir format, and is described in
23062 section &<<SECTmaildirdelivery>>& below.
23063
23064
23065 .option maildir_use_size_file appendfile&!! boolean false
23066 .cindex "maildir format" "&_maildirsize_& file"
23067 The result of string expansion for this option must be a valid boolean value.
23068 If it is true, it enables support for &_maildirsize_& files. Exim
23069 creates a &_maildirsize_& file in a maildir if one does not exist, taking the
23070 quota from the &%quota%& option of the transport. If &%quota%& is unset, the
23071 value is zero. See &%maildir_quota_directory_regex%& above and section
23072 &<<SECTmaildirdelivery>>& below for further details.
23073
23074 .option maildirfolder_create_regex appendfile string unset
23075 .cindex "maildir format" "&_maildirfolder_& file"
23076 .cindex "&_maildirfolder_&, creating"
23077 The value of this option is a regular expression. If it is unset, it has no
23078 effect. Otherwise, before a maildir delivery takes place, the pattern is
23079 matched against the name of the maildir directory, that is, the directory
23080 containing the &_new_& and &_tmp_& subdirectories that will be used for the
23081 delivery. If there is a match, Exim checks for the existence of a file called
23082 &_maildirfolder_& in the directory, and creates it if it does not exist.
23083 See section &<<SECTmaildirdelivery>>& for more details.
23084
23085
23086 .option mailstore_format appendfile boolean false
23087 .cindex "mailstore format" "specifying"
23088 If this option is set with the &%directory%& option, the delivery is into two
23089 new files in  &"mailstore"& format. The option is available only if
23090 SUPPORT_MAILSTORE is present in &_Local/Makefile_&. See section &<<SECTopdir>>&
23091 below for further details.
23092
23093
23094 .option mailstore_prefix appendfile string&!! unset
23095 This option applies only to deliveries in mailstore format, and is described in
23096 section &<<SECTopdir>>& below.
23097
23098
23099 .option mailstore_suffix appendfile string&!! unset
23100 This option applies only to deliveries in mailstore format, and is described in
23101 section &<<SECTopdir>>& below.
23102
23103
23104 .option mbx_format appendfile boolean false
23105 .cindex "locking files"
23106 .cindex "file" "locking"
23107 .cindex "file" "MBX format"
23108 .cindex "MBX format, specifying"
23109 This option is available only if Exim has been compiled with SUPPORT_MBX
23110 set in &_Local/Makefile_&. If &%mbx_format%& is set with the &%file%& option,
23111 the message is appended to the mailbox file in MBX format instead of
23112 traditional Unix format. This format is supported by Pine4 and its associated
23113 IMAP and POP daemons, by means of the &'c-client'& library that they all use.
23114
23115 &*Note*&: The &%message_prefix%& and &%message_suffix%& options are not
23116 automatically changed by the use of &%mbx_format%&. They should normally be set
23117 empty when using MBX format, so this option almost always appears in this
23118 combination:
23119 .code
23120 mbx_format = true
23121 message_prefix =
23122 message_suffix =
23123 .endd
23124 If none of the locking options are mentioned in the configuration,
23125 &%use_mbx_lock%& is assumed and the other locking options default to false. It
23126 is possible to specify the other kinds of locking with &%mbx_format%&, but
23127 &%use_fcntl_lock%& and &%use_mbx_lock%& are mutually exclusive. MBX locking
23128 interworks with &'c-client'&, providing for shared access to the mailbox. It
23129 should not be used if any program that does not use this form of locking is
23130 going to access the mailbox, nor should it be used if the mailbox file is NFS
23131 mounted, because it works only when the mailbox is accessed from a single host.
23132
23133 If you set &%use_fcntl_lock%& with an MBX-format mailbox, you cannot use
23134 the standard version of &'c-client'&, because as long as it has a mailbox open
23135 (this means for the whole of a Pine or IMAP session), Exim will not be able to
23136 append messages to it.
23137
23138
23139 .option message_prefix appendfile string&!! "see below"
23140 .cindex "&""From""& line"
23141 The string specified here is expanded and output at the start of every message.
23142 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
23143 in which case it is:
23144 .code
23145 message_prefix = "From ${if def:return_path{$return_path}\
23146   {MAILER-DAEMON}} $tod_bsdinbox\n"
23147 .endd
23148 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
23149 &`\n`& to &`\r\n`& in &%message_prefix%&.
23150
23151 .option message_suffix appendfile string&!! "see below"
23152 The string specified here is expanded and output at the end of every message.
23153 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
23154 in which case it is a single newline character. The suffix can be suppressed by
23155 setting
23156 .code
23157 message_suffix =
23158 .endd
23159 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
23160 &`\n`& to &`\r\n`& in &%message_suffix%&.
23161
23162 .option mode appendfile "octal integer" 0600
23163 If the output file is created, it is given this mode. If it already exists and
23164 has wider permissions, they are reduced to this mode. If it has narrower
23165 permissions, an error occurs unless &%mode_fail_narrower%& is false. However,
23166 if the delivery is the result of a &%save%& command in a filter file specifying
23167 a particular mode, the mode of the output file is always forced to take that
23168 value, and this option is ignored.
23169
23170
23171 .option mode_fail_narrower appendfile boolean true
23172 This option applies in the case when an existing mailbox file has a narrower
23173 mode than that specified by the &%mode%& option. If &%mode_fail_narrower%& is
23174 true, the delivery is deferred (&"mailbox has the wrong mode"&); otherwise Exim
23175 continues with the delivery attempt, using the existing mode of the file.
23176
23177
23178 .option notify_comsat appendfile boolean false
23179 If this option is true, the &'comsat'& daemon is notified after every
23180 successful delivery to a user mailbox. This is the daemon that notifies logged
23181 on users about incoming mail.
23182
23183
23184 .option quota appendfile string&!! unset
23185 .cindex "quota" "imposed by Exim"
23186 This option imposes a limit on the size of the file to which Exim is appending,
23187 or to the total space used in the directory tree when the &%directory%& option
23188 is set. In the latter case, computation of the space used is expensive, because
23189 all the files in the directory (and any sub-directories) have to be
23190 individually inspected and their sizes summed. (See &%quota_size_regex%& and
23191 &%maildir_use_size_file%& for ways to avoid this in environments where users
23192 have no shell access to their mailboxes).
23193
23194 As there is no interlock against two simultaneous deliveries into a
23195 multi-file mailbox, it is possible for the quota to be overrun in this case.
23196 For single-file mailboxes, of course, an interlock is a necessity.
23197
23198 A file's size is taken as its &'used'& value. Because of blocking effects, this
23199 may be a lot less than the actual amount of disk space allocated to the file.
23200 If the sizes of a number of files are being added up, the rounding effect can
23201 become quite noticeable, especially on systems that have large block sizes.
23202 Nevertheless, it seems best to stick to the &'used'& figure, because this is
23203 the obvious value which users understand most easily.
23204
23205 The value of the option is expanded, and must then be a numerical value
23206 (decimal point allowed), optionally followed by one of the letters K, M, or G,
23207 for kilobytes, megabytes, or gigabytes, optionally followed by a slash
23208 and further option modifiers. If Exim is running on a system with
23209 large file support (Linux and FreeBSD have this), mailboxes larger than 2G can
23210 be handled.
23211
23212 The option modifier &%no_check%& can be used to force delivery even if the over
23213 quota condition is met. The quota gets updated as usual.
23214
23215 &*Note*&: A value of zero is interpreted as &"no quota"&.
23216
23217 The expansion happens while Exim is running as root, before it changes uid for
23218 the delivery. This means that files that are inaccessible to the end user can
23219 be used to hold quota values that are looked up in the expansion. When delivery
23220 fails because this quota is exceeded, the handling of the error is as for
23221 system quota failures.
23222
23223 By default, Exim's quota checking mimics system quotas, and restricts the
23224 mailbox to the specified maximum size, though the value is not accurate to the
23225 last byte, owing to separator lines and additional headers that may get added
23226 during message delivery. When a mailbox is nearly full, large messages may get
23227 refused even though small ones are accepted, because the size of the current
23228 message is added to the quota when the check is made. This behaviour can be
23229 changed by setting &%quota_is_inclusive%& false. When this is done, the check
23230 for exceeding the quota does not include the current message. Thus, deliveries
23231 continue until the quota has been exceeded; thereafter, no further messages are
23232 delivered. See also &%quota_warn_threshold%&.
23233
23234
23235 .option quota_directory appendfile string&!! unset
23236 This option defines the directory to check for quota purposes when delivering
23237 into individual files. The default is the delivery directory, or, if a file
23238 called &_maildirfolder_& exists in a maildir directory, the parent of the
23239 delivery directory.
23240
23241
23242 .option quota_filecount appendfile string&!! 0
23243 This option applies when the &%directory%& option is set. It limits the total
23244 number of files in the directory (compare the inode limit in system quotas). It
23245 can only be used if &%quota%& is also set. The value is expanded; an expansion
23246 failure causes delivery to be deferred. A value of zero is interpreted as
23247 &"no quota"&.
23248
23249 The option modifier &%no_check%& can be used to force delivery even if the over
23250 quota condition is met. The quota gets updated as usual.
23251
23252 .option quota_is_inclusive appendfile boolean true
23253 See &%quota%& above.
23254
23255
23256 .option quota_size_regex appendfile string unset
23257 This option applies when one of the delivery modes that writes a separate file
23258 for each message is being used. When Exim wants to find the size of one of
23259 these files in order to test the quota, it first checks &%quota_size_regex%&.
23260 If this is set to a regular expression that matches the filename, and it
23261 captures one string, that string is interpreted as a representation of the
23262 file's size. The value of &%quota_size_regex%& is not expanded.
23263
23264 This feature is useful only when users have no shell access to their mailboxes
23265 &-- otherwise they could defeat the quota simply by renaming the files. This
23266 facility can be used with maildir deliveries, by setting &%maildir_tag%& to add
23267 the file length to the filename. For example:
23268 .code
23269 maildir_tag = ,S=$message_size
23270 quota_size_regex = ,S=(\d+)
23271 .endd
23272 An alternative to &$message_size$& is &$message_linecount$&, which contains the
23273 number of lines in the message.
23274
23275 The regular expression should not assume that the length is at the end of the
23276 filename (even though &%maildir_tag%& puts it there) because maildir MUAs
23277 sometimes add other information onto the ends of message filenames.
23278
23279 Section &<<SECID136>>& contains further information.
23280
23281 This option should not be used when other message-handling software
23282 may duplicate messages by making hardlinks to the files.  When that is done Exim
23283 will count the message size once for each filename, in contrast with the actual
23284 disk usage.  When the option is not set, calculating total usage requires
23285 a system-call per file to get the size; the number of links is then available also
23286 as is used to adjust the effective size.
23287
23288
23289 .option quota_warn_message appendfile string&!! "see below"
23290 See below for the use of this option. If it is not set when
23291 &%quota_warn_threshold%& is set, it defaults to
23292 .code
23293 quota_warn_message = "\
23294   To: $local_part@$domain\n\
23295   Subject: Your mailbox\n\n\
23296   This message is automatically created \
23297   by mail delivery software.\n\n\
23298   The size of your mailbox has exceeded \
23299   a warning threshold that is\n\
23300   set by the system administrator.\n"
23301 .endd
23302
23303
23304 .option quota_warn_threshold appendfile string&!! 0
23305 .cindex "quota" "warning threshold"
23306 .cindex "mailbox" "size warning"
23307 .cindex "size" "of mailbox"
23308 This option is expanded in the same way as &%quota%& (see above). If the
23309 resulting value is greater than zero, and delivery of the message causes the
23310 size of the file or total space in the directory tree to cross the given
23311 threshold, a warning message is sent. If &%quota%& is also set, the threshold
23312 may be specified as a percentage of it by following the value with a percent
23313 sign. For example:
23314 .code
23315 quota = 10M
23316 quota_warn_threshold = 75%
23317 .endd
23318 If &%quota%& is not set, a setting of &%quota_warn_threshold%& that ends with a
23319 percent sign is ignored.
23320
23321 The warning message itself is specified by the &%quota_warn_message%& option,
23322 and it must start with a &'To:'& header line containing the recipient(s) of the
23323 warning message. These do not necessarily have to include the recipient(s) of
23324 the original message. A &'Subject:'& line should also normally be supplied. You
23325 can include any other header lines that you want. If you do not include a
23326 &'From:'& line, the default is:
23327 .code
23328 From: Mail Delivery System <mailer-daemon@$qualify_domain_sender>
23329 .endd
23330 .oindex &%errors_reply_to%&
23331 If you supply a &'Reply-To:'& line, it overrides the global &%errors_reply_to%&
23332 option.
23333
23334 The &%quota%& option does not have to be set in order to use this option; they
23335 are independent of one another except when the threshold is specified as a
23336 percentage.
23337
23338
23339 .option use_bsmtp appendfile boolean false
23340 .cindex "envelope from"
23341 .cindex "envelope sender"
23342 If this option is set true, &(appendfile)& writes messages in &"batch SMTP"&
23343 format, with the envelope sender and recipient(s) included as SMTP commands. If
23344 you want to include a leading HELO command with such messages, you can do
23345 so by setting the &%message_prefix%& option. See section &<<SECTbatchSMTP>>&
23346 for details of batch SMTP.
23347
23348
23349 .option use_crlf appendfile boolean false
23350 .cindex "carriage return"
23351 .cindex "linefeed"
23352 This option causes lines to be terminated with the two-character CRLF sequence
23353 (carriage return, linefeed) instead of just a linefeed character. In the case
23354 of batched SMTP, the byte sequence written to the file is then an exact image
23355 of what would be sent down a real SMTP connection.
23356
23357 &*Note:*& The contents of the &%message_prefix%& and &%message_suffix%& options
23358 (which are used to supply the traditional &"From&~"& and blank line separators
23359 in Berkeley-style mailboxes) are written verbatim, so must contain their own
23360 carriage return characters if these are needed. In cases where these options
23361 have non-empty defaults, the values end with a single linefeed, so they must be
23362 changed to end with &`\r\n`& if &%use_crlf%& is set.
23363
23364
23365 .option use_fcntl_lock appendfile boolean "see below"
23366 This option controls the use of the &[fcntl()]& function to lock a file for
23367 exclusive use when a message is being appended. It is set by default unless
23368 &%use_flock_lock%& is set. Otherwise, it should be turned off only if you know
23369 that all your MUAs use lock file locking. When both &%use_fcntl_lock%& and
23370 &%use_flock_lock%& are unset, &%use_lockfile%& must be set.
23371
23372
23373 .option use_flock_lock appendfile boolean false
23374 This option is provided to support the use of &[flock()]& for file locking, for
23375 the few situations where it is needed. Most modern operating systems support
23376 &[fcntl()]& and &[lockf()]& locking, and these two functions interwork with
23377 each other. Exim uses &[fcntl()]& locking by default.
23378
23379 This option is required only if you are using an operating system where
23380 &[flock()]& is used by programs that access mailboxes (typically MUAs), and
23381 where &[flock()]& does not correctly interwork with &[fcntl()]&. You can use
23382 both &[fcntl()]& and &[flock()]& locking simultaneously if you want.
23383
23384 .cindex "Solaris" "&[flock()]& support"
23385 Not all operating systems provide &[flock()]&. Some versions of Solaris do not
23386 have it (and some, I think, provide a not quite right version built on top of
23387 &[lockf()]&). If the OS does not have &[flock()]&, Exim will be built without
23388 the ability to use it, and any attempt to do so will cause a configuration
23389 error.
23390
23391 &*Warning*&: &[flock()]& locks do not work on NFS files (unless &[flock()]&
23392 is just being mapped onto &[fcntl()]& by the OS).
23393
23394
23395 .option use_lockfile appendfile boolean "see below"
23396 If this option is turned off, Exim does not attempt to create a lock file when
23397 appending to a mailbox file. In this situation, the only locking is by
23398 &[fcntl()]&. You should only turn &%use_lockfile%& off if you are absolutely
23399 sure that every MUA that is ever going to look at your users' mailboxes uses
23400 &[fcntl()]& rather than a lock file, and even then only when you are not
23401 delivering over NFS from more than one host.
23402
23403 .cindex "NFS" "lock file"
23404 In order to append to an NFS file safely from more than one host, it is
23405 necessary to take out a lock &'before'& opening the file, and the lock file
23406 achieves this. Otherwise, even with &[fcntl()]& locking, there is a risk of
23407 file corruption.
23408
23409 The &%use_lockfile%& option is set by default unless &%use_mbx_lock%& is set.
23410 It is not possible to turn both &%use_lockfile%& and &%use_fcntl_lock%& off,
23411 except when &%mbx_format%& is set.
23412
23413
23414 .option use_mbx_lock appendfile boolean "see below"
23415 This option is available only if Exim has been compiled with SUPPORT_MBX
23416 set in &_Local/Makefile_&. Setting the option specifies that special MBX
23417 locking rules be used. It is set by default if &%mbx_format%& is set and none
23418 of the locking options are mentioned in the configuration. The locking rules
23419 are the same as are used by the &'c-client'& library that underlies Pine and
23420 the IMAP4 and POP daemons that come with it (see the discussion below). The
23421 rules allow for shared access to the mailbox. However, this kind of locking
23422 does not work when the mailbox is NFS mounted.
23423
23424 You can set &%use_mbx_lock%& with either (or both) of &%use_fcntl_lock%& and
23425 &%use_flock_lock%& to control what kind of locking is used in implementing the
23426 MBX locking rules. The default is to use &[fcntl()]& if &%use_mbx_lock%& is set
23427 without &%use_fcntl_lock%& or &%use_flock_lock%&.
23428
23429
23430
23431
23432 .section "Operational details for appending" "SECTopappend"
23433 .cindex "appending to a file"
23434 .cindex "file" "appending"
23435 Before appending to a file, the following preparations are made:
23436
23437 .ilist
23438 If the name of the file is &_/dev/null_&, no action is taken, and a success
23439 return is given.
23440
23441 .next
23442 .cindex "directory creation"
23443 If any directories on the file's path are missing, Exim creates them if the
23444 &%create_directory%& option is set. A created directory's mode is given by the
23445 &%directory_mode%& option.
23446
23447 .next
23448 If &%file_format%& is set, the format of an existing file is checked. If this
23449 indicates that a different transport should be used, control is passed to that
23450 transport.
23451
23452 .next
23453 .cindex "file" "locking"
23454 .cindex "locking files"
23455 .cindex "NFS" "lock file"
23456 If &%use_lockfile%& is set, a lock file is built in a way that will work
23457 reliably over NFS, as follows:
23458
23459 .olist
23460 Create a &"hitching post"& file whose name is that of the lock file with the
23461 current time, primary host name, and process id added, by opening for writing
23462 as a new file. If this fails with an access error, delivery is deferred.
23463 .next
23464 Close the hitching post file, and hard link it to the lock filename.
23465 .next
23466 If the call to &[link()]& succeeds, creation of the lock file has succeeded.
23467 Unlink the hitching post name.
23468 .next
23469 Otherwise, use &[stat()]& to get information about the hitching post file, and
23470 then unlink hitching post name. If the number of links is exactly two, creation
23471 of the lock file succeeded but something (for example, an NFS server crash and
23472 restart) caused this fact not to be communicated to the &[link()]& call.
23473 .next
23474 If creation of the lock file failed, wait for &%lock_interval%& and try again,
23475 up to &%lock_retries%& times. However, since any program that writes to a
23476 mailbox should complete its task very quickly, it is reasonable to time out old
23477 lock files that are normally the result of user agent and system crashes. If an
23478 existing lock file is older than &%lockfile_timeout%& Exim attempts to unlink
23479 it before trying again.
23480 .endlist olist
23481
23482 .next
23483 A call is made to &[lstat()]& to discover whether the main file exists, and if
23484 so, what its characteristics are. If &[lstat()]& fails for any reason other
23485 than non-existence, delivery is deferred.
23486
23487 .next
23488 .cindex "symbolic link" "to mailbox"
23489 .cindex "mailbox" "symbolic link"
23490 If the file does exist and is a symbolic link, delivery is deferred, unless the
23491 &%allow_symlink%& option is set, in which case the ownership of the link is
23492 checked, and then &[stat()]& is called to find out about the real file, which
23493 is then subjected to the checks below. The check on the top-level link
23494 ownership prevents one user creating a link for another's mailbox in a sticky
23495 directory, though allowing symbolic links in this case is definitely not a good
23496 idea. If there is a chain of symbolic links, the intermediate ones are not
23497 checked.
23498
23499 .next
23500 If the file already exists but is not a regular file, or if the file's owner
23501 and group (if the group is being checked &-- see &%check_group%& above) are
23502 different from the user and group under which the delivery is running,
23503 delivery is deferred.
23504
23505 .next
23506 If the file's permissions are more generous than specified, they are reduced.
23507 If they are insufficient, delivery is deferred, unless &%mode_fail_narrower%&
23508 is set false, in which case the delivery is tried using the existing
23509 permissions.
23510
23511 .next
23512 The file's inode number is saved, and the file is then opened for appending.
23513 If this fails because the file has vanished, &(appendfile)& behaves as if it
23514 hadn't existed (see below). For any other failures, delivery is deferred.
23515
23516 .next
23517 If the file is opened successfully, check that the inode number hasn't
23518 changed, that it is still a regular file, and that the owner and permissions
23519 have not changed. If anything is wrong, defer delivery and freeze the message.
23520
23521 .next
23522 If the file did not exist originally, defer delivery if the &%file_must_exist%&
23523 option is set. Otherwise, check that the file is being created in a permitted
23524 directory if the &%create_file%& option is set (deferring on failure), and then
23525 open for writing as a new file, with the O_EXCL and O_CREAT options,
23526 except when dealing with a symbolic link (the &%allow_symlink%& option must be
23527 set). In this case, which can happen if the link points to a non-existent file,
23528 the file is opened for writing using O_CREAT but not O_EXCL, because
23529 that prevents link following.
23530
23531 .next
23532 .cindex "loop" "while file testing"
23533 If opening fails because the file exists, obey the tests given above for
23534 existing files. However, to avoid looping in a situation where the file is
23535 being continuously created and destroyed, the exists/not-exists loop is broken
23536 after 10 repetitions, and the message is then frozen.
23537
23538 .next
23539 If opening fails with any other error, defer delivery.
23540
23541 .next
23542 .cindex "file" "locking"
23543 .cindex "locking files"
23544 Once the file is open, unless both &%use_fcntl_lock%& and &%use_flock_lock%&
23545 are false, it is locked using &[fcntl()]& or &[flock()]& or both. If
23546 &%use_mbx_lock%& is false, an exclusive lock is requested in each case.
23547 However, if &%use_mbx_lock%& is true, Exim takes out a shared lock on the open
23548 file, and an exclusive lock on the file whose name is
23549 .code
23550 /tmp/.<device-number>.<inode-number>
23551 .endd
23552 using the device and inode numbers of the open mailbox file, in accordance with
23553 the MBX locking rules. This file is created with a mode that is specified by
23554 the &%lockfile_mode%& option.
23555
23556 If Exim fails to lock the file, there are two possible courses of action,
23557 depending on the value of the locking timeout. This is obtained from
23558 &%lock_fcntl_timeout%& or &%lock_flock_timeout%&, as appropriate.
23559
23560 If the timeout value is zero, the file is closed, Exim waits for
23561 &%lock_interval%&, and then goes back and re-opens the file as above and tries
23562 to lock it again. This happens up to &%lock_retries%& times, after which the
23563 delivery is deferred.
23564
23565 If the timeout has a value greater than zero, blocking calls to &[fcntl()]& or
23566 &[flock()]& are used (with the given timeout), so there has already been some
23567 waiting involved by the time locking fails. Nevertheless, Exim does not give up
23568 immediately. It retries up to
23569 .code
23570 (lock_retries * lock_interval) / <timeout>
23571 .endd
23572 times (rounded up).
23573 .endlist
23574
23575 At the end of delivery, Exim closes the file (which releases the &[fcntl()]&
23576 and/or &[flock()]& locks) and then deletes the lock file if one was created.
23577
23578
23579 .section "Operational details for delivery to a new file" "SECTopdir"
23580 .cindex "delivery" "to single file"
23581 .cindex "&""From""& line"
23582 When the &%directory%& option is set instead of &%file%&, each message is
23583 delivered into a newly-created file or set of files. When &(appendfile)& is
23584 activated directly from a &(redirect)& router, neither &%file%& nor
23585 &%directory%& is normally set, because the path for delivery is supplied by the
23586 router. (See for example, the &(address_file)& transport in the default
23587 configuration.) In this case, delivery is to a new file if either the path name
23588 ends in &`/`&, or the &%maildir_format%& or &%mailstore_format%& option is set.
23589
23590 No locking is required while writing the message to a new file, so the various
23591 locking options of the transport are ignored. The &"From"& line that by default
23592 separates messages in a single file is not normally needed, nor is the escaping
23593 of message lines that start with &"From"&, and there is no need to ensure a
23594 newline at the end of each message. Consequently, the default values for
23595 &%check_string%&, &%message_prefix%&, and &%message_suffix%& are all unset when
23596 any of &%directory%&, &%maildir_format%&, or &%mailstore_format%& is set.
23597
23598 If Exim is required to check a &%quota%& setting, it adds up the sizes of all
23599 the files in the delivery directory by default. However, you can specify a
23600 different directory by setting &%quota_directory%&. Also, for maildir
23601 deliveries (see below) the &_maildirfolder_& convention is honoured.
23602
23603
23604 .cindex "maildir format"
23605 .cindex "mailstore format"
23606 There are three different ways in which delivery to individual files can be
23607 done, controlled by the settings of the &%maildir_format%& and
23608 &%mailstore_format%& options. Note that code to support maildir or mailstore
23609 formats is not included in the binary unless SUPPORT_MAILDIR or
23610 SUPPORT_MAILSTORE, respectively, is set in &_Local/Makefile_&.
23611
23612 .cindex "directory creation"
23613 In all three cases an attempt is made to create the directory and any necessary
23614 sub-directories if they do not exist, provided that the &%create_directory%&
23615 option is set (the default). The location of a created directory can be
23616 constrained by setting &%create_file%&. A created directory's mode is given by
23617 the &%directory_mode%& option. If creation fails, or if the
23618 &%create_directory%& option is not set when creation is required, delivery is
23619 deferred.
23620
23621
23622
23623 .section "Maildir delivery" "SECTmaildirdelivery"
23624 .cindex "maildir format" "description of"
23625 If the &%maildir_format%& option is true, Exim delivers each message by writing
23626 it to a file whose name is &_tmp/<stime>.H<mtime>P<pid>.<host>_& in the
23627 directory that is defined by the &%directory%& option (the &"delivery
23628 directory"&). If the delivery is successful, the file is renamed into the
23629 &_new_& subdirectory.
23630
23631 In the filename, <&'stime'&> is the current time of day in seconds, and
23632 <&'mtime'&> is the microsecond fraction of the time. After a maildir delivery,
23633 Exim checks that the time-of-day clock has moved on by at least one microsecond
23634 before terminating the delivery process. This guarantees uniqueness for the
23635 filename. However, as a precaution, Exim calls &[stat()]& for the file before
23636 opening it. If any response other than ENOENT (does not exist) is given,
23637 Exim waits 2 seconds and tries again, up to &%maildir_retries%& times.
23638
23639 Before Exim carries out a maildir delivery, it ensures that subdirectories
23640 called &_new_&, &_cur_&, and &_tmp_& exist in the delivery directory. If they
23641 do not exist, Exim tries to create them and any superior directories in their
23642 path, subject to the &%create_directory%& and &%create_file%& options. If the
23643 &%maildirfolder_create_regex%& option is set, and the regular expression it
23644 contains matches the delivery directory, Exim also ensures that a file called
23645 &_maildirfolder_& exists in the delivery directory. If a missing directory or
23646 &_maildirfolder_& file cannot be created, delivery is deferred.
23647
23648 These features make it possible to use Exim to create all the necessary files
23649 and directories in a maildir mailbox, including subdirectories for maildir++
23650 folders. Consider this example:
23651 .code
23652 maildir_format = true
23653 directory = /var/mail/$local_part_data\
23654            ${if eq{$local_part_suffix}{}{}\
23655            {/.${substr_1:$local_part_suffix}}}
23656 maildirfolder_create_regex = /\.[^/]+$
23657 .endd
23658 If &$local_part_suffix$& is empty (there was no suffix for the local part),
23659 delivery is into a toplevel maildir with a name like &_/var/mail/pimbo_& (for
23660 the user called &'pimbo'&). The pattern in &%maildirfolder_create_regex%& does
23661 not match this name, so Exim will not look for or create the file
23662 &_/var/mail/pimbo/maildirfolder_&, though it will create
23663 &_/var/mail/pimbo/{cur,new,tmp}_& if necessary.
23664
23665 However, if &$local_part_suffix$& contains &`-eximusers`& (for example),
23666 delivery is into the maildir++ folder &_/var/mail/pimbo/.eximusers_&, which
23667 does match &%maildirfolder_create_regex%&. In this case, Exim will create
23668 &_/var/mail/pimbo/.eximusers/maildirfolder_& as well as the three maildir
23669 directories &_/var/mail/pimbo/.eximusers/{cur,new,tmp}_&.
23670
23671 &*Warning:*& Take care when setting &%maildirfolder_create_regex%& that it does
23672 not inadvertently match the toplevel maildir directory, because a
23673 &_maildirfolder_& file at top level would completely break quota calculations.
23674
23675 .cindex "quota" "in maildir delivery"
23676 .cindex "maildir++"
23677 If Exim is required to check a &%quota%& setting before a maildir delivery, and
23678 &%quota_directory%& is not set, it looks for a file called &_maildirfolder_& in
23679 the maildir directory (alongside &_new_&, &_cur_&, &_tmp_&). If this exists,
23680 Exim assumes the directory is a maildir++ folder directory, which is one level
23681 down from the user's top level mailbox directory. This causes it to start at
23682 the parent directory instead of the current directory when calculating the
23683 amount of space used.
23684
23685 One problem with delivering into a multi-file mailbox is that it is
23686 computationally expensive to compute the size of the mailbox for quota
23687 checking. Various approaches have been taken to reduce the amount of work
23688 needed. The next two sections describe two of them. A third alternative is to
23689 use some external process for maintaining the size data, and use the expansion
23690 of the &%mailbox_size%& option as a way of importing it into Exim.
23691
23692
23693
23694
23695 .section "Using tags to record message sizes" "SECID135"
23696 If &%maildir_tag%& is set, the string is expanded for each delivery.
23697 When the maildir file is renamed into the &_new_& sub-directory, the
23698 tag is added to its name. However, if adding the tag takes the length of the
23699 name to the point where the test &[stat()]& call fails with ENAMETOOLONG,
23700 the tag is dropped and the maildir file is created with no tag.
23701
23702
23703 .vindex "&$message_size$&"
23704 Tags can be used to encode the size of files in their names; see
23705 &%quota_size_regex%& above for an example. The expansion of &%maildir_tag%&
23706 happens after the message has been written. The value of the &$message_size$&
23707 variable is set to the number of bytes actually written. If the expansion is
23708 forced to fail, the tag is ignored, but a non-forced failure causes delivery to
23709 be deferred. The expanded tag may contain any printing characters except &"/"&.
23710 Non-printing characters in the string are ignored; if the resulting string is
23711 empty, it is ignored. If it starts with an alphanumeric character, a leading
23712 colon is inserted; this default has not proven to be the path that popular
23713 maildir implementations have chosen (but changing it in Exim would break
23714 backwards compatibility).
23715
23716 For one common implementation, you might set:
23717 .code
23718 maildir_tag = ,S=${message_size}
23719 .endd
23720 but you should check the documentation of the other software to be sure.
23721
23722 It is advisable to also set &%quota_size_regex%& when setting &%maildir_tag%&
23723 as this allows Exim to extract the size from your tag, instead of having to
23724 &[stat()]& each message file.
23725
23726
23727 .section "Using a maildirsize file" "SECID136"
23728 .cindex "quota" "in maildir delivery"
23729 .cindex "maildir format" "&_maildirsize_& file"
23730 If &%maildir_use_size_file%& is true, Exim implements the maildir++ rules for
23731 storing quota and message size information in a file called &_maildirsize_&
23732 within the toplevel maildir directory. If this file does not exist, Exim
23733 creates it, setting the quota from the &%quota%& option of the transport. If
23734 the maildir directory itself does not exist, it is created before any attempt
23735 to write a &_maildirsize_& file.
23736
23737 The &_maildirsize_& file is used to hold information about the sizes of
23738 messages in the maildir, thus speeding up quota calculations. The quota value
23739 in the file is just a cache; if the quota is changed in the transport, the new
23740 value overrides the cached value when the next message is delivered. The cache
23741 is maintained for the benefit of other programs that access the maildir and
23742 need to know the quota.
23743
23744 If the &%quota%& option in the transport is unset or zero, the &_maildirsize_&
23745 file is maintained (with a zero quota setting), but no quota is imposed.
23746
23747 A regular expression is available for controlling which directories in the
23748 maildir participate in quota calculations when a &_maildirsizefile_& is in use.
23749 See the description of the &%maildir_quota_directory_regex%& option above for
23750 details.
23751
23752
23753 .section "Mailstore delivery" "SECID137"
23754 .cindex "mailstore format" "description of"
23755 If the &%mailstore_format%& option is true, each message is written as two
23756 files in the given directory. A unique base name is constructed from the
23757 message id and the current delivery process, and the files that are written use
23758 this base name plus the suffixes &_.env_& and &_.msg_&. The &_.env_& file
23759 contains the message's envelope, and the &_.msg_& file contains the message
23760 itself. The base name is placed in the variable &$mailstore_basename$&.
23761
23762 During delivery, the envelope is first written to a file with the suffix
23763 &_.tmp_&. The &_.msg_& file is then written, and when it is complete, the
23764 &_.tmp_& file is renamed as the &_.env_& file. Programs that access messages in
23765 mailstore format should wait for the presence of both a &_.msg_& and a &_.env_&
23766 file before accessing either of them. An alternative approach is to wait for
23767 the absence of a &_.tmp_& file.
23768
23769 The envelope file starts with any text defined by the &%mailstore_prefix%&
23770 option, expanded and terminated by a newline if there isn't one. Then follows
23771 the sender address on one line, then all the recipient addresses, one per line.
23772 There can be more than one recipient only if the &%batch_max%& option is set
23773 greater than one. Finally, &%mailstore_suffix%& is expanded and the result
23774 appended to the file, followed by a newline if it does not end with one.
23775
23776 If expansion of &%mailstore_prefix%& or &%mailstore_suffix%& ends with a forced
23777 failure, it is ignored. Other expansion errors are treated as serious
23778 configuration errors, and delivery is deferred. The variable
23779 &$mailstore_basename$& is available for use during these expansions.
23780
23781
23782 .section "Non-special new file delivery" "SECID138"
23783 If neither &%maildir_format%& nor &%mailstore_format%& is set, a single new
23784 file is created directly in the named directory. For example, when delivering
23785 messages into files in batched SMTP format for later delivery to some host (see
23786 section &<<SECTbatchSMTP>>&), a setting such as
23787 .code
23788 directory = /var/bsmtp/$host
23789 .endd
23790 might be used. A message is written to a file with a temporary name, which is
23791 then renamed when the delivery is complete. The final name is obtained by
23792 expanding the contents of the &%directory_file%& option.
23793 .ecindex IIDapptra1
23794 .ecindex IIDapptra2
23795
23796
23797
23798
23799
23800
23801 . ////////////////////////////////////////////////////////////////////////////
23802 . ////////////////////////////////////////////////////////////////////////////
23803
23804 .chapter "The autoreply transport" "CHID8"
23805 .scindex IIDauttra1 "transports" "&(autoreply)&"
23806 .scindex IIDauttra2 "&(autoreply)& transport"
23807 The &(autoreply)& transport is not a true transport in that it does not cause
23808 the message to be transmitted. Instead, it generates a new mail message as an
23809 automatic reply to the incoming message. &'References:'& and
23810 &'Auto-Submitted:'& header lines are included. These are constructed according
23811 to the rules in RFCs 2822 and 3834, respectively.
23812
23813 If the router that passes the message to this transport does not have the
23814 &%unseen%& option set, the original message (for the current recipient) is not
23815 delivered anywhere. However, when the &%unseen%& option is set on the router
23816 that passes the message to this transport, routing of the address continues, so
23817 another router can set up a normal message delivery.
23818
23819
23820 The &(autoreply)& transport is usually run as the result of mail filtering, a
23821 &"vacation"& message being the standard example. However, it can also be run
23822 directly from a router like any other transport. To reduce the possibility of
23823 message cascades, messages created by the &(autoreply)& transport always have
23824 empty envelope sender addresses, like bounce messages.
23825
23826 The parameters of the message to be sent can be specified in the configuration
23827 by options described below. However, these are used only when the address
23828 passed to the transport does not contain its own reply information. When the
23829 transport is run as a consequence of a
23830 &%mail%&
23831 or &%vacation%& command in a filter file, the parameters of the message are
23832 supplied by the filter, and passed with the address. The transport's options
23833 that define the message are then ignored (so they are not usually set in this
23834 case). The message is specified entirely by the filter or by the transport; it
23835 is never built from a mixture of options. However, the &%file_optional%&,
23836 &%mode%&, and &%return_message%& options apply in all cases.
23837
23838 &(Autoreply)& is implemented as a local transport. When used as a result of a
23839 command in a user's filter file, &(autoreply)& normally runs under the uid and
23840 gid of the user, and with appropriate current and home directories (see chapter
23841 &<<CHAPenvironment>>&).
23842
23843 There is a subtle difference between routing a message to a &(pipe)& transport
23844 that generates some text to be returned to the sender, and routing it to an
23845 &(autoreply)& transport. This difference is noticeable only if more than one
23846 address from the same message is so handled. In the case of a pipe, the
23847 separate outputs from the different addresses are gathered up and returned to
23848 the sender in a single message, whereas if &(autoreply)& is used, a separate
23849 message is generated for each address that is passed to it.
23850
23851 Non-printing characters are not permitted in the header lines generated for the
23852 message that &(autoreply)& creates, with the exception of newlines that are
23853 immediately followed by white space. If any non-printing characters are found,
23854 the transport defers.
23855 Whether characters with the top bit set count as printing characters or not is
23856 controlled by the &%print_topbitchars%& global option.
23857
23858 If any of the generic options for manipulating headers (for example,
23859 &%headers_add%&) are set on an &(autoreply)& transport, they apply to the copy
23860 of the original message that is included in the generated message when
23861 &%return_message%& is set. They do not apply to the generated message itself.
23862
23863 .vindex "&$sender_address$&"
23864 If the &(autoreply)& transport receives return code 2 from Exim when it submits
23865 the message, indicating that there were no recipients, it does not treat this
23866 as an error. This means that autoreplies sent to &$sender_address$& when this
23867 is empty (because the incoming message is a bounce message) do not cause
23868 problems. They are just discarded.
23869
23870
23871
23872 .section "Private options for autoreply" "SECID139"
23873 .cindex "options" "&(autoreply)& transport"
23874
23875 .option bcc autoreply string&!! unset
23876 This specifies the addresses that are to receive &"blind carbon copies"& of the
23877 message when the message is specified by the transport.
23878
23879
23880 .option cc autoreply string&!! unset
23881 This specifies recipients of the message and the contents of the &'Cc:'& header
23882 when the message is specified by the transport.
23883
23884
23885 .option file autoreply string&!! unset
23886 The contents of the file are sent as the body of the message when the message
23887 is specified by the transport. If both &%file%& and &%text%& are set, the text
23888 string comes first.
23889
23890
23891 .option file_expand autoreply boolean false
23892 If this is set, the contents of the file named by the &%file%& option are
23893 subjected to string expansion as they are added to the message.
23894
23895
23896 .option file_optional autoreply boolean false
23897 If this option is true, no error is generated if the file named by the &%file%&
23898 option or passed with the address does not exist or cannot be read.
23899
23900
23901 .option from autoreply string&!! unset
23902 This specifies the contents of the &'From:'& header when the message is
23903 specified by the transport.
23904
23905
23906 .option headers autoreply string&!! unset
23907 This specifies additional RFC 2822 headers that are to be added to the message
23908 when the message is specified by the transport. Several can be given by using
23909 &"\n"& to separate them. There is no check on the format.
23910
23911
23912 .option log autoreply string&!! unset
23913 This option names a file in which a record of every message sent is logged when
23914 the message is specified by the transport.
23915
23916
23917 .option mode autoreply "octal integer" 0600
23918 If either the log file or the &"once"& file has to be created, this mode is
23919 used.
23920
23921
23922 .option never_mail autoreply "address list&!!" unset
23923 If any run of the transport creates a message with a recipient that matches any
23924 item in the list, that recipient is quietly discarded. If all recipients are
23925 discarded, no message is created. This applies both when the recipients are
23926 generated by a filter and when they are specified in the transport.
23927
23928
23929
23930 .option once autoreply string&!! unset
23931 This option names a file or DBM database in which a record of each &'To:'&
23932 recipient is kept when the message is specified by the transport. &*Note*&:
23933 This does not apply to &'Cc:'& or &'Bcc:'& recipients.
23934
23935 If &%once%& is unset, or is set to an empty string, the message is always sent.
23936 By default, if &%once%& is set to a non-empty filename, the message
23937 is not sent if a potential recipient is already listed in the database.
23938 However, if the &%once_repeat%& option specifies a time greater than zero, the
23939 message is sent if that much time has elapsed since a message was last sent to
23940 this recipient. A setting of zero time for &%once_repeat%& (the default)
23941 prevents a message from being sent a second time &-- in this case, zero means
23942 infinity.
23943
23944 If &%once_file_size%& is zero, a DBM database is used to remember recipients,
23945 and it is allowed to grow as large as necessary. If &%once_file_size%& is set
23946 greater than zero, it changes the way Exim implements the &%once%& option.
23947 Instead of using a DBM file to record every recipient it sends to, it uses a
23948 regular file, whose size will never get larger than the given value.
23949
23950 In the file, Exim keeps a linear list of recipient addresses and the times at
23951 which they were sent messages. If the file is full when a new address needs to
23952 be added, the oldest address is dropped. If &%once_repeat%& is not set, this
23953 means that a given recipient may receive multiple messages, but at
23954 unpredictable intervals that depend on the rate of turnover of addresses in the
23955 file. If &%once_repeat%& is set, it specifies a maximum time between repeats.
23956
23957
23958 .option once_file_size autoreply integer 0
23959 See &%once%& above.
23960
23961
23962 .option once_repeat autoreply time&!! 0s
23963 See &%once%& above.
23964 After expansion, the value of this option must be a valid time value.
23965
23966
23967 .option reply_to autoreply string&!! unset
23968 This specifies the contents of the &'Reply-To:'& header when the message is
23969 specified by the transport.
23970
23971
23972 .option return_message autoreply boolean false
23973 If this is set, a copy of the original message is returned with the new
23974 message, subject to the maximum size set in the &%return_size_limit%& global
23975 configuration option.
23976
23977
23978 .option subject autoreply string&!! unset
23979 This specifies the contents of the &'Subject:'& header when the message is
23980 specified by the transport. It is tempting to quote the original subject in
23981 automatic responses. For example:
23982 .code
23983 subject = Re: $h_subject:
23984 .endd
23985 There is a danger in doing this, however. It may allow a third party to
23986 subscribe your users to an opt-in mailing list, provided that the list accepts
23987 bounce messages as subscription confirmations. Well-managed lists require a
23988 non-bounce message to confirm a subscription, so the danger is relatively
23989 small.
23990
23991
23992
23993 .option text autoreply string&!! unset
23994 This specifies a single string to be used as the body of the message when the
23995 message is specified by the transport. If both &%text%& and &%file%& are set,
23996 the text comes first.
23997
23998
23999 .option to autoreply string&!! unset
24000 This specifies recipients of the message and the contents of the &'To:'& header
24001 when the message is specified by the transport.
24002 .ecindex IIDauttra1
24003 .ecindex IIDauttra2
24004
24005
24006
24007
24008 . ////////////////////////////////////////////////////////////////////////////
24009 . ////////////////////////////////////////////////////////////////////////////
24010
24011 .chapter "The lmtp transport" "CHAPLMTP"
24012 .cindex "transports" "&(lmtp)&"
24013 .cindex "&(lmtp)& transport"
24014 .cindex "LMTP" "over a pipe"
24015 .cindex "LMTP" "over a socket"
24016 The &(lmtp)& transport runs the LMTP protocol (RFC 2033) over a pipe to a
24017 specified command
24018 or by interacting with a Unix domain socket.
24019 This transport is something of a cross between the &(pipe)& and &(smtp)&
24020 transports. Exim also has support for using LMTP over TCP/IP; this is
24021 implemented as an option for the &(smtp)& transport. Because LMTP is expected
24022 to be of minority interest, the default build-time configure in &_src/EDITME_&
24023 has it commented out. You need to ensure that
24024 .code
24025 TRANSPORT_LMTP=yes
24026 .endd
24027 .cindex "options" "&(lmtp)& transport"
24028 is present in your &_Local/Makefile_& in order to have the &(lmtp)& transport
24029 included in the Exim binary. The private options of the &(lmtp)& transport are
24030 as follows:
24031
24032 .option batch_id lmtp string&!! unset
24033 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
24034
24035
24036 .option batch_max lmtp integer 1
24037 This limits the number of addresses that can be handled in a single delivery.
24038 Most LMTP servers can handle several addresses at once, so it is normally a
24039 good idea to increase this value. See the description of local delivery
24040 batching in chapter &<<CHAPbatching>>&.
24041
24042
24043 .option command lmtp string&!! unset
24044 This option must be set if &%socket%& is not set. The string is a command which
24045 is run in a separate process. It is split up into a command name and list of
24046 arguments, each of which is separately expanded (so expansion cannot change the
24047 number of arguments). The command is run directly, not via a shell. The message
24048 is passed to the new process using the standard input and output to operate the
24049 LMTP protocol.
24050
24051 .option ignore_quota lmtp boolean false
24052 .cindex "LMTP" "ignoring quota errors"
24053 If this option is set true, the string &`IGNOREQUOTA`& is added to RCPT
24054 commands, provided that the LMTP server has advertised support for IGNOREQUOTA
24055 in its response to the LHLO command.
24056
24057 .option socket lmtp string&!! unset
24058 This option must be set if &%command%& is not set. The result of expansion must
24059 be the name of a Unix domain socket. The transport connects to the socket and
24060 delivers the message to it using the LMTP protocol.
24061
24062
24063 .option timeout lmtp time 5m
24064 The transport is aborted if the created process or Unix domain socket does not
24065 respond to LMTP commands or message input within this timeout. Delivery
24066 is deferred, and will be tried again later. Here is an example of a typical
24067 LMTP transport:
24068 .code
24069 lmtp:
24070   driver = lmtp
24071   command = /some/local/lmtp/delivery/program
24072   batch_max = 20
24073   user = exim
24074 .endd
24075 This delivers up to 20 addresses at a time, in a mixture of domains if
24076 necessary, running as the user &'exim'&.
24077
24078
24079
24080 . ////////////////////////////////////////////////////////////////////////////
24081 . ////////////////////////////////////////////////////////////////////////////
24082
24083 .chapter "The pipe transport" "CHAPpipetransport"
24084 .scindex IIDpiptra1 "transports" "&(pipe)&"
24085 .scindex IIDpiptra2 "&(pipe)& transport"
24086 The &(pipe)& transport is used to deliver messages via a pipe to a command
24087 running in another process. One example is the use of &(pipe)& as a
24088 pseudo-remote transport for passing messages to some other delivery mechanism
24089 (such as UUCP). Another is the use by individual users to automatically process
24090 their incoming messages. The &(pipe)& transport can be used in one of the
24091 following ways:
24092
24093 .ilist
24094 .vindex "&$local_part$&"
24095 A router routes one address to a transport in the normal way, and the
24096 transport is configured as a &(pipe)& transport. In this case, &$local_part$&
24097 contains the local part of the address (as usual), and the command that is run
24098 is specified by the &%command%& option on the transport.
24099 .next
24100 .vindex "&$pipe_addresses$&"
24101 If the &%batch_max%& option is set greater than 1 (the default is 1), the
24102 transport can handle more than one address in a single run. In this case, when
24103 more than one address is routed to the transport, &$local_part$& is not set
24104 (because it is not unique). However, the pseudo-variable &$pipe_addresses$&
24105 (described in section &<<SECThowcommandrun>>& below) contains all the addresses
24106 that are routed to the transport.
24107 .next
24108 .vindex "&$address_pipe$&"
24109 A router redirects an address directly to a pipe command (for example, from an
24110 alias or forward file). In this case, &$address_pipe$& contains the text of the
24111 pipe command, and the &%command%& option on the transport is ignored unless
24112 &%force_command%& is set. If only one address is being transported
24113 (&%batch_max%& is not greater than one, or only one address was redirected to
24114 this pipe command), &$local_part$& contains the local part that was redirected.
24115 .endlist
24116
24117
24118 The &(pipe)& transport is a non-interactive delivery method. Exim can also
24119 deliver messages over pipes using the LMTP interactive protocol. This is
24120 implemented by the &(lmtp)& transport.
24121
24122 In the case when &(pipe)& is run as a consequence of an entry in a local user's
24123 &_.forward_& file, the command runs under the uid and gid of that user. In
24124 other cases, the uid and gid have to be specified explicitly, either on the
24125 transport or on the router that handles the address. Current and &"home"&
24126 directories are also controllable. See chapter &<<CHAPenvironment>>& for
24127 details of the local delivery environment and chapter &<<CHAPbatching>>&
24128 for a discussion of local delivery batching.
24129
24130 .new
24131 .cindex "tainted data" "in pipe command"
24132 .cindex pipe "tainted data"
24133 Tainted data may not be used for the command name.
24134 .wen
24135
24136
24137 .section "Concurrent delivery" "SECID140"
24138 If two messages arrive at almost the same time, and both are routed to a pipe
24139 delivery, the two pipe transports may be run concurrently. You must ensure that
24140 any pipe commands you set up are robust against this happening. If the commands
24141 write to a file, the &%exim_lock%& utility might be of use.
24142 Alternatively the &%max_parallel%& option could be used with a value
24143 of "1" to enforce serialization.
24144
24145
24146
24147
24148 .section "Returned status and data" "SECID141"
24149 .cindex "&(pipe)& transport" "returned data"
24150 If the command exits with a non-zero return code, the delivery is deemed to
24151 have failed, unless either the &%ignore_status%& option is set (in which case
24152 the return code is treated as zero), or the return code is one of those listed
24153 in the &%temp_errors%& option, which are interpreted as meaning &"try again
24154 later"&. In this case, delivery is deferred. Details of a permanent failure are
24155 logged, but are not included in the bounce message, which merely contains
24156 &"local delivery failed"&.
24157
24158 If the command exits on a signal and the &%freeze_signal%& option is set then
24159 the message will be frozen in the queue. If that option is not set, a bounce
24160 will be sent as normal.
24161
24162 If the return code is greater than 128 and the command being run is a shell
24163 script, it normally means that the script was terminated by a signal whose
24164 value is the return code minus 128. The &%freeze_signal%& option does not
24165 apply in this case.
24166
24167 If Exim is unable to run the command (that is, if &[execve()]& fails), the
24168 return code is set to 127. This is the value that a shell returns if it is
24169 asked to run a non-existent command. The wording for the log line suggests that
24170 a non-existent command may be the problem.
24171
24172 The &%return_output%& option can affect the result of a pipe delivery. If it is
24173 set and the command produces any output on its standard output or standard
24174 error streams, the command is considered to have failed, even if it gave a zero
24175 return code or if &%ignore_status%& is set. The output from the command is
24176 included as part of the bounce message. The &%return_fail_output%& option is
24177 similar, except that output is returned only when the command exits with a
24178 failure return code, that is, a value other than zero or a code that matches
24179 &%temp_errors%&.
24180
24181
24182
24183 .section "How the command is run" "SECThowcommandrun"
24184 .cindex "&(pipe)& transport" "path for command"
24185 The command line is (by default) broken down into a command name and arguments
24186 by the &(pipe)& transport itself. The &%allow_commands%& and
24187 &%restrict_to_path%& options can be used to restrict the commands that may be
24188 run.
24189
24190 .cindex "quoting" "in pipe command"
24191 Unquoted arguments are delimited by white space. If an argument appears in
24192 double quotes, backslash is interpreted as an escape character in the usual
24193 way. If an argument appears in single quotes, no escaping is done.
24194
24195 String expansion is applied to the command line except when it comes from a
24196 traditional &_.forward_& file (commands from a filter file are expanded). The
24197 expansion is applied to each argument in turn rather than to the whole line.
24198 For this reason, any string expansion item that contains white space must be
24199 quoted so as to be contained within a single argument. A setting such as
24200 .code
24201 command = /some/path ${if eq{$local_part}{postmaster}{xx}{yy}}
24202 .endd
24203 will not work, because the expansion item gets split between several
24204 arguments. You have to write
24205 .code
24206 command = /some/path "${if eq{$local_part}{postmaster}{xx}{yy}}"
24207 .endd
24208 to ensure that it is all in one argument. The expansion is done in this way,
24209 argument by argument, so that the number of arguments cannot be changed as a
24210 result of expansion, and quotes or backslashes in inserted variables do not
24211 interact with external quoting. However, this leads to problems if you want to
24212 generate multiple arguments (or the command name plus arguments) from a single
24213 expansion. In this situation, the simplest solution is to use a shell. For
24214 example:
24215 .code
24216 command = /bin/sh -c ${lookup{$local_part}lsearch{/some/file}}
24217 .endd
24218
24219 .cindex "transport" "filter"
24220 .cindex "filter" "transport filter"
24221 .vindex "&$pipe_addresses$&"
24222 Special handling takes place when an argument consists of precisely the text
24223 &`$pipe_addresses`& (no quotes).
24224 This is not a general expansion variable; the only
24225 place this string is recognized is when it appears as an argument for a pipe or
24226 transport filter command. It causes each address that is being handled to be
24227 inserted in the argument list at that point &'as a separate argument'&. This
24228 avoids any problems with spaces or shell metacharacters, and is of use when a
24229 &(pipe)& transport is handling groups of addresses in a batch.
24230
24231 If &%force_command%& is enabled on the transport, special handling takes place
24232 for an argument that consists of precisely the text &`$address_pipe`&.  It
24233 is handled similarly to &$pipe_addresses$& above.  It is expanded and each
24234 argument is inserted in the argument list at that point
24235 &'as a separate argument'&.  The &`$address_pipe`& item does not need to be
24236 the only item in the argument; in fact, if it were then &%force_command%&
24237 should behave as a no-op.  Rather, it should be used to adjust the command
24238 run while preserving the argument vector separation.
24239
24240 After splitting up into arguments and expansion, the resulting command is run
24241 in a subprocess directly from the transport, &'not'& under a shell. The
24242 message that is being delivered is supplied on the standard input, and the
24243 standard output and standard error are both connected to a single pipe that is
24244 read by Exim. The &%max_output%& option controls how much output the command
24245 may produce, and the &%return_output%& and &%return_fail_output%& options
24246 control what is done with it.
24247
24248 Not running the command under a shell (by default) lessens the security risks
24249 in cases when a command from a user's filter file is built out of data that was
24250 taken from an incoming message. If a shell is required, it can of course be
24251 explicitly specified as the command to be run. However, there are circumstances
24252 where existing commands (for example, in &_.forward_& files) expect to be run
24253 under a shell and cannot easily be modified. To allow for these cases, there is
24254 an option called &%use_shell%&, which changes the way the &(pipe)& transport
24255 works. Instead of breaking up the command line as just described, it expands it
24256 as a single string and passes the result to &_/bin/sh_&. The
24257 &%restrict_to_path%& option and the &$pipe_addresses$& facility cannot be used
24258 with &%use_shell%&, and the whole mechanism is inherently less secure.
24259
24260
24261
24262 .section "Environment variables" "SECTpipeenv"
24263 .cindex "&(pipe)& transport" "environment for command"
24264 .cindex "environment" "&(pipe)& transport"
24265 The environment variables listed below are set up when the command is invoked.
24266 This list is a compromise for maximum compatibility with other MTAs. Note that
24267 the &%environment%& option can be used to add additional variables to this
24268 environment. The environment for the &(pipe)& transport is not subject
24269 to the &%add_environment%& and &%keep_environment%& main config options.
24270 .display
24271 &`DOMAIN            `&   the domain of the address
24272 &`HOME              `&   the home directory, if set
24273 &`HOST              `&   the host name when called from a router (see below)
24274 &`LOCAL_PART        `&   see below
24275 &`LOCAL_PART_PREFIX `&   see below
24276 &`LOCAL_PART_SUFFIX `&   see below
24277 &`LOGNAME           `&   see below
24278 &`MESSAGE_ID        `&   Exim's local ID for the message
24279 &`PATH              `&   as specified by the &%path%& option below
24280 &`QUALIFY_DOMAIN    `&   the sender qualification domain
24281 &`RECIPIENT         `&   the complete recipient address
24282 &`SENDER            `&   the sender of the message (empty if a bounce)
24283 &`SHELL             `&   &`/bin/sh`&
24284 &`TZ                `&   the value of the &%timezone%& option, if set
24285 &`USER              `&   see below
24286 .endd
24287 When a &(pipe)& transport is called directly from (for example) an &(accept)&
24288 router, LOCAL_PART is set to the local part of the address. When it is
24289 called as a result of a forward or alias expansion, LOCAL_PART is set to
24290 the local part of the address that was expanded. In both cases, any affixes are
24291 removed from the local part, and made available in LOCAL_PART_PREFIX and
24292 LOCAL_PART_SUFFIX, respectively. LOGNAME and USER are set to the
24293 same value as LOCAL_PART for compatibility with other MTAs.
24294
24295 .cindex "HOST"
24296 HOST is set only when a &(pipe)& transport is called from a router that
24297 associates hosts with an address, typically when using &(pipe)& as a
24298 pseudo-remote transport. HOST is set to the first host name specified by
24299 the router.
24300
24301 .cindex "HOME"
24302 If the transport's generic &%home_directory%& option is set, its value is used
24303 for the HOME environment variable. Otherwise, a home directory may be set
24304 by the router's &%transport_home_directory%& option, which defaults to the
24305 user's home directory if &%check_local_user%& is set.
24306
24307
24308 .section "Private options for pipe" "SECID142"
24309 .cindex "options" "&(pipe)& transport"
24310
24311
24312
24313 .option allow_commands pipe "string list&!!" unset
24314 .cindex "&(pipe)& transport" "permitted commands"
24315 The string is expanded, and is then interpreted as a colon-separated list of
24316 permitted commands. If &%restrict_to_path%& is not set, the only commands
24317 permitted are those in the &%allow_commands%& list. They need not be absolute
24318 paths; the &%path%& option is still used for relative paths. If
24319 &%restrict_to_path%& is set with &%allow_commands%&, the command must either be
24320 in the &%allow_commands%& list, or a name without any slashes that is found on
24321 the path. In other words, if neither &%allow_commands%& nor
24322 &%restrict_to_path%& is set, there is no restriction on the command, but
24323 otherwise only commands that are permitted by one or the other are allowed. For
24324 example, if
24325 .code
24326 allow_commands = /usr/bin/vacation
24327 .endd
24328 and &%restrict_to_path%& is not set, the only permitted command is
24329 &_/usr/bin/vacation_&. The &%allow_commands%& option may not be set if
24330 &%use_shell%& is set.
24331
24332
24333 .option batch_id pipe string&!! unset
24334 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
24335
24336
24337 .option batch_max pipe integer 1
24338 This limits the number of addresses that can be handled in a single delivery.
24339 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
24340
24341
24342 .option check_string pipe string unset
24343 As &(pipe)& writes the message, the start of each line is tested for matching
24344 &%check_string%&, and if it does, the initial matching characters are replaced
24345 by the contents of &%escape_string%&, provided both are set. The value of
24346 &%check_string%& is a literal string, not a regular expression, and the case of
24347 any letters it contains is significant. When &%use_bsmtp%& is set, the contents
24348 of &%check_string%& and &%escape_string%& are forced to values that implement
24349 the SMTP escaping protocol. Any settings made in the configuration file are
24350 ignored.
24351
24352
24353 .option command pipe string&!! unset
24354 This option need not be set when &(pipe)& is being used to deliver to pipes
24355 obtained directly from address redirections. In other cases, the option must be
24356 set, to provide a command to be run. It need not yield an absolute path (see
24357 the &%path%& option below). The command is split up into separate arguments by
24358 Exim, and each argument is separately expanded, as described in section
24359 &<<SECThowcommandrun>>& above.
24360
24361
24362 .option environment pipe string&!! unset
24363 .cindex "&(pipe)& transport" "environment for command"
24364 .cindex "environment" "&(pipe)& transport"
24365 This option is used to add additional variables to the environment in which the
24366 command runs (see section &<<SECTpipeenv>>& for the default list). Its value is
24367 a string which is expanded, and then interpreted as a colon-separated list of
24368 environment settings of the form <&'name'&>=<&'value'&>.
24369
24370
24371 .option escape_string pipe string unset
24372 See &%check_string%& above.
24373
24374
24375 .option freeze_exec_fail pipe boolean false
24376 .cindex "exec failure"
24377 .cindex "failure of exec"
24378 .cindex "&(pipe)& transport" "failure of exec"
24379 Failure to exec the command in a pipe transport is by default treated like
24380 any other failure while running the command. However, if &%freeze_exec_fail%&
24381 is set, failure to exec is treated specially, and causes the message to be
24382 frozen, whatever the setting of &%ignore_status%&.
24383
24384
24385 .option freeze_signal pipe boolean false
24386 .cindex "signal exit"
24387 .cindex "&(pipe)& transport", "signal exit"
24388 Normally if the process run by a command in a pipe transport exits on a signal,
24389 a bounce message is sent. If &%freeze_signal%& is set, the message will be
24390 frozen in Exim's queue instead.
24391
24392
24393 .option force_command pipe boolean false
24394 .cindex "force command"
24395 .cindex "&(pipe)& transport", "force command"
24396 Normally when a router redirects an address directly to a pipe command
24397 the &%command%& option on the transport is ignored.  If &%force_command%&
24398 is set, the &%command%& option will used. This is especially
24399 useful for forcing a wrapper or additional argument to be added to the
24400 command. For example:
24401 .code
24402 command = /usr/bin/remote_exec myhost -- $address_pipe
24403 force_command
24404 .endd
24405
24406 Note that &$address_pipe$& is handled specially in &%command%& when
24407 &%force_command%& is set, expanding out to the original argument vector as
24408 separate items, similarly to a Unix shell &`"$@"`& construct.
24409
24410
24411 .option ignore_status pipe boolean false
24412 If this option is true, the status returned by the subprocess that is set up to
24413 run the command is ignored, and Exim behaves as if zero had been returned.
24414 Otherwise, a non-zero status or termination by signal causes an error return
24415 from the transport unless the status value is one of those listed in
24416 &%temp_errors%&; these cause the delivery to be deferred and tried again later.
24417
24418 &*Note*&: This option does not apply to timeouts, which do not return a status.
24419 See the &%timeout_defer%& option for how timeouts are handled.
24420
24421
24422 .option log_defer_output pipe boolean false
24423 .cindex "&(pipe)& transport" "logging output"
24424 If this option is set, and the status returned by the command is
24425 one of the codes listed in &%temp_errors%& (that is, delivery was deferred),
24426 and any output was produced on stdout or stderr, the first line of it is
24427 written to the main log.
24428
24429
24430 .option log_fail_output pipe boolean false
24431 If this option is set, and the command returns any output on stdout or
24432 stderr, and also ends with a return code that is neither zero nor one of
24433 the return codes listed in &%temp_errors%& (that is, the delivery
24434 failed), the first line of output is written to the main log. This
24435 option and &%log_output%& are mutually exclusive.  Only one of them may
24436 be set.
24437
24438
24439 .option log_output pipe boolean false
24440 If this option is set and the command returns any output on stdout or
24441 stderr, the first line of output is written to the main log, whatever
24442 the return code. This option and &%log_fail_output%& are mutually
24443 exclusive. Only one of them may be set.
24444
24445
24446 .option max_output pipe integer 20K
24447 This specifies the maximum amount of output that the command may produce on its
24448 standard output and standard error file combined. If the limit is exceeded, the
24449 process running the command is killed. This is intended as a safety measure to
24450 catch runaway processes. The limit is applied independently of the settings of
24451 the options that control what is done with such output (for example,
24452 &%return_output%&). Because of buffering effects, the amount of output may
24453 exceed the limit by a small amount before Exim notices.
24454
24455
24456 .option message_prefix pipe string&!! "see below"
24457 The string specified here is expanded and output at the start of every message.
24458 The default is unset if &%use_bsmtp%& is set. Otherwise it is
24459 .code
24460 message_prefix = \
24461   From ${if def:return_path{$return_path}{MAILER-DAEMON}}\
24462   ${tod_bsdinbox}\n
24463 .endd
24464 .cindex "Cyrus"
24465 .cindex "&%tmail%&"
24466 .cindex "&""From""& line"
24467 This is required by the commonly used &_/usr/bin/vacation_& program.
24468 However, it must &'not'& be present if delivery is to the Cyrus IMAP server,
24469 or to the &%tmail%& local delivery agent. The prefix can be suppressed by
24470 setting
24471 .code
24472 message_prefix =
24473 .endd
24474 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
24475 &`\n`& to &`\r\n`& in &%message_prefix%&.
24476
24477
24478 .option message_suffix pipe string&!! "see below"
24479 The string specified here is expanded and output at the end of every message.
24480 The default is unset if &%use_bsmtp%& is set. Otherwise it is a single newline.
24481 The suffix can be suppressed by setting
24482 .code
24483 message_suffix =
24484 .endd
24485 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
24486 &`\n`& to &`\r\n`& in &%message_suffix%&.
24487
24488
24489 .option path pipe string&!! "/bin:/usr/bin"
24490 This option is expanded and
24491 specifies the string that is set up in the PATH environment
24492 variable of the subprocess.
24493 If the &%command%& option does not yield an absolute path name, the command is
24494 sought in the PATH directories, in the usual way. &*Warning*&: This does not
24495 apply to a command specified as a transport filter.
24496
24497
24498 .option permit_coredump pipe boolean false
24499 Normally Exim inhibits core-dumps during delivery.  If you have a need to get
24500 a core-dump of a pipe command, enable this command.  This enables core-dumps
24501 during delivery and affects both the Exim binary and the pipe command run.
24502 It is recommended that this option remain off unless and until you have a need
24503 for it and that this only be enabled when needed, as the risk of excessive
24504 resource consumption can be quite high.  Note also that Exim is typically
24505 installed as a setuid binary and most operating systems will inhibit coredumps
24506 of these by default, so further OS-specific action may be required.
24507
24508
24509 .option pipe_as_creator pipe boolean false
24510 .cindex "uid (user id)" "local delivery"
24511 If the generic &%user%& option is not set and this option is true, the delivery
24512 process is run under the uid that was in force when Exim was originally called
24513 to accept the message. If the group id is not otherwise set (via the generic
24514 &%group%& option), the gid that was in force when Exim was originally called to
24515 accept the message is used.
24516
24517
24518 .option restrict_to_path pipe boolean false
24519 When this option is set, any command name not listed in &%allow_commands%& must
24520 contain no slashes. The command is searched for only in the directories listed
24521 in the &%path%& option. This option is intended for use in the case when a pipe
24522 command has been generated from a user's &_.forward_& file. This is usually
24523 handled by a &(pipe)& transport called &%address_pipe%&.
24524
24525
24526 .option return_fail_output pipe boolean false
24527 If this option is true, and the command produced any output and ended with a
24528 return code other than zero or one of the codes listed in &%temp_errors%& (that
24529 is, the delivery failed), the output is returned in the bounce message.
24530 However, if the message has a null sender (that is, it is itself a bounce
24531 message), output from the command is discarded. This option and
24532 &%return_output%& are mutually exclusive. Only one of them may be set.
24533
24534
24535
24536 .option return_output pipe boolean false
24537 If this option is true, and the command produced any output, the delivery is
24538 deemed to have failed whatever the return code from the command, and the output
24539 is returned in the bounce message. Otherwise, the output is just discarded.
24540 However, if the message has a null sender (that is, it is a bounce message),
24541 output from the command is always discarded, whatever the setting of this
24542 option. This option and &%return_fail_output%& are mutually exclusive. Only one
24543 of them may be set.
24544
24545
24546
24547 .option temp_errors pipe "string list" "see below"
24548 .cindex "&(pipe)& transport" "temporary failure"
24549 This option contains either a colon-separated list of numbers, or a single
24550 asterisk. If &%ignore_status%& is false
24551 and &%return_output%& is not set,
24552 and the command exits with a non-zero return code, the failure is treated as
24553 temporary and the delivery is deferred if the return code matches one of the
24554 numbers, or if the setting is a single asterisk. Otherwise, non-zero return
24555 codes are treated as permanent errors. The default setting contains the codes
24556 defined by EX_TEMPFAIL and EX_CANTCREAT in &_sysexits.h_&. If Exim is
24557 compiled on a system that does not define these macros, it assumes values of 75
24558 and 73, respectively.
24559
24560
24561 .option timeout pipe time 1h
24562 If the command fails to complete within this time, it is killed. This normally
24563 causes the delivery to fail (but see &%timeout_defer%&). A zero time interval
24564 specifies no timeout. In order to ensure that any subprocesses created by the
24565 command are also killed, Exim makes the initial process a process group leader,
24566 and kills the whole process group on a timeout. However, this can be defeated
24567 if one of the processes starts a new process group.
24568
24569 .option timeout_defer pipe boolean false
24570 A timeout in a &(pipe)& transport, either in the command that the transport
24571 runs, or in a transport filter that is associated with it, is by default
24572 treated as a hard error, and the delivery fails. However, if &%timeout_defer%&
24573 is set true, both kinds of timeout become temporary errors, causing the
24574 delivery to be deferred.
24575
24576 .option umask pipe "octal integer" 022
24577 This specifies the umask setting for the subprocess that runs the command.
24578
24579
24580 .option use_bsmtp pipe boolean false
24581 .cindex "envelope sender"
24582 If this option is set true, the &(pipe)& transport writes messages in &"batch
24583 SMTP"& format, with the envelope sender and recipient(s) included as SMTP
24584 commands. If you want to include a leading HELO command with such messages,
24585 you can do so by setting the &%message_prefix%& option. See section
24586 &<<SECTbatchSMTP>>& for details of batch SMTP.
24587
24588 .option use_classresources pipe boolean false
24589 .cindex "class resources (BSD)"
24590 This option is available only when Exim is running on FreeBSD, NetBSD, or
24591 BSD/OS. If it is set true, the &[setclassresources()]& function is used to set
24592 resource limits when a &(pipe)& transport is run to perform a delivery. The
24593 limits for the uid under which the pipe is to run are obtained from the login
24594 class database.
24595
24596
24597 .option use_crlf pipe boolean false
24598 .cindex "carriage return"
24599 .cindex "linefeed"
24600 This option causes lines to be terminated with the two-character CRLF sequence
24601 (carriage return, linefeed) instead of just a linefeed character. In the case
24602 of batched SMTP, the byte sequence written to the pipe is then an exact image
24603 of what would be sent down a real SMTP connection.
24604
24605 The contents of the &%message_prefix%& and &%message_suffix%& options are
24606 written verbatim, so must contain their own carriage return characters if these
24607 are needed. When &%use_bsmtp%& is not set, the default values for both
24608 &%message_prefix%& and &%message_suffix%& end with a single linefeed, so their
24609 values must be changed to end with &`\r\n`& if &%use_crlf%& is set.
24610
24611
24612 .option use_shell pipe boolean false
24613 .vindex "&$pipe_addresses$&"
24614 If this option is set, it causes the command to be passed to &_/bin/sh_&
24615 instead of being run directly from the transport, as described in section
24616 &<<SECThowcommandrun>>&. This is less secure, but is needed in some situations
24617 where the command is expected to be run under a shell and cannot easily be
24618 modified. The &%allow_commands%& and &%restrict_to_path%& options, and the
24619 &`$pipe_addresses`& facility are incompatible with &%use_shell%&. The
24620 command is expanded as a single string, and handed to &_/bin/sh_& as data for
24621 its &%-c%& option.
24622
24623
24624
24625 .section "Using an external local delivery agent" "SECID143"
24626 .cindex "local delivery" "using an external agent"
24627 .cindex "&'procmail'&"
24628 .cindex "external local delivery"
24629 .cindex "delivery" "&'procmail'&"
24630 .cindex "delivery" "by external agent"
24631 The &(pipe)& transport can be used to pass all messages that require local
24632 delivery to a separate local delivery agent such as &%procmail%&. When doing
24633 this, care must be taken to ensure that the pipe is run under an appropriate
24634 uid and gid. In some configurations one wants this to be a uid that is trusted
24635 by the delivery agent to supply the correct sender of the message. It may be
24636 necessary to recompile or reconfigure the delivery agent so that it trusts an
24637 appropriate user. The following is an example transport and router
24638 configuration for &%procmail%&:
24639 .code
24640 # transport
24641 procmail_pipe:
24642   driver = pipe
24643   command = /usr/local/bin/procmail -d $local_part_data
24644   return_path_add
24645   delivery_date_add
24646   envelope_to_add
24647   check_string = "From "
24648   escape_string = ">From "
24649   umask = 077
24650   user = $local_part_data
24651   group = mail
24652
24653 # router
24654 procmail:
24655   driver = accept
24656   check_local_user
24657   transport = procmail_pipe
24658 .endd
24659 In this example, the pipe is run as the local user, but with the group set to
24660 &'mail'&. An alternative is to run the pipe as a specific user such as &'mail'&
24661 or &'exim'&, but in this case you must arrange for &%procmail%& to trust that
24662 user to supply a correct sender address. If you do not specify either a
24663 &%group%& or a &%user%& option, the pipe command is run as the local user. The
24664 home directory is the user's home directory by default.
24665
24666 &*Note*&: The command that the pipe transport runs does &'not'& begin with
24667 .code
24668 IFS=" "
24669 .endd
24670 as shown in some &%procmail%& documentation, because Exim does not by default
24671 use a shell to run pipe commands.
24672
24673 .cindex "Cyrus"
24674 The next example shows a transport and a router for a system where local
24675 deliveries are handled by the Cyrus IMAP server.
24676 .code
24677 # transport
24678 local_delivery_cyrus:
24679   driver = pipe
24680   command = /usr/cyrus/bin/deliver \
24681             -m ${substr_1:$local_part_suffix} -- $local_part
24682   user = cyrus
24683   group = mail
24684   return_output
24685   log_output
24686   message_prefix =
24687   message_suffix =
24688
24689 # router
24690 local_user_cyrus:
24691   driver = accept
24692   check_local_user
24693   local_part_suffix = .*
24694   transport = local_delivery_cyrus
24695 .endd
24696 Note the unsetting of &%message_prefix%& and &%message_suffix%&, and the use of
24697 &%return_output%& to cause any text written by Cyrus to be returned to the
24698 sender.
24699 .ecindex IIDpiptra1
24700 .ecindex IIDpiptra2
24701
24702
24703 . ////////////////////////////////////////////////////////////////////////////
24704 . ////////////////////////////////////////////////////////////////////////////
24705
24706 .chapter "The smtp transport" "CHAPsmtptrans"
24707 .scindex IIDsmttra1 "transports" "&(smtp)&"
24708 .scindex IIDsmttra2 "&(smtp)& transport"
24709 The &(smtp)& transport delivers messages over TCP/IP connections using the SMTP
24710 or LMTP protocol. The list of hosts to try can either be taken from the address
24711 that is being processed (having been set up by the router), or specified
24712 explicitly for the transport. Timeout and retry processing (see chapter
24713 &<<CHAPretry>>&) is applied to each IP address independently.
24714
24715
24716 .section "Multiple messages on a single connection" "SECID144"
24717 The sending of multiple messages over a single TCP/IP connection can arise in
24718 two ways:
24719
24720 .ilist
24721 If a message contains more than &%max_rcpt%& (see below) addresses that are
24722 routed to the same host, more than one copy of the message has to be sent to
24723 that host. In this situation, multiple copies may be sent in a single run of
24724 the &(smtp)& transport over a single TCP/IP connection. (What Exim actually
24725 does when it has too many addresses to send in one message also depends on the
24726 value of the global &%remote_max_parallel%& option. Details are given in
24727 section &<<SECToutSMTPTCP>>&.)
24728 .next
24729 .cindex "hints database" "remembering routing"
24730 When a message has been successfully delivered over a TCP/IP connection, Exim
24731 looks in its hints database to see if there are any other messages awaiting a
24732 connection to the same host. If there are, a new delivery process is started
24733 for one of them, and the current TCP/IP connection is passed on to it. The new
24734 process may in turn send multiple copies and possibly create yet another
24735 process.
24736 .endlist
24737
24738
24739 For each copy sent over the same TCP/IP connection, a sequence counter is
24740 incremented, and if it ever gets to the value of &%connection_max_messages%&,
24741 no further messages are sent over that connection.
24742
24743
24744
24745 .section "Use of the $host and $host_address variables" "SECID145"
24746 .vindex "&$host$&"
24747 .vindex "&$host_address$&"
24748 At the start of a run of the &(smtp)& transport, the values of &$host$& and
24749 &$host_address$& are the name and IP address of the first host on the host list
24750 passed by the router. However, when the transport is about to connect to a
24751 specific host, and while it is connected to that host, &$host$& and
24752 &$host_address$& are set to the values for that host. These are the values
24753 that are in force when the &%helo_data%&, &%hosts_try_auth%&, &%interface%&,
24754 &%serialize_hosts%&, and the various TLS options are expanded.
24755
24756
24757 .section "Use of $tls_cipher and $tls_peerdn" "usecippeer"
24758 .vindex &$tls_bits$&
24759 .vindex &$tls_cipher$&
24760 .vindex &$tls_peerdn$&
24761 .vindex &$tls_sni$&
24762 At the start of a run of the &(smtp)& transport, the values of &$tls_bits$&,
24763 &$tls_cipher$&, &$tls_peerdn$& and &$tls_sni$&
24764 are the values that were set when the message was received.
24765 These are the values that are used for options that are expanded before any
24766 SMTP connections are made. Just before each connection is made, these four
24767 variables are emptied. If TLS is subsequently started, they are set to the
24768 appropriate values for the outgoing connection, and these are the values that
24769 are in force when any authenticators are run and when the
24770 &%authenticated_sender%& option is expanded.
24771
24772 These variables are deprecated in favour of &$tls_in_cipher$& et. al.
24773 and will be removed in a future release.
24774
24775
24776 .section "Private options for smtp" "SECID146"
24777 .cindex "options" "&(smtp)& transport"
24778 The private options of the &(smtp)& transport are as follows:
24779
24780
24781 .option address_retry_include_sender smtp boolean true
24782 .cindex "4&'xx'& responses" "retrying after"
24783 When an address is delayed because of a 4&'xx'& response to a RCPT command, it
24784 is the combination of sender and recipient that is delayed in subsequent queue
24785 runs until the retry time is reached. You can delay the recipient without
24786 reference to the sender (which is what earlier versions of Exim did), by
24787 setting &%address_retry_include_sender%& false. However, this can lead to
24788 problems with servers that regularly issue 4&'xx'& responses to RCPT commands.
24789
24790 .option allow_localhost smtp boolean false
24791 .cindex "local host" "sending to"
24792 .cindex "fallback" "hosts specified on transport"
24793 When a host specified in &%hosts%& or &%fallback_hosts%& (see below) turns out
24794 to be the local host, or is listed in &%hosts_treat_as_local%&, delivery is
24795 deferred by default. However, if &%allow_localhost%& is set, Exim goes on to do
24796 the delivery anyway. This should be used only in special cases when the
24797 configuration ensures that no looping will result (for example, a differently
24798 configured Exim is listening on the port to which the message is sent).
24799
24800
24801 .option authenticated_sender smtp string&!! unset
24802 .cindex "Cyrus"
24803 When Exim has authenticated as a client, or if &%authenticated_sender_force%&
24804 is true, this option sets a value for the AUTH= item on outgoing MAIL commands,
24805 overriding any existing authenticated sender value. If the string expansion is
24806 forced to fail, the option is ignored. Other expansion failures cause delivery
24807 to be deferred. If the result of expansion is an empty string, that is also
24808 ignored.
24809
24810 The expansion happens after the outgoing connection has been made and TLS
24811 started, if required. This means that the &$host$&, &$host_address$&,
24812 &$tls_out_cipher$&, and &$tls_out_peerdn$& variables are set according to the
24813 particular connection.
24814
24815 If the SMTP session is not authenticated, the expansion of
24816 &%authenticated_sender%& still happens (and can cause the delivery to be
24817 deferred if it fails), but no AUTH= item is added to MAIL commands
24818 unless &%authenticated_sender_force%& is true.
24819
24820 This option allows you to use the &(smtp)& transport in LMTP mode to
24821 deliver mail to Cyrus IMAP and provide the proper local part as the
24822 &"authenticated sender"&, via a setting such as:
24823 .code
24824 authenticated_sender = $local_part
24825 .endd
24826 This removes the need for IMAP subfolders to be assigned special ACLs to
24827 allow direct delivery to those subfolders.
24828
24829 Because of expected uses such as that just described for Cyrus (when no
24830 domain is involved), there is no checking on the syntax of the provided
24831 value.
24832
24833
24834 .option authenticated_sender_force smtp boolean false
24835 If this option is set true, the &%authenticated_sender%& option's value
24836 is used for the AUTH= item on outgoing MAIL commands, even if Exim has not
24837 authenticated as a client.
24838
24839
24840 .option command_timeout smtp time 5m
24841 This sets a timeout for receiving a response to an SMTP command that has been
24842 sent out. It is also used when waiting for the initial banner line from the
24843 remote host. Its value must not be zero.
24844
24845
24846 .option connect_timeout smtp time 5m
24847 This sets a timeout for the &[connect()]& function, which sets up a TCP/IP call
24848 to a remote host. A setting of zero allows the system timeout (typically
24849 several minutes) to act. To have any effect, the value of this option must be
24850 less than the system timeout. However, it has been observed that on some
24851 systems there is no system timeout, which is why the default value for this
24852 option is 5 minutes, a value recommended by RFC 1123.
24853
24854
24855 .option connection_max_messages smtp integer 500
24856 .cindex "SMTP" "passed connection"
24857 .cindex "SMTP" "multiple deliveries"
24858 .cindex "multiple SMTP deliveries"
24859 This controls the maximum number of separate message deliveries that are sent
24860 over a single TCP/IP connection. If the value is zero, there is no limit.
24861 For testing purposes, this value can be overridden by the &%-oB%& command line
24862 option.
24863
24864
24865 .option dane_require_tls_ciphers smtp string&!! unset
24866 .cindex "TLS" "requiring specific ciphers for DANE"
24867 .cindex "cipher" "requiring specific"
24868 .cindex DANE "TLS ciphers"
24869 This option may be used to override &%tls_require_ciphers%& for connections
24870 where DANE has been determined to be in effect.
24871 If not set, then &%tls_require_ciphers%& will be used.
24872 Normal SMTP delivery is not able to make strong demands of TLS cipher
24873 configuration, because delivery will fall back to plaintext.  Once DANE has
24874 been determined to be in effect, there is no plaintext fallback and making the
24875 TLS cipherlist configuration stronger will increase security, rather than
24876 counter-intuitively decreasing it.
24877 If the option expands to be empty or is forced to fail, then it will
24878 be treated as unset and &%tls_require_ciphers%& will be used instead.
24879
24880
24881 .option data_timeout smtp time 5m
24882 This sets a timeout for the transmission of each block in the data portion of
24883 the message. As a result, the overall timeout for a message depends on the size
24884 of the message. Its value must not be zero. See also &%final_timeout%&.
24885
24886
24887 .option dkim_canon smtp string&!! unset
24888 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
24889 .option dkim_domain smtp string list&!! unset
24890 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
24891 .option dkim_hash smtp string&!! sha256
24892 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
24893 .option dkim_identity smtp string&!! unset
24894 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
24895 .option dkim_private_key smtp string&!! unset
24896 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
24897 .option dkim_selector smtp string&!! unset
24898 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
24899 .option dkim_strict smtp string&!! unset
24900 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
24901 .option dkim_sign_headers smtp string&!! "per RFC"
24902 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
24903 .option dkim_timestamps smtp string&!! unset
24904 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
24905
24906
24907 .option delay_after_cutoff smtp boolean true
24908 .cindex "final cutoff" "retries, controlling"
24909 .cindex retry "final cutoff"
24910 This option controls what happens when all remote IP addresses for a given
24911 domain have been inaccessible for so long that they have passed their retry
24912 cutoff times.
24913
24914 In the default state, if the next retry time has not been reached for any of
24915 them, the address is bounced without trying any deliveries. In other words,
24916 Exim delays retrying an IP address after the final cutoff time until a new
24917 retry time is reached, and can therefore bounce an address without ever trying
24918 a delivery, when machines have been down for a long time. Some people are
24919 unhappy at this prospect, so...
24920
24921 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
24922 addresses are past their final cutoff time, Exim tries to deliver to those
24923 IP addresses that have not been tried since the message arrived. If there are
24924 none, of if they all fail, the address is bounced. In other words, it does not
24925 delay when a new message arrives, but immediately tries those expired IP
24926 addresses that haven't been tried since the message arrived. If there is a
24927 continuous stream of messages for the dead hosts, unsetting
24928 &%delay_after_cutoff%& means that there will be many more attempts to deliver
24929 to them.
24930
24931
24932 .option dns_qualify_single smtp boolean true
24933 If the &%hosts%& or &%fallback_hosts%& option is being used,
24934 and the &%gethostbyname%& option is false,
24935 the RES_DEFNAMES resolver option is set. See the &%qualify_single%& option
24936 in chapter &<<CHAPdnslookup>>& for more details.
24937
24938
24939 .option dns_search_parents smtp boolean false
24940 If the &%hosts%& or &%fallback_hosts%& option is being used, and the
24941 &%gethostbyname%& option is false, the RES_DNSRCH resolver option is set.
24942 See the &%search_parents%& option in chapter &<<CHAPdnslookup>>& for more
24943 details.
24944
24945
24946 .option dnssec_request_domains smtp "domain list&!!" *
24947 .cindex "MX record" "security"
24948 .cindex "DNSSEC" "MX lookup"
24949 .cindex "security" "MX lookup"
24950 .cindex "DNS" "DNSSEC"
24951 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
24952 the dnssec request bit set. Setting this transport option is only useful if the
24953 transport overrides or sets the host names. See the &%dnssec_request_domains%&
24954 router option.
24955
24956
24957
24958 .option dnssec_require_domains smtp "domain list&!!" unset
24959 .cindex "MX record" "security"
24960 .cindex "DNSSEC" "MX lookup"
24961 .cindex "security" "MX lookup"
24962 .cindex "DNS" "DNSSEC"
24963 DNS lookups for domains matching &%dnssec_require_domains%& will be done with
24964 the dnssec request bit set.  Setting this transport option is only
24965 useful if the transport overrides or sets the host names. See the
24966 &%dnssec_require_domains%& router option.
24967
24968
24969
24970 .option dscp smtp string&!! unset
24971 .cindex "DCSP" "outbound"
24972 This option causes the DSCP value associated with a socket to be set to one
24973 of a number of fixed strings or to numeric value.
24974 The &%-bI:dscp%& option may be used to ask Exim which names it knows of.
24975 Common values include &`throughput`&, &`mincost`&, and on newer systems
24976 &`ef`&, &`af41`&, etc.  Numeric values may be in the range 0 to 0x3F.
24977
24978 The outbound packets from Exim will be marked with this value in the header
24979 (for IPv4, the TOS field; for IPv6, the TCLASS field); there is no guarantee
24980 that these values will have any effect, not be stripped by networking
24981 equipment, or do much of anything without cooperation with your Network
24982 Engineer and those of all network operators between the source and destination.
24983
24984
24985 .option fallback_hosts smtp "string list" unset
24986 .cindex "fallback" "hosts specified on transport"
24987 String expansion is not applied to this option. The argument must be a
24988 colon-separated list of host names or IP addresses, optionally also including
24989 port numbers, though the separator can be changed, as described in section
24990 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
24991 item in a &%route_list%& setting for the &(manualroute)& router, as described
24992 in section &<<SECTformatonehostitem>>&.
24993
24994 Fallback hosts can also be specified on routers, which associate them with the
24995 addresses they process. As for the &%hosts%& option without &%hosts_override%&,
24996 &%fallback_hosts%& specified on the transport is used only if the address does
24997 not have its own associated fallback host list. Unlike &%hosts%&, a setting of
24998 &%fallback_hosts%& on an address is not overridden by &%hosts_override%&.
24999 However, &%hosts_randomize%& does apply to fallback host lists.
25000
25001 If Exim is unable to deliver to any of the hosts for a particular address, and
25002 the errors are not permanent rejections, the address is put on a separate
25003 transport queue with its host list replaced by the fallback hosts, unless the
25004 address was routed via MX records and the current host was in the original MX
25005 list. In that situation, the fallback host list is not used.
25006
25007 Once normal deliveries are complete, the fallback queue is delivered by
25008 re-running the same transports with the new host lists. If several failing
25009 addresses have the same fallback hosts (and &%max_rcpt%& permits it), a single
25010 copy of the message is sent.
25011
25012 The resolution of the host names on the fallback list is controlled by the
25013 &%gethostbyname%& option, as for the &%hosts%& option. Fallback hosts apply
25014 both to cases when the host list comes with the address and when it is taken
25015 from &%hosts%&. This option provides a &"use a smart host only if delivery
25016 fails"& facility.
25017
25018
25019 .option final_timeout smtp time 10m
25020 This is the timeout that applies while waiting for the response to the final
25021 line containing just &"."& that terminates a message. Its value must not be
25022 zero.
25023
25024 .option gethostbyname smtp boolean false
25025 If this option is true when the &%hosts%& and/or &%fallback_hosts%& options are
25026 being used, names are looked up using &[gethostbyname()]&
25027 (or &[getipnodebyname()]& when available)
25028 instead of using the DNS. Of course, that function may in fact use the DNS, but
25029 it may also consult other sources of information such as &_/etc/hosts_&.
25030
25031 .option gnutls_compat_mode smtp boolean unset
25032 This option controls whether GnuTLS is used in compatibility mode in an Exim
25033 server. This reduces security slightly, but improves interworking with older
25034 implementations of TLS.
25035
25036 .option helo_data smtp string&!! "see below"
25037 .cindex "HELO" "argument, setting"
25038 .cindex "EHLO" "argument, setting"
25039 .cindex "LHLO argument setting"
25040 The value of this option is expanded after a connection to a another host has
25041 been set up. The result is used as the argument for the EHLO, HELO, or LHLO
25042 command that starts the outgoing SMTP or LMTP session. The default value of the
25043 option is:
25044 .code
25045 $primary_hostname
25046 .endd
25047 During the expansion, the variables &$host$& and &$host_address$& are set to
25048 the identity of the remote host, and the variables &$sending_ip_address$& and
25049 &$sending_port$& are set to the local IP address and port number that are being
25050 used. These variables can be used to generate different values for different
25051 servers or different local IP addresses. For example, if you want the string
25052 that is used for &%helo_data%& to be obtained by a DNS lookup of the outgoing
25053 interface address, you could use this:
25054 .code
25055 helo_data = ${lookup dnsdb{ptr=$sending_ip_address}{$value}\
25056   {$primary_hostname}}
25057 .endd
25058 The use of &%helo_data%& applies both to sending messages and when doing
25059 callouts.
25060
25061 .option hosts smtp "string list&!!" unset
25062 Hosts are associated with an address by a router such as &(dnslookup)&, which
25063 finds the hosts by looking up the address domain in the DNS, or by
25064 &(manualroute)&, which has lists of hosts in its configuration. However,
25065 email addresses can be passed to the &(smtp)& transport by any router, and not
25066 all of them can provide an associated list of hosts.
25067
25068 The &%hosts%& option specifies a list of hosts to be used if the address being
25069 processed does not have any hosts associated with it. The hosts specified by
25070 &%hosts%& are also used, whether or not the address has its own hosts, if
25071 &%hosts_override%& is set.
25072
25073 The string is first expanded, before being interpreted as a colon-separated
25074 list of host names or IP addresses, possibly including port numbers. The
25075 separator may be changed to something other than colon, as described in section
25076 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
25077 item in a &%route_list%& setting for the &(manualroute)& router, as described
25078 in section &<<SECTformatonehostitem>>&. However, note that the &`/MX`& facility
25079 of the &(manualroute)& router is not available here.
25080
25081 If the expansion fails, delivery is deferred. Unless the failure was caused by
25082 the inability to complete a lookup, the error is logged to the panic log as
25083 well as the main log. Host names are looked up either by searching directly for
25084 address records in the DNS or by calling &[gethostbyname()]& (or
25085 &[getipnodebyname()]& when available), depending on the setting of the
25086 &%gethostbyname%& option. When Exim is compiled with IPv6 support, if a host
25087 that is looked up in the DNS has both IPv4 and IPv6 addresses, both types of
25088 address are used.
25089
25090 During delivery, the hosts are tried in order, subject to their retry status,
25091 unless &%hosts_randomize%& is set.
25092
25093
25094 .option hosts_avoid_esmtp smtp "host list&!!" unset
25095 .cindex "ESMTP, avoiding use of"
25096 .cindex "HELO" "forcing use of"
25097 .cindex "EHLO" "avoiding use of"
25098 .cindex "PIPELINING" "avoiding the use of"
25099 This option is for use with broken hosts that announce ESMTP facilities (for
25100 example, PIPELINING) and then fail to implement them properly. When a host
25101 matches &%hosts_avoid_esmtp%&, Exim sends HELO rather than EHLO at the
25102 start of the SMTP session. This means that it cannot use any of the ESMTP
25103 facilities such as AUTH, PIPELINING, SIZE, and STARTTLS.
25104
25105
25106 .option hosts_avoid_pipelining smtp "host list&!!" unset
25107 .cindex "PIPELINING" "avoiding the use of"
25108 Exim will not use the SMTP PIPELINING extension when delivering to any host
25109 that matches this list, even if the server host advertises PIPELINING support.
25110
25111 .option hosts_pipe_connect smtp "host list&!!" unset
25112 .cindex "pipelining" "early connection"
25113 .cindex "pipelining" PIPE_CONNECT
25114 If Exim is built with the SUPPORT_PIPE_CONNECT build option
25115 this option controls which to hosts the facility watched for
25116 and recorded, and used for subsequent connections.
25117
25118 The retry hints database is used for the record,
25119 and records are subject to the &%retry_data_expire%& option.
25120 When used, the pipelining saves on roundtrip times.
25121 It also turns SMTP into a client-first protocol
25122 so combines well with TCP Fast Open.
25123
25124 See also the &%pipelining_connect_advertise_hosts%& main option.
25125
25126 Note:
25127 When the facility is used, the transport &%helo_data%& option
25128 will be expanded before the &$sending_ip_address$& variable
25129 is filled in.
25130 A check is made for the use of that variable, without the
25131 presence of a &"def:"& test on it, but suitably complex coding
25132 can avoid the check and produce unexpected results.
25133 You have been warned.
25134
25135
25136 .option hosts_avoid_tls smtp "host list&!!" unset
25137 .cindex "TLS" "avoiding for certain hosts"
25138 Exim will not try to start a TLS session when delivering to any host that
25139 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
25140
25141 .option hosts_verify_avoid_tls smtp "host list&!!" unset
25142 .cindex "TLS" "avoiding for certain hosts"
25143 Exim will not try to start a TLS session for a verify callout,
25144 or when delivering in cutthrough mode,
25145 to any host that matches this list.
25146
25147
25148 .option hosts_max_try smtp integer 5
25149 .cindex "host" "maximum number to try"
25150 .cindex "limit" "number of hosts tried"
25151 .cindex "limit" "number of MX tried"
25152 .cindex "MX record" "maximum tried"
25153 This option limits the number of IP addresses that are tried for any one
25154 delivery in cases where there are temporary delivery errors. Section
25155 &<<SECTvalhosmax>>& describes in detail how the value of this option is used.
25156
25157
25158 .option hosts_max_try_hardlimit smtp integer 50
25159 This is an additional check on the maximum number of IP addresses that Exim
25160 tries for any one delivery. Section &<<SECTvalhosmax>>& describes its use and
25161 why it exists.
25162
25163
25164
25165 .option hosts_nopass_tls smtp "host list&!!" unset
25166 .cindex "TLS" "passing connection"
25167 .cindex "multiple SMTP deliveries"
25168 .cindex "TLS" "multiple message deliveries"
25169 For any host that matches this list, a connection on which a TLS session has
25170 been started will not be passed to a new delivery process for sending another
25171 message on the same connection. See section &<<SECTmulmessam>>& for an
25172 explanation of when this might be needed.
25173
25174 .option hosts_noproxy_tls smtp "host list&!!" unset
25175 .cindex "TLS" "passing connection"
25176 .cindex "multiple SMTP deliveries"
25177 .cindex "TLS" "multiple message deliveries"
25178 For any host that matches this list, a TLS session which has
25179 been started will not be passed to a new delivery process for sending another
25180 message on the same session.
25181
25182 The traditional implementation closes down TLS and re-starts it in the new
25183 process, on the same open TCP connection, for each successive message
25184 sent.  If permitted by this option a pipe to to the new process is set up
25185 instead, and the original process maintains the TLS connection and proxies
25186 the SMTP connection from and to the new process and any subsequents.
25187 The new process has no access to TLS information, so cannot include it in
25188 logging.
25189
25190
25191
25192 .option hosts_override smtp boolean false
25193 If this option is set and the &%hosts%& option is also set, any hosts that are
25194 attached to the address are ignored, and instead the hosts specified by the
25195 &%hosts%& option are always used. This option does not apply to
25196 &%fallback_hosts%&.
25197
25198
25199 .option hosts_randomize smtp boolean false
25200 .cindex "randomized host list"
25201 .cindex "host" "list of; randomized"
25202 .cindex "fallback" "randomized hosts"
25203 If this option is set, and either the list of hosts is taken from the
25204 &%hosts%& or the &%fallback_hosts%& option, or the hosts supplied by the router
25205 were not obtained from MX records (this includes fallback hosts from the
25206 router), and were not randomized by the router, the order of trying the hosts
25207 is randomized each time the transport runs. Randomizing the order of a host
25208 list can be used to do crude load sharing.
25209
25210 When &%hosts_randomize%& is true, a host list may be split into groups whose
25211 order is separately randomized. This makes it possible to set up MX-like
25212 behaviour. The boundaries between groups are indicated by an item that is just
25213 &`+`& in the host list. For example:
25214 .code
25215 hosts = host1:host2:host3:+:host4:host5
25216 .endd
25217 The order of the first three hosts and the order of the last two hosts is
25218 randomized for each use, but the first three always end up before the last two.
25219 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored.
25220
25221 .option hosts_require_auth smtp "host list&!!" unset
25222 .cindex "authentication" "required by client"
25223 This option provides a list of servers for which authentication must succeed
25224 before Exim will try to transfer a message. If authentication fails for
25225 servers which are not in this list, Exim tries to send unauthenticated. If
25226 authentication fails for one of these servers, delivery is deferred. This
25227 temporary error is detectable in the retry rules, so it can be turned into a
25228 hard failure if required. See also &%hosts_try_auth%&, and chapter
25229 &<<CHAPSMTPAUTH>>& for details of authentication.
25230
25231
25232 .option hosts_request_ocsp smtp "host list&!!" *
25233 .cindex "TLS" "requiring for certain servers"
25234 Exim will request a Certificate Status on a
25235 TLS session for any host that matches this list.
25236 &%tls_verify_certificates%& should also be set for the transport.
25237
25238 .option hosts_require_dane smtp "host list&!!" unset
25239 .cindex DANE "transport options"
25240 .cindex DANE "requiring for certain servers"
25241 If built with DANE support, Exim  will require that a DNSSEC-validated
25242 TLSA record is present for any host matching the list,
25243 and that a DANE-verified TLS connection is made. See
25244 the &%dnssec_request_domains%& router and transport options.
25245 There will be no fallback to in-clear communication.
25246 See section &<<SECDANE>>&.
25247
25248 .option hosts_require_ocsp smtp "host list&!!" unset
25249 .cindex "TLS" "requiring for certain servers"
25250 Exim will request, and check for a valid Certificate Status being given, on a
25251 TLS session for any host that matches this list.
25252 &%tls_verify_certificates%& should also be set for the transport.
25253
25254 .option hosts_require_tls smtp "host list&!!" unset
25255 .cindex "TLS" "requiring for certain servers"
25256 Exim will insist on using a TLS session when delivering to any host that
25257 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
25258 &*Note*&: This option affects outgoing mail only. To insist on TLS for
25259 incoming messages, use an appropriate ACL.
25260
25261 .option hosts_try_auth smtp "host list&!!" unset
25262 .cindex "authentication" "optional in client"
25263 This option provides a list of servers to which, provided they announce
25264 authentication support, Exim will attempt to authenticate as a client when it
25265 connects. If authentication fails, Exim will try to transfer the message
25266 unauthenticated. See also &%hosts_require_auth%&, and chapter
25267 &<<CHAPSMTPAUTH>>& for details of authentication.
25268
25269 .option hosts_try_chunking smtp "host list&!!" *
25270 .cindex CHUNKING "enabling, in client"
25271 .cindex BDAT "SMTP command"
25272 .cindex "RFC 3030" "CHUNKING"
25273 This option provides a list of servers to which, provided they announce
25274 CHUNKING support, Exim will attempt to use BDAT commands rather than DATA.
25275 .new
25276 Unless DKIM signing is being done,
25277 .wen
25278 BDAT will not be used in conjunction with a transport filter.
25279
25280 .option hosts_try_dane smtp "host list&!!" *
25281 .cindex DANE "transport options"
25282 .cindex DANE "attempting for certain servers"
25283 If built with DANE support, Exim  will require that a DNSSEC-validated
25284 TLSA record is present for any host matching the list,
25285 and that a DANE-verified TLS connection is made. See
25286 the &%dnssec_request_domains%& router and transport options.
25287 There will be no fallback to in-clear communication.
25288 See section &<<SECDANE>>&.
25289
25290 .option hosts_try_fastopen smtp "host list&!!" *
25291 .cindex "fast open, TCP" "enabling, in client"
25292 .cindex "TCP Fast Open" "enabling, in client"
25293 .cindex "RFC 7413" "TCP Fast Open"
25294 This option provides a list of servers to which, provided
25295 the facility is supported by this system, Exim will attempt to
25296 perform a TCP Fast Open.
25297 No data is sent on the SYN segment but, if the remote server also
25298 supports the facility, it can send its SMTP banner immediately after
25299 the SYN,ACK segment.  This can save up to one round-trip time.
25300
25301 The facility is only active for previously-contacted servers,
25302 as the initiator must present a cookie in the SYN segment.
25303
25304 On (at least some) current Linux distributions the facility must be enabled
25305 in the kernel by the sysadmin before the support is usable.
25306 There is no option for control of the server side; if the system supports
25307 it it is always enabled.  Note that lengthy operations in the connect ACL,
25308 such as DNSBL lookups, will still delay the emission of the SMTP banner.
25309
25310 .option hosts_try_prdr smtp "host list&!!" *
25311 .cindex "PRDR" "enabling, optional in client"
25312 This option provides a list of servers to which, provided they announce
25313 PRDR support, Exim will attempt to negotiate PRDR
25314 for multi-recipient messages.
25315 The option can usually be left as default.
25316
25317 .option interface smtp "string list&!!" unset
25318 .cindex "bind IP address"
25319 .cindex "IP address" "binding"
25320 .vindex "&$host$&"
25321 .vindex "&$host_address$&"
25322 This option specifies which interface to bind to when making an outgoing SMTP
25323 call. The value is an IP address, not an interface name such as
25324 &`eth0`&. Do not confuse this with the interface address that was used when a
25325 message was received, which is in &$received_ip_address$&, formerly known as
25326 &$interface_address$&. The name was changed to minimize confusion with the
25327 outgoing interface address. There is no variable that contains an outgoing
25328 interface address because, unless it is set by this option, its value is
25329 unknown.
25330
25331 During the expansion of the &%interface%& option the variables &$host$& and
25332 &$host_address$& refer to the host to which a connection is about to be made
25333 during the expansion of the string. Forced expansion failure, or an empty
25334 string result causes the option to be ignored. Otherwise, after expansion, the
25335 string must be a list of IP addresses, colon-separated by default, but the
25336 separator can be changed in the usual way (&<<SECTlistsepchange>>&).
25337 For example:
25338 .code
25339 interface = <; 192.168.123.123 ; 3ffe:ffff:836f::fe86:a061
25340 .endd
25341 The first interface of the correct type (IPv4 or IPv6) is used for the outgoing
25342 connection. If none of them are the correct type, the option is ignored. If
25343 &%interface%& is not set, or is ignored, the system's IP functions choose which
25344 interface to use if the host has more than one.
25345
25346
25347 .option keepalive smtp boolean true
25348 .cindex "keepalive" "on outgoing connection"
25349 This option controls the setting of SO_KEEPALIVE on outgoing TCP/IP socket
25350 connections. When set, it causes the kernel to probe idle connections
25351 periodically, by sending packets with &"old"& sequence numbers. The other end
25352 of the connection should send a acknowledgment if the connection is still okay
25353 or a reset if the connection has been aborted. The reason for doing this is
25354 that it has the beneficial effect of freeing up certain types of connection
25355 that can get stuck when the remote host is disconnected without tidying up the
25356 TCP/IP call properly. The keepalive mechanism takes several hours to detect
25357 unreachable hosts.
25358
25359
25360 .option lmtp_ignore_quota smtp boolean false
25361 .cindex "LMTP" "ignoring quota errors"
25362 If this option is set true when the &%protocol%& option is set to &"lmtp"&, the
25363 string &`IGNOREQUOTA`& is added to RCPT commands, provided that the LMTP server
25364 has advertised support for IGNOREQUOTA in its response to the LHLO command.
25365
25366 .option max_rcpt smtp integer 100
25367 .cindex "RCPT" "maximum number of outgoing"
25368 This option limits the number of RCPT commands that are sent in a single
25369 SMTP message transaction. Each set of addresses is treated independently, and
25370 so can cause parallel connections to the same host if &%remote_max_parallel%&
25371 permits this.
25372
25373
25374 .option multi_domain smtp boolean&!! true
25375 .vindex "&$domain$&"
25376 When this option is set, the &(smtp)& transport can handle a number of
25377 addresses containing a mixture of different domains provided they all resolve
25378 to the same list of hosts. Turning the option off restricts the transport to
25379 handling only one domain at a time. This is useful if you want to use
25380 &$domain$& in an expansion for the transport, because it is set only when there
25381 is a single domain involved in a remote delivery.
25382
25383 It is expanded per-address and can depend on any of
25384 &$address_data$&, &$domain_data$&, &$local_part_data$&,
25385 &$host$&, &$host_address$& and &$host_port$&.
25386
25387 .option port smtp string&!! "see below"
25388 .cindex "port" "sending TCP/IP"
25389 .cindex "TCP/IP" "setting outgoing port"
25390 This option specifies the TCP/IP port on the server to which Exim connects.
25391 &*Note:*& Do not confuse this with the port that was used when a message was
25392 received, which is in &$received_port$&, formerly known as &$interface_port$&.
25393 The name was changed to minimize confusion with the outgoing port. There is no
25394 variable that contains an outgoing port.
25395
25396 If the value of this option begins with a digit it is taken as a port number;
25397 otherwise it is looked up using &[getservbyname()]&. The default value is
25398 normally &"smtp"&,
25399 but if &%protocol%& is set to &"lmtp"& the default is &"lmtp"&
25400 and if &%protocol%& is set to &"smtps"& the default is &"smtps"&.
25401 If the expansion fails, or if a port number cannot be found, delivery
25402 is deferred.
25403
25404 Note that at least one Linux distribution has been seen failing
25405 to put &"smtps"& in its &"/etc/services"& file, resulting is such deferrals.
25406
25407
25408
25409 .option protocol smtp string smtp
25410 .cindex "LMTP" "over TCP/IP"
25411 .cindex "ssmtp protocol" "outbound"
25412 .cindex "TLS" "SSL-on-connect outbound"
25413 .vindex "&$port$&"
25414 If this option is set to &"lmtp"& instead of &"smtp"&, the default value for
25415 the &%port%& option changes to &"lmtp"&, and the transport operates the LMTP
25416 protocol (RFC 2033) instead of SMTP. This protocol is sometimes used for local
25417 deliveries into closed message stores. Exim also has support for running LMTP
25418 over a pipe to a local process &-- see chapter &<<CHAPLMTP>>&.
25419
25420 If this option is set to &"smtps"&, the default value for the &%port%& option
25421 changes to &"smtps"&, and the transport initiates TLS immediately after
25422 connecting, as an outbound SSL-on-connect, instead of using STARTTLS to upgrade.
25423 The Internet standards bodies used to strongly discourage use of this mode,
25424 but as of RFC 8314 it is perferred over STARTTLS for message submission
25425 (as distinct from MTA-MTA communication).
25426
25427
25428 .option retry_include_ip_address smtp boolean&!! true
25429 Exim normally includes both the host name and the IP address in the key it
25430 constructs for indexing retry data after a temporary delivery failure. This
25431 means that when one of several IP addresses for a host is failing, it gets
25432 tried periodically (controlled by the retry rules), but use of the other IP
25433 addresses is not affected.
25434
25435 However, in some dialup environments hosts are assigned a different IP address
25436 each time they connect. In this situation the use of the IP address as part of
25437 the retry key leads to undesirable behaviour. Setting this option false causes
25438 Exim to use only the host name.
25439 Since it is expanded it can be made to depend on the host or domain.
25440
25441
25442 .option serialize_hosts smtp "host list&!!" unset
25443 .cindex "serializing connections"
25444 .cindex "host" "serializing connections"
25445 Because Exim operates in a distributed manner, if several messages for the same
25446 host arrive at around the same time, more than one simultaneous connection to
25447 the remote host can occur. This is not usually a problem except when there is a
25448 slow link between the hosts. In that situation it may be helpful to restrict
25449 Exim to one connection at a time. This can be done by setting
25450 &%serialize_hosts%& to match the relevant hosts.
25451
25452 .cindex "hints database" "serializing deliveries to a host"
25453 Exim implements serialization by means of a hints database in which a record is
25454 written whenever a process connects to one of the restricted hosts. The record
25455 is deleted when the connection is completed. Obviously there is scope for
25456 records to get left lying around if there is a system or program crash. To
25457 guard against this, Exim ignores any records that are more than six hours old.
25458
25459 If you set up this kind of serialization, you should also arrange to delete the
25460 relevant hints database whenever your system reboots. The names of the files
25461 start with &_misc_& and they are kept in the &_spool/db_& directory. There
25462 may be one or two files, depending on the type of DBM in use. The same files
25463 are used for ETRN serialization.
25464
25465 See also the &%max_parallel%& generic transport option.
25466
25467
25468 .option size_addition smtp integer 1024
25469 .cindex "SMTP" "SIZE"
25470 .cindex "message" "size issue for transport filter"
25471 .cindex "size" "of message"
25472 .cindex "transport" "filter"
25473 .cindex "filter" "transport filter"
25474 If a remote SMTP server indicates that it supports the SIZE option of the
25475 MAIL command, Exim uses this to pass over the message size at the start of
25476 an SMTP transaction. It adds the value of &%size_addition%& to the value it
25477 sends, to allow for headers and other text that may be added during delivery by
25478 configuration options or in a transport filter. It may be necessary to increase
25479 this if a lot of text is added to messages.
25480
25481 Alternatively, if the value of &%size_addition%& is set negative, it disables
25482 the use of the SIZE option altogether.
25483
25484
25485 .option socks_proxy smtp string&!! unset
25486 .cindex proxy SOCKS
25487 This option enables use of SOCKS proxies for connections made by the
25488 transport.  For details see section &<<SECTproxySOCKS>>&.
25489
25490
25491 .option tls_certificate smtp string&!! unset
25492 .cindex "TLS" "client certificate, location of"
25493 .cindex "certificate" "client, location of"
25494 .vindex "&$host$&"
25495 .vindex "&$host_address$&"
25496 The value of this option must be the absolute path to a file which contains the
25497 client's certificate, for possible use when sending a message over an encrypted
25498 connection. The values of &$host$& and &$host_address$& are set to the name and
25499 address of the server during the expansion. See chapter &<<CHAPTLS>>& for
25500 details of TLS.
25501
25502 &*Note*&: This option must be set if you want Exim to be able to use a TLS
25503 certificate when sending messages as a client. The global option of the same
25504 name specifies the certificate for Exim as a server; it is not automatically
25505 assumed that the same certificate should be used when Exim is operating as a
25506 client.
25507
25508
25509 .option tls_crl smtp string&!! unset
25510 .cindex "TLS" "client certificate revocation list"
25511 .cindex "certificate" "revocation list for client"
25512 This option specifies a certificate revocation list. The expanded value must
25513 be the name of a file that contains a CRL in PEM format.
25514
25515
25516 .option tls_dh_min_bits smtp integer 1024
25517 .cindex "TLS" "Diffie-Hellman minimum acceptable size"
25518 When establishing a TLS session, if a ciphersuite which uses Diffie-Hellman
25519 key agreement is negotiated, the server will provide a large prime number
25520 for use.  This option establishes the minimum acceptable size of that number.
25521 If the parameter offered by the server is too small, then the TLS handshake
25522 will fail.
25523
25524 Only supported when using GnuTLS.
25525
25526
25527 .option tls_privatekey smtp string&!! unset
25528 .cindex "TLS" "client private key, location of"
25529 .vindex "&$host$&"
25530 .vindex "&$host_address$&"
25531 The value of this option must be the absolute path to a file which contains the
25532 client's private key. This is used when sending a message over an encrypted
25533 connection using a client certificate. The values of &$host$& and
25534 &$host_address$& are set to the name and address of the server during the
25535 expansion. If this option is unset, or the expansion is forced to fail, or the
25536 result is an empty string, the private key is assumed to be in the same file as
25537 the certificate. See chapter &<<CHAPTLS>>& for details of TLS.
25538
25539
25540 .option tls_require_ciphers smtp string&!! unset
25541 .cindex "TLS" "requiring specific ciphers"
25542 .cindex "cipher" "requiring specific"
25543 .vindex "&$host$&"
25544 .vindex "&$host_address$&"
25545 The value of this option must be a list of permitted cipher suites, for use
25546 when setting up an outgoing encrypted connection. (There is a global option of
25547 the same name for controlling incoming connections.) The values of &$host$& and
25548 &$host_address$& are set to the name and address of the server during the
25549 expansion. See chapter &<<CHAPTLS>>& for details of TLS; note that this option
25550 is used in different ways by OpenSSL and GnuTLS (see sections
25551 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&). For GnuTLS, the order of the
25552 ciphers is a preference order.
25553
25554
25555
25556 .option tls_sni smtp string&!! unset
25557 .cindex "TLS" "Server Name Indication"
25558 .vindex "&$tls_sni$&"
25559 If this option is set then it sets the $tls_out_sni variable and causes any
25560 TLS session to pass this value as the Server Name Indication extension to
25561 the remote side, which can be used by the remote side to select an appropriate
25562 certificate and private key for the session.
25563
25564 See &<<SECTtlssni>>& for more information.
25565
25566 Note that for OpenSSL, this feature requires a build of OpenSSL that supports
25567 TLS extensions.
25568
25569
25570
25571
25572 .option tls_tempfail_tryclear smtp boolean true
25573 .cindex "4&'xx'& responses" "to STARTTLS"
25574 When the server host is not in &%hosts_require_tls%&, and there is a problem in
25575 setting up a TLS session, this option determines whether or not Exim should try
25576 to deliver the message unencrypted. If it is set false, delivery to the
25577 current host is deferred; if there are other hosts, they are tried. If this
25578 option is set true, Exim attempts to deliver unencrypted after a 4&'xx'&
25579 response to STARTTLS. Also, if STARTTLS is accepted, but the subsequent
25580 TLS negotiation fails, Exim closes the current connection (because it is in an
25581 unknown state), opens a new one to the same host, and then tries the delivery
25582 in clear.
25583
25584
25585 .option tls_try_verify_hosts smtp "host list&!!" *
25586 .cindex "TLS" "server certificate verification"
25587 .cindex "certificate" "verification of server"
25588 This option gives a list of hosts for which, on encrypted connections,
25589 certificate verification will be tried but need not succeed.
25590 The &%tls_verify_certificates%& option must also be set.
25591 Note that unless the host is in this list
25592 TLS connections will be denied to hosts using self-signed certificates
25593 when &%tls_verify_certificates%& is matched.
25594 The &$tls_out_certificate_verified$& variable is set when
25595 certificate verification succeeds.
25596
25597
25598 .option tls_verify_cert_hostnames smtp "host list&!!" *
25599 .cindex "TLS" "server certificate hostname verification"
25600 .cindex "certificate" "verification of server"
25601 This option give a list of hosts for which,
25602 while verifying the server certificate,
25603 checks will be included on the host name
25604 (note that this will generally be the result of a DNS MX lookup)
25605 versus Subject and Subject-Alternate-Name fields.  Wildcard names are permitted
25606 limited to being the initial component of a 3-or-more component FQDN.
25607
25608 There is no equivalent checking on client certificates.
25609
25610
25611 .option tls_verify_certificates smtp string&!! system
25612 .cindex "TLS" "server certificate verification"
25613 .cindex "certificate" "verification of server"
25614 .vindex "&$host$&"
25615 .vindex "&$host_address$&"
25616 The value of this option must be either the
25617 word "system"
25618 or the absolute path to
25619 a file or directory containing permitted certificates for servers,
25620 for use when setting up an encrypted connection.
25621
25622 The "system" value for the option will use a location compiled into the SSL library.
25623 This is not available for GnuTLS versions preceding 3.0.20; a value of "system"
25624 is taken as empty and an explicit location
25625 must be specified.
25626
25627 The use of a directory for the option value is not available for GnuTLS versions
25628 preceding 3.3.6 and a single file must be used.
25629
25630 With OpenSSL the certificates specified
25631 explicitly
25632 either by file or directory
25633 are added to those given by the system default location.
25634
25635 The values of &$host$& and
25636 &$host_address$& are set to the name and address of the server during the
25637 expansion of this option. See chapter &<<CHAPTLS>>& for details of TLS.
25638
25639 For back-compatibility,
25640 if neither tls_verify_hosts nor tls_try_verify_hosts are set
25641 (a single-colon empty list counts as being set)
25642 and certificate verification fails the TLS connection is closed.
25643
25644
25645 .option tls_verify_hosts smtp "host list&!!" unset
25646 .cindex "TLS" "server certificate verification"
25647 .cindex "certificate" "verification of server"
25648 This option gives a list of hosts for which, on encrypted connections,
25649 certificate verification must succeed.
25650 The &%tls_verify_certificates%& option must also be set.
25651 If both this option and &%tls_try_verify_hosts%& are unset
25652 operation is as if this option selected all hosts.
25653
25654 .option utf8_downconvert smtp integer!! unset
25655 .cindex utf8 "address downconversion"
25656 .cindex i18n "utf8 address downconversion"
25657 If built with internationalization support,
25658 this option controls conversion of UTF-8 in message addresses
25659 to a-label form.
25660 For details see section &<<SECTi18nMTA>>&.
25661
25662
25663
25664
25665 .section "How the limits for the number of hosts to try are used" &&&
25666          "SECTvalhosmax"
25667 .cindex "host" "maximum number to try"
25668 .cindex "limit" "hosts; maximum number tried"
25669 There are two options that are concerned with the number of hosts that are
25670 tried when an SMTP delivery takes place. They are &%hosts_max_try%& and
25671 &%hosts_max_try_hardlimit%&.
25672
25673
25674 The &%hosts_max_try%& option limits the number of hosts that are tried
25675 for a single delivery. However, despite the term &"host"& in its name, the
25676 option actually applies to each IP address independently. In other words, a
25677 multihomed host is treated as several independent hosts, just as it is for
25678 retrying.
25679
25680 Many of the larger ISPs have multiple MX records which often point to
25681 multihomed hosts. As a result, a list of a dozen or more IP addresses may be
25682 created as a result of routing one of these domains.
25683
25684 Trying every single IP address on such a long list does not seem sensible; if
25685 several at the top of the list fail, it is reasonable to assume there is some
25686 problem that is likely to affect all of them. Roughly speaking, the value of
25687 &%hosts_max_try%& is the maximum number that are tried before deferring the
25688 delivery. However, the logic cannot be quite that simple.
25689
25690 Firstly, IP addresses that are skipped because their retry times have not
25691 arrived do not count, and in addition, addresses that are past their retry
25692 limits are also not counted, even when they are tried. This means that when
25693 some IP addresses are past their retry limits, more than the value of
25694 &%hosts_max_retry%& may be tried. The reason for this behaviour is to ensure
25695 that all IP addresses are considered before timing out an email address (but
25696 see below for an exception).
25697
25698 Secondly, when the &%hosts_max_try%& limit is reached, Exim looks down the host
25699 list to see if there is a subsequent host with a different (higher valued) MX.
25700 If there is, that host is considered next, and the current IP address is used
25701 but not counted. This behaviour helps in the case of a domain with a retry rule
25702 that hardly ever delays any hosts, as is now explained:
25703
25704 Consider the case of a long list of hosts with one MX value, and a few with a
25705 higher MX value. If &%hosts_max_try%& is small (the default is 5) only a few
25706 hosts at the top of the list are tried at first. With the default retry rule,
25707 which specifies increasing retry times, the higher MX hosts are eventually
25708 tried when those at the top of the list are skipped because they have not
25709 reached their retry times.
25710
25711 However, it is common practice to put a fixed short retry time on domains for
25712 large ISPs, on the grounds that their servers are rarely down for very long.
25713 Unfortunately, these are exactly the domains that tend to resolve to long lists
25714 of hosts. The short retry time means that the lowest MX hosts are tried every
25715 time. The attempts may be in a different order because of random sorting, but
25716 without the special MX check, the higher MX hosts would never be tried until
25717 all the lower MX hosts had timed out (which might be several days), because
25718 there are always some lower MX hosts that have reached their retry times. With
25719 the special check, Exim considers at least one IP address from each MX value at
25720 every delivery attempt, even if the &%hosts_max_try%& limit has already been
25721 reached.
25722
25723 The above logic means that &%hosts_max_try%& is not a hard limit, and in
25724 particular, Exim normally eventually tries all the IP addresses before timing
25725 out an email address. When &%hosts_max_try%& was implemented, this seemed a
25726 reasonable thing to do. Recently, however, some lunatic DNS configurations have
25727 been set up with hundreds of IP addresses for some domains. It can
25728 take a very long time indeed for an address to time out in these cases.
25729
25730 The &%hosts_max_try_hardlimit%& option was added to help with this problem.
25731 Exim never tries more than this number of IP addresses; if it hits this limit
25732 and they are all timed out, the email address is bounced, even though not all
25733 possible IP addresses have been tried.
25734 .ecindex IIDsmttra1
25735 .ecindex IIDsmttra2
25736
25737
25738
25739
25740
25741 . ////////////////////////////////////////////////////////////////////////////
25742 . ////////////////////////////////////////////////////////////////////////////
25743
25744 .chapter "Address rewriting" "CHAPrewrite"
25745 .scindex IIDaddrew "rewriting" "addresses"
25746 There are some circumstances in which Exim automatically rewrites domains in
25747 addresses. The two most common are when an address is given without a domain
25748 (referred to as an &"unqualified address"&) or when an address contains an
25749 abbreviated domain that is expanded by DNS lookup.
25750
25751 Unqualified envelope addresses are accepted only for locally submitted
25752 messages, or for messages that are received from hosts matching
25753 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
25754 appropriate. Unqualified addresses in header lines are qualified if they are in
25755 locally submitted messages, or messages from hosts that are permitted to send
25756 unqualified envelope addresses. Otherwise, unqualified addresses in header
25757 lines are neither qualified nor rewritten.
25758
25759 One situation in which Exim does &'not'& automatically rewrite a domain is
25760 when it is the name of a CNAME record in the DNS. The older RFCs suggest that
25761 such a domain should be rewritten using the &"canonical"& name, and some MTAs
25762 do this. The new RFCs do not contain this suggestion.
25763
25764
25765 .section "Explicitly configured address rewriting" "SECID147"
25766 This chapter describes the rewriting rules that can be used in the
25767 main rewrite section of the configuration file, and also in the generic
25768 &%headers_rewrite%& option that can be set on any transport.
25769
25770 Some people believe that configured address rewriting is a Mortal Sin.
25771 Others believe that life is not possible without it. Exim provides the
25772 facility; you do not have to use it.
25773
25774 The main rewriting rules that appear in the &"rewrite"& section of the
25775 configuration file are applied to addresses in incoming messages, both envelope
25776 addresses and addresses in header lines. Each rule specifies the types of
25777 address to which it applies.
25778
25779 Whether or not addresses in header lines are rewritten depends on the origin of
25780 the headers and the type of rewriting. Global rewriting, that is, rewriting
25781 rules from the rewrite section of the configuration file, is applied only to
25782 those headers that were received with the message. Header lines that are added
25783 by ACLs or by a system filter or by individual routers or transports (which
25784 are specific to individual recipient addresses) are not rewritten by the global
25785 rules.
25786
25787 Rewriting at transport time, by means of the &%headers_rewrite%& option,
25788 applies all headers except those added by routers and transports. That is, as
25789 well as the headers that were received with the message, it also applies to
25790 headers that were added by an ACL or a system filter.
25791
25792
25793 In general, rewriting addresses from your own system or domain has some
25794 legitimacy. Rewriting other addresses should be done only with great care and
25795 in special circumstances. The author of Exim believes that rewriting should be
25796 used sparingly, and mainly for &"regularizing"& addresses in your own domains.
25797 Although it can sometimes be used as a routing tool, this is very strongly
25798 discouraged.
25799
25800 There are two commonly encountered circumstances where rewriting is used, as
25801 illustrated by these examples:
25802
25803 .ilist
25804 The company whose domain is &'hitch.fict.example'& has a number of hosts that
25805 exchange mail with each other behind a firewall, but there is only a single
25806 gateway to the outer world. The gateway rewrites &'*.hitch.fict.example'& as
25807 &'hitch.fict.example'& when sending mail off-site.
25808 .next
25809 A host rewrites the local parts of its own users so that, for example,
25810 &'fp42@hitch.fict.example'& becomes &'Ford.Prefect@hitch.fict.example'&.
25811 .endlist
25812
25813
25814
25815 .section "When does rewriting happen?" "SECID148"
25816 .cindex "rewriting" "timing of"
25817 .cindex "&ACL;" "rewriting addresses in"
25818 Configured address rewriting can take place at several different stages of a
25819 message's processing.
25820
25821 .vindex "&$sender_address$&"
25822 At the start of an ACL for MAIL, the sender address may have been rewritten
25823 by a special SMTP-time rewrite rule (see section &<<SECTrewriteS>>&), but no
25824 ordinary rewrite rules have yet been applied. If, however, the sender address
25825 is verified in the ACL, it is rewritten before verification, and remains
25826 rewritten thereafter. The subsequent value of &$sender_address$& is the
25827 rewritten address. This also applies if sender verification happens in a
25828 RCPT ACL. Otherwise, when the sender address is not verified, it is
25829 rewritten as soon as a message's header lines have been received.
25830
25831 .vindex "&$domain$&"
25832 .vindex "&$local_part$&"
25833 Similarly, at the start of an ACL for RCPT, the current recipient's address
25834 may have been rewritten by a special SMTP-time rewrite rule, but no ordinary
25835 rewrite rules have yet been applied to it. However, the behaviour is different
25836 from the sender address when a recipient is verified. The address is rewritten
25837 for the verification, but the rewriting is not remembered at this stage. The
25838 value of &$local_part$& and &$domain$& after verification are always the same
25839 as they were before (that is, they contain the unrewritten &-- except for
25840 SMTP-time rewriting &-- address).
25841
25842 As soon as a message's header lines have been received, all the envelope
25843 recipient addresses are permanently rewritten, and rewriting is also applied to
25844 the addresses in the header lines (if configured). This happens before adding
25845 any header lines that were specified in MAIL or RCPT ACLs, and
25846 .cindex "&[local_scan()]& function" "address rewriting; timing of"
25847 before the DATA ACL and &[local_scan()]& functions are run.
25848
25849 When an address is being routed, either for delivery or for verification,
25850 rewriting is applied immediately to child addresses that are generated by
25851 redirection, unless &%no_rewrite%& is set on the router.
25852
25853 .cindex "envelope from"
25854 .cindex "envelope sender" "rewriting at transport time"
25855 .cindex "rewriting" "at transport time"
25856 .cindex "header lines" "rewriting at transport time"
25857 At transport time, additional rewriting of addresses in header lines can be
25858 specified by setting the generic &%headers_rewrite%& option on a transport.
25859 This option contains rules that are identical in form to those in the rewrite
25860 section of the configuration file. They are applied to the original message
25861 header lines and any that were added by ACLs or a system filter. They are not
25862 applied to header lines that are added by routers or the transport.
25863
25864 The outgoing envelope sender can be rewritten by means of the &%return_path%&
25865 transport option. However, it is not possible to rewrite envelope recipients at
25866 transport time.
25867
25868
25869
25870
25871 .section "Testing the rewriting rules that apply on input" "SECID149"
25872 .cindex "rewriting" "testing"
25873 .cindex "testing" "rewriting"
25874 Exim's input rewriting configuration appears in a part of the runtime
25875 configuration file headed by &"begin rewrite"&. It can be tested by the
25876 &%-brw%& command line option. This takes an address (which can be a full RFC
25877 2822 address) as its argument. The output is a list of how the address would be
25878 transformed by the rewriting rules for each of the different places it might
25879 appear in an incoming message, that is, for each different header and for the
25880 envelope sender and recipient fields. For example,
25881 .code
25882 exim -brw ph10@exim.workshop.example
25883 .endd
25884 might produce the output
25885 .code
25886 sender: Philip.Hazel@exim.workshop.example
25887 from: Philip.Hazel@exim.workshop.example
25888 to: ph10@exim.workshop.example
25889 cc: ph10@exim.workshop.example
25890 bcc: ph10@exim.workshop.example
25891 reply-to: Philip.Hazel@exim.workshop.example
25892 env-from: Philip.Hazel@exim.workshop.example
25893 env-to: ph10@exim.workshop.example
25894 .endd
25895 which shows that rewriting has been set up for that address when used in any of
25896 the source fields, but not when it appears as a recipient address. At the
25897 present time, there is no equivalent way of testing rewriting rules that are
25898 set for a particular transport.
25899
25900
25901 .section "Rewriting rules" "SECID150"
25902 .cindex "rewriting" "rules"
25903 The rewrite section of the configuration file consists of lines of rewriting
25904 rules in the form
25905 .display
25906 <&'source pattern'&>  <&'replacement'&>  <&'flags'&>
25907 .endd
25908 Rewriting rules that are specified for the &%headers_rewrite%& generic
25909 transport option are given as a colon-separated list. Each item in the list
25910 takes the same form as a line in the main rewriting configuration (except that
25911 any colons must be doubled, of course).
25912
25913 The formats of source patterns and replacement strings are described below.
25914 Each is terminated by white space, unless enclosed in double quotes, in which
25915 case normal quoting conventions apply inside the quotes. The flags are single
25916 characters which may appear in any order. Spaces and tabs between them are
25917 ignored.
25918
25919 For each address that could potentially be rewritten, the rules are scanned in
25920 order, and replacements for the address from earlier rules can themselves be
25921 replaced by later rules (but see the &"q"& and &"R"& flags).
25922
25923 The order in which addresses are rewritten is undefined, may change between
25924 releases, and must not be relied on, with one exception: when a message is
25925 received, the envelope sender is always rewritten first, before any header
25926 lines are rewritten. For example, the replacement string for a rewrite of an
25927 address in &'To:'& must not assume that the message's address in &'From:'& has
25928 (or has not) already been rewritten. However, a rewrite of &'From:'& may assume
25929 that the envelope sender has already been rewritten.
25930
25931 .vindex "&$domain$&"
25932 .vindex "&$local_part$&"
25933 The variables &$local_part$& and &$domain$& can be used in the replacement
25934 string to refer to the address that is being rewritten. Note that lookup-driven
25935 rewriting can be done by a rule of the form
25936 .code
25937 *@*   ${lookup ...
25938 .endd
25939 where the lookup key uses &$1$& and &$2$& or &$local_part$& and &$domain$& to
25940 refer to the address that is being rewritten.
25941
25942
25943 .section "Rewriting patterns" "SECID151"
25944 .cindex "rewriting" "patterns"
25945 .cindex "address list" "in a rewriting pattern"
25946 The source pattern in a rewriting rule is any item which may appear in an
25947 address list (see section &<<SECTaddresslist>>&). It is in fact processed as a
25948 single-item address list, which means that it is expanded before being tested
25949 against the address. As always, if you use a regular expression as a pattern,
25950 you must take care to escape dollar and backslash characters, or use the &`\N`&
25951 facility to suppress string expansion within the regular expression.
25952
25953 Domains in patterns should be given in lower case. Local parts in patterns are
25954 case-sensitive. If you want to do case-insensitive matching of local parts, you
25955 can use a regular expression that starts with &`^(?i)`&.
25956
25957 .cindex "numerical variables (&$1$& &$2$& etc)" "in rewriting rules"
25958 After matching, the numerical variables &$1$&, &$2$&, etc. may be set,
25959 depending on the type of match which occurred. These can be used in the
25960 replacement string to insert portions of the incoming address. &$0$& always
25961 refers to the complete incoming address. When a regular expression is used, the
25962 numerical variables are set from its capturing subexpressions. For other types
25963 of pattern they are set as follows:
25964
25965 .ilist
25966 If a local part or domain starts with an asterisk, the numerical variables
25967 refer to the character strings matched by asterisks, with &$1$& associated with
25968 the first asterisk, and &$2$& with the second, if present. For example, if the
25969 pattern
25970 .code
25971 *queen@*.fict.example
25972 .endd
25973 is matched against the address &'hearts-queen@wonderland.fict.example'& then
25974 .code
25975 $0 = hearts-queen@wonderland.fict.example
25976 $1 = hearts-
25977 $2 = wonderland
25978 .endd
25979 Note that if the local part does not start with an asterisk, but the domain
25980 does, it is &$1$& that contains the wild part of the domain.
25981
25982 .next
25983 If the domain part of the pattern is a partial lookup, the wild and fixed parts
25984 of the domain are placed in the next available numerical variables. Suppose,
25985 for example, that the address &'foo@bar.baz.example'& is processed by a
25986 rewriting rule of the form
25987 .display
25988 &`*@partial-dbm;/some/dbm/file`&    <&'replacement string'&>
25989 .endd
25990 and the key in the file that matches the domain is &`*.baz.example`&. Then
25991 .code
25992 $1 = foo
25993 $2 = bar
25994 $3 = baz.example
25995 .endd
25996 If the address &'foo@baz.example'& is looked up, this matches the same
25997 wildcard file entry, and in this case &$2$& is set to the empty string, but
25998 &$3$& is still set to &'baz.example'&. If a non-wild key is matched in a
25999 partial lookup, &$2$& is again set to the empty string and &$3$& is set to the
26000 whole domain. For non-partial domain lookups, no numerical variables are set.
26001 .endlist
26002
26003
26004 .section "Rewriting replacements" "SECID152"
26005 .cindex "rewriting" "replacements"
26006 If the replacement string for a rule is a single asterisk, addresses that
26007 match the pattern and the flags are &'not'& rewritten, and no subsequent
26008 rewriting rules are scanned. For example,
26009 .code
26010 hatta@lookingglass.fict.example  *  f
26011 .endd
26012 specifies that &'hatta@lookingglass.fict.example'& is never to be rewritten in
26013 &'From:'& headers.
26014
26015 .vindex "&$domain$&"
26016 .vindex "&$local_part$&"
26017 If the replacement string is not a single asterisk, it is expanded, and must
26018 yield a fully qualified address. Within the expansion, the variables
26019 &$local_part$& and &$domain$& refer to the address that is being rewritten.
26020 Any letters they contain retain their original case &-- they are not lower
26021 cased. The numerical variables are set up according to the type of pattern that
26022 matched the address, as described above. If the expansion is forced to fail by
26023 the presence of &"fail"& in a conditional or lookup item, rewriting by the
26024 current rule is abandoned, but subsequent rules may take effect. Any other
26025 expansion failure causes the entire rewriting operation to be abandoned, and an
26026 entry written to the panic log.
26027
26028
26029
26030 .section "Rewriting flags" "SECID153"
26031 There are three different kinds of flag that may appear on rewriting rules:
26032
26033 .ilist
26034 Flags that specify which headers and envelope addresses to rewrite: E, F, T, b,
26035 c, f, h, r, s, t.
26036 .next
26037 A flag that specifies rewriting at SMTP time: S.
26038 .next
26039 Flags that control the rewriting process: Q, q, R, w.
26040 .endlist
26041
26042 For rules that are part of the &%headers_rewrite%& generic transport option,
26043 E, F, T, and S are not permitted.
26044
26045
26046
26047 .section "Flags specifying which headers and envelope addresses to rewrite" &&&
26048          "SECID154"
26049 .cindex "rewriting" "flags"
26050 If none of the following flag letters, nor the &"S"& flag (see section
26051 &<<SECTrewriteS>>&) are present, a main rewriting rule applies to all headers
26052 and to both the sender and recipient fields of the envelope, whereas a
26053 transport-time rewriting rule just applies to all headers. Otherwise, the
26054 rewriting rule is skipped unless the relevant addresses are being processed.
26055 .display
26056 &`E`&       rewrite all envelope fields
26057 &`F`&       rewrite the envelope From field
26058 &`T`&       rewrite the envelope To field
26059 &`b`&       rewrite the &'Bcc:'& header
26060 &`c`&       rewrite the &'Cc:'& header
26061 &`f`&       rewrite the &'From:'& header
26062 &`h`&       rewrite all headers
26063 &`r`&       rewrite the &'Reply-To:'& header
26064 &`s`&       rewrite the &'Sender:'& header
26065 &`t`&       rewrite the &'To:'& header
26066 .endd
26067 "All headers" means all of the headers listed above that can be selected
26068 individually, plus their &'Resent-'& versions. It does not include
26069 other headers such as &'Subject:'& etc.
26070
26071 You should be particularly careful about rewriting &'Sender:'& headers, and
26072 restrict this to special known cases in your own domains.
26073
26074
26075 .section "The SMTP-time rewriting flag" "SECTrewriteS"
26076 .cindex "SMTP" "rewriting malformed addresses"
26077 .cindex "RCPT" "rewriting argument of"
26078 .cindex "MAIL" "rewriting argument of"
26079 The rewrite flag &"S"& specifies a rewrite of incoming envelope addresses at
26080 SMTP time, as soon as an address is received in a MAIL or RCPT command, and
26081 before any other processing; even before syntax checking. The pattern is
26082 required to be a regular expression, and it is matched against the whole of the
26083 data for the command, including any surrounding angle brackets.
26084
26085 .vindex "&$domain$&"
26086 .vindex "&$local_part$&"
26087 This form of rewrite rule allows for the handling of addresses that are not
26088 compliant with RFCs 2821 and 2822 (for example, &"bang paths"& in batched SMTP
26089 input). Because the input is not required to be a syntactically valid address,
26090 the variables &$local_part$& and &$domain$& are not available during the
26091 expansion of the replacement string. The result of rewriting replaces the
26092 original address in the MAIL or RCPT command.
26093
26094
26095 .section "Flags controlling the rewriting process" "SECID155"
26096 There are four flags which control the way the rewriting process works. These
26097 take effect only when a rule is invoked, that is, when the address is of the
26098 correct type (matches the flags) and matches the pattern:
26099
26100 .ilist
26101 If the &"Q"& flag is set on a rule, the rewritten address is permitted to be an
26102 unqualified local part. It is qualified with &%qualify_recipient%&. In the
26103 absence of &"Q"& the rewritten address must always include a domain.
26104 .next
26105 If the &"q"& flag is set on a rule, no further rewriting rules are considered,
26106 even if no rewriting actually takes place because of a &"fail"& in the
26107 expansion. The &"q"& flag is not effective if the address is of the wrong type
26108 (does not match the flags) or does not match the pattern.
26109 .next
26110 The &"R"& flag causes a successful rewriting rule to be re-applied to the new
26111 address, up to ten times. It can be combined with the &"q"& flag, to stop
26112 rewriting once it fails to match (after at least one successful rewrite).
26113 .next
26114 .cindex "rewriting" "whole addresses"
26115 When an address in a header is rewritten, the rewriting normally applies only
26116 to the working part of the address, with any comments and RFC 2822 &"phrase"&
26117 left unchanged. For example, rewriting might change
26118 .code
26119 From: Ford Prefect <fp42@restaurant.hitch.fict.example>
26120 .endd
26121 into
26122 .code
26123 From: Ford Prefect <prefectf@hitch.fict.example>
26124 .endd
26125 .cindex "RFC 2047"
26126 Sometimes there is a need to replace the whole address item, and this can be
26127 done by adding the flag letter &"w"& to a rule. If this is set on a rule that
26128 causes an address in a header line to be rewritten, the entire address is
26129 replaced, not just the working part. The replacement must be a complete RFC
26130 2822 address, including the angle brackets if necessary. If text outside angle
26131 brackets contains a character whose value is greater than 126 or less than 32
26132 (except for tab), the text is encoded according to RFC 2047. The character set
26133 is taken from &%headers_charset%&, which gets its default at build time.
26134
26135 When the &"w"& flag is set on a rule that causes an envelope address to be
26136 rewritten, all but the working part of the replacement address is discarded.
26137 .endlist
26138
26139
26140 .section "Rewriting examples" "SECID156"
26141 Here is an example of the two common rewriting paradigms:
26142 .code
26143 *@*.hitch.fict.example  $1@hitch.fict.example
26144 *@hitch.fict.example    ${lookup{$1}dbm{/etc/realnames}\
26145                      {$value}fail}@hitch.fict.example bctfrF
26146 .endd
26147 Note the use of &"fail"& in the lookup expansion in the second rule, forcing
26148 the string expansion to fail if the lookup does not succeed. In this context it
26149 has the effect of leaving the original address unchanged, but Exim goes on to
26150 consider subsequent rewriting rules, if any, because the &"q"& flag is not
26151 present in that rule. An alternative to &"fail"& would be to supply &$1$&
26152 explicitly, which would cause the rewritten address to be the same as before,
26153 at the cost of a small bit of processing. Not supplying either of these is an
26154 error, since the rewritten address would then contain no local part.
26155
26156 The first example above replaces the domain with a superior, more general
26157 domain. This may not be desirable for certain local parts. If the rule
26158 .code
26159 root@*.hitch.fict.example  *
26160 .endd
26161 were inserted before the first rule, rewriting would be suppressed for the
26162 local part &'root'& at any domain ending in &'hitch.fict.example'&.
26163
26164 Rewriting can be made conditional on a number of tests, by making use of
26165 &${if$& in the expansion item. For example, to apply a rewriting rule only to
26166 messages that originate outside the local host:
26167 .code
26168 *@*.hitch.fict.example  "${if !eq {$sender_host_address}{}\
26169                          {$1@hitch.fict.example}fail}"
26170 .endd
26171 The replacement string is quoted in this example because it contains white
26172 space.
26173
26174 .cindex "rewriting" "bang paths"
26175 .cindex "bang paths" "rewriting"
26176 Exim does not handle addresses in the form of &"bang paths"&. If it sees such
26177 an address it treats it as an unqualified local part which it qualifies with
26178 the local qualification domain (if the source of the message is local or if the
26179 remote host is permitted to send unqualified addresses). Rewriting can
26180 sometimes be used to handle simple bang paths with a fixed number of
26181 components. For example, the rule
26182 .code
26183 \N^([^!]+)!(.*)@your.domain.example$\N   $2@$1
26184 .endd
26185 rewrites a two-component bang path &'host.name!user'& as the domain address
26186 &'user@host.name'&. However, there is a security implication in using this as
26187 a global rewriting rule for envelope addresses. It can provide a backdoor
26188 method for using your system as a relay, because the incoming addresses appear
26189 to be local. If the bang path addresses are received via SMTP, it is safer to
26190 use the &"S"& flag to rewrite them as they are received, so that relay checking
26191 can be done on the rewritten addresses.
26192 .ecindex IIDaddrew
26193
26194
26195
26196
26197
26198 . ////////////////////////////////////////////////////////////////////////////
26199 . ////////////////////////////////////////////////////////////////////////////
26200
26201 .chapter "Retry configuration" "CHAPretry"
26202 .scindex IIDretconf1 "retry" "configuration, description of"
26203 .scindex IIDregconf2 "configuration file" "retry section"
26204 The &"retry"& section of the runtime configuration file contains a list of
26205 retry rules that control how often Exim tries to deliver messages that cannot
26206 be delivered at the first attempt. If there are no retry rules (the section is
26207 empty or not present), there are no retries. In this situation, temporary
26208 errors are treated as permanent. The default configuration contains a single,
26209 general-purpose retry rule (see section &<<SECID57>>&). The &%-brt%& command
26210 line option can be used to test which retry rule will be used for a given
26211 address, domain and error.
26212
26213 The most common cause of retries is temporary failure to deliver to a remote
26214 host because the host is down, or inaccessible because of a network problem.
26215 Exim's retry processing in this case is applied on a per-host (strictly, per IP
26216 address) basis, not on a per-message basis. Thus, if one message has recently
26217 been delayed, delivery of a new message to the same host is not immediately
26218 tried, but waits for the host's retry time to arrive. If the &%retry_defer%&
26219 log selector is set, the message
26220 .cindex "retry" "time not reached"
26221 &"retry time not reached"& is written to the main log whenever a delivery is
26222 skipped for this reason. Section &<<SECToutSMTPerr>>& contains more details of
26223 the handling of errors during remote deliveries.
26224
26225 Retry processing applies to routing as well as to delivering, except as covered
26226 in the next paragraph. The retry rules do not distinguish between these
26227 actions. It is not possible, for example, to specify different behaviour for
26228 failures to route the domain &'snark.fict.example'& and failures to deliver to
26229 the host &'snark.fict.example'&. I didn't think anyone would ever need this
26230 added complication, so did not implement it. However, although they share the
26231 same retry rule, the actual retry times for routing and transporting a given
26232 domain are maintained independently.
26233
26234 When a delivery is not part of a queue run (typically an immediate delivery on
26235 receipt of a message), the routers are always run, and local deliveries are
26236 always attempted, even if retry times are set for them. This makes for better
26237 behaviour if one particular message is causing problems (for example, causing
26238 quota overflow, or provoking an error in a filter file). If such a delivery
26239 suffers a temporary failure, the retry data is updated as normal, and
26240 subsequent delivery attempts from queue runs occur only when the retry time for
26241 the local address is reached.
26242
26243 .section "Changing retry rules" "SECID157"
26244 If you change the retry rules in your configuration, you should consider
26245 whether or not to delete the retry data that is stored in Exim's spool area in
26246 files with names like &_db/retry_&. Deleting any of Exim's hints files is
26247 always safe; that is why they are called &"hints"&.
26248
26249 The hints retry data contains suggested retry times based on the previous
26250 rules. In the case of a long-running problem with a remote host, it might
26251 record the fact that the host has timed out. If your new rules increase the
26252 timeout time for such a host, you should definitely remove the old retry data
26253 and let Exim recreate it, based on the new rules. Otherwise Exim might bounce
26254 messages that it should now be retaining.
26255
26256
26257
26258 .section "Format of retry rules" "SECID158"
26259 .cindex "retry" "rules"
26260 Each retry rule occupies one line and consists of three or four parts,
26261 separated by white space: a pattern, an error name, an optional list of sender
26262 addresses, and a list of retry parameters. The pattern and sender lists must be
26263 enclosed in double quotes if they contain white space. The rules are searched
26264 in order until one is found where the pattern, error name, and sender list (if
26265 present) match the failing host or address, the error that occurred, and the
26266 message's sender, respectively.
26267
26268
26269 The pattern is any single item that may appear in an address list (see section
26270 &<<SECTaddresslist>>&). It is in fact processed as a one-item address list,
26271 which means that it is expanded before being tested against the address that
26272 has been delayed. A negated address list item is permitted. Address
26273 list processing treats a plain domain name as if it were preceded by &"*@"&,
26274 which makes it possible for many retry rules to start with just a domain. For
26275 example,
26276 .code
26277 lookingglass.fict.example        *  F,24h,30m;
26278 .endd
26279 provides a rule for any address in the &'lookingglass.fict.example'& domain,
26280 whereas
26281 .code
26282 alice@lookingglass.fict.example  *  F,24h,30m;
26283 .endd
26284 applies only to temporary failures involving the local part &%alice%&.
26285 In practice, almost all rules start with a domain name pattern without a local
26286 part.
26287
26288 .cindex "regular expressions" "in retry rules"
26289 &*Warning*&: If you use a regular expression in a retry rule pattern, it
26290 must match a complete address, not just a domain, because that is how regular
26291 expressions work in address lists.
26292 .display
26293 &`^\Nxyz\d+\.abc\.example$\N        *  G,1h,10m,2`&     &%Wrong%&
26294 &`^\N[^@]+@xyz\d+\.abc\.example$\N  *  G,1h,10m,2`&     &%Right%&
26295 .endd
26296
26297
26298 .section "Choosing which retry rule to use for address errors" "SECID159"
26299 When Exim is looking for a retry rule after a routing attempt has failed (for
26300 example, after a DNS timeout), each line in the retry configuration is tested
26301 against the complete address only if &%retry_use_local_part%& is set for the
26302 router. Otherwise, only the domain is used, except when matching against a
26303 regular expression, when the local part of the address is replaced with &"*"&.
26304 A domain on its own can match a domain pattern, or a pattern that starts with
26305 &"*@"&. By default, &%retry_use_local_part%& is true for routers where
26306 &%check_local_user%& is true, and false for other routers.
26307
26308 Similarly, when Exim is looking for a retry rule after a local delivery has
26309 failed (for example, after a mailbox full error), each line in the retry
26310 configuration is tested against the complete address only if
26311 &%retry_use_local_part%& is set for the transport (it defaults true for all
26312 local transports).
26313
26314 .cindex "4&'xx'& responses" "retry rules for"
26315 However, when Exim is looking for a retry rule after a remote delivery attempt
26316 suffers an address error (a 4&'xx'& SMTP response for a recipient address), the
26317 whole address is always used as the key when searching the retry rules. The
26318 rule that is found is used to create a retry time for the combination of the
26319 failing address and the message's sender. It is the combination of sender and
26320 recipient that is delayed in subsequent queue runs until its retry time is
26321 reached. You can delay the recipient without regard to the sender by setting
26322 &%address_retry_include_sender%& false in the &(smtp)& transport but this can
26323 lead to problems with servers that regularly issue 4&'xx'& responses to RCPT
26324 commands.
26325
26326
26327
26328 .section "Choosing which retry rule to use for host and message errors" &&&
26329          "SECID160"
26330 For a temporary error that is not related to an individual address (for
26331 example, a connection timeout), each line in the retry configuration is checked
26332 twice. First, the name of the remote host is used as a domain name (preceded by
26333 &"*@"& when matching a regular expression). If this does not match the line,
26334 the domain from the email address is tried in a similar fashion. For example,
26335 suppose the MX records for &'a.b.c.example'& are
26336 .code
26337 a.b.c.example  MX  5  x.y.z.example
26338                MX  6  p.q.r.example
26339                MX  7  m.n.o.example
26340 .endd
26341 and the retry rules are
26342 .code
26343 p.q.r.example    *      F,24h,30m;
26344 a.b.c.example    *      F,4d,45m;
26345 .endd
26346 and a delivery to the host &'x.y.z.example'& suffers a connection failure. The
26347 first rule matches neither the host nor the domain, so Exim looks at the second
26348 rule. This does not match the host, but it does match the domain, so it is used
26349 to calculate the retry time for the host &'x.y.z.example'&. Meanwhile, Exim
26350 tries to deliver to &'p.q.r.example'&. If this also suffers a host error, the
26351 first retry rule is used, because it matches the host.
26352
26353 In other words, temporary failures to deliver to host &'p.q.r.example'& use the
26354 first rule to determine retry times, but for all the other hosts for the domain
26355 &'a.b.c.example'&, the second rule is used. The second rule is also used if
26356 routing to &'a.b.c.example'& suffers a temporary failure.
26357
26358 &*Note*&: The host name is used when matching the patterns, not its IP address.
26359 However, if a message is routed directly to an IP address without the use of a
26360 host name, for example, if a &(manualroute)& router contains a setting such as:
26361 .code
26362 route_list = *.a.example  192.168.34.23
26363 .endd
26364 then the &"host name"& that is used when searching for a retry rule is the
26365 textual form of the IP address.
26366
26367 .section "Retry rules for specific errors" "SECID161"
26368 .cindex "retry" "specific errors; specifying"
26369 The second field in a retry rule is the name of a particular error, or an
26370 asterisk, which matches any error. The errors that can be tested for are:
26371
26372 .vlist
26373 .vitem &%auth_failed%&
26374 Authentication failed when trying to send to a host in the
26375 &%hosts_require_auth%& list in an &(smtp)& transport.
26376
26377 .vitem &%data_4xx%&
26378 A 4&'xx'& error was received for an outgoing DATA command, either immediately
26379 after the command, or after sending the message's data.
26380
26381 .vitem &%mail_4xx%&
26382 A 4&'xx'& error was received for an outgoing MAIL command.
26383
26384 .vitem &%rcpt_4xx%&
26385 A 4&'xx'& error was received for an outgoing RCPT command.
26386 .endlist
26387
26388 For the three 4&'xx'& errors, either the first or both of the x's can be given
26389 as specific digits, for example: &`mail_45x`& or &`rcpt_436`&. For example, to
26390 recognize 452 errors given to RCPT commands for addresses in a certain domain,
26391 and have retries every ten minutes with a one-hour timeout, you could set up a
26392 retry rule of this form:
26393 .code
26394 the.domain.name  rcpt_452   F,1h,10m
26395 .endd
26396 These errors apply to both outgoing SMTP (the &(smtp)& transport) and outgoing
26397 LMTP (either the &(lmtp)& transport, or the &(smtp)& transport in LMTP mode).
26398
26399 .vlist
26400 .vitem &%lost_connection%&
26401 A server unexpectedly closed the SMTP connection. There may, of course,
26402 legitimate reasons for this (host died, network died), but if it repeats a lot
26403 for the same host, it indicates something odd.
26404
26405 .vitem &%lookup%&
26406 A DNS lookup for a host failed.
26407 Note that a &%dnslookup%& router will need to have matched
26408 its &%fail_defer_domains%& option for this retry type to be usable.
26409 Also note that a &%manualroute%& router will probably need
26410 its &%host_find_failed%& option set to &%defer%&.
26411
26412 .vitem &%refused_MX%&
26413 A connection to a host obtained from an MX record was refused.
26414
26415 .vitem &%refused_A%&
26416 A connection to a host not obtained from an MX record was refused.
26417
26418 .vitem &%refused%&
26419 A connection was refused.
26420
26421 .vitem &%timeout_connect_MX%&
26422 A connection attempt to a host obtained from an MX record timed out.
26423
26424 .vitem &%timeout_connect_A%&
26425 A connection attempt to a host not obtained from an MX record timed out.
26426
26427 .vitem &%timeout_connect%&
26428 A connection attempt timed out.
26429
26430 .vitem &%timeout_MX%&
26431 There was a timeout while connecting or during an SMTP session with a host
26432 obtained from an MX record.
26433
26434 .vitem &%timeout_A%&
26435 There was a timeout while connecting or during an SMTP session with a host not
26436 obtained from an MX record.
26437
26438 .vitem &%timeout%&
26439 There was a timeout while connecting or during an SMTP session.
26440
26441 .vitem &%tls_required%&
26442 The server was required to use TLS (it matched &%hosts_require_tls%& in the
26443 &(smtp)& transport), but either did not offer TLS, or it responded with 4&'xx'&
26444 to STARTTLS, or there was a problem setting up the TLS connection.
26445
26446 .vitem &%quota%&
26447 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
26448 transport.
26449
26450 .vitem &%quota_%&<&'time'&>
26451 .cindex "quota" "error testing in retry rule"
26452 .cindex "retry" "quota error testing"
26453 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
26454 transport, and the mailbox has not been accessed for <&'time'&>. For example,
26455 &'quota_4d'& applies to a quota error when the mailbox has not been accessed
26456 for four days.
26457 .endlist
26458
26459 .cindex "mailbox" "time of last read"
26460 The idea of &%quota_%&<&'time'&> is to make it possible to have shorter
26461 timeouts when the mailbox is full and is not being read by its owner. Ideally,
26462 it should be based on the last time that the user accessed the mailbox.
26463 However, it is not always possible to determine this. Exim uses the following
26464 heuristic rules:
26465
26466 .ilist
26467 If the mailbox is a single file, the time of last access (the &"atime"&) is
26468 used. As no new messages are being delivered (because the mailbox is over
26469 quota), Exim does not access the file, so this is the time of last user access.
26470 .next
26471 .cindex "maildir format" "time of last read"
26472 For a maildir delivery, the time of last modification of the &_new_&
26473 subdirectory is used. As the mailbox is over quota, no new files are created in
26474 the &_new_& subdirectory, because no new messages are being delivered. Any
26475 change to the &_new_& subdirectory is therefore assumed to be the result of an
26476 MUA moving a new message to the &_cur_& directory when it is first read. The
26477 time that is used is therefore the last time that the user read a new message.
26478 .next
26479 For other kinds of multi-file mailbox, the time of last access cannot be
26480 obtained, so a retry rule that uses this type of error field is never matched.
26481 .endlist
26482
26483 The quota errors apply both to system-enforced quotas and to Exim's own quota
26484 mechanism in the &(appendfile)& transport. The &'quota'& error also applies
26485 when a local delivery is deferred because a partition is full (the ENOSPC
26486 error).
26487
26488
26489
26490 .section "Retry rules for specified senders" "SECID162"
26491 .cindex "retry" "rules; sender-specific"
26492 You can specify retry rules that apply only when the failing message has a
26493 specific sender. In particular, this can be used to define retry rules that
26494 apply only to bounce messages. The third item in a retry rule can be of this
26495 form:
26496 .display
26497 &`senders=`&<&'address list'&>
26498 .endd
26499 The retry timings themselves are then the fourth item. For example:
26500 .code
26501 *   rcpt_4xx   senders=:   F,1h,30m
26502 .endd
26503 matches recipient 4&'xx'& errors for bounce messages sent to any address at any
26504 host. If the address list contains white space, it must be enclosed in quotes.
26505 For example:
26506 .code
26507 a.domain  rcpt_452  senders="xb.dom : yc.dom"  G,8h,10m,1.5
26508 .endd
26509 &*Warning*&: This facility can be unhelpful if it is used for host errors
26510 (which do not depend on the recipient). The reason is that the sender is used
26511 only to match the retry rule. Once the rule has been found for a host error,
26512 its contents are used to set a retry time for the host, and this will apply to
26513 all messages, not just those with specific senders.
26514
26515 When testing retry rules using &%-brt%&, you can supply a sender using the
26516 &%-f%& command line option, like this:
26517 .code
26518 exim -f "" -brt user@dom.ain
26519 .endd
26520 If you do not set &%-f%& with &%-brt%&, a retry rule that contains a senders
26521 list is never matched.
26522
26523
26524
26525
26526
26527 .section "Retry parameters" "SECID163"
26528 .cindex "retry" "parameters in rules"
26529 The third (or fourth, if a senders list is present) field in a retry rule is a
26530 sequence of retry parameter sets, separated by semicolons. Each set consists of
26531 .display
26532 <&'letter'&>,<&'cutoff time'&>,<&'arguments'&>
26533 .endd
26534 The letter identifies the algorithm for computing a new retry time; the cutoff
26535 time is the time beyond which this algorithm no longer applies, and the
26536 arguments vary the algorithm's action. The cutoff time is measured from the
26537 time that the first failure for the domain (combined with the local part if
26538 relevant) was detected, not from the time the message was received.
26539
26540 .cindex "retry" "algorithms"
26541 .cindex "retry" "fixed intervals"
26542 .cindex "retry" "increasing intervals"
26543 .cindex "retry" "random intervals"
26544 The available algorithms are:
26545
26546 .ilist
26547 &'F'&: retry at fixed intervals. There is a single time parameter specifying
26548 the interval.
26549 .next
26550 &'G'&: retry at geometrically increasing intervals. The first argument
26551 specifies a starting value for the interval, and the second a multiplier, which
26552 is used to increase the size of the interval at each retry.
26553 .next
26554 &'H'&: retry at randomized intervals. The arguments are as for &'G'&. For each
26555 retry, the previous interval is multiplied by the factor in order to get a
26556 maximum for the next interval. The minimum interval is the first argument of
26557 the parameter, and an actual interval is chosen randomly between them. Such a
26558 rule has been found to be helpful in cluster configurations when all the
26559 members of the cluster restart at once, and may therefore synchronize their
26560 queue processing times.
26561 .endlist
26562
26563 When computing the next retry time, the algorithm definitions are scanned in
26564 order until one whose cutoff time has not yet passed is reached. This is then
26565 used to compute a new retry time that is later than the current time. In the
26566 case of fixed interval retries, this simply means adding the interval to the
26567 current time. For geometrically increasing intervals, retry intervals are
26568 computed from the rule's parameters until one that is greater than the previous
26569 interval is found. The main configuration variable
26570 .cindex "limit" "retry interval"
26571 .cindex "retry" "interval, maximum"
26572 .oindex "&%retry_interval_max%&"
26573 &%retry_interval_max%& limits the maximum interval between retries. It
26574 cannot be set greater than &`24h`&, which is its default value.
26575
26576 A single remote domain may have a number of hosts associated with it, and each
26577 host may have more than one IP address. Retry algorithms are selected on the
26578 basis of the domain name, but are applied to each IP address independently. If,
26579 for example, a host has two IP addresses and one is unusable, Exim will
26580 generate retry times for it and will not try to use it until its next retry
26581 time comes. Thus the good IP address is likely to be tried first most of the
26582 time.
26583
26584 .cindex "hints database" "use for retrying"
26585 Retry times are hints rather than promises. Exim does not make any attempt to
26586 run deliveries exactly at the computed times. Instead, a queue runner process
26587 starts delivery processes for delayed messages periodically, and these attempt
26588 new deliveries only for those addresses that have passed their next retry time.
26589 If a new message arrives for a deferred address, an immediate delivery attempt
26590 occurs only if the address has passed its retry time. In the absence of new
26591 messages, the minimum time between retries is the interval between queue runner
26592 processes. There is not much point in setting retry times of five minutes if
26593 your queue runners happen only once an hour, unless there are a significant
26594 number of incoming messages (which might be the case on a system that is
26595 sending everything to a smart host, for example).
26596
26597 The data in the retry hints database can be inspected by using the
26598 &'exim_dumpdb'& or &'exim_fixdb'& utility programs (see chapter
26599 &<<CHAPutils>>&). The latter utility can also be used to change the data. The
26600 &'exinext'& utility script can be used to find out what the next retry times
26601 are for the hosts associated with a particular mail domain, and also for local
26602 deliveries that have been deferred.
26603
26604
26605 .section "Retry rule examples" "SECID164"
26606 Here are some example retry rules:
26607 .code
26608 alice@wonderland.fict.example quota_5d  F,7d,3h
26609 wonderland.fict.example       quota_5d
26610 wonderland.fict.example       *         F,1h,15m; G,2d,1h,2;
26611 lookingglass.fict.example     *         F,24h,30m;
26612 *                 refused_A   F,2h,20m;
26613 *                 *           F,2h,15m; G,16h,1h,1.5; F,5d,8h
26614 .endd
26615 The first rule sets up special handling for mail to
26616 &'alice@wonderland.fict.example'& when there is an over-quota error and the
26617 mailbox has not been read for at least 5 days. Retries continue every three
26618 hours for 7 days. The second rule handles over-quota errors for all other local
26619 parts at &'wonderland.fict.example'&; the absence of a local part has the same
26620 effect as supplying &"*@"&. As no retry algorithms are supplied, messages that
26621 fail are bounced immediately if the mailbox has not been read for at least 5
26622 days.
26623
26624 The third rule handles all other errors at &'wonderland.fict.example'&; retries
26625 happen every 15 minutes for an hour, then with geometrically increasing
26626 intervals until two days have passed since a delivery first failed. After the
26627 first hour there is a delay of one hour, then two hours, then four hours, and
26628 so on (this is a rather extreme example).
26629
26630 The fourth rule controls retries for the domain &'lookingglass.fict.example'&.
26631 They happen every 30 minutes for 24 hours only. The remaining two rules handle
26632 all other domains, with special action for connection refusal from hosts that
26633 were not obtained from an MX record.
26634
26635 The final rule in a retry configuration should always have asterisks in the
26636 first two fields so as to provide a general catch-all for any addresses that do
26637 not have their own special handling. This example tries every 15 minutes for 2
26638 hours, then with intervals starting at one hour and increasing by a factor of
26639 1.5 up to 16 hours, then every 8 hours up to 5 days.
26640
26641
26642
26643 .section "Timeout of retry data" "SECID165"
26644 .cindex "timeout" "of retry data"
26645 .oindex "&%retry_data_expire%&"
26646 .cindex "hints database" "data expiry"
26647 .cindex "retry" "timeout of data"
26648 Exim timestamps the data that it writes to its retry hints database. When it
26649 consults the data during a delivery it ignores any that is older than the value
26650 set in &%retry_data_expire%& (default 7 days). If, for example, a host hasn't
26651 been tried for 7 days, Exim will try to deliver to it immediately a message
26652 arrives, and if that fails, it will calculate a retry time as if it were
26653 failing for the first time.
26654
26655 This improves the behaviour for messages routed to rarely-used hosts such as MX
26656 backups. If such a host was down at one time, and happens to be down again when
26657 Exim tries a month later, using the old retry data would imply that it had been
26658 down all the time, which is not a justified assumption.
26659
26660 If a host really is permanently dead, this behaviour causes a burst of retries
26661 every now and again, but only if messages routed to it are rare. If there is a
26662 message at least once every 7 days the retry data never expires.
26663
26664
26665
26666
26667 .section "Long-term failures" "SECID166"
26668 .cindex "delivery failure, long-term"
26669 .cindex "retry" "after long-term failure"
26670 Special processing happens when an email address has been failing for so long
26671 that the cutoff time for the last algorithm is reached. For example, using the
26672 default retry rule:
26673 .code
26674 * * F,2h,15m; G,16h,1h,1.5; F,4d,6h
26675 .endd
26676 the cutoff time is four days. Reaching the retry cutoff is independent of how
26677 long any specific message has been failing; it is the length of continuous
26678 failure for the recipient address that counts.
26679
26680 When the cutoff time is reached for a local delivery, or for all the IP
26681 addresses associated with a remote delivery, a subsequent delivery failure
26682 causes Exim to give up on the address, and a bounce message is generated.
26683 In order to cater for new messages that use the failing address, a next retry
26684 time is still computed from the final algorithm, and is used as follows:
26685
26686 For local deliveries, one delivery attempt is always made for any subsequent
26687 messages. If this delivery fails, the address fails immediately. The
26688 post-cutoff retry time is not used.
26689
26690 .cindex "final cutoff" "retries, controlling"
26691 .cindex retry "final cutoff"
26692 If the delivery is remote, there are two possibilities, controlled by the
26693 .oindex "&%delay_after_cutoff%&"
26694 &%delay_after_cutoff%& option of the &(smtp)& transport. The option is true by
26695 default. Until the post-cutoff retry time for one of the IP addresses,
26696 as set by the &%retry_data_expire%& option, is
26697 reached, the failing email address is bounced immediately, without a delivery
26698 attempt taking place. After that time, one new delivery attempt is made to
26699 those IP addresses that are past their retry times, and if that still fails,
26700 the address is bounced and new retry times are computed.
26701
26702 In other words, when all the hosts for a given email address have been failing
26703 for a long time, Exim bounces rather then defers until one of the hosts' retry
26704 times is reached. Then it tries once, and bounces if that attempt fails. This
26705 behaviour ensures that few resources are wasted in repeatedly trying to deliver
26706 to a broken destination, but if the host does recover, Exim will eventually
26707 notice.
26708
26709 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
26710 addresses are past their final cutoff time, Exim tries to deliver to those IP
26711 addresses that have not been tried since the message arrived. If there are
26712 no suitable IP addresses, or if they all fail, the address is bounced. In other
26713 words, it does not delay when a new message arrives, but tries the expired
26714 addresses immediately, unless they have been tried since the message arrived.
26715 If there is a continuous stream of messages for the failing domains, setting
26716 &%delay_after_cutoff%& false means that there will be many more attempts to
26717 deliver to permanently failing IP addresses than when &%delay_after_cutoff%& is
26718 true.
26719
26720 .section "Deliveries that work intermittently" "SECID167"
26721 .cindex "retry" "intermittently working deliveries"
26722 Some additional logic is needed to cope with cases where a host is
26723 intermittently available, or when a message has some attribute that prevents
26724 its delivery when others to the same address get through. In this situation,
26725 because some messages are successfully delivered, the &"retry clock"& for the
26726 host or address keeps getting reset by the successful deliveries, and so
26727 failing messages remain in the queue for ever because the cutoff time is never
26728 reached.
26729
26730 Two exceptional actions are applied to prevent this happening. The first
26731 applies to errors that are related to a message rather than a remote host.
26732 Section &<<SECToutSMTPerr>>& has a discussion of the different kinds of error;
26733 examples of message-related errors are 4&'xx'& responses to MAIL or DATA
26734 commands, and quota failures. For this type of error, if a message's arrival
26735 time is earlier than the &"first failed"& time for the error, the earlier time
26736 is used when scanning the retry rules to decide when to try next and when to
26737 time out the address.
26738
26739 The exceptional second action applies in all cases. If a message has been on
26740 the queue for longer than the cutoff time of any applicable retry rule for a
26741 given address, a delivery is attempted for that address, even if it is not yet
26742 time, and if this delivery fails, the address is timed out. A new retry time is
26743 not computed in this case, so that other messages for the same address are
26744 considered immediately.
26745 .ecindex IIDretconf1
26746 .ecindex IIDregconf2
26747
26748
26749
26750
26751
26752
26753 . ////////////////////////////////////////////////////////////////////////////
26754 . ////////////////////////////////////////////////////////////////////////////
26755
26756 .chapter "SMTP authentication" "CHAPSMTPAUTH"
26757 .scindex IIDauthconf1 "SMTP" "authentication configuration"
26758 .scindex IIDauthconf2 "authentication"
26759 The &"authenticators"& section of Exim's runtime configuration is concerned
26760 with SMTP authentication. This facility is an extension to the SMTP protocol,
26761 described in RFC 2554, which allows a client SMTP host to authenticate itself
26762 to a server. This is a common way for a server to recognize clients that are
26763 permitted to use it as a relay. SMTP authentication is not of relevance to the
26764 transfer of mail between servers that have no managerial connection with each
26765 other.
26766
26767 .cindex "AUTH" "description of"
26768 Very briefly, the way SMTP authentication works is as follows:
26769
26770 .ilist
26771 The server advertises a number of authentication &'mechanisms'& in response to
26772 the client's EHLO command.
26773 .next
26774 The client issues an AUTH command, naming a specific mechanism. The command
26775 may, optionally, contain some authentication data.
26776 .next
26777 The server may issue one or more &'challenges'&, to which the client must send
26778 appropriate responses. In simple authentication mechanisms, the challenges are
26779 just prompts for user names and passwords. The server does not have to issue
26780 any challenges &-- in some mechanisms the relevant data may all be transmitted
26781 with the AUTH command.
26782 .next
26783 The server either accepts or denies authentication.
26784 .next
26785 If authentication succeeds, the client may optionally make use of the AUTH
26786 option on the MAIL command to pass an authenticated sender in subsequent
26787 mail transactions. Authentication lasts for the remainder of the SMTP
26788 connection.
26789 .next
26790 If authentication fails, the client may give up, or it may try a different
26791 authentication mechanism, or it may try transferring mail over the
26792 unauthenticated connection.
26793 .endlist
26794
26795 If you are setting up a client, and want to know which authentication
26796 mechanisms the server supports, you can use Telnet to connect to port 25 (the
26797 SMTP port) on the server, and issue an EHLO command. The response to this
26798 includes the list of supported mechanisms. For example:
26799 .display
26800 &`$ `&&*&`telnet server.example 25`&*&
26801 &`Trying 192.168.34.25...`&
26802 &`Connected to server.example.`&
26803 &`Escape character is &#x0027;^]&#x0027;.`&
26804 &`220 server.example ESMTP Exim 4.20 ...`&
26805 &*&`ehlo client.example`&*&
26806 &`250-server.example Hello client.example [10.8.4.5]`&
26807 &`250-SIZE 52428800`&
26808 &`250-PIPELINING`&
26809 &`250-AUTH PLAIN`&
26810 &`250 HELP`&
26811 .endd
26812 The second-last line of this example output shows that the server supports
26813 authentication using the PLAIN mechanism. In Exim, the different authentication
26814 mechanisms are configured by specifying &'authenticator'& drivers. Like the
26815 routers and transports, which authenticators are included in the binary is
26816 controlled by build-time definitions. The following are currently available,
26817 included by setting
26818 .code
26819 AUTH_CRAM_MD5=yes
26820 AUTH_CYRUS_SASL=yes
26821 AUTH_DOVECOT=yes
26822 AUTH_EXTERNAL=yes
26823 AUTH_GSASL=yes
26824 AUTH_HEIMDAL_GSSAPI=yes
26825 AUTH_PLAINTEXT=yes
26826 AUTH_SPA=yes
26827 AUTH_TLS=yes
26828 .endd
26829 in &_Local/Makefile_&, respectively. The first of these supports the CRAM-MD5
26830 authentication mechanism (RFC 2195), and the second provides an interface to
26831 the Cyrus SASL authentication library.
26832 The third is an interface to Dovecot's authentication system, delegating the
26833 work via a socket interface.
26834 The fourth provides for negotiation of authentication done via non-SMTP means,
26835 as defined by RFC 4422 Appendix A.
26836 The fifth provides an interface to the GNU SASL authentication library, which
26837 provides mechanisms but typically not data sources.
26838 The sixth provides direct access to Heimdal GSSAPI, geared for Kerberos, but
26839 supporting setting a server keytab.
26840 The seventh can be configured to support
26841 the PLAIN authentication mechanism (RFC 2595) or the LOGIN mechanism, which is
26842 not formally documented, but used by several MUAs.
26843 The eighth authenticator
26844 supports Microsoft's &'Secure Password Authentication'& mechanism.
26845 The last is an Exim authenticator but not an SMTP one;
26846 instead it can use information from a TLS negotiation.
26847
26848 The authenticators are configured using the same syntax as other drivers (see
26849 section &<<SECTfordricon>>&). If no authenticators are required, no
26850 authentication section need be present in the configuration file. Each
26851 authenticator can in principle have both server and client functions. When Exim
26852 is receiving SMTP mail, it is acting as a server; when it is sending out
26853 messages over SMTP, it is acting as a client. Authenticator configuration
26854 options are provided for use in both these circumstances.
26855
26856 To make it clear which options apply to which situation, the prefixes
26857 &%server_%& and &%client_%& are used on option names that are specific to
26858 either the server or the client function, respectively. Server and client
26859 functions are disabled if none of their options are set. If an authenticator is
26860 to be used for both server and client functions, a single definition, using
26861 both sets of options, is required. For example:
26862 .code
26863 cram:
26864   driver = cram_md5
26865   public_name = CRAM-MD5
26866   server_secret = ${if eq{$auth1}{ph10}{secret1}fail}
26867   client_name = ph10
26868   client_secret = secret2
26869 .endd
26870 The &%server_%& option is used when Exim is acting as a server, and the
26871 &%client_%& options when it is acting as a client.
26872
26873 Descriptions of the individual authenticators are given in subsequent chapters.
26874 The remainder of this chapter covers the generic options for the
26875 authenticators, followed by general discussion of the way authentication works
26876 in Exim.
26877
26878 &*Beware:*& the meaning of &$auth1$&, &$auth2$&, ... varies on a per-driver and
26879 per-mechanism basis.  Please read carefully to determine which variables hold
26880 account labels such as usercodes and which hold passwords or other
26881 authenticating data.
26882
26883 Note that some mechanisms support two different identifiers for accounts: the
26884 &'authentication id'& and the &'authorization id'&.  The contractions &'authn'&
26885 and &'authz'& are commonly encountered.  The American spelling is standard here.
26886 Conceptually, authentication data such as passwords are tied to the identifier
26887 used to authenticate; servers may have rules to permit one user to act as a
26888 second user, so that after login the session is treated as though that second
26889 user had logged in.  That second user is the &'authorization id'&.  A robust
26890 configuration might confirm that the &'authz'& field is empty or matches the
26891 &'authn'& field.  Often this is just ignored.  The &'authn'& can be considered
26892 as verified data, the &'authz'& as an unverified request which the server might
26893 choose to honour.
26894
26895 A &'realm'& is a text string, typically a domain name, presented by a server
26896 to a client to help it select an account and credentials to use.  In some
26897 mechanisms, the client and server provably agree on the realm, but clients
26898 typically can not treat the realm as secure data to be blindly trusted.
26899
26900
26901
26902 .section "Generic options for authenticators" "SECID168"
26903 .cindex "authentication" "generic options"
26904 .cindex "options" "generic; for authenticators"
26905
26906 .option client_condition authenticators string&!! unset
26907 When Exim is authenticating as a client, it skips any authenticator whose
26908 &%client_condition%& expansion yields &"0"&, &"no"&, or &"false"&. This can be
26909 used, for example, to skip plain text authenticators when the connection is not
26910 encrypted by a setting such as:
26911 .code
26912 client_condition = ${if !eq{$tls_out_cipher}{}}
26913 .endd
26914
26915
26916 .option client_set_id authenticators string&!! unset
26917 When client authentication succeeds, this condition is expanded; the
26918 result is used in the log lines for outbound messages.
26919 Typically it will be the user name used for authentication.
26920
26921
26922 .option driver authenticators string unset
26923 This option must always be set. It specifies which of the available
26924 authenticators is to be used.
26925
26926
26927 .option public_name authenticators string unset
26928 This option specifies the name of the authentication mechanism that the driver
26929 implements, and by which it is known to the outside world. These names should
26930 contain only upper case letters, digits, underscores, and hyphens (RFC 2222),
26931 but Exim in fact matches them caselessly. If &%public_name%& is not set, it
26932 defaults to the driver's instance name.
26933
26934
26935 .option server_advertise_condition authenticators string&!! unset
26936 When a server is about to advertise an authentication mechanism, the condition
26937 is expanded. If it yields the empty string, &"0"&, &"no"&, or &"false"&, the
26938 mechanism is not advertised.
26939 If the expansion fails, the mechanism is not advertised. If the failure was not
26940 forced, and was not caused by a lookup defer, the incident is logged.
26941 See section &<<SECTauthexiser>>& below for further discussion.
26942
26943
26944 .option server_condition authenticators string&!! unset
26945 This option must be set for a &%plaintext%& server authenticator, where it
26946 is used directly to control authentication. See section &<<SECTplainserver>>&
26947 for details.
26948
26949 For the &(gsasl)& authenticator, this option is required for various
26950 mechanisms; see chapter &<<CHAPgsasl>>& for details.
26951
26952 For the other authenticators, &%server_condition%& can be used as an additional
26953 authentication or authorization mechanism that is applied after the other
26954 authenticator conditions succeed. If it is set, it is expanded when the
26955 authenticator would otherwise return a success code. If the expansion is forced
26956 to fail, authentication fails. Any other expansion failure causes a temporary
26957 error code to be returned. If the result of a successful expansion is an empty
26958 string, &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
26959 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds. For any
26960 other result, a temporary error code is returned, with the expanded string as
26961 the error text.
26962
26963
26964 .option server_debug_print authenticators string&!! unset
26965 If this option is set and authentication debugging is enabled (see the &%-d%&
26966 command line option), the string is expanded and included in the debugging
26967 output when the authenticator is run as a server. This can help with checking
26968 out the values of variables.
26969 If expansion of the string fails, the error message is written to the debugging
26970 output, and Exim carries on processing.
26971
26972
26973 .option server_set_id authenticators string&!! unset
26974 .vindex "&$authenticated_id$&"
26975 .vindex "&$authenticated_fail_id$&"
26976 When an Exim server successfully authenticates a client, this string is
26977 expanded using data from the authentication, and preserved for any incoming
26978 messages in the variable &$authenticated_id$&. It is also included in the log
26979 lines for incoming messages. For example, a user/password authenticator
26980 configuration might preserve the user name that was used to authenticate, and
26981 refer to it subsequently during delivery of the message.
26982 On a failing authentication the expansion result is instead saved in
26983 the &$authenticated_fail_id$& variable.
26984 If expansion fails, the option is ignored.
26985
26986
26987 .option server_mail_auth_condition authenticators string&!! unset
26988 This option allows a server to discard authenticated sender addresses supplied
26989 as part of MAIL commands in SMTP connections that are authenticated by the
26990 driver on which &%server_mail_auth_condition%& is set. The option is not used
26991 as part of the authentication process; instead its (unexpanded) value is
26992 remembered for later use.
26993 How it is used is described in the following section.
26994
26995
26996
26997
26998
26999 .section "The AUTH parameter on MAIL commands" "SECTauthparamail"
27000 .cindex "authentication" "sender; authenticated"
27001 .cindex "AUTH" "on MAIL command"
27002 When a client supplied an AUTH= item on a MAIL command, Exim applies
27003 the following checks before accepting it as the authenticated sender of the
27004 message:
27005
27006 .ilist
27007 If the connection is not using extended SMTP (that is, HELO was used rather
27008 than EHLO), the use of AUTH= is a syntax error.
27009 .next
27010 If the value of the AUTH= parameter is &"<>"&, it is ignored.
27011 .next
27012 .vindex "&$authenticated_sender$&"
27013 If &%acl_smtp_mailauth%& is defined, the ACL it specifies is run. While it is
27014 running, the value of &$authenticated_sender$& is set to the value obtained
27015 from the AUTH= parameter. If the ACL does not yield &"accept"&, the value of
27016 &$authenticated_sender$& is deleted. The &%acl_smtp_mailauth%& ACL may not
27017 return &"drop"& or &"discard"&. If it defers, a temporary error code (451) is
27018 given for the MAIL command.
27019 .next
27020 If &%acl_smtp_mailauth%& is not defined, the value of the AUTH= parameter
27021 is accepted and placed in &$authenticated_sender$& only if the client has
27022 authenticated.
27023 .next
27024 If the AUTH= value was accepted by either of the two previous rules, and
27025 the client has authenticated, and the authenticator has a setting for the
27026 &%server_mail_auth_condition%&, the condition is checked at this point. The
27027 valued that was saved from the authenticator is expanded. If the expansion
27028 fails, or yields an empty string, &"0"&, &"no"&, or &"false"&, the value of
27029 &$authenticated_sender$& is deleted. If the expansion yields any other value,
27030 the value of &$authenticated_sender$& is retained and passed on with the
27031 message.
27032 .endlist
27033
27034
27035 When &$authenticated_sender$& is set for a message, it is passed on to other
27036 hosts to which Exim authenticates as a client. Do not confuse this value with
27037 &$authenticated_id$&, which is a string obtained from the authentication
27038 process, and which is not usually a complete email address.
27039
27040 .vindex "&$sender_address$&"
27041 Whenever an AUTH= value is ignored, the incident is logged. The ACL for
27042 MAIL, if defined, is run after AUTH= is accepted or ignored. It can
27043 therefore make use of &$authenticated_sender$&. The converse is not true: the
27044 value of &$sender_address$& is not yet set up when the &%acl_smtp_mailauth%&
27045 ACL is run.
27046
27047
27048
27049 .section "Authentication on an Exim server" "SECTauthexiser"
27050 .cindex "authentication" "on an Exim server"
27051 When Exim receives an EHLO command, it advertises the public names of those
27052 authenticators that are configured as servers, subject to the following
27053 conditions:
27054
27055 .ilist
27056 The client host must match &%auth_advertise_hosts%& (default *).
27057 .next
27058 It the &%server_advertise_condition%& option is set, its expansion must not
27059 yield the empty string, &"0"&, &"no"&, or &"false"&.
27060 .endlist
27061
27062 The order in which the authenticators are defined controls the order in which
27063 the mechanisms are advertised.
27064
27065 Some mail clients (for example, some versions of Netscape) require the user to
27066 provide a name and password for authentication whenever AUTH is advertised,
27067 even though authentication may not in fact be needed (for example, Exim may be
27068 set up to allow unconditional relaying from the client by an IP address check).
27069 You can make such clients more friendly by not advertising AUTH to them.
27070 For example, if clients on the 10.9.8.0/24 network are permitted (by the ACL
27071 that runs for RCPT) to relay without authentication, you should set
27072 .code
27073 auth_advertise_hosts = ! 10.9.8.0/24
27074 .endd
27075 so that no authentication mechanisms are advertised to them.
27076
27077 The &%server_advertise_condition%& controls the advertisement of individual
27078 authentication mechanisms. For example, it can be used to restrict the
27079 advertisement of a particular mechanism to encrypted connections, by a setting
27080 such as:
27081 .code
27082 server_advertise_condition = ${if eq{$tls_in_cipher}{}{no}{yes}}
27083 .endd
27084 .vindex "&$tls_in_cipher$&"
27085 If the session is encrypted, &$tls_in_cipher$& is not empty, and so the expansion
27086 yields &"yes"&, which allows the advertisement to happen.
27087
27088 When an Exim server receives an AUTH command from a client, it rejects it
27089 immediately if AUTH was not advertised in response to an earlier EHLO
27090 command. This is the case if
27091
27092 .ilist
27093 The client host does not match &%auth_advertise_hosts%&; or
27094 .next
27095 No authenticators are configured with server options; or
27096 .next
27097 Expansion of &%server_advertise_condition%& blocked the advertising of all the
27098 server authenticators.
27099 .endlist
27100
27101
27102 Otherwise, Exim runs the ACL specified by &%acl_smtp_auth%& in order
27103 to decide whether to accept the command. If &%acl_smtp_auth%& is not set,
27104 AUTH is accepted from any client host.
27105
27106 If AUTH is not rejected by the ACL, Exim searches its configuration for a
27107 server authentication mechanism that was advertised in response to EHLO and
27108 that matches the one named in the AUTH command. If it finds one, it runs
27109 the appropriate authentication protocol, and authentication either succeeds or
27110 fails. If there is no matching advertised mechanism, the AUTH command is
27111 rejected with a 504 error.
27112
27113 .vindex "&$received_protocol$&"
27114 .vindex "&$sender_host_authenticated$&"
27115 When a message is received from an authenticated host, the value of
27116 &$received_protocol$& is set to &"esmtpa"& or &"esmtpsa"& instead of &"esmtp"&
27117 or &"esmtps"&, and &$sender_host_authenticated$& contains the name (not the
27118 public name) of the authenticator driver that successfully authenticated the
27119 client from which the message was received. This variable is empty if there was
27120 no successful authentication.
27121
27122 .cindex authentication "expansion item"
27123 Successful authentication sets up information used by the
27124 &%authresults%& expansion item.
27125
27126
27127
27128
27129 .section "Testing server authentication" "SECID169"
27130 .cindex "authentication" "testing a server"
27131 .cindex "AUTH" "testing a server"
27132 .cindex "base64 encoding" "creating authentication test data"
27133 Exim's &%-bh%& option can be useful for testing server authentication
27134 configurations. The data for the AUTH command has to be sent using base64
27135 encoding. A quick way to produce such data for testing is the following Perl
27136 script:
27137 .code
27138 use MIME::Base64;
27139 printf ("%s", encode_base64(eval "\"$ARGV[0]\""));
27140 .endd
27141 .cindex "binary zero" "in authentication data"
27142 This interprets its argument as a Perl string, and then encodes it. The
27143 interpretation as a Perl string allows binary zeros, which are required for
27144 some kinds of authentication, to be included in the data. For example, a
27145 command line to run this script on such data might be
27146 .code
27147 encode '\0user\0password'
27148 .endd
27149 Note the use of single quotes to prevent the shell interpreting the
27150 backslashes, so that they can be interpreted by Perl to specify characters
27151 whose code value is zero.
27152
27153 &*Warning 1*&: If either of the user or password strings starts with an octal
27154 digit, you must use three zeros instead of one after the leading backslash. If
27155 you do not, the octal digit that starts your string will be incorrectly
27156 interpreted as part of the code for the first character.
27157
27158 &*Warning 2*&: If there are characters in the strings that Perl interprets
27159 specially, you must use a Perl escape to prevent them being misinterpreted. For
27160 example, a command such as
27161 .code
27162 encode '\0user@domain.com\0pas$$word'
27163 .endd
27164 gives an incorrect answer because of the unescaped &"@"& and &"$"& characters.
27165
27166 If you have the &%mimencode%& command installed, another way to do produce
27167 base64-encoded strings is to run the command
27168 .code
27169 echo -e -n `\0user\0password' | mimencode
27170 .endd
27171 The &%-e%& option of &%echo%& enables the interpretation of backslash escapes
27172 in the argument, and the &%-n%& option specifies no newline at the end of its
27173 output. However, not all versions of &%echo%& recognize these options, so you
27174 should check your version before relying on this suggestion.
27175
27176
27177
27178 .section "Authentication by an Exim client" "SECID170"
27179 .cindex "authentication" "on an Exim client"
27180 The &(smtp)& transport has two options called &%hosts_require_auth%& and
27181 &%hosts_try_auth%&. When the &(smtp)& transport connects to a server that
27182 announces support for authentication, and the host matches an entry in either
27183 of these options, Exim (as a client) tries to authenticate as follows:
27184
27185 .ilist
27186 For each authenticator that is configured as a client, in the order in which
27187 they are defined in the configuration, it searches the authentication
27188 mechanisms announced by the server for one whose name matches the public name
27189 of the authenticator.
27190 .next
27191 .vindex "&$host$&"
27192 .vindex "&$host_address$&"
27193 When it finds one that matches, it runs the authenticator's client code. The
27194 variables &$host$& and &$host_address$& are available for any string expansions
27195 that the client might do. They are set to the server's name and IP address. If
27196 any expansion is forced to fail, the authentication attempt is abandoned, and
27197 Exim moves on to the next authenticator. Otherwise an expansion failure causes
27198 delivery to be deferred.
27199 .next
27200 If the result of the authentication attempt is a temporary error or a timeout,
27201 Exim abandons trying to send the message to the host for the moment. It will
27202 try again later. If there are any backup hosts available, they are tried in the
27203 usual way.
27204 .next
27205 If the response to authentication is a permanent error (5&'xx'& code), Exim
27206 carries on searching the list of authenticators and tries another one if
27207 possible. If all authentication attempts give permanent errors, or if there are
27208 no attempts because no mechanisms match (or option expansions force failure),
27209 what happens depends on whether the host matches &%hosts_require_auth%& or
27210 &%hosts_try_auth%&. In the first case, a temporary error is generated, and
27211 delivery is deferred. The error can be detected in the retry rules, and thereby
27212 turned into a permanent error if you wish. In the second case, Exim tries to
27213 deliver the message unauthenticated.
27214 .endlist
27215
27216 Note that the hostlist test for whether to do authentication can be
27217 confused if name-IP lookups change between the time the peer is decided
27218 upon and the time that the transport runs.  For example, with a manualroute
27219 router given a host name, and with DNS "round-robin" used by that name: if
27220 the local resolver cache times out between the router and the transport
27221 running, the transport may get an IP for the name for its authentication
27222 check which does not match the connection peer IP.
27223 No authentication will then be done, despite the names being identical.
27224
27225 For such cases use a separate transport which always authenticates.
27226
27227 .cindex "AUTH" "on MAIL command"
27228 When Exim has authenticated itself to a remote server, it adds the AUTH
27229 parameter to the MAIL commands it sends, if it has an authenticated sender for
27230 the message. If the message came from a remote host, the authenticated sender
27231 is the one that was receiving on an incoming MAIL command, provided that the
27232 incoming connection was authenticated and the &%server_mail_auth%& condition
27233 allowed the authenticated sender to be retained. If a local process calls Exim
27234 to send a message, the sender address that is built from the login name and
27235 &%qualify_domain%& is treated as authenticated. However, if the
27236 &%authenticated_sender%& option is set on the &(smtp)& transport, it overrides
27237 the authenticated sender that was received with the message.
27238 .ecindex IIDauthconf1
27239 .ecindex IIDauthconf2
27240
27241
27242
27243
27244
27245
27246 . ////////////////////////////////////////////////////////////////////////////
27247 . ////////////////////////////////////////////////////////////////////////////
27248
27249 .chapter "The plaintext authenticator" "CHAPplaintext"
27250 .scindex IIDplaiauth1 "&(plaintext)& authenticator"
27251 .scindex IIDplaiauth2 "authenticators" "&(plaintext)&"
27252 The &(plaintext)& authenticator can be configured to support the PLAIN and
27253 LOGIN authentication mechanisms, both of which transfer authentication data as
27254 plain (unencrypted) text (though base64 encoded). The use of plain text is a
27255 security risk; you are strongly advised to insist on the use of SMTP encryption
27256 (see chapter &<<CHAPTLS>>&) if you use the PLAIN or LOGIN mechanisms. If you do
27257 use unencrypted plain text, you should not use the same passwords for SMTP
27258 connections as you do for login accounts.
27259
27260 .section "Avoiding cleartext use" "SECTplain_TLS"
27261 The following generic option settings will disable &(plaintext)& authenticators when
27262 TLS is not being used:
27263 .code
27264   server_advertise_condition = ${if def:tls_in_cipher }
27265   client_condition =           ${if def:tls_out_cipher}
27266 .endd
27267
27268 &*Note*&: a plaintext SMTP AUTH done inside TLS is not vulnerable to casual snooping,
27269 but is still vulnerable to a Man In The Middle attack unless certificates
27270 (including their names) have been properly verified.
27271
27272 .section "Plaintext server options" "SECID171"
27273 .cindex "options" "&(plaintext)& authenticator (server)"
27274 When configured as a server, &(plaintext)& uses the following options:
27275
27276 .option server_condition authenticators string&!! unset
27277 This is actually a global authentication option, but it must be set in order to
27278 configure the &(plaintext)& driver as a server. Its use is described below.
27279
27280 .option server_prompts plaintext "string list&!!" unset
27281 The contents of this option, after expansion, must be a colon-separated list of
27282 prompt strings. If expansion fails, a temporary authentication rejection is
27283 given.
27284
27285 .section "Using plaintext in a server" "SECTplainserver"
27286 .cindex "AUTH" "in &(plaintext)& authenticator"
27287 .cindex "binary zero" "in &(plaintext)& authenticator"
27288 .cindex "numerical variables (&$1$& &$2$& etc)" &&&
27289         "in &(plaintext)& authenticator"
27290 .vindex "&$auth1$&, &$auth2$&, etc"
27291 .cindex "base64 encoding" "in &(plaintext)& authenticator"
27292
27293 When running as a server, &(plaintext)& performs the authentication test by
27294 expanding a string. The data sent by the client with the AUTH command, or in
27295 response to subsequent prompts, is base64 encoded, and so may contain any byte
27296 values when decoded. If any data is supplied with the command, it is treated as
27297 a list of strings, separated by NULs (binary zeros), the first three of which
27298 are placed in the expansion variables &$auth1$&, &$auth2$&, and &$auth3$&
27299 (neither LOGIN nor PLAIN uses more than three strings).
27300
27301 For compatibility with previous releases of Exim, the values are also placed in
27302 the expansion variables &$1$&, &$2$&, and &$3$&. However, the use of these
27303 variables for this purpose is now deprecated, as it can lead to confusion in
27304 string expansions that also use them for other things.
27305
27306 If there are more strings in &%server_prompts%& than the number of strings
27307 supplied with the AUTH command, the remaining prompts are used to obtain more
27308 data. Each response from the client may be a list of NUL-separated strings.
27309
27310 .vindex "&$authenticated_id$&"
27311 Once a sufficient number of data strings have been received,
27312 &%server_condition%& is expanded. If the expansion is forced to fail,
27313 authentication fails. Any other expansion failure causes a temporary error code
27314 to be returned. If the result of a successful expansion is an empty string,
27315 &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
27316 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds and the
27317 generic &%server_set_id%& option is expanded and saved in &$authenticated_id$&.
27318 For any other result, a temporary error code is returned, with the expanded
27319 string as the error text.
27320
27321 &*Warning*&: If you use a lookup in the expansion to find the user's
27322 password, be sure to make the authentication fail if the user is unknown.
27323 There are good and bad examples at the end of the next section.
27324
27325
27326
27327 .section "The PLAIN authentication mechanism" "SECID172"
27328 .cindex "PLAIN authentication mechanism"
27329 .cindex authentication PLAIN
27330 .cindex "binary zero" "in &(plaintext)& authenticator"
27331 The PLAIN authentication mechanism (RFC 2595) specifies that three strings be
27332 sent as one item of data (that is, one combined string containing two NUL
27333 separators). The data is sent either as part of the AUTH command, or
27334 subsequently in response to an empty prompt from the server.
27335
27336 The second and third strings are a user name and a corresponding password.
27337 Using a single fixed user name and password as an example, this could be
27338 configured as follows:
27339 .code
27340 fixed_plain:
27341   driver = plaintext
27342   public_name = PLAIN
27343   server_prompts = :
27344   server_condition = \
27345     ${if and {{eq{$auth2}{username}}{eq{$auth3}{mysecret}}}}
27346   server_set_id = $auth2
27347 .endd
27348 Note that the default result strings from &%if%& (&"true"& or an empty string)
27349 are exactly what we want here, so they need not be specified. Obviously, if the
27350 password contains expansion-significant characters such as dollar, backslash,
27351 or closing brace, they have to be escaped.
27352
27353 The &%server_prompts%& setting specifies a single, empty prompt (empty items at
27354 the end of a string list are ignored). If all the data comes as part of the
27355 AUTH command, as is commonly the case, the prompt is not used. This
27356 authenticator is advertised in the response to EHLO as
27357 .code
27358 250-AUTH PLAIN
27359 .endd
27360 and a client host can authenticate itself by sending the command
27361 .code
27362 AUTH PLAIN AHVzZXJuYW1lAG15c2VjcmV0
27363 .endd
27364 As this contains three strings (more than the number of prompts), no further
27365 data is required from the client. Alternatively, the client may just send
27366 .code
27367 AUTH PLAIN
27368 .endd
27369 to initiate authentication, in which case the server replies with an empty
27370 prompt. The client must respond with the combined data string.
27371
27372 The data string is base64 encoded, as required by the RFC. This example,
27373 when decoded, is <&'NUL'&>&`username`&<&'NUL'&>&`mysecret`&, where <&'NUL'&>
27374 represents a zero byte. This is split up into three strings, the first of which
27375 is empty. The &%server_condition%& option in the authenticator checks that the
27376 second two are &`username`& and &`mysecret`& respectively.
27377
27378 Having just one fixed user name and password, as in this example, is not very
27379 realistic, though for a small organization with only a handful of
27380 authenticating clients it could make sense.
27381
27382 A more sophisticated instance of this authenticator could use the user name in
27383 &$auth2$& to look up a password in a file or database, and maybe do an encrypted
27384 comparison (see &%crypteq%& in chapter &<<CHAPexpand>>&). Here is a example of
27385 this approach, where the passwords are looked up in a DBM file. &*Warning*&:
27386 This is an incorrect example:
27387 .code
27388 server_condition = \
27389   ${if eq{$auth3}{${lookup{$auth2}dbm{/etc/authpwd}}}}
27390 .endd
27391 The expansion uses the user name (&$auth2$&) as the key to look up a password,
27392 which it then compares to the supplied password (&$auth3$&). Why is this example
27393 incorrect? It works fine for existing users, but consider what happens if a
27394 non-existent user name is given. The lookup fails, but as no success/failure
27395 strings are given for the lookup, it yields an empty string. Thus, to defeat
27396 the authentication, all a client has to do is to supply a non-existent user
27397 name and an empty password. The correct way of writing this test is:
27398 .code
27399 server_condition = ${lookup{$auth2}dbm{/etc/authpwd}\
27400   {${if eq{$value}{$auth3}}} {false}}
27401 .endd
27402 In this case, if the lookup succeeds, the result is checked; if the lookup
27403 fails, &"false"& is returned and authentication fails. If &%crypteq%& is being
27404 used instead of &%eq%&, the first example is in fact safe, because &%crypteq%&
27405 always fails if its second argument is empty. However, the second way of
27406 writing the test makes the logic clearer.
27407
27408
27409 .section "The LOGIN authentication mechanism" "SECID173"
27410 .cindex "LOGIN authentication mechanism"
27411 .cindex authentication LOGIN
27412 The LOGIN authentication mechanism is not documented in any RFC, but is in use
27413 in a number of programs. No data is sent with the AUTH command. Instead, a
27414 user name and password are supplied separately, in response to prompts. The
27415 plaintext authenticator can be configured to support this as in this example:
27416 .code
27417 fixed_login:
27418   driver = plaintext
27419   public_name = LOGIN
27420   server_prompts = User Name : Password
27421   server_condition = \
27422     ${if and {{eq{$auth1}{username}}{eq{$auth2}{mysecret}}}}
27423   server_set_id = $auth1
27424 .endd
27425 Because of the way plaintext operates, this authenticator accepts data supplied
27426 with the AUTH command (in contravention of the specification of LOGIN), but
27427 if the client does not supply it (as is the case for LOGIN clients), the prompt
27428 strings are used to obtain two data items.
27429
27430 Some clients are very particular about the precise text of the prompts. For
27431 example, Outlook Express is reported to recognize only &"Username:"& and
27432 &"Password:"&. Here is an example of a LOGIN authenticator that uses those
27433 strings. It uses the &%ldapauth%& expansion condition to check the user
27434 name and password by binding to an LDAP server:
27435 .code
27436 login:
27437   driver = plaintext
27438   public_name = LOGIN
27439   server_prompts = Username:: : Password::
27440   server_condition = ${if and{{ \
27441     !eq{}{$auth1} }{ \
27442     ldapauth{\
27443       user="uid=${quote_ldap_dn:$auth1},ou=people,o=example.org" \
27444       pass=${quote:$auth2} \
27445       ldap://ldap.example.org/} }} }
27446   server_set_id = uid=$auth1,ou=people,o=example.org
27447 .endd
27448 We have to check that the username is not empty before using it, because LDAP
27449 does not permit empty DN components. We must also use the &%quote_ldap_dn%&
27450 operator to correctly quote the DN for authentication. However, the basic
27451 &%quote%& operator, rather than any of the LDAP quoting operators, is the
27452 correct one to use for the password, because quoting is needed only to make
27453 the password conform to the Exim syntax. At the LDAP level, the password is an
27454 uninterpreted string.
27455
27456
27457 .section "Support for different kinds of authentication" "SECID174"
27458 A number of string expansion features are provided for the purpose of
27459 interfacing to different ways of user authentication. These include checking
27460 traditionally encrypted passwords from &_/etc/passwd_& (or equivalent), PAM,
27461 Radius, &%ldapauth%&, &'pwcheck'&, and &'saslauthd'&. For details see section
27462 &<<SECTexpcond>>&.
27463
27464
27465
27466
27467 .section "Using plaintext in a client" "SECID175"
27468 .cindex "options" "&(plaintext)& authenticator (client)"
27469 The &(plaintext)& authenticator has two client options:
27470
27471 .option client_ignore_invalid_base64 plaintext boolean false
27472 If the client receives a server prompt that is not a valid base64 string,
27473 authentication is abandoned by default. However, if this option is set true,
27474 the error in the challenge is ignored and the client sends the response as
27475 usual.
27476
27477 .option client_send plaintext string&!! unset
27478 The string is a colon-separated list of authentication data strings. Each
27479 string is independently expanded before being sent to the server. The first
27480 string is sent with the AUTH command; any more strings are sent in response
27481 to prompts from the server. Before each string is expanded, the value of the
27482 most recent prompt is placed in the next &$auth$&<&'n'&> variable, starting
27483 with &$auth1$& for the first prompt. Up to three prompts are stored in this
27484 way. Thus, the prompt that is received in response to sending the first string
27485 (with the AUTH command) can be used in the expansion of the second string, and
27486 so on. If an invalid base64 string is received when
27487 &%client_ignore_invalid_base64%& is set, an empty string is put in the
27488 &$auth$&<&'n'&> variable.
27489
27490 &*Note*&: You cannot use expansion to create multiple strings, because
27491 splitting takes priority and happens first.
27492
27493 Because the PLAIN authentication mechanism requires NUL (binary zero) bytes in
27494 the data, further processing is applied to each string before it is sent. If
27495 there are any single circumflex characters in the string, they are converted to
27496 NULs. Should an actual circumflex be required as data, it must be doubled in
27497 the string.
27498
27499 This is an example of a client configuration that implements the PLAIN
27500 authentication mechanism with a fixed user name and password:
27501 .code
27502 fixed_plain:
27503   driver = plaintext
27504   public_name = PLAIN
27505   client_send = ^username^mysecret
27506 .endd
27507 The lack of colons means that the entire text is sent with the AUTH
27508 command, with the circumflex characters converted to NULs. A similar example
27509 that uses the LOGIN mechanism is:
27510 .code
27511 fixed_login:
27512   driver = plaintext
27513   public_name = LOGIN
27514   client_send = : username : mysecret
27515 .endd
27516 The initial colon means that the first string is empty, so no data is sent with
27517 the AUTH command itself. The remaining strings are sent in response to
27518 prompts.
27519 .ecindex IIDplaiauth1
27520 .ecindex IIDplaiauth2
27521
27522
27523
27524
27525 . ////////////////////////////////////////////////////////////////////////////
27526 . ////////////////////////////////////////////////////////////////////////////
27527
27528 .chapter "The cram_md5 authenticator" "CHID9"
27529 .scindex IIDcramauth1 "&(cram_md5)& authenticator"
27530 .scindex IIDcramauth2 "authenticators" "&(cram_md5)&"
27531 .cindex "CRAM-MD5 authentication mechanism"
27532 .cindex authentication CRAM-MD5
27533 The CRAM-MD5 authentication mechanism is described in RFC 2195. The server
27534 sends a challenge string to the client, and the response consists of a user
27535 name and the CRAM-MD5 digest of the challenge string combined with a secret
27536 string (password) which is known to both server and client. Thus, the secret
27537 is not sent over the network as plain text, which makes this authenticator more
27538 secure than &(plaintext)&. However, the downside is that the secret has to be
27539 available in plain text at either end.
27540
27541
27542 .section "Using cram_md5 as a server" "SECID176"
27543 .cindex "options" "&(cram_md5)& authenticator (server)"
27544 This authenticator has one server option, which must be set to configure the
27545 authenticator as a server:
27546
27547 .option server_secret cram_md5 string&!! unset
27548 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(cram_md5)& authenticator"
27549 When the server receives the client's response, the user name is placed in
27550 the expansion variable &$auth1$&, and &%server_secret%& is expanded to
27551 obtain the password for that user. The server then computes the CRAM-MD5 digest
27552 that the client should have sent, and checks that it received the correct
27553 string. If the expansion of &%server_secret%& is forced to fail, authentication
27554 fails. If the expansion fails for some other reason, a temporary error code is
27555 returned to the client.
27556
27557 For compatibility with previous releases of Exim, the user name is also placed
27558 in &$1$&. However, the use of this variables for this purpose is now
27559 deprecated, as it can lead to confusion in string expansions that also use
27560 numeric variables for other things.
27561
27562 For example, the following authenticator checks that the user name given by the
27563 client is &"ph10"&, and if so, uses &"secret"& as the password. For any other
27564 user name, authentication fails.
27565 .code
27566 fixed_cram:
27567   driver = cram_md5
27568   public_name = CRAM-MD5
27569   server_secret = ${if eq{$auth1}{ph10}{secret}fail}
27570   server_set_id = $auth1
27571 .endd
27572 .vindex "&$authenticated_id$&"
27573 If authentication succeeds, the setting of &%server_set_id%& preserves the user
27574 name in &$authenticated_id$&. A more typical configuration might look up the
27575 secret string in a file, using the user name as the key. For example:
27576 .code
27577 lookup_cram:
27578   driver = cram_md5
27579   public_name = CRAM-MD5
27580   server_secret = ${lookup{$auth1}lsearch{/etc/authpwd}\
27581                   {$value}fail}
27582   server_set_id = $auth1
27583 .endd
27584 Note that this expansion explicitly forces failure if the lookup fails
27585 because &$auth1$& contains an unknown user name.
27586
27587 As another example, if you wish to re-use a Cyrus SASL sasldb2 file without
27588 using the relevant libraries, you need to know the realm to specify in the
27589 lookup and then ask for the &"userPassword"& attribute for that user in that
27590 realm, with:
27591 .code
27592 cyrusless_crammd5:
27593   driver = cram_md5
27594   public_name = CRAM-MD5
27595   server_secret = ${lookup{$auth1:mail.example.org:userPassword}\
27596                   dbmjz{/etc/sasldb2}{$value}fail}
27597   server_set_id = $auth1
27598 .endd
27599
27600 .section "Using cram_md5 as a client" "SECID177"
27601 .cindex "options" "&(cram_md5)& authenticator (client)"
27602 When used as a client, the &(cram_md5)& authenticator has two options:
27603
27604
27605
27606 .option client_name cram_md5 string&!! "the primary host name"
27607 This string is expanded, and the result used as the user name data when
27608 computing the response to the server's challenge.
27609
27610
27611 .option client_secret cram_md5 string&!! unset
27612 This option must be set for the authenticator to work as a client. Its value is
27613 expanded and the result used as the secret string when computing the response.
27614
27615
27616 .vindex "&$host$&"
27617 .vindex "&$host_address$&"
27618 Different user names and secrets can be used for different servers by referring
27619 to &$host$& or &$host_address$& in the options. Forced failure of either
27620 expansion string is treated as an indication that this authenticator is not
27621 prepared to handle this case. Exim moves on to the next configured client
27622 authenticator. Any other expansion failure causes Exim to give up trying to
27623 send the message to the current server.
27624
27625 A simple example configuration of a &(cram_md5)& authenticator, using fixed
27626 strings, is:
27627 .code
27628 fixed_cram:
27629   driver = cram_md5
27630   public_name = CRAM-MD5
27631   client_name = ph10
27632   client_secret = secret
27633 .endd
27634 .ecindex IIDcramauth1
27635 .ecindex IIDcramauth2
27636
27637
27638
27639 . ////////////////////////////////////////////////////////////////////////////
27640 . ////////////////////////////////////////////////////////////////////////////
27641
27642 .chapter "The cyrus_sasl authenticator" "CHID10"
27643 .scindex IIDcyrauth1 "&(cyrus_sasl)& authenticator"
27644 .scindex IIDcyrauth2 "authenticators" "&(cyrus_sasl)&"
27645 .cindex "Cyrus" "SASL library"
27646 .cindex "Kerberos"
27647 The code for this authenticator was provided by Matthew Byng-Maddick while
27648 at A L Digital Ltd.
27649
27650 The &(cyrus_sasl)& authenticator provides server support for the Cyrus SASL
27651 library implementation of the RFC 2222 (&"Simple Authentication and Security
27652 Layer"&). This library supports a number of authentication mechanisms,
27653 including PLAIN and LOGIN, but also several others that Exim does not support
27654 directly. In particular, there is support for Kerberos authentication.
27655
27656 The &(cyrus_sasl)& authenticator provides a gatewaying mechanism directly to
27657 the Cyrus interface, so if your Cyrus library can do, for example, CRAM-MD5,
27658 then so can the &(cyrus_sasl)& authenticator. By default it uses the public
27659 name of the driver to determine which mechanism to support.
27660
27661 Where access to some kind of secret file is required, for example, in GSSAPI
27662 or CRAM-MD5, it is worth noting that the authenticator runs as the Exim
27663 user, and that the Cyrus SASL library has no way of escalating privileges
27664 by default. You may also find you need to set environment variables,
27665 depending on the driver you are using.
27666
27667 The application name provided by Exim is &"exim"&, so various SASL options may
27668 be set in &_exim.conf_& in your SASL directory. If you are using GSSAPI for
27669 Kerberos, note that because of limitations in the GSSAPI interface,
27670 changing the server keytab might need to be communicated down to the Kerberos
27671 layer independently. The mechanism for doing so is dependent upon the Kerberos
27672 implementation.
27673
27674 For example, for older releases of Heimdal, the environment variable KRB5_KTNAME
27675 may be set to point to an alternative keytab file. Exim will pass this
27676 variable through from its own inherited environment when started as root or the
27677 Exim user. The keytab file needs to be readable by the Exim user.
27678 With newer releases of Heimdal, a setuid Exim may cause Heimdal to discard the
27679 environment variable.  In practice, for those releases, the Cyrus authenticator
27680 is not a suitable interface for GSSAPI (Kerberos) support.  Instead, consider
27681 the &(heimdal_gssapi)& authenticator, described in chapter &<<CHAPheimdalgss>>&
27682
27683
27684 .section "Using cyrus_sasl as a server" "SECID178"
27685 The &(cyrus_sasl)& authenticator has four private options. It puts the username
27686 (on a successful authentication) into &$auth1$&. For compatibility with
27687 previous releases of Exim, the username is also placed in &$1$&. However, the
27688 use of this variable for this purpose is now deprecated, as it can lead to
27689 confusion in string expansions that also use numeric variables for other
27690 things.
27691
27692
27693 .option server_hostname cyrus_sasl string&!! "see below"
27694 This option selects the hostname that is used when communicating with the
27695 library. The default value is &`$primary_hostname`&. It is up to the underlying
27696 SASL plug-in what it does with this data.
27697
27698
27699 .option server_mech cyrus_sasl string "see below"
27700 This option selects the authentication mechanism this driver should use. The
27701 default is the value of the generic &%public_name%& option. This option allows
27702 you to use a different underlying mechanism from the advertised name. For
27703 example:
27704 .code
27705 sasl:
27706   driver = cyrus_sasl
27707   public_name = X-ANYTHING
27708   server_mech = CRAM-MD5
27709   server_set_id = $auth1
27710 .endd
27711
27712 .option server_realm cyrus_sasl string&!! unset
27713 This specifies the SASL realm that the server claims to be in.
27714
27715
27716 .option server_service cyrus_sasl string &`smtp`&
27717 This is the SASL service that the server claims to implement.
27718
27719
27720 For straightforward cases, you do not need to set any of the authenticator's
27721 private options. All you need to do is to specify an appropriate mechanism as
27722 the public name. Thus, if you have a SASL library that supports CRAM-MD5 and
27723 PLAIN, you could have two authenticators as follows:
27724 .code
27725 sasl_cram_md5:
27726   driver = cyrus_sasl
27727   public_name = CRAM-MD5
27728   server_set_id = $auth1
27729
27730 sasl_plain:
27731   driver = cyrus_sasl
27732   public_name = PLAIN
27733   server_set_id = $auth2
27734 .endd
27735 Cyrus SASL does implement the LOGIN authentication method, even though it is
27736 not a standard method. It is disabled by default in the source distribution,
27737 but it is present in many binary distributions.
27738 .ecindex IIDcyrauth1
27739 .ecindex IIDcyrauth2
27740
27741
27742
27743
27744 . ////////////////////////////////////////////////////////////////////////////
27745 . ////////////////////////////////////////////////////////////////////////////
27746 .chapter "The dovecot authenticator" "CHAPdovecot"
27747 .scindex IIDdcotauth1 "&(dovecot)& authenticator"
27748 .scindex IIDdcotauth2 "authenticators" "&(dovecot)&"
27749 This authenticator is an interface to the authentication facility of the
27750 Dovecot 2 POP/IMAP server, which can support a number of authentication methods.
27751 Note that Dovecot must be configured to use auth-client not auth-userdb.
27752 If you are using Dovecot to authenticate POP/IMAP clients, it might be helpful
27753 to use the same mechanisms for SMTP authentication. This is a server
27754 authenticator only. There is only one option:
27755
27756 .option server_socket dovecot string unset
27757
27758 This option must specify the UNIX socket that is the interface to Dovecot
27759 authentication. The &%public_name%& option must specify an authentication
27760 mechanism that Dovecot is configured to support. You can have several
27761 authenticators for different mechanisms. For example:
27762 .code
27763 dovecot_plain:
27764   driver = dovecot
27765   public_name = PLAIN
27766   server_socket = /var/run/dovecot/auth-client
27767   server_set_id = $auth1
27768
27769 dovecot_ntlm:
27770   driver = dovecot
27771   public_name = NTLM
27772   server_socket = /var/run/dovecot/auth-client
27773   server_set_id = $auth1
27774 .endd
27775 If the SMTP connection is encrypted, or if &$sender_host_address$& is equal to
27776 &$received_ip_address$& (that is, the connection is local), the &"secured"&
27777 option is passed in the Dovecot authentication command. If, for a TLS
27778 connection, a client certificate has been verified, the &"valid-client-cert"&
27779 option is passed. When authentication succeeds, the identity of the user
27780 who authenticated is placed in &$auth1$&.
27781
27782 .new
27783 The Dovecot configuration to match the above wil look
27784 something like:
27785 .code
27786 conf.d/10-master.conf :-
27787
27788 service auth {
27789 ...
27790 #SASL
27791   unix_listener auth-client {
27792     mode = 0660
27793     user = mail
27794   }
27795 ...
27796 }
27797
27798 conf.d/10-auth.conf :-
27799
27800 auth_mechanisms = plain login ntlm
27801 .endd
27802 .wen
27803
27804 .ecindex IIDdcotauth1
27805 .ecindex IIDdcotauth2
27806
27807
27808 . ////////////////////////////////////////////////////////////////////////////
27809 . ////////////////////////////////////////////////////////////////////////////
27810 .chapter "The gsasl authenticator" "CHAPgsasl"
27811 .scindex IIDgsaslauth1 "&(gsasl)& authenticator"
27812 .scindex IIDgsaslauth2 "authenticators" "&(gsasl)&"
27813 .cindex "authentication" "GNU SASL"
27814 .cindex "authentication" "SASL"
27815 .cindex "authentication" "EXTERNAL"
27816 .cindex "authentication" "ANONYMOUS"
27817 .cindex "authentication" "PLAIN"
27818 .cindex "authentication" "LOGIN"
27819 .cindex "authentication" "DIGEST-MD5"
27820 .cindex "authentication" "CRAM-MD5"
27821 .cindex "authentication" "SCRAM family"
27822 The &(gsasl)& authenticator provides integration for the GNU SASL
27823 library and the mechanisms it provides.  This is new as of the 4.80 release
27824 and there are a few areas where the library does not let Exim smoothly
27825 scale to handle future authentication mechanisms, so no guarantee can be
27826 made that any particular new authentication mechanism will be supported
27827 without code changes in Exim.
27828
27829 .new
27830 The library is expected to add support in an upcoming
27831 realease for the SCRAM-SHA-256 method.
27832 The macro _HAVE_AUTH_GSASL_SCRAM_SHA_256 will be defined
27833 when this happens.
27834
27835
27836 .option client_authz gsasl string&!! unset
27837 This option can be used to supply an &'authorization id'&
27838 which is different to the &'authentication_id'& provided
27839 by &%client_username%& option.
27840 If unset or (after expansion) empty it is not used,
27841 which is the common case.
27842
27843 .option client_channelbinding gsasl boolean false
27844 See &%server_channelbinding%& below.
27845
27846 .option client_password gsasl string&!! unset
27847 This option is exapanded before use, and should result in
27848 the password to be used, in clear.
27849
27850 .option client_username gsasl string&!! unset
27851 This option is exapanded before use, and should result in
27852 the account name to be used.
27853 .wen
27854
27855 .new
27856 .option client_spassword gsasl string&!! unset
27857 If a SCRAM mechanism is being used and this option is set
27858 it is used in preference to &%client_password%&.
27859 The value after expansion should be
27860 a 40 (for SHA-1) or 64 (for SHA-256) character string
27861 with the PBKDF2-prepared password, hex-encoded.
27862 Note that this value will depend on the salt and iteration-count
27863 supplied by the server.
27864 .wen
27865
27866
27867
27868 .option server_channelbinding gsasl boolean false
27869 Do not set this true and rely on the properties
27870 without consulting a cryptographic engineer.
27871
27872 Some authentication mechanisms are able to use external context at both ends
27873 of the session to bind the authentication to that context, and fail the
27874 authentication process if that context differs.  Specifically, some TLS
27875 ciphersuites can provide identifying information about the cryptographic
27876 context.
27877
27878 This should have meant that certificate identity and verification becomes a
27879 non-issue, as a man-in-the-middle attack will cause the correct client and
27880 server to see different identifiers and authentication will fail.
27881
27882 .new
27883 This is
27884 only usable by mechanisms which support "channel binding"; at time of
27885 writing, that's the SCRAM family.
27886 When using this feature the "-PLUS" variants of the method names need to be used.
27887 .wen
27888
27889 This defaults off to ensure smooth upgrade across Exim releases, in case
27890 this option causes some clients to start failing.  Some future release
27891 of Exim might have switched the default to be true.
27892
27893 However, Channel Binding in TLS has proven to be vulnerable in current versions.
27894 Do not plan to rely upon this feature for security, ever, without consulting
27895 with a subject matter expert (a cryptographic engineer).
27896
27897
27898 .option server_hostname gsasl string&!! "see below"
27899 This option selects the hostname that is used when communicating with the
27900 library. The default value is &`$primary_hostname`&.
27901 Some mechanisms will use this data.
27902
27903
27904 .option server_mech gsasl string "see below"
27905 This option selects the authentication mechanism this driver should use. The
27906 default is the value of the generic &%public_name%& option. This option allows
27907 you to use a different underlying mechanism from the advertised name. For
27908 example:
27909 .code
27910 sasl:
27911   driver = gsasl
27912   public_name = X-ANYTHING
27913   server_mech = CRAM-MD5
27914   server_set_id = $auth1
27915 .endd
27916
27917
27918 .option server_password gsasl string&!! unset
27919 Various mechanisms need access to the cleartext password on the server, so
27920 that proof-of-possession can be demonstrated on the wire, without sending
27921 the password itself.
27922
27923 The data available for lookup varies per mechanism.
27924 In all cases, &$auth1$& is set to the &'authentication id'&.
27925 The &$auth2$& variable will always be the &'authorization id'& (&'authz'&)
27926 if available, else the empty string.
27927 The &$auth3$& variable will always be the &'realm'& if available,
27928 else the empty string.
27929
27930 A forced failure will cause authentication to defer.
27931
27932 If using this option, it may make sense to set the &%server_condition%&
27933 option to be simply "true".
27934
27935
27936 .option server_realm gsasl string&!! unset
27937 This specifies the SASL realm that the server claims to be in.
27938 Some mechanisms will use this data.
27939
27940
27941 .option server_scram_iter gsasl string&!! 4096
27942 This option provides data for the SCRAM family of mechanisms.
27943 .new
27944 The &$auth1$&, &$auth2$& and &$auth3$& variables are available
27945 when this option is expanded.
27946
27947 The result of expansion should be a decimal number,
27948 and represents both a lower-bound on the security, and
27949 a compute cost factor imposed on the client
27950 (if it does not cache results, or the server changes
27951 either the iteration count or the salt).
27952 A minimum value of 4096 is required by the standards
27953 for all current SCRAM mechanism variants.
27954 .wen
27955
27956 .option server_scram_salt gsasl string&!! unset
27957 This option provides data for the SCRAM family of mechanisms.
27958 .new
27959 The &$auth1$&, &$auth2$& and &$auth3$& variables are available
27960 when this option is expanded.
27961 The value should be a base64-encoded string,
27962 of random data typically 4-to-16 bytes long.
27963 If unset or empty after expansion the library will provides a value for the
27964 protocol conversation.
27965 .wen
27966
27967
27968 .new
27969 .option server_key gsasl string&!! unset
27970 .option server_skey gsasl string&!! unset
27971 These options can be used for the SCRAM family of mechanisms
27972 to provide stored information related to a password,
27973 the storage of which is preferable to plaintext.
27974
27975 &%server_key%& is the value defined in the SCRAM standards as ServerKey;
27976 &%server_skey%& is StoredKey.
27977
27978 They are only available for version 1.9.0 (or later) of the gsasl library.
27979 When this is so, the macros
27980 _OPT_AUTHENTICATOR_GSASL_SERVER_KEY
27981 and _HAVE_AUTH_GSASL_SCRAM_S_KEY
27982 will be defined.
27983
27984 The &$authN$& variables are available when these options are expanded.
27985
27986 If set, the results of expansion should for each
27987 should be a 28 (for SHA-1) or 44 (for SHA-256) character string
27988 of base64-coded data, and will be used in preference to the
27989 &%server_password%& option.
27990 If unset or not of the right length, &%server_password%& will be used.
27991
27992 The libgsasl library release includes a utility &'gsasl'& which can be used
27993 to generate these values.
27994 .wen
27995
27996
27997 .option server_service gsasl string &`smtp`&
27998 This is the SASL service that the server claims to implement.
27999 Some mechanisms will use this data.
28000
28001
28002 .section "&(gsasl)& auth variables" "SECTgsaslauthvar"
28003 .vindex "&$auth1$&, &$auth2$&, etc"
28004 These may be set when evaluating specific options, as detailed above.
28005 They will also be set when evaluating &%server_condition%&.
28006
28007 Unless otherwise stated below, the &(gsasl)& integration will use the following
28008 meanings for these variables:
28009
28010 .ilist
28011 .vindex "&$auth1$&"
28012 &$auth1$&: the &'authentication id'&
28013 .next
28014 .vindex "&$auth2$&"
28015 &$auth2$&: the &'authorization id'&
28016 .next
28017 .vindex "&$auth3$&"
28018 &$auth3$&: the &'realm'&
28019 .endlist
28020
28021 On a per-mechanism basis:
28022
28023 .ilist
28024 .cindex "authentication" "EXTERNAL"
28025 EXTERNAL: only &$auth1$& is set, to the possibly empty &'authorization id'&;
28026 the &%server_condition%& option must be present.
28027 .next
28028 .cindex "authentication" "ANONYMOUS"
28029 ANONYMOUS: only &$auth1$& is set, to the possibly empty &'anonymous token'&;
28030 the &%server_condition%& option must be present.
28031 .next
28032 .cindex "authentication" "GSSAPI"
28033 GSSAPI: &$auth1$& will be set to the &'GSSAPI Display Name'&;
28034 &$auth2$& will be set to the &'authorization id'&,
28035 the &%server_condition%& option must be present.
28036 .endlist
28037
28038 An &'anonymous token'& is something passed along as an unauthenticated
28039 identifier; this is analogous to FTP anonymous authentication passing an
28040 email address, or software-identifier@, as the "password".
28041
28042
28043 An example showing the password having the realm specified in the callback
28044 and demonstrating a Cyrus SASL to GSASL migration approach is:
28045 .code
28046 gsasl_cyrusless_crammd5:
28047   driver = gsasl
28048   public_name = CRAM-MD5
28049   server_realm = imap.example.org
28050   server_password = ${lookup{$auth1:$auth3:userPassword}\
28051                     dbmjz{/etc/sasldb2}{$value}fail}
28052   server_set_id = ${quote:$auth1}
28053   server_condition = yes
28054 .endd
28055
28056
28057 . ////////////////////////////////////////////////////////////////////////////
28058 . ////////////////////////////////////////////////////////////////////////////
28059
28060 .chapter "The heimdal_gssapi authenticator" "CHAPheimdalgss"
28061 .scindex IIDheimdalgssauth1 "&(heimdal_gssapi)& authenticator"
28062 .scindex IIDheimdalgssauth2 "authenticators" "&(heimdal_gssapi)&"
28063 .cindex "authentication" "GSSAPI"
28064 .cindex "authentication" "Kerberos"
28065 The &(heimdal_gssapi)& authenticator provides server integration for the
28066 Heimdal GSSAPI/Kerberos library, permitting Exim to set a keytab pathname
28067 reliably.
28068
28069 .option server_hostname heimdal_gssapi string&!! "see below"
28070 This option selects the hostname that is used, with &%server_service%&,
28071 for constructing the GSS server name, as a &'GSS_C_NT_HOSTBASED_SERVICE'&
28072 identifier.  The default value is &`$primary_hostname`&.
28073
28074 .option server_keytab heimdal_gssapi string&!! unset
28075 If set, then Heimdal will not use the system default keytab (typically
28076 &_/etc/krb5.keytab_&) but instead the pathname given in this option.
28077 The value should be a pathname, with no &"file:"& prefix.
28078
28079 .option server_service heimdal_gssapi string&!! "smtp"
28080 This option specifies the service identifier used, in conjunction with
28081 &%server_hostname%&, for building the identifier for finding credentials
28082 from the keytab.
28083
28084
28085 .section "&(heimdal_gssapi)& auth variables" "SECTheimdalgssauthvar"
28086 Beware that these variables will typically include a realm, thus will appear
28087 to be roughly like an email address already.  The &'authzid'& in &$auth2$& is
28088 not verified, so a malicious client can set it to anything.
28089
28090 The &$auth1$& field should be safely trustable as a value from the Key
28091 Distribution Center.  Note that these are not quite email addresses.
28092 Each identifier is for a role, and so the left-hand-side may include a
28093 role suffix.  For instance, &"joe/admin@EXAMPLE.ORG"&.
28094
28095 .vindex "&$auth1$&, &$auth2$&, etc"
28096 .ilist
28097 .vindex "&$auth1$&"
28098 &$auth1$&: the &'authentication id'&, set to the GSS Display Name.
28099 .next
28100 .vindex "&$auth2$&"
28101 &$auth2$&: the &'authorization id'&, sent within SASL encapsulation after
28102 authentication.  If that was empty, this will also be set to the
28103 GSS Display Name.
28104 .endlist
28105
28106
28107 . ////////////////////////////////////////////////////////////////////////////
28108 . ////////////////////////////////////////////////////////////////////////////
28109
28110 .chapter "The spa authenticator" "CHAPspa"
28111 .scindex IIDspaauth1 "&(spa)& authenticator"
28112 .scindex IIDspaauth2 "authenticators" "&(spa)&"
28113 .cindex "authentication" "Microsoft Secure Password"
28114 .cindex "authentication" "NTLM"
28115 .cindex "Microsoft Secure Password Authentication"
28116 .cindex "NTLM authentication"
28117 The &(spa)& authenticator provides client support for Microsoft's &'Secure
28118 Password Authentication'& mechanism,
28119 which is also sometimes known as NTLM (NT LanMan). The code for client side of
28120 this authenticator was contributed by Marc Prud'hommeaux, and much of it is
28121 taken from the Samba project (&url(https://www.samba.org/)). The code for the
28122 server side was subsequently contributed by Tom Kistner. The mechanism works as
28123 follows:
28124
28125 .ilist
28126 After the AUTH command has been accepted, the client sends an SPA
28127 authentication request based on the user name and optional domain.
28128 .next
28129 The server sends back a challenge.
28130 .next
28131 The client builds a challenge response which makes use of the user's password
28132 and sends it to the server, which then accepts or rejects it.
28133 .endlist
28134
28135 Encryption is used to protect the password in transit.
28136
28137
28138
28139 .section "Using spa as a server" "SECID179"
28140 .cindex "options" "&(spa)& authenticator (server)"
28141 The &(spa)& authenticator has just one server option:
28142
28143 .option server_password spa string&!! unset
28144 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(spa)& authenticator"
28145 This option is expanded, and the result must be the cleartext password for the
28146 authenticating user, whose name is at this point in &$auth1$&. For
28147 compatibility with previous releases of Exim, the user name is also placed in
28148 &$1$&. However, the use of this variable for this purpose is now deprecated, as
28149 it can lead to confusion in string expansions that also use numeric variables
28150 for other things. For example:
28151 .code
28152 spa:
28153   driver = spa
28154   public_name = NTLM
28155   server_password = \
28156     ${lookup{$auth1}lsearch{/etc/exim/spa_clearpass}{$value}fail}
28157 .endd
28158 If the expansion is forced to fail, authentication fails. Any other expansion
28159 failure causes a temporary error code to be returned.
28160
28161
28162
28163
28164
28165 .section "Using spa as a client" "SECID180"
28166 .cindex "options" "&(spa)& authenticator (client)"
28167 The &(spa)& authenticator has the following client options:
28168
28169
28170
28171 .option client_domain spa string&!! unset
28172 This option specifies an optional domain for the authentication.
28173
28174
28175 .option client_password spa string&!! unset
28176 This option specifies the user's password, and must be set.
28177
28178
28179 .option client_username spa string&!! unset
28180 This option specifies the user name, and must be set. Here is an example of a
28181 configuration of this authenticator for use with the mail servers at
28182 &'msn.com'&:
28183 .code
28184 msn:
28185   driver = spa
28186   public_name = MSN
28187   client_username = msn/msn_username
28188   client_password = msn_plaintext_password
28189   client_domain = DOMAIN_OR_UNSET
28190 .endd
28191 .ecindex IIDspaauth1
28192 .ecindex IIDspaauth2
28193
28194
28195
28196
28197
28198 . ////////////////////////////////////////////////////////////////////////////
28199 . ////////////////////////////////////////////////////////////////////////////
28200
28201 .chapter "The external authenticator" "CHAPexternauth"
28202 .scindex IIDexternauth1 "&(external)& authenticator"
28203 .scindex IIDexternauth2 "authenticators" "&(external)&"
28204 .cindex "authentication" "Client Certificate"
28205 .cindex "authentication" "X509"
28206 .cindex "Certificate-based authentication"
28207 The &(external)& authenticator provides support for
28208 authentication based on non-SMTP information.
28209 The specification is in RFC 4422 Appendix A
28210 (&url(https://tools.ietf.org/html/rfc4422)).
28211 It is only a transport and negotiation mechanism;
28212 the process of authentication is entirely controlled
28213 by the server configuration.
28214
28215 The client presents an identity in-clear.
28216 It is probably wise for a server to only advertise,
28217 and for clients to only attempt,
28218 this authentication method on a secure (eg. under TLS) connection.
28219
28220 One possible use, compatible with the
28221 K-9 Mail Andoid client (&url(https://k9mail.github.io/)),
28222 is for using X509 client certificates.
28223
28224 It thus overlaps in function with the TLS authenticator
28225 (see &<<CHAPtlsauth>>&)
28226 but is a full SMTP SASL authenticator
28227 rather than being implicit for TLS-connection carried
28228 client certificates only.
28229
28230 The examples and discussion in this chapter assume that
28231 client-certificate authentication is being done.
28232
28233 The client must present a certificate,
28234 for which it must have been requested via the
28235 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& main options
28236 (see &<<CHAPTLS>>&).
28237 For authentication to be effective the certificate should be
28238 verifiable against a trust-anchor certificate known to the server.
28239
28240 .section "External options" "SECTexternsoptions"
28241 .cindex "options" "&(external)& authenticator (server)"
28242 The &(external)& authenticator has two server options:
28243
28244 .option server_param2 external string&!! unset
28245 .option server_param3 external string&!! unset
28246 .cindex "variables (&$auth1$& &$auth2$& etc)" "in &(external)& authenticator"
28247 These options are expanded before the &%server_condition%& option
28248 and the result are placed in &$auth2$& and &$auth3$& resectively.
28249 If the expansion is forced to fail, authentication fails. Any other expansion
28250 failure causes a temporary error code to be returned.
28251
28252 They can be used to clarify the coding of a complex &%server_condition%&.
28253
28254 .section "Using external in a server" "SECTexternserver"
28255 .cindex "AUTH" "in &(external)& authenticator"
28256 .cindex "numerical variables (&$1$& &$2$& etc)" &&&
28257         "in &(external)& authenticator"
28258 .vindex "&$auth1$&, &$auth2$&, etc"
28259 .cindex "base64 encoding" "in &(external)& authenticator"
28260
28261 When running as a server, &(external)& performs the authentication test by
28262 expanding a string. The data sent by the client with the AUTH command, or in
28263 response to subsequent prompts, is base64 encoded, and so may contain any byte
28264 values when decoded. The decoded value is treated as
28265 an identity for authentication and
28266 placed in the expansion variable &$auth1$&.
28267
28268 For compatibility with previous releases of Exim, the value is also placed in
28269 the expansion variable &$1$&. However, the use of this
28270 variable for this purpose is now deprecated, as it can lead to confusion in
28271 string expansions that also use them for other things.
28272
28273 .vindex "&$authenticated_id$&"
28274 Once an identity has been received,
28275 &%server_condition%& is expanded. If the expansion is forced to fail,
28276 authentication fails. Any other expansion failure causes a temporary error code
28277 to be returned. If the result of a successful expansion is an empty string,
28278 &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
28279 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds and the
28280 generic &%server_set_id%& option is expanded and saved in &$authenticated_id$&.
28281 For any other result, a temporary error code is returned, with the expanded
28282 string as the error text.
28283
28284 Example:
28285 .code
28286 ext_ccert_san_mail:
28287   driver =            external
28288   public_name =       EXTERNAL
28289
28290   server_advertise_condition = $tls_in_certificate_verified
28291   server_param2 =     ${certextract {subj_altname,mail,>:} \
28292                                     {$tls_in_peercert}}
28293   server_condition =  ${if forany {$auth2} \
28294                             {eq {$item}{$auth1}}}
28295   server_set_id =     $auth1
28296 .endd
28297 This accepts a client certificate that is verifiable against any
28298 of your configured trust-anchors
28299 (which usually means the full set of public CAs)
28300 and which has a mail-SAN matching the claimed identity sent by the client.
28301
28302 &*Note*&: up to TLS1.2, the client cert is on the wire in-clear, including the SAN.
28303 The account name is therefore guessable by an opponent.
28304 TLS 1.3 protects both server and client certificates, and is not vulnerable
28305 in this way.
28306
28307
28308 .section "Using external in a client" "SECTexternclient"
28309 .cindex "options" "&(external)& authenticator (client)"
28310 The &(external)& authenticator has one client option:
28311
28312 .option client_send external string&!! unset
28313 This option is expanded and sent with the AUTH command as the
28314 identity being asserted.
28315
28316 Example:
28317 .code
28318 ext_ccert:
28319   driver =      external
28320   public_name = EXTERNAL
28321
28322   client_condition = ${if !eq{$tls_out_cipher}{}}
28323   client_send = myaccount@smarthost.example.net
28324 .endd
28325
28326
28327 .ecindex IIDexternauth1
28328 .ecindex IIDexternauth2
28329
28330
28331
28332
28333
28334 . ////////////////////////////////////////////////////////////////////////////
28335 . ////////////////////////////////////////////////////////////////////////////
28336
28337 .chapter "The tls authenticator" "CHAPtlsauth"
28338 .scindex IIDtlsauth1 "&(tls)& authenticator"
28339 .scindex IIDtlsauth2 "authenticators" "&(tls)&"
28340 .cindex "authentication" "Client Certificate"
28341 .cindex "authentication" "X509"
28342 .cindex "Certificate-based authentication"
28343 The &(tls)& authenticator provides server support for
28344 authentication based on client certificates.
28345
28346 It is not an SMTP authentication mechanism and is not
28347 advertised by the server as part of the SMTP EHLO response.
28348 It is an Exim authenticator in the sense that it affects
28349 the protocol element of the log line, can be tested for
28350 by the &%authenticated%& ACL condition, and can set
28351 the &$authenticated_id$& variable.
28352
28353 The client must present a verifiable certificate,
28354 for which it must have been requested via the
28355 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& main options
28356 (see &<<CHAPTLS>>&).
28357
28358 If an authenticator of this type is configured it is
28359 run before any SMTP-level communication is done,
28360 and can authenticate the connection.
28361 If it does, SMTP authentication is not offered.
28362
28363 A maximum of one authenticator of this type may be present.
28364
28365
28366 .cindex "options" "&(tls)& authenticator (server)"
28367 The &(tls)& authenticator has three server options:
28368
28369 .option server_param1 tls string&!! unset
28370 .cindex "variables (&$auth1$& &$auth2$& etc)" "in &(tls)& authenticator"
28371 This option is expanded after the TLS negotiation and
28372 the result is placed in &$auth1$&.
28373 If the expansion is forced to fail, authentication fails. Any other expansion
28374 failure causes a temporary error code to be returned.
28375
28376 .option server_param2 tls string&!! unset
28377 .option server_param3 tls string&!! unset
28378 As above, for &$auth2$& and &$auth3$&.
28379
28380 &%server_param1%& may also be spelled &%server_param%&.
28381
28382
28383 Example:
28384 .code
28385 tls:
28386   driver = tls
28387   server_param1 =     ${certextract {subj_altname,mail,>:} \
28388                                     {$tls_in_peercert}}
28389   server_condition =  ${if and { {eq{$tls_in_certificate_verified}{1}} \
28390                                  {forany {$auth1} \
28391                             {!= {0} \
28392                                 {${lookup ldap{ldap:///\
28393                          mailname=${quote_ldap_dn:${lc:$item}},\
28394                          ou=users,LDAP_DC?mailid} {$value}{0} \
28395                        }    }  } }}}
28396   server_set_id =     ${if = {1}{${listcount:$auth1}} {$auth1}{}}
28397 .endd
28398 This accepts a client certificate that is verifiable against any
28399 of your configured trust-anchors
28400 (which usually means the full set of public CAs)
28401 and which has a SAN with a good account name.
28402
28403 Note that, up to TLS1.2, the client cert is on the wire in-clear, including the SAN,
28404 The account name is therefore guessable by an opponent.
28405 TLS 1.3 protects both server and client certificates, and is not vulnerable
28406 in this way.
28407 Likewise, a traditional plaintext SMTP AUTH done inside TLS is not.
28408
28409 . An alternative might use
28410 . .code
28411 .   server_param1 = ${sha256:$tls_in_peercert}
28412 . .endd
28413 . to require one of a set of specific certs that define a given account
28414 . (the verification is still required, but mostly irrelevant).
28415 . This would help for per-device use.
28416 .
28417 . However, for the future we really need support for checking a
28418 . user cert in LDAP - which probably wants a base-64 DER.
28419
28420 .ecindex IIDtlsauth1
28421 .ecindex IIDtlsauth2
28422
28423
28424 Note that because authentication is traditionally an SMTP operation,
28425 the &%authenticated%& ACL condition cannot be used in
28426 a connect- or helo-ACL.
28427
28428
28429
28430 . ////////////////////////////////////////////////////////////////////////////
28431 . ////////////////////////////////////////////////////////////////////////////
28432
28433 .chapter "Encrypted SMTP connections using TLS/SSL" "CHAPTLS" &&&
28434          "Encrypted SMTP connections"
28435 .scindex IIDencsmtp1 "encryption" "on SMTP connection"
28436 .scindex IIDencsmtp2 "SMTP" "encryption"
28437 .cindex "TLS" "on SMTP connection"
28438 .cindex "OpenSSL"
28439 .cindex "GnuTLS"
28440 Support for TLS (Transport Layer Security), formerly known as SSL (Secure
28441 Sockets Layer), is implemented by making use of the OpenSSL library or the
28442 GnuTLS library (Exim requires GnuTLS release 1.0 or later). There is no
28443 cryptographic code in the Exim distribution itself for implementing TLS. In
28444 order to use this feature you must install OpenSSL or GnuTLS, and then build a
28445 version of Exim that includes TLS support (see section &<<SECTinctlsssl>>&).
28446 You also need to understand the basic concepts of encryption at a managerial
28447 level, and in particular, the way that public keys, private keys, and
28448 certificates are used.
28449
28450 RFC 3207 defines how SMTP connections can make use of encryption. Once a
28451 connection is established, the client issues a STARTTLS command. If the
28452 server accepts this, the client and the server negotiate an encryption
28453 mechanism. If the negotiation succeeds, the data that subsequently passes
28454 between them is encrypted.
28455
28456 Exim's ACLs can detect whether the current SMTP session is encrypted or not,
28457 and if so, what cipher suite is in use, whether the client supplied a
28458 certificate, and whether or not that certificate was verified. This makes it
28459 possible for an Exim server to deny or accept certain commands based on the
28460 encryption state.
28461
28462 &*Warning*&: Certain types of firewall and certain anti-virus products can
28463 disrupt TLS connections. You need to turn off SMTP scanning for these products
28464 in order to get TLS to work.
28465
28466
28467
28468 .section "Support for the &""submissions""& (aka &""ssmtp""& and &""smtps""&) protocol" &&&
28469          "SECID284"
28470 .cindex "submissions protocol"
28471 .cindex "ssmtp protocol"
28472 .cindex "smtps protocol"
28473 .cindex "SMTP" "submissions protocol"
28474 .cindex "SMTP" "ssmtp protocol"
28475 .cindex "SMTP" "smtps protocol"
28476 The history of port numbers for TLS in SMTP is a little messy and has been
28477 contentious.  As of RFC 8314, the common practice of using the historically
28478 allocated port 465 for "email submission but with TLS immediately upon connect
28479 instead of using STARTTLS" is officially blessed by the IETF, and recommended
28480 by them in preference to STARTTLS.
28481
28482 The name originally assigned to the port was &"ssmtp"& or &"smtps"&, but as
28483 clarity emerged over the dual roles of SMTP, for MX delivery and Email
28484 Submission, nomenclature has shifted.  The modern name is now &"submissions"&.
28485
28486 This approach was, for a while, officially abandoned when encrypted SMTP was
28487 standardized, but many clients kept using it, even as the TCP port number was
28488 reassigned for other use.
28489 Thus you may encounter guidance claiming that you shouldn't enable use of
28490 this port.
28491 In practice, a number of mail-clients have only ever supported submissions,
28492 not submission with STARTTLS upgrade.
28493 Ideally, offer both submission (587) and submissions (465) service.
28494
28495 Exim supports TLS-on-connect by means of the &%tls_on_connect_ports%&
28496 global option. Its value must be a list of port numbers;
28497 the most common use is expected to be:
28498 .code
28499 tls_on_connect_ports = 465
28500 .endd
28501 The port numbers specified by this option apply to all SMTP connections, both
28502 via the daemon and via &'inetd'&. You still need to specify all the ports that
28503 the daemon uses (by setting &%daemon_smtp_ports%& or &%local_interfaces%& or
28504 the &%-oX%& command line option) because &%tls_on_connect_ports%& does not add
28505 an extra port &-- rather, it specifies different behaviour on a port that is
28506 defined elsewhere.
28507
28508 There is also a &%-tls-on-connect%& command line option. This overrides
28509 &%tls_on_connect_ports%&; it forces the TLS-only behaviour for all ports.
28510
28511
28512
28513
28514
28515
28516 .section "OpenSSL vs GnuTLS" "SECTopenvsgnu"
28517 .cindex "TLS" "OpenSSL &'vs'& GnuTLS"
28518 TLS is supported in Exim using either the OpenSSL or GnuTLS library.
28519 To build Exim to use OpenSSL you need to set
28520 .code
28521 USE_OPENSSL=yes
28522 .endd
28523 in Local/Makefile.
28524
28525 To build Exim to use GnuTLS, you need to set
28526 .code
28527 USE_GNUTLS=yes
28528 .endd
28529 in Local/Makefile.
28530
28531 You must also set TLS_LIBS and TLS_INCLUDE appropriately, so that the
28532 include files and libraries for GnuTLS can be found.
28533
28534 There are some differences in usage when using GnuTLS instead of OpenSSL:
28535
28536 .ilist
28537 The &%tls_verify_certificates%& option
28538 cannot be the path of a directory
28539 for GnuTLS versions before 3.3.6
28540 (for later versions, or OpenSSL, it can be either).
28541 .next
28542 The default value for &%tls_dhparam%& differs for historical reasons.
28543 .next
28544 .vindex "&$tls_in_peerdn$&"
28545 .vindex "&$tls_out_peerdn$&"
28546 Distinguished Name (DN) strings reported by the OpenSSL library use a slash for
28547 separating fields; GnuTLS uses commas, in accordance with RFC 2253. This
28548 affects the value of the &$tls_in_peerdn$& and &$tls_out_peerdn$& variables.
28549 .next
28550 OpenSSL identifies cipher suites using hyphens as separators, for example:
28551 DES-CBC3-SHA. GnuTLS historically used underscores, for example:
28552 RSA_ARCFOUR_SHA. What is more, OpenSSL complains if underscores are present
28553 in a cipher list. To make life simpler, Exim changes underscores to hyphens
28554 for OpenSSL and passes the string unchanged to GnuTLS (expecting the library
28555 to handle its own older variants) when processing lists of cipher suites in the
28556 &%tls_require_ciphers%& options (the global option and the &(smtp)& transport
28557 option).
28558 .next
28559 The &%tls_require_ciphers%& options operate differently, as described in the
28560 sections &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
28561 .next
28562 The &%tls_dh_min_bits%& SMTP transport option is only honoured by GnuTLS.
28563 When using OpenSSL, this option is ignored.
28564 (If an API is found to let OpenSSL be configured in this way,
28565 let the Exim Maintainers know and we'll likely use it).
28566 .next
28567 With GnuTLS, if an explicit list is used for the &%tls_privatekey%& main option
28568 main option, it must be ordered to match the &%tls_certificate%& list.
28569 .next
28570 Some other recently added features may only be available in one or the other.
28571 This should be documented with the feature.  If the documentation does not
28572 explicitly state that the feature is infeasible in the other TLS
28573 implementation, then patches are welcome.
28574 .endlist
28575
28576
28577 .section "GnuTLS parameter computation" "SECTgnutlsparam"
28578 This section only applies if &%tls_dhparam%& is set to &`historic`& or to
28579 an explicit path; if the latter, then the text about generation still applies,
28580 but not the chosen filename.
28581 By default, as of Exim 4.80 a hard-coded D-H prime is used.
28582 See the documentation of &%tls_dhparam%& for more information.
28583
28584 GnuTLS uses D-H parameters that may take a substantial amount of time
28585 to compute. It is unreasonable to re-compute them for every TLS session.
28586 Therefore, Exim keeps this data in a file in its spool directory, called
28587 &_gnutls-params-NNNN_& for some value of NNNN, corresponding to the number
28588 of bits requested.
28589 The file is owned by the Exim user and is readable only by
28590 its owner. Every Exim process that start up GnuTLS reads the D-H
28591 parameters from this file. If the file does not exist, the first Exim process
28592 that needs it computes the data and writes it to a temporary file which is
28593 renamed once it is complete. It does not matter if several Exim processes do
28594 this simultaneously (apart from wasting a few resources). Once a file is in
28595 place, new Exim processes immediately start using it.
28596
28597 For maximum security, the parameters that are stored in this file should be
28598 recalculated periodically, the frequency depending on your paranoia level.
28599 If you are avoiding using the fixed D-H primes published in RFCs, then you
28600 are concerned about some advanced attacks and will wish to do this; if you do
28601 not regenerate then you might as well stick to the standard primes.
28602
28603 Arranging this is easy in principle; just delete the file when you want new
28604 values to be computed. However, there may be a problem. The calculation of new
28605 parameters needs random numbers, and these are obtained from &_/dev/random_&.
28606 If the system is not very active, &_/dev/random_& may delay returning data
28607 until enough randomness (entropy) is available. This may cause Exim to hang for
28608 a substantial amount of time, causing timeouts on incoming connections.
28609
28610 The solution is to generate the parameters externally to Exim. They are stored
28611 in &_gnutls-params-N_& in PEM format, which means that they can be
28612 generated externally using the &(certtool)& command that is part of GnuTLS.
28613
28614 To replace the parameters with new ones, instead of deleting the file
28615 and letting Exim re-create it, you can generate new parameters using
28616 &(certtool)& and, when this has been done, replace Exim's cache file by
28617 renaming. The relevant commands are something like this:
28618 .code
28619 # ls
28620 [ look for file; assume gnutls-params-2236 is the most recent ]
28621 # rm -f new-params
28622 # touch new-params
28623 # chown exim:exim new-params
28624 # chmod 0600 new-params
28625 # certtool --generate-dh-params --bits 2236 >>new-params
28626 # openssl dhparam -noout -text -in new-params | head
28627 [ check the first line, make sure it's not more than 2236;
28628   if it is, then go back to the start ("rm") and repeat
28629   until the size generated is at most the size requested ]
28630 # chmod 0400 new-params
28631 # mv new-params gnutls-params-2236
28632 .endd
28633 If Exim never has to generate the parameters itself, the possibility of
28634 stalling is removed.
28635
28636 The filename changed in Exim 4.80, to gain the -bits suffix.  The value which
28637 Exim will choose depends upon the version of GnuTLS in use.  For older GnuTLS,
28638 the value remains hard-coded in Exim as 1024.  As of GnuTLS 2.12.x, there is
28639 a way for Exim to ask for the "normal" number of bits for D-H public-key usage,
28640 and Exim does so.  This attempt to remove Exim from TLS policy decisions
28641 failed, as GnuTLS 2.12 returns a value higher than the current hard-coded limit
28642 of the NSS library.  Thus Exim gains the &%tls_dh_max_bits%& global option,
28643 which applies to all D-H usage, client or server.  If the value returned by
28644 GnuTLS is greater than &%tls_dh_max_bits%& then the value will be clamped down
28645 to &%tls_dh_max_bits%&.  The default value has been set at the current NSS
28646 limit, which is still much higher than Exim historically used.
28647
28648 The filename and bits used will change as the GnuTLS maintainers change the
28649 value for their parameter &`GNUTLS_SEC_PARAM_NORMAL`&, as clamped by
28650 &%tls_dh_max_bits%&.  At the time of writing (mid 2012), GnuTLS 2.12 recommends
28651 2432 bits, while NSS is limited to 2236 bits.
28652
28653 In fact, the requested value will be *lower* than &%tls_dh_max_bits%&, to
28654 increase the chance of the generated prime actually being within acceptable
28655 bounds, as GnuTLS has been observed to overshoot.  Note the check step in the
28656 procedure above.  There is no sane procedure available to Exim to double-check
28657 the size of the generated prime, so it might still be too large.
28658
28659
28660 .section "Requiring specific ciphers in OpenSSL" "SECTreqciphssl"
28661 .cindex "TLS" "requiring specific ciphers (OpenSSL)"
28662 .oindex "&%tls_require_ciphers%&" "OpenSSL"
28663 There is a function in the OpenSSL library that can be passed a list of cipher
28664 suites before the cipher negotiation takes place. This specifies which ciphers
28665 are acceptable for TLS versions prior to 1.3.
28666 The list is colon separated and may contain names like
28667 DES-CBC3-SHA. Exim passes the expanded value of &%tls_require_ciphers%&
28668 directly to this function call.
28669 Many systems will install the OpenSSL manual-pages, so you may have
28670 &'ciphers(1)'& available to you.
28671 The following quotation from the OpenSSL
28672 documentation specifies what forms of item are allowed in the cipher string:
28673
28674 .ilist
28675 It can consist of a single cipher suite such as RC4-SHA.
28676 .next
28677 It can represent a list of cipher suites containing a certain algorithm,
28678 or cipher suites of a certain type. For example SHA1 represents all
28679 ciphers suites using the digest algorithm SHA1 and SSLv3 represents all
28680 SSL v3 algorithms.
28681 .next
28682 Lists of cipher suites can be combined in a single cipher string using
28683 the + character. This is used as a logical and operation. For example
28684 SHA1+DES represents all cipher suites containing the SHA1 and the DES
28685 algorithms.
28686 .endlist
28687
28688 Each cipher string can be optionally preceded by one of the characters &`!`&,
28689 &`-`& or &`+`&.
28690 .ilist
28691 If &`!`& is used, the ciphers are permanently deleted from the list. The
28692 ciphers deleted can never reappear in the list even if they are explicitly
28693 stated.
28694 .next
28695 If &`-`& is used, the ciphers are deleted from the list, but some or all
28696 of the ciphers can be added again by later options.
28697 .next
28698 If &`+`& is used, the ciphers are moved to the end of the list. This
28699 option does not add any new ciphers; it just moves matching existing ones.
28700 .endlist
28701
28702 If none of these characters is present, the string is interpreted as
28703 a list of ciphers to be appended to the current preference list. If the list
28704 includes any ciphers already present they will be ignored: that is, they will
28705 not be moved to the end of the list.
28706 .endlist
28707
28708 The OpenSSL &'ciphers(1)'& command may be used to test the results of a given
28709 string:
28710 .code
28711 # note single-quotes to get ! past any shell history expansion
28712 $ openssl ciphers 'HIGH:!MD5:!SHA1'
28713 .endd
28714
28715 This example will let the library defaults be permitted on the MX port, where
28716 there's probably no identity verification anyway, but ups the ante on the
28717 submission ports where the administrator might have some influence on the
28718 choice of clients used:
28719 .code
28720 # OpenSSL variant; see man ciphers(1)
28721 tls_require_ciphers = ${if =={$received_port}{25}\
28722                            {DEFAULT}\
28723                            {HIGH:!MD5:!SHA1}}
28724 .endd
28725
28726 This example will prefer ECDSA-authenticated ciphers over RSA ones:
28727 .code
28728 tls_require_ciphers = ECDSA:RSA:!COMPLEMENTOFDEFAULT
28729 .endd
28730
28731 For TLS version 1.3 the control available is less fine-grained
28732 and Exim does not provide access to it at present.
28733 The value of the &%tls_require_ciphers%& option is ignored when
28734 TLS version 1.3 is negotiated.
28735
28736 As of writing the library default cipher suite list for TLSv1.3 is
28737 .code
28738 TLS_AES_256_GCM_SHA384:TLS_CHACHA20_POLY1305_SHA256:TLS_AES_128_GCM_SHA256
28739 .endd
28740
28741
28742 .section "Requiring specific ciphers or other parameters in GnuTLS" &&&
28743          "SECTreqciphgnu"
28744 .cindex "GnuTLS" "specifying parameters for"
28745 .cindex "TLS" "specifying ciphers (GnuTLS)"
28746 .cindex "TLS" "specifying key exchange methods (GnuTLS)"
28747 .cindex "TLS" "specifying MAC algorithms (GnuTLS)"
28748 .cindex "TLS" "specifying protocols (GnuTLS)"
28749 .cindex "TLS" "specifying priority string (GnuTLS)"
28750 .oindex "&%tls_require_ciphers%&" "GnuTLS"
28751 The GnuTLS library allows the caller to provide a "priority string", documented
28752 as part of the &[gnutls_priority_init]& function.  This is very similar to the
28753 ciphersuite specification in OpenSSL.
28754
28755 The &%tls_require_ciphers%& option is treated as the GnuTLS priority string
28756 and controls both protocols and ciphers.
28757
28758 The &%tls_require_ciphers%& option is available both as an global option,
28759 controlling how Exim behaves as a server, and also as an option of the
28760 &(smtp)& transport, controlling how Exim behaves as a client.  In both cases
28761 the value is string expanded.  The resulting string is not an Exim list and
28762 the string is given to the GnuTLS library, so that Exim does not need to be
28763 aware of future feature enhancements of GnuTLS.
28764
28765 Documentation of the strings accepted may be found in the GnuTLS manual, under
28766 "Priority strings".  This is online as
28767 &url(https://www.gnutls.org/manual/html_node/Priority-Strings.html),
28768 but beware that this relates to GnuTLS 3, which may be newer than the version
28769 installed on your system.  If you are using GnuTLS 3,
28770 then the example code
28771 &url(https://www.gnutls.org/manual/gnutls.html#Listing-the-ciphersuites-in-a-priority-string)
28772 on that site can be used to test a given string.
28773
28774 For example:
28775 .code
28776 # Disable older versions of protocols
28777 tls_require_ciphers = NORMAL:%LATEST_RECORD_VERSION:-VERS-SSL3.0
28778 .endd
28779
28780 Prior to Exim 4.80, an older API of GnuTLS was used, and Exim supported three
28781 additional options, "&%gnutls_require_kx%&", "&%gnutls_require_mac%&" and
28782 "&%gnutls_require_protocols%&".  &%tls_require_ciphers%& was an Exim list.
28783
28784 This example will let the library defaults be permitted on the MX port, where
28785 there's probably no identity verification anyway, and lowers security further
28786 by increasing compatibility; but this ups the ante on the submission ports
28787 where the administrator might have some influence on the choice of clients
28788 used:
28789 .code
28790 # GnuTLS variant
28791 tls_require_ciphers = ${if =={$received_port}{25}\
28792                            {NORMAL:%COMPAT}\
28793                            {SECURE128}}
28794 .endd
28795
28796
28797 .section "Configuring an Exim server to use TLS" "SECID182"
28798 .cindex "TLS" "configuring an Exim server"
28799 When Exim has been built with TLS support, it advertises the availability of
28800 the STARTTLS command to client hosts that match &%tls_advertise_hosts%&,
28801 but not to any others. The default value of this option is *, which means
28802 that STARTTLS is always advertised.  Set it to blank to never advertise;
28803 this is reasonable for systems that want to use TLS only as a client.
28804
28805 If STARTTLS is to be used you
28806 need to set some other options in order to make TLS available.
28807
28808 If a client issues a STARTTLS command and there is some configuration
28809 problem in the server, the command is rejected with a 454 error. If the client
28810 persists in trying to issue SMTP commands, all except QUIT are rejected
28811 with the error
28812 .code
28813 554 Security failure
28814 .endd
28815 If a STARTTLS command is issued within an existing TLS session, it is
28816 rejected with a 554 error code.
28817
28818 To enable TLS operations on a server, the &%tls_advertise_hosts%& option
28819 must be set to match some hosts. The default is * which matches all hosts.
28820
28821 If this is all you do, TLS encryption will be enabled but not authentication -
28822 meaning that the peer has no assurance it is actually you he is talking to.
28823 You gain protection from a passive sniffer listening on the wire but not
28824 from someone able to intercept the communication.
28825
28826 Further protection requires some further configuration at the server end.
28827
28828 To make TLS work you need to set, in the server,
28829 .code
28830 tls_certificate = /some/file/name
28831 tls_privatekey = /some/file/name
28832 .endd
28833 These options are, in fact, expanded strings, so you can make them depend on
28834 the identity of the client that is connected if you wish. The first file
28835 contains the server's X509 certificate, and the second contains the private key
28836 that goes with it. These files need to be
28837 PEM format and readable by the Exim user, and must
28838 always be given as full path names.
28839 The key must not be password-protected.
28840 They can be the same file if both the
28841 certificate and the key are contained within it. If &%tls_privatekey%& is not
28842 set, or if its expansion is forced to fail or results in an empty string, this
28843 is assumed to be the case. The certificate file may also contain intermediate
28844 certificates that need to be sent to the client to enable it to authenticate
28845 the server's certificate.
28846
28847 For dual-stack (eg. RSA and ECDSA) configurations, these options can be
28848 colon-separated lists of file paths.  Ciphers using given authentication
28849 algorithms require the presence of a suitable certificate to supply the
28850 public-key.  The server selects among the certificates to present to the
28851 client depending on the selected cipher, hence the priority ordering for
28852 ciphers will affect which certificate is used.
28853
28854 If you do not understand about certificates and keys, please try to find a
28855 source of this background information, which is not Exim-specific. (There are a
28856 few comments below in section &<<SECTcerandall>>&.)
28857
28858 &*Note*&: These options do not apply when Exim is operating as a client &--
28859 they apply only in the case of a server. If you need to use a certificate in an
28860 Exim client, you must set the options of the same names in an &(smtp)&
28861 transport.
28862
28863 With just these options, an Exim server will be able to use TLS. It does not
28864 require the client to have a certificate (but see below for how to insist on
28865 this). There is one other option that may be needed in other situations. If
28866 .code
28867 tls_dhparam = /some/file/name
28868 .endd
28869 is set, the SSL library is initialized for the use of Diffie-Hellman ciphers
28870 with the parameters contained in the file.
28871 Set this to &`none`& to disable use of DH entirely, by making no prime
28872 available:
28873 .code
28874 tls_dhparam = none
28875 .endd
28876 This may also be set to a string identifying a standard prime to be used for
28877 DH; if it is set to &`default`& or, for OpenSSL, is unset, then the prime
28878 used is &`ike23`&.  There are a few standard primes available, see the
28879 documentation for &%tls_dhparam%& for the complete list.
28880
28881 See the command
28882 .code
28883 openssl dhparam
28884 .endd
28885 for a way of generating file data.
28886
28887 The strings supplied for these three options are expanded every time a client
28888 host connects. It is therefore possible to use different certificates and keys
28889 for different hosts, if you so wish, by making use of the client's IP address
28890 in &$sender_host_address$& to control the expansion. If a string expansion is
28891 forced to fail, Exim behaves as if the option is not set.
28892
28893 .cindex "cipher" "logging"
28894 .cindex "log" "TLS cipher"
28895 .vindex "&$tls_in_cipher$&"
28896 The variable &$tls_in_cipher$& is set to the cipher suite that was negotiated for
28897 an incoming TLS connection. It is included in the &'Received:'& header of an
28898 incoming message (by default &-- you can, of course, change this), and it is
28899 also included in the log line that records a message's arrival, keyed by
28900 &"X="&, unless the &%tls_cipher%& log selector is turned off. The &%encrypted%&
28901 condition can be used to test for specific cipher suites in ACLs.
28902
28903 Once TLS has been established, the ACLs that run for subsequent SMTP commands
28904 can check the name of the cipher suite and vary their actions accordingly. The
28905 cipher suite names vary, depending on which TLS library is being used. For
28906 example, OpenSSL uses the name DES-CBC3-SHA for the cipher suite which in other
28907 contexts is known as TLS_RSA_WITH_3DES_EDE_CBC_SHA. Check the OpenSSL or GnuTLS
28908 documentation for more details.
28909
28910 For outgoing SMTP deliveries, &$tls_out_cipher$& is used and logged
28911 (again depending on the &%tls_cipher%& log selector).
28912
28913
28914 .section "Requesting and verifying client certificates" "SECID183"
28915 .cindex "certificate" "verification of client"
28916 .cindex "TLS" "client certificate verification"
28917 If you want an Exim server to request a certificate when negotiating a TLS
28918 session with a client, you must set either &%tls_verify_hosts%& or
28919 &%tls_try_verify_hosts%&. You can, of course, set either of them to * to
28920 apply to all TLS connections. For any host that matches one of these options,
28921 Exim requests a certificate as part of the setup of the TLS session. The
28922 contents of the certificate are verified by comparing it with a list of
28923 expected trust-anchors or certificates.
28924 These may be the system default set (depending on library version),
28925 an explicit file or,
28926 depending on library version, a directory, identified by
28927 &%tls_verify_certificates%&.
28928
28929 A file can contain multiple certificates, concatenated end to end. If a
28930 directory is used
28931 (OpenSSL only),
28932 each certificate must be in a separate file, with a name (or a symbolic link)
28933 of the form <&'hash'&>.0, where <&'hash'&> is a hash value constructed from the
28934 certificate. You can compute the relevant hash by running the command
28935 .code
28936 openssl x509 -hash -noout -in /cert/file
28937 .endd
28938 where &_/cert/file_& contains a single certificate.
28939
28940 There is no checking of names of the client against the certificate
28941 Subject Name or Subject Alternate Names.
28942
28943 The difference between &%tls_verify_hosts%& and &%tls_try_verify_hosts%& is
28944 what happens if the client does not supply a certificate, or if the certificate
28945 does not match any of the certificates in the collection named by
28946 &%tls_verify_certificates%&. If the client matches &%tls_verify_hosts%&, the
28947 attempt to set up a TLS session is aborted, and the incoming connection is
28948 dropped. If the client matches &%tls_try_verify_hosts%&, the (encrypted) SMTP
28949 session continues. ACLs that run for subsequent SMTP commands can detect the
28950 fact that no certificate was verified, and vary their actions accordingly. For
28951 example, you can insist on a certificate before accepting a message for
28952 relaying, but not when the message is destined for local delivery.
28953
28954 .vindex "&$tls_in_peerdn$&"
28955 When a client supplies a certificate (whether it verifies or not), the value of
28956 the Distinguished Name of the certificate is made available in the variable
28957 &$tls_in_peerdn$& during subsequent processing of the message.
28958
28959 .cindex "log" "distinguished name"
28960 Because it is often a long text string, it is not included in the log line or
28961 &'Received:'& header by default. You can arrange for it to be logged, keyed by
28962 &"DN="&, by setting the &%tls_peerdn%& log selector, and you can use
28963 &%received_header_text%& to change the &'Received:'& header. When no
28964 certificate is supplied, &$tls_in_peerdn$& is empty.
28965
28966
28967 .section "Revoked certificates" "SECID184"
28968 .cindex "TLS" "revoked certificates"
28969 .cindex "revocation list"
28970 .cindex "certificate" "revocation list"
28971 .cindex "OCSP" "stapling"
28972 Certificate issuing authorities issue Certificate Revocation Lists (CRLs) when
28973 certificates are revoked. If you have such a list, you can pass it to an Exim
28974 server using the global option called &%tls_crl%& and to an Exim client using
28975 an identically named option for the &(smtp)& transport. In each case, the value
28976 of the option is expanded and must then be the name of a file that contains a
28977 CRL in PEM format.
28978 The downside is that clients have to periodically re-download a potentially huge
28979 file from every certificate authority they know of.
28980
28981 The way with most moving parts at query time is Online Certificate
28982 Status Protocol (OCSP), where the client verifies the certificate
28983 against an OCSP server run by the CA.  This lets the CA track all
28984 usage of the certs.  It requires running software with access to the
28985 private key of the CA, to sign the responses to the OCSP queries.  OCSP
28986 is based on HTTP and can be proxied accordingly.
28987
28988 The only widespread OCSP server implementation (known to this writer)
28989 comes as part of OpenSSL and aborts on an invalid request, such as
28990 connecting to the port and then disconnecting.  This requires
28991 re-entering the passphrase each time some random client does this.
28992
28993 The third way is OCSP Stapling; in this, the server using a certificate
28994 issued by the CA periodically requests an OCSP proof of validity from
28995 the OCSP server, then serves it up inline as part of the TLS
28996 negotiation.   This approach adds no extra round trips, does not let the
28997 CA track users, scales well with number of certs issued by the CA and is
28998 resilient to temporary OCSP server failures, as long as the server
28999 starts retrying to fetch an OCSP proof some time before its current
29000 proof expires.  The downside is that it requires server support.
29001
29002 Unless Exim is built with the support disabled,
29003 or with GnuTLS earlier than version 3.3.16 / 3.4.8
29004 support for OCSP stapling is included.
29005
29006 There is a global option called &%tls_ocsp_file%&.
29007 The file specified therein is expected to be in DER format, and contain
29008 an OCSP proof.  Exim will serve it as part of the TLS handshake.  This
29009 option will be re-expanded for SNI, if the &%tls_certificate%& option
29010 contains &`tls_in_sni`&, as per other TLS options.
29011
29012 Exim does not at this time implement any support for fetching a new OCSP
29013 proof.  The burden is on the administrator to handle this, outside of
29014 Exim.  The file specified should be replaced atomically, so that the
29015 contents are always valid.  Exim will expand the &%tls_ocsp_file%& option
29016 on each connection, so a new file will be handled transparently on the
29017 next connection.
29018
29019 When built with OpenSSL Exim will check for a valid next update timestamp
29020 in the OCSP proof; if not present, or if the proof has expired, it will be
29021 ignored.
29022
29023 For the client to be able to verify the stapled OCSP the server must
29024 also supply, in its stapled information, any intermediate
29025 certificates for the chain leading to the OCSP proof from the signer
29026 of the server certificate.  There may be zero or one such. These
29027 intermediate certificates should be added to the server OCSP stapling
29028 file named by &%tls_ocsp_file%&.
29029
29030 Note that the proof only covers the terminal server certificate,
29031 not any of the chain from CA to it.
29032
29033 There is no current way to staple a proof for a client certificate.
29034
29035 .code
29036   A helper script "ocsp_fetch.pl" for fetching a proof from a CA
29037   OCSP server is supplied.  The server URL may be included in the
29038   server certificate, if the CA is helpful.
29039
29040   One failure mode seen was the OCSP Signer cert expiring before the end
29041   of validity of the OCSP proof. The checking done by Exim/OpenSSL
29042   noted this as invalid overall, but the re-fetch script did not.
29043 .endd
29044
29045
29046
29047
29048 .section "Configuring an Exim client to use TLS" "SECTclientTLS"
29049 .cindex "cipher" "logging"
29050 .cindex "log" "TLS cipher"
29051 .cindex "log" "distinguished name"
29052 .cindex "TLS" "configuring an Exim client"
29053 The &%tls_cipher%& and &%tls_peerdn%& log selectors apply to outgoing SMTP
29054 deliveries as well as to incoming, the latter one causing logging of the
29055 server certificate's DN. The remaining client configuration for TLS is all
29056 within the &(smtp)& transport.
29057
29058 It is not necessary to set any options to have TLS work in the &(smtp)&
29059 transport. If Exim is built with TLS support, and TLS is advertised by a
29060 server, the &(smtp)& transport always tries to start a TLS session. However,
29061 this can be prevented by setting &%hosts_avoid_tls%& (an option of the
29062 transport) to a list of server hosts for which TLS should not be used.
29063
29064 If you do not want Exim to attempt to send messages unencrypted when an attempt
29065 to set up an encrypted connection fails in any way, you can set
29066 &%hosts_require_tls%& to a list of hosts for which encryption is mandatory. For
29067 those hosts, delivery is always deferred if an encrypted connection cannot be
29068 set up. If there are any other hosts for the address, they are tried in the
29069 usual way.
29070
29071 When the server host is not in &%hosts_require_tls%&, Exim may try to deliver
29072 the message unencrypted. It always does this if the response to STARTTLS is
29073 a 5&'xx'& code. For a temporary error code, or for a failure to negotiate a TLS
29074 session after a success response code, what happens is controlled by the
29075 &%tls_tempfail_tryclear%& option of the &(smtp)& transport. If it is false,
29076 delivery to this host is deferred, and other hosts (if available) are tried. If
29077 it is true, Exim attempts to deliver unencrypted after a 4&'xx'& response to
29078 STARTTLS, and if STARTTLS is accepted, but the subsequent TLS
29079 negotiation fails, Exim closes the current connection (because it is in an
29080 unknown state), opens a new one to the same host, and then tries the delivery
29081 unencrypted.
29082
29083 The &%tls_certificate%& and &%tls_privatekey%& options of the &(smtp)&
29084 transport provide the client with a certificate, which is passed to the server
29085 if it requests it. If the server is Exim, it will request a certificate only if
29086 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& matches the client.
29087
29088 &*Note*&: Do not use a certificate which has the OCSP-must-staple extension,
29089 for client use (they are usable for server use).
29090 As the TLS protocol has no means for the client to staple before TLS 1.3 it will result
29091 in failed connections.
29092
29093 If the &%tls_verify_certificates%& option is set on the &(smtp)& transport, it
29094 specifies a collection of expected server certificates.
29095 These may be
29096 the system default set (depending on library version),
29097 a file,
29098 or (depending on library version) a directory.
29099 The client verifies the server's certificate
29100 against this collection, taking into account any revoked certificates that are
29101 in the list defined by &%tls_crl%&.
29102 Failure to verify fails the TLS connection unless either of the
29103 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& options are set.
29104
29105 The &%tls_verify_hosts%& and &%tls_try_verify_hosts%& options restrict
29106 certificate verification to the listed servers.  Verification either must
29107 or need not succeed respectively.
29108
29109 The &%tls_verify_cert_hostnames%& option lists hosts for which additional
29110 checks are made: that the host name (the one in the DNS A record)
29111 is valid for the certificate.
29112 The option defaults to always checking.
29113
29114 The &(smtp)& transport has two OCSP-related options:
29115 &%hosts_require_ocsp%&; a host-list for which a Certificate Status
29116 is requested and required for the connection to proceed.  The default
29117 value is empty.
29118 &%hosts_request_ocsp%&; a host-list for which (additionally)
29119 a Certificate Status is requested (but not necessarily verified).  The default
29120 value is "*" meaning that requests are made unless configured
29121 otherwise.
29122
29123 The host(s) should also be in &%hosts_require_tls%&, and
29124 &%tls_verify_certificates%& configured for the transport,
29125 for OCSP to be relevant.
29126
29127 If
29128 &%tls_require_ciphers%& is set on the &(smtp)& transport, it must contain a
29129 list of permitted cipher suites. If either of these checks fails, delivery to
29130 the current host is abandoned, and the &(smtp)& transport tries to deliver to
29131 alternative hosts, if any.
29132
29133  &*Note*&:
29134 These options must be set in the &(smtp)& transport for Exim to use TLS when it
29135 is operating as a client. Exim does not assume that a server certificate (set
29136 by the global options of the same name) should also be used when operating as a
29137 client.
29138
29139 .vindex "&$host$&"
29140 .vindex "&$host_address$&"
29141 All the TLS options in the &(smtp)& transport are expanded before use, with
29142 &$host$& and &$host_address$& containing the name and address of the server to
29143 which the client is connected. Forced failure of an expansion causes Exim to
29144 behave as if the relevant option were unset.
29145
29146 .vindex &$tls_out_bits$&
29147 .vindex &$tls_out_cipher$&
29148 .vindex &$tls_out_peerdn$&
29149 .vindex &$tls_out_sni$&
29150 Before an SMTP connection is established, the
29151 &$tls_out_bits$&, &$tls_out_cipher$&, &$tls_out_peerdn$& and &$tls_out_sni$&
29152 variables are emptied. (Until the first connection, they contain the values
29153 that were set when the message was received.) If STARTTLS is subsequently
29154 successfully obeyed, these variables are set to the relevant values for the
29155 outgoing connection.
29156
29157
29158
29159 .section "Use of TLS Server Name Indication" "SECTtlssni"
29160 .cindex "TLS" "Server Name Indication"
29161 .vindex "&$tls_in_sni$&"
29162 .oindex "&%tls_in_sni%&"
29163 With TLS1.0 or above, there is an extension mechanism by which extra
29164 information can be included at various points in the protocol.  One of these
29165 extensions, documented in RFC 6066 (and before that RFC 4366) is
29166 &"Server Name Indication"&, commonly &"SNI"&.  This extension is sent by the
29167 client in the initial handshake, so that the server can examine the servername
29168 within and possibly choose to use different certificates and keys (and more)
29169 for this session.
29170
29171 This is analogous to HTTP's &"Host:"& header, and is the main mechanism by
29172 which HTTPS-enabled web-sites can be virtual-hosted, many sites to one IP
29173 address.
29174
29175 With SMTP to MX, there are the same problems here as in choosing the identity
29176 against which to validate a certificate: you can't rely on insecure DNS to
29177 provide the identity which you then cryptographically verify.  So this will
29178 be of limited use in that environment.
29179
29180 With SMTP to Submission, there is a well-defined hostname which clients are
29181 connecting to and can validate certificates against.  Thus clients &*can*&
29182 choose to include this information in the TLS negotiation.  If this becomes
29183 wide-spread, then hosters can choose to present different certificates to
29184 different clients.  Or even negotiate different cipher suites.
29185
29186 The &%tls_sni%& option on an SMTP transport is an expanded string; the result,
29187 if not empty, will be sent on a TLS session as part of the handshake.  There's
29188 nothing more to it.  Choosing a sensible value not derived insecurely is the
29189 only point of caution.  The &$tls_out_sni$& variable will be set to this string
29190 for the lifetime of the client connection (including during authentication).
29191
29192 Except during SMTP client sessions, if &$tls_in_sni$& is set then it is a string
29193 received from a client.
29194 It can be logged with the &%log_selector%& item &`+tls_sni`&.
29195
29196 If the string &`tls_in_sni`& appears in the main section's &%tls_certificate%&
29197 option (prior to expansion) then the following options will be re-expanded
29198 during TLS session handshake, to permit alternative values to be chosen:
29199
29200 .ilist
29201 &%tls_certificate%&
29202 .next
29203 &%tls_crl%&
29204 .next
29205 &%tls_privatekey%&
29206 .next
29207 &%tls_verify_certificates%&
29208 .next
29209 &%tls_ocsp_file%&
29210 .endlist
29211
29212 Great care should be taken to deal with matters of case, various injection
29213 attacks in the string (&`../`& or SQL), and ensuring that a valid filename
29214 can always be referenced; it is important to remember that &$tls_in_sni$& is
29215 arbitrary unverified data provided prior to authentication.
29216 Further, the initial certificate is loaded before SNI has arrived, so
29217 an expansion for &%tls_certificate%& must have a default which is used
29218 when &$tls_in_sni$& is empty.
29219
29220 The Exim developers are proceeding cautiously and so far no other TLS options
29221 are re-expanded.
29222
29223 When Exim is built against OpenSSL, OpenSSL must have been built with support
29224 for TLS Extensions.  This holds true for OpenSSL 1.0.0+ and 0.9.8+ with
29225 enable-tlsext in EXTRACONFIGURE.  If you invoke &(openssl s_client -h)& and
29226 see &`-servername`& in the output, then OpenSSL has support.
29227
29228 When Exim is built against GnuTLS, SNI support is available as of GnuTLS
29229 0.5.10.  (Its presence predates the current API which Exim uses, so if Exim
29230 built, then you have SNI support).
29231
29232
29233
29234 .section "Multiple messages on the same encrypted TCP/IP connection" &&&
29235          "SECTmulmessam"
29236 .cindex "multiple SMTP deliveries with TLS"
29237 .cindex "TLS" "multiple message deliveries"
29238 Exim sends multiple messages down the same TCP/IP connection by starting up
29239 an entirely new delivery process for each message, passing the socket from
29240 one process to the next. This implementation does not fit well with the use
29241 of TLS, because there is quite a lot of state information associated with a TLS
29242 connection, not just a socket identification. Passing all the state information
29243 to a new process is not feasible. Consequently, for sending using TLS Exim
29244 starts an additional proxy process for handling the encryption, piping the
29245 unencrypted data stream from and to the delivery processes.
29246
29247 An older mode of operation can be enabled on a per-host basis by the
29248 &%hosts_noproxy_tls%& option on the &(smtp)& transport.  If the host matches
29249 this list the proxy process described above is not used; instead Exim
29250 shuts down an existing TLS session being run by the delivery process
29251 before passing the socket to a new process. The new process may then
29252 try to start a new TLS session, and if successful, may try to re-authenticate
29253 if AUTH is in use, before sending the next message.
29254
29255 The RFC is not clear as to whether or not an SMTP session continues in clear
29256 after TLS has been shut down, or whether TLS may be restarted again later, as
29257 just described. However, if the server is Exim, this shutdown and
29258 reinitialization works. It is not known which (if any) other servers operate
29259 successfully if the client closes a TLS session and continues with unencrypted
29260 SMTP, but there are certainly some that do not work. For such servers, Exim
29261 should not pass the socket to another process, because the failure of the
29262 subsequent attempt to use it would cause Exim to record a temporary host error,
29263 and delay other deliveries to that host.
29264
29265 To test for this case, Exim sends an EHLO command to the server after
29266 closing down the TLS session. If this fails in any way, the connection is
29267 closed instead of being passed to a new delivery process, but no retry
29268 information is recorded.
29269
29270 There is also a manual override; you can set &%hosts_nopass_tls%& on the
29271 &(smtp)& transport to match those hosts for which Exim should not pass
29272 connections to new processes if TLS has been used.
29273
29274
29275
29276
29277 .section "Certificates and all that" "SECTcerandall"
29278 .cindex "certificate" "references to discussion"
29279 In order to understand fully how TLS works, you need to know about
29280 certificates, certificate signing, and certificate authorities.
29281 This is a large topic and an introductory guide is unsuitable for the Exim
29282 reference manual, so instead we provide pointers to existing documentation.
29283
29284 The Apache web-server was for a long time the canonical guide, so their
29285 documentation is a good place to start; their SSL module's Introduction
29286 document is currently at
29287 .display
29288 &url(https://httpd.apache.org/docs/current/ssl/ssl_intro.html)
29289 .endd
29290 and their FAQ is at
29291 .display
29292 &url(https://httpd.apache.org/docs/current/ssl/ssl_faq.html)
29293 .endd
29294
29295 Eric Rescorla's book, &'SSL and TLS'&, published by Addison-Wesley (ISBN
29296 0-201-61598-3) in 2001, contains both introductory and more in-depth
29297 descriptions.
29298 More recently Ivan Ristić's book &'Bulletproof SSL and TLS'&,
29299 published by Feisty Duck (ISBN 978-1907117046) in 2013 is good.
29300 Ivan is the author of the popular TLS testing tools at
29301 &url(https://www.ssllabs.com/).
29302
29303
29304 .section "Certificate chains" "SECID186"
29305 The file named by &%tls_certificate%& may contain more than one
29306 certificate. This is useful in the case where the certificate that is being
29307 sent is validated by an intermediate certificate which the other end does
29308 not have. Multiple certificates must be in the correct order in the file.
29309 First the host's certificate itself, then the first intermediate
29310 certificate to validate the issuer of the host certificate, then the next
29311 intermediate certificate to validate the issuer of the first intermediate
29312 certificate, and so on, until finally (optionally) the root certificate.
29313 The root certificate must already be trusted by the recipient for
29314 validation to succeed, of course, but if it's not preinstalled, sending the
29315 root certificate along with the rest makes it available for the user to
29316 install if the receiving end is a client MUA that can interact with a user.
29317
29318 Note that certificates using MD5 are unlikely to work on today's Internet;
29319 even if your libraries allow loading them for use in Exim when acting as a
29320 server, increasingly clients will not accept such certificates.  The error
29321 diagnostics in such a case can be frustratingly vague.
29322
29323
29324
29325 .section "Self-signed certificates" "SECID187"
29326 .cindex "certificate" "self-signed"
29327 You can create a self-signed certificate using the &'req'& command provided
29328 with OpenSSL, like this:
29329 . ==== Do not shorten the duration here without reading and considering
29330 . ==== the text below.  Please leave it at 9999 days.
29331 .code
29332 openssl req -x509 -newkey rsa:1024 -keyout file1 -out file2 \
29333             -days 9999 -nodes
29334 .endd
29335 &_file1_& and &_file2_& can be the same file; the key and the certificate are
29336 delimited and so can be identified independently. The &%-days%& option
29337 specifies a period for which the certificate is valid. The &%-nodes%& option is
29338 important: if you do not set it, the key is encrypted with a passphrase
29339 that you are prompted for, and any use that is made of the key causes more
29340 prompting for the passphrase. This is not helpful if you are going to use
29341 this certificate and key in an MTA, where prompting is not possible.
29342
29343 . ==== I expect to still be working 26 years from now.  The less technical
29344 . ==== debt I create, in terms of storing up trouble for my later years, the
29345 . ==== happier I will be then.  We really have reached the point where we
29346 . ==== should start, at the very least, provoking thought and making folks
29347 . ==== pause before proceeding, instead of leaving all the fixes until two
29348 . ==== years before 2^31 seconds after the 1970 Unix epoch.
29349 . ==== -pdp, 2012
29350 NB: we are now past the point where 9999 days takes us past the 32-bit Unix
29351 epoch.  If your system uses unsigned time_t (most do) and is 32-bit, then
29352 the above command might produce a date in the past.  Think carefully about
29353 the lifetime of the systems you're deploying, and either reduce the duration
29354 of the certificate or reconsider your platform deployment.  (At time of
29355 writing, reducing the duration is the most likely choice, but the inexorable
29356 progression of time takes us steadily towards an era where this will not
29357 be a sensible resolution).
29358
29359 A self-signed certificate made in this way is sufficient for testing, and
29360 may be adequate for all your requirements if you are mainly interested in
29361 encrypting transfers, and not in secure identification.
29362
29363 However, many clients require that the certificate presented by the server be a
29364 user (also called &"leaf"& or &"site"&) certificate, and not a self-signed
29365 certificate. In this situation, the self-signed certificate described above
29366 must be installed on the client host as a trusted root &'certification
29367 authority'& (CA), and the certificate used by Exim must be a user certificate
29368 signed with that self-signed certificate.
29369
29370 For information on creating self-signed CA certificates and using them to sign
29371 user certificates, see the &'General implementation overview'& chapter of the
29372 Open-source PKI book, available online at
29373 &url(https://sourceforge.net/projects/ospkibook/).
29374 .ecindex IIDencsmtp1
29375 .ecindex IIDencsmtp2
29376
29377
29378
29379 .section DANE "SECDANE"
29380 .cindex DANE
29381 DNS-based Authentication of Named Entities, as applied to SMTP over TLS, provides assurance to a client that
29382 it is actually talking to the server it wants to rather than some attacker operating a Man In The Middle (MITM)
29383 operation.  The latter can terminate the TLS connection you make, and make another one to the server (so both
29384 you and the server still think you have an encrypted connection) and, if one of the "well known" set of
29385 Certificate Authorities has been suborned - something which *has* been seen already (2014), a verifiable
29386 certificate (if you're using normal root CAs, eg. the Mozilla set, as your trust anchors).
29387
29388 What DANE does is replace the CAs with the DNS as the trust anchor.  The assurance is limited to a) the possibility
29389 that the DNS has been suborned, b) mistakes made by the admins of the target server.   The attack surface presented
29390 by (a) is thought to be smaller than that of the set of root CAs.
29391
29392 It also allows the server to declare (implicitly) that connections to it should use TLS.  An MITM could simply
29393 fail to pass on a server's STARTTLS.
29394
29395 DANE scales better than having to maintain (and side-channel communicate) copies of server certificates
29396 for every possible target server.  It also scales (slightly) better than having to maintain on an SMTP
29397 client a copy of the standard CAs bundle.  It also means not having to pay a CA for certificates.
29398
29399 DANE requires a server operator to do three things: 1) run DNSSEC.  This provides assurance to clients
29400 that DNS lookups they do for the server have not been tampered with.  The domain MX record applying
29401 to this server, its A record, its TLSA record and any associated CNAME records must all be covered by
29402 DNSSEC.
29403 2) add TLSA DNS records.  These say what the server certificate for a TLS connection should be.
29404 3) offer a server certificate, or certificate chain, in TLS connections which is is anchored by one of the TLSA records.
29405
29406 There are no changes to Exim specific to server-side operation of DANE.
29407 Support for client-side operation of DANE can be included at compile time by defining SUPPORT_DANE=yes
29408 in &_Local/Makefile_&.
29409 If it has been included, the macro "_HAVE_DANE" will be defined.
29410
29411 A TLSA record consist of 4 fields, the "Certificate Usage", the
29412 "Selector", the "Matching type", and the "Certificate Association Data".
29413 For a detailed description of the TLSA record see
29414 &url(https://tools.ietf.org/html/rfc7671#page-5,RFC 7671).
29415
29416 The TLSA record for the server may have "Certificate Usage" (1st) field of DANE-TA(2) or DANE-EE(3).
29417 These are the "Trust Anchor" and "End Entity" variants.
29418 The latter specifies the End Entity directly, i.e. the certificate involved is that of the server
29419 (and if only DANE-EE is used then it should be the sole one transmitted during the TLS handshake);
29420 this is appropriate for a single system, using a self-signed certificate.
29421 DANE-TA usage is effectively declaring a specific CA to be used; this might be a private CA or a public,
29422 well-known one.
29423 A private CA at simplest is just a self-signed certificate (with certain
29424 attributes) which is used to sign server certificates, but running one securely
29425 does require careful arrangement.
29426 With DANE-TA, as implemented in Exim and commonly in other MTAs,
29427 the server TLS handshake must transmit the entire certificate chain from CA to server-certificate.
29428 DANE-TA is commonly used for several services and/or servers, each having a TLSA query-domain CNAME record,
29429 all of which point to a single TLSA record.
29430 DANE-TA and DANE-EE can both be used together.
29431
29432 Our recommendation is to use DANE with a certificate from a public CA,
29433 because this enables a variety of strategies for remote clients to verify
29434 your certificate.
29435 You can then publish information both via DANE and another technology,
29436 "MTA-STS", described below.
29437
29438 When you use DANE-TA to publish trust anchor information, you ask entities
29439 outside your administrative control to trust the Certificate Authority for
29440 connections to you.
29441 If using a private CA then you should expect others to still apply the
29442 technical criteria they'd use for a public CA to your certificates.
29443 In particular, you should probably try to follow current best practices for CA
29444 operation around hash algorithms and key sizes.
29445 Do not expect other organizations to lower their security expectations just
29446 because a particular profile might be reasonable for your own internal use.
29447
29448 When this text was last updated, this in practice means to avoid use of SHA-1
29449 and MD5; if using RSA to use key sizes of at least 2048 bits (and no larger
29450 than 4096, for interoperability); to use keyUsage fields correctly; to use
29451 random serial numbers.
29452 The list of requirements is subject to change as best practices evolve.
29453 If you're not already using a private CA, or it doesn't meet these
29454 requirements, then we encourage you to avoid all these issues and use a public
29455 CA such as &url(https://letsencrypt.org/,Let's Encrypt) instead.
29456
29457 The TLSA record should have a "Selector" (2nd) field of SPKI(1) and
29458 a "Matching Type" (3rd) field of SHA2-512(2).
29459
29460 For the "Certificate Authority Data" (4th) field, commands like
29461
29462 .code
29463   openssl x509 -pubkey -noout <certificate.pem \
29464   | openssl rsa -outform der -pubin 2>/dev/null \
29465   | openssl sha512 \
29466   | awk '{print $2}'
29467 .endd
29468
29469 are workable to create a hash of the certificate's public key.
29470
29471 An example TLSA record for DANE-EE(3), SPKI(1), and SHA-512 (2) looks like
29472
29473 .code
29474   _25._tcp.mail.example.com. TLSA 3 1 2 8BA8A336E...
29475 .endd
29476
29477 At the time of writing, &url(https://www.huque.com/bin/gen_tlsa)
29478 is useful for quickly generating TLSA records.
29479
29480
29481 For use with the DANE-TA model, server certificates must have a correct name (SubjectName or SubjectAltName).
29482
29483 The Certificate issued by the CA published in the DANE-TA model should be
29484 issued using a strong hash algorithm.
29485 Exim, and importantly various other MTAs sending to you, will not
29486 re-enable hash algorithms which have been disabled by default in TLS
29487 libraries.
29488 This means no MD5 and no SHA-1.  SHA2-256 is the minimum for reliable
29489 interoperability (and probably the maximum too, in 2018).
29490
29491 The use of OCSP-stapling should be considered, allowing for fast revocation of certificates (which would otherwise
29492 be limited by the DNS TTL on the TLSA records).  However, this is likely to only be usable with DANE-TA.  NOTE: the
29493 default of requesting OCSP for all hosts is modified iff DANE is in use, to:
29494
29495 .code
29496   hosts_request_ocsp = ${if or { {= {0}{$tls_out_tlsa_usage}} \
29497                                  {= {4}{$tls_out_tlsa_usage}} } \
29498                          {*}{}}
29499 .endd
29500
29501 The (new) variable &$tls_out_tlsa_usage$& is a bitfield with numbered bits set for TLSA record usage codes.
29502 The zero above means DANE was not in use, the four means that only DANE-TA usage TLSA records were
29503 found. If the definition of &%hosts_request_ocsp%& includes the
29504 string "tls_out_tlsa_usage", they are re-expanded in time to
29505 control the OCSP request.
29506
29507 This modification of hosts_request_ocsp is only done if it has the default value of "*".  Admins who change it, and
29508 those who use &%hosts_require_ocsp%&, should consider the interaction with DANE in their OCSP settings.
29509
29510
29511 For client-side DANE there are three new smtp transport options, &%hosts_try_dane%&, &%hosts_require_dane%&
29512 and &%dane_require_tls_ciphers%&.
29513 The &"require"& variant will result in failure if the target host is not
29514 DNSSEC-secured. To get DNSSEC-secured hostname resolution, use
29515 the &%dnssec_request_domains%& router or transport option.
29516
29517 DANE will only be usable if the target host has DNSSEC-secured MX, A and TLSA records.
29518
29519 A TLSA lookup will be done if either of the above options match and the host-lookup succeeded using dnssec.
29520 If a TLSA lookup is done and succeeds, a DANE-verified TLS connection
29521 will be required for the host.  If it does not, the host will not
29522 be used; there is no fallback to non-DANE or non-TLS.
29523
29524 If DANE is requested and usable, then the TLS cipher list configuration
29525 prefers to use the option &%dane_require_tls_ciphers%& and falls
29526 back to &%tls_require_ciphers%& only if that is unset.
29527 This lets you configure "decent crypto" for DANE and "better than nothing
29528 crypto" as the default.  Note though that while GnuTLS lets the string control
29529 which versions of TLS/SSL will be negotiated, OpenSSL does not and you're
29530 limited to ciphersuite constraints.
29531
29532 If DANE is requested and useable (see above) the following transport options are ignored:
29533 .code
29534   hosts_require_tls
29535   tls_verify_hosts
29536   tls_try_verify_hosts
29537   tls_verify_certificates
29538   tls_crl
29539   tls_verify_cert_hostnames
29540 .endd
29541
29542 If DANE is not usable, whether requested or not, and CA-anchored
29543 verification evaluation is wanted, the above variables should be set appropriately.
29544
29545 The router and transport option &%dnssec_request_domains%& must not be
29546 set to &"never"&, and &%dnssec_require_domains%& is ignored.
29547
29548 If verification was successful using DANE then the "CV" item in the delivery log line will show as "CV=dane".
29549
29550 There is a new variable &$tls_out_dane$& which will have "yes" if
29551 verification succeeded using DANE and "no" otherwise (only useful
29552 in combination with events; see &<<CHAPevents>>&),
29553 and a new variable &$tls_out_tlsa_usage$& (detailed above).
29554
29555 .cindex DANE reporting
29556 An event (see &<<CHAPevents>>&) of type "dane:fail" will be raised on failures
29557 to achieve DANE-verified connection, if one was either requested and offered, or
29558 required.  This is intended to support TLS-reporting as defined in
29559 &url(https://tools.ietf.org/html/draft-ietf-uta-smtp-tlsrpt-17).
29560 The &$event_data$& will be one of the Result Types defined in
29561 Section 4.3 of that document.
29562
29563 Under GnuTLS, DANE is only supported from version 3.0.0 onwards.
29564
29565 DANE is specified in published RFCs and decouples certificate authority trust
29566 selection from a "race to the bottom" of "you must trust everything for mail
29567 to get through".  There is an alternative technology called MTA-STS, which
29568 instead publishes MX trust anchor information on an HTTPS website.  At the
29569 time this text was last updated, MTA-STS was still a draft, not yet an RFC.
29570 Exim has no support for MTA-STS as a client, but Exim mail server operators
29571 can choose to publish information describing their TLS configuration using
29572 MTA-STS to let those clients who do use that protocol derive trust
29573 information.
29574
29575 The MTA-STS design requires a certificate from a public Certificate Authority
29576 which is recognized by clients sending to you.
29577 That selection of which CAs are trusted by others is outside your control.
29578
29579 The most interoperable course of action is probably to use
29580 &url(https://letsencrypt.org/,Let's Encrypt), with automated certificate
29581 renewal; to publish the anchor information in DNSSEC-secured DNS via TLSA
29582 records for DANE clients (such as Exim and Postfix) and to publish anchor
29583 information for MTA-STS as well.  This is what is done for the &'exim.org'&
29584 domain itself (with caveats around occasionally broken MTA-STS because of
29585 incompatible specification changes prior to reaching RFC status).
29586
29587
29588
29589 . ////////////////////////////////////////////////////////////////////////////
29590 . ////////////////////////////////////////////////////////////////////////////
29591
29592 .chapter "Access control lists" "CHAPACL"
29593 .scindex IIDacl "&ACL;" "description"
29594 .cindex "control of incoming mail"
29595 .cindex "message" "controlling incoming"
29596 .cindex "policy control" "access control lists"
29597 Access Control Lists (ACLs) are defined in a separate section of the runtime
29598 configuration file, headed by &"begin acl"&. Each ACL definition starts with a
29599 name, terminated by a colon. Here is a complete ACL section that contains just
29600 one very small ACL:
29601 .code
29602 begin acl
29603 small_acl:
29604   accept   hosts = one.host.only
29605 .endd
29606 You can have as many lists as you like in the ACL section, and the order in
29607 which they appear does not matter. The lists are self-terminating.
29608
29609 The majority of ACLs are used to control Exim's behaviour when it receives
29610 certain SMTP commands. This applies both to incoming TCP/IP connections, and
29611 when a local process submits a message using SMTP by specifying the &%-bs%&
29612 option. The most common use is for controlling which recipients are accepted
29613 in incoming messages. In addition, you can define an ACL that is used to check
29614 local non-SMTP messages. The default configuration file contains an example of
29615 a realistic ACL for checking RCPT commands. This is discussed in chapter
29616 &<<CHAPdefconfil>>&.
29617
29618
29619 .section "Testing ACLs" "SECID188"
29620 The &%-bh%& command line option provides a way of testing your ACL
29621 configuration locally by running a fake SMTP session with which you interact.
29622
29623
29624 .section "Specifying when ACLs are used" "SECID189"
29625 .cindex "&ACL;" "options for specifying"
29626 In order to cause an ACL to be used, you have to name it in one of the relevant
29627 options in the main part of the configuration. These options are:
29628 .cindex "AUTH" "ACL for"
29629 .cindex "DATA" "ACLs for"
29630 .cindex "ETRN" "ACL for"
29631 .cindex "EXPN" "ACL for"
29632 .cindex "HELO" "ACL for"
29633 .cindex "EHLO" "ACL for"
29634 .cindex "DKIM" "ACL for"
29635 .cindex "MAIL" "ACL for"
29636 .cindex "QUIT, ACL for"
29637 .cindex "RCPT" "ACL for"
29638 .cindex "STARTTLS, ACL for"
29639 .cindex "VRFY" "ACL for"
29640 .cindex "SMTP" "connection, ACL for"
29641 .cindex "non-SMTP messages" "ACLs for"
29642 .cindex "MIME content scanning" "ACL for"
29643 .cindex "PRDR" "ACL for"
29644
29645 .table2 140pt
29646 .irow &%acl_not_smtp%&         "ACL for non-SMTP messages"
29647 .irow &%acl_not_smtp_mime%&    "ACL for non-SMTP MIME parts"
29648 .irow &%acl_not_smtp_start%&   "ACL at start of non-SMTP message"
29649 .irow &%acl_smtp_auth%&        "ACL for AUTH"
29650 .irow &%acl_smtp_connect%&     "ACL for start of SMTP connection"
29651 .irow &%acl_smtp_data%&        "ACL after DATA is complete"
29652 .irow &%acl_smtp_data_prdr%&   "ACL for each recipient, after DATA is complete"
29653 .irow &%acl_smtp_dkim%&        "ACL for each DKIM signer"
29654 .irow &%acl_smtp_etrn%&        "ACL for ETRN"
29655 .irow &%acl_smtp_expn%&        "ACL for EXPN"
29656 .irow &%acl_smtp_helo%&        "ACL for HELO or EHLO"
29657 .irow &%acl_smtp_mail%&        "ACL for MAIL"
29658 .irow &%acl_smtp_mailauth%&    "ACL for the AUTH parameter of MAIL"
29659 .irow &%acl_smtp_mime%&        "ACL for content-scanning MIME parts"
29660 .irow &%acl_smtp_notquit%&     "ACL for non-QUIT terminations"
29661 .irow &%acl_smtp_predata%&     "ACL at start of DATA command"
29662 .irow &%acl_smtp_quit%&        "ACL for QUIT"
29663 .irow &%acl_smtp_rcpt%&        "ACL for RCPT"
29664 .irow &%acl_smtp_starttls%&    "ACL for STARTTLS"
29665 .irow &%acl_smtp_vrfy%&        "ACL for VRFY"
29666 .endtable
29667
29668 For example, if you set
29669 .code
29670 acl_smtp_rcpt = small_acl
29671 .endd
29672 the little ACL defined above is used whenever Exim receives a RCPT command
29673 in an SMTP dialogue. The majority of policy tests on incoming messages can be
29674 done when RCPT commands arrive. A rejection of RCPT should cause the
29675 sending MTA to give up on the recipient address contained in the RCPT
29676 command, whereas rejection at other times may cause the client MTA to keep on
29677 trying to deliver the message. It is therefore recommended that you do as much
29678 testing as possible at RCPT time.
29679
29680
29681 .section "The non-SMTP ACLs" "SECID190"
29682 .cindex "non-SMTP messages" "ACLs for"
29683 The non-SMTP ACLs apply to all non-interactive incoming messages, that is, they
29684 apply to batched SMTP as well as to non-SMTP messages. (Batched SMTP is not
29685 really SMTP.) Many of the ACL conditions (for example, host tests, and tests on
29686 the state of the SMTP connection such as encryption and authentication) are not
29687 relevant and are forbidden in these ACLs. However, the sender and recipients
29688 are known, so the &%senders%& and &%sender_domains%& conditions and the
29689 &$sender_address$& and &$recipients$& variables can be used. Variables such as
29690 &$authenticated_sender$& are also available. You can specify added header lines
29691 in any of these ACLs.
29692
29693 The &%acl_not_smtp_start%& ACL is run right at the start of receiving a
29694 non-SMTP message, before any of the message has been read. (This is the
29695 analogue of the &%acl_smtp_predata%& ACL for SMTP input.) In the case of
29696 batched SMTP input, it runs after the DATA command has been reached. The
29697 result of this ACL is ignored; it cannot be used to reject a message. If you
29698 really need to, you could set a value in an ACL variable here and reject based
29699 on that in the &%acl_not_smtp%& ACL. However, this ACL can be used to set
29700 controls, and in particular, it can be used to set
29701 .code
29702 control = suppress_local_fixups
29703 .endd
29704 This cannot be used in the other non-SMTP ACLs because by the time they are
29705 run, it is too late.
29706
29707 The &%acl_not_smtp_mime%& ACL is available only when Exim is compiled with the
29708 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
29709
29710 The &%acl_not_smtp%& ACL is run just before the &[local_scan()]& function. Any
29711 kind of rejection is treated as permanent, because there is no way of sending a
29712 temporary error for these kinds of message.
29713
29714
29715 .section "The SMTP connect ACL" "SECID191"
29716 .cindex "SMTP" "connection, ACL for"
29717 .oindex &%smtp_banner%&
29718 The ACL test specified by &%acl_smtp_connect%& happens at the start of an SMTP
29719 session, after the test specified by &%host_reject_connection%& (which is now
29720 an anomaly) and any TCP Wrappers testing (if configured). If the connection is
29721 accepted by an &%accept%& verb that has a &%message%& modifier, the contents of
29722 the message override the banner message that is otherwise specified by the
29723 &%smtp_banner%& option.
29724
29725
29726 .section "The EHLO/HELO ACL" "SECID192"
29727 .cindex "EHLO" "ACL for"
29728 .cindex "HELO" "ACL for"
29729 The ACL test specified by &%acl_smtp_helo%& happens when the client issues an
29730 EHLO or HELO command, after the tests specified by &%helo_accept_junk_hosts%&,
29731 &%helo_allow_chars%&, &%helo_verify_hosts%&, and &%helo_try_verify_hosts%&.
29732 Note that a client may issue more than one EHLO or HELO command in an SMTP
29733 session, and indeed is required to issue a new EHLO or HELO after successfully
29734 setting up encryption following a STARTTLS command.
29735
29736 Note also that a deny neither forces the client to go away nor means that
29737 mail will be refused on the connection.  Consider checking for
29738 &$sender_helo_name$& being defined in a MAIL or RCPT ACL to do that.
29739
29740 If the command is accepted by an &%accept%& verb that has a &%message%&
29741 modifier, the message may not contain more than one line (it will be truncated
29742 at the first newline and a panic logged if it does). Such a message cannot
29743 affect the EHLO options that are listed on the second and subsequent lines of
29744 an EHLO response.
29745
29746
29747 .section "The DATA ACLs" "SECID193"
29748 .cindex "DATA" "ACLs for"
29749 Two ACLs are associated with the DATA command, because it is two-stage
29750 command, with two responses being sent to the client.
29751 When the DATA command is received, the ACL defined by &%acl_smtp_predata%&
29752 is obeyed. This gives you control after all the RCPT commands, but before
29753 the message itself is received. It offers the opportunity to give a negative
29754 response to the DATA command before the data is transmitted. Header lines
29755 added by MAIL or RCPT ACLs are not visible at this time, but any that
29756 are defined here are visible when the &%acl_smtp_data%& ACL is run.
29757
29758 You cannot test the contents of the message, for example, to verify addresses
29759 in the headers, at RCPT time or when the DATA command is received. Such
29760 tests have to appear in the ACL that is run after the message itself has been
29761 received, before the final response to the DATA command is sent. This is
29762 the ACL specified by &%acl_smtp_data%&, which is the second ACL that is
29763 associated with the DATA command.
29764
29765 .cindex CHUNKING "BDAT command"
29766 .cindex BDAT "SMTP command"
29767 .cindex "RFC 3030" CHUNKING
29768 If CHUNKING was advertised and a BDAT command sequence is received,
29769 the &%acl_smtp_predata%& ACL is not run.
29770 . XXX why not?  It should be possible, for the first BDAT.
29771 The &%acl_smtp_data%& is run after the last BDAT command and all of
29772 the data specified is received.
29773
29774 For both of these ACLs, it is not possible to reject individual recipients. An
29775 error response rejects the entire message. Unfortunately, it is known that some
29776 MTAs do not treat hard (5&'xx'&) responses to the DATA command (either
29777 before or after the data) correctly &-- they keep the message on their queues
29778 and try again later, but that is their problem, though it does waste some of
29779 your resources.
29780
29781 The &%acl_smtp_data%& ACL is run after
29782 the &%acl_smtp_data_prdr%&,
29783 the &%acl_smtp_dkim%&
29784 and the &%acl_smtp_mime%& ACLs.
29785
29786 .section "The SMTP DKIM ACL" "SECTDKIMACL"
29787 The &%acl_smtp_dkim%& ACL is available only when Exim is compiled with DKIM support
29788 enabled (which is the default).
29789
29790 The ACL test specified by &%acl_smtp_dkim%& happens after a message has been
29791 received, and is executed for each DKIM signature found in a message.  If not
29792 otherwise specified, the default action is to accept.
29793
29794 This ACL is evaluated before &%acl_smtp_mime%& and &%acl_smtp_data%&.
29795
29796 For details on the operation of DKIM, see section &<<SECDKIM>>&.
29797
29798
29799 .section "The SMTP MIME ACL" "SECID194"
29800 The &%acl_smtp_mime%& option is available only when Exim is compiled with the
29801 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
29802
29803 This ACL is evaluated after &%acl_smtp_dkim%& but before &%acl_smtp_data%&.
29804
29805
29806 .section "The SMTP PRDR ACL" "SECTPRDRACL"
29807 .cindex "PRDR" "ACL for"
29808 .oindex "&%prdr_enable%&"
29809 The &%acl_smtp_data_prdr%& ACL is available only when Exim is compiled
29810 with PRDR support enabled (which is the default).
29811 It becomes active only when the PRDR feature is negotiated between
29812 client and server for a message, and more than one recipient
29813 has been accepted.
29814
29815 The ACL test specified by &%acl_smtp_data_prdr%& happens after a message
29816 has been received, and is executed once for each recipient of the message
29817 with &$local_part$& and &$domain$& valid.
29818 The test may accept, defer or deny for individual recipients.
29819 The &%acl_smtp_data%& will still be called after this ACL and
29820 can reject the message overall, even if this ACL has accepted it
29821 for some or all recipients.
29822
29823 PRDR may be used to support per-user content filtering.  Without it
29824 one must defer any recipient after the first that has a different
29825 content-filter configuration.  With PRDR, the RCPT-time check
29826 .cindex "PRDR" "variable for"
29827 for this can be disabled when the variable &$prdr_requested$&
29828 is &"yes"&.
29829 Any required difference in behaviour of the main DATA-time
29830 ACL should however depend on the PRDR-time ACL having run, as Exim
29831 will avoid doing so in some situations (e.g. single-recipient mails).
29832
29833 See also the &%prdr_enable%& global option
29834 and the &%hosts_try_prdr%& smtp transport option.
29835
29836 This ACL is evaluated after &%acl_smtp_dkim%& but before &%acl_smtp_data%&.
29837 If the ACL is not defined, processing completes as if
29838 the feature was not requested by the client.
29839
29840 .section "The QUIT ACL" "SECTQUITACL"
29841 .cindex "QUIT, ACL for"
29842 The ACL for the SMTP QUIT command is anomalous, in that the outcome of the ACL
29843 does not affect the response code to QUIT, which is always 221. Thus, the ACL
29844 does not in fact control any access.
29845 For this reason, it may only accept
29846 or warn as its final result.
29847
29848 This ACL can be used for tasks such as custom logging at the end of an SMTP
29849 session. For example, you can use ACL variables in other ACLs to count
29850 messages, recipients, etc., and log the totals at QUIT time using one or
29851 more &%logwrite%& modifiers on a &%warn%& verb.
29852
29853 &*Warning*&: Only the &$acl_c$&&'x'& variables can be used for this, because
29854 the &$acl_m$&&'x'& variables are reset at the end of each incoming message.
29855
29856 You do not need to have a final &%accept%&, but if you do, you can use a
29857 &%message%& modifier to specify custom text that is sent as part of the 221
29858 response to QUIT.
29859
29860 This ACL is run only for a &"normal"& QUIT. For certain kinds of disastrous
29861 failure (for example, failure to open a log file, or when Exim is bombing out
29862 because it has detected an unrecoverable error), all SMTP commands from the
29863 client are given temporary error responses until QUIT is received or the
29864 connection is closed. In these special cases, the QUIT ACL does not run.
29865
29866
29867 .section "The not-QUIT ACL" "SECTNOTQUITACL"
29868 .vindex &$acl_smtp_notquit$&
29869 The not-QUIT ACL, specified by &%acl_smtp_notquit%&, is run in most cases when
29870 an SMTP session ends without sending QUIT. However, when Exim itself is in bad
29871 trouble, such as being unable to write to its log files, this ACL is not run,
29872 because it might try to do things (such as write to log files) that make the
29873 situation even worse.
29874
29875 Like the QUIT ACL, this ACL is provided to make it possible to do customized
29876 logging or to gather statistics, and its outcome is ignored. The &%delay%&
29877 modifier is forbidden in this ACL, and the only permitted verbs are &%accept%&
29878 and &%warn%&.
29879
29880 .vindex &$smtp_notquit_reason$&
29881 When the not-QUIT ACL is running, the variable &$smtp_notquit_reason$& is set
29882 to a string that indicates the reason for the termination of the SMTP
29883 connection. The possible values are:
29884 .table2
29885 .irow &`acl-drop`&                 "Another ACL issued a &%drop%& command"
29886 .irow &`bad-commands`&             "Too many unknown or non-mail commands"
29887 .irow &`command-timeout`&          "Timeout while reading SMTP commands"
29888 .irow &`connection-lost`&          "The SMTP connection has been lost"
29889 .irow &`data-timeout`&             "Timeout while reading message data"
29890 .irow &`local-scan-error`&         "The &[local_scan()]& function crashed"
29891 .irow &`local-scan-timeout`&       "The &[local_scan()]& function timed out"
29892 .irow &`signal-exit`&              "SIGTERM or SIGINT"
29893 .irow &`synchronization-error`&    "SMTP synchronization error"
29894 .irow &`tls-failed`&               "TLS failed to start"
29895 .endtable
29896 In most cases when an SMTP connection is closed without having received QUIT,
29897 Exim sends an SMTP response message before actually closing the connection.
29898 With the exception of the &`acl-drop`& case, the default message can be
29899 overridden by the &%message%& modifier in the not-QUIT ACL. In the case of a
29900 &%drop%& verb in another ACL, it is the message from the other ACL that is
29901 used.
29902
29903
29904 .section "Finding an ACL to use" "SECID195"
29905 .cindex "&ACL;" "finding which to use"
29906 The value of an &%acl_smtp_%&&'xxx'& option is expanded before use, so
29907 you can use different ACLs in different circumstances. For example,
29908 .code
29909 acl_smtp_rcpt = ${if ={25}{$interface_port} \
29910                      {acl_check_rcpt} {acl_check_rcpt_submit} }
29911 .endd
29912 In the default configuration file there are some example settings for
29913 providing an RFC 4409 message &"submission"& service on port 587 and
29914 an RFC 8314 &"submissions"& service on port 465. You can use a string
29915 expansion like this to choose an ACL for MUAs on these ports which is
29916 more appropriate for this purpose than the default ACL on port 25.
29917
29918 The expanded string does not have to be the name of an ACL in the
29919 configuration file; there are other possibilities. Having expanded the
29920 string, Exim searches for an ACL as follows:
29921
29922 .ilist
29923 If the string begins with a slash, Exim uses it as a filename, and reads its
29924 contents as an ACL. The lines are processed in the same way as lines in the
29925 Exim configuration file. In particular, continuation lines are supported, blank
29926 lines are ignored, as are lines whose first non-whitespace character is &"#"&.
29927 If the file does not exist or cannot be read, an error occurs (typically
29928 causing a temporary failure of whatever caused the ACL to be run). For example:
29929 .code
29930 acl_smtp_data = /etc/acls/\
29931   ${lookup{$sender_host_address}lsearch\
29932   {/etc/acllist}{$value}{default}}
29933 .endd
29934 This looks up an ACL file to use on the basis of the host's IP address, falling
29935 back to a default if the lookup fails. If an ACL is successfully read from a
29936 file, it is retained in memory for the duration of the Exim process, so that it
29937 can be re-used without having to re-read the file.
29938 .next
29939 If the string does not start with a slash, and does not contain any spaces,
29940 Exim searches the ACL section of the configuration for an ACL whose name
29941 matches the string.
29942 .next
29943 If no named ACL is found, or if the string contains spaces, Exim parses
29944 the string as an inline ACL. This can save typing in cases where you just
29945 want to have something like
29946 .code
29947 acl_smtp_vrfy = accept
29948 .endd
29949 in order to allow free use of the VRFY command. Such a string may contain
29950 newlines; it is processed in the same way as an ACL that is read from a file.
29951 .endlist
29952
29953
29954
29955
29956 .section "ACL return codes" "SECID196"
29957 .cindex "&ACL;" "return codes"
29958 Except for the QUIT ACL, which does not affect the SMTP return code (see
29959 section &<<SECTQUITACL>>& above), the result of running an ACL is either
29960 &"accept"& or &"deny"&, or, if some test cannot be completed (for example, if a
29961 database is down), &"defer"&. These results cause 2&'xx'&, 5&'xx'&, and 4&'xx'&
29962 return codes, respectively, to be used in the SMTP dialogue. A fourth return,
29963 &"error"&, occurs when there is an error such as invalid syntax in the ACL.
29964 This also causes a 4&'xx'& return code.
29965
29966 For the non-SMTP ACL, &"defer"& and &"error"& are treated in the same way as
29967 &"deny"&, because there is no mechanism for passing temporary errors to the
29968 submitters of non-SMTP messages.
29969
29970
29971 ACLs that are relevant to message reception may also return &"discard"&. This
29972 has the effect of &"accept"&, but causes either the entire message or an
29973 individual recipient address to be discarded. In other words, it is a
29974 blackholing facility. Use it with care.
29975
29976 If the ACL for MAIL returns &"discard"&, all recipients are discarded, and no
29977 ACL is run for subsequent RCPT commands. The effect of &"discard"& in a
29978 RCPT ACL is to discard just the one recipient address. If there are no
29979 recipients left when the message's data is received, the DATA ACL is not
29980 run. A &"discard"& return from the DATA or the non-SMTP ACL discards all the
29981 remaining recipients. The &"discard"& return is not permitted for the
29982 &%acl_smtp_predata%& ACL.
29983
29984 If the ACL for VRFY returns &"accept"&, a recipient verify (without callout)
29985 is done on the address and the result determines the SMTP response.
29986
29987
29988 .cindex "&[local_scan()]& function" "when all recipients discarded"
29989 The &[local_scan()]& function is always run, even if there are no remaining
29990 recipients; it may create new recipients.
29991
29992
29993
29994 .section "Unset ACL options" "SECID197"
29995 .cindex "&ACL;" "unset options"
29996 The default actions when any of the &%acl_%&&'xxx'& options are unset are not
29997 all the same. &*Note*&: These defaults apply only when the relevant ACL is
29998 not defined at all. For any defined ACL, the default action when control
29999 reaches the end of the ACL statements is &"deny"&.
30000
30001 For &%acl_smtp_quit%& and &%acl_not_smtp_start%& there is no default because
30002 these two are ACLs that are used only for their side effects. They cannot be
30003 used to accept or reject anything.
30004
30005 For &%acl_not_smtp%&, &%acl_smtp_auth%&, &%acl_smtp_connect%&,
30006 &%acl_smtp_data%&, &%acl_smtp_helo%&, &%acl_smtp_mail%&, &%acl_smtp_mailauth%&,
30007 &%acl_smtp_mime%&, &%acl_smtp_predata%&, and &%acl_smtp_starttls%&, the action
30008 when the ACL is not defined is &"accept"&.
30009
30010 For the others (&%acl_smtp_etrn%&, &%acl_smtp_expn%&, &%acl_smtp_rcpt%&, and
30011 &%acl_smtp_vrfy%&), the action when the ACL is not defined is &"deny"&.
30012 This means that &%acl_smtp_rcpt%& must be defined in order to receive any
30013 messages over an SMTP connection. For an example, see the ACL in the default
30014 configuration file.
30015
30016
30017
30018
30019 .section "Data for message ACLs" "SECID198"
30020 .cindex "&ACL;" "data for message ACL"
30021 .vindex &$domain$&
30022 .vindex &$local_part$&
30023 .vindex &$sender_address$&
30024 .vindex &$sender_host_address$&
30025 .vindex &$smtp_command$&
30026 When a MAIL or RCPT ACL, or either of the DATA ACLs, is running, the variables
30027 that contain information about the host and the message's sender (for example,
30028 &$sender_host_address$& and &$sender_address$&) are set, and can be used in ACL
30029 statements. In the case of RCPT (but not MAIL or DATA), &$domain$& and
30030 &$local_part$& are set from the argument address. The entire SMTP command
30031 is available in &$smtp_command$&.
30032
30033 When an ACL for the AUTH parameter of MAIL is running, the variables that
30034 contain information about the host are set, but &$sender_address$& is not yet
30035 set. Section &<<SECTauthparamail>>& contains a discussion of this parameter and
30036 how it is used.
30037
30038 .vindex "&$message_size$&"
30039 The &$message_size$& variable is set to the value of the SIZE parameter on
30040 the MAIL command at MAIL, RCPT and pre-data time, or to -1 if
30041 that parameter is not given. The value is updated to the true message size by
30042 the time the final DATA ACL is run (after the message data has been
30043 received).
30044
30045 .vindex "&$rcpt_count$&"
30046 .vindex "&$recipients_count$&"
30047 The &$rcpt_count$& variable increases by one for each RCPT command received.
30048 The &$recipients_count$& variable increases by one each time a RCPT command is
30049 accepted, so while an ACL for RCPT is being processed, it contains the number
30050 of previously accepted recipients. At DATA time (for both the DATA ACLs),
30051 &$rcpt_count$& contains the total number of RCPT commands, and
30052 &$recipients_count$& contains the total number of accepted recipients.
30053
30054
30055
30056
30057
30058 .section "Data for non-message ACLs" "SECTdatfornon"
30059 .cindex "&ACL;" "data for non-message ACL"
30060 .vindex &$smtp_command_argument$&
30061 .vindex &$smtp_command$&
30062 When an ACL is being run for AUTH, EHLO, ETRN, EXPN, HELO, STARTTLS, or VRFY,
30063 the remainder of the SMTP command line is placed in &$smtp_command_argument$&,
30064 and the entire SMTP command is available in &$smtp_command$&.
30065 These variables can be tested using a &%condition%& condition. For example,
30066 here is an ACL for use with AUTH, which insists that either the session is
30067 encrypted, or the CRAM-MD5 authentication method is used. In other words, it
30068 does not permit authentication methods that use cleartext passwords on
30069 unencrypted connections.
30070 .code
30071 acl_check_auth:
30072   accept encrypted = *
30073   accept condition = ${if eq{${uc:$smtp_command_argument}}\
30074                      {CRAM-MD5}}
30075   deny   message   = TLS encryption or CRAM-MD5 required
30076 .endd
30077 (Another way of applying this restriction is to arrange for the authenticators
30078 that use cleartext passwords not to be advertised when the connection is not
30079 encrypted. You can use the generic &%server_advertise_condition%& authenticator
30080 option to do this.)
30081
30082
30083
30084 .section "Format of an ACL" "SECID199"
30085 .cindex "&ACL;" "format of"
30086 .cindex "&ACL;" "verbs, definition of"
30087 An individual ACL consists of a number of statements. Each statement starts
30088 with a verb, optionally followed by a number of conditions and &"modifiers"&.
30089 Modifiers can change the way the verb operates, define error and log messages,
30090 set variables, insert delays, and vary the processing of accepted messages.
30091
30092 If all the conditions are met, the verb is obeyed. The same condition may be
30093 used (with different arguments) more than once in the same statement. This
30094 provides a means of specifying an &"and"& conjunction between conditions. For
30095 example:
30096 .code
30097 deny  dnslists = list1.example
30098       dnslists = list2.example
30099 .endd
30100 If there are no conditions, the verb is always obeyed. Exim stops evaluating
30101 the conditions and modifiers when it reaches a condition that fails. What
30102 happens then depends on the verb (and in one case, on a special modifier). Not
30103 all the conditions make sense at every testing point. For example, you cannot
30104 test a sender address in the ACL that is run for a VRFY command.
30105
30106
30107 .section "ACL verbs" "SECID200"
30108 The ACL verbs are as follows:
30109
30110 .ilist
30111 .cindex "&%accept%& ACL verb"
30112 &%accept%&: If all the conditions are met, the ACL returns &"accept"&. If any
30113 of the conditions are not met, what happens depends on whether &%endpass%&
30114 appears among the conditions (for syntax see below). If the failing condition
30115 is before &%endpass%&, control is passed to the next ACL statement; if it is
30116 after &%endpass%&, the ACL returns &"deny"&. Consider this statement, used to
30117 check a RCPT command:
30118 .code
30119 accept domains = +local_domains
30120        endpass
30121        verify = recipient
30122 .endd
30123 If the recipient domain does not match the &%domains%& condition, control
30124 passes to the next statement. If it does match, the recipient is verified, and
30125 the command is accepted if verification succeeds. However, if verification
30126 fails, the ACL yields &"deny"&, because the failing condition is after
30127 &%endpass%&.
30128
30129 The &%endpass%& feature has turned out to be confusing to many people, so its
30130 use is not recommended nowadays. It is always possible to rewrite an ACL so
30131 that &%endpass%& is not needed, and it is no longer used in the default
30132 configuration.
30133
30134 .cindex "&%message%& ACL modifier" "with &%accept%&"
30135 If a &%message%& modifier appears on an &%accept%& statement, its action
30136 depends on whether or not &%endpass%& is present. In the absence of &%endpass%&
30137 (when an &%accept%& verb either accepts or passes control to the next
30138 statement), &%message%& can be used to vary the message that is sent when an
30139 SMTP command is accepted. For example, in a RCPT ACL you could have:
30140 .display
30141 &`accept  `&<&'some conditions'&>
30142 &`        message = OK, I will allow you through today`&
30143 .endd
30144 You can specify an SMTP response code, optionally followed by an &"extended
30145 response code"& at the start of the message, but the first digit must be the
30146 same as would be sent by default, which is 2 for an &%accept%& verb.
30147
30148 If &%endpass%& is present in an &%accept%& statement, &%message%& specifies
30149 an error message that is used when access is denied. This behaviour is retained
30150 for backward compatibility, but current &"best practice"& is to avoid the use
30151 of &%endpass%&.
30152
30153
30154 .next
30155 .cindex "&%defer%& ACL verb"
30156 &%defer%&: If all the conditions are true, the ACL returns &"defer"& which, in
30157 an SMTP session, causes a 4&'xx'& response to be given. For a non-SMTP ACL,
30158 &%defer%& is the same as &%deny%&, because there is no way of sending a
30159 temporary error. For a RCPT command, &%defer%& is much the same as using a
30160 &(redirect)& router and &`:defer:`& while verifying, but the &%defer%& verb can
30161 be used in any ACL, and even for a recipient it might be a simpler approach.
30162
30163
30164 .next
30165 .cindex "&%deny%& ACL verb"
30166 &%deny%&: If all the conditions are met, the ACL returns &"deny"&. If any of
30167 the conditions are not met, control is passed to the next ACL statement. For
30168 example,
30169 .code
30170 deny dnslists = blackholes.mail-abuse.org
30171 .endd
30172 rejects commands from hosts that are on a DNS black list.
30173
30174
30175 .next
30176 .cindex "&%discard%& ACL verb"
30177 &%discard%&: This verb behaves like &%accept%&, except that it returns
30178 &"discard"& from the ACL instead of &"accept"&. It is permitted only on ACLs
30179 that are concerned with receiving messages. When all the conditions are true,
30180 the sending entity receives a &"success"& response. However, &%discard%& causes
30181 recipients to be discarded. If it is used in an ACL for RCPT, just the one
30182 recipient is discarded; if used for MAIL, DATA or in the non-SMTP ACL, all the
30183 message's recipients are discarded. Recipients that are discarded before DATA
30184 do not appear in the log line when the &%received_recipients%& log selector is set.
30185
30186 If the &%log_message%& modifier is set when &%discard%& operates,
30187 its contents are added to the line that is automatically written to the log.
30188 The &%message%& modifier operates exactly as it does for &%accept%&.
30189
30190
30191 .next
30192 .cindex "&%drop%& ACL verb"
30193 &%drop%&: This verb behaves like &%deny%&, except that an SMTP connection is
30194 forcibly closed after the 5&'xx'& error message has been sent. For example:
30195 .code
30196 drop   message   = I don't take more than 20 RCPTs
30197        condition = ${if > {$rcpt_count}{20}}
30198 .endd
30199 There is no difference between &%deny%& and &%drop%& for the connect-time ACL.
30200 The connection is always dropped after sending a 550 response.
30201
30202 .next
30203 .cindex "&%require%& ACL verb"
30204 &%require%&: If all the conditions are met, control is passed to the next ACL
30205 statement. If any of the conditions are not met, the ACL returns &"deny"&. For
30206 example, when checking a RCPT command,
30207 .code
30208 require message = Sender did not verify
30209         verify  = sender
30210 .endd
30211 passes control to subsequent statements only if the message's sender can be
30212 verified. Otherwise, it rejects the command. Note the positioning of the
30213 &%message%& modifier, before the &%verify%& condition. The reason for this is
30214 discussed in section &<<SECTcondmodproc>>&.
30215
30216 .next
30217 .cindex "&%warn%& ACL verb"
30218 &%warn%&: If all the conditions are true, a line specified by the
30219 &%log_message%& modifier is written to Exim's main log. Control always passes
30220 to the next ACL statement. If any condition is false, the log line is not
30221 written. If an identical log line is requested several times in the same
30222 message, only one copy is actually written to the log. If you want to force
30223 duplicates to be written, use the &%logwrite%& modifier instead.
30224
30225 If &%log_message%& is not present, a &%warn%& verb just checks its conditions
30226 and obeys any &"immediate"& modifiers (such as &%control%&, &%set%&,
30227 &%logwrite%&, &%add_header%&, and &%remove_header%&) that appear before the
30228 first failing condition. There is more about adding header lines in section
30229 &<<SECTaddheadacl>>&.
30230
30231 If any condition on a &%warn%& statement cannot be completed (that is, there is
30232 some sort of defer), the log line specified by &%log_message%& is not written.
30233 This does not include the case of a forced failure from a lookup, which
30234 is considered to be a successful completion. After a defer, no further
30235 conditions or modifiers in the &%warn%& statement are processed. The incident
30236 is logged, and the ACL continues to be processed, from the next statement
30237 onwards.
30238
30239
30240 .vindex "&$acl_verify_message$&"
30241 When one of the &%warn%& conditions is an address verification that fails, the
30242 text of the verification failure message is in &$acl_verify_message$&. If you
30243 want this logged, you must set it up explicitly. For example:
30244 .code
30245 warn   !verify = sender
30246        log_message = sender verify failed: $acl_verify_message
30247 .endd
30248 .endlist
30249
30250 At the end of each ACL there is an implicit unconditional &%deny%&.
30251
30252 As you can see from the examples above, the conditions and modifiers are
30253 written one to a line, with the first one on the same line as the verb, and
30254 subsequent ones on following lines. If you have a very long condition, you can
30255 continue it onto several physical lines by the usual backslash continuation
30256 mechanism. It is conventional to align the conditions vertically.
30257
30258
30259
30260 .section "ACL variables" "SECTaclvariables"
30261 .cindex "&ACL;" "variables"
30262 There are some special variables that can be set during ACL processing. They
30263 can be used to pass information between different ACLs, different invocations
30264 of the same ACL in the same SMTP connection, and between ACLs and the routers,
30265 transports, and filters that are used to deliver a message. The names of these
30266 variables must begin with &$acl_c$& or &$acl_m$&, followed either by a digit or
30267 an underscore, but the remainder of the name can be any sequence of
30268 alphanumeric characters and underscores that you choose. There is no limit on
30269 the number of ACL variables. The two sets act as follows:
30270 .ilist
30271 The values of those variables whose names begin with &$acl_c$& persist
30272 throughout an SMTP connection. They are never reset. Thus, a value that is set
30273 while receiving one message is still available when receiving the next message
30274 on the same SMTP connection.
30275 .next
30276 The values of those variables whose names begin with &$acl_m$& persist only
30277 while a message is being received. They are reset afterwards. They are also
30278 reset by MAIL, RSET, EHLO, HELO, and after starting up a TLS session.
30279 .endlist
30280
30281 When a message is accepted, the current values of all the ACL variables are
30282 preserved with the message and are subsequently made available at delivery
30283 time. The ACL variables are set by a modifier called &%set%&. For example:
30284 .code
30285 accept hosts = whatever
30286        set acl_m4 = some value
30287 accept authenticated = *
30288        set acl_c_auth = yes
30289 .endd
30290 &*Note*&: A leading dollar sign is not used when naming a variable that is to
30291 be set. If you want to set a variable without taking any action, you can use a
30292 &%warn%& verb without any other modifiers or conditions.
30293
30294 .oindex &%strict_acl_vars%&
30295 What happens if a syntactically valid but undefined ACL variable is
30296 referenced depends on the setting of the &%strict_acl_vars%& option. If it is
30297 false (the default), an empty string is substituted; if it is true, an
30298 error is generated.
30299
30300 Versions of Exim before 4.64 have a limited set of numbered variables, but
30301 their names are compatible, so there is no problem with upgrading.
30302
30303
30304 .section "Condition and modifier processing" "SECTcondmodproc"
30305 .cindex "&ACL;" "conditions; processing"
30306 .cindex "&ACL;" "modifiers; processing"
30307 An exclamation mark preceding a condition negates its result. For example:
30308 .code
30309 deny   domains = *.dom.example
30310       !verify  = recipient
30311 .endd
30312 causes the ACL to return &"deny"& if the recipient domain ends in
30313 &'dom.example'& and the recipient address cannot be verified. Sometimes
30314 negation can be used on the right-hand side of a condition. For example, these
30315 two statements are equivalent:
30316 .code
30317 deny  hosts = !192.168.3.4
30318 deny !hosts =  192.168.3.4
30319 .endd
30320 However, for many conditions (&%verify%& being a good example), only left-hand
30321 side negation of the whole condition is possible.
30322
30323 The arguments of conditions and modifiers are expanded. A forced failure
30324 of an expansion causes a condition to be ignored, that is, it behaves as if the
30325 condition is true. Consider these two statements:
30326 .code
30327 accept  senders = ${lookup{$host_name}lsearch\
30328                   {/some/file}{$value}fail}
30329 accept  senders = ${lookup{$host_name}lsearch\
30330                   {/some/file}{$value}{}}
30331 .endd
30332 Each attempts to look up a list of acceptable senders. If the lookup succeeds,
30333 the returned list is searched, but if the lookup fails the behaviour is
30334 different in the two cases. The &%fail%& in the first statement causes the
30335 condition to be ignored, leaving no further conditions. The &%accept%& verb
30336 therefore succeeds. The second statement, however, generates an empty list when
30337 the lookup fails. No sender can match an empty list, so the condition fails,
30338 and therefore the &%accept%& also fails.
30339
30340 ACL modifiers appear mixed in with conditions in ACL statements. Some of them
30341 specify actions that are taken as the conditions for a statement are checked;
30342 others specify text for messages that are used when access is denied or a
30343 warning is generated. The &%control%& modifier affects the way an incoming
30344 message is handled.
30345
30346 The positioning of the modifiers in an ACL statement is important, because the
30347 processing of a verb ceases as soon as its outcome is known. Only those
30348 modifiers that have already been encountered will take effect. For example,
30349 consider this use of the &%message%& modifier:
30350 .code
30351 require message = Can't verify sender
30352         verify  = sender
30353         message = Can't verify recipient
30354         verify  = recipient
30355         message = This message cannot be used
30356 .endd
30357 If sender verification fails, Exim knows that the result of the statement is
30358 &"deny"&, so it goes no further. The first &%message%& modifier has been seen,
30359 so its text is used as the error message. If sender verification succeeds, but
30360 recipient verification fails, the second message is used. If recipient
30361 verification succeeds, the third message becomes &"current"&, but is never used
30362 because there are no more conditions to cause failure.
30363
30364 For the &%deny%& verb, on the other hand, it is always the last &%message%&
30365 modifier that is used, because all the conditions must be true for rejection to
30366 happen. Specifying more than one &%message%& modifier does not make sense, and
30367 the message can even be specified after all the conditions. For example:
30368 .code
30369 deny   hosts = ...
30370       !senders = *@my.domain.example
30371        message = Invalid sender from client host
30372 .endd
30373 The &"deny"& result does not happen until the end of the statement is reached,
30374 by which time Exim has set up the message.
30375
30376
30377
30378 .section "ACL modifiers" "SECTACLmodi"
30379 .cindex "&ACL;" "modifiers; list of"
30380 The ACL modifiers are as follows:
30381
30382 .vlist
30383 .vitem &*add_header*&&~=&~<&'text'&>
30384 This modifier specifies one or more header lines that are to be added to an
30385 incoming message, assuming, of course, that the message is ultimately
30386 accepted. For details, see section &<<SECTaddheadacl>>&.
30387
30388 .vitem &*continue*&&~=&~<&'text'&>
30389 .cindex "&%continue%& ACL modifier"
30390 .cindex "database" "updating in ACL"
30391 This modifier does nothing of itself, and processing of the ACL always
30392 continues with the next condition or modifier. The value of &%continue%& is in
30393 the side effects of expanding its argument. Typically this could be used to
30394 update a database. It is really just a syntactic tidiness, to avoid having to
30395 write rather ugly lines like this:
30396 .display
30397 &`condition = ${if eq{0}{`&<&'some expansion'&>&`}{true}{true}}`&
30398 .endd
30399 Instead, all you need is
30400 .display
30401 &`continue = `&<&'some expansion'&>
30402 .endd
30403
30404 .vitem &*control*&&~=&~<&'text'&>
30405 .cindex "&%control%& ACL modifier"
30406 This modifier affects the subsequent processing of the SMTP connection or of an
30407 incoming message that is accepted. The effect of the first type of control
30408 lasts for the duration of the connection, whereas the effect of the second type
30409 lasts only until the current message has been received. The message-specific
30410 controls always apply to the whole message, not to individual recipients,
30411 even if the &%control%& modifier appears in a RCPT ACL.
30412
30413 As there are now quite a few controls that can be applied, they are described
30414 separately in section &<<SECTcontrols>>&. The &%control%& modifier can be used
30415 in several different ways. For example:
30416
30417 . ==== As this is a nested list, any displays it contains must be indented
30418 . ==== as otherwise they are too far to the left. That comment applies only
30419 . ==== when xmlto and fop are used; formatting with sdop gets it right either
30420 . ==== way.
30421
30422 .ilist
30423 It can be at the end of an &%accept%& statement:
30424 .code
30425     accept  ...some conditions
30426             control = queue
30427 .endd
30428 In this case, the control is applied when this statement yields &"accept"&, in
30429 other words, when the conditions are all true.
30430
30431 .next
30432 It can be in the middle of an &%accept%& statement:
30433 .code
30434     accept  ...some conditions...
30435             control = queue
30436             ...some more conditions...
30437 .endd
30438 If the first set of conditions are true, the control is applied, even if the
30439 statement does not accept because one of the second set of conditions is false.
30440 In this case, some subsequent statement must yield &"accept"& for the control
30441 to be relevant.
30442
30443 .next
30444 It can be used with &%warn%& to apply the control, leaving the
30445 decision about accepting or denying to a subsequent verb. For
30446 example:
30447 .code
30448     warn    ...some conditions...
30449             control = freeze
30450     accept  ...
30451 .endd
30452 This example of &%warn%& does not contain &%message%&, &%log_message%&, or
30453 &%logwrite%&, so it does not add anything to the message and does not write a
30454 log entry.
30455
30456 .next
30457 If you want to apply a control unconditionally, you can use it with a
30458 &%require%& verb. For example:
30459 .code
30460     require  control = no_multiline_responses
30461 .endd
30462 .endlist
30463
30464 .vitem &*delay*&&~=&~<&'time'&>
30465 .cindex "&%delay%& ACL modifier"
30466 .oindex "&%-bh%&"
30467 This modifier may appear in any ACL except notquit. It causes Exim to wait for
30468 the time interval before proceeding. However, when testing Exim using the
30469 &%-bh%& option, the delay is not actually imposed (an appropriate message is
30470 output instead). The time is given in the usual Exim notation, and the delay
30471 happens as soon as the modifier is processed. In an SMTP session, pending
30472 output is flushed before the delay is imposed.
30473
30474 Like &%control%&, &%delay%& can be used with &%accept%& or &%deny%&, for
30475 example:
30476 .code
30477 deny    ...some conditions...
30478         delay = 30s
30479 .endd
30480 The delay happens if all the conditions are true, before the statement returns
30481 &"deny"&. Compare this with:
30482 .code
30483 deny    delay = 30s
30484         ...some conditions...
30485 .endd
30486 which waits for 30s before processing the conditions. The &%delay%& modifier
30487 can also be used with &%warn%& and together with &%control%&:
30488 .code
30489 warn    ...some conditions...
30490         delay = 2m
30491         control = freeze
30492 accept  ...
30493 .endd
30494
30495 If &%delay%& is encountered when the SMTP PIPELINING extension is in use,
30496 responses to several commands are no longer buffered and sent in one packet (as
30497 they would normally be) because all output is flushed before imposing the
30498 delay. This optimization is disabled so that a number of small delays do not
30499 appear to the client as one large aggregated delay that might provoke an
30500 unwanted timeout. You can, however, disable output flushing for &%delay%& by
30501 using a &%control%& modifier to set &%no_delay_flush%&.
30502
30503
30504 .vitem &*endpass*&
30505 .cindex "&%endpass%& ACL modifier"
30506 This modifier, which has no argument, is recognized only in &%accept%& and
30507 &%discard%& statements. It marks the boundary between the conditions whose
30508 failure causes control to pass to the next statement, and the conditions whose
30509 failure causes the ACL to return &"deny"&. This concept has proved to be
30510 confusing to some people, so the use of &%endpass%& is no longer recommended as
30511 &"best practice"&. See the description of &%accept%& above for more details.
30512
30513
30514 .vitem &*log_message*&&~=&~<&'text'&>
30515 .cindex "&%log_message%& ACL modifier"
30516 This modifier sets up a message that is used as part of the log message if the
30517 ACL denies access or a &%warn%& statement's conditions are true. For example:
30518 .code
30519 require log_message = wrong cipher suite $tls_in_cipher
30520         encrypted   = DES-CBC3-SHA
30521 .endd
30522 &%log_message%& is also used when recipients are discarded by &%discard%&. For
30523 example:
30524 .display
30525 &`discard `&<&'some conditions'&>
30526 &`        log_message = Discarded $local_part@$domain because...`&
30527 .endd
30528 When access is denied, &%log_message%& adds to any underlying error message
30529 that may exist because of a condition failure. For example, while verifying a
30530 recipient address, a &':fail:'& redirection might have already set up a
30531 message.
30532
30533 The message may be defined before the conditions to which it applies, because
30534 the string expansion does not happen until Exim decides that access is to be
30535 denied. This means that any variables that are set by the condition are
30536 available for inclusion in the message. For example, the &$dnslist_$&<&'xxx'&>
30537 variables are set after a DNS black list lookup succeeds. If the expansion of
30538 &%log_message%& fails, or if the result is an empty string, the modifier is
30539 ignored.
30540
30541 .vindex "&$acl_verify_message$&"
30542 If you want to use a &%warn%& statement to log the result of an address
30543 verification, you can use &$acl_verify_message$& to include the verification
30544 error message.
30545
30546 If &%log_message%& is used with a &%warn%& statement, &"Warning:"& is added to
30547 the start of the logged message. If the same warning log message is requested
30548 more than once while receiving  a single email message, only one copy is
30549 actually logged. If you want to log multiple copies, use &%logwrite%& instead
30550 of &%log_message%&. In the absence of &%log_message%& and &%logwrite%&, nothing
30551 is logged for a successful &%warn%& statement.
30552
30553 If &%log_message%& is not present and there is no underlying error message (for
30554 example, from the failure of address verification), but &%message%& is present,
30555 the &%message%& text is used for logging rejections. However, if any text for
30556 logging contains newlines, only the first line is logged. In the absence of
30557 both &%log_message%& and &%message%&, a default built-in message is used for
30558 logging rejections.
30559
30560
30561 .vitem "&*log_reject_target*&&~=&~<&'log name list'&>"
30562 .cindex "&%log_reject_target%& ACL modifier"
30563 .cindex "logging in ACL" "specifying which log"
30564 This modifier makes it possible to specify which logs are used for messages
30565 about ACL rejections. Its argument is a colon-separated list of words that can
30566 be &"main"&, &"reject"&, or &"panic"&. The default is &`main:reject`&. The list
30567 may be empty, in which case a rejection is not logged at all. For example, this
30568 ACL fragment writes no logging information when access is denied:
30569 .display
30570 &`deny `&<&'some conditions'&>
30571 &`     log_reject_target =`&
30572 .endd
30573 This modifier can be used in SMTP and non-SMTP ACLs. It applies to both
30574 permanent and temporary rejections. Its effect lasts for the rest of the
30575 current ACL.
30576
30577
30578 .vitem &*logwrite*&&~=&~<&'text'&>
30579 .cindex "&%logwrite%& ACL modifier"
30580 .cindex "logging in ACL" "immediate"
30581 This modifier writes a message to a log file as soon as it is encountered when
30582 processing an ACL. (Compare &%log_message%&, which, except in the case of
30583 &%warn%& and &%discard%&, is used only if the ACL statement denies
30584 access.) The &%logwrite%& modifier can be used to log special incidents in
30585 ACLs. For example:
30586 .display
30587 &`accept `&<&'some special conditions'&>
30588 &`       control  = freeze`&
30589 &`       logwrite = froze message because ...`&
30590 .endd
30591 By default, the message is written to the main log. However, it may begin
30592 with a colon, followed by a comma-separated list of log names, and then
30593 another colon, to specify exactly which logs are to be written. For
30594 example:
30595 .code
30596 logwrite = :main,reject: text for main and reject logs
30597 logwrite = :panic: text for panic log only
30598 .endd
30599
30600
30601 .vitem &*message*&&~=&~<&'text'&>
30602 .cindex "&%message%& ACL modifier"
30603 This modifier sets up a text string that is expanded and used as a response
30604 message when an ACL statement terminates the ACL with an &"accept"&, &"deny"&,
30605 or &"defer"& response. (In the case of the &%accept%& and &%discard%& verbs,
30606 there is some complication if &%endpass%& is involved; see the description of
30607 &%accept%& for details.)
30608
30609 The expansion of the message happens at the time Exim decides that the ACL is
30610 to end, not at the time it processes &%message%&. If the expansion fails, or
30611 generates an empty string, the modifier is ignored. Here is an example where
30612 &%message%& must be specified first, because the ACL ends with a rejection if
30613 the &%hosts%& condition fails:
30614 .code
30615 require  message = Host not recognized
30616          hosts = 10.0.0.0/8
30617 .endd
30618 (Once a condition has failed, no further conditions or modifiers are
30619 processed.)
30620
30621 .cindex "SMTP" "error codes"
30622 .oindex "&%smtp_banner%&
30623 For ACLs that are triggered by SMTP commands, the message is returned as part
30624 of the SMTP response. The use of &%message%& with &%accept%& (or &%discard%&)
30625 is meaningful only for SMTP, as no message is returned when a non-SMTP message
30626 is accepted. In the case of the connect ACL, accepting with a message modifier
30627 overrides the value of &%smtp_banner%&. For the EHLO/HELO ACL, a customized
30628 accept message may not contain more than one line (otherwise it will be
30629 truncated at the first newline and a panic logged), and it cannot affect the
30630 EHLO options.
30631
30632 When SMTP is involved, the message may begin with an overriding response code,
30633 consisting of three digits optionally followed by an &"extended response code"&
30634 of the form &'n.n.n'&, each code being followed by a space. For example:
30635 .code
30636 deny  message = 599 1.2.3 Host not welcome
30637       hosts = 192.168.34.0/24
30638 .endd
30639 The first digit of the supplied response code must be the same as would be sent
30640 by default. A panic occurs if it is not. Exim uses a 550 code when it denies
30641 access, but for the predata ACL, note that the default success code is 354, not
30642 2&'xx'&.
30643
30644 Notwithstanding the previous paragraph, for the QUIT ACL, unlike the others,
30645 the message modifier cannot override the 221 response code.
30646
30647 The text in a &%message%& modifier is literal; any quotes are taken as
30648 literals, but because the string is expanded, backslash escapes are processed
30649 anyway. If the message contains newlines, this gives rise to a multi-line SMTP
30650 response.
30651
30652 .vindex "&$acl_verify_message$&"
30653 For ACLs that are called by an &%acl =%& ACL condition, the message is
30654 stored in &$acl_verify_message$&, from which the calling ACL may use it.
30655
30656 If &%message%& is used on a statement that verifies an address, the message
30657 specified overrides any message that is generated by the verification process.
30658 However, the original message is available in the variable
30659 &$acl_verify_message$&, so you can incorporate it into your message if you
30660 wish. In particular, if you want the text from &%:fail:%& items in &(redirect)&
30661 routers to be passed back as part of the SMTP response, you should either not
30662 use a &%message%& modifier, or make use of &$acl_verify_message$&.
30663
30664 For compatibility with previous releases of Exim, a &%message%& modifier that
30665 is used with a &%warn%& verb behaves in a similar way to the &%add_header%&
30666 modifier, but this usage is now deprecated. However, &%message%& acts only when
30667 all the conditions are true, wherever it appears in an ACL command, whereas
30668 &%add_header%& acts as soon as it is encountered. If &%message%& is used with
30669 &%warn%& in an ACL that is not concerned with receiving a message, it has no
30670 effect.
30671
30672
30673 .vitem &*queue*&&~=&~<&'text'&>
30674 .cindex "&%queue%& ACL modifier"
30675 .cindex "named queues" "selecting in ACL"
30676 This modifier specifies the use of a named queue for spool files
30677 for the message.
30678 It can only be used before the message is received (i.e. not in
30679 the DATA ACL).
30680 This could be used, for example, for known high-volume burst sources
30681 of traffic, or for quarantine of messages.
30682 Separate queue-runner processes will be needed for named queues.
30683 If the text after expansion is empty, the default queue is used.
30684
30685
30686 .vitem &*remove_header*&&~=&~<&'text'&>
30687 This modifier specifies one or more header names in a colon-separated list
30688  that are to be removed from an incoming message, assuming, of course, that
30689 the message is ultimately accepted. For details, see section &<<SECTremoveheadacl>>&.
30690
30691
30692 .vitem &*set*&&~<&'acl_name'&>&~=&~<&'value'&>
30693 .cindex "&%set%& ACL modifier"
30694 This modifier puts a value into one of the ACL variables (see section
30695 &<<SECTaclvariables>>&).
30696
30697
30698 .vitem &*udpsend*&&~=&~<&'parameters'&>
30699 .cindex "UDP communications"
30700 This modifier sends a UDP packet, for purposes such as statistics
30701 collection or behaviour monitoring. The parameters are expanded, and
30702 the result of the expansion must be a colon-separated list consisting
30703 of a destination server, port number, and the packet contents. The
30704 server can be specified as a host name or IPv4 or IPv6 address. The
30705 separator can be changed with the usual angle bracket syntax. For
30706 example, you might want to collect information on which hosts connect
30707 when:
30708 .code
30709 udpsend = <; 2001:dB8::dead:beef ; 1234 ;\
30710              $tod_zulu $sender_host_address
30711 .endd
30712 .endlist
30713
30714
30715
30716
30717 .section "Use of the control modifier" "SECTcontrols"
30718 .cindex "&%control%& ACL modifier"
30719 The &%control%& modifier supports the following settings:
30720
30721 .vlist
30722 .vitem &*control&~=&~allow_auth_unadvertised*&
30723 This modifier allows a client host to use the SMTP AUTH command even when it
30724 has not been advertised in response to EHLO. Furthermore, because there are
30725 apparently some really broken clients that do this, Exim will accept AUTH after
30726 HELO (rather than EHLO) when this control is set. It should be used only if you
30727 really need it, and you should limit its use to those broken clients that do
30728 not work without it. For example:
30729 .code
30730 warn hosts   = 192.168.34.25
30731      control = allow_auth_unadvertised
30732 .endd
30733 Normally, when an Exim server receives an AUTH command, it checks the name of
30734 the authentication mechanism that is given in the command to ensure that it
30735 matches an advertised mechanism. When this control is set, the check that a
30736 mechanism has been advertised is bypassed. Any configured mechanism can be used
30737 by the client. This control is permitted only in the connection and HELO ACLs.
30738
30739
30740 .vitem &*control&~=&~caseful_local_part*& &&&
30741        &*control&~=&~caselower_local_part*&
30742 .cindex "&ACL;" "case of local part in"
30743 .cindex "case of local parts"
30744 .vindex "&$local_part$&"
30745 These two controls are permitted only in the ACL specified by &%acl_smtp_rcpt%&
30746 (that is, during RCPT processing). By default, the contents of &$local_part$&
30747 are lower cased before ACL processing. If &"caseful_local_part"& is specified,
30748 any uppercase letters in the original local part are restored in &$local_part$&
30749 for the rest of the ACL, or until a control that sets &"caselower_local_part"&
30750 is encountered.
30751
30752 These controls affect only the current recipient. Moreover, they apply only to
30753 local part handling that takes place directly in the ACL (for example, as a key
30754 in lookups). If a test to verify the recipient is obeyed, the case-related
30755 handling of the local part during the verification is controlled by the router
30756 configuration (see the &%caseful_local_part%& generic router option).
30757
30758 This facility could be used, for example, to add a spam score to local parts
30759 containing upper case letters. For example, using &$acl_m4$& to accumulate the
30760 spam score:
30761 .code
30762 warn  control = caseful_local_part
30763       set acl_m4 = ${eval:\
30764                      $acl_m4 + \
30765                      ${if match{$local_part}{[A-Z]}{1}{0}}\
30766                     }
30767       control = caselower_local_part
30768 .endd
30769 Notice that we put back the lower cased version afterwards, assuming that
30770 is what is wanted for subsequent tests.
30771
30772
30773 .vitem &*control&~=&~cutthrough_delivery/*&<&'options'&>
30774 .cindex "&ACL;" "cutthrough routing"
30775 .cindex "cutthrough" "requesting"
30776 This option requests delivery be attempted while the item is being received.
30777
30778 The option is usable in the RCPT ACL.
30779 If enabled for a message received via smtp and routed to an smtp transport,
30780 and only one transport, interface, destination host and port combination
30781 is used for all recipients of the message,
30782 then the delivery connection is made while the receiving connection is open
30783 and data is copied from one to the other.
30784
30785 An attempt to set this option for any recipient but the first
30786 for a mail will be quietly ignored.
30787 If a recipient-verify callout
30788 (with use_sender)
30789 connection is subsequently
30790 requested in the same ACL it is held open and used for
30791 any subsequent recipients and the data,
30792 otherwise one is made after the initial RCPT ACL completes.
30793
30794 Note that routers are used in verify mode,
30795 and cannot depend on content of received headers.
30796 Note also that headers cannot be
30797 modified by any of the post-data ACLs (DATA, MIME and DKIM).
30798 Headers may be modified by routers (subject to the above) and transports.
30799 The &'Received-By:'& header is generated as soon as the body reception starts,
30800 rather than the traditional time after the full message is received;
30801 this will affect the timestamp.
30802
30803 All the usual ACLs are called; if one results in the message being
30804 rejected, all effort spent in delivery (including the costs on
30805 the ultimate destination) will be wasted.
30806 Note that in the case of data-time ACLs this includes the entire
30807 message body.
30808
30809 Cutthrough delivery is not supported via transport-filters or when DKIM signing
30810 of outgoing messages is done, because it sends data to the ultimate destination
30811 before the entire message has been received from the source.
30812 It is not supported for messages received with the SMTP PRDR
30813 or CHUNKING
30814 options in use.
30815
30816 Should the ultimate destination system positively accept or reject the mail,
30817 a corresponding indication is given to the source system and nothing is queued.
30818 If the item is successfully delivered in cutthrough mode
30819 the delivery log lines are tagged with ">>" rather than "=>" and appear
30820 before the acceptance "<=" line.
30821
30822 If there is a temporary error the item is queued for later delivery in the
30823 usual fashion.
30824 This behaviour can be adjusted by appending the option &*defer=*&<&'value'&>
30825 to the control; the default value is &"spool"& and the alternate value
30826 &"pass"& copies an SMTP defer response from the target back to the initiator
30827 and does not queue the message.
30828 Note that this is independent of any recipient verify conditions in the ACL.
30829
30830 Delivery in this mode avoids the generation of a bounce mail to a
30831 (possibly faked)
30832 sender when the destination system is doing content-scan based rejection.
30833
30834
30835 .vitem &*control&~=&~debug/*&<&'options'&>
30836 .cindex "&ACL;" "enabling debug logging"
30837 .cindex "debugging" "enabling from an ACL"
30838 This control turns on debug logging, almost as though Exim had been invoked
30839 with &`-d`&, with the output going to a new logfile in the usual logs directory,
30840 by default called &'debuglog'&.
30841 The filename can be adjusted with the &'tag'& option, which
30842 may access any variables already defined.  The logging may be adjusted with
30843 the &'opts'& option, which takes the same values as the &`-d`& command-line
30844 option.
30845 Logging started this way may be stopped, and the file removed,
30846 with the &'kill'& option.
30847 Some examples (which depend on variables that don't exist in all
30848 contexts):
30849 .code
30850       control = debug
30851       control = debug/tag=.$sender_host_address
30852       control = debug/opts=+expand+acl
30853       control = debug/tag=.$message_exim_id/opts=+expand
30854       control = debug/kill
30855 .endd
30856
30857
30858 .vitem &*control&~=&~dkim_disable_verify*&
30859 .cindex "disable DKIM verify"
30860 .cindex "DKIM" "disable verify"
30861 This control turns off DKIM verification processing entirely.  For details on
30862 the operation and configuration of DKIM, see section &<<SECDKIM>>&.
30863
30864
30865 .vitem &*control&~=&~dmarc_disable_verify*&
30866 .cindex "disable DMARC verify"
30867 .cindex "DMARC" "disable verify"
30868 This control turns off DMARC verification processing entirely.  For details on
30869 the operation and configuration of DMARC, see section &<<SECDMARC>>&.
30870
30871
30872 .vitem &*control&~=&~dscp/*&<&'value'&>
30873 .cindex "&ACL;" "setting DSCP value"
30874 .cindex "DSCP" "inbound"
30875 This option causes the DSCP value associated with the socket for the inbound
30876 connection to be adjusted to a given value, given as one of a number of fixed
30877 strings or to numeric value.
30878 The &%-bI:dscp%& option may be used to ask Exim which names it knows of.
30879 Common values include &`throughput`&, &`mincost`&, and on newer systems
30880 &`ef`&, &`af41`&, etc.  Numeric values may be in the range 0 to 0x3F.
30881
30882 The outbound packets from Exim will be marked with this value in the header
30883 (for IPv4, the TOS field; for IPv6, the TCLASS field); there is no guarantee
30884 that these values will have any effect, not be stripped by networking
30885 equipment, or do much of anything without cooperation with your Network
30886 Engineer and those of all network operators between the source and destination.
30887
30888
30889 .vitem &*control&~=&~enforce_sync*& &&&
30890        &*control&~=&~no_enforce_sync*&
30891 .cindex "SMTP" "synchronization checking"
30892 .cindex "synchronization checking in SMTP"
30893 These controls make it possible to be selective about when SMTP synchronization
30894 is enforced. The global option &%smtp_enforce_sync%& specifies the initial
30895 state of the switch (it is true by default). See the description of this option
30896 in chapter &<<CHAPmainconfig>>& for details of SMTP synchronization checking.
30897
30898 The effect of these two controls lasts for the remainder of the SMTP
30899 connection. They can appear in any ACL except the one for the non-SMTP
30900 messages. The most straightforward place to put them is in the ACL defined by
30901 &%acl_smtp_connect%&, which is run at the start of an incoming SMTP connection,
30902 before the first synchronization check. The expected use is to turn off the
30903 synchronization checks for badly-behaved hosts that you nevertheless need to
30904 work with.
30905
30906
30907 .vitem &*control&~=&~fakedefer/*&<&'message'&>
30908 .cindex "fake defer"
30909 .cindex "defer, fake"
30910 This control works in exactly the same way as &%fakereject%& (described below)
30911 except that it causes an SMTP 450 response after the message data instead of a
30912 550 response. You must take care when using &%fakedefer%& because it causes the
30913 messages to be duplicated when the sender retries. Therefore, you should not
30914 use &%fakedefer%& if the message is to be delivered normally.
30915
30916 .vitem &*control&~=&~fakereject/*&<&'message'&>
30917 .cindex "fake rejection"
30918 .cindex "rejection, fake"
30919 This control is permitted only for the MAIL, RCPT, and DATA ACLs, in other
30920 words, only when an SMTP message is being received. If Exim accepts the
30921 message, instead the final 250 response, a 550 rejection message is sent.
30922 However, Exim proceeds to deliver the message as normal. The control applies
30923 only to the current message, not to any subsequent ones that may be received in
30924 the same SMTP connection.
30925
30926 The text for the 550 response is taken from the &%control%& modifier. If no
30927 message is supplied, the following is used:
30928 .code
30929 550-Your message has been rejected but is being
30930 550-kept for evaluation.
30931 550-If it was a legitimate message, it may still be
30932 550 delivered to the target recipient(s).
30933 .endd
30934 This facility should be used with extreme caution.
30935
30936 .vitem &*control&~=&~freeze*&
30937 .cindex "frozen messages" "forcing in ACL"
30938 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
30939 other words, only when a message is being received. If the message is accepted,
30940 it is placed on Exim's queue and frozen. The control applies only to the
30941 current message, not to any subsequent ones that may be received in the same
30942 SMTP connection.
30943
30944 This modifier can optionally be followed by &`/no_tell`&. If the global option
30945 &%freeze_tell%& is set, it is ignored for the current message (that is, nobody
30946 is told about the freezing), provided all the &*control=freeze*& modifiers that
30947 are obeyed for the current message have the &`/no_tell`& option.
30948
30949 .vitem &*control&~=&~no_delay_flush*&
30950 .cindex "SMTP" "output flushing, disabling for delay"
30951 Exim normally flushes SMTP output before implementing a delay in an ACL, to
30952 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
30953 use. This control, as long as it is encountered before the &%delay%& modifier,
30954 disables such output flushing.
30955
30956 .vitem &*control&~=&~no_callout_flush*&
30957 .cindex "SMTP" "output flushing, disabling for callout"
30958 Exim normally flushes SMTP output before performing a callout in an ACL, to
30959 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
30960 use. This control, as long as it is encountered before the &%verify%& condition
30961 that causes the callout, disables such output flushing.
30962
30963 .vitem &*control&~=&~no_mbox_unspool*&
30964 This control is available when Exim is compiled with the content scanning
30965 extension. Content scanning may require a copy of the current message, or parts
30966 of it, to be written in &"mbox format"& to a spool file, for passing to a virus
30967 or spam scanner. Normally, such copies are deleted when they are no longer
30968 needed. If this control is set, the copies are not deleted. The control applies
30969 only to the current message, not to any subsequent ones that may be received in
30970 the same SMTP connection. It is provided for debugging purposes and is unlikely
30971 to be useful in production.
30972
30973 .vitem &*control&~=&~no_multiline_responses*&
30974 .cindex "multiline responses, suppressing"
30975 This control is permitted for any ACL except the one for non-SMTP messages.
30976 It seems that there are broken clients in use that cannot handle multiline
30977 SMTP responses, despite the fact that RFC 821 defined them over 20 years ago.
30978
30979 If this control is set, multiline SMTP responses from ACL rejections are
30980 suppressed. One way of doing this would have been to put out these responses as
30981 one long line. However, RFC 2821 specifies a maximum of 512 bytes per response
30982 (&"use multiline responses for more"& it says &-- ha!), and some of the
30983 responses might get close to that. So this facility, which is after all only a
30984 sop to broken clients, is implemented by doing two very easy things:
30985
30986 .ilist
30987 Extra information that is normally output as part of a rejection caused by
30988 sender verification failure is omitted. Only the final line (typically &"sender
30989 verification failed"&) is sent.
30990 .next
30991 If a &%message%& modifier supplies a multiline response, only the first
30992 line is output.
30993 .endlist
30994
30995 The setting of the switch can, of course, be made conditional on the
30996 calling host. Its effect lasts until the end of the SMTP connection.
30997
30998 .vitem &*control&~=&~no_pipelining*&
30999 .cindex "PIPELINING" "suppressing advertising"
31000 This control turns off the advertising of the PIPELINING extension to SMTP in
31001 the current session. To be useful, it must be obeyed before Exim sends its
31002 response to an EHLO command. Therefore, it should normally appear in an ACL
31003 controlled by &%acl_smtp_connect%& or &%acl_smtp_helo%&. See also
31004 &%pipelining_advertise_hosts%&.
31005
31006 .new
31007 .vitem &*control&~=&~queue/*&<&'options'&>* &&&
31008        &*control&~=&~queue_only*&
31009 .oindex "&%queue%&"
31010 .oindex "&%queue_only%&"
31011 .cindex "queueing incoming messages"
31012 .cindex queueing "forcing in ACL"
31013 .cindex "first pass routing"
31014 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
31015 other words, only when a message is being received. If the message is accepted,
31016 it is placed on Exim's queue and left there for delivery by a subsequent queue
31017 runner.
31018 If used with no options set,
31019 no immediate delivery process is started. In other words, it has the
31020 effect as the &%queue_only%& global option or &'-odq'& command-line option.
31021
31022 If the &'first_pass_route'& option is given then
31023 the behaviour is like the command-line &'-oqds'& option;
31024 a delivery process is started which stops short of making
31025 any SMTP delivery.  The benefit is that the hints database will be updated for
31026 the message being waiting for a specific host, and a later queue run will be
31027 able to send all such messages on a single connection.
31028
31029 The control only applies to the current message, not to any subsequent ones that
31030  may be received in the same SMTP connection.
31031 .wen
31032
31033 .vitem &*control&~=&~submission/*&<&'options'&>
31034 .cindex "message" "submission"
31035 .cindex "submission mode"
31036 This control is permitted only for the MAIL, RCPT, and start of data ACLs (the
31037 latter is the one defined by &%acl_smtp_predata%&). Setting it tells Exim that
31038 the current message is a submission from a local MUA. In this case, Exim
31039 operates in &"submission mode"&, and applies certain fixups to the message if
31040 necessary. For example, it adds a &'Date:'& header line if one is not present.
31041 This control is not permitted in the &%acl_smtp_data%& ACL, because that is too
31042 late (the message has already been created).
31043
31044 Chapter &<<CHAPmsgproc>>& describes the processing that Exim applies to
31045 messages. Section &<<SECTsubmodnon>>& covers the processing that happens in
31046 submission mode; the available options for this control are described there.
31047 The control applies only to the current message, not to any subsequent ones
31048 that may be received in the same SMTP connection.
31049
31050 .vitem &*control&~=&~suppress_local_fixups*&
31051 .cindex "submission fixups, suppressing"
31052 This control applies to locally submitted (non TCP/IP) messages, and is the
31053 complement of &`control = submission`&. It disables the fixups that are
31054 normally applied to locally-submitted messages. Specifically:
31055
31056 .ilist
31057 Any &'Sender:'& header line is left alone (in this respect, it is a
31058 dynamic version of &%local_sender_retain%&).
31059 .next
31060 No &'Message-ID:'&, &'From:'&, or &'Date:'& header lines are added.
31061 .next
31062 There is no check that &'From:'& corresponds to the actual sender.
31063 .endlist ilist
31064
31065 This control may be useful when a remotely-originated message is accepted,
31066 passed to some scanning program, and then re-submitted for delivery. It can be
31067 used only in the &%acl_smtp_mail%&, &%acl_smtp_rcpt%&, &%acl_smtp_predata%&,
31068 and &%acl_not_smtp_start%& ACLs, because it has to be set before the message's
31069 data is read.
31070
31071 &*Note:*& This control applies only to the current message, not to any others
31072 that are being submitted at the same time using &%-bs%& or &%-bS%&.
31073
31074 .vitem &*control&~=&~utf8_downconvert*&
31075 This control enables conversion of UTF-8 in message addresses
31076 to a-label form.
31077 For details see section &<<SECTi18nMTA>>&.
31078 .endlist vlist
31079
31080
31081 .section "Summary of message fixup control" "SECTsummesfix"
31082 All four possibilities for message fixups can be specified:
31083
31084 .ilist
31085 Locally submitted, fixups applied: the default.
31086 .next
31087 Locally submitted, no fixups applied: use
31088 &`control = suppress_local_fixups`&.
31089 .next
31090 Remotely submitted, no fixups applied: the default.
31091 .next
31092 Remotely submitted, fixups applied: use &`control = submission`&.
31093 .endlist
31094
31095
31096
31097 .section "Adding header lines in ACLs" "SECTaddheadacl"
31098 .cindex "header lines" "adding in an ACL"
31099 .cindex "header lines" "position of added lines"
31100 .cindex "&%add_header%& ACL modifier"
31101 The &%add_header%& modifier can be used to add one or more extra header lines
31102 to an incoming message, as in this example:
31103 .code
31104 warn dnslists = sbl.spamhaus.org : \
31105                 dialup.mail-abuse.org
31106      add_header = X-blacklisted-at: $dnslist_domain
31107 .endd
31108 The &%add_header%& modifier is permitted in the MAIL, RCPT, PREDATA, DATA,
31109 MIME, DKIM, and non-SMTP ACLs (in other words, those that are concerned with
31110 receiving a message). The message must ultimately be accepted for
31111 &%add_header%& to have any significant effect. You can use &%add_header%& with
31112 any ACL verb, including &%deny%& (though this is potentially useful only in a
31113 RCPT ACL).
31114
31115 Headers will not be added to the message if the modifier is used in
31116 DATA, MIME or DKIM ACLs for a message delivered by cutthrough routing.
31117
31118 Leading and trailing newlines are removed from
31119 the data for the &%add_header%& modifier; if it then
31120 contains one or more newlines that
31121 are not followed by a space or a tab, it is assumed to contain multiple header
31122 lines. Each one is checked for valid syntax; &`X-ACL-Warn:`& is added to the
31123 front of any line that is not a valid header line.
31124
31125 Added header lines are accumulated during the MAIL, RCPT, and predata ACLs.
31126 They are added to the message before processing the DATA and MIME ACLs.
31127 However, if an identical header line is requested more than once, only one copy
31128 is actually added to the message. Further header lines may be accumulated
31129 during the DATA and MIME ACLs, after which they are added to the message, again
31130 with duplicates suppressed. Thus, it is possible to add two identical header
31131 lines to an SMTP message, but only if one is added before DATA and one after.
31132 In the case of non-SMTP messages, new headers are accumulated during the
31133 non-SMTP ACLs, and are added to the message after all the ACLs have run. If a
31134 message is rejected after DATA or by the non-SMTP ACL, all added header lines
31135 are included in the entry that is written to the reject log.
31136
31137 .cindex "header lines" "added; visibility of"
31138 Header lines are not visible in string expansions
31139 of message headers
31140 until they are added to the
31141 message. It follows that header lines defined in the MAIL, RCPT, and predata
31142 ACLs are not visible until the DATA ACL and MIME ACLs are run. Similarly,
31143 header lines that are added by the DATA or MIME ACLs are not visible in those
31144 ACLs. Because of this restriction, you cannot use header lines as a way of
31145 passing data between (for example) the MAIL and RCPT ACLs. If you want to do
31146 this, you can use ACL variables, as described in section
31147 &<<SECTaclvariables>>&.
31148
31149 The list of headers yet to be added is given by the &%$headers_added%& variable.
31150
31151 The &%add_header%& modifier acts immediately as it is encountered during the
31152 processing of an ACL. Notice the difference between these two cases:
31153 .display
31154 &`accept add_header = ADDED: some text`&
31155 &`       `&<&'some condition'&>
31156
31157 &`accept `&<&'some condition'&>
31158 &`       add_header = ADDED: some text`&
31159 .endd
31160 In the first case, the header line is always added, whether or not the
31161 condition is true. In the second case, the header line is added only if the
31162 condition is true. Multiple occurrences of &%add_header%& may occur in the same
31163 ACL statement. All those that are encountered before a condition fails are
31164 honoured.
31165
31166 .cindex "&%warn%& ACL verb"
31167 For compatibility with previous versions of Exim, a &%message%& modifier for a
31168 &%warn%& verb acts in the same way as &%add_header%&, except that it takes
31169 effect only if all the conditions are true, even if it appears before some of
31170 them. Furthermore, only the last occurrence of &%message%& is honoured. This
31171 usage of &%message%& is now deprecated. If both &%add_header%& and &%message%&
31172 are present on a &%warn%& verb, both are processed according to their
31173 specifications.
31174
31175 By default, new header lines are added to a message at the end of the existing
31176 header lines. However, you can specify that any particular header line should
31177 be added right at the start (before all the &'Received:'& lines), immediately
31178 after the first block of &'Received:'& lines, or immediately before any line
31179 that is not a &'Received:'& or &'Resent-something:'& header.
31180
31181 This is done by specifying &":at_start:"&, &":after_received:"&, or
31182 &":at_start_rfc:"& (or, for completeness, &":at_end:"&) before the text of the
31183 header line, respectively. (Header text cannot start with a colon, as there has
31184 to be a header name first.) For example:
31185 .code
31186 warn add_header = \
31187        :after_received:X-My-Header: something or other...
31188 .endd
31189 If more than one header line is supplied in a single &%add_header%& modifier,
31190 each one is treated independently and can therefore be placed differently. If
31191 you add more than one line at the start, or after the Received: block, they end
31192 up in reverse order.
31193
31194 &*Warning*&: This facility currently applies only to header lines that are
31195 added in an ACL. It does NOT work for header lines that are added in a
31196 system filter or in a router or transport.
31197
31198
31199
31200 .section "Removing header lines in ACLs" "SECTremoveheadacl"
31201 .cindex "header lines" "removing in an ACL"
31202 .cindex "header lines" "position of removed lines"
31203 .cindex "&%remove_header%& ACL modifier"
31204 The &%remove_header%& modifier can be used to remove one or more header lines
31205 from an incoming message, as in this example:
31206 .code
31207 warn   message        = Remove internal headers
31208        remove_header  = x-route-mail1 : x-route-mail2
31209 .endd
31210 The &%remove_header%& modifier is permitted in the MAIL, RCPT, PREDATA, DATA,
31211 MIME, DKIM, and non-SMTP ACLs (in other words, those that are concerned with
31212 receiving a message). The message must ultimately be accepted for
31213 &%remove_header%& to have any significant effect. You can use &%remove_header%&
31214 with any ACL verb, including &%deny%&, though this is really not useful for
31215 any verb that doesn't result in a delivered message.
31216
31217 Headers will not be removed from the message if the modifier is used in
31218 DATA, MIME or DKIM ACLs for a message delivered by cutthrough routing.
31219
31220 More than one header can be removed at the same time by using a colon separated
31221 list of header names. The header matching is case insensitive. Wildcards are
31222 not permitted, nor is list expansion performed, so you cannot use hostlists to
31223 create a list of headers, however both connection and message variable expansion
31224 are performed (&%$acl_c_*%& and &%$acl_m_*%&), illustrated in this example:
31225 .code
31226 warn   hosts           = +internal_hosts
31227        set acl_c_ihdrs = x-route-mail1 : x-route-mail2
31228 warn   message         = Remove internal headers
31229        remove_header   = $acl_c_ihdrs
31230 .endd
31231 Header names for removal are accumulated during the MAIL, RCPT, and predata ACLs.
31232 Matching header lines are removed from the message before processing the DATA and MIME ACLs.
31233 If multiple header lines match, all are removed.
31234 There is no harm in attempting to remove the same header twice nor in removing
31235 a non-existent header. Further header lines to be removed may be accumulated
31236 during the DATA and MIME ACLs, after which they are removed from the message,
31237 if present. In the case of non-SMTP messages, headers to be removed are
31238 accumulated during the non-SMTP ACLs, and are removed from the message after
31239 all the ACLs have run. If a message is rejected after DATA or by the non-SMTP
31240 ACL, there really is no effect because there is no logging of what headers
31241 would have been removed.
31242
31243 .cindex "header lines" "removed; visibility of"
31244 Header lines are not visible in string expansions until the DATA phase when it
31245 is received. Any header lines removed in the MAIL, RCPT, and predata ACLs are
31246 not visible in the DATA ACL and MIME ACLs. Similarly, header lines that are
31247 removed by the DATA or MIME ACLs are still visible in those ACLs. Because of
31248 this restriction, you cannot use header lines as a way of controlling data
31249 passed between (for example) the MAIL and RCPT ACLs. If you want to do this,
31250 you should instead use ACL variables, as described in section
31251 &<<SECTaclvariables>>&.
31252
31253 The &%remove_header%& modifier acts immediately as it is encountered during the
31254 processing of an ACL. Notice the difference between these two cases:
31255 .display
31256 &`accept remove_header = X-Internal`&
31257 &`       `&<&'some condition'&>
31258
31259 &`accept `&<&'some condition'&>
31260 &`       remove_header = X-Internal`&
31261 .endd
31262 In the first case, the header line is always removed, whether or not the
31263 condition is true. In the second case, the header line is removed only if the
31264 condition is true. Multiple occurrences of &%remove_header%& may occur in the
31265 same ACL statement. All those that are encountered before a condition fails
31266 are honoured.
31267
31268 &*Warning*&: This facility currently applies only to header lines that are
31269 present during ACL processing. It does NOT remove header lines that are added
31270 in a system filter or in a router or transport.
31271
31272
31273
31274
31275 .section "ACL conditions" "SECTaclconditions"
31276 .cindex "&ACL;" "conditions; list of"
31277 Some of the conditions listed in this section are available only when Exim is
31278 compiled with the content-scanning extension. They are included here briefly
31279 for completeness. More detailed descriptions can be found in the discussion on
31280 content scanning in chapter &<<CHAPexiscan>>&.
31281
31282 Not all conditions are relevant in all circumstances. For example, testing
31283 senders and recipients does not make sense in an ACL that is being run as the
31284 result of the arrival of an ETRN command, and checks on message headers can be
31285 done only in the ACLs specified by &%acl_smtp_data%& and &%acl_not_smtp%&. You
31286 can use the same condition (with different parameters) more than once in the
31287 same ACL statement. This provides a way of specifying an &"and"& conjunction.
31288 The conditions are as follows:
31289
31290
31291 .vlist
31292 .vitem &*acl&~=&~*&<&'name&~of&~acl&~or&~ACL&~string&~or&~file&~name&~'&>
31293 .cindex "&ACL;" "nested"
31294 .cindex "&ACL;" "indirect"
31295 .cindex "&ACL;" "arguments"
31296 .cindex "&%acl%& ACL condition"
31297 The possible values of the argument are the same as for the
31298 &%acl_smtp_%&&'xxx'& options. The named or inline ACL is run. If it returns
31299 &"accept"& the condition is true; if it returns &"deny"& the condition is
31300 false. If it returns &"defer"&, the current ACL returns &"defer"& unless the
31301 condition is on a &%warn%& verb. In that case, a &"defer"& return makes the
31302 condition false. This means that further processing of the &%warn%& verb
31303 ceases, but processing of the ACL continues.
31304
31305 If the argument is a named ACL, up to nine space-separated optional values
31306 can be appended; they appear within the called ACL in $acl_arg1 to $acl_arg9,
31307 and $acl_narg is set to the count of values.
31308 Previous values of these variables are restored after the call returns.
31309 The name and values are expanded separately.
31310 Note that spaces in complex expansions which are used as arguments
31311 will act as argument separators.
31312
31313 If the nested &%acl%& returns &"drop"& and the outer condition denies access,
31314 the connection is dropped. If it returns &"discard"&, the verb must be
31315 &%accept%& or &%discard%&, and the action is taken immediately &-- no further
31316 conditions are tested.
31317
31318 ACLs may be nested up to 20 deep; the limit exists purely to catch runaway
31319 loops. This condition allows you to use different ACLs in different
31320 circumstances. For example, different ACLs can be used to handle RCPT commands
31321 for different local users or different local domains.
31322
31323 .vitem &*authenticated&~=&~*&<&'string&~list'&>
31324 .cindex "&%authenticated%& ACL condition"
31325 .cindex "authentication" "ACL checking"
31326 .cindex "&ACL;" "testing for authentication"
31327 If the SMTP connection is not authenticated, the condition is false. Otherwise,
31328 the name of the authenticator is tested against the list. To test for
31329 authentication by any authenticator, you can set
31330 .code
31331 authenticated = *
31332 .endd
31333
31334 .vitem &*condition&~=&~*&<&'string'&>
31335 .cindex "&%condition%& ACL condition"
31336 .cindex "customizing" "ACL condition"
31337 .cindex "&ACL;" "customized test"
31338 .cindex "&ACL;" "testing, customized"
31339 This feature allows you to make up custom conditions. If the result of
31340 expanding the string is an empty string, the number zero, or one of the strings
31341 &"no"& or &"false"&, the condition is false. If the result is any non-zero
31342 number, or one of the strings &"yes"& or &"true"&, the condition is true. For
31343 any other value, some error is assumed to have occurred, and the ACL returns
31344 &"defer"&. However, if the expansion is forced to fail, the condition is
31345 ignored. The effect is to treat it as true, whether it is positive or
31346 negative.
31347
31348 .vitem &*decode&~=&~*&<&'location'&>
31349 .cindex "&%decode%& ACL condition"
31350 This condition is available only when Exim is compiled with the
31351 content-scanning extension, and it is allowed only in the ACL defined by
31352 &%acl_smtp_mime%&. It causes the current MIME part to be decoded into a file.
31353 If all goes well, the condition is true. It is false only if there are
31354 problems such as a syntax error or a memory shortage. For more details, see
31355 chapter &<<CHAPexiscan>>&.
31356
31357 .vitem &*dnslists&~=&~*&<&'list&~of&~domain&~names&~and&~other&~data'&>
31358 .cindex "&%dnslists%& ACL condition"
31359 .cindex "DNS list" "in ACL"
31360 .cindex "black list (DNS)"
31361 .cindex "&ACL;" "testing a DNS list"
31362 This condition checks for entries in DNS black lists. These are also known as
31363 &"RBL lists"&, after the original Realtime Blackhole List, but note that the
31364 use of the lists at &'mail-abuse.org'& now carries a charge. There are too many
31365 different variants of this condition to describe briefly here. See sections
31366 &<<SECTmorednslists>>&&--&<<SECTmorednslistslast>>& for details.
31367
31368 .vitem &*domains&~=&~*&<&'domain&~list'&>
31369 .cindex "&%domains%& ACL condition"
31370 .cindex "domain" "ACL checking"
31371 .cindex "&ACL;" "testing a recipient domain"
31372 .vindex "&$domain_data$&"
31373 This condition is relevant only after a RCPT command. It checks that the domain
31374 of the recipient address is in the domain list. If percent-hack processing is
31375 enabled, it is done before this test is done. If the check succeeds with a
31376 lookup, the result of the lookup is placed in &$domain_data$& until the next
31377 &%domains%& test.
31378
31379 &*Note carefully*& (because many people seem to fall foul of this): you cannot
31380 use &%domains%& in a DATA ACL.
31381
31382
31383 .vitem &*encrypted&~=&~*&<&'string&~list'&>
31384 .cindex "&%encrypted%& ACL condition"
31385 .cindex "encryption" "checking in an ACL"
31386 .cindex "&ACL;" "testing for encryption"
31387 If the SMTP connection is not encrypted, the condition is false. Otherwise, the
31388 name of the cipher suite in use is tested against the list. To test for
31389 encryption without testing for any specific cipher suite(s), set
31390 .code
31391 encrypted = *
31392 .endd
31393
31394
31395 .vitem &*hosts&~=&~*&<&'host&~list'&>
31396 .cindex "&%hosts%& ACL condition"
31397 .cindex "host" "ACL checking"
31398 .cindex "&ACL;" "testing the client host"
31399 This condition tests that the calling host matches the host list. If you have
31400 name lookups or wildcarded host names and IP addresses in the same host list,
31401 you should normally put the IP addresses first. For example, you could have:
31402 .code
31403 accept hosts = 10.9.8.7 : dbm;/etc/friendly/hosts
31404 .endd
31405 The lookup in this example uses the host name for its key. This is implied by
31406 the lookup type &"dbm"&. (For a host address lookup you would use &"net-dbm"&
31407 and it wouldn't matter which way round you had these two items.)
31408
31409 The reason for the problem with host names lies in the left-to-right way that
31410 Exim processes lists. It can test IP addresses without doing any DNS lookups,
31411 but when it reaches an item that requires a host name, it fails if it cannot
31412 find a host name to compare with the pattern. If the above list is given in the
31413 opposite order, the &%accept%& statement fails for a host whose name cannot be
31414 found, even if its IP address is 10.9.8.7.
31415
31416 If you really do want to do the name check first, and still recognize the IP
31417 address even if the name lookup fails, you can rewrite the ACL like this:
31418 .code
31419 accept hosts = dbm;/etc/friendly/hosts
31420 accept hosts = 10.9.8.7
31421 .endd
31422 The default action on failing to find the host name is to assume that the host
31423 is not in the list, so the first &%accept%& statement fails. The second
31424 statement can then check the IP address.
31425
31426 .vindex "&$host_data$&"
31427 If a &%hosts%& condition is satisfied by means of a lookup, the result
31428 of the lookup is made available in the &$host_data$& variable. This
31429 allows you, for example, to set up a statement like this:
31430 .code
31431 deny  hosts = net-lsearch;/some/file
31432 message = $host_data
31433 .endd
31434 which gives a custom error message for each denied host.
31435
31436 .vitem &*local_parts&~=&~*&<&'local&~part&~list'&>
31437 .cindex "&%local_parts%& ACL condition"
31438 .cindex "local part" "ACL checking"
31439 .cindex "&ACL;" "testing a local part"
31440 .vindex "&$local_part_data$&"
31441 This condition is relevant only after a RCPT command. It checks that the local
31442 part of the recipient address is in the list. If percent-hack processing is
31443 enabled, it is done before this test. If the check succeeds with a lookup, the
31444 result of the lookup is placed in &$local_part_data$&, which remains set until
31445 the next &%local_parts%& test.
31446
31447 .vitem &*malware&~=&~*&<&'option'&>
31448 .cindex "&%malware%& ACL condition"
31449 .cindex "&ACL;" "virus scanning"
31450 .cindex "&ACL;" "scanning for viruses"
31451 This condition is available only when Exim is compiled with the
31452 content-scanning extension
31453 and only after a DATA command.
31454 It causes the incoming message to be scanned for
31455 viruses. For details, see chapter &<<CHAPexiscan>>&.
31456
31457 .vitem &*mime_regex&~=&~*&<&'list&~of&~regular&~expressions'&>
31458 .cindex "&%mime_regex%& ACL condition"
31459 .cindex "&ACL;" "testing by regex matching"
31460 This condition is available only when Exim is compiled with the
31461 content-scanning extension, and it is allowed only in the ACL defined by
31462 &%acl_smtp_mime%&. It causes the current MIME part to be scanned for a match
31463 with any of the regular expressions. For details, see chapter
31464 &<<CHAPexiscan>>&.
31465
31466 .vitem &*ratelimit&~=&~*&<&'parameters'&>
31467 .cindex "rate limiting"
31468 This condition can be used to limit the rate at which a user or host submits
31469 messages. Details are given in section &<<SECTratelimiting>>&.
31470
31471 .vitem &*recipients&~=&~*&<&'address&~list'&>
31472 .cindex "&%recipients%& ACL condition"
31473 .cindex "recipient" "ACL checking"
31474 .cindex "&ACL;" "testing a recipient"
31475 This condition is relevant only after a RCPT command. It checks the entire
31476 recipient address against a list of recipients.
31477
31478 .vitem &*regex&~=&~*&<&'list&~of&~regular&~expressions'&>
31479 .cindex "&%regex%& ACL condition"
31480 .cindex "&ACL;" "testing by regex matching"
31481 This condition is available only when Exim is compiled with the
31482 content-scanning extension, and is available only in the DATA, MIME, and
31483 non-SMTP ACLs. It causes the incoming message to be scanned for a match with
31484 any of the regular expressions. For details, see chapter &<<CHAPexiscan>>&.
31485
31486 .vitem &*sender_domains&~=&~*&<&'domain&~list'&>
31487 .cindex "&%sender_domains%& ACL condition"
31488 .cindex "sender" "ACL checking"
31489 .cindex "&ACL;" "testing a sender domain"
31490 .vindex "&$domain$&"
31491 .vindex "&$sender_address_domain$&"
31492 This condition tests the domain of the sender of the message against the given
31493 domain list. &*Note*&: The domain of the sender address is in
31494 &$sender_address_domain$&. It is &'not'& put in &$domain$& during the testing
31495 of this condition. This is an exception to the general rule for testing domain
31496 lists. It is done this way so that, if this condition is used in an ACL for a
31497 RCPT command, the recipient's domain (which is in &$domain$&) can be used to
31498 influence the sender checking.
31499
31500 &*Warning*&: It is a bad idea to use this condition on its own as a control on
31501 relaying, because sender addresses are easily, and commonly, forged.
31502
31503 .vitem &*senders&~=&~*&<&'address&~list'&>
31504 .cindex "&%senders%& ACL condition"
31505 .cindex "sender" "ACL checking"
31506 .cindex "&ACL;" "testing a sender"
31507 This condition tests the sender of the message against the given list. To test
31508 for a bounce message, which has an empty sender, set
31509 .code
31510 senders = :
31511 .endd
31512 &*Warning*&: It is a bad idea to use this condition on its own as a control on
31513 relaying, because sender addresses are easily, and commonly, forged.
31514
31515 .vitem &*spam&~=&~*&<&'username'&>
31516 .cindex "&%spam%& ACL condition"
31517 .cindex "&ACL;" "scanning for spam"
31518 This condition is available only when Exim is compiled with the
31519 content-scanning extension. It causes the incoming message to be scanned by
31520 SpamAssassin. For details, see chapter &<<CHAPexiscan>>&.
31521
31522 .vitem &*verify&~=&~certificate*&
31523 .cindex "&%verify%& ACL condition"
31524 .cindex "TLS" "client certificate verification"
31525 .cindex "certificate" "verification of client"
31526 .cindex "&ACL;" "certificate verification"
31527 .cindex "&ACL;" "testing a TLS certificate"
31528 This condition is true in an SMTP session if the session is encrypted, and a
31529 certificate was received from the client, and the certificate was verified. The
31530 server requests a certificate only if the client matches &%tls_verify_hosts%&
31531 or &%tls_try_verify_hosts%& (see chapter &<<CHAPTLS>>&).
31532
31533 .vitem &*verify&~=&~csa*&
31534 .cindex "CSA verification"
31535 This condition checks whether the sending host (the client) is authorized to
31536 send email. Details of how this works are given in section
31537 &<<SECTverifyCSA>>&.
31538
31539 .vitem &*verify&~=&~header_names_ascii*&
31540 .cindex "&%verify%& ACL condition"
31541 .cindex "&ACL;" "verifying header names only ASCII"
31542 .cindex "header lines" "verifying header names only ASCII"
31543 .cindex "verifying" "header names only ASCII"
31544 This condition is relevant only in an ACL that is run after a message has been
31545 received, that is, in an ACL specified by &%acl_smtp_data%& or
31546 &%acl_not_smtp%&.  It checks all header names (not the content) to make sure
31547 there are no non-ASCII characters, also excluding control characters.  The
31548 allowable characters are decimal ASCII values 33 through 126.
31549
31550 Exim itself will handle headers with non-ASCII characters, but it can cause
31551 problems for downstream applications, so this option will allow their
31552 detection and rejection in the DATA ACL's.
31553
31554 .vitem &*verify&~=&~header_sender/*&<&'options'&>
31555 .cindex "&%verify%& ACL condition"
31556 .cindex "&ACL;" "verifying sender in the header"
31557 .cindex "header lines" "verifying the sender in"
31558 .cindex "sender" "verifying in header"
31559 .cindex "verifying" "sender in header"
31560 This condition is relevant only in an ACL that is run after a message has been
31561 received, that is, in an ACL specified by &%acl_smtp_data%& or
31562 &%acl_not_smtp%&. It checks that there is a verifiable address in at least one
31563 of the &'Sender:'&, &'Reply-To:'&, or &'From:'& header lines. Such an address
31564 is loosely thought of as a &"sender"& address (hence the name of the test).
31565 However, an address that appears in one of these headers need not be an address
31566 that accepts bounce messages; only sender addresses in envelopes are required
31567 to accept bounces. Therefore, if you use the callout option on this check, you
31568 might want to arrange for a non-empty address in the MAIL command.
31569
31570 Details of address verification and the options are given later, starting at
31571 section &<<SECTaddressverification>>& (callouts are described in section
31572 &<<SECTcallver>>&). You can combine this condition with the &%senders%&
31573 condition to restrict it to bounce messages only:
31574 .code
31575 deny    senders = :
31576         message = A valid sender header is required for bounces
31577        !verify  = header_sender
31578 .endd
31579
31580 .vitem &*verify&~=&~header_syntax*&
31581 .cindex "&%verify%& ACL condition"
31582 .cindex "&ACL;" "verifying header syntax"
31583 .cindex "header lines" "verifying syntax"
31584 .cindex "verifying" "header syntax"
31585 This condition is relevant only in an ACL that is run after a message has been
31586 received, that is, in an ACL specified by &%acl_smtp_data%& or
31587 &%acl_not_smtp%&. It checks the syntax of all header lines that can contain
31588 lists of addresses (&'Sender:'&, &'From:'&, &'Reply-To:'&, &'To:'&, &'Cc:'&,
31589 and &'Bcc:'&), returning true if there are no problems.
31590 Unqualified addresses (local parts without domains) are
31591 permitted only in locally generated messages and from hosts that match
31592 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
31593 appropriate.
31594
31595 Note that this condition is a syntax check only. However, a common spamming
31596 ploy used to be to send syntactically invalid headers such as
31597 .code
31598 To: @
31599 .endd
31600 and this condition can be used to reject such messages, though they are not as
31601 common as they used to be.
31602
31603 .vitem &*verify&~=&~helo*&
31604 .cindex "&%verify%& ACL condition"
31605 .cindex "&ACL;" "verifying HELO/EHLO"
31606 .cindex "HELO" "verifying"
31607 .cindex "EHLO" "verifying"
31608 .cindex "verifying" "EHLO"
31609 .cindex "verifying" "HELO"
31610 This condition is true if a HELO or EHLO command has been received from the
31611 client host, and its contents have been verified. If there has been no previous
31612 attempt to verify the HELO/EHLO contents, it is carried out when this
31613 condition is encountered. See the description of the &%helo_verify_hosts%& and
31614 &%helo_try_verify_hosts%& options for details of how to request verification
31615 independently of this condition, and for detail of the verification.
31616
31617 For SMTP input that does not come over TCP/IP (the &%-bs%& command line
31618 option), this condition is always true.
31619
31620
31621 .vitem &*verify&~=&~not_blind/*&<&'options'&>
31622 .cindex "verifying" "not blind"
31623 .cindex "bcc recipients, verifying none"
31624 This condition checks that there are no blind (bcc) recipients in the message.
31625 Every envelope recipient must appear either in a &'To:'& header line or in a
31626 &'Cc:'& header line for this condition to be true. Local parts are checked
31627 case-sensitively; domains are checked case-insensitively. If &'Resent-To:'& or
31628 &'Resent-Cc:'& header lines exist, they are also checked. This condition can be
31629 used only in a DATA or non-SMTP ACL.
31630
31631 There is one possible option, &`case_insensitive`&.  If this is present then
31632 local parts are checked case-insensitively.
31633
31634 There are, of course, many legitimate messages that make use of blind (bcc)
31635 recipients. This check should not be used on its own for blocking messages.
31636
31637
31638 .vitem &*verify&~=&~recipient/*&<&'options'&>
31639 .cindex "&%verify%& ACL condition"
31640 .cindex "&ACL;" "verifying recipient"
31641 .cindex "recipient" "verifying"
31642 .cindex "verifying" "recipient"
31643 .vindex "&$address_data$&"
31644 This condition is relevant only after a RCPT command. It verifies the current
31645 recipient. Details of address verification are given later, starting at section
31646 &<<SECTaddressverification>>&. After a recipient has been verified, the value
31647 of &$address_data$& is the last value that was set while routing the address.
31648 This applies even if the verification fails. When an address that is being
31649 verified is redirected to a single address, verification continues with the new
31650 address, and in that case, the subsequent value of &$address_data$& is the
31651 value for the child address.
31652
31653 .vitem &*verify&~=&~reverse_host_lookup/*&<&'options'&>
31654 .cindex "&%verify%& ACL condition"
31655 .cindex "&ACL;" "verifying host reverse lookup"
31656 .cindex "host" "verifying reverse lookup"
31657 This condition ensures that a verified host name has been looked up from the IP
31658 address of the client host. (This may have happened already if the host name
31659 was needed for checking a host list, or if the host matched &%host_lookup%&.)
31660 Verification ensures that the host name obtained from a reverse DNS lookup, or
31661 one of its aliases, does, when it is itself looked up in the DNS, yield the
31662 original IP address.
31663
31664 There is one possible option, &`defer_ok`&.  If this is present and a
31665 DNS operation returns a temporary error, the verify condition succeeds.
31666
31667 If this condition is used for a locally generated message (that is, when there
31668 is no client host involved), it always succeeds.
31669
31670 .vitem &*verify&~=&~sender/*&<&'options'&>
31671 .cindex "&%verify%& ACL condition"
31672 .cindex "&ACL;" "verifying sender"
31673 .cindex "sender" "verifying"
31674 .cindex "verifying" "sender"
31675 This condition is relevant only after a MAIL or RCPT command, or after a
31676 message has been received (the &%acl_smtp_data%& or &%acl_not_smtp%& ACLs). If
31677 the message's sender is empty (that is, this is a bounce message), the
31678 condition is true. Otherwise, the sender address is verified.
31679
31680 .vindex "&$address_data$&"
31681 .vindex "&$sender_address_data$&"
31682 If there is data in the &$address_data$& variable at the end of routing, its
31683 value is placed in &$sender_address_data$& at the end of verification. This
31684 value can be used in subsequent conditions and modifiers in the same ACL
31685 statement. It does not persist after the end of the current statement. If you
31686 want to preserve the value for longer, you can save it in an ACL variable.
31687
31688 Details of verification are given later, starting at section
31689 &<<SECTaddressverification>>&. Exim caches the result of sender verification,
31690 to avoid doing it more than once per message.
31691
31692 .vitem &*verify&~=&~sender=*&<&'address'&>&*/*&<&'options'&>
31693 .cindex "&%verify%& ACL condition"
31694 This is a variation of the previous option, in which a modified address is
31695 verified as a sender.
31696
31697 Note that '/' is legal in local-parts; if the address may have such
31698 (eg. is generated from the received message)
31699 they must be protected from the options parsing by doubling:
31700 .code
31701 verify = sender=${sg{${address:$h_sender:}}{/}{//}}
31702 .endd
31703 .endlist
31704
31705
31706
31707 .section "Using DNS lists" "SECTmorednslists"
31708 .cindex "DNS list" "in ACL"
31709 .cindex "black list (DNS)"
31710 .cindex "&ACL;" "testing a DNS list"
31711 In its simplest form, the &%dnslists%& condition tests whether the calling host
31712 is on at least one of a number of DNS lists by looking up the inverted IP
31713 address in one or more DNS domains. (Note that DNS list domains are not mail
31714 domains, so the &`+`& syntax for named lists doesn't work - it is used for
31715 special options instead.) For example, if the calling host's IP
31716 address is 192.168.62.43, and the ACL statement is
31717 .code
31718 deny dnslists = blackholes.mail-abuse.org : \
31719                 dialups.mail-abuse.org
31720 .endd
31721 the following records are looked up:
31722 .code
31723 43.62.168.192.blackholes.mail-abuse.org
31724 43.62.168.192.dialups.mail-abuse.org
31725 .endd
31726 As soon as Exim finds an existing DNS record, processing of the list stops.
31727 Thus, multiple entries on the list provide an &"or"& conjunction. If you want
31728 to test that a host is on more than one list (an &"and"& conjunction), you can
31729 use two separate conditions:
31730 .code
31731 deny dnslists = blackholes.mail-abuse.org
31732      dnslists = dialups.mail-abuse.org
31733 .endd
31734 If a DNS lookup times out or otherwise fails to give a decisive answer, Exim
31735 behaves as if the host does not match the list item, that is, as if the DNS
31736 record does not exist. If there are further items in the DNS list, they are
31737 processed.
31738
31739 This is usually the required action when &%dnslists%& is used with &%deny%&
31740 (which is the most common usage), because it prevents a DNS failure from
31741 blocking mail. However, you can change this behaviour by putting one of the
31742 following special items in the list:
31743 .display
31744 &`+include_unknown `&   behave as if the item is on the list
31745 &`+exclude_unknown `&   behave as if the item is not on the list (default)
31746 &`+defer_unknown   `&   give a temporary error
31747 .endd
31748 .cindex "&`+include_unknown`&"
31749 .cindex "&`+exclude_unknown`&"
31750 .cindex "&`+defer_unknown`&"
31751 Each of these applies to any subsequent items on the list. For example:
31752 .code
31753 deny dnslists = +defer_unknown : foo.bar.example
31754 .endd
31755 Testing the list of domains stops as soon as a match is found. If you want to
31756 warn for one list and block for another, you can use two different statements:
31757 .code
31758 deny  dnslists = blackholes.mail-abuse.org
31759 warn  message  = X-Warn: sending host is on dialups list
31760       dnslists = dialups.mail-abuse.org
31761 .endd
31762 .cindex caching "of dns lookup"
31763 .cindex DNS TTL
31764 DNS list lookups are cached by Exim for the duration of the SMTP session
31765 (but limited by the DNS return TTL value),
31766 so a lookup based on the IP address is done at most once for any incoming
31767 connection (assuming long-enough TTL).
31768 Exim does not share information between multiple incoming
31769 connections (but your local name server cache should be active).
31770
31771 There are a number of DNS lists to choose from, some commercial, some free,
31772 or free for small deployments.  An overview can be found at
31773 &url(https://en.wikipedia.org/wiki/Comparison_of_DNS_blacklists).
31774
31775
31776
31777 .section "Specifying the IP address for a DNS list lookup" "SECID201"
31778 .cindex "DNS list" "keyed by explicit IP address"
31779 By default, the IP address that is used in a DNS list lookup is the IP address
31780 of the calling host. However, you can specify another IP address by listing it
31781 after the domain name, introduced by a slash. For example:
31782 .code
31783 deny dnslists = black.list.tld/192.168.1.2
31784 .endd
31785 This feature is not very helpful with explicit IP addresses; it is intended for
31786 use with IP addresses that are looked up, for example, the IP addresses of the
31787 MX hosts or nameservers of an email sender address. For an example, see section
31788 &<<SECTmulkeyfor>>& below.
31789
31790
31791
31792
31793 .section "DNS lists keyed on domain names" "SECID202"
31794 .cindex "DNS list" "keyed by domain name"
31795 There are some lists that are keyed on domain names rather than inverted IP
31796 addresses (see, e.g., the &'domain based zones'& link at
31797 &url(http://www.rfc-ignorant.org/)). No reversing of components is used
31798 with these lists. You can change the name that is looked up in a DNS list by
31799 listing it after the domain name, introduced by a slash. For example,
31800 .code
31801 deny  message  = Sender's domain is listed at $dnslist_domain
31802       dnslists = dsn.rfc-ignorant.org/$sender_address_domain
31803 .endd
31804 This particular example is useful only in ACLs that are obeyed after the
31805 RCPT or DATA commands, when a sender address is available. If (for
31806 example) the message's sender is &'user@tld.example'& the name that is looked
31807 up by this example is
31808 .code
31809 tld.example.dsn.rfc-ignorant.org
31810 .endd
31811 A single &%dnslists%& condition can contain entries for both names and IP
31812 addresses. For example:
31813 .code
31814 deny dnslists = sbl.spamhaus.org : \
31815                 dsn.rfc-ignorant.org/$sender_address_domain
31816 .endd
31817 The first item checks the sending host's IP address; the second checks a domain
31818 name. The whole condition is true if either of the DNS lookups succeeds.
31819
31820
31821
31822
31823 .section "Multiple explicit keys for a DNS list" "SECTmulkeyfor"
31824 .cindex "DNS list" "multiple keys for"
31825 The syntax described above for looking up explicitly-defined values (either
31826 names or IP addresses) in a DNS blacklist is a simplification. After the domain
31827 name for the DNS list, what follows the slash can in fact be a list of items.
31828 As with all lists in Exim, the default separator is a colon. However, because
31829 this is a sublist within the list of DNS blacklist domains, it is necessary
31830 either to double the separators like this:
31831 .code
31832 dnslists = black.list.tld/name.1::name.2
31833 .endd
31834 or to change the separator character, like this:
31835 .code
31836 dnslists = black.list.tld/<;name.1;name.2
31837 .endd
31838 If an item in the list is an IP address, it is inverted before the DNS
31839 blacklist domain is appended. If it is not an IP address, no inversion
31840 occurs. Consider this condition:
31841 .code
31842 dnslists = black.list.tld/<;192.168.1.2;a.domain
31843 .endd
31844 The DNS lookups that occur are:
31845 .code
31846 2.1.168.192.black.list.tld
31847 a.domain.black.list.tld
31848 .endd
31849 Once a DNS record has been found (that matches a specific IP return
31850 address, if specified &-- see section &<<SECTaddmatcon>>&), no further lookups
31851 are done. If there is a temporary DNS error, the rest of the sublist of domains
31852 or IP addresses is tried. A temporary error for the whole dnslists item occurs
31853 only if no other DNS lookup in this sublist succeeds. In other words, a
31854 successful lookup for any of the items in the sublist overrides a temporary
31855 error for a previous item.
31856
31857 The ability to supply a list of items after the slash is in some sense just a
31858 syntactic convenience. These two examples have the same effect:
31859 .code
31860 dnslists = black.list.tld/a.domain : black.list.tld/b.domain
31861 dnslists = black.list.tld/a.domain::b.domain
31862 .endd
31863 However, when the data for the list is obtained from a lookup, the second form
31864 is usually much more convenient. Consider this example:
31865 .code
31866 deny message  = The mail servers for the domain \
31867                 $sender_address_domain \
31868                 are listed at $dnslist_domain ($dnslist_value); \
31869                 see $dnslist_text.
31870      dnslists = sbl.spamhaus.org/<|${lookup dnsdb {>|a=<|\
31871                                    ${lookup dnsdb {>|mxh=\
31872                                    $sender_address_domain} }} }
31873 .endd
31874 Note the use of &`>|`& in the dnsdb lookup to specify the separator for
31875 multiple DNS records. The inner dnsdb lookup produces a list of MX hosts
31876 and the outer dnsdb lookup finds the IP addresses for these hosts. The result
31877 of expanding the condition might be something like this:
31878 .code
31879 dnslists = sbl.spamhaus.org/<|192.168.2.3|192.168.5.6|...
31880 .endd
31881 Thus, this example checks whether or not the IP addresses of the sender
31882 domain's mail servers are on the Spamhaus black list.
31883
31884 The key that was used for a successful DNS list lookup is put into the variable
31885 &$dnslist_matched$& (see section &<<SECID204>>&).
31886
31887
31888
31889
31890 .section "Data returned by DNS lists" "SECID203"
31891 .cindex "DNS list" "data returned from"
31892 DNS lists are constructed using address records in the DNS. The original RBL
31893 just used the address 127.0.0.1 on the right hand side of each record, but the
31894 RBL+ list and some other lists use a number of values with different meanings.
31895 The values used on the RBL+ list are:
31896 .display
31897 127.1.0.1  RBL
31898 127.1.0.2  DUL
31899 127.1.0.3  DUL and RBL
31900 127.1.0.4  RSS
31901 127.1.0.5  RSS and RBL
31902 127.1.0.6  RSS and DUL
31903 127.1.0.7  RSS and DUL and RBL
31904 .endd
31905 Section &<<SECTaddmatcon>>& below describes how you can distinguish between
31906 different values. Some DNS lists may return more than one address record;
31907 see section &<<SECThanmuldnsrec>>& for details of how they are checked.
31908
31909
31910 .section "Variables set from DNS lists" "SECID204"
31911 .cindex "expansion" "variables, set from DNS list"
31912 .cindex "DNS list" "variables set from"
31913 .vindex "&$dnslist_domain$&"
31914 .vindex "&$dnslist_matched$&"
31915 .vindex "&$dnslist_text$&"
31916 .vindex "&$dnslist_value$&"
31917 When an entry is found in a DNS list, the variable &$dnslist_domain$& contains
31918 the name of the overall domain that matched (for example,
31919 &`spamhaus.example`&), &$dnslist_matched$& contains the key within that domain
31920 (for example, &`192.168.5.3`&), and &$dnslist_value$& contains the data from
31921 the DNS record. When the key is an IP address, it is not reversed in
31922 &$dnslist_matched$& (though it is, of course, in the actual lookup). In simple
31923 cases, for example:
31924 .code
31925 deny dnslists = spamhaus.example
31926 .endd
31927 the key is also available in another variable (in this case,
31928 &$sender_host_address$&). In more complicated cases, however, this is not true.
31929 For example, using a data lookup (as described in section &<<SECTmulkeyfor>>&)
31930 might generate a dnslists lookup like this:
31931 .code
31932 deny dnslists = spamhaus.example/<|192.168.1.2|192.168.6.7|...
31933 .endd
31934 If this condition succeeds, the value in &$dnslist_matched$& might be
31935 &`192.168.6.7`& (for example).
31936
31937 If more than one address record is returned by the DNS lookup, all the IP
31938 addresses are included in &$dnslist_value$&, separated by commas and spaces.
31939 The variable &$dnslist_text$& contains the contents of any associated TXT
31940 record. For lists such as RBL+ the TXT record for a merged entry is often not
31941 very meaningful. See section &<<SECTmordetinf>>& for a way of obtaining more
31942 information.
31943
31944 You can use the DNS list variables in &%message%& or &%log_message%& modifiers
31945 &-- although these appear before the condition in the ACL, they are not
31946 expanded until after it has failed. For example:
31947 .code
31948 deny    hosts = !+local_networks
31949         message = $sender_host_address is listed \
31950                   at $dnslist_domain
31951         dnslists = rbl-plus.mail-abuse.example
31952 .endd
31953
31954
31955
31956 .section "Additional matching conditions for DNS lists" "SECTaddmatcon"
31957 .cindex "DNS list" "matching specific returned data"
31958 You can add an equals sign and an IP address after a &%dnslists%& domain name
31959 in order to restrict its action to DNS records with a matching right hand side.
31960 For example,
31961 .code
31962 deny dnslists = rblplus.mail-abuse.org=127.0.0.2
31963 .endd
31964 rejects only those hosts that yield 127.0.0.2. Without this additional data,
31965 any address record is considered to be a match. For the moment, we assume
31966 that the DNS lookup returns just one record. Section &<<SECThanmuldnsrec>>&
31967 describes how multiple records are handled.
31968
31969 More than one IP address may be given for checking, using a comma as a
31970 separator. These are alternatives &-- if any one of them matches, the
31971 &%dnslists%& condition is true. For example:
31972 .code
31973 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
31974 .endd
31975 If you want to specify a constraining address list and also specify names or IP
31976 addresses to be looked up, the constraining address list must be specified
31977 first. For example:
31978 .code
31979 deny dnslists = dsn.rfc-ignorant.org\
31980                 =127.0.0.2/$sender_address_domain
31981 .endd
31982
31983 If the character &`&&`& is used instead of &`=`&, the comparison for each
31984 listed IP address is done by a bitwise &"and"& instead of by an equality test.
31985 In other words, the listed addresses are used as bit masks. The comparison is
31986 true if all the bits in the mask are present in the address that is being
31987 tested. For example:
31988 .code
31989 dnslists = a.b.c&0.0.0.3
31990 .endd
31991 matches if the address is &'x.x.x.'&3, &'x.x.x.'&7, &'x.x.x.'&11, etc. If you
31992 want to test whether one bit or another bit is present (as opposed to both
31993 being present), you must use multiple values. For example:
31994 .code
31995 dnslists = a.b.c&0.0.0.1,0.0.0.2
31996 .endd
31997 matches if the final component of the address is an odd number or two times
31998 an odd number.
31999
32000
32001
32002 .section "Negated DNS matching conditions" "SECID205"
32003 You can supply a negative list of IP addresses as part of a &%dnslists%&
32004 condition. Whereas
32005 .code
32006 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
32007 .endd
32008 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
32009 IP address yielded by the list is either 127.0.0.2 or 127.0.0.3"&,
32010 .code
32011 deny  dnslists = a.b.c!=127.0.0.2,127.0.0.3
32012 .endd
32013 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
32014 IP address yielded by the list is not 127.0.0.2 and not 127.0.0.3"&. In other
32015 words, the result of the test is inverted if an exclamation mark appears before
32016 the &`=`& (or the &`&&`&) sign.
32017
32018 &*Note*&: This kind of negation is not the same as negation in a domain,
32019 host, or address list (which is why the syntax is different).
32020
32021 If you are using just one list, the negation syntax does not gain you much. The
32022 previous example is precisely equivalent to
32023 .code
32024 deny  dnslists = a.b.c
32025      !dnslists = a.b.c=127.0.0.2,127.0.0.3
32026 .endd
32027 However, if you are using multiple lists, the negation syntax is clearer.
32028 Consider this example:
32029 .code
32030 deny  dnslists = sbl.spamhaus.org : \
32031                  list.dsbl.org : \
32032                  dnsbl.njabl.org!=127.0.0.3 : \
32033                  relays.ordb.org
32034 .endd
32035 Using only positive lists, this would have to be:
32036 .code
32037 deny  dnslists = sbl.spamhaus.org : \
32038                  list.dsbl.org
32039 deny  dnslists = dnsbl.njabl.org
32040      !dnslists = dnsbl.njabl.org=127.0.0.3
32041 deny  dnslists = relays.ordb.org
32042 .endd
32043 which is less clear, and harder to maintain.
32044
32045
32046
32047
32048 .section "Handling multiple DNS records from a DNS list" "SECThanmuldnsrec"
32049 A DNS lookup for a &%dnslists%& condition may return more than one DNS record,
32050 thereby providing more than one IP address. When an item in a &%dnslists%& list
32051 is followed by &`=`& or &`&&`& and a list of IP addresses, in order to restrict
32052 the match to specific results from the DNS lookup, there are two ways in which
32053 the checking can be handled. For example, consider the condition:
32054 .code
32055 dnslists = a.b.c=127.0.0.1
32056 .endd
32057 What happens if the DNS lookup for the incoming IP address yields both
32058 127.0.0.1 and 127.0.0.2 by means of two separate DNS records? Is the
32059 condition true because at least one given value was found, or is it false
32060 because at least one of the found values was not listed? And how does this
32061 affect negated conditions? Both possibilities are provided for with the help of
32062 additional separators &`==`& and &`=&&`&.
32063
32064 .ilist
32065 If &`=`& or &`&&`& is used, the condition is true if any one of the looked up
32066 IP addresses matches one of the listed addresses. For the example above, the
32067 condition is true because 127.0.0.1 matches.
32068 .next
32069 If &`==`& or &`=&&`& is used, the condition is true only if every one of the
32070 looked up IP addresses matches one of the listed addresses. If the condition is
32071 changed to:
32072 .code
32073 dnslists = a.b.c==127.0.0.1
32074 .endd
32075 and the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
32076 false because 127.0.0.2 is not listed. You would need to have:
32077 .code
32078 dnslists = a.b.c==127.0.0.1,127.0.0.2
32079 .endd
32080 for the condition to be true.
32081 .endlist
32082
32083 When &`!`& is used to negate IP address matching, it inverts the result, giving
32084 the precise opposite of the behaviour above. Thus:
32085 .ilist
32086 If &`!=`& or &`!&&`& is used, the condition is true if none of the looked up IP
32087 addresses matches one of the listed addresses. Consider:
32088 .code
32089 dnslists = a.b.c!&0.0.0.1
32090 .endd
32091 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
32092 false because 127.0.0.1 matches.
32093 .next
32094 If &`!==`& or &`!=&&`& is used, the condition is true if there is at least one
32095 looked up IP address that does not match. Consider:
32096 .code
32097 dnslists = a.b.c!=&0.0.0.1
32098 .endd
32099 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
32100 true, because 127.0.0.2 does not match. You would need to have:
32101 .code
32102 dnslists = a.b.c!=&0.0.0.1,0.0.0.2
32103 .endd
32104 for the condition to be false.
32105 .endlist
32106 When the DNS lookup yields only a single IP address, there is no difference
32107 between &`=`& and &`==`& and between &`&&`& and &`=&&`&.
32108
32109
32110
32111
32112 .section "Detailed information from merged DNS lists" "SECTmordetinf"
32113 .cindex "DNS list" "information from merged"
32114 When the facility for restricting the matching IP values in a DNS list is used,
32115 the text from the TXT record that is set in &$dnslist_text$& may not reflect
32116 the true reason for rejection. This happens when lists are merged and the IP
32117 address in the A record is used to distinguish them; unfortunately there is
32118 only one TXT record. One way round this is not to use merged lists, but that
32119 can be inefficient because it requires multiple DNS lookups where one would do
32120 in the vast majority of cases when the host of interest is not on any of the
32121 lists.
32122
32123 A less inefficient way of solving this problem is available. If
32124 two domain names, comma-separated, are given, the second is used first to
32125 do an initial check, making use of any IP value restrictions that are set.
32126 If there is a match, the first domain is used, without any IP value
32127 restrictions, to get the TXT record. As a byproduct of this, there is also
32128 a check that the IP being tested is indeed on the first list. The first
32129 domain is the one that is put in &$dnslist_domain$&. For example:
32130 .code
32131 deny message  = \
32132          rejected because $sender_host_address is blacklisted \
32133          at $dnslist_domain\n$dnslist_text
32134        dnslists = \
32135          sbl.spamhaus.org,sbl-xbl.spamhaus.org=127.0.0.2 : \
32136          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
32137 .endd
32138 For the first blacklist item, this starts by doing a lookup in
32139 &'sbl-xbl.spamhaus.org'& and testing for a 127.0.0.2 return. If there is a
32140 match, it then looks in &'sbl.spamhaus.org'&, without checking the return
32141 value, and as long as something is found, it looks for the corresponding TXT
32142 record. If there is no match in &'sbl-xbl.spamhaus.org'&, nothing more is done.
32143 The second blacklist item is processed similarly.
32144
32145 If you are interested in more than one merged list, the same list must be
32146 given several times, but because the results of the DNS lookups are cached,
32147 the DNS calls themselves are not repeated. For example:
32148 .code
32149 deny dnslists = \
32150          http.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.2 : \
32151          socks.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.3 : \
32152          misc.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.4 : \
32153          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
32154 .endd
32155 In this case there is one lookup in &'dnsbl.sorbs.net'&, and if none of the IP
32156 values matches (or if no record is found), this is the only lookup that is
32157 done. Only if there is a match is one of the more specific lists consulted.
32158
32159
32160
32161 .section "DNS lists and IPv6" "SECTmorednslistslast"
32162 .cindex "IPv6" "DNS black lists"
32163 .cindex "DNS list" "IPv6 usage"
32164 If Exim is asked to do a dnslist lookup for an IPv6 address, it inverts it
32165 nibble by nibble. For example, if the calling host's IP address is
32166 3ffe:ffff:836f:0a00:000a:0800:200a:c031, Exim might look up
32167 .code
32168 1.3.0.c.a.0.0.2.0.0.8.0.a.0.0.0.0.0.a.0.f.6.3.8.
32169   f.f.f.f.e.f.f.3.blackholes.mail-abuse.org
32170 .endd
32171 (split over two lines here to fit on the page). Unfortunately, some of the DNS
32172 lists contain wildcard records, intended for IPv4, that interact badly with
32173 IPv6. For example, the DNS entry
32174 .code
32175 *.3.some.list.example.    A    127.0.0.1
32176 .endd
32177 is probably intended to put the entire 3.0.0.0/8 IPv4 network on the list.
32178 Unfortunately, it also matches the entire 3::/4 IPv6 network.
32179
32180 You can exclude IPv6 addresses from DNS lookups by making use of a suitable
32181 &%condition%& condition, as in this example:
32182 .code
32183 deny   condition = ${if isip4{$sender_host_address}}
32184        dnslists  = some.list.example
32185 .endd
32186
32187 If an explicit key is being used for a DNS lookup and it may be an IPv6
32188 address you should specify alternate list separators for both the outer
32189 (DNS list name) list and inner (lookup keys) list:
32190 .code
32191        dnslists = <; dnsbl.example.com/<|$acl_m_addrslist
32192 .endd
32193
32194 .section "Rate limiting incoming messages" "SECTratelimiting"
32195 .cindex "rate limiting" "client sending"
32196 .cindex "limiting client sending rates"
32197 .oindex "&%smtp_ratelimit_*%&"
32198 The &%ratelimit%& ACL condition can be used to measure and control the rate at
32199 which clients can send email. This is more powerful than the
32200 &%smtp_ratelimit_*%& options, because those options control the rate of
32201 commands in a single SMTP session only, whereas the &%ratelimit%& condition
32202 works across all connections (concurrent and sequential) from the same client
32203 host. The syntax of the &%ratelimit%& condition is:
32204 .display
32205 &`ratelimit =`& <&'m'&> &`/`& <&'p'&> &`/`& <&'options'&> &`/`& <&'key'&>
32206 .endd
32207 If the average client sending rate is less than &'m'& messages per time
32208 period &'p'& then the condition is false; otherwise it is true.
32209
32210 As a side-effect, the &%ratelimit%& condition sets the expansion variable
32211 &$sender_rate$& to the client's computed rate, &$sender_rate_limit$& to the
32212 configured value of &'m'&, and &$sender_rate_period$& to the configured value
32213 of &'p'&.
32214
32215 The parameter &'p'& is the smoothing time constant, in the form of an Exim
32216 time interval, for example, &`8h`& for eight hours. A larger time constant
32217 means that it takes Exim longer to forget a client's past behaviour. The
32218 parameter &'m'& is the maximum number of messages that a client is permitted to
32219 send in each time interval. It also specifies the number of messages permitted
32220 in a fast burst. By increasing both &'m'& and &'p'& but keeping &'m/p'&
32221 constant, you can allow a client to send more messages in a burst without
32222 changing its long-term sending rate limit. Conversely, if &'m'& and &'p'& are
32223 both small, messages must be sent at an even rate.
32224
32225 There is a script in &_util/ratelimit.pl_& which extracts sending rates from
32226 log files, to assist with choosing appropriate settings for &'m'& and &'p'&
32227 when deploying the &%ratelimit%& ACL condition. The script prints usage
32228 instructions when it is run with no arguments.
32229
32230 The key is used to look up the data for calculating the client's average
32231 sending rate. This data is stored in Exim's spool directory, alongside the
32232 retry and other hints databases. The default key is &$sender_host_address$&,
32233 which means Exim computes the sending rate of each client host IP address.
32234 By changing the key you can change how Exim identifies clients for the purpose
32235 of ratelimiting. For example, to limit the sending rate of each authenticated
32236 user, independent of the computer they are sending from, set the key to
32237 &$authenticated_id$&. You must ensure that the lookup key is meaningful; for
32238 example, &$authenticated_id$& is only meaningful if the client has
32239 authenticated (which you can check with the &%authenticated%& ACL condition).
32240
32241 The lookup key does not have to identify clients: If you want to limit the
32242 rate at which a recipient receives messages, you can use the key
32243 &`$local_part@$domain`& with the &%per_rcpt%& option (see below) in a RCPT
32244 ACL.
32245
32246 Each &%ratelimit%& condition can have up to four options. A &%per_*%& option
32247 specifies what Exim measures the rate of, for example, messages or recipients
32248 or bytes. You can adjust the measurement using the &%unique=%& and/or
32249 &%count=%& options. You can also control when Exim updates the recorded rate
32250 using a &%strict%&, &%leaky%&, or &%readonly%& option. The options are
32251 separated by a slash, like the other parameters. They may appear in any order.
32252
32253 Internally, Exim appends the smoothing constant &'p'& onto the lookup key with
32254 any options that alter the meaning of the stored data. The limit &'m'& is not
32255 stored, so you can alter the configured maximum rate and Exim will still
32256 remember clients' past behaviour. If you change the &%per_*%& mode or add or
32257 remove the &%unique=%& option, the lookup key changes so Exim will forget past
32258 behaviour. The lookup key is not affected by changes to the update mode and
32259 the &%count=%& option.
32260
32261
32262 .section "Ratelimit options for what is being measured" "ratoptmea"
32263 .cindex "rate limiting" "per_* options"
32264 The &%per_conn%& option limits the client's connection rate. It is not
32265 normally used in the &%acl_not_smtp%&, &%acl_not_smtp_mime%&, or
32266 &%acl_not_smtp_start%& ACLs.
32267
32268 The &%per_mail%& option limits the client's rate of sending messages. This is
32269 the default if none of the &%per_*%& options is specified. It can be used in
32270 &%acl_smtp_mail%&, &%acl_smtp_rcpt%&, &%acl_smtp_predata%&, &%acl_smtp_mime%&,
32271 &%acl_smtp_data%&, or &%acl_not_smtp%&.
32272
32273 The &%per_byte%& option limits the sender's email bandwidth. It can be used in
32274 the same ACLs as the &%per_mail%& option, though it is best to use this option
32275 in the &%acl_smtp_mime%&, &%acl_smtp_data%& or &%acl_not_smtp%& ACLs; if it is
32276 used in an earlier ACL, Exim relies on the SIZE parameter given by the client
32277 in its MAIL command, which may be inaccurate or completely missing. You can
32278 follow the limit &'m'& in the configuration with K, M, or G to specify limits
32279 in kilobytes, megabytes, or gigabytes, respectively.
32280
32281 The &%per_rcpt%& option causes Exim to limit the rate at which recipients are
32282 accepted. It can be used in the &%acl_smtp_rcpt%&, &%acl_smtp_predata%&,
32283 &%acl_smtp_mime%&, &%acl_smtp_data%&, or &%acl_smtp_rcpt%& ACLs. In
32284 &%acl_smtp_rcpt%& the rate is updated one recipient at a time; in the other
32285 ACLs the rate is updated with the total (accepted) recipient count in one go. Note that
32286 in either case the rate limiting engine will see a message with many
32287 recipients as a large high-speed burst.
32288
32289 The &%per_addr%& option is like the &%per_rcpt%& option, except it counts the
32290 number of different recipients that the client has sent messages to in the
32291 last time period. That is, if the client repeatedly sends messages to the same
32292 recipient, its measured rate is not increased. This option can only be used in
32293 &%acl_smtp_rcpt%&.
32294
32295 The &%per_cmd%& option causes Exim to recompute the rate every time the
32296 condition is processed. This can be used to limit the rate of any SMTP
32297 command. If it is used in multiple ACLs it can limit the aggregate rate of
32298 multiple different commands.
32299
32300 The &%count=%& option can be used to alter how much Exim adds to the client's
32301 measured rate. For example, the &%per_byte%& option is equivalent to
32302 &`per_mail/count=$message_size`&. If there is no &%count=%& option, Exim
32303 increases the measured rate by one (except for the &%per_rcpt%& option in ACLs
32304 other than &%acl_smtp_rcpt%&). The count does not have to be an integer.
32305
32306 The &%unique=%& option is described in section &<<ratoptuniq>>& below.
32307
32308
32309 .section "Ratelimit update modes" "ratoptupd"
32310 .cindex "rate limiting" "reading data without updating"
32311 You can specify one of three options with the &%ratelimit%& condition to
32312 control when its database is updated. This section describes the &%readonly%&
32313 mode, and the next section describes the &%strict%& and &%leaky%& modes.
32314
32315 If the &%ratelimit%& condition is used in &%readonly%& mode, Exim looks up a
32316 previously-computed rate to check against the limit.
32317
32318 For example, you can test the client's sending rate and deny it access (when
32319 it is too fast) in the connect ACL. If the client passes this check then it
32320 can go on to send a message, in which case its recorded rate will be updated
32321 in the MAIL ACL. Subsequent connections from the same client will check this
32322 new rate.
32323 .code
32324 acl_check_connect:
32325  deny ratelimit = 100 / 5m / readonly
32326     log_message = RATE CHECK: $sender_rate/$sender_rate_period \
32327                   (max $sender_rate_limit)
32328 # ...
32329 acl_check_mail:
32330  warn ratelimit = 100 / 5m / strict
32331     log_message = RATE UPDATE: $sender_rate/$sender_rate_period \
32332                   (max $sender_rate_limit)
32333 .endd
32334
32335 If Exim encounters multiple &%ratelimit%& conditions with the same key when
32336 processing a message then it may increase the client's measured rate more than
32337 it should. For example, this will happen if you check the &%per_rcpt%& option
32338 in both &%acl_smtp_rcpt%& and &%acl_smtp_data%&. However it's OK to check the
32339 same &%ratelimit%& condition multiple times in the same ACL. You can avoid any
32340 multiple update problems by using the &%readonly%& option on later ratelimit
32341 checks.
32342
32343 The &%per_*%& options described above do not make sense in some ACLs. If you
32344 use a &%per_*%& option in an ACL where it is not normally permitted then the
32345 update mode defaults to &%readonly%& and you cannot specify the &%strict%& or
32346 &%leaky%& modes. In other ACLs the default update mode is &%leaky%& (see the
32347 next section) so you must specify the &%readonly%& option explicitly.
32348
32349
32350 .section "Ratelimit options for handling fast clients" "ratoptfast"
32351 .cindex "rate limiting" "strict and leaky modes"
32352 If a client's average rate is greater than the maximum, the rate limiting
32353 engine can react in two possible ways, depending on the presence of the
32354 &%strict%& or &%leaky%& update modes. This is independent of the other
32355 counter-measures (such as rejecting the message) that may be specified by the
32356 rest of the ACL.
32357
32358 The &%leaky%& (default) option means that the client's recorded rate is not
32359 updated if it is above the limit. The effect of this is that Exim measures the
32360 client's average rate of successfully sent email,
32361 up to the given limit.
32362 This is appropriate if the countermeasure when the condition is true
32363 consists of refusing the message, and
32364 is generally the better choice if you have clients that retry automatically.
32365 If the action when true is anything more complex then this option is
32366 likely not what is wanted.
32367
32368 The &%strict%& option means that the client's recorded rate is always
32369 updated. The effect of this is that Exim measures the client's average rate
32370 of attempts to send email, which can be much higher than the maximum it is
32371 actually allowed. If the client is over the limit it may be subjected to
32372 counter-measures by the ACL. It must slow down and allow sufficient time to
32373 pass that its computed rate falls below the maximum before it can send email
32374 again. The time (the number of smoothing periods) it must wait and not
32375 attempt to send mail can be calculated with this formula:
32376 .code
32377         ln(peakrate/maxrate)
32378 .endd
32379
32380
32381 .section "Limiting the rate of different events" "ratoptuniq"
32382 .cindex "rate limiting" "counting unique events"
32383 The &%ratelimit%& &%unique=%& option controls a mechanism for counting the
32384 rate of different events. For example, the &%per_addr%& option uses this
32385 mechanism to count the number of different recipients that the client has
32386 sent messages to in the last time period; it is equivalent to
32387 &`per_rcpt/unique=$local_part@$domain`&. You could use this feature to
32388 measure the rate that a client uses different sender addresses with the
32389 options &`per_mail/unique=$sender_address`&.
32390
32391 For each &%ratelimit%& key Exim stores the set of &%unique=%& values that it
32392 has seen for that key. The whole set is thrown away when it is older than the
32393 rate smoothing period &'p'&, so each different event is counted at most once
32394 per period. In the &%leaky%& update mode, an event that causes the client to
32395 go over the limit is not added to the set, in the same way that the client's
32396 recorded rate is not updated in the same situation.
32397
32398 When you combine the &%unique=%& and &%readonly%& options, the specific
32399 &%unique=%& value is ignored, and Exim just retrieves the client's stored
32400 rate.
32401
32402 The &%unique=%& mechanism needs more space in the ratelimit database than the
32403 other &%ratelimit%& options in order to store the event set. The number of
32404 unique values is potentially as large as the rate limit, so the extra space
32405 required increases with larger limits.
32406
32407 The uniqueification is not perfect: there is a small probability that Exim
32408 will think a new event has happened before. If the sender's rate is less than
32409 the limit, Exim should be more than 99.9% correct. However in &%strict%& mode
32410 the measured rate can go above the limit, in which case Exim may under-count
32411 events by a significant margin. Fortunately, if the rate is high enough (2.7
32412 times the limit) that the false positive rate goes above 9%, then Exim will
32413 throw away the over-full event set before the measured rate falls below the
32414 limit. Therefore the only harm should be that exceptionally high sending rates
32415 are logged incorrectly; any countermeasures you configure will be as effective
32416 as intended.
32417
32418
32419 .section "Using rate limiting" "useratlim"
32420 Exim's other ACL facilities are used to define what counter-measures are taken
32421 when the rate limit is exceeded. This might be anything from logging a warning
32422 (for example, while measuring existing sending rates in order to define
32423 policy), through time delays to slow down fast senders, up to rejecting the
32424 message. For example:
32425 .code
32426 # Log all senders' rates
32427 warn ratelimit = 0 / 1h / strict
32428      log_message = Sender rate $sender_rate / $sender_rate_period
32429
32430 # Slow down fast senders; note the need to truncate $sender_rate
32431 # at the decimal point.
32432 warn ratelimit = 100 / 1h / per_rcpt / strict
32433      delay     = ${eval: ${sg{$sender_rate}{[.].*}{}} - \
32434                    $sender_rate_limit }s
32435
32436 # Keep authenticated users under control
32437 deny authenticated = *
32438      ratelimit = 100 / 1d / strict / $authenticated_id
32439
32440 # System-wide rate limit
32441 defer message = Sorry, too busy. Try again later.
32442      ratelimit = 10 / 1s / $primary_hostname
32443
32444 # Restrict incoming rate from each host, with a default
32445 # set using a macro and special cases looked up in a table.
32446 defer message = Sender rate exceeds $sender_rate_limit \
32447                messages per $sender_rate_period
32448      ratelimit = ${lookup {$sender_host_address} \
32449                    cdb {DB/ratelimits.cdb} \
32450                    {$value} {RATELIMIT} }
32451 .endd
32452 &*Warning*&: If you have a busy server with a lot of &%ratelimit%& tests,
32453 especially with the &%per_rcpt%& option, you may suffer from a performance
32454 bottleneck caused by locking on the ratelimit hints database. Apart from
32455 making your ACLs less complicated, you can reduce the problem by using a
32456 RAM disk for Exim's hints directory (usually &_/var/spool/exim/db/_&). However
32457 this means that Exim will lose its hints data after a reboot (including retry
32458 hints, the callout cache, and ratelimit data).
32459
32460
32461
32462 .section "Address verification" "SECTaddressverification"
32463 .cindex "verifying address" "options for"
32464 .cindex "policy control" "address verification"
32465 Several of the &%verify%& conditions described in section
32466 &<<SECTaclconditions>>& cause addresses to be verified. Section
32467 &<<SECTsenaddver>>& discusses the reporting of sender verification failures.
32468 The verification conditions can be followed by options that modify the
32469 verification process. The options are separated from the keyword and from each
32470 other by slashes, and some of them contain parameters. For example:
32471 .code
32472 verify = sender/callout
32473 verify = recipient/defer_ok/callout=10s,defer_ok
32474 .endd
32475 The first stage of address verification, which always happens, is to run the
32476 address through the routers, in &"verify mode"&. Routers can detect the
32477 difference between verification and routing for delivery, and their actions can
32478 be varied by a number of generic options such as &%verify%& and &%verify_only%&
32479 (see chapter &<<CHAProutergeneric>>&). If routing fails, verification fails.
32480 The available options are as follows:
32481
32482 .ilist
32483 If the &%callout%& option is specified, successful routing to one or more
32484 remote hosts is followed by a &"callout"& to those hosts as an additional
32485 check. Callouts and their sub-options are discussed in the next section.
32486 .next
32487 If there is a defer error while doing verification routing, the ACL
32488 normally returns &"defer"&. However, if you include &%defer_ok%& in the
32489 options, the condition is forced to be true instead. Note that this is a main
32490 verification option as well as a suboption for callouts.
32491 .next
32492 The &%no_details%& option is covered in section &<<SECTsenaddver>>&, which
32493 discusses the reporting of sender address verification failures.
32494 .next
32495 The &%success_on_redirect%& option causes verification always to succeed
32496 immediately after a successful redirection. By default, if a redirection
32497 generates just one address, that address is also verified. See further
32498 discussion in section &<<SECTredirwhilveri>>&.
32499 .endlist
32500
32501 .cindex "verifying address" "differentiating failures"
32502 .vindex "&$recipient_verify_failure$&"
32503 .vindex "&$sender_verify_failure$&"
32504 .vindex "&$acl_verify_message$&"
32505 After an address verification failure, &$acl_verify_message$& contains the
32506 error message that is associated with the failure. It can be preserved by
32507 coding like this:
32508 .code
32509 warn  !verify = sender
32510        set acl_m0 = $acl_verify_message
32511 .endd
32512 If you are writing your own custom rejection message or log message when
32513 denying access, you can use this variable to include information about the
32514 verification failure.
32515
32516 In addition, &$sender_verify_failure$& or &$recipient_verify_failure$& (as
32517 appropriate) contains one of the following words:
32518
32519 .ilist
32520 &%qualify%&: The address was unqualified (no domain), and the message
32521 was neither local nor came from an exempted host.
32522 .next
32523 &%route%&: Routing failed.
32524 .next
32525 &%mail%&: Routing succeeded, and a callout was attempted; rejection
32526 occurred at or before the MAIL command (that is, on initial
32527 connection, HELO, or MAIL).
32528 .next
32529 &%recipient%&: The RCPT command in a callout was rejected.
32530 .next
32531 &%postmaster%&: The postmaster check in a callout was rejected.
32532 .endlist
32533
32534 The main use of these variables is expected to be to distinguish between
32535 rejections of MAIL and rejections of RCPT in callouts.
32536
32537 The above variables may also be set after a &*successful*&
32538 address verification to:
32539
32540 .ilist
32541 &%random%&: A random local-part callout succeeded
32542 .endlist
32543
32544
32545
32546
32547 .section "Callout verification" "SECTcallver"
32548 .cindex "verifying address" "by callout"
32549 .cindex "callout" "verification"
32550 .cindex "SMTP" "callout verification"
32551 For non-local addresses, routing verifies the domain, but is unable to do any
32552 checking of the local part. There are situations where some means of verifying
32553 the local part is desirable. One way this can be done is to make an SMTP
32554 &'callback'& to a delivery host for the sender address or a &'callforward'& to
32555 a subsequent host for a recipient address, to see if the host accepts the
32556 address. We use the term &'callout'& to cover both cases. Note that for a
32557 sender address, the callback is not to the client host that is trying to
32558 deliver the message, but to one of the hosts that accepts incoming mail for the
32559 sender's domain.
32560
32561 Exim does not do callouts by default. If you want them to happen, you must
32562 request them by setting appropriate options on the &%verify%& condition, as
32563 described below. This facility should be used with care, because it can add a
32564 lot of resource usage to the cost of verifying an address. However, Exim does
32565 cache the results of callouts, which helps to reduce the cost. Details of
32566 caching are in section &<<SECTcallvercache>>&.
32567
32568 Recipient callouts are usually used only between hosts that are controlled by
32569 the same administration. For example, a corporate gateway host could use
32570 callouts to check for valid recipients on an internal mailserver. A successful
32571 callout does not guarantee that a real delivery to the address would succeed;
32572 on the other hand, a failing callout does guarantee that a delivery would fail.
32573
32574 If the &%callout%& option is present on a condition that verifies an address, a
32575 second stage of verification occurs if the address is successfully routed to
32576 one or more remote hosts. The usual case is routing by a &(dnslookup)& or a
32577 &(manualroute)& router, where the router specifies the hosts. However, if a
32578 router that does not set up hosts routes to an &(smtp)& transport with a
32579 &%hosts%& setting, the transport's hosts are used. If an &(smtp)& transport has
32580 &%hosts_override%& set, its hosts are always used, whether or not the router
32581 supplies a host list.
32582 Callouts are only supported on &(smtp)& transports.
32583
32584 The port that is used is taken from the transport, if it is specified and is a
32585 remote transport. (For routers that do verification only, no transport need be
32586 specified.) Otherwise, the default SMTP port is used. If a remote transport
32587 specifies an outgoing interface, this is used; otherwise the interface is not
32588 specified. Likewise, the text that is used for the HELO command is taken from
32589 the transport's &%helo_data%& option; if there is no transport, the value of
32590 &$smtp_active_hostname$& is used.
32591
32592 For a sender callout check, Exim makes SMTP connections to the remote hosts, to
32593 test whether a bounce message could be delivered to the sender address. The
32594 following SMTP commands are sent:
32595 .display
32596 &`HELO `&<&'local host name'&>
32597 &`MAIL FROM:<>`&
32598 &`RCPT TO:`&<&'the address to be tested'&>
32599 &`QUIT`&
32600 .endd
32601 LHLO is used instead of HELO if the transport's &%protocol%& option is
32602 set to &"lmtp"&.
32603
32604 The callout may use EHLO, AUTH and/or STARTTLS given appropriate option
32605 settings.
32606
32607 A recipient callout check is similar. By default, it also uses an empty address
32608 for the sender. This default is chosen because most hosts do not make use of
32609 the sender address when verifying a recipient. Using the same address means
32610 that a single cache entry can be used for each recipient. Some sites, however,
32611 do make use of the sender address when verifying. These are catered for by the
32612 &%use_sender%& and &%use_postmaster%& options, described in the next section.
32613
32614 If the response to the RCPT command is a 2&'xx'& code, the verification
32615 succeeds. If it is 5&'xx'&, the verification fails. For any other condition,
32616 Exim tries the next host, if any. If there is a problem with all the remote
32617 hosts, the ACL yields &"defer"&, unless the &%defer_ok%& parameter of the
32618 &%callout%& option is given, in which case the condition is forced to succeed.
32619
32620 .cindex "SMTP" "output flushing, disabling for callout"
32621 A callout may take a little time. For this reason, Exim normally flushes SMTP
32622 output before performing a callout in an ACL, to avoid unexpected timeouts in
32623 clients when the SMTP PIPELINING extension is in use. The flushing can be
32624 disabled by using a &%control%& modifier to set &%no_callout_flush%&.
32625
32626
32627
32628
32629 .section "Additional parameters for callouts" "CALLaddparcall"
32630 .cindex "callout" "additional parameters for"
32631 The &%callout%& option can be followed by an equals sign and a number of
32632 optional parameters, separated by commas. For example:
32633 .code
32634 verify = recipient/callout=10s,defer_ok
32635 .endd
32636 The old syntax, which had &%callout_defer_ok%& and &%check_postmaster%& as
32637 separate verify options, is retained for backwards compatibility, but is now
32638 deprecated. The additional parameters for &%callout%& are as follows:
32639
32640
32641 .vlist
32642 .vitem <&'a&~time&~interval'&>
32643 .cindex "callout" "timeout, specifying"
32644 This specifies the timeout that applies for the callout attempt to each host.
32645 For example:
32646 .code
32647 verify = sender/callout=5s
32648 .endd
32649 The default is 30 seconds. The timeout is used for each response from the
32650 remote host. It is also used for the initial connection, unless overridden by
32651 the &%connect%& parameter.
32652
32653
32654 .vitem &*connect&~=&~*&<&'time&~interval'&>
32655 .cindex "callout" "connection timeout, specifying"
32656 This parameter makes it possible to set a different (usually smaller) timeout
32657 for making the SMTP connection. For example:
32658 .code
32659 verify = sender/callout=5s,connect=1s
32660 .endd
32661 If not specified, this timeout defaults to the general timeout value.
32662
32663 .vitem &*defer_ok*&
32664 .cindex "callout" "defer, action on"
32665 When this parameter is present, failure to contact any host, or any other kind
32666 of temporary error, is treated as success by the ACL. However, the cache is not
32667 updated in this circumstance.
32668
32669 .vitem &*fullpostmaster*&
32670 .cindex "callout" "full postmaster check"
32671 This operates like the &%postmaster%& option (see below), but if the check for
32672 &'postmaster@domain'& fails, it tries just &'postmaster'&, without a domain, in
32673 accordance with the specification in RFC 2821. The RFC states that the
32674 unqualified address &'postmaster'& should be accepted.
32675
32676
32677 .vitem &*mailfrom&~=&~*&<&'email&~address'&>
32678 .cindex "callout" "sender when verifying header"
32679 When verifying addresses in header lines using the &%header_sender%&
32680 verification option, Exim behaves by default as if the addresses are envelope
32681 sender addresses from a message. Callout verification therefore tests to see
32682 whether a bounce message could be delivered, by using an empty address in the
32683 MAIL command. However, it is arguable that these addresses might never be used
32684 as envelope senders, and could therefore justifiably reject bounce messages
32685 (empty senders). The &%mailfrom%& callout parameter allows you to specify what
32686 address to use in the MAIL command. For example:
32687 .code
32688 require  verify = header_sender/callout=mailfrom=abcd@x.y.z
32689 .endd
32690 This parameter is available only for the &%header_sender%& verification option.
32691
32692
32693 .vitem &*maxwait&~=&~*&<&'time&~interval'&>
32694 .cindex "callout" "overall timeout, specifying"
32695 This parameter sets an overall timeout for performing a callout verification.
32696 For example:
32697 .code
32698 verify = sender/callout=5s,maxwait=30s
32699 .endd
32700 This timeout defaults to four times the callout timeout for individual SMTP
32701 commands. The overall timeout applies when there is more than one host that can
32702 be tried. The timeout is checked before trying the next host. This prevents
32703 very long delays if there are a large number of hosts and all are timing out
32704 (for example, when network connections are timing out).
32705
32706
32707 .vitem &*no_cache*&
32708 .cindex "callout" "cache, suppressing"
32709 .cindex "caching callout, suppressing"
32710 When this parameter is given, the callout cache is neither read nor updated.
32711
32712 .vitem &*postmaster*&
32713 .cindex "callout" "postmaster; checking"
32714 When this parameter is set, a successful callout check is followed by a similar
32715 check for the local part &'postmaster'& at the same domain. If this address is
32716 rejected, the callout fails (but see &%fullpostmaster%& above). The result of
32717 the postmaster check is recorded in a cache record; if it is a failure, this is
32718 used to fail subsequent callouts for the domain without a connection being
32719 made, until the cache record expires.
32720
32721 .vitem &*postmaster_mailfrom&~=&~*&<&'email&~address'&>
32722 The postmaster check uses an empty sender in the MAIL command by default.
32723 You can use this parameter to do a postmaster check using a different address.
32724 For example:
32725 .code
32726 require  verify = sender/callout=postmaster_mailfrom=abc@x.y.z
32727 .endd
32728 If both &%postmaster%& and &%postmaster_mailfrom%& are present, the rightmost
32729 one overrides. The &%postmaster%& parameter is equivalent to this example:
32730 .code
32731 require  verify = sender/callout=postmaster_mailfrom=
32732 .endd
32733 &*Warning*&: The caching arrangements for postmaster checking do not take
32734 account of the sender address. It is assumed that either the empty address or
32735 a fixed non-empty address will be used. All that Exim remembers is that the
32736 postmaster check for the domain succeeded or failed.
32737
32738
32739 .vitem &*random*&
32740 .cindex "callout" "&""random""& check"
32741 When this parameter is set, before doing the normal callout check, Exim does a
32742 check for a &"random"& local part at the same domain. The local part is not
32743 really random &-- it is defined by the expansion of the option
32744 &%callout_random_local_part%&, which defaults to
32745 .code
32746 $primary_hostname-$tod_epoch-testing
32747 .endd
32748 The idea here is to try to determine whether the remote host accepts all local
32749 parts without checking. If it does, there is no point in doing callouts for
32750 specific local parts. If the &"random"& check succeeds, the result is saved in
32751 a cache record, and used to force the current and subsequent callout checks to
32752 succeed without a connection being made, until the cache record expires.
32753
32754 .vitem &*use_postmaster*&
32755 .cindex "callout" "sender for recipient check"
32756 This parameter applies to recipient callouts only. For example:
32757 .code
32758 deny  !verify = recipient/callout=use_postmaster
32759 .endd
32760 .vindex "&$qualify_domain$&"
32761 It causes a non-empty postmaster address to be used in the MAIL command when
32762 performing the callout for the recipient, and also for a &"random"& check if
32763 that is configured. The local part of the address is &`postmaster`& and the
32764 domain is the contents of &$qualify_domain$&.
32765
32766 .vitem &*use_sender*&
32767 This option applies to recipient callouts only. For example:
32768 .code
32769 require  verify = recipient/callout=use_sender
32770 .endd
32771 It causes the message's actual sender address to be used in the MAIL
32772 command when performing the callout, instead of an empty address. There is no
32773 need to use this option unless you know that the called hosts make use of the
32774 sender when checking recipients. If used indiscriminately, it reduces the
32775 usefulness of callout caching.
32776
32777 .vitem &*hold*&
32778 This option applies to recipient callouts only. For example:
32779 .code
32780 require  verify = recipient/callout=use_sender,hold
32781 .endd
32782 It causes the connection to be held open and used for any further recipients
32783 and for eventual delivery (should that be done quickly).
32784 Doing this saves on TCP and SMTP startup costs, and TLS costs also
32785 when that is used for the connections.
32786 The advantage is only gained if there are no callout cache hits
32787 (which could be enforced by the no_cache option),
32788 if the use_sender option is used,
32789 if neither the random nor the use_postmaster option is used,
32790 and if no other callouts intervene.
32791 .endlist
32792
32793 If you use any of the parameters that set a non-empty sender for the MAIL
32794 command (&%mailfrom%&, &%postmaster_mailfrom%&, &%use_postmaster%&, or
32795 &%use_sender%&), you should think about possible loops. Recipient checking is
32796 usually done between two hosts that are under the same management, and the host
32797 that receives the callouts is not normally configured to do callouts itself.
32798 Therefore, it is normally safe to use &%use_postmaster%& or &%use_sender%& in
32799 these circumstances.
32800
32801 However, if you use a non-empty sender address for a callout to an arbitrary
32802 host, there is the likelihood that the remote host will itself initiate a
32803 callout check back to your host. As it is checking what appears to be a message
32804 sender, it is likely to use an empty address in MAIL, thus avoiding a
32805 callout loop. However, to be on the safe side it would be best to set up your
32806 own ACLs so that they do not do sender verification checks when the recipient
32807 is the address you use for header sender or postmaster callout checking.
32808
32809 Another issue to think about when using non-empty senders for callouts is
32810 caching. When you set &%mailfrom%& or &%use_sender%&, the cache record is keyed
32811 by the sender/recipient combination; thus, for any given recipient, many more
32812 actual callouts are performed than when an empty sender or postmaster is used.
32813
32814
32815
32816
32817 .section "Callout caching" "SECTcallvercache"
32818 .cindex "hints database" "callout cache"
32819 .cindex "callout" "cache, description of"
32820 .cindex "caching" "callout"
32821 Exim caches the results of callouts in order to reduce the amount of resources
32822 used, unless you specify the &%no_cache%& parameter with the &%callout%&
32823 option. A hints database called &"callout"& is used for the cache. Two
32824 different record types are used: one records the result of a callout check for
32825 a specific address, and the other records information that applies to the
32826 entire domain (for example, that it accepts the local part &'postmaster'&).
32827
32828 When an original callout fails, a detailed SMTP error message is given about
32829 the failure. However, for subsequent failures use the cache data, this message
32830 is not available.
32831
32832 The expiry times for negative and positive address cache records are
32833 independent, and can be set by the global options &%callout_negative_expire%&
32834 (default 2h) and &%callout_positive_expire%& (default 24h), respectively.
32835
32836 If a host gives a negative response to an SMTP connection, or rejects any
32837 commands up to and including
32838 .code
32839 MAIL FROM:<>
32840 .endd
32841 (but not including the MAIL command with a non-empty address),
32842 any callout attempt is bound to fail. Exim remembers such failures in a
32843 domain cache record, which it uses to fail callouts for the domain without
32844 making new connections, until the domain record times out. There are two
32845 separate expiry times for domain cache records:
32846 &%callout_domain_negative_expire%& (default 3h) and
32847 &%callout_domain_positive_expire%& (default 7d).
32848
32849 Domain records expire when the negative expiry time is reached if callouts
32850 cannot be made for the domain, or if the postmaster check failed.
32851 Otherwise, they expire when the positive expiry time is reached. This
32852 ensures that, for example, a host that stops accepting &"random"& local parts
32853 will eventually be noticed.
32854
32855 The callout caching mechanism is based on the domain of the address that is
32856 being tested. If the domain routes to several hosts, it is assumed that their
32857 behaviour will be the same.
32858
32859
32860
32861 .section "Sender address verification reporting" "SECTsenaddver"
32862 .cindex "verifying" "suppressing error details"
32863 See section &<<SECTaddressverification>>& for a general discussion of
32864 verification. When sender verification fails in an ACL, the details of the
32865 failure are given as additional output lines before the 550 response to the
32866 relevant SMTP command (RCPT or DATA). For example, if sender callout is in use,
32867 you might see:
32868 .code
32869 MAIL FROM:<xyz@abc.example>
32870 250 OK
32871 RCPT TO:<pqr@def.example>
32872 550-Verification failed for <xyz@abc.example>
32873 550-Called:   192.168.34.43
32874 550-Sent:     RCPT TO:<xyz@abc.example>
32875 550-Response: 550 Unknown local part xyz in <xyz@abc.example>
32876 550 Sender verification failed
32877 .endd
32878 If more than one RCPT command fails in the same way, the details are given
32879 only for the first of them. However, some administrators do not want to send
32880 out this much information. You can suppress the details by adding
32881 &`/no_details`& to the ACL statement that requests sender verification. For
32882 example:
32883 .code
32884 verify = sender/no_details
32885 .endd
32886
32887 .section "Redirection while verifying" "SECTredirwhilveri"
32888 .cindex "verifying" "redirection while"
32889 .cindex "address redirection" "while verifying"
32890 A dilemma arises when a local address is redirected by aliasing or forwarding
32891 during verification: should the generated addresses themselves be verified,
32892 or should the successful expansion of the original address be enough to verify
32893 it? By default, Exim takes the following pragmatic approach:
32894
32895 .ilist
32896 When an incoming address is redirected to just one child address, verification
32897 continues with the child address, and if that fails to verify, the original
32898 verification also fails.
32899 .next
32900 When an incoming address is redirected to more than one child address,
32901 verification does not continue. A success result is returned.
32902 .endlist
32903
32904 This seems the most reasonable behaviour for the common use of aliasing as a
32905 way of redirecting different local parts to the same mailbox. It means, for
32906 example, that a pair of alias entries of the form
32907 .code
32908 A.Wol:   aw123
32909 aw123:   :fail: Gone away, no forwarding address
32910 .endd
32911 work as expected, with both local parts causing verification failure. When a
32912 redirection generates more than one address, the behaviour is more like a
32913 mailing list, where the existence of the alias itself is sufficient for
32914 verification to succeed.
32915
32916 It is possible, however, to change the default behaviour so that all successful
32917 redirections count as successful verifications, however many new addresses are
32918 generated. This is specified by the &%success_on_redirect%& verification
32919 option. For example:
32920 .code
32921 require verify = recipient/success_on_redirect/callout=10s
32922 .endd
32923 In this example, verification succeeds if a router generates a new address, and
32924 the callout does not occur, because no address was routed to a remote host.
32925
32926 When verification is being tested via the &%-bv%& option, the treatment of
32927 redirections is as just described, unless the &%-v%& or any debugging option is
32928 also specified. In that case, full verification is done for every generated
32929 address and a report is output for each of them.
32930
32931
32932
32933 .section "Client SMTP authorization (CSA)" "SECTverifyCSA"
32934 .cindex "CSA" "verifying"
32935 Client SMTP Authorization is a system that allows a site to advertise
32936 which machines are and are not permitted to send email. This is done by placing
32937 special SRV records in the DNS; these are looked up using the client's HELO
32938 domain. At the time of writing, CSA is still an Internet Draft. Client SMTP
32939 Authorization checks in Exim are performed by the ACL condition:
32940 .code
32941 verify = csa
32942 .endd
32943 This fails if the client is not authorized. If there is a DNS problem, or if no
32944 valid CSA SRV record is found, or if the client is authorized, the condition
32945 succeeds. These three cases can be distinguished using the expansion variable
32946 &$csa_status$&, which can take one of the values &"fail"&, &"defer"&,
32947 &"unknown"&, or &"ok"&. The condition does not itself defer because that would
32948 be likely to cause problems for legitimate email.
32949
32950 The error messages produced by the CSA code include slightly more
32951 detail. If &$csa_status$& is &"defer"&, this may be because of problems
32952 looking up the CSA SRV record, or problems looking up the CSA target
32953 address record. There are four reasons for &$csa_status$& being &"fail"&:
32954
32955 .ilist
32956 The client's host name is explicitly not authorized.
32957 .next
32958 The client's IP address does not match any of the CSA target IP addresses.
32959 .next
32960 The client's host name is authorized but it has no valid target IP addresses
32961 (for example, the target's addresses are IPv6 and the client is using IPv4).
32962 .next
32963 The client's host name has no CSA SRV record but a parent domain has asserted
32964 that all subdomains must be explicitly authorized.
32965 .endlist
32966
32967 The &%csa%& verification condition can take an argument which is the domain to
32968 use for the DNS query. The default is:
32969 .code
32970 verify = csa/$sender_helo_name
32971 .endd
32972 This implementation includes an extension to CSA. If the query domain
32973 is an address literal such as [192.0.2.95], or if it is a bare IP
32974 address, Exim searches for CSA SRV records in the reverse DNS as if
32975 the HELO domain was (for example) &'95.2.0.192.in-addr.arpa'&. Therefore it is
32976 meaningful to say:
32977 .code
32978 verify = csa/$sender_host_address
32979 .endd
32980 In fact, this is the check that Exim performs if the client does not say HELO.
32981 This extension can be turned off by setting the main configuration option
32982 &%dns_csa_use_reverse%& to be false.
32983
32984 If a CSA SRV record is not found for the domain itself, a search
32985 is performed through its parent domains for a record which might be
32986 making assertions about subdomains. The maximum depth of this search is limited
32987 using the main configuration option &%dns_csa_search_limit%&, which is 5 by
32988 default. Exim does not look for CSA SRV records in a top level domain, so the
32989 default settings handle HELO domains as long as seven
32990 (&'hostname.five.four.three.two.one.com'&). This encompasses the vast majority
32991 of legitimate HELO domains.
32992
32993 The &'dnsdb'& lookup also has support for CSA. Although &'dnsdb'& also supports
32994 direct SRV lookups, this is not sufficient because of the extra parent domain
32995 search behaviour of CSA, and (as with PTR lookups) &'dnsdb'& also turns IP
32996 addresses into lookups in the reverse DNS space. The result of a successful
32997 lookup such as:
32998 .code
32999 ${lookup dnsdb {csa=$sender_helo_name}}
33000 .endd
33001 has two space-separated fields: an authorization code and a target host name.
33002 The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
33003 authorization required but absent, or &"?"& for unknown.
33004
33005
33006
33007
33008 .section "Bounce address tag validation" "SECTverifyPRVS"
33009 .cindex "BATV, verifying"
33010 Bounce address tag validation (BATV) is a scheme whereby the envelope senders
33011 of outgoing messages have a cryptographic, timestamped &"tag"& added to them.
33012 Genuine incoming bounce messages should therefore always be addressed to
33013 recipients that have a valid tag. This scheme is a way of detecting unwanted
33014 bounce messages caused by sender address forgeries (often called &"collateral
33015 spam"&), because the recipients of such messages do not include valid tags.
33016
33017 There are two expansion items to help with the implementation of the BATV
33018 &"prvs"& (private signature) scheme in an Exim configuration. This scheme signs
33019 the original envelope sender address by using a simple key to add a hash of the
33020 address and some time-based randomizing information. The &%prvs%& expansion
33021 item creates a signed address, and the &%prvscheck%& expansion item checks one.
33022 The syntax of these expansion items is described in section
33023 &<<SECTexpansionitems>>&.
33024 The validity period on signed addresses is seven days.
33025
33026 As an example, suppose the secret per-address keys are stored in an MySQL
33027 database. A query to look up the key for an address could be defined as a macro
33028 like this:
33029 .code
33030 PRVSCHECK_SQL = ${lookup mysql{SELECT secret FROM batv_prvs \
33031                 WHERE sender='${quote_mysql:$prvscheck_address}'\
33032                 }{$value}}
33033 .endd
33034 Suppose also that the senders who make use of BATV are defined by an address
33035 list called &%batv_senders%&. Then, in the ACL for RCPT commands, you could
33036 use this:
33037 .code
33038 # Bounces: drop unsigned addresses for BATV senders
33039 deny message = This address does not send an unsigned reverse path
33040      senders = :
33041      recipients = +batv_senders
33042
33043 # Bounces: In case of prvs-signed address, check signature.
33044 deny message = Invalid reverse path signature.
33045      senders = :
33046      condition  = ${prvscheck {$local_part@$domain}\
33047                   {PRVSCHECK_SQL}{1}}
33048      !condition = $prvscheck_result
33049 .endd
33050 The first statement rejects recipients for bounce messages that are addressed
33051 to plain BATV sender addresses, because it is known that BATV senders do not
33052 send out messages with plain sender addresses. The second statement rejects
33053 recipients that are prvs-signed, but with invalid signatures (either because
33054 the key is wrong, or the signature has timed out).
33055
33056 A non-prvs-signed address is not rejected by the second statement, because the
33057 &%prvscheck%& expansion yields an empty string if its first argument is not a
33058 prvs-signed address, thus causing the &%condition%& condition to be false. If
33059 the first argument is a syntactically valid prvs-signed address, the yield is
33060 the third string (in this case &"1"&), whether or not the cryptographic and
33061 timeout checks succeed. The &$prvscheck_result$& variable contains the result
33062 of the checks (empty for failure, &"1"& for success).
33063
33064 There is one more issue you must consider when implementing prvs-signing:
33065 you have to ensure that the routers accept prvs-signed addresses and
33066 deliver them correctly. The easiest way to handle this is to use a &(redirect)&
33067 router to remove the signature with a configuration along these lines:
33068 .code
33069 batv_redirect:
33070   driver = redirect
33071   data = ${prvscheck {$local_part@$domain}{PRVSCHECK_SQL}}
33072 .endd
33073 This works because, if the third argument of &%prvscheck%& is empty, the result
33074 of the expansion of a prvs-signed address is the decoded value of the original
33075 address. This router should probably be the first of your routers that handles
33076 local addresses.
33077
33078 To create BATV-signed addresses in the first place, a transport of this form
33079 can be used:
33080 .code
33081 external_smtp_batv:
33082   driver = smtp
33083   return_path = ${prvs {$return_path} \
33084                        {${lookup mysql{SELECT \
33085                        secret FROM batv_prvs WHERE \
33086                        sender='${quote_mysql:$sender_address}'} \
33087                        {$value}fail}}}
33088 .endd
33089 If no key can be found for the existing return path, no signing takes place.
33090
33091
33092
33093 .section "Using an ACL to control relaying" "SECTrelaycontrol"
33094 .cindex "&ACL;" "relay control"
33095 .cindex "relaying" "control by ACL"
33096 .cindex "policy control" "relay control"
33097 An MTA is said to &'relay'& a message if it receives it from some host and
33098 delivers it directly to another host as a result of a remote address contained
33099 within it. Redirecting a local address via an alias or forward file and then
33100 passing the message on to another host is not relaying,
33101 .cindex "&""percent hack""&"
33102 but a redirection as a result of the &"percent hack"& is.
33103
33104 Two kinds of relaying exist, which are termed &"incoming"& and &"outgoing"&.
33105 A host which is acting as a gateway or an MX backup is concerned with incoming
33106 relaying from arbitrary hosts to a specific set of domains. On the other hand,
33107 a host which is acting as a smart host for a number of clients is concerned
33108 with outgoing relaying from those clients to the Internet at large. Often the
33109 same host is fulfilling both functions,
33110 . ///
33111 . as illustrated in the diagram below,
33112 . ///
33113 but in principle these two kinds of relaying are entirely independent. What is
33114 not wanted is the transmission of mail from arbitrary remote hosts through your
33115 system to arbitrary domains.
33116
33117
33118 You can implement relay control by means of suitable statements in the ACL that
33119 runs for each RCPT command. For convenience, it is often easiest to use
33120 Exim's named list facility to define the domains and hosts involved. For
33121 example, suppose you want to do the following:
33122
33123 .ilist
33124 Deliver a number of domains to mailboxes on the local host (or process them
33125 locally in some other way). Let's say these are &'my.dom1.example'& and
33126 &'my.dom2.example'&.
33127 .next
33128 Relay mail for a number of other domains for which you are the secondary MX.
33129 These might be &'friend1.example'& and &'friend2.example'&.
33130 .next
33131 Relay mail from the hosts on your local LAN, to whatever domains are involved.
33132 Suppose your LAN is 192.168.45.0/24.
33133 .endlist
33134
33135
33136 In the main part of the configuration, you put the following definitions:
33137 .code
33138 domainlist local_domains    = my.dom1.example : my.dom2.example
33139 domainlist relay_to_domains = friend1.example : friend2.example
33140 hostlist   relay_from_hosts = 192.168.45.0/24
33141 .endd
33142 Now you can use these definitions in the ACL that is run for every RCPT
33143 command:
33144 .code
33145 acl_check_rcpt:
33146   accept domains = +local_domains : +relay_to_domains
33147   accept hosts   = +relay_from_hosts
33148 .endd
33149 The first statement accepts any RCPT command that contains an address in
33150 the local or relay domains. For any other domain, control passes to the second
33151 statement, which accepts the command only if it comes from one of the relay
33152 hosts. In practice, you will probably want to make your ACL more sophisticated
33153 than this, for example, by including sender and recipient verification. The
33154 default configuration includes a more comprehensive example, which is described
33155 in chapter &<<CHAPdefconfil>>&.
33156
33157
33158
33159 .section "Checking a relay configuration" "SECTcheralcon"
33160 .cindex "relaying" "checking control of"
33161 You can check the relay characteristics of your configuration in the same way
33162 that you can test any ACL behaviour for an incoming SMTP connection, by using
33163 the &%-bh%& option to run a fake SMTP session with which you interact.
33164 .ecindex IIDacl
33165
33166
33167
33168 . ////////////////////////////////////////////////////////////////////////////
33169 . ////////////////////////////////////////////////////////////////////////////
33170
33171 .chapter "Content scanning at ACL time" "CHAPexiscan"
33172 .scindex IIDcosca "content scanning" "at ACL time"
33173 The extension of Exim to include content scanning at ACL time, formerly known
33174 as &"exiscan"&, was originally implemented as a patch by Tom Kistner. The code
33175 was integrated into the main source for Exim release 4.50, and Tom continues to
33176 maintain it. Most of the wording of this chapter is taken from Tom's
33177 specification.
33178
33179 It is also possible to scan the content of messages at other times. The
33180 &[local_scan()]& function (see chapter &<<CHAPlocalscan>>&) allows for content
33181 scanning after all the ACLs have run. A transport filter can be used to scan
33182 messages at delivery time (see the &%transport_filter%& option, described in
33183 chapter &<<CHAPtransportgeneric>>&).
33184
33185 If you want to include the ACL-time content-scanning features when you compile
33186 Exim, you need to arrange for WITH_CONTENT_SCAN to be defined in your
33187 &_Local/Makefile_&. When you do that, the Exim binary is built with:
33188
33189 .ilist
33190 Two additional ACLs (&%acl_smtp_mime%& and &%acl_not_smtp_mime%&) that are run
33191 for all MIME parts for SMTP and non-SMTP messages, respectively.
33192 .next
33193 Additional ACL conditions and modifiers: &%decode%&, &%malware%&,
33194 &%mime_regex%&, &%regex%&, and &%spam%&. These can be used in the ACL that is
33195 run at the end of message reception (the &%acl_smtp_data%& ACL).
33196 .next
33197 An additional control feature (&"no_mbox_unspool"&) that saves spooled copies
33198 of messages, or parts of messages, for debugging purposes.
33199 .next
33200 Additional expansion variables that are set in the new ACL and by the new
33201 conditions.
33202 .next
33203 Two new main configuration options: &%av_scanner%& and &%spamd_address%&.
33204 .endlist
33205
33206 Content-scanning is continually evolving, and new features are still being
33207 added. While such features are still unstable and liable to incompatible
33208 changes, they are made available in Exim by setting options whose names begin
33209 EXPERIMENTAL_ in &_Local/Makefile_&. Such features are not documented in
33210 this manual. You can find out about them by reading the file called
33211 &_doc/experimental.txt_&.
33212
33213 All the content-scanning facilities work on a MBOX copy of the message that is
33214 temporarily created in a file called:
33215 .display
33216 <&'spool_directory'&>&`/scan/`&<&'message_id'&>/<&'message_id'&>&`.eml`&
33217 .endd
33218 The &_.eml_& extension is a friendly hint to virus scanners that they can
33219 expect an MBOX-like structure inside that file. The file is created when the
33220 first content scanning facility is called. Subsequent calls to content
33221 scanning conditions open the same file again. The directory is recursively
33222 removed when the &%acl_smtp_data%& ACL has finished running, unless
33223 .code
33224 control = no_mbox_unspool
33225 .endd
33226 has been encountered. When the MIME ACL decodes files, they are put into the
33227 same directory by default.
33228
33229
33230
33231 .section "Scanning for viruses" "SECTscanvirus"
33232 .cindex "virus scanning"
33233 .cindex "content scanning" "for viruses"
33234 .cindex "content scanning" "the &%malware%& condition"
33235 The &%malware%& ACL condition lets you connect virus scanner software to Exim.
33236 It supports a &"generic"& interface to scanners called via the shell, and
33237 specialized interfaces for &"daemon"& type virus scanners, which are resident
33238 in memory and thus are much faster.
33239
33240 Since message data needs to have arrived,
33241 the condition may be only called in ACL defined by
33242 &%acl_smtp_data%&,
33243 &%acl_smtp_data_prdr%&,
33244 &%acl_smtp_mime%& or
33245 &%acl_smtp_dkim%&
33246
33247 A timeout of 2 minutes is applied to a scanner call (by default);
33248 if it expires then a defer action is taken.
33249
33250 .oindex "&%av_scanner%&"
33251 You can set the &%av_scanner%& option in the main part of the configuration
33252 to specify which scanner to use, together with any additional options that
33253 are needed. The basic syntax is as follows:
33254 .display
33255 &`av_scanner = <`&&'scanner-type'&&`>:<`&&'option1'&&`>:<`&&'option2'&&`>:[...]`&
33256 .endd
33257 If you do not set &%av_scanner%&, it defaults to
33258 .code
33259 av_scanner = sophie:/var/run/sophie
33260 .endd
33261 If the value of &%av_scanner%& starts with a dollar character, it is expanded
33262 before use.
33263 The usual list-parsing of the content (see &<<SECTlistconstruct>>&) applies.
33264 The following scanner types are supported in this release,
33265 though individual ones can be included or not at build time:
33266
33267 .vlist
33268 .vitem &%avast%&
33269 .cindex "virus scanners" "avast"
33270 This is the scanner daemon of Avast. It has been tested with Avast Core
33271 Security (currently at version 2.2.0).
33272 You can get a trial version at &url(https://www.avast.com) or for Linux
33273 at &url(https://www.avast.com/linux-server-antivirus).
33274 This scanner type takes one option,
33275 which can be either a full path to a UNIX socket,
33276 or host and port specifiers separated by white space.
33277 The host may be a name or an IP address; the port is either a
33278 single number or a pair of numbers with a dash between.
33279 A list of options may follow. These options are interpreted on the
33280 Exim's side of the malware scanner, or are given on separate lines to
33281 the daemon as options before the main scan command.
33282
33283 .cindex &`pass_unscanned`& "avast"
33284 If &`pass_unscanned`&
33285 is set, any files the Avast scanner can't scan (e.g.
33286 decompression bombs, or invalid archives) are considered clean. Use with
33287 care.
33288
33289 For example:
33290 .code
33291 av_scanner = avast:/var/run/avast/scan.sock:FLAGS -fullfiles:SENSITIVITY -pup
33292 av_scanner = avast:/var/run/avast/scan.sock:pass_unscanned:FLAGS -fullfiles:SENSITIVITY -pup
33293 av_scanner = avast:192.168.2.22 5036
33294 .endd
33295 If you omit the argument, the default path
33296 &_/var/run/avast/scan.sock_&
33297 is used.
33298 If you use a remote host,
33299 you need to make Exim's spool directory available to it,
33300 as the scanner is passed a file path, not file contents.
33301 For information about available commands and their options you may use
33302 .code
33303 $ socat UNIX:/var/run/avast/scan.sock STDIO:
33304     FLAGS
33305     SENSITIVITY
33306     PACK
33307 .endd
33308
33309 If the scanner returns a temporary failure (e.g. license issues, or
33310 permission problems), the message is deferred and a paniclog entry is
33311 written.  The usual &`defer_ok`& option is available.
33312
33313 .vitem &%aveserver%&
33314 .cindex "virus scanners" "Kaspersky"
33315 This is the scanner daemon of Kaspersky Version 5. You can get a trial version
33316 at &url(https://www.kaspersky.com/). This scanner type takes one option,
33317 which is the path to the daemon's UNIX socket. The default is shown in this
33318 example:
33319 .code
33320 av_scanner = aveserver:/var/run/aveserver
33321 .endd
33322
33323
33324 .vitem &%clamd%&
33325 .cindex "virus scanners" "clamd"
33326 This daemon-type scanner is GPL and free. You can get it at
33327 &url(https://www.clamav.net/). Some older versions of clamd do not seem to
33328 unpack MIME containers, so it used to be recommended to unpack MIME attachments
33329 in the MIME ACL. This is no longer believed to be necessary.
33330
33331 The options are a list of server specifiers, which may be
33332 a UNIX socket specification,
33333 a TCP socket specification,
33334 or a (global) option.
33335
33336 A socket specification consists of a space-separated list.
33337 For a Unix socket the first element is a full path for the socket,
33338 for a TCP socket the first element is the IP address
33339 and the second a port number,
33340 Any further elements are per-server (non-global) options.
33341 These per-server options are supported:
33342 .code
33343 retry=<timespec>        Retry on connect fail
33344 .endd
33345
33346 The &`retry`& option specifies a time after which a single retry for
33347 a failed connect is made.  The default is to not retry.
33348
33349 If a Unix socket file is specified, only one server is supported.
33350
33351 Examples:
33352 .code
33353 av_scanner = clamd:/opt/clamd/socket
33354 av_scanner = clamd:192.0.2.3 1234
33355 av_scanner = clamd:192.0.2.3 1234:local
33356 av_scanner = clamd:192.0.2.3 1234 retry=10s
33357 av_scanner = clamd:192.0.2.3 1234 : 192.0.2.4 1234
33358 .endd
33359 If the value of av_scanner points to a UNIX socket file or contains the
33360 &`local`&
33361 option, then the ClamAV interface will pass a filename containing the data
33362 to be scanned, which should normally result in less I/O happening and be
33363 more efficient.  Normally in the TCP case, the data is streamed to ClamAV as
33364 Exim does not assume that there is a common filesystem with the remote host.
33365
33366 The final example shows that multiple TCP targets can be specified.  Exim will
33367 randomly use one for each incoming email (i.e. it load balances them).  Note
33368 that only TCP targets may be used if specifying a list of scanners; a UNIX
33369 socket cannot be mixed in with TCP targets.  If one of the servers becomes
33370 unavailable, Exim will try the remaining one(s) until it finds one that works.
33371 When a clamd server becomes unreachable, Exim will log a message.  Exim does
33372 not keep track of scanner state between multiple messages, and the scanner
33373 selection is random, so the message will get logged in the mainlog for each
33374 email that the down scanner gets chosen first (message wrapped to be readable):
33375 .code
33376 2013-10-09 14:30:39 1VTumd-0000Y8-BQ malware acl condition:
33377    clamd: connection to localhost, port 3310 failed
33378    (Connection refused)
33379 .endd
33380
33381 If the option is unset, the default is &_/tmp/clamd_&. Thanks to David Saez for
33382 contributing the code for this scanner.
33383
33384 .vitem &%cmdline%&
33385 .cindex "virus scanners" "command line interface"
33386 This is the keyword for the generic command line scanner interface. It can be
33387 used to attach virus scanners that are invoked from the shell. This scanner
33388 type takes 3 mandatory options:
33389
33390 .olist
33391 The full path and name of the scanner binary, with all command line options,
33392 and a placeholder (&`%s`&) for the directory to scan.
33393
33394 .next
33395 A regular expression to match against the STDOUT and STDERR output of the
33396 virus scanner. If the expression matches, a virus was found. You must make
33397 absolutely sure that this expression matches on &"virus found"&. This is called
33398 the &"trigger"& expression.
33399
33400 .next
33401 Another regular expression, containing exactly one pair of parentheses, to
33402 match the name of the virus found in the scanners output. This is called the
33403 &"name"& expression.
33404 .endlist olist
33405
33406 For example, Sophos Sweep reports a virus on a line like this:
33407 .code
33408 Virus 'W32/Magistr-B' found in file ./those.bat
33409 .endd
33410 For the trigger expression, we can match the phrase &"found in file"&. For the
33411 name expression, we want to extract the W32/Magistr-B string, so we can match
33412 for the single quotes left and right of it. Altogether, this makes the
33413 configuration setting:
33414 .code
33415 av_scanner = cmdline:\
33416              /path/to/sweep -ss -all -rec -archive %s:\
33417              found in file:'(.+)'
33418 .endd
33419 .vitem &%drweb%&
33420 .cindex "virus scanners" "DrWeb"
33421 The DrWeb daemon scanner (&url(https://www.sald.ru/)) interface
33422 takes one option,
33423 either a full path to a UNIX socket,
33424 or host and port specifiers separated by white space.
33425 The host may be a name or an IP address; the port is either a
33426 single number or a pair of numbers with a dash between.
33427 For example:
33428 .code
33429 av_scanner = drweb:/var/run/drwebd.sock
33430 av_scanner = drweb:192.168.2.20 31337
33431 .endd
33432 If you omit the argument, the default path &_/usr/local/drweb/run/drwebd.sock_&
33433 is used. Thanks to Alex Miller for contributing the code for this scanner.
33434
33435 .vitem &%f-protd%&
33436 .cindex "virus scanners" "f-protd"
33437 The f-protd scanner is accessed via HTTP over TCP.
33438 One argument is taken, being a space-separated hostname and port number
33439 (or port-range).
33440 For example:
33441 .code
33442 av_scanner = f-protd:localhost 10200-10204
33443 .endd
33444 If you omit the argument, the default values shown above are used.
33445
33446 .vitem &%f-prot6d%&
33447 .cindex "virus scanners" "f-prot6d"
33448 The f-prot6d scanner is accessed using the FPSCAND protocol over TCP.
33449 One argument is taken, being a space-separated hostname and port number.
33450 For example:
33451 .code
33452 av_scanner = f-prot6d:localhost 10200
33453 .endd
33454 If you omit the argument, the default values show above are used.
33455
33456 .vitem &%fsecure%&
33457 .cindex "virus scanners" "F-Secure"
33458 The F-Secure daemon scanner (&url(https://www.f-secure.com/)) takes one
33459 argument which is the path to a UNIX socket. For example:
33460 .code
33461 av_scanner = fsecure:/path/to/.fsav
33462 .endd
33463 If no argument is given, the default is &_/var/run/.fsav_&. Thanks to Johan
33464 Thelmen for contributing the code for this scanner.
33465
33466 .vitem &%kavdaemon%&
33467 .cindex "virus scanners" "Kaspersky"
33468 This is the scanner daemon of Kaspersky Version 4. This version of the
33469 Kaspersky scanner is outdated. Please upgrade (see &%aveserver%& above). This
33470 scanner type takes one option, which is the path to the daemon's UNIX socket.
33471 For example:
33472 .code
33473 av_scanner = kavdaemon:/opt/AVP/AvpCtl
33474 .endd
33475 The default path is &_/var/run/AvpCtl_&.
33476
33477 .vitem &%mksd%&
33478 .cindex "virus scanners" "mksd"
33479 This was a daemon type scanner that is aimed mainly at Polish users,
33480 though some documentation was available in English.
33481 The history can be shown at &url(https://en.wikipedia.org/wiki/Mks_vir)
33482 and this appears to be a candidate for removal from Exim, unless
33483 we are informed of other virus scanners which use the same protocol
33484 to integrate.
33485 The only option for this scanner type is
33486 the maximum number of processes used simultaneously to scan the attachments,
33487 provided that mksd has
33488 been run with at least the same number of child processes. For example:
33489 .code
33490 av_scanner = mksd:2
33491 .endd
33492 You can safely omit this option (the default value is 1).
33493
33494 .vitem &%sock%&
33495 .cindex "virus scanners" "simple socket-connected"
33496 This is a general-purpose way of talking to simple scanner daemons
33497 running on the local machine.
33498 There are four options:
33499 an address (which may be an IP address and port, or the path of a Unix socket),
33500 a commandline to send (may include a single %s which will be replaced with
33501 the path to the mail file to be scanned),
33502 an RE to trigger on from the returned data,
33503 and an RE to extract malware_name from the returned data.
33504 For example:
33505 .code
33506 av_scanner = sock:127.0.0.1 6001:%s:(SPAM|VIRUS):(.*)$
33507 .endd
33508 Note that surrounding whitespace is stripped from each option, meaning
33509 there is no way to specify a trailing newline.
33510 The socket specifier and both regular-expressions are required.
33511 Default for the commandline is &_%s\n_& (note this does have a trailing newline);
33512 specify an empty element to get this.
33513
33514 .vitem &%sophie%&
33515 .cindex "virus scanners" "Sophos and Sophie"
33516 Sophie is a daemon that uses Sophos' &%libsavi%& library to scan for viruses.
33517 You can get Sophie at &url(http://sophie.sourceforge.net/). The only option
33518 for this scanner type is the path to the UNIX socket that Sophie uses for
33519 client communication. For example:
33520 .code
33521 av_scanner = sophie:/tmp/sophie
33522 .endd
33523 The default path is &_/var/run/sophie_&, so if you are using this, you can omit
33524 the option.
33525 .endlist
33526
33527 When &%av_scanner%& is correctly set, you can use the &%malware%& condition in
33528 the DATA ACL. &*Note*&: You cannot use the &%malware%& condition in the MIME
33529 ACL.
33530
33531 The &%av_scanner%& option is expanded each time &%malware%& is called. This
33532 makes it possible to use different scanners. See further below for an example.
33533 The &%malware%& condition caches its results, so when you use it multiple times
33534 for the same message, the actual scanning process is only carried out once.
33535 However, using expandable items in &%av_scanner%& disables this caching, in
33536 which case each use of the &%malware%& condition causes a new scan of the
33537 message.
33538
33539 The &%malware%& condition takes a right-hand argument that is expanded before
33540 use and taken as a list, slash-separated by default.
33541 The first element can then be one of
33542
33543 .ilist
33544 &"true"&, &"*"&, or &"1"&, in which case the message is scanned for viruses.
33545 The condition succeeds if a virus was found, and fail otherwise. This is the
33546 recommended usage.
33547 .next
33548 &"false"& or &"0"& or an empty string, in which case no scanning is done and
33549 the condition fails immediately.
33550 .next
33551 A regular expression, in which case the message is scanned for viruses. The
33552 condition succeeds if a virus is found and its name matches the regular
33553 expression. This allows you to take special actions on certain types of virus.
33554 Note that &"/"& characters in the RE must be doubled due to the list-processing,
33555 unless the separator is changed (in the usual way &<<SECTlistsepchange>>&).
33556 .endlist
33557
33558 You can append a &`defer_ok`& element to the &%malware%& argument list to accept
33559 messages even if there is a problem with the virus scanner.
33560 Otherwise, such a problem causes the ACL to defer.
33561
33562 You can append a &`tmo=<val>`& element to the &%malware%& argument list to
33563 specify a non-default timeout.  The default is two minutes.
33564 For example:
33565 .code
33566 malware = * / defer_ok / tmo=10s
33567 .endd
33568 A timeout causes the ACL to defer.
33569
33570 .vindex "&$callout_address$&"
33571 When a connection is made to the scanner the expansion variable &$callout_address$&
33572 is set to record the actual address used.
33573
33574 .vindex "&$malware_name$&"
33575 When a virus is found, the condition sets up an expansion variable called
33576 &$malware_name$& that contains the name of the virus. You can use it in a
33577 &%message%& modifier that specifies the error returned to the sender, and/or in
33578 logging data.
33579
33580 Beware the interaction of Exim's &%message_size_limit%& with any size limits
33581 imposed by your anti-virus scanner.
33582
33583 Here is a very simple scanning example:
33584 .code
33585 deny message = This message contains malware ($malware_name)
33586      malware = *
33587 .endd
33588 The next example accepts messages when there is a problem with the scanner:
33589 .code
33590 deny message = This message contains malware ($malware_name)
33591      malware = */defer_ok
33592 .endd
33593 The next example shows how to use an ACL variable to scan with both sophie and
33594 aveserver. It assumes you have set:
33595 .code
33596 av_scanner = $acl_m0
33597 .endd
33598 in the main Exim configuration.
33599 .code
33600 deny message = This message contains malware ($malware_name)
33601      set acl_m0 = sophie
33602      malware = *
33603
33604 deny message = This message contains malware ($malware_name)
33605      set acl_m0 = aveserver
33606      malware = *
33607 .endd
33608
33609
33610 .section "Scanning with SpamAssassin and Rspamd" "SECTscanspamass"
33611 .cindex "content scanning" "for spam"
33612 .cindex "spam scanning"
33613 .cindex "SpamAssassin"
33614 .cindex "Rspamd"
33615 The &%spam%& ACL condition calls SpamAssassin's &%spamd%& daemon to get a spam
33616 score and a report for the message.
33617 Support is also provided for Rspamd.
33618
33619 For more information about installation and configuration of SpamAssassin or
33620 Rspamd refer to their respective websites at
33621 &url(https://spamassassin.apache.org/) and &url(https://www.rspamd.com/)
33622
33623 SpamAssassin can be installed with CPAN by running:
33624 .code
33625 perl -MCPAN -e 'install Mail::SpamAssassin'
33626 .endd
33627 SpamAssassin has its own set of configuration files. Please review its
33628 documentation to see how you can tweak it. The default installation should work
33629 nicely, however.
33630
33631 .oindex "&%spamd_address%&"
33632 By default, SpamAssassin listens on 127.0.0.1, TCP port 783 and if you
33633 intend to use an instance running on the local host you do not need to set
33634 &%spamd_address%&. If you intend to use another host or port for SpamAssassin,
33635 you must set the &%spamd_address%& option in the global part of the Exim
33636 configuration as follows (example):
33637 .code
33638 spamd_address = 192.168.99.45 783
33639 .endd
33640 The SpamAssassin protocol relies on a TCP half-close from the client.
33641 If your SpamAssassin client side is running a Linux system with an
33642 iptables firewall, consider setting
33643 &%net.netfilter.nf_conntrack_tcp_timeout_close_wait%& to at least the
33644 timeout, Exim uses when waiting for a response from the SpamAssassin
33645 server (currently defaulting to 120s).  With a lower value the Linux
33646 connection tracking may consider your half-closed connection as dead too
33647 soon.
33648
33649
33650 To use Rspamd (which by default listens on all local addresses
33651 on TCP port 11333)
33652 you should add &%variant=rspamd%& after the address/port pair, for example:
33653 .code
33654 spamd_address = 127.0.0.1 11333 variant=rspamd
33655 .endd
33656
33657 As of version 2.60, &%SpamAssassin%& also supports communication over UNIX
33658 sockets. If you want to us these, supply &%spamd_address%& with an absolute
33659 filename instead of an address/port pair:
33660 .code
33661 spamd_address = /var/run/spamd_socket
33662 .endd
33663 You can have multiple &%spamd%& servers to improve scalability. These can
33664 reside on other hardware reachable over the network. To specify multiple
33665 &%spamd%& servers, put multiple address/port pairs in the &%spamd_address%&
33666 option, separated with colons (the separator can be changed in the usual way &<<SECTlistsepchange>>&):
33667 .code
33668 spamd_address = 192.168.2.10 783 : \
33669                 192.168.2.11 783 : \
33670                 192.168.2.12 783
33671 .endd
33672 Up to 32 &%spamd%& servers are supported.
33673 When a server fails to respond to the connection attempt, all other
33674 servers are tried until one succeeds. If no server responds, the &%spam%&
33675 condition defers.
33676
33677 Unix and TCP socket specifications may be mixed in any order.
33678 Each element of the list is a list itself, space-separated by default
33679 and changeable in the usual way (&<<SECTlistsepchange>>&);
33680 take care to not double the separator.
33681
33682 For TCP socket specifications a host name or IP (v4 or v6, but
33683 subject to list-separator quoting rules) address can be used,
33684 and the port can be one or a dash-separated pair.
33685 In the latter case, the range is tried in strict order.
33686
33687 Elements after the first for Unix sockets, or second for TCP socket,
33688 are options.
33689 The supported options are:
33690 .code
33691 pri=<priority>      Selection priority
33692 weight=<value>      Selection bias
33693 time=<start>-<end>  Use only between these times of day
33694 retry=<timespec>    Retry on connect fail
33695 tmo=<timespec>      Connection time limit
33696 variant=rspamd      Use Rspamd rather than SpamAssassin protocol
33697 .endd
33698
33699 The &`pri`& option specifies a priority for the server within the list,
33700 higher values being tried first.
33701 The default priority is 1.
33702
33703 The &`weight`& option specifies a selection bias.
33704 Within a priority set
33705 servers are queried in a random fashion, weighted by this value.
33706 The default value for selection bias is 1.
33707
33708 Time specifications for the &`time`& option are <hour>.<minute>.<second>
33709 in the local time zone; each element being one or more digits.
33710 Either the seconds or both minutes and seconds, plus the leading &`.`&
33711 characters, may be omitted and will be taken as zero.
33712
33713 Timeout specifications for the &`retry`& and &`tmo`& options
33714 are the usual Exim time interval standard, e.g. &`20s`& or &`1m`&.
33715
33716 The &`tmo`& option specifies an overall timeout for communication.
33717 The default value is two minutes.
33718
33719 The &`retry`& option specifies a time after which a single retry for
33720 a failed connect is made.
33721 The default is to not retry.
33722
33723 The &%spamd_address%& variable is expanded before use if it starts with
33724 a dollar sign. In this case, the expansion may return a string that is
33725 used as the list so that multiple spamd servers can be the result of an
33726 expansion.
33727
33728 .vindex "&$callout_address$&"
33729 When a connection is made to the server the expansion variable &$callout_address$&
33730 is set to record the actual address used.
33731
33732 .section "Calling SpamAssassin from an Exim ACL" "SECID206"
33733 Here is a simple example of the use of the &%spam%& condition in a DATA ACL:
33734 .code
33735 deny message = This message was classified as SPAM
33736      spam = joe
33737 .endd
33738 The right-hand side of the &%spam%& condition specifies a name. This is
33739 relevant if you have set up multiple SpamAssassin profiles. If you do not want
33740 to scan using a specific profile, but rather use the SpamAssassin system-wide
33741 default profile, you can scan for an unknown name, or simply use &"nobody"&.
33742 Rspamd does not use this setting. However, you must put something on the
33743 right-hand side.
33744
33745 The name allows you to use per-domain or per-user antispam profiles in
33746 principle, but this is not straightforward in practice, because a message may
33747 have multiple recipients, not necessarily all in the same domain. Because the
33748 &%spam%& condition has to be called from a DATA-time ACL in order to be able to
33749 read the contents of the message, the variables &$local_part$& and &$domain$&
33750 are not set.
33751 Careful enforcement of single-recipient messages
33752 (e.g. by responding with defer in the recipient ACL for all recipients
33753 after the first),
33754 or the use of PRDR,
33755 .cindex "PRDR" "use for per-user SpamAssassin profiles"
33756 are needed to use this feature.
33757
33758 The right-hand side of the &%spam%& condition is expanded before being used, so
33759 you can put lookups or conditions there. When the right-hand side evaluates to
33760 &"0"& or &"false"&, no scanning is done and the condition fails immediately.
33761
33762
33763 Scanning with SpamAssassin uses a lot of resources. If you scan every message,
33764 large ones may cause significant performance degradation. As most spam messages
33765 are quite small, it is recommended that you do not scan the big ones. For
33766 example:
33767 .code
33768 deny message = This message was classified as SPAM
33769      condition = ${if < {$message_size}{10K}}
33770      spam = nobody
33771 .endd
33772
33773 The &%spam%& condition returns true if the threshold specified in the user's
33774 SpamAssassin profile has been matched or exceeded. If you want to use the
33775 &%spam%& condition for its side effects (see the variables below), you can make
33776 it always return &"true"& by appending &`:true`& to the username.
33777
33778 .cindex "spam scanning" "returned variables"
33779 When the &%spam%& condition is run, it sets up a number of expansion
33780 variables.
33781 Except for &$spam_report$&,
33782 these variables are saved with the received message so are
33783 available for use at delivery time.
33784
33785 .vlist
33786 .vitem &$spam_score$&
33787 The spam score of the message, for example, &"3.4"& or &"30.5"&. This is useful
33788 for inclusion in log or reject messages.
33789
33790 .vitem &$spam_score_int$&
33791 The spam score of the message, multiplied by ten, as an integer value. For
33792 example &"34"& or &"305"&. It may appear to disagree with &$spam_score$&
33793 because &$spam_score$& is rounded and &$spam_score_int$& is truncated.
33794 The integer value is useful for numeric comparisons in conditions.
33795
33796 .vitem &$spam_bar$&
33797 A string consisting of a number of &"+"& or &"-"& characters, representing the
33798 integer part of the spam score value. A spam score of 4.4 would have a
33799 &$spam_bar$& value of &"++++"&. This is useful for inclusion in warning
33800 headers, since MUAs can match on such strings. The maximum length of the
33801 spam bar is 50 characters.
33802
33803 .vitem &$spam_report$&
33804 A multiline text table, containing the full SpamAssassin report for the
33805 message. Useful for inclusion in headers or reject messages.
33806 This variable is only usable in a DATA-time ACL.
33807 Beware that SpamAssassin may return non-ASCII characters, especially
33808 when running in country-specific locales, which are not legal
33809 unencoded in headers.
33810
33811 .vitem &$spam_action$&
33812 For SpamAssassin either 'reject' or 'no action' depending on the
33813 spam score versus threshold.
33814 For Rspamd, the recommended action.
33815
33816 .endlist
33817
33818 The &%spam%& condition caches its results unless expansion in
33819 spamd_address was used. If you call it again with the same user name, it
33820 does not scan again, but rather returns the same values as before.
33821
33822 The &%spam%& condition returns DEFER if there is any error while running
33823 the message through SpamAssassin or if the expansion of spamd_address
33824 failed. If you want to treat DEFER as FAIL (to pass on to the next ACL
33825 statement block), append &`/defer_ok`& to the right-hand side of the
33826 spam condition, like this:
33827 .code
33828 deny message = This message was classified as SPAM
33829      spam    = joe/defer_ok
33830 .endd
33831 This causes messages to be accepted even if there is a problem with &%spamd%&.
33832
33833 Here is a longer, commented example of the use of the &%spam%&
33834 condition:
33835 .code
33836 # put headers in all messages (no matter if spam or not)
33837 warn  spam = nobody:true
33838       add_header = X-Spam-Score: $spam_score ($spam_bar)
33839       add_header = X-Spam-Report: $spam_report
33840
33841 # add second subject line with *SPAM* marker when message
33842 # is over threshold
33843 warn  spam = nobody
33844       add_header = Subject: *SPAM* $h_Subject:
33845
33846 # reject spam at high scores (> 12)
33847 deny  message = This message scored $spam_score spam points.
33848       spam = nobody:true
33849       condition = ${if >{$spam_score_int}{120}{1}{0}}
33850 .endd
33851
33852
33853
33854 .section "Scanning MIME parts" "SECTscanmimepart"
33855 .cindex "content scanning" "MIME parts"
33856 .cindex "MIME content scanning"
33857 .oindex "&%acl_smtp_mime%&"
33858 .oindex "&%acl_not_smtp_mime%&"
33859 The &%acl_smtp_mime%& global option specifies an ACL that is called once for
33860 each MIME part of an SMTP message, including multipart types, in the sequence
33861 of their position in the message. Similarly, the &%acl_not_smtp_mime%& option
33862 specifies an ACL that is used for the MIME parts of non-SMTP messages. These
33863 options may both refer to the same ACL if you want the same processing in both
33864 cases.
33865
33866 These ACLs are called (possibly many times) just before the &%acl_smtp_data%&
33867 ACL in the case of an SMTP message, or just before the &%acl_not_smtp%& ACL in
33868 the case of a non-SMTP message. However, a MIME ACL is called only if the
33869 message contains a &'Content-Type:'& header line. When a call to a MIME
33870 ACL does not yield &"accept"&, ACL processing is aborted and the appropriate
33871 result code is sent to the client. In the case of an SMTP message, the
33872 &%acl_smtp_data%& ACL is not called when this happens.
33873
33874 You cannot use the &%malware%& or &%spam%& conditions in a MIME ACL; these can
33875 only be used in the DATA or non-SMTP ACLs. However, you can use the &%regex%&
33876 condition to match against the raw MIME part. You can also use the
33877 &%mime_regex%& condition to match against the decoded MIME part (see section
33878 &<<SECTscanregex>>&).
33879
33880 At the start of a MIME ACL, a number of variables are set from the header
33881 information for the relevant MIME part. These are described below. The contents
33882 of the MIME part are not by default decoded into a disk file except for MIME
33883 parts whose content-type is &"message/rfc822"&. If you want to decode a MIME
33884 part into a disk file, you can use the &%decode%& condition. The general
33885 syntax is:
33886 .display
33887 &`decode = [/`&<&'path'&>&`/]`&<&'filename'&>
33888 .endd
33889 The right hand side is expanded before use. After expansion,
33890 the value can be:
33891
33892 .olist
33893 &"0"& or &"false"&, in which case no decoding is done.
33894 .next
33895 The string &"default"&. In that case, the file is put in the temporary
33896 &"default"& directory <&'spool_directory'&>&_/scan/_&<&'message_id'&>&_/_& with
33897 a sequential filename consisting of the message id and a sequence number. The
33898 full path and name is available in &$mime_decoded_filename$& after decoding.
33899 .next
33900 A full path name starting with a slash. If the full name is an existing
33901 directory, it is used as a replacement for the default directory. The filename
33902 is then sequentially assigned. If the path does not exist, it is used as
33903 the full path and filename.
33904 .next
33905 If the string does not start with a slash, it is used as the
33906 filename, and the default path is then used.
33907 .endlist
33908 The &%decode%& condition normally succeeds. It is only false for syntax
33909 errors or unusual circumstances such as memory shortages. You can easily decode
33910 a file with its original, proposed filename using
33911 .code
33912 decode = $mime_filename
33913 .endd
33914 However, you should keep in mind that &$mime_filename$& might contain
33915 anything. If you place files outside of the default path, they are not
33916 automatically unlinked.
33917
33918 For RFC822 attachments (these are messages attached to messages, with a
33919 content-type of &"message/rfc822"&), the ACL is called again in the same manner
33920 as for the primary message, only that the &$mime_is_rfc822$& expansion
33921 variable is set (see below). Attached messages are always decoded to disk
33922 before being checked, and the files are unlinked once the check is done.
33923
33924 The MIME ACL supports the &%regex%& and &%mime_regex%& conditions. These can be
33925 used to match regular expressions against raw and decoded MIME parts,
33926 respectively. They are described in section &<<SECTscanregex>>&.
33927
33928 .cindex "MIME content scanning" "returned variables"
33929 The following list describes all expansion variables that are
33930 available in the MIME ACL:
33931
33932 .vlist
33933 .vitem &$mime_anomaly_level$& &&&
33934        &$mime_anomaly_text$&
33935 .vindex &$mime_anomaly_level$&
33936 .vindex &$mime_anomaly_text$&
33937 If there are problems decoding, these variables contain information on
33938 the detected issue.
33939
33940 .vitem &$mime_boundary$&
33941 .vindex &$mime_boundary$&
33942 If the current part is a multipart (see &$mime_is_multipart$& below), it should
33943 have a boundary string, which is stored in this variable. If the current part
33944 has no boundary parameter in the &'Content-Type:'& header, this variable
33945 contains the empty string.
33946
33947 .vitem &$mime_charset$&
33948 .vindex &$mime_charset$&
33949 This variable contains the character set identifier, if one was found in the
33950 &'Content-Type:'& header. Examples for charset identifiers are:
33951 .code
33952 us-ascii
33953 gb2312 (Chinese)
33954 iso-8859-1
33955 .endd
33956 Please note that this value is not normalized, so you should do matches
33957 case-insensitively.
33958
33959 .vitem &$mime_content_description$&
33960 .vindex &$mime_content_description$&
33961 This variable contains the normalized content of the &'Content-Description:'&
33962 header. It can contain a human-readable description of the parts content. Some
33963 implementations repeat the filename for attachments here, but they are usually
33964 only used for display purposes.
33965
33966 .vitem &$mime_content_disposition$&
33967 .vindex &$mime_content_disposition$&
33968 This variable contains the normalized content of the &'Content-Disposition:'&
33969 header. You can expect strings like &"attachment"& or &"inline"& here.
33970
33971 .vitem &$mime_content_id$&
33972 .vindex &$mime_content_id$&
33973 This variable contains the normalized content of the &'Content-ID:'& header.
33974 This is a unique ID that can be used to reference a part from another part.
33975
33976 .vitem &$mime_content_size$&
33977 .vindex &$mime_content_size$&
33978 This variable is set only after the &%decode%& modifier (see above) has been
33979 successfully run. It contains the size of the decoded part in kilobytes. The
33980 size is always rounded up to full kilobytes, so only a completely empty part
33981 has a &$mime_content_size$& of zero.
33982
33983 .vitem &$mime_content_transfer_encoding$&
33984 .vindex &$mime_content_transfer_encoding$&
33985 This variable contains the normalized content of the
33986 &'Content-transfer-encoding:'& header. This is a symbolic name for an encoding
33987 type. Typical values are &"base64"& and &"quoted-printable"&.
33988
33989 .vitem &$mime_content_type$&
33990 .vindex &$mime_content_type$&
33991 If the MIME part has a &'Content-Type:'& header, this variable contains its
33992 value, lowercased, and without any options (like &"name"& or &"charset"&). Here
33993 are some examples of popular MIME types, as they may appear in this variable:
33994 .code
33995 text/plain
33996 text/html
33997 application/octet-stream
33998 image/jpeg
33999 audio/midi
34000 .endd
34001 If the MIME part has no &'Content-Type:'& header, this variable contains the
34002 empty string.
34003
34004 .vitem &$mime_decoded_filename$&
34005 .vindex &$mime_decoded_filename$&
34006 This variable is set only after the &%decode%& modifier (see above) has been
34007 successfully run. It contains the full path and filename of the file
34008 containing the decoded data.
34009 .endlist
34010
34011 .cindex "RFC 2047"
34012 .vlist
34013 .vitem &$mime_filename$&
34014 .vindex &$mime_filename$&
34015 This is perhaps the most important of the MIME variables. It contains a
34016 proposed filename for an attachment, if one was found in either the
34017 &'Content-Type:'& or &'Content-Disposition:'& headers. The filename will be
34018 RFC2047
34019 or RFC2231
34020 decoded, but no additional sanity checks are done.
34021  If no filename was
34022 found, this variable contains the empty string.
34023
34024 .vitem &$mime_is_coverletter$&
34025 .vindex &$mime_is_coverletter$&
34026 This variable attempts to differentiate the &"cover letter"& of an e-mail from
34027 attached data. It can be used to clamp down on flashy or unnecessarily encoded
34028 content in the cover letter, while not restricting attachments at all.
34029
34030 The variable contains 1 (true) for a MIME part believed to be part of the
34031 cover letter, and 0 (false) for an attachment. At present, the algorithm is as
34032 follows:
34033
34034 .olist
34035 The outermost MIME part of a message is always a cover letter.
34036
34037 .next
34038 If a multipart/alternative or multipart/related MIME part is a cover letter,
34039 so are all MIME subparts within that multipart.
34040
34041 .next
34042 If any other multipart is a cover letter, the first subpart is a cover letter,
34043 and the rest are attachments.
34044
34045 .next
34046 All parts contained within an attachment multipart are attachments.
34047 .endlist olist
34048
34049 As an example, the following will ban &"HTML mail"& (including that sent with
34050 alternative plain text), while allowing HTML files to be attached. HTML
34051 coverletter mail attached to non-HTML coverletter mail will also be allowed:
34052 .code
34053 deny message = HTML mail is not accepted here
34054 !condition = $mime_is_rfc822
34055 condition = $mime_is_coverletter
34056 condition = ${if eq{$mime_content_type}{text/html}{1}{0}}
34057 .endd
34058
34059 .vitem &$mime_is_multipart$&
34060 .vindex &$mime_is_multipart$&
34061 This variable has the value 1 (true) when the current part has the main type
34062 &"multipart"&, for example, &"multipart/alternative"& or &"multipart/mixed"&.
34063 Since multipart entities only serve as containers for other parts, you may not
34064 want to carry out specific actions on them.
34065
34066 .vitem &$mime_is_rfc822$&
34067 .vindex &$mime_is_rfc822$&
34068 This variable has the value 1 (true) if the current part is not a part of the
34069 checked message itself, but part of an attached message. Attached message
34070 decoding is fully recursive.
34071
34072 .vitem &$mime_part_count$&
34073 .vindex &$mime_part_count$&
34074 This variable is a counter that is raised for each processed MIME part. It
34075 starts at zero for the very first part (which is usually a multipart). The
34076 counter is per-message, so it is reset when processing RFC822 attachments (see
34077 &$mime_is_rfc822$&). The counter stays set after &%acl_smtp_mime%& is
34078 complete, so you can use it in the DATA ACL to determine the number of MIME
34079 parts of a message. For non-MIME messages, this variable contains the value -1.
34080 .endlist
34081
34082
34083
34084 .section "Scanning with regular expressions" "SECTscanregex"
34085 .cindex "content scanning" "with regular expressions"
34086 .cindex "regular expressions" "content scanning with"
34087 You can specify your own custom regular expression matches on the full body of
34088 the message, or on individual MIME parts.
34089
34090 The &%regex%& condition takes one or more regular expressions as arguments and
34091 matches them against the full message (when called in the DATA ACL) or a raw
34092 MIME part (when called in the MIME ACL). The &%regex%& condition matches
34093 linewise, with a maximum line length of 32K characters. That means you cannot
34094 have multiline matches with the &%regex%& condition.
34095
34096 The &%mime_regex%& condition can be called only in the MIME ACL. It matches up
34097 to 32K of decoded content (the whole content at once, not linewise). If the
34098 part has not been decoded with the &%decode%& modifier earlier in the ACL, it
34099 is decoded automatically when &%mime_regex%& is executed (using default path
34100 and filename values). If the decoded data is larger than  32K, only the first
34101 32K characters are checked.
34102
34103 The regular expressions are passed as a colon-separated list. To include a
34104 literal colon, you must double it. Since the whole right-hand side string is
34105 expanded before being used, you must also escape dollar signs and backslashes
34106 with more backslashes, or use the &`\N`& facility to disable expansion.
34107 Here is a simple example that contains two regular expressions:
34108 .code
34109 deny message = contains blacklisted regex ($regex_match_string)
34110      regex = [Mm]ortgage : URGENT BUSINESS PROPOSAL
34111 .endd
34112 The conditions returns true if any one of the regular expressions matches. The
34113 &$regex_match_string$& expansion variable is then set up and contains the
34114 matching regular expression.
34115 The expansion variables &$regex1$& &$regex2$& etc
34116 are set to any substrings captured by the regular expression.
34117
34118 &*Warning*&: With large messages, these conditions can be fairly
34119 CPU-intensive.
34120
34121 .ecindex IIDcosca
34122
34123
34124
34125
34126 . ////////////////////////////////////////////////////////////////////////////
34127 . ////////////////////////////////////////////////////////////////////////////
34128
34129 .chapter "Adding a local scan function to Exim" "CHAPlocalscan" &&&
34130          "Local scan function"
34131 .scindex IIDlosca "&[local_scan()]& function" "description of"
34132 .cindex "customizing" "input scan using C function"
34133 .cindex "policy control" "by local scan function"
34134 In these days of email worms, viruses, and ever-increasing spam, some sites
34135 want to apply a lot of checking to messages before accepting them.
34136
34137 The content scanning extension (chapter &<<CHAPexiscan>>&) has facilities for
34138 passing messages to external virus and spam scanning software. You can also do
34139 a certain amount in Exim itself through string expansions and the &%condition%&
34140 condition in the ACL that runs after the SMTP DATA command or the ACL for
34141 non-SMTP messages (see chapter &<<CHAPACL>>&), but this has its limitations.
34142
34143 To allow for further customization to a site's own requirements, there is the
34144 possibility of linking Exim with a private message scanning function, written
34145 in C. If you want to run code that is written in something other than C, you
34146 can of course use a little C stub to call it.
34147
34148 The local scan function is run once for every incoming message, at the point
34149 when Exim is just about to accept the message.
34150 It can therefore be used to control non-SMTP messages from local processes as
34151 well as messages arriving via SMTP.
34152
34153 Exim applies a timeout to calls of the local scan function, and there is an
34154 option called &%local_scan_timeout%& for setting it. The default is 5 minutes.
34155 Zero means &"no timeout"&.
34156 Exim also sets up signal handlers for SIGSEGV, SIGILL, SIGFPE, and SIGBUS
34157 before calling the local scan function, so that the most common types of crash
34158 are caught. If the timeout is exceeded or one of those signals is caught, the
34159 incoming message is rejected with a temporary error if it is an SMTP message.
34160 For a non-SMTP message, the message is dropped and Exim ends with a non-zero
34161 code. The incident is logged on the main and reject logs.
34162
34163
34164
34165 .section "Building Exim to use a local scan function" "SECID207"
34166 .cindex "&[local_scan()]& function" "building Exim to use"
34167 To make use of the local scan function feature, you must tell Exim where your
34168 function is before building Exim, by setting
34169 both HAVE_LOCAL_SCAN and
34170 LOCAL_SCAN_SOURCE in your
34171 &_Local/Makefile_&. A recommended place to put it is in the &_Local_&
34172 directory, so you might set
34173 .code
34174 HAVE_LOCAL_SCAN=yes
34175 LOCAL_SCAN_SOURCE=Local/local_scan.c
34176 .endd
34177 for example. The function must be called &[local_scan()]&;
34178 .new
34179 the source file(s) for it should first #define LOCAL_SCAN
34180 and then #include "local_scan.h".
34181 .wen
34182 It is called by
34183 Exim after it has received a message, when the success return code is about to
34184 be sent. This is after all the ACLs have been run. The return code from your
34185 function controls whether the message is actually accepted or not. There is a
34186 commented template function (that just accepts the message) in the file
34187 _src/local_scan.c_.
34188
34189 If you want to make use of Exim's runtime configuration file to set options
34190 for your &[local_scan()]& function, you must also set
34191 .code
34192 LOCAL_SCAN_HAS_OPTIONS=yes
34193 .endd
34194 in &_Local/Makefile_& (see section &<<SECTconoptloc>>& below).
34195
34196
34197
34198
34199 .section "API for local_scan()" "SECTapiforloc"
34200 .cindex "&[local_scan()]& function" "API description"
34201 .cindex &%dlfunc%& "API description"
34202 You must include this line near the start of your code:
34203 .code
34204 #define LOCAL_SCAN
34205 #include "local_scan.h"
34206 .endd
34207 This header file defines a number of variables and other values, and the
34208 prototype for the function itself. Exim is coded to use unsigned char values
34209 almost exclusively, and one of the things this header defines is a shorthand
34210 for &`unsigned char`& called &`uschar`&.
34211 It also makes available the following macro definitions, to simplify casting character
34212 strings and pointers to character strings:
34213 .code
34214 #define CS   (char *)
34215 #define CCS  (const char *)
34216 #define CSS  (char **)
34217 #define US   (unsigned char *)
34218 #define CUS  (const unsigned char *)
34219 #define USS  (unsigned char **)
34220 .endd
34221 The function prototype for &[local_scan()]& is:
34222 .code
34223 extern int local_scan(int fd, uschar **return_text);
34224 .endd
34225 The arguments are as follows:
34226
34227 .ilist
34228 &%fd%& is a file descriptor for the file that contains the body of the message
34229 (the -D file). The file is open for reading and writing, but updating it is not
34230 recommended. &*Warning*&: You must &'not'& close this file descriptor.
34231
34232 The descriptor is positioned at character 19 of the file, which is the first
34233 character of the body itself, because the first 19 characters are the message
34234 id followed by &`-D`& and a newline. If you rewind the file, you should use the
34235 macro SPOOL_DATA_START_OFFSET to reset to the start of the data, just in
34236 case this changes in some future version.
34237 .next
34238 &%return_text%& is an address which you can use to return a pointer to a text
34239 string at the end of the function. The value it points to on entry is NULL.
34240 .endlist
34241
34242 The function must return an &%int%& value which is one of the following macros:
34243
34244 .vlist
34245 .vitem &`LOCAL_SCAN_ACCEPT`&
34246 .vindex "&$local_scan_data$&"
34247 The message is accepted. If you pass back a string of text, it is saved with
34248 the message, and made available in the variable &$local_scan_data$&. No
34249 newlines are permitted (if there are any, they are turned into spaces) and the
34250 maximum length of text is 1000 characters.
34251
34252 .vitem &`LOCAL_SCAN_ACCEPT_FREEZE`&
34253 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
34254 queued without immediate delivery, and is frozen.
34255
34256 .vitem &`LOCAL_SCAN_ACCEPT_QUEUE`&
34257 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
34258 queued without immediate delivery.
34259
34260 .vitem &`LOCAL_SCAN_REJECT`&
34261 The message is rejected; the returned text is used as an error message which is
34262 passed back to the sender and which is also logged. Newlines are permitted &--
34263 they cause a multiline response for SMTP rejections, but are converted to
34264 &`\n`& in log lines. If no message is given, &"Administrative prohibition"& is
34265 used.
34266
34267 .vitem &`LOCAL_SCAN_TEMPREJECT`&
34268 The message is temporarily rejected; the returned text is used as an error
34269 message as for LOCAL_SCAN_REJECT. If no message is given, &"Temporary local
34270 problem"& is used.
34271
34272 .vitem &`LOCAL_SCAN_REJECT_NOLOGHDR`&
34273 This behaves as LOCAL_SCAN_REJECT, except that the header of the rejected
34274 message is not written to the reject log. It has the effect of unsetting the
34275 &%rejected_header%& log selector for just this rejection. If
34276 &%rejected_header%& is already unset (see the discussion of the
34277 &%log_selection%& option in section &<<SECTlogselector>>&), this code is the
34278 same as LOCAL_SCAN_REJECT.
34279
34280 .vitem &`LOCAL_SCAN_TEMPREJECT_NOLOGHDR`&
34281 This code is a variation of LOCAL_SCAN_TEMPREJECT in the same way that
34282 LOCAL_SCAN_REJECT_NOLOGHDR is a variation of LOCAL_SCAN_REJECT.
34283 .endlist
34284
34285 If the message is not being received by interactive SMTP, rejections are
34286 reported by writing to &%stderr%& or by sending an email, as configured by the
34287 &%-oe%& command line options.
34288
34289
34290
34291 .section "Configuration options for local_scan()" "SECTconoptloc"
34292 .cindex "&[local_scan()]& function" "configuration options"
34293 It is possible to have option settings in the main configuration file
34294 that set values in static variables in the &[local_scan()]& module. If you
34295 want to do this, you must have the line
34296 .code
34297 LOCAL_SCAN_HAS_OPTIONS=yes
34298 .endd
34299 in your &_Local/Makefile_& when you build Exim. (This line is in
34300 &_OS/Makefile-Default_&, commented out). Then, in the &[local_scan()]& source
34301 file, you must define static variables to hold the option values, and a table
34302 to define them.
34303
34304 The table must be a vector called &%local_scan_options%&, of type
34305 &`optionlist`&. Each entry is a triplet, consisting of a name, an option type,
34306 and a pointer to the variable that holds the value. The entries must appear in
34307 alphabetical order. Following &%local_scan_options%& you must also define a
34308 variable called &%local_scan_options_count%& that contains the number of
34309 entries in the table. Here is a short example, showing two kinds of option:
34310 .code
34311 static int my_integer_option = 42;
34312 static uschar *my_string_option = US"a default string";
34313
34314 optionlist local_scan_options[] = {
34315   { "my_integer", opt_int,       &my_integer_option },
34316   { "my_string",  opt_stringptr, &my_string_option }
34317 };
34318
34319 int local_scan_options_count =
34320   sizeof(local_scan_options)/sizeof(optionlist);
34321 .endd
34322 The values of the variables can now be changed from Exim's runtime
34323 configuration file by including a local scan section as in this example:
34324 .code
34325 begin local_scan
34326 my_integer = 99
34327 my_string = some string of text...
34328 .endd
34329 The available types of option data are as follows:
34330
34331 .vlist
34332 .vitem &*opt_bool*&
34333 This specifies a boolean (true/false) option. The address should point to a
34334 variable of type &`BOOL`&, which will be set to TRUE or FALSE, which are macros
34335 that are defined as &"1"& and &"0"&, respectively. If you want to detect
34336 whether such a variable has been set at all, you can initialize it to
34337 TRUE_UNSET. (BOOL variables are integers underneath, so can hold more than two
34338 values.)
34339
34340 .vitem &*opt_fixed*&
34341 This specifies a fixed point number, such as is used for load averages.
34342 The address should point to a variable of type &`int`&. The value is stored
34343 multiplied by 1000, so, for example, 1.4142 is truncated and stored as 1414.
34344
34345 .vitem &*opt_int*&
34346 This specifies an integer; the address should point to a variable of type
34347 &`int`&. The value may be specified in any of the integer formats accepted by
34348 Exim.
34349
34350 .vitem &*opt_mkint*&
34351 This is the same as &%opt_int%&, except that when such a value is output in a
34352 &%-bP%& listing, if it is an exact number of kilobytes or megabytes, it is
34353 printed with the suffix K or M.
34354
34355 .vitem &*opt_octint*&
34356 This also specifies an integer, but the value is always interpreted as an
34357 octal integer, whether or not it starts with the digit zero, and it is
34358 always output in octal.
34359
34360 .vitem &*opt_stringptr*&
34361 This specifies a string value; the address must be a pointer to a
34362 variable that points to a string (for example, of type &`uschar *`&).
34363
34364 .vitem &*opt_time*&
34365 This specifies a time interval value. The address must point to a variable of
34366 type &`int`&. The value that is placed there is a number of seconds.
34367 .endlist
34368
34369 If the &%-bP%& command line option is followed by &`local_scan`&, Exim prints
34370 out the values of all the &[local_scan()]& options.
34371
34372
34373
34374 .section "Available Exim variables" "SECID208"
34375 .cindex "&[local_scan()]& function" "available Exim variables"
34376 The header &_local_scan.h_& gives you access to a number of C variables. These
34377 are the only ones that are guaranteed to be maintained from release to release.
34378 Note, however, that you can obtain the value of any Exim expansion variable,
34379 including &$recipients$&, by calling &'expand_string()'&. The exported
34380 C variables are as follows:
34381
34382 .vlist
34383 .vitem &*int&~body_linecount*&
34384 This variable contains the number of lines in the message's body.
34385 It is not valid if the &%spool_files_wireformat%& option is used.
34386
34387 .vitem &*int&~body_zerocount*&
34388 This variable contains the number of binary zero bytes in the message's body.
34389 It is not valid if the &%spool_files_wireformat%& option is used.
34390
34391 .vitem &*unsigned&~int&~debug_selector*&
34392 This variable is set to zero when no debugging is taking place. Otherwise, it
34393 is a bitmap of debugging selectors. Two bits are identified for use in
34394 &[local_scan()]&; they are defined as macros:
34395
34396 .ilist
34397 The &`D_v`& bit is set when &%-v%& was present on the command line. This is a
34398 testing option that is not privileged &-- any caller may set it. All the
34399 other selector bits can be set only by admin users.
34400
34401 .next
34402 The &`D_local_scan`& bit is provided for use by &[local_scan()]&; it is set
34403 by the &`+local_scan`& debug selector. It is not included in the default set
34404 of debugging bits.
34405 .endlist ilist
34406
34407 Thus, to write to the debugging output only when &`+local_scan`& has been
34408 selected, you should use code like this:
34409 .code
34410 if ((debug_selector & D_local_scan) != 0)
34411   debug_printf("xxx", ...);
34412 .endd
34413 .vitem &*uschar&~*expand_string_message*&
34414 After a failing call to &'expand_string()'& (returned value NULL), the
34415 variable &%expand_string_message%& contains the error message, zero-terminated.
34416
34417 .vitem &*header_line&~*header_list*&
34418 A pointer to a chain of header lines. The &%header_line%& structure is
34419 discussed below.
34420
34421 .vitem &*header_line&~*header_last*&
34422 A pointer to the last of the header lines.
34423
34424 .vitem &*uschar&~*headers_charset*&
34425 The value of the &%headers_charset%& configuration option.
34426
34427 .vitem &*BOOL&~host_checking*&
34428 This variable is TRUE during a host checking session that is initiated by the
34429 &%-bh%& command line option.
34430
34431 .vitem &*uschar&~*interface_address*&
34432 The IP address of the interface that received the message, as a string. This
34433 is NULL for locally submitted messages.
34434
34435 .vitem &*int&~interface_port*&
34436 The port on which this message was received. When testing with the &%-bh%&
34437 command line option, the value of this variable is -1 unless a port has been
34438 specified via the &%-oMi%& option.
34439
34440 .vitem &*uschar&~*message_id*&
34441 This variable contains Exim's message id for the incoming message (the value of
34442 &$message_exim_id$&) as a zero-terminated string.
34443
34444 .vitem &*uschar&~*received_protocol*&
34445 The name of the protocol by which the message was received.
34446
34447 .vitem &*int&~recipients_count*&
34448 The number of accepted recipients.
34449
34450 .vitem &*recipient_item&~*recipients_list*&
34451 .cindex "recipient" "adding in local scan"
34452 .cindex "recipient" "removing in local scan"
34453 The list of accepted recipients, held in a vector of length
34454 &%recipients_count%&. The &%recipient_item%& structure is discussed below. You
34455 can add additional recipients by calling &'receive_add_recipient()'& (see
34456 below). You can delete recipients by removing them from the vector and
34457 adjusting the value in &%recipients_count%&. In particular, by setting
34458 &%recipients_count%& to zero you remove all recipients. If you then return the
34459 value &`LOCAL_SCAN_ACCEPT`&, the message is accepted, but immediately
34460 blackholed. To replace the recipients, you can set &%recipients_count%& to zero
34461 and then call &'receive_add_recipient()'& as often as needed.
34462
34463 .vitem &*uschar&~*sender_address*&
34464 The envelope sender address. For bounce messages this is the empty string.
34465
34466 .vitem &*uschar&~*sender_host_address*&
34467 The IP address of the sending host, as a string. This is NULL for
34468 locally-submitted messages.
34469
34470 .vitem &*uschar&~*sender_host_authenticated*&
34471 The name of the authentication mechanism that was used, or NULL if the message
34472 was not received over an authenticated SMTP connection.
34473
34474 .vitem &*uschar&~*sender_host_name*&
34475 The name of the sending host, if known.
34476
34477 .vitem &*int&~sender_host_port*&
34478 The port on the sending host.
34479
34480 .vitem &*BOOL&~smtp_input*&
34481 This variable is TRUE for all SMTP input, including BSMTP.
34482
34483 .vitem &*BOOL&~smtp_batched_input*&
34484 This variable is TRUE for BSMTP input.
34485
34486 .vitem &*int&~store_pool*&
34487 The contents of this variable control which pool of memory is used for new
34488 requests. See section &<<SECTmemhanloc>>& for details.
34489 .endlist
34490
34491
34492 .section "Structure of header lines" "SECID209"
34493 The &%header_line%& structure contains the members listed below.
34494 You can add additional header lines by calling the &'header_add()'& function
34495 (see below). You can cause header lines to be ignored (deleted) by setting
34496 their type to *.
34497
34498
34499 .vlist
34500 .vitem &*struct&~header_line&~*next*&
34501 A pointer to the next header line, or NULL for the last line.
34502
34503 .vitem &*int&~type*&
34504 A code identifying certain headers that Exim recognizes. The codes are printing
34505 characters, and are documented in chapter &<<CHAPspool>>& of this manual.
34506 Notice in particular that any header line whose type is * is not transmitted
34507 with the message. This flagging is used for header lines that have been
34508 rewritten, or are to be removed (for example, &'Envelope-sender:'& header
34509 lines.) Effectively, * means &"deleted"&.
34510
34511 .vitem &*int&~slen*&
34512 The number of characters in the header line, including the terminating and any
34513 internal newlines.
34514
34515 .vitem &*uschar&~*text*&
34516 A pointer to the text of the header. It always ends with a newline, followed by
34517 a zero byte. Internal newlines are preserved.
34518 .endlist
34519
34520
34521
34522 .section "Structure of recipient items" "SECID210"
34523 The &%recipient_item%& structure contains these members:
34524
34525 .vlist
34526 .vitem &*uschar&~*address*&
34527 This is a pointer to the recipient address as it was received.
34528
34529 .vitem &*int&~pno*&
34530 This is used in later Exim processing when top level addresses are created by
34531 the &%one_time%& option. It is not relevant at the time &[local_scan()]& is run
34532 and must always contain -1 at this stage.
34533
34534 .vitem &*uschar&~*errors_to*&
34535 If this value is not NULL, bounce messages caused by failing to deliver to the
34536 recipient are sent to the address it contains. In other words, it overrides the
34537 envelope sender for this one recipient. (Compare the &%errors_to%& generic
34538 router option.) If a &[local_scan()]& function sets an &%errors_to%& field to
34539 an unqualified address, Exim qualifies it using the domain from
34540 &%qualify_recipient%&. When &[local_scan()]& is called, the &%errors_to%& field
34541 is NULL for all recipients.
34542 .endlist
34543
34544
34545
34546 .section "Available Exim functions" "SECID211"
34547 .cindex "&[local_scan()]& function" "available Exim functions"
34548 The header &_local_scan.h_& gives you access to a number of Exim functions.
34549 These are the only ones that are guaranteed to be maintained from release to
34550 release:
34551
34552 .vlist
34553 .vitem "&*pid_t&~child_open(uschar&~**argv,&~uschar&~**envp,&~int&~newumask,&&&
34554        &~int&~*infdptr,&~int&~*outfdptr, &~&~BOOL&~make_leader)*&"
34555
34556 This function creates a child process that runs the command specified by
34557 &%argv%&. The environment for the process is specified by &%envp%&, which can
34558 be NULL if no environment variables are to be passed. A new umask is supplied
34559 for the process in &%newumask%&.
34560
34561 Pipes to the standard input and output of the new process are set up
34562 and returned to the caller via the &%infdptr%& and &%outfdptr%& arguments. The
34563 standard error is cloned to the standard output. If there are any file
34564 descriptors &"in the way"& in the new process, they are closed. If the final
34565 argument is TRUE, the new process is made into a process group leader.
34566
34567 The function returns the pid of the new process, or -1 if things go wrong.
34568
34569 .vitem &*int&~child_close(pid_t&~pid,&~int&~timeout)*&
34570 This function waits for a child process to terminate, or for a timeout (in
34571 seconds) to expire. A timeout value of zero means wait as long as it takes. The
34572 return value is as follows:
34573
34574 .ilist
34575 >= 0
34576
34577 The process terminated by a normal exit and the value is the process
34578 ending status.
34579
34580 .next
34581 < 0 and > &--256
34582
34583 The process was terminated by a signal and the value is the negation of the
34584 signal number.
34585
34586 .next
34587 &--256
34588
34589 The process timed out.
34590 .next
34591 &--257
34592
34593 The was some other error in wait(); &%errno%& is still set.
34594 .endlist
34595
34596 .vitem &*pid_t&~child_open_exim(int&~*fd)*&
34597 This function provide you with a means of submitting a new message to
34598 Exim. (Of course, you can also call &_/usr/sbin/sendmail_& yourself if you
34599 want, but this packages it all up for you.) The function creates a pipe,
34600 forks a subprocess that is running
34601 .code
34602 exim -t -oem -oi -f <>
34603 .endd
34604 and returns to you (via the &`int *`& argument) a file descriptor for the pipe
34605 that is connected to the standard input. The yield of the function is the PID
34606 of the subprocess. You can then write a message to the file descriptor, with
34607 recipients in &'To:'&, &'Cc:'&, and/or &'Bcc:'& header lines.
34608
34609 When you have finished, call &'child_close()'& to wait for the process to
34610 finish and to collect its ending status. A timeout value of zero is usually
34611 fine in this circumstance. Unless you have made a mistake with the recipient
34612 addresses, you should get a return code of zero.
34613
34614
34615 .vitem &*pid_t&~child_open_exim2(int&~*fd,&~uschar&~*sender,&~uschar&~&&&
34616        *sender_authentication)*&
34617 This function is a more sophisticated version of &'child_open()'&. The command
34618 that it runs is:
34619 .display
34620 &`exim -t -oem -oi -f `&&'sender'&&` -oMas `&&'sender_authentication'&
34621 .endd
34622 The third argument may be NULL, in which case the &%-oMas%& option is omitted.
34623
34624
34625 .vitem &*void&~debug_printf(char&~*,&~...)*&
34626 This is Exim's debugging function, with arguments as for &'(printf()'&. The
34627 output is written to the standard error stream. If no debugging is selected,
34628 calls to &'debug_printf()'& have no effect. Normally, you should make calls
34629 conditional on the &`local_scan`& debug selector by coding like this:
34630 .code
34631 if ((debug_selector & D_local_scan) != 0)
34632   debug_printf("xxx", ...);
34633 .endd
34634
34635 .vitem &*uschar&~*expand_string(uschar&~*string)*&
34636 This is an interface to Exim's string expansion code. The return value is the
34637 expanded string, or NULL if there was an expansion failure.
34638 The C variable &%expand_string_message%& contains an error message after an
34639 expansion failure. If expansion does not change the string, the return value is
34640 the pointer to the input string. Otherwise, the return value points to a new
34641 block of memory that was obtained by a call to &'store_get()'&. See section
34642 &<<SECTmemhanloc>>& below for a discussion of memory handling.
34643
34644 .vitem &*void&~header_add(int&~type,&~char&~*format,&~...)*&
34645 This function allows you to an add additional header line at the end of the
34646 existing ones. The first argument is the type, and should normally be a space
34647 character. The second argument is a format string and any number of
34648 substitution arguments as for &[sprintf()]&. You may include internal newlines
34649 if you want, and you must ensure that the string ends with a newline.
34650
34651 .vitem "&*void&~header_add_at_position(BOOL&~after,&~uschar&~*name,&~&&&
34652         BOOL&~topnot,&~int&~type,&~char&~*format, &~&~...)*&"
34653 This function adds a new header line at a specified point in the header
34654 chain. The header itself is specified as for &'header_add()'&.
34655
34656 If &%name%& is NULL, the new header is added at the end of the chain if
34657 &%after%& is true, or at the start if &%after%& is false. If &%name%& is not
34658 NULL, the header lines are searched for the first non-deleted header that
34659 matches the name. If one is found, the new header is added before it if
34660 &%after%& is false. If &%after%& is true, the new header is added after the
34661 found header and any adjacent subsequent ones with the same name (even if
34662 marked &"deleted"&). If no matching non-deleted header is found, the &%topnot%&
34663 option controls where the header is added. If it is true, addition is at the
34664 top; otherwise at the bottom. Thus, to add a header after all the &'Received:'&
34665 headers, or at the top if there are no &'Received:'& headers, you could use
34666 .code
34667 header_add_at_position(TRUE, US"Received", TRUE,
34668   ' ', "X-xxx: ...");
34669 .endd
34670 Normally, there is always at least one non-deleted &'Received:'& header, but
34671 there may not be if &%received_header_text%& expands to an empty string.
34672
34673
34674 .vitem &*void&~header_remove(int&~occurrence,&~uschar&~*name)*&
34675 This function removes header lines. If &%occurrence%& is zero or negative, all
34676 occurrences of the header are removed. If occurrence is greater than zero, that
34677 particular instance of the header is removed. If no header(s) can be found that
34678 match the specification, the function does nothing.
34679
34680
34681 .vitem "&*BOOL&~header_testname(header_line&~*hdr,&~uschar&~*name,&~&&&
34682         int&~length,&~BOOL&~notdel)*&"
34683 This function tests whether the given header has the given name. It is not just
34684 a string comparison, because white space is permitted between the name and the
34685 colon. If the &%notdel%& argument is true, a false return is forced for all
34686 &"deleted"& headers; otherwise they are not treated specially. For example:
34687 .code
34688 if (header_testname(h, US"X-Spam", 6, TRUE)) ...
34689 .endd
34690 .vitem &*uschar&~*lss_b64encode(uschar&~*cleartext,&~int&~length)*&
34691 .cindex "base64 encoding" "functions for &[local_scan()]& use"
34692 This function base64-encodes a string, which is passed by address and length.
34693 The text may contain bytes of any value, including zero. The result is passed
34694 back in dynamic memory that is obtained by calling &'store_get()'&. It is
34695 zero-terminated.
34696
34697 .vitem &*int&~lss_b64decode(uschar&~*codetext,&~uschar&~**cleartext)*&
34698 This function decodes a base64-encoded string. Its arguments are a
34699 zero-terminated base64-encoded string and the address of a variable that is set
34700 to point to the result, which is in dynamic memory. The length of the decoded
34701 string is the yield of the function. If the input is invalid base64 data, the
34702 yield is -1. A zero byte is added to the end of the output string to make it
34703 easy to interpret as a C string (assuming it contains no zeros of its own). The
34704 added zero byte is not included in the returned count.
34705
34706 .vitem &*int&~lss_match_domain(uschar&~*domain,&~uschar&~*list)*&
34707 This function checks for a match in a domain list. Domains are always
34708 matched caselessly. The return value is one of the following:
34709 .display
34710 &`OK     `& match succeeded
34711 &`FAIL   `& match failed
34712 &`DEFER  `& match deferred
34713 .endd
34714 DEFER is usually caused by some kind of lookup defer, such as the
34715 inability to contact a database.
34716
34717 .vitem "&*int&~lss_match_local_part(uschar&~*localpart,&~uschar&~*list,&~&&&
34718         BOOL&~caseless)*&"
34719 This function checks for a match in a local part list. The third argument
34720 controls case-sensitivity. The return values are as for
34721 &'lss_match_domain()'&.
34722
34723 .vitem "&*int&~lss_match_address(uschar&~*address,&~uschar&~*list,&~&&&
34724         BOOL&~caseless)*&"
34725 This function checks for a match in an address list. The third argument
34726 controls the case-sensitivity of the local part match. The domain is always
34727 matched caselessly. The return values are as for &'lss_match_domain()'&.
34728
34729 .vitem "&*int&~lss_match_host(uschar&~*host_name,&~uschar&~*host_address,&~&&&
34730         uschar&~*list)*&"
34731 This function checks for a match in a host list. The most common usage is
34732 expected to be
34733 .code
34734 lss_match_host(sender_host_name, sender_host_address, ...)
34735 .endd
34736 .vindex "&$sender_host_address$&"
34737 An empty address field matches an empty item in the host list. If the host name
34738 is NULL, the name corresponding to &$sender_host_address$& is automatically
34739 looked up if a host name is required to match an item in the list. The return
34740 values are as for &'lss_match_domain()'&, but in addition, &'lss_match_host()'&
34741 returns ERROR in the case when it had to look up a host name, but the lookup
34742 failed.
34743
34744 .vitem "&*void&~log_write(unsigned&~int&~selector,&~int&~which,&~char&~&&&
34745         *format,&~...)*&"
34746 This function writes to Exim's log files. The first argument should be zero (it
34747 is concerned with &%log_selector%&). The second argument can be &`LOG_MAIN`& or
34748 &`LOG_REJECT`& or &`LOG_PANIC`& or the inclusive &"or"& of any combination of
34749 them. It specifies to which log or logs the message is written. The remaining
34750 arguments are a format and relevant insertion arguments. The string should not
34751 contain any newlines, not even at the end.
34752
34753
34754 .vitem &*void&~receive_add_recipient(uschar&~*address,&~int&~pno)*&
34755 This function adds an additional recipient to the message. The first argument
34756 is the recipient address. If it is unqualified (has no domain), it is qualified
34757 with the &%qualify_recipient%& domain. The second argument must always be -1.
34758
34759 This function does not allow you to specify a private &%errors_to%& address (as
34760 described with the structure of &%recipient_item%& above), because it pre-dates
34761 the addition of that field to the structure. However, it is easy to add such a
34762 value afterwards. For example:
34763 .code
34764  receive_add_recipient(US"monitor@mydom.example", -1);
34765  recipients_list[recipients_count-1].errors_to =
34766    US"postmaster@mydom.example";
34767 .endd
34768
34769 .vitem &*BOOL&~receive_remove_recipient(uschar&~*recipient)*&
34770 This is a convenience function to remove a named recipient from the list of
34771 recipients. It returns true if a recipient was removed, and false if no
34772 matching recipient could be found. The argument must be a complete email
34773 address.
34774 .endlist
34775
34776
34777 .cindex "RFC 2047"
34778 .vlist
34779 .vitem "&*uschar&~rfc2047_decode(uschar&~*string,&~BOOL&~lencheck,&&&
34780   &~uschar&~*target,&~int&~zeroval,&~int&~*lenptr, &~&~uschar&~**error)*&"
34781 This function decodes strings that are encoded according to RFC 2047. Typically
34782 these are the contents of header lines. First, each &"encoded word"& is decoded
34783 from the Q or B encoding into a byte-string. Then, if provided with the name of
34784 a charset encoding, and if the &[iconv()]& function is available, an attempt is
34785 made  to translate the result to the named character set. If this fails, the
34786 binary string is returned with an error message.
34787
34788 The first argument is the string to be decoded. If &%lencheck%& is TRUE, the
34789 maximum MIME word length is enforced. The third argument is the target
34790 encoding, or NULL if no translation is wanted.
34791
34792 .cindex "binary zero" "in RFC 2047 decoding"
34793 .cindex "RFC 2047" "binary zero in"
34794 If a binary zero is encountered in the decoded string, it is replaced by the
34795 contents of the &%zeroval%& argument. For use with Exim headers, the value must
34796 not be 0 because header lines are handled as zero-terminated strings.
34797
34798 The function returns the result of processing the string, zero-terminated; if
34799 &%lenptr%& is not NULL, the length of the result is set in the variable to
34800 which it points. When &%zeroval%& is 0, &%lenptr%& should not be NULL.
34801
34802 If an error is encountered, the function returns NULL and uses the &%error%&
34803 argument to return an error message. The variable pointed to by &%error%& is
34804 set to NULL if there is no error; it may be set non-NULL even when the function
34805 returns a non-NULL value if decoding was successful, but there was a problem
34806 with translation.
34807
34808
34809 .vitem &*int&~smtp_fflush(void)*&
34810 This function is used in conjunction with &'smtp_printf()'&, as described
34811 below.
34812
34813 .vitem &*void&~smtp_printf(char&~*,BOOL,&~...)*&
34814 The arguments of this function are almost like &[printf()]&; it writes to the SMTP
34815 output stream. You should use this function only when there is an SMTP output
34816 stream, that is, when the incoming message is being received via interactive
34817 SMTP. This is the case when &%smtp_input%& is TRUE and &%smtp_batched_input%&
34818 is FALSE. If you want to test for an incoming message from another host (as
34819 opposed to a local process that used the &%-bs%& command line option), you can
34820 test the value of &%sender_host_address%&, which is non-NULL when a remote host
34821 is involved.
34822
34823 If an SMTP TLS connection is established, &'smtp_printf()'& uses the TLS
34824 output function, so it can be used for all forms of SMTP connection.
34825
34826 The second argument is used to request that the data be buffered
34827 (when TRUE) or flushed (along with any previously buffered, when FALSE).
34828 This is advisory only, but likely to save on system-calls and packets
34829 sent when a sequence of calls to the function are made.
34830
34831 The argument was added in Exim version 4.90 - changing the API/ABI.
34832 Nobody noticed until 4.93 was imminent, at which point the
34833 ABI version number was incremented.
34834
34835 Strings that are written by &'smtp_printf()'& from within &[local_scan()]&
34836 must start with an appropriate response code: 550 if you are going to return
34837 LOCAL_SCAN_REJECT, 451 if you are going to return
34838 LOCAL_SCAN_TEMPREJECT, and 250 otherwise. Because you are writing the
34839 initial lines of a multi-line response, the code must be followed by a hyphen
34840 to indicate that the line is not the final response line. You must also ensure
34841 that the lines you write terminate with CRLF. For example:
34842 .code
34843 smtp_printf("550-this is some extra info\r\n");
34844 return LOCAL_SCAN_REJECT;
34845 .endd
34846 Note that you can also create multi-line responses by including newlines in
34847 the data returned via the &%return_text%& argument. The added value of using
34848 &'smtp_printf()'& is that, for instance, you could introduce delays between
34849 multiple output lines.
34850
34851 The &'smtp_printf()'& function does not return any error indication, because it
34852 does not
34853 guarantee a flush of
34854 pending output, and therefore does not test
34855 the state of the stream. (In the main code of Exim, flushing and error
34856 detection is done when Exim is ready for the next SMTP input command.) If
34857 you want to flush the output and check for an error (for example, the
34858 dropping of a TCP/IP connection), you can call &'smtp_fflush()'&, which has no
34859 arguments. It flushes the output stream, and returns a non-zero value if there
34860 is an error.
34861
34862 .new
34863 .vitem &*void&~*store_get(int,BOOL)*&
34864 This function accesses Exim's internal store (memory) manager. It gets a new
34865 chunk of memory whose size is given by the first argument.
34866 The second argument should be given as TRUE if the memory will be used for
34867 data possibly coming from an attacker (eg. the message content),
34868 FALSE if it is locally-sourced.
34869 Exim bombs out if it ever
34870 runs out of memory. See the next section for a discussion of memory handling.
34871 .wen
34872
34873 .vitem &*void&~*store_get_perm(int,BOOL)*&
34874 This function is like &'store_get()'&, but it always gets memory from the
34875 permanent pool. See the next section for a discussion of memory handling.
34876
34877 .vitem &*uschar&~*string_copy(uschar&~*string)*&
34878 See below.
34879
34880 .vitem &*uschar&~*string_copyn(uschar&~*string,&~int&~length)*&
34881 See below.
34882
34883 .vitem &*uschar&~*string_sprintf(char&~*format,&~...)*&
34884 These three functions create strings using Exim's dynamic memory facilities.
34885 The first makes a copy of an entire string. The second copies up to a maximum
34886 number of characters, indicated by the second argument. The third uses a format
34887 and insertion arguments to create a new string. In each case, the result is a
34888 pointer to a new string in the current memory pool. See the next section for
34889 more discussion.
34890 .endlist
34891
34892
34893
34894 .section "More about Exim's memory handling" "SECTmemhanloc"
34895 .cindex "&[local_scan()]& function" "memory handling"
34896 No function is provided for freeing memory, because that is never needed.
34897 The dynamic memory that Exim uses when receiving a message is automatically
34898 recycled if another message is received by the same process (this applies only
34899 to incoming SMTP connections &-- other input methods can supply only one
34900 message at a time). After receiving the last message, a reception process
34901 terminates.
34902
34903 Because it is recycled, the normal dynamic memory cannot be used for holding
34904 data that must be preserved over a number of incoming messages on the same SMTP
34905 connection. However, Exim in fact uses two pools of dynamic memory; the second
34906 one is not recycled, and can be used for this purpose.
34907
34908 If you want to allocate memory that remains available for subsequent messages
34909 in the same SMTP connection, you should set
34910 .code
34911 store_pool = POOL_PERM
34912 .endd
34913 before calling the function that does the allocation. There is no need to
34914 restore the value if you do not need to; however, if you do want to revert to
34915 the normal pool, you can either restore the previous value of &%store_pool%& or
34916 set it explicitly to POOL_MAIN.
34917
34918 The pool setting applies to all functions that get dynamic memory, including
34919 &'expand_string()'&, &'store_get()'&, and the &'string_xxx()'& functions.
34920 There is also a convenience function called &'store_get_perm()'& that gets a
34921 block of memory from the permanent pool while preserving the value of
34922 &%store_pool%&.
34923 .ecindex IIDlosca
34924
34925
34926
34927
34928 . ////////////////////////////////////////////////////////////////////////////
34929 . ////////////////////////////////////////////////////////////////////////////
34930
34931 .chapter "System-wide message filtering" "CHAPsystemfilter"
34932 .scindex IIDsysfil1 "filter" "system filter"
34933 .scindex IIDsysfil2 "filtering all mail"
34934 .scindex IIDsysfil3 "system filter"
34935 The previous chapters (on ACLs and the local scan function) describe checks
34936 that can be applied to messages before they are accepted by a host. There is
34937 also a mechanism for checking messages once they have been received, but before
34938 they are delivered. This is called the &'system filter'&.
34939
34940 The system filter operates in a similar manner to users' filter files, but it
34941 is run just once per message (however many recipients the message has).
34942 It should not normally be used as a substitute for routing, because &%deliver%&
34943 commands in a system router provide new envelope recipient addresses.
34944 The system filter must be an Exim filter. It cannot be a Sieve filter.
34945
34946 The system filter is run at the start of a delivery attempt, before any routing
34947 is done. If a message fails to be completely delivered at the first attempt,
34948 the system filter is run again at the start of every retry.
34949 If you want your filter to do something only once per message, you can make use
34950 of the &%first_delivery%& condition in an &%if%& command in the filter to
34951 prevent it happening on retries.
34952
34953 .vindex "&$domain$&"
34954 .vindex "&$local_part$&"
34955 &*Warning*&: Because the system filter runs just once, variables that are
34956 specific to individual recipient addresses, such as &$local_part$& and
34957 &$domain$&, are not set, and the &"personal"& condition is not meaningful. If
34958 you want to run a centrally-specified filter for each recipient address
34959 independently, you can do so by setting up a suitable &(redirect)& router, as
34960 described in section &<<SECTperaddfil>>& below.
34961
34962
34963 .section "Specifying a system filter" "SECID212"
34964 .cindex "uid (user id)" "system filter"
34965 .cindex "gid (group id)" "system filter"
34966 The name of the file that contains the system filter must be specified by
34967 setting &%system_filter%&. If you want the filter to run under a uid and gid
34968 other than root, you must also set &%system_filter_user%& and
34969 &%system_filter_group%& as appropriate. For example:
34970 .code
34971 system_filter = /etc/mail/exim.filter
34972 system_filter_user = exim
34973 .endd
34974 If a system filter generates any deliveries directly to files or pipes (via the
34975 &%save%& or &%pipe%& commands), transports to handle these deliveries must be
34976 specified by setting &%system_filter_file_transport%& and
34977 &%system_filter_pipe_transport%&, respectively. Similarly,
34978 &%system_filter_reply_transport%& must be set to handle any messages generated
34979 by the &%reply%& command.
34980
34981
34982 .section "Testing a system filter" "SECID213"
34983 You can run simple tests of a system filter in the same way as for a user
34984 filter, but you should use &%-bF%& rather than &%-bf%&, so that features that
34985 are permitted only in system filters are recognized.
34986
34987 If you want to test the combined effect of a system filter and a user filter,
34988 you can use both &%-bF%& and &%-bf%& on the same command line.
34989
34990
34991
34992 .section "Contents of a system filter" "SECID214"
34993 The language used to specify system filters is the same as for users' filter
34994 files. It is described in the separate end-user document &'Exim's interface to
34995 mail filtering'&. However, there are some additional features that are
34996 available only in system filters; these are described in subsequent sections.
34997 If they are encountered in a user's filter file or when testing with &%-bf%&,
34998 they cause errors.
34999
35000 .cindex "frozen messages" "manual thaw; testing in filter"
35001 There are two special conditions which, though available in users' filter
35002 files, are designed for use in system filters. The condition &%first_delivery%&
35003 is true only for the first attempt at delivering a message, and
35004 &%manually_thawed%& is true only if the message has been frozen, and
35005 subsequently thawed by an admin user. An explicit forced delivery counts as a
35006 manual thaw, but thawing as a result of the &%auto_thaw%& setting does not.
35007
35008 &*Warning*&: If a system filter uses the &%first_delivery%& condition to
35009 specify an &"unseen"& (non-significant) delivery, and that delivery does not
35010 succeed, it will not be tried again.
35011 If you want Exim to retry an unseen delivery until it succeeds, you should
35012 arrange to set it up every time the filter runs.
35013
35014 When a system filter finishes running, the values of the variables &$n0$& &--
35015 &$n9$& are copied into &$sn0$& &-- &$sn9$& and are thereby made available to
35016 users' filter files. Thus a system filter can, for example, set up &"scores"&
35017 to which users' filter files can refer.
35018
35019
35020
35021 .section "Additional variable for system filters" "SECID215"
35022 .vindex "&$recipients$&"
35023 The expansion variable &$recipients$&, containing a list of all the recipients
35024 of the message (separated by commas and white space), is available in system
35025 filters. It is not available in users' filters for privacy reasons.
35026
35027
35028
35029 .section "Defer, freeze, and fail commands for system filters" "SECID216"
35030 .cindex "freezing messages"
35031 .cindex "message" "freezing"
35032 .cindex "message" "forced failure"
35033 .cindex "&%fail%&" "in system filter"
35034 .cindex "&%freeze%& in system filter"
35035 .cindex "&%defer%& in system filter"
35036 There are three extra commands (&%defer%&, &%freeze%& and &%fail%&) which are
35037 always available in system filters, but are not normally enabled in users'
35038 filters. (See the &%allow_defer%&, &%allow_freeze%& and &%allow_fail%& options
35039 for the &(redirect)& router.) These commands can optionally be followed by the
35040 word &%text%& and a string containing an error message, for example:
35041 .code
35042 fail text "this message looks like spam to me"
35043 .endd
35044 The keyword &%text%& is optional if the next character is a double quote.
35045
35046 The &%defer%& command defers delivery of the original recipients of the
35047 message. The &%fail%& command causes all the original recipients to be failed,
35048 and a bounce message to be created. The &%freeze%& command suspends all
35049 delivery attempts for the original recipients. In all cases, any new deliveries
35050 that are specified by the filter are attempted as normal after the filter has
35051 run.
35052
35053 The &%freeze%& command is ignored if the message has been manually unfrozen and
35054 not manually frozen since. This means that automatic freezing by a system
35055 filter can be used as a way of checking out suspicious messages. If a message
35056 is found to be all right, manually unfreezing it allows it to be delivered.
35057
35058 .cindex "log" "&%fail%& command log line"
35059 .cindex "&%fail%&" "log line; reducing"
35060 The text given with a fail command is used as part of the bounce message as
35061 well as being written to the log. If the message is quite long, this can fill
35062 up a lot of log space when such failures are common. To reduce the size of the
35063 log message, Exim interprets the text in a special way if it starts with the
35064 two characters &`<<`& and contains &`>>`& later. The text between these two
35065 strings is written to the log, and the rest of the text is used in the bounce
35066 message. For example:
35067 .code
35068 fail "<<filter test 1>>Your message is rejected \
35069      because it contains attachments that we are \
35070      not prepared to receive."
35071 .endd
35072
35073 .cindex "loop" "caused by &%fail%&"
35074 Take great care with the &%fail%& command when basing the decision to fail on
35075 the contents of the message, because the bounce message will of course include
35076 the contents of the original message and will therefore trigger the &%fail%&
35077 command again (causing a mail loop) unless steps are taken to prevent this.
35078 Testing the &%error_message%& condition is one way to prevent this. You could
35079 use, for example
35080 .code
35081 if $message_body contains "this is spam" and not error_message
35082 then fail text "spam is not wanted here" endif
35083 .endd
35084 though of course that might let through unwanted bounce messages. The
35085 alternative is clever checking of the body and/or headers to detect bounces
35086 generated by the filter.
35087
35088 The interpretation of a system filter file ceases after a
35089 &%defer%&,
35090 &%freeze%&, or &%fail%& command is obeyed. However, any deliveries that were
35091 set up earlier in the filter file are honoured, so you can use a sequence such
35092 as
35093 .code
35094 mail ...
35095 freeze
35096 .endd
35097 to send a specified message when the system filter is freezing (or deferring or
35098 failing) a message. The normal deliveries for the message do not, of course,
35099 take place.
35100
35101
35102
35103 .section "Adding and removing headers in a system filter" "SECTaddremheasys"
35104 .cindex "header lines" "adding; in system filter"
35105 .cindex "header lines" "removing; in system filter"
35106 .cindex "filter" "header lines; adding/removing"
35107 Two filter commands that are available only in system filters are:
35108 .code
35109 headers add <string>
35110 headers remove <string>
35111 .endd
35112 The argument for the &%headers add%& is a string that is expanded and then
35113 added to the end of the message's headers. It is the responsibility of the
35114 filter maintainer to make sure it conforms to RFC 2822 syntax. Leading white
35115 space is ignored, and if the string is otherwise empty, or if the expansion is
35116 forced to fail, the command has no effect.
35117
35118 You can use &"\n"& within the string, followed by white space, to specify
35119 continued header lines. More than one header may be added in one command by
35120 including &"\n"& within the string without any following white space. For
35121 example:
35122 .code
35123 headers add "X-header-1: ....\n  \
35124              continuation of X-header-1 ...\n\
35125              X-header-2: ...."
35126 .endd
35127 Note that the header line continuation white space after the first newline must
35128 be placed before the backslash that continues the input string, because white
35129 space after input continuations is ignored.
35130
35131 The argument for &%headers remove%& is a colon-separated list of header names.
35132 This command applies only to those headers that are stored with the message;
35133 those that are added at delivery time (such as &'Envelope-To:'& and
35134 &'Return-Path:'&) cannot be removed by this means. If there is more than one
35135 header with the same name, they are all removed.
35136
35137 The &%headers%& command in a system filter makes an immediate change to the set
35138 of header lines that was received with the message (with possible additions
35139 from ACL processing). Subsequent commands in the system filter operate on the
35140 modified set, which also forms the basis for subsequent message delivery.
35141 Unless further modified during routing or transporting, this set of headers is
35142 used for all recipients of the message.
35143
35144 During routing and transporting, the variables that refer to the contents of
35145 header lines refer only to those lines that are in this set. Thus, header lines
35146 that are added by a system filter are visible to users' filter files and to all
35147 routers and transports. This contrasts with the manipulation of header lines by
35148 routers and transports, which is not immediate, but which instead is saved up
35149 until the message is actually being written (see section
35150 &<<SECTheadersaddrem>>&).
35151
35152 If the message is not delivered at the first attempt, header lines that were
35153 added by the system filter are stored with the message, and so are still
35154 present at the next delivery attempt. Header lines that were removed are still
35155 present, but marked &"deleted"& so that they are not transported with the
35156 message. For this reason, it is usual to make the &%headers%& command
35157 conditional on &%first_delivery%& so that the set of header lines is not
35158 modified more than once.
35159
35160 Because header modification in a system filter acts immediately, you have to
35161 use an indirect approach if you want to modify the contents of a header line.
35162 For example:
35163 .code
35164 headers add "Old-Subject: $h_subject:"
35165 headers remove "Subject"
35166 headers add "Subject: new subject (was: $h_old-subject:)"
35167 headers remove "Old-Subject"
35168 .endd
35169
35170
35171
35172 .section "Setting an errors address in a system filter" "SECID217"
35173 .cindex "envelope from"
35174 .cindex "envelope sender"
35175 In a system filter, if a &%deliver%& command is followed by
35176 .code
35177 errors_to <some address>
35178 .endd
35179 in order to change the envelope sender (and hence the error reporting) for that
35180 delivery, any address may be specified. (In a user filter, only the current
35181 user's address can be set.) For example, if some mail is being monitored, you
35182 might use
35183 .code
35184 unseen deliver monitor@spying.example errors_to root@local.example
35185 .endd
35186 to take a copy which would not be sent back to the normal error reporting
35187 address if its delivery failed.
35188
35189
35190
35191 .section "Per-address filtering" "SECTperaddfil"
35192 .vindex "&$domain$&"
35193 .vindex "&$local_part$&"
35194 In contrast to the system filter, which is run just once per message for each
35195 delivery attempt, it is also possible to set up a system-wide filtering
35196 operation that runs once for each recipient address. In this case, variables
35197 such as &$local_part$& and &$domain$& can be used, and indeed, the choice of
35198 filter file could be made dependent on them. This is an example of a router
35199 which implements such a filter:
35200 .code
35201 central_filter:
35202   check_local_user
35203   driver = redirect
35204   domains = +local_domains
35205   file = /central/filters/$local_part_data
35206   no_verify
35207   allow_filter
35208   allow_freeze
35209 .endd
35210 The filter is run in a separate process under its own uid. Therefore, either
35211 &%check_local_user%& must be set (as above), in which case the filter is run as
35212 the local user, or the &%user%& option must be used to specify which user to
35213 use. If both are set, &%user%& overrides.
35214
35215 Care should be taken to ensure that none of the commands in the filter file
35216 specify a significant delivery if the message is to go on to be delivered to
35217 its intended recipient. The router will not then claim to have dealt with the
35218 address, so it will be passed on to subsequent routers to be delivered in the
35219 normal way.
35220 .ecindex IIDsysfil1
35221 .ecindex IIDsysfil2
35222 .ecindex IIDsysfil3
35223
35224
35225
35226
35227
35228
35229 . ////////////////////////////////////////////////////////////////////////////
35230 . ////////////////////////////////////////////////////////////////////////////
35231
35232 .chapter "Message processing" "CHAPmsgproc"
35233 .scindex IIDmesproc "message" "general processing"
35234 Exim performs various transformations on the sender and recipient addresses of
35235 all messages that it handles, and also on the messages' header lines. Some of
35236 these are optional and configurable, while others always take place. All of
35237 this processing, except rewriting as a result of routing, and the addition or
35238 removal of header lines while delivering, happens when a message is received,
35239 before it is placed on Exim's queue.
35240
35241 Some of the automatic processing takes place by default only for
35242 &"locally-originated"& messages. This adjective is used to describe messages
35243 that are not received over TCP/IP, but instead are passed to an Exim process on
35244 its standard input. This includes the interactive &"local SMTP"& case that is
35245 set up by the &%-bs%& command line option.
35246
35247 &*Note*&: Messages received over TCP/IP on the loopback interface (127.0.0.1
35248 or ::1) are not considered to be locally-originated. Exim does not treat the
35249 loopback interface specially in any way.
35250
35251 If you want the loopback interface to be treated specially, you must ensure
35252 that there are appropriate entries in your ACLs.
35253
35254
35255
35256
35257 .section "Submission mode for non-local messages" "SECTsubmodnon"
35258 .cindex "message" "submission"
35259 .cindex "submission mode"
35260 Processing that happens automatically for locally-originated messages (unless
35261 &%suppress_local_fixups%& is set) can also be requested for messages that are
35262 received over TCP/IP. The term &"submission mode"& is used to describe this
35263 state. Submission mode is set by the modifier
35264 .code
35265 control = submission
35266 .endd
35267 in a MAIL, RCPT, or pre-data ACL for an incoming message (see sections
35268 &<<SECTACLmodi>>& and &<<SECTcontrols>>&). This makes Exim treat the message as
35269 a local submission, and is normally used when the source of the message is
35270 known to be an MUA running on a client host (as opposed to an MTA). For
35271 example, to set submission mode for messages originating on the IPv4 loopback
35272 interface, you could include the following in the MAIL ACL:
35273 .code
35274 warn  hosts = 127.0.0.1
35275       control = submission
35276 .endd
35277 .cindex "&%sender_retain%& submission option"
35278 There are some options that can be used when setting submission mode. A slash
35279 is used to separate options. For example:
35280 .code
35281 control = submission/sender_retain
35282 .endd
35283 Specifying &%sender_retain%& has the effect of setting &%local_sender_retain%&
35284 true and &%local_from_check%& false for the current incoming message. The first
35285 of these allows an existing &'Sender:'& header in the message to remain, and
35286 the second suppresses the check to ensure that &'From:'& matches the
35287 authenticated sender. With this setting, Exim still fixes up messages by adding
35288 &'Date:'& and &'Message-ID:'& header lines if they are missing, but makes no
35289 attempt to check sender authenticity in header lines.
35290
35291 When &%sender_retain%& is not set, a submission mode setting may specify a
35292 domain to be used when generating a &'From:'& or &'Sender:'& header line. For
35293 example:
35294 .code
35295 control = submission/domain=some.domain
35296 .endd
35297 The domain may be empty. How this value is used is described in sections
35298 &<<SECTthefrohea>>& and &<<SECTthesenhea>>&. There is also a &%name%& option
35299 that allows you to specify the user's full name for inclusion in a created
35300 &'Sender:'& or &'From:'& header line. For example:
35301 .code
35302 accept authenticated = *
35303        control = submission/domain=wonderland.example/\
35304                             name=${lookup {$authenticated_id} \
35305                                    lsearch {/etc/exim/namelist}}
35306 .endd
35307 Because the name may contain any characters, including slashes, the &%name%&
35308 option must be given last. The remainder of the string is used as the name. For
35309 the example above, if &_/etc/exim/namelist_& contains:
35310 .code
35311 bigegg:  Humpty Dumpty
35312 .endd
35313 then when the sender has authenticated as &'bigegg'&, the generated &'Sender:'&
35314 line would be:
35315 .code
35316 Sender: Humpty Dumpty <bigegg@wonderland.example>
35317 .endd
35318 .cindex "return path" "in submission mode"
35319 By default, submission mode forces the return path to the same address as is
35320 used to create the &'Sender:'& header. However, if &%sender_retain%& is
35321 specified, the return path is also left unchanged.
35322
35323 &*Note*&: The changes caused by submission mode take effect after the predata
35324 ACL. This means that any sender checks performed before the fix-ups use the
35325 untrusted sender address specified by the user, not the trusted sender address
35326 specified by submission mode. Although this might be slightly unexpected, it
35327 does mean that you can configure ACL checks to spot that a user is trying to
35328 spoof another's address.
35329
35330 .section "Line endings" "SECTlineendings"
35331 .cindex "line endings"
35332 .cindex "carriage return"
35333 .cindex "linefeed"
35334 RFC 2821 specifies that CRLF (two characters: carriage-return, followed by
35335 linefeed) is the line ending for messages transmitted over the Internet using
35336 SMTP over TCP/IP. However, within individual operating systems, different
35337 conventions are used. For example, Unix-like systems use just LF, but others
35338 use CRLF or just CR.
35339
35340 Exim was designed for Unix-like systems, and internally, it stores messages
35341 using the system's convention of a single LF as a line terminator. When
35342 receiving a message, all line endings are translated to this standard format.
35343 Originally, it was thought that programs that passed messages directly to an
35344 MTA within an operating system would use that system's convention. Experience
35345 has shown that this is not the case; for example, there are Unix applications
35346 that use CRLF in this circumstance. For this reason, and for compatibility with
35347 other MTAs, the way Exim handles line endings for all messages is now as
35348 follows:
35349
35350 .ilist
35351 LF not preceded by CR is treated as a line ending.
35352 .next
35353 CR is treated as a line ending; if it is immediately followed by LF, the LF
35354 is ignored.
35355 .next
35356 The sequence &"CR, dot, CR"& does not terminate an incoming SMTP message,
35357 nor a local message in the state where a line containing only a dot is a
35358 terminator.
35359 .next
35360 If a bare CR is encountered within a header line, an extra space is added after
35361 the line terminator so as not to end the header line. The reasoning behind this
35362 is that bare CRs in header lines are most likely either to be mistakes, or
35363 people trying to play silly games.
35364 .next
35365 If the first header line received in a message ends with CRLF, a subsequent
35366 bare LF in a header line is treated in the same way as a bare CR in a header
35367 line.
35368 .endlist
35369
35370
35371
35372
35373
35374 .section "Unqualified addresses" "SECID218"
35375 .cindex "unqualified addresses"
35376 .cindex "address" "qualification"
35377 By default, Exim expects every envelope address it receives from an external
35378 host to be fully qualified. Unqualified addresses cause negative responses to
35379 SMTP commands. However, because SMTP is used as a means of transporting
35380 messages from MUAs running on personal workstations, there is sometimes a
35381 requirement to accept unqualified addresses from specific hosts or IP networks.
35382
35383 Exim has two options that separately control which hosts may send unqualified
35384 sender or recipient addresses in SMTP commands, namely
35385 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&. In both
35386 cases, if an unqualified address is accepted, it is qualified by adding the
35387 value of &%qualify_domain%& or &%qualify_recipient%&, as appropriate.
35388
35389 .oindex "&%qualify_domain%&"
35390 .oindex "&%qualify_recipient%&"
35391 Unqualified addresses in header lines are automatically qualified for messages
35392 that are locally originated, unless the &%-bnq%& option is given on the command
35393 line. For messages received over SMTP, unqualified addresses in header lines
35394 are qualified only if unqualified addresses are permitted in SMTP commands. In
35395 other words, such qualification is also controlled by
35396 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&,
35397
35398
35399
35400
35401 .section "The UUCP From line" "SECID219"
35402 .cindex "&""From""& line"
35403 .cindex "UUCP" "&""From""& line"
35404 .cindex "sender" "address"
35405 .oindex "&%uucp_from_pattern%&"
35406 .oindex "&%uucp_from_sender%&"
35407 .cindex "envelope from"
35408 .cindex "envelope sender"
35409 .cindex "Sendmail compatibility" "&""From""& line"
35410 Messages that have come from UUCP (and some other applications) often begin
35411 with a line containing the envelope sender and a timestamp, following the word
35412 &"From"&. Examples of two common formats are:
35413 .code
35414 From a.oakley@berlin.mus Fri Jan  5 12:35 GMT 1996
35415 From f.butler@berlin.mus Fri, 7 Jan 97 14:00:00 GMT
35416 .endd
35417 This line precedes the RFC 2822 header lines. For compatibility with Sendmail,
35418 Exim recognizes such lines at the start of messages that are submitted to it
35419 via the command line (that is, on the standard input). It does not recognize
35420 such lines in incoming SMTP messages, unless the sending host matches
35421 &%ignore_fromline_hosts%& or the &%-bs%& option was used for a local message
35422 and &%ignore_fromline_local%& is set. The recognition is controlled by a
35423 regular expression that is defined by the &%uucp_from_pattern%& option, whose
35424 default value matches the two common cases shown above and puts the address
35425 that follows &"From"& into &$1$&.
35426
35427 .cindex "numerical variables (&$1$& &$2$& etc)" "in &""From ""& line handling"
35428 When the caller of Exim for a non-SMTP message that contains a &"From"& line is
35429 a trusted user, the message's sender address is constructed by expanding the
35430 contents of &%uucp_sender_address%&, whose default value is &"$1"&. This is
35431 then parsed as an RFC 2822 address. If there is no domain, the local part is
35432 qualified with &%qualify_domain%& unless it is the empty string. However, if
35433 the command line &%-f%& option is used, it overrides the &"From"& line.
35434
35435 If the caller of Exim is not trusted, the &"From"& line is recognized, but the
35436 sender address is not changed. This is also the case for incoming SMTP messages
35437 that are permitted to contain &"From"& lines.
35438
35439 Only one &"From"& line is recognized. If there is more than one, the second is
35440 treated as a data line that starts the body of the message, as it is not valid
35441 as a header line. This also happens if a &"From"& line is present in an
35442 incoming SMTP message from a source that is not permitted to send them.
35443
35444
35445
35446 .section "Resent- header lines" "SECID220"
35447 .cindex "&%Resent-%& header lines"
35448 .cindex "header lines" "Resent-"
35449 RFC 2822 makes provision for sets of header lines starting with the string
35450 &`Resent-`& to be added to a message when it is resent by the original
35451 recipient to somebody else. These headers are &'Resent-Date:'&,
35452 &'Resent-From:'&, &'Resent-Sender:'&, &'Resent-To:'&, &'Resent-Cc:'&,
35453 &'Resent-Bcc:'& and &'Resent-Message-ID:'&. The RFC says:
35454
35455 .blockquote
35456 &'Resent fields are strictly informational. They MUST NOT be used in the normal
35457 processing of replies or other such automatic actions on messages.'&
35458 .endblockquote
35459
35460 This leaves things a bit vague as far as other processing actions such as
35461 address rewriting are concerned. Exim treats &%Resent-%& header lines as
35462 follows:
35463
35464 .ilist
35465 A &'Resent-From:'& line that just contains the login id of the submitting user
35466 is automatically rewritten in the same way as &'From:'& (see below).
35467 .next
35468 If there's a rewriting rule for a particular header line, it is also applied to
35469 &%Resent-%& header lines of the same type. For example, a rule that rewrites
35470 &'From:'& also rewrites &'Resent-From:'&.
35471 .next
35472 For local messages, if &'Sender:'& is removed on input, &'Resent-Sender:'& is
35473 also removed.
35474 .next
35475 For a locally-submitted message,
35476 if there are any &%Resent-%& header lines but no &'Resent-Date:'&,
35477 &'Resent-From:'&, or &'Resent-Message-Id:'&, they are added as necessary. It is
35478 the contents of &'Resent-Message-Id:'& (rather than &'Message-Id:'&) which are
35479 included in log lines in this case.
35480 .next
35481 The logic for adding &'Sender:'& is duplicated for &'Resent-Sender:'& when any
35482 &%Resent-%& header lines are present.
35483 .endlist
35484
35485
35486
35487
35488 .section "The Auto-Submitted: header line" "SECID221"
35489 Whenever Exim generates an autoreply, a bounce, or a delay warning message, it
35490 includes the header line:
35491 .code
35492 Auto-Submitted: auto-replied
35493 .endd
35494
35495 .section "The Bcc: header line" "SECID222"
35496 .cindex "&'Bcc:'& header line"
35497 If Exim is called with the &%-t%& option, to take recipient addresses from a
35498 message's header, it removes any &'Bcc:'& header line that may exist (after
35499 extracting its addresses). If &%-t%& is not present on the command line, any
35500 existing &'Bcc:'& is not removed.
35501
35502
35503 .section "The Date: header line" "SECID223"
35504 .cindex "&'Date:'& header line"
35505 .cindex "header lines" "Date:"
35506 If a locally-generated or submission-mode message has no &'Date:'& header line,
35507 Exim adds one, using the current date and time, unless the
35508 &%suppress_local_fixups%& control has been specified.
35509
35510 .section "The Delivery-date: header line" "SECID224"
35511 .cindex "&'Delivery-date:'& header line"
35512 .oindex "&%delivery_date_remove%&"
35513 &'Delivery-date:'& header lines are not part of the standard RFC 2822 header
35514 set. Exim can be configured to add them to the final delivery of messages. (See
35515 the generic &%delivery_date_add%& transport option.) They should not be present
35516 in messages in transit. If the &%delivery_date_remove%& configuration option is
35517 set (the default), Exim removes &'Delivery-date:'& header lines from incoming
35518 messages.
35519
35520
35521 .section "The Envelope-to: header line" "SECID225"
35522 .cindex "&'Envelope-to:'& header line"
35523 .cindex "header lines" "Envelope-to:"
35524 .oindex "&%envelope_to_remove%&"
35525 &'Envelope-to:'& header lines are not part of the standard RFC 2822 header set.
35526 Exim can be configured to add them to the final delivery of messages. (See the
35527 generic &%envelope_to_add%& transport option.) They should not be present in
35528 messages in transit. If the &%envelope_to_remove%& configuration option is set
35529 (the default), Exim removes &'Envelope-to:'& header lines from incoming
35530 messages.
35531
35532
35533 .section "The From: header line" "SECTthefrohea"
35534 .cindex "&'From:'& header line"
35535 .cindex "header lines" "From:"
35536 .cindex "Sendmail compatibility" "&""From""& line"
35537 .cindex "message" "submission"
35538 .cindex "submission mode"
35539 If a submission-mode message does not contain a &'From:'& header line, Exim
35540 adds one if either of the following conditions is true:
35541
35542 .ilist
35543 The envelope sender address is not empty (that is, this is not a bounce
35544 message). The added header line copies the envelope sender address.
35545 .next
35546 .vindex "&$authenticated_id$&"
35547 The SMTP session is authenticated and &$authenticated_id$& is not empty.
35548 .olist
35549 .vindex "&$qualify_domain$&"
35550 If no domain is specified by the submission control, the local part is
35551 &$authenticated_id$& and the domain is &$qualify_domain$&.
35552 .next
35553 If a non-empty domain is specified by the submission control, the local
35554 part is &$authenticated_id$&, and the domain is the specified domain.
35555 .next
35556 If an empty domain is specified by the submission control,
35557 &$authenticated_id$& is assumed to be the complete address.
35558 .endlist
35559 .endlist
35560
35561 A non-empty envelope sender takes precedence.
35562
35563 If a locally-generated incoming message does not contain a &'From:'& header
35564 line, and the &%suppress_local_fixups%& control is not set, Exim adds one
35565 containing the sender's address. The calling user's login name and full name
35566 are used to construct the address, as described in section &<<SECTconstr>>&.
35567 They are obtained from the password data by calling &[getpwuid()]& (but see the
35568 &%unknown_login%& configuration option). The address is qualified with
35569 &%qualify_domain%&.
35570
35571 For compatibility with Sendmail, if an incoming, non-SMTP message has a
35572 &'From:'& header line containing just the unqualified login name of the calling
35573 user, this is replaced by an address containing the user's login name and full
35574 name as described in section &<<SECTconstr>>&.
35575
35576
35577 .section "The Message-ID: header line" "SECID226"
35578 .cindex "&'Message-ID:'& header line"
35579 .cindex "header lines" "Message-ID:"
35580 .cindex "message" "submission"
35581 .oindex "&%message_id_header_text%&"
35582 If a locally-generated or submission-mode incoming message does not contain a
35583 &'Message-ID:'& or &'Resent-Message-ID:'& header line, and the
35584 &%suppress_local_fixups%& control is not set, Exim adds a suitable header line
35585 to the message. If there are any &'Resent-:'& headers in the message, it
35586 creates &'Resent-Message-ID:'&. The id is constructed from Exim's internal
35587 message id, preceded by the letter E to ensure it starts with a letter, and
35588 followed by @ and the primary host name. Additional information can be included
35589 in this header line by setting the &%message_id_header_text%& and/or
35590 &%message_id_header_domain%& options.
35591
35592
35593 .section "The Received: header line" "SECID227"
35594 .cindex "&'Received:'& header line"
35595 .cindex "header lines" "Received:"
35596 A &'Received:'& header line is added at the start of every message. The
35597 contents are defined by the &%received_header_text%& configuration option, and
35598 Exim automatically adds a semicolon and a timestamp to the configured string.
35599
35600 The &'Received:'& header is generated as soon as the message's header lines
35601 have been received. At this stage, the timestamp in the &'Received:'& header
35602 line is the time that the message started to be received. This is the value
35603 that is seen by the DATA ACL and by the &[local_scan()]& function.
35604
35605 Once a message is accepted, the timestamp in the &'Received:'& header line is
35606 changed to the time of acceptance, which is (apart from a small delay while the
35607 -H spool file is written) the earliest time at which delivery could start.
35608
35609
35610 .section "The References: header line" "SECID228"
35611 .cindex "&'References:'& header line"
35612 .cindex "header lines" "References:"
35613 Messages created by the &(autoreply)& transport include a &'References:'&
35614 header line. This is constructed according to the rules that are described in
35615 section 3.64 of RFC 2822 (which states that replies should contain such a
35616 header line), and section 3.14 of RFC 3834 (which states that automatic
35617 responses are not different in this respect). However, because some mail
35618 processing software does not cope well with very long header lines, no more
35619 than 12 message IDs are copied from the &'References:'& header line in the
35620 incoming message. If there are more than 12, the first one and then the final
35621 11 are copied, before adding the message ID of the incoming message.
35622
35623
35624
35625 .section "The Return-path: header line" "SECID229"
35626 .cindex "&'Return-path:'& header line"
35627 .cindex "header lines" "Return-path:"
35628 .oindex "&%return_path_remove%&"
35629 &'Return-path:'& header lines are defined as something an MTA may insert when
35630 it does the final delivery of messages. (See the generic &%return_path_add%&
35631 transport option.) Therefore, they should not be present in messages in
35632 transit. If the &%return_path_remove%& configuration option is set (the
35633 default), Exim removes &'Return-path:'& header lines from incoming messages.
35634
35635
35636
35637 .section "The Sender: header line" "SECTthesenhea"
35638 .cindex "&'Sender:'& header line"
35639 .cindex "message" "submission"
35640 .cindex "header lines" "Sender:"
35641 For a locally-originated message from an untrusted user, Exim may remove an
35642 existing &'Sender:'& header line, and it may add a new one. You can modify
35643 these actions by setting the &%local_sender_retain%& option true, the
35644 &%local_from_check%& option false, or by using the &%suppress_local_fixups%&
35645 control setting.
35646
35647 When a local message is received from an untrusted user and
35648 &%local_from_check%& is true (the default), and the &%suppress_local_fixups%&
35649 control has not been set, a check is made to see if the address given in the
35650 &'From:'& header line is the correct (local) sender of the message. The address
35651 that is expected has the login name as the local part and the value of
35652 &%qualify_domain%& as the domain. Prefixes and suffixes for the local part can
35653 be permitted by setting &%local_from_prefix%& and &%local_from_suffix%&
35654 appropriately. If &'From:'& does not contain the correct sender, a &'Sender:'&
35655 line is added to the message.
35656
35657 If you set &%local_from_check%& false, this checking does not occur. However,
35658 the removal of an existing &'Sender:'& line still happens, unless you also set
35659 &%local_sender_retain%& to be true. It is not possible to set both of these
35660 options true at the same time.
35661
35662 .cindex "submission mode"
35663 By default, no processing of &'Sender:'& header lines is done for messages
35664 received over TCP/IP or for messages submitted by trusted users. However, when
35665 a message is received over TCP/IP in submission mode, and &%sender_retain%& is
35666 not specified on the submission control, the following processing takes place:
35667
35668 .vindex "&$authenticated_id$&"
35669 First, any existing &'Sender:'& lines are removed. Then, if the SMTP session is
35670 authenticated, and &$authenticated_id$& is not empty, a sender address is
35671 created as follows:
35672
35673 .ilist
35674 .vindex "&$qualify_domain$&"
35675 If no domain is specified by the submission control, the local part is
35676 &$authenticated_id$& and the domain is &$qualify_domain$&.
35677 .next
35678 If a non-empty domain is specified by the submission control, the local part
35679 is &$authenticated_id$&, and the domain is the specified domain.
35680 .next
35681 If an empty domain is specified by the submission control,
35682 &$authenticated_id$& is assumed to be the complete address.
35683 .endlist
35684
35685 This address is compared with the address in the &'From:'& header line. If they
35686 are different, a &'Sender:'& header line containing the created address is
35687 added. Prefixes and suffixes for the local part in &'From:'& can be permitted
35688 by setting &%local_from_prefix%& and &%local_from_suffix%& appropriately.
35689
35690 .cindex "return path" "created from &'Sender:'&"
35691 &*Note*&: Whenever a &'Sender:'& header line is created, the return path for
35692 the message (the envelope sender address) is changed to be the same address,
35693 except in the case of submission mode when &%sender_retain%& is specified.
35694
35695
35696
35697 .section "Adding and removing header lines in routers and transports" &&&
35698          "SECTheadersaddrem"
35699 .cindex "header lines" "adding; in router or transport"
35700 .cindex "header lines" "removing; in router or transport"
35701 When a message is delivered, the addition and removal of header lines can be
35702 specified in a system filter, or on any of the routers and transports that
35703 process the message. Section &<<SECTaddremheasys>>& contains details about
35704 modifying headers in a system filter. Header lines can also be added in an ACL
35705 as a message is received (see section &<<SECTaddheadacl>>&).
35706
35707 In contrast to what happens in a system filter, header modifications that are
35708 specified on routers and transports apply only to the particular recipient
35709 addresses that are being processed by those routers and transports. These
35710 changes do not actually take place until a copy of the message is being
35711 transported. Therefore, they do not affect the basic set of header lines, and
35712 they do not affect the values of the variables that refer to header lines.
35713
35714 &*Note*&: In particular, this means that any expansions in the configuration of
35715 the transport cannot refer to the modified header lines, because such
35716 expansions all occur before the message is actually transported.
35717
35718 For both routers and transports, the argument of a &%headers_add%&
35719 option must be in the form of one or more RFC 2822 header lines, separated by
35720 newlines (coded as &"\n"&). For example:
35721 .code
35722 headers_add = X-added-header: added by $primary_hostname\n\
35723               X-added-second: another added header line
35724 .endd
35725 Exim does not check the syntax of these added header lines.
35726
35727 Multiple &%headers_add%& options for a single router or transport can be
35728 specified; the values will append to a single list of header lines.
35729 Each header-line is separately expanded.
35730
35731 The argument of a &%headers_remove%& option must consist of a colon-separated
35732 list of header names. This is confusing, because header names themselves are
35733 often terminated by colons. In this case, the colons are the list separators,
35734 not part of the names. For example:
35735 .code
35736 headers_remove = return-receipt-to:acknowledge-to
35737 .endd
35738
35739 Multiple &%headers_remove%& options for a single router or transport can be
35740 specified; the arguments will append to a single header-names list.
35741 Each item is separately expanded.
35742 Note that colons in complex expansions which are used to
35743 form all or part of a &%headers_remove%& list
35744 will act as list separators.
35745
35746 When &%headers_add%& or &%headers_remove%& is specified on a router,
35747 items are expanded at routing time,
35748 and then associated with all addresses that are
35749 accepted by that router, and also with any new addresses that it generates. If
35750 an address passes through several routers as a result of aliasing or
35751 forwarding, the changes are cumulative.
35752
35753 .oindex "&%unseen%&"
35754 However, this does not apply to multiple routers that result from the use of
35755 the &%unseen%& option. Any header modifications that were specified by the
35756 &"unseen"& router or its predecessors apply only to the &"unseen"& delivery.
35757
35758 Addresses that end up with different &%headers_add%& or &%headers_remove%&
35759 settings cannot be delivered together in a batch, so a transport is always
35760 dealing with a set of addresses that have the same header-processing
35761 requirements.
35762
35763 The transport starts by writing the original set of header lines that arrived
35764 with the message, possibly modified by the system filter. As it writes out
35765 these lines, it consults the list of header names that were attached to the
35766 recipient address(es) by &%headers_remove%& options in routers, and it also
35767 consults the transport's own &%headers_remove%& option. Header lines whose
35768 names are on either of these lists are not written out. If there are multiple
35769 instances of any listed header, they are all skipped.
35770
35771 After the remaining original header lines have been written, new header
35772 lines that were specified by routers' &%headers_add%& options are written, in
35773 the order in which they were attached to the address. These are followed by any
35774 header lines specified by the transport's &%headers_add%& option.
35775
35776 This way of handling header line modifications in routers and transports has
35777 the following consequences:
35778
35779 .ilist
35780 The original set of header lines, possibly modified by the system filter,
35781 remains &"visible"&, in the sense that the &$header_$&&'xxx'& variables refer
35782 to it, at all times.
35783 .next
35784 Header lines that are added by a router's
35785 &%headers_add%& option are not accessible by means of the &$header_$&&'xxx'&
35786 expansion syntax in subsequent routers or the transport.
35787 .next
35788 Conversely, header lines that are specified for removal by &%headers_remove%&
35789 in a router remain visible to subsequent routers and the transport.
35790 .next
35791 Headers added to an address by &%headers_add%& in a router cannot be removed by
35792 a later router or by a transport.
35793 .next
35794 An added header can refer to the contents of an original header that is to be
35795 removed, even it has the same name as the added header. For example:
35796 .code
35797 headers_remove = subject
35798 headers_add = Subject: new subject (was: $h_subject:)
35799 .endd
35800 .endlist
35801
35802 &*Warning*&: The &%headers_add%& and &%headers_remove%& options cannot be used
35803 for a &(redirect)& router that has the &%one_time%& option set.
35804
35805
35806
35807
35808
35809 .section "Constructed addresses" "SECTconstr"
35810 .cindex "address" "constructed"
35811 .cindex "constructed address"
35812 When Exim constructs a sender address for a locally-generated message, it uses
35813 the form
35814 .display
35815 <&'user name'&>&~&~<&'login'&&`@`&&'qualify_domain'&>
35816 .endd
35817 For example:
35818 .code
35819 Zaphod Beeblebrox <zaphod@end.univ.example>
35820 .endd
35821 The user name is obtained from the &%-F%& command line option if set, or
35822 otherwise by looking up the calling user by &[getpwuid()]& and extracting the
35823 &"gecos"& field from the password entry. If the &"gecos"& field contains an
35824 ampersand character, this is replaced by the login name with the first letter
35825 upper cased, as is conventional in a number of operating systems. See the
35826 &%gecos_name%& option for a way to tailor the handling of the &"gecos"& field.
35827 The &%unknown_username%& option can be used to specify user names in cases when
35828 there is no password file entry.
35829
35830 .cindex "RFC 2047"
35831 In all cases, the user name is made to conform to RFC 2822 by quoting all or
35832 parts of it if necessary. In addition, if it contains any non-printing
35833 characters, it is encoded as described in RFC 2047, which defines a way of
35834 including non-ASCII characters in header lines. The value of the
35835 &%headers_charset%& option specifies the name of the encoding that is used (the
35836 characters are assumed to be in this encoding). The setting of
35837 &%print_topbitchars%& controls whether characters with the top bit set (that
35838 is, with codes greater than 127) count as printing characters or not.
35839
35840
35841
35842 .section "Case of local parts" "SECID230"
35843 .cindex "case of local parts"
35844 .cindex "local part" "case of"
35845 RFC 2822 states that the case of letters in the local parts of addresses cannot
35846 be assumed to be non-significant. Exim preserves the case of local parts of
35847 addresses, but by default it uses a lower-cased form when it is routing,
35848 because on most Unix systems, usernames are in lower case and case-insensitive
35849 routing is required. However, any particular router can be made to use the
35850 original case for local parts by setting the &%caseful_local_part%& generic
35851 router option.
35852
35853 .cindex "mixed-case login names"
35854 If you must have mixed-case user names on your system, the best way to proceed,
35855 assuming you want case-independent handling of incoming email, is to set up
35856 your first router to convert incoming local parts in your domains to the
35857 correct case by means of a file lookup. For example:
35858 .code
35859 correct_case:
35860   driver = redirect
35861   domains = +local_domains
35862   data = ${lookup{$local_part}cdb\
35863               {/etc/usercased.cdb}{$value}fail}\
35864               @$domain
35865 .endd
35866 For this router, the local part is forced to lower case by the default action
35867 (&%caseful_local_part%& is not set). The lower-cased local part is used to look
35868 up a new local part in the correct case. If you then set &%caseful_local_part%&
35869 on any subsequent routers which process your domains, they will operate on
35870 local parts with the correct case in a case-sensitive manner.
35871
35872
35873
35874 .section "Dots in local parts" "SECID231"
35875 .cindex "dot" "in local part"
35876 .cindex "local part" "dots in"
35877 RFC 2822 forbids empty components in local parts. That is, an unquoted local
35878 part may not begin or end with a dot, nor have two consecutive dots in the
35879 middle. However, it seems that many MTAs do not enforce this, so Exim permits
35880 empty components for compatibility.
35881
35882
35883
35884 .section "Rewriting addresses" "SECID232"
35885 .cindex "rewriting" "addresses"
35886 Rewriting of sender and recipient addresses, and addresses in headers, can
35887 happen automatically, or as the result of configuration options, as described
35888 in chapter &<<CHAPrewrite>>&. The headers that may be affected by this are
35889 &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-To:'&, &'Sender:'&, and &'To:'&.
35890
35891 Automatic rewriting includes qualification, as mentioned above. The other case
35892 in which it can happen is when an incomplete non-local domain is given. The
35893 routing process may cause this to be expanded into the full domain name. For
35894 example, a header such as
35895 .code
35896 To: hare@teaparty
35897 .endd
35898 might get rewritten as
35899 .code
35900 To: hare@teaparty.wonderland.fict.example
35901 .endd
35902 Rewriting as a result of routing is the one kind of message processing that
35903 does not happen at input time, as it cannot be done until the address has
35904 been routed.
35905
35906 Strictly, one should not do &'any'& deliveries of a message until all its
35907 addresses have been routed, in case any of the headers get changed as a
35908 result of routing. However, doing this in practice would hold up many
35909 deliveries for unreasonable amounts of time, just because one address could not
35910 immediately be routed. Exim therefore does not delay other deliveries when
35911 routing of one or more addresses is deferred.
35912 .ecindex IIDmesproc
35913
35914
35915
35916 . ////////////////////////////////////////////////////////////////////////////
35917 . ////////////////////////////////////////////////////////////////////////////
35918
35919 .chapter "SMTP processing" "CHAPSMTP"
35920 .scindex IIDsmtpproc1 "SMTP" "processing details"
35921 .scindex IIDsmtpproc2 "LMTP" "processing details"
35922 Exim supports a number of different ways of using the SMTP protocol, and its
35923 LMTP variant, which is an interactive protocol for transferring messages into a
35924 closed mail store application. This chapter contains details of how SMTP is
35925 processed. For incoming mail, the following are available:
35926
35927 .ilist
35928 SMTP over TCP/IP (Exim daemon or &'inetd'&);
35929 .next
35930 SMTP over the standard input and output (the &%-bs%& option);
35931 .next
35932 Batched SMTP on the standard input (the &%-bS%& option).
35933 .endlist
35934
35935 For mail delivery, the following are available:
35936
35937 .ilist
35938 SMTP over TCP/IP (the &(smtp)& transport);
35939 .next
35940 LMTP over TCP/IP (the &(smtp)& transport with the &%protocol%& option set to
35941 &"lmtp"&);
35942 .next
35943 LMTP over a pipe to a process running in the local host (the &(lmtp)&
35944 transport);
35945 .next
35946 Batched SMTP to a file or pipe (the &(appendfile)& and &(pipe)& transports with
35947 the &%use_bsmtp%& option set).
35948 .endlist
35949
35950 &'Batched SMTP'& is the name for a process in which batches of messages are
35951 stored in or read from files (or pipes), in a format in which SMTP commands are
35952 used to contain the envelope information.
35953
35954
35955
35956 .section "Outgoing SMTP and LMTP over TCP/IP" "SECToutSMTPTCP"
35957 .cindex "SMTP" "outgoing over TCP/IP"
35958 .cindex "outgoing SMTP over TCP/IP"
35959 .cindex "LMTP" "over TCP/IP"
35960 .cindex "outgoing LMTP over TCP/IP"
35961 .cindex "EHLO"
35962 .cindex "HELO"
35963 .cindex "SIZE option on MAIL command"
35964 Outgoing SMTP and LMTP over TCP/IP is implemented by the &(smtp)& transport.
35965 The &%protocol%& option selects which protocol is to be used, but the actual
35966 processing is the same in both cases.
35967
35968 If, in response to its EHLO command, Exim is told that the SIZE
35969 parameter is supported, it adds SIZE=<&'n'&> to each subsequent MAIL
35970 command. The value of <&'n'&> is the message size plus the value of the
35971 &%size_addition%& option (default 1024) to allow for additions to the message
35972 such as per-transport header lines, or changes made in a
35973 .cindex "transport" "filter"
35974 .cindex "filter" "transport filter"
35975 transport filter. If &%size_addition%& is set negative, the use of SIZE is
35976 suppressed.
35977
35978 If the remote server advertises support for PIPELINING, Exim uses the
35979 pipelining extension to SMTP (RFC 2197) to reduce the number of TCP/IP packets
35980 required for the transaction.
35981
35982 If the remote server advertises support for the STARTTLS command, and Exim
35983 was built to support TLS encryption, it tries to start a TLS session unless the
35984 server matches &%hosts_avoid_tls%&. See chapter &<<CHAPTLS>>& for more details.
35985 Either a match in that or &%hosts_verify_avoid_tls%& apply when the transport
35986 is called for verification.
35987
35988 If the remote server advertises support for the AUTH command, Exim scans
35989 the authenticators configuration for any suitable client settings, as described
35990 in chapter &<<CHAPSMTPAUTH>>&.
35991
35992 .cindex "carriage return"
35993 .cindex "linefeed"
35994 Responses from the remote host are supposed to be terminated by CR followed by
35995 LF. However, there are known to be hosts that do not send CR characters, so in
35996 order to be able to interwork with such hosts, Exim treats LF on its own as a
35997 line terminator.
35998
35999 If a message contains a number of different addresses, all those with the same
36000 characteristics (for example, the same envelope sender) that resolve to the
36001 same set of hosts, in the same order, are sent in a single SMTP transaction,
36002 even if they are for different domains, unless there are more than the setting
36003 of the &%max_rcpt%&s option in the &(smtp)& transport allows, in which case
36004 they are split into groups containing no more than &%max_rcpt%&s addresses
36005 each. If &%remote_max_parallel%& is greater than one, such groups may be sent
36006 in parallel sessions. The order of hosts with identical MX values is not
36007 significant when checking whether addresses can be batched in this way.
36008
36009 When the &(smtp)& transport suffers a temporary failure that is not
36010 message-related, Exim updates its transport-specific database, which contains
36011 records indexed by host name that remember which messages are waiting for each
36012 particular host. It also updates the retry database with new retry times.
36013
36014 .cindex "hints database" "retry keys"
36015 Exim's retry hints are based on host name plus IP address, so if one address of
36016 a multi-homed host is broken, it will soon be skipped most of the time.
36017 See the next section for more detail about error handling.
36018
36019 .cindex "SMTP" "passed connection"
36020 .cindex "SMTP" "batching over TCP/IP"
36021 When a message is successfully delivered over a TCP/IP SMTP connection, Exim
36022 looks in the hints database for the transport to see if there are any queued
36023 messages waiting for the host to which it is connected. If it finds one, it
36024 creates a new Exim process using the &%-MC%& option (which can only be used by
36025 a process running as root or the Exim user) and passes the TCP/IP socket to it
36026 so that it can deliver another message using the same socket. The new process
36027 does only those deliveries that are routed to the connected host, and may in
36028 turn pass the socket on to a third process, and so on.
36029
36030 The &%connection_max_messages%& option of the &(smtp)& transport can be used to
36031 limit the number of messages sent down a single TCP/IP connection.
36032
36033 .cindex "asterisk" "after IP address"
36034 The second and subsequent messages delivered down an existing connection are
36035 identified in the main log by the addition of an asterisk after the closing
36036 square bracket of the IP address.
36037
36038
36039
36040
36041 .section "Errors in outgoing SMTP" "SECToutSMTPerr"
36042 .cindex "error" "in outgoing SMTP"
36043 .cindex "SMTP" "errors in outgoing"
36044 .cindex "host" "error"
36045 Three different kinds of error are recognized for outgoing SMTP: host errors,
36046 message errors, and recipient errors.
36047
36048 .vlist
36049 .vitem "&*Host errors*&"
36050 A host error is not associated with a particular message or with a
36051 particular recipient of a message. The host errors are:
36052
36053 .ilist
36054 Connection refused or timed out,
36055 .next
36056 Any error response code on connection,
36057 .next
36058 Any error response code to EHLO or HELO,
36059 .next
36060 Loss of connection at any time, except after &"."&,
36061 .next
36062 I/O errors at any time,
36063 .next
36064 Timeouts during the session, other than in response to MAIL, RCPT or
36065 the &"."& at the end of the data.
36066 .endlist ilist
36067
36068 For a host error, a permanent error response on connection, or in response to
36069 EHLO, causes all addresses routed to the host to be failed. Any other host
36070 error causes all addresses to be deferred, and retry data to be created for the
36071 host. It is not tried again, for any message, until its retry time arrives. If
36072 the current set of addresses are not all delivered in this run (to some
36073 alternative host), the message is added to the list of those waiting for this
36074 host, so if it is still undelivered when a subsequent successful delivery is
36075 made to the host, it will be sent down the same SMTP connection.
36076
36077 .vitem "&*Message errors*&"
36078 .cindex "message" "error"
36079 A message error is associated with a particular message when sent to a
36080 particular host, but not with a particular recipient of the message. The
36081 message errors are:
36082
36083 .ilist
36084 Any error response code to MAIL, DATA, or the &"."& that terminates
36085 the data,
36086 .next
36087 Timeout after MAIL,
36088 .next
36089 Timeout or loss of connection after the &"."& that terminates the data. A
36090 timeout after the DATA command itself is treated as a host error, as is loss of
36091 connection at any other time.
36092 .endlist ilist
36093
36094 For a message error, a permanent error response (5&'xx'&) causes all addresses
36095 to be failed, and a delivery error report to be returned to the sender. A
36096 temporary error response (4&'xx'&), or one of the timeouts, causes all
36097 addresses to be deferred. Retry data is not created for the host, but instead,
36098 a retry record for the combination of host plus message id is created. The
36099 message is not added to the list of those waiting for this host. This ensures
36100 that the failing message will not be sent to this host again until the retry
36101 time arrives. However, other messages that are routed to the host are not
36102 affected, so if it is some property of the message that is causing the error,
36103 it will not stop the delivery of other mail.
36104
36105 If the remote host specified support for the SIZE parameter in its response
36106 to EHLO, Exim adds SIZE=&'nnn'& to the MAIL command, so an
36107 over-large message will cause a message error because the error arrives as a
36108 response to MAIL.
36109
36110 .vitem "&*Recipient errors*&"
36111 .cindex "recipient" "error"
36112 A recipient error is associated with a particular recipient of a message. The
36113 recipient errors are:
36114
36115 .ilist
36116 Any error response to RCPT,
36117 .next
36118 Timeout after RCPT.
36119 .endlist
36120
36121 For a recipient error, a permanent error response (5&'xx'&) causes the
36122 recipient address to be failed, and a bounce message to be returned to the
36123 sender. A temporary error response (4&'xx'&) or a timeout causes the failing
36124 address to be deferred, and routing retry data to be created for it. This is
36125 used to delay processing of the address in subsequent queue runs, until its
36126 routing retry time arrives. This applies to all messages, but because it
36127 operates only in queue runs, one attempt will be made to deliver a new message
36128 to the failing address before the delay starts to operate. This ensures that,
36129 if the failure is really related to the message rather than the recipient
36130 (&"message too big for this recipient"& is a possible example), other messages
36131 have a chance of getting delivered. If a delivery to the address does succeed,
36132 the retry information gets cleared, so all stuck messages get tried again, and
36133 the retry clock is reset.
36134
36135 The message is not added to the list of those waiting for this host. Use of the
36136 host for other messages is unaffected, and except in the case of a timeout,
36137 other recipients are processed independently, and may be successfully delivered
36138 in the current SMTP session. After a timeout it is of course impossible to
36139 proceed with the session, so all addresses get deferred. However, those other
36140 than the one that failed do not suffer any subsequent retry delays. Therefore,
36141 if one recipient is causing trouble, the others have a chance of getting
36142 through when a subsequent delivery attempt occurs before the failing
36143 recipient's retry time.
36144 .endlist
36145
36146 In all cases, if there are other hosts (or IP addresses) available for the
36147 current set of addresses (for example, from multiple MX records), they are
36148 tried in this run for any undelivered addresses, subject of course to their
36149 own retry data. In other words, recipient error retry data does not take effect
36150 until the next delivery attempt.
36151
36152 Some hosts have been observed to give temporary error responses to every
36153 MAIL command at certain times (&"insufficient space"& has been seen). It
36154 would be nice if such circumstances could be recognized, and defer data for the
36155 host itself created, but this is not possible within the current Exim design.
36156 What actually happens is that retry data for every (host, message) combination
36157 is created.
36158
36159 The reason that timeouts after MAIL and RCPT are treated specially is that
36160 these can sometimes arise as a result of the remote host's verification
36161 procedures. Exim makes this assumption, and treats them as if a temporary error
36162 response had been received. A timeout after &"."& is treated specially because
36163 it is known that some broken implementations fail to recognize the end of the
36164 message if the last character of the last line is a binary zero. Thus, it is
36165 helpful to treat this case as a message error.
36166
36167 Timeouts at other times are treated as host errors, assuming a problem with the
36168 host, or the connection to it. If a timeout after MAIL, RCPT,
36169 or &"."& is really a connection problem, the assumption is that at the next try
36170 the timeout is likely to occur at some other point in the dialogue, causing it
36171 then to be treated as a host error.
36172
36173 There is experimental evidence that some MTAs drop the connection after the
36174 terminating &"."& if they do not like the contents of the message for some
36175 reason, in contravention of the RFC, which indicates that a 5&'xx'& response
36176 should be given. That is why Exim treats this case as a message rather than a
36177 host error, in order not to delay other messages to the same host.
36178
36179
36180
36181
36182 .section "Incoming SMTP messages over TCP/IP" "SECID233"
36183 .cindex "SMTP" "incoming over TCP/IP"
36184 .cindex "incoming SMTP over TCP/IP"
36185 .cindex "inetd"
36186 .cindex "daemon"
36187 Incoming SMTP messages can be accepted in one of two ways: by running a
36188 listening daemon, or by using &'inetd'&. In the latter case, the entry in
36189 &_/etc/inetd.conf_& should be like this:
36190 .code
36191 smtp stream tcp nowait exim /opt/exim/bin/exim in.exim -bs
36192 .endd
36193 Exim distinguishes between this case and the case of a locally running user
36194 agent using the &%-bs%& option by checking whether or not the standard input is
36195 a socket. When it is, either the port must be privileged (less than 1024), or
36196 the caller must be root or the Exim user. If any other user passes a socket
36197 with an unprivileged port number, Exim prints a message on the standard error
36198 stream and exits with an error code.
36199
36200 By default, Exim does not make a log entry when a remote host connects or
36201 disconnects (either via the daemon or &'inetd'&), unless the disconnection is
36202 unexpected. It can be made to write such log entries by setting the
36203 &%smtp_connection%& log selector.
36204
36205 .cindex "carriage return"
36206 .cindex "linefeed"
36207 Commands from the remote host are supposed to be terminated by CR followed by
36208 LF. However, there are known to be hosts that do not send CR characters. In
36209 order to be able to interwork with such hosts, Exim treats LF on its own as a
36210 line terminator.
36211 Furthermore, because common code is used for receiving messages from all
36212 sources, a CR on its own is also interpreted as a line terminator. However, the
36213 sequence &"CR, dot, CR"& does not terminate incoming SMTP data.
36214
36215 .cindex "EHLO" "invalid data"
36216 .cindex "HELO" "invalid data"
36217 One area that sometimes gives rise to problems concerns the EHLO or
36218 HELO commands. Some clients send syntactically invalid versions of these
36219 commands, which Exim rejects by default. (This is nothing to do with verifying
36220 the data that is sent, so &%helo_verify_hosts%& is not relevant.) You can tell
36221 Exim not to apply a syntax check by setting &%helo_accept_junk_hosts%& to
36222 match the broken hosts that send invalid commands.
36223
36224 .cindex "SIZE option on MAIL command"
36225 .cindex "MAIL" "SIZE option"
36226 The amount of disk space available is checked whenever SIZE is received on
36227 a MAIL command, independently of whether &%message_size_limit%& or
36228 &%check_spool_space%& is configured, unless &%smtp_check_spool_space%& is set
36229 false. A temporary error is given if there is not enough space. If
36230 &%check_spool_space%& is set, the check is for that amount of space plus the
36231 value given with SIZE, that is, it checks that the addition of the incoming
36232 message will not reduce the space below the threshold.
36233
36234 When a message is successfully received, Exim includes the local message id in
36235 its response to the final &"."& that terminates the data. If the remote host
36236 logs this text it can help with tracing what has happened to a message.
36237
36238 The Exim daemon can limit the number of simultaneous incoming connections it is
36239 prepared to handle (see the &%smtp_accept_max%& option). It can also limit the
36240 number of simultaneous incoming connections from a single remote host (see the
36241 &%smtp_accept_max_per_host%& option). Additional connection attempts are
36242 rejected using the SMTP temporary error code 421.
36243
36244 The Exim daemon does not rely on the SIGCHLD signal to detect when a
36245 subprocess has finished, as this can get lost at busy times. Instead, it looks
36246 for completed subprocesses every time it wakes up. Provided there are other
36247 things happening (new incoming calls, starts of queue runs), completed
36248 processes will be noticed and tidied away. On very quiet systems you may
36249 sometimes see a &"defunct"& Exim process hanging about. This is not a problem;
36250 it will be noticed when the daemon next wakes up.
36251
36252 When running as a daemon, Exim can reserve some SMTP slots for specific hosts,
36253 and can also be set up to reject SMTP calls from non-reserved hosts at times of
36254 high system load &-- for details see the &%smtp_accept_reserve%&,
36255 &%smtp_load_reserve%&, and &%smtp_reserve_hosts%& options. The load check
36256 applies in both the daemon and &'inetd'& cases.
36257
36258 Exim normally starts a delivery process for each message received, though this
36259 can be varied by means of the &%-odq%& command line option and the
36260 &%queue_only%&, &%queue_only_file%&, and &%queue_only_load%& options. The
36261 number of simultaneously running delivery processes started in this way from
36262 SMTP input can be limited by the &%smtp_accept_queue%& and
36263 &%smtp_accept_queue_per_connection%& options. When either limit is reached,
36264 subsequently received messages are just put on the input queue without starting
36265 a delivery process.
36266
36267 The controls that involve counts of incoming SMTP calls (&%smtp_accept_max%&,
36268 &%smtp_accept_queue%&, &%smtp_accept_reserve%&) are not available when Exim is
36269 started up from the &'inetd'& daemon, because in that case each connection is
36270 handled by an entirely independent Exim process. Control by load average is,
36271 however, available with &'inetd'&.
36272
36273 Exim can be configured to verify addresses in incoming SMTP commands as they
36274 are received. See chapter &<<CHAPACL>>& for details. It can also be configured
36275 to rewrite addresses at this time &-- before any syntax checking is done. See
36276 section &<<SECTrewriteS>>&.
36277
36278 Exim can also be configured to limit the rate at which a client host submits
36279 MAIL and RCPT commands in a single SMTP session. See the
36280 &%smtp_ratelimit_hosts%& option.
36281
36282
36283
36284 .section "Unrecognized SMTP commands" "SECID234"
36285 .cindex "SMTP" "unrecognized commands"
36286 If Exim receives more than &%smtp_max_unknown_commands%& unrecognized SMTP
36287 commands during a single SMTP connection, it drops the connection after sending
36288 the error response to the last command. The default value for
36289 &%smtp_max_unknown_commands%& is 3. This is a defence against some kinds of
36290 abuse that subvert web servers into making connections to SMTP ports; in these
36291 circumstances, a number of non-SMTP lines are sent first.
36292
36293
36294 .section "Syntax and protocol errors in SMTP commands" "SECID235"
36295 .cindex "SMTP" "syntax errors"
36296 .cindex "SMTP" "protocol errors"
36297 A syntax error is detected if an SMTP command is recognized, but there is
36298 something syntactically wrong with its data, for example, a malformed email
36299 address in a RCPT command. Protocol errors include invalid command
36300 sequencing such as RCPT before MAIL. If Exim receives more than
36301 &%smtp_max_synprot_errors%& such commands during a single SMTP connection, it
36302 drops the connection after sending the error response to the last command. The
36303 default value for &%smtp_max_synprot_errors%& is 3. This is a defence against
36304 broken clients that loop sending bad commands (yes, it has been seen).
36305
36306
36307
36308 .section "Use of non-mail SMTP commands" "SECID236"
36309 .cindex "SMTP" "non-mail commands"
36310 The &"non-mail"& SMTP commands are those other than MAIL, RCPT, and
36311 DATA. Exim counts such commands, and drops the connection if there are too
36312 many of them in a single SMTP session. This action catches some
36313 denial-of-service attempts and things like repeated failing AUTHs, or a mad
36314 client looping sending EHLO. The global option &%smtp_accept_max_nonmail%&
36315 defines what &"too many"& means. Its default value is 10.
36316
36317 When a new message is expected, one occurrence of RSET is not counted. This
36318 allows a client to send one RSET between messages (this is not necessary,
36319 but some clients do it). Exim also allows one uncounted occurrence of HELO
36320 or EHLO, and one occurrence of STARTTLS between messages. After
36321 starting up a TLS session, another EHLO is expected, and so it too is not
36322 counted.
36323
36324 The first occurrence of AUTH in a connection, or immediately following
36325 STARTTLS is also not counted. Otherwise, all commands other than MAIL,
36326 RCPT, DATA, and QUIT are counted.
36327
36328 You can control which hosts are subject to the limit set by
36329 &%smtp_accept_max_nonmail%& by setting
36330 &%smtp_accept_max_nonmail_hosts%&. The default value is &`*`&, which makes
36331 the limit apply to all hosts. This option means that you can exclude any
36332 specific badly-behaved hosts that you have to live with.
36333
36334
36335
36336
36337 .section "The VRFY and EXPN commands" "SECID237"
36338 When Exim receives a VRFY or EXPN command on a TCP/IP connection, it
36339 runs the ACL specified by &%acl_smtp_vrfy%& or &%acl_smtp_expn%& (as
36340 appropriate) in order to decide whether the command should be accepted or not.
36341
36342 .cindex "VRFY" "processing"
36343 When no ACL is defined for VRFY, or if it rejects without
36344 setting an explicit response code, the command is accepted
36345 (with a 252 SMTP response code)
36346 in order to support awkward clients that do a VRFY before every RCPT.
36347 When VRFY is accepted, it runs exactly the same code as when Exim is
36348 called with the &%-bv%& option, and returns 250/451/550
36349 SMTP response codes.
36350
36351 .cindex "EXPN" "processing"
36352 If no ACL for EXPN is defined, the command is rejected.
36353 When EXPN is accepted, a single-level expansion of the address is done.
36354 EXPN is treated as an &"address test"& (similar to the &%-bt%& option) rather
36355 than a verification (the &%-bv%& option). If an unqualified local part is given
36356 as the argument to EXPN, it is qualified with &%qualify_domain%&. Rejections
36357 of VRFY and EXPN commands are logged on the main and reject logs, and
36358 VRFY verification failures are logged on the main log for consistency with
36359 RCPT failures.
36360
36361
36362
36363 .section "The ETRN command" "SECTETRN"
36364 .cindex "ETRN" "processing"
36365 RFC 1985 describes an SMTP command called ETRN that is designed to
36366 overcome the security problems of the TURN command (which has fallen into
36367 disuse). When Exim receives an ETRN command on a TCP/IP connection, it runs
36368 the ACL specified by &%acl_smtp_etrn%& in order to decide whether the command
36369 should be accepted or not. If no ACL is defined, the command is rejected.
36370
36371 The ETRN command is concerned with &"releasing"& messages that are awaiting
36372 delivery to certain hosts. As Exim does not organize its message queue by host,
36373 the only form of ETRN that is supported by default is the one where the
36374 text starts with the &"#"& prefix, in which case the remainder of the text is
36375 specific to the SMTP server. A valid ETRN command causes a run of Exim with
36376 the &%-R%& option to happen, with the remainder of the ETRN text as its
36377 argument. For example,
36378 .code
36379 ETRN #brigadoon
36380 .endd
36381 runs the command
36382 .code
36383 exim -R brigadoon
36384 .endd
36385 which causes a delivery attempt on all messages with undelivered addresses
36386 containing the text &"brigadoon"&. When &%smtp_etrn_serialize%& is set (the
36387 default), Exim prevents the simultaneous execution of more than one queue run
36388 for the same argument string as a result of an ETRN command. This stops
36389 a misbehaving client from starting more than one queue runner at once.
36390
36391 .cindex "hints database" "ETRN serialization"
36392 Exim implements the serialization by means of a hints database in which a
36393 record is written whenever a process is started by ETRN, and deleted when
36394 the process completes. However, Exim does not keep the SMTP session waiting for
36395 the ETRN process to complete. Once ETRN is accepted, the client is sent
36396 a &"success"& return code. Obviously there is scope for hints records to get
36397 left lying around if there is a system or program crash. To guard against this,
36398 Exim ignores any records that are more than six hours old.
36399
36400 .oindex "&%smtp_etrn_command%&"
36401 For more control over what ETRN does, the &%smtp_etrn_command%& option can
36402 used. This specifies a command that is run whenever ETRN is received,
36403 whatever the form of its argument. For
36404 example:
36405 .code
36406 smtp_etrn_command = /etc/etrn_command $domain \
36407                     $sender_host_address
36408 .endd
36409 .vindex "&$domain$&"
36410 The string is split up into arguments which are independently expanded. The
36411 expansion variable &$domain$& is set to the argument of the ETRN command,
36412 and no syntax checking is done on the contents of this argument. Exim does not
36413 wait for the command to complete, so its status code is not checked. Exim runs
36414 under its own uid and gid when receiving incoming SMTP, so it is not possible
36415 for it to change them before running the command.
36416
36417
36418
36419 .section "Incoming local SMTP" "SECID238"
36420 .cindex "SMTP" "local incoming"
36421 Some user agents use SMTP to pass messages to their local MTA using the
36422 standard input and output, as opposed to passing the envelope on the command
36423 line and writing the message to the standard input. This is supported by the
36424 &%-bs%& option. This form of SMTP is handled in the same way as incoming
36425 messages over TCP/IP (including the use of ACLs), except that the envelope
36426 sender given in a MAIL command is ignored unless the caller is trusted. In
36427 an ACL you can detect this form of SMTP input by testing for an empty host
36428 identification. It is common to have this as the first line in the ACL that
36429 runs for RCPT commands:
36430 .code
36431 accept hosts = :
36432 .endd
36433 This accepts SMTP messages from local processes without doing any other tests.
36434
36435
36436
36437 .section "Outgoing batched SMTP" "SECTbatchSMTP"
36438 .cindex "SMTP" "batched outgoing"
36439 .cindex "batched SMTP output"
36440 Both the &(appendfile)& and &(pipe)& transports can be used for handling
36441 batched SMTP. Each has an option called &%use_bsmtp%& which causes messages to
36442 be output in BSMTP format. No SMTP responses are possible for this form of
36443 delivery. All it is doing is using SMTP commands as a way of transmitting the
36444 envelope along with the message.
36445
36446 The message is written to the file or pipe preceded by the SMTP commands
36447 MAIL and RCPT, and followed by a line containing a single dot. Lines in
36448 the message that start with a dot have an extra dot added. The SMTP command
36449 HELO is not normally used. If it is required, the &%message_prefix%& option
36450 can be used to specify it.
36451
36452 Because &(appendfile)& and &(pipe)& are both local transports, they accept only
36453 one recipient address at a time by default. However, you can arrange for them
36454 to handle several addresses at once by setting the &%batch_max%& option. When
36455 this is done for BSMTP, messages may contain multiple RCPT commands. See
36456 chapter &<<CHAPbatching>>& for more details.
36457
36458 .vindex "&$host$&"
36459 When one or more addresses are routed to a BSMTP transport by a router that
36460 sets up a host list, the name of the first host on the list is available to the
36461 transport in the variable &$host$&. Here is an example of such a transport and
36462 router:
36463 .code
36464 begin routers
36465 route_append:
36466   driver = manualroute
36467   transport = smtp_appendfile
36468   route_list = domain.example  batch.host.example
36469
36470 begin transports
36471 smtp_appendfile:
36472   driver = appendfile
36473   directory = /var/bsmtp/$host
36474   batch_max = 1000
36475   use_bsmtp
36476   user = exim
36477 .endd
36478 This causes messages addressed to &'domain.example'& to be written in BSMTP
36479 format to &_/var/bsmtp/batch.host.example_&, with only a single copy of each
36480 message (unless there are more than 1000 recipients).
36481
36482
36483
36484 .section "Incoming batched SMTP" "SECTincomingbatchedSMTP"
36485 .cindex "SMTP" "batched incoming"
36486 .cindex "batched SMTP input"
36487 The &%-bS%& command line option causes Exim to accept one or more messages by
36488 reading SMTP on the standard input, but to generate no responses. If the caller
36489 is trusted, the senders in the MAIL commands are believed; otherwise the
36490 sender is always the caller of Exim. Unqualified senders and receivers are not
36491 rejected (there seems little point) but instead just get qualified. HELO
36492 and EHLO act as RSET; VRFY, EXPN, ETRN and  HELP, act
36493 as NOOP; QUIT quits.
36494
36495 Minimal policy checking is done for BSMTP input. Only the non-SMTP
36496 ACL is run in the same way as for non-SMTP local input.
36497
36498 If an error is detected while reading a message, including a missing &"."& at
36499 the end, Exim gives up immediately. It writes details of the error to the
36500 standard output in a stylized way that the calling program should be able to
36501 make some use of automatically, for example:
36502 .code
36503 554 Unexpected end of file
36504 Transaction started in line 10
36505 Error detected in line 14
36506 .endd
36507 It writes a more verbose version, for human consumption, to the standard error
36508 file, for example:
36509 .code
36510 An error was detected while processing a file of BSMTP input.
36511 The error message was:
36512
36513 501 '>' missing at end of address
36514
36515 The SMTP transaction started in line 10.
36516 The error was detected in line 12.
36517 The SMTP command at fault was:
36518
36519 rcpt to:<malformed@in.com.plete
36520
36521 1 previous message was successfully processed.
36522 The rest of the batch was abandoned.
36523 .endd
36524 The return code from Exim is zero only if there were no errors. It is 1 if some
36525 messages were accepted before an error was detected, and 2 if no messages were
36526 accepted.
36527 .ecindex IIDsmtpproc1
36528 .ecindex IIDsmtpproc2
36529
36530
36531
36532 . ////////////////////////////////////////////////////////////////////////////
36533 . ////////////////////////////////////////////////////////////////////////////
36534
36535 .chapter "Customizing bounce and warning messages" "CHAPemsgcust" &&&
36536          "Customizing messages"
36537 When a message fails to be delivered, or remains in the queue for more than a
36538 configured amount of time, Exim sends a message to the original sender, or
36539 to an alternative configured address. The text of these messages is built into
36540 the code of Exim, but it is possible to change it, either by adding a single
36541 string, or by replacing each of the paragraphs by text supplied in a file.
36542
36543 The &'From:'& and &'To:'& header lines are automatically generated; you can
36544 cause a &'Reply-To:'& line to be added by setting the &%errors_reply_to%&
36545 option. Exim also adds the line
36546 .code
36547 Auto-Submitted: auto-generated
36548 .endd
36549 to all warning and bounce messages,
36550
36551
36552 .section "Customizing bounce messages" "SECID239"
36553 .cindex "customizing" "bounce message"
36554 .cindex "bounce message" "customizing"
36555 If &%bounce_message_text%& is set, its contents are included in the default
36556 message immediately after &"This message was created automatically by mail
36557 delivery software."& The string is not expanded. It is not used if
36558 &%bounce_message_file%& is set.
36559
36560 When &%bounce_message_file%& is set, it must point to a template file for
36561 constructing error messages. The file consists of a series of text items,
36562 separated by lines consisting of exactly four asterisks. If the file cannot be
36563 opened, default text is used and a message is written to the main and panic
36564 logs. If any text item in the file is empty, default text is used for that
36565 item.
36566
36567 .vindex "&$bounce_recipient$&"
36568 .vindex "&$bounce_return_size_limit$&"
36569 Each item of text that is read from the file is expanded, and there are two
36570 expansion variables which can be of use here: &$bounce_recipient$& is set to
36571 the recipient of an error message while it is being created, and
36572 &$bounce_return_size_limit$& contains the value of the &%return_size_limit%&
36573 option, rounded to a whole number.
36574
36575 The items must appear in the file in the following order:
36576
36577 .ilist
36578 The first item is included in the headers, and should include at least a
36579 &'Subject:'& header. Exim does not check the syntax of these headers.
36580 .next
36581 The second item forms the start of the error message. After it, Exim lists the
36582 failing addresses with their error messages.
36583 .next
36584 The third item is used to introduce any text from pipe transports that is to be
36585 returned to the sender. It is omitted if there is no such text.
36586 .next
36587 The fourth, fifth and sixth items will be ignored and may be empty.
36588 The fields exist for back-compatibility
36589 .endlist
36590
36591 The default state (&%bounce_message_file%& unset) is equivalent to the
36592 following file, in which the sixth item is empty. The &'Subject:'& and some
36593 other lines have been split in order to fit them on the page:
36594 .code
36595 Subject: Mail delivery failed
36596   ${if eq{$sender_address}{$bounce_recipient}
36597   {: returning message to sender}}
36598 ****
36599 This message was created automatically by mail delivery software.
36600
36601 A message ${if eq{$sender_address}{$bounce_recipient}
36602   {that you sent }{sent by
36603
36604 <$sender_address>
36605
36606 }}could not be delivered to all of its recipients.
36607 This is a permanent error. The following address(es) failed:
36608 ****
36609 The following text was generated during the delivery attempt(s):
36610 ****
36611 ------ This is a copy of the message, including all the headers.
36612   ------
36613 ****
36614 ------ The body of the message is $message_size characters long;
36615   only the first
36616 ------ $bounce_return_size_limit or so are included here.
36617 ****
36618 .endd
36619 .section "Customizing warning messages" "SECTcustwarn"
36620 .cindex "customizing" "warning message"
36621 .cindex "warning of delay" "customizing the message"
36622 The option &%warn_message_file%& can be pointed at a template file for use when
36623 warnings about message delays are created. In this case there are only three
36624 text sections:
36625
36626 .ilist
36627 The first item is included in the headers, and should include at least a
36628 &'Subject:'& header. Exim does not check the syntax of these headers.
36629 .next
36630 The second item forms the start of the warning message. After it, Exim lists
36631 the delayed addresses.
36632 .next
36633 The third item then ends the message.
36634 .endlist
36635
36636 The default state is equivalent to the following file, except that some lines
36637 have been split here, in order to fit them on the page:
36638 .code
36639 Subject: Warning: message $message_exim_id delayed
36640   $warn_message_delay
36641 ****
36642 This message was created automatically by mail delivery software.
36643
36644 A message ${if eq{$sender_address}{$warn_message_recipients}
36645 {that you sent }{sent by
36646
36647 <$sender_address>
36648
36649 }}has not been delivered to all of its recipients after
36650 more than $warn_message_delay in the queue on $primary_hostname.
36651
36652 The message identifier is:     $message_exim_id
36653 The subject of the message is: $h_subject
36654 The date of the message is:    $h_date
36655
36656 The following address(es) have not yet been delivered:
36657 ****
36658 No action is required on your part. Delivery attempts will
36659 continue for some time, and this warning may be repeated at
36660 intervals if the message remains undelivered. Eventually the
36661 mail delivery software will give up, and when that happens,
36662 the message will be returned to you.
36663 .endd
36664 .vindex "&$warn_message_delay$&"
36665 .vindex "&$warn_message_recipients$&"
36666 However, in the default state the subject and date lines are omitted if no
36667 appropriate headers exist. During the expansion of this file,
36668 &$warn_message_delay$& is set to the delay time in one of the forms &"<&'n'&>
36669 minutes"& or &"<&'n'&> hours"&, and &$warn_message_recipients$& contains a list
36670 of recipients for the warning message. There may be more than one if there are
36671 multiple addresses with different &%errors_to%& settings on the routers that
36672 handled them.
36673
36674
36675
36676
36677 . ////////////////////////////////////////////////////////////////////////////
36678 . ////////////////////////////////////////////////////////////////////////////
36679
36680 .chapter "Some common configuration settings" "CHAPcomconreq"
36681 This chapter discusses some configuration settings that seem to be fairly
36682 common. More examples and discussion can be found in the Exim book.
36683
36684
36685
36686 .section "Sending mail to a smart host" "SECID240"
36687 .cindex "smart host" "example router"
36688 If you want to send all mail for non-local domains to a &"smart host"&, you
36689 should replace the default &(dnslookup)& router with a router which does the
36690 routing explicitly:
36691 .code
36692 send_to_smart_host:
36693   driver = manualroute
36694   route_list = !+local_domains smart.host.name
36695   transport = remote_smtp
36696 .endd
36697 You can use the smart host's IP address instead of the name if you wish.
36698 If you are using Exim only to submit messages to a smart host, and not for
36699 receiving incoming messages, you can arrange for it to do the submission
36700 synchronously by setting the &%mua_wrapper%& option (see chapter
36701 &<<CHAPnonqueueing>>&).
36702
36703
36704
36705
36706 .section "Using Exim to handle mailing lists" "SECTmailinglists"
36707 .cindex "mailing lists"
36708 Exim can be used to run simple mailing lists, but for large and/or complicated
36709 requirements, the use of additional specialized mailing list software such as
36710 Majordomo or Mailman is recommended.
36711
36712 The &(redirect)& router can be used to handle mailing lists where each list
36713 is maintained in a separate file, which can therefore be managed by an
36714 independent manager. The &%domains%& router option can be used to run these
36715 lists in a separate domain from normal mail. For example:
36716 .code
36717 lists:
36718   driver = redirect
36719   domains = lists.example
36720   file = ${lookup {$local_part} dsearch,ret=full {/usr/lists}}
36721   forbid_pipe
36722   forbid_file
36723   errors_to = ${quote_local_part:$local_part-request}@lists.example
36724   no_more
36725 .endd
36726 This router is skipped for domains other than &'lists.example'&. For addresses
36727 in that domain, it looks for a file that matches the local part. If there is no
36728 such file, the router declines, but because &%no_more%& is set, no subsequent
36729 routers are tried, and so the whole delivery fails.
36730
36731 The &%forbid_pipe%& and &%forbid_file%& options prevent a local part from being
36732 expanded into a filename or a pipe delivery, which is usually inappropriate in
36733 a mailing list.
36734
36735 .oindex "&%errors_to%&"
36736 The &%errors_to%& option specifies that any delivery errors caused by addresses
36737 taken from a mailing list are to be sent to the given address rather than the
36738 original sender of the message. However, before acting on this, Exim verifies
36739 the error address, and ignores it if verification fails.
36740
36741 For example, using the configuration above, mail sent to
36742 &'dicts@lists.example'& is passed on to those addresses contained in
36743 &_/usr/lists/dicts_&, with error reports directed to
36744 &'dicts-request@lists.example'&, provided that this address can be verified.
36745 There could be a file called &_/usr/lists/dicts-request_& containing
36746 the address(es) of this particular list's manager(s), but other approaches,
36747 such as setting up an earlier router (possibly using the &%local_part_prefix%&
36748 or &%local_part_suffix%& options) to handle addresses of the form
36749 &%owner-%&&'xxx'& or &%xxx-%&&'request'&, are also possible.
36750
36751
36752
36753 .section "Syntax errors in mailing lists" "SECID241"
36754 .cindex "mailing lists" "syntax errors in"
36755 If an entry in redirection data contains a syntax error, Exim normally defers
36756 delivery of the original address. That means that a syntax error in a mailing
36757 list holds up all deliveries to the list. This may not be appropriate when a
36758 list is being maintained automatically from data supplied by users, and the
36759 addresses are not rigorously checked.
36760
36761 If the &%skip_syntax_errors%& option is set, the &(redirect)& router just skips
36762 entries that fail to parse, noting the incident in the log. If in addition
36763 &%syntax_errors_to%& is set to a verifiable address, a message is sent to it
36764 whenever a broken address is skipped. It is usually appropriate to set
36765 &%syntax_errors_to%& to the same address as &%errors_to%&.
36766
36767
36768
36769 .section "Re-expansion of mailing lists" "SECID242"
36770 .cindex "mailing lists" "re-expansion of"
36771 Exim remembers every individual address to which a message has been delivered,
36772 in order to avoid duplication, but it normally stores only the original
36773 recipient addresses with a message. If all the deliveries to a mailing list
36774 cannot be done at the first attempt, the mailing list is re-expanded when the
36775 delivery is next tried. This means that alterations to the list are taken into
36776 account at each delivery attempt, so addresses that have been added to
36777 the list since the message arrived will therefore receive a copy of the
36778 message, even though it pre-dates their subscription.
36779
36780 If this behaviour is felt to be undesirable, the &%one_time%& option can be set
36781 on the &(redirect)& router. If this is done, any addresses generated by the
36782 router that fail to deliver at the first attempt are added to the message as
36783 &"top level"& addresses, and the parent address that generated them is marked
36784 &"delivered"&. Thus, expansion of the mailing list does not happen again at the
36785 subsequent delivery attempts. The disadvantage of this is that if any of the
36786 failing addresses are incorrect, correcting them in the file has no effect on
36787 pre-existing messages.
36788
36789 The original top-level address is remembered with each of the generated
36790 addresses, and is output in any log messages. However, any intermediate parent
36791 addresses are not recorded. This makes a difference to the log only if the
36792 &%all_parents%& selector is set, but for mailing lists there is normally only
36793 one level of expansion anyway.
36794
36795
36796
36797 .section "Closed mailing lists" "SECID243"
36798 .cindex "mailing lists" "closed"
36799 The examples so far have assumed open mailing lists, to which anybody may
36800 send mail. It is also possible to set up closed lists, where mail is accepted
36801 from specified senders only. This is done by making use of the generic
36802 &%senders%& option to restrict the router that handles the list.
36803
36804 The following example uses the same file as a list of recipients and as a list
36805 of permitted senders. It requires three routers:
36806 .code
36807 lists_request:
36808   driver = redirect
36809   domains = lists.example
36810   local_part_suffix = -request
36811   local_parts = ${lookup {$local_part} dsearch,filter=file {/usr/lists}}
36812   file = /usr/lists/${local_part_data}-request
36813   no_more
36814
36815 lists_post:
36816   driver = redirect
36817   domains = lists.example
36818   senders = ${if exists {/usr/lists/$local_part}\
36819              {lsearch;/usr/lists/$local_part}{*}}
36820   file = ${lookup {$local_part} dsearch,ret=full {/usr/lists}}
36821   forbid_pipe
36822   forbid_file
36823   errors_to = ${quote_local_part:$local_part-request}@lists.example
36824   no_more
36825
36826 lists_closed:
36827   driver = redirect
36828   domains = lists.example
36829   allow_fail
36830   data = :fail: $local_part@lists.example is a closed mailing list
36831 .endd
36832 All three routers have the same &%domains%& setting, so for any other domains,
36833 they are all skipped. The first router runs only if the local part ends in
36834 &%-request%&. It handles messages to the list manager(s) by means of an open
36835 mailing list.
36836
36837 The second router runs only if the &%senders%& precondition is satisfied. It
36838 checks for the existence of a list that corresponds to the local part, and then
36839 checks that the sender is on the list by means of a linear search. It is
36840 necessary to check for the existence of the file before trying to search it,
36841 because otherwise Exim thinks there is a configuration error. If the file does
36842 not exist, the expansion of &%senders%& is *, which matches all senders. This
36843 means that the router runs, but because there is no list, declines, and
36844 &%no_more%& ensures that no further routers are run. The address fails with an
36845 &"unrouteable address"& error.
36846
36847 The third router runs only if the second router is skipped, which happens when
36848 a mailing list exists, but the sender is not on it. This router forcibly fails
36849 the address, giving a suitable error message.
36850
36851
36852
36853
36854 .section "Variable Envelope Return Paths (VERP)" "SECTverp"
36855 .cindex "VERP"
36856 .cindex "Variable Envelope Return Paths"
36857 .cindex "envelope from"
36858 .cindex "envelope sender"
36859 Variable Envelope Return Paths &-- see &url(https://cr.yp.to/proto/verp.txt) &--
36860 are a way of helping mailing list administrators discover which subscription
36861 address is the cause of a particular delivery failure. The idea is to encode
36862 the original recipient address in the outgoing envelope sender address, so that
36863 if the message is forwarded by another host and then subsequently bounces, the
36864 original recipient can be extracted from the recipient address of the bounce.
36865
36866 .oindex &%errors_to%&
36867 .oindex &%return_path%&
36868 Envelope sender addresses can be modified by Exim using two different
36869 facilities: the &%errors_to%& option on a router (as shown in previous mailing
36870 list examples), or the &%return_path%& option on a transport. The second of
36871 these is effective only if the message is successfully delivered to another
36872 host; it is not used for errors detected on the local host (see the description
36873 of &%return_path%& in chapter &<<CHAPtransportgeneric>>&). Here is an example
36874 of the use of &%return_path%& to implement VERP on an &(smtp)& transport:
36875 .code
36876 verp_smtp:
36877   driver = smtp
36878   max_rcpt = 1
36879   return_path = \
36880     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
36881       {${quote_local_part:$1-request+$local_part=$domain}@your.dom.example}fail}
36882 .endd
36883 This has the effect of rewriting the return path (envelope sender) on outgoing
36884 SMTP messages, if the local part of the original return path ends in
36885 &"-request"&, and the domain is &'your.dom.example'&. The rewriting inserts the
36886 local part and domain of the recipient into the return path. Suppose, for
36887 example, that a message whose return path has been set to
36888 &'somelist-request@your.dom.example'& is sent to
36889 &'subscriber@other.dom.example'&. In the transport, the return path is
36890 rewritten as
36891 .code
36892 somelist-request+subscriber=other.dom.example@your.dom.example
36893 .endd
36894 .vindex "&$local_part$&"
36895 For this to work, you must tell Exim to send multiple copies of messages that
36896 have more than one recipient, so that each copy has just one recipient. This is
36897 achieved by setting &%max_rcpt%& to 1. Without this, a single copy of a message
36898 might be sent to several different recipients in the same domain, in which case
36899 &$local_part$& is not available in the transport, because it is not unique.
36900
36901 Unless your host is doing nothing but mailing list deliveries, you should
36902 probably use a separate transport for the VERP deliveries, so as not to use
36903 extra resources in making one-per-recipient copies for other deliveries. This
36904 can easily be done by expanding the &%transport%& option in the router:
36905 .code
36906 dnslookup:
36907   driver = dnslookup
36908   domains = ! +local_domains
36909   transport = \
36910     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
36911       {verp_smtp}{remote_smtp}}
36912   no_more
36913 .endd
36914 If you want to change the return path using &%errors_to%& in a router instead
36915 of using &%return_path%& in the transport, you need to set &%errors_to%& on all
36916 routers that handle mailing list addresses. This will ensure that all delivery
36917 errors, including those detected on the local host, are sent to the VERP
36918 address.
36919
36920 On a host that does no local deliveries and has no manual routing, only the
36921 &(dnslookup)& router needs to be changed. A special transport is not needed for
36922 SMTP deliveries. Every mailing list recipient has its own return path value,
36923 and so Exim must hand them to the transport one at a time. Here is an example
36924 of a &(dnslookup)& router that implements VERP:
36925 .code
36926 verp_dnslookup:
36927   driver = dnslookup
36928   domains = ! +local_domains
36929   transport = remote_smtp
36930   errors_to = \
36931     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}}
36932      {${quote_local_part:$1-request+$local_part=$domain}@your.dom.example}fail}
36933   no_more
36934 .endd
36935 Before you start sending out messages with VERPed return paths, you must also
36936 configure Exim to accept the bounce messages that come back to those paths.
36937 Typically this is done by setting a &%local_part_suffix%& option for a
36938 router, and using this to route the messages to wherever you want to handle
36939 them.
36940
36941 The overhead incurred in using VERP depends very much on the size of the
36942 message, the number of recipient addresses that resolve to the same remote
36943 host, and the speed of the connection over which the message is being sent. If
36944 a lot of addresses resolve to the same host and the connection is slow, sending
36945 a separate copy of the message for each address may take substantially longer
36946 than sending a single copy with many recipients (for which VERP cannot be
36947 used).
36948
36949
36950
36951
36952
36953
36954 .section "Virtual domains" "SECTvirtualdomains"
36955 .cindex "virtual domains"
36956 .cindex "domain" "virtual"
36957 The phrase &'virtual domain'& is unfortunately used with two rather different
36958 meanings:
36959
36960 .ilist
36961 A domain for which there are no real mailboxes; all valid local parts are
36962 aliases for other email addresses. Common examples are organizational
36963 top-level domains and &"vanity"& domains.
36964 .next
36965 One of a number of independent domains that are all handled by the same host,
36966 with mailboxes on that host, but where the mailbox owners do not necessarily
36967 have login accounts on that host.
36968 .endlist
36969
36970 The first usage is probably more common, and does seem more &"virtual"& than
36971 the second. This kind of domain can be handled in Exim with a straightforward
36972 aliasing router. One approach is to create a separate alias file for each
36973 virtual domain. Exim can test for the existence of the alias file to determine
36974 whether the domain exists. The &(dsearch)& lookup type is useful here, leading
36975 to a router of this form:
36976 .code
36977 virtual:
36978   driver = redirect
36979   domains = dsearch;/etc/mail/virtual
36980   data = ${lookup{$local_part}lsearch{/etc/mail/virtual/$domain_data}}
36981   no_more
36982 .endd
36983 .new
36984 The &%domains%& option specifies that the router is to be skipped, unless there
36985 is a file in the &_/etc/mail/virtual_& directory whose name is the same as the
36986 domain that is being processed.
36987 The &(dsearch)& lookup used results in an untainted version of &$domain$&
36988 being placed into the &$domain_data$& variable.
36989 .wen
36990
36991 When the router runs, it looks up the local
36992 part in the file to find a new address (or list of addresses). The &%no_more%&
36993 setting ensures that if the lookup fails (leading to &%data%& being an empty
36994 string), Exim gives up on the address without trying any subsequent routers.
36995
36996 This one router can handle all the virtual domains because the alias filenames
36997 follow a fixed pattern. Permissions can be arranged so that appropriate people
36998 can edit the different alias files. A successful aliasing operation results in
36999 a new envelope recipient address, which is then routed from scratch.
37000
37001 The other kind of &"virtual"& domain can also be handled in a straightforward
37002 way. One approach is to create a file for each domain containing a list of
37003 valid local parts, and use it in a router like this:
37004 .code
37005 my_domains:
37006   driver = accept
37007   domains = dsearch;/etc/mail/domains
37008   local_parts = lsearch;/etc/mail/domains/$domain
37009   transport = my_mailboxes
37010 .endd
37011 The address is accepted if there is a file for the domain, and the local part
37012 can be found in the file. The &%domains%& option is used to check for the
37013 file's existence because &%domains%& is tested before the &%local_parts%&
37014 option (see section &<<SECTrouprecon>>&). You cannot use &%require_files%&,
37015 because that option is tested after &%local_parts%&. The transport is as
37016 follows:
37017 .code
37018 my_mailboxes:
37019   driver = appendfile
37020   file = /var/mail/$domain/$local_part_data
37021   user = mail
37022 .endd
37023 This uses a directory of mailboxes for each domain. The &%user%& setting is
37024 required, to specify which uid is to be used for writing to the mailboxes.
37025
37026 The configuration shown here is just one example of how you might support this
37027 requirement. There are many other ways this kind of configuration can be set
37028 up, for example, by using a database instead of separate files to hold all the
37029 information about the domains.
37030
37031
37032
37033 .section "Multiple user mailboxes" "SECTmulbox"
37034 .cindex "multiple mailboxes"
37035 .cindex "mailbox" "multiple"
37036 .cindex "local part" "prefix"
37037 .cindex "local part" "suffix"
37038 Heavy email users often want to operate with multiple mailboxes, into which
37039 incoming mail is automatically sorted. A popular way of handling this is to
37040 allow users to use multiple sender addresses, so that replies can easily be
37041 identified. Users are permitted to add prefixes or suffixes to their local
37042 parts for this purpose. The wildcard facility of the generic router options
37043 &%local_part_prefix%& and &%local_part_suffix%& can be used for this. For
37044 example, consider this router:
37045 .code
37046 userforward:
37047   driver = redirect
37048   check_local_user
37049   file = $home/.forward
37050   local_part_suffix = -*
37051   local_part_suffix_optional
37052   allow_filter
37053 .endd
37054 .vindex "&$local_part_suffix$&"
37055 It runs a user's &_.forward_& file for all local parts of the form
37056 &'username-*'&. Within the filter file the user can distinguish different
37057 cases by testing the variable &$local_part_suffix$&. For example:
37058 .code
37059 if $local_part_suffix contains -special then
37060 save /home/$local_part/Mail/special
37061 endif
37062 .endd
37063 If the filter file does not exist, or does not deal with such addresses, they
37064 fall through to subsequent routers, and, assuming no subsequent use of the
37065 &%local_part_suffix%& option is made, they presumably fail. Thus, users have
37066 control over which suffixes are valid.
37067
37068 Alternatively, a suffix can be used to trigger the use of a different
37069 &_.forward_& file &-- which is the way a similar facility is implemented in
37070 another MTA:
37071 .code
37072 userforward:
37073   driver = redirect
37074   check_local_user
37075   local_part_suffix = -*
37076   local_part_suffix_optional
37077   file = ${lookup {.forward$local_part_suffix} dsearch,ret=full {$home} {$value}fail}
37078   allow_filter
37079 .endd
37080 If there is no suffix, &_.forward_& is used; if the suffix is &'-special'&, for
37081 example, &_.forward-special_& is used. Once again, if the appropriate file
37082 does not exist, or does not deal with the address, it is passed on to
37083 subsequent routers, which could, if required, look for an unqualified
37084 &_.forward_& file to use as a default.
37085
37086
37087
37088 .section "Simplified vacation processing" "SECID244"
37089 .cindex "vacation processing"
37090 The traditional way of running the &'vacation'& program is for a user to set up
37091 a pipe command in a &_.forward_& file
37092 (see section &<<SECTspecitredli>>& for syntax details).
37093 This is prone to error by inexperienced users. There are two features of Exim
37094 that can be used to make this process simpler for users:
37095
37096 .ilist
37097 A local part prefix such as &"vacation-"& can be specified on a router which
37098 can cause the message to be delivered directly to the &'vacation'& program, or
37099 alternatively can use Exim's &(autoreply)& transport. The contents of a user's
37100 &_.forward_& file are then much simpler. For example:
37101 .code
37102 spqr, vacation-spqr
37103 .endd
37104 .next
37105 The &%require_files%& generic router option can be used to trigger a
37106 vacation delivery by checking for the existence of a certain file in the
37107 user's home directory. The &%unseen%& generic option should also be used, to
37108 ensure that the original delivery also proceeds. In this case, all the user has
37109 to do is to create a file called, say, &_.vacation_&, containing a vacation
37110 message.
37111 .endlist
37112
37113 Another advantage of both these methods is that they both work even when the
37114 use of arbitrary pipes by users is locked out.
37115
37116
37117
37118 .section "Taking copies of mail" "SECID245"
37119 .cindex "message" "copying every"
37120 Some installations have policies that require archive copies of all messages to
37121 be made. A single copy of each message can easily be taken by an appropriate
37122 command in a system filter, which could, for example, use a different file for
37123 each day's messages.
37124
37125 There is also a shadow transport mechanism that can be used to take copies of
37126 messages that are successfully delivered by local transports, one copy per
37127 delivery. This could be used, &'inter alia'&, to implement automatic
37128 notification of delivery by sites that insist on doing such things.
37129
37130
37131
37132 .section "Intermittently connected hosts" "SECID246"
37133 .cindex "intermittently connected hosts"
37134 It has become quite common (because it is cheaper) for hosts to connect to the
37135 Internet periodically rather than remain connected all the time. The normal
37136 arrangement is that mail for such hosts accumulates on a system that is
37137 permanently connected.
37138
37139 Exim was designed for use on permanently connected hosts, and so it is not
37140 particularly well-suited to use in an intermittently connected environment.
37141 Nevertheless there are some features that can be used.
37142
37143
37144 .section "Exim on the upstream server host" "SECID247"
37145 It is tempting to arrange for incoming mail for the intermittently connected
37146 host to remain in Exim's queue until the client connects. However, this
37147 approach does not scale very well. Two different kinds of waiting message are
37148 being mixed up in the same queue &-- those that cannot be delivered because of
37149 some temporary problem, and those that are waiting for their destination host
37150 to connect. This makes it hard to manage the queue, as well as wasting
37151 resources, because each queue runner scans the entire queue.
37152
37153 A better approach is to separate off those messages that are waiting for an
37154 intermittently connected host. This can be done by delivering these messages
37155 into local files in batch SMTP, &"mailstore"&, or other envelope-preserving
37156 format, from where they are transmitted by other software when their
37157 destination connects. This makes it easy to collect all the mail for one host
37158 in a single directory, and to apply local timeout rules on a per-message basis
37159 if required.
37160
37161 On a very small scale, leaving the mail on Exim's queue can be made to work. If
37162 you are doing this, you should configure Exim with a long retry period for the
37163 intermittent host. For example:
37164 .code
37165 cheshire.wonderland.fict.example    *   F,5d,24h
37166 .endd
37167 This stops a lot of failed delivery attempts from occurring, but Exim remembers
37168 which messages it has queued up for that host. Once the intermittent host comes
37169 online, forcing delivery of one message (either by using the &%-M%& or &%-R%&
37170 options, or by using the ETRN SMTP command (see section &<<SECTETRN>>&)
37171 causes all the queued up messages to be delivered, often down a single SMTP
37172 connection. While the host remains connected, any new messages get delivered
37173 immediately.
37174
37175 If the connecting hosts do not have fixed IP addresses, that is, if a host is
37176 issued with a different IP address each time it connects, Exim's retry
37177 mechanisms on the holding host get confused, because the IP address is normally
37178 used as part of the key string for holding retry information. This can be
37179 avoided by unsetting &%retry_include_ip_address%& on the &(smtp)& transport.
37180 Since this has disadvantages for permanently connected hosts, it is best to
37181 arrange a separate transport for the intermittently connected ones.
37182
37183
37184
37185 .section "Exim on the intermittently connected client host" "SECID248"
37186 The value of &%smtp_accept_queue_per_connection%& should probably be
37187 increased, or even set to zero (that is, disabled) on the intermittently
37188 connected host, so that all incoming messages down a single connection get
37189 delivered immediately.
37190
37191 .cindex "SMTP" "passed connection"
37192 .cindex "SMTP" "multiple deliveries"
37193 .cindex "multiple SMTP deliveries"
37194 .cindex "first pass routing"
37195 Mail waiting to be sent from an intermittently connected host will probably
37196 not have been routed, because without a connection DNS lookups are not
37197 possible. This means that if a normal queue run is done at connection time,
37198 each message is likely to be sent in a separate SMTP session. This can be
37199 avoided by starting the queue run with a command line option beginning with
37200 &%-qq%& instead of &%-q%&. In this case, the queue is scanned twice. In the
37201 first pass, routing is done but no deliveries take place. The second pass is a
37202 normal queue run; since all the messages have been previously routed, those
37203 destined for the same host are likely to get sent as multiple deliveries in a
37204 single SMTP connection.
37205
37206
37207
37208 . ////////////////////////////////////////////////////////////////////////////
37209 . ////////////////////////////////////////////////////////////////////////////
37210
37211 .chapter "Using Exim as a non-queueing client" "CHAPnonqueueing" &&&
37212          "Exim as a non-queueing client"
37213 .cindex "client, non-queueing"
37214 .cindex "smart host" "suppressing queueing"
37215 On a personal computer, it is a common requirement for all
37216 email to be sent to a &"smart host"&. There are plenty of MUAs that can be
37217 configured to operate that way, for all the popular operating systems.
37218 However, there are some MUAs for Unix-like systems that cannot be so
37219 configured: they submit messages using the command line interface of
37220 &_/usr/sbin/sendmail_&. Furthermore, utility programs such as &'cron'& submit
37221 messages this way.
37222
37223 If the personal computer runs continuously, there is no problem, because it can
37224 run a conventional MTA that handles delivery to the smart host, and deal with
37225 any delays via its queueing mechanism. However, if the computer does not run
37226 continuously or runs different operating systems at different times, queueing
37227 email is not desirable.
37228
37229 There is therefore a requirement for something that can provide the
37230 &_/usr/sbin/sendmail_& interface but deliver messages to a smart host without
37231 any queueing or retrying facilities. Furthermore, the delivery to the smart
37232 host should be synchronous, so that if it fails, the sending MUA is immediately
37233 informed. In other words, we want something that extends an MUA that submits
37234 to a local MTA via the command line so that it behaves like one that submits
37235 to a remote smart host using TCP/SMTP.
37236
37237 There are a number of applications (for example, there is one called &'ssmtp'&)
37238 that do this job. However, people have found them to be lacking in various
37239 ways. For instance, you might want to allow aliasing and forwarding to be done
37240 before sending a message to the smart host.
37241
37242 Exim already had the necessary infrastructure for doing this job. Just a few
37243 tweaks were needed to make it behave as required, though it is somewhat of an
37244 overkill to use a fully-featured MTA for this purpose.
37245
37246 .oindex "&%mua_wrapper%&"
37247 There is a Boolean global option called &%mua_wrapper%&, defaulting false.
37248 Setting &%mua_wrapper%& true causes Exim to run in a special mode where it
37249 assumes that it is being used to &"wrap"& a command-line MUA in the manner
37250 just described. As well as setting &%mua_wrapper%&, you also need to provide a
37251 compatible router and transport configuration. Typically there will be just one
37252 router and one transport, sending everything to a smart host.
37253
37254 When run in MUA wrapping mode, the behaviour of Exim changes in the
37255 following ways:
37256
37257 .ilist
37258 A daemon cannot be run, nor will Exim accept incoming messages from &'inetd'&.
37259 In other words, the only way to submit messages is via the command line.
37260 .next
37261 Each message is synchronously delivered as soon as it is received (&%-odi%& is
37262 assumed). All queueing options (&%queue_only%&, &%queue_smtp_domains%&,
37263 &%control%& in an ACL, etc.) are quietly ignored. The Exim reception process
37264 does not finish until the delivery attempt is complete. If the delivery is
37265 successful, a zero return code is given.
37266 .next
37267 Address redirection is permitted, but the final routing for all addresses must
37268 be to the same remote transport, and to the same list of hosts. Furthermore,
37269 the return address (envelope sender) must be the same for all recipients, as
37270 must any added or deleted header lines. In other words, it must be possible to
37271 deliver the message in a single SMTP transaction, however many recipients there
37272 are.
37273 .next
37274 If these conditions are not met, or if routing any address results in a
37275 failure or defer status, or if Exim is unable to deliver all the recipients
37276 successfully to one of the smart hosts, delivery of the entire message fails.
37277 .next
37278 Because no queueing is allowed, all failures are treated as permanent; there
37279 is no distinction between 4&'xx'& and 5&'xx'& SMTP response codes from the
37280 smart host. Furthermore, because only a single yes/no response can be given to
37281 the caller, it is not possible to deliver to some recipients and not others. If
37282 there is an error (temporary or permanent) for any recipient, all are failed.
37283 .next
37284 If more than one smart host is listed, Exim will try another host after a
37285 connection failure or a timeout, in the normal way. However, if this kind of
37286 failure happens for all the hosts, the delivery fails.
37287 .next
37288 When delivery fails, an error message is written to the standard error stream
37289 (as well as to Exim's log), and Exim exits to the caller with a return code
37290 value 1. The message is expunged from Exim's spool files. No bounce messages
37291 are ever generated.
37292 .next
37293 No retry data is maintained, and any retry rules are ignored.
37294 .next
37295 A number of Exim options are overridden: &%deliver_drop_privilege%& is forced
37296 true, &%max_rcpt%& in the &(smtp)& transport is forced to &"unlimited"&,
37297 &%remote_max_parallel%& is forced to one, and fallback hosts are ignored.
37298 .endlist
37299
37300 The overall effect is that Exim makes a single synchronous attempt to deliver
37301 the message, failing if there is any kind of problem. Because no local
37302 deliveries are done and no daemon can be run, Exim does not need root
37303 privilege. It should be possible to run it setuid to &'exim'& instead of setuid
37304 to &'root'&. See section &<<SECTrunexiwitpri>>& for a general discussion about
37305 the advantages and disadvantages of running without root privilege.
37306
37307
37308
37309
37310 . ////////////////////////////////////////////////////////////////////////////
37311 . ////////////////////////////////////////////////////////////////////////////
37312
37313 .chapter "Log files" "CHAPlog"
37314 .scindex IIDloggen "log" "general description"
37315 .cindex "log" "types of"
37316 Exim writes three different logs, referred to as the main log, the reject log,
37317 and the panic log:
37318
37319 .ilist
37320 .cindex "main log"
37321 The main log records the arrival of each message and each delivery in a single
37322 line in each case. The format is as compact as possible, in an attempt to keep
37323 down the size of log files. Two-character flag sequences make it easy to pick
37324 out these lines. A number of other events are recorded in the main log. Some of
37325 them are optional, in which case the &%log_selector%& option controls whether
37326 they are included or not. A Perl script called &'eximstats'&, which does simple
37327 analysis of main log files, is provided in the Exim distribution (see section
37328 &<<SECTmailstat>>&).
37329 .next
37330 .cindex "reject log"
37331 The reject log records information from messages that are rejected as a result
37332 of a configuration option (that is, for policy reasons).
37333 The first line of each rejection is a copy of the line that is also written to
37334 the main log. Then, if the message's header has been read at the time the log
37335 is written, its contents are written to this log. Only the original header
37336 lines are available; header lines added by ACLs are not logged. You can use the
37337 reject log to check that your policy controls are working correctly; on a busy
37338 host this may be easier than scanning the main log for rejection messages. You
37339 can suppress the writing of the reject log by setting &%write_rejectlog%&
37340 false.
37341 .next
37342 .cindex "panic log"
37343 .cindex "system log"
37344 When certain serious errors occur, Exim writes entries to its panic log. If the
37345 error is sufficiently disastrous, Exim bombs out afterwards. Panic log entries
37346 are usually written to the main log as well, but can get lost amid the mass of
37347 other entries. The panic log should be empty under normal circumstances. It is
37348 therefore a good idea to check it (or to have a &'cron'& script check it)
37349 regularly, in order to become aware of any problems. When Exim cannot open its
37350 panic log, it tries as a last resort to write to the system log (syslog). This
37351 is opened with LOG_PID+LOG_CONS and the facility code of LOG_MAIL. The
37352 message itself is written at priority LOG_CRIT.
37353 .endlist
37354
37355 Every log line starts with a timestamp, in the format shown in the following
37356 example. Note that many of the examples shown in this chapter are line-wrapped.
37357 In the log file, this would be all on one line:
37358 .code
37359 2001-09-16 16:09:47 SMTP connection from [127.0.0.1] closed
37360   by QUIT
37361 .endd
37362 By default, the timestamps are in the local timezone. There are two
37363 ways of changing this:
37364
37365 .ilist
37366 You can set the &%timezone%& option to a different time zone; in particular, if
37367 you set
37368 .code
37369 timezone = UTC
37370 .endd
37371 the timestamps will be in UTC (aka GMT).
37372 .next
37373 If you set &%log_timezone%& true, the time zone is added to the timestamp, for
37374 example:
37375 .code
37376 2003-04-25 11:17:07 +0100 Start queue run: pid=12762
37377 .endd
37378 .endlist
37379
37380 .cindex "log" "process ids in"
37381 .cindex "pid (process id)" "in log lines"
37382 Exim does not include its process id in log lines by default, but you can
37383 request that it does so by specifying the &`pid`& log selector (see section
37384 &<<SECTlogselector>>&). When this is set, the process id is output, in square
37385 brackets, immediately after the time and date.
37386
37387
37388
37389
37390 .section "Where the logs are written" "SECTwhelogwri"
37391 .cindex "log" "destination"
37392 .cindex "log" "to file"
37393 .cindex "log" "to syslog"
37394 .cindex "syslog"
37395 The logs may be written to local files, or to syslog, or both. However, it
37396 should be noted that many syslog implementations use UDP as a transport, and
37397 are therefore unreliable in the sense that messages are not guaranteed to
37398 arrive at the loghost, nor is the ordering of messages necessarily maintained.
37399 It has also been reported that on large log files (tens of megabytes) you may
37400 need to tweak syslog to prevent it syncing the file with each write &-- on
37401 Linux this has been seen to make syslog take 90% plus of CPU time.
37402
37403 The destination for Exim's logs is configured by setting LOG_FILE_PATH in
37404 &_Local/Makefile_& or by setting &%log_file_path%& in the runtime
37405 configuration. This latter string is expanded, so it can contain, for example,
37406 references to the host name:
37407 .code
37408 log_file_path = /var/log/$primary_hostname/exim_%slog
37409 .endd
37410 It is generally advisable, however, to set the string in &_Local/Makefile_&
37411 rather than at runtime, because then the setting is available right from the
37412 start of Exim's execution. Otherwise, if there's something it wants to log
37413 before it has read the configuration file (for example, an error in the
37414 configuration file) it will not use the path you want, and may not be able to
37415 log at all.
37416
37417 The value of LOG_FILE_PATH or &%log_file_path%& is a colon-separated
37418 list, currently limited to at most two items. This is one option where the
37419 facility for changing a list separator may not be used. The list must always be
37420 colon-separated. If an item in the list is &"syslog"& then syslog is used;
37421 otherwise the item must either be an absolute path, containing &`%s`& at the
37422 point where &"main"&, &"reject"&, or &"panic"& is to be inserted, or be empty,
37423 implying the use of a default path.
37424
37425 When Exim encounters an empty item in the list, it searches the list defined by
37426 LOG_FILE_PATH, and uses the first item it finds that is neither empty nor
37427 &"syslog"&. This means that an empty item in &%log_file_path%& can be used to
37428 mean &"use the path specified at build time"&. It no such item exists, log
37429 files are written in the &_log_& subdirectory of the spool directory. This is
37430 equivalent to the setting:
37431 .code
37432 log_file_path = $spool_directory/log/%slog
37433 .endd
37434 If you do not specify anything at build time or runtime,
37435 or if you unset the option at runtime (i.e. &`log_file_path = `&),
37436 that is where the logs are written.
37437
37438 A log file path may also contain &`%D`& or &`%M`& if datestamped log filenames
37439 are in use &-- see section &<<SECTdatlogfil>>& below.
37440
37441 Here are some examples of possible settings:
37442 .display
37443 &`LOG_FILE_PATH=syslog                    `& syslog only
37444 &`LOG_FILE_PATH=:syslog                   `& syslog and default path
37445 &`LOG_FILE_PATH=syslog : /usr/log/exim_%s `& syslog and specified path
37446 &`LOG_FILE_PATH=/usr/log/exim_%s          `& specified path only
37447 .endd
37448 If there are more than two paths in the list, the first is used and a panic
37449 error is logged.
37450
37451
37452
37453 .section "Logging to local files that are periodically &""cycled""&" "SECID285"
37454 .cindex "log" "cycling local files"
37455 .cindex "cycling logs"
37456 .cindex "&'exicyclog'&"
37457 .cindex "log" "local files; writing to"
37458 Some operating systems provide centralized and standardized methods for cycling
37459 log files. For those that do not, a utility script called &'exicyclog'& is
37460 provided (see section &<<SECTcyclogfil>>&). This renames and compresses the
37461 main and reject logs each time it is called. The maximum number of old logs to
37462 keep can be set. It is suggested this script is run as a daily &'cron'& job.
37463
37464 An Exim delivery process opens the main log when it first needs to write to it,
37465 and it keeps the file open in case subsequent entries are required &-- for
37466 example, if a number of different deliveries are being done for the same
37467 message. However, remote SMTP deliveries can take a long time, and this means
37468 that the file may be kept open long after it is renamed if &'exicyclog'& or
37469 something similar is being used to rename log files on a regular basis. To
37470 ensure that a switch of log files is noticed as soon as possible, Exim calls
37471 &[stat()]& on the main log's name before reusing an open file, and if the file
37472 does not exist, or its inode has changed, the old file is closed and Exim
37473 tries to open the main log from scratch. Thus, an old log file may remain open
37474 for quite some time, but no Exim processes should write to it once it has been
37475 renamed.
37476
37477
37478
37479 .section "Datestamped log files" "SECTdatlogfil"
37480 .cindex "log" "datestamped files"
37481 Instead of cycling the main and reject log files by renaming them
37482 periodically, some sites like to use files whose names contain a datestamp,
37483 for example, &_mainlog-20031225_&. The datestamp is in the form &_yyyymmdd_& or
37484 &_yyyymm_&. Exim has support for this way of working. It is enabled by setting
37485 the &%log_file_path%& option to a path that includes &`%D`& or &`%M`& at the
37486 point where the datestamp is required. For example:
37487 .code
37488 log_file_path = /var/spool/exim/log/%slog-%D
37489 log_file_path = /var/log/exim-%s-%D.log
37490 log_file_path = /var/spool/exim/log/%D-%slog
37491 log_file_path = /var/log/exim/%s.%M
37492 .endd
37493 As before, &`%s`& is replaced by &"main"& or &"reject"&; the following are
37494 examples of names generated by the above examples:
37495 .code
37496 /var/spool/exim/log/mainlog-20021225
37497 /var/log/exim-reject-20021225.log
37498 /var/spool/exim/log/20021225-mainlog
37499 /var/log/exim/main.200212
37500 .endd
37501 When this form of log file is specified, Exim automatically switches to new
37502 files at midnight. It does not make any attempt to compress old logs; you
37503 will need to write your own script if you require this. You should not
37504 run &'exicyclog'& with this form of logging.
37505
37506 The location of the panic log is also determined by &%log_file_path%&, but it
37507 is not datestamped, because rotation of the panic log does not make sense.
37508 When generating the name of the panic log, &`%D`& or &`%M`& are removed from
37509 the string. In addition, if it immediately follows a slash, a following
37510 non-alphanumeric character is removed; otherwise a preceding non-alphanumeric
37511 character is removed. Thus, the four examples above would give these panic
37512 log names:
37513 .code
37514 /var/spool/exim/log/paniclog
37515 /var/log/exim-panic.log
37516 /var/spool/exim/log/paniclog
37517 /var/log/exim/panic
37518 .endd
37519
37520
37521 .section "Logging to syslog" "SECID249"
37522 .cindex "log" "syslog; writing to"
37523 The use of syslog does not change what Exim logs or the format of its messages,
37524 except in one respect. If &%syslog_timestamp%& is set false, the timestamps on
37525 Exim's log lines are omitted when these lines are sent to syslog. Apart from
37526 that, the same strings are written to syslog as to log files. The syslog
37527 &"facility"& is set to LOG_MAIL, and the program name to &"exim"&
37528 by default, but you can change these by setting the &%syslog_facility%& and
37529 &%syslog_processname%& options, respectively. If Exim was compiled with
37530 SYSLOG_LOG_PID set in &_Local/Makefile_& (this is the default in
37531 &_src/EDITME_&), then, on systems that permit it (all except ULTRIX), the
37532 LOG_PID flag is set so that the &[syslog()]& call adds the pid as well as
37533 the time and host name to each line.
37534 The three log streams are mapped onto syslog priorities as follows:
37535
37536 .ilist
37537 &'mainlog'& is mapped to LOG_INFO
37538 .next
37539 &'rejectlog'& is mapped to LOG_NOTICE
37540 .next
37541 &'paniclog'& is mapped to LOG_ALERT
37542 .endlist
37543
37544 Many log lines are written to both &'mainlog'& and &'rejectlog'&, and some are
37545 written to both &'mainlog'& and &'paniclog'&, so there will be duplicates if
37546 these are routed by syslog to the same place. You can suppress this duplication
37547 by setting &%syslog_duplication%& false.
37548
37549 Exim's log lines can sometimes be very long, and some of its &'rejectlog'&
37550 entries contain multiple lines when headers are included. To cope with both
37551 these cases, entries written to syslog are split into separate &[syslog()]&
37552 calls at each internal newline, and also after a maximum of
37553 870 data characters. (This allows for a total syslog line length of 1024, when
37554 additions such as timestamps are added.) If you are running a syslog
37555 replacement that can handle lines longer than the 1024 characters allowed by
37556 RFC 3164, you should set
37557 .code
37558 SYSLOG_LONG_LINES=yes
37559 .endd
37560 in &_Local/Makefile_& before building Exim. That stops Exim from splitting long
37561 lines, but it still splits at internal newlines in &'reject'& log entries.
37562
37563 To make it easy to re-assemble split lines later, each component of a split
37564 entry starts with a string of the form [<&'n'&>/<&'m'&>] or [<&'n'&>\<&'m'&>]
37565 where <&'n'&> is the component number and <&'m'&> is the total number of
37566 components in the entry. The / delimiter is used when the line was split
37567 because it was too long; if it was split because of an internal newline, the \
37568 delimiter is used. For example, supposing the length limit to be 50 instead of
37569 870, the following would be the result of a typical rejection message to
37570 &'mainlog'& (LOG_INFO), each line in addition being preceded by the time, host
37571 name, and pid as added by syslog:
37572 .code
37573 [1/5] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected from
37574 [2/5]  [127.0.0.1] (ph10): syntax error in 'From' header
37575 [3/5]  when scanning for sender: missing or malformed lo
37576 [4/5] cal part in "<>" (envelope sender is <ph10@cam.exa
37577 [5/5] mple>)
37578 .endd
37579 The same error might cause the following lines to be written to &"rejectlog"&
37580 (LOG_NOTICE):
37581 .code
37582 [1/18] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected fro
37583 [2/18] m [127.0.0.1] (ph10): syntax error in 'From' head
37584 [3/18] er when scanning for sender: missing or malformed
37585 [4/18]  local part in "<>" (envelope sender is <ph10@cam
37586 [5\18] .example>)
37587 [6\18] Recipients: ph10@some.domain.cam.example
37588 [7\18] P Received: from [127.0.0.1] (ident=ph10)
37589 [8\18]        by xxxxx.cam.example with smtp (Exim 4.00)
37590 [9\18]        id 16RdAL-0006pc-00
37591 [10/18]        for ph10@cam.example; Mon, 16 Sep 2002 16:
37592 [11\18] 09:43 +0100
37593 [12\18] F From: <>
37594 [13\18]   Subject: this is a test header
37595 [18\18]   X-something: this is another header
37596 [15/18] I Message-Id: <E16RdAL-0006pc-00@xxxxx.cam.examp
37597 [16\18] le>
37598 [17\18] B Bcc:
37599 [18/18]   Date: Mon, 16 Sep 2002 16:09:43 +0100
37600 .endd
37601 Log lines that are neither too long nor contain newlines are written to syslog
37602 without modification.
37603
37604 If only syslog is being used, the Exim monitor is unable to provide a log tail
37605 display, unless syslog is routing &'mainlog'& to a file on the local host and
37606 the environment variable EXIMON_LOG_FILE_PATH is set to tell the monitor
37607 where it is.
37608
37609
37610
37611 .section "Log line flags" "SECID250"
37612 One line is written to the main log for each message received, and for each
37613 successful, unsuccessful, and delayed delivery. These lines can readily be
37614 picked out by the distinctive two-character flags that immediately follow the
37615 timestamp. The flags are:
37616 .display
37617 &`<=`&     message arrival
37618 &`(=`&     message fakereject
37619 &`=>`&     normal message delivery
37620 &`->`&     additional address in same delivery
37621 &`>>`&     cutthrough message delivery
37622 &`*>`&     delivery suppressed by &%-N%&
37623 &`**`&     delivery failed; address bounced
37624 &`==`&     delivery deferred; temporary problem
37625 .endd
37626
37627
37628 .section "Logging message reception" "SECID251"
37629 .cindex "log" "reception line"
37630 The format of the single-line entry in the main log that is written for every
37631 message received is shown in the basic example below, which is split over
37632 several lines in order to fit it on the page:
37633 .code
37634 2002-10-31 08:57:53 16ZCW1-0005MB-00 <= kryten@dwarf.fict.example
37635   H=mailer.fict.example [192.168.123.123] U=exim
37636   P=smtp S=5678 id=<incoming message id>
37637 .endd
37638 The address immediately following &"<="& is the envelope sender address. A
37639 bounce message is shown with the sender address &"<>"&, and if it is locally
37640 generated, this is followed by an item of the form
37641 .code
37642 R=<message id>
37643 .endd
37644 which is a reference to the message that caused the bounce to be sent.
37645
37646 .cindex "HELO"
37647 .cindex "EHLO"
37648 For messages from other hosts, the H and U fields identify the remote host and
37649 record the RFC 1413 identity of the user that sent the message, if one was
37650 received. The number given in square brackets is the IP address of the sending
37651 host. If there is a single, unparenthesized  host name in the H field, as
37652 above, it has been verified to correspond to the IP address (see the
37653 &%host_lookup%& option). If the name is in parentheses, it was the name quoted
37654 by the remote host in the SMTP HELO or EHLO command, and has not been
37655 verified. If verification yields a different name to that given for HELO or
37656 EHLO, the verified name appears first, followed by the HELO or EHLO
37657 name in parentheses.
37658
37659 Misconfigured hosts (and mail forgers) sometimes put an IP address, with or
37660 without brackets, in the HELO or EHLO command, leading to entries in
37661 the log containing text like these examples:
37662 .code
37663 H=(10.21.32.43) [192.168.8.34]
37664 H=([10.21.32.43]) [192.168.8.34]
37665 .endd
37666 This can be confusing. Only the final address in square brackets can be relied
37667 on.
37668
37669 For locally generated messages (that is, messages not received over TCP/IP),
37670 the H field is omitted, and the U field contains the login name of the caller
37671 of Exim.
37672
37673 .cindex "authentication" "logging"
37674 .cindex "AUTH" "logging"
37675 For all messages, the P field specifies the protocol used to receive the
37676 message. This is the value that is stored in &$received_protocol$&. In the case
37677 of incoming SMTP messages, the value indicates whether or not any SMTP
37678 extensions (ESMTP), encryption, or authentication were used. If the SMTP
37679 session was encrypted, there is an additional X field that records the cipher
37680 suite that was used.
37681
37682 .cindex log protocol
37683 The protocol is set to &"esmtpsa"& or &"esmtpa"& for messages received from
37684 hosts that have authenticated themselves using the SMTP AUTH command. The first
37685 value is used when the SMTP connection was encrypted (&"secure"&). In this case
37686 there is an additional item A= followed by the name of the authenticator that
37687 was used. If an authenticated identification was set up by the authenticator's
37688 &%server_set_id%& option, this is logged too, separated by a colon from the
37689 authenticator name.
37690
37691 .cindex "size" "of message"
37692 The id field records the existing message id, if present. The size of the
37693 received message is given by the S field. When the message is delivered,
37694 headers may be removed or added, so that the size of delivered copies of the
37695 message may not correspond with this value (and indeed may be different to each
37696 other).
37697
37698 The &%log_selector%& option can be used to request the logging of additional
37699 data when a message is received. See section &<<SECTlogselector>>& below.
37700
37701
37702
37703 .section "Logging deliveries" "SECID252"
37704 .cindex "log" "delivery line"
37705 The format of the single-line entry in the main log that is written for every
37706 delivery is shown in one of the examples below, for local and remote
37707 deliveries, respectively. Each example has been split into multiple lines in order
37708 to fit it on the page:
37709 .code
37710 2002-10-31 08:59:13 16ZCW1-0005MB-00 => marv
37711   <marv@hitch.fict.example> R=localuser T=local_delivery
37712 2002-10-31 09:00:10 16ZCW1-0005MB-00 =>
37713   monk@holistic.fict.example R=dnslookup T=remote_smtp
37714   H=holistic.fict.example [192.168.234.234]
37715 .endd
37716 For ordinary local deliveries, the original address is given in angle brackets
37717 after the final delivery address, which might be a pipe or a file. If
37718 intermediate address(es) exist between the original and the final address, the
37719 last of these is given in parentheses after the final address. The R and T
37720 fields record the router and transport that were used to process the address.
37721
37722 If SMTP AUTH was used for the delivery there is an additional item A=
37723 followed by the name of the authenticator that was used.
37724 If an authenticated identification was set up by the authenticator's &%client_set_id%&
37725 option, this is logged too, separated by a colon from the authenticator name.
37726
37727 If a shadow transport was run after a successful local delivery, the log line
37728 for the successful delivery has an item added on the end, of the form
37729 .display
37730 &`ST=<`&&'shadow transport name'&&`>`&
37731 .endd
37732 If the shadow transport did not succeed, the error message is put in
37733 parentheses afterwards.
37734
37735 .cindex "asterisk" "after IP address"
37736 When more than one address is included in a single delivery (for example, two
37737 SMTP RCPT commands in one transaction) the second and subsequent addresses are
37738 flagged with &`->`& instead of &`=>`&. When two or more messages are delivered
37739 down a single SMTP connection, an asterisk follows the IP address in the log
37740 lines for the second and subsequent messages.
37741 When two or more messages are delivered down a single TLS connection, the
37742 DNS and some TLS-related information logged for the first message delivered
37743 will not be present in the log lines for the second and subsequent messages.
37744 TLS cipher information is still available.
37745
37746 .cindex "delivery" "cutthrough; logging"
37747 .cindex "cutthrough" "logging"
37748 When delivery is done in cutthrough mode it is flagged with &`>>`& and the log
37749 line precedes the reception line, since cutthrough waits for a possible
37750 rejection from the destination in case it can reject the sourced item.
37751
37752 The generation of a reply message by a filter file gets logged as a
37753 &"delivery"& to the addressee, preceded by &">"&.
37754
37755 The &%log_selector%& option can be used to request the logging of additional
37756 data when a message is delivered. See section &<<SECTlogselector>>& below.
37757
37758
37759 .section "Discarded deliveries" "SECID253"
37760 .cindex "discarded messages"
37761 .cindex "message" "discarded"
37762 .cindex "delivery" "discarded; logging"
37763 When a message is discarded as a result of the command &"seen finish"& being
37764 obeyed in a filter file which generates no deliveries, a log entry of the form
37765 .code
37766 2002-12-10 00:50:49 16auJc-0001UB-00 => discarded
37767   <low.club@bridge.example> R=userforward
37768 .endd
37769 is written, to record why no deliveries are logged. When a message is discarded
37770 because it is aliased to &":blackhole:"& the log line is like this:
37771 .code
37772 1999-03-02 09:44:33 10HmaX-0005vi-00 => :blackhole:
37773   <hole@nowhere.example> R=blackhole_router
37774 .endd
37775
37776
37777 .section "Deferred deliveries" "SECID254"
37778 When a delivery is deferred, a line of the following form is logged:
37779 .code
37780 2002-12-19 16:20:23 16aiQz-0002Q5-00 == marvin@endrest.example
37781   R=dnslookup T=smtp defer (146): Connection refused
37782 .endd
37783 In the case of remote deliveries, the error is the one that was given for the
37784 last IP address that was tried. Details of individual SMTP failures are also
37785 written to the log, so the above line would be preceded by something like
37786 .code
37787 2002-12-19 16:20:23 16aiQz-0002Q5-00 Failed to connect to
37788   mail1.endrest.example [192.168.239.239]: Connection refused
37789 .endd
37790 When a deferred address is skipped because its retry time has not been reached,
37791 a message is written to the log, but this can be suppressed by setting an
37792 appropriate value in &%log_selector%&.
37793
37794
37795
37796 .section "Delivery failures" "SECID255"
37797 .cindex "delivery" "failure; logging"
37798 If a delivery fails because an address cannot be routed, a line of the
37799 following form is logged:
37800 .code
37801 1995-12-19 16:20:23 0tRiQz-0002Q5-00 ** jim@trek99.example
37802   <jim@trek99.example>: unknown mail domain
37803 .endd
37804 If a delivery fails at transport time, the router and transport are shown, and
37805 the response from the remote host is included, as in this example:
37806 .code
37807 2002-07-11 07:14:17 17SXDU-000189-00 ** ace400@pb.example
37808   R=dnslookup T=remote_smtp: SMTP error from remote mailer
37809   after pipelined RCPT TO:<ace400@pb.example>: host
37810   pbmail3.py.example [192.168.63.111]: 553 5.3.0
37811   <ace400@pb.example>...Addressee unknown
37812 .endd
37813 The word &"pipelined"& indicates that the SMTP PIPELINING extension was being
37814 used. See &%hosts_avoid_esmtp%& in the &(smtp)& transport for a way of
37815 disabling PIPELINING. The log lines for all forms of delivery failure are
37816 flagged with &`**`&.
37817
37818
37819
37820 .section "Fake deliveries" "SECID256"
37821 .cindex "delivery" "fake; logging"
37822 If a delivery does not actually take place because the &%-N%& option has been
37823 used to suppress it, a normal delivery line is written to the log, except that
37824 &"=>"& is replaced by &"*>"&.
37825
37826
37827
37828 .section "Completion" "SECID257"
37829 A line of the form
37830 .code
37831 2002-10-31 09:00:11 16ZCW1-0005MB-00 Completed
37832 .endd
37833 is written to the main log when a message is about to be removed from the spool
37834 at the end of its processing.
37835
37836
37837
37838
37839 .section "Summary of Fields in Log Lines" "SECID258"
37840 .cindex "log" "summary of fields"
37841 A summary of the field identifiers that are used in log lines is shown in
37842 the following table:
37843 .display
37844 &`A   `&        authenticator name (and optional id and sender)
37845 &`C   `&        SMTP confirmation on delivery
37846 &`    `&        command list for &"no mail in SMTP session"&
37847 &`CV  `&        certificate verification status
37848 &`D   `&        duration of &"no mail in SMTP session"&
37849 &`DKIM`&        domain verified in incoming message
37850 &`DN  `&        distinguished name from peer certificate
37851 &`DS  `&        DNSSEC secured lookups
37852 &`DT  `&        on &`=>`&, &'=='& and &'**'& lines: time taken for, or to attempt, a delivery
37853 &`F   `&        sender address (on delivery lines)
37854 &`H   `&        host name and IP address
37855 &`I   `&        local interface used
37856 &`id  `&        message id (from header) for incoming message
37857 &`K   `&        CHUNKING extension used
37858 &`L   `&        on &`<=`& and &`=>`& lines: PIPELINING extension used
37859 &`M8S `&        8BITMIME status for incoming message
37860 &`P   `&        on &`<=`& lines: protocol used
37861 &`    `&        on &`=>`& and &`**`& lines: return path
37862 &`PRDR`&        PRDR extension used
37863 &`PRX `&        on &`<=`& and &`=>`& lines: proxy address
37864 &`Q   `&        alternate queue name
37865 &`QT  `&        on &`=>`& lines: time spent on queue so far
37866 &`    `&        on &"Completed"& lines: time spent on queue
37867 &`R   `&        on &`<=`& lines: reference for local bounce
37868 &`    `&        on &`=>`&  &`>>`& &`**`& and &`==`& lines: router name
37869 &`RT  `&        on &`<=`& lines: time taken for reception
37870 &`S   `&        size of message in bytes
37871 &`SNI `&        server name indication from TLS client hello
37872 &`ST  `&        shadow transport name
37873 &`T   `&        on &`<=`& lines: message subject (topic)
37874 &`TFO `&        connection took advantage of TCP Fast Open
37875 &`    `&        on &`=>`& &`**`& and &`==`& lines: transport name
37876 &`U   `&        local user or RFC 1413 identity
37877 &`X   `&        TLS cipher suite
37878 .endd
37879
37880
37881 .section "Other log entries" "SECID259"
37882 Various other types of log entry are written from time to time. Most should be
37883 self-explanatory. Among the more common are:
37884
37885 .ilist
37886 .cindex "retry" "time not reached"
37887 &'retry time not reached'&&~&~An address previously suffered a temporary error
37888 during routing or local delivery, and the time to retry has not yet arrived.
37889 This message is not written to an individual message log file unless it happens
37890 during the first delivery attempt.
37891 .next
37892 &'retry time not reached for any host'&&~&~An address previously suffered
37893 temporary errors during remote delivery, and the retry time has not yet arrived
37894 for any of the hosts to which it is routed.
37895 .next
37896 .cindex "spool directory" "file locked"
37897 &'spool file locked'&&~&~An attempt to deliver a message cannot proceed because
37898 some other Exim process is already working on the message. This can be quite
37899 common if queue running processes are started at frequent intervals. The
37900 &'exiwhat'& utility script can be used to find out what Exim processes are
37901 doing.
37902 .next
37903 .cindex "error" "ignored"
37904 &'error ignored'&&~&~There are several circumstances that give rise to this
37905 message:
37906 .olist
37907 Exim failed to deliver a bounce message whose age was greater than
37908 &%ignore_bounce_errors_after%&. The bounce was discarded.
37909 .next
37910 A filter file set up a delivery using the &"noerror"& option, and the delivery
37911 failed. The delivery was discarded.
37912 .next
37913 A delivery set up by a router configured with
37914 . ==== As this is a nested list, any displays it contains must be indented
37915 . ==== as otherwise they are too far to the left.
37916 .code
37917     errors_to = <>
37918 .endd
37919 failed. The delivery was discarded.
37920 .endlist olist
37921 .next
37922 .cindex DKIM "log line"
37923 &'DKIM: d='&&~&~Verbose results of a DKIM verification attempt, if enabled for
37924 logging and the message has a DKIM signature header.
37925 .endlist ilist
37926
37927
37928
37929
37930
37931 .section "Reducing or increasing what is logged" "SECTlogselector"
37932 .cindex "log" "selectors"
37933 By setting the &%log_selector%& global option, you can disable some of Exim's
37934 default logging, or you can request additional logging. The value of
37935 &%log_selector%& is made up of names preceded by plus or minus characters. For
37936 example:
37937 .code
37938 log_selector = +arguments -retry_defer
37939 .endd
37940 The list of optional log items is in the following table, with the default
37941 selection marked by asterisks:
37942 .display
37943 &` 8bitmime                   `&  received 8BITMIME status
37944 &`*acl_warn_skipped           `&  skipped &%warn%& statement in ACL
37945 &` address_rewrite            `&  address rewriting
37946 &` all_parents                `&  all parents in => lines
37947 &` arguments                  `&  command line arguments
37948 &`*connection_reject          `&  connection rejections
37949 &`*delay_delivery             `&  immediate delivery delayed
37950 &` deliver_time               `&  time taken to attempt delivery
37951 &` delivery_size              `&  add &`S=`&&'nnn'& to => lines
37952 &`*dkim                       `&  DKIM verified domain on <= lines
37953 &` dkim_verbose               `&  separate full DKIM verification result line, per signature
37954 &`*dnslist_defer              `&  defers of DNS list (aka RBL) lookups
37955 &` dnssec                     `&  DNSSEC secured lookups
37956 &`*etrn                       `&  ETRN commands
37957 &`*host_lookup_failed         `&  as it says
37958 &` ident_timeout              `&  timeout for ident connection
37959 &` incoming_interface         `&  local interface on <= and => lines
37960 &` incoming_port              `&  remote port on <= lines
37961 &`*lost_incoming_connection   `&  as it says (includes timeouts)
37962 &` millisec                   `&  millisecond timestamps and RT,QT,DT,D times
37963 &`*msg_id                     `&  on <= lines, Message-ID: header value
37964 &` msg_id_created             `&  on <= lines, Message-ID: header value when one had to be added
37965 &` outgoing_interface         `&  local interface on => lines
37966 &` outgoing_port              `&  add remote port to => lines
37967 &`*queue_run                  `&  start and end queue runs
37968 &` queue_time                 `&  time on queue for one recipient
37969 &` queue_time_overall         `&  time on queue for whole message
37970 &` pid                        `&  Exim process id
37971 &` pipelining                 `&  PIPELINING use, on <= and => lines
37972 &` proxy                      `&  proxy address on <= and => lines
37973 &` receive_time               `&  time taken to receive message
37974 &` received_recipients        `&  recipients on <= lines
37975 &` received_sender            `&  sender on <= lines
37976 &`*rejected_header            `&  header contents on reject log
37977 &`*retry_defer                `&  &"retry time not reached"&
37978 &` return_path_on_delivery    `&  put return path on => and ** lines
37979 &` sender_on_delivery         `&  add sender to => lines
37980 &`*sender_verify_fail         `&  sender verification failures
37981 &`*size_reject                `&  rejection because too big
37982 &`*skip_delivery              `&  delivery skipped in a queue run
37983 &`*smtp_confirmation          `&  SMTP confirmation on => lines
37984 &` smtp_connection            `&  incoming SMTP connections
37985 &` smtp_incomplete_transaction`&  incomplete SMTP transactions
37986 &` smtp_mailauth              `&  AUTH argument to MAIL commands
37987 &` smtp_no_mail               `&  session with no MAIL commands
37988 &` smtp_protocol_error        `&  SMTP protocol errors
37989 &` smtp_syntax_error          `&  SMTP syntax errors
37990 &` subject                    `&  contents of &'Subject:'& on <= lines
37991 &`*tls_certificate_verified   `&  certificate verification status
37992 &`*tls_cipher                 `&  TLS cipher suite on <= and => lines
37993 &` tls_peerdn                 `&  TLS peer DN on <= and => lines
37994 &` tls_sni                    `&  TLS SNI on <= lines
37995 &` unknown_in_list            `&  DNS lookup failed in list match
37996
37997 &` all                        `&  all of the above
37998 .endd
37999 See also the &%slow_lookup_log%& main configuration option,
38000 section &<<SECID99>>&
38001
38002 More details on each of these items follows:
38003
38004 .ilist
38005 .cindex "8BITMIME"
38006 .cindex "log" "8BITMIME"
38007 &%8bitmime%&: This causes Exim to log any 8BITMIME status of received messages,
38008 which may help in tracking down interoperability issues with ancient MTAs
38009 that are not 8bit clean.  This is added to the &"<="& line, tagged with
38010 &`M8S=`& and a value of &`0`&, &`7`& or &`8`&, corresponding to "not given",
38011 &`7BIT`& and &`8BITMIME`& respectively.
38012 .next
38013 .cindex "&%warn%& ACL verb" "log when skipping"
38014 &%acl_warn_skipped%&: When an ACL &%warn%& statement is skipped because one of
38015 its conditions cannot be evaluated, a log line to this effect is written if
38016 this log selector is set.
38017 .next
38018 .cindex "log" "rewriting"
38019 .cindex "rewriting" "logging"
38020 &%address_rewrite%&: This applies both to global rewrites and per-transport
38021 rewrites, but not to rewrites in filters run as an unprivileged user (because
38022 such users cannot access the log).
38023 .next
38024 .cindex "log" "full parentage"
38025 &%all_parents%&: Normally only the original and final addresses are logged on
38026 delivery lines; with this selector, intermediate parents are given in
38027 parentheses between them.
38028 .next
38029 .cindex "log" "Exim arguments"
38030 .cindex "Exim arguments, logging"
38031 &%arguments%&: This causes Exim to write the arguments with which it was called
38032 to the main log, preceded by the current working directory. This is a debugging
38033 feature, added to make it easier to find out how certain MUAs call
38034 &_/usr/sbin/sendmail_&. The logging does not happen if Exim has given up root
38035 privilege because it was called with the &%-C%& or &%-D%& options. Arguments
38036 that are empty or that contain white space are quoted. Non-printing characters
38037 are shown as escape sequences. This facility cannot log unrecognized arguments,
38038 because the arguments are checked before the configuration file is read. The
38039 only way to log such cases is to interpose a script such as &_util/logargs.sh_&
38040 between the caller and Exim.
38041 .next
38042 .cindex "log" "connection rejections"
38043 &%connection_reject%&: A log entry is written whenever an incoming SMTP
38044 connection is rejected, for whatever reason.
38045 .next
38046 .cindex "log" "delayed delivery"
38047 .cindex "delayed delivery, logging"
38048 &%delay_delivery%&: A log entry is written whenever a delivery process is not
38049 started for an incoming message because the load is too high or too many
38050 messages were received on one connection. Logging does not occur if no delivery
38051 process is started because &%queue_only%& is set or &%-odq%& was used.
38052 .next
38053 .cindex "log" "delivery duration"
38054 &%deliver_time%&: For each delivery, the amount of real time it has taken to
38055 perform the actual delivery is logged as DT=<&'time'&>, for example, &`DT=1s`&.
38056 If millisecond logging is enabled, short times will be shown with greater
38057 precision, eg. &`DT=0.304s`&.
38058 .next
38059 .cindex "log" "message size on delivery"
38060 .cindex "size" "of message"
38061 &%delivery_size%&: For each delivery, the size of message delivered is added to
38062 the &"=>"& line, tagged with S=.
38063 .next
38064 .cindex log "DKIM verification"
38065 .cindex DKIM "verification logging"
38066 &%dkim%&: For message acceptance log lines, when an DKIM signature in the header
38067 verifies successfully a tag of DKIM is added, with one of the verified domains.
38068 .next
38069 .cindex log "DKIM verification"
38070 .cindex DKIM "verification logging"
38071 &%dkim_verbose%&: A log entry is written for each attempted DKIM verification.
38072 .next
38073 .cindex "log" "dnslist defer"
38074 .cindex "DNS list" "logging defer"
38075 .cindex "black list (DNS)"
38076 &%dnslist_defer%&: A log entry is written if an attempt to look up a host in a
38077 DNS black list suffers a temporary error.
38078 .next
38079 .cindex log dnssec
38080 .cindex dnssec logging
38081 &%dnssec%&: For message acceptance and (attempted) delivery log lines, when
38082 dns lookups gave secure results a tag of DS is added.
38083 For acceptance this covers the reverse and forward lookups for host name verification.
38084 It does not cover helo-name verification.
38085 For delivery this covers the SRV, MX, A and/or AAAA lookups.
38086 .next
38087 .cindex "log" "ETRN commands"
38088 .cindex "ETRN" "logging"
38089 &%etrn%&: Every valid ETRN command that is received is logged, before the ACL
38090 is run to determine whether or not it is actually accepted. An invalid ETRN
38091 command, or one received within a message transaction is not logged by this
38092 selector (see &%smtp_syntax_error%& and &%smtp_protocol_error%&).
38093 .next
38094 .cindex "log" "host lookup failure"
38095 &%host_lookup_failed%&: When a lookup of a host's IP addresses fails to find
38096 any addresses, or when a lookup of an IP address fails to find a host name, a
38097 log line is written. This logging does not apply to direct DNS lookups when
38098 routing email addresses, but it does apply to &"byname"& lookups.
38099 .next
38100 .cindex "log" "ident timeout"
38101 .cindex "RFC 1413" "logging timeout"
38102 &%ident_timeout%&: A log line is written whenever an attempt to connect to a
38103 client's ident port times out.
38104 .next
38105 .cindex "log" "incoming interface"
38106 .cindex "log" "local interface"
38107 .cindex "log" "local address and port"
38108 .cindex "TCP/IP" "logging local address and port"
38109 .cindex "interface" "logging"
38110 &%incoming_interface%&: The interface on which a message was received is added
38111 to the &"<="& line as an IP address in square brackets, tagged by I= and
38112 followed by a colon and the port number. The local interface and port are also
38113 added to other SMTP log lines, for example, &"SMTP connection from"&, to
38114 rejection lines, and (despite the name) to outgoing &"=>"& and &"->"& lines.
38115 The latter can be disabled by turning off the &%outgoing_interface%& option.
38116 .next
38117 .cindex log "incoming proxy address"
38118 .cindex proxy "logging proxy address"
38119 .cindex "TCP/IP" "logging proxy address"
38120 &%proxy%&: The internal (closest to the system running Exim) IP address
38121 of the proxy, tagged by PRX=, on the &"<="& line for a message accepted
38122 on a proxied connection
38123 or the &"=>"& line for a message delivered on a proxied connection.
38124 See &<<SECTproxyInbound>>& for more information.
38125 .next
38126 .cindex "log" "incoming remote port"
38127 .cindex "port" "logging remote"
38128 .cindex "TCP/IP" "logging incoming remote port"
38129 .vindex "&$sender_fullhost$&"
38130 .vindex "&$sender_rcvhost$&"
38131 &%incoming_port%&: The remote port number from which a message was received is
38132 added to log entries and &'Received:'& header lines, following the IP address
38133 in square brackets, and separated from it by a colon. This is implemented by
38134 changing the value that is put in the &$sender_fullhost$& and
38135 &$sender_rcvhost$& variables. Recording the remote port number has become more
38136 important with the widening use of NAT (see RFC 2505).
38137 .next
38138 .cindex "log" "dropped connection"
38139 &%lost_incoming_connection%&: A log line is written when an incoming SMTP
38140 connection is unexpectedly dropped.
38141 .next
38142 .cindex "log" "millisecond timestamps"
38143 .cindex millisecond logging
38144 .cindex timestamps "millisecond, in logs"
38145 &%millisec%&: Timestamps have a period and three decimal places of finer granularity
38146 appended to the seconds value.
38147 .next
38148 .cindex "log" "message id"
38149 &%msg_id%&: The value of the Message-ID: header.
38150 .next
38151 &%msg_id_created%&: The value of the Message-ID: header, when one had to be created.
38152 This will be either because the message is a bounce, or was submitted locally
38153 (submission mode) without one.
38154 The field identifier will have an asterix appended: &"id*="&.
38155 .next
38156 .cindex "log" "outgoing interface"
38157 .cindex "log" "local interface"
38158 .cindex "log" "local address and port"
38159 .cindex "TCP/IP" "logging local address and port"
38160 .cindex "interface" "logging"
38161 &%outgoing_interface%&: If &%incoming_interface%& is turned on, then the
38162 interface on which a message was sent is added to delivery lines as an I= tag
38163 followed by IP address in square brackets. You can disable this by turning
38164 off the &%outgoing_interface%& option.
38165 .next
38166 .cindex "log" "outgoing remote port"
38167 .cindex "port" "logging outgoing remote"
38168 .cindex "TCP/IP" "logging outgoing remote port"
38169 &%outgoing_port%&: The remote port number is added to delivery log lines (those
38170 containing => tags) following the IP address.
38171 The local port is also added if &%incoming_interface%& and
38172 &%outgoing_interface%& are both enabled.
38173 This option is not included in the default setting, because for most ordinary
38174 configurations, the remote port number is always 25 (the SMTP port), and the
38175 local port is a random ephemeral port.
38176 .next
38177 .cindex "log" "process ids in"
38178 .cindex "pid (process id)" "in log lines"
38179 &%pid%&: The current process id is added to every log line, in square brackets,
38180 immediately after the time and date.
38181 .next
38182 .cindex log pipelining
38183 .cindex pipelining "logging outgoing"
38184 &%pipelining%&: A field is added to delivery and accept
38185 log lines when the ESMTP PIPELINING extension was used.
38186 The field is a single "L".
38187
38188 On accept lines, where PIPELINING was offered but not used by the client,
38189 the field has a minus appended.
38190
38191 .cindex "pipelining" "early connection"
38192 If Exim is built with the SUPPORT_PIPE_CONNECT build option
38193 accept "L" fields have a period appended if the feature was
38194 offered but not used, or an asterisk appended if used.
38195 Delivery "L" fields have an asterisk appended if used.
38196
38197 .next
38198 .cindex "log" "queue run"
38199 .cindex "queue runner" "logging"
38200 &%queue_run%&: The start and end of every queue run are logged.
38201 .next
38202 .cindex "log" "queue time"
38203 &%queue_time%&: The amount of time the message has been in the queue on the
38204 local host is logged as QT=<&'time'&> on delivery (&`=>`&) lines, for example,
38205 &`QT=3m45s`&. The clock starts when Exim starts to receive the message, so it
38206 includes reception time as well as the delivery time for the current address.
38207 This means that it may be longer than the difference between the arrival and
38208 delivery log line times, because the arrival log line is not written until the
38209 message has been successfully received.
38210 If millisecond logging is enabled, short times will be shown with greater
38211 precision, eg. &`QT=1.578s`&.
38212 .next
38213 &%queue_time_overall%&: The amount of time the message has been in the queue on
38214 the local host is logged as QT=<&'time'&> on &"Completed"& lines, for
38215 example, &`QT=3m45s`&. The clock starts when Exim starts to receive the
38216 message, so it includes reception time as well as the total delivery time.
38217 .next
38218 .cindex "log" "receive duration"
38219 &%receive_time%&: For each message, the amount of real time it has taken to
38220 perform the reception is logged as RT=<&'time'&>, for example, &`RT=1s`&.
38221 If millisecond logging is enabled, short times will be shown with greater
38222 precision, eg. &`RT=0.204s`&.
38223 .next
38224 .cindex "log" "recipients"
38225 &%received_recipients%&: The recipients of a message are listed in the main log
38226 as soon as the message is received. The list appears at the end of the log line
38227 that is written when a message is received, preceded by the word &"for"&. The
38228 addresses are listed after they have been qualified, but before any rewriting
38229 has taken place.
38230 Recipients that were discarded by an ACL for MAIL or RCPT do not appear
38231 in the list.
38232 .next
38233 .cindex "log" "sender reception"
38234 &%received_sender%&: The unrewritten original sender of a message is added to
38235 the end of the log line that records the message's arrival, after the word
38236 &"from"& (before the recipients if &%received_recipients%& is also set).
38237 .next
38238 .cindex "log" "header lines for rejection"
38239 &%rejected_header%&: If a message's header has been received at the time a
38240 rejection is written to the reject log, the complete header is added to the
38241 log. Header logging can be turned off individually for messages that are
38242 rejected by the &[local_scan()]& function (see section &<<SECTapiforloc>>&).
38243 .next
38244 .cindex "log" "retry defer"
38245 &%retry_defer%&: A log line is written if a delivery is deferred because a
38246 retry time has not yet been reached. However, this &"retry time not reached"&
38247 message is always omitted from individual message logs after the first delivery
38248 attempt.
38249 .next
38250 .cindex "log" "return path"
38251 &%return_path_on_delivery%&: The return path that is being transmitted with
38252 the message is included in delivery and bounce lines, using the tag P=.
38253 This is omitted if no delivery actually happens, for example, if routing fails,
38254 or if delivery is to &_/dev/null_& or to &`:blackhole:`&.
38255 .next
38256 .cindex "log" "sender on delivery"
38257 &%sender_on_delivery%&: The message's sender address is added to every delivery
38258 and bounce line, tagged by F= (for &"from"&).
38259 This is the original sender that was received with the message; it is not
38260 necessarily the same as the outgoing return path.
38261 .next
38262 .cindex "log" "sender verify failure"
38263 &%sender_verify_fail%&: If this selector is unset, the separate log line that
38264 gives details of a sender verification failure is not written. Log lines for
38265 the rejection of SMTP commands contain just &"sender verify failed"&, so some
38266 detail is lost.
38267 .next
38268 .cindex "log" "size rejection"
38269 &%size_reject%&: A log line is written whenever a message is rejected because
38270 it is too big.
38271 .next
38272 .cindex "log" "frozen messages; skipped"
38273 .cindex "frozen messages" "logging skipping"
38274 &%skip_delivery%&: A log line is written whenever a message is skipped during a
38275 queue run because it is frozen or because another process is already delivering
38276 it.
38277 .cindex "&""spool file is locked""&"
38278 The message that is written is &"spool file is locked"&.
38279 .next
38280 .cindex "log" "smtp confirmation"
38281 .cindex "SMTP" "logging confirmation"
38282 .cindex "LMTP" "logging confirmation"
38283 &%smtp_confirmation%&: The response to the final &"."& in the SMTP or LMTP dialogue for
38284 outgoing messages is added to delivery log lines in the form &`C=`&<&'text'&>.
38285 A number of MTAs (including Exim) return an identifying string in this
38286 response.
38287 .next
38288 .cindex "log" "SMTP connections"
38289 .cindex "SMTP" "logging connections"
38290 &%smtp_connection%&: A log line is written whenever an incoming SMTP connection is
38291 established or closed, unless the connection is from a host that matches
38292 &%hosts_connection_nolog%&. (In contrast, &%lost_incoming_connection%& applies
38293 only when the closure is unexpected.) This applies to connections from local
38294 processes that use &%-bs%& as well as to TCP/IP connections. If a connection is
38295 dropped in the middle of a message, a log line is always written, whether or
38296 not this selector is set, but otherwise nothing is written at the start and end
38297 of connections unless this selector is enabled.
38298
38299 For TCP/IP connections to an Exim daemon, the current number of connections is
38300 included in the log message for each new connection, but note that the count is
38301 reset if the daemon is restarted.
38302 Also, because connections are closed (and the closure is logged) in
38303 subprocesses, the count may not include connections that have been closed but
38304 whose termination the daemon has not yet noticed. Thus, while it is possible to
38305 match up the opening and closing of connections in the log, the value of the
38306 logged counts may not be entirely accurate.
38307 .next
38308 .cindex "log" "SMTP transaction; incomplete"
38309 .cindex "SMTP" "logging incomplete transactions"
38310 &%smtp_incomplete_transaction%&: When a mail transaction is aborted by
38311 RSET, QUIT, loss of connection, or otherwise, the incident is logged,
38312 and the message sender plus any accepted recipients are included in the log
38313 line. This can provide evidence of dictionary attacks.
38314 .next
38315 .cindex "log" "non-MAIL SMTP sessions"
38316 .cindex "MAIL" "logging session without"
38317 &%smtp_no_mail%&: A line is written to the main log whenever an accepted SMTP
38318 connection terminates without having issued a MAIL command. This includes both
38319 the case when the connection is dropped, and the case when QUIT is used. It
38320 does not include cases where the connection is rejected right at the start (by
38321 an ACL, or because there are too many connections, or whatever). These cases
38322 already have their own log lines.
38323
38324 The log line that is written contains the identity of the client in the usual
38325 way, followed by D= and a time, which records the duration of the connection.
38326 If the connection was authenticated, this fact is logged exactly as it is for
38327 an incoming message, with an A= item. If the connection was encrypted, CV=,
38328 DN=, and X= items may appear as they do for an incoming message, controlled by
38329 the same logging options.
38330
38331 Finally, if any SMTP commands were issued during the connection, a C= item
38332 is added to the line, listing the commands that were used. For example,
38333 .code
38334 C=EHLO,QUIT
38335 .endd
38336 shows that the client issued QUIT straight after EHLO. If there were fewer
38337 than 20 commands, they are all listed. If there were more than 20 commands,
38338 the last 20 are listed, preceded by &"..."&. However, with the default
38339 setting of 10 for &%smtp_accept_max_nonmail%&, the connection will in any case
38340 have been aborted before 20 non-mail commands are processed.
38341 .next
38342 &%smtp_mailauth%&: A third subfield with the authenticated sender,
38343 colon-separated, is appended to the A= item for a message arrival or delivery
38344 log line, if an AUTH argument to the SMTP MAIL command (see &<<SECTauthparamail>>&)
38345 was accepted or used.
38346 .next
38347 .cindex "log" "SMTP protocol error"
38348 .cindex "SMTP" "logging protocol error"
38349 &%smtp_protocol_error%&: A log line is written for every SMTP protocol error
38350 encountered. Exim does not have perfect detection of all protocol errors
38351 because of transmission delays and the use of pipelining. If PIPELINING has
38352 been advertised to a client, an Exim server assumes that the client will use
38353 it, and therefore it does not count &"expected"& errors (for example, RCPT
38354 received after rejecting MAIL) as protocol errors.
38355 .next
38356 .cindex "SMTP" "logging syntax errors"
38357 .cindex "SMTP" "syntax errors; logging"
38358 .cindex "SMTP" "unknown command; logging"
38359 .cindex "log" "unknown SMTP command"
38360 .cindex "log" "SMTP syntax error"
38361 &%smtp_syntax_error%&: A log line is written for every SMTP syntax error
38362 encountered. An unrecognized command is treated as a syntax error. For an
38363 external connection, the host identity is given; for an internal connection
38364 using &%-bs%& the sender identification (normally the calling user) is given.
38365 .next
38366 .cindex "log" "subject"
38367 .cindex "subject, logging"
38368 &%subject%&: The subject of the message is added to the arrival log line,
38369 preceded by &"T="& (T for &"topic"&, since S is already used for &"size"&).
38370 Any MIME &"words"& in the subject are decoded. The &%print_topbitchars%& option
38371 specifies whether characters with values greater than 127 should be logged
38372 unchanged, or whether they should be rendered as escape sequences.
38373 .next
38374 .cindex "log" "certificate verification"
38375 .cindex log DANE
38376 .cindex DANE logging
38377 &%tls_certificate_verified%&: An extra item is added to <= and => log lines
38378 when TLS is in use. The item is &`CV=yes`& if the peer's certificate was
38379 verified
38380 using a CA trust anchor,
38381 &`CA=dane`& if using a DNS trust anchor,
38382 and &`CV=no`& if not.
38383 .next
38384 .cindex "log" "TLS cipher"
38385 .cindex "TLS" "logging cipher"
38386 &%tls_cipher%&: When a message is sent or received over an encrypted
38387 connection, the cipher suite used is added to the log line, preceded by X=.
38388 .next
38389 .cindex "log" "TLS peer DN"
38390 .cindex "TLS" "logging peer DN"
38391 &%tls_peerdn%&: When a message is sent or received over an encrypted
38392 connection, and a certificate is supplied by the remote host, the peer DN is
38393 added to the log line, preceded by DN=.
38394 .next
38395 .cindex "log" "TLS SNI"
38396 .cindex "TLS" "logging SNI"
38397 &%tls_sni%&: When a message is received over an encrypted connection, and
38398 the remote host provided the Server Name Indication extension, the SNI is
38399 added to the log line, preceded by SNI=.
38400 .next
38401 .cindex "log" "DNS failure in list"
38402 &%unknown_in_list%&: This setting causes a log entry to be written when the
38403 result of a list match is failure because a DNS lookup failed.
38404 .endlist
38405
38406
38407 .section "Message log" "SECID260"
38408 .cindex "message" "log file for"
38409 .cindex "log" "message log; description of"
38410 .cindex "&_msglog_& directory"
38411 .oindex "&%preserve_message_logs%&"
38412 In addition to the general log files, Exim writes a log file for each message
38413 that it handles. The names of these per-message logs are the message ids, and
38414 they are kept in the &_msglog_& sub-directory of the spool directory. Each
38415 message log contains copies of the log lines that apply to the message. This
38416 makes it easier to inspect the status of an individual message without having
38417 to search the main log. A message log is deleted when processing of the message
38418 is complete, unless &%preserve_message_logs%& is set, but this should be used
38419 only with great care because they can fill up your disk very quickly.
38420
38421 On a heavily loaded system, it may be desirable to disable the use of
38422 per-message logs, in order to reduce disk I/O. This can be done by setting the
38423 &%message_logs%& option false.
38424 .ecindex IIDloggen
38425
38426
38427
38428
38429 . ////////////////////////////////////////////////////////////////////////////
38430 . ////////////////////////////////////////////////////////////////////////////
38431
38432 .chapter "Exim utilities" "CHAPutils"
38433 .scindex IIDutils "utilities"
38434 A number of utility scripts and programs are supplied with Exim and are
38435 described in this chapter. There is also the Exim Monitor, which is covered in
38436 the next chapter. The utilities described here are:
38437
38438 .itable none 0 0 3  7* left  15* left  40* left
38439 .irow &<<SECTfinoutwha>>&     &'exiwhat'&       &&&
38440   "list what Exim processes are doing"
38441 .irow &<<SECTgreptheque>>&    &'exiqgrep'&      "grep the queue"
38442 .irow &<<SECTsumtheque>>&     &'exiqsumm'&      "summarize the queue"
38443 .irow &<<SECTextspeinf>>&     &'exigrep'&       "search the main log"
38444 .irow &<<SECTexipick>>&       &'exipick'&       "select messages on &&&
38445                                                 various criteria"
38446 .irow &<<SECTcyclogfil>>&     &'exicyclog'&     "cycle (rotate) log files"
38447 .irow &<<SECTmailstat>>&      &'eximstats'&     &&&
38448   "extract statistics from the log"
38449 .irow &<<SECTcheckaccess>>&   &'exim_checkaccess'& &&&
38450   "check address acceptance from given IP"
38451 .irow &<<SECTdbmbuild>>&      &'exim_dbmbuild'& "build a DBM file"
38452 .irow &<<SECTfinindret>>&     &'exinext'&       "extract retry information"
38453 .irow &<<SECThindatmai>>&     &'exim_dumpdb'&   "dump a hints database"
38454 .irow &<<SECThindatmai>>&     &'exim_tidydb'&   "clean up a hints database"
38455 .irow &<<SECThindatmai>>&     &'exim_fixdb'&    "patch a hints database"
38456 .irow &<<SECTmailboxmaint>>&  &'exim_lock'&     "lock a mailbox file"
38457 .endtable
38458
38459 Another utility that might be of use to sites with many MTAs is Tom Kistner's
38460 &'exilog'&. It provides log visualizations across multiple Exim servers. See
38461 &url(https://duncanthrax.net/exilog/) for details.
38462
38463
38464
38465
38466 .section "Finding out what Exim processes are doing (exiwhat)" "SECTfinoutwha"
38467 .cindex "&'exiwhat'&"
38468 .cindex "process, querying"
38469 .cindex "SIGUSR1"
38470 On operating systems that can restart a system call after receiving a signal
38471 (most modern OS), an Exim process responds to the SIGUSR1 signal by writing
38472 a line describing what it is doing to the file &_exim-process.info_& in the
38473 Exim spool directory. The &'exiwhat'& script sends the signal to all Exim
38474 processes it can find, having first emptied the file. It then waits for one
38475 second to allow the Exim processes to react before displaying the results. In
38476 order to run &'exiwhat'& successfully you have to have sufficient privilege to
38477 send the signal to the Exim processes, so it is normally run as root.
38478
38479 &*Warning*&: This is not an efficient process. It is intended for occasional
38480 use by system administrators. It is not sensible, for example, to set up a
38481 script that sends SIGUSR1 signals to Exim processes at short intervals.
38482
38483
38484 Unfortunately, the &'ps'& command that &'exiwhat'& uses to find Exim processes
38485 varies in different operating systems. Not only are different options used,
38486 but the format of the output is different. For this reason, there are some
38487 system configuration options that configure exactly how &'exiwhat'& works. If
38488 it doesn't seem to be working for you, check the following compile-time
38489 options:
38490 .display
38491 &`EXIWHAT_PS_CMD    `& the command for running &'ps'&
38492 &`EXIWHAT_PS_ARG    `& the argument for &'ps'&
38493 &`EXIWHAT_EGREP_ARG `& the argument for &'egrep'& to select from &'ps'& output
38494 &`EXIWHAT_KILL_ARG  `& the argument for the &'kill'& command
38495 .endd
38496 An example of typical output from &'exiwhat'& is
38497 .code
38498 164 daemon: -q1h, listening on port 25
38499 10483 running queue: waiting for 0tAycK-0002ij-00 (10492)
38500 10492 delivering 0tAycK-0002ij-00 to mail.ref.example
38501   [10.19.42.42] (editor@ref.example)
38502 10592 handling incoming call from [192.168.243.242]
38503 10628 accepting a local non-SMTP message
38504 .endd
38505 The first number in the output line is the process number. The third line has
38506 been split here, in order to fit it on the page.
38507
38508
38509
38510 .section "Selective queue listing (exiqgrep)" "SECTgreptheque"
38511 .cindex "&'exiqgrep'&"
38512 .cindex "queue" "grepping"
38513 This utility is a Perl script contributed by Matt Hubbard. It runs
38514 .code
38515 exim -bpu
38516 .endd
38517 or (in case &*-a*& switch is specified)
38518 .code
38519 exim -bp
38520 .endd
38521 The &*-C*& option is used to specify an alternate &_exim.conf_& which might
38522 contain alternate exim configuration the queue management might be using.
38523
38524 to obtain a queue listing, and then greps the output to select messages
38525 that match given criteria. The following selection options are available:
38526
38527 .vlist
38528 .vitem &*-f*&&~<&'regex'&>
38529 Match the sender address using a case-insensitive search. The field that is
38530 tested is enclosed in angle brackets, so you can test for bounce messages with
38531 .code
38532 exiqgrep -f '^<>$'
38533 .endd
38534 .vitem &*-r*&&~<&'regex'&>
38535 Match a recipient address using a case-insensitive search. The field that is
38536 tested is not enclosed in angle brackets.
38537
38538 .vitem &*-s*&&~<&'regex'&>
38539 Match against the size field.
38540
38541 .vitem &*-y*&&~<&'seconds'&>
38542 Match messages that are younger than the given time.
38543
38544 .vitem &*-o*&&~<&'seconds'&>
38545 Match messages that are older than the given time.
38546
38547 .vitem &*-z*&
38548 Match only frozen messages.
38549
38550 .vitem &*-x*&
38551 Match only non-frozen messages.
38552
38553 .vitem &*-G*&&~<&'queuename'&>
38554 Match only messages in the given queue.  Without this, the default queue is searched.
38555 .endlist
38556
38557 The following options control the format of the output:
38558
38559 .vlist
38560 .vitem &*-c*&
38561 Display only the count of matching messages.
38562
38563 .vitem &*-l*&
38564 Long format &-- display the full message information as output by Exim. This is
38565 the default.
38566
38567 .vitem &*-i*&
38568 Display message ids only.
38569
38570 .vitem &*-b*&
38571 Brief format &-- one line per message.
38572
38573 .vitem &*-R*&
38574 Display messages in reverse order.
38575
38576 .vitem &*-a*&
38577 Include delivered recipients in queue listing.
38578 .endlist
38579
38580 There is one more option, &%-h%&, which outputs a list of options.
38581
38582
38583
38584 .section "Summarizing the queue (exiqsumm)" "SECTsumtheque"
38585 .cindex "&'exiqsumm'&"
38586 .cindex "queue" "summary"
38587 The &'exiqsumm'& utility is a Perl script which reads the output of &`exim
38588 -bp`& and produces a summary of the messages in the queue. Thus, you use it by
38589 running a command such as
38590 .code
38591 exim -bp | exiqsumm
38592 .endd
38593 The output consists of one line for each domain that has messages waiting for
38594 it, as in the following example:
38595 .code
38596 3   2322   74m   66m  msn.com.example
38597 .endd
38598 Each line lists the number of pending deliveries for a domain, their total
38599 volume, and the length of time that the oldest and the newest messages have
38600 been waiting. Note that the number of pending deliveries is greater than the
38601 number of messages when messages have more than one recipient.
38602
38603 A summary line is output at the end. By default the output is sorted on the
38604 domain name, but &'exiqsumm'& has the options &%-a%& and &%-c%&, which cause
38605 the output to be sorted by oldest message and by count of messages,
38606 respectively. There are also three options that split the messages for each
38607 domain into two or more subcounts: &%-b%& separates bounce messages, &%-f%&
38608 separates frozen messages, and &%-s%& separates messages according to their
38609 sender.
38610
38611 The output of &'exim -bp'& contains the original addresses in the message, so
38612 this also applies to the output from &'exiqsumm'&. No domains from addresses
38613 generated by aliasing or forwarding are included (unless the &%one_time%&
38614 option of the &(redirect)& router has been used to convert them into &"top
38615 level"& addresses).
38616
38617
38618
38619
38620 .section "Extracting specific information from the log (exigrep)" &&&
38621          "SECTextspeinf"
38622 .cindex "&'exigrep'&"
38623 .cindex "log" "extracts; grepping for"
38624 The &'exigrep'& utility is a Perl script that searches one or more main log
38625 files for entries that match a given pattern. When it finds a match, it
38626 extracts all the log entries for the relevant message, not just those that
38627 match the pattern. Thus, &'exigrep'& can extract complete log entries for a
38628 given message, or all mail for a given user, or for a given host, for example.
38629 The input files can be in Exim log format or syslog format.
38630 If a matching log line is not associated with a specific message, it is
38631 included in &'exigrep'&'s output without any additional lines. The usage is:
38632 .display
38633 &`exigrep [-t<`&&'n'&&`>] [-I] [-l] [-M] [-v] <`&&'pattern'&&`> [<`&&'log file'&&`>] ...`&
38634 .endd
38635 If no log filenames are given on the command line, the standard input is read.
38636
38637 The &%-t%& argument specifies a number of seconds. It adds an additional
38638 condition for message selection. Messages that are complete are shown only if
38639 they spent more than <&'n'&> seconds in the queue.
38640
38641 By default, &'exigrep'& does case-insensitive matching. The &%-I%& option
38642 makes it case-sensitive. This may give a performance improvement when searching
38643 large log files. Without &%-I%&, the Perl pattern matches use Perl's &`/i`&
38644 option; with &%-I%& they do not. In both cases it is possible to change the
38645 case sensitivity within the pattern by using &`(?i)`& or &`(?-i)`&.
38646
38647 The &%-l%& option means &"literal"&, that is, treat all characters in the
38648 pattern as standing for themselves. Otherwise the pattern must be a Perl
38649 regular expression.
38650
38651 The &%-v%& option inverts the matching condition. That is, a line is selected
38652 if it does &'not'& match the pattern.
38653
38654 The &%-M%& options means &"related messages"&. &'exigrep'& will show messages
38655 that are generated as a result/response to a message that &'exigrep'& matched
38656 normally.
38657
38658 Example of &%-M%&:
38659 user_a sends a message to user_b, which generates a bounce back to user_b. If
38660 &'exigrep'& is used to search for &"user_a"&, only the first message will be
38661 displayed.  But if &'exigrep'& is used to search for &"user_b"&, the first and
38662 the second (bounce) message will be displayed. Using &%-M%& with &'exigrep'&
38663 when searching for &"user_a"& will show both messages since the bounce is
38664 &"related"& to or a &"result"& of the first message that was found by the
38665 search term.
38666
38667 If the location of a &'zcat'& command is known from the definition of
38668 ZCAT_COMMAND in &_Local/Makefile_&, &'exigrep'& automatically passes any file
38669 whose name ends in COMPRESS_SUFFIX through &'zcat'& as it searches it.
38670 If the ZCAT_COMMAND is not executable, &'exigrep'& tries to use
38671 autodetection of some well known compression extensions.
38672
38673
38674 .section "Selecting messages by various criteria (exipick)" "SECTexipick"
38675 .cindex "&'exipick'&"
38676 John Jetmore's &'exipick'& utility is included in the Exim distribution. It
38677 lists messages from the queue according to a variety of criteria. For details
38678 of &'exipick'&'s facilities, run &'exipick'& with
38679 the &%--help%& option.
38680
38681
38682 .section "Cycling log files (exicyclog)" "SECTcyclogfil"
38683 .cindex "log" "cycling local files"
38684 .cindex "cycling logs"
38685 .cindex "&'exicyclog'&"
38686 The &'exicyclog'& script can be used to cycle (rotate) &'mainlog'& and
38687 &'rejectlog'& files. This is not necessary if only syslog is being used, or if
38688 you are using log files with datestamps in their names (see section
38689 &<<SECTdatlogfil>>&). Some operating systems have their own standard mechanisms
38690 for log cycling, and these can be used instead of &'exicyclog'& if preferred.
38691 There are two command line options for &'exicyclog'&:
38692 .ilist
38693 &%-k%& <&'count'&> specifies the number of log files to keep, overriding the
38694 default that is set when Exim is built. The default default is 10.
38695 .next
38696 &%-l%& <&'path'&> specifies the log file path, in the same format as Exim's
38697 &%log_file_path%& option (for example, &`/var/log/exim_%slog`&), again
38698 overriding the script's default, which is to find the setting from Exim's
38699 configuration.
38700 .endlist
38701
38702 Each time &'exicyclog'& is run the filenames get &"shuffled down"& by one. If
38703 the main log filename is &_mainlog_& (the default) then when &'exicyclog'& is
38704 run &_mainlog_& becomes &_mainlog.01_&, the previous &_mainlog.01_& becomes
38705 &_mainlog.02_& and so on, up to the limit that is set in the script or by the
38706 &%-k%& option. Log files whose numbers exceed the limit are discarded. Reject
38707 logs are handled similarly.
38708
38709 If the limit is greater than 99, the script uses 3-digit numbers such as
38710 &_mainlog.001_&, &_mainlog.002_&, etc. If you change from a number less than 99
38711 to one that is greater, or &'vice versa'&, you will have to fix the names of
38712 any existing log files.
38713
38714 If no &_mainlog_& file exists, the script does nothing. Files that &"drop off"&
38715 the end are deleted. All files with numbers greater than 01 are compressed,
38716 using a compression command which is configured by the COMPRESS_COMMAND
38717 setting in &_Local/Makefile_&. It is usual to run &'exicyclog'& daily from a
38718 root &%crontab%& entry of the form
38719 .code
38720 1 0 * * * su exim -c /usr/exim/bin/exicyclog
38721 .endd
38722 assuming you have used the name &"exim"& for the Exim user. You can run
38723 &'exicyclog'& as root if you wish, but there is no need.
38724
38725
38726
38727 .section "Mail statistics (eximstats)" "SECTmailstat"
38728 .cindex "statistics"
38729 .cindex "&'eximstats'&"
38730 A Perl script called &'eximstats'& is provided for extracting statistical
38731 information from log files. The output is either plain text, or HTML.
38732 . --- 2018-09-07: LogReport's Lire appears to be dead; website is a Yahoo Japan
38733 . --- 404 error and everything else points to that.
38734
38735 The &'eximstats'& script has been hacked about quite a bit over time. The
38736 latest version is the result of some extensive revision by Steve Campbell. A
38737 lot of information is given by default, but there are options for suppressing
38738 various parts of it. Following any options, the arguments to the script are a
38739 list of files, which should be main log files. For example:
38740 .code
38741 eximstats -nr /var/spool/exim/log/mainlog.01
38742 .endd
38743 By default, &'eximstats'& extracts information about the number and volume of
38744 messages received from or delivered to various hosts. The information is sorted
38745 both by message count and by volume, and the top fifty hosts in each category
38746 are listed on the standard output. Similar information, based on email
38747 addresses or domains instead of hosts can be requested by means of various
38748 options. For messages delivered and received locally, similar statistics are
38749 also produced per user.
38750
38751 The output also includes total counts and statistics about delivery errors, and
38752 histograms showing the number of messages received and deliveries made in each
38753 hour of the day. A delivery with more than one address in its envelope (for
38754 example, an SMTP transaction with more than one RCPT command) is counted
38755 as a single delivery by &'eximstats'&.
38756
38757 Though normally more deliveries than receipts are reported (as messages may
38758 have multiple recipients), it is possible for &'eximstats'& to report more
38759 messages received than delivered, even though the queue is empty at the start
38760 and end of the period in question. If an incoming message contains no valid
38761 recipients, no deliveries are recorded for it. A bounce message is handled as
38762 an entirely separate message.
38763
38764 &'eximstats'& always outputs a grand total summary giving the volume and number
38765 of messages received and deliveries made, and the number of hosts involved in
38766 each case. It also outputs the number of messages that were delayed (that is,
38767 not completely delivered at the first attempt), and the number that had at
38768 least one address that failed.
38769
38770 The remainder of the output is in sections that can be independently disabled
38771 or modified by various options. It consists of a summary of deliveries by
38772 transport, histograms of messages received and delivered per time interval
38773 (default per hour), information about the time messages spent in the queue,
38774 a list of relayed messages, lists of the top fifty sending hosts, local
38775 senders, destination hosts, and destination local users by count and by volume,
38776 and a list of delivery errors that occurred.
38777
38778 The relay information lists messages that were actually relayed, that is, they
38779 came from a remote host and were directly delivered to some other remote host,
38780 without being processed (for example, for aliasing or forwarding) locally.
38781
38782 There are quite a few options for &'eximstats'& to control exactly what it
38783 outputs. These are documented in the Perl script itself, and can be extracted
38784 by running the command &(perldoc)& on the script. For example:
38785 .code
38786 perldoc /usr/exim/bin/eximstats
38787 .endd
38788
38789 .section "Checking access policy (exim_checkaccess)" "SECTcheckaccess"
38790 .cindex "&'exim_checkaccess'&"
38791 .cindex "policy control" "checking access"
38792 .cindex "checking access"
38793 The &%-bh%& command line argument allows you to run a fake SMTP session with
38794 debugging output, in order to check what Exim is doing when it is applying
38795 policy controls to incoming SMTP mail. However, not everybody is sufficiently
38796 familiar with the SMTP protocol to be able to make full use of &%-bh%&, and
38797 sometimes you just want to answer the question &"Does this address have
38798 access?"& without bothering with any further details.
38799
38800 The &'exim_checkaccess'& utility is a &"packaged"& version of &%-bh%&. It takes
38801 two arguments, an IP address and an email address:
38802 .code
38803 exim_checkaccess 10.9.8.7 A.User@a.domain.example
38804 .endd
38805 The utility runs a call to Exim with the &%-bh%& option, to test whether the
38806 given email address would be accepted in a RCPT command in a TCP/IP
38807 connection from the host with the given IP address. The output of the utility
38808 is either the word &"accepted"&, or the SMTP error response, for example:
38809 .code
38810 Rejected:
38811 550 Relay not permitted
38812 .endd
38813 When running this test, the utility uses &`<>`& as the envelope sender address
38814 for the MAIL command, but you can change this by providing additional
38815 options. These are passed directly to the Exim command. For example, to specify
38816 that the test is to be run with the sender address &'himself@there.example'&
38817 you can use:
38818 .code
38819 exim_checkaccess 10.9.8.7 A.User@a.domain.example \
38820                  -f himself@there.example
38821 .endd
38822 Note that these additional Exim command line items must be given after the two
38823 mandatory arguments.
38824
38825 Because the &%exim_checkaccess%& uses &%-bh%&, it does not perform callouts
38826 while running its checks. You can run checks that include callouts by using
38827 &%-bhc%&, but this is not yet available in a &"packaged"& form.
38828
38829
38830
38831 .section "Making DBM files (exim_dbmbuild)" "SECTdbmbuild"
38832 .cindex "DBM" "building dbm files"
38833 .cindex "building DBM files"
38834 .cindex "&'exim_dbmbuild'&"
38835 .cindex "lower casing"
38836 .cindex "binary zero" "in lookup key"
38837 The &'exim_dbmbuild'& program reads an input file containing keys and data in
38838 the format used by the &(lsearch)& lookup (see section
38839 &<<SECTsinglekeylookups>>&). It writes a DBM file using the lower-cased alias
38840 names as keys and the remainder of the information as data. The lower-casing
38841 can be prevented by calling the program with the &%-nolc%& option.
38842
38843 A terminating zero is included as part of the key string. This is expected by
38844 the &(dbm)& lookup type. However, if the option &%-nozero%& is given,
38845 &'exim_dbmbuild'& creates files without terminating zeroes in either the key
38846 strings or the data strings. The &(dbmnz)& lookup type can be used with such
38847 files.
38848
38849 The program requires two arguments: the name of the input file (which can be a
38850 single hyphen to indicate the standard input), and the name of the output file.
38851 It creates the output under a temporary name, and then renames it if all went
38852 well.
38853
38854 .cindex "USE_DB"
38855 If the native DB interface is in use (USE_DB is set in a compile-time
38856 configuration file &-- this is common in free versions of Unix) the two
38857 filenames must be different, because in this mode the Berkeley DB functions
38858 create a single output file using exactly the name given. For example,
38859 .code
38860 exim_dbmbuild /etc/aliases /etc/aliases.db
38861 .endd
38862 reads the system alias file and creates a DBM version of it in
38863 &_/etc/aliases.db_&.
38864
38865 In systems that use the &'ndbm'& routines (mostly proprietary versions of
38866 Unix), two files are used, with the suffixes &_.dir_& and &_.pag_&. In this
38867 environment, the suffixes are added to the second argument of
38868 &'exim_dbmbuild'&, so it can be the same as the first. This is also the case
38869 when the Berkeley functions are used in compatibility mode (though this is not
38870 recommended), because in that case it adds a &_.db_& suffix to the filename.
38871
38872 If a duplicate key is encountered, the program outputs a warning, and when it
38873 finishes, its return code is 1 rather than zero, unless the &%-noduperr%&
38874 option is used. By default, only the first of a set of duplicates is used &--
38875 this makes it compatible with &(lsearch)& lookups. There is an option
38876 &%-lastdup%& which causes it to use the data for the last duplicate instead.
38877 There is also an option &%-nowarn%&, which stops it listing duplicate keys to
38878 &%stderr%&. For other errors, where it doesn't actually make a new file, the
38879 return code is 2.
38880
38881
38882
38883
38884 .section "Finding individual retry times (exinext)" "SECTfinindret"
38885 .cindex "retry" "times"
38886 .cindex "&'exinext'&"
38887 A utility called &'exinext'& (mostly a Perl script) provides the ability to
38888 fish specific information out of the retry database. Given a mail domain (or a
38889 complete address), it looks up the hosts for that domain, and outputs any retry
38890 information for the hosts or for the domain. At present, the retry information
38891 is obtained by running &'exim_dumpdb'& (see below) and post-processing the
38892 output. For example:
38893 .code
38894 $ exinext piglet@milne.fict.example
38895 kanga.milne.example:192.168.8.1 error 146: Connection refused
38896   first failed: 21-Feb-1996 14:57:34
38897   last tried:   21-Feb-1996 14:57:34
38898   next try at:  21-Feb-1996 15:02:34
38899 roo.milne.example:192.168.8.3 error 146: Connection refused
38900   first failed: 20-Jan-1996 13:12:08
38901   last tried:   21-Feb-1996 11:42:03
38902   next try at:  21-Feb-1996 19:42:03
38903   past final cutoff time
38904 .endd
38905 You can also give &'exinext'& a local part, without a domain, and it
38906 will give any retry information for that local part in your default domain.
38907 A message id can be used to obtain retry information pertaining to a specific
38908 message. This exists only when an attempt to deliver a message to a remote host
38909 suffers a message-specific error (see section &<<SECToutSMTPerr>>&).
38910 &'exinext'& is not particularly efficient, but then it is not expected to be
38911 run very often.
38912
38913 The &'exinext'& utility calls Exim to find out information such as the location
38914 of the spool directory. The utility has &%-C%& and &%-D%& options, which are
38915 passed on to the &'exim'& commands. The first specifies an alternate Exim
38916 configuration file, and the second sets macros for use within the configuration
38917 file. These features are mainly to help in testing, but might also be useful in
38918 environments where more than one configuration file is in use.
38919
38920
38921
38922 .section "Hints database maintenance" "SECThindatmai"
38923 .cindex "hints database" "maintenance"
38924 .cindex "maintaining Exim's hints database"
38925 Three utility programs are provided for maintaining the DBM files that Exim
38926 uses to contain its delivery hint information. Each program requires two
38927 arguments. The first specifies the name of Exim's spool directory, and the
38928 second is the name of the database it is to operate on. These are as follows:
38929
38930 .ilist
38931 &'retry'&: the database of retry information
38932 .next
38933 &'wait-'&<&'transport name'&>: databases of information about messages waiting
38934 for remote hosts
38935 .next
38936 &'callout'&: the callout cache
38937 .next
38938 &'ratelimit'&: the data for implementing the ratelimit ACL condition
38939 .next
38940 &'misc'&: other hints data
38941 .endlist
38942
38943 The &'misc'& database is used for
38944
38945 .ilist
38946 Serializing ETRN runs (when &%smtp_etrn_serialize%& is set)
38947 .next
38948 Serializing delivery to a specific host (when &%serialize_hosts%& is set in an
38949 &(smtp)& transport)
38950 .next
38951 Limiting the concurrency of specific transports (when &%max_parallel%& is set
38952 in a transport)
38953 .endlist
38954
38955
38956
38957 .section "exim_dumpdb" "SECID261"
38958 .cindex "&'exim_dumpdb'&"
38959 The entire contents of a database are written to the standard output by the
38960 &'exim_dumpdb'& program, which has no options or arguments other than the
38961 spool and database names. For example, to dump the retry database:
38962 .code
38963 exim_dumpdb /var/spool/exim retry
38964 .endd
38965 Two lines of output are produced for each entry:
38966 .code
38967 T:mail.ref.example:192.168.242.242 146 77 Connection refused
38968 31-Oct-1995 12:00:12 02-Nov-1995 12:21:39 02-Nov-1995 20:21:39 *
38969 .endd
38970 The first item on the first line is the key of the record. It starts with one
38971 of the letters R, or T, depending on whether it refers to a routing or
38972 transport retry. For a local delivery, the next part is the local address; for
38973 a remote delivery it is the name of the remote host, followed by its failing IP
38974 address (unless &%retry_include_ip_address%& is set false on the &(smtp)&
38975 transport). If the remote port is not the standard one (port 25), it is added
38976 to the IP address. Then there follows an error code, an additional error code,
38977 and a textual description of the error.
38978
38979 The three times on the second line are the time of first failure, the time of
38980 the last delivery attempt, and the computed time for the next attempt. The line
38981 ends with an asterisk if the cutoff time for the last retry rule has been
38982 exceeded.
38983
38984 Each output line from &'exim_dumpdb'& for the &'wait-xxx'& databases
38985 consists of a host name followed by a list of ids for messages that are or were
38986 waiting to be delivered to that host. If there are a very large number for any
38987 one host, continuation records, with a sequence number added to the host name,
38988 may be seen. The data in these records is often out of date, because a message
38989 may be routed to several alternative hosts, and Exim makes no effort to keep
38990 cross-references.
38991
38992
38993
38994 .section "exim_tidydb" "SECID262"
38995 .cindex "&'exim_tidydb'&"
38996 The &'exim_tidydb'& utility program is used to tidy up the contents of a hints
38997 database. If run with no options, it removes all records that are more than 30
38998 days old. The age is calculated from the date and time that the record was last
38999 updated. Note that, in the case of the retry database, it is &'not'& the time
39000 since the first delivery failure. Information about a host that has been down
39001 for more than 30 days will remain in the database, provided that the record is
39002 updated sufficiently often.
39003
39004 The cutoff date can be altered by means of the &%-t%& option, which must be
39005 followed by a time. For example, to remove all records older than a week from
39006 the retry database:
39007 .code
39008 exim_tidydb -t 7d /var/spool/exim retry
39009 .endd
39010 Both the &'wait-xxx'& and &'retry'& databases contain items that involve
39011 message ids. In the former these appear as data in records keyed by host &--
39012 they were messages that were waiting for that host &-- and in the latter they
39013 are the keys for retry information for messages that have suffered certain
39014 types of error. When &'exim_tidydb'& is run, a check is made to ensure that
39015 message ids in database records are those of messages that are still on the
39016 queue. Message ids for messages that no longer exist are removed from
39017 &'wait-xxx'& records, and if this leaves any records empty, they are deleted.
39018 For the &'retry'& database, records whose keys are non-existent message ids are
39019 removed. The &'exim_tidydb'& utility outputs comments on the standard output
39020 whenever it removes information from the database.
39021
39022 Certain records are automatically removed by Exim when they are no longer
39023 needed, but others are not. For example, if all the MX hosts for a domain are
39024 down, a retry record is created for each one. If the primary MX host comes back
39025 first, its record is removed when Exim successfully delivers to it, but the
39026 records for the others remain because Exim has not tried to use those hosts.
39027
39028 It is important, therefore, to run &'exim_tidydb'& periodically on all the
39029 hints databases. You should do this at a quiet time of day, because it requires
39030 a database to be locked (and therefore inaccessible to Exim) while it does its
39031 work. Removing records from a DBM file does not normally make the file smaller,
39032 but all the common DBM libraries are able to re-use the space that is released.
39033 After an initial phase of increasing in size, the databases normally reach a
39034 point at which they no longer get any bigger, as long as they are regularly
39035 tidied.
39036
39037 &*Warning*&: If you never run &'exim_tidydb'&, the space used by the hints
39038 databases is likely to keep on increasing.
39039
39040
39041
39042
39043 .section "exim_fixdb" "SECID263"
39044 .cindex "&'exim_fixdb'&"
39045 The &'exim_fixdb'& program is a utility for interactively modifying databases.
39046 Its main use is for testing Exim, but it might also be occasionally useful for
39047 getting round problems in a live system. It has no options, and its interface
39048 is somewhat crude. On entry, it prompts for input with a right angle-bracket. A
39049 key of a database record can then be entered, and the data for that record is
39050 displayed.
39051
39052 If &"d"& is typed at the next prompt, the entire record is deleted. For all
39053 except the &'retry'& database, that is the only operation that can be carried
39054 out. For the &'retry'& database, each field is output preceded by a number, and
39055 data for individual fields can be changed by typing the field number followed
39056 by new data, for example:
39057 .code
39058 > 4 951102:1000
39059 .endd
39060 resets the time of the next delivery attempt. Time values are given as a
39061 sequence of digit pairs for year, month, day, hour, and minute. Colons can be
39062 used as optional separators.
39063
39064
39065
39066
39067 .section "Mailbox maintenance (exim_lock)" "SECTmailboxmaint"
39068 .cindex "mailbox" "maintenance"
39069 .cindex "&'exim_lock'&"
39070 .cindex "locking mailboxes"
39071 The &'exim_lock'& utility locks a mailbox file using the same algorithm as
39072 Exim. For a discussion of locking issues, see section &<<SECTopappend>>&.
39073 &'Exim_lock'& can be used to prevent any modification of a mailbox by Exim or
39074 a user agent while investigating a problem. The utility requires the name of
39075 the file as its first argument. If the locking is successful, the second
39076 argument is run as a command (using C's &[system()]& function); if there is no
39077 second argument, the value of the SHELL environment variable is used; if this
39078 is unset or empty, &_/bin/sh_& is run. When the command finishes, the mailbox
39079 is unlocked and the utility ends. The following options are available:
39080
39081 .vlist
39082 .vitem &%-fcntl%&
39083 Use &[fcntl()]& locking on the open mailbox.
39084
39085 .vitem &%-flock%&
39086 Use &[flock()]& locking on the open mailbox, provided the operating system
39087 supports it.
39088
39089 .vitem &%-interval%&
39090 This must be followed by a number, which is a number of seconds; it sets the
39091 interval to sleep between retries (default 3).
39092
39093 .vitem &%-lockfile%&
39094 Create a lock file before opening the mailbox.
39095
39096 .vitem &%-mbx%&
39097 Lock the mailbox using MBX rules.
39098
39099 .vitem &%-q%&
39100 Suppress verification output.
39101
39102 .vitem &%-retries%&
39103 This must be followed by a number; it sets the number of times to try to get
39104 the lock (default 10).
39105
39106 .vitem &%-restore_time%&
39107 This option causes &%exim_lock%& to restore the modified and read times to the
39108 locked file before exiting. This allows you to access a locked mailbox (for
39109 example, to take a backup copy) without disturbing the times that the user
39110 subsequently sees.
39111
39112 .vitem &%-timeout%&
39113 This must be followed by a number, which is a number of seconds; it sets a
39114 timeout to be used with a blocking &[fcntl()]& lock. If it is not set (the
39115 default), a non-blocking call is used.
39116
39117 .vitem &%-v%&
39118 Generate verbose output.
39119 .endlist
39120
39121 If none of &%-fcntl%&, &%-flock%&, &%-lockfile%& or &%-mbx%& are given, the
39122 default is to create a lock file and also to use &[fcntl()]& locking on the
39123 mailbox, which is the same as Exim's default. The use of &%-flock%& or
39124 &%-fcntl%& requires that the file be writeable; the use of &%-lockfile%&
39125 requires that the directory containing the file be writeable. Locking by lock
39126 file does not last forever; Exim assumes that a lock file is expired if it is
39127 more than 30 minutes old.
39128
39129 The &%-mbx%& option can be used with either or both of &%-fcntl%& or
39130 &%-flock%&. It assumes &%-fcntl%& by default. MBX locking causes a shared lock
39131 to be taken out on the open mailbox, and an exclusive lock on the file
39132 &_/tmp/.n.m_& where &'n'& and &'m'& are the device number and inode
39133 number of the mailbox file. When the locking is released, if an exclusive lock
39134 can be obtained for the mailbox, the file in &_/tmp_& is deleted.
39135
39136 The default output contains verification of the locking that takes place. The
39137 &%-v%& option causes some additional information to be given. The &%-q%& option
39138 suppresses all output except error messages.
39139
39140 A command such as
39141 .code
39142 exim_lock /var/spool/mail/spqr
39143 .endd
39144 runs an interactive shell while the file is locked, whereas
39145 .display
39146 &`exim_lock -q /var/spool/mail/spqr <<End`&
39147 <&'some commands'&>
39148 &`End`&
39149 .endd
39150 runs a specific non-interactive sequence of commands while the file is locked,
39151 suppressing all verification output. A single command can be run by a command
39152 such as
39153 .code
39154 exim_lock -q /var/spool/mail/spqr \
39155   "cp /var/spool/mail/spqr /some/where"
39156 .endd
39157 Note that if a command is supplied, it must be entirely contained within the
39158 second argument &-- hence the quotes.
39159 .ecindex IIDutils
39160
39161
39162 . ////////////////////////////////////////////////////////////////////////////
39163 . ////////////////////////////////////////////////////////////////////////////
39164
39165 .chapter "The Exim monitor" "CHAPeximon"
39166 .scindex IIDeximon "Exim monitor" "description"
39167 .cindex "X-windows"
39168 .cindex "&'eximon'&"
39169 .cindex "Local/eximon.conf"
39170 .cindex "&_exim_monitor/EDITME_&"
39171 The Exim monitor is an application which displays in an X window information
39172 about the state of Exim's queue and what Exim is doing. An admin user can
39173 perform certain operations on messages from this GUI interface; however all
39174 such facilities are also available from the command line, and indeed, the
39175 monitor itself makes use of the command line to perform any actions requested.
39176
39177
39178
39179 .section "Running the monitor" "SECID264"
39180 The monitor is started by running the script called &'eximon'&. This is a shell
39181 script that sets up a number of environment variables, and then runs the
39182 binary called &_eximon.bin_&. The default appearance of the monitor window can
39183 be changed by editing the &_Local/eximon.conf_& file created by editing
39184 &_exim_monitor/EDITME_&. Comments in that file describe what the various
39185 parameters are for.
39186
39187 The parameters that get built into the &'eximon'& script can be overridden for
39188 a particular invocation by setting up environment variables of the same names,
39189 preceded by &`EXIMON_`&. For example, a shell command such as
39190 .code
39191 EXIMON_LOG_DEPTH=400 eximon
39192 .endd
39193 (in a Bourne-compatible shell) runs &'eximon'& with an overriding setting of
39194 the LOG_DEPTH parameter. If EXIMON_LOG_FILE_PATH is set in the environment, it
39195 overrides the Exim log file configuration. This makes it possible to have
39196 &'eximon'& tailing log data that is written to syslog, provided that MAIL.INFO
39197 syslog messages are routed to a file on the local host.
39198
39199 X resources can be used to change the appearance of the window in the normal
39200 way. For example, a resource setting of the form
39201 .code
39202 Eximon*background: gray94
39203 .endd
39204 changes the colour of the background to light grey rather than white. The
39205 stripcharts are drawn with both the data lines and the reference lines in
39206 black. This means that the reference lines are not visible when on top of the
39207 data. However, their colour can be changed by setting a resource called
39208 &"highlight"& (an odd name, but that's what the Athena stripchart widget uses).
39209 For example, if your X server is running Unix, you could set up lighter
39210 reference lines in the stripcharts by obeying
39211 .code
39212 xrdb -merge <<End
39213 Eximon*highlight: gray
39214 End
39215 .endd
39216 .cindex "admin user"
39217 In order to see the contents of messages in the queue, and to operate on them,
39218 &'eximon'& must either be run as root or by an admin user.
39219
39220 The command-line parameters of &'eximon'& are passed to &_eximon.bin_& and may
39221 contain X11 resource parameters interpreted by the X11 library.  In addition,
39222 if the first parameter starts with the string "gdb" then it is removed and the
39223 binary is invoked under gdb (the parameter is used as the gdb command-name, so
39224 versioned variants of gdb can be invoked).
39225
39226 The monitor's window is divided into three parts. The first contains one or
39227 more stripcharts and two action buttons, the second contains a &"tail"& of the
39228 main log file, and the third is a display of the queue of messages awaiting
39229 delivery, with two more action buttons. The following sections describe these
39230 different parts of the display.
39231
39232
39233
39234
39235 .section "The stripcharts" "SECID265"
39236 .cindex "stripchart"
39237 The first stripchart is always a count of messages in the queue. Its name can
39238 be configured by setting QUEUE_STRIPCHART_NAME in the
39239 &_Local/eximon.conf_& file. The remaining stripcharts are defined in the
39240 configuration script by regular expression matches on log file entries, making
39241 it possible to display, for example, counts of messages delivered to certain
39242 hosts or using certain transports. The supplied defaults display counts of
39243 received and delivered messages, and of local and SMTP deliveries. The default
39244 period between stripchart updates is one minute; this can be adjusted by a
39245 parameter in the &_Local/eximon.conf_& file.
39246
39247 The stripchart displays rescale themselves automatically as the value they are
39248 displaying changes. There are always 10 horizontal lines in each chart; the
39249 title string indicates the value of each division when it is greater than one.
39250 For example, &"x2"& means that each division represents a value of 2.
39251
39252 It is also possible to have a stripchart which shows the percentage fullness of
39253 a particular disk partition, which is useful when local deliveries are confined
39254 to a single partition.
39255
39256 .cindex "&%statvfs%& function"
39257 This relies on the availability of the &[statvfs()]& function or equivalent in
39258 the operating system. Most, but not all versions of Unix that support Exim have
39259 this. For this particular stripchart, the top of the chart always represents
39260 100%, and the scale is given as &"x10%"&. This chart is configured by setting
39261 SIZE_STRIPCHART and (optionally) SIZE_STRIPCHART_NAME in the
39262 &_Local/eximon.conf_& file.
39263
39264
39265
39266
39267 .section "Main action buttons" "SECID266"
39268 .cindex "size" "of monitor window"
39269 .cindex "Exim monitor" "window size"
39270 .cindex "window size"
39271 Below the stripcharts there is an action button for quitting the monitor. Next
39272 to this is another button marked &"Size"&. They are placed here so that
39273 shrinking the window to its default minimum size leaves just the queue count
39274 stripchart and these two buttons visible. Pressing the &"Size"& button causes
39275 the window to expand to its maximum size, unless it is already at the maximum,
39276 in which case it is reduced to its minimum.
39277
39278 When expanding to the maximum, if the window cannot be fully seen where it
39279 currently is, it is moved back to where it was the last time it was at full
39280 size. When it is expanding from its minimum size, the old position is
39281 remembered, and next time it is reduced to the minimum it is moved back there.
39282
39283 The idea is that you can keep a reduced window just showing one or two
39284 stripcharts at a convenient place on your screen, easily expand it to show
39285 the full window when required, and just as easily put it back to what it was.
39286 The idea is copied from what the &'twm'& window manager does for its
39287 &'f.fullzoom'& action. The minimum size of the window can be changed by setting
39288 the MIN_HEIGHT and MIN_WIDTH values in &_Local/eximon.conf_&.
39289
39290 Normally, the monitor starts up with the window at its full size, but it can be
39291 built so that it starts up with the window at its smallest size, by setting
39292 START_SMALL=yes in &_Local/eximon.conf_&.
39293
39294
39295
39296 .section "The log display" "SECID267"
39297 .cindex "log" "tail of; in monitor"
39298 The second section of the window is an area in which a display of the tail of
39299 the main log is maintained.
39300 To save space on the screen, the timestamp on each log line is shortened by
39301 removing the date and, if &%log_timezone%& is set, the timezone.
39302 The log tail is not available when the only destination for logging data is
39303 syslog, unless the syslog lines are routed to a local file whose name is passed
39304 to &'eximon'& via the EXIMON_LOG_FILE_PATH environment variable.
39305
39306 The log sub-window has a scroll bar at its lefthand side which can be used to
39307 move back to look at earlier text, and the up and down arrow keys also have a
39308 scrolling effect. The amount of log that is kept depends on the setting of
39309 LOG_BUFFER in &_Local/eximon.conf_&, which specifies the amount of memory
39310 to use. When this is full, the earlier 50% of data is discarded &-- this is
39311 much more efficient than throwing it away line by line. The sub-window also has
39312 a horizontal scroll bar for accessing the ends of long log lines. This is the
39313 only means of horizontal scrolling; the right and left arrow keys are not
39314 available. Text can be cut from this part of the window using the mouse in the
39315 normal way. The size of this subwindow is controlled by parameters in the
39316 configuration file &_Local/eximon.conf_&.
39317
39318 Searches of the text in the log window can be carried out by means of the ^R
39319 and ^S keystrokes, which default to a reverse and a forward search,
39320 respectively. The search covers only the text that is displayed in the window.
39321 It cannot go further back up the log.
39322
39323 The point from which the search starts is indicated by a caret marker. This is
39324 normally at the end of the text in the window, but can be positioned explicitly
39325 by pointing and clicking with the left mouse button, and is moved automatically
39326 by a successful search. If new text arrives in the window when it is scrolled
39327 back, the caret remains where it is, but if the window is not scrolled back,
39328 the caret is moved to the end of the new text.
39329
39330 Pressing ^R or ^S pops up a window into which the search text can be typed.
39331 There are buttons for selecting forward or reverse searching, for carrying out
39332 the search, and for cancelling. If the &"Search"& button is pressed, the search
39333 happens and the window remains so that further searches can be done. If the
39334 &"Return"& key is pressed, a single search is done and the window is closed. If
39335 ^C is typed the search is cancelled.
39336
39337 The searching facility is implemented using the facilities of the Athena text
39338 widget. By default this pops up a window containing both &"search"& and
39339 &"replace"& options. In order to suppress the unwanted &"replace"& portion for
39340 eximon, a modified version of the &%TextPop%& widget is distributed with Exim.
39341 However, the linkers in BSDI and HP-UX seem unable to handle an externally
39342 provided version of &%TextPop%& when the remaining parts of the text widget
39343 come from the standard libraries. The compile-time option EXIMON_TEXTPOP can be
39344 unset to cut out the modified &%TextPop%&, making it possible to build Eximon
39345 on these systems, at the expense of having unwanted items in the search popup
39346 window.
39347
39348
39349
39350 .section "The queue display" "SECID268"
39351 .cindex "queue" "display in monitor"
39352 The bottom section of the monitor window contains a list of all messages that
39353 are in the queue, which includes those currently being received or delivered,
39354 as well as those awaiting delivery. The size of this subwindow is controlled by
39355 parameters in the configuration file &_Local/eximon.conf_&, and the frequency
39356 at which it is updated is controlled by another parameter in the same file &--
39357 the default is 5 minutes, since queue scans can be quite expensive. However,
39358 there is an &"Update"& action button just above the display which can be used
39359 to force an update of the queue display at any time.
39360
39361 When a host is down for some time, a lot of pending mail can build up for it,
39362 and this can make it hard to deal with other messages in the queue. To help
39363 with this situation there is a button next to &"Update"& called &"Hide"&. If
39364 pressed, a dialogue box called &"Hide addresses ending with"& is put up. If you
39365 type anything in here and press &"Return"&, the text is added to a chain of
39366 such texts, and if every undelivered address in a message matches at least one
39367 of the texts, the message is not displayed.
39368
39369 If there is an address that does not match any of the texts, all the addresses
39370 are displayed as normal. The matching happens on the ends of addresses so, for
39371 example, &'cam.ac.uk'& specifies all addresses in Cambridge, while
39372 &'xxx@foo.com.example'& specifies just one specific address. When any hiding
39373 has been set up, a button called &"Unhide"& is displayed. If pressed, it
39374 cancels all hiding. Also, to ensure that hidden messages do not get forgotten,
39375 a hide request is automatically cancelled after one hour.
39376
39377 While the dialogue box is displayed, you can't press any buttons or do anything
39378 else to the monitor window. For this reason, if you want to cut text from the
39379 queue display to use in the dialogue box, you have to do the cutting before
39380 pressing the &"Hide"& button.
39381
39382 The queue display contains, for each unhidden queued message, the length of
39383 time it has been in the queue, the size of the message, the message id, the
39384 message sender, and the first undelivered recipient, all on one line. If it is
39385 a bounce message, the sender is shown as &"<>"&. If there is more than one
39386 recipient to which the message has not yet been delivered, subsequent ones are
39387 listed on additional lines, up to a maximum configured number, following which
39388 an ellipsis is displayed. Recipients that have already received the message are
39389 not shown.
39390
39391 .cindex "frozen messages" "display"
39392 If a message is frozen, an asterisk is displayed at the left-hand side.
39393
39394 The queue display has a vertical scroll bar, and can also be scrolled by means
39395 of the arrow keys. Text can be cut from it using the mouse in the normal way.
39396 The text searching facilities, as described above for the log window, are also
39397 available, but the caret is always moved to the end of the text when the queue
39398 display is updated.
39399
39400
39401
39402 .section "The queue menu" "SECID269"
39403 .cindex "queue" "menu in monitor"
39404 If the &%shift%& key is held down and the left button is clicked when the mouse
39405 pointer is over the text for any message, an action menu pops up, and the first
39406 line of the queue display for the message is highlighted. This does not affect
39407 any selected text.
39408
39409 If you want to use some other event for popping up the menu, you can set the
39410 MENU_EVENT parameter in &_Local/eximon.conf_& to change the default, or
39411 set EXIMON_MENU_EVENT in the environment before starting the monitor. The
39412 value set in this parameter is a standard X event description. For example, to
39413 run eximon using &%ctrl%& rather than &%shift%& you could use
39414 .code
39415 EXIMON_MENU_EVENT='Ctrl<Btn1Down>' eximon
39416 .endd
39417 The title of the menu is the message id, and it contains entries which act as
39418 follows:
39419
39420 .ilist
39421 &'message log'&: The contents of the message log for the message are displayed
39422 in a new text window.
39423 .next
39424 &'headers'&: Information from the spool file that contains the envelope
39425 information and headers is displayed in a new text window. See chapter
39426 &<<CHAPspool>>& for a description of the format of spool files.
39427 .next
39428 &'body'&: The contents of the spool file containing the body of the message are
39429 displayed in a new text window. There is a default limit of 20,000 bytes to the
39430 amount of data displayed. This can be changed by setting the BODY_MAX
39431 option at compile time, or the EXIMON_BODY_MAX option at runtime.
39432 .next
39433 &'deliver message'&: A call to Exim is made using the &%-M%& option to request
39434 delivery of the message. This causes an automatic thaw if the message is
39435 frozen. The &%-v%& option is also set, and the output from Exim is displayed in
39436 a new text window. The delivery is run in a separate process, to avoid holding
39437 up the monitor while the delivery proceeds.
39438 .next
39439 &'freeze message'&: A call to Exim is made using the &%-Mf%& option to request
39440 that the message be frozen.
39441 .next
39442 .cindex "thawing messages"
39443 .cindex "unfreezing messages"
39444 .cindex "frozen messages" "thawing"
39445 &'thaw message'&: A call to Exim is made using the &%-Mt%& option to request
39446 that the message be thawed.
39447 .next
39448 .cindex "delivery" "forcing failure"
39449 &'give up on msg'&: A call to Exim is made using the &%-Mg%& option to request
39450 that Exim gives up trying to deliver the message. A bounce message is generated
39451 for any remaining undelivered addresses.
39452 .next
39453 &'remove message'&: A call to Exim is made using the &%-Mrm%& option to request
39454 that the message be deleted from the system without generating a bounce
39455 message.
39456 .next
39457 &'add recipient'&: A dialog box is displayed into which a recipient address can
39458 be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
39459 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
39460 Otherwise it must be entered as a fully qualified address. Pressing RETURN
39461 causes a call to Exim to be made using the &%-Mar%& option to request that an
39462 additional recipient be added to the message, unless the entry box is empty, in
39463 which case no action is taken.
39464 .next
39465 &'mark delivered'&: A dialog box is displayed into which a recipient address
39466 can be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
39467 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
39468 Otherwise it must be entered as a fully qualified address. Pressing RETURN
39469 causes a call to Exim to be made using the &%-Mmd%& option to mark the given
39470 recipient address as already delivered, unless the entry box is empty, in which
39471 case no action is taken.
39472 .next
39473 &'mark all delivered'&: A call to Exim is made using the &%-Mmad%& option to
39474 mark all recipient addresses as already delivered.
39475 .next
39476 &'edit sender'&: A dialog box is displayed initialized with the current
39477 sender's address. Pressing RETURN causes a call to Exim to be made using the
39478 &%-Mes%& option to replace the sender address, unless the entry box is empty,
39479 in which case no action is taken. If you want to set an empty sender (as in
39480 bounce messages), you must specify it as &"<>"&. Otherwise, if the address is
39481 not qualified and the QUALIFY_DOMAIN parameter is set in &_Local/eximon.conf_&,
39482 the address is qualified with that domain.
39483 .endlist
39484
39485 When a delivery is forced, a window showing the &%-v%& output is displayed. In
39486 other cases when a call to Exim is made, if there is any output from Exim (in
39487 particular, if the command fails) a window containing the command and the
39488 output is displayed. Otherwise, the results of the action are normally apparent
39489 from the log and queue displays. However, if you set ACTION_OUTPUT=yes in
39490 &_Local/eximon.conf_&, a window showing the Exim command is always opened, even
39491 if no output is generated.
39492
39493 The queue display is automatically updated for actions such as freezing and
39494 thawing, unless ACTION_QUEUE_UPDATE=no has been set in
39495 &_Local/eximon.conf_&. In this case the &"Update"& button has to be used to
39496 force an update of the display after one of these actions.
39497
39498 In any text window that is displayed as result of a menu action, the normal
39499 cut-and-paste facility is available, and searching can be carried out using ^R
39500 and ^S, as described above for the log tail window.
39501 .ecindex IIDeximon
39502
39503
39504
39505
39506
39507 . ////////////////////////////////////////////////////////////////////////////
39508 . ////////////////////////////////////////////////////////////////////////////
39509
39510 .chapter "Security considerations" "CHAPsecurity"
39511 .scindex IIDsecurcon "security" "discussion of"
39512 This chapter discusses a number of issues concerned with security, some of
39513 which are also covered in other parts of this manual.
39514
39515 For reasons that this author does not understand, some people have promoted
39516 Exim as a &"particularly secure"& mailer. Perhaps it is because of the
39517 existence of this chapter in the documentation. However, the intent of the
39518 chapter is simply to describe the way Exim works in relation to certain
39519 security concerns, not to make any specific claims about the effectiveness of
39520 its security as compared with other MTAs.
39521
39522 What follows is a description of the way Exim is supposed to be. Best efforts
39523 have been made to try to ensure that the code agrees with the theory, but an
39524 absence of bugs can never be guaranteed. Any that are reported will get fixed
39525 as soon as possible.
39526
39527
39528 .section "Building a more &""hardened""& Exim" "SECID286"
39529 .cindex "security" "build-time features"
39530 There are a number of build-time options that can be set in &_Local/Makefile_&
39531 to create Exim binaries that are &"harder"& to attack, in particular by a rogue
39532 Exim administrator who does not have the root password, or by someone who has
39533 penetrated the Exim (but not the root) account. These options are as follows:
39534
39535 .ilist
39536 ALT_CONFIG_PREFIX can be set to a string that is required to match the
39537 start of any filenames used with the &%-C%& option. When it is set, these
39538 filenames are also not allowed to contain the sequence &"/../"&. (However, if
39539 the value of the &%-C%& option is identical to the value of CONFIGURE_FILE in
39540 &_Local/Makefile_&, Exim ignores &%-C%& and proceeds as usual.) There is no
39541 default setting for &%ALT_CONFIG_PREFIX%&.
39542
39543 If the permitted configuration files are confined to a directory to
39544 which only root has access, this guards against someone who has broken
39545 into the Exim account from running a privileged Exim with an arbitrary
39546 configuration file, and using it to break into other accounts.
39547 .next
39548
39549 If a non-trusted configuration file (i.e. not the default configuration file
39550 or one which is trusted by virtue of being listed in the TRUSTED_CONFIG_LIST
39551 file) is specified with &%-C%&, or if macros are given with &%-D%& (but see
39552 the next item), then root privilege is retained only if the caller of Exim is
39553 root. This locks out the possibility of testing a configuration using &%-C%&
39554 right through message reception and delivery, even if the caller is root. The
39555 reception works, but by that time, Exim is running as the Exim user, so when
39556 it re-execs to regain privilege for the delivery, the use of &%-C%& causes
39557 privilege to be lost. However, root can test reception and delivery using two
39558 separate commands.
39559
39560 .next
39561 The WHITELIST_D_MACROS build option declares some macros to be safe to override
39562 with &%-D%& if the real uid is one of root, the Exim run-time user or the
39563 CONFIGURE_OWNER, if defined.  The potential impact of this option is limited by
39564 requiring the run-time value supplied to &%-D%& to match a regex that errs on
39565 the restrictive side.  Requiring build-time selection of safe macros is onerous
39566 but this option is intended solely as a transition mechanism to permit
39567 previously-working configurations to continue to work after release 4.73.
39568 .next
39569 If DISABLE_D_OPTION is defined, the use of the &%-D%& command line option
39570 is disabled.
39571 .next
39572 FIXED_NEVER_USERS can be set to a colon-separated list of users that are
39573 never to be used for any deliveries. This is like the &%never_users%& runtime
39574 option, but it cannot be overridden; the runtime option adds additional users
39575 to the list. The default setting is &"root"&; this prevents a non-root user who
39576 is permitted to modify the runtime file from using Exim as a way to get root.
39577 .endlist
39578
39579
39580
39581 .section "Root privilege" "SECID270"
39582 .cindex "setuid"
39583 .cindex "root privilege"
39584 The Exim binary is normally setuid to root, which means that it gains root
39585 privilege (runs as root) when it starts execution. In some special cases (for
39586 example, when the daemon is not in use and there are no local deliveries), it
39587 may be possible to run Exim setuid to some user other than root. This is
39588 discussed in the next section. However, in most installations, root privilege
39589 is required for two things:
39590
39591 .ilist
39592 To set up a socket connected to the standard SMTP port (25) when initialising
39593 the listening daemon. If Exim is run from &'inetd'&, this privileged action is
39594 not required.
39595 .next
39596 To be able to change uid and gid in order to read users' &_.forward_& files and
39597 perform local deliveries as the receiving user or as specified in the
39598 configuration.
39599 .endlist
39600
39601 It is not necessary to be root to do any of the other things Exim does, such as
39602 receiving messages and delivering them externally over SMTP, and it is
39603 obviously more secure if Exim does not run as root except when necessary.
39604 For this reason, a user and group for Exim to use must be defined in
39605 &_Local/Makefile_&. These are known as &"the Exim user"& and &"the Exim
39606 group"&. Their values can be changed by the runtime configuration, though this
39607 is not recommended. Often a user called &'exim'& is used, but some sites use
39608 &'mail'& or another user name altogether.
39609
39610 Exim uses &[setuid()]& whenever it gives up root privilege. This is a permanent
39611 abdication; the process cannot regain root afterwards. Prior to release 4.00,
39612 &[seteuid()]& was used in some circumstances, but this is no longer the case.
39613
39614 After a new Exim process has interpreted its command line options, it changes
39615 uid and gid in the following cases:
39616
39617 .ilist
39618 .oindex "&%-C%&"
39619 .oindex "&%-D%&"
39620 If the &%-C%& option is used to specify an alternate configuration file, or if
39621 the &%-D%& option is used to define macro values for the configuration, and the
39622 calling process is not running as root, the uid and gid are changed to those of
39623 the calling process.
39624 However, if DISABLE_D_OPTION is defined in &_Local/Makefile_&, the &%-D%&
39625 option may not be used at all.
39626 If WHITELIST_D_MACROS is defined in &_Local/Makefile_&, then some macro values
39627 can be supplied if the calling process is running as root, the Exim run-time
39628 user or CONFIGURE_OWNER, if defined.
39629 .next
39630 .oindex "&%-be%&"
39631 .oindex "&%-bf%&"
39632 .oindex "&%-bF%&"
39633 If the expansion test option (&%-be%&) or one of the filter testing options
39634 (&%-bf%& or &%-bF%&) are used, the uid and gid are changed to those of the
39635 calling process.
39636 .next
39637 If the process is not a daemon process or a queue runner process or a delivery
39638 process or a process for testing address routing (started with &%-bt%&), the
39639 uid and gid are changed to the Exim user and group. This means that Exim always
39640 runs under its own uid and gid when receiving messages. This also applies when
39641 testing address verification
39642 .oindex "&%-bv%&"
39643 .oindex "&%-bh%&"
39644 (the &%-bv%& option) and testing incoming message policy controls (the &%-bh%&
39645 option).
39646 .next
39647 For a daemon, queue runner, delivery, or address testing process, the uid
39648 remains as root at this stage, but the gid is changed to the Exim group.
39649 .endlist
39650
39651 The processes that initially retain root privilege behave as follows:
39652
39653 .ilist
39654 A daemon process changes the gid to the Exim group and the uid to the Exim
39655 user after setting up one or more listening sockets. The &[initgroups()]&
39656 function is called, so that if the Exim user is in any additional groups, they
39657 will be used during message reception.
39658 .next
39659 A queue runner process retains root privilege throughout its execution. Its
39660 job is to fork a controlled sequence of delivery processes.
39661 .next
39662 A delivery process retains root privilege throughout most of its execution,
39663 but any actual deliveries (that is, the transports themselves) are run in
39664 subprocesses which always change to a non-root uid and gid. For local
39665 deliveries this is typically the uid and gid of the owner of the mailbox; for
39666 remote deliveries, the Exim uid and gid are used. Once all the delivery
39667 subprocesses have been run, a delivery process changes to the Exim uid and gid
39668 while doing post-delivery tidying up such as updating the retry database and
39669 generating bounce and warning messages.
39670
39671 While the recipient addresses in a message are being routed, the delivery
39672 process runs as root. However, if a user's filter file has to be processed,
39673 this is done in a subprocess that runs under the individual user's uid and
39674 gid. A system filter is run as root unless &%system_filter_user%& is set.
39675 .next
39676 A process that is testing addresses (the &%-bt%& option) runs as root so that
39677 the routing is done in the same environment as a message delivery.
39678 .endlist
39679
39680
39681
39682
39683 .section "Running Exim without privilege" "SECTrunexiwitpri"
39684 .cindex "privilege, running without"
39685 .cindex "unprivileged running"
39686 .cindex "root privilege" "running without"
39687 Some installations like to run Exim in an unprivileged state for more of its
39688 operation, for added security. Support for this mode of operation is provided
39689 by the global option &%deliver_drop_privilege%&. When this is set, the uid and
39690 gid are changed to the Exim user and group at the start of a delivery process
39691 (and also queue runner and address testing processes). This means that address
39692 routing is no longer run as root, and the deliveries themselves cannot change
39693 to any other uid.
39694
39695 .cindex SIGHUP
39696 .cindex "daemon" "restarting"
39697 Leaving the binary setuid to root, but setting &%deliver_drop_privilege%& means
39698 that the daemon can still be started in the usual way, and it can respond
39699 correctly to SIGHUP because the re-invocation regains root privilege.
39700
39701 An alternative approach is to make Exim setuid to the Exim user and also setgid
39702 to the Exim group. If you do this, the daemon must be started from a root
39703 process. (Calling Exim from a root process makes it behave in the way it does
39704 when it is setuid root.) However, the daemon cannot restart itself after a
39705 SIGHUP signal because it cannot regain privilege.
39706
39707 It is still useful to set &%deliver_drop_privilege%& in this case, because it
39708 stops Exim from trying to re-invoke itself to do a delivery after a message has
39709 been received. Such a re-invocation is a waste of resources because it has no
39710 effect.
39711
39712 If restarting the daemon is not an issue (for example, if &%mua_wrapper%& is
39713 set, or &'inetd'& is being used instead of a daemon), having the binary setuid
39714 to the Exim user seems a clean approach, but there is one complication:
39715
39716 In this style of operation, Exim is running with the real uid and gid set to
39717 those of the calling process, and the effective uid/gid set to Exim's values.
39718 Ideally, any association with the calling process' uid/gid should be dropped,
39719 that is, the real uid/gid should be reset to the effective values so as to
39720 discard any privileges that the caller may have. While some operating systems
39721 have a function that permits this action for a non-root effective uid, quite a
39722 number of them do not. Because of this lack of standardization, Exim does not
39723 address this problem at this time.
39724
39725 For this reason, the recommended approach for &"mostly unprivileged"& running
39726 is to keep the Exim binary setuid to root, and to set
39727 &%deliver_drop_privilege%&. This also has the advantage of allowing a daemon to
39728 be used in the most straightforward way.
39729
39730 If you configure Exim not to run delivery processes as root, there are a
39731 number of restrictions on what you can do:
39732
39733 .ilist
39734 You can deliver only as the Exim user/group. You should  explicitly use the
39735 &%user%& and &%group%& options to override routers or local transports that
39736 normally deliver as the recipient. This makes sure that configurations that
39737 work in this mode function the same way in normal mode. Any implicit or
39738 explicit specification of another user causes an error.
39739 .next
39740 Use of &_.forward_& files is severely restricted, such that it is usually
39741 not worthwhile to include them in the configuration.
39742 .next
39743 Users who wish to use &_.forward_& would have to make their home directory and
39744 the file itself accessible to the Exim user. Pipe and append-to-file entries,
39745 and their equivalents in Exim filters, cannot be used. While they could be
39746 enabled in the Exim user's name, that would be insecure and not very useful.
39747 .next
39748 Unless the local user mailboxes are all owned by the Exim user (possible in
39749 some POP3 or IMAP-only environments):
39750
39751 .olist
39752 They must be owned by the Exim group and be writeable by that group. This
39753 implies you must set &%mode%& in the appendfile configuration, as well as the
39754 mode of the mailbox files themselves.
39755 .next
39756 You must set &%no_check_owner%&, since most or all of the files will not be
39757 owned by the Exim user.
39758 .next
39759 You must set &%file_must_exist%&, because Exim cannot set the owner correctly
39760 on a newly created mailbox when unprivileged. This also implies that new
39761 mailboxes need to be created manually.
39762 .endlist olist
39763 .endlist ilist
39764
39765
39766 These restrictions severely restrict what can be done in local deliveries.
39767 However, there are no restrictions on remote deliveries. If you are running a
39768 gateway host that does no local deliveries, setting &%deliver_drop_privilege%&
39769 gives more security at essentially no cost.
39770
39771 If you are using the &%mua_wrapper%& facility (see chapter
39772 &<<CHAPnonqueueing>>&), &%deliver_drop_privilege%& is forced to be true.
39773
39774
39775
39776
39777 .section "Delivering to local files" "SECID271"
39778 Full details of the checks applied by &(appendfile)& before it writes to a file
39779 are given in chapter &<<CHAPappendfile>>&.
39780
39781
39782
39783 .section "Running local commands" "SECTsecconslocalcmds"
39784 .cindex "security" "local commands"
39785 .cindex "security" "command injection attacks"
39786 There are a number of ways in which an administrator can configure Exim to run
39787 commands based upon received, untrustworthy, data. Further, in some
39788 configurations a user who can control a &_.forward_& file can also arrange to
39789 run commands. Configuration to check includes, but is not limited to:
39790
39791 .ilist
39792 Use of &%use_shell%& in the pipe transport: various forms of shell command
39793 injection may be possible with this option present. It is dangerous and should
39794 be used only with considerable caution. Consider constraints which whitelist
39795 allowed characters in a variable which is to be used in a pipe transport that
39796 has &%use_shell%& enabled.
39797 .next
39798 A number of options such as &%forbid_filter_run%&, &%forbid_filter_perl%&,
39799 &%forbid_filter_dlfunc%& and so forth which restrict facilities available to
39800 &_.forward_& files in a redirect router. If Exim is running on a central mail
39801 hub to which ordinary users do not have shell access, but home directories are
39802 NFS mounted (for instance) then administrators should review the list of these
39803 forbid options available, and should bear in mind that the options that may
39804 need forbidding can change as new features are added between releases.
39805 .next
39806 The &%${run...}%& expansion item does not use a shell by default, but
39807 administrators can configure use of &_/bin/sh_& as part of the command.
39808 Such invocations should be viewed with prejudicial suspicion.
39809 .next
39810 Administrators who use embedded Perl are advised to explore how Perl's
39811 taint checking might apply to their usage.
39812 .next
39813 Use of &%${expand...}%& is somewhat analogous to shell's eval builtin and
39814 administrators are well advised to view its use with suspicion, in case (for
39815 instance) it allows a local-part to contain embedded Exim directives.
39816 .next
39817 Use of &%${match_local_part...}%& and friends becomes more dangerous if
39818 Exim was built with EXPAND_LISTMATCH_RHS defined: the second string in
39819 each can reference arbitrary lists and files, rather than just being a list
39820 of opaque strings.
39821 The EXPAND_LISTMATCH_RHS option was added and set false by default because of
39822 real-world security vulnerabilities caused by its use with untrustworthy data
39823 injected in, for SQL injection attacks.
39824 Consider the use of the &%inlisti%& expansion condition instead.
39825 .endlist
39826
39827
39828
39829
39830 .section "Trust in configuration data" "SECTsecconfdata"
39831 .cindex "security" "data sources"
39832 .cindex "security" "regular expressions"
39833 .cindex "regular expressions" "security"
39834 .cindex "PCRE" "security"
39835 If configuration data for Exim can come from untrustworthy sources, there
39836 are some issues to be aware of:
39837
39838 .ilist
39839 Use of &%${expand...}%& may provide a path for shell injection attacks.
39840 .next
39841 Letting untrusted data provide a regular expression is unwise.
39842 .next
39843 Using &%${match...}%& to apply a fixed regular expression against untrusted
39844 data may result in pathological behaviour within PCRE.  Be aware of what
39845 "backtracking" means and consider options for being more strict with a regular
39846 expression. Avenues to explore include limiting what can match (avoiding &`.`&
39847 when &`[a-z0-9]`& or other character class will do), use of atomic grouping and
39848 possessive quantifiers or just not using regular expressions against untrusted
39849 data.
39850 .next
39851 It can be important to correctly use &%${quote:...}%&,
39852 &%${quote_local_part:...}%& and &%${quote_%&<&'lookup-type'&>&%:...}%& expansion
39853 items to ensure that data is correctly constructed.
39854 .next
39855 Some lookups might return multiple results, even though normal usage is only
39856 expected to yield one result.
39857 .endlist
39858
39859
39860
39861
39862 .section "IPv4 source routing" "SECID272"
39863 .cindex "source routing" "in IP packets"
39864 .cindex "IP source routing"
39865 Many operating systems suppress IP source-routed packets in the kernel, but
39866 some cannot be made to do this, so Exim does its own check. It logs incoming
39867 IPv4 source-routed TCP calls, and then drops them. Things are all different in
39868 IPv6. No special checking is currently done.
39869
39870
39871
39872 .section "The VRFY, EXPN, and ETRN commands in SMTP" "SECID273"
39873 Support for these SMTP commands is disabled by default. If required, they can
39874 be enabled by defining suitable ACLs.
39875
39876
39877
39878
39879 .section "Privileged users" "SECID274"
39880 .cindex "trusted users"
39881 .cindex "admin user"
39882 .cindex "privileged user"
39883 .cindex "user" "trusted"
39884 .cindex "user" "admin"
39885 Exim recognizes two sets of users with special privileges. Trusted users are
39886 able to submit new messages to Exim locally, but supply their own sender
39887 addresses and information about a sending host. For other users submitting
39888 local messages, Exim sets up the sender address from the uid, and doesn't
39889 permit a remote host to be specified.
39890
39891 .oindex "&%-f%&"
39892 However, an untrusted user is permitted to use the &%-f%& command line option
39893 in the special form &%-f <>%& to indicate that a delivery failure for the
39894 message should not cause an error report. This affects the message's envelope,
39895 but it does not affect the &'Sender:'& header. Untrusted users may also be
39896 permitted to use specific forms of address with the &%-f%& option by setting
39897 the &%untrusted_set_sender%& option.
39898
39899 Trusted users are used to run processes that receive mail messages from some
39900 other mail domain and pass them on to Exim for delivery either locally, or over
39901 the Internet. Exim trusts a caller that is running as root, as the Exim user,
39902 as any user listed in the &%trusted_users%& configuration option, or under any
39903 group listed in the &%trusted_groups%& option.
39904
39905 Admin users are permitted to do things to the messages on Exim's queue. They
39906 can freeze or thaw messages, cause them to be returned to their senders, remove
39907 them entirely, or modify them in various ways. In addition, admin users can run
39908 the Exim monitor and see all the information it is capable of providing, which
39909 includes the contents of files on the spool.
39910
39911 .oindex "&%-M%&"
39912 .oindex "&%-q%&"
39913 By default, the use of the &%-M%& and &%-q%& options to cause Exim to attempt
39914 delivery of messages on its queue is restricted to admin users. This
39915 restriction can be relaxed by setting the &%no_prod_requires_admin%& option.
39916 Similarly, the use of &%-bp%& (and its variants) to list the contents of the
39917 queue is also restricted to admin users. This restriction can be relaxed by
39918 setting &%no_queue_list_requires_admin%&.
39919
39920 Exim recognizes an admin user if the calling process is running as root or as
39921 the Exim user or if any of the groups associated with the calling process is
39922 the Exim group. It is not necessary actually to be running under the Exim
39923 group. However, if admin users who are not root or the Exim user are to access
39924 the contents of files on the spool via the Exim monitor (which runs
39925 unprivileged), Exim must be built to allow group read access to its spool
39926 files.
39927
39928 By default, regular users are trusted to perform basic testing and
39929 introspection commands, as themselves.  This setting can be tightened by
39930 setting the &%commandline_checks_require_admin%& option.
39931 This affects most of the checking options,
39932 such as &%-be%& and anything else &%-b*%&.
39933
39934
39935 .section "Spool files" "SECID275"
39936 .cindex "spool directory" "files"
39937 Exim's spool directory and everything it contains is owned by the Exim user and
39938 set to the Exim group. The mode for spool files is defined in the
39939 &_Local/Makefile_& configuration file, and defaults to 0640. This means that
39940 any user who is a member of the Exim group can access these files.
39941
39942
39943
39944 .section "Use of argv[0]" "SECID276"
39945 Exim examines the last component of &%argv[0]%&, and if it matches one of a set
39946 of specific strings, Exim assumes certain options. For example, calling Exim
39947 with the last component of &%argv[0]%& set to &"rsmtp"& is exactly equivalent
39948 to calling it with the option &%-bS%&. There are no security implications in
39949 this.
39950
39951
39952
39953 .section "Use of %f formatting" "SECID277"
39954 The only use made of &"%f"& by Exim is in formatting load average values. These
39955 are actually stored in integer variables as 1000 times the load average.
39956 Consequently, their range is limited and so therefore is the length of the
39957 converted output.
39958
39959
39960
39961 .section "Embedded Exim path" "SECID278"
39962 Exim uses its own path name, which is embedded in the code, only when it needs
39963 to re-exec in order to regain root privilege. Therefore, it is not root when it
39964 does so. If some bug allowed the path to get overwritten, it would lead to an
39965 arbitrary program's being run as exim, not as root.
39966
39967
39968
39969 .section "Dynamic module directory" "SECTdynmoddir"
39970 Any dynamically loadable modules must be installed into the directory
39971 defined in &`LOOKUP_MODULE_DIR`& in &_Local/Makefile_& for Exim to permit
39972 loading it.
39973
39974
39975 .section "Use of sprintf()" "SECID279"
39976 .cindex "&[sprintf()]&"
39977 A large number of occurrences of &"sprintf"& in the code are actually calls to
39978 &'string_sprintf()'&, a function that returns the result in malloc'd store.
39979 The intermediate formatting is done into a large fixed buffer by a function
39980 that runs through the format string itself, and checks the length of each
39981 conversion before performing it, thus preventing buffer overruns.
39982
39983 The remaining uses of &[sprintf()]& happen in controlled circumstances where
39984 the output buffer is known to be sufficiently long to contain the converted
39985 string.
39986
39987
39988
39989 .section "Use of debug_printf() and log_write()" "SECID280"
39990 Arbitrary strings are passed to both these functions, but they do their
39991 formatting by calling the function &'string_vformat()'&, which runs through
39992 the format string itself, and checks the length of each conversion.
39993
39994
39995
39996 .section "Use of strcat() and strcpy()" "SECID281"
39997 These are used only in cases where the output buffer is known to be large
39998 enough to hold the result.
39999 .ecindex IIDsecurcon
40000
40001
40002
40003
40004 . ////////////////////////////////////////////////////////////////////////////
40005 . ////////////////////////////////////////////////////////////////////////////
40006
40007 .chapter "Format of spool files" "CHAPspool"
40008 .scindex IIDforspo1 "format" "spool files"
40009 .scindex IIDforspo2 "spool directory" "format of files"
40010 .scindex IIDforspo3 "spool files" "format of"
40011 .cindex "spool files" "editing"
40012 A message on Exim's queue consists of two files, whose names are the message id
40013 followed by -D and -H, respectively. The data portion of the message is kept in
40014 the -D file on its own. The message's envelope, status, and headers are all
40015 kept in the -H file, whose format is described in this chapter. Each of these
40016 two files contains the final component of its own name as its first line. This
40017 is insurance against disk crashes where the directory is lost but the files
40018 themselves are recoverable.
40019
40020 The file formats may be changed, or new formats added, at any release.
40021 Spool files are not intended as an interface to other programs
40022 and should not be used as such.
40023
40024 Some people are tempted into editing -D files in order to modify messages. You
40025 need to be extremely careful if you do this; it is not recommended and you are
40026 on your own if you do it. Here are some of the pitfalls:
40027
40028 .ilist
40029 You must ensure that Exim does not try to deliver the message while you are
40030 fiddling with it. The safest way is to take out a write lock on the -D file,
40031 which is what Exim itself does, using &[fcntl()]&. If you update the file in
40032 place, the lock will be retained. If you write a new file and rename it, the
40033 lock will be lost at the instant of rename.
40034 .next
40035 .vindex "&$body_linecount$&"
40036 If you change the number of lines in the file, the value of
40037 &$body_linecount$&, which is stored in the -H file, will be incorrect and can
40038 cause incomplete transmission of messages or undeliverable messages.
40039 .next
40040 If the message is in MIME format, you must take care not to break it.
40041 .next
40042 If the message is cryptographically signed, any change will invalidate the
40043 signature.
40044 .endlist
40045 All in all, modifying -D files is fraught with danger.
40046
40047 Files whose names end with -J may also be seen in the &_input_& directory (or
40048 its subdirectories when &%split_spool_directory%& is set). These are journal
40049 files, used to record addresses to which the message has been delivered during
40050 the course of a delivery attempt. If there are still undelivered recipients at
40051 the end, the -H file is updated, and the -J file is deleted. If, however, there
40052 is some kind of crash (for example, a power outage) before this happens, the -J
40053 file remains in existence. When Exim next processes the message, it notices the
40054 -J file and uses it to update the -H file before starting the next delivery
40055 attempt.
40056
40057 Files whose names end with -K or .eml may also be seen in the spool.
40058 These are temporaries used for DKIM or malware processing, when that is used.
40059 They should be tidied up by normal operations; any old ones are probably
40060 relics of crashes and can be removed.
40061
40062 .section "Format of the -H file" "SECID282"
40063 .cindex "uid (user id)" "in spool file"
40064 .cindex "gid (group id)" "in spool file"
40065 The second line of the -H file contains the login name for the uid of the
40066 process that called Exim to read the message, followed by the numerical uid and
40067 gid. For a locally generated message, this is normally the user who sent the
40068 message. For a message received over TCP/IP via the daemon, it is
40069 normally the Exim user.
40070
40071 The third line of the file contains the address of the message's sender as
40072 transmitted in the envelope, contained in angle brackets. The sender address is
40073 empty for bounce messages. For incoming SMTP mail, the sender address is given
40074 in the MAIL command. For locally generated mail, the sender address is
40075 created by Exim from the login name of the current user and the configured
40076 &%qualify_domain%&. However, this can be overridden by the &%-f%& option or a
40077 leading &"From&~"& line if the caller is trusted, or if the supplied address is
40078 &"<>"& or an address that matches &%untrusted_set_senders%&.
40079
40080 The fourth line contains two numbers. The first is the time that the message
40081 was received, in the conventional Unix form &-- the number of seconds since the
40082 start of the epoch. The second number is a count of the number of messages
40083 warning of delayed delivery that have been sent to the sender.
40084
40085 There follow a number of lines starting with a hyphen. These can appear in any
40086 order, and are omitted when not relevant:
40087
40088 .vlist
40089 .vitem "&%-acl%&&~<&'number'&>&~<&'length'&>"
40090 This item is obsolete, and is not generated from Exim release 4.61 onwards;
40091 &%-aclc%& and &%-aclm%& are used instead. However, &%-acl%& is still
40092 recognized, to provide backward compatibility. In the old format, a line of
40093 this form is present for every ACL variable that is not empty. The number
40094 identifies the variable; the &%acl_c%&&*x*& variables are numbered 0&--9 and
40095 the &%acl_m%&&*x*& variables are numbered 10&--19. The length is the length of
40096 the data string for the variable. The string itself starts at the beginning of
40097 the next line, and is followed by a newline character. It may contain internal
40098 newlines.
40099
40100 .vitem "&%-aclc%&&~<&'rest-of-name'&>&~<&'length'&>"
40101 A line of this form is present for every ACL connection variable that is
40102 defined. Note that there is a space between &%-aclc%& and the rest of the name.
40103 The length is the length of the data string for the variable. The string itself
40104 starts at the beginning of the next line, and is followed by a newline
40105 character. It may contain internal newlines.
40106
40107 .vitem "&%-aclm%&&~<&'rest-of-name'&>&~<&'length'&>"
40108 A line of this form is present for every ACL message variable that is defined.
40109 Note that there is a space between &%-aclm%& and the rest of the name. The
40110 length is the length of the data string for the variable. The string itself
40111 starts at the beginning of the next line, and is followed by a newline
40112 character. It may contain internal newlines.
40113
40114 .vitem "&%-active_hostname%&&~<&'hostname'&>"
40115 This is present if, when the message was received over SMTP, the value of
40116 &$smtp_active_hostname$& was different to the value of &$primary_hostname$&.
40117
40118 .vitem &%-allow_unqualified_recipient%&
40119 This is present if unqualified recipient addresses are permitted in header
40120 lines (to stop such addresses from being qualified if rewriting occurs at
40121 transport time). Local messages that were input using &%-bnq%& and remote
40122 messages from hosts that match &%recipient_unqualified_hosts%& set this flag.
40123
40124 .vitem &%-allow_unqualified_sender%&
40125 This is present if unqualified sender addresses are permitted in header lines
40126 (to stop such addresses from being qualified if rewriting occurs at transport
40127 time). Local messages that were input using &%-bnq%& and remote messages from
40128 hosts that match &%sender_unqualified_hosts%& set this flag.
40129
40130 .vitem "&%-auth_id%&&~<&'text'&>"
40131 The id information for a message received on an authenticated SMTP connection
40132 &-- the value of the &$authenticated_id$& variable.
40133
40134 .vitem "&%-auth_sender%&&~<&'address'&>"
40135 The address of an authenticated sender &-- the value of the
40136 &$authenticated_sender$& variable.
40137
40138 .vitem "&%-body_linecount%&&~<&'number'&>"
40139 This records the number of lines in the body of the message, and is
40140 present unless &%-spool_file_wireformat%& is.
40141
40142 .vitem "&%-body_zerocount%&&~<&'number'&>"
40143 This records the number of binary zero bytes in the body of the message, and is
40144 present if the number is greater than zero.
40145
40146 .vitem &%-deliver_firsttime%&
40147 This is written when a new message is first added to the spool. When the spool
40148 file is updated after a deferral, it is omitted.
40149
40150 .vitem "&%-frozen%&&~<&'time'&>"
40151 .cindex "frozen messages" "spool data"
40152 The message is frozen, and the freezing happened at <&'time'&>.
40153
40154 .vitem "&%-helo_name%&&~<&'text'&>"
40155 This records the host name as specified by a remote host in a HELO or EHLO
40156 command.
40157
40158 .vitem "&%-host_address%&&~<&'address'&>.<&'port'&>"
40159 This records the IP address of the host from which the message was received and
40160 the remote port number that was used. It is omitted for locally generated
40161 messages.
40162
40163 .vitem "&%-host_auth%&&~<&'text'&>"
40164 If the message was received on an authenticated SMTP connection, this records
40165 the name of the authenticator &-- the value of the
40166 &$sender_host_authenticated$& variable.
40167
40168 .vitem &%-host_lookup_failed%&
40169 This is present if an attempt to look up the sending host's name from its IP
40170 address failed. It corresponds to the &$host_lookup_failed$& variable.
40171
40172 .vitem "&%-host_name%&&~<&'text'&>"
40173 .cindex "reverse DNS lookup"
40174 .cindex "DNS" "reverse lookup"
40175 This records the name of the remote host from which the message was received,
40176 if the host name was looked up from the IP address when the message was being
40177 received. It is not present if no reverse lookup was done.
40178
40179 .vitem "&%-ident%&&~<&'text'&>"
40180 For locally submitted messages, this records the login of the originating user,
40181 unless it was a trusted user and the &%-oMt%& option was used to specify an
40182 ident value. For messages received over TCP/IP, this records the ident string
40183 supplied by the remote host, if any.
40184
40185 .vitem "&%-interface_address%&&~<&'address'&>.<&'port'&>"
40186 This records the IP address of the local interface and the port number through
40187 which a message was received from a remote host. It is omitted for locally
40188 generated messages.
40189
40190 .vitem &%-local%&
40191 The message is from a local sender.
40192
40193 .vitem &%-localerror%&
40194 The message is a locally-generated bounce message.
40195
40196 .vitem "&%-local_scan%&&~<&'string'&>"
40197 This records the data string that was returned by the &[local_scan()]& function
40198 when the message was received &-- the value of the &$local_scan_data$&
40199 variable. It is omitted if no data was returned.
40200
40201 .vitem &%-manual_thaw%&
40202 The message was frozen but has been thawed manually, that is, by an explicit
40203 Exim command rather than via the auto-thaw process.
40204
40205 .vitem &%-N%&
40206 A testing delivery process was started using the &%-N%& option to suppress any
40207 actual deliveries, but delivery was deferred. At any further delivery attempts,
40208 &%-N%& is assumed.
40209
40210 .vitem &%-received_protocol%&
40211 This records the value of the &$received_protocol$& variable, which contains
40212 the name of the protocol by which the message was received.
40213
40214 .vitem &%-sender_set_untrusted%&
40215 The envelope sender of this message was set by an untrusted local caller (used
40216 to ensure that the caller is displayed in queue listings).
40217
40218 .vitem "&%-spam_score_int%&&~<&'number'&>"
40219 If a message was scanned by SpamAssassin, this is present. It records the value
40220 of &$spam_score_int$&.
40221
40222 .vitem &%-spool_file_wireformat%&
40223 The -D file for this message is in wire-format (for ESMTP CHUNKING)
40224 rather than Unix-format.
40225 The line-ending is CRLF rather than newline.
40226 There is still, however, no leading-dot-stuffing.
40227
40228 .vitem &%-tls_certificate_verified%&
40229 A TLS certificate was received from the client that sent this message, and the
40230 certificate was verified by the server.
40231
40232 .vitem "&%-tls_cipher%&&~<&'cipher name'&>"
40233 When the message was received over an encrypted connection, this records the
40234 name of the cipher suite that was used.
40235
40236 .vitem "&%-tls_peerdn%&&~<&'peer DN'&>"
40237 When the message was received over an encrypted connection, and a certificate
40238 was received from the client, this records the Distinguished Name from that
40239 certificate.
40240 .endlist
40241
40242 Any of the above may have an extra hyphen prepended, to indicate the the
40243 corresponding data is untrusted.
40244
40245 Following the options there is a list of those addresses to which the message
40246 is not to be delivered. This set of addresses is initialized from the command
40247 line when the &%-t%& option is used and &%extract_addresses_remove_arguments%&
40248 is set; otherwise it starts out empty. Whenever a successful delivery is made,
40249 the address is added to this set. The addresses are kept internally as a
40250 balanced binary tree, and it is a representation of that tree which is written
40251 to the spool file. If an address is expanded via an alias or forward file, the
40252 original address is added to the tree when deliveries to all its child
40253 addresses are complete.
40254
40255 If the tree is empty, there is a single line in the spool file containing just
40256 the text &"XX"&. Otherwise, each line consists of two letters, which are either
40257 Y or N, followed by an address. The address is the value for the node of the
40258 tree, and the letters indicate whether the node has a left branch and/or a
40259 right branch attached to it, respectively. If branches exist, they immediately
40260 follow. Here is an example of a three-node tree:
40261 .code
40262 YY darcy@austen.fict.example
40263 NN alice@wonderland.fict.example
40264 NN editor@thesaurus.ref.example
40265 .endd
40266 After the non-recipients tree, there is a list of the message's recipients.
40267 This is a simple list, preceded by a count. It includes all the original
40268 recipients of the message, including those to whom the message has already been
40269 delivered. In the simplest case, the list contains one address per line. For
40270 example:
40271 .code
40272 4
40273 editor@thesaurus.ref.example
40274 darcy@austen.fict.example
40275 rdo@foundation
40276 alice@wonderland.fict.example
40277 .endd
40278 However, when a child address has been added to the top-level addresses as a
40279 result of the use of the &%one_time%& option on a &(redirect)& router, each
40280 line is of the following form:
40281 .display
40282 <&'top-level address'&> <&'errors_to address'&> &&&
40283   <&'length'&>,<&'parent number'&>#<&'flag bits'&>
40284 .endd
40285 The 01 flag bit indicates the presence of the three other fields that follow
40286 the top-level address. Other bits may be used in future to support additional
40287 fields. The <&'parent number'&> is the offset in the recipients list of the
40288 original parent of the &"one time"& address. The first two fields are the
40289 envelope sender that is associated with this address and its length. If the
40290 length is zero, there is no special envelope sender (there are then two space
40291 characters in the line). A non-empty field can arise from a &(redirect)& router
40292 that has an &%errors_to%& setting.
40293
40294
40295 A blank line separates the envelope and status information from the headers
40296 which follow. A header may occupy several lines of the file, and to save effort
40297 when reading it in, each header is preceded by a number and an identifying
40298 character. The number is the number of characters in the header, including any
40299 embedded newlines and the terminating newline. The character is one of the
40300 following:
40301
40302 .table2 50pt
40303 .row <&'blank'&>         "header in which Exim has no special interest"
40304 .row &`B`&               "&'Bcc:'& header"
40305 .row &`C`&               "&'Cc:'& header"
40306 .row &`F`&               "&'From:'& header"
40307 .row &`I`&               "&'Message-id:'& header"
40308 .row &`P`&               "&'Received:'& header &-- P for &""postmark""&"
40309 .row &`R`&               "&'Reply-To:'& header"
40310 .row &`S`&               "&'Sender:'& header"
40311 .row &`T`&               "&'To:'& header"
40312 .row &`*`&               "replaced or deleted header"
40313 .endtable
40314
40315 Deleted or replaced (rewritten) headers remain in the spool file for debugging
40316 purposes. They are not transmitted when the message is delivered. Here is a
40317 typical set of headers:
40318 .code
40319 111P Received: by hobbit.fict.example with local (Exim 4.00)
40320 id 14y9EI-00026G-00; Fri, 11 May 2001 10:28:59 +0100
40321 049  Message-Id: <E14y9EI-00026G-00@hobbit.fict.example>
40322 038* X-rewrote-sender: bb@hobbit.fict.example
40323 042* From: Bilbo Baggins <bb@hobbit.fict.example>
40324 049F From: Bilbo Baggins <B.Baggins@hobbit.fict.example>
40325 099* To: alice@wonderland.fict.example, rdo@foundation,
40326 darcy@austen.fict.example, editor@thesaurus.ref.example
40327 104T To: alice@wonderland.fict.example, rdo@foundation.example,
40328 darcy@austen.fict.example, editor@thesaurus.ref.example
40329 038  Date: Fri, 11 May 2001 10:28:59 +0100
40330 .endd
40331 The asterisked headers indicate that the envelope sender, &'From:'& header, and
40332 &'To:'& header have been rewritten, the last one because routing expanded the
40333 unqualified domain &'foundation'&.
40334 .ecindex IIDforspo1
40335 .ecindex IIDforspo2
40336 .ecindex IIDforspo3
40337
40338 .section "Format of the -D file" "SECID282a"
40339 The data file is traditionally in Unix-standard format: lines are ended with
40340 an ASCII newline character.
40341 However, when the &%spool_wireformat%& main option is used some -D files
40342 can have an alternate format.
40343 This is flagged by a &%-spool_file_wireformat%& line in the corresponding -H file.
40344 The -D file lines (not including the first name-component line) are
40345 suitable for direct copying to the wire when transmitting using the
40346 ESMTP CHUNKING option, meaning lower processing overhead.
40347 Lines are terminated with an ASCII CRLF pair.
40348 There is no dot-stuffing (and no dot-termination).
40349
40350 . ////////////////////////////////////////////////////////////////////////////
40351 . ////////////////////////////////////////////////////////////////////////////
40352
40353 .chapter "DKIM, SPF and DMARC" "CHAPdkim" &&&
40354          "DKIM, SPF and DMARC Support"
40355
40356 .section "DKIM (DomainKeys Identified Mail)" SECDKIM
40357 .cindex "DKIM"
40358
40359 DKIM is a mechanism by which messages sent by some entity can be provably
40360 linked to a domain which that entity controls.  It permits reputation to
40361 be tracked on a per-domain basis, rather than merely upon source IP address.
40362 DKIM is documented in RFC 6376.
40363
40364 As DKIM relies on the message being unchanged in transit, messages handled
40365 by a mailing-list (which traditionally adds to the message) will not match
40366 any original DKIM signature.
40367
40368 DKIM support is compiled into Exim by default if TLS support is present.
40369 It can be disabled by setting DISABLE_DKIM=yes in &_Local/Makefile_&.
40370
40371 Exim's DKIM implementation allows for
40372 .olist
40373 Signing outgoing messages: This function is implemented in the SMTP transport.
40374 It can co-exist with all other Exim features
40375 (including transport filters)
40376 except cutthrough delivery.
40377 .next
40378 Verifying signatures in incoming messages: This is implemented by an additional
40379 ACL (acl_smtp_dkim), which can be called several times per message, with
40380 different signature contexts.
40381 .endlist
40382
40383 In typical Exim style, the verification implementation does not include any
40384 default "policy". Instead it enables you to build your own policy using
40385 Exim's standard controls.
40386
40387 Please note that verification of DKIM signatures in incoming mail is turned
40388 on by default for logging (in the <= line) purposes.
40389
40390 Additional log detail can be enabled using the &%dkim_verbose%& log_selector.
40391 When set, for each signature in incoming email,
40392 exim will log a line displaying the most important signature details, and the
40393 signature status. Here is an example (with line-breaks added for clarity):
40394 .code
40395 2009-09-09 10:22:28 1MlIRf-0003LU-U3 DKIM:
40396     d=facebookmail.com s=q1-2009b
40397     c=relaxed/relaxed a=rsa-sha1
40398     i=@facebookmail.com t=1252484542 [verification succeeded]
40399 .endd
40400
40401 You might want to turn off DKIM verification processing entirely for internal
40402 or relay mail sources. To do that, set the &%dkim_disable_verify%& ACL
40403 control modifier. This should typically be done in the RCPT ACL, at points
40404 where you accept mail from relay sources (internal hosts or authenticated
40405 senders).
40406
40407
40408 .section "Signing outgoing messages" "SECDKIMSIGN"
40409 .cindex "DKIM" "signing"
40410
40411 For signing to be usable you must have published a DKIM record in DNS.
40412 Note that RFC 8301 (which does not cover EC keys) says:
40413 .code
40414 rsa-sha1 MUST NOT be used for signing or verifying.
40415
40416 Signers MUST use RSA keys of at least 1024 bits for all keys.
40417 Signers SHOULD use RSA keys of at least 2048 bits.
40418 .endd
40419
40420 Note also that the key content (the 'p=' field)
40421 in the DNS record is different between RSA and EC keys;
40422 for the former it is the base64 of the ASN.1 for the RSA public key
40423 (equivalent to the private-key .pem with the header/trailer stripped)
40424 but for EC keys it is the base64 of the pure key; no ASN.1 wrapping.
40425
40426 Signing is enabled by setting private options on the SMTP transport.
40427 These options take (expandable) strings as arguments.
40428
40429 .option dkim_domain smtp string list&!! unset
40430 The domain(s) you want to sign with.
40431 After expansion, this can be a list.
40432 Each element in turn,
40433 lowercased,
40434 is put into the &%$dkim_domain%& expansion variable
40435 while expanding the remaining signing options.
40436 If it is empty after expansion, DKIM signing is not done,
40437 and no error will result even if &%dkim_strict%& is set.
40438
40439 .option dkim_selector smtp string list&!! unset
40440 This sets the key selector string.
40441 After expansion, which can use &$dkim_domain$&, this can be a list.
40442 Each element in turn is put in the expansion
40443 variable &%$dkim_selector%& which may be used in the &%dkim_private_key%&
40444 option along with &%$dkim_domain%&.
40445 If the option is empty after expansion, DKIM signing is not done for this domain,
40446 and no error will result even if &%dkim_strict%& is set.
40447
40448 .option dkim_private_key smtp string&!! unset
40449 This sets the private key to use.
40450 You can use the &%$dkim_domain%& and
40451 &%$dkim_selector%& expansion variables to determine the private key to use.
40452 The result can either
40453 .ilist
40454 be a valid RSA private key in ASCII armor (.pem file), including line breaks
40455 .next
40456 with GnuTLS 3.6.0 or OpenSSL 1.1.1 or later,
40457 be a valid Ed25519 private key (same format as above)
40458 .next
40459 start with a slash, in which case it is treated as a file that contains
40460 the private key
40461 .next
40462 be "0", "false" or the empty string, in which case the message will not
40463 be signed. This case will not result in an error, even if &%dkim_strict%&
40464 is set.
40465 .endlist
40466
40467 To generate keys under OpenSSL:
40468 .code
40469 openssl genrsa -out dkim_rsa.private 2048
40470 openssl rsa -in dkim_rsa.private -out /dev/stdout -pubout -outform PEM
40471 .endd
40472 The result file from the first command should be retained, and
40473 this option set to use it.
40474 Take the base-64 lines from the output of the second command, concatenated,
40475 for the DNS TXT record.
40476 See section 3.6 of RFC6376 for the record specification.
40477
40478 Under GnuTLS:
40479 .code
40480 certtool --generate-privkey --rsa --bits=2048 --password='' -8 --outfile=dkim_rsa.private
40481 certtool --load-privkey=dkim_rsa.private --pubkey-info
40482 .endd
40483
40484 Note that RFC 8301 says:
40485 .code
40486 Signers MUST use RSA keys of at least 1024 bits for all keys.
40487 Signers SHOULD use RSA keys of at least 2048 bits.
40488 .endd
40489
40490 EC keys for DKIM are defined by RFC 8463.
40491 They are considerably smaller than RSA keys for equivalent protection.
40492 As they are a recent development, users should consider dual-signing
40493 (by setting a list of selectors, and an expansion for this option)
40494 for some transition period.
40495 The "_CRYPTO_SIGN_ED25519" macro will be defined if support is present
40496 for EC keys.
40497
40498 OpenSSL 1.1.1 and GnuTLS 3.6.0 can create Ed25519 private keys:
40499 .code
40500 openssl genpkey -algorithm ed25519 -out dkim_ed25519.private
40501 certtool --generate-privkey --key-type=ed25519 --outfile=dkim_ed25519.private
40502 .endd
40503
40504 To produce the required public key value for a DNS record:
40505 .code
40506 openssl pkey -outform DER -pubout -in dkim_ed25519.private | tail -c +13 | base64
40507 certtool --load_privkey=dkim_ed25519.private --pubkey_info --outder | tail -c +13 | base64
40508 .endd
40509
40510 Exim also supports an alternate format
40511 of Ed25519 keys in DNS which was a candidate during development
40512 of the standard, but not adopted.
40513 A future release will probably drop that support.
40514
40515 .option dkim_hash smtp string&!! sha256
40516 Can be set to any one of the supported hash methods, which are:
40517 .ilist
40518 &`sha1`& &-- should not be used, is old and insecure
40519 .next
40520 &`sha256`& &-- the default
40521 .next
40522 &`sha512`& &-- possibly more secure but less well supported
40523 .endlist
40524
40525 Note that RFC 8301 says:
40526 .code
40527 rsa-sha1 MUST NOT be used for signing or verifying.
40528 .endd
40529
40530 .option dkim_identity smtp string&!! unset
40531 If set after expansion, the value is used to set an "i=" tag in
40532 the signing header.  The DKIM standards restrict the permissible
40533 syntax of this optional tag to a mail address, with possibly-empty
40534 local part, an @, and a domain identical to or subdomain of the "d="
40535 tag value.  Note that Exim does not check the value.
40536
40537 .option dkim_canon smtp string&!! unset
40538 This option sets the canonicalization method used when signing a message.
40539 The DKIM RFC currently supports two methods: "simple" and "relaxed".
40540 The option defaults to "relaxed" when unset. Note: the current implementation
40541 only supports signing with the same canonicalization method for both headers and body.
40542
40543 .option dkim_strict smtp string&!! unset
40544 This  option  defines  how  Exim  behaves  when  signing a message that
40545 should be signed fails for some reason.  When the expansion evaluates to
40546 either &"1"& or &"true"&, Exim will defer. Otherwise Exim will send the message
40547 unsigned. You can use the &%$dkim_domain%& and &%$dkim_selector%& expansion
40548 variables here.
40549
40550 .option dkim_sign_headers smtp string&!! "see below"
40551 If set, this option must expand to a colon-separated
40552 list of header names.
40553 Headers with these names, or the absence or such a header, will be included
40554 in the message signature.
40555 When unspecified, the header names listed in RFC4871 will be used,
40556 whether or not each header is present in the message.
40557 The default list is available for the expansion in the macro
40558 &"_DKIM_SIGN_HEADERS"&
40559 .new
40560 and an oversigning variant is in &"_DKIM_OVERSIGN_HEADERS"&.
40561 .wen
40562
40563 If a name is repeated, multiple headers by that name (or the absence thereof)
40564 will be signed.  The textually later headers in the headers part of the
40565 message are signed first, if there are multiples.
40566
40567 A name can be prefixed with either an &"="& or a &"+"& character.
40568 If an &"="& prefix is used, all headers that are present with this name
40569 will be signed.
40570 If a &"+"& prefix if used, all headers that are present with this name
40571 will be signed, and one signature added for a missing header with the
40572 name will be appended.
40573
40574 .option dkim_timestamps smtp integer&!! unset
40575 This option controls the inclusion of timestamp information in the signature.
40576 If not set, no such information will be included.
40577 Otherwise, must be an unsigned number giving an offset in seconds from the current time
40578 for the expiry tag
40579 (eg. 1209600 for two weeks);
40580 both creation (t=) and expiry (x=) tags will be included.
40581
40582 RFC 6376 lists these tags as RECOMMENDED.
40583
40584
40585 .section "Verifying DKIM signatures in incoming mail" "SECDKIMVFY"
40586 .cindex "DKIM" "verification"
40587
40588 Verification of DKIM signatures in SMTP incoming email is done for all
40589 messages for which an ACL control &%dkim_disable_verify%& has not been set.
40590 .cindex DKIM "selecting signature algorithms"
40591 Individual classes of signature algorithm can be ignored by changing
40592 the main options &%dkim_verify_hashes%& or &%dkim_verify_keytypes%&.
40593 The &%dkim_verify_minimal%& option can be set to cease verification
40594 processing for a message once the first passing signature is found.
40595
40596 .cindex authentication "expansion item"
40597 Performing verification sets up information used by the
40598 &%authresults%& expansion item.
40599
40600 For most purposes the default option settings suffice and the remainder
40601 of this section can be ignored.
40602
40603 The results of verification are made available to the
40604 &%acl_smtp_dkim%& ACL, which can examine and modify them.
40605 A missing ACL definition defaults to accept.
40606 By default, the ACL is called once for each
40607 syntactically(!) correct signature in the incoming message.
40608 If any ACL call does not accept, the message is not accepted.
40609 If a cutthrough delivery was in progress for the message, that is
40610 summarily dropped (having wasted the transmission effort).
40611
40612 To evaluate the verification result in the ACL
40613 a large number of expansion variables
40614 containing the signature status and its details are set up during the
40615 runtime of the ACL.
40616
40617 Calling the ACL only for existing signatures is not sufficient to build
40618 more advanced policies. For that reason, the main option
40619 &%dkim_verify_signers%&, and an expansion variable
40620 &%$dkim_signers%& exist.
40621
40622 The main option &%dkim_verify_signers%& can be set to a colon-separated
40623 list of DKIM domains or identities for which the ACL &%acl_smtp_dkim%& is
40624 called. It is expanded when the message has been received. At this point,
40625 the expansion variable &%$dkim_signers%& already contains a colon-separated
40626 list of signer domains and identities for the message. When
40627 &%dkim_verify_signers%& is not specified in the main configuration,
40628 it defaults as:
40629 .code
40630 dkim_verify_signers = $dkim_signers
40631 .endd
40632 This leads to the default behaviour of calling &%acl_smtp_dkim%& for each
40633 DKIM signature in the message. Current DKIM verifiers may want to explicitly
40634 call the ACL for known domains or identities. This would be achieved as follows:
40635 .code
40636 dkim_verify_signers = paypal.com:ebay.com:$dkim_signers
40637 .endd
40638 This would result in &%acl_smtp_dkim%& always being called for "paypal.com"
40639 and "ebay.com", plus all domains and identities that have signatures in the message.
40640 You can also be more creative in constructing your policy. For example:
40641 .code
40642 dkim_verify_signers = $sender_address_domain:$dkim_signers
40643 .endd
40644
40645 If a domain or identity is listed several times in the (expanded) value of
40646 &%dkim_verify_signers%&, the ACL is only called once for that domain or identity.
40647
40648 Note that if the option is set using untrustworthy data
40649 (such as the From: header)
40650 care should be taken to force lowercase for domains
40651 and for the domain part if identities.
40652 The default setting can be regarded as trustworthy in this respect.
40653
40654 If multiple signatures match a domain (or identity), the ACL is called once
40655 for each matching signature.
40656
40657
40658 Inside the DKIM ACL, the following expansion variables are
40659 available (from most to least important):
40660
40661
40662 .vlist
40663 .vitem &%$dkim_cur_signer%&
40664 The signer that is being evaluated in this ACL run. This can be a domain or
40665 an identity. This is one of the list items from the expanded main option
40666 &%dkim_verify_signers%& (see above).
40667
40668 .vitem &%$dkim_verify_status%&
40669 Within the DKIM ACL,
40670 a string describing the general status of the signature. One of
40671 .ilist
40672 &%none%&: There is no signature in the message for the current domain or
40673 identity (as reflected by &%$dkim_cur_signer%&).
40674 .next
40675 &%invalid%&: The signature could not be verified due to a processing error.
40676 More detail is available in &%$dkim_verify_reason%&.
40677 .next
40678 &%fail%&: Verification of the signature failed.  More detail is
40679 available in &%$dkim_verify_reason%&.
40680 .next
40681 &%pass%&: The signature passed verification. It is valid.
40682 .endlist
40683
40684 This variable can be overwritten using an ACL 'set' modifier.
40685 This might, for instance, be done to enforce a policy restriction on
40686 hash-method or key-size:
40687 .code
40688   warn condition       = ${if eq {$dkim_verify_status}{pass}}
40689        condition       = ${if eq {${length_3:$dkim_algo}}{rsa}}
40690        condition       = ${if or {{eq {$dkim_algo}{rsa-sha1}} \
40691                                   {< {$dkim_key_length}{1024}}}}
40692        logwrite        = NOTE: forcing DKIM verify fail (was pass)
40693        set dkim_verify_status = fail
40694        set dkim_verify_reason = hash too weak or key too short
40695 .endd
40696
40697 So long as a DKIM ACL is defined (it need do no more than accept),
40698 after all the DKIM ACL runs have completed, the value becomes a
40699 colon-separated list of the values after each run.
40700 This is maintained for the mime, prdr and data ACLs.
40701
40702 .vitem &%$dkim_verify_reason%&
40703 A string giving a little bit more detail when &%$dkim_verify_status%& is either
40704 "fail" or "invalid". One of
40705 .ilist
40706 &%pubkey_unavailable%& (when &%$dkim_verify_status%&="invalid"): The public
40707 key for the domain could not be retrieved. This may be a temporary problem.
40708 .next
40709 &%pubkey_syntax%& (when &%$dkim_verify_status%&="invalid"): The public key
40710 record for the domain is syntactically invalid.
40711 .next
40712 &%bodyhash_mismatch%& (when &%$dkim_verify_status%&="fail"): The calculated
40713 body hash does not match the one specified in the signature header. This
40714 means that the message body was modified in transit.
40715 .next
40716 &%signature_incorrect%& (when &%$dkim_verify_status%&="fail"): The signature
40717 could not be verified. This may mean that headers were modified,
40718 re-written or otherwise changed in a way which is incompatible with
40719 DKIM verification. It may of course also mean that the signature is forged.
40720 .endlist
40721
40722 This variable can be overwritten, with any value, using an ACL 'set' modifier.
40723
40724 .vitem &%$dkim_domain%&
40725 The signing domain. IMPORTANT: This variable is only populated if there is
40726 an actual signature in the message for the current domain or identity (as
40727 reflected by &%$dkim_cur_signer%&).
40728
40729 .vitem &%$dkim_identity%&
40730 The signing identity, if present. IMPORTANT: This variable is only populated
40731 if there is an actual signature in the message for the current domain or
40732 identity (as reflected by &%$dkim_cur_signer%&).
40733
40734 .vitem &%$dkim_selector%&
40735 The key record selector string.
40736
40737 .vitem &%$dkim_algo%&
40738 The algorithm used. One of 'rsa-sha1' or 'rsa-sha256'.
40739 If running under GnuTLS 3.6.0 or OpenSSL 1.1.1 or later,
40740 may also be 'ed25519-sha256'.
40741 The "_CRYPTO_SIGN_ED25519" macro will be defined if support is present
40742 for EC keys.
40743
40744 Note that RFC 8301 says:
40745 .code
40746 rsa-sha1 MUST NOT be used for signing or verifying.
40747
40748 DKIM signatures identified as having been signed with historic
40749 algorithms (currently, rsa-sha1) have permanently failed evaluation
40750 .endd
40751
40752 To enforce this you must either have a DKIM ACL which checks this variable
40753 and overwrites the &$dkim_verify_status$& variable as discussed above,
40754 or have set the main option &%dkim_verify_hashes%& to exclude
40755 processing of such signatures.
40756
40757 .vitem &%$dkim_canon_body%&
40758 The body canonicalization method. One of 'relaxed' or 'simple'.
40759
40760 .vitem &%$dkim_canon_headers%&
40761 The header canonicalization method. One of 'relaxed' or 'simple'.
40762
40763 .vitem &%$dkim_copiedheaders%&
40764 A transcript of headers and their values which are included in the signature
40765 (copied from the 'z=' tag of the signature).
40766 Note that RFC6376 requires that verification fail if the From: header is
40767 not included in the signature.  Exim does not enforce this; sites wishing
40768 strict enforcement should code the check explicitly.
40769
40770 .vitem &%$dkim_bodylength%&
40771 The number of signed body bytes. If zero ("0"), the body is unsigned. If no
40772 limit was set by the signer, "9999999999999" is returned. This makes sure
40773 that this variable always expands to an integer value.
40774 &*Note:*& The presence of the signature tag specifying a signing body length
40775 is one possible route to spoofing of valid DKIM signatures.
40776 A paranoid implementation might wish to regard signature where this variable
40777 shows less than the "no limit" return as being invalid.
40778
40779 .vitem &%$dkim_created%&
40780 UNIX timestamp reflecting the date and time when the signature was created.
40781 When this was not specified by the signer, "0" is returned.
40782
40783 .vitem &%$dkim_expires%&
40784 UNIX timestamp reflecting the date and time when the signer wants the
40785 signature to be treated as "expired". When this was not specified by the
40786 signer, "9999999999999" is returned. This makes it possible to do useful
40787 integer size comparisons against this value.
40788 Note that Exim does not check this value.
40789
40790 .vitem &%$dkim_headernames%&
40791 A colon-separated list of names of headers included in the signature.
40792
40793 .vitem &%$dkim_key_testing%&
40794 "1" if the key record has the "testing" flag set, "0" if not.
40795
40796 .vitem &%$dkim_key_nosubdomains%&
40797 "1" if the key record forbids subdomaining, "0" otherwise.
40798
40799 .vitem &%$dkim_key_srvtype%&
40800 Service type (tag s=) from the key record. Defaults to "*" if not specified
40801 in the key record.
40802
40803 .vitem &%$dkim_key_granularity%&
40804 Key granularity (tag g=) from the key record. Defaults to "*" if not specified
40805 in the key record.
40806
40807 .vitem &%$dkim_key_notes%&
40808 Notes from the key record (tag n=).
40809
40810 .vitem &%$dkim_key_length%&
40811 Number of bits in the key.
40812 .new
40813 Valid only once the key is loaded, which is at the time the header signature
40814 is verified, which is after the body hash is.
40815 .wen
40816
40817 Note that RFC 8301 says:
40818 .code
40819 Verifiers MUST NOT consider signatures using RSA keys of
40820 less than 1024 bits as valid signatures.
40821 .endd
40822
40823 This is enforced by the default setting for the &%dkim_verify_min_keysizes%&
40824 option.
40825
40826 .endlist
40827
40828 In addition, two ACL conditions are provided:
40829
40830 .vlist
40831 .vitem &%dkim_signers%&
40832 ACL condition that checks a colon-separated list of domains or identities
40833 for a match against the domain or identity that the ACL is currently verifying
40834 (reflected by &%$dkim_cur_signer%&). This is typically used to restrict an ACL
40835 verb to a group of domains or identities. For example:
40836
40837 .code
40838 # Warn when Mail purportedly from GMail has no gmail signature
40839 warn log_message = GMail sender without gmail.com DKIM signature
40840      sender_domains = gmail.com
40841      dkim_signers = gmail.com
40842      dkim_status = none
40843 .endd
40844
40845 Note that the above does not check for a total lack of DKIM signing;
40846 for that check for empty &$h_DKIM-Signature:$& in the data ACL.
40847
40848 .vitem &%dkim_status%&
40849 ACL condition that checks a colon-separated list of possible DKIM verification
40850 results against the actual result of verification. This is typically used
40851 to restrict an ACL verb to a list of verification outcomes, for example:
40852
40853 .code
40854 deny message = Mail from Paypal with invalid/missing signature
40855      sender_domains = paypal.com:paypal.de
40856      dkim_signers = paypal.com:paypal.de
40857      dkim_status = none:invalid:fail
40858 .endd
40859
40860 The possible status keywords are: 'none','invalid','fail' and 'pass'. Please
40861 see the documentation of the &%$dkim_verify_status%& expansion variable above
40862 for more information of what they mean.
40863 .endlist
40864
40865
40866
40867
40868 .section "SPF (Sender Policy Framework)" SECSPF
40869 .cindex SPF verification
40870
40871 SPF is a mechanism whereby a domain may assert which IP addresses may transmit
40872 messages with its domain in the envelope from, documented by RFC 7208.
40873 For more information on SPF see &url(http://www.open-spf.org), a static copy of
40874 the &url(http://openspf.org).
40875 . --- 2019-10-28: still not https, open-spf.org is told to be a
40876 . --- web-archive copy of the now dead openspf.org site
40877 . --- See https://www.mail-archive.com/mailop@mailop.org/msg08019.html for a
40878 . --- discussion.
40879
40880 Messages sent by a system not authorised will fail checking of such assertions.
40881 This includes retransmissions done by traditional forwarders.
40882
40883 SPF verification support is built into Exim if SUPPORT_SPF=yes is set in
40884 &_Local/Makefile_&.  The support uses the &_libspf2_& library
40885 &url(https://www.libspf2.org/).
40886 There is no Exim involvement in the transmission of messages;
40887 publishing certain DNS records is all that is required.
40888
40889 For verification, an ACL condition and an expansion lookup are provided.
40890 .cindex authentication "expansion item"
40891 Performing verification sets up information used by the
40892 &%authresults%& expansion item.
40893
40894
40895 .cindex SPF "ACL condition"
40896 .cindex ACL "spf condition"
40897 The ACL condition "spf" can be used at or after the MAIL ACL.
40898 It takes as an argument a list of strings giving the outcome of the SPF check,
40899 and will succeed for any matching outcome.
40900 Valid strings are:
40901 .vlist
40902 .vitem &%pass%&
40903 The SPF check passed, the sending host is positively verified by SPF.
40904
40905 .vitem &%fail%&
40906 The SPF check failed, the sending host is NOT allowed to send mail for the
40907 domain in the envelope-from address.
40908
40909 .vitem &%softfail%&
40910 The SPF check failed, but the queried domain can't absolutely confirm that this
40911 is a forgery.
40912
40913 .vitem &%none%&
40914 The queried domain does not publish SPF records.
40915
40916 .vitem &%neutral%&
40917 The SPF check returned a "neutral" state.  This means the queried domain has
40918 published a SPF record, but wants to allow outside servers to send mail under
40919 its domain as well.  This should be treated like "none".
40920
40921 .vitem &%permerror%&
40922 This indicates a syntax error in the SPF record of the queried domain.
40923 You may deny messages when this occurs.
40924
40925 .vitem &%temperror%&
40926 This indicates a temporary error during all processing, including Exim's
40927 SPF processing.  You may defer messages when this occurs.
40928 .endlist
40929
40930 You can prefix each string with an exclamation mark to  invert
40931 its meaning,  for example  "!fail" will  match all  results but
40932 "fail".  The  string  list is  evaluated  left-to-right,  in a
40933 short-circuit fashion.
40934
40935 Example:
40936 .code
40937 deny spf = fail
40938      message = $sender_host_address is not allowed to send mail from \
40939                ${if def:sender_address_domain \
40940                     {$sender_address_domain}{$sender_helo_name}}.  \
40941                Please see http://www.open-spf.org/Why?scope=\
40942                ${if def:sender_address_domain {mfrom}{helo}};\
40943                identity=${if def:sender_address_domain \
40944                              {$sender_address}{$sender_helo_name}};\
40945                ip=$sender_host_address
40946 .endd
40947
40948 When the spf condition has run, it sets up several expansion
40949 variables:
40950
40951 .cindex SPF "verification variables"
40952 .vlist
40953 .vitem &$spf_header_comment$&
40954 .vindex &$spf_header_comment$&
40955   This contains a human-readable string describing the outcome
40956   of the SPF check. You can add it to a custom header or use
40957   it for logging purposes.
40958
40959 .vitem &$spf_received$&
40960 .vindex &$spf_received$&
40961   This contains a complete Received-SPF: header that can be
40962   added to the message. Please note that according to the SPF
40963   draft, this header must be added at the top of the header
40964   list. Please see section 10 on how you can do this.
40965
40966   Note: in case of "Best-guess" (see below), the convention is
40967   to put this string in a header called X-SPF-Guess: instead.
40968
40969 .vitem &$spf_result$&
40970 .vindex &$spf_result$&
40971   This contains the outcome of the SPF check in string form,
40972   one of pass, fail, softfail, none, neutral, permerror or
40973   temperror.
40974
40975 .vitem &$spf_result_guessed$&
40976 .vindex &$spf_result_guessed$&
40977   This boolean is true only if a best-guess operation was used
40978   and required in order to obtain a result.
40979
40980 .vitem &$spf_smtp_comment$&
40981 .vindex &$spf_smtp_comment$&
40982   This contains a string that can be used in a SMTP response
40983   to the calling party. Useful for "fail".
40984 .endlist
40985
40986
40987 .cindex SPF "ACL condition"
40988 .cindex ACL "spf_guess condition"
40989 .cindex SPF "best guess"
40990 In addition to SPF, you can also perform checks for so-called
40991 "Best-guess".  Strictly speaking, "Best-guess" is not standard
40992 SPF, but it is supported by the same framework that enables SPF
40993 capability.
40994 Refer to &url(http://www.open-spf.org/FAQ/Best_guess_record)
40995 for a description of what it means.
40996 . --- 2019-10-28: still not https:
40997
40998 To access this feature, simply use the spf_guess condition in place
40999 of the spf one.  For example:
41000
41001 .code
41002 deny spf_guess = fail
41003      message = $sender_host_address doesn't look trustworthy to me
41004 .endd
41005
41006 In case you decide to reject messages based on this check, you
41007 should note that although it uses the same framework, "Best-guess"
41008 is not SPF, and therefore you should not mention SPF at all in your
41009 reject message.
41010
41011 When the spf_guess condition has run, it sets up the same expansion
41012 variables as when spf condition is run, described above.
41013
41014 Additionally, since Best-guess is not standardized, you may redefine
41015 what "Best-guess" means to you by redefining the main configuration
41016 &%spf_guess%& option.
41017 For example, the following:
41018
41019 .code
41020 spf_guess = v=spf1 a/16 mx/16 ptr ?all
41021 .endd
41022
41023 would relax host matching rules to a broader network range.
41024
41025
41026 .cindex SPF "lookup expansion"
41027 .cindex lookup spf
41028 A lookup expansion is also available. It takes an email
41029 address as the key and an IP address
41030 (v4 or v6)
41031 as the database:
41032
41033 .code
41034   ${lookup {username@domain} spf {ip.ip.ip.ip}}
41035 .endd
41036
41037 The lookup will return the same result strings as can appear in
41038 &$spf_result$& (pass,fail,softfail,neutral,none,err_perm,err_temp).
41039
41040
41041
41042
41043
41044 .section DMARC SECDMARC
41045 .cindex DMARC verification
41046
41047 DMARC combines feedback from SPF, DKIM, and header From: in order
41048 to attempt to provide better indicators of the authenticity of an
41049 email.  This document does not explain the fundamentals; you
41050 should read and understand how it works by visiting the website at
41051 &url(http://www.dmarc.org/).
41052
41053 If Exim is built with DMARC support,
41054 the libopendmarc library is used.
41055
41056 For building Exim yourself, obtain the library from
41057 &url(http://sourceforge.net/projects/opendmarc/)
41058 to obtain a copy, or find it in your favorite package
41059 repository.  You will need to attend to the local/Makefile feature
41060 SUPPORT_DMARC and the associated LDFLAGS addition.
41061 This description assumes
41062 that headers will be in /usr/local/include, and that the libraries
41063 are in /usr/local/lib.
41064
41065 . subsection
41066
41067 There are three main-configuration options:
41068 .cindex DMARC "configuration options"
41069
41070 The &%dmarc_tld_file%& option
41071 .oindex &%dmarc_tld_file%&
41072 defines the location of a text file of valid
41073 top level domains the opendmarc library uses
41074 during domain parsing. Maintained by Mozilla,
41075 the most current version can be downloaded
41076 from a link at &url(https://publicsuffix.org/list/public_suffix_list.dat).
41077 See also the util/renew-opendmarc-tlds.sh script.
41078 .new
41079 The default for the option is unset.
41080 If not set, DMARC processing is disabled.
41081 .wen
41082
41083
41084 The &%dmarc_history_file%& option, if set
41085 .oindex &%dmarc_history_file%&
41086 defines the location of a file to log results
41087 of dmarc verification on inbound emails. The
41088 contents are importable by the opendmarc tools
41089 which will manage the data, send out DMARC
41090 reports, and expire the data. Make sure the
41091 directory of this file is writable by the user
41092 exim runs as.
41093 The default is unset.
41094
41095 The &%dmarc_forensic_sender%& option
41096 .oindex &%dmarc_forensic_sender%&
41097 defines an alternate email address to use when sending a
41098 forensic report detailing alignment failures
41099 if a sender domain's dmarc record specifies it
41100 and you have configured Exim to send them.
41101 If set, this is expanded and used for the
41102 From: header line; the address is extracted
41103 from it and used for the envelope from.
41104 If not set (the default), the From: header is expanded from
41105 the dsn_from option, and <> is used for the
41106 envelope from.
41107
41108 . I wish we had subsections...
41109
41110 .cindex DMARC controls
41111 By default, the DMARC processing will run for any remote,
41112 non-authenticated user.  It makes sense to only verify DMARC
41113 status of messages coming from remote, untrusted sources.  You can
41114 use standard conditions such as hosts, senders, etc, to decide that
41115 DMARC verification should *not* be performed for them and disable
41116 DMARC with an ACL control modifier:
41117 .code
41118   control = dmarc_disable_verify
41119 .endd
41120 A DMARC record can also specify a "forensic address", which gives
41121 exim an email address to submit reports about failed alignment.
41122 Exim does not do this by default because in certain conditions it
41123 results in unintended information leakage (what lists a user might
41124 be subscribed to, etc).  You must configure exim to submit forensic
41125 reports to the owner of the domain.  If the DMARC record contains a
41126 forensic address and you specify the control statement below, then
41127 exim will send these forensic emails.  It is also advised that you
41128 configure a &%dmarc_forensic_sender%& because the default sender address
41129 construction might be inadequate.
41130 .code
41131   control = dmarc_enable_forensic
41132 .endd
41133 (AGAIN: You can choose not to send these forensic reports by simply
41134 not putting the dmarc_enable_forensic control line at any point in
41135 your exim config.  If you don't tell exim to send them, it will not
41136 send them.)
41137
41138 There are no options to either control.  Both must appear before
41139 the DATA acl.
41140
41141 . subsection
41142
41143 DMARC checks cam be run on incoming SMTP  messages by using the
41144 &"dmarc_status"& ACL condition in the DATA ACL.  You are required to
41145 call the &"spf"& condition first in the ACLs, then the &"dmarc_status"&
41146 condition.  Putting this condition in the ACLs is required in order
41147 for a DMARC check to actually occur.  All of the variables are set
41148 up before the DATA ACL, but there is no actual DMARC check that
41149 occurs until a &"dmarc_status"& condition is encountered in the ACLs.
41150
41151 The &"dmarc_status"& condition takes a list of strings on its
41152 right-hand side.  These strings describe recommended action based
41153 on the DMARC check.  To understand what the policy recommendations
41154 mean, refer to the DMARC website above.  Valid strings are:
41155 .display
41156 &'accept      '& The DMARC check passed and the library recommends accepting the email.
41157 &'reject      '& The DMARC check failed and the library recommends rejecting the email.
41158 &'quarantine  '& The DMARC check failed and the library recommends keeping it for further inspection.
41159 &'none        '& The DMARC check passed and the library recommends no specific action, neutral.
41160 &'norecord    '& No policy section in the DMARC record for this sender domain.
41161 &'nofrom      '& Unable to determine the domain of the sender.
41162 &'temperror   '& Library error or dns error.
41163 &'off         '& The DMARC check was disabled for this email.
41164 .endd
41165 You can prefix each string with an exclamation mark to invert its
41166 meaning, for example "!accept" will match all results but
41167 "accept".  The string list is evaluated left-to-right in a
41168 short-circuit fashion.  When a string matches the outcome of the
41169 DMARC check, the condition succeeds.  If none of the listed
41170 strings matches the outcome of the DMARC check, the condition
41171 fails.
41172
41173 Of course, you can also use any other lookup method that Exim
41174 supports, including LDAP, Postgres, MySQL, etc, as long as the
41175 result is a list of colon-separated strings.
41176
41177 Performing the check sets up information used by the
41178 &%authresults%& expansion item.
41179
41180 Several expansion variables are set before the DATA ACL is
41181 processed, and you can use them in this ACL.  The following
41182 expansion variables are available:
41183
41184 .vlist
41185 .vitem &$dmarc_status$&
41186 .vindex &$dmarc_status$&
41187 .cindex DMARC result
41188 A one word status indicating what the DMARC library
41189 thinks of the email.  It is a combination of the results of
41190 DMARC record lookup and the SPF/DKIM/DMARC processing results
41191 (if a DMARC record was found).  The actual policy declared
41192 in the DMARC record is in a separate expansion variable.
41193
41194 .vitem &$dmarc_status_text$&
41195 .vindex &$dmarc_status_text$&
41196 Slightly longer, human readable status.
41197
41198 .vitem &$dmarc_used_domain$&
41199 .vindex &$dmarc_used_domain$&
41200 The domain which DMARC used to look up the DMARC policy record.
41201
41202 .vitem &$dmarc_domain_policy$&
41203 .vindex &$dmarc_domain_policy$&
41204 The policy declared in the DMARC record.  Valid values
41205 are "none", "reject" and "quarantine".  It is blank when there
41206 is any error, including no DMARC record.
41207 .endlist
41208
41209 . subsection
41210
41211 By default, Exim's DMARC configuration is intended to be
41212 non-intrusive and conservative.  To facilitate this, Exim will not
41213 create any type of logging files without explicit configuration by
41214 you, the admin.  Nor will Exim send out any emails/reports about
41215 DMARC issues without explicit configuration by you, the admin (other
41216 than typical bounce messages that may come about due to ACL
41217 processing or failure delivery issues).
41218
41219 In order to log statistics suitable to be imported by the opendmarc
41220 tools, you need to:
41221 .ilist
41222 Configure the global option &%dmarc_history_file%&
41223 .next
41224 Configure cron jobs to call the appropriate opendmarc history
41225 import scripts and truncating the dmarc_history_file
41226 .endlist
41227
41228 In order to send forensic reports, you need to:
41229 .ilist
41230 Configure the global option &%dmarc_forensic_sender%&
41231 .next
41232 Configure, somewhere before the DATA ACL, the control option to
41233 enable sending DMARC forensic reports
41234 .endlist
41235
41236 . subsection
41237
41238 Example usage:
41239 .code
41240 (RCPT ACL)
41241   warn    domains        = +local_domains
41242           hosts          = +local_hosts
41243           control        = dmarc_disable_verify
41244
41245   warn    !domains       = +screwed_up_dmarc_records
41246           control        = dmarc_enable_forensic
41247
41248   warn    condition      = (lookup if destined to mailing list)
41249           set acl_m_mailing_list = 1
41250
41251 (DATA ACL)
41252   warn    dmarc_status   = accept : none : off
41253           !authenticated = *
41254           log_message    = DMARC DEBUG: $dmarc_status $dmarc_used_domain
41255
41256   warn    dmarc_status   = !accept
41257           !authenticated = *
41258           log_message    = DMARC DEBUG: '$dmarc_status' for $dmarc_used_domain
41259
41260   warn    dmarc_status   = quarantine
41261           !authenticated = *
41262           set $acl_m_quarantine = 1
41263           # Do something in a transport with this flag variable
41264
41265   deny    condition      = ${if eq{$dmarc_domain_policy}{reject}}
41266           condition      = ${if eq{$acl_m_mailing_list}{1}}
41267           message        = Messages from $dmarc_used_domain break mailing lists
41268
41269   deny    dmarc_status   = reject
41270           !authenticated = *
41271           message        = Message from $dmarc_used_domain failed sender's DMARC policy, REJECT
41272
41273   warn    add_header     = :at_start:${authresults {$primary_hostname}}
41274 .endd
41275
41276
41277
41278
41279
41280 . ////////////////////////////////////////////////////////////////////////////
41281 . ////////////////////////////////////////////////////////////////////////////
41282
41283 .chapter "Proxies" "CHAPproxies" &&&
41284          "Proxy support"
41285 .cindex "proxy support"
41286 .cindex "proxy" "access via"
41287
41288 A proxy is an intermediate system through which communication is passed.
41289 Proxies may provide a security, availability or load-distribution function.
41290
41291
41292 .section "Inbound proxies" SECTproxyInbound
41293 .cindex proxy inbound
41294 .cindex proxy "server side"
41295 .cindex proxy "Proxy protocol"
41296 .cindex "Proxy protocol" proxy
41297
41298 Exim has support for receiving inbound SMTP connections via a proxy
41299 that uses &"Proxy Protocol"& to speak to it.
41300 To include this support, include &"SUPPORT_PROXY=yes"&
41301 in Local/Makefile.
41302
41303 It was built on the HAProxy specification, found at
41304 &url(https://www.haproxy.org/download/1.8/doc/proxy-protocol.txt).
41305
41306 The purpose of this facility is so that an application load balancer,
41307 such as HAProxy, can sit in front of several Exim servers
41308 to distribute load.
41309 Exim uses the local protocol communication with the proxy to obtain
41310 the remote SMTP system IP address and port information.
41311 There is no logging if a host passes or
41312 fails Proxy Protocol negotiation, but it can easily be determined and
41313 recorded in an ACL (example is below).
41314
41315 Use of a proxy is enabled by setting the &%hosts_proxy%&
41316 main configuration option to a hostlist; connections from these
41317 hosts will use Proxy Protocol.
41318 Exim supports both version 1 and version 2 of the Proxy Protocol and
41319 automatically determines which version is in use.
41320
41321 The Proxy Protocol header is the first data received on a TCP connection
41322 and is inserted before any TLS-on-connect handshake from the client; Exim
41323 negotiates TLS between Exim-as-server and the remote client, not between
41324 Exim and the proxy server.
41325
41326 The following expansion variables are usable
41327 (&"internal"& and &"external"& here refer to the interfaces
41328 of the proxy):
41329 .display
41330 &'proxy_external_address   '& IP of host being proxied or IP of remote interface of proxy
41331 &'proxy_external_port      '& Port of host being proxied or Port on remote interface of proxy
41332 &'proxy_local_address      '& IP of proxy server inbound or IP of local interface of proxy
41333 &'proxy_local_port         '& Port of proxy server inbound or Port on local interface of proxy
41334 &'proxy_session            '& boolean: SMTP connection via proxy
41335 .endd
41336 If &$proxy_session$& is set but &$proxy_external_address$& is empty
41337 there was a protocol error.
41338 The variables &$sender_host_address$& and &$sender_host_port$&
41339 will have values for the actual client system, not the proxy.
41340
41341 Since the real connections are all coming from the proxy, and the
41342 per host connection tracking is done before Proxy Protocol is
41343 evaluated, &%smtp_accept_max_per_host%& must be set high enough to
41344 handle all of the parallel volume you expect per inbound proxy.
41345 With the option set so high, you lose the ability
41346 to protect your server from many connections from one IP.
41347 In order to prevent your server from overload, you
41348 need to add a per connection ratelimit to your connect ACL.
41349 A possible solution is:
41350 .display
41351   # Set max number of connections per host
41352   LIMIT   = 5
41353   # Or do some kind of IP lookup in a flat file or database
41354   # LIMIT = ${lookup{$sender_host_address}iplsearch{/etc/exim/proxy_limits}}
41355
41356   defer   message        = Too many connections from this IP right now
41357           ratelimit      = LIMIT / 5s / per_conn / strict
41358 .endd
41359
41360
41361
41362 .section "Outbound proxies" SECTproxySOCKS
41363 .cindex proxy outbound
41364 .cindex proxy "client side"
41365 .cindex proxy SOCKS
41366 .cindex SOCKS proxy
41367 Exim has support for sending outbound SMTP via a proxy
41368 using a protocol called SOCKS5 (defined by RFC1928).
41369 The support can be optionally included by defining SUPPORT_SOCKS=yes in
41370 Local/Makefile.
41371
41372 Use of a proxy is enabled by setting the &%socks_proxy%& option
41373 on an smtp transport.
41374 The option value is expanded and should then be a list
41375 (colon-separated by default) of proxy specifiers.
41376 Each proxy specifier is a list
41377 (space-separated by default) where the initial element
41378 is an IP address and any subsequent elements are options.
41379
41380 Options are a string <name>=<value>.
41381 The list of options is in the following table:
41382 .display
41383 &'auth   '& authentication method
41384 &'name   '& authentication username
41385 &'pass   '& authentication password
41386 &'port   '& tcp port
41387 &'tmo    '& connection timeout
41388 &'pri    '& priority
41389 &'weight '& selection bias
41390 .endd
41391
41392 More details on each of these options follows:
41393
41394 .ilist
41395 .cindex authentication "to proxy"
41396 .cindex proxy authentication
41397 &%auth%&: Either &"none"& (default) or &"name"&.
41398 Using &"name"& selects username/password authentication per RFC 1929
41399 for access to the proxy.
41400 Default is &"none"&.
41401 .next
41402 &%name%&: sets the username for the &"name"& authentication method.
41403 Default is empty.
41404 .next
41405 &%pass%&: sets the password for the &"name"& authentication method.
41406 Default is empty.
41407 .next
41408 &%port%&: the TCP port number to use for the connection to the proxy.
41409 Default is 1080.
41410 .next
41411 &%tmo%&: sets a connection timeout in seconds for this proxy.
41412 Default is 5.
41413 .next
41414 &%pri%&: specifies a priority for the proxy within the list,
41415 higher values being tried first.
41416 The default priority is 1.
41417 .next
41418 &%weight%&: specifies a selection bias.
41419 Within a priority set servers are queried in a random fashion,
41420 weighted by this value.
41421 The default value for selection bias is 1.
41422 .endlist
41423
41424 Proxies from the list are tried according to their priority
41425 and weight settings until one responds.  The timeout for the
41426 overall connection applies to the set of proxied attempts.
41427
41428 .section Logging SECTproxyLog
41429 To log the (local) IP of a proxy in the incoming or delivery logline,
41430 add &"+proxy"& to the &%log_selector%& option.
41431 This will add a component tagged with &"PRX="& to the line.
41432
41433 . ////////////////////////////////////////////////////////////////////////////
41434 . ////////////////////////////////////////////////////////////////////////////
41435
41436 .chapter "Internationalisation" "CHAPi18n" &&&
41437          "Internationalisation""
41438 .cindex internationalisation "email address"
41439 .cindex EAI
41440 .cindex i18n
41441 .cindex utf8 "mail name handling"
41442
41443 Exim has support for Internationalised mail names.
41444 To include this it must be built with SUPPORT_I18N and the libidn library.
41445 Standards supported are RFCs 2060, 5890, 6530 and 6533.
41446
41447 If Exim is built with SUPPORT_I18N_2008 (in addition to SUPPORT_I18N, not
41448 instead of it) then IDNA2008 is supported; this adds an extra library
41449 requirement, upon libidn2.
41450
41451 .section "MTA operations" SECTi18nMTA
41452 .cindex SMTPUTF8 "ESMTP option"
41453 The main configuration option &%smtputf8_advertise_hosts%& specifies
41454 a host list.  If this matches the sending host and
41455 accept_8bitmime is true (the default) then the ESMTP option
41456 SMTPUTF8 will be advertised.
41457
41458 If the sender specifies the SMTPUTF8 option on a MAIL command
41459 international handling for the message is enabled and
41460 the expansion variable &$message_smtputf8$& will have value TRUE.
41461
41462 The option &%allow_utf8_domains%& is set to true for this
41463 message. All DNS lookups are converted to a-label form
41464 whatever the setting of &%allow_utf8_domains%&
41465 when Exim is built with SUPPORT_I18N.
41466
41467 Both localparts and domain are maintained as the original
41468 UTF-8 form internally; any comparison or regular-expression use will
41469 require appropriate care.  Filenames created, eg. by
41470 the appendfile transport, will have UTF-8 names.
41471
41472 HELO names sent by the smtp transport will have any UTF-8
41473 components expanded to a-label form,
41474 and any certificate name checks will be done using the a-label
41475 form of the name.
41476
41477 .cindex log protocol
41478 .cindex SMTPUTF8 logging
41479 .cindex i18n logging
41480 Log lines and Received-by: header lines will acquire a "utf8"
41481 prefix on the protocol element, eg. utf8esmtp.
41482
41483 The following expansion operators can be used:
41484 .code
41485 ${utf8_domain_to_alabel:str}
41486 ${utf8_domain_from_alabel:str}
41487 ${utf8_localpart_to_alabel:str}
41488 ${utf8_localpart_from_alabel:str}
41489 .endd
41490
41491 .cindex utf8 "address downconversion"
41492 .cindex i18n "utf8 address downconversion"
41493 The RCPT ACL
41494 may use the following modifier:
41495 .display
41496 control = utf8_downconvert
41497 control = utf8_downconvert/<value>
41498 .endd
41499 This sets a flag requiring that addresses are converted to
41500 a-label form before smtp delivery, for use in a
41501 Message Submission Agent context.
41502 If a value is appended it may be:
41503 .display
41504 &`1  `& (default) mandatory downconversion
41505 &`0  `& no downconversion
41506 &`-1 `& if SMTPUTF8 not supported by destination host
41507 .endd
41508
41509 If mua_wrapper is set, the utf8_downconvert control
41510 is initially set to -1.
41511
41512 The smtp transport has an option &%utf8_downconvert%&.
41513 If set it must expand to one of the three values described above,
41514 and it overrides any previously set value.
41515
41516
41517 There is no explicit support for VRFY and EXPN.
41518 Configurations supporting these should inspect
41519 &$smtp_command_argument$& for an SMTPUTF8 argument.
41520
41521 There is no support for LMTP on Unix sockets.
41522 Using the "lmtp" protocol option on an smtp transport,
41523 for LMTP over TCP, should work as expected.
41524
41525 There is no support for DSN unitext handling,
41526 and no provision for converting logging from or to UTF-8.
41527
41528
41529
41530 .section "MDA operations" SECTi18nMDA
41531 To aid in constructing names suitable for IMAP folders
41532 the following expansion operator can be used:
41533 .code
41534 ${imapfolder {<string>} {<sep>} {<specials>}}
41535 .endd
41536
41537 The string is converted from the charset specified by
41538 the "headers charset" command (in a filter file)
41539 or &%headers_charset%& main configuration option (otherwise),
41540 to the
41541 modified UTF-7 encoding specified by RFC 2060,
41542 with the following exception: All occurrences of <sep>
41543 (which has to be a single character)
41544 are replaced with periods ("."), and all periods and slashes that are not
41545 <sep> and are not in the <specials> string are BASE64 encoded.
41546
41547 The third argument can be omitted, defaulting to an empty string.
41548 The second argument can be omitted, defaulting to "/".
41549
41550 This is the encoding used by Courier for Maildir names on disk, and followed
41551 by many other IMAP servers.
41552
41553 Examples:
41554 .display
41555 &`${imapfolder {Foo/Bar}}       `& yields &`Foo.Bar`&
41556 &`${imapfolder {Foo/Bar}{.}{/}} `& yields &`Foo&&AC8-Bar`&
41557 &`${imapfolder {Räksmörgås}}    `& yields &`R&&AOQ-ksm&&APY-rg&&AOU-s`&
41558 .endd
41559
41560 Note that the source charset setting is vital, and also that characters
41561 must be representable in UTF-16.
41562
41563
41564 . ////////////////////////////////////////////////////////////////////////////
41565 . ////////////////////////////////////////////////////////////////////////////
41566
41567 .chapter "Events" "CHAPevents" &&&
41568          "Events"
41569 .cindex events
41570
41571 The events mechanism in Exim can be used to intercept processing at a number
41572 of points.  It was originally invented to give a way to do customised logging
41573 actions (for example, to a database) but can also be used to modify some
41574 processing actions.
41575
41576 Most installations will never need to use Events.
41577 The support can be left out of a build by defining DISABLE_EVENT=yes
41578 in &_Local/Makefile_&.
41579
41580 There are two major classes of events: main and transport.
41581 The main configuration option &%event_action%& controls reception events;
41582 a transport option &%event_action%& controls delivery events.
41583
41584 Both options are a string which is expanded when the event fires.
41585 An example might look like:
41586 .cindex logging custom
41587 .code
41588 event_action = ${if eq {msg:delivery}{$event_name} \
41589 {${lookup pgsql {SELECT * FROM record_Delivery( \
41590     '${quote_pgsql:$sender_address_domain}',\
41591     '${quote_pgsql:${lc:$sender_address_local_part}}', \
41592     '${quote_pgsql:$domain}', \
41593     '${quote_pgsql:${lc:$local_part}}', \
41594     '${quote_pgsql:$host_address}', \
41595     '${quote_pgsql:${lc:$host}}', \
41596     '${quote_pgsql:$message_exim_id}')}} \
41597 } {}}
41598 .endd
41599
41600 Events have names which correspond to the point in process at which they fire.
41601 The name is placed in the variable &$event_name$& and the event action
41602 expansion must check this, as it will be called for every possible event type.
41603
41604 .new
41605 The current list of events is:
41606 .wen
41607 .display
41608 &`dane:fail              after    transport  `& per connection
41609 &`msg:complete           after    main       `& per message
41610 &`msg:defer              after    transport  `& per message per delivery try
41611 &`msg:delivery           after    transport  `& per recipient
41612 &`msg:rcpt:host:defer    after    transport  `& per recipient per host
41613 &`msg:rcpt:defer         after    transport  `& per recipient
41614 &`msg:host:defer         after    transport  `& per host per delivery try; host errors
41615 &`msg:fail:delivery      after    transport  `& per recipient
41616 &`msg:fail:internal      after    main       `& per recipient
41617 &`tcp:connect            before   transport  `& per connection
41618 &`tcp:close              after    transport  `& per connection
41619 &`tls:cert               before   both       `& per certificate in verification chain
41620 &`smtp:connect           after    transport  `& per connection
41621 &`smtp:ehlo              after    transport  `& per connection
41622 .endd
41623 New event types may be added in future.
41624
41625 The event name is a colon-separated list, defining the type of
41626 event in a tree of possibilities.  It may be used as a list
41627 or just matched on as a whole.  There will be no spaces in the name.
41628
41629 The second column in the table above describes whether the event fires
41630 before or after the action is associates with.  Those which fire before
41631 can be used to affect that action (more on this below).
41632
41633 The third column in the table above says what section of the configuration
41634 should define the event action.
41635
41636 An additional variable, &$event_data$&, is filled with information varying
41637 with the event type:
41638 .display
41639 &`dane:fail            `& failure reason
41640 &`msg:defer            `& error string
41641 &`msg:delivery         `& smtp confirmation message
41642 &`msg:fail:internal    `& failure reason
41643 &`msg:fail:delivery    `& smtp error message
41644 &`msg:host:defer       `& error string
41645 &`msg:rcpt:host:defer  `& error string
41646 &`msg:rcpt:defer       `& error string
41647 &`tls:cert             `& verification chain depth
41648 &`smtp:connect         `& smtp banner
41649 &`smtp:ehlo            `& smtp ehlo response
41650 .endd
41651
41652 The :defer events populate one extra variable: &$event_defer_errno$&.
41653
41654 For complex operations an ACL expansion can be used in &%event_action%&
41655 however due to the multiple contexts that Exim operates in during
41656 the course of its processing:
41657 .ilist
41658 variables set in transport events will not be visible outside that
41659 transport call
41660 .next
41661 acl_m variables in a server context are lost on a new connection,
41662 and after smtp helo/ehlo/mail/starttls/rset commands
41663 .endlist
41664 Using an ACL expansion with the logwrite modifier can be
41665 a useful way of writing to the main log.
41666
41667 The expansion of the event_action option should normally
41668 return an empty string.  Should it return anything else the
41669 following will be forced:
41670 .display
41671 &`tcp:connect      `&  do not connect
41672 &`tls:cert         `&  refuse verification
41673 &`smtp:connect     `&  close connection
41674 .endd
41675 All other message types ignore the result string, and
41676 no other use is made of it.
41677
41678 For a tcp:connect event, if the connection is being made to a proxy
41679 then the address and port variables will be that of the proxy and not
41680 the target system.
41681
41682 For tls:cert events, if GnuTLS is in use this will trigger only per
41683 chain element received on the connection.
41684 For OpenSSL it will trigger for every chain element including those
41685 loaded locally.
41686
41687 . ////////////////////////////////////////////////////////////////////////////
41688 . ////////////////////////////////////////////////////////////////////////////
41689
41690 .chapter "Adding new drivers or lookup types" "CHID13" &&&
41691          "Adding drivers or lookups"
41692 .cindex "adding drivers"
41693 .cindex "new drivers, adding"
41694 .cindex "drivers" "adding new"
41695 The following actions have to be taken in order to add a new router, transport,
41696 authenticator, or lookup type to Exim:
41697
41698 .olist
41699 Choose a name for the driver or lookup type that does not conflict with any
41700 existing name; I will use &"newdriver"& in what follows.
41701 .next
41702 Add to &_src/EDITME_& the line:
41703 .display
41704 <&'type'&>&`_NEWDRIVER=yes`&
41705 .endd
41706 where <&'type'&> is ROUTER, TRANSPORT, AUTH, or LOOKUP. If the
41707 code is not to be included in the binary by default, comment this line out. You
41708 should also add any relevant comments about the driver or lookup type.
41709 .next
41710 Add to &_src/config.h.defaults_& the line:
41711 .code
41712 #define <type>_NEWDRIVER
41713 .endd
41714 .next
41715 Edit &_src/drtables.c_&, adding conditional code to pull in the private header
41716 and create a table entry as is done for all the other drivers and lookup types.
41717 .next
41718 Edit &_scripts/lookups-Makefile_& if this is a new lookup; there is a for-loop
41719 near the bottom, ranging the &`name_mod`& variable over a list of all lookups.
41720 Add your &`NEWDRIVER`& to that list.
41721 As long as the dynamic module would be named &_newdriver.so_&, you can use the
41722 simple form that most lookups have.
41723 .next
41724 Edit &_Makefile_& in the appropriate sub-directory (&_src/routers_&,
41725 &_src/transports_&, &_src/auths_&, or &_src/lookups_&); add a line for the new
41726 driver or lookup type and add it to the definition of OBJ.
41727 .next
41728 Edit &_OS/Makefile-Base_& adding a &_.o_& file for the predefined-macros, to the
41729 definition of OBJ_MACRO.  Add a set of line to do the compile also.
41730 .next
41731 Create &_newdriver.h_& and &_newdriver.c_& in the appropriate sub-directory of
41732 &_src_&.
41733 .next
41734 Edit &_scripts/MakeLinks_& and add commands to link the &_.h_& and &_.c_& files
41735 as for other drivers and lookups.
41736 .endlist
41737
41738 Then all you need to do is write the code! A good way to start is to make a
41739 proforma by copying an existing module of the same type, globally changing all
41740 occurrences of the name, and cutting out most of the code. Note that any
41741 options you create must be listed in alphabetical order, because the tables are
41742 searched using a binary chop procedure.
41743
41744 There is a &_README_& file in each of the sub-directories of &_src_& describing
41745 the interface that is expected.
41746
41747
41748
41749
41750 . ////////////////////////////////////////////////////////////////////////////
41751 . ////////////////////////////////////////////////////////////////////////////
41752
41753 . /////////////////////////////////////////////////////////////////////////////
41754 . These lines are processing instructions for the Simple DocBook Processor that
41755 . Philip Hazel has developed as a less cumbersome way of making PostScript and
41756 . PDFs than using xmlto and fop. They will be ignored by all other XML
41757 . processors.
41758 . /////////////////////////////////////////////////////////////////////////////
41759
41760 .literal xml
41761 <?sdop
41762   format="newpage"
41763   foot_right_recto="&chaptertitle;"
41764   foot_right_verso="&chaptertitle;"
41765 ?>
41766 .literal off
41767
41768 .makeindex "Options index"   "option"
41769 .makeindex "Variables index" "variable"
41770 .makeindex "Concept index"   "concept"
41771
41772
41773 . /////////////////////////////////////////////////////////////////////////////
41774 . /////////////////////////////////////////////////////////////////////////////