OpenSSL: when supported by the library version, disable renegotiation for pre-TLS1.3
[users/heiko/exim.git] / doc / doc-docbook / spec.xfpt
1 . /////////////////////////////////////////////////////////////////////////////
2 . This is the primary source of the Exim Manual. It is an xfpt document that is
3 . converted into DocBook XML for subsequent conversion into printable and online
4 . formats. The markup used herein is "standard" xfpt markup, with some extras.
5 . The markup is summarized in a file called Markup.txt.
6 .
7 . WARNING: When you use the .new macro, make sure it appears *before* any
8 . adjacent index items; otherwise you get an empty "paragraph" which causes
9 . unwanted vertical space.
10 . /////////////////////////////////////////////////////////////////////////////
11
12 .include stdflags
13 .include stdmacs
14
15 . /////////////////////////////////////////////////////////////////////////////
16 . This outputs the standard DocBook boilerplate.
17 . /////////////////////////////////////////////////////////////////////////////
18
19 .docbook
20
21 . /////////////////////////////////////////////////////////////////////////////
22 . These lines are processing instructions for the Simple DocBook Processor that
23 . Philip Hazel has developed as a less cumbersome way of making PostScript and
24 . PDFs than using xmlto and fop. They will be ignored by all other XML
25 . processors.
26 . /////////////////////////////////////////////////////////////////////////////
27
28 .literal xml
29 <?sdop
30   foot_right_recto="&chaptertitle; (&chapternumber;)"
31   foot_right_verso="&chaptertitle; (&chapternumber;)"
32   toc_chapter_blanks="yes,yes"
33   table_warn_overflow="overprint"
34 ?>
35 .literal off
36
37 . /////////////////////////////////////////////////////////////////////////////
38 . This generates the outermost <book> element that wraps the entire document.
39 . /////////////////////////////////////////////////////////////////////////////
40
41 .book
42
43 . /////////////////////////////////////////////////////////////////////////////
44 . These definitions set some parameters and save some typing.
45 . Update the Copyright year (only) when changing content.
46 . /////////////////////////////////////////////////////////////////////////////
47
48 .set previousversion "4.92"
49 .include ./local_params
50
51 .set ACL "access control lists (ACLs)"
52 .set I   "&nbsp;&nbsp;&nbsp;&nbsp;"
53
54 .macro copyyear
55 2018, 2019
56 .endmacro
57
58 . /////////////////////////////////////////////////////////////////////////////
59 . Additional xfpt markup used by this document, over and above the default
60 . provided in the xfpt library.
61 . /////////////////////////////////////////////////////////////////////////////
62
63 . --- Override the &$ flag to automatically insert a $ with the variable name.
64
65 .flag &$  $&   "<varname>$"  "</varname>"
66
67 . --- Short flags for daggers in option headings. They will always be inside
68 . --- an italic string, but we want the daggers to be in Roman.
69
70 .flag &!!      "</emphasis>&dagger;<emphasis>"
71 .flag &!?      "</emphasis>&Dagger;<emphasis>"
72
73 . --- A macro for an Exim option definition heading, generating a one-line
74 . --- table with four columns. For cases when the option name is given with
75 . --- a space, so that it can be split, a fifth argument is used for the
76 . --- index entry.
77
78 .macro option
79 .arg 5
80 .oindex "&%$5%&"
81 .endarg
82 .arg -5
83 .oindex "&%$1%&"
84 .endarg
85 .itable all 0 0 4 8* left 6* center 6* center 6* right
86 .row "&%$1%&" "Use: &'$2'&" "Type: &'$3'&" "Default: &'$4'&"
87 .endtable
88 .endmacro
89
90 . --- A macro for the common 2-column tables. The width of the first column
91 . --- is suitable for the many tables at the start of the main options chapter;
92 . --- a small number of other 2-column tables override it.
93
94 .macro table2 196pt 254pt
95 .itable none 0 0 2 $1 left $2 left
96 .endmacro
97
98 . --- A macro that generates .row, but puts &I; at the start of the first
99 . --- argument, thus indenting it. Assume a minimum of two arguments, and
100 . --- allow up to four arguments, which is as many as we'll ever need.
101
102 .macro irow
103 .arg 4
104 .row "&I;$1" "$2" "$3" "$4"
105 .endarg
106 .arg -4
107 .arg 3
108 .row "&I;$1" "$2" "$3"
109 .endarg
110 .arg -3
111 .row "&I;$1" "$2"
112 .endarg
113 .endarg
114 .endmacro
115
116 . --- Macros for option, variable, and concept index entries. For a "range"
117 . --- style of entry, use .scindex for the start and .ecindex for the end. The
118 . --- first argument of .scindex and the only argument of .ecindex must be the
119 . --- ID that ties them together.
120
121 .macro cindex
122 &<indexterm role="concept">&
123 &<primary>&$1&</primary>&
124 .arg 2
125 &<secondary>&$2&</secondary>&
126 .endarg
127 &</indexterm>&
128 .endmacro
129
130 .macro scindex
131 &<indexterm role="concept" id="$1" class="startofrange">&
132 &<primary>&$2&</primary>&
133 .arg 3
134 &<secondary>&$3&</secondary>&
135 .endarg
136 &</indexterm>&
137 .endmacro
138
139 .macro ecindex
140 &<indexterm role="concept" startref="$1" class="endofrange"/>&
141 .endmacro
142
143 .macro oindex
144 &<indexterm role="option">&
145 &<primary>&$1&</primary>&
146 .arg 2
147 &<secondary>&$2&</secondary>&
148 .endarg
149 &</indexterm>&
150 .endmacro
151
152 .macro vindex
153 &<indexterm role="variable">&
154 &<primary>&$1&</primary>&
155 .arg 2
156 &<secondary>&$2&</secondary>&
157 .endarg
158 &</indexterm>&
159 .endmacro
160
161 .macro index
162 .echo "** Don't use .index; use .cindex or .oindex or .vindex"
163 .endmacro
164 . ////////////////////////////////////////////////////////////////////////////
165
166
167 . ////////////////////////////////////////////////////////////////////////////
168 . The <bookinfo> element is removed from the XML before processing for ASCII
169 . output formats.
170 . ////////////////////////////////////////////////////////////////////////////
171
172 .literal xml
173 <bookinfo>
174 <title>Specification of the Exim Mail Transfer Agent</title>
175 <titleabbrev>The Exim MTA</titleabbrev>
176 <date>
177 .fulldate
178 </date>
179 <author><firstname>Exim</firstname><surname>Maintainers</surname></author>
180 <authorinitials>EM</authorinitials>
181 <revhistory><revision>
182 .versiondatexml
183   <authorinitials>EM</authorinitials>
184 </revision></revhistory>
185 <copyright><year>
186 .copyyear
187            </year><holder>University of Cambridge</holder></copyright>
188 </bookinfo>
189 .literal off
190
191
192 . /////////////////////////////////////////////////////////////////////////////
193 . This chunk of literal XML implements index entries of the form "x, see y" and
194 . "x, see also y". However, the DocBook DTD doesn't allow <indexterm> entries
195 . at the top level, so we have to put the .chapter directive first.
196 . /////////////////////////////////////////////////////////////////////////////
197
198 .chapter "Introduction" "CHID1"
199 .literal xml
200
201 <indexterm role="variable">
202   <primary>$1, $2, etc.</primary>
203   <see><emphasis>numerical variables</emphasis></see>
204 </indexterm>
205 <indexterm role="concept">
206   <primary>address</primary>
207   <secondary>rewriting</secondary>
208   <see><emphasis>rewriting</emphasis></see>
209 </indexterm>
210 <indexterm role="concept">
211   <primary>Bounce Address Tag Validation</primary>
212   <see><emphasis>BATV</emphasis></see>
213 </indexterm>
214 <indexterm role="concept">
215   <primary>Client SMTP Authorization</primary>
216   <see><emphasis>CSA</emphasis></see>
217 </indexterm>
218 <indexterm role="concept">
219   <primary>CR character</primary>
220   <see><emphasis>carriage return</emphasis></see>
221 </indexterm>
222 <indexterm role="concept">
223   <primary>CRL</primary>
224   <see><emphasis>certificate revocation list</emphasis></see>
225 </indexterm>
226 <indexterm role="concept">
227   <primary>delivery</primary>
228   <secondary>failure report</secondary>
229   <see><emphasis>bounce message</emphasis></see>
230 </indexterm>
231 <indexterm role="concept">
232   <primary>dialup</primary>
233   <see><emphasis>intermittently connected hosts</emphasis></see>
234 </indexterm>
235 <indexterm role="concept">
236   <primary>exiscan</primary>
237   <see><emphasis>content scanning</emphasis></see>
238 </indexterm>
239 <indexterm role="concept">
240   <primary>failover</primary>
241   <see><emphasis>fallback</emphasis></see>
242 </indexterm>
243 <indexterm role="concept">
244   <primary>fallover</primary>
245   <see><emphasis>fallback</emphasis></see>
246 </indexterm>
247 <indexterm role="concept">
248   <primary>filter</primary>
249   <secondary>Sieve</secondary>
250   <see><emphasis>Sieve filter</emphasis></see>
251 </indexterm>
252 <indexterm role="concept">
253   <primary>ident</primary>
254   <see><emphasis>RFC 1413</emphasis></see>
255 </indexterm>
256 <indexterm role="concept">
257   <primary>LF character</primary>
258   <see><emphasis>linefeed</emphasis></see>
259 </indexterm>
260 <indexterm role="concept">
261   <primary>maximum</primary>
262   <seealso><emphasis>limit</emphasis></seealso>
263 </indexterm>
264 <indexterm role="concept">
265   <primary>monitor</primary>
266   <see><emphasis>Exim monitor</emphasis></see>
267 </indexterm>
268 <indexterm role="concept">
269   <primary>no_<emphasis>xxx</emphasis></primary>
270   <see>entry for xxx</see>
271 </indexterm>
272 <indexterm role="concept">
273   <primary>NUL</primary>
274   <see><emphasis>binary zero</emphasis></see>
275 </indexterm>
276 <indexterm role="concept">
277   <primary>passwd file</primary>
278   <see><emphasis>/etc/passwd</emphasis></see>
279 </indexterm>
280 <indexterm role="concept">
281   <primary>process id</primary>
282   <see><emphasis>pid</emphasis></see>
283 </indexterm>
284 <indexterm role="concept">
285   <primary>RBL</primary>
286   <see><emphasis>DNS list</emphasis></see>
287 </indexterm>
288 <indexterm role="concept">
289   <primary>redirection</primary>
290   <see><emphasis>address redirection</emphasis></see>
291 </indexterm>
292 <indexterm role="concept">
293   <primary>return path</primary>
294   <seealso><emphasis>envelope sender</emphasis></seealso>
295 </indexterm>
296 <indexterm role="concept">
297   <primary>scanning</primary>
298   <see><emphasis>content scanning</emphasis></see>
299 </indexterm>
300 <indexterm role="concept">
301   <primary>SSL</primary>
302   <see><emphasis>TLS</emphasis></see>
303 </indexterm>
304 <indexterm role="concept">
305   <primary>string</primary>
306   <secondary>expansion</secondary>
307   <see><emphasis>expansion</emphasis></see>
308 </indexterm>
309 <indexterm role="concept">
310   <primary>top bit</primary>
311   <see><emphasis>8-bit characters</emphasis></see>
312 </indexterm>
313 <indexterm role="concept">
314   <primary>variables</primary>
315   <see><emphasis>expansion, variables</emphasis></see>
316 </indexterm>
317 <indexterm role="concept">
318   <primary>zero, binary</primary>
319   <see><emphasis>binary zero</emphasis></see>
320 </indexterm>
321
322 .literal off
323
324
325 . /////////////////////////////////////////////////////////////////////////////
326 . This is the real start of the first chapter. See the comment above as to why
327 . we can't have the .chapter line here.
328 . chapter "Introduction"
329 . /////////////////////////////////////////////////////////////////////////////
330
331 Exim is a mail transfer agent (MTA) for hosts that are running Unix or
332 Unix-like operating systems. It was designed on the assumption that it would be
333 run on hosts that are permanently connected to the Internet. However, it can be
334 used on intermittently connected hosts with suitable configuration adjustments.
335
336 Configuration files currently exist for the following operating systems: AIX,
337 BSD/OS (aka BSDI), Darwin (Mac OS X), DGUX, Dragonfly, FreeBSD, GNU/Hurd,
338 GNU/Linux, HI-OSF (Hitachi), HI-UX, HP-UX, IRIX, MIPS RISCOS, NetBSD, OpenBSD,
339 OpenUNIX, QNX, SCO, SCO SVR4.2 (aka UNIX-SV), Solaris (aka SunOS5), SunOS4,
340 Tru64-Unix (formerly Digital UNIX, formerly DEC-OSF1), Ultrix, and UnixWare.
341 Some of these operating systems are no longer current and cannot easily be
342 tested, so the configuration files may no longer work in practice.
343
344 There are also configuration files for compiling Exim in the Cygwin environment
345 that can be installed on systems running Windows. However, this document does
346 not contain any information about running Exim in the Cygwin environment.
347
348 The terms and conditions for the use and distribution of Exim are contained in
349 the file &_NOTICE_&. Exim is distributed under the terms of the GNU General
350 Public Licence, a copy of which may be found in the file &_LICENCE_&.
351
352 The use, supply, or promotion of Exim for the purpose of sending bulk,
353 unsolicited electronic mail is incompatible with the basic aims of Exim,
354 which revolve around the free provision of a service that enhances the quality
355 of personal communications. The author of Exim regards indiscriminate
356 mass-mailing as an antisocial, irresponsible abuse of the Internet.
357
358 Exim owes a great deal to Smail 3 and its author, Ron Karr. Without the
359 experience of running and working on the Smail 3 code, I could never have
360 contemplated starting to write a new MTA. Many of the ideas and user interfaces
361 were originally taken from Smail 3, though the actual code of Exim is entirely
362 new, and has developed far beyond the initial concept.
363
364 Many people, both in Cambridge and around the world, have contributed to the
365 development and the testing of Exim, and to porting it to various operating
366 systems. I am grateful to them all. The distribution now contains a file called
367 &_ACKNOWLEDGMENTS_&, in which I have started recording the names of
368 contributors.
369
370
371 .section "Exim documentation" "SECID1"
372 . Keep this example change bar when updating the documentation!
373
374 .cindex "documentation"
375 This edition of the Exim specification applies to version &version() of Exim.
376 Substantive changes from the &previousversion; edition are marked in some
377 renditions of this document; this paragraph is so marked if the rendition is
378 capable of showing a change indicator.
379
380 This document is very much a reference manual; it is not a tutorial. The reader
381 is expected to have some familiarity with the SMTP mail transfer protocol and
382 with general Unix system administration. Although there are some discussions
383 and examples in places, the information is mostly organized in a way that makes
384 it easy to look up, rather than in a natural order for sequential reading.
385 Furthermore, this manual aims to cover every aspect of Exim in detail, including
386 a number of rarely-used, special-purpose features that are unlikely to be of
387 very wide interest.
388
389 .cindex "books about Exim"
390 An &"easier"& discussion of Exim which provides more in-depth explanatory,
391 introductory, and tutorial material can be found in a book entitled &'The Exim
392 SMTP Mail Server'& (second edition, 2007), published by UIT Cambridge
393 (&url(https://www.uit.co.uk/exim-book/)).
394
395 The book also contains a chapter that gives a general introduction to SMTP and
396 Internet mail. Inevitably, however, the book is unlikely to be fully up-to-date
397 with the latest release of Exim. (Note that the earlier book about Exim,
398 published by O'Reilly, covers Exim 3, and many things have changed in Exim 4.)
399
400 .cindex "Debian" "information sources"
401 If you are using a Debian distribution of Exim, you will find information about
402 Debian-specific features in the file
403 &_/usr/share/doc/exim4-base/README.Debian_&.
404 The command &(man update-exim.conf)& is another source of Debian-specific
405 information.
406
407 .cindex "&_doc/NewStuff_&"
408 .cindex "&_doc/ChangeLog_&"
409 .cindex "change log"
410 As Exim develops, there may be features in newer versions that have not
411 yet made it into this document, which is updated only when the most significant
412 digit of the fractional part of the version number changes. Specifications of
413 new features that are not yet in this manual are placed in the file
414 &_doc/NewStuff_& in the Exim distribution.
415
416 Some features may be classified as &"experimental"&. These may change
417 incompatibly while they are developing, or even be withdrawn. For this reason,
418 they are not documented in this manual. Information about experimental features
419 can be found in the file &_doc/experimental.txt_&.
420
421 All changes to Exim (whether new features, bug fixes, or other kinds of
422 change) are noted briefly in the file called &_doc/ChangeLog_&.
423
424 .cindex "&_doc/spec.txt_&"
425 This specification itself is available as an ASCII file in &_doc/spec.txt_& so
426 that it can easily be searched with a text editor. Other files in the &_doc_&
427 directory are:
428
429 .table2 100pt
430 .row &_OptionLists.txt_&     "list of all options in alphabetical order"
431 .row &_dbm.discuss.txt_&     "discussion about DBM libraries"
432 .row &_exim.8_&              "a man page of Exim's command line options"
433 .row &_experimental.txt_&    "documentation of experimental features"
434 .row &_filter.txt_&          "specification of the filter language"
435 .row &_Exim3.upgrade_&       "upgrade notes from release 2 to release 3"
436 .row &_Exim4.upgrade_&       "upgrade notes from release 3 to release 4"
437 .row &_openssl.txt_&         "installing a current OpenSSL release"
438 .endtable
439
440 The main specification and the specification of the filtering language are also
441 available in other formats (HTML, PostScript, PDF, and Texinfo). Section
442 &<<SECTavail>>& below tells you how to get hold of these.
443
444
445
446 .section "FTP site and websites" "SECID2"
447 .cindex "website"
448 .cindex "FTP site"
449 The primary site for Exim source distributions is the &%exim.org%& FTP site,
450 available over HTTPS, HTTP and FTP.  These services, and the &%exim.org%&
451 website, are hosted at the University of Cambridge.
452
453 .cindex "wiki"
454 .cindex "FAQ"
455 As well as Exim distribution tar files, the Exim website contains a number of
456 differently formatted versions of the documentation. A recent addition to the
457 online information is the Exim wiki (&url(https://wiki.exim.org)),
458 which contains what used to be a separate FAQ, as well as various other
459 examples, tips, and know-how that have been contributed by Exim users.
460 The wiki site should always redirect to the correct place, which is currently
461 provided by GitHub, and is open to editing by anyone with a GitHub account.
462
463 .cindex Bugzilla
464 An Exim Bugzilla exists at &url(https://bugs.exim.org). You can use
465 this to report bugs, and also to add items to the wish list. Please search
466 first to check that you are not duplicating a previous entry.
467 Please do not ask for configuration help in the bug-tracker.
468
469
470 .section "Mailing lists" "SECID3"
471 .cindex "mailing lists" "for Exim users"
472 The following Exim mailing lists exist:
473
474 .table2 140pt
475 .row &'exim-announce@exim.org'&   "Moderated, low volume announcements list"
476 .row &'exim-users@exim.org'&      "General discussion list"
477 .row &'exim-dev@exim.org'&        "Discussion of bugs, enhancements, etc."
478 .row &'exim-cvs@exim.org'&        "Automated commit messages from the VCS"
479 .endtable
480
481 You can subscribe to these lists, change your existing subscriptions, and view
482 or search the archives via the mailing lists link on the Exim home page.
483 .cindex "Debian" "mailing list for"
484 If you are using a Debian distribution of Exim, you may wish to subscribe to
485 the Debian-specific mailing list &'pkg-exim4-users@lists.alioth.debian.org'&
486 via this web page:
487 .display
488 &url(https://alioth-lists.debian.net/cgi-bin/mailman/listinfo/pkg-exim4-users)
489 .endd
490 Please ask Debian-specific questions on that list and not on the general Exim
491 lists.
492
493 .section "Bug reports" "SECID5"
494 .cindex "bug reports"
495 .cindex "reporting bugs"
496 Reports of obvious bugs can be emailed to &'bugs@exim.org'& or reported
497 via the Bugzilla (&url(https://bugs.exim.org)). However, if you are unsure
498 whether some behaviour is a bug or not, the best thing to do is to post a
499 message to the &'exim-dev'& mailing list and have it discussed.
500
501
502
503 .section "Where to find the Exim distribution" "SECTavail"
504 .cindex "FTP site"
505 .cindex "HTTPS download site"
506 .cindex "distribution" "FTP site"
507 .cindex "distribution" "https site"
508 The master distribution site for the Exim distribution is
509 .display
510 &url(https://downloads.exim.org/)
511 .endd
512 The service is available over HTTPS, HTTP and FTP.
513 We encourage people to migrate to HTTPS.
514
515 The content served at &url(https://downloads.exim.org/) is identical to the
516 content served at &url(https://ftp.exim.org/pub/exim) and
517 &url(ftp://ftp.exim.org/pub/exim).
518
519 If accessing via a hostname containing &'ftp'&, then the file references that
520 follow are relative to the &_exim_& directories at these sites.
521 If accessing via the hostname &'downloads'& then the subdirectories described
522 here are top-level directories.
523
524 There are now quite a number of independent mirror sites around
525 the world. Those that I know about are listed in the file called &_Mirrors_&.
526
527 Within the top exim directory there are subdirectories called &_exim3_& (for
528 previous Exim 3 distributions), &_exim4_& (for the latest Exim 4
529 distributions), and &_Testing_& for testing versions. In the &_exim4_&
530 subdirectory, the current release can always be found in files called
531 .display
532 &_exim-n.nn.tar.xz_&
533 &_exim-n.nn.tar.gz_&
534 &_exim-n.nn.tar.bz2_&
535 .endd
536 where &'n.nn'& is the highest such version number in the directory. The three
537 files contain identical data; the only difference is the type of compression.
538 The &_.xz_& file is usually the smallest, while the &_.gz_& file is the
539 most portable to old systems.
540
541 .cindex "distribution" "signing details"
542 .cindex "distribution" "public key"
543 .cindex "public key for signed distribution"
544 The distributions will be PGP signed by an individual key of the Release
545 Coordinator.  This key will have a uid containing an email address in the
546 &'exim.org'& domain and will have signatures from other people, including
547 other Exim maintainers.  We expect that the key will be in the "strong set" of
548 PGP keys.  There should be a trust path to that key from the Exim Maintainer's
549 PGP keys, a version of which can be found in the release directory in the file
550 &_Exim-Maintainers-Keyring.asc_&.  All keys used will be available in public keyserver pools,
551 such as &'pool.sks-keyservers.net'&.
552
553 At the time of the last update, releases were being made by Jeremy Harris and signed
554 with key &'0xBCE58C8CE41F32DF'&.  Other recent keys used for signing are those
555 of Heiko Schlittermann, &'0x26101B62F69376CE'&,
556 and of Phil Pennock, &'0x4D1E900E14C1CC04'&.
557
558 The signatures for the tar bundles are in:
559 .display
560 &_exim-n.nn.tar.xz.asc_&
561 &_exim-n.nn.tar.gz.asc_&
562 &_exim-n.nn.tar.bz2.asc_&
563 .endd
564 For each released version, the log of changes is made available in a
565 separate file in the directory &_ChangeLogs_& so that it is possible to
566 find out what has changed without having to download the entire distribution.
567
568 .cindex "documentation" "available formats"
569 The main distribution contains ASCII versions of this specification and other
570 documentation; other formats of the documents are available in separate files
571 inside the &_exim4_& directory of the FTP site:
572 .display
573 &_exim-html-n.nn.tar.gz_&
574 &_exim-pdf-n.nn.tar.gz_&
575 &_exim-postscript-n.nn.tar.gz_&
576 &_exim-texinfo-n.nn.tar.gz_&
577 .endd
578 These tar files contain only the &_doc_& directory, not the complete
579 distribution, and are also available in &_.bz2_& and &_.xz_& forms.
580
581
582 .section "Limitations" "SECID6"
583 .ilist
584 .cindex "limitations of Exim"
585 .cindex "bang paths" "not handled by Exim"
586 Exim is designed for use as an Internet MTA, and therefore handles addresses in
587 RFC 2822 domain format only. It cannot handle UUCP &"bang paths"&, though
588 simple two-component bang paths can be converted by a straightforward rewriting
589 configuration. This restriction does not prevent Exim from being interfaced to
590 UUCP as a transport mechanism, provided that domain addresses are used.
591 .next
592 .cindex "domainless addresses"
593 .cindex "address" "without domain"
594 Exim insists that every address it handles has a domain attached. For incoming
595 local messages, domainless addresses are automatically qualified with a
596 configured domain value. Configuration options specify from which remote
597 systems unqualified addresses are acceptable. These are then qualified on
598 arrival.
599 .next
600 .cindex "transport" "external"
601 .cindex "external transports"
602 The only external transport mechanisms that are currently implemented are SMTP
603 and LMTP over a TCP/IP network (including support for IPv6). However, a pipe
604 transport is available, and there are facilities for writing messages to files
605 and pipes, optionally in &'batched SMTP'& format; these facilities can be used
606 to send messages to other transport mechanisms such as UUCP, provided they can
607 handle domain-style addresses. Batched SMTP input is also catered for.
608 .next
609 Exim is not designed for storing mail for dial-in hosts. When the volumes of
610 such mail are large, it is better to get the messages &"delivered"& into files
611 (that is, off Exim's queue) and subsequently passed on to the dial-in hosts by
612 other means.
613 .next
614 Although Exim does have basic facilities for scanning incoming messages, these
615 are not comprehensive enough to do full virus or spam scanning. Such operations
616 are best carried out using additional specialized software packages. If you
617 compile Exim with the content-scanning extension, straightforward interfaces to
618 a number of common scanners are provided.
619 .endlist
620
621
622 .section "Runtime configuration" "SECID7"
623 Exim's runtime configuration is held in a single text file that is divided
624 into a number of sections. The entries in this file consist of keywords and
625 values, in the style of Smail 3 configuration files. A default configuration
626 file which is suitable for simple online installations is provided in the
627 distribution, and is described in chapter &<<CHAPdefconfil>>& below.
628
629
630 .section "Calling interface" "SECID8"
631 .cindex "Sendmail compatibility" "command line interface"
632 Like many MTAs, Exim has adopted the Sendmail command line interface so that it
633 can be a straight replacement for &_/usr/lib/sendmail_& or
634 &_/usr/sbin/sendmail_& when sending mail, but you do not need to know anything
635 about Sendmail in order to run Exim. For actions other than sending messages,
636 Sendmail-compatible options also exist, but those that produce output (for
637 example, &%-bp%&, which lists the messages in the queue) do so in Exim's own
638 format. There are also some additional options that are compatible with Smail
639 3, and some further options that are new to Exim. Chapter &<<CHAPcommandline>>&
640 documents all Exim's command line options. This information is automatically
641 made into the man page that forms part of the Exim distribution.
642
643 Control of messages in the queue can be done via certain privileged command
644 line options. There is also an optional monitor program called &'eximon'&,
645 which displays current information in an X window, and which contains a menu
646 interface to Exim's command line administration options.
647
648
649
650 .section "Terminology" "SECID9"
651 .cindex "terminology definitions"
652 .cindex "body of message" "definition of"
653 The &'body'& of a message is the actual data that the sender wants to transmit.
654 It is the last part of a message and is separated from the &'header'& (see
655 below) by a blank line.
656
657 .cindex "bounce message" "definition of"
658 When a message cannot be delivered, it is normally returned to the sender in a
659 delivery failure message or a &"non-delivery report"& (NDR). The term
660 &'bounce'& is commonly used for this action, and the error reports are often
661 called &'bounce messages'&. This is a convenient shorthand for &"delivery
662 failure error report"&. Such messages have an empty sender address in the
663 message's &'envelope'& (see below) to ensure that they cannot themselves give
664 rise to further bounce messages.
665
666 The term &'default'& appears frequently in this manual. It is used to qualify a
667 value which is used in the absence of any setting in the configuration. It may
668 also qualify an action which is taken unless a configuration setting specifies
669 otherwise.
670
671 The term &'defer'& is used when the delivery of a message to a specific
672 destination cannot immediately take place for some reason (a remote host may be
673 down, or a user's local mailbox may be full). Such deliveries are &'deferred'&
674 until a later time.
675
676 The word &'domain'& is sometimes used to mean all but the first component of a
677 host's name. It is &'not'& used in that sense here, where it normally refers to
678 the part of an email address following the @ sign.
679
680 .cindex "envelope, definition of"
681 .cindex "sender" "definition of"
682 A message in transit has an associated &'envelope'&, as well as a header and a
683 body. The envelope contains a sender address (to which bounce messages should
684 be delivered), and any number of recipient addresses. References to the
685 sender or the recipients of a message usually mean the addresses in the
686 envelope. An MTA uses these addresses for delivery, and for returning bounce
687 messages, not the addresses that appear in the header lines.
688
689 .cindex "message" "header, definition of"
690 .cindex "header section" "definition of"
691 The &'header'& of a message is the first part of a message's text, consisting
692 of a number of lines, each of which has a name such as &'From:'&, &'To:'&,
693 &'Subject:'&, etc. Long header lines can be split over several text lines by
694 indenting the continuations. The header is separated from the body by a blank
695 line.
696
697 .cindex "local part" "definition of"
698 .cindex "domain" "definition of"
699 The term &'local part'&, which is taken from RFC 2822, is used to refer to the
700 part of an email address that precedes the @ sign. The part that follows the
701 @ sign is called the &'domain'& or &'mail domain'&.
702
703 .cindex "local delivery" "definition of"
704 .cindex "remote delivery, definition of"
705 The terms &'local delivery'& and &'remote delivery'& are used to distinguish
706 delivery to a file or a pipe on the local host from delivery by SMTP over
707 TCP/IP to another host. As far as Exim is concerned, all hosts other than the
708 host it is running on are &'remote'&.
709
710 .cindex "return path" "definition of"
711 &'Return path'& is another name that is used for the sender address in a
712 message's envelope.
713
714 .cindex "queue" "definition of"
715 The term &'queue'& is used to refer to the set of messages awaiting delivery
716 because this term is in widespread use in the context of MTAs. However, in
717 Exim's case, the reality is more like a pool than a queue, because there is
718 normally no ordering of waiting messages.
719
720 .cindex "queue runner" "definition of"
721 The term &'queue runner'& is used to describe a process that scans the queue
722 and attempts to deliver those messages whose retry times have come. This term
723 is used by other MTAs and also relates to the command &%runq%&, but in Exim
724 the waiting messages are normally processed in an unpredictable order.
725
726 .cindex "spool directory" "definition of"
727 The term &'spool directory'& is used for a directory in which Exim keeps the
728 messages in its queue &-- that is, those that it is in the process of
729 delivering. This should not be confused with the directory in which local
730 mailboxes are stored, which is called a &"spool directory"& by some people. In
731 the Exim documentation, &"spool"& is always used in the first sense.
732
733
734
735
736
737
738 . ////////////////////////////////////////////////////////////////////////////
739 . ////////////////////////////////////////////////////////////////////////////
740
741 .chapter "Incorporated code" "CHID2"
742 .cindex "incorporated code"
743 .cindex "regular expressions" "library"
744 .cindex "PCRE"
745 .cindex "OpenDMARC"
746 A number of pieces of external code are included in the Exim distribution.
747
748 .ilist
749 Regular expressions are supported in the main Exim program and in the
750 Exim monitor using the freely-distributable PCRE library, copyright
751 &copy; University of Cambridge. The source to PCRE is no longer shipped with
752 Exim, so you will need to use the version of PCRE shipped with your system,
753 or obtain and install the full version of the library from
754 &url(ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre).
755 .next
756 .cindex "cdb" "acknowledgment"
757 Support for the cdb (Constant DataBase) lookup method is provided by code
758 contributed by Nigel Metheringham of (at the time he contributed it) Planet
759 Online Ltd. The implementation is completely contained within the code of Exim.
760 It does not link against an external cdb library. The code contains the
761 following statements:
762
763 .blockquote
764 Copyright &copy; 1998 Nigel Metheringham, Planet Online Ltd
765
766 This program is free software; you can redistribute it and/or modify it under
767 the terms of the GNU General Public License as published by the Free Software
768 Foundation; either version 2 of the License, or (at your option) any later
769 version.
770 This code implements Dan Bernstein's Constant DataBase (cdb) spec. Information,
771 the spec and sample code for cdb can be obtained from
772 &url(https://cr.yp.to/cdb.html). This implementation borrows
773 some code from Dan Bernstein's implementation (which has no license
774 restrictions applied to it).
775 .endblockquote
776 .next
777 .cindex "SPA authentication"
778 .cindex "Samba project"
779 .cindex "Microsoft Secure Password Authentication"
780 Client support for Microsoft's &'Secure Password Authentication'& is provided
781 by code contributed by Marc Prud'hommeaux. Server support was contributed by
782 Tom Kistner. This includes code taken from the Samba project, which is released
783 under the Gnu GPL.
784 .next
785 .cindex "Cyrus"
786 .cindex "&'pwcheck'& daemon"
787 .cindex "&'pwauthd'& daemon"
788 Support for calling the Cyrus &'pwcheck'& and &'saslauthd'& daemons is provided
789 by code taken from the Cyrus-SASL library and adapted by Alexander S.
790 Sabourenkov. The permission notice appears below, in accordance with the
791 conditions expressed therein.
792
793 .blockquote
794 Copyright &copy; 2001 Carnegie Mellon University.  All rights reserved.
795
796 Redistribution and use in source and binary forms, with or without
797 modification, are permitted provided that the following conditions
798 are met:
799
800 .olist
801 Redistributions of source code must retain the above copyright
802 notice, this list of conditions and the following disclaimer.
803 .next
804 Redistributions in binary form must reproduce the above copyright
805 notice, this list of conditions and the following disclaimer in
806 the documentation and/or other materials provided with the
807 distribution.
808 .next
809 The name &"Carnegie Mellon University"& must not be used to
810 endorse or promote products derived from this software without
811 prior written permission. For permission or any other legal
812 details, please contact
813 .display
814               Office of Technology Transfer
815               Carnegie Mellon University
816               5000 Forbes Avenue
817               Pittsburgh, PA  15213-3890
818               (412) 268-4387, fax: (412) 268-7395
819               tech-transfer@andrew.cmu.edu
820 .endd
821 .next
822 Redistributions of any form whatsoever must retain the following
823 acknowledgment:
824
825 &"This product includes software developed by Computing Services
826 at Carnegie Mellon University (&url(https://www.cmu.edu/computing/)."&
827
828 CARNEGIE MELLON UNIVERSITY DISCLAIMS ALL WARRANTIES WITH REGARD TO
829 THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
830 AND FITNESS, IN NO EVENT SHALL CARNEGIE MELLON UNIVERSITY BE LIABLE
831 FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
832 WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN
833 AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING
834 OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
835 .endlist
836 .endblockquote
837
838 .next
839 .cindex "Exim monitor" "acknowledgment"
840 .cindex "X-windows"
841 .cindex "Athena"
842 The Exim Monitor program, which is an X-Window application, includes
843 modified versions of the Athena StripChart and TextPop widgets.
844 This code is copyright by DEC and MIT, and their permission notice appears
845 below, in accordance with the conditions expressed therein.
846
847 .blockquote
848 Copyright 1987, 1988 by Digital Equipment Corporation, Maynard, Massachusetts,
849 and the Massachusetts Institute of Technology, Cambridge, Massachusetts.
850
851 All Rights Reserved
852
853 Permission to use, copy, modify, and distribute this software and its
854 documentation for any purpose and without fee is hereby granted,
855 provided that the above copyright notice appear in all copies and that
856 both that copyright notice and this permission notice appear in
857 supporting documentation, and that the names of Digital or MIT not be
858 used in advertising or publicity pertaining to distribution of the
859 software without specific, written prior permission.
860
861 DIGITAL DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING
862 ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL
863 DIGITAL BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR
864 ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
865 WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION,
866 ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
867 SOFTWARE.
868 .endblockquote
869
870 .next
871 .cindex "opendmarc" "acknowledgment"
872 The DMARC implementation uses the OpenDMARC library which is Copyrighted by
873 The Trusted Domain Project. Portions of Exim source which use OpenDMARC
874 derived code are indicated in the respective source files. The full OpenDMARC
875 license is provided in the LICENSE.opendmarc file contained in the distributed
876 source code.
877
878 .next
879 Many people have contributed code fragments, some large, some small, that were
880 not covered by any specific license requirements. It is assumed that the
881 contributors are happy to see their code incorporated into Exim under the GPL.
882 .endlist
883
884
885
886
887
888 . ////////////////////////////////////////////////////////////////////////////
889 . ////////////////////////////////////////////////////////////////////////////
890
891 .chapter "How Exim receives and delivers mail" "CHID11" &&&
892          "Receiving and delivering mail"
893
894
895 .section "Overall philosophy" "SECID10"
896 .cindex "design philosophy"
897 Exim is designed to work efficiently on systems that are permanently connected
898 to the Internet and are handling a general mix of mail. In such circumstances,
899 most messages can be delivered immediately. Consequently, Exim does not
900 maintain independent queues of messages for specific domains or hosts, though
901 it does try to send several messages in a single SMTP connection after a host
902 has been down, and it also maintains per-host retry information.
903
904
905 .section "Policy control" "SECID11"
906 .cindex "policy control" "overview"
907 Policy controls are now an important feature of MTAs that are connected to the
908 Internet. Perhaps their most important job is to stop MTAs from being abused as
909 &"open relays"& by misguided individuals who send out vast amounts of
910 unsolicited junk and want to disguise its source. Exim provides flexible
911 facilities for specifying policy controls on incoming mail:
912
913 .ilist
914 .cindex "&ACL;" "introduction"
915 Exim 4 (unlike previous versions of Exim) implements policy controls on
916 incoming mail by means of &'Access Control Lists'& (ACLs). Each list is a
917 series of statements that may either grant or deny access. ACLs can be used at
918 several places in the SMTP dialogue while receiving a message from a remote
919 host. However, the most common places are after each RCPT command, and at the
920 very end of the message. The sysadmin can specify conditions for accepting or
921 rejecting individual recipients or the entire message, respectively, at these
922 two points (see chapter &<<CHAPACL>>&). Denial of access results in an SMTP
923 error code.
924 .next
925 An ACL is also available for locally generated, non-SMTP messages. In this
926 case, the only available actions are to accept or deny the entire message.
927 .next
928 When Exim is compiled with the content-scanning extension, facilities are
929 provided in the ACL mechanism for passing the message to external virus and/or
930 spam scanning software. The result of such a scan is passed back to the ACL,
931 which can then use it to decide what to do with the message.
932 .next
933 When a message has been received, either from a remote host or from the local
934 host, but before the final acknowledgment has been sent, a locally supplied C
935 function called &[local_scan()]& can be run to inspect the message and decide
936 whether to accept it or not (see chapter &<<CHAPlocalscan>>&). If the message
937 is accepted, the list of recipients can be modified by the function.
938 .next
939 Using the &[local_scan()]& mechanism is another way of calling external scanner
940 software. The &%SA-Exim%& add-on package works this way. It does not require
941 Exim to be compiled with the content-scanning extension.
942 .next
943 After a message has been accepted, a further checking mechanism is available in
944 the form of the &'system filter'& (see chapter &<<CHAPsystemfilter>>&). This
945 runs at the start of every delivery process.
946 .endlist
947
948
949
950 .section "User filters" "SECID12"
951 .cindex "filter" "introduction"
952 .cindex "Sieve filter"
953 In a conventional Exim configuration, users are able to run private filters by
954 setting up appropriate &_.forward_& files in their home directories. See
955 chapter &<<CHAPredirect>>& (about the &(redirect)& router) for the
956 configuration needed to support this, and the separate document entitled
957 &'Exim's interfaces to mail filtering'& for user details. Two different kinds
958 of filtering are available:
959
960 .ilist
961 Sieve filters are written in the standard filtering language that is defined
962 by RFC 3028.
963 .next
964 Exim filters are written in a syntax that is unique to Exim, but which is more
965 powerful than Sieve, which it pre-dates.
966 .endlist
967
968 User filters are run as part of the routing process, described below.
969
970
971
972 .section "Message identification" "SECTmessiden"
973 .cindex "message ids" "details of format"
974 .cindex "format" "of message id"
975 .cindex "id of message"
976 .cindex "base62"
977 .cindex "base36"
978 .cindex "Darwin"
979 .cindex "Cygwin"
980 Every message handled by Exim is given a &'message id'& which is sixteen
981 characters long. It is divided into three parts, separated by hyphens, for
982 example &`16VDhn-0001bo-D3`&. Each part is a sequence of letters and digits,
983 normally encoding numbers in base 62. However, in the Darwin operating
984 system (Mac OS X) and when Exim is compiled to run under Cygwin, base 36
985 (avoiding the use of lower case letters) is used instead, because the message
986 id is used to construct filenames, and the names of files in those systems are
987 not always case-sensitive.
988
989 .cindex "pid (process id)" "re-use of"
990 The detail of the contents of the message id have changed as Exim has evolved.
991 Earlier versions relied on the operating system not re-using a process id (pid)
992 within one second. On modern operating systems, this assumption can no longer
993 be made, so the algorithm had to be changed. To retain backward compatibility,
994 the format of the message id was retained, which is why the following rules are
995 somewhat eccentric:
996
997 .ilist
998 The first six characters of the message id are the time at which the message
999 started to be received, to a granularity of one second. That is, this field
1000 contains the number of seconds since the start of the epoch (the normal Unix
1001 way of representing the date and time of day).
1002 .next
1003 After the first hyphen, the next six characters are the id of the process that
1004 received the message.
1005 .next
1006 There are two different possibilities for the final two characters:
1007 .olist
1008 .oindex "&%localhost_number%&"
1009 If &%localhost_number%& is not set, this value is the fractional part of the
1010 time of reception, normally in units of 1/2000 of a second, but for systems
1011 that must use base 36 instead of base 62 (because of case-insensitive file
1012 systems), the units are 1/1000 of a second.
1013 .next
1014 If &%localhost_number%& is set, it is multiplied by 200 (100) and added to
1015 the fractional part of the time, which in this case is in units of 1/200
1016 (1/100) of a second.
1017 .endlist
1018 .endlist
1019
1020 After a message has been received, Exim waits for the clock to tick at the
1021 appropriate resolution before proceeding, so that if another message is
1022 received by the same process, or by another process with the same (re-used)
1023 pid, it is guaranteed that the time will be different. In most cases, the clock
1024 will already have ticked while the message was being received.
1025
1026
1027 .section "Receiving mail" "SECID13"
1028 .cindex "receiving mail"
1029 .cindex "message" "reception"
1030 The only way Exim can receive mail from another host is using SMTP over
1031 TCP/IP, in which case the sender and recipient addresses are transferred using
1032 SMTP commands. However, from a locally running process (such as a user's MUA),
1033 there are several possibilities:
1034
1035 .ilist
1036 If the process runs Exim with the &%-bm%& option, the message is read
1037 non-interactively (usually via a pipe), with the recipients taken from the
1038 command line, or from the body of the message if &%-t%& is also used.
1039 .next
1040 If the process runs Exim with the &%-bS%& option, the message is also read
1041 non-interactively, but in this case the recipients are listed at the start of
1042 the message in a series of SMTP RCPT commands, terminated by a DATA
1043 command. This is called &"batch SMTP"& format,
1044 but it isn't really SMTP. The SMTP commands are just another way of passing
1045 envelope addresses in a non-interactive submission.
1046 .next
1047 If the process runs Exim with the &%-bs%& option, the message is read
1048 interactively, using the SMTP protocol. A two-way pipe is normally used for
1049 passing data between the local process and the Exim process.
1050 This is &"real"& SMTP and is handled in the same way as SMTP over TCP/IP. For
1051 example, the ACLs for SMTP commands are used for this form of submission.
1052 .next
1053 A local process may also make a TCP/IP call to the host's loopback address
1054 (127.0.0.1) or any other of its IP addresses. When receiving messages, Exim
1055 does not treat the loopback address specially. It treats all such connections
1056 in the same way as connections from other hosts.
1057 .endlist
1058
1059
1060 .cindex "message sender, constructed by Exim"
1061 .cindex "sender" "constructed by Exim"
1062 In the three cases that do not involve TCP/IP, the sender address is
1063 constructed from the login name of the user that called Exim and a default
1064 qualification domain (which can be set by the &%qualify_domain%& configuration
1065 option). For local or batch SMTP, a sender address that is passed using the
1066 SMTP MAIL command is ignored. However, the system administrator may allow
1067 certain users (&"trusted users"&) to specify a different sender addresses
1068 unconditionally, or all users to specify certain forms of different sender
1069 address. The &%-f%& option or the SMTP MAIL command is used to specify these
1070 different addresses. See section &<<SECTtrustedadmin>>& for details of trusted
1071 users, and the &%untrusted_set_sender%& option for a way of allowing untrusted
1072 users to change sender addresses.
1073
1074 Messages received by either of the non-interactive mechanisms are subject to
1075 checking by the non-SMTP ACL if one is defined. Messages received using SMTP
1076 (either over TCP/IP or interacting with a local process) can be checked by a
1077 number of ACLs that operate at different times during the SMTP session. Either
1078 individual recipients or the entire message can be rejected if local policy
1079 requirements are not met. The &[local_scan()]& function (see chapter
1080 &<<CHAPlocalscan>>&) is run for all incoming messages.
1081
1082 Exim can be configured not to start a delivery process when a message is
1083 received; this can be unconditional, or depend on the number of incoming SMTP
1084 connections or the system load. In these situations, new messages wait on the
1085 queue until a queue runner process picks them up. However, in standard
1086 configurations under normal conditions, delivery is started as soon as a
1087 message is received.
1088
1089
1090
1091
1092
1093 .section "Handling an incoming message" "SECID14"
1094 .cindex "spool directory" "files that hold a message"
1095 .cindex "file" "how a message is held"
1096 When Exim accepts a message, it writes two files in its spool directory. The
1097 first contains the envelope information, the current status of the message, and
1098 the header lines, and the second contains the body of the message. The names of
1099 the two spool files consist of the message id, followed by &`-H`& for the
1100 file containing the envelope and header, and &`-D`& for the data file.
1101
1102 .cindex "spool directory" "&_input_& sub-directory"
1103 By default, all these message files are held in a single directory called
1104 &_input_& inside the general Exim spool directory. Some operating systems do
1105 not perform very well if the number of files in a directory gets large; to
1106 improve performance in such cases, the &%split_spool_directory%& option can be
1107 used. This causes Exim to split up the input files into 62 sub-directories
1108 whose names are single letters or digits. When this is done, the queue is
1109 processed one sub-directory at a time instead of all at once, which can improve
1110 overall performance even when there are not enough files in each directory to
1111 affect file system performance.
1112
1113 The envelope information consists of the address of the message's sender and
1114 the addresses of the recipients. This information is entirely separate from
1115 any addresses contained in the header lines. The status of the message includes
1116 a list of recipients who have already received the message. The format of the
1117 first spool file is described in chapter &<<CHAPspool>>&.
1118
1119 .cindex "rewriting" "addresses"
1120 Address rewriting that is specified in the rewrite section of the configuration
1121 (see chapter &<<CHAPrewrite>>&) is done once and for all on incoming addresses,
1122 both in the header lines and the envelope, at the time the message is accepted.
1123 If during the course of delivery additional addresses are generated (for
1124 example, via aliasing), these new addresses are rewritten as soon as they are
1125 generated. At the time a message is actually delivered (transported) further
1126 rewriting can take place; because this is a transport option, it can be
1127 different for different forms of delivery. It is also possible to specify the
1128 addition or removal of certain header lines at the time the message is
1129 delivered (see chapters &<<CHAProutergeneric>>& and
1130 &<<CHAPtransportgeneric>>&).
1131
1132
1133
1134 .section "Life of a message" "SECID15"
1135 .cindex "message" "life of"
1136 .cindex "message" "frozen"
1137 A message remains in the spool directory until it is completely delivered to
1138 its recipients or to an error address, or until it is deleted by an
1139 administrator or by the user who originally created it. In cases when delivery
1140 cannot proceed &-- for example when a message can neither be delivered to its
1141 recipients nor returned to its sender, the message is marked &"frozen"& on the
1142 spool, and no more deliveries are attempted.
1143
1144 .cindex "frozen messages" "thawing"
1145 .cindex "message" "thawing frozen"
1146 An administrator can &"thaw"& such messages when the problem has been
1147 corrected, and can also freeze individual messages by hand if necessary. In
1148 addition, an administrator can force a delivery error, causing a bounce message
1149 to be sent.
1150
1151 .oindex "&%timeout_frozen_after%&"
1152 .oindex "&%ignore_bounce_errors_after%&"
1153 There are options called &%ignore_bounce_errors_after%& and
1154 &%timeout_frozen_after%&, which discard frozen messages after a certain time.
1155 The first applies only to frozen bounces, the second to all frozen messages.
1156
1157 .cindex "message" "log file for"
1158 .cindex "log" "file for each message"
1159 While Exim is working on a message, it writes information about each delivery
1160 attempt to its main log file. This includes successful, unsuccessful, and
1161 delayed deliveries for each recipient (see chapter &<<CHAPlog>>&). The log
1162 lines are also written to a separate &'message log'& file for each message.
1163 These logs are solely for the benefit of the administrator and are normally
1164 deleted along with the spool files when processing of a message is complete.
1165 The use of individual message logs can be disabled by setting
1166 &%no_message_logs%&; this might give an improvement in performance on very busy
1167 systems.
1168
1169 .cindex "journal file"
1170 .cindex "file" "journal"
1171 All the information Exim itself needs to set up a delivery is kept in the first
1172 spool file, along with the header lines. When a successful delivery occurs, the
1173 address is immediately written at the end of a journal file, whose name is the
1174 message id followed by &`-J`&. At the end of a delivery run, if there are some
1175 addresses left to be tried again later, the first spool file (the &`-H`& file)
1176 is updated to indicate which these are, and the journal file is then deleted.
1177 Updating the spool file is done by writing a new file and renaming it, to
1178 minimize the possibility of data loss.
1179
1180 Should the system or Exim crash after a successful delivery but before
1181 the spool file has been updated, the journal is left lying around. The next
1182 time Exim attempts to deliver the message, it reads the journal file and
1183 updates the spool file before proceeding. This minimizes the chances of double
1184 deliveries caused by crashes.
1185
1186
1187
1188 .section "Processing an address for delivery" "SECTprocaddress"
1189 .cindex "drivers" "definition of"
1190 .cindex "router" "definition of"
1191 .cindex "transport" "definition of"
1192 The main delivery processing elements of Exim are called &'routers'& and
1193 &'transports'&, and collectively these are known as &'drivers'&. Code for a
1194 number of them is provided in the source distribution, and compile-time options
1195 specify which ones are included in the binary. Runtime options specify which
1196 ones are actually used for delivering messages.
1197
1198 .cindex "drivers" "instance definition"
1199 Each driver that is specified in the runtime configuration is an &'instance'&
1200 of that particular driver type. Multiple instances are allowed; for example,
1201 you can set up several different &(smtp)& transports, each with different
1202 option values that might specify different ports or different timeouts. Each
1203 instance has its own identifying name. In what follows we will normally use the
1204 instance name when discussing one particular instance (that is, one specific
1205 configuration of the driver), and the generic driver name when discussing
1206 the driver's features in general.
1207
1208 A &'router'& is a driver that operates on an address, either determining how
1209 its delivery should happen, by assigning it to a specific transport, or
1210 converting the address into one or more new addresses (for example, via an
1211 alias file). A router may also explicitly choose to fail an address, causing it
1212 to be bounced.
1213
1214 A &'transport'& is a driver that transmits a copy of the message from Exim's
1215 spool to some destination. There are two kinds of transport: for a &'local'&
1216 transport, the destination is a file or a pipe on the local host, whereas for a
1217 &'remote'& transport the destination is some other host. A message is passed
1218 to a specific transport as a result of successful routing. If a message has
1219 several recipients, it may be passed to a number of different transports.
1220
1221 .cindex "preconditions" "definition of"
1222 An address is processed by passing it to each configured router instance in
1223 turn, subject to certain preconditions, until a router accepts the address or
1224 specifies that it should be bounced. We will describe this process in more
1225 detail shortly. First, as a simple example, we consider how each recipient
1226 address in a message is processed in a small configuration of three routers.
1227
1228 To make this a more concrete example, it is described in terms of some actual
1229 routers, but remember, this is only an example. You can configure Exim's
1230 routers in many different ways, and there may be any number of routers in a
1231 configuration.
1232
1233 The first router that is specified in a configuration is often one that handles
1234 addresses in domains that are not recognized specifically by the local host.
1235 Typically these are addresses for arbitrary domains on the Internet. A precondition
1236 is set up which looks for the special domains known to the host (for example,
1237 its own domain name), and the router is run for addresses that do &'not'&
1238 match. Typically, this is a router that looks up domains in the DNS in order to
1239 find the hosts to which this address routes. If it succeeds, the address is
1240 assigned to a suitable SMTP transport; if it does not succeed, the router is
1241 configured to fail the address.
1242
1243 The second router is reached only when the domain is recognized as one that
1244 &"belongs"& to the local host. This router does redirection &-- also known as
1245 aliasing and forwarding. When it generates one or more new addresses from the
1246 original, each of them is routed independently from the start. Otherwise, the
1247 router may cause an address to fail, or it may simply decline to handle the
1248 address, in which case the address is passed to the next router.
1249
1250 The final router in many configurations is one that checks to see if the
1251 address belongs to a local mailbox. The precondition may involve a check to
1252 see if the local part is the name of a login account, or it may look up the
1253 local part in a file or a database. If its preconditions are not met, or if
1254 the router declines, we have reached the end of the routers. When this happens,
1255 the address is bounced.
1256
1257
1258
1259 .section "Processing an address for verification" "SECID16"
1260 .cindex "router" "for verification"
1261 .cindex "verifying address" "overview"
1262 As well as being used to decide how to deliver to an address, Exim's routers
1263 are also used for &'address verification'&. Verification can be requested as
1264 one of the checks to be performed in an ACL for incoming messages, on both
1265 sender and recipient addresses, and it can be tested using the &%-bv%& and
1266 &%-bvs%& command line options.
1267
1268 When an address is being verified, the routers are run in &"verify mode"&. This
1269 does not affect the way the routers work, but it is a state that can be
1270 detected. By this means, a router can be skipped or made to behave differently
1271 when verifying. A common example is a configuration in which the first router
1272 sends all messages to a message-scanning program unless they have been
1273 previously scanned. Thus, the first router accepts all addresses without any
1274 checking, making it useless for verifying. Normally, the &%no_verify%& option
1275 would be set for such a router, causing it to be skipped in verify mode.
1276
1277
1278
1279
1280 .section "Running an individual router" "SECTrunindrou"
1281 .cindex "router" "running details"
1282 .cindex "preconditions" "checking"
1283 .cindex "router" "result of running"
1284 As explained in the example above, a number of preconditions are checked before
1285 running a router. If any are not met, the router is skipped, and the address is
1286 passed to the next router. When all the preconditions on a router &'are'& met,
1287 the router is run. What happens next depends on the outcome, which is one of
1288 the following:
1289
1290 .ilist
1291 &'accept'&: The router accepts the address, and either assigns it to a
1292 transport or generates one or more &"child"& addresses. Processing the
1293 original address ceases
1294 .oindex "&%unseen%&"
1295 unless the &%unseen%& option is set on the router. This option
1296 can be used to set up multiple deliveries with different routing (for example,
1297 for keeping archive copies of messages). When &%unseen%& is set, the address is
1298 passed to the next router. Normally, however, an &'accept'& return marks the
1299 end of routing.
1300
1301 Any child addresses generated by the router are processed independently,
1302 starting with the first router by default. It is possible to change this by
1303 setting the &%redirect_router%& option to specify which router to start at for
1304 child addresses. Unlike &%pass_router%& (see below) the router specified by
1305 &%redirect_router%& may be anywhere in the router configuration.
1306 .next
1307 &'pass'&: The router recognizes the address, but cannot handle it itself. It
1308 requests that the address be passed to another router. By default, the address
1309 is passed to the next router, but this can be changed by setting the
1310 &%pass_router%& option. However, (unlike &%redirect_router%&) the named router
1311 must be below the current router (to avoid loops).
1312 .next
1313 &'decline'&: The router declines to accept the address because it does not
1314 recognize it at all. By default, the address is passed to the next router, but
1315 this can be prevented by setting the &%no_more%& option. When &%no_more%& is
1316 set, all the remaining routers are skipped. In effect, &%no_more%& converts
1317 &'decline'& into &'fail'&.
1318 .next
1319 &'fail'&: The router determines that the address should fail, and queues it for
1320 the generation of a bounce message. There is no further processing of the
1321 original address unless &%unseen%& is set on the router.
1322 .next
1323 &'defer'&: The router cannot handle the address at the present time. (A
1324 database may be offline, or a DNS lookup may have timed out.) No further
1325 processing of the address happens in this delivery attempt. It is tried again
1326 next time the message is considered for delivery.
1327 .next
1328 &'error'&: There is some error in the router (for example, a syntax error in
1329 its configuration). The action is as for defer.
1330 .endlist
1331
1332 If an address reaches the end of the routers without having been accepted by
1333 any of them, it is bounced as unrouteable. The default error message in this
1334 situation is &"unrouteable address"&, but you can set your own message by
1335 making use of the &%cannot_route_message%& option. This can be set for any
1336 router; the value from the last router that &"saw"& the address is used.
1337
1338 Sometimes while routing you want to fail a delivery when some conditions are
1339 met but others are not, instead of passing the address on for further routing.
1340 You can do this by having a second router that explicitly fails the delivery
1341 when the relevant conditions are met. The &(redirect)& router has a &"fail"&
1342 facility for this purpose.
1343
1344
1345 .section "Duplicate addresses" "SECID17"
1346 .cindex "case of local parts"
1347 .cindex "address duplicate, discarding"
1348 .cindex "duplicate addresses"
1349 Once routing is complete, Exim scans the addresses that are assigned to local
1350 and remote transports and discards any duplicates that it finds. During this
1351 check, local parts are treated case-sensitively. This happens only when
1352 actually delivering a message; when testing routers with &%-bt%&, all the
1353 routed addresses are shown.
1354
1355
1356
1357 .section "Router preconditions" "SECTrouprecon"
1358 .cindex "router" "preconditions, order of processing"
1359 .cindex "preconditions" "order of processing"
1360 The preconditions that are tested for each router are listed below, in the
1361 order in which they are tested. The individual configuration options are
1362 described in more detail in chapter &<<CHAProutergeneric>>&.
1363
1364 .ilist
1365 .cindex affix "router precondition"
1366 The &%local_part_prefix%& and &%local_part_suffix%& options can specify that
1367 the local parts handled by the router may or must have certain prefixes and/or
1368 suffixes. If a mandatory affix (prefix or suffix) is not present, the router is
1369 skipped. These conditions are tested first. When an affix is present, it is
1370 removed from the local part before further processing, including the evaluation
1371 of any other conditions.
1372 .next
1373 Routers can be designated for use only when not verifying an address, that is,
1374 only when routing it for delivery (or testing its delivery routing). If the
1375 &%verify%& option is set false, the router is skipped when Exim is verifying an
1376 address.
1377 Setting the &%verify%& option actually sets two options, &%verify_sender%& and
1378 &%verify_recipient%&, which independently control the use of the router for
1379 sender and recipient verification. You can set these options directly if
1380 you want a router to be used for only one type of verification.
1381 Note that cutthrough delivery is classed as a recipient verification for this purpose.
1382 .next
1383 If the &%address_test%& option is set false, the router is skipped when Exim is
1384 run with the &%-bt%& option to test an address routing. This can be helpful
1385 when the first router sends all new messages to a scanner of some sort; it
1386 makes it possible to use &%-bt%& to test subsequent delivery routing without
1387 having to simulate the effect of the scanner.
1388 .next
1389 Routers can be designated for use only when verifying an address, as
1390 opposed to routing it for delivery. The &%verify_only%& option controls this.
1391 Again, cutthrough delivery counts as a verification.
1392 .next
1393 Individual routers can be explicitly skipped when running the routers to
1394 check an address given in the SMTP EXPN command (see the &%expn%& option).
1395 .next
1396 If the &%domains%& option is set, the domain of the address must be in the set
1397 of domains that it defines.
1398 .next
1399 .vindex "&$local_part_prefix$&"
1400 .vindex "&$local_part$&"
1401 .vindex "&$local_part_suffix$&"
1402 .cindex affix "router precondition"
1403 If the &%local_parts%& option is set, the local part of the address must be in
1404 the set of local parts that it defines. If &%local_part_prefix%& or
1405 &%local_part_suffix%& is in use, the prefix or suffix is removed from the local
1406 part before this check. If you want to do precondition tests on local parts
1407 that include affixes, you can do so by using a &%condition%& option (see below)
1408 that uses the variables &$local_part$&, &$local_part_prefix$&, and
1409 &$local_part_suffix$& as necessary.
1410 .next
1411 .vindex "&$local_user_uid$&"
1412 .vindex "&$local_user_gid$&"
1413 .vindex "&$home$&"
1414 If the &%check_local_user%& option is set, the local part must be the name of
1415 an account on the local host. If this check succeeds, the uid and gid of the
1416 local user are placed in &$local_user_uid$& and &$local_user_gid$& and the
1417 user's home directory is placed in &$home$&; these values can be used in the
1418 remaining preconditions.
1419 .next
1420 If the &%router_home_directory%& option is set, it is expanded at this point,
1421 because it overrides the value of &$home$&. If this expansion were left till
1422 later, the value of &$home$& as set by &%check_local_user%& would be used in
1423 subsequent tests. Having two different values of &$home$& in the same router
1424 could lead to confusion.
1425 .next
1426 If the &%senders%& option is set, the envelope sender address must be in the
1427 set of addresses that it defines.
1428 .next
1429 If the &%require_files%& option is set, the existence or non-existence of
1430 specified files is tested.
1431 .next
1432 .cindex "customizing" "precondition"
1433 If the &%condition%& option is set, it is evaluated and tested. This option
1434 uses an expanded string to allow you to set up your own custom preconditions.
1435 Expanded strings are described in chapter &<<CHAPexpand>>&.
1436 .endlist
1437
1438
1439 Note that &%require_files%& comes near the end of the list, so you cannot use
1440 it to check for the existence of a file in which to lookup up a domain, local
1441 part, or sender. However, as these options are all expanded, you can use the
1442 &%exists%& expansion condition to make such tests within each condition. The
1443 &%require_files%& option is intended for checking files that the router may be
1444 going to use internally, or which are needed by a specific transport (for
1445 example, &_.procmailrc_&).
1446
1447
1448
1449 .section "Delivery in detail" "SECID18"
1450 .cindex "delivery" "in detail"
1451 When a message is to be delivered, the sequence of events is as follows:
1452
1453 .ilist
1454 If a system-wide filter file is specified, the message is passed to it. The
1455 filter may add recipients to the message, replace the recipients, discard the
1456 message, cause a new message to be generated, or cause the message delivery to
1457 fail. The format of the system filter file is the same as for Exim user filter
1458 files, described in the separate document entitled &'Exim's interfaces to mail
1459 filtering'&.
1460 .cindex "Sieve filter" "not available for system filter"
1461 (&*Note*&: Sieve cannot be used for system filter files.)
1462
1463 Some additional features are available in system filters &-- see chapter
1464 &<<CHAPsystemfilter>>& for details. Note that a message is passed to the system
1465 filter only once per delivery attempt, however many recipients it has. However,
1466 if there are several delivery attempts because one or more addresses could not
1467 be immediately delivered, the system filter is run each time. The filter
1468 condition &%first_delivery%& can be used to detect the first run of the system
1469 filter.
1470 .next
1471 Each recipient address is offered to each configured router, in turn, subject to
1472 its preconditions, until one is able to handle it. If no router can handle the
1473 address, that is, if they all decline, the address is failed. Because routers
1474 can be targeted at particular domains, several locally handled domains can be
1475 processed entirely independently of each other.
1476 .next
1477 .cindex "routing" "loops in"
1478 .cindex "loop" "while routing"
1479 A router that accepts an address may assign it to a local or a remote
1480 transport. However, the transport is not run at this time. Instead, the address
1481 is placed on a list for the particular transport, which will be run later.
1482 Alternatively, the router may generate one or more new addresses (typically
1483 from alias, forward, or filter files). New addresses are fed back into this
1484 process from the top, but in order to avoid loops, a router ignores any address
1485 which has an identically-named ancestor that was processed by itself.
1486 .next
1487 When all the routing has been done, addresses that have been successfully
1488 handled are passed to their assigned transports. When local transports are
1489 doing real local deliveries, they handle only one address at a time, but if a
1490 local transport is being used as a pseudo-remote transport (for example, to
1491 collect batched SMTP messages for transmission by some other means) multiple
1492 addresses can be handled. Remote transports can always handle more than one
1493 address at a time, but can be configured not to do so, or to restrict multiple
1494 addresses to the same domain.
1495 .next
1496 Each local delivery to a file or a pipe runs in a separate process under a
1497 non-privileged uid, and these deliveries are run one at a time. Remote
1498 deliveries also run in separate processes, normally under a uid that is private
1499 to Exim (&"the Exim user"&), but in this case, several remote deliveries can be
1500 run in parallel. The maximum number of simultaneous remote deliveries for any
1501 one message is set by the &%remote_max_parallel%& option.
1502 The order in which deliveries are done is not defined, except that all local
1503 deliveries happen before any remote deliveries.
1504 .next
1505 .cindex "queue runner"
1506 When it encounters a local delivery during a queue run, Exim checks its retry
1507 database to see if there has been a previous temporary delivery failure for the
1508 address before running the local transport. If there was a previous failure,
1509 Exim does not attempt a new delivery until the retry time for the address is
1510 reached. However, this happens only for delivery attempts that are part of a
1511 queue run. Local deliveries are always attempted when delivery immediately
1512 follows message reception, even if retry times are set for them. This makes for
1513 better behaviour if one particular message is causing problems (for example,
1514 causing quota overflow, or provoking an error in a filter file).
1515 .next
1516 .cindex "delivery" "retry in remote transports"
1517 Remote transports do their own retry handling, since an address may be
1518 deliverable to one of a number of hosts, each of which may have a different
1519 retry time. If there have been previous temporary failures and no host has
1520 reached its retry time, no delivery is attempted, whether in a queue run or
1521 not. See chapter &<<CHAPretry>>& for details of retry strategies.
1522 .next
1523 If there were any permanent errors, a bounce message is returned to an
1524 appropriate address (the sender in the common case), with details of the error
1525 for each failing address. Exim can be configured to send copies of bounce
1526 messages to other addresses.
1527 .next
1528 .cindex "delivery" "deferral"
1529 If one or more addresses suffered a temporary failure, the message is left on
1530 the queue, to be tried again later. Delivery of these addresses is said to be
1531 &'deferred'&.
1532 .next
1533 When all the recipient addresses have either been delivered or bounced,
1534 handling of the message is complete. The spool files and message log are
1535 deleted, though the message log can optionally be preserved if required.
1536 .endlist
1537
1538
1539
1540
1541 .section "Retry mechanism" "SECID19"
1542 .cindex "delivery" "retry mechanism"
1543 .cindex "retry" "description of mechanism"
1544 .cindex "queue runner"
1545 Exim's mechanism for retrying messages that fail to get delivered at the first
1546 attempt is the queue runner process. You must either run an Exim daemon that
1547 uses the &%-q%& option with a time interval to start queue runners at regular
1548 intervals or use some other means (such as &'cron'&) to start them. If you do
1549 not arrange for queue runners to be run, messages that fail temporarily at the
1550 first attempt will remain in your queue forever. A queue runner process works
1551 its way through the queue, one message at a time, trying each delivery that has
1552 passed its retry time.
1553 You can run several queue runners at once.
1554
1555 Exim uses a set of configured rules to determine when next to retry the failing
1556 address (see chapter &<<CHAPretry>>&). These rules also specify when Exim
1557 should give up trying to deliver to the address, at which point it generates a
1558 bounce message. If no retry rules are set for a particular host, address, and
1559 error combination, no retries are attempted, and temporary errors are treated
1560 as permanent.
1561
1562
1563
1564 .section "Temporary delivery failure" "SECID20"
1565 .cindex "delivery" "temporary failure"
1566 There are many reasons why a message may not be immediately deliverable to a
1567 particular address. Failure to connect to a remote machine (because it, or the
1568 connection to it, is down) is one of the most common. Temporary failures may be
1569 detected during routing as well as during the transport stage of delivery.
1570 Local deliveries may be delayed if NFS files are unavailable, or if a mailbox
1571 is on a file system where the user is over quota. Exim can be configured to
1572 impose its own quotas on local mailboxes; where system quotas are set they will
1573 also apply.
1574
1575 If a host is unreachable for a period of time, a number of messages may be
1576 waiting for it by the time it recovers, and sending them in a single SMTP
1577 connection is clearly beneficial. Whenever a delivery to a remote host is
1578 deferred,
1579 .cindex "hints database" "deferred deliveries"
1580 Exim makes a note in its hints database, and whenever a successful
1581 SMTP delivery has happened, it looks to see if any other messages are waiting
1582 for the same host. If any are found, they are sent over the same SMTP
1583 connection, subject to a configuration limit as to the maximum number in any
1584 one connection.
1585
1586
1587
1588 .section "Permanent delivery failure" "SECID21"
1589 .cindex "delivery" "permanent failure"
1590 .cindex "bounce message" "when generated"
1591 When a message cannot be delivered to some or all of its intended recipients, a
1592 bounce message is generated. Temporary delivery failures turn into permanent
1593 errors when their timeout expires. All the addresses that fail in a given
1594 delivery attempt are listed in a single message. If the original message has
1595 many recipients, it is possible for some addresses to fail in one delivery
1596 attempt and others to fail subsequently, giving rise to more than one bounce
1597 message. The wording of bounce messages can be customized by the administrator.
1598 See chapter &<<CHAPemsgcust>>& for details.
1599
1600 .cindex "&'X-Failed-Recipients:'& header line"
1601 Bounce messages contain an &'X-Failed-Recipients:'& header line that lists the
1602 failed addresses, for the benefit of programs that try to analyse such messages
1603 automatically.
1604
1605 .cindex "bounce message" "recipient of"
1606 A bounce message is normally sent to the sender of the original message, as
1607 obtained from the message's envelope. For incoming SMTP messages, this is the
1608 address given in the MAIL command. However, when an address is expanded via a
1609 forward or alias file, an alternative address can be specified for delivery
1610 failures of the generated addresses. For a mailing list expansion (see section
1611 &<<SECTmailinglists>>&) it is common to direct bounce messages to the manager
1612 of the list.
1613
1614
1615
1616 .section "Failures to deliver bounce messages" "SECID22"
1617 .cindex "bounce message" "failure to deliver"
1618 If a bounce message (either locally generated or received from a remote host)
1619 itself suffers a permanent delivery failure, the message is left in the queue,
1620 but it is frozen, awaiting the attention of an administrator. There are options
1621 that can be used to make Exim discard such failed messages, or to keep them
1622 for only a short time (see &%timeout_frozen_after%& and
1623 &%ignore_bounce_errors_after%&).
1624
1625
1626
1627
1628
1629 . ////////////////////////////////////////////////////////////////////////////
1630 . ////////////////////////////////////////////////////////////////////////////
1631
1632 .chapter "Building and installing Exim" "CHID3"
1633 .scindex IIDbuex "building Exim"
1634
1635 .section "Unpacking" "SECID23"
1636 Exim is distributed as a gzipped or bzipped tar file which, when unpacked,
1637 creates a directory with the name of the current release (for example,
1638 &_exim-&version()_&) into which the following files are placed:
1639
1640 .table2 140pt
1641 .irow &_ACKNOWLEDGMENTS_& "contains some acknowledgments"
1642 .irow &_CHANGES_&         "contains a reference to where changes are &&&
1643   documented"
1644 .irow &_LICENCE_&         "the GNU General Public Licence"
1645 .irow &_Makefile_&        "top-level make file"
1646 .irow &_NOTICE_&          "conditions for the use of Exim"
1647 .irow &_README_&          "list of files, directories and simple build &&&
1648   instructions"
1649 .endtable
1650
1651 Other files whose names begin with &_README_& may also be present. The
1652 following subdirectories are created:
1653
1654 .table2 140pt
1655 .irow &_Local_&           "an empty directory for local configuration files"
1656 .irow &_OS_&              "OS-specific files"
1657 .irow &_doc_&             "documentation files"
1658 .irow &_exim_monitor_&    "source files for the Exim monitor"
1659 .irow &_scripts_&         "scripts used in the build process"
1660 .irow &_src_&             "remaining source files"
1661 .irow &_util_&            "independent utilities"
1662 .endtable
1663
1664 The main utility programs are contained in the &_src_& directory and are built
1665 with the Exim binary. The &_util_& directory contains a few optional scripts
1666 that may be useful to some sites.
1667
1668
1669 .section "Multiple machine architectures and operating systems" "SECID24"
1670 .cindex "building Exim" "multiple OS/architectures"
1671 The building process for Exim is arranged to make it easy to build binaries for
1672 a number of different architectures and operating systems from the same set of
1673 source files. Compilation does not take place in the &_src_& directory.
1674 Instead, a &'build directory'& is created for each architecture and operating
1675 system.
1676 .cindex "symbolic link" "to build directory"
1677 Symbolic links to the sources are installed in this directory, which is where
1678 the actual building takes place. In most cases, Exim can discover the machine
1679 architecture and operating system for itself, but the defaults can be
1680 overridden if necessary.
1681 .cindex compiler requirements
1682 .cindex compiler version
1683 A C99-capable compiler will be required for the build.
1684
1685
1686 .section "PCRE library" "SECTpcre"
1687 .cindex "PCRE library"
1688 Exim no longer has an embedded PCRE library as the vast majority of
1689 modern systems include PCRE as a system library, although you may need to
1690 install the PCRE package or the PCRE development package for your operating
1691 system. If your system has a normal PCRE installation the Exim build
1692 process will need no further configuration. If the library or the
1693 headers are in an unusual location you will need to either set the PCRE_LIBS
1694 and INCLUDE directives appropriately,
1695 or set PCRE_CONFIG=yes to use the installed &(pcre-config)& command.
1696 If your operating system has no
1697 PCRE support then you will need to obtain and build the current PCRE
1698 from &url(ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre/).
1699 More information on PCRE is available at &url(https://www.pcre.org/).
1700
1701 .section "DBM libraries" "SECTdb"
1702 .cindex "DBM libraries" "discussion of"
1703 .cindex "hints database" "DBM files used for"
1704 Even if you do not use any DBM files in your configuration, Exim still needs a
1705 DBM library in order to operate, because it uses indexed files for its hints
1706 databases. Unfortunately, there are a number of DBM libraries in existence, and
1707 different operating systems often have different ones installed.
1708
1709 .cindex "Solaris" "DBM library for"
1710 .cindex "IRIX, DBM library for"
1711 .cindex "BSD, DBM library for"
1712 .cindex "Linux, DBM library for"
1713 If you are using Solaris, IRIX, one of the modern BSD systems, or a modern
1714 Linux distribution, the DBM configuration should happen automatically, and you
1715 may be able to ignore this section. Otherwise, you may have to learn more than
1716 you would like about DBM libraries from what follows.
1717
1718 .cindex "&'ndbm'& DBM library"
1719 Licensed versions of Unix normally contain a library of DBM functions operating
1720 via the &'ndbm'& interface, and this is what Exim expects by default. Free
1721 versions of Unix seem to vary in what they contain as standard. In particular,
1722 some early versions of Linux have no default DBM library, and different
1723 distributors have chosen to bundle different libraries with their packaged
1724 versions. However, the more recent releases seem to have standardized on the
1725 Berkeley DB library.
1726
1727 Different DBM libraries have different conventions for naming the files they
1728 use. When a program opens a file called &_dbmfile_&, there are several
1729 possibilities:
1730
1731 .olist
1732 A traditional &'ndbm'& implementation, such as that supplied as part of
1733 Solaris, operates on two files called &_dbmfile.dir_& and &_dbmfile.pag_&.
1734 .next
1735 .cindex "&'gdbm'& DBM library"
1736 The GNU library, &'gdbm'&, operates on a single file. If used via its &'ndbm'&
1737 compatibility interface it makes two different hard links to it with names
1738 &_dbmfile.dir_& and &_dbmfile.pag_&, but if used via its native interface, the
1739 filename is used unmodified.
1740 .next
1741 .cindex "Berkeley DB library"
1742 The Berkeley DB package, if called via its &'ndbm'& compatibility interface,
1743 operates on a single file called &_dbmfile.db_&, but otherwise looks to the
1744 programmer exactly the same as the traditional &'ndbm'& implementation.
1745 .next
1746 If the Berkeley package is used in its native mode, it operates on a single
1747 file called &_dbmfile_&; the programmer's interface is somewhat different to
1748 the traditional &'ndbm'& interface.
1749 .next
1750 To complicate things further, there are several very different versions of the
1751 Berkeley DB package. Version 1.85 was stable for a very long time, releases
1752 2.&'x'& and 3.&'x'& were current for a while, but the latest versions when Exim last revamped support were numbered 4.&'x'&.
1753 Maintenance of some of the earlier releases has ceased. All versions of
1754 Berkeley DB could be obtained from
1755 &url(http://www.sleepycat.com/), which is now a redirect to their new owner's
1756 page with far newer versions listed.
1757 It is probably wise to plan to move your storage configurations away from
1758 Berkeley DB format, as today there are smaller and simpler alternatives more
1759 suited to Exim's usage model.
1760 .next
1761 .cindex "&'tdb'& DBM library"
1762 Yet another DBM library, called &'tdb'&, is available from
1763 &url(https://sourceforge.net/projects/tdb/files/). It has its own interface, and also
1764 operates on a single file.
1765 .endlist
1766
1767 .cindex "USE_DB"
1768 .cindex "DBM libraries" "configuration for building"
1769 Exim and its utilities can be compiled to use any of these interfaces. In order
1770 to use any version of the Berkeley DB package in native mode, you must set
1771 USE_DB in an appropriate configuration file (typically
1772 &_Local/Makefile_&). For example:
1773 .code
1774 USE_DB=yes
1775 .endd
1776 Similarly, for gdbm you set USE_GDBM, and for tdb you set USE_TDB. An
1777 error is diagnosed if you set more than one of these.
1778
1779 At the lowest level, the build-time configuration sets none of these options,
1780 thereby assuming an interface of type (1). However, some operating system
1781 configuration files (for example, those for the BSD operating systems and
1782 Linux) assume type (4) by setting USE_DB as their default, and the
1783 configuration files for Cygwin set USE_GDBM. Anything you set in
1784 &_Local/Makefile_&, however, overrides these system defaults.
1785
1786 As well as setting USE_DB, USE_GDBM, or USE_TDB, it may also be
1787 necessary to set DBMLIB, to cause inclusion of the appropriate library, as
1788 in one of these lines:
1789 .code
1790 DBMLIB = -ldb
1791 DBMLIB = -ltdb
1792 .endd
1793 Settings like that will work if the DBM library is installed in the standard
1794 place. Sometimes it is not, and the library's header file may also not be in
1795 the default path. You may need to set INCLUDE to specify where the header
1796 file is, and to specify the path to the library more fully in DBMLIB, as in
1797 this example:
1798 .code
1799 INCLUDE=-I/usr/local/include/db-4.1
1800 DBMLIB=/usr/local/lib/db-4.1/libdb.a
1801 .endd
1802 There is further detailed discussion about the various DBM libraries in the
1803 file &_doc/dbm.discuss.txt_& in the Exim distribution.
1804
1805
1806
1807 .section "Pre-building configuration" "SECID25"
1808 .cindex "building Exim" "pre-building configuration"
1809 .cindex "configuration for building Exim"
1810 .cindex "&_Local/Makefile_&"
1811 .cindex "&_src/EDITME_&"
1812 Before building Exim, a local configuration file that specifies options
1813 independent of any operating system has to be created with the name
1814 &_Local/Makefile_&. A template for this file is supplied as the file
1815 &_src/EDITME_&, and it contains full descriptions of all the option settings
1816 therein. These descriptions are therefore not repeated here. If you are
1817 building Exim for the first time, the simplest thing to do is to copy
1818 &_src/EDITME_& to &_Local/Makefile_&, then read it and edit it appropriately.
1819
1820 There are three settings that you must supply, because Exim will not build
1821 without them. They are the location of the runtime configuration file
1822 (CONFIGURE_FILE), the directory in which Exim binaries will be installed
1823 (BIN_DIRECTORY), and the identity of the Exim user (EXIM_USER and
1824 maybe EXIM_GROUP as well). The value of CONFIGURE_FILE can in fact be
1825 a colon-separated list of filenames; Exim uses the first of them that exists.
1826
1827 There are a few other parameters that can be specified either at build time or
1828 at runtime, to enable the same binary to be used on a number of different
1829 machines. However, if the locations of Exim's spool directory and log file
1830 directory (if not within the spool directory) are fixed, it is recommended that
1831 you specify them in &_Local/Makefile_& instead of at runtime, so that errors
1832 detected early in Exim's execution (such as a malformed configuration file) can
1833 be logged.
1834
1835 .cindex "content scanning" "specifying at build time"
1836 Exim's interfaces for calling virus and spam scanning software directly from
1837 access control lists are not compiled by default. If you want to include these
1838 facilities, you need to set
1839 .code
1840 WITH_CONTENT_SCAN=yes
1841 .endd
1842 in your &_Local/Makefile_&. For details of the facilities themselves, see
1843 chapter &<<CHAPexiscan>>&.
1844
1845
1846 .cindex "&_Local/eximon.conf_&"
1847 .cindex "&_exim_monitor/EDITME_&"
1848 If you are going to build the Exim monitor, a similar configuration process is
1849 required. The file &_exim_monitor/EDITME_& must be edited appropriately for
1850 your installation and saved under the name &_Local/eximon.conf_&. If you are
1851 happy with the default settings described in &_exim_monitor/EDITME_&,
1852 &_Local/eximon.conf_& can be empty, but it must exist.
1853
1854 This is all the configuration that is needed in straightforward cases for known
1855 operating systems. However, the building process is set up so that it is easy
1856 to override options that are set by default or by operating-system-specific
1857 configuration files, for example, to change the C compiler, which
1858 defaults to &%gcc%&. See section &<<SECToverride>>& below for details of how to
1859 do this.
1860
1861
1862
1863 .section "Support for iconv()" "SECID26"
1864 .cindex "&[iconv()]& support"
1865 .cindex "RFC 2047"
1866 The contents of header lines in messages may be encoded according to the rules
1867 described RFC 2047. This makes it possible to transmit characters that are not
1868 in the ASCII character set, and to label them as being in a particular
1869 character set. When Exim is inspecting header lines by means of the &%$h_%&
1870 mechanism, it decodes them, and translates them into a specified character set
1871 (default is set at build time). The translation is possible only if the operating system
1872 supports the &[iconv()]& function.
1873
1874 However, some of the operating systems that supply &[iconv()]& do not support
1875 very many conversions. The GNU &%libiconv%& library (available from
1876 &url(https://www.gnu.org/software/libiconv/)) can be installed on such
1877 systems to remedy this deficiency, as well as on systems that do not supply
1878 &[iconv()]& at all. After installing &%libiconv%&, you should add
1879 .code
1880 HAVE_ICONV=yes
1881 .endd
1882 to your &_Local/Makefile_& and rebuild Exim.
1883
1884
1885
1886 .section "Including TLS/SSL encryption support" "SECTinctlsssl"
1887 .cindex "TLS" "including support for TLS"
1888 .cindex "encryption" "including support for"
1889 .cindex "OpenSSL" "building Exim with"
1890 .cindex "GnuTLS" "building Exim with"
1891 Exim is usually built to support encrypted SMTP connections, using the STARTTLS
1892 command as per RFC 2487. It can also support clients that expect to
1893 start a TLS session immediately on connection to a non-standard port (see the
1894 &%tls_on_connect_ports%& runtime option and the &%-tls-on-connect%& command
1895 line option).
1896
1897 If you want to build Exim with TLS support, you must first install either the
1898 OpenSSL or GnuTLS library. There is no cryptographic code in Exim itself for
1899 implementing SSL.
1900
1901 .new
1902 If you do not want TLS support you should set
1903 .code
1904 DISABLE_TLS=yes
1905 .endd
1906 in &_Local/Makefile_&.
1907 .wen
1908
1909 If OpenSSL is installed, you should set
1910 .code
1911 USE_OPENSL=yes
1912 TLS_LIBS=-lssl -lcrypto
1913 .endd
1914 in &_Local/Makefile_&. You may also need to specify the locations of the
1915 OpenSSL library and include files. For example:
1916 .code
1917 USE_OPENSL=yes
1918 TLS_LIBS=-L/usr/local/openssl/lib -lssl -lcrypto
1919 TLS_INCLUDE=-I/usr/local/openssl/include/
1920 .endd
1921 .cindex "pkg-config" "OpenSSL"
1922 If you have &'pkg-config'& available, then instead you can just use:
1923 .code
1924 USE_OPENSL=yes
1925 USE_OPENSSL_PC=openssl
1926 .endd
1927 .cindex "USE_GNUTLS"
1928 If GnuTLS is installed, you should set
1929 .code
1930 USE_GNUTLS=yes
1931 TLS_LIBS=-lgnutls -ltasn1 -lgcrypt
1932 .endd
1933 in &_Local/Makefile_&, and again you may need to specify the locations of the
1934 library and include files. For example:
1935 .code
1936 USE_GNUTLS=yes
1937 TLS_LIBS=-L/usr/gnu/lib -lgnutls -ltasn1 -lgcrypt
1938 TLS_INCLUDE=-I/usr/gnu/include
1939 .endd
1940 .cindex "pkg-config" "GnuTLS"
1941 If you have &'pkg-config'& available, then instead you can just use:
1942 .code
1943 USE_GNUTLS=yes
1944 USE_GNUTLS_PC=gnutls
1945 .endd
1946
1947 You do not need to set TLS_INCLUDE if the relevant directory is already
1948 specified in INCLUDE. Details of how to configure Exim to make use of TLS are
1949 given in chapter &<<CHAPTLS>>&.
1950
1951
1952
1953
1954 .section "Use of tcpwrappers" "SECID27"
1955
1956 .cindex "tcpwrappers, building Exim to support"
1957 .cindex "USE_TCP_WRAPPERS"
1958 .cindex "TCP_WRAPPERS_DAEMON_NAME"
1959 .cindex "tcp_wrappers_daemon_name"
1960 Exim can be linked with the &'tcpwrappers'& library in order to check incoming
1961 SMTP calls using the &'tcpwrappers'& control files. This may be a convenient
1962 alternative to Exim's own checking facilities for installations that are
1963 already making use of &'tcpwrappers'& for other purposes. To do this, you
1964 should set USE_TCP_WRAPPERS in &_Local/Makefile_&, arrange for the file
1965 &_tcpd.h_& to be available at compile time, and also ensure that the library
1966 &_libwrap.a_& is available at link time, typically by including &%-lwrap%& in
1967 EXTRALIBS_EXIM. For example, if &'tcpwrappers'& is installed in &_/usr/local_&,
1968 you might have
1969 .code
1970 USE_TCP_WRAPPERS=yes
1971 CFLAGS=-O -I/usr/local/include
1972 EXTRALIBS_EXIM=-L/usr/local/lib -lwrap
1973 .endd
1974 in &_Local/Makefile_&. The daemon name to use in the &'tcpwrappers'& control
1975 files is &"exim"&. For example, the line
1976 .code
1977 exim : LOCAL  192.168.1.  .friendly.domain.example
1978 .endd
1979 in your &_/etc/hosts.allow_& file allows connections from the local host, from
1980 the subnet 192.168.1.0/24, and from all hosts in &'friendly.domain.example'&.
1981 All other connections are denied. The daemon name used by &'tcpwrappers'&
1982 can be changed at build time by setting TCP_WRAPPERS_DAEMON_NAME in
1983 &_Local/Makefile_&, or by setting tcp_wrappers_daemon_name in the
1984 configure file. Consult the &'tcpwrappers'& documentation for
1985 further details.
1986
1987
1988 .section "Including support for IPv6" "SECID28"
1989 .cindex "IPv6" "including support for"
1990 Exim contains code for use on systems that have IPv6 support. Setting
1991 &`HAVE_IPV6=YES`& in &_Local/Makefile_& causes the IPv6 code to be included;
1992 it may also be necessary to set IPV6_INCLUDE and IPV6_LIBS on systems
1993 where the IPv6 support is not fully integrated into the normal include and
1994 library files.
1995
1996 Two different types of DNS record for handling IPv6 addresses have been
1997 defined. AAAA records (analogous to A records for IPv4) are in use, and are
1998 currently seen as the mainstream. Another record type called A6 was proposed
1999 as better than AAAA because it had more flexibility. However, it was felt to be
2000 over-complex, and its status was reduced to &"experimental"&.
2001 Exim used to
2002 have a compile option for including A6 record support but this has now been
2003 withdrawn.
2004
2005
2006
2007 .section "Dynamically loaded lookup module support" "SECTdynamicmodules"
2008 .cindex "lookup modules"
2009 .cindex "dynamic modules"
2010 .cindex ".so building"
2011 On some platforms, Exim supports not compiling all lookup types directly into
2012 the main binary, instead putting some into external modules which can be loaded
2013 on demand.
2014 This permits packagers to build Exim with support for lookups with extensive
2015 library dependencies without requiring all users to install all of those
2016 dependencies.
2017 Most, but not all, lookup types can be built this way.
2018
2019 Set &`LOOKUP_MODULE_DIR`& to the directory into which the modules will be
2020 installed; Exim will only load modules from that directory, as a security
2021 measure.  You will need to set &`CFLAGS_DYNAMIC`& if not already defined
2022 for your OS; see &_OS/Makefile-Linux_& for an example.
2023 Some other requirements for adjusting &`EXTRALIBS`& may also be necessary,
2024 see &_src/EDITME_& for details.
2025
2026 Then, for each module to be loaded dynamically, define the relevant
2027 &`LOOKUP_`&<&'lookup_type'&> flags to have the value "2" instead of "yes".
2028 For example, this will build in lsearch but load sqlite and mysql support
2029 on demand:
2030 .code
2031 LOOKUP_LSEARCH=yes
2032 LOOKUP_SQLITE=2
2033 LOOKUP_MYSQL=2
2034 .endd
2035
2036
2037 .section "The building process" "SECID29"
2038 .cindex "build directory"
2039 Once &_Local/Makefile_& (and &_Local/eximon.conf_&, if required) have been
2040 created, run &'make'& at the top level. It determines the architecture and
2041 operating system types, and creates a build directory if one does not exist.
2042 For example, on a Sun system running Solaris 8, the directory
2043 &_build-SunOS5-5.8-sparc_& is created.
2044 .cindex "symbolic link" "to source files"
2045 Symbolic links to relevant source files are installed in the build directory.
2046
2047 If this is the first time &'make'& has been run, it calls a script that builds
2048 a make file inside the build directory, using the configuration files from the
2049 &_Local_& directory. The new make file is then passed to another instance of
2050 &'make'&. This does the real work, building a number of utility scripts, and
2051 then compiling and linking the binaries for the Exim monitor (if configured), a
2052 number of utility programs, and finally Exim itself. The command &`make
2053 makefile`& can be used to force a rebuild of the make file in the build
2054 directory, should this ever be necessary.
2055
2056 If you have problems building Exim, check for any comments there may be in the
2057 &_README_& file concerning your operating system, and also take a look at the
2058 FAQ, where some common problems are covered.
2059
2060
2061
2062 .section 'Output from &"make"&' "SECID283"
2063 The output produced by the &'make'& process for compile lines is often very
2064 unreadable, because these lines can be very long. For this reason, the normal
2065 output is suppressed by default, and instead output similar to that which
2066 appears when compiling the 2.6 Linux kernel is generated: just a short line for
2067 each module that is being compiled or linked. However, it is still possible to
2068 get the full output, by calling &'make'& like this:
2069 .code
2070 FULLECHO='' make -e
2071 .endd
2072 The value of FULLECHO defaults to &"@"&, the flag character that suppresses
2073 command reflection in &'make'&. When you ask for the full output, it is
2074 given in addition to the short output.
2075
2076
2077
2078 .section "Overriding build-time options for Exim" "SECToverride"
2079 .cindex "build-time options, overriding"
2080 The main make file that is created at the beginning of the building process
2081 consists of the concatenation of a number of files which set configuration
2082 values, followed by a fixed set of &'make'& instructions. If a value is set
2083 more than once, the last setting overrides any previous ones. This provides a
2084 convenient way of overriding defaults. The files that are concatenated are, in
2085 order:
2086 .display
2087 &_OS/Makefile-Default_&
2088 &_OS/Makefile-_&<&'ostype'&>
2089 &_Local/Makefile_&
2090 &_Local/Makefile-_&<&'ostype'&>
2091 &_Local/Makefile-_&<&'archtype'&>
2092 &_Local/Makefile-_&<&'ostype'&>-<&'archtype'&>
2093 &_OS/Makefile-Base_&
2094 .endd
2095 .cindex "&_Local/Makefile_&"
2096 .cindex "building Exim" "operating system type"
2097 .cindex "building Exim" "architecture type"
2098 where <&'ostype'&> is the operating system type and <&'archtype'&> is the
2099 architecture type. &_Local/Makefile_& is required to exist, and the building
2100 process fails if it is absent. The other three &_Local_& files are optional,
2101 and are often not needed.
2102
2103 The values used for <&'ostype'&> and <&'archtype'&> are obtained from scripts
2104 called &_scripts/os-type_& and &_scripts/arch-type_& respectively. If either of
2105 the environment variables EXIM_OSTYPE or EXIM_ARCHTYPE is set, their
2106 values are used, thereby providing a means of forcing particular settings.
2107 Otherwise, the scripts try to get values from the &%uname%& command. If this
2108 fails, the shell variables OSTYPE and ARCHTYPE are inspected. A number
2109 of &'ad hoc'& transformations are then applied, to produce the standard names
2110 that Exim expects. You can run these scripts directly from the shell in order
2111 to find out what values are being used on your system.
2112
2113
2114 &_OS/Makefile-Default_& contains comments about the variables that are set
2115 therein. Some (but not all) are mentioned below. If there is something that
2116 needs changing, review the contents of this file and the contents of the make
2117 file for your operating system (&_OS/Makefile-<ostype>_&) to see what the
2118 default values are.
2119
2120
2121 .cindex "building Exim" "overriding default settings"
2122 If you need to change any of the values that are set in &_OS/Makefile-Default_&
2123 or in &_OS/Makefile-<ostype>_&, or to add any new definitions, you do not
2124 need to change the original files. Instead, you should make the changes by
2125 putting the new values in an appropriate &_Local_& file. For example,
2126 .cindex "Tru64-Unix build-time settings"
2127 when building Exim in many releases of the Tru64-Unix (formerly Digital UNIX,
2128 formerly DEC-OSF1) operating system, it is necessary to specify that the C
2129 compiler is called &'cc'& rather than &'gcc'&. Also, the compiler must be
2130 called with the option &%-std1%&, to make it recognize some of the features of
2131 Standard C that Exim uses. (Most other compilers recognize Standard C by
2132 default.) To do this, you should create a file called &_Local/Makefile-OSF1_&
2133 containing the lines
2134 .code
2135 CC=cc
2136 CFLAGS=-std1
2137 .endd
2138 If you are compiling for just one operating system, it may be easier to put
2139 these lines directly into &_Local/Makefile_&.
2140
2141 Keeping all your local configuration settings separate from the distributed
2142 files makes it easy to transfer them to new versions of Exim simply by copying
2143 the contents of the &_Local_& directory.
2144
2145
2146 .cindex "NIS lookup type" "including support for"
2147 .cindex "NIS+ lookup type" "including support for"
2148 .cindex "LDAP" "including support for"
2149 .cindex "lookup" "inclusion in binary"
2150 Exim contains support for doing LDAP, NIS, NIS+, and other kinds of file
2151 lookup, but not all systems have these components installed, so the default is
2152 not to include the relevant code in the binary. All the different kinds of file
2153 and database lookup that Exim supports are implemented as separate code modules
2154 which are included only if the relevant compile-time options are set. In the
2155 case of LDAP, NIS, and NIS+, the settings for &_Local/Makefile_& are:
2156 .code
2157 LOOKUP_LDAP=yes
2158 LOOKUP_NIS=yes
2159 LOOKUP_NISPLUS=yes
2160 .endd
2161 and similar settings apply to the other lookup types. They are all listed in
2162 &_src/EDITME_&. In many cases the relevant include files and interface
2163 libraries need to be installed before compiling Exim.
2164 .cindex "cdb" "including support for"
2165 However, there are some optional lookup types (such as cdb) for which
2166 the code is entirely contained within Exim, and no external include
2167 files or libraries are required. When a lookup type is not included in the
2168 binary, attempts to configure Exim to use it cause runtime configuration
2169 errors.
2170
2171 .cindex "pkg-config" "lookups"
2172 .cindex "pkg-config" "authenticators"
2173 Many systems now use a tool called &'pkg-config'& to encapsulate information
2174 about how to compile against a library; Exim has some initial support for
2175 being able to use pkg-config for lookups and authenticators.  For any given
2176 makefile variable which starts &`LOOKUP_`& or &`AUTH_`&, you can add a new
2177 variable with the &`_PC`& suffix in the name and assign as the value the
2178 name of the package to be queried.  The results of querying via the
2179 &'pkg-config'& command will be added to the appropriate Makefile variables
2180 with &`+=`& directives, so your version of &'make'& will need to support that
2181 syntax.  For instance:
2182 .code
2183 LOOKUP_SQLITE=yes
2184 LOOKUP_SQLITE_PC=sqlite3
2185 AUTH_GSASL=yes
2186 AUTH_GSASL_PC=libgsasl
2187 AUTH_HEIMDAL_GSSAPI=yes
2188 AUTH_HEIMDAL_GSSAPI_PC=heimdal-gssapi
2189 .endd
2190
2191 .cindex "Perl" "including support for"
2192 Exim can be linked with an embedded Perl interpreter, allowing Perl
2193 subroutines to be called during string expansion. To enable this facility,
2194 .code
2195 EXIM_PERL=perl.o
2196 .endd
2197 must be defined in &_Local/Makefile_&. Details of this facility are given in
2198 chapter &<<CHAPperl>>&.
2199
2200 .cindex "X11 libraries, location of"
2201 The location of the X11 libraries is something that varies a lot between
2202 operating systems, and there may be different versions of X11 to cope
2203 with. Exim itself makes no use of X11, but if you are compiling the Exim
2204 monitor, the X11 libraries must be available.
2205 The following three variables are set in &_OS/Makefile-Default_&:
2206 .code
2207 X11=/usr/X11R6
2208 XINCLUDE=-I$(X11)/include
2209 XLFLAGS=-L$(X11)/lib
2210 .endd
2211 These are overridden in some of the operating-system configuration files. For
2212 example, in &_OS/Makefile-SunOS5_& there is
2213 .code
2214 X11=/usr/openwin
2215 XINCLUDE=-I$(X11)/include
2216 XLFLAGS=-L$(X11)/lib -R$(X11)/lib
2217 .endd
2218 If you need to override the default setting for your operating system, place a
2219 definition of all three of these variables into your
2220 &_Local/Makefile-<ostype>_& file.
2221
2222 .cindex "EXTRALIBS"
2223 If you need to add any extra libraries to the link steps, these can be put in a
2224 variable called EXTRALIBS, which appears in all the link commands, but by
2225 default is not defined. In contrast, EXTRALIBS_EXIM is used only on the
2226 command for linking the main Exim binary, and not for any associated utilities.
2227
2228 .cindex "DBM libraries" "configuration for building"
2229 There is also DBMLIB, which appears in the link commands for binaries that
2230 use DBM functions (see also section &<<SECTdb>>&). Finally, there is
2231 EXTRALIBS_EXIMON, which appears only in the link step for the Exim monitor
2232 binary, and which can be used, for example, to include additional X11
2233 libraries.
2234
2235 .cindex "configuration file" "editing"
2236 The make file copes with rebuilding Exim correctly if any of the configuration
2237 files are edited. However, if an optional configuration file is deleted, it is
2238 necessary to touch the associated non-optional file (that is,
2239 &_Local/Makefile_& or &_Local/eximon.conf_&) before rebuilding.
2240
2241
2242 .section "OS-specific header files" "SECID30"
2243 .cindex "&_os.h_&"
2244 .cindex "building Exim" "OS-specific C header files"
2245 The &_OS_& directory contains a number of files with names of the form
2246 &_os.h-<ostype>_&. These are system-specific C header files that should not
2247 normally need to be changed. There is a list of macro settings that are
2248 recognized in the file &_OS/os.configuring_&, which should be consulted if you
2249 are porting Exim to a new operating system.
2250
2251
2252
2253 .section "Overriding build-time options for the monitor" "SECID31"
2254 .cindex "building Eximon"
2255 A similar process is used for overriding things when building the Exim monitor,
2256 where the files that are involved are
2257 .display
2258 &_OS/eximon.conf-Default_&
2259 &_OS/eximon.conf-_&<&'ostype'&>
2260 &_Local/eximon.conf_&
2261 &_Local/eximon.conf-_&<&'ostype'&>
2262 &_Local/eximon.conf-_&<&'archtype'&>
2263 &_Local/eximon.conf-_&<&'ostype'&>-<&'archtype'&>
2264 .endd
2265 .cindex "&_Local/eximon.conf_&"
2266 As with Exim itself, the final three files need not exist, and in this case the
2267 &_OS/eximon.conf-<ostype>_& file is also optional. The default values in
2268 &_OS/eximon.conf-Default_& can be overridden dynamically by setting environment
2269 variables of the same name, preceded by EXIMON_. For example, setting
2270 EXIMON_LOG_DEPTH in the environment overrides the value of
2271 LOG_DEPTH at runtime.
2272 .ecindex IIDbuex
2273
2274
2275 .section "Installing Exim binaries and scripts" "SECID32"
2276 .cindex "installing Exim"
2277 .cindex "BIN_DIRECTORY"
2278 The command &`make install`& runs the &(exim_install)& script with no
2279 arguments. The script copies binaries and utility scripts into the directory
2280 whose name is specified by the BIN_DIRECTORY setting in &_Local/Makefile_&.
2281 .cindex "setuid" "installing Exim with"
2282 The install script copies files only if they are newer than the files they are
2283 going to replace. The Exim binary is required to be owned by root and have the
2284 &'setuid'& bit set, for normal configurations. Therefore, you must run &`make
2285 install`& as root so that it can set up the Exim binary in this way. However, in
2286 some special situations (for example, if a host is doing no local deliveries)
2287 it may be possible to run Exim without making the binary setuid root (see
2288 chapter &<<CHAPsecurity>>& for details).
2289
2290 .cindex "CONFIGURE_FILE"
2291 Exim's runtime configuration file is named by the CONFIGURE_FILE setting
2292 in &_Local/Makefile_&. If this names a single file, and the file does not
2293 exist, the default configuration file &_src/configure.default_& is copied there
2294 by the installation script. If a runtime configuration file already exists, it
2295 is left alone. If CONFIGURE_FILE is a colon-separated list, naming several
2296 alternative files, no default is installed.
2297
2298 .cindex "system aliases file"
2299 .cindex "&_/etc/aliases_&"
2300 One change is made to the default configuration file when it is installed: the
2301 default configuration contains a router that references a system aliases file.
2302 The path to this file is set to the value specified by
2303 SYSTEM_ALIASES_FILE in &_Local/Makefile_& (&_/etc/aliases_& by default).
2304 If the system aliases file does not exist, the installation script creates it,
2305 and outputs a comment to the user.
2306
2307 The created file contains no aliases, but it does contain comments about the
2308 aliases a site should normally have. Mail aliases have traditionally been
2309 kept in &_/etc/aliases_&. However, some operating systems are now using
2310 &_/etc/mail/aliases_&. You should check if yours is one of these, and change
2311 Exim's configuration if necessary.
2312
2313 The default configuration uses the local host's name as the only local domain,
2314 and is set up to do local deliveries into the shared directory &_/var/mail_&,
2315 running as the local user. System aliases and &_.forward_& files in users' home
2316 directories are supported, but no NIS or NIS+ support is configured. Domains
2317 other than the name of the local host are routed using the DNS, with delivery
2318 over SMTP.
2319
2320 It is possible to install Exim for special purposes (such as building a binary
2321 distribution) in a private part of the file system. You can do this by a
2322 command such as
2323 .code
2324 make DESTDIR=/some/directory/ install
2325 .endd
2326 This has the effect of pre-pending the specified directory to all the file
2327 paths, except the name of the system aliases file that appears in the default
2328 configuration. (If a default alias file is created, its name &'is'& modified.)
2329 For backwards compatibility, ROOT is used if DESTDIR is not set,
2330 but this usage is deprecated.
2331
2332 .cindex "installing Exim" "what is not installed"
2333 Running &'make install'& does not copy the Exim 4 conversion script
2334 &'convert4r4'&. You will probably run this only once if you are
2335 upgrading from Exim 3. None of the documentation files in the &_doc_&
2336 directory are copied, except for the info files when you have set
2337 INFO_DIRECTORY, as described in section &<<SECTinsinfdoc>>& below.
2338
2339 For the utility programs, old versions are renamed by adding the suffix &_.O_&
2340 to their names. The Exim binary itself, however, is handled differently. It is
2341 installed under a name that includes the version number and the compile number,
2342 for example, &_exim-&version()-1_&. The script then arranges for a symbolic link
2343 called &_exim_& to point to the binary. If you are updating a previous version
2344 of Exim, the script takes care to ensure that the name &_exim_& is never absent
2345 from the directory (as seen by other processes).
2346
2347 .cindex "installing Exim" "testing the script"
2348 If you want to see what the &'make install'& will do before running it for
2349 real, you can pass the &%-n%& option to the installation script by this
2350 command:
2351 .code
2352 make INSTALL_ARG=-n install
2353 .endd
2354 The contents of the variable INSTALL_ARG are passed to the installation
2355 script. You do not need to be root to run this test. Alternatively, you can run
2356 the installation script directly, but this must be from within the build
2357 directory. For example, from the top-level Exim directory you could use this
2358 command:
2359 .code
2360 (cd build-SunOS5-5.5.1-sparc; ../scripts/exim_install -n)
2361 .endd
2362 .cindex "installing Exim" "install script options"
2363 There are two other options that can be supplied to the installation script.
2364
2365 .ilist
2366 &%-no_chown%& bypasses the call to change the owner of the installed binary
2367 to root, and the call to make it a setuid binary.
2368 .next
2369 &%-no_symlink%& bypasses the setting up of the symbolic link &_exim_& to the
2370 installed binary.
2371 .endlist
2372
2373 INSTALL_ARG can be used to pass these options to the script. For example:
2374 .code
2375 make INSTALL_ARG=-no_symlink install
2376 .endd
2377 The installation script can also be given arguments specifying which files are
2378 to be copied. For example, to install just the Exim binary, and nothing else,
2379 without creating the symbolic link, you could use:
2380 .code
2381 make INSTALL_ARG='-no_symlink exim' install
2382 .endd
2383
2384
2385
2386 .section "Installing info documentation" "SECTinsinfdoc"
2387 .cindex "installing Exim" "&'info'& documentation"
2388 Not all systems use the GNU &'info'& system for documentation, and for this
2389 reason, the Texinfo source of Exim's documentation is not included in the main
2390 distribution. Instead it is available separately from the FTP site (see section
2391 &<<SECTavail>>&).
2392
2393 If you have defined INFO_DIRECTORY in &_Local/Makefile_& and the Texinfo
2394 source of the documentation is found in the source tree, running &`make
2395 install`& automatically builds the info files and installs them.
2396
2397
2398
2399 .section "Setting up the spool directory" "SECID33"
2400 .cindex "spool directory" "creating"
2401 When it starts up, Exim tries to create its spool directory if it does not
2402 exist. The Exim uid and gid are used for the owner and group of the spool
2403 directory. Sub-directories are automatically created in the spool directory as
2404 necessary.
2405
2406
2407
2408
2409 .section "Testing" "SECID34"
2410 .cindex "testing" "installation"
2411 Having installed Exim, you can check that the runtime configuration file is
2412 syntactically valid by running the following command, which assumes that the
2413 Exim binary directory is within your PATH environment variable:
2414 .code
2415 exim -bV
2416 .endd
2417 If there are any errors in the configuration file, Exim outputs error messages.
2418 Otherwise it outputs the version number and build date,
2419 the DBM library that is being used, and information about which drivers and
2420 other optional code modules are included in the binary.
2421 Some simple routing tests can be done by using the address testing option. For
2422 example,
2423 .display
2424 &`exim -bt`& <&'local username'&>
2425 .endd
2426 should verify that it recognizes a local mailbox, and
2427 .display
2428 &`exim -bt`& <&'remote address'&>
2429 .endd
2430 a remote one. Then try getting it to deliver mail, both locally and remotely.
2431 This can be done by passing messages directly to Exim, without going through a
2432 user agent. For example:
2433 .code
2434 exim -v postmaster@your.domain.example
2435 From: user@your.domain.example
2436 To: postmaster@your.domain.example
2437 Subject: Testing Exim
2438
2439 This is a test message.
2440 ^D
2441 .endd
2442 The &%-v%& option causes Exim to output some verification of what it is doing.
2443 In this case you should see copies of three log lines, one for the message's
2444 arrival, one for its delivery, and one containing &"Completed"&.
2445
2446 .cindex "delivery" "problems with"
2447 If you encounter problems, look at Exim's log files (&'mainlog'& and
2448 &'paniclog'&) to see if there is any relevant information there. Another source
2449 of information is running Exim with debugging turned on, by specifying the
2450 &%-d%& option. If a message is stuck on Exim's spool, you can force a delivery
2451 with debugging turned on by a command of the form
2452 .display
2453 &`exim -d -M`& <&'exim-message-id'&>
2454 .endd
2455 You must be root or an &"admin user"& in order to do this. The &%-d%& option
2456 produces rather a lot of output, but you can cut this down to specific areas.
2457 For example, if you use &%-d-all+route%& only the debugging information
2458 relevant to routing is included. (See the &%-d%& option in chapter
2459 &<<CHAPcommandline>>& for more details.)
2460
2461 .cindex '&"sticky"& bit'
2462 .cindex "lock files"
2463 One specific problem that has shown up on some sites is the inability to do
2464 local deliveries into a shared mailbox directory, because it does not have the
2465 &"sticky bit"& set on it. By default, Exim tries to create a lock file before
2466 writing to a mailbox file, and if it cannot create the lock file, the delivery
2467 is deferred. You can get round this either by setting the &"sticky bit"& on the
2468 directory, or by setting a specific group for local deliveries and allowing
2469 that group to create files in the directory (see the comments above the
2470 &(local_delivery)& transport in the default configuration file). Another
2471 approach is to configure Exim not to use lock files, but just to rely on
2472 &[fcntl()]& locking instead. However, you should do this only if all user
2473 agents also use &[fcntl()]& locking. For further discussion of locking issues,
2474 see chapter &<<CHAPappendfile>>&.
2475
2476 One thing that cannot be tested on a system that is already running an MTA is
2477 the receipt of incoming SMTP mail on the standard SMTP port. However, the
2478 &%-oX%& option can be used to run an Exim daemon that listens on some other
2479 port, or &'inetd'& can be used to do this. The &%-bh%& option and the
2480 &'exim_checkaccess'& utility can be used to check out policy controls on
2481 incoming SMTP mail.
2482
2483 Testing a new version on a system that is already running Exim can most easily
2484 be done by building a binary with a different CONFIGURE_FILE setting. From
2485 within the runtime configuration, all other file and directory names
2486 that Exim uses can be altered, in order to keep it entirely clear of the
2487 production version.
2488
2489
2490 .section "Replacing another MTA with Exim" "SECID35"
2491 .cindex "replacing another MTA"
2492 Building and installing Exim for the first time does not of itself put it in
2493 general use. The name by which the system's MTA is called by mail user agents
2494 is either &_/usr/sbin/sendmail_&, or &_/usr/lib/sendmail_& (depending on the
2495 operating system), and it is necessary to make this name point to the &'exim'&
2496 binary in order to get the user agents to pass messages to Exim. This is
2497 normally done by renaming any existing file and making &_/usr/sbin/sendmail_&
2498 or &_/usr/lib/sendmail_&
2499 .cindex "symbolic link" "to &'exim'& binary"
2500 a symbolic link to the &'exim'& binary. It is a good idea to remove any setuid
2501 privilege and executable status from the old MTA. It is then necessary to stop
2502 and restart the mailer daemon, if one is running.
2503
2504 .cindex "FreeBSD, MTA indirection"
2505 .cindex "&_/etc/mail/mailer.conf_&"
2506 Some operating systems have introduced alternative ways of switching MTAs. For
2507 example, if you are running FreeBSD, you need to edit the file
2508 &_/etc/mail/mailer.conf_& instead of setting up a symbolic link as just
2509 described. A typical example of the contents of this file for running Exim is
2510 as follows:
2511 .code
2512 sendmail            /usr/exim/bin/exim
2513 send-mail           /usr/exim/bin/exim
2514 mailq               /usr/exim/bin/exim -bp
2515 newaliases          /usr/bin/true
2516 .endd
2517 Once you have set up the symbolic link, or edited &_/etc/mail/mailer.conf_&,
2518 your Exim installation is &"live"&. Check it by sending a message from your
2519 favourite user agent.
2520
2521 You should consider what to tell your users about the change of MTA. Exim may
2522 have different capabilities to what was previously running, and there are
2523 various operational differences such as the text of messages produced by
2524 command line options and in bounce messages. If you allow your users to make
2525 use of Exim's filtering capabilities, you should make the document entitled
2526 &'Exim's interface to mail filtering'& available to them.
2527
2528
2529
2530 .section "Upgrading Exim" "SECID36"
2531 .cindex "upgrading Exim"
2532 If you are already running Exim on your host, building and installing a new
2533 version automatically makes it available to MUAs, or any other programs that
2534 call the MTA directly. However, if you are running an Exim daemon, you do need
2535 .cindex restart "on HUP signal"
2536 .cindex signal "HUP, to restart"
2537 to send it a HUP signal, to make it re-execute itself, and thereby pick up the
2538 new binary. You do not need to stop processing mail in order to install a new
2539 version of Exim. The install script does not modify an existing runtime
2540 configuration file.
2541
2542
2543
2544
2545 .section "Stopping the Exim daemon on Solaris" "SECID37"
2546 .cindex "Solaris" "stopping Exim on"
2547 The standard command for stopping the mailer daemon on Solaris is
2548 .code
2549 /etc/init.d/sendmail stop
2550 .endd
2551 If &_/usr/lib/sendmail_& has been turned into a symbolic link, this script
2552 fails to stop Exim because it uses the command &'ps -e'& and greps the output
2553 for the text &"sendmail"&; this is not present because the actual program name
2554 (that is, &"exim"&) is given by the &'ps'& command with these options. A
2555 solution is to replace the line that finds the process id with something like
2556 .code
2557 pid=`cat /var/spool/exim/exim-daemon.pid`
2558 .endd
2559 to obtain the daemon's pid directly from the file that Exim saves it in.
2560
2561 Note, however, that stopping the daemon does not &"stop Exim"&. Messages can
2562 still be received from local processes, and if automatic delivery is configured
2563 (the normal case), deliveries will still occur.
2564
2565
2566
2567
2568 . ////////////////////////////////////////////////////////////////////////////
2569 . ////////////////////////////////////////////////////////////////////////////
2570
2571 .chapter "The Exim command line" "CHAPcommandline"
2572 .scindex IIDclo1 "command line" "options"
2573 .scindex IIDclo2 "options" "command line"
2574 Exim's command line takes the standard Unix form of a sequence of options,
2575 each starting with a hyphen character, followed by a number of arguments. The
2576 options are compatible with the main options of Sendmail, and there are also
2577 some additional options, some of which are compatible with Smail 3. Certain
2578 combinations of options do not make sense, and provoke an error if used.
2579 The form of the arguments depends on which options are set.
2580
2581
2582 .section "Setting options by program name" "SECID38"
2583 .cindex "&'mailq'&"
2584 If Exim is called under the name &'mailq'&, it behaves as if the option &%-bp%&
2585 were present before any other options.
2586 The &%-bp%& option requests a listing of the contents of the mail queue on the
2587 standard output.
2588 This feature is for compatibility with some systems that contain a command of
2589 that name in one of the standard libraries, symbolically linked to
2590 &_/usr/sbin/sendmail_& or &_/usr/lib/sendmail_&.
2591
2592 .cindex "&'rsmtp'&"
2593 If Exim is called under the name &'rsmtp'& it behaves as if the option &%-bS%&
2594 were present before any other options, for compatibility with Smail. The
2595 &%-bS%& option is used for reading in a number of messages in batched SMTP
2596 format.
2597
2598 .cindex "&'rmail'&"
2599 If Exim is called under the name &'rmail'& it behaves as if the &%-i%& and
2600 &%-oee%& options were present before any other options, for compatibility with
2601 Smail. The name &'rmail'& is used as an interface by some UUCP systems.
2602
2603 .cindex "&'runq'&"
2604 .cindex "queue runner"
2605 If Exim is called under the name &'runq'& it behaves as if the option &%-q%&
2606 were present before any other options, for compatibility with Smail. The &%-q%&
2607 option causes a single queue runner process to be started.
2608
2609 .cindex "&'newaliases'&"
2610 .cindex "alias file" "building"
2611 .cindex "Sendmail compatibility" "calling Exim as &'newaliases'&"
2612 If Exim is called under the name &'newaliases'& it behaves as if the option
2613 &%-bi%& were present before any other options, for compatibility with Sendmail.
2614 This option is used for rebuilding Sendmail's alias file. Exim does not have
2615 the concept of a single alias file, but can be configured to run a given
2616 command if called with the &%-bi%& option.
2617
2618
2619 .section "Trusted and admin users" "SECTtrustedadmin"
2620 Some Exim options are available only to &'trusted users'& and others are
2621 available only to &'admin users'&. In the description below, the phrases &"Exim
2622 user"& and &"Exim group"& mean the user and group defined by EXIM_USER and
2623 EXIM_GROUP in &_Local/Makefile_& or set by the &%exim_user%& and
2624 &%exim_group%& options. These do not necessarily have to use the name &"exim"&.
2625
2626 .ilist
2627 .cindex "trusted users" "definition of"
2628 .cindex "user" "trusted definition of"
2629 The trusted users are root, the Exim user, any user listed in the
2630 &%trusted_users%& configuration option, and any user whose current group or any
2631 supplementary group is one of those listed in the &%trusted_groups%&
2632 configuration option. Note that the Exim group is not automatically trusted.
2633
2634 .cindex '&"From"& line'
2635 .cindex "envelope from"
2636 .cindex "envelope sender"
2637 Trusted users are always permitted to use the &%-f%& option or a leading
2638 &"From&~"& line to specify the envelope sender of a message that is passed to
2639 Exim through the local interface (see the &%-bm%& and &%-f%& options below).
2640 See the &%untrusted_set_sender%& option for a way of permitting non-trusted
2641 users to set envelope senders.
2642
2643 .cindex "&'From:'& header line"
2644 .cindex "&'Sender:'& header line"
2645 .cindex "header lines" "From:"
2646 .cindex "header lines" "Sender:"
2647 For a trusted user, there is never any check on the contents of the &'From:'&
2648 header line, and a &'Sender:'& line is never added. Furthermore, any existing
2649 &'Sender:'& line in incoming local (non-TCP/IP) messages is not removed.
2650
2651 Trusted users may also specify a host name, host address, interface address,
2652 protocol name, ident value, and authentication data when submitting a message
2653 locally. Thus, they are able to insert messages into Exim's queue locally that
2654 have the characteristics of messages received from a remote host. Untrusted
2655 users may in some circumstances use &%-f%&, but can never set the other values
2656 that are available to trusted users.
2657 .next
2658 .cindex "user" "admin definition of"
2659 .cindex "admin user" "definition of"
2660 The admin users are root, the Exim user, and any user that is a member of the
2661 Exim group or of any group listed in the &%admin_groups%& configuration option.
2662 The current group does not have to be one of these groups.
2663
2664 Admin users are permitted to list the queue, and to carry out certain
2665 operations on messages, for example, to force delivery failures. It is also
2666 necessary to be an admin user in order to see the full information provided by
2667 the Exim monitor, and full debugging output.
2668
2669 By default, the use of the &%-M%&, &%-q%&, &%-R%&, and &%-S%& options to cause
2670 Exim to attempt delivery of messages on its queue is restricted to admin users.
2671 However, this restriction can be relaxed by setting the &%prod_requires_admin%&
2672 option false (that is, specifying &%no_prod_requires_admin%&).
2673
2674 Similarly, the use of the &%-bp%& option to list all the messages in the queue
2675 is restricted to admin users unless &%queue_list_requires_admin%& is set
2676 false.
2677 .endlist
2678
2679
2680 &*Warning*&: If you configure your system so that admin users are able to
2681 edit Exim's configuration file, you are giving those users an easy way of
2682 getting root. There is further discussion of this issue at the start of chapter
2683 &<<CHAPconf>>&.
2684
2685
2686
2687
2688 .section "Command line options" "SECID39"
2689 Exim's command line options are described in alphabetical order below. If none
2690 of the options that specifies a specific action (such as starting the daemon or
2691 a queue runner, or testing an address, or receiving a message in a specific
2692 format, or listing the queue) are present, and there is at least one argument
2693 on the command line, &%-bm%& (accept a local message on the standard input,
2694 with the arguments specifying the recipients) is assumed. Otherwise, Exim
2695 outputs a brief message about itself and exits.
2696
2697 . ////////////////////////////////////////////////////////////////////////////
2698 . Insert a stylized XML comment here, to identify the start of the command line
2699 . options. This is for the benefit of the Perl script that automatically
2700 . creates a man page for the options.
2701 . ////////////////////////////////////////////////////////////////////////////
2702
2703 .literal xml
2704 <!-- === Start of command line options === -->
2705 .literal off
2706
2707
2708 .vlist
2709 .vitem &%--%&
2710 .oindex "--"
2711 .cindex "options" "command line; terminating"
2712 This is a pseudo-option whose only purpose is to terminate the options and
2713 therefore to cause subsequent command line items to be treated as arguments
2714 rather than options, even if they begin with hyphens.
2715
2716 .vitem &%--help%&
2717 .oindex "&%--help%&"
2718 This option causes Exim to output a few sentences stating what it is.
2719 The same output is generated if the Exim binary is called with no options and
2720 no arguments.
2721
2722 .vitem &%--version%&
2723 .oindex "&%--version%&"
2724 This option is an alias for &%-bV%& and causes version information to be
2725 displayed.
2726
2727 .vitem &%-Ac%& &&&
2728        &%-Am%&
2729 .oindex "&%-Ac%&"
2730 .oindex "&%-Am%&"
2731 These options are used by Sendmail for selecting configuration files and are
2732 ignored by Exim.
2733
2734 .vitem &%-B%&<&'type'&>
2735 .oindex "&%-B%&"
2736 .cindex "8-bit characters"
2737 .cindex "Sendmail compatibility" "8-bit characters"
2738 This is a Sendmail option for selecting 7 or 8 bit processing. Exim is 8-bit
2739 clean; it ignores this option.
2740
2741 .vitem &%-bd%&
2742 .oindex "&%-bd%&"
2743 .cindex "daemon"
2744 .cindex "SMTP" "listener"
2745 .cindex "queue runner"
2746 This option runs Exim as a daemon, awaiting incoming SMTP connections. Usually
2747 the &%-bd%& option is combined with the &%-q%&<&'time'&> option, to specify
2748 that the daemon should also initiate periodic queue runs.
2749
2750 The &%-bd%& option can be used only by an admin user. If either of the &%-d%&
2751 (debugging) or &%-v%& (verifying) options are set, the daemon does not
2752 disconnect from the controlling terminal. When running this way, it can be
2753 stopped by pressing ctrl-C.
2754
2755 By default, Exim listens for incoming connections to the standard SMTP port on
2756 all the host's running interfaces. However, it is possible to listen on other
2757 ports, on multiple ports, and only on specific interfaces. Chapter
2758 &<<CHAPinterfaces>>& contains a description of the options that control this.
2759
2760 When a listening daemon
2761 .cindex "daemon" "process id (pid)"
2762 .cindex "pid (process id)" "of daemon"
2763 is started without the use of &%-oX%& (that is, without overriding the normal
2764 configuration), it writes its process id to a file called &_exim-daemon.pid_&
2765 in Exim's spool directory. This location can be overridden by setting
2766 PID_FILE_PATH in &_Local/Makefile_&. The file is written while Exim is still
2767 running as root.
2768
2769 When &%-oX%& is used on the command line to start a listening daemon, the
2770 process id is not written to the normal pid file path. However, &%-oP%& can be
2771 used to specify a path on the command line if a pid file is required.
2772
2773 The SIGHUP signal
2774 .cindex "SIGHUP"
2775 .cindex restart "on HUP signal"
2776 .cindex signal "HUP, to restart"
2777 .cindex "daemon" "restarting"
2778 .cindex signal "to reload configuration"
2779 .cindex daemon "reload configuration"
2780 .cindex reload configuration
2781 can be used to cause the daemon to re-execute itself. This should be done
2782 whenever Exim's configuration file, or any file that is incorporated into it by
2783 means of the &%.include%& facility, is changed, and also whenever a new version
2784 of Exim is installed. It is not necessary to do this when other files that are
2785 referenced from the configuration (for example, alias files) are changed,
2786 because these are reread each time they are used.
2787
2788 .vitem &%-bdf%&
2789 .oindex "&%-bdf%&"
2790 This option has the same effect as &%-bd%& except that it never disconnects
2791 from the controlling terminal, even when no debugging is specified.
2792
2793 .vitem &%-be%&
2794 .oindex "&%-be%&"
2795 .cindex "testing" "string expansion"
2796 .cindex "expansion" "testing"
2797 Run Exim in expansion testing mode. Exim discards its root privilege, to
2798 prevent ordinary users from using this mode to read otherwise inaccessible
2799 files. If no arguments are given, Exim runs interactively, prompting for lines
2800 of data. Otherwise, it processes each argument in turn.
2801
2802 If Exim was built with USE_READLINE=yes in &_Local/Makefile_&, it tries
2803 to load the &%libreadline%& library dynamically whenever the &%-be%& option is
2804 used without command line arguments. If successful, it uses the &[readline()]&
2805 function, which provides extensive line-editing facilities, for reading the
2806 test data. A line history is supported.
2807
2808 Long expansion expressions can be split over several lines by using backslash
2809 continuations. As in Exim's runtime configuration, white space at the start of
2810 continuation lines is ignored. Each argument or data line is passed through the
2811 string expansion mechanism, and the result is output. Variable values from the
2812 configuration file (for example, &$qualify_domain$&) are available, but no
2813 message-specific values (such as &$message_exim_id$&) are set, because no message
2814 is being processed (but see &%-bem%& and &%-Mset%&).
2815
2816 &*Note*&: If you use this mechanism to test lookups, and you change the data
2817 files or databases you are using, you must exit and restart Exim before trying
2818 the same lookup again. Otherwise, because each Exim process caches the results
2819 of lookups, you will just get the same result as before.
2820
2821 Macro processing is done on lines before string-expansion: new macros can be
2822 defined and macros will be expanded.
2823 Because macros in the config file are often used for secrets, those are only
2824 available to admin users.
2825
2826 .vitem &%-bem%&&~<&'filename'&>
2827 .oindex "&%-bem%&"
2828 .cindex "testing" "string expansion"
2829 .cindex "expansion" "testing"
2830 This option operates like &%-be%& except that it must be followed by the name
2831 of a file. For example:
2832 .code
2833 exim -bem /tmp/testmessage
2834 .endd
2835 The file is read as a message (as if receiving a locally-submitted non-SMTP
2836 message) before any of the test expansions are done. Thus, message-specific
2837 variables such as &$message_size$& and &$header_from:$& are available. However,
2838 no &'Received:'& header is added to the message. If the &%-t%& option is set,
2839 recipients are read from the headers in the normal way, and are shown in the
2840 &$recipients$& variable. Note that recipients cannot be given on the command
2841 line, because further arguments are taken as strings to expand (just like
2842 &%-be%&).
2843
2844 .vitem &%-bF%&&~<&'filename'&>
2845 .oindex "&%-bF%&"
2846 .cindex "system filter" "testing"
2847 .cindex "testing" "system filter"
2848 This option is the same as &%-bf%& except that it assumes that the filter being
2849 tested is a system filter. The additional commands that are available only in
2850 system filters are recognized.
2851
2852 .vitem &%-bf%&&~<&'filename'&>
2853 .oindex "&%-bf%&"
2854 .cindex "filter" "testing"
2855 .cindex "testing" "filter file"
2856 .cindex "forward file" "testing"
2857 .cindex "testing" "forward file"
2858 .cindex "Sieve filter" "testing"
2859 This option runs Exim in user filter testing mode; the file is the filter file
2860 to be tested, and a test message must be supplied on the standard input. If
2861 there are no message-dependent tests in the filter, an empty file can be
2862 supplied.
2863
2864 If you want to test a system filter file, use &%-bF%& instead of &%-bf%&. You
2865 can use both &%-bF%& and &%-bf%& on the same command, in order to test a system
2866 filter and a user filter in the same run. For example:
2867 .code
2868 exim -bF /system/filter -bf /user/filter </test/message
2869 .endd
2870 This is helpful when the system filter adds header lines or sets filter
2871 variables that are used by the user filter.
2872
2873 If the test filter file does not begin with one of the special lines
2874 .code
2875 # Exim filter
2876 # Sieve filter
2877 .endd
2878 it is taken to be a normal &_.forward_& file, and is tested for validity under
2879 that interpretation. See sections &<<SECTitenonfilred>>& to
2880 &<<SECTspecitredli>>& for a description of the possible contents of non-filter
2881 redirection lists.
2882
2883 The result of an Exim command that uses &%-bf%&, provided no errors are
2884 detected, is a list of the actions that Exim would try to take if presented
2885 with the message for real. More details of filter testing are given in the
2886 separate document entitled &'Exim's interfaces to mail filtering'&.
2887
2888 When testing a filter file,
2889 .cindex "&""From""& line"
2890 .cindex "envelope from"
2891 .cindex "envelope sender"
2892 .oindex "&%-f%&" "for filter testing"
2893 the envelope sender can be set by the &%-f%& option,
2894 or by a &"From&~"& line at the start of the test message. Various parameters
2895 that would normally be taken from the envelope recipient address of the message
2896 can be set by means of additional command line options (see the next four
2897 options).
2898
2899 .vitem &%-bfd%&&~<&'domain'&>
2900 .oindex "&%-bfd%&"
2901 .vindex "&$qualify_domain$&"
2902 This sets the domain of the recipient address when a filter file is being
2903 tested by means of the &%-bf%& option. The default is the value of
2904 &$qualify_domain$&.
2905
2906 .vitem &%-bfl%&&~<&'local&~part'&>
2907 .oindex "&%-bfl%&"
2908 This sets the local part of the recipient address when a filter file is being
2909 tested by means of the &%-bf%& option. The default is the username of the
2910 process that calls Exim. A local part should be specified with any prefix or
2911 suffix stripped, because that is how it appears to the filter when a message is
2912 actually being delivered.
2913
2914 .vitem &%-bfp%&&~<&'prefix'&>
2915 .oindex "&%-bfp%&"
2916 .cindex affix "filter testing"
2917 This sets the prefix of the local part of the recipient address when a filter
2918 file is being tested by means of the &%-bf%& option. The default is an empty
2919 prefix.
2920
2921 .vitem &%-bfs%&&~<&'suffix'&>
2922 .oindex "&%-bfs%&"
2923 .cindex affix "filter testing"
2924 This sets the suffix of the local part of the recipient address when a filter
2925 file is being tested by means of the &%-bf%& option. The default is an empty
2926 suffix.
2927
2928 .vitem &%-bh%&&~<&'IP&~address'&>
2929 .oindex "&%-bh%&"
2930 .cindex "testing" "incoming SMTP"
2931 .cindex "SMTP" "testing incoming"
2932 .cindex "testing" "relay control"
2933 .cindex "relaying" "testing configuration"
2934 .cindex "policy control" "testing"
2935 .cindex "debugging" "&%-bh%& option"
2936 This option runs a fake SMTP session as if from the given IP address, using the
2937 standard input and output. The IP address may include a port number at the end,
2938 after a full stop. For example:
2939 .code
2940 exim -bh 10.9.8.7.1234
2941 exim -bh fe80::a00:20ff:fe86:a061.5678
2942 .endd
2943 When an IPv6 address is given, it is converted into canonical form. In the case
2944 of the second example above, the value of &$sender_host_address$& after
2945 conversion to the canonical form is
2946 &`fe80:0000:0000:0a00:20ff:fe86:a061.5678`&.
2947
2948 Comments as to what is going on are written to the standard error file. These
2949 include lines beginning with &"LOG"& for anything that would have been logged.
2950 This facility is provided for testing configuration options for incoming
2951 messages, to make sure they implement the required policy. For example, you can
2952 test your relay controls using &%-bh%&.
2953
2954 &*Warning 1*&:
2955 .cindex "RFC 1413"
2956 You can test features of the configuration that rely on ident (RFC 1413)
2957 information by using the &%-oMt%& option. However, Exim cannot actually perform
2958 an ident callout when testing using &%-bh%& because there is no incoming SMTP
2959 connection.
2960
2961 &*Warning 2*&: Address verification callouts (see section &<<SECTcallver>>&)
2962 are also skipped when testing using &%-bh%&. If you want these callouts to
2963 occur, use &%-bhc%& instead.
2964
2965 Messages supplied during the testing session are discarded, and nothing is
2966 written to any of the real log files. There may be pauses when DNS (and other)
2967 lookups are taking place, and of course these may time out. The &%-oMi%& option
2968 can be used to specify a specific IP interface and port if this is important,
2969 and &%-oMaa%& and &%-oMai%& can be used to set parameters as if the SMTP
2970 session were authenticated.
2971
2972 The &'exim_checkaccess'& utility is a &"packaged"& version of &%-bh%& whose
2973 output just states whether a given recipient address from a given host is
2974 acceptable or not. See section &<<SECTcheckaccess>>&.
2975
2976 Features such as authentication and encryption, where the client input is not
2977 plain text, cannot easily be tested with &%-bh%&. Instead, you should use a
2978 specialized SMTP test program such as
2979 &url(https://www.jetmore.org/john/code/swaks/,swaks).
2980
2981 .vitem &%-bhc%&&~<&'IP&~address'&>
2982 .oindex "&%-bhc%&"
2983 This option operates in the same way as &%-bh%&, except that address
2984 verification callouts are performed if required. This includes consulting and
2985 updating the callout cache database.
2986
2987 .vitem &%-bi%&
2988 .oindex "&%-bi%&"
2989 .cindex "alias file" "building"
2990 .cindex "building alias file"
2991 .cindex "Sendmail compatibility" "&%-bi%& option"
2992 Sendmail interprets the &%-bi%& option as a request to rebuild its alias file.
2993 Exim does not have the concept of a single alias file, and so it cannot mimic
2994 this behaviour. However, calls to &_/usr/lib/sendmail_& with the &%-bi%& option
2995 tend to appear in various scripts such as NIS make files, so the option must be
2996 recognized.
2997
2998 If &%-bi%& is encountered, the command specified by the &%bi_command%&
2999 configuration option is run, under the uid and gid of the caller of Exim. If
3000 the &%-oA%& option is used, its value is passed to the command as an argument.
3001 The command set by &%bi_command%& may not contain arguments. The command can
3002 use the &'exim_dbmbuild'& utility, or some other means, to rebuild alias files
3003 if this is required. If the &%bi_command%& option is not set, calling Exim with
3004 &%-bi%& is a no-op.
3005
3006 . // Keep :help first, then the rest in alphabetical order
3007 .vitem &%-bI:help%&
3008 .oindex "&%-bI:help%&"
3009 .cindex "querying exim information"
3010 We shall provide various options starting &`-bI:`& for querying Exim for
3011 information.  The output of many of these will be intended for machine
3012 consumption.  This one is not.  The &%-bI:help%& option asks Exim for a
3013 synopsis of supported options beginning &`-bI:`&.  Use of any of these
3014 options shall cause Exim to exit after producing the requested output.
3015
3016 .vitem &%-bI:dscp%&
3017 .oindex "&%-bI:dscp%&"
3018 .cindex "DSCP" "values"
3019 This option causes Exim to emit an alphabetically sorted list of all
3020 recognised DSCP names.
3021
3022 .vitem &%-bI:sieve%&
3023 .oindex "&%-bI:sieve%&"
3024 .cindex "Sieve filter" "capabilities"
3025 This option causes Exim to emit an alphabetically sorted list of all supported
3026 Sieve protocol extensions on stdout, one per line.  This is anticipated to be
3027 useful for ManageSieve (RFC 5804) implementations, in providing that protocol's
3028 &`SIEVE`& capability response line.  As the precise list may depend upon
3029 compile-time build options, which this option will adapt to, this is the only
3030 way to guarantee a correct response.
3031
3032 .vitem &%-bm%&
3033 .oindex "&%-bm%&"
3034 .cindex "local message reception"
3035 This option runs an Exim receiving process that accepts an incoming,
3036 locally-generated message on the standard input. The recipients are given as the
3037 command arguments (except when &%-t%& is also present &-- see below). Each
3038 argument can be a comma-separated list of RFC 2822 addresses. This is the
3039 default option for selecting the overall action of an Exim call; it is assumed
3040 if no other conflicting option is present.
3041
3042 If any addresses in the message are unqualified (have no domain), they are
3043 qualified by the values of the &%qualify_domain%& or &%qualify_recipient%&
3044 options, as appropriate. The &%-bnq%& option (see below) provides a way of
3045 suppressing this for special cases.
3046
3047 Policy checks on the contents of local messages can be enforced by means of
3048 the non-SMTP ACL. See chapter &<<CHAPACL>>& for details.
3049
3050 .cindex "return code" "for &%-bm%&"
3051 The return code is zero if the message is successfully accepted. Otherwise, the
3052 action is controlled by the &%-oe%&&'x'& option setting &-- see below.
3053
3054 The format
3055 .cindex "message" "format"
3056 .cindex "format" "message"
3057 .cindex "&""From""& line"
3058 .cindex "UUCP" "&""From""& line"
3059 .cindex "Sendmail compatibility" "&""From""& line"
3060 of the message must be as defined in RFC 2822, except that, for
3061 compatibility with Sendmail and Smail, a line in one of the forms
3062 .code
3063 From sender Fri Jan  5 12:55 GMT 1997
3064 From sender Fri, 5 Jan 97 12:55:01
3065 .endd
3066 (with the weekday optional, and possibly with additional text after the date)
3067 is permitted to appear at the start of the message. There appears to be no
3068 authoritative specification of the format of this line. Exim recognizes it by
3069 matching against the regular expression defined by the &%uucp_from_pattern%&
3070 option, which can be changed if necessary.
3071
3072 .oindex "&%-f%&" "overriding &""From""& line"
3073 The specified sender is treated as if it were given as the argument to the
3074 &%-f%& option, but if a &%-f%& option is also present, its argument is used in
3075 preference to the address taken from the message. The caller of Exim must be a
3076 trusted user for the sender of a message to be set in this way.
3077
3078 .vitem &%-bmalware%&&~<&'filename'&>
3079 .oindex "&%-bmalware%&"
3080 .cindex "testing", "malware"
3081 .cindex "malware scan test"
3082 This debugging option causes Exim to scan the given file or directory
3083 (depending on the used scanner interface),
3084 using the malware scanning framework.  The option of &%av_scanner%& influences
3085 this option, so if &%av_scanner%&'s value is dependent upon an expansion then
3086 the expansion should have defaults which apply to this invocation.  ACLs are
3087 not invoked, so if &%av_scanner%& references an ACL variable then that variable
3088 will never be populated and &%-bmalware%& will fail.
3089
3090 Exim will have changed working directory before resolving the filename, so
3091 using fully qualified pathnames is advisable.  Exim will be running as the Exim
3092 user when it tries to open the file, rather than as the invoking user.
3093 This option requires admin privileges.
3094
3095 The &%-bmalware%& option will not be extended to be more generally useful,
3096 there are better tools for file-scanning.  This option exists to help
3097 administrators verify their Exim and AV scanner configuration.
3098
3099 .vitem &%-bnq%&
3100 .oindex "&%-bnq%&"
3101 .cindex "address qualification, suppressing"
3102 By default, Exim automatically qualifies unqualified addresses (those
3103 without domains) that appear in messages that are submitted locally (that
3104 is, not over TCP/IP). This qualification applies both to addresses in
3105 envelopes, and addresses in header lines. Sender addresses are qualified using
3106 &%qualify_domain%&, and recipient addresses using &%qualify_recipient%& (which
3107 defaults to the value of &%qualify_domain%&).
3108
3109 Sometimes, qualification is not wanted. For example, if &%-bS%& (batch SMTP) is
3110 being used to re-submit messages that originally came from remote hosts after
3111 content scanning, you probably do not want to qualify unqualified addresses in
3112 header lines. (Such lines will be present only if you have not enabled a header
3113 syntax check in the appropriate ACL.)
3114
3115 The &%-bnq%& option suppresses all qualification of unqualified addresses in
3116 messages that originate on the local host. When this is used, unqualified
3117 addresses in the envelope provoke errors (causing message rejection) and
3118 unqualified addresses in header lines are left alone.
3119
3120
3121 .vitem &%-bP%&
3122 .oindex "&%-bP%&"
3123 .cindex "configuration options" "extracting"
3124 .cindex "options" "configuration &-- extracting"
3125 If this option is given with no arguments, it causes the values of all Exim's
3126 main configuration options to be written to the standard output. The values
3127 of one or more specific options can be requested by giving their names as
3128 arguments, for example:
3129 .code
3130 exim -bP qualify_domain hold_domains
3131 .endd
3132 .cindex "hiding configuration option values"
3133 .cindex "configuration options" "hiding value of"
3134 .cindex "options" "hiding value of"
3135 However, any option setting that is preceded by the word &"hide"& in the
3136 configuration file is not shown in full, except to an admin user. For other
3137 users, the output is as in this example:
3138 .code
3139 mysql_servers = <value not displayable>
3140 .endd
3141 If &%config%& is given as an argument, the config is
3142 output, as it was parsed, any include file resolved, any comment removed.
3143
3144 If &%config_file%& is given as an argument, the name of the runtime
3145 configuration file is output. (&%configure_file%& works too, for
3146 backward compatibility.)
3147 If a list of configuration files was supplied, the value that is output here
3148 is the name of the file that was actually used.
3149
3150 .cindex "options" "hiding name of"
3151 If the &%-n%& flag is given, then for most modes of &%-bP%& operation the
3152 name will not be output.
3153
3154 .cindex "daemon" "process id (pid)"
3155 .cindex "pid (process id)" "of daemon"
3156 If &%log_file_path%& or &%pid_file_path%& are given, the names of the
3157 directories where log files and daemon pid files are written are output,
3158 respectively. If these values are unset, log files are written in a
3159 sub-directory of the spool directory called &%log%&, and the pid file is
3160 written directly into the spool directory.
3161
3162 If &%-bP%& is followed by a name preceded by &`+`&, for example,
3163 .code
3164 exim -bP +local_domains
3165 .endd
3166 it searches for a matching named list of any type (domain, host, address, or
3167 local part) and outputs what it finds.
3168
3169 .cindex "options" "router &-- extracting"
3170 .cindex "options" "transport &-- extracting"
3171 .cindex "options" "authenticator &-- extracting"
3172 If one of the words &%router%&, &%transport%&, or &%authenticator%& is given,
3173 followed by the name of an appropriate driver instance, the option settings for
3174 that driver are output. For example:
3175 .code
3176 exim -bP transport local_delivery
3177 .endd
3178 The generic driver options are output first, followed by the driver's private
3179 options. A list of the names of drivers of a particular type can be obtained by
3180 using one of the words &%router_list%&, &%transport_list%&, or
3181 &%authenticator_list%&, and a complete list of all drivers with their option
3182 settings can be obtained by using &%routers%&, &%transports%&, or
3183 &%authenticators%&.
3184
3185 .cindex "environment"
3186 If &%environment%& is given as an argument, the set of environment
3187 variables is output, line by line. Using the &%-n%& flag suppresses the value of the
3188 variables.
3189
3190 .cindex "options" "macro &-- extracting"
3191 If invoked by an admin user, then &%macro%&, &%macro_list%& and &%macros%&
3192 are available, similarly to the drivers.  Because macros are sometimes used
3193 for storing passwords, this option is restricted.
3194 The output format is one item per line.
3195 For the "-bP macro <name>" form, if no such macro is found
3196 the exit status will be nonzero.
3197
3198 .vitem &%-bp%&
3199 .oindex "&%-bp%&"
3200 .cindex "queue" "listing messages in"
3201 .cindex "listing" "messages in the queue"
3202 This option requests a listing of the contents of the mail queue on the
3203 standard output. If the &%-bp%& option is followed by a list of message ids,
3204 just those messages are listed. By default, this option can be used only by an
3205 admin user. However, the &%queue_list_requires_admin%& option can be set false
3206 to allow any user to see the queue.
3207
3208 Each message in the queue is displayed as in the following example:
3209 .code
3210 25m  2.9K 0t5C6f-0000c8-00 <alice@wonderland.fict.example>
3211           red.king@looking-glass.fict.example
3212           <other addresses>
3213 .endd
3214 .cindex "message" "size in queue listing"
3215 .cindex "size" "of message"
3216 The first line contains the length of time the message has been in the queue
3217 (in this case 25 minutes), the size of the message (2.9K), the unique local
3218 identifier for the message, and the message sender, as contained in the
3219 envelope. For bounce messages, the sender address is empty, and appears as
3220 &"<>"&. If the message was submitted locally by an untrusted user who overrode
3221 the default sender address, the user's login name is shown in parentheses
3222 before the sender address.
3223
3224 .cindex "frozen messages" "in queue listing"
3225 If the message is frozen (attempts to deliver it are suspended) then the text
3226 &"*** frozen ***"& is displayed at the end of this line.
3227
3228 The recipients of the message (taken from the envelope, not the headers) are
3229 displayed on subsequent lines. Those addresses to which the message has already
3230 been delivered are marked with the letter D. If an original address gets
3231 expanded into several addresses via an alias or forward file, the original is
3232 displayed with a D only when deliveries for all of its child addresses are
3233 complete.
3234
3235
3236 .vitem &%-bpa%&
3237 .oindex "&%-bpa%&"
3238 This option operates like &%-bp%&, but in addition it shows delivered addresses
3239 that were generated from the original top level address(es) in each message by
3240 alias or forwarding operations. These addresses are flagged with &"+D"& instead
3241 of just &"D"&.
3242
3243
3244 .vitem &%-bpc%&
3245 .oindex "&%-bpc%&"
3246 .cindex "queue" "count of messages on"
3247 This option counts the number of messages in the queue, and writes the total
3248 to the standard output. It is restricted to admin users, unless
3249 &%queue_list_requires_admin%& is set false.
3250
3251
3252 .vitem &%-bpr%&
3253 .oindex "&%-bpr%&"
3254 This option operates like &%-bp%&, but the output is not sorted into
3255 chronological order of message arrival. This can speed it up when there are
3256 lots of messages in the queue, and is particularly useful if the output is
3257 going to be post-processed in a way that doesn't need the sorting.
3258
3259 .vitem &%-bpra%&
3260 .oindex "&%-bpra%&"
3261 This option is a combination of &%-bpr%& and &%-bpa%&.
3262
3263 .vitem &%-bpru%&
3264 .oindex "&%-bpru%&"
3265 This option is a combination of &%-bpr%& and &%-bpu%&.
3266
3267
3268 .vitem &%-bpu%&
3269 .oindex "&%-bpu%&"
3270 This option operates like &%-bp%& but shows only undelivered top-level
3271 addresses for each message displayed. Addresses generated by aliasing or
3272 forwarding are not shown, unless the message was deferred after processing by a
3273 router with the &%one_time%& option set.
3274
3275
3276 .vitem &%-brt%&
3277 .oindex "&%-brt%&"
3278 .cindex "testing" "retry configuration"
3279 .cindex "retry" "configuration testing"
3280 This option is for testing retry rules, and it must be followed by up to three
3281 arguments. It causes Exim to look for a retry rule that matches the values
3282 and to write it to the standard output. For example:
3283 .code
3284 exim -brt bach.comp.mus.example
3285 Retry rule: *.comp.mus.example  F,2h,15m; F,4d,30m;
3286 .endd
3287 See chapter &<<CHAPretry>>& for a description of Exim's retry rules. The first
3288 argument, which is required, can be a complete address in the form
3289 &'local_part@domain'&, or it can be just a domain name. If the second argument
3290 contains a dot, it is interpreted as an optional second domain name; if no
3291 retry rule is found for the first argument, the second is tried. This ties in
3292 with Exim's behaviour when looking for retry rules for remote hosts &-- if no
3293 rule is found that matches the host, one that matches the mail domain is
3294 sought. Finally, an argument that is the name of a specific delivery error, as
3295 used in setting up retry rules, can be given. For example:
3296 .code
3297 exim -brt haydn.comp.mus.example quota_3d
3298 Retry rule: *@haydn.comp.mus.example quota_3d  F,1h,15m
3299 .endd
3300
3301 .vitem &%-brw%&
3302 .oindex "&%-brw%&"
3303 .cindex "testing" "rewriting"
3304 .cindex "rewriting" "testing"
3305 This option is for testing address rewriting rules, and it must be followed by
3306 a single argument, consisting of either a local part without a domain, or a
3307 complete address with a fully qualified domain. Exim outputs how this address
3308 would be rewritten for each possible place it might appear. See chapter
3309 &<<CHAPrewrite>>& for further details.
3310
3311 .vitem &%-bS%&
3312 .oindex "&%-bS%&"
3313 .cindex "SMTP" "batched incoming"
3314 .cindex "batched SMTP input"
3315 This option is used for batched SMTP input, which is an alternative interface
3316 for non-interactive local message submission. A number of messages can be
3317 submitted in a single run. However, despite its name, this is not really SMTP
3318 input. Exim reads each message's envelope from SMTP commands on the standard
3319 input, but generates no responses. If the caller is trusted, or
3320 &%untrusted_set_sender%& is set, the senders in the SMTP MAIL commands are
3321 believed; otherwise the sender is always the caller of Exim.
3322
3323 The message itself is read from the standard input, in SMTP format (leading
3324 dots doubled), terminated by a line containing just a single dot. An error is
3325 provoked if the terminating dot is missing. A further message may then follow.
3326
3327 As for other local message submissions, the contents of incoming batch SMTP
3328 messages can be checked using the non-SMTP ACL (see chapter &<<CHAPACL>>&).
3329 Unqualified addresses are automatically qualified using &%qualify_domain%& and
3330 &%qualify_recipient%&, as appropriate, unless the &%-bnq%& option is used.
3331
3332 Some other SMTP commands are recognized in the input. HELO and EHLO act
3333 as RSET; VRFY, EXPN, ETRN, and HELP act as NOOP;
3334 QUIT quits, ignoring the rest of the standard input.
3335
3336 .cindex "return code" "for &%-bS%&"
3337 If any error is encountered, reports are written to the standard output and
3338 error streams, and Exim gives up immediately. The return code is 0 if no error
3339 was detected; it is 1 if one or more messages were accepted before the error
3340 was detected; otherwise it is 2.
3341
3342 More details of input using batched SMTP are given in section
3343 &<<SECTincomingbatchedSMTP>>&.
3344
3345 .vitem &%-bs%&
3346 .oindex "&%-bs%&"
3347 .cindex "SMTP" "local input"
3348 .cindex "local SMTP input"
3349 This option causes Exim to accept one or more messages by reading SMTP commands
3350 on the standard input, and producing SMTP replies on the standard output. SMTP
3351 policy controls, as defined in ACLs (see chapter &<<CHAPACL>>&) are applied.
3352 Some user agents use this interface as a way of passing locally-generated
3353 messages to the MTA.
3354
3355 In
3356 .cindex "sender" "source of"
3357 this usage, if the caller of Exim is trusted, or &%untrusted_set_sender%& is
3358 set, the senders of messages are taken from the SMTP MAIL commands.
3359 Otherwise the content of these commands is ignored and the sender is set up as
3360 the calling user. Unqualified addresses are automatically qualified using
3361 &%qualify_domain%& and &%qualify_recipient%&, as appropriate, unless the
3362 &%-bnq%& option is used.
3363
3364 .cindex "inetd"
3365 The
3366 &%-bs%& option is also used to run Exim from &'inetd'&, as an alternative to
3367 using a listening daemon. Exim can distinguish the two cases by checking
3368 whether the standard input is a TCP/IP socket. When Exim is called from
3369 &'inetd'&, the source of the mail is assumed to be remote, and the comments
3370 above concerning senders and qualification do not apply. In this situation,
3371 Exim behaves in exactly the same way as it does when receiving a message via
3372 the listening daemon.
3373
3374 .vitem &%-bt%&
3375 .oindex "&%-bt%&"
3376 .cindex "testing" "addresses"
3377 .cindex "address" "testing"
3378 This option runs Exim in address testing mode, in which each argument is taken
3379 as a recipient address to be tested for deliverability. The results are
3380 written to the standard output. If a test fails, and the caller is not an admin
3381 user, no details of the failure are output, because these might contain
3382 sensitive information such as usernames and passwords for database lookups.
3383
3384 If no arguments are given, Exim runs in an interactive manner, prompting with a
3385 right angle bracket for addresses to be tested.
3386
3387 Unlike the &%-be%& test option, you cannot arrange for Exim to use the
3388 &[readline()]& function, because it is running as &'root'& and there are
3389 security issues.
3390
3391 Each address is handled as if it were the recipient address of a message
3392 (compare the &%-bv%& option). It is passed to the routers and the result is
3393 written to the standard output. However, any router that has
3394 &%no_address_test%& set is bypassed. This can make &%-bt%& easier to use for
3395 genuine routing tests if your first router passes everything to a scanner
3396 program.
3397
3398 .cindex "return code" "for &%-bt%&"
3399 The return code is 2 if any address failed outright; it is 1 if no address
3400 failed outright but at least one could not be resolved for some reason. Return
3401 code 0 is given only when all addresses succeed.
3402
3403 .cindex "duplicate addresses"
3404 &*Note*&: When actually delivering a message, Exim removes duplicate recipient
3405 addresses after routing is complete, so that only one delivery takes place.
3406 This does not happen when testing with &%-bt%&; the full results of routing are
3407 always shown.
3408
3409 &*Warning*&: &%-bt%& can only do relatively simple testing. If any of the
3410 routers in the configuration makes any tests on the sender address of a
3411 message,
3412 .oindex "&%-f%&" "for address testing"
3413 you can use the &%-f%& option to set an appropriate sender when running
3414 &%-bt%& tests. Without it, the sender is assumed to be the calling user at the
3415 default qualifying domain. However, if you have set up (for example) routers
3416 whose behaviour depends on the contents of an incoming message, you cannot test
3417 those conditions using &%-bt%&. The &%-N%& option provides a possible way of
3418 doing such tests.
3419
3420 .vitem &%-bV%&
3421 .oindex "&%-bV%&"
3422 .cindex "version number of Exim"
3423 This option causes Exim to write the current version number, compilation
3424 number, and compilation date of the &'exim'& binary to the standard output.
3425 It also lists the DBM library that is being used, the optional modules (such as
3426 specific lookup types), the drivers that are included in the binary, and the
3427 name of the runtime configuration file that is in use.
3428
3429 As part of its operation, &%-bV%& causes Exim to read and syntax check its
3430 configuration file. However, this is a static check only. It cannot check
3431 values that are to be expanded. For example, although a misspelt ACL verb is
3432 detected, an error in the verb's arguments is not. You cannot rely on &%-bV%&
3433 alone to discover (for example) all the typos in the configuration; some
3434 realistic testing is needed. The &%-bh%& and &%-N%& options provide more
3435 dynamic testing facilities.
3436
3437 .vitem &%-bv%&
3438 .oindex "&%-bv%&"
3439 .cindex "verifying address" "using &%-bv%&"
3440 .cindex "address" "verification"
3441 This option runs Exim in address verification mode, in which each argument is
3442 taken as a recipient address to be verified by the routers. (This does
3443 not involve any verification callouts). During normal operation, verification
3444 happens mostly as a consequence processing a &%verify%& condition in an ACL
3445 (see chapter &<<CHAPACL>>&). If you want to test an entire ACL, possibly
3446 including callouts, see the &%-bh%& and &%-bhc%& options.
3447
3448 If verification fails, and the caller is not an admin user, no details of the
3449 failure are output, because these might contain sensitive information such as
3450 usernames and passwords for database lookups.
3451
3452 If no arguments are given, Exim runs in an interactive manner, prompting with a
3453 right angle bracket for addresses to be verified.
3454
3455 Unlike the &%-be%& test option, you cannot arrange for Exim to use the
3456 &[readline()]& function, because it is running as &'exim'& and there are
3457 security issues.
3458
3459 Verification differs from address testing (the &%-bt%& option) in that routers
3460 that have &%no_verify%& set are skipped, and if the address is accepted by a
3461 router that has &%fail_verify%& set, verification fails. The address is
3462 verified as a recipient if &%-bv%& is used; to test verification for a sender
3463 address, &%-bvs%& should be used.
3464
3465 If the &%-v%& option is not set, the output consists of a single line for each
3466 address, stating whether it was verified or not, and giving a reason in the
3467 latter case. Without &%-v%&, generating more than one address by redirection
3468 causes verification to end successfully, without considering the generated
3469 addresses. However, if just one address is generated, processing continues,
3470 and the generated address must verify successfully for the overall verification
3471 to succeed.
3472
3473 When &%-v%& is set, more details are given of how the address has been handled,
3474 and in the case of address redirection, all the generated addresses are also
3475 considered. Verification may succeed for some and fail for others.
3476
3477 The
3478 .cindex "return code" "for &%-bv%&"
3479 return code is 2 if any address failed outright; it is 1 if no address
3480 failed outright but at least one could not be resolved for some reason. Return
3481 code 0 is given only when all addresses succeed.
3482
3483 If any of the routers in the configuration makes any tests on the sender
3484 address of a message, you should use the &%-f%& option to set an appropriate
3485 sender when running &%-bv%& tests. Without it, the sender is assumed to be the
3486 calling user at the default qualifying domain.
3487
3488 .vitem &%-bvs%&
3489 .oindex "&%-bvs%&"
3490 This option acts like &%-bv%&, but verifies the address as a sender rather
3491 than a recipient address. This affects any rewriting and qualification that
3492 might happen.
3493
3494 .vitem &%-bw%&
3495 .oindex "&%-bw%&"
3496 .cindex "daemon"
3497 .cindex "inetd"
3498 .cindex "inetd" "wait mode"
3499 This option runs Exim as a daemon, awaiting incoming SMTP connections,
3500 similarly to the &%-bd%& option.  All port specifications on the command-line
3501 and in the configuration file are ignored.  Queue-running may not be specified.
3502
3503 In this mode, Exim expects to be passed a socket as fd 0 (stdin) which is
3504 listening for connections.  This permits the system to start up and have
3505 inetd (or equivalent) listen on the SMTP ports, starting an Exim daemon for
3506 each port only when the first connection is received.
3507
3508 If the option is given as &%-bw%&<&'time'&> then the time is a timeout, after
3509 which the daemon will exit, which should cause inetd to listen once more.
3510
3511 .vitem &%-C%&&~<&'filelist'&>
3512 .oindex "&%-C%&"
3513 .cindex "configuration file" "alternate"
3514 .cindex "CONFIGURE_FILE"
3515 .cindex "alternate configuration file"
3516 This option causes Exim to find the runtime configuration file from the given
3517 list instead of from the list specified by the CONFIGURE_FILE
3518 compile-time setting. Usually, the list will consist of just a single filename,
3519 but it can be a colon-separated list of names. In this case, the first
3520 file that exists is used. Failure to open an existing file stops Exim from
3521 proceeding any further along the list, and an error is generated.
3522
3523 When this option is used by a caller other than root, and the list is different
3524 from the compiled-in list, Exim gives up its root privilege immediately, and
3525 runs with the real and effective uid and gid set to those of the caller.
3526 However, if a TRUSTED_CONFIG_LIST file is defined in &_Local/Makefile_&, that
3527 file contains a list of full pathnames, one per line, for configuration files
3528 which are trusted. Root privilege is retained for any configuration file so
3529 listed, as long as the caller is the Exim user (or the user specified in the
3530 CONFIGURE_OWNER option, if any), and as long as the configuration file is
3531 not writeable by inappropriate users or groups.
3532
3533 Leaving TRUSTED_CONFIG_LIST unset precludes the possibility of testing a
3534 configuration using &%-C%& right through message reception and delivery,
3535 even if the caller is root. The reception works, but by that time, Exim is
3536 running as the Exim user, so when it re-executes to regain privilege for the
3537 delivery, the use of &%-C%& causes privilege to be lost. However, root can
3538 test reception and delivery using two separate commands (one to put a message
3539 in the queue, using &%-odq%&, and another to do the delivery, using &%-M%&).
3540
3541 If ALT_CONFIG_PREFIX is defined &_in Local/Makefile_&, it specifies a
3542 prefix string with which any file named in a &%-C%& command line option
3543 must start. In addition, the filename must not contain the sequence &`/../`&.
3544 However, if the value of the &%-C%& option is identical to the value of
3545 CONFIGURE_FILE in &_Local/Makefile_&, Exim ignores &%-C%& and proceeds as
3546 usual. There is no default setting for ALT_CONFIG_PREFIX; when it is
3547 unset, any filename can be used with &%-C%&.
3548
3549 ALT_CONFIG_PREFIX can be used to confine alternative configuration files
3550 to a directory to which only root has access. This prevents someone who has
3551 broken into the Exim account from running a privileged Exim with an arbitrary
3552 configuration file.
3553
3554 The &%-C%& facility is useful for ensuring that configuration files are
3555 syntactically correct, but cannot be used for test deliveries, unless the
3556 caller is privileged, or unless it is an exotic configuration that does not
3557 require privilege. No check is made on the owner or group of the files
3558 specified by this option.
3559
3560
3561 .vitem &%-D%&<&'macro'&>=<&'value'&>
3562 .oindex "&%-D%&"
3563 .cindex "macro" "setting on command line"
3564 This option can be used to override macro definitions in the configuration file
3565 (see section &<<SECTmacrodefs>>&). However, like &%-C%&, if it is used by an
3566 unprivileged caller, it causes Exim to give up its root privilege.
3567 If DISABLE_D_OPTION is defined in &_Local/Makefile_&, the use of &%-D%& is
3568 completely disabled, and its use causes an immediate error exit.
3569
3570 If WHITELIST_D_MACROS is defined in &_Local/Makefile_& then it should be a
3571 colon-separated list of macros which are considered safe and, if &%-D%& only
3572 supplies macros from this list, and the values are acceptable, then Exim will
3573 not give up root privilege if the caller is root, the Exim run-time user, or
3574 the CONFIGURE_OWNER, if set.  This is a transition mechanism and is expected
3575 to be removed in the future.  Acceptable values for the macros satisfy the
3576 regexp: &`^[A-Za-z0-9_/.-]*$`&
3577
3578 The entire option (including equals sign if present) must all be within one
3579 command line item. &%-D%& can be used to set the value of a macro to the empty
3580 string, in which case the equals sign is optional. These two commands are
3581 synonymous:
3582 .code
3583 exim -DABC  ...
3584 exim -DABC= ...
3585 .endd
3586 To include spaces in a macro definition item, quotes must be used. If you use
3587 quotes, spaces are permitted around the macro name and the equals sign. For
3588 example:
3589 .code
3590 exim '-D ABC = something' ...
3591 .endd
3592 &%-D%& may be repeated up to 10 times on a command line.
3593 Only macro names up to 22 letters long can be set.
3594
3595
3596 .vitem &%-d%&<&'debug&~options'&>
3597 .oindex "&%-d%&"
3598 .cindex "debugging" "list of selectors"
3599 .cindex "debugging" "&%-d%& option"
3600 This option causes debugging information to be written to the standard
3601 error stream. It is restricted to admin users because debugging output may show
3602 database queries that contain password information. Also, the details of users'
3603 filter files should be protected. If a non-admin user uses &%-d%&, Exim
3604 writes an error message to the standard error stream and exits with a non-zero
3605 return code.
3606
3607 When &%-d%& is used, &%-v%& is assumed. If &%-d%& is given on its own, a lot of
3608 standard debugging data is output. This can be reduced, or increased to include
3609 some more rarely needed information, by directly following &%-d%& with a string
3610 made up of names preceded by plus or minus characters. These add or remove sets
3611 of debugging data, respectively. For example, &%-d+filter%& adds filter
3612 debugging, whereas &%-d-all+filter%& selects only filter debugging. Note that
3613 no spaces are allowed in the debug setting. The available debugging categories
3614 are:
3615 .display
3616 &`acl            `& ACL interpretation
3617 &`auth           `& authenticators
3618 &`deliver        `& general delivery logic
3619 &`dns            `& DNS lookups (see also resolver)
3620 &`dnsbl          `& DNS black list (aka RBL) code
3621 &`exec           `& arguments for &[execv()]& calls
3622 &`expand         `& detailed debugging for string expansions
3623 &`filter         `& filter handling
3624 &`hints_lookup   `& hints data lookups
3625 &`host_lookup    `& all types of name-to-IP address handling
3626 &`ident          `& ident lookup
3627 &`interface      `& lists of local interfaces
3628 &`lists          `& matching things in lists
3629 &`load           `& system load checks
3630 &`local_scan     `& can be used by &[local_scan()]& (see chapter &&&
3631                     &<<CHAPlocalscan>>&)
3632 &`lookup         `& general lookup code and all lookups
3633 &`memory         `& memory handling
3634 &`noutf8         `& modifier: avoid UTF-8 line-drawing
3635 &`pid            `& modifier: add pid to debug output lines
3636 &`process_info   `& setting info for the process log
3637 &`queue_run      `& queue runs
3638 &`receive        `& general message reception logic
3639 &`resolver       `& turn on the DNS resolver's debugging output
3640 &`retry          `& retry handling
3641 &`rewrite        `& address rewriting
3642 &`route          `& address routing
3643 &`timestamp      `& modifier: add timestamp to debug output lines
3644 &`tls            `& TLS logic
3645 &`transport      `& transports
3646 &`uid            `& changes of uid/gid and looking up uid/gid
3647 &`verify         `& address verification logic
3648 &`all            `& almost all of the above (see below), and also &%-v%&
3649 .endd
3650 The &`all`& option excludes &`memory`& when used as &`+all`&, but includes it
3651 for &`-all`&. The reason for this is that &`+all`& is something that people
3652 tend to use when generating debug output for Exim maintainers. If &`+memory`&
3653 is included, an awful lot of output that is very rarely of interest is
3654 generated, so it now has to be explicitly requested. However, &`-all`& does
3655 turn everything off.
3656
3657 .cindex "resolver, debugging output"
3658 .cindex "DNS resolver, debugging output"
3659 The &`resolver`& option produces output only if the DNS resolver was compiled
3660 with DEBUG enabled. This is not the case in some operating systems. Also,
3661 unfortunately, debugging output from the DNS resolver is written to stdout
3662 rather than stderr.
3663
3664 The default (&%-d%& with no argument) omits &`expand`&, &`filter`&,
3665 &`interface`&, &`load`&, &`memory`&, &`pid`&, &`resolver`&, and &`timestamp`&.
3666 However, the &`pid`& selector is forced when debugging is turned on for a
3667 daemon, which then passes it on to any re-executed Exims. Exim also
3668 automatically adds the pid to debug lines when several remote deliveries are
3669 run in parallel.
3670
3671 The &`timestamp`& selector causes the current time to be inserted at the start
3672 of all debug output lines. This can be useful when trying to track down delays
3673 in processing.
3674
3675 .cindex debugging "UTF-8 in"
3676 .cindex UTF-8 "in debug output"
3677 The &`noutf8`& selector disables the use of
3678 UTF-8 line-drawing characters to group related information.
3679 When disabled. ascii-art is used instead.
3680 Using the &`+all`& option does not set this modifier,
3681
3682 If the &%debug_print%& option is set in any driver, it produces output whenever
3683 any debugging is selected, or if &%-v%& is used.
3684
3685 .vitem &%-dd%&<&'debug&~options'&>
3686 .oindex "&%-dd%&"
3687 This option behaves exactly like &%-d%& except when used on a command that
3688 starts a daemon process. In that case, debugging is turned off for the
3689 subprocesses that the daemon creates. Thus, it is useful for monitoring the
3690 behaviour of the daemon without creating as much output as full debugging does.
3691
3692 .vitem &%-dropcr%&
3693 .oindex "&%-dropcr%&"
3694 This is an obsolete option that is now a no-op. It used to affect the way Exim
3695 handled CR and LF characters in incoming messages. What happens now is
3696 described in section &<<SECTlineendings>>&.
3697
3698 .vitem &%-E%&
3699 .oindex "&%-E%&"
3700 .cindex "bounce message" "generating"
3701 This option specifies that an incoming message is a locally-generated delivery
3702 failure report. It is used internally by Exim when handling delivery failures
3703 and is not intended for external use. Its only effect is to stop Exim
3704 generating certain messages to the postmaster, as otherwise message cascades
3705 could occur in some situations. As part of the same option, a message id may
3706 follow the characters &%-E%&. If it does, the log entry for the receipt of the
3707 new message contains the id, following &"R="&, as a cross-reference.
3708
3709 .vitem &%-e%&&'x'&
3710 .oindex "&%-e%&&'x'&"
3711 There are a number of Sendmail options starting with &%-oe%& which seem to be
3712 called by various programs without the leading &%o%& in the option. For
3713 example, the &%vacation%& program uses &%-eq%&. Exim treats all options of the
3714 form &%-e%&&'x'& as synonymous with the corresponding &%-oe%&&'x'& options.
3715
3716 .vitem &%-F%&&~<&'string'&>
3717 .oindex "&%-F%&"
3718 .cindex "sender" "name"
3719 .cindex "name" "of sender"
3720 This option sets the sender's full name for use when a locally-generated
3721 message is being accepted. In the absence of this option, the user's &'gecos'&
3722 entry from the password data is used. As users are generally permitted to alter
3723 their &'gecos'& entries, no security considerations are involved. White space
3724 between &%-F%& and the <&'string'&> is optional.
3725
3726 .vitem &%-f%&&~<&'address'&>
3727 .oindex "&%-f%&"
3728 .cindex "sender" "address"
3729 .cindex "address" "sender"
3730 .cindex "trusted users"
3731 .cindex "envelope from"
3732 .cindex "envelope sender"
3733 .cindex "user" "trusted"
3734 This option sets the address of the envelope sender of a locally-generated
3735 message (also known as the return path). The option can normally be used only
3736 by a trusted user, but &%untrusted_set_sender%& can be set to allow untrusted
3737 users to use it.
3738
3739 Processes running as root or the Exim user are always trusted. Other
3740 trusted users are defined by the &%trusted_users%& or &%trusted_groups%&
3741 options. In the absence of &%-f%&, or if the caller is not trusted, the sender
3742 of a local message is set to the caller's login name at the default qualify
3743 domain.
3744
3745 There is one exception to the restriction on the use of &%-f%&: an empty sender
3746 can be specified by any user, trusted or not, to create a message that can
3747 never provoke a bounce. An empty sender can be specified either as an empty
3748 string, or as a pair of angle brackets with nothing between them, as in these
3749 examples of shell commands:
3750 .code
3751 exim -f '<>' user@domain
3752 exim -f "" user@domain
3753 .endd
3754 In addition, the use of &%-f%& is not restricted when testing a filter file
3755 with &%-bf%& or when testing or verifying addresses using the &%-bt%& or
3756 &%-bv%& options.
3757
3758 Allowing untrusted users to change the sender address does not of itself make
3759 it possible to send anonymous mail. Exim still checks that the &'From:'& header
3760 refers to the local user, and if it does not, it adds a &'Sender:'& header,
3761 though this can be overridden by setting &%no_local_from_check%&.
3762
3763 White
3764 .cindex "&""From""& line"
3765 space between &%-f%& and the <&'address'&> is optional (that is, they can be
3766 given as two arguments or one combined argument). The sender of a
3767 locally-generated message can also be set (when permitted) by an initial
3768 &"From&~"& line in the message &-- see the description of &%-bm%& above &-- but
3769 if &%-f%& is also present, it overrides &"From&~"&.
3770
3771 .vitem &%-G%&
3772 .oindex "&%-G%&"
3773 .cindex "submission fixups, suppressing (command-line)"
3774 This option is equivalent to an ACL applying:
3775 .code
3776 control = suppress_local_fixups
3777 .endd
3778 for every message received.  Note that Sendmail will complain about such
3779 bad formatting, where Exim silently just does not fix it up.  This may change
3780 in future.
3781
3782 As this affects audit information, the caller must be a trusted user to use
3783 this option.
3784
3785 .vitem &%-h%&&~<&'number'&>
3786 .oindex "&%-h%&"
3787 .cindex "Sendmail compatibility" "&%-h%& option ignored"
3788 This option is accepted for compatibility with Sendmail, but has no effect. (In
3789 Sendmail it overrides the &"hop count"& obtained by counting &'Received:'&
3790 headers.)
3791
3792 .vitem &%-i%&
3793 .oindex "&%-i%&"
3794 .cindex "Solaris" "&'mail'& command"
3795 .cindex "dot" "in incoming non-SMTP message"
3796 This option, which has the same effect as &%-oi%&, specifies that a dot on a
3797 line by itself should not terminate an incoming, non-SMTP message. I can find
3798 no documentation for this option in Solaris 2.4 Sendmail, but the &'mailx'&
3799 command in Solaris 2.4 uses it. See also &%-ti%&.
3800
3801 .vitem &%-L%&&~<&'tag'&>
3802 .oindex "&%-L%&"
3803 .cindex "syslog" "process name; set with flag"
3804 This option is equivalent to setting &%syslog_processname%& in the config
3805 file and setting &%log_file_path%& to &`syslog`&.
3806 Its use is restricted to administrators.  The configuration file has to be
3807 read and parsed, to determine access rights, before this is set and takes
3808 effect, so early configuration file errors will not honour this flag.
3809
3810 The tag should not be longer than 32 characters.
3811
3812 .vitem &%-M%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3813 .oindex "&%-M%&"
3814 .cindex "forcing delivery"
3815 .cindex "delivery" "forcing attempt"
3816 .cindex "frozen messages" "forcing delivery"
3817 This option requests Exim to run a delivery attempt on each message in turn. If
3818 any of the messages are frozen, they are automatically thawed before the
3819 delivery attempt. The settings of &%queue_domains%&, &%queue_smtp_domains%&,
3820 and &%hold_domains%& are ignored.
3821
3822 Retry
3823 .cindex "hints database" "overriding retry hints"
3824 hints for any of the addresses are overridden &-- Exim tries to deliver even if
3825 the normal retry time has not yet been reached. This option requires the caller
3826 to be an admin user. However, there is an option called &%prod_requires_admin%&
3827 which can be set false to relax this restriction (and also the same requirement
3828 for the &%-q%&, &%-R%&, and &%-S%& options).
3829
3830 The deliveries happen synchronously, that is, the original Exim process does
3831 not terminate until all the delivery attempts have finished. No output is
3832 produced unless there is a serious error. If you want to see what is happening,
3833 use the &%-v%& option as well, or inspect Exim's main log.
3834
3835 .vitem &%-Mar%&&~<&'message&~id'&>&~<&'address'&>&~<&'address'&>&~...
3836 .oindex "&%-Mar%&"
3837 .cindex "message" "adding recipients"
3838 .cindex "recipient" "adding"
3839 This option requests Exim to add the addresses to the list of recipients of the
3840 message (&"ar"& for &"add recipients"&). The first argument must be a message
3841 id, and the remaining ones must be email addresses. However, if the message is
3842 active (in the middle of a delivery attempt), it is not altered. This option
3843 can be used only by an admin user.
3844
3845 .vitem "&%-MC%&&~<&'transport'&>&~<&'hostname'&>&~<&'sequence&~number'&>&&&
3846         &~<&'message&~id'&>"
3847 .oindex "&%-MC%&"
3848 .cindex "SMTP" "passed connection"
3849 .cindex "SMTP" "multiple deliveries"
3850 .cindex "multiple SMTP deliveries"
3851 This option is not intended for use by external callers. It is used internally
3852 by Exim to invoke another instance of itself to deliver a waiting message using
3853 an existing SMTP connection, which is passed as the standard input. Details are
3854 given in chapter &<<CHAPSMTP>>&. This must be the final option, and the caller
3855 must be root or the Exim user in order to use it.
3856
3857 .vitem &%-MCA%&
3858 .oindex "&%-MCA%&"
3859 This option is not intended for use by external callers. It is used internally
3860 by Exim in conjunction with the &%-MC%& option. It signifies that the
3861 connection to the remote host has been authenticated.
3862
3863 .vitem &%-MCD%&
3864 .oindex "&%-MCD%&"
3865 This option is not intended for use by external callers. It is used internally
3866 by Exim in conjunction with the &%-MC%& option. It signifies that the
3867 remote host supports the ESMTP &_DSN_& extension.
3868
3869 .vitem &%-MCG%&&~<&'queue&~name'&>
3870 .oindex "&%-MCG%&"
3871 This option is not intended for use by external callers. It is used internally
3872 by Exim in conjunction with the &%-MC%& option. It signifies that an
3873 alternate queue is used, named by the following argument.
3874
3875 .vitem &%-MCK%&
3876 .oindex "&%-MCK%&"
3877 This option is not intended for use by external callers. It is used internally
3878 by Exim in conjunction with the &%-MC%& option. It signifies that a
3879 remote host supports the ESMTP &_CHUNKING_& extension.
3880
3881 .vitem &%-MCP%&
3882 .oindex "&%-MCP%&"
3883 This option is not intended for use by external callers. It is used internally
3884 by Exim in conjunction with the &%-MC%& option. It signifies that the server to
3885 which Exim is connected supports pipelining.
3886
3887 .vitem &%-MCQ%&&~<&'process&~id'&>&~<&'pipe&~fd'&>
3888 .oindex "&%-MCQ%&"
3889 This option is not intended for use by external callers. It is used internally
3890 by Exim in conjunction with the &%-MC%& option when the original delivery was
3891 started by a queue runner. It passes on the process id of the queue runner,
3892 together with the file descriptor number of an open pipe. Closure of the pipe
3893 signals the final completion of the sequence of processes that are passing
3894 messages through the same SMTP connection.
3895
3896 .vitem &%-MCS%&
3897 .oindex "&%-MCS%&"
3898 This option is not intended for use by external callers. It is used internally
3899 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3900 SMTP SIZE option should be used on messages delivered down the existing
3901 connection.
3902
3903 .vitem &%-MCT%&
3904 .oindex "&%-MCT%&"
3905 This option is not intended for use by external callers. It is used internally
3906 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3907 host to which Exim is connected supports TLS encryption.
3908
3909 .vitem &%-MCt%&&~<&'IP&~address'&>&~<&'port'&>&~<&'cipher'&>
3910 .oindex "&%-MCt%&"
3911 This option is not intended for use by external callers. It is used internally
3912 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3913 connection is being proxied by a parent process for handling TLS encryption.
3914 The arguments give the local address and port being proxied, and the TLS cipher.
3915
3916 .vitem &%-Mc%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3917 .oindex "&%-Mc%&"
3918 .cindex "hints database" "not overridden by &%-Mc%&"
3919 .cindex "delivery" "manually started &-- not forced"
3920 This option requests Exim to run a delivery attempt on each message, in turn,
3921 but unlike the &%-M%& option, it does check for retry hints, and respects any
3922 that are found. This option is not very useful to external callers. It is
3923 provided mainly for internal use by Exim when it needs to re-invoke itself in
3924 order to regain root privilege for a delivery (see chapter &<<CHAPsecurity>>&).
3925 However, &%-Mc%& can be useful when testing, in order to run a delivery that
3926 respects retry times and other options such as &%hold_domains%& that are
3927 overridden when &%-M%& is used. Such a delivery does not count as a queue run.
3928 If you want to run a specific delivery as if in a queue run, you should use
3929 &%-q%& with a message id argument. A distinction between queue run deliveries
3930 and other deliveries is made in one or two places.
3931
3932 .vitem &%-Mes%&&~<&'message&~id'&>&~<&'address'&>
3933 .oindex "&%-Mes%&"
3934 .cindex "message" "changing sender"
3935 .cindex "sender" "changing"
3936 This option requests Exim to change the sender address in the message to the
3937 given address, which must be a fully qualified address or &"<>"& (&"es"& for
3938 &"edit sender"&). There must be exactly two arguments. The first argument must
3939 be a message id, and the second one an email address. However, if the message
3940 is active (in the middle of a delivery attempt), its status is not altered.
3941 This option can be used only by an admin user.
3942
3943 .vitem &%-Mf%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3944 .oindex "&%-Mf%&"
3945 .cindex "freezing messages"
3946 .cindex "message" "manually freezing"
3947 This option requests Exim to mark each listed message as &"frozen"&. This
3948 prevents any delivery attempts taking place until the message is &"thawed"&,
3949 either manually or as a result of the &%auto_thaw%& configuration option.
3950 However, if any of the messages are active (in the middle of a delivery
3951 attempt), their status is not altered. This option can be used only by an admin
3952 user.
3953
3954 .vitem &%-Mg%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3955 .oindex "&%-Mg%&"
3956 .cindex "giving up on messages"
3957 .cindex "message" "abandoning delivery attempts"
3958 .cindex "delivery" "abandoning further attempts"
3959 This option requests Exim to give up trying to deliver the listed messages,
3960 including any that are frozen. However, if any of the messages are active,
3961 their status is not altered. For non-bounce messages, a delivery error message
3962 is sent to the sender, containing the text &"cancelled by administrator"&.
3963 Bounce messages are just discarded. This option can be used only by an admin
3964 user.
3965
3966 .new
3967 .vitem &%-MG%&&~<&'queue&~name'&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3968 .oindex "&%-MG%&"
3969 .cindex queue named
3970 .cindex "named queues"
3971 .cindex "queue" "moving messages"
3972 This option requests that each listed message be moved from its current
3973 queue to the given named queue.
3974 The destination queue name argument is required, but can be an empty
3975 string to define the default queue.
3976 If the messages are not currently located in the default queue,
3977 a &%-qG<name>%& option will be required to define the source queue.
3978 .wen
3979
3980 .vitem &%-Mmad%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3981 .oindex "&%-Mmad%&"
3982 .cindex "delivery" "cancelling all"
3983 This option requests Exim to mark all the recipient addresses in the messages
3984 as already delivered (&"mad"& for &"mark all delivered"&). However, if any
3985 message is active (in the middle of a delivery attempt), its status is not
3986 altered. This option can be used only by an admin user.
3987
3988 .vitem &%-Mmd%&&~<&'message&~id'&>&~<&'address'&>&~<&'address'&>&~...
3989 .oindex "&%-Mmd%&"
3990 .cindex "delivery" "cancelling by address"
3991 .cindex "recipient" "removing"
3992 .cindex "removing recipients"
3993 This option requests Exim to mark the given addresses as already delivered
3994 (&"md"& for &"mark delivered"&). The first argument must be a message id, and
3995 the remaining ones must be email addresses. These are matched to recipient
3996 addresses in the message in a case-sensitive manner. If the message is active
3997 (in the middle of a delivery attempt), its status is not altered. This option
3998 can be used only by an admin user.
3999
4000 .vitem &%-Mrm%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
4001 .oindex "&%-Mrm%&"
4002 .cindex "removing messages"
4003 .cindex "abandoning mail"
4004 .cindex "message" "manually discarding"
4005 This option requests Exim to remove the given messages from the queue. No
4006 bounce messages are sent; each message is simply forgotten. However, if any of
4007 the messages are active, their status is not altered. This option can be used
4008 only by an admin user or by the user who originally caused the message to be
4009 placed in the queue.
4010
4011 . .new
4012 . .vitem &%-MS%&
4013 . .oindex "&%-MS%&"
4014 . .cindex REQUIRETLS
4015 . This option is used to request REQUIRETLS processing on the message.
4016 . It is used internally by Exim in conjunction with -E when generating
4017 . a bounce message.
4018 . .wen
4019
4020 .vitem &%-Mset%&&~<&'message&~id'&>
4021 .oindex "&%-Mset%&"
4022 .cindex "testing" "string expansion"
4023 .cindex "expansion" "testing"
4024 This option is useful only in conjunction with &%-be%& (that is, when testing
4025 string expansions). Exim loads the given message from its spool before doing
4026 the test expansions, thus setting message-specific variables such as
4027 &$message_size$& and the header variables. The &$recipients$& variable is made
4028 available. This feature is provided to make it easier to test expansions that
4029 make use of these variables. However, this option can be used only by an admin
4030 user. See also &%-bem%&.
4031
4032 .vitem &%-Mt%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
4033 .oindex "&%-Mt%&"
4034 .cindex "thawing messages"
4035 .cindex "unfreezing messages"
4036 .cindex "frozen messages" "thawing"
4037 .cindex "message" "thawing frozen"
4038 This option requests Exim to &"thaw"& any of the listed messages that are
4039 &"frozen"&, so that delivery attempts can resume. However, if any of the
4040 messages are active, their status is not altered. This option can be used only
4041 by an admin user.
4042
4043 .vitem &%-Mvb%&&~<&'message&~id'&>
4044 .oindex "&%-Mvb%&"
4045 .cindex "listing" "message body"
4046 .cindex "message" "listing body of"
4047 This option causes the contents of the message body (-D) spool file to be
4048 written to the standard output. This option can be used only by an admin user.
4049
4050 .vitem &%-Mvc%&&~<&'message&~id'&>
4051 .oindex "&%-Mvc%&"
4052 .cindex "message" "listing in RFC 2822 format"
4053 .cindex "listing" "message in RFC 2822 format"
4054 This option causes a copy of the complete message (header lines plus body) to
4055 be written to the standard output in RFC 2822 format. This option can be used
4056 only by an admin user.
4057
4058 .vitem &%-Mvh%&&~<&'message&~id'&>
4059 .oindex "&%-Mvh%&"
4060 .cindex "listing" "message headers"
4061 .cindex "header lines" "listing"
4062 .cindex "message" "listing header lines"
4063 This option causes the contents of the message headers (-H) spool file to be
4064 written to the standard output. This option can be used only by an admin user.
4065
4066 .vitem &%-Mvl%&&~<&'message&~id'&>
4067 .oindex "&%-Mvl%&"
4068 .cindex "listing" "message log"
4069 .cindex "message" "listing message log"
4070 This option causes the contents of the message log spool file to be written to
4071 the standard output. This option can be used only by an admin user.
4072
4073 .vitem &%-m%&
4074 .oindex "&%-m%&"
4075 This is apparently a synonym for &%-om%& that is accepted by Sendmail, so Exim
4076 treats it that way too.
4077
4078 .vitem &%-N%&
4079 .oindex "&%-N%&"
4080 .cindex "debugging" "&%-N%& option"
4081 .cindex "debugging" "suppressing delivery"
4082 This is a debugging option that inhibits delivery of a message at the transport
4083 level. It implies &%-v%&. Exim goes through many of the motions of delivery &--
4084 it just doesn't actually transport the message, but instead behaves as if it
4085 had successfully done so. However, it does not make any updates to the retry
4086 database, and the log entries for deliveries are flagged with &"*>"& rather
4087 than &"=>"&.
4088
4089 Because &%-N%& discards any message to which it applies, only root or the Exim
4090 user are allowed to use it with &%-bd%&, &%-q%&, &%-R%& or &%-M%&. In other
4091 words, an ordinary user can use it only when supplying an incoming message to
4092 which it will apply. Although transportation never fails when &%-N%& is set, an
4093 address may be deferred because of a configuration problem on a transport, or a
4094 routing problem. Once &%-N%& has been used for a delivery attempt, it sticks to
4095 the message, and applies to any subsequent delivery attempts that may happen
4096 for that message.
4097
4098 .vitem &%-n%&
4099 .oindex "&%-n%&"
4100 This option is interpreted by Sendmail to mean &"no aliasing"&.
4101 For normal modes of operation, it is ignored by Exim.
4102 When combined with &%-bP%& it makes the output more terse (suppresses
4103 option names, environment values and config pretty printing).
4104
4105 .vitem &%-O%&&~<&'data'&>
4106 .oindex "&%-O%&"
4107 This option is interpreted by Sendmail to mean &`set option`&. It is ignored by
4108 Exim.
4109
4110 .vitem &%-oA%&&~<&'file&~name'&>
4111 .oindex "&%-oA%&"
4112 .cindex "Sendmail compatibility" "&%-oA%& option"
4113 This option is used by Sendmail in conjunction with &%-bi%& to specify an
4114 alternative alias filename. Exim handles &%-bi%& differently; see the
4115 description above.
4116
4117 .vitem &%-oB%&&~<&'n'&>
4118 .oindex "&%-oB%&"
4119 .cindex "SMTP" "passed connection"
4120 .cindex "SMTP" "multiple deliveries"
4121 .cindex "multiple SMTP deliveries"
4122 This is a debugging option which limits the maximum number of messages that can
4123 be delivered down one SMTP connection, overriding the value set in any &(smtp)&
4124 transport. If <&'n'&> is omitted, the limit is set to 1.
4125
4126 .vitem &%-odb%&
4127 .oindex "&%-odb%&"
4128 .cindex "background delivery"
4129 .cindex "delivery" "in the background"
4130 This option applies to all modes in which Exim accepts incoming messages,
4131 including the listening daemon. It requests &"background"& delivery of such
4132 messages, which means that the accepting process automatically starts a
4133 delivery process for each message received, but does not wait for the delivery
4134 processes to finish.
4135
4136 When all the messages have been received, the reception process exits,
4137 leaving the delivery processes to finish in their own time. The standard output
4138 and error streams are closed at the start of each delivery process.
4139 This is the default action if none of the &%-od%& options are present.
4140
4141 If one of the queueing options in the configuration file
4142 (&%queue_only%& or &%queue_only_file%&, for example) is in effect, &%-odb%&
4143 overrides it if &%queue_only_override%& is set true, which is the default
4144 setting. If &%queue_only_override%& is set false, &%-odb%& has no effect.
4145
4146 .vitem &%-odf%&
4147 .oindex "&%-odf%&"
4148 .cindex "foreground delivery"
4149 .cindex "delivery" "in the foreground"
4150 This option requests &"foreground"& (synchronous) delivery when Exim has
4151 accepted a locally-generated message. (For the daemon it is exactly the same as
4152 &%-odb%&.) A delivery process is automatically started to deliver the message,
4153 and Exim waits for it to complete before proceeding.
4154
4155 The original Exim reception process does not finish until the delivery
4156 process for the final message has ended. The standard error stream is left open
4157 during deliveries.
4158
4159 However, like &%-odb%&, this option has no effect if &%queue_only_override%& is
4160 false and one of the queueing options in the configuration file is in effect.
4161
4162 If there is a temporary delivery error during foreground delivery, the
4163 message is left in the queue for later delivery, and the original reception
4164 process exits. See chapter &<<CHAPnonqueueing>>& for a way of setting up a
4165 restricted configuration that never queues messages.
4166
4167
4168 .vitem &%-odi%&
4169 .oindex "&%-odi%&"
4170 This option is synonymous with &%-odf%&. It is provided for compatibility with
4171 Sendmail.
4172
4173 .vitem &%-odq%&
4174 .oindex "&%-odq%&"
4175 .cindex "non-immediate delivery"
4176 .cindex "delivery" "suppressing immediate"
4177 .cindex "queueing incoming messages"
4178 This option applies to all modes in which Exim accepts incoming messages,
4179 including the listening daemon. It specifies that the accepting process should
4180 not automatically start a delivery process for each message received. Messages
4181 are placed in the queue, and remain there until a subsequent queue runner
4182 process encounters them. There are several configuration options (such as
4183 &%queue_only%&) that can be used to queue incoming messages under certain
4184 conditions. This option overrides all of them and also &%-odqs%&. It always
4185 forces queueing.
4186
4187 .vitem &%-odqs%&
4188 .oindex "&%-odqs%&"
4189 .cindex "SMTP" "delaying delivery"
4190 This option is a hybrid between &%-odb%&/&%-odi%& and &%-odq%&.
4191 However, like &%-odb%& and &%-odi%&, this option has no effect if
4192 &%queue_only_override%& is false and one of the queueing options in the
4193 configuration file is in effect.
4194
4195 When &%-odqs%& does operate, a delivery process is started for each incoming
4196 message, in the background by default, but in the foreground if &%-odi%& is
4197 also present. The recipient addresses are routed, and local deliveries are done
4198 in the normal way. However, if any SMTP deliveries are required, they are not
4199 done at this time, so the message remains in the queue until a subsequent queue
4200 runner process encounters it. Because routing was done, Exim knows which
4201 messages are waiting for which hosts, and so a number of messages for the same
4202 host can be sent in a single SMTP connection. The &%queue_smtp_domains%&
4203 configuration option has the same effect for specific domains. See also the
4204 &%-qq%& option.
4205
4206 .vitem &%-oee%&
4207 .oindex "&%-oee%&"
4208 .cindex "error" "reporting"
4209 If an error is detected while a non-SMTP message is being received (for
4210 example, a malformed address), the error is reported to the sender in a mail
4211 message.
4212
4213 .cindex "return code" "for &%-oee%&"
4214 Provided
4215 this error message is successfully sent, the Exim receiving process
4216 exits with a return code of zero. If not, the return code is 2 if the problem
4217 is that the original message has no recipients, or 1 for any other error.
4218 This is the default &%-oe%&&'x'& option if Exim is called as &'rmail'&.
4219
4220 .vitem &%-oem%&
4221 .oindex "&%-oem%&"
4222 .cindex "error" "reporting"
4223 .cindex "return code" "for &%-oem%&"
4224 This is the same as &%-oee%&, except that Exim always exits with a non-zero
4225 return code, whether or not the error message was successfully sent.
4226 This is the default &%-oe%&&'x'& option, unless Exim is called as &'rmail'&.
4227
4228 .vitem &%-oep%&
4229 .oindex "&%-oep%&"
4230 .cindex "error" "reporting"
4231 If an error is detected while a non-SMTP message is being received, the
4232 error is reported by writing a message to the standard error file (stderr).
4233 .cindex "return code" "for &%-oep%&"
4234 The return code is 1 for all errors.
4235
4236 .vitem &%-oeq%&
4237 .oindex "&%-oeq%&"
4238 .cindex "error" "reporting"
4239 This option is supported for compatibility with Sendmail, but has the same
4240 effect as &%-oep%&.
4241
4242 .vitem &%-oew%&
4243 .oindex "&%-oew%&"
4244 .cindex "error" "reporting"
4245 This option is supported for compatibility with Sendmail, but has the same
4246 effect as &%-oem%&.
4247
4248 .vitem &%-oi%&
4249 .oindex "&%-oi%&"
4250 .cindex "dot" "in incoming non-SMTP message"
4251 This option, which has the same effect as &%-i%&, specifies that a dot on a
4252 line by itself should not terminate an incoming, non-SMTP message. Otherwise, a
4253 single dot does terminate, though Exim does no special processing for other
4254 lines that start with a dot. This option is set by default if Exim is called as
4255 &'rmail'&. See also &%-ti%&.
4256
4257 .vitem &%-oitrue%&
4258 .oindex "&%-oitrue%&"
4259 This option is treated as synonymous with &%-oi%&.
4260
4261 .vitem &%-oMa%&&~<&'host&~address'&>
4262 .oindex "&%-oMa%&"
4263 .cindex "sender" "host address, specifying for local message"
4264 A number of options starting with &%-oM%& can be used to set values associated
4265 with remote hosts on locally-submitted messages (that is, messages not received
4266 over TCP/IP). These options can be used by any caller in conjunction with the
4267 &%-bh%&, &%-be%&, &%-bf%&, &%-bF%&, &%-bt%&, or &%-bv%& testing options. In
4268 other circumstances, they are ignored unless the caller is trusted.
4269
4270 The &%-oMa%& option sets the sender host address. This may include a port
4271 number at the end, after a full stop (period). For example:
4272 .code
4273 exim -bs -oMa 10.9.8.7.1234
4274 .endd
4275 An alternative syntax is to enclose the IP address in square brackets,
4276 followed by a colon and the port number:
4277 .code
4278 exim -bs -oMa [10.9.8.7]:1234
4279 .endd
4280 The IP address is placed in the &$sender_host_address$& variable, and the
4281 port, if present, in &$sender_host_port$&. If both &%-oMa%& and &%-bh%&
4282 are present on the command line, the sender host IP address is taken from
4283 whichever one is last.
4284
4285 .vitem &%-oMaa%&&~<&'name'&>
4286 .oindex "&%-oMaa%&"
4287 .cindex "authentication" "name, specifying for local message"
4288 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMaa%&
4289 option sets the value of &$sender_host_authenticated$& (the authenticator
4290 name). See chapter &<<CHAPSMTPAUTH>>& for a discussion of SMTP authentication.
4291 This option can be used with &%-bh%& and &%-bs%& to set up an
4292 authenticated SMTP session without actually using the SMTP AUTH command.
4293
4294 .vitem &%-oMai%&&~<&'string'&>
4295 .oindex "&%-oMai%&"
4296 .cindex "authentication" "id, specifying for local message"
4297 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMai%&
4298 option sets the value of &$authenticated_id$& (the id that was authenticated).
4299 This overrides the default value (the caller's login id, except with &%-bh%&,
4300 where there is no default) for messages from local sources. See chapter
4301 &<<CHAPSMTPAUTH>>& for a discussion of authenticated ids.
4302
4303 .vitem &%-oMas%&&~<&'address'&>
4304 .oindex "&%-oMas%&"
4305 .cindex "authentication" "sender, specifying for local message"
4306 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMas%&
4307 option sets the authenticated sender value in &$authenticated_sender$&. It
4308 overrides the sender address that is created from the caller's login id for
4309 messages from local sources, except when &%-bh%& is used, when there is no
4310 default. For both &%-bh%& and &%-bs%&, an authenticated sender that is
4311 specified on a MAIL command overrides this value. See chapter
4312 &<<CHAPSMTPAUTH>>& for a discussion of authenticated senders.
4313
4314 .vitem &%-oMi%&&~<&'interface&~address'&>
4315 .oindex "&%-oMi%&"
4316 .cindex "interface" "address, specifying for local message"
4317 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMi%&
4318 option sets the IP interface address value. A port number may be included,
4319 using the same syntax as for &%-oMa%&. The interface address is placed in
4320 &$received_ip_address$& and the port number, if present, in &$received_port$&.
4321
4322 .vitem &%-oMm%&&~<&'message&~reference'&>
4323 .oindex "&%-oMm%&"
4324 .cindex "message reference" "message reference, specifying for local message"
4325 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMm%&
4326 option sets the message reference, e.g. message-id, and is logged during
4327 delivery. This is useful when some kind of audit trail is required to tie
4328 messages together. The format of the message reference is checked and will
4329 abort if the format is invalid. The option will only be accepted if exim is
4330 running in trusted mode, not as any regular user.
4331
4332 The best example of a message reference is when Exim sends a bounce message.
4333 The message reference is the message-id of the original message for which Exim
4334 is sending the bounce.
4335
4336 .vitem &%-oMr%&&~<&'protocol&~name'&>
4337 .oindex "&%-oMr%&"
4338 .cindex "protocol, specifying for local message"
4339 .vindex "&$received_protocol$&"
4340 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMr%&
4341 option sets the received protocol value that is stored in
4342 &$received_protocol$&. However, it does not apply (and is ignored) when &%-bh%&
4343 or &%-bs%& is used. For &%-bh%&, the protocol is forced to one of the standard
4344 SMTP protocol names (see the description of &$received_protocol$& in section
4345 &<<SECTexpvar>>&). For &%-bs%&, the protocol is always &"local-"& followed by
4346 one of those same names. For &%-bS%& (batched SMTP) however, the protocol can
4347 be set by &%-oMr%&. Repeated use of this option is not supported.
4348
4349 .vitem &%-oMs%&&~<&'host&~name'&>
4350 .oindex "&%-oMs%&"
4351 .cindex "sender" "host name, specifying for local message"
4352 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMs%&
4353 option sets the sender host name in &$sender_host_name$&. When this option is
4354 present, Exim does not attempt to look up a host name from an IP address; it
4355 uses the name it is given.
4356
4357 .vitem &%-oMt%&&~<&'ident&~string'&>
4358 .oindex "&%-oMt%&"
4359 .cindex "sender" "ident string, specifying for local message"
4360 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMt%&
4361 option sets the sender ident value in &$sender_ident$&. The default setting for
4362 local callers is the login id of the calling process, except when &%-bh%& is
4363 used, when there is no default.
4364
4365 .vitem &%-om%&
4366 .oindex "&%-om%&"
4367 .cindex "Sendmail compatibility" "&%-om%& option ignored"
4368 In Sendmail, this option means &"me too"&, indicating that the sender of a
4369 message should receive a copy of the message if the sender appears in an alias
4370 expansion. Exim always does this, so the option does nothing.
4371
4372 .vitem &%-oo%&
4373 .oindex "&%-oo%&"
4374 .cindex "Sendmail compatibility" "&%-oo%& option ignored"
4375 This option is ignored. In Sendmail it specifies &"old style headers"&,
4376 whatever that means.
4377
4378 .vitem &%-oP%&&~<&'path'&>
4379 .oindex "&%-oP%&"
4380 .cindex "pid (process id)" "of daemon"
4381 .cindex "daemon" "process id (pid)"
4382 This option is useful only in conjunction with &%-bd%& or &%-q%& with a time
4383 value. The option specifies the file to which the process id of the daemon is
4384 written. When &%-oX%& is used with &%-bd%&, or when &%-q%& with a time is used
4385 without &%-bd%&, this is the only way of causing Exim to write a pid file,
4386 because in those cases, the normal pid file is not used.
4387
4388 .vitem &%-or%&&~<&'time'&>
4389 .oindex "&%-or%&"
4390 .cindex "timeout" "for non-SMTP input"
4391 This option sets a timeout value for incoming non-SMTP messages. If it is not
4392 set, Exim will wait forever for the standard input. The value can also be set
4393 by the &%receive_timeout%& option. The format used for specifying times is
4394 described in section &<<SECTtimeformat>>&.
4395
4396 .vitem &%-os%&&~<&'time'&>
4397 .oindex "&%-os%&"
4398 .cindex "timeout" "for SMTP input"
4399 .cindex "SMTP" "input timeout"
4400 This option sets a timeout value for incoming SMTP messages. The timeout
4401 applies to each SMTP command and block of data. The value can also be set by
4402 the &%smtp_receive_timeout%& option; it defaults to 5 minutes. The format used
4403 for specifying times is described in section &<<SECTtimeformat>>&.
4404
4405 .vitem &%-ov%&
4406 .oindex "&%-ov%&"
4407 This option has exactly the same effect as &%-v%&.
4408
4409 .vitem &%-oX%&&~<&'number&~or&~string'&>
4410 .oindex "&%-oX%&"
4411 .cindex "TCP/IP" "setting listening ports"
4412 .cindex "TCP/IP" "setting listening interfaces"
4413 .cindex "port" "receiving TCP/IP"
4414 This option is relevant only when the &%-bd%& (start listening daemon) option
4415 is also given. It controls which ports and interfaces the daemon uses. Details
4416 of the syntax, and how it interacts with configuration file options, are given
4417 in chapter &<<CHAPinterfaces>>&. When &%-oX%& is used to start a daemon, no pid
4418 file is written unless &%-oP%& is also present to specify a pid filename.
4419
4420 .vitem &%-pd%&
4421 .oindex "&%-pd%&"
4422 .cindex "Perl" "starting the interpreter"
4423 This option applies when an embedded Perl interpreter is linked with Exim (see
4424 chapter &<<CHAPperl>>&). It overrides the setting of the &%perl_at_start%&
4425 option, forcing the starting of the interpreter to be delayed until it is
4426 needed.
4427
4428 .vitem &%-ps%&
4429 .oindex "&%-ps%&"
4430 .cindex "Perl" "starting the interpreter"
4431 This option applies when an embedded Perl interpreter is linked with Exim (see
4432 chapter &<<CHAPperl>>&). It overrides the setting of the &%perl_at_start%&
4433 option, forcing the starting of the interpreter to occur as soon as Exim is
4434 started.
4435
4436 .vitem &%-p%&<&'rval'&>:<&'sval'&>
4437 .oindex "&%-p%&"
4438 For compatibility with Sendmail, this option is equivalent to
4439 .display
4440 &`-oMr`& <&'rval'&> &`-oMs`& <&'sval'&>
4441 .endd
4442 It sets the incoming protocol and host name (for trusted callers). The
4443 host name and its colon can be omitted when only the protocol is to be set.
4444 Note the Exim already has two private options, &%-pd%& and &%-ps%&, that refer
4445 to embedded Perl. It is therefore impossible to set a protocol value of &`d`&
4446 or &`s`& using this option (but that does not seem a real limitation).
4447 Repeated use of this option is not supported.
4448
4449 .vitem &%-q%&
4450 .oindex "&%-q%&"
4451 .cindex "queue runner" "starting manually"
4452 This option is normally restricted to admin users. However, there is a
4453 configuration option called &%prod_requires_admin%& which can be set false to
4454 relax this restriction (and also the same requirement for the &%-M%&, &%-R%&,
4455 and &%-S%& options).
4456
4457 .cindex "queue runner" "description of operation"
4458 If other commandline options do not specify an action,
4459 the &%-q%& option starts one queue runner process. This scans the queue of
4460 waiting messages, and runs a delivery process for each one in turn. It waits
4461 for each delivery process to finish before starting the next one. A delivery
4462 process may not actually do any deliveries if the retry times for the addresses
4463 have not been reached. Use &%-qf%& (see below) if you want to override this.
4464
4465 If
4466 .cindex "SMTP" "passed connection"
4467 .cindex "SMTP" "multiple deliveries"
4468 .cindex "multiple SMTP deliveries"
4469 the delivery process spawns other processes to deliver other messages down
4470 passed SMTP connections, the queue runner waits for these to finish before
4471 proceeding.
4472
4473 When all the queued messages have been considered, the original queue runner
4474 process terminates. In other words, a single pass is made over the waiting
4475 mail, one message at a time. Use &%-q%& with a time (see below) if you want
4476 this to be repeated periodically.
4477
4478 Exim processes the waiting messages in an unpredictable order. It isn't very
4479 random, but it is likely to be different each time, which is all that matters.
4480 If one particular message screws up a remote MTA, other messages to the same
4481 MTA have a chance of getting through if they get tried first.
4482
4483 It is possible to cause the messages to be processed in lexical message id
4484 order, which is essentially the order in which they arrived, by setting the
4485 &%queue_run_in_order%& option, but this is not recommended for normal use.
4486
4487 .vitem &%-q%&<&'qflags'&>
4488 The &%-q%& option may be followed by one or more flag letters that change its
4489 behaviour. They are all optional, but if more than one is present, they must
4490 appear in the correct order. Each flag is described in a separate item below.
4491
4492 .vitem &%-qq...%&
4493 .oindex "&%-qq%&"
4494 .cindex "queue" "double scanning"
4495 .cindex "queue" "routing"
4496 .cindex "routing" "whole queue before delivery"
4497 An option starting with &%-qq%& requests a two-stage queue run. In the first
4498 stage, the queue is scanned as if the &%queue_smtp_domains%& option matched
4499 every domain. Addresses are routed, local deliveries happen, but no remote
4500 transports are run.
4501
4502 .cindex "hints database" "remembering routing"
4503 The hints database that remembers which messages are waiting for specific hosts
4504 is updated, as if delivery to those hosts had been deferred. After this is
4505 complete, a second, normal queue scan happens, with routing and delivery taking
4506 place as normal. Messages that are routed to the same host should mostly be
4507 delivered down a single SMTP
4508 .cindex "SMTP" "passed connection"
4509 .cindex "SMTP" "multiple deliveries"
4510 .cindex "multiple SMTP deliveries"
4511 connection because of the hints that were set up during the first queue scan.
4512 This option may be useful for hosts that are connected to the Internet
4513 intermittently.
4514
4515 .vitem &%-q[q]i...%&
4516 .oindex "&%-qi%&"
4517 .cindex "queue" "initial delivery"
4518 If the &'i'& flag is present, the queue runner runs delivery processes only for
4519 those messages that haven't previously been tried. (&'i'& stands for &"initial
4520 delivery"&.) This can be helpful if you are putting messages in the queue using
4521 &%-odq%& and want a queue runner just to process the new messages.
4522
4523 .vitem &%-q[q][i]f...%&
4524 .oindex "&%-qf%&"
4525 .cindex "queue" "forcing delivery"
4526 .cindex "delivery" "forcing in queue run"
4527 If one &'f'& flag is present, a delivery attempt is forced for each non-frozen
4528 message, whereas without &'f'& only those non-frozen addresses that have passed
4529 their retry times are tried.
4530
4531 .vitem &%-q[q][i]ff...%&
4532 .oindex "&%-qff%&"
4533 .cindex "frozen messages" "forcing delivery"
4534 If &'ff'& is present, a delivery attempt is forced for every message, whether
4535 frozen or not.
4536
4537 .vitem &%-q[q][i][f[f]]l%&
4538 .oindex "&%-ql%&"
4539 .cindex "queue" "local deliveries only"
4540 The &'l'& (the letter &"ell"&) flag specifies that only local deliveries are to
4541 be done. If a message requires any remote deliveries, it remains in the queue
4542 for later delivery.
4543
4544 .vitem &%-q[q][i][f[f]][l][G<name>[/<time>]]]%&
4545 .oindex "&%-qG%&"
4546 .cindex queue named
4547 .cindex "named queues"
4548 .cindex "queue" "delivering specific messages"
4549 If the &'G'& flag and a name is present, the queue runner operates on the
4550 queue with the given name rather than the default queue.
4551 The name should not contain a &'/'& character.
4552 For a periodic queue run (see below)
4553 append to the name a slash and a time value.
4554
4555 If other commandline options specify an action, a &'-qG<name>'& option
4556 will specify a queue to operate on.
4557 For example:
4558 .code
4559 exim -bp -qGquarantine
4560 mailq -qGquarantine
4561 exim -qGoffpeak -Rf @special.domain.example
4562 .endd
4563
4564 .vitem &%-q%&<&'qflags'&>&~<&'start&~id'&>&~<&'end&~id'&>
4565 When scanning the queue, Exim can be made to skip over messages whose ids are
4566 lexically less than a given value by following the &%-q%& option with a
4567 starting message id. For example:
4568 .code
4569 exim -q 0t5C6f-0000c8-00
4570 .endd
4571 Messages that arrived earlier than &`0t5C6f-0000c8-00`& are not inspected. If a
4572 second message id is given, messages whose ids are lexically greater than it
4573 are also skipped. If the same id is given twice, for example,
4574 .code
4575 exim -q 0t5C6f-0000c8-00 0t5C6f-0000c8-00
4576 .endd
4577 just one delivery process is started, for that message. This differs from
4578 &%-M%& in that retry data is respected, and it also differs from &%-Mc%& in
4579 that it counts as a delivery from a queue run. Note that the selection
4580 mechanism does not affect the order in which the messages are scanned. There
4581 are also other ways of selecting specific sets of messages for delivery in a
4582 queue run &-- see &%-R%& and &%-S%&.
4583
4584 .vitem &%-q%&<&'qflags'&><&'time'&>
4585 .cindex "queue runner" "starting periodically"
4586 .cindex "periodic queue running"
4587 When a time value is present, the &%-q%& option causes Exim to run as a daemon,
4588 starting a queue runner process at intervals specified by the given time value
4589 (whose format is described in section &<<SECTtimeformat>>&). This form of the
4590 &%-q%& option is commonly combined with the &%-bd%& option, in which case a
4591 single daemon process handles both functions. A common way of starting up a
4592 combined daemon at system boot time is to use a command such as
4593 .code
4594 /usr/exim/bin/exim -bd -q30m
4595 .endd
4596 Such a daemon listens for incoming SMTP calls, and also starts a queue runner
4597 process every 30 minutes.
4598
4599 When a daemon is started by &%-q%& with a time value, but without &%-bd%&, no
4600 pid file is written unless one is explicitly requested by the &%-oP%& option.
4601
4602 .vitem &%-qR%&<&'rsflags'&>&~<&'string'&>
4603 .oindex "&%-qR%&"
4604 This option is synonymous with &%-R%&. It is provided for Sendmail
4605 compatibility.
4606
4607 .vitem &%-qS%&<&'rsflags'&>&~<&'string'&>
4608 .oindex "&%-qS%&"
4609 This option is synonymous with &%-S%&.
4610
4611 .vitem &%-R%&<&'rsflags'&>&~<&'string'&>
4612 .oindex "&%-R%&"
4613 .cindex "queue runner" "for specific recipients"
4614 .cindex "delivery" "to given domain"
4615 .cindex "domain" "delivery to"
4616 The <&'rsflags'&> may be empty, in which case the white space before the string
4617 is optional, unless the string is &'f'&, &'ff'&, &'r'&, &'rf'&, or &'rff'&,
4618 which are the possible values for <&'rsflags'&>. White space is required if
4619 <&'rsflags'&> is not empty.
4620
4621 This option is similar to &%-q%& with no time value, that is, it causes Exim to
4622 perform a single queue run, except that, when scanning the messages on the
4623 queue, Exim processes only those that have at least one undelivered recipient
4624 address containing the given string, which is checked in a case-independent
4625 way. If the <&'rsflags'&> start with &'r'&, <&'string'&> is interpreted as a
4626 regular expression; otherwise it is a literal string.
4627
4628 If you want to do periodic queue runs for messages with specific recipients,
4629 you can combine &%-R%& with &%-q%& and a time value. For example:
4630 .code
4631 exim -q25m -R @special.domain.example
4632 .endd
4633 This example does a queue run for messages with recipients in the given domain
4634 every 25 minutes. Any additional flags that are specified with &%-q%& are
4635 applied to each queue run.
4636
4637 Once a message is selected for delivery by this mechanism, all its addresses
4638 are processed. For the first selected message, Exim overrides any retry
4639 information and forces a delivery attempt for each undelivered address. This
4640 means that if delivery of any address in the first message is successful, any
4641 existing retry information is deleted, and so delivery attempts for that
4642 address in subsequently selected messages (which are processed without forcing)
4643 will run. However, if delivery of any address does not succeed, the retry
4644 information is updated, and in subsequently selected messages, the failing
4645 address will be skipped.
4646
4647 .cindex "frozen messages" "forcing delivery"
4648 If the <&'rsflags'&> contain &'f'& or &'ff'&, the delivery forcing applies to
4649 all selected messages, not just the first; frozen messages are included when
4650 &'ff'& is present.
4651
4652 The &%-R%& option makes it straightforward to initiate delivery of all messages
4653 to a given domain after a host has been down for some time. When the SMTP
4654 command ETRN is accepted by its ACL (see chapter &<<CHAPACL>>&), its default
4655 effect is to run Exim with the &%-R%& option, but it can be configured to run
4656 an arbitrary command instead.
4657
4658 .vitem &%-r%&
4659 .oindex "&%-r%&"
4660 This is a documented (for Sendmail) obsolete alternative name for &%-f%&.
4661
4662 .vitem &%-S%&<&'rsflags'&>&~<&'string'&>
4663 .oindex "&%-S%&"
4664 .cindex "delivery" "from given sender"
4665 .cindex "queue runner" "for specific senders"
4666 This option acts like &%-R%& except that it checks the string against each
4667 message's sender instead of against the recipients. If &%-R%& is also set, both
4668 conditions must be met for a message to be selected. If either of the options
4669 has &'f'& or &'ff'& in its flags, the associated action is taken.
4670
4671 .vitem &%-Tqt%&&~<&'times'&>
4672 .oindex "&%-Tqt%&"
4673 This is an option that is exclusively for use by the Exim testing suite. It is not
4674 recognized when Exim is run normally. It allows for the setting up of explicit
4675 &"queue times"& so that various warning/retry features can be tested.
4676
4677 .vitem &%-t%&
4678 .oindex "&%-t%&"
4679 .cindex "recipient" "extracting from header lines"
4680 .cindex "&'Bcc:'& header line"
4681 .cindex "&'Cc:'& header line"
4682 .cindex "&'To:'& header line"
4683 When Exim is receiving a locally-generated, non-SMTP message on its standard
4684 input, the &%-t%& option causes the recipients of the message to be obtained
4685 from the &'To:'&, &'Cc:'&, and &'Bcc:'& header lines in the message instead of
4686 from the command arguments. The addresses are extracted before any rewriting
4687 takes place and the &'Bcc:'& header line, if present, is then removed.
4688
4689 .cindex "Sendmail compatibility" "&%-t%& option"
4690 If the command has any arguments, they specify addresses to which the message
4691 is &'not'& to be delivered. That is, the argument addresses are removed from
4692 the recipients list obtained from the headers. This is compatible with Smail 3
4693 and in accordance with the documented behaviour of several versions of
4694 Sendmail, as described in man pages on a number of operating systems (e.g.
4695 Solaris 8, IRIX 6.5, HP-UX 11). However, some versions of Sendmail &'add'&
4696 argument addresses to those obtained from the headers, and the O'Reilly
4697 Sendmail book documents it that way. Exim can be made to add argument addresses
4698 instead of subtracting them by setting the option
4699 &%extract_addresses_remove_arguments%& false.
4700
4701 .cindex "&%Resent-%& header lines" "with &%-t%&"
4702 If there are any &%Resent-%& header lines in the message, Exim extracts
4703 recipients from all &'Resent-To:'&, &'Resent-Cc:'&, and &'Resent-Bcc:'& header
4704 lines instead of from &'To:'&, &'Cc:'&, and &'Bcc:'&. This is for compatibility
4705 with Sendmail and other MTAs. (Prior to release 4.20, Exim gave an error if
4706 &%-t%& was used in conjunction with &%Resent-%& header lines.)
4707
4708 RFC 2822 talks about different sets of &%Resent-%& header lines (for when a
4709 message is resent several times). The RFC also specifies that they should be
4710 added at the front of the message, and separated by &'Received:'& lines. It is
4711 not at all clear how &%-t%& should operate in the present of multiple sets,
4712 nor indeed exactly what constitutes a &"set"&.
4713 In practice, it seems that MUAs do not follow the RFC. The &%Resent-%& lines
4714 are often added at the end of the header, and if a message is resent more than
4715 once, it is common for the original set of &%Resent-%& headers to be renamed as
4716 &%X-Resent-%& when a new set is added. This removes any possible ambiguity.
4717
4718 .vitem &%-ti%&
4719 .oindex "&%-ti%&"
4720 This option is exactly equivalent to &%-t%& &%-i%&. It is provided for
4721 compatibility with Sendmail.
4722
4723 .vitem &%-tls-on-connect%&
4724 .oindex "&%-tls-on-connect%&"
4725 .cindex "TLS" "use without STARTTLS"
4726 .cindex "TLS" "automatic start"
4727 This option is available when Exim is compiled with TLS support. It forces all
4728 incoming SMTP connections to behave as if the incoming port is listed in the
4729 &%tls_on_connect_ports%& option. See section &<<SECTsupobssmt>>& and chapter
4730 &<<CHAPTLS>>& for further details.
4731
4732
4733 .vitem &%-U%&
4734 .oindex "&%-U%&"
4735 .cindex "Sendmail compatibility" "&%-U%& option ignored"
4736 Sendmail uses this option for &"initial message submission"&, and its
4737 documentation states that in future releases, it may complain about
4738 syntactically invalid messages rather than fixing them when this flag is not
4739 set. Exim ignores this option.
4740
4741 .vitem &%-v%&
4742 .oindex "&%-v%&"
4743 This option causes Exim to write information to the standard error stream,
4744 describing what it is doing. In particular, it shows the log lines for
4745 receiving and delivering a message, and if an SMTP connection is made, the SMTP
4746 dialogue is shown. Some of the log lines shown may not actually be written to
4747 the log if the setting of &%log_selector%& discards them. Any relevant
4748 selectors are shown with each log line. If none are shown, the logging is
4749 unconditional.
4750
4751 .vitem &%-x%&
4752 .oindex "&%-x%&"
4753 AIX uses &%-x%& for a private purpose (&"mail from a local mail program has
4754 National Language Support extended characters in the body of the mail item"&).
4755 It sets &%-x%& when calling the MTA from its &%mail%& command. Exim ignores
4756 this option.
4757
4758 .vitem &%-X%&&~<&'logfile'&>
4759 .oindex "&%-X%&"
4760 This option is interpreted by Sendmail to cause debug information to be sent
4761 to the named file.  It is ignored by Exim.
4762
4763 .vitem &%-z%&&~<&'log-line'&>
4764 .oindex "&%-z%&"
4765 This option writes its argument to Exim's logfile.
4766 Use is restricted to administrators; the intent is for operational notes.
4767 Quotes should be used to maintain a multi-word item as a single argument,
4768 under most shells.
4769 .endlist
4770
4771 .ecindex IIDclo1
4772 .ecindex IIDclo2
4773
4774
4775 . ////////////////////////////////////////////////////////////////////////////
4776 . Insert a stylized DocBook comment here, to identify the end of the command
4777 . line options. This is for the benefit of the Perl script that automatically
4778 . creates a man page for the options.
4779 . ////////////////////////////////////////////////////////////////////////////
4780
4781 .literal xml
4782 <!-- === End of command line options === -->
4783 .literal off
4784
4785
4786
4787
4788
4789 . ////////////////////////////////////////////////////////////////////////////
4790 . ////////////////////////////////////////////////////////////////////////////
4791
4792
4793 .chapter "The Exim runtime configuration file" "CHAPconf" &&&
4794          "The runtime configuration file"
4795
4796 .cindex "runtime configuration"
4797 .cindex "configuration file" "general description"
4798 .cindex "CONFIGURE_FILE"
4799 .cindex "configuration file" "errors in"
4800 .cindex "error" "in configuration file"
4801 .cindex "return code" "for bad configuration"
4802 Exim uses a single runtime configuration file that is read whenever an Exim
4803 binary is executed. Note that in normal operation, this happens frequently,
4804 because Exim is designed to operate in a distributed manner, without central
4805 control.
4806
4807 If a syntax error is detected while reading the configuration file, Exim
4808 writes a message on the standard error, and exits with a non-zero return code.
4809 The message is also written to the panic log. &*Note*&: Only simple syntax
4810 errors can be detected at this time. The values of any expanded options are
4811 not checked until the expansion happens, even when the expansion does not
4812 actually alter the string.
4813
4814 The name of the configuration file is compiled into the binary for security
4815 reasons, and is specified by the CONFIGURE_FILE compilation option. In
4816 most configurations, this specifies a single file. However, it is permitted to
4817 give a colon-separated list of filenames, in which case Exim uses the first
4818 existing file in the list.
4819
4820 .cindex "EXIM_USER"
4821 .cindex "EXIM_GROUP"
4822 .cindex "CONFIGURE_OWNER"
4823 .cindex "CONFIGURE_GROUP"
4824 .cindex "configuration file" "ownership"
4825 .cindex "ownership" "configuration file"
4826 The runtime configuration file must be owned by root or by the user that is
4827 specified at compile time by the CONFIGURE_OWNER option (if set). The
4828 configuration file must not be world-writeable, or group-writeable unless its
4829 group is the root group or the one specified at compile time by the
4830 CONFIGURE_GROUP option.
4831
4832 &*Warning*&: In a conventional configuration, where the Exim binary is setuid
4833 to root, anybody who is able to edit the runtime configuration file has an
4834 easy way to run commands as root. If you specify a user or group in the
4835 CONFIGURE_OWNER or CONFIGURE_GROUP options, then that user and/or any users
4836 who are members of that group will trivially be able to obtain root privileges.
4837
4838 Up to Exim version 4.72, the runtime configuration file was also permitted to
4839 be writeable by the Exim user and/or group. That has been changed in Exim 4.73
4840 since it offered a simple privilege escalation for any attacker who managed to
4841 compromise the Exim user account.
4842
4843 A default configuration file, which will work correctly in simple situations,
4844 is provided in the file &_src/configure.default_&. If CONFIGURE_FILE
4845 defines just one filename, the installation process copies the default
4846 configuration to a new file of that name if it did not previously exist. If
4847 CONFIGURE_FILE is a list, no default is automatically installed. Chapter
4848 &<<CHAPdefconfil>>& is a &"walk-through"& discussion of the default
4849 configuration.
4850
4851
4852
4853 .section "Using a different configuration file" "SECID40"
4854 .cindex "configuration file" "alternate"
4855 A one-off alternate configuration can be specified by the &%-C%& command line
4856 option, which may specify a single file or a list of files. However, when
4857 &%-C%& is used, Exim gives up its root privilege, unless called by root (or
4858 unless the argument for &%-C%& is identical to the built-in value from
4859 CONFIGURE_FILE), or is listed in the TRUSTED_CONFIG_LIST file and the caller
4860 is the Exim user or the user specified in the CONFIGURE_OWNER setting. &%-C%&
4861 is useful mainly for checking the syntax of configuration files before
4862 installing them. No owner or group checks are done on a configuration file
4863 specified by &%-C%&, if root privilege has been dropped.
4864
4865 Even the Exim user is not trusted to specify an arbitrary configuration file
4866 with the &%-C%& option to be used with root privileges, unless that file is
4867 listed in the TRUSTED_CONFIG_LIST file. This locks out the possibility of
4868 testing a configuration using &%-C%& right through message reception and
4869 delivery, even if the caller is root. The reception works, but by that time,
4870 Exim is running as the Exim user, so when it re-execs to regain privilege for
4871 the delivery, the use of &%-C%& causes privilege to be lost. However, root
4872 can test reception and delivery using two separate commands (one to put a
4873 message in the queue, using &%-odq%&, and another to do the delivery, using
4874 &%-M%&).
4875
4876 If ALT_CONFIG_PREFIX is defined &_in Local/Makefile_&, it specifies a
4877 prefix string with which any file named in a &%-C%& command line option must
4878 start. In addition, the filename must not contain the sequence &"&`/../`&"&.
4879 There is no default setting for ALT_CONFIG_PREFIX; when it is unset, any
4880 filename can be used with &%-C%&.
4881
4882 One-off changes to a configuration can be specified by the &%-D%& command line
4883 option, which defines and overrides values for macros used inside the
4884 configuration file. However, like &%-C%&, the use of this option by a
4885 non-privileged user causes Exim to discard its root privilege.
4886 If DISABLE_D_OPTION is defined in &_Local/Makefile_&, the use of &%-D%& is
4887 completely disabled, and its use causes an immediate error exit.
4888
4889 The WHITELIST_D_MACROS option in &_Local/Makefile_& permits the binary builder
4890 to declare certain macro names trusted, such that root privilege will not
4891 necessarily be discarded.
4892 WHITELIST_D_MACROS defines a colon-separated list of macros which are
4893 considered safe and, if &%-D%& only supplies macros from this list, and the
4894 values are acceptable, then Exim will not give up root privilege if the caller
4895 is root, the Exim run-time user, or the CONFIGURE_OWNER, if set.  This is a
4896 transition mechanism and is expected to be removed in the future.  Acceptable
4897 values for the macros satisfy the regexp: &`^[A-Za-z0-9_/.-]*$`&
4898
4899 Some sites may wish to use the same Exim binary on different machines that
4900 share a file system, but to use different configuration files on each machine.
4901 If CONFIGURE_FILE_USE_NODE is defined in &_Local/Makefile_&, Exim first
4902 looks for a file whose name is the configuration filename followed by a dot
4903 and the machine's node name, as obtained from the &[uname()]& function. If this
4904 file does not exist, the standard name is tried. This processing occurs for
4905 each filename in the list given by CONFIGURE_FILE or &%-C%&.
4906
4907 In some esoteric situations different versions of Exim may be run under
4908 different effective uids and the CONFIGURE_FILE_USE_EUID is defined to
4909 help with this. See the comments in &_src/EDITME_& for details.
4910
4911
4912
4913 .section "Configuration file format" "SECTconffilfor"
4914 .cindex "configuration file" "format of"
4915 .cindex "format" "configuration file"
4916 Exim's configuration file is divided into a number of different parts. General
4917 option settings must always appear at the start of the file. The other parts
4918 are all optional, and may appear in any order. Each part other than the first
4919 is introduced by the word &"begin"& followed by at least one literal
4920 space, and the name of the part. The optional parts are:
4921
4922 .ilist
4923 &'ACL'&: Access control lists for controlling incoming SMTP mail (see chapter
4924 &<<CHAPACL>>&).
4925 .next
4926 .cindex "AUTH" "configuration"
4927 &'authenticators'&: Configuration settings for the authenticator drivers. These
4928 are concerned with the SMTP AUTH command (see chapter &<<CHAPSMTPAUTH>>&).
4929 .next
4930 &'routers'&: Configuration settings for the router drivers. Routers process
4931 addresses and determine how the message is to be delivered (see chapters
4932 &<<CHAProutergeneric>>&&--&<<CHAPredirect>>&).
4933 .next
4934 &'transports'&: Configuration settings for the transport drivers. Transports
4935 define mechanisms for copying messages to destinations (see chapters
4936 &<<CHAPtransportgeneric>>&&--&<<CHAPsmtptrans>>&).
4937 .next
4938 &'retry'&: Retry rules, for use when a message cannot be delivered immediately.
4939 If there is no retry section, or if it is empty (that is, no retry rules are
4940 defined), Exim will not retry deliveries. In this situation, temporary errors
4941 are treated the same as permanent errors. Retry rules are discussed in chapter
4942 &<<CHAPretry>>&.
4943 .next
4944 &'rewrite'&: Global address rewriting rules, for use when a message arrives and
4945 when new addresses are generated during delivery. Rewriting is discussed in
4946 chapter &<<CHAPrewrite>>&.
4947 .next
4948 &'local_scan'&: Private options for the &[local_scan()]& function. If you
4949 want to use this feature, you must set
4950 .code
4951 LOCAL_SCAN_HAS_OPTIONS=yes
4952 .endd
4953 in &_Local/Makefile_& before building Exim. Details of the &[local_scan()]&
4954 facility are given in chapter &<<CHAPlocalscan>>&.
4955 .endlist
4956
4957 .cindex "configuration file" "leading white space in"
4958 .cindex "configuration file" "trailing white space in"
4959 .cindex "white space" "in configuration file"
4960 Leading and trailing white space in configuration lines is always ignored.
4961
4962 Blank lines in the file, and lines starting with a # character (ignoring
4963 leading white space) are treated as comments and are ignored. &*Note*&: A
4964 # character other than at the beginning of a line is not treated specially,
4965 and does not introduce a comment.
4966
4967 Any non-comment line can be continued by ending it with a backslash. Note that
4968 the general rule for white space means that trailing white space after the
4969 backslash and leading white space at the start of continuation
4970 lines is ignored. Comment lines beginning with # (but not empty lines) may
4971 appear in the middle of a sequence of continuation lines.
4972
4973 A convenient way to create a configuration file is to start from the
4974 default, which is supplied in &_src/configure.default_&, and add, delete, or
4975 change settings as required.
4976
4977 The ACLs, retry rules, and rewriting rules have their own syntax which is
4978 described in chapters &<<CHAPACL>>&, &<<CHAPretry>>&, and &<<CHAPrewrite>>&,
4979 respectively. The other parts of the configuration file have some syntactic
4980 items in common, and these are described below, from section &<<SECTcos>>&
4981 onwards. Before that, the inclusion, macro, and conditional facilities are
4982 described.
4983
4984
4985
4986 .section "File inclusions in the configuration file" "SECID41"
4987 .cindex "inclusions in configuration file"
4988 .cindex "configuration file" "including other files"
4989 .cindex "&`.include`& in configuration file"
4990 .cindex "&`.include_if_exists`& in configuration file"
4991 You can include other files inside Exim's runtime configuration file by
4992 using this syntax:
4993 .display
4994 &`.include`& <&'filename'&>
4995 &`.include_if_exists`& <&'filename'&>
4996 .endd
4997 on a line by itself. Double quotes round the filename are optional. If you use
4998 the first form, a configuration error occurs if the file does not exist; the
4999 second form does nothing for non-existent files.
5000 The first form allows a relative name. It is resolved relative to
5001 the directory of the including file. For the second form an absolute filename
5002 is required.
5003
5004 Includes may be nested to any depth, but remember that Exim reads its
5005 configuration file often, so it is a good idea to keep them to a minimum.
5006 If you change the contents of an included file, you must HUP the daemon,
5007 because an included file is read only when the configuration itself is read.
5008
5009 The processing of inclusions happens early, at a physical line level, so, like
5010 comment lines, an inclusion can be used in the middle of an option setting,
5011 for example:
5012 .code
5013 hosts_lookup = a.b.c \
5014                .include /some/file
5015 .endd
5016 Include processing happens after macro processing (see below). Its effect is to
5017 process the lines of the included file as if they occurred inline where the
5018 inclusion appears.
5019
5020
5021
5022 .section "Macros in the configuration file" "SECTmacrodefs"
5023 .cindex "macro" "description of"
5024 .cindex "configuration file" "macros"
5025 If a line in the main part of the configuration (that is, before the first
5026 &"begin"& line) begins with an upper case letter, it is taken as a macro
5027 definition, and must be of the form
5028 .display
5029 <&'name'&> = <&'rest of line'&>
5030 .endd
5031 The name must consist of letters, digits, and underscores, and need not all be
5032 in upper case, though that is recommended. The rest of the line, including any
5033 continuations, is the replacement text, and has leading and trailing white
5034 space removed. Quotes are not removed. The replacement text can never end with
5035 a backslash character, but this doesn't seem to be a serious limitation.
5036
5037 Macros may also be defined between router, transport, authenticator, or ACL
5038 definitions. They may not, however, be defined within an individual driver or
5039 ACL, or in the &%local_scan%&, retry, or rewrite sections of the configuration.
5040
5041 .section "Macro substitution" "SECID42"
5042 Once a macro is defined, all subsequent lines in the file (and any included
5043 files) are scanned for the macro name; if there are several macros, the line is
5044 scanned for each, in turn, in the order in which the macros are defined. The
5045 replacement text is not re-scanned for the current macro, though it is scanned
5046 for subsequently defined macros. For this reason, a macro name may not contain
5047 the name of a previously defined macro as a substring. You could, for example,
5048 define
5049 .display
5050 &`ABCD_XYZ = `&<&'something'&>
5051 &`ABCD = `&<&'something else'&>
5052 .endd
5053 but putting the definitions in the opposite order would provoke a configuration
5054 error. Macro expansion is applied to individual physical lines from the file,
5055 before checking for line continuation or file inclusion (see above). If a line
5056 consists solely of a macro name, and the expansion of the macro is empty, the
5057 line is ignored. A macro at the start of a line may turn the line into a
5058 comment line or a &`.include`& line.
5059
5060
5061 .section "Redefining macros" "SECID43"
5062 Once defined, the value of a macro can be redefined later in the configuration
5063 (or in an included file). Redefinition is specified by using &'=='& instead of
5064 &'='&. For example:
5065 .code
5066 MAC =  initial value
5067 ...
5068 MAC == updated value
5069 .endd
5070 Redefinition does not alter the order in which the macros are applied to the
5071 subsequent lines of the configuration file. It is still the same order in which
5072 the macros were originally defined. All that changes is the macro's value.
5073 Redefinition makes it possible to accumulate values. For example:
5074 .code
5075 MAC =  initial value
5076 ...
5077 MAC == MAC and something added
5078 .endd
5079 This can be helpful in situations where the configuration file is built
5080 from a number of other files.
5081
5082 .section "Overriding macro values" "SECID44"
5083 The values set for macros in the configuration file can be overridden by the
5084 &%-D%& command line option, but Exim gives up its root privilege when &%-D%& is
5085 used, unless called by root or the Exim user. A definition on the command line
5086 using the &%-D%& option causes all definitions and redefinitions within the
5087 file to be ignored.
5088
5089
5090
5091 .section "Example of macro usage" "SECID45"
5092 As an example of macro usage, consider a configuration where aliases are looked
5093 up in a MySQL database. It helps to keep the file less cluttered if long
5094 strings such as SQL statements are defined separately as macros, for example:
5095 .code
5096 ALIAS_QUERY = select mailbox from user where \
5097               login='${quote_mysql:$local_part}';
5098 .endd
5099 This can then be used in a &(redirect)& router setting like this:
5100 .code
5101 data = ${lookup mysql{ALIAS_QUERY}}
5102 .endd
5103 In earlier versions of Exim macros were sometimes used for domain, host, or
5104 address lists. In Exim 4 these are handled better by named lists &-- see
5105 section &<<SECTnamedlists>>&.
5106
5107
5108 .section "Builtin macros" "SECTbuiltinmacros"
5109 Exim defines some macros depending on facilities available, which may
5110 differ due to build-time definitions and from one release to another.
5111 All of these macros start with an underscore.
5112 They can be used to conditionally include parts of a configuration
5113 (see below).
5114
5115 The following classes of macros are defined:
5116 .display
5117 &` _HAVE_*                    `&  build-time defines
5118 &` _DRIVER_ROUTER_*           `&  router drivers
5119 &` _DRIVER_TRANSPORT_*        `&  transport drivers
5120 &` _DRIVER_AUTHENTICATOR_*    `&  authenticator drivers
5121 &` _LOG_*                     `&  log_selector values
5122 &` _OPT_MAIN_*                `&  main config options
5123 &` _OPT_ROUTERS_*             `&  generic router options
5124 &` _OPT_TRANSPORTS_*          `&  generic transport options
5125 &` _OPT_AUTHENTICATORS_*      `&  generic authenticator options
5126 &` _OPT_ROUTER_*_*            `&  private router options
5127 &` _OPT_TRANSPORT_*_*         `&  private transport options
5128 &` _OPT_AUTHENTICATOR_*_*     `&  private authenticator options
5129 .endd
5130
5131 Use an &"exim -bP macros"& command to get the list of macros.
5132
5133
5134 .section "Conditional skips in the configuration file" "SECID46"
5135 .cindex "configuration file" "conditional skips"
5136 .cindex "&`.ifdef`&"
5137 You can use the directives &`.ifdef`&, &`.ifndef`&, &`.elifdef`&,
5138 &`.elifndef`&, &`.else`&, and &`.endif`& to dynamically include or exclude
5139 portions of the configuration file. The processing happens whenever the file is
5140 read (that is, when an Exim binary starts to run).
5141
5142 The implementation is very simple. Instances of the first four directives must
5143 be followed by text that includes the names of one or macros. The condition
5144 that is tested is whether or not any macro substitution has taken place in the
5145 line. Thus:
5146 .code
5147 .ifdef AAA
5148 message_size_limit = 50M
5149 .else
5150 message_size_limit = 100M
5151 .endif
5152 .endd
5153 sets a message size limit of 50M if the macro &`AAA`& is defined
5154 (or &`A`& or &`AA`&), and 100M
5155 otherwise. If there is more than one macro named on the line, the condition
5156 is true if any of them are defined. That is, it is an &"or"& condition. To
5157 obtain an &"and"& condition, you need to use nested &`.ifdef`&s.
5158
5159 Although you can use a macro expansion to generate one of these directives,
5160 it is not very useful, because the condition &"there was a macro substitution
5161 in this line"& will always be true.
5162
5163 Text following &`.else`& and &`.endif`& is ignored, and can be used as comment
5164 to clarify complicated nestings.
5165
5166
5167
5168 .section "Common option syntax" "SECTcos"
5169 .cindex "common option syntax"
5170 .cindex "syntax of common options"
5171 .cindex "configuration file" "common option syntax"
5172 For the main set of options, driver options, and &[local_scan()]& options,
5173 each setting is on a line by itself, and starts with a name consisting of
5174 lower-case letters and underscores. Many options require a data value, and in
5175 these cases the name must be followed by an equals sign (with optional white
5176 space) and then the value. For example:
5177 .code
5178 qualify_domain = mydomain.example.com
5179 .endd
5180 .cindex "hiding configuration option values"
5181 .cindex "configuration options" "hiding value of"
5182 .cindex "options" "hiding value of"
5183 Some option settings may contain sensitive data, for example, passwords for
5184 accessing databases. To stop non-admin users from using the &%-bP%& command
5185 line option to read these values, you can precede the option settings with the
5186 word &"hide"&. For example:
5187 .code
5188 hide mysql_servers = localhost/users/admin/secret-password
5189 .endd
5190 For non-admin users, such options are displayed like this:
5191 .code
5192 mysql_servers = <value not displayable>
5193 .endd
5194 If &"hide"& is used on a driver option, it hides the value of that option on
5195 all instances of the same driver.
5196
5197 The following sections describe the syntax used for the different data types
5198 that are found in option settings.
5199
5200
5201 .section "Boolean options" "SECID47"
5202 .cindex "format" "boolean"
5203 .cindex "boolean configuration values"
5204 .oindex "&%no_%&&'xxx'&"
5205 .oindex "&%not_%&&'xxx'&"
5206 Options whose type is given as boolean are on/off switches. There are two
5207 different ways of specifying such options: with and without a data value. If
5208 the option name is specified on its own without data, the switch is turned on;
5209 if it is preceded by &"no_"& or &"not_"& the switch is turned off. However,
5210 boolean options may be followed by an equals sign and one of the words
5211 &"true"&, &"false"&, &"yes"&, or &"no"&, as an alternative syntax. For example,
5212 the following two settings have exactly the same effect:
5213 .code
5214 queue_only
5215 queue_only = true
5216 .endd
5217 The following two lines also have the same (opposite) effect:
5218 .code
5219 no_queue_only
5220 queue_only = false
5221 .endd
5222 You can use whichever syntax you prefer.
5223
5224
5225
5226
5227 .section "Integer values" "SECID48"
5228 .cindex "integer configuration values"
5229 .cindex "format" "integer"
5230 If an option's type is given as &"integer"&, the value can be given in decimal,
5231 hexadecimal, or octal. If it starts with a digit greater than zero, a decimal
5232 number is assumed. Otherwise, it is treated as an octal number unless it starts
5233 with the characters &"0x"&, in which case the remainder is interpreted as a
5234 hexadecimal number.
5235
5236 If an integer value is followed by the letter K, it is multiplied by 1024; if
5237 it is followed by the letter M, it is multiplied by 1024x1024;
5238 if by the letter G, 1024x1024x1024.
5239 When the values
5240 of integer option settings are output, values which are an exact multiple of
5241 1024 or 1024x1024 are sometimes, but not always, printed using the letters K
5242 and M. The printing style is independent of the actual input format that was
5243 used.
5244
5245
5246 .section "Octal integer values" "SECID49"
5247 .cindex "integer format"
5248 .cindex "format" "octal integer"
5249 If an option's type is given as &"octal integer"&, its value is always
5250 interpreted as an octal number, whether or not it starts with the digit zero.
5251 Such options are always output in octal.
5252
5253
5254 .section "Fixed point numbers" "SECID50"
5255 .cindex "fixed point configuration values"
5256 .cindex "format" "fixed point"
5257 If an option's type is given as &"fixed-point"&, its value must be a decimal
5258 integer, optionally followed by a decimal point and up to three further digits.
5259
5260
5261
5262 .section "Time intervals" "SECTtimeformat"
5263 .cindex "time interval" "specifying in configuration"
5264 .cindex "format" "time interval"
5265 A time interval is specified as a sequence of numbers, each followed by one of
5266 the following letters, with no intervening white space:
5267
5268 .table2 30pt
5269 .irow &%s%& seconds
5270 .irow &%m%& minutes
5271 .irow &%h%& hours
5272 .irow &%d%& days
5273 .irow &%w%& weeks
5274 .endtable
5275
5276 For example, &"3h50m"& specifies 3 hours and 50 minutes. The values of time
5277 intervals are output in the same format. Exim does not restrict the values; it
5278 is perfectly acceptable, for example, to specify &"90m"& instead of &"1h30m"&.
5279
5280
5281
5282 .section "String values" "SECTstrings"
5283 .cindex "string" "format of configuration values"
5284 .cindex "format" "string"
5285 If an option's type is specified as &"string"&, the value can be specified with
5286 or without double-quotes. If it does not start with a double-quote, the value
5287 consists of the remainder of the line plus any continuation lines, starting at
5288 the first character after any leading white space, with trailing white space
5289 removed, and with no interpretation of the characters in the string. Because
5290 Exim removes comment lines (those beginning with #) at an early stage, they can
5291 appear in the middle of a multi-line string. The following two settings are
5292 therefore equivalent:
5293 .code
5294 trusted_users = uucp:mail
5295 trusted_users = uucp:\
5296                 # This comment line is ignored
5297                 mail
5298 .endd
5299 .cindex "string" "quoted"
5300 .cindex "escape characters in quoted strings"
5301 If a string does start with a double-quote, it must end with a closing
5302 double-quote, and any backslash characters other than those used for line
5303 continuation are interpreted as escape characters, as follows:
5304
5305 .table2 100pt
5306 .irow &`\\`&                     "single backslash"
5307 .irow &`\n`&                     "newline"
5308 .irow &`\r`&                     "carriage return"
5309 .irow &`\t`&                     "tab"
5310 .irow "&`\`&<&'octal digits'&>"  "up to 3 octal digits specify one character"
5311 .irow "&`\x`&<&'hex digits'&>"   "up to 2 hexadecimal digits specify one &&&
5312                                    character"
5313 .endtable
5314
5315 If a backslash is followed by some other character, including a double-quote
5316 character, that character replaces the pair.
5317
5318 Quoting is necessary only if you want to make use of the backslash escapes to
5319 insert special characters, or if you need to specify a value with leading or
5320 trailing spaces. These cases are rare, so quoting is almost never needed in
5321 current versions of Exim. In versions of Exim before 3.14, quoting was required
5322 in order to continue lines, so you may come across older configuration files
5323 and examples that apparently quote unnecessarily.
5324
5325
5326 .section "Expanded strings" "SECID51"
5327 .cindex "expansion" "definition of"
5328 Some strings in the configuration file are subjected to &'string expansion'&,
5329 by which means various parts of the string may be changed according to the
5330 circumstances (see chapter &<<CHAPexpand>>&). The input syntax for such strings
5331 is as just described; in particular, the handling of backslashes in quoted
5332 strings is done as part of the input process, before expansion takes place.
5333 However, backslash is also an escape character for the expander, so any
5334 backslashes that are required for that reason must be doubled if they are
5335 within a quoted configuration string.
5336
5337
5338 .section "User and group names" "SECID52"
5339 .cindex "user name" "format of"
5340 .cindex "format" "user name"
5341 .cindex "groups" "name format"
5342 .cindex "format" "group name"
5343 User and group names are specified as strings, using the syntax described
5344 above, but the strings are interpreted specially. A user or group name must
5345 either consist entirely of digits, or be a name that can be looked up using the
5346 &[getpwnam()]& or &[getgrnam()]& function, as appropriate.
5347
5348
5349 .section "List construction" "SECTlistconstruct"
5350 .cindex "list" "syntax of in configuration"
5351 .cindex "format" "list item in configuration"
5352 .cindex "string" "list, definition of"
5353 The data for some configuration options is a list of items, with colon as the
5354 default separator. Many of these options are shown with type &"string list"& in
5355 the descriptions later in this document. Others are listed as &"domain list"&,
5356 &"host list"&, &"address list"&, or &"local part list"&. Syntactically, they
5357 are all the same; however, those other than &"string list"& are subject to
5358 particular kinds of interpretation, as described in chapter
5359 &<<CHAPdomhosaddlists>>&.
5360
5361 In all these cases, the entire list is treated as a single string as far as the
5362 input syntax is concerned. The &%trusted_users%& setting in section
5363 &<<SECTstrings>>& above is an example. If a colon is actually needed in an item
5364 in a list, it must be entered as two colons. Leading and trailing white space
5365 on each item in a list is ignored. This makes it possible to include items that
5366 start with a colon, and in particular, certain forms of IPv6 address. For
5367 example, the list
5368 .code
5369 local_interfaces = 127.0.0.1 : ::::1
5370 .endd
5371 contains two IP addresses, the IPv4 address 127.0.0.1 and the IPv6 address ::1.
5372
5373 &*Note*&: Although leading and trailing white space is ignored in individual
5374 list items, it is not ignored when parsing the list. The space after the first
5375 colon in the example above is necessary. If it were not there, the list would
5376 be interpreted as the two items 127.0.0.1:: and 1.
5377
5378 .section "Changing list separators" "SECTlistsepchange"
5379 .cindex "list separator" "changing"
5380 .cindex "IPv6" "addresses in lists"
5381 Doubling colons in IPv6 addresses is an unwelcome chore, so a mechanism was
5382 introduced to allow the separator character to be changed. If a list begins
5383 with a left angle bracket, followed by any punctuation character, that
5384 character is used instead of colon as the list separator. For example, the list
5385 above can be rewritten to use a semicolon separator like this:
5386 .code
5387 local_interfaces = <; 127.0.0.1 ; ::1
5388 .endd
5389 This facility applies to all lists, with the exception of the list in
5390 &%log_file_path%&. It is recommended that the use of non-colon separators be
5391 confined to circumstances where they really are needed.
5392
5393 .cindex "list separator" "newline as"
5394 .cindex "newline" "as list separator"
5395 It is also possible to use newline and other control characters (those with
5396 code values less than 32, plus DEL) as separators in lists. Such separators
5397 must be provided literally at the time the list is processed. For options that
5398 are string-expanded, you can write the separator using a normal escape
5399 sequence. This will be processed by the expander before the string is
5400 interpreted as a list. For example, if a newline-separated list of domains is
5401 generated by a lookup, you can process it directly by a line such as this:
5402 .code
5403 domains = <\n ${lookup mysql{.....}}
5404 .endd
5405 This avoids having to change the list separator in such data. You are unlikely
5406 to want to use a control character as a separator in an option that is not
5407 expanded, because the value is literal text. However, it can be done by giving
5408 the value in quotes. For example:
5409 .code
5410 local_interfaces = "<\n 127.0.0.1 \n ::1"
5411 .endd
5412 Unlike printing character separators, which can be included in list items by
5413 doubling, it is not possible to include a control character as data when it is
5414 set as the separator. Two such characters in succession are interpreted as
5415 enclosing an empty list item.
5416
5417
5418
5419 .section "Empty items in lists" "SECTempitelis"
5420 .cindex "list" "empty item in"
5421 An empty item at the end of a list is always ignored. In other words, trailing
5422 separator characters are ignored. Thus, the list in
5423 .code
5424 senders = user@domain :
5425 .endd
5426 contains only a single item. If you want to include an empty string as one item
5427 in a list, it must not be the last item. For example, this list contains three
5428 items, the second of which is empty:
5429 .code
5430 senders = user1@domain : : user2@domain
5431 .endd
5432 &*Note*&: There must be white space between the two colons, as otherwise they
5433 are interpreted as representing a single colon data character (and the list
5434 would then contain just one item). If you want to specify a list that contains
5435 just one, empty item, you can do it as in this example:
5436 .code
5437 senders = :
5438 .endd
5439 In this case, the first item is empty, and the second is discarded because it
5440 is at the end of the list.
5441
5442
5443
5444
5445 .section "Format of driver configurations" "SECTfordricon"
5446 .cindex "drivers" "configuration format"
5447 There are separate parts in the configuration for defining routers, transports,
5448 and authenticators. In each part, you are defining a number of driver
5449 instances, each with its own set of options. Each driver instance is defined by
5450 a sequence of lines like this:
5451 .display
5452 <&'instance name'&>:
5453   <&'option'&>
5454   ...
5455   <&'option'&>
5456 .endd
5457 In the following example, the instance name is &(localuser)&, and it is
5458 followed by three options settings:
5459 .code
5460 localuser:
5461   driver = accept
5462   check_local_user
5463   transport = local_delivery
5464 .endd
5465 For each driver instance, you specify which Exim code module it uses &-- by the
5466 setting of the &%driver%& option &-- and (optionally) some configuration
5467 settings. For example, in the case of transports, if you want a transport to
5468 deliver with SMTP you would use the &(smtp)& driver; if you want to deliver to
5469 a local file you would use the &(appendfile)& driver. Each of the drivers is
5470 described in detail in its own separate chapter later in this manual.
5471
5472 You can have several routers, transports, or authenticators that are based on
5473 the same underlying driver (each must have a different instance name).
5474
5475 The order in which routers are defined is important, because addresses are
5476 passed to individual routers one by one, in order. The order in which
5477 transports are defined does not matter at all. The order in which
5478 authenticators are defined is used only when Exim, as a client, is searching
5479 them to find one that matches an authentication mechanism offered by the
5480 server.
5481
5482 .cindex "generic options"
5483 .cindex "options" "generic &-- definition of"
5484 Within a driver instance definition, there are two kinds of option: &'generic'&
5485 and &'private'&. The generic options are those that apply to all drivers of the
5486 same type (that is, all routers, all transports or all authenticators). The
5487 &%driver%& option is a generic option that must appear in every definition.
5488 .cindex "private options"
5489 The private options are special for each driver, and none need appear, because
5490 they all have default values.
5491
5492 The options may appear in any order, except that the &%driver%& option must
5493 precede any private options, since these depend on the particular driver. For
5494 this reason, it is recommended that &%driver%& always be the first option.
5495
5496 Driver instance names, which are used for reference in log entries and
5497 elsewhere, can be any sequence of letters, digits, and underscores (starting
5498 with a letter) and must be unique among drivers of the same type. A router and
5499 a transport (for example) can each have the same name, but no two router
5500 instances can have the same name. The name of a driver instance should not be
5501 confused with the name of the underlying driver module. For example, the
5502 configuration lines:
5503 .code
5504 remote_smtp:
5505   driver = smtp
5506 .endd
5507 create an instance of the &(smtp)& transport driver whose name is
5508 &(remote_smtp)&. The same driver code can be used more than once, with
5509 different instance names and different option settings each time. A second
5510 instance of the &(smtp)& transport, with different options, might be defined
5511 thus:
5512 .code
5513 special_smtp:
5514   driver = smtp
5515   port = 1234
5516   command_timeout = 10s
5517 .endd
5518 The names &(remote_smtp)& and &(special_smtp)& would be used to reference
5519 these transport instances from routers, and these names would appear in log
5520 lines.
5521
5522 Comment lines may be present in the middle of driver specifications. The full
5523 list of option settings for any particular driver instance, including all the
5524 defaulted values, can be extracted by making use of the &%-bP%& command line
5525 option.
5526
5527
5528
5529
5530
5531
5532 . ////////////////////////////////////////////////////////////////////////////
5533 . ////////////////////////////////////////////////////////////////////////////
5534
5535 .chapter "The default configuration file" "CHAPdefconfil"
5536 .scindex IIDconfiwal "configuration file" "default &""walk through""&"
5537 .cindex "default" "configuration file &""walk through""&"
5538 The default configuration file supplied with Exim as &_src/configure.default_&
5539 is sufficient for a host with simple mail requirements. As an introduction to
5540 the way Exim is configured, this chapter &"walks through"& the default
5541 configuration, giving brief explanations of the settings. Detailed descriptions
5542 of the options are given in subsequent chapters. The default configuration file
5543 itself contains extensive comments about ways you might want to modify the
5544 initial settings. However, note that there are many options that are not
5545 mentioned at all in the default configuration.
5546
5547
5548
5549 .section "Macros" "SECTdefconfmacros"
5550 All macros should be defined before any options.
5551
5552 One macro is specified, but commented out, in the default configuration:
5553 .code
5554 # ROUTER_SMARTHOST=MAIL.HOSTNAME.FOR.CENTRAL.SERVER.EXAMPLE
5555 .endd
5556 If all off-site mail is expected to be delivered to a "smarthost", then set the
5557 hostname here and uncomment the macro.  This will affect which router is used
5558 later on.  If this is left commented out, then Exim will perform direct-to-MX
5559 deliveries using a &(dnslookup)& router.
5560
5561 In addition to macros defined here, Exim includes a number of built-in macros
5562 to enable configuration to be guarded by a binary built with support for a
5563 given feature.  See section &<<SECTbuiltinmacros>>& for more details.
5564
5565
5566 .section "Main configuration settings" "SECTdefconfmain"
5567 The main (global) configuration option settings section must always come first
5568 in the file, after the macros.
5569 The first thing you'll see in the file, after some initial comments, is the line
5570 .code
5571 # primary_hostname =
5572 .endd
5573 This is a commented-out setting of the &%primary_hostname%& option. Exim needs
5574 to know the official, fully qualified name of your host, and this is where you
5575 can specify it. However, in most cases you do not need to set this option. When
5576 it is unset, Exim uses the &[uname()]& system function to obtain the host name.
5577
5578 The first three non-comment configuration lines are as follows:
5579 .code
5580 domainlist local_domains    = @
5581 domainlist relay_to_domains =
5582 hostlist   relay_from_hosts = 127.0.0.1
5583 .endd
5584 These are not, in fact, option settings. They are definitions of two named
5585 domain lists and one named host list. Exim allows you to give names to lists of
5586 domains, hosts, and email addresses, in order to make it easier to manage the
5587 configuration file (see section &<<SECTnamedlists>>&).
5588
5589 The first line defines a domain list called &'local_domains'&; this is used
5590 later in the configuration to identify domains that are to be delivered
5591 on the local host.
5592
5593 .cindex "@ in a domain list"
5594 There is just one item in this list, the string &"@"&. This is a special form
5595 of entry which means &"the name of the local host"&. Thus, if the local host is
5596 called &'a.host.example'&, mail to &'any.user@a.host.example'& is expected to
5597 be delivered locally. Because the local host's name is referenced indirectly,
5598 the same configuration file can be used on different hosts.
5599
5600 The second line defines a domain list called &'relay_to_domains'&, but the
5601 list itself is empty. Later in the configuration we will come to the part that
5602 controls mail relaying through the local host; it allows relaying to any
5603 domains in this list. By default, therefore, no relaying on the basis of a mail
5604 domain is permitted.
5605
5606 The third line defines a host list called &'relay_from_hosts'&. This list is
5607 used later in the configuration to permit relaying from any host or IP address
5608 that matches the list. The default contains just the IP address of the IPv4
5609 loopback interface, which means that processes on the local host are able to
5610 submit mail for relaying by sending it over TCP/IP to that interface. No other
5611 hosts are permitted to submit messages for relaying.
5612
5613 Just to be sure there's no misunderstanding: at this point in the configuration
5614 we aren't actually setting up any controls. We are just defining some domains
5615 and hosts that will be used in the controls that are specified later.
5616
5617 The next two configuration lines are genuine option settings:
5618 .code
5619 acl_smtp_rcpt = acl_check_rcpt
5620 acl_smtp_data = acl_check_data
5621 .endd
5622 These options specify &'Access Control Lists'& (ACLs) that are to be used
5623 during an incoming SMTP session for every recipient of a message (every RCPT
5624 command), and after the contents of the message have been received,
5625 respectively. The names of the lists are &'acl_check_rcpt'& and
5626 &'acl_check_data'&, and we will come to their definitions below, in the ACL
5627 section of the configuration. The RCPT ACL controls which recipients are
5628 accepted for an incoming message &-- if a configuration does not provide an ACL
5629 to check recipients, no SMTP mail can be accepted. The DATA ACL allows the
5630 contents of a message to be checked.
5631
5632 Two commented-out option settings are next:
5633 .code
5634 # av_scanner = clamd:/tmp/clamd
5635 # spamd_address = 127.0.0.1 783
5636 .endd
5637 These are example settings that can be used when Exim is compiled with the
5638 content-scanning extension. The first specifies the interface to the virus
5639 scanner, and the second specifies the interface to SpamAssassin. Further
5640 details are given in chapter &<<CHAPexiscan>>&.
5641
5642 Three more commented-out option settings follow:
5643 .code
5644 # tls_advertise_hosts = *
5645 # tls_certificate = /etc/ssl/exim.crt
5646 # tls_privatekey = /etc/ssl/exim.pem
5647 .endd
5648 These are example settings that can be used when Exim is compiled with
5649 support for TLS (aka SSL) as described in section &<<SECTinctlsssl>>&. The
5650 first one specifies the list of clients that are allowed to use TLS when
5651 connecting to this server; in this case, the wildcard means all clients. The
5652 other options specify where Exim should find its TLS certificate and private
5653 key, which together prove the server's identity to any clients that connect.
5654 More details are given in chapter &<<CHAPTLS>>&.
5655
5656 Another two commented-out option settings follow:
5657 .code
5658 # daemon_smtp_ports = 25 : 465 : 587
5659 # tls_on_connect_ports = 465
5660 .endd
5661 .cindex "port" "465 and 587"
5662 .cindex "port" "for message submission"
5663 .cindex "message" "submission, ports for"
5664 .cindex "submissions protocol"
5665 .cindex "smtps protocol"
5666 .cindex "ssmtp protocol"
5667 .cindex "SMTP" "submissions protocol"
5668 .cindex "SMTP" "ssmtp protocol"
5669 .cindex "SMTP" "smtps protocol"
5670 These options provide better support for roaming users who wish to use this
5671 server for message submission. They are not much use unless you have turned on
5672 TLS (as described in the previous paragraph) and authentication (about which
5673 more in section &<<SECTdefconfauth>>&).
5674 Mail submission from mail clients (MUAs) should be separate from inbound mail
5675 to your domain (MX delivery) for various good reasons (eg, ability to impose
5676 much saner TLS protocol and ciphersuite requirements without unintended
5677 consequences).
5678 RFC 6409 (previously 4409) specifies use of port 587 for SMTP Submission,
5679 which uses STARTTLS, so this is the &"submission"& port.
5680 RFC 8314 specifies use of port 465 as the &"submissions"& protocol,
5681 which should be used in preference to 587.
5682 You should also consider deploying SRV records to help clients find
5683 these ports.
5684 Older names for &"submissions"& are &"smtps"& and &"ssmtp"&.
5685
5686 Two more commented-out options settings follow:
5687 .code
5688 # qualify_domain =
5689 # qualify_recipient =
5690 .endd
5691 The first of these specifies a domain that Exim uses when it constructs a
5692 complete email address from a local login name. This is often needed when Exim
5693 receives a message from a local process. If you do not set &%qualify_domain%&,
5694 the value of &%primary_hostname%& is used. If you set both of these options,
5695 you can have different qualification domains for sender and recipient
5696 addresses. If you set only the first one, its value is used in both cases.
5697
5698 .cindex "domain literal" "recognizing format"
5699 The following line must be uncommented if you want Exim to recognize
5700 addresses of the form &'user@[10.11.12.13]'& that is, with a &"domain literal"&
5701 (an IP address within square brackets) instead of a named domain.
5702 .code
5703 # allow_domain_literals
5704 .endd
5705 The RFCs still require this form, but many people think that in the modern
5706 Internet it makes little sense to permit mail to be sent to specific hosts by
5707 quoting their IP addresses. This ancient format has been used by people who
5708 try to abuse hosts by using them for unwanted relaying. However, some
5709 people believe there are circumstances (for example, messages addressed to
5710 &'postmaster'&) where domain literals are still useful.
5711
5712 The next configuration line is a kind of trigger guard:
5713 .code
5714 never_users = root
5715 .endd
5716 It specifies that no delivery must ever be run as the root user. The normal
5717 convention is to set up &'root'& as an alias for the system administrator. This
5718 setting is a guard against slips in the configuration.
5719 The list of users specified by &%never_users%& is not, however, the complete
5720 list; the build-time configuration in &_Local/Makefile_& has an option called
5721 FIXED_NEVER_USERS specifying a list that cannot be overridden. The
5722 contents of &%never_users%& are added to this list. By default
5723 FIXED_NEVER_USERS also specifies root.
5724
5725 When a remote host connects to Exim in order to send mail, the only information
5726 Exim has about the host's identity is its IP address. The next configuration
5727 line,
5728 .code
5729 host_lookup = *
5730 .endd
5731 specifies that Exim should do a reverse DNS lookup on all incoming connections,
5732 in order to get a host name. This improves the quality of the logging
5733 information, but if you feel it is too expensive, you can remove it entirely,
5734 or restrict the lookup to hosts on &"nearby"& networks.
5735 Note that it is not always possible to find a host name from an IP address,
5736 because not all DNS reverse zones are maintained, and sometimes DNS servers are
5737 unreachable.
5738
5739 The next two lines are concerned with &'ident'& callbacks, as defined by RFC
5740 1413 (hence their names):
5741 .code
5742 rfc1413_hosts = *
5743 rfc1413_query_timeout = 0s
5744 .endd
5745 These settings cause Exim to avoid ident callbacks for all incoming SMTP calls.
5746 Few hosts offer RFC1413 service these days; calls have to be
5747 terminated by a timeout and this needlessly delays the startup
5748 of an incoming SMTP connection.
5749 If you have hosts for which you trust RFC1413 and need this
5750 information, you can change this.
5751
5752 This line enables an efficiency SMTP option.  It is negotiated by clients
5753 and not expected to cause problems but can be disabled if needed.
5754 .code
5755 prdr_enable = true
5756 .endd
5757
5758 When Exim receives messages over SMTP connections, it expects all addresses to
5759 be fully qualified with a domain, as required by the SMTP definition. However,
5760 if you are running a server to which simple clients submit messages, you may
5761 find that they send unqualified addresses. The two commented-out options:
5762 .code
5763 # sender_unqualified_hosts =
5764 # recipient_unqualified_hosts =
5765 .endd
5766 show how you can specify hosts that are permitted to send unqualified sender
5767 and recipient addresses, respectively.
5768
5769 The &%log_selector%& option is used to increase the detail of logging
5770 over the default:
5771 .code
5772 log_selector = +smtp_protocol_error +smtp_syntax_error \
5773                +tls_certificate_verified
5774 .endd
5775
5776 The &%percent_hack_domains%& option is also commented out:
5777 .code
5778 # percent_hack_domains =
5779 .endd
5780 It provides a list of domains for which the &"percent hack"& is to operate.
5781 This is an almost obsolete form of explicit email routing. If you do not know
5782 anything about it, you can safely ignore this topic.
5783
5784 The next two settings in the main part of the default configuration are
5785 concerned with messages that have been &"frozen"& on Exim's queue. When a
5786 message is frozen, Exim no longer continues to try to deliver it. Freezing
5787 occurs when a bounce message encounters a permanent failure because the sender
5788 address of the original message that caused the bounce is invalid, so the
5789 bounce cannot be delivered. This is probably the most common case, but there
5790 are also other conditions that cause freezing, and frozen messages are not
5791 always bounce messages.
5792 .code
5793 ignore_bounce_errors_after = 2d
5794 timeout_frozen_after = 7d
5795 .endd
5796 The first of these options specifies that failing bounce messages are to be
5797 discarded after 2 days in the queue. The second specifies that any frozen
5798 message (whether a bounce message or not) is to be timed out (and discarded)
5799 after a week. In this configuration, the first setting ensures that no failing
5800 bounce message ever lasts a week.
5801
5802 Exim queues it's messages in a spool directory. If you expect to have
5803 large queues, you may consider using this option. It splits the spool
5804 directory into subdirectories to avoid file system degradation from
5805 many files in a single directory, resulting in better performance.
5806 Manual manipulation of queued messages becomes more complex (though fortunately
5807 not often needed).
5808 .code
5809 # split_spool_directory = true
5810 .endd
5811
5812 In an ideal world everybody follows the standards. For non-ASCII
5813 messages RFC 2047 is a standard, allowing a maximum line length of 76
5814 characters. Exim adheres that standard and won't process messages which
5815 violate this standard. (Even ${rfc2047:...} expansions will fail.)
5816 In particular, the Exim maintainers have had multiple reports of
5817 problems from Russian administrators of issues until they disable this
5818 check, because of some popular, yet buggy, mail composition software.
5819 .code
5820 # check_rfc2047_length = false
5821 .endd
5822
5823 If you need to be strictly RFC compliant you may wish to disable the
5824 8BITMIME advertisement. Use this, if you exchange mails with systems
5825 that are not 8-bit clean.
5826 .code
5827 # accept_8bitmime = false
5828 .endd
5829
5830 Libraries you use may depend on specific environment settings.  This
5831 imposes a security risk (e.g. PATH). There are two lists:
5832 &%keep_environment%& for the variables to import as they are, and
5833 &%add_environment%& for variables we want to set to a fixed value.
5834 Note that TZ is handled separately, by the $%timezone%$ runtime
5835 option and by the TIMEZONE_DEFAULT buildtime option.
5836 .code
5837 # keep_environment = ^LDAP
5838 # add_environment = PATH=/usr/bin::/bin
5839 .endd
5840
5841
5842 .section "ACL configuration" "SECID54"
5843 .cindex "default" "ACLs"
5844 .cindex "&ACL;" "default configuration"
5845 In the default configuration, the ACL section follows the main configuration.
5846 It starts with the line
5847 .code
5848 begin acl
5849 .endd
5850 and it contains the definitions of two ACLs, called &'acl_check_rcpt'& and
5851 &'acl_check_data'&, that were referenced in the settings of &%acl_smtp_rcpt%&
5852 and &%acl_smtp_data%& above.
5853
5854 .cindex "RCPT" "ACL for"
5855 The first ACL is used for every RCPT command in an incoming SMTP message. Each
5856 RCPT command specifies one of the message's recipients. The ACL statements
5857 are considered in order, until the recipient address is either accepted or
5858 rejected. The RCPT command is then accepted or rejected, according to the
5859 result of the ACL processing.
5860 .code
5861 acl_check_rcpt:
5862 .endd
5863 This line, consisting of a name terminated by a colon, marks the start of the
5864 ACL, and names it.
5865 .code
5866 accept  hosts = :
5867 .endd
5868 This ACL statement accepts the recipient if the sending host matches the list.
5869 But what does that strange list mean? It doesn't actually contain any host
5870 names or IP addresses. The presence of the colon puts an empty item in the
5871 list; Exim matches this only if the incoming message did not come from a remote
5872 host, because in that case, the remote hostname is empty. The colon is
5873 important. Without it, the list itself is empty, and can never match anything.
5874
5875 What this statement is doing is to accept unconditionally all recipients in
5876 messages that are submitted by SMTP from local processes using the standard
5877 input and output (that is, not using TCP/IP). A number of MUAs operate in this
5878 manner.
5879 .code
5880 deny    message       = Restricted characters in address
5881         domains       = +local_domains
5882         local_parts   = ^[.] : ^.*[@%!/|]
5883
5884 deny    message       = Restricted characters in address
5885         domains       = !+local_domains
5886         local_parts   = ^[./|] : ^.*[@%!] : ^.*/\\.\\./
5887 .endd
5888 These statements are concerned with local parts that contain any of the
5889 characters &"@"&, &"%"&, &"!"&, &"/"&, &"|"&, or dots in unusual places.
5890 Although these characters are entirely legal in local parts (in the case of
5891 &"@"& and leading dots, only if correctly quoted), they do not commonly occur
5892 in Internet mail addresses.
5893
5894 The first three have in the past been associated with explicitly routed
5895 addresses (percent is still sometimes used &-- see the &%percent_hack_domains%&
5896 option). Addresses containing these characters are regularly tried by spammers
5897 in an attempt to bypass relaying restrictions, and also by open relay testing
5898 programs. Unless you really need them it is safest to reject these characters
5899 at this early stage. This configuration is heavy-handed in rejecting these
5900 characters for all messages it accepts from remote hosts. This is a deliberate
5901 policy of being as safe as possible.
5902
5903 The first rule above is stricter, and is applied to messages that are addressed
5904 to one of the local domains handled by this host. This is implemented by the
5905 first condition, which restricts it to domains that are listed in the
5906 &'local_domains'& domain list. The &"+"& character is used to indicate a
5907 reference to a named list. In this configuration, there is just one domain in
5908 &'local_domains'&, but in general there may be many.
5909
5910 The second condition on the first statement uses two regular expressions to
5911 block local parts that begin with a dot or contain &"@"&, &"%"&, &"!"&, &"/"&,
5912 or &"|"&. If you have local accounts that include these characters, you will
5913 have to modify this rule.
5914
5915 Empty components (two dots in a row) are not valid in RFC 2822, but Exim
5916 allows them because they have been encountered in practice. (Consider the
5917 common convention of local parts constructed as
5918 &"&'first-initial.second-initial.family-name'&"& when applied to someone like
5919 the author of Exim, who has no second initial.) However, a local part starting
5920 with a dot or containing &"/../"& can cause trouble if it is used as part of a
5921 filename (for example, for a mailing list). This is also true for local parts
5922 that contain slashes. A pipe symbol can also be troublesome if the local part
5923 is incorporated unthinkingly into a shell command line.
5924
5925 The second rule above applies to all other domains, and is less strict. This
5926 allows your own users to send outgoing messages to sites that use slashes
5927 and vertical bars in their local parts. It blocks local parts that begin
5928 with a dot, slash, or vertical bar, but allows these characters within the
5929 local part. However, the sequence &"/../"& is barred. The use of &"@"&, &"%"&,
5930 and &"!"& is blocked, as before. The motivation here is to prevent your users
5931 (or your users' viruses) from mounting certain kinds of attack on remote sites.
5932 .code
5933 accept  local_parts   = postmaster
5934         domains       = +local_domains
5935 .endd
5936 This statement, which has two conditions, accepts an incoming address if the
5937 local part is &'postmaster'& and the domain is one of those listed in the
5938 &'local_domains'& domain list. The &"+"& character is used to indicate a
5939 reference to a named list. In this configuration, there is just one domain in
5940 &'local_domains'&, but in general there may be many.
5941
5942 The presence of this statement means that mail to postmaster is never blocked
5943 by any of the subsequent tests. This can be helpful while sorting out problems
5944 in cases where the subsequent tests are incorrectly denying access.
5945 .code
5946 require verify        = sender
5947 .endd
5948 This statement requires the sender address to be verified before any subsequent
5949 ACL statement can be used. If verification fails, the incoming recipient
5950 address is refused. Verification consists of trying to route the address, to
5951 see if a bounce message could be delivered to it. In the case of remote
5952 addresses, basic verification checks only the domain, but &'callouts'& can be
5953 used for more verification if required. Section &<<SECTaddressverification>>&
5954 discusses the details of address verification.
5955 .code
5956 accept  hosts         = +relay_from_hosts
5957         control       = submission
5958 .endd
5959 This statement accepts the address if the message is coming from one of the
5960 hosts that are defined as being allowed to relay through this host. Recipient
5961 verification is omitted here, because in many cases the clients are dumb MUAs
5962 that do not cope well with SMTP error responses. For the same reason, the
5963 second line specifies &"submission mode"& for messages that are accepted. This
5964 is described in detail in section &<<SECTsubmodnon>>&; it causes Exim to fix
5965 messages that are deficient in some way, for example, because they lack a
5966 &'Date:'& header line. If you are actually relaying out from MTAs, you should
5967 probably add recipient verification here, and disable submission mode.
5968 .code
5969 accept  authenticated = *
5970         control       = submission
5971 .endd
5972 This statement accepts the address if the client host has authenticated itself.
5973 Submission mode is again specified, on the grounds that such messages are most
5974 likely to come from MUAs. The default configuration does not define any
5975 authenticators, though it does include some nearly complete commented-out
5976 examples described in &<<SECTdefconfauth>>&. This means that no client can in
5977 fact authenticate until you complete the authenticator definitions.
5978 .code
5979 require message = relay not permitted
5980         domains = +local_domains : +relay_to_domains
5981 .endd
5982 This statement rejects the address if its domain is neither a local domain nor
5983 one of the domains for which this host is a relay.
5984 .code
5985 require verify = recipient
5986 .endd
5987 This statement requires the recipient address to be verified; if verification
5988 fails, the address is rejected.
5989 .code
5990 # deny    message     = rejected because $sender_host_address \
5991 #                       is in a black list at $dnslist_domain\n\
5992 #                       $dnslist_text
5993 #         dnslists    = black.list.example
5994 #
5995 # warn    dnslists    = black.list.example
5996 #         add_header  = X-Warning: $sender_host_address is in \
5997 #                       a black list at $dnslist_domain
5998 #         log_message = found in $dnslist_domain
5999 .endd
6000 These commented-out lines are examples of how you could configure Exim to check
6001 sending hosts against a DNS black list. The first statement rejects messages
6002 from blacklisted hosts, whereas the second just inserts a warning header
6003 line.
6004 .code
6005 # require verify = csa
6006 .endd
6007 This commented-out line is an example of how you could turn on client SMTP
6008 authorization (CSA) checking. Such checks do DNS lookups for special SRV
6009 records.
6010 .code
6011 accept
6012 .endd
6013 The final statement in the first ACL unconditionally accepts any recipient
6014 address that has successfully passed all the previous tests.
6015 .code
6016 acl_check_data:
6017 .endd
6018 This line marks the start of the second ACL, and names it. Most of the contents
6019 of this ACL are commented out:
6020 .code
6021 # deny    malware   = *
6022 #         message   = This message contains a virus \
6023 #                     ($malware_name).
6024 .endd
6025 These lines are examples of how to arrange for messages to be scanned for
6026 viruses when Exim has been compiled with the content-scanning extension, and a
6027 suitable virus scanner is installed. If the message is found to contain a
6028 virus, it is rejected with the given custom error message.
6029 .code
6030 # warn    spam      = nobody
6031 #         message   = X-Spam_score: $spam_score\n\
6032 #                     X-Spam_score_int: $spam_score_int\n\
6033 #                     X-Spam_bar: $spam_bar\n\
6034 #                     X-Spam_report: $spam_report
6035 .endd
6036 These lines are an example of how to arrange for messages to be scanned by
6037 SpamAssassin when Exim has been compiled with the content-scanning extension,
6038 and SpamAssassin has been installed. The SpamAssassin check is run with
6039 &`nobody`& as its user parameter, and the results are added to the message as a
6040 series of extra header line. In this case, the message is not rejected,
6041 whatever the spam score.
6042 .code
6043 accept
6044 .endd
6045 This final line in the DATA ACL accepts the message unconditionally.
6046
6047
6048 .section "Router configuration" "SECID55"
6049 .cindex "default" "routers"
6050 .cindex "routers" "default"
6051 The router configuration comes next in the default configuration, introduced
6052 by the line
6053 .code
6054 begin routers
6055 .endd
6056 Routers are the modules in Exim that make decisions about where to send
6057 messages. An address is passed to each router, in turn, until it is either
6058 accepted, or failed. This means that the order in which you define the routers
6059 matters. Each router is fully described in its own chapter later in this
6060 manual. Here we give only brief overviews.
6061 .code
6062 # domain_literal:
6063 #   driver = ipliteral
6064 #   domains = !+local_domains
6065 #   transport = remote_smtp
6066 .endd
6067 .cindex "domain literal" "default router"
6068 This router is commented out because the majority of sites do not want to
6069 support domain literal addresses (those of the form &'user@[10.9.8.7]'&). If
6070 you uncomment this router, you also need to uncomment the setting of
6071 &%allow_domain_literals%& in the main part of the configuration.
6072
6073 Which router is used next depends upon whether or not the ROUTER_SMARTHOST
6074 macro has been defined, per
6075 .code
6076 .ifdef ROUTER_SMARTHOST
6077 smarthost:
6078 #...
6079 .else
6080 dnslookup:
6081 #...
6082 .endif
6083 .endd
6084
6085 If ROUTER_SMARTHOST has been defined, either at the top of the file or on the
6086 command-line, then we route all non-local mail to that smarthost; otherwise, we'll
6087 perform DNS lookups for direct-to-MX lookup.  Any mail which is to a local domain will
6088 skip these routers because of the &%domains%& option.
6089
6090 .code
6091 smarthost:
6092   driver = manualroute
6093   domains = ! +local_domains
6094   transport = smarthost_smtp
6095   route_data = ROUTER_SMARTHOST
6096   ignore_target_hosts = <; 0.0.0.0 ; 127.0.0.0/8 ; ::1
6097   no_more
6098 .endd
6099 This router only handles mail which is not to any local domains; this is
6100 specified by the line
6101 .code
6102 domains = ! +local_domains
6103 .endd
6104 The &%domains%& option lists the domains to which this router applies, but the
6105 exclamation mark is a negation sign, so the router is used only for domains
6106 that are not in the domain list called &'local_domains'& (which was defined at
6107 the start of the configuration). The plus sign before &'local_domains'&
6108 indicates that it is referring to a named list. Addresses in other domains are
6109 passed on to the following routers.
6110
6111 The name of the router driver is &(manualroute)& because we are manually
6112 specifying how mail should be routed onwards, instead of using DNS MX.
6113 While the name of this router instance is arbitrary, the &%driver%& option must
6114 be one of the driver modules that is in the Exim binary.
6115
6116 With no pre-conditions other than &%domains%&, all mail for non-local domains
6117 will be handled by this router, and the &%no_more%& setting will ensure that no
6118 other routers will be used for messages matching the pre-conditions.  See
6119 &<<SECTrouprecon>>& for more on how the pre-conditions apply.  For messages which
6120 are handled by this router, we provide a hostname to deliver to in &%route_data%&
6121 and the macro supplies the value; the address is then queued for the
6122 &(smarthost_smtp)& transport.
6123
6124 .code
6125 dnslookup:
6126   driver = dnslookup
6127   domains = ! +local_domains
6128   transport = remote_smtp
6129   ignore_target_hosts = 0.0.0.0 : 127.0.0.0/8
6130   no_more
6131 .endd
6132 The &%domains%& option behaves as per smarthost, above.
6133
6134 The name of the router driver is &(dnslookup)&,
6135 and is specified by the &%driver%& option. Do not be confused by the fact that
6136 the name of this router instance is the same as the name of the driver. The
6137 instance name is arbitrary, but the name set in the &%driver%& option must be
6138 one of the driver modules that is in the Exim binary.
6139
6140 The &(dnslookup)& router routes addresses by looking up their domains in the
6141 DNS in order to obtain a list of hosts to which the address is routed. If the
6142 router succeeds, the address is queued for the &(remote_smtp)& transport, as
6143 specified by the &%transport%& option. If the router does not find the domain
6144 in the DNS, no further routers are tried because of the &%no_more%& setting, so
6145 the address fails and is bounced.
6146
6147 The &%ignore_target_hosts%& option specifies a list of IP addresses that are to
6148 be entirely ignored. This option is present because a number of cases have been
6149 encountered where MX records in the DNS point to host names
6150 whose IP addresses are 0.0.0.0 or are in the 127 subnet (typically 127.0.0.1).
6151 Completely ignoring these IP addresses causes Exim to fail to route the
6152 email address, so it bounces. Otherwise, Exim would log a routing problem, and
6153 continue to try to deliver the message periodically until the address timed
6154 out.
6155 .code
6156 system_aliases:
6157   driver = redirect
6158   allow_fail
6159   allow_defer
6160   data = ${lookup{$local_part}lsearch{/etc/aliases}}
6161 # user = exim
6162   file_transport = address_file
6163   pipe_transport = address_pipe
6164 .endd
6165 Control reaches this and subsequent routers only for addresses in the local
6166 domains. This router checks to see whether the local part is defined as an
6167 alias in the &_/etc/aliases_& file, and if so, redirects it according to the
6168 data that it looks up from that file. If no data is found for the local part,
6169 the value of the &%data%& option is empty, causing the address to be passed to
6170 the next router.
6171
6172 &_/etc/aliases_& is a conventional name for the system aliases file that is
6173 often used. That is why it is referenced by from the default configuration
6174 file. However, you can change this by setting SYSTEM_ALIASES_FILE in
6175 &_Local/Makefile_& before building Exim.
6176 .code
6177 userforward:
6178   driver = redirect
6179   check_local_user
6180 # local_part_suffix = +* : -*
6181 # local_part_suffix_optional
6182   file = $home/.forward
6183 # allow_filter
6184   no_verify
6185   no_expn
6186   check_ancestor
6187   file_transport = address_file
6188   pipe_transport = address_pipe
6189   reply_transport = address_reply
6190 .endd
6191 This is the most complicated router in the default configuration. It is another
6192 redirection router, but this time it is looking for forwarding data set up by
6193 individual users. The &%check_local_user%& setting specifies a check that the
6194 local part of the address is the login name of a local user. If it is not, the
6195 router is skipped. The two commented options that follow &%check_local_user%&,
6196 namely:
6197 .code
6198 # local_part_suffix = +* : -*
6199 # local_part_suffix_optional
6200 .endd
6201 .vindex "&$local_part_suffix$&"
6202 show how you can specify the recognition of local part suffixes. If the first
6203 is uncommented, a suffix beginning with either a plus or a minus sign, followed
6204 by any sequence of characters, is removed from the local part and placed in the
6205 variable &$local_part_suffix$&. The second suffix option specifies that the
6206 presence of a suffix in the local part is optional. When a suffix is present,
6207 the check for a local login uses the local part with the suffix removed.
6208
6209 When a local user account is found, the file called &_.forward_& in the user's
6210 home directory is consulted. If it does not exist, or is empty, the router
6211 declines. Otherwise, the contents of &_.forward_& are interpreted as
6212 redirection data (see chapter &<<CHAPredirect>>& for more details).
6213
6214 .cindex "Sieve filter" "enabling in default router"
6215 Traditional &_.forward_& files contain just a list of addresses, pipes, or
6216 files. Exim supports this by default. However, if &%allow_filter%& is set (it
6217 is commented out by default), the contents of the file are interpreted as a set
6218 of Exim or Sieve filtering instructions, provided the file begins with &"#Exim
6219 filter"& or &"#Sieve filter"&, respectively. User filtering is discussed in the
6220 separate document entitled &'Exim's interfaces to mail filtering'&.
6221
6222 The &%no_verify%& and &%no_expn%& options mean that this router is skipped when
6223 verifying addresses, or when running as a consequence of an SMTP EXPN command.
6224 There are two reasons for doing this:
6225
6226 .olist
6227 Whether or not a local user has a &_.forward_& file is not really relevant when
6228 checking an address for validity; it makes sense not to waste resources doing
6229 unnecessary work.
6230 .next
6231 More importantly, when Exim is verifying addresses or handling an EXPN
6232 command during an SMTP session, it is running as the Exim user, not as root.
6233 The group is the Exim group, and no additional groups are set up.
6234 It may therefore not be possible for Exim to read users' &_.forward_& files at
6235 this time.
6236 .endlist
6237
6238 The setting of &%check_ancestor%& prevents the router from generating a new
6239 address that is the same as any previous address that was redirected. (This
6240 works round a problem concerning a bad interaction between aliasing and
6241 forwarding &-- see section &<<SECTredlocmai>>&).
6242
6243 The final three option settings specify the transports that are to be used when
6244 forwarding generates a direct delivery to a file, or to a pipe, or sets up an
6245 auto-reply, respectively. For example, if a &_.forward_& file contains
6246 .code
6247 a.nother@elsewhere.example, /home/spqr/archive
6248 .endd
6249 the delivery to &_/home/spqr/archive_& is done by running the &%address_file%&
6250 transport.
6251 .code
6252 localuser:
6253   driver = accept
6254   check_local_user
6255 # local_part_suffix = +* : -*
6256 # local_part_suffix_optional
6257   transport = local_delivery
6258 .endd
6259 The final router sets up delivery into local mailboxes, provided that the local
6260 part is the name of a local login, by accepting the address and assigning it to
6261 the &(local_delivery)& transport. Otherwise, we have reached the end of the
6262 routers, so the address is bounced. The commented suffix settings fulfil the
6263 same purpose as they do for the &(userforward)& router.
6264
6265
6266 .section "Transport configuration" "SECID56"
6267 .cindex "default" "transports"
6268 .cindex "transports" "default"
6269 Transports define mechanisms for actually delivering messages. They operate
6270 only when referenced from routers, so the order in which they are defined does
6271 not matter. The transports section of the configuration starts with
6272 .code
6273 begin transports
6274 .endd
6275 Two remote transports and four local transports are defined.
6276 .code
6277 remote_smtp:
6278   driver = smtp
6279   message_size_limit = ${if > {$max_received_linelength}{998} {1}{0}}
6280 .ifdef _HAVE_PRDR
6281   hosts_try_prdr = *
6282 .endif
6283 .endd
6284 This transport is used for delivering messages over SMTP connections.
6285 The list of remote hosts comes from the router.
6286 The &%message_size_limit%& usage is a hack to avoid sending on messages
6287 with over-long lines.  The built-in macro _HAVE_DANE guards configuration
6288 to use DANE for delivery;
6289 see section &<<SECDANE>>& for more details.
6290
6291 The &%hosts_try_prdr%& option enables an efficiency SMTP option.  It is
6292 negotiated between client and server and not expected to cause problems
6293 but can be disabled if needed.  The built-in macro _HAVE_PRDR guards the
6294 use of the &%hosts_try_prdr%& configuration option.
6295
6296 The other remote transport is used when delivering to a specific smarthost
6297 with whom there must be some kind of existing relationship, instead of the
6298 usual federated system.
6299
6300 .code
6301 smarthost_smtp:
6302   driver = smtp
6303   message_size_limit = ${if > {$max_received_linelength}{998} {1}{0}}
6304   multi_domain
6305   #
6306 .ifdef _HAVE_TLS
6307   # Comment out any of these which you have to, then file a Support
6308   # request with your smarthost provider to get things fixed:
6309   hosts_require_tls = *
6310   tls_verify_hosts = *
6311   # As long as tls_verify_hosts is enabled, this won't matter, but if you
6312   # have to comment it out then this will at least log whether you succeed
6313   # or not:
6314   tls_try_verify_hosts = *
6315   #
6316   # The SNI name should match the name which we'll expect to verify;
6317   # many mail systems don't use SNI and this doesn't matter, but if it does,
6318   # we need to send a name which the remote site will recognize.
6319   # This _should_ be the name which the smarthost operators specified as
6320   # the hostname for sending your mail to.
6321   tls_sni = ROUTER_SMARTHOST
6322   #
6323 .ifdef _HAVE_OPENSSL
6324   tls_require_ciphers = HIGH:!aNULL:@STRENGTH
6325 .endif
6326 .ifdef _HAVE_GNUTLS
6327   tls_require_ciphers = SECURE192:-VERS-SSL3.0:-VERS-TLS1.0:-VERS-TLS1.1
6328 .endif
6329 .endif
6330 .ifdef _HAVE_PRDR
6331   hosts_try_prdr = *
6332 .endif
6333 .endd
6334 After the same &%message_size_limit%& hack, we then specify that this Transport
6335 can handle messages to multiple domains in one run.  The assumption here is
6336 that you're routing all non-local mail to the same place and that place is
6337 happy to take all messages from you as quickly as possible.
6338 All other options depend upon built-in macros; if Exim was built without TLS support
6339 then no other options are defined.
6340 If TLS is available, then we configure "stronger than default" TLS ciphersuites
6341 and versions using the &%tls_require_ciphers%& option, where the value to be
6342 used depends upon the library providing TLS.
6343 Beyond that, the options adopt the stance that you should have TLS support available
6344 from your smarthost on today's Internet, so we turn on requiring TLS for the
6345 mail to be delivered, and requiring that the certificate be valid, and match
6346 the expected hostname.  The &%tls_sni%& option can be used by service providers
6347 to select an appropriate certificate to present to you and here we re-use the
6348 ROUTER_SMARTHOST macro, because that is unaffected by CNAMEs present in DNS.
6349 You want to specify the hostname which you'll expect to validate for, and that
6350 should not be subject to insecure tampering via DNS results.
6351
6352 For the &%hosts_try_prdr%& option see the previous transport.
6353
6354 All other options are defaulted.
6355 .code
6356 local_delivery:
6357   driver = appendfile
6358   file = /var/mail/$local_part
6359   delivery_date_add
6360   envelope_to_add
6361   return_path_add
6362 # group = mail
6363 # mode = 0660
6364 .endd
6365 This &(appendfile)& transport is used for local delivery to user mailboxes in
6366 traditional BSD mailbox format. By default it runs under the uid and gid of the
6367 local user, which requires the sticky bit to be set on the &_/var/mail_&
6368 directory. Some systems use the alternative approach of running mail deliveries
6369 under a particular group instead of using the sticky bit. The commented options
6370 show how this can be done.
6371
6372 Exim adds three headers to the message as it delivers it: &'Delivery-date:'&,
6373 &'Envelope-to:'& and &'Return-path:'&. This action is requested by the three
6374 similarly-named options above.
6375 .code
6376 address_pipe:
6377   driver = pipe
6378   return_output
6379 .endd
6380 This transport is used for handling deliveries to pipes that are generated by
6381 redirection (aliasing or users' &_.forward_& files). The &%return_output%&
6382 option specifies that any output on stdout or stderr generated by the pipe is to
6383 be returned to the sender.
6384 .code
6385 address_file:
6386   driver = appendfile
6387   delivery_date_add
6388   envelope_to_add
6389   return_path_add
6390 .endd
6391 This transport is used for handling deliveries to files that are generated by
6392 redirection. The name of the file is not specified in this instance of
6393 &(appendfile)&, because it comes from the &(redirect)& router.
6394 .code
6395 address_reply:
6396   driver = autoreply
6397 .endd
6398 This transport is used for handling automatic replies generated by users'
6399 filter files.
6400
6401
6402
6403 .section "Default retry rule" "SECID57"
6404 .cindex "retry" "default rule"
6405 .cindex "default" "retry rule"
6406 The retry section of the configuration file contains rules which affect the way
6407 Exim retries deliveries that cannot be completed at the first attempt. It is
6408 introduced by the line
6409 .code
6410 begin retry
6411 .endd
6412 In the default configuration, there is just one rule, which applies to all
6413 errors:
6414 .code
6415 *   *   F,2h,15m; G,16h,1h,1.5; F,4d,6h
6416 .endd
6417 This causes any temporarily failing address to be retried every 15 minutes for
6418 2 hours, then at intervals starting at one hour and increasing by a factor of
6419 1.5 until 16 hours have passed, then every 6 hours up to 4 days. If an address
6420 is not delivered after 4 days of temporary failure, it is bounced. The time is
6421 measured from first failure, not from the time the message was received.
6422
6423 If the retry section is removed from the configuration, or is empty (that is,
6424 if no retry rules are defined), Exim will not retry deliveries. This turns
6425 temporary errors into permanent errors.
6426
6427
6428 .section "Rewriting configuration" "SECID58"
6429 The rewriting section of the configuration, introduced by
6430 .code
6431 begin rewrite
6432 .endd
6433 contains rules for rewriting addresses in messages as they arrive. There are no
6434 rewriting rules in the default configuration file.
6435
6436
6437
6438 .section "Authenticators configuration" "SECTdefconfauth"
6439 .cindex "AUTH" "configuration"
6440 The authenticators section of the configuration, introduced by
6441 .code
6442 begin authenticators
6443 .endd
6444 defines mechanisms for the use of the SMTP AUTH command. The default
6445 configuration file contains two commented-out example authenticators
6446 which support plaintext username/password authentication using the
6447 standard PLAIN mechanism and the traditional but non-standard LOGIN
6448 mechanism, with Exim acting as the server. PLAIN and LOGIN are enough
6449 to support most MUA software.
6450
6451 The example PLAIN authenticator looks like this:
6452 .code
6453 #PLAIN:
6454 #  driver                  = plaintext
6455 #  server_set_id           = $auth2
6456 #  server_prompts          = :
6457 #  server_condition        = Authentication is not yet configured
6458 #  server_advertise_condition = ${if def:tls_in_cipher }
6459 .endd
6460 And the example LOGIN authenticator looks like this:
6461 .code
6462 #LOGIN:
6463 #  driver                  = plaintext
6464 #  server_set_id           = $auth1
6465 #  server_prompts          = <| Username: | Password:
6466 #  server_condition        = Authentication is not yet configured
6467 #  server_advertise_condition = ${if def:tls_in_cipher }
6468 .endd
6469
6470 The &%server_set_id%& option makes Exim remember the authenticated username
6471 in &$authenticated_id$&, which can be used later in ACLs or routers. The
6472 &%server_prompts%& option configures the &(plaintext)& authenticator so
6473 that it implements the details of the specific authentication mechanism,
6474 i.e. PLAIN or LOGIN. The &%server_advertise_condition%& setting controls
6475 when Exim offers authentication to clients; in the examples, this is only
6476 when TLS or SSL has been started, so to enable the authenticators you also
6477 need to add support for TLS as described in section &<<SECTdefconfmain>>&.
6478
6479 The &%server_condition%& setting defines how to verify that the username and
6480 password are correct. In the examples it just produces an error message.
6481 To make the authenticators work, you can use a string expansion
6482 expression like one of the examples in chapter &<<CHAPplaintext>>&.
6483
6484 Beware that the sequence of the parameters to PLAIN and LOGIN differ; the
6485 usercode and password are in different positions.
6486 Chapter &<<CHAPplaintext>>& covers both.
6487
6488 .ecindex IIDconfiwal
6489
6490
6491
6492 . ////////////////////////////////////////////////////////////////////////////
6493 . ////////////////////////////////////////////////////////////////////////////
6494
6495 .chapter "Regular expressions" "CHAPregexp"
6496
6497 .cindex "regular expressions" "library"
6498 .cindex "PCRE"
6499 Exim supports the use of regular expressions in many of its options. It
6500 uses the PCRE regular expression library; this provides regular expression
6501 matching that is compatible with Perl 5. The syntax and semantics of
6502 regular expressions is discussed in
6503 online Perl manpages, in
6504 many Perl reference books, and also in
6505 Jeffrey Friedl's &'Mastering Regular Expressions'&, which is published by
6506 O'Reilly (see &url(http://www.oreilly.com/catalog/regex2/)).
6507 . --- the http: URL here redirects to another page with the ISBN in the URL
6508 . --- where trying to use https: just redirects back to http:, so sticking
6509 . --- to the old URL for now.  2018-09-07.
6510
6511 The documentation for the syntax and semantics of the regular expressions that
6512 are supported by PCRE is included in the PCRE distribution, and no further
6513 description is included here. The PCRE functions are called from Exim using
6514 the default option settings (that is, with no PCRE options set), except that
6515 the PCRE_CASELESS option is set when the matching is required to be
6516 case-insensitive.
6517
6518 In most cases, when a regular expression is required in an Exim configuration,
6519 it has to start with a circumflex, in order to distinguish it from plain text
6520 or an &"ends with"& wildcard. In this example of a configuration setting, the
6521 second item in the colon-separated list is a regular expression.
6522 .code
6523 domains = a.b.c : ^\\d{3} : *.y.z : ...
6524 .endd
6525 The doubling of the backslash is required because of string expansion that
6526 precedes interpretation &-- see section &<<SECTlittext>>& for more discussion
6527 of this issue, and a way of avoiding the need for doubling backslashes. The
6528 regular expression that is eventually used in this example contains just one
6529 backslash. The circumflex is included in the regular expression, and has the
6530 normal effect of &"anchoring"& it to the start of the string that is being
6531 matched.
6532
6533 There are, however, two cases where a circumflex is not required for the
6534 recognition of a regular expression: these are the &%match%& condition in a
6535 string expansion, and the &%matches%& condition in an Exim filter file. In
6536 these cases, the relevant string is always treated as a regular expression; if
6537 it does not start with a circumflex, the expression is not anchored, and can
6538 match anywhere in the subject string.
6539
6540 In all cases, if you want a regular expression to match at the end of a string,
6541 you must code the $ metacharacter to indicate this. For example:
6542 .code
6543 domains = ^\\d{3}\\.example
6544 .endd
6545 matches the domain &'123.example'&, but it also matches &'123.example.com'&.
6546 You need to use:
6547 .code
6548 domains = ^\\d{3}\\.example\$
6549 .endd
6550 if you want &'example'& to be the top-level domain. The backslash before the
6551 $ is needed because string expansion also interprets dollar characters.
6552
6553
6554
6555 . ////////////////////////////////////////////////////////////////////////////
6556 . ////////////////////////////////////////////////////////////////////////////
6557
6558 .chapter "File and database lookups" "CHAPfdlookup"
6559 .scindex IIDfidalo1 "file" "lookups"
6560 .scindex IIDfidalo2 "database" "lookups"
6561 .cindex "lookup" "description of"
6562 Exim can be configured to look up data in files or databases as it processes
6563 messages. Two different kinds of syntax are used:
6564
6565 .olist
6566 A string that is to be expanded may contain explicit lookup requests. These
6567 cause parts of the string to be replaced by data that is obtained from the
6568 lookup. Lookups of this type are conditional expansion items. Different results
6569 can be defined for the cases of lookup success and failure. See chapter
6570 &<<CHAPexpand>>&, where string expansions are described in detail.
6571 The key for the lookup is specified as part of the string expansion.
6572 .next
6573 Lists of domains, hosts, and email addresses can contain lookup requests as a
6574 way of avoiding excessively long linear lists. In this case, the data that is
6575 returned by the lookup is often (but not always) discarded; whether the lookup
6576 succeeds or fails is what really counts. These kinds of list are described in
6577 chapter &<<CHAPdomhosaddlists>>&.
6578 The key for the lookup is given by the context in which the list is expanded.
6579 .endlist
6580
6581 String expansions, lists, and lookups interact with each other in such a way
6582 that there is no order in which to describe any one of them that does not
6583 involve references to the others. Each of these three chapters makes more sense
6584 if you have read the other two first. If you are reading this for the first
6585 time, be aware that some of it will make a lot more sense after you have read
6586 chapters &<<CHAPdomhosaddlists>>& and &<<CHAPexpand>>&.
6587
6588 .section "Examples of different lookup syntax" "SECID60"
6589 It is easy to confuse the two different kinds of lookup, especially as the
6590 lists that may contain the second kind are always expanded before being
6591 processed as lists. Therefore, they may also contain lookups of the first kind.
6592 Be careful to distinguish between the following two examples:
6593 .code
6594 domains = ${lookup{$sender_host_address}lsearch{/some/file}}
6595 domains = lsearch;/some/file
6596 .endd
6597 The first uses a string expansion, the result of which must be a domain list.
6598 No strings have been specified for a successful or a failing lookup; the
6599 defaults in this case are the looked-up data and an empty string, respectively.
6600 The expansion takes place before the string is processed as a list, and the
6601 file that is searched could contain lines like this:
6602 .code
6603 192.168.3.4: domain1:domain2:...
6604 192.168.1.9: domain3:domain4:...
6605 .endd
6606 When the lookup succeeds, the result of the expansion is a list of domains (and
6607 possibly other types of item that are allowed in domain lists).
6608
6609 In the second example, the lookup is a single item in a domain list. It causes
6610 Exim to use a lookup to see if the domain that is being processed can be found
6611 in the file. The file could contains lines like this:
6612 .code
6613 domain1:
6614 domain2:
6615 .endd
6616 Any data that follows the keys is not relevant when checking that the domain
6617 matches the list item.
6618
6619 It is possible, though no doubt confusing, to use both kinds of lookup at once.
6620 Consider a file containing lines like this:
6621 .code
6622 192.168.5.6: lsearch;/another/file
6623 .endd
6624 If the value of &$sender_host_address$& is 192.168.5.6, expansion of the
6625 first &%domains%& setting above generates the second setting, which therefore
6626 causes a second lookup to occur.
6627
6628 The rest of this chapter describes the different lookup types that are
6629 available. Any of them can be used in any part of the configuration where a
6630 lookup is permitted.
6631
6632
6633 .section "Lookup types" "SECID61"
6634 .cindex "lookup" "types of"
6635 .cindex "single-key lookup" "definition of"
6636 Two different types of data lookup are implemented:
6637
6638 .ilist
6639 The &'single-key'& type requires the specification of a file in which to look,
6640 and a single key to search for. The key must be a non-empty string for the
6641 lookup to succeed. The lookup type determines how the file is searched.
6642 .next
6643 .cindex "query-style lookup" "definition of"
6644 The &'query-style'& type accepts a generalized database query. No particular
6645 key value is assumed by Exim for query-style lookups. You can use whichever
6646 Exim variables you need to construct the database query.
6647 .endlist
6648
6649 The code for each lookup type is in a separate source file that is included in
6650 the binary of Exim only if the corresponding compile-time option is set. The
6651 default settings in &_src/EDITME_& are:
6652 .code
6653 LOOKUP_DBM=yes
6654 LOOKUP_LSEARCH=yes
6655 .endd
6656 which means that only linear searching and DBM lookups are included by default.
6657 For some types of lookup (e.g. SQL databases), you need to install appropriate
6658 libraries and header files before building Exim.
6659
6660
6661
6662
6663 .section "Single-key lookup types" "SECTsinglekeylookups"
6664 .cindex "lookup" "single-key types"
6665 .cindex "single-key lookup" "list of types"
6666 The following single-key lookup types are implemented:
6667
6668 .ilist
6669 .cindex "cdb" "description of"
6670 .cindex "lookup" "cdb"
6671 .cindex "binary zero" "in lookup key"
6672 &(cdb)&: The given file is searched as a Constant DataBase file, using the key
6673 string without a terminating binary zero. The cdb format is designed for
6674 indexed files that are read frequently and never updated, except by total
6675 re-creation. As such, it is particularly suitable for large files containing
6676 aliases or other indexed data referenced by an MTA. Information about cdb and
6677 tools for building the files can be found in several places:
6678 .display
6679 &url(https://cr.yp.to/cdb.html)
6680 &url(https://www.corpit.ru/mjt/tinycdb.html)
6681 &url(https://packages.debian.org/stable/utils/freecdb)
6682 &url(https://github.com/philpennock/cdbtools) (in Go)
6683 .endd
6684 A cdb distribution is not needed in order to build Exim with cdb support,
6685 because the code for reading cdb files is included directly in Exim itself.
6686 However, no means of building or testing cdb files is provided with Exim, so
6687 you need to obtain a cdb distribution in order to do this.
6688 .next
6689 .cindex "DBM" "lookup type"
6690 .cindex "lookup" "dbm"
6691 .cindex "binary zero" "in lookup key"
6692 &(dbm)&: Calls to DBM library functions are used to extract data from the given
6693 DBM file by looking up the record with the given key. A terminating binary
6694 zero is included in the key that is passed to the DBM library. See section
6695 &<<SECTdb>>& for a discussion of DBM libraries.
6696
6697 .cindex "Berkeley DB library" "file format"
6698 For all versions of Berkeley DB, Exim uses the DB_HASH style of database
6699 when building DBM files using the &%exim_dbmbuild%& utility. However, when
6700 using Berkeley DB versions 3 or 4, it opens existing databases for reading with
6701 the DB_UNKNOWN option. This enables it to handle any of the types of database
6702 that the library supports, and can be useful for accessing DBM files created by
6703 other applications. (For earlier DB versions, DB_HASH is always used.)
6704 .next
6705 .cindex "lookup" "dbmjz"
6706 .cindex "lookup" "dbm &-- embedded NULs"
6707 .cindex "sasldb2"
6708 .cindex "dbmjz lookup type"
6709 &(dbmjz)&: This is the same as &(dbm)&, except that the lookup key is
6710 interpreted as an Exim list; the elements of the list are joined together with
6711 ASCII NUL characters to form the lookup key.  An example usage would be to
6712 authenticate incoming SMTP calls using the passwords from Cyrus SASL's
6713 &_/etc/sasldb2_& file with the &(gsasl)& authenticator or Exim's own
6714 &(cram_md5)& authenticator.
6715 .next
6716 .cindex "lookup" "dbmnz"
6717 .cindex "lookup" "dbm &-- terminating zero"
6718 .cindex "binary zero" "in lookup key"
6719 .cindex "Courier"
6720 .cindex "&_/etc/userdbshadow.dat_&"
6721 .cindex "dbmnz lookup type"
6722 &(dbmnz)&: This is the same as &(dbm)&, except that a terminating binary zero
6723 is not included in the key that is passed to the DBM library. You may need this
6724 if you want to look up data in files that are created by or shared with some
6725 other application that does not use terminating zeros. For example, you need to
6726 use &(dbmnz)& rather than &(dbm)& if you want to authenticate incoming SMTP
6727 calls using the passwords from Courier's &_/etc/userdbshadow.dat_& file. Exim's
6728 utility program for creating DBM files (&'exim_dbmbuild'&) includes the zeros
6729 by default, but has an option to omit them (see section &<<SECTdbmbuild>>&).
6730 .next
6731 .cindex "lookup" "dsearch"
6732 .cindex "dsearch lookup type"
6733 &(dsearch)&: The given file must be a directory; this is searched for an entry
6734 whose name is the key by calling the &[lstat()]& function. The key may not
6735 contain any forward slash characters. If &[lstat()]& succeeds, the result of
6736 the lookup is the name of the entry, which may be a file, directory,
6737 symbolic link, or any other kind of directory entry. An example of how this
6738 lookup can be used to support virtual domains is given in section
6739 &<<SECTvirtualdomains>>&.
6740 .next
6741 .cindex "lookup" "iplsearch"
6742 .cindex "iplsearch lookup type"
6743 &(iplsearch)&: The given file is a text file containing keys and data. A key is
6744 terminated by a colon or white space or the end of the line. The keys in the
6745 file must be IP addresses, or IP addresses with CIDR masks. Keys that involve
6746 IPv6 addresses must be enclosed in quotes to prevent the first internal colon
6747 being interpreted as a key terminator. For example:
6748 .code
6749 1.2.3.4:           data for 1.2.3.4
6750 192.168.0.0/16:    data for 192.168.0.0/16
6751 "abcd::cdab":      data for abcd::cdab
6752 "abcd:abcd::/32"   data for abcd:abcd::/32
6753 .endd
6754 The key for an &(iplsearch)& lookup must be an IP address (without a mask). The
6755 file is searched linearly, using the CIDR masks where present, until a matching
6756 key is found. The first key that matches is used; there is no attempt to find a
6757 &"best"& match. Apart from the way the keys are matched, the processing for
6758 &(iplsearch)& is the same as for &(lsearch)&.
6759
6760 &*Warning 1*&: Unlike most other single-key lookup types, a file of data for
6761 &(iplsearch)& can &'not'& be turned into a DBM or cdb file, because those
6762 lookup types support only literal keys.
6763
6764 &*Warning 2*&: In a host list, you must always use &(net-iplsearch)& so that
6765 the implicit key is the host's IP address rather than its name (see section
6766 &<<SECThoslispatsikey>>&).
6767
6768 .new
6769 &*Warning 3*&: Do not use an IPv4-mapped IPv6 address for a key; use the
6770 IPv4, in dotted-quad form. (Exim converts IPv4-mapped IPv6 addresses to this
6771 notation before executing the lookup.)
6772 .wen
6773 .next
6774 .new
6775 .cindex lookup json
6776 .cindex json "lookup type"
6777 .cindex JSON expansions
6778 &(json)&: The given file is a text file with a JSON structure.
6779 An element of the structure is extracted, defined by the search key.
6780 The key is a list of subelement selectors
6781 (colon-separated by default but changeable in the usual way)
6782 which are applied in turn to select smaller and smaller portions
6783 of the JSON structure.
6784 If a selector is numeric, it must apply to a JSON array; the (zero-based)
6785 nunbered array element is selected.
6786 Otherwise it must apply to a JSON object; the named element is selected.
6787 The final resulting element can be a simple JSON type or a JSON object
6788 or array; for the latter two a string-representation os the JSON
6789 is returned.
6790 For elements of type string, the returned value is de-quoted.
6791 .wen
6792 .next
6793 .cindex "linear search"
6794 .cindex "lookup" "lsearch"
6795 .cindex "lsearch lookup type"
6796 .cindex "case sensitivity" "in lsearch lookup"
6797 &(lsearch)&: The given file is a text file that is searched linearly for a
6798 line beginning with the search key, terminated by a colon or white space or the
6799 end of the line. The search is case-insensitive; that is, upper and lower case
6800 letters are treated as the same. The first occurrence of the key that is found
6801 in the file is used.
6802
6803 White space between the key and the colon is permitted. The remainder of the
6804 line, with leading and trailing white space removed, is the data. This can be
6805 continued onto subsequent lines by starting them with any amount of white
6806 space, but only a single space character is included in the data at such a
6807 junction. If the data begins with a colon, the key must be terminated by a
6808 colon, for example:
6809 .code
6810 baduser:  :fail:
6811 .endd
6812 Empty lines and lines beginning with # are ignored, even if they occur in the
6813 middle of an item. This is the traditional textual format of alias files. Note
6814 that the keys in an &(lsearch)& file are literal strings. There is no
6815 wildcarding of any kind.
6816
6817 .cindex "lookup" "lsearch &-- colons in keys"
6818 .cindex "white space" "in lsearch key"
6819 In most &(lsearch)& files, keys are not required to contain colons or #
6820 characters, or white space. However, if you need this feature, it is available.
6821 If a key begins with a doublequote character, it is terminated only by a
6822 matching quote (or end of line), and the normal escaping rules apply to its
6823 contents (see section &<<SECTstrings>>&). An optional colon is permitted after
6824 quoted keys (exactly as for unquoted keys). There is no special handling of
6825 quotes for the data part of an &(lsearch)& line.
6826
6827 .next
6828 .cindex "NIS lookup type"
6829 .cindex "lookup" "NIS"
6830 .cindex "binary zero" "in lookup key"
6831 &(nis)&: The given file is the name of a NIS map, and a NIS lookup is done with
6832 the given key, without a terminating binary zero. There is a variant called
6833 &(nis0)& which does include the terminating binary zero in the key. This is
6834 reportedly needed for Sun-style alias files. Exim does not recognize NIS
6835 aliases; the full map names must be used.
6836
6837 .next
6838 .cindex "wildlsearch lookup type"
6839 .cindex "lookup" "wildlsearch"
6840 .cindex "nwildlsearch lookup type"
6841 .cindex "lookup" "nwildlsearch"
6842 &(wildlsearch)& or &(nwildlsearch)&: These search a file linearly, like
6843 &(lsearch)&, but instead of being interpreted as a literal string, each key in
6844 the file may be wildcarded. The difference between these two lookup types is
6845 that for &(wildlsearch)&, each key in the file is string-expanded before being
6846 used, whereas for &(nwildlsearch)&, no expansion takes place.
6847
6848 .cindex "case sensitivity" "in (n)wildlsearch lookup"
6849 Like &(lsearch)&, the testing is done case-insensitively. However, keys in the
6850 file that are regular expressions can be made case-sensitive by the use of
6851 &`(-i)`& within the pattern. The following forms of wildcard are recognized:
6852
6853 . ==== As this is a nested list, any displays it contains must be indented
6854 . ==== as otherwise they are too far to the left.
6855
6856 .olist
6857 The string may begin with an asterisk to mean &"ends with"&. For example:
6858 .code
6859     *.a.b.c       data for anything.a.b.c
6860     *fish         data for anythingfish
6861 .endd
6862 .next
6863 The string may begin with a circumflex to indicate a regular expression. For
6864 example, for &(wildlsearch)&:
6865 .code
6866     ^\N\d+\.a\.b\N    data for <digits>.a.b
6867 .endd
6868 Note the use of &`\N`& to disable expansion of the contents of the regular
6869 expression. If you are using &(nwildlsearch)&, where the keys are not
6870 string-expanded, the equivalent entry is:
6871 .code
6872     ^\d+\.a\.b        data for <digits>.a.b
6873 .endd
6874 The case-insensitive flag is set at the start of compiling the regular
6875 expression, but it can be turned off by using &`(-i)`& at an appropriate point.
6876 For example, to make the entire pattern case-sensitive:
6877 .code
6878     ^(?-i)\d+\.a\.b        data for <digits>.a.b
6879 .endd
6880
6881 If the regular expression contains white space or colon characters, you must
6882 either quote it (see &(lsearch)& above), or represent these characters in other
6883 ways. For example, &`\s`& can be used for white space and &`\x3A`& for a
6884 colon. This may be easier than quoting, because if you quote, you have to
6885 escape all the backslashes inside the quotes.
6886
6887 &*Note*&: It is not possible to capture substrings in a regular expression
6888 match for later use, because the results of all lookups are cached. If a lookup
6889 is repeated, the result is taken from the cache, and no actual pattern matching
6890 takes place. The values of all the numeric variables are unset after a
6891 &((n)wildlsearch)& match.
6892
6893 .next
6894 Although I cannot see it being of much use, the general matching function that
6895 is used to implement &((n)wildlsearch)& means that the string may begin with a
6896 lookup name terminated by a semicolon, and followed by lookup data. For
6897 example:
6898 .code
6899     cdb;/some/file  data for keys that match the file
6900 .endd
6901 The data that is obtained from the nested lookup is discarded.
6902 .endlist olist
6903
6904 Keys that do not match any of these patterns are interpreted literally. The
6905 continuation rules for the data are the same as for &(lsearch)&, and keys may
6906 be followed by optional colons.
6907
6908 &*Warning*&: Unlike most other single-key lookup types, a file of data for
6909 &((n)wildlsearch)& can &'not'& be turned into a DBM or cdb file, because those
6910 lookup types support only literal keys.
6911
6912 .next
6913 .cindex "lookup" "spf"
6914 If Exim is built with SPF support, manual lookups can be done
6915 (as opposed to the standard ACL condition method.
6916 For details see section &<<SECSPF>>&.
6917 .endlist ilist
6918
6919
6920 .section "Query-style lookup types" "SECTquerystylelookups"
6921 .cindex "lookup" "query-style types"
6922 .cindex "query-style lookup" "list of types"
6923 The supported query-style lookup types are listed below. Further details about
6924 many of them are given in later sections.
6925
6926 .ilist
6927 .cindex "DNS" "as a lookup type"
6928 .cindex "lookup" "DNS"
6929 &(dnsdb)&: This does a DNS search for one or more records whose domain names
6930 are given in the supplied query. The resulting data is the contents of the
6931 records. See section &<<SECTdnsdb>>&.
6932 .next
6933 .cindex "InterBase lookup type"
6934 .cindex "lookup" "InterBase"
6935 &(ibase)&: This does a lookup in an InterBase database.
6936 .next
6937 .cindex "LDAP" "lookup type"
6938 .cindex "lookup" "LDAP"
6939 &(ldap)&: This does an LDAP lookup using a query in the form of a URL, and
6940 returns attributes from a single entry. There is a variant called &(ldapm)&
6941 that permits values from multiple entries to be returned. A third variant
6942 called &(ldapdn)& returns the Distinguished Name of a single entry instead of
6943 any attribute values. See section &<<SECTldap>>&.
6944 .next
6945 .cindex "MySQL" "lookup type"
6946 .cindex "lookup" "MySQL"
6947 &(mysql)&: The format of the query is an SQL statement that is passed to a
6948 MySQL database. See section &<<SECTsql>>&.
6949 .next
6950 .cindex "NIS+ lookup type"
6951 .cindex "lookup" "NIS+"
6952 &(nisplus)&: This does a NIS+ lookup using a query that can specify the name of
6953 the field to be returned. See section &<<SECTnisplus>>&.
6954 .next
6955 .cindex "Oracle" "lookup type"
6956 .cindex "lookup" "Oracle"
6957 &(oracle)&: The format of the query is an SQL statement that is passed to an
6958 Oracle database. See section &<<SECTsql>>&.
6959 .next
6960 .cindex "lookup" "passwd"
6961 .cindex "passwd lookup type"
6962 .cindex "&_/etc/passwd_&"
6963 &(passwd)& is a query-style lookup with queries that are just user names. The
6964 lookup calls &[getpwnam()]& to interrogate the system password data, and on
6965 success, the result string is the same as you would get from an &(lsearch)&
6966 lookup on a traditional &_/etc/passwd file_&, though with &`*`& for the
6967 password value. For example:
6968 .code
6969 *:42:42:King Rat:/home/kr:/bin/bash
6970 .endd
6971 .next
6972 .cindex "PostgreSQL lookup type"
6973 .cindex "lookup" "PostgreSQL"
6974 &(pgsql)&: The format of the query is an SQL statement that is passed to a
6975 PostgreSQL database. See section &<<SECTsql>>&.
6976
6977 .next
6978 .cindex "Redis lookup type"
6979 .cindex lookup Redis
6980 &(redis)&: The format of the query is either a simple get or simple set,
6981 passed to a Redis database. See section &<<SECTsql>>&.
6982
6983 .next
6984 .cindex "sqlite lookup type"
6985 .cindex "lookup" "sqlite"
6986 &(sqlite)&: The format of the query is a filename followed by an SQL statement
6987 that is passed to an SQLite database. See section &<<SECTsqlite>>&.
6988
6989 .next
6990 &(testdb)&: This is a lookup type that is used for testing Exim. It is
6991 not likely to be useful in normal operation.
6992 .next
6993 .cindex "whoson lookup type"
6994 .cindex "lookup" "whoson"
6995 . --- still http:-only, 2018-09-07
6996 &(whoson)&: &'Whoson'& (&url(http://whoson.sourceforge.net)) is a protocol that
6997 allows a server to check whether a particular (dynamically allocated) IP
6998 address is currently allocated to a known (trusted) user and, optionally, to
6999 obtain the identity of the said user. For SMTP servers, &'Whoson'& was popular
7000 at one time for &"POP before SMTP"& authentication, but that approach has been
7001 superseded by SMTP authentication. In Exim, &'Whoson'& can be used to implement
7002 &"POP before SMTP"& checking using ACL statements such as
7003 .code
7004 require condition = \
7005   ${lookup whoson {$sender_host_address}{yes}{no}}
7006 .endd
7007 The query consists of a single IP address. The value returned is the name of
7008 the authenticated user, which is stored in the variable &$value$&. However, in
7009 this example, the data in &$value$& is not used; the result of the lookup is
7010 one of the fixed strings &"yes"& or &"no"&.
7011 .endlist
7012
7013
7014
7015 .section "Temporary errors in lookups" "SECID63"
7016 .cindex "lookup" "temporary error in"
7017 Lookup functions can return temporary error codes if the lookup cannot be
7018 completed. For example, an SQL or LDAP database might be unavailable. For this
7019 reason, it is not advisable to use a lookup that might do this for critical
7020 options such as a list of local domains.
7021
7022 When a lookup cannot be completed in a router or transport, delivery
7023 of the message (to the relevant address) is deferred, as for any other
7024 temporary error. In other circumstances Exim may assume the lookup has failed,
7025 or may give up altogether.
7026
7027
7028
7029 .section "Default values in single-key lookups" "SECTdefaultvaluelookups"
7030 .cindex "wildcard lookups"
7031 .cindex "lookup" "default values"
7032 .cindex "lookup" "wildcard"
7033 .cindex "lookup" "* added to type"
7034 .cindex "default" "in single-key lookups"
7035 In this context, a &"default value"& is a value specified by the administrator
7036 that is to be used if a lookup fails.
7037
7038 &*Note:*& This section applies only to single-key lookups. For query-style
7039 lookups, the facilities of the query language must be used. An attempt to
7040 specify a default for a query-style lookup provokes an error.
7041
7042 If &"*"& is added to a single-key lookup type (for example, &%lsearch*%&)
7043 and the initial lookup fails, the key &"*"& is looked up in the file to
7044 provide a default value. See also the section on partial matching below.
7045
7046 .cindex "*@ with single-key lookup"
7047 .cindex "lookup" "*@ added to type"
7048 .cindex "alias file" "per-domain default"
7049 Alternatively, if &"*@"& is added to a single-key lookup type (for example
7050 &%dbm*@%&) then, if the initial lookup fails and the key contains an @
7051 character, a second lookup is done with everything before the last @ replaced
7052 by *. This makes it possible to provide per-domain defaults in alias files
7053 that include the domains in the keys. If the second lookup fails (or doesn't
7054 take place because there is no @ in the key), &"*"& is looked up.
7055 For example, a &(redirect)& router might contain:
7056 .code
7057 data = ${lookup{$local_part@$domain}lsearch*@{/etc/mix-aliases}}
7058 .endd
7059 Suppose the address that is being processed is &'jane@eyre.example'&. Exim
7060 looks up these keys, in this order:
7061 .code
7062 jane@eyre.example
7063 *@eyre.example
7064 *
7065 .endd
7066 The data is taken from whichever key it finds first. &*Note*&: In an
7067 &(lsearch)& file, this does not mean the first of these keys in the file. A
7068 complete scan is done for each key, and only if it is not found at all does
7069 Exim move on to try the next key.
7070
7071
7072
7073 .section "Partial matching in single-key lookups" "SECTpartiallookup"
7074 .cindex "partial matching"
7075 .cindex "wildcard lookups"
7076 .cindex "lookup" "partial matching"
7077 .cindex "lookup" "wildcard"
7078 .cindex "asterisk" "in search type"
7079 The normal operation of a single-key lookup is to search the file for an exact
7080 match with the given key. However, in a number of situations where domains are
7081 being looked up, it is useful to be able to do partial matching. In this case,
7082 information in the file that has a key starting with &"*."& is matched by any
7083 domain that ends with the components that follow the full stop. For example, if
7084 a key in a DBM file is
7085 .code
7086 *.dates.fict.example
7087 .endd
7088 then when partial matching is enabled this is matched by (amongst others)
7089 &'2001.dates.fict.example'& and &'1984.dates.fict.example'&. It is also matched
7090 by &'dates.fict.example'&, if that does not appear as a separate key in the
7091 file.
7092
7093 &*Note*&: Partial matching is not available for query-style lookups. It is
7094 also not available for any lookup items in address lists (see section
7095 &<<SECTaddresslist>>&).
7096
7097 Partial matching is implemented by doing a series of separate lookups using
7098 keys constructed by modifying the original subject key. This means that it can
7099 be used with any of the single-key lookup types, provided that
7100 partial matching keys
7101 beginning with a special prefix (default &"*."&) are included in the data file.
7102 Keys in the file that do not begin with the prefix are matched only by
7103 unmodified subject keys when partial matching is in use.
7104
7105 Partial matching is requested by adding the string &"partial-"& to the front of
7106 the name of a single-key lookup type, for example, &%partial-dbm%&. When this
7107 is done, the subject key is first looked up unmodified; if that fails, &"*."&
7108 is added at the start of the subject key, and it is looked up again. If that
7109 fails, further lookups are tried with dot-separated components removed from the
7110 start of the subject key, one-by-one, and &"*."& added on the front of what
7111 remains.
7112
7113 A minimum number of two non-* components are required. This can be adjusted
7114 by including a number before the hyphen in the search type. For example,
7115 &%partial3-lsearch%& specifies a minimum of three non-* components in the
7116 modified keys. Omitting the number is equivalent to &"partial2-"&. If the
7117 subject key is &'2250.dates.fict.example'& then the following keys are looked
7118 up when the minimum number of non-* components is two:
7119 .code
7120 2250.dates.fict.example
7121 *.2250.dates.fict.example
7122 *.dates.fict.example
7123 *.fict.example
7124 .endd
7125 As soon as one key in the sequence is successfully looked up, the lookup
7126 finishes.
7127
7128 .cindex "lookup" "partial matching &-- changing prefix"
7129 .cindex "prefix" "for partial matching"
7130 The use of &"*."& as the partial matching prefix is a default that can be
7131 changed. The motivation for this feature is to allow Exim to operate with file
7132 formats that are used by other MTAs. A different prefix can be supplied in
7133 parentheses instead of the hyphen after &"partial"&. For example:
7134 .code
7135 domains = partial(.)lsearch;/some/file
7136 .endd
7137 In this example, if the domain is &'a.b.c'&, the sequence of lookups is
7138 &`a.b.c`&, &`.a.b.c`&, and &`.b.c`& (the default minimum of 2 non-wild
7139 components is unchanged). The prefix may consist of any punctuation characters
7140 other than a closing parenthesis. It may be empty, for example:
7141 .code
7142 domains = partial1()cdb;/some/file
7143 .endd
7144 For this example, if the domain is &'a.b.c'&, the sequence of lookups is
7145 &`a.b.c`&, &`b.c`&, and &`c`&.
7146
7147 If &"partial0"& is specified, what happens at the end (when the lookup with
7148 just one non-wild component has failed, and the original key is shortened right
7149 down to the null string) depends on the prefix:
7150
7151 .ilist
7152 If the prefix has zero length, the whole lookup fails.
7153 .next
7154 If the prefix has length 1, a lookup for just the prefix is done. For
7155 example, the final lookup for &"partial0(.)"& is for &`.`& alone.
7156 .next
7157 Otherwise, if the prefix ends in a dot, the dot is removed, and the
7158 remainder is looked up. With the default prefix, therefore, the final lookup is
7159 for &"*"& on its own.
7160 .next
7161 Otherwise, the whole prefix is looked up.
7162 .endlist
7163
7164
7165 If the search type ends in &"*"& or &"*@"& (see section
7166 &<<SECTdefaultvaluelookups>>& above), the search for an ultimate default that
7167 this implies happens after all partial lookups have failed. If &"partial0"& is
7168 specified, adding &"*"& to the search type has no effect with the default
7169 prefix, because the &"*"& key is already included in the sequence of partial
7170 lookups. However, there might be a use for lookup types such as
7171 &"partial0(.)lsearch*"&.
7172
7173 The use of &"*"& in lookup partial matching differs from its use as a wildcard
7174 in domain lists and the like. Partial matching works only in terms of
7175 dot-separated components; a key such as &`*fict.example`&
7176 in a database file is useless, because the asterisk in a partial matching
7177 subject key is always followed by a dot.
7178
7179
7180
7181
7182 .section "Lookup caching" "SECID64"
7183 .cindex "lookup" "caching"
7184 .cindex "caching" "lookup data"
7185 Exim caches all lookup results in order to avoid needless repetition of
7186 lookups. However, because (apart from the daemon) Exim operates as a collection
7187 of independent, short-lived processes, this caching applies only within a
7188 single Exim process. There is no inter-process lookup caching facility.
7189
7190 For single-key lookups, Exim keeps the relevant files open in case there is
7191 another lookup that needs them. In some types of configuration this can lead to
7192 many files being kept open for messages with many recipients. To avoid hitting
7193 the operating system limit on the number of simultaneously open files, Exim
7194 closes the least recently used file when it needs to open more files than its
7195 own internal limit, which can be changed via the &%lookup_open_max%& option.
7196
7197 The single-key lookup files are closed and the lookup caches are flushed at
7198 strategic points during delivery &-- for example, after all routing is
7199 complete.
7200
7201
7202
7203
7204 .section "Quoting lookup data" "SECID65"
7205 .cindex "lookup" "quoting"
7206 .cindex "quoting" "in lookups"
7207 When data from an incoming message is included in a query-style lookup, there
7208 is the possibility of special characters in the data messing up the syntax of
7209 the query. For example, a NIS+ query that contains
7210 .code
7211 [name=$local_part]
7212 .endd
7213 will be broken if the local part happens to contain a closing square bracket.
7214 For NIS+, data can be enclosed in double quotes like this:
7215 .code
7216 [name="$local_part"]
7217 .endd
7218 but this still leaves the problem of a double quote in the data. The rule for
7219 NIS+ is that double quotes must be doubled. Other lookup types have different
7220 rules, and to cope with the differing requirements, an expansion operator
7221 of the following form is provided:
7222 .code
7223 ${quote_<lookup-type>:<string>}
7224 .endd
7225 For example, the safest way to write the NIS+ query is
7226 .code
7227 [name="${quote_nisplus:$local_part}"]
7228 .endd
7229 See chapter &<<CHAPexpand>>& for full coverage of string expansions. The quote
7230 operator can be used for all lookup types, but has no effect for single-key
7231 lookups, since no quoting is ever needed in their key strings.
7232
7233
7234
7235
7236 .section "More about dnsdb" "SECTdnsdb"
7237 .cindex "dnsdb lookup"
7238 .cindex "lookup" "dnsdb"
7239 .cindex "DNS" "as a lookup type"
7240 The &(dnsdb)& lookup type uses the DNS as its database. A simple query consists
7241 of a record type and a domain name, separated by an equals sign. For example,
7242 an expansion string could contain:
7243 .code
7244 ${lookup dnsdb{mx=a.b.example}{$value}fail}
7245 .endd
7246 If the lookup succeeds, the result is placed in &$value$&, which in this case
7247 is used on its own as the result. If the lookup does not succeed, the
7248 &`fail`& keyword causes a &'forced expansion failure'& &-- see section
7249 &<<SECTforexpfai>>& for an explanation of what this means.
7250
7251 The supported DNS record types are A, CNAME, MX, NS, PTR, SOA, SPF, SRV, TLSA
7252 and TXT, and, when Exim is compiled with IPv6 support, AAAA.
7253 If no type is given, TXT is assumed.
7254
7255 For any record type, if multiple records are found, the data is returned as a
7256 concatenation, with newline as the default separator. The order, of course,
7257 depends on the DNS resolver. You can specify a different separator character
7258 between multiple records by putting a right angle-bracket followed immediately
7259 by the new separator at the start of the query. For example:
7260 .code
7261 ${lookup dnsdb{>: a=host1.example}}
7262 .endd
7263 It is permitted to specify a space as the separator character. Further
7264 white space is ignored.
7265 For lookup types that return multiple fields per record,
7266 an alternate field separator can be specified using a comma after the main
7267 separator character, followed immediately by the field separator.
7268
7269 .cindex "PTR record" "in &(dnsdb)& lookup"
7270 When the type is PTR,
7271 the data can be an IP address, written as normal; inversion and the addition of
7272 &%in-addr.arpa%& or &%ip6.arpa%& happens automatically. For example:
7273 .code
7274 ${lookup dnsdb{ptr=192.168.4.5}{$value}fail}
7275 .endd
7276 If the data for a PTR record is not a syntactically valid IP address, it is not
7277 altered and nothing is added.
7278
7279 .cindex "MX record" "in &(dnsdb)& lookup"
7280 .cindex "SRV record" "in &(dnsdb)& lookup"
7281 For an MX lookup, both the preference value and the host name are returned for
7282 each record, separated by a space. For an SRV lookup, the priority, weight,
7283 port, and host name are returned for each record, separated by spaces.
7284 The field separator can be modified as above.
7285
7286 .cindex "TXT record" "in &(dnsdb)& lookup"
7287 .cindex "SPF record" "in &(dnsdb)& lookup"
7288 For TXT records with multiple items of data, only the first item is returned,
7289 unless a field separator is specified.
7290 To concatenate items without a separator, use a semicolon instead.
7291 For SPF records the
7292 default behaviour is to concatenate multiple items without using a separator.
7293 .code
7294 ${lookup dnsdb{>\n,: txt=a.b.example}}
7295 ${lookup dnsdb{>\n; txt=a.b.example}}
7296 ${lookup dnsdb{spf=example.org}}
7297 .endd
7298 It is permitted to specify a space as the separator character. Further
7299 white space is ignored.
7300
7301 .cindex "SOA record" "in &(dnsdb)& lookup"
7302 For an SOA lookup, while no result is obtained the lookup is redone with
7303 successively more leading components dropped from the given domain.
7304 Only the primary-nameserver field is returned unless a field separator is
7305 specified.
7306 .code
7307 ${lookup dnsdb{>:,; soa=a.b.example.com}}
7308 .endd
7309
7310 .section "Dnsdb lookup modifiers" "SECTdnsdb_mod"
7311 .cindex "dnsdb modifiers"
7312 .cindex "modifiers" "dnsdb"
7313 .cindex "options" "dnsdb"
7314 Modifiers for &(dnsdb)& lookups are given by optional keywords,
7315 each followed by a comma,
7316 that may appear before the record type.
7317
7318 The &(dnsdb)& lookup fails only if all the DNS lookups fail. If there is a
7319 temporary DNS error for any of them, the behaviour is controlled by
7320 a defer-option modifier.
7321 The possible keywords are
7322 &"defer_strict"&, &"defer_never"&, and &"defer_lax"&.
7323 With &"strict"& behaviour, any temporary DNS error causes the
7324 whole lookup to defer. With &"never"& behaviour, a temporary DNS error is
7325 ignored, and the behaviour is as if the DNS lookup failed to find anything.
7326 With &"lax"& behaviour, all the queries are attempted, but a temporary DNS
7327 error causes the whole lookup to defer only if none of the other lookups
7328 succeed. The default is &"lax"&, so the following lookups are equivalent:
7329 .code
7330 ${lookup dnsdb{defer_lax,a=one.host.com:two.host.com}}
7331 ${lookup dnsdb{a=one.host.com:two.host.com}}
7332 .endd
7333 Thus, in the default case, as long as at least one of the DNS lookups
7334 yields some data, the lookup succeeds.
7335
7336 .cindex "DNSSEC" "dns lookup"
7337 Use of &(DNSSEC)& is controlled by a dnssec modifier.
7338 The possible keywords are
7339 &"dnssec_strict"&, &"dnssec_lax"&, and &"dnssec_never"&.
7340 With &"strict"& or &"lax"& DNSSEC information is requested
7341 with the lookup.
7342 With &"strict"& a response from the DNS resolver that
7343 is not labelled as authenticated data
7344 is treated as equivalent to a temporary DNS error.
7345 The default is &"lax"&.
7346
7347 See also the &$lookup_dnssec_authenticated$& variable.
7348
7349 .cindex timeout "dns lookup"
7350 .cindex "DNS" timeout
7351 Timeout for the dnsdb lookup can be controlled by a retrans modifier.
7352 The form is &"retrans_VAL"& where VAL is an Exim time specification
7353 (e.g. &"5s"&).
7354 The default value is set by the main configuration option &%dns_retrans%&.
7355
7356 Retries for the dnsdb lookup can be controlled by a retry modifier.
7357 The form if &"retry_VAL"& where VAL is an integer.
7358 The default count is set by the main configuration option &%dns_retry%&.
7359
7360 .cindex caching "of dns lookup"
7361 .cindex TTL "of dns lookup"
7362 .cindex DNS TTL
7363 Dnsdb lookup results are cached within a single process (and its children).
7364 The cache entry lifetime is limited to the smallest time-to-live (TTL)
7365 value of the set of returned DNS records.
7366
7367
7368 .section "Pseudo dnsdb record types" "SECID66"
7369 .cindex "MX record" "in &(dnsdb)& lookup"
7370 By default, both the preference value and the host name are returned for
7371 each MX record, separated by a space. If you want only host names, you can use
7372 the pseudo-type MXH:
7373 .code
7374 ${lookup dnsdb{mxh=a.b.example}}
7375 .endd
7376 In this case, the preference values are omitted, and just the host names are
7377 returned.
7378
7379 .cindex "name server for enclosing domain"
7380 Another pseudo-type is ZNS (for &"zone NS"&). It performs a lookup for NS
7381 records on the given domain, but if none are found, it removes the first
7382 component of the domain name, and tries again. This process continues until NS
7383 records are found or there are no more components left (or there is a DNS
7384 error). In other words, it may return the name servers for a top-level domain,
7385 but it never returns the root name servers. If there are no NS records for the
7386 top-level domain, the lookup fails. Consider these examples:
7387 .code
7388 ${lookup dnsdb{zns=xxx.quercite.com}}
7389 ${lookup dnsdb{zns=xxx.edu}}
7390 .endd
7391 Assuming that in each case there are no NS records for the full domain name,
7392 the first returns the name servers for &%quercite.com%&, and the second returns
7393 the name servers for &%edu%&.
7394
7395 You should be careful about how you use this lookup because, unless the
7396 top-level domain does not exist, the lookup always returns some host names. The
7397 sort of use to which this might be put is for seeing if the name servers for a
7398 given domain are on a blacklist. You can probably assume that the name servers
7399 for the high-level domains such as &%com%& or &%co.uk%& are not going to be on
7400 such a list.
7401
7402 .cindex "CSA" "in &(dnsdb)& lookup"
7403 A third pseudo-type is CSA (Client SMTP Authorization). This looks up SRV
7404 records according to the CSA rules, which are described in section
7405 &<<SECTverifyCSA>>&. Although &(dnsdb)& supports SRV lookups directly, this is
7406 not sufficient because of the extra parent domain search behaviour of CSA. The
7407 result of a successful lookup such as:
7408 .code
7409 ${lookup dnsdb {csa=$sender_helo_name}}
7410 .endd
7411 has two space-separated fields: an authorization code and a target host name.
7412 The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
7413 authorization required but absent, or &"?"& for unknown.
7414
7415 .cindex "A+" "in &(dnsdb)& lookup"
7416 The pseudo-type A+ performs an AAAA
7417 and then an A lookup.  All results are returned; defer processing
7418 (see below) is handled separately for each lookup.  Example:
7419 .code
7420 ${lookup dnsdb {>; a+=$sender_helo_name}}
7421 .endd
7422
7423
7424 .section "Multiple dnsdb lookups" "SECID67"
7425 In the previous sections, &(dnsdb)& lookups for a single domain are described.
7426 However, you can specify a list of domains or IP addresses in a single
7427 &(dnsdb)& lookup. The list is specified in the normal Exim way, with colon as
7428 the default separator, but with the ability to change this. For example:
7429 .code
7430 ${lookup dnsdb{one.domain.com:two.domain.com}}
7431 ${lookup dnsdb{a=one.host.com:two.host.com}}
7432 ${lookup dnsdb{ptr = <; 1.2.3.4 ; 4.5.6.8}}
7433 .endd
7434 In order to retain backwards compatibility, there is one special case: if
7435 the lookup type is PTR and no change of separator is specified, Exim looks
7436 to see if the rest of the string is precisely one IPv6 address. In this
7437 case, it does not treat it as a list.
7438
7439 The data from each lookup is concatenated, with newline separators by default,
7440 in the same way that multiple DNS records for a single item are handled. A
7441 different separator can be specified, as described above.
7442
7443
7444
7445
7446 .section "More about LDAP" "SECTldap"
7447 .cindex "LDAP" "lookup, more about"
7448 .cindex "lookup" "LDAP"
7449 .cindex "Solaris" "LDAP"
7450 The original LDAP implementation came from the University of Michigan; this has
7451 become &"Open LDAP"&, and there are now two different releases. Another
7452 implementation comes from Netscape, and Solaris 7 and subsequent releases
7453 contain inbuilt LDAP support. Unfortunately, though these are all compatible at
7454 the lookup function level, their error handling is different. For this reason
7455 it is necessary to set a compile-time variable when building Exim with LDAP, to
7456 indicate which LDAP library is in use. One of the following should appear in
7457 your &_Local/Makefile_&:
7458 .code
7459 LDAP_LIB_TYPE=UMICHIGAN
7460 LDAP_LIB_TYPE=OPENLDAP1
7461 LDAP_LIB_TYPE=OPENLDAP2
7462 LDAP_LIB_TYPE=NETSCAPE
7463 LDAP_LIB_TYPE=SOLARIS
7464 .endd
7465 If LDAP_LIB_TYPE is not set, Exim assumes &`OPENLDAP1`&, which has the
7466 same interface as the University of Michigan version.
7467
7468 There are three LDAP lookup types in Exim. These behave slightly differently in
7469 the way they handle the results of a query:
7470
7471 .ilist
7472 &(ldap)& requires the result to contain just one entry; if there are more, it
7473 gives an error.
7474 .next
7475 &(ldapdn)& also requires the result to contain just one entry, but it is the
7476 Distinguished Name that is returned rather than any attribute values.
7477 .next
7478 &(ldapm)& permits the result to contain more than one entry; the attributes
7479 from all of them are returned.
7480 .endlist
7481
7482
7483 For &(ldap)& and &(ldapm)&, if a query finds only entries with no attributes,
7484 Exim behaves as if the entry did not exist, and the lookup fails. The format of
7485 the data returned by a successful lookup is described in the next section.
7486 First we explain how LDAP queries are coded.
7487
7488
7489 .section "Format of LDAP queries" "SECTforldaque"
7490 .cindex "LDAP" "query format"
7491 An LDAP query takes the form of a URL as defined in RFC 2255. For example, in
7492 the configuration of a &(redirect)& router one might have this setting:
7493 .code
7494 data = ${lookup ldap \
7495   {ldap:///cn=$local_part,o=University%20of%20Cambridge,\
7496   c=UK?mailbox?base?}}
7497 .endd
7498 .cindex "LDAP" "with TLS"
7499 The URL may begin with &`ldap`& or &`ldaps`& if your LDAP library supports
7500 secure (encrypted) LDAP connections. The second of these ensures that an
7501 encrypted TLS connection is used.
7502
7503 With sufficiently modern LDAP libraries, Exim supports forcing TLS over regular
7504 LDAP connections, rather than the SSL-on-connect &`ldaps`&.
7505 See the &%ldap_start_tls%& option.
7506
7507 Starting with Exim 4.83, the initialization of LDAP with TLS is more tightly
7508 controlled. Every part of the TLS configuration can be configured by settings in
7509 &_exim.conf_&. Depending on the version of the client libraries installed on
7510 your system, some of the initialization may have required setting options in
7511 &_/etc/ldap.conf_& or &_~/.ldaprc_& to get TLS working with self-signed
7512 certificates. This revealed a nuance where the current UID that exim was
7513 running as could affect which config files it read. With Exim 4.83, these
7514 methods become optional, only taking effect if not specifically set in
7515 &_exim.conf_&.
7516
7517
7518 .section "LDAP quoting" "SECID68"
7519 .cindex "LDAP" "quoting"
7520 Two levels of quoting are required in LDAP queries, the first for LDAP itself
7521 and the second because the LDAP query is represented as a URL. Furthermore,
7522 within an LDAP query, two different kinds of quoting are required. For this
7523 reason, there are two different LDAP-specific quoting operators.
7524
7525 The &%quote_ldap%& operator is designed for use on strings that are part of
7526 filter specifications. Conceptually, it first does the following conversions on
7527 the string:
7528 .code
7529 *   =>   \2A
7530 (   =>   \28
7531 )   =>   \29
7532 \   =>   \5C
7533 .endd
7534 in accordance with RFC 2254. The resulting string is then quoted according
7535 to the rules for URLs, that is, all non-alphanumeric characters except
7536 .code
7537 ! $ ' - . _ ( ) * +
7538 .endd
7539 are converted to their hex values, preceded by a percent sign. For example:
7540 .code
7541 ${quote_ldap: a(bc)*, a<yz>; }
7542 .endd
7543 yields
7544 .code
7545 %20a%5C28bc%5C29%5C2A%2C%20a%3Cyz%3E%3B%20
7546 .endd
7547 Removing the URL quoting, this is (with a leading and a trailing space):
7548 .code
7549 a\28bc\29\2A, a<yz>;
7550 .endd
7551 The &%quote_ldap_dn%& operator is designed for use on strings that are part of
7552 base DN specifications in queries. Conceptually, it first converts the string
7553 by inserting a backslash in front of any of the following characters:
7554 .code
7555 , + " \ < > ;
7556 .endd
7557 It also inserts a backslash before any leading spaces or # characters, and
7558 before any trailing spaces. (These rules are in RFC 2253.) The resulting string
7559 is then quoted according to the rules for URLs. For example:
7560 .code
7561 ${quote_ldap_dn: a(bc)*, a<yz>; }
7562 .endd
7563 yields
7564 .code
7565 %5C%20a(bc)*%5C%2C%20a%5C%3Cyz%5C%3E%5C%3B%5C%20
7566 .endd
7567 Removing the URL quoting, this is (with a trailing space):
7568 .code
7569 \ a(bc)*\, a\<yz\>\;\
7570 .endd
7571 There are some further comments about quoting in the section on LDAP
7572 authentication below.
7573
7574
7575 .section "LDAP connections" "SECID69"
7576 .cindex "LDAP" "connections"
7577 The connection to an LDAP server may either be over TCP/IP, or, when OpenLDAP
7578 is in use, via a Unix domain socket. The example given above does not specify
7579 an LDAP server. A server that is reached by TCP/IP can be specified in a query
7580 by starting it with
7581 .code
7582 ldap://<hostname>:<port>/...
7583 .endd
7584 If the port (and preceding colon) are omitted, the standard LDAP port (389) is
7585 used. When no server is specified in a query, a list of default servers is
7586 taken from the &%ldap_default_servers%& configuration option. This supplies a
7587 colon-separated list of servers which are tried in turn until one successfully
7588 handles a query, or there is a serious error. Successful handling either
7589 returns the requested data, or indicates that it does not exist. Serious errors
7590 are syntactical, or multiple values when only a single value is expected.
7591 Errors which cause the next server to be tried are connection failures, bind
7592 failures, and timeouts.
7593
7594 For each server name in the list, a port number can be given. The standard way
7595 of specifying a host and port is to use a colon separator (RFC 1738). Because
7596 &%ldap_default_servers%& is a colon-separated list, such colons have to be
7597 doubled. For example
7598 .code
7599 ldap_default_servers = ldap1.example.com::145:ldap2.example.com
7600 .endd
7601 If &%ldap_default_servers%& is unset, a URL with no server name is passed
7602 to the LDAP library with no server name, and the library's default (normally
7603 the local host) is used.
7604
7605 If you are using the OpenLDAP library, you can connect to an LDAP server using
7606 a Unix domain socket instead of a TCP/IP connection. This is specified by using
7607 &`ldapi`& instead of &`ldap`& in LDAP queries. What follows here applies only
7608 to OpenLDAP. If Exim is compiled with a different LDAP library, this feature is
7609 not available.
7610
7611 For this type of connection, instead of a host name for the server, a pathname
7612 for the socket is required, and the port number is not relevant. The pathname
7613 can be specified either as an item in &%ldap_default_servers%&, or inline in
7614 the query. In the former case, you can have settings such as
7615 .code
7616 ldap_default_servers = /tmp/ldap.sock : backup.ldap.your.domain
7617 .endd
7618 When the pathname is given in the query, you have to escape the slashes as
7619 &`%2F`& to fit in with the LDAP URL syntax. For example:
7620 .code
7621 ${lookup ldap {ldapi://%2Ftmp%2Fldap.sock/o=...
7622 .endd
7623 When Exim processes an LDAP lookup and finds that the &"hostname"& is really
7624 a pathname, it uses the Unix domain socket code, even if the query actually
7625 specifies &`ldap`& or &`ldaps`&. In particular, no encryption is used for a
7626 socket connection. This behaviour means that you can use a setting of
7627 &%ldap_default_servers%& such as in the example above with traditional &`ldap`&
7628 or &`ldaps`& queries, and it will work. First, Exim tries a connection via
7629 the Unix domain socket; if that fails, it tries a TCP/IP connection to the
7630 backup host.
7631
7632 If an explicit &`ldapi`& type is given in a query when a host name is
7633 specified, an error is diagnosed. However, if there are more items in
7634 &%ldap_default_servers%&, they are tried. In other words:
7635
7636 .ilist
7637 Using a pathname with &`ldap`& or &`ldaps`& forces the use of the Unix domain
7638 interface.
7639 .next
7640 Using &`ldapi`& with a host name causes an error.
7641 .endlist
7642
7643
7644 Using &`ldapi`& with no host or path in the query, and no setting of
7645 &%ldap_default_servers%&, does whatever the library does by default.
7646
7647
7648
7649 .section "LDAP authentication and control information" "SECID70"
7650 .cindex "LDAP" "authentication"
7651 The LDAP URL syntax provides no way of passing authentication and other control
7652 information to the server. To make this possible, the URL in an LDAP query may
7653 be preceded by any number of <&'name'&>=<&'value'&> settings, separated by
7654 spaces. If a value contains spaces it must be enclosed in double quotes, and
7655 when double quotes are used, backslash is interpreted in the usual way inside
7656 them. The following names are recognized:
7657 .display
7658 &`DEREFERENCE`&  set the dereferencing parameter
7659 &`NETTIME    `&  set a timeout for a network operation
7660 &`USER       `&  set the DN, for authenticating the LDAP bind
7661 &`PASS       `&  set the password, likewise
7662 &`REFERRALS  `&  set the referrals parameter
7663 &`SERVERS    `&  set alternate server list for this query only
7664 &`SIZE       `&  set the limit for the number of entries returned
7665 &`TIME       `&  set the maximum waiting time for a query
7666 .endd
7667 The value of the DEREFERENCE parameter must be one of the words &"never"&,
7668 &"searching"&, &"finding"&, or &"always"&. The value of the REFERRALS parameter
7669 must be &"follow"& (the default) or &"nofollow"&. The latter stops the LDAP
7670 library from trying to follow referrals issued by the LDAP server.
7671
7672 .cindex LDAP timeout
7673 .cindex timeout "LDAP lookup"
7674 The name CONNECT is an obsolete name for NETTIME, retained for
7675 backwards compatibility. This timeout (specified as a number of seconds) is
7676 enforced from the client end for operations that can be carried out over a
7677 network. Specifically, it applies to network connections and calls to the
7678 &'ldap_result()'& function. If the value is greater than zero, it is used if
7679 LDAP_OPT_NETWORK_TIMEOUT is defined in the LDAP headers (OpenLDAP), or
7680 if LDAP_X_OPT_CONNECT_TIMEOUT is defined in the LDAP headers (Netscape
7681 SDK 4.1). A value of zero forces an explicit setting of &"no timeout"& for
7682 Netscape SDK; for OpenLDAP no action is taken.
7683
7684 The TIME parameter (also a number of seconds) is passed to the server to
7685 set a server-side limit on the time taken to complete a search.
7686
7687 The SERVERS parameter allows you to specify an alternate list of ldap servers
7688 to use for an individual lookup.  The global &%ldap_default_servers%& option provides a
7689 default list of ldap servers, and a single lookup can specify a single ldap
7690 server to use.  But when you need to do a lookup with a list of servers that is
7691 different than the default list (maybe different order, maybe a completely
7692 different set of servers), the SERVERS parameter allows you to specify this
7693 alternate list (colon-separated).
7694
7695 Here is an example of an LDAP query in an Exim lookup that uses some of these
7696 values. This is a single line, folded to fit on the page:
7697 .code
7698 ${lookup ldap
7699   {user="cn=manager,o=University of Cambridge,c=UK" pass=secret
7700   ldap:///o=University%20of%20Cambridge,c=UK?sn?sub?(cn=foo)}
7701   {$value}fail}
7702 .endd
7703 The encoding of spaces as &`%20`& is a URL thing which should not be done for
7704 any of the auxiliary data. Exim configuration settings that include lookups
7705 which contain password information should be preceded by &"hide"& to prevent
7706 non-admin users from using the &%-bP%& option to see their values.
7707
7708 The auxiliary data items may be given in any order. The default is no
7709 connection timeout (the system timeout is used), no user or password, no limit
7710 on the number of entries returned, and no time limit on queries.
7711
7712 When a DN is quoted in the USER= setting for LDAP authentication, Exim
7713 removes any URL quoting that it may contain before passing it LDAP. Apparently
7714 some libraries do this for themselves, but some do not. Removing the URL
7715 quoting has two advantages:
7716
7717 .ilist
7718 It makes it possible to use the same &%quote_ldap_dn%& expansion for USER=
7719 DNs as with DNs inside actual queries.
7720 .next
7721 It permits spaces inside USER= DNs.
7722 .endlist
7723
7724 For example, a setting such as
7725 .code
7726 USER=cn=${quote_ldap_dn:$1}
7727 .endd
7728 should work even if &$1$& contains spaces.
7729
7730 Expanded data for the PASS= value should be quoted using the &%quote%&
7731 expansion operator, rather than the LDAP quote operators. The only reason this
7732 field needs quoting is to ensure that it conforms to the Exim syntax, which
7733 does not allow unquoted spaces. For example:
7734 .code
7735 PASS=${quote:$3}
7736 .endd
7737 The LDAP authentication mechanism can be used to check passwords as part of
7738 SMTP authentication. See the &%ldapauth%& expansion string condition in chapter
7739 &<<CHAPexpand>>&.
7740
7741
7742
7743 .section "Format of data returned by LDAP" "SECID71"
7744 .cindex "LDAP" "returned data formats"
7745 The &(ldapdn)& lookup type returns the Distinguished Name from a single entry
7746 as a sequence of values, for example
7747 .code
7748 cn=manager,o=University of Cambridge,c=UK
7749 .endd
7750 The &(ldap)& lookup type generates an error if more than one entry matches the
7751 search filter, whereas &(ldapm)& permits this case, and inserts a newline in
7752 the result between the data from different entries. It is possible for multiple
7753 values to be returned for both &(ldap)& and &(ldapm)&, but in the former case
7754 you know that whatever values are returned all came from a single entry in the
7755 directory.
7756
7757 In the common case where you specify a single attribute in your LDAP query, the
7758 result is not quoted, and does not contain the attribute name. If the attribute
7759 has multiple values, they are separated by commas. Any comma that is
7760 part of an attribute's value is doubled.
7761
7762 If you specify multiple attributes, the result contains space-separated, quoted
7763 strings, each preceded by the attribute name and an equals sign. Within the
7764 quotes, the quote character, backslash, and newline are escaped with
7765 backslashes, and commas are used to separate multiple values for the attribute.
7766 Any commas in attribute values are doubled
7767 (permitting treatment of the values as a comma-separated list).
7768 Apart from the escaping, the string within quotes takes the same form as the
7769 output when a single attribute is requested. Specifying no attributes is the
7770 same as specifying all of an entry's attributes.
7771
7772 Here are some examples of the output format. The first line of each pair is an
7773 LDAP query, and the second is the data that is returned. The attribute called
7774 &%attr1%& has two values, one of them with an embedded comma, whereas
7775 &%attr2%& has only one value. Both attributes are derived from &%attr%&
7776 (they have SUP &%attr%& in their schema definitions).
7777
7778 .code
7779 ldap:///o=base?attr1?sub?(uid=fred)
7780 value1.1,value1,,2
7781
7782 ldap:///o=base?attr2?sub?(uid=fred)
7783 value two
7784
7785 ldap:///o=base?attr?sub?(uid=fred)
7786 value1.1,value1,,2,value two
7787
7788 ldap:///o=base?attr1,attr2?sub?(uid=fred)
7789 attr1="value1.1,value1,,2" attr2="value two"
7790
7791 ldap:///o=base??sub?(uid=fred)
7792 objectClass="top" attr1="value1.1,value1,,2" attr2="value two"
7793 .endd
7794 You can
7795 make use of Exim's &%-be%& option to run expansion tests and thereby check the
7796 results of LDAP lookups.
7797 The &%extract%& operator in string expansions can be used to pick out
7798 individual fields from data that consists of &'key'&=&'value'& pairs.
7799 The &%listextract%& operator should be used to pick out individual values
7800 of attributes, even when only a single value is expected.
7801 The doubling of embedded commas allows you to use the returned data as a
7802 comma separated list (using the "<," syntax for changing the input list separator).
7803
7804
7805
7806
7807 .section "More about NIS+" "SECTnisplus"
7808 .cindex "NIS+ lookup type"
7809 .cindex "lookup" "NIS+"
7810 NIS+ queries consist of a NIS+ &'indexed name'& followed by an optional colon
7811 and field name. If this is given, the result of a successful query is the
7812 contents of the named field; otherwise the result consists of a concatenation
7813 of &'field-name=field-value'& pairs, separated by spaces. Empty values and
7814 values containing spaces are quoted. For example, the query
7815 .code
7816 [name=mg1456],passwd.org_dir
7817 .endd
7818 might return the string
7819 .code
7820 name=mg1456 passwd="" uid=999 gid=999 gcos="Martin Guerre"
7821 home=/home/mg1456 shell=/bin/bash shadow=""
7822 .endd
7823 (split over two lines here to fit on the page), whereas
7824 .code
7825 [name=mg1456],passwd.org_dir:gcos
7826 .endd
7827 would just return
7828 .code
7829 Martin Guerre
7830 .endd
7831 with no quotes. A NIS+ lookup fails if NIS+ returns more than one table entry
7832 for the given indexed key. The effect of the &%quote_nisplus%& expansion
7833 operator is to double any quote characters within the text.
7834
7835
7836
7837 .section "SQL lookups" "SECTsql"
7838 .cindex "SQL lookup types"
7839 .cindex "MySQL" "lookup type"
7840 .cindex "PostgreSQL lookup type"
7841 .cindex "lookup" "MySQL"
7842 .cindex "lookup" "PostgreSQL"
7843 .cindex "Oracle" "lookup type"
7844 .cindex "lookup" "Oracle"
7845 .cindex "InterBase lookup type"
7846 .cindex "lookup" "InterBase"
7847 .cindex "Redis lookup type"
7848 .cindex lookup Redis
7849 Exim can support lookups in InterBase, MySQL, Oracle, PostgreSQL, Redis,
7850 and SQLite
7851 databases. Queries for these databases contain SQL statements, so an example
7852 might be
7853 .code
7854 ${lookup mysql{select mailbox from users where id='userx'}\
7855   {$value}fail}
7856 .endd
7857 If the result of the query contains more than one field, the data for each
7858 field in the row is returned, preceded by its name, so the result of
7859 .code
7860 ${lookup pgsql{select home,name from users where id='userx'}\
7861   {$value}}
7862 .endd
7863 might be
7864 .code
7865 home=/home/userx name="Mister X"
7866 .endd
7867 Empty values and values containing spaces are double quoted, with embedded
7868 quotes escaped by a backslash. If the result of the query contains just one
7869 field, the value is passed back verbatim, without a field name, for example:
7870 .code
7871 Mister X
7872 .endd
7873 If the result of the query yields more than one row, it is all concatenated,
7874 with a newline between the data for each row.
7875
7876
7877 .section "More about MySQL, PostgreSQL, Oracle, InterBase, and Redis" "SECID72"
7878 .cindex "MySQL" "lookup type"
7879 .cindex "PostgreSQL lookup type"
7880 .cindex "lookup" "MySQL"
7881 .cindex "lookup" "PostgreSQL"
7882 .cindex "Oracle" "lookup type"
7883 .cindex "lookup" "Oracle"
7884 .cindex "InterBase lookup type"
7885 .cindex "lookup" "InterBase"
7886 .cindex "Redis lookup type"
7887 .cindex lookup Redis
7888 If any MySQL, PostgreSQL, Oracle, InterBase or Redis lookups are used, the
7889 &%mysql_servers%&, &%pgsql_servers%&, &%oracle_servers%&, &%ibase_servers%&,
7890 or &%redis_servers%&
7891 option (as appropriate) must be set to a colon-separated list of server
7892 information.
7893 (For MySQL and PostgreSQL, the global option need not be set if all
7894 queries contain their own server information &-- see section
7895 &<<SECTspeserque>>&.)
7896 For all but Redis
7897 each item in the list is a slash-separated list of four
7898 items: host name, database name, user name, and password. In the case of
7899 Oracle, the host name field is used for the &"service name"&, and the database
7900 name field is not used and should be empty. For example:
7901 .code
7902 hide oracle_servers = oracle.plc.example//userx/abcdwxyz
7903 .endd
7904 Because password data is sensitive, you should always precede the setting with
7905 &"hide"&, to prevent non-admin users from obtaining the setting via the &%-bP%&
7906 option. Here is an example where two MySQL servers are listed:
7907 .code
7908 hide mysql_servers = localhost/users/root/secret:\
7909                      otherhost/users/root/othersecret
7910 .endd
7911 For MySQL and PostgreSQL, a host may be specified as <&'name'&>:<&'port'&> but
7912 because this is a colon-separated list, the colon has to be doubled. For each
7913 query, these parameter groups are tried in order until a connection is made and
7914 a query is successfully processed. The result of a query may be that no data is
7915 found, but that is still a successful query. In other words, the list of
7916 servers provides a backup facility, not a list of different places to look.
7917
7918 For Redis the global option need not be specified if all queries contain their
7919 own server information &-- see section &<<SECTspeserque>>&.
7920 If specified, the option must be set to a colon-separated list of server
7921 information.
7922 Each item in the list is a slash-separated list of three items:
7923 host, database number, and password.
7924 .olist
7925 The host is required and may be either an IPv4 address and optional
7926 port number (separated by a colon, which needs doubling due to the
7927 higher-level list), or a Unix socket pathname enclosed in parentheses
7928 .next
7929 The database number is optional; if present that number is selected in the backend
7930 .next
7931 The password is optional; if present it is used to authenticate to the backend
7932 .endlist
7933
7934 The &%quote_mysql%&, &%quote_pgsql%&, and &%quote_oracle%& expansion operators
7935 convert newline, tab, carriage return, and backspace to \n, \t, \r, and \b
7936 respectively, and the characters single-quote, double-quote, and backslash
7937 itself are escaped with backslashes.
7938
7939 The &%quote_redis%& expansion operator
7940 escapes whitespace and backslash characters with a backslash.
7941
7942 .section "Specifying the server in the query" "SECTspeserque"
7943 For MySQL, PostgreSQL and Redis lookups (but not currently for Oracle and InterBase),
7944 it is possible to specify a list of servers with an individual query. This is
7945 done by starting the query with
7946 .display
7947 &`servers=`&&'server1:server2:server3:...'&&`;`&
7948 .endd
7949 Each item in the list may take one of two forms:
7950 .olist
7951 If it contains no slashes it is assumed to be just a host name. The appropriate
7952 global option (&%mysql_servers%& or &%pgsql_servers%&) is searched for a host
7953 of the same name, and the remaining parameters (database, user, password) are
7954 taken from there.
7955 .next
7956 If it contains any slashes, it is taken as a complete parameter set.
7957 .endlist
7958 The list of servers is used in exactly the same way as the global list.
7959 Once a connection to a server has happened and a query has been
7960 successfully executed, processing of the lookup ceases.
7961
7962 This feature is intended for use in master/slave situations where updates
7963 are occurring and you want to update the master rather than a slave. If the
7964 master is in the list as a backup for reading, you might have a global setting
7965 like this:
7966 .code
7967 mysql_servers = slave1/db/name/pw:\
7968                 slave2/db/name/pw:\
7969                 master/db/name/pw
7970 .endd
7971 In an updating lookup, you could then write:
7972 .code
7973 ${lookup mysql{servers=master; UPDATE ...} }
7974 .endd
7975 That query would then be sent only to the master server. If, on the other hand,
7976 the master is not to be used for reading, and so is not present in the global
7977 option, you can still update it by a query of this form:
7978 .code
7979 ${lookup pgsql{servers=master/db/name/pw; UPDATE ...} }
7980 .endd
7981
7982
7983 .section "Special MySQL features" "SECID73"
7984 For MySQL, an empty host name or the use of &"localhost"& in &%mysql_servers%&
7985 causes a connection to the server on the local host by means of a Unix domain
7986 socket. An alternate socket can be specified in parentheses.
7987 An option group name for MySQL option files can be specified in square brackets;
7988 the default value is &"exim"&.
7989 The full syntax of each item in &%mysql_servers%& is:
7990 .display
7991 <&'hostname'&>::<&'port'&>(<&'socket name'&>)[<&'option group'&>]/&&&
7992   <&'database'&>/<&'user'&>/<&'password'&>
7993 .endd
7994 Any of the four sub-parts of the first field can be omitted. For normal use on
7995 the local host it can be left blank or set to just &"localhost"&.
7996
7997 No database need be supplied &-- but if it is absent here, it must be given in
7998 the queries.
7999
8000 If a MySQL query is issued that does not request any data (an insert, update,
8001 or delete command), the result of the lookup is the number of rows affected.
8002
8003 &*Warning*&: This can be misleading. If an update does not actually change
8004 anything (for example, setting a field to the value it already has), the result
8005 is zero because no rows are affected.
8006
8007
8008 .section "Special PostgreSQL features" "SECID74"
8009 PostgreSQL lookups can also use Unix domain socket connections to the database.
8010 This is usually faster and costs less CPU time than a TCP/IP connection.
8011 However it can be used only if the mail server runs on the same machine as the
8012 database server. A configuration line for PostgreSQL via Unix domain sockets
8013 looks like this:
8014 .code
8015 hide pgsql_servers = (/tmp/.s.PGSQL.5432)/db/user/password : ...
8016 .endd
8017 In other words, instead of supplying a host name, a path to the socket is
8018 given. The path name is enclosed in parentheses so that its slashes aren't
8019 visually confused with the delimiters for the other server parameters.
8020
8021 If a PostgreSQL query is issued that does not request any data (an insert,
8022 update, or delete command), the result of the lookup is the number of rows
8023 affected.
8024
8025 .section "More about SQLite" "SECTsqlite"
8026 .cindex "lookup" "SQLite"
8027 .cindex "sqlite lookup type"
8028 SQLite is different to the other SQL lookups because a filename is required in
8029 addition to the SQL query. An SQLite database is a single file, and there is no
8030 daemon as in the other SQL databases. The interface to Exim requires the name
8031 of the file, as an absolute path, to be given at the start of the query. It is
8032 separated from the query by white space. This means that the path name cannot
8033 contain white space. Here is a lookup expansion example:
8034 .code
8035 ${lookup sqlite {/some/thing/sqlitedb \
8036   select name from aliases where id='userx';}}
8037 .endd
8038 In a list, the syntax is similar. For example:
8039 .code
8040 domainlist relay_to_domains = sqlite;/some/thing/sqlitedb \
8041    select * from relays where ip='$sender_host_address';
8042 .endd
8043 The only character affected by the &%quote_sqlite%& operator is a single
8044 quote, which it doubles.
8045
8046 .cindex timeout SQLite
8047 .cindex sqlite "lookup timeout"
8048 The SQLite library handles multiple simultaneous accesses to the database
8049 internally. Multiple readers are permitted, but only one process can
8050 update at once. Attempts to access the database while it is being updated
8051 are rejected after a timeout period, during which the SQLite library
8052 waits for the lock to be released. In Exim, the default timeout is set
8053 to 5 seconds, but it can be changed by means of the &%sqlite_lock_timeout%&
8054 option.
8055
8056 .section "More about Redis" "SECTredis"
8057 .cindex "lookup" "Redis"
8058 .cindex "redis lookup type"
8059 Redis is a non-SQL database. Commands are simple get and set.
8060 Examples:
8061 .code
8062 ${lookup redis{set keyname ${quote_redis:objvalue plus}}}
8063 ${lookup redis{get keyname}}
8064 .endd
8065
8066 As of release 4.91, "lightweight" support for Redis Cluster is available.
8067 Requires &%redis_servers%& list to contain all the servers in the cluster, all
8068 of which must be reachable from the running exim instance. If the cluster has
8069 master/slave replication, the list must contain all the master and slave
8070 servers.
8071
8072 When the Redis Cluster returns a "MOVED" response to a query, Exim does not
8073 immediately follow the redirection but treats the response as a DEFER, moving on
8074 to the next server in the &%redis_servers%& list until the correct server is
8075 reached.
8076
8077 .ecindex IIDfidalo1
8078 .ecindex IIDfidalo2
8079
8080
8081 . ////////////////////////////////////////////////////////////////////////////
8082 . ////////////////////////////////////////////////////////////////////////////
8083
8084 .chapter "Domain, host, address, and local part lists" &&&
8085          "CHAPdomhosaddlists" &&&
8086          "Domain, host, and address lists"
8087 .scindex IIDdohoadli "lists of domains; hosts; etc."
8088 A number of Exim configuration options contain lists of domains, hosts,
8089 email addresses, or local parts. For example, the &%hold_domains%& option
8090 contains a list of domains whose delivery is currently suspended. These lists
8091 are also used as data in ACL statements (see chapter &<<CHAPACL>>&), and as
8092 arguments to expansion conditions such as &%match_domain%&.
8093
8094 Each item in one of these lists is a pattern to be matched against a domain,
8095 host, email address, or local part, respectively. In the sections below, the
8096 different types of pattern for each case are described, but first we cover some
8097 general facilities that apply to all four kinds of list.
8098
8099 Note that other parts of Exim use a &'string list'& which does not
8100 support all the complexity available in
8101 domain, host, address and local part lists.
8102
8103
8104
8105 .section "Expansion of lists" "SECTlistexpand"
8106 .cindex "expansion" "of lists"
8107 Each list is expanded as a single string before it is used.
8108
8109 &'Exception: the router headers_remove option, where list-item
8110 splitting is done before string-expansion.'&
8111
8112 The result of
8113 expansion must be a list, possibly containing empty items, which is split up
8114 into separate items for matching. By default, colon is the separator character,
8115 but this can be varied if necessary. See sections &<<SECTlistconstruct>>& and
8116 &<<SECTempitelis>>& for details of the list syntax; the second of these
8117 discusses the way to specify empty list items.
8118
8119
8120 If the string expansion is forced to fail, Exim behaves as if the item it is
8121 testing (domain, host, address, or local part) is not in the list. Other
8122 expansion failures cause temporary errors.
8123
8124 If an item in a list is a regular expression, backslashes, dollars and possibly
8125 other special characters in the expression must be protected against
8126 misinterpretation by the string expander. The easiest way to do this is to use
8127 the &`\N`& expansion feature to indicate that the contents of the regular
8128 expression should not be expanded. For example, in an ACL you might have:
8129 .code
8130 deny senders = \N^\d{8}\w@.*\.baddomain\.example$\N : \
8131                ${lookup{$domain}lsearch{/badsenders/bydomain}}
8132 .endd
8133 The first item is a regular expression that is protected from expansion by
8134 &`\N`&, whereas the second uses the expansion to obtain a list of unwanted
8135 senders based on the receiving domain.
8136
8137
8138
8139
8140 .section "Negated items in lists" "SECID76"
8141 .cindex "list" "negation"
8142 .cindex "negation" "in lists"
8143 Items in a list may be positive or negative. Negative items are indicated by a
8144 leading exclamation mark, which may be followed by optional white space. A list
8145 defines a set of items (domains, etc). When Exim processes one of these lists,
8146 it is trying to find out whether a domain, host, address, or local part
8147 (respectively) is in the set that is defined by the list. It works like this:
8148
8149 The list is scanned from left to right. If a positive item is matched, the
8150 subject that is being checked is in the set; if a negative item is matched, the
8151 subject is not in the set. If the end of the list is reached without the
8152 subject having matched any of the patterns, it is in the set if the last item
8153 was a negative one, but not if it was a positive one. For example, the list in
8154 .code
8155 domainlist relay_to_domains = !a.b.c : *.b.c
8156 .endd
8157 matches any domain ending in &'.b.c'& except for &'a.b.c'&. Domains that match
8158 neither &'a.b.c'& nor &'*.b.c'& do not match, because the last item in the
8159 list is positive. However, if the setting were
8160 .code
8161 domainlist relay_to_domains = !a.b.c
8162 .endd
8163 then all domains other than &'a.b.c'& would match because the last item in the
8164 list is negative. In other words, a list that ends with a negative item behaves
8165 as if it had an extra item &`:*`& on the end.
8166
8167 Another way of thinking about positive and negative items in lists is to read
8168 the connector as &"or"& after a positive item and as &"and"& after a negative
8169 item.
8170
8171
8172
8173 .section "File names in lists" "SECTfilnamlis"
8174 .cindex "list" "filename in"
8175 If an item in a domain, host, address, or local part list is an absolute
8176 filename (beginning with a slash character), each line of the file is read and
8177 processed as if it were an independent item in the list, except that further
8178 filenames are not allowed,
8179 and no expansion of the data from the file takes place.
8180 Empty lines in the file are ignored, and the file may also contain comment
8181 lines:
8182
8183 .ilist
8184 For domain and host lists, if a # character appears anywhere in a line of the
8185 file, it and all following characters are ignored.
8186 .next
8187 Because local parts may legitimately contain # characters, a comment in an
8188 address list or local part list file is recognized only if # is preceded by
8189 white space or the start of the line. For example:
8190 .code
8191 not#comment@x.y.z   # but this is a comment
8192 .endd
8193 .endlist
8194
8195 Putting a filename in a list has the same effect as inserting each line of the
8196 file as an item in the list (blank lines and comments excepted). However, there
8197 is one important difference: the file is read each time the list is processed,
8198 so if its contents vary over time, Exim's behaviour changes.
8199
8200 If a filename is preceded by an exclamation mark, the sense of any match
8201 within the file is inverted. For example, if
8202 .code
8203 hold_domains = !/etc/nohold-domains
8204 .endd
8205 and the file contains the lines
8206 .code
8207 !a.b.c
8208 *.b.c
8209 .endd
8210 then &'a.b.c'& is in the set of domains defined by &%hold_domains%&, whereas
8211 any domain matching &`*.b.c`& is not.
8212
8213
8214
8215 .section "An lsearch file is not an out-of-line list" "SECID77"
8216 As will be described in the sections that follow, lookups can be used in lists
8217 to provide indexed methods of checking list membership. There has been some
8218 confusion about the way &(lsearch)& lookups work in lists. Because
8219 an &(lsearch)& file contains plain text and is scanned sequentially, it is
8220 sometimes thought that it is allowed to contain wild cards and other kinds of
8221 non-constant pattern. This is not the case. The keys in an &(lsearch)& file are
8222 always fixed strings, just as for any other single-key lookup type.
8223
8224 If you want to use a file to contain wild-card patterns that form part of a
8225 list, just give the filename on its own, without a search type, as described
8226 in the previous section. You could also use the &(wildlsearch)& or
8227 &(nwildlsearch)&, but there is no advantage in doing this.
8228
8229
8230
8231
8232 .section "Named lists" "SECTnamedlists"
8233 .cindex "named lists"
8234 .cindex "list" "named"
8235 A list of domains, hosts, email addresses, or local parts can be given a name
8236 which is then used to refer to the list elsewhere in the configuration. This is
8237 particularly convenient if the same list is required in several different
8238 places. It also allows lists to be given meaningful names, which can improve
8239 the readability of the configuration. For example, it is conventional to define
8240 a domain list called &'local_domains'& for all the domains that are handled
8241 locally on a host, using a configuration line such as
8242 .code
8243 domainlist local_domains = localhost:my.dom.example
8244 .endd
8245 Named lists are referenced by giving their name preceded by a plus sign, so,
8246 for example, a router that is intended to handle local domains would be
8247 configured with the line
8248 .code
8249 domains = +local_domains
8250 .endd
8251 The first router in a configuration is often one that handles all domains
8252 except the local ones, using a configuration with a negated item like this:
8253 .code
8254 dnslookup:
8255   driver = dnslookup
8256   domains = ! +local_domains
8257   transport = remote_smtp
8258   no_more
8259 .endd
8260 The four kinds of named list are created by configuration lines starting with
8261 the words &%domainlist%&, &%hostlist%&, &%addresslist%&, or &%localpartlist%&,
8262 respectively. Then there follows the name that you are defining, followed by an
8263 equals sign and the list itself. For example:
8264 .code
8265 hostlist    relay_from_hosts = 192.168.23.0/24 : my.friend.example
8266 addresslist bad_senders = cdb;/etc/badsenders
8267 .endd
8268 A named list may refer to other named lists:
8269 .code
8270 domainlist  dom1 = first.example : second.example
8271 domainlist  dom2 = +dom1 : third.example
8272 domainlist  dom3 = fourth.example : +dom2 : fifth.example
8273 .endd
8274 &*Warning*&: If the last item in a referenced list is a negative one, the
8275 effect may not be what you intended, because the negation does not propagate
8276 out to the higher level. For example, consider:
8277 .code
8278 domainlist  dom1 = !a.b
8279 domainlist  dom2 = +dom1 : *.b
8280 .endd
8281 The second list specifies &"either in the &%dom1%& list or &'*.b'&"&. The first
8282 list specifies just &"not &'a.b'&"&, so the domain &'x.y'& matches it. That
8283 means it matches the second list as well. The effect is not the same as
8284 .code
8285 domainlist  dom2 = !a.b : *.b
8286 .endd
8287 where &'x.y'& does not match. It's best to avoid negation altogether in
8288 referenced lists if you can.
8289
8290 Named lists may have a performance advantage. When Exim is routing an
8291 address or checking an incoming message, it caches the result of tests on named
8292 lists. So, if you have a setting such as
8293 .code
8294 domains = +local_domains
8295 .endd
8296 on several of your routers
8297 or in several ACL statements,
8298 the actual test is done only for the first one. However, the caching works only
8299 if there are no expansions within the list itself or any sublists that it
8300 references. In other words, caching happens only for lists that are known to be
8301 the same each time they are referenced.
8302
8303 By default, there may be up to 16 named lists of each type. This limit can be
8304 extended by changing a compile-time variable. The use of domain and host lists
8305 is recommended for concepts such as local domains, relay domains, and relay
8306 hosts. The default configuration is set up like this.
8307
8308
8309
8310 .section "Named lists compared with macros" "SECID78"
8311 .cindex "list" "named compared with macro"
8312 .cindex "macro" "compared with named list"
8313 At first sight, named lists might seem to be no different from macros in the
8314 configuration file. However, macros are just textual substitutions. If you
8315 write
8316 .code
8317 ALIST = host1 : host2
8318 auth_advertise_hosts = !ALIST
8319 .endd
8320 it probably won't do what you want, because that is exactly the same as
8321 .code
8322 auth_advertise_hosts = !host1 : host2
8323 .endd
8324 Notice that the second host name is not negated. However, if you use a host
8325 list, and write
8326 .code
8327 hostlist alist = host1 : host2
8328 auth_advertise_hosts = ! +alist
8329 .endd
8330 the negation applies to the whole list, and so that is equivalent to
8331 .code
8332 auth_advertise_hosts = !host1 : !host2
8333 .endd
8334
8335
8336 .section "Named list caching" "SECID79"
8337 .cindex "list" "caching of named"
8338 .cindex "caching" "named lists"
8339 While processing a message, Exim caches the result of checking a named list if
8340 it is sure that the list is the same each time. In practice, this means that
8341 the cache operates only if the list contains no $ characters, which guarantees
8342 that it will not change when it is expanded. Sometimes, however, you may have
8343 an expanded list that you know will be the same each time within a given
8344 message. For example:
8345 .code
8346 domainlist special_domains = \
8347            ${lookup{$sender_host_address}cdb{/some/file}}
8348 .endd
8349 This provides a list of domains that depends only on the sending host's IP
8350 address. If this domain list is referenced a number of times (for example,
8351 in several ACL lines, or in several routers) the result of the check is not
8352 cached by default, because Exim does not know that it is going to be the
8353 same list each time.
8354
8355 By appending &`_cache`& to &`domainlist`& you can tell Exim to go ahead and
8356 cache the result anyway. For example:
8357 .code
8358 domainlist_cache special_domains = ${lookup{...
8359 .endd
8360 If you do this, you should be absolutely sure that caching is going to do
8361 the right thing in all cases. When in doubt, leave it out.
8362
8363
8364
8365 .section "Domain lists" "SECTdomainlist"
8366 .cindex "domain list" "patterns for"
8367 .cindex "list" "domain list"
8368 Domain lists contain patterns that are to be matched against a mail domain.
8369 The following types of item may appear in domain lists:
8370
8371 .ilist
8372 .cindex "primary host name"
8373 .cindex "host name" "matched in domain list"
8374 .oindex "&%primary_hostname%&"
8375 .cindex "domain list" "matching primary host name"
8376 .cindex "@ in a domain list"
8377 If a pattern consists of a single @ character, it matches the local host name,
8378 as set by the &%primary_hostname%& option (or defaulted). This makes it
8379 possible to use the same configuration file on several different hosts that
8380 differ only in their names.
8381 .next
8382 .cindex "@[] in a domain list"
8383 .cindex "domain list" "matching local IP interfaces"
8384 .cindex "domain literal"
8385 If a pattern consists of the string &`@[]`& it matches an IP address enclosed
8386 in square brackets (as in an email address that contains a domain literal), but
8387 only if that IP address is recognized as local for email routing purposes. The
8388 &%local_interfaces%& and &%extra_local_interfaces%& options can be used to
8389 control which of a host's several IP addresses are treated as local.
8390 In today's Internet, the use of domain literals is controversial.
8391 .next
8392 .cindex "@mx_any"
8393 .cindex "@mx_primary"
8394 .cindex "@mx_secondary"
8395 .cindex "domain list" "matching MX pointers to local host"
8396 If a pattern consists of the string &`@mx_any`& it matches any domain that
8397 has an MX record pointing to the local host or to any host that is listed in
8398 .oindex "&%hosts_treat_as_local%&"
8399 &%hosts_treat_as_local%&. The items &`@mx_primary`& and &`@mx_secondary`&
8400 are similar, except that the first matches only when a primary MX target is the
8401 local host, and the second only when no primary MX target is the local host,
8402 but a secondary MX target is. &"Primary"& means an MX record with the lowest
8403 preference value &-- there may of course be more than one of them.
8404
8405 The MX lookup that takes place when matching a pattern of this type is
8406 performed with the resolver options for widening names turned off. Thus, for
8407 example, a single-component domain will &'not'& be expanded by adding the
8408 resolver's default domain. See the &%qualify_single%& and &%search_parents%&
8409 options of the &(dnslookup)& router for a discussion of domain widening.
8410
8411 Sometimes you may want to ignore certain IP addresses when using one of these
8412 patterns. You can specify this by following the pattern with &`/ignore=`&<&'ip
8413 list'&>, where <&'ip list'&> is a list of IP addresses. These addresses are
8414 ignored when processing the pattern (compare the &%ignore_target_hosts%& option
8415 on a router). For example:
8416 .code
8417 domains = @mx_any/ignore=127.0.0.1
8418 .endd
8419 This example matches any domain that has an MX record pointing to one of
8420 the local host's IP addresses other than 127.0.0.1.
8421
8422 The list of IP addresses is in fact processed by the same code that processes
8423 host lists, so it may contain CIDR-coded network specifications and it may also
8424 contain negative items.
8425
8426 Because the list of IP addresses is a sublist within a domain list, you have to
8427 be careful about delimiters if there is more than one address. Like any other
8428 list, the default delimiter can be changed. Thus, you might have:
8429 .code
8430 domains = @mx_any/ignore=<;127.0.0.1;0.0.0.0 : \
8431           an.other.domain : ...
8432 .endd
8433 so that the sublist uses semicolons for delimiters. When IPv6 addresses are
8434 involved, it is easiest to change the delimiter for the main list as well:
8435 .code
8436 domains = <? @mx_any/ignore=<;127.0.0.1;::1 ? \
8437           an.other.domain ? ...
8438 .endd
8439 .next
8440 .cindex "asterisk" "in domain list"
8441 .cindex "domain list" "asterisk in"
8442 .cindex "domain list" "matching &""ends with""&"
8443 If a pattern starts with an asterisk, the remaining characters of the pattern
8444 are compared with the terminating characters of the domain. The use of &"*"& in
8445 domain lists differs from its use in partial matching lookups. In a domain
8446 list, the character following the asterisk need not be a dot, whereas partial
8447 matching works only in terms of dot-separated components. For example, a domain
8448 list item such as &`*key.ex`& matches &'donkey.ex'& as well as
8449 &'cipher.key.ex'&.
8450
8451 .next
8452 .cindex "regular expressions" "in domain list"
8453 .cindex "domain list" "matching regular expression"
8454 If a pattern starts with a circumflex character, it is treated as a regular
8455 expression, and matched against the domain using a regular expression matching
8456 function. The circumflex is treated as part of the regular expression.
8457 Email domains are case-independent, so this regular expression match is by
8458 default case-independent, but you can make it case-dependent by starting it
8459 with &`(?-i)`&. References to descriptions of the syntax of regular expressions
8460 are given in chapter &<<CHAPregexp>>&.
8461
8462 &*Warning*&: Because domain lists are expanded before being processed, you
8463 must escape any backslash and dollar characters in the regular expression, or
8464 use the special &`\N`& sequence (see chapter &<<CHAPexpand>>&) to specify that
8465 it is not to be expanded (unless you really do want to build a regular
8466 expression by expansion, of course).
8467 .next
8468 .cindex "lookup" "in domain list"
8469 .cindex "domain list" "matching by lookup"
8470 If a pattern starts with the name of a single-key lookup type followed by a
8471 semicolon (for example, &"dbm;"& or &"lsearch;"&), the remainder of the pattern
8472 must be a filename in a suitable format for the lookup type. For example, for
8473 &"cdb;"& it must be an absolute path:
8474 .code
8475 domains = cdb;/etc/mail/local_domains.cdb
8476 .endd
8477 The appropriate type of lookup is done on the file using the domain name as the
8478 key. In most cases, the data that is looked up is not used; Exim is interested
8479 only in whether or not the key is present in the file. However, when a lookup
8480 is used for the &%domains%& option on a router
8481 or a &%domains%& condition in an ACL statement, the data is preserved in the
8482 &$domain_data$& variable and can be referred to in other router options or
8483 other statements in the same ACL.
8484
8485 .next
8486 Any of the single-key lookup type names may be preceded by
8487 &`partial`&<&'n'&>&`-`&, where the <&'n'&> is optional, for example,
8488 .code
8489 domains = partial-dbm;/partial/domains
8490 .endd
8491 This causes partial matching logic to be invoked; a description of how this
8492 works is given in section &<<SECTpartiallookup>>&.
8493
8494 .next
8495 .cindex "asterisk" "in lookup type"
8496 Any of the single-key lookup types may be followed by an asterisk. This causes
8497 a default lookup for a key consisting of a single asterisk to be done if the
8498 original lookup fails. This is not a useful feature when using a domain list to
8499 select particular domains (because any domain would match), but it might have
8500 value if the result of the lookup is being used via the &$domain_data$&
8501 expansion variable.
8502 .next
8503 If the pattern starts with the name of a query-style lookup type followed by a
8504 semicolon (for example, &"nisplus;"& or &"ldap;"&), the remainder of the
8505 pattern must be an appropriate query for the lookup type, as described in
8506 chapter &<<CHAPfdlookup>>&. For example:
8507 .code
8508 hold_domains = mysql;select domain from holdlist \
8509   where domain = '${quote_mysql:$domain}';
8510 .endd
8511 In most cases, the data that is looked up is not used (so for an SQL query, for
8512 example, it doesn't matter what field you select). Exim is interested only in
8513 whether or not the query succeeds. However, when a lookup is used for the
8514 &%domains%& option on a router, the data is preserved in the &$domain_data$&
8515 variable and can be referred to in other options.
8516 .next
8517 .cindex "domain list" "matching literal domain name"
8518 If none of the above cases apply, a caseless textual comparison is made
8519 between the pattern and the domain.
8520 .endlist
8521
8522 Here is an example that uses several different kinds of pattern:
8523 .code
8524 domainlist funny_domains = \
8525   @ : \
8526   lib.unseen.edu : \
8527   *.foundation.fict.example : \
8528   \N^[1-2]\d{3}\.fict\.example$\N : \
8529   partial-dbm;/opt/data/penguin/book : \
8530   nis;domains.byname : \
8531   nisplus;[name=$domain,status=local],domains.org_dir
8532 .endd
8533 There are obvious processing trade-offs among the various matching modes. Using
8534 an asterisk is faster than a regular expression, and listing a few names
8535 explicitly probably is too. The use of a file or database lookup is expensive,
8536 but may be the only option if hundreds of names are required. Because the
8537 patterns are tested in order, it makes sense to put the most commonly matched
8538 patterns earlier.
8539
8540
8541
8542 .section "Host lists" "SECThostlist"
8543 .cindex "host list" "patterns in"
8544 .cindex "list" "host list"
8545 Host lists are used to control what remote hosts are allowed to do. For
8546 example, some hosts may be allowed to use the local host as a relay, and some
8547 may be permitted to use the SMTP ETRN command. Hosts can be identified in
8548 two different ways, by name or by IP address. In a host list, some types of
8549 pattern are matched to a host name, and some are matched to an IP address.
8550 You need to be particularly careful with this when single-key lookups are
8551 involved, to ensure that the right value is being used as the key.
8552
8553
8554 .section "Special host list patterns" "SECID80"
8555 .cindex "empty item in hosts list"
8556 .cindex "host list" "empty string in"
8557 If a host list item is the empty string, it matches only when no remote host is
8558 involved. This is the case when a message is being received from a local
8559 process using SMTP on the standard input, that is, when a TCP/IP connection is
8560 not used.
8561
8562 .cindex "asterisk" "in host list"
8563 The special pattern &"*"& in a host list matches any host or no host. Neither
8564 the IP address nor the name is actually inspected.
8565
8566
8567
8568 .section "Host list patterns that match by IP address" "SECThoslispatip"
8569 .cindex "host list" "matching IP addresses"
8570 If an IPv4 host calls an IPv6 host and the call is accepted on an IPv6 socket,
8571 the incoming address actually appears in the IPv6 host as
8572 &`::ffff:`&<&'v4address'&>. When such an address is tested against a host
8573 list, it is converted into a traditional IPv4 address first. (Not all operating
8574 systems accept IPv4 calls on IPv6 sockets, as there have been some security
8575 concerns.)
8576
8577 The following types of pattern in a host list check the remote host by
8578 inspecting its IP address:
8579
8580 .ilist
8581 If the pattern is a plain domain name (not a regular expression, not starting
8582 with *, not a lookup of any kind), Exim calls the operating system function
8583 to find the associated IP address(es). Exim uses the newer
8584 &[getipnodebyname()]& function when available, otherwise &[gethostbyname()]&.
8585 This typically causes a forward DNS lookup of the name. The result is compared
8586 with the IP address of the subject host.
8587
8588 If there is a temporary problem (such as a DNS timeout) with the host name
8589 lookup, a temporary error occurs. For example, if the list is being used in an
8590 ACL condition, the ACL gives a &"defer"& response, usually leading to a
8591 temporary SMTP error code. If no IP address can be found for the host name,
8592 what happens is described in section &<<SECTbehipnot>>& below.
8593
8594 .next
8595 .cindex "@ in a host list"
8596 If the pattern is &"@"&, the primary host name is substituted and used as a
8597 domain name, as just described.
8598
8599 .next
8600 If the pattern is an IP address, it is matched against the IP address of the
8601 subject host. IPv4 addresses are given in the normal &"dotted-quad"& notation.
8602 IPv6 addresses can be given in colon-separated format, but the colons have to
8603 be doubled so as not to be taken as item separators when the default list
8604 separator is used. IPv6 addresses are recognized even when Exim is compiled
8605 without IPv6 support. This means that if they appear in a host list on an
8606 IPv4-only host, Exim will not treat them as host names. They are just addresses
8607 that can never match a client host.
8608
8609 .next
8610 .cindex "@[] in a host list"
8611 If the pattern is &"@[]"&, it matches the IP address of any IP interface on
8612 the local host. For example, if the local host is an IPv4 host with one
8613 interface address 10.45.23.56, these two ACL statements have the same effect:
8614 .code
8615 accept hosts = 127.0.0.1 : 10.45.23.56
8616 accept hosts = @[]
8617 .endd
8618 .next
8619 .cindex "CIDR notation"
8620 If the pattern is an IP address followed by a slash and a mask length (for
8621 example 10.11.42.0/24), it is matched against the IP address of the subject
8622 host under the given mask. This allows, an entire network of hosts to be
8623 included (or excluded) by a single item. The mask uses CIDR notation; it
8624 specifies the number of address bits that must match, starting from the most
8625 significant end of the address.
8626
8627 &*Note*&: The mask is &'not'& a count of addresses, nor is it the high number
8628 of a range of addresses. It is the number of bits in the network portion of the
8629 address. The above example specifies a 24-bit netmask, so it matches all 256
8630 addresses in the 10.11.42.0 network. An item such as
8631 .code
8632 192.168.23.236/31
8633 .endd
8634 matches just two addresses, 192.168.23.236 and 192.168.23.237. A mask value of
8635 32 for an IPv4 address is the same as no mask at all; just a single address
8636 matches.
8637
8638 Here is another example which shows an IPv4 and an IPv6 network:
8639 .code
8640 recipient_unqualified_hosts = 192.168.0.0/16: \
8641                               3ffe::ffff::836f::::/48
8642 .endd
8643 The doubling of list separator characters applies only when these items
8644 appear inline in a host list. It is not required when indirecting via a file.
8645 For example:
8646 .code
8647 recipient_unqualified_hosts = /opt/exim/unqualnets
8648 .endd
8649 could make use of a file containing
8650 .code
8651 172.16.0.0/12
8652 3ffe:ffff:836f::/48
8653 .endd
8654 to have exactly the same effect as the previous example. When listing IPv6
8655 addresses inline, it is usually more convenient to use the facility for
8656 changing separator characters. This list contains the same two networks:
8657 .code
8658 recipient_unqualified_hosts = <; 172.16.0.0/12; \
8659                                  3ffe:ffff:836f::/48
8660 .endd
8661 The separator is changed to semicolon by the leading &"<;"& at the start of the
8662 list.
8663 .endlist
8664
8665
8666
8667 .section "Host list patterns for single-key lookups by host address" &&&
8668          "SECThoslispatsikey"
8669 .cindex "host list" "lookup of IP address"
8670 When a host is to be identified by a single-key lookup of its complete IP
8671 address, the pattern takes this form:
8672 .display
8673 &`net-<`&&'single-key-search-type'&&`>;<`&&'search-data'&&`>`&
8674 .endd
8675 For example:
8676 .code
8677 hosts_lookup = net-cdb;/hosts-by-ip.db
8678 .endd
8679 The text form of the IP address of the subject host is used as the lookup key.
8680 IPv6 addresses are converted to an unabbreviated form, using lower case
8681 letters, with dots as separators because colon is the key terminator in
8682 &(lsearch)& files. [Colons can in fact be used in keys in &(lsearch)& files by
8683 quoting the keys, but this is a facility that was added later.] The data
8684 returned by the lookup is not used.
8685
8686 .cindex "IP address" "masking"
8687 .cindex "host list" "masked IP address"
8688 Single-key lookups can also be performed using masked IP addresses, using
8689 patterns of this form:
8690 .display
8691 &`net<`&&'number'&&`>-<`&&'single-key-search-type'&&`>;<`&&'search-data'&&`>`&
8692 .endd
8693 For example:
8694 .code
8695 net24-dbm;/networks.db
8696 .endd
8697 The IP address of the subject host is masked using <&'number'&> as the mask
8698 length. A textual string is constructed from the masked value, followed by the
8699 mask, and this is used as the lookup key. For example, if the host's IP address
8700 is 192.168.34.6, the key that is looked up for the above example is
8701 &"192.168.34.0/24"&.
8702
8703 When an IPv6 address is converted to a string, dots are normally used instead
8704 of colons, so that keys in &(lsearch)& files need not contain colons (which
8705 terminate &(lsearch)& keys). This was implemented some time before the ability
8706 to quote keys was made available in &(lsearch)& files. However, the more
8707 recently implemented &(iplsearch)& files do require colons in IPv6 keys
8708 (notated using the quoting facility) so as to distinguish them from IPv4 keys.
8709 For this reason, when the lookup type is &(iplsearch)&, IPv6 addresses are
8710 converted using colons and not dots.
8711 .new
8712 In all cases except IPv4-mapped IPv6, full, unabbreviated IPv6
8713 addresses are always used.
8714 The latter are converted to IPv4 addresses, in dotted-quad form.
8715 .wen
8716
8717 Ideally, it would be nice to tidy up this anomalous situation by changing to
8718 colons in all cases, given that quoting is now available for &(lsearch)&.
8719 However, this would be an incompatible change that might break some existing
8720 configurations.
8721
8722 &*Warning*&: Specifying &%net32-%& (for an IPv4 address) or &%net128-%& (for an
8723 IPv6 address) is not the same as specifying just &%net-%& without a number. In
8724 the former case the key strings include the mask value, whereas in the latter
8725 case the IP address is used on its own.
8726
8727
8728
8729 .section "Host list patterns that match by host name" "SECThoslispatnam"
8730 .cindex "host" "lookup failures"
8731 .cindex "unknown host name"
8732 .cindex "host list" "matching host name"
8733 There are several types of pattern that require Exim to know the name of the
8734 remote host. These are either wildcard patterns or lookups by name. (If a
8735 complete hostname is given without any wildcarding, it is used to find an IP
8736 address to match against, as described in section &<<SECThoslispatip>>&
8737 above.)
8738
8739 If the remote host name is not already known when Exim encounters one of these
8740 patterns, it has to be found from the IP address.
8741 Although many sites on the Internet are conscientious about maintaining reverse
8742 DNS data for their hosts, there are also many that do not do this.
8743 Consequently, a name cannot always be found, and this may lead to unwanted
8744 effects. Take care when configuring host lists with wildcarded name patterns.
8745 Consider what will happen if a name cannot be found.
8746
8747 Because of the problems of determining host names from IP addresses, matching
8748 against host names is not as common as matching against IP addresses.
8749
8750 By default, in order to find a host name, Exim first does a reverse DNS lookup;
8751 if no name is found in the DNS, the system function (&[gethostbyaddr()]& or
8752 &[getipnodebyaddr()]& if available) is tried. The order in which these lookups
8753 are done can be changed by setting the &%host_lookup_order%& option. For
8754 security, once Exim has found one or more names, it looks up the IP addresses
8755 for these names and compares them with the IP address that it started with.
8756 Only those names whose IP addresses match are accepted. Any other names are
8757 discarded. If no names are left, Exim behaves as if the host name cannot be
8758 found. In the most common case there is only one name and one IP address.
8759
8760 There are some options that control what happens if a host name cannot be
8761 found. These are described in section &<<SECTbehipnot>>& below.
8762
8763 .cindex "host" "alias for"
8764 .cindex "alias for host"
8765 As a result of aliasing, hosts may have more than one name. When processing any
8766 of the following types of pattern, all the host's names are checked:
8767
8768 .ilist
8769 .cindex "asterisk" "in host list"
8770 If a pattern starts with &"*"& the remainder of the item must match the end of
8771 the host name. For example, &`*.b.c`& matches all hosts whose names end in
8772 &'.b.c'&. This special simple form is provided because this is a very common
8773 requirement. Other kinds of wildcarding require the use of a regular
8774 expression.
8775 .next
8776 .cindex "regular expressions" "in host list"
8777 .cindex "host list" "regular expression in"
8778 If the item starts with &"^"& it is taken to be a regular expression which is
8779 matched against the host name. Host names are case-independent, so this regular
8780 expression match is by default case-independent, but you can make it
8781 case-dependent by starting it with &`(?-i)`&. References to descriptions of the
8782 syntax of regular expressions are given in chapter &<<CHAPregexp>>&. For
8783 example,
8784 .code
8785 ^(a|b)\.c\.d$
8786 .endd
8787 is a regular expression that matches either of the two hosts &'a.c.d'& or
8788 &'b.c.d'&. When a regular expression is used in a host list, you must take care
8789 that backslash and dollar characters are not misinterpreted as part of the
8790 string expansion. The simplest way to do this is to use &`\N`& to mark that
8791 part of the string as non-expandable. For example:
8792 .code
8793 sender_unqualified_hosts = \N^(a|b)\.c\.d$\N : ....
8794 .endd
8795 &*Warning*&: If you want to match a complete host name, you must include the
8796 &`$`& terminating metacharacter in the regular expression, as in the above
8797 example. Without it, a match at the start of the host name is all that is
8798 required.
8799 .endlist
8800
8801
8802
8803
8804 .section "Behaviour when an IP address or name cannot be found" "SECTbehipnot"
8805 .cindex "host" "lookup failures, permanent"
8806 While processing a host list, Exim may need to look up an IP address from a
8807 name (see section &<<SECThoslispatip>>&), or it may need to look up a host name
8808 from an IP address (see section &<<SECThoslispatnam>>&). In either case, the
8809 behaviour when it fails to find the information it is seeking is the same.
8810
8811 &*Note*&: This section applies to permanent lookup failures. It does &'not'&
8812 apply to temporary DNS errors, whose handling is described in the next section.
8813
8814 .cindex "&`+include_unknown`&"
8815 .cindex "&`+ignore_unknown`&"
8816 Exim parses a host list from left to right. If it encounters a permanent
8817 lookup failure in any item in the host list before it has found a match,
8818 Exim treats it as a failure and the default behavior is as if the host
8819 does not match the list. This may not always be what you want to happen.
8820 To change Exim's behaviour, the special items &`+include_unknown`& or
8821 &`+ignore_unknown`& may appear in the list (at top level &-- they are
8822 not recognized in an indirected file).
8823
8824 .ilist
8825 If any item that follows &`+include_unknown`& requires information that
8826 cannot found, Exim behaves as if the host does match the list. For example,
8827 .code
8828 host_reject_connection = +include_unknown:*.enemy.ex
8829 .endd
8830 rejects connections from any host whose name matches &`*.enemy.ex`&, and also
8831 any hosts whose name it cannot find.
8832
8833 .next
8834 If any item that follows &`+ignore_unknown`& requires information that cannot
8835 be found, Exim ignores that item and proceeds to the rest of the list. For
8836 example:
8837 .code
8838 accept hosts = +ignore_unknown : friend.example : \
8839                192.168.4.5
8840 .endd
8841 accepts from any host whose name is &'friend.example'& and from 192.168.4.5,
8842 whether or not its host name can be found. Without &`+ignore_unknown`&, if no
8843 name can be found for 192.168.4.5, it is rejected.
8844 .endlist
8845
8846 Both &`+include_unknown`& and &`+ignore_unknown`& may appear in the same
8847 list. The effect of each one lasts until the next, or until the end of the
8848 list.
8849
8850 .section "Mixing wildcarded host names and addresses in host lists" &&&
8851          "SECTmixwilhos"
8852 .cindex "host list" "mixing names and addresses in"
8853
8854 This section explains the host/ip processing logic with the same concepts
8855 as the previous section, but specifically addresses what happens when a
8856 wildcarded hostname is one of the items in the hostlist.
8857
8858 .ilist
8859 If you have name lookups or wildcarded host names and
8860 IP addresses in the same host list, you should normally put the IP
8861 addresses first. For example, in an ACL you could have:
8862 .code
8863 accept hosts = 10.9.8.7 : *.friend.example
8864 .endd
8865 The reason you normally would order it this way lies in the
8866 left-to-right way that Exim processes lists.  It can test IP addresses
8867 without doing any DNS lookups, but when it reaches an item that requires
8868 a host name, it fails if it cannot find a host name to compare with the
8869 pattern. If the above list is given in the opposite order, the
8870 &%accept%& statement fails for a host whose name cannot be found, even
8871 if its IP address is 10.9.8.7.
8872
8873 .next
8874 If you really do want to do the name check first, and still recognize the IP
8875 address, you can rewrite the ACL like this:
8876 .code
8877 accept hosts = *.friend.example
8878 accept hosts = 10.9.8.7
8879 .endd
8880 If the first &%accept%& fails, Exim goes on to try the second one. See chapter
8881 &<<CHAPACL>>& for details of ACLs. Alternatively, you can use
8882 &`+ignore_unknown`&, which was discussed in depth in the first example in
8883 this section.
8884 .endlist
8885
8886
8887 .section "Temporary DNS errors when looking up host information" &&&
8888          "SECTtemdnserr"
8889 .cindex "host" "lookup failures, temporary"
8890 .cindex "&`+include_defer`&"
8891 .cindex "&`+ignore_defer`&"
8892 A temporary DNS lookup failure normally causes a defer action (except when
8893 &%dns_again_means_nonexist%& converts it into a permanent error). However,
8894 host lists can include &`+ignore_defer`& and &`+include_defer`&, analogous to
8895 &`+ignore_unknown`& and &`+include_unknown`&, as described in the previous
8896 section. These options should be used with care, probably only in non-critical
8897 host lists such as whitelists.
8898
8899
8900
8901 .section "Host list patterns for single-key lookups by host name" &&&
8902          "SECThoslispatnamsk"
8903 .cindex "unknown host name"
8904 .cindex "host list" "matching host name"
8905 If a pattern is of the form
8906 .display
8907 <&'single-key-search-type'&>;<&'search-data'&>
8908 .endd
8909 for example
8910 .code
8911 dbm;/host/accept/list
8912 .endd
8913 a single-key lookup is performed, using the host name as its key. If the
8914 lookup succeeds, the host matches the item. The actual data that is looked up
8915 is not used.
8916
8917 &*Reminder*&: With this kind of pattern, you must have host &'names'& as
8918 keys in the file, not IP addresses. If you want to do lookups based on IP
8919 addresses, you must precede the search type with &"net-"& (see section
8920 &<<SECThoslispatsikey>>&). There is, however, no reason why you could not use
8921 two items in the same list, one doing an address lookup and one doing a name
8922 lookup, both using the same file.
8923
8924
8925
8926 .section "Host list patterns for query-style lookups" "SECID81"
8927 If a pattern is of the form
8928 .display
8929 <&'query-style-search-type'&>;<&'query'&>
8930 .endd
8931 the query is obeyed, and if it succeeds, the host matches the item. The actual
8932 data that is looked up is not used. The variables &$sender_host_address$& and
8933 &$sender_host_name$& can be used in the query. For example:
8934 .code
8935 hosts_lookup = pgsql;\
8936   select ip from hostlist where ip='$sender_host_address'
8937 .endd
8938 The value of &$sender_host_address$& for an IPv6 address contains colons. You
8939 can use the &%sg%& expansion item to change this if you need to. If you want to
8940 use masked IP addresses in database queries, you can use the &%mask%& expansion
8941 operator.
8942
8943 If the query contains a reference to &$sender_host_name$&, Exim automatically
8944 looks up the host name if it has not already done so. (See section
8945 &<<SECThoslispatnam>>& for comments on finding host names.)
8946
8947 Historical note: prior to release 4.30, Exim would always attempt to find a
8948 host name before running the query, unless the search type was preceded by
8949 &`net-`&. This is no longer the case. For backwards compatibility, &`net-`& is
8950 still recognized for query-style lookups, but its presence or absence has no
8951 effect. (Of course, for single-key lookups, &`net-`& &'is'& important.
8952 See section &<<SECThoslispatsikey>>&.)
8953
8954
8955
8956
8957
8958 .section "Address lists" "SECTaddresslist"
8959 .cindex "list" "address list"
8960 .cindex "address list" "empty item"
8961 .cindex "address list" "patterns"
8962 Address lists contain patterns that are matched against mail addresses. There
8963 is one special case to be considered: the sender address of a bounce message is
8964 always empty. You can test for this by providing an empty item in an address
8965 list. For example, you can set up a router to process bounce messages by
8966 using this option setting:
8967 .code
8968 senders = :
8969 .endd
8970 The presence of the colon creates an empty item. If you do not provide any
8971 data, the list is empty and matches nothing. The empty sender can also be
8972 detected by a regular expression that matches an empty string,
8973 and by a query-style lookup that succeeds when &$sender_address$& is empty.
8974
8975 Non-empty items in an address list can be straightforward email addresses. For
8976 example:
8977 .code
8978 senders = jbc@askone.example : hs@anacreon.example
8979 .endd
8980 A certain amount of wildcarding is permitted. If a pattern contains an @
8981 character, but is not a regular expression and does not begin with a
8982 semicolon-terminated lookup type (described below), the local part of the
8983 subject address is compared with the local part of the pattern, which may start
8984 with an asterisk. If the local parts match, the domain is checked in exactly
8985 the same way as for a pattern in a domain list. For example, the domain can be
8986 wildcarded, refer to a named list, or be a lookup:
8987 .code
8988 deny senders = *@*.spamming.site:\
8989                *@+hostile_domains:\
8990                bozo@partial-lsearch;/list/of/dodgy/sites:\
8991                *@dbm;/bad/domains.db
8992 .endd
8993 .cindex "local part" "starting with !"
8994 .cindex "address list" "local part starting with !"
8995 If a local part that begins with an exclamation mark is required, it has to be
8996 specified using a regular expression, because otherwise the exclamation mark is
8997 treated as a sign of negation, as is standard in lists.
8998
8999 If a non-empty pattern that is not a regular expression or a lookup does not
9000 contain an @ character, it is matched against the domain part of the subject
9001 address. The only two formats that are recognized this way are a literal
9002 domain, or a domain pattern that starts with *. In both these cases, the effect
9003 is the same as if &`*@`& preceded the pattern. For example:
9004 .code
9005 deny senders = enemy.domain : *.enemy.domain
9006 .endd
9007
9008 The following kinds of more complicated address list pattern can match any
9009 address, including the empty address that is characteristic of bounce message
9010 senders:
9011
9012 .ilist
9013 .cindex "regular expressions" "in address list"
9014 .cindex "address list" "regular expression in"
9015 If (after expansion) a pattern starts with &"^"&, a regular expression match is
9016 done against the complete address, with the pattern as the regular expression.
9017 You must take care that backslash and dollar characters are not misinterpreted
9018 as part of the string expansion. The simplest way to do this is to use &`\N`&
9019 to mark that part of the string as non-expandable. For example:
9020 .code
9021 deny senders = \N^.*this.*@example\.com$\N : \
9022                \N^\d{8}.+@spamhaus.example$\N : ...
9023 .endd
9024 The &`\N`& sequences are removed by the expansion, so these items do indeed
9025 start with &"^"& by the time they are being interpreted as address patterns.
9026
9027 .next
9028 .cindex "address list" "lookup for complete address"
9029 Complete addresses can be looked up by using a pattern that starts with a
9030 lookup type terminated by a semicolon, followed by the data for the lookup. For
9031 example:
9032 .code
9033 deny senders = cdb;/etc/blocked.senders : \
9034   mysql;select address from blocked where \
9035   address='${quote_mysql:$sender_address}'
9036 .endd
9037 Both query-style and single-key lookup types can be used. For a single-key
9038 lookup type, Exim uses the complete address as the key. However, empty keys are
9039 not supported for single-key lookups, so a match against the empty address
9040 always fails. This restriction does not apply to query-style lookups.
9041
9042 Partial matching for single-key lookups (section &<<SECTpartiallookup>>&)
9043 cannot be used, and is ignored if specified, with an entry being written to the
9044 panic log.
9045 .cindex "*@ with single-key lookup"
9046 However, you can configure lookup defaults, as described in section
9047 &<<SECTdefaultvaluelookups>>&, but this is useful only for the &"*@"& type of
9048 default. For example, with this lookup:
9049 .code
9050 accept senders = lsearch*@;/some/file
9051 .endd
9052 the file could contains lines like this:
9053 .code
9054 user1@domain1.example
9055 *@domain2.example
9056 .endd
9057 and for the sender address &'nimrod@jaeger.example'&, the sequence of keys
9058 that are tried is:
9059 .code
9060 nimrod@jaeger.example
9061 *@jaeger.example
9062 *
9063 .endd
9064 &*Warning 1*&: Do not include a line keyed by &"*"& in the file, because that
9065 would mean that every address matches, thus rendering the test useless.
9066
9067 &*Warning 2*&: Do not confuse these two kinds of item:
9068 .code
9069 deny recipients = dbm*@;/some/file
9070 deny recipients = *@dbm;/some/file
9071 .endd
9072 The first does a whole address lookup, with defaulting, as just described,
9073 because it starts with a lookup type. The second matches the local part and
9074 domain independently, as described in a bullet point below.
9075 .endlist
9076
9077
9078 The following kinds of address list pattern can match only non-empty addresses.
9079 If the subject address is empty, a match against any of these pattern types
9080 always fails.
9081
9082
9083 .ilist
9084 .cindex "@@ with single-key lookup"
9085 .cindex "address list" "@@ lookup type"
9086 .cindex "address list" "split local part and domain"
9087 If a pattern starts with &"@@"& followed by a single-key lookup item
9088 (for example, &`@@lsearch;/some/file`&), the address that is being checked is
9089 split into a local part and a domain. The domain is looked up in the file. If
9090 it is not found, there is no match. If it is found, the data that is looked up
9091 from the file is treated as a colon-separated list of local part patterns, each
9092 of which is matched against the subject local part in turn.
9093
9094 .cindex "asterisk" "in address list"
9095 The lookup may be a partial one, and/or one involving a search for a default
9096 keyed by &"*"& (see section &<<SECTdefaultvaluelookups>>&). The local part
9097 patterns that are looked up can be regular expressions or begin with &"*"&, or
9098 even be further lookups. They may also be independently negated. For example,
9099 with
9100 .code
9101 deny senders = @@dbm;/etc/reject-by-domain
9102 .endd
9103 the data from which the DBM file is built could contain lines like
9104 .code
9105 baddomain.com:  !postmaster : *
9106 .endd
9107 to reject all senders except &%postmaster%& from that domain.
9108
9109 .cindex "local part" "starting with !"
9110 If a local part that actually begins with an exclamation mark is required, it
9111 has to be specified using a regular expression. In &(lsearch)& files, an entry
9112 may be split over several lines by indenting the second and subsequent lines,
9113 but the separating colon must still be included at line breaks. White space
9114 surrounding the colons is ignored. For example:
9115 .code
9116 aol.com:  spammer1 : spammer2 : ^[0-9]+$ :
9117   spammer3 : spammer4
9118 .endd
9119 As in all colon-separated lists in Exim, a colon can be included in an item by
9120 doubling.
9121
9122 If the last item in the list starts with a right angle-bracket, the remainder
9123 of the item is taken as a new key to look up in order to obtain a continuation
9124 list of local parts. The new key can be any sequence of characters. Thus one
9125 might have entries like
9126 .code
9127 aol.com: spammer1 : spammer 2 : >*
9128 xyz.com: spammer3 : >*
9129 *:       ^\d{8}$
9130 .endd
9131 in a file that was searched with &%@@dbm*%&, to specify a match for 8-digit
9132 local parts for all domains, in addition to the specific local parts listed for
9133 each domain. Of course, using this feature costs another lookup each time a
9134 chain is followed, but the effort needed to maintain the data is reduced.
9135
9136 .cindex "loop" "in lookups"
9137 It is possible to construct loops using this facility, and in order to catch
9138 them, the chains may be no more than fifty items long.
9139
9140 .next
9141 The @@<&'lookup'&> style of item can also be used with a query-style
9142 lookup, but in this case, the chaining facility is not available. The lookup
9143 can only return a single list of local parts.
9144 .endlist
9145
9146 &*Warning*&: There is an important difference between the address list items
9147 in these two examples:
9148 .code
9149 senders = +my_list
9150 senders = *@+my_list
9151 .endd
9152 In the first one, &`my_list`& is a named address list, whereas in the second
9153 example it is a named domain list.
9154
9155
9156
9157
9158 .section "Case of letters in address lists" "SECTcasletadd"
9159 .cindex "case of local parts"
9160 .cindex "address list" "case forcing"
9161 .cindex "case forcing in address lists"
9162 Domains in email addresses are always handled caselessly, but for local parts
9163 case may be significant on some systems (see &%caseful_local_part%& for how
9164 Exim deals with this when routing addresses). However, RFC 2505 (&'Anti-Spam
9165 Recommendations for SMTP MTAs'&) suggests that matching of addresses to
9166 blocking lists should be done in a case-independent manner. Since most address
9167 lists in Exim are used for this kind of control, Exim attempts to do this by
9168 default.
9169
9170 The domain portion of an address is always lowercased before matching it to an
9171 address list. The local part is lowercased by default, and any string
9172 comparisons that take place are done caselessly. This means that the data in
9173 the address list itself, in files included as plain filenames, and in any file
9174 that is looked up using the &"@@"& mechanism, can be in any case. However, the
9175 keys in files that are looked up by a search type other than &(lsearch)& (which
9176 works caselessly) must be in lower case, because these lookups are not
9177 case-independent.
9178
9179 .cindex "&`+caseful`&"
9180 To allow for the possibility of caseful address list matching, if an item in
9181 an address list is the string &"+caseful"&, the original case of the local
9182 part is restored for any comparisons that follow, and string comparisons are no
9183 longer case-independent. This does not affect the domain, which remains in
9184 lower case. However, although independent matches on the domain alone are still
9185 performed caselessly, regular expressions that match against an entire address
9186 become case-sensitive after &"+caseful"& has been seen.
9187
9188
9189
9190 .section "Local part lists" "SECTlocparlis"
9191 .cindex "list" "local part list"
9192 .cindex "local part" "list"
9193 Case-sensitivity in local part lists is handled in the same way as for address
9194 lists, as just described. The &"+caseful"& item can be used if required. In a
9195 setting of the &%local_parts%& option in a router with &%caseful_local_part%&
9196 set false, the subject is lowercased and the matching is initially
9197 case-insensitive. In this case, &"+caseful"& will restore case-sensitive
9198 matching in the local part list, but not elsewhere in the router. If
9199 &%caseful_local_part%& is set true in a router, matching in the &%local_parts%&
9200 option is case-sensitive from the start.
9201
9202 If a local part list is indirected to a file (see section &<<SECTfilnamlis>>&),
9203 comments are handled in the same way as address lists &-- they are recognized
9204 only if the # is preceded by white space or the start of the line.
9205 Otherwise, local part lists are matched in the same way as domain lists, except
9206 that the special items that refer to the local host (&`@`&, &`@[]`&,
9207 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`&) are not recognized.
9208 Refer to section &<<SECTdomainlist>>& for details of the other available item
9209 types.
9210 .ecindex IIDdohoadli
9211
9212
9213
9214
9215 . ////////////////////////////////////////////////////////////////////////////
9216 . ////////////////////////////////////////////////////////////////////////////
9217
9218 .chapter "String expansions" "CHAPexpand"
9219 .scindex IIDstrexp "expansion" "of strings"
9220 Many strings in Exim's runtime configuration are expanded before use. Some of
9221 them are expanded every time they are used; others are expanded only once.
9222
9223 When a string is being expanded it is copied verbatim from left to right except
9224 .cindex expansion "string concatenation"
9225 when a dollar or backslash character is encountered. A dollar specifies the
9226 start of a portion of the string that is interpreted and replaced as described
9227 below in section &<<SECTexpansionitems>>& onwards. Backslash is used as an
9228 escape character, as described in the following section.
9229
9230 Whether a string is expanded depends upon the context.  Usually this is solely
9231 dependent upon the option for which a value is sought; in this documentation,
9232 options for which string expansion is performed are marked with &dagger; after
9233 the data type.  ACL rules always expand strings.  A couple of expansion
9234 conditions do not expand some of the brace-delimited branches, for security
9235 reasons,
9236 .new
9237 .cindex "tainted data" expansion
9238 .cindex expansion "tainted data"
9239 and expansion of data deriving from the sender (&"tainted data"&)
9240 is not permitted.
9241 .wen
9242
9243
9244
9245 .section "Literal text in expanded strings" "SECTlittext"
9246 .cindex "expansion" "including literal text"
9247 An uninterpreted dollar can be included in an expanded string by putting a
9248 backslash in front of it. A backslash can be used to prevent any special
9249 character being treated specially in an expansion, including backslash itself.
9250 If the string appears in quotes in the configuration file, two backslashes are
9251 required because the quotes themselves cause interpretation of backslashes when
9252 the string is read in (see section &<<SECTstrings>>&).
9253
9254 .cindex "expansion" "non-expandable substrings"
9255 A portion of the string can specified as non-expandable by placing it between
9256 two occurrences of &`\N`&. This is particularly useful for protecting regular
9257 expressions, which often contain backslashes and dollar signs. For example:
9258 .code
9259 deny senders = \N^\d{8}[a-z]@some\.site\.example$\N
9260 .endd
9261 On encountering the first &`\N`&, the expander copies subsequent characters
9262 without interpretation until it reaches the next &`\N`& or the end of the
9263 string.
9264
9265
9266
9267 .section "Character escape sequences in expanded strings" "SECID82"
9268 .cindex "expansion" "escape sequences"
9269 A backslash followed by one of the letters &"n"&, &"r"&, or &"t"& in an
9270 expanded string is recognized as an escape sequence for the character newline,
9271 carriage return, or tab, respectively. A backslash followed by up to three
9272 octal digits is recognized as an octal encoding for a single character, and a
9273 backslash followed by &"x"& and up to two hexadecimal digits is a hexadecimal
9274 encoding.
9275
9276 These escape sequences are also recognized in quoted strings when they are read
9277 in. Their interpretation in expansions as well is useful for unquoted strings,
9278 and for other cases such as looked-up strings that are then expanded.
9279
9280
9281 .section "Testing string expansions" "SECID83"
9282 .cindex "expansion" "testing"
9283 .cindex "testing" "string expansion"
9284 .oindex "&%-be%&"
9285 Many expansions can be tested by calling Exim with the &%-be%& option. This
9286 takes the command arguments, or lines from the standard input if there are no
9287 arguments, runs them through the string expansion code, and writes the results
9288 to the standard output. Variables based on configuration values are set up, but
9289 since no message is being processed, variables such as &$local_part$& have no
9290 value. Nevertheless the &%-be%& option can be useful for checking out file and
9291 database lookups, and the use of expansion operators such as &%sg%&, &%substr%&
9292 and &%nhash%&.
9293
9294 Exim gives up its root privilege when it is called with the &%-be%& option, and
9295 instead runs under the uid and gid it was called with, to prevent users from
9296 using &%-be%& for reading files to which they do not have access.
9297
9298 .oindex "&%-bem%&"
9299 If you want to test expansions that include variables whose values are taken
9300 from a message, there are two other options that can be used. The &%-bem%&
9301 option is like &%-be%& except that it is followed by a filename. The file is
9302 read as a message before doing the test expansions. For example:
9303 .code
9304 exim -bem /tmp/test.message '$h_subject:'
9305 .endd
9306 The &%-Mset%& option is used in conjunction with &%-be%& and is followed by an
9307 Exim message identifier. For example:
9308 .code
9309 exim -be -Mset 1GrA8W-0004WS-LQ '$recipients'
9310 .endd
9311 This loads the message from Exim's spool before doing the test expansions, and
9312 is therefore restricted to admin users.
9313
9314
9315 .section "Forced expansion failure" "SECTforexpfai"
9316 .cindex "expansion" "forced failure"
9317 A number of expansions that are described in the following section have
9318 alternative &"true"& and &"false"& substrings, enclosed in brace characters
9319 (which are sometimes called &"curly brackets"&). Which of the two strings is
9320 used depends on some condition that is evaluated as part of the expansion. If,
9321 instead of a &"false"& substring, the word &"fail"& is used (not in braces),
9322 the entire string expansion fails in a way that can be detected by the code
9323 that requested the expansion. This is called &"forced expansion failure"&, and
9324 its consequences depend on the circumstances. In some cases it is no different
9325 from any other expansion failure, but in others a different action may be
9326 taken. Such variations are mentioned in the documentation of the option that is
9327 being expanded.
9328
9329
9330
9331
9332 .section "Expansion items" "SECTexpansionitems"
9333 The following items are recognized in expanded strings. White space may be used
9334 between sub-items that are keywords or substrings enclosed in braces inside an
9335 outer set of braces, to improve readability. &*Warning*&: Within braces,
9336 white space is significant.
9337
9338 .vlist
9339 .vitem &*$*&<&'variable&~name'&>&~or&~&*${*&<&'variable&~name'&>&*}*&
9340 .cindex "expansion" "variables"
9341 Substitute the contents of the named variable, for example:
9342 .code
9343 $local_part
9344 ${domain}
9345 .endd
9346 The second form can be used to separate the name from subsequent alphanumeric
9347 characters. This form (using braces) is available only for variables; it does
9348 &'not'& apply to message headers. The names of the variables are given in
9349 section &<<SECTexpvar>>& below. If the name of a non-existent variable is
9350 given, the expansion fails.
9351
9352 .vitem &*${*&<&'op'&>&*:*&<&'string'&>&*}*&
9353 .cindex "expansion" "operators"
9354 The string is first itself expanded, and then the operation specified by
9355 <&'op'&> is applied to it. For example:
9356 .code
9357 ${lc:$local_part}
9358 .endd
9359 The string starts with the first character after the colon, which may be
9360 leading white space. A list of operators is given in section &<<SECTexpop>>&
9361 below. The operator notation is used for simple expansion items that have just
9362 one argument, because it reduces the number of braces and therefore makes the
9363 string easier to understand.
9364
9365 .vitem &*$bheader_*&<&'header&~name'&>&*:*&&~or&~&*$bh_*&<&'header&~name'&>&*:*&
9366 This item inserts &"basic"& header lines. It is described with the &%header%&
9367 expansion item below.
9368
9369
9370 .vitem "&*${acl{*&<&'name'&>&*}{*&<&'arg'&>&*}...}*&"
9371 .cindex "expansion" "calling an acl"
9372 .cindex "&%acl%&" "call from expansion"
9373 The name and zero to nine argument strings are first expanded separately.  The expanded
9374 arguments are assigned to the variables &$acl_arg1$& to &$acl_arg9$& in order.
9375 Any unused are made empty.  The variable &$acl_narg$& is set to the number of
9376 arguments.  The named ACL (see chapter &<<CHAPACL>>&) is called
9377 and may use the variables; if another acl expansion is used the values
9378 are restored after it returns.  If the ACL sets
9379 a value using a "message =" modifier and returns accept or deny, the value becomes
9380 the result of the expansion.
9381 If no message is set and the ACL returns accept or deny
9382 the expansion result is an empty string.
9383 If the ACL returns defer the result is a forced-fail.  Otherwise the expansion fails.
9384
9385
9386 .vitem "&*${authresults{*&<&'authserv-id'&>&*}}*&"
9387 .cindex authentication "results header"
9388 .cindex headers "authentication-results:"
9389 .cindex authentication "expansion item"
9390 This item returns a string suitable for insertion as an
9391 &'Authentication-Results:'&
9392 header line.
9393 The given <&'authserv-id'&> is included in the result; typically this
9394 will be a domain name identifying the system performing the authentications.
9395 Methods that might be present in the result include:
9396 .code
9397 none
9398 iprev
9399 auth
9400 spf
9401 dkim
9402 .endd
9403
9404 Example use (as an ACL modifier):
9405 .code
9406       add_header = :at_start:${authresults {$primary_hostname}}
9407 .endd
9408 This is safe even if no authentication results are available.
9409
9410
9411 .vitem "&*${certextract{*&<&'field'&>&*}{*&<&'certificate'&>&*}&&&
9412        {*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9413 .cindex "expansion" "extracting certificate fields"
9414 .cindex "&%certextract%&" "certificate fields"
9415 .cindex "certificate" "extracting fields"
9416 The <&'certificate'&> must be a variable of type certificate.
9417 The field name is expanded and used to retrieve the relevant field from
9418 the certificate.  Supported fields are:
9419 .display
9420 &`version        `&
9421 &`serial_number  `&
9422 &`subject        `& RFC4514 DN
9423 &`issuer         `& RFC4514 DN
9424 &`notbefore      `& time
9425 &`notafter       `& time
9426 &`sig_algorithm  `&
9427 &`signature      `&
9428 &`subj_altname   `& tagged list
9429 &`ocsp_uri       `& list
9430 &`crl_uri        `& list
9431 .endd
9432 If the field is found,
9433 <&'string2'&> is expanded, and replaces the whole item;
9434 otherwise <&'string3'&> is used. During the expansion of <&'string2'&> the
9435 variable &$value$& contains the value that has been extracted. Afterwards, it
9436 is restored to any previous value it might have had.
9437
9438 If {<&'string3'&>} is omitted, the item is replaced by an empty string if the
9439 key is not found. If {<&'string2'&>} is also omitted, the value that was
9440 extracted is used.
9441
9442 Some field names take optional modifiers, appended and separated by commas.
9443
9444 The field selectors marked as "RFC4514" above
9445 output a Distinguished Name string which is
9446 not quite
9447 parseable by Exim as a comma-separated tagged list
9448 (the exceptions being elements containing commas).
9449 RDN elements of a single type may be selected by
9450 a modifier of the type label; if so the expansion
9451 result is a list (newline-separated by default).
9452 The separator may be changed by another modifier of
9453 a right angle-bracket followed immediately by the new separator.
9454 Recognised RDN type labels include "CN", "O", "OU" and "DC".
9455
9456 The field selectors marked as "time" above
9457 take an optional modifier of "int"
9458 for which the result is the number of seconds since epoch.
9459 Otherwise the result is a human-readable string
9460 in the timezone selected by the main "timezone" option.
9461
9462 The field selectors marked as "list" above return a list,
9463 newline-separated by default,
9464 (embedded separator characters in elements are doubled).
9465 The separator may be changed by a modifier of
9466 a right angle-bracket followed immediately by the new separator.
9467
9468 The field selectors marked as "tagged" above
9469 prefix each list element with a type string and an equals sign.
9470 Elements of only one type may be selected by a modifier
9471 which is one of "dns", "uri" or "mail";
9472 if so the element tags are omitted.
9473
9474 If not otherwise noted field values are presented in human-readable form.
9475
9476 .vitem "&*${dlfunc{*&<&'file'&>&*}{*&<&'function'&>&*}{*&<&'arg'&>&*}&&&
9477        {*&<&'arg'&>&*}...}*&"
9478 .cindex &%dlfunc%&
9479 This expansion dynamically loads and then calls a locally-written C function.
9480 This functionality is available only if Exim is compiled with
9481 .code
9482 EXPAND_DLFUNC=yes
9483 .endd
9484 set in &_Local/Makefile_&. Once loaded, Exim remembers the dynamically loaded
9485 object so that it doesn't reload the same object file in the same Exim process
9486 (but of course Exim does start new processes frequently).
9487
9488 There may be from zero to eight arguments to the function.
9489
9490 .new
9491 When compiling
9492 a local function that is to be called in this way,
9493 first &_DLFUNC_IMPL_& should be defined,
9494 and second &_local_scan.h_& should be included.
9495 .wen
9496 The Exim variables and functions that are defined by that API
9497 are also available for dynamically loaded functions. The function itself
9498 must have the following type:
9499 .code
9500 int dlfunction(uschar **yield, int argc, uschar *argv[])
9501 .endd
9502 Where &`uschar`& is a typedef for &`unsigned char`& in &_local_scan.h_&. The
9503 function should return one of the following values:
9504
9505 &`OK`&: Success. The string that is placed in the variable &'yield'& is put
9506 into the expanded string that is being built.
9507
9508 &`FAIL`&: A non-forced expansion failure occurs, with the error message taken
9509 from &'yield'&, if it is set.
9510
9511 &`FAIL_FORCED`&: A forced expansion failure occurs, with the error message
9512 taken from &'yield'& if it is set.
9513
9514 &`ERROR`&: Same as &`FAIL`&, except that a panic log entry is written.
9515
9516 When compiling a function that is to be used in this way with gcc,
9517 you need to add &%-shared%& to the gcc command. Also, in the Exim build-time
9518 configuration, you must add &%-export-dynamic%& to EXTRALIBS.
9519
9520
9521 .vitem "&*${env{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&"
9522 .cindex "expansion" "extracting value from environment"
9523 .cindex "environment" "values from"
9524 The key is first expanded separately, and leading and trailing white space
9525 removed.
9526 This is then searched for as a name in the environment.
9527 If a variable is found then its value is placed in &$value$&
9528 and <&'string1'&> is expanded, otherwise <&'string2'&> is expanded.
9529
9530 Instead of {<&'string2'&>} the word &"fail"& (not in curly brackets) can
9531 appear, for example:
9532 .code
9533 ${env{USER}{$value} fail }
9534 .endd
9535 This forces an expansion failure (see section &<<SECTforexpfai>>&);
9536 {<&'string1'&>} must be present for &"fail"& to be recognized.
9537
9538 If {<&'string2'&>} is omitted an empty string is substituted on
9539 search failure.
9540 If {<&'string1'&>} is omitted the search result is substituted on
9541 search success.
9542
9543 The environment is adjusted by the &%keep_environment%& and
9544 &%add_environment%& main section options.
9545
9546
9547 .vitem "&*${extract{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}&&&
9548        {*&<&'string3'&>&*}}*&"
9549 .cindex "expansion" "extracting substrings by key"
9550 .cindex "&%extract%&" "substrings by key"
9551 The key and <&'string1'&> are first expanded separately. Leading and trailing
9552 white space is removed from the key (but not from any of the strings). The key
9553 must not be empty and must not consist entirely of digits.
9554 The expanded <&'string1'&> must be of the form:
9555 .display
9556 <&'key1'&> = <&'value1'&>  <&'key2'&> = <&'value2'&> ...
9557 .endd
9558 .vindex "&$value$&"
9559 where the equals signs and spaces (but not both) are optional. If any of the
9560 values contain white space, they must be enclosed in double quotes, and any
9561 values that are enclosed in double quotes are subject to escape processing as
9562 described in section &<<SECTstrings>>&. The expanded <&'string1'&> is searched
9563 for the value that corresponds to the key. The search is case-insensitive. If
9564 the key is found, <&'string2'&> is expanded, and replaces the whole item;
9565 otherwise <&'string3'&> is used. During the expansion of <&'string2'&> the
9566 variable &$value$& contains the value that has been extracted. Afterwards, it
9567 is restored to any previous value it might have had.
9568
9569 If {<&'string3'&>} is omitted, the item is replaced by an empty string if the
9570 key is not found. If {<&'string2'&>} is also omitted, the value that was
9571 extracted is used. Thus, for example, these two expansions are identical, and
9572 yield &"2001"&:
9573 .code
9574 ${extract{gid}{uid=1984 gid=2001}}
9575 ${extract{gid}{uid=1984 gid=2001}{$value}}
9576 .endd
9577 Instead of {<&'string3'&>} the word &"fail"& (not in curly brackets) can
9578 appear, for example:
9579 .code
9580 ${extract{Z}{A=... B=...}{$value} fail }
9581 .endd
9582 This forces an expansion failure (see section &<<SECTforexpfai>>&);
9583 {<&'string2'&>} must be present for &"fail"& to be recognized.
9584
9585 .vitem "&*${extract json{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}&&&
9586        {*&<&'string3'&>&*}}*&" &&&
9587        "&*${extract jsons{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}&&&
9588        {*&<&'string3'&>&*}}*&"
9589 .cindex "expansion" "extracting from JSON object"
9590 .cindex JSON expansions
9591 The key and <&'string1'&> are first expanded separately. Leading and trailing
9592 white space is removed from the key (but not from any of the strings). The key
9593 must not be empty and must not consist entirely of digits.
9594 The expanded <&'string1'&> must be of the form:
9595 .display
9596 { <&'"key1"'&> : <&'value1'&> ,  <&'"key2"'&> , <&'value2'&> ... }
9597 .endd
9598 .vindex "&$value$&"
9599 The braces, commas and colons, and the quoting of the member name are required;
9600 the spaces are optional.
9601 Matching of the key against the member names is done case-sensitively.
9602 For the &"json"& variant,
9603 if a returned value is a JSON string, it retains its leading and
9604 trailing quotes.
9605 .new
9606 For the &"jsons"& variant, which is intended for use with JSON strings, the
9607 leading and trailing quotes are removed from the returned value.
9608 .wen
9609 . XXX should be a UTF-8 compare
9610
9611 The results of matching are handled as above.
9612
9613
9614 .vitem "&*${extract{*&<&'number'&>&*}{*&<&'separators'&>&*}&&&
9615         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9616 .cindex "expansion" "extracting substrings by number"
9617 .cindex "&%extract%&" "substrings by number"
9618 The <&'number'&> argument must consist entirely of decimal digits,
9619 apart from leading and trailing white space, which is ignored.
9620 This is what distinguishes this form of &%extract%& from the previous kind. It
9621 behaves in the same way, except that, instead of extracting a named field, it
9622 extracts from <&'string1'&> the field whose number is given as the first
9623 argument. You can use &$value$& in <&'string2'&> or &`fail`& instead of
9624 <&'string3'&> as before.
9625
9626 The fields in the string are separated by any one of the characters in the
9627 separator string. These may include space or tab characters.
9628 The first field is numbered one. If the number is negative, the fields are
9629 counted from the end of the string, with the rightmost one numbered -1. If the
9630 number given is zero, the entire string is returned. If the modulus of the
9631 number is greater than the number of fields in the string, the result is the
9632 expansion of <&'string3'&>, or the empty string if <&'string3'&> is not
9633 provided. For example:
9634 .code
9635 ${extract{2}{:}{x:42:99:& Mailer::/bin/bash}}
9636 .endd
9637 yields &"42"&, and
9638 .code
9639 ${extract{-4}{:}{x:42:99:& Mailer::/bin/bash}}
9640 .endd
9641 yields &"99"&. Two successive separators mean that the field between them is
9642 empty (for example, the fifth field above).
9643
9644
9645 .vitem "&*${extract json {*&<&'number'&>&*}}&&&
9646         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&" &&&
9647        "&*${extract jsons{*&<&'number'&>&*}}&&&
9648         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9649 .cindex "expansion" "extracting from JSON array"
9650 .cindex JSON expansions
9651 The <&'number'&> argument must consist entirely of decimal digits,
9652 apart from leading and trailing white space, which is ignored.
9653
9654 Field selection and result handling is as above;
9655 there is no choice of field separator.
9656 For the &"json"& variant,
9657 if a returned value is a JSON string, it retains its leading and
9658 trailing quotes.
9659 .new
9660 For the &"jsons"& variant, which is intended for use with JSON strings, the
9661 leading and trailing quotes are removed from the returned value.
9662 .wen
9663
9664
9665 .vitem &*${filter{*&<&'string'&>&*}{*&<&'condition'&>&*}}*&
9666 .cindex "list" "selecting by condition"
9667 .cindex "expansion" "selecting from list by condition"
9668 .vindex "&$item$&"
9669 After expansion, <&'string'&> is interpreted as a list, colon-separated by
9670 default, but the separator can be changed in the usual way (&<<SECTlistsepchange>>&).
9671 For each item
9672 in this list, its value is place in &$item$&, and then the condition is
9673 evaluated. If the condition is true, &$item$& is added to the output as an
9674 item in a new list; if the condition is false, the item is discarded. The
9675 separator used for the output list is the same as the one used for the
9676 input, but a separator setting is not included in the output. For example:
9677 .code
9678 ${filter{a:b:c}{!eq{$item}{b}}}
9679 .endd
9680 yields &`a:c`&. At the end of the expansion, the value of &$item$& is restored
9681 to what it was before. See also the &%map%& and &%reduce%& expansion items.
9682
9683
9684 .vitem &*${hash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9685 .cindex "hash function" "textual"
9686 .cindex "expansion" "textual hash"
9687 This is a textual hashing function, and was the first to be implemented in
9688 early versions of Exim. In current releases, there are other hashing functions
9689 (numeric, MD5, and SHA-1), which are described below.
9690
9691 The first two strings, after expansion, must be numbers. Call them <&'m'&> and
9692 <&'n'&>. If you are using fixed values for these numbers, that is, if
9693 <&'string1'&> and <&'string2'&> do not change when they are expanded, you can
9694 use the simpler operator notation that avoids some of the braces:
9695 .code
9696 ${hash_<n>_<m>:<string>}
9697 .endd
9698 The second number is optional (in both notations). If <&'n'&> is greater than
9699 or equal to the length of the string, the expansion item returns the string.
9700 Otherwise it computes a new string of length <&'n'&> by applying a hashing
9701 function to the string. The new string consists of characters taken from the
9702 first <&'m'&> characters of the string
9703 .code
9704 abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQWRSTUVWXYZ0123456789
9705 .endd
9706 If <&'m'&> is not present the value 26 is used, so that only lower case
9707 letters appear. For example:
9708 .display
9709 &`$hash{3}{monty}}           `&   yields  &`jmg`&
9710 &`$hash{5}{monty}}           `&   yields  &`monty`&
9711 &`$hash{4}{62}{monty python}}`&   yields  &`fbWx`&
9712 .endd
9713
9714 .vitem "&*$header_*&<&'header&~name'&>&*:*&&~or&~&&&
9715         &*$h_*&<&'header&~name'&>&*:*&" &&&
9716        "&*$bheader_*&<&'header&~name'&>&*:*&&~or&~&&&
9717         &*$bh_*&<&'header&~name'&>&*:*&" &&&
9718        "&*$lheader_*&<&'header&~name'&>&*:*&&~or&~&&&
9719         &*$lh_*&<&'header&~name'&>&*:*&"
9720        "&*$rheader_*&<&'header&~name'&>&*:*&&~or&~&&&
9721         &*$rh_*&<&'header&~name'&>&*:*&"
9722 .cindex "expansion" "header insertion"
9723 .vindex "&$header_$&"
9724 .vindex "&$bheader_$&"
9725 .vindex "&$lheader_$&"
9726 .vindex "&$rheader_$&"
9727 .cindex "header lines" "in expansion strings"
9728 .cindex "header lines" "character sets"
9729 .cindex "header lines" "decoding"
9730 Substitute the contents of the named message header line, for example
9731 .code
9732 $header_reply-to:
9733 .endd
9734 The newline that terminates a header line is not included in the expansion, but
9735 internal newlines (caused by splitting the header line over several physical
9736 lines) may be present.
9737
9738 The difference between the four pairs of expansions is in the way
9739 the data in the header line is interpreted.
9740
9741 .ilist
9742 .cindex "white space" "in header lines"
9743 &%rheader%& gives the original &"raw"& content of the header line, with no
9744 processing at all, and without the removal of leading and trailing white space.
9745
9746 .next
9747 .cindex "list" "of header lines"
9748 &%lheader%& gives a colon-separated list, one element per header when there
9749 are multiple headers with a given name.
9750 Any embedded colon characters within an element are doubled, so normal Exim
9751 list-processing facilities can be used.
9752 The terminating newline of each element is removed; in other respects
9753 the content is &"raw"&.
9754
9755 .next
9756 .cindex "base64 encoding" "in header lines"
9757 &%bheader%& removes leading and trailing white space, and then decodes base64
9758 or quoted-printable MIME &"words"& within the header text, but does no
9759 character set translation. If decoding of what looks superficially like a MIME
9760 &"word"& fails, the raw string is returned. If decoding
9761 .cindex "binary zero" "in header line"
9762 produces a binary zero character, it is replaced by a question mark &-- this is
9763 what Exim does for binary zeros that are actually received in header lines.
9764
9765 .next
9766 &%header%& tries to translate the string as decoded by &%bheader%& to a
9767 standard character set. This is an attempt to produce the same string as would
9768 be displayed on a user's MUA. If translation fails, the &%bheader%& string is
9769 returned. Translation is attempted only on operating systems that support the
9770 &[iconv()]& function. This is indicated by the compile-time macro HAVE_ICONV in
9771 a system Makefile or in &_Local/Makefile_&.
9772 .endlist ilist
9773
9774 In a filter file, the target character set for &%header%& can be specified by a
9775 command of the following form:
9776 .code
9777 headers charset "UTF-8"
9778 .endd
9779 This command affects all references to &$h_$& (or &$header_$&) expansions in
9780 subsequently obeyed filter commands. In the absence of this command, the target
9781 character set in a filter is taken from the setting of the &%headers_charset%&
9782 option in the runtime configuration. The value of this option defaults to the
9783 value of HEADERS_CHARSET in &_Local/Makefile_&. The ultimate default is
9784 ISO-8859-1.
9785
9786 Header names follow the syntax of RFC 2822, which states that they may contain
9787 any printing characters except space and colon. Consequently, curly brackets
9788 &'do not'& terminate header names, and should not be used to enclose them as
9789 if they were variables. Attempting to do so causes a syntax error.
9790
9791 Only header lines that are common to all copies of a message are visible to
9792 this mechanism. These are the original header lines that are received with the
9793 message, and any that are added by an ACL statement or by a system
9794 filter. Header lines that are added to a particular copy of a message by a
9795 router or transport are not accessible.
9796
9797 For incoming SMTP messages, no header lines are visible in
9798 ACLs that are obeyed before the data phase completes,
9799 because the header structure is not set up until the message is received.
9800 They are visible in DKIM, PRDR and DATA ACLs.
9801 Header lines that are added in a RCPT ACL (for example)
9802 are saved until the message's incoming header lines are available, at which
9803 point they are added.
9804 When any of the above ACLs ar
9805 running, however, header lines added by earlier ACLs are visible.
9806
9807 Upper case and lower case letters are synonymous in header names. If the
9808 following character is white space, the terminating colon may be omitted, but
9809 this is not recommended, because you may then forget it when it is needed. When
9810 white space terminates the header name, this white space is included in the
9811 expanded string.  If the message does not contain the given header, the
9812 expansion item is replaced by an empty string. (See the &%def%& condition in
9813 section &<<SECTexpcond>>& for a means of testing for the existence of a
9814 header.)
9815
9816 If there is more than one header with the same name, they are all concatenated
9817 to form the substitution string, up to a maximum length of 64K. Unless
9818 &%rheader%& is being used, leading and trailing white space is removed from
9819 each header before concatenation, and a completely empty header is ignored. A
9820 newline character is then inserted between non-empty headers, but there is no
9821 newline at the very end. For the &%header%& and &%bheader%& expansion, for
9822 those headers that contain lists of addresses, a comma is also inserted at the
9823 junctions between headers. This does not happen for the &%rheader%& expansion.
9824
9825
9826 .vitem &*${hmac{*&<&'hashname'&>&*}{*&<&'secret'&>&*}{*&<&'string'&>&*}}*&
9827 .cindex "expansion" "hmac hashing"
9828 .cindex &%hmac%&
9829 This function uses cryptographic hashing (either MD5 or SHA-1) to convert a
9830 shared secret and some text into a message authentication code, as specified in
9831 RFC 2104. This differs from &`${md5:secret_text...}`& or
9832 &`${sha1:secret_text...}`& in that the hmac step adds a signature to the
9833 cryptographic hash, allowing for authentication that is not possible with MD5
9834 or SHA-1 alone. The hash name must expand to either &`md5`& or &`sha1`& at
9835 present. For example:
9836 .code
9837 ${hmac{md5}{somesecret}{$primary_hostname $tod_log}}
9838 .endd
9839 For the hostname &'mail.example.com'& and time 2002-10-17 11:30:59, this
9840 produces:
9841 .code
9842 dd97e3ba5d1a61b5006108f8c8252953
9843 .endd
9844 As an example of how this might be used, you might put in the main part of
9845 an Exim configuration:
9846 .code
9847 SPAMSCAN_SECRET=cohgheeLei2thahw
9848 .endd
9849 In a router or a transport you could then have:
9850 .code
9851 headers_add = \
9852   X-Spam-Scanned: ${primary_hostname} ${message_exim_id} \
9853   ${hmac{md5}{SPAMSCAN_SECRET}\
9854   {${primary_hostname},${message_exim_id},$h_message-id:}}
9855 .endd
9856 Then given a message, you can check where it was scanned by looking at the
9857 &'X-Spam-Scanned:'& header line. If you know the secret, you can check that
9858 this header line is authentic by recomputing the authentication code from the
9859 host name, message ID and the &'Message-id:'& header line. This can be done
9860 using Exim's &%-be%& option, or by other means, for example, by using the
9861 &'hmac_md5_hex()'& function in Perl.
9862
9863
9864 .vitem &*${if&~*&<&'condition'&>&*&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
9865 .cindex "expansion" "conditional"
9866 .cindex "&%if%&, expansion item"
9867 If <&'condition'&> is true, <&'string1'&> is expanded and replaces the whole
9868 item; otherwise <&'string2'&> is used. The available conditions are described
9869 in section &<<SECTexpcond>>& below. For example:
9870 .code
9871 ${if eq {$local_part}{postmaster} {yes}{no} }
9872 .endd
9873 The second string need not be present; if it is not and the condition is not
9874 true, the item is replaced with nothing. Alternatively, the word &"fail"& may
9875 be present instead of the second string (without any curly brackets). In this
9876 case, the expansion is forced to fail if the condition is not true (see section
9877 &<<SECTforexpfai>>&).
9878
9879 If both strings are omitted, the result is the string &`true`& if the condition
9880 is true, and the empty string if the condition is false. This makes it less
9881 cumbersome to write custom ACL and router conditions. For example, instead of
9882 .code
9883 condition = ${if >{$acl_m4}{3}{true}{false}}
9884 .endd
9885 you can use
9886 .code
9887 condition = ${if >{$acl_m4}{3}}
9888 .endd
9889
9890
9891
9892 .vitem &*${imapfolder{*&<&'foldername'&>&*}}*&
9893 .cindex expansion "imap folder"
9894 .cindex "&%imapfolder%& expansion item"
9895 This item converts a (possibly multilevel, or with non-ASCII characters)
9896 folder specification to a Maildir name for filesystem use.
9897 For information on internationalisation support see &<<SECTi18nMDA>>&.
9898
9899
9900
9901 .vitem &*${length{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
9902 .cindex "expansion" "string truncation"
9903 .cindex "&%length%& expansion item"
9904 The &%length%& item is used to extract the initial portion of a string. Both
9905 strings are expanded, and the first one must yield a number, <&'n'&>, say. If
9906 you are using a fixed value for the number, that is, if <&'string1'&> does not
9907 change when expanded, you can use the simpler operator notation that avoids
9908 some of the braces:
9909 .code
9910 ${length_<n>:<string>}
9911 .endd
9912 The result of this item is either the first <&'n'&> bytes or the whole
9913 of <&'string2'&>, whichever is the shorter. Do not confuse &%length%& with
9914 &%strlen%&, which gives the length of a string.
9915 All measurement is done in bytes and is not UTF-8 aware.
9916
9917
9918 .vitem "&*${listextract{*&<&'number'&>&*}&&&
9919         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9920 .cindex "expansion" "extracting list elements by number"
9921 .cindex "&%listextract%&" "extract list elements by number"
9922 .cindex "list" "extracting elements by number"
9923 The <&'number'&> argument must consist entirely of decimal digits,
9924 apart from an optional leading minus,
9925 and leading and trailing white space (which is ignored).
9926
9927 After expansion, <&'string1'&> is interpreted as a list, colon-separated by
9928 default, but the separator can be changed in the usual way (&<<SECTlistsepchange>>&).
9929
9930 The first field of the list is numbered one.
9931 If the number is negative, the fields are
9932 counted from the end of the list, with the rightmost one numbered -1.
9933 The numbered element of the list is extracted and placed in &$value$&,
9934 then <&'string2'&> is expanded as the result.
9935
9936 If the modulus of the
9937 number is zero or greater than the number of fields in the string,
9938 the result is the expansion of <&'string3'&>.
9939
9940 For example:
9941 .code
9942 ${listextract{2}{x:42:99}}
9943 .endd
9944 yields &"42"&, and
9945 .code
9946 ${listextract{-3}{<, x,42,99,& Mailer,,/bin/bash}{result: $value}}
9947 .endd
9948 yields &"result: 42"&.
9949
9950 If {<&'string3'&>} is omitted, an empty string is used for string3.
9951 If {<&'string2'&>} is also omitted, the value that was
9952 extracted is used.
9953 You can use &`fail`& instead of {<&'string3'&>} as in a string extract.
9954
9955
9956 .vitem "&*${lookup{*&<&'key'&>&*}&~*&<&'search&~type'&>&*&~&&&
9957         {*&<&'file'&>&*}&~{*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&"
9958 This is the first of one of two different types of lookup item, which are both
9959 described in the next item.
9960
9961 .vitem "&*${lookup&~*&<&'search&~type'&>&*&~{*&<&'query'&>&*}&~&&&
9962         {*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&"
9963 .cindex "expansion" "lookup in"
9964 .cindex "file" "lookups"
9965 .cindex "lookup" "in expanded string"
9966 The two forms of lookup item specify data lookups in files and databases, as
9967 discussed in chapter &<<CHAPfdlookup>>&. The first form is used for single-key
9968 lookups, and the second is used for query-style lookups. The <&'key'&>,
9969 <&'file'&>, and <&'query'&> strings are expanded before use.
9970
9971 If there is any white space in a lookup item which is part of a filter command,
9972 a retry or rewrite rule, a routing rule for the &(manualroute)& router, or any
9973 other place where white space is significant, the lookup item must be enclosed
9974 in double quotes. The use of data lookups in users' filter files may be locked
9975 out by the system administrator.
9976
9977 .vindex "&$value$&"
9978 If the lookup succeeds, <&'string1'&> is expanded and replaces the entire item.
9979 During its expansion, the variable &$value$& contains the data returned by the
9980 lookup. Afterwards it reverts to the value it had previously (at the outer
9981 level it is empty). If the lookup fails, <&'string2'&> is expanded and replaces
9982 the entire item. If {<&'string2'&>} is omitted, the replacement is the empty
9983 string on failure. If <&'string2'&> is provided, it can itself be a nested
9984 lookup, thus providing a mechanism for looking up a default value when the
9985 original lookup fails.
9986
9987 If a nested lookup is used as part of <&'string1'&>, &$value$& contains the
9988 data for the outer lookup while the parameters of the second lookup are
9989 expanded, and also while <&'string2'&> of the second lookup is expanded, should
9990 the second lookup fail. Instead of {<&'string2'&>} the word &"fail"& can
9991 appear, and in this case, if the lookup fails, the entire expansion is forced
9992 to fail (see section &<<SECTforexpfai>>&). If both {<&'string1'&>} and
9993 {<&'string2'&>} are omitted, the result is the looked up value in the case of a
9994 successful lookup, and nothing in the case of failure.
9995
9996 For single-key lookups, the string &"partial"& is permitted to precede the
9997 search type in order to do partial matching, and * or *@ may follow a search
9998 type to request default lookups if the key does not match (see sections
9999 &<<SECTdefaultvaluelookups>>& and &<<SECTpartiallookup>>& for details).
10000
10001 .cindex "numerical variables (&$1$& &$2$& etc)" "in lookup expansion"
10002 If a partial search is used, the variables &$1$& and &$2$& contain the wild
10003 and non-wild parts of the key during the expansion of the replacement text.
10004 They return to their previous values at the end of the lookup item.
10005
10006 This example looks up the postmaster alias in the conventional alias file:
10007 .code
10008 ${lookup {postmaster} lsearch {/etc/aliases} {$value}}
10009 .endd
10010 This example uses NIS+ to look up the full name of the user corresponding to
10011 the local part of an address, forcing the expansion to fail if it is not found:
10012 .code
10013 ${lookup nisplus {[name=$local_part],passwd.org_dir:gcos} \
10014   {$value}fail}
10015 .endd
10016
10017
10018 .vitem &*${map{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
10019 .cindex "expansion" "list creation"
10020 .vindex "&$item$&"
10021 After expansion, <&'string1'&> is interpreted as a list, colon-separated by
10022 default, but the separator can be changed in the usual way (&<<SECTlistsepchange>>&).
10023 For each item
10024 in this list, its value is place in &$item$&, and then <&'string2'&> is
10025 expanded and added to the output as an item in a new list. The separator used
10026 for the output list is the same as the one used for the input, but a separator
10027 setting is not included in the output. For example:
10028 .code
10029 ${map{a:b:c}{[$item]}} ${map{<- x-y-z}{($item)}}
10030 .endd
10031 expands to &`[a]:[b]:[c] (x)-(y)-(z)`&. At the end of the expansion, the
10032 value of &$item$& is restored to what it was before. See also the &%filter%&
10033 and &%reduce%& expansion items.
10034
10035 .vitem &*${nhash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
10036 .cindex "expansion" "numeric hash"
10037 .cindex "hash function" "numeric"
10038 The three strings are expanded; the first two must yield numbers. Call them
10039 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
10040 if <&'string1'&> and <&'string2'&> do not change when they are expanded, you
10041 can use the simpler operator notation that avoids some of the braces:
10042 .code
10043 ${nhash_<n>_<m>:<string>}
10044 .endd
10045 The second number is optional (in both notations). If there is only one number,
10046 the result is a number in the range 0&--<&'n'&>-1. Otherwise, the string is
10047 processed by a div/mod hash function that returns two numbers, separated by a
10048 slash, in the ranges 0 to <&'n'&>-1 and 0 to <&'m'&>-1, respectively. For
10049 example,
10050 .code
10051 ${nhash{8}{64}{supercalifragilisticexpialidocious}}
10052 .endd
10053 returns the string &"6/33"&.
10054
10055
10056
10057 .vitem &*${perl{*&<&'subroutine'&>&*}{*&<&'arg'&>&*}{*&<&'arg'&>&*}...}*&
10058 .cindex "Perl" "use in expanded string"
10059 .cindex "expansion" "calling Perl from"
10060 This item is available only if Exim has been built to include an embedded Perl
10061 interpreter. The subroutine name and the arguments are first separately
10062 expanded, and then the Perl subroutine is called with those arguments. No
10063 additional arguments need be given; the maximum number permitted, including the
10064 name of the subroutine, is nine.
10065
10066 The return value of the subroutine is inserted into the expanded string, unless
10067 the return value is &%undef%&. In that case, the expansion fails in the same
10068 way as an explicit &"fail"& on a lookup item. The return value is a scalar.
10069 Whatever you return is evaluated in a scalar context. For example, if you
10070 return the name of a Perl vector, the return value is the size of the vector,
10071 not its contents.
10072
10073 If the subroutine exits by calling Perl's &%die%& function, the expansion fails
10074 with the error message that was passed to &%die%&. More details of the embedded
10075 Perl facility are given in chapter &<<CHAPperl>>&.
10076
10077 The &(redirect)& router has an option called &%forbid_filter_perl%& which locks
10078 out the use of this expansion item in filter files.
10079
10080
10081 .vitem &*${prvs{*&<&'address'&>&*}{*&<&'secret'&>&*}{*&<&'keynumber'&>&*}}*&
10082 .cindex "&%prvs%& expansion item"
10083 The first argument is a complete email address and the second is secret
10084 keystring. The third argument, specifying a key number, is optional. If absent,
10085 it defaults to 0. The result of the expansion is a prvs-signed email address,
10086 to be typically used with the &%return_path%& option on an &(smtp)& transport
10087 as part of a bounce address tag validation (BATV) scheme. For more discussion
10088 and an example, see section &<<SECTverifyPRVS>>&.
10089
10090 .vitem "&*${prvscheck{*&<&'address'&>&*}{*&<&'secret'&>&*}&&&
10091         {*&<&'string'&>&*}}*&"
10092 .cindex "&%prvscheck%& expansion item"
10093 This expansion item is the complement of the &%prvs%& item. It is used for
10094 checking prvs-signed addresses. If the expansion of the first argument does not
10095 yield a syntactically valid prvs-signed address, the whole item expands to the
10096 empty string. When the first argument does expand to a syntactically valid
10097 prvs-signed address, the second argument is expanded, with the prvs-decoded
10098 version of the address and the key number extracted from the address in the
10099 variables &$prvscheck_address$& and &$prvscheck_keynum$&, respectively.
10100
10101 These two variables can be used in the expansion of the second argument to
10102 retrieve the secret. The validity of the prvs-signed address is then checked
10103 against the secret. The result is stored in the variable &$prvscheck_result$&,
10104 which is empty for failure or &"1"& for success.
10105
10106 The third argument is optional; if it is missing, it defaults to an empty
10107 string. This argument is now expanded. If the result is an empty string, the
10108 result of the expansion is the decoded version of the address. This is the case
10109 whether or not the signature was valid. Otherwise, the result of the expansion
10110 is the expansion of the third argument.
10111
10112 All three variables can be used in the expansion of the third argument.
10113 However, once the expansion is complete, only &$prvscheck_result$& remains set.
10114 For more discussion and an example, see section &<<SECTverifyPRVS>>&.
10115
10116 .vitem &*${readfile{*&<&'file&~name'&>&*}{*&<&'eol&~string'&>&*}}*&
10117 .cindex "expansion" "inserting an entire file"
10118 .cindex "file" "inserting into expansion"
10119 .cindex "&%readfile%& expansion item"
10120 The filename and end-of-line string are first expanded separately. The file is
10121 then read, and its contents replace the entire item. All newline characters in
10122 the file are replaced by the end-of-line string if it is present. Otherwise,
10123 newlines are left in the string.
10124 String expansion is not applied to the contents of the file. If you want this,
10125 you must wrap the item in an &%expand%& operator. If the file cannot be read,
10126 the string expansion fails.
10127
10128 The &(redirect)& router has an option called &%forbid_filter_readfile%& which
10129 locks out the use of this expansion item in filter files.
10130
10131
10132
10133 .vitem "&*${readsocket{*&<&'name'&>&*}{*&<&'request'&>&*}&&&
10134         {*&<&'options'&>&*}{*&<&'eol&~string'&>&*}{*&<&'fail&~string'&>&*}}*&"
10135 .cindex "expansion" "inserting from a socket"
10136 .cindex "socket, use of in expansion"
10137 .cindex "&%readsocket%& expansion item"
10138 This item inserts data from a Unix domain or TCP socket into the expanded
10139 string. The minimal way of using it uses just two arguments, as in these
10140 examples:
10141 .code
10142 ${readsocket{/socket/name}{request string}}
10143 ${readsocket{inet:some.host:1234}{request string}}
10144 .endd
10145 For a Unix domain socket, the first substring must be the path to the socket.
10146 For an Internet socket, the first substring must contain &`inet:`& followed by
10147 a host name or IP address, followed by a colon and a port, which can be a
10148 number or the name of a TCP port in &_/etc/services_&. An IP address may
10149 optionally be enclosed in square brackets. This is best for IPv6 addresses. For
10150 example:
10151 .code
10152 ${readsocket{inet:[::1]:1234}{request string}}
10153 .endd
10154 Only a single host name may be given, but if looking it up yields more than
10155 one IP address, they are each tried in turn until a connection is made. For
10156 both kinds of socket, Exim makes a connection, writes the request string
10157 unless it is an empty string; and no terminating NUL is ever sent)
10158 and reads from the socket until an end-of-file
10159 is read. A timeout of 5 seconds is applied. Additional, optional arguments
10160 extend what can be done. Firstly, you can vary the timeout. For example:
10161 .code
10162 ${readsocket{/socket/name}{request string}{3s}}
10163 .endd
10164
10165 The third argument is a list of options, of which the first element is the timeout
10166 and must be present if the argument is given.
10167 Further elements are options of form &'name=value'&.
10168 Two option types is currently recognised: shutdown and tls.
10169 The first defines whether (the default)
10170 or not a shutdown is done on the connection after sending the request.
10171 Example, to not do so (preferred, eg. by some webservers):
10172 .code
10173 ${readsocket{/socket/name}{request string}{3s:shutdown=no}}
10174 .endd
10175 The second, tls, controls the use of TLS on the connection.  Example:
10176 .code
10177 ${readsocket{/socket/name}{request string}{3s:tls=yes}}
10178 .endd
10179 The default is to not use TLS.
10180 If it is enabled, a shutdown as descripbed above is never done.
10181
10182 A fourth argument allows you to change any newlines that are in the data
10183 that is read, in the same way as for &%readfile%& (see above). This example
10184 turns them into spaces:
10185 .code
10186 ${readsocket{inet:127.0.0.1:3294}{request string}{3s}{ }}
10187 .endd
10188 As with all expansions, the substrings are expanded before the processing
10189 happens. Errors in these sub-expansions cause the expansion to fail. In
10190 addition, the following errors can occur:
10191
10192 .ilist
10193 Failure to create a socket file descriptor;
10194 .next
10195 Failure to connect the socket;
10196 .next
10197 Failure to write the request string;
10198 .next
10199 Timeout on reading from the socket.
10200 .endlist
10201
10202 By default, any of these errors causes the expansion to fail. However, if
10203 you supply a fifth substring, it is expanded and used when any of the above
10204 errors occurs. For example:
10205 .code
10206 ${readsocket{/socket/name}{request string}{3s}{\n}\
10207   {socket failure}}
10208 .endd
10209 You can test for the existence of a Unix domain socket by wrapping this
10210 expansion in &`${if exists`&, but there is a race condition between that test
10211 and the actual opening of the socket, so it is safer to use the fifth argument
10212 if you want to be absolutely sure of avoiding an expansion error for a
10213 non-existent Unix domain socket, or a failure to connect to an Internet socket.
10214
10215 The &(redirect)& router has an option called &%forbid_filter_readsocket%& which
10216 locks out the use of this expansion item in filter files.
10217
10218
10219 .vitem &*${reduce{*&<&'string1'&>}{<&'string2'&>&*}{*&<&'string3'&>&*}}*&
10220 .cindex "expansion" "reducing a list to a scalar"
10221 .cindex "list" "reducing to a scalar"
10222 .vindex "&$value$&"
10223 .vindex "&$item$&"
10224 This operation reduces a list to a single, scalar string. After expansion,
10225 <&'string1'&> is interpreted as a list, colon-separated by default, but the
10226 separator can be changed in the usual way (&<<SECTlistsepchange>>&).
10227 Then <&'string2'&> is expanded and
10228 assigned to the &$value$& variable. After this, each item in the <&'string1'&>
10229 list is assigned to &$item$&, in turn, and <&'string3'&> is expanded for each of
10230 them. The result of that expansion is assigned to &$value$& before the next
10231 iteration. When the end of the list is reached, the final value of &$value$& is
10232 added to the expansion output. The &%reduce%& expansion item can be used in a
10233 number of ways. For example, to add up a list of numbers:
10234 .code
10235 ${reduce {<, 1,2,3}{0}{${eval:$value+$item}}}
10236 .endd
10237 The result of that expansion would be &`6`&. The maximum of a list of numbers
10238 can be found:
10239 .code
10240 ${reduce {3:0:9:4:6}{0}{${if >{$item}{$value}{$item}{$value}}}}
10241 .endd
10242 At the end of a &*reduce*& expansion, the values of &$item$& and &$value$& are
10243 restored to what they were before. See also the &%filter%& and &%map%&
10244 expansion items.
10245
10246 .vitem &*$rheader_*&<&'header&~name'&>&*:*&&~or&~&*$rh_*&<&'header&~name'&>&*:*&
10247 This item inserts &"raw"& header lines. It is described with the &%header%&
10248 expansion item in section &<<SECTexpansionitems>>& above.
10249
10250 .vitem "&*${run{*&<&'command'&>&*&~*&<&'args'&>&*}{*&<&'string1'&>&*}&&&
10251         {*&<&'string2'&>&*}}*&"
10252 .cindex "expansion" "running a command"
10253 .cindex "&%run%& expansion item"
10254 The command and its arguments are first expanded as one string. The string is
10255 split apart into individual arguments by spaces, and then the command is run
10256 in a separate process, but under the same uid and gid.  As in other command
10257 executions from Exim, a shell is not used by default. If the command requires
10258 a shell, you must explicitly code it.
10259
10260 Since the arguments are split by spaces, when there is a variable expansion
10261 which has an empty result, it will cause the situation that the argument will
10262 simply be omitted when the program is actually executed by Exim. If the
10263 script/program requires a specific number of arguments and the expanded
10264 variable could possibly result in this empty expansion, the variable must be
10265 quoted. This is more difficult if the expanded variable itself could result
10266 in a string containing quotes, because it would interfere with the quotes
10267 around the command arguments. A possible guard against this is to wrap the
10268 variable in the &%sg%& operator to change any quote marks to some other
10269 character.
10270
10271 The standard input for the command exists, but is empty. The standard output
10272 and standard error are set to the same file descriptor.
10273 .cindex "return code" "from &%run%& expansion"
10274 .vindex "&$value$&"
10275 If the command succeeds (gives a zero return code) <&'string1'&> is expanded
10276 and replaces the entire item; during this expansion, the standard output/error
10277 from the command is in the variable &$value$&. If the command fails,
10278 <&'string2'&>, if present, is expanded and used. Once again, during the
10279 expansion, the standard output/error from the command is in the variable
10280 &$value$&.
10281
10282 If <&'string2'&> is absent, the result is empty. Alternatively, <&'string2'&>
10283 can be the word &"fail"& (not in braces) to force expansion failure if the
10284 command does not succeed. If both strings are omitted, the result is contents
10285 of the standard output/error on success, and nothing on failure.
10286
10287 .vindex "&$run_in_acl$&"
10288 The standard output/error of the command is put in the variable &$value$&.
10289 In this ACL example, the output of a command is logged for the admin to
10290 troubleshoot:
10291 .code
10292 warn  condition    = ${run{/usr/bin/id}{yes}{no}}
10293       log_message  = Output of id: $value
10294 .endd
10295 If the command requires shell idioms, such as the > redirect operator, the
10296 shell must be invoked directly, such as with:
10297 .code
10298 ${run{/bin/bash -c "/usr/bin/id >/tmp/id"}{yes}{yes}}
10299 .endd
10300
10301 .vindex "&$runrc$&"
10302 The return code from the command is put in the variable &$runrc$&, and this
10303 remains set afterwards, so in a filter file you can do things like this:
10304 .code
10305 if "${run{x y z}{}}$runrc" is 1 then ...
10306   elif $runrc is 2 then ...
10307   ...
10308 endif
10309 .endd
10310 If execution of the command fails (for example, the command does not exist),
10311 the return code is 127 &-- the same code that shells use for non-existent
10312 commands.
10313
10314 &*Warning*&: In a router or transport, you cannot assume the order in which
10315 option values are expanded, except for those preconditions whose order of
10316 testing is documented. Therefore, you cannot reliably expect to set &$runrc$&
10317 by the expansion of one option, and use it in another.
10318
10319 The &(redirect)& router has an option called &%forbid_filter_run%& which locks
10320 out the use of this expansion item in filter files.
10321
10322
10323 .vitem &*${sg{*&<&'subject'&>&*}{*&<&'regex'&>&*}{*&<&'replacement'&>&*}}*&
10324 .cindex "expansion" "string substitution"
10325 .cindex "&%sg%& expansion item"
10326 This item works like Perl's substitution operator (s) with the global (/g)
10327 option; hence its name. However, unlike the Perl equivalent, Exim does not
10328 modify the subject string; instead it returns the modified string for insertion
10329 into the overall expansion. The item takes three arguments: the subject string,
10330 a regular expression, and a substitution string. For example:
10331 .code
10332 ${sg{abcdefabcdef}{abc}{xyz}}
10333 .endd
10334 yields &"xyzdefxyzdef"&. Because all three arguments are expanded before use,
10335 if any $, } or \ characters are required in the regular expression or in the
10336 substitution string, they have to be escaped. For example:
10337 .code
10338 ${sg{abcdef}{^(...)(...)\$}{\$2\$1}}
10339 .endd
10340 yields &"defabc"&, and
10341 .code
10342 ${sg{1=A 4=D 3=C}{\N(\d+)=\N}{K\$1=}}
10343 .endd
10344 yields &"K1=A K4=D K3=C"&. Note the use of &`\N`& to protect the contents of
10345 the regular expression from string expansion.
10346
10347 The regular expression is compiled in 8-bit mode, working against bytes
10348 rather than any Unicode-aware character handling.
10349
10350
10351 .vitem &*${sort{*&<&'string'&>&*}{*&<&'comparator'&>&*}{*&<&'extractor'&>&*}}*&
10352 .cindex sorting "a list"
10353 .cindex list sorting
10354 .cindex expansion "list sorting"
10355 After expansion, <&'string'&> is interpreted as a list, colon-separated by
10356 default, but the separator can be changed in the usual way (&<<SECTlistsepchange>>&).
10357 The <&'comparator'&> argument is interpreted as the operator
10358 of a two-argument expansion condition.
10359 The numeric operators plus ge, gt, le, lt (and ~i variants) are supported.
10360 The comparison should return true when applied to two values
10361 if the first value should sort before the second value.
10362 The <&'extractor'&> expansion is applied repeatedly to elements of the list,
10363 the element being placed in &$item$&,
10364 to give values for comparison.
10365
10366 The item result is a sorted list,
10367 with the original list separator,
10368 of the list elements (in full) of the original.
10369
10370 Examples:
10371 .code
10372 ${sort{3:2:1:4}{<}{$item}}
10373 .endd
10374 sorts a list of numbers, and
10375 .code
10376 ${sort {${lookup dnsdb{>:,,mx=example.com}}} {<} {${listextract{1}{<,$item}}}}
10377 .endd
10378 will sort an MX lookup into priority order.
10379
10380
10381 .vitem &*${substr{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
10382 .cindex "&%substr%& expansion item"
10383 .cindex "substring extraction"
10384 .cindex "expansion" "substring extraction"
10385 The three strings are expanded; the first two must yield numbers. Call them
10386 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
10387 if <&'string1'&> and <&'string2'&> do not change when they are expanded, you
10388 can use the simpler operator notation that avoids some of the braces:
10389 .code
10390 ${substr_<n>_<m>:<string>}
10391 .endd
10392 The second number is optional (in both notations).
10393 If it is absent in the simpler format, the preceding underscore must also be
10394 omitted.
10395
10396 The &%substr%& item can be used to extract more general substrings than
10397 &%length%&. The first number, <&'n'&>, is a starting offset, and <&'m'&> is the
10398 length required. For example
10399 .code
10400 ${substr{3}{2}{$local_part}}
10401 .endd
10402 If the starting offset is greater than the string length the result is the
10403 null string; if the length plus starting offset is greater than the string
10404 length, the result is the right-hand part of the string, starting from the
10405 given offset. The first byte (character) in the string has offset zero.
10406
10407 The &%substr%& expansion item can take negative offset values to count
10408 from the right-hand end of its operand. The last byte (character) is offset -1,
10409 the second-last is offset -2, and so on. Thus, for example,
10410 .code
10411 ${substr{-5}{2}{1234567}}
10412 .endd
10413 yields &"34"&. If the absolute value of a negative offset is greater than the
10414 length of the string, the substring starts at the beginning of the string, and
10415 the length is reduced by the amount of overshoot. Thus, for example,
10416 .code
10417 ${substr{-5}{2}{12}}
10418 .endd
10419 yields an empty string, but
10420 .code
10421 ${substr{-3}{2}{12}}
10422 .endd
10423 yields &"1"&.
10424
10425 When the second number is omitted from &%substr%&, the remainder of the string
10426 is taken if the offset is positive. If it is negative, all bytes (characters) in the
10427 string preceding the offset point are taken. For example, an offset of -1 and
10428 no length, as in these semantically identical examples:
10429 .code
10430 ${substr_-1:abcde}
10431 ${substr{-1}{abcde}}
10432 .endd
10433 yields all but the last character of the string, that is, &"abcd"&.
10434
10435 All measurement is done in bytes and is not UTF-8 aware.
10436
10437
10438
10439 .vitem "&*${tr{*&<&'subject'&>&*}{*&<&'characters'&>&*}&&&
10440         {*&<&'replacements'&>&*}}*&"
10441 .cindex "expansion" "character translation"
10442 .cindex "&%tr%& expansion item"
10443 This item does single-character (in bytes) translation on its subject string. The second
10444 argument is a list of characters to be translated in the subject string. Each
10445 matching character is replaced by the corresponding character from the
10446 replacement list. For example
10447 .code
10448 ${tr{abcdea}{ac}{13}}
10449 .endd
10450 yields &`1b3de1`&. If there are duplicates in the second character string, the
10451 last occurrence is used. If the third string is shorter than the second, its
10452 last character is replicated. However, if it is empty, no translation takes
10453 place.
10454
10455 All character handling is done in bytes and is not UTF-8 aware.
10456
10457 .endlist
10458
10459
10460
10461 .section "Expansion operators" "SECTexpop"
10462 .cindex "expansion" "operators"
10463 For expansion items that perform transformations on a single argument string,
10464 the &"operator"& notation is used because it is simpler and uses fewer braces.
10465 The substring is first expanded before the operation is applied to it. The
10466 following operations can be performed:
10467
10468 .vlist
10469 .vitem &*${address:*&<&'string'&>&*}*&
10470 .cindex "expansion" "RFC 2822 address handling"
10471 .cindex "&%address%& expansion item"
10472 The string is interpreted as an RFC 2822 address, as it might appear in a
10473 header line, and the effective address is extracted from it. If the string does
10474 not parse successfully, the result is empty.
10475
10476 The parsing correctly handles SMTPUTF8 Unicode in the string.
10477
10478
10479 .vitem &*${addresses:*&<&'string'&>&*}*&
10480 .cindex "expansion" "RFC 2822 address handling"
10481 .cindex "&%addresses%& expansion item"
10482 The string (after expansion) is interpreted as a list of addresses in RFC
10483 2822 format, such as can be found in a &'To:'& or &'Cc:'& header line. The
10484 operative address (&'local-part@domain'&) is extracted from each item, and the
10485 result of the expansion is a colon-separated list, with appropriate
10486 doubling of colons should any happen to be present in the email addresses.
10487 Syntactically invalid RFC2822 address items are omitted from the output.
10488
10489 It is possible to specify a character other than colon for the output
10490 separator by starting the string with > followed by the new separator
10491 character. For example:
10492 .code
10493 ${addresses:>& Chief <ceo@up.stairs>, sec@base.ment (dogsbody)}
10494 .endd
10495 expands to &`ceo@up.stairs&&sec@base.ment`&. The string is expanded
10496 first, so if the expanded string starts with >, it may change the output
10497 separator unintentionally. This can be avoided by setting the output
10498 separator explicitly:
10499 .code
10500 ${addresses:>:$h_from:}
10501 .endd
10502
10503 Compare the &%address%& (singular)
10504 expansion item, which extracts the working address from a single RFC2822
10505 address. See the &%filter%&, &%map%&, and &%reduce%& items for ways of
10506 processing lists.
10507
10508 To clarify "list of addresses in RFC 2822 format" mentioned above, Exim follows
10509 a strict interpretation of header line formatting.  Exim parses the bare,
10510 unquoted portion of an email address and if it finds a comma, treats it as an
10511 email address separator. For the example header line:
10512 .code
10513 From: =?iso-8859-2?Q?Last=2C_First?= <user@example.com>
10514 .endd
10515 The first example below demonstrates that Q-encoded email addresses are parsed
10516 properly if it is given the raw header (in this example, &`$rheader_from:`&).
10517 It does not see the comma because it's still encoded as "=2C".  The second
10518 example below is passed the contents of &`$header_from:`&, meaning it gets
10519 de-mimed. Exim sees the decoded "," so it treats it as &*two*& email addresses.
10520 The third example shows that the presence of a comma is skipped when it is
10521 quoted.  The fourth example shows SMTPUTF8 handling.
10522 .code
10523 # exim -be '${addresses:From: \
10524 =?iso-8859-2?Q?Last=2C_First?= <user@example.com>}'
10525 user@example.com
10526 # exim -be '${addresses:From: Last, First <user@example.com>}'
10527 Last:user@example.com
10528 # exim -be '${addresses:From: "Last, First" <user@example.com>}'
10529 user@example.com
10530 # exim -be '${addresses:フィル <フィリップ@example.jp>}'
10531 フィリップ@example.jp
10532 .endd
10533
10534 .vitem &*${base32:*&<&'digits'&>&*}*&
10535 .cindex "&%base32%& expansion item"
10536 .cindex "expansion" "conversion to base 32"
10537 The string must consist entirely of decimal digits. The number is converted to
10538 base 32 and output as a (empty, for zero) string of characters.
10539 Only lowercase letters are used.
10540
10541 .vitem &*${base32d:*&<&'base-32&~digits'&>&*}*&
10542 .cindex "&%base32d%& expansion item"
10543 .cindex "expansion" "conversion to base 32"
10544 The string must consist entirely of base-32 digits.
10545 The number is converted to decimal and output as a string.
10546
10547 .vitem &*${base62:*&<&'digits'&>&*}*&
10548 .cindex "&%base62%& expansion item"
10549 .cindex "expansion" "conversion to base 62"
10550 The string must consist entirely of decimal digits. The number is converted to
10551 base 62 and output as a string of six characters, including leading zeros. In
10552 the few operating environments where Exim uses base 36 instead of base 62 for
10553 its message identifiers (because those systems do not have case-sensitive
10554 filenames), base 36 is used by this operator, despite its name. &*Note*&: Just
10555 to be absolutely clear: this is &'not'& base64 encoding.
10556
10557 .vitem &*${base62d:*&<&'base-62&~digits'&>&*}*&
10558 .cindex "&%base62d%& expansion item"
10559 .cindex "expansion" "conversion to base 62"
10560 The string must consist entirely of base-62 digits, or, in operating
10561 environments where Exim uses base 36 instead of base 62 for its message
10562 identifiers, base-36 digits. The number is converted to decimal and output as a
10563 string.
10564
10565 .vitem &*${base64:*&<&'string'&>&*}*&
10566 .cindex "expansion" "base64 encoding"
10567 .cindex "base64 encoding" "in string expansion"
10568 .cindex "&%base64%& expansion item"
10569 .cindex certificate "base64 of DER"
10570 This operator converts a string into one that is base64 encoded.
10571
10572 If the string is a single variable of type certificate,
10573 returns the base64 encoding of the DER form of the certificate.
10574
10575
10576 .vitem &*${base64d:*&<&'string'&>&*}*&
10577 .cindex "expansion" "base64 decoding"
10578 .cindex "base64 decoding" "in string expansion"
10579 .cindex "&%base64d%& expansion item"
10580 This operator converts a base64-encoded string into the un-coded form.
10581
10582
10583 .vitem &*${domain:*&<&'string'&>&*}*&
10584 .cindex "domain" "extraction"
10585 .cindex "expansion" "domain extraction"
10586 The string is interpreted as an RFC 2822 address and the domain is extracted
10587 from it. If the string does not parse successfully, the result is empty.
10588
10589
10590 .vitem &*${escape:*&<&'string'&>&*}*&
10591 .cindex "expansion" "escaping non-printing characters"
10592 .cindex "&%escape%& expansion item"
10593 If the string contains any non-printing characters, they are converted to
10594 escape sequences starting with a backslash. Whether characters with the most
10595 significant bit set (so-called &"8-bit characters"&) count as printing or not
10596 is controlled by the &%print_topbitchars%& option.
10597
10598 .vitem &*${escape8bit:*&<&'string'&>&*}*&
10599 .cindex "expansion" "escaping 8-bit characters"
10600 .cindex "&%escape8bit%& expansion item"
10601 If the string contains and characters with the most significant bit set,
10602 they are converted to escape sequences starting with a backslash.
10603 Backslashes and DEL characters are also converted.
10604
10605
10606 .vitem &*${eval:*&<&'string'&>&*}*&&~and&~&*${eval10:*&<&'string'&>&*}*&
10607 .cindex "expansion" "expression evaluation"
10608 .cindex "expansion" "arithmetic expression"
10609 .cindex "&%eval%& expansion item"
10610 These items supports simple arithmetic and bitwise logical operations in
10611 expansion strings. The string (after expansion) must be a conventional
10612 arithmetic expression, but it is limited to basic arithmetic operators, bitwise
10613 logical operators, and parentheses. All operations are carried out using
10614 integer arithmetic. The operator priorities are as follows (the same as in the
10615 C programming language):
10616 .table2 70pt 300pt
10617 .irow &'highest:'& "not (~), negate (-)"
10618 .irow ""   "multiply (*), divide (/), remainder (%)"
10619 .irow ""   "plus (+), minus (-)"
10620 .irow ""   "shift-left (<<), shift-right (>>)"
10621 .irow ""   "and (&&)"
10622 .irow ""   "xor (^)"
10623 .irow &'lowest:'&  "or (|)"
10624 .endtable
10625 Binary operators with the same priority are evaluated from left to right. White
10626 space is permitted before or after operators.
10627
10628 For &%eval%&, numbers may be decimal, octal (starting with &"0"&) or
10629 hexadecimal (starting with &"0x"&). For &%eval10%&, all numbers are taken as
10630 decimal, even if they start with a leading zero; hexadecimal numbers are not
10631 permitted. This can be useful when processing numbers extracted from dates or
10632 times, which often do have leading zeros.
10633
10634 A number may be followed by &"K"&, &"M"& or &"G"& to multiply it by 1024, 1024*1024
10635 or 1024*1024*1024,
10636 respectively. Negative numbers are supported. The result of the computation is
10637 a decimal representation of the answer (without &"K"&, &"M"& or &"G"&). For example:
10638
10639 .display
10640 &`${eval:1+1}            `&  yields 2
10641 &`${eval:1+2*3}          `&  yields 7
10642 &`${eval:(1+2)*3}        `&  yields 9
10643 &`${eval:2+42%5}         `&  yields 4
10644 &`${eval:0xc&amp;5}          `&  yields 4
10645 &`${eval:0xc|5}          `&  yields 13
10646 &`${eval:0xc^5}          `&  yields 9
10647 &`${eval:0xc>>1}         `&  yields 6
10648 &`${eval:0xc<<1}         `&  yields 24
10649 &`${eval:~255&amp;0x1234}    `&  yields 4608
10650 &`${eval:-(~255&amp;0x1234)} `&  yields -4608
10651 .endd
10652
10653 As a more realistic example, in an ACL you might have
10654 .code
10655 deny   message = Too many bad recipients
10656        condition =                    \
10657          ${if and {                   \
10658            {>{$rcpt_count}{10}}       \
10659            {                          \
10660            <                          \
10661              {$recipients_count}      \
10662              {${eval:$rcpt_count/2}}  \
10663            }                          \
10664          }{yes}{no}}
10665 .endd
10666 The condition is true if there have been more than 10 RCPT commands and
10667 fewer than half of them have resulted in a valid recipient.
10668
10669
10670 .vitem &*${expand:*&<&'string'&>&*}*&
10671 .cindex "expansion" "re-expansion of substring"
10672 The &%expand%& operator causes a string to be expanded for a second time. For
10673 example,
10674 .code
10675 ${expand:${lookup{$domain}dbm{/some/file}{$value}}}
10676 .endd
10677 first looks up a string in a file while expanding the operand for &%expand%&,
10678 and then re-expands what it has found.
10679
10680
10681 .vitem &*${from_utf8:*&<&'string'&>&*}*&
10682 .cindex "Unicode"
10683 .cindex "UTF-8" "conversion from"
10684 .cindex "expansion" "UTF-8 conversion"
10685 .cindex "&%from_utf8%& expansion item"
10686 The world is slowly moving towards Unicode, although there are no standards for
10687 email yet. However, other applications (including some databases) are starting
10688 to store data in Unicode, using UTF-8 encoding. This operator converts from a
10689 UTF-8 string to an ISO-8859-1 string. UTF-8 code values greater than 255 are
10690 converted to underscores. The input must be a valid UTF-8 string. If it is not,
10691 the result is an undefined sequence of bytes.
10692
10693 Unicode code points with values less than 256 are compatible with ASCII and
10694 ISO-8859-1 (also known as Latin-1).
10695 For example, character 169 is the copyright symbol in both cases, though the
10696 way it is encoded is different. In UTF-8, more than one byte is needed for
10697 characters with code values greater than 127, whereas ISO-8859-1 is a
10698 single-byte encoding (but thereby limited to 256 characters). This makes
10699 translation from UTF-8 to ISO-8859-1 straightforward.
10700
10701
10702 .vitem &*${hash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
10703 .cindex "hash function" "textual"
10704 .cindex "expansion" "textual hash"
10705 The &%hash%& operator is a simpler interface to the hashing function that can
10706 be used when the two parameters are fixed numbers (as opposed to strings that
10707 change when expanded). The effect is the same as
10708 .code
10709 ${hash{<n>}{<m>}{<string>}}
10710 .endd
10711 See the description of the general &%hash%& item above for details. The
10712 abbreviation &%h%& can be used when &%hash%& is used as an operator.
10713
10714
10715
10716 .vitem &*${hex2b64:*&<&'hexstring'&>&*}*&
10717 .cindex "base64 encoding" "conversion from hex"
10718 .cindex "expansion" "hex to base64"
10719 .cindex "&%hex2b64%& expansion item"
10720 This operator converts a hex string into one that is base64 encoded. This can
10721 be useful for processing the output of the various hashing functions.
10722
10723
10724
10725 .vitem &*${hexquote:*&<&'string'&>&*}*&
10726 .cindex "quoting" "hex-encoded unprintable characters"
10727 .cindex "&%hexquote%& expansion item"
10728 This operator converts non-printable characters in a string into a hex
10729 escape form. Byte values between 33 (!) and 126 (~) inclusive are left
10730 as is, and other byte values are converted to &`\xNN`&, for example, a
10731 byte value 127 is converted to &`\x7f`&.
10732
10733
10734 .vitem &*${ipv6denorm:*&<&'string'&>&*}*&
10735 .cindex "&%ipv6denorm%& expansion item"
10736 .cindex "IP address" normalisation
10737 This expands an IPv6 address to a full eight-element colon-separated set
10738 of hex digits including leading zeroes.
10739 A trailing ipv4-style dotted-decimal set is converted to hex.
10740 Pure IPv4 addresses are converted to IPv4-mapped IPv6.
10741
10742 .vitem &*${ipv6norm:*&<&'string'&>&*}*&
10743 .cindex "&%ipv6norm%& expansion item"
10744 .cindex "IP address" normalisation
10745 .cindex "IP address" "canonical form"
10746 This converts an IPv6 address to canonical form.
10747 Leading zeroes of groups are omitted, and the longest
10748 set of zero-valued groups is replaced with a double colon.
10749 A trailing ipv4-style dotted-decimal set is converted to hex.
10750 Pure IPv4 addresses are converted to IPv4-mapped IPv6.
10751
10752
10753 .vitem &*${lc:*&<&'string'&>&*}*&
10754 .cindex "case forcing in strings"
10755 .cindex "string" "case forcing"
10756 .cindex "lower casing"
10757 .cindex "expansion" "case forcing"
10758 .cindex "&%lc%& expansion item"
10759 This forces the letters in the string into lower-case, for example:
10760 .code
10761 ${lc:$local_part}
10762 .endd
10763 Case is defined per the system C locale.
10764
10765 .vitem &*${length_*&<&'number'&>&*:*&<&'string'&>&*}*&
10766 .cindex "expansion" "string truncation"
10767 .cindex "&%length%& expansion item"
10768 The &%length%& operator is a simpler interface to the &%length%& function that
10769 can be used when the parameter is a fixed number (as opposed to a string that
10770 changes when expanded). The effect is the same as
10771 .code
10772 ${length{<number>}{<string>}}
10773 .endd
10774 See the description of the general &%length%& item above for details. Note that
10775 &%length%& is not the same as &%strlen%&. The abbreviation &%l%& can be used
10776 when &%length%& is used as an operator.
10777 All measurement is done in bytes and is not UTF-8 aware.
10778
10779
10780 .vitem &*${listcount:*&<&'string'&>&*}*&
10781 .cindex "expansion" "list item count"
10782 .cindex "list" "item count"
10783 .cindex "list" "count of items"
10784 .cindex "&%listcount%& expansion item"
10785 The string is interpreted as a list and the number of items is returned.
10786
10787
10788 .vitem &*${listnamed:*&<&'name'&>&*}*&&~and&~&*${listnamed_*&<&'type'&>&*:*&<&'name'&>&*}*&
10789 .cindex "expansion" "named list"
10790 .cindex "&%listnamed%& expansion item"
10791 The name is interpreted as a named list and the content of the list is returned,
10792 expanding any referenced lists, re-quoting as needed for colon-separation.
10793 If the optional type is given it must be one of "a", "d", "h" or "l"
10794 and selects address-, domain-, host- or localpart- lists to search among respectively.
10795 Otherwise all types are searched in an undefined order and the first
10796 matching list is returned.
10797
10798
10799 .vitem &*${local_part:*&<&'string'&>&*}*&
10800 .cindex "expansion" "local part extraction"
10801 .cindex "&%local_part%& expansion item"
10802 The string is interpreted as an RFC 2822 address and the local part is
10803 extracted from it. If the string does not parse successfully, the result is
10804 empty.
10805 The parsing correctly handles SMTPUTF8 Unicode in the string.
10806
10807
10808 .vitem &*${mask:*&<&'IP&~address'&>&*/*&<&'bit&~count'&>&*}*&
10809 .cindex "masked IP address"
10810 .cindex "IP address" "masking"
10811 .cindex "CIDR notation"
10812 .cindex "expansion" "IP address masking"
10813 .cindex "&%mask%& expansion item"
10814 If the form of the string to be operated on is not an IP address followed by a
10815 slash and an integer (that is, a network address in CIDR notation), the
10816 expansion fails. Otherwise, this operator converts the IP address to binary,
10817 masks off the least significant bits according to the bit count, and converts
10818 the result back to text, with mask appended. For example,
10819 .code
10820 ${mask:10.111.131.206/28}
10821 .endd
10822 returns the string &"10.111.131.192/28"&. Since this operation is expected to
10823 be mostly used for looking up masked addresses in files, the result for an IPv6
10824 address uses dots to separate components instead of colons, because colon
10825 terminates a key string in lsearch files. So, for example,
10826 .code
10827 ${mask:3ffe:ffff:836f:0a00:000a:0800:200a:c031/99}
10828 .endd
10829 returns the string
10830 .code
10831 3ffe.ffff.836f.0a00.000a.0800.2000.0000/99
10832 .endd
10833 Letters in IPv6 addresses are always output in lower case.
10834
10835
10836 .vitem &*${md5:*&<&'string'&>&*}*&
10837 .cindex "MD5 hash"
10838 .cindex "expansion" "MD5 hash"
10839 .cindex certificate fingerprint
10840 .cindex "&%md5%& expansion item"
10841 The &%md5%& operator computes the MD5 hash value of the string, and returns it
10842 as a 32-digit hexadecimal number, in which any letters are in lower case.
10843
10844 If the string is a single variable of type certificate,
10845 returns the MD5 hash fingerprint of the certificate.
10846
10847
10848 .vitem &*${nhash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
10849 .cindex "expansion" "numeric hash"
10850 .cindex "hash function" "numeric"
10851 The &%nhash%& operator is a simpler interface to the numeric hashing function
10852 that can be used when the two parameters are fixed numbers (as opposed to
10853 strings that change when expanded). The effect is the same as
10854 .code
10855 ${nhash{<n>}{<m>}{<string>}}
10856 .endd
10857 See the description of the general &%nhash%& item above for details.
10858
10859
10860 .vitem &*${quote:*&<&'string'&>&*}*&
10861 .cindex "quoting" "in string expansions"
10862 .cindex "expansion" "quoting"
10863 .cindex "&%quote%& expansion item"
10864 The &%quote%& operator puts its argument into double quotes if it
10865 is an empty string or
10866 contains anything other than letters, digits, underscores, dots, and hyphens.
10867 Any occurrences of double quotes and backslashes are escaped with a backslash.
10868 Newlines and carriage returns are converted to &`\n`& and &`\r`&,
10869 respectively For example,
10870 .code
10871 ${quote:ab"*"cd}
10872 .endd
10873 becomes
10874 .code
10875 "ab\"*\"cd"
10876 .endd
10877 The place where this is useful is when the argument is a substitution from a
10878 variable or a message header.
10879
10880 .vitem &*${quote_local_part:*&<&'string'&>&*}*&
10881 .cindex "&%quote_local_part%& expansion item"
10882 This operator is like &%quote%&, except that it quotes the string only if
10883 required to do so by the rules of RFC 2822 for quoting local parts. For
10884 example, a plus sign would not cause quoting (but it would for &%quote%&).
10885 If you are creating a new email address from the contents of &$local_part$&
10886 (or any other unknown data), you should always use this operator.
10887
10888 This quoting determination is not SMTPUTF8-aware, thus quoting non-ASCII data
10889 will likely use the quoting form.
10890 Thus &'${quote_local_part:フィル}'& will always become &'"フィル"'&.
10891
10892
10893 .vitem &*${quote_*&<&'lookup-type'&>&*:*&<&'string'&>&*}*&
10894 .cindex "quoting" "lookup-specific"
10895 This operator applies lookup-specific quoting rules to the string. Each
10896 query-style lookup type has its own quoting rules which are described with
10897 the lookups in chapter &<<CHAPfdlookup>>&. For example,
10898 .code
10899 ${quote_ldap:two * two}
10900 .endd
10901 returns
10902 .code
10903 two%20%5C2A%20two
10904 .endd
10905 For single-key lookup types, no quoting is ever necessary and this operator
10906 yields an unchanged string.
10907
10908
10909 .vitem &*${randint:*&<&'n'&>&*}*&
10910 .cindex "random number"
10911 This operator returns a somewhat random number which is less than the
10912 supplied number and is at least 0.  The quality of this randomness depends
10913 on how Exim was built; the values are not suitable for keying material.
10914 If Exim is linked against OpenSSL then RAND_pseudo_bytes() is used.
10915 If Exim is linked against GnuTLS then gnutls_rnd(GNUTLS_RND_NONCE) is used,
10916 for versions of GnuTLS with that function.
10917 Otherwise, the implementation may be arc4random(), random() seeded by
10918 srandomdev() or srandom(), or a custom implementation even weaker than
10919 random().
10920
10921
10922 .vitem &*${reverse_ip:*&<&'ipaddr'&>&*}*&
10923 .cindex "expansion" "IP address"
10924 This operator reverses an IP address; for IPv4 addresses, the result is in
10925 dotted-quad decimal form, while for IPv6 addresses the result is in
10926 dotted-nibble hexadecimal form.  In both cases, this is the "natural" form
10927 for DNS.  For example,
10928 .code
10929 ${reverse_ip:192.0.2.4}
10930 ${reverse_ip:2001:0db8:c42:9:1:abcd:192.0.2.127}
10931 .endd
10932 returns
10933 .code
10934 4.2.0.192
10935 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
10936 .endd
10937
10938
10939 .vitem &*${rfc2047:*&<&'string'&>&*}*&
10940 .cindex "expansion" "RFC 2047"
10941 .cindex "RFC 2047" "expansion operator"
10942 .cindex "&%rfc2047%& expansion item"
10943 This operator encodes text according to the rules of RFC 2047. This is an
10944 encoding that is used in header lines to encode non-ASCII characters. It is
10945 assumed that the input string is in the encoding specified by the
10946 &%headers_charset%& option, which gets its default at build time. If the string
10947 contains only characters in the range 33&--126, and no instances of the
10948 characters
10949 .code
10950 ? = ( ) < > @ , ; : \ " . [ ] _
10951 .endd
10952 it is not modified. Otherwise, the result is the RFC 2047 encoding of the
10953 string, using as many &"encoded words"& as necessary to encode all the
10954 characters.
10955
10956
10957 .vitem &*${rfc2047d:*&<&'string'&>&*}*&
10958 .cindex "expansion" "RFC 2047"
10959 .cindex "RFC 2047" "decoding"
10960 .cindex "&%rfc2047d%& expansion item"
10961 This operator decodes strings that are encoded as per RFC 2047. Binary zero
10962 bytes are replaced by question marks. Characters are converted into the
10963 character set defined by &%headers_charset%&. Overlong RFC 2047 &"words"& are
10964 not recognized unless &%check_rfc2047_length%& is set false.
10965
10966 &*Note*&: If you use &%$header%&_&'xxx'&&*:*& (or &%$h%&_&'xxx'&&*:*&) to
10967 access a header line, RFC 2047 decoding is done automatically. You do not need
10968 to use this operator as well.
10969
10970
10971
10972 .vitem &*${rxquote:*&<&'string'&>&*}*&
10973 .cindex "quoting" "in regular expressions"
10974 .cindex "regular expressions" "quoting"
10975 .cindex "&%rxquote%& expansion item"
10976 The &%rxquote%& operator inserts a backslash before any non-alphanumeric
10977 characters in its argument. This is useful when substituting the values of
10978 variables or headers inside regular expressions.
10979
10980
10981 .vitem &*${sha1:*&<&'string'&>&*}*&
10982 .cindex "SHA-1 hash"
10983 .cindex "expansion" "SHA-1 hashing"
10984 .cindex certificate fingerprint
10985 .cindex "&%sha1%& expansion item"
10986 The &%sha1%& operator computes the SHA-1 hash value of the string, and returns
10987 it as a 40-digit hexadecimal number, in which any letters are in upper case.
10988
10989 If the string is a single variable of type certificate,
10990 returns the SHA-1 hash fingerprint of the certificate.
10991
10992
10993 .vitem &*${sha256:*&<&'string'&>&*}*& &&&
10994        &*${sha2:*&<&'string'&>&*}*& &&&
10995        &*${sha2_<n>:*&<&'string'&>&*}*&
10996 .cindex "SHA-256 hash"
10997 .cindex "SHA-2 hash"
10998 .cindex certificate fingerprint
10999 .cindex "expansion" "SHA-256 hashing"
11000 .cindex "&%sha256%& expansion item"
11001 .cindex "&%sha2%& expansion item"
11002 The &%sha256%& operator computes the SHA-256 hash value of the string
11003 and returns
11004 it as a 64-digit hexadecimal number, in which any letters are in upper case.
11005
11006 If the string is a single variable of type certificate,
11007 returns the SHA-256 hash fingerprint of the certificate.
11008
11009 .new
11010 The operator can also be spelled &%sha2%& and does the same as &%sha256%&
11011 (except for certificates, which are not supported).
11012 Finally, if an underbar
11013 and a number is appended it specifies the output length, selecting a
11014 member of the SHA-2 family of hash functions.
11015 Values of 256, 384 and 512 are accepted, with 256 being the default.
11016 .wen
11017
11018
11019 .vitem &*${sha3:*&<&'string'&>&*}*& &&&
11020        &*${sha3_<n>:*&<&'string'&>&*}*&
11021 .cindex "SHA3 hash"
11022 .cindex "expansion" "SHA3 hashing"
11023 .cindex "&%sha3%& expansion item"
11024 The &%sha3%& operator computes the SHA3-256 hash value of the string
11025 and returns
11026 it as a 64-digit hexadecimal number, in which any letters are in upper case.
11027
11028 If a number is appended, separated by an underbar, it specifies
11029 the output length.  Values of 224, 256, 384 and 512 are accepted;
11030 with 256 being the default.
11031
11032 The &%sha3%& expansion item is only supported if Exim has been
11033 compiled with GnuTLS 3.5.0 or later,
11034 or OpenSSL 1.1.1 or later.
11035 The macro "_CRYPTO_HASH_SHA3" will be defined if it is supported.
11036
11037
11038 .vitem &*${stat:*&<&'string'&>&*}*&
11039 .cindex "expansion" "statting a file"
11040 .cindex "file" "extracting characteristics"
11041 .cindex "&%stat%& expansion item"
11042 The string, after expansion, must be a file path. A call to the &[stat()]&
11043 function is made for this path. If &[stat()]& fails, an error occurs and the
11044 expansion fails. If it succeeds, the data from the stat replaces the item, as a
11045 series of <&'name'&>=<&'value'&> pairs, where the values are all numerical,
11046 except for the value of &"smode"&. The names are: &"mode"& (giving the mode as
11047 a 4-digit octal number), &"smode"& (giving the mode in symbolic format as a
11048 10-character string, as for the &'ls'& command), &"inode"&, &"device"&,
11049 &"links"&, &"uid"&, &"gid"&, &"size"&, &"atime"&, &"mtime"&, and &"ctime"&. You
11050 can extract individual fields using the &%extract%& expansion item.
11051
11052 The use of the &%stat%& expansion in users' filter files can be locked out by
11053 the system administrator. &*Warning*&: The file size may be incorrect on 32-bit
11054 systems for files larger than 2GB.
11055
11056 .vitem &*${str2b64:*&<&'string'&>&*}*&
11057 .cindex "&%str2b64%& expansion item"
11058 Now deprecated, a synonym for the &%base64%& expansion operator.
11059
11060
11061
11062 .vitem &*${strlen:*&<&'string'&>&*}*&
11063 .cindex "expansion" "string length"
11064 .cindex "string" "length in expansion"
11065 .cindex "&%strlen%& expansion item"
11066 The item is replace by the length of the expanded string, expressed as a
11067 decimal number. &*Note*&: Do not confuse &%strlen%& with &%length%&.
11068 All measurement is done in bytes and is not UTF-8 aware.
11069
11070
11071 .vitem &*${substr_*&<&'start'&>&*_*&<&'length'&>&*:*&<&'string'&>&*}*&
11072 .cindex "&%substr%& expansion item"
11073 .cindex "substring extraction"
11074 .cindex "expansion" "substring expansion"
11075 The &%substr%& operator is a simpler interface to the &%substr%& function that
11076 can be used when the two parameters are fixed numbers (as opposed to strings
11077 that change when expanded). The effect is the same as
11078 .code
11079 ${substr{<start>}{<length>}{<string>}}
11080 .endd
11081 See the description of the general &%substr%& item above for details. The
11082 abbreviation &%s%& can be used when &%substr%& is used as an operator.
11083 All measurement is done in bytes and is not UTF-8 aware.
11084
11085 .vitem &*${time_eval:*&<&'string'&>&*}*&
11086 .cindex "&%time_eval%& expansion item"
11087 .cindex "time interval" "decoding"
11088 This item converts an Exim time interval such as &`2d4h5m`& into a number of
11089 seconds.
11090
11091 .vitem &*${time_interval:*&<&'string'&>&*}*&
11092 .cindex "&%time_interval%& expansion item"
11093 .cindex "time interval" "formatting"
11094 The argument (after sub-expansion) must be a sequence of decimal digits that
11095 represents an interval of time as a number of seconds. It is converted into a
11096 number of larger units and output in Exim's normal time format, for example,
11097 &`1w3d4h2m6s`&.
11098
11099 .vitem &*${uc:*&<&'string'&>&*}*&
11100 .cindex "case forcing in strings"
11101 .cindex "string" "case forcing"
11102 .cindex "upper casing"
11103 .cindex "expansion" "case forcing"
11104 .cindex "&%uc%& expansion item"
11105 This forces the letters in the string into upper-case.
11106 Case is defined per the system C locale.
11107
11108 .vitem &*${utf8clean:*&<&'string'&>&*}*&
11109 .cindex "correction of invalid utf-8 sequences in strings"
11110 .cindex "utf-8" "utf-8 sequences"
11111 .cindex "incorrect utf-8"
11112 .cindex "expansion" "utf-8 forcing"
11113 .cindex "&%utf8clean%& expansion item"
11114 This replaces any invalid utf-8 sequence in the string by the character &`?`&.
11115 In versions of Exim before 4.92, this did not correctly do so for a truncated
11116 final codepoint's encoding, and the character would be silently dropped.
11117 If you must handle detection of this scenario across both sets of Exim behavior,
11118 the complexity will depend upon the task.
11119 For instance, to detect if the first character is multibyte and a 1-byte
11120 extraction can be successfully used as a path component (as is common for
11121 dividing up delivery folders), you might use:
11122 .code
11123 condition = ${if inlist{${utf8clean:${length_1:$local_part}}}{:?}{yes}{no}}
11124 .endd
11125 (which will false-positive if the first character of the local part is a
11126 literal question mark).
11127
11128 .vitem "&*${utf8_domain_to_alabel:*&<&'string'&>&*}*&" &&&
11129        "&*${utf8_domain_from_alabel:*&<&'string'&>&*}*&" &&&
11130        "&*${utf8_localpart_to_alabel:*&<&'string'&>&*}*&" &&&
11131        "&*${utf8_localpart_from_alabel:*&<&'string'&>&*}*&"
11132 .cindex expansion UTF-8
11133 .cindex UTF-8 expansion
11134 .cindex EAI
11135 .cindex internationalisation
11136 .cindex "&%utf8_domain_to_alabel%& expansion item"
11137 .cindex "&%utf8_domain_from_alabel%& expansion item"
11138 .cindex "&%utf8_localpart_to_alabel%& expansion item"
11139 .cindex "&%utf8_localpart_from_alabel%& expansion item"
11140 These convert EAI mail name components between UTF-8 and a-label forms.
11141 For information on internationalisation support see &<<SECTi18nMTA>>&.
11142 .endlist
11143
11144
11145
11146
11147
11148
11149 .section "Expansion conditions" "SECTexpcond"
11150 .scindex IIDexpcond "expansion" "conditions"
11151 The following conditions are available for testing by the &%${if%& construct
11152 while expanding strings:
11153
11154 .vlist
11155 .vitem &*!*&<&'condition'&>
11156 .cindex "expansion" "negating a condition"
11157 .cindex "negation" "in expansion condition"
11158 Preceding any condition with an exclamation mark negates the result of the
11159 condition.
11160
11161 .vitem <&'symbolic&~operator'&>&~&*{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11162 .cindex "numeric comparison"
11163 .cindex "expansion" "numeric comparison"
11164 There are a number of symbolic operators for doing numeric comparisons. They
11165 are:
11166 .display
11167 &`=   `&   equal
11168 &`==  `&   equal
11169 &`>   `&   greater
11170 &`>=  `&   greater or equal
11171 &`<   `&   less
11172 &`<=  `&   less or equal
11173 .endd
11174 For example:
11175 .code
11176 ${if >{$message_size}{10M} ...
11177 .endd
11178 Note that the general negation operator provides for inequality testing. The
11179 two strings must take the form of optionally signed decimal integers,
11180 optionally followed by one of the letters &"K"&, &"M"& or &"G"& (in either upper or
11181 lower case), signifying multiplication by 1024, 1024*1024 or 1024*1024*1024, respectively.
11182 As a special case, the numerical value of an empty string is taken as
11183 zero.
11184
11185 In all cases, a relative comparator OP is testing if <&'string1'&> OP
11186 <&'string2'&>; the above example is checking if &$message_size$& is larger than
11187 10M, not if 10M is larger than &$message_size$&.
11188
11189
11190 .vitem &*acl&~{{*&<&'name'&>&*}{*&<&'arg1'&>&*}&&&
11191         {*&<&'arg2'&>&*}...}*&
11192 .cindex "expansion" "calling an acl"
11193 .cindex "&%acl%&" "expansion condition"
11194 The name and zero to nine argument strings are first expanded separately.  The expanded
11195 arguments are assigned to the variables &$acl_arg1$& to &$acl_arg9$& in order.
11196 Any unused are made empty.  The variable &$acl_narg$& is set to the number of
11197 arguments.  The named ACL (see chapter &<<CHAPACL>>&) is called
11198 and may use the variables; if another acl expansion is used the values
11199 are restored after it returns.  If the ACL sets
11200 a value using a "message =" modifier the variable $value becomes
11201 the result of the expansion, otherwise it is empty.
11202 If the ACL returns accept the condition is true; if deny, false.
11203 If the ACL returns defer the result is a forced-fail.
11204
11205 .vitem &*bool&~{*&<&'string'&>&*}*&
11206 .cindex "expansion" "boolean parsing"
11207 .cindex "&%bool%& expansion condition"
11208 This condition turns a string holding a true or false representation into
11209 a boolean state.  It parses &"true"&, &"false"&, &"yes"& and &"no"&
11210 (case-insensitively); also integer numbers map to true if non-zero,
11211 false if zero.
11212 An empty string is treated as false.
11213 Leading and trailing whitespace is ignored;
11214 thus a string consisting only of whitespace is false.
11215 All other string values will result in expansion failure.
11216
11217 When combined with ACL variables, this expansion condition will let you
11218 make decisions in one place and act on those decisions in another place.
11219 For example:
11220 .code
11221 ${if bool{$acl_m_privileged_sender} ...
11222 .endd
11223
11224
11225 .vitem &*bool_lax&~{*&<&'string'&>&*}*&
11226 .cindex "expansion" "boolean parsing"
11227 .cindex "&%bool_lax%& expansion condition"
11228 Like &%bool%&, this condition turns a string into a boolean state.  But
11229 where &%bool%& accepts a strict set of strings, &%bool_lax%& uses the same
11230 loose definition that the Router &%condition%& option uses.  The empty string
11231 and the values &"false"&, &"no"& and &"0"& map to false, all others map to
11232 true.  Leading and trailing whitespace is ignored.
11233
11234 Note that where &"bool{00}"& is false, &"bool_lax{00}"& is true.
11235
11236 .vitem &*crypteq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11237 .cindex "expansion" "encrypted comparison"
11238 .cindex "encrypted strings, comparing"
11239 .cindex "&%crypteq%& expansion condition"
11240 This condition is included in the Exim binary if it is built to support any
11241 authentication mechanisms (see chapter &<<CHAPSMTPAUTH>>&). Otherwise, it is
11242 necessary to define SUPPORT_CRYPTEQ in &_Local/Makefile_& to get &%crypteq%&
11243 included in the binary.
11244
11245 The &%crypteq%& condition has two arguments. The first is encrypted and
11246 compared against the second, which is already encrypted. The second string may
11247 be in the LDAP form for storing encrypted strings, which starts with the
11248 encryption type in curly brackets, followed by the data. If the second string
11249 does not begin with &"{"& it is assumed to be encrypted with &[crypt()]& or
11250 &[crypt16()]& (see below), since such strings cannot begin with &"{"&.
11251 Typically this will be a field from a password file. An example of an encrypted
11252 string in LDAP form is:
11253 .code
11254 {md5}CY9rzUYh03PK3k6DJie09g==
11255 .endd
11256 If such a string appears directly in an expansion, the curly brackets have to
11257 be quoted, because they are part of the expansion syntax. For example:
11258 .code
11259 ${if crypteq {test}{\{md5\}CY9rzUYh03PK3k6DJie09g==}{yes}{no}}
11260 .endd
11261 The following encryption types (whose names are matched case-independently) are
11262 supported:
11263
11264 .ilist
11265 .cindex "MD5 hash"
11266 .cindex "base64 encoding" "in encrypted password"
11267 &%{md5}%& computes the MD5 digest of the first string, and expresses this as
11268 printable characters to compare with the remainder of the second string. If the
11269 length of the comparison string is 24, Exim assumes that it is base64 encoded
11270 (as in the above example). If the length is 32, Exim assumes that it is a
11271 hexadecimal encoding of the MD5 digest. If the length not 24 or 32, the
11272 comparison fails.
11273
11274 .next
11275 .cindex "SHA-1 hash"
11276 &%{sha1}%& computes the SHA-1 digest of the first string, and expresses this as
11277 printable characters to compare with the remainder of the second string. If the
11278 length of the comparison string is 28, Exim assumes that it is base64 encoded.
11279 If the length is 40, Exim assumes that it is a hexadecimal encoding of the
11280 SHA-1 digest. If the length is not 28 or 40, the comparison fails.
11281
11282 .next
11283 .cindex "&[crypt()]&"
11284 &%{crypt}%& calls the &[crypt()]& function, which traditionally used to use
11285 only the first eight characters of the password. However, in modern operating
11286 systems this is no longer true, and in many cases the entire password is used,
11287 whatever its length.
11288
11289 .next
11290 .cindex "&[crypt16()]&"
11291 &%{crypt16}%& calls the &[crypt16()]& function, which was originally created to
11292 use up to 16 characters of the password in some operating systems. Again, in
11293 modern operating systems, more characters may be used.
11294 .endlist
11295 Exim has its own version of &[crypt16()]&, which is just a double call to
11296 &[crypt()]&. For operating systems that have their own version, setting
11297 HAVE_CRYPT16 in &_Local/Makefile_& when building Exim causes it to use the
11298 operating system version instead of its own. This option is set by default in
11299 the OS-dependent &_Makefile_& for those operating systems that are known to
11300 support &[crypt16()]&.
11301
11302 Some years after Exim's &[crypt16()]& was implemented, a user discovered that
11303 it was not using the same algorithm as some operating systems' versions. It
11304 turns out that as well as &[crypt16()]& there is a function called
11305 &[bigcrypt()]& in some operating systems. This may or may not use the same
11306 algorithm, and both of them may be different to Exim's built-in &[crypt16()]&.
11307
11308 However, since there is now a move away from the traditional &[crypt()]&
11309 functions towards using SHA1 and other algorithms, tidying up this area of
11310 Exim is seen as very low priority.
11311
11312 If you do not put a encryption type (in curly brackets) in a &%crypteq%&
11313 comparison, the default is usually either &`{crypt}`& or &`{crypt16}`&, as
11314 determined by the setting of DEFAULT_CRYPT in &_Local/Makefile_&. The default
11315 default is &`{crypt}`&. Whatever the default, you can always use either
11316 function by specifying it explicitly in curly brackets.
11317
11318 .vitem &*def:*&<&'variable&~name'&>
11319 .cindex "expansion" "checking for empty variable"
11320 .cindex "&%def%& expansion condition"
11321 The &%def%& condition must be followed by the name of one of the expansion
11322 variables defined in section &<<SECTexpvar>>&. The condition is true if the
11323 variable does not contain the empty string. For example:
11324 .code
11325 ${if def:sender_ident {from $sender_ident}}
11326 .endd
11327 Note that the variable name is given without a leading &%$%& character. If the
11328 variable does not exist, the expansion fails.
11329
11330 .vitem "&*def:header_*&<&'header&~name'&>&*:*&&~&~or&~&&&
11331         &~&*def:h_*&<&'header&~name'&>&*:*&"
11332 .cindex "expansion" "checking header line existence"
11333 This condition is true if a message is being processed and the named header
11334 exists in the message. For example,
11335 .code
11336 ${if def:header_reply-to:{$h_reply-to:}{$h_from:}}
11337 .endd
11338 &*Note*&: No &%$%& appears before &%header_%& or &%h_%& in the condition, and
11339 the header name must be terminated by a colon if white space does not follow.
11340
11341 .vitem &*eq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11342        &*eqi&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11343 .cindex "string" "comparison"
11344 .cindex "expansion" "string comparison"
11345 .cindex "&%eq%& expansion condition"
11346 .cindex "&%eqi%& expansion condition"
11347 The two substrings are first expanded. The condition is true if the two
11348 resulting strings are identical. For &%eq%& the comparison includes the case of
11349 letters, whereas for &%eqi%& the comparison is case-independent, where
11350 case is defined per the system C locale.
11351
11352 .vitem &*exists&~{*&<&'file&~name'&>&*}*&
11353 .cindex "expansion" "file existence test"
11354 .cindex "file" "existence test"
11355 .cindex "&%exists%&, expansion condition"
11356 The substring is first expanded and then interpreted as an absolute path. The
11357 condition is true if the named file (or directory) exists. The existence test
11358 is done by calling the &[stat()]& function. The use of the &%exists%& test in
11359 users' filter files may be locked out by the system administrator.
11360
11361 .vitem &*first_delivery*&
11362 .cindex "delivery" "first"
11363 .cindex "first delivery"
11364 .cindex "expansion" "first delivery test"
11365 .cindex "&%first_delivery%& expansion condition"
11366 This condition, which has no data, is true during a message's first delivery
11367 attempt. It is false during any subsequent delivery attempts.
11368
11369
11370 .vitem "&*forall{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&" &&&
11371        "&*forany{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&"
11372 .cindex "list" "iterative conditions"
11373 .cindex "expansion" "&*forall*& condition"
11374 .cindex "expansion" "&*forany*& condition"
11375 .vindex "&$item$&"
11376 These conditions iterate over a list. The first argument is expanded to form
11377 the list. By default, the list separator is a colon, but it can be changed by
11378 the normal method (&<<SECTlistsepchange>>&).
11379 The second argument is interpreted as a condition that is to
11380 be applied to each item in the list in turn. During the interpretation of the
11381 condition, the current list item is placed in a variable called &$item$&.
11382 .ilist
11383 For &*forany*&, interpretation stops if the condition is true for any item, and
11384 the result of the whole condition is true. If the condition is false for all
11385 items in the list, the overall condition is false.
11386 .next
11387 For &*forall*&, interpretation stops if the condition is false for any item,
11388 and the result of the whole condition is false. If the condition is true for
11389 all items in the list, the overall condition is true.
11390 .endlist
11391 Note that negation of &*forany*& means that the condition must be false for all
11392 items for the overall condition to succeed, and negation of &*forall*& means
11393 that the condition must be false for at least one item. In this example, the
11394 list separator is changed to a comma:
11395 .code
11396 ${if forany{<, $recipients}{match{$item}{^user3@}}{yes}{no}}
11397 .endd
11398 The value of &$item$& is saved and restored while &%forany%& or &%forall%& is
11399 being processed, to enable these expansion items to be nested.
11400
11401 To scan a named list, expand it with the &*listnamed*& operator.
11402
11403 .new
11404 .vitem "&*forall_json{*&<&'a JSON array'&>&*}{*&<&'a condition'&>&*}*&" &&&
11405        "&*forany_json{*&<&'a JSON array'&>&*}{*&<&'a condition'&>&*}*&" &&&
11406        "&*forall_jsons{*&<&'a JSON array'&>&*}{*&<&'a condition'&>&*}*&" &&&
11407        "&*forany_jsons{*&<&'a JSON array'&>&*}{*&<&'a condition'&>&*}*&"
11408 .cindex JSON "iterative conditions"
11409 .cindex JSON expansions
11410 .cindex expansion "&*forall_json*& condition"
11411 .cindex expansion "&*forany_json*& condition"
11412 .cindex expansion "&*forall_jsons*& condition"
11413 .cindex expansion "&*forany_jsons*& condition"
11414 As for the above, except that the first argument must, after expansion,
11415 be a JSON array.
11416 The array separator is not changeable.
11417 For the &"jsons"& variants the elements are expected to be JSON strings
11418 and have their quotes removed before the evaluation of the condition.
11419 .wen
11420
11421
11422
11423 .vitem &*ge&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11424        &*gei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11425 .cindex "string" "comparison"
11426 .cindex "expansion" "string comparison"
11427 .cindex "&%ge%& expansion condition"
11428 .cindex "&%gei%& expansion condition"
11429 The two substrings are first expanded. The condition is true if the first
11430 string is lexically greater than or equal to the second string. For &%ge%& the
11431 comparison includes the case of letters, whereas for &%gei%& the comparison is
11432 case-independent.
11433 Case and collation order are defined per the system C locale.
11434
11435 .vitem &*gt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11436        &*gti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11437 .cindex "string" "comparison"
11438 .cindex "expansion" "string comparison"
11439 .cindex "&%gt%& expansion condition"
11440 .cindex "&%gti%& expansion condition"
11441 The two substrings are first expanded. The condition is true if the first
11442 string is lexically greater than the second string. For &%gt%& the comparison
11443 includes the case of letters, whereas for &%gti%& the comparison is
11444 case-independent.
11445 Case and collation order are defined per the system C locale.
11446
11447 .vitem &*inlist&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11448        &*inlisti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11449 .cindex "string" "comparison"
11450 .cindex "list" "iterative conditions"
11451 Both strings are expanded; the second string is treated as a list of simple
11452 strings; if the first string is a member of the second, then the condition
11453 is true.
11454 For the case-independent &%inlisti%& condition, case is defined per the system C locale.
11455
11456 These are simpler to use versions of the more powerful &*forany*& condition.
11457 Examples, and the &*forany*& equivalents:
11458 .code
11459 ${if inlist{needle}{foo:needle:bar}}
11460   ${if forany{foo:needle:bar}{eq{$item}{needle}}}
11461 ${if inlisti{Needle}{fOo:NeeDLE:bAr}}
11462   ${if forany{fOo:NeeDLE:bAr}{eqi{$item}{Needle}}}
11463 .endd
11464
11465 .vitem &*isip&~{*&<&'string'&>&*}*&  &&&
11466        &*isip4&~{*&<&'string'&>&*}*& &&&
11467        &*isip6&~{*&<&'string'&>&*}*&
11468 .cindex "IP address" "testing string format"
11469 .cindex "string" "testing for IP address"
11470 .cindex "&%isip%& expansion condition"
11471 .cindex "&%isip4%& expansion condition"
11472 .cindex "&%isip6%& expansion condition"
11473 The substring is first expanded, and then tested to see if it has the form of
11474 an IP address. Both IPv4 and IPv6 addresses are valid for &%isip%&, whereas
11475 &%isip4%& and &%isip6%& test specifically for IPv4 or IPv6 addresses.
11476
11477 For an IPv4 address, the test is for four dot-separated components, each of
11478 which consists of from one to three digits. For an IPv6 address, up to eight
11479 colon-separated components are permitted, each containing from one to four
11480 hexadecimal digits. There may be fewer than eight components if an empty
11481 component (adjacent colons) is present. Only one empty component is permitted.
11482
11483 &*Note*&: The checks used to be just on the form of the address; actual numerical
11484 values were not considered. Thus, for example, 999.999.999.999 passed the IPv4
11485 check.
11486 This is no longer the case.
11487
11488 The main use of these tests is to distinguish between IP addresses and
11489 host names, or between IPv4 and IPv6 addresses. For example, you could use
11490 .code
11491 ${if isip4{$sender_host_address}...
11492 .endd
11493 to test which IP version an incoming SMTP connection is using.
11494
11495 .vitem &*ldapauth&~{*&<&'ldap&~query'&>&*}*&
11496 .cindex "LDAP" "use for authentication"
11497 .cindex "expansion" "LDAP authentication test"
11498 .cindex "&%ldapauth%& expansion condition"
11499 This condition supports user authentication using LDAP. See section
11500 &<<SECTldap>>& for details of how to use LDAP in lookups and the syntax of
11501 queries. For this use, the query must contain a user name and password. The
11502 query itself is not used, and can be empty. The condition is true if the
11503 password is not empty, and the user name and password are accepted by the LDAP
11504 server. An empty password is rejected without calling LDAP because LDAP binds
11505 with an empty password are considered anonymous regardless of the username, and
11506 will succeed in most configurations. See chapter &<<CHAPSMTPAUTH>>& for details
11507 of SMTP authentication, and chapter &<<CHAPplaintext>>& for an example of how
11508 this can be used.
11509
11510
11511 .vitem &*le&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11512        &*lei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11513 .cindex "string" "comparison"
11514 .cindex "expansion" "string comparison"
11515 .cindex "&%le%& expansion condition"
11516 .cindex "&%lei%& expansion condition"
11517 The two substrings are first expanded. The condition is true if the first
11518 string is lexically less than or equal to the second string. For &%le%& the
11519 comparison includes the case of letters, whereas for &%lei%& the comparison is
11520 case-independent.
11521 Case and collation order are defined per the system C locale.
11522
11523 .vitem &*lt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11524        &*lti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11525 .cindex "string" "comparison"
11526 .cindex "expansion" "string comparison"
11527 .cindex "&%lt%& expansion condition"
11528 .cindex "&%lti%& expansion condition"
11529 The two substrings are first expanded. The condition is true if the first
11530 string is lexically less than the second string. For &%lt%& the comparison
11531 includes the case of letters, whereas for &%lti%& the comparison is
11532 case-independent.
11533 Case and collation order are defined per the system C locale.
11534
11535
11536 .vitem &*match&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11537 .cindex "expansion" "regular expression comparison"
11538 .cindex "regular expressions" "match in expanded string"
11539 .cindex "&%match%& expansion condition"
11540 The two substrings are first expanded. The second is then treated as a regular
11541 expression and applied to the first. Because of the pre-expansion, if the
11542 regular expression contains dollar, or backslash characters, they must be
11543 escaped. Care must also be taken if the regular expression contains braces
11544 (curly brackets). A closing brace must be escaped so that it is not taken as a
11545 premature termination of <&'string2'&>. The easiest approach is to use the
11546 &`\N`& feature to disable expansion of the regular expression.
11547 For example,
11548 .code
11549 ${if match {$local_part}{\N^\d{3}\N} ...
11550 .endd
11551 If the whole expansion string is in double quotes, further escaping of
11552 backslashes is also required.
11553
11554 The condition is true if the regular expression match succeeds.
11555 The regular expression is not required to begin with a circumflex
11556 metacharacter, but if there is no circumflex, the expression is not anchored,
11557 and it may match anywhere in the subject, not just at the start. If you want
11558 the pattern to match at the end of the subject, you must include the &`$`&
11559 metacharacter at an appropriate point.
11560 All character handling is done in bytes and is not UTF-8 aware,
11561 but we might change this in a future Exim release.
11562
11563 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%if%& expansion"
11564 At the start of an &%if%& expansion the values of the numeric variable
11565 substitutions &$1$& etc. are remembered. Obeying a &%match%& condition that
11566 succeeds causes them to be reset to the substrings of that condition and they
11567 will have these values during the expansion of the success string. At the end
11568 of the &%if%& expansion, the previous values are restored. After testing a
11569 combination of conditions using &%or%&, the subsequent values of the numeric
11570 variables are those of the condition that succeeded.
11571
11572 .vitem &*match_address&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11573 .cindex "&%match_address%& expansion condition"
11574 See &*match_local_part*&.
11575
11576 .vitem &*match_domain&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11577 .cindex "&%match_domain%& expansion condition"
11578 See &*match_local_part*&.
11579
11580 .vitem &*match_ip&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11581 .cindex "&%match_ip%& expansion condition"
11582 This condition matches an IP address to a list of IP address patterns. It must
11583 be followed by two argument strings. The first (after expansion) must be an IP
11584 address or an empty string. The second (not expanded) is a restricted host
11585 list that can match only an IP address, not a host name. For example:
11586 .code
11587 ${if match_ip{$sender_host_address}{1.2.3.4:5.6.7.8}{...}{...}}
11588 .endd
11589 The specific types of host list item that are permitted in the list are:
11590
11591 .ilist
11592 An IP address, optionally with a CIDR mask.
11593 .next
11594 A single asterisk, which matches any IP address.
11595 .next
11596 An empty item, which matches only if the IP address is empty. This could be
11597 useful for testing for a locally submitted message or one from specific hosts
11598 in a single test such as
11599 . ==== As this is a nested list, any displays it contains must be indented
11600 . ==== as otherwise they are too far to the left. This comment applies to
11601 . ==== the use of xmlto plus fop. There's no problem when formatting with
11602 . ==== sdop, with or without the extra indent.
11603 .code
11604   ${if match_ip{$sender_host_address}{:4.3.2.1:...}{...}{...}}
11605 .endd
11606 where the first item in the list is the empty string.
11607 .next
11608 The item @[] matches any of the local host's interface addresses.
11609 .next
11610 Single-key lookups are assumed to be like &"net-"& style lookups in host lists,
11611 even if &`net-`& is not specified. There is never any attempt to turn the IP
11612 address into a host name. The most common type of linear search for
11613 &*match_ip*& is likely to be &*iplsearch*&, in which the file can contain CIDR
11614 masks. For example:
11615 .code
11616   ${if match_ip{$sender_host_address}{iplsearch;/some/file}...
11617 .endd
11618 It is of course possible to use other kinds of lookup, and in such a case, you
11619 do need to specify the &`net-`& prefix if you want to specify a specific
11620 address mask, for example:
11621 .code
11622   ${if match_ip{$sender_host_address}{net24-dbm;/some/file}...
11623 .endd
11624 However, unless you are combining a &%match_ip%& condition with others, it is
11625 just as easy to use the fact that a lookup is itself a condition, and write:
11626 .code
11627   ${lookup{${mask:$sender_host_address/24}}dbm{/a/file}...
11628 .endd
11629 .endlist ilist
11630
11631 Note that <&'string2'&> is not itself subject to string expansion, unless
11632 Exim was built with the EXPAND_LISTMATCH_RHS option.
11633
11634 Consult section &<<SECThoslispatip>>& for further details of these patterns.
11635
11636 .vitem &*match_local_part&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11637 .cindex "domain list" "in expansion condition"
11638 .cindex "address list" "in expansion condition"
11639 .cindex "local part" "list, in expansion condition"
11640 .cindex "&%match_local_part%& expansion condition"
11641 This condition, together with &%match_address%& and &%match_domain%&, make it
11642 possible to test domain, address, and local part lists within expansions. Each
11643 condition requires two arguments: an item and a list to match. A trivial
11644 example is:
11645 .code
11646 ${if match_domain{a.b.c}{x.y.z:a.b.c:p.q.r}{yes}{no}}
11647 .endd
11648 In each case, the second argument may contain any of the allowable items for a
11649 list of the appropriate type. Also, because the second argument
11650 is a standard form of list, it is possible to refer to a named list.
11651 Thus, you can use conditions like this:
11652 .code
11653 ${if match_domain{$domain}{+local_domains}{...
11654 .endd
11655 .cindex "&`+caseful`&"
11656 For address lists, the matching starts off caselessly, but the &`+caseful`&
11657 item can be used, as in all address lists, to cause subsequent items to
11658 have their local parts matched casefully. Domains are always matched
11659 caselessly.
11660
11661 Note that <&'string2'&> is not itself subject to string expansion, unless
11662 Exim was built with the EXPAND_LISTMATCH_RHS option.
11663
11664 &*Note*&: Host lists are &'not'& supported in this way. This is because
11665 hosts have two identities: a name and an IP address, and it is not clear
11666 how to specify cleanly how such a test would work. However, IP addresses can be
11667 matched using &%match_ip%&.
11668
11669 .vitem &*pam&~{*&<&'string1'&>&*:*&<&'string2'&>&*:...}*&
11670 .cindex "PAM authentication"
11671 .cindex "AUTH" "with PAM"
11672 .cindex "Solaris" "PAM support"
11673 .cindex "expansion" "PAM authentication test"
11674 .cindex "&%pam%& expansion condition"
11675 &'Pluggable Authentication Modules'&
11676 (&url(https://mirrors.edge.kernel.org/pub/linux/libs/pam/)) are a facility that is
11677 available in the latest releases of Solaris and in some GNU/Linux
11678 distributions. The Exim support, which is intended for use in conjunction with
11679 the SMTP AUTH command, is available only if Exim is compiled with
11680 .code
11681 SUPPORT_PAM=yes
11682 .endd
11683 in &_Local/Makefile_&. You probably need to add &%-lpam%& to EXTRALIBS, and
11684 in some releases of GNU/Linux &%-ldl%& is also needed.
11685
11686 The argument string is first expanded, and the result must be a
11687 colon-separated list of strings. Leading and trailing white space is ignored.
11688 The PAM module is initialized with the service name &"exim"& and the user name
11689 taken from the first item in the colon-separated data string (<&'string1'&>).
11690 The remaining items in the data string are passed over in response to requests
11691 from the authentication function. In the simple case there will only be one
11692 request, for a password, so the data consists of just two strings.
11693
11694 There can be problems if any of the strings are permitted to contain colon
11695 characters. In the usual way, these have to be doubled to avoid being taken as
11696 separators. If the data is being inserted from a variable, the &%sg%& expansion
11697 item can be used to double any existing colons. For example, the configuration
11698 of a LOGIN authenticator might contain this setting:
11699 .code
11700 server_condition = ${if pam{$auth1:${sg{$auth2}{:}{::}}}}
11701 .endd
11702 For a PLAIN authenticator you could use:
11703 .code
11704 server_condition = ${if pam{$auth2:${sg{$auth3}{:}{::}}}}
11705 .endd
11706 In some operating systems, PAM authentication can be done only from a process
11707 running as root. Since Exim is running as the Exim user when receiving
11708 messages, this means that PAM cannot be used directly in those systems.
11709 . --- 2018-09-07: the pam_exim modified variant has gone, removed claims re using Exim via that
11710
11711
11712 .vitem &*pwcheck&~{*&<&'string1'&>&*:*&<&'string2'&>&*}*&
11713 .cindex "&'pwcheck'& daemon"
11714 .cindex "Cyrus"
11715 .cindex "expansion" "&'pwcheck'& authentication test"
11716 .cindex "&%pwcheck%& expansion condition"
11717 This condition supports user authentication using the Cyrus &'pwcheck'& daemon.
11718 This is one way of making it possible for passwords to be checked by a process
11719 that is not running as root. &*Note*&: The use of &'pwcheck'& is now
11720 deprecated. Its replacement is &'saslauthd'& (see below).
11721
11722 The pwcheck support is not included in Exim by default. You need to specify
11723 the location of the pwcheck daemon's socket in &_Local/Makefile_& before
11724 building Exim. For example:
11725 .code
11726 CYRUS_PWCHECK_SOCKET=/var/pwcheck/pwcheck
11727 .endd
11728 You do not need to install the full Cyrus software suite in order to use
11729 the pwcheck daemon. You can compile and install just the daemon alone
11730 from the Cyrus SASL library. Ensure that &'exim'& is the only user that has
11731 access to the &_/var/pwcheck_& directory.
11732
11733 The &%pwcheck%& condition takes one argument, which must be the user name and
11734 password, separated by a colon. For example, in a LOGIN authenticator
11735 configuration, you might have this:
11736 .code
11737 server_condition = ${if pwcheck{$auth1:$auth2}}
11738 .endd
11739 Again, for a PLAIN authenticator configuration, this would be:
11740 .code
11741 server_condition = ${if pwcheck{$auth2:$auth3}}
11742 .endd
11743 .vitem &*queue_running*&
11744 .cindex "queue runner" "detecting when delivering from"
11745 .cindex "expansion" "queue runner test"
11746 .cindex "&%queue_running%& expansion condition"
11747 This condition, which has no data, is true during delivery attempts that are
11748 initiated by queue runner processes, and false otherwise.
11749
11750
11751 .vitem &*radius&~{*&<&'authentication&~string'&>&*}*&
11752 .cindex "Radius"
11753 .cindex "expansion" "Radius authentication"
11754 .cindex "&%radius%& expansion condition"
11755 Radius authentication (RFC 2865) is supported in a similar way to PAM. You must
11756 set RADIUS_CONFIG_FILE in &_Local/Makefile_& to specify the location of
11757 the Radius client configuration file in order to build Exim with Radius
11758 support.
11759
11760 With just that one setting, Exim expects to be linked with the &%radiusclient%&
11761 library, using the original API. If you are using release 0.4.0 or later of
11762 this library, you need to set
11763 .code
11764 RADIUS_LIB_TYPE=RADIUSCLIENTNEW
11765 .endd
11766 in &_Local/Makefile_& when building Exim. You can also link Exim with the
11767 &%libradius%& library that comes with FreeBSD. To do this, set
11768 .code
11769 RADIUS_LIB_TYPE=RADLIB
11770 .endd
11771 in &_Local/Makefile_&, in addition to setting RADIUS_CONFIGURE_FILE.
11772 You may also have to supply a suitable setting in EXTRALIBS so that the
11773 Radius library can be found when Exim is linked.
11774
11775 The string specified by RADIUS_CONFIG_FILE is expanded and passed to the
11776 Radius client library, which calls the Radius server. The condition is true if
11777 the authentication is successful. For example:
11778 .code
11779 server_condition = ${if radius{<arguments>}}
11780 .endd
11781
11782
11783 .vitem "&*saslauthd&~{{*&<&'user'&>&*}{*&<&'password'&>&*}&&&
11784         {*&<&'service'&>&*}{*&<&'realm'&>&*}}*&"
11785 .cindex "&'saslauthd'& daemon"
11786 .cindex "Cyrus"
11787 .cindex "expansion" "&'saslauthd'& authentication test"
11788 .cindex "&%saslauthd%& expansion condition"
11789 This condition supports user authentication using the Cyrus &'saslauthd'&
11790 daemon. This replaces the older &'pwcheck'& daemon, which is now deprecated.
11791 Using this daemon is one way of making it possible for passwords to be checked
11792 by a process that is not running as root.
11793
11794 The saslauthd support is not included in Exim by default. You need to specify
11795 the location of the saslauthd daemon's socket in &_Local/Makefile_& before
11796 building Exim. For example:
11797 .code
11798 CYRUS_SASLAUTHD_SOCKET=/var/state/saslauthd/mux
11799 .endd
11800 You do not need to install the full Cyrus software suite in order to use
11801 the saslauthd daemon. You can compile and install just the daemon alone
11802 from the Cyrus SASL library.
11803
11804 Up to four arguments can be supplied to the &%saslauthd%& condition, but only
11805 two are mandatory. For example:
11806 .code
11807 server_condition = ${if saslauthd{{$auth1}{$auth2}}}
11808 .endd
11809 The service and the realm are optional (which is why the arguments are enclosed
11810 in their own set of braces). For details of the meaning of the service and
11811 realm, and how to run the daemon, consult the Cyrus documentation.
11812 .endlist vlist
11813
11814
11815
11816 .section "Combining expansion conditions" "SECID84"
11817 .cindex "expansion" "combining conditions"
11818 Several conditions can be tested at once by combining them using the &%and%&
11819 and &%or%& combination conditions. Note that &%and%& and &%or%& are complete
11820 conditions on their own, and precede their lists of sub-conditions. Each
11821 sub-condition must be enclosed in braces within the overall braces that contain
11822 the list. No repetition of &%if%& is used.
11823
11824
11825 .vlist
11826 .vitem &*or&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
11827 .cindex "&""or""& expansion condition"
11828 .cindex "expansion" "&""or""& of conditions"
11829 The sub-conditions are evaluated from left to right. The condition is true if
11830 any one of the sub-conditions is true.
11831 For example,
11832 .code
11833 ${if or {{eq{$local_part}{spqr}}{eq{$domain}{testing.com}}}...
11834 .endd
11835 When a true sub-condition is found, the following ones are parsed but not
11836 evaluated. If there are several &"match"& sub-conditions the values of the
11837 numeric variables afterwards are taken from the first one that succeeds.
11838
11839 .vitem &*and&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
11840 .cindex "&""and""& expansion condition"
11841 .cindex "expansion" "&""and""& of conditions"
11842 The sub-conditions are evaluated from left to right. The condition is true if
11843 all of the sub-conditions are true. If there are several &"match"&
11844 sub-conditions, the values of the numeric variables afterwards are taken from
11845 the last one. When a false sub-condition is found, the following ones are
11846 parsed but not evaluated.
11847 .endlist
11848 .ecindex IIDexpcond
11849
11850
11851
11852
11853 .section "Expansion variables" "SECTexpvar"
11854 .cindex "expansion" "variables, list of"
11855 This section contains an alphabetical list of all the expansion variables. Some
11856 of them are available only when Exim is compiled with specific options such as
11857 support for TLS or the content scanning extension.
11858
11859 .vlist
11860 .vitem "&$0$&, &$1$&, etc"
11861 .cindex "numerical variables (&$1$& &$2$& etc)"
11862 When a &%match%& expansion condition succeeds, these variables contain the
11863 captured substrings identified by the regular expression during subsequent
11864 processing of the success string of the containing &%if%& expansion item.
11865 In the expansion condition case
11866 they do not retain their values afterwards; in fact, their previous
11867 values are restored at the end of processing an &%if%& item. The numerical
11868 variables may also be set externally by some other matching process which
11869 precedes the expansion of the string. For example, the commands available in
11870 Exim filter files include an &%if%& command with its own regular expression
11871 matching condition.
11872
11873 .vitem "&$acl_arg1$&, &$acl_arg2$&, etc"
11874 Within an acl condition, expansion condition or expansion item
11875 any arguments are copied to these variables,
11876 any unused variables being made empty.
11877
11878 .vitem "&$acl_c...$&"
11879 Values can be placed in these variables by the &%set%& modifier in an ACL. They
11880 can be given any name that starts with &$acl_c$& and is at least six characters
11881 long, but the sixth character must be either a digit or an underscore. For
11882 example: &$acl_c5$&, &$acl_c_mycount$&. The values of the &$acl_c...$&
11883 variables persist throughout the lifetime of an SMTP connection. They can be
11884 used to pass information between ACLs and between different invocations of the
11885 same ACL. When a message is received, the values of these variables are saved
11886 with the message, and can be accessed by filters, routers, and transports
11887 during subsequent delivery.
11888
11889 .vitem "&$acl_m...$&"
11890 These variables are like the &$acl_c...$& variables, except that their values
11891 are reset after a message has been received. Thus, if several messages are
11892 received in one SMTP connection, &$acl_m...$& values are not passed on from one
11893 message to the next, as &$acl_c...$& values are. The &$acl_m...$& variables are
11894 also reset by MAIL, RSET, EHLO, HELO, and after starting a TLS session. When a
11895 message is received, the values of these variables are saved with the message,
11896 and can be accessed by filters, routers, and transports during subsequent
11897 delivery.
11898
11899 .vitem &$acl_narg$&
11900 Within an acl condition, expansion condition or expansion item
11901 this variable has the number of arguments.
11902
11903 .vitem &$acl_verify_message$&
11904 .vindex "&$acl_verify_message$&"
11905 After an address verification has failed, this variable contains the failure
11906 message. It retains its value for use in subsequent modifiers. The message can
11907 be preserved by coding like this:
11908 .code
11909 warn !verify = sender
11910      set acl_m0 = $acl_verify_message
11911 .endd
11912 You can use &$acl_verify_message$& during the expansion of the &%message%& or
11913 &%log_message%& modifiers, to include information about the verification
11914 failure.
11915
11916 .vitem &$address_data$&
11917 .vindex "&$address_data$&"
11918 This variable is set by means of the &%address_data%& option in routers. The
11919 value then remains with the address while it is processed by subsequent routers
11920 and eventually a transport. If the transport is handling multiple addresses,
11921 the value from the first address is used. See chapter &<<CHAProutergeneric>>&
11922 for more details. &*Note*&: The contents of &$address_data$& are visible in
11923 user filter files.
11924
11925 If &$address_data$& is set when the routers are called from an ACL to verify
11926 a recipient address, the final value is still in the variable for subsequent
11927 conditions and modifiers of the ACL statement. If routing the address caused it
11928 to be redirected to just one address, the child address is also routed as part
11929 of the verification, and in this case the final value of &$address_data$& is
11930 from the child's routing.
11931
11932 If &$address_data$& is set when the routers are called from an ACL to verify a
11933 sender address, the final value is also preserved, but this time in
11934 &$sender_address_data$&, to distinguish it from data from a recipient
11935 address.
11936
11937 In both cases (recipient and sender verification), the value does not persist
11938 after the end of the current ACL statement. If you want to preserve
11939 these values for longer, you can save them in ACL variables.
11940
11941 .vitem &$address_file$&
11942 .vindex "&$address_file$&"
11943 When, as a result of aliasing, forwarding, or filtering, a message is directed
11944 to a specific file, this variable holds the name of the file when the transport
11945 is running. At other times, the variable is empty. For example, using the
11946 default configuration, if user &%r2d2%& has a &_.forward_& file containing
11947 .code
11948 /home/r2d2/savemail
11949 .endd
11950 then when the &(address_file)& transport is running, &$address_file$&
11951 contains the text string &`/home/r2d2/savemail`&.
11952 .cindex "Sieve filter" "value of &$address_file$&"
11953 For Sieve filters, the value may be &"inbox"& or a relative folder name. It is
11954 then up to the transport configuration to generate an appropriate absolute path
11955 to the relevant file.
11956
11957 .vitem &$address_pipe$&
11958 .vindex "&$address_pipe$&"
11959 When, as a result of aliasing or forwarding, a message is directed to a pipe,
11960 this variable holds the pipe command when the transport is running.
11961
11962 .vitem "&$auth1$& &-- &$auth3$&"
11963 .vindex "&$auth1$&, &$auth2$&, etc"
11964 These variables are used in SMTP authenticators (see chapters
11965 &<<CHAPplaintext>>&&--&<<CHAPtlsauth>>&). Elsewhere, they are empty.
11966
11967 .vitem &$authenticated_id$&
11968 .cindex "authentication" "id"
11969 .vindex "&$authenticated_id$&"
11970 When a server successfully authenticates a client it may be configured to
11971 preserve some of the authentication information in the variable
11972 &$authenticated_id$& (see chapter &<<CHAPSMTPAUTH>>&). For example, a
11973 user/password authenticator configuration might preserve the user name for use
11974 in the routers. Note that this is not the same information that is saved in
11975 &$sender_host_authenticated$&.
11976
11977 When a message is submitted locally (that is, not over a TCP connection)
11978 the value of &$authenticated_id$& is normally the login name of the calling
11979 process. However, a trusted user can override this by means of the &%-oMai%&
11980 command line option.
11981 This second case also sets up information used by the
11982 &$authresults$& expansion item.
11983
11984 .vitem &$authenticated_fail_id$&
11985 .cindex "authentication" "fail" "id"
11986 .vindex "&$authenticated_fail_id$&"
11987 When an authentication attempt fails, the variable &$authenticated_fail_id$&
11988 will contain the failed authentication id. If more than one authentication
11989 id is attempted, it will contain only the last one. The variable is
11990 available for processing in the ACL's, generally the quit or notquit ACL.
11991 A message to a local recipient could still be accepted without requiring
11992 authentication, which means this variable could also be visible in all of
11993 the ACL's as well.
11994
11995
11996 .vitem &$authenticated_sender$&
11997 .cindex "sender" "authenticated"
11998 .cindex "authentication" "sender"
11999 .cindex "AUTH" "on MAIL command"
12000 .vindex "&$authenticated_sender$&"
12001 When acting as a server, Exim takes note of the AUTH= parameter on an incoming
12002 SMTP MAIL command if it believes the sender is sufficiently trusted, as
12003 described in section &<<SECTauthparamail>>&. Unless the data is the string
12004 &"<>"&, it is set as the authenticated sender of the message, and the value is
12005 available during delivery in the &$authenticated_sender$& variable. If the
12006 sender is not trusted, Exim accepts the syntax of AUTH=, but ignores the data.
12007
12008 .vindex "&$qualify_domain$&"
12009 When a message is submitted locally (that is, not over a TCP connection), the
12010 value of &$authenticated_sender$& is an address constructed from the login
12011 name of the calling process and &$qualify_domain$&, except that a trusted user
12012 can override this by means of the &%-oMas%& command line option.
12013
12014
12015 .vitem &$authentication_failed$&
12016 .cindex "authentication" "failure"
12017 .vindex "&$authentication_failed$&"
12018 This variable is set to &"1"& in an Exim server if a client issues an AUTH
12019 command that does not succeed. Otherwise it is set to &"0"&. This makes it
12020 possible to distinguish between &"did not try to authenticate"&
12021 (&$sender_host_authenticated$& is empty and &$authentication_failed$& is set to
12022 &"0"&) and &"tried to authenticate but failed"& (&$sender_host_authenticated$&
12023 is empty and &$authentication_failed$& is set to &"1"&). Failure includes any
12024 negative response to an AUTH command, including (for example) an attempt to use
12025 an undefined mechanism.
12026
12027 .vitem &$av_failed$&
12028 .cindex "content scanning" "AV scanner failure"
12029 This variable is available when Exim is compiled with the content-scanning
12030 extension. It is set to &"0"& by default, but will be set to &"1"& if any
12031 problem occurs with the virus scanner (specified by &%av_scanner%&) during
12032 the ACL malware condition.
12033
12034 .vitem &$body_linecount$&
12035 .cindex "message body" "line count"
12036 .cindex "body of message" "line count"
12037 .vindex "&$body_linecount$&"
12038 When a message is being received or delivered, this variable contains the
12039 number of lines in the message's body. See also &$message_linecount$&.
12040
12041 .vitem &$body_zerocount$&
12042 .cindex "message body" "binary zero count"
12043 .cindex "body of message" "binary zero count"
12044 .cindex "binary zero" "in message body"
12045 .vindex "&$body_zerocount$&"
12046 When a message is being received or delivered, this variable contains the
12047 number of binary zero bytes (ASCII NULs) in the message's body.
12048
12049 .vitem &$bounce_recipient$&
12050 .vindex "&$bounce_recipient$&"
12051 This is set to the recipient address of a bounce message while Exim is creating
12052 it. It is useful if a customized bounce message text file is in use (see
12053 chapter &<<CHAPemsgcust>>&).
12054
12055 .vitem &$bounce_return_size_limit$&
12056 .vindex "&$bounce_return_size_limit$&"
12057 This contains the value set in the &%bounce_return_size_limit%& option, rounded
12058 up to a multiple of 1000. It is useful when a customized error message text
12059 file is in use (see chapter &<<CHAPemsgcust>>&).
12060
12061 .vitem &$caller_gid$&
12062 .cindex "gid (group id)" "caller"
12063 .vindex "&$caller_gid$&"
12064 The real group id under which the process that called Exim was running. This is
12065 not the same as the group id of the originator of a message (see
12066 &$originator_gid$&). If Exim re-execs itself, this variable in the new
12067 incarnation normally contains the Exim gid.
12068
12069 .vitem &$caller_uid$&
12070 .cindex "uid (user id)" "caller"
12071 .vindex "&$caller_uid$&"
12072 The real user id under which the process that called Exim was running. This is
12073 not the same as the user id of the originator of a message (see
12074 &$originator_uid$&). If Exim re-execs itself, this variable in the new
12075 incarnation normally contains the Exim uid.
12076
12077 .vitem &$callout_address$&
12078 .vindex "&$callout_address$&"
12079 After a callout for verification, spamd or malware daemon service, the
12080 address that was connected to.
12081
12082 .vitem &$compile_number$&
12083 .vindex "&$compile_number$&"
12084 The building process for Exim keeps a count of the number
12085 of times it has been compiled. This serves to distinguish different
12086 compilations of the same version of Exim.
12087
12088 .vitem &$config_dir$&
12089 .vindex "&$config_dir$&"
12090 The directory name of the main configuration file. That is, the content of
12091 &$config_file$& with the last component stripped. The value does not
12092 contain the trailing slash. If &$config_file$& does not contain a slash,
12093 &$config_dir$& is ".".
12094
12095 .vitem &$config_file$&
12096 .vindex "&$config_file$&"
12097 The name of the main configuration file Exim is using.
12098
12099 .new
12100 .vitem &$dmarc_domain_policy$& &&&
12101        &$dmarc_status$& &&&
12102        &$dmarc_status_text$& &&&
12103        &$dmarc_used_domains$&
12104 Results of DMARC verification.
12105 For details see section &<<SECDMARC>>&.
12106 .wen
12107
12108 .vitem &$dkim_verify_status$&
12109 Results of DKIM verification.
12110 For details see section &<<SECDKIMVFY>>&.
12111
12112 .vitem &$dkim_cur_signer$& &&&
12113        &$dkim_verify_reason$& &&&
12114        &$dkim_domain$& &&&
12115        &$dkim_identity$& &&&
12116        &$dkim_selector$& &&&
12117        &$dkim_algo$& &&&
12118        &$dkim_canon_body$& &&&
12119        &$dkim_canon_headers$& &&&
12120        &$dkim_copiedheaders$& &&&
12121        &$dkim_bodylength$& &&&
12122        &$dkim_created$& &&&
12123        &$dkim_expires$& &&&
12124        &$dkim_headernames$& &&&
12125        &$dkim_key_testing$& &&&
12126        &$dkim_key_nosubdomains$& &&&
12127        &$dkim_key_srvtype$& &&&
12128        &$dkim_key_granularity$& &&&
12129        &$dkim_key_notes$& &&&
12130        &$dkim_key_length$&
12131 These variables are only available within the DKIM ACL.
12132 For details see section &<<SECDKIMVFY>>&.
12133
12134 .vitem &$dkim_signers$&
12135 .vindex &$dkim_signers$&
12136 When a message has been received this variable contains
12137 a colon-separated list of signer domains and identities for the message.
12138 For details see section &<<SECDKIMVFY>>&.
12139
12140 .vitem &$dnslist_domain$& &&&
12141        &$dnslist_matched$& &&&
12142        &$dnslist_text$& &&&
12143        &$dnslist_value$&
12144 .vindex "&$dnslist_domain$&"
12145 .vindex "&$dnslist_matched$&"
12146 .vindex "&$dnslist_text$&"
12147 .vindex "&$dnslist_value$&"
12148 .cindex "black list (DNS)"
12149 When a DNS (black) list lookup succeeds, these variables are set to contain
12150 the following data from the lookup: the list's domain name, the key that was
12151 looked up, the contents of any associated TXT record, and the value from the
12152 main A record. See section &<<SECID204>>& for more details.
12153
12154 .vitem &$domain$&
12155 .vindex "&$domain$&"
12156 When an address is being routed, or delivered on its own, this variable
12157 contains the domain. Uppercase letters in the domain are converted into lower
12158 case for &$domain$&.
12159
12160 Global address rewriting happens when a message is received, so the value of
12161 &$domain$& during routing and delivery is the value after rewriting. &$domain$&
12162 is set during user filtering, but not during system filtering, because a
12163 message may have many recipients and the system filter is called just once.
12164
12165 When more than one address is being delivered at once (for example, several
12166 RCPT commands in one SMTP delivery), &$domain$& is set only if they all
12167 have the same domain. Transports can be restricted to handling only one domain
12168 at a time if the value of &$domain$& is required at transport time &-- this is
12169 the default for local transports. For further details of the environment in
12170 which local transports are run, see chapter &<<CHAPenvironment>>&.
12171
12172 .oindex "&%delay_warning_condition%&"
12173 At the end of a delivery, if all deferred addresses have the same domain, it is
12174 set in &$domain$& during the expansion of &%delay_warning_condition%&.
12175
12176 The &$domain$& variable is also used in some other circumstances:
12177
12178 .ilist
12179 When an ACL is running for a RCPT command, &$domain$& contains the domain of
12180 the recipient address. The domain of the &'sender'& address is in
12181 &$sender_address_domain$& at both MAIL time and at RCPT time. &$domain$& is not
12182 normally set during the running of the MAIL ACL. However, if the sender address
12183 is verified with a callout during the MAIL ACL, the sender domain is placed in
12184 &$domain$& during the expansions of &%hosts%&, &%interface%&, and &%port%& in
12185 the &(smtp)& transport.
12186
12187 .next
12188 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
12189 &$domain$& contains the domain portion of the address that is being rewritten;
12190 it can be used in the expansion of the replacement address, for example, to
12191 rewrite domains by file lookup.
12192
12193 .next
12194 With one important exception, whenever a domain list is being scanned,
12195 &$domain$& contains the subject domain. &*Exception*&: When a domain list in
12196 a &%sender_domains%& condition in an ACL is being processed, the subject domain
12197 is in &$sender_address_domain$& and not in &$domain$&. It works this way so
12198 that, in a RCPT ACL, the sender domain list can be dependent on the
12199 recipient domain (which is what is in &$domain$& at this time).
12200
12201 .next
12202 .cindex "ETRN" "value of &$domain$&"
12203 .oindex "&%smtp_etrn_command%&"
12204 When the &%smtp_etrn_command%& option is being expanded, &$domain$& contains
12205 the complete argument of the ETRN command (see section &<<SECTETRN>>&).
12206 .endlist
12207
12208
12209 .vitem &$domain_data$&
12210 .vindex "&$domain_data$&"
12211 When the &%domains%& option on a router matches a domain by
12212 means of a lookup, the data read by the lookup is available during the running
12213 of the router as &$domain_data$&. In addition, if the driver routes the
12214 address to a transport, the value is available in that transport. If the
12215 transport is handling multiple addresses, the value from the first address is
12216 used.
12217
12218 &$domain_data$& is also set when the &%domains%& condition in an ACL matches a
12219 domain by means of a lookup. The data read by the lookup is available during
12220 the rest of the ACL statement. In all other situations, this variable expands
12221 to nothing.
12222
12223 .vitem &$exim_gid$&
12224 .vindex "&$exim_gid$&"
12225 This variable contains the numerical value of the Exim group id.
12226
12227 .vitem &$exim_path$&
12228 .vindex "&$exim_path$&"
12229 This variable contains the path to the Exim binary.
12230
12231 .vitem &$exim_uid$&
12232 .vindex "&$exim_uid$&"
12233 This variable contains the numerical value of the Exim user id.
12234
12235 .vitem &$exim_version$&
12236 .vindex "&$exim_version$&"
12237 This variable contains the version string of the Exim build.
12238 The first character is a major version number, currently 4.
12239 Then after a dot, the next group of digits is a minor version number.
12240 There may be other characters following the minor version.
12241 This value may be overridden by the &%exim_version%& main config option.
12242
12243 .vitem &$header_$&<&'name'&>
12244 This is not strictly an expansion variable. It is expansion syntax for
12245 inserting the message header line with the given name. Note that the name must
12246 be terminated by colon or white space, because it may contain a wide variety of
12247 characters. Note also that braces must &'not'& be used.
12248 See the full description in section &<<SECTexpansionitems>>& above.
12249
12250 .vitem &$headers_added$&
12251 .vindex "&$headers_added$&"
12252 Within an ACL this variable contains the headers added so far by
12253 the ACL modifier add_header (section &<<SECTaddheadacl>>&).
12254 The headers are a newline-separated list.
12255
12256 .vitem &$home$&
12257 .vindex "&$home$&"
12258 When the &%check_local_user%& option is set for a router, the user's home
12259 directory is placed in &$home$& when the check succeeds. In particular, this
12260 means it is set during the running of users' filter files. A router may also
12261 explicitly set a home directory for use by a transport; this can be overridden
12262 by a setting on the transport itself.
12263
12264 When running a filter test via the &%-bf%& option, &$home$& is set to the value
12265 of the environment variable HOME, which is subject to the
12266 &%keep_environment%& and &%add_environment%& main config options.
12267
12268 .vitem &$host$&
12269 .vindex "&$host$&"
12270 If a router assigns an address to a transport (any transport), and passes a
12271 list of hosts with the address, the value of &$host$& when the transport starts
12272 to run is the name of the first host on the list. Note that this applies both
12273 to local and remote transports.
12274
12275 .cindex "transport" "filter"
12276 .cindex "filter" "transport filter"
12277 For the &(smtp)& transport, if there is more than one host, the value of
12278 &$host$& changes as the transport works its way through the list. In
12279 particular, when the &(smtp)& transport is expanding its options for encryption
12280 using TLS, or for specifying a transport filter (see chapter
12281 &<<CHAPtransportgeneric>>&), &$host$& contains the name of the host to which it
12282 is connected.
12283
12284 When used in the client part of an authenticator configuration (see chapter
12285 &<<CHAPSMTPAUTH>>&), &$host$& contains the name of the server to which the
12286 client is connected.
12287
12288
12289 .vitem &$host_address$&
12290 .vindex "&$host_address$&"
12291 This variable is set to the remote host's IP address whenever &$host$& is set
12292 for a remote connection. It is also set to the IP address that is being checked
12293 when the &%ignore_target_hosts%& option is being processed.
12294
12295 .vitem &$host_data$&
12296 .vindex "&$host_data$&"
12297 If a &%hosts%& condition in an ACL is satisfied by means of a lookup, the
12298 result of the lookup is made available in the &$host_data$& variable. This
12299 allows you, for example, to do things like this:
12300 .code
12301 deny  hosts = net-lsearch;/some/file
12302 message = $host_data
12303 .endd
12304 .vitem &$host_lookup_deferred$&
12305 .cindex "host name" "lookup, failure of"
12306 .vindex "&$host_lookup_deferred$&"
12307 This variable normally contains &"0"&, as does &$host_lookup_failed$&. When a
12308 message comes from a remote host and there is an attempt to look up the host's
12309 name from its IP address, and the attempt is not successful, one of these
12310 variables is set to &"1"&.
12311
12312 .ilist
12313 If the lookup receives a definite negative response (for example, a DNS lookup
12314 succeeded, but no records were found), &$host_lookup_failed$& is set to &"1"&.
12315
12316 .next
12317 If there is any kind of problem during the lookup, such that Exim cannot
12318 tell whether or not the host name is defined (for example, a timeout for a DNS
12319 lookup), &$host_lookup_deferred$& is set to &"1"&.
12320 .endlist ilist
12321
12322 Looking up a host's name from its IP address consists of more than just a
12323 single reverse lookup. Exim checks that a forward lookup of at least one of the
12324 names it receives from a reverse lookup yields the original IP address. If this
12325 is not the case, Exim does not accept the looked up name(s), and
12326 &$host_lookup_failed$& is set to &"1"&. Thus, being able to find a name from an
12327 IP address (for example, the existence of a PTR record in the DNS) is not
12328 sufficient on its own for the success of a host name lookup. If the reverse
12329 lookup succeeds, but there is a lookup problem such as a timeout when checking
12330 the result, the name is not accepted, and &$host_lookup_deferred$& is set to
12331 &"1"&. See also &$sender_host_name$&.
12332
12333 .cindex authentication "expansion item"
12334 Performing these checks sets up information used by the
12335 &%authresults%& expansion item.
12336
12337
12338 .vitem &$host_lookup_failed$&
12339 .vindex "&$host_lookup_failed$&"
12340 See &$host_lookup_deferred$&.
12341
12342 .vitem &$host_port$&
12343 .vindex "&$host_port$&"
12344 This variable is set to the remote host's TCP port whenever &$host$& is set
12345 for an outbound connection.
12346
12347 .vitem &$initial_cwd$&
12348 .vindex "&$initial_cwd$&
12349 This variable contains the full path name of the initial working
12350 directory of the current Exim process. This may differ from the current
12351 working directory, as Exim changes this to "/" during early startup, and
12352 to &$spool_directory$& later.
12353
12354 .vitem &$inode$&
12355 .vindex "&$inode$&"
12356 The only time this variable is set is while expanding the &%directory_file%&
12357 option in the &(appendfile)& transport. The variable contains the inode number
12358 of the temporary file which is about to be renamed. It can be used to construct
12359 a unique name for the file.
12360
12361 .vitem &$interface_address$&
12362 .vindex "&$interface_address$&"
12363 This is an obsolete name for &$received_ip_address$&.
12364
12365 .vitem &$interface_port$&
12366 .vindex "&$interface_port$&"
12367 This is an obsolete name for &$received_port$&.
12368
12369 .vitem &$item$&
12370 .vindex "&$item$&"
12371 This variable is used during the expansion of &*forall*& and &*forany*&
12372 conditions (see section &<<SECTexpcond>>&), and &*filter*&, &*map*&, and
12373 &*reduce*& items (see section &<<SECTexpcond>>&). In other circumstances, it is
12374 empty.
12375
12376 .vitem &$ldap_dn$&
12377 .vindex "&$ldap_dn$&"
12378 This variable, which is available only when Exim is compiled with LDAP support,
12379 contains the DN from the last entry in the most recently successful LDAP
12380 lookup.
12381
12382 .vitem &$load_average$&
12383 .vindex "&$load_average$&"
12384 This variable contains the system load average, multiplied by 1000 so that it
12385 is an integer. For example, if the load average is 0.21, the value of the
12386 variable is 210. The value is recomputed every time the variable is referenced.
12387
12388 .vitem &$local_part$&
12389 .vindex "&$local_part$&"
12390 When an address is being routed, or delivered on its own, this
12391 variable contains the local part. When a number of addresses are being
12392 delivered together (for example, multiple RCPT commands in an SMTP
12393 session), &$local_part$& is not set.
12394
12395 Global address rewriting happens when a message is received, so the value of
12396 &$local_part$& during routing and delivery is the value after rewriting.
12397 &$local_part$& is set during user filtering, but not during system filtering,
12398 because a message may have many recipients and the system filter is called just
12399 once.
12400
12401 .vindex "&$local_part_prefix$&"
12402 .vindex "&$local_part_suffix$&"
12403 .cindex affix variables
12404 If a local part prefix or suffix has been recognized, it is not included in the
12405 value of &$local_part$& during routing and subsequent delivery. The values of
12406 any prefix or suffix are in &$local_part_prefix$& and
12407 &$local_part_suffix$&, respectively.
12408
12409 When a message is being delivered to a file, pipe, or autoreply transport as a
12410 result of aliasing or forwarding, &$local_part$& is set to the local part of
12411 the parent address, not to the filename or command (see &$address_file$& and
12412 &$address_pipe$&).
12413
12414 When an ACL is running for a RCPT command, &$local_part$& contains the
12415 local part of the recipient address.
12416
12417 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
12418 &$local_part$& contains the local part of the address that is being rewritten;
12419 it can be used in the expansion of the replacement address, for example.
12420
12421 In all cases, all quoting is removed from the local part. For example, for both
12422 the addresses
12423 .code
12424 "abc:xyz"@test.example
12425 abc\:xyz@test.example
12426 .endd
12427 the value of &$local_part$& is
12428 .code
12429 abc:xyz
12430 .endd
12431 If you use &$local_part$& to create another address, you should always wrap it
12432 inside a quoting operator. For example, in a &(redirect)& router you could
12433 have:
12434 .code
12435 data = ${quote_local_part:$local_part}@new.domain.example
12436 .endd
12437 &*Note*&: The value of &$local_part$& is normally lower cased. If you want
12438 to process local parts in a case-dependent manner in a router, you can set the
12439 &%caseful_local_part%& option (see chapter &<<CHAProutergeneric>>&).
12440
12441 .vitem &$local_part_data$&
12442 .vindex "&$local_part_data$&"
12443 When the &%local_parts%& option on a router matches a local part by means of a
12444 lookup, the data read by the lookup is available during the running of the
12445 router as &$local_part_data$&. In addition, if the driver routes the address
12446 to a transport, the value is available in that transport. If the transport is
12447 handling multiple addresses, the value from the first address is used.
12448
12449 &$local_part_data$& is also set when the &%local_parts%& condition in an ACL
12450 matches a local part by means of a lookup. The data read by the lookup is
12451 available during the rest of the ACL statement. In all other situations, this
12452 variable expands to nothing.
12453
12454 .vitem &$local_part_prefix$&
12455 .vindex "&$local_part_prefix$&"
12456 .cindex affix variables
12457 When an address is being routed or delivered, and a
12458 specific prefix for the local part was recognized, it is available in this
12459 variable, having been removed from &$local_part$&.
12460
12461 .vitem &$local_part_suffix$&
12462 .vindex "&$local_part_suffix$&"
12463 When an address is being routed or delivered, and a
12464 specific suffix for the local part was recognized, it is available in this
12465 variable, having been removed from &$local_part$&.
12466
12467 .vitem &$local_scan_data$&
12468 .vindex "&$local_scan_data$&"
12469 This variable contains the text returned by the &[local_scan()]& function when
12470 a message is received. See chapter &<<CHAPlocalscan>>& for more details.
12471
12472 .vitem &$local_user_gid$&
12473 .vindex "&$local_user_gid$&"
12474 See &$local_user_uid$&.
12475
12476 .vitem &$local_user_uid$&
12477 .vindex "&$local_user_uid$&"
12478 This variable and &$local_user_gid$& are set to the uid and gid after the
12479 &%check_local_user%& router precondition succeeds. This means that their values
12480 are available for the remaining preconditions (&%senders%&, &%require_files%&,
12481 and &%condition%&), for the &%address_data%& expansion, and for any
12482 router-specific expansions. At all other times, the values in these variables
12483 are &`(uid_t)(-1)`& and &`(gid_t)(-1)`&, respectively.
12484
12485 .vitem &$localhost_number$&
12486 .vindex "&$localhost_number$&"
12487 This contains the expanded value of the
12488 &%localhost_number%& option. The expansion happens after the main options have
12489 been read.
12490
12491 .vitem &$log_inodes$&
12492 .vindex "&$log_inodes$&"
12493 The number of free inodes in the disk partition where Exim's
12494 log files are being written. The value is recalculated whenever the variable is
12495 referenced. If the relevant file system does not have the concept of inodes,
12496 the value of is -1. See also the &%check_log_inodes%& option.
12497
12498 .vitem &$log_space$&
12499 .vindex "&$log_space$&"
12500 The amount of free space (as a number of kilobytes) in the disk
12501 partition where Exim's log files are being written. The value is recalculated
12502 whenever the variable is referenced. If the operating system does not have the
12503 ability to find the amount of free space (only true for experimental systems),
12504 the space value is -1. See also the &%check_log_space%& option.
12505
12506
12507 .vitem &$lookup_dnssec_authenticated$&
12508 .vindex "&$lookup_dnssec_authenticated$&"
12509 This variable is set after a DNS lookup done by
12510 a dnsdb lookup expansion, dnslookup router or smtp transport.
12511 .cindex "DNS" "DNSSEC"
12512 It will be empty if &(DNSSEC)& was not requested,
12513 &"no"& if the result was not labelled as authenticated data
12514 and &"yes"& if it was.
12515 Results that are labelled as authoritative answer that match
12516 the &%dns_trust_aa%& configuration variable count also
12517 as authenticated data.
12518
12519 .vitem &$mailstore_basename$&
12520 .vindex "&$mailstore_basename$&"
12521 This variable is set only when doing deliveries in &"mailstore"& format in the
12522 &(appendfile)& transport. During the expansion of the &%mailstore_prefix%&,
12523 &%mailstore_suffix%&, &%message_prefix%&, and &%message_suffix%& options, it
12524 contains the basename of the files that are being written, that is, the name
12525 without the &".tmp"&, &".env"&, or &".msg"& suffix. At all other times, this
12526 variable is empty.
12527
12528 .vitem &$malware_name$&
12529 .vindex "&$malware_name$&"
12530 This variable is available when Exim is compiled with the
12531 content-scanning extension. It is set to the name of the virus that was found
12532 when the ACL &%malware%& condition is true (see section &<<SECTscanvirus>>&).
12533
12534 .vitem &$max_received_linelength$&
12535 .vindex "&$max_received_linelength$&"
12536 .cindex "maximum" "line length"
12537 .cindex "line length" "maximum"
12538 This variable contains the number of bytes in the longest line that was
12539 received as part of the message, not counting the line termination
12540 character(s).
12541 It is not valid if the &%spool_files_wireformat%& option is used.
12542
12543 .vitem &$message_age$&
12544 .cindex "message" "age of"
12545 .vindex "&$message_age$&"
12546 This variable is set at the start of a delivery attempt to contain the number
12547 of seconds since the message was received. It does not change during a single
12548 delivery attempt.
12549
12550 .vitem &$message_body$&
12551 .cindex "body of message" "expansion variable"
12552 .cindex "message body" "in expansion"
12553 .cindex "binary zero" "in message body"
12554 .vindex "&$message_body$&"
12555 .oindex "&%message_body_visible%&"
12556 This variable contains the initial portion of a message's body while it is
12557 being delivered, and is intended mainly for use in filter files. The maximum
12558 number of characters of the body that are put into the variable is set by the
12559 &%message_body_visible%& configuration option; the default is 500.
12560
12561 .oindex "&%message_body_newlines%&"
12562 By default, newlines are converted into spaces in &$message_body$&, to make it
12563 easier to search for phrases that might be split over a line break. However,
12564 this can be disabled by setting &%message_body_newlines%& to be true. Binary
12565 zeros are always converted into spaces.
12566
12567 .vitem &$message_body_end$&
12568 .cindex "body of message" "expansion variable"
12569 .cindex "message body" "in expansion"
12570 .vindex "&$message_body_end$&"
12571 This variable contains the final portion of a message's
12572 body while it is being delivered. The format and maximum size are as for
12573 &$message_body$&.
12574
12575 .vitem &$message_body_size$&
12576 .cindex "body of message" "size"
12577 .cindex "message body" "size"
12578 .vindex "&$message_body_size$&"
12579 When a message is being delivered, this variable contains the size of the body
12580 in bytes. The count starts from the character after the blank line that
12581 separates the body from the header. Newlines are included in the count. See
12582 also &$message_size$&, &$body_linecount$&, and &$body_zerocount$&.
12583
12584 If the spool file is wireformat
12585 (see the &%spool_files_wireformat%& main option)
12586 the CRLF line-terminators are included in the count.
12587
12588 .vitem &$message_exim_id$&
12589 .vindex "&$message_exim_id$&"
12590 When a message is being received or delivered, this variable contains the
12591 unique message id that is generated and used by Exim to identify the message.
12592 An id is not created for a message until after its header has been successfully
12593 received. &*Note*&: This is &'not'& the contents of the &'Message-ID:'& header
12594 line; it is the local id that Exim assigns to the message, for example:
12595 &`1BXTIK-0001yO-VA`&.
12596
12597 .vitem &$message_headers$&
12598 .vindex &$message_headers$&
12599 This variable contains a concatenation of all the header lines when a message
12600 is being processed, except for lines added by routers or transports. The header
12601 lines are separated by newline characters. Their contents are decoded in the
12602 same way as a header line that is inserted by &%bheader%&.
12603
12604 .vitem &$message_headers_raw$&
12605 .vindex &$message_headers_raw$&
12606 This variable is like &$message_headers$& except that no processing of the
12607 contents of header lines is done.
12608
12609 .vitem &$message_id$&
12610 This is an old name for &$message_exim_id$&. It is now deprecated.
12611
12612 .vitem &$message_linecount$&
12613 .vindex "&$message_linecount$&"
12614 This variable contains the total number of lines in the header and body of the
12615 message. Compare &$body_linecount$&, which is the count for the body only.
12616 During the DATA and content-scanning ACLs, &$message_linecount$& contains the
12617 number of lines received. Before delivery happens (that is, before filters,
12618 routers, and transports run) the count is increased to include the
12619 &'Received:'& header line that Exim standardly adds, and also any other header
12620 lines that are added by ACLs. The blank line that separates the message header
12621 from the body is not counted.
12622
12623 As with the special case of &$message_size$&, during the expansion of the
12624 appendfile transport's maildir_tag option in maildir format, the value of
12625 &$message_linecount$& is the precise size of the number of newlines in the
12626 file that has been written (minus one for the blank line between the
12627 header and the body).
12628
12629 Here is an example of the use of this variable in a DATA ACL:
12630 .code
12631 deny message   = Too many lines in message header
12632      condition = \
12633       ${if <{250}{${eval:$message_linecount - $body_linecount}}}
12634 .endd
12635 In the MAIL and RCPT ACLs, the value is zero because at that stage the
12636 message has not yet been received.
12637
12638 This variable is not valid if the &%spool_files_wireformat%& option is used.
12639
12640 .vitem &$message_size$&
12641 .cindex "size" "of message"
12642 .cindex "message" "size"
12643 .vindex "&$message_size$&"
12644 When a message is being processed, this variable contains its size in bytes. In
12645 most cases, the size includes those headers that were received with the
12646 message, but not those (such as &'Envelope-to:'&) that are added to individual
12647 deliveries as they are written. However, there is one special case: during the
12648 expansion of the &%maildir_tag%& option in the &(appendfile)& transport while
12649 doing a delivery in maildir format, the value of &$message_size$& is the
12650 precise size of the file that has been written. See also
12651 &$message_body_size$&, &$body_linecount$&, and &$body_zerocount$&.
12652
12653 .cindex "RCPT" "value of &$message_size$&"
12654 While running a per message ACL (mail/rcpt/predata), &$message_size$&
12655 contains the size supplied on the MAIL command, or -1 if no size was given. The
12656 value may not, of course, be truthful.
12657
12658 .vitem &$mime_$&&'xxx'&
12659 A number of variables whose names start with &$mime$& are
12660 available when Exim is compiled with the content-scanning extension. For
12661 details, see section &<<SECTscanmimepart>>&.
12662
12663 .vitem "&$n0$& &-- &$n9$&"
12664 These variables are counters that can be incremented by means
12665 of the &%add%& command in filter files.
12666
12667 .vitem &$original_domain$&
12668 .vindex "&$domain$&"
12669 .vindex "&$original_domain$&"
12670 When a top-level address is being processed for delivery, this contains the
12671 same value as &$domain$&. However, if a &"child"& address (for example,
12672 generated by an alias, forward, or filter file) is being processed, this
12673 variable contains the domain of the original address (lower cased). This
12674 differs from &$parent_domain$& only when there is more than one level of
12675 aliasing or forwarding. When more than one address is being delivered in a
12676 single transport run, &$original_domain$& is not set.
12677
12678 If a new address is created by means of a &%deliver%& command in a system
12679 filter, it is set up with an artificial &"parent"& address. This has the local
12680 part &'system-filter'& and the default qualify domain.
12681
12682 .vitem &$original_local_part$&
12683 .vindex "&$local_part$&"
12684 .vindex "&$original_local_part$&"
12685 When a top-level address is being processed for delivery, this contains the
12686 same value as &$local_part$&, unless a prefix or suffix was removed from the
12687 local part, because &$original_local_part$& always contains the full local
12688 part. When a &"child"& address (for example, generated by an alias, forward, or
12689 filter file) is being processed, this variable contains the full local part of
12690 the original address.
12691
12692 If the router that did the redirection processed the local part
12693 case-insensitively, the value in &$original_local_part$& is in lower case.
12694 This variable differs from &$parent_local_part$& only when there is more than
12695 one level of aliasing or forwarding. When more than one address is being
12696 delivered in a single transport run, &$original_local_part$& is not set.
12697
12698 If a new address is created by means of a &%deliver%& command in a system
12699 filter, it is set up with an artificial &"parent"& address. This has the local
12700 part &'system-filter'& and the default qualify domain.
12701
12702 .vitem &$originator_gid$&
12703 .cindex "gid (group id)" "of originating user"
12704 .cindex "sender" "gid"
12705 .vindex "&$caller_gid$&"
12706 .vindex "&$originator_gid$&"
12707 This variable contains the value of &$caller_gid$& that was set when the
12708 message was received. For messages received via the command line, this is the
12709 gid of the sending user. For messages received by SMTP over TCP/IP, this is
12710 normally the gid of the Exim user.
12711
12712 .vitem &$originator_uid$&
12713 .cindex "uid (user id)" "of originating user"
12714 .cindex "sender" "uid"
12715 .vindex "&$caller_uid$&"
12716 .vindex "&$originator_uid$&"
12717 The value of &$caller_uid$& that was set when the message was received. For
12718 messages received via the command line, this is the uid of the sending user.
12719 For messages received by SMTP over TCP/IP, this is normally the uid of the Exim
12720 user.
12721
12722 .vitem &$parent_domain$&
12723 .vindex "&$parent_domain$&"
12724 This variable is similar to &$original_domain$& (see
12725 above), except that it refers to the immediately preceding parent address.
12726
12727 .vitem &$parent_local_part$&
12728 .vindex "&$parent_local_part$&"
12729 This variable is similar to &$original_local_part$&
12730 (see above), except that it refers to the immediately preceding parent address.
12731
12732 .vitem &$pid$&
12733 .cindex "pid (process id)" "of current process"
12734 .vindex "&$pid$&"
12735 This variable contains the current process id.
12736
12737 .vitem &$pipe_addresses$&
12738 .cindex "filter" "transport filter"
12739 .cindex "transport" "filter"
12740 .vindex "&$pipe_addresses$&"
12741 This is not an expansion variable, but is mentioned here because the string
12742 &`$pipe_addresses`& is handled specially in the command specification for the
12743 &(pipe)& transport (chapter &<<CHAPpipetransport>>&) and in transport filters
12744 (described under &%transport_filter%& in chapter &<<CHAPtransportgeneric>>&).
12745 It cannot be used in general expansion strings, and provokes an &"unknown
12746 variable"& error if encountered.
12747
12748 .vitem &$primary_hostname$&
12749 .vindex "&$primary_hostname$&"
12750 This variable contains the value set by &%primary_hostname%& in the
12751 configuration file, or read by the &[uname()]& function. If &[uname()]& returns
12752 a single-component name, Exim calls &[gethostbyname()]& (or
12753 &[getipnodebyname()]& where available) in an attempt to acquire a fully
12754 qualified host name. See also &$smtp_active_hostname$&.
12755
12756
12757 .vitem &$proxy_external_address$& &&&
12758        &$proxy_external_port$& &&&
12759        &$proxy_local_address$& &&&
12760        &$proxy_local_port$& &&&
12761        &$proxy_session$&
12762 These variables are only available when built with Proxy Protocol
12763 or SOCKS5 support.
12764 For details see chapter &<<SECTproxyInbound>>&.
12765
12766 .vitem &$prdr_requested$&
12767 .cindex "PRDR" "variable for"
12768 This variable is set to &"yes"& if PRDR was requested by the client for the
12769 current message, otherwise &"no"&.
12770
12771 .vitem &$prvscheck_address$&
12772 This variable is used in conjunction with the &%prvscheck%& expansion item,
12773 which is described in sections &<<SECTexpansionitems>>& and
12774 &<<SECTverifyPRVS>>&.
12775
12776 .vitem &$prvscheck_keynum$&
12777 This variable is used in conjunction with the &%prvscheck%& expansion item,
12778 which is described in sections &<<SECTexpansionitems>>& and
12779 &<<SECTverifyPRVS>>&.
12780
12781 .vitem &$prvscheck_result$&
12782 This variable is used in conjunction with the &%prvscheck%& expansion item,
12783 which is described in sections &<<SECTexpansionitems>>& and
12784 &<<SECTverifyPRVS>>&.
12785
12786 .vitem &$qualify_domain$&
12787 .vindex "&$qualify_domain$&"
12788 The value set for the &%qualify_domain%& option in the configuration file.
12789
12790 .vitem &$qualify_recipient$&
12791 .vindex "&$qualify_recipient$&"
12792 The value set for the &%qualify_recipient%& option in the configuration file,
12793 or if not set, the value of &$qualify_domain$&.
12794
12795 .vitem &$queue_name$&
12796 .vindex &$queue_name$&
12797 .cindex "named queues"
12798 .cindex queues named
12799 The name of the spool queue in use; empty for the default queue.
12800
12801 .new
12802 .vitem &$r_...$&
12803 .vindex &$r_...$&
12804 .cindex router variables
12805 Values can be placed in these variables by the &%set%& option of a router.
12806 They can be given any name that starts with &$r_$&.
12807 The values persist for the address being handled through subsequent routers
12808 and the eventual transport.
12809 .wen
12810
12811 .vitem &$rcpt_count$&
12812 .vindex "&$rcpt_count$&"
12813 When a message is being received by SMTP, this variable contains the number of
12814 RCPT commands received for the current message. If this variable is used in a
12815 RCPT ACL, its value includes the current command.
12816
12817 .vitem &$rcpt_defer_count$&
12818 .vindex "&$rcpt_defer_count$&"
12819 .cindex "4&'xx'& responses" "count of"
12820 When a message is being received by SMTP, this variable contains the number of
12821 RCPT commands in the current message that have previously been rejected with a
12822 temporary (4&'xx'&) response.
12823
12824 .vitem &$rcpt_fail_count$&
12825 .vindex "&$rcpt_fail_count$&"
12826 When a message is being received by SMTP, this variable contains the number of
12827 RCPT commands in the current message that have previously been rejected with a
12828 permanent (5&'xx'&) response.
12829
12830 .vitem &$received_count$&
12831 .vindex "&$received_count$&"
12832 This variable contains the number of &'Received:'& header lines in the message,
12833 including the one added by Exim (so its value is always greater than zero). It
12834 is available in the DATA ACL, the non-SMTP ACL, and while routing and
12835 delivering.
12836
12837 .vitem &$received_for$&
12838 .vindex "&$received_for$&"
12839 If there is only a single recipient address in an incoming message, this
12840 variable contains that address when the &'Received:'& header line is being
12841 built. The value is copied after recipient rewriting has happened, but before
12842 the &[local_scan()]& function is run.
12843
12844 .vitem &$received_ip_address$&
12845 .vindex "&$received_ip_address$&"
12846 As soon as an Exim server starts processing an incoming TCP/IP connection, this
12847 variable is set to the address of the local IP interface, and &$received_port$&
12848 is set to the local port number. (The remote IP address and port are in
12849 &$sender_host_address$& and &$sender_host_port$&.) When testing with &%-bh%&,
12850 the port value is -1 unless it has been set using the &%-oMi%& command line
12851 option.
12852
12853 As well as being useful in ACLs (including the &"connect"& ACL), these variable
12854 could be used, for example, to make the filename for a TLS certificate depend
12855 on which interface and/or port is being used for the incoming connection. The
12856 values of &$received_ip_address$& and &$received_port$& are saved with any
12857 messages that are received, thus making these variables available at delivery
12858 time.
12859 For outbound connections see &$sending_ip_address$&.
12860
12861 .vitem &$received_port$&
12862 .vindex "&$received_port$&"
12863 See &$received_ip_address$&.
12864
12865 .vitem &$received_protocol$&
12866 .vindex "&$received_protocol$&"
12867 When a message is being processed, this variable contains the name of the
12868 protocol by which it was received. Most of the names used by Exim are defined
12869 by RFCs 821, 2821, and 3848. They start with &"smtp"& (the client used HELO) or
12870 &"esmtp"& (the client used EHLO). This can be followed by &"s"& for secure
12871 (encrypted) and/or &"a"& for authenticated. Thus, for example, if the protocol
12872 is set to &"esmtpsa"&, the message was received over an encrypted SMTP
12873 connection and the client was successfully authenticated.
12874
12875 Exim uses the protocol name &"smtps"& for the case when encryption is
12876 automatically set up on connection without the use of STARTTLS (see
12877 &%tls_on_connect_ports%&), and the client uses HELO to initiate the
12878 encrypted SMTP session. The name &"smtps"& is also used for the rare situation
12879 where the client initially uses EHLO, sets up an encrypted connection using
12880 STARTTLS, and then uses HELO afterwards.
12881
12882 The &%-oMr%& option provides a way of specifying a custom protocol name for
12883 messages that are injected locally by trusted callers. This is commonly used to
12884 identify messages that are being re-injected after some kind of scanning.
12885
12886 .vitem &$received_time$&
12887 .vindex "&$received_time$&"
12888 This variable contains the date and time when the current message was received,
12889 as a number of seconds since the start of the Unix epoch.
12890
12891 .vitem &$recipient_data$&
12892 .vindex "&$recipient_data$&"
12893 This variable is set after an indexing lookup success in an ACL &%recipients%&
12894 condition. It contains the data from the lookup, and the value remains set
12895 until the next &%recipients%& test. Thus, you can do things like this:
12896 .display
12897 &`require recipients  = cdb*@;/some/file`&
12898 &`deny    `&&'some further test involving'& &`$recipient_data`&
12899 .endd
12900 &*Warning*&: This variable is set only when a lookup is used as an indexing
12901 method in the address list, using the semicolon syntax as in the example above.
12902 The variable is not set for a lookup that is used as part of the string
12903 expansion that all such lists undergo before being interpreted.
12904
12905 .vitem &$recipient_verify_failure$&
12906 .vindex "&$recipient_verify_failure$&"
12907 In an ACL, when a recipient verification fails, this variable contains
12908 information about the failure. It is set to one of the following words:
12909
12910 .ilist
12911 &"qualify"&: The address was unqualified (no domain), and the message
12912 was neither local nor came from an exempted host.
12913
12914 .next
12915 &"route"&: Routing failed.
12916
12917 .next
12918 &"mail"&: Routing succeeded, and a callout was attempted; rejection occurred at
12919 or before the MAIL command (that is, on initial connection, HELO, or
12920 MAIL).
12921
12922 .next
12923 &"recipient"&: The RCPT command in a callout was rejected.
12924 .next
12925
12926 &"postmaster"&: The postmaster check in a callout was rejected.
12927 .endlist
12928
12929 The main use of this variable is expected to be to distinguish between
12930 rejections of MAIL and rejections of RCPT.
12931
12932 .vitem &$recipients$&
12933 .vindex "&$recipients$&"
12934 This variable contains a list of envelope recipients for a message. A comma and
12935 a space separate the addresses in the replacement text. However, the variable
12936 is not generally available, to prevent exposure of Bcc recipients in
12937 unprivileged users' filter files. You can use &$recipients$& only in these
12938 cases:
12939
12940 .olist
12941 In a system filter file.
12942 .next
12943 In the ACLs associated with the DATA command and with non-SMTP messages, that
12944 is, the ACLs defined by &%acl_smtp_predata%&, &%acl_smtp_data%&,
12945 &%acl_smtp_mime%&, &%acl_not_smtp_start%&, &%acl_not_smtp%&, and
12946 &%acl_not_smtp_mime%&.
12947 .next
12948 From within a &[local_scan()]& function.
12949 .endlist
12950
12951
12952 .vitem &$recipients_count$&
12953 .vindex "&$recipients_count$&"
12954 When a message is being processed, this variable contains the number of
12955 envelope recipients that came with the message. Duplicates are not excluded
12956 from the count. While a message is being received over SMTP, the number
12957 increases for each accepted recipient. It can be referenced in an ACL.
12958
12959
12960 .vitem &$regex_match_string$&
12961 .vindex "&$regex_match_string$&"
12962 This variable is set to contain the matching regular expression after a
12963 &%regex%& ACL condition has matched (see section &<<SECTscanregex>>&).
12964
12965 .vitem "&$regex1$&, &$regex2$&, etc"
12966 .cindex "regex submatch variables (&$1regex$& &$2regex$& etc)"
12967 When a &%regex%& or &%mime_regex%& ACL condition succeeds,
12968 these variables contain the
12969 captured substrings identified by the regular expression.
12970
12971
12972 .vitem &$reply_address$&
12973 .vindex "&$reply_address$&"
12974 When a message is being processed, this variable contains the contents of the
12975 &'Reply-To:'& header line if one exists and it is not empty, or otherwise the
12976 contents of the &'From:'& header line. Apart from the removal of leading
12977 white space, the value is not processed in any way. In particular, no RFC 2047
12978 decoding or character code translation takes place.
12979
12980 .vitem &$return_path$&
12981 .vindex "&$return_path$&"
12982 When a message is being delivered, this variable contains the return path &--
12983 the sender field that will be sent as part of the envelope. It is not enclosed
12984 in <> characters. At the start of routing an address, &$return_path$& has the
12985 same value as &$sender_address$&, but if, for example, an incoming message to a
12986 mailing list has been expanded by a router which specifies a different address
12987 for bounce messages, &$return_path$& subsequently contains the new bounce
12988 address, whereas &$sender_address$& always contains the original sender address
12989 that was received with the message. In other words, &$sender_address$& contains
12990 the incoming envelope sender, and &$return_path$& contains the outgoing
12991 envelope sender.
12992
12993 .vitem &$return_size_limit$&
12994 .vindex "&$return_size_limit$&"
12995 This is an obsolete name for &$bounce_return_size_limit$&.
12996
12997 .vitem &$router_name$&
12998 .cindex "router" "name"
12999 .cindex "name" "of router"
13000 .vindex "&$router_name$&"
13001 During the running of a router this variable contains its name.
13002
13003 .vitem &$runrc$&
13004 .cindex "return code" "from &%run%& expansion"
13005 .vindex "&$runrc$&"
13006 This variable contains the return code from a command that is run by the
13007 &%${run...}%& expansion item. &*Warning*&: In a router or transport, you cannot
13008 assume the order in which option values are expanded, except for those
13009 preconditions whose order of testing is documented. Therefore, you cannot
13010 reliably expect to set &$runrc$& by the expansion of one option, and use it in
13011 another.
13012
13013 .vitem &$self_hostname$&
13014 .oindex "&%self%&" "value of host name"
13015 .vindex "&$self_hostname$&"
13016 When an address is routed to a supposedly remote host that turns out to be the
13017 local host, what happens is controlled by the &%self%& generic router option.
13018 One of its values causes the address to be passed to another router. When this
13019 happens, &$self_hostname$& is set to the name of the local host that the
13020 original router encountered. In other circumstances its contents are null.
13021
13022 .vitem &$sender_address$&
13023 .vindex "&$sender_address$&"
13024 When a message is being processed, this variable contains the sender's address
13025 that was received in the message's envelope. The case of letters in the address
13026 is retained, in both the local part and the domain. For bounce messages, the
13027 value of this variable is the empty string. See also &$return_path$&.
13028
13029 .vitem &$sender_address_data$&
13030 .vindex "&$address_data$&"
13031 .vindex "&$sender_address_data$&"
13032 If &$address_data$& is set when the routers are called from an ACL to verify a
13033 sender address, the final value is preserved in &$sender_address_data$&, to
13034 distinguish it from data from a recipient address. The value does not persist
13035 after the end of the current ACL statement. If you want to preserve it for
13036 longer, you can save it in an ACL variable.
13037
13038 .vitem &$sender_address_domain$&
13039 .vindex "&$sender_address_domain$&"
13040 The domain portion of &$sender_address$&.
13041
13042 .vitem &$sender_address_local_part$&
13043 .vindex "&$sender_address_local_part$&"
13044 The local part portion of &$sender_address$&.
13045
13046 .vitem &$sender_data$&
13047 .vindex "&$sender_data$&"
13048 This variable is set after a lookup success in an ACL &%senders%& condition or
13049 in a router &%senders%& option. It contains the data from the lookup, and the
13050 value remains set until the next &%senders%& test. Thus, you can do things like
13051 this:
13052 .display
13053 &`require senders      = cdb*@;/some/file`&
13054 &`deny    `&&'some further test involving'& &`$sender_data`&
13055 .endd
13056 &*Warning*&: This variable is set only when a lookup is used as an indexing
13057 method in the address list, using the semicolon syntax as in the example above.
13058 The variable is not set for a lookup that is used as part of the string
13059 expansion that all such lists undergo before being interpreted.
13060
13061 .vitem &$sender_fullhost$&
13062 .vindex "&$sender_fullhost$&"
13063 When a message is received from a remote host, this variable contains the host
13064 name and IP address in a single string. It ends with the IP address in square
13065 brackets, followed by a colon and a port number if the logging of ports is
13066 enabled. The format of the rest of the string depends on whether the host
13067 issued a HELO or EHLO SMTP command, and whether the host name was verified by
13068 looking up its IP address. (Looking up the IP address can be forced by the
13069 &%host_lookup%& option, independent of verification.) A plain host name at the
13070 start of the string is a verified host name; if this is not present,
13071 verification either failed or was not requested. A host name in parentheses is
13072 the argument of a HELO or EHLO command. This is omitted if it is identical to
13073 the verified host name or to the host's IP address in square brackets.
13074
13075 .vitem &$sender_helo_dnssec$&
13076 .vindex "&$sender_helo_dnssec$&"
13077 This boolean variable is true if a successful HELO verification was
13078 .cindex "DNS" "DNSSEC"
13079 done using DNS information the resolver library stated was authenticated data.
13080
13081 .vitem &$sender_helo_name$&
13082 .vindex "&$sender_helo_name$&"
13083 When a message is received from a remote host that has issued a HELO or EHLO
13084 command, the argument of that command is placed in this variable. It is also
13085 set if HELO or EHLO is used when a message is received using SMTP locally via
13086 the &%-bs%& or &%-bS%& options.
13087
13088 .vitem &$sender_host_address$&
13089 .vindex "&$sender_host_address$&"
13090 When a message is received from a remote host using SMTP,
13091 this variable contains that
13092 host's IP address. For locally non-SMTP submitted messages, it is empty.
13093
13094 .vitem &$sender_host_authenticated$&
13095 .vindex "&$sender_host_authenticated$&"
13096 This variable contains the name (not the public name) of the authenticator
13097 driver that successfully authenticated the client from which the message was
13098 received. It is empty if there was no successful authentication. See also
13099 &$authenticated_id$&.
13100
13101 .vitem &$sender_host_dnssec$&
13102 .vindex "&$sender_host_dnssec$&"
13103 If an attempt to populate &$sender_host_name$& has been made
13104 (by reference, &%hosts_lookup%& or
13105 otherwise) then this boolean will have been set true if, and only if, the
13106 resolver library states that both
13107 the reverse and forward DNS were authenticated data.  At all
13108 other times, this variable is false.
13109
13110 .cindex "DNS" "DNSSEC"
13111 It is likely that you will need to coerce DNSSEC support on in the resolver
13112 library, by setting:
13113 .code
13114 dns_dnssec_ok = 1
13115 .endd
13116
13117 Exim does not perform DNSSEC validation itself, instead leaving that to a
13118 validating resolver (e.g. unbound, or bind with suitable configuration).
13119
13120 If you have changed &%host_lookup_order%& so that &`bydns`& is not the first
13121 mechanism in the list, then this variable will be false.
13122
13123 This requires that your system resolver library support EDNS0 (and that
13124 DNSSEC flags exist in the system headers).  If the resolver silently drops
13125 all EDNS0 options, then this will have no effect.  OpenBSD's asr resolver
13126 is known to currently ignore EDNS0, documented in CAVEATS of asr_run(3).
13127
13128
13129 .vitem &$sender_host_name$&
13130 .vindex "&$sender_host_name$&"
13131 When a message is received from a remote host, this variable contains the
13132 host's name as obtained by looking up its IP address. For messages received by
13133 other means, this variable is empty.
13134
13135 .vindex "&$host_lookup_failed$&"
13136 If the host name has not previously been looked up, a reference to
13137 &$sender_host_name$& triggers a lookup (for messages from remote hosts).
13138 A looked up name is accepted only if it leads back to the original IP address
13139 via a forward lookup. If either the reverse or the forward lookup fails to find
13140 any data, or if the forward lookup does not yield the original IP address,
13141 &$sender_host_name$& remains empty, and &$host_lookup_failed$& is set to &"1"&.
13142
13143 .vindex "&$host_lookup_deferred$&"
13144 However, if either of the lookups cannot be completed (for example, there is a
13145 DNS timeout), &$host_lookup_deferred$& is set to &"1"&, and
13146 &$host_lookup_failed$& remains set to &"0"&.
13147
13148 Once &$host_lookup_failed$& is set to &"1"&, Exim does not try to look up the
13149 host name again if there is a subsequent reference to &$sender_host_name$&
13150 in the same Exim process, but it does try again if &$host_lookup_deferred$&
13151 is set to &"1"&.
13152
13153 Exim does not automatically look up every calling host's name. If you want
13154 maximum efficiency, you should arrange your configuration so that it avoids
13155 these lookups altogether. The lookup happens only if one or more of the
13156 following are true:
13157
13158 .ilist
13159 A string containing &$sender_host_name$& is expanded.
13160 .next
13161 The calling host matches the list in &%host_lookup%&. In the default
13162 configuration, this option is set to *, so it must be changed if lookups are
13163 to be avoided. (In the code, the default for &%host_lookup%& is unset.)
13164 .next
13165 Exim needs the host name in order to test an item in a host list. The items
13166 that require this are described in sections &<<SECThoslispatnam>>& and
13167 &<<SECThoslispatnamsk>>&.
13168 .next
13169 The calling host matches &%helo_try_verify_hosts%& or &%helo_verify_hosts%&.
13170 In this case, the host name is required to compare with the name quoted in any
13171 EHLO or HELO commands that the client issues.
13172 .next
13173 The remote host issues a EHLO or HELO command that quotes one of the
13174 domains in &%helo_lookup_domains%&. The default value of this option is
13175 . ==== As this is a nested list, any displays it contains must be indented
13176 . ==== as otherwise they are too far to the left.
13177 .code
13178   helo_lookup_domains = @ : @[]
13179 .endd
13180 which causes a lookup if a remote host (incorrectly) gives the server's name or
13181 IP address in an EHLO or HELO command.
13182 .endlist
13183
13184
13185 .vitem &$sender_host_port$&
13186 .vindex "&$sender_host_port$&"
13187 When a message is received from a remote host, this variable contains the port
13188 number that was used on the remote host.
13189
13190 .vitem &$sender_ident$&
13191 .vindex "&$sender_ident$&"
13192 When a message is received from a remote host, this variable contains the
13193 identification received in response to an RFC 1413 request. When a message has
13194 been received locally, this variable contains the login name of the user that
13195 called Exim.
13196
13197 .vitem &$sender_rate_$&&'xxx'&
13198 A number of variables whose names begin &$sender_rate_$& are set as part of the
13199 &%ratelimit%& ACL condition. Details are given in section
13200 &<<SECTratelimiting>>&.
13201
13202 .vitem &$sender_rcvhost$&
13203 .cindex "DNS" "reverse lookup"
13204 .cindex "reverse DNS lookup"
13205 .vindex "&$sender_rcvhost$&"
13206 This is provided specifically for use in &'Received:'& headers. It starts with
13207 either the verified host name (as obtained from a reverse DNS lookup) or, if
13208 there is no verified host name, the IP address in square brackets. After that
13209 there may be text in parentheses. When the first item is a verified host name,
13210 the first thing in the parentheses is the IP address in square brackets,
13211 followed by a colon and a port number if port logging is enabled. When the
13212 first item is an IP address, the port is recorded as &"port=&'xxxx'&"& inside
13213 the parentheses.
13214
13215 There may also be items of the form &"helo=&'xxxx'&"& if HELO or EHLO
13216 was used and its argument was not identical to the real host name or IP
13217 address, and &"ident=&'xxxx'&"& if an RFC 1413 ident string is available. If
13218 all three items are present in the parentheses, a newline and tab are inserted
13219 into the string, to improve the formatting of the &'Received:'& header.
13220
13221 .vitem &$sender_verify_failure$&
13222 .vindex "&$sender_verify_failure$&"
13223 In an ACL, when a sender verification fails, this variable contains information
13224 about the failure. The details are the same as for
13225 &$recipient_verify_failure$&.
13226
13227 .vitem &$sending_ip_address$&
13228 .vindex "&$sending_ip_address$&"
13229 This variable is set whenever an outgoing SMTP connection to another host has
13230 been set up. It contains the IP address of the local interface that is being
13231 used. This is useful if a host that has more than one IP address wants to take
13232 on different personalities depending on which one is being used. For incoming
13233 connections, see &$received_ip_address$&.
13234
13235 .vitem &$sending_port$&
13236 .vindex "&$sending_port$&"
13237 This variable is set whenever an outgoing SMTP connection to another host has
13238 been set up. It contains the local port that is being used. For incoming
13239 connections, see &$received_port$&.
13240
13241 .vitem &$smtp_active_hostname$&
13242 .vindex "&$smtp_active_hostname$&"
13243 During an incoming SMTP session, this variable contains the value of the active
13244 host name, as specified by the &%smtp_active_hostname%& option. The value of
13245 &$smtp_active_hostname$& is saved with any message that is received, so its
13246 value can be consulted during routing and delivery.
13247
13248 .vitem &$smtp_command$&
13249 .vindex "&$smtp_command$&"
13250 During the processing of an incoming SMTP command, this variable contains the
13251 entire command. This makes it possible to distinguish between HELO and EHLO in
13252 the HELO ACL, and also to distinguish between commands such as these:
13253 .code
13254 MAIL FROM:<>
13255 MAIL FROM: <>
13256 .endd
13257 For a MAIL command, extra parameters such as SIZE can be inspected. For a RCPT
13258 command, the address in &$smtp_command$& is the original address before any
13259 rewriting, whereas the values in &$local_part$& and &$domain$& are taken from
13260 the address after SMTP-time rewriting.
13261
13262 .vitem &$smtp_command_argument$&
13263 .cindex "SMTP" "command, argument for"
13264 .vindex "&$smtp_command_argument$&"
13265 While an ACL is running to check an SMTP command, this variable contains the
13266 argument, that is, the text that follows the command name, with leading white
13267 space removed. Following the introduction of &$smtp_command$&, this variable is
13268 somewhat redundant, but is retained for backwards compatibility.
13269
13270 .vitem &$smtp_command_history$&
13271 .cindex SMTP "command history"
13272 .vindex "&$smtp_command_history$&"
13273 A comma-separated list (with no whitespace) of the most-recent SMTP commands
13274 received, in time-order left to right.  Only a limited number of commands
13275 are remembered.
13276
13277 .vitem &$smtp_count_at_connection_start$&
13278 .vindex "&$smtp_count_at_connection_start$&"
13279 This variable is set greater than zero only in processes spawned by the Exim
13280 daemon for handling incoming SMTP connections. The name is deliberately long,
13281 in order to emphasize what the contents are. When the daemon accepts a new
13282 connection, it increments this variable. A copy of the variable is passed to
13283 the child process that handles the connection, but its value is fixed, and
13284 never changes. It is only an approximation of how many incoming connections
13285 there actually are, because many other connections may come and go while a
13286 single connection is being processed. When a child process terminates, the
13287 daemon decrements its copy of the variable.
13288
13289 .vitem "&$sn0$& &-- &$sn9$&"
13290 These variables are copies of the values of the &$n0$& &-- &$n9$& accumulators
13291 that were current at the end of the system filter file. This allows a system
13292 filter file to set values that can be tested in users' filter files. For
13293 example, a system filter could set a value indicating how likely it is that a
13294 message is junk mail.
13295
13296 .vitem &$spam_$&&'xxx'&
13297 A number of variables whose names start with &$spam$& are available when Exim
13298 is compiled with the content-scanning extension. For details, see section
13299 &<<SECTscanspamass>>&.
13300
13301 .vitem &$spf_header_comment$& &&&
13302        &$spf_received$& &&&
13303        &$spf_result$& &&&
13304        &$spf_result_guessed$& &&&
13305        &$spf_smtp_comment$&
13306 These variables are only available if Exim is built with SPF support.
13307 For details see section &<<SECSPF>>&.
13308
13309 .vitem &$spool_directory$&
13310 .vindex "&$spool_directory$&"
13311 The name of Exim's spool directory.
13312
13313 .vitem &$spool_inodes$&
13314 .vindex "&$spool_inodes$&"
13315 The number of free inodes in the disk partition where Exim's spool files are
13316 being written. The value is recalculated whenever the variable is referenced.
13317 If the relevant file system does not have the concept of inodes, the value of
13318 is -1. See also the &%check_spool_inodes%& option.
13319
13320 .vitem &$spool_space$&
13321 .vindex "&$spool_space$&"
13322 The amount of free space (as a number of kilobytes) in the disk partition where
13323 Exim's spool files are being written. The value is recalculated whenever the
13324 variable is referenced. If the operating system does not have the ability to
13325 find the amount of free space (only true for experimental systems), the space
13326 value is -1. For example, to check in an ACL that there is at least 50
13327 megabytes free on the spool, you could write:
13328 .code
13329 condition = ${if > {$spool_space}{50000}}
13330 .endd
13331 See also the &%check_spool_space%& option.
13332
13333
13334 .vitem &$thisaddress$&
13335 .vindex "&$thisaddress$&"
13336 This variable is set only during the processing of the &%foranyaddress%&
13337 command in a filter file. Its use is explained in the description of that
13338 command, which can be found in the separate document entitled &'Exim's
13339 interfaces to mail filtering'&.
13340
13341 .vitem &$tls_in_bits$&
13342 .vindex "&$tls_in_bits$&"
13343 Contains an approximation of the TLS cipher's bit-strength
13344 on the inbound connection; the meaning of
13345 this depends upon the TLS implementation used.
13346 If TLS has not been negotiated, the value will be 0.
13347 The value of this is automatically fed into the Cyrus SASL authenticator
13348 when acting as a server, to specify the "external SSF" (a SASL term).
13349
13350 The deprecated &$tls_bits$& variable refers to the inbound side
13351 except when used in the context of an outbound SMTP delivery, when it refers to
13352 the outbound.
13353
13354 .vitem &$tls_out_bits$&
13355 .vindex "&$tls_out_bits$&"
13356 Contains an approximation of the TLS cipher's bit-strength
13357 on an outbound SMTP connection; the meaning of
13358 this depends upon the TLS implementation used.
13359 If TLS has not been negotiated, the value will be 0.
13360
13361 .vitem &$tls_in_ourcert$&
13362 .vindex "&$tls_in_ourcert$&"
13363 .cindex certificate variables
13364 This variable refers to the certificate presented to the peer of an
13365 inbound connection when the message was received.
13366 It is only useful as the argument of a
13367 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
13368 or a &%def%& condition.
13369
13370 &*Note*&: Under versions of OpenSSL preceding 1.1.1,
13371 when a list of more than one
13372 file is used for &%tls_certificate%&, this variable is not reliable.
13373 .new
13374 The macro "_TLS_BAD_MULTICERT_IN_OURCERT" will be defined for those versions.
13375 .wen
13376
13377 .vitem &$tls_in_peercert$&
13378 .vindex "&$tls_in_peercert$&"
13379 This variable refers to the certificate presented by the peer of an
13380 inbound connection when the message was received.
13381 It is only useful as the argument of a
13382 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
13383 or a &%def%& condition.
13384 If certificate verification fails it may refer to a failing chain element
13385 which is not the leaf.
13386
13387 .vitem &$tls_out_ourcert$&
13388 .vindex "&$tls_out_ourcert$&"
13389 This variable refers to the certificate presented to the peer of an
13390 outbound connection.  It is only useful as the argument of a
13391 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
13392 or a &%def%& condition.
13393
13394 .vitem &$tls_out_peercert$&
13395 .vindex "&$tls_out_peercert$&"
13396 This variable refers to the certificate presented by the peer of an
13397 outbound connection.  It is only useful as the argument of a
13398 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
13399 or a &%def%& condition.
13400 If certificate verification fails it may refer to a failing chain element
13401 which is not the leaf.
13402
13403 .vitem &$tls_in_certificate_verified$&
13404 .vindex "&$tls_in_certificate_verified$&"
13405 This variable is set to &"1"& if a TLS certificate was verified when the
13406 message was received, and &"0"& otherwise.
13407
13408 The deprecated &$tls_certificate_verified$& variable refers to the inbound side
13409 except when used in the context of an outbound SMTP delivery, when it refers to
13410 the outbound.
13411
13412 .vitem &$tls_out_certificate_verified$&
13413 .vindex "&$tls_out_certificate_verified$&"
13414 This variable is set to &"1"& if a TLS certificate was verified when an
13415 outbound SMTP connection was made,
13416 and &"0"& otherwise.
13417
13418 .vitem &$tls_in_cipher$&
13419 .vindex "&$tls_in_cipher$&"
13420 .vindex "&$tls_cipher$&"
13421 When a message is received from a remote host over an encrypted SMTP
13422 connection, this variable is set to the cipher suite that was negotiated, for
13423 example DES-CBC3-SHA. In other circumstances, in particular, for message
13424 received over unencrypted connections, the variable is empty. Testing
13425 &$tls_in_cipher$& for emptiness is one way of distinguishing between encrypted and
13426 non-encrypted connections during ACL processing.
13427
13428 The deprecated &$tls_cipher$& variable is the same as &$tls_in_cipher$& during message reception,
13429 but in the context of an outward SMTP delivery taking place via the &(smtp)& transport
13430 becomes the same as &$tls_out_cipher$&.
13431
13432 .new
13433 .vitem &$tls_in_cipher_std$&
13434 .vindex "&$tls_in_cipher_std$&"
13435 As above, but returning the RFC standard name for the cipher suite.
13436 .wen
13437
13438 .vitem &$tls_out_cipher$&
13439 .vindex "&$tls_out_cipher$&"
13440 This variable is
13441 cleared before any outgoing SMTP connection is made,
13442 and then set to the outgoing cipher suite if one is negotiated. See chapter
13443 &<<CHAPTLS>>& for details of TLS support and chapter &<<CHAPsmtptrans>>& for
13444 details of the &(smtp)& transport.
13445
13446 ,new
13447 .vitem &$tls_out_cipher_std$&
13448 .vindex "&$tls_out_cipher_std$&"
13449 As above, but returning the RFC standard name for the cipher suite.
13450 .wen
13451
13452 .vitem &$tls_out_dane$&
13453 .vindex &$tls_out_dane$&
13454 DANE active status.  See section &<<SECDANE>>&.
13455
13456 .vitem &$tls_in_ocsp$&
13457 .vindex "&$tls_in_ocsp$&"
13458 When a message is received from a remote client connection
13459 the result of any OCSP request from the client is encoded in this variable:
13460 .code
13461 0 OCSP proof was not requested (default value)
13462 1 No response to request
13463 2 Response not verified
13464 3 Verification failed
13465 4 Verification succeeded
13466 .endd
13467
13468 .vitem &$tls_out_ocsp$&
13469 .vindex "&$tls_out_ocsp$&"
13470 When a message is sent to a remote host connection
13471 the result of any OCSP request made is encoded in this variable.
13472 See &$tls_in_ocsp$& for values.
13473
13474 .vitem &$tls_in_peerdn$&
13475 .vindex "&$tls_in_peerdn$&"
13476 .vindex "&$tls_peerdn$&"
13477 .cindex certificate "extracting fields"
13478 When a message is received from a remote host over an encrypted SMTP
13479 connection, and Exim is configured to request a certificate from the client,
13480 the value of the Distinguished Name of the certificate is made available in the
13481 &$tls_in_peerdn$& during subsequent processing.
13482 If certificate verification fails it may refer to a failing chain element
13483 which is not the leaf.
13484
13485 The deprecated &$tls_peerdn$& variable refers to the inbound side
13486 except when used in the context of an outbound SMTP delivery, when it refers to
13487 the outbound.
13488
13489 .vitem &$tls_out_peerdn$&
13490 .vindex "&$tls_out_peerdn$&"
13491 When a message is being delivered to a remote host over an encrypted SMTP
13492 connection, and Exim is configured to request a certificate from the server,
13493 the value of the Distinguished Name of the certificate is made available in the
13494 &$tls_out_peerdn$& during subsequent processing.
13495 If certificate verification fails it may refer to a failing chain element
13496 which is not the leaf.
13497
13498 .vitem &$tls_in_sni$&
13499 .vindex "&$tls_in_sni$&"
13500 .vindex "&$tls_sni$&"
13501 .cindex "TLS" "Server Name Indication"
13502 When a TLS session is being established, if the client sends the Server
13503 Name Indication extension, the value will be placed in this variable.
13504 If the variable appears in &%tls_certificate%& then this option and
13505 some others, described in &<<SECTtlssni>>&,
13506 will be re-expanded early in the TLS session, to permit
13507 a different certificate to be presented (and optionally a different key to be
13508 used) to the client, based upon the value of the SNI extension.
13509
13510 The deprecated &$tls_sni$& variable refers to the inbound side
13511 except when used in the context of an outbound SMTP delivery, when it refers to
13512 the outbound.
13513
13514 .vitem &$tls_out_sni$&
13515 .vindex "&$tls_out_sni$&"
13516 .cindex "TLS" "Server Name Indication"
13517 During outbound
13518 SMTP deliveries, this variable reflects the value of the &%tls_sni%& option on
13519 the transport.
13520
13521 .vitem &$tls_out_tlsa_usage$&
13522 .vindex &$tls_out_tlsa_usage$&
13523 Bitfield of TLSA record types found.  See section &<<SECDANE>>&.
13524
13525 .vitem &$tod_bsdinbox$&
13526 .vindex "&$tod_bsdinbox$&"
13527 The time of day and the date, in the format required for BSD-style mailbox
13528 files, for example: Thu Oct 17 17:14:09 1995.
13529
13530 .vitem &$tod_epoch$&
13531 .vindex "&$tod_epoch$&"
13532 The time and date as a number of seconds since the start of the Unix epoch.
13533
13534 .vitem &$tod_epoch_l$&
13535 .vindex "&$tod_epoch_l$&"
13536 The time and date as a number of microseconds since the start of the Unix epoch.
13537
13538 .vitem &$tod_full$&
13539 .vindex "&$tod_full$&"
13540 A full version of the time and date, for example: Wed, 16 Oct 1995 09:51:40
13541 +0100. The timezone is always given as a numerical offset from UTC, with
13542 positive values used for timezones that are ahead (east) of UTC, and negative
13543 values for those that are behind (west).
13544
13545 .vitem &$tod_log$&
13546 .vindex "&$tod_log$&"
13547 The time and date in the format used for writing Exim's log files, for example:
13548 1995-10-12 15:32:29, but without a timezone.
13549
13550 .vitem &$tod_logfile$&
13551 .vindex "&$tod_logfile$&"
13552 This variable contains the date in the format yyyymmdd. This is the format that
13553 is used for datestamping log files when &%log_file_path%& contains the &`%D`&
13554 flag.
13555
13556 .vitem &$tod_zone$&
13557 .vindex "&$tod_zone$&"
13558 This variable contains the numerical value of the local timezone, for example:
13559 -0500.
13560
13561 .vitem &$tod_zulu$&
13562 .vindex "&$tod_zulu$&"
13563 This variable contains the UTC date and time in &"Zulu"& format, as specified
13564 by ISO 8601, for example: 20030221154023Z.
13565
13566 .vitem &$transport_name$&
13567 .cindex "transport" "name"
13568 .cindex "name" "of transport"
13569 .vindex "&$transport_name$&"
13570 During the running of a transport, this variable contains its name.
13571
13572 .vitem &$value$&
13573 .vindex "&$value$&"
13574 This variable contains the result of an expansion lookup, extraction operation,
13575 or external command, as described above. It is also used during a
13576 &*reduce*& expansion.
13577
13578 .vitem &$verify_mode$&
13579 .vindex "&$verify_mode$&"
13580 While a router or transport is being run in verify mode or for cutthrough delivery,
13581 contains "S" for sender-verification or "R" for recipient-verification.
13582 Otherwise, empty.
13583
13584 .vitem &$version_number$&
13585 .vindex "&$version_number$&"
13586 The version number of Exim. Same as &$exim_version$&, may be overridden
13587 by the &%exim_version%& main config option.
13588
13589 .vitem &$warn_message_delay$&
13590 .vindex "&$warn_message_delay$&"
13591 This variable is set only during the creation of a message warning about a
13592 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
13593
13594 .vitem &$warn_message_recipients$&
13595 .vindex "&$warn_message_recipients$&"
13596 This variable is set only during the creation of a message warning about a
13597 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
13598 .endlist
13599 .ecindex IIDstrexp
13600
13601
13602
13603 . ////////////////////////////////////////////////////////////////////////////
13604 . ////////////////////////////////////////////////////////////////////////////
13605
13606 .chapter "Embedded Perl" "CHAPperl"
13607 .scindex IIDperl "Perl" "calling from Exim"
13608 Exim can be built to include an embedded Perl interpreter. When this is done,
13609 Perl subroutines can be called as part of the string expansion process. To make
13610 use of the Perl support, you need version 5.004 or later of Perl installed on
13611 your system. To include the embedded interpreter in the Exim binary, include
13612 the line
13613 .code
13614 EXIM_PERL = perl.o
13615 .endd
13616 in your &_Local/Makefile_& and then build Exim in the normal way.
13617
13618
13619 .section "Setting up so Perl can be used" "SECID85"
13620 .oindex "&%perl_startup%&"
13621 Access to Perl subroutines is via a global configuration option called
13622 &%perl_startup%& and an expansion string operator &%${perl ...}%&. If there is
13623 no &%perl_startup%& option in the Exim configuration file then no Perl
13624 interpreter is started and there is almost no overhead for Exim (since none of
13625 the Perl library will be paged in unless used). If there is a &%perl_startup%&
13626 option then the associated value is taken to be Perl code which is executed in
13627 a newly created Perl interpreter.
13628
13629 The value of &%perl_startup%& is not expanded in the Exim sense, so you do not
13630 need backslashes before any characters to escape special meanings. The option
13631 should usually be something like
13632 .code
13633 perl_startup = do '/etc/exim.pl'
13634 .endd
13635 where &_/etc/exim.pl_& is Perl code which defines any subroutines you want to
13636 use from Exim. Exim can be configured either to start up a Perl interpreter as
13637 soon as it is entered, or to wait until the first time it is needed. Starting
13638 the interpreter at the beginning ensures that it is done while Exim still has
13639 its setuid privilege, but can impose an unnecessary overhead if Perl is not in
13640 fact used in a particular run. Also, note that this does not mean that Exim is
13641 necessarily running as root when Perl is called at a later time. By default,
13642 the interpreter is started only when it is needed, but this can be changed in
13643 two ways:
13644
13645 .ilist
13646 .oindex "&%perl_at_start%&"
13647 Setting &%perl_at_start%& (a boolean option) in the configuration requests
13648 a startup when Exim is entered.
13649 .next
13650 The command line option &%-ps%& also requests a startup when Exim is entered,
13651 overriding the setting of &%perl_at_start%&.
13652 .endlist
13653
13654 There is also a command line option &%-pd%& (for delay) which suppresses the
13655 initial startup, even if &%perl_at_start%& is set.
13656
13657 .ilist
13658 .oindex "&%perl_taintmode%&"
13659 .cindex "Perl" "taintmode"
13660 To provide more security executing Perl code via the embedded Perl
13661 interpreter, the &%perl_taintmode%& option can be set. This enables the
13662 taint mode of the Perl interpreter. You are encouraged to set this
13663 option to a true value. To avoid breaking existing installations, it
13664 defaults to false.
13665
13666
13667 .section "Calling Perl subroutines" "SECID86"
13668 When the configuration file includes a &%perl_startup%& option you can make use
13669 of the string expansion item to call the Perl subroutines that are defined
13670 by the &%perl_startup%& code. The operator is used in any of the following
13671 forms:
13672 .code
13673 ${perl{foo}}
13674 ${perl{foo}{argument}}
13675 ${perl{foo}{argument1}{argument2} ... }
13676 .endd
13677 which calls the subroutine &%foo%& with the given arguments. A maximum of eight
13678 arguments may be passed. Passing more than this results in an expansion failure
13679 with an error message of the form
13680 .code
13681 Too many arguments passed to Perl subroutine "foo" (max is 8)
13682 .endd
13683 The return value of the Perl subroutine is evaluated in a scalar context before
13684 it is passed back to Exim to be inserted into the expanded string. If the
13685 return value is &'undef'&, the expansion is forced to fail in the same way as
13686 an explicit &"fail"& on an &%if%& or &%lookup%& item. If the subroutine aborts
13687 by obeying Perl's &%die%& function, the expansion fails with the error message
13688 that was passed to &%die%&.
13689
13690
13691 .section "Calling Exim functions from Perl" "SECID87"
13692 Within any Perl code called from Exim, the function &'Exim::expand_string()'&
13693 is available to call back into Exim's string expansion function. For example,
13694 the Perl code
13695 .code
13696 my $lp = Exim::expand_string('$local_part');
13697 .endd
13698 makes the current Exim &$local_part$& available in the Perl variable &$lp$&.
13699 Note those are single quotes and not double quotes to protect against
13700 &$local_part$& being interpolated as a Perl variable.
13701
13702 If the string expansion is forced to fail by a &"fail"& item, the result of
13703 &'Exim::expand_string()'& is &%undef%&. If there is a syntax error in the
13704 expansion string, the Perl call from the original expansion string fails with
13705 an appropriate error message, in the same way as if &%die%& were used.
13706
13707 .cindex "debugging" "from embedded Perl"
13708 .cindex "log" "writing from embedded Perl"
13709 Two other Exim functions are available for use from within Perl code.
13710 &'Exim::debug_write()'& writes a string to the standard error stream if Exim's
13711 debugging is enabled. If you want a newline at the end, you must supply it.
13712 &'Exim::log_write()'& writes a string to Exim's main log, adding a leading
13713 timestamp. In this case, you should not supply a terminating newline.
13714
13715
13716 .section "Use of standard output and error by Perl" "SECID88"
13717 .cindex "Perl" "standard output and error"
13718 You should not write to the standard error or output streams from within your
13719 Perl code, as it is not defined how these are set up. In versions of Exim
13720 before 4.50, it is possible for the standard output or error to refer to the
13721 SMTP connection during message reception via the daemon. Writing to this stream
13722 is certain to cause chaos. From Exim 4.50 onwards, the standard output and
13723 error streams are connected to &_/dev/null_& in the daemon. The chaos is
13724 avoided, but the output is lost.
13725
13726 .cindex "Perl" "use of &%warn%&"
13727 The Perl &%warn%& statement writes to the standard error stream by default.
13728 Calls to &%warn%& may be embedded in Perl modules that you use, but over which
13729 you have no control. When Exim starts up the Perl interpreter, it arranges for
13730 output from the &%warn%& statement to be written to the Exim main log. You can
13731 change this by including appropriate Perl magic somewhere in your Perl code.
13732 For example, to discard &%warn%& output completely, you need this:
13733 .code
13734 $SIG{__WARN__} = sub { };
13735 .endd
13736 Whenever a &%warn%& is obeyed, the anonymous subroutine is called. In this
13737 example, the code for the subroutine is empty, so it does nothing, but you can
13738 include any Perl code that you like. The text of the &%warn%& message is passed
13739 as the first subroutine argument.
13740 .ecindex IIDperl
13741
13742
13743 . ////////////////////////////////////////////////////////////////////////////
13744 . ////////////////////////////////////////////////////////////////////////////
13745
13746 .chapter "Starting the daemon and the use of network interfaces" &&&
13747          "CHAPinterfaces" &&&
13748          "Starting the daemon"
13749 .cindex "daemon" "starting"
13750 .cindex "interface" "listening"
13751 .cindex "network interface"
13752 .cindex "interface" "network"
13753 .cindex "IP address" "for listening"
13754 .cindex "daemon" "listening IP addresses"
13755 .cindex "TCP/IP" "setting listening interfaces"
13756 .cindex "TCP/IP" "setting listening ports"
13757 A host that is connected to a TCP/IP network may have one or more physical
13758 hardware network interfaces. Each of these interfaces may be configured as one
13759 or more &"logical"& interfaces, which are the entities that a program actually
13760 works with. Each of these logical interfaces is associated with an IP address.
13761 In addition, TCP/IP software supports &"loopback"& interfaces (127.0.0.1 in
13762 IPv4 and ::1 in IPv6), which do not use any physical hardware. Exim requires
13763 knowledge about the host's interfaces for use in three different circumstances:
13764
13765 .olist
13766 When a listening daemon is started, Exim needs to know which interfaces
13767 and ports to listen on.
13768 .next
13769 When Exim is routing an address, it needs to know which IP addresses
13770 are associated with local interfaces. This is required for the correct
13771 processing of MX lists by removing the local host and others with the
13772 same or higher priority values. Also, Exim needs to detect cases
13773 when an address is routed to an IP address that in fact belongs to the
13774 local host. Unless the &%self%& router option or the &%allow_localhost%&
13775 option of the smtp transport is set (as appropriate), this is treated
13776 as an error situation.
13777 .next
13778 When Exim connects to a remote host, it may need to know which interface to use
13779 for the outgoing connection.
13780 .endlist
13781
13782
13783 Exim's default behaviour is likely to be appropriate in the vast majority
13784 of cases. If your host has only one interface, and you want all its IP
13785 addresses to be treated in the same way, and you are using only the
13786 standard SMTP port, you should not need to take any special action. The
13787 rest of this chapter does not apply to you.
13788
13789 In a more complicated situation you may want to listen only on certain
13790 interfaces, or on different ports, and for this reason there are a number of
13791 options that can be used to influence Exim's behaviour. The rest of this
13792 chapter describes how they operate.
13793
13794 When a message is received over TCP/IP, the interface and port that were
13795 actually used are set in &$received_ip_address$& and &$received_port$&.
13796
13797
13798
13799 .section "Starting a listening daemon" "SECID89"
13800 When a listening daemon is started (by means of the &%-bd%& command line
13801 option), the interfaces and ports on which it listens are controlled by the
13802 following options:
13803
13804 .ilist
13805 &%daemon_smtp_ports%& contains a list of default ports
13806 or service names.
13807 (For backward compatibility, this option can also be specified in the singular.)
13808 .next
13809 &%local_interfaces%& contains list of interface IP addresses on which to
13810 listen. Each item may optionally also specify a port.
13811 .endlist
13812
13813 The default list separator in both cases is a colon, but this can be changed as
13814 described in section &<<SECTlistsepchange>>&. When IPv6 addresses are involved,
13815 it is usually best to change the separator to avoid having to double all the
13816 colons. For example:
13817 .code
13818 local_interfaces = <; 127.0.0.1 ; \
13819                       192.168.23.65 ; \
13820                       ::1 ; \
13821                       3ffe:ffff:836f::fe86:a061
13822 .endd
13823 There are two different formats for specifying a port along with an IP address
13824 in &%local_interfaces%&:
13825
13826 .olist
13827 The port is added onto the address with a dot separator. For example, to listen
13828 on port 1234 on two different IP addresses:
13829 .code
13830 local_interfaces = <; 192.168.23.65.1234 ; \
13831                       3ffe:ffff:836f::fe86:a061.1234
13832 .endd
13833 .next
13834 The IP address is enclosed in square brackets, and the port is added
13835 with a colon separator, for example:
13836 .code
13837 local_interfaces = <; [192.168.23.65]:1234 ; \
13838                       [3ffe:ffff:836f::fe86:a061]:1234
13839 .endd
13840 .endlist
13841
13842 When a port is not specified, the value of &%daemon_smtp_ports%& is used. The
13843 default setting contains just one port:
13844 .code
13845 daemon_smtp_ports = smtp
13846 .endd
13847 If more than one port is listed, each interface that does not have its own port
13848 specified listens on all of them. Ports that are listed in
13849 &%daemon_smtp_ports%& can be identified either by name (defined in
13850 &_/etc/services_&) or by number. However, when ports are given with individual
13851 IP addresses in &%local_interfaces%&, only numbers (not names) can be used.
13852
13853
13854
13855 .section "Special IP listening addresses" "SECID90"
13856 The addresses 0.0.0.0 and ::0 are treated specially. They are interpreted
13857 as &"all IPv4 interfaces"& and &"all IPv6 interfaces"&, respectively. In each
13858 case, Exim tells the TCP/IP stack to &"listen on all IPv&'x'& interfaces"&
13859 instead of setting up separate listening sockets for each interface. The
13860 default value of &%local_interfaces%& is
13861 .code
13862 local_interfaces = 0.0.0.0
13863 .endd
13864 when Exim is built without IPv6 support; otherwise it is:
13865 .code
13866 local_interfaces = <; ::0 ; 0.0.0.0
13867 .endd
13868 Thus, by default, Exim listens on all available interfaces, on the SMTP port.
13869
13870
13871
13872 .section "Overriding local_interfaces and daemon_smtp_ports" "SECID91"
13873 The &%-oX%& command line option can be used to override the values of
13874 &%daemon_smtp_ports%& and/or &%local_interfaces%& for a particular daemon
13875 instance. Another way of doing this would be to use macros and the &%-D%&
13876 option. However, &%-oX%& can be used by any admin user, whereas modification of
13877 the runtime configuration by &%-D%& is allowed only when the caller is root or
13878 exim.
13879
13880 The value of &%-oX%& is a list of items. The default colon separator can be
13881 changed in the usual way (&<<SECTlistsepchange>>&) if required.
13882 If there are any items that do not
13883 contain dots or colons (that is, are not IP addresses), the value of
13884 &%daemon_smtp_ports%& is replaced by the list of those items. If there are any
13885 items that do contain dots or colons, the value of &%local_interfaces%& is
13886 replaced by those items. Thus, for example,
13887 .code
13888 -oX 1225
13889 .endd
13890 overrides &%daemon_smtp_ports%&, but leaves &%local_interfaces%& unchanged,
13891 whereas
13892 .code
13893 -oX 192.168.34.5.1125
13894 .endd
13895 overrides &%local_interfaces%&, leaving &%daemon_smtp_ports%& unchanged.
13896 (However, since &%local_interfaces%& now contains no items without ports, the
13897 value of &%daemon_smtp_ports%& is no longer relevant in this example.)
13898
13899
13900
13901 .section "Support for the submissions (aka SSMTP or SMTPS) protocol" "SECTsupobssmt"
13902 .cindex "submissions protocol"
13903 .cindex "ssmtp protocol"
13904 .cindex "smtps protocol"
13905 .cindex "SMTP" "ssmtp protocol"
13906 .cindex "SMTP" "smtps protocol"
13907 Exim supports the use of TLS-on-connect, used by mail clients in the
13908 &"submissions"& protocol, historically also known as SMTPS or SSMTP.
13909 For some years, IETF Standards Track documents only blessed the
13910 STARTTLS-based Submission service (port 587) while common practice was to support
13911 the same feature set on port 465, but using TLS-on-connect.
13912 If your installation needs to provide service to mail clients
13913 (Mail User Agents, MUAs) then you should provide service on both the 587 and
13914 the 465 TCP ports.
13915
13916 If the &%tls_on_connect_ports%& option is set to a list of port numbers or
13917 service names, connections to those ports must first establish TLS, before
13918 proceeding to the application layer use of the SMTP protocol.
13919
13920 The common use of this option is expected to be
13921 .code
13922 tls_on_connect_ports = 465
13923 .endd
13924 per RFC 8314.
13925 There is also a command line option &%-tls-on-connect%&, which forces all ports
13926 to behave in this way when a daemon is started.
13927
13928 &*Warning*&: Setting &%tls_on_connect_ports%& does not of itself cause the
13929 daemon to listen on those ports. You must still specify them in
13930 &%daemon_smtp_ports%&, &%local_interfaces%&, or the &%-oX%& option. (This is
13931 because &%tls_on_connect_ports%& applies to &%inetd%& connections as well as to
13932 connections via the daemon.)
13933
13934
13935
13936
13937 .section "IPv6 address scopes" "SECID92"
13938 .cindex "IPv6" "address scopes"
13939 IPv6 addresses have &"scopes"&, and a host with multiple hardware interfaces
13940 can, in principle, have the same link-local IPv6 address on different
13941 interfaces. Thus, additional information is needed, over and above the IP
13942 address, to distinguish individual interfaces. A convention of using a
13943 percent sign followed by something (often the interface name) has been
13944 adopted in some cases, leading to addresses like this:
13945 .code
13946 fe80::202:b3ff:fe03:45c1%eth0
13947 .endd
13948 To accommodate this usage, a percent sign followed by an arbitrary string is
13949 allowed at the end of an IPv6 address. By default, Exim calls &[getaddrinfo()]&
13950 to convert a textual IPv6 address for actual use. This function recognizes the
13951 percent convention in operating systems that support it, and it processes the
13952 address appropriately. Unfortunately, some older libraries have problems with
13953 &[getaddrinfo()]&. If
13954 .code
13955 IPV6_USE_INET_PTON=yes
13956 .endd
13957 is set in &_Local/Makefile_& (or an OS-dependent Makefile) when Exim is built,
13958 Exim uses &'inet_pton()'& to convert a textual IPv6 address for actual use,
13959 instead of &[getaddrinfo()]&. (Before version 4.14, it always used this
13960 function.) Of course, this means that the additional functionality of
13961 &[getaddrinfo()]& &-- recognizing scoped addresses &-- is lost.
13962
13963 .section "Disabling IPv6" "SECID93"
13964 .cindex "IPv6" "disabling"
13965 Sometimes it happens that an Exim binary that was compiled with IPv6 support is
13966 run on a host whose kernel does not support IPv6. The binary will fall back to
13967 using IPv4, but it may waste resources looking up AAAA records, and trying to
13968 connect to IPv6 addresses, causing delays to mail delivery. If you set the
13969 .oindex "&%disable_ipv6%&"
13970 &%disable_ipv6%& option true, even if the Exim binary has IPv6 support, no IPv6
13971 activities take place. AAAA records are never looked up, and any IPv6 addresses
13972 that are listed in &%local_interfaces%&, data for the &(manualroute)& router,
13973 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
13974 to handle IPv6 literal addresses.
13975
13976 On the other hand, when IPv6 is in use, there may be times when you want to
13977 disable it for certain hosts or domains. You can use the &%dns_ipv4_lookup%&
13978 option to globally suppress the lookup of AAAA records for specified domains,
13979 and you can use the &%ignore_target_hosts%& generic router option to ignore
13980 IPv6 addresses in an individual router.
13981
13982
13983
13984 .section "Examples of starting a listening daemon" "SECID94"
13985 The default case in an IPv6 environment is
13986 .code
13987 daemon_smtp_ports = smtp
13988 local_interfaces = <; ::0 ; 0.0.0.0
13989 .endd
13990 This specifies listening on the smtp port on all IPv6 and IPv4 interfaces.
13991 Either one or two sockets may be used, depending on the characteristics of
13992 the TCP/IP stack. (This is complicated and messy; for more information,
13993 read the comments in the &_daemon.c_& source file.)
13994
13995 To specify listening on ports 25 and 26 on all interfaces:
13996 .code
13997 daemon_smtp_ports = 25 : 26
13998 .endd
13999 (leaving &%local_interfaces%& at the default setting) or, more explicitly:
14000 .code
14001 local_interfaces = <; ::0.25     ; ::0.26 \
14002                       0.0.0.0.25 ; 0.0.0.0.26
14003 .endd
14004 To listen on the default port on all IPv4 interfaces, and on port 26 on the
14005 IPv4 loopback address only:
14006 .code
14007 local_interfaces = 0.0.0.0 : 127.0.0.1.26
14008 .endd
14009 To specify listening on the default port on specific interfaces only:
14010 .code
14011 local_interfaces = 10.0.0.67 : 192.168.34.67
14012 .endd
14013 &*Warning*&: Such a setting excludes listening on the loopback interfaces.
14014
14015
14016
14017 .section "Recognizing the local host" "SECTreclocipadd"
14018 The &%local_interfaces%& option is also used when Exim needs to determine
14019 whether or not an IP address refers to the local host. That is, the IP
14020 addresses of all the interfaces on which a daemon is listening are always
14021 treated as local.
14022
14023 For this usage, port numbers in &%local_interfaces%& are ignored. If either of
14024 the items 0.0.0.0 or ::0 are encountered, Exim gets a complete list of
14025 available interfaces from the operating system, and extracts the relevant
14026 (that is, IPv4 or IPv6) addresses to use for checking.
14027
14028 Some systems set up large numbers of virtual interfaces in order to provide
14029 many virtual web servers. In this situation, you may want to listen for
14030 email on only a few of the available interfaces, but nevertheless treat all
14031 interfaces as local when routing. You can do this by setting
14032 &%extra_local_interfaces%& to a list of IP addresses, possibly including the
14033 &"all"& wildcard values. These addresses are recognized as local, but are not
14034 used for listening. Consider this example:
14035 .code
14036 local_interfaces = <; 127.0.0.1 ; ::1 ; \
14037                       192.168.53.235 ; \
14038                       3ffe:2101:12:1:a00:20ff:fe86:a061
14039
14040 extra_local_interfaces = <; ::0 ; 0.0.0.0
14041 .endd
14042 The daemon listens on the loopback interfaces and just one IPv4 and one IPv6
14043 address, but all available interface addresses are treated as local when
14044 Exim is routing.
14045
14046 In some environments the local host name may be in an MX list, but with an IP
14047 address that is not assigned to any local interface. In other cases it may be
14048 desirable to treat other host names as if they referred to the local host. Both
14049 these cases can be handled by setting the &%hosts_treat_as_local%& option.
14050 This contains host names rather than IP addresses. When a host is referenced
14051 during routing, either via an MX record or directly, it is treated as the local
14052 host if its name matches &%hosts_treat_as_local%&, or if any of its IP
14053 addresses match &%local_interfaces%& or &%extra_local_interfaces%&.
14054
14055
14056
14057 .section "Delivering to a remote host" "SECID95"
14058 Delivery to a remote host is handled by the smtp transport. By default, it
14059 allows the system's TCP/IP functions to choose which interface to use (if
14060 there is more than one) when connecting to a remote host. However, the
14061 &%interface%& option can be set to specify which interface is used. See the
14062 description of the smtp transport in chapter &<<CHAPsmtptrans>>& for more
14063 details.
14064
14065
14066
14067
14068 . ////////////////////////////////////////////////////////////////////////////
14069 . ////////////////////////////////////////////////////////////////////////////
14070
14071 .chapter "Main configuration" "CHAPmainconfig"
14072 .scindex IIDconfima "configuration file" "main section"
14073 .scindex IIDmaiconf "main configuration"
14074 The first part of the runtime configuration file contains three types of item:
14075
14076 .ilist
14077 Macro definitions: These lines start with an upper case letter. See section
14078 &<<SECTmacrodefs>>& for details of macro processing.
14079 .next
14080 Named list definitions: These lines start with one of the words &"domainlist"&,
14081 &"hostlist"&, &"addresslist"&, or &"localpartlist"&. Their use is described in
14082 section &<<SECTnamedlists>>&.
14083 .next
14084 Main configuration settings: Each setting occupies one line of the file
14085 (with possible continuations). If any setting is preceded by the word
14086 &"hide"&, the &%-bP%& command line option displays its value to admin users
14087 only. See section &<<SECTcos>>& for a description of the syntax of these option
14088 settings.
14089 .endlist
14090
14091 This chapter specifies all the main configuration options, along with their
14092 types and default values. For ease of finding a particular option, they appear
14093 in alphabetical order in section &<<SECTalomo>>& below. However, because there
14094 are now so many options, they are first listed briefly in functional groups, as
14095 an aid to finding the name of the option you are looking for. Some options are
14096 listed in more than one group.
14097
14098 .section "Miscellaneous" "SECID96"
14099 .table2
14100 .row &%bi_command%&                  "to run for &%-bi%& command line option"
14101 .row &%debug_store%&                 "do extra internal checks"
14102 .row &%disable_ipv6%&                "do no IPv6 processing"
14103 .row &%keep_malformed%&              "for broken files &-- should not happen"
14104 .row &%localhost_number%&            "for unique message ids in clusters"
14105 .row &%message_body_newlines%&       "retain newlines in &$message_body$&"
14106 .row &%message_body_visible%&        "how much to show in &$message_body$&"
14107 .row &%mua_wrapper%&                 "run in &""MUA wrapper""& mode"
14108 .row &%print_topbitchars%&           "top-bit characters are printing"
14109 .row &%spool_wireformat%&            "use wire-format spool data files when possible"
14110 .row &%timezone%&                    "force time zone"
14111 .endtable
14112
14113
14114 .section "Exim parameters" "SECID97"
14115 .table2
14116 .row &%exim_group%&                  "override compiled-in value"
14117 .row &%exim_path%&                   "override compiled-in value"
14118 .row &%exim_user%&                   "override compiled-in value"
14119 .row &%primary_hostname%&            "default from &[uname()]&"
14120 .row &%split_spool_directory%&       "use multiple directories"
14121 .row &%spool_directory%&             "override compiled-in value"
14122 .endtable
14123
14124
14125
14126 .section "Privilege controls" "SECID98"
14127 .table2
14128 .row &%admin_groups%&                "groups that are Exim admin users"
14129 .row &%commandline_checks_require_admin%& "require admin for various checks"
14130 .row &%deliver_drop_privilege%&      "drop root for delivery processes"
14131 .row &%local_from_check%&            "insert &'Sender:'& if necessary"
14132 .row &%local_from_prefix%&           "for testing &'From:'& for local sender"
14133 .row &%local_from_suffix%&           "for testing &'From:'& for local sender"
14134 .row &%local_sender_retain%&         "keep &'Sender:'& from untrusted user"
14135 .row &%never_users%&                 "do not run deliveries as these"
14136 .row &%prod_requires_admin%&         "forced delivery requires admin user"
14137 .row &%queue_list_requires_admin%&   "queue listing requires admin user"
14138 .row &%trusted_groups%&              "groups that are trusted"
14139 .row &%trusted_users%&               "users that are trusted"
14140 .endtable
14141
14142
14143
14144 .section "Logging" "SECID99"
14145 .table2
14146 .row &%event_action%&                "custom logging"
14147 .row &%hosts_connection_nolog%&      "exemption from connect logging"
14148 .row &%log_file_path%&               "override compiled-in value"
14149 .row &%log_selector%&                "set/unset optional logging"
14150 .row &%log_timezone%&                "add timezone to log lines"
14151 .row &%message_logs%&                "create per-message logs"
14152 .row &%preserve_message_logs%&       "after message completion"
14153 .row &%process_log_path%&            "for SIGUSR1 and &'exiwhat'&"
14154 .row &%slow_lookup_log%&             "control logging of slow DNS lookups"
14155 .row &%syslog_duplication%&          "controls duplicate log lines on syslog"
14156 .row &%syslog_facility%&             "set syslog &""facility""& field"
14157 .row &%syslog_pid%&                  "pid in syslog lines"
14158 .row &%syslog_processname%&          "set syslog &""ident""& field"
14159 .row &%syslog_timestamp%&            "timestamp syslog lines"
14160 .row &%write_rejectlog%&             "control use of message log"
14161 .endtable
14162
14163
14164
14165 .section "Frozen messages" "SECID100"
14166 .table2
14167 .row &%auto_thaw%&                   "sets time for retrying frozen messages"
14168 .row &%freeze_tell%&                 "send message when freezing"
14169 .row &%move_frozen_messages%&        "to another directory"
14170 .row &%timeout_frozen_after%&        "keep frozen messages only so long"
14171 .endtable
14172
14173
14174
14175 .section "Data lookups" "SECID101"
14176 .table2
14177 .row &%ibase_servers%&               "InterBase servers"
14178 .row &%ldap_ca_cert_dir%&            "dir of CA certs to verify LDAP server's"
14179 .row &%ldap_ca_cert_file%&           "file of CA certs to verify LDAP server's"
14180 .row &%ldap_cert_file%&              "client cert file for LDAP"
14181 .row &%ldap_cert_key%&               "client key file for LDAP"
14182 .row &%ldap_cipher_suite%&           "TLS negotiation preference control"
14183 .row &%ldap_default_servers%&        "used if no server in query"
14184 .row &%ldap_require_cert%&           "action to take without LDAP server cert"
14185 .row &%ldap_start_tls%&              "require TLS within LDAP"
14186 .row &%ldap_version%&                "set protocol version"
14187 .row &%lookup_open_max%&             "lookup files held open"
14188 .row &%mysql_servers%&               "default MySQL servers"
14189 .row &%oracle_servers%&              "Oracle servers"
14190 .row &%pgsql_servers%&               "default PostgreSQL servers"
14191 .row &%sqlite_lock_timeout%&         "as it says"
14192 .endtable
14193
14194
14195
14196 .section "Message ids" "SECID102"
14197 .table2
14198 .row &%message_id_header_domain%&    "used to build &'Message-ID:'& header"
14199 .row &%message_id_header_text%&      "ditto"
14200 .endtable
14201
14202
14203
14204 .section "Embedded Perl Startup" "SECID103"
14205 .table2
14206 .row &%perl_at_start%&               "always start the interpreter"
14207 .row &%perl_startup%&                "code to obey when starting Perl"
14208 .row &%perl_taintmode%&              "enable taint mode in Perl"
14209 .endtable
14210
14211
14212
14213 .section "Daemon" "SECID104"
14214 .table2
14215 .row &%daemon_smtp_ports%&           "default ports"
14216 .row &%daemon_startup_retries%&      "number of times to retry"
14217 .row &%daemon_startup_sleep%&        "time to sleep between tries"
14218 .row &%extra_local_interfaces%&      "not necessarily listened on"
14219 .row &%local_interfaces%&            "on which to listen, with optional ports"
14220 .row &%pid_file_path%&               "override compiled-in value"
14221 .row &%queue_run_max%&               "maximum simultaneous queue runners"
14222 .endtable
14223
14224
14225
14226 .section "Resource control" "SECID105"
14227 .table2
14228 .row &%check_log_inodes%&            "before accepting a message"
14229 .row &%check_log_space%&             "before accepting a message"
14230 .row &%check_spool_inodes%&          "before accepting a message"
14231 .row &%check_spool_space%&           "before accepting a message"
14232 .row &%deliver_queue_load_max%&      "no queue deliveries if load high"
14233 .row &%queue_only_load%&             "queue incoming if load high"
14234 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
14235 .row &%queue_run_max%&               "maximum simultaneous queue runners"
14236 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
14237 .row &%smtp_accept_max%&             "simultaneous incoming connections"
14238 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
14239 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
14240 .row &%smtp_accept_max_per_connection%& "messages per connection"
14241 .row &%smtp_accept_max_per_host%&    "connections from one host"
14242 .row &%smtp_accept_queue%&           "queue mail if more connections"
14243 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
14244                                            connection"
14245 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
14246 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
14247 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
14248 .row &%smtp_load_reserve%&           "SMTP from reserved hosts if load high"
14249 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
14250 .endtable
14251
14252
14253
14254 .section "Policy controls" "SECID106"
14255 .table2
14256 .row &%acl_not_smtp%&                "ACL for non-SMTP messages"
14257 .row &%acl_not_smtp_mime%&           "ACL for non-SMTP MIME parts"
14258 .row &%acl_not_smtp_start%&          "ACL for start of non-SMTP message"
14259 .row &%acl_smtp_auth%&               "ACL for AUTH"
14260 .row &%acl_smtp_connect%&            "ACL for connection"
14261 .row &%acl_smtp_data%&               "ACL for DATA"
14262 .row &%acl_smtp_data_prdr%&          "ACL for DATA, per-recipient"
14263 .row &%acl_smtp_dkim%&               "ACL for DKIM verification"
14264 .row &%acl_smtp_etrn%&               "ACL for ETRN"
14265 .row &%acl_smtp_expn%&               "ACL for EXPN"
14266 .row &%acl_smtp_helo%&               "ACL for EHLO or HELO"
14267 .row &%acl_smtp_mail%&               "ACL for MAIL"
14268 .row &%acl_smtp_mailauth%&           "ACL for AUTH on MAIL command"
14269 .row &%acl_smtp_mime%&               "ACL for MIME parts"
14270 .row &%acl_smtp_notquit%&            "ACL for non-QUIT terminations"
14271 .row &%acl_smtp_predata%&            "ACL for start of data"
14272 .row &%acl_smtp_quit%&               "ACL for QUIT"
14273 .row &%acl_smtp_rcpt%&               "ACL for RCPT"
14274 .row &%acl_smtp_starttls%&           "ACL for STARTTLS"
14275 .row &%acl_smtp_vrfy%&               "ACL for VRFY"
14276 .row &%av_scanner%&                  "specify virus scanner"
14277 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
14278                                       words""&"
14279 .row &%dns_cname_loops%&             "follow CNAMEs returned by resolver"
14280 .row &%dns_csa_search_limit%&        "control CSA parent search depth"
14281 .row &%dns_csa_use_reverse%&         "en/disable CSA IP reverse search"
14282 .row &%header_maxsize%&              "total size of message header"
14283 .row &%header_line_maxsize%&         "individual header line limit"
14284 .row &%helo_accept_junk_hosts%&      "allow syntactic junk from these hosts"
14285 .row &%helo_allow_chars%&            "allow illegal chars in HELO names"
14286 .row &%helo_lookup_domains%&         "lookup hostname for these HELO names"
14287 .row &%helo_try_verify_hosts%&       "HELO soft-checked for these hosts"
14288 .row &%helo_verify_hosts%&           "HELO hard-checked for these hosts"
14289 .row &%host_lookup%&                 "host name looked up for these hosts"
14290 .row &%host_lookup_order%&           "order of DNS and local name lookups"
14291 .row &%hosts_proxy%&                 "use proxy protocol for these hosts"
14292 .row &%host_reject_connection%&      "reject connection from these hosts"
14293 .row &%hosts_treat_as_local%&        "useful in some cluster configurations"
14294 .row &%local_scan_timeout%&          "timeout for &[local_scan()]&"
14295 .row &%message_size_limit%&          "for all messages"
14296 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
14297 .row &%spamd_address%&               "set interface to SpamAssassin"
14298 .row &%strict_acl_vars%&             "object to unset ACL variables"
14299 .endtable
14300
14301
14302
14303 .section "Callout cache" "SECID107"
14304 .table2
14305 .row &%callout_domain_negative_expire%& "timeout for negative domain cache &&&
14306                                          item"
14307 .row &%callout_domain_positive_expire%& "timeout for positive domain cache &&&
14308                                          item"
14309 .row &%callout_negative_expire%&     "timeout for negative address cache item"
14310 .row &%callout_positive_expire%&     "timeout for positive address cache item"
14311 .row &%callout_random_local_part%&   "string to use for &""random""& testing"
14312 .endtable
14313
14314
14315
14316 .section "TLS" "SECID108"
14317 .table2
14318 .row &%gnutls_compat_mode%&          "use GnuTLS compatibility mode"
14319 .row &%gnutls_allow_auto_pkcs11%&    "allow GnuTLS to autoload PKCS11 modules"
14320 .row &%openssl_options%&             "adjust OpenSSL compatibility options"
14321 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
14322 .row &%tls_certificate%&             "location of server certificate"
14323 .row &%tls_crl%&                     "certificate revocation list"
14324 .row &%tls_dh_max_bits%&             "clamp D-H bit count suggestion"
14325 .row &%tls_dhparam%&                 "DH parameters for server"
14326 .row &%tls_eccurve%&                 "EC curve selection for server"
14327 .row &%tls_ocsp_file%&               "location of server certificate status proof"
14328 .row &%tls_on_connect_ports%&        "specify SSMTP (SMTPS) ports"
14329 .row &%tls_privatekey%&              "location of server private key"
14330 .row &%tls_remember_esmtp%&          "don't reset after starting TLS"
14331 .row &%tls_require_ciphers%&         "specify acceptable ciphers"
14332 .row &%tls_try_verify_hosts%&        "try to verify client certificate"
14333 .row &%tls_verify_certificates%&     "expected client certificates"
14334 .row &%tls_verify_hosts%&            "insist on client certificate verify"
14335 .endtable
14336
14337
14338
14339 .section "Local user handling" "SECID109"
14340 .table2
14341 .row &%finduser_retries%&            "useful in NIS environments"
14342 .row &%gecos_name%&                  "used when creating &'Sender:'&"
14343 .row &%gecos_pattern%&               "ditto"
14344 .row &%max_username_length%&         "for systems that truncate"
14345 .row &%unknown_login%&               "used when no login name found"
14346 .row &%unknown_username%&            "ditto"
14347 .row &%uucp_from_pattern%&           "for recognizing &""From ""& lines"
14348 .row &%uucp_from_sender%&            "ditto"
14349 .endtable
14350
14351
14352
14353 .section "All incoming messages (SMTP and non-SMTP)" "SECID110"
14354 .table2
14355 .row &%header_maxsize%&              "total size of message header"
14356 .row &%header_line_maxsize%&         "individual header line limit"
14357 .row &%message_size_limit%&          "applies to all messages"
14358 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
14359 .row &%received_header_text%&        "expanded to make &'Received:'&"
14360 .row &%received_headers_max%&        "for mail loop detection"
14361 .row &%recipients_max%&              "limit per message"
14362 .row &%recipients_max_reject%&       "permanently reject excess recipients"
14363 .endtable
14364
14365
14366
14367
14368 .section "Non-SMTP incoming messages" "SECID111"
14369 .table2
14370 .row &%receive_timeout%&             "for non-SMTP messages"
14371 .endtable
14372
14373
14374
14375
14376
14377 .section "Incoming SMTP messages" "SECID112"
14378 See also the &'Policy controls'& section above.
14379
14380 .table2
14381 .row &%dkim_verify_hashes%&          "DKIM hash methods accepted for signatures"
14382 .row &%dkim_verify_keytypes%&        "DKIM key types accepted for signatures"
14383 .row &%dkim_verify_signers%&         "DKIM domains for which DKIM ACL is run"
14384 .row &%host_lookup%&                 "host name looked up for these hosts"
14385 .row &%host_lookup_order%&           "order of DNS and local name lookups"
14386 .row &%recipient_unqualified_hosts%& "may send unqualified recipients"
14387 .row &%rfc1413_hosts%&               "make ident calls to these hosts"
14388 .row &%rfc1413_query_timeout%&       "zero disables ident calls"
14389 .row &%sender_unqualified_hosts%&    "may send unqualified senders"
14390 .row &%smtp_accept_keepalive%&       "some TCP/IP magic"
14391 .row &%smtp_accept_max%&             "simultaneous incoming connections"
14392 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
14393 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
14394 .row &%smtp_accept_max_per_connection%& "messages per connection"
14395 .row &%smtp_accept_max_per_host%&    "connections from one host"
14396 .row &%smtp_accept_queue%&           "queue mail if more connections"
14397 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
14398                                            connection"
14399 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
14400 .row &%smtp_active_hostname%&        "host name to use in messages"
14401 .row &%smtp_banner%&                 "text for welcome banner"
14402 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
14403 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
14404 .row &%smtp_enforce_sync%&           "of SMTP command/responses"
14405 .row &%smtp_etrn_command%&           "what to run for ETRN"
14406 .row &%smtp_etrn_serialize%&         "only one at once"
14407 .row &%smtp_load_reserve%&           "only reserve hosts if this load"
14408 .row &%smtp_max_unknown_commands%&   "before dropping connection"
14409 .row &%smtp_ratelimit_hosts%&        "apply ratelimiting to these hosts"
14410 .row &%smtp_ratelimit_mail%&         "ratelimit for MAIL commands"
14411 .row &%smtp_ratelimit_rcpt%&         "ratelimit for RCPT commands"
14412 .row &%smtp_receive_timeout%&        "per command or data line"
14413 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
14414 .row &%smtp_return_error_details%&   "give detail on rejections"
14415 .endtable
14416
14417
14418
14419 .section "SMTP extensions" "SECID113"
14420 .table2
14421 .row &%accept_8bitmime%&             "advertise 8BITMIME"
14422 .row &%auth_advertise_hosts%&        "advertise AUTH to these hosts"
14423 .row &%chunking_advertise_hosts%&    "advertise CHUNKING to these hosts"
14424 .row &%dsn_advertise_hosts%&         "advertise DSN extensions to these hosts"
14425 .row &%ignore_fromline_hosts%&       "allow &""From ""& from these hosts"
14426 .row &%ignore_fromline_local%&       "allow &""From ""& from local SMTP"
14427 .row &%pipelining_advertise_hosts%&  "advertise pipelining to these hosts"
14428 .row &%pipelining_connect_advertise_hosts%& "advertise pipelining to these hosts"
14429 .row &%prdr_enable%&                 "advertise PRDR to all hosts"
14430 .row &%smtputf8_advertise_hosts%&    "advertise SMTPUTF8 to these hosts"
14431 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
14432 .endtable
14433
14434
14435
14436 .section "Processing messages" "SECID114"
14437 .table2
14438 .row &%allow_domain_literals%&       "recognize domain literal syntax"
14439 .row &%allow_mx_to_ip%&              "allow MX to point to IP address"
14440 .row &%allow_utf8_domains%&          "in addresses"
14441 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
14442                                       words""&"
14443 .row &%delivery_date_remove%&        "from incoming messages"
14444 .row &%envelope_to_remove%&          "from incoming messages"
14445 .row &%extract_addresses_remove_arguments%& "affects &%-t%& processing"
14446 .row &%headers_charset%&             "default for translations"
14447 .row &%qualify_domain%&              "default for senders"
14448 .row &%qualify_recipient%&           "default for recipients"
14449 .row &%return_path_remove%&          "from incoming messages"
14450 .row &%strip_excess_angle_brackets%& "in addresses"
14451 .row &%strip_trailing_dot%&          "at end of addresses"
14452 .row &%untrusted_set_sender%&        "untrusted can set envelope sender"
14453 .endtable
14454
14455
14456
14457 .section "System filter" "SECID115"
14458 .table2
14459 .row &%system_filter%&               "locate system filter"
14460 .row &%system_filter_directory_transport%& "transport for delivery to a &&&
14461                                             directory"
14462 .row &%system_filter_file_transport%& "transport for delivery to a file"
14463 .row &%system_filter_group%&         "group for filter running"
14464 .row &%system_filter_pipe_transport%& "transport for delivery to a pipe"
14465 .row &%system_filter_reply_transport%& "transport for autoreply delivery"
14466 .row &%system_filter_user%&          "user for filter running"
14467 .endtable
14468
14469
14470
14471 .section "Routing and delivery" "SECID116"
14472 .table2
14473 .row &%disable_ipv6%&                "do no IPv6 processing"
14474 .row &%dns_again_means_nonexist%&    "for broken domains"
14475 .row &%dns_check_names_pattern%&     "pre-DNS syntax check"
14476 .row &%dns_dnssec_ok%&               "parameter for resolver"
14477 .row &%dns_ipv4_lookup%&             "only v4 lookup for these domains"
14478 .row &%dns_retrans%&                 "parameter for resolver"
14479 .row &%dns_retry%&                   "parameter for resolver"
14480 .row &%dns_trust_aa%&                "DNS zones trusted as authentic"
14481 .row &%dns_use_edns0%&               "parameter for resolver"
14482 .row &%hold_domains%&                "hold delivery for these domains"
14483 .row &%local_interfaces%&            "for routing checks"
14484 .row &%queue_domains%&               "no immediate delivery for these"
14485 .row &%queue_only%&                  "no immediate delivery at all"
14486 .row &%queue_only_file%&             "no immediate delivery if file exists"
14487 .row &%queue_only_load%&             "no immediate delivery if load is high"
14488 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
14489 .row &%queue_only_override%&         "allow command line to override"
14490 .row &%queue_run_in_order%&          "order of arrival"
14491 .row &%queue_run_max%&               "of simultaneous queue runners"
14492 .row &%queue_smtp_domains%&          "no immediate SMTP delivery for these"
14493 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
14494 .row &%remote_sort_domains%&         "order of remote deliveries"
14495 .row &%retry_data_expire%&           "timeout for retry data"
14496 .row &%retry_interval_max%&          "safety net for retry rules"
14497 .endtable
14498
14499
14500
14501 .section "Bounce and warning messages" "SECID117"
14502 .table2
14503 .row &%bounce_message_file%&         "content of bounce"
14504 .row &%bounce_message_text%&         "content of bounce"
14505 .row &%bounce_return_body%&          "include body if returning message"
14506 .row &%bounce_return_linesize_limit%& "limit on returned message line length"
14507 .row &%bounce_return_message%&       "include original message in bounce"
14508 .row &%bounce_return_size_limit%&    "limit on returned message"
14509 .row &%bounce_sender_authentication%& "send authenticated sender with bounce"
14510 .row &%dsn_from%&                    "set &'From:'& contents in bounces"
14511 .row &%errors_copy%&                 "copy bounce messages"
14512 .row &%errors_reply_to%&             "&'Reply-to:'& in bounces"
14513 .row &%delay_warning%&               "time schedule"
14514 .row &%delay_warning_condition%&     "condition for warning messages"
14515 .row &%ignore_bounce_errors_after%&  "discard undeliverable bounces"
14516 .row &%smtp_return_error_details%&   "give detail on rejections"
14517 .row &%warn_message_file%&           "content of warning message"
14518 .endtable
14519
14520
14521
14522 .section "Alphabetical list of main options" "SECTalomo"
14523 Those options that undergo string expansion before use are marked with
14524 &dagger;.
14525
14526 .option accept_8bitmime main boolean true
14527 .cindex "8BITMIME"
14528 .cindex "8-bit characters"
14529 .cindex "log" "selectors"
14530 .cindex "log" "8BITMIME"
14531 This option causes Exim to send 8BITMIME in its response to an SMTP
14532 EHLO command, and to accept the BODY= parameter on MAIL commands.
14533 However, though Exim is 8-bit clean, it is not a protocol converter, and it
14534 takes no steps to do anything special with messages received by this route.
14535
14536 Historically Exim kept this option off by default, but the maintainers
14537 feel that in today's Internet, this causes more problems than it solves.
14538 It now defaults to true.
14539 A more detailed analysis of the issues is provided by Dan Bernstein:
14540 .display
14541 &url(https://cr.yp.to/smtp/8bitmime.html)
14542 .endd
14543
14544 To log received 8BITMIME status use
14545 .code
14546 log_selector = +8bitmime
14547 .endd
14548
14549 .option acl_not_smtp main string&!! unset
14550 .cindex "&ACL;" "for non-SMTP messages"
14551 .cindex "non-SMTP messages" "ACLs for"
14552 This option defines the ACL that is run when a non-SMTP message has been
14553 read and is on the point of being accepted. See chapter &<<CHAPACL>>& for
14554 further details.
14555
14556 .option acl_not_smtp_mime main string&!! unset
14557 This option defines the ACL that is run for individual MIME parts of non-SMTP
14558 messages. It operates in exactly the same way as &%acl_smtp_mime%& operates for
14559 SMTP messages.
14560
14561 .option acl_not_smtp_start main string&!! unset
14562 .cindex "&ACL;" "at start of non-SMTP message"
14563 .cindex "non-SMTP messages" "ACLs for"
14564 This option defines the ACL that is run before Exim starts reading a
14565 non-SMTP message. See chapter &<<CHAPACL>>& for further details.
14566
14567 .option acl_smtp_auth main string&!! unset
14568 .cindex "&ACL;" "setting up for SMTP commands"
14569 .cindex "AUTH" "ACL for"
14570 This option defines the ACL that is run when an SMTP AUTH command is
14571 received. See chapter &<<CHAPACL>>& for further details.
14572
14573 .option acl_smtp_connect main string&!! unset
14574 .cindex "&ACL;" "on SMTP connection"
14575 This option defines the ACL that is run when an SMTP connection is received.
14576 See chapter &<<CHAPACL>>& for further details.
14577
14578 .option acl_smtp_data main string&!! unset
14579 .cindex "DATA" "ACL for"
14580 This option defines the ACL that is run after an SMTP DATA command has been
14581 processed and the message itself has been received, but before the final
14582 acknowledgment is sent. See chapter &<<CHAPACL>>& for further details.
14583
14584 .option acl_smtp_data_prdr main string&!! accept
14585 .cindex "PRDR" "ACL for"
14586 .cindex "DATA" "PRDR ACL for"
14587 .cindex "&ACL;" "PRDR-related"
14588 .cindex "&ACL;" "per-user data processing"
14589 This option defines the ACL that,
14590 if the PRDR feature has been negotiated,
14591 is run for each recipient after an SMTP DATA command has been
14592 processed and the message itself has been received, but before the
14593 acknowledgment is sent. See chapter &<<CHAPACL>>& for further details.
14594
14595 .option acl_smtp_dkim main string&!! unset
14596 .cindex DKIM "ACL for"
14597 This option defines the ACL that is run for each DKIM signature
14598 (by default, or as specified in the dkim_verify_signers option)
14599 of a received message.
14600 See section &<<SECDKIMVFY>>& for further details.
14601
14602 .option acl_smtp_etrn main string&!! unset
14603 .cindex "ETRN" "ACL for"
14604 This option defines the ACL that is run when an SMTP ETRN command is
14605 received. See chapter &<<CHAPACL>>& for further details.
14606
14607 .option acl_smtp_expn main string&!! unset
14608 .cindex "EXPN" "ACL for"
14609 This option defines the ACL that is run when an SMTP EXPN command is
14610 received. See chapter &<<CHAPACL>>& for further details.
14611
14612 .option acl_smtp_helo main string&!! unset
14613 .cindex "EHLO" "ACL for"
14614 .cindex "HELO" "ACL for"
14615 This option defines the ACL that is run when an SMTP EHLO or HELO
14616 command is received. See chapter &<<CHAPACL>>& for further details.
14617
14618
14619 .option acl_smtp_mail main string&!! unset
14620 .cindex "MAIL" "ACL for"
14621 This option defines the ACL that is run when an SMTP MAIL command is
14622 received. See chapter &<<CHAPACL>>& for further details.
14623
14624 .option acl_smtp_mailauth main string&!! unset
14625 .cindex "AUTH" "on MAIL command"
14626 This option defines the ACL that is run when there is an AUTH parameter on
14627 a MAIL command. See chapter &<<CHAPACL>>& for details of ACLs, and chapter
14628 &<<CHAPSMTPAUTH>>& for details of authentication.
14629
14630 .option acl_smtp_mime main string&!! unset
14631 .cindex "MIME content scanning" "ACL for"
14632 This option is available when Exim is built with the content-scanning
14633 extension. It defines the ACL that is run for each MIME part in a message. See
14634 section &<<SECTscanmimepart>>& for details.
14635
14636 .option acl_smtp_notquit main string&!! unset
14637 .cindex "not-QUIT, ACL for"
14638 This option defines the ACL that is run when an SMTP session
14639 ends without a QUIT command being received.
14640 See chapter &<<CHAPACL>>& for further details.
14641
14642 .option acl_smtp_predata main string&!! unset
14643 This option defines the ACL that is run when an SMTP DATA command is
14644 received, before the message itself is received. See chapter &<<CHAPACL>>& for
14645 further details.
14646
14647 .option acl_smtp_quit main string&!! unset
14648 .cindex "QUIT, ACL for"
14649 This option defines the ACL that is run when an SMTP QUIT command is
14650 received. See chapter &<<CHAPACL>>& for further details.
14651
14652 .option acl_smtp_rcpt main string&!! unset
14653 .cindex "RCPT" "ACL for"
14654 This option defines the ACL that is run when an SMTP RCPT command is
14655 received. See chapter &<<CHAPACL>>& for further details.
14656
14657 .option acl_smtp_starttls main string&!! unset
14658 .cindex "STARTTLS, ACL for"
14659 This option defines the ACL that is run when an SMTP STARTTLS command is
14660 received. See chapter &<<CHAPACL>>& for further details.
14661
14662 .option acl_smtp_vrfy main string&!! unset
14663 .cindex "VRFY" "ACL for"
14664 This option defines the ACL that is run when an SMTP VRFY command is
14665 received. See chapter &<<CHAPACL>>& for further details.
14666
14667 .option add_environment main "string list" empty
14668 .cindex "environment" "set values"
14669 This option allows to set individual environment variables that the
14670 currently linked libraries and programs in child processes use.
14671 See &<<SECTpipeenv>>& for the environment of &(pipe)& transports.
14672
14673 .option admin_groups main "string list&!!" unset
14674 .cindex "admin user"
14675 This option is expanded just once, at the start of Exim's processing. If the
14676 current group or any of the supplementary groups of an Exim caller is in this
14677 colon-separated list, the caller has admin privileges. If all your system
14678 programmers are in a specific group, for example, you can give them all Exim
14679 admin privileges by putting that group in &%admin_groups%&. However, this does
14680 not permit them to read Exim's spool files (whose group owner is the Exim gid).
14681 To permit this, you have to add individuals to the Exim group.
14682
14683 .option allow_domain_literals main boolean false
14684 .cindex "domain literal"
14685 If this option is set, the RFC 2822 domain literal format is permitted in
14686 email addresses. The option is not set by default, because the domain literal
14687 format is not normally required these days, and few people know about it. It
14688 has, however, been exploited by mail abusers.
14689
14690 Unfortunately, it seems that some DNS black list maintainers are using this
14691 format to report black listing to postmasters. If you want to accept messages
14692 addressed to your hosts by IP address, you need to set
14693 &%allow_domain_literals%& true, and also to add &`@[]`& to the list of local
14694 domains (defined in the named domain list &%local_domains%& in the default
14695 configuration). This &"magic string"& matches the domain literal form of all
14696 the local host's IP addresses.
14697
14698
14699 .option allow_mx_to_ip main boolean false
14700 .cindex "MX record" "pointing to IP address"
14701 It appears that more and more DNS zone administrators are breaking the rules
14702 and putting domain names that look like IP addresses on the right hand side of
14703 MX records. Exim follows the rules and rejects this, giving an error message
14704 that explains the misconfiguration. However, some other MTAs support this
14705 practice, so to avoid &"Why can't Exim do this?"& complaints,
14706 &%allow_mx_to_ip%& exists, in order to enable this heinous activity. It is not
14707 recommended, except when you have no other choice.
14708
14709 .option allow_utf8_domains main boolean false
14710 .cindex "domain" "UTF-8 characters in"
14711 .cindex "UTF-8" "in domain name"
14712 Lots of discussion is going on about internationalized domain names. One
14713 camp is strongly in favour of just using UTF-8 characters, and it seems
14714 that at least two other MTAs permit this.
14715 This option allows Exim users to experiment if they wish.
14716
14717 If it is set true, Exim's domain parsing function allows valid
14718 UTF-8 multicharacters to appear in domain name components, in addition to
14719 letters, digits, and hyphens.
14720
14721 .new
14722 If Exim is built with internationalization support
14723 and the SMTPUTF8 ESMTP option is in use (see chapter &<<CHAPi18n>>&)
14724 this option can be left as default.
14725 .wen
14726 Without that,
14727 if you want to look up such domain names in the DNS, you must also
14728 adjust the value of &%dns_check_names_pattern%& to match the extended form. A
14729 suitable setting is:
14730 .code
14731 dns_check_names_pattern = (?i)^(?>(?(1)\.|())[a-z0-9\xc0-\xff]\
14732   (?>[-a-z0-9\x80-\xff]*[a-z0-9\x80-\xbf])?)+$
14733 .endd
14734 Alternatively, you can just disable this feature by setting
14735 .code
14736 dns_check_names_pattern =
14737 .endd
14738 That is, set the option to an empty string so that no check is done.
14739
14740
14741 .option auth_advertise_hosts main "host list&!!" *
14742 .cindex "authentication" "advertising"
14743 .cindex "AUTH" "advertising"
14744 If any server authentication mechanisms are configured, Exim advertises them in
14745 response to an EHLO command only if the calling host matches this list.
14746 Otherwise, Exim does not advertise AUTH.
14747 Exim does not accept AUTH commands from clients to which it has not
14748 advertised the availability of AUTH. The advertising of individual
14749 authentication mechanisms can be controlled by the use of the
14750 &%server_advertise_condition%& generic authenticator option on the individual
14751 authenticators. See chapter &<<CHAPSMTPAUTH>>& for further details.
14752
14753 Certain mail clients (for example, Netscape) require the user to provide a name
14754 and password for authentication if AUTH is advertised, even though it may
14755 not be needed (the host may accept messages from hosts on its local LAN without
14756 authentication, for example). The &%auth_advertise_hosts%& option can be used
14757 to make these clients more friendly by excluding them from the set of hosts to
14758 which Exim advertises AUTH.
14759
14760 .cindex "AUTH" "advertising when encrypted"
14761 If you want to advertise the availability of AUTH only when the connection
14762 is encrypted using TLS, you can make use of the fact that the value of this
14763 option is expanded, with a setting like this:
14764 .code
14765 auth_advertise_hosts = ${if eq{$tls_in_cipher}{}{}{*}}
14766 .endd
14767 .vindex "&$tls_in_cipher$&"
14768 If &$tls_in_cipher$& is empty, the session is not encrypted, and the result of
14769 the expansion is empty, thus matching no hosts. Otherwise, the result of the
14770 expansion is *, which matches all hosts.
14771
14772
14773 .option auto_thaw main time 0s
14774 .cindex "thawing messages"
14775 .cindex "unfreezing messages"
14776 If this option is set to a time greater than zero, a queue runner will try a
14777 new delivery attempt on any frozen message, other than a bounce message, if
14778 this much time has passed since it was frozen. This may result in the message
14779 being re-frozen if nothing has changed since the last attempt. It is a way of
14780 saying &"keep on trying, even though there are big problems"&.
14781
14782 &*Note*&: This is an old option, which predates &%timeout_frozen_after%& and
14783 &%ignore_bounce_errors_after%&. It is retained for compatibility, but it is not
14784 thought to be very useful any more, and its use should probably be avoided.
14785
14786
14787 .option av_scanner main string "see below"
14788 This option is available if Exim is built with the content-scanning extension.
14789 It specifies which anti-virus scanner to use. The default value is:
14790 .code
14791 sophie:/var/run/sophie
14792 .endd
14793 If the value of &%av_scanner%& starts with a dollar character, it is expanded
14794 before use. See section &<<SECTscanvirus>>& for further details.
14795
14796
14797 .option bi_command main string unset
14798 .oindex "&%-bi%&"
14799 This option supplies the name of a command that is run when Exim is called with
14800 the &%-bi%& option (see chapter &<<CHAPcommandline>>&). The string value is
14801 just the command name, it is not a complete command line. If an argument is
14802 required, it must come from the &%-oA%& command line option.
14803
14804
14805 .option bounce_message_file main string unset
14806 .cindex "bounce message" "customizing"
14807 .cindex "customizing" "bounce message"
14808 This option defines a template file containing paragraphs of text to be used
14809 for constructing bounce messages.  Details of the file's contents are given in
14810 chapter &<<CHAPemsgcust>>&. See also &%warn_message_file%&.
14811
14812
14813 .option bounce_message_text main string unset
14814 When this option is set, its contents are included in the default bounce
14815 message immediately after &"This message was created automatically by mail
14816 delivery software."& It is not used if &%bounce_message_file%& is set.
14817
14818 .option bounce_return_body main boolean true
14819 .cindex "bounce message" "including body"
14820 This option controls whether the body of an incoming message is included in a
14821 bounce message when &%bounce_return_message%& is true. The default setting
14822 causes the entire message, both header and body, to be returned (subject to the
14823 value of &%bounce_return_size_limit%&). If this option is false, only the
14824 message header is included. In the case of a non-SMTP message containing an
14825 error that is detected during reception, only those header lines preceding the
14826 point at which the error was detected are returned.
14827 .cindex "bounce message" "including original"
14828
14829 .option bounce_return_linesize_limit main integer 998
14830 .cindex "size" "of bounce lines, limit"
14831 .cindex "bounce message" "line length limit"
14832 .cindex "limit" "bounce message line length"
14833 This option sets a limit in bytes on the line length of messages
14834 that are returned to senders due to delivery problems,
14835 when &%bounce_return_message%& is true.
14836 The default value corresponds to RFC limits.
14837 If the message being returned has lines longer than this value it is
14838 treated as if the &%bounce_return_size_limit%& (below) restriction was exceeded.
14839
14840 The option also applies to bounces returned when an error is detected
14841 during reception of a message.
14842 In this case lines from the original are truncated.
14843
14844 The option does not apply to messages generated by an &(autoreply)& transport.
14845
14846
14847 .option bounce_return_message main boolean true
14848 If this option is set false, none of the original message is included in
14849 bounce messages generated by Exim. See also &%bounce_return_size_limit%& and
14850 &%bounce_return_body%&.
14851
14852
14853 .option bounce_return_size_limit main integer 100K
14854 .cindex "size" "of bounce, limit"
14855 .cindex "bounce message" "size limit"
14856 .cindex "limit" "bounce message size"
14857 This option sets a limit in bytes on the size of messages that are returned to
14858 senders as part of bounce messages when &%bounce_return_message%& is true. The
14859 limit should be less than the value of the global &%message_size_limit%& and of
14860 any &%message_size_limit%& settings on transports, to allow for the bounce text
14861 that Exim generates. If this option is set to zero there is no limit.
14862
14863 When the body of any message that is to be included in a bounce message is
14864 greater than the limit, it is truncated, and a comment pointing this out is
14865 added at the top. The actual cutoff may be greater than the value given, owing
14866 to the use of buffering for transferring the message in chunks (typically 8K in
14867 size). The idea is to save bandwidth on those undeliverable 15-megabyte
14868 messages.
14869
14870 .option bounce_sender_authentication main string unset
14871 .cindex "bounce message" "sender authentication"
14872 .cindex "authentication" "bounce message"
14873 .cindex "AUTH" "on bounce message"
14874 This option provides an authenticated sender address that is sent with any
14875 bounce messages generated by Exim that are sent over an authenticated SMTP
14876 connection. A typical setting might be:
14877 .code
14878 bounce_sender_authentication = mailer-daemon@my.domain.example
14879 .endd
14880 which would cause bounce messages to be sent using the SMTP command:
14881 .code
14882 MAIL FROM:<> AUTH=mailer-daemon@my.domain.example
14883 .endd
14884 The value of &%bounce_sender_authentication%& must always be a complete email
14885 address.
14886
14887 .option callout_domain_negative_expire main time 3h
14888 .cindex "caching" "callout timeouts"
14889 .cindex "callout" "caching timeouts"
14890 This option specifies the expiry time for negative callout cache data for a
14891 domain. See section &<<SECTcallver>>& for details of callout verification, and
14892 section &<<SECTcallvercache>>& for details of the caching.
14893
14894
14895 .option callout_domain_positive_expire main time 7d
14896 This option specifies the expiry time for positive callout cache data for a
14897 domain. See section &<<SECTcallver>>& for details of callout verification, and
14898 section &<<SECTcallvercache>>& for details of the caching.
14899
14900
14901 .option callout_negative_expire main time 2h
14902 This option specifies the expiry time for negative callout cache data for an
14903 address. See section &<<SECTcallver>>& for details of callout verification, and
14904 section &<<SECTcallvercache>>& for details of the caching.
14905
14906
14907 .option callout_positive_expire main time 24h
14908 This option specifies the expiry time for positive callout cache data for an
14909 address. See section &<<SECTcallver>>& for details of callout verification, and
14910 section &<<SECTcallvercache>>& for details of the caching.
14911
14912
14913 .option callout_random_local_part main string&!! "see below"
14914 This option defines the &"random"& local part that can be used as part of
14915 callout verification. The default value is
14916 .code
14917 $primary_hostname-$tod_epoch-testing
14918 .endd
14919 See section &<<CALLaddparcall>>& for details of how this value is used.
14920
14921
14922 .option check_log_inodes main integer 100
14923 See &%check_spool_space%& below.
14924
14925
14926 .option check_log_space main integer 10M
14927 See &%check_spool_space%& below.
14928
14929 .oindex "&%check_rfc2047_length%&"
14930 .cindex "RFC 2047" "disabling length check"
14931 .option check_rfc2047_length main boolean true
14932 RFC 2047 defines a way of encoding non-ASCII characters in headers using a
14933 system of &"encoded words"&. The RFC specifies a maximum length for an encoded
14934 word; strings to be encoded that exceed this length are supposed to use
14935 multiple encoded words. By default, Exim does not recognize encoded words that
14936 exceed the maximum length. However, it seems that some software, in violation
14937 of the RFC, generates overlong encoded words. If &%check_rfc2047_length%& is
14938 set false, Exim recognizes encoded words of any length.
14939
14940
14941 .option check_spool_inodes main integer 100
14942 See &%check_spool_space%& below.
14943
14944
14945 .option check_spool_space main integer 10M
14946 .cindex "checking disk space"
14947 .cindex "disk space, checking"
14948 .cindex "spool directory" "checking space"
14949 The four &%check_...%& options allow for checking of disk resources before a
14950 message is accepted.
14951
14952 .vindex "&$log_inodes$&"
14953 .vindex "&$log_space$&"
14954 .vindex "&$spool_inodes$&"
14955 .vindex "&$spool_space$&"
14956 When any of these options are nonzero, they apply to all incoming messages. If you
14957 want to apply different checks to different kinds of message, you can do so by
14958 testing the variables &$log_inodes$&, &$log_space$&, &$spool_inodes$&, and
14959 &$spool_space$& in an ACL with appropriate additional conditions.
14960
14961
14962 &%check_spool_space%& and &%check_spool_inodes%& check the spool partition if
14963 either value is greater than zero, for example:
14964 .code
14965 check_spool_space = 100M
14966 check_spool_inodes = 100
14967 .endd
14968 The spool partition is the one that contains the directory defined by
14969 SPOOL_DIRECTORY in &_Local/Makefile_&. It is used for holding messages in
14970 transit.
14971
14972 &%check_log_space%& and &%check_log_inodes%&  check the partition in which log
14973 files are written if either is greater than zero. These should be set only if
14974 &%log_file_path%& and &%spool_directory%& refer to different partitions.
14975
14976 If there is less space or fewer inodes than requested, Exim refuses to accept
14977 incoming mail. In the case of SMTP input this is done by giving a 452 temporary
14978 error response to the MAIL command. If ESMTP is in use and there was a
14979 SIZE parameter on the MAIL command, its value is added to the
14980 &%check_spool_space%& value, and the check is performed even if
14981 &%check_spool_space%& is zero, unless &%no_smtp_check_spool_space%& is set.
14982
14983 The values for &%check_spool_space%& and &%check_log_space%& are held as a
14984 number of kilobytes (though specified in bytes).
14985 If a non-multiple of 1024 is specified, it is rounded up.
14986
14987 For non-SMTP input and for batched SMTP input, the test is done at start-up; on
14988 failure a message is written to stderr and Exim exits with a non-zero code, as
14989 it obviously cannot send an error message of any kind.
14990
14991 There is a slight performance penalty for these checks.
14992 Versions of Exim preceding 4.88 had these disabled by default;
14993 high-rate installations confident they will never run out of resources
14994 may wish to deliberately disable them.
14995
14996 .option chunking_advertise_hosts main "host list&!!" *
14997 .cindex CHUNKING advertisement
14998 .cindex "RFC 3030" "CHUNKING"
14999 The CHUNKING extension (RFC3030) will be advertised in the EHLO message to
15000 these hosts.
15001 Hosts may use the BDAT command as an alternate to DATA.
15002
15003 .option commandline_checks_require_admin main boolean &`false`&
15004 .cindex "restricting access to features"
15005 This option restricts various basic checking features to require an
15006 administrative user.
15007 This affects most of the &%-b*%& options, such as &%-be%&.
15008
15009 .option debug_store main boolean &`false`&
15010 .cindex debugging "memory corruption"
15011 .cindex memory debugging
15012 This option, when true, enables extra checking in Exim's internal memory
15013 management.  For use when a memory corruption issue is being investigated,
15014 it should normally be left as default.
15015
15016 .option daemon_smtp_ports main string &`smtp`&
15017 .cindex "port" "for daemon"
15018 .cindex "TCP/IP" "setting listening ports"
15019 This option specifies one or more default SMTP ports on which the Exim daemon
15020 listens. See chapter &<<CHAPinterfaces>>& for details of how it is used. For
15021 backward compatibility, &%daemon_smtp_port%& (singular) is a synonym.
15022
15023 .option daemon_startup_retries main integer 9
15024 .cindex "daemon startup, retrying"
15025 This option, along with &%daemon_startup_sleep%&, controls the retrying done by
15026 the daemon at startup when it cannot immediately bind a listening socket
15027 (typically because the socket is already in use): &%daemon_startup_retries%&
15028 defines the number of retries after the first failure, and
15029 &%daemon_startup_sleep%& defines the length of time to wait between retries.
15030
15031 .option daemon_startup_sleep main time 30s
15032 See &%daemon_startup_retries%&.
15033
15034 .option delay_warning main "time list" 24h
15035 .cindex "warning of delay"
15036 .cindex "delay warning, specifying"
15037 .cindex "queue" "delay warning"
15038 When a message is delayed, Exim sends a warning message to the sender at
15039 intervals specified by this option. The data is a colon-separated list of times
15040 after which to send warning messages. If the value of the option is an empty
15041 string or a zero time, no warnings are sent. Up to 10 times may be given. If a
15042 message has been in the queue for longer than the last time, the last interval
15043 between the times is used to compute subsequent warning times. For example,
15044 with
15045 .code
15046 delay_warning = 4h:8h:24h
15047 .endd
15048 the first message is sent after 4 hours, the second after 8 hours, and
15049 the third one after 24 hours. After that, messages are sent every 16 hours,
15050 because that is the interval between the last two times on the list. If you set
15051 just one time, it specifies the repeat interval. For example, with:
15052 .code
15053 delay_warning = 6h
15054 .endd
15055 messages are repeated every six hours. To stop warnings after a given time, set
15056 a very large time at the end of the list. For example:
15057 .code
15058 delay_warning = 2h:12h:99d
15059 .endd
15060 Note that the option is only evaluated at the time a delivery attempt fails,
15061 which depends on retry and queue-runner configuration.
15062 Typically retries will be configured more frequently than warning messages.
15063
15064 .option delay_warning_condition main string&!! "see below"
15065 .vindex "&$domain$&"
15066 The string is expanded at the time a warning message might be sent. If all the
15067 deferred addresses have the same domain, it is set in &$domain$& during the
15068 expansion. Otherwise &$domain$& is empty. If the result of the expansion is a
15069 forced failure, an empty string, or a string matching any of &"0"&, &"no"& or
15070 &"false"& (the comparison being done caselessly) then the warning message is
15071 not sent. The default is:
15072 .code
15073 delay_warning_condition = ${if or {\
15074   { !eq{$h_list-id:$h_list-post:$h_list-subscribe:}{} }\
15075   { match{$h_precedence:}{(?i)bulk|list|junk} }\
15076   { match{$h_auto-submitted:}{(?i)auto-generated|auto-replied} }\
15077   } {no}{yes}}
15078 .endd
15079 This suppresses the sending of warnings for messages that contain &'List-ID:'&,
15080 &'List-Post:'&, or &'List-Subscribe:'& headers, or have &"bulk"&, &"list"& or
15081 &"junk"& in a &'Precedence:'& header, or have &"auto-generated"& or
15082 &"auto-replied"& in an &'Auto-Submitted:'& header.
15083
15084 .option deliver_drop_privilege main boolean false
15085 .cindex "unprivileged delivery"
15086 .cindex "delivery" "unprivileged"
15087 If this option is set true, Exim drops its root privilege at the start of a
15088 delivery process, and runs as the Exim user throughout. This severely restricts
15089 the kinds of local delivery that are possible, but is viable in certain types
15090 of configuration. There is a discussion about the use of root privilege in
15091 chapter &<<CHAPsecurity>>&.
15092
15093 .option deliver_queue_load_max main fixed-point unset
15094 .cindex "load average"
15095 .cindex "queue runner" "abandoning"
15096 When this option is set, a queue run is abandoned if the system load average
15097 becomes greater than the value of the option. The option has no effect on
15098 ancient operating systems on which Exim cannot determine the load average.
15099 See also &%queue_only_load%& and &%smtp_load_reserve%&.
15100
15101
15102 .option delivery_date_remove main boolean true
15103 .cindex "&'Delivery-date:'& header line"
15104 Exim's transports have an option for adding a &'Delivery-date:'& header to a
15105 message when it is delivered, in exactly the same way as &'Return-path:'& is
15106 handled. &'Delivery-date:'& records the actual time of delivery. Such headers
15107 should not be present in incoming messages, and this option causes them to be
15108 removed at the time the message is received, to avoid any problems that might
15109 occur when a delivered message is subsequently sent on to some other recipient.
15110
15111 .option disable_fsync main boolean false
15112 .cindex "&[fsync()]&, disabling"
15113 This option is available only if Exim was built with the compile-time option
15114 ENABLE_DISABLE_FSYNC. When this is not set, a reference to &%disable_fsync%& in
15115 a runtime configuration generates an &"unknown option"& error. You should not
15116 build Exim with ENABLE_DISABLE_FSYNC or set &%disable_fsync%& unless you
15117 really, really, really understand what you are doing. &'No pre-compiled
15118 distributions of Exim should ever make this option available.'&
15119
15120 When &%disable_fsync%& is set true, Exim no longer calls &[fsync()]& to force
15121 updated files' data to be written to disc before continuing. Unexpected events
15122 such as crashes and power outages may cause data to be lost or scrambled.
15123 Here be Dragons. &*Beware.*&
15124
15125
15126 .option disable_ipv6 main boolean false
15127 .cindex "IPv6" "disabling"
15128 If this option is set true, even if the Exim binary has IPv6 support, no IPv6
15129 activities take place. AAAA records are never looked up, and any IPv6 addresses
15130 that are listed in &%local_interfaces%&, data for the &%manualroute%& router,
15131 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
15132 to handle IPv6 literal addresses.
15133
15134
15135 .new
15136 .option dkim_verify_hashes main "string list" "sha256 : sha512 : sha1"
15137 .cindex DKIM "selecting signature algorithms"
15138 This option gives a list of hash types which are acceptable in signatures,
15139 and an order of processing.
15140 Signatures with algorithms not in the list will be ignored.
15141
15142 Note that the presence of sha1 violates RFC 8301.
15143 Signatures using the rsa-sha1 are however (as of writing) still common.
15144 The default inclusion of sha1 may be dropped in a future release.
15145
15146 .option dkim_verify_keytypes main "string list" "ed25519 : rsa"
15147 This option gives a list of key types which are acceptable in signatures,
15148 and an order of processing.
15149 Signatures with algorithms not in the list will be ignored.
15150
15151 .option dkim_verify_minimal main boolean false
15152 If set to true, verification of signatures will terminate after the
15153 first success.
15154 .wen
15155
15156 .option dkim_verify_signers main "domain list&!!" $dkim_signers
15157 .cindex DKIM "controlling calls to the ACL"
15158 This option gives a list of DKIM domains for which the DKIM ACL is run.
15159 It is expanded after the message is received; by default it runs
15160 the ACL once for each signature in the message.
15161 See section &<<SECDKIMVFY>>&.
15162
15163
15164 .option dns_again_means_nonexist main "domain list&!!" unset
15165 .cindex "DNS" "&""try again""& response; overriding"
15166 DNS lookups give a &"try again"& response for the DNS errors
15167 &"non-authoritative host not found"& and &"SERVERFAIL"&. This can cause Exim to
15168 keep trying to deliver a message, or to give repeated temporary errors to
15169 incoming mail. Sometimes the effect is caused by a badly set up name server and
15170 may persist for a long time. If a domain which exhibits this problem matches
15171 anything in &%dns_again_means_nonexist%&, it is treated as if it did not exist.
15172 This option should be used with care. You can make it apply to reverse lookups
15173 by a setting such as this:
15174 .code
15175 dns_again_means_nonexist = *.in-addr.arpa
15176 .endd
15177 This option applies to all DNS lookups that Exim does. It also applies when the
15178 &[gethostbyname()]& or &[getipnodebyname()]& functions give temporary errors,
15179 since these are most likely to be caused by DNS lookup problems. The
15180 &(dnslookup)& router has some options of its own for controlling what happens
15181 when lookups for MX or SRV records give temporary errors. These more specific
15182 options are applied after this global option.
15183
15184 .option dns_check_names_pattern main string "see below"
15185 .cindex "DNS" "pre-check of name syntax"
15186 When this option is set to a non-empty string, it causes Exim to check domain
15187 names for characters that are not allowed in host names before handing them to
15188 the DNS resolver, because some resolvers give temporary errors for names that
15189 contain unusual characters. If a domain name contains any unwanted characters,
15190 a &"not found"& result is forced, and the resolver is not called. The check is
15191 done by matching the domain name against a regular expression, which is the
15192 value of this option. The default pattern is
15193 .code
15194 dns_check_names_pattern = \
15195   (?i)^(?>(?(1)\.|())[^\W_](?>[a-z0-9/-]*[^\W_])?)+$
15196 .endd
15197 which permits only letters, digits, slashes, and hyphens in components, but
15198 they must start and end with a letter or digit. Slashes are not, in fact,
15199 permitted in host names, but they are found in certain NS records (which can be
15200 accessed in Exim by using a &%dnsdb%& lookup). If you set
15201 &%allow_utf8_domains%&, you must modify this pattern, or set the option to an
15202 empty string.
15203
15204 .option dns_csa_search_limit main integer 5
15205 This option controls the depth of parental searching for CSA SRV records in the
15206 DNS, as described in more detail in section &<<SECTverifyCSA>>&.
15207
15208 .option dns_csa_use_reverse main boolean true
15209 This option controls whether or not an IP address, given as a CSA domain, is
15210 reversed and looked up in the reverse DNS, as described in more detail in
15211 section &<<SECTverifyCSA>>&.
15212
15213 .option dns_cname_loops main integer 1
15214 .cindex DNS "CNAME following"
15215 This option controls the following of CNAME chains, needed if the resolver does
15216 not do it internally.
15217 As of 2018 most should, and the default can be left.
15218 If you have an ancient one, a value of 10 is likely needed.
15219
15220 The default value of one CNAME-follow is needed
15221 thanks to the observed return for an MX request,
15222 given no MX presence but a CNAME to an A, of the CNAME.
15223
15224
15225 .option dns_dnssec_ok main integer -1
15226 .cindex "DNS" "resolver options"
15227 .cindex "DNS" "DNSSEC"
15228 If this option is set to a non-negative number then Exim will initialise the
15229 DNS resolver library to either use or not use DNSSEC, overriding the system
15230 default. A value of 0 coerces DNSSEC off, a value of 1 coerces DNSSEC on.
15231
15232 If the resolver library does not support DNSSEC then this option has no effect.
15233
15234
15235 .option dns_ipv4_lookup main "domain list&!!" unset
15236 .cindex "IPv6" "DNS lookup for AAAA records"
15237 .cindex "DNS" "IPv6 lookup for AAAA records"
15238 .cindex DNS "IPv6 disabling"
15239 When Exim is compiled with IPv6 support and &%disable_ipv6%& is not set, it
15240 looks for IPv6 address records (AAAA records) as well as IPv4 address records
15241 (A records) when trying to find IP addresses for hosts, unless the host's
15242 domain matches this list.
15243
15244 This is a fudge to help with name servers that give big delays or otherwise do
15245 not work for the AAAA record type. In due course, when the world's name
15246 servers have all been upgraded, there should be no need for this option.
15247 .new
15248 Note that all lookups, including those done for verification, are affected;
15249 this will result in verify failure for IPv6 connections or ones using names
15250 only valid for IPv6 addresses.
15251 .wen
15252
15253
15254 .option dns_retrans main time 0s
15255 .cindex "DNS" "resolver options"
15256 .cindex timeout "dns lookup"
15257 .cindex "DNS" timeout
15258 The options &%dns_retrans%& and &%dns_retry%& can be used to set the
15259 retransmission and retry parameters for DNS lookups. Values of zero (the
15260 defaults) leave the system default settings unchanged. The first value is the
15261 time between retries, and the second is the number of retries. It isn't
15262 totally clear exactly how these settings affect the total time a DNS lookup may
15263 take. I haven't found any documentation about timeouts on DNS lookups; these
15264 parameter values are available in the external resolver interface structure,
15265 but nowhere does it seem to describe how they are used or what you might want
15266 to set in them.
15267 See also the &%slow_lookup_log%& option.
15268
15269
15270 .option dns_retry main integer 0
15271 See &%dns_retrans%& above.
15272
15273
15274 .option dns_trust_aa main "domain list&!!" unset
15275 .cindex "DNS" "resolver options"
15276 .cindex "DNS" "DNSSEC"
15277 If this option is set then lookup results marked with the AA bit
15278 (Authoritative Answer) are trusted the same way as if they were
15279 DNSSEC-verified. The authority section's name of the answer must
15280 match with this expanded domain list.
15281
15282 Use this option only if you talk directly to a resolver that is
15283 authoritative for some zones and does not set the AD (Authentic Data)
15284 bit in the answer. Some DNS servers may have an configuration option to
15285 mark the answers from their own zones as verified (they set the AD bit).
15286 Others do not have this option. It is considered as poor practice using
15287 a resolver that is an authoritative server for some zones.
15288
15289 Use this option only if you really have to (e.g. if you want
15290 to use DANE for remote delivery to a server that is listed in the DNS
15291 zones that your resolver is authoritative for).
15292
15293 If the DNS answer packet has the AA bit set and contains resource record
15294 in the answer section, the name of the first NS record appearing in the
15295 authority section is compared against the list. If the answer packet is
15296 authoritative but the answer section is empty, the name of the first SOA
15297 record in the authoritative section is used instead.
15298
15299 .cindex "DNS" "resolver options"
15300 .option dns_use_edns0 main integer -1
15301 .cindex "DNS" "resolver options"
15302 .cindex "DNS" "EDNS0"
15303 .cindex "DNS" "OpenBSD
15304 If this option is set to a non-negative number then Exim will initialise the
15305 DNS resolver library to either use or not use EDNS0 extensions, overriding
15306 the system default. A value of 0 coerces EDNS0 off, a value of 1 coerces EDNS0
15307 on.
15308
15309 If the resolver library does not support EDNS0 then this option has no effect.
15310
15311 OpenBSD's asr resolver routines are known to ignore the EDNS0 option; this
15312 means that DNSSEC will not work with Exim on that platform either, unless Exim
15313 is linked against an alternative DNS client library.
15314
15315
15316 .option drop_cr main boolean false
15317 This is an obsolete option that is now a no-op. It used to affect the way Exim
15318 handled CR and LF characters in incoming messages. What happens now is
15319 described in section &<<SECTlineendings>>&.
15320
15321 .option dsn_advertise_hosts main "host list&!!" unset
15322 .cindex "bounce messages" "success"
15323 .cindex "DSN" "success"
15324 .cindex "Delivery Status Notification" "success"
15325 DSN extensions (RFC3461) will be advertised in the EHLO message to,
15326 and accepted from, these hosts.
15327 Hosts may use the NOTIFY and ENVID options on RCPT TO commands,
15328 and RET and ORCPT options on MAIL FROM commands.
15329 A NOTIFY=SUCCESS option requests success-DSN messages.
15330 A NOTIFY= option with no argument requests that no delay or failure DSNs
15331 are sent.
15332
15333 .option dsn_from main "string&!!" "see below"
15334 .cindex "&'From:'& header line" "in bounces"
15335 .cindex "bounce messages" "&'From:'& line, specifying"
15336 This option can be used to vary the contents of &'From:'& header lines in
15337 bounces and other automatically generated messages (&"Delivery Status
15338 Notifications"& &-- hence the name of the option). The default setting is:
15339 .code
15340 dsn_from = Mail Delivery System <Mailer-Daemon@$qualify_domain>
15341 .endd
15342 The value is expanded every time it is needed. If the expansion fails, a
15343 panic is logged, and the default value is used.
15344
15345 .option envelope_to_remove main boolean true
15346 .cindex "&'Envelope-to:'& header line"
15347 Exim's transports have an option for adding an &'Envelope-to:'& header to a
15348 message when it is delivered, in exactly the same way as &'Return-path:'& is
15349 handled. &'Envelope-to:'& records the original recipient address from the
15350 message's envelope that caused the delivery to happen. Such headers should not
15351 be present in incoming messages, and this option causes them to be removed at
15352 the time the message is received, to avoid any problems that might occur when a
15353 delivered message is subsequently sent on to some other recipient.
15354
15355
15356 .option errors_copy main "string list&!!" unset
15357 .cindex "bounce message" "copy to other address"
15358 .cindex "copy of bounce message"
15359 Setting this option causes Exim to send bcc copies of bounce messages that it
15360 generates to other addresses. &*Note*&: This does not apply to bounce messages
15361 coming from elsewhere. The value of the option is a colon-separated list of
15362 items. Each item consists of a pattern, terminated by white space, followed by
15363 a comma-separated list of email addresses. If a pattern contains spaces, it
15364 must be enclosed in double quotes.
15365
15366 Each pattern is processed in the same way as a single item in an address list
15367 (see section &<<SECTaddresslist>>&). When a pattern matches the recipient of
15368 the bounce message, the message is copied to the addresses on the list. The
15369 items are scanned in order, and once a matching one is found, no further items
15370 are examined. For example:
15371 .code
15372 errors_copy = spqr@mydomain   postmaster@mydomain.example :\
15373               rqps@mydomain   hostmaster@mydomain.example,\
15374                               postmaster@mydomain.example
15375 .endd
15376 .vindex "&$domain$&"
15377 .vindex "&$local_part$&"
15378 The address list is expanded before use. The expansion variables &$local_part$&
15379 and &$domain$& are set from the original recipient of the error message, and if
15380 there was any wildcard matching in the pattern, the expansion
15381 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%errors_copy%&"
15382 variables &$0$&, &$1$&, etc. are set in the normal way.
15383
15384
15385 .option errors_reply_to main string unset
15386 .cindex "bounce message" "&'Reply-to:'& in"
15387 By default, Exim's bounce and delivery warning messages contain the header line
15388 .display
15389 &`From: Mail Delivery System <Mailer-Daemon@`&&'qualify-domain'&&`>`&
15390 .endd
15391 .oindex &%quota_warn_message%&
15392 where &'qualify-domain'& is the value of the &%qualify_domain%& option.
15393 A warning message that is generated by the &%quota_warn_message%& option in an
15394 &(appendfile)& transport may contain its own &'From:'& header line that
15395 overrides the default.
15396
15397 Experience shows that people reply to bounce messages. If the
15398 &%errors_reply_to%& option is set, a &'Reply-To:'& header is added to bounce
15399 and warning messages. For example:
15400 .code
15401 errors_reply_to = postmaster@my.domain.example
15402 .endd
15403 The value of the option is not expanded. It must specify a valid RFC 2822
15404 address. However, if a warning message that is generated by the
15405 &%quota_warn_message%& option in an &(appendfile)& transport contain its
15406 own &'Reply-To:'& header line, the value of the &%errors_reply_to%& option is
15407 not used.
15408
15409
15410 .option event_action main string&!! unset
15411 .cindex events
15412 This option declares a string to be expanded for Exim's events mechanism.
15413 For details see chapter &<<CHAPevents>>&.
15414
15415
15416 .option exim_group main string "compile-time configured"
15417 .cindex "gid (group id)" "Exim's own"
15418 .cindex "Exim group"
15419 This option changes the gid under which Exim runs when it gives up root
15420 privilege. The default value is compiled into the binary. The value of this
15421 option is used only when &%exim_user%& is also set. Unless it consists entirely
15422 of digits, the string is looked up using &[getgrnam()]&, and failure causes a
15423 configuration error. See chapter &<<CHAPsecurity>>& for a discussion of
15424 security issues.
15425
15426
15427 .option exim_path main string "see below"
15428 .cindex "Exim binary, path name"
15429 This option specifies the path name of the Exim binary, which is used when Exim
15430 needs to re-exec itself. The default is set up to point to the file &'exim'& in
15431 the directory configured at compile time by the BIN_DIRECTORY setting. It
15432 is necessary to change &%exim_path%& if, exceptionally, Exim is run from some
15433 other place.
15434 &*Warning*&: Do not use a macro to define the value of this option, because
15435 you will break those Exim utilities that scan the configuration file to find
15436 where the binary is. (They then use the &%-bP%& option to extract option
15437 settings such as the value of &%spool_directory%&.)
15438
15439
15440 .option exim_user main string "compile-time configured"
15441 .cindex "uid (user id)" "Exim's own"
15442 .cindex "Exim user"
15443 This option changes the uid under which Exim runs when it gives up root
15444 privilege. The default value is compiled into the binary. Ownership of the run
15445 time configuration file and the use of the &%-C%& and &%-D%& command line
15446 options is checked against the values in the binary, not what is set here.
15447
15448 Unless it consists entirely of digits, the string is looked up using
15449 &[getpwnam()]&, and failure causes a configuration error. If &%exim_group%& is
15450 not also supplied, the gid is taken from the result of &[getpwnam()]& if it is
15451 used. See chapter &<<CHAPsecurity>>& for a discussion of security issues.
15452
15453
15454 .option exim_version main string "current version"
15455 .cindex "Exim version"
15456 .cindex customizing "version number"
15457 .cindex "version number of Exim" override
15458 This option allows to override the &$version_number$&/&$exim_version$& Exim reports in
15459 various places.  Use with care, this may fool stupid security scanners.
15460
15461
15462 .option extra_local_interfaces main "string list" unset
15463 This option defines network interfaces that are to be considered local when
15464 routing, but which are not used for listening by the daemon. See section
15465 &<<SECTreclocipadd>>& for details.
15466
15467
15468 . Allow this long option name to split; give it unsplit as a fifth argument
15469 . for the automatic .oindex that is generated by .option.
15470
15471 .option "extract_addresses_remove_arguments" main boolean true &&&
15472          extract_addresses_remove_arguments
15473 .oindex "&%-t%&"
15474 .cindex "command line" "addresses with &%-t%&"
15475 .cindex "Sendmail compatibility" "&%-t%& option"
15476 According to some Sendmail documentation (Sun, IRIX, HP-UX), if any addresses
15477 are present on the command line when the &%-t%& option is used to build an
15478 envelope from a message's &'To:'&, &'Cc:'& and &'Bcc:'& headers, the command
15479 line addresses are removed from the recipients list. This is also how Smail
15480 behaves. However, other Sendmail documentation (the O'Reilly book) states that
15481 command line addresses are added to those obtained from the header lines. When
15482 &%extract_addresses_remove_arguments%& is true (the default), Exim subtracts
15483 argument headers. If it is set false, Exim adds rather than removes argument
15484 addresses.
15485
15486
15487 .option finduser_retries main integer 0
15488 .cindex "NIS, retrying user lookups"
15489 On systems running NIS or other schemes in which user and group information is
15490 distributed from a remote system, there can be times when &[getpwnam()]& and
15491 related functions fail, even when given valid data, because things time out.
15492 Unfortunately these failures cannot be distinguished from genuine &"not found"&
15493 errors. If &%finduser_retries%& is set greater than zero, Exim will try that
15494 many extra times to find a user or a group, waiting for one second between
15495 retries.
15496
15497 .cindex "&_/etc/passwd_&" "multiple reading of"
15498 You should not set this option greater than zero if your user information is in
15499 a traditional &_/etc/passwd_& file, because it will cause Exim needlessly to
15500 search the file multiple times for non-existent users, and also cause delay.
15501
15502
15503
15504 .option freeze_tell main "string list, comma separated" unset
15505 .cindex "freezing messages" "sending a message when freezing"
15506 On encountering certain errors, or when configured to do so in a system filter,
15507 ACL, or special router, Exim freezes a message. This means that no further
15508 delivery attempts take place until an administrator thaws the message, or the
15509 &%auto_thaw%&, &%ignore_bounce_errors_after%&, or &%timeout_frozen_after%&
15510 feature cause it to be processed. If &%freeze_tell%& is set, Exim generates a
15511 warning message whenever it freezes something, unless the message it is
15512 freezing is a locally-generated bounce message. (Without this exception there
15513 is the possibility of looping.) The warning message is sent to the addresses
15514 supplied as the comma-separated value of this option. If several of the
15515 message's addresses cause freezing, only a single message is sent. If the
15516 freezing was automatic, the reason(s) for freezing can be found in the message
15517 log. If you configure freezing in a filter or ACL, you must arrange for any
15518 logging that you require.
15519
15520
15521 .option gecos_name main string&!! unset
15522 .cindex "HP-UX"
15523 .cindex "&""gecos""& field, parsing"
15524 Some operating systems, notably HP-UX, use the &"gecos"& field in the system
15525 password file to hold other information in addition to users' real names. Exim
15526 looks up this field for use when it is creating &'Sender:'& or &'From:'&
15527 headers. If either &%gecos_pattern%& or &%gecos_name%& are unset, the contents
15528 of the field are used unchanged, except that, if an ampersand is encountered,
15529 it is replaced by the user's login name with the first character forced to
15530 upper case, since this is a convention that is observed on many systems.
15531
15532 When these options are set, &%gecos_pattern%& is treated as a regular
15533 expression that is to be applied to the field (again with && replaced by the
15534 login name), and if it matches, &%gecos_name%& is expanded and used as the
15535 user's name.
15536
15537 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%gecos_name%&"
15538 Numeric variables such as &$1$&, &$2$&, etc. can be used in the expansion to
15539 pick up sub-fields that were matched by the pattern. In HP-UX, where the user's
15540 name terminates at the first comma, the following can be used:
15541 .code
15542 gecos_pattern = ([^,]*)
15543 gecos_name = $1
15544 .endd
15545
15546 .option gecos_pattern main string unset
15547 See &%gecos_name%& above.
15548
15549
15550 .option gnutls_compat_mode main boolean unset
15551 This option controls whether GnuTLS is used in compatibility mode in an Exim
15552 server. This reduces security slightly, but improves interworking with older
15553 implementations of TLS.
15554
15555
15556 .option gnutls_allow_auto_pkcs11 main boolean unset
15557 This option will let GnuTLS (2.12.0 or later) autoload PKCS11 modules with
15558 the p11-kit configuration files in &_/etc/pkcs11/modules/_&.
15559
15560 See
15561 &url(https://www.gnutls.org/manual/gnutls.html#Smart-cards-and-HSMs)
15562 for documentation.
15563
15564
15565
15566 .option headers_charset main string "see below"
15567 This option sets a default character set for translating from encoded MIME
15568 &"words"& in header lines, when referenced by an &$h_xxx$& expansion item. The
15569 default is the value of HEADERS_CHARSET in &_Local/Makefile_&. The
15570 ultimate default is ISO-8859-1. For more details see the description of header
15571 insertions in section &<<SECTexpansionitems>>&.
15572
15573
15574
15575 .option header_maxsize main integer "see below"
15576 .cindex "header section" "maximum size of"
15577 .cindex "limit" "size of message header section"
15578 This option controls the overall maximum size of a message's header
15579 section. The default is the value of HEADER_MAXSIZE in
15580 &_Local/Makefile_&; the default for that is 1M. Messages with larger header
15581 sections are rejected.
15582
15583
15584 .option header_line_maxsize main integer 0
15585 .cindex "header lines" "maximum size of"
15586 .cindex "limit" "size of one header line"
15587 This option limits the length of any individual header line in a message, after
15588 all the continuations have been joined together. Messages with individual
15589 header lines that are longer than the limit are rejected. The default value of
15590 zero means &"no limit"&.
15591
15592
15593
15594
15595 .option helo_accept_junk_hosts main "host list&!!" unset
15596 .cindex "HELO" "accepting junk data"
15597 .cindex "EHLO" "accepting junk data"
15598 Exim checks the syntax of HELO and EHLO commands for incoming SMTP
15599 mail, and gives an error response for invalid data. Unfortunately, there are
15600 some SMTP clients that send syntactic junk. They can be accommodated by setting
15601 this option. Note that this is a syntax check only. See &%helo_verify_hosts%&
15602 if you want to do semantic checking.
15603 See also &%helo_allow_chars%& for a way of extending the permitted character
15604 set.
15605
15606
15607 .option helo_allow_chars main string unset
15608 .cindex "HELO" "underscores in"
15609 .cindex "EHLO" "underscores in"
15610 .cindex "underscore in EHLO/HELO"
15611 This option can be set to a string of rogue characters that are permitted in
15612 all EHLO and HELO names in addition to the standard letters, digits,
15613 hyphens, and dots. If you really must allow underscores, you can set
15614 .code
15615 helo_allow_chars = _
15616 .endd
15617 Note that the value is one string, not a list.
15618
15619
15620 .option helo_lookup_domains main "domain list&!!" &`@:@[]`&
15621 .cindex "HELO" "forcing reverse lookup"
15622 .cindex "EHLO" "forcing reverse lookup"
15623 If the domain given by a client in a HELO or EHLO command matches this
15624 list, a reverse lookup is done in order to establish the host's true name. The
15625 default forces a lookup if the client host gives the server's name or any of
15626 its IP addresses (in brackets), something that broken clients have been seen to
15627 do.
15628
15629
15630 .option helo_try_verify_hosts main "host list&!!" unset
15631 .cindex "HELO verifying" "optional"
15632 .cindex "EHLO" "verifying, optional"
15633 By default, Exim just checks the syntax of HELO and EHLO commands (see
15634 &%helo_accept_junk_hosts%& and &%helo_allow_chars%&). However, some sites like
15635 to do more extensive checking of the data supplied by these commands. The ACL
15636 condition &`verify = helo`& is provided to make this possible.
15637 Formerly, it was necessary also to set this option (&%helo_try_verify_hosts%&)
15638 to force the check to occur. From release 4.53 onwards, this is no longer
15639 necessary. If the check has not been done before &`verify = helo`& is
15640 encountered, it is done at that time. Consequently, this option is obsolete.
15641 Its specification is retained here for backwards compatibility.
15642
15643 When an EHLO or HELO command is received, if the calling host matches
15644 &%helo_try_verify_hosts%&, Exim checks that the host name given in the HELO or
15645 EHLO command either:
15646
15647 .ilist
15648 is an IP literal matching the calling address of the host, or
15649 .next
15650 .cindex "DNS" "reverse lookup"
15651 .cindex "reverse DNS lookup"
15652 matches the host name that Exim obtains by doing a reverse lookup of the
15653 calling host address, or
15654 .next
15655 when looked up in DNS yields the calling host address.
15656 .endlist
15657
15658 However, the EHLO or HELO command is not rejected if any of the checks
15659 fail. Processing continues, but the result of the check is remembered, and can
15660 be detected later in an ACL by the &`verify = helo`& condition.
15661
15662 If DNS was used for successful verification, the variable
15663 .cindex "DNS" "DNSSEC"
15664 &$helo_verify_dnssec$& records the DNSSEC status of the lookups.
15665
15666 .option helo_verify_hosts main "host list&!!" unset
15667 .cindex "HELO verifying" "mandatory"
15668 .cindex "EHLO" "verifying, mandatory"
15669 Like &%helo_try_verify_hosts%&, this option is obsolete, and retained only for
15670 backwards compatibility. For hosts that match this option, Exim checks the host
15671 name given in the HELO or EHLO in the same way as for
15672 &%helo_try_verify_hosts%&. If the check fails, the HELO or EHLO command is
15673 rejected with a 550 error, and entries are written to the main and reject logs.
15674 If a MAIL command is received before EHLO or HELO, it is rejected with a 503
15675 error.
15676
15677 .option hold_domains main "domain list&!!" unset
15678 .cindex "domain" "delaying delivery"
15679 .cindex "delivery" "delaying certain domains"
15680 This option allows mail for particular domains to be held in the queue
15681 manually. The option is overridden if a message delivery is forced with the
15682 &%-M%&, &%-qf%&, &%-Rf%& or &%-Sf%& options, and also while testing or
15683 verifying addresses using &%-bt%& or &%-bv%&. Otherwise, if a domain matches an
15684 item in &%hold_domains%&, no routing or delivery for that address is done, and
15685 it is deferred every time the message is looked at.
15686
15687 This option is intended as a temporary operational measure for delaying the
15688 delivery of mail while some problem is being sorted out, or some new
15689 configuration tested. If you just want to delay the processing of some
15690 domains until a queue run occurs, you should use &%queue_domains%& or
15691 &%queue_smtp_domains%&, not &%hold_domains%&.
15692
15693 A setting of &%hold_domains%& does not override Exim's code for removing
15694 messages from the queue if they have been there longer than the longest retry
15695 time in any retry rule. If you want to hold messages for longer than the normal
15696 retry times, insert a dummy retry rule with a long retry time.
15697
15698
15699 .option host_lookup main "host list&!!" unset
15700 .cindex "host name" "lookup, forcing"
15701 Exim does not look up the name of a calling host from its IP address unless it
15702 is required to compare against some host list, or the host matches
15703 &%helo_try_verify_hosts%& or &%helo_verify_hosts%&, or the host matches this
15704 option (which normally contains IP addresses rather than host names). The
15705 default configuration file contains
15706 .code
15707 host_lookup = *
15708 .endd
15709 which causes a lookup to happen for all hosts. If the expense of these lookups
15710 is felt to be too great, the setting can be changed or removed.
15711
15712 After a successful reverse lookup, Exim does a forward lookup on the name it
15713 has obtained, to verify that it yields the IP address that it started with. If
15714 this check fails, Exim behaves as if the name lookup failed.
15715
15716 .vindex "&$host_lookup_failed$&"
15717 .vindex "&$sender_host_name$&"
15718 After any kind of failure, the host name (in &$sender_host_name$&) remains
15719 unset, and &$host_lookup_failed$& is set to the string &"1"&. See also
15720 &%dns_again_means_nonexist%&, &%helo_lookup_domains%&, and
15721 &`verify = reverse_host_lookup`& in ACLs.
15722
15723
15724 .option host_lookup_order main "string list" &`bydns:byaddr`&
15725 This option specifies the order of different lookup methods when Exim is trying
15726 to find a host name from an IP address. The default is to do a DNS lookup
15727 first, and then to try a local lookup (using &[gethostbyaddr()]& or equivalent)
15728 if that fails. You can change the order of these lookups, or omit one entirely,
15729 if you want.
15730
15731 &*Warning*&: The &"byaddr"& method does not always yield aliases when there are
15732 multiple PTR records in the DNS and the IP address is not listed in
15733 &_/etc/hosts_&. Different operating systems give different results in this
15734 case. That is why the default tries a DNS lookup first.
15735
15736
15737
15738 .option host_reject_connection main "host list&!!" unset
15739 .cindex "host" "rejecting connections from"
15740 If this option is set, incoming SMTP calls from the hosts listed are rejected
15741 as soon as the connection is made.
15742 This option is obsolete, and retained only for backward compatibility, because
15743 nowadays the ACL specified by &%acl_smtp_connect%& can also reject incoming
15744 connections immediately.
15745
15746 The ability to give an immediate rejection (either by this option or using an
15747 ACL) is provided for use in unusual cases. Many hosts will just try again,
15748 sometimes without much delay. Normally, it is better to use an ACL to reject
15749 incoming messages at a later stage, such as after RCPT commands. See
15750 chapter &<<CHAPACL>>&.
15751
15752
15753 .option hosts_connection_nolog main "host list&!!" unset
15754 .cindex "host" "not logging connections from"
15755 This option defines a list of hosts for which connection logging does not
15756 happen, even though the &%smtp_connection%& log selector is set. For example,
15757 you might want not to log SMTP connections from local processes, or from
15758 127.0.0.1, or from your local LAN. This option is consulted in the main loop of
15759 the daemon; you should therefore strive to restrict its value to a short inline
15760 list of IP addresses and networks. To disable logging SMTP connections from
15761 local processes, you must create a host list with an empty item. For example:
15762 .code
15763 hosts_connection_nolog = :
15764 .endd
15765 If the &%smtp_connection%& log selector is not set, this option has no effect.
15766
15767
15768
15769 .option hosts_proxy main "host list&!!" unset
15770 .cindex proxy "proxy protocol"
15771 This option enables use of Proxy Protocol proxies for incoming
15772 connections.  For details see section &<<SECTproxyInbound>>&.
15773
15774
15775 .option hosts_treat_as_local main "domain list&!!" unset
15776 .cindex "local host" "domains treated as"
15777 .cindex "host" "treated as local"
15778 If this option is set, any host names that match the domain list are treated as
15779 if they were the local host when Exim is scanning host lists obtained from MX
15780 records
15781 or other sources. Note that the value of this option is a domain list, not a
15782 host list, because it is always used to check host names, not IP addresses.
15783
15784 This option also applies when Exim is matching the special items
15785 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`& in a domain list (see
15786 section &<<SECTdomainlist>>&), and when checking the &%hosts%& option in the
15787 &(smtp)& transport for the local host (see the &%allow_localhost%& option in
15788 that transport). See also &%local_interfaces%&, &%extra_local_interfaces%&, and
15789 chapter &<<CHAPinterfaces>>&, which contains a discussion about local network
15790 interfaces and recognizing the local host.
15791
15792
15793 .option ibase_servers main "string list" unset
15794 .cindex "InterBase" "server list"
15795 This option provides a list of InterBase servers and associated connection data,
15796 to be used in conjunction with &(ibase)& lookups (see section &<<SECID72>>&).
15797 The option is available only if Exim has been built with InterBase support.
15798
15799
15800
15801 .option ignore_bounce_errors_after main time 10w
15802 .cindex "bounce message" "discarding"
15803 .cindex "discarding bounce message"
15804 This option affects the processing of bounce messages that cannot be delivered,
15805 that is, those that suffer a permanent delivery failure. (Bounce messages that
15806 suffer temporary delivery failures are of course retried in the usual way.)
15807
15808 After a permanent delivery failure, bounce messages are frozen,
15809 because there is no sender to whom they can be returned. When a frozen bounce
15810 message has been in the queue for more than the given time, it is unfrozen at
15811 the next queue run, and a further delivery is attempted. If delivery fails
15812 again, the bounce message is discarded. This makes it possible to keep failed
15813 bounce messages around for a shorter time than the normal maximum retry time
15814 for frozen messages. For example,
15815 .code
15816 ignore_bounce_errors_after = 12h
15817 .endd
15818 retries failed bounce message deliveries after 12 hours, discarding any further
15819 failures. If the value of this option is set to a zero time period, bounce
15820 failures are discarded immediately. Setting a very long time (as in the default
15821 value) has the effect of disabling this option. For ways of automatically
15822 dealing with other kinds of frozen message, see &%auto_thaw%& and
15823 &%timeout_frozen_after%&.
15824
15825
15826 .option ignore_fromline_hosts main "host list&!!" unset
15827 .cindex "&""From""& line"
15828 .cindex "UUCP" "&""From""& line"
15829 Some broken SMTP clients insist on sending a UUCP-like &"From&~"& line before
15830 the headers of a message. By default this is treated as the start of the
15831 message's body, which means that any following headers are not recognized as
15832 such. Exim can be made to ignore it by setting &%ignore_fromline_hosts%& to
15833 match those hosts that insist on sending it. If the sender is actually a local
15834 process rather than a remote host, and is using &%-bs%& to inject the messages,
15835 &%ignore_fromline_local%& must be set to achieve this effect.
15836
15837
15838 .option ignore_fromline_local main boolean false
15839 See &%ignore_fromline_hosts%& above.
15840
15841 .option keep_environment main "string list" unset
15842 .cindex "environment" "values from"
15843 This option contains a string list of environment variables to keep.
15844 You have to trust these variables or you have to be sure that
15845 these variables do not impose any security risk. Keep in mind that
15846 during the startup phase Exim is running with an effective UID 0 in most
15847 installations. As the default value is an empty list, the default
15848 environment for using libraries, running embedded Perl code, or running
15849 external binaries is empty, and does not not even contain PATH or HOME.
15850
15851 Actually the list is interpreted as a list of patterns
15852 (&<<SECTlistexpand>>&), except that it is not expanded first.
15853
15854 WARNING: Macro substitution is still done first, so having a macro
15855 FOO and having FOO_HOME in your &%keep_environment%& option may have
15856 unexpected results. You may work around this using a regular expression
15857 that does not match the macro name: ^[F]OO_HOME$.
15858
15859 Current versions of Exim issue a warning during startup if you do not mention
15860 &%keep_environment%& in your runtime configuration file and if your
15861 current environment is not empty. Future versions may not issue that warning
15862 anymore.
15863
15864 See the &%add_environment%& main config option for a way to set
15865 environment variables to a fixed value.  The environment for &(pipe)&
15866 transports is handled separately, see section &<<SECTpipeenv>>& for
15867 details.
15868
15869
15870 .option keep_malformed main time 4d
15871 This option specifies the length of time to keep messages whose spool files
15872 have been corrupted in some way. This should, of course, never happen. At the
15873 next attempt to deliver such a message, it gets removed. The incident is
15874 logged.
15875
15876
15877 .option ldap_ca_cert_dir main string unset
15878 .cindex "LDAP", "TLS CA certificate directory"
15879 .cindex certificate "directory for LDAP"
15880 This option indicates which directory contains CA certificates for verifying
15881 a TLS certificate presented by an LDAP server.
15882 While Exim does not provide a default value, your SSL library may.
15883 Analogous to &%tls_verify_certificates%& but as a client-side option for LDAP
15884 and constrained to be a directory.
15885
15886
15887 .option ldap_ca_cert_file main string unset
15888 .cindex "LDAP", "TLS CA certificate file"
15889 .cindex certificate "file for LDAP"
15890 This option indicates which file contains CA certificates for verifying
15891 a TLS certificate presented by an LDAP server.
15892 While Exim does not provide a default value, your SSL library may.
15893 Analogous to &%tls_verify_certificates%& but as a client-side option for LDAP
15894 and constrained to be a file.
15895
15896
15897 .option ldap_cert_file main string unset
15898 .cindex "LDAP" "TLS client certificate file"
15899 .cindex certificate "file for LDAP"
15900 This option indicates which file contains an TLS client certificate which
15901 Exim should present to the LDAP server during TLS negotiation.
15902 Should be used together with &%ldap_cert_key%&.
15903
15904
15905 .option ldap_cert_key main string unset
15906 .cindex "LDAP" "TLS client key file"
15907 .cindex certificate "key for LDAP"
15908 This option indicates which file contains the secret/private key to use
15909 to prove identity to the LDAP server during TLS negotiation.
15910 Should be used together with &%ldap_cert_file%&, which contains the
15911 identity to be proven.
15912
15913
15914 .option ldap_cipher_suite main string unset
15915 .cindex "LDAP" "TLS cipher suite"
15916 This controls the TLS cipher-suite negotiation during TLS negotiation with
15917 the LDAP server.  See &<<SECTreqciphssl>>& for more details of the format of
15918 cipher-suite options with OpenSSL (as used by LDAP client libraries).
15919
15920
15921 .option ldap_default_servers main "string list" unset
15922 .cindex "LDAP" "default servers"
15923 This option provides a list of LDAP servers which are tried in turn when an
15924 LDAP query does not contain a server. See section &<<SECTforldaque>>& for
15925 details of LDAP queries. This option is available only when Exim has been built
15926 with LDAP support.
15927
15928
15929 .option ldap_require_cert main string unset.
15930 .cindex "LDAP" "policy for LDAP server TLS cert presentation"
15931 This should be one of the values "hard", "demand", "allow", "try" or "never".
15932 A value other than one of these is interpreted as "never".
15933 See the entry "TLS_REQCERT" in your system man page for ldap.conf(5).
15934 Although Exim does not set a default, the LDAP library probably defaults
15935 to hard/demand.
15936
15937
15938 .option ldap_start_tls main boolean false
15939 .cindex "LDAP" "whether or not to negotiate TLS"
15940 If set, Exim will attempt to negotiate TLS with the LDAP server when
15941 connecting on a regular LDAP port.  This is the LDAP equivalent of SMTP's
15942 "STARTTLS".  This is distinct from using "ldaps", which is the LDAP form
15943 of SSL-on-connect.
15944 In the event of failure to negotiate TLS, the action taken is controlled
15945 by &%ldap_require_cert%&.
15946 This option is ignored for &`ldapi`& connections.
15947
15948
15949 .option ldap_version main integer unset
15950 .cindex "LDAP" "protocol version, forcing"
15951 This option can be used to force Exim to set a specific protocol version for
15952 LDAP. If it option is unset, it is shown by the &%-bP%& command line option as
15953 -1. When this is the case, the default is 3 if LDAP_VERSION3 is defined in
15954 the LDAP headers; otherwise it is 2. This option is available only when Exim
15955 has been built with LDAP support.
15956
15957
15958
15959 .option local_from_check main boolean true
15960 .cindex "&'Sender:'& header line" "disabling addition of"
15961 .cindex "&'From:'& header line" "disabling checking of"
15962 When a message is submitted locally (that is, not over a TCP/IP connection) by
15963 an untrusted user, Exim removes any existing &'Sender:'& header line, and
15964 checks that the &'From:'& header line matches the login of the calling user and
15965 the domain specified by &%qualify_domain%&.
15966
15967 &*Note*&: An unqualified address (no domain) in the &'From:'& header in a
15968 locally submitted message is automatically qualified by Exim, unless the
15969 &%-bnq%& command line option is used.
15970
15971 You can use &%local_from_prefix%& and &%local_from_suffix%& to permit affixes
15972 on the local part. If the &'From:'& header line does not match, Exim adds a
15973 &'Sender:'& header with an address constructed from the calling user's login
15974 and the default qualify domain.
15975
15976 If &%local_from_check%& is set false, the &'From:'& header check is disabled,
15977 and no &'Sender:'& header is ever added. If, in addition, you want to retain
15978 &'Sender:'& header lines supplied by untrusted users, you must also set
15979 &%local_sender_retain%& to be true.
15980
15981 .cindex "envelope from"
15982 .cindex "envelope sender"
15983 These options affect only the header lines in the message. The envelope sender
15984 is still forced to be the login id at the qualify domain unless
15985 &%untrusted_set_sender%& permits the user to supply an envelope sender.
15986
15987 For messages received over TCP/IP, an ACL can specify &"submission mode"& to
15988 request similar header line checking. See section &<<SECTthesenhea>>&, which
15989 has more details about &'Sender:'& processing.
15990
15991
15992
15993
15994 .option local_from_prefix main string unset
15995 When Exim checks the &'From:'& header line of locally submitted messages for
15996 matching the login id (see &%local_from_check%& above), it can be configured to
15997 ignore certain prefixes and suffixes in the local part of the address. This is
15998 done by setting &%local_from_prefix%& and/or &%local_from_suffix%& to
15999 appropriate lists, in the same form as the &%local_part_prefix%& and
16000 &%local_part_suffix%& router options (see chapter &<<CHAProutergeneric>>&). For
16001 example, if
16002 .code
16003 local_from_prefix = *-
16004 .endd
16005 is set, a &'From:'& line containing
16006 .code
16007 From: anything-user@your.domain.example
16008 .endd
16009 will not cause a &'Sender:'& header to be added if &'user@your.domain.example'&
16010 matches the actual sender address that is constructed from the login name and
16011 qualify domain.
16012
16013
16014 .option local_from_suffix main string unset
16015 See &%local_from_prefix%& above.
16016
16017
16018 .option local_interfaces main "string list" "see below"
16019 This option controls which network interfaces are used by the daemon for
16020 listening; they are also used to identify the local host when routing. Chapter
16021 &<<CHAPinterfaces>>& contains a full description of this option and the related
16022 options &%daemon_smtp_ports%&, &%extra_local_interfaces%&,
16023 &%hosts_treat_as_local%&, and &%tls_on_connect_ports%&. The default value for
16024 &%local_interfaces%& is
16025 .code
16026 local_interfaces = 0.0.0.0
16027 .endd
16028 when Exim is built without IPv6 support; otherwise it is
16029 .code
16030 local_interfaces = <; ::0 ; 0.0.0.0
16031 .endd
16032
16033 .option local_scan_timeout main time 5m
16034 .cindex "timeout" "for &[local_scan()]& function"
16035 .cindex "&[local_scan()]& function" "timeout"
16036 This timeout applies to the &[local_scan()]& function (see chapter
16037 &<<CHAPlocalscan>>&). Zero means &"no timeout"&. If the timeout is exceeded,
16038 the incoming message is rejected with a temporary error if it is an SMTP
16039 message. For a non-SMTP message, the message is dropped and Exim ends with a
16040 non-zero code. The incident is logged on the main and reject logs.
16041
16042
16043
16044 .option local_sender_retain main boolean false
16045 .cindex "&'Sender:'& header line" "retaining from local submission"
16046 When a message is submitted locally (that is, not over a TCP/IP connection) by
16047 an untrusted user, Exim removes any existing &'Sender:'& header line. If you
16048 do not want this to happen, you must set &%local_sender_retain%&, and you must
16049 also set &%local_from_check%& to be false (Exim will complain if you do not).
16050 See also the ACL modifier &`control = suppress_local_fixups`&. Section
16051 &<<SECTthesenhea>>& has more details about &'Sender:'& processing.
16052
16053
16054
16055
16056 .option localhost_number main string&!! unset
16057 .cindex "host" "locally unique number for"
16058 .cindex "message ids" "with multiple hosts"
16059 .vindex "&$localhost_number$&"
16060 Exim's message ids are normally unique only within the local host. If
16061 uniqueness among a set of hosts is required, each host must set a different
16062 value for the &%localhost_number%& option. The string is expanded immediately
16063 after reading the configuration file (so that a number can be computed from the
16064 host name, for example) and the result of the expansion must be a number in the
16065 range 0&--16 (or 0&--10 on operating systems with case-insensitive file
16066 systems). This is available in subsequent string expansions via the variable
16067 &$localhost_number$&. When &%localhost_number is set%&, the final two
16068 characters of the message id, instead of just being a fractional part of the
16069 time, are computed from the time and the local host number as described in
16070 section &<<SECTmessiden>>&.
16071
16072
16073
16074 .option log_file_path main "string list&!!" "set at compile time"
16075 .cindex "log" "file path for"
16076 This option sets the path which is used to determine the names of Exim's log
16077 files, or indicates that logging is to be to syslog, or both. It is expanded
16078 when Exim is entered, so it can, for example, contain a reference to the host
16079 name. If no specific path is set for the log files at compile or runtime,
16080 or if the option is unset at runtime (i.e.  &`log_file_path = `&)
16081 they are written in a sub-directory called &_log_& in Exim's spool directory.
16082 .new
16083 A path must start with a slash.
16084 To send to syslog, use the word &"syslog"&.
16085 .wen
16086 Chapter &<<CHAPlog>>& contains further details about Exim's logging, and
16087 section &<<SECTwhelogwri>>& describes how the contents of &%log_file_path%& are
16088 used. If this string is fixed at your installation (contains no expansion
16089 variables) it is recommended that you do not set this option in the
16090 configuration file, but instead supply the path using LOG_FILE_PATH in
16091 &_Local/Makefile_& so that it is available to Exim for logging errors detected
16092 early on &-- in particular, failure to read the configuration file.
16093
16094
16095 .option log_selector main string unset
16096 .cindex "log" "selectors"
16097 This option can be used to reduce or increase the number of things that Exim
16098 writes to its log files. Its argument is made up of names preceded by plus or
16099 minus characters. For example:
16100 .code
16101 log_selector = +arguments -retry_defer
16102 .endd
16103 A list of possible names and what they control is given in the chapter on
16104 logging, in section &<<SECTlogselector>>&.
16105
16106
16107 .option log_timezone main boolean false
16108 .cindex "log" "timezone for entries"
16109 .vindex "&$tod_log$&"
16110 .vindex "&$tod_zone$&"
16111 By default, the timestamps on log lines are in local time without the
16112 timezone. This means that if your timezone changes twice a year, the timestamps
16113 in log lines are ambiguous for an hour when the clocks go back. One way of
16114 avoiding this problem is to set the timezone to UTC. An alternative is to set
16115 &%log_timezone%& true. This turns on the addition of the timezone offset to
16116 timestamps in log lines. Turning on this option can add quite a lot to the size
16117 of log files because each line is extended by 6 characters. Note that the
16118 &$tod_log$& variable contains the log timestamp without the zone, but there is
16119 another variable called &$tod_zone$& that contains just the timezone offset.
16120
16121
16122 .option lookup_open_max main integer 25
16123 .cindex "too many open files"
16124 .cindex "open files, too many"
16125 .cindex "file" "too many open"
16126 .cindex "lookup" "maximum open files"
16127 .cindex "limit" "open files for lookups"
16128 This option limits the number of simultaneously open files for single-key
16129 lookups that use regular files (that is, &(lsearch)&, &(dbm)&, and &(cdb)&).
16130 Exim normally keeps these files open during routing, because often the same
16131 file is required several times. If the limit is reached, Exim closes the least
16132 recently used file. Note that if you are using the &'ndbm'& library, it
16133 actually opens two files for each logical DBM database, though it still counts
16134 as one for the purposes of &%lookup_open_max%&. If you are getting &"too many
16135 open files"& errors with NDBM, you need to reduce the value of
16136 &%lookup_open_max%&.
16137
16138
16139 .option max_username_length main integer 0
16140 .cindex "length of login name"
16141 .cindex "user name" "maximum length"
16142 .cindex "limit" "user name length"
16143 Some operating systems are broken in that they truncate long arguments to
16144 &[getpwnam()]& to eight characters, instead of returning &"no such user"&. If
16145 this option is set greater than zero, any attempt to call &[getpwnam()]& with
16146 an argument that is longer behaves as if &[getpwnam()]& failed.
16147
16148
16149 .option message_body_newlines main bool false
16150 .cindex "message body" "newlines in variables"
16151 .cindex "newline" "in message body variables"
16152 .vindex "&$message_body$&"
16153 .vindex "&$message_body_end$&"
16154 By default, newlines in the message body are replaced by spaces when setting
16155 the &$message_body$& and &$message_body_end$& expansion variables. If this
16156 option is set true, this no longer happens.
16157
16158
16159 .option message_body_visible main integer 500
16160 .cindex "body of message" "visible size"
16161 .cindex "message body" "visible size"
16162 .vindex "&$message_body$&"
16163 .vindex "&$message_body_end$&"
16164 This option specifies how much of a message's body is to be included in the
16165 &$message_body$& and &$message_body_end$& expansion variables.
16166
16167
16168 .option message_id_header_domain main string&!! unset
16169 .cindex "&'Message-ID:'& header line"
16170 If this option is set, the string is expanded and used as the right hand side
16171 (domain) of the &'Message-ID:'& header that Exim creates if a
16172 locally-originated incoming message does not have one. &"Locally-originated"&
16173 means &"not received over TCP/IP."&
16174 Otherwise, the primary host name is used.
16175 Only letters, digits, dot and hyphen are accepted; any other characters are
16176 replaced by hyphens. If the expansion is forced to fail, or if the result is an
16177 empty string, the option is ignored.
16178
16179
16180 .option message_id_header_text main string&!! unset
16181 If this variable is set, the string is expanded and used to augment the text of
16182 the &'Message-id:'& header that Exim creates if a locally-originated incoming
16183 message does not have one. The text of this header is required by RFC 2822 to
16184 take the form of an address. By default, Exim uses its internal message id as
16185 the local part, and the primary host name as the domain. If this option is set,
16186 it is expanded, and provided the expansion is not forced to fail, and does not
16187 yield an empty string, the result is inserted into the header immediately
16188 before the @, separated from the internal message id by a dot. Any characters
16189 that are illegal in an address are automatically converted into hyphens. This
16190 means that variables such as &$tod_log$& can be used, because the spaces and
16191 colons will become hyphens.
16192
16193
16194 .option message_logs main boolean true
16195 .cindex "message logs" "disabling"
16196 .cindex "log" "message log; disabling"
16197 If this option is turned off, per-message log files are not created in the
16198 &_msglog_& spool sub-directory. This reduces the amount of disk I/O required by
16199 Exim, by reducing the number of files involved in handling a message from a
16200 minimum of four (header spool file, body spool file, delivery journal, and
16201 per-message log) to three. The other major I/O activity is Exim's main log,
16202 which is not affected by this option.
16203
16204
16205 .option message_size_limit main string&!! 50M
16206 .cindex "message" "size limit"
16207 .cindex "limit" "message size"
16208 .cindex "size" "of message, limit"
16209 This option limits the maximum size of message that Exim will process. The
16210 value is expanded for each incoming connection so, for example, it can be made
16211 to depend on the IP address of the remote host for messages arriving via
16212 TCP/IP. After expansion, the value must be a sequence of decimal digits,
16213 optionally followed by K or M.
16214
16215 &*Note*&: This limit cannot be made to depend on a message's sender or any
16216 other properties of an individual message, because it has to be advertised in
16217 the server's response to EHLO. String expansion failure causes a temporary
16218 error. A value of zero means no limit, but its use is not recommended. See also
16219 &%bounce_return_size_limit%&.
16220
16221 Incoming SMTP messages are failed with a 552 error if the limit is
16222 exceeded; locally-generated messages either get a stderr message or a delivery
16223 failure message to the sender, depending on the &%-oe%& setting. Rejection of
16224 an oversized message is logged in both the main and the reject logs. See also
16225 the generic transport option &%message_size_limit%&, which limits the size of
16226 message that an individual transport can process.
16227
16228 If you use a virus-scanner and set this option to to a value larger than the
16229 maximum size that your virus-scanner is configured to support, you may get
16230 failures triggered by large mails.  The right size to configure for the
16231 virus-scanner depends upon what data is passed and the options in use but it's
16232 probably safest to just set it to a little larger than this value.  E.g., with a
16233 default Exim message size of 50M and a default ClamAV StreamMaxLength of 10M,
16234 some problems may result.
16235
16236 A value of 0 will disable size limit checking; Exim will still advertise the
16237 SIZE extension in an EHLO response, but without a limit, so as to permit
16238 SMTP clients to still indicate the message size along with the MAIL verb.
16239
16240
16241 .option move_frozen_messages main boolean false
16242 .cindex "frozen messages" "moving"
16243 This option, which is available only if Exim has been built with the setting
16244 .code
16245 SUPPORT_MOVE_FROZEN_MESSAGES=yes
16246 .endd
16247 in &_Local/Makefile_&, causes frozen messages and their message logs to be
16248 moved from the &_input_& and &_msglog_& directories on the spool to &_Finput_&
16249 and &_Fmsglog_&, respectively. There is currently no support in Exim or the
16250 standard utilities for handling such moved messages, and they do not show up in
16251 lists generated by &%-bp%& or by the Exim monitor.
16252
16253
16254 .option mua_wrapper main boolean false
16255 Setting this option true causes Exim to run in a very restrictive mode in which
16256 it passes messages synchronously to a smart host. Chapter &<<CHAPnonqueueing>>&
16257 contains a full description of this facility.
16258
16259
16260
16261 .option mysql_servers main "string list" unset
16262 .cindex "MySQL" "server list"
16263 This option provides a list of MySQL servers and associated connection data, to
16264 be used in conjunction with &(mysql)& lookups (see section &<<SECID72>>&). The
16265 option is available only if Exim has been built with MySQL support.
16266
16267
16268 .option never_users main "string list&!!" unset
16269 This option is expanded just once, at the start of Exim's processing. Local
16270 message deliveries are normally run in processes that are setuid to the
16271 recipient, and remote deliveries are normally run under Exim's own uid and gid.
16272 It is usually desirable to prevent any deliveries from running as root, as a
16273 safety precaution.
16274
16275 When Exim is built, an option called FIXED_NEVER_USERS can be set to a
16276 list of users that must not be used for local deliveries. This list is fixed in
16277 the binary and cannot be overridden by the configuration file. By default, it
16278 contains just the single user name &"root"&. The &%never_users%& runtime option
16279 can be used to add more users to the fixed list.
16280
16281 If a message is to be delivered as one of the users on the fixed list or the
16282 &%never_users%& list, an error occurs, and delivery is deferred. A common
16283 example is
16284 .code
16285 never_users = root:daemon:bin
16286 .endd
16287 Including root is redundant if it is also on the fixed list, but it does no
16288 harm. This option overrides the &%pipe_as_creator%& option of the &(pipe)&
16289 transport driver.
16290
16291
16292 .option openssl_options main "string list" "+no_sslv2 +no_sslv3 +single_dh_use +no_ticket +no_renegotiation"
16293 .cindex "OpenSSL "compatibility options"
16294 This option allows an administrator to adjust the SSL options applied
16295 by OpenSSL to connections.  It is given as a space-separated list of items,
16296 each one to be +added or -subtracted from the current value.
16297
16298 This option is only available if Exim is built against OpenSSL.  The values
16299 available for this option vary according to the age of your OpenSSL install.
16300 The &"all"& value controls a subset of flags which are available, typically
16301 the bug workaround options.  The &'SSL_CTX_set_options'& man page will
16302 list the values known on your system and Exim should support all the
16303 &"bug workaround"& options and many of the &"modifying"& options.  The Exim
16304 names lose the leading &"SSL_OP_"& and are lower-cased.
16305
16306 Note that adjusting the options can have severe impact upon the security of
16307 SSL as used by Exim.  It is possible to disable safety checks and shoot
16308 yourself in the foot in various unpleasant ways.  This option should not be
16309 adjusted lightly.  An unrecognised item will be detected at startup, by
16310 invoking Exim with the &%-bV%& flag.
16311
16312 The option affects Exim operating both as a server and as a client.
16313
16314 Historical note: prior to release 4.80, Exim defaulted this value to
16315 "+dont_insert_empty_fragments", which may still be needed for compatibility
16316 with some clients, but which lowers security by increasing exposure to
16317 some now infamous attacks.
16318
16319 Examples:
16320 .code
16321 # Make both old MS and old Eudora happy:
16322 openssl_options = -all +microsoft_big_sslv3_buffer \
16323                        +dont_insert_empty_fragments
16324
16325 # Disable older protocol versions:
16326 openssl_options = +no_sslv2 +no_sslv3
16327 .endd
16328
16329 Possible options may include:
16330 .ilist
16331 &`all`&
16332 .next
16333 &`allow_unsafe_legacy_renegotiation`&
16334 .next
16335 &`cipher_server_preference`&
16336 .next
16337 &`dont_insert_empty_fragments`&
16338 .next
16339 &`ephemeral_rsa`&
16340 .next
16341 &`legacy_server_connect`&
16342 .next
16343 &`microsoft_big_sslv3_buffer`&
16344 .next
16345 &`microsoft_sess_id_bug`&
16346 .next
16347 &`msie_sslv2_rsa_padding`&
16348 .next
16349 &`netscape_challenge_bug`&
16350 .next
16351 &`netscape_reuse_cipher_change_bug`&
16352 .next
16353 &`no_compression`&
16354 .next
16355 &`no_session_resumption_on_renegotiation`&
16356 .next
16357 &`no_sslv2`&
16358 .next
16359 &`no_sslv3`&
16360 .next
16361 &`no_ticket`&
16362 .next
16363 &`no_tlsv1`&
16364 .next
16365 &`no_tlsv1_1`&
16366 .next
16367 &`no_tlsv1_2`&
16368 .next
16369 &`safari_ecdhe_ecdsa_bug`&
16370 .next
16371 &`single_dh_use`&
16372 .next
16373 &`single_ecdh_use`&
16374 .next
16375 &`ssleay_080_client_dh_bug`&
16376 .next
16377 &`sslref2_reuse_cert_type_bug`&
16378 .next
16379 &`tls_block_padding_bug`&
16380 .next
16381 &`tls_d5_bug`&
16382 .next
16383 &`tls_rollback_bug`&
16384 .endlist
16385
16386 As an aside, the &`safari_ecdhe_ecdsa_bug`& item is a misnomer and affects
16387 all clients connecting using the MacOS SecureTransport TLS facility prior
16388 to MacOS 10.8.4, including email clients.  If you see old MacOS clients failing
16389 to negotiate TLS then this option value might help, provided that your OpenSSL
16390 release is new enough to contain this work-around.  This may be a situation
16391 where you have to upgrade OpenSSL to get buggy clients working.
16392
16393
16394 .option oracle_servers main "string list" unset
16395 .cindex "Oracle" "server list"
16396 This option provides a list of Oracle servers and associated connection data,
16397 to be used in conjunction with &(oracle)& lookups (see section &<<SECID72>>&).
16398 The option is available only if Exim has been built with Oracle support.
16399
16400
16401 .option percent_hack_domains main "domain list&!!" unset
16402 .cindex "&""percent hack""&"
16403 .cindex "source routing" "in email address"
16404 .cindex "address" "source-routed"
16405 The &"percent hack"& is the convention whereby a local part containing a
16406 percent sign is re-interpreted as a new email address, with the percent
16407 replaced by @. This is sometimes called &"source routing"&, though that term is
16408 also applied to RFC 2822 addresses that begin with an @ character. If this
16409 option is set, Exim implements the percent facility for those domains listed,
16410 but no others. This happens before an incoming SMTP address is tested against
16411 an ACL.
16412
16413 &*Warning*&: The &"percent hack"& has often been abused by people who are
16414 trying to get round relaying restrictions. For this reason, it is best avoided
16415 if at all possible. Unfortunately, a number of less security-conscious MTAs
16416 implement it unconditionally. If you are running Exim on a gateway host, and
16417 routing mail through to internal MTAs without processing the local parts, it is
16418 a good idea to reject recipient addresses with percent characters in their
16419 local parts. Exim's default configuration does this.
16420
16421
16422 .option perl_at_start main boolean false
16423 .cindex "Perl"
16424 This option is available only when Exim is built with an embedded Perl
16425 interpreter. See chapter &<<CHAPperl>>& for details of its use.
16426
16427
16428 .option perl_startup main string unset
16429 .cindex "Perl"
16430 This option is available only when Exim is built with an embedded Perl
16431 interpreter. See chapter &<<CHAPperl>>& for details of its use.
16432
16433 .option perl_startup main boolean false
16434 .cindex "Perl"
16435 This Option enables the taint mode of the embedded Perl interpreter.
16436
16437
16438 .option pgsql_servers main "string list" unset
16439 .cindex "PostgreSQL lookup type" "server list"
16440 This option provides a list of PostgreSQL servers and associated connection
16441 data, to be used in conjunction with &(pgsql)& lookups (see section
16442 &<<SECID72>>&). The option is available only if Exim has been built with
16443 PostgreSQL support.
16444
16445
16446 .option pid_file_path main string&!! "set at compile time"
16447 .cindex "daemon" "pid file path"
16448 .cindex "pid file, path for"
16449 This option sets the name of the file to which the Exim daemon writes its
16450 process id. The string is expanded, so it can contain, for example, references
16451 to the host name:
16452 .code
16453 pid_file_path = /var/log/$primary_hostname/exim.pid
16454 .endd
16455 If no path is set, the pid is written to the file &_exim-daemon.pid_& in Exim's
16456 spool directory.
16457 The value set by the option can be overridden by the &%-oP%& command line
16458 option. A pid file is not written if a &"non-standard"& daemon is run by means
16459 of the &%-oX%& option, unless a path is explicitly supplied by &%-oP%&.
16460
16461
16462 .option pipelining_advertise_hosts main "host list&!!" *
16463 .cindex "PIPELINING" "suppressing advertising"
16464 This option can be used to suppress the advertisement of the SMTP
16465 PIPELINING extension to specific hosts. See also the &*no_pipelining*&
16466 control in section &<<SECTcontrols>>&. When PIPELINING is not advertised and
16467 &%smtp_enforce_sync%& is true, an Exim server enforces strict synchronization
16468 for each SMTP command and response. When PIPELINING is advertised, Exim assumes
16469 that clients will use it; &"out of order"& commands that are &"expected"& do
16470 not count as protocol errors (see &%smtp_max_synprot_errors%&).
16471
16472 .new
16473 .option pipelining_connect_advertise_hosts main "host list&!!" *
16474 .cindex "pipelining" "early connection"
16475 .cindex "pipelining" PIPE_CONNECT
16476 If Exim is built with the SUPPORT_PIPE_CONNECT build option
16477 this option controls which hosts the facility is advertised to
16478 and from which pipeline early-connection (before MAIL) SMTP
16479 commands are acceptable.
16480 When used, the pipelining saves on roundtrip times.
16481
16482 See also the &%hosts_pipe_connect%& smtp transport option.
16483
16484 Currently the option name &"X_PIPE_CONNECT"& is used.
16485 .wen
16486
16487
16488 .option prdr_enable main boolean false
16489 .cindex "PRDR" "enabling on server"
16490 This option can be used to enable the Per-Recipient Data Response extension
16491 to SMTP, defined by Eric Hall.
16492 If the option is set, PRDR is advertised by Exim when operating as a server.
16493 If the client requests PRDR, and more than one recipient, for a message
16494 an additional ACL is called for each recipient after the message content
16495 is received.  See section &<<SECTPRDRACL>>&.
16496
16497 .option preserve_message_logs main boolean false
16498 .cindex "message logs" "preserving"
16499 If this option is set, message log files are not deleted when messages are
16500 completed. Instead, they are moved to a sub-directory of the spool directory
16501 called &_msglog.OLD_&, where they remain available for statistical or debugging
16502 purposes. This is a dangerous option to set on systems with any appreciable
16503 volume of mail. Use with care!
16504
16505
16506 .option primary_hostname main string "see below"
16507 .cindex "name" "of local host"
16508 .cindex "host" "name of local"
16509 .cindex "local host" "name of"
16510 .vindex "&$primary_hostname$&"
16511 This specifies the name of the current host. It is used in the default EHLO or
16512 HELO command for outgoing SMTP messages (changeable via the &%helo_data%&
16513 option in the &(smtp)& transport), and as the default for &%qualify_domain%&.
16514 The value is also used by default in some SMTP response messages from an Exim
16515 server. This can be changed dynamically by setting &%smtp_active_hostname%&.
16516
16517 If &%primary_hostname%& is not set, Exim calls &[uname()]& to find the host
16518 name. If this fails, Exim panics and dies. If the name returned by &[uname()]&
16519 contains only one component, Exim passes it to &[gethostbyname()]& (or
16520 &[getipnodebyname()]& when available) in order to obtain the fully qualified
16521 version. The variable &$primary_hostname$& contains the host name, whether set
16522 explicitly by this option, or defaulted.
16523
16524
16525 .option print_topbitchars main boolean false
16526 .cindex "printing characters"
16527 .cindex "8-bit characters"
16528 By default, Exim considers only those characters whose codes lie in the range
16529 32&--126 to be printing characters. In a number of circumstances (for example,
16530 when writing log entries) non-printing characters are converted into escape
16531 sequences, primarily to avoid messing up the layout. If &%print_topbitchars%&
16532 is set, code values of 128 and above are also considered to be printing
16533 characters.
16534
16535 This option also affects the header syntax checks performed by the
16536 &(autoreply)& transport, and whether Exim uses RFC 2047 encoding of
16537 the user's full name when constructing From: and Sender: addresses (as
16538 described in section &<<SECTconstr>>&). Setting this option can cause
16539 Exim to generate eight bit message headers that do not conform to the
16540 standards.
16541
16542
16543 .option process_log_path main string unset
16544 .cindex "process log path"
16545 .cindex "log" "process log"
16546 .cindex "&'exiwhat'&"
16547 This option sets the name of the file to which an Exim process writes its
16548 &"process log"& when sent a USR1 signal. This is used by the &'exiwhat'&
16549 utility script. If this option is unset, the file called &_exim-process.info_&
16550 in Exim's spool directory is used. The ability to specify the name explicitly
16551 can be useful in environments where two different Exims are running, using
16552 different spool directories.
16553
16554
16555 .option prod_requires_admin main boolean true
16556 .cindex "restricting access to features"
16557 .oindex "&%-M%&"
16558 .oindex "&%-R%&"
16559 .oindex "&%-q%&"
16560 The &%-M%&, &%-R%&, and &%-q%& command-line options require the caller to be an
16561 admin user unless &%prod_requires_admin%& is set false. See also
16562 &%queue_list_requires_admin%& and &%commandline_checks_require_admin%&.
16563
16564
16565 .option qualify_domain main string "see below"
16566 .cindex "domain" "for qualifying addresses"
16567 .cindex "address" "qualification"
16568 This option specifies the domain name that is added to any envelope sender
16569 addresses that do not have a domain qualification. It also applies to
16570 recipient addresses if &%qualify_recipient%& is not set. Unqualified addresses
16571 are accepted by default only for locally-generated messages. Qualification is
16572 also applied to addresses in header lines such as &'From:'& and &'To:'& for
16573 locally-generated messages, unless the &%-bnq%& command line option is used.
16574
16575 Messages from external sources must always contain fully qualified addresses,
16576 unless the sending host matches &%sender_unqualified_hosts%& or
16577 &%recipient_unqualified_hosts%& (as appropriate), in which case incoming
16578 addresses are qualified with &%qualify_domain%& or &%qualify_recipient%& as
16579 necessary. Internally, Exim always works with fully qualified envelope
16580 addresses. If &%qualify_domain%& is not set, it defaults to the
16581 &%primary_hostname%& value.
16582
16583
16584 .option qualify_recipient main string "see below"
16585 This option allows you to specify a different domain for qualifying recipient
16586 addresses to the one that is used for senders. See &%qualify_domain%& above.
16587
16588
16589
16590 .option queue_domains main "domain list&!!" unset
16591 .cindex "domain" "specifying non-immediate delivery"
16592 .cindex "queueing incoming messages"
16593 .cindex "message" "queueing certain domains"
16594 This option lists domains for which immediate delivery is not required.
16595 A delivery process is started whenever a message is received, but only those
16596 domains that do not match are processed. All other deliveries wait until the
16597 next queue run. See also &%hold_domains%& and &%queue_smtp_domains%&.
16598
16599
16600 .option queue_list_requires_admin main boolean true
16601 .cindex "restricting access to features"
16602 .oindex "&%-bp%&"
16603 The &%-bp%& command-line option, which lists the messages that are on the
16604 queue, requires the caller to be an admin user unless
16605 &%queue_list_requires_admin%& is set false.
16606 See also &%prod_requires_admin%& and &%commandline_checks_require_admin%&.
16607
16608
16609 .option queue_only main boolean false
16610 .cindex "queueing incoming messages"
16611 .cindex "message" "queueing unconditionally"
16612 If &%queue_only%& is set, a delivery process is not automatically started
16613 whenever a message is received. Instead, the message waits in the queue for the
16614 next queue run. Even if &%queue_only%& is false, incoming messages may not get
16615 delivered immediately when certain conditions (such as heavy load) occur.
16616
16617 The &%-odq%& command line has the same effect as &%queue_only%&. The &%-odb%&
16618 and &%-odi%& command line options override &%queue_only%& unless
16619 &%queue_only_override%& is set false. See also &%queue_only_file%&,
16620 &%queue_only_load%&, and &%smtp_accept_queue%&.
16621
16622
16623 .option queue_only_file main string unset
16624 .cindex "queueing incoming messages"
16625 .cindex "message" "queueing by file existence"
16626 This option can be set to a colon-separated list of absolute path names, each
16627 one optionally preceded by &"smtp"&. When Exim is receiving a message,
16628 it tests for the existence of each listed path using a call to &[stat()]&. For
16629 each path that exists, the corresponding queueing option is set.
16630 For paths with no prefix, &%queue_only%& is set; for paths prefixed by
16631 &"smtp"&, &%queue_smtp_domains%& is set to match all domains. So, for example,
16632 .code
16633 queue_only_file = smtp/some/file
16634 .endd
16635 causes Exim to behave as if &%queue_smtp_domains%& were set to &"*"& whenever
16636 &_/some/file_& exists.
16637
16638
16639 .option queue_only_load main fixed-point unset
16640 .cindex "load average"
16641 .cindex "queueing incoming messages"
16642 .cindex "message" "queueing by load"
16643 If the system load average is higher than this value, incoming messages from
16644 all sources are queued, and no automatic deliveries are started. If this
16645 happens during local or remote SMTP input, all subsequent messages received on
16646 the same SMTP connection are queued by default, whatever happens to the load in
16647 the meantime, but this can be changed by setting &%queue_only_load_latch%&
16648 false.
16649
16650 Deliveries will subsequently be performed by queue runner processes. This
16651 option has no effect on ancient operating systems on which Exim cannot
16652 determine the load average. See also &%deliver_queue_load_max%& and
16653 &%smtp_load_reserve%&.
16654
16655
16656 .option queue_only_load_latch main boolean true
16657 .cindex "load average" "re-evaluating per message"
16658 When this option is true (the default), once one message has been queued
16659 because the load average is higher than the value set by &%queue_only_load%&,
16660 all subsequent messages received on the same SMTP connection are also queued.
16661 This is a deliberate choice; even though the load average may fall below the
16662 threshold, it doesn't seem right to deliver later messages on the same
16663 connection when not delivering earlier ones. However, there are special
16664 circumstances such as very long-lived connections from scanning appliances
16665 where this is not the best strategy. In such cases, &%queue_only_load_latch%&
16666 should be set false. This causes the value of the load average to be
16667 re-evaluated for each message.
16668
16669
16670 .option queue_only_override main boolean true
16671 .cindex "queueing incoming messages"
16672 When this option is true, the &%-od%&&'x'& command line options override the
16673 setting of &%queue_only%& or &%queue_only_file%& in the configuration file. If
16674 &%queue_only_override%& is set false, the &%-od%&&'x'& options cannot be used
16675 to override; they are accepted, but ignored.
16676
16677
16678 .option queue_run_in_order main boolean false
16679 .cindex "queue runner" "processing messages in order"
16680 If this option is set, queue runs happen in order of message arrival instead of
16681 in an arbitrary order. For this to happen, a complete list of the entire queue
16682 must be set up before the deliveries start. When the queue is all held in a
16683 single directory (the default), a single list is created for both the ordered
16684 and the non-ordered cases. However, if &%split_spool_directory%& is set, a
16685 single list is not created when &%queue_run_in_order%& is false. In this case,
16686 the sub-directories are processed one at a time (in a random order), and this
16687 avoids setting up one huge list for the whole queue. Thus, setting
16688 &%queue_run_in_order%& with &%split_spool_directory%& may degrade performance
16689 when the queue is large, because of the extra work in setting up the single,
16690 large list. In most situations, &%queue_run_in_order%& should not be set.
16691
16692
16693
16694 .option queue_run_max main integer&!! 5
16695 .cindex "queue runner" "maximum number of"
16696 This controls the maximum number of queue runner processes that an Exim daemon
16697 can run simultaneously. This does not mean that it starts them all at once,
16698 but rather that if the maximum number are still running when the time comes to
16699 start another one, it refrains from starting another one. This can happen with
16700 very large queues and/or very sluggish deliveries. This option does not,
16701 however, interlock with other processes, so additional queue runners can be
16702 started by other means, or by killing and restarting the daemon.
16703
16704 Setting this option to zero does not suppress queue runs; rather, it disables
16705 the limit, allowing any number of simultaneous queue runner processes to be
16706 run. If you do not want queue runs to occur, omit the &%-q%&&'xx'& setting on
16707 the daemon's command line.
16708
16709 .cindex queues named
16710 .cindex "named queues"
16711 To set limits for different named queues use
16712 an expansion depending on the &$queue_name$& variable.
16713
16714 .option queue_smtp_domains main "domain list&!!" unset
16715 .cindex "queueing incoming messages"
16716 .cindex "message" "queueing remote deliveries"
16717 When this option is set, a delivery process is started whenever a message is
16718 received, routing is performed, and local deliveries take place.
16719 However, if any SMTP deliveries are required for domains that match
16720 &%queue_smtp_domains%&, they are not immediately delivered, but instead the
16721 message waits in the queue for the next queue run. Since routing of the message
16722 has taken place, Exim knows to which remote hosts it must be delivered, and so
16723 when the queue run happens, multiple messages for the same host are delivered
16724 over a single SMTP connection. The &%-odqs%& command line option causes all
16725 SMTP deliveries to be queued in this way, and is equivalent to setting
16726 &%queue_smtp_domains%& to &"*"&. See also &%hold_domains%& and
16727 &%queue_domains%&.
16728
16729
16730 .option receive_timeout main time 0s
16731 .cindex "timeout" "for non-SMTP input"
16732 This option sets the timeout for accepting a non-SMTP message, that is, the
16733 maximum time that Exim waits when reading a message on the standard input. If
16734 the value is zero, it will wait forever. This setting is overridden by the
16735 &%-or%& command line option. The timeout for incoming SMTP messages is
16736 controlled by &%smtp_receive_timeout%&.
16737
16738 .option received_header_text main string&!! "see below"
16739 .cindex "customizing" "&'Received:'& header"
16740 .cindex "&'Received:'& header line" "customizing"
16741 This string defines the contents of the &'Received:'& message header that is
16742 added to each message, except for the timestamp, which is automatically added
16743 on at the end (preceded by a semicolon). The string is expanded each time it is
16744 used. If the expansion yields an empty string, no &'Received:'& header line is
16745 added to the message. Otherwise, the string should start with the text
16746 &"Received:"& and conform to the RFC 2822 specification for &'Received:'&
16747 header lines.
16748 .new
16749 The default setting is:
16750
16751 .code
16752 received_header_text = Received: \
16753   ${if def:sender_rcvhost {from $sender_rcvhost\n\t}\
16754     {${if def:sender_ident \
16755       {from ${quote_local_part:$sender_ident} }}\
16756         ${if def:sender_helo_name {(helo=$sender_helo_name)\n\t}}}}\
16757   by $primary_hostname \
16758   ${if def:received_protocol {with $received_protocol }}\
16759   ${if def:tls_in_cipher_std { tls $tls_in_cipher_std\n\t}}\
16760   (Exim $version_number)\n\t\
16761   ${if def:sender_address \
16762   {(envelope-from <$sender_address>)\n\t}}\
16763   id $message_exim_id\
16764   ${if def:received_for {\n\tfor $received_for}}
16765 .endd
16766 .wen
16767
16768 The reference to the TLS cipher is omitted when Exim is built without TLS
16769 support. The use of conditional expansions ensures that this works for both
16770 locally generated messages and messages received from remote hosts, giving
16771 header lines such as the following:
16772 .code
16773 Received: from scrooge.carol.example ([192.168.12.25] ident=root)
16774 by marley.carol.example with esmtp (Exim 4.00)
16775 (envelope-from <bob@carol.example>)
16776 id 16IOWa-00019l-00
16777 for chas@dickens.example; Tue, 25 Dec 2001 14:43:44 +0000
16778 Received: by scrooge.carol.example with local (Exim 4.00)
16779 id 16IOWW-000083-00; Tue, 25 Dec 2001 14:43:41 +0000
16780 .endd
16781 Until the body of the message has been received, the timestamp is the time when
16782 the message started to be received. Once the body has arrived, and all policy
16783 checks have taken place, the timestamp is updated to the time at which the
16784 message was accepted.
16785
16786
16787 .option received_headers_max main integer 30
16788 .cindex "loop" "prevention"
16789 .cindex "mail loop prevention"
16790 .cindex "&'Received:'& header line" "counting"
16791 When a message is to be delivered, the number of &'Received:'& headers is
16792 counted, and if it is greater than this parameter, a mail loop is assumed to
16793 have occurred, the delivery is abandoned, and an error message is generated.
16794 This applies to both local and remote deliveries.
16795
16796
16797 .option recipient_unqualified_hosts main "host list&!!" unset
16798 .cindex "unqualified addresses"
16799 .cindex "host" "unqualified addresses from"
16800 This option lists those hosts from which Exim is prepared to accept unqualified
16801 recipient addresses in message envelopes. The addresses are made fully
16802 qualified by the addition of the &%qualify_recipient%& value. This option also
16803 affects message header lines. Exim does not reject unqualified recipient
16804 addresses in headers, but it qualifies them only if the message came from a
16805 host that matches &%recipient_unqualified_hosts%&,
16806 or if the message was submitted locally (not using TCP/IP), and the &%-bnq%&
16807 option was not set.
16808
16809
16810 .option recipients_max main integer 0
16811 .cindex "limit" "number of recipients"
16812 .cindex "recipient" "maximum number"
16813 If this option is set greater than zero, it specifies the maximum number of
16814 original recipients for any message. Additional recipients that are generated
16815 by aliasing or forwarding do not count. SMTP messages get a 452 response for
16816 all recipients over the limit; earlier recipients are delivered as normal.
16817 Non-SMTP messages with too many recipients are failed, and no deliveries are
16818 done.
16819
16820 .cindex "RCPT" "maximum number of incoming"
16821 &*Note*&: The RFCs specify that an SMTP server should accept at least 100
16822 RCPT commands in a single message.
16823
16824
16825 .option recipients_max_reject main boolean false
16826 If this option is set true, Exim rejects SMTP messages containing too many
16827 recipients by giving 552 errors to the surplus RCPT commands, and a 554
16828 error to the eventual DATA command. Otherwise (the default) it gives a 452
16829 error to the surplus RCPT commands and accepts the message on behalf of the
16830 initial set of recipients. The remote server should then re-send the message
16831 for the remaining recipients at a later time.
16832
16833
16834 .option remote_max_parallel main integer 2
16835 .cindex "delivery" "parallelism for remote"
16836 This option controls parallel delivery of one message to a number of remote
16837 hosts. If the value is less than 2, parallel delivery is disabled, and Exim
16838 does all the remote deliveries for a message one by one. Otherwise, if a single
16839 message has to be delivered to more than one remote host, or if several copies
16840 have to be sent to the same remote host, up to &%remote_max_parallel%&
16841 deliveries are done simultaneously. If more than &%remote_max_parallel%&
16842 deliveries are required, the maximum number of processes are started, and as
16843 each one finishes, another is begun. The order of starting processes is the
16844 same as if sequential delivery were being done, and can be controlled by the
16845 &%remote_sort_domains%& option. If parallel delivery takes place while running
16846 with debugging turned on, the debugging output from each delivery process is
16847 tagged with its process id.
16848
16849 This option controls only the maximum number of parallel deliveries for one
16850 message in one Exim delivery process. Because Exim has no central queue
16851 manager, there is no way of controlling the total number of simultaneous
16852 deliveries if the configuration allows a delivery attempt as soon as a message
16853 is received.
16854
16855 .cindex "number of deliveries"
16856 .cindex "delivery" "maximum number of"
16857 If you want to control the total number of deliveries on the system, you
16858 need to set the &%queue_only%& option. This ensures that all incoming messages
16859 are added to the queue without starting a delivery process. Then set up an Exim
16860 daemon to start queue runner processes at appropriate intervals (probably
16861 fairly often, for example, every minute), and limit the total number of queue
16862 runners by setting the &%queue_run_max%& parameter. Because each queue runner
16863 delivers only one message at a time, the maximum number of deliveries that can
16864 then take place at once is &%queue_run_max%& multiplied by
16865 &%remote_max_parallel%&.
16866
16867 If it is purely remote deliveries you want to control, use
16868 &%queue_smtp_domains%& instead of &%queue_only%&. This has the added benefit of
16869 doing the SMTP routing before queueing, so that several messages for the same
16870 host will eventually get delivered down the same connection.
16871
16872
16873 .option remote_sort_domains main "domain list&!!" unset
16874 .cindex "sorting remote deliveries"
16875 .cindex "delivery" "sorting remote"
16876 When there are a number of remote deliveries for a message, they are sorted by
16877 domain into the order given by this list. For example,
16878 .code
16879 remote_sort_domains = *.cam.ac.uk:*.uk
16880 .endd
16881 would attempt to deliver to all addresses in the &'cam.ac.uk'& domain first,
16882 then to those in the &%uk%& domain, then to any others.
16883
16884
16885 .option retry_data_expire main time 7d
16886 .cindex "hints database" "data expiry"
16887 This option sets a &"use before"& time on retry information in Exim's hints
16888 database. Any older retry data is ignored. This means that, for example, once a
16889 host has not been tried for 7 days, Exim behaves as if it has no knowledge of
16890 past failures.
16891
16892
16893 .option retry_interval_max main time 24h
16894 .cindex "retry" "limit on interval"
16895 .cindex "limit" "on retry interval"
16896 Chapter &<<CHAPretry>>& describes Exim's mechanisms for controlling the
16897 intervals between delivery attempts for messages that cannot be delivered
16898 straight away. This option sets an overall limit to the length of time between
16899 retries. It cannot be set greater than 24 hours; any attempt to do so forces
16900 the default value.
16901
16902
16903 .option return_path_remove main boolean true
16904 .cindex "&'Return-path:'& header line" "removing"
16905 RFC 2821, section 4.4, states that an SMTP server must insert a
16906 &'Return-path:'& header line into a message when it makes a &"final delivery"&.
16907 The &'Return-path:'& header preserves the sender address as received in the
16908 MAIL command. This description implies that this header should not be present
16909 in an incoming message. If &%return_path_remove%& is true, any existing
16910 &'Return-path:'& headers are removed from messages at the time they are
16911 received. Exim's transports have options for adding &'Return-path:'& headers at
16912 the time of delivery. They are normally used only for final local deliveries.
16913
16914
16915 .option return_size_limit main integer 100K
16916 This option is an obsolete synonym for &%bounce_return_size_limit%&.
16917
16918
16919 .option rfc1413_hosts main "host list&!!" @[]
16920 .cindex "RFC 1413"
16921 .cindex "host" "for RFC 1413 calls"
16922 RFC 1413 identification calls are made to any client host which matches
16923 an item in the list.
16924 The default value specifies just this host, being any local interface
16925 for the system.
16926
16927 .option rfc1413_query_timeout main time 0s
16928 .cindex "RFC 1413" "query timeout"
16929 .cindex "timeout" "for RFC 1413 call"
16930 This sets the timeout on RFC 1413 identification calls. If it is set to zero,
16931 no RFC 1413 calls are ever made.
16932
16933
16934 .option sender_unqualified_hosts main "host list&!!" unset
16935 .cindex "unqualified addresses"
16936 .cindex "host" "unqualified addresses from"
16937 This option lists those hosts from which Exim is prepared to accept unqualified
16938 sender addresses. The addresses are made fully qualified by the addition of
16939 &%qualify_domain%&. This option also affects message header lines. Exim does
16940 not reject unqualified addresses in headers that contain sender addresses, but
16941 it qualifies them only if the message came from a host that matches
16942 &%sender_unqualified_hosts%&, or if the message was submitted locally (not
16943 using TCP/IP), and the &%-bnq%& option was not set.
16944
16945 .option add_environment main "string list" empty
16946 .cindex "environment"
16947 This option allows to add individual environment variables that the
16948 currently linked libraries and programs in child processes use. The
16949 default list is empty.
16950
16951
16952 .option slow_lookup_log main integer 0
16953 .cindex "logging" "slow lookups"
16954 .cindex "dns" "logging slow lookups"
16955 This option controls logging of slow lookups.
16956 If the value is nonzero it is taken as a number of milliseconds
16957 and lookups taking longer than this are logged.
16958 Currently this applies only to DNS lookups.
16959
16960
16961
16962 .option smtp_accept_keepalive main boolean true
16963 .cindex "keepalive" "on incoming connection"
16964 This option controls the setting of the SO_KEEPALIVE option on incoming
16965 TCP/IP socket connections. When set, it causes the kernel to probe idle
16966 connections periodically, by sending packets with &"old"& sequence numbers. The
16967 other end of the connection should send an acknowledgment if the connection is
16968 still okay or a reset if the connection has been aborted. The reason for doing
16969 this is that it has the beneficial effect of freeing up certain types of
16970 connection that can get stuck when the remote host is disconnected without
16971 tidying up the TCP/IP call properly. The keepalive mechanism takes several
16972 hours to detect unreachable hosts.
16973
16974
16975
16976 .option smtp_accept_max main integer 20
16977 .cindex "limit" "incoming SMTP connections"
16978 .cindex "SMTP" "incoming connection count"
16979 .cindex "inetd"
16980 This option specifies the maximum number of simultaneous incoming SMTP calls
16981 that Exim will accept. It applies only to the listening daemon; there is no
16982 control (in Exim) when incoming SMTP is being handled by &'inetd'&. If the
16983 value is set to zero, no limit is applied. However, it is required to be
16984 non-zero if either &%smtp_accept_max_per_host%& or &%smtp_accept_queue%& is
16985 set. See also &%smtp_accept_reserve%& and &%smtp_load_reserve%&.
16986
16987 A new SMTP connection is immediately rejected if the &%smtp_accept_max%& limit
16988 has been reached. If not, Exim first checks &%smtp_accept_max_per_host%&. If
16989 that limit has not been reached for the client host, &%smtp_accept_reserve%&
16990 and &%smtp_load_reserve%& are then checked before accepting the connection.
16991
16992
16993 .option smtp_accept_max_nonmail main integer 10
16994 .cindex "limit" "non-mail SMTP commands"
16995 .cindex "SMTP" "limiting non-mail commands"
16996 Exim counts the number of &"non-mail"& commands in an SMTP session, and drops
16997 the connection if there are too many. This option defines &"too many"&. The
16998 check catches some denial-of-service attacks, repeated failing AUTHs, or a mad
16999 client looping sending EHLO, for example. The check is applied only if the
17000 client host matches &%smtp_accept_max_nonmail_hosts%&.
17001
17002 When a new message is expected, one occurrence of RSET is not counted. This
17003 allows a client to send one RSET between messages (this is not necessary,
17004 but some clients do it). Exim also allows one uncounted occurrence of HELO
17005 or EHLO, and one occurrence of STARTTLS between messages. After
17006 starting up a TLS session, another EHLO is expected, and so it too is not
17007 counted. The first occurrence of AUTH in a connection, or immediately
17008 following STARTTLS is not counted. Otherwise, all commands other than
17009 MAIL, RCPT, DATA, and QUIT are counted.
17010
17011
17012 .option smtp_accept_max_nonmail_hosts main "host list&!!" *
17013 You can control which hosts are subject to the &%smtp_accept_max_nonmail%&
17014 check by setting this option. The default value makes it apply to all hosts. By
17015 changing the value, you can exclude any badly-behaved hosts that you have to
17016 live with.
17017
17018
17019 . Allow this long option name to split; give it unsplit as a fifth argument
17020 . for the automatic .oindex that is generated by .option.
17021 . We insert " &~&~" which is both pretty nasty visually and results in
17022 . non-searchable text.  HowItWorks.txt mentions an option for inserting
17023 . zero-width-space, which would be nicer visually and results in (at least)
17024 . html that Firefox will split on when it's forced to reflow (rather than
17025 . inserting a horizontal scrollbar).  However, the text is still not
17026 . searchable.  NM changed this occurrence for bug 1197 to no longer allow
17027 . the option name to split.
17028
17029 .option "smtp_accept_max_per_connection" main integer 1000 &&&
17030          smtp_accept_max_per_connection
17031 .cindex "SMTP" "limiting incoming message count"
17032 .cindex "limit" "messages per SMTP connection"
17033 The value of this option limits the number of MAIL commands that Exim is
17034 prepared to accept over a single SMTP connection, whether or not each command
17035 results in the transfer of a message. After the limit is reached, a 421
17036 response is given to subsequent MAIL commands. This limit is a safety
17037 precaution against a client that goes mad (incidents of this type have been
17038 seen).
17039
17040
17041 .option smtp_accept_max_per_host main string&!! unset
17042 .cindex "limit" "SMTP connections from one host"
17043 .cindex "host" "limiting SMTP connections from"
17044 This option restricts the number of simultaneous IP connections from a single
17045 host (strictly, from a single IP address) to the Exim daemon. The option is
17046 expanded, to enable different limits to be applied to different hosts by
17047 reference to &$sender_host_address$&. Once the limit is reached, additional
17048 connection attempts from the same host are rejected with error code 421. This
17049 is entirely independent of &%smtp_accept_reserve%&. The option's default value
17050 of zero imposes no limit. If this option is set greater than zero, it is
17051 required that &%smtp_accept_max%& be non-zero.
17052
17053 &*Warning*&: When setting this option you should not use any expansion
17054 constructions that take an appreciable amount of time. The expansion and test
17055 happen in the main daemon loop, in order to reject additional connections
17056 without forking additional processes (otherwise a denial-of-service attack
17057 could cause a vast number or processes to be created). While the daemon is
17058 doing this processing, it cannot accept any other incoming connections.
17059
17060
17061
17062 .option smtp_accept_queue main integer 0
17063 .cindex "SMTP" "incoming connection count"
17064 .cindex "queueing incoming messages"
17065 .cindex "message" "queueing by SMTP connection count"
17066 If the number of simultaneous incoming SMTP connections being handled via the
17067 listening daemon exceeds this value, messages received by SMTP are just placed
17068 in the queue; no delivery processes are started automatically. The count is
17069 fixed at the start of an SMTP connection. It cannot be updated in the
17070 subprocess that receives messages, and so the queueing or not queueing applies
17071 to all messages received in the same connection.
17072
17073 A value of zero implies no limit, and clearly any non-zero value is useful only
17074 if it is less than the &%smtp_accept_max%& value (unless that is zero). See
17075 also &%queue_only%&, &%queue_only_load%&, &%queue_smtp_domains%&, and the
17076 various &%-od%&&'x'& command line options.
17077
17078
17079 . See the comment on smtp_accept_max_per_connection
17080
17081 .option "smtp_accept_queue_per_connection" main integer 10 &&&
17082          smtp_accept_queue_per_connection
17083 .cindex "queueing incoming messages"
17084 .cindex "message" "queueing by message count"
17085 This option limits the number of delivery processes that Exim starts
17086 automatically when receiving messages via SMTP, whether via the daemon or by
17087 the use of &%-bs%& or &%-bS%&. If the value of the option is greater than zero,
17088 and the number of messages received in a single SMTP session exceeds this
17089 number, subsequent messages are placed in the queue, but no delivery processes
17090 are started. This helps to limit the number of Exim processes when a server
17091 restarts after downtime and there is a lot of mail waiting for it on other
17092 systems. On large systems, the default should probably be increased, and on
17093 dial-in client systems it should probably be set to zero (that is, disabled).
17094
17095
17096 .option smtp_accept_reserve main integer 0
17097 .cindex "SMTP" "incoming call count"
17098 .cindex "host" "reserved"
17099 When &%smtp_accept_max%& is set greater than zero, this option specifies a
17100 number of SMTP connections that are reserved for connections from the hosts
17101 that are specified in &%smtp_reserve_hosts%&. The value set in
17102 &%smtp_accept_max%& includes this reserve pool. The specified hosts are not
17103 restricted to this number of connections; the option specifies a minimum number
17104 of connection slots for them, not a maximum. It is a guarantee that this group
17105 of hosts can always get at least &%smtp_accept_reserve%& connections. However,
17106 the limit specified by &%smtp_accept_max_per_host%& is still applied to each
17107 individual host.
17108
17109 For example, if &%smtp_accept_max%& is set to 50 and &%smtp_accept_reserve%& is
17110 set to 5, once there are 45 active connections (from any hosts), new
17111 connections are accepted only from hosts listed in &%smtp_reserve_hosts%&,
17112 provided the other criteria for acceptance are met.
17113
17114
17115 .option smtp_active_hostname main string&!! unset
17116 .cindex "host" "name in SMTP responses"
17117 .cindex "SMTP" "host name in responses"
17118 .vindex "&$primary_hostname$&"
17119 This option is provided for multi-homed servers that want to masquerade as
17120 several different hosts. At the start of an incoming SMTP connection, its value
17121 is expanded and used instead of the value of &$primary_hostname$& in SMTP
17122 responses. For example, it is used as domain name in the response to an
17123 incoming HELO or EHLO command.
17124
17125 .vindex "&$smtp_active_hostname$&"
17126 The active hostname is placed in the &$smtp_active_hostname$& variable, which
17127 is saved with any messages that are received. It is therefore available for use
17128 in routers and transports when the message is later delivered.
17129
17130 If this option is unset, or if its expansion is forced to fail, or if the
17131 expansion results in an empty string, the value of &$primary_hostname$& is
17132 used. Other expansion failures cause a message to be written to the main and
17133 panic logs, and the SMTP command receives a temporary error. Typically, the
17134 value of &%smtp_active_hostname%& depends on the incoming interface address.
17135 For example:
17136 .code
17137 smtp_active_hostname = ${if eq{$received_ip_address}{10.0.0.1}\
17138   {cox.mydomain}{box.mydomain}}
17139 .endd
17140
17141 Although &$smtp_active_hostname$& is primarily concerned with incoming
17142 messages, it is also used as the default for HELO commands in callout
17143 verification if there is no remote transport from which to obtain a
17144 &%helo_data%& value.
17145
17146 .option smtp_banner main string&!! "see below"
17147 .cindex "SMTP" "welcome banner"
17148 .cindex "banner for SMTP"
17149 .cindex "welcome banner for SMTP"
17150 .cindex "customizing" "SMTP banner"
17151 This string, which is expanded every time it is used, is output as the initial
17152 positive response to an SMTP connection. The default setting is:
17153 .code
17154 smtp_banner = $smtp_active_hostname ESMTP Exim \
17155   $version_number $tod_full
17156 .endd
17157 Failure to expand the string causes a panic error. If you want to create a
17158 multiline response to the initial SMTP connection, use &"\n"& in the string at
17159 appropriate points, but not at the end. Note that the 220 code is not included
17160 in this string. Exim adds it automatically (several times in the case of a
17161 multiline response).
17162
17163
17164 .option smtp_check_spool_space main boolean true
17165 .cindex "checking disk space"
17166 .cindex "disk space, checking"
17167 .cindex "spool directory" "checking space"
17168 When this option is set, if an incoming SMTP session encounters the SIZE
17169 option on a MAIL command, it checks that there is enough space in the
17170 spool directory's partition to accept a message of that size, while still
17171 leaving free the amount specified by &%check_spool_space%& (even if that value
17172 is zero). If there isn't enough space, a temporary error code is returned.
17173
17174
17175 .option smtp_connect_backlog main integer 20
17176 .cindex "connection backlog"
17177 .cindex "SMTP" "connection backlog"
17178 .cindex "backlog of connections"
17179 This option specifies a maximum number of waiting SMTP connections. Exim passes
17180 this value to the TCP/IP system when it sets up its listener. Once this number
17181 of connections are waiting for the daemon's attention, subsequent connection
17182 attempts are refused at the TCP/IP level. At least, that is what the manuals
17183 say; in some circumstances such connection attempts have been observed to time
17184 out instead. For large systems it is probably a good idea to increase the
17185 value (to 50, say). It also gives some protection against denial-of-service
17186 attacks by SYN flooding.
17187
17188
17189 .option smtp_enforce_sync main boolean true
17190 .cindex "SMTP" "synchronization checking"
17191 .cindex "synchronization checking in SMTP"
17192 The SMTP protocol specification requires the client to wait for a response from
17193 the server at certain points in the dialogue. Without PIPELINING these
17194 synchronization points are after every command; with PIPELINING they are
17195 fewer, but they still exist.
17196
17197 Some spamming sites send out a complete set of SMTP commands without waiting
17198 for any response. Exim protects against this by rejecting a message if the
17199 client has sent further input when it should not have. The error response &"554
17200 SMTP synchronization error"& is sent, and the connection is dropped. Testing
17201 for this error cannot be perfect because of transmission delays (unexpected
17202 input may be on its way but not yet received when Exim checks). However, it
17203 does detect many instances.
17204
17205 The check can be globally disabled by setting &%smtp_enforce_sync%& false.
17206 If you want to disable the check selectively (for example, only for certain
17207 hosts), you can do so by an appropriate use of a &%control%& modifier in an ACL
17208 (see section &<<SECTcontrols>>&). See also &%pipelining_advertise_hosts%&.
17209
17210
17211
17212 .option smtp_etrn_command main string&!! unset
17213 .cindex "ETRN" "command to be run"
17214 .vindex "&$domain$&"
17215 If this option is set, the given command is run whenever an SMTP ETRN
17216 command is received from a host that is permitted to issue such commands (see
17217 chapter &<<CHAPACL>>&). The string is split up into separate arguments which
17218 are independently expanded. The expansion variable &$domain$& is set to the
17219 argument of the ETRN command, and no syntax checking is done on it. For
17220 example:
17221 .code
17222 smtp_etrn_command = /etc/etrn_command $domain \
17223                     $sender_host_address
17224 .endd
17225 A new process is created to run the command, but Exim does not wait for it to
17226 complete. Consequently, its status cannot be checked. If the command cannot be
17227 run, a line is written to the panic log, but the ETRN caller still receives
17228 a 250 success response. Exim is normally running under its own uid when
17229 receiving SMTP, so it is not possible for it to change the uid before running
17230 the command.
17231
17232
17233 .option smtp_etrn_serialize main boolean true
17234 .cindex "ETRN" "serializing"
17235 When this option is set, it prevents the simultaneous execution of more than
17236 one identical command as a result of ETRN in an SMTP connection. See
17237 section &<<SECTETRN>>& for details.
17238
17239
17240 .option smtp_load_reserve main fixed-point unset
17241 .cindex "load average"
17242 If the system load average ever gets higher than this, incoming SMTP calls are
17243 accepted only from those hosts that match an entry in &%smtp_reserve_hosts%&.
17244 If &%smtp_reserve_hosts%& is not set, no incoming SMTP calls are accepted when
17245 the load is over the limit. The option has no effect on ancient operating
17246 systems on which Exim cannot determine the load average. See also
17247 &%deliver_queue_load_max%& and &%queue_only_load%&.
17248
17249
17250
17251 .option smtp_max_synprot_errors main integer 3
17252 .cindex "SMTP" "limiting syntax and protocol errors"
17253 .cindex "limit" "SMTP syntax and protocol errors"
17254 Exim rejects SMTP commands that contain syntax or protocol errors. In
17255 particular, a syntactically invalid email address, as in this command:
17256 .code
17257 RCPT TO:<abc xyz@a.b.c>
17258 .endd
17259 causes immediate rejection of the command, before any other tests are done.
17260 (The ACL cannot be run if there is no valid address to set up for it.) An
17261 example of a protocol error is receiving RCPT before MAIL. If there are
17262 too many syntax or protocol errors in one SMTP session, the connection is
17263 dropped. The limit is set by this option.
17264
17265 .cindex "PIPELINING" "expected errors"
17266 When the PIPELINING extension to SMTP is in use, some protocol errors are
17267 &"expected"&, for instance, a RCPT command after a rejected MAIL command.
17268 Exim assumes that PIPELINING will be used if it advertises it (see
17269 &%pipelining_advertise_hosts%&), and in this situation, &"expected"& errors do
17270 not count towards the limit.
17271
17272
17273
17274 .option smtp_max_unknown_commands main integer 3
17275 .cindex "SMTP" "limiting unknown commands"
17276 .cindex "limit" "unknown SMTP commands"
17277 If there are too many unrecognized commands in an incoming SMTP session, an
17278 Exim server drops the connection. This is a defence against some kinds of abuse
17279 that subvert web
17280 clients
17281 into making connections to SMTP ports; in these circumstances, a number of
17282 non-SMTP command lines are sent first.
17283
17284
17285
17286 .option smtp_ratelimit_hosts main "host list&!!" unset
17287 .cindex "SMTP" "rate limiting"
17288 .cindex "limit" "rate of message arrival"
17289 .cindex "RCPT" "rate limiting"
17290 Some sites find it helpful to be able to limit the rate at which certain hosts
17291 can send them messages, and the rate at which an individual message can specify
17292 recipients.
17293
17294 Exim has two rate-limiting facilities. This section describes the older
17295 facility, which can limit rates within a single connection. The newer
17296 &%ratelimit%& ACL condition can limit rates across all connections. See section
17297 &<<SECTratelimiting>>& for details of the newer facility.
17298
17299 When a host matches &%smtp_ratelimit_hosts%&, the values of
17300 &%smtp_ratelimit_mail%& and &%smtp_ratelimit_rcpt%& are used to control the
17301 rate of acceptance of MAIL and RCPT commands in a single SMTP session,
17302 respectively. Each option, if set, must contain a set of four comma-separated
17303 values:
17304
17305 .ilist
17306 A threshold, before which there is no rate limiting.
17307 .next
17308 An initial time delay. Unlike other times in Exim, numbers with decimal
17309 fractional parts are allowed here.
17310 .next
17311 A factor by which to increase the delay each time.
17312 .next
17313 A maximum value for the delay. This should normally be less than 5 minutes,
17314 because after that time, the client is liable to timeout the SMTP command.
17315 .endlist
17316
17317 For example, these settings have been used successfully at the site which
17318 first suggested this feature, for controlling mail from their customers:
17319 .code
17320 smtp_ratelimit_mail = 2,0.5s,1.05,4m
17321 smtp_ratelimit_rcpt = 4,0.25s,1.015,4m
17322 .endd
17323 The first setting specifies delays that are applied to MAIL commands after
17324 two have been received over a single connection. The initial delay is 0.5
17325 seconds, increasing by a factor of 1.05 each time. The second setting applies
17326 delays to RCPT commands when more than four occur in a single message.
17327
17328
17329 .option smtp_ratelimit_mail main string unset
17330 See &%smtp_ratelimit_hosts%& above.
17331
17332
17333 .option smtp_ratelimit_rcpt main string unset
17334 See &%smtp_ratelimit_hosts%& above.
17335
17336
17337 .option smtp_receive_timeout main time&!! 5m
17338 .cindex "timeout" "for SMTP input"
17339 .cindex "SMTP" "input timeout"
17340 This sets a timeout value for SMTP reception. It applies to all forms of SMTP
17341 input, including batch SMTP. If a line of input (either an SMTP command or a
17342 data line) is not received within this time, the SMTP connection is dropped and
17343 the message is abandoned.
17344 A line is written to the log containing one of the following messages:
17345 .code
17346 SMTP command timeout on connection from...
17347 SMTP data timeout on connection from...
17348 .endd
17349 The former means that Exim was expecting to read an SMTP command; the latter
17350 means that it was in the DATA phase, reading the contents of a message.
17351
17352 If the first character of the option is a &"$"& the option is
17353 expanded before use and may depend on
17354 &$sender_host_name$&, &$sender_host_address$& and &$sender_host_port$&.
17355
17356
17357 .oindex "&%-os%&"
17358 The value set by this option can be overridden by the
17359 &%-os%& command-line option. A setting of zero time disables the timeout, but
17360 this should never be used for SMTP over TCP/IP. (It can be useful in some cases
17361 of local input using &%-bs%& or &%-bS%&.) For non-SMTP input, the reception
17362 timeout is controlled by &%receive_timeout%& and &%-or%&.
17363
17364
17365 .option smtp_reserve_hosts main "host list&!!" unset
17366 This option defines hosts for which SMTP connections are reserved; see
17367 &%smtp_accept_reserve%& and &%smtp_load_reserve%& above.
17368
17369
17370 .option smtp_return_error_details main boolean false
17371 .cindex "SMTP" "details policy failures"
17372 .cindex "policy control" "rejection, returning details"
17373 In the default state, Exim uses bland messages such as
17374 &"Administrative prohibition"& when it rejects SMTP commands for policy
17375 reasons. Many sysadmins like this because it gives away little information
17376 to spammers. However, some other sysadmins who are applying strict checking
17377 policies want to give out much fuller information about failures. Setting
17378 &%smtp_return_error_details%& true causes Exim to be more forthcoming. For
17379 example, instead of &"Administrative prohibition"&, it might give:
17380 .code
17381 550-Rejected after DATA: '>' missing at end of address:
17382 550 failing address in "From" header is: <user@dom.ain
17383 .endd
17384
17385
17386 .option smtputf8_advertise_hosts main "host list&!!" *
17387 .cindex "SMTPUTF8" "advertising"
17388 When Exim is built with support for internationalised mail names,
17389 the availability thereof is advertised in
17390 response to EHLO only to those client hosts that match this option. See
17391 chapter &<<CHAPi18n>>& for details of Exim's support for internationalisation.
17392
17393
17394 .option spamd_address main string "127.0.0.1 783"
17395 This option is available when Exim is compiled with the content-scanning
17396 extension. It specifies how Exim connects to SpamAssassin's &%spamd%& daemon.
17397 See section &<<SECTscanspamass>>& for more details.
17398
17399
17400
17401 .option spf_guess main string "v=spf1 a/24 mx/24 ptr ?all"
17402 This option is available when Exim is compiled with SPF support.
17403 See section &<<SECSPF>>& for more details.
17404
17405
17406
17407 .option split_spool_directory main boolean false
17408 .cindex "multiple spool directories"
17409 .cindex "spool directory" "split"
17410 .cindex "directories, multiple"
17411 If this option is set, it causes Exim to split its input directory into 62
17412 subdirectories, each with a single alphanumeric character as its name. The
17413 sixth character of the message id is used to allocate messages to
17414 subdirectories; this is the least significant base-62 digit of the time of
17415 arrival of the message.
17416
17417 Splitting up the spool in this way may provide better performance on systems
17418 where there are long mail queues, by reducing the number of files in any one
17419 directory. The msglog directory is also split up in a similar way to the input
17420 directory; however, if &%preserve_message_logs%& is set, all old msglog files
17421 are still placed in the single directory &_msglog.OLD_&.
17422
17423 It is not necessary to take any special action for existing messages when
17424 changing &%split_spool_directory%&. Exim notices messages that are in the
17425 &"wrong"& place, and continues to process them. If the option is turned off
17426 after a period of being on, the subdirectories will eventually empty and be
17427 automatically deleted.
17428
17429 When &%split_spool_directory%& is set, the behaviour of queue runner processes
17430 changes. Instead of creating a list of all messages in the queue, and then
17431 trying to deliver each one, in turn, it constructs a list of those in one
17432 sub-directory and tries to deliver them, before moving on to the next
17433 sub-directory. The sub-directories are processed in a random order. This
17434 spreads out the scanning of the input directories, and uses less memory. It is
17435 particularly beneficial when there are lots of messages in the queue. However,
17436 if &%queue_run_in_order%& is set, none of this new processing happens. The
17437 entire queue has to be scanned and sorted before any deliveries can start.
17438
17439
17440 .option spool_directory main string&!! "set at compile time"
17441 .cindex "spool directory" "path to"
17442 This defines the directory in which Exim keeps its spool, that is, the messages
17443 it is waiting to deliver. The default value is taken from the compile-time
17444 configuration setting, if there is one. If not, this option must be set. The
17445 string is expanded, so it can contain, for example, a reference to
17446 &$primary_hostname$&.
17447
17448 If the spool directory name is fixed on your installation, it is recommended
17449 that you set it at build time rather than from this option, particularly if the
17450 log files are being written to the spool directory (see &%log_file_path%&).
17451 Otherwise log files cannot be used for errors that are detected early on, such
17452 as failures in the configuration file.
17453
17454 By using this option to override the compiled-in path, it is possible to run
17455 tests of Exim without using the standard spool.
17456
17457 .option spool_wireformat main boolean false
17458 .cindex "spool directory" "file formats"
17459 If this option is set, Exim may for some messages use an alternative format
17460 for data-files in the spool which matches the wire format.
17461 Doing this permits more efficient message reception and transmission.
17462 Currently it is only done for messages received using the ESMTP CHUNKING
17463 option.
17464
17465 The following variables will not have useful values:
17466 .code
17467 $max_received_linelength
17468 $body_linecount
17469 $body_zerocount
17470 .endd
17471
17472 Users of the local_scan() API (see &<<CHAPlocalscan>>&),
17473 and any external programs which are passed a reference to a message data file
17474 (except via the &"regex"&, &"malware"& or &"spam"&) ACL conditions)
17475 will need to be aware of the different formats potentially available.
17476
17477 Using any of the ACL conditions noted will negate the reception benefit
17478 (as a Unix-mbox-format file is constructed for them).
17479 The transmission benefit is maintained.
17480
17481 .option sqlite_lock_timeout main time 5s
17482 .cindex "sqlite lookup type" "lock timeout"
17483 This option controls the timeout that the &(sqlite)& lookup uses when trying to
17484 access an SQLite database. See section &<<SECTsqlite>>& for more details.
17485
17486 .option strict_acl_vars main boolean false
17487 .cindex "&ACL;" "variables, handling unset"
17488 This option controls what happens if a syntactically valid but undefined ACL
17489 variable is referenced. If it is false (the default), an empty string
17490 is substituted; if it is true, an error is generated. See section
17491 &<<SECTaclvariables>>& for details of ACL variables.
17492
17493 .option strip_excess_angle_brackets main boolean false
17494 .cindex "angle brackets, excess"
17495 If this option is set, redundant pairs of angle brackets round &"route-addr"&
17496 items in addresses are stripped. For example, &'<<xxx@a.b.c.d>>'& is
17497 treated as &'<xxx@a.b.c.d>'&. If this is in the envelope and the message is
17498 passed on to another MTA, the excess angle brackets are not passed on. If this
17499 option is not set, multiple pairs of angle brackets cause a syntax error.
17500
17501
17502 .option strip_trailing_dot main boolean false
17503 .cindex "trailing dot on domain"
17504 .cindex "dot" "trailing on domain"
17505 If this option is set, a trailing dot at the end of a domain in an address is
17506 ignored. If this is in the envelope and the message is passed on to another
17507 MTA, the dot is not passed on. If this option is not set, a dot at the end of a
17508 domain causes a syntax error.
17509 However, addresses in header lines are checked only when an ACL requests header
17510 syntax checking.
17511
17512
17513 .option syslog_duplication main boolean true
17514 .cindex "syslog" "duplicate log lines; suppressing"
17515 When Exim is logging to syslog, it writes the log lines for its three
17516 separate logs at different syslog priorities so that they can in principle
17517 be separated on the logging hosts. Some installations do not require this
17518 separation, and in those cases, the duplication of certain log lines is a
17519 nuisance. If &%syslog_duplication%& is set false, only one copy of any
17520 particular log line is written to syslog. For lines that normally go to
17521 both the main log and the reject log, the reject log version (possibly
17522 containing message header lines) is written, at LOG_NOTICE priority.
17523 Lines that normally go to both the main and the panic log are written at
17524 the LOG_ALERT priority.
17525
17526
17527 .option syslog_facility main string unset
17528 .cindex "syslog" "facility; setting"
17529 This option sets the syslog &"facility"& name, used when Exim is logging to
17530 syslog. The value must be one of the strings &"mail"&, &"user"&, &"news"&,
17531 &"uucp"&, &"daemon"&, or &"local&'x'&"& where &'x'& is a digit between 0 and 7.
17532 If this option is unset, &"mail"& is used. See chapter &<<CHAPlog>>& for
17533 details of Exim's logging.
17534
17535
17536 .option syslog_pid main boolean true
17537 .cindex "syslog" "pid"
17538 If &%syslog_pid%& is set false, the PID on Exim's log lines are
17539 omitted when these lines are sent to syslog. (Syslog normally prefixes
17540 the log lines with the PID of the logging process automatically.) You need
17541 to enable the &`+pid`& log selector item, if you want Exim to write it's PID
17542 into the logs.) See chapter &<<CHAPlog>>& for details of Exim's logging.
17543
17544
17545
17546 .option syslog_processname main string &`exim`&
17547 .cindex "syslog" "process name; setting"
17548 This option sets the syslog &"ident"& name, used when Exim is logging to
17549 syslog. The value must be no longer than 32 characters. See chapter
17550 &<<CHAPlog>>& for details of Exim's logging.
17551
17552
17553
17554 .option syslog_timestamp main boolean true
17555 .cindex "syslog" "timestamps"
17556 If &%syslog_timestamp%& is set false, the timestamps on Exim's log lines are
17557 omitted when these lines are sent to syslog. See chapter &<<CHAPlog>>& for
17558 details of Exim's logging.
17559
17560
17561 .option system_filter main string&!! unset
17562 .cindex "filter" "system filter"
17563 .cindex "system filter" "specifying"
17564 .cindex "Sieve filter" "not available for system filter"
17565 This option specifies an Exim filter file that is applied to all messages at
17566 the start of each delivery attempt, before any routing is done. System filters
17567 must be Exim filters; they cannot be Sieve filters. If the system filter
17568 generates any deliveries to files or pipes, or any new mail messages, the
17569 appropriate &%system_filter_..._transport%& option(s) must be set, to define
17570 which transports are to be used. Details of this facility are given in chapter
17571 &<<CHAPsystemfilter>>&.
17572 A forced expansion failure results in no filter operation.
17573
17574
17575 .option system_filter_directory_transport main string&!! unset
17576 .vindex "&$address_file$&"
17577 This sets the name of the transport driver that is to be used when the
17578 &%save%& command in a system message filter specifies a path ending in &"/"&,
17579 implying delivery of each message into a separate file in some directory.
17580 During the delivery, the variable &$address_file$& contains the path name.
17581
17582
17583 .option system_filter_file_transport main string&!! unset
17584 .cindex "file" "transport for system filter"
17585 This sets the name of the transport driver that is to be used when the &%save%&
17586 command in a system message filter specifies a path not ending in &"/"&. During
17587 the delivery, the variable &$address_file$& contains the path name.
17588
17589 .option system_filter_group main string unset
17590 .cindex "gid (group id)" "system filter"
17591 This option is used only when &%system_filter_user%& is also set. It sets the
17592 gid under which the system filter is run, overriding any gid that is associated
17593 with the user. The value may be numerical or symbolic.
17594
17595 .option system_filter_pipe_transport main string&!! unset
17596 .cindex "&(pipe)& transport" "for system filter"
17597 .vindex "&$address_pipe$&"
17598 This specifies the transport driver that is to be used when a &%pipe%& command
17599 is used in a system filter. During the delivery, the variable &$address_pipe$&
17600 contains the pipe command.
17601
17602
17603 .option system_filter_reply_transport main string&!! unset
17604 .cindex "&(autoreply)& transport" "for system filter"
17605 This specifies the transport driver that is to be used when a &%mail%& command
17606 is used in a system filter.
17607
17608
17609 .option system_filter_user main string unset
17610 .cindex "uid (user id)" "system filter"
17611 If this option is set to root, the system filter is run in the main Exim
17612 delivery process, as root.  Otherwise, the system filter runs in a separate
17613 process, as the given user, defaulting to the Exim run-time user.
17614 Unless the string consists entirely of digits, it
17615 is looked up in the password data. Failure to find the named user causes a
17616 configuration error. The gid is either taken from the password data, or
17617 specified by &%system_filter_group%&. When the uid is specified numerically,
17618 &%system_filter_group%& is required to be set.
17619
17620 If the system filter generates any pipe, file, or reply deliveries, the uid
17621 under which the filter is run is used when transporting them, unless a
17622 transport option overrides.
17623
17624
17625 .option tcp_nodelay main boolean true
17626 .cindex "daemon" "TCP_NODELAY on sockets"
17627 .cindex "Nagle algorithm"
17628 .cindex "TCP_NODELAY on listening sockets"
17629 If this option is set false, it stops the Exim daemon setting the
17630 TCP_NODELAY option on its listening sockets. Setting TCP_NODELAY
17631 turns off the &"Nagle algorithm"&, which is a way of improving network
17632 performance in interactive (character-by-character) situations. Turning it off
17633 should improve Exim's performance a bit, so that is what happens by default.
17634 However, it appears that some broken clients cannot cope, and time out. Hence
17635 this option. It affects only those sockets that are set up for listening by the
17636 daemon. Sockets created by the smtp transport for delivering mail always set
17637 TCP_NODELAY.
17638
17639
17640 .option timeout_frozen_after main time 0s
17641 .cindex "frozen messages" "timing out"
17642 .cindex "timeout" "frozen messages"
17643 If &%timeout_frozen_after%& is set to a time greater than zero, a frozen
17644 message of any kind that has been in the queue for longer than the given time
17645 is automatically cancelled at the next queue run. If the frozen message is a
17646 bounce message, it is just discarded; otherwise, a bounce is sent to the
17647 sender, in a similar manner to cancellation by the &%-Mg%& command line option.
17648 If you want to timeout frozen bounce messages earlier than other kinds of
17649 frozen message, see &%ignore_bounce_errors_after%&.
17650
17651 &*Note:*& the default value of zero means no timeouts; with this setting,
17652 frozen messages remain in the queue forever (except for any frozen bounce
17653 messages that are released by &%ignore_bounce_errors_after%&).
17654
17655
17656 .option timezone main string unset
17657 .cindex "timezone, setting"
17658 .cindex "environment" "values from"
17659 The value of &%timezone%& is used to set the environment variable TZ while
17660 running Exim (if it is different on entry). This ensures that all timestamps
17661 created by Exim are in the required timezone. If you want all your timestamps
17662 to be in UTC (aka GMT) you should set
17663 .code
17664 timezone = UTC
17665 .endd
17666 The default value is taken from TIMEZONE_DEFAULT in &_Local/Makefile_&,
17667 or, if that is not set, from the value of the TZ environment variable when Exim
17668 is built. If &%timezone%& is set to the empty string, either at build or run
17669 time, any existing TZ variable is removed from the environment when Exim
17670 runs. This is appropriate behaviour for obtaining wall-clock time on some, but
17671 unfortunately not all, operating systems.
17672
17673
17674 .option tls_advertise_hosts main "host list&!!" *
17675 .cindex "TLS" "advertising"
17676 .cindex "encryption" "on SMTP connection"
17677 .cindex "SMTP" "encrypted connection"
17678 When Exim is built with support for TLS encrypted connections, the availability
17679 of the STARTTLS command to set up an encrypted session is advertised in
17680 response to EHLO only to those client hosts that match this option. See
17681 chapter &<<CHAPTLS>>& for details of Exim's support for TLS.
17682 Note that the default value requires that a certificate be supplied
17683 using the &%tls_certificate%& option.  If TLS support for incoming connections
17684 is not required the &%tls_advertise_hosts%& option should be set empty.
17685
17686
17687 .option tls_certificate main string list&!! unset
17688 .cindex "TLS" "server certificate; location of"
17689 .cindex "certificate" "server, location of"
17690 The value of this option is expanded, and must then be a list of absolute paths to
17691 files which contain the server's certificates (in PEM format).
17692 Commonly only one file is needed.
17693 The server's private key is also
17694 assumed to be in this file if &%tls_privatekey%& is unset. See chapter
17695 &<<CHAPTLS>>& for further details.
17696
17697 &*Note*&: The certificates defined by this option are used only when Exim is
17698 receiving incoming messages as a server. If you want to supply certificates for
17699 use when sending messages as a client, you must set the &%tls_certificate%&
17700 option in the relevant &(smtp)& transport.
17701
17702 &*Note*&: If you use filenames based on IP addresses, change the list
17703 separator in the usual way (&<<SECTlistsepchange>>&) to avoid confusion under IPv6.
17704
17705 &*Note*&: Under versions of OpenSSL preceding 1.1.1,
17706 when a list of more than one
17707 file is used, the &$tls_in_ourcert$& variable is unreliable.
17708 .new
17709 The macro "_TLS_BAD_MULTICERT_IN_OURCERT" will be defined for those versions.
17710 .wen
17711
17712 If the option contains &$tls_out_sni$& and Exim is built against OpenSSL, then
17713 if the OpenSSL build supports TLS extensions and the TLS client sends the
17714 Server Name Indication extension, then this option and others documented in
17715 &<<SECTtlssni>>& will be re-expanded.
17716
17717 If this option is unset or empty a fresh self-signed certificate will be
17718 generated for every connection.
17719
17720 .option tls_crl main string&!! unset
17721 .cindex "TLS" "server certificate revocation list"
17722 .cindex "certificate" "revocation list for server"
17723 This option specifies a certificate revocation list. The expanded value must
17724 be the name of a file that contains CRLs in PEM format.
17725
17726 Under OpenSSL the option can specify a directory with CRL files.
17727
17728 &*Note:*& Under OpenSSL the option must, if given, supply a CRL
17729 for each signing element of the certificate chain (i.e. all but the leaf).
17730 For the file variant this can be multiple PEM blocks in the one file.
17731
17732 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
17733
17734
17735 .option tls_dh_max_bits main integer 2236
17736 .cindex "TLS" "D-H bit count"
17737 The number of bits used for Diffie-Hellman key-exchange may be suggested by
17738 the chosen TLS library.  That value might prove to be too high for
17739 interoperability.  This option provides a maximum clamp on the value
17740 suggested, trading off security for interoperability.
17741
17742 The value must be at least 1024.
17743
17744 The value 2236 was chosen because, at time of adding the option, it was the
17745 hard-coded maximum value supported by the NSS cryptographic library, as used
17746 by Thunderbird, while GnuTLS was suggesting 2432 bits as normal.
17747
17748 If you prefer more security and are willing to break some clients, raise this
17749 number.
17750
17751 Note that the value passed to GnuTLS for *generating* a new prime may be a
17752 little less than this figure, because GnuTLS is inexact and may produce a
17753 larger prime than requested.
17754
17755
17756 .option tls_dhparam main string&!! unset
17757 .cindex "TLS" "D-H parameters for server"
17758 The value of this option is expanded and indicates the source of DH parameters
17759 to be used by Exim.
17760
17761 .new
17762 This option is ignored for GnuTLS version 3.6.0 and later.
17763 The library manages parameter negotiation internally.
17764 .wen
17765
17766 &*Note: The Exim Maintainers strongly recommend,
17767 for other TLS library versions,
17768 using a filename with site-generated
17769 local DH parameters*&, which has been supported across all versions of Exim.  The
17770 other specific constants available are a fallback so that even when
17771 "unconfigured", Exim can offer Perfect Forward Secrecy in older ciphersuites in TLS.
17772
17773 If &%tls_dhparam%& is a filename starting with a &`/`&,
17774 then it names a file from which DH
17775 parameters should be loaded.  If the file exists, it should hold a PEM-encoded
17776 PKCS#3 representation of the DH prime.  If the file does not exist, for
17777 OpenSSL it is an error.  For GnuTLS, Exim will attempt to create the file and
17778 fill it with a generated DH prime.  For OpenSSL, if the DH bit-count from
17779 loading the file is greater than &%tls_dh_max_bits%& then it will be ignored,
17780 and treated as though the &%tls_dhparam%& were set to "none".
17781
17782 If this option expands to the string "none", then no DH parameters will be
17783 loaded by Exim.
17784
17785 If this option expands to the string "historic" and Exim is using GnuTLS, then
17786 Exim will attempt to load a file from inside the spool directory.  If the file
17787 does not exist, Exim will attempt to create it.
17788 See section &<<SECTgnutlsparam>>& for further details.
17789
17790 If Exim is using OpenSSL and this option is empty or unset, then Exim will load
17791 a default DH prime; the default is Exim-specific but lacks verifiable provenance.
17792
17793 In older versions of Exim the default was the 2048 bit prime described in section
17794 2.2 of RFC 5114, "2048-bit MODP Group with 224-bit Prime Order Subgroup", which
17795 in IKE is assigned number 23.
17796
17797 Otherwise, the option must expand to the name used by Exim for any of a number
17798 of DH primes specified in RFC 2409, RFC 3526, RFC 5114, RFC 7919, or from other
17799 sources.  As names, Exim uses a standard specified name, else "ike" followed by
17800 the number used by IKE, or "default" which corresponds to
17801 &`exim.dev.20160529.3`&.
17802
17803 The available standard primes are:
17804 &`ffdhe2048`&, &`ffdhe3072`&, &`ffdhe4096`&, &`ffdhe6144`&, &`ffdhe8192`&,
17805 &`ike1`&, &`ike2`&, &`ike5`&,
17806 &`ike14`&, &`ike15`&, &`ike16`&, &`ike17`&, &`ike18`&,
17807 &`ike22`&, &`ike23`& and &`ike24`&.
17808
17809 The available additional primes are:
17810 &`exim.dev.20160529.1`&, &`exim.dev.20160529.2`& and &`exim.dev.20160529.3`&.
17811
17812 Some of these will be too small to be accepted by clients.
17813 Some may be too large to be accepted by clients.
17814 The open cryptographic community has suspicions about the integrity of some
17815 of the later IKE values, which led into RFC7919 providing new fixed constants
17816 (the "ffdhe" identifiers).
17817
17818 At this point, all of the "ike" values should be considered obsolete;
17819 they're still in Exim to avoid breaking unusual configurations, but are
17820 candidates for removal the next time we have backwards-incompatible changes.
17821
17822 The TLS protocol does not negotiate an acceptable size for this; clients tend
17823 to hard-drop connections if what is offered by the server is unacceptable,
17824 whether too large or too small, and there's no provision for the client to
17825 tell the server what these constraints are.  Thus, as a server operator, you
17826 need to make an educated guess as to what is most likely to work for your
17827 userbase.
17828
17829 Some known size constraints suggest that a bit-size in the range 2048 to 2236
17830 is most likely to maximise interoperability.  The upper bound comes from
17831 applications using the Mozilla Network Security Services (NSS) library, which
17832 used to set its &`DH_MAX_P_BITS`& upper-bound to 2236.  This affects many
17833 mail user agents (MUAs). The lower bound comes from Debian installs of Exim4
17834 prior to the 4.80 release, as Debian used to patch Exim to raise the minimum
17835 acceptable bound from 1024 to 2048.
17836
17837
17838 .option tls_eccurve main string&!! &`auto`&
17839 .cindex TLS "EC cryptography"
17840 This option selects a EC curve for use by Exim when used with OpenSSL.
17841 It has no effect when Exim is used with GnuTLS.
17842
17843 After expansion it must contain a valid EC curve parameter, such as
17844 &`prime256v1`&, &`secp384r1`&, or &`P-512`&. Consult your OpenSSL manual
17845 for valid selections.
17846
17847 For OpenSSL versions before (and not including) 1.0.2, the string
17848 &`auto`& selects &`prime256v1`&. For more recent OpenSSL versions
17849 &`auto`& tells the library to choose.
17850
17851 If the option expands to an empty string, no EC curves will be enabled.
17852
17853
17854 .option tls_ocsp_file main string&!! unset
17855 .cindex TLS "certificate status"
17856 .cindex TLS "OCSP proof file"
17857 This option
17858 must if set expand to the absolute path to a file which contains a current
17859 status proof for the server's certificate, as obtained from the
17860 Certificate Authority.
17861
17862 Usable for GnuTLS 3.4.4 or 3.3.17 or OpenSSL 1.1.0 (or later).
17863 .new
17864 The macro "_HAVE_TLS_OCSP" will be defined for those versions.
17865 .wen
17866
17867 .new
17868 For OpenSSL 1.1.0 or later, and
17869 .wen
17870 for GnuTLS 3.5.6 or later the expanded value of this option can be a list
17871 of files, to match a list given for the &%tls_certificate%& option.
17872 The ordering of the two lists must match.
17873 .new
17874 The macro "_HAVE_TLS_OCSP_LIST" will be defined for those versions.
17875 .wen
17876
17877 .new
17878 The file(s) should be in DER format,
17879 except for GnuTLS 3.6.3 or later
17880 or for OpenSSL,
17881 when an optional filetype prefix can be used.
17882 The prefix must be one of "DER" or "PEM", followed by
17883 a single space.  If one is used it sets the format for subsequent
17884 files in the list; the initial format is DER.
17885 If multiple proofs are wanted, for multiple chain elements
17886 (this only works under TLS1.3)
17887 they must be coded as a combined OCSP response.
17888
17889 Although GnuTLS will accept PEM files with multiple separate
17890 PEM blobs (ie. separate OCSP responses), it sends them in the
17891 TLS Certificate record interleaved with the certificates of the chain;
17892 although a GnuTLS client is happy with that, an OpenSSL client is not.
17893 .wen
17894
17895 .option tls_on_connect_ports main "string list" unset
17896 .cindex SSMTP
17897 .cindex SMTPS
17898 This option specifies a list of incoming SSMTP (aka SMTPS) ports that should
17899 operate the SSMTP (SMTPS) protocol, where a TLS session is immediately
17900 set up without waiting for the client to issue a STARTTLS command. For
17901 further details, see section &<<SECTsupobssmt>>&.
17902
17903
17904
17905 .option tls_privatekey main string list&!! unset
17906 .cindex "TLS" "server private key; location of"
17907 The value of this option is expanded, and must then be a list of absolute paths to
17908 files which contains the server's private keys.
17909 If this option is unset, or if
17910 the expansion is forced to fail, or the result is an empty string, the private
17911 key is assumed to be in the same file as the server's certificates. See chapter
17912 &<<CHAPTLS>>& for further details.
17913
17914 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
17915
17916
17917 .option tls_remember_esmtp main boolean false
17918 .cindex "TLS" "esmtp state; remembering"
17919 .cindex "TLS" "broken clients"
17920 If this option is set true, Exim violates the RFCs by remembering that it is in
17921 &"esmtp"& state after successfully negotiating a TLS session. This provides
17922 support for broken clients that fail to send a new EHLO after starting a
17923 TLS session.
17924
17925
17926 .option tls_require_ciphers main string&!! unset
17927 .cindex "TLS" "requiring specific ciphers"
17928 .cindex "cipher" "requiring specific"
17929 This option controls which ciphers can be used for incoming TLS connections.
17930 The &(smtp)& transport has an option of the same name for controlling outgoing
17931 connections. This option is expanded for each connection, so can be varied for
17932 different clients if required. The value of this option must be a list of
17933 permitted cipher suites. The OpenSSL and GnuTLS libraries handle cipher control
17934 in somewhat different ways. If GnuTLS is being used, the client controls the
17935 preference order of the available ciphers. Details are given in sections
17936 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
17937
17938
17939 .option tls_try_verify_hosts main "host list&!!" unset
17940 .cindex "TLS" "client certificate verification"
17941 .cindex "certificate" "verification of client"
17942 See &%tls_verify_hosts%& below.
17943
17944
17945 .option tls_verify_certificates main string&!! system
17946 .cindex "TLS" "client certificate verification"
17947 .cindex "certificate" "verification of client"
17948 The value of this option is expanded, and must then be either the
17949 word "system"
17950 or the absolute path to
17951 a file or directory containing permitted certificates for clients that
17952 match &%tls_verify_hosts%& or &%tls_try_verify_hosts%&.
17953
17954 The "system" value for the option will use a
17955 system default location compiled into the SSL library.
17956 This is not available for GnuTLS versions preceding 3.0.20,
17957 and will be taken as empty; an explicit location
17958 must be specified.
17959
17960 The use of a directory for the option value is not available for GnuTLS versions
17961 preceding 3.3.6 and a single file must be used.
17962
17963 With OpenSSL the certificates specified
17964 explicitly
17965 either by file or directory
17966 are added to those given by the system default location.
17967
17968 These certificates should be for the certificate authorities trusted, rather
17969 than the public cert of individual clients.  With both OpenSSL and GnuTLS, if
17970 the value is a file then the certificates are sent by Exim as a server to
17971 connecting clients, defining the list of accepted certificate authorities.
17972 Thus the values defined should be considered public data.  To avoid this,
17973 use the explicit directory version.
17974
17975 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
17976
17977 A forced expansion failure or setting to an empty string is equivalent to
17978 being unset.
17979
17980
17981 .option tls_verify_hosts main "host list&!!" unset
17982 .cindex "TLS" "client certificate verification"
17983 .cindex "certificate" "verification of client"
17984 This option, along with &%tls_try_verify_hosts%&, controls the checking of
17985 certificates from clients. The expected certificates are defined by
17986 &%tls_verify_certificates%&, which must be set. A configuration error occurs if
17987 either &%tls_verify_hosts%& or &%tls_try_verify_hosts%& is set and
17988 &%tls_verify_certificates%& is not set.
17989
17990 Any client that matches &%tls_verify_hosts%& is constrained by
17991 &%tls_verify_certificates%&. When the client initiates a TLS session, it must
17992 present one of the listed certificates. If it does not, the connection is
17993 aborted. &*Warning*&: Including a host in &%tls_verify_hosts%& does not require
17994 the host to use TLS. It can still send SMTP commands through unencrypted
17995 connections. Forcing a client to use TLS has to be done separately using an
17996 ACL to reject inappropriate commands when the connection is not encrypted.
17997
17998 A weaker form of checking is provided by &%tls_try_verify_hosts%&. If a client
17999 matches this option (but not &%tls_verify_hosts%&), Exim requests a
18000 certificate and checks it against &%tls_verify_certificates%&, but does not
18001 abort the connection if there is no certificate or if it does not match. This
18002 state can be detected in an ACL, which makes it possible to implement policies
18003 such as &"accept for relay only if a verified certificate has been received,
18004 but accept for local delivery if encrypted, even without a verified
18005 certificate"&.
18006
18007 Client hosts that match neither of these lists are not asked to present
18008 certificates.
18009
18010
18011 .option trusted_groups main "string list&!!" unset
18012 .cindex "trusted groups"
18013 .cindex "groups" "trusted"
18014 This option is expanded just once, at the start of Exim's processing. If this
18015 option is set, any process that is running in one of the listed groups, or
18016 which has one of them as a supplementary group, is trusted. The groups can be
18017 specified numerically or by name. See section &<<SECTtrustedadmin>>& for
18018 details of what trusted callers are permitted to do. If neither
18019 &%trusted_groups%& nor &%trusted_users%& is set, only root and the Exim user
18020 are trusted.
18021
18022 .option trusted_users main "string list&!!" unset
18023 .cindex "trusted users"
18024 .cindex "user" "trusted"
18025 This option is expanded just once, at the start of Exim's processing. If this
18026 option is set, any process that is running as one of the listed users is
18027 trusted. The users can be specified numerically or by name. See section
18028 &<<SECTtrustedadmin>>& for details of what trusted callers are permitted to do.
18029 If neither &%trusted_groups%& nor &%trusted_users%& is set, only root and the
18030 Exim user are trusted.
18031
18032 .option unknown_login main string&!! unset
18033 .cindex "uid (user id)" "unknown caller"
18034 .vindex "&$caller_uid$&"
18035 This is a specialized feature for use in unusual configurations. By default, if
18036 the uid of the caller of Exim cannot be looked up using &[getpwuid()]&, Exim
18037 gives up. The &%unknown_login%& option can be used to set a login name to be
18038 used in this circumstance. It is expanded, so values like &%user$caller_uid%&
18039 can be set. When &%unknown_login%& is used, the value of &%unknown_username%&
18040 is used for the user's real name (gecos field), unless this has been set by the
18041 &%-F%& option.
18042
18043 .option unknown_username main string unset
18044 See &%unknown_login%&.
18045
18046 .option untrusted_set_sender main "address list&!!" unset
18047 .cindex "trusted users"
18048 .cindex "sender" "setting by untrusted user"
18049 .cindex "untrusted user setting sender"
18050 .cindex "user" "untrusted setting sender"
18051 .cindex "envelope from"
18052 .cindex "envelope sender"
18053 When an untrusted user submits a message to Exim using the standard input, Exim
18054 normally creates an envelope sender address from the user's login and the
18055 default qualification domain. Data from the &%-f%& option (for setting envelope
18056 senders on non-SMTP messages) or the SMTP MAIL command (if &%-bs%& or &%-bS%&
18057 is used) is ignored.
18058
18059 However, untrusted users are permitted to set an empty envelope sender address,
18060 to declare that a message should never generate any bounces. For example:
18061 .code
18062 exim -f '<>' user@domain.example
18063 .endd
18064 .vindex "&$sender_ident$&"
18065 The &%untrusted_set_sender%& option allows you to permit untrusted users to set
18066 other envelope sender addresses in a controlled way. When it is set, untrusted
18067 users are allowed to set envelope sender addresses that match any of the
18068 patterns in the list. Like all address lists, the string is expanded. The
18069 identity of the user is in &$sender_ident$&, so you can, for example, restrict
18070 users to setting senders that start with their login ids
18071 followed by a hyphen
18072 by a setting like this:
18073 .code
18074 untrusted_set_sender = ^$sender_ident-
18075 .endd
18076 If you want to allow untrusted users to set envelope sender addresses without
18077 restriction, you can use
18078 .code
18079 untrusted_set_sender = *
18080 .endd
18081 The &%untrusted_set_sender%& option applies to all forms of local input, but
18082 only to the setting of the envelope sender. It does not permit untrusted users
18083 to use the other options which trusted user can use to override message
18084 parameters. Furthermore, it does not stop Exim from removing an existing
18085 &'Sender:'& header in the message, or from adding a &'Sender:'& header if
18086 necessary. See &%local_sender_retain%& and &%local_from_check%& for ways of
18087 overriding these actions. The handling of the &'Sender:'& header is also
18088 described in section &<<SECTthesenhea>>&.
18089
18090 The log line for a message's arrival shows the envelope sender following
18091 &"<="&. For local messages, the user's login always follows, after &"U="&. In
18092 &%-bp%& displays, and in the Exim monitor, if an untrusted user sets an
18093 envelope sender address, the user's login is shown in parentheses after the
18094 sender address.
18095
18096
18097 .option uucp_from_pattern main string "see below"
18098 .cindex "&""From""& line"
18099 .cindex "UUCP" "&""From""& line"
18100 Some applications that pass messages to an MTA via a command line interface use
18101 an initial line starting with &"From&~"& to pass the envelope sender. In
18102 particular, this is used by UUCP software. Exim recognizes such a line by means
18103 of a regular expression that is set in &%uucp_from_pattern%&. When the pattern
18104 matches, the sender address is constructed by expanding the contents of
18105 &%uucp_from_sender%&, provided that the caller of Exim is a trusted user. The
18106 default pattern recognizes lines in the following two forms:
18107 .code
18108 From ph10 Fri Jan  5 12:35 GMT 1996
18109 From ph10 Fri, 7 Jan 97 14:00:00 GMT
18110 .endd
18111 The pattern can be seen by running
18112 .code
18113 exim -bP uucp_from_pattern
18114 .endd
18115 It checks only up to the hours and minutes, and allows for a 2-digit or 4-digit
18116 year in the second case. The first word after &"From&~"& is matched in the
18117 regular expression by a parenthesized subpattern. The default value for
18118 &%uucp_from_sender%& is &"$1"&, which therefore just uses this first word
18119 (&"ph10"& in the example above) as the message's sender. See also
18120 &%ignore_fromline_hosts%&.
18121
18122
18123 .option uucp_from_sender main string&!! &`$1`&
18124 See &%uucp_from_pattern%& above.
18125
18126
18127 .option warn_message_file main string unset
18128 .cindex "warning of delay" "customizing the message"
18129 .cindex "customizing" "warning message"
18130 This option defines a template file containing paragraphs of text to be used
18131 for constructing the warning message which is sent by Exim when a message has
18132 been in the queue for a specified amount of time, as specified by
18133 &%delay_warning%&. Details of the file's contents are given in chapter
18134 &<<CHAPemsgcust>>&. See also &%bounce_message_file%&.
18135
18136
18137 .option write_rejectlog main boolean true
18138 .cindex "reject log" "disabling"
18139 If this option is set false, Exim no longer writes anything to the reject log.
18140 See chapter &<<CHAPlog>>& for details of what Exim writes to its logs.
18141 .ecindex IIDconfima
18142 .ecindex IIDmaiconf
18143
18144
18145
18146
18147 . ////////////////////////////////////////////////////////////////////////////
18148 . ////////////////////////////////////////////////////////////////////////////
18149
18150 .chapter "Generic options for routers" "CHAProutergeneric"
18151 .scindex IIDgenoprou1 "options" "generic; for routers"
18152 .scindex IIDgenoprou2 "generic options" "router"
18153 This chapter describes the generic options that apply to all routers.
18154 Those that are preconditions are marked with &Dagger; in the &"use"& field.
18155
18156 For a general description of how a router operates, see sections
18157 &<<SECTrunindrou>>& and &<<SECTrouprecon>>&. The latter specifies the order in
18158 which the preconditions are tested. The order of expansion of the options that
18159 provide data for a transport is: &%errors_to%&, &%headers_add%&,
18160 &%headers_remove%&, &%transport%&.
18161
18162
18163
18164 .option address_data routers string&!! unset
18165 .cindex "router" "data attached to address"
18166 The string is expanded just before the router is run, that is, after all the
18167 precondition tests have succeeded. If the expansion is forced to fail, the
18168 router declines, the value of &%address_data%& remains unchanged, and the
18169 &%more%& option controls what happens next. Other expansion failures cause
18170 delivery of the address to be deferred.
18171
18172 .vindex "&$address_data$&"
18173 When the expansion succeeds, the value is retained with the address, and can be
18174 accessed using the variable &$address_data$& in the current router, subsequent
18175 routers, and the eventual transport.
18176
18177 &*Warning*&: If the current or any subsequent router is a &(redirect)& router
18178 that runs a user's filter file, the contents of &$address_data$& are accessible
18179 in the filter. This is not normally a problem, because such data is usually
18180 either not confidential or it &"belongs"& to the current user, but if you do
18181 put confidential data into &$address_data$& you need to remember this point.
18182
18183 Even if the router declines or passes, the value of &$address_data$& remains
18184 with the address, though it can be changed by another &%address_data%& setting
18185 on a subsequent router. If a router generates child addresses, the value of
18186 &$address_data$& propagates to them. This also applies to the special kind of
18187 &"child"& that is generated by a router with the &%unseen%& option.
18188
18189 The idea of &%address_data%& is that you can use it to look up a lot of data
18190 for the address once, and then pick out parts of the data later. For example,
18191 you could use a single LDAP lookup to return a string of the form
18192 .code
18193 uid=1234 gid=5678 mailbox=/mail/xyz forward=/home/xyz/.forward
18194 .endd
18195 In the transport you could pick out the mailbox by a setting such as
18196 .code
18197 file = ${extract{mailbox}{$address_data}}
18198 .endd
18199 This makes the configuration file less messy, and also reduces the number of
18200 lookups (though Exim does cache lookups).
18201
18202 .new
18203 See also the &%set%& option below.
18204 .wen
18205
18206 .vindex "&$sender_address_data$&"
18207 .vindex "&$address_data$&"
18208 The &%address_data%& facility is also useful as a means of passing information
18209 from one router to another, and from a router to a transport. In addition, if
18210 &$address_data$& is set by a router when verifying a recipient address from an
18211 ACL, it remains available for use in the rest of the ACL statement. After
18212 verifying a sender, the value is transferred to &$sender_address_data$&.
18213
18214
18215
18216 .option address_test routers&!? boolean true
18217 .oindex "&%-bt%&"
18218 .cindex "router" "skipping when address testing"
18219 If this option is set false, the router is skipped when routing is being tested
18220 by means of the &%-bt%& command line option. This can be a convenience when
18221 your first router sends messages to an external scanner, because it saves you
18222 having to set the &"already scanned"& indicator when testing real address
18223 routing.
18224
18225
18226
18227 .option cannot_route_message routers string&!! unset
18228 .cindex "router" "customizing &""cannot route""& message"
18229 .cindex "customizing" "&""cannot route""& message"
18230 This option specifies a text message that is used when an address cannot be
18231 routed because Exim has run out of routers. The default message is
18232 &"Unrouteable address"&. This option is useful only on routers that have
18233 &%more%& set false, or on the very last router in a configuration, because the
18234 value that is used is taken from the last router that is considered. This
18235 includes a router that is skipped because its preconditions are not met, as
18236 well as a router that declines. For example, using the default configuration,
18237 you could put:
18238 .code
18239 cannot_route_message = Remote domain not found in DNS
18240 .endd
18241 on the first router, which is a &(dnslookup)& router with &%more%& set false,
18242 and
18243 .code
18244 cannot_route_message = Unknown local user
18245 .endd
18246 on the final router that checks for local users. If string expansion fails for
18247 this option, the default message is used. Unless the expansion failure was
18248 explicitly forced, a message about the failure is written to the main and panic
18249 logs, in addition to the normal message about the routing failure.
18250
18251
18252 .option caseful_local_part routers boolean false
18253 .cindex "case of local parts"
18254 .cindex "router" "case of local parts"
18255 By default, routers handle the local parts of addresses in a case-insensitive
18256 manner, though the actual case is preserved for transmission with the message.
18257 If you want the case of letters to be significant in a router, you must set
18258 this option true. For individual router options that contain address or local
18259 part lists (for example, &%local_parts%&), case-sensitive matching can be
18260 turned on by &"+caseful"& as a list item. See section &<<SECTcasletadd>>& for
18261 more details.
18262
18263 .vindex "&$local_part$&"
18264 .vindex "&$original_local_part$&"
18265 .vindex "&$parent_local_part$&"
18266 The value of the &$local_part$& variable is forced to lower case while a
18267 router is running unless &%caseful_local_part%& is set. When a router assigns
18268 an address to a transport, the value of &$local_part$& when the transport runs
18269 is the same as it was in the router. Similarly, when a router generates child
18270 addresses by aliasing or forwarding, the values of &$original_local_part$&
18271 and &$parent_local_part$& are those that were used by the redirecting router.
18272
18273 This option applies to the processing of an address by a router. When a
18274 recipient address is being processed in an ACL, there is a separate &%control%&
18275 modifier that can be used to specify case-sensitive processing within the ACL
18276 (see section &<<SECTcontrols>>&).
18277
18278
18279
18280 .option check_local_user routers&!? boolean false
18281 .cindex "local user, checking in router"
18282 .cindex "router" "checking for local user"
18283 .cindex "&_/etc/passwd_&"
18284 .vindex "&$home$&"
18285 When this option is true, Exim checks that the local part of the recipient
18286 address (with affixes removed if relevant) is the name of an account on the
18287 local system. The check is done by calling the &[getpwnam()]& function rather
18288 than trying to read &_/etc/passwd_& directly. This means that other methods of
18289 holding password data (such as NIS) are supported. If the local part is a local
18290 user, &$home$& is set from the password data, and can be tested in other
18291 preconditions that are evaluated after this one (the order of evaluation is
18292 given in section &<<SECTrouprecon>>&). However, the value of &$home$& can be
18293 overridden by &%router_home_directory%&. If the local part is not a local user,
18294 the router is skipped.
18295
18296 If you want to check that the local part is either the name of a local user
18297 or matches something else, you cannot combine &%check_local_user%& with a
18298 setting of &%local_parts%&, because that specifies the logical &'and'& of the
18299 two conditions. However, you can use a &(passwd)& lookup in a &%local_parts%&
18300 setting to achieve this. For example:
18301 .code
18302 local_parts = passwd;$local_part : lsearch;/etc/other/users
18303 .endd
18304 Note, however, that the side effects of &%check_local_user%& (such as setting
18305 up a home directory) do not occur when a &(passwd)& lookup is used in a
18306 &%local_parts%& (or any other) precondition.
18307
18308
18309
18310 .option condition routers&!? string&!! unset
18311 .cindex "router" "customized precondition"
18312 This option specifies a general precondition test that has to succeed for the
18313 router to be called. The &%condition%& option is the last precondition to be
18314 evaluated (see section &<<SECTrouprecon>>&). The string is expanded, and if the
18315 result is a forced failure, or an empty string, or one of the strings &"0"& or
18316 &"no"& or &"false"& (checked without regard to the case of the letters), the
18317 router is skipped, and the address is offered to the next one.
18318
18319 If the result is any other value, the router is run (as this is the last
18320 precondition to be evaluated, all the other preconditions must be true).
18321
18322 This option is unusual in that multiple &%condition%& options may be present.
18323 All &%condition%& options must succeed.
18324
18325 The &%condition%& option provides a means of applying custom conditions to the
18326 running of routers. Note that in the case of a simple conditional expansion,
18327 the default expansion values are exactly what is wanted. For example:
18328 .code
18329 condition = ${if >{$message_age}{600}}
18330 .endd
18331 Because of the default behaviour of the string expansion, this is equivalent to
18332 .code
18333 condition = ${if >{$message_age}{600}{true}{}}
18334 .endd
18335
18336 A multiple condition example, which succeeds:
18337 .code
18338 condition = ${if >{$message_age}{600}}
18339 condition = ${if !eq{${lc:$local_part}}{postmaster}}
18340 condition = foobar
18341 .endd
18342
18343 If the expansion fails (other than forced failure) delivery is deferred. Some
18344 of the other precondition options are common special cases that could in fact
18345 be specified using &%condition%&.
18346
18347 Historical note: We have &%condition%& on ACLs and on Routers.  Routers
18348 are far older, and use one set of semantics.  ACLs are newer and when
18349 they were created, the ACL &%condition%& process was given far stricter
18350 parse semantics.  The &%bool{}%& expansion condition uses the same rules as
18351 ACLs.  The &%bool_lax{}%& expansion condition uses the same rules as
18352 Routers.  More pointedly, the &%bool_lax{}%& was written to match the existing
18353 Router rules processing behavior.
18354
18355 This is best illustrated in an example:
18356 .code
18357 # If used in an ACL condition will fail with a syntax error, but
18358 # in a router condition any extra characters are treated as a string
18359
18360 $ exim -be '${if eq {${lc:GOOGLE.com}} {google.com}} {yes} {no}}'
18361 true {yes} {no}}
18362
18363 $ exim -be '${if eq {${lc:WHOIS.com}} {google.com}} {yes} {no}}'
18364  {yes} {no}}
18365 .endd
18366 In each example above, the &%if%& statement actually ends after
18367 &"{google.com}}"&.  Since no true or false braces were defined, the
18368 default &%if%& behavior is to return a boolean true or a null answer
18369 (which evaluates to false). The rest of the line is then treated as a
18370 string. So the first example resulted in the boolean answer &"true"&
18371 with the string &" {yes} {no}}"& appended to it. The second example
18372 resulted in the null output (indicating false) with the string
18373 &" {yes} {no}}"& appended to it.
18374
18375 In fact you can put excess forward braces in too.  In the router
18376 &%condition%&, Exim's parser only looks for &"{"& symbols when they
18377 mean something, like after a &"$"& or when required as part of a
18378 conditional.  But otherwise &"{"& and &"}"& are treated as ordinary
18379 string characters.
18380
18381 Thus, in a Router, the above expansion strings will both always evaluate
18382 true, as the result of expansion is a non-empty string which doesn't
18383 match an explicit false value.  This can be tricky to debug.  By
18384 contrast, in an ACL either of those strings will always result in an
18385 expansion error because the result doesn't look sufficiently boolean.
18386
18387
18388 .option debug_print routers string&!! unset
18389 .cindex "testing" "variables in drivers"
18390 If this option is set and debugging is enabled (see the &%-d%& command line
18391 option) or in address-testing mode (see the &%-bt%& command line option),
18392 the string is expanded and included in the debugging output.
18393 If expansion of the string fails, the error message is written to the debugging
18394 output, and Exim carries on processing.
18395 This option is provided to help with checking out the values of variables and
18396 so on when debugging router configurations. For example, if a &%condition%&
18397 option appears not to be working, &%debug_print%& can be used to output the
18398 variables it references. The output happens after checks for &%domains%&,
18399 &%local_parts%&, and &%check_local_user%& but before any other preconditions
18400 are tested. A newline is added to the text if it does not end with one.
18401 The variable &$router_name$& contains the name of the router.
18402
18403
18404
18405 .option disable_logging routers boolean false
18406 If this option is set true, nothing is logged for any routing errors
18407 or for any deliveries caused by this router. You should not set this option
18408 unless you really, really know what you are doing. See also the generic
18409 transport option of the same name.
18410
18411 .option dnssec_request_domains routers "domain list&!!" *
18412 .cindex "MX record" "security"
18413 .cindex "DNSSEC" "MX lookup"
18414 .cindex "security" "MX lookup"
18415 .cindex "DNS" "DNSSEC"
18416 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
18417 the dnssec request bit set.
18418 This applies to all of the SRV, MX, AAAA, A lookup sequence.
18419
18420 .option dnssec_require_domains routers "domain list&!!" unset
18421 .cindex "MX record" "security"
18422 .cindex "DNSSEC" "MX lookup"
18423 .cindex "security" "MX lookup"
18424 .cindex "DNS" "DNSSEC"
18425 DNS lookups for domains matching &%dnssec_require_domains%& will be done with
18426 the dnssec request bit set.  Any returns not having the Authenticated Data bit
18427 (AD bit) set will be ignored and logged as a host-lookup failure.
18428 This applies to all of the SRV, MX, AAAA, A lookup sequence.
18429
18430
18431 .option domains routers&!? "domain list&!!" unset
18432 .cindex "router" "restricting to specific domains"
18433 .vindex "&$domain_data$&"
18434 If this option is set, the router is skipped unless the current domain matches
18435 the list. If the match is achieved by means of a file lookup, the data that the
18436 lookup returned for the domain is placed in &$domain_data$& for use in string
18437 expansions of the driver's private options. See section &<<SECTrouprecon>>& for
18438 a list of the order in which preconditions are evaluated.
18439
18440
18441
18442 .option driver routers string unset
18443 This option must always be set. It specifies which of the available routers is
18444 to be used.
18445
18446
18447 .option dsn_lasthop routers boolean false
18448 .cindex "DSN" "success"
18449 .cindex "Delivery Status Notification" "success"
18450 If this option is set true, and extended DSN (RFC3461) processing is in effect,
18451 Exim will not pass on DSN requests to downstream DSN-aware hosts but will
18452 instead send a success DSN as if the next hop does not support DSN.
18453 Not effective on redirect routers.
18454
18455
18456
18457 .option errors_to routers string&!! unset
18458 .cindex "envelope from"
18459 .cindex "envelope sender"
18460 .cindex "router" "changing address for errors"
18461 If a router successfully handles an address, it may assign the address to a
18462 transport for delivery or it may generate child addresses. In both cases, if
18463 there is a delivery problem during later processing, the resulting bounce
18464 message is sent to the address that results from expanding this string,
18465 provided that the address verifies successfully. The &%errors_to%& option is
18466 expanded before &%headers_add%&, &%headers_remove%&, and &%transport%&.
18467
18468 The &%errors_to%& setting associated with an address can be overridden if it
18469 subsequently passes through other routers that have their own &%errors_to%&
18470 settings, or if the message is delivered by a transport with a &%return_path%&
18471 setting.
18472
18473 If &%errors_to%& is unset, or the expansion is forced to fail, or the result of
18474 the expansion fails to verify, the errors address associated with the incoming
18475 address is used. At top level, this is the envelope sender. A non-forced
18476 expansion failure causes delivery to be deferred.
18477
18478 If an address for which &%errors_to%& has been set ends up being delivered over
18479 SMTP, the envelope sender for that delivery is the &%errors_to%& value, so that
18480 any bounces that are generated by other MTAs on the delivery route are also
18481 sent there. You can set &%errors_to%& to the empty string by either of these
18482 settings:
18483 .code
18484 errors_to =
18485 errors_to = ""
18486 .endd
18487 An expansion item that yields an empty string has the same effect. If you do
18488 this, a locally detected delivery error for addresses processed by this router
18489 no longer gives rise to a bounce message; the error is discarded. If the
18490 address is delivered to a remote host, the return path is set to &`<>`&, unless
18491 overridden by the &%return_path%& option on the transport.
18492
18493 .vindex "&$address_data$&"
18494 If for some reason you want to discard local errors, but use a non-empty
18495 MAIL command for remote delivery, you can preserve the original return
18496 path in &$address_data$& in the router, and reinstate it in the transport by
18497 setting &%return_path%&.
18498
18499 The most common use of &%errors_to%& is to direct mailing list bounces to the
18500 manager of the list, as described in section &<<SECTmailinglists>>&, or to
18501 implement VERP (Variable Envelope Return Paths) (see section &<<SECTverp>>&).
18502
18503
18504
18505 .option expn routers&!? boolean true
18506 .cindex "address" "testing"
18507 .cindex "testing" "addresses"
18508 .cindex "EXPN" "router skipping"
18509 .cindex "router" "skipping for EXPN"
18510 If this option is turned off, the router is skipped when testing an address
18511 as a result of processing an SMTP EXPN command. You might, for example,
18512 want to turn it off on a router for users' &_.forward_& files, while leaving it
18513 on for the system alias file.
18514 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
18515 are evaluated.
18516
18517 The use of the SMTP EXPN command is controlled by an ACL (see chapter
18518 &<<CHAPACL>>&). When Exim is running an EXPN command, it is similar to testing
18519 an address with &%-bt%&. Compare VRFY, whose counterpart is &%-bv%&.
18520
18521
18522
18523 .option fail_verify routers boolean false
18524 .cindex "router" "forcing verification failure"
18525 Setting this option has the effect of setting both &%fail_verify_sender%& and
18526 &%fail_verify_recipient%& to the same value.
18527
18528
18529
18530 .option fail_verify_recipient routers boolean false
18531 If this option is true and an address is accepted by this router when
18532 verifying a recipient, verification fails.
18533
18534
18535
18536 .option fail_verify_sender routers boolean false
18537 If this option is true and an address is accepted by this router when
18538 verifying a sender, verification fails.
18539
18540
18541
18542 .option fallback_hosts routers "string list" unset
18543 .cindex "router" "fallback hosts"
18544 .cindex "fallback" "hosts specified on router"
18545 String expansion is not applied to this option. The argument must be a
18546 colon-separated list of host names or IP addresses. The list separator can be
18547 changed (see section &<<SECTlistsepchange>>&), and a port can be specified with
18548 each name or address. In fact, the format of each item is exactly the same as
18549 defined for the list of hosts in a &(manualroute)& router (see section
18550 &<<SECTformatonehostitem>>&).
18551
18552 If a router queues an address for a remote transport, this host list is
18553 associated with the address, and used instead of the transport's fallback host
18554 list. If &%hosts_randomize%& is set on the transport, the order of the list is
18555 randomized for each use. See the &%fallback_hosts%& option of the &(smtp)&
18556 transport for further details.
18557
18558
18559 .option group routers string&!! "see below"
18560 .cindex "gid (group id)" "local delivery"
18561 .cindex "local transports" "uid and gid"
18562 .cindex "transport" "local"
18563 .cindex "router" "setting group"
18564 When a router queues an address for a transport, and the transport does not
18565 specify a group, the group given here is used when running the delivery
18566 process.
18567 The group may be specified numerically or by name. If expansion fails, the
18568 error is logged and delivery is deferred.
18569 The default is unset, unless &%check_local_user%& is set, when the default
18570 is taken from the password information. See also &%initgroups%& and &%user%&
18571 and the discussion in chapter &<<CHAPenvironment>>&.
18572
18573
18574
18575 .option headers_add routers list&!! unset
18576 .cindex "header lines" "adding"
18577 .cindex "router" "adding header lines"
18578 This option specifies a list of text headers,
18579 newline-separated (by default, changeable in the usual way &<<SECTlistsepchange>>&),
18580 that is associated with any addresses that are accepted by the router.
18581 Each item is separately expanded, at routing time.  However, this
18582 option has no effect when an address is just being verified. The way in which
18583 the text is used to add header lines at transport time is described in section
18584 &<<SECTheadersaddrem>>&. New header lines are not actually added until the
18585 message is in the process of being transported. This means that references to
18586 header lines in string expansions in the transport's configuration do not
18587 &"see"& the added header lines.
18588
18589 The &%headers_add%& option is expanded after &%errors_to%&, but before
18590 &%headers_remove%& and &%transport%&. If an item is empty, or if
18591 an item expansion is forced to fail, the item has no effect. Other expansion
18592 failures are treated as configuration errors.
18593
18594 Unlike most options, &%headers_add%& can be specified multiple times
18595 for a router; all listed headers are added.
18596
18597 &*Warning 1*&: The &%headers_add%& option cannot be used for a &(redirect)&
18598 router that has the &%one_time%& option set.
18599
18600 .cindex "duplicate addresses"
18601 .oindex "&%unseen%&"
18602 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
18603 additions are deleted when the address is passed on to subsequent routers.
18604 For a &%redirect%& router, if a generated address is the same as the incoming
18605 address, this can lead to duplicate addresses with different header
18606 modifications. Exim does not do duplicate deliveries (except, in certain
18607 circumstances, to pipes -- see section &<<SECTdupaddr>>&), but it is undefined
18608 which of the duplicates is discarded, so this ambiguous situation should be
18609 avoided. The &%repeat_use%& option of the &%redirect%& router may be of help.
18610
18611
18612
18613 .option headers_remove routers list&!! unset
18614 .cindex "header lines" "removing"
18615 .cindex "router" "removing header lines"
18616 This option specifies a list of text headers,
18617 colon-separated (by default, changeable in the usual way &<<SECTlistsepchange>>&),
18618 that is associated with any addresses that are accepted by the router.
18619 Each item is separately expanded, at routing time.  However, this
18620 option has no effect when an address is just being verified. The way in which
18621 the text is used to remove header lines at transport time is described in
18622 section &<<SECTheadersaddrem>>&. Header lines are not actually removed until
18623 the message is in the process of being transported. This means that references
18624 to header lines in string expansions in the transport's configuration still
18625 &"see"& the original header lines.
18626
18627 The &%headers_remove%& option is expanded after &%errors_to%& and
18628 &%headers_add%&, but before &%transport%&. If an item expansion is forced to fail,
18629 the item has no effect. Other expansion failures are treated as configuration
18630 errors.
18631
18632 Unlike most options, &%headers_remove%& can be specified multiple times
18633 for a router; all listed headers are removed.
18634
18635 &*Warning 1*&: The &%headers_remove%& option cannot be used for a &(redirect)&
18636 router that has the &%one_time%& option set.
18637
18638 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
18639 removal requests are deleted when the address is passed on to subsequent
18640 routers, and this can lead to problems with duplicates -- see the similar
18641 warning for &%headers_add%& above.
18642
18643 &*Warning 3*&: Because of the separate expansion of the list items,
18644 items that contain a list separator must have it doubled.
18645 To avoid this, change the list separator (&<<SECTlistsepchange>>&).
18646
18647
18648
18649 .option ignore_target_hosts routers "host list&!!" unset
18650 .cindex "IP address" "discarding"
18651 .cindex "router" "discarding IP addresses"
18652 Although this option is a host list, it should normally contain IP address
18653 entries rather than names. If any host that is looked up by the router has an
18654 IP address that matches an item in this list, Exim behaves as if that IP
18655 address did not exist. This option allows you to cope with rogue DNS entries
18656 like
18657 .code
18658 remote.domain.example.  A  127.0.0.1
18659 .endd
18660 by setting
18661 .code
18662 ignore_target_hosts = 127.0.0.1
18663 .endd
18664 on the relevant router. If all the hosts found by a &(dnslookup)& router are
18665 discarded in this way, the router declines. In a conventional configuration, an
18666 attempt to mail to such a domain would normally provoke the &"unrouteable
18667 domain"& error, and an attempt to verify an address in the domain would fail.
18668 Similarly, if &%ignore_target_hosts%& is set on an &(ipliteral)& router, the
18669 router declines if presented with one of the listed addresses.
18670
18671 You can use this option to disable the use of IPv4 or IPv6 for mail delivery by
18672 means of the first or the second of the following settings, respectively:
18673 .code
18674 ignore_target_hosts = 0.0.0.0/0
18675 ignore_target_hosts = <; 0::0/0
18676 .endd
18677 The pattern in the first line matches all IPv4 addresses, whereas the pattern
18678 in the second line matches all IPv6 addresses.
18679
18680 This option may also be useful for ignoring link-local and site-local IPv6
18681 addresses. Because, like all host lists, the value of &%ignore_target_hosts%&
18682 is expanded before use as a list, it is possible to make it dependent on the
18683 domain that is being routed.
18684
18685 .vindex "&$host_address$&"
18686 During its expansion, &$host_address$& is set to the IP address that is being
18687 checked.
18688
18689 .option initgroups routers boolean false
18690 .cindex "additional groups"
18691 .cindex "groups" "additional"
18692 .cindex "local transports" "uid and gid"
18693 .cindex "transport" "local"
18694 If the router queues an address for a transport, and this option is true, and
18695 the uid supplied by the router is not overridden by the transport, the
18696 &[initgroups()]& function is called when running the transport to ensure that
18697 any additional groups associated with the uid are set up. See also &%group%&
18698 and &%user%& and the discussion in chapter &<<CHAPenvironment>>&.
18699
18700
18701
18702 .option local_part_prefix routers&!? "string list" unset
18703 .cindex affix "router precondition"
18704 .cindex "router" "prefix for local part"
18705 .cindex "prefix" "for local part, used in router"
18706 If this option is set, the router is skipped unless the local part starts with
18707 one of the given strings, or &%local_part_prefix_optional%& is true. See
18708 section &<<SECTrouprecon>>& for a list of the order in which preconditions are
18709 evaluated.
18710
18711 The list is scanned from left to right, and the first prefix that matches is
18712 used. A limited form of wildcard is available; if the prefix begins with an
18713 asterisk, it matches the longest possible sequence of arbitrary characters at
18714 the start of the local part. An asterisk should therefore always be followed by
18715 some character that does not occur in normal local parts.
18716 .cindex "multiple mailboxes"
18717 .cindex "mailbox" "multiple"
18718 Wildcarding can be used to set up multiple user mailboxes, as described in
18719 section &<<SECTmulbox>>&.
18720
18721 .vindex "&$local_part$&"
18722 .vindex "&$local_part_prefix$&"
18723 During the testing of the &%local_parts%& option, and while the router is
18724 running, the prefix is removed from the local part, and is available in the
18725 expansion variable &$local_part_prefix$&. When a message is being delivered, if
18726 the router accepts the address, this remains true during subsequent delivery by
18727 a transport. In particular, the local part that is transmitted in the RCPT
18728 command for LMTP, SMTP, and BSMTP deliveries has the prefix removed by default.
18729 This behaviour can be overridden by setting &%rcpt_include_affixes%& true on
18730 the relevant transport.
18731
18732 When an address is being verified, &%local_part_prefix%& affects only the
18733 behaviour of the router. If the callout feature of verification is in use, this
18734 means that the full address, including the prefix, will be used during the
18735 callout.
18736
18737 The prefix facility is commonly used to handle local parts of the form
18738 &%owner-something%&. Another common use is to support local parts of the form
18739 &%real-username%& to bypass a user's &_.forward_& file &-- helpful when trying
18740 to tell a user their forwarding is broken &-- by placing a router like this one
18741 immediately before the router that handles &_.forward_& files:
18742 .code
18743 real_localuser:
18744   driver = accept
18745   local_part_prefix = real-
18746   check_local_user
18747   transport = local_delivery
18748 .endd
18749 For security, it would probably be a good idea to restrict the use of this
18750 router to locally-generated messages, using a condition such as this:
18751 .code
18752   condition = ${if match {$sender_host_address}\
18753                          {\N^(|127\.0\.0\.1)$\N}}
18754 .endd
18755
18756 If both &%local_part_prefix%& and &%local_part_suffix%& are set for a router,
18757 both conditions must be met if not optional. Care must be taken if wildcards
18758 are used in both a prefix and a suffix on the same router. Different
18759 separator characters must be used to avoid ambiguity.
18760
18761
18762 .option local_part_prefix_optional routers boolean false
18763 See &%local_part_prefix%& above.
18764
18765
18766
18767 .option local_part_suffix routers&!? "string list" unset
18768 .cindex "router" "suffix for local part"
18769 .cindex "suffix for local part" "used in router"
18770 This option operates in the same way as &%local_part_prefix%&, except that the
18771 local part must end (rather than start) with the given string, the
18772 &%local_part_suffix_optional%& option determines whether the suffix is
18773 mandatory, and the wildcard * character, if present, must be the last
18774 character of the suffix. This option facility is commonly used to handle local
18775 parts of the form &%something-request%& and multiple user mailboxes of the form
18776 &%username-foo%&.
18777
18778
18779 .option local_part_suffix_optional routers boolean false
18780 See &%local_part_suffix%& above.
18781
18782
18783
18784 .option local_parts routers&!? "local part list&!!" unset
18785 .cindex "router" "restricting to specific local parts"
18786 .cindex "local part" "checking in router"
18787 The router is run only if the local part of the address matches the list.
18788 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
18789 are evaluated, and
18790 section &<<SECTlocparlis>>& for a discussion of local part lists. Because the
18791 string is expanded, it is possible to make it depend on the domain, for
18792 example:
18793 .code
18794 local_parts = dbm;/usr/local/specials/$domain
18795 .endd
18796 .vindex "&$local_part_data$&"
18797 If the match is achieved by a lookup, the data that the lookup returned
18798 for the local part is placed in the variable &$local_part_data$& for use in
18799 expansions of the router's private options. You might use this option, for
18800 example, if you have a large number of local virtual domains, and you want to
18801 send all postmaster mail to the same place without having to set up an alias in
18802 each virtual domain:
18803 .code
18804 postmaster:
18805   driver = redirect
18806   local_parts = postmaster
18807   data = postmaster@real.domain.example
18808 .endd
18809
18810
18811 .option log_as_local routers boolean "see below"
18812 .cindex "log" "delivery line"
18813 .cindex "delivery" "log line format"
18814 Exim has two logging styles for delivery, the idea being to make local
18815 deliveries stand out more visibly from remote ones. In the &"local"& style, the
18816 recipient address is given just as the local part, without a domain. The use of
18817 this style is controlled by this option. It defaults to true for the &(accept)&
18818 router, and false for all the others. This option applies only when a
18819 router assigns an address to a transport. It has no effect on routers that
18820 redirect addresses.
18821
18822
18823
18824 .option more routers boolean&!! true
18825 The result of string expansion for this option must be a valid boolean value,
18826 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
18827 result causes an error, and delivery is deferred. If the expansion is forced to
18828 fail, the default value for the option (true) is used. Other failures cause
18829 delivery to be deferred.
18830
18831 If this option is set false, and the router declines to handle the address, no
18832 further routers are tried, routing fails, and the address is bounced.
18833 .oindex "&%self%&"
18834 However, if the router explicitly passes an address to the following router by
18835 means of the setting
18836 .code
18837 self = pass
18838 .endd
18839 or otherwise, the setting of &%more%& is ignored. Also, the setting of &%more%&
18840 does not affect the behaviour if one of the precondition tests fails. In that
18841 case, the address is always passed to the next router.
18842
18843 Note that &%address_data%& is not considered to be a precondition. If its
18844 expansion is forced to fail, the router declines, and the value of &%more%&
18845 controls what happens next.
18846
18847
18848 .option pass_on_timeout routers boolean false
18849 .cindex "timeout" "of router"
18850 .cindex "router" "timeout"
18851 If a router times out during a host lookup, it normally causes deferral of the
18852 address. If &%pass_on_timeout%& is set, the address is passed on to the next
18853 router, overriding &%no_more%&. This may be helpful for systems that are
18854 intermittently connected to the Internet, or those that want to pass to a smart
18855 host any messages that cannot immediately be delivered.
18856
18857 There are occasional other temporary errors that can occur while doing DNS
18858 lookups. They are treated in the same way as a timeout, and this option
18859 applies to all of them.
18860
18861
18862
18863 .option pass_router routers string unset
18864 .cindex "router" "go to after &""pass""&"
18865 Routers that recognize the generic &%self%& option (&(dnslookup)&,
18866 &(ipliteral)&, and &(manualroute)&) are able to return &"pass"&, forcing
18867 routing to continue, and overriding a false setting of &%more%&. When one of
18868 these routers returns &"pass"&, the address is normally handed on to the next
18869 router in sequence. This can be changed by setting &%pass_router%& to the name
18870 of another router. However (unlike &%redirect_router%&) the named router must
18871 be below the current router, to avoid loops. Note that this option applies only
18872 to the special case of &"pass"&. It does not apply when a router returns
18873 &"decline"& because it cannot handle an address.
18874
18875
18876
18877 .option redirect_router routers string unset
18878 .cindex "router" "start at after redirection"
18879 Sometimes an administrator knows that it is pointless to reprocess addresses
18880 generated from alias or forward files with the same router again. For
18881 example, if an alias file translates real names into login ids there is no
18882 point searching the alias file a second time, especially if it is a large file.
18883
18884 The &%redirect_router%& option can be set to the name of any router instance.
18885 It causes the routing of any generated addresses to start at the named router
18886 instead of at the first router. This option has no effect if the router in
18887 which it is set does not generate new addresses.
18888
18889
18890
18891 .option require_files routers&!? "string list&!!" unset
18892 .cindex "file" "requiring for router"
18893 .cindex "router" "requiring file existence"
18894 This option provides a general mechanism for predicating the running of a
18895 router on the existence or non-existence of certain files or directories.
18896 Before running a router, as one of its precondition tests, Exim works its way
18897 through the &%require_files%& list, expanding each item separately.
18898
18899 Because the list is split before expansion, any colons in expansion items must
18900 be doubled, or the facility for using a different list separator must be used
18901 (&<<SECTlistsepchange>>&).
18902 If any expansion is forced to fail, the item is ignored. Other expansion
18903 failures cause routing of the address to be deferred.
18904
18905 If any expanded string is empty, it is ignored. Otherwise, except as described
18906 below, each string must be a fully qualified file path, optionally preceded by
18907 &"!"&. The paths are passed to the &[stat()]& function to test for the
18908 existence of the files or directories. The router is skipped if any paths not
18909 preceded by &"!"& do not exist, or if any paths preceded by &"!"& do exist.
18910
18911 .cindex "NFS"
18912 If &[stat()]& cannot determine whether a file exists or not, delivery of
18913 the message is deferred. This can happen when NFS-mounted filesystems are
18914 unavailable.
18915
18916 This option is checked after the &%domains%&, &%local_parts%&, and &%senders%&
18917 options, so you cannot use it to check for the existence of a file in which to
18918 look up a domain, local part, or sender. (See section &<<SECTrouprecon>>& for a
18919 full list of the order in which preconditions are evaluated.) However, as
18920 these options are all expanded, you can use the &%exists%& expansion condition
18921 to make such tests. The &%require_files%& option is intended for checking files
18922 that the router may be going to use internally, or which are needed by a
18923 transport (e.g., &_.procmailrc_&).
18924
18925 During delivery, the &[stat()]& function is run as root, but there is a
18926 facility for some checking of the accessibility of a file by another user.
18927 This is not a proper permissions check, but just a &"rough"& check that
18928 operates as follows:
18929
18930 If an item in a &%require_files%& list does not contain any forward slash
18931 characters, it is taken to be the user (and optional group, separated by a
18932 comma) to be checked for subsequent files in the list. If no group is specified
18933 but the user is specified symbolically, the gid associated with the uid is
18934 used. For example:
18935 .code
18936 require_files = mail:/some/file
18937 require_files = $local_part:$home/.procmailrc
18938 .endd
18939 If a user or group name in a &%require_files%& list does not exist, the
18940 &%require_files%& condition fails.
18941
18942 Exim performs the check by scanning along the components of the file path, and
18943 checking the access for the given uid and gid. It checks for &"x"& access on
18944 directories, and &"r"& access on the final file. Note that this means that file
18945 access control lists, if the operating system has them, are ignored.
18946
18947 &*Warning 1*&: When the router is being run to verify addresses for an
18948 incoming SMTP message, Exim is not running as root, but under its own uid. This
18949 may affect the result of a &%require_files%& check. In particular, &[stat()]&
18950 may yield the error EACCES (&"Permission denied"&). This means that the Exim
18951 user is not permitted to read one of the directories on the file's path.
18952
18953 &*Warning 2*&: Even when Exim is running as root while delivering a message,
18954 &[stat()]& can yield EACCES for a file in an NFS directory that is mounted
18955 without root access. In this case, if a check for access by a particular user
18956 is requested, Exim creates a subprocess that runs as that user, and tries the
18957 check again in that process.
18958
18959 The default action for handling an unresolved EACCES is to consider it to
18960 be caused by a configuration error, and routing is deferred because the
18961 existence or non-existence of the file cannot be determined. However, in some
18962 circumstances it may be desirable to treat this condition as if the file did
18963 not exist. If the filename (or the exclamation mark that precedes the filename
18964 for non-existence) is preceded by a plus sign, the EACCES error is treated
18965 as if the file did not exist. For example:
18966 .code
18967 require_files = +/some/file
18968 .endd
18969 If the router is not an essential part of verification (for example, it
18970 handles users' &_.forward_& files), another solution is to set the &%verify%&
18971 option false so that the router is skipped when verifying.
18972
18973
18974
18975 .option retry_use_local_part routers boolean "see below"
18976 .cindex "hints database" "retry keys"
18977 .cindex "local part" "in retry keys"
18978 When a delivery suffers a temporary routing failure, a retry record is created
18979 in Exim's hints database. For addresses whose routing depends only on the
18980 domain, the key for the retry record should not involve the local part, but for
18981 other addresses, both the domain and the local part should be included.
18982 Usually, remote routing is of the former kind, and local routing is of the
18983 latter kind.
18984
18985 This option controls whether the local part is used to form the key for retry
18986 hints for addresses that suffer temporary errors while being handled by this
18987 .new
18988 router. The default value is true for any router that has any of
18989 &%check_local_user%&,
18990 &%local_parts%&,
18991 &%condition%&,
18992 &%local_part_prefix%&,
18993 &%local_part_suffix%&,
18994 &%senders%& or
18995 &%require_files%&
18996 .wen
18997 set, and false otherwise. Note that this option does not apply to hints keys
18998 for transport delays; they are controlled by a generic transport option of the
18999 same name.
19000
19001 Failing to set this option when it is needed
19002 (because a remote router handles only some of the local-parts for a domain)
19003 can result in incorrect error messages being generated.
19004
19005 The setting of &%retry_use_local_part%& applies only to the router on which it
19006 appears. If the router generates child addresses, they are routed
19007 independently; this setting does not become attached to them.
19008
19009
19010
19011 .option router_home_directory routers string&!! unset
19012 .cindex "router" "home directory for"
19013 .cindex "home directory" "for router"
19014 .vindex "&$home$&"
19015 This option sets a home directory for use while the router is running. (Compare
19016 &%transport_home_directory%&, which sets a home directory for later
19017 transporting.) In particular, if used on a &(redirect)& router, this option
19018 sets a value for &$home$& while a filter is running. The value is expanded;
19019 forced expansion failure causes the option to be ignored &-- other failures
19020 cause the router to defer.
19021
19022 Expansion of &%router_home_directory%& happens immediately after the
19023 &%check_local_user%& test (if configured), before any further expansions take
19024 place.
19025 (See section &<<SECTrouprecon>>& for a list of the order in which preconditions
19026 are evaluated.)
19027 While the router is running, &%router_home_directory%& overrides the value of
19028 &$home$& that came from &%check_local_user%&.
19029
19030 When a router accepts an address and assigns it to a local transport (including
19031 the cases when a &(redirect)& router generates a pipe, file, or autoreply
19032 delivery), the home directory setting for the transport is taken from the first
19033 of these values that is set:
19034
19035 .ilist
19036 The &%home_directory%& option on the transport;
19037 .next
19038 The &%transport_home_directory%& option on the router;
19039 .next
19040 The password data if &%check_local_user%& is set on the router;
19041 .next
19042 The &%router_home_directory%& option on the router.
19043 .endlist
19044
19045 In other words, &%router_home_directory%& overrides the password data for the
19046 router, but not for the transport.
19047
19048
19049
19050 .option self routers string freeze
19051 .cindex "MX record" "pointing to local host"
19052 .cindex "local host" "MX pointing to"
19053 This option applies to those routers that use a recipient address to find a
19054 list of remote hosts. Currently, these are the &(dnslookup)&, &(ipliteral)&,
19055 and &(manualroute)& routers.
19056 Certain configurations of the &(queryprogram)& router can also specify a list
19057 of remote hosts.
19058 Usually such routers are configured to send the message to a remote host via an
19059 &(smtp)& transport. The &%self%& option specifies what happens when the first
19060 host on the list turns out to be the local host.
19061 The way in which Exim checks for the local host is described in section
19062 &<<SECTreclocipadd>>&.
19063
19064 Normally this situation indicates either an error in Exim's configuration (for
19065 example, the router should be configured not to process this domain), or an
19066 error in the DNS (for example, the MX should not point to this host). For this
19067 reason, the default action is to log the incident, defer the address, and
19068 freeze the message. The following alternatives are provided for use in special
19069 cases:
19070
19071 .vlist
19072 .vitem &%defer%&
19073 Delivery of the message is tried again later, but the message is not frozen.
19074
19075 .vitem "&%reroute%&: <&'domain'&>"
19076 The domain is changed to the given domain, and the address is passed back to
19077 be reprocessed by the routers. No rewriting of headers takes place. This
19078 behaviour is essentially a redirection.
19079
19080 .vitem "&%reroute: rewrite:%& <&'domain'&>"
19081 The domain is changed to the given domain, and the address is passed back to be
19082 reprocessed by the routers. Any headers that contain the original domain are
19083 rewritten.
19084
19085 .vitem &%pass%&
19086 .oindex "&%more%&"
19087 .vindex "&$self_hostname$&"
19088 The router passes the address to the next router, or to the router named in the
19089 &%pass_router%& option if it is set. This overrides &%no_more%&. During
19090 subsequent routing and delivery, the variable &$self_hostname$& contains the
19091 name of the local host that the router encountered. This can be used to
19092 distinguish between different cases for hosts with multiple names. The
19093 combination
19094 .code
19095 self = pass
19096 no_more
19097 .endd
19098 ensures that only those addresses that routed to the local host are passed on.
19099 Without &%no_more%&, addresses that were declined for other reasons would also
19100 be passed to the next router.
19101
19102 .vitem &%fail%&
19103 Delivery fails and an error report is generated.
19104
19105 .vitem &%send%&
19106 .cindex "local host" "sending to"
19107 The anomaly is ignored and the address is queued for the transport. This
19108 setting should be used with extreme caution. For an &(smtp)& transport, it
19109 makes sense only in cases where the program that is listening on the SMTP port
19110 is not this version of Exim. That is, it must be some other MTA, or Exim with a
19111 different configuration file that handles the domain in another way.
19112 .endlist
19113
19114
19115
19116 .option senders routers&!? "address list&!!" unset
19117 .cindex "router" "checking senders"
19118 If this option is set, the router is skipped unless the message's sender
19119 address matches something on the list.
19120 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
19121 are evaluated.
19122
19123 There are issues concerning verification when the running of routers is
19124 dependent on the sender. When Exim is verifying the address in an &%errors_to%&
19125 setting, it sets the sender to the null string. When using the &%-bt%& option
19126 to check a configuration file, it is necessary also to use the &%-f%& option to
19127 set an appropriate sender. For incoming mail, the sender is unset when
19128 verifying the sender, but is available when verifying any recipients. If the
19129 SMTP VRFY command is enabled, it must be used after MAIL if the sender address
19130 matters.
19131
19132
19133 .new
19134 .option set routers "string list" unset
19135 .cindex router variables
19136 This option may be used multiple times on a router;
19137 because of this the list aspect is mostly irrelevant.
19138 The list separator is a semicolon but can be changed in the
19139 usual way.
19140
19141 Each list-element given must be of the form $"name = value"$
19142 and the names used must start with the string &"r_"&.
19143 Values containing a list-separator should have them doubled.
19144 When a router runs, the strings are evaluated in order,
19145 to create variables which are added to the set associated with
19146 the address.
19147 The variable is set with the expansion of the value.
19148 The variables can be used by the router options
19149 (not including any preconditions)
19150 and by the transport.
19151 Later definitions of a given named variable will override former ones.
19152 Varible use is via the usual &$r_...$& syntax.
19153
19154 This is similar to the &%address_data%& option, except that
19155 many independent variables can be used, with choice of naming.
19156 .wen
19157
19158
19159 .option translate_ip_address routers string&!! unset
19160 .cindex "IP address" "translating"
19161 .cindex "packet radio"
19162 .cindex "router" "IP address translation"
19163 There exist some rare networking situations (for example, packet radio) where
19164 it is helpful to be able to translate IP addresses generated by normal routing
19165 mechanisms into other IP addresses, thus performing a kind of manual IP
19166 routing. This should be done only if the normal IP routing of the TCP/IP stack
19167 is inadequate or broken. Because this is an extremely uncommon requirement, the
19168 code to support this option is not included in the Exim binary unless
19169 SUPPORT_TRANSLATE_IP_ADDRESS=yes is set in &_Local/Makefile_&.
19170
19171 .vindex "&$host_address$&"
19172 The &%translate_ip_address%& string is expanded for every IP address generated
19173 by the router, with the generated address set in &$host_address$&. If the
19174 expansion is forced to fail, no action is taken.
19175 For any other expansion error, delivery of the message is deferred.
19176 If the result of the expansion is an IP address, that replaces the original
19177 address; otherwise the result is assumed to be a host name &-- this is looked
19178 up using &[gethostbyname()]& (or &[getipnodebyname()]& when available) to
19179 produce one or more replacement IP addresses. For example, to subvert all IP
19180 addresses in some specific networks, this could be added to a router:
19181 .code
19182 translate_ip_address = \
19183   ${lookup{${mask:$host_address/26}}lsearch{/some/file}\
19184     {$value}fail}}
19185 .endd
19186 The file would contain lines like
19187 .code
19188 10.2.3.128/26    some.host
19189 10.8.4.34/26     10.44.8.15
19190 .endd
19191 You should not make use of this facility unless you really understand what you
19192 are doing.
19193
19194
19195
19196 .option transport routers string&!! unset
19197 This option specifies the transport to be used when a router accepts an address
19198 and sets it up for delivery. A transport is never needed if a router is used
19199 only for verification. The value of the option is expanded at routing time,
19200 after the expansion of &%errors_to%&, &%headers_add%&, and &%headers_remove%&,
19201 and result must be the name of one of the configured transports. If it is not,
19202 delivery is deferred.
19203
19204 The &%transport%& option is not used by the &(redirect)& router, but it does
19205 have some private options that set up transports for pipe and file deliveries
19206 (see chapter &<<CHAPredirect>>&).
19207
19208
19209
19210 .option transport_current_directory routers string&!! unset
19211 .cindex "current directory for local transport"
19212 This option associates a current directory with any address that is routed
19213 to a local transport. This can happen either because a transport is
19214 explicitly configured for the router, or because it generates a delivery to a
19215 file or a pipe. During the delivery process (that is, at transport time), this
19216 option string is expanded and is set as the current directory, unless
19217 overridden by a setting on the transport.
19218 If the expansion fails for any reason, including forced failure, an error is
19219 logged, and delivery is deferred.
19220 See chapter &<<CHAPenvironment>>& for details of the local delivery
19221 environment.
19222
19223
19224
19225
19226 .option transport_home_directory routers string&!! "see below"
19227 .cindex "home directory" "for local transport"
19228 This option associates a home directory with any address that is routed to a
19229 local transport. This can happen either because a transport is explicitly
19230 configured for the router, or because it generates a delivery to a file or a
19231 pipe. During the delivery process (that is, at transport time), the option
19232 string is expanded and is set as the home directory, unless overridden by a
19233 setting of &%home_directory%& on the transport.
19234 If the expansion fails for any reason, including forced failure, an error is
19235 logged, and delivery is deferred.
19236
19237 If the transport does not specify a home directory, and
19238 &%transport_home_directory%& is not set for the router, the home directory for
19239 the transport is taken from the password data if &%check_local_user%& is set for
19240 the router. Otherwise it is taken from &%router_home_directory%& if that option
19241 is set; if not, no home directory is set for the transport.
19242
19243 See chapter &<<CHAPenvironment>>& for further details of the local delivery
19244 environment.
19245
19246
19247
19248
19249 .option unseen routers boolean&!! false
19250 .cindex "router" "carrying on after success"
19251 The result of string expansion for this option must be a valid boolean value,
19252 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
19253 result causes an error, and delivery is deferred. If the expansion is forced to
19254 fail, the default value for the option (false) is used. Other failures cause
19255 delivery to be deferred.
19256
19257 When this option is set true, routing does not cease if the router accepts the
19258 address. Instead, a copy of the incoming address is passed to the next router,
19259 overriding a false setting of &%more%&. There is little point in setting
19260 &%more%& false if &%unseen%& is always true, but it may be useful in cases when
19261 the value of &%unseen%& contains expansion items (and therefore, presumably, is
19262 sometimes true and sometimes false).
19263
19264 .cindex "copy of message (&%unseen%& option)"
19265 Setting the &%unseen%& option has a similar effect to the &%unseen%& command
19266 qualifier in filter files. It can be used to cause copies of messages to be
19267 delivered to some other destination, while also carrying out a normal delivery.
19268 In effect, the current address is made into a &"parent"& that has two children
19269 &-- one that is delivered as specified by this router, and a clone that goes on
19270 to be routed further. For this reason, &%unseen%& may not be combined with the
19271 &%one_time%& option in a &(redirect)& router.
19272
19273 &*Warning*&: Header lines added to the address (or specified for removal) by
19274 this router or by previous routers affect the &"unseen"& copy of the message
19275 only. The clone that continues to be processed by further routers starts with
19276 no added headers and none specified for removal. For a &%redirect%& router, if
19277 a generated address is the same as the incoming address, this can lead to
19278 duplicate addresses with different header modifications. Exim does not do
19279 duplicate deliveries (except, in certain circumstances, to pipes -- see section
19280 &<<SECTdupaddr>>&), but it is undefined which of the duplicates is discarded,
19281 so this ambiguous situation should be avoided. The &%repeat_use%& option of the
19282 &%redirect%& router may be of help.
19283
19284 Unlike the handling of header modifications, any data that was set by the
19285 &%address_data%& option in the current or previous routers &'is'& passed on to
19286 subsequent routers.
19287
19288
19289 .option user routers string&!! "see below"
19290 .cindex "uid (user id)" "local delivery"
19291 .cindex "local transports" "uid and gid"
19292 .cindex "transport" "local"
19293 .cindex "router" "user for filter processing"
19294 .cindex "filter" "user for processing"
19295 When a router queues an address for a transport, and the transport does not
19296 specify a user, the user given here is used when running the delivery process.
19297 The user may be specified numerically or by name. If expansion fails, the
19298 error is logged and delivery is deferred.
19299 This user is also used by the &(redirect)& router when running a filter file.
19300 The default is unset, except when &%check_local_user%& is set. In this case,
19301 the default is taken from the password information. If the user is specified as
19302 a name, and &%group%& is not set, the group associated with the user is used.
19303 See also &%initgroups%& and &%group%& and the discussion in chapter
19304 &<<CHAPenvironment>>&.
19305
19306
19307
19308 .option verify routers&!? boolean true
19309 Setting this option has the effect of setting &%verify_sender%& and
19310 &%verify_recipient%& to the same value.
19311
19312
19313 .option verify_only routers&!? boolean false
19314 .cindex "EXPN" "with &%verify_only%&"
19315 .oindex "&%-bv%&"
19316 .cindex "router" "used only when verifying"
19317 If this option is set, the router is used only when verifying an address,
19318 delivering in cutthrough mode or
19319 testing with the &%-bv%& option, not when actually doing a delivery, testing
19320 with the &%-bt%& option, or running the SMTP EXPN command. It can be further
19321 restricted to verifying only senders or recipients by means of
19322 &%verify_sender%& and &%verify_recipient%&.
19323
19324 &*Warning*&: When the router is being run to verify addresses for an incoming
19325 SMTP message, Exim is not running as root, but under its own uid. If the router
19326 accesses any files, you need to make sure that they are accessible to the Exim
19327 user or group.
19328
19329
19330 .option verify_recipient routers&!? boolean true
19331 If this option is false, the router is skipped when verifying recipient
19332 addresses,
19333 delivering in cutthrough mode
19334 or testing recipient verification using &%-bv%&.
19335 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
19336 are evaluated.
19337 See also the &$verify_mode$& variable.
19338
19339
19340 .option verify_sender routers&!? boolean true
19341 If this option is false, the router is skipped when verifying sender addresses
19342 or testing sender verification using &%-bvs%&.
19343 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
19344 are evaluated.
19345 See also the &$verify_mode$& variable.
19346 .ecindex IIDgenoprou1
19347 .ecindex IIDgenoprou2
19348
19349
19350
19351
19352
19353
19354 . ////////////////////////////////////////////////////////////////////////////
19355 . ////////////////////////////////////////////////////////////////////////////
19356
19357 .chapter "The accept router" "CHID4"
19358 .cindex "&(accept)& router"
19359 .cindex "routers" "&(accept)&"
19360 The &(accept)& router has no private options of its own. Unless it is being
19361 used purely for verification (see &%verify_only%&) a transport is required to
19362 be defined by the generic &%transport%& option. If the preconditions that are
19363 specified by generic options are met, the router accepts the address and queues
19364 it for the given transport. The most common use of this router is for setting
19365 up deliveries to local mailboxes. For example:
19366 .code
19367 localusers:
19368   driver = accept
19369   domains = mydomain.example
19370   check_local_user
19371   transport = local_delivery
19372 .endd
19373 The &%domains%& condition in this example checks the domain of the address, and
19374 &%check_local_user%& checks that the local part is the login of a local user.
19375 When both preconditions are met, the &(accept)& router runs, and queues the
19376 address for the &(local_delivery)& transport.
19377
19378
19379
19380
19381
19382
19383 . ////////////////////////////////////////////////////////////////////////////
19384 . ////////////////////////////////////////////////////////////////////////////
19385
19386 .chapter "The dnslookup router" "CHAPdnslookup"
19387 .scindex IIDdnsrou1 "&(dnslookup)& router"
19388 .scindex IIDdnsrou2 "routers" "&(dnslookup)&"
19389 The &(dnslookup)& router looks up the hosts that handle mail for the
19390 recipient's domain in the DNS. A transport must always be set for this router,
19391 unless &%verify_only%& is set.
19392
19393 If SRV support is configured (see &%check_srv%& below), Exim first searches for
19394 SRV records. If none are found, or if SRV support is not configured,
19395 MX records are looked up. If no MX records exist, address records are sought.
19396 However, &%mx_domains%& can be set to disable the direct use of address
19397 records.
19398
19399 MX records of equal priority are sorted by Exim into a random order. Exim then
19400 looks for address records for the host names obtained from MX or SRV records.
19401 When a host has more than one IP address, they are sorted into a random order,
19402 except that IPv6 addresses are sorted before IPv4 addresses. If all the
19403 IP addresses found are discarded by a setting of the &%ignore_target_hosts%&
19404 generic option, the router declines.
19405
19406 Unless they have the highest priority (lowest MX value), MX records that point
19407 to the local host, or to any host name that matches &%hosts_treat_as_local%&,
19408 are discarded, together with any other MX records of equal or lower priority.
19409
19410 .cindex "MX record" "pointing to local host"
19411 .cindex "local host" "MX pointing to"
19412 .oindex "&%self%&" "in &(dnslookup)& router"
19413 If the host pointed to by the highest priority MX record, or looked up as an
19414 address record, is the local host, or matches &%hosts_treat_as_local%&, what
19415 happens is controlled by the generic &%self%& option.
19416
19417
19418 .section "Problems with DNS lookups" "SECTprowitdnsloo"
19419 There have been problems with DNS servers when SRV records are looked up.
19420 Some misbehaving servers return a DNS error or timeout when a non-existent
19421 SRV record is sought. Similar problems have in the past been reported for
19422 MX records. The global &%dns_again_means_nonexist%& option can help with this
19423 problem, but it is heavy-handed because it is a global option.
19424
19425 For this reason, there are two options, &%srv_fail_domains%& and
19426 &%mx_fail_domains%&, that control what happens when a DNS lookup in a
19427 &(dnslookup)& router results in a DNS failure or a &"try again"& response. If
19428 an attempt to look up an SRV or MX record causes one of these results, and the
19429 domain matches the relevant list, Exim behaves as if the DNS had responded &"no
19430 such record"&. In the case of an SRV lookup, this means that the router
19431 proceeds to look for MX records; in the case of an MX lookup, it proceeds to
19432 look for A or AAAA records, unless the domain matches &%mx_domains%&, in which
19433 case routing fails.
19434
19435
19436 .section "Declining addresses by dnslookup" "SECTdnslookupdecline"
19437 .cindex "&(dnslookup)& router" "declines"
19438 There are a few cases where a &(dnslookup)& router will decline to accept
19439 an address; if such a router is expected to handle "all remaining non-local
19440 domains", then it is important to set &%no_more%&.
19441
19442 The router will defer rather than decline if the domain
19443 is found in the &%fail_defer_domains%& router option.
19444
19445 Reasons for a &(dnslookup)& router to decline currently include:
19446 .ilist
19447 The domain does not exist in DNS
19448 .next
19449 The domain exists but the MX record's host part is just "."; this is a common
19450 convention (borrowed from SRV) used to indicate that there is no such service
19451 for this domain and to not fall back to trying A/AAAA records.
19452 .next
19453 Ditto, but for SRV records, when &%check_srv%& is set on this router.
19454 .next
19455 MX record points to a non-existent host.
19456 .next
19457 MX record points to an IP address and the main section option
19458 &%allow_mx_to_ip%& is not set.
19459 .next
19460 MX records exist and point to valid hosts, but all hosts resolve only to
19461 addresses blocked by the &%ignore_target_hosts%& generic option on this router.
19462 .next
19463 The domain is not syntactically valid (see also &%allow_utf8_domains%& and
19464 &%dns_check_names_pattern%& for handling one variant of this)
19465 .next
19466 &%check_secondary_mx%& is set on this router but the local host can
19467 not be found in the MX records (see below)
19468 .endlist
19469
19470
19471
19472
19473 .section "Private options for dnslookup" "SECID118"
19474 .cindex "options" "&(dnslookup)& router"
19475 The private options for the &(dnslookup)& router are as follows:
19476
19477 .option check_secondary_mx dnslookup boolean false
19478 .cindex "MX record" "checking for secondary"
19479 If this option is set, the router declines unless the local host is found in
19480 (and removed from) the list of hosts obtained by MX lookup. This can be used to
19481 process domains for which the local host is a secondary mail exchanger
19482 differently to other domains. The way in which Exim decides whether a host is
19483 the local host is described in section &<<SECTreclocipadd>>&.
19484
19485
19486 .option check_srv dnslookup string&!! unset
19487 .cindex "SRV record" "enabling use of"
19488 The &(dnslookup)& router supports the use of SRV records (see RFC 2782) in
19489 addition to MX and address records. The support is disabled by default. To
19490 enable SRV support, set the &%check_srv%& option to the name of the service
19491 required. For example,
19492 .code
19493 check_srv = smtp
19494 .endd
19495 looks for SRV records that refer to the normal smtp service. The option is
19496 expanded, so the service name can vary from message to message or address
19497 to address. This might be helpful if SRV records are being used for a
19498 submission service. If the expansion is forced to fail, the &%check_srv%&
19499 option is ignored, and the router proceeds to look for MX records in the
19500 normal way.
19501
19502 When the expansion succeeds, the router searches first for SRV records for
19503 the given service (it assumes TCP protocol). A single SRV record with a
19504 host name that consists of just a single dot indicates &"no such service for
19505 this domain"&; if this is encountered, the router declines. If other kinds of
19506 SRV record are found, they are used to construct a host list for delivery
19507 according to the rules of RFC 2782. MX records are not sought in this case.
19508
19509 When no SRV records are found, MX records (and address records) are sought in
19510 the traditional way. In other words, SRV records take precedence over MX
19511 records, just as MX records take precedence over address records. Note that
19512 this behaviour is not sanctioned by RFC 2782, though a previous draft RFC
19513 defined it. It is apparently believed that MX records are sufficient for email
19514 and that SRV records should not be used for this purpose. However, SRV records
19515 have an additional &"weight"& feature which some people might find useful when
19516 trying to split an SMTP load between hosts of different power.
19517
19518 See section &<<SECTprowitdnsloo>>& above for a discussion of Exim's behaviour
19519 when there is a DNS lookup error.
19520
19521
19522
19523
19524 .option fail_defer_domains dnslookup "domain list&!!" unset
19525 .cindex "MX record" "not found"
19526 DNS lookups for domains matching &%fail_defer_domains%&
19527 which find no matching record will cause the router to defer
19528 rather than the default behaviour of decline.
19529 This maybe be useful for queueing messages for a newly created
19530 domain while the DNS configuration is not ready.
19531 However, it will result in any message with mistyped domains
19532 also being queued.
19533
19534
19535 .option ipv4_only "string&!!" unset
19536 .cindex IPv6 disabling
19537 .cindex DNS "IPv6 disabling"
19538 The string is expanded, and if the result is anything but a forced failure,
19539 or an empty string, or one of the strings “0” or “no” or “false”
19540 (checked without regard to the case of the letters),
19541 only A records are used.
19542
19543 .option ipv4_prefer "string&!!" unset
19544 .cindex IPv4 preference
19545 .cindex DNS "IPv4 preference"
19546 The string is expanded, and if the result is anything but a forced failure,
19547 or an empty string, or one of the strings “0” or “no” or “false”
19548 (checked without regard to the case of the letters),
19549 A records are sorted before AAAA records (inverting the default).
19550
19551 .option mx_domains dnslookup "domain list&!!" unset
19552 .cindex "MX record" "required to exist"
19553 .cindex "SRV record" "required to exist"
19554 A domain that matches &%mx_domains%& is required to have either an MX or an SRV
19555 record in order to be recognized. (The name of this option could be improved.)
19556 For example, if all the mail hosts in &'fict.example'& are known to have MX
19557 records, except for those in &'discworld.fict.example'&, you could use this
19558 setting:
19559 .code
19560 mx_domains = ! *.discworld.fict.example : *.fict.example
19561 .endd
19562 This specifies that messages addressed to a domain that matches the list but
19563 has no MX record should be bounced immediately instead of being routed using
19564 the address record.
19565
19566
19567 .option mx_fail_domains dnslookup "domain list&!!" unset
19568 If the DNS lookup for MX records for one of the domains in this list causes a
19569 DNS lookup error, Exim behaves as if no MX records were found. See section
19570 &<<SECTprowitdnsloo>>& for more discussion.
19571
19572
19573
19574
19575 .option qualify_single dnslookup boolean true
19576 .cindex "DNS" "resolver options"
19577 .cindex "DNS" "qualifying single-component names"
19578 When this option is true, the resolver option RES_DEFNAMES is set for DNS
19579 lookups. Typically, but not standardly, this causes the resolver to qualify
19580 single-component names with the default domain. For example, on a machine
19581 called &'dictionary.ref.example'&, the domain &'thesaurus'& would be changed to
19582 &'thesaurus.ref.example'& inside the resolver. For details of what your
19583 resolver actually does, consult your man pages for &'resolver'& and
19584 &'resolv.conf'&.
19585
19586
19587
19588 .option rewrite_headers dnslookup boolean true
19589 .cindex "rewriting" "header lines"
19590 .cindex "header lines" "rewriting"
19591 If the domain name in the address that is being processed is not fully
19592 qualified, it may be expanded to its full form by a DNS lookup. For example, if
19593 an address is specified as &'dormouse@teaparty'&, the domain might be
19594 expanded to &'teaparty.wonderland.fict.example'&. Domain expansion can also
19595 occur as a result of setting the &%widen_domains%& option. If
19596 &%rewrite_headers%& is true, all occurrences of the abbreviated domain name in
19597 any &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-to:'&, &'Sender:'&, and &'To:'&
19598 header lines of the message are rewritten with the full domain name.
19599
19600 This option should be turned off only when it is known that no message is
19601 ever going to be sent outside an environment where the abbreviation makes
19602 sense.
19603
19604 When an MX record is looked up in the DNS and matches a wildcard record, name
19605 servers normally return a record containing the name that has been looked up,
19606 making it impossible to detect whether a wildcard was present or not. However,
19607 some name servers have recently been seen to return the wildcard entry. If the
19608 name returned by a DNS lookup begins with an asterisk, it is not used for
19609 header rewriting.
19610
19611
19612 .option same_domain_copy_routing dnslookup boolean false
19613 .cindex "address" "copying routing"
19614 Addresses with the same domain are normally routed by the &(dnslookup)& router
19615 to the same list of hosts. However, this cannot be presumed, because the router
19616 options and preconditions may refer to the local part of the address. By
19617 default, therefore, Exim routes each address in a message independently. DNS
19618 servers run caches, so repeated DNS lookups are not normally expensive, and in
19619 any case, personal messages rarely have more than a few recipients.
19620
19621 If you are running mailing lists with large numbers of subscribers at the same
19622 domain, and you are using a &(dnslookup)& router which is independent of the
19623 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
19624 lookups for identical domains in one message. In this case, when &(dnslookup)&
19625 routes an address to a remote transport, any other unrouted addresses in the
19626 message that have the same domain are automatically given the same routing
19627 without processing them independently,
19628 provided the following conditions are met:
19629
19630 .ilist
19631 No router that processed the address specified &%headers_add%& or
19632 &%headers_remove%&.
19633 .next
19634 The router did not change the address in any way, for example, by &"widening"&
19635 the domain.
19636 .endlist
19637
19638
19639
19640
19641 .option search_parents dnslookup boolean false
19642 .cindex "DNS" "resolver options"
19643 When this option is true, the resolver option RES_DNSRCH is set for DNS
19644 lookups. This is different from the &%qualify_single%& option in that it
19645 applies to domains containing dots. Typically, but not standardly, it causes
19646 the resolver to search for the name in the current domain and in parent
19647 domains. For example, on a machine in the &'fict.example'& domain, if looking
19648 up &'teaparty.wonderland'& failed, the resolver would try
19649 &'teaparty.wonderland.fict.example'&. For details of what your resolver
19650 actually does, consult your man pages for &'resolver'& and &'resolv.conf'&.
19651
19652 Setting this option true can cause problems in domains that have a wildcard MX
19653 record, because any domain that does not have its own MX record matches the
19654 local wildcard.
19655
19656
19657
19658 .option srv_fail_domains dnslookup "domain list&!!" unset
19659 If the DNS lookup for SRV records for one of the domains in this list causes a
19660 DNS lookup error, Exim behaves as if no SRV records were found. See section
19661 &<<SECTprowitdnsloo>>& for more discussion.
19662
19663
19664
19665
19666 .option widen_domains dnslookup "string list" unset
19667 .cindex "domain" "partial; widening"
19668 If a DNS lookup fails and this option is set, each of its strings in turn is
19669 added onto the end of the domain, and the lookup is tried again. For example,
19670 if
19671 .code
19672 widen_domains = fict.example:ref.example
19673 .endd
19674 is set and a lookup of &'klingon.dictionary'& fails,
19675 &'klingon.dictionary.fict.example'& is looked up, and if this fails,
19676 &'klingon.dictionary.ref.example'& is tried. Note that the &%qualify_single%&
19677 and &%search_parents%& options can cause some widening to be undertaken inside
19678 the DNS resolver. &%widen_domains%& is not applied to sender addresses
19679 when verifying, unless &%rewrite_headers%& is false (not the default).
19680
19681
19682 .section "Effect of qualify_single and search_parents" "SECID119"
19683 When a domain from an envelope recipient is changed by the resolver as a result
19684 of the &%qualify_single%& or &%search_parents%& options, Exim rewrites the
19685 corresponding address in the message's header lines unless &%rewrite_headers%&
19686 is set false. Exim then re-routes the address, using the full domain.
19687
19688 These two options affect only the DNS lookup that takes place inside the router
19689 for the domain of the address that is being routed. They do not affect lookups
19690 such as that implied by
19691 .code
19692 domains = @mx_any
19693 .endd
19694 that may happen while processing a router precondition before the router is
19695 entered. No widening ever takes place for these lookups.
19696 .ecindex IIDdnsrou1
19697 .ecindex IIDdnsrou2
19698
19699
19700
19701
19702
19703
19704
19705
19706
19707 . ////////////////////////////////////////////////////////////////////////////
19708 . ////////////////////////////////////////////////////////////////////////////
19709
19710 .chapter "The ipliteral router" "CHID5"
19711 .cindex "&(ipliteral)& router"
19712 .cindex "domain literal" "routing"
19713 .cindex "routers" "&(ipliteral)&"
19714 This router has no private options. Unless it is being used purely for
19715 verification (see &%verify_only%&) a transport is required to be defined by the
19716 generic &%transport%& option. The router accepts the address if its domain part
19717 takes the form of an RFC 2822 domain literal. For example, the &(ipliteral)&
19718 router handles the address
19719 .code
19720 root@[192.168.1.1]
19721 .endd
19722 by setting up delivery to the host with that IP address. IPv4 domain literals
19723 consist of an IPv4 address enclosed in square brackets. IPv6 domain literals
19724 are similar, but the address is preceded by &`ipv6:`&. For example:
19725 .code
19726 postmaster@[ipv6:fe80::a00:20ff:fe86:a061.5678]
19727 .endd
19728 Exim allows &`ipv4:`& before IPv4 addresses, for consistency, and on the
19729 grounds that sooner or later somebody will try it.
19730
19731 .oindex "&%self%&" "in &(ipliteral)& router"
19732 If the IP address matches something in &%ignore_target_hosts%&, the router
19733 declines. If an IP literal turns out to refer to the local host, the generic
19734 &%self%& option determines what happens.
19735
19736 The RFCs require support for domain literals; however, their use is
19737 controversial in today's Internet. If you want to use this router, you must
19738 also set the main configuration option &%allow_domain_literals%&. Otherwise,
19739 Exim will not recognize the domain literal syntax in addresses.
19740
19741
19742
19743 . ////////////////////////////////////////////////////////////////////////////
19744 . ////////////////////////////////////////////////////////////////////////////
19745
19746 .chapter "The iplookup router" "CHID6"
19747 .cindex "&(iplookup)& router"
19748 .cindex "routers" "&(iplookup)&"
19749 The &(iplookup)& router was written to fulfil a specific requirement in
19750 Cambridge University (which in fact no longer exists). For this reason, it is
19751 not included in the binary of Exim by default. If you want to include it, you
19752 must set
19753 .code
19754 ROUTER_IPLOOKUP=yes
19755 .endd
19756 in your &_Local/Makefile_& configuration file.
19757
19758 The &(iplookup)& router routes an address by sending it over a TCP or UDP
19759 connection to one or more specific hosts. The host can then return the same or
19760 a different address &-- in effect rewriting the recipient address in the
19761 message's envelope. The new address is then passed on to subsequent routers. If
19762 this process fails, the address can be passed on to other routers, or delivery
19763 can be deferred. Since &(iplookup)& is just a rewriting router, a transport
19764 must not be specified for it.
19765
19766 .cindex "options" "&(iplookup)& router"
19767 .option hosts iplookup string unset
19768 This option must be supplied. Its value is a colon-separated list of host
19769 names. The hosts are looked up using &[gethostbyname()]&
19770 (or &[getipnodebyname()]& when available)
19771 and are tried in order until one responds to the query. If none respond, what
19772 happens is controlled by &%optional%&.
19773
19774
19775 .option optional iplookup boolean false
19776 If &%optional%& is true, if no response is obtained from any host, the address
19777 is passed to the next router, overriding &%no_more%&. If &%optional%& is false,
19778 delivery to the address is deferred.
19779
19780
19781 .option port iplookup integer 0
19782 .cindex "port" "&(iplookup)& router"
19783 This option must be supplied. It specifies the port number for the TCP or UDP
19784 call.
19785
19786
19787 .option protocol iplookup string udp
19788 This option can be set to &"udp"& or &"tcp"& to specify which of the two
19789 protocols is to be used.
19790
19791
19792 .option query iplookup string&!! "see below"
19793 This defines the content of the query that is sent to the remote hosts. The
19794 default value is:
19795 .code
19796 $local_part@$domain $local_part@$domain
19797 .endd
19798 The repetition serves as a way of checking that a response is to the correct
19799 query in the default case (see &%response_pattern%& below).
19800
19801
19802 .option reroute iplookup string&!! unset
19803 If this option is not set, the rerouted address is precisely the byte string
19804 returned by the remote host, up to the first white space, if any. If set, the
19805 string is expanded to form the rerouted address. It can include parts matched
19806 in the response by &%response_pattern%& by means of numeric variables such as
19807 &$1$&, &$2$&, etc. The variable &$0$& refers to the entire input string,
19808 whether or not a pattern is in use. In all cases, the rerouted address must end
19809 up in the form &'local_part@domain'&.
19810
19811
19812 .option response_pattern iplookup string unset
19813 This option can be set to a regular expression that is applied to the string
19814 returned from the remote host. If the pattern does not match the response, the
19815 router declines. If &%response_pattern%& is not set, no checking of the
19816 response is done, unless the query was defaulted, in which case there is a
19817 check that the text returned after the first white space is the original
19818 address. This checks that the answer that has been received is in response to
19819 the correct question. For example, if the response is just a new domain, the
19820 following could be used:
19821 .code
19822 response_pattern = ^([^@]+)$
19823 reroute = $local_part@$1
19824 .endd
19825
19826 .option timeout iplookup time 5s
19827 This specifies the amount of time to wait for a response from the remote
19828 machine. The same timeout is used for the &[connect()]& function for a TCP
19829 call. It does not apply to UDP.
19830
19831
19832
19833
19834 . ////////////////////////////////////////////////////////////////////////////
19835 . ////////////////////////////////////////////////////////////////////////////
19836
19837 .chapter "The manualroute router" "CHID7"
19838 .scindex IIDmanrou1 "&(manualroute)& router"
19839 .scindex IIDmanrou2 "routers" "&(manualroute)&"
19840 .cindex "domain" "manually routing"
19841 The &(manualroute)& router is so-called because it provides a way of manually
19842 routing an address according to its domain. It is mainly used when you want to
19843 route addresses to remote hosts according to your own rules, bypassing the
19844 normal DNS routing that looks up MX records. However, &(manualroute)& can also
19845 route to local transports, a facility that may be useful if you want to save
19846 messages for dial-in hosts in local files.
19847
19848 The &(manualroute)& router compares a list of domain patterns with the domain
19849 it is trying to route. If there is no match, the router declines. Each pattern
19850 has associated with it a list of hosts and some other optional data, which may
19851 include a transport. The combination of a pattern and its data is called a
19852 &"routing rule"&. For patterns that do not have an associated transport, the
19853 generic &%transport%& option must specify a transport, unless the router is
19854 being used purely for verification (see &%verify_only%&).
19855
19856 .vindex "&$host$&"
19857 In the case of verification, matching the domain pattern is sufficient for the
19858 router to accept the address. When actually routing an address for delivery,
19859 an address that matches a domain pattern is queued for the associated
19860 transport. If the transport is not a local one, a host list must be associated
19861 with the pattern; IP addresses are looked up for the hosts, and these are
19862 passed to the transport along with the mail address. For local transports, a
19863 host list is optional. If it is present, it is passed in &$host$& as a single
19864 text string.
19865
19866 The list of routing rules can be provided as an inline string in
19867 &%route_list%&, or the data can be obtained by looking up the domain in a file
19868 or database by setting &%route_data%&. Only one of these settings may appear in
19869 any one instance of &(manualroute)&. The format of routing rules is described
19870 below, following the list of private options.
19871
19872
19873 .section "Private options for manualroute" "SECTprioptman"
19874
19875 .cindex "options" "&(manualroute)& router"
19876 The private options for the &(manualroute)& router are as follows:
19877
19878 .option host_all_ignored manualroute string defer
19879 See &%host_find_failed%&.
19880
19881 .option host_find_failed manualroute string freeze
19882 This option controls what happens when &(manualroute)& tries to find an IP
19883 address for a host, and the host does not exist. The option can be set to one
19884 of the following values:
19885 .code
19886 decline
19887 defer
19888 fail
19889 freeze
19890 ignore
19891 pass
19892 .endd
19893 The default (&"freeze"&) assumes that this state is a serious configuration
19894 error. The difference between &"pass"& and &"decline"& is that the former
19895 forces the address to be passed to the next router (or the router defined by
19896 &%pass_router%&),
19897 .oindex "&%more%&"
19898 overriding &%no_more%&, whereas the latter passes the address to the next
19899 router only if &%more%& is true.
19900
19901 The value &"ignore"& causes Exim to completely ignore a host whose IP address
19902 cannot be found. If all the hosts in the list are ignored, the behaviour is
19903 controlled by the &%host_all_ignored%& option. This takes the same values
19904 as &%host_find_failed%&, except that it cannot be set to &"ignore"&.
19905
19906 The &%host_find_failed%& option applies only to a definite &"does not exist"&
19907 state; if a host lookup gets a temporary error, delivery is deferred unless the
19908 generic &%pass_on_timeout%& option is set.
19909
19910
19911 .option hosts_randomize manualroute boolean false
19912 .cindex "randomized host list"
19913 .cindex "host" "list of; randomized"
19914 If this option is set, the order of the items in a host list in a routing rule
19915 is randomized each time the list is used, unless an option in the routing rule
19916 overrides (see below). Randomizing the order of a host list can be used to do
19917 crude load sharing. However, if more than one mail address is routed by the
19918 same router to the same host list, the host lists are considered to be the same
19919 (even though they may be randomized into different orders) for the purpose of
19920 deciding whether to batch the deliveries into a single SMTP transaction.
19921
19922 When &%hosts_randomize%& is true, a host list may be split
19923 into groups whose order is separately randomized. This makes it possible to
19924 set up MX-like behaviour. The boundaries between groups are indicated by an
19925 item that is just &`+`& in the host list. For example:
19926 .code
19927 route_list = * host1:host2:host3:+:host4:host5
19928 .endd
19929 The order of the first three hosts and the order of the last two hosts is
19930 randomized for each use, but the first three always end up before the last two.
19931 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored. If a
19932 randomized host list is passed to an &(smtp)& transport that also has
19933 &%hosts_randomize set%&, the list is not re-randomized.
19934
19935
19936 .option route_data manualroute string&!! unset
19937 If this option is set, it must expand to yield the data part of a routing rule.
19938 Typically, the expansion string includes a lookup based on the domain. For
19939 example:
19940 .code
19941 route_data = ${lookup{$domain}dbm{/etc/routes}}
19942 .endd
19943 If the expansion is forced to fail, or the result is an empty string, the
19944 router declines. Other kinds of expansion failure cause delivery to be
19945 deferred.
19946
19947
19948 .option route_list manualroute "string list" unset
19949 This string is a list of routing rules, in the form defined below. Note that,
19950 unlike most string lists, the items are separated by semicolons. This is so
19951 that they may contain colon-separated host lists.
19952
19953
19954 .option same_domain_copy_routing manualroute boolean false
19955 .cindex "address" "copying routing"
19956 Addresses with the same domain are normally routed by the &(manualroute)&
19957 router to the same list of hosts. However, this cannot be presumed, because the
19958 router options and preconditions may refer to the local part of the address. By
19959 default, therefore, Exim routes each address in a message independently. DNS
19960 servers run caches, so repeated DNS lookups are not normally expensive, and in
19961 any case, personal messages rarely have more than a few recipients.
19962
19963 If you are running mailing lists with large numbers of subscribers at the same
19964 domain, and you are using a &(manualroute)& router which is independent of the
19965 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
19966 lookups for identical domains in one message. In this case, when
19967 &(manualroute)& routes an address to a remote transport, any other unrouted
19968 addresses in the message that have the same domain are automatically given the
19969 same routing without processing them independently. However, this is only done
19970 if &%headers_add%& and &%headers_remove%& are unset.
19971
19972
19973
19974
19975 .section "Routing rules in route_list" "SECID120"
19976 The value of &%route_list%& is a string consisting of a sequence of routing
19977 rules, separated by semicolons. If a semicolon is needed in a rule, it can be
19978 entered as two semicolons. Alternatively, the list separator can be changed as
19979 described (for colon-separated lists) in section &<<SECTlistconstruct>>&.
19980 Empty rules are ignored. The format of each rule is
19981 .display
19982 <&'domain pattern'&>  <&'list of hosts'&>  <&'options'&>
19983 .endd
19984 The following example contains two rules, each with a simple domain pattern and
19985 no options:
19986 .code
19987 route_list = \
19988   dict.ref.example  mail-1.ref.example:mail-2.ref.example ; \
19989   thes.ref.example  mail-3.ref.example:mail-4.ref.example
19990 .endd
19991 The three parts of a rule are separated by white space. The pattern and the
19992 list of hosts can be enclosed in quotes if necessary, and if they are, the
19993 usual quoting rules apply. Each rule in a &%route_list%& must start with a
19994 single domain pattern, which is the only mandatory item in the rule. The
19995 pattern is in the same format as one item in a domain list (see section
19996 &<<SECTdomainlist>>&),
19997 except that it may not be the name of an interpolated file.
19998 That is, it may be wildcarded, or a regular expression, or a file or database
19999 lookup (with semicolons doubled, because of the use of semicolon as a separator
20000 in a &%route_list%&).
20001
20002 The rules in &%route_list%& are searched in order until one of the patterns
20003 matches the domain that is being routed. The list of hosts and then options are
20004 then used as described below. If there is no match, the router declines. When
20005 &%route_list%& is set, &%route_data%& must not be set.
20006
20007
20008
20009 .section "Routing rules in route_data" "SECID121"
20010 The use of &%route_list%& is convenient when there are only a small number of
20011 routing rules. For larger numbers, it is easier to use a file or database to
20012 hold the routing information, and use the &%route_data%& option instead.
20013 The value of &%route_data%& is a list of hosts, followed by (optional) options.
20014 Most commonly, &%route_data%& is set as a string that contains an
20015 expansion lookup. For example, suppose we place two routing rules in a file
20016 like this:
20017 .code
20018 dict.ref.example:  mail-1.ref.example:mail-2.ref.example
20019 thes.ref.example:  mail-3.ref.example:mail-4.ref.example
20020 .endd
20021 This data can be accessed by setting
20022 .code
20023 route_data = ${lookup{$domain}lsearch{/the/file/name}}
20024 .endd
20025 Failure of the lookup results in an empty string, causing the router to
20026 decline. However, you do not have to use a lookup in &%route_data%&. The only
20027 requirement is that the result of expanding the string is a list of hosts,
20028 possibly followed by options, separated by white space. The list of hosts must
20029 be enclosed in quotes if it contains white space.
20030
20031
20032
20033
20034 .section "Format of the list of hosts" "SECID122"
20035 A list of hosts, whether obtained via &%route_data%& or &%route_list%&, is
20036 always separately expanded before use. If the expansion fails, the router
20037 declines. The result of the expansion must be a colon-separated list of names
20038 and/or IP addresses, optionally also including ports.
20039 If the list is written with spaces, it must be protected with quotes.
20040 The format of each item
20041 in the list is described in the next section. The list separator can be changed
20042 as described in section &<<SECTlistsepchange>>&.
20043
20044 If the list of hosts was obtained from a &%route_list%& item, the following
20045 variables are set during its expansion:
20046
20047 .ilist
20048 .cindex "numerical variables (&$1$& &$2$&  etc)" "in &(manualroute)& router"
20049 If the domain was matched against a regular expression, the numeric variables
20050 &$1$&, &$2$&, etc. may be set. For example:
20051 .code
20052 route_list = ^domain(\d+)   host-$1.text.example
20053 .endd
20054 .next
20055 &$0$& is always set to the entire domain.
20056 .next
20057 &$1$& is also set when partial matching is done in a file lookup.
20058
20059 .next
20060 .vindex "&$value$&"
20061 If the pattern that matched the domain was a lookup item, the data that was
20062 looked up is available in the expansion variable &$value$&. For example:
20063 .code
20064 route_list = lsearch;;/some/file.routes  $value
20065 .endd
20066 .endlist
20067
20068 Note the doubling of the semicolon in the pattern that is necessary because
20069 semicolon is the default route list separator.
20070
20071
20072
20073 .section "Format of one host item" "SECTformatonehostitem"
20074 Each item in the list of hosts is either a host name or an IP address,
20075 optionally with an attached port number. When no port is given, an IP address
20076 is not enclosed in brackets. When a port is specified, it overrides the port
20077 specification on the transport. The port is separated from the name or address
20078 by a colon. This leads to some complications:
20079
20080 .ilist
20081 Because colon is the default separator for the list of hosts, either
20082 the colon that specifies a port must be doubled, or the list separator must
20083 be changed. The following two examples have the same effect:
20084 .code
20085 route_list = * "host1.tld::1225 : host2.tld::1226"
20086 route_list = * "<+ host1.tld:1225 + host2.tld:1226"
20087 .endd
20088 .next
20089 When IPv6 addresses are involved, it gets worse, because they contain
20090 colons of their own. To make this case easier, it is permitted to
20091 enclose an IP address (either v4 or v6) in square brackets if a port
20092 number follows. For example:
20093 .code
20094 route_list = * "</ [10.1.1.1]:1225 / [::1]:1226"
20095 .endd
20096 .endlist
20097
20098 .section "How the list of hosts is used" "SECThostshowused"
20099 When an address is routed to an &(smtp)& transport by &(manualroute)&, each of
20100 the hosts is tried, in the order specified, when carrying out the SMTP
20101 delivery. However, the order can be changed by setting the &%hosts_randomize%&
20102 option, either on the router (see section &<<SECTprioptman>>& above), or on the
20103 transport.
20104
20105 Hosts may be listed by name or by IP address. An unadorned name in the list of
20106 hosts is interpreted as a host name. A name that is followed by &`/MX`& is
20107 interpreted as an indirection to a sublist of hosts obtained by looking up MX
20108 records in the DNS. For example:
20109 .code
20110 route_list = *  x.y.z:p.q.r/MX:e.f.g
20111 .endd
20112 If this feature is used with a port specifier, the port must come last. For
20113 example:
20114 .code
20115 route_list = *  dom1.tld/mx::1225
20116 .endd
20117 If the &%hosts_randomize%& option is set, the order of the items in the list is
20118 randomized before any lookups are done. Exim then scans the list; for any name
20119 that is not followed by &`/MX`& it looks up an IP address. If this turns out to
20120 be an interface on the local host and the item is not the first in the list,
20121 Exim discards it and any subsequent items. If it is the first item, what
20122 happens is controlled by the
20123 .oindex "&%self%&" "in &(manualroute)& router"
20124 &%self%& option of the router.
20125
20126 A name on the list that is followed by &`/MX`& is replaced with the list of
20127 hosts obtained by looking up MX records for the name. This is always a DNS
20128 lookup; the &%bydns%& and &%byname%& options (see section &<<SECThowoptused>>&
20129 below) are not relevant here. The order of these hosts is determined by the
20130 preference values in the MX records, according to the usual rules. Because
20131 randomizing happens before the MX lookup, it does not affect the order that is
20132 defined by MX preferences.
20133
20134 If the local host is present in the sublist obtained from MX records, but is
20135 not the most preferred host in that list, it and any equally or less
20136 preferred hosts are removed before the sublist is inserted into the main list.
20137
20138 If the local host is the most preferred host in the MX list, what happens
20139 depends on where in the original list of hosts the &`/MX`& item appears. If it
20140 is not the first item (that is, there are previous hosts in the main list),
20141 Exim discards this name and any subsequent items in the main list.
20142
20143 If the MX item is first in the list of hosts, and the local host is the
20144 most preferred host, what happens is controlled by the &%self%& option of the
20145 router.
20146
20147 DNS failures when lookup up the MX records are treated in the same way as DNS
20148 failures when looking up IP addresses: &%pass_on_timeout%& and
20149 &%host_find_failed%& are used when relevant.
20150
20151 The generic &%ignore_target_hosts%& option applies to all hosts in the list,
20152 whether obtained from an MX lookup or not.
20153
20154
20155
20156 .section "How the options are used" "SECThowoptused"
20157 The options are a sequence of words, space-separated.
20158 One of the words can be the name of a transport; this overrides the
20159 &%transport%& option on the router for this particular routing rule only. The
20160 other words (if present) control randomization of the list of hosts on a
20161 per-rule basis, and how the IP addresses of the hosts are to be found when
20162 routing to a remote transport. These options are as follows:
20163
20164 .ilist
20165 &%randomize%&: randomize the order of the hosts in this list, overriding the
20166 setting of &%hosts_randomize%& for this routing rule only.
20167 .next
20168 &%no_randomize%&: do not randomize the order of the hosts in this list,
20169 overriding the setting of &%hosts_randomize%& for this routing rule only.
20170 .next
20171 &%byname%&: use &[getipnodebyname()]& (&[gethostbyname()]& on older systems) to
20172 find IP addresses. This function may ultimately cause a DNS lookup, but it may
20173 also look in &_/etc/hosts_& or other sources of information.
20174 .next
20175 &%bydns%&: look up address records for the hosts directly in the DNS; fail if
20176 no address records are found. If there is a temporary DNS error (such as a
20177 timeout), delivery is deferred.
20178 .next
20179 &%ipv4_only%&: in direct DNS lookups, look up only A records.
20180 .next
20181 &%ipv4_prefer%&: in direct DNS lookups, sort A records before AAAA records.
20182 .endlist
20183
20184 For example:
20185 .code
20186 route_list = domain1  host1:host2:host3  randomize bydns;\
20187              domain2  host4:host5
20188 .endd
20189 If neither &%byname%& nor &%bydns%& is given, Exim behaves as follows: First, a
20190 DNS lookup is done. If this yields anything other than HOST_NOT_FOUND, that
20191 result is used. Otherwise, Exim goes on to try a call to &[getipnodebyname()]&
20192 or &[gethostbyname()]&, and the result of the lookup is the result of that
20193 call.
20194
20195 &*Warning*&: It has been discovered that on some systems, if a DNS lookup
20196 called via &[getipnodebyname()]& times out, HOST_NOT_FOUND is returned
20197 instead of TRY_AGAIN. That is why the default action is to try a DNS
20198 lookup first. Only if that gives a definite &"no such host"& is the local
20199 function called.
20200
20201 &*Compatibility*&: From Exim 4.85 until fixed for 4.90, there was an
20202 inadvertent constraint that a transport name as an option had to be the last
20203 option specified.
20204
20205
20206
20207 If no IP address for a host can be found, what happens is controlled by the
20208 &%host_find_failed%& option.
20209
20210 .vindex "&$host$&"
20211 When an address is routed to a local transport, IP addresses are not looked up.
20212 The host list is passed to the transport in the &$host$& variable.
20213
20214
20215
20216 .section "Manualroute examples" "SECID123"
20217 In some of the examples that follow, the presence of the &%remote_smtp%&
20218 transport, as defined in the default configuration file, is assumed:
20219
20220 .ilist
20221 .cindex "smart host" "example router"
20222 The &(manualroute)& router can be used to forward all external mail to a
20223 &'smart host'&. If you have set up, in the main part of the configuration, a
20224 named domain list that contains your local domains, for example:
20225 .code
20226 domainlist local_domains = my.domain.example
20227 .endd
20228 You can arrange for all other domains to be routed to a smart host by making
20229 your first router something like this:
20230 .code
20231 smart_route:
20232   driver = manualroute
20233   domains = !+local_domains
20234   transport = remote_smtp
20235   route_list = * smarthost.ref.example
20236 .endd
20237 This causes all non-local addresses to be sent to the single host
20238 &'smarthost.ref.example'&. If a colon-separated list of smart hosts is given,
20239 they are tried in order
20240 (but you can use &%hosts_randomize%& to vary the order each time).
20241 Another way of configuring the same thing is this:
20242 .code
20243 smart_route:
20244   driver = manualroute
20245   transport = remote_smtp
20246   route_list = !+local_domains  smarthost.ref.example
20247 .endd
20248 There is no difference in behaviour between these two routers as they stand.
20249 However, they behave differently if &%no_more%& is added to them. In the first
20250 example, the router is skipped if the domain does not match the &%domains%&
20251 precondition; the following router is always tried. If the router runs, it
20252 always matches the domain and so can never decline. Therefore, &%no_more%&
20253 would have no effect. In the second case, the router is never skipped; it
20254 always runs. However, if it doesn't match the domain, it declines. In this case
20255 &%no_more%& would prevent subsequent routers from running.
20256
20257 .next
20258 .cindex "mail hub example"
20259 A &'mail hub'& is a host which receives mail for a number of domains via MX
20260 records in the DNS and delivers it via its own private routing mechanism. Often
20261 the final destinations are behind a firewall, with the mail hub being the one
20262 machine that can connect to machines both inside and outside the firewall. The
20263 &(manualroute)& router is usually used on a mail hub to route incoming messages
20264 to the correct hosts. For a small number of domains, the routing can be inline,
20265 using the &%route_list%& option, but for a larger number a file or database
20266 lookup is easier to manage.
20267
20268 If the domain names are in fact the names of the machines to which the mail is
20269 to be sent by the mail hub, the configuration can be quite simple. For
20270 example:
20271 .code
20272 hub_route:
20273   driver = manualroute
20274   transport = remote_smtp
20275   route_list = *.rhodes.tvs.example  $domain
20276 .endd
20277 This configuration routes domains that match &`*.rhodes.tvs.example`& to hosts
20278 whose names are the same as the mail domains. A similar approach can be taken
20279 if the host name can be obtained from the domain name by a string manipulation
20280 that the expansion facilities can handle. Otherwise, a lookup based on the
20281 domain can be used to find the host:
20282 .code
20283 through_firewall:
20284   driver = manualroute
20285   transport = remote_smtp
20286   route_data = ${lookup {$domain} cdb {/internal/host/routes}}
20287 .endd
20288 The result of the lookup must be the name or IP address of the host (or
20289 hosts) to which the address is to be routed. If the lookup fails, the route
20290 data is empty, causing the router to decline. The address then passes to the
20291 next router.
20292
20293 .next
20294 .cindex "batched SMTP output example"
20295 .cindex "SMTP" "batched outgoing; example"
20296 You can use &(manualroute)& to deliver messages to pipes or files in batched
20297 SMTP format for onward transportation by some other means. This is one way of
20298 storing mail for a dial-up host when it is not connected. The route list entry
20299 can be as simple as a single domain name in a configuration like this:
20300 .code
20301 save_in_file:
20302   driver = manualroute
20303   transport = batchsmtp_appendfile
20304   route_list = saved.domain.example
20305 .endd
20306 though often a pattern is used to pick up more than one domain. If there are
20307 several domains or groups of domains with different transport requirements,
20308 different transports can be listed in the routing information:
20309 .code
20310 save_in_file:
20311   driver = manualroute
20312   route_list = \
20313     *.saved.domain1.example  $domain  batch_appendfile; \
20314     *.saved.domain2.example  \
20315       ${lookup{$domain}dbm{/domain2/hosts}{$value}fail} \
20316       batch_pipe
20317 .endd
20318 .vindex "&$domain$&"
20319 .vindex "&$host$&"
20320 The first of these just passes the domain in the &$host$& variable, which
20321 doesn't achieve much (since it is also in &$domain$&), but the second does a
20322 file lookup to find a value to pass, causing the router to decline to handle
20323 the address if the lookup fails.
20324
20325 .next
20326 .cindex "UUCP" "example of router for"
20327 Routing mail directly to UUCP software is a specific case of the use of
20328 &(manualroute)& in a gateway to another mail environment. This is an example of
20329 one way it can be done:
20330 .code
20331 # Transport
20332 uucp:
20333   driver = pipe
20334   user = nobody
20335   command = /usr/local/bin/uux -r - \
20336     ${substr_-5:$host}!rmail ${local_part}
20337   return_fail_output = true
20338
20339 # Router
20340 uucphost:
20341   transport = uucp
20342   driver = manualroute
20343   route_data = \
20344     ${lookup{$domain}lsearch{/usr/local/exim/uucphosts}}
20345 .endd
20346 The file &_/usr/local/exim/uucphosts_& contains entries like
20347 .code
20348 darksite.ethereal.example:           darksite.UUCP
20349 .endd
20350 It can be set up more simply without adding and removing &".UUCP"& but this way
20351 makes clear the distinction between the domain name
20352 &'darksite.ethereal.example'& and the UUCP host name &'darksite'&.
20353 .endlist
20354 .ecindex IIDmanrou1
20355 .ecindex IIDmanrou2
20356
20357
20358
20359
20360
20361
20362
20363
20364 . ////////////////////////////////////////////////////////////////////////////
20365 . ////////////////////////////////////////////////////////////////////////////
20366
20367 .chapter "The queryprogram router" "CHAPdriverlast"
20368 .scindex IIDquerou1 "&(queryprogram)& router"
20369 .scindex IIDquerou2 "routers" "&(queryprogram)&"
20370 .cindex "routing" "by external program"
20371 The &(queryprogram)& router routes an address by running an external command
20372 and acting on its output. This is an expensive way to route, and is intended
20373 mainly for use in lightly-loaded systems, or for performing experiments.
20374 However, if it is possible to use the precondition options (&%domains%&,
20375 &%local_parts%&, etc) to skip this router for most addresses, it could sensibly
20376 be used in special cases, even on a busy host. There are the following private
20377 options:
20378 .cindex "options" "&(queryprogram)& router"
20379
20380 .option command queryprogram string&!! unset
20381 This option must be set. It specifies the command that is to be run. The
20382 command is split up into a command name and arguments, and then each is
20383 expanded separately (exactly as for a &(pipe)& transport, described in chapter
20384 &<<CHAPpipetransport>>&).
20385
20386
20387 .option command_group queryprogram string unset
20388 .cindex "gid (group id)" "in &(queryprogram)& router"
20389 This option specifies a gid to be set when running the command while routing an
20390 address for deliver. It must be set if &%command_user%& specifies a numerical
20391 uid. If it begins with a digit, it is interpreted as the numerical value of the
20392 gid. Otherwise it is looked up using &[getgrnam()]&.
20393
20394
20395 .option command_user queryprogram string unset
20396 .cindex "uid (user id)" "for &(queryprogram)&"
20397 This option must be set. It specifies the uid which is set when running the
20398 command while routing an address for delivery. If the value begins with a digit,
20399 it is interpreted as the numerical value of the uid. Otherwise, it is looked up
20400 using &[getpwnam()]& to obtain a value for the uid and, if &%command_group%& is
20401 not set, a value for the gid also.
20402
20403 &*Warning:*& Changing uid and gid is possible only when Exim is running as
20404 root, which it does during a normal delivery in a conventional configuration.
20405 However, when an address is being verified during message reception, Exim is
20406 usually running as the Exim user, not as root. If the &(queryprogram)& router
20407 is called from a non-root process, Exim cannot change uid or gid before running
20408 the command. In this circumstance the command runs under the current uid and
20409 gid.
20410
20411
20412 .option current_directory queryprogram string /
20413 This option specifies an absolute path which is made the current directory
20414 before running the command.
20415
20416
20417 .option timeout queryprogram time 1h
20418 If the command does not complete within the timeout period, its process group
20419 is killed and the message is frozen. A value of zero time specifies no
20420 timeout.
20421
20422
20423 The standard output of the command is connected to a pipe, which is read when
20424 the command terminates. It should consist of a single line of output,
20425 containing up to five fields, separated by white space. The maximum length of
20426 the line is 1023 characters. Longer lines are silently truncated. The first
20427 field is one of the following words (case-insensitive):
20428
20429 .ilist
20430 &'Accept'&: routing succeeded; the remaining fields specify what to do (see
20431 below).
20432 .next
20433 &'Decline'&: the router declines; pass the address to the next router, unless
20434 &%no_more%& is set.
20435 .next
20436 &'Fail'&: routing failed; do not pass the address to any more routers. Any
20437 subsequent text on the line is an error message. If the router is run as part
20438 of address verification during an incoming SMTP message, the message is
20439 included in the SMTP response.
20440 .next
20441 &'Defer'&: routing could not be completed at this time; try again later. Any
20442 subsequent text on the line is an error message which is logged. It is not
20443 included in any SMTP response.
20444 .next
20445 &'Freeze'&: the same as &'defer'&, except that the message is frozen.
20446 .next
20447 &'Pass'&: pass the address to the next router (or the router specified by
20448 &%pass_router%&), overriding &%no_more%&.
20449 .next
20450 &'Redirect'&: the message is redirected. The remainder of the line is a list of
20451 new addresses, which are routed independently, starting with the first router,
20452 or the router specified by &%redirect_router%&, if set.
20453 .endlist
20454
20455 When the first word is &'accept'&, the remainder of the line consists of a
20456 number of keyed data values, as follows (split into two lines here, to fit on
20457 the page):
20458 .code
20459 ACCEPT TRANSPORT=<transport> HOSTS=<list of hosts>
20460 LOOKUP=byname|bydns DATA=<text>
20461 .endd
20462 The data items can be given in any order, and all are optional. If no transport
20463 is included, the transport specified by the generic &%transport%& option is
20464 used. The list of hosts and the lookup type are needed only if the transport is
20465 an &(smtp)& transport that does not itself supply a list of hosts.
20466
20467 The format of the list of hosts is the same as for the &(manualroute)& router.
20468 As well as host names and IP addresses with optional port numbers, as described
20469 in section &<<SECTformatonehostitem>>&, it may contain names followed by
20470 &`/MX`& to specify sublists of hosts that are obtained by looking up MX records
20471 (see section &<<SECThostshowused>>&).
20472
20473 If the lookup type is not specified, Exim behaves as follows when trying to
20474 find an IP address for each host: First, a DNS lookup is done. If this yields
20475 anything other than HOST_NOT_FOUND, that result is used. Otherwise, Exim
20476 goes on to try a call to &[getipnodebyname()]& or &[gethostbyname()]&, and the
20477 result of the lookup is the result of that call.
20478
20479 .vindex "&$address_data$&"
20480 If the DATA field is set, its value is placed in the &$address_data$&
20481 variable. For example, this return line
20482 .code
20483 accept hosts=x1.y.example:x2.y.example data="rule1"
20484 .endd
20485 routes the address to the default transport, passing a list of two hosts. When
20486 the transport runs, the string &"rule1"& is in &$address_data$&.
20487 .ecindex IIDquerou1
20488 .ecindex IIDquerou2
20489
20490
20491
20492
20493 . ////////////////////////////////////////////////////////////////////////////
20494 . ////////////////////////////////////////////////////////////////////////////
20495
20496 .chapter "The redirect router" "CHAPredirect"
20497 .scindex IIDredrou1 "&(redirect)& router"
20498 .scindex IIDredrou2 "routers" "&(redirect)&"
20499 .cindex "alias file" "in a &(redirect)& router"
20500 .cindex "address redirection" "&(redirect)& router"
20501 The &(redirect)& router handles several kinds of address redirection. Its most
20502 common uses are for resolving local part aliases from a central alias file
20503 (usually called &_/etc/aliases_&) and for handling users' personal &_.forward_&
20504 files, but it has many other potential uses. The incoming address can be
20505 redirected in several different ways:
20506
20507 .ilist
20508 It can be replaced by one or more new addresses which are themselves routed
20509 independently.
20510 .next
20511 It can be routed to be delivered to a given file or directory.
20512 .next
20513 It can be routed to be delivered to a specified pipe command.
20514 .next
20515 It can cause an automatic reply to be generated.
20516 .next
20517 It can be forced to fail, optionally with a custom error message.
20518 .next
20519 It can be temporarily deferred, optionally with a custom message.
20520 .next
20521 It can be discarded.
20522 .endlist
20523
20524 The generic &%transport%& option must not be set for &(redirect)& routers.
20525 However, there are some private options which define transports for delivery to
20526 files and pipes, and for generating autoreplies. See the &%file_transport%&,
20527 &%pipe_transport%& and &%reply_transport%& descriptions below.
20528
20529 If success DSNs have been requested
20530 .cindex "DSN" "success"
20531 .cindex "Delivery Status Notification" "success"
20532 redirection triggers one and the DSN options are not passed any further.
20533
20534
20535
20536 .section "Redirection data" "SECID124"
20537 The router operates by interpreting a text string which it obtains either by
20538 expanding the contents of the &%data%& option, or by reading the entire
20539 contents of a file whose name is given in the &%file%& option. These two
20540 options are mutually exclusive. The first is commonly used for handling system
20541 aliases, in a configuration like this:
20542 .code
20543 system_aliases:
20544   driver = redirect
20545   data = ${lookup{$local_part}lsearch{/etc/aliases}}
20546 .endd
20547 If the lookup fails, the expanded string in this example is empty. When the
20548 expansion of &%data%& results in an empty string, the router declines. A forced
20549 expansion failure also causes the router to decline; other expansion failures
20550 cause delivery to be deferred.
20551
20552 A configuration using &%file%& is commonly used for handling users'
20553 &_.forward_& files, like this:
20554 .code
20555 userforward:
20556   driver = redirect
20557   check_local_user
20558   file = $home/.forward
20559   no_verify
20560 .endd
20561 If the file does not exist, or causes no action to be taken (for example, it is
20562 empty or consists only of comments), the router declines. &*Warning*&: This
20563 is not the case when the file contains syntactically valid items that happen to
20564 yield empty addresses, for example, items containing only RFC 2822 address
20565 comments.
20566
20567
20568
20569 .section "Forward files and address verification" "SECID125"
20570 .cindex "address redirection" "while verifying"
20571 It is usual to set &%no_verify%& on &(redirect)& routers which handle users'
20572 &_.forward_& files, as in the example above. There are two reasons for this:
20573
20574 .ilist
20575 When Exim is receiving an incoming SMTP message from a remote host, it is
20576 running under the Exim uid, not as root. Exim is unable to change uid to read
20577 the file as the user, and it may not be able to read it as the Exim user. So in
20578 practice the router may not be able to operate.
20579 .next
20580 However, even when the router can operate, the existence of a &_.forward_& file
20581 is unimportant when verifying an address. What should be checked is whether the
20582 local part is a valid user name or not. Cutting out the redirection processing
20583 saves some resources.
20584 .endlist
20585
20586
20587
20588
20589
20590
20591 .section "Interpreting redirection data" "SECID126"
20592 .cindex "Sieve filter" "specifying in redirection data"
20593 .cindex "filter" "specifying in redirection data"
20594 The contents of the data string, whether obtained from &%data%& or &%file%&,
20595 can be interpreted in two different ways:
20596
20597 .ilist
20598 If the &%allow_filter%& option is set true, and the data begins with the text
20599 &"#Exim filter"& or &"#Sieve filter"&, it is interpreted as a list of
20600 &'filtering'& instructions in the form of an Exim or Sieve filter file,
20601 respectively. Details of the syntax and semantics of filter files are described
20602 in a separate document entitled &'Exim's interfaces to mail filtering'&; this
20603 document is intended for use by end users.
20604 .next
20605 Otherwise, the data must be a comma-separated list of redirection items, as
20606 described in the next section.
20607 .endlist
20608
20609 When a message is redirected to a file (a &"mail folder"&), the filename given
20610 in a non-filter redirection list must always be an absolute path. A filter may
20611 generate a relative path &-- how this is handled depends on the transport's
20612 configuration. See section &<<SECTfildiropt>>& for a discussion of this issue
20613 for the &(appendfile)& transport.
20614
20615
20616
20617 .section "Items in a non-filter redirection list" "SECTitenonfilred"
20618 .cindex "address redirection" "non-filter list items"
20619 When the redirection data is not an Exim or Sieve filter, for example, if it
20620 comes from a conventional alias or forward file, it consists of a list of
20621 addresses, filenames, pipe commands, or certain special items (see section
20622 &<<SECTspecitredli>>& below). The special items can be individually enabled or
20623 disabled by means of options whose names begin with &%allow_%& or &%forbid_%&,
20624 depending on their default values. The items in the list are separated by
20625 commas or newlines.
20626 If a comma is required in an item, the entire item must be enclosed in double
20627 quotes.
20628
20629 Lines starting with a # character are comments, and are ignored, and # may
20630 also appear following a comma, in which case everything between the # and the
20631 next newline character is ignored.
20632
20633 If an item is entirely enclosed in double quotes, these are removed. Otherwise
20634 double quotes are retained because some forms of mail address require their use
20635 (but never to enclose the entire address). In the following description,
20636 &"item"& refers to what remains after any surrounding double quotes have been
20637 removed.
20638
20639 .vindex "&$local_part$&"
20640 &*Warning*&: If you use an Exim expansion to construct a redirection address,
20641 and the expansion contains a reference to &$local_part$&, you should make use
20642 of the &%quote_local_part%& expansion operator, in case the local part contains
20643 special characters. For example, to redirect all mail for the domain
20644 &'obsolete.example'&, retaining the existing local part, you could use this
20645 setting:
20646 .code
20647 data = ${quote_local_part:$local_part}@newdomain.example
20648 .endd
20649
20650
20651 .section "Redirecting to a local mailbox" "SECTredlocmai"
20652 .cindex "routing" "loops in"
20653 .cindex "loop" "while routing, avoidance of"
20654 .cindex "address redirection" "to local mailbox"
20655 A redirection item may safely be the same as the address currently under
20656 consideration. This does not cause a routing loop, because a router is
20657 automatically skipped if any ancestor of the address that is being processed
20658 is the same as the current address and was processed by the current router.
20659 Such an address is therefore passed to the following routers, so it is handled
20660 as if there were no redirection. When making this loop-avoidance test, the
20661 complete local part, including any prefix or suffix, is used.
20662
20663 .cindex "address redirection" "local part without domain"
20664 Specifying the same local part without a domain is a common usage in personal
20665 filter files when the user wants to have messages delivered to the local
20666 mailbox and also forwarded elsewhere. For example, the user whose login is
20667 &'cleo'& might have a &_.forward_& file containing this:
20668 .code
20669 cleo, cleopatra@egypt.example
20670 .endd
20671 .cindex "backslash in alias file"
20672 .cindex "alias file" "backslash in"
20673 For compatibility with other MTAs, such unqualified local parts may be
20674 preceded by &"\"&, but this is not a requirement for loop prevention. However,
20675 it does make a difference if more than one domain is being handled
20676 synonymously.
20677
20678 If an item begins with &"\"& and the rest of the item parses as a valid RFC
20679 2822 address that does not include a domain, the item is qualified using the
20680 domain of the incoming address. In the absence of a leading &"\"&, unqualified
20681 addresses are qualified using the value in &%qualify_recipient%&, but you can
20682 force the incoming domain to be used by setting &%qualify_preserve_domain%&.
20683
20684 Care must be taken if there are alias names for local users.
20685 Consider an MTA handling a single local domain where the system alias file
20686 contains:
20687 .code
20688 Sam.Reman: spqr
20689 .endd
20690 Now suppose that Sam (whose login id is &'spqr'&) wants to save copies of
20691 messages in the local mailbox, and also forward copies elsewhere. He creates
20692 this forward file:
20693 .code
20694 Sam.Reman, spqr@reme.elsewhere.example
20695 .endd
20696 With these settings, an incoming message addressed to &'Sam.Reman'& fails. The
20697 &(redirect)& router for system aliases does not process &'Sam.Reman'& the
20698 second time round, because it has previously routed it,
20699 and the following routers presumably cannot handle the alias. The forward file
20700 should really contain
20701 .code
20702 spqr, spqr@reme.elsewhere.example
20703 .endd
20704 but because this is such a common error, the &%check_ancestor%& option (see
20705 below) exists to provide a way to get round it. This is normally set on a
20706 &(redirect)& router that is handling users' &_.forward_& files.
20707
20708
20709
20710 .section "Special items in redirection lists" "SECTspecitredli"
20711 In addition to addresses, the following types of item may appear in redirection
20712 lists (that is, in non-filter redirection data):
20713
20714 .ilist
20715 .cindex "pipe" "in redirection list"
20716 .cindex "address redirection" "to pipe"
20717 An item is treated as a pipe command if it begins with &"|"& and does not parse
20718 as a valid RFC 2822 address that includes a domain. A transport for running the
20719 command must be specified by the &%pipe_transport%& option.
20720 Normally, either the router or the transport specifies a user and a group under
20721 which to run the delivery. The default is to use the Exim user and group.
20722
20723 Single or double quotes can be used for enclosing the individual arguments of
20724 the pipe command; no interpretation of escapes is done for single quotes. If
20725 the command contains a comma character, it is necessary to put the whole item
20726 in double quotes, for example:
20727 .code
20728 "|/some/command ready,steady,go"
20729 .endd
20730 since items in redirection lists are terminated by commas. Do not, however,
20731 quote just the command. An item such as
20732 .code
20733 |"/some/command ready,steady,go"
20734 .endd
20735 is interpreted as a pipe with a rather strange command name, and no arguments.
20736
20737 Note that the above example assumes that the text comes from a lookup source
20738 of some sort, so that the quotes are part of the data.  If composing a
20739 redirect router with a &%data%& option directly specifying this command, the
20740 quotes will be used by the configuration parser to define the extent of one
20741 string, but will not be passed down into the redirect router itself.  There
20742 are two main approaches to get around this: escape quotes to be part of the
20743 data itself, or avoid using this mechanism and instead create a custom
20744 transport with the &%command%& option set and reference that transport from
20745 an &%accept%& router.
20746
20747 .next
20748 .cindex "file" "in redirection list"
20749 .cindex "address redirection" "to file"
20750 An item is interpreted as a path name if it begins with &"/"& and does not
20751 parse as a valid RFC 2822 address that includes a domain. For example,
20752 .code
20753 /home/world/minbari
20754 .endd
20755 is treated as a filename, but
20756 .code
20757 /s=molari/o=babylon/@x400gate.way
20758 .endd
20759 is treated as an address. For a filename, a transport must be specified using
20760 the &%file_transport%& option. However, if the generated path name ends with a
20761 forward slash character, it is interpreted as a directory name rather than a
20762 filename, and &%directory_transport%& is used instead.
20763
20764 Normally, either the router or the transport specifies a user and a group under
20765 which to run the delivery. The default is to use the Exim user and group.
20766
20767 .cindex "&_/dev/null_&"
20768 However, if a redirection item is the path &_/dev/null_&, delivery to it is
20769 bypassed at a high level, and the log entry shows &"**bypassed**"&
20770 instead of a transport name. In this case the user and group are not used.
20771
20772 .next
20773 .cindex "included address list"
20774 .cindex "address redirection" "included external list"
20775 If an item is of the form
20776 .code
20777 :include:<path name>
20778 .endd
20779 a list of further items is taken from the given file and included at that
20780 point. &*Note*&: Such a file can not be a filter file; it is just an
20781 out-of-line addition to the list. The items in the included list are separated
20782 by commas or newlines and are not subject to expansion. If this is the first
20783 item in an alias list in an &(lsearch)& file, a colon must be used to terminate
20784 the alias name. This example is incorrect:
20785 .code
20786 list1    :include:/opt/lists/list1
20787 .endd
20788 It must be given as
20789 .code
20790 list1:   :include:/opt/lists/list1
20791 .endd
20792 .next
20793 .cindex "address redirection" "to black hole"
20794 .cindex "delivery" "discard"
20795 .cindex "delivery" "blackhole"
20796 .cindex "black hole"
20797 .cindex "abandoning mail"
20798 Sometimes you want to throw away mail to a particular local part.  Making the
20799 &%data%& option expand to an empty string does not work, because that causes
20800 the router to decline. Instead, the alias item
20801 .code
20802 :blackhole:
20803 .endd
20804 can be used. It does what its name implies. No delivery is
20805 done, and no error message is generated. This has the same effect as specifying
20806 &_/dev/null_& as a destination, but it can be independently disabled.
20807
20808 &*Warning*&: If &':blackhole:'& appears anywhere in a redirection list, no
20809 delivery is done for the original local part, even if other redirection items
20810 are present. If you are generating a multi-item list (for example, by reading a
20811 database) and need the ability to provide a no-op item, you must use
20812 &_/dev/null_&.
20813
20814 .next
20815 .cindex "delivery" "forcing failure"
20816 .cindex "delivery" "forcing deferral"
20817 .cindex "failing delivery" "forcing"
20818 .cindex "deferred delivery, forcing"
20819 .cindex "customizing" "failure message"
20820 An attempt to deliver a particular address can be deferred or forced to fail by
20821 redirection items of the form
20822 .code
20823 :defer:
20824 :fail:
20825 .endd
20826 respectively. When a redirection list contains such an item, it applies
20827 to the entire redirection; any other items in the list are ignored. Any
20828 text following &':fail:'& or &':defer:'& is placed in the error text
20829 associated with the failure. For example, an alias file might contain:
20830 .code
20831 X.Employee:  :fail: Gone away, no forwarding address
20832 .endd
20833 In the case of an address that is being verified from an ACL or as the subject
20834 of a
20835 .cindex "VRFY" "error text, display of"
20836 VRFY command, the text is included in the SMTP error response by
20837 default.
20838 .cindex "EXPN" "error text, display of"
20839 The text is not included in the response to an EXPN command. In non-SMTP cases
20840 the text is included in the error message that Exim generates.
20841
20842 .cindex "SMTP" "error codes"
20843 By default, Exim sends a 451 SMTP code for a &':defer:'&, and 550 for
20844 &':fail:'&. However, if the message starts with three digits followed by a
20845 space, optionally followed by an extended code of the form &'n.n.n'&, also
20846 followed by a space, and the very first digit is the same as the default error
20847 code, the code from the message is used instead. If the very first digit is
20848 incorrect, a panic error is logged, and the default code is used. You can
20849 suppress the use of the supplied code in a redirect router by setting the
20850 &%forbid_smtp_code%& option true. In this case, any SMTP code is quietly
20851 ignored.
20852
20853 .vindex "&$acl_verify_message$&"
20854 In an ACL, an explicitly provided message overrides the default, but the
20855 default message is available in the variable &$acl_verify_message$& and can
20856 therefore be included in a custom message if this is desired.
20857
20858 Normally the error text is the rest of the redirection list &-- a comma does
20859 not terminate it &-- but a newline does act as a terminator. Newlines are not
20860 normally present in alias expansions. In &(lsearch)& lookups they are removed
20861 as part of the continuation process, but they may exist in other kinds of
20862 lookup and in &':include:'& files.
20863
20864 During routing for message delivery (as opposed to verification), a redirection
20865 containing &':fail:'& causes an immediate failure of the incoming address,
20866 whereas &':defer:'& causes the message to remain in the queue so that a
20867 subsequent delivery attempt can happen at a later time. If an address is
20868 deferred for too long, it will ultimately fail, because the normal retry
20869 rules still apply.
20870
20871 .next
20872 .cindex "alias file" "exception to default"
20873 Sometimes it is useful to use a single-key search type with a default (see
20874 chapter &<<CHAPfdlookup>>&) to look up aliases. However, there may be a need
20875 for exceptions to the default. These can be handled by aliasing them to
20876 &':unknown:'&. This differs from &':fail:'& in that it causes the &(redirect)&
20877 router to decline, whereas &':fail:'& forces routing to fail. A lookup which
20878 results in an empty redirection list has the same effect.
20879 .endlist
20880
20881
20882 .section "Duplicate addresses" "SECTdupaddr"
20883 .cindex "duplicate addresses"
20884 .cindex "address duplicate, discarding"
20885 .cindex "pipe" "duplicated"
20886 Exim removes duplicate addresses from the list to which it is delivering, so as
20887 to deliver just one copy to each address. This does not apply to deliveries
20888 routed to pipes by different immediate parent addresses, but an indirect
20889 aliasing scheme of the type
20890 .code
20891 pipe:       |/some/command $local_part
20892 localpart1: pipe
20893 localpart2: pipe
20894 .endd
20895 does not work with a message that is addressed to both local parts, because
20896 when the second is aliased to the intermediate local part &"pipe"& it gets
20897 discarded as being the same as a previously handled address. However, a scheme
20898 such as
20899 .code
20900 localpart1: |/some/command $local_part
20901 localpart2: |/some/command $local_part
20902 .endd
20903 does result in two different pipe deliveries, because the immediate parents of
20904 the pipes are distinct.
20905
20906
20907
20908 .section "Repeated redirection expansion" "SECID128"
20909 .cindex "repeated redirection expansion"
20910 .cindex "address redirection" "repeated for each delivery attempt"
20911 When a message cannot be delivered to all of its recipients immediately,
20912 leading to two or more delivery attempts, redirection expansion is carried out
20913 afresh each time for those addresses whose children were not all previously
20914 delivered. If redirection is being used as a mailing list, this can lead to new
20915 members of the list receiving copies of old messages. The &%one_time%& option
20916 can be used to avoid this.
20917
20918
20919 .section "Errors in redirection lists" "SECID129"
20920 .cindex "address redirection" "errors"
20921 If &%skip_syntax_errors%& is set, a malformed address that causes a parsing
20922 error is skipped, and an entry is written to the main log. This may be useful
20923 for mailing lists that are automatically managed. Otherwise, if an error is
20924 detected while generating the list of new addresses, the original address is
20925 deferred. See also &%syntax_errors_to%&.
20926
20927
20928
20929 .section "Private options for the redirect router" "SECID130"
20930
20931 .cindex "options" "&(redirect)& router"
20932 The private options for the &(redirect)& router are as follows:
20933
20934
20935 .option allow_defer redirect boolean false
20936 Setting this option allows the use of &':defer:'& in non-filter redirection
20937 data, or the &%defer%& command in an Exim filter file.
20938
20939
20940 .option allow_fail redirect boolean false
20941 .cindex "failing delivery" "from filter"
20942 If this option is true, the &':fail:'& item can be used in a redirection list,
20943 and the &%fail%& command may be used in an Exim filter file.
20944
20945
20946 .option allow_filter redirect boolean false
20947 .cindex "filter" "enabling use of"
20948 .cindex "Sieve filter" "enabling use of"
20949 Setting this option allows Exim to interpret redirection data that starts with
20950 &"#Exim filter"& or &"#Sieve filter"& as a set of filtering instructions. There
20951 are some features of Exim filter files that some administrators may wish to
20952 lock out; see the &%forbid_filter_%&&'xxx'& options below.
20953
20954 It is also possible to lock out Exim filters or Sieve filters while allowing
20955 the other type; see &%forbid_exim_filter%& and &%forbid_sieve_filter%&.
20956
20957
20958 The filter is run using the uid and gid set by the generic &%user%& and
20959 &%group%& options. These take their defaults from the password data if
20960 &%check_local_user%& is set, so in the normal case of users' personal filter
20961 files, the filter is run as the relevant user. When &%allow_filter%& is set
20962 true, Exim insists that either &%check_local_user%& or &%user%& is set.
20963
20964
20965
20966 .option allow_freeze redirect boolean false
20967 .cindex "freezing messages" "allowing in filter"
20968 Setting this option allows the use of the &%freeze%& command in an Exim filter.
20969 This command is more normally encountered in system filters, and is disabled by
20970 default for redirection filters because it isn't something you usually want to
20971 let ordinary users do.
20972
20973
20974
20975 .option check_ancestor redirect boolean false
20976 This option is concerned with handling generated addresses that are the same
20977 as some address in the list of redirection ancestors of the current address.
20978 Although it is turned off by default in the code, it is set in the default
20979 configuration file for handling users' &_.forward_& files. It is recommended
20980 for this use of the &(redirect)& router.
20981
20982 When &%check_ancestor%& is set, if a generated address (including the domain)
20983 is the same as any ancestor of the current address, it is replaced by a copy of
20984 the current address. This helps in the case where local part A is aliased to B,
20985 and B has a &_.forward_& file pointing back to A. For example, within a single
20986 domain, the local part &"Joe.Bloggs"& is aliased to &"jb"& and
20987 &_&~jb/.forward_& contains:
20988 .code
20989 \Joe.Bloggs, <other item(s)>
20990 .endd
20991 Without the &%check_ancestor%& setting, either local part (&"jb"& or
20992 &"joe.bloggs"&) gets processed once by each router and so ends up as it was
20993 originally. If &"jb"& is the real mailbox name, mail to &"jb"& gets delivered
20994 (having been turned into &"joe.bloggs"& by the &_.forward_& file and back to
20995 &"jb"& by the alias), but mail to &"joe.bloggs"& fails. Setting
20996 &%check_ancestor%& on the &(redirect)& router that handles the &_.forward_&
20997 file prevents it from turning &"jb"& back into &"joe.bloggs"& when that was the
20998 original address. See also the &%repeat_use%& option below.
20999
21000
21001 .option check_group redirect boolean "see below"
21002 When the &%file%& option is used, the group owner of the file is checked only
21003 when this option is set. The permitted groups are those listed in the
21004 &%owngroups%& option, together with the user's default group if
21005 &%check_local_user%& is set. If the file has the wrong group, routing is
21006 deferred. The default setting for this option is true if &%check_local_user%&
21007 is set and the &%modemask%& option permits the group write bit, or if the
21008 &%owngroups%& option is set. Otherwise it is false, and no group check occurs.
21009
21010
21011
21012 .option check_owner redirect boolean "see below"
21013 When the &%file%& option is used, the owner of the file is checked only when
21014 this option is set. If &%check_local_user%& is set, the local user is
21015 permitted; otherwise the owner must be one of those listed in the &%owners%&
21016 option. The default value for this option is true if &%check_local_user%& or
21017 &%owners%& is set. Otherwise the default is false, and no owner check occurs.
21018
21019
21020 .option data redirect string&!! unset
21021 This option is mutually exclusive with &%file%&. One or other of them must be
21022 set, but not both. The contents of &%data%& are expanded, and then used as the
21023 list of forwarding items, or as a set of filtering instructions. If the
21024 expansion is forced to fail, or the result is an empty string or a string that
21025 has no effect (consists entirely of comments), the router declines.
21026
21027 When filtering instructions are used, the string must begin with &"#Exim
21028 filter"&, and all comments in the string, including this initial one, must be
21029 terminated with newline characters. For example:
21030 .code
21031 data = #Exim filter\n\
21032        if $h_to: contains Exim then save $home/mail/exim endif
21033 .endd
21034 If you are reading the data from a database where newlines cannot be included,
21035 you can use the &${sg}$& expansion item to turn the escape string of your
21036 choice into a newline.
21037
21038
21039 .option directory_transport redirect string&!! unset
21040 A &(redirect)& router sets up a direct delivery to a directory when a path name
21041 ending with a slash is specified as a new &"address"&. The transport used is
21042 specified by this option, which, after expansion, must be the name of a
21043 configured transport. This should normally be an &(appendfile)& transport.
21044
21045
21046 .option file redirect string&!! unset
21047 This option specifies the name of a file that contains the redirection data. It
21048 is mutually exclusive with the &%data%& option. The string is expanded before
21049 use; if the expansion is forced to fail, the router declines. Other expansion
21050 failures cause delivery to be deferred. The result of a successful expansion
21051 must be an absolute path. The entire file is read and used as the redirection
21052 data. If the data is an empty string or a string that has no effect (consists
21053 entirely of comments), the router declines.
21054
21055 .cindex "NFS" "checking for file existence"
21056 If the attempt to open the file fails with a &"does not exist"& error, Exim
21057 runs a check on the containing directory,
21058 unless &%ignore_enotdir%& is true (see below).
21059 If the directory does not appear to exist, delivery is deferred. This can
21060 happen when users' &_.forward_& files are in NFS-mounted directories, and there
21061 is a mount problem. If the containing directory does exist, but the file does
21062 not, the router declines.
21063
21064
21065 .option file_transport redirect string&!! unset
21066 .vindex "&$address_file$&"
21067 A &(redirect)& router sets up a direct delivery to a file when a path name not
21068 ending in a slash is specified as a new &"address"&. The transport used is
21069 specified by this option, which, after expansion, must be the name of a
21070 configured transport. This should normally be an &(appendfile)& transport. When
21071 it is running, the filename is in &$address_file$&.
21072
21073
21074 .option filter_prepend_home redirect boolean true
21075 When this option is true, if a &(save)& command in an Exim filter specifies a
21076 relative path, and &$home$& is defined, it is automatically prepended to the
21077 relative path. If this option is set false, this action does not happen. The
21078 relative path is then passed to the transport unmodified.
21079
21080
21081 .option forbid_blackhole redirect boolean false
21082 .cindex "restricting access to features"
21083 .cindex "filter" "locking out certain features"
21084 If this option is true, the &':blackhole:'& item may not appear in a
21085 redirection list.
21086
21087
21088 .option forbid_exim_filter redirect boolean false
21089 .cindex "restricting access to features"
21090 .cindex "filter" "locking out certain features"
21091 If this option is set true, only Sieve filters are permitted when
21092 &%allow_filter%& is true.
21093
21094
21095
21096
21097 .option forbid_file redirect boolean false
21098 .cindex "restricting access to features"
21099 .cindex "delivery" "to file; forbidding"
21100 .cindex "filter" "locking out certain features"
21101 .cindex "Sieve filter" "forbidding delivery to a file"
21102 .cindex "Sieve filter" "&""keep""& facility; disabling"
21103 If this option is true, this router may not generate a new address that
21104 specifies delivery to a local file or directory, either from a filter or from a
21105 conventional forward file. This option is forced to be true if &%one_time%& is
21106 set. It applies to Sieve filters as well as to Exim filters, but if true, it
21107 locks out the Sieve's &"keep"& facility.
21108
21109
21110 .option forbid_filter_dlfunc redirect boolean false
21111 .cindex "restricting access to features"
21112 .cindex "filter" "locking out certain features"
21113 If this option is true, string expansions in Exim filters are not allowed to
21114 make use of the &%dlfunc%& expansion facility to run dynamically loaded
21115 functions.
21116
21117 .option forbid_filter_existstest redirect boolean false
21118 .cindex "restricting access to features"
21119 .cindex "filter" "locking out certain features"
21120 .cindex "expansion" "statting a file"
21121 If this option is true, string expansions in Exim filters are not allowed to
21122 make use of the &%exists%& condition or the &%stat%& expansion item.
21123
21124 .option forbid_filter_logwrite redirect boolean false
21125 .cindex "restricting access to features"
21126 .cindex "filter" "locking out certain features"
21127 If this option is true, use of the logging facility in Exim filters is not
21128 permitted. Logging is in any case available only if the filter is being run
21129 under some unprivileged uid (which is normally the case for ordinary users'
21130 &_.forward_& files).
21131
21132
21133 .option forbid_filter_lookup redirect boolean false
21134 .cindex "restricting access to features"
21135 .cindex "filter" "locking out certain features"
21136 If this option is true, string expansions in Exim filter files are not allowed
21137 to make use of &%lookup%& items.
21138
21139
21140 .option forbid_filter_perl redirect boolean false
21141 .cindex "restricting access to features"
21142 .cindex "filter" "locking out certain features"
21143 This option has an effect only if Exim is built with embedded Perl support. If
21144 it is true, string expansions in Exim filter files are not allowed to make use
21145 of the embedded Perl support.
21146
21147
21148 .option forbid_filter_readfile redirect boolean false
21149 .cindex "restricting access to features"
21150 .cindex "filter" "locking out certain features"
21151 If this option is true, string expansions in Exim filter files are not allowed
21152 to make use of &%readfile%& items.
21153
21154
21155 .option forbid_filter_readsocket redirect boolean false
21156 .cindex "restricting access to features"
21157 .cindex "filter" "locking out certain features"
21158 If this option is true, string expansions in Exim filter files are not allowed
21159 to make use of &%readsocket%& items.
21160
21161
21162 .option forbid_filter_reply redirect boolean false
21163 .cindex "restricting access to features"
21164 .cindex "filter" "locking out certain features"
21165 If this option is true, this router may not generate an automatic reply
21166 message. Automatic replies can be generated only from Exim or Sieve filter
21167 files, not from traditional forward files. This option is forced to be true if
21168 &%one_time%& is set.
21169
21170
21171 .option forbid_filter_run redirect boolean false
21172 .cindex "restricting access to features"
21173 .cindex "filter" "locking out certain features"
21174 If this option is true, string expansions in Exim filter files are not allowed
21175 to make use of &%run%& items.
21176
21177
21178 .option forbid_include redirect boolean false
21179 .cindex "restricting access to features"
21180 .cindex "filter" "locking out certain features"
21181 If this option is true, items of the form
21182 .code
21183 :include:<path name>
21184 .endd
21185 are not permitted in non-filter redirection lists.
21186
21187
21188 .option forbid_pipe redirect boolean false
21189 .cindex "restricting access to features"
21190 .cindex "filter" "locking out certain features"
21191 .cindex "delivery" "to pipe; forbidding"
21192 If this option is true, this router may not generate a new address which
21193 specifies delivery to a pipe, either from an Exim filter or from a conventional
21194 forward file. This option is forced to be true if &%one_time%& is set.
21195
21196
21197 .option forbid_sieve_filter redirect boolean false
21198 .cindex "restricting access to features"
21199 .cindex "filter" "locking out certain features"
21200 If this option is set true, only Exim filters are permitted when
21201 &%allow_filter%& is true.
21202
21203
21204 .cindex "SMTP" "error codes"
21205 .option forbid_smtp_code redirect boolean false
21206 If this option is set true, any SMTP error codes that are present at the start
21207 of messages specified for &`:defer:`& or &`:fail:`& are quietly ignored, and
21208 the default codes (451 and 550, respectively) are always used.
21209
21210
21211
21212
21213 .option hide_child_in_errmsg redirect boolean false
21214 .cindex "bounce message" "redirection details; suppressing"
21215 If this option is true, it prevents Exim from quoting a child address if it
21216 generates a bounce or delay message for it. Instead it says &"an address
21217 generated from <&'the top level address'&>"&. Of course, this applies only to
21218 bounces generated locally. If a message is forwarded to another host, &'its'&
21219 bounce may well quote the generated address.
21220
21221
21222 .option ignore_eacces redirect boolean false
21223 .cindex "EACCES"
21224 If this option is set and an attempt to open a redirection file yields the
21225 EACCES error (permission denied), the &(redirect)& router behaves as if the
21226 file did not exist.
21227
21228
21229 .option ignore_enotdir redirect boolean false
21230 .cindex "ENOTDIR"
21231 If this option is set and an attempt to open a redirection file yields the
21232 ENOTDIR error (something on the path is not a directory), the &(redirect)&
21233 router behaves as if the file did not exist.
21234
21235 Setting &%ignore_enotdir%& has another effect as well: When a &(redirect)&
21236 router that has the &%file%& option set discovers that the file does not exist
21237 (the ENOENT error), it tries to &[stat()]& the parent directory, as a check
21238 against unmounted NFS directories. If the parent can not be statted, delivery
21239 is deferred. However, it seems wrong to do this check when &%ignore_enotdir%&
21240 is set, because that option tells Exim to ignore &"something on the path is not
21241 a directory"& (the ENOTDIR error). This is a confusing area, because it seems
21242 that some operating systems give ENOENT where others give ENOTDIR.
21243
21244
21245
21246 .option include_directory redirect string unset
21247 If this option is set, the path names of any &':include:'& items in a
21248 redirection list must start with this directory.
21249
21250
21251 .option modemask redirect "octal integer" 022
21252 This specifies mode bits which must not be set for a file specified by the
21253 &%file%& option. If any of the forbidden bits are set, delivery is deferred.
21254
21255
21256 .option one_time redirect boolean false
21257 .cindex "one-time aliasing/forwarding expansion"
21258 .cindex "alias file" "one-time expansion"
21259 .cindex "forward file" "one-time expansion"
21260 .cindex "mailing lists" "one-time expansion"
21261 .cindex "address redirection" "one-time expansion"
21262 Sometimes the fact that Exim re-evaluates aliases and reprocesses redirection
21263 files each time it tries to deliver a message causes a problem when one or more
21264 of the generated addresses fails be delivered at the first attempt. The problem
21265 is not one of duplicate delivery &-- Exim is clever enough to handle that &--
21266 but of what happens when the redirection list changes during the time that the
21267 message is on Exim's queue. This is particularly true in the case of mailing
21268 lists, where new subscribers might receive copies of messages that were posted
21269 before they subscribed.
21270
21271 If &%one_time%& is set and any addresses generated by the router fail to
21272 deliver at the first attempt, the failing addresses are added to the message as
21273 &"top level"& addresses, and the parent address that generated them is marked
21274 &"delivered"&. Thus, redirection does not happen again at the next delivery
21275 attempt.
21276
21277 &*Warning 1*&: Any header line addition or removal that is specified by this
21278 router would be lost if delivery did not succeed at the first attempt. For this
21279 reason, the &%headers_add%& and &%headers_remove%& generic options are not
21280 permitted when &%one_time%& is set.
21281
21282 &*Warning 2*&: To ensure that the router generates only addresses (as opposed
21283 to pipe or file deliveries or auto-replies) &%forbid_file%&, &%forbid_pipe%&,
21284 and &%forbid_filter_reply%& are forced to be true when &%one_time%& is set.
21285
21286 &*Warning 3*&: The &%unseen%& generic router option may not be set with
21287 &%one_time%&.
21288
21289 The original top-level address is remembered with each of the generated
21290 addresses, and is output in any log messages. However, any intermediate parent
21291 addresses are not recorded. This makes a difference to the log only if
21292 &%all_parents%& log selector is set. It is expected that &%one_time%& will
21293 typically be used for mailing lists, where there is normally just one level of
21294 expansion.
21295
21296
21297 .option owners redirect "string list" unset
21298 .cindex "ownership" "alias file"
21299 .cindex "ownership" "forward file"
21300 .cindex "alias file" "ownership"
21301 .cindex "forward file" "ownership"
21302 This specifies a list of permitted owners for the file specified by &%file%&.
21303 This list is in addition to the local user when &%check_local_user%& is set.
21304 See &%check_owner%& above.
21305
21306
21307 .option owngroups redirect "string list" unset
21308 This specifies a list of permitted groups for the file specified by &%file%&.
21309 The list is in addition to the local user's primary group when
21310 &%check_local_user%& is set. See &%check_group%& above.
21311
21312
21313 .option pipe_transport redirect string&!! unset
21314 .vindex "&$address_pipe$&"
21315 A &(redirect)& router sets up a direct delivery to a pipe when a string
21316 starting with a vertical bar character is specified as a new &"address"&. The
21317 transport used is specified by this option, which, after expansion, must be the
21318 name of a configured transport. This should normally be a &(pipe)& transport.
21319 When the transport is run, the pipe command is in &$address_pipe$&.
21320
21321
21322 .option qualify_domain redirect string&!! unset
21323 .vindex "&$qualify_recipient$&"
21324 If this option is set, and an unqualified address (one without a domain) is
21325 generated, and that address would normally be qualified by the global setting
21326 in &%qualify_recipient%&, it is instead qualified with the domain specified by
21327 expanding this string. If the expansion fails, the router declines. If you want
21328 to revert to the default, you can have the expansion generate
21329 &$qualify_recipient$&.
21330
21331 This option applies to all unqualified addresses generated by Exim filters,
21332 but for traditional &_.forward_& files, it applies only to addresses that are
21333 not preceded by a backslash. Sieve filters cannot generate unqualified
21334 addresses.
21335
21336 .option qualify_preserve_domain redirect boolean false
21337 .cindex "domain" "in redirection; preserving"
21338 .cindex "preserving domain in redirection"
21339 .cindex "address redirection" "domain; preserving"
21340 If this option is set, the router's local &%qualify_domain%& option must not be
21341 set (a configuration error occurs if it is). If an unqualified address (one
21342 without a domain) is generated, it is qualified with the domain of the parent
21343 address (the immediately preceding ancestor) instead of the global
21344 &%qualify_recipient%& value. In the case of a traditional &_.forward_& file,
21345 this applies whether or not the address is preceded by a backslash.
21346
21347
21348 .option repeat_use redirect boolean true
21349 If this option is set false, the router is skipped for a child address that has
21350 any ancestor that was routed by this router. This test happens before any of
21351 the other preconditions are tested. Exim's default anti-looping rules skip
21352 only when the ancestor is the same as the current address. See also
21353 &%check_ancestor%& above and the generic &%redirect_router%& option.
21354
21355
21356 .option reply_transport redirect string&!! unset
21357 A &(redirect)& router sets up an automatic reply when a &%mail%& or
21358 &%vacation%& command is used in a filter file. The transport used is specified
21359 by this option, which, after expansion, must be the name of a configured
21360 transport. This should normally be an &(autoreply)& transport. Other transports
21361 are unlikely to do anything sensible or useful.
21362
21363
21364 .option rewrite redirect boolean true
21365 .cindex "address redirection" "disabling rewriting"
21366 If this option is set false, addresses generated by the router are not
21367 subject to address rewriting. Otherwise, they are treated like new addresses
21368 and are rewritten according to the global rewriting rules.
21369
21370
21371 .option sieve_subaddress redirect string&!! unset
21372 The value of this option is passed to a Sieve filter to specify the
21373 :subaddress part of an address.
21374
21375 .option sieve_useraddress redirect string&!! unset
21376 The value of this option is passed to a Sieve filter to specify the :user part
21377 of an address. However, if it is unset, the entire original local part
21378 (including any prefix or suffix) is used for :user.
21379
21380
21381 .option sieve_vacation_directory redirect string&!! unset
21382 .cindex "Sieve filter" "vacation directory"
21383 To enable the &"vacation"& extension for Sieve filters, you must set
21384 &%sieve_vacation_directory%& to the directory where vacation databases are held
21385 (do not put anything else in that directory), and ensure that the
21386 &%reply_transport%& option refers to an &(autoreply)& transport. Each user
21387 needs their own directory; Exim will create it if necessary.
21388
21389
21390
21391 .option skip_syntax_errors redirect boolean false
21392 .cindex "forward file" "broken"
21393 .cindex "address redirection" "broken files"
21394 .cindex "alias file" "broken"
21395 .cindex "broken alias or forward files"
21396 .cindex "ignoring faulty addresses"
21397 .cindex "skipping faulty addresses"
21398 .cindex "error" "skipping bad syntax"
21399 If &%skip_syntax_errors%& is set, syntactically malformed addresses in
21400 non-filter redirection data are skipped, and each failing address is logged. If
21401 &%syntax_errors_to%& is set, a message is sent to the address it defines,
21402 giving details of the failures. If &%syntax_errors_text%& is set, its contents
21403 are expanded and placed at the head of the error message generated by
21404 &%syntax_errors_to%&. Usually it is appropriate to set &%syntax_errors_to%& to
21405 be the same address as the generic &%errors_to%& option. The
21406 &%skip_syntax_errors%& option is often used when handling mailing lists.
21407
21408 If all the addresses in a redirection list are skipped because of syntax
21409 errors, the router declines to handle the original address, and it is passed to
21410 the following routers.
21411
21412 If &%skip_syntax_errors%& is set when an Exim filter is interpreted, any syntax
21413 error in the filter causes filtering to be abandoned without any action being
21414 taken. The incident is logged, and the router declines to handle the address,
21415 so it is passed to the following routers.
21416
21417 .cindex "Sieve filter" "syntax errors in"
21418 Syntax errors in a Sieve filter file cause the &"keep"& action to occur. This
21419 action is specified by RFC 3028. The values of &%skip_syntax_errors%&,
21420 &%syntax_errors_to%&, and &%syntax_errors_text%& are not used.
21421
21422 &%skip_syntax_errors%& can be used to specify that errors in users' forward
21423 lists or filter files should not prevent delivery. The &%syntax_errors_to%&
21424 option, used with an address that does not get redirected, can be used to
21425 notify users of these errors, by means of a router like this:
21426 .code
21427 userforward:
21428   driver = redirect
21429   allow_filter
21430   check_local_user
21431   file = $home/.forward
21432   file_transport = address_file
21433   pipe_transport = address_pipe
21434   reply_transport = address_reply
21435   no_verify
21436   skip_syntax_errors
21437   syntax_errors_to = real-$local_part@$domain
21438   syntax_errors_text = \
21439    This is an automatically generated message. An error has\n\
21440    been found in your .forward file. Details of the error are\n\
21441    reported below. While this error persists, you will receive\n\
21442    a copy of this message for every message that is addressed\n\
21443    to you. If your .forward file is a filter file, or if it is\n\
21444    a non-filter file containing no valid forwarding addresses,\n\
21445    a copy of each incoming message will be put in your normal\n\
21446    mailbox. If a non-filter file contains at least one valid\n\
21447    forwarding address, forwarding to the valid addresses will\n\
21448    happen, and those will be the only deliveries that occur.
21449 .endd
21450 You also need a router to ensure that local addresses that are prefixed by
21451 &`real-`& are recognized, but not forwarded or filtered. For example, you could
21452 put this immediately before the &(userforward)& router:
21453 .code
21454 real_localuser:
21455   driver = accept
21456   check_local_user
21457   local_part_prefix = real-
21458   transport = local_delivery
21459 .endd
21460 For security, it would probably be a good idea to restrict the use of this
21461 router to locally-generated messages, using a condition such as this:
21462 .code
21463   condition = ${if match {$sender_host_address}\
21464                          {\N^(|127\.0\.0\.1)$\N}}
21465 .endd
21466
21467
21468 .option syntax_errors_text redirect string&!! unset
21469 See &%skip_syntax_errors%& above.
21470
21471
21472 .option syntax_errors_to redirect string unset
21473 See &%skip_syntax_errors%& above.
21474 .ecindex IIDredrou1
21475 .ecindex IIDredrou2
21476
21477
21478
21479
21480
21481
21482 . ////////////////////////////////////////////////////////////////////////////
21483 . ////////////////////////////////////////////////////////////////////////////
21484
21485 .chapter "Environment for running local transports" "CHAPenvironment" &&&
21486          "Environment for local transports"
21487 .scindex IIDenvlotra1 "local transports" "environment for"
21488 .scindex IIDenvlotra2 "environment" "local transports"
21489 .scindex IIDenvlotra3 "transport" "local; environment for"
21490 Local transports handle deliveries to files and pipes. (The &(autoreply)&
21491 transport can be thought of as similar to a pipe.) Exim always runs transports
21492 in subprocesses, under specified uids and gids. Typical deliveries to local
21493 mailboxes run under the uid and gid of the local user.
21494
21495 Exim also sets a specific current directory while running the transport; for
21496 some transports a home directory setting is also relevant. The &(pipe)&
21497 transport is the only one that sets up environment variables; see section
21498 &<<SECTpipeenv>>& for details.
21499
21500 The values used for the uid, gid, and the directories may come from several
21501 different places. In many cases, the router that handles the address associates
21502 settings with that address as a result of its &%check_local_user%&, &%group%&,
21503 or &%user%& options. However, values may also be given in the transport's own
21504 configuration, and these override anything that comes from the router.
21505
21506
21507
21508 .section "Concurrent deliveries" "SECID131"
21509 .cindex "concurrent deliveries"
21510 .cindex "simultaneous deliveries"
21511 If two different messages for the same local recipient arrive more or less
21512 simultaneously, the two delivery processes are likely to run concurrently. When
21513 the &(appendfile)& transport is used to write to a file, Exim applies locking
21514 rules to stop concurrent processes from writing to the same file at the same
21515 time.
21516
21517 However, when you use a &(pipe)& transport, it is up to you to arrange any
21518 locking that is needed. Here is a silly example:
21519 .code
21520 my_transport:
21521   driver = pipe
21522   command = /bin/sh -c 'cat >>/some/file'
21523 .endd
21524 This is supposed to write the message at the end of the file. However, if two
21525 messages arrive at the same time, the file will be scrambled. You can use the
21526 &%exim_lock%& utility program (see section &<<SECTmailboxmaint>>&) to lock a
21527 file using the same algorithm that Exim itself uses.
21528
21529
21530
21531
21532 .section "Uids and gids" "SECTenvuidgid"
21533 .cindex "local transports" "uid and gid"
21534 .cindex "transport" "local; uid and gid"
21535 All transports have the options &%group%& and &%user%&. If &%group%& is set, it
21536 overrides any group that the router set in the address, even if &%user%& is not
21537 set for the transport. This makes it possible, for example, to run local mail
21538 delivery under the uid of the recipient (set by the router), but in a special
21539 group (set by the transport). For example:
21540 .code
21541 # Routers ...
21542 # User/group are set by check_local_user in this router
21543 local_users:
21544   driver = accept
21545   check_local_user
21546   transport = group_delivery
21547
21548 # Transports ...
21549 # This transport overrides the group
21550 group_delivery:
21551   driver = appendfile
21552   file = /var/spool/mail/$local_part
21553   group = mail
21554 .endd
21555 If &%user%& is set for a transport, its value overrides what is set in the
21556 address by the router. If &%user%& is non-numeric and &%group%& is not set, the
21557 gid associated with the user is used. If &%user%& is numeric, &%group%& must be
21558 set.
21559
21560 .oindex "&%initgroups%&"
21561 When the uid is taken from the transport's configuration, the &[initgroups()]&
21562 function is called for the groups associated with that uid if the
21563 &%initgroups%& option is set for the transport. When the uid is not specified
21564 by the transport, but is associated with the address by a router, the option
21565 for calling &[initgroups()]& is taken from the router configuration.
21566
21567 .cindex "&(pipe)& transport" "uid for"
21568 The &(pipe)& transport contains the special option &%pipe_as_creator%&. If this
21569 is set and &%user%& is not set, the uid of the process that called Exim to
21570 receive the message is used, and if &%group%& is not set, the corresponding
21571 original gid is also used.
21572
21573 This is the detailed preference order for obtaining a gid; the first of the
21574 following that is set is used:
21575
21576 .ilist
21577 A &%group%& setting of the transport;
21578 .next
21579 A &%group%& setting of the router;
21580 .next
21581 A gid associated with a user setting of the router, either as a result of
21582 &%check_local_user%& or an explicit non-numeric &%user%& setting;
21583 .next
21584 The group associated with a non-numeric &%user%& setting of the transport;
21585 .next
21586 In a &(pipe)& transport, the creator's gid if &%deliver_as_creator%& is set and
21587 the uid is the creator's uid;
21588 .next
21589 The Exim gid if the Exim uid is being used as a default.
21590 .endlist
21591
21592 If, for example, the user is specified numerically on the router and there are
21593 no group settings, no gid is available. In this situation, an error occurs.
21594 This is different for the uid, for which there always is an ultimate default.
21595 The first of the following that is set is used:
21596
21597 .ilist
21598 A &%user%& setting of the transport;
21599 .next
21600 In a &(pipe)& transport, the creator's uid if &%deliver_as_creator%& is set;
21601 .next
21602 A &%user%& setting of the router;
21603 .next
21604 A &%check_local_user%& setting of the router;
21605 .next
21606 The Exim uid.
21607 .endlist
21608
21609 Of course, an error will still occur if the uid that is chosen is on the
21610 &%never_users%& list.
21611
21612
21613
21614
21615
21616 .section "Current and home directories" "SECID132"
21617 .cindex "current directory for local transport"
21618 .cindex "home directory" "for local transport"
21619 .cindex "transport" "local; home directory for"
21620 .cindex "transport" "local; current directory for"
21621 Routers may set current and home directories for local transports by means of
21622 the &%transport_current_directory%& and &%transport_home_directory%& options.
21623 However, if the transport's &%current_directory%& or &%home_directory%& options
21624 are set, they override the router's values. In detail, the home directory
21625 for a local transport is taken from the first of these values that is set:
21626
21627 .ilist
21628 The &%home_directory%& option on the transport;
21629 .next
21630 The &%transport_home_directory%& option on the router;
21631 .next
21632 The password data if &%check_local_user%& is set on the router;
21633 .next
21634 The &%router_home_directory%& option on the router.
21635 .endlist
21636
21637 The current directory is taken from the first of these values that is set:
21638
21639 .ilist
21640 The &%current_directory%& option on the transport;
21641 .next
21642 The &%transport_current_directory%& option on the router.
21643 .endlist
21644
21645
21646 If neither the router nor the transport sets a current directory, Exim uses the
21647 value of the home directory, if it is set. Otherwise it sets the current
21648 directory to &_/_& before running a local transport.
21649
21650
21651
21652 .section "Expansion variables derived from the address" "SECID133"
21653 .vindex "&$domain$&"
21654 .vindex "&$local_part$&"
21655 .vindex "&$original_domain$&"
21656 Normally a local delivery is handling a single address, and in that case the
21657 variables such as &$domain$& and &$local_part$& are set during local
21658 deliveries. However, in some circumstances more than one address may be handled
21659 at once (for example, while writing batch SMTP for onward transmission by some
21660 other means). In this case, the variables associated with the local part are
21661 never set, &$domain$& is set only if all the addresses have the same domain,
21662 and &$original_domain$& is never set.
21663 .ecindex IIDenvlotra1
21664 .ecindex IIDenvlotra2
21665 .ecindex IIDenvlotra3
21666
21667
21668
21669
21670
21671
21672
21673 . ////////////////////////////////////////////////////////////////////////////
21674 . ////////////////////////////////////////////////////////////////////////////
21675
21676 .chapter "Generic options for transports" "CHAPtransportgeneric"
21677 .scindex IIDgenoptra1 "generic options" "transport"
21678 .scindex IIDgenoptra2 "options" "generic; for transports"
21679 .scindex IIDgenoptra3 "transport" "generic options for"
21680 The following generic options apply to all transports:
21681
21682
21683 .option body_only transports boolean false
21684 .cindex "transport" "body only"
21685 .cindex "message" "transporting body only"
21686 .cindex "body of message" "transporting"
21687 If this option is set, the message's headers are not transported. It is
21688 mutually exclusive with &%headers_only%&. If it is used with the &(appendfile)&
21689 or &(pipe)& transports, the settings of &%message_prefix%& and
21690 &%message_suffix%& should be checked, because this option does not
21691 automatically suppress them.
21692
21693
21694 .option current_directory transports string&!! unset
21695 .cindex "transport" "current directory for"
21696 This specifies the current directory that is to be set while running the
21697 transport, overriding any value that may have been set by the router.
21698 If the expansion fails for any reason, including forced failure, an error is
21699 logged, and delivery is deferred.
21700
21701
21702 .option disable_logging transports boolean false
21703 If this option is set true, nothing is logged for any
21704 deliveries by the transport or for any
21705 transport errors. You should not set this option unless you really, really know
21706 what you are doing.
21707
21708
21709 .option debug_print transports string&!! unset
21710 .cindex "testing" "variables in drivers"
21711 If this option is set and debugging is enabled (see the &%-d%& command line
21712 option), the string is expanded and included in the debugging output when the
21713 transport is run.
21714 If expansion of the string fails, the error message is written to the debugging
21715 output, and Exim carries on processing.
21716 This facility is provided to help with checking out the values of variables and
21717 so on when debugging driver configurations. For example, if a &%headers_add%&
21718 option is not working properly, &%debug_print%& could be used to output the
21719 variables it references. A newline is added to the text if it does not end with
21720 one.
21721 The variables &$transport_name$& and &$router_name$& contain the name of the
21722 transport and the router that called it.
21723
21724 .option delivery_date_add transports boolean false
21725 .cindex "&'Delivery-date:'& header line"
21726 If this option is true, a &'Delivery-date:'& header is added to the message.
21727 This gives the actual time the delivery was made. As this is not a standard
21728 header, Exim has a configuration option (&%delivery_date_remove%&) which
21729 requests its removal from incoming messages, so that delivered messages can
21730 safely be resent to other recipients.
21731
21732
21733 .option driver transports string unset
21734 This specifies which of the available transport drivers is to be used.
21735 There is no default, and this option must be set for every transport.
21736
21737
21738 .option envelope_to_add transports boolean false
21739 .cindex "&'Envelope-to:'& header line"
21740 If this option is true, an &'Envelope-to:'& header is added to the message.
21741 This gives the original address(es) in the incoming envelope that caused this
21742 delivery to happen. More than one address may be present if the transport is
21743 configured to handle several addresses at once, or if more than one original
21744 address was redirected to the same final address. As this is not a standard
21745 header, Exim has a configuration option (&%envelope_to_remove%&) which requests
21746 its removal from incoming messages, so that delivered messages can safely be
21747 resent to other recipients.
21748
21749
21750 .option event_action transports string&!! unset
21751 .cindex events
21752 This option declares a string to be expanded for Exim's events mechanism.
21753 For details see chapter &<<CHAPevents>>&.
21754
21755
21756 .option group transports string&!! "Exim group"
21757 .cindex "transport" "group; specifying"
21758 This option specifies a gid for running the transport process, overriding any
21759 value that the router supplies, and also overriding any value associated with
21760 &%user%& (see below).
21761
21762
21763 .option headers_add transports list&!! unset
21764 .cindex "header lines" "adding in transport"
21765 .cindex "transport" "header lines; adding"
21766 This option specifies a list of text headers,
21767 newline-separated (by default, changeable in the usual way &<<SECTlistsepchange>>&),
21768 which are (separately) expanded and added to the header
21769 portion of a message as it is transported, as described in section
21770 &<<SECTheadersaddrem>>&. Additional header lines can also be specified by
21771 routers. If the result of the expansion is an empty string, or if the expansion
21772 is forced to fail, no action is taken. Other expansion failures are treated as
21773 errors and cause the delivery to be deferred.
21774
21775 Unlike most options, &%headers_add%& can be specified multiple times
21776 for a transport; all listed headers are added.
21777
21778
21779 .option headers_only transports boolean false
21780 .cindex "transport" "header lines only"
21781 .cindex "message" "transporting headers only"
21782 .cindex "header lines" "transporting"
21783 If this option is set, the message's body is not transported. It is mutually
21784 exclusive with &%body_only%&. If it is used with the &(appendfile)& or &(pipe)&
21785 transports, the settings of &%message_prefix%& and &%message_suffix%& should be
21786 checked, since this option does not automatically suppress them.
21787
21788
21789 .option headers_remove transports list&!! unset
21790 .cindex "header lines" "removing"
21791 .cindex "transport" "header lines; removing"
21792 This option specifies a list of header names,
21793 colon-separated (by default, changeable in the usual way &<<SECTlistsepchange>>&);
21794 these headers are omitted from the message as it is transported, as described
21795 in section &<<SECTheadersaddrem>>&. Header removal can also be specified by
21796 routers.
21797 Each list item is separately expanded.
21798 If the result of the expansion is an empty string, or if the expansion
21799 is forced to fail, no action is taken. Other expansion failures are treated as
21800 errors and cause the delivery to be deferred.
21801
21802 Unlike most options, &%headers_remove%& can be specified multiple times
21803 for a transport; all listed headers are removed.
21804
21805 &*Warning*&: Because of the separate expansion of the list items,
21806 items that contain a list separator must have it doubled.
21807 To avoid this, change the list separator (&<<SECTlistsepchange>>&).
21808
21809
21810
21811 .option headers_rewrite transports string unset
21812 .cindex "transport" "header lines; rewriting"
21813 .cindex "rewriting" "at transport time"
21814 This option allows addresses in header lines to be rewritten at transport time,
21815 that is, as the message is being copied to its destination. The contents of the
21816 option are a colon-separated list of rewriting rules. Each rule is in exactly
21817 the same form as one of the general rewriting rules that are applied when a
21818 message is received. These are described in chapter &<<CHAPrewrite>>&. For
21819 example,
21820 .code
21821 headers_rewrite = a@b c@d f : \
21822                   x@y w@z
21823 .endd
21824 changes &'a@b'& into &'c@d'& in &'From:'& header lines, and &'x@y'& into
21825 &'w@z'& in all address-bearing header lines. The rules are applied to the
21826 header lines just before they are written out at transport time, so they affect
21827 only those copies of the message that pass through the transport. However, only
21828 the message's original header lines, and any that were added by a system
21829 filter, are rewritten. If a router or transport adds header lines, they are not
21830 affected by this option. These rewriting rules are &'not'& applied to the
21831 envelope. You can change the return path using &%return_path%&, but you cannot
21832 change envelope recipients at this time.
21833
21834
21835 .option home_directory transports string&!! unset
21836 .cindex "transport" "home directory for"
21837 .vindex "&$home$&"
21838 This option specifies a home directory setting for a local transport,
21839 overriding any value that may be set by the router. The home directory is
21840 placed in &$home$& while expanding the transport's private options. It is also
21841 used as the current directory if no current directory is set by the
21842 &%current_directory%& option on the transport or the
21843 &%transport_current_directory%& option on the router. If the expansion fails
21844 for any reason, including forced failure, an error is logged, and delivery is
21845 deferred.
21846
21847
21848 .option initgroups transports boolean false
21849 .cindex "additional groups"
21850 .cindex "groups" "additional"
21851 .cindex "transport" "group; additional"
21852 If this option is true and the uid for the delivery process is provided by the
21853 transport, the &[initgroups()]& function is called when running the transport
21854 to ensure that any additional groups associated with the uid are set up.
21855
21856
21857 .option max_parallel transports integer&!! unset
21858 .cindex limit "transport parallelism"
21859 .cindex transport "parallel processes"
21860 .cindex transport "concurrency limit"
21861 .cindex "delivery" "parallelism for transport"
21862 If this option is set and expands to an integer greater than zero
21863 it limits the number of concurrent runs of the transport.
21864 The control does not apply to shadow transports.
21865
21866 .cindex "hints database" "transport concurrency control"
21867 Exim implements this control by means of a hints database in which a record is
21868 incremented whenever a transport process is being created. The record
21869 is decremented and possibly removed when the process terminates.
21870 Obviously there is scope for
21871 records to get left lying around if there is a system or program crash. To
21872 guard against this, Exim ignores any records that are more than six hours old.
21873
21874 If you use this option, you should also arrange to delete the
21875 relevant hints database whenever your system reboots. The names of the files
21876 start with &_misc_& and they are kept in the &_spool/db_& directory. There
21877 may be one or two files, depending on the type of DBM in use. The same files
21878 are used for ETRN and smtp transport serialization.
21879
21880
21881 .option message_size_limit transports string&!! 0
21882 .cindex "limit" "message size per transport"
21883 .cindex "size" "of message, limit"
21884 .cindex "transport" "message size; limiting"
21885 This option controls the size of messages passed through the transport. It is
21886 expanded before use; the result of the expansion must be a sequence of decimal
21887 digits, optionally followed by K or M. If the expansion fails for any reason,
21888 including forced failure, or if the result is not of the required form,
21889 delivery is deferred. If the value is greater than zero and the size of a
21890 message exceeds this limit, the address is failed. If there is any chance that
21891 the resulting bounce message could be routed to the same transport, you should
21892 ensure that &%return_size_limit%& is less than the transport's
21893 &%message_size_limit%&, as otherwise the bounce message will fail to get
21894 delivered.
21895
21896
21897
21898 .option rcpt_include_affixes transports boolean false
21899 .cindex "prefix" "for local part, including in envelope"
21900 .cindex "suffix for local part" "including in envelope"
21901 .cindex "local part" "prefix"
21902 .cindex "local part" "suffix"
21903 When this option is false (the default), and an address that has had any
21904 affixes (prefixes or suffixes) removed from the local part is delivered by any
21905 form of SMTP or LMTP, the affixes are not included. For example, if a router
21906 that contains
21907 .code
21908 local_part_prefix = *-
21909 .endd
21910 routes the address &'abc-xyz@some.domain'& to an SMTP transport, the envelope
21911 is delivered with
21912 .code
21913 RCPT TO:<xyz@some.domain>
21914 .endd
21915 This is also the case when an ACL-time callout is being used to verify a
21916 recipient address. However, if &%rcpt_include_affixes%& is set true, the
21917 whole local part is included in the RCPT command. This option applies to BSMTP
21918 deliveries by the &(appendfile)& and &(pipe)& transports as well as to the
21919 &(lmtp)& and &(smtp)& transports.
21920
21921
21922 .option retry_use_local_part transports boolean "see below"
21923 .cindex "hints database" "retry keys"
21924 When a delivery suffers a temporary failure, a retry record is created
21925 in Exim's hints database. For remote deliveries, the key for the retry record
21926 is based on the name and/or IP address of the failing remote host. For local
21927 deliveries, the key is normally the entire address, including both the local
21928 part and the domain. This is suitable for most common cases of local delivery
21929 temporary failure &-- for example, exceeding a mailbox quota should delay only
21930 deliveries to that mailbox, not to the whole domain.
21931
21932 However, in some special cases you may want to treat a temporary local delivery
21933 as a failure associated with the domain, and not with a particular local part.
21934 (For example, if you are storing all mail for some domain in files.) You can do
21935 this by setting &%retry_use_local_part%& false.
21936
21937 For all the local transports, its default value is true. For remote transports,
21938 the default value is false for tidiness, but changing the value has no effect
21939 on a remote transport in the current implementation.
21940
21941
21942 .option return_path transports string&!! unset
21943 .cindex "envelope sender"
21944 .cindex "envelope from"
21945 .cindex "transport" "return path; changing"
21946 .cindex "return path" "changing in transport"
21947 If this option is set, the string is expanded at transport time and replaces
21948 the existing return path (envelope sender) value in the copy of the message
21949 that is being delivered. An empty return path is permitted. This feature is
21950 designed for remote deliveries, where the value of this option is used in the
21951 SMTP MAIL command. If you set &%return_path%& for a local transport, the
21952 only effect is to change the address that is placed in the &'Return-path:'&
21953 header line, if one is added to the message (see the next option).
21954
21955 &*Note:*& A changed return path is not logged unless you add
21956 &%return_path_on_delivery%& to the log selector.
21957
21958 .vindex "&$return_path$&"
21959 The expansion can refer to the existing value via &$return_path$&. This is
21960 either the message's envelope sender, or an address set by the
21961 &%errors_to%& option on a router. If the expansion is forced to fail, no
21962 replacement occurs; if it fails for another reason, delivery is deferred. This
21963 option can be used to support VERP (Variable Envelope Return Paths) &-- see
21964 section &<<SECTverp>>&.
21965
21966 &*Note*&: If a delivery error is detected locally, including the case when a
21967 remote server rejects a message at SMTP time, the bounce message is not sent to
21968 the value of this option. It is sent to the previously set errors address.
21969 This defaults to the incoming sender address, but can be changed by setting
21970 &%errors_to%& in a router.
21971
21972
21973
21974 .option return_path_add transports boolean false
21975 .cindex "&'Return-path:'& header line"
21976 If this option is true, a &'Return-path:'& header is added to the message.
21977 Although the return path is normally available in the prefix line of BSD
21978 mailboxes, this is commonly not displayed by MUAs, and so the user does not
21979 have easy access to it.
21980
21981 RFC 2821 states that the &'Return-path:'& header is added to a message &"when
21982 the delivery SMTP server makes the final delivery"&. This implies that this
21983 header should not be present in incoming messages. Exim has a configuration
21984 option, &%return_path_remove%&, which requests removal of this header from
21985 incoming messages, so that delivered messages can safely be resent to other
21986 recipients.
21987
21988
21989 .option shadow_condition transports string&!! unset
21990 See &%shadow_transport%& below.
21991
21992
21993 .option shadow_transport transports string unset
21994 .cindex "shadow transport"
21995 .cindex "transport" "shadow"
21996 A local transport may set the &%shadow_transport%& option to the name of
21997 another local transport. Shadow remote transports are not supported.
21998
21999 Whenever a delivery to the main transport succeeds, and either
22000 &%shadow_condition%& is unset, or its expansion does not result in the empty
22001 string or one of the strings &"0"& or &"no"& or &"false"&, the message is also
22002 passed to the shadow transport, with the same delivery address or addresses. If
22003 expansion fails, no action is taken except that non-forced expansion failures
22004 cause a log line to be written.
22005
22006 The result of the shadow transport is discarded and does not affect the
22007 subsequent processing of the message. Only a single level of shadowing is
22008 provided; the &%shadow_transport%& option is ignored on any transport when it
22009 is running as a shadow. Options concerned with output from pipes are also
22010 ignored. The log line for the successful delivery has an item added on the end,
22011 of the form
22012 .code
22013 ST=<shadow transport name>
22014 .endd
22015 If the shadow transport did not succeed, the error message is put in
22016 parentheses afterwards. Shadow transports can be used for a number of different
22017 purposes, including keeping more detailed log information than Exim normally
22018 provides, and implementing automatic acknowledgment policies based on message
22019 headers that some sites insist on.
22020
22021
22022 .option transport_filter transports string&!! unset
22023 .cindex "transport" "filter"
22024 .cindex "filter" "transport filter"
22025 This option sets up a filtering (in the Unix shell sense) process for messages
22026 at transport time. It should not be confused with mail filtering as set up by
22027 individual users or via a system filter.
22028 If unset, or expanding to an empty string, no filtering is done.
22029
22030 When the message is about to be written out, the command specified by
22031 &%transport_filter%& is started up in a separate, parallel process, and
22032 the entire message, including the header lines, is passed to it on its standard
22033 input (this in fact is done from a third process, to avoid deadlock). The
22034 command must be specified as an absolute path.
22035
22036 The lines of the message that are written to the transport filter are
22037 terminated by newline (&"\n"&). The message is passed to the filter before any
22038 SMTP-specific processing, such as turning &"\n"& into &"\r\n"& and escaping
22039 lines beginning with a dot, and also before any processing implied by the
22040 settings of &%check_string%& and &%escape_string%& in the &(appendfile)& or
22041 &(pipe)& transports.
22042
22043 The standard error for the filter process is set to the same destination as its
22044 standard output; this is read and written to the message's ultimate
22045 destination. The process that writes the message to the filter, the
22046 filter itself, and the original process that reads the result and delivers it
22047 are all run in parallel, like a shell pipeline.
22048
22049 The filter can perform any transformations it likes, but of course should take
22050 care not to break RFC 2822 syntax. Exim does not check the result, except to
22051 test for a final newline when SMTP is in use. All messages transmitted over
22052 SMTP must end with a newline, so Exim supplies one if it is missing.
22053
22054 .cindex "content scanning" "per user"
22055 A transport filter can be used to provide content-scanning on a per-user basis
22056 at delivery time if the only required effect of the scan is to modify the
22057 message. For example, a content scan could insert a new header line containing
22058 a spam score. This could be interpreted by a filter in the user's MUA. It is
22059 not possible to discard a message at this stage.
22060
22061 .cindex "SMTP" "SIZE"
22062 A problem might arise if the filter increases the size of a message that is
22063 being sent down an SMTP connection. If the receiving SMTP server has indicated
22064 support for the SIZE parameter, Exim will have sent the size of the message
22065 at the start of the SMTP session. If what is actually sent is substantially
22066 more, the server might reject the message. This can be worked round by setting
22067 the &%size_addition%& option on the &(smtp)& transport, either to allow for
22068 additions to the message, or to disable the use of SIZE altogether.
22069
22070 .vindex "&$pipe_addresses$&"
22071 The value of the &%transport_filter%& option is the command string for starting
22072 the filter, which is run directly from Exim, not under a shell. The string is
22073 parsed by Exim in the same way as a command string for the &(pipe)& transport:
22074 Exim breaks it up into arguments and then expands each argument separately (see
22075 section &<<SECThowcommandrun>>&). Any kind of expansion failure causes delivery
22076 to be deferred. The special argument &$pipe_addresses$& is replaced by a number
22077 of arguments, one for each address that applies to this delivery. (This isn't
22078 an ideal name for this feature here, but as it was already implemented for the
22079 &(pipe)& transport, it seemed sensible not to change it.)
22080
22081 .vindex "&$host$&"
22082 .vindex "&$host_address$&"
22083 The expansion variables &$host$& and &$host_address$& are available when the
22084 transport is a remote one. They contain the name and IP address of the host to
22085 which the message is being sent. For example:
22086 .code
22087 transport_filter = /some/directory/transport-filter.pl \
22088   $host $host_address $sender_address $pipe_addresses
22089 .endd
22090
22091 Two problems arise if you want to use more complicated expansion items to
22092 generate transport filter commands, both of which due to the fact that the
22093 command is split up &'before'& expansion.
22094 .ilist
22095 If an expansion item contains white space, you must quote it, so that it is all
22096 part of the same command item. If the entire option setting is one such
22097 expansion item, you have to take care what kind of quoting you use. For
22098 example:
22099 .code
22100 transport_filter = '/bin/cmd${if eq{$host}{a.b.c}{1}{2}}'
22101 .endd
22102 This runs the command &(/bin/cmd1)& if the host name is &'a.b.c'&, and
22103 &(/bin/cmd2)& otherwise. If double quotes had been used, they would have been
22104 stripped by Exim when it read the option's value. When the value is used, if
22105 the single quotes were missing, the line would be split into two items,
22106 &`/bin/cmd${if`& and &`eq{$host}{a.b.c}{1}{2}`&, and an error would occur when
22107 Exim tried to expand the first one.
22108 .next
22109 Except for the special case of &$pipe_addresses$& that is mentioned above, an
22110 expansion cannot generate multiple arguments, or a command name followed by
22111 arguments. Consider this example:
22112 .code
22113 transport_filter = ${lookup{$host}lsearch{/a/file}\
22114                     {$value}{/bin/cat}}
22115 .endd
22116 The result of the lookup is interpreted as the name of the command, even
22117 if it contains white space. The simplest way round this is to use a shell:
22118 .code
22119 transport_filter = /bin/sh -c ${lookup{$host}lsearch{/a/file}\
22120                                {$value}{/bin/cat}}
22121 .endd
22122 .endlist
22123
22124 The filter process is run under the same uid and gid as the normal delivery.
22125 For remote deliveries this is the Exim uid/gid by default. The command should
22126 normally yield a zero return code. Transport filters are not supposed to fail.
22127 A non-zero code is taken to mean that the transport filter encountered some
22128 serious problem. Delivery of the message is deferred; the message remains on
22129 the queue and is tried again later. It is not possible to cause a message to be
22130 bounced from a transport filter.
22131
22132 If a transport filter is set on an autoreply transport, the original message is
22133 passed through the filter as it is being copied into the newly generated
22134 message, which happens if the &%return_message%& option is set.
22135
22136
22137 .option transport_filter_timeout transports time 5m
22138 .cindex "transport" "filter, timeout"
22139 When Exim is reading the output of a transport filter, it applies a timeout
22140 that can be set by this option. Exceeding the timeout is normally treated as a
22141 temporary delivery failure. However, if a transport filter is used with a
22142 &(pipe)& transport, a timeout in the transport filter is treated in the same
22143 way as a timeout in the pipe command itself. By default, a timeout is a hard
22144 error, but if the &(pipe)& transport's &%timeout_defer%& option is set true, it
22145 becomes a temporary error.
22146
22147
22148 .option user transports string&!! "Exim user"
22149 .cindex "uid (user id)" "local delivery"
22150 .cindex "transport" "user, specifying"
22151 This option specifies the user under whose uid the delivery process is to be
22152 run, overriding any uid that may have been set by the router. If the user is
22153 given as a name, the uid is looked up from the password data, and the
22154 associated group is taken as the value of the gid to be used if the &%group%&
22155 option is not set.
22156
22157 For deliveries that use local transports, a user and group are normally
22158 specified explicitly or implicitly (for example, as a result of
22159 &%check_local_user%&) by the router or transport.
22160
22161 .cindex "hints database" "access by remote transport"
22162 For remote transports, you should leave this option unset unless you really are
22163 sure you know what you are doing. When a remote transport is running, it needs
22164 to be able to access Exim's hints databases, because each host may have its own
22165 retry data.
22166 .ecindex IIDgenoptra1
22167 .ecindex IIDgenoptra2
22168 .ecindex IIDgenoptra3
22169
22170
22171
22172
22173
22174
22175 . ////////////////////////////////////////////////////////////////////////////
22176 . ////////////////////////////////////////////////////////////////////////////
22177
22178 .chapter "Address batching in local transports" "CHAPbatching" &&&
22179          "Address batching"
22180 .cindex "transport" "local; address batching in"
22181 The only remote transport (&(smtp)&) is normally configured to handle more than
22182 one address at a time, so that when several addresses are routed to the same
22183 remote host, just one copy of the message is sent. Local transports, however,
22184 normally handle one address at a time. That is, a separate instance of the
22185 transport is run for each address that is routed to the transport. A separate
22186 copy of the message is delivered each time.
22187
22188 .cindex "batched local delivery"
22189 .oindex "&%batch_max%&"
22190 .oindex "&%batch_id%&"
22191 In special cases, it may be desirable to handle several addresses at once in a
22192 local transport, for example:
22193
22194 .ilist
22195 In an &(appendfile)& transport, when storing messages in files for later
22196 delivery by some other means, a single copy of the message with multiple
22197 recipients saves space.
22198 .next
22199 In an &(lmtp)& transport, when delivering over &"local SMTP"& to some process,
22200 a single copy saves time, and is the normal way LMTP is expected to work.
22201 .next
22202 In a &(pipe)& transport, when passing the message
22203 to a scanner program or
22204 to some other delivery mechanism such as UUCP, multiple recipients may be
22205 acceptable.
22206 .endlist
22207
22208 These three local transports all have the same options for controlling multiple
22209 (&"batched"&) deliveries, namely &%batch_max%& and &%batch_id%&. To save
22210 repeating the information for each transport, these options are described here.
22211
22212 The &%batch_max%& option specifies the maximum number of addresses that can be
22213 delivered together in a single run of the transport. Its default value is one
22214 (no batching). When more than one address is routed to a transport that has a
22215 &%batch_max%& value greater than one, the addresses are delivered in a batch
22216 (that is, in a single run of the transport with multiple recipients), subject
22217 to certain conditions:
22218
22219 .ilist
22220 .vindex "&$local_part$&"
22221 If any of the transport's options contain a reference to &$local_part$&, no
22222 batching is possible.
22223 .next
22224 .vindex "&$domain$&"
22225 If any of the transport's options contain a reference to &$domain$&, only
22226 addresses with the same domain are batched.
22227 .next
22228 .cindex "customizing" "batching condition"
22229 If &%batch_id%& is set, it is expanded for each address, and only those
22230 addresses with the same expanded value are batched. This allows you to specify
22231 customized batching conditions. Failure of the expansion for any reason,
22232 including forced failure, disables batching, but it does not stop the delivery
22233 from taking place.
22234 .next
22235 Batched addresses must also have the same errors address (where to send
22236 delivery errors), the same header additions and removals, the same user and
22237 group for the transport, and if a host list is present, the first host must
22238 be the same.
22239 .endlist
22240
22241 In the case of the &(appendfile)& and &(pipe)& transports, batching applies
22242 both when the file or pipe command is specified in the transport, and when it
22243 is specified by a &(redirect)& router, but all the batched addresses must of
22244 course be routed to the same file or pipe command. These two transports have an
22245 option called &%use_bsmtp%&, which causes them to deliver the message in
22246 &"batched SMTP"& format, with the envelope represented as SMTP commands. The
22247 &%check_string%& and &%escape_string%& options are forced to the values
22248 .code
22249 check_string = "."
22250 escape_string = ".."
22251 .endd
22252 when batched SMTP is in use. A full description of the batch SMTP mechanism is
22253 given in section &<<SECTbatchSMTP>>&. The &(lmtp)& transport does not have a
22254 &%use_bsmtp%& option, because it always delivers using the SMTP protocol.
22255
22256 .cindex "&'Envelope-to:'& header line"
22257 If the generic &%envelope_to_add%& option is set for a batching transport, the
22258 &'Envelope-to:'& header that is added to the message contains all the addresses
22259 that are being processed together. If you are using a batching &(appendfile)&
22260 transport without &%use_bsmtp%&, the only way to preserve the recipient
22261 addresses is to set the &%envelope_to_add%& option.
22262
22263 .cindex "&(pipe)& transport" "with multiple addresses"
22264 .vindex "&$pipe_addresses$&"
22265 If you are using a &(pipe)& transport without BSMTP, and setting the
22266 transport's &%command%& option, you can include &$pipe_addresses$& as part of
22267 the command. This is not a true variable; it is a bit of magic that causes each
22268 of the recipient addresses to be inserted into the command as a separate
22269 argument. This provides a way of accessing all the addresses that are being
22270 delivered in the batch. &*Note:*& This is not possible for pipe commands that
22271 are specified by a &(redirect)& router.
22272
22273
22274
22275
22276 . ////////////////////////////////////////////////////////////////////////////
22277 . ////////////////////////////////////////////////////////////////////////////
22278
22279 .chapter "The appendfile transport" "CHAPappendfile"
22280 .scindex IIDapptra1 "&(appendfile)& transport"
22281 .scindex IIDapptra2 "transports" "&(appendfile)&"
22282 .cindex "directory creation"
22283 .cindex "creating directories"
22284 The &(appendfile)& transport delivers a message by appending it to an existing
22285 file, or by creating an entirely new file in a specified directory. Single
22286 files to which messages are appended can be in the traditional Unix mailbox
22287 format, or optionally in the MBX format supported by the Pine MUA and
22288 University of Washington IMAP daemon, &'inter alia'&. When each message is
22289 being delivered as a separate file, &"maildir"& format can optionally be used
22290 to give added protection against failures that happen part-way through the
22291 delivery. A third form of separate-file delivery known as &"mailstore"& is also
22292 supported. For all file formats, Exim attempts to create as many levels of
22293 directory as necessary, provided that &%create_directory%& is set.
22294
22295 The code for the optional formats is not included in the Exim binary by
22296 default. It is necessary to set SUPPORT_MBX, SUPPORT_MAILDIR and/or
22297 SUPPORT_MAILSTORE in &_Local/Makefile_& to have the appropriate code
22298 included.
22299
22300 .cindex "quota" "system"
22301 Exim recognizes system quota errors, and generates an appropriate message. Exim
22302 also supports its own quota control within the transport, for use when the
22303 system facility is unavailable or cannot be used for some reason.
22304
22305 If there is an error while appending to a file (for example, quota exceeded or
22306 partition filled), Exim attempts to reset the file's length and last
22307 modification time back to what they were before. If there is an error while
22308 creating an entirely new file, the new file is removed.
22309
22310 Before appending to a file, a number of security checks are made, and the
22311 file is locked. A detailed description is given below, after the list of
22312 private options.
22313
22314 The &(appendfile)& transport is most commonly used for local deliveries to
22315 users' mailboxes. However, it can also be used as a pseudo-remote transport for
22316 putting messages into files for remote delivery by some means other than Exim.
22317 &"Batch SMTP"& format is often used in this case (see the &%use_bsmtp%&
22318 option).
22319
22320
22321
22322 .section "The file and directory options" "SECTfildiropt"
22323 The &%file%& option specifies a single file, to which the message is appended;
22324 the &%directory%& option specifies a directory, in which a new file containing
22325 the message is created. Only one of these two options can be set, and for
22326 normal deliveries to mailboxes, one of them &'must'& be set.
22327
22328 .vindex "&$address_file$&"
22329 .vindex "&$local_part$&"
22330 However, &(appendfile)& is also used for delivering messages to files or
22331 directories whose names (or parts of names) are obtained from alias,
22332 forwarding, or filtering operations (for example, a &%save%& command in a
22333 user's Exim filter). When such a transport is running, &$local_part$& contains
22334 the local part that was aliased or forwarded, and &$address_file$& contains the
22335 name (or partial name) of the file or directory generated by the redirection
22336 operation. There are two cases:
22337
22338 .ilist
22339 If neither &%file%& nor &%directory%& is set, the redirection operation
22340 must specify an absolute path (one that begins with &`/`&). This is the most
22341 common case when users with local accounts use filtering to sort mail into
22342 different folders. See for example, the &(address_file)& transport in the
22343 default configuration. If the path ends with a slash, it is assumed to be the
22344 name of a directory. A delivery to a directory can also be forced by setting
22345 &%maildir_format%& or &%mailstore_format%&.
22346 .next
22347 If &%file%& or &%directory%& is set for a delivery from a redirection, it is
22348 used to determine the file or directory name for the delivery. Normally, the
22349 contents of &$address_file$& are used in some way in the string expansion.
22350 .endlist
22351
22352
22353 .cindex "Sieve filter" "configuring &(appendfile)&"
22354 .cindex "Sieve filter" "relative mailbox path handling"
22355 As an example of the second case, consider an environment where users do not
22356 have home directories. They may be permitted to use Exim filter commands of the
22357 form:
22358 .code
22359 save folder23
22360 .endd
22361 or Sieve filter commands of the form:
22362 .code
22363 require "fileinto";
22364 fileinto "folder23";
22365 .endd
22366 In this situation, the expansion of &%file%& or &%directory%& in the transport
22367 must transform the relative path into an appropriate absolute filename. In the
22368 case of Sieve filters, the name &'inbox'& must be handled. It is the name that
22369 is used as a result of a &"keep"& action in the filter. This example shows one
22370 way of handling this requirement:
22371 .code
22372 file = ${if eq{$address_file}{inbox} \
22373             {/var/mail/$local_part} \
22374             {${if eq{${substr_0_1:$address_file}}{/} \
22375                   {$address_file} \
22376                   {$home/mail/$address_file} \
22377             }} \
22378        }
22379 .endd
22380 With this setting of &%file%&, &'inbox'& refers to the standard mailbox
22381 location, absolute paths are used without change, and other folders are in the
22382 &_mail_& directory within the home directory.
22383
22384 &*Note 1*&: While processing an Exim filter, a relative path such as
22385 &_folder23_& is turned into an absolute path if a home directory is known to
22386 the router. In particular, this is the case if &%check_local_user%& is set. If
22387 you want to prevent this happening at routing time, you can set
22388 &%router_home_directory%& empty. This forces the router to pass the relative
22389 path to the transport.
22390
22391 &*Note 2*&: An absolute path in &$address_file$& is not treated specially;
22392 the &%file%& or &%directory%& option is still used if it is set.
22393
22394
22395
22396
22397 .section "Private options for appendfile" "SECID134"
22398 .cindex "options" "&(appendfile)& transport"
22399
22400
22401
22402 .option allow_fifo appendfile boolean false
22403 .cindex "fifo (named pipe)"
22404 .cindex "named pipe (fifo)"
22405 .cindex "pipe" "named (fifo)"
22406 Setting this option permits delivery to named pipes (FIFOs) as well as to
22407 regular files. If no process is reading the named pipe at delivery time, the
22408 delivery is deferred.
22409
22410
22411 .option allow_symlink appendfile boolean false
22412 .cindex "symbolic link" "to mailbox"
22413 .cindex "mailbox" "symbolic link"
22414 By default, &(appendfile)& will not deliver if the path name for the file is
22415 that of a symbolic link. Setting this option relaxes that constraint, but there
22416 are security issues involved in the use of symbolic links. Be sure you know
22417 what you are doing if you set this. Details of exactly what this option affects
22418 are included in the discussion which follows this list of options.
22419
22420
22421 .option batch_id appendfile string&!! unset
22422 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
22423 However, batching is automatically disabled for &(appendfile)& deliveries that
22424 happen as a result of forwarding or aliasing or other redirection directly to a
22425 file.
22426
22427
22428 .option batch_max appendfile integer 1
22429 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
22430
22431
22432 .option check_group appendfile boolean false
22433 When this option is set, the group owner of the file defined by the &%file%&
22434 option is checked to see that it is the same as the group under which the
22435 delivery process is running. The default setting is false because the default
22436 file mode is 0600, which means that the group is irrelevant.
22437
22438
22439 .option check_owner appendfile boolean true
22440 When this option is set, the owner of the file defined by the &%file%& option
22441 is checked to ensure that it is the same as the user under which the delivery
22442 process is running.
22443
22444
22445 .option check_string appendfile string "see below"
22446 .cindex "&""From""& line"
22447 As &(appendfile)& writes the message, the start of each line is tested for
22448 matching &%check_string%&, and if it does, the initial matching characters are
22449 replaced by the contents of &%escape_string%&. The value of &%check_string%& is
22450 a literal string, not a regular expression, and the case of any letters it
22451 contains is significant.
22452
22453 If &%use_bsmtp%& is set the values of &%check_string%& and &%escape_string%&
22454 are forced to &"."& and &".."& respectively, and any settings in the
22455 configuration are ignored. Otherwise, they default to &"From&~"& and
22456 &">From&~"& when the &%file%& option is set, and unset when any of the
22457 &%directory%&, &%maildir%&, or &%mailstore%& options are set.
22458
22459 The default settings, along with &%message_prefix%& and &%message_suffix%&, are
22460 suitable for traditional &"BSD"& mailboxes, where a line beginning with
22461 &"From&~"& indicates the start of a new message. All four options need changing
22462 if another format is used. For example, to deliver to mailboxes in MMDF format:
22463 .cindex "MMDF format mailbox"
22464 .cindex "mailbox" "MMDF format"
22465 .code
22466 check_string = "\1\1\1\1\n"
22467 escape_string = "\1\1\1\1 \n"
22468 message_prefix = "\1\1\1\1\n"
22469 message_suffix = "\1\1\1\1\n"
22470 .endd
22471 .option create_directory appendfile boolean true
22472 .cindex "directory creation"
22473 When this option is true, Exim attempts to create any missing superior
22474 directories for the file that it is about to write. A created directory's mode
22475 is given by the &%directory_mode%& option.
22476
22477 The group ownership of a newly created directory is highly dependent on the
22478 operating system (and possibly the file system) that is being used. For
22479 example, in Solaris, if the parent directory has the setgid bit set, its group
22480 is propagated to the child; if not, the currently set group is used. However,
22481 in FreeBSD, the parent's group is always used.
22482
22483
22484
22485 .option create_file appendfile string anywhere
22486 This option constrains the location of files and directories that are created
22487 by this transport. It applies to files defined by the &%file%& option and
22488 directories defined by the &%directory%& option. In the case of maildir
22489 delivery, it applies to the top level directory, not the maildir directories
22490 beneath.
22491
22492 The option must be set to one of the words &"anywhere"&, &"inhome"&, or
22493 &"belowhome"&. In the second and third cases, a home directory must have been
22494 set for the transport. This option is not useful when an explicit filename is
22495 given for normal mailbox deliveries. It is intended for the case when filenames
22496 are generated from users' &_.forward_& files. These are usually handled
22497 by an &(appendfile)& transport called &%address_file%&. See also
22498 &%file_must_exist%&.
22499
22500
22501 .option directory appendfile string&!! unset
22502 This option is mutually exclusive with the &%file%& option, but one of &%file%&
22503 or &%directory%& must be set, unless the delivery is the direct result of a
22504 redirection (see section &<<SECTfildiropt>>&).
22505
22506 When &%directory%& is set, the string is expanded, and the message is delivered
22507 into a new file or files in or below the given directory, instead of being
22508 appended to a single mailbox file. A number of different formats are provided
22509 (see &%maildir_format%& and &%mailstore_format%&), and see section
22510 &<<SECTopdir>>& for further details of this form of delivery.
22511
22512
22513 .option directory_file appendfile string&!! "see below"
22514 .cindex "base62"
22515 .vindex "&$inode$&"
22516 When &%directory%& is set, but neither &%maildir_format%& nor
22517 &%mailstore_format%& is set, &(appendfile)& delivers each message into a file
22518 whose name is obtained by expanding this string. The default value is:
22519 .code
22520 q${base62:$tod_epoch}-$inode
22521 .endd
22522 This generates a unique name from the current time, in base 62 form, and the
22523 inode of the file. The variable &$inode$& is available only when expanding this
22524 option.
22525
22526
22527 .option directory_mode appendfile "octal integer" 0700
22528 If &(appendfile)& creates any directories as a result of the
22529 &%create_directory%& option, their mode is specified by this option.
22530
22531
22532 .option escape_string appendfile string "see description"
22533 See &%check_string%& above.
22534
22535
22536 .option file appendfile string&!! unset
22537 This option is mutually exclusive with the &%directory%& option, but one of
22538 &%file%& or &%directory%& must be set, unless the delivery is the direct result
22539 of a redirection (see section &<<SECTfildiropt>>&). The &%file%& option
22540 specifies a single file, to which the message is appended. One or more of
22541 &%use_fcntl_lock%&, &%use_flock_lock%&, or &%use_lockfile%& must be set with
22542 &%file%&.
22543
22544 .cindex "NFS" "lock file"
22545 .cindex "locking files"
22546 .cindex "lock files"
22547 If you are using more than one host to deliver over NFS into the same
22548 mailboxes, you should always use lock files.
22549
22550 The string value is expanded for each delivery, and must yield an absolute
22551 path. The most common settings of this option are variations on one of these
22552 examples:
22553 .code
22554 file = /var/spool/mail/$local_part
22555 file = /home/$local_part/inbox
22556 file = $home/inbox
22557 .endd
22558 .cindex "&""sticky""& bit"
22559 In the first example, all deliveries are done into the same directory. If Exim
22560 is configured to use lock files (see &%use_lockfile%& below) it must be able to
22561 create a file in the directory, so the &"sticky"& bit must be turned on for
22562 deliveries to be possible, or alternatively the &%group%& option can be used to
22563 run the delivery under a group id which has write access to the directory.
22564
22565
22566
22567 .option file_format appendfile string unset
22568 .cindex "file" "mailbox; checking existing format"
22569 This option requests the transport to check the format of an existing file
22570 before adding to it. The check consists of matching a specific string at the
22571 start of the file. The value of the option consists of an even number of
22572 colon-separated strings. The first of each pair is the test string, and the
22573 second is the name of a transport. If the transport associated with a matched
22574 string is not the current transport, control is passed over to the other
22575 transport. For example, suppose the standard &(local_delivery)& transport has
22576 this added to it:
22577 .code
22578 file_format = "From       : local_delivery :\
22579                \1\1\1\1\n : local_mmdf_delivery"
22580 .endd
22581 Mailboxes that begin with &"From"& are still handled by this transport, but if
22582 a mailbox begins with four binary ones followed by a newline, control is passed
22583 to a transport called &%local_mmdf_delivery%&, which presumably is configured
22584 to do the delivery in MMDF format. If a mailbox does not exist or is empty, it
22585 is assumed to match the current transport. If the start of a mailbox doesn't
22586 match any string, or if the transport named for a given string is not defined,
22587 delivery is deferred.
22588
22589
22590 .option file_must_exist appendfile boolean false
22591 If this option is true, the file specified by the &%file%& option must exist.
22592 A temporary error occurs if it does not, causing delivery to be deferred.
22593 If this option is false, the file is created if it does not exist.
22594
22595
22596 .option lock_fcntl_timeout appendfile time 0s
22597 .cindex "timeout" "mailbox locking"
22598 .cindex "mailbox" "locking, blocking and non-blocking"
22599 .cindex "locking files"
22600 By default, the &(appendfile)& transport uses non-blocking calls to &[fcntl()]&
22601 when locking an open mailbox file. If the call fails, the delivery process
22602 sleeps for &%lock_interval%& and tries again, up to &%lock_retries%& times.
22603 Non-blocking calls are used so that the file is not kept open during the wait
22604 for the lock; the reason for this is to make it as safe as possible for
22605 deliveries over NFS in the case when processes might be accessing an NFS
22606 mailbox without using a lock file. This should not be done, but
22607 misunderstandings and hence misconfigurations are not unknown.
22608
22609 On a busy system, however, the performance of a non-blocking lock approach is
22610 not as good as using a blocking lock with a timeout. In this case, the waiting
22611 is done inside the system call, and Exim's delivery process acquires the lock
22612 and can proceed as soon as the previous lock holder releases it.
22613
22614 If &%lock_fcntl_timeout%& is set to a non-zero time, blocking locks, with that
22615 timeout, are used. There may still be some retrying: the maximum number of
22616 retries is
22617 .code
22618 (lock_retries * lock_interval) / lock_fcntl_timeout
22619 .endd
22620 rounded up to the next whole number. In other words, the total time during
22621 which &(appendfile)& is trying to get a lock is roughly the same, unless
22622 &%lock_fcntl_timeout%& is set very large.
22623
22624 You should consider setting this option if you are getting a lot of delayed
22625 local deliveries because of errors of the form
22626 .code
22627 failed to lock mailbox /some/file (fcntl)
22628 .endd
22629
22630 .option lock_flock_timeout appendfile time 0s
22631 This timeout applies to file locking when using &[flock()]& (see
22632 &%use_flock%&); the timeout operates in a similar manner to
22633 &%lock_fcntl_timeout%&.
22634
22635
22636 .option lock_interval appendfile time 3s
22637 This specifies the time to wait between attempts to lock the file. See below
22638 for details of locking.
22639
22640
22641 .option lock_retries appendfile integer 10
22642 This specifies the maximum number of attempts to lock the file. A value of zero
22643 is treated as 1. See below for details of locking.
22644
22645
22646 .option lockfile_mode appendfile "octal integer" 0600
22647 This specifies the mode of the created lock file, when a lock file is being
22648 used (see &%use_lockfile%& and &%use_mbx_lock%&).
22649
22650
22651 .option lockfile_timeout appendfile time 30m
22652 .cindex "timeout" "mailbox locking"
22653 When a lock file is being used (see &%use_lockfile%&), if a lock file already
22654 exists and is older than this value, it is assumed to have been left behind by
22655 accident, and Exim attempts to remove it.
22656
22657
22658 .option mailbox_filecount appendfile string&!! unset
22659 .cindex "mailbox" "specifying size of"
22660 .cindex "size" "of mailbox"
22661 If this option is set, it is expanded, and the result is taken as the current
22662 number of files in the mailbox. It must be a decimal number, optionally
22663 followed by K or M. This provides a way of obtaining this information from an
22664 external source that maintains the data.
22665
22666
22667 .option mailbox_size appendfile string&!! unset
22668 .cindex "mailbox" "specifying size of"
22669 .cindex "size" "of mailbox"
22670 If this option is set, it is expanded, and the result is taken as the current
22671 size the mailbox. It must be a decimal number, optionally followed by K or M.
22672 This provides a way of obtaining this information from an external source that
22673 maintains the data. This is likely to be helpful for maildir deliveries where
22674 it is computationally expensive to compute the size of a mailbox.
22675
22676
22677
22678 .option maildir_format appendfile boolean false
22679 .cindex "maildir format" "specifying"
22680 If this option is set with the &%directory%& option, the delivery is into a new
22681 file, in the &"maildir"& format that is used by other mail software. When the
22682 transport is activated directly from a &(redirect)& router (for example, the
22683 &(address_file)& transport in the default configuration), setting
22684 &%maildir_format%& causes the path received from the router to be treated as a
22685 directory, whether or not it ends with &`/`&. This option is available only if
22686 SUPPORT_MAILDIR is present in &_Local/Makefile_&. See section
22687 &<<SECTmaildirdelivery>>& below for further details.
22688
22689
22690 .option maildir_quota_directory_regex appendfile string "See below"
22691 .cindex "maildir format" "quota; directories included in"
22692 .cindex "quota" "maildir; directories included in"
22693 This option is relevant only when &%maildir_use_size_file%& is set. It defines
22694 a regular expression for specifying directories, relative to the quota
22695 directory (see &%quota_directory%&), that should be included in the quota
22696 calculation. The default value is:
22697 .code
22698 maildir_quota_directory_regex = ^(?:cur|new|\..*)$
22699 .endd
22700 This includes the &_cur_& and &_new_& directories, and any maildir++ folders
22701 (directories whose names begin with a dot). If you want to exclude the
22702 &_Trash_&
22703 folder from the count (as some sites do), you need to change this setting to
22704 .code
22705 maildir_quota_directory_regex = ^(?:cur|new|\.(?!Trash).*)$
22706 .endd
22707 This uses a negative lookahead in the regular expression to exclude the
22708 directory whose name is &_.Trash_&. When a directory is excluded from quota
22709 calculations, quota processing is bypassed for any messages that are delivered
22710 directly into that directory.
22711
22712
22713 .option maildir_retries appendfile integer 10
22714 This option specifies the number of times to retry when writing a file in
22715 &"maildir"& format. See section &<<SECTmaildirdelivery>>& below.
22716
22717
22718 .option maildir_tag appendfile string&!! unset
22719 This option applies only to deliveries in maildir format, and is described in
22720 section &<<SECTmaildirdelivery>>& below.
22721
22722
22723 .option maildir_use_size_file appendfile&!! boolean false
22724 .cindex "maildir format" "&_maildirsize_& file"
22725 The result of string expansion for this option must be a valid boolean value.
22726 If it is true, it enables support for &_maildirsize_& files. Exim
22727 creates a &_maildirsize_& file in a maildir if one does not exist, taking the
22728 quota from the &%quota%& option of the transport. If &%quota%& is unset, the
22729 value is zero. See &%maildir_quota_directory_regex%& above and section
22730 &<<SECTmaildirdelivery>>& below for further details.
22731
22732 .option maildirfolder_create_regex appendfile string unset
22733 .cindex "maildir format" "&_maildirfolder_& file"
22734 .cindex "&_maildirfolder_&, creating"
22735 The value of this option is a regular expression. If it is unset, it has no
22736 effect. Otherwise, before a maildir delivery takes place, the pattern is
22737 matched against the name of the maildir directory, that is, the directory
22738 containing the &_new_& and &_tmp_& subdirectories that will be used for the
22739 delivery. If there is a match, Exim checks for the existence of a file called
22740 &_maildirfolder_& in the directory, and creates it if it does not exist.
22741 See section &<<SECTmaildirdelivery>>& for more details.
22742
22743
22744 .option mailstore_format appendfile boolean false
22745 .cindex "mailstore format" "specifying"
22746 If this option is set with the &%directory%& option, the delivery is into two
22747 new files in  &"mailstore"& format. The option is available only if
22748 SUPPORT_MAILSTORE is present in &_Local/Makefile_&. See section &<<SECTopdir>>&
22749 below for further details.
22750
22751
22752 .option mailstore_prefix appendfile string&!! unset
22753 This option applies only to deliveries in mailstore format, and is described in
22754 section &<<SECTopdir>>& below.
22755
22756
22757 .option mailstore_suffix appendfile string&!! unset
22758 This option applies only to deliveries in mailstore format, and is described in
22759 section &<<SECTopdir>>& below.
22760
22761
22762 .option mbx_format appendfile boolean false
22763 .cindex "locking files"
22764 .cindex "file" "locking"
22765 .cindex "file" "MBX format"
22766 .cindex "MBX format, specifying"
22767 This option is available only if Exim has been compiled with SUPPORT_MBX
22768 set in &_Local/Makefile_&. If &%mbx_format%& is set with the &%file%& option,
22769 the message is appended to the mailbox file in MBX format instead of
22770 traditional Unix format. This format is supported by Pine4 and its associated
22771 IMAP and POP daemons, by means of the &'c-client'& library that they all use.
22772
22773 &*Note*&: The &%message_prefix%& and &%message_suffix%& options are not
22774 automatically changed by the use of &%mbx_format%&. They should normally be set
22775 empty when using MBX format, so this option almost always appears in this
22776 combination:
22777 .code
22778 mbx_format = true
22779 message_prefix =
22780 message_suffix =
22781 .endd
22782 If none of the locking options are mentioned in the configuration,
22783 &%use_mbx_lock%& is assumed and the other locking options default to false. It
22784 is possible to specify the other kinds of locking with &%mbx_format%&, but
22785 &%use_fcntl_lock%& and &%use_mbx_lock%& are mutually exclusive. MBX locking
22786 interworks with &'c-client'&, providing for shared access to the mailbox. It
22787 should not be used if any program that does not use this form of locking is
22788 going to access the mailbox, nor should it be used if the mailbox file is NFS
22789 mounted, because it works only when the mailbox is accessed from a single host.
22790
22791 If you set &%use_fcntl_lock%& with an MBX-format mailbox, you cannot use
22792 the standard version of &'c-client'&, because as long as it has a mailbox open
22793 (this means for the whole of a Pine or IMAP session), Exim will not be able to
22794 append messages to it.
22795
22796
22797 .option message_prefix appendfile string&!! "see below"
22798 .cindex "&""From""& line"
22799 The string specified here is expanded and output at the start of every message.
22800 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
22801 in which case it is:
22802 .code
22803 message_prefix = "From ${if def:return_path{$return_path}\
22804   {MAILER-DAEMON}} $tod_bsdinbox\n"
22805 .endd
22806 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
22807 &`\n`& to &`\r\n`& in &%message_prefix%&.
22808
22809 .option message_suffix appendfile string&!! "see below"
22810 The string specified here is expanded and output at the end of every message.
22811 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
22812 in which case it is a single newline character. The suffix can be suppressed by
22813 setting
22814 .code
22815 message_suffix =
22816 .endd
22817 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
22818 &`\n`& to &`\r\n`& in &%message_suffix%&.
22819
22820 .option mode appendfile "octal integer" 0600
22821 If the output file is created, it is given this mode. If it already exists and
22822 has wider permissions, they are reduced to this mode. If it has narrower
22823 permissions, an error occurs unless &%mode_fail_narrower%& is false. However,
22824 if the delivery is the result of a &%save%& command in a filter file specifying
22825 a particular mode, the mode of the output file is always forced to take that
22826 value, and this option is ignored.
22827
22828
22829 .option mode_fail_narrower appendfile boolean true
22830 This option applies in the case when an existing mailbox file has a narrower
22831 mode than that specified by the &%mode%& option. If &%mode_fail_narrower%& is
22832 true, the delivery is deferred (&"mailbox has the wrong mode"&); otherwise Exim
22833 continues with the delivery attempt, using the existing mode of the file.
22834
22835
22836 .option notify_comsat appendfile boolean false
22837 If this option is true, the &'comsat'& daemon is notified after every
22838 successful delivery to a user mailbox. This is the daemon that notifies logged
22839 on users about incoming mail.
22840
22841
22842 .option quota appendfile string&!! unset
22843 .cindex "quota" "imposed by Exim"
22844 This option imposes a limit on the size of the file to which Exim is appending,
22845 or to the total space used in the directory tree when the &%directory%& option
22846 is set. In the latter case, computation of the space used is expensive, because
22847 all the files in the directory (and any sub-directories) have to be
22848 individually inspected and their sizes summed. (See &%quota_size_regex%& and
22849 &%maildir_use_size_file%& for ways to avoid this in environments where users
22850 have no shell access to their mailboxes).
22851
22852 As there is no interlock against two simultaneous deliveries into a
22853 multi-file mailbox, it is possible for the quota to be overrun in this case.
22854 For single-file mailboxes, of course, an interlock is a necessity.
22855
22856 A file's size is taken as its &'used'& value. Because of blocking effects, this
22857 may be a lot less than the actual amount of disk space allocated to the file.
22858 If the sizes of a number of files are being added up, the rounding effect can
22859 become quite noticeable, especially on systems that have large block sizes.
22860 Nevertheless, it seems best to stick to the &'used'& figure, because this is
22861 the obvious value which users understand most easily.
22862
22863 The value of the option is expanded, and must then be a numerical value
22864 (decimal point allowed), optionally followed by one of the letters K, M, or G,
22865 for kilobytes, megabytes, or gigabytes, optionally followed by a slash
22866 and further option modifiers. If Exim is running on a system with
22867 large file support (Linux and FreeBSD have this), mailboxes larger than 2G can
22868 be handled.
22869
22870 The option modifier &%no_check%& can be used to force delivery even if the over
22871 quota condition is met. The quota gets updated as usual.
22872
22873 &*Note*&: A value of zero is interpreted as &"no quota"&.
22874
22875 The expansion happens while Exim is running as root, before it changes uid for
22876 the delivery. This means that files that are inaccessible to the end user can
22877 be used to hold quota values that are looked up in the expansion. When delivery
22878 fails because this quota is exceeded, the handling of the error is as for
22879 system quota failures.
22880
22881 By default, Exim's quota checking mimics system quotas, and restricts the
22882 mailbox to the specified maximum size, though the value is not accurate to the
22883 last byte, owing to separator lines and additional headers that may get added
22884 during message delivery. When a mailbox is nearly full, large messages may get
22885 refused even though small ones are accepted, because the size of the current
22886 message is added to the quota when the check is made. This behaviour can be
22887 changed by setting &%quota_is_inclusive%& false. When this is done, the check
22888 for exceeding the quota does not include the current message. Thus, deliveries
22889 continue until the quota has been exceeded; thereafter, no further messages are
22890 delivered. See also &%quota_warn_threshold%&.
22891
22892
22893 .option quota_directory appendfile string&!! unset
22894 This option defines the directory to check for quota purposes when delivering
22895 into individual files. The default is the delivery directory, or, if a file
22896 called &_maildirfolder_& exists in a maildir directory, the parent of the
22897 delivery directory.
22898
22899
22900 .option quota_filecount appendfile string&!! 0
22901 This option applies when the &%directory%& option is set. It limits the total
22902 number of files in the directory (compare the inode limit in system quotas). It
22903 can only be used if &%quota%& is also set. The value is expanded; an expansion
22904 failure causes delivery to be deferred. A value of zero is interpreted as
22905 &"no quota"&.
22906
22907 The option modifier &%no_check%& can be used to force delivery even if the over
22908 quota condition is met. The quota gets updated as usual.
22909
22910 .option quota_is_inclusive appendfile boolean true
22911 See &%quota%& above.
22912
22913
22914 .option quota_size_regex appendfile string unset
22915 This option applies when one of the delivery modes that writes a separate file
22916 for each message is being used. When Exim wants to find the size of one of
22917 these files in order to test the quota, it first checks &%quota_size_regex%&.
22918 If this is set to a regular expression that matches the filename, and it
22919 captures one string, that string is interpreted as a representation of the
22920 file's size. The value of &%quota_size_regex%& is not expanded.
22921
22922 This feature is useful only when users have no shell access to their mailboxes
22923 &-- otherwise they could defeat the quota simply by renaming the files. This
22924 facility can be used with maildir deliveries, by setting &%maildir_tag%& to add
22925 the file length to the filename. For example:
22926 .code
22927 maildir_tag = ,S=$message_size
22928 quota_size_regex = ,S=(\d+)
22929 .endd
22930 An alternative to &$message_size$& is &$message_linecount$&, which contains the
22931 number of lines in the message.
22932
22933 The regular expression should not assume that the length is at the end of the
22934 filename (even though &%maildir_tag%& puts it there) because maildir MUAs
22935 sometimes add other information onto the ends of message filenames.
22936
22937 Section &<<SECID136>>& contains further information.
22938
22939 .new
22940 This option should not be used when other message-handling software
22941 may duplicate messages by making hardlinks to the files.  When that is done Exim
22942 will count the message size once for each filename, in contrast with the actual
22943 disk usage.  When the option is not set, calculating total usage requires
22944 a system-call per file to get the size; the number of links is then available also
22945 as is used to adjust the effective size.
22946 .wen
22947
22948
22949 .option quota_warn_message appendfile string&!! "see below"
22950 See below for the use of this option. If it is not set when
22951 &%quota_warn_threshold%& is set, it defaults to
22952 .code
22953 quota_warn_message = "\
22954   To: $local_part@$domain\n\
22955   Subject: Your mailbox\n\n\
22956   This message is automatically created \
22957   by mail delivery software.\n\n\
22958   The size of your mailbox has exceeded \
22959   a warning threshold that is\n\
22960   set by the system administrator.\n"
22961 .endd
22962
22963
22964 .option quota_warn_threshold appendfile string&!! 0
22965 .cindex "quota" "warning threshold"
22966 .cindex "mailbox" "size warning"
22967 .cindex "size" "of mailbox"
22968 This option is expanded in the same way as &%quota%& (see above). If the
22969 resulting value is greater than zero, and delivery of the message causes the
22970 size of the file or total space in the directory tree to cross the given
22971 threshold, a warning message is sent. If &%quota%& is also set, the threshold
22972 may be specified as a percentage of it by following the value with a percent
22973 sign. For example:
22974 .code
22975 quota = 10M
22976 quota_warn_threshold = 75%
22977 .endd
22978 If &%quota%& is not set, a setting of &%quota_warn_threshold%& that ends with a
22979 percent sign is ignored.
22980
22981 The warning message itself is specified by the &%quota_warn_message%& option,
22982 and it must start with a &'To:'& header line containing the recipient(s) of the
22983 warning message. These do not necessarily have to include the recipient(s) of
22984 the original message. A &'Subject:'& line should also normally be supplied. You
22985 can include any other header lines that you want. If you do not include a
22986 &'From:'& line, the default is:
22987 .code
22988 From: Mail Delivery System <mailer-daemon@$qualify_domain_sender>
22989 .endd
22990 .oindex &%errors_reply_to%&
22991 If you supply a &'Reply-To:'& line, it overrides the global &%errors_reply_to%&
22992 option.
22993
22994 The &%quota%& option does not have to be set in order to use this option; they
22995 are independent of one another except when the threshold is specified as a
22996 percentage.
22997
22998
22999 .option use_bsmtp appendfile boolean false
23000 .cindex "envelope from"
23001 .cindex "envelope sender"
23002 If this option is set true, &(appendfile)& writes messages in &"batch SMTP"&
23003 format, with the envelope sender and recipient(s) included as SMTP commands. If
23004 you want to include a leading HELO command with such messages, you can do
23005 so by setting the &%message_prefix%& option. See section &<<SECTbatchSMTP>>&
23006 for details of batch SMTP.
23007
23008
23009 .option use_crlf appendfile boolean false
23010 .cindex "carriage return"
23011 .cindex "linefeed"
23012 This option causes lines to be terminated with the two-character CRLF sequence
23013 (carriage return, linefeed) instead of just a linefeed character. In the case
23014 of batched SMTP, the byte sequence written to the file is then an exact image
23015 of what would be sent down a real SMTP connection.
23016
23017 &*Note:*& The contents of the &%message_prefix%& and &%message_suffix%& options
23018 (which are used to supply the traditional &"From&~"& and blank line separators
23019 in Berkeley-style mailboxes) are written verbatim, so must contain their own
23020 carriage return characters if these are needed. In cases where these options
23021 have non-empty defaults, the values end with a single linefeed, so they must be
23022 changed to end with &`\r\n`& if &%use_crlf%& is set.
23023
23024
23025 .option use_fcntl_lock appendfile boolean "see below"
23026 This option controls the use of the &[fcntl()]& function to lock a file for
23027 exclusive use when a message is being appended. It is set by default unless
23028 &%use_flock_lock%& is set. Otherwise, it should be turned off only if you know
23029 that all your MUAs use lock file locking. When both &%use_fcntl_lock%& and
23030 &%use_flock_lock%& are unset, &%use_lockfile%& must be set.
23031
23032
23033 .option use_flock_lock appendfile boolean false
23034 This option is provided to support the use of &[flock()]& for file locking, for
23035 the few situations where it is needed. Most modern operating systems support
23036 &[fcntl()]& and &[lockf()]& locking, and these two functions interwork with
23037 each other. Exim uses &[fcntl()]& locking by default.
23038
23039 This option is required only if you are using an operating system where
23040 &[flock()]& is used by programs that access mailboxes (typically MUAs), and
23041 where &[flock()]& does not correctly interwork with &[fcntl()]&. You can use
23042 both &[fcntl()]& and &[flock()]& locking simultaneously if you want.
23043
23044 .cindex "Solaris" "&[flock()]& support"
23045 Not all operating systems provide &[flock()]&. Some versions of Solaris do not
23046 have it (and some, I think, provide a not quite right version built on top of
23047 &[lockf()]&). If the OS does not have &[flock()]&, Exim will be built without
23048 the ability to use it, and any attempt to do so will cause a configuration
23049 error.
23050
23051 &*Warning*&: &[flock()]& locks do not work on NFS files (unless &[flock()]&
23052 is just being mapped onto &[fcntl()]& by the OS).
23053
23054
23055 .option use_lockfile appendfile boolean "see below"
23056 If this option is turned off, Exim does not attempt to create a lock file when
23057 appending to a mailbox file. In this situation, the only locking is by
23058 &[fcntl()]&. You should only turn &%use_lockfile%& off if you are absolutely
23059 sure that every MUA that is ever going to look at your users' mailboxes uses
23060 &[fcntl()]& rather than a lock file, and even then only when you are not
23061 delivering over NFS from more than one host.
23062
23063 .cindex "NFS" "lock file"
23064 In order to append to an NFS file safely from more than one host, it is
23065 necessary to take out a lock &'before'& opening the file, and the lock file
23066 achieves this. Otherwise, even with &[fcntl()]& locking, there is a risk of
23067 file corruption.
23068
23069 The &%use_lockfile%& option is set by default unless &%use_mbx_lock%& is set.
23070 It is not possible to turn both &%use_lockfile%& and &%use_fcntl_lock%& off,
23071 except when &%mbx_format%& is set.
23072
23073
23074 .option use_mbx_lock appendfile boolean "see below"
23075 This option is available only if Exim has been compiled with SUPPORT_MBX
23076 set in &_Local/Makefile_&. Setting the option specifies that special MBX
23077 locking rules be used. It is set by default if &%mbx_format%& is set and none
23078 of the locking options are mentioned in the configuration. The locking rules
23079 are the same as are used by the &'c-client'& library that underlies Pine and
23080 the IMAP4 and POP daemons that come with it (see the discussion below). The
23081 rules allow for shared access to the mailbox. However, this kind of locking
23082 does not work when the mailbox is NFS mounted.
23083
23084 You can set &%use_mbx_lock%& with either (or both) of &%use_fcntl_lock%& and
23085 &%use_flock_lock%& to control what kind of locking is used in implementing the
23086 MBX locking rules. The default is to use &[fcntl()]& if &%use_mbx_lock%& is set
23087 without &%use_fcntl_lock%& or &%use_flock_lock%&.
23088
23089
23090
23091
23092 .section "Operational details for appending" "SECTopappend"
23093 .cindex "appending to a file"
23094 .cindex "file" "appending"
23095 Before appending to a file, the following preparations are made:
23096
23097 .ilist
23098 If the name of the file is &_/dev/null_&, no action is taken, and a success
23099 return is given.
23100
23101 .next
23102 .cindex "directory creation"
23103 If any directories on the file's path are missing, Exim creates them if the
23104 &%create_directory%& option is set. A created directory's mode is given by the
23105 &%directory_mode%& option.
23106
23107 .next
23108 If &%file_format%& is set, the format of an existing file is checked. If this
23109 indicates that a different transport should be used, control is passed to that
23110 transport.
23111
23112 .next
23113 .cindex "file" "locking"
23114 .cindex "locking files"
23115 .cindex "NFS" "lock file"
23116 If &%use_lockfile%& is set, a lock file is built in a way that will work
23117 reliably over NFS, as follows:
23118
23119 .olist
23120 Create a &"hitching post"& file whose name is that of the lock file with the
23121 current time, primary host name, and process id added, by opening for writing
23122 as a new file. If this fails with an access error, delivery is deferred.
23123 .next
23124 Close the hitching post file, and hard link it to the lock filename.
23125 .next
23126 If the call to &[link()]& succeeds, creation of the lock file has succeeded.
23127 Unlink the hitching post name.
23128 .next
23129 Otherwise, use &[stat()]& to get information about the hitching post file, and
23130 then unlink hitching post name. If the number of links is exactly two, creation
23131 of the lock file succeeded but something (for example, an NFS server crash and
23132 restart) caused this fact not to be communicated to the &[link()]& call.
23133 .next
23134 If creation of the lock file failed, wait for &%lock_interval%& and try again,
23135 up to &%lock_retries%& times. However, since any program that writes to a
23136 mailbox should complete its task very quickly, it is reasonable to time out old
23137 lock files that are normally the result of user agent and system crashes. If an
23138 existing lock file is older than &%lockfile_timeout%& Exim attempts to unlink
23139 it before trying again.
23140 .endlist olist
23141
23142 .next
23143 A call is made to &[lstat()]& to discover whether the main file exists, and if
23144 so, what its characteristics are. If &[lstat()]& fails for any reason other
23145 than non-existence, delivery is deferred.
23146
23147 .next
23148 .cindex "symbolic link" "to mailbox"
23149 .cindex "mailbox" "symbolic link"
23150 If the file does exist and is a symbolic link, delivery is deferred, unless the
23151 &%allow_symlink%& option is set, in which case the ownership of the link is
23152 checked, and then &[stat()]& is called to find out about the real file, which
23153 is then subjected to the checks below. The check on the top-level link
23154 ownership prevents one user creating a link for another's mailbox in a sticky
23155 directory, though allowing symbolic links in this case is definitely not a good
23156 idea. If there is a chain of symbolic links, the intermediate ones are not
23157 checked.
23158
23159 .next
23160 If the file already exists but is not a regular file, or if the file's owner
23161 and group (if the group is being checked &-- see &%check_group%& above) are
23162 different from the user and group under which the delivery is running,
23163 delivery is deferred.
23164
23165 .next
23166 If the file's permissions are more generous than specified, they are reduced.
23167 If they are insufficient, delivery is deferred, unless &%mode_fail_narrower%&
23168 is set false, in which case the delivery is tried using the existing
23169 permissions.
23170
23171 .next
23172 The file's inode number is saved, and the file is then opened for appending.
23173 If this fails because the file has vanished, &(appendfile)& behaves as if it
23174 hadn't existed (see below). For any other failures, delivery is deferred.
23175
23176 .next
23177 If the file is opened successfully, check that the inode number hasn't
23178 changed, that it is still a regular file, and that the owner and permissions
23179 have not changed. If anything is wrong, defer delivery and freeze the message.
23180
23181 .next
23182 If the file did not exist originally, defer delivery if the &%file_must_exist%&
23183 option is set. Otherwise, check that the file is being created in a permitted
23184 directory if the &%create_file%& option is set (deferring on failure), and then
23185 open for writing as a new file, with the O_EXCL and O_CREAT options,
23186 except when dealing with a symbolic link (the &%allow_symlink%& option must be
23187 set). In this case, which can happen if the link points to a non-existent file,
23188 the file is opened for writing using O_CREAT but not O_EXCL, because
23189 that prevents link following.
23190
23191 .next
23192 .cindex "loop" "while file testing"
23193 If opening fails because the file exists, obey the tests given above for
23194 existing files. However, to avoid looping in a situation where the file is
23195 being continuously created and destroyed, the exists/not-exists loop is broken
23196 after 10 repetitions, and the message is then frozen.
23197
23198 .next
23199 If opening fails with any other error, defer delivery.
23200
23201 .next
23202 .cindex "file" "locking"
23203 .cindex "locking files"
23204 Once the file is open, unless both &%use_fcntl_lock%& and &%use_flock_lock%&
23205 are false, it is locked using &[fcntl()]& or &[flock()]& or both. If
23206 &%use_mbx_lock%& is false, an exclusive lock is requested in each case.
23207 However, if &%use_mbx_lock%& is true, Exim takes out a shared lock on the open
23208 file, and an exclusive lock on the file whose name is
23209 .code
23210 /tmp/.<device-number>.<inode-number>
23211 .endd
23212 using the device and inode numbers of the open mailbox file, in accordance with
23213 the MBX locking rules. This file is created with a mode that is specified by
23214 the &%lockfile_mode%& option.
23215
23216 If Exim fails to lock the file, there are two possible courses of action,
23217 depending on the value of the locking timeout. This is obtained from
23218 &%lock_fcntl_timeout%& or &%lock_flock_timeout%&, as appropriate.
23219
23220 If the timeout value is zero, the file is closed, Exim waits for
23221 &%lock_interval%&, and then goes back and re-opens the file as above and tries
23222 to lock it again. This happens up to &%lock_retries%& times, after which the
23223 delivery is deferred.
23224
23225 If the timeout has a value greater than zero, blocking calls to &[fcntl()]& or
23226 &[flock()]& are used (with the given timeout), so there has already been some
23227 waiting involved by the time locking fails. Nevertheless, Exim does not give up
23228 immediately. It retries up to
23229 .code
23230 (lock_retries * lock_interval) / <timeout>
23231 .endd
23232 times (rounded up).
23233 .endlist
23234
23235 At the end of delivery, Exim closes the file (which releases the &[fcntl()]&
23236 and/or &[flock()]& locks) and then deletes the lock file if one was created.
23237
23238
23239 .section "Operational details for delivery to a new file" "SECTopdir"
23240 .cindex "delivery" "to single file"
23241 .cindex "&""From""& line"
23242 When the &%directory%& option is set instead of &%file%&, each message is
23243 delivered into a newly-created file or set of files. When &(appendfile)& is
23244 activated directly from a &(redirect)& router, neither &%file%& nor
23245 &%directory%& is normally set, because the path for delivery is supplied by the
23246 router. (See for example, the &(address_file)& transport in the default
23247 configuration.) In this case, delivery is to a new file if either the path name
23248 ends in &`/`&, or the &%maildir_format%& or &%mailstore_format%& option is set.
23249
23250 No locking is required while writing the message to a new file, so the various
23251 locking options of the transport are ignored. The &"From"& line that by default
23252 separates messages in a single file is not normally needed, nor is the escaping
23253 of message lines that start with &"From"&, and there is no need to ensure a
23254 newline at the end of each message. Consequently, the default values for
23255 &%check_string%&, &%message_prefix%&, and &%message_suffix%& are all unset when
23256 any of &%directory%&, &%maildir_format%&, or &%mailstore_format%& is set.
23257
23258 If Exim is required to check a &%quota%& setting, it adds up the sizes of all
23259 the files in the delivery directory by default. However, you can specify a
23260 different directory by setting &%quota_directory%&. Also, for maildir
23261 deliveries (see below) the &_maildirfolder_& convention is honoured.
23262
23263
23264 .cindex "maildir format"
23265 .cindex "mailstore format"
23266 There are three different ways in which delivery to individual files can be
23267 done, controlled by the settings of the &%maildir_format%& and
23268 &%mailstore_format%& options. Note that code to support maildir or mailstore
23269 formats is not included in the binary unless SUPPORT_MAILDIR or
23270 SUPPORT_MAILSTORE, respectively, is set in &_Local/Makefile_&.
23271
23272 .cindex "directory creation"
23273 In all three cases an attempt is made to create the directory and any necessary
23274 sub-directories if they do not exist, provided that the &%create_directory%&
23275 option is set (the default). The location of a created directory can be
23276 constrained by setting &%create_file%&. A created directory's mode is given by
23277 the &%directory_mode%& option. If creation fails, or if the
23278 &%create_directory%& option is not set when creation is required, delivery is
23279 deferred.
23280
23281
23282
23283 .section "Maildir delivery" "SECTmaildirdelivery"
23284 .cindex "maildir format" "description of"
23285 If the &%maildir_format%& option is true, Exim delivers each message by writing
23286 it to a file whose name is &_tmp/<stime>.H<mtime>P<pid>.<host>_& in the
23287 directory that is defined by the &%directory%& option (the &"delivery
23288 directory"&). If the delivery is successful, the file is renamed into the
23289 &_new_& subdirectory.
23290
23291 In the filename, <&'stime'&> is the current time of day in seconds, and
23292 <&'mtime'&> is the microsecond fraction of the time. After a maildir delivery,
23293 Exim checks that the time-of-day clock has moved on by at least one microsecond
23294 before terminating the delivery process. This guarantees uniqueness for the
23295 filename. However, as a precaution, Exim calls &[stat()]& for the file before
23296 opening it. If any response other than ENOENT (does not exist) is given,
23297 Exim waits 2 seconds and tries again, up to &%maildir_retries%& times.
23298
23299 Before Exim carries out a maildir delivery, it ensures that subdirectories
23300 called &_new_&, &_cur_&, and &_tmp_& exist in the delivery directory. If they
23301 do not exist, Exim tries to create them and any superior directories in their
23302 path, subject to the &%create_directory%& and &%create_file%& options. If the
23303 &%maildirfolder_create_regex%& option is set, and the regular expression it
23304 contains matches the delivery directory, Exim also ensures that a file called
23305 &_maildirfolder_& exists in the delivery directory. If a missing directory or
23306 &_maildirfolder_& file cannot be created, delivery is deferred.
23307
23308 These features make it possible to use Exim to create all the necessary files
23309 and directories in a maildir mailbox, including subdirectories for maildir++
23310 folders. Consider this example:
23311 .code
23312 maildir_format = true
23313 directory = /var/mail/$local_part\
23314            ${if eq{$local_part_suffix}{}{}\
23315            {/.${substr_1:$local_part_suffix}}}
23316 maildirfolder_create_regex = /\.[^/]+$
23317 .endd
23318 If &$local_part_suffix$& is empty (there was no suffix for the local part),
23319 delivery is into a toplevel maildir with a name like &_/var/mail/pimbo_& (for
23320 the user called &'pimbo'&). The pattern in &%maildirfolder_create_regex%& does
23321 not match this name, so Exim will not look for or create the file
23322 &_/var/mail/pimbo/maildirfolder_&, though it will create
23323 &_/var/mail/pimbo/{cur,new,tmp}_& if necessary.
23324
23325 However, if &$local_part_suffix$& contains &`-eximusers`& (for example),
23326 delivery is into the maildir++ folder &_/var/mail/pimbo/.eximusers_&, which
23327 does match &%maildirfolder_create_regex%&. In this case, Exim will create
23328 &_/var/mail/pimbo/.eximusers/maildirfolder_& as well as the three maildir
23329 directories &_/var/mail/pimbo/.eximusers/{cur,new,tmp}_&.
23330
23331 &*Warning:*& Take care when setting &%maildirfolder_create_regex%& that it does
23332 not inadvertently match the toplevel maildir directory, because a
23333 &_maildirfolder_& file at top level would completely break quota calculations.
23334
23335 .cindex "quota" "in maildir delivery"
23336 .cindex "maildir++"
23337 If Exim is required to check a &%quota%& setting before a maildir delivery, and
23338 &%quota_directory%& is not set, it looks for a file called &_maildirfolder_& in
23339 the maildir directory (alongside &_new_&, &_cur_&, &_tmp_&). If this exists,
23340 Exim assumes the directory is a maildir++ folder directory, which is one level
23341 down from the user's top level mailbox directory. This causes it to start at
23342 the parent directory instead of the current directory when calculating the
23343 amount of space used.
23344
23345 One problem with delivering into a multi-file mailbox is that it is
23346 computationally expensive to compute the size of the mailbox for quota
23347 checking. Various approaches have been taken to reduce the amount of work
23348 needed. The next two sections describe two of them. A third alternative is to
23349 use some external process for maintaining the size data, and use the expansion
23350 of the &%mailbox_size%& option as a way of importing it into Exim.
23351
23352
23353
23354
23355 .section "Using tags to record message sizes" "SECID135"
23356 If &%maildir_tag%& is set, the string is expanded for each delivery.
23357 When the maildir file is renamed into the &_new_& sub-directory, the
23358 tag is added to its name. However, if adding the tag takes the length of the
23359 name to the point where the test &[stat()]& call fails with ENAMETOOLONG,
23360 the tag is dropped and the maildir file is created with no tag.
23361
23362
23363 .vindex "&$message_size$&"
23364 Tags can be used to encode the size of files in their names; see
23365 &%quota_size_regex%& above for an example. The expansion of &%maildir_tag%&
23366 happens after the message has been written. The value of the &$message_size$&
23367 variable is set to the number of bytes actually written. If the expansion is
23368 forced to fail, the tag is ignored, but a non-forced failure causes delivery to
23369 be deferred. The expanded tag may contain any printing characters except &"/"&.
23370 Non-printing characters in the string are ignored; if the resulting string is
23371 empty, it is ignored. If it starts with an alphanumeric character, a leading
23372 colon is inserted; this default has not proven to be the path that popular
23373 maildir implementations have chosen (but changing it in Exim would break
23374 backwards compatibility).
23375
23376 For one common implementation, you might set:
23377 .code
23378 maildir_tag = ,S=${message_size}
23379 .endd
23380 but you should check the documentation of the other software to be sure.
23381
23382 It is advisable to also set &%quota_size_regex%& when setting &%maildir_tag%&
23383 as this allows Exim to extract the size from your tag, instead of having to
23384 &[stat()]& each message file.
23385
23386
23387 .section "Using a maildirsize file" "SECID136"
23388 .cindex "quota" "in maildir delivery"
23389 .cindex "maildir format" "&_maildirsize_& file"
23390 If &%maildir_use_size_file%& is true, Exim implements the maildir++ rules for
23391 storing quota and message size information in a file called &_maildirsize_&
23392 within the toplevel maildir directory. If this file does not exist, Exim
23393 creates it, setting the quota from the &%quota%& option of the transport. If
23394 the maildir directory itself does not exist, it is created before any attempt
23395 to write a &_maildirsize_& file.
23396
23397 The &_maildirsize_& file is used to hold information about the sizes of
23398 messages in the maildir, thus speeding up quota calculations. The quota value
23399 in the file is just a cache; if the quota is changed in the transport, the new
23400 value overrides the cached value when the next message is delivered. The cache
23401 is maintained for the benefit of other programs that access the maildir and
23402 need to know the quota.
23403
23404 If the &%quota%& option in the transport is unset or zero, the &_maildirsize_&
23405 file is maintained (with a zero quota setting), but no quota is imposed.
23406
23407 A regular expression is available for controlling which directories in the
23408 maildir participate in quota calculations when a &_maildirsizefile_& is in use.
23409 See the description of the &%maildir_quota_directory_regex%& option above for
23410 details.
23411
23412
23413 .section "Mailstore delivery" "SECID137"
23414 .cindex "mailstore format" "description of"
23415 If the &%mailstore_format%& option is true, each message is written as two
23416 files in the given directory. A unique base name is constructed from the
23417 message id and the current delivery process, and the files that are written use
23418 this base name plus the suffixes &_.env_& and &_.msg_&. The &_.env_& file
23419 contains the message's envelope, and the &_.msg_& file contains the message
23420 itself. The base name is placed in the variable &$mailstore_basename$&.
23421
23422 During delivery, the envelope is first written to a file with the suffix
23423 &_.tmp_&. The &_.msg_& file is then written, and when it is complete, the
23424 &_.tmp_& file is renamed as the &_.env_& file. Programs that access messages in
23425 mailstore format should wait for the presence of both a &_.msg_& and a &_.env_&
23426 file before accessing either of them. An alternative approach is to wait for
23427 the absence of a &_.tmp_& file.
23428
23429 The envelope file starts with any text defined by the &%mailstore_prefix%&
23430 option, expanded and terminated by a newline if there isn't one. Then follows
23431 the sender address on one line, then all the recipient addresses, one per line.
23432 There can be more than one recipient only if the &%batch_max%& option is set
23433 greater than one. Finally, &%mailstore_suffix%& is expanded and the result
23434 appended to the file, followed by a newline if it does not end with one.
23435
23436 If expansion of &%mailstore_prefix%& or &%mailstore_suffix%& ends with a forced
23437 failure, it is ignored. Other expansion errors are treated as serious
23438 configuration errors, and delivery is deferred. The variable
23439 &$mailstore_basename$& is available for use during these expansions.
23440
23441
23442 .section "Non-special new file delivery" "SECID138"
23443 If neither &%maildir_format%& nor &%mailstore_format%& is set, a single new
23444 file is created directly in the named directory. For example, when delivering
23445 messages into files in batched SMTP format for later delivery to some host (see
23446 section &<<SECTbatchSMTP>>&), a setting such as
23447 .code
23448 directory = /var/bsmtp/$host
23449 .endd
23450 might be used. A message is written to a file with a temporary name, which is
23451 then renamed when the delivery is complete. The final name is obtained by
23452 expanding the contents of the &%directory_file%& option.
23453 .ecindex IIDapptra1
23454 .ecindex IIDapptra2
23455
23456
23457
23458
23459
23460
23461 . ////////////////////////////////////////////////////////////////////////////
23462 . ////////////////////////////////////////////////////////////////////////////
23463
23464 .chapter "The autoreply transport" "CHID8"
23465 .scindex IIDauttra1 "transports" "&(autoreply)&"
23466 .scindex IIDauttra2 "&(autoreply)& transport"
23467 The &(autoreply)& transport is not a true transport in that it does not cause
23468 the message to be transmitted. Instead, it generates a new mail message as an
23469 automatic reply to the incoming message. &'References:'& and
23470 &'Auto-Submitted:'& header lines are included. These are constructed according
23471 to the rules in RFCs 2822 and 3834, respectively.
23472
23473 If the router that passes the message to this transport does not have the
23474 &%unseen%& option set, the original message (for the current recipient) is not
23475 delivered anywhere. However, when the &%unseen%& option is set on the router
23476 that passes the message to this transport, routing of the address continues, so
23477 another router can set up a normal message delivery.
23478
23479
23480 The &(autoreply)& transport is usually run as the result of mail filtering, a
23481 &"vacation"& message being the standard example. However, it can also be run
23482 directly from a router like any other transport. To reduce the possibility of
23483 message cascades, messages created by the &(autoreply)& transport always have
23484 empty envelope sender addresses, like bounce messages.
23485
23486 The parameters of the message to be sent can be specified in the configuration
23487 by options described below. However, these are used only when the address
23488 passed to the transport does not contain its own reply information. When the
23489 transport is run as a consequence of a
23490 &%mail%&
23491 or &%vacation%& command in a filter file, the parameters of the message are
23492 supplied by the filter, and passed with the address. The transport's options
23493 that define the message are then ignored (so they are not usually set in this
23494 case). The message is specified entirely by the filter or by the transport; it
23495 is never built from a mixture of options. However, the &%file_optional%&,
23496 &%mode%&, and &%return_message%& options apply in all cases.
23497
23498 &(Autoreply)& is implemented as a local transport. When used as a result of a
23499 command in a user's filter file, &(autoreply)& normally runs under the uid and
23500 gid of the user, and with appropriate current and home directories (see chapter
23501 &<<CHAPenvironment>>&).
23502
23503 There is a subtle difference between routing a message to a &(pipe)& transport
23504 that generates some text to be returned to the sender, and routing it to an
23505 &(autoreply)& transport. This difference is noticeable only if more than one
23506 address from the same message is so handled. In the case of a pipe, the
23507 separate outputs from the different addresses are gathered up and returned to
23508 the sender in a single message, whereas if &(autoreply)& is used, a separate
23509 message is generated for each address that is passed to it.
23510
23511 Non-printing characters are not permitted in the header lines generated for the
23512 message that &(autoreply)& creates, with the exception of newlines that are
23513 immediately followed by white space. If any non-printing characters are found,
23514 the transport defers.
23515 Whether characters with the top bit set count as printing characters or not is
23516 controlled by the &%print_topbitchars%& global option.
23517
23518 If any of the generic options for manipulating headers (for example,
23519 &%headers_add%&) are set on an &(autoreply)& transport, they apply to the copy
23520 of the original message that is included in the generated message when
23521 &%return_message%& is set. They do not apply to the generated message itself.
23522
23523 .vindex "&$sender_address$&"
23524 If the &(autoreply)& transport receives return code 2 from Exim when it submits
23525 the message, indicating that there were no recipients, it does not treat this
23526 as an error. This means that autoreplies sent to &$sender_address$& when this
23527 is empty (because the incoming message is a bounce message) do not cause
23528 problems. They are just discarded.
23529
23530
23531
23532 .section "Private options for autoreply" "SECID139"
23533 .cindex "options" "&(autoreply)& transport"
23534
23535 .option bcc autoreply string&!! unset
23536 This specifies the addresses that are to receive &"blind carbon copies"& of the
23537 message when the message is specified by the transport.
23538
23539
23540 .option cc autoreply string&!! unset
23541 This specifies recipients of the message and the contents of the &'Cc:'& header
23542 when the message is specified by the transport.
23543
23544
23545 .option file autoreply string&!! unset
23546 The contents of the file are sent as the body of the message when the message
23547 is specified by the transport. If both &%file%& and &%text%& are set, the text
23548 string comes first.
23549
23550
23551 .option file_expand autoreply boolean false
23552 If this is set, the contents of the file named by the &%file%& option are
23553 subjected to string expansion as they are added to the message.
23554
23555
23556 .option file_optional autoreply boolean false
23557 If this option is true, no error is generated if the file named by the &%file%&
23558 option or passed with the address does not exist or cannot be read.
23559
23560
23561 .option from autoreply string&!! unset
23562 This specifies the contents of the &'From:'& header when the message is
23563 specified by the transport.
23564
23565
23566 .option headers autoreply string&!! unset
23567 This specifies additional RFC 2822 headers that are to be added to the message
23568 when the message is specified by the transport. Several can be given by using
23569 &"\n"& to separate them. There is no check on the format.
23570
23571
23572 .option log autoreply string&!! unset
23573 This option names a file in which a record of every message sent is logged when
23574 the message is specified by the transport.
23575
23576
23577 .option mode autoreply "octal integer" 0600
23578 If either the log file or the &"once"& file has to be created, this mode is
23579 used.
23580
23581
23582 .option never_mail autoreply "address list&!!" unset
23583 If any run of the transport creates a message with a recipient that matches any
23584 item in the list, that recipient is quietly discarded. If all recipients are
23585 discarded, no message is created. This applies both when the recipients are
23586 generated by a filter and when they are specified in the transport.
23587
23588
23589
23590 .option once autoreply string&!! unset
23591 This option names a file or DBM database in which a record of each &'To:'&
23592 recipient is kept when the message is specified by the transport. &*Note*&:
23593 This does not apply to &'Cc:'& or &'Bcc:'& recipients.
23594
23595 If &%once%& is unset, or is set to an empty string, the message is always sent.
23596 By default, if &%once%& is set to a non-empty filename, the message
23597 is not sent if a potential recipient is already listed in the database.
23598 However, if the &%once_repeat%& option specifies a time greater than zero, the
23599 message is sent if that much time has elapsed since a message was last sent to
23600 this recipient. A setting of zero time for &%once_repeat%& (the default)
23601 prevents a message from being sent a second time &-- in this case, zero means
23602 infinity.
23603
23604 If &%once_file_size%& is zero, a DBM database is used to remember recipients,
23605 and it is allowed to grow as large as necessary. If &%once_file_size%& is set
23606 greater than zero, it changes the way Exim implements the &%once%& option.
23607 Instead of using a DBM file to record every recipient it sends to, it uses a
23608 regular file, whose size will never get larger than the given value.
23609
23610 In the file, Exim keeps a linear list of recipient addresses and the times at
23611 which they were sent messages. If the file is full when a new address needs to
23612 be added, the oldest address is dropped. If &%once_repeat%& is not set, this
23613 means that a given recipient may receive multiple messages, but at
23614 unpredictable intervals that depend on the rate of turnover of addresses in the
23615 file. If &%once_repeat%& is set, it specifies a maximum time between repeats.
23616
23617
23618 .option once_file_size autoreply integer 0
23619 See &%once%& above.
23620
23621
23622 .option once_repeat autoreply time&!! 0s
23623 See &%once%& above.
23624 After expansion, the value of this option must be a valid time value.
23625
23626
23627 .option reply_to autoreply string&!! unset
23628 This specifies the contents of the &'Reply-To:'& header when the message is
23629 specified by the transport.
23630
23631
23632 .option return_message autoreply boolean false
23633 If this is set, a copy of the original message is returned with the new
23634 message, subject to the maximum size set in the &%return_size_limit%& global
23635 configuration option.
23636
23637
23638 .option subject autoreply string&!! unset
23639 This specifies the contents of the &'Subject:'& header when the message is
23640 specified by the transport. It is tempting to quote the original subject in
23641 automatic responses. For example:
23642 .code
23643 subject = Re: $h_subject:
23644 .endd
23645 There is a danger in doing this, however. It may allow a third party to
23646 subscribe your users to an opt-in mailing list, provided that the list accepts
23647 bounce messages as subscription confirmations. Well-managed lists require a
23648 non-bounce message to confirm a subscription, so the danger is relatively
23649 small.
23650
23651
23652
23653 .option text autoreply string&!! unset
23654 This specifies a single string to be used as the body of the message when the
23655 message is specified by the transport. If both &%text%& and &%file%& are set,
23656 the text comes first.
23657
23658
23659 .option to autoreply string&!! unset
23660 This specifies recipients of the message and the contents of the &'To:'& header
23661 when the message is specified by the transport.
23662 .ecindex IIDauttra1
23663 .ecindex IIDauttra2
23664
23665
23666
23667
23668 . ////////////////////////////////////////////////////////////////////////////
23669 . ////////////////////////////////////////////////////////////////////////////
23670
23671 .chapter "The lmtp transport" "CHAPLMTP"
23672 .cindex "transports" "&(lmtp)&"
23673 .cindex "&(lmtp)& transport"
23674 .cindex "LMTP" "over a pipe"
23675 .cindex "LMTP" "over a socket"
23676 The &(lmtp)& transport runs the LMTP protocol (RFC 2033) over a pipe to a
23677 specified command
23678 or by interacting with a Unix domain socket.
23679 This transport is something of a cross between the &(pipe)& and &(smtp)&
23680 transports. Exim also has support for using LMTP over TCP/IP; this is
23681 implemented as an option for the &(smtp)& transport. Because LMTP is expected
23682 to be of minority interest, the default build-time configure in &_src/EDITME_&
23683 has it commented out. You need to ensure that
23684 .code
23685 TRANSPORT_LMTP=yes
23686 .endd
23687 .cindex "options" "&(lmtp)& transport"
23688 is present in your &_Local/Makefile_& in order to have the &(lmtp)& transport
23689 included in the Exim binary. The private options of the &(lmtp)& transport are
23690 as follows:
23691
23692 .option batch_id lmtp string&!! unset
23693 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
23694
23695
23696 .option batch_max lmtp integer 1
23697 This limits the number of addresses that can be handled in a single delivery.
23698 Most LMTP servers can handle several addresses at once, so it is normally a
23699 good idea to increase this value. See the description of local delivery
23700 batching in chapter &<<CHAPbatching>>&.
23701
23702
23703 .option command lmtp string&!! unset
23704 This option must be set if &%socket%& is not set. The string is a command which
23705 is run in a separate process. It is split up into a command name and list of
23706 arguments, each of which is separately expanded (so expansion cannot change the
23707 number of arguments). The command is run directly, not via a shell. The message
23708 is passed to the new process using the standard input and output to operate the
23709 LMTP protocol.
23710
23711 .option ignore_quota lmtp boolean false
23712 .cindex "LMTP" "ignoring quota errors"
23713 If this option is set true, the string &`IGNOREQUOTA`& is added to RCPT
23714 commands, provided that the LMTP server has advertised support for IGNOREQUOTA
23715 in its response to the LHLO command.
23716
23717 .option socket lmtp string&!! unset
23718 This option must be set if &%command%& is not set. The result of expansion must
23719 be the name of a Unix domain socket. The transport connects to the socket and
23720 delivers the message to it using the LMTP protocol.
23721
23722
23723 .option timeout lmtp time 5m
23724 The transport is aborted if the created process or Unix domain socket does not
23725 respond to LMTP commands or message input within this timeout. Delivery
23726 is deferred, and will be tried again later. Here is an example of a typical
23727 LMTP transport:
23728 .code
23729 lmtp:
23730   driver = lmtp
23731   command = /some/local/lmtp/delivery/program
23732   batch_max = 20
23733   user = exim
23734 .endd
23735 This delivers up to 20 addresses at a time, in a mixture of domains if
23736 necessary, running as the user &'exim'&.
23737
23738
23739
23740 . ////////////////////////////////////////////////////////////////////////////
23741 . ////////////////////////////////////////////////////////////////////////////
23742
23743 .chapter "The pipe transport" "CHAPpipetransport"
23744 .scindex IIDpiptra1 "transports" "&(pipe)&"
23745 .scindex IIDpiptra2 "&(pipe)& transport"
23746 The &(pipe)& transport is used to deliver messages via a pipe to a command
23747 running in another process. One example is the use of &(pipe)& as a
23748 pseudo-remote transport for passing messages to some other delivery mechanism
23749 (such as UUCP). Another is the use by individual users to automatically process
23750 their incoming messages. The &(pipe)& transport can be used in one of the
23751 following ways:
23752
23753 .ilist
23754 .vindex "&$local_part$&"
23755 A router routes one address to a transport in the normal way, and the
23756 transport is configured as a &(pipe)& transport. In this case, &$local_part$&
23757 contains the local part of the address (as usual), and the command that is run
23758 is specified by the &%command%& option on the transport.
23759 .next
23760 .vindex "&$pipe_addresses$&"
23761 If the &%batch_max%& option is set greater than 1 (the default is 1), the
23762 transport can handle more than one address in a single run. In this case, when
23763 more than one address is routed to the transport, &$local_part$& is not set
23764 (because it is not unique). However, the pseudo-variable &$pipe_addresses$&
23765 (described in section &<<SECThowcommandrun>>& below) contains all the addresses
23766 that are routed to the transport.
23767 .next
23768 .vindex "&$address_pipe$&"
23769 A router redirects an address directly to a pipe command (for example, from an
23770 alias or forward file). In this case, &$address_pipe$& contains the text of the
23771 pipe command, and the &%command%& option on the transport is ignored unless
23772 &%force_command%& is set. If only one address is being transported
23773 (&%batch_max%& is not greater than one, or only one address was redirected to
23774 this pipe command), &$local_part$& contains the local part that was redirected.
23775 .endlist
23776
23777
23778 The &(pipe)& transport is a non-interactive delivery method. Exim can also
23779 deliver messages over pipes using the LMTP interactive protocol. This is
23780 implemented by the &(lmtp)& transport.
23781
23782 In the case when &(pipe)& is run as a consequence of an entry in a local user's
23783 &_.forward_& file, the command runs under the uid and gid of that user. In
23784 other cases, the uid and gid have to be specified explicitly, either on the
23785 transport or on the router that handles the address. Current and &"home"&
23786 directories are also controllable. See chapter &<<CHAPenvironment>>& for
23787 details of the local delivery environment and chapter &<<CHAPbatching>>&
23788 for a discussion of local delivery batching.
23789
23790
23791 .section "Concurrent delivery" "SECID140"
23792 If two messages arrive at almost the same time, and both are routed to a pipe
23793 delivery, the two pipe transports may be run concurrently. You must ensure that
23794 any pipe commands you set up are robust against this happening. If the commands
23795 write to a file, the &%exim_lock%& utility might be of use.
23796 Alternatively the &%max_parallel%& option could be used with a value
23797 of "1" to enforce serialization.
23798
23799
23800
23801
23802 .section "Returned status and data" "SECID141"
23803 .cindex "&(pipe)& transport" "returned data"
23804 If the command exits with a non-zero return code, the delivery is deemed to
23805 have failed, unless either the &%ignore_status%& option is set (in which case
23806 the return code is treated as zero), or the return code is one of those listed
23807 in the &%temp_errors%& option, which are interpreted as meaning &"try again
23808 later"&. In this case, delivery is deferred. Details of a permanent failure are
23809 logged, but are not included in the bounce message, which merely contains
23810 &"local delivery failed"&.
23811
23812 If the command exits on a signal and the &%freeze_signal%& option is set then
23813 the message will be frozen in the queue. If that option is not set, a bounce
23814 will be sent as normal.
23815
23816 If the return code is greater than 128 and the command being run is a shell
23817 script, it normally means that the script was terminated by a signal whose
23818 value is the return code minus 128. The &%freeze_signal%& option does not
23819 apply in this case.
23820
23821 If Exim is unable to run the command (that is, if &[execve()]& fails), the
23822 return code is set to 127. This is the value that a shell returns if it is
23823 asked to run a non-existent command. The wording for the log line suggests that
23824 a non-existent command may be the problem.
23825
23826 The &%return_output%& option can affect the result of a pipe delivery. If it is
23827 set and the command produces any output on its standard output or standard
23828 error streams, the command is considered to have failed, even if it gave a zero
23829 return code or if &%ignore_status%& is set. The output from the command is
23830 included as part of the bounce message. The &%return_fail_output%& option is
23831 similar, except that output is returned only when the command exits with a
23832 failure return code, that is, a value other than zero or a code that matches
23833 &%temp_errors%&.
23834
23835
23836
23837 .section "How the command is run" "SECThowcommandrun"
23838 .cindex "&(pipe)& transport" "path for command"
23839 The command line is (by default) broken down into a command name and arguments
23840 by the &(pipe)& transport itself. The &%allow_commands%& and
23841 &%restrict_to_path%& options can be used to restrict the commands that may be
23842 run.
23843
23844 .cindex "quoting" "in pipe command"
23845 Unquoted arguments are delimited by white space. If an argument appears in
23846 double quotes, backslash is interpreted as an escape character in the usual
23847 way. If an argument appears in single quotes, no escaping is done.
23848
23849 String expansion is applied to the command line except when it comes from a
23850 traditional &_.forward_& file (commands from a filter file are expanded). The
23851 expansion is applied to each argument in turn rather than to the whole line.
23852 For this reason, any string expansion item that contains white space must be
23853 quoted so as to be contained within a single argument. A setting such as
23854 .code
23855 command = /some/path ${if eq{$local_part}{postmaster}{xx}{yy}}
23856 .endd
23857 will not work, because the expansion item gets split between several
23858 arguments. You have to write
23859 .code
23860 command = /some/path "${if eq{$local_part}{postmaster}{xx}{yy}}"
23861 .endd
23862 to ensure that it is all in one argument. The expansion is done in this way,
23863 argument by argument, so that the number of arguments cannot be changed as a
23864 result of expansion, and quotes or backslashes in inserted variables do not
23865 interact with external quoting. However, this leads to problems if you want to
23866 generate multiple arguments (or the command name plus arguments) from a single
23867 expansion. In this situation, the simplest solution is to use a shell. For
23868 example:
23869 .code
23870 command = /bin/sh -c ${lookup{$local_part}lsearch{/some/file}}
23871 .endd
23872
23873 .cindex "transport" "filter"
23874 .cindex "filter" "transport filter"
23875 .vindex "&$pipe_addresses$&"
23876 Special handling takes place when an argument consists of precisely the text
23877 &`$pipe_addresses`& (no quotes).
23878 This is not a general expansion variable; the only
23879 place this string is recognized is when it appears as an argument for a pipe or
23880 transport filter command. It causes each address that is being handled to be
23881 inserted in the argument list at that point &'as a separate argument'&. This
23882 avoids any problems with spaces or shell metacharacters, and is of use when a
23883 &(pipe)& transport is handling groups of addresses in a batch.
23884
23885 If &%force_command%& is enabled on the transport, special handling takes place
23886 for an argument that consists of precisely the text &`$address_pipe`&.  It
23887 is handled similarly to &$pipe_addresses$& above.  It is expanded and each
23888 argument is inserted in the argument list at that point
23889 &'as a separate argument'&.  The &`$address_pipe`& item does not need to be
23890 the only item in the argument; in fact, if it were then &%force_command%&
23891 should behave as a no-op.  Rather, it should be used to adjust the command
23892 run while preserving the argument vector separation.
23893
23894 After splitting up into arguments and expansion, the resulting command is run
23895 in a subprocess directly from the transport, &'not'& under a shell. The
23896 message that is being delivered is supplied on the standard input, and the
23897 standard output and standard error are both connected to a single pipe that is
23898 read by Exim. The &%max_output%& option controls how much output the command
23899 may produce, and the &%return_output%& and &%return_fail_output%& options
23900 control what is done with it.
23901
23902 Not running the command under a shell (by default) lessens the security risks
23903 in cases when a command from a user's filter file is built out of data that was
23904 taken from an incoming message. If a shell is required, it can of course be
23905 explicitly specified as the command to be run. However, there are circumstances
23906 where existing commands (for example, in &_.forward_& files) expect to be run
23907 under a shell and cannot easily be modified. To allow for these cases, there is
23908 an option called &%use_shell%&, which changes the way the &(pipe)& transport
23909 works. Instead of breaking up the command line as just described, it expands it
23910 as a single string and passes the result to &_/bin/sh_&. The
23911 &%restrict_to_path%& option and the &$pipe_addresses$& facility cannot be used
23912 with &%use_shell%&, and the whole mechanism is inherently less secure.
23913
23914
23915
23916 .section "Environment variables" "SECTpipeenv"
23917 .cindex "&(pipe)& transport" "environment for command"
23918 .cindex "environment" "&(pipe)& transport"
23919 The environment variables listed below are set up when the command is invoked.
23920 This list is a compromise for maximum compatibility with other MTAs. Note that
23921 the &%environment%& option can be used to add additional variables to this
23922 environment. The environment for the &(pipe)& transport is not subject
23923 to the &%add_environment%& and &%keep_environment%& main config options.
23924 .display
23925 &`DOMAIN            `&   the domain of the address
23926 &`HOME              `&   the home directory, if set
23927 &`HOST              `&   the host name when called from a router (see below)
23928 &`LOCAL_PART        `&   see below
23929 &`LOCAL_PART_PREFIX `&   see below
23930 &`LOCAL_PART_SUFFIX `&   see below
23931 &`LOGNAME           `&   see below
23932 &`MESSAGE_ID        `&   Exim's local ID for the message
23933 &`PATH              `&   as specified by the &%path%& option below
23934 &`QUALIFY_DOMAIN    `&   the sender qualification domain
23935 &`RECIPIENT         `&   the complete recipient address
23936 &`SENDER            `&   the sender of the message (empty if a bounce)
23937 &`SHELL             `&   &`/bin/sh`&
23938 &`TZ                `&   the value of the &%timezone%& option, if set
23939 &`USER              `&   see below
23940 .endd
23941 When a &(pipe)& transport is called directly from (for example) an &(accept)&
23942 router, LOCAL_PART is set to the local part of the address. When it is
23943 called as a result of a forward or alias expansion, LOCAL_PART is set to
23944 the local part of the address that was expanded. In both cases, any affixes are
23945 removed from the local part, and made available in LOCAL_PART_PREFIX and
23946 LOCAL_PART_SUFFIX, respectively. LOGNAME and USER are set to the
23947 same value as LOCAL_PART for compatibility with other MTAs.
23948
23949 .cindex "HOST"
23950 HOST is set only when a &(pipe)& transport is called from a router that
23951 associates hosts with an address, typically when using &(pipe)& as a
23952 pseudo-remote transport. HOST is set to the first host name specified by
23953 the router.
23954
23955 .cindex "HOME"
23956 If the transport's generic &%home_directory%& option is set, its value is used
23957 for the HOME environment variable. Otherwise, a home directory may be set
23958 by the router's &%transport_home_directory%& option, which defaults to the
23959 user's home directory if &%check_local_user%& is set.
23960
23961
23962 .section "Private options for pipe" "SECID142"
23963 .cindex "options" "&(pipe)& transport"
23964
23965
23966
23967 .option allow_commands pipe "string list&!!" unset
23968 .cindex "&(pipe)& transport" "permitted commands"
23969 The string is expanded, and is then interpreted as a colon-separated list of
23970 permitted commands. If &%restrict_to_path%& is not set, the only commands
23971 permitted are those in the &%allow_commands%& list. They need not be absolute
23972 paths; the &%path%& option is still used for relative paths. If
23973 &%restrict_to_path%& is set with &%allow_commands%&, the command must either be
23974 in the &%allow_commands%& list, or a name without any slashes that is found on
23975 the path. In other words, if neither &%allow_commands%& nor
23976 &%restrict_to_path%& is set, there is no restriction on the command, but
23977 otherwise only commands that are permitted by one or the other are allowed. For
23978 example, if
23979 .code
23980 allow_commands = /usr/bin/vacation
23981 .endd
23982 and &%restrict_to_path%& is not set, the only permitted command is
23983 &_/usr/bin/vacation_&. The &%allow_commands%& option may not be set if
23984 &%use_shell%& is set.
23985
23986
23987 .option batch_id pipe string&!! unset
23988 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
23989
23990
23991 .option batch_max pipe integer 1
23992 This limits the number of addresses that can be handled in a single delivery.
23993 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
23994
23995
23996 .option check_string pipe string unset
23997 As &(pipe)& writes the message, the start of each line is tested for matching
23998 &%check_string%&, and if it does, the initial matching characters are replaced
23999 by the contents of &%escape_string%&, provided both are set. The value of
24000 &%check_string%& is a literal string, not a regular expression, and the case of
24001 any letters it contains is significant. When &%use_bsmtp%& is set, the contents
24002 of &%check_string%& and &%escape_string%& are forced to values that implement
24003 the SMTP escaping protocol. Any settings made in the configuration file are
24004 ignored.
24005
24006
24007 .option command pipe string&!! unset
24008 This option need not be set when &(pipe)& is being used to deliver to pipes
24009 obtained directly from address redirections. In other cases, the option must be
24010 set, to provide a command to be run. It need not yield an absolute path (see
24011 the &%path%& option below). The command is split up into separate arguments by
24012 Exim, and each argument is separately expanded, as described in section
24013 &<<SECThowcommandrun>>& above.
24014
24015
24016 .option environment pipe string&!! unset
24017 .cindex "&(pipe)& transport" "environment for command"
24018 .cindex "environment" "&(pipe)& transport"
24019 This option is used to add additional variables to the environment in which the
24020 command runs (see section &<<SECTpipeenv>>& for the default list). Its value is
24021 a string which is expanded, and then interpreted as a colon-separated list of
24022 environment settings of the form <&'name'&>=<&'value'&>.
24023
24024
24025 .option escape_string pipe string unset
24026 See &%check_string%& above.
24027
24028
24029 .option freeze_exec_fail pipe boolean false
24030 .cindex "exec failure"
24031 .cindex "failure of exec"
24032 .cindex "&(pipe)& transport" "failure of exec"
24033 Failure to exec the command in a pipe transport is by default treated like
24034 any other failure while running the command. However, if &%freeze_exec_fail%&
24035 is set, failure to exec is treated specially, and causes the message to be
24036 frozen, whatever the setting of &%ignore_status%&.
24037
24038
24039 .option freeze_signal pipe boolean false
24040 .cindex "signal exit"
24041 .cindex "&(pipe)& transport", "signal exit"
24042 Normally if the process run by a command in a pipe transport exits on a signal,
24043 a bounce message is sent. If &%freeze_signal%& is set, the message will be
24044 frozen in Exim's queue instead.
24045
24046
24047 .option force_command pipe boolean false
24048 .cindex "force command"
24049 .cindex "&(pipe)& transport", "force command"
24050 Normally when a router redirects an address directly to a pipe command
24051 the &%command%& option on the transport is ignored.  If &%force_command%&
24052 is set, the &%command%& option will used. This is especially
24053 useful for forcing a wrapper or additional argument to be added to the
24054 command. For example:
24055 .code
24056 command = /usr/bin/remote_exec myhost -- $address_pipe
24057 force_command
24058 .endd
24059
24060 Note that &$address_pipe$& is handled specially in &%command%& when
24061 &%force_command%& is set, expanding out to the original argument vector as
24062 separate items, similarly to a Unix shell &`"$@"`& construct.
24063
24064
24065 .option ignore_status pipe boolean false
24066 If this option is true, the status returned by the subprocess that is set up to
24067 run the command is ignored, and Exim behaves as if zero had been returned.
24068 Otherwise, a non-zero status or termination by signal causes an error return
24069 from the transport unless the status value is one of those listed in
24070 &%temp_errors%&; these cause the delivery to be deferred and tried again later.
24071
24072 &*Note*&: This option does not apply to timeouts, which do not return a status.
24073 See the &%timeout_defer%& option for how timeouts are handled.
24074
24075
24076 .option log_defer_output pipe boolean false
24077 .cindex "&(pipe)& transport" "logging output"
24078 If this option is set, and the status returned by the command is
24079 one of the codes listed in &%temp_errors%& (that is, delivery was deferred),
24080 and any output was produced on stdout or stderr, the first line of it is
24081 written to the main log.
24082
24083
24084 .option log_fail_output pipe boolean false
24085 If this option is set, and the command returns any output on stdout or
24086 stderr, and also ends with a return code that is neither zero nor one of
24087 the return codes listed in &%temp_errors%& (that is, the delivery
24088 failed), the first line of output is written to the main log. This
24089 option and &%log_output%& are mutually exclusive.  Only one of them may
24090 be set.
24091
24092
24093 .option log_output pipe boolean false
24094 If this option is set and the command returns any output on stdout or
24095 stderr, the first line of output is written to the main log, whatever
24096 the return code. This option and &%log_fail_output%& are mutually
24097 exclusive. Only one of them may be set.
24098
24099
24100 .option max_output pipe integer 20K
24101 This specifies the maximum amount of output that the command may produce on its
24102 standard output and standard error file combined. If the limit is exceeded, the
24103 process running the command is killed. This is intended as a safety measure to
24104 catch runaway processes. The limit is applied independently of the settings of
24105 the options that control what is done with such output (for example,
24106 &%return_output%&). Because of buffering effects, the amount of output may
24107 exceed the limit by a small amount before Exim notices.
24108
24109
24110 .option message_prefix pipe string&!! "see below"
24111 The string specified here is expanded and output at the start of every message.
24112 The default is unset if &%use_bsmtp%& is set. Otherwise it is
24113 .code
24114 message_prefix = \
24115   From ${if def:return_path{$return_path}{MAILER-DAEMON}}\
24116   ${tod_bsdinbox}\n
24117 .endd
24118 .cindex "Cyrus"
24119 .cindex "&%tmail%&"
24120 .cindex "&""From""& line"
24121 This is required by the commonly used &_/usr/bin/vacation_& program.
24122 However, it must &'not'& be present if delivery is to the Cyrus IMAP server,
24123 or to the &%tmail%& local delivery agent. The prefix can be suppressed by
24124 setting
24125 .code
24126 message_prefix =
24127 .endd
24128 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
24129 &`\n`& to &`\r\n`& in &%message_prefix%&.
24130
24131
24132 .option message_suffix pipe string&!! "see below"
24133 The string specified here is expanded and output at the end of every message.
24134 The default is unset if &%use_bsmtp%& is set. Otherwise it is a single newline.
24135 The suffix can be suppressed by setting
24136 .code
24137 message_suffix =
24138 .endd
24139 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
24140 &`\n`& to &`\r\n`& in &%message_suffix%&.
24141
24142
24143 .option path pipe string&!! "/bin:/usr/bin"
24144 This option is expanded and
24145 specifies the string that is set up in the PATH environment
24146 variable of the subprocess.
24147 If the &%command%& option does not yield an absolute path name, the command is
24148 sought in the PATH directories, in the usual way. &*Warning*&: This does not
24149 apply to a command specified as a transport filter.
24150
24151
24152 .option permit_coredump pipe boolean false
24153 Normally Exim inhibits core-dumps during delivery.  If you have a need to get
24154 a core-dump of a pipe command, enable this command.  This enables core-dumps
24155 during delivery and affects both the Exim binary and the pipe command run.
24156 It is recommended that this option remain off unless and until you have a need
24157 for it and that this only be enabled when needed, as the risk of excessive
24158 resource consumption can be quite high.  Note also that Exim is typically
24159 installed as a setuid binary and most operating systems will inhibit coredumps
24160 of these by default, so further OS-specific action may be required.
24161
24162
24163 .option pipe_as_creator pipe boolean false
24164 .cindex "uid (user id)" "local delivery"
24165 If the generic &%user%& option is not set and this option is true, the delivery
24166 process is run under the uid that was in force when Exim was originally called
24167 to accept the message. If the group id is not otherwise set (via the generic
24168 &%group%& option), the gid that was in force when Exim was originally called to
24169 accept the message is used.
24170
24171
24172 .option restrict_to_path pipe boolean false
24173 When this option is set, any command name not listed in &%allow_commands%& must
24174 contain no slashes. The command is searched for only in the directories listed
24175 in the &%path%& option. This option is intended for use in the case when a pipe
24176 command has been generated from a user's &_.forward_& file. This is usually
24177 handled by a &(pipe)& transport called &%address_pipe%&.
24178
24179
24180 .option return_fail_output pipe boolean false
24181 If this option is true, and the command produced any output and ended with a
24182 return code other than zero or one of the codes listed in &%temp_errors%& (that
24183 is, the delivery failed), the output is returned in the bounce message.
24184 However, if the message has a null sender (that is, it is itself a bounce
24185 message), output from the command is discarded. This option and
24186 &%return_output%& are mutually exclusive. Only one of them may be set.
24187
24188
24189
24190 .option return_output pipe boolean false
24191 If this option is true, and the command produced any output, the delivery is
24192 deemed to have failed whatever the return code from the command, and the output
24193 is returned in the bounce message. Otherwise, the output is just discarded.
24194 However, if the message has a null sender (that is, it is a bounce message),
24195 output from the command is always discarded, whatever the setting of this
24196 option. This option and &%return_fail_output%& are mutually exclusive. Only one
24197 of them may be set.
24198
24199
24200
24201 .option temp_errors pipe "string list" "see below"
24202 .cindex "&(pipe)& transport" "temporary failure"
24203 This option contains either a colon-separated list of numbers, or a single
24204 asterisk. If &%ignore_status%& is false
24205 and &%return_output%& is not set,
24206 and the command exits with a non-zero return code, the failure is treated as
24207 temporary and the delivery is deferred if the return code matches one of the
24208 numbers, or if the setting is a single asterisk. Otherwise, non-zero return
24209 codes are treated as permanent errors. The default setting contains the codes
24210 defined by EX_TEMPFAIL and EX_CANTCREAT in &_sysexits.h_&. If Exim is
24211 compiled on a system that does not define these macros, it assumes values of 75
24212 and 73, respectively.
24213
24214
24215 .option timeout pipe time 1h
24216 If the command fails to complete within this time, it is killed. This normally
24217 causes the delivery to fail (but see &%timeout_defer%&). A zero time interval
24218 specifies no timeout. In order to ensure that any subprocesses created by the
24219 command are also killed, Exim makes the initial process a process group leader,
24220 and kills the whole process group on a timeout. However, this can be defeated
24221 if one of the processes starts a new process group.
24222
24223 .option timeout_defer pipe boolean false
24224 A timeout in a &(pipe)& transport, either in the command that the transport
24225 runs, or in a transport filter that is associated with it, is by default
24226 treated as a hard error, and the delivery fails. However, if &%timeout_defer%&
24227 is set true, both kinds of timeout become temporary errors, causing the
24228 delivery to be deferred.
24229
24230 .option umask pipe "octal integer" 022
24231 This specifies the umask setting for the subprocess that runs the command.
24232
24233
24234 .option use_bsmtp pipe boolean false
24235 .cindex "envelope sender"
24236 If this option is set true, the &(pipe)& transport writes messages in &"batch
24237 SMTP"& format, with the envelope sender and recipient(s) included as SMTP
24238 commands. If you want to include a leading HELO command with such messages,
24239 you can do so by setting the &%message_prefix%& option. See section
24240 &<<SECTbatchSMTP>>& for details of batch SMTP.
24241
24242 .option use_classresources pipe boolean false
24243 .cindex "class resources (BSD)"
24244 This option is available only when Exim is running on FreeBSD, NetBSD, or
24245 BSD/OS. If it is set true, the &[setclassresources()]& function is used to set
24246 resource limits when a &(pipe)& transport is run to perform a delivery. The
24247 limits for the uid under which the pipe is to run are obtained from the login
24248 class database.
24249
24250
24251 .option use_crlf pipe boolean false
24252 .cindex "carriage return"
24253 .cindex "linefeed"
24254 This option causes lines to be terminated with the two-character CRLF sequence
24255 (carriage return, linefeed) instead of just a linefeed character. In the case
24256 of batched SMTP, the byte sequence written to the pipe is then an exact image
24257 of what would be sent down a real SMTP connection.
24258
24259 The contents of the &%message_prefix%& and &%message_suffix%& options are
24260 written verbatim, so must contain their own carriage return characters if these
24261 are needed. When &%use_bsmtp%& is not set, the default values for both
24262 &%message_prefix%& and &%message_suffix%& end with a single linefeed, so their
24263 values must be changed to end with &`\r\n`& if &%use_crlf%& is set.
24264
24265
24266 .option use_shell pipe boolean false
24267 .vindex "&$pipe_addresses$&"
24268 If this option is set, it causes the command to be passed to &_/bin/sh_&
24269 instead of being run directly from the transport, as described in section
24270 &<<SECThowcommandrun>>&. This is less secure, but is needed in some situations
24271 where the command is expected to be run under a shell and cannot easily be
24272 modified. The &%allow_commands%& and &%restrict_to_path%& options, and the
24273 &`$pipe_addresses`& facility are incompatible with &%use_shell%&. The
24274 command is expanded as a single string, and handed to &_/bin/sh_& as data for
24275 its &%-c%& option.
24276
24277
24278
24279 .section "Using an external local delivery agent" "SECID143"
24280 .cindex "local delivery" "using an external agent"
24281 .cindex "&'procmail'&"
24282 .cindex "external local delivery"
24283 .cindex "delivery" "&'procmail'&"
24284 .cindex "delivery" "by external agent"
24285 The &(pipe)& transport can be used to pass all messages that require local
24286 delivery to a separate local delivery agent such as &%procmail%&. When doing
24287 this, care must be taken to ensure that the pipe is run under an appropriate
24288 uid and gid. In some configurations one wants this to be a uid that is trusted
24289 by the delivery agent to supply the correct sender of the message. It may be
24290 necessary to recompile or reconfigure the delivery agent so that it trusts an
24291 appropriate user. The following is an example transport and router
24292 configuration for &%procmail%&:
24293 .code
24294 # transport
24295 procmail_pipe:
24296   driver = pipe
24297   command = /usr/local/bin/procmail -d $local_part
24298   return_path_add
24299   delivery_date_add
24300   envelope_to_add
24301   check_string = "From "
24302   escape_string = ">From "
24303   umask = 077
24304   user = $local_part
24305   group = mail
24306
24307 # router
24308 procmail:
24309   driver = accept
24310   check_local_user
24311   transport = procmail_pipe
24312 .endd
24313 In this example, the pipe is run as the local user, but with the group set to
24314 &'mail'&. An alternative is to run the pipe as a specific user such as &'mail'&
24315 or &'exim'&, but in this case you must arrange for &%procmail%& to trust that
24316 user to supply a correct sender address. If you do not specify either a
24317 &%group%& or a &%user%& option, the pipe command is run as the local user. The
24318 home directory is the user's home directory by default.
24319
24320 &*Note*&: The command that the pipe transport runs does &'not'& begin with
24321 .code
24322 IFS=" "
24323 .endd
24324 as shown in some &%procmail%& documentation, because Exim does not by default
24325 use a shell to run pipe commands.
24326
24327 .cindex "Cyrus"
24328 The next example shows a transport and a router for a system where local
24329 deliveries are handled by the Cyrus IMAP server.
24330 .code
24331 # transport
24332 local_delivery_cyrus:
24333   driver = pipe
24334   command = /usr/cyrus/bin/deliver \
24335             -m ${substr_1:$local_part_suffix} -- $local_part
24336   user = cyrus
24337   group = mail
24338   return_output
24339   log_output
24340   message_prefix =
24341   message_suffix =
24342
24343 # router
24344 local_user_cyrus:
24345   driver = accept
24346   check_local_user
24347   local_part_suffix = .*
24348   transport = local_delivery_cyrus
24349 .endd
24350 Note the unsetting of &%message_prefix%& and &%message_suffix%&, and the use of
24351 &%return_output%& to cause any text written by Cyrus to be returned to the
24352 sender.
24353 .ecindex IIDpiptra1
24354 .ecindex IIDpiptra2
24355
24356
24357 . ////////////////////////////////////////////////////////////////////////////
24358 . ////////////////////////////////////////////////////////////////////////////
24359
24360 .chapter "The smtp transport" "CHAPsmtptrans"
24361 .scindex IIDsmttra1 "transports" "&(smtp)&"
24362 .scindex IIDsmttra2 "&(smtp)& transport"
24363 The &(smtp)& transport delivers messages over TCP/IP connections using the SMTP
24364 or LMTP protocol. The list of hosts to try can either be taken from the address
24365 that is being processed (having been set up by the router), or specified
24366 explicitly for the transport. Timeout and retry processing (see chapter
24367 &<<CHAPretry>>&) is applied to each IP address independently.
24368
24369
24370 .section "Multiple messages on a single connection" "SECID144"
24371 The sending of multiple messages over a single TCP/IP connection can arise in
24372 two ways:
24373
24374 .ilist
24375 If a message contains more than &%max_rcpt%& (see below) addresses that are
24376 routed to the same host, more than one copy of the message has to be sent to
24377 that host. In this situation, multiple copies may be sent in a single run of
24378 the &(smtp)& transport over a single TCP/IP connection. (What Exim actually
24379 does when it has too many addresses to send in one message also depends on the
24380 value of the global &%remote_max_parallel%& option. Details are given in
24381 section &<<SECToutSMTPTCP>>&.)
24382 .next
24383 .cindex "hints database" "remembering routing"
24384 When a message has been successfully delivered over a TCP/IP connection, Exim
24385 looks in its hints database to see if there are any other messages awaiting a
24386 connection to the same host. If there are, a new delivery process is started
24387 for one of them, and the current TCP/IP connection is passed on to it. The new
24388 process may in turn send multiple copies and possibly create yet another
24389 process.
24390 .endlist
24391
24392
24393 For each copy sent over the same TCP/IP connection, a sequence counter is
24394 incremented, and if it ever gets to the value of &%connection_max_messages%&,
24395 no further messages are sent over that connection.
24396
24397
24398
24399 .section "Use of the $host and $host_address variables" "SECID145"
24400 .vindex "&$host$&"
24401 .vindex "&$host_address$&"
24402 At the start of a run of the &(smtp)& transport, the values of &$host$& and
24403 &$host_address$& are the name and IP address of the first host on the host list
24404 passed by the router. However, when the transport is about to connect to a
24405 specific host, and while it is connected to that host, &$host$& and
24406 &$host_address$& are set to the values for that host. These are the values
24407 that are in force when the &%helo_data%&, &%hosts_try_auth%&, &%interface%&,
24408 &%serialize_hosts%&, and the various TLS options are expanded.
24409
24410
24411 .section "Use of $tls_cipher and $tls_peerdn" "usecippeer"
24412 .vindex &$tls_bits$&
24413 .vindex &$tls_cipher$&
24414 .vindex &$tls_peerdn$&
24415 .vindex &$tls_sni$&
24416 At the start of a run of the &(smtp)& transport, the values of &$tls_bits$&,
24417 &$tls_cipher$&, &$tls_peerdn$& and &$tls_sni$&
24418 are the values that were set when the message was received.
24419 These are the values that are used for options that are expanded before any
24420 SMTP connections are made. Just before each connection is made, these four
24421 variables are emptied. If TLS is subsequently started, they are set to the
24422 appropriate values for the outgoing connection, and these are the values that
24423 are in force when any authenticators are run and when the
24424 &%authenticated_sender%& option is expanded.
24425
24426 These variables are deprecated in favour of &$tls_in_cipher$& et. al.
24427 and will be removed in a future release.
24428
24429
24430 .section "Private options for smtp" "SECID146"
24431 .cindex "options" "&(smtp)& transport"
24432 The private options of the &(smtp)& transport are as follows:
24433
24434
24435 .option address_retry_include_sender smtp boolean true
24436 .cindex "4&'xx'& responses" "retrying after"
24437 When an address is delayed because of a 4&'xx'& response to a RCPT command, it
24438 is the combination of sender and recipient that is delayed in subsequent queue
24439 runs until the retry time is reached. You can delay the recipient without
24440 reference to the sender (which is what earlier versions of Exim did), by
24441 setting &%address_retry_include_sender%& false. However, this can lead to
24442 problems with servers that regularly issue 4&'xx'& responses to RCPT commands.
24443
24444 .option allow_localhost smtp boolean false
24445 .cindex "local host" "sending to"
24446 .cindex "fallback" "hosts specified on transport"
24447 When a host specified in &%hosts%& or &%fallback_hosts%& (see below) turns out
24448 to be the local host, or is listed in &%hosts_treat_as_local%&, delivery is
24449 deferred by default. However, if &%allow_localhost%& is set, Exim goes on to do
24450 the delivery anyway. This should be used only in special cases when the
24451 configuration ensures that no looping will result (for example, a differently
24452 configured Exim is listening on the port to which the message is sent).
24453
24454
24455 .option authenticated_sender smtp string&!! unset
24456 .cindex "Cyrus"
24457 When Exim has authenticated as a client, or if &%authenticated_sender_force%&
24458 is true, this option sets a value for the AUTH= item on outgoing MAIL commands,
24459 overriding any existing authenticated sender value. If the string expansion is
24460 forced to fail, the option is ignored. Other expansion failures cause delivery
24461 to be deferred. If the result of expansion is an empty string, that is also
24462 ignored.
24463
24464 The expansion happens after the outgoing connection has been made and TLS
24465 started, if required. This means that the &$host$&, &$host_address$&,
24466 &$tls_out_cipher$&, and &$tls_out_peerdn$& variables are set according to the
24467 particular connection.
24468
24469 If the SMTP session is not authenticated, the expansion of
24470 &%authenticated_sender%& still happens (and can cause the delivery to be
24471 deferred if it fails), but no AUTH= item is added to MAIL commands
24472 unless &%authenticated_sender_force%& is true.
24473
24474 This option allows you to use the &(smtp)& transport in LMTP mode to
24475 deliver mail to Cyrus IMAP and provide the proper local part as the
24476 &"authenticated sender"&, via a setting such as:
24477 .code
24478 authenticated_sender = $local_part
24479 .endd
24480 This removes the need for IMAP subfolders to be assigned special ACLs to
24481 allow direct delivery to those subfolders.
24482
24483 Because of expected uses such as that just described for Cyrus (when no
24484 domain is involved), there is no checking on the syntax of the provided
24485 value.
24486
24487
24488 .option authenticated_sender_force smtp boolean false
24489 If this option is set true, the &%authenticated_sender%& option's value
24490 is used for the AUTH= item on outgoing MAIL commands, even if Exim has not
24491 authenticated as a client.
24492
24493
24494 .option command_timeout smtp time 5m
24495 This sets a timeout for receiving a response to an SMTP command that has been
24496 sent out. It is also used when waiting for the initial banner line from the
24497 remote host. Its value must not be zero.
24498
24499
24500 .option connect_timeout smtp time 5m
24501 This sets a timeout for the &[connect()]& function, which sets up a TCP/IP call
24502 to a remote host. A setting of zero allows the system timeout (typically
24503 several minutes) to act. To have any effect, the value of this option must be
24504 less than the system timeout. However, it has been observed that on some
24505 systems there is no system timeout, which is why the default value for this
24506 option is 5 minutes, a value recommended by RFC 1123.
24507
24508
24509 .option connection_max_messages smtp integer 500
24510 .cindex "SMTP" "passed connection"
24511 .cindex "SMTP" "multiple deliveries"
24512 .cindex "multiple SMTP deliveries"
24513 This controls the maximum number of separate message deliveries that are sent
24514 over a single TCP/IP connection. If the value is zero, there is no limit.
24515 For testing purposes, this value can be overridden by the &%-oB%& command line
24516 option.
24517
24518
24519 .option dane_require_tls_ciphers smtp string&!! unset
24520 .cindex "TLS" "requiring specific ciphers for DANE"
24521 .cindex "cipher" "requiring specific"
24522 .cindex DANE "TLS ciphers"
24523 This option may be used to override &%tls_require_ciphers%& for connections
24524 where DANE has been determined to be in effect.
24525 If not set, then &%tls_require_ciphers%& will be used.
24526 Normal SMTP delivery is not able to make strong demands of TLS cipher
24527 configuration, because delivery will fall back to plaintext.  Once DANE has
24528 been determined to be in effect, there is no plaintext fallback and making the
24529 TLS cipherlist configuration stronger will increase security, rather than
24530 counter-intuitively decreasing it.
24531 If the option expands to be empty or is forced to fail, then it will
24532 be treated as unset and &%tls_require_ciphers%& will be used instead.
24533
24534
24535 .option data_timeout smtp time 5m
24536 This sets a timeout for the transmission of each block in the data portion of
24537 the message. As a result, the overall timeout for a message depends on the size
24538 of the message. Its value must not be zero. See also &%final_timeout%&.
24539
24540
24541 .option dkim_canon smtp string&!! unset
24542 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
24543 .option dkim_domain smtp string list&!! unset
24544 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
24545 .option dkim_hash smtp string&!! sha256
24546 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
24547 .option dkim_identity smtp string&!! unset
24548 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
24549 .option dkim_private_key smtp string&!! unset
24550 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
24551 .option dkim_selector smtp string&!! unset
24552 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
24553 .option dkim_strict smtp string&!! unset
24554 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
24555 .option dkim_sign_headers smtp string&!! "per RFC"
24556 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
24557 .option dkim_timestamps smtp string&!! unset
24558 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
24559
24560
24561 .option delay_after_cutoff smtp boolean true
24562 .cindex "final cutoff" "retries, controlling"
24563 .cindex retry "final cutoff"
24564 This option controls what happens when all remote IP addresses for a given
24565 domain have been inaccessible for so long that they have passed their retry
24566 cutoff times.
24567
24568 In the default state, if the next retry time has not been reached for any of
24569 them, the address is bounced without trying any deliveries. In other words,
24570 Exim delays retrying an IP address after the final cutoff time until a new
24571 retry time is reached, and can therefore bounce an address without ever trying
24572 a delivery, when machines have been down for a long time. Some people are
24573 unhappy at this prospect, so...
24574
24575 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
24576 addresses are past their final cutoff time, Exim tries to deliver to those
24577 IP addresses that have not been tried since the message arrived. If there are
24578 none, of if they all fail, the address is bounced. In other words, it does not
24579 delay when a new message arrives, but immediately tries those expired IP
24580 addresses that haven't been tried since the message arrived. If there is a
24581 continuous stream of messages for the dead hosts, unsetting
24582 &%delay_after_cutoff%& means that there will be many more attempts to deliver
24583 to them.
24584
24585
24586 .option dns_qualify_single smtp boolean true
24587 If the &%hosts%& or &%fallback_hosts%& option is being used,
24588 and the &%gethostbyname%& option is false,
24589 the RES_DEFNAMES resolver option is set. See the &%qualify_single%& option
24590 in chapter &<<CHAPdnslookup>>& for more details.
24591
24592
24593 .option dns_search_parents smtp boolean false
24594 If the &%hosts%& or &%fallback_hosts%& option is being used, and the
24595 &%gethostbyname%& option is false, the RES_DNSRCH resolver option is set.
24596 See the &%search_parents%& option in chapter &<<CHAPdnslookup>>& for more
24597 details.
24598
24599
24600 .option dnssec_request_domains smtp "domain list&!!" *
24601 .cindex "MX record" "security"
24602 .cindex "DNSSEC" "MX lookup"
24603 .cindex "security" "MX lookup"
24604 .cindex "DNS" "DNSSEC"
24605 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
24606 the dnssec request bit set. Setting this transport option is only useful if the
24607 transport overrides or sets the host names. See the &%dnssec_request_domains%&
24608 router option.
24609
24610
24611
24612 .option dnssec_require_domains smtp "domain list&!!" unset
24613 .cindex "MX record" "security"
24614 .cindex "DNSSEC" "MX lookup"
24615 .cindex "security" "MX lookup"
24616 .cindex "DNS" "DNSSEC"
24617 DNS lookups for domains matching &%dnssec_require_domains%& will be done with
24618 the dnssec request bit set.  Setting this transport option is only
24619 useful if the transport overrides or sets the host names. See the
24620 &%dnssec_require_domains%& router option.
24621
24622
24623
24624 .option dscp smtp string&!! unset
24625 .cindex "DCSP" "outbound"
24626 This option causes the DSCP value associated with a socket to be set to one
24627 of a number of fixed strings or to numeric value.
24628 The &%-bI:dscp%& option may be used to ask Exim which names it knows of.
24629 Common values include &`throughput`&, &`mincost`&, and on newer systems
24630 &`ef`&, &`af41`&, etc.  Numeric values may be in the range 0 to 0x3F.
24631
24632 The outbound packets from Exim will be marked with this value in the header
24633 (for IPv4, the TOS field; for IPv6, the TCLASS field); there is no guarantee
24634 that these values will have any effect, not be stripped by networking
24635 equipment, or do much of anything without cooperation with your Network
24636 Engineer and those of all network operators between the source and destination.
24637
24638
24639 .option fallback_hosts smtp "string list" unset
24640 .cindex "fallback" "hosts specified on transport"
24641 String expansion is not applied to this option. The argument must be a
24642 colon-separated list of host names or IP addresses, optionally also including
24643 port numbers, though the separator can be changed, as described in section
24644 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
24645 item in a &%route_list%& setting for the &(manualroute)& router, as described
24646 in section &<<SECTformatonehostitem>>&.
24647
24648 Fallback hosts can also be specified on routers, which associate them with the
24649 addresses they process. As for the &%hosts%& option without &%hosts_override%&,
24650 &%fallback_hosts%& specified on the transport is used only if the address does
24651 not have its own associated fallback host list. Unlike &%hosts%&, a setting of
24652 &%fallback_hosts%& on an address is not overridden by &%hosts_override%&.
24653 However, &%hosts_randomize%& does apply to fallback host lists.
24654
24655 If Exim is unable to deliver to any of the hosts for a particular address, and
24656 the errors are not permanent rejections, the address is put on a separate
24657 transport queue with its host list replaced by the fallback hosts, unless the
24658 address was routed via MX records and the current host was in the original MX
24659 list. In that situation, the fallback host list is not used.
24660
24661 Once normal deliveries are complete, the fallback queue is delivered by
24662 re-running the same transports with the new host lists. If several failing
24663 addresses have the same fallback hosts (and &%max_rcpt%& permits it), a single
24664 copy of the message is sent.
24665
24666 The resolution of the host names on the fallback list is controlled by the
24667 &%gethostbyname%& option, as for the &%hosts%& option. Fallback hosts apply
24668 both to cases when the host list comes with the address and when it is taken
24669 from &%hosts%&. This option provides a &"use a smart host only if delivery
24670 fails"& facility.
24671
24672
24673 .option final_timeout smtp time 10m
24674 This is the timeout that applies while waiting for the response to the final
24675 line containing just &"."& that terminates a message. Its value must not be
24676 zero.
24677
24678 .option gethostbyname smtp boolean false
24679 If this option is true when the &%hosts%& and/or &%fallback_hosts%& options are
24680 being used, names are looked up using &[gethostbyname()]&
24681 (or &[getipnodebyname()]& when available)
24682 instead of using the DNS. Of course, that function may in fact use the DNS, but
24683 it may also consult other sources of information such as &_/etc/hosts_&.
24684
24685 .option gnutls_compat_mode smtp boolean unset
24686 This option controls whether GnuTLS is used in compatibility mode in an Exim
24687 server. This reduces security slightly, but improves interworking with older
24688 implementations of TLS.
24689
24690 .option helo_data smtp string&!! "see below"
24691 .cindex "HELO" "argument, setting"
24692 .cindex "EHLO" "argument, setting"
24693 .cindex "LHLO argument setting"
24694 The value of this option is expanded after a connection to a another host has
24695 been set up. The result is used as the argument for the EHLO, HELO, or LHLO
24696 command that starts the outgoing SMTP or LMTP session. The default value of the
24697 option is:
24698 .code
24699 $primary_hostname
24700 .endd
24701 During the expansion, the variables &$host$& and &$host_address$& are set to
24702 the identity of the remote host, and the variables &$sending_ip_address$& and
24703 &$sending_port$& are set to the local IP address and port number that are being
24704 used. These variables can be used to generate different values for different
24705 servers or different local IP addresses. For example, if you want the string
24706 that is used for &%helo_data%& to be obtained by a DNS lookup of the outgoing
24707 interface address, you could use this:
24708 .code
24709 helo_data = ${lookup dnsdb{ptr=$sending_ip_address}{$value}\
24710   {$primary_hostname}}
24711 .endd
24712 The use of &%helo_data%& applies both to sending messages and when doing
24713 callouts.
24714
24715 .option hosts smtp "string list&!!" unset
24716 Hosts are associated with an address by a router such as &(dnslookup)&, which
24717 finds the hosts by looking up the address domain in the DNS, or by
24718 &(manualroute)&, which has lists of hosts in its configuration. However,
24719 email addresses can be passed to the &(smtp)& transport by any router, and not
24720 all of them can provide an associated list of hosts.
24721
24722 The &%hosts%& option specifies a list of hosts to be used if the address being
24723 processed does not have any hosts associated with it. The hosts specified by
24724 &%hosts%& are also used, whether or not the address has its own hosts, if
24725 &%hosts_override%& is set.
24726
24727 The string is first expanded, before being interpreted as a colon-separated
24728 list of host names or IP addresses, possibly including port numbers. The
24729 separator may be changed to something other than colon, as described in section
24730 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
24731 item in a &%route_list%& setting for the &(manualroute)& router, as described
24732 in section &<<SECTformatonehostitem>>&. However, note that the &`/MX`& facility
24733 of the &(manualroute)& router is not available here.
24734
24735 If the expansion fails, delivery is deferred. Unless the failure was caused by
24736 the inability to complete a lookup, the error is logged to the panic log as
24737 well as the main log. Host names are looked up either by searching directly for
24738 address records in the DNS or by calling &[gethostbyname()]& (or
24739 &[getipnodebyname()]& when available), depending on the setting of the
24740 &%gethostbyname%& option. When Exim is compiled with IPv6 support, if a host
24741 that is looked up in the DNS has both IPv4 and IPv6 addresses, both types of
24742 address are used.
24743
24744 During delivery, the hosts are tried in order, subject to their retry status,
24745 unless &%hosts_randomize%& is set.
24746
24747
24748 .option hosts_avoid_esmtp smtp "host list&!!" unset
24749 .cindex "ESMTP, avoiding use of"
24750 .cindex "HELO" "forcing use of"
24751 .cindex "EHLO" "avoiding use of"
24752 .cindex "PIPELINING" "avoiding the use of"
24753 This option is for use with broken hosts that announce ESMTP facilities (for
24754 example, PIPELINING) and then fail to implement them properly. When a host
24755 matches &%hosts_avoid_esmtp%&, Exim sends HELO rather than EHLO at the
24756 start of the SMTP session. This means that it cannot use any of the ESMTP
24757 facilities such as AUTH, PIPELINING, SIZE, and STARTTLS.
24758
24759
24760 .option hosts_avoid_pipelining smtp "host list&!!" unset
24761 .cindex "PIPELINING" "avoiding the use of"
24762 Exim will not use the SMTP PIPELINING extension when delivering to any host
24763 that matches this list, even if the server host advertises PIPELINING support.
24764
24765 .new
24766 .option hosts_pipe_connect smtp "host list&!!" unset
24767 .cindex "pipelining" "early connection"
24768 .cindex "pipelining" PIPE_CONNECT
24769 If Exim is built with the SUPPORT_PIPE_CONNECT build option
24770 this option controls which to hosts the facility watched for
24771 and recorded, and used for subsequent connections.
24772
24773 The retry hints database is used for the record,
24774 and records are subject to the &%retry_data_expire%& option.
24775 When used, the pipelining saves on roundtrip times.
24776 It also turns SMTP into a client-first protocol
24777 so combines well with TCP Fast Open.
24778
24779 See also the &%pipelining_connect_advertise_hosts%& main option.
24780
24781 Note:
24782 When the facility is used, the transport &%helo_data%& option
24783 will be expanded before the &$sending_ip_address$& variable
24784 is filled in.
24785 A check is made for the use of that variable, without the
24786 presence of a &"def:"& test on it, but suitably complex coding
24787 can avoid the check and produce unexpected results.
24788 You have been warned.
24789 .wen
24790
24791
24792 .option hosts_avoid_tls smtp "host list&!!" unset
24793 .cindex "TLS" "avoiding for certain hosts"
24794 Exim will not try to start a TLS session when delivering to any host that
24795 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
24796
24797 .option hosts_verify_avoid_tls smtp "host list&!!" unset
24798 .cindex "TLS" "avoiding for certain hosts"
24799 Exim will not try to start a TLS session for a verify callout,
24800 or when delivering in cutthrough mode,
24801 to any host that matches this list.
24802
24803
24804 .option hosts_max_try smtp integer 5
24805 .cindex "host" "maximum number to try"
24806 .cindex "limit" "number of hosts tried"
24807 .cindex "limit" "number of MX tried"
24808 .cindex "MX record" "maximum tried"
24809 This option limits the number of IP addresses that are tried for any one
24810 delivery in cases where there are temporary delivery errors. Section
24811 &<<SECTvalhosmax>>& describes in detail how the value of this option is used.
24812
24813
24814 .option hosts_max_try_hardlimit smtp integer 50
24815 This is an additional check on the maximum number of IP addresses that Exim
24816 tries for any one delivery. Section &<<SECTvalhosmax>>& describes its use and
24817 why it exists.
24818
24819
24820
24821 .option hosts_nopass_tls smtp "host list&!!" unset
24822 .cindex "TLS" "passing connection"
24823 .cindex "multiple SMTP deliveries"
24824 .cindex "TLS" "multiple message deliveries"
24825 For any host that matches this list, a connection on which a TLS session has
24826 been started will not be passed to a new delivery process for sending another
24827 message on the same connection. See section &<<SECTmulmessam>>& for an
24828 explanation of when this might be needed.
24829
24830 .new
24831 .option hosts_noproxy_tls smtp "host list&!!" unset
24832 .cindex "TLS" "passing connection"
24833 .cindex "multiple SMTP deliveries"
24834 .cindex "TLS" "multiple message deliveries"
24835 For any host that matches this list, a TLS session which has
24836 been started will not be passed to a new delivery process for sending another
24837 message on the same session.
24838 .wen
24839
24840 The traditional implementation closes down TLS and re-starts it in the new
24841 process, on the same open TCP connection, for each successive message
24842 sent.  If permitted by this option a pipe to to the new process is set up
24843 instead, and the original process maintains the TLS connection and proxies
24844 the SMTP connection from and to the new process and any subsequents.
24845 The new process has no access to TLS information, so cannot include it in
24846 logging.
24847
24848
24849
24850 .option hosts_override smtp boolean false
24851 If this option is set and the &%hosts%& option is also set, any hosts that are
24852 attached to the address are ignored, and instead the hosts specified by the
24853 &%hosts%& option are always used. This option does not apply to
24854 &%fallback_hosts%&.
24855
24856
24857 .option hosts_randomize smtp boolean false
24858 .cindex "randomized host list"
24859 .cindex "host" "list of; randomized"
24860 .cindex "fallback" "randomized hosts"
24861 If this option is set, and either the list of hosts is taken from the
24862 &%hosts%& or the &%fallback_hosts%& option, or the hosts supplied by the router
24863 were not obtained from MX records (this includes fallback hosts from the
24864 router), and were not randomized by the router, the order of trying the hosts
24865 is randomized each time the transport runs. Randomizing the order of a host
24866 list can be used to do crude load sharing.
24867
24868 When &%hosts_randomize%& is true, a host list may be split into groups whose
24869 order is separately randomized. This makes it possible to set up MX-like
24870 behaviour. The boundaries between groups are indicated by an item that is just
24871 &`+`& in the host list. For example:
24872 .code
24873 hosts = host1:host2:host3:+:host4:host5
24874 .endd
24875 The order of the first three hosts and the order of the last two hosts is
24876 randomized for each use, but the first three always end up before the last two.
24877 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored.
24878
24879 .option hosts_require_auth smtp "host list&!!" unset
24880 .cindex "authentication" "required by client"
24881 This option provides a list of servers for which authentication must succeed
24882 before Exim will try to transfer a message. If authentication fails for
24883 servers which are not in this list, Exim tries to send unauthenticated. If
24884 authentication fails for one of these servers, delivery is deferred. This
24885 temporary error is detectable in the retry rules, so it can be turned into a
24886 hard failure if required. See also &%hosts_try_auth%&, and chapter
24887 &<<CHAPSMTPAUTH>>& for details of authentication.
24888
24889
24890 .option hosts_request_ocsp smtp "host list&!!" *
24891 .cindex "TLS" "requiring for certain servers"
24892 Exim will request a Certificate Status on a
24893 TLS session for any host that matches this list.
24894 &%tls_verify_certificates%& should also be set for the transport.
24895
24896 .option hosts_require_dane smtp "host list&!!" unset
24897 .cindex DANE "transport options"
24898 .cindex DANE "requiring for certain servers"
24899 If built with DANE support, Exim  will require that a DNSSEC-validated
24900 TLSA record is present for any host matching the list,
24901 and that a DANE-verified TLS connection is made. See
24902 the &%dnssec_request_domains%& router and transport options.
24903 There will be no fallback to in-clear communication.
24904 See section &<<SECDANE>>&.
24905
24906 .option hosts_require_ocsp smtp "host list&!!" unset
24907 .cindex "TLS" "requiring for certain servers"
24908 Exim will request, and check for a valid Certificate Status being given, on a
24909 TLS session for any host that matches this list.
24910 &%tls_verify_certificates%& should also be set for the transport.
24911
24912 .option hosts_require_tls smtp "host list&!!" unset
24913 .cindex "TLS" "requiring for certain servers"
24914 Exim will insist on using a TLS session when delivering to any host that
24915 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
24916 &*Note*&: This option affects outgoing mail only. To insist on TLS for
24917 incoming messages, use an appropriate ACL.
24918
24919 .option hosts_try_auth smtp "host list&!!" unset
24920 .cindex "authentication" "optional in client"
24921 This option provides a list of servers to which, provided they announce
24922 authentication support, Exim will attempt to authenticate as a client when it
24923 connects. If authentication fails, Exim will try to transfer the message
24924 unauthenticated. See also &%hosts_require_auth%&, and chapter
24925 &<<CHAPSMTPAUTH>>& for details of authentication.
24926
24927 .option hosts_try_chunking smtp "host list&!!" *
24928 .cindex CHUNKING "enabling, in client"
24929 .cindex BDAT "SMTP command"
24930 .cindex "RFC 3030" "CHUNKING"
24931 This option provides a list of servers to which, provided they announce
24932 CHUNKING support, Exim will attempt to use BDAT commands rather than DATA.
24933 BDAT will not be used in conjunction with a transport filter.
24934
24935 .option hosts_try_dane smtp "host list&!!" *
24936 .cindex DANE "transport options"
24937 .cindex DANE "attempting for certain servers"
24938 If built with DANE support, Exim  will require that a DNSSEC-validated
24939 TLSA record is present for any host matching the list,
24940 and that a DANE-verified TLS connection is made. See
24941 the &%dnssec_request_domains%& router and transport options.
24942 There will be no fallback to in-clear communication.
24943 See section &<<SECDANE>>&.
24944
24945 .option hosts_try_fastopen smtp "host list&!!" *
24946 .cindex "fast open, TCP" "enabling, in client"
24947 .cindex "TCP Fast Open" "enabling, in client"
24948 .cindex "RFC 7413" "TCP Fast Open"
24949 This option provides a list of servers to which, provided
24950 the facility is supported by this system, Exim will attempt to
24951 perform a TCP Fast Open.
24952 No data is sent on the SYN segment but, if the remote server also
24953 supports the facility, it can send its SMTP banner immediately after
24954 the SYN,ACK segment.  This can save up to one round-trip time.
24955
24956 The facility is only active for previously-contacted servers,
24957 as the initiator must present a cookie in the SYN segment.
24958
24959 On (at least some) current Linux distributions the facility must be enabled
24960 in the kernel by the sysadmin before the support is usable.
24961 There is no option for control of the server side; if the system supports
24962 it it is always enabled.  Note that lengthy operations in the connect ACL,
24963 such as DNSBL lookups, will still delay the emission of the SMTP banner.
24964
24965 .option hosts_try_prdr smtp "host list&!!" *
24966 .cindex "PRDR" "enabling, optional in client"
24967 This option provides a list of servers to which, provided they announce
24968 PRDR support, Exim will attempt to negotiate PRDR
24969 for multi-recipient messages.
24970 The option can usually be left as default.
24971
24972 .option interface smtp "string list&!!" unset
24973 .cindex "bind IP address"
24974 .cindex "IP address" "binding"
24975 .vindex "&$host$&"
24976 .vindex "&$host_address$&"
24977 This option specifies which interface to bind to when making an outgoing SMTP
24978 call. The value is an IP address, not an interface name such as
24979 &`eth0`&. Do not confuse this with the interface address that was used when a
24980 message was received, which is in &$received_ip_address$&, formerly known as
24981 &$interface_address$&. The name was changed to minimize confusion with the
24982 outgoing interface address. There is no variable that contains an outgoing
24983 interface address because, unless it is set by this option, its value is
24984 unknown.
24985
24986 During the expansion of the &%interface%& option the variables &$host$& and
24987 &$host_address$& refer to the host to which a connection is about to be made
24988 during the expansion of the string. Forced expansion failure, or an empty
24989 string result causes the option to be ignored. Otherwise, after expansion, the
24990 string must be a list of IP addresses, colon-separated by default, but the
24991 separator can be changed in the usual way (&<<SECTlistsepchange>>&).
24992 For example:
24993 .code
24994 interface = <; 192.168.123.123 ; 3ffe:ffff:836f::fe86:a061
24995 .endd
24996 The first interface of the correct type (IPv4 or IPv6) is used for the outgoing
24997 connection. If none of them are the correct type, the option is ignored. If
24998 &%interface%& is not set, or is ignored, the system's IP functions choose which
24999 interface to use if the host has more than one.
25000
25001
25002 .option keepalive smtp boolean true
25003 .cindex "keepalive" "on outgoing connection"
25004 This option controls the setting of SO_KEEPALIVE on outgoing TCP/IP socket
25005 connections. When set, it causes the kernel to probe idle connections
25006 periodically, by sending packets with &"old"& sequence numbers. The other end
25007 of the connection should send a acknowledgment if the connection is still okay
25008 or a reset if the connection has been aborted. The reason for doing this is
25009 that it has the beneficial effect of freeing up certain types of connection
25010 that can get stuck when the remote host is disconnected without tidying up the
25011 TCP/IP call properly. The keepalive mechanism takes several hours to detect
25012 unreachable hosts.
25013
25014
25015 .option lmtp_ignore_quota smtp boolean false
25016 .cindex "LMTP" "ignoring quota errors"
25017 If this option is set true when the &%protocol%& option is set to &"lmtp"&, the
25018 string &`IGNOREQUOTA`& is added to RCPT commands, provided that the LMTP server
25019 has advertised support for IGNOREQUOTA in its response to the LHLO command.
25020
25021 .option max_rcpt smtp integer 100
25022 .cindex "RCPT" "maximum number of outgoing"
25023 This option limits the number of RCPT commands that are sent in a single
25024 SMTP message transaction. Each set of addresses is treated independently, and
25025 so can cause parallel connections to the same host if &%remote_max_parallel%&
25026 permits this.
25027
25028
25029 .option multi_domain smtp boolean&!! true
25030 .vindex "&$domain$&"
25031 When this option is set, the &(smtp)& transport can handle a number of
25032 addresses containing a mixture of different domains provided they all resolve
25033 to the same list of hosts. Turning the option off restricts the transport to
25034 handling only one domain at a time. This is useful if you want to use
25035 &$domain$& in an expansion for the transport, because it is set only when there
25036 is a single domain involved in a remote delivery.
25037
25038 It is expanded per-address and can depend on any of
25039 &$address_data$&, &$domain_data$&, &$local_part_data$&,
25040 &$host$&, &$host_address$& and &$host_port$&.
25041
25042 .option port smtp string&!! "see below"
25043 .cindex "port" "sending TCP/IP"
25044 .cindex "TCP/IP" "setting outgoing port"
25045 This option specifies the TCP/IP port on the server to which Exim connects.
25046 &*Note:*& Do not confuse this with the port that was used when a message was
25047 received, which is in &$received_port$&, formerly known as &$interface_port$&.
25048 The name was changed to minimize confusion with the outgoing port. There is no
25049 variable that contains an outgoing port.
25050
25051 If the value of this option begins with a digit it is taken as a port number;
25052 otherwise it is looked up using &[getservbyname()]&. The default value is
25053 normally &"smtp"&,
25054 but if &%protocol%& is set to &"lmtp"& the default is &"lmtp"&
25055 and if &%protocol%& is set to &"smtps"& the default is &"smtps"&.
25056 If the expansion fails, or if a port number cannot be found, delivery
25057 is deferred.
25058
25059 Note that at least one Linux distribution has been seen failing
25060 to put &"smtps"& in its &"/etc/services"& file, resulting is such deferrals.
25061
25062
25063
25064 .option protocol smtp string smtp
25065 .cindex "LMTP" "over TCP/IP"
25066 .cindex "ssmtp protocol" "outbound"
25067 .cindex "TLS" "SSL-on-connect outbound"
25068 .vindex "&$port$&"
25069 If this option is set to &"lmtp"& instead of &"smtp"&, the default value for
25070 the &%port%& option changes to &"lmtp"&, and the transport operates the LMTP
25071 protocol (RFC 2033) instead of SMTP. This protocol is sometimes used for local
25072 deliveries into closed message stores. Exim also has support for running LMTP
25073 over a pipe to a local process &-- see chapter &<<CHAPLMTP>>&.
25074
25075 If this option is set to &"smtps"&, the default value for the &%port%& option
25076 changes to &"smtps"&, and the transport initiates TLS immediately after
25077 connecting, as an outbound SSL-on-connect, instead of using STARTTLS to upgrade.
25078 The Internet standards bodies used to strongly discourage use of this mode,
25079 but as of RFC 8314 it is perferred over STARTTLS for message submission
25080 (as distinct from MTA-MTA communication).
25081
25082
25083 .option retry_include_ip_address smtp boolean&!! true
25084 Exim normally includes both the host name and the IP address in the key it
25085 constructs for indexing retry data after a temporary delivery failure. This
25086 means that when one of several IP addresses for a host is failing, it gets
25087 tried periodically (controlled by the retry rules), but use of the other IP
25088 addresses is not affected.
25089
25090 However, in some dialup environments hosts are assigned a different IP address
25091 each time they connect. In this situation the use of the IP address as part of
25092 the retry key leads to undesirable behaviour. Setting this option false causes
25093 Exim to use only the host name.
25094 Since it is expanded it can be made to depend on the host or domain.
25095
25096
25097 .option serialize_hosts smtp "host list&!!" unset
25098 .cindex "serializing connections"
25099 .cindex "host" "serializing connections"
25100 Because Exim operates in a distributed manner, if several messages for the same
25101 host arrive at around the same time, more than one simultaneous connection to
25102 the remote host can occur. This is not usually a problem except when there is a
25103 slow link between the hosts. In that situation it may be helpful to restrict
25104 Exim to one connection at a time. This can be done by setting
25105 &%serialize_hosts%& to match the relevant hosts.
25106
25107 .cindex "hints database" "serializing deliveries to a host"
25108 Exim implements serialization by means of a hints database in which a record is
25109 written whenever a process connects to one of the restricted hosts. The record
25110 is deleted when the connection is completed. Obviously there is scope for
25111 records to get left lying around if there is a system or program crash. To
25112 guard against this, Exim ignores any records that are more than six hours old.
25113
25114 If you set up this kind of serialization, you should also arrange to delete the
25115 relevant hints database whenever your system reboots. The names of the files
25116 start with &_misc_& and they are kept in the &_spool/db_& directory. There
25117 may be one or two files, depending on the type of DBM in use. The same files
25118 are used for ETRN serialization.
25119
25120 See also the &%max_parallel%& generic transport option.
25121
25122
25123 .option size_addition smtp integer 1024
25124 .cindex "SMTP" "SIZE"
25125 .cindex "message" "size issue for transport filter"
25126 .cindex "size" "of message"
25127 .cindex "transport" "filter"
25128 .cindex "filter" "transport filter"
25129 If a remote SMTP server indicates that it supports the SIZE option of the
25130 MAIL command, Exim uses this to pass over the message size at the start of
25131 an SMTP transaction. It adds the value of &%size_addition%& to the value it
25132 sends, to allow for headers and other text that may be added during delivery by
25133 configuration options or in a transport filter. It may be necessary to increase
25134 this if a lot of text is added to messages.
25135
25136 Alternatively, if the value of &%size_addition%& is set negative, it disables
25137 the use of the SIZE option altogether.
25138
25139
25140 .option socks_proxy smtp string&!! unset
25141 .cindex proxy SOCKS
25142 This option enables use of SOCKS proxies for connections made by the
25143 transport.  For details see section &<<SECTproxySOCKS>>&.
25144
25145
25146 .option tls_certificate smtp string&!! unset
25147 .cindex "TLS" "client certificate, location of"
25148 .cindex "certificate" "client, location of"
25149 .vindex "&$host$&"
25150 .vindex "&$host_address$&"
25151 The value of this option must be the absolute path to a file which contains the
25152 client's certificate, for possible use when sending a message over an encrypted
25153 connection. The values of &$host$& and &$host_address$& are set to the name and
25154 address of the server during the expansion. See chapter &<<CHAPTLS>>& for
25155 details of TLS.
25156
25157 &*Note*&: This option must be set if you want Exim to be able to use a TLS
25158 certificate when sending messages as a client. The global option of the same
25159 name specifies the certificate for Exim as a server; it is not automatically
25160 assumed that the same certificate should be used when Exim is operating as a
25161 client.
25162
25163
25164 .option tls_crl smtp string&!! unset
25165 .cindex "TLS" "client certificate revocation list"
25166 .cindex "certificate" "revocation list for client"
25167 This option specifies a certificate revocation list. The expanded value must
25168 be the name of a file that contains a CRL in PEM format.
25169
25170
25171 .option tls_dh_min_bits smtp integer 1024
25172 .cindex "TLS" "Diffie-Hellman minimum acceptable size"
25173 When establishing a TLS session, if a ciphersuite which uses Diffie-Hellman
25174 key agreement is negotiated, the server will provide a large prime number
25175 for use.  This option establishes the minimum acceptable size of that number.
25176 If the parameter offered by the server is too small, then the TLS handshake
25177 will fail.
25178
25179 Only supported when using GnuTLS.
25180
25181
25182 .option tls_privatekey smtp string&!! unset
25183 .cindex "TLS" "client private key, location of"
25184 .vindex "&$host$&"
25185 .vindex "&$host_address$&"
25186 The value of this option must be the absolute path to a file which contains the
25187 client's private key. This is used when sending a message over an encrypted
25188 connection using a client certificate. The values of &$host$& and
25189 &$host_address$& are set to the name and address of the server during the
25190 expansion. If this option is unset, or the expansion is forced to fail, or the
25191 result is an empty string, the private key is assumed to be in the same file as
25192 the certificate. See chapter &<<CHAPTLS>>& for details of TLS.
25193
25194
25195 .option tls_require_ciphers smtp string&!! unset
25196 .cindex "TLS" "requiring specific ciphers"
25197 .cindex "cipher" "requiring specific"
25198 .vindex "&$host$&"
25199 .vindex "&$host_address$&"
25200 The value of this option must be a list of permitted cipher suites, for use
25201 when setting up an outgoing encrypted connection. (There is a global option of
25202 the same name for controlling incoming connections.) The values of &$host$& and
25203 &$host_address$& are set to the name and address of the server during the
25204 expansion. See chapter &<<CHAPTLS>>& for details of TLS; note that this option
25205 is used in different ways by OpenSSL and GnuTLS (see sections
25206 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&). For GnuTLS, the order of the
25207 ciphers is a preference order.
25208
25209
25210
25211 .option tls_sni smtp string&!! unset
25212 .cindex "TLS" "Server Name Indication"
25213 .vindex "&$tls_sni$&"
25214 If this option is set then it sets the $tls_out_sni variable and causes any
25215 TLS session to pass this value as the Server Name Indication extension to
25216 the remote side, which can be used by the remote side to select an appropriate
25217 certificate and private key for the session.
25218
25219 See &<<SECTtlssni>>& for more information.
25220
25221 Note that for OpenSSL, this feature requires a build of OpenSSL that supports
25222 TLS extensions.
25223
25224
25225
25226
25227 .option tls_tempfail_tryclear smtp boolean true
25228 .cindex "4&'xx'& responses" "to STARTTLS"
25229 When the server host is not in &%hosts_require_tls%&, and there is a problem in
25230 setting up a TLS session, this option determines whether or not Exim should try
25231 to deliver the message unencrypted. If it is set false, delivery to the
25232 current host is deferred; if there are other hosts, they are tried. If this
25233 option is set true, Exim attempts to deliver unencrypted after a 4&'xx'&
25234 response to STARTTLS. Also, if STARTTLS is accepted, but the subsequent
25235 TLS negotiation fails, Exim closes the current connection (because it is in an
25236 unknown state), opens a new one to the same host, and then tries the delivery
25237 in clear.
25238
25239
25240 .option tls_try_verify_hosts smtp "host list&!!" *
25241 .cindex "TLS" "server certificate verification"
25242 .cindex "certificate" "verification of server"
25243 This option gives a list of hosts for which, on encrypted connections,
25244 certificate verification will be tried but need not succeed.
25245 The &%tls_verify_certificates%& option must also be set.
25246 Note that unless the host is in this list
25247 TLS connections will be denied to hosts using self-signed certificates
25248 when &%tls_verify_certificates%& is matched.
25249 The &$tls_out_certificate_verified$& variable is set when
25250 certificate verification succeeds.
25251
25252
25253 .option tls_verify_cert_hostnames smtp "host list&!!" *
25254 .cindex "TLS" "server certificate hostname verification"
25255 .cindex "certificate" "verification of server"
25256 This option give a list of hosts for which,
25257 while verifying the server certificate,
25258 checks will be included on the host name
25259 (note that this will generally be the result of a DNS MX lookup)
25260 versus Subject and Subject-Alternate-Name fields.  Wildcard names are permitted
25261 limited to being the initial component of a 3-or-more component FQDN.
25262
25263 There is no equivalent checking on client certificates.
25264
25265
25266 .option tls_verify_certificates smtp string&!! system
25267 .cindex "TLS" "server certificate verification"
25268 .cindex "certificate" "verification of server"
25269 .vindex "&$host$&"
25270 .vindex "&$host_address$&"
25271 The value of this option must be either the
25272 word "system"
25273 or the absolute path to
25274 a file or directory containing permitted certificates for servers,
25275 for use when setting up an encrypted connection.
25276
25277 The "system" value for the option will use a location compiled into the SSL library.
25278 This is not available for GnuTLS versions preceding 3.0.20; a value of "system"
25279 is taken as empty and an explicit location
25280 must be specified.
25281
25282 The use of a directory for the option value is not available for GnuTLS versions
25283 preceding 3.3.6 and a single file must be used.
25284
25285 With OpenSSL the certificates specified
25286 explicitly
25287 either by file or directory
25288 are added to those given by the system default location.
25289
25290 The values of &$host$& and
25291 &$host_address$& are set to the name and address of the server during the
25292 expansion of this option. See chapter &<<CHAPTLS>>& for details of TLS.
25293
25294 For back-compatibility,
25295 if neither tls_verify_hosts nor tls_try_verify_hosts are set
25296 (a single-colon empty list counts as being set)
25297 and certificate verification fails the TLS connection is closed.
25298
25299
25300 .option tls_verify_hosts smtp "host list&!!" unset
25301 .cindex "TLS" "server certificate verification"
25302 .cindex "certificate" "verification of server"
25303 This option gives a list of hosts for which, on encrypted connections,
25304 certificate verification must succeed.
25305 The &%tls_verify_certificates%& option must also be set.
25306 If both this option and &%tls_try_verify_hosts%& are unset
25307 operation is as if this option selected all hosts.
25308
25309 .option utf8_downconvert smtp integer!! unset
25310 .cindex utf8 "address downconversion"
25311 .cindex i18n "utf8 address downconversion"
25312 If built with internationalization support,
25313 this option controls conversion of UTF-8 in message addresses
25314 to a-label form.
25315 For details see section &<<SECTi18nMTA>>&.
25316
25317
25318
25319
25320 .section "How the limits for the number of hosts to try are used" &&&
25321          "SECTvalhosmax"
25322 .cindex "host" "maximum number to try"
25323 .cindex "limit" "hosts; maximum number tried"
25324 There are two options that are concerned with the number of hosts that are
25325 tried when an SMTP delivery takes place. They are &%hosts_max_try%& and
25326 &%hosts_max_try_hardlimit%&.
25327
25328
25329 The &%hosts_max_try%& option limits the number of hosts that are tried
25330 for a single delivery. However, despite the term &"host"& in its name, the
25331 option actually applies to each IP address independently. In other words, a
25332 multihomed host is treated as several independent hosts, just as it is for
25333 retrying.
25334
25335 Many of the larger ISPs have multiple MX records which often point to
25336 multihomed hosts. As a result, a list of a dozen or more IP addresses may be
25337 created as a result of routing one of these domains.
25338
25339 Trying every single IP address on such a long list does not seem sensible; if
25340 several at the top of the list fail, it is reasonable to assume there is some
25341 problem that is likely to affect all of them. Roughly speaking, the value of
25342 &%hosts_max_try%& is the maximum number that are tried before deferring the
25343 delivery. However, the logic cannot be quite that simple.
25344
25345 Firstly, IP addresses that are skipped because their retry times have not
25346 arrived do not count, and in addition, addresses that are past their retry
25347 limits are also not counted, even when they are tried. This means that when
25348 some IP addresses are past their retry limits, more than the value of
25349 &%hosts_max_retry%& may be tried. The reason for this behaviour is to ensure
25350 that all IP addresses are considered before timing out an email address (but
25351 see below for an exception).
25352
25353 Secondly, when the &%hosts_max_try%& limit is reached, Exim looks down the host
25354 list to see if there is a subsequent host with a different (higher valued) MX.
25355 If there is, that host is considered next, and the current IP address is used
25356 but not counted. This behaviour helps in the case of a domain with a retry rule
25357 that hardly ever delays any hosts, as is now explained:
25358
25359 Consider the case of a long list of hosts with one MX value, and a few with a
25360 higher MX value. If &%hosts_max_try%& is small (the default is 5) only a few
25361 hosts at the top of the list are tried at first. With the default retry rule,
25362 which specifies increasing retry times, the higher MX hosts are eventually
25363 tried when those at the top of the list are skipped because they have not
25364 reached their retry times.
25365
25366 However, it is common practice to put a fixed short retry time on domains for
25367 large ISPs, on the grounds that their servers are rarely down for very long.
25368 Unfortunately, these are exactly the domains that tend to resolve to long lists
25369 of hosts. The short retry time means that the lowest MX hosts are tried every
25370 time. The attempts may be in a different order because of random sorting, but
25371 without the special MX check, the higher MX hosts would never be tried until
25372 all the lower MX hosts had timed out (which might be several days), because
25373 there are always some lower MX hosts that have reached their retry times. With
25374 the special check, Exim considers at least one IP address from each MX value at
25375 every delivery attempt, even if the &%hosts_max_try%& limit has already been
25376 reached.
25377
25378 The above logic means that &%hosts_max_try%& is not a hard limit, and in
25379 particular, Exim normally eventually tries all the IP addresses before timing
25380 out an email address. When &%hosts_max_try%& was implemented, this seemed a
25381 reasonable thing to do. Recently, however, some lunatic DNS configurations have
25382 been set up with hundreds of IP addresses for some domains. It can
25383 take a very long time indeed for an address to time out in these cases.
25384
25385 The &%hosts_max_try_hardlimit%& option was added to help with this problem.
25386 Exim never tries more than this number of IP addresses; if it hits this limit
25387 and they are all timed out, the email address is bounced, even though not all
25388 possible IP addresses have been tried.
25389 .ecindex IIDsmttra1
25390 .ecindex IIDsmttra2
25391
25392
25393
25394
25395
25396 . ////////////////////////////////////////////////////////////////////////////
25397 . ////////////////////////////////////////////////////////////////////////////
25398
25399 .chapter "Address rewriting" "CHAPrewrite"
25400 .scindex IIDaddrew "rewriting" "addresses"
25401 There are some circumstances in which Exim automatically rewrites domains in
25402 addresses. The two most common are when an address is given without a domain
25403 (referred to as an &"unqualified address"&) or when an address contains an
25404 abbreviated domain that is expanded by DNS lookup.
25405
25406 Unqualified envelope addresses are accepted only for locally submitted
25407 messages, or for messages that are received from hosts matching
25408 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
25409 appropriate. Unqualified addresses in header lines are qualified if they are in
25410 locally submitted messages, or messages from hosts that are permitted to send
25411 unqualified envelope addresses. Otherwise, unqualified addresses in header
25412 lines are neither qualified nor rewritten.
25413
25414 One situation in which Exim does &'not'& automatically rewrite a domain is
25415 when it is the name of a CNAME record in the DNS. The older RFCs suggest that
25416 such a domain should be rewritten using the &"canonical"& name, and some MTAs
25417 do this. The new RFCs do not contain this suggestion.
25418
25419
25420 .section "Explicitly configured address rewriting" "SECID147"
25421 This chapter describes the rewriting rules that can be used in the
25422 main rewrite section of the configuration file, and also in the generic
25423 &%headers_rewrite%& option that can be set on any transport.
25424
25425 Some people believe that configured address rewriting is a Mortal Sin.
25426 Others believe that life is not possible without it. Exim provides the
25427 facility; you do not have to use it.
25428
25429 The main rewriting rules that appear in the &"rewrite"& section of the
25430 configuration file are applied to addresses in incoming messages, both envelope
25431 addresses and addresses in header lines. Each rule specifies the types of
25432 address to which it applies.
25433
25434 Whether or not addresses in header lines are rewritten depends on the origin of
25435 the headers and the type of rewriting. Global rewriting, that is, rewriting
25436 rules from the rewrite section of the configuration file, is applied only to
25437 those headers that were received with the message. Header lines that are added
25438 by ACLs or by a system filter or by individual routers or transports (which
25439 are specific to individual recipient addresses) are not rewritten by the global
25440 rules.
25441
25442 Rewriting at transport time, by means of the &%headers_rewrite%& option,
25443 applies all headers except those added by routers and transports. That is, as
25444 well as the headers that were received with the message, it also applies to
25445 headers that were added by an ACL or a system filter.
25446
25447
25448 In general, rewriting addresses from your own system or domain has some
25449 legitimacy. Rewriting other addresses should be done only with great care and
25450 in special circumstances. The author of Exim believes that rewriting should be
25451 used sparingly, and mainly for &"regularizing"& addresses in your own domains.
25452 Although it can sometimes be used as a routing tool, this is very strongly
25453 discouraged.
25454
25455 There are two commonly encountered circumstances where rewriting is used, as
25456 illustrated by these examples:
25457
25458 .ilist
25459 The company whose domain is &'hitch.fict.example'& has a number of hosts that
25460 exchange mail with each other behind a firewall, but there is only a single
25461 gateway to the outer world. The gateway rewrites &'*.hitch.fict.example'& as
25462 &'hitch.fict.example'& when sending mail off-site.
25463 .next
25464 A host rewrites the local parts of its own users so that, for example,
25465 &'fp42@hitch.fict.example'& becomes &'Ford.Prefect@hitch.fict.example'&.
25466 .endlist
25467
25468
25469
25470 .section "When does rewriting happen?" "SECID148"
25471 .cindex "rewriting" "timing of"
25472 .cindex "&ACL;" "rewriting addresses in"
25473 Configured address rewriting can take place at several different stages of a
25474 message's processing.
25475
25476 .vindex "&$sender_address$&"
25477 At the start of an ACL for MAIL, the sender address may have been rewritten
25478 by a special SMTP-time rewrite rule (see section &<<SECTrewriteS>>&), but no
25479 ordinary rewrite rules have yet been applied. If, however, the sender address
25480 is verified in the ACL, it is rewritten before verification, and remains
25481 rewritten thereafter. The subsequent value of &$sender_address$& is the
25482 rewritten address. This also applies if sender verification happens in a
25483 RCPT ACL. Otherwise, when the sender address is not verified, it is
25484 rewritten as soon as a message's header lines have been received.
25485
25486 .vindex "&$domain$&"
25487 .vindex "&$local_part$&"
25488 Similarly, at the start of an ACL for RCPT, the current recipient's address
25489 may have been rewritten by a special SMTP-time rewrite rule, but no ordinary
25490 rewrite rules have yet been applied to it. However, the behaviour is different
25491 from the sender address when a recipient is verified. The address is rewritten
25492 for the verification, but the rewriting is not remembered at this stage. The
25493 value of &$local_part$& and &$domain$& after verification are always the same
25494 as they were before (that is, they contain the unrewritten &-- except for
25495 SMTP-time rewriting &-- address).
25496
25497 As soon as a message's header lines have been received, all the envelope
25498 recipient addresses are permanently rewritten, and rewriting is also applied to
25499 the addresses in the header lines (if configured). This happens before adding
25500 any header lines that were specified in MAIL or RCPT ACLs, and
25501 .cindex "&[local_scan()]& function" "address rewriting; timing of"
25502 before the DATA ACL and &[local_scan()]& functions are run.
25503
25504 When an address is being routed, either for delivery or for verification,
25505 rewriting is applied immediately to child addresses that are generated by
25506 redirection, unless &%no_rewrite%& is set on the router.
25507
25508 .cindex "envelope from"
25509 .cindex "envelope sender" "rewriting at transport time"
25510 .cindex "rewriting" "at transport time"
25511 .cindex "header lines" "rewriting at transport time"
25512 At transport time, additional rewriting of addresses in header lines can be
25513 specified by setting the generic &%headers_rewrite%& option on a transport.
25514 This option contains rules that are identical in form to those in the rewrite
25515 section of the configuration file. They are applied to the original message
25516 header lines and any that were added by ACLs or a system filter. They are not
25517 applied to header lines that are added by routers or the transport.
25518
25519 The outgoing envelope sender can be rewritten by means of the &%return_path%&
25520 transport option. However, it is not possible to rewrite envelope recipients at
25521 transport time.
25522
25523
25524
25525
25526 .section "Testing the rewriting rules that apply on input" "SECID149"
25527 .cindex "rewriting" "testing"
25528 .cindex "testing" "rewriting"
25529 Exim's input rewriting configuration appears in a part of the runtime
25530 configuration file headed by &"begin rewrite"&. It can be tested by the
25531 &%-brw%& command line option. This takes an address (which can be a full RFC
25532 2822 address) as its argument. The output is a list of how the address would be
25533 transformed by the rewriting rules for each of the different places it might
25534 appear in an incoming message, that is, for each different header and for the
25535 envelope sender and recipient fields. For example,
25536 .code
25537 exim -brw ph10@exim.workshop.example
25538 .endd
25539 might produce the output
25540 .code
25541 sender: Philip.Hazel@exim.workshop.example
25542 from: Philip.Hazel@exim.workshop.example
25543 to: ph10@exim.workshop.example
25544 cc: ph10@exim.workshop.example
25545 bcc: ph10@exim.workshop.example
25546 reply-to: Philip.Hazel@exim.workshop.example
25547 env-from: Philip.Hazel@exim.workshop.example
25548 env-to: ph10@exim.workshop.example
25549 .endd
25550 which shows that rewriting has been set up for that address when used in any of
25551 the source fields, but not when it appears as a recipient address. At the
25552 present time, there is no equivalent way of testing rewriting rules that are
25553 set for a particular transport.
25554
25555
25556 .section "Rewriting rules" "SECID150"
25557 .cindex "rewriting" "rules"
25558 The rewrite section of the configuration file consists of lines of rewriting
25559 rules in the form
25560 .display
25561 <&'source pattern'&>  <&'replacement'&>  <&'flags'&>
25562 .endd
25563 Rewriting rules that are specified for the &%headers_rewrite%& generic
25564 transport option are given as a colon-separated list. Each item in the list
25565 takes the same form as a line in the main rewriting configuration (except that
25566 any colons must be doubled, of course).
25567
25568 The formats of source patterns and replacement strings are described below.
25569 Each is terminated by white space, unless enclosed in double quotes, in which
25570 case normal quoting conventions apply inside the quotes. The flags are single
25571 characters which may appear in any order. Spaces and tabs between them are
25572 ignored.
25573
25574 For each address that could potentially be rewritten, the rules are scanned in
25575 order, and replacements for the address from earlier rules can themselves be
25576 replaced by later rules (but see the &"q"& and &"R"& flags).
25577
25578 The order in which addresses are rewritten is undefined, may change between
25579 releases, and must not be relied on, with one exception: when a message is
25580 received, the envelope sender is always rewritten first, before any header
25581 lines are rewritten. For example, the replacement string for a rewrite of an
25582 address in &'To:'& must not assume that the message's address in &'From:'& has
25583 (or has not) already been rewritten. However, a rewrite of &'From:'& may assume
25584 that the envelope sender has already been rewritten.
25585
25586 .vindex "&$domain$&"
25587 .vindex "&$local_part$&"
25588 The variables &$local_part$& and &$domain$& can be used in the replacement
25589 string to refer to the address that is being rewritten. Note that lookup-driven
25590 rewriting can be done by a rule of the form
25591 .code
25592 *@*   ${lookup ...
25593 .endd
25594 where the lookup key uses &$1$& and &$2$& or &$local_part$& and &$domain$& to
25595 refer to the address that is being rewritten.
25596
25597
25598 .section "Rewriting patterns" "SECID151"
25599 .cindex "rewriting" "patterns"
25600 .cindex "address list" "in a rewriting pattern"
25601 The source pattern in a rewriting rule is any item which may appear in an
25602 address list (see section &<<SECTaddresslist>>&). It is in fact processed as a
25603 single-item address list, which means that it is expanded before being tested
25604 against the address. As always, if you use a regular expression as a pattern,
25605 you must take care to escape dollar and backslash characters, or use the &`\N`&
25606 facility to suppress string expansion within the regular expression.
25607
25608 Domains in patterns should be given in lower case. Local parts in patterns are
25609 case-sensitive. If you want to do case-insensitive matching of local parts, you
25610 can use a regular expression that starts with &`^(?i)`&.
25611
25612 .cindex "numerical variables (&$1$& &$2$& etc)" "in rewriting rules"
25613 After matching, the numerical variables &$1$&, &$2$&, etc. may be set,
25614 depending on the type of match which occurred. These can be used in the
25615 replacement string to insert portions of the incoming address. &$0$& always
25616 refers to the complete incoming address. When a regular expression is used, the
25617 numerical variables are set from its capturing subexpressions. For other types
25618 of pattern they are set as follows:
25619
25620 .ilist
25621 If a local part or domain starts with an asterisk, the numerical variables
25622 refer to the character strings matched by asterisks, with &$1$& associated with
25623 the first asterisk, and &$2$& with the second, if present. For example, if the
25624 pattern
25625 .code
25626 *queen@*.fict.example
25627 .endd
25628 is matched against the address &'hearts-queen@wonderland.fict.example'& then
25629 .code
25630 $0 = hearts-queen@wonderland.fict.example
25631 $1 = hearts-
25632 $2 = wonderland
25633 .endd
25634 Note that if the local part does not start with an asterisk, but the domain
25635 does, it is &$1$& that contains the wild part of the domain.
25636
25637 .next
25638 If the domain part of the pattern is a partial lookup, the wild and fixed parts
25639 of the domain are placed in the next available numerical variables. Suppose,
25640 for example, that the address &'foo@bar.baz.example'& is processed by a
25641 rewriting rule of the form
25642 .display
25643 &`*@partial-dbm;/some/dbm/file`&    <&'replacement string'&>
25644 .endd
25645 and the key in the file that matches the domain is &`*.baz.example`&. Then
25646 .code
25647 $1 = foo
25648 $2 = bar
25649 $3 = baz.example
25650 .endd
25651 If the address &'foo@baz.example'& is looked up, this matches the same
25652 wildcard file entry, and in this case &$2$& is set to the empty string, but
25653 &$3$& is still set to &'baz.example'&. If a non-wild key is matched in a
25654 partial lookup, &$2$& is again set to the empty string and &$3$& is set to the
25655 whole domain. For non-partial domain lookups, no numerical variables are set.
25656 .endlist
25657
25658
25659 .section "Rewriting replacements" "SECID152"
25660 .cindex "rewriting" "replacements"
25661 If the replacement string for a rule is a single asterisk, addresses that
25662 match the pattern and the flags are &'not'& rewritten, and no subsequent
25663 rewriting rules are scanned. For example,
25664 .code
25665 hatta@lookingglass.fict.example  *  f
25666 .endd
25667 specifies that &'hatta@lookingglass.fict.example'& is never to be rewritten in
25668 &'From:'& headers.
25669
25670 .vindex "&$domain$&"
25671 .vindex "&$local_part$&"
25672 If the replacement string is not a single asterisk, it is expanded, and must
25673 yield a fully qualified address. Within the expansion, the variables
25674 &$local_part$& and &$domain$& refer to the address that is being rewritten.
25675 Any letters they contain retain their original case &-- they are not lower
25676 cased. The numerical variables are set up according to the type of pattern that
25677 matched the address, as described above. If the expansion is forced to fail by
25678 the presence of &"fail"& in a conditional or lookup item, rewriting by the
25679 current rule is abandoned, but subsequent rules may take effect. Any other
25680 expansion failure causes the entire rewriting operation to be abandoned, and an
25681 entry written to the panic log.
25682
25683
25684
25685 .section "Rewriting flags" "SECID153"
25686 There are three different kinds of flag that may appear on rewriting rules:
25687
25688 .ilist
25689 Flags that specify which headers and envelope addresses to rewrite: E, F, T, b,
25690 c, f, h, r, s, t.
25691 .next
25692 A flag that specifies rewriting at SMTP time: S.
25693 .next
25694 Flags that control the rewriting process: Q, q, R, w.
25695 .endlist
25696
25697 For rules that are part of the &%headers_rewrite%& generic transport option,
25698 E, F, T, and S are not permitted.
25699
25700
25701
25702 .section "Flags specifying which headers and envelope addresses to rewrite" &&&
25703          "SECID154"
25704 .cindex "rewriting" "flags"
25705 If none of the following flag letters, nor the &"S"& flag (see section
25706 &<<SECTrewriteS>>&) are present, a main rewriting rule applies to all headers
25707 and to both the sender and recipient fields of the envelope, whereas a
25708 transport-time rewriting rule just applies to all headers. Otherwise, the
25709 rewriting rule is skipped unless the relevant addresses are being processed.
25710 .display
25711 &`E`&       rewrite all envelope fields
25712 &`F`&       rewrite the envelope From field
25713 &`T`&       rewrite the envelope To field
25714 &`b`&       rewrite the &'Bcc:'& header
25715 &`c`&       rewrite the &'Cc:'& header
25716 &`f`&       rewrite the &'From:'& header
25717 &`h`&       rewrite all headers
25718 &`r`&       rewrite the &'Reply-To:'& header
25719 &`s`&       rewrite the &'Sender:'& header
25720 &`t`&       rewrite the &'To:'& header
25721 .endd
25722 "All headers" means all of the headers listed above that can be selected
25723 individually, plus their &'Resent-'& versions. It does not include
25724 other headers such as &'Subject:'& etc.
25725
25726 You should be particularly careful about rewriting &'Sender:'& headers, and
25727 restrict this to special known cases in your own domains.
25728
25729
25730 .section "The SMTP-time rewriting flag" "SECTrewriteS"
25731 .cindex "SMTP" "rewriting malformed addresses"
25732 .cindex "RCPT" "rewriting argument of"
25733 .cindex "MAIL" "rewriting argument of"
25734 The rewrite flag &"S"& specifies a rewrite of incoming envelope addresses at
25735 SMTP time, as soon as an address is received in a MAIL or RCPT command, and
25736 before any other processing; even before syntax checking. The pattern is
25737 required to be a regular expression, and it is matched against the whole of the
25738 data for the command, including any surrounding angle brackets.
25739
25740 .vindex "&$domain$&"
25741 .vindex "&$local_part$&"
25742 This form of rewrite rule allows for the handling of addresses that are not
25743 compliant with RFCs 2821 and 2822 (for example, &"bang paths"& in batched SMTP
25744 input). Because the input is not required to be a syntactically valid address,
25745 the variables &$local_part$& and &$domain$& are not available during the
25746 expansion of the replacement string. The result of rewriting replaces the
25747 original address in the MAIL or RCPT command.
25748
25749
25750 .section "Flags controlling the rewriting process" "SECID155"
25751 There are four flags which control the way the rewriting process works. These
25752 take effect only when a rule is invoked, that is, when the address is of the
25753 correct type (matches the flags) and matches the pattern:
25754
25755 .ilist
25756 If the &"Q"& flag is set on a rule, the rewritten address is permitted to be an
25757 unqualified local part. It is qualified with &%qualify_recipient%&. In the
25758 absence of &"Q"& the rewritten address must always include a domain.
25759 .next
25760 If the &"q"& flag is set on a rule, no further rewriting rules are considered,
25761 even if no rewriting actually takes place because of a &"fail"& in the
25762 expansion. The &"q"& flag is not effective if the address is of the wrong type
25763 (does not match the flags) or does not match the pattern.
25764 .next
25765 The &"R"& flag causes a successful rewriting rule to be re-applied to the new
25766 address, up to ten times. It can be combined with the &"q"& flag, to stop
25767 rewriting once it fails to match (after at least one successful rewrite).
25768 .next
25769 .cindex "rewriting" "whole addresses"
25770 When an address in a header is rewritten, the rewriting normally applies only
25771 to the working part of the address, with any comments and RFC 2822 &"phrase"&
25772 left unchanged. For example, rewriting might change
25773 .code
25774 From: Ford Prefect <fp42@restaurant.hitch.fict.example>
25775 .endd
25776 into
25777 .code
25778 From: Ford Prefect <prefectf@hitch.fict.example>
25779 .endd
25780 .cindex "RFC 2047"
25781 Sometimes there is a need to replace the whole address item, and this can be
25782 done by adding the flag letter &"w"& to a rule. If this is set on a rule that
25783 causes an address in a header line to be rewritten, the entire address is
25784 replaced, not just the working part. The replacement must be a complete RFC
25785 2822 address, including the angle brackets if necessary. If text outside angle
25786 brackets contains a character whose value is greater than 126 or less than 32
25787 (except for tab), the text is encoded according to RFC 2047. The character set
25788 is taken from &%headers_charset%&, which gets its default at build time.
25789
25790 When the &"w"& flag is set on a rule that causes an envelope address to be
25791 rewritten, all but the working part of the replacement address is discarded.
25792 .endlist
25793
25794
25795 .section "Rewriting examples" "SECID156"
25796 Here is an example of the two common rewriting paradigms:
25797 .code
25798 *@*.hitch.fict.example  $1@hitch.fict.example
25799 *@hitch.fict.example    ${lookup{$1}dbm{/etc/realnames}\
25800                      {$value}fail}@hitch.fict.example bctfrF
25801 .endd
25802 Note the use of &"fail"& in the lookup expansion in the second rule, forcing
25803 the string expansion to fail if the lookup does not succeed. In this context it
25804 has the effect of leaving the original address unchanged, but Exim goes on to
25805 consider subsequent rewriting rules, if any, because the &"q"& flag is not
25806 present in that rule. An alternative to &"fail"& would be to supply &$1$&
25807 explicitly, which would cause the rewritten address to be the same as before,
25808 at the cost of a small bit of processing. Not supplying either of these is an
25809 error, since the rewritten address would then contain no local part.
25810
25811 The first example above replaces the domain with a superior, more general
25812 domain. This may not be desirable for certain local parts. If the rule
25813 .code
25814 root@*.hitch.fict.example  *
25815 .endd
25816 were inserted before the first rule, rewriting would be suppressed for the
25817 local part &'root'& at any domain ending in &'hitch.fict.example'&.
25818
25819 Rewriting can be made conditional on a number of tests, by making use of
25820 &${if$& in the expansion item. For example, to apply a rewriting rule only to
25821 messages that originate outside the local host:
25822 .code
25823 *@*.hitch.fict.example  "${if !eq {$sender_host_address}{}\
25824                          {$1@hitch.fict.example}fail}"
25825 .endd
25826 The replacement string is quoted in this example because it contains white
25827 space.
25828
25829 .cindex "rewriting" "bang paths"
25830 .cindex "bang paths" "rewriting"
25831 Exim does not handle addresses in the form of &"bang paths"&. If it sees such
25832 an address it treats it as an unqualified local part which it qualifies with
25833 the local qualification domain (if the source of the message is local or if the
25834 remote host is permitted to send unqualified addresses). Rewriting can
25835 sometimes be used to handle simple bang paths with a fixed number of
25836 components. For example, the rule
25837 .code
25838 \N^([^!]+)!(.*)@your.domain.example$\N   $2@$1
25839 .endd
25840 rewrites a two-component bang path &'host.name!user'& as the domain address
25841 &'user@host.name'&. However, there is a security implication in using this as
25842 a global rewriting rule for envelope addresses. It can provide a backdoor
25843 method for using your system as a relay, because the incoming addresses appear
25844 to be local. If the bang path addresses are received via SMTP, it is safer to
25845 use the &"S"& flag to rewrite them as they are received, so that relay checking
25846 can be done on the rewritten addresses.
25847 .ecindex IIDaddrew
25848
25849
25850
25851
25852
25853 . ////////////////////////////////////////////////////////////////////////////
25854 . ////////////////////////////////////////////////////////////////////////////
25855
25856 .chapter "Retry configuration" "CHAPretry"
25857 .scindex IIDretconf1 "retry" "configuration, description of"
25858 .scindex IIDregconf2 "configuration file" "retry section"
25859 The &"retry"& section of the runtime configuration file contains a list of
25860 retry rules that control how often Exim tries to deliver messages that cannot
25861 be delivered at the first attempt. If there are no retry rules (the section is
25862 empty or not present), there are no retries. In this situation, temporary
25863 errors are treated as permanent. The default configuration contains a single,
25864 general-purpose retry rule (see section &<<SECID57>>&). The &%-brt%& command
25865 line option can be used to test which retry rule will be used for a given
25866 address, domain and error.
25867
25868 The most common cause of retries is temporary failure to deliver to a remote
25869 host because the host is down, or inaccessible because of a network problem.
25870 Exim's retry processing in this case is applied on a per-host (strictly, per IP
25871 address) basis, not on a per-message basis. Thus, if one message has recently
25872 been delayed, delivery of a new message to the same host is not immediately
25873 tried, but waits for the host's retry time to arrive. If the &%retry_defer%&
25874 log selector is set, the message
25875 .cindex "retry" "time not reached"
25876 &"retry time not reached"& is written to the main log whenever a delivery is
25877 skipped for this reason. Section &<<SECToutSMTPerr>>& contains more details of
25878 the handling of errors during remote deliveries.
25879
25880 Retry processing applies to routing as well as to delivering, except as covered
25881 in the next paragraph. The retry rules do not distinguish between these
25882 actions. It is not possible, for example, to specify different behaviour for
25883 failures to route the domain &'snark.fict.example'& and failures to deliver to
25884 the host &'snark.fict.example'&. I didn't think anyone would ever need this
25885 added complication, so did not implement it. However, although they share the
25886 same retry rule, the actual retry times for routing and transporting a given
25887 domain are maintained independently.
25888
25889 When a delivery is not part of a queue run (typically an immediate delivery on
25890 receipt of a message), the routers are always run, and local deliveries are
25891 always attempted, even if retry times are set for them. This makes for better
25892 behaviour if one particular message is causing problems (for example, causing
25893 quota overflow, or provoking an error in a filter file). If such a delivery
25894 suffers a temporary failure, the retry data is updated as normal, and
25895 subsequent delivery attempts from queue runs occur only when the retry time for
25896 the local address is reached.
25897
25898 .section "Changing retry rules" "SECID157"
25899 If you change the retry rules in your configuration, you should consider
25900 whether or not to delete the retry data that is stored in Exim's spool area in
25901 files with names like &_db/retry_&. Deleting any of Exim's hints files is
25902 always safe; that is why they are called &"hints"&.
25903
25904 The hints retry data contains suggested retry times based on the previous
25905 rules. In the case of a long-running problem with a remote host, it might
25906 record the fact that the host has timed out. If your new rules increase the
25907 timeout time for such a host, you should definitely remove the old retry data
25908 and let Exim recreate it, based on the new rules. Otherwise Exim might bounce
25909 messages that it should now be retaining.
25910
25911
25912
25913 .section "Format of retry rules" "SECID158"
25914 .cindex "retry" "rules"
25915 Each retry rule occupies one line and consists of three or four parts,
25916 separated by white space: a pattern, an error name, an optional list of sender
25917 addresses, and a list of retry parameters. The pattern and sender lists must be
25918 enclosed in double quotes if they contain white space. The rules are searched
25919 in order until one is found where the pattern, error name, and sender list (if
25920 present) match the failing host or address, the error that occurred, and the
25921 message's sender, respectively.
25922
25923
25924 The pattern is any single item that may appear in an address list (see section
25925 &<<SECTaddresslist>>&). It is in fact processed as a one-item address list,
25926 which means that it is expanded before being tested against the address that
25927 has been delayed. A negated address list item is permitted. Address
25928 list processing treats a plain domain name as if it were preceded by &"*@"&,
25929 which makes it possible for many retry rules to start with just a domain. For
25930 example,
25931 .code
25932 lookingglass.fict.example        *  F,24h,30m;
25933 .endd
25934 provides a rule for any address in the &'lookingglass.fict.example'& domain,
25935 whereas
25936 .code
25937 alice@lookingglass.fict.example  *  F,24h,30m;
25938 .endd
25939 applies only to temporary failures involving the local part &%alice%&.
25940 In practice, almost all rules start with a domain name pattern without a local
25941 part.
25942
25943 .cindex "regular expressions" "in retry rules"
25944 &*Warning*&: If you use a regular expression in a retry rule pattern, it
25945 must match a complete address, not just a domain, because that is how regular
25946 expressions work in address lists.
25947 .display
25948 &`^\Nxyz\d+\.abc\.example$\N        *  G,1h,10m,2`&     &%Wrong%&
25949 &`^\N[^@]+@xyz\d+\.abc\.example$\N  *  G,1h,10m,2`&     &%Right%&
25950 .endd
25951
25952
25953 .section "Choosing which retry rule to use for address errors" "SECID159"
25954 When Exim is looking for a retry rule after a routing attempt has failed (for
25955 example, after a DNS timeout), each line in the retry configuration is tested
25956 against the complete address only if &%retry_use_local_part%& is set for the
25957 router. Otherwise, only the domain is used, except when matching against a
25958 regular expression, when the local part of the address is replaced with &"*"&.
25959 A domain on its own can match a domain pattern, or a pattern that starts with
25960 &"*@"&. By default, &%retry_use_local_part%& is true for routers where
25961 &%check_local_user%& is true, and false for other routers.
25962
25963 Similarly, when Exim is looking for a retry rule after a local delivery has
25964 failed (for example, after a mailbox full error), each line in the retry
25965 configuration is tested against the complete address only if
25966 &%retry_use_local_part%& is set for the transport (it defaults true for all
25967 local transports).
25968
25969 .cindex "4&'xx'& responses" "retry rules for"
25970 However, when Exim is looking for a retry rule after a remote delivery attempt
25971 suffers an address error (a 4&'xx'& SMTP response for a recipient address), the
25972 whole address is always used as the key when searching the retry rules. The
25973 rule that is found is used to create a retry time for the combination of the
25974 failing address and the message's sender. It is the combination of sender and
25975 recipient that is delayed in subsequent queue runs until its retry time is
25976 reached. You can delay the recipient without regard to the sender by setting
25977 &%address_retry_include_sender%& false in the &(smtp)& transport but this can
25978 lead to problems with servers that regularly issue 4&'xx'& responses to RCPT
25979 commands.
25980
25981
25982
25983 .section "Choosing which retry rule to use for host and message errors" &&&
25984          "SECID160"
25985 For a temporary error that is not related to an individual address (for
25986 example, a connection timeout), each line in the retry configuration is checked
25987 twice. First, the name of the remote host is used as a domain name (preceded by
25988 &"*@"& when matching a regular expression). If this does not match the line,
25989 the domain from the email address is tried in a similar fashion. For example,
25990 suppose the MX records for &'a.b.c.example'& are
25991 .code
25992 a.b.c.example  MX  5  x.y.z.example
25993                MX  6  p.q.r.example
25994                MX  7  m.n.o.example
25995 .endd
25996 and the retry rules are
25997 .code
25998 p.q.r.example    *      F,24h,30m;
25999 a.b.c.example    *      F,4d,45m;
26000 .endd
26001 and a delivery to the host &'x.y.z.example'& suffers a connection failure. The
26002 first rule matches neither the host nor the domain, so Exim looks at the second
26003 rule. This does not match the host, but it does match the domain, so it is used
26004 to calculate the retry time for the host &'x.y.z.example'&. Meanwhile, Exim
26005 tries to deliver to &'p.q.r.example'&. If this also suffers a host error, the
26006 first retry rule is used, because it matches the host.
26007
26008 In other words, temporary failures to deliver to host &'p.q.r.example'& use the
26009 first rule to determine retry times, but for all the other hosts for the domain
26010 &'a.b.c.example'&, the second rule is used. The second rule is also used if
26011 routing to &'a.b.c.example'& suffers a temporary failure.
26012
26013 &*Note*&: The host name is used when matching the patterns, not its IP address.
26014 However, if a message is routed directly to an IP address without the use of a
26015 host name, for example, if a &(manualroute)& router contains a setting such as:
26016 .code
26017 route_list = *.a.example  192.168.34.23
26018 .endd
26019 then the &"host name"& that is used when searching for a retry rule is the
26020 textual form of the IP address.
26021
26022 .section "Retry rules for specific errors" "SECID161"
26023 .cindex "retry" "specific errors; specifying"
26024 The second field in a retry rule is the name of a particular error, or an
26025 asterisk, which matches any error. The errors that can be tested for are:
26026
26027 .vlist
26028 .vitem &%auth_failed%&
26029 Authentication failed when trying to send to a host in the
26030 &%hosts_require_auth%& list in an &(smtp)& transport.
26031
26032 .vitem &%data_4xx%&
26033 A 4&'xx'& error was received for an outgoing DATA command, either immediately
26034 after the command, or after sending the message's data.
26035
26036 .vitem &%mail_4xx%&
26037 A 4&'xx'& error was received for an outgoing MAIL command.
26038
26039 .vitem &%rcpt_4xx%&
26040 A 4&'xx'& error was received for an outgoing RCPT command.
26041 .endlist
26042
26043 For the three 4&'xx'& errors, either the first or both of the x's can be given
26044 as specific digits, for example: &`mail_45x`& or &`rcpt_436`&. For example, to
26045 recognize 452 errors given to RCPT commands for addresses in a certain domain,
26046 and have retries every ten minutes with a one-hour timeout, you could set up a
26047 retry rule of this form:
26048 .code
26049 the.domain.name  rcpt_452   F,1h,10m
26050 .endd
26051 These errors apply to both outgoing SMTP (the &(smtp)& transport) and outgoing
26052 LMTP (either the &(lmtp)& transport, or the &(smtp)& transport in LMTP mode).
26053
26054 .vlist
26055 .vitem &%lost_connection%&
26056 A server unexpectedly closed the SMTP connection. There may, of course,
26057 legitimate reasons for this (host died, network died), but if it repeats a lot
26058 for the same host, it indicates something odd.
26059
26060 .vitem &%lookup%&
26061 A DNS lookup for a host failed.
26062 Note that a &%dnslookup%& router will need to have matched
26063 its &%fail_defer_domains%& option for this retry type to be usable.
26064 Also note that a &%manualroute%& router will probably need
26065 its &%host_find_failed%& option set to &%defer%&.
26066
26067 .vitem &%refused_MX%&
26068 A connection to a host obtained from an MX record was refused.
26069
26070 .vitem &%refused_A%&
26071 A connection to a host not obtained from an MX record was refused.
26072
26073 .vitem &%refused%&
26074 A connection was refused.
26075
26076 .vitem &%timeout_connect_MX%&
26077 A connection attempt to a host obtained from an MX record timed out.
26078
26079 .vitem &%timeout_connect_A%&
26080 A connection attempt to a host not obtained from an MX record timed out.
26081
26082 .vitem &%timeout_connect%&
26083 A connection attempt timed out.
26084
26085 .vitem &%timeout_MX%&
26086 There was a timeout while connecting or during an SMTP session with a host
26087 obtained from an MX record.
26088
26089 .vitem &%timeout_A%&
26090 There was a timeout while connecting or during an SMTP session with a host not
26091 obtained from an MX record.
26092
26093 .vitem &%timeout%&
26094 There was a timeout while connecting or during an SMTP session.
26095
26096 .vitem &%tls_required%&
26097 The server was required to use TLS (it matched &%hosts_require_tls%& in the
26098 &(smtp)& transport), but either did not offer TLS, or it responded with 4&'xx'&
26099 to STARTTLS, or there was a problem setting up the TLS connection.
26100
26101 .vitem &%quota%&
26102 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
26103 transport.
26104
26105 .vitem &%quota_%&<&'time'&>
26106 .cindex "quota" "error testing in retry rule"
26107 .cindex "retry" "quota error testing"
26108 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
26109 transport, and the mailbox has not been accessed for <&'time'&>. For example,
26110 &'quota_4d'& applies to a quota error when the mailbox has not been accessed
26111 for four days.
26112 .endlist
26113
26114 .cindex "mailbox" "time of last read"
26115 The idea of &%quota_%&<&'time'&> is to make it possible to have shorter
26116 timeouts when the mailbox is full and is not being read by its owner. Ideally,
26117 it should be based on the last time that the user accessed the mailbox.
26118 However, it is not always possible to determine this. Exim uses the following
26119 heuristic rules:
26120
26121 .ilist
26122 If the mailbox is a single file, the time of last access (the &"atime"&) is
26123 used. As no new messages are being delivered (because the mailbox is over
26124 quota), Exim does not access the file, so this is the time of last user access.
26125 .next
26126 .cindex "maildir format" "time of last read"
26127 For a maildir delivery, the time of last modification of the &_new_&
26128 subdirectory is used. As the mailbox is over quota, no new files are created in
26129 the &_new_& subdirectory, because no new messages are being delivered. Any
26130 change to the &_new_& subdirectory is therefore assumed to be the result of an
26131 MUA moving a new message to the &_cur_& directory when it is first read. The
26132 time that is used is therefore the last time that the user read a new message.
26133 .next
26134 For other kinds of multi-file mailbox, the time of last access cannot be
26135 obtained, so a retry rule that uses this type of error field is never matched.
26136 .endlist
26137
26138 The quota errors apply both to system-enforced quotas and to Exim's own quota
26139 mechanism in the &(appendfile)& transport. The &'quota'& error also applies
26140 when a local delivery is deferred because a partition is full (the ENOSPC
26141 error).
26142
26143
26144
26145 .section "Retry rules for specified senders" "SECID162"
26146 .cindex "retry" "rules; sender-specific"
26147 You can specify retry rules that apply only when the failing message has a
26148 specific sender. In particular, this can be used to define retry rules that
26149 apply only to bounce messages. The third item in a retry rule can be of this
26150 form:
26151 .display
26152 &`senders=`&<&'address list'&>
26153 .endd
26154 The retry timings themselves are then the fourth item. For example:
26155 .code
26156 *   rcpt_4xx   senders=:   F,1h,30m
26157 .endd
26158 matches recipient 4&'xx'& errors for bounce messages sent to any address at any
26159 host. If the address list contains white space, it must be enclosed in quotes.
26160 For example:
26161 .code
26162 a.domain  rcpt_452  senders="xb.dom : yc.dom"  G,8h,10m,1.5
26163 .endd
26164 &*Warning*&: This facility can be unhelpful if it is used for host errors
26165 (which do not depend on the recipient). The reason is that the sender is used
26166 only to match the retry rule. Once the rule has been found for a host error,
26167 its contents are used to set a retry time for the host, and this will apply to
26168 all messages, not just those with specific senders.
26169
26170 When testing retry rules using &%-brt%&, you can supply a sender using the
26171 &%-f%& command line option, like this:
26172 .code
26173 exim -f "" -brt user@dom.ain
26174 .endd
26175 If you do not set &%-f%& with &%-brt%&, a retry rule that contains a senders
26176 list is never matched.
26177
26178
26179
26180
26181
26182 .section "Retry parameters" "SECID163"
26183 .cindex "retry" "parameters in rules"
26184 The third (or fourth, if a senders list is present) field in a retry rule is a
26185 sequence of retry parameter sets, separated by semicolons. Each set consists of
26186 .display
26187 <&'letter'&>,<&'cutoff time'&>,<&'arguments'&>
26188 .endd
26189 The letter identifies the algorithm for computing a new retry time; the cutoff
26190 time is the time beyond which this algorithm no longer applies, and the
26191 arguments vary the algorithm's action. The cutoff time is measured from the
26192 time that the first failure for the domain (combined with the local part if
26193 relevant) was detected, not from the time the message was received.
26194
26195 .cindex "retry" "algorithms"
26196 .cindex "retry" "fixed intervals"
26197 .cindex "retry" "increasing intervals"
26198 .cindex "retry" "random intervals"
26199 The available algorithms are:
26200
26201 .ilist
26202 &'F'&: retry at fixed intervals. There is a single time parameter specifying
26203 the interval.
26204 .next
26205 &'G'&: retry at geometrically increasing intervals. The first argument
26206 specifies a starting value for the interval, and the second a multiplier, which
26207 is used to increase the size of the interval at each retry.
26208 .next
26209 &'H'&: retry at randomized intervals. The arguments are as for &'G'&. For each
26210 retry, the previous interval is multiplied by the factor in order to get a
26211 maximum for the next interval. The minimum interval is the first argument of
26212 the parameter, and an actual interval is chosen randomly between them. Such a
26213 rule has been found to be helpful in cluster configurations when all the
26214 members of the cluster restart at once, and may therefore synchronize their
26215 queue processing times.
26216 .endlist
26217
26218 When computing the next retry time, the algorithm definitions are scanned in
26219 order until one whose cutoff time has not yet passed is reached. This is then
26220 used to compute a new retry time that is later than the current time. In the
26221 case of fixed interval retries, this simply means adding the interval to the
26222 current time. For geometrically increasing intervals, retry intervals are
26223 computed from the rule's parameters until one that is greater than the previous
26224 interval is found. The main configuration variable
26225 .cindex "limit" "retry interval"
26226 .cindex "retry" "interval, maximum"
26227 .oindex "&%retry_interval_max%&"
26228 &%retry_interval_max%& limits the maximum interval between retries. It
26229 cannot be set greater than &`24h`&, which is its default value.
26230
26231 A single remote domain may have a number of hosts associated with it, and each
26232 host may have more than one IP address. Retry algorithms are selected on the
26233 basis of the domain name, but are applied to each IP address independently. If,
26234 for example, a host has two IP addresses and one is unusable, Exim will
26235 generate retry times for it and will not try to use it until its next retry
26236 time comes. Thus the good IP address is likely to be tried first most of the
26237 time.
26238
26239 .cindex "hints database" "use for retrying"
26240 Retry times are hints rather than promises. Exim does not make any attempt to
26241 run deliveries exactly at the computed times. Instead, a queue runner process
26242 starts delivery processes for delayed messages periodically, and these attempt
26243 new deliveries only for those addresses that have passed their next retry time.
26244 If a new message arrives for a deferred address, an immediate delivery attempt
26245 occurs only if the address has passed its retry time. In the absence of new
26246 messages, the minimum time between retries is the interval between queue runner
26247 processes. There is not much point in setting retry times of five minutes if
26248 your queue runners happen only once an hour, unless there are a significant
26249 number of incoming messages (which might be the case on a system that is
26250 sending everything to a smart host, for example).
26251
26252 The data in the retry hints database can be inspected by using the
26253 &'exim_dumpdb'& or &'exim_fixdb'& utility programs (see chapter
26254 &<<CHAPutils>>&). The latter utility can also be used to change the data. The
26255 &'exinext'& utility script can be used to find out what the next retry times
26256 are for the hosts associated with a particular mail domain, and also for local
26257 deliveries that have been deferred.
26258
26259
26260 .section "Retry rule examples" "SECID164"
26261 Here are some example retry rules:
26262 .code
26263 alice@wonderland.fict.example quota_5d  F,7d,3h
26264 wonderland.fict.example       quota_5d
26265 wonderland.fict.example       *         F,1h,15m; G,2d,1h,2;
26266 lookingglass.fict.example     *         F,24h,30m;
26267 *                 refused_A   F,2h,20m;
26268 *                 *           F,2h,15m; G,16h,1h,1.5; F,5d,8h
26269 .endd
26270 The first rule sets up special handling for mail to
26271 &'alice@wonderland.fict.example'& when there is an over-quota error and the
26272 mailbox has not been read for at least 5 days. Retries continue every three
26273 hours for 7 days. The second rule handles over-quota errors for all other local
26274 parts at &'wonderland.fict.example'&; the absence of a local part has the same
26275 effect as supplying &"*@"&. As no retry algorithms are supplied, messages that
26276 fail are bounced immediately if the mailbox has not been read for at least 5
26277 days.
26278
26279 The third rule handles all other errors at &'wonderland.fict.example'&; retries
26280 happen every 15 minutes for an hour, then with geometrically increasing
26281 intervals until two days have passed since a delivery first failed. After the
26282 first hour there is a delay of one hour, then two hours, then four hours, and
26283 so on (this is a rather extreme example).
26284
26285 The fourth rule controls retries for the domain &'lookingglass.fict.example'&.
26286 They happen every 30 minutes for 24 hours only. The remaining two rules handle
26287 all other domains, with special action for connection refusal from hosts that
26288 were not obtained from an MX record.
26289
26290 The final rule in a retry configuration should always have asterisks in the
26291 first two fields so as to provide a general catch-all for any addresses that do
26292 not have their own special handling. This example tries every 15 minutes for 2
26293 hours, then with intervals starting at one hour and increasing by a factor of
26294 1.5 up to 16 hours, then every 8 hours up to 5 days.
26295
26296
26297
26298 .section "Timeout of retry data" "SECID165"
26299 .cindex "timeout" "of retry data"
26300 .oindex "&%retry_data_expire%&"
26301 .cindex "hints database" "data expiry"
26302 .cindex "retry" "timeout of data"
26303 Exim timestamps the data that it writes to its retry hints database. When it
26304 consults the data during a delivery it ignores any that is older than the value
26305 set in &%retry_data_expire%& (default 7 days). If, for example, a host hasn't
26306 been tried for 7 days, Exim will try to deliver to it immediately a message
26307 arrives, and if that fails, it will calculate a retry time as if it were
26308 failing for the first time.
26309
26310 This improves the behaviour for messages routed to rarely-used hosts such as MX
26311 backups. If such a host was down at one time, and happens to be down again when
26312 Exim tries a month later, using the old retry data would imply that it had been
26313 down all the time, which is not a justified assumption.
26314
26315 If a host really is permanently dead, this behaviour causes a burst of retries
26316 every now and again, but only if messages routed to it are rare. If there is a
26317 message at least once every 7 days the retry data never expires.
26318
26319
26320
26321
26322 .section "Long-term failures" "SECID166"
26323 .cindex "delivery failure, long-term"
26324 .cindex "retry" "after long-term failure"
26325 Special processing happens when an email address has been failing for so long
26326 that the cutoff time for the last algorithm is reached. For example, using the
26327 default retry rule:
26328 .code
26329 * * F,2h,15m; G,16h,1h,1.5; F,4d,6h
26330 .endd
26331 the cutoff time is four days. Reaching the retry cutoff is independent of how
26332 long any specific message has been failing; it is the length of continuous
26333 failure for the recipient address that counts.
26334
26335 When the cutoff time is reached for a local delivery, or for all the IP
26336 addresses associated with a remote delivery, a subsequent delivery failure
26337 causes Exim to give up on the address, and a bounce message is generated.
26338 In order to cater for new messages that use the failing address, a next retry
26339 time is still computed from the final algorithm, and is used as follows:
26340
26341 For local deliveries, one delivery attempt is always made for any subsequent
26342 messages. If this delivery fails, the address fails immediately. The
26343 post-cutoff retry time is not used.
26344
26345 .cindex "final cutoff" "retries, controlling"
26346 .cindex retry "final cutoff"
26347 If the delivery is remote, there are two possibilities, controlled by the
26348 .oindex "&%delay_after_cutoff%&"
26349 &%delay_after_cutoff%& option of the &(smtp)& transport. The option is true by
26350 default. Until the post-cutoff retry time for one of the IP addresses,
26351 as set by the &%retry_data_expire%& option, is
26352 reached, the failing email address is bounced immediately, without a delivery
26353 attempt taking place. After that time, one new delivery attempt is made to
26354 those IP addresses that are past their retry times, and if that still fails,
26355 the address is bounced and new retry times are computed.
26356
26357 In other words, when all the hosts for a given email address have been failing
26358 for a long time, Exim bounces rather then defers until one of the hosts' retry
26359 times is reached. Then it tries once, and bounces if that attempt fails. This
26360 behaviour ensures that few resources are wasted in repeatedly trying to deliver
26361 to a broken destination, but if the host does recover, Exim will eventually
26362 notice.
26363
26364 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
26365 addresses are past their final cutoff time, Exim tries to deliver to those IP
26366 addresses that have not been tried since the message arrived. If there are
26367 no suitable IP addresses, or if they all fail, the address is bounced. In other
26368 words, it does not delay when a new message arrives, but tries the expired
26369 addresses immediately, unless they have been tried since the message arrived.
26370 If there is a continuous stream of messages for the failing domains, setting
26371 &%delay_after_cutoff%& false means that there will be many more attempts to
26372 deliver to permanently failing IP addresses than when &%delay_after_cutoff%& is
26373 true.
26374
26375 .section "Deliveries that work intermittently" "SECID167"
26376 .cindex "retry" "intermittently working deliveries"
26377 Some additional logic is needed to cope with cases where a host is
26378 intermittently available, or when a message has some attribute that prevents
26379 its delivery when others to the same address get through. In this situation,
26380 because some messages are successfully delivered, the &"retry clock"& for the
26381 host or address keeps getting reset by the successful deliveries, and so
26382 failing messages remain in the queue for ever because the cutoff time is never
26383 reached.
26384
26385 Two exceptional actions are applied to prevent this happening. The first
26386 applies to errors that are related to a message rather than a remote host.
26387 Section &<<SECToutSMTPerr>>& has a discussion of the different kinds of error;
26388 examples of message-related errors are 4&'xx'& responses to MAIL or DATA
26389 commands, and quota failures. For this type of error, if a message's arrival
26390 time is earlier than the &"first failed"& time for the error, the earlier time
26391 is used when scanning the retry rules to decide when to try next and when to
26392 time out the address.
26393
26394 The exceptional second action applies in all cases. If a message has been on
26395 the queue for longer than the cutoff time of any applicable retry rule for a
26396 given address, a delivery is attempted for that address, even if it is not yet
26397 time, and if this delivery fails, the address is timed out. A new retry time is
26398 not computed in this case, so that other messages for the same address are
26399 considered immediately.
26400 .ecindex IIDretconf1
26401 .ecindex IIDregconf2
26402
26403
26404
26405
26406
26407
26408 . ////////////////////////////////////////////////////////////////////////////
26409 . ////////////////////////////////////////////////////////////////////////////
26410
26411 .chapter "SMTP authentication" "CHAPSMTPAUTH"
26412 .scindex IIDauthconf1 "SMTP" "authentication configuration"
26413 .scindex IIDauthconf2 "authentication"
26414 The &"authenticators"& section of Exim's runtime configuration is concerned
26415 with SMTP authentication. This facility is an extension to the SMTP protocol,
26416 described in RFC 2554, which allows a client SMTP host to authenticate itself
26417 to a server. This is a common way for a server to recognize clients that are
26418 permitted to use it as a relay. SMTP authentication is not of relevance to the
26419 transfer of mail between servers that have no managerial connection with each
26420 other.
26421
26422 .cindex "AUTH" "description of"
26423 Very briefly, the way SMTP authentication works is as follows:
26424
26425 .ilist
26426 The server advertises a number of authentication &'mechanisms'& in response to
26427 the client's EHLO command.
26428 .next
26429 The client issues an AUTH command, naming a specific mechanism. The command
26430 may, optionally, contain some authentication data.
26431 .next
26432 The server may issue one or more &'challenges'&, to which the client must send
26433 appropriate responses. In simple authentication mechanisms, the challenges are
26434 just prompts for user names and passwords. The server does not have to issue
26435 any challenges &-- in some mechanisms the relevant data may all be transmitted
26436 with the AUTH command.
26437 .next
26438 The server either accepts or denies authentication.
26439 .next
26440 If authentication succeeds, the client may optionally make use of the AUTH
26441 option on the MAIL command to pass an authenticated sender in subsequent
26442 mail transactions. Authentication lasts for the remainder of the SMTP
26443 connection.
26444 .next
26445 If authentication fails, the client may give up, or it may try a different
26446 authentication mechanism, or it may try transferring mail over the
26447 unauthenticated connection.
26448 .endlist
26449
26450 If you are setting up a client, and want to know which authentication
26451 mechanisms the server supports, you can use Telnet to connect to port 25 (the
26452 SMTP port) on the server, and issue an EHLO command. The response to this
26453 includes the list of supported mechanisms. For example:
26454 .display
26455 &`$ `&&*&`telnet server.example 25`&*&
26456 &`Trying 192.168.34.25...`&
26457 &`Connected to server.example.`&
26458 &`Escape character is &#x0027;^]&#x0027;.`&
26459 &`220 server.example ESMTP Exim 4.20 ...`&
26460 &*&`ehlo client.example`&*&
26461 &`250-server.example Hello client.example [10.8.4.5]`&
26462 &`250-SIZE 52428800`&
26463 &`250-PIPELINING`&
26464 &`250-AUTH PLAIN`&
26465 &`250 HELP`&
26466 .endd
26467 The second-last line of this example output shows that the server supports
26468 authentication using the PLAIN mechanism. In Exim, the different authentication
26469 mechanisms are configured by specifying &'authenticator'& drivers. Like the
26470 routers and transports, which authenticators are included in the binary is
26471 controlled by build-time definitions. The following are currently available,
26472 included by setting
26473 .code
26474 AUTH_CRAM_MD5=yes
26475 AUTH_CYRUS_SASL=yes
26476 AUTH_DOVECOT=yes
26477 AUTH_EXTERNAL=yes
26478 AUTH_GSASL=yes
26479 AUTH_HEIMDAL_GSSAPI=yes
26480 AUTH_PLAINTEXT=yes
26481 AUTH_SPA=yes
26482 AUTH_TLS=yes
26483 .endd
26484 in &_Local/Makefile_&, respectively. The first of these supports the CRAM-MD5
26485 authentication mechanism (RFC 2195), and the second provides an interface to
26486 the Cyrus SASL authentication library.
26487 The third is an interface to Dovecot's authentication system, delegating the
26488 work via a socket interface.
26489 .new
26490 The fourth provides for negotiation of authentication done via non-SMTP means,
26491 as defined by RFC 4422 Appendix A.
26492 .wen
26493 The fifth provides an interface to the GNU SASL authentication library, which
26494 provides mechanisms but typically not data sources.
26495 The sixth provides direct access to Heimdal GSSAPI, geared for Kerberos, but
26496 supporting setting a server keytab.
26497 The seventh can be configured to support
26498 the PLAIN authentication mechanism (RFC 2595) or the LOGIN mechanism, which is
26499 not formally documented, but used by several MUAs.
26500 The eighth authenticator
26501 supports Microsoft's &'Secure Password Authentication'& mechanism.
26502 The last is an Exim authenticator but not an SMTP one;
26503 instead it can use information from a TLS negotiation.
26504
26505 The authenticators are configured using the same syntax as other drivers (see
26506 section &<<SECTfordricon>>&). If no authenticators are required, no
26507 authentication section need be present in the configuration file. Each
26508 authenticator can in principle have both server and client functions. When Exim
26509 is receiving SMTP mail, it is acting as a server; when it is sending out
26510 messages over SMTP, it is acting as a client. Authenticator configuration
26511 options are provided for use in both these circumstances.
26512
26513 To make it clear which options apply to which situation, the prefixes
26514 &%server_%& and &%client_%& are used on option names that are specific to
26515 either the server or the client function, respectively. Server and client
26516 functions are disabled if none of their options are set. If an authenticator is
26517 to be used for both server and client functions, a single definition, using
26518 both sets of options, is required. For example:
26519 .code
26520 cram:
26521   driver = cram_md5
26522   public_name = CRAM-MD5
26523   server_secret = ${if eq{$auth1}{ph10}{secret1}fail}
26524   client_name = ph10
26525   client_secret = secret2
26526 .endd
26527 The &%server_%& option is used when Exim is acting as a server, and the
26528 &%client_%& options when it is acting as a client.
26529
26530 Descriptions of the individual authenticators are given in subsequent chapters.
26531 The remainder of this chapter covers the generic options for the
26532 authenticators, followed by general discussion of the way authentication works
26533 in Exim.
26534
26535 &*Beware:*& the meaning of &$auth1$&, &$auth2$&, ... varies on a per-driver and
26536 per-mechanism basis.  Please read carefully to determine which variables hold
26537 account labels such as usercodes and which hold passwords or other
26538 authenticating data.
26539
26540 Note that some mechanisms support two different identifiers for accounts: the
26541 &'authentication id'& and the &'authorization id'&.  The contractions &'authn'&
26542 and &'authz'& are commonly encountered.  The American spelling is standard here.
26543 Conceptually, authentication data such as passwords are tied to the identifier
26544 used to authenticate; servers may have rules to permit one user to act as a
26545 second user, so that after login the session is treated as though that second
26546 user had logged in.  That second user is the &'authorization id'&.  A robust
26547 configuration might confirm that the &'authz'& field is empty or matches the
26548 &'authn'& field.  Often this is just ignored.  The &'authn'& can be considered
26549 as verified data, the &'authz'& as an unverified request which the server might
26550 choose to honour.
26551
26552 A &'realm'& is a text string, typically a domain name, presented by a server
26553 to a client to help it select an account and credentials to use.  In some
26554 mechanisms, the client and server provably agree on the realm, but clients
26555 typically can not treat the realm as secure data to be blindly trusted.
26556
26557
26558
26559 .section "Generic options for authenticators" "SECID168"
26560 .cindex "authentication" "generic options"
26561 .cindex "options" "generic; for authenticators"
26562
26563 .option client_condition authenticators string&!! unset
26564 When Exim is authenticating as a client, it skips any authenticator whose
26565 &%client_condition%& expansion yields &"0"&, &"no"&, or &"false"&. This can be
26566 used, for example, to skip plain text authenticators when the connection is not
26567 encrypted by a setting such as:
26568 .code
26569 client_condition = ${if !eq{$tls_out_cipher}{}}
26570 .endd
26571
26572
26573 .option client_set_id authenticators string&!! unset
26574 When client authentication succeeds, this condition is expanded; the
26575 result is used in the log lines for outbound messages.
26576 Typically it will be the user name used for authentication.
26577
26578
26579 .option driver authenticators string unset
26580 This option must always be set. It specifies which of the available
26581 authenticators is to be used.
26582
26583
26584 .option public_name authenticators string unset
26585 This option specifies the name of the authentication mechanism that the driver
26586 implements, and by which it is known to the outside world. These names should
26587 contain only upper case letters, digits, underscores, and hyphens (RFC 2222),
26588 but Exim in fact matches them caselessly. If &%public_name%& is not set, it
26589 defaults to the driver's instance name.
26590
26591
26592 .option server_advertise_condition authenticators string&!! unset
26593 When a server is about to advertise an authentication mechanism, the condition
26594 is expanded. If it yields the empty string, &"0"&, &"no"&, or &"false"&, the
26595 mechanism is not advertised.
26596 If the expansion fails, the mechanism is not advertised. If the failure was not
26597 forced, and was not caused by a lookup defer, the incident is logged.
26598 See section &<<SECTauthexiser>>& below for further discussion.
26599
26600
26601 .option server_condition authenticators string&!! unset
26602 This option must be set for a &%plaintext%& server authenticator, where it
26603 is used directly to control authentication. See section &<<SECTplainserver>>&
26604 for details.
26605
26606 For the &(gsasl)& authenticator, this option is required for various
26607 mechanisms; see chapter &<<CHAPgsasl>>& for details.
26608
26609 For the other authenticators, &%server_condition%& can be used as an additional
26610 authentication or authorization mechanism that is applied after the other
26611 authenticator conditions succeed. If it is set, it is expanded when the
26612 authenticator would otherwise return a success code. If the expansion is forced
26613 to fail, authentication fails. Any other expansion failure causes a temporary
26614 error code to be returned. If the result of a successful expansion is an empty
26615 string, &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
26616 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds. For any
26617 other result, a temporary error code is returned, with the expanded string as
26618 the error text.
26619
26620
26621 .option server_debug_print authenticators string&!! unset
26622 If this option is set and authentication debugging is enabled (see the &%-d%&
26623 command line option), the string is expanded and included in the debugging
26624 output when the authenticator is run as a server. This can help with checking
26625 out the values of variables.
26626 If expansion of the string fails, the error message is written to the debugging
26627 output, and Exim carries on processing.
26628
26629
26630 .option server_set_id authenticators string&!! unset
26631 .vindex "&$authenticated_id$&"
26632 .vindex "&$authenticated_fail_id$&"
26633 When an Exim server successfully authenticates a client, this string is
26634 expanded using data from the authentication, and preserved for any incoming
26635 messages in the variable &$authenticated_id$&. It is also included in the log
26636 lines for incoming messages. For example, a user/password authenticator
26637 configuration might preserve the user name that was used to authenticate, and
26638 refer to it subsequently during delivery of the message.
26639 On a failing authentication the expansion result is instead saved in
26640 the &$authenticated_fail_id$& variable.
26641 If expansion fails, the option is ignored.
26642
26643
26644 .option server_mail_auth_condition authenticators string&!! unset
26645 This option allows a server to discard authenticated sender addresses supplied
26646 as part of MAIL commands in SMTP connections that are authenticated by the
26647 driver on which &%server_mail_auth_condition%& is set. The option is not used
26648 as part of the authentication process; instead its (unexpanded) value is
26649 remembered for later use.
26650 How it is used is described in the following section.
26651
26652
26653
26654
26655
26656 .section "The AUTH parameter on MAIL commands" "SECTauthparamail"
26657 .cindex "authentication" "sender; authenticated"
26658 .cindex "AUTH" "on MAIL command"
26659 When a client supplied an AUTH= item on a MAIL command, Exim applies
26660 the following checks before accepting it as the authenticated sender of the
26661 message:
26662
26663 .ilist
26664 If the connection is not using extended SMTP (that is, HELO was used rather
26665 than EHLO), the use of AUTH= is a syntax error.
26666 .next
26667 If the value of the AUTH= parameter is &"<>"&, it is ignored.
26668 .next
26669 .vindex "&$authenticated_sender$&"
26670 If &%acl_smtp_mailauth%& is defined, the ACL it specifies is run. While it is
26671 running, the value of &$authenticated_sender$& is set to the value obtained
26672 from the AUTH= parameter. If the ACL does not yield &"accept"&, the value of
26673 &$authenticated_sender$& is deleted. The &%acl_smtp_mailauth%& ACL may not
26674 return &"drop"& or &"discard"&. If it defers, a temporary error code (451) is
26675 given for the MAIL command.
26676 .next
26677 If &%acl_smtp_mailauth%& is not defined, the value of the AUTH= parameter
26678 is accepted and placed in &$authenticated_sender$& only if the client has
26679 authenticated.
26680 .next
26681 If the AUTH= value was accepted by either of the two previous rules, and
26682 the client has authenticated, and the authenticator has a setting for the
26683 &%server_mail_auth_condition%&, the condition is checked at this point. The
26684 valued that was saved from the authenticator is expanded. If the expansion
26685 fails, or yields an empty string, &"0"&, &"no"&, or &"false"&, the value of
26686 &$authenticated_sender$& is deleted. If the expansion yields any other value,
26687 the value of &$authenticated_sender$& is retained and passed on with the
26688 message.
26689 .endlist
26690
26691
26692 When &$authenticated_sender$& is set for a message, it is passed on to other
26693 hosts to which Exim authenticates as a client. Do not confuse this value with
26694 &$authenticated_id$&, which is a string obtained from the authentication
26695 process, and which is not usually a complete email address.
26696
26697 .vindex "&$sender_address$&"
26698 Whenever an AUTH= value is ignored, the incident is logged. The ACL for
26699 MAIL, if defined, is run after AUTH= is accepted or ignored. It can
26700 therefore make use of &$authenticated_sender$&. The converse is not true: the
26701 value of &$sender_address$& is not yet set up when the &%acl_smtp_mailauth%&
26702 ACL is run.
26703
26704
26705
26706 .section "Authentication on an Exim server" "SECTauthexiser"
26707 .cindex "authentication" "on an Exim server"
26708 When Exim receives an EHLO command, it advertises the public names of those
26709 authenticators that are configured as servers, subject to the following
26710 conditions:
26711
26712 .ilist
26713 The client host must match &%auth_advertise_hosts%& (default *).
26714 .next
26715 It the &%server_advertise_condition%& option is set, its expansion must not
26716 yield the empty string, &"0"&, &"no"&, or &"false"&.
26717 .endlist
26718
26719 The order in which the authenticators are defined controls the order in which
26720 the mechanisms are advertised.
26721
26722 Some mail clients (for example, some versions of Netscape) require the user to
26723 provide a name and password for authentication whenever AUTH is advertised,
26724 even though authentication may not in fact be needed (for example, Exim may be
26725 set up to allow unconditional relaying from the client by an IP address check).
26726 You can make such clients more friendly by not advertising AUTH to them.
26727 For example, if clients on the 10.9.8.0/24 network are permitted (by the ACL
26728 that runs for RCPT) to relay without authentication, you should set
26729 .code
26730 auth_advertise_hosts = ! 10.9.8.0/24
26731 .endd
26732 so that no authentication mechanisms are advertised to them.
26733
26734 The &%server_advertise_condition%& controls the advertisement of individual
26735 authentication mechanisms. For example, it can be used to restrict the
26736 advertisement of a particular mechanism to encrypted connections, by a setting
26737 such as:
26738 .code
26739 server_advertise_condition = ${if eq{$tls_in_cipher}{}{no}{yes}}
26740 .endd
26741 .vindex "&$tls_in_cipher$&"
26742 If the session is encrypted, &$tls_in_cipher$& is not empty, and so the expansion
26743 yields &"yes"&, which allows the advertisement to happen.
26744
26745 When an Exim server receives an AUTH command from a client, it rejects it
26746 immediately if AUTH was not advertised in response to an earlier EHLO
26747 command. This is the case if
26748
26749 .ilist
26750 The client host does not match &%auth_advertise_hosts%&; or
26751 .next
26752 No authenticators are configured with server options; or
26753 .next
26754 Expansion of &%server_advertise_condition%& blocked the advertising of all the
26755 server authenticators.
26756 .endlist
26757
26758
26759 Otherwise, Exim runs the ACL specified by &%acl_smtp_auth%& in order
26760 to decide whether to accept the command. If &%acl_smtp_auth%& is not set,
26761 AUTH is accepted from any client host.
26762
26763 If AUTH is not rejected by the ACL, Exim searches its configuration for a
26764 server authentication mechanism that was advertised in response to EHLO and
26765 that matches the one named in the AUTH command. If it finds one, it runs
26766 the appropriate authentication protocol, and authentication either succeeds or
26767 fails. If there is no matching advertised mechanism, the AUTH command is
26768 rejected with a 504 error.
26769
26770 .vindex "&$received_protocol$&"
26771 .vindex "&$sender_host_authenticated$&"
26772 When a message is received from an authenticated host, the value of
26773 &$received_protocol$& is set to &"esmtpa"& or &"esmtpsa"& instead of &"esmtp"&
26774 or &"esmtps"&, and &$sender_host_authenticated$& contains the name (not the
26775 public name) of the authenticator driver that successfully authenticated the
26776 client from which the message was received. This variable is empty if there was
26777 no successful authentication.
26778
26779 .cindex authentication "expansion item"
26780 Successful authentication sets up information used by the
26781 &%authresults%& expansion item.
26782
26783
26784
26785
26786 .section "Testing server authentication" "SECID169"
26787 .cindex "authentication" "testing a server"
26788 .cindex "AUTH" "testing a server"
26789 .cindex "base64 encoding" "creating authentication test data"
26790 Exim's &%-bh%& option can be useful for testing server authentication
26791 configurations. The data for the AUTH command has to be sent using base64
26792 encoding. A quick way to produce such data for testing is the following Perl
26793 script:
26794 .code
26795 use MIME::Base64;
26796 printf ("%s", encode_base64(eval "\"$ARGV[0]\""));
26797 .endd
26798 .cindex "binary zero" "in authentication data"
26799 This interprets its argument as a Perl string, and then encodes it. The
26800 interpretation as a Perl string allows binary zeros, which are required for
26801 some kinds of authentication, to be included in the data. For example, a
26802 command line to run this script on such data might be
26803 .code
26804 encode '\0user\0password'
26805 .endd
26806 Note the use of single quotes to prevent the shell interpreting the
26807 backslashes, so that they can be interpreted by Perl to specify characters
26808 whose code value is zero.
26809
26810 &*Warning 1*&: If either of the user or password strings starts with an octal
26811 digit, you must use three zeros instead of one after the leading backslash. If
26812 you do not, the octal digit that starts your string will be incorrectly
26813 interpreted as part of the code for the first character.
26814
26815 &*Warning 2*&: If there are characters in the strings that Perl interprets
26816 specially, you must use a Perl escape to prevent them being misinterpreted. For
26817 example, a command such as
26818 .code
26819 encode '\0user@domain.com\0pas$$word'
26820 .endd
26821 gives an incorrect answer because of the unescaped &"@"& and &"$"& characters.
26822
26823 If you have the &%mimencode%& command installed, another way to do produce
26824 base64-encoded strings is to run the command
26825 .code
26826 echo -e -n `\0user\0password' | mimencode
26827 .endd
26828 The &%-e%& option of &%echo%& enables the interpretation of backslash escapes
26829 in the argument, and the &%-n%& option specifies no newline at the end of its
26830 output. However, not all versions of &%echo%& recognize these options, so you
26831 should check your version before relying on this suggestion.
26832
26833
26834
26835 .section "Authentication by an Exim client" "SECID170"
26836 .cindex "authentication" "on an Exim client"
26837 The &(smtp)& transport has two options called &%hosts_require_auth%& and
26838 &%hosts_try_auth%&. When the &(smtp)& transport connects to a server that
26839 announces support for authentication, and the host matches an entry in either
26840 of these options, Exim (as a client) tries to authenticate as follows:
26841
26842 .ilist
26843 For each authenticator that is configured as a client, in the order in which
26844 they are defined in the configuration, it searches the authentication
26845 mechanisms announced by the server for one whose name matches the public name
26846 of the authenticator.
26847 .next
26848 .vindex "&$host$&"
26849 .vindex "&$host_address$&"
26850 When it finds one that matches, it runs the authenticator's client code. The
26851 variables &$host$& and &$host_address$& are available for any string expansions
26852 that the client might do. They are set to the server's name and IP address. If
26853 any expansion is forced to fail, the authentication attempt is abandoned, and
26854 Exim moves on to the next authenticator. Otherwise an expansion failure causes
26855 delivery to be deferred.
26856 .next
26857 If the result of the authentication attempt is a temporary error or a timeout,
26858 Exim abandons trying to send the message to the host for the moment. It will
26859 try again later. If there are any backup hosts available, they are tried in the
26860 usual way.
26861 .next
26862 If the response to authentication is a permanent error (5&'xx'& code), Exim
26863 carries on searching the list of authenticators and tries another one if
26864 possible. If all authentication attempts give permanent errors, or if there are
26865 no attempts because no mechanisms match (or option expansions force failure),
26866 what happens depends on whether the host matches &%hosts_require_auth%& or
26867 &%hosts_try_auth%&. In the first case, a temporary error is generated, and
26868 delivery is deferred. The error can be detected in the retry rules, and thereby
26869 turned into a permanent error if you wish. In the second case, Exim tries to
26870 deliver the message unauthenticated.
26871 .endlist
26872
26873 Note that the hostlist test for whether to do authentication can be
26874 confused if name-IP lookups change between the time the peer is decided
26875 upon and the time that the transport runs.  For example, with a manualroute
26876 router given a host name, and with DNS "round-robin" used by that name: if
26877 the local resolver cache times out between the router and the transport
26878 running, the transport may get an IP for the name for its authentication
26879 check which does not match the connection peer IP.
26880 No authentication will then be done, despite the names being identical.
26881
26882 For such cases use a separate transport which always authenticates.
26883
26884 .cindex "AUTH" "on MAIL command"
26885 When Exim has authenticated itself to a remote server, it adds the AUTH
26886 parameter to the MAIL commands it sends, if it has an authenticated sender for
26887 the message. If the message came from a remote host, the authenticated sender
26888 is the one that was receiving on an incoming MAIL command, provided that the
26889 incoming connection was authenticated and the &%server_mail_auth%& condition
26890 allowed the authenticated sender to be retained. If a local process calls Exim
26891 to send a message, the sender address that is built from the login name and
26892 &%qualify_domain%& is treated as authenticated. However, if the
26893 &%authenticated_sender%& option is set on the &(smtp)& transport, it overrides
26894 the authenticated sender that was received with the message.
26895 .ecindex IIDauthconf1
26896 .ecindex IIDauthconf2
26897
26898
26899
26900
26901
26902
26903 . ////////////////////////////////////////////////////////////////////////////
26904 . ////////////////////////////////////////////////////////////////////////////
26905
26906 .chapter "The plaintext authenticator" "CHAPplaintext"
26907 .scindex IIDplaiauth1 "&(plaintext)& authenticator"
26908 .scindex IIDplaiauth2 "authenticators" "&(plaintext)&"
26909 The &(plaintext)& authenticator can be configured to support the PLAIN and
26910 LOGIN authentication mechanisms, both of which transfer authentication data as
26911 plain (unencrypted) text (though base64 encoded). The use of plain text is a
26912 security risk; you are strongly advised to insist on the use of SMTP encryption
26913 (see chapter &<<CHAPTLS>>&) if you use the PLAIN or LOGIN mechanisms. If you do
26914 use unencrypted plain text, you should not use the same passwords for SMTP
26915 connections as you do for login accounts.
26916
26917 .section "Plaintext options" "SECID171"
26918 .cindex "options" "&(plaintext)& authenticator (server)"
26919 When configured as a server, &(plaintext)& uses the following options:
26920
26921 .option server_condition authenticators string&!! unset
26922 This is actually a global authentication option, but it must be set in order to
26923 configure the &(plaintext)& driver as a server. Its use is described below.
26924
26925 .option server_prompts plaintext string&!! unset
26926 The contents of this option, after expansion, must be a colon-separated list of
26927 prompt strings. If expansion fails, a temporary authentication rejection is
26928 given.
26929
26930 .section "Using plaintext in a server" "SECTplainserver"
26931 .cindex "AUTH" "in &(plaintext)& authenticator"
26932 .cindex "binary zero" "in &(plaintext)& authenticator"
26933 .cindex "numerical variables (&$1$& &$2$& etc)" &&&
26934         "in &(plaintext)& authenticator"
26935 .vindex "&$auth1$&, &$auth2$&, etc"
26936 .cindex "base64 encoding" "in &(plaintext)& authenticator"
26937
26938 When running as a server, &(plaintext)& performs the authentication test by
26939 expanding a string. The data sent by the client with the AUTH command, or in
26940 response to subsequent prompts, is base64 encoded, and so may contain any byte
26941 values when decoded. If any data is supplied with the command, it is treated as
26942 a list of strings, separated by NULs (binary zeros), the first three of which
26943 are placed in the expansion variables &$auth1$&, &$auth2$&, and &$auth3$&
26944 (neither LOGIN nor PLAIN uses more than three strings).
26945
26946 For compatibility with previous releases of Exim, the values are also placed in
26947 the expansion variables &$1$&, &$2$&, and &$3$&. However, the use of these
26948 variables for this purpose is now deprecated, as it can lead to confusion in
26949 string expansions that also use them for other things.
26950
26951 If there are more strings in &%server_prompts%& than the number of strings
26952 supplied with the AUTH command, the remaining prompts are used to obtain more
26953 data. Each response from the client may be a list of NUL-separated strings.
26954
26955 .vindex "&$authenticated_id$&"
26956 Once a sufficient number of data strings have been received,
26957 &%server_condition%& is expanded. If the expansion is forced to fail,
26958 authentication fails. Any other expansion failure causes a temporary error code
26959 to be returned. If the result of a successful expansion is an empty string,
26960 &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
26961 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds and the
26962 generic &%server_set_id%& option is expanded and saved in &$authenticated_id$&.
26963 For any other result, a temporary error code is returned, with the expanded
26964 string as the error text.
26965
26966 &*Warning*&: If you use a lookup in the expansion to find the user's
26967 password, be sure to make the authentication fail if the user is unknown.
26968 There are good and bad examples at the end of the next section.
26969
26970
26971
26972 .section "The PLAIN authentication mechanism" "SECID172"
26973 .cindex "PLAIN authentication mechanism"
26974 .cindex "authentication" "PLAIN mechanism"
26975 .cindex "binary zero" "in &(plaintext)& authenticator"
26976 The PLAIN authentication mechanism (RFC 2595) specifies that three strings be
26977 sent as one item of data (that is, one combined string containing two NUL
26978 separators). The data is sent either as part of the AUTH command, or
26979 subsequently in response to an empty prompt from the server.
26980
26981 The second and third strings are a user name and a corresponding password.
26982 Using a single fixed user name and password as an example, this could be
26983 configured as follows:
26984 .code
26985 fixed_plain:
26986   driver = plaintext
26987   public_name = PLAIN
26988   server_prompts = :
26989   server_condition = \
26990     ${if and {{eq{$auth2}{username}}{eq{$auth3}{mysecret}}}}
26991   server_set_id = $auth2
26992 .endd
26993 Note that the default result strings from &%if%& (&"true"& or an empty string)
26994 are exactly what we want here, so they need not be specified. Obviously, if the
26995 password contains expansion-significant characters such as dollar, backslash,
26996 or closing brace, they have to be escaped.
26997
26998 The &%server_prompts%& setting specifies a single, empty prompt (empty items at
26999 the end of a string list are ignored). If all the data comes as part of the
27000 AUTH command, as is commonly the case, the prompt is not used. This
27001 authenticator is advertised in the response to EHLO as
27002 .code
27003 250-AUTH PLAIN
27004 .endd
27005 and a client host can authenticate itself by sending the command
27006 .code
27007 AUTH PLAIN AHVzZXJuYW1lAG15c2VjcmV0
27008 .endd
27009 As this contains three strings (more than the number of prompts), no further
27010 data is required from the client. Alternatively, the client may just send
27011 .code
27012 AUTH PLAIN
27013 .endd
27014 to initiate authentication, in which case the server replies with an empty
27015 prompt. The client must respond with the combined data string.
27016
27017 The data string is base64 encoded, as required by the RFC. This example,
27018 when decoded, is <&'NUL'&>&`username`&<&'NUL'&>&`mysecret`&, where <&'NUL'&>
27019 represents a zero byte. This is split up into three strings, the first of which
27020 is empty. The &%server_condition%& option in the authenticator checks that the
27021 second two are &`username`& and &`mysecret`& respectively.
27022
27023 Having just one fixed user name and password, as in this example, is not very
27024 realistic, though for a small organization with only a handful of
27025 authenticating clients it could make sense.
27026
27027 A more sophisticated instance of this authenticator could use the user name in
27028 &$auth2$& to look up a password in a file or database, and maybe do an encrypted
27029 comparison (see &%crypteq%& in chapter &<<CHAPexpand>>&). Here is a example of
27030 this approach, where the passwords are looked up in a DBM file. &*Warning*&:
27031 This is an incorrect example:
27032 .code
27033 server_condition = \
27034   ${if eq{$auth3}{${lookup{$auth2}dbm{/etc/authpwd}}}}
27035 .endd
27036 The expansion uses the user name (&$auth2$&) as the key to look up a password,
27037 which it then compares to the supplied password (&$auth3$&). Why is this example
27038 incorrect? It works fine for existing users, but consider what happens if a
27039 non-existent user name is given. The lookup fails, but as no success/failure
27040 strings are given for the lookup, it yields an empty string. Thus, to defeat
27041 the authentication, all a client has to do is to supply a non-existent user
27042 name and an empty password. The correct way of writing this test is:
27043 .code
27044 server_condition = ${lookup{$auth2}dbm{/etc/authpwd}\
27045   {${if eq{$value}{$auth3}}} {false}}
27046 .endd
27047 In this case, if the lookup succeeds, the result is checked; if the lookup
27048 fails, &"false"& is returned and authentication fails. If &%crypteq%& is being
27049 used instead of &%eq%&, the first example is in fact safe, because &%crypteq%&
27050 always fails if its second argument is empty. However, the second way of
27051 writing the test makes the logic clearer.
27052
27053
27054 .section "The LOGIN authentication mechanism" "SECID173"
27055 .cindex "LOGIN authentication mechanism"
27056 .cindex "authentication" "LOGIN mechanism"
27057 The LOGIN authentication mechanism is not documented in any RFC, but is in use
27058 in a number of programs. No data is sent with the AUTH command. Instead, a
27059 user name and password are supplied separately, in response to prompts. The
27060 plaintext authenticator can be configured to support this as in this example:
27061 .code
27062 fixed_login:
27063   driver = plaintext
27064   public_name = LOGIN
27065   server_prompts = User Name : Password
27066   server_condition = \
27067     ${if and {{eq{$auth1}{username}}{eq{$auth2}{mysecret}}}}
27068   server_set_id = $auth1
27069 .endd
27070 Because of the way plaintext operates, this authenticator accepts data supplied
27071 with the AUTH command (in contravention of the specification of LOGIN), but
27072 if the client does not supply it (as is the case for LOGIN clients), the prompt
27073 strings are used to obtain two data items.
27074
27075 Some clients are very particular about the precise text of the prompts. For
27076 example, Outlook Express is reported to recognize only &"Username:"& and
27077 &"Password:"&. Here is an example of a LOGIN authenticator that uses those
27078 strings. It uses the &%ldapauth%& expansion condition to check the user
27079 name and password by binding to an LDAP server:
27080 .code
27081 login:
27082   driver = plaintext
27083   public_name = LOGIN
27084   server_prompts = Username:: : Password::
27085   server_condition = ${if and{{ \
27086     !eq{}{$auth1} }{ \
27087     ldapauth{\
27088       user="uid=${quote_ldap_dn:$auth1},ou=people,o=example.org" \
27089       pass=${quote:$auth2} \
27090       ldap://ldap.example.org/} }} }
27091   server_set_id = uid=$auth1,ou=people,o=example.org
27092 .endd
27093 We have to check that the username is not empty before using it, because LDAP
27094 does not permit empty DN components. We must also use the &%quote_ldap_dn%&
27095 operator to correctly quote the DN for authentication. However, the basic
27096 &%quote%& operator, rather than any of the LDAP quoting operators, is the
27097 correct one to use for the password, because quoting is needed only to make
27098 the password conform to the Exim syntax. At the LDAP level, the password is an
27099 uninterpreted string.
27100
27101
27102 .section "Support for different kinds of authentication" "SECID174"
27103 A number of string expansion features are provided for the purpose of
27104 interfacing to different ways of user authentication. These include checking
27105 traditionally encrypted passwords from &_/etc/passwd_& (or equivalent), PAM,
27106 Radius, &%ldapauth%&, &'pwcheck'&, and &'saslauthd'&. For details see section
27107 &<<SECTexpcond>>&.
27108
27109
27110
27111
27112 .section "Using plaintext in a client" "SECID175"
27113 .cindex "options" "&(plaintext)& authenticator (client)"
27114 The &(plaintext)& authenticator has two client options:
27115
27116 .option client_ignore_invalid_base64 plaintext boolean false
27117 If the client receives a server prompt that is not a valid base64 string,
27118 authentication is abandoned by default. However, if this option is set true,
27119 the error in the challenge is ignored and the client sends the response as
27120 usual.
27121
27122 .option client_send plaintext string&!! unset
27123 The string is a colon-separated list of authentication data strings. Each
27124 string is independently expanded before being sent to the server. The first
27125 string is sent with the AUTH command; any more strings are sent in response
27126 to prompts from the server. Before each string is expanded, the value of the
27127 most recent prompt is placed in the next &$auth$&<&'n'&> variable, starting
27128 with &$auth1$& for the first prompt. Up to three prompts are stored in this
27129 way. Thus, the prompt that is received in response to sending the first string
27130 (with the AUTH command) can be used in the expansion of the second string, and
27131 so on. If an invalid base64 string is received when
27132 &%client_ignore_invalid_base64%& is set, an empty string is put in the
27133 &$auth$&<&'n'&> variable.
27134
27135 &*Note*&: You cannot use expansion to create multiple strings, because
27136 splitting takes priority and happens first.
27137
27138 Because the PLAIN authentication mechanism requires NUL (binary zero) bytes in
27139 the data, further processing is applied to each string before it is sent. If
27140 there are any single circumflex characters in the string, they are converted to
27141 NULs. Should an actual circumflex be required as data, it must be doubled in
27142 the string.
27143
27144 This is an example of a client configuration that implements the PLAIN
27145 authentication mechanism with a fixed user name and password:
27146 .code
27147 fixed_plain:
27148   driver = plaintext
27149   public_name = PLAIN
27150   client_send = ^username^mysecret
27151 .endd
27152 The lack of colons means that the entire text is sent with the AUTH
27153 command, with the circumflex characters converted to NULs. A similar example
27154 that uses the LOGIN mechanism is:
27155 .code
27156 fixed_login:
27157   driver = plaintext
27158   public_name = LOGIN
27159   client_send = : username : mysecret
27160 .endd
27161 The initial colon means that the first string is empty, so no data is sent with
27162 the AUTH command itself. The remaining strings are sent in response to
27163 prompts.
27164 .ecindex IIDplaiauth1
27165 .ecindex IIDplaiauth2
27166
27167
27168
27169
27170 . ////////////////////////////////////////////////////////////////////////////
27171 . ////////////////////////////////////////////////////////////////////////////
27172
27173 .chapter "The cram_md5 authenticator" "CHID9"
27174 .scindex IIDcramauth1 "&(cram_md5)& authenticator"
27175 .scindex IIDcramauth2 "authenticators" "&(cram_md5)&"
27176 .cindex "CRAM-MD5 authentication mechanism"
27177 .cindex "authentication" "CRAM-MD5 mechanism"
27178 The CRAM-MD5 authentication mechanism is described in RFC 2195. The server
27179 sends a challenge string to the client, and the response consists of a user
27180 name and the CRAM-MD5 digest of the challenge string combined with a secret
27181 string (password) which is known to both server and client. Thus, the secret
27182 is not sent over the network as plain text, which makes this authenticator more
27183 secure than &(plaintext)&. However, the downside is that the secret has to be
27184 available in plain text at either end.
27185
27186
27187 .section "Using cram_md5 as a server" "SECID176"
27188 .cindex "options" "&(cram_md5)& authenticator (server)"
27189 This authenticator has one server option, which must be set to configure the
27190 authenticator as a server:
27191
27192 .option server_secret cram_md5 string&!! unset
27193 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(cram_md5)& authenticator"
27194 When the server receives the client's response, the user name is placed in
27195 the expansion variable &$auth1$&, and &%server_secret%& is expanded to
27196 obtain the password for that user. The server then computes the CRAM-MD5 digest
27197 that the client should have sent, and checks that it received the correct
27198 string. If the expansion of &%server_secret%& is forced to fail, authentication
27199 fails. If the expansion fails for some other reason, a temporary error code is
27200 returned to the client.
27201
27202 For compatibility with previous releases of Exim, the user name is also placed
27203 in &$1$&. However, the use of this variables for this purpose is now
27204 deprecated, as it can lead to confusion in string expansions that also use
27205 numeric variables for other things.
27206
27207 For example, the following authenticator checks that the user name given by the
27208 client is &"ph10"&, and if so, uses &"secret"& as the password. For any other
27209 user name, authentication fails.
27210 .code
27211 fixed_cram:
27212   driver = cram_md5
27213   public_name = CRAM-MD5
27214   server_secret = ${if eq{$auth1}{ph10}{secret}fail}
27215   server_set_id = $auth1
27216 .endd
27217 .vindex "&$authenticated_id$&"
27218 If authentication succeeds, the setting of &%server_set_id%& preserves the user
27219 name in &$authenticated_id$&. A more typical configuration might look up the
27220 secret string in a file, using the user name as the key. For example:
27221 .code
27222 lookup_cram:
27223   driver = cram_md5
27224   public_name = CRAM-MD5
27225   server_secret = ${lookup{$auth1}lsearch{/etc/authpwd}\
27226                   {$value}fail}
27227   server_set_id = $auth1
27228 .endd
27229 Note that this expansion explicitly forces failure if the lookup fails
27230 because &$auth1$& contains an unknown user name.
27231
27232 As another example, if you wish to re-use a Cyrus SASL sasldb2 file without
27233 using the relevant libraries, you need to know the realm to specify in the
27234 lookup and then ask for the &"userPassword"& attribute for that user in that
27235 realm, with:
27236 .code
27237 cyrusless_crammd5:
27238   driver = cram_md5
27239   public_name = CRAM-MD5
27240   server_secret = ${lookup{$auth1:mail.example.org:userPassword}\
27241                   dbmjz{/etc/sasldb2}{$value}fail}
27242   server_set_id = $auth1
27243 .endd
27244
27245 .section "Using cram_md5 as a client" "SECID177"
27246 .cindex "options" "&(cram_md5)& authenticator (client)"
27247 When used as a client, the &(cram_md5)& authenticator has two options:
27248
27249
27250
27251 .option client_name cram_md5 string&!! "the primary host name"
27252 This string is expanded, and the result used as the user name data when
27253 computing the response to the server's challenge.
27254
27255
27256 .option client_secret cram_md5 string&!! unset
27257 This option must be set for the authenticator to work as a client. Its value is
27258 expanded and the result used as the secret string when computing the response.
27259
27260
27261 .vindex "&$host$&"
27262 .vindex "&$host_address$&"
27263 Different user names and secrets can be used for different servers by referring
27264 to &$host$& or &$host_address$& in the options. Forced failure of either
27265 expansion string is treated as an indication that this authenticator is not
27266 prepared to handle this case. Exim moves on to the next configured client
27267 authenticator. Any other expansion failure causes Exim to give up trying to
27268 send the message to the current server.
27269
27270 A simple example configuration of a &(cram_md5)& authenticator, using fixed
27271 strings, is:
27272 .code
27273 fixed_cram:
27274   driver = cram_md5
27275   public_name = CRAM-MD5
27276   client_name = ph10
27277   client_secret = secret
27278 .endd
27279 .ecindex IIDcramauth1
27280 .ecindex IIDcramauth2
27281
27282
27283
27284 . ////////////////////////////////////////////////////////////////////////////
27285 . ////////////////////////////////////////////////////////////////////////////
27286
27287 .chapter "The cyrus_sasl authenticator" "CHID10"
27288 .scindex IIDcyrauth1 "&(cyrus_sasl)& authenticator"
27289 .scindex IIDcyrauth2 "authenticators" "&(cyrus_sasl)&"
27290 .cindex "Cyrus" "SASL library"
27291 .cindex "Kerberos"
27292 The code for this authenticator was provided by Matthew Byng-Maddick while
27293 at A L Digital Ltd.
27294
27295 The &(cyrus_sasl)& authenticator provides server support for the Cyrus SASL
27296 library implementation of the RFC 2222 (&"Simple Authentication and Security
27297 Layer"&). This library supports a number of authentication mechanisms,
27298 including PLAIN and LOGIN, but also several others that Exim does not support
27299 directly. In particular, there is support for Kerberos authentication.
27300
27301 The &(cyrus_sasl)& authenticator provides a gatewaying mechanism directly to
27302 the Cyrus interface, so if your Cyrus library can do, for example, CRAM-MD5,
27303 then so can the &(cyrus_sasl)& authenticator. By default it uses the public
27304 name of the driver to determine which mechanism to support.
27305
27306 Where access to some kind of secret file is required, for example, in GSSAPI
27307 or CRAM-MD5, it is worth noting that the authenticator runs as the Exim
27308 user, and that the Cyrus SASL library has no way of escalating privileges
27309 by default. You may also find you need to set environment variables,
27310 depending on the driver you are using.
27311
27312 The application name provided by Exim is &"exim"&, so various SASL options may
27313 be set in &_exim.conf_& in your SASL directory. If you are using GSSAPI for
27314 Kerberos, note that because of limitations in the GSSAPI interface,
27315 changing the server keytab might need to be communicated down to the Kerberos
27316 layer independently. The mechanism for doing so is dependent upon the Kerberos
27317 implementation.
27318
27319 For example, for older releases of Heimdal, the environment variable KRB5_KTNAME
27320 may be set to point to an alternative keytab file. Exim will pass this
27321 variable through from its own inherited environment when started as root or the
27322 Exim user. The keytab file needs to be readable by the Exim user.
27323 With newer releases of Heimdal, a setuid Exim may cause Heimdal to discard the
27324 environment variable.  In practice, for those releases, the Cyrus authenticator
27325 is not a suitable interface for GSSAPI (Kerberos) support.  Instead, consider
27326 the &(heimdal_gssapi)& authenticator, described in chapter &<<CHAPheimdalgss>>&
27327
27328
27329 .section "Using cyrus_sasl as a server" "SECID178"
27330 The &(cyrus_sasl)& authenticator has four private options. It puts the username
27331 (on a successful authentication) into &$auth1$&. For compatibility with
27332 previous releases of Exim, the username is also placed in &$1$&. However, the
27333 use of this variable for this purpose is now deprecated, as it can lead to
27334 confusion in string expansions that also use numeric variables for other
27335 things.
27336
27337
27338 .option server_hostname cyrus_sasl string&!! "see below"
27339 This option selects the hostname that is used when communicating with the
27340 library. The default value is &`$primary_hostname`&. It is up to the underlying
27341 SASL plug-in what it does with this data.
27342
27343
27344 .option server_mech cyrus_sasl string "see below"
27345 This option selects the authentication mechanism this driver should use. The
27346 default is the value of the generic &%public_name%& option. This option allows
27347 you to use a different underlying mechanism from the advertised name. For
27348 example:
27349 .code
27350 sasl:
27351   driver = cyrus_sasl
27352   public_name = X-ANYTHING
27353   server_mech = CRAM-MD5
27354   server_set_id = $auth1
27355 .endd
27356
27357 .option server_realm cyrus_sasl string&!! unset
27358 This specifies the SASL realm that the server claims to be in.
27359
27360
27361 .option server_service cyrus_sasl string &`smtp`&
27362 This is the SASL service that the server claims to implement.
27363
27364
27365 For straightforward cases, you do not need to set any of the authenticator's
27366 private options. All you need to do is to specify an appropriate mechanism as
27367 the public name. Thus, if you have a SASL library that supports CRAM-MD5 and
27368 PLAIN, you could have two authenticators as follows:
27369 .code
27370 sasl_cram_md5:
27371   driver = cyrus_sasl
27372   public_name = CRAM-MD5
27373   server_set_id = $auth1
27374
27375 sasl_plain:
27376   driver = cyrus_sasl
27377   public_name = PLAIN
27378   server_set_id = $auth2
27379 .endd
27380 Cyrus SASL does implement the LOGIN authentication method, even though it is
27381 not a standard method. It is disabled by default in the source distribution,
27382 but it is present in many binary distributions.
27383 .ecindex IIDcyrauth1
27384 .ecindex IIDcyrauth2
27385
27386
27387
27388
27389 . ////////////////////////////////////////////////////////////////////////////
27390 . ////////////////////////////////////////////////////////////////////////////
27391 .chapter "The dovecot authenticator" "CHAPdovecot"
27392 .scindex IIDdcotauth1 "&(dovecot)& authenticator"
27393 .scindex IIDdcotauth2 "authenticators" "&(dovecot)&"
27394 This authenticator is an interface to the authentication facility of the
27395 Dovecot POP/IMAP server, which can support a number of authentication methods.
27396 Note that Dovecot must be configured to use auth-client not auth-userdb.
27397 If you are using Dovecot to authenticate POP/IMAP clients, it might be helpful
27398 to use the same mechanisms for SMTP authentication. This is a server
27399 authenticator only. There is only one option:
27400
27401 .option server_socket dovecot string unset
27402
27403 This option must specify the UNIX socket that is the interface to Dovecot
27404 authentication. The &%public_name%& option must specify an authentication
27405 mechanism that Dovecot is configured to support. You can have several
27406 authenticators for different mechanisms. For example:
27407 .code
27408 dovecot_plain:
27409   driver = dovecot
27410   public_name = PLAIN
27411   server_socket = /var/run/dovecot/auth-client
27412   server_set_id = $auth1
27413
27414 dovecot_ntlm:
27415   driver = dovecot
27416   public_name = NTLM
27417   server_socket = /var/run/dovecot/auth-client
27418   server_set_id = $auth1
27419 .endd
27420 If the SMTP connection is encrypted, or if &$sender_host_address$& is equal to
27421 &$received_ip_address$& (that is, the connection is local), the &"secured"&
27422 option is passed in the Dovecot authentication command. If, for a TLS
27423 connection, a client certificate has been verified, the &"valid-client-cert"&
27424 option is passed. When authentication succeeds, the identity of the user
27425 who authenticated is placed in &$auth1$&.
27426 .ecindex IIDdcotauth1
27427 .ecindex IIDdcotauth2
27428
27429
27430 . ////////////////////////////////////////////////////////////////////////////
27431 . ////////////////////////////////////////////////////////////////////////////
27432 .chapter "The gsasl authenticator" "CHAPgsasl"
27433 .scindex IIDgsaslauth1 "&(gsasl)& authenticator"
27434 .scindex IIDgsaslauth2 "authenticators" "&(gsasl)&"
27435 .cindex "authentication" "GNU SASL"
27436 .cindex "authentication" "SASL"
27437 .cindex "authentication" "EXTERNAL"
27438 .cindex "authentication" "ANONYMOUS"
27439 .cindex "authentication" "PLAIN"
27440 .cindex "authentication" "LOGIN"
27441 .cindex "authentication" "DIGEST-MD5"
27442 .cindex "authentication" "CRAM-MD5"
27443 .cindex "authentication" "SCRAM-SHA-1"
27444 The &(gsasl)& authenticator provides server integration for the GNU SASL
27445 library and the mechanisms it provides.  This is new as of the 4.80 release
27446 and there are a few areas where the library does not let Exim smoothly
27447 scale to handle future authentication mechanisms, so no guarantee can be
27448 made that any particular new authentication mechanism will be supported
27449 without code changes in Exim.
27450
27451 Exim's &(gsasl)& authenticator does not have client-side support at this
27452 time; only the server-side support is implemented.  Patches welcome.
27453
27454
27455 .option server_channelbinding gsasl boolean false
27456 Do not set this true without consulting a cryptographic engineer.
27457
27458 Some authentication mechanisms are able to use external context at both ends
27459 of the session to bind the authentication to that context, and fail the
27460 authentication process if that context differs.  Specifically, some TLS
27461 ciphersuites can provide identifying information about the cryptographic
27462 context.
27463
27464 This should have meant that certificate identity and verification becomes a
27465 non-issue, as a man-in-the-middle attack will cause the correct client and
27466 server to see different identifiers and authentication will fail.
27467
27468 This is currently only supported when using the GnuTLS library.  This is
27469 only usable by mechanisms which support "channel binding"; at time of
27470 writing, that's the SCRAM family.
27471
27472 This defaults off to ensure smooth upgrade across Exim releases, in case
27473 this option causes some clients to start failing.  Some future release
27474 of Exim might have switched the default to be true.
27475
27476 However, Channel Binding in TLS has proven to be broken in current versions.
27477 Do not plan to rely upon this feature for security, ever, without consulting
27478 with a subject matter expert (a cryptographic engineer).
27479
27480
27481 .option server_hostname gsasl string&!! "see below"
27482 This option selects the hostname that is used when communicating with the
27483 library. The default value is &`$primary_hostname`&.
27484 Some mechanisms will use this data.
27485
27486
27487 .option server_mech gsasl string "see below"
27488 This option selects the authentication mechanism this driver should use. The
27489 default is the value of the generic &%public_name%& option. This option allows
27490 you to use a different underlying mechanism from the advertised name. For
27491 example:
27492 .code
27493 sasl:
27494   driver = gsasl
27495   public_name = X-ANYTHING
27496   server_mech = CRAM-MD5
27497   server_set_id = $auth1
27498 .endd
27499
27500
27501 .option server_password gsasl string&!! unset
27502 Various mechanisms need access to the cleartext password on the server, so
27503 that proof-of-possession can be demonstrated on the wire, without sending
27504 the password itself.
27505
27506 The data available for lookup varies per mechanism.
27507 In all cases, &$auth1$& is set to the &'authentication id'&.
27508 The &$auth2$& variable will always be the &'authorization id'& (&'authz'&)
27509 if available, else the empty string.
27510 The &$auth3$& variable will always be the &'realm'& if available,
27511 else the empty string.
27512
27513 A forced failure will cause authentication to defer.
27514
27515 If using this option, it may make sense to set the &%server_condition%&
27516 option to be simply "true".
27517
27518
27519 .option server_realm gsasl string&!! unset
27520 This specifies the SASL realm that the server claims to be in.
27521 Some mechanisms will use this data.
27522
27523
27524 .option server_scram_iter gsasl string&!! unset
27525 This option provides data for the SCRAM family of mechanisms.
27526 &$auth1$& is not available at evaluation time.
27527 (This may change, as we receive feedback on use)
27528
27529
27530 .option server_scram_salt gsasl string&!! unset
27531 This option provides data for the SCRAM family of mechanisms.
27532 &$auth1$& is not available at evaluation time.
27533 (This may change, as we receive feedback on use)
27534
27535
27536 .option server_service gsasl string &`smtp`&
27537 This is the SASL service that the server claims to implement.
27538 Some mechanisms will use this data.
27539
27540
27541 .section "&(gsasl)& auth variables" "SECTgsaslauthvar"
27542 .vindex "&$auth1$&, &$auth2$&, etc"
27543 These may be set when evaluating specific options, as detailed above.
27544 They will also be set when evaluating &%server_condition%&.
27545
27546 Unless otherwise stated below, the &(gsasl)& integration will use the following
27547 meanings for these variables:
27548
27549 .ilist
27550 .vindex "&$auth1$&"
27551 &$auth1$&: the &'authentication id'&
27552 .next
27553 .vindex "&$auth2$&"
27554 &$auth2$&: the &'authorization id'&
27555 .next
27556 .vindex "&$auth3$&"
27557 &$auth3$&: the &'realm'&
27558 .endlist
27559
27560 On a per-mechanism basis:
27561
27562 .ilist
27563 .cindex "authentication" "EXTERNAL"
27564 EXTERNAL: only &$auth1$& is set, to the possibly empty &'authorization id'&;
27565 the &%server_condition%& option must be present.
27566 .next
27567 .cindex "authentication" "ANONYMOUS"
27568 ANONYMOUS: only &$auth1$& is set, to the possibly empty &'anonymous token'&;
27569 the &%server_condition%& option must be present.
27570 .next
27571 .cindex "authentication" "GSSAPI"
27572 GSSAPI: &$auth1$& will be set to the &'GSSAPI Display Name'&;
27573 &$auth2$& will be set to the &'authorization id'&,
27574 the &%server_condition%& option must be present.
27575 .endlist
27576
27577 An &'anonymous token'& is something passed along as an unauthenticated
27578 identifier; this is analogous to FTP anonymous authentication passing an
27579 email address, or software-identifier@, as the "password".
27580
27581
27582 An example showing the password having the realm specified in the callback
27583 and demonstrating a Cyrus SASL to GSASL migration approach is:
27584 .code
27585 gsasl_cyrusless_crammd5:
27586   driver = gsasl
27587   public_name = CRAM-MD5
27588   server_realm = imap.example.org
27589   server_password = ${lookup{$auth1:$auth3:userPassword}\
27590                     dbmjz{/etc/sasldb2}{$value}fail}
27591   server_set_id = ${quote:$auth1}
27592   server_condition = yes
27593 .endd
27594
27595
27596 . ////////////////////////////////////////////////////////////////////////////
27597 . ////////////////////////////////////////////////////////////////////////////
27598
27599 .chapter "The heimdal_gssapi authenticator" "CHAPheimdalgss"
27600 .scindex IIDheimdalgssauth1 "&(heimdal_gssapi)& authenticator"
27601 .scindex IIDheimdalgssauth2 "authenticators" "&(heimdal_gssapi)&"
27602 .cindex "authentication" "GSSAPI"
27603 .cindex "authentication" "Kerberos"
27604 The &(heimdal_gssapi)& authenticator provides server integration for the
27605 Heimdal GSSAPI/Kerberos library, permitting Exim to set a keytab pathname
27606 reliably.
27607
27608 .option server_hostname heimdal_gssapi string&!! "see below"
27609 This option selects the hostname that is used, with &%server_service%&,
27610 for constructing the GSS server name, as a &'GSS_C_NT_HOSTBASED_SERVICE'&
27611 identifier.  The default value is &`$primary_hostname`&.
27612
27613 .option server_keytab heimdal_gssapi string&!! unset
27614 If set, then Heimdal will not use the system default keytab (typically
27615 &_/etc/krb5.keytab_&) but instead the pathname given in this option.
27616 The value should be a pathname, with no &"file:"& prefix.
27617
27618 .option server_service heimdal_gssapi string&!! "smtp"
27619 This option specifies the service identifier used, in conjunction with
27620 &%server_hostname%&, for building the identifier for finding credentials
27621 from the keytab.
27622
27623
27624 .section "&(heimdal_gssapi)& auth variables" "SECTheimdalgssauthvar"
27625 Beware that these variables will typically include a realm, thus will appear
27626 to be roughly like an email address already.  The &'authzid'& in &$auth2$& is
27627 not verified, so a malicious client can set it to anything.
27628
27629 The &$auth1$& field should be safely trustable as a value from the Key
27630 Distribution Center.  Note that these are not quite email addresses.
27631 Each identifier is for a role, and so the left-hand-side may include a
27632 role suffix.  For instance, &"joe/admin@EXAMPLE.ORG"&.
27633
27634 .vindex "&$auth1$&, &$auth2$&, etc"
27635 .ilist
27636 .vindex "&$auth1$&"
27637 &$auth1$&: the &'authentication id'&, set to the GSS Display Name.
27638 .next
27639 .vindex "&$auth2$&"
27640 &$auth2$&: the &'authorization id'&, sent within SASL encapsulation after
27641 authentication.  If that was empty, this will also be set to the
27642 GSS Display Name.
27643 .endlist
27644
27645
27646 . ////////////////////////////////////////////////////////////////////////////
27647 . ////////////////////////////////////////////////////////////////////////////
27648
27649 .chapter "The spa authenticator" "CHAPspa"
27650 .scindex IIDspaauth1 "&(spa)& authenticator"
27651 .scindex IIDspaauth2 "authenticators" "&(spa)&"
27652 .cindex "authentication" "Microsoft Secure Password"
27653 .cindex "authentication" "NTLM"
27654 .cindex "Microsoft Secure Password Authentication"
27655 .cindex "NTLM authentication"
27656 The &(spa)& authenticator provides client support for Microsoft's &'Secure
27657 Password Authentication'& mechanism,
27658 which is also sometimes known as NTLM (NT LanMan). The code for client side of
27659 this authenticator was contributed by Marc Prud'hommeaux, and much of it is
27660 taken from the Samba project (&url(https://www.samba.org/)). The code for the
27661 server side was subsequently contributed by Tom Kistner. The mechanism works as
27662 follows:
27663
27664 .ilist
27665 After the AUTH command has been accepted, the client sends an SPA
27666 authentication request based on the user name and optional domain.
27667 .next
27668 The server sends back a challenge.
27669 .next
27670 The client builds a challenge response which makes use of the user's password
27671 and sends it to the server, which then accepts or rejects it.
27672 .endlist
27673
27674 Encryption is used to protect the password in transit.
27675
27676
27677
27678 .section "Using spa as a server" "SECID179"
27679 .cindex "options" "&(spa)& authenticator (server)"
27680 The &(spa)& authenticator has just one server option:
27681
27682 .option server_password spa string&!! unset
27683 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(spa)& authenticator"
27684 This option is expanded, and the result must be the cleartext password for the
27685 authenticating user, whose name is at this point in &$auth1$&. For
27686 compatibility with previous releases of Exim, the user name is also placed in
27687 &$1$&. However, the use of this variable for this purpose is now deprecated, as
27688 it can lead to confusion in string expansions that also use numeric variables
27689 for other things. For example:
27690 .code
27691 spa:
27692   driver = spa
27693   public_name = NTLM
27694   server_password = \
27695     ${lookup{$auth1}lsearch{/etc/exim/spa_clearpass}{$value}fail}
27696 .endd
27697 If the expansion is forced to fail, authentication fails. Any other expansion
27698 failure causes a temporary error code to be returned.
27699
27700
27701
27702
27703
27704 .section "Using spa as a client" "SECID180"
27705 .cindex "options" "&(spa)& authenticator (client)"
27706 The &(spa)& authenticator has the following client options:
27707
27708
27709
27710 .option client_domain spa string&!! unset
27711 This option specifies an optional domain for the authentication.
27712
27713
27714 .option client_password spa string&!! unset
27715 This option specifies the user's password, and must be set.
27716
27717
27718 .option client_username spa string&!! unset
27719 This option specifies the user name, and must be set. Here is an example of a
27720 configuration of this authenticator for use with the mail servers at
27721 &'msn.com'&:
27722 .code
27723 msn:
27724   driver = spa
27725   public_name = MSN
27726   client_username = msn/msn_username
27727   client_password = msn_plaintext_password
27728   client_domain = DOMAIN_OR_UNSET
27729 .endd
27730 .ecindex IIDspaauth1
27731 .ecindex IIDspaauth2
27732
27733
27734
27735
27736
27737 . ////////////////////////////////////////////////////////////////////////////
27738 . ////////////////////////////////////////////////////////////////////////////
27739
27740 .chapter "The external authenticator" "CHAPexternauth"
27741 .scindex IIDexternauth1 "&(external)& authenticator"
27742 .scindex IIDexternauth2 "authenticators" "&(external)&"
27743 .cindex "authentication" "Client Certificate"
27744 .cindex "authentication" "X509"
27745 .cindex "Certificate-based authentication"
27746 The &(external)& authenticator provides support for
27747 authentication based on non-SMTP information.
27748 The specification is in RFC 4422 Appendix A
27749 (&url(https://tools.ietf.org/html/rfc4422)).
27750 It is only a transport and negotiation mechanism;
27751 the process of authentication is entirely controlled
27752 by the server configuration.
27753
27754 The client presents an identity in-clear.
27755 It is probably wise for a server to only advertise,
27756 and for clients to only attempt,
27757 this authentication method on a secure (eg. under TLS) connection.
27758
27759 One possible use, compatible with the
27760 K-9 Mail Andoid client (&url(https://k9mail.github.io/)),
27761 is for using X509 client certificates.
27762
27763 It thus overlaps in function with the TLS authenticator
27764 (see &<<CHAPtlsauth>>&)
27765 but is a full SMTP SASL authenticator
27766 rather than being implicit for TLS-connection carried
27767 client certificates only.
27768
27769 The examples and discussion in this chapter assume that
27770 client-certificate authentication is being done.
27771
27772 The client must present a certificate,
27773 for which it must have been requested via the
27774 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& main options
27775 (see &<<CHAPTLS>>&).
27776 For authentication to be effective the certificate should be
27777 verifiable against a trust-anchor certificate known to the server.
27778
27779 .section "External options" "SECTexternsoptions"
27780 .cindex "options" "&(external)& authenticator (server)"
27781 The &(external)& authenticator has two server options:
27782
27783 .option server_param2 external string&!! unset
27784 .option server_param3 external string&!! unset
27785 .cindex "variables (&$auth1$& &$auth2$& etc)" "in &(external)& authenticator"
27786 These options are expanded before the &%server_condition%& option
27787 and the result are placed in &$auth2$& and &$auth3$& resectively.
27788 If the expansion is forced to fail, authentication fails. Any other expansion
27789 failure causes a temporary error code to be returned.
27790
27791 They can be used to clarify the coding of a complex &%server_condition%&.
27792
27793 .section "Using external in a server" "SECTexternserver"
27794 .cindex "AUTH" "in &(external)& authenticator"
27795 .cindex "numerical variables (&$1$& &$2$& etc)" &&&
27796         "in &(external)& authenticator"
27797 .vindex "&$auth1$&, &$auth2$&, etc"
27798 .cindex "base64 encoding" "in &(external)& authenticator"
27799
27800 When running as a server, &(external)& performs the authentication test by
27801 expanding a string. The data sent by the client with the AUTH command, or in
27802 response to subsequent prompts, is base64 encoded, and so may contain any byte
27803 values when decoded. The decoded value is treated as
27804 an identity for authentication and
27805 placed in the expansion variable &$auth1$&.
27806
27807 For compatibility with previous releases of Exim, the value is also placed in
27808 the expansion variable &$1$&. However, the use of this
27809 variable for this purpose is now deprecated, as it can lead to confusion in
27810 string expansions that also use them for other things.
27811
27812 .vindex "&$authenticated_id$&"
27813 Once an identity has been received,
27814 &%server_condition%& is expanded. If the expansion is forced to fail,
27815 authentication fails. Any other expansion failure causes a temporary error code
27816 to be returned. If the result of a successful expansion is an empty string,
27817 &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
27818 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds and the
27819 generic &%server_set_id%& option is expanded and saved in &$authenticated_id$&.
27820 For any other result, a temporary error code is returned, with the expanded
27821 string as the error text.
27822
27823 Example:
27824 .code
27825 ext_ccert_san_mail:
27826   driver =            external
27827   public_name =       EXTERNAL
27828
27829   server_advertise_condition = $tls_in_certificate_verified
27830   server_param2 =     ${certextract {subj_altname,mail,>:} \
27831                                     {$tls_in_peercert}}
27832   server_condition =  ${if forany {$auth2} \
27833                             {eq {$item}{$auth1}}}
27834   server_set_id =     $auth1
27835 .endd
27836 This accepts a client certificate that is verifiable against any
27837 of your configured trust-anchors
27838 (which usually means the full set of public CAs)
27839 and which has a mail-SAN matching the claimed identity sent by the client.
27840
27841 Note that, up to TLS1.2, the client cert is on the wire in-clear, including the SAN,
27842 The account name is therefore guessable by an opponent.
27843 TLS 1.3 protects both server and client certificates, and is not vulnerable
27844 in this way.
27845 Likewise, a traditional plaintext SMTP AUTH done inside TLS is not.
27846
27847
27848 .section "Using external in a client" "SECTexternclient"
27849 .cindex "options" "&(external)& authenticator (client)"
27850 The &(external)& authenticator has one client option:
27851
27852 .option client_send external string&!! unset
27853 This option is expanded and sent with the AUTH command as the
27854 identity being asserted.
27855
27856 Example:
27857 .code
27858 ext_ccert:
27859   driver =      external
27860   public_name = EXTERNAL
27861
27862   client_condition = ${if !eq{$tls_out_cipher}{}}
27863   client_send = myaccount@smarthost.example.net
27864 .endd
27865
27866
27867 .ecindex IIDexternauth1
27868 .ecindex IIDexternauth2
27869
27870
27871
27872
27873
27874 . ////////////////////////////////////////////////////////////////////////////
27875 . ////////////////////////////////////////////////////////////////////////////
27876
27877 .chapter "The tls authenticator" "CHAPtlsauth"
27878 .scindex IIDtlsauth1 "&(tls)& authenticator"
27879 .scindex IIDtlsauth2 "authenticators" "&(tls)&"
27880 .cindex "authentication" "Client Certificate"
27881 .cindex "authentication" "X509"
27882 .cindex "Certificate-based authentication"
27883 The &(tls)& authenticator provides server support for
27884 authentication based on client certificates.
27885
27886 It is not an SMTP authentication mechanism and is not
27887 advertised by the server as part of the SMTP EHLO response.
27888 It is an Exim authenticator in the sense that it affects
27889 the protocol element of the log line, can be tested for
27890 by the &%authenticated%& ACL condition, and can set
27891 the &$authenticated_id$& variable.
27892
27893 The client must present a verifiable certificate,
27894 for which it must have been requested via the
27895 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& main options
27896 (see &<<CHAPTLS>>&).
27897
27898 If an authenticator of this type is configured it is
27899 run before any SMTP-level communication is done,
27900 and can authenticate the connection.
27901 If it does, SMTP authentication is not offered.
27902
27903 A maximum of one authenticator of this type may be present.
27904
27905
27906 .cindex "options" "&(tls)& authenticator (server)"
27907 The &(tls)& authenticator has three server options:
27908
27909 .option server_param1 tls string&!! unset
27910 .cindex "variables (&$auth1$& &$auth2$& etc)" "in &(tls)& authenticator"
27911 This option is expanded after the TLS negotiation and
27912 the result is placed in &$auth1$&.
27913 If the expansion is forced to fail, authentication fails. Any other expansion
27914 failure causes a temporary error code to be returned.
27915
27916 .option server_param2 tls string&!! unset
27917 .option server_param3 tls string&!! unset
27918 As above, for &$auth2$& and &$auth3$&.
27919
27920 &%server_param1%& may also be spelled &%server_param%&.
27921
27922
27923 Example:
27924 .code
27925 tls:
27926   driver = tls
27927   server_param1 =     ${certextract {subj_altname,mail,>:} \
27928                                     {$tls_in_peercert}}
27929   server_condition =  ${if and { {eq{$tls_in_certificate_verified}{1}} \
27930                                  {forany {$auth1} \
27931                             {!= {0} \
27932                                 {${lookup ldap{ldap:///\
27933                          mailname=${quote_ldap_dn:${lc:$item}},\
27934                          ou=users,LDAP_DC?mailid} {$value}{0} \
27935                        }    }  } }}}
27936   server_set_id =     ${if = {1}{${listcount:$auth1}} {$auth1}{}}
27937 .endd
27938 This accepts a client certificate that is verifiable against any
27939 of your configured trust-anchors
27940 (which usually means the full set of public CAs)
27941 and which has a SAN with a good account name.
27942
27943 Note that, up to TLS1.2, the client cert is on the wire in-clear, including the SAN,
27944 The account name is therefore guessable by an opponent.
27945 TLS 1.3 protects both server and client certificates, and is not vulnerable
27946 in this way.
27947 Likewise, a traditional plaintext SMTP AUTH done inside TLS is not.
27948
27949 . An alternative might use
27950 . .code
27951 .   server_param1 = ${sha256:$tls_in_peercert}
27952 . .endd
27953 . to require one of a set of specific certs that define a given account
27954 . (the verification is still required, but mostly irrelevant).
27955 . This would help for per-device use.
27956 .
27957 . However, for the future we really need support for checking a
27958 . user cert in LDAP - which probably wants a base-64 DER.
27959
27960 .ecindex IIDtlsauth1
27961 .ecindex IIDtlsauth2
27962
27963
27964 Note that because authentication is traditionally an SMTP operation,
27965 the &%authenticated%& ACL condition cannot be used in
27966 a connect- or helo-ACL.
27967
27968
27969
27970 . ////////////////////////////////////////////////////////////////////////////
27971 . ////////////////////////////////////////////////////////////////////////////
27972
27973 .chapter "Encrypted SMTP connections using TLS/SSL" "CHAPTLS" &&&
27974          "Encrypted SMTP connections"
27975 .scindex IIDencsmtp1 "encryption" "on SMTP connection"
27976 .scindex IIDencsmtp2 "SMTP" "encryption"
27977 .cindex "TLS" "on SMTP connection"
27978 .cindex "OpenSSL"
27979 .cindex "GnuTLS"
27980 Support for TLS (Transport Layer Security), formerly known as SSL (Secure
27981 Sockets Layer), is implemented by making use of the OpenSSL library or the
27982 GnuTLS library (Exim requires GnuTLS release 1.0 or later). There is no
27983 cryptographic code in the Exim distribution itself for implementing TLS. In
27984 order to use this feature you must install OpenSSL or GnuTLS, and then build a
27985 version of Exim that includes TLS support (see section &<<SECTinctlsssl>>&).
27986 You also need to understand the basic concepts of encryption at a managerial
27987 level, and in particular, the way that public keys, private keys, and
27988 certificates are used.
27989
27990 RFC 3207 defines how SMTP connections can make use of encryption. Once a
27991 connection is established, the client issues a STARTTLS command. If the
27992 server accepts this, the client and the server negotiate an encryption
27993 mechanism. If the negotiation succeeds, the data that subsequently passes
27994 between them is encrypted.
27995
27996 Exim's ACLs can detect whether the current SMTP session is encrypted or not,
27997 and if so, what cipher suite is in use, whether the client supplied a
27998 certificate, and whether or not that certificate was verified. This makes it
27999 possible for an Exim server to deny or accept certain commands based on the
28000 encryption state.
28001
28002 &*Warning*&: Certain types of firewall and certain anti-virus products can
28003 disrupt TLS connections. You need to turn off SMTP scanning for these products
28004 in order to get TLS to work.
28005
28006
28007
28008 .section "Support for the &""submissions""& (aka &""ssmtp""& and &""smtps""&) protocol" &&&
28009          "SECID284"
28010 .cindex "submissions protocol"
28011 .cindex "ssmtp protocol"
28012 .cindex "smtps protocol"
28013 .cindex "SMTP" "submissions protocol"
28014 .cindex "SMTP" "ssmtp protocol"
28015 .cindex "SMTP" "smtps protocol"
28016 The history of port numbers for TLS in SMTP is a little messy and has been
28017 contentious.  As of RFC 8314, the common practice of using the historically
28018 allocated port 465 for "email submission but with TLS immediately upon connect
28019 instead of using STARTTLS" is officially blessed by the IETF, and recommended
28020 by them in preference to STARTTLS.
28021
28022 The name originally assigned to the port was &"ssmtp"& or &"smtps"&, but as
28023 clarity emerged over the dual roles of SMTP, for MX delivery and Email
28024 Submission, nomenclature has shifted.  The modern name is now &"submissions"&.
28025
28026 This approach was, for a while, officially abandoned when encrypted SMTP was
28027 standardized, but many clients kept using it, even as the TCP port number was
28028 reassigned for other use.
28029 Thus you may encounter guidance claiming that you shouldn't enable use of
28030 this port.
28031 In practice, a number of mail-clients have only ever supported submissions,
28032 not submission with STARTTLS upgrade.
28033 Ideally, offer both submission (587) and submissions (465) service.
28034
28035 Exim supports TLS-on-connect by means of the &%tls_on_connect_ports%&
28036 global option. Its value must be a list of port numbers;
28037 the most common use is expected to be:
28038 .code
28039 tls_on_connect_ports = 465
28040 .endd
28041 The port numbers specified by this option apply to all SMTP connections, both
28042 via the daemon and via &'inetd'&. You still need to specify all the ports that
28043 the daemon uses (by setting &%daemon_smtp_ports%& or &%local_interfaces%& or
28044 the &%-oX%& command line option) because &%tls_on_connect_ports%& does not add
28045 an extra port &-- rather, it specifies different behaviour on a port that is
28046 defined elsewhere.
28047
28048 There is also a &%-tls-on-connect%& command line option. This overrides
28049 &%tls_on_connect_ports%&; it forces the TLS-only behaviour for all ports.
28050
28051
28052
28053
28054
28055
28056 .section "OpenSSL vs GnuTLS" "SECTopenvsgnu"
28057 .cindex "TLS" "OpenSSL &'vs'& GnuTLS"
28058 The first TLS support in Exim was implemented using OpenSSL. Support for GnuTLS
28059 followed later, when the first versions of GnuTLS were released. To build Exim
28060 to use GnuTLS, you need to set
28061 .code
28062 USE_GNUTLS=yes
28063 .endd
28064 in Local/Makefile
28065 you must also set TLS_LIBS and TLS_INCLUDE appropriately, so that the
28066 include files and libraries for GnuTLS can be found.
28067
28068 There are some differences in usage when using GnuTLS instead of OpenSSL:
28069
28070 .ilist
28071 The &%tls_verify_certificates%& option
28072 cannot be the path of a directory
28073 for GnuTLS versions before 3.3.6
28074 (for later versions, or OpenSSL, it can be either).
28075 .next
28076 The default value for &%tls_dhparam%& differs for historical reasons.
28077 .next
28078 .vindex "&$tls_in_peerdn$&"
28079 .vindex "&$tls_out_peerdn$&"
28080 Distinguished Name (DN) strings reported by the OpenSSL library use a slash for
28081 separating fields; GnuTLS uses commas, in accordance with RFC 2253. This
28082 affects the value of the &$tls_in_peerdn$& and &$tls_out_peerdn$& variables.
28083 .next
28084 OpenSSL identifies cipher suites using hyphens as separators, for example:
28085 DES-CBC3-SHA. GnuTLS historically used underscores, for example:
28086 RSA_ARCFOUR_SHA. What is more, OpenSSL complains if underscores are present
28087 in a cipher list. To make life simpler, Exim changes underscores to hyphens
28088 for OpenSSL and passes the string unchanged to GnuTLS (expecting the library
28089 to handle its own older variants) when processing lists of cipher suites in the
28090 &%tls_require_ciphers%& options (the global option and the &(smtp)& transport
28091 option).
28092 .next
28093 The &%tls_require_ciphers%& options operate differently, as described in the
28094 sections &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
28095 .next
28096 The &%tls_dh_min_bits%& SMTP transport option is only honoured by GnuTLS.
28097 When using OpenSSL, this option is ignored.
28098 (If an API is found to let OpenSSL be configured in this way,
28099 let the Exim Maintainers know and we'll likely use it).
28100 .next
28101 With GnuTLS, if an explicit list is used for the &%tls_privatekey%& main option
28102 main option, it must be ordered to match the &%tls_certificate%& list.
28103 .next
28104 Some other recently added features may only be available in one or the other.
28105 This should be documented with the feature.  If the documentation does not
28106 explicitly state that the feature is infeasible in the other TLS
28107 implementation, then patches are welcome.
28108 .endlist
28109
28110
28111 .section "GnuTLS parameter computation" "SECTgnutlsparam"
28112 This section only applies if &%tls_dhparam%& is set to &`historic`& or to
28113 an explicit path; if the latter, then the text about generation still applies,
28114 but not the chosen filename.
28115 By default, as of Exim 4.80 a hard-coded D-H prime is used.
28116 See the documentation of &%tls_dhparam%& for more information.
28117
28118 GnuTLS uses D-H parameters that may take a substantial amount of time
28119 to compute. It is unreasonable to re-compute them for every TLS session.
28120 Therefore, Exim keeps this data in a file in its spool directory, called
28121 &_gnutls-params-NNNN_& for some value of NNNN, corresponding to the number
28122 of bits requested.
28123 The file is owned by the Exim user and is readable only by
28124 its owner. Every Exim process that start up GnuTLS reads the D-H
28125 parameters from this file. If the file does not exist, the first Exim process
28126 that needs it computes the data and writes it to a temporary file which is
28127 renamed once it is complete. It does not matter if several Exim processes do
28128 this simultaneously (apart from wasting a few resources). Once a file is in
28129 place, new Exim processes immediately start using it.
28130
28131 For maximum security, the parameters that are stored in this file should be
28132 recalculated periodically, the frequency depending on your paranoia level.
28133 If you are avoiding using the fixed D-H primes published in RFCs, then you
28134 are concerned about some advanced attacks and will wish to do this; if you do
28135 not regenerate then you might as well stick to the standard primes.
28136
28137 Arranging this is easy in principle; just delete the file when you want new
28138 values to be computed. However, there may be a problem. The calculation of new
28139 parameters needs random numbers, and these are obtained from &_/dev/random_&.
28140 If the system is not very active, &_/dev/random_& may delay returning data
28141 until enough randomness (entropy) is available. This may cause Exim to hang for
28142 a substantial amount of time, causing timeouts on incoming connections.
28143
28144 The solution is to generate the parameters externally to Exim. They are stored
28145 in &_gnutls-params-N_& in PEM format, which means that they can be
28146 generated externally using the &(certtool)& command that is part of GnuTLS.
28147
28148 To replace the parameters with new ones, instead of deleting the file
28149 and letting Exim re-create it, you can generate new parameters using
28150 &(certtool)& and, when this has been done, replace Exim's cache file by
28151 renaming. The relevant commands are something like this:
28152 .code
28153 # ls
28154 [ look for file; assume gnutls-params-2236 is the most recent ]
28155 # rm -f new-params
28156 # touch new-params
28157 # chown exim:exim new-params
28158 # chmod 0600 new-params
28159 # certtool --generate-dh-params --bits 2236 >>new-params
28160 # openssl dhparam -noout -text -in new-params | head
28161 [ check the first line, make sure it's not more than 2236;
28162   if it is, then go back to the start ("rm") and repeat
28163   until the size generated is at most the size requested ]
28164 # chmod 0400 new-params
28165 # mv new-params gnutls-params-2236
28166 .endd
28167 If Exim never has to generate the parameters itself, the possibility of
28168 stalling is removed.
28169
28170 The filename changed in Exim 4.80, to gain the -bits suffix.  The value which
28171 Exim will choose depends upon the version of GnuTLS in use.  For older GnuTLS,
28172 the value remains hard-coded in Exim as 1024.  As of GnuTLS 2.12.x, there is
28173 a way for Exim to ask for the "normal" number of bits for D-H public-key usage,
28174 and Exim does so.  This attempt to remove Exim from TLS policy decisions
28175 failed, as GnuTLS 2.12 returns a value higher than the current hard-coded limit
28176 of the NSS library.  Thus Exim gains the &%tls_dh_max_bits%& global option,
28177 which applies to all D-H usage, client or server.  If the value returned by
28178 GnuTLS is greater than &%tls_dh_max_bits%& then the value will be clamped down
28179 to &%tls_dh_max_bits%&.  The default value has been set at the current NSS
28180 limit, which is still much higher than Exim historically used.
28181
28182 The filename and bits used will change as the GnuTLS maintainers change the
28183 value for their parameter &`GNUTLS_SEC_PARAM_NORMAL`&, as clamped by
28184 &%tls_dh_max_bits%&.  At the time of writing (mid 2012), GnuTLS 2.12 recommends
28185 2432 bits, while NSS is limited to 2236 bits.
28186
28187 In fact, the requested value will be *lower* than &%tls_dh_max_bits%&, to
28188 increase the chance of the generated prime actually being within acceptable
28189 bounds, as GnuTLS has been observed to overshoot.  Note the check step in the
28190 procedure above.  There is no sane procedure available to Exim to double-check
28191 the size of the generated prime, so it might still be too large.
28192
28193
28194 .section "Requiring specific ciphers in OpenSSL" "SECTreqciphssl"
28195 .cindex "TLS" "requiring specific ciphers (OpenSSL)"
28196 .oindex "&%tls_require_ciphers%&" "OpenSSL"
28197 There is a function in the OpenSSL library that can be passed a list of cipher
28198 suites before the cipher negotiation takes place. This specifies which ciphers
28199 are acceptable for TLS versions prior to 1.3.
28200 The list is colon separated and may contain names like
28201 DES-CBC3-SHA. Exim passes the expanded value of &%tls_require_ciphers%&
28202 directly to this function call.
28203 Many systems will install the OpenSSL manual-pages, so you may have
28204 &'ciphers(1)'& available to you.
28205 The following quotation from the OpenSSL
28206 documentation specifies what forms of item are allowed in the cipher string:
28207
28208 .ilist
28209 It can consist of a single cipher suite such as RC4-SHA.
28210 .next
28211 It can represent a list of cipher suites containing a certain algorithm,
28212 or cipher suites of a certain type. For example SHA1 represents all
28213 ciphers suites using the digest algorithm SHA1 and SSLv3 represents all
28214 SSL v3 algorithms.
28215 .next
28216 Lists of cipher suites can be combined in a single cipher string using
28217 the + character. This is used as a logical and operation. For example
28218 SHA1+DES represents all cipher suites containing the SHA1 and the DES
28219 algorithms.
28220 .endlist
28221
28222 Each cipher string can be optionally preceded by one of the characters &`!`&,
28223 &`-`& or &`+`&.
28224 .ilist
28225 If &`!`& is used, the ciphers are permanently deleted from the list. The
28226 ciphers deleted can never reappear in the list even if they are explicitly
28227 stated.
28228 .next
28229 If &`-`& is used, the ciphers are deleted from the list, but some or all
28230 of the ciphers can be added again by later options.
28231 .next
28232 If &`+`& is used, the ciphers are moved to the end of the list. This
28233 option does not add any new ciphers; it just moves matching existing ones.
28234 .endlist
28235
28236 If none of these characters is present, the string is interpreted as
28237 a list of ciphers to be appended to the current preference list. If the list
28238 includes any ciphers already present they will be ignored: that is, they will
28239 not be moved to the end of the list.
28240 .endlist
28241
28242 The OpenSSL &'ciphers(1)'& command may be used to test the results of a given
28243 string:
28244 .code
28245 # note single-quotes to get ! past any shell history expansion
28246 $ openssl ciphers 'HIGH:!MD5:!SHA1'
28247 .endd
28248
28249 This example will let the library defaults be permitted on the MX port, where
28250 there's probably no identity verification anyway, but ups the ante on the
28251 submission ports where the administrator might have some influence on the
28252 choice of clients used:
28253 .code
28254 # OpenSSL variant; see man ciphers(1)
28255 tls_require_ciphers = ${if =={$received_port}{25}\
28256                            {DEFAULT}\
28257                            {HIGH:!MD5:!SHA1}}
28258 .endd
28259
28260 This example will prefer ECDSA-authenticated ciphers over RSA ones:
28261 .code
28262 tls_require_ciphers = ECDSA:RSA:!COMPLEMENTOFDEFAULT
28263 .endd
28264
28265 For TLS version 1.3 the control available is less fine-grained
28266 and Exim does not provide access to it at present.
28267 The value of the &%tls_require_ciphers%& option is ignored when
28268 TLS version 1.3 is negotiated.
28269
28270 As of writing the library default cipher suite list for TLSv1.3 is
28271 .code
28272 TLS_AES_256_GCM_SHA384:TLS_CHACHA20_POLY1305_SHA256:TLS_AES_128_GCM_SHA256
28273 .endd
28274
28275
28276 .section "Requiring specific ciphers or other parameters in GnuTLS" &&&
28277          "SECTreqciphgnu"
28278 .cindex "GnuTLS" "specifying parameters for"
28279 .cindex "TLS" "specifying ciphers (GnuTLS)"
28280 .cindex "TLS" "specifying key exchange methods (GnuTLS)"
28281 .cindex "TLS" "specifying MAC algorithms (GnuTLS)"
28282 .cindex "TLS" "specifying protocols (GnuTLS)"
28283 .cindex "TLS" "specifying priority string (GnuTLS)"
28284 .oindex "&%tls_require_ciphers%&" "GnuTLS"
28285 The GnuTLS library allows the caller to provide a "priority string", documented
28286 as part of the &[gnutls_priority_init]& function.  This is very similar to the
28287 ciphersuite specification in OpenSSL.
28288
28289 The &%tls_require_ciphers%& option is treated as the GnuTLS priority string
28290 and controls both protocols and ciphers.
28291
28292 The &%tls_require_ciphers%& option is available both as an global option,
28293 controlling how Exim behaves as a server, and also as an option of the
28294 &(smtp)& transport, controlling how Exim behaves as a client.  In both cases
28295 the value is string expanded.  The resulting string is not an Exim list and
28296 the string is given to the GnuTLS library, so that Exim does not need to be
28297 aware of future feature enhancements of GnuTLS.
28298
28299 Documentation of the strings accepted may be found in the GnuTLS manual, under
28300 "Priority strings".  This is online as
28301 &url(https://www.gnutls.org/manual/html_node/Priority-Strings.html),
28302 but beware that this relates to GnuTLS 3, which may be newer than the version
28303 installed on your system.  If you are using GnuTLS 3,
28304 then the example code
28305 &url(https://www.gnutls.org/manual/gnutls.html#Listing-the-ciphersuites-in-a-priority-string)
28306 on that site can be used to test a given string.
28307
28308 For example:
28309 .code
28310 # Disable older versions of protocols
28311 tls_require_ciphers = NORMAL:%LATEST_RECORD_VERSION:-VERS-SSL3.0
28312 .endd
28313
28314 Prior to Exim 4.80, an older API of GnuTLS was used, and Exim supported three
28315 additional options, "&%gnutls_require_kx%&", "&%gnutls_require_mac%&" and
28316 "&%gnutls_require_protocols%&".  &%tls_require_ciphers%& was an Exim list.
28317
28318 This example will let the library defaults be permitted on the MX port, where
28319 there's probably no identity verification anyway, and lowers security further
28320 by increasing compatibility; but this ups the ante on the submission ports
28321 where the administrator might have some influence on the choice of clients
28322 used:
28323 .code
28324 # GnuTLS variant
28325 tls_require_ciphers = ${if =={$received_port}{25}\
28326                            {NORMAL:%COMPAT}\
28327                            {SECURE128}}
28328 .endd
28329
28330
28331 .section "Configuring an Exim server to use TLS" "SECID182"
28332 .cindex "TLS" "configuring an Exim server"
28333 When Exim has been built with TLS support, it advertises the availability of
28334 the STARTTLS command to client hosts that match &%tls_advertise_hosts%&,
28335 but not to any others. The default value of this option is *, which means
28336 that STARTTLS is always advertised.  Set it to blank to never advertise;
28337 this is reasonable for systems that want to use TLS only as a client.
28338
28339 If STARTTLS is to be used you
28340 need to set some other options in order to make TLS available.
28341
28342 If a client issues a STARTTLS command and there is some configuration
28343 problem in the server, the command is rejected with a 454 error. If the client
28344 persists in trying to issue SMTP commands, all except QUIT are rejected
28345 with the error
28346 .code
28347 554 Security failure
28348 .endd
28349 If a STARTTLS command is issued within an existing TLS session, it is
28350 rejected with a 554 error code.
28351
28352 To enable TLS operations on a server, the &%tls_advertise_hosts%& option
28353 must be set to match some hosts. The default is * which matches all hosts.
28354
28355 If this is all you do, TLS encryption will be enabled but not authentication -
28356 meaning that the peer has no assurance it is actually you he is talking to.
28357 You gain protection from a passive sniffer listening on the wire but not
28358 from someone able to intercept the communication.
28359
28360 Further protection requires some further configuration at the server end.
28361
28362 To make TLS work you need to set, in the server,
28363 .code
28364 tls_certificate = /some/file/name
28365 tls_privatekey = /some/file/name
28366 .endd
28367 These options are, in fact, expanded strings, so you can make them depend on
28368 the identity of the client that is connected if you wish. The first file
28369 contains the server's X509 certificate, and the second contains the private key
28370 that goes with it. These files need to be
28371 PEM format and readable by the Exim user, and must
28372 always be given as full path names.
28373 The key must not be password-protected.
28374 They can be the same file if both the
28375 certificate and the key are contained within it. If &%tls_privatekey%& is not
28376 set, or if its expansion is forced to fail or results in an empty string, this
28377 is assumed to be the case. The certificate file may also contain intermediate
28378 certificates that need to be sent to the client to enable it to authenticate
28379 the server's certificate.
28380
28381 For dual-stack (eg. RSA and ECDSA) configurations, these options can be
28382 colon-separated lists of file paths.  Ciphers using given authentication
28383 algorithms require the presence of a suitable certificate to supply the
28384 public-key.  The server selects among the certificates to present to the
28385 client depending on the selected cipher, hence the priority ordering for
28386 ciphers will affect which certificate is used.
28387
28388 If you do not understand about certificates and keys, please try to find a
28389 source of this background information, which is not Exim-specific. (There are a
28390 few comments below in section &<<SECTcerandall>>&.)
28391
28392 &*Note*&: These options do not apply when Exim is operating as a client &--
28393 they apply only in the case of a server. If you need to use a certificate in an
28394 Exim client, you must set the options of the same names in an &(smtp)&
28395 transport.
28396
28397 With just these options, an Exim server will be able to use TLS. It does not
28398 require the client to have a certificate (but see below for how to insist on
28399 this). There is one other option that may be needed in other situations. If
28400 .code
28401 tls_dhparam = /some/file/name
28402 .endd
28403 is set, the SSL library is initialized for the use of Diffie-Hellman ciphers
28404 with the parameters contained in the file.
28405 Set this to &`none`& to disable use of DH entirely, by making no prime
28406 available:
28407 .code
28408 tls_dhparam = none
28409 .endd
28410 This may also be set to a string identifying a standard prime to be used for
28411 DH; if it is set to &`default`& or, for OpenSSL, is unset, then the prime
28412 used is &`ike23`&.  There are a few standard primes available, see the
28413 documentation for &%tls_dhparam%& for the complete list.
28414
28415 See the command
28416 .code
28417 openssl dhparam
28418 .endd
28419 for a way of generating file data.
28420
28421 The strings supplied for these three options are expanded every time a client
28422 host connects. It is therefore possible to use different certificates and keys
28423 for different hosts, if you so wish, by making use of the client's IP address
28424 in &$sender_host_address$& to control the expansion. If a string expansion is
28425 forced to fail, Exim behaves as if the option is not set.
28426
28427 .cindex "cipher" "logging"
28428 .cindex "log" "TLS cipher"
28429 .vindex "&$tls_in_cipher$&"
28430 The variable &$tls_in_cipher$& is set to the cipher suite that was negotiated for
28431 an incoming TLS connection. It is included in the &'Received:'& header of an
28432 incoming message (by default &-- you can, of course, change this), and it is
28433 also included in the log line that records a message's arrival, keyed by
28434 &"X="&, unless the &%tls_cipher%& log selector is turned off. The &%encrypted%&
28435 condition can be used to test for specific cipher suites in ACLs.
28436
28437 Once TLS has been established, the ACLs that run for subsequent SMTP commands
28438 can check the name of the cipher suite and vary their actions accordingly. The
28439 cipher suite names vary, depending on which TLS library is being used. For
28440 example, OpenSSL uses the name DES-CBC3-SHA for the cipher suite which in other
28441 contexts is known as TLS_RSA_WITH_3DES_EDE_CBC_SHA. Check the OpenSSL or GnuTLS
28442 documentation for more details.
28443
28444 For outgoing SMTP deliveries, &$tls_out_cipher$& is used and logged
28445 (again depending on the &%tls_cipher%& log selector).
28446
28447
28448 .section "Requesting and verifying client certificates" "SECID183"
28449 .cindex "certificate" "verification of client"
28450 .cindex "TLS" "client certificate verification"
28451 If you want an Exim server to request a certificate when negotiating a TLS
28452 session with a client, you must set either &%tls_verify_hosts%& or
28453 &%tls_try_verify_hosts%&. You can, of course, set either of them to * to
28454 apply to all TLS connections. For any host that matches one of these options,
28455 Exim requests a certificate as part of the setup of the TLS session. The
28456 contents of the certificate are verified by comparing it with a list of
28457 expected trust-anchors or certificates.
28458 These may be the system default set (depending on library version),
28459 an explicit file or,
28460 depending on library version, a directory, identified by
28461 &%tls_verify_certificates%&.
28462
28463 A file can contain multiple certificates, concatenated end to end. If a
28464 directory is used
28465 (OpenSSL only),
28466 each certificate must be in a separate file, with a name (or a symbolic link)
28467 of the form <&'hash'&>.0, where <&'hash'&> is a hash value constructed from the
28468 certificate. You can compute the relevant hash by running the command
28469 .code
28470 openssl x509 -hash -noout -in /cert/file
28471 .endd
28472 where &_/cert/file_& contains a single certificate.
28473
28474 There is no checking of names of the client against the certificate
28475 Subject Name or Subject Alternate Names.
28476
28477 The difference between &%tls_verify_hosts%& and &%tls_try_verify_hosts%& is
28478 what happens if the client does not supply a certificate, or if the certificate
28479 does not match any of the certificates in the collection named by
28480 &%tls_verify_certificates%&. If the client matches &%tls_verify_hosts%&, the
28481 attempt to set up a TLS session is aborted, and the incoming connection is
28482 dropped. If the client matches &%tls_try_verify_hosts%&, the (encrypted) SMTP
28483 session continues. ACLs that run for subsequent SMTP commands can detect the
28484 fact that no certificate was verified, and vary their actions accordingly. For
28485 example, you can insist on a certificate before accepting a message for
28486 relaying, but not when the message is destined for local delivery.
28487
28488 .vindex "&$tls_in_peerdn$&"
28489 When a client supplies a certificate (whether it verifies or not), the value of
28490 the Distinguished Name of the certificate is made available in the variable
28491 &$tls_in_peerdn$& during subsequent processing of the message.
28492
28493 .cindex "log" "distinguished name"
28494 Because it is often a long text string, it is not included in the log line or
28495 &'Received:'& header by default. You can arrange for it to be logged, keyed by
28496 &"DN="&, by setting the &%tls_peerdn%& log selector, and you can use
28497 &%received_header_text%& to change the &'Received:'& header. When no
28498 certificate is supplied, &$tls_in_peerdn$& is empty.
28499
28500
28501 .section "Revoked certificates" "SECID184"
28502 .cindex "TLS" "revoked certificates"
28503 .cindex "revocation list"
28504 .cindex "certificate" "revocation list"
28505 .cindex "OCSP" "stapling"
28506 Certificate issuing authorities issue Certificate Revocation Lists (CRLs) when
28507 certificates are revoked. If you have such a list, you can pass it to an Exim
28508 server using the global option called &%tls_crl%& and to an Exim client using
28509 an identically named option for the &(smtp)& transport. In each case, the value
28510 of the option is expanded and must then be the name of a file that contains a
28511 CRL in PEM format.
28512 The downside is that clients have to periodically re-download a potentially huge
28513 file from every certificate authority they know of.
28514
28515 The way with most moving parts at query time is Online Certificate
28516 Status Protocol (OCSP), where the client verifies the certificate
28517 against an OCSP server run by the CA.  This lets the CA track all
28518 usage of the certs.  It requires running software with access to the
28519 private key of the CA, to sign the responses to the OCSP queries.  OCSP
28520 is based on HTTP and can be proxied accordingly.
28521
28522 The only widespread OCSP server implementation (known to this writer)
28523 comes as part of OpenSSL and aborts on an invalid request, such as
28524 connecting to the port and then disconnecting.  This requires
28525 re-entering the passphrase each time some random client does this.
28526
28527 The third way is OCSP Stapling; in this, the server using a certificate
28528 issued by the CA periodically requests an OCSP proof of validity from
28529 the OCSP server, then serves it up inline as part of the TLS
28530 negotiation.   This approach adds no extra round trips, does not let the
28531 CA track users, scales well with number of certs issued by the CA and is
28532 resilient to temporary OCSP server failures, as long as the server
28533 starts retrying to fetch an OCSP proof some time before its current
28534 proof expires.  The downside is that it requires server support.
28535
28536 Unless Exim is built with the support disabled,
28537 or with GnuTLS earlier than version 3.3.16 / 3.4.8
28538 support for OCSP stapling is included.
28539
28540 There is a global option called &%tls_ocsp_file%&.
28541 The file specified therein is expected to be in DER format, and contain
28542 an OCSP proof.  Exim will serve it as part of the TLS handshake.  This
28543 option will be re-expanded for SNI, if the &%tls_certificate%& option
28544 contains &`tls_in_sni`&, as per other TLS options.
28545
28546 Exim does not at this time implement any support for fetching a new OCSP
28547 proof.  The burden is on the administrator to handle this, outside of
28548 Exim.  The file specified should be replaced atomically, so that the
28549 contents are always valid.  Exim will expand the &%tls_ocsp_file%& option
28550 on each connection, so a new file will be handled transparently on the
28551 next connection.
28552
28553 When built with OpenSSL Exim will check for a valid next update timestamp
28554 in the OCSP proof; if not present, or if the proof has expired, it will be
28555 ignored.
28556
28557 For the client to be able to verify the stapled OCSP the server must
28558 also supply, in its stapled information, any intermediate
28559 certificates for the chain leading to the OCSP proof from the signer
28560 of the server certificate.  There may be zero or one such. These
28561 intermediate certificates should be added to the server OCSP stapling
28562 file named by &%tls_ocsp_file%&.
28563
28564 Note that the proof only covers the terminal server certificate,
28565 not any of the chain from CA to it.
28566
28567 There is no current way to staple a proof for a client certificate.
28568
28569 .code
28570   A helper script "ocsp_fetch.pl" for fetching a proof from a CA
28571   OCSP server is supplied.  The server URL may be included in the
28572   server certificate, if the CA is helpful.
28573
28574   One failure mode seen was the OCSP Signer cert expiring before the end
28575   of validity of the OCSP proof. The checking done by Exim/OpenSSL
28576   noted this as invalid overall, but the re-fetch script did not.
28577 .endd
28578
28579
28580
28581
28582 .section "Configuring an Exim client to use TLS" "SECTclientTLS"
28583 .cindex "cipher" "logging"
28584 .cindex "log" "TLS cipher"
28585 .cindex "log" "distinguished name"
28586 .cindex "TLS" "configuring an Exim client"
28587 The &%tls_cipher%& and &%tls_peerdn%& log selectors apply to outgoing SMTP
28588 deliveries as well as to incoming, the latter one causing logging of the
28589 server certificate's DN. The remaining client configuration for TLS is all
28590 within the &(smtp)& transport.
28591
28592 It is not necessary to set any options to have TLS work in the &(smtp)&
28593 transport. If Exim is built with TLS support, and TLS is advertised by a
28594 server, the &(smtp)& transport always tries to start a TLS session. However,
28595 this can be prevented by setting &%hosts_avoid_tls%& (an option of the
28596 transport) to a list of server hosts for which TLS should not be used.
28597
28598 If you do not want Exim to attempt to send messages unencrypted when an attempt
28599 to set up an encrypted connection fails in any way, you can set
28600 &%hosts_require_tls%& to a list of hosts for which encryption is mandatory. For
28601 those hosts, delivery is always deferred if an encrypted connection cannot be
28602 set up. If there are any other hosts for the address, they are tried in the
28603 usual way.
28604
28605 When the server host is not in &%hosts_require_tls%&, Exim may try to deliver
28606 the message unencrypted. It always does this if the response to STARTTLS is
28607 a 5&'xx'& code. For a temporary error code, or for a failure to negotiate a TLS
28608 session after a success response code, what happens is controlled by the
28609 &%tls_tempfail_tryclear%& option of the &(smtp)& transport. If it is false,
28610 delivery to this host is deferred, and other hosts (if available) are tried. If
28611 it is true, Exim attempts to deliver unencrypted after a 4&'xx'& response to
28612 STARTTLS, and if STARTTLS is accepted, but the subsequent TLS
28613 negotiation fails, Exim closes the current connection (because it is in an
28614 unknown state), opens a new one to the same host, and then tries the delivery
28615 unencrypted.
28616
28617 The &%tls_certificate%& and &%tls_privatekey%& options of the &(smtp)&
28618 transport provide the client with a certificate, which is passed to the server
28619 if it requests it. If the server is Exim, it will request a certificate only if
28620 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& matches the client.
28621
28622 .new
28623 Do not use a certificate which has the OCSP-must-staple extension,
28624 for client use (they are usable for server use).
28625 As TLS has no means for the client to staple before TLS 1.3 it will result
28626 in failed connections.
28627 .wen
28628
28629 If the &%tls_verify_certificates%& option is set on the &(smtp)& transport, it
28630 specifies a collection of expected server certificates.
28631 These may be
28632 the system default set (depending on library version),
28633 a file,
28634 or (depending on library version) a directory.
28635 The client verifies the server's certificate
28636 against this collection, taking into account any revoked certificates that are
28637 in the list defined by &%tls_crl%&.
28638 Failure to verify fails the TLS connection unless either of the
28639 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& options are set.
28640
28641 The &%tls_verify_hosts%& and &%tls_try_verify_hosts%& options restrict
28642 certificate verification to the listed servers.  Verification either must
28643 or need not succeed respectively.
28644
28645 The &%tls_verify_cert_hostnames%& option lists hosts for which additional
28646 checks are made: that the host name (the one in the DNS A record)
28647 is valid for the certificate.
28648 The option defaults to always checking.
28649
28650 The &(smtp)& transport has two OCSP-related options:
28651 &%hosts_require_ocsp%&; a host-list for which a Certificate Status
28652 is requested and required for the connection to proceed.  The default
28653 value is empty.
28654 &%hosts_request_ocsp%&; a host-list for which (additionally)
28655 a Certificate Status is requested (but not necessarily verified).  The default
28656 value is "*" meaning that requests are made unless configured
28657 otherwise.
28658
28659 The host(s) should also be in &%hosts_require_tls%&, and
28660 &%tls_verify_certificates%& configured for the transport,
28661 for OCSP to be relevant.
28662
28663 If
28664 &%tls_require_ciphers%& is set on the &(smtp)& transport, it must contain a
28665 list of permitted cipher suites. If either of these checks fails, delivery to
28666 the current host is abandoned, and the &(smtp)& transport tries to deliver to
28667 alternative hosts, if any.
28668
28669  &*Note*&:
28670 These options must be set in the &(smtp)& transport for Exim to use TLS when it
28671 is operating as a client. Exim does not assume that a server certificate (set
28672 by the global options of the same name) should also be used when operating as a
28673 client.
28674
28675 .vindex "&$host$&"
28676 .vindex "&$host_address$&"
28677 All the TLS options in the &(smtp)& transport are expanded before use, with
28678 &$host$& and &$host_address$& containing the name and address of the server to
28679 which the client is connected. Forced failure of an expansion causes Exim to
28680 behave as if the relevant option were unset.
28681
28682 .vindex &$tls_out_bits$&
28683 .vindex &$tls_out_cipher$&
28684 .vindex &$tls_out_peerdn$&
28685 .vindex &$tls_out_sni$&
28686 Before an SMTP connection is established, the
28687 &$tls_out_bits$&, &$tls_out_cipher$&, &$tls_out_peerdn$& and &$tls_out_sni$&
28688 variables are emptied. (Until the first connection, they contain the values
28689 that were set when the message was received.) If STARTTLS is subsequently
28690 successfully obeyed, these variables are set to the relevant values for the
28691 outgoing connection.
28692
28693
28694
28695 .section "Use of TLS Server Name Indication" "SECTtlssni"
28696 .cindex "TLS" "Server Name Indication"
28697 .vindex "&$tls_in_sni$&"
28698 .oindex "&%tls_in_sni%&"
28699 With TLS1.0 or above, there is an extension mechanism by which extra
28700 information can be included at various points in the protocol.  One of these
28701 extensions, documented in RFC 6066 (and before that RFC 4366) is
28702 &"Server Name Indication"&, commonly &"SNI"&.  This extension is sent by the
28703 client in the initial handshake, so that the server can examine the servername
28704 within and possibly choose to use different certificates and keys (and more)
28705 for this session.
28706
28707 This is analogous to HTTP's &"Host:"& header, and is the main mechanism by
28708 which HTTPS-enabled web-sites can be virtual-hosted, many sites to one IP
28709 address.
28710
28711 With SMTP to MX, there are the same problems here as in choosing the identity
28712 against which to validate a certificate: you can't rely on insecure DNS to
28713 provide the identity which you then cryptographically verify.  So this will
28714 be of limited use in that environment.
28715
28716 With SMTP to Submission, there is a well-defined hostname which clients are
28717 connecting to and can validate certificates against.  Thus clients &*can*&
28718 choose to include this information in the TLS negotiation.  If this becomes
28719 wide-spread, then hosters can choose to present different certificates to
28720 different clients.  Or even negotiate different cipher suites.
28721
28722 The &%tls_sni%& option on an SMTP transport is an expanded string; the result,
28723 if not empty, will be sent on a TLS session as part of the handshake.  There's
28724 nothing more to it.  Choosing a sensible value not derived insecurely is the
28725 only point of caution.  The &$tls_out_sni$& variable will be set to this string
28726 for the lifetime of the client connection (including during authentication).
28727
28728 Except during SMTP client sessions, if &$tls_in_sni$& is set then it is a string
28729 received from a client.
28730 It can be logged with the &%log_selector%& item &`+tls_sni`&.
28731
28732 If the string &`tls_in_sni`& appears in the main section's &%tls_certificate%&
28733 option (prior to expansion) then the following options will be re-expanded
28734 during TLS session handshake, to permit alternative values to be chosen:
28735
28736 .ilist
28737 &%tls_certificate%&
28738 .next
28739 &%tls_crl%&
28740 .next
28741 &%tls_privatekey%&
28742 .next
28743 &%tls_verify_certificates%&
28744 .next
28745 &%tls_ocsp_file%&
28746 .endlist
28747
28748 Great care should be taken to deal with matters of case, various injection
28749 attacks in the string (&`../`& or SQL), and ensuring that a valid filename
28750 can always be referenced; it is important to remember that &$tls_in_sni$& is
28751 arbitrary unverified data provided prior to authentication.
28752 Further, the initial certificate is loaded before SNI has arrived, so
28753 an expansion for &%tls_certificate%& must have a default which is used
28754 when &$tls_in_sni$& is empty.
28755
28756 The Exim developers are proceeding cautiously and so far no other TLS options
28757 are re-expanded.
28758
28759 When Exim is built against OpenSSL, OpenSSL must have been built with support
28760 for TLS Extensions.  This holds true for OpenSSL 1.0.0+ and 0.9.8+ with
28761 enable-tlsext in EXTRACONFIGURE.  If you invoke &(openssl s_client -h)& and
28762 see &`-servername`& in the output, then OpenSSL has support.
28763
28764 When Exim is built against GnuTLS, SNI support is available as of GnuTLS
28765 0.5.10.  (Its presence predates the current API which Exim uses, so if Exim
28766 built, then you have SNI support).
28767
28768
28769
28770 .section "Multiple messages on the same encrypted TCP/IP connection" &&&
28771          "SECTmulmessam"
28772 .cindex "multiple SMTP deliveries with TLS"
28773 .cindex "TLS" "multiple message deliveries"
28774 Exim sends multiple messages down the same TCP/IP connection by starting up
28775 an entirely new delivery process for each message, passing the socket from
28776 one process to the next. This implementation does not fit well with the use
28777 of TLS, because there is quite a lot of state information associated with a TLS
28778 connection, not just a socket identification. Passing all the state information
28779 to a new process is not feasible. Consequently, for sending using TLS Exim
28780 starts an additional proxy process for handling the encryption, piping the
28781 unencrypted data stream from and to the delivery processes.
28782
28783 An older mode of operation can be enabled on a per-host basis by the
28784 &%hosts_noproxy_tls%& option on the &(smtp)& transport.  If the host matches
28785 this list the proxy process described above is not used; instead Exim
28786 shuts down an existing TLS session being run by the delivery process
28787 before passing the socket to a new process. The new process may then
28788 try to start a new TLS session, and if successful, may try to re-authenticate
28789 if AUTH is in use, before sending the next message.
28790
28791 The RFC is not clear as to whether or not an SMTP session continues in clear
28792 after TLS has been shut down, or whether TLS may be restarted again later, as
28793 just described. However, if the server is Exim, this shutdown and
28794 reinitialization works. It is not known which (if any) other servers operate
28795 successfully if the client closes a TLS session and continues with unencrypted
28796 SMTP, but there are certainly some that do not work. For such servers, Exim
28797 should not pass the socket to another process, because the failure of the
28798 subsequent attempt to use it would cause Exim to record a temporary host error,
28799 and delay other deliveries to that host.
28800
28801 To test for this case, Exim sends an EHLO command to the server after
28802 closing down the TLS session. If this fails in any way, the connection is
28803 closed instead of being passed to a new delivery process, but no retry
28804 information is recorded.
28805
28806 There is also a manual override; you can set &%hosts_nopass_tls%& on the
28807 &(smtp)& transport to match those hosts for which Exim should not pass
28808 connections to new processes if TLS has been used.
28809
28810
28811
28812
28813 .section "Certificates and all that" "SECTcerandall"
28814 .cindex "certificate" "references to discussion"
28815 In order to understand fully how TLS works, you need to know about
28816 certificates, certificate signing, and certificate authorities.
28817 This is a large topic and an introductory guide is unsuitable for the Exim
28818 reference manual, so instead we provide pointers to existing documentation.
28819
28820 The Apache web-server was for a long time the canonical guide, so their
28821 documentation is a good place to start; their SSL module's Introduction
28822 document is currently at
28823 .display
28824 &url(https://httpd.apache.org/docs/current/ssl/ssl_intro.html)
28825 .endd
28826 and their FAQ is at
28827 .display
28828 &url(https://httpd.apache.org/docs/current/ssl/ssl_faq.html)
28829 .endd
28830
28831 Eric Rescorla's book, &'SSL and TLS'&, published by Addison-Wesley (ISBN
28832 0-201-61598-3) in 2001, contains both introductory and more in-depth
28833 descriptions.
28834 More recently Ivan Ristić's book &'Bulletproof SSL and TLS'&,
28835 published by Feisty Duck (ISBN 978-1907117046) in 2013 is good.
28836 Ivan is the author of the popular TLS testing tools at
28837 &url(https://www.ssllabs.com/).
28838
28839
28840 .section "Certificate chains" "SECID186"
28841 The file named by &%tls_certificate%& may contain more than one
28842 certificate. This is useful in the case where the certificate that is being
28843 sent is validated by an intermediate certificate which the other end does
28844 not have. Multiple certificates must be in the correct order in the file.
28845 First the host's certificate itself, then the first intermediate
28846 certificate to validate the issuer of the host certificate, then the next
28847 intermediate certificate to validate the issuer of the first intermediate
28848 certificate, and so on, until finally (optionally) the root certificate.
28849 The root certificate must already be trusted by the recipient for
28850 validation to succeed, of course, but if it's not preinstalled, sending the
28851 root certificate along with the rest makes it available for the user to
28852 install if the receiving end is a client MUA that can interact with a user.
28853
28854 Note that certificates using MD5 are unlikely to work on today's Internet;
28855 even if your libraries allow loading them for use in Exim when acting as a
28856 server, increasingly clients will not accept such certificates.  The error
28857 diagnostics in such a case can be frustratingly vague.
28858
28859
28860
28861 .section "Self-signed certificates" "SECID187"
28862 .cindex "certificate" "self-signed"
28863 You can create a self-signed certificate using the &'req'& command provided
28864 with OpenSSL, like this:
28865 . ==== Do not shorten the duration here without reading and considering
28866 . ==== the text below.  Please leave it at 9999 days.
28867 .code
28868 openssl req -x509 -newkey rsa:1024 -keyout file1 -out file2 \
28869             -days 9999 -nodes
28870 .endd
28871 &_file1_& and &_file2_& can be the same file; the key and the certificate are
28872 delimited and so can be identified independently. The &%-days%& option
28873 specifies a period for which the certificate is valid. The &%-nodes%& option is
28874 important: if you do not set it, the key is encrypted with a passphrase
28875 that you are prompted for, and any use that is made of the key causes more
28876 prompting for the passphrase. This is not helpful if you are going to use
28877 this certificate and key in an MTA, where prompting is not possible.
28878
28879 . ==== I expect to still be working 26 years from now.  The less technical
28880 . ==== debt I create, in terms of storing up trouble for my later years, the
28881 . ==== happier I will be then.  We really have reached the point where we
28882 . ==== should start, at the very least, provoking thought and making folks
28883 . ==== pause before proceeding, instead of leaving all the fixes until two
28884 . ==== years before 2^31 seconds after the 1970 Unix epoch.
28885 . ==== -pdp, 2012
28886 NB: we are now past the point where 9999 days takes us past the 32-bit Unix
28887 epoch.  If your system uses unsigned time_t (most do) and is 32-bit, then
28888 the above command might produce a date in the past.  Think carefully about
28889 the lifetime of the systems you're deploying, and either reduce the duration
28890 of the certificate or reconsider your platform deployment.  (At time of
28891 writing, reducing the duration is the most likely choice, but the inexorable
28892 progression of time takes us steadily towards an era where this will not
28893 be a sensible resolution).
28894
28895 A self-signed certificate made in this way is sufficient for testing, and
28896 may be adequate for all your requirements if you are mainly interested in
28897 encrypting transfers, and not in secure identification.
28898
28899 However, many clients require that the certificate presented by the server be a
28900 user (also called &"leaf"& or &"site"&) certificate, and not a self-signed
28901 certificate. In this situation, the self-signed certificate described above
28902 must be installed on the client host as a trusted root &'certification
28903 authority'& (CA), and the certificate used by Exim must be a user certificate
28904 signed with that self-signed certificate.
28905
28906 For information on creating self-signed CA certificates and using them to sign
28907 user certificates, see the &'General implementation overview'& chapter of the
28908 Open-source PKI book, available online at
28909 &url(https://sourceforge.net/projects/ospkibook/).
28910 .ecindex IIDencsmtp1
28911 .ecindex IIDencsmtp2
28912
28913
28914
28915 .section DANE "SECDANE"
28916 .cindex DANE
28917 DNS-based Authentication of Named Entities, as applied to SMTP over TLS, provides assurance to a client that
28918 it is actually talking to the server it wants to rather than some attacker operating a Man In The Middle (MITM)
28919 operation.  The latter can terminate the TLS connection you make, and make another one to the server (so both
28920 you and the server still think you have an encrypted connection) and, if one of the "well known" set of
28921 Certificate Authorities has been suborned - something which *has* been seen already (2014), a verifiable
28922 certificate (if you're using normal root CAs, eg. the Mozilla set, as your trust anchors).
28923
28924 What DANE does is replace the CAs with the DNS as the trust anchor.  The assurance is limited to a) the possibility
28925 that the DNS has been suborned, b) mistakes made by the admins of the target server.   The attack surface presented
28926 by (a) is thought to be smaller than that of the set of root CAs.
28927
28928 It also allows the server to declare (implicitly) that connections to it should use TLS.  An MITM could simply
28929 fail to pass on a server's STARTTLS.
28930
28931 DANE scales better than having to maintain (and side-channel communicate) copies of server certificates
28932 for every possible target server.  It also scales (slightly) better than having to maintain on an SMTP
28933 client a copy of the standard CAs bundle.  It also means not having to pay a CA for certificates.
28934
28935 DANE requires a server operator to do three things: 1) run DNSSEC.  This provides assurance to clients
28936 that DNS lookups they do for the server have not been tampered with.  The domain MX record applying
28937 to this server, its A record, its TLSA record and any associated CNAME records must all be covered by
28938 DNSSEC.
28939 2) add TLSA DNS records.  These say what the server certificate for a TLS connection should be.
28940 3) offer a server certificate, or certificate chain, in TLS connections which is is anchored by one of the TLSA records.
28941
28942 There are no changes to Exim specific to server-side operation of DANE.
28943 Support for client-side operation of DANE can be included at compile time by defining SUPPORT_DANE=yes
28944 in &_Local/Makefile_&.
28945 If it has been included, the macro "_HAVE_DANE" will be defined.
28946
28947 A TLSA record consist of 4 fields, the "Certificate Usage", the
28948 "Selector", the "Matching type", and the "Certificate Association Data".
28949 For a detailed description of the TLSA record see
28950 &url(https://tools.ietf.org/html/rfc7671#page-5,RFC 7671).
28951
28952 The TLSA record for the server may have "Certificate Usage" (1st) field of DANE-TA(2) or DANE-EE(3).
28953 These are the "Trust Anchor" and "End Entity" variants.
28954 The latter specifies the End Entity directly, i.e. the certificate involved is that of the server
28955 (and if only DANE-EE is used then it should be the sole one transmitted during the TLS handshake);
28956 this is appropriate for a single system, using a self-signed certificate.
28957 DANE-TA usage is effectively declaring a specific CA to be used; this might be a private CA or a public,
28958 well-known one.
28959 A private CA at simplest is just a self-signed certificate (with certain
28960 attributes) which is used to sign server certificates, but running one securely
28961 does require careful arrangement.
28962 With DANE-TA, as implemented in Exim and commonly in other MTAs,
28963 the server TLS handshake must transmit the entire certificate chain from CA to server-certificate.
28964 DANE-TA is commonly used for several services and/or servers, each having a TLSA query-domain CNAME record,
28965 all of which point to a single TLSA record.
28966 DANE-TA and DANE-EE can both be used together.
28967
28968 Our recommendation is to use DANE with a certificate from a public CA,
28969 because this enables a variety of strategies for remote clients to verify
28970 your certificate.
28971 You can then publish information both via DANE and another technology,
28972 "MTA-STS", described below.
28973
28974 When you use DANE-TA to publish trust anchor information, you ask entities
28975 outside your administrative control to trust the Certificate Authority for
28976 connections to you.
28977 If using a private CA then you should expect others to still apply the
28978 technical criteria they'd use for a public CA to your certificates.
28979 In particular, you should probably try to follow current best practices for CA
28980 operation around hash algorithms and key sizes.
28981 Do not expect other organizations to lower their security expectations just
28982 because a particular profile might be reasonable for your own internal use.
28983
28984 When this text was last updated, this in practice means to avoid use of SHA-1
28985 and MD5; if using RSA to use key sizes of at least 2048 bits (and no larger
28986 than 4096, for interoperability); to use keyUsage fields correctly; to use
28987 random serial numbers.
28988 The list of requirements is subject to change as best practices evolve.
28989 If you're not already using a private CA, or it doesn't meet these
28990 requirements, then we encourage you to avoid all these issues and use a public
28991 CA such as &url(https://letsencrypt.org/,Let's Encrypt) instead.
28992
28993 The TLSA record should have a "Selector" (2nd) field of SPKI(1) and
28994 a "Matching Type" (3rd) field of SHA2-512(2).
28995
28996 For the "Certificate Authority Data" (4th) field, commands like
28997
28998 .code
28999   openssl x509 -pubkey -noout <certificate.pem \
29000   | openssl rsa -outform der -pubin 2>/dev/null \
29001   | openssl sha512 \
29002   | awk '{print $2}'
29003 .endd
29004
29005 are workable to create a hash of the certificate's public key.
29006
29007 An example TLSA record for DANE-EE(3), SPKI(1), and SHA-512 (2) looks like
29008
29009 .code
29010   _25._tcp.mail.example.com. TLSA 3 1 2 8BA8A336E...
29011 .endd
29012
29013 At the time of writing, &url(https://www.huque.com/bin/gen_tlsa)
29014 is useful for quickly generating TLSA records.
29015
29016
29017 For use with the DANE-TA model, server certificates must have a correct name (SubjectName or SubjectAltName).
29018
29019 The Certificate issued by the CA published in the DANE-TA model should be
29020 issued using a strong hash algorithm.
29021 Exim, and importantly various other MTAs sending to you, will not
29022 re-enable hash algorithms which have been disabled by default in TLS
29023 libraries.
29024 This means no MD5 and no SHA-1.  SHA2-256 is the minimum for reliable
29025 interoperability (and probably the maximum too, in 2018).
29026
29027 The use of OCSP-stapling should be considered, allowing for fast revocation of certificates (which would otherwise
29028 be limited by the DNS TTL on the TLSA records).  However, this is likely to only be usable with DANE-TA.  NOTE: the
29029 default of requesting OCSP for all hosts is modified iff DANE is in use, to:
29030
29031 .code
29032   hosts_request_ocsp = ${if or { {= {0}{$tls_out_tlsa_usage}} \
29033                                  {= {4}{$tls_out_tlsa_usage}} } \
29034                          {*}{}}
29035 .endd
29036
29037 The (new) variable &$tls_out_tlsa_usage$& is a bitfield with numbered bits set for TLSA record usage codes.
29038 The zero above means DANE was not in use, the four means that only DANE-TA usage TLSA records were
29039 found. If the definition of &%hosts_request_ocsp%& includes the
29040 string "tls_out_tlsa_usage", they are re-expanded in time to
29041 control the OCSP request.
29042
29043 This modification of hosts_request_ocsp is only done if it has the default value of "*".  Admins who change it, and
29044 those who use &%hosts_require_ocsp%&, should consider the interaction with DANE in their OCSP settings.
29045
29046
29047 For client-side DANE there are three new smtp transport options, &%hosts_try_dane%&, &%hosts_require_dane%&
29048 and &%dane_require_tls_ciphers%&.
29049 The require variant will result in failure if the target host is not
29050 DNSSEC-secured. To get DNSSEC-secured hostname resolution, use
29051 the &%dnssec_request_domains%& router or transport option.
29052
29053 DANE will only be usable if the target host has DNSSEC-secured MX, A and TLSA records.
29054
29055 A TLSA lookup will be done if either of the above options match and the host-lookup succeeded using dnssec.
29056 If a TLSA lookup is done and succeeds, a DANE-verified TLS connection
29057 will be required for the host.  If it does not, the host will not
29058 be used; there is no fallback to non-DANE or non-TLS.
29059
29060 If DANE is requested and usable, then the TLS cipher list configuration
29061 prefers to use the option &%dane_require_tls_ciphers%& and falls
29062 back to &%tls_require_ciphers%& only if that is unset.
29063 This lets you configure "decent crypto" for DANE and "better than nothing
29064 crypto" as the default.  Note though that while GnuTLS lets the string control
29065 which versions of TLS/SSL will be negotiated, OpenSSL does not and you're
29066 limited to ciphersuite constraints.
29067
29068 If DANE is requested and useable (see above) the following transport options are ignored:
29069 .code
29070   hosts_require_tls
29071   tls_verify_hosts
29072   tls_try_verify_hosts
29073   tls_verify_certificates
29074   tls_crl
29075   tls_verify_cert_hostnames
29076 .endd
29077
29078 If DANE is not usable, whether requested or not, and CA-anchored
29079 verification evaluation is wanted, the above variables should be set appropriately.
29080
29081 The router and transport option &%dnssec_request_domains%& must not be
29082 set to "never" and &%dnssec_require_domains%& is ignored.
29083
29084 If verification was successful using DANE then the "CV" item in the delivery log line will show as "CV=dane".
29085
29086 There is a new variable &$tls_out_dane$& which will have "yes" if
29087 verification succeeded using DANE and "no" otherwise (only useful
29088 in combination with events; see &<<CHAPevents>>&),
29089 and a new variable &$tls_out_tlsa_usage$& (detailed above).
29090
29091 .cindex DANE reporting
29092 An event (see &<<CHAPevents>>&) of type "dane:fail" will be raised on failures
29093 to achieve DANE-verified connection, if one was either requested and offered, or
29094 required.  This is intended to support TLS-reporting as defined in
29095 &url(https://tools.ietf.org/html/draft-ietf-uta-smtp-tlsrpt-17).
29096 The &$event_data$& will be one of the Result Types defined in
29097 Section 4.3 of that document.
29098
29099 Under GnuTLS, DANE is only supported from version 3.0.0 onwards.
29100
29101 DANE is specified in published RFCs and decouples certificate authority trust
29102 selection from a "race to the bottom" of "you must trust everything for mail
29103 to get through".  There is an alternative technology called MTA-STS, which
29104 instead publishes MX trust anchor information on an HTTPS website.  At the
29105 time this text was last updated, MTA-STS was still a draft, not yet an RFC.
29106 Exim has no support for MTA-STS as a client, but Exim mail server operators
29107 can choose to publish information describing their TLS configuration using
29108 MTA-STS to let those clients who do use that protocol derive trust
29109 information.
29110
29111 The MTA-STS design requires a certificate from a public Certificate Authority
29112 which is recognized by clients sending to you.
29113 That selection of which CAs are trusted by others is outside your control.
29114
29115 The most interoperable course of action is probably to use
29116 &url(https://letsencrypt.org/,Let's Encrypt), with automated certificate
29117 renewal; to publish the anchor information in DNSSEC-secured DNS via TLSA
29118 records for DANE clients (such as Exim and Postfix) and to publish anchor
29119 information for MTA-STS as well.  This is what is done for the &'exim.org'&
29120 domain itself (with caveats around occasionally broken MTA-STS because of
29121 incompatible specification changes prior to reaching RFC status).
29122
29123
29124
29125 . ////////////////////////////////////////////////////////////////////////////
29126 . ////////////////////////////////////////////////////////////////////////////
29127
29128 .chapter "Access control lists" "CHAPACL"
29129 .scindex IIDacl "&ACL;" "description"
29130 .cindex "control of incoming mail"
29131 .cindex "message" "controlling incoming"
29132 .cindex "policy control" "access control lists"
29133 Access Control Lists (ACLs) are defined in a separate section of the runtime
29134 configuration file, headed by &"begin acl"&. Each ACL definition starts with a
29135 name, terminated by a colon. Here is a complete ACL section that contains just
29136 one very small ACL:
29137 .code
29138 begin acl
29139 small_acl:
29140   accept   hosts = one.host.only
29141 .endd
29142 You can have as many lists as you like in the ACL section, and the order in
29143 which they appear does not matter. The lists are self-terminating.
29144
29145 The majority of ACLs are used to control Exim's behaviour when it receives
29146 certain SMTP commands. This applies both to incoming TCP/IP connections, and
29147 when a local process submits a message using SMTP by specifying the &%-bs%&
29148 option. The most common use is for controlling which recipients are accepted
29149 in incoming messages. In addition, you can define an ACL that is used to check
29150 local non-SMTP messages. The default configuration file contains an example of
29151 a realistic ACL for checking RCPT commands. This is discussed in chapter
29152 &<<CHAPdefconfil>>&.
29153
29154
29155 .section "Testing ACLs" "SECID188"
29156 The &%-bh%& command line option provides a way of testing your ACL
29157 configuration locally by running a fake SMTP session with which you interact.
29158
29159
29160 .section "Specifying when ACLs are used" "SECID189"
29161 .cindex "&ACL;" "options for specifying"
29162 In order to cause an ACL to be used, you have to name it in one of the relevant
29163 options in the main part of the configuration. These options are:
29164 .cindex "AUTH" "ACL for"
29165 .cindex "DATA" "ACLs for"
29166 .cindex "ETRN" "ACL for"
29167 .cindex "EXPN" "ACL for"
29168 .cindex "HELO" "ACL for"
29169 .cindex "EHLO" "ACL for"
29170 .cindex "DKIM" "ACL for"
29171 .cindex "MAIL" "ACL for"
29172 .cindex "QUIT, ACL for"
29173 .cindex "RCPT" "ACL for"
29174 .cindex "STARTTLS, ACL for"
29175 .cindex "VRFY" "ACL for"
29176 .cindex "SMTP" "connection, ACL for"
29177 .cindex "non-SMTP messages" "ACLs for"
29178 .cindex "MIME content scanning" "ACL for"
29179 .cindex "PRDR" "ACL for"
29180
29181 .table2 140pt
29182 .irow &%acl_not_smtp%&         "ACL for non-SMTP messages"
29183 .irow &%acl_not_smtp_mime%&    "ACL for non-SMTP MIME parts"
29184 .irow &%acl_not_smtp_start%&   "ACL at start of non-SMTP message"
29185 .irow &%acl_smtp_auth%&        "ACL for AUTH"
29186 .irow &%acl_smtp_connect%&     "ACL for start of SMTP connection"
29187 .irow &%acl_smtp_data%&        "ACL after DATA is complete"
29188 .irow &%acl_smtp_data_prdr%&   "ACL for each recipient, after DATA is complete"
29189 .irow &%acl_smtp_dkim%&        "ACL for each DKIM signer"
29190 .irow &%acl_smtp_etrn%&        "ACL for ETRN"
29191 .irow &%acl_smtp_expn%&        "ACL for EXPN"
29192 .irow &%acl_smtp_helo%&        "ACL for HELO or EHLO"
29193 .irow &%acl_smtp_mail%&        "ACL for MAIL"
29194 .irow &%acl_smtp_mailauth%&    "ACL for the AUTH parameter of MAIL"
29195 .irow &%acl_smtp_mime%&        "ACL for content-scanning MIME parts"
29196 .irow &%acl_smtp_notquit%&     "ACL for non-QUIT terminations"
29197 .irow &%acl_smtp_predata%&     "ACL at start of DATA command"
29198 .irow &%acl_smtp_quit%&        "ACL for QUIT"
29199 .irow &%acl_smtp_rcpt%&        "ACL for RCPT"
29200 .irow &%acl_smtp_starttls%&    "ACL for STARTTLS"
29201 .irow &%acl_smtp_vrfy%&        "ACL for VRFY"
29202 .endtable
29203
29204 For example, if you set
29205 .code
29206 acl_smtp_rcpt = small_acl
29207 .endd
29208 the little ACL defined above is used whenever Exim receives a RCPT command
29209 in an SMTP dialogue. The majority of policy tests on incoming messages can be
29210 done when RCPT commands arrive. A rejection of RCPT should cause the
29211 sending MTA to give up on the recipient address contained in the RCPT
29212 command, whereas rejection at other times may cause the client MTA to keep on
29213 trying to deliver the message. It is therefore recommended that you do as much
29214 testing as possible at RCPT time.
29215
29216
29217 .section "The non-SMTP ACLs" "SECID190"
29218 .cindex "non-SMTP messages" "ACLs for"
29219 The non-SMTP ACLs apply to all non-interactive incoming messages, that is, they
29220 apply to batched SMTP as well as to non-SMTP messages. (Batched SMTP is not
29221 really SMTP.) Many of the ACL conditions (for example, host tests, and tests on
29222 the state of the SMTP connection such as encryption and authentication) are not
29223 relevant and are forbidden in these ACLs. However, the sender and recipients
29224 are known, so the &%senders%& and &%sender_domains%& conditions and the
29225 &$sender_address$& and &$recipients$& variables can be used. Variables such as
29226 &$authenticated_sender$& are also available. You can specify added header lines
29227 in any of these ACLs.
29228
29229 The &%acl_not_smtp_start%& ACL is run right at the start of receiving a
29230 non-SMTP message, before any of the message has been read. (This is the
29231 analogue of the &%acl_smtp_predata%& ACL for SMTP input.) In the case of
29232 batched SMTP input, it runs after the DATA command has been reached. The
29233 result of this ACL is ignored; it cannot be used to reject a message. If you
29234 really need to, you could set a value in an ACL variable here and reject based
29235 on that in the &%acl_not_smtp%& ACL. However, this ACL can be used to set
29236 controls, and in particular, it can be used to set
29237 .code
29238 control = suppress_local_fixups
29239 .endd
29240 This cannot be used in the other non-SMTP ACLs because by the time they are
29241 run, it is too late.
29242
29243 The &%acl_not_smtp_mime%& ACL is available only when Exim is compiled with the
29244 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
29245
29246 The &%acl_not_smtp%& ACL is run just before the &[local_scan()]& function. Any
29247 kind of rejection is treated as permanent, because there is no way of sending a
29248 temporary error for these kinds of message.
29249
29250
29251 .section "The SMTP connect ACL" "SECID191"
29252 .cindex "SMTP" "connection, ACL for"
29253 .oindex &%smtp_banner%&
29254 The ACL test specified by &%acl_smtp_connect%& happens at the start of an SMTP
29255 session, after the test specified by &%host_reject_connection%& (which is now
29256 an anomaly) and any TCP Wrappers testing (if configured). If the connection is
29257 accepted by an &%accept%& verb that has a &%message%& modifier, the contents of
29258 the message override the banner message that is otherwise specified by the
29259 &%smtp_banner%& option.
29260
29261
29262 .section "The EHLO/HELO ACL" "SECID192"
29263 .cindex "EHLO" "ACL for"
29264 .cindex "HELO" "ACL for"
29265 The ACL test specified by &%acl_smtp_helo%& happens when the client issues an
29266 EHLO or HELO command, after the tests specified by &%helo_accept_junk_hosts%&,
29267 &%helo_allow_chars%&, &%helo_verify_hosts%&, and &%helo_try_verify_hosts%&.
29268 Note that a client may issue more than one EHLO or HELO command in an SMTP
29269 session, and indeed is required to issue a new EHLO or HELO after successfully
29270 setting up encryption following a STARTTLS command.
29271
29272 Note also that a deny neither forces the client to go away nor means that
29273 mail will be refused on the connection.  Consider checking for
29274 &$sender_helo_name$& being defined in a MAIL or RCPT ACL to do that.
29275
29276 If the command is accepted by an &%accept%& verb that has a &%message%&
29277 modifier, the message may not contain more than one line (it will be truncated
29278 at the first newline and a panic logged if it does). Such a message cannot
29279 affect the EHLO options that are listed on the second and subsequent lines of
29280 an EHLO response.
29281
29282
29283 .section "The DATA ACLs" "SECID193"
29284 .cindex "DATA" "ACLs for"
29285 Two ACLs are associated with the DATA command, because it is two-stage
29286 command, with two responses being sent to the client.
29287 When the DATA command is received, the ACL defined by &%acl_smtp_predata%&
29288 is obeyed. This gives you control after all the RCPT commands, but before
29289 the message itself is received. It offers the opportunity to give a negative
29290 response to the DATA command before the data is transmitted. Header lines
29291 added by MAIL or RCPT ACLs are not visible at this time, but any that
29292 are defined here are visible when the &%acl_smtp_data%& ACL is run.
29293
29294 You cannot test the contents of the message, for example, to verify addresses
29295 in the headers, at RCPT time or when the DATA command is received. Such
29296 tests have to appear in the ACL that is run after the message itself has been
29297 received, before the final response to the DATA command is sent. This is
29298 the ACL specified by &%acl_smtp_data%&, which is the second ACL that is
29299 associated with the DATA command.
29300
29301 .cindex CHUNKING "BDAT command"
29302 .cindex BDAT "SMTP command"
29303 .cindex "RFC 3030" CHUNKING
29304 If CHUNKING was advertised and a BDAT command sequence is received,
29305 the &%acl_smtp_predata%& ACL is not run.
29306 . XXX why not?  It should be possible, for the first BDAT.
29307 The &%acl_smtp_data%& is run after the last BDAT command and all of
29308 the data specified is received.
29309
29310 For both of these ACLs, it is not possible to reject individual recipients. An
29311 error response rejects the entire message. Unfortunately, it is known that some
29312 MTAs do not treat hard (5&'xx'&) responses to the DATA command (either
29313 before or after the data) correctly &-- they keep the message on their queues
29314 and try again later, but that is their problem, though it does waste some of
29315 your resources.
29316
29317 The &%acl_smtp_data%& ACL is run after
29318 the &%acl_smtp_data_prdr%&,
29319 the &%acl_smtp_dkim%&
29320 and the &%acl_smtp_mime%& ACLs.
29321
29322 .section "The SMTP DKIM ACL" "SECTDKIMACL"
29323 The &%acl_smtp_dkim%& ACL is available only when Exim is compiled with DKIM support
29324 enabled (which is the default).
29325
29326 The ACL test specified by &%acl_smtp_dkim%& happens after a message has been
29327 received, and is executed for each DKIM signature found in a message.  If not
29328 otherwise specified, the default action is to accept.
29329
29330 This ACL is evaluated before &%acl_smtp_mime%& and &%acl_smtp_data%&.
29331
29332 For details on the operation of DKIM, see section &<<SECDKIM>>&.
29333
29334
29335 .section "The SMTP MIME ACL" "SECID194"
29336 The &%acl_smtp_mime%& option is available only when Exim is compiled with the
29337 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
29338
29339 This ACL is evaluated after &%acl_smtp_dkim%& but before &%acl_smtp_data%&.
29340
29341
29342 .section "The SMTP PRDR ACL" "SECTPRDRACL"
29343 .cindex "PRDR" "ACL for"
29344 .oindex "&%prdr_enable%&"
29345 The &%acl_smtp_data_prdr%& ACL is available only when Exim is compiled
29346 with PRDR support enabled (which is the default).
29347 It becomes active only when the PRDR feature is negotiated between
29348 client and server for a message, and more than one recipient
29349 has been accepted.
29350
29351 The ACL test specified by &%acl_smtp_data_prdr%& happens after a message
29352 has been received, and is executed once for each recipient of the message
29353 with &$local_part$& and &$domain$& valid.
29354 The test may accept, defer or deny for individual recipients.
29355 The &%acl_smtp_data%& will still be called after this ACL and
29356 can reject the message overall, even if this ACL has accepted it
29357 for some or all recipients.
29358
29359 PRDR may be used to support per-user content filtering.  Without it
29360 one must defer any recipient after the first that has a different
29361 content-filter configuration.  With PRDR, the RCPT-time check
29362 .cindex "PRDR" "variable for"
29363 for this can be disabled when the variable &$prdr_requested$&
29364 is &"yes"&.
29365 Any required difference in behaviour of the main DATA-time
29366 ACL should however depend on the PRDR-time ACL having run, as Exim
29367 will avoid doing so in some situations (e.g. single-recipient mails).
29368
29369 See also the &%prdr_enable%& global option
29370 and the &%hosts_try_prdr%& smtp transport option.
29371
29372 This ACL is evaluated after &%acl_smtp_dkim%& but before &%acl_smtp_data%&.
29373 If the ACL is not defined, processing completes as if
29374 the feature was not requested by the client.
29375
29376 .section "The QUIT ACL" "SECTQUITACL"
29377 .cindex "QUIT, ACL for"
29378 The ACL for the SMTP QUIT command is anomalous, in that the outcome of the ACL
29379 does not affect the response code to QUIT, which is always 221. Thus, the ACL
29380 does not in fact control any access.
29381 For this reason, it may only accept
29382 or warn as its final result.
29383
29384 This ACL can be used for tasks such as custom logging at the end of an SMTP
29385 session. For example, you can use ACL variables in other ACLs to count
29386 messages, recipients, etc., and log the totals at QUIT time using one or
29387 more &%logwrite%& modifiers on a &%warn%& verb.
29388
29389 &*Warning*&: Only the &$acl_c$&&'x'& variables can be used for this, because
29390 the &$acl_m$&&'x'& variables are reset at the end of each incoming message.
29391
29392 You do not need to have a final &%accept%&, but if you do, you can use a
29393 &%message%& modifier to specify custom text that is sent as part of the 221
29394 response to QUIT.
29395
29396 This ACL is run only for a &"normal"& QUIT. For certain kinds of disastrous
29397 failure (for example, failure to open a log file, or when Exim is bombing out
29398 because it has detected an unrecoverable error), all SMTP commands from the
29399 client are given temporary error responses until QUIT is received or the
29400 connection is closed. In these special cases, the QUIT ACL does not run.
29401
29402
29403 .section "The not-QUIT ACL" "SECTNOTQUITACL"
29404 .vindex &$acl_smtp_notquit$&
29405 The not-QUIT ACL, specified by &%acl_smtp_notquit%&, is run in most cases when
29406 an SMTP session ends without sending QUIT. However, when Exim itself is in bad
29407 trouble, such as being unable to write to its log files, this ACL is not run,
29408 because it might try to do things (such as write to log files) that make the
29409 situation even worse.
29410
29411 Like the QUIT ACL, this ACL is provided to make it possible to do customized
29412 logging or to gather statistics, and its outcome is ignored. The &%delay%&
29413 modifier is forbidden in this ACL, and the only permitted verbs are &%accept%&
29414 and &%warn%&.
29415
29416 .vindex &$smtp_notquit_reason$&
29417 When the not-QUIT ACL is running, the variable &$smtp_notquit_reason$& is set
29418 to a string that indicates the reason for the termination of the SMTP
29419 connection. The possible values are:
29420 .table2
29421 .irow &`acl-drop`&                 "Another ACL issued a &%drop%& command"
29422 .irow &`bad-commands`&             "Too many unknown or non-mail commands"
29423 .irow &`command-timeout`&          "Timeout while reading SMTP commands"
29424 .irow &`connection-lost`&          "The SMTP connection has been lost"
29425 .irow &`data-timeout`&             "Timeout while reading message data"
29426 .irow &`local-scan-error`&         "The &[local_scan()]& function crashed"
29427 .irow &`local-scan-timeout`&       "The &[local_scan()]& function timed out"
29428 .irow &`signal-exit`&              "SIGTERM or SIGINT"
29429 .irow &`synchronization-error`&    "SMTP synchronization error"
29430 .irow &`tls-failed`&               "TLS failed to start"
29431 .endtable
29432 In most cases when an SMTP connection is closed without having received QUIT,
29433 Exim sends an SMTP response message before actually closing the connection.
29434 With the exception of the &`acl-drop`& case, the default message can be
29435 overridden by the &%message%& modifier in the not-QUIT ACL. In the case of a
29436 &%drop%& verb in another ACL, it is the message from the other ACL that is
29437 used.
29438
29439
29440 .section "Finding an ACL to use" "SECID195"
29441 .cindex "&ACL;" "finding which to use"
29442 The value of an &%acl_smtp_%&&'xxx'& option is expanded before use, so
29443 you can use different ACLs in different circumstances. For example,
29444 .code
29445 acl_smtp_rcpt = ${if ={25}{$interface_port} \
29446                      {acl_check_rcpt} {acl_check_rcpt_submit} }
29447 .endd
29448 In the default configuration file there are some example settings for
29449 providing an RFC 4409 message &"submission"& service on port 587 and
29450 an RFC 8314 &"submissions"& service on port 465. You can use a string
29451 expansion like this to choose an ACL for MUAs on these ports which is
29452 more appropriate for this purpose than the default ACL on port 25.
29453
29454 The expanded string does not have to be the name of an ACL in the
29455 configuration file; there are other possibilities. Having expanded the
29456 string, Exim searches for an ACL as follows:
29457
29458 .ilist
29459 If the string begins with a slash, Exim uses it as a filename, and reads its
29460 contents as an ACL. The lines are processed in the same way as lines in the
29461 Exim configuration file. In particular, continuation lines are supported, blank
29462 lines are ignored, as are lines whose first non-whitespace character is &"#"&.
29463 If the file does not exist or cannot be read, an error occurs (typically
29464 causing a temporary failure of whatever caused the ACL to be run). For example:
29465 .code
29466 acl_smtp_data = /etc/acls/\
29467   ${lookup{$sender_host_address}lsearch\
29468   {/etc/acllist}{$value}{default}}
29469 .endd
29470 This looks up an ACL file to use on the basis of the host's IP address, falling
29471 back to a default if the lookup fails. If an ACL is successfully read from a
29472 file, it is retained in memory for the duration of the Exim process, so that it
29473 can be re-used without having to re-read the file.
29474 .next
29475 If the string does not start with a slash, and does not contain any spaces,
29476 Exim searches the ACL section of the configuration for an ACL whose name
29477 matches the string.
29478 .next
29479 If no named ACL is found, or if the string contains spaces, Exim parses
29480 the string as an inline ACL. This can save typing in cases where you just
29481 want to have something like
29482 .code
29483 acl_smtp_vrfy = accept
29484 .endd
29485 in order to allow free use of the VRFY command. Such a string may contain
29486 newlines; it is processed in the same way as an ACL that is read from a file.
29487 .endlist
29488
29489
29490
29491
29492 .section "ACL return codes" "SECID196"
29493 .cindex "&ACL;" "return codes"
29494 Except for the QUIT ACL, which does not affect the SMTP return code (see
29495 section &<<SECTQUITACL>>& above), the result of running an ACL is either
29496 &"accept"& or &"deny"&, or, if some test cannot be completed (for example, if a
29497 database is down), &"defer"&. These results cause 2&'xx'&, 5&'xx'&, and 4&'xx'&
29498 return codes, respectively, to be used in the SMTP dialogue. A fourth return,
29499 &"error"&, occurs when there is an error such as invalid syntax in the ACL.
29500 This also causes a 4&'xx'& return code.
29501
29502 For the non-SMTP ACL, &"defer"& and &"error"& are treated in the same way as
29503 &"deny"&, because there is no mechanism for passing temporary errors to the
29504 submitters of non-SMTP messages.
29505
29506
29507 ACLs that are relevant to message reception may also return &"discard"&. This
29508 has the effect of &"accept"&, but causes either the entire message or an
29509 individual recipient address to be discarded. In other words, it is a
29510 blackholing facility. Use it with care.
29511
29512 If the ACL for MAIL returns &"discard"&, all recipients are discarded, and no
29513 ACL is run for subsequent RCPT commands. The effect of &"discard"& in a
29514 RCPT ACL is to discard just the one recipient address. If there are no
29515 recipients left when the message's data is received, the DATA ACL is not
29516 run. A &"discard"& return from the DATA or the non-SMTP ACL discards all the
29517 remaining recipients. The &"discard"& return is not permitted for the
29518 &%acl_smtp_predata%& ACL.
29519
29520 If the ACL for VRFY returns &"accept"&, a recipient verify (without callout)
29521 is done on the address and the result determines the SMTP response.
29522
29523
29524 .cindex "&[local_scan()]& function" "when all recipients discarded"
29525 The &[local_scan()]& function is always run, even if there are no remaining
29526 recipients; it may create new recipients.
29527
29528
29529
29530 .section "Unset ACL options" "SECID197"
29531 .cindex "&ACL;" "unset options"
29532 The default actions when any of the &%acl_%&&'xxx'& options are unset are not
29533 all the same. &*Note*&: These defaults apply only when the relevant ACL is
29534 not defined at all. For any defined ACL, the default action when control
29535 reaches the end of the ACL statements is &"deny"&.
29536
29537 For &%acl_smtp_quit%& and &%acl_not_smtp_start%& there is no default because
29538 these two are ACLs that are used only for their side effects. They cannot be
29539 used to accept or reject anything.
29540
29541 For &%acl_not_smtp%&, &%acl_smtp_auth%&, &%acl_smtp_connect%&,
29542 &%acl_smtp_data%&, &%acl_smtp_helo%&, &%acl_smtp_mail%&, &%acl_smtp_mailauth%&,
29543 &%acl_smtp_mime%&, &%acl_smtp_predata%&, and &%acl_smtp_starttls%&, the action
29544 when the ACL is not defined is &"accept"&.
29545
29546 For the others (&%acl_smtp_etrn%&, &%acl_smtp_expn%&, &%acl_smtp_rcpt%&, and
29547 &%acl_smtp_vrfy%&), the action when the ACL is not defined is &"deny"&.
29548 This means that &%acl_smtp_rcpt%& must be defined in order to receive any
29549 messages over an SMTP connection. For an example, see the ACL in the default
29550 configuration file.
29551
29552
29553
29554
29555 .section "Data for message ACLs" "SECID198"
29556 .cindex "&ACL;" "data for message ACL"
29557 .vindex &$domain$&
29558 .vindex &$local_part$&
29559 .vindex &$sender_address$&
29560 .vindex &$sender_host_address$&
29561 .vindex &$smtp_command$&
29562 When a MAIL or RCPT ACL, or either of the DATA ACLs, is running, the variables
29563 that contain information about the host and the message's sender (for example,
29564 &$sender_host_address$& and &$sender_address$&) are set, and can be used in ACL
29565 statements. In the case of RCPT (but not MAIL or DATA), &$domain$& and
29566 &$local_part$& are set from the argument address. The entire SMTP command
29567 is available in &$smtp_command$&.
29568
29569 When an ACL for the AUTH parameter of MAIL is running, the variables that
29570 contain information about the host are set, but &$sender_address$& is not yet
29571 set. Section &<<SECTauthparamail>>& contains a discussion of this parameter and
29572 how it is used.
29573
29574 .vindex "&$message_size$&"
29575 The &$message_size$& variable is set to the value of the SIZE parameter on
29576 the MAIL command at MAIL, RCPT and pre-data time, or to -1 if
29577 that parameter is not given. The value is updated to the true message size by
29578 the time the final DATA ACL is run (after the message data has been
29579 received).
29580
29581 .vindex "&$rcpt_count$&"
29582 .vindex "&$recipients_count$&"
29583 The &$rcpt_count$& variable increases by one for each RCPT command received.
29584 The &$recipients_count$& variable increases by one each time a RCPT command is
29585 accepted, so while an ACL for RCPT is being processed, it contains the number
29586 of previously accepted recipients. At DATA time (for both the DATA ACLs),
29587 &$rcpt_count$& contains the total number of RCPT commands, and
29588 &$recipients_count$& contains the total number of accepted recipients.
29589
29590
29591
29592
29593
29594 .section "Data for non-message ACLs" "SECTdatfornon"
29595 .cindex "&ACL;" "data for non-message ACL"
29596 .vindex &$smtp_command_argument$&
29597 .vindex &$smtp_command$&
29598 When an ACL is being run for AUTH, EHLO, ETRN, EXPN, HELO, STARTTLS, or VRFY,
29599 the remainder of the SMTP command line is placed in &$smtp_command_argument$&,
29600 and the entire SMTP command is available in &$smtp_command$&.
29601 These variables can be tested using a &%condition%& condition. For example,
29602 here is an ACL for use with AUTH, which insists that either the session is
29603 encrypted, or the CRAM-MD5 authentication method is used. In other words, it
29604 does not permit authentication methods that use cleartext passwords on
29605 unencrypted connections.
29606 .code
29607 acl_check_auth:
29608   accept encrypted = *
29609   accept condition = ${if eq{${uc:$smtp_command_argument}}\
29610                      {CRAM-MD5}}
29611   deny   message   = TLS encryption or CRAM-MD5 required
29612 .endd
29613 (Another way of applying this restriction is to arrange for the authenticators
29614 that use cleartext passwords not to be advertised when the connection is not
29615 encrypted. You can use the generic &%server_advertise_condition%& authenticator
29616 option to do this.)
29617
29618
29619
29620 .section "Format of an ACL" "SECID199"
29621 .cindex "&ACL;" "format of"
29622 .cindex "&ACL;" "verbs, definition of"
29623 An individual ACL consists of a number of statements. Each statement starts
29624 with a verb, optionally followed by a number of conditions and &"modifiers"&.
29625 Modifiers can change the way the verb operates, define error and log messages,
29626 set variables, insert delays, and vary the processing of accepted messages.
29627
29628 If all the conditions are met, the verb is obeyed. The same condition may be
29629 used (with different arguments) more than once in the same statement. This
29630 provides a means of specifying an &"and"& conjunction between conditions. For
29631 example:
29632 .code
29633 deny  dnslists = list1.example
29634       dnslists = list2.example
29635 .endd
29636 If there are no conditions, the verb is always obeyed. Exim stops evaluating
29637 the conditions and modifiers when it reaches a condition that fails. What
29638 happens then depends on the verb (and in one case, on a special modifier). Not
29639 all the conditions make sense at every testing point. For example, you cannot
29640 test a sender address in the ACL that is run for a VRFY command.
29641
29642
29643 .section "ACL verbs" "SECID200"
29644 The ACL verbs are as follows:
29645
29646 .ilist
29647 .cindex "&%accept%& ACL verb"
29648 &%accept%&: If all the conditions are met, the ACL returns &"accept"&. If any
29649 of the conditions are not met, what happens depends on whether &%endpass%&
29650 appears among the conditions (for syntax see below). If the failing condition
29651 is before &%endpass%&, control is passed to the next ACL statement; if it is
29652 after &%endpass%&, the ACL returns &"deny"&. Consider this statement, used to
29653 check a RCPT command:
29654 .code
29655 accept domains = +local_domains
29656        endpass
29657        verify = recipient
29658 .endd
29659 If the recipient domain does not match the &%domains%& condition, control
29660 passes to the next statement. If it does match, the recipient is verified, and
29661 the command is accepted if verification succeeds. However, if verification
29662 fails, the ACL yields &"deny"&, because the failing condition is after
29663 &%endpass%&.
29664
29665 The &%endpass%& feature has turned out to be confusing to many people, so its
29666 use is not recommended nowadays. It is always possible to rewrite an ACL so
29667 that &%endpass%& is not needed, and it is no longer used in the default
29668 configuration.
29669
29670 .cindex "&%message%& ACL modifier" "with &%accept%&"
29671 If a &%message%& modifier appears on an &%accept%& statement, its action
29672 depends on whether or not &%endpass%& is present. In the absence of &%endpass%&
29673 (when an &%accept%& verb either accepts or passes control to the next
29674 statement), &%message%& can be used to vary the message that is sent when an
29675 SMTP command is accepted. For example, in a RCPT ACL you could have:
29676 .display
29677 &`accept  `&<&'some conditions'&>
29678 &`        message = OK, I will allow you through today`&
29679 .endd
29680 You can specify an SMTP response code, optionally followed by an &"extended
29681 response code"& at the start of the message, but the first digit must be the
29682 same as would be sent by default, which is 2 for an &%accept%& verb.
29683
29684 If &%endpass%& is present in an &%accept%& statement, &%message%& specifies
29685 an error message that is used when access is denied. This behaviour is retained
29686 for backward compatibility, but current &"best practice"& is to avoid the use
29687 of &%endpass%&.
29688
29689
29690 .next
29691 .cindex "&%defer%& ACL verb"
29692 &%defer%&: If all the conditions are true, the ACL returns &"defer"& which, in
29693 an SMTP session, causes a 4&'xx'& response to be given. For a non-SMTP ACL,
29694 &%defer%& is the same as &%deny%&, because there is no way of sending a
29695 temporary error. For a RCPT command, &%defer%& is much the same as using a
29696 &(redirect)& router and &`:defer:`& while verifying, but the &%defer%& verb can
29697 be used in any ACL, and even for a recipient it might be a simpler approach.
29698
29699
29700 .next
29701 .cindex "&%deny%& ACL verb"
29702 &%deny%&: If all the conditions are met, the ACL returns &"deny"&. If any of
29703 the conditions are not met, control is passed to the next ACL statement. For
29704 example,
29705 .code
29706 deny dnslists = blackholes.mail-abuse.org
29707 .endd
29708 rejects commands from hosts that are on a DNS black list.
29709
29710
29711 .next
29712 .cindex "&%discard%& ACL verb"
29713 &%discard%&: This verb behaves like &%accept%&, except that it returns
29714 &"discard"& from the ACL instead of &"accept"&. It is permitted only on ACLs
29715 that are concerned with receiving messages. When all the conditions are true,
29716 the sending entity receives a &"success"& response. However, &%discard%& causes
29717 recipients to be discarded. If it is used in an ACL for RCPT, just the one
29718 recipient is discarded; if used for MAIL, DATA or in the non-SMTP ACL, all the
29719 message's recipients are discarded. Recipients that are discarded before DATA
29720 do not appear in the log line when the &%received_recipients%& log selector is set.
29721
29722 If the &%log_message%& modifier is set when &%discard%& operates,
29723 its contents are added to the line that is automatically written to the log.
29724 The &%message%& modifier operates exactly as it does for &%accept%&.
29725
29726
29727 .next
29728 .cindex "&%drop%& ACL verb"
29729 &%drop%&: This verb behaves like &%deny%&, except that an SMTP connection is
29730 forcibly closed after the 5&'xx'& error message has been sent. For example:
29731 .code
29732 drop   message   = I don't take more than 20 RCPTs
29733        condition = ${if > {$rcpt_count}{20}}
29734 .endd
29735 There is no difference between &%deny%& and &%drop%& for the connect-time ACL.
29736 The connection is always dropped after sending a 550 response.
29737
29738 .next
29739 .cindex "&%require%& ACL verb"
29740 &%require%&: If all the conditions are met, control is passed to the next ACL
29741 statement. If any of the conditions are not met, the ACL returns &"deny"&. For
29742 example, when checking a RCPT command,
29743 .code
29744 require message = Sender did not verify
29745         verify  = sender
29746 .endd
29747 passes control to subsequent statements only if the message's sender can be
29748 verified. Otherwise, it rejects the command. Note the positioning of the
29749 &%message%& modifier, before the &%verify%& condition. The reason for this is
29750 discussed in section &<<SECTcondmodproc>>&.
29751
29752 .next
29753 .cindex "&%warn%& ACL verb"
29754 &%warn%&: If all the conditions are true, a line specified by the
29755 &%log_message%& modifier is written to Exim's main log. Control always passes
29756 to the next ACL statement. If any condition is false, the log line is not
29757 written. If an identical log line is requested several times in the same
29758 message, only one copy is actually written to the log. If you want to force
29759 duplicates to be written, use the &%logwrite%& modifier instead.
29760
29761 If &%log_message%& is not present, a &%warn%& verb just checks its conditions
29762 and obeys any &"immediate"& modifiers (such as &%control%&, &%set%&,
29763 &%logwrite%&, &%add_header%&, and &%remove_header%&) that appear before the
29764 first failing condition. There is more about adding header lines in section
29765 &<<SECTaddheadacl>>&.
29766
29767 If any condition on a &%warn%& statement cannot be completed (that is, there is
29768 some sort of defer), the log line specified by &%log_message%& is not written.
29769 This does not include the case of a forced failure from a lookup, which
29770 is considered to be a successful completion. After a defer, no further
29771 conditions or modifiers in the &%warn%& statement are processed. The incident
29772 is logged, and the ACL continues to be processed, from the next statement
29773 onwards.
29774
29775
29776 .vindex "&$acl_verify_message$&"
29777 When one of the &%warn%& conditions is an address verification that fails, the
29778 text of the verification failure message is in &$acl_verify_message$&. If you
29779 want this logged, you must set it up explicitly. For example:
29780 .code
29781 warn   !verify = sender
29782        log_message = sender verify failed: $acl_verify_message
29783 .endd
29784 .endlist
29785
29786 At the end of each ACL there is an implicit unconditional &%deny%&.
29787
29788 As you can see from the examples above, the conditions and modifiers are
29789 written one to a line, with the first one on the same line as the verb, and
29790 subsequent ones on following lines. If you have a very long condition, you can
29791 continue it onto several physical lines by the usual backslash continuation
29792 mechanism. It is conventional to align the conditions vertically.
29793
29794
29795
29796 .section "ACL variables" "SECTaclvariables"
29797 .cindex "&ACL;" "variables"
29798 There are some special variables that can be set during ACL processing. They
29799 can be used to pass information between different ACLs, different invocations
29800 of the same ACL in the same SMTP connection, and between ACLs and the routers,
29801 transports, and filters that are used to deliver a message. The names of these
29802 variables must begin with &$acl_c$& or &$acl_m$&, followed either by a digit or
29803 an underscore, but the remainder of the name can be any sequence of
29804 alphanumeric characters and underscores that you choose. There is no limit on
29805 the number of ACL variables. The two sets act as follows:
29806 .ilist
29807 The values of those variables whose names begin with &$acl_c$& persist
29808 throughout an SMTP connection. They are never reset. Thus, a value that is set
29809 while receiving one message is still available when receiving the next message
29810 on the same SMTP connection.
29811 .next
29812 The values of those variables whose names begin with &$acl_m$& persist only
29813 while a message is being received. They are reset afterwards. They are also
29814 reset by MAIL, RSET, EHLO, HELO, and after starting up a TLS session.
29815 .endlist
29816
29817 When a message is accepted, the current values of all the ACL variables are
29818 preserved with the message and are subsequently made available at delivery
29819 time. The ACL variables are set by a modifier called &%set%&. For example:
29820 .code
29821 accept hosts = whatever
29822        set acl_m4 = some value
29823 accept authenticated = *
29824        set acl_c_auth = yes
29825 .endd
29826 &*Note*&: A leading dollar sign is not used when naming a variable that is to
29827 be set. If you want to set a variable without taking any action, you can use a
29828 &%warn%& verb without any other modifiers or conditions.
29829
29830 .oindex &%strict_acl_vars%&
29831 What happens if a syntactically valid but undefined ACL variable is
29832 referenced depends on the setting of the &%strict_acl_vars%& option. If it is
29833 false (the default), an empty string is substituted; if it is true, an
29834 error is generated.
29835
29836 Versions of Exim before 4.64 have a limited set of numbered variables, but
29837 their names are compatible, so there is no problem with upgrading.
29838
29839
29840 .section "Condition and modifier processing" "SECTcondmodproc"
29841 .cindex "&ACL;" "conditions; processing"
29842 .cindex "&ACL;" "modifiers; processing"
29843 An exclamation mark preceding a condition negates its result. For example:
29844 .code
29845 deny   domains = *.dom.example
29846       !verify  = recipient
29847 .endd
29848 causes the ACL to return &"deny"& if the recipient domain ends in
29849 &'dom.example'& and the recipient address cannot be verified. Sometimes
29850 negation can be used on the right-hand side of a condition. For example, these
29851 two statements are equivalent:
29852 .code
29853 deny  hosts = !192.168.3.4
29854 deny !hosts =  192.168.3.4
29855 .endd
29856 However, for many conditions (&%verify%& being a good example), only left-hand
29857 side negation of the whole condition is possible.
29858
29859 The arguments of conditions and modifiers are expanded. A forced failure
29860 of an expansion causes a condition to be ignored, that is, it behaves as if the
29861 condition is true. Consider these two statements:
29862 .code
29863 accept  senders = ${lookup{$host_name}lsearch\
29864                   {/some/file}{$value}fail}
29865 accept  senders = ${lookup{$host_name}lsearch\
29866                   {/some/file}{$value}{}}
29867 .endd
29868 Each attempts to look up a list of acceptable senders. If the lookup succeeds,
29869 the returned list is searched, but if the lookup fails the behaviour is
29870 different in the two cases. The &%fail%& in the first statement causes the
29871 condition to be ignored, leaving no further conditions. The &%accept%& verb
29872 therefore succeeds. The second statement, however, generates an empty list when
29873 the lookup fails. No sender can match an empty list, so the condition fails,
29874 and therefore the &%accept%& also fails.
29875
29876 ACL modifiers appear mixed in with conditions in ACL statements. Some of them
29877 specify actions that are taken as the conditions for a statement are checked;
29878 others specify text for messages that are used when access is denied or a
29879 warning is generated. The &%control%& modifier affects the way an incoming
29880 message is handled.
29881
29882 The positioning of the modifiers in an ACL statement is important, because the
29883 processing of a verb ceases as soon as its outcome is known. Only those
29884 modifiers that have already been encountered will take effect. For example,
29885 consider this use of the &%message%& modifier:
29886 .code
29887 require message = Can't verify sender
29888         verify  = sender
29889         message = Can't verify recipient
29890         verify  = recipient
29891         message = This message cannot be used
29892 .endd
29893 If sender verification fails, Exim knows that the result of the statement is
29894 &"deny"&, so it goes no further. The first &%message%& modifier has been seen,
29895 so its text is used as the error message. If sender verification succeeds, but
29896 recipient verification fails, the second message is used. If recipient
29897 verification succeeds, the third message becomes &"current"&, but is never used
29898 because there are no more conditions to cause failure.
29899
29900 For the &%deny%& verb, on the other hand, it is always the last &%message%&
29901 modifier that is used, because all the conditions must be true for rejection to
29902 happen. Specifying more than one &%message%& modifier does not make sense, and
29903 the message can even be specified after all the conditions. For example:
29904 .code
29905 deny   hosts = ...
29906       !senders = *@my.domain.example
29907        message = Invalid sender from client host
29908 .endd
29909 The &"deny"& result does not happen until the end of the statement is reached,
29910 by which time Exim has set up the message.
29911
29912
29913
29914 .section "ACL modifiers" "SECTACLmodi"
29915 .cindex "&ACL;" "modifiers; list of"
29916 The ACL modifiers are as follows:
29917
29918 .vlist
29919 .vitem &*add_header*&&~=&~<&'text'&>
29920 This modifier specifies one or more header lines that are to be added to an
29921 incoming message, assuming, of course, that the message is ultimately
29922 accepted. For details, see section &<<SECTaddheadacl>>&.
29923
29924 .vitem &*continue*&&~=&~<&'text'&>
29925 .cindex "&%continue%& ACL modifier"
29926 .cindex "database" "updating in ACL"
29927 This modifier does nothing of itself, and processing of the ACL always
29928 continues with the next condition or modifier. The value of &%continue%& is in
29929 the side effects of expanding its argument. Typically this could be used to
29930 update a database. It is really just a syntactic tidiness, to avoid having to
29931 write rather ugly lines like this:
29932 .display
29933 &`condition = ${if eq{0}{`&<&'some expansion'&>&`}{true}{true}}`&
29934 .endd
29935 Instead, all you need is
29936 .display
29937 &`continue = `&<&'some expansion'&>
29938 .endd
29939
29940 .vitem &*control*&&~=&~<&'text'&>
29941 .cindex "&%control%& ACL modifier"
29942 This modifier affects the subsequent processing of the SMTP connection or of an
29943 incoming message that is accepted. The effect of the first type of control
29944 lasts for the duration of the connection, whereas the effect of the second type
29945 lasts only until the current message has been received. The message-specific
29946 controls always apply to the whole message, not to individual recipients,
29947 even if the &%control%& modifier appears in a RCPT ACL.
29948
29949 As there are now quite a few controls that can be applied, they are described
29950 separately in section &<<SECTcontrols>>&. The &%control%& modifier can be used
29951 in several different ways. For example:
29952
29953 . ==== As this is a nested list, any displays it contains must be indented
29954 . ==== as otherwise they are too far to the left. That comment applies only
29955 . ==== when xmlto and fop are used; formatting with sdop gets it right either
29956 . ==== way.
29957
29958 .ilist
29959 It can be at the end of an &%accept%& statement:
29960 .code
29961     accept  ...some conditions
29962             control = queue_only
29963 .endd
29964 In this case, the control is applied when this statement yields &"accept"&, in
29965 other words, when the conditions are all true.
29966
29967 .next
29968 It can be in the middle of an &%accept%& statement:
29969 .code
29970     accept  ...some conditions...
29971             control = queue_only
29972             ...some more conditions...
29973 .endd
29974 If the first set of conditions are true, the control is applied, even if the
29975 statement does not accept because one of the second set of conditions is false.
29976 In this case, some subsequent statement must yield &"accept"& for the control
29977 to be relevant.
29978
29979 .next
29980 It can be used with &%warn%& to apply the control, leaving the
29981 decision about accepting or denying to a subsequent verb. For
29982 example:
29983 .code
29984     warn    ...some conditions...
29985             control = freeze
29986     accept  ...
29987 .endd
29988 This example of &%warn%& does not contain &%message%&, &%log_message%&, or
29989 &%logwrite%&, so it does not add anything to the message and does not write a
29990 log entry.
29991
29992 .next
29993 If you want to apply a control unconditionally, you can use it with a
29994 &%require%& verb. For example:
29995 .code
29996     require  control = no_multiline_responses
29997 .endd
29998 .endlist
29999
30000 .vitem &*delay*&&~=&~<&'time'&>
30001 .cindex "&%delay%& ACL modifier"
30002 .oindex "&%-bh%&"
30003 This modifier may appear in any ACL except notquit. It causes Exim to wait for
30004 the time interval before proceeding. However, when testing Exim using the
30005 &%-bh%& option, the delay is not actually imposed (an appropriate message is
30006 output instead). The time is given in the usual Exim notation, and the delay
30007 happens as soon as the modifier is processed. In an SMTP session, pending
30008 output is flushed before the delay is imposed.
30009
30010 Like &%control%&, &%delay%& can be used with &%accept%& or &%deny%&, for
30011 example:
30012 .code
30013 deny    ...some conditions...
30014         delay = 30s
30015 .endd
30016 The delay happens if all the conditions are true, before the statement returns
30017 &"deny"&. Compare this with:
30018 .code
30019 deny    delay = 30s
30020         ...some conditions...
30021 .endd
30022 which waits for 30s before processing the conditions. The &%delay%& modifier
30023 can also be used with &%warn%& and together with &%control%&:
30024 .code
30025 warn    ...some conditions...
30026         delay = 2m
30027         control = freeze
30028 accept  ...
30029 .endd
30030
30031 If &%delay%& is encountered when the SMTP PIPELINING extension is in use,
30032 responses to several commands are no longer buffered and sent in one packet (as
30033 they would normally be) because all output is flushed before imposing the
30034 delay. This optimization is disabled so that a number of small delays do not
30035 appear to the client as one large aggregated delay that might provoke an
30036 unwanted timeout. You can, however, disable output flushing for &%delay%& by
30037 using a &%control%& modifier to set &%no_delay_flush%&.
30038
30039
30040 .vitem &*endpass*&
30041 .cindex "&%endpass%& ACL modifier"
30042 This modifier, which has no argument, is recognized only in &%accept%& and
30043 &%discard%& statements. It marks the boundary between the conditions whose
30044 failure causes control to pass to the next statement, and the conditions whose
30045 failure causes the ACL to return &"deny"&. This concept has proved to be
30046 confusing to some people, so the use of &%endpass%& is no longer recommended as
30047 &"best practice"&. See the description of &%accept%& above for more details.
30048
30049
30050 .vitem &*log_message*&&~=&~<&'text'&>
30051 .cindex "&%log_message%& ACL modifier"
30052 This modifier sets up a message that is used as part of the log message if the
30053 ACL denies access or a &%warn%& statement's conditions are true. For example:
30054 .code
30055 require log_message = wrong cipher suite $tls_in_cipher
30056         encrypted   = DES-CBC3-SHA
30057 .endd
30058 &%log_message%& is also used when recipients are discarded by &%discard%&. For
30059 example:
30060 .display
30061 &`discard `&<&'some conditions'&>
30062 &`        log_message = Discarded $local_part@$domain because...`&
30063 .endd
30064 When access is denied, &%log_message%& adds to any underlying error message
30065 that may exist because of a condition failure. For example, while verifying a
30066 recipient address, a &':fail:'& redirection might have already set up a
30067 message.
30068
30069 The message may be defined before the conditions to which it applies, because
30070 the string expansion does not happen until Exim decides that access is to be
30071 denied. This means that any variables that are set by the condition are
30072 available for inclusion in the message. For example, the &$dnslist_$&<&'xxx'&>
30073 variables are set after a DNS black list lookup succeeds. If the expansion of
30074 &%log_message%& fails, or if the result is an empty string, the modifier is
30075 ignored.
30076
30077 .vindex "&$acl_verify_message$&"
30078 If you want to use a &%warn%& statement to log the result of an address
30079 verification, you can use &$acl_verify_message$& to include the verification
30080 error message.
30081
30082 If &%log_message%& is used with a &%warn%& statement, &"Warning:"& is added to
30083 the start of the logged message. If the same warning log message is requested
30084 more than once while receiving  a single email message, only one copy is
30085 actually logged. If you want to log multiple copies, use &%logwrite%& instead
30086 of &%log_message%&. In the absence of &%log_message%& and &%logwrite%&, nothing
30087 is logged for a successful &%warn%& statement.
30088
30089 If &%log_message%& is not present and there is no underlying error message (for
30090 example, from the failure of address verification), but &%message%& is present,
30091 the &%message%& text is used for logging rejections. However, if any text for
30092 logging contains newlines, only the first line is logged. In the absence of
30093 both &%log_message%& and &%message%&, a default built-in message is used for
30094 logging rejections.
30095
30096
30097 .vitem "&*log_reject_target*&&~=&~<&'log name list'&>"
30098 .cindex "&%log_reject_target%& ACL modifier"
30099 .cindex "logging in ACL" "specifying which log"
30100 This modifier makes it possible to specify which logs are used for messages
30101 about ACL rejections. Its argument is a colon-separated list of words that can
30102 be &"main"&, &"reject"&, or &"panic"&. The default is &`main:reject`&. The list
30103 may be empty, in which case a rejection is not logged at all. For example, this
30104 ACL fragment writes no logging information when access is denied:
30105 .display
30106 &`deny `&<&'some conditions'&>
30107 &`     log_reject_target =`&
30108 .endd
30109 This modifier can be used in SMTP and non-SMTP ACLs. It applies to both
30110 permanent and temporary rejections. Its effect lasts for the rest of the
30111 current ACL.
30112
30113
30114 .vitem &*logwrite*&&~=&~<&'text'&>
30115 .cindex "&%logwrite%& ACL modifier"
30116 .cindex "logging in ACL" "immediate"
30117 This modifier writes a message to a log file as soon as it is encountered when
30118 processing an ACL. (Compare &%log_message%&, which, except in the case of
30119 &%warn%& and &%discard%&, is used only if the ACL statement denies
30120 access.) The &%logwrite%& modifier can be used to log special incidents in
30121 ACLs. For example:
30122 .display
30123 &`accept `&<&'some special conditions'&>
30124 &`       control  = freeze`&
30125 &`       logwrite = froze message because ...`&
30126 .endd
30127 By default, the message is written to the main log. However, it may begin
30128 with a colon, followed by a comma-separated list of log names, and then
30129 another colon, to specify exactly which logs are to be written. For
30130 example:
30131 .code
30132 logwrite = :main,reject: text for main and reject logs
30133 logwrite = :panic: text for panic log only
30134 .endd
30135
30136
30137 .vitem &*message*&&~=&~<&'text'&>
30138 .cindex "&%message%& ACL modifier"
30139 This modifier sets up a text string that is expanded and used as a response
30140 message when an ACL statement terminates the ACL with an &"accept"&, &"deny"&,
30141 or &"defer"& response. (In the case of the &%accept%& and &%discard%& verbs,
30142 there is some complication if &%endpass%& is involved; see the description of
30143 &%accept%& for details.)
30144
30145 The expansion of the message happens at the time Exim decides that the ACL is
30146 to end, not at the time it processes &%message%&. If the expansion fails, or
30147 generates an empty string, the modifier is ignored. Here is an example where
30148 &%message%& must be specified first, because the ACL ends with a rejection if
30149 the &%hosts%& condition fails:
30150 .code
30151 require  message = Host not recognized
30152          hosts = 10.0.0.0/8
30153 .endd
30154 (Once a condition has failed, no further conditions or modifiers are
30155 processed.)
30156
30157 .cindex "SMTP" "error codes"
30158 .oindex "&%smtp_banner%&
30159 For ACLs that are triggered by SMTP commands, the message is returned as part
30160 of the SMTP response. The use of &%message%& with &%accept%& (or &%discard%&)
30161 is meaningful only for SMTP, as no message is returned when a non-SMTP message
30162 is accepted. In the case of the connect ACL, accepting with a message modifier
30163 overrides the value of &%smtp_banner%&. For the EHLO/HELO ACL, a customized
30164 accept message may not contain more than one line (otherwise it will be
30165 truncated at the first newline and a panic logged), and it cannot affect the
30166 EHLO options.
30167
30168 When SMTP is involved, the message may begin with an overriding response code,
30169 consisting of three digits optionally followed by an &"extended response code"&
30170 of the form &'n.n.n'&, each code being followed by a space. For example:
30171 .code
30172 deny  message = 599 1.2.3 Host not welcome
30173       hosts = 192.168.34.0/24
30174 .endd
30175 The first digit of the supplied response code must be the same as would be sent
30176 by default. A panic occurs if it is not. Exim uses a 550 code when it denies
30177 access, but for the predata ACL, note that the default success code is 354, not
30178 2&'xx'&.
30179
30180 Notwithstanding the previous paragraph, for the QUIT ACL, unlike the others,
30181 the message modifier cannot override the 221 response code.
30182
30183 The text in a &%message%& modifier is literal; any quotes are taken as
30184 literals, but because the string is expanded, backslash escapes are processed
30185 anyway. If the message contains newlines, this gives rise to a multi-line SMTP
30186 response.
30187
30188 .vindex "&$acl_verify_message$&"
30189 For ACLs that are called by an &%acl =%& ACL condition, the message is
30190 stored in &$acl_verify_message$&, from which the calling ACL may use it.
30191
30192 If &%message%& is used on a statement that verifies an address, the message
30193 specified overrides any message that is generated by the verification process.
30194 However, the original message is available in the variable
30195 &$acl_verify_message$&, so you can incorporate it into your message if you
30196 wish. In particular, if you want the text from &%:fail:%& items in &(redirect)&
30197 routers to be passed back as part of the SMTP response, you should either not
30198 use a &%message%& modifier, or make use of &$acl_verify_message$&.
30199
30200 For compatibility with previous releases of Exim, a &%message%& modifier that
30201 is used with a &%warn%& verb behaves in a similar way to the &%add_header%&
30202 modifier, but this usage is now deprecated. However, &%message%& acts only when
30203 all the conditions are true, wherever it appears in an ACL command, whereas
30204 &%add_header%& acts as soon as it is encountered. If &%message%& is used with
30205 &%warn%& in an ACL that is not concerned with receiving a message, it has no
30206 effect.
30207
30208
30209 .vitem &*queue*&&~=&~<&'text'&>
30210 .cindex "&%queue%& ACL modifier"
30211 .cindex "named queues" "selecting in ACL"
30212 This modifier specifies the use of a named queue for spool files
30213 for the message.
30214 It can only be used before the message is received (i.e. not in
30215 the DATA ACL).
30216 This could be used, for example, for known high-volume burst sources
30217 of traffic, or for quarantine of messages.
30218 Separate queue-runner processes will be needed for named queues.
30219 If the text after expansion is empty, the default queue is used.
30220
30221
30222 .vitem &*remove_header*&&~=&~<&'text'&>
30223 This modifier specifies one or more header names in a colon-separated list
30224  that are to be removed from an incoming message, assuming, of course, that
30225 the message is ultimately accepted. For details, see section &<<SECTremoveheadacl>>&.
30226
30227
30228 .vitem &*set*&&~<&'acl_name'&>&~=&~<&'value'&>
30229 .cindex "&%set%& ACL modifier"
30230 This modifier puts a value into one of the ACL variables (see section
30231 &<<SECTaclvariables>>&).
30232
30233
30234 .vitem &*udpsend*&&~=&~<&'parameters'&>
30235 .cindex "UDP communications"
30236 This modifier sends a UDP packet, for purposes such as statistics
30237 collection or behaviour monitoring. The parameters are expanded, and
30238 the result of the expansion must be a colon-separated list consisting
30239 of a destination server, port number, and the packet contents. The
30240 server can be specified as a host name or IPv4 or IPv6 address. The
30241 separator can be changed with the usual angle bracket syntax. For
30242 example, you might want to collect information on which hosts connect
30243 when:
30244 .code
30245 udpsend = <; 2001:dB8::dead:beef ; 1234 ;\
30246              $tod_zulu $sender_host_address
30247 .endd
30248 .endlist
30249
30250
30251
30252
30253 .section "Use of the control modifier" "SECTcontrols"
30254 .cindex "&%control%& ACL modifier"
30255 The &%control%& modifier supports the following settings:
30256
30257 .vlist
30258 .vitem &*control&~=&~allow_auth_unadvertised*&
30259 This modifier allows a client host to use the SMTP AUTH command even when it
30260 has not been advertised in response to EHLO. Furthermore, because there are
30261 apparently some really broken clients that do this, Exim will accept AUTH after
30262 HELO (rather than EHLO) when this control is set. It should be used only if you
30263 really need it, and you should limit its use to those broken clients that do
30264 not work without it. For example:
30265 .code
30266 warn hosts   = 192.168.34.25
30267      control = allow_auth_unadvertised
30268 .endd
30269 Normally, when an Exim server receives an AUTH command, it checks the name of
30270 the authentication mechanism that is given in the command to ensure that it
30271 matches an advertised mechanism. When this control is set, the check that a
30272 mechanism has been advertised is bypassed. Any configured mechanism can be used
30273 by the client. This control is permitted only in the connection and HELO ACLs.
30274
30275
30276 .vitem &*control&~=&~caseful_local_part*& &&&
30277        &*control&~=&~caselower_local_part*&
30278 .cindex "&ACL;" "case of local part in"
30279 .cindex "case of local parts"
30280 .vindex "&$local_part$&"
30281 These two controls are permitted only in the ACL specified by &%acl_smtp_rcpt%&
30282 (that is, during RCPT processing). By default, the contents of &$local_part$&
30283 are lower cased before ACL processing. If &"caseful_local_part"& is specified,
30284 any uppercase letters in the original local part are restored in &$local_part$&
30285 for the rest of the ACL, or until a control that sets &"caselower_local_part"&
30286 is encountered.
30287
30288 These controls affect only the current recipient. Moreover, they apply only to
30289 local part handling that takes place directly in the ACL (for example, as a key
30290 in lookups). If a test to verify the recipient is obeyed, the case-related
30291 handling of the local part during the verification is controlled by the router
30292 configuration (see the &%caseful_local_part%& generic router option).
30293
30294 This facility could be used, for example, to add a spam score to local parts
30295 containing upper case letters. For example, using &$acl_m4$& to accumulate the
30296 spam score:
30297 .code
30298 warn  control = caseful_local_part
30299       set acl_m4 = ${eval:\
30300                      $acl_m4 + \
30301                      ${if match{$local_part}{[A-Z]}{1}{0}}\
30302                     }
30303       control = caselower_local_part
30304 .endd
30305 Notice that we put back the lower cased version afterwards, assuming that
30306 is what is wanted for subsequent tests.
30307
30308
30309 .vitem &*control&~=&~cutthrough_delivery/*&<&'options'&>
30310 .cindex "&ACL;" "cutthrough routing"
30311 .cindex "cutthrough" "requesting"
30312 This option requests delivery be attempted while the item is being received.
30313
30314 The option is usable in the RCPT ACL.
30315 If enabled for a message received via smtp and routed to an smtp transport,
30316 and only one transport, interface, destination host and port combination
30317 is used for all recipients of the message,
30318 then the delivery connection is made while the receiving connection is open
30319 and data is copied from one to the other.
30320
30321 An attempt to set this option for any recipient but the first
30322 for a mail will be quietly ignored.
30323 If a recipient-verify callout
30324 (with use_sender)
30325 connection is subsequently
30326 requested in the same ACL it is held open and used for
30327 any subsequent recipients and the data,
30328 otherwise one is made after the initial RCPT ACL completes.
30329
30330 Note that routers are used in verify mode,
30331 and cannot depend on content of received headers.
30332 Note also that headers cannot be
30333 modified by any of the post-data ACLs (DATA, MIME and DKIM).
30334 Headers may be modified by routers (subject to the above) and transports.
30335 The &'Received-By:'& header is generated as soon as the body reception starts,
30336 rather than the traditional time after the full message is received;
30337 this will affect the timestamp.
30338
30339 All the usual ACLs are called; if one results in the message being
30340 rejected, all effort spent in delivery (including the costs on
30341 the ultimate destination) will be wasted.
30342 Note that in the case of data-time ACLs this includes the entire
30343 message body.
30344
30345 Cutthrough delivery is not supported via transport-filters or when DKIM signing
30346 of outgoing messages is done, because it sends data to the ultimate destination
30347 before the entire message has been received from the source.
30348 It is not supported for messages received with the SMTP PRDR
30349 or CHUNKING
30350 options in use.
30351
30352 Should the ultimate destination system positively accept or reject the mail,
30353 a corresponding indication is given to the source system and nothing is queued.
30354 If the item is successfully delivered in cutthrough mode
30355 the delivery log lines are tagged with ">>" rather than "=>" and appear
30356 before the acceptance "<=" line.
30357
30358 If there is a temporary error the item is queued for later delivery in the
30359 usual fashion.
30360 This behaviour can be adjusted by appending the option &*defer=*&<&'value'&>
30361 to the control; the default value is &"spool"& and the alternate value
30362 &"pass"& copies an SMTP defer response from the target back to the initiator
30363 and does not queue the message.
30364 Note that this is independent of any recipient verify conditions in the ACL.
30365
30366 Delivery in this mode avoids the generation of a bounce mail to a
30367 (possibly faked)
30368 sender when the destination system is doing content-scan based rejection.
30369
30370
30371 .vitem &*control&~=&~debug/*&<&'options'&>
30372 .cindex "&ACL;" "enabling debug logging"
30373 .cindex "debugging" "enabling from an ACL"
30374 This control turns on debug logging, almost as though Exim had been invoked
30375 with &`-d`&, with the output going to a new logfile in the usual logs directory,
30376 by default called &'debuglog'&.
30377 The filename can be adjusted with the &'tag'& option, which
30378 may access any variables already defined.  The logging may be adjusted with
30379 the &'opts'& option, which takes the same values as the &`-d`& command-line
30380 option.
30381 Logging started this way may be stopped, and the file removed,
30382 with the &'kill'& option.
30383 Some examples (which depend on variables that don't exist in all
30384 contexts):
30385 .code
30386       control = debug
30387       control = debug/tag=.$sender_host_address
30388       control = debug/opts=+expand+acl
30389       control = debug/tag=.$message_exim_id/opts=+expand
30390       control = debug/kill
30391 .endd
30392
30393
30394 .vitem &*control&~=&~dkim_disable_verify*&
30395 .cindex "disable DKIM verify"
30396 .cindex "DKIM" "disable verify"
30397 This control turns off DKIM verification processing entirely.  For details on
30398 the operation and configuration of DKIM, see section &<<SECDKIM>>&.
30399
30400
30401 .vitem &*control&~=&~dscp/*&<&'value'&>
30402 .cindex "&ACL;" "setting DSCP value"
30403 .cindex "DSCP" "inbound"
30404 This option causes the DSCP value associated with the socket for the inbound
30405 connection to be adjusted to a given value, given as one of a number of fixed
30406 strings or to numeric value.
30407 The &%-bI:dscp%& option may be used to ask Exim which names it knows of.
30408 Common values include &`throughput`&, &`mincost`&, and on newer systems
30409 &`ef`&, &`af41`&, etc.  Numeric values may be in the range 0 to 0x3F.
30410
30411 The outbound packets from Exim will be marked with this value in the header
30412 (for IPv4, the TOS field; for IPv6, the TCLASS field); there is no guarantee
30413 that these values will have any effect, not be stripped by networking
30414 equipment, or do much of anything without cooperation with your Network
30415 Engineer and those of all network operators between the source and destination.
30416
30417
30418 .vitem &*control&~=&~enforce_sync*& &&&
30419        &*control&~=&~no_enforce_sync*&
30420 .cindex "SMTP" "synchronization checking"
30421 .cindex "synchronization checking in SMTP"
30422 These controls make it possible to be selective about when SMTP synchronization
30423 is enforced. The global option &%smtp_enforce_sync%& specifies the initial
30424 state of the switch (it is true by default). See the description of this option
30425 in chapter &<<CHAPmainconfig>>& for details of SMTP synchronization checking.
30426
30427 The effect of these two controls lasts for the remainder of the SMTP
30428 connection. They can appear in any ACL except the one for the non-SMTP
30429 messages. The most straightforward place to put them is in the ACL defined by
30430 &%acl_smtp_connect%&, which is run at the start of an incoming SMTP connection,
30431 before the first synchronization check. The expected use is to turn off the
30432 synchronization checks for badly-behaved hosts that you nevertheless need to
30433 work with.
30434
30435
30436 .vitem &*control&~=&~fakedefer/*&<&'message'&>
30437 .cindex "fake defer"
30438 .cindex "defer, fake"
30439 This control works in exactly the same way as &%fakereject%& (described below)
30440 except that it causes an SMTP 450 response after the message data instead of a
30441 550 response. You must take care when using &%fakedefer%& because it causes the
30442 messages to be duplicated when the sender retries. Therefore, you should not
30443 use &%fakedefer%& if the message is to be delivered normally.
30444
30445 .vitem &*control&~=&~fakereject/*&<&'message'&>
30446 .cindex "fake rejection"
30447 .cindex "rejection, fake"
30448 This control is permitted only for the MAIL, RCPT, and DATA ACLs, in other
30449 words, only when an SMTP message is being received. If Exim accepts the
30450 message, instead the final 250 response, a 550 rejection message is sent.
30451 However, Exim proceeds to deliver the message as normal. The control applies
30452 only to the current message, not to any subsequent ones that may be received in
30453 the same SMTP connection.
30454
30455 The text for the 550 response is taken from the &%control%& modifier. If no
30456 message is supplied, the following is used:
30457 .code
30458 550-Your message has been rejected but is being
30459 550-kept for evaluation.
30460 550-If it was a legitimate message, it may still be
30461 550 delivered to the target recipient(s).
30462 .endd
30463 This facility should be used with extreme caution.
30464
30465 .vitem &*control&~=&~freeze*&
30466 .cindex "frozen messages" "forcing in ACL"
30467 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
30468 other words, only when a message is being received. If the message is accepted,
30469 it is placed on Exim's queue and frozen. The control applies only to the
30470 current message, not to any subsequent ones that may be received in the same
30471 SMTP connection.
30472
30473 This modifier can optionally be followed by &`/no_tell`&. If the global option
30474 &%freeze_tell%& is set, it is ignored for the current message (that is, nobody
30475 is told about the freezing), provided all the &*control=freeze*& modifiers that
30476 are obeyed for the current message have the &`/no_tell`& option.
30477
30478 .vitem &*control&~=&~no_delay_flush*&
30479 .cindex "SMTP" "output flushing, disabling for delay"
30480 Exim normally flushes SMTP output before implementing a delay in an ACL, to
30481 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
30482 use. This control, as long as it is encountered before the &%delay%& modifier,
30483 disables such output flushing.
30484
30485 .vitem &*control&~=&~no_callout_flush*&
30486 .cindex "SMTP" "output flushing, disabling for callout"
30487 Exim normally flushes SMTP output before performing a callout in an ACL, to
30488 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
30489 use. This control, as long as it is encountered before the &%verify%& condition
30490 that causes the callout, disables such output flushing.
30491
30492 .vitem &*control&~=&~no_mbox_unspool*&
30493 This control is available when Exim is compiled with the content scanning
30494 extension. Content scanning may require a copy of the current message, or parts
30495 of it, to be written in &"mbox format"& to a spool file, for passing to a virus
30496 or spam scanner. Normally, such copies are deleted when they are no longer
30497 needed. If this control is set, the copies are not deleted. The control applies
30498 only to the current message, not to any subsequent ones that may be received in
30499 the same SMTP connection. It is provided for debugging purposes and is unlikely
30500 to be useful in production.
30501
30502 .vitem &*control&~=&~no_multiline_responses*&
30503 .cindex "multiline responses, suppressing"
30504 This control is permitted for any ACL except the one for non-SMTP messages.
30505 It seems that there are broken clients in use that cannot handle multiline
30506 SMTP responses, despite the fact that RFC 821 defined them over 20 years ago.
30507
30508 If this control is set, multiline SMTP responses from ACL rejections are
30509 suppressed. One way of doing this would have been to put out these responses as
30510 one long line. However, RFC 2821 specifies a maximum of 512 bytes per response
30511 (&"use multiline responses for more"& it says &-- ha!), and some of the
30512 responses might get close to that. So this facility, which is after all only a
30513 sop to broken clients, is implemented by doing two very easy things:
30514
30515 .ilist
30516 Extra information that is normally output as part of a rejection caused by
30517 sender verification failure is omitted. Only the final line (typically &"sender
30518 verification failed"&) is sent.
30519 .next
30520 If a &%message%& modifier supplies a multiline response, only the first
30521 line is output.
30522 .endlist
30523
30524 The setting of the switch can, of course, be made conditional on the
30525 calling host. Its effect lasts until the end of the SMTP connection.
30526
30527 .vitem &*control&~=&~no_pipelining*&
30528 .cindex "PIPELINING" "suppressing advertising"
30529 This control turns off the advertising of the PIPELINING extension to SMTP in
30530 the current session. To be useful, it must be obeyed before Exim sends its
30531 response to an EHLO command. Therefore, it should normally appear in an ACL
30532 controlled by &%acl_smtp_connect%& or &%acl_smtp_helo%&. See also
30533 &%pipelining_advertise_hosts%&.
30534
30535 .vitem &*control&~=&~queue_only*&
30536 .oindex "&%queue_only%&"
30537 .cindex "queueing incoming messages"
30538 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
30539 other words, only when a message is being received. If the message is accepted,
30540 it is placed on Exim's queue and left there for delivery by a subsequent queue
30541 runner. No immediate delivery process is started. In other words, it has the
30542 effect as the &%queue_only%& global option. However, the control applies only
30543 to the current message, not to any subsequent ones that may be received in the
30544 same SMTP connection.
30545
30546 .vitem &*control&~=&~submission/*&<&'options'&>
30547 .cindex "message" "submission"
30548 .cindex "submission mode"
30549 This control is permitted only for the MAIL, RCPT, and start of data ACLs (the
30550 latter is the one defined by &%acl_smtp_predata%&). Setting it tells Exim that
30551 the current message is a submission from a local MUA. In this case, Exim
30552 operates in &"submission mode"&, and applies certain fixups to the message if
30553 necessary. For example, it adds a &'Date:'& header line if one is not present.
30554 This control is not permitted in the &%acl_smtp_data%& ACL, because that is too
30555 late (the message has already been created).
30556
30557 Chapter &<<CHAPmsgproc>>& describes the processing that Exim applies to
30558 messages. Section &<<SECTsubmodnon>>& covers the processing that happens in
30559 submission mode; the available options for this control are described there.
30560 The control applies only to the current message, not to any subsequent ones
30561 that may be received in the same SMTP connection.
30562
30563 .vitem &*control&~=&~suppress_local_fixups*&
30564 .cindex "submission fixups, suppressing"
30565 This control applies to locally submitted (non TCP/IP) messages, and is the
30566 complement of &`control = submission`&. It disables the fixups that are
30567 normally applied to locally-submitted messages. Specifically:
30568
30569 .ilist
30570 Any &'Sender:'& header line is left alone (in this respect, it is a
30571 dynamic version of &%local_sender_retain%&).
30572 .next
30573 No &'Message-ID:'&, &'From:'&, or &'Date:'& header lines are added.
30574 .next
30575 There is no check that &'From:'& corresponds to the actual sender.
30576 .endlist ilist
30577
30578 This control may be useful when a remotely-originated message is accepted,
30579 passed to some scanning program, and then re-submitted for delivery. It can be
30580 used only in the &%acl_smtp_mail%&, &%acl_smtp_rcpt%&, &%acl_smtp_predata%&,
30581 and &%acl_not_smtp_start%& ACLs, because it has to be set before the message's
30582 data is read.
30583
30584 &*Note:*& This control applies only to the current message, not to any others
30585 that are being submitted at the same time using &%-bs%& or &%-bS%&.
30586
30587 .vitem &*control&~=&~utf8_downconvert*&
30588 This control enables conversion of UTF-8 in message addresses
30589 to a-label form.
30590 For details see section &<<SECTi18nMTA>>&.
30591 .endlist vlist
30592
30593
30594 .section "Summary of message fixup control" "SECTsummesfix"
30595 All four possibilities for message fixups can be specified:
30596
30597 .ilist
30598 Locally submitted, fixups applied: the default.
30599 .next
30600 Locally submitted, no fixups applied: use
30601 &`control = suppress_local_fixups`&.
30602 .next
30603 Remotely submitted, no fixups applied: the default.
30604 .next
30605 Remotely submitted, fixups applied: use &`control = submission`&.
30606 .endlist
30607
30608
30609
30610 .section "Adding header lines in ACLs" "SECTaddheadacl"
30611 .cindex "header lines" "adding in an ACL"
30612 .cindex "header lines" "position of added lines"
30613 .cindex "&%add_header%& ACL modifier"
30614 The &%add_header%& modifier can be used to add one or more extra header lines
30615 to an incoming message, as in this example:
30616 .code
30617 warn dnslists = sbl.spamhaus.org : \
30618                 dialup.mail-abuse.org
30619      add_header = X-blacklisted-at: $dnslist_domain
30620 .endd
30621 The &%add_header%& modifier is permitted in the MAIL, RCPT, PREDATA, DATA,
30622 MIME, DKIM, and non-SMTP ACLs (in other words, those that are concerned with
30623 receiving a message). The message must ultimately be accepted for
30624 &%add_header%& to have any significant effect. You can use &%add_header%& with
30625 any ACL verb, including &%deny%& (though this is potentially useful only in a
30626 RCPT ACL).
30627
30628 Headers will not be added to the message if the modifier is used in
30629 DATA, MIME or DKIM ACLs for a message delivered by cutthrough routing.
30630
30631 Leading and trailing newlines are removed from
30632 the data for the &%add_header%& modifier; if it then
30633 contains one or more newlines that
30634 are not followed by a space or a tab, it is assumed to contain multiple header
30635 lines. Each one is checked for valid syntax; &`X-ACL-Warn:`& is added to the
30636 front of any line that is not a valid header line.
30637
30638 Added header lines are accumulated during the MAIL, RCPT, and predata ACLs.
30639 They are added to the message before processing the DATA and MIME ACLs.
30640 However, if an identical header line is requested more than once, only one copy
30641 is actually added to the message. Further header lines may be accumulated
30642 during the DATA and MIME ACLs, after which they are added to the message, again
30643 with duplicates suppressed. Thus, it is possible to add two identical header
30644 lines to an SMTP message, but only if one is added before DATA and one after.
30645 In the case of non-SMTP messages, new headers are accumulated during the
30646 non-SMTP ACLs, and are added to the message after all the ACLs have run. If a
30647 message is rejected after DATA or by the non-SMTP ACL, all added header lines
30648 are included in the entry that is written to the reject log.
30649
30650 .cindex "header lines" "added; visibility of"
30651 Header lines are not visible in string expansions
30652 of message headers
30653 until they are added to the
30654 message. It follows that header lines defined in the MAIL, RCPT, and predata
30655 ACLs are not visible until the DATA ACL and MIME ACLs are run. Similarly,
30656 header lines that are added by the DATA or MIME ACLs are not visible in those
30657 ACLs. Because of this restriction, you cannot use header lines as a way of
30658 passing data between (for example) the MAIL and RCPT ACLs. If you want to do
30659 this, you can use ACL variables, as described in section
30660 &<<SECTaclvariables>>&.
30661
30662 The list of headers yet to be added is given by the &%$headers_added%& variable.
30663
30664 The &%add_header%& modifier acts immediately as it is encountered during the
30665 processing of an ACL. Notice the difference between these two cases:
30666 .display
30667 &`accept add_header = ADDED: some text`&
30668 &`       `&<&'some condition'&>
30669
30670 &`accept `&<&'some condition'&>
30671 &`       add_header = ADDED: some text`&
30672 .endd
30673 In the first case, the header line is always added, whether or not the
30674 condition is true. In the second case, the header line is added only if the
30675 condition is true. Multiple occurrences of &%add_header%& may occur in the same
30676 ACL statement. All those that are encountered before a condition fails are
30677 honoured.
30678
30679 .cindex "&%warn%& ACL verb"
30680 For compatibility with previous versions of Exim, a &%message%& modifier for a
30681 &%warn%& verb acts in the same way as &%add_header%&, except that it takes
30682 effect only if all the conditions are true, even if it appears before some of
30683 them. Furthermore, only the last occurrence of &%message%& is honoured. This
30684 usage of &%message%& is now deprecated. If both &%add_header%& and &%message%&
30685 are present on a &%warn%& verb, both are processed according to their
30686 specifications.
30687
30688 By default, new header lines are added to a message at the end of the existing
30689 header lines. However, you can specify that any particular header line should
30690 be added right at the start (before all the &'Received:'& lines), immediately
30691 after the first block of &'Received:'& lines, or immediately before any line
30692 that is not a &'Received:'& or &'Resent-something:'& header.
30693
30694 This is done by specifying &":at_start:"&, &":after_received:"&, or
30695 &":at_start_rfc:"& (or, for completeness, &":at_end:"&) before the text of the
30696 header line, respectively. (Header text cannot start with a colon, as there has
30697 to be a header name first.) For example:
30698 .code
30699 warn add_header = \
30700        :after_received:X-My-Header: something or other...
30701 .endd
30702 If more than one header line is supplied in a single &%add_header%& modifier,
30703 each one is treated independently and can therefore be placed differently. If
30704 you add more than one line at the start, or after the Received: block, they end
30705 up in reverse order.
30706
30707 &*Warning*&: This facility currently applies only to header lines that are
30708 added in an ACL. It does NOT work for header lines that are added in a
30709 system filter or in a router or transport.
30710
30711
30712
30713 .section "Removing header lines in ACLs" "SECTremoveheadacl"
30714 .cindex "header lines" "removing in an ACL"
30715 .cindex "header lines" "position of removed lines"
30716 .cindex "&%remove_header%& ACL modifier"
30717 The &%remove_header%& modifier can be used to remove one or more header lines
30718 from an incoming message, as in this example:
30719 .code
30720 warn   message        = Remove internal headers
30721        remove_header  = x-route-mail1 : x-route-mail2
30722 .endd
30723 The &%remove_header%& modifier is permitted in the MAIL, RCPT, PREDATA, DATA,
30724 MIME, DKIM, and non-SMTP ACLs (in other words, those that are concerned with
30725 receiving a message). The message must ultimately be accepted for
30726 &%remove_header%& to have any significant effect. You can use &%remove_header%&
30727 with any ACL verb, including &%deny%&, though this is really not useful for
30728 any verb that doesn't result in a delivered message.
30729
30730 Headers will not be removed from the message if the modifier is used in
30731 DATA, MIME or DKIM ACLs for a message delivered by cutthrough routing.
30732
30733 More than one header can be removed at the same time by using a colon separated
30734 list of header names. The header matching is case insensitive. Wildcards are
30735 not permitted, nor is list expansion performed, so you cannot use hostlists to
30736 create a list of headers, however both connection and message variable expansion
30737 are performed (&%$acl_c_*%& and &%$acl_m_*%&), illustrated in this example:
30738 .code
30739 warn   hosts           = +internal_hosts
30740        set acl_c_ihdrs = x-route-mail1 : x-route-mail2
30741 warn   message         = Remove internal headers
30742        remove_header   = $acl_c_ihdrs
30743 .endd
30744 Header names for removal are accumulated during the MAIL, RCPT, and predata ACLs.
30745 Matching header lines are removed from the message before processing the DATA and MIME ACLs.
30746 If multiple header lines match, all are removed.
30747 There is no harm in attempting to remove the same header twice nor in removing
30748 a non-existent header. Further header lines to be removed may be accumulated
30749 during the DATA and MIME ACLs, after which they are removed from the message,
30750 if present. In the case of non-SMTP messages, headers to be removed are
30751 accumulated during the non-SMTP ACLs, and are removed from the message after
30752 all the ACLs have run. If a message is rejected after DATA or by the non-SMTP
30753 ACL, there really is no effect because there is no logging of what headers
30754 would have been removed.
30755
30756 .cindex "header lines" "removed; visibility of"
30757 Header lines are not visible in string expansions until the DATA phase when it
30758 is received. Any header lines removed in the MAIL, RCPT, and predata ACLs are
30759 not visible in the DATA ACL and MIME ACLs. Similarly, header lines that are
30760 removed by the DATA or MIME ACLs are still visible in those ACLs. Because of
30761 this restriction, you cannot use header lines as a way of controlling data
30762 passed between (for example) the MAIL and RCPT ACLs. If you want to do this,
30763 you should instead use ACL variables, as described in section
30764 &<<SECTaclvariables>>&.
30765
30766 The &%remove_header%& modifier acts immediately as it is encountered during the
30767 processing of an ACL. Notice the difference between these two cases:
30768 .display
30769 &`accept remove_header = X-Internal`&
30770 &`       `&<&'some condition'&>
30771
30772 &`accept `&<&'some condition'&>
30773 &`       remove_header = X-Internal`&
30774 .endd
30775 In the first case, the header line is always removed, whether or not the
30776 condition is true. In the second case, the header line is removed only if the
30777 condition is true. Multiple occurrences of &%remove_header%& may occur in the
30778 same ACL statement. All those that are encountered before a condition fails
30779 are honoured.
30780
30781 &*Warning*&: This facility currently applies only to header lines that are
30782 present during ACL processing. It does NOT remove header lines that are added
30783 in a system filter or in a router or transport.
30784
30785
30786
30787
30788 .section "ACL conditions" "SECTaclconditions"
30789 .cindex "&ACL;" "conditions; list of"
30790 Some of the conditions listed in this section are available only when Exim is
30791 compiled with the content-scanning extension. They are included here briefly
30792 for completeness. More detailed descriptions can be found in the discussion on
30793 content scanning in chapter &<<CHAPexiscan>>&.
30794
30795 Not all conditions are relevant in all circumstances. For example, testing
30796 senders and recipients does not make sense in an ACL that is being run as the
30797 result of the arrival of an ETRN command, and checks on message headers can be
30798 done only in the ACLs specified by &%acl_smtp_data%& and &%acl_not_smtp%&. You
30799 can use the same condition (with different parameters) more than once in the
30800 same ACL statement. This provides a way of specifying an &"and"& conjunction.
30801 The conditions are as follows:
30802
30803
30804 .vlist
30805 .vitem &*acl&~=&~*&<&'name&~of&~acl&~or&~ACL&~string&~or&~file&~name&~'&>
30806 .cindex "&ACL;" "nested"
30807 .cindex "&ACL;" "indirect"
30808 .cindex "&ACL;" "arguments"
30809 .cindex "&%acl%& ACL condition"
30810 The possible values of the argument are the same as for the
30811 &%acl_smtp_%&&'xxx'& options. The named or inline ACL is run. If it returns
30812 &"accept"& the condition is true; if it returns &"deny"& the condition is
30813 false. If it returns &"defer"&, the current ACL returns &"defer"& unless the
30814 condition is on a &%warn%& verb. In that case, a &"defer"& return makes the
30815 condition false. This means that further processing of the &%warn%& verb
30816 ceases, but processing of the ACL continues.
30817
30818 If the argument is a named ACL, up to nine space-separated optional values
30819 can be appended; they appear within the called ACL in $acl_arg1 to $acl_arg9,
30820 and $acl_narg is set to the count of values.
30821 Previous values of these variables are restored after the call returns.
30822 The name and values are expanded separately.
30823 Note that spaces in complex expansions which are used as arguments
30824 will act as argument separators.
30825
30826 If the nested &%acl%& returns &"drop"& and the outer condition denies access,
30827 the connection is dropped. If it returns &"discard"&, the verb must be
30828 &%accept%& or &%discard%&, and the action is taken immediately &-- no further
30829 conditions are tested.
30830
30831 ACLs may be nested up to 20 deep; the limit exists purely to catch runaway
30832 loops. This condition allows you to use different ACLs in different
30833 circumstances. For example, different ACLs can be used to handle RCPT commands
30834 for different local users or different local domains.
30835
30836 .vitem &*authenticated&~=&~*&<&'string&~list'&>
30837 .cindex "&%authenticated%& ACL condition"
30838 .cindex "authentication" "ACL checking"
30839 .cindex "&ACL;" "testing for authentication"
30840 If the SMTP connection is not authenticated, the condition is false. Otherwise,
30841 the name of the authenticator is tested against the list. To test for
30842 authentication by any authenticator, you can set
30843 .code
30844 authenticated = *
30845 .endd
30846
30847 .vitem &*condition&~=&~*&<&'string'&>
30848 .cindex "&%condition%& ACL condition"
30849 .cindex "customizing" "ACL condition"
30850 .cindex "&ACL;" "customized test"
30851 .cindex "&ACL;" "testing, customized"
30852 This feature allows you to make up custom conditions. If the result of
30853 expanding the string is an empty string, the number zero, or one of the strings
30854 &"no"& or &"false"&, the condition is false. If the result is any non-zero
30855 number, or one of the strings &"yes"& or &"true"&, the condition is true. For
30856 any other value, some error is assumed to have occurred, and the ACL returns
30857 &"defer"&. However, if the expansion is forced to fail, the condition is
30858 ignored. The effect is to treat it as true, whether it is positive or
30859 negative.
30860
30861 .vitem &*decode&~=&~*&<&'location'&>
30862 .cindex "&%decode%& ACL condition"
30863 This condition is available only when Exim is compiled with the
30864 content-scanning extension, and it is allowed only in the ACL defined by
30865 &%acl_smtp_mime%&. It causes the current MIME part to be decoded into a file.
30866 If all goes well, the condition is true. It is false only if there are
30867 problems such as a syntax error or a memory shortage. For more details, see
30868 chapter &<<CHAPexiscan>>&.
30869
30870 .vitem &*dnslists&~=&~*&<&'list&~of&~domain&~names&~and&~other&~data'&>
30871 .cindex "&%dnslists%& ACL condition"
30872 .cindex "DNS list" "in ACL"
30873 .cindex "black list (DNS)"
30874 .cindex "&ACL;" "testing a DNS list"
30875 This condition checks for entries in DNS black lists. These are also known as
30876 &"RBL lists"&, after the original Realtime Blackhole List, but note that the
30877 use of the lists at &'mail-abuse.org'& now carries a charge. There are too many
30878 different variants of this condition to describe briefly here. See sections
30879 &<<SECTmorednslists>>&&--&<<SECTmorednslistslast>>& for details.
30880
30881 .vitem &*domains&~=&~*&<&'domain&~list'&>
30882 .cindex "&%domains%& ACL condition"
30883 .cindex "domain" "ACL checking"
30884 .cindex "&ACL;" "testing a recipient domain"
30885 .vindex "&$domain_data$&"
30886 This condition is relevant only after a RCPT command. It checks that the domain
30887 of the recipient address is in the domain list. If percent-hack processing is
30888 enabled, it is done before this test is done. If the check succeeds with a
30889 lookup, the result of the lookup is placed in &$domain_data$& until the next
30890 &%domains%& test.
30891
30892 &*Note carefully*& (because many people seem to fall foul of this): you cannot
30893 use &%domains%& in a DATA ACL.
30894
30895
30896 .vitem &*encrypted&~=&~*&<&'string&~list'&>
30897 .cindex "&%encrypted%& ACL condition"
30898 .cindex "encryption" "checking in an ACL"
30899 .cindex "&ACL;" "testing for encryption"
30900 If the SMTP connection is not encrypted, the condition is false. Otherwise, the
30901 name of the cipher suite in use is tested against the list. To test for
30902 encryption without testing for any specific cipher suite(s), set
30903 .code
30904 encrypted = *
30905 .endd
30906
30907
30908 .vitem &*hosts&~=&~*&<&'host&~list'&>
30909 .cindex "&%hosts%& ACL condition"
30910 .cindex "host" "ACL checking"
30911 .cindex "&ACL;" "testing the client host"
30912 This condition tests that the calling host matches the host list. If you have
30913 name lookups or wildcarded host names and IP addresses in the same host list,
30914 you should normally put the IP addresses first. For example, you could have:
30915 .code
30916 accept hosts = 10.9.8.7 : dbm;/etc/friendly/hosts
30917 .endd
30918 The lookup in this example uses the host name for its key. This is implied by
30919 the lookup type &"dbm"&. (For a host address lookup you would use &"net-dbm"&
30920 and it wouldn't matter which way round you had these two items.)
30921
30922 The reason for the problem with host names lies in the left-to-right way that
30923 Exim processes lists. It can test IP addresses without doing any DNS lookups,
30924 but when it reaches an item that requires a host name, it fails if it cannot
30925 find a host name to compare with the pattern. If the above list is given in the
30926 opposite order, the &%accept%& statement fails for a host whose name cannot be
30927 found, even if its IP address is 10.9.8.7.
30928
30929 If you really do want to do the name check first, and still recognize the IP
30930 address even if the name lookup fails, you can rewrite the ACL like this:
30931 .code
30932 accept hosts = dbm;/etc/friendly/hosts
30933 accept hosts = 10.9.8.7
30934 .endd
30935 The default action on failing to find the host name is to assume that the host
30936 is not in the list, so the first &%accept%& statement fails. The second
30937 statement can then check the IP address.
30938
30939 .vindex "&$host_data$&"
30940 If a &%hosts%& condition is satisfied by means of a lookup, the result
30941 of the lookup is made available in the &$host_data$& variable. This
30942 allows you, for example, to set up a statement like this:
30943 .code
30944 deny  hosts = net-lsearch;/some/file
30945 message = $host_data
30946 .endd
30947 which gives a custom error message for each denied host.
30948
30949 .vitem &*local_parts&~=&~*&<&'local&~part&~list'&>
30950 .cindex "&%local_parts%& ACL condition"
30951 .cindex "local part" "ACL checking"
30952 .cindex "&ACL;" "testing a local part"
30953 .vindex "&$local_part_data$&"
30954 This condition is relevant only after a RCPT command. It checks that the local
30955 part of the recipient address is in the list. If percent-hack processing is
30956 enabled, it is done before this test. If the check succeeds with a lookup, the
30957 result of the lookup is placed in &$local_part_data$&, which remains set until
30958 the next &%local_parts%& test.
30959
30960 .vitem &*malware&~=&~*&<&'option'&>
30961 .cindex "&%malware%& ACL condition"
30962 .cindex "&ACL;" "virus scanning"
30963 .cindex "&ACL;" "scanning for viruses"
30964 This condition is available only when Exim is compiled with the
30965 content-scanning extension
30966 and only after a DATA command.
30967 It causes the incoming message to be scanned for
30968 viruses. For details, see chapter &<<CHAPexiscan>>&.
30969
30970 .vitem &*mime_regex&~=&~*&<&'list&~of&~regular&~expressions'&>
30971 .cindex "&%mime_regex%& ACL condition"
30972 .cindex "&ACL;" "testing by regex matching"
30973 This condition is available only when Exim is compiled with the
30974 content-scanning extension, and it is allowed only in the ACL defined by
30975 &%acl_smtp_mime%&. It causes the current MIME part to be scanned for a match
30976 with any of the regular expressions. For details, see chapter
30977 &<<CHAPexiscan>>&.
30978
30979 .vitem &*ratelimit&~=&~*&<&'parameters'&>
30980 .cindex "rate limiting"
30981 This condition can be used to limit the rate at which a user or host submits
30982 messages. Details are given in section &<<SECTratelimiting>>&.
30983
30984 .vitem &*recipients&~=&~*&<&'address&~list'&>
30985 .cindex "&%recipients%& ACL condition"
30986 .cindex "recipient" "ACL checking"
30987 .cindex "&ACL;" "testing a recipient"
30988 This condition is relevant only after a RCPT command. It checks the entire
30989 recipient address against a list of recipients.
30990
30991 .vitem &*regex&~=&~*&<&'list&~of&~regular&~expressions'&>
30992 .cindex "&%regex%& ACL condition"
30993 .cindex "&ACL;" "testing by regex matching"
30994 This condition is available only when Exim is compiled with the
30995 content-scanning extension, and is available only in the DATA, MIME, and
30996 non-SMTP ACLs. It causes the incoming message to be scanned for a match with
30997 any of the regular expressions. For details, see chapter &<<CHAPexiscan>>&.
30998
30999 .vitem &*sender_domains&~=&~*&<&'domain&~list'&>
31000 .cindex "&%sender_domains%& ACL condition"
31001 .cindex "sender" "ACL checking"
31002 .cindex "&ACL;" "testing a sender domain"
31003 .vindex "&$domain$&"
31004 .vindex "&$sender_address_domain$&"
31005 This condition tests the domain of the sender of the message against the given
31006 domain list. &*Note*&: The domain of the sender address is in
31007 &$sender_address_domain$&. It is &'not'& put in &$domain$& during the testing
31008 of this condition. This is an exception to the general rule for testing domain
31009 lists. It is done this way so that, if this condition is used in an ACL for a
31010 RCPT command, the recipient's domain (which is in &$domain$&) can be used to
31011 influence the sender checking.
31012
31013 &*Warning*&: It is a bad idea to use this condition on its own as a control on
31014 relaying, because sender addresses are easily, and commonly, forged.
31015
31016 .vitem &*senders&~=&~*&<&'address&~list'&>
31017 .cindex "&%senders%& ACL condition"
31018 .cindex "sender" "ACL checking"
31019 .cindex "&ACL;" "testing a sender"
31020 This condition tests the sender of the message against the given list. To test
31021 for a bounce message, which has an empty sender, set
31022 .code
31023 senders = :
31024 .endd
31025 &*Warning*&: It is a bad idea to use this condition on its own as a control on
31026 relaying, because sender addresses are easily, and commonly, forged.
31027
31028 .vitem &*spam&~=&~*&<&'username'&>
31029 .cindex "&%spam%& ACL condition"
31030 .cindex "&ACL;" "scanning for spam"
31031 This condition is available only when Exim is compiled with the
31032 content-scanning extension. It causes the incoming message to be scanned by
31033 SpamAssassin. For details, see chapter &<<CHAPexiscan>>&.
31034
31035 .vitem &*verify&~=&~certificate*&
31036 .cindex "&%verify%& ACL condition"
31037 .cindex "TLS" "client certificate verification"
31038 .cindex "certificate" "verification of client"
31039 .cindex "&ACL;" "certificate verification"
31040 .cindex "&ACL;" "testing a TLS certificate"
31041 This condition is true in an SMTP session if the session is encrypted, and a
31042 certificate was received from the client, and the certificate was verified. The
31043 server requests a certificate only if the client matches &%tls_verify_hosts%&
31044 or &%tls_try_verify_hosts%& (see chapter &<<CHAPTLS>>&).
31045
31046 .vitem &*verify&~=&~csa*&
31047 .cindex "CSA verification"
31048 This condition checks whether the sending host (the client) is authorized to
31049 send email. Details of how this works are given in section
31050 &<<SECTverifyCSA>>&.
31051
31052 .vitem &*verify&~=&~header_names_ascii*&
31053 .cindex "&%verify%& ACL condition"
31054 .cindex "&ACL;" "verifying header names only ASCII"
31055 .cindex "header lines" "verifying header names only ASCII"
31056 .cindex "verifying" "header names only ASCII"
31057 This condition is relevant only in an ACL that is run after a message has been
31058 received, that is, in an ACL specified by &%acl_smtp_data%& or
31059 &%acl_not_smtp%&.  It checks all header names (not the content) to make sure
31060 there are no non-ASCII characters, also excluding control characters.  The
31061 allowable characters are decimal ASCII values 33 through 126.
31062
31063 Exim itself will handle headers with non-ASCII characters, but it can cause
31064 problems for downstream applications, so this option will allow their
31065 detection and rejection in the DATA ACL's.
31066
31067 .vitem &*verify&~=&~header_sender/*&<&'options'&>
31068 .cindex "&%verify%& ACL condition"
31069 .cindex "&ACL;" "verifying sender in the header"
31070 .cindex "header lines" "verifying the sender in"
31071 .cindex "sender" "verifying in header"
31072 .cindex "verifying" "sender in header"
31073 This condition is relevant only in an ACL that is run after a message has been
31074 received, that is, in an ACL specified by &%acl_smtp_data%& or
31075 &%acl_not_smtp%&. It checks that there is a verifiable address in at least one
31076 of the &'Sender:'&, &'Reply-To:'&, or &'From:'& header lines. Such an address
31077 is loosely thought of as a &"sender"& address (hence the name of the test).
31078 However, an address that appears in one of these headers need not be an address
31079 that accepts bounce messages; only sender addresses in envelopes are required
31080 to accept bounces. Therefore, if you use the callout option on this check, you
31081 might want to arrange for a non-empty address in the MAIL command.
31082
31083 Details of address verification and the options are given later, starting at
31084 section &<<SECTaddressverification>>& (callouts are described in section
31085 &<<SECTcallver>>&). You can combine this condition with the &%senders%&
31086 condition to restrict it to bounce messages only:
31087 .code
31088 deny    senders = :
31089         message = A valid sender header is required for bounces
31090        !verify  = header_sender
31091 .endd
31092
31093 .vitem &*verify&~=&~header_syntax*&
31094 .cindex "&%verify%& ACL condition"
31095 .cindex "&ACL;" "verifying header syntax"
31096 .cindex "header lines" "verifying syntax"
31097 .cindex "verifying" "header syntax"
31098 This condition is relevant only in an ACL that is run after a message has been
31099 received, that is, in an ACL specified by &%acl_smtp_data%& or
31100 &%acl_not_smtp%&. It checks the syntax of all header lines that can contain
31101 lists of addresses (&'Sender:'&, &'From:'&, &'Reply-To:'&, &'To:'&, &'Cc:'&,
31102 and &'Bcc:'&), returning true if there are no problems.
31103 Unqualified addresses (local parts without domains) are
31104 permitted only in locally generated messages and from hosts that match
31105 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
31106 appropriate.
31107
31108 Note that this condition is a syntax check only. However, a common spamming
31109 ploy used to be to send syntactically invalid headers such as
31110 .code
31111 To: @
31112 .endd
31113 and this condition can be used to reject such messages, though they are not as
31114 common as they used to be.
31115
31116 .vitem &*verify&~=&~helo*&
31117 .cindex "&%verify%& ACL condition"
31118 .cindex "&ACL;" "verifying HELO/EHLO"
31119 .cindex "HELO" "verifying"
31120 .cindex "EHLO" "verifying"
31121 .cindex "verifying" "EHLO"
31122 .cindex "verifying" "HELO"
31123 This condition is true if a HELO or EHLO command has been received from the
31124 client host, and its contents have been verified. If there has been no previous
31125 attempt to verify the HELO/EHLO contents, it is carried out when this
31126 condition is encountered. See the description of the &%helo_verify_hosts%& and
31127 &%helo_try_verify_hosts%& options for details of how to request verification
31128 independently of this condition, and for detail of the verification.
31129
31130 For SMTP input that does not come over TCP/IP (the &%-bs%& command line
31131 option), this condition is always true.
31132
31133
31134 .vitem &*verify&~=&~not_blind/*&<&'options'&>
31135 .cindex "verifying" "not blind"
31136 .cindex "bcc recipients, verifying none"
31137 This condition checks that there are no blind (bcc) recipients in the message.
31138 Every envelope recipient must appear either in a &'To:'& header line or in a
31139 &'Cc:'& header line for this condition to be true. Local parts are checked
31140 case-sensitively; domains are checked case-insensitively. If &'Resent-To:'& or
31141 &'Resent-Cc:'& header lines exist, they are also checked. This condition can be
31142 used only in a DATA or non-SMTP ACL.
31143
31144 .new
31145 There is one possible option, &`case_insensitive`&.  If this is present then
31146 local parts are checked case-insensitively.
31147 .wen
31148
31149 There are, of course, many legitimate messages that make use of blind (bcc)
31150 recipients. This check should not be used on its own for blocking messages.
31151
31152
31153 .vitem &*verify&~=&~recipient/*&<&'options'&>
31154 .cindex "&%verify%& ACL condition"
31155 .cindex "&ACL;" "verifying recipient"
31156 .cindex "recipient" "verifying"
31157 .cindex "verifying" "recipient"
31158 .vindex "&$address_data$&"
31159 This condition is relevant only after a RCPT command. It verifies the current
31160 recipient. Details of address verification are given later, starting at section
31161 &<<SECTaddressverification>>&. After a recipient has been verified, the value
31162 of &$address_data$& is the last value that was set while routing the address.
31163 This applies even if the verification fails. When an address that is being
31164 verified is redirected to a single address, verification continues with the new
31165 address, and in that case, the subsequent value of &$address_data$& is the
31166 value for the child address.
31167
31168 .vitem &*verify&~=&~reverse_host_lookup/*&<&'options'&>
31169 .cindex "&%verify%& ACL condition"
31170 .cindex "&ACL;" "verifying host reverse lookup"
31171 .cindex "host" "verifying reverse lookup"
31172 This condition ensures that a verified host name has been looked up from the IP
31173 address of the client host. (This may have happened already if the host name
31174 was needed for checking a host list, or if the host matched &%host_lookup%&.)
31175 Verification ensures that the host name obtained from a reverse DNS lookup, or
31176 one of its aliases, does, when it is itself looked up in the DNS, yield the
31177 original IP address.
31178
31179 There is one possible option, &`defer_ok`&.  If this is present and a
31180 DNS operation returns a temporary error, the verify condition succeeds.
31181
31182 If this condition is used for a locally generated message (that is, when there
31183 is no client host involved), it always succeeds.
31184
31185 .vitem &*verify&~=&~sender/*&<&'options'&>
31186 .cindex "&%verify%& ACL condition"
31187 .cindex "&ACL;" "verifying sender"
31188 .cindex "sender" "verifying"
31189 .cindex "verifying" "sender"
31190 This condition is relevant only after a MAIL or RCPT command, or after a
31191 message has been received (the &%acl_smtp_data%& or &%acl_not_smtp%& ACLs). If
31192 the message's sender is empty (that is, this is a bounce message), the
31193 condition is true. Otherwise, the sender address is verified.
31194
31195 .vindex "&$address_data$&"
31196 .vindex "&$sender_address_data$&"
31197 If there is data in the &$address_data$& variable at the end of routing, its
31198 value is placed in &$sender_address_data$& at the end of verification. This
31199 value can be used in subsequent conditions and modifiers in the same ACL
31200 statement. It does not persist after the end of the current statement. If you
31201 want to preserve the value for longer, you can save it in an ACL variable.
31202
31203 Details of verification are given later, starting at section
31204 &<<SECTaddressverification>>&. Exim caches the result of sender verification,
31205 to avoid doing it more than once per message.
31206
31207 .vitem &*verify&~=&~sender=*&<&'address'&>&*/*&<&'options'&>
31208 .cindex "&%verify%& ACL condition"
31209 This is a variation of the previous option, in which a modified address is
31210 verified as a sender.
31211
31212 Note that '/' is legal in local-parts; if the address may have such
31213 (eg. is generated from the received message)
31214 they must be protected from the options parsing by doubling:
31215 .code
31216 verify = sender=${sg{${address:$h_sender:}}{/}{//}}
31217 .endd
31218 .endlist
31219
31220
31221
31222 .section "Using DNS lists" "SECTmorednslists"
31223 .cindex "DNS list" "in ACL"
31224 .cindex "black list (DNS)"
31225 .cindex "&ACL;" "testing a DNS list"
31226 In its simplest form, the &%dnslists%& condition tests whether the calling host
31227 is on at least one of a number of DNS lists by looking up the inverted IP
31228 address in one or more DNS domains. (Note that DNS list domains are not mail
31229 domains, so the &`+`& syntax for named lists doesn't work - it is used for
31230 special options instead.) For example, if the calling host's IP
31231 address is 192.168.62.43, and the ACL statement is
31232 .code
31233 deny dnslists = blackholes.mail-abuse.org : \
31234                 dialups.mail-abuse.org
31235 .endd
31236 the following records are looked up:
31237 .code
31238 43.62.168.192.blackholes.mail-abuse.org
31239 43.62.168.192.dialups.mail-abuse.org
31240 .endd
31241 As soon as Exim finds an existing DNS record, processing of the list stops.
31242 Thus, multiple entries on the list provide an &"or"& conjunction. If you want
31243 to test that a host is on more than one list (an &"and"& conjunction), you can
31244 use two separate conditions:
31245 .code
31246 deny dnslists = blackholes.mail-abuse.org
31247      dnslists = dialups.mail-abuse.org
31248 .endd
31249 If a DNS lookup times out or otherwise fails to give a decisive answer, Exim
31250 behaves as if the host does not match the list item, that is, as if the DNS
31251 record does not exist. If there are further items in the DNS list, they are
31252 processed.
31253
31254 This is usually the required action when &%dnslists%& is used with &%deny%&
31255 (which is the most common usage), because it prevents a DNS failure from
31256 blocking mail. However, you can change this behaviour by putting one of the
31257 following special items in the list:
31258 .display
31259 &`+include_unknown `&   behave as if the item is on the list
31260 &`+exclude_unknown `&   behave as if the item is not on the list (default)
31261 &`+defer_unknown   `&   give a temporary error
31262 .endd
31263 .cindex "&`+include_unknown`&"
31264 .cindex "&`+exclude_unknown`&"
31265 .cindex "&`+defer_unknown`&"
31266 Each of these applies to any subsequent items on the list. For example:
31267 .code
31268 deny dnslists = +defer_unknown : foo.bar.example
31269 .endd
31270 Testing the list of domains stops as soon as a match is found. If you want to
31271 warn for one list and block for another, you can use two different statements:
31272 .code
31273 deny  dnslists = blackholes.mail-abuse.org
31274 warn  message  = X-Warn: sending host is on dialups list
31275       dnslists = dialups.mail-abuse.org
31276 .endd
31277 .cindex caching "of dns lookup"
31278 .cindex DNS TTL
31279 DNS list lookups are cached by Exim for the duration of the SMTP session
31280 (but limited by the DNS return TTL value),
31281 so a lookup based on the IP address is done at most once for any incoming
31282 connection (assuming long-enough TTL).
31283 Exim does not share information between multiple incoming
31284 connections (but your local name server cache should be active).
31285
31286 There are a number of DNS lists to choose from, some commercial, some free,
31287 or free for small deployments.  An overview can be found at
31288 &url(https://en.wikipedia.org/wiki/Comparison_of_DNS_blacklists).
31289
31290
31291
31292 .section "Specifying the IP address for a DNS list lookup" "SECID201"
31293 .cindex "DNS list" "keyed by explicit IP address"
31294 By default, the IP address that is used in a DNS list lookup is the IP address
31295 of the calling host. However, you can specify another IP address by listing it
31296 after the domain name, introduced by a slash. For example:
31297 .code
31298 deny dnslists = black.list.tld/192.168.1.2
31299 .endd
31300 This feature is not very helpful with explicit IP addresses; it is intended for
31301 use with IP addresses that are looked up, for example, the IP addresses of the
31302 MX hosts or nameservers of an email sender address. For an example, see section
31303 &<<SECTmulkeyfor>>& below.
31304
31305
31306
31307
31308 .section "DNS lists keyed on domain names" "SECID202"
31309 .cindex "DNS list" "keyed by domain name"
31310 There are some lists that are keyed on domain names rather than inverted IP
31311 addresses (see, e.g., the &'domain based zones'& link at
31312 &url(http://www.rfc-ignorant.org/)). No reversing of components is used
31313 with these lists. You can change the name that is looked up in a DNS list by
31314 listing it after the domain name, introduced by a slash. For example,
31315 .code
31316 deny  message  = Sender's domain is listed at $dnslist_domain
31317       dnslists = dsn.rfc-ignorant.org/$sender_address_domain
31318 .endd
31319 This particular example is useful only in ACLs that are obeyed after the
31320 RCPT or DATA commands, when a sender address is available. If (for
31321 example) the message's sender is &'user@tld.example'& the name that is looked
31322 up by this example is
31323 .code
31324 tld.example.dsn.rfc-ignorant.org
31325 .endd
31326 A single &%dnslists%& condition can contain entries for both names and IP
31327 addresses. For example:
31328 .code
31329 deny dnslists = sbl.spamhaus.org : \
31330                 dsn.rfc-ignorant.org/$sender_address_domain
31331 .endd
31332 The first item checks the sending host's IP address; the second checks a domain
31333 name. The whole condition is true if either of the DNS lookups succeeds.
31334
31335
31336
31337
31338 .section "Multiple explicit keys for a DNS list" "SECTmulkeyfor"
31339 .cindex "DNS list" "multiple keys for"
31340 The syntax described above for looking up explicitly-defined values (either
31341 names or IP addresses) in a DNS blacklist is a simplification. After the domain
31342 name for the DNS list, what follows the slash can in fact be a list of items.
31343 As with all lists in Exim, the default separator is a colon. However, because
31344 this is a sublist within the list of DNS blacklist domains, it is necessary
31345 either to double the separators like this:
31346 .code
31347 dnslists = black.list.tld/name.1::name.2
31348 .endd
31349 or to change the separator character, like this:
31350 .code
31351 dnslists = black.list.tld/<;name.1;name.2
31352 .endd
31353 If an item in the list is an IP address, it is inverted before the DNS
31354 blacklist domain is appended. If it is not an IP address, no inversion
31355 occurs. Consider this condition:
31356 .code
31357 dnslists = black.list.tld/<;192.168.1.2;a.domain
31358 .endd
31359 The DNS lookups that occur are:
31360 .code
31361 2.1.168.192.black.list.tld
31362 a.domain.black.list.tld
31363 .endd
31364 Once a DNS record has been found (that matches a specific IP return
31365 address, if specified &-- see section &<<SECTaddmatcon>>&), no further lookups
31366 are done. If there is a temporary DNS error, the rest of the sublist of domains
31367 or IP addresses is tried. A temporary error for the whole dnslists item occurs
31368 only if no other DNS lookup in this sublist succeeds. In other words, a
31369 successful lookup for any of the items in the sublist overrides a temporary
31370 error for a previous item.
31371
31372 The ability to supply a list of items after the slash is in some sense just a
31373 syntactic convenience. These two examples have the same effect:
31374 .code
31375 dnslists = black.list.tld/a.domain : black.list.tld/b.domain
31376 dnslists = black.list.tld/a.domain::b.domain
31377 .endd
31378 However, when the data for the list is obtained from a lookup, the second form
31379 is usually much more convenient. Consider this example:
31380 .code
31381 deny message  = The mail servers for the domain \
31382                 $sender_address_domain \
31383                 are listed at $dnslist_domain ($dnslist_value); \
31384                 see $dnslist_text.
31385      dnslists = sbl.spamhaus.org/<|${lookup dnsdb {>|a=<|\
31386                                    ${lookup dnsdb {>|mxh=\
31387                                    $sender_address_domain} }} }
31388 .endd
31389 Note the use of &`>|`& in the dnsdb lookup to specify the separator for
31390 multiple DNS records. The inner dnsdb lookup produces a list of MX hosts
31391 and the outer dnsdb lookup finds the IP addresses for these hosts. The result
31392 of expanding the condition might be something like this:
31393 .code
31394 dnslists = sbl.spamhaus.org/<|192.168.2.3|192.168.5.6|...
31395 .endd
31396 Thus, this example checks whether or not the IP addresses of the sender
31397 domain's mail servers are on the Spamhaus black list.
31398
31399 The key that was used for a successful DNS list lookup is put into the variable
31400 &$dnslist_matched$& (see section &<<SECID204>>&).
31401
31402
31403
31404
31405 .section "Data returned by DNS lists" "SECID203"
31406 .cindex "DNS list" "data returned from"
31407 DNS lists are constructed using address records in the DNS. The original RBL
31408 just used the address 127.0.0.1 on the right hand side of each record, but the
31409 RBL+ list and some other lists use a number of values with different meanings.
31410 The values used on the RBL+ list are:
31411 .display
31412 127.1.0.1  RBL
31413 127.1.0.2  DUL
31414 127.1.0.3  DUL and RBL
31415 127.1.0.4  RSS
31416 127.1.0.5  RSS and RBL
31417 127.1.0.6  RSS and DUL
31418 127.1.0.7  RSS and DUL and RBL
31419 .endd
31420 Section &<<SECTaddmatcon>>& below describes how you can distinguish between
31421 different values. Some DNS lists may return more than one address record;
31422 see section &<<SECThanmuldnsrec>>& for details of how they are checked.
31423
31424
31425 .section "Variables set from DNS lists" "SECID204"
31426 .cindex "expansion" "variables, set from DNS list"
31427 .cindex "DNS list" "variables set from"
31428 .vindex "&$dnslist_domain$&"
31429 .vindex "&$dnslist_matched$&"
31430 .vindex "&$dnslist_text$&"
31431 .vindex "&$dnslist_value$&"
31432 When an entry is found in a DNS list, the variable &$dnslist_domain$& contains
31433 the name of the overall domain that matched (for example,
31434 &`spamhaus.example`&), &$dnslist_matched$& contains the key within that domain
31435 (for example, &`192.168.5.3`&), and &$dnslist_value$& contains the data from
31436 the DNS record. When the key is an IP address, it is not reversed in
31437 &$dnslist_matched$& (though it is, of course, in the actual lookup). In simple
31438 cases, for example:
31439 .code
31440 deny dnslists = spamhaus.example
31441 .endd
31442 the key is also available in another variable (in this case,
31443 &$sender_host_address$&). In more complicated cases, however, this is not true.
31444 For example, using a data lookup (as described in section &<<SECTmulkeyfor>>&)
31445 might generate a dnslists lookup like this:
31446 .code
31447 deny dnslists = spamhaus.example/<|192.168.1.2|192.168.6.7|...
31448 .endd
31449 If this condition succeeds, the value in &$dnslist_matched$& might be
31450 &`192.168.6.7`& (for example).
31451
31452 If more than one address record is returned by the DNS lookup, all the IP
31453 addresses are included in &$dnslist_value$&, separated by commas and spaces.
31454 The variable &$dnslist_text$& contains the contents of any associated TXT
31455 record. For lists such as RBL+ the TXT record for a merged entry is often not
31456 very meaningful. See section &<<SECTmordetinf>>& for a way of obtaining more
31457 information.
31458
31459 You can use the DNS list variables in &%message%& or &%log_message%& modifiers
31460 &-- although these appear before the condition in the ACL, they are not
31461 expanded until after it has failed. For example:
31462 .code
31463 deny    hosts = !+local_networks
31464         message = $sender_host_address is listed \
31465                   at $dnslist_domain
31466         dnslists = rbl-plus.mail-abuse.example
31467 .endd
31468
31469
31470
31471 .section "Additional matching conditions for DNS lists" "SECTaddmatcon"
31472 .cindex "DNS list" "matching specific returned data"
31473 You can add an equals sign and an IP address after a &%dnslists%& domain name
31474 in order to restrict its action to DNS records with a matching right hand side.
31475 For example,
31476 .code
31477 deny dnslists = rblplus.mail-abuse.org=127.0.0.2
31478 .endd
31479 rejects only those hosts that yield 127.0.0.2. Without this additional data,
31480 any address record is considered to be a match. For the moment, we assume
31481 that the DNS lookup returns just one record. Section &<<SECThanmuldnsrec>>&
31482 describes how multiple records are handled.
31483
31484 More than one IP address may be given for checking, using a comma as a
31485 separator. These are alternatives &-- if any one of them matches, the
31486 &%dnslists%& condition is true. For example:
31487 .code
31488 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
31489 .endd
31490 If you want to specify a constraining address list and also specify names or IP
31491 addresses to be looked up, the constraining address list must be specified
31492 first. For example:
31493 .code
31494 deny dnslists = dsn.rfc-ignorant.org\
31495                 =127.0.0.2/$sender_address_domain
31496 .endd
31497
31498 If the character &`&&`& is used instead of &`=`&, the comparison for each
31499 listed IP address is done by a bitwise &"and"& instead of by an equality test.
31500 In other words, the listed addresses are used as bit masks. The comparison is
31501 true if all the bits in the mask are present in the address that is being
31502 tested. For example:
31503 .code
31504 dnslists = a.b.c&0.0.0.3
31505 .endd
31506 matches if the address is &'x.x.x.'&3, &'x.x.x.'&7, &'x.x.x.'&11, etc. If you
31507 want to test whether one bit or another bit is present (as opposed to both
31508 being present), you must use multiple values. For example:
31509 .code
31510 dnslists = a.b.c&0.0.0.1,0.0.0.2
31511 .endd
31512 matches if the final component of the address is an odd number or two times
31513 an odd number.
31514
31515
31516
31517 .section "Negated DNS matching conditions" "SECID205"
31518 You can supply a negative list of IP addresses as part of a &%dnslists%&
31519 condition. Whereas
31520 .code
31521 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
31522 .endd
31523 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
31524 IP address yielded by the list is either 127.0.0.2 or 127.0.0.3"&,
31525 .code
31526 deny  dnslists = a.b.c!=127.0.0.2,127.0.0.3
31527 .endd
31528 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
31529 IP address yielded by the list is not 127.0.0.2 and not 127.0.0.3"&. In other
31530 words, the result of the test is inverted if an exclamation mark appears before
31531 the &`=`& (or the &`&&`&) sign.
31532
31533 &*Note*&: This kind of negation is not the same as negation in a domain,
31534 host, or address list (which is why the syntax is different).
31535
31536 If you are using just one list, the negation syntax does not gain you much. The
31537 previous example is precisely equivalent to
31538 .code
31539 deny  dnslists = a.b.c
31540      !dnslists = a.b.c=127.0.0.2,127.0.0.3
31541 .endd
31542 However, if you are using multiple lists, the negation syntax is clearer.
31543 Consider this example:
31544 .code
31545 deny  dnslists = sbl.spamhaus.org : \
31546                  list.dsbl.org : \
31547                  dnsbl.njabl.org!=127.0.0.3 : \
31548                  relays.ordb.org
31549 .endd
31550 Using only positive lists, this would have to be:
31551 .code
31552 deny  dnslists = sbl.spamhaus.org : \
31553                  list.dsbl.org
31554 deny  dnslists = dnsbl.njabl.org
31555      !dnslists = dnsbl.njabl.org=127.0.0.3
31556 deny  dnslists = relays.ordb.org
31557 .endd
31558 which is less clear, and harder to maintain.
31559
31560
31561
31562
31563 .section "Handling multiple DNS records from a DNS list" "SECThanmuldnsrec"
31564 A DNS lookup for a &%dnslists%& condition may return more than one DNS record,
31565 thereby providing more than one IP address. When an item in a &%dnslists%& list
31566 is followed by &`=`& or &`&&`& and a list of IP addresses, in order to restrict
31567 the match to specific results from the DNS lookup, there are two ways in which
31568 the checking can be handled. For example, consider the condition:
31569 .code
31570 dnslists = a.b.c=127.0.0.1
31571 .endd
31572 What happens if the DNS lookup for the incoming IP address yields both
31573 127.0.0.1 and 127.0.0.2 by means of two separate DNS records? Is the
31574 condition true because at least one given value was found, or is it false
31575 because at least one of the found values was not listed? And how does this
31576 affect negated conditions? Both possibilities are provided for with the help of
31577 additional separators &`==`& and &`=&&`&.
31578
31579 .ilist
31580 If &`=`& or &`&&`& is used, the condition is true if any one of the looked up
31581 IP addresses matches one of the listed addresses. For the example above, the
31582 condition is true because 127.0.0.1 matches.
31583 .next
31584 If &`==`& or &`=&&`& is used, the condition is true only if every one of the
31585 looked up IP addresses matches one of the listed addresses. If the condition is
31586 changed to:
31587 .code
31588 dnslists = a.b.c==127.0.0.1
31589 .endd
31590 and the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
31591 false because 127.0.0.2 is not listed. You would need to have:
31592 .code
31593 dnslists = a.b.c==127.0.0.1,127.0.0.2
31594 .endd
31595 for the condition to be true.
31596 .endlist
31597
31598 When &`!`& is used to negate IP address matching, it inverts the result, giving
31599 the precise opposite of the behaviour above. Thus:
31600 .ilist
31601 If &`!=`& or &`!&&`& is used, the condition is true if none of the looked up IP
31602 addresses matches one of the listed addresses. Consider:
31603 .code
31604 dnslists = a.b.c!&0.0.0.1
31605 .endd
31606 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
31607 false because 127.0.0.1 matches.
31608 .next
31609 If &`!==`& or &`!=&&`& is used, the condition is true if there is at least one
31610 looked up IP address that does not match. Consider:
31611 .code
31612 dnslists = a.b.c!=&0.0.0.1
31613 .endd
31614 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
31615 true, because 127.0.0.2 does not match. You would need to have:
31616 .code
31617 dnslists = a.b.c!=&0.0.0.1,0.0.0.2
31618 .endd
31619 for the condition to be false.
31620 .endlist
31621 When the DNS lookup yields only a single IP address, there is no difference
31622 between &`=`& and &`==`& and between &`&&`& and &`=&&`&.
31623
31624
31625
31626
31627 .section "Detailed information from merged DNS lists" "SECTmordetinf"
31628 .cindex "DNS list" "information from merged"
31629 When the facility for restricting the matching IP values in a DNS list is used,
31630 the text from the TXT record that is set in &$dnslist_text$& may not reflect
31631 the true reason for rejection. This happens when lists are merged and the IP
31632 address in the A record is used to distinguish them; unfortunately there is
31633 only one TXT record. One way round this is not to use merged lists, but that
31634 can be inefficient because it requires multiple DNS lookups where one would do
31635 in the vast majority of cases when the host of interest is not on any of the
31636 lists.
31637
31638 A less inefficient way of solving this problem is available. If
31639 two domain names, comma-separated, are given, the second is used first to
31640 do an initial check, making use of any IP value restrictions that are set.
31641 If there is a match, the first domain is used, without any IP value
31642 restrictions, to get the TXT record. As a byproduct of this, there is also
31643 a check that the IP being tested is indeed on the first list. The first
31644 domain is the one that is put in &$dnslist_domain$&. For example:
31645 .code
31646 deny message  = \
31647          rejected because $sender_host_address is blacklisted \
31648          at $dnslist_domain\n$dnslist_text
31649        dnslists = \
31650          sbl.spamhaus.org,sbl-xbl.spamhaus.org=127.0.0.2 : \
31651          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
31652 .endd
31653 For the first blacklist item, this starts by doing a lookup in
31654 &'sbl-xbl.spamhaus.org'& and testing for a 127.0.0.2 return. If there is a
31655 match, it then looks in &'sbl.spamhaus.org'&, without checking the return
31656 value, and as long as something is found, it looks for the corresponding TXT
31657 record. If there is no match in &'sbl-xbl.spamhaus.org'&, nothing more is done.
31658 The second blacklist item is processed similarly.
31659
31660 If you are interested in more than one merged list, the same list must be
31661 given several times, but because the results of the DNS lookups are cached,
31662 the DNS calls themselves are not repeated. For example:
31663 .code
31664 deny dnslists = \
31665          http.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.2 : \
31666          socks.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.3 : \
31667          misc.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.4 : \
31668          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
31669 .endd
31670 In this case there is one lookup in &'dnsbl.sorbs.net'&, and if none of the IP
31671 values matches (or if no record is found), this is the only lookup that is
31672 done. Only if there is a match is one of the more specific lists consulted.
31673
31674
31675
31676 .section "DNS lists and IPv6" "SECTmorednslistslast"
31677 .cindex "IPv6" "DNS black lists"
31678 .cindex "DNS list" "IPv6 usage"
31679 If Exim is asked to do a dnslist lookup for an IPv6 address, it inverts it
31680 nibble by nibble. For example, if the calling host's IP address is
31681 3ffe:ffff:836f:0a00:000a:0800:200a:c031, Exim might look up
31682 .code
31683 1.3.0.c.a.0.0.2.0.0.8.0.a.0.0.0.0.0.a.0.f.6.3.8.
31684   f.f.f.f.e.f.f.3.blackholes.mail-abuse.org
31685 .endd
31686 (split over two lines here to fit on the page). Unfortunately, some of the DNS
31687 lists contain wildcard records, intended for IPv4, that interact badly with
31688 IPv6. For example, the DNS entry
31689 .code
31690 *.3.some.list.example.    A    127.0.0.1
31691 .endd
31692 is probably intended to put the entire 3.0.0.0/8 IPv4 network on the list.
31693 Unfortunately, it also matches the entire 3::/4 IPv6 network.
31694
31695 You can exclude IPv6 addresses from DNS lookups by making use of a suitable
31696 &%condition%& condition, as in this example:
31697 .code
31698 deny   condition = ${if isip4{$sender_host_address}}
31699        dnslists  = some.list.example
31700 .endd
31701
31702 If an explicit key is being used for a DNS lookup and it may be an IPv6
31703 address you should specify alternate list separators for both the outer
31704 (DNS list name) list and inner (lookup keys) list:
31705 .code
31706        dnslists = <; dnsbl.example.com/<|$acl_m_addrslist
31707 .endd
31708
31709 .section "Rate limiting incoming messages" "SECTratelimiting"
31710 .cindex "rate limiting" "client sending"
31711 .cindex "limiting client sending rates"
31712 .oindex "&%smtp_ratelimit_*%&"
31713 The &%ratelimit%& ACL condition can be used to measure and control the rate at
31714 which clients can send email. This is more powerful than the
31715 &%smtp_ratelimit_*%& options, because those options control the rate of
31716 commands in a single SMTP session only, whereas the &%ratelimit%& condition
31717 works across all connections (concurrent and sequential) from the same client
31718 host. The syntax of the &%ratelimit%& condition is:
31719 .display
31720 &`ratelimit =`& <&'m'&> &`/`& <&'p'&> &`/`& <&'options'&> &`/`& <&'key'&>
31721 .endd
31722 If the average client sending rate is less than &'m'& messages per time
31723 period &'p'& then the condition is false; otherwise it is true.
31724
31725 As a side-effect, the &%ratelimit%& condition sets the expansion variable
31726 &$sender_rate$& to the client's computed rate, &$sender_rate_limit$& to the
31727 configured value of &'m'&, and &$sender_rate_period$& to the configured value
31728 of &'p'&.
31729
31730 The parameter &'p'& is the smoothing time constant, in the form of an Exim
31731 time interval, for example, &`8h`& for eight hours. A larger time constant
31732 means that it takes Exim longer to forget a client's past behaviour. The
31733 parameter &'m'& is the maximum number of messages that a client is permitted to
31734 send in each time interval. It also specifies the number of messages permitted
31735 in a fast burst. By increasing both &'m'& and &'p'& but keeping &'m/p'&
31736 constant, you can allow a client to send more messages in a burst without
31737 changing its long-term sending rate limit. Conversely, if &'m'& and &'p'& are
31738 both small, messages must be sent at an even rate.
31739
31740 There is a script in &_util/ratelimit.pl_& which extracts sending rates from
31741 log files, to assist with choosing appropriate settings for &'m'& and &'p'&
31742 when deploying the &%ratelimit%& ACL condition. The script prints usage
31743 instructions when it is run with no arguments.
31744
31745 The key is used to look up the data for calculating the client's average
31746 sending rate. This data is stored in Exim's spool directory, alongside the
31747 retry and other hints databases. The default key is &$sender_host_address$&,
31748 which means Exim computes the sending rate of each client host IP address.
31749 By changing the key you can change how Exim identifies clients for the purpose
31750 of ratelimiting. For example, to limit the sending rate of each authenticated
31751 user, independent of the computer they are sending from, set the key to
31752 &$authenticated_id$&. You must ensure that the lookup key is meaningful; for
31753 example, &$authenticated_id$& is only meaningful if the client has
31754 authenticated (which you can check with the &%authenticated%& ACL condition).
31755
31756 The lookup key does not have to identify clients: If you want to limit the
31757 rate at which a recipient receives messages, you can use the key
31758 &`$local_part@$domain`& with the &%per_rcpt%& option (see below) in a RCPT
31759 ACL.
31760
31761 Each &%ratelimit%& condition can have up to four options. A &%per_*%& option
31762 specifies what Exim measures the rate of, for example, messages or recipients
31763 or bytes. You can adjust the measurement using the &%unique=%& and/or
31764 &%count=%& options. You can also control when Exim updates the recorded rate
31765 using a &%strict%&, &%leaky%&, or &%readonly%& option. The options are
31766 separated by a slash, like the other parameters. They may appear in any order.
31767
31768 Internally, Exim appends the smoothing constant &'p'& onto the lookup key with
31769 any options that alter the meaning of the stored data. The limit &'m'& is not
31770 stored, so you can alter the configured maximum rate and Exim will still
31771 remember clients' past behaviour. If you change the &%per_*%& mode or add or
31772 remove the &%unique=%& option, the lookup key changes so Exim will forget past
31773 behaviour. The lookup key is not affected by changes to the update mode and
31774 the &%count=%& option.
31775
31776
31777 .section "Ratelimit options for what is being measured" "ratoptmea"
31778 .cindex "rate limiting" "per_* options"
31779 The &%per_conn%& option limits the client's connection rate. It is not
31780 normally used in the &%acl_not_smtp%&, &%acl_not_smtp_mime%&, or
31781 &%acl_not_smtp_start%& ACLs.
31782
31783 The &%per_mail%& option limits the client's rate of sending messages. This is
31784 the default if none of the &%per_*%& options is specified. It can be used in
31785 &%acl_smtp_mail%&, &%acl_smtp_rcpt%&, &%acl_smtp_predata%&, &%acl_smtp_mime%&,
31786 &%acl_smtp_data%&, or &%acl_not_smtp%&.
31787
31788 The &%per_byte%& option limits the sender's email bandwidth. It can be used in
31789 the same ACLs as the &%per_mail%& option, though it is best to use this option
31790 in the &%acl_smtp_mime%&, &%acl_smtp_data%& or &%acl_not_smtp%& ACLs; if it is
31791 used in an earlier ACL, Exim relies on the SIZE parameter given by the client
31792 in its MAIL command, which may be inaccurate or completely missing. You can
31793 follow the limit &'m'& in the configuration with K, M, or G to specify limits
31794 in kilobytes, megabytes, or gigabytes, respectively.
31795
31796 The &%per_rcpt%& option causes Exim to limit the rate at which recipients are
31797 accepted. It can be used in the &%acl_smtp_rcpt%&, &%acl_smtp_predata%&,
31798 &%acl_smtp_mime%&, &%acl_smtp_data%&, or &%acl_smtp_rcpt%& ACLs. In
31799 &%acl_smtp_rcpt%& the rate is updated one recipient at a time; in the other
31800 ACLs the rate is updated with the total (accepted) recipient count in one go. Note that
31801 in either case the rate limiting engine will see a message with many
31802 recipients as a large high-speed burst.
31803
31804 The &%per_addr%& option is like the &%per_rcpt%& option, except it counts the
31805 number of different recipients that the client has sent messages to in the
31806 last time period. That is, if the client repeatedly sends messages to the same
31807 recipient, its measured rate is not increased. This option can only be used in
31808 &%acl_smtp_rcpt%&.
31809
31810 The &%per_cmd%& option causes Exim to recompute the rate every time the
31811 condition is processed. This can be used to limit the rate of any SMTP
31812 command. If it is used in multiple ACLs it can limit the aggregate rate of
31813 multiple different commands.
31814
31815 The &%count=%& option can be used to alter how much Exim adds to the client's
31816 measured rate. For example, the &%per_byte%& option is equivalent to
31817 &`per_mail/count=$message_size`&. If there is no &%count=%& option, Exim
31818 increases the measured rate by one (except for the &%per_rcpt%& option in ACLs
31819 other than &%acl_smtp_rcpt%&). The count does not have to be an integer.
31820
31821 The &%unique=%& option is described in section &<<ratoptuniq>>& below.
31822
31823
31824 .section "Ratelimit update modes" "ratoptupd"
31825 .cindex "rate limiting" "reading data without updating"
31826 You can specify one of three options with the &%ratelimit%& condition to
31827 control when its database is updated. This section describes the &%readonly%&
31828 mode, and the next section describes the &%strict%& and &%leaky%& modes.
31829
31830 If the &%ratelimit%& condition is used in &%readonly%& mode, Exim looks up a
31831 previously-computed rate to check against the limit.
31832
31833 For example, you can test the client's sending rate and deny it access (when
31834 it is too fast) in the connect ACL. If the client passes this check then it
31835 can go on to send a message, in which case its recorded rate will be updated
31836 in the MAIL ACL. Subsequent connections from the same client will check this
31837 new rate.
31838 .code
31839 acl_check_connect:
31840  deny ratelimit = 100 / 5m / readonly
31841     log_message = RATE CHECK: $sender_rate/$sender_rate_period \
31842                   (max $sender_rate_limit)
31843 # ...
31844 acl_check_mail:
31845  warn ratelimit = 100 / 5m / strict
31846     log_message = RATE UPDATE: $sender_rate/$sender_rate_period \
31847                   (max $sender_rate_limit)
31848 .endd
31849
31850 If Exim encounters multiple &%ratelimit%& conditions with the same key when
31851 processing a message then it may increase the client's measured rate more than
31852 it should. For example, this will happen if you check the &%per_rcpt%& option
31853 in both &%acl_smtp_rcpt%& and &%acl_smtp_data%&. However it's OK to check the
31854 same &%ratelimit%& condition multiple times in the same ACL. You can avoid any
31855 multiple update problems by using the &%readonly%& option on later ratelimit
31856 checks.
31857
31858 The &%per_*%& options described above do not make sense in some ACLs. If you
31859 use a &%per_*%& option in an ACL where it is not normally permitted then the
31860 update mode defaults to &%readonly%& and you cannot specify the &%strict%& or
31861 &%leaky%& modes. In other ACLs the default update mode is &%leaky%& (see the
31862 next section) so you must specify the &%readonly%& option explicitly.
31863
31864
31865 .section "Ratelimit options for handling fast clients" "ratoptfast"
31866 .cindex "rate limiting" "strict and leaky modes"
31867 If a client's average rate is greater than the maximum, the rate limiting
31868 engine can react in two possible ways, depending on the presence of the
31869 &%strict%& or &%leaky%& update modes. This is independent of the other
31870 counter-measures (such as rejecting the message) that may be specified by the
31871 rest of the ACL.
31872
31873 The &%leaky%& (default) option means that the client's recorded rate is not
31874 updated if it is above the limit. The effect of this is that Exim measures the
31875 client's average rate of successfully sent email,
31876 up to the given limit.
31877 This is appropriate if the countermeasure when the condition is true
31878 consists of refusing the message, and
31879 is generally the better choice if you have clients that retry automatically.
31880 If the action when true is anything more complex then this option is
31881 likely not what is wanted.
31882
31883 The &%strict%& option means that the client's recorded rate is always
31884 updated. The effect of this is that Exim measures the client's average rate
31885 of attempts to send email, which can be much higher than the maximum it is
31886 actually allowed. If the client is over the limit it may be subjected to
31887 counter-measures by the ACL. It must slow down and allow sufficient time to
31888 pass that its computed rate falls below the maximum before it can send email
31889 again. The time (the number of smoothing periods) it must wait and not
31890 attempt to send mail can be calculated with this formula:
31891 .code
31892         ln(peakrate/maxrate)
31893 .endd
31894
31895
31896 .section "Limiting the rate of different events" "ratoptuniq"
31897 .cindex "rate limiting" "counting unique events"
31898 The &%ratelimit%& &%unique=%& option controls a mechanism for counting the
31899 rate of different events. For example, the &%per_addr%& option uses this
31900 mechanism to count the number of different recipients that the client has
31901 sent messages to in the last time period; it is equivalent to
31902 &`per_rcpt/unique=$local_part@$domain`&. You could use this feature to
31903 measure the rate that a client uses different sender addresses with the
31904 options &`per_mail/unique=$sender_address`&.
31905
31906 For each &%ratelimit%& key Exim stores the set of &%unique=%& values that it
31907 has seen for that key. The whole set is thrown away when it is older than the
31908 rate smoothing period &'p'&, so each different event is counted at most once
31909 per period. In the &%leaky%& update mode, an event that causes the client to
31910 go over the limit is not added to the set, in the same way that the client's
31911 recorded rate is not updated in the same situation.
31912
31913 When you combine the &%unique=%& and &%readonly%& options, the specific
31914 &%unique=%& value is ignored, and Exim just retrieves the client's stored
31915 rate.
31916
31917 The &%unique=%& mechanism needs more space in the ratelimit database than the
31918 other &%ratelimit%& options in order to store the event set. The number of
31919 unique values is potentially as large as the rate limit, so the extra space
31920 required increases with larger limits.
31921
31922 The uniqueification is not perfect: there is a small probability that Exim
31923 will think a new event has happened before. If the sender's rate is less than
31924 the limit, Exim should be more than 99.9% correct. However in &%strict%& mode
31925 the measured rate can go above the limit, in which case Exim may under-count
31926 events by a significant margin. Fortunately, if the rate is high enough (2.7
31927 times the limit) that the false positive rate goes above 9%, then Exim will
31928 throw away the over-full event set before the measured rate falls below the
31929 limit. Therefore the only harm should be that exceptionally high sending rates
31930 are logged incorrectly; any countermeasures you configure will be as effective
31931 as intended.
31932
31933
31934 .section "Using rate limiting" "useratlim"
31935 Exim's other ACL facilities are used to define what counter-measures are taken
31936 when the rate limit is exceeded. This might be anything from logging a warning
31937 (for example, while measuring existing sending rates in order to define
31938 policy), through time delays to slow down fast senders, up to rejecting the
31939 message. For example:
31940 .code
31941 # Log all senders' rates
31942 warn ratelimit = 0 / 1h / strict
31943      log_message = Sender rate $sender_rate / $sender_rate_period
31944
31945 # Slow down fast senders; note the need to truncate $sender_rate
31946 # at the decimal point.
31947 warn ratelimit = 100 / 1h / per_rcpt / strict
31948      delay     = ${eval: ${sg{$sender_rate}{[.].*}{}} - \
31949                    $sender_rate_limit }s
31950
31951 # Keep authenticated users under control
31952 deny authenticated = *
31953      ratelimit = 100 / 1d / strict / $authenticated_id
31954
31955 # System-wide rate limit
31956 defer message = Sorry, too busy. Try again later.
31957      ratelimit = 10 / 1s / $primary_hostname
31958
31959 # Restrict incoming rate from each host, with a default
31960 # set using a macro and special cases looked up in a table.
31961 defer message = Sender rate exceeds $sender_rate_limit \
31962                messages per $sender_rate_period
31963      ratelimit = ${lookup {$sender_host_address} \
31964                    cdb {DB/ratelimits.cdb} \
31965                    {$value} {RATELIMIT} }
31966 .endd
31967 &*Warning*&: If you have a busy server with a lot of &%ratelimit%& tests,
31968 especially with the &%per_rcpt%& option, you may suffer from a performance
31969 bottleneck caused by locking on the ratelimit hints database. Apart from
31970 making your ACLs less complicated, you can reduce the problem by using a
31971 RAM disk for Exim's hints directory (usually &_/var/spool/exim/db/_&). However
31972 this means that Exim will lose its hints data after a reboot (including retry
31973 hints, the callout cache, and ratelimit data).
31974
31975
31976
31977 .section "Address verification" "SECTaddressverification"
31978 .cindex "verifying address" "options for"
31979 .cindex "policy control" "address verification"
31980 Several of the &%verify%& conditions described in section
31981 &<<SECTaclconditions>>& cause addresses to be verified. Section
31982 &<<SECTsenaddver>>& discusses the reporting of sender verification failures.
31983 The verification conditions can be followed by options that modify the
31984 verification process. The options are separated from the keyword and from each
31985 other by slashes, and some of them contain parameters. For example:
31986 .code
31987 verify = sender/callout
31988 verify = recipient/defer_ok/callout=10s,defer_ok
31989 .endd
31990 The first stage of address verification, which always happens, is to run the
31991 address through the routers, in &"verify mode"&. Routers can detect the
31992 difference between verification and routing for delivery, and their actions can
31993 be varied by a number of generic options such as &%verify%& and &%verify_only%&
31994 (see chapter &<<CHAProutergeneric>>&). If routing fails, verification fails.
31995 The available options are as follows:
31996
31997 .ilist
31998 If the &%callout%& option is specified, successful routing to one or more
31999 remote hosts is followed by a &"callout"& to those hosts as an additional
32000 check. Callouts and their sub-options are discussed in the next section.
32001 .next
32002 If there is a defer error while doing verification routing, the ACL
32003 normally returns &"defer"&. However, if you include &%defer_ok%& in the
32004 options, the condition is forced to be true instead. Note that this is a main
32005 verification option as well as a suboption for callouts.
32006 .next
32007 The &%no_details%& option is covered in section &<<SECTsenaddver>>&, which
32008 discusses the reporting of sender address verification failures.
32009 .next
32010 The &%success_on_redirect%& option causes verification always to succeed
32011 immediately after a successful redirection. By default, if a redirection
32012 generates just one address, that address is also verified. See further
32013 discussion in section &<<SECTredirwhilveri>>&.
32014 .endlist
32015
32016 .cindex "verifying address" "differentiating failures"
32017 .vindex "&$recipient_verify_failure$&"
32018 .vindex "&$sender_verify_failure$&"
32019 .vindex "&$acl_verify_message$&"
32020 After an address verification failure, &$acl_verify_message$& contains the
32021 error message that is associated with the failure. It can be preserved by
32022 coding like this:
32023 .code
32024 warn  !verify = sender
32025        set acl_m0 = $acl_verify_message
32026 .endd
32027 If you are writing your own custom rejection message or log message when
32028 denying access, you can use this variable to include information about the
32029 verification failure.
32030
32031 In addition, &$sender_verify_failure$& or &$recipient_verify_failure$& (as
32032 appropriate) contains one of the following words:
32033
32034 .ilist
32035 &%qualify%&: The address was unqualified (no domain), and the message
32036 was neither local nor came from an exempted host.
32037 .next
32038 &%route%&: Routing failed.
32039 .next
32040 &%mail%&: Routing succeeded, and a callout was attempted; rejection
32041 occurred at or before the MAIL command (that is, on initial
32042 connection, HELO, or MAIL).
32043 .next
32044 &%recipient%&: The RCPT command in a callout was rejected.
32045 .next
32046 &%postmaster%&: The postmaster check in a callout was rejected.
32047 .endlist
32048
32049 The main use of these variables is expected to be to distinguish between
32050 rejections of MAIL and rejections of RCPT in callouts.
32051
32052 The above variables may also be set after a &*successful*&
32053 address verification to:
32054
32055 .ilist
32056 &%random%&: A random local-part callout succeeded
32057 .endlist
32058
32059
32060
32061
32062 .section "Callout verification" "SECTcallver"
32063 .cindex "verifying address" "by callout"
32064 .cindex "callout" "verification"
32065 .cindex "SMTP" "callout verification"
32066 For non-local addresses, routing verifies the domain, but is unable to do any
32067 checking of the local part. There are situations where some means of verifying
32068 the local part is desirable. One way this can be done is to make an SMTP
32069 &'callback'& to a delivery host for the sender address or a &'callforward'& to
32070 a subsequent host for a recipient address, to see if the host accepts the
32071 address. We use the term &'callout'& to cover both cases. Note that for a
32072 sender address, the callback is not to the client host that is trying to
32073 deliver the message, but to one of the hosts that accepts incoming mail for the
32074 sender's domain.
32075
32076 Exim does not do callouts by default. If you want them to happen, you must
32077 request them by setting appropriate options on the &%verify%& condition, as
32078 described below. This facility should be used with care, because it can add a
32079 lot of resource usage to the cost of verifying an address. However, Exim does
32080 cache the results of callouts, which helps to reduce the cost. Details of
32081 caching are in section &<<SECTcallvercache>>&.
32082
32083 Recipient callouts are usually used only between hosts that are controlled by
32084 the same administration. For example, a corporate gateway host could use
32085 callouts to check for valid recipients on an internal mailserver. A successful
32086 callout does not guarantee that a real delivery to the address would succeed;
32087 on the other hand, a failing callout does guarantee that a delivery would fail.
32088
32089 If the &%callout%& option is present on a condition that verifies an address, a
32090 second stage of verification occurs if the address is successfully routed to
32091 one or more remote hosts. The usual case is routing by a &(dnslookup)& or a
32092 &(manualroute)& router, where the router specifies the hosts. However, if a
32093 router that does not set up hosts routes to an &(smtp)& transport with a
32094 &%hosts%& setting, the transport's hosts are used. If an &(smtp)& transport has
32095 &%hosts_override%& set, its hosts are always used, whether or not the router
32096 supplies a host list.
32097 Callouts are only supported on &(smtp)& transports.
32098
32099 The port that is used is taken from the transport, if it is specified and is a
32100 remote transport. (For routers that do verification only, no transport need be
32101 specified.) Otherwise, the default SMTP port is used. If a remote transport
32102 specifies an outgoing interface, this is used; otherwise the interface is not
32103 specified. Likewise, the text that is used for the HELO command is taken from
32104 the transport's &%helo_data%& option; if there is no transport, the value of
32105 &$smtp_active_hostname$& is used.
32106
32107 For a sender callout check, Exim makes SMTP connections to the remote hosts, to
32108 test whether a bounce message could be delivered to the sender address. The
32109 following SMTP commands are sent:
32110 .display
32111 &`HELO `&<&'local host name'&>
32112 &`MAIL FROM:<>`&
32113 &`RCPT TO:`&<&'the address to be tested'&>
32114 &`QUIT`&
32115 .endd
32116 LHLO is used instead of HELO if the transport's &%protocol%& option is
32117 set to &"lmtp"&.
32118
32119 The callout may use EHLO, AUTH and/or STARTTLS given appropriate option
32120 settings.
32121
32122 A recipient callout check is similar. By default, it also uses an empty address
32123 for the sender. This default is chosen because most hosts do not make use of
32124 the sender address when verifying a recipient. Using the same address means
32125 that a single cache entry can be used for each recipient. Some sites, however,
32126 do make use of the sender address when verifying. These are catered for by the
32127 &%use_sender%& and &%use_postmaster%& options, described in the next section.
32128
32129 If the response to the RCPT command is a 2&'xx'& code, the verification
32130 succeeds. If it is 5&'xx'&, the verification fails. For any other condition,
32131 Exim tries the next host, if any. If there is a problem with all the remote
32132 hosts, the ACL yields &"defer"&, unless the &%defer_ok%& parameter of the
32133 &%callout%& option is given, in which case the condition is forced to succeed.
32134
32135 .cindex "SMTP" "output flushing, disabling for callout"
32136 A callout may take a little time. For this reason, Exim normally flushes SMTP
32137 output before performing a callout in an ACL, to avoid unexpected timeouts in
32138 clients when the SMTP PIPELINING extension is in use. The flushing can be
32139 disabled by using a &%control%& modifier to set &%no_callout_flush%&.
32140
32141
32142
32143
32144 .section "Additional parameters for callouts" "CALLaddparcall"
32145 .cindex "callout" "additional parameters for"
32146 The &%callout%& option can be followed by an equals sign and a number of
32147 optional parameters, separated by commas. For example:
32148 .code
32149 verify = recipient/callout=10s,defer_ok
32150 .endd
32151 The old syntax, which had &%callout_defer_ok%& and &%check_postmaster%& as
32152 separate verify options, is retained for backwards compatibility, but is now
32153 deprecated. The additional parameters for &%callout%& are as follows:
32154
32155
32156 .vlist
32157 .vitem <&'a&~time&~interval'&>
32158 .cindex "callout" "timeout, specifying"
32159 This specifies the timeout that applies for the callout attempt to each host.
32160 For example:
32161 .code
32162 verify = sender/callout=5s
32163 .endd
32164 The default is 30 seconds. The timeout is used for each response from the
32165 remote host. It is also used for the initial connection, unless overridden by
32166 the &%connect%& parameter.
32167
32168
32169 .vitem &*connect&~=&~*&<&'time&~interval'&>
32170 .cindex "callout" "connection timeout, specifying"
32171 This parameter makes it possible to set a different (usually smaller) timeout
32172 for making the SMTP connection. For example:
32173 .code
32174 verify = sender/callout=5s,connect=1s
32175 .endd
32176 If not specified, this timeout defaults to the general timeout value.
32177
32178 .vitem &*defer_ok*&
32179 .cindex "callout" "defer, action on"
32180 When this parameter is present, failure to contact any host, or any other kind
32181 of temporary error, is treated as success by the ACL. However, the cache is not
32182 updated in this circumstance.
32183
32184 .vitem &*fullpostmaster*&
32185 .cindex "callout" "full postmaster check"
32186 This operates like the &%postmaster%& option (see below), but if the check for
32187 &'postmaster@domain'& fails, it tries just &'postmaster'&, without a domain, in
32188 accordance with the specification in RFC 2821. The RFC states that the
32189 unqualified address &'postmaster'& should be accepted.
32190
32191
32192 .vitem &*mailfrom&~=&~*&<&'email&~address'&>
32193 .cindex "callout" "sender when verifying header"
32194 When verifying addresses in header lines using the &%header_sender%&
32195 verification option, Exim behaves by default as if the addresses are envelope
32196 sender addresses from a message. Callout verification therefore tests to see
32197 whether a bounce message could be delivered, by using an empty address in the
32198 MAIL command. However, it is arguable that these addresses might never be used
32199 as envelope senders, and could therefore justifiably reject bounce messages
32200 (empty senders). The &%mailfrom%& callout parameter allows you to specify what
32201 address to use in the MAIL command. For example:
32202 .code
32203 require  verify = header_sender/callout=mailfrom=abcd@x.y.z
32204 .endd
32205 This parameter is available only for the &%header_sender%& verification option.
32206
32207
32208 .vitem &*maxwait&~=&~*&<&'time&~interval'&>
32209 .cindex "callout" "overall timeout, specifying"
32210 This parameter sets an overall timeout for performing a callout verification.
32211 For example:
32212 .code
32213 verify = sender/callout=5s,maxwait=30s
32214 .endd
32215 This timeout defaults to four times the callout timeout for individual SMTP
32216 commands. The overall timeout applies when there is more than one host that can
32217 be tried. The timeout is checked before trying the next host. This prevents
32218 very long delays if there are a large number of hosts and all are timing out
32219 (for example, when network connections are timing out).
32220
32221
32222 .vitem &*no_cache*&
32223 .cindex "callout" "cache, suppressing"
32224 .cindex "caching callout, suppressing"
32225 When this parameter is given, the callout cache is neither read nor updated.
32226
32227 .vitem &*postmaster*&
32228 .cindex "callout" "postmaster; checking"
32229 When this parameter is set, a successful callout check is followed by a similar
32230 check for the local part &'postmaster'& at the same domain. If this address is
32231 rejected, the callout fails (but see &%fullpostmaster%& above). The result of
32232 the postmaster check is recorded in a cache record; if it is a failure, this is
32233 used to fail subsequent callouts for the domain without a connection being
32234 made, until the cache record expires.
32235
32236 .vitem &*postmaster_mailfrom&~=&~*&<&'email&~address'&>
32237 The postmaster check uses an empty sender in the MAIL command by default.
32238 You can use this parameter to do a postmaster check using a different address.
32239 For example:
32240 .code
32241 require  verify = sender/callout=postmaster_mailfrom=abc@x.y.z
32242 .endd
32243 If both &%postmaster%& and &%postmaster_mailfrom%& are present, the rightmost
32244 one overrides. The &%postmaster%& parameter is equivalent to this example:
32245 .code
32246 require  verify = sender/callout=postmaster_mailfrom=
32247 .endd
32248 &*Warning*&: The caching arrangements for postmaster checking do not take
32249 account of the sender address. It is assumed that either the empty address or
32250 a fixed non-empty address will be used. All that Exim remembers is that the
32251 postmaster check for the domain succeeded or failed.
32252
32253
32254 .vitem &*random*&
32255 .cindex "callout" "&""random""& check"
32256 When this parameter is set, before doing the normal callout check, Exim does a
32257 check for a &"random"& local part at the same domain. The local part is not
32258 really random &-- it is defined by the expansion of the option
32259 &%callout_random_local_part%&, which defaults to
32260 .code
32261 $primary_hostname-$tod_epoch-testing
32262 .endd
32263 The idea here is to try to determine whether the remote host accepts all local
32264 parts without checking. If it does, there is no point in doing callouts for
32265 specific local parts. If the &"random"& check succeeds, the result is saved in
32266 a cache record, and used to force the current and subsequent callout checks to
32267 succeed without a connection being made, until the cache record expires.
32268
32269 .vitem &*use_postmaster*&
32270 .cindex "callout" "sender for recipient check"
32271 This parameter applies to recipient callouts only. For example:
32272 .code
32273 deny  !verify = recipient/callout=use_postmaster
32274 .endd
32275 .vindex "&$qualify_domain$&"
32276 It causes a non-empty postmaster address to be used in the MAIL command when
32277 performing the callout for the recipient, and also for a &"random"& check if
32278 that is configured. The local part of the address is &`postmaster`& and the
32279 domain is the contents of &$qualify_domain$&.
32280
32281 .vitem &*use_sender*&
32282 This option applies to recipient callouts only. For example:
32283 .code
32284 require  verify = recipient/callout=use_sender
32285 .endd
32286 It causes the message's actual sender address to be used in the MAIL
32287 command when performing the callout, instead of an empty address. There is no
32288 need to use this option unless you know that the called hosts make use of the
32289 sender when checking recipients. If used indiscriminately, it reduces the
32290 usefulness of callout caching.
32291
32292 .vitem &*hold*&
32293 This option applies to recipient callouts only. For example:
32294 .code
32295 require  verify = recipient/callout=use_sender,hold
32296 .endd
32297 It causes the connection to be held open and used for any further recipients
32298 and for eventual delivery (should that be done quickly).
32299 Doing this saves on TCP and SMTP startup costs, and TLS costs also
32300 when that is used for the connections.
32301 The advantage is only gained if there are no callout cache hits
32302 (which could be enforced by the no_cache option),
32303 if the use_sender option is used,
32304 if neither the random nor the use_postmaster option is used,
32305 and if no other callouts intervene.
32306 .endlist
32307
32308 If you use any of the parameters that set a non-empty sender for the MAIL
32309 command (&%mailfrom%&, &%postmaster_mailfrom%&, &%use_postmaster%&, or
32310 &%use_sender%&), you should think about possible loops. Recipient checking is
32311 usually done between two hosts that are under the same management, and the host
32312 that receives the callouts is not normally configured to do callouts itself.
32313 Therefore, it is normally safe to use &%use_postmaster%& or &%use_sender%& in
32314 these circumstances.
32315
32316 However, if you use a non-empty sender address for a callout to an arbitrary
32317 host, there is the likelihood that the remote host will itself initiate a
32318 callout check back to your host. As it is checking what appears to be a message
32319 sender, it is likely to use an empty address in MAIL, thus avoiding a
32320 callout loop. However, to be on the safe side it would be best to set up your
32321 own ACLs so that they do not do sender verification checks when the recipient
32322 is the address you use for header sender or postmaster callout checking.
32323
32324 Another issue to think about when using non-empty senders for callouts is
32325 caching. When you set &%mailfrom%& or &%use_sender%&, the cache record is keyed
32326 by the sender/recipient combination; thus, for any given recipient, many more
32327 actual callouts are performed than when an empty sender or postmaster is used.
32328
32329
32330
32331
32332 .section "Callout caching" "SECTcallvercache"
32333 .cindex "hints database" "callout cache"
32334 .cindex "callout" "cache, description of"
32335 .cindex "caching" "callout"
32336 Exim caches the results of callouts in order to reduce the amount of resources
32337 used, unless you specify the &%no_cache%& parameter with the &%callout%&
32338 option. A hints database called &"callout"& is used for the cache. Two
32339 different record types are used: one records the result of a callout check for
32340 a specific address, and the other records information that applies to the
32341 entire domain (for example, that it accepts the local part &'postmaster'&).
32342
32343 When an original callout fails, a detailed SMTP error message is given about
32344 the failure. However, for subsequent failures use the cache data, this message
32345 is not available.
32346
32347 The expiry times for negative and positive address cache records are
32348 independent, and can be set by the global options &%callout_negative_expire%&
32349 (default 2h) and &%callout_positive_expire%& (default 24h), respectively.
32350
32351 If a host gives a negative response to an SMTP connection, or rejects any
32352 commands up to and including
32353 .code
32354 MAIL FROM:<>
32355 .endd
32356 (but not including the MAIL command with a non-empty address),
32357 any callout attempt is bound to fail. Exim remembers such failures in a
32358 domain cache record, which it uses to fail callouts for the domain without
32359 making new connections, until the domain record times out. There are two
32360 separate expiry times for domain cache records:
32361 &%callout_domain_negative_expire%& (default 3h) and
32362 &%callout_domain_positive_expire%& (default 7d).
32363
32364 Domain records expire when the negative expiry time is reached if callouts
32365 cannot be made for the domain, or if the postmaster check failed.
32366 Otherwise, they expire when the positive expiry time is reached. This
32367 ensures that, for example, a host that stops accepting &"random"& local parts
32368 will eventually be noticed.
32369
32370 The callout caching mechanism is based on the domain of the address that is
32371 being tested. If the domain routes to several hosts, it is assumed that their
32372 behaviour will be the same.
32373
32374
32375
32376 .section "Sender address verification reporting" "SECTsenaddver"
32377 .cindex "verifying" "suppressing error details"
32378 See section &<<SECTaddressverification>>& for a general discussion of
32379 verification. When sender verification fails in an ACL, the details of the
32380 failure are given as additional output lines before the 550 response to the
32381 relevant SMTP command (RCPT or DATA). For example, if sender callout is in use,
32382 you might see:
32383 .code
32384 MAIL FROM:<xyz@abc.example>
32385 250 OK
32386 RCPT TO:<pqr@def.example>
32387 550-Verification failed for <xyz@abc.example>
32388 550-Called:   192.168.34.43
32389 550-Sent:     RCPT TO:<xyz@abc.example>
32390 550-Response: 550 Unknown local part xyz in <xyz@abc.example>
32391 550 Sender verification failed
32392 .endd
32393 If more than one RCPT command fails in the same way, the details are given
32394 only for the first of them. However, some administrators do not want to send
32395 out this much information. You can suppress the details by adding
32396 &`/no_details`& to the ACL statement that requests sender verification. For
32397 example:
32398 .code
32399 verify = sender/no_details
32400 .endd
32401
32402 .section "Redirection while verifying" "SECTredirwhilveri"
32403 .cindex "verifying" "redirection while"
32404 .cindex "address redirection" "while verifying"
32405 A dilemma arises when a local address is redirected by aliasing or forwarding
32406 during verification: should the generated addresses themselves be verified,
32407 or should the successful expansion of the original address be enough to verify
32408 it? By default, Exim takes the following pragmatic approach:
32409
32410 .ilist
32411 When an incoming address is redirected to just one child address, verification
32412 continues with the child address, and if that fails to verify, the original
32413 verification also fails.
32414 .next
32415 When an incoming address is redirected to more than one child address,
32416 verification does not continue. A success result is returned.
32417 .endlist
32418
32419 This seems the most reasonable behaviour for the common use of aliasing as a
32420 way of redirecting different local parts to the same mailbox. It means, for
32421 example, that a pair of alias entries of the form
32422 .code
32423 A.Wol:   aw123
32424 aw123:   :fail: Gone away, no forwarding address
32425 .endd
32426 work as expected, with both local parts causing verification failure. When a
32427 redirection generates more than one address, the behaviour is more like a
32428 mailing list, where the existence of the alias itself is sufficient for
32429 verification to succeed.
32430
32431 It is possible, however, to change the default behaviour so that all successful
32432 redirections count as successful verifications, however many new addresses are
32433 generated. This is specified by the &%success_on_redirect%& verification
32434 option. For example:
32435 .code
32436 require verify = recipient/success_on_redirect/callout=10s
32437 .endd
32438 In this example, verification succeeds if a router generates a new address, and
32439 the callout does not occur, because no address was routed to a remote host.
32440
32441 When verification is being tested via the &%-bv%& option, the treatment of
32442 redirections is as just described, unless the &%-v%& or any debugging option is
32443 also specified. In that case, full verification is done for every generated
32444 address and a report is output for each of them.
32445
32446
32447
32448 .section "Client SMTP authorization (CSA)" "SECTverifyCSA"
32449 .cindex "CSA" "verifying"
32450 Client SMTP Authorization is a system that allows a site to advertise
32451 which machines are and are not permitted to send email. This is done by placing
32452 special SRV records in the DNS; these are looked up using the client's HELO
32453 domain. At the time of writing, CSA is still an Internet Draft. Client SMTP
32454 Authorization checks in Exim are performed by the ACL condition:
32455 .code
32456 verify = csa
32457 .endd
32458 This fails if the client is not authorized. If there is a DNS problem, or if no
32459 valid CSA SRV record is found, or if the client is authorized, the condition
32460 succeeds. These three cases can be distinguished using the expansion variable
32461 &$csa_status$&, which can take one of the values &"fail"&, &"defer"&,
32462 &"unknown"&, or &"ok"&. The condition does not itself defer because that would
32463 be likely to cause problems for legitimate email.
32464
32465 The error messages produced by the CSA code include slightly more
32466 detail. If &$csa_status$& is &"defer"&, this may be because of problems
32467 looking up the CSA SRV record, or problems looking up the CSA target
32468 address record. There are four reasons for &$csa_status$& being &"fail"&:
32469
32470 .ilist
32471 The client's host name is explicitly not authorized.
32472 .next
32473 The client's IP address does not match any of the CSA target IP addresses.
32474 .next
32475 The client's host name is authorized but it has no valid target IP addresses
32476 (for example, the target's addresses are IPv6 and the client is using IPv4).
32477 .next
32478 The client's host name has no CSA SRV record but a parent domain has asserted
32479 that all subdomains must be explicitly authorized.
32480 .endlist
32481
32482 The &%csa%& verification condition can take an argument which is the domain to
32483 use for the DNS query. The default is:
32484 .code
32485 verify = csa/$sender_helo_name
32486 .endd
32487 This implementation includes an extension to CSA. If the query domain
32488 is an address literal such as [192.0.2.95], or if it is a bare IP
32489 address, Exim searches for CSA SRV records in the reverse DNS as if
32490 the HELO domain was (for example) &'95.2.0.192.in-addr.arpa'&. Therefore it is
32491 meaningful to say:
32492 .code
32493 verify = csa/$sender_host_address
32494 .endd
32495 In fact, this is the check that Exim performs if the client does not say HELO.
32496 This extension can be turned off by setting the main configuration option
32497 &%dns_csa_use_reverse%& to be false.
32498
32499 If a CSA SRV record is not found for the domain itself, a search
32500 is performed through its parent domains for a record which might be
32501 making assertions about subdomains. The maximum depth of this search is limited
32502 using the main configuration option &%dns_csa_search_limit%&, which is 5 by
32503 default. Exim does not look for CSA SRV records in a top level domain, so the
32504 default settings handle HELO domains as long as seven
32505 (&'hostname.five.four.three.two.one.com'&). This encompasses the vast majority
32506 of legitimate HELO domains.
32507
32508 The &'dnsdb'& lookup also has support for CSA. Although &'dnsdb'& also supports
32509 direct SRV lookups, this is not sufficient because of the extra parent domain
32510 search behaviour of CSA, and (as with PTR lookups) &'dnsdb'& also turns IP
32511 addresses into lookups in the reverse DNS space. The result of a successful
32512 lookup such as:
32513 .code
32514 ${lookup dnsdb {csa=$sender_helo_name}}
32515 .endd
32516 has two space-separated fields: an authorization code and a target host name.
32517 The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
32518 authorization required but absent, or &"?"& for unknown.
32519
32520
32521
32522
32523 .section "Bounce address tag validation" "SECTverifyPRVS"
32524 .cindex "BATV, verifying"
32525 Bounce address tag validation (BATV) is a scheme whereby the envelope senders
32526 of outgoing messages have a cryptographic, timestamped &"tag"& added to them.
32527 Genuine incoming bounce messages should therefore always be addressed to
32528 recipients that have a valid tag. This scheme is a way of detecting unwanted
32529 bounce messages caused by sender address forgeries (often called &"collateral
32530 spam"&), because the recipients of such messages do not include valid tags.
32531
32532 There are two expansion items to help with the implementation of the BATV
32533 &"prvs"& (private signature) scheme in an Exim configuration. This scheme signs
32534 the original envelope sender address by using a simple key to add a hash of the
32535 address and some time-based randomizing information. The &%prvs%& expansion
32536 item creates a signed address, and the &%prvscheck%& expansion item checks one.
32537 The syntax of these expansion items is described in section
32538 &<<SECTexpansionitems>>&.
32539 The validity period on signed addresses is seven days.
32540
32541 As an example, suppose the secret per-address keys are stored in an MySQL
32542 database. A query to look up the key for an address could be defined as a macro
32543 like this:
32544 .code
32545 PRVSCHECK_SQL = ${lookup mysql{SELECT secret FROM batv_prvs \
32546                 WHERE sender='${quote_mysql:$prvscheck_address}'\
32547                 }{$value}}
32548 .endd
32549 Suppose also that the senders who make use of BATV are defined by an address
32550 list called &%batv_senders%&. Then, in the ACL for RCPT commands, you could
32551 use this:
32552 .code
32553 # Bounces: drop unsigned addresses for BATV senders
32554 deny message = This address does not send an unsigned reverse path
32555      senders = :
32556      recipients = +batv_senders
32557
32558 # Bounces: In case of prvs-signed address, check signature.
32559 deny message = Invalid reverse path signature.
32560      senders = :
32561      condition  = ${prvscheck {$local_part@$domain}\
32562                   {PRVSCHECK_SQL}{1}}
32563      !condition = $prvscheck_result
32564 .endd
32565 The first statement rejects recipients for bounce messages that are addressed
32566 to plain BATV sender addresses, because it is known that BATV senders do not
32567 send out messages with plain sender addresses. The second statement rejects
32568 recipients that are prvs-signed, but with invalid signatures (either because
32569 the key is wrong, or the signature has timed out).
32570
32571 A non-prvs-signed address is not rejected by the second statement, because the
32572 &%prvscheck%& expansion yields an empty string if its first argument is not a
32573 prvs-signed address, thus causing the &%condition%& condition to be false. If
32574 the first argument is a syntactically valid prvs-signed address, the yield is
32575 the third string (in this case &"1"&), whether or not the cryptographic and
32576 timeout checks succeed. The &$prvscheck_result$& variable contains the result
32577 of the checks (empty for failure, &"1"& for success).
32578
32579 There is one more issue you must consider when implementing prvs-signing:
32580 you have to ensure that the routers accept prvs-signed addresses and
32581 deliver them correctly. The easiest way to handle this is to use a &(redirect)&
32582 router to remove the signature with a configuration along these lines:
32583 .code
32584 batv_redirect:
32585   driver = redirect
32586   data = ${prvscheck {$local_part@$domain}{PRVSCHECK_SQL}}
32587 .endd
32588 This works because, if the third argument of &%prvscheck%& is empty, the result
32589 of the expansion of a prvs-signed address is the decoded value of the original
32590 address. This router should probably be the first of your routers that handles
32591 local addresses.
32592
32593 To create BATV-signed addresses in the first place, a transport of this form
32594 can be used:
32595 .code
32596 external_smtp_batv:
32597   driver = smtp
32598   return_path = ${prvs {$return_path} \
32599                        {${lookup mysql{SELECT \
32600                        secret FROM batv_prvs WHERE \
32601                        sender='${quote_mysql:$sender_address}'} \
32602                        {$value}fail}}}
32603 .endd
32604 If no key can be found for the existing return path, no signing takes place.
32605
32606
32607
32608 .section "Using an ACL to control relaying" "SECTrelaycontrol"
32609 .cindex "&ACL;" "relay control"
32610 .cindex "relaying" "control by ACL"
32611 .cindex "policy control" "relay control"
32612 An MTA is said to &'relay'& a message if it receives it from some host and
32613 delivers it directly to another host as a result of a remote address contained
32614 within it. Redirecting a local address via an alias or forward file and then
32615 passing the message on to another host is not relaying,
32616 .cindex "&""percent hack""&"
32617 but a redirection as a result of the &"percent hack"& is.
32618
32619 Two kinds of relaying exist, which are termed &"incoming"& and &"outgoing"&.
32620 A host which is acting as a gateway or an MX backup is concerned with incoming
32621 relaying from arbitrary hosts to a specific set of domains. On the other hand,
32622 a host which is acting as a smart host for a number of clients is concerned
32623 with outgoing relaying from those clients to the Internet at large. Often the
32624 same host is fulfilling both functions,
32625 . ///
32626 . as illustrated in the diagram below,
32627 . ///
32628 but in principle these two kinds of relaying are entirely independent. What is
32629 not wanted is the transmission of mail from arbitrary remote hosts through your
32630 system to arbitrary domains.
32631
32632
32633 You can implement relay control by means of suitable statements in the ACL that
32634 runs for each RCPT command. For convenience, it is often easiest to use
32635 Exim's named list facility to define the domains and hosts involved. For
32636 example, suppose you want to do the following:
32637
32638 .ilist
32639 Deliver a number of domains to mailboxes on the local host (or process them
32640 locally in some other way). Let's say these are &'my.dom1.example'& and
32641 &'my.dom2.example'&.
32642 .next
32643 Relay mail for a number of other domains for which you are the secondary MX.
32644 These might be &'friend1.example'& and &'friend2.example'&.
32645 .next
32646 Relay mail from the hosts on your local LAN, to whatever domains are involved.
32647 Suppose your LAN is 192.168.45.0/24.
32648 .endlist
32649
32650
32651 In the main part of the configuration, you put the following definitions:
32652 .code
32653 domainlist local_domains    = my.dom1.example : my.dom2.example
32654 domainlist relay_to_domains = friend1.example : friend2.example
32655 hostlist   relay_from_hosts = 192.168.45.0/24
32656 .endd
32657 Now you can use these definitions in the ACL that is run for every RCPT
32658 command:
32659 .code
32660 acl_check_rcpt:
32661   accept domains = +local_domains : +relay_to_domains
32662   accept hosts   = +relay_from_hosts
32663 .endd
32664 The first statement accepts any RCPT command that contains an address in
32665 the local or relay domains. For any other domain, control passes to the second
32666 statement, which accepts the command only if it comes from one of the relay
32667 hosts. In practice, you will probably want to make your ACL more sophisticated
32668 than this, for example, by including sender and recipient verification. The
32669 default configuration includes a more comprehensive example, which is described
32670 in chapter &<<CHAPdefconfil>>&.
32671
32672
32673
32674 .section "Checking a relay configuration" "SECTcheralcon"
32675 .cindex "relaying" "checking control of"
32676 You can check the relay characteristics of your configuration in the same way
32677 that you can test any ACL behaviour for an incoming SMTP connection, by using
32678 the &%-bh%& option to run a fake SMTP session with which you interact.
32679 .ecindex IIDacl
32680
32681
32682
32683 . ////////////////////////////////////////////////////////////////////////////
32684 . ////////////////////////////////////////////////////////////////////////////
32685
32686 .chapter "Content scanning at ACL time" "CHAPexiscan"
32687 .scindex IIDcosca "content scanning" "at ACL time"
32688 The extension of Exim to include content scanning at ACL time, formerly known
32689 as &"exiscan"&, was originally implemented as a patch by Tom Kistner. The code
32690 was integrated into the main source for Exim release 4.50, and Tom continues to
32691 maintain it. Most of the wording of this chapter is taken from Tom's
32692 specification.
32693
32694 It is also possible to scan the content of messages at other times. The
32695 &[local_scan()]& function (see chapter &<<CHAPlocalscan>>&) allows for content
32696 scanning after all the ACLs have run. A transport filter can be used to scan
32697 messages at delivery time (see the &%transport_filter%& option, described in
32698 chapter &<<CHAPtransportgeneric>>&).
32699
32700 If you want to include the ACL-time content-scanning features when you compile
32701 Exim, you need to arrange for WITH_CONTENT_SCAN to be defined in your
32702 &_Local/Makefile_&. When you do that, the Exim binary is built with:
32703
32704 .ilist
32705 Two additional ACLs (&%acl_smtp_mime%& and &%acl_not_smtp_mime%&) that are run
32706 for all MIME parts for SMTP and non-SMTP messages, respectively.
32707 .next
32708 Additional ACL conditions and modifiers: &%decode%&, &%malware%&,
32709 &%mime_regex%&, &%regex%&, and &%spam%&. These can be used in the ACL that is
32710 run at the end of message reception (the &%acl_smtp_data%& ACL).
32711 .next
32712 An additional control feature (&"no_mbox_unspool"&) that saves spooled copies
32713 of messages, or parts of messages, for debugging purposes.
32714 .next
32715 Additional expansion variables that are set in the new ACL and by the new
32716 conditions.
32717 .next
32718 Two new main configuration options: &%av_scanner%& and &%spamd_address%&.
32719 .endlist
32720
32721 Content-scanning is continually evolving, and new features are still being
32722 added. While such features are still unstable and liable to incompatible
32723 changes, they are made available in Exim by setting options whose names begin
32724 EXPERIMENTAL_ in &_Local/Makefile_&. Such features are not documented in
32725 this manual. You can find out about them by reading the file called
32726 &_doc/experimental.txt_&.
32727
32728 All the content-scanning facilities work on a MBOX copy of the message that is
32729 temporarily created in a file called:
32730 .display
32731 <&'spool_directory'&>&`/scan/`&<&'message_id'&>/<&'message_id'&>&`.eml`&
32732 .endd
32733 The &_.eml_& extension is a friendly hint to virus scanners that they can
32734 expect an MBOX-like structure inside that file. The file is created when the
32735 first content scanning facility is called. Subsequent calls to content
32736 scanning conditions open the same file again. The directory is recursively
32737 removed when the &%acl_smtp_data%& ACL has finished running, unless
32738 .code
32739 control = no_mbox_unspool
32740 .endd
32741 has been encountered. When the MIME ACL decodes files, they are put into the
32742 same directory by default.
32743
32744
32745
32746 .section "Scanning for viruses" "SECTscanvirus"
32747 .cindex "virus scanning"
32748 .cindex "content scanning" "for viruses"
32749 .cindex "content scanning" "the &%malware%& condition"
32750 The &%malware%& ACL condition lets you connect virus scanner software to Exim.
32751 It supports a &"generic"& interface to scanners called via the shell, and
32752 specialized interfaces for &"daemon"& type virus scanners, which are resident
32753 in memory and thus are much faster.
32754
32755 .new
32756 Since message data needs to have arrived,
32757 the condition may be only called in ACL defined by
32758 &%acl_smtp_data%&,
32759 &%acl_smtp_data_prdr%&,
32760 &%acl_smtp_mime%& or
32761 &%acl_smtp_dkim%&
32762 .wen
32763
32764 A timeout of 2 minutes is applied to a scanner call (by default);
32765 if it expires then a defer action is taken.
32766
32767 .oindex "&%av_scanner%&"
32768 You can set the &%av_scanner%& option in the main part of the configuration
32769 to specify which scanner to use, together with any additional options that
32770 are needed. The basic syntax is as follows:
32771 .display
32772 &`av_scanner = <`&&'scanner-type'&&`>:<`&&'option1'&&`>:<`&&'option2'&&`>:[...]`&
32773 .endd
32774 If you do not set &%av_scanner%&, it defaults to
32775 .code
32776 av_scanner = sophie:/var/run/sophie
32777 .endd
32778 If the value of &%av_scanner%& starts with a dollar character, it is expanded
32779 before use.
32780 The usual list-parsing of the content (see &<<SECTlistconstruct>>&) applies.
32781 The following scanner types are supported in this release,
32782 though individual ones can be included or not at build time:
32783
32784 .vlist
32785 .vitem &%avast%&
32786 .cindex "virus scanners" "avast"
32787 This is the scanner daemon of Avast. It has been tested with Avast Core
32788 Security (currently at version 2.2.0).
32789 You can get a trial version at &url(https://www.avast.com) or for Linux
32790 at &url(https://www.avast.com/linux-server-antivirus).
32791 This scanner type takes one option,
32792 which can be either a full path to a UNIX socket,
32793 or host and port specifiers separated by white space.
32794 The host may be a name or an IP address; the port is either a
32795 single number or a pair of numbers with a dash between.
32796 A list of options may follow. These options are interpreted on the
32797 Exim's side of the malware scanner, or are given on separate lines to
32798 the daemon as options before the main scan command.
32799
32800 .cindex &`pass_unscanned`& "avast"
32801 If &`pass_unscanned`&
32802 is set, any files the Avast scanner can't scan (e.g.
32803 decompression bombs, or invalid archives) are considered clean. Use with
32804 care.
32805
32806 For example:
32807 .code
32808 av_scanner = avast:/var/run/avast/scan.sock:FLAGS -fullfiles:SENSITIVITY -pup
32809 av_scanner = avast:/var/run/avast/scan.sock:pass_unscanned:FLAGS -fullfiles:SENSITIVITY -pup
32810 av_scanner = avast:192.168.2.22 5036
32811 .endd
32812 If you omit the argument, the default path
32813 &_/var/run/avast/scan.sock_&
32814 is used.
32815 If you use a remote host,
32816 you need to make Exim's spool directory available to it,
32817 as the scanner is passed a file path, not file contents.
32818 For information about available commands and their options you may use
32819 .code
32820 $ socat UNIX:/var/run/avast/scan.sock STDIO:
32821     FLAGS
32822     SENSITIVITY
32823     PACK
32824 .endd
32825
32826 If the scanner returns a temporary failure (e.g. license issues, or
32827 permission problems), the message is deferred and a paniclog entry is
32828 written.  The usual &`defer_ok`& option is available.
32829
32830 .vitem &%aveserver%&
32831 .cindex "virus scanners" "Kaspersky"
32832 This is the scanner daemon of Kaspersky Version 5. You can get a trial version
32833 at &url(https://www.kaspersky.com/). This scanner type takes one option,
32834 which is the path to the daemon's UNIX socket. The default is shown in this
32835 example:
32836 .code
32837 av_scanner = aveserver:/var/run/aveserver
32838 .endd
32839
32840
32841 .vitem &%clamd%&
32842 .cindex "virus scanners" "clamd"
32843 This daemon-type scanner is GPL and free. You can get it at
32844 &url(https://www.clamav.net/). Some older versions of clamd do not seem to
32845 unpack MIME containers, so it used to be recommended to unpack MIME attachments
32846 in the MIME ACL. This is no longer believed to be necessary.
32847
32848 The options are a list of server specifiers, which may be
32849 a UNIX socket specification,
32850 a TCP socket specification,
32851 or a (global) option.
32852
32853 A socket specification consists of a space-separated list.
32854 For a Unix socket the first element is a full path for the socket,
32855 for a TCP socket the first element is the IP address
32856 and the second a port number,
32857 Any further elements are per-server (non-global) options.
32858 These per-server options are supported:
32859 .code
32860 retry=<timespec>        Retry on connect fail
32861 .endd
32862
32863 The &`retry`& option specifies a time after which a single retry for
32864 a failed connect is made.  The default is to not retry.
32865
32866 If a Unix socket file is specified, only one server is supported.
32867
32868 Examples:
32869 .code
32870 av_scanner = clamd:/opt/clamd/socket
32871 av_scanner = clamd:192.0.2.3 1234
32872 av_scanner = clamd:192.0.2.3 1234:local
32873 av_scanner = clamd:192.0.2.3 1234 retry=10s
32874 av_scanner = clamd:192.0.2.3 1234 : 192.0.2.4 1234
32875 .endd
32876 If the value of av_scanner points to a UNIX socket file or contains the
32877 &`local`&
32878 option, then the ClamAV interface will pass a filename containing the data
32879 to be scanned, which should normally result in less I/O happening and be
32880 more efficient.  Normally in the TCP case, the data is streamed to ClamAV as
32881 Exim does not assume that there is a common filesystem with the remote host.
32882
32883 The final example shows that multiple TCP targets can be specified.  Exim will
32884 randomly use one for each incoming email (i.e. it load balances them).  Note
32885 that only TCP targets may be used if specifying a list of scanners; a UNIX
32886 socket cannot be mixed in with TCP targets.  If one of the servers becomes
32887 unavailable, Exim will try the remaining one(s) until it finds one that works.
32888 When a clamd server becomes unreachable, Exim will log a message.  Exim does
32889 not keep track of scanner state between multiple messages, and the scanner
32890 selection is random, so the message will get logged in the mainlog for each
32891 email that the down scanner gets chosen first (message wrapped to be readable):
32892 .code
32893 2013-10-09 14:30:39 1VTumd-0000Y8-BQ malware acl condition:
32894    clamd: connection to localhost, port 3310 failed
32895    (Connection refused)
32896 .endd
32897
32898 If the option is unset, the default is &_/tmp/clamd_&. Thanks to David Saez for
32899 contributing the code for this scanner.
32900
32901 .vitem &%cmdline%&
32902 .cindex "virus scanners" "command line interface"
32903 This is the keyword for the generic command line scanner interface. It can be
32904 used to attach virus scanners that are invoked from the shell. This scanner
32905 type takes 3 mandatory options:
32906
32907 .olist
32908 The full path and name of the scanner binary, with all command line options,
32909 and a placeholder (&`%s`&) for the directory to scan.
32910
32911 .next
32912 A regular expression to match against the STDOUT and STDERR output of the
32913 virus scanner. If the expression matches, a virus was found. You must make
32914 absolutely sure that this expression matches on &"virus found"&. This is called
32915 the &"trigger"& expression.
32916
32917 .next
32918 Another regular expression, containing exactly one pair of parentheses, to
32919 match the name of the virus found in the scanners output. This is called the
32920 &"name"& expression.
32921 .endlist olist
32922
32923 For example, Sophos Sweep reports a virus on a line like this:
32924 .code
32925 Virus 'W32/Magistr-B' found in file ./those.bat
32926 .endd
32927 For the trigger expression, we can match the phrase &"found in file"&. For the
32928 name expression, we want to extract the W32/Magistr-B string, so we can match
32929 for the single quotes left and right of it. Altogether, this makes the
32930 configuration setting:
32931 .code
32932 av_scanner = cmdline:\
32933              /path/to/sweep -ss -all -rec -archive %s:\
32934              found in file:'(.+)'
32935 .endd
32936 .vitem &%drweb%&
32937 .cindex "virus scanners" "DrWeb"
32938 The DrWeb daemon scanner (&url(https://www.sald.ru/)) interface
32939 takes one option,
32940 either a full path to a UNIX socket,
32941 or host and port specifiers separated by white space.
32942 The host may be a name or an IP address; the port is either a
32943 single number or a pair of numbers with a dash between.
32944 For example:
32945 .code
32946 av_scanner = drweb:/var/run/drwebd.sock
32947 av_scanner = drweb:192.168.2.20 31337
32948 .endd
32949 If you omit the argument, the default path &_/usr/local/drweb/run/drwebd.sock_&
32950 is used. Thanks to Alex Miller for contributing the code for this scanner.
32951
32952 .vitem &%f-protd%&
32953 .cindex "virus scanners" "f-protd"
32954 The f-protd scanner is accessed via HTTP over TCP.
32955 One argument is taken, being a space-separated hostname and port number
32956 (or port-range).
32957 For example:
32958 .code
32959 av_scanner = f-protd:localhost 10200-10204
32960 .endd
32961 If you omit the argument, the default values shown above are used.
32962
32963 .vitem &%f-prot6d%&
32964 .cindex "virus scanners" "f-prot6d"
32965 The f-prot6d scanner is accessed using the FPSCAND protocol over TCP.
32966 One argument is taken, being a space-separated hostname and port number.
32967 For example:
32968 .code
32969 av_scanner = f-prot6d:localhost 10200
32970 .endd
32971 If you omit the argument, the default values show above are used.
32972
32973 .vitem &%fsecure%&
32974 .cindex "virus scanners" "F-Secure"
32975 The F-Secure daemon scanner (&url(https://www.f-secure.com/)) takes one
32976 argument which is the path to a UNIX socket. For example:
32977 .code
32978 av_scanner = fsecure:/path/to/.fsav
32979 .endd
32980 If no argument is given, the default is &_/var/run/.fsav_&. Thanks to Johan
32981 Thelmen for contributing the code for this scanner.
32982
32983 .vitem &%kavdaemon%&
32984 .cindex "virus scanners" "Kaspersky"
32985 This is the scanner daemon of Kaspersky Version 4. This version of the
32986 Kaspersky scanner is outdated. Please upgrade (see &%aveserver%& above). This
32987 scanner type takes one option, which is the path to the daemon's UNIX socket.
32988 For example:
32989 .code
32990 av_scanner = kavdaemon:/opt/AVP/AvpCtl
32991 .endd
32992 The default path is &_/var/run/AvpCtl_&.
32993
32994 .vitem &%mksd%&
32995 .cindex "virus scanners" "mksd"
32996 This was a daemon type scanner that is aimed mainly at Polish users,
32997 though some documentation was available in English.
32998 The history can be shown at &url(https://en.wikipedia.org/wiki/Mks_vir)
32999 and this appears to be a candidate for removal from Exim, unless
33000 we are informed of other virus scanners which use the same protocol
33001 to integrate.
33002 The only option for this scanner type is
33003 the maximum number of processes used simultaneously to scan the attachments,
33004 provided that mksd has
33005 been run with at least the same number of child processes. For example:
33006 .code
33007 av_scanner = mksd:2
33008 .endd
33009 You can safely omit this option (the default value is 1).
33010
33011 .vitem &%sock%&
33012 .cindex "virus scanners" "simple socket-connected"
33013 This is a general-purpose way of talking to simple scanner daemons
33014 running on the local machine.
33015 There are four options:
33016 an address (which may be an IP address and port, or the path of a Unix socket),
33017 a commandline to send (may include a single %s which will be replaced with
33018 the path to the mail file to be scanned),
33019 an RE to trigger on from the returned data,
33020 and an RE to extract malware_name from the returned data.
33021 For example:
33022 .code
33023 av_scanner = sock:127.0.0.1 6001:%s:(SPAM|VIRUS):(.*)$
33024 .endd
33025 Note that surrounding whitespace is stripped from each option, meaning
33026 there is no way to specify a trailing newline.
33027 The socket specifier and both regular-expressions are required.
33028 Default for the commandline is &_%s\n_& (note this does have a trailing newline);
33029 specify an empty element to get this.
33030
33031 .vitem &%sophie%&
33032 .cindex "virus scanners" "Sophos and Sophie"
33033 Sophie is a daemon that uses Sophos' &%libsavi%& library to scan for viruses.
33034 You can get Sophie at &url(http://sophie.sourceforge.net/). The only option
33035 for this scanner type is the path to the UNIX socket that Sophie uses for
33036 client communication. For example:
33037 .code
33038 av_scanner = sophie:/tmp/sophie
33039 .endd
33040 The default path is &_/var/run/sophie_&, so if you are using this, you can omit
33041 the option.
33042 .endlist
33043
33044 When &%av_scanner%& is correctly set, you can use the &%malware%& condition in
33045 the DATA ACL. &*Note*&: You cannot use the &%malware%& condition in the MIME
33046 ACL.
33047
33048 The &%av_scanner%& option is expanded each time &%malware%& is called. This
33049 makes it possible to use different scanners. See further below for an example.
33050 The &%malware%& condition caches its results, so when you use it multiple times
33051 for the same message, the actual scanning process is only carried out once.
33052 However, using expandable items in &%av_scanner%& disables this caching, in
33053 which case each use of the &%malware%& condition causes a new scan of the
33054 message.
33055
33056 The &%malware%& condition takes a right-hand argument that is expanded before
33057 use and taken as a list, slash-separated by default.
33058 The first element can then be one of
33059
33060 .ilist
33061 &"true"&, &"*"&, or &"1"&, in which case the message is scanned for viruses.
33062 The condition succeeds if a virus was found, and fail otherwise. This is the
33063 recommended usage.
33064 .next
33065 &"false"& or &"0"& or an empty string, in which case no scanning is done and
33066 the condition fails immediately.
33067 .next
33068 A regular expression, in which case the message is scanned for viruses. The
33069 condition succeeds if a virus is found and its name matches the regular
33070 expression. This allows you to take special actions on certain types of virus.
33071 Note that &"/"& characters in the RE must be doubled due to the list-processing,
33072 unless the separator is changed (in the usual way &<<SECTlistsepchange>>&).
33073 .endlist
33074
33075 You can append a &`defer_ok`& element to the &%malware%& argument list to accept
33076 messages even if there is a problem with the virus scanner.
33077 Otherwise, such a problem causes the ACL to defer.
33078
33079 You can append a &`tmo=<val>`& element to the &%malware%& argument list to
33080 specify a non-default timeout.  The default is two minutes.
33081 For example:
33082 .code
33083 malware = * / defer_ok / tmo=10s
33084 .endd
33085 A timeout causes the ACL to defer.
33086
33087 .vindex "&$callout_address$&"
33088 When a connection is made to the scanner the expansion variable &$callout_address$&
33089 is set to record the actual address used.
33090
33091 .vindex "&$malware_name$&"
33092 When a virus is found, the condition sets up an expansion variable called
33093 &$malware_name$& that contains the name of the virus. You can use it in a
33094 &%message%& modifier that specifies the error returned to the sender, and/or in
33095 logging data.
33096
33097 Beware the interaction of Exim's &%message_size_limit%& with any size limits
33098 imposed by your anti-virus scanner.
33099
33100 Here is a very simple scanning example:
33101 .code
33102 deny message = This message contains malware ($malware_name)
33103      malware = *
33104 .endd
33105 The next example accepts messages when there is a problem with the scanner:
33106 .code
33107 deny message = This message contains malware ($malware_name)
33108      malware = */defer_ok
33109 .endd
33110 The next example shows how to use an ACL variable to scan with both sophie and
33111 aveserver. It assumes you have set:
33112 .code
33113 av_scanner = $acl_m0
33114 .endd
33115 in the main Exim configuration.
33116 .code
33117 deny message = This message contains malware ($malware_name)
33118      set acl_m0 = sophie
33119      malware = *
33120
33121 deny message = This message contains malware ($malware_name)
33122      set acl_m0 = aveserver
33123      malware = *
33124 .endd
33125
33126
33127 .section "Scanning with SpamAssassin and Rspamd" "SECTscanspamass"
33128 .cindex "content scanning" "for spam"
33129 .cindex "spam scanning"
33130 .cindex "SpamAssassin"
33131 .cindex "Rspamd"
33132 The &%spam%& ACL condition calls SpamAssassin's &%spamd%& daemon to get a spam
33133 score and a report for the message.
33134 Support is also provided for Rspamd.
33135
33136 For more information about installation and configuration of SpamAssassin or
33137 Rspamd refer to their respective websites at
33138 &url(https://spamassassin.apache.org/) and &url(https://www.rspamd.com/)
33139
33140 SpamAssassin can be installed with CPAN by running:
33141 .code
33142 perl -MCPAN -e 'install Mail::SpamAssassin'
33143 .endd
33144 SpamAssassin has its own set of configuration files. Please review its
33145 documentation to see how you can tweak it. The default installation should work
33146 nicely, however.
33147
33148 .oindex "&%spamd_address%&"
33149 By default, SpamAssassin listens on 127.0.0.1, TCP port 783 and if you
33150 intend to use an instance running on the local host you do not need to set
33151 &%spamd_address%&. If you intend to use another host or port for SpamAssassin,
33152 you must set the &%spamd_address%& option in the global part of the Exim
33153 configuration as follows (example):
33154 .code
33155 spamd_address = 192.168.99.45 783
33156 .endd
33157 The SpamAssassin protocol relies on a TCP half-close from the client.
33158 If your SpamAssassin client side is running a Linux system with an
33159 iptables firewall, consider setting
33160 &%net.netfilter.nf_conntrack_tcp_timeout_close_wait%& to at least the
33161 timeout, Exim uses when waiting for a response from the SpamAssassin
33162 server (currently defaulting to 120s).  With a lower value the Linux
33163 connection tracking may consider your half-closed connection as dead too
33164 soon.
33165
33166
33167 To use Rspamd (which by default listens on all local addresses
33168 on TCP port 11333)
33169 you should add &%variant=rspamd%& after the address/port pair, for example:
33170 .code
33171 spamd_address = 127.0.0.1 11333 variant=rspamd
33172 .endd
33173
33174 As of version 2.60, &%SpamAssassin%& also supports communication over UNIX
33175 sockets. If you want to us these, supply &%spamd_address%& with an absolute
33176 filename instead of an address/port pair:
33177 .code
33178 spamd_address = /var/run/spamd_socket
33179 .endd
33180 You can have multiple &%spamd%& servers to improve scalability. These can
33181 reside on other hardware reachable over the network. To specify multiple
33182 &%spamd%& servers, put multiple address/port pairs in the &%spamd_address%&
33183 option, separated with colons (the separator can be changed in the usual way &<<SECTlistsepchange>>&):
33184 .code
33185 spamd_address = 192.168.2.10 783 : \
33186                 192.168.2.11 783 : \
33187                 192.168.2.12 783
33188 .endd
33189 Up to 32 &%spamd%& servers are supported.
33190 When a server fails to respond to the connection attempt, all other
33191 servers are tried until one succeeds. If no server responds, the &%spam%&
33192 condition defers.
33193
33194 Unix and TCP socket specifications may be mixed in any order.
33195 Each element of the list is a list itself, space-separated by default
33196 and changeable in the usual way (&<<SECTlistsepchange>>&);
33197 take care to not double the separator.
33198
33199 For TCP socket specifications a host name or IP (v4 or v6, but
33200 subject to list-separator quoting rules) address can be used,
33201 and the port can be one or a dash-separated pair.
33202 In the latter case, the range is tried in strict order.
33203
33204 Elements after the first for Unix sockets, or second for TCP socket,
33205 are options.
33206 The supported options are:
33207 .code
33208 pri=<priority>      Selection priority
33209 weight=<value>      Selection bias
33210 time=<start>-<end>  Use only between these times of day
33211 retry=<timespec>    Retry on connect fail
33212 tmo=<timespec>      Connection time limit
33213 variant=rspamd      Use Rspamd rather than SpamAssassin protocol
33214 .endd
33215
33216 The &`pri`& option specifies a priority for the server within the list,
33217 higher values being tried first.
33218 The default priority is 1.
33219
33220 The &`weight`& option specifies a selection bias.
33221 Within a priority set
33222 servers are queried in a random fashion, weighted by this value.
33223 The default value for selection bias is 1.
33224
33225 Time specifications for the &`time`& option are <hour>.<minute>.<second>
33226 in the local time zone; each element being one or more digits.
33227 Either the seconds or both minutes and seconds, plus the leading &`.`&
33228 characters, may be omitted and will be taken as zero.
33229
33230 Timeout specifications for the &`retry`& and &`tmo`& options
33231 are the usual Exim time interval standard, e.g. &`20s`& or &`1m`&.
33232
33233 The &`tmo`& option specifies an overall timeout for communication.
33234 The default value is two minutes.
33235
33236 The &`retry`& option specifies a time after which a single retry for
33237 a failed connect is made.
33238 The default is to not retry.
33239
33240 The &%spamd_address%& variable is expanded before use if it starts with
33241 a dollar sign. In this case, the expansion may return a string that is
33242 used as the list so that multiple spamd servers can be the result of an
33243 expansion.
33244
33245 .vindex "&$callout_address$&"
33246 When a connection is made to the server the expansion variable &$callout_address$&
33247 is set to record the actual address used.
33248
33249 .section "Calling SpamAssassin from an Exim ACL" "SECID206"
33250 Here is a simple example of the use of the &%spam%& condition in a DATA ACL:
33251 .code
33252 deny message = This message was classified as SPAM
33253      spam = joe
33254 .endd
33255 The right-hand side of the &%spam%& condition specifies a name. This is
33256 relevant if you have set up multiple SpamAssassin profiles. If you do not want
33257 to scan using a specific profile, but rather use the SpamAssassin system-wide
33258 default profile, you can scan for an unknown name, or simply use &"nobody"&.
33259 Rspamd does not use this setting. However, you must put something on the
33260 right-hand side.
33261
33262 The name allows you to use per-domain or per-user antispam profiles in
33263 principle, but this is not straightforward in practice, because a message may
33264 have multiple recipients, not necessarily all in the same domain. Because the
33265 &%spam%& condition has to be called from a DATA-time ACL in order to be able to
33266 read the contents of the message, the variables &$local_part$& and &$domain$&
33267 are not set.
33268 Careful enforcement of single-recipient messages
33269 (e.g. by responding with defer in the recipient ACL for all recipients
33270 after the first),
33271 or the use of PRDR,
33272 .cindex "PRDR" "use for per-user SpamAssassin profiles"
33273 are needed to use this feature.
33274
33275 The right-hand side of the &%spam%& condition is expanded before being used, so
33276 you can put lookups or conditions there. When the right-hand side evaluates to
33277 &"0"& or &"false"&, no scanning is done and the condition fails immediately.
33278
33279
33280 Scanning with SpamAssassin uses a lot of resources. If you scan every message,
33281 large ones may cause significant performance degradation. As most spam messages
33282 are quite small, it is recommended that you do not scan the big ones. For
33283 example:
33284 .code
33285 deny message = This message was classified as SPAM
33286      condition = ${if < {$message_size}{10K}}
33287      spam = nobody
33288 .endd
33289
33290 The &%spam%& condition returns true if the threshold specified in the user's
33291 SpamAssassin profile has been matched or exceeded. If you want to use the
33292 &%spam%& condition for its side effects (see the variables below), you can make
33293 it always return &"true"& by appending &`:true`& to the username.
33294
33295 .cindex "spam scanning" "returned variables"
33296 When the &%spam%& condition is run, it sets up a number of expansion
33297 variables.
33298 Except for &$spam_report$&,
33299 these variables are saved with the received message so are
33300 available for use at delivery time.
33301
33302 .vlist
33303 .vitem &$spam_score$&
33304 The spam score of the message, for example, &"3.4"& or &"30.5"&. This is useful
33305 for inclusion in log or reject messages.
33306
33307 .vitem &$spam_score_int$&
33308 The spam score of the message, multiplied by ten, as an integer value. For
33309 example &"34"& or &"305"&. It may appear to disagree with &$spam_score$&
33310 because &$spam_score$& is rounded and &$spam_score_int$& is truncated.
33311 The integer value is useful for numeric comparisons in conditions.
33312
33313 .vitem &$spam_bar$&
33314 A string consisting of a number of &"+"& or &"-"& characters, representing the
33315 integer part of the spam score value. A spam score of 4.4 would have a
33316 &$spam_bar$& value of &"++++"&. This is useful for inclusion in warning
33317 headers, since MUAs can match on such strings. The maximum length of the
33318 spam bar is 50 characters.
33319
33320 .vitem &$spam_report$&
33321 A multiline text table, containing the full SpamAssassin report for the
33322 message. Useful for inclusion in headers or reject messages.
33323 This variable is only usable in a DATA-time ACL.
33324 Beware that SpamAssassin may return non-ASCII characters, especially
33325 when running in country-specific locales, which are not legal
33326 unencoded in headers.
33327
33328 .vitem &$spam_action$&
33329 For SpamAssassin either 'reject' or 'no action' depending on the
33330 spam score versus threshold.
33331 For Rspamd, the recommended action.
33332
33333 .endlist
33334
33335 The &%spam%& condition caches its results unless expansion in
33336 spamd_address was used. If you call it again with the same user name, it
33337 does not scan again, but rather returns the same values as before.
33338
33339 The &%spam%& condition returns DEFER if there is any error while running
33340 the message through SpamAssassin or if the expansion of spamd_address
33341 failed. If you want to treat DEFER as FAIL (to pass on to the next ACL
33342 statement block), append &`/defer_ok`& to the right-hand side of the
33343 spam condition, like this:
33344 .code
33345 deny message = This message was classified as SPAM
33346      spam    = joe/defer_ok
33347 .endd
33348 This causes messages to be accepted even if there is a problem with &%spamd%&.
33349
33350 Here is a longer, commented example of the use of the &%spam%&
33351 condition:
33352 .code
33353 # put headers in all messages (no matter if spam or not)
33354 warn  spam = nobody:true
33355       add_header = X-Spam-Score: $spam_score ($spam_bar)
33356       add_header = X-Spam-Report: $spam_report
33357
33358 # add second subject line with *SPAM* marker when message
33359 # is over threshold
33360 warn  spam = nobody
33361       add_header = Subject: *SPAM* $h_Subject:
33362
33363 # reject spam at high scores (> 12)
33364 deny  message = This message scored $spam_score spam points.
33365       spam = nobody:true
33366       condition = ${if >{$spam_score_int}{120}{1}{0}}
33367 .endd
33368
33369
33370
33371 .section "Scanning MIME parts" "SECTscanmimepart"
33372 .cindex "content scanning" "MIME parts"
33373 .cindex "MIME content scanning"
33374 .oindex "&%acl_smtp_mime%&"
33375 .oindex "&%acl_not_smtp_mime%&"
33376 The &%acl_smtp_mime%& global option specifies an ACL that is called once for
33377 each MIME part of an SMTP message, including multipart types, in the sequence
33378 of their position in the message. Similarly, the &%acl_not_smtp_mime%& option
33379 specifies an ACL that is used for the MIME parts of non-SMTP messages. These
33380 options may both refer to the same ACL if you want the same processing in both
33381 cases.
33382
33383 These ACLs are called (possibly many times) just before the &%acl_smtp_data%&
33384 ACL in the case of an SMTP message, or just before the &%acl_not_smtp%& ACL in
33385 the case of a non-SMTP message. However, a MIME ACL is called only if the
33386 message contains a &'Content-Type:'& header line. When a call to a MIME
33387 ACL does not yield &"accept"&, ACL processing is aborted and the appropriate
33388 result code is sent to the client. In the case of an SMTP message, the
33389 &%acl_smtp_data%& ACL is not called when this happens.
33390
33391 You cannot use the &%malware%& or &%spam%& conditions in a MIME ACL; these can
33392 only be used in the DATA or non-SMTP ACLs. However, you can use the &%regex%&
33393 condition to match against the raw MIME part. You can also use the
33394 &%mime_regex%& condition to match against the decoded MIME part (see section
33395 &<<SECTscanregex>>&).
33396
33397 At the start of a MIME ACL, a number of variables are set from the header
33398 information for the relevant MIME part. These are described below. The contents
33399 of the MIME part are not by default decoded into a disk file except for MIME
33400 parts whose content-type is &"message/rfc822"&. If you want to decode a MIME
33401 part into a disk file, you can use the &%decode%& condition. The general
33402 syntax is:
33403 .display
33404 &`decode = [/`&<&'path'&>&`/]`&<&'filename'&>
33405 .endd
33406 The right hand side is expanded before use. After expansion,
33407 the value can be:
33408
33409 .olist
33410 &"0"& or &"false"&, in which case no decoding is done.
33411 .next
33412 The string &"default"&. In that case, the file is put in the temporary
33413 &"default"& directory <&'spool_directory'&>&_/scan/_&<&'message_id'&>&_/_& with
33414 a sequential filename consisting of the message id and a sequence number. The
33415 full path and name is available in &$mime_decoded_filename$& after decoding.
33416 .next
33417 A full path name starting with a slash. If the full name is an existing
33418 directory, it is used as a replacement for the default directory. The filename
33419 is then sequentially assigned. If the path does not exist, it is used as
33420 the full path and filename.
33421 .next
33422 If the string does not start with a slash, it is used as the
33423 filename, and the default path is then used.
33424 .endlist
33425 The &%decode%& condition normally succeeds. It is only false for syntax
33426 errors or unusual circumstances such as memory shortages. You can easily decode
33427 a file with its original, proposed filename using
33428 .code
33429 decode = $mime_filename
33430 .endd
33431 However, you should keep in mind that &$mime_filename$& might contain
33432 anything. If you place files outside of the default path, they are not
33433 automatically unlinked.
33434
33435 For RFC822 attachments (these are messages attached to messages, with a
33436 content-type of &"message/rfc822"&), the ACL is called again in the same manner
33437 as for the primary message, only that the &$mime_is_rfc822$& expansion
33438 variable is set (see below). Attached messages are always decoded to disk
33439 before being checked, and the files are unlinked once the check is done.
33440
33441 The MIME ACL supports the &%regex%& and &%mime_regex%& conditions. These can be
33442 used to match regular expressions against raw and decoded MIME parts,
33443 respectively. They are described in section &<<SECTscanregex>>&.
33444
33445 .cindex "MIME content scanning" "returned variables"
33446 The following list describes all expansion variables that are
33447 available in the MIME ACL:
33448
33449 .vlist
33450 .vitem &$mime_boundary$&
33451 If the current part is a multipart (see &$mime_is_multipart$&) below, it should
33452 have a boundary string, which is stored in this variable. If the current part
33453 has no boundary parameter in the &'Content-Type:'& header, this variable
33454 contains the empty string.
33455
33456 .vitem &$mime_charset$&
33457 This variable contains the character set identifier, if one was found in the
33458 &'Content-Type:'& header. Examples for charset identifiers are:
33459 .code
33460 us-ascii
33461 gb2312 (Chinese)
33462 iso-8859-1
33463 .endd
33464 Please note that this value is not normalized, so you should do matches
33465 case-insensitively.
33466
33467 .vitem &$mime_content_description$&
33468 This variable contains the normalized content of the &'Content-Description:'&
33469 header. It can contain a human-readable description of the parts content. Some
33470 implementations repeat the filename for attachments here, but they are usually
33471 only used for display purposes.
33472
33473 .vitem &$mime_content_disposition$&
33474 This variable contains the normalized content of the &'Content-Disposition:'&
33475 header. You can expect strings like &"attachment"& or &"inline"& here.
33476
33477 .vitem &$mime_content_id$&
33478 This variable contains the normalized content of the &'Content-ID:'& header.
33479 This is a unique ID that can be used to reference a part from another part.
33480
33481 .vitem &$mime_content_size$&
33482 This variable is set only after the &%decode%& modifier (see above) has been
33483 successfully run. It contains the size of the decoded part in kilobytes. The
33484 size is always rounded up to full kilobytes, so only a completely empty part
33485 has a &$mime_content_size$& of zero.
33486
33487 .vitem &$mime_content_transfer_encoding$&
33488 This variable contains the normalized content of the
33489 &'Content-transfer-encoding:'& header. This is a symbolic name for an encoding
33490 type. Typical values are &"base64"& and &"quoted-printable"&.
33491
33492 .vitem &$mime_content_type$&
33493 If the MIME part has a &'Content-Type:'& header, this variable contains its
33494 value, lowercased, and without any options (like &"name"& or &"charset"&). Here
33495 are some examples of popular MIME types, as they may appear in this variable:
33496 .code
33497 text/plain
33498 text/html
33499 application/octet-stream
33500 image/jpeg
33501 audio/midi
33502 .endd
33503 If the MIME part has no &'Content-Type:'& header, this variable contains the
33504 empty string.
33505
33506 .vitem &$mime_decoded_filename$&
33507 This variable is set only after the &%decode%& modifier (see above) has been
33508 successfully run. It contains the full path and filename of the file
33509 containing the decoded data.
33510 .endlist
33511
33512 .cindex "RFC 2047"
33513 .vlist
33514 .vitem &$mime_filename$&
33515 This is perhaps the most important of the MIME variables. It contains a
33516 proposed filename for an attachment, if one was found in either the
33517 &'Content-Type:'& or &'Content-Disposition:'& headers. The filename will be
33518 RFC2047
33519 or RFC2231
33520 decoded, but no additional sanity checks are done.
33521  If no filename was
33522 found, this variable contains the empty string.
33523
33524 .vitem &$mime_is_coverletter$&
33525 This variable attempts to differentiate the &"cover letter"& of an e-mail from
33526 attached data. It can be used to clamp down on flashy or unnecessarily encoded
33527 content in the cover letter, while not restricting attachments at all.
33528
33529 The variable contains 1 (true) for a MIME part believed to be part of the
33530 cover letter, and 0 (false) for an attachment. At present, the algorithm is as
33531 follows:
33532
33533 .olist
33534 The outermost MIME part of a message is always a cover letter.
33535
33536 .next
33537 If a multipart/alternative or multipart/related MIME part is a cover letter,
33538 so are all MIME subparts within that multipart.
33539
33540 .next
33541 If any other multipart is a cover letter, the first subpart is a cover letter,
33542 and the rest are attachments.
33543
33544 .next
33545 All parts contained within an attachment multipart are attachments.
33546 .endlist olist
33547
33548 As an example, the following will ban &"HTML mail"& (including that sent with
33549 alternative plain text), while allowing HTML files to be attached. HTML
33550 coverletter mail attached to non-HTML coverletter mail will also be allowed:
33551 .code
33552 deny message = HTML mail is not accepted here
33553 !condition = $mime_is_rfc822
33554 condition = $mime_is_coverletter
33555 condition = ${if eq{$mime_content_type}{text/html}{1}{0}}
33556 .endd
33557 .vitem &$mime_is_multipart$&
33558 This variable has the value 1 (true) when the current part has the main type
33559 &"multipart"&, for example, &"multipart/alternative"& or &"multipart/mixed"&.
33560 Since multipart entities only serve as containers for other parts, you may not
33561 want to carry out specific actions on them.
33562
33563 .vitem &$mime_is_rfc822$&
33564 This variable has the value 1 (true) if the current part is not a part of the
33565 checked message itself, but part of an attached message. Attached message
33566 decoding is fully recursive.
33567
33568 .vitem &$mime_part_count$&
33569 This variable is a counter that is raised for each processed MIME part. It
33570 starts at zero for the very first part (which is usually a multipart). The
33571 counter is per-message, so it is reset when processing RFC822 attachments (see
33572 &$mime_is_rfc822$&). The counter stays set after &%acl_smtp_mime%& is
33573 complete, so you can use it in the DATA ACL to determine the number of MIME
33574 parts of a message. For non-MIME messages, this variable contains the value -1.
33575 .endlist
33576
33577
33578
33579 .section "Scanning with regular expressions" "SECTscanregex"
33580 .cindex "content scanning" "with regular expressions"
33581 .cindex "regular expressions" "content scanning with"
33582 You can specify your own custom regular expression matches on the full body of
33583 the message, or on individual MIME parts.
33584
33585 The &%regex%& condition takes one or more regular expressions as arguments and
33586 matches them against the full message (when called in the DATA ACL) or a raw
33587 MIME part (when called in the MIME ACL). The &%regex%& condition matches
33588 linewise, with a maximum line length of 32K characters. That means you cannot
33589 have multiline matches with the &%regex%& condition.
33590
33591 The &%mime_regex%& condition can be called only in the MIME ACL. It matches up
33592 to 32K of decoded content (the whole content at once, not linewise). If the
33593 part has not been decoded with the &%decode%& modifier earlier in the ACL, it
33594 is decoded automatically when &%mime_regex%& is executed (using default path
33595 and filename values). If the decoded data is larger than  32K, only the first
33596 32K characters are checked.
33597
33598 The regular expressions are passed as a colon-separated list. To include a
33599 literal colon, you must double it. Since the whole right-hand side string is
33600 expanded before being used, you must also escape dollar signs and backslashes
33601 with more backslashes, or use the &`\N`& facility to disable expansion.
33602 Here is a simple example that contains two regular expressions:
33603 .code
33604 deny message = contains blacklisted regex ($regex_match_string)
33605      regex = [Mm]ortgage : URGENT BUSINESS PROPOSAL
33606 .endd
33607 The conditions returns true if any one of the regular expressions matches. The
33608 &$regex_match_string$& expansion variable is then set up and contains the
33609 matching regular expression.
33610 The expansion variables &$regex1$& &$regex2$& etc
33611 are set to any substrings captured by the regular expression.
33612
33613 &*Warning*&: With large messages, these conditions can be fairly
33614 CPU-intensive.
33615
33616 .ecindex IIDcosca
33617
33618
33619
33620
33621 . ////////////////////////////////////////////////////////////////////////////
33622 . ////////////////////////////////////////////////////////////////////////////
33623
33624 .chapter "Adding a local scan function to Exim" "CHAPlocalscan" &&&
33625          "Local scan function"
33626 .scindex IIDlosca "&[local_scan()]& function" "description of"
33627 .cindex "customizing" "input scan using C function"
33628 .cindex "policy control" "by local scan function"
33629 In these days of email worms, viruses, and ever-increasing spam, some sites
33630 want to apply a lot of checking to messages before accepting them.
33631
33632 The content scanning extension (chapter &<<CHAPexiscan>>&) has facilities for
33633 passing messages to external virus and spam scanning software. You can also do
33634 a certain amount in Exim itself through string expansions and the &%condition%&
33635 condition in the ACL that runs after the SMTP DATA command or the ACL for
33636 non-SMTP messages (see chapter &<<CHAPACL>>&), but this has its limitations.
33637
33638 To allow for further customization to a site's own requirements, there is the
33639 possibility of linking Exim with a private message scanning function, written
33640 in C. If you want to run code that is written in something other than C, you
33641 can of course use a little C stub to call it.
33642
33643 The local scan function is run once for every incoming message, at the point
33644 when Exim is just about to accept the message.
33645 It can therefore be used to control non-SMTP messages from local processes as
33646 well as messages arriving via SMTP.
33647
33648 Exim applies a timeout to calls of the local scan function, and there is an
33649 option called &%local_scan_timeout%& for setting it. The default is 5 minutes.
33650 Zero means &"no timeout"&.
33651 Exim also sets up signal handlers for SIGSEGV, SIGILL, SIGFPE, and SIGBUS
33652 before calling the local scan function, so that the most common types of crash
33653 are caught. If the timeout is exceeded or one of those signals is caught, the
33654 incoming message is rejected with a temporary error if it is an SMTP message.
33655 For a non-SMTP message, the message is dropped and Exim ends with a non-zero
33656 code. The incident is logged on the main and reject logs.
33657
33658
33659
33660 .section "Building Exim to use a local scan function" "SECID207"
33661 .cindex "&[local_scan()]& function" "building Exim to use"
33662 To make use of the local scan function feature, you must tell Exim where your
33663 function is before building Exim, by setting
33664 both HAVE_LOCAL_SCAN and
33665 LOCAL_SCAN_SOURCE in your
33666 &_Local/Makefile_&. A recommended place to put it is in the &_Local_&
33667 directory, so you might set
33668 .code
33669 HAVE_LOCAL_SCAN=yes
33670 LOCAL_SCAN_SOURCE=Local/local_scan.c
33671 .endd
33672 for example. The function must be called &[local_scan()]&. It is called by
33673 Exim after it has received a message, when the success return code is about to
33674 be sent. This is after all the ACLs have been run. The return code from your
33675 function controls whether the message is actually accepted or not. There is a
33676 commented template function (that just accepts the message) in the file
33677 _src/local_scan.c_.
33678
33679 If you want to make use of Exim's runtime configuration file to set options
33680 for your &[local_scan()]& function, you must also set
33681 .code
33682 LOCAL_SCAN_HAS_OPTIONS=yes
33683 .endd
33684 in &_Local/Makefile_& (see section &<<SECTconoptloc>>& below).
33685
33686
33687
33688
33689 .section "API for local_scan()" "SECTapiforloc"
33690 .cindex "&[local_scan()]& function" "API description"
33691 .cindex &%dlfunc%& "API description"
33692 You must include this line near the start of your code:
33693 .code
33694 #include "local_scan.h"
33695 .endd
33696 This header file defines a number of variables and other values, and the
33697 prototype for the function itself. Exim is coded to use unsigned char values
33698 almost exclusively, and one of the things this header defines is a shorthand
33699 for &`unsigned char`& called &`uschar`&.
33700 It also contains the following macro definitions, to simplify casting character
33701 strings and pointers to character strings:
33702 .code
33703 #define CS   (char *)
33704 #define CCS  (const char *)
33705 #define CSS  (char **)
33706 #define US   (unsigned char *)
33707 #define CUS  (const unsigned char *)
33708 #define USS  (unsigned char **)
33709 .endd
33710 The function prototype for &[local_scan()]& is:
33711 .code
33712 extern int local_scan(int fd, uschar **return_text);
33713 .endd
33714 The arguments are as follows:
33715
33716 .ilist
33717 &%fd%& is a file descriptor for the file that contains the body of the message
33718 (the -D file). The file is open for reading and writing, but updating it is not
33719 recommended. &*Warning*&: You must &'not'& close this file descriptor.
33720
33721 The descriptor is positioned at character 19 of the file, which is the first
33722 character of the body itself, because the first 19 characters are the message
33723 id followed by &`-D`& and a newline. If you rewind the file, you should use the
33724 macro SPOOL_DATA_START_OFFSET to reset to the start of the data, just in
33725 case this changes in some future version.
33726 .next
33727 &%return_text%& is an address which you can use to return a pointer to a text
33728 string at the end of the function. The value it points to on entry is NULL.
33729 .endlist
33730
33731 The function must return an &%int%& value which is one of the following macros:
33732
33733 .vlist
33734 .vitem &`LOCAL_SCAN_ACCEPT`&
33735 .vindex "&$local_scan_data$&"
33736 The message is accepted. If you pass back a string of text, it is saved with
33737 the message, and made available in the variable &$local_scan_data$&. No
33738 newlines are permitted (if there are any, they are turned into spaces) and the
33739 maximum length of text is 1000 characters.
33740
33741 .vitem &`LOCAL_SCAN_ACCEPT_FREEZE`&
33742 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
33743 queued without immediate delivery, and is frozen.
33744
33745 .vitem &`LOCAL_SCAN_ACCEPT_QUEUE`&
33746 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
33747 queued without immediate delivery.
33748
33749 .vitem &`LOCAL_SCAN_REJECT`&
33750 The message is rejected; the returned text is used as an error message which is
33751 passed back to the sender and which is also logged. Newlines are permitted &--
33752 they cause a multiline response for SMTP rejections, but are converted to
33753 &`\n`& in log lines. If no message is given, &"Administrative prohibition"& is
33754 used.
33755
33756 .vitem &`LOCAL_SCAN_TEMPREJECT`&
33757 The message is temporarily rejected; the returned text is used as an error
33758 message as for LOCAL_SCAN_REJECT. If no message is given, &"Temporary local
33759 problem"& is used.
33760
33761 .vitem &`LOCAL_SCAN_REJECT_NOLOGHDR`&
33762 This behaves as LOCAL_SCAN_REJECT, except that the header of the rejected
33763 message is not written to the reject log. It has the effect of unsetting the
33764 &%rejected_header%& log selector for just this rejection. If
33765 &%rejected_header%& is already unset (see the discussion of the
33766 &%log_selection%& option in section &<<SECTlogselector>>&), this code is the
33767 same as LOCAL_SCAN_REJECT.
33768
33769 .vitem &`LOCAL_SCAN_TEMPREJECT_NOLOGHDR`&
33770 This code is a variation of LOCAL_SCAN_TEMPREJECT in the same way that
33771 LOCAL_SCAN_REJECT_NOLOGHDR is a variation of LOCAL_SCAN_REJECT.
33772 .endlist
33773
33774 If the message is not being received by interactive SMTP, rejections are
33775 reported by writing to &%stderr%& or by sending an email, as configured by the
33776 &%-oe%& command line options.
33777
33778
33779
33780 .section "Configuration options for local_scan()" "SECTconoptloc"
33781 .cindex "&[local_scan()]& function" "configuration options"
33782 It is possible to have option settings in the main configuration file
33783 that set values in static variables in the &[local_scan()]& module. If you
33784 want to do this, you must have the line
33785 .code
33786 LOCAL_SCAN_HAS_OPTIONS=yes
33787 .endd
33788 in your &_Local/Makefile_& when you build Exim. (This line is in
33789 &_OS/Makefile-Default_&, commented out). Then, in the &[local_scan()]& source
33790 file, you must define static variables to hold the option values, and a table
33791 to define them.
33792
33793 The table must be a vector called &%local_scan_options%&, of type
33794 &`optionlist`&. Each entry is a triplet, consisting of a name, an option type,
33795 and a pointer to the variable that holds the value. The entries must appear in
33796 alphabetical order. Following &%local_scan_options%& you must also define a
33797 variable called &%local_scan_options_count%& that contains the number of
33798 entries in the table. Here is a short example, showing two kinds of option:
33799 .code
33800 static int my_integer_option = 42;
33801 static uschar *my_string_option = US"a default string";
33802
33803 optionlist local_scan_options[] = {
33804   { "my_integer", opt_int,       &my_integer_option },
33805   { "my_string",  opt_stringptr, &my_string_option }
33806 };
33807
33808 int local_scan_options_count =
33809   sizeof(local_scan_options)/sizeof(optionlist);
33810 .endd
33811 The values of the variables can now be changed from Exim's runtime
33812 configuration file by including a local scan section as in this example:
33813 .code
33814 begin local_scan
33815 my_integer = 99
33816 my_string = some string of text...
33817 .endd
33818 The available types of option data are as follows:
33819
33820 .vlist
33821 .vitem &*opt_bool*&
33822 This specifies a boolean (true/false) option. The address should point to a
33823 variable of type &`BOOL`&, which will be set to TRUE or FALSE, which are macros
33824 that are defined as &"1"& and &"0"&, respectively. If you want to detect
33825 whether such a variable has been set at all, you can initialize it to
33826 TRUE_UNSET. (BOOL variables are integers underneath, so can hold more than two
33827 values.)
33828
33829 .vitem &*opt_fixed*&
33830 This specifies a fixed point number, such as is used for load averages.
33831 The address should point to a variable of type &`int`&. The value is stored
33832 multiplied by 1000, so, for example, 1.4142 is truncated and stored as 1414.
33833
33834 .vitem &*opt_int*&
33835 This specifies an integer; the address should point to a variable of type
33836 &`int`&. The value may be specified in any of the integer formats accepted by
33837 Exim.
33838
33839 .vitem &*opt_mkint*&
33840 This is the same as &%opt_int%&, except that when such a value is output in a
33841 &%-bP%& listing, if it is an exact number of kilobytes or megabytes, it is
33842 printed with the suffix K or M.
33843
33844 .vitem &*opt_octint*&
33845 This also specifies an integer, but the value is always interpreted as an
33846 octal integer, whether or not it starts with the digit zero, and it is
33847 always output in octal.
33848
33849 .vitem &*opt_stringptr*&
33850 This specifies a string value; the address must be a pointer to a
33851 variable that points to a string (for example, of type &`uschar *`&).
33852
33853 .vitem &*opt_time*&
33854 This specifies a time interval value. The address must point to a variable of
33855 type &`int`&. The value that is placed there is a number of seconds.
33856 .endlist
33857
33858 If the &%-bP%& command line option is followed by &`local_scan`&, Exim prints
33859 out the values of all the &[local_scan()]& options.
33860
33861
33862
33863 .section "Available Exim variables" "SECID208"
33864 .cindex "&[local_scan()]& function" "available Exim variables"
33865 The header &_local_scan.h_& gives you access to a number of C variables. These
33866 are the only ones that are guaranteed to be maintained from release to release.
33867 Note, however, that you can obtain the value of any Exim expansion variable,
33868 including &$recipients$&, by calling &'expand_string()'&. The exported
33869 C variables are as follows:
33870
33871 .vlist
33872 .vitem &*int&~body_linecount*&
33873 This variable contains the number of lines in the message's body.
33874 It is not valid if the &%spool_files_wireformat%& option is used.
33875
33876 .vitem &*int&~body_zerocount*&
33877 This variable contains the number of binary zero bytes in the message's body.
33878 It is not valid if the &%spool_files_wireformat%& option is used.
33879
33880 .vitem &*unsigned&~int&~debug_selector*&
33881 This variable is set to zero when no debugging is taking place. Otherwise, it
33882 is a bitmap of debugging selectors. Two bits are identified for use in
33883 &[local_scan()]&; they are defined as macros:
33884
33885 .ilist
33886 The &`D_v`& bit is set when &%-v%& was present on the command line. This is a
33887 testing option that is not privileged &-- any caller may set it. All the
33888 other selector bits can be set only by admin users.
33889
33890 .next
33891 The &`D_local_scan`& bit is provided for use by &[local_scan()]&; it is set
33892 by the &`+local_scan`& debug selector. It is not included in the default set
33893 of debugging bits.
33894 .endlist ilist
33895
33896 Thus, to write to the debugging output only when &`+local_scan`& has been
33897 selected, you should use code like this:
33898 .code
33899 if ((debug_selector & D_local_scan) != 0)
33900   debug_printf("xxx", ...);
33901 .endd
33902 .vitem &*uschar&~*expand_string_message*&
33903 After a failing call to &'expand_string()'& (returned value NULL), the
33904 variable &%expand_string_message%& contains the error message, zero-terminated.
33905
33906 .vitem &*header_line&~*header_list*&
33907 A pointer to a chain of header lines. The &%header_line%& structure is
33908 discussed below.
33909
33910 .vitem &*header_line&~*header_last*&
33911 A pointer to the last of the header lines.
33912
33913 .vitem &*uschar&~*headers_charset*&
33914 The value of the &%headers_charset%& configuration option.
33915
33916 .vitem &*BOOL&~host_checking*&
33917 This variable is TRUE during a host checking session that is initiated by the
33918 &%-bh%& command line option.
33919
33920 .vitem &*uschar&~*interface_address*&
33921 The IP address of the interface that received the message, as a string. This
33922 is NULL for locally submitted messages.
33923
33924 .vitem &*int&~interface_port*&
33925 The port on which this message was received. When testing with the &%-bh%&
33926 command line option, the value of this variable is -1 unless a port has been
33927 specified via the &%-oMi%& option.
33928
33929 .vitem &*uschar&~*message_id*&
33930 This variable contains Exim's message id for the incoming message (the value of
33931 &$message_exim_id$&) as a zero-terminated string.
33932
33933 .vitem &*uschar&~*received_protocol*&
33934 The name of the protocol by which the message was received.
33935
33936 .vitem &*int&~recipients_count*&
33937 The number of accepted recipients.
33938
33939 .vitem &*recipient_item&~*recipients_list*&
33940 .cindex "recipient" "adding in local scan"
33941 .cindex "recipient" "removing in local scan"
33942 The list of accepted recipients, held in a vector of length
33943 &%recipients_count%&. The &%recipient_item%& structure is discussed below. You
33944 can add additional recipients by calling &'receive_add_recipient()'& (see
33945 below). You can delete recipients by removing them from the vector and
33946 adjusting the value in &%recipients_count%&. In particular, by setting
33947 &%recipients_count%& to zero you remove all recipients. If you then return the
33948 value &`LOCAL_SCAN_ACCEPT`&, the message is accepted, but immediately
33949 blackholed. To replace the recipients, you can set &%recipients_count%& to zero
33950 and then call &'receive_add_recipient()'& as often as needed.
33951
33952 .vitem &*uschar&~*sender_address*&
33953 The envelope sender address. For bounce messages this is the empty string.
33954
33955 .vitem &*uschar&~*sender_host_address*&
33956 The IP address of the sending host, as a string. This is NULL for
33957 locally-submitted messages.
33958
33959 .vitem &*uschar&~*sender_host_authenticated*&
33960 The name of the authentication mechanism that was used, or NULL if the message
33961 was not received over an authenticated SMTP connection.
33962
33963 .vitem &*uschar&~*sender_host_name*&
33964 The name of the sending host, if known.
33965
33966 .vitem &*int&~sender_host_port*&
33967 The port on the sending host.
33968
33969 .vitem &*BOOL&~smtp_input*&
33970 This variable is TRUE for all SMTP input, including BSMTP.
33971
33972 .vitem &*BOOL&~smtp_batched_input*&
33973 This variable is TRUE for BSMTP input.
33974
33975 .vitem &*int&~store_pool*&
33976 The contents of this variable control which pool of memory is used for new
33977 requests. See section &<<SECTmemhanloc>>& for details.
33978 .endlist
33979
33980
33981 .section "Structure of header lines" "SECID209"
33982 The &%header_line%& structure contains the members listed below.
33983 You can add additional header lines by calling the &'header_add()'& function
33984 (see below). You can cause header lines to be ignored (deleted) by setting
33985 their type to *.
33986
33987
33988 .vlist
33989 .vitem &*struct&~header_line&~*next*&
33990 A pointer to the next header line, or NULL for the last line.
33991
33992 .vitem &*int&~type*&
33993 A code identifying certain headers that Exim recognizes. The codes are printing
33994 characters, and are documented in chapter &<<CHAPspool>>& of this manual.
33995 Notice in particular that any header line whose type is * is not transmitted
33996 with the message. This flagging is used for header lines that have been
33997 rewritten, or are to be removed (for example, &'Envelope-sender:'& header
33998 lines.) Effectively, * means &"deleted"&.
33999
34000 .vitem &*int&~slen*&
34001 The number of characters in the header line, including the terminating and any
34002 internal newlines.
34003
34004 .vitem &*uschar&~*text*&
34005 A pointer to the text of the header. It always ends with a newline, followed by
34006 a zero byte. Internal newlines are preserved.
34007 .endlist
34008
34009
34010
34011 .section "Structure of recipient items" "SECID210"
34012 The &%recipient_item%& structure contains these members:
34013
34014 .vlist
34015 .vitem &*uschar&~*address*&
34016 This is a pointer to the recipient address as it was received.
34017
34018 .vitem &*int&~pno*&
34019 This is used in later Exim processing when top level addresses are created by
34020 the &%one_time%& option. It is not relevant at the time &[local_scan()]& is run
34021 and must always contain -1 at this stage.
34022
34023 .vitem &*uschar&~*errors_to*&
34024 If this value is not NULL, bounce messages caused by failing to deliver to the
34025 recipient are sent to the address it contains. In other words, it overrides the
34026 envelope sender for this one recipient. (Compare the &%errors_to%& generic
34027 router option.) If a &[local_scan()]& function sets an &%errors_to%& field to
34028 an unqualified address, Exim qualifies it using the domain from
34029 &%qualify_recipient%&. When &[local_scan()]& is called, the &%errors_to%& field
34030 is NULL for all recipients.
34031 .endlist
34032
34033
34034
34035 .section "Available Exim functions" "SECID211"
34036 .cindex "&[local_scan()]& function" "available Exim functions"
34037 The header &_local_scan.h_& gives you access to a number of Exim functions.
34038 These are the only ones that are guaranteed to be maintained from release to
34039 release:
34040
34041 .vlist
34042 .vitem "&*pid_t&~child_open(uschar&~**argv,&~uschar&~**envp,&~int&~newumask,&&&
34043        &~int&~*infdptr,&~int&~*outfdptr, &~&~BOOL&~make_leader)*&"
34044
34045 This function creates a child process that runs the command specified by
34046 &%argv%&. The environment for the process is specified by &%envp%&, which can
34047 be NULL if no environment variables are to be passed. A new umask is supplied
34048 for the process in &%newumask%&.
34049
34050 Pipes to the standard input and output of the new process are set up
34051 and returned to the caller via the &%infdptr%& and &%outfdptr%& arguments. The
34052 standard error is cloned to the standard output. If there are any file
34053 descriptors &"in the way"& in the new process, they are closed. If the final
34054 argument is TRUE, the new process is made into a process group leader.
34055
34056 The function returns the pid of the new process, or -1 if things go wrong.
34057
34058 .vitem &*int&~child_close(pid_t&~pid,&~int&~timeout)*&
34059 This function waits for a child process to terminate, or for a timeout (in
34060 seconds) to expire. A timeout value of zero means wait as long as it takes. The
34061 return value is as follows:
34062
34063 .ilist
34064 >= 0
34065
34066 The process terminated by a normal exit and the value is the process
34067 ending status.
34068
34069 .next
34070 < 0 and > &--256
34071
34072 The process was terminated by a signal and the value is the negation of the
34073 signal number.
34074
34075 .next
34076 &--256
34077
34078 The process timed out.
34079 .next
34080 &--257
34081
34082 The was some other error in wait(); &%errno%& is still set.
34083 .endlist
34084
34085 .vitem &*pid_t&~child_open_exim(int&~*fd)*&
34086 This function provide you with a means of submitting a new message to
34087 Exim. (Of course, you can also call &_/usr/sbin/sendmail_& yourself if you
34088 want, but this packages it all up for you.) The function creates a pipe,
34089 forks a subprocess that is running
34090 .code
34091 exim -t -oem -oi -f <>
34092 .endd
34093 and returns to you (via the &`int *`& argument) a file descriptor for the pipe
34094 that is connected to the standard input. The yield of the function is the PID
34095 of the subprocess. You can then write a message to the file descriptor, with
34096 recipients in &'To:'&, &'Cc:'&, and/or &'Bcc:'& header lines.
34097
34098 When you have finished, call &'child_close()'& to wait for the process to
34099 finish and to collect its ending status. A timeout value of zero is usually
34100 fine in this circumstance. Unless you have made a mistake with the recipient
34101 addresses, you should get a return code of zero.
34102
34103
34104 .vitem &*pid_t&~child_open_exim2(int&~*fd,&~uschar&~*sender,&~uschar&~&&&
34105        *sender_authentication)*&
34106 This function is a more sophisticated version of &'child_open()'&. The command
34107 that it runs is:
34108 .display
34109 &`exim -t -oem -oi -f `&&'sender'&&` -oMas `&&'sender_authentication'&
34110 .endd
34111 The third argument may be NULL, in which case the &%-oMas%& option is omitted.
34112
34113
34114 .vitem &*void&~debug_printf(char&~*,&~...)*&
34115 This is Exim's debugging function, with arguments as for &'(printf()'&. The
34116 output is written to the standard error stream. If no debugging is selected,
34117 calls to &'debug_printf()'& have no effect. Normally, you should make calls
34118 conditional on the &`local_scan`& debug selector by coding like this:
34119 .code
34120 if ((debug_selector & D_local_scan) != 0)
34121   debug_printf("xxx", ...);
34122 .endd
34123
34124 .vitem &*uschar&~*expand_string(uschar&~*string)*&
34125 This is an interface to Exim's string expansion code. The return value is the
34126 expanded string, or NULL if there was an expansion failure.
34127 The C variable &%expand_string_message%& contains an error message after an
34128 expansion failure. If expansion does not change the string, the return value is
34129 the pointer to the input string. Otherwise, the return value points to a new
34130 block of memory that was obtained by a call to &'store_get()'&. See section
34131 &<<SECTmemhanloc>>& below for a discussion of memory handling.
34132
34133 .vitem &*void&~header_add(int&~type,&~char&~*format,&~...)*&
34134 This function allows you to an add additional header line at the end of the
34135 existing ones. The first argument is the type, and should normally be a space
34136 character. The second argument is a format string and any number of
34137 substitution arguments as for &[sprintf()]&. You may include internal newlines
34138 if you want, and you must ensure that the string ends with a newline.
34139
34140 .vitem "&*void&~header_add_at_position(BOOL&~after,&~uschar&~*name,&~&&&
34141         BOOL&~topnot,&~int&~type,&~char&~*format, &~&~...)*&"
34142 This function adds a new header line at a specified point in the header
34143 chain. The header itself is specified as for &'header_add()'&.
34144
34145 If &%name%& is NULL, the new header is added at the end of the chain if
34146 &%after%& is true, or at the start if &%after%& is false. If &%name%& is not
34147 NULL, the header lines are searched for the first non-deleted header that
34148 matches the name. If one is found, the new header is added before it if
34149 &%after%& is false. If &%after%& is true, the new header is added after the
34150 found header and any adjacent subsequent ones with the same name (even if
34151 marked &"deleted"&). If no matching non-deleted header is found, the &%topnot%&
34152 option controls where the header is added. If it is true, addition is at the
34153 top; otherwise at the bottom. Thus, to add a header after all the &'Received:'&
34154 headers, or at the top if there are no &'Received:'& headers, you could use
34155 .code
34156 header_add_at_position(TRUE, US"Received", TRUE,
34157   ' ', "X-xxx: ...");
34158 .endd
34159 Normally, there is always at least one non-deleted &'Received:'& header, but
34160 there may not be if &%received_header_text%& expands to an empty string.
34161
34162
34163 .vitem &*void&~header_remove(int&~occurrence,&~uschar&~*name)*&
34164 This function removes header lines. If &%occurrence%& is zero or negative, all
34165 occurrences of the header are removed. If occurrence is greater than zero, that
34166 particular instance of the header is removed. If no header(s) can be found that
34167 match the specification, the function does nothing.
34168
34169
34170 .vitem "&*BOOL&~header_testname(header_line&~*hdr,&~uschar&~*name,&~&&&
34171         int&~length,&~BOOL&~notdel)*&"
34172 This function tests whether the given header has the given name. It is not just
34173 a string comparison, because white space is permitted between the name and the
34174 colon. If the &%notdel%& argument is true, a false return is forced for all
34175 &"deleted"& headers; otherwise they are not treated specially. For example:
34176 .code
34177 if (header_testname(h, US"X-Spam", 6, TRUE)) ...
34178 .endd
34179 .vitem &*uschar&~*lss_b64encode(uschar&~*cleartext,&~int&~length)*&
34180 .cindex "base64 encoding" "functions for &[local_scan()]& use"
34181 This function base64-encodes a string, which is passed by address and length.
34182 The text may contain bytes of any value, including zero. The result is passed
34183 back in dynamic memory that is obtained by calling &'store_get()'&. It is
34184 zero-terminated.
34185
34186 .vitem &*int&~lss_b64decode(uschar&~*codetext,&~uschar&~**cleartext)*&
34187 This function decodes a base64-encoded string. Its arguments are a
34188 zero-terminated base64-encoded string and the address of a variable that is set
34189 to point to the result, which is in dynamic memory. The length of the decoded
34190 string is the yield of the function. If the input is invalid base64 data, the
34191 yield is -1. A zero byte is added to the end of the output string to make it
34192 easy to interpret as a C string (assuming it contains no zeros of its own). The
34193 added zero byte is not included in the returned count.
34194
34195 .vitem &*int&~lss_match_domain(uschar&~*domain,&~uschar&~*list)*&
34196 This function checks for a match in a domain list. Domains are always
34197 matched caselessly. The return value is one of the following:
34198 .display
34199 &`OK     `& match succeeded
34200 &`FAIL   `& match failed
34201 &`DEFER  `& match deferred
34202 .endd
34203 DEFER is usually caused by some kind of lookup defer, such as the
34204 inability to contact a database.
34205
34206 .vitem "&*int&~lss_match_local_part(uschar&~*localpart,&~uschar&~*list,&~&&&
34207         BOOL&~caseless)*&"
34208 This function checks for a match in a local part list. The third argument
34209 controls case-sensitivity. The return values are as for
34210 &'lss_match_domain()'&.
34211
34212 .vitem "&*int&~lss_match_address(uschar&~*address,&~uschar&~*list,&~&&&
34213         BOOL&~caseless)*&"
34214 This function checks for a match in an address list. The third argument
34215 controls the case-sensitivity of the local part match. The domain is always
34216 matched caselessly. The return values are as for &'lss_match_domain()'&.
34217
34218 .vitem "&*int&~lss_match_host(uschar&~*host_name,&~uschar&~*host_address,&~&&&
34219         uschar&~*list)*&"
34220 This function checks for a match in a host list. The most common usage is
34221 expected to be
34222 .code
34223 lss_match_host(sender_host_name, sender_host_address, ...)
34224 .endd
34225 .vindex "&$sender_host_address$&"
34226 An empty address field matches an empty item in the host list. If the host name
34227 is NULL, the name corresponding to &$sender_host_address$& is automatically
34228 looked up if a host name is required to match an item in the list. The return
34229 values are as for &'lss_match_domain()'&, but in addition, &'lss_match_host()'&
34230 returns ERROR in the case when it had to look up a host name, but the lookup
34231 failed.
34232
34233 .vitem "&*void&~log_write(unsigned&~int&~selector,&~int&~which,&~char&~&&&
34234         *format,&~...)*&"
34235 This function writes to Exim's log files. The first argument should be zero (it
34236 is concerned with &%log_selector%&). The second argument can be &`LOG_MAIN`& or
34237 &`LOG_REJECT`& or &`LOG_PANIC`& or the inclusive &"or"& of any combination of
34238 them. It specifies to which log or logs the message is written. The remaining
34239 arguments are a format and relevant insertion arguments. The string should not
34240 contain any newlines, not even at the end.
34241
34242
34243 .vitem &*void&~receive_add_recipient(uschar&~*address,&~int&~pno)*&
34244 This function adds an additional recipient to the message. The first argument
34245 is the recipient address. If it is unqualified (has no domain), it is qualified
34246 with the &%qualify_recipient%& domain. The second argument must always be -1.
34247
34248 This function does not allow you to specify a private &%errors_to%& address (as
34249 described with the structure of &%recipient_item%& above), because it pre-dates
34250 the addition of that field to the structure. However, it is easy to add such a
34251 value afterwards. For example:
34252 .code
34253  receive_add_recipient(US"monitor@mydom.example", -1);
34254  recipients_list[recipients_count-1].errors_to =
34255    US"postmaster@mydom.example";
34256 .endd
34257
34258 .vitem &*BOOL&~receive_remove_recipient(uschar&~*recipient)*&
34259 This is a convenience function to remove a named recipient from the list of
34260 recipients. It returns true if a recipient was removed, and false if no
34261 matching recipient could be found. The argument must be a complete email
34262 address.
34263 .endlist
34264
34265
34266 .cindex "RFC 2047"
34267 .vlist
34268 .vitem "&*uschar&~rfc2047_decode(uschar&~*string,&~BOOL&~lencheck,&&&
34269   &~uschar&~*target,&~int&~zeroval,&~int&~*lenptr, &~&~uschar&~**error)*&"
34270 This function decodes strings that are encoded according to RFC 2047. Typically
34271 these are the contents of header lines. First, each &"encoded word"& is decoded
34272 from the Q or B encoding into a byte-string. Then, if provided with the name of
34273 a charset encoding, and if the &[iconv()]& function is available, an attempt is
34274 made  to translate the result to the named character set. If this fails, the
34275 binary string is returned with an error message.
34276
34277 The first argument is the string to be decoded. If &%lencheck%& is TRUE, the
34278 maximum MIME word length is enforced. The third argument is the target
34279 encoding, or NULL if no translation is wanted.
34280
34281 .cindex "binary zero" "in RFC 2047 decoding"
34282 .cindex "RFC 2047" "binary zero in"
34283 If a binary zero is encountered in the decoded string, it is replaced by the
34284 contents of the &%zeroval%& argument. For use with Exim headers, the value must
34285 not be 0 because header lines are handled as zero-terminated strings.
34286
34287 The function returns the result of processing the string, zero-terminated; if
34288 &%lenptr%& is not NULL, the length of the result is set in the variable to
34289 which it points. When &%zeroval%& is 0, &%lenptr%& should not be NULL.
34290
34291 If an error is encountered, the function returns NULL and uses the &%error%&
34292 argument to return an error message. The variable pointed to by &%error%& is
34293 set to NULL if there is no error; it may be set non-NULL even when the function
34294 returns a non-NULL value if decoding was successful, but there was a problem
34295 with translation.
34296
34297
34298 .vitem &*int&~smtp_fflush(void)*&
34299 This function is used in conjunction with &'smtp_printf()'&, as described
34300 below.
34301
34302 .vitem &*void&~smtp_printf(char&~*,&~...)*&
34303 The arguments of this function are like &[printf()]&; it writes to the SMTP
34304 output stream. You should use this function only when there is an SMTP output
34305 stream, that is, when the incoming message is being received via interactive
34306 SMTP. This is the case when &%smtp_input%& is TRUE and &%smtp_batched_input%&
34307 is FALSE. If you want to test for an incoming message from another host (as
34308 opposed to a local process that used the &%-bs%& command line option), you can
34309 test the value of &%sender_host_address%&, which is non-NULL when a remote host
34310 is involved.
34311
34312 If an SMTP TLS connection is established, &'smtp_printf()'& uses the TLS
34313 output function, so it can be used for all forms of SMTP connection.
34314
34315 Strings that are written by &'smtp_printf()'& from within &[local_scan()]&
34316 must start with an appropriate response code: 550 if you are going to return
34317 LOCAL_SCAN_REJECT, 451 if you are going to return
34318 LOCAL_SCAN_TEMPREJECT, and 250 otherwise. Because you are writing the
34319 initial lines of a multi-line response, the code must be followed by a hyphen
34320 to indicate that the line is not the final response line. You must also ensure
34321 that the lines you write terminate with CRLF. For example:
34322 .code
34323 smtp_printf("550-this is some extra info\r\n");
34324 return LOCAL_SCAN_REJECT;
34325 .endd
34326 Note that you can also create multi-line responses by including newlines in
34327 the data returned via the &%return_text%& argument. The added value of using
34328 &'smtp_printf()'& is that, for instance, you could introduce delays between
34329 multiple output lines.
34330
34331 The &'smtp_printf()'& function does not return any error indication, because it
34332 does not automatically flush pending output, and therefore does not test
34333 the state of the stream. (In the main code of Exim, flushing and error
34334 detection is done when Exim is ready for the next SMTP input command.) If
34335 you want to flush the output and check for an error (for example, the
34336 dropping of a TCP/IP connection), you can call &'smtp_fflush()'&, which has no
34337 arguments. It flushes the output stream, and returns a non-zero value if there
34338 is an error.
34339
34340 .vitem &*void&~*store_get(int)*&
34341 This function accesses Exim's internal store (memory) manager. It gets a new
34342 chunk of memory whose size is given by the argument. Exim bombs out if it ever
34343 runs out of memory. See the next section for a discussion of memory handling.
34344
34345 .vitem &*void&~*store_get_perm(int)*&
34346 This function is like &'store_get()'&, but it always gets memory from the
34347 permanent pool. See the next section for a discussion of memory handling.
34348
34349 .vitem &*uschar&~*string_copy(uschar&~*string)*&
34350 See below.
34351
34352 .vitem &*uschar&~*string_copyn(uschar&~*string,&~int&~length)*&
34353 See below.
34354
34355 .vitem &*uschar&~*string_sprintf(char&~*format,&~...)*&
34356 These three functions create strings using Exim's dynamic memory facilities.
34357 The first makes a copy of an entire string. The second copies up to a maximum
34358 number of characters, indicated by the second argument. The third uses a format
34359 and insertion arguments to create a new string. In each case, the result is a
34360 pointer to a new string in the current memory pool. See the next section for
34361 more discussion.
34362 .endlist
34363
34364
34365
34366 .section "More about Exim's memory handling" "SECTmemhanloc"
34367 .cindex "&[local_scan()]& function" "memory handling"
34368 No function is provided for freeing memory, because that is never needed.
34369 The dynamic memory that Exim uses when receiving a message is automatically
34370 recycled if another message is received by the same process (this applies only
34371 to incoming SMTP connections &-- other input methods can supply only one
34372 message at a time). After receiving the last message, a reception process
34373 terminates.
34374
34375 Because it is recycled, the normal dynamic memory cannot be used for holding
34376 data that must be preserved over a number of incoming messages on the same SMTP
34377 connection. However, Exim in fact uses two pools of dynamic memory; the second
34378 one is not recycled, and can be used for this purpose.
34379
34380 If you want to allocate memory that remains available for subsequent messages
34381 in the same SMTP connection, you should set
34382 .code
34383 store_pool = POOL_PERM
34384 .endd
34385 before calling the function that does the allocation. There is no need to
34386 restore the value if you do not need to; however, if you do want to revert to
34387 the normal pool, you can either restore the previous value of &%store_pool%& or
34388 set it explicitly to POOL_MAIN.
34389
34390 The pool setting applies to all functions that get dynamic memory, including
34391 &'expand_string()'&, &'store_get()'&, and the &'string_xxx()'& functions.
34392 There is also a convenience function called &'store_get_perm()'& that gets a
34393 block of memory from the permanent pool while preserving the value of
34394 &%store_pool%&.
34395 .ecindex IIDlosca
34396
34397
34398
34399
34400 . ////////////////////////////////////////////////////////////////////////////
34401 . ////////////////////////////////////////////////////////////////////////////
34402
34403 .chapter "System-wide message filtering" "CHAPsystemfilter"
34404 .scindex IIDsysfil1 "filter" "system filter"
34405 .scindex IIDsysfil2 "filtering all mail"
34406 .scindex IIDsysfil3 "system filter"
34407 The previous chapters (on ACLs and the local scan function) describe checks
34408 that can be applied to messages before they are accepted by a host. There is
34409 also a mechanism for checking messages once they have been received, but before
34410 they are delivered. This is called the &'system filter'&.
34411
34412 The system filter operates in a similar manner to users' filter files, but it
34413 is run just once per message (however many recipients the message has).
34414 It should not normally be used as a substitute for routing, because &%deliver%&
34415 commands in a system router provide new envelope recipient addresses.
34416 The system filter must be an Exim filter. It cannot be a Sieve filter.
34417
34418 The system filter is run at the start of a delivery attempt, before any routing
34419 is done. If a message fails to be completely delivered at the first attempt,
34420 the system filter is run again at the start of every retry.
34421 If you want your filter to do something only once per message, you can make use
34422 of the &%first_delivery%& condition in an &%if%& command in the filter to
34423 prevent it happening on retries.
34424
34425 .vindex "&$domain$&"
34426 .vindex "&$local_part$&"
34427 &*Warning*&: Because the system filter runs just once, variables that are
34428 specific to individual recipient addresses, such as &$local_part$& and
34429 &$domain$&, are not set, and the &"personal"& condition is not meaningful. If
34430 you want to run a centrally-specified filter for each recipient address
34431 independently, you can do so by setting up a suitable &(redirect)& router, as
34432 described in section &<<SECTperaddfil>>& below.
34433
34434
34435 .section "Specifying a system filter" "SECID212"
34436 .cindex "uid (user id)" "system filter"
34437 .cindex "gid (group id)" "system filter"
34438 The name of the file that contains the system filter must be specified by
34439 setting &%system_filter%&. If you want the filter to run under a uid and gid
34440 other than root, you must also set &%system_filter_user%& and
34441 &%system_filter_group%& as appropriate. For example:
34442 .code
34443 system_filter = /etc/mail/exim.filter
34444 system_filter_user = exim
34445 .endd
34446 If a system filter generates any deliveries directly to files or pipes (via the
34447 &%save%& or &%pipe%& commands), transports to handle these deliveries must be
34448 specified by setting &%system_filter_file_transport%& and
34449 &%system_filter_pipe_transport%&, respectively. Similarly,
34450 &%system_filter_reply_transport%& must be set to handle any messages generated
34451 by the &%reply%& command.
34452
34453
34454 .section "Testing a system filter" "SECID213"
34455 You can run simple tests of a system filter in the same way as for a user
34456 filter, but you should use &%-bF%& rather than &%-bf%&, so that features that
34457 are permitted only in system filters are recognized.
34458
34459 If you want to test the combined effect of a system filter and a user filter,
34460 you can use both &%-bF%& and &%-bf%& on the same command line.
34461
34462
34463
34464 .section "Contents of a system filter" "SECID214"
34465 The language used to specify system filters is the same as for users' filter
34466 files. It is described in the separate end-user document &'Exim's interface to
34467 mail filtering'&. However, there are some additional features that are
34468 available only in system filters; these are described in subsequent sections.
34469 If they are encountered in a user's filter file or when testing with &%-bf%&,
34470 they cause errors.
34471
34472 .cindex "frozen messages" "manual thaw; testing in filter"
34473 There are two special conditions which, though available in users' filter
34474 files, are designed for use in system filters. The condition &%first_delivery%&
34475 is true only for the first attempt at delivering a message, and
34476 &%manually_thawed%& is true only if the message has been frozen, and
34477 subsequently thawed by an admin user. An explicit forced delivery counts as a
34478 manual thaw, but thawing as a result of the &%auto_thaw%& setting does not.
34479
34480 &*Warning*&: If a system filter uses the &%first_delivery%& condition to
34481 specify an &"unseen"& (non-significant) delivery, and that delivery does not
34482 succeed, it will not be tried again.
34483 If you want Exim to retry an unseen delivery until it succeeds, you should
34484 arrange to set it up every time the filter runs.
34485
34486 When a system filter finishes running, the values of the variables &$n0$& &--
34487 &$n9$& are copied into &$sn0$& &-- &$sn9$& and are thereby made available to
34488 users' filter files. Thus a system filter can, for example, set up &"scores"&
34489 to which users' filter files can refer.
34490
34491
34492
34493 .section "Additional variable for system filters" "SECID215"
34494 .vindex "&$recipients$&"
34495 The expansion variable &$recipients$&, containing a list of all the recipients
34496 of the message (separated by commas and white space), is available in system
34497 filters. It is not available in users' filters for privacy reasons.
34498
34499
34500
34501 .section "Defer, freeze, and fail commands for system filters" "SECID216"
34502 .cindex "freezing messages"
34503 .cindex "message" "freezing"
34504 .cindex "message" "forced failure"
34505 .cindex "&%fail%&" "in system filter"
34506 .cindex "&%freeze%& in system filter"
34507 .cindex "&%defer%& in system filter"
34508 There are three extra commands (&%defer%&, &%freeze%& and &%fail%&) which are
34509 always available in system filters, but are not normally enabled in users'
34510 filters. (See the &%allow_defer%&, &%allow_freeze%& and &%allow_fail%& options
34511 for the &(redirect)& router.) These commands can optionally be followed by the
34512 word &%text%& and a string containing an error message, for example:
34513 .code
34514 fail text "this message looks like spam to me"
34515 .endd
34516 The keyword &%text%& is optional if the next character is a double quote.
34517
34518 The &%defer%& command defers delivery of the original recipients of the
34519 message. The &%fail%& command causes all the original recipients to be failed,
34520 and a bounce message to be created. The &%freeze%& command suspends all
34521 delivery attempts for the original recipients. In all cases, any new deliveries
34522 that are specified by the filter are attempted as normal after the filter has
34523 run.
34524
34525 The &%freeze%& command is ignored if the message has been manually unfrozen and
34526 not manually frozen since. This means that automatic freezing by a system
34527 filter can be used as a way of checking out suspicious messages. If a message
34528 is found to be all right, manually unfreezing it allows it to be delivered.
34529
34530 .cindex "log" "&%fail%& command log line"
34531 .cindex "&%fail%&" "log line; reducing"
34532 The text given with a fail command is used as part of the bounce message as
34533 well as being written to the log. If the message is quite long, this can fill
34534 up a lot of log space when such failures are common. To reduce the size of the
34535 log message, Exim interprets the text in a special way if it starts with the
34536 two characters &`<<`& and contains &`>>`& later. The text between these two
34537 strings is written to the log, and the rest of the text is used in the bounce
34538 message. For example:
34539 .code
34540 fail "<<filter test 1>>Your message is rejected \
34541      because it contains attachments that we are \
34542      not prepared to receive."
34543 .endd
34544
34545 .cindex "loop" "caused by &%fail%&"
34546 Take great care with the &%fail%& command when basing the decision to fail on
34547 the contents of the message, because the bounce message will of course include
34548 the contents of the original message and will therefore trigger the &%fail%&
34549 command again (causing a mail loop) unless steps are taken to prevent this.
34550 Testing the &%error_message%& condition is one way to prevent this. You could
34551 use, for example
34552 .code
34553 if $message_body contains "this is spam" and not error_message
34554 then fail text "spam is not wanted here" endif
34555 .endd
34556 though of course that might let through unwanted bounce messages. The
34557 alternative is clever checking of the body and/or headers to detect bounces
34558 generated by the filter.
34559
34560 The interpretation of a system filter file ceases after a
34561 &%defer%&,
34562 &%freeze%&, or &%fail%& command is obeyed. However, any deliveries that were
34563 set up earlier in the filter file are honoured, so you can use a sequence such
34564 as
34565 .code
34566 mail ...
34567 freeze
34568 .endd
34569 to send a specified message when the system filter is freezing (or deferring or
34570 failing) a message. The normal deliveries for the message do not, of course,
34571 take place.
34572
34573
34574
34575 .section "Adding and removing headers in a system filter" "SECTaddremheasys"
34576 .cindex "header lines" "adding; in system filter"
34577 .cindex "header lines" "removing; in system filter"
34578 .cindex "filter" "header lines; adding/removing"
34579 Two filter commands that are available only in system filters are:
34580 .code
34581 headers add <string>
34582 headers remove <string>
34583 .endd
34584 The argument for the &%headers add%& is a string that is expanded and then
34585 added to the end of the message's headers. It is the responsibility of the
34586 filter maintainer to make sure it conforms to RFC 2822 syntax. Leading white
34587 space is ignored, and if the string is otherwise empty, or if the expansion is
34588 forced to fail, the command has no effect.
34589
34590 You can use &"\n"& within the string, followed by white space, to specify
34591 continued header lines. More than one header may be added in one command by
34592 including &"\n"& within the string without any following white space. For
34593 example:
34594 .code
34595 headers add "X-header-1: ....\n  \
34596              continuation of X-header-1 ...\n\
34597              X-header-2: ...."
34598 .endd
34599 Note that the header line continuation white space after the first newline must
34600 be placed before the backslash that continues the input string, because white
34601 space after input continuations is ignored.
34602
34603 The argument for &%headers remove%& is a colon-separated list of header names.
34604 This command applies only to those headers that are stored with the message;
34605 those that are added at delivery time (such as &'Envelope-To:'& and
34606 &'Return-Path:'&) cannot be removed by this means. If there is more than one
34607 header with the same name, they are all removed.
34608
34609 The &%headers%& command in a system filter makes an immediate change to the set
34610 of header lines that was received with the message (with possible additions
34611 from ACL processing). Subsequent commands in the system filter operate on the
34612 modified set, which also forms the basis for subsequent message delivery.
34613 Unless further modified during routing or transporting, this set of headers is
34614 used for all recipients of the message.
34615
34616 During routing and transporting, the variables that refer to the contents of
34617 header lines refer only to those lines that are in this set. Thus, header lines
34618 that are added by a system filter are visible to users' filter files and to all
34619 routers and transports. This contrasts with the manipulation of header lines by
34620 routers and transports, which is not immediate, but which instead is saved up
34621 until the message is actually being written (see section
34622 &<<SECTheadersaddrem>>&).
34623
34624 If the message is not delivered at the first attempt, header lines that were
34625 added by the system filter are stored with the message, and so are still
34626 present at the next delivery attempt. Header lines that were removed are still
34627 present, but marked &"deleted"& so that they are not transported with the
34628 message. For this reason, it is usual to make the &%headers%& command
34629 conditional on &%first_delivery%& so that the set of header lines is not
34630 modified more than once.
34631
34632 Because header modification in a system filter acts immediately, you have to
34633 use an indirect approach if you want to modify the contents of a header line.
34634 For example:
34635 .code
34636 headers add "Old-Subject: $h_subject:"
34637 headers remove "Subject"
34638 headers add "Subject: new subject (was: $h_old-subject:)"
34639 headers remove "Old-Subject"
34640 .endd
34641
34642
34643
34644 .section "Setting an errors address in a system filter" "SECID217"
34645 .cindex "envelope from"
34646 .cindex "envelope sender"
34647 In a system filter, if a &%deliver%& command is followed by
34648 .code
34649 errors_to <some address>
34650 .endd
34651 in order to change the envelope sender (and hence the error reporting) for that
34652 delivery, any address may be specified. (In a user filter, only the current
34653 user's address can be set.) For example, if some mail is being monitored, you
34654 might use
34655 .code
34656 unseen deliver monitor@spying.example errors_to root@local.example
34657 .endd
34658 to take a copy which would not be sent back to the normal error reporting
34659 address if its delivery failed.
34660
34661
34662
34663 .section "Per-address filtering" "SECTperaddfil"
34664 .vindex "&$domain$&"
34665 .vindex "&$local_part$&"
34666 In contrast to the system filter, which is run just once per message for each
34667 delivery attempt, it is also possible to set up a system-wide filtering
34668 operation that runs once for each recipient address. In this case, variables
34669 such as &$local_part$& and &$domain$& can be used, and indeed, the choice of
34670 filter file could be made dependent on them. This is an example of a router
34671 which implements such a filter:
34672 .code
34673 central_filter:
34674   check_local_user
34675   driver = redirect
34676   domains = +local_domains
34677   file = /central/filters/$local_part
34678   no_verify
34679   allow_filter
34680   allow_freeze
34681 .endd
34682 The filter is run in a separate process under its own uid. Therefore, either
34683 &%check_local_user%& must be set (as above), in which case the filter is run as
34684 the local user, or the &%user%& option must be used to specify which user to
34685 use. If both are set, &%user%& overrides.
34686
34687 Care should be taken to ensure that none of the commands in the filter file
34688 specify a significant delivery if the message is to go on to be delivered to
34689 its intended recipient. The router will not then claim to have dealt with the
34690 address, so it will be passed on to subsequent routers to be delivered in the
34691 normal way.
34692 .ecindex IIDsysfil1
34693 .ecindex IIDsysfil2
34694 .ecindex IIDsysfil3
34695
34696
34697
34698
34699
34700
34701 . ////////////////////////////////////////////////////////////////////////////
34702 . ////////////////////////////////////////////////////////////////////////////
34703
34704 .chapter "Message processing" "CHAPmsgproc"
34705 .scindex IIDmesproc "message" "general processing"
34706 Exim performs various transformations on the sender and recipient addresses of
34707 all messages that it handles, and also on the messages' header lines. Some of
34708 these are optional and configurable, while others always take place. All of
34709 this processing, except rewriting as a result of routing, and the addition or
34710 removal of header lines while delivering, happens when a message is received,
34711 before it is placed on Exim's queue.
34712
34713 Some of the automatic processing takes place by default only for
34714 &"locally-originated"& messages. This adjective is used to describe messages
34715 that are not received over TCP/IP, but instead are passed to an Exim process on
34716 its standard input. This includes the interactive &"local SMTP"& case that is
34717 set up by the &%-bs%& command line option.
34718
34719 &*Note*&: Messages received over TCP/IP on the loopback interface (127.0.0.1
34720 or ::1) are not considered to be locally-originated. Exim does not treat the
34721 loopback interface specially in any way.
34722
34723 If you want the loopback interface to be treated specially, you must ensure
34724 that there are appropriate entries in your ACLs.
34725
34726
34727
34728
34729 .section "Submission mode for non-local messages" "SECTsubmodnon"
34730 .cindex "message" "submission"
34731 .cindex "submission mode"
34732 Processing that happens automatically for locally-originated messages (unless
34733 &%suppress_local_fixups%& is set) can also be requested for messages that are
34734 received over TCP/IP. The term &"submission mode"& is used to describe this
34735 state. Submission mode is set by the modifier
34736 .code
34737 control = submission
34738 .endd
34739 in a MAIL, RCPT, or pre-data ACL for an incoming message (see sections
34740 &<<SECTACLmodi>>& and &<<SECTcontrols>>&). This makes Exim treat the message as
34741 a local submission, and is normally used when the source of the message is
34742 known to be an MUA running on a client host (as opposed to an MTA). For
34743 example, to set submission mode for messages originating on the IPv4 loopback
34744 interface, you could include the following in the MAIL ACL:
34745 .code
34746 warn  hosts = 127.0.0.1
34747       control = submission
34748 .endd
34749 .cindex "&%sender_retain%& submission option"
34750 There are some options that can be used when setting submission mode. A slash
34751 is used to separate options. For example:
34752 .code
34753 control = submission/sender_retain
34754 .endd
34755 Specifying &%sender_retain%& has the effect of setting &%local_sender_retain%&
34756 true and &%local_from_check%& false for the current incoming message. The first
34757 of these allows an existing &'Sender:'& header in the message to remain, and
34758 the second suppresses the check to ensure that &'From:'& matches the
34759 authenticated sender. With this setting, Exim still fixes up messages by adding
34760 &'Date:'& and &'Message-ID:'& header lines if they are missing, but makes no
34761 attempt to check sender authenticity in header lines.
34762
34763 When &%sender_retain%& is not set, a submission mode setting may specify a
34764 domain to be used when generating a &'From:'& or &'Sender:'& header line. For
34765 example:
34766 .code
34767 control = submission/domain=some.domain
34768 .endd
34769 The domain may be empty. How this value is used is described in sections
34770 &<<SECTthefrohea>>& and &<<SECTthesenhea>>&. There is also a &%name%& option
34771 that allows you to specify the user's full name for inclusion in a created
34772 &'Sender:'& or &'From:'& header line. For example:
34773 .code
34774 accept authenticated = *
34775        control = submission/domain=wonderland.example/\
34776                             name=${lookup {$authenticated_id} \
34777                                    lsearch {/etc/exim/namelist}}
34778 .endd
34779 Because the name may contain any characters, including slashes, the &%name%&
34780 option must be given last. The remainder of the string is used as the name. For
34781 the example above, if &_/etc/exim/namelist_& contains:
34782 .code
34783 bigegg:  Humpty Dumpty
34784 .endd
34785 then when the sender has authenticated as &'bigegg'&, the generated &'Sender:'&
34786 line would be:
34787 .code
34788 Sender: Humpty Dumpty <bigegg@wonderland.example>
34789 .endd
34790 .cindex "return path" "in submission mode"
34791 By default, submission mode forces the return path to the same address as is
34792 used to create the &'Sender:'& header. However, if &%sender_retain%& is
34793 specified, the return path is also left unchanged.
34794
34795 &*Note*&: The changes caused by submission mode take effect after the predata
34796 ACL. This means that any sender checks performed before the fix-ups use the
34797 untrusted sender address specified by the user, not the trusted sender address
34798 specified by submission mode. Although this might be slightly unexpected, it
34799 does mean that you can configure ACL checks to spot that a user is trying to
34800 spoof another's address.
34801
34802 .section "Line endings" "SECTlineendings"
34803 .cindex "line endings"
34804 .cindex "carriage return"
34805 .cindex "linefeed"
34806 RFC 2821 specifies that CRLF (two characters: carriage-return, followed by
34807 linefeed) is the line ending for messages transmitted over the Internet using
34808 SMTP over TCP/IP. However, within individual operating systems, different
34809 conventions are used. For example, Unix-like systems use just LF, but others
34810 use CRLF or just CR.
34811
34812 Exim was designed for Unix-like systems, and internally, it stores messages
34813 using the system's convention of a single LF as a line terminator. When
34814 receiving a message, all line endings are translated to this standard format.
34815 Originally, it was thought that programs that passed messages directly to an
34816 MTA within an operating system would use that system's convention. Experience
34817 has shown that this is not the case; for example, there are Unix applications
34818 that use CRLF in this circumstance. For this reason, and for compatibility with
34819 other MTAs, the way Exim handles line endings for all messages is now as
34820 follows:
34821
34822 .ilist
34823 LF not preceded by CR is treated as a line ending.
34824 .next
34825 CR is treated as a line ending; if it is immediately followed by LF, the LF
34826 is ignored.
34827 .next
34828 The sequence &"CR, dot, CR"& does not terminate an incoming SMTP message,
34829 nor a local message in the state where a line containing only a dot is a
34830 terminator.
34831 .next
34832 If a bare CR is encountered within a header line, an extra space is added after
34833 the line terminator so as not to end the header line. The reasoning behind this
34834 is that bare CRs in header lines are most likely either to be mistakes, or
34835 people trying to play silly games.
34836 .next
34837 If the first header line received in a message ends with CRLF, a subsequent
34838 bare LF in a header line is treated in the same way as a bare CR in a header
34839 line.
34840 .endlist
34841
34842
34843
34844
34845
34846 .section "Unqualified addresses" "SECID218"
34847 .cindex "unqualified addresses"
34848 .cindex "address" "qualification"
34849 By default, Exim expects every envelope address it receives from an external
34850 host to be fully qualified. Unqualified addresses cause negative responses to
34851 SMTP commands. However, because SMTP is used as a means of transporting
34852 messages from MUAs running on personal workstations, there is sometimes a
34853 requirement to accept unqualified addresses from specific hosts or IP networks.
34854
34855 Exim has two options that separately control which hosts may send unqualified
34856 sender or recipient addresses in SMTP commands, namely
34857 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&. In both
34858 cases, if an unqualified address is accepted, it is qualified by adding the
34859 value of &%qualify_domain%& or &%qualify_recipient%&, as appropriate.
34860
34861 .oindex "&%qualify_domain%&"
34862 .oindex "&%qualify_recipient%&"
34863 Unqualified addresses in header lines are automatically qualified for messages
34864 that are locally originated, unless the &%-bnq%& option is given on the command
34865 line. For messages received over SMTP, unqualified addresses in header lines
34866 are qualified only if unqualified addresses are permitted in SMTP commands. In
34867 other words, such qualification is also controlled by
34868 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&,
34869
34870
34871
34872
34873 .section "The UUCP From line" "SECID219"
34874 .cindex "&""From""& line"
34875 .cindex "UUCP" "&""From""& line"
34876 .cindex "sender" "address"
34877 .oindex "&%uucp_from_pattern%&"
34878 .oindex "&%uucp_from_sender%&"
34879 .cindex "envelope from"
34880 .cindex "envelope sender"
34881 .cindex "Sendmail compatibility" "&""From""& line"
34882 Messages that have come from UUCP (and some other applications) often begin
34883 with a line containing the envelope sender and a timestamp, following the word
34884 &"From"&. Examples of two common formats are:
34885 .code
34886 From a.oakley@berlin.mus Fri Jan  5 12:35 GMT 1996
34887 From f.butler@berlin.mus Fri, 7 Jan 97 14:00:00 GMT
34888 .endd
34889 This line precedes the RFC 2822 header lines. For compatibility with Sendmail,
34890 Exim recognizes such lines at the start of messages that are submitted to it
34891 via the command line (that is, on the standard input). It does not recognize
34892 such lines in incoming SMTP messages, unless the sending host matches
34893 &%ignore_fromline_hosts%& or the &%-bs%& option was used for a local message
34894 and &%ignore_fromline_local%& is set. The recognition is controlled by a
34895 regular expression that is defined by the &%uucp_from_pattern%& option, whose
34896 default value matches the two common cases shown above and puts the address
34897 that follows &"From"& into &$1$&.
34898
34899 .cindex "numerical variables (&$1$& &$2$& etc)" "in &""From ""& line handling"
34900 When the caller of Exim for a non-SMTP message that contains a &"From"& line is
34901 a trusted user, the message's sender address is constructed by expanding the
34902 contents of &%uucp_sender_address%&, whose default value is &"$1"&. This is
34903 then parsed as an RFC 2822 address. If there is no domain, the local part is
34904 qualified with &%qualify_domain%& unless it is the empty string. However, if
34905 the command line &%-f%& option is used, it overrides the &"From"& line.
34906
34907 If the caller of Exim is not trusted, the &"From"& line is recognized, but the
34908 sender address is not changed. This is also the case for incoming SMTP messages
34909 that are permitted to contain &"From"& lines.
34910
34911 Only one &"From"& line is recognized. If there is more than one, the second is
34912 treated as a data line that starts the body of the message, as it is not valid
34913 as a header line. This also happens if a &"From"& line is present in an
34914 incoming SMTP message from a source that is not permitted to send them.
34915
34916
34917
34918 .section "Resent- header lines" "SECID220"
34919 .cindex "&%Resent-%& header lines"
34920 .cindex "header lines" "Resent-"
34921 RFC 2822 makes provision for sets of header lines starting with the string
34922 &`Resent-`& to be added to a message when it is resent by the original
34923 recipient to somebody else. These headers are &'Resent-Date:'&,
34924 &'Resent-From:'&, &'Resent-Sender:'&, &'Resent-To:'&, &'Resent-Cc:'&,
34925 &'Resent-Bcc:'& and &'Resent-Message-ID:'&. The RFC says:
34926
34927 .blockquote
34928 &'Resent fields are strictly informational. They MUST NOT be used in the normal
34929 processing of replies or other such automatic actions on messages.'&
34930 .endblockquote
34931
34932 This leaves things a bit vague as far as other processing actions such as
34933 address rewriting are concerned. Exim treats &%Resent-%& header lines as
34934 follows:
34935
34936 .ilist
34937 A &'Resent-From:'& line that just contains the login id of the submitting user
34938 is automatically rewritten in the same way as &'From:'& (see below).
34939 .next
34940 If there's a rewriting rule for a particular header line, it is also applied to
34941 &%Resent-%& header lines of the same type. For example, a rule that rewrites
34942 &'From:'& also rewrites &'Resent-From:'&.
34943 .next
34944 For local messages, if &'Sender:'& is removed on input, &'Resent-Sender:'& is
34945 also removed.
34946 .next
34947 For a locally-submitted message,
34948 if there are any &%Resent-%& header lines but no &'Resent-Date:'&,
34949 &'Resent-From:'&, or &'Resent-Message-Id:'&, they are added as necessary. It is
34950 the contents of &'Resent-Message-Id:'& (rather than &'Message-Id:'&) which are
34951 included in log lines in this case.
34952 .next
34953 The logic for adding &'Sender:'& is duplicated for &'Resent-Sender:'& when any
34954 &%Resent-%& header lines are present.
34955 .endlist
34956
34957
34958
34959
34960 .section "The Auto-Submitted: header line" "SECID221"
34961 Whenever Exim generates an autoreply, a bounce, or a delay warning message, it
34962 includes the header line:
34963 .code
34964 Auto-Submitted: auto-replied
34965 .endd
34966
34967 .section "The Bcc: header line" "SECID222"
34968 .cindex "&'Bcc:'& header line"
34969 If Exim is called with the &%-t%& option, to take recipient addresses from a
34970 message's header, it removes any &'Bcc:'& header line that may exist (after
34971 extracting its addresses). If &%-t%& is not present on the command line, any
34972 existing &'Bcc:'& is not removed.
34973
34974
34975 .section "The Date: header line" "SECID223"
34976 .cindex "&'Date:'& header line"
34977 .cindex "header lines" "Date:"
34978 If a locally-generated or submission-mode message has no &'Date:'& header line,
34979 Exim adds one, using the current date and time, unless the
34980 &%suppress_local_fixups%& control has been specified.
34981
34982 .section "The Delivery-date: header line" "SECID224"
34983 .cindex "&'Delivery-date:'& header line"
34984 .oindex "&%delivery_date_remove%&"
34985 &'Delivery-date:'& header lines are not part of the standard RFC 2822 header
34986 set. Exim can be configured to add them to the final delivery of messages. (See
34987 the generic &%delivery_date_add%& transport option.) They should not be present
34988 in messages in transit. If the &%delivery_date_remove%& configuration option is
34989 set (the default), Exim removes &'Delivery-date:'& header lines from incoming
34990 messages.
34991
34992
34993 .section "The Envelope-to: header line" "SECID225"
34994 .cindex "&'Envelope-to:'& header line"
34995 .cindex "header lines" "Envelope-to:"
34996 .oindex "&%envelope_to_remove%&"
34997 &'Envelope-to:'& header lines are not part of the standard RFC 2822 header set.
34998 Exim can be configured to add them to the final delivery of messages. (See the
34999 generic &%envelope_to_add%& transport option.) They should not be present in
35000 messages in transit. If the &%envelope_to_remove%& configuration option is set
35001 (the default), Exim removes &'Envelope-to:'& header lines from incoming
35002 messages.
35003
35004
35005 .section "The From: header line" "SECTthefrohea"
35006 .cindex "&'From:'& header line"
35007 .cindex "header lines" "From:"
35008 .cindex "Sendmail compatibility" "&""From""& line"
35009 .cindex "message" "submission"
35010 .cindex "submission mode"
35011 If a submission-mode message does not contain a &'From:'& header line, Exim
35012 adds one if either of the following conditions is true:
35013
35014 .ilist
35015 The envelope sender address is not empty (that is, this is not a bounce
35016 message). The added header line copies the envelope sender address.
35017 .next
35018 .vindex "&$authenticated_id$&"
35019 The SMTP session is authenticated and &$authenticated_id$& is not empty.
35020 .olist
35021 .vindex "&$qualify_domain$&"
35022 If no domain is specified by the submission control, the local part is
35023 &$authenticated_id$& and the domain is &$qualify_domain$&.
35024 .next
35025 If a non-empty domain is specified by the submission control, the local
35026 part is &$authenticated_id$&, and the domain is the specified domain.
35027 .next
35028 If an empty domain is specified by the submission control,
35029 &$authenticated_id$& is assumed to be the complete address.
35030 .endlist
35031 .endlist
35032
35033 A non-empty envelope sender takes precedence.
35034
35035 If a locally-generated incoming message does not contain a &'From:'& header
35036 line, and the &%suppress_local_fixups%& control is not set, Exim adds one
35037 containing the sender's address. The calling user's login name and full name
35038 are used to construct the address, as described in section &<<SECTconstr>>&.
35039 They are obtained from the password data by calling &[getpwuid()]& (but see the
35040 &%unknown_login%& configuration option). The address is qualified with
35041 &%qualify_domain%&.
35042
35043 For compatibility with Sendmail, if an incoming, non-SMTP message has a
35044 &'From:'& header line containing just the unqualified login name of the calling
35045 user, this is replaced by an address containing the user's login name and full
35046 name as described in section &<<SECTconstr>>&.
35047
35048
35049 .section "The Message-ID: header line" "SECID226"
35050 .cindex "&'Message-ID:'& header line"
35051 .cindex "header lines" "Message-ID:"
35052 .cindex "message" "submission"
35053 .oindex "&%message_id_header_text%&"
35054 If a locally-generated or submission-mode incoming message does not contain a
35055 &'Message-ID:'& or &'Resent-Message-ID:'& header line, and the
35056 &%suppress_local_fixups%& control is not set, Exim adds a suitable header line
35057 to the message. If there are any &'Resent-:'& headers in the message, it
35058 creates &'Resent-Message-ID:'&. The id is constructed from Exim's internal
35059 message id, preceded by the letter E to ensure it starts with a letter, and
35060 followed by @ and the primary host name. Additional information can be included
35061 in this header line by setting the &%message_id_header_text%& and/or
35062 &%message_id_header_domain%& options.
35063
35064
35065 .section "The Received: header line" "SECID227"
35066 .cindex "&'Received:'& header line"
35067 .cindex "header lines" "Received:"
35068 A &'Received:'& header line is added at the start of every message. The
35069 contents are defined by the &%received_header_text%& configuration option, and
35070 Exim automatically adds a semicolon and a timestamp to the configured string.
35071
35072 The &'Received:'& header is generated as soon as the message's header lines
35073 have been received. At this stage, the timestamp in the &'Received:'& header
35074 line is the time that the message started to be received. This is the value
35075 that is seen by the DATA ACL and by the &[local_scan()]& function.
35076
35077 Once a message is accepted, the timestamp in the &'Received:'& header line is
35078 changed to the time of acceptance, which is (apart from a small delay while the
35079 -H spool file is written) the earliest time at which delivery could start.
35080
35081
35082 .section "The References: header line" "SECID228"
35083 .cindex "&'References:'& header line"
35084 .cindex "header lines" "References:"
35085 Messages created by the &(autoreply)& transport include a &'References:'&
35086 header line. This is constructed according to the rules that are described in
35087 section 3.64 of RFC 2822 (which states that replies should contain such a
35088 header line), and section 3.14 of RFC 3834 (which states that automatic
35089 responses are not different in this respect). However, because some mail
35090 processing software does not cope well with very long header lines, no more
35091 than 12 message IDs are copied from the &'References:'& header line in the
35092 incoming message. If there are more than 12, the first one and then the final
35093 11 are copied, before adding the message ID of the incoming message.
35094
35095
35096
35097 .section "The Return-path: header line" "SECID229"
35098 .cindex "&'Return-path:'& header line"
35099 .cindex "header lines" "Return-path:"
35100 .oindex "&%return_path_remove%&"
35101 &'Return-path:'& header lines are defined as something an MTA may insert when
35102 it does the final delivery of messages. (See the generic &%return_path_add%&
35103 transport option.) Therefore, they should not be present in messages in
35104 transit. If the &%return_path_remove%& configuration option is set (the
35105 default), Exim removes &'Return-path:'& header lines from incoming messages.
35106
35107
35108
35109 .section "The Sender: header line" "SECTthesenhea"
35110 .cindex "&'Sender:'& header line"
35111 .cindex "message" "submission"
35112 .cindex "header lines" "Sender:"
35113 For a locally-originated message from an untrusted user, Exim may remove an
35114 existing &'Sender:'& header line, and it may add a new one. You can modify
35115 these actions by setting the &%local_sender_retain%& option true, the
35116 &%local_from_check%& option false, or by using the &%suppress_local_fixups%&
35117 control setting.
35118
35119 When a local message is received from an untrusted user and
35120 &%local_from_check%& is true (the default), and the &%suppress_local_fixups%&
35121 control has not been set, a check is made to see if the address given in the
35122 &'From:'& header line is the correct (local) sender of the message. The address
35123 that is expected has the login name as the local part and the value of
35124 &%qualify_domain%& as the domain. Prefixes and suffixes for the local part can
35125 be permitted by setting &%local_from_prefix%& and &%local_from_suffix%&
35126 appropriately. If &'From:'& does not contain the correct sender, a &'Sender:'&
35127 line is added to the message.
35128
35129 If you set &%local_from_check%& false, this checking does not occur. However,
35130 the removal of an existing &'Sender:'& line still happens, unless you also set
35131 &%local_sender_retain%& to be true. It is not possible to set both of these
35132 options true at the same time.
35133
35134 .cindex "submission mode"
35135 By default, no processing of &'Sender:'& header lines is done for messages
35136 received over TCP/IP or for messages submitted by trusted users. However, when
35137 a message is received over TCP/IP in submission mode, and &%sender_retain%& is
35138 not specified on the submission control, the following processing takes place:
35139
35140 .vindex "&$authenticated_id$&"
35141 First, any existing &'Sender:'& lines are removed. Then, if the SMTP session is
35142 authenticated, and &$authenticated_id$& is not empty, a sender address is
35143 created as follows:
35144
35145 .ilist
35146 .vindex "&$qualify_domain$&"
35147 If no domain is specified by the submission control, the local part is
35148 &$authenticated_id$& and the domain is &$qualify_domain$&.
35149 .next
35150 If a non-empty domain is specified by the submission control, the local part
35151 is &$authenticated_id$&, and the domain is the specified domain.
35152 .next
35153 If an empty domain is specified by the submission control,
35154 &$authenticated_id$& is assumed to be the complete address.
35155 .endlist
35156
35157 This address is compared with the address in the &'From:'& header line. If they
35158 are different, a &'Sender:'& header line containing the created address is
35159 added. Prefixes and suffixes for the local part in &'From:'& can be permitted
35160 by setting &%local_from_prefix%& and &%local_from_suffix%& appropriately.
35161
35162 .cindex "return path" "created from &'Sender:'&"
35163 &*Note*&: Whenever a &'Sender:'& header line is created, the return path for
35164 the message (the envelope sender address) is changed to be the same address,
35165 except in the case of submission mode when &%sender_retain%& is specified.
35166
35167
35168
35169 .section "Adding and removing header lines in routers and transports" &&&
35170          "SECTheadersaddrem"
35171 .cindex "header lines" "adding; in router or transport"
35172 .cindex "header lines" "removing; in router or transport"
35173 When a message is delivered, the addition and removal of header lines can be
35174 specified in a system filter, or on any of the routers and transports that
35175 process the message. Section &<<SECTaddremheasys>>& contains details about
35176 modifying headers in a system filter. Header lines can also be added in an ACL
35177 as a message is received (see section &<<SECTaddheadacl>>&).
35178
35179 In contrast to what happens in a system filter, header modifications that are
35180 specified on routers and transports apply only to the particular recipient
35181 addresses that are being processed by those routers and transports. These
35182 changes do not actually take place until a copy of the message is being
35183 transported. Therefore, they do not affect the basic set of header lines, and
35184 they do not affect the values of the variables that refer to header lines.
35185
35186 &*Note*&: In particular, this means that any expansions in the configuration of
35187 the transport cannot refer to the modified header lines, because such
35188 expansions all occur before the message is actually transported.
35189
35190 For both routers and transports, the argument of a &%headers_add%&
35191 option must be in the form of one or more RFC 2822 header lines, separated by
35192 newlines (coded as &"\n"&). For example:
35193 .code
35194 headers_add = X-added-header: added by $primary_hostname\n\
35195               X-added-second: another added header line
35196 .endd
35197 Exim does not check the syntax of these added header lines.
35198
35199 Multiple &%headers_add%& options for a single router or transport can be
35200 specified; the values will append to a single list of header lines.
35201 Each header-line is separately expanded.
35202
35203 The argument of a &%headers_remove%& option must consist of a colon-separated
35204 list of header names. This is confusing, because header names themselves are
35205 often terminated by colons. In this case, the colons are the list separators,
35206 not part of the names. For example:
35207 .code
35208 headers_remove = return-receipt-to:acknowledge-to
35209 .endd
35210
35211 Multiple &%headers_remove%& options for a single router or transport can be
35212 specified; the arguments will append to a single header-names list.
35213 Each item is separately expanded.
35214 Note that colons in complex expansions which are used to
35215 form all or part of a &%headers_remove%& list
35216 will act as list separators.
35217
35218 When &%headers_add%& or &%headers_remove%& is specified on a router,
35219 items are expanded at routing time,
35220 and then associated with all addresses that are
35221 accepted by that router, and also with any new addresses that it generates. If
35222 an address passes through several routers as a result of aliasing or
35223 forwarding, the changes are cumulative.
35224
35225 .oindex "&%unseen%&"
35226 However, this does not apply to multiple routers that result from the use of
35227 the &%unseen%& option. Any header modifications that were specified by the
35228 &"unseen"& router or its predecessors apply only to the &"unseen"& delivery.
35229
35230 Addresses that end up with different &%headers_add%& or &%headers_remove%&
35231 settings cannot be delivered together in a batch, so a transport is always
35232 dealing with a set of addresses that have the same header-processing
35233 requirements.
35234
35235 The transport starts by writing the original set of header lines that arrived
35236 with the message, possibly modified by the system filter. As it writes out
35237 these lines, it consults the list of header names that were attached to the
35238 recipient address(es) by &%headers_remove%& options in routers, and it also
35239 consults the transport's own &%headers_remove%& option. Header lines whose
35240 names are on either of these lists are not written out. If there are multiple
35241 instances of any listed header, they are all skipped.
35242
35243 After the remaining original header lines have been written, new header
35244 lines that were specified by routers' &%headers_add%& options are written, in
35245 the order in which they were attached to the address. These are followed by any
35246 header lines specified by the transport's &%headers_add%& option.
35247
35248 This way of handling header line modifications in routers and transports has
35249 the following consequences:
35250
35251 .ilist
35252 The original set of header lines, possibly modified by the system filter,
35253 remains &"visible"&, in the sense that the &$header_$&&'xxx'& variables refer
35254 to it, at all times.
35255 .next
35256 Header lines that are added by a router's
35257 &%headers_add%& option are not accessible by means of the &$header_$&&'xxx'&
35258 expansion syntax in subsequent routers or the transport.
35259 .next
35260 Conversely, header lines that are specified for removal by &%headers_remove%&
35261 in a router remain visible to subsequent routers and the transport.
35262 .next
35263 Headers added to an address by &%headers_add%& in a router cannot be removed by
35264 a later router or by a transport.
35265 .next
35266 An added header can refer to the contents of an original header that is to be
35267 removed, even it has the same name as the added header. For example:
35268 .code
35269 headers_remove = subject
35270 headers_add = Subject: new subject (was: $h_subject:)
35271 .endd
35272 .endlist
35273
35274 &*Warning*&: The &%headers_add%& and &%headers_remove%& options cannot be used
35275 for a &(redirect)& router that has the &%one_time%& option set.
35276
35277
35278
35279
35280
35281 .section "Constructed addresses" "SECTconstr"
35282 .cindex "address" "constructed"
35283 .cindex "constructed address"
35284 When Exim constructs a sender address for a locally-generated message, it uses
35285 the form
35286 .display
35287 <&'user name'&>&~&~<&'login'&&`@`&&'qualify_domain'&>
35288 .endd
35289 For example:
35290 .code
35291 Zaphod Beeblebrox <zaphod@end.univ.example>
35292 .endd
35293 The user name is obtained from the &%-F%& command line option if set, or
35294 otherwise by looking up the calling user by &[getpwuid()]& and extracting the
35295 &"gecos"& field from the password entry. If the &"gecos"& field contains an
35296 ampersand character, this is replaced by the login name with the first letter
35297 upper cased, as is conventional in a number of operating systems. See the
35298 &%gecos_name%& option for a way to tailor the handling of the &"gecos"& field.
35299 The &%unknown_username%& option can be used to specify user names in cases when
35300 there is no password file entry.
35301
35302 .cindex "RFC 2047"
35303 In all cases, the user name is made to conform to RFC 2822 by quoting all or
35304 parts of it if necessary. In addition, if it contains any non-printing
35305 characters, it is encoded as described in RFC 2047, which defines a way of
35306 including non-ASCII characters in header lines. The value of the
35307 &%headers_charset%& option specifies the name of the encoding that is used (the
35308 characters are assumed to be in this encoding). The setting of
35309 &%print_topbitchars%& controls whether characters with the top bit set (that
35310 is, with codes greater than 127) count as printing characters or not.
35311
35312
35313
35314 .section "Case of local parts" "SECID230"
35315 .cindex "case of local parts"
35316 .cindex "local part" "case of"
35317 RFC 2822 states that the case of letters in the local parts of addresses cannot
35318 be assumed to be non-significant. Exim preserves the case of local parts of
35319 addresses, but by default it uses a lower-cased form when it is routing,
35320 because on most Unix systems, usernames are in lower case and case-insensitive
35321 routing is required. However, any particular router can be made to use the
35322 original case for local parts by setting the &%caseful_local_part%& generic
35323 router option.
35324
35325 .cindex "mixed-case login names"
35326 If you must have mixed-case user names on your system, the best way to proceed,
35327 assuming you want case-independent handling of incoming email, is to set up
35328 your first router to convert incoming local parts in your domains to the
35329 correct case by means of a file lookup. For example:
35330 .code
35331 correct_case:
35332   driver = redirect
35333   domains = +local_domains
35334   data = ${lookup{$local_part}cdb\
35335               {/etc/usercased.cdb}{$value}fail}\
35336               @$domain
35337 .endd
35338 For this router, the local part is forced to lower case by the default action
35339 (&%caseful_local_part%& is not set). The lower-cased local part is used to look
35340 up a new local part in the correct case. If you then set &%caseful_local_part%&
35341 on any subsequent routers which process your domains, they will operate on
35342 local parts with the correct case in a case-sensitive manner.
35343
35344
35345
35346 .section "Dots in local parts" "SECID231"
35347 .cindex "dot" "in local part"
35348 .cindex "local part" "dots in"
35349 RFC 2822 forbids empty components in local parts. That is, an unquoted local
35350 part may not begin or end with a dot, nor have two consecutive dots in the
35351 middle. However, it seems that many MTAs do not enforce this, so Exim permits
35352 empty components for compatibility.
35353
35354
35355
35356 .section "Rewriting addresses" "SECID232"
35357 .cindex "rewriting" "addresses"
35358 Rewriting of sender and recipient addresses, and addresses in headers, can
35359 happen automatically, or as the result of configuration options, as described
35360 in chapter &<<CHAPrewrite>>&. The headers that may be affected by this are
35361 &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-To:'&, &'Sender:'&, and &'To:'&.
35362
35363 Automatic rewriting includes qualification, as mentioned above. The other case
35364 in which it can happen is when an incomplete non-local domain is given. The
35365 routing process may cause this to be expanded into the full domain name. For
35366 example, a header such as
35367 .code
35368 To: hare@teaparty
35369 .endd
35370 might get rewritten as
35371 .code
35372 To: hare@teaparty.wonderland.fict.example
35373 .endd
35374 Rewriting as a result of routing is the one kind of message processing that
35375 does not happen at input time, as it cannot be done until the address has
35376 been routed.
35377
35378 Strictly, one should not do &'any'& deliveries of a message until all its
35379 addresses have been routed, in case any of the headers get changed as a
35380 result of routing. However, doing this in practice would hold up many
35381 deliveries for unreasonable amounts of time, just because one address could not
35382 immediately be routed. Exim therefore does not delay other deliveries when
35383 routing of one or more addresses is deferred.
35384 .ecindex IIDmesproc
35385
35386
35387
35388 . ////////////////////////////////////////////////////////////////////////////
35389 . ////////////////////////////////////////////////////////////////////////////
35390
35391 .chapter "SMTP processing" "CHAPSMTP"
35392 .scindex IIDsmtpproc1 "SMTP" "processing details"
35393 .scindex IIDsmtpproc2 "LMTP" "processing details"
35394 Exim supports a number of different ways of using the SMTP protocol, and its
35395 LMTP variant, which is an interactive protocol for transferring messages into a
35396 closed mail store application. This chapter contains details of how SMTP is
35397 processed. For incoming mail, the following are available:
35398
35399 .ilist
35400 SMTP over TCP/IP (Exim daemon or &'inetd'&);
35401 .next
35402 SMTP over the standard input and output (the &%-bs%& option);
35403 .next
35404 Batched SMTP on the standard input (the &%-bS%& option).
35405 .endlist
35406
35407 For mail delivery, the following are available:
35408
35409 .ilist
35410 SMTP over TCP/IP (the &(smtp)& transport);
35411 .next
35412 LMTP over TCP/IP (the &(smtp)& transport with the &%protocol%& option set to
35413 &"lmtp"&);
35414 .next
35415 LMTP over a pipe to a process running in the local host (the &(lmtp)&
35416 transport);
35417 .next
35418 Batched SMTP to a file or pipe (the &(appendfile)& and &(pipe)& transports with
35419 the &%use_bsmtp%& option set).
35420 .endlist
35421
35422 &'Batched SMTP'& is the name for a process in which batches of messages are
35423 stored in or read from files (or pipes), in a format in which SMTP commands are
35424 used to contain the envelope information.
35425
35426
35427
35428 .section "Outgoing SMTP and LMTP over TCP/IP" "SECToutSMTPTCP"
35429 .cindex "SMTP" "outgoing over TCP/IP"
35430 .cindex "outgoing SMTP over TCP/IP"
35431 .cindex "LMTP" "over TCP/IP"
35432 .cindex "outgoing LMTP over TCP/IP"
35433 .cindex "EHLO"
35434 .cindex "HELO"
35435 .cindex "SIZE option on MAIL command"
35436 Outgoing SMTP and LMTP over TCP/IP is implemented by the &(smtp)& transport.
35437 The &%protocol%& option selects which protocol is to be used, but the actual
35438 processing is the same in both cases.
35439
35440 If, in response to its EHLO command, Exim is told that the SIZE
35441 parameter is supported, it adds SIZE=<&'n'&> to each subsequent MAIL
35442 command. The value of <&'n'&> is the message size plus the value of the
35443 &%size_addition%& option (default 1024) to allow for additions to the message
35444 such as per-transport header lines, or changes made in a
35445 .cindex "transport" "filter"
35446 .cindex "filter" "transport filter"
35447 transport filter. If &%size_addition%& is set negative, the use of SIZE is
35448 suppressed.
35449
35450 If the remote server advertises support for PIPELINING, Exim uses the
35451 pipelining extension to SMTP (RFC 2197) to reduce the number of TCP/IP packets
35452 required for the transaction.
35453
35454 If the remote server advertises support for the STARTTLS command, and Exim
35455 was built to support TLS encryption, it tries to start a TLS session unless the
35456 server matches &%hosts_avoid_tls%&. See chapter &<<CHAPTLS>>& for more details.
35457 Either a match in that or &%hosts_verify_avoid_tls%& apply when the transport
35458 is called for verification.
35459
35460 If the remote server advertises support for the AUTH command, Exim scans
35461 the authenticators configuration for any suitable client settings, as described
35462 in chapter &<<CHAPSMTPAUTH>>&.
35463
35464 .cindex "carriage return"
35465 .cindex "linefeed"
35466 Responses from the remote host are supposed to be terminated by CR followed by
35467 LF. However, there are known to be hosts that do not send CR characters, so in
35468 order to be able to interwork with such hosts, Exim treats LF on its own as a
35469 line terminator.
35470
35471 If a message contains a number of different addresses, all those with the same
35472 characteristics (for example, the same envelope sender) that resolve to the
35473 same set of hosts, in the same order, are sent in a single SMTP transaction,
35474 even if they are for different domains, unless there are more than the setting
35475 of the &%max_rcpt%&s option in the &(smtp)& transport allows, in which case
35476 they are split into groups containing no more than &%max_rcpt%&s addresses
35477 each. If &%remote_max_parallel%& is greater than one, such groups may be sent
35478 in parallel sessions. The order of hosts with identical MX values is not
35479 significant when checking whether addresses can be batched in this way.
35480
35481 When the &(smtp)& transport suffers a temporary failure that is not
35482 message-related, Exim updates its transport-specific database, which contains
35483 records indexed by host name that remember which messages are waiting for each
35484 particular host. It also updates the retry database with new retry times.
35485
35486 .cindex "hints database" "retry keys"
35487 Exim's retry hints are based on host name plus IP address, so if one address of
35488 a multi-homed host is broken, it will soon be skipped most of the time.
35489 See the next section for more detail about error handling.
35490
35491 .cindex "SMTP" "passed connection"
35492 .cindex "SMTP" "batching over TCP/IP"
35493 When a message is successfully delivered over a TCP/IP SMTP connection, Exim
35494 looks in the hints database for the transport to see if there are any queued
35495 messages waiting for the host to which it is connected. If it finds one, it
35496 creates a new Exim process using the &%-MC%& option (which can only be used by
35497 a process running as root or the Exim user) and passes the TCP/IP socket to it
35498 so that it can deliver another message using the same socket. The new process
35499 does only those deliveries that are routed to the connected host, and may in
35500 turn pass the socket on to a third process, and so on.
35501
35502 The &%connection_max_messages%& option of the &(smtp)& transport can be used to
35503 limit the number of messages sent down a single TCP/IP connection.
35504
35505 .cindex "asterisk" "after IP address"
35506 The second and subsequent messages delivered down an existing connection are
35507 identified in the main log by the addition of an asterisk after the closing
35508 square bracket of the IP address.
35509
35510
35511
35512
35513 .section "Errors in outgoing SMTP" "SECToutSMTPerr"
35514 .cindex "error" "in outgoing SMTP"
35515 .cindex "SMTP" "errors in outgoing"
35516 .cindex "host" "error"
35517 Three different kinds of error are recognized for outgoing SMTP: host errors,
35518 message errors, and recipient errors.
35519
35520 .vlist
35521 .vitem "&*Host errors*&"
35522 A host error is not associated with a particular message or with a
35523 particular recipient of a message. The host errors are:
35524
35525 .ilist
35526 Connection refused or timed out,
35527 .next
35528 Any error response code on connection,
35529 .next
35530 Any error response code to EHLO or HELO,
35531 .next
35532 Loss of connection at any time, except after &"."&,
35533 .next
35534 I/O errors at any time,
35535 .next
35536 Timeouts during the session, other than in response to MAIL, RCPT or
35537 the &"."& at the end of the data.
35538 .endlist ilist
35539
35540 For a host error, a permanent error response on connection, or in response to
35541 EHLO, causes all addresses routed to the host to be failed. Any other host
35542 error causes all addresses to be deferred, and retry data to be created for the
35543 host. It is not tried again, for any message, until its retry time arrives. If
35544 the current set of addresses are not all delivered in this run (to some
35545 alternative host), the message is added to the list of those waiting for this
35546 host, so if it is still undelivered when a subsequent successful delivery is
35547 made to the host, it will be sent down the same SMTP connection.
35548
35549 .vitem "&*Message errors*&"
35550 .cindex "message" "error"
35551 A message error is associated with a particular message when sent to a
35552 particular host, but not with a particular recipient of the message. The
35553 message errors are:
35554
35555 .ilist
35556 Any error response code to MAIL, DATA, or the &"."& that terminates
35557 the data,
35558 .next
35559 Timeout after MAIL,
35560 .next
35561 Timeout or loss of connection after the &"."& that terminates the data. A
35562 timeout after the DATA command itself is treated as a host error, as is loss of
35563 connection at any other time.
35564 .endlist ilist
35565
35566 For a message error, a permanent error response (5&'xx'&) causes all addresses
35567 to be failed, and a delivery error report to be returned to the sender. A
35568 temporary error response (4&'xx'&), or one of the timeouts, causes all
35569 addresses to be deferred. Retry data is not created for the host, but instead,
35570 a retry record for the combination of host plus message id is created. The
35571 message is not added to the list of those waiting for this host. This ensures
35572 that the failing message will not be sent to this host again until the retry
35573 time arrives. However, other messages that are routed to the host are not
35574 affected, so if it is some property of the message that is causing the error,
35575 it will not stop the delivery of other mail.
35576
35577 If the remote host specified support for the SIZE parameter in its response
35578 to EHLO, Exim adds SIZE=&'nnn'& to the MAIL command, so an
35579 over-large message will cause a message error because the error arrives as a
35580 response to MAIL.
35581
35582 .vitem "&*Recipient errors*&"
35583 .cindex "recipient" "error"
35584 A recipient error is associated with a particular recipient of a message. The
35585 recipient errors are:
35586
35587 .ilist
35588 Any error response to RCPT,
35589 .next
35590 Timeout after RCPT.
35591 .endlist
35592
35593 For a recipient error, a permanent error response (5&'xx'&) causes the
35594 recipient address to be failed, and a bounce message to be returned to the
35595 sender. A temporary error response (4&'xx'&) or a timeout causes the failing
35596 address to be deferred, and routing retry data to be created for it. This is
35597 used to delay processing of the address in subsequent queue runs, until its
35598 routing retry time arrives. This applies to all messages, but because it
35599 operates only in queue runs, one attempt will be made to deliver a new message
35600 to the failing address before the delay starts to operate. This ensures that,
35601 if the failure is really related to the message rather than the recipient
35602 (&"message too big for this recipient"& is a possible example), other messages
35603 have a chance of getting delivered. If a delivery to the address does succeed,
35604 the retry information gets cleared, so all stuck messages get tried again, and
35605 the retry clock is reset.
35606
35607 The message is not added to the list of those waiting for this host. Use of the
35608 host for other messages is unaffected, and except in the case of a timeout,
35609 other recipients are processed independently, and may be successfully delivered
35610 in the current SMTP session. After a timeout it is of course impossible to
35611 proceed with the session, so all addresses get deferred. However, those other
35612 than the one that failed do not suffer any subsequent retry delays. Therefore,
35613 if one recipient is causing trouble, the others have a chance of getting
35614 through when a subsequent delivery attempt occurs before the failing
35615 recipient's retry time.
35616 .endlist
35617
35618 In all cases, if there are other hosts (or IP addresses) available for the
35619 current set of addresses (for example, from multiple MX records), they are
35620 tried in this run for any undelivered addresses, subject of course to their
35621 own retry data. In other words, recipient error retry data does not take effect
35622 until the next delivery attempt.
35623
35624 Some hosts have been observed to give temporary error responses to every
35625 MAIL command at certain times (&"insufficient space"& has been seen). It
35626 would be nice if such circumstances could be recognized, and defer data for the
35627 host itself created, but this is not possible within the current Exim design.
35628 What actually happens is that retry data for every (host, message) combination
35629 is created.
35630
35631 The reason that timeouts after MAIL and RCPT are treated specially is that
35632 these can sometimes arise as a result of the remote host's verification
35633 procedures. Exim makes this assumption, and treats them as if a temporary error
35634 response had been received. A timeout after &"."& is treated specially because
35635 it is known that some broken implementations fail to recognize the end of the
35636 message if the last character of the last line is a binary zero. Thus, it is
35637 helpful to treat this case as a message error.
35638
35639 Timeouts at other times are treated as host errors, assuming a problem with the
35640 host, or the connection to it. If a timeout after MAIL, RCPT,
35641 or &"."& is really a connection problem, the assumption is that at the next try
35642 the timeout is likely to occur at some other point in the dialogue, causing it
35643 then to be treated as a host error.
35644
35645 There is experimental evidence that some MTAs drop the connection after the
35646 terminating &"."& if they do not like the contents of the message for some
35647 reason, in contravention of the RFC, which indicates that a 5&'xx'& response
35648 should be given. That is why Exim treats this case as a message rather than a
35649 host error, in order not to delay other messages to the same host.
35650
35651
35652
35653
35654 .section "Incoming SMTP messages over TCP/IP" "SECID233"
35655 .cindex "SMTP" "incoming over TCP/IP"
35656 .cindex "incoming SMTP over TCP/IP"
35657 .cindex "inetd"
35658 .cindex "daemon"
35659 Incoming SMTP messages can be accepted in one of two ways: by running a
35660 listening daemon, or by using &'inetd'&. In the latter case, the entry in
35661 &_/etc/inetd.conf_& should be like this:
35662 .code
35663 smtp stream tcp nowait exim /opt/exim/bin/exim in.exim -bs
35664 .endd
35665 Exim distinguishes between this case and the case of a locally running user
35666 agent using the &%-bs%& option by checking whether or not the standard input is
35667 a socket. When it is, either the port must be privileged (less than 1024), or
35668 the caller must be root or the Exim user. If any other user passes a socket
35669 with an unprivileged port number, Exim prints a message on the standard error
35670 stream and exits with an error code.
35671
35672 By default, Exim does not make a log entry when a remote host connects or
35673 disconnects (either via the daemon or &'inetd'&), unless the disconnection is
35674 unexpected. It can be made to write such log entries by setting the
35675 &%smtp_connection%& log selector.
35676
35677 .cindex "carriage return"
35678 .cindex "linefeed"
35679 Commands from the remote host are supposed to be terminated by CR followed by
35680 LF. However, there are known to be hosts that do not send CR characters. In
35681 order to be able to interwork with such hosts, Exim treats LF on its own as a
35682 line terminator.
35683 Furthermore, because common code is used for receiving messages from all
35684 sources, a CR on its own is also interpreted as a line terminator. However, the
35685 sequence &"CR, dot, CR"& does not terminate incoming SMTP data.
35686
35687 .cindex "EHLO" "invalid data"
35688 .cindex "HELO" "invalid data"
35689 One area that sometimes gives rise to problems concerns the EHLO or
35690 HELO commands. Some clients send syntactically invalid versions of these
35691 commands, which Exim rejects by default. (This is nothing to do with verifying
35692 the data that is sent, so &%helo_verify_hosts%& is not relevant.) You can tell
35693 Exim not to apply a syntax check by setting &%helo_accept_junk_hosts%& to
35694 match the broken hosts that send invalid commands.
35695
35696 .cindex "SIZE option on MAIL command"
35697 .cindex "MAIL" "SIZE option"
35698 The amount of disk space available is checked whenever SIZE is received on
35699 a MAIL command, independently of whether &%message_size_limit%& or
35700 &%check_spool_space%& is configured, unless &%smtp_check_spool_space%& is set
35701 false. A temporary error is given if there is not enough space. If
35702 &%check_spool_space%& is set, the check is for that amount of space plus the
35703 value given with SIZE, that is, it checks that the addition of the incoming
35704 message will not reduce the space below the threshold.
35705
35706 When a message is successfully received, Exim includes the local message id in
35707 its response to the final &"."& that terminates the data. If the remote host
35708 logs this text it can help with tracing what has happened to a message.
35709
35710 The Exim daemon can limit the number of simultaneous incoming connections it is
35711 prepared to handle (see the &%smtp_accept_max%& option). It can also limit the
35712 number of simultaneous incoming connections from a single remote host (see the
35713 &%smtp_accept_max_per_host%& option). Additional connection attempts are
35714 rejected using the SMTP temporary error code 421.
35715
35716 The Exim daemon does not rely on the SIGCHLD signal to detect when a
35717 subprocess has finished, as this can get lost at busy times. Instead, it looks
35718 for completed subprocesses every time it wakes up. Provided there are other
35719 things happening (new incoming calls, starts of queue runs), completed
35720 processes will be noticed and tidied away. On very quiet systems you may
35721 sometimes see a &"defunct"& Exim process hanging about. This is not a problem;
35722 it will be noticed when the daemon next wakes up.
35723
35724 When running as a daemon, Exim can reserve some SMTP slots for specific hosts,
35725 and can also be set up to reject SMTP calls from non-reserved hosts at times of
35726 high system load &-- for details see the &%smtp_accept_reserve%&,
35727 &%smtp_load_reserve%&, and &%smtp_reserve_hosts%& options. The load check
35728 applies in both the daemon and &'inetd'& cases.
35729
35730 Exim normally starts a delivery process for each message received, though this
35731 can be varied by means of the &%-odq%& command line option and the
35732 &%queue_only%&, &%queue_only_file%&, and &%queue_only_load%& options. The
35733 number of simultaneously running delivery processes started in this way from
35734 SMTP input can be limited by the &%smtp_accept_queue%& and
35735 &%smtp_accept_queue_per_connection%& options. When either limit is reached,
35736 subsequently received messages are just put on the input queue without starting
35737 a delivery process.
35738
35739 The controls that involve counts of incoming SMTP calls (&%smtp_accept_max%&,
35740 &%smtp_accept_queue%&, &%smtp_accept_reserve%&) are not available when Exim is
35741 started up from the &'inetd'& daemon, because in that case each connection is
35742 handled by an entirely independent Exim process. Control by load average is,
35743 however, available with &'inetd'&.
35744
35745 Exim can be configured to verify addresses in incoming SMTP commands as they
35746 are received. See chapter &<<CHAPACL>>& for details. It can also be configured
35747 to rewrite addresses at this time &-- before any syntax checking is done. See
35748 section &<<SECTrewriteS>>&.
35749
35750 Exim can also be configured to limit the rate at which a client host submits
35751 MAIL and RCPT commands in a single SMTP session. See the
35752 &%smtp_ratelimit_hosts%& option.
35753
35754
35755
35756 .section "Unrecognized SMTP commands" "SECID234"
35757 .cindex "SMTP" "unrecognized commands"
35758 If Exim receives more than &%smtp_max_unknown_commands%& unrecognized SMTP
35759 commands during a single SMTP connection, it drops the connection after sending
35760 the error response to the last command. The default value for
35761 &%smtp_max_unknown_commands%& is 3. This is a defence against some kinds of
35762 abuse that subvert web servers into making connections to SMTP ports; in these
35763 circumstances, a number of non-SMTP lines are sent first.
35764
35765
35766 .section "Syntax and protocol errors in SMTP commands" "SECID235"
35767 .cindex "SMTP" "syntax errors"
35768 .cindex "SMTP" "protocol errors"
35769 A syntax error is detected if an SMTP command is recognized, but there is
35770 something syntactically wrong with its data, for example, a malformed email
35771 address in a RCPT command. Protocol errors include invalid command
35772 sequencing such as RCPT before MAIL. If Exim receives more than
35773 &%smtp_max_synprot_errors%& such commands during a single SMTP connection, it
35774 drops the connection after sending the error response to the last command. The
35775 default value for &%smtp_max_synprot_errors%& is 3. This is a defence against
35776 broken clients that loop sending bad commands (yes, it has been seen).
35777
35778
35779
35780 .section "Use of non-mail SMTP commands" "SECID236"
35781 .cindex "SMTP" "non-mail commands"
35782 The &"non-mail"& SMTP commands are those other than MAIL, RCPT, and
35783 DATA. Exim counts such commands, and drops the connection if there are too
35784 many of them in a single SMTP session. This action catches some
35785 denial-of-service attempts and things like repeated failing AUTHs, or a mad
35786 client looping sending EHLO. The global option &%smtp_accept_max_nonmail%&
35787 defines what &"too many"& means. Its default value is 10.
35788
35789 When a new message is expected, one occurrence of RSET is not counted. This
35790 allows a client to send one RSET between messages (this is not necessary,
35791 but some clients do it). Exim also allows one uncounted occurrence of HELO
35792 or EHLO, and one occurrence of STARTTLS between messages. After
35793 starting up a TLS session, another EHLO is expected, and so it too is not
35794 counted.
35795
35796 The first occurrence of AUTH in a connection, or immediately following
35797 STARTTLS is also not counted. Otherwise, all commands other than MAIL,
35798 RCPT, DATA, and QUIT are counted.
35799
35800 You can control which hosts are subject to the limit set by
35801 &%smtp_accept_max_nonmail%& by setting
35802 &%smtp_accept_max_nonmail_hosts%&. The default value is &`*`&, which makes
35803 the limit apply to all hosts. This option means that you can exclude any
35804 specific badly-behaved hosts that you have to live with.
35805
35806
35807
35808
35809 .section "The VRFY and EXPN commands" "SECID237"
35810 When Exim receives a VRFY or EXPN command on a TCP/IP connection, it
35811 runs the ACL specified by &%acl_smtp_vrfy%& or &%acl_smtp_expn%& (as
35812 appropriate) in order to decide whether the command should be accepted or not.
35813
35814 .cindex "VRFY" "processing"
35815 When no ACL is defined for VRFY, or if it rejects without
35816 setting an explicit response code, the command is accepted
35817 (with a 252 SMTP response code)
35818 in order to support awkward clients that do a VRFY before every RCPT.
35819 When VRFY is accepted, it runs exactly the same code as when Exim is
35820 called with the &%-bv%& option, and returns 250/451/550
35821 SMTP response codes.
35822
35823 .cindex "EXPN" "processing"
35824 If no ACL for EXPN is defined, the command is rejected.
35825 When EXPN is accepted, a single-level expansion of the address is done.
35826 EXPN is treated as an &"address test"& (similar to the &%-bt%& option) rather
35827 than a verification (the &%-bv%& option). If an unqualified local part is given
35828 as the argument to EXPN, it is qualified with &%qualify_domain%&. Rejections
35829 of VRFY and EXPN commands are logged on the main and reject logs, and
35830 VRFY verification failures are logged on the main log for consistency with
35831 RCPT failures.
35832
35833
35834
35835 .section "The ETRN command" "SECTETRN"
35836 .cindex "ETRN" "processing"
35837 RFC 1985 describes an SMTP command called ETRN that is designed to
35838 overcome the security problems of the TURN command (which has fallen into
35839 disuse). When Exim receives an ETRN command on a TCP/IP connection, it runs
35840 the ACL specified by &%acl_smtp_etrn%& in order to decide whether the command
35841 should be accepted or not. If no ACL is defined, the command is rejected.
35842
35843 The ETRN command is concerned with &"releasing"& messages that are awaiting
35844 delivery to certain hosts. As Exim does not organize its message queue by host,
35845 the only form of ETRN that is supported by default is the one where the
35846 text starts with the &"#"& prefix, in which case the remainder of the text is
35847 specific to the SMTP server. A valid ETRN command causes a run of Exim with
35848 the &%-R%& option to happen, with the remainder of the ETRN text as its
35849 argument. For example,
35850 .code
35851 ETRN #brigadoon
35852 .endd
35853 runs the command
35854 .code
35855 exim -R brigadoon
35856 .endd
35857 which causes a delivery attempt on all messages with undelivered addresses
35858 containing the text &"brigadoon"&. When &%smtp_etrn_serialize%& is set (the
35859 default), Exim prevents the simultaneous execution of more than one queue run
35860 for the same argument string as a result of an ETRN command. This stops
35861 a misbehaving client from starting more than one queue runner at once.
35862
35863 .cindex "hints database" "ETRN serialization"
35864 Exim implements the serialization by means of a hints database in which a
35865 record is written whenever a process is started by ETRN, and deleted when
35866 the process completes. However, Exim does not keep the SMTP session waiting for
35867 the ETRN process to complete. Once ETRN is accepted, the client is sent
35868 a &"success"& return code. Obviously there is scope for hints records to get
35869 left lying around if there is a system or program crash. To guard against this,
35870 Exim ignores any records that are more than six hours old.
35871
35872 .oindex "&%smtp_etrn_command%&"
35873 For more control over what ETRN does, the &%smtp_etrn_command%& option can
35874 used. This specifies a command that is run whenever ETRN is received,
35875 whatever the form of its argument. For
35876 example:
35877 .code
35878 smtp_etrn_command = /etc/etrn_command $domain \
35879                     $sender_host_address
35880 .endd
35881 .vindex "&$domain$&"
35882 The string is split up into arguments which are independently expanded. The
35883 expansion variable &$domain$& is set to the argument of the ETRN command,
35884 and no syntax checking is done on the contents of this argument. Exim does not
35885 wait for the command to complete, so its status code is not checked. Exim runs
35886 under its own uid and gid when receiving incoming SMTP, so it is not possible
35887 for it to change them before running the command.
35888
35889
35890
35891 .section "Incoming local SMTP" "SECID238"
35892 .cindex "SMTP" "local incoming"
35893 Some user agents use SMTP to pass messages to their local MTA using the
35894 standard input and output, as opposed to passing the envelope on the command
35895 line and writing the message to the standard input. This is supported by the
35896 &%-bs%& option. This form of SMTP is handled in the same way as incoming
35897 messages over TCP/IP (including the use of ACLs), except that the envelope
35898 sender given in a MAIL command is ignored unless the caller is trusted. In
35899 an ACL you can detect this form of SMTP input by testing for an empty host
35900 identification. It is common to have this as the first line in the ACL that
35901 runs for RCPT commands:
35902 .code
35903 accept hosts = :
35904 .endd
35905 This accepts SMTP messages from local processes without doing any other tests.
35906
35907
35908
35909 .section "Outgoing batched SMTP" "SECTbatchSMTP"
35910 .cindex "SMTP" "batched outgoing"
35911 .cindex "batched SMTP output"
35912 Both the &(appendfile)& and &(pipe)& transports can be used for handling
35913 batched SMTP. Each has an option called &%use_bsmtp%& which causes messages to
35914 be output in BSMTP format. No SMTP responses are possible for this form of
35915 delivery. All it is doing is using SMTP commands as a way of transmitting the
35916 envelope along with the message.
35917
35918 The message is written to the file or pipe preceded by the SMTP commands
35919 MAIL and RCPT, and followed by a line containing a single dot. Lines in
35920 the message that start with a dot have an extra dot added. The SMTP command
35921 HELO is not normally used. If it is required, the &%message_prefix%& option
35922 can be used to specify it.
35923
35924 Because &(appendfile)& and &(pipe)& are both local transports, they accept only
35925 one recipient address at a time by default. However, you can arrange for them
35926 to handle several addresses at once by setting the &%batch_max%& option. When
35927 this is done for BSMTP, messages may contain multiple RCPT commands. See
35928 chapter &<<CHAPbatching>>& for more details.
35929
35930 .vindex "&$host$&"
35931 When one or more addresses are routed to a BSMTP transport by a router that
35932 sets up a host list, the name of the first host on the list is available to the
35933 transport in the variable &$host$&. Here is an example of such a transport and
35934 router:
35935 .code
35936 begin routers
35937 route_append:
35938   driver = manualroute
35939   transport = smtp_appendfile
35940   route_list = domain.example  batch.host.example
35941
35942 begin transports
35943 smtp_appendfile:
35944   driver = appendfile
35945   directory = /var/bsmtp/$host
35946   batch_max = 1000
35947   use_bsmtp
35948   user = exim
35949 .endd
35950 This causes messages addressed to &'domain.example'& to be written in BSMTP
35951 format to &_/var/bsmtp/batch.host.example_&, with only a single copy of each
35952 message (unless there are more than 1000 recipients).
35953
35954
35955
35956 .section "Incoming batched SMTP" "SECTincomingbatchedSMTP"
35957 .cindex "SMTP" "batched incoming"
35958 .cindex "batched SMTP input"
35959 The &%-bS%& command line option causes Exim to accept one or more messages by
35960 reading SMTP on the standard input, but to generate no responses. If the caller
35961 is trusted, the senders in the MAIL commands are believed; otherwise the
35962 sender is always the caller of Exim. Unqualified senders and receivers are not
35963 rejected (there seems little point) but instead just get qualified. HELO
35964 and EHLO act as RSET; VRFY, EXPN, ETRN and  HELP, act
35965 as NOOP; QUIT quits.
35966
35967 Minimal policy checking is done for BSMTP input. Only the non-SMTP
35968 ACL is run in the same way as for non-SMTP local input.
35969
35970 If an error is detected while reading a message, including a missing &"."& at
35971 the end, Exim gives up immediately. It writes details of the error to the
35972 standard output in a stylized way that the calling program should be able to
35973 make some use of automatically, for example:
35974 .code
35975 554 Unexpected end of file
35976 Transaction started in line 10
35977 Error detected in line 14
35978 .endd
35979 It writes a more verbose version, for human consumption, to the standard error
35980 file, for example:
35981 .code
35982 An error was detected while processing a file of BSMTP input.
35983 The error message was:
35984
35985 501 '>' missing at end of address
35986
35987 The SMTP transaction started in line 10.
35988 The error was detected in line 12.
35989 The SMTP command at fault was:
35990
35991 rcpt to:<malformed@in.com.plete
35992
35993 1 previous message was successfully processed.
35994 The rest of the batch was abandoned.
35995 .endd
35996 The return code from Exim is zero only if there were no errors. It is 1 if some
35997 messages were accepted before an error was detected, and 2 if no messages were
35998 accepted.
35999 .ecindex IIDsmtpproc1
36000 .ecindex IIDsmtpproc2
36001
36002
36003
36004 . ////////////////////////////////////////////////////////////////////////////
36005 . ////////////////////////////////////////////////////////////////////////////
36006
36007 .chapter "Customizing bounce and warning messages" "CHAPemsgcust" &&&
36008          "Customizing messages"
36009 When a message fails to be delivered, or remains in the queue for more than a
36010 configured amount of time, Exim sends a message to the original sender, or
36011 to an alternative configured address. The text of these messages is built into
36012 the code of Exim, but it is possible to change it, either by adding a single
36013 string, or by replacing each of the paragraphs by text supplied in a file.
36014
36015 The &'From:'& and &'To:'& header lines are automatically generated; you can
36016 cause a &'Reply-To:'& line to be added by setting the &%errors_reply_to%&
36017 option. Exim also adds the line
36018 .code
36019 Auto-Submitted: auto-generated
36020 .endd
36021 to all warning and bounce messages,
36022
36023
36024 .section "Customizing bounce messages" "SECID239"
36025 .cindex "customizing" "bounce message"
36026 .cindex "bounce message" "customizing"
36027 If &%bounce_message_text%& is set, its contents are included in the default
36028 message immediately after &"This message was created automatically by mail
36029 delivery software."& The string is not expanded. It is not used if
36030 &%bounce_message_file%& is set.
36031
36032 When &%bounce_message_file%& is set, it must point to a template file for
36033 constructing error messages. The file consists of a series of text items,
36034 separated by lines consisting of exactly four asterisks. If the file cannot be
36035 opened, default text is used and a message is written to the main and panic
36036 logs. If any text item in the file is empty, default text is used for that
36037 item.
36038
36039 .vindex "&$bounce_recipient$&"
36040 .vindex "&$bounce_return_size_limit$&"
36041 Each item of text that is read from the file is expanded, and there are two
36042 expansion variables which can be of use here: &$bounce_recipient$& is set to
36043 the recipient of an error message while it is being created, and
36044 &$bounce_return_size_limit$& contains the value of the &%return_size_limit%&
36045 option, rounded to a whole number.
36046
36047 The items must appear in the file in the following order:
36048
36049 .ilist
36050 The first item is included in the headers, and should include at least a
36051 &'Subject:'& header. Exim does not check the syntax of these headers.
36052 .next
36053 The second item forms the start of the error message. After it, Exim lists the
36054 failing addresses with their error messages.
36055 .next
36056 The third item is used to introduce any text from pipe transports that is to be
36057 returned to the sender. It is omitted if there is no such text.
36058 .next
36059 The fourth, fifth and sixth items will be ignored and may be empty.
36060 The fields exist for back-compatibility
36061 .endlist
36062
36063 The default state (&%bounce_message_file%& unset) is equivalent to the
36064 following file, in which the sixth item is empty. The &'Subject:'& and some
36065 other lines have been split in order to fit them on the page:
36066 .code
36067 Subject: Mail delivery failed
36068   ${if eq{$sender_address}{$bounce_recipient}
36069   {: returning message to sender}}
36070 ****
36071 This message was created automatically by mail delivery software.
36072
36073 A message ${if eq{$sender_address}{$bounce_recipient}
36074   {that you sent }{sent by
36075
36076 <$sender_address>
36077
36078 }}could not be delivered to all of its recipients.
36079 This is a permanent error. The following address(es) failed:
36080 ****
36081 The following text was generated during the delivery attempt(s):
36082 ****
36083 ------ This is a copy of the message, including all the headers.
36084   ------
36085 ****
36086 ------ The body of the message is $message_size characters long;
36087   only the first
36088 ------ $bounce_return_size_limit or so are included here.
36089 ****
36090 .endd
36091 .section "Customizing warning messages" "SECTcustwarn"
36092 .cindex "customizing" "warning message"
36093 .cindex "warning of delay" "customizing the message"
36094 The option &%warn_message_file%& can be pointed at a template file for use when
36095 warnings about message delays are created. In this case there are only three
36096 text sections:
36097
36098 .ilist
36099 The first item is included in the headers, and should include at least a
36100 &'Subject:'& header. Exim does not check the syntax of these headers.
36101 .next
36102 The second item forms the start of the warning message. After it, Exim lists
36103 the delayed addresses.
36104 .next
36105 The third item then ends the message.
36106 .endlist
36107
36108 The default state is equivalent to the following file, except that some lines
36109 have been split here, in order to fit them on the page:
36110 .code
36111 Subject: Warning: message $message_exim_id delayed
36112   $warn_message_delay
36113 ****
36114 This message was created automatically by mail delivery software.
36115
36116 A message ${if eq{$sender_address}{$warn_message_recipients}
36117 {that you sent }{sent by
36118
36119 <$sender_address>
36120
36121 }}has not been delivered to all of its recipients after
36122 more than $warn_message_delay in the queue on $primary_hostname.
36123
36124 The message identifier is:     $message_exim_id
36125 The subject of the message is: $h_subject
36126 The date of the message is:    $h_date
36127
36128 The following address(es) have not yet been delivered:
36129 ****
36130 No action is required on your part. Delivery attempts will
36131 continue for some time, and this warning may be repeated at
36132 intervals if the message remains undelivered. Eventually the
36133 mail delivery software will give up, and when that happens,
36134 the message will be returned to you.
36135 .endd
36136 .vindex "&$warn_message_delay$&"
36137 .vindex "&$warn_message_recipients$&"
36138 However, in the default state the subject and date lines are omitted if no
36139 appropriate headers exist. During the expansion of this file,
36140 &$warn_message_delay$& is set to the delay time in one of the forms &"<&'n'&>
36141 minutes"& or &"<&'n'&> hours"&, and &$warn_message_recipients$& contains a list
36142 of recipients for the warning message. There may be more than one if there are
36143 multiple addresses with different &%errors_to%& settings on the routers that
36144 handled them.
36145
36146
36147
36148
36149 . ////////////////////////////////////////////////////////////////////////////
36150 . ////////////////////////////////////////////////////////////////////////////
36151
36152 .chapter "Some common configuration settings" "CHAPcomconreq"
36153 This chapter discusses some configuration settings that seem to be fairly
36154 common. More examples and discussion can be found in the Exim book.
36155
36156
36157
36158 .section "Sending mail to a smart host" "SECID240"
36159 .cindex "smart host" "example router"
36160 If you want to send all mail for non-local domains to a &"smart host"&, you
36161 should replace the default &(dnslookup)& router with a router which does the
36162 routing explicitly:
36163 .code
36164 send_to_smart_host:
36165   driver = manualroute
36166   route_list = !+local_domains smart.host.name
36167   transport = remote_smtp
36168 .endd
36169 You can use the smart host's IP address instead of the name if you wish.
36170 If you are using Exim only to submit messages to a smart host, and not for
36171 receiving incoming messages, you can arrange for it to do the submission
36172 synchronously by setting the &%mua_wrapper%& option (see chapter
36173 &<<CHAPnonqueueing>>&).
36174
36175
36176
36177
36178 .section "Using Exim to handle mailing lists" "SECTmailinglists"
36179 .cindex "mailing lists"
36180 Exim can be used to run simple mailing lists, but for large and/or complicated
36181 requirements, the use of additional specialized mailing list software such as
36182 Majordomo or Mailman is recommended.
36183
36184 The &(redirect)& router can be used to handle mailing lists where each list
36185 is maintained in a separate file, which can therefore be managed by an
36186 independent manager. The &%domains%& router option can be used to run these
36187 lists in a separate domain from normal mail. For example:
36188 .code
36189 lists:
36190   driver = redirect
36191   domains = lists.example
36192   file = /usr/lists/$local_part
36193   forbid_pipe
36194   forbid_file
36195   errors_to = $local_part-request@lists.example
36196   no_more
36197 .endd
36198 This router is skipped for domains other than &'lists.example'&. For addresses
36199 in that domain, it looks for a file that matches the local part. If there is no
36200 such file, the router declines, but because &%no_more%& is set, no subsequent
36201 routers are tried, and so the whole delivery fails.
36202
36203 The &%forbid_pipe%& and &%forbid_file%& options prevent a local part from being
36204 expanded into a filename or a pipe delivery, which is usually inappropriate in
36205 a mailing list.
36206
36207 .oindex "&%errors_to%&"
36208 The &%errors_to%& option specifies that any delivery errors caused by addresses
36209 taken from a mailing list are to be sent to the given address rather than the
36210 original sender of the message. However, before acting on this, Exim verifies
36211 the error address, and ignores it if verification fails.
36212
36213 For example, using the configuration above, mail sent to
36214 &'dicts@lists.example'& is passed on to those addresses contained in
36215 &_/usr/lists/dicts_&, with error reports directed to
36216 &'dicts-request@lists.example'&, provided that this address can be verified.
36217 There could be a file called &_/usr/lists/dicts-request_& containing
36218 the address(es) of this particular list's manager(s), but other approaches,
36219 such as setting up an earlier router (possibly using the &%local_part_prefix%&
36220 or &%local_part_suffix%& options) to handle addresses of the form
36221 &%owner-%&&'xxx'& or &%xxx-%&&'request'&, are also possible.
36222
36223
36224
36225 .section "Syntax errors in mailing lists" "SECID241"
36226 .cindex "mailing lists" "syntax errors in"
36227 If an entry in redirection data contains a syntax error, Exim normally defers
36228 delivery of the original address. That means that a syntax error in a mailing
36229 list holds up all deliveries to the list. This may not be appropriate when a
36230 list is being maintained automatically from data supplied by users, and the
36231 addresses are not rigorously checked.
36232
36233 If the &%skip_syntax_errors%& option is set, the &(redirect)& router just skips
36234 entries that fail to parse, noting the incident in the log. If in addition
36235 &%syntax_errors_to%& is set to a verifiable address, a message is sent to it
36236 whenever a broken address is skipped. It is usually appropriate to set
36237 &%syntax_errors_to%& to the same address as &%errors_to%&.
36238
36239
36240
36241 .section "Re-expansion of mailing lists" "SECID242"
36242 .cindex "mailing lists" "re-expansion of"
36243 Exim remembers every individual address to which a message has been delivered,
36244 in order to avoid duplication, but it normally stores only the original
36245 recipient addresses with a message. If all the deliveries to a mailing list
36246 cannot be done at the first attempt, the mailing list is re-expanded when the
36247 delivery is next tried. This means that alterations to the list are taken into
36248 account at each delivery attempt, so addresses that have been added to
36249 the list since the message arrived will therefore receive a copy of the
36250 message, even though it pre-dates their subscription.
36251
36252 If this behaviour is felt to be undesirable, the &%one_time%& option can be set
36253 on the &(redirect)& router. If this is done, any addresses generated by the
36254 router that fail to deliver at the first attempt are added to the message as
36255 &"top level"& addresses, and the parent address that generated them is marked
36256 &"delivered"&. Thus, expansion of the mailing list does not happen again at the
36257 subsequent delivery attempts. The disadvantage of this is that if any of the
36258 failing addresses are incorrect, correcting them in the file has no effect on
36259 pre-existing messages.
36260
36261 The original top-level address is remembered with each of the generated
36262 addresses, and is output in any log messages. However, any intermediate parent
36263 addresses are not recorded. This makes a difference to the log only if the
36264 &%all_parents%& selector is set, but for mailing lists there is normally only
36265 one level of expansion anyway.
36266
36267
36268
36269 .section "Closed mailing lists" "SECID243"
36270 .cindex "mailing lists" "closed"
36271 The examples so far have assumed open mailing lists, to which anybody may
36272 send mail. It is also possible to set up closed lists, where mail is accepted
36273 from specified senders only. This is done by making use of the generic
36274 &%senders%& option to restrict the router that handles the list.
36275
36276 The following example uses the same file as a list of recipients and as a list
36277 of permitted senders. It requires three routers:
36278 .code
36279 lists_request:
36280   driver = redirect
36281   domains = lists.example
36282   local_part_suffix = -request
36283   file = /usr/lists/$local_part$local_part_suffix
36284   no_more
36285
36286 lists_post:
36287   driver = redirect
36288   domains = lists.example
36289   senders = ${if exists {/usr/lists/$local_part}\
36290              {lsearch;/usr/lists/$local_part}{*}}
36291   file = /usr/lists/$local_part
36292   forbid_pipe
36293   forbid_file
36294   errors_to = $local_part-request@lists.example
36295   no_more
36296
36297 lists_closed:
36298   driver = redirect
36299   domains = lists.example
36300   allow_fail
36301   data = :fail: $local_part@lists.example is a closed mailing list
36302 .endd
36303 All three routers have the same &%domains%& setting, so for any other domains,
36304 they are all skipped. The first router runs only if the local part ends in
36305 &%-request%&. It handles messages to the list manager(s) by means of an open
36306 mailing list.
36307
36308 The second router runs only if the &%senders%& precondition is satisfied. It
36309 checks for the existence of a list that corresponds to the local part, and then
36310 checks that the sender is on the list by means of a linear search. It is
36311 necessary to check for the existence of the file before trying to search it,
36312 because otherwise Exim thinks there is a configuration error. If the file does
36313 not exist, the expansion of &%senders%& is *, which matches all senders. This
36314 means that the router runs, but because there is no list, declines, and
36315 &%no_more%& ensures that no further routers are run. The address fails with an
36316 &"unrouteable address"& error.
36317
36318 The third router runs only if the second router is skipped, which happens when
36319 a mailing list exists, but the sender is not on it. This router forcibly fails
36320 the address, giving a suitable error message.
36321
36322
36323
36324
36325 .section "Variable Envelope Return Paths (VERP)" "SECTverp"
36326 .cindex "VERP"
36327 .cindex "Variable Envelope Return Paths"
36328 .cindex "envelope from"
36329 .cindex "envelope sender"
36330 Variable Envelope Return Paths &-- see &url(https://cr.yp.to/proto/verp.txt) &--
36331 are a way of helping mailing list administrators discover which subscription
36332 address is the cause of a particular delivery failure. The idea is to encode
36333 the original recipient address in the outgoing envelope sender address, so that
36334 if the message is forwarded by another host and then subsequently bounces, the
36335 original recipient can be extracted from the recipient address of the bounce.
36336
36337 .oindex &%errors_to%&
36338 .oindex &%return_path%&
36339 Envelope sender addresses can be modified by Exim using two different
36340 facilities: the &%errors_to%& option on a router (as shown in previous mailing
36341 list examples), or the &%return_path%& option on a transport. The second of
36342 these is effective only if the message is successfully delivered to another
36343 host; it is not used for errors detected on the local host (see the description
36344 of &%return_path%& in chapter &<<CHAPtransportgeneric>>&). Here is an example
36345 of the use of &%return_path%& to implement VERP on an &(smtp)& transport:
36346 .code
36347 verp_smtp:
36348   driver = smtp
36349   max_rcpt = 1
36350   return_path = \
36351     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
36352       {$1-request+$local_part=$domain@your.dom.example}fail}
36353 .endd
36354 This has the effect of rewriting the return path (envelope sender) on outgoing
36355 SMTP messages, if the local part of the original return path ends in
36356 &"-request"&, and the domain is &'your.dom.example'&. The rewriting inserts the
36357 local part and domain of the recipient into the return path. Suppose, for
36358 example, that a message whose return path has been set to
36359 &'somelist-request@your.dom.example'& is sent to
36360 &'subscriber@other.dom.example'&. In the transport, the return path is
36361 rewritten as
36362 .code
36363 somelist-request+subscriber=other.dom.example@your.dom.example
36364 .endd
36365 .vindex "&$local_part$&"
36366 For this to work, you must tell Exim to send multiple copies of messages that
36367 have more than one recipient, so that each copy has just one recipient. This is
36368 achieved by setting &%max_rcpt%& to 1. Without this, a single copy of a message
36369 might be sent to several different recipients in the same domain, in which case
36370 &$local_part$& is not available in the transport, because it is not unique.
36371
36372 Unless your host is doing nothing but mailing list deliveries, you should
36373 probably use a separate transport for the VERP deliveries, so as not to use
36374 extra resources in making one-per-recipient copies for other deliveries. This
36375 can easily be done by expanding the &%transport%& option in the router:
36376 .code
36377 dnslookup:
36378   driver = dnslookup
36379   domains = ! +local_domains
36380   transport = \
36381     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
36382       {verp_smtp}{remote_smtp}}
36383   no_more
36384 .endd
36385 If you want to change the return path using &%errors_to%& in a router instead
36386 of using &%return_path%& in the transport, you need to set &%errors_to%& on all
36387 routers that handle mailing list addresses. This will ensure that all delivery
36388 errors, including those detected on the local host, are sent to the VERP
36389 address.
36390
36391 On a host that does no local deliveries and has no manual routing, only the
36392 &(dnslookup)& router needs to be changed. A special transport is not needed for
36393 SMTP deliveries. Every mailing list recipient has its own return path value,
36394 and so Exim must hand them to the transport one at a time. Here is an example
36395 of a &(dnslookup)& router that implements VERP:
36396 .code
36397 verp_dnslookup:
36398   driver = dnslookup
36399   domains = ! +local_domains
36400   transport = remote_smtp
36401   errors_to = \
36402     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}}
36403      {$1-request+$local_part=$domain@your.dom.example}fail}
36404   no_more
36405 .endd
36406 Before you start sending out messages with VERPed return paths, you must also
36407 configure Exim to accept the bounce messages that come back to those paths.
36408 Typically this is done by setting a &%local_part_suffix%& option for a
36409 router, and using this to route the messages to wherever you want to handle
36410 them.
36411
36412 The overhead incurred in using VERP depends very much on the size of the
36413 message, the number of recipient addresses that resolve to the same remote
36414 host, and the speed of the connection over which the message is being sent. If
36415 a lot of addresses resolve to the same host and the connection is slow, sending
36416 a separate copy of the message for each address may take substantially longer
36417 than sending a single copy with many recipients (for which VERP cannot be
36418 used).
36419
36420
36421
36422
36423
36424
36425 .section "Virtual domains" "SECTvirtualdomains"
36426 .cindex "virtual domains"
36427 .cindex "domain" "virtual"
36428 The phrase &'virtual domain'& is unfortunately used with two rather different
36429 meanings:
36430
36431 .ilist
36432 A domain for which there are no real mailboxes; all valid local parts are
36433 aliases for other email addresses. Common examples are organizational
36434 top-level domains and &"vanity"& domains.
36435 .next
36436 One of a number of independent domains that are all handled by the same host,
36437 with mailboxes on that host, but where the mailbox owners do not necessarily
36438 have login accounts on that host.
36439 .endlist
36440
36441 The first usage is probably more common, and does seem more &"virtual"& than
36442 the second. This kind of domain can be handled in Exim with a straightforward
36443 aliasing router. One approach is to create a separate alias file for each
36444 virtual domain. Exim can test for the existence of the alias file to determine
36445 whether the domain exists. The &(dsearch)& lookup type is useful here, leading
36446 to a router of this form:
36447 .code
36448 virtual:
36449   driver = redirect
36450   domains = dsearch;/etc/mail/virtual
36451   data = ${lookup{$local_part}lsearch{/etc/mail/virtual/$domain}}
36452   no_more
36453 .endd
36454 The &%domains%& option specifies that the router is to be skipped, unless there
36455 is a file in the &_/etc/mail/virtual_& directory whose name is the same as the
36456 domain that is being processed. When the router runs, it looks up the local
36457 part in the file to find a new address (or list of addresses). The &%no_more%&
36458 setting ensures that if the lookup fails (leading to &%data%& being an empty
36459 string), Exim gives up on the address without trying any subsequent routers.
36460
36461 This one router can handle all the virtual domains because the alias filenames
36462 follow a fixed pattern. Permissions can be arranged so that appropriate people
36463 can edit the different alias files. A successful aliasing operation results in
36464 a new envelope recipient address, which is then routed from scratch.
36465
36466 The other kind of &"virtual"& domain can also be handled in a straightforward
36467 way. One approach is to create a file for each domain containing a list of
36468 valid local parts, and use it in a router like this:
36469 .code
36470 my_domains:
36471   driver = accept
36472   domains = dsearch;/etc/mail/domains
36473   local_parts = lsearch;/etc/mail/domains/$domain
36474   transport = my_mailboxes
36475 .endd
36476 The address is accepted if there is a file for the domain, and the local part
36477 can be found in the file. The &%domains%& option is used to check for the
36478 file's existence because &%domains%& is tested before the &%local_parts%&
36479 option (see section &<<SECTrouprecon>>&). You cannot use &%require_files%&,
36480 because that option is tested after &%local_parts%&. The transport is as
36481 follows:
36482 .code
36483 my_mailboxes:
36484   driver = appendfile
36485   file = /var/mail/$domain/$local_part
36486   user = mail
36487 .endd
36488 This uses a directory of mailboxes for each domain. The &%user%& setting is
36489 required, to specify which uid is to be used for writing to the mailboxes.
36490
36491 The configuration shown here is just one example of how you might support this
36492 requirement. There are many other ways this kind of configuration can be set
36493 up, for example, by using a database instead of separate files to hold all the
36494 information about the domains.
36495
36496
36497
36498 .section "Multiple user mailboxes" "SECTmulbox"
36499 .cindex "multiple mailboxes"
36500 .cindex "mailbox" "multiple"
36501 .cindex "local part" "prefix"
36502 .cindex "local part" "suffix"
36503 Heavy email users often want to operate with multiple mailboxes, into which
36504 incoming mail is automatically sorted. A popular way of handling this is to
36505 allow users to use multiple sender addresses, so that replies can easily be
36506 identified. Users are permitted to add prefixes or suffixes to their local
36507 parts for this purpose. The wildcard facility of the generic router options
36508 &%local_part_prefix%& and &%local_part_suffix%& can be used for this. For
36509 example, consider this router:
36510 .code
36511 userforward:
36512   driver = redirect
36513   check_local_user
36514   file = $home/.forward
36515   local_part_suffix = -*
36516   local_part_suffix_optional
36517   allow_filter
36518 .endd
36519 .vindex "&$local_part_suffix$&"
36520 It runs a user's &_.forward_& file for all local parts of the form
36521 &'username-*'&. Within the filter file the user can distinguish different
36522 cases by testing the variable &$local_part_suffix$&. For example:
36523 .code
36524 if $local_part_suffix contains -special then
36525 save /home/$local_part/Mail/special
36526 endif
36527 .endd
36528 If the filter file does not exist, or does not deal with such addresses, they
36529 fall through to subsequent routers, and, assuming no subsequent use of the
36530 &%local_part_suffix%& option is made, they presumably fail. Thus, users have
36531 control over which suffixes are valid.
36532
36533 Alternatively, a suffix can be used to trigger the use of a different
36534 &_.forward_& file &-- which is the way a similar facility is implemented in
36535 another MTA:
36536 .code
36537 userforward:
36538   driver = redirect
36539   check_local_user
36540   file = $home/.forward$local_part_suffix
36541   local_part_suffix = -*
36542   local_part_suffix_optional
36543   allow_filter
36544 .endd
36545 If there is no suffix, &_.forward_& is used; if the suffix is &'-special'&, for
36546 example, &_.forward-special_& is used. Once again, if the appropriate file
36547 does not exist, or does not deal with the address, it is passed on to
36548 subsequent routers, which could, if required, look for an unqualified
36549 &_.forward_& file to use as a default.
36550
36551
36552
36553 .section "Simplified vacation processing" "SECID244"
36554 .cindex "vacation processing"
36555 The traditional way of running the &'vacation'& program is for a user to set up
36556 a pipe command in a &_.forward_& file
36557 (see section &<<SECTspecitredli>>& for syntax details).
36558 This is prone to error by inexperienced users. There are two features of Exim
36559 that can be used to make this process simpler for users:
36560
36561 .ilist
36562 A local part prefix such as &"vacation-"& can be specified on a router which
36563 can cause the message to be delivered directly to the &'vacation'& program, or
36564 alternatively can use Exim's &(autoreply)& transport. The contents of a user's
36565 &_.forward_& file are then much simpler. For example:
36566 .code
36567 spqr, vacation-spqr
36568 .endd
36569 .next
36570 The &%require_files%& generic router option can be used to trigger a
36571 vacation delivery by checking for the existence of a certain file in the
36572 user's home directory. The &%unseen%& generic option should also be used, to
36573 ensure that the original delivery also proceeds. In this case, all the user has
36574 to do is to create a file called, say, &_.vacation_&, containing a vacation
36575 message.
36576 .endlist
36577
36578 Another advantage of both these methods is that they both work even when the
36579 use of arbitrary pipes by users is locked out.
36580
36581
36582
36583 .section "Taking copies of mail" "SECID245"
36584 .cindex "message" "copying every"
36585 Some installations have policies that require archive copies of all messages to
36586 be made. A single copy of each message can easily be taken by an appropriate
36587 command in a system filter, which could, for example, use a different file for
36588 each day's messages.
36589
36590 There is also a shadow transport mechanism that can be used to take copies of
36591 messages that are successfully delivered by local transports, one copy per
36592 delivery. This could be used, &'inter alia'&, to implement automatic
36593 notification of delivery by sites that insist on doing such things.
36594
36595
36596
36597 .section "Intermittently connected hosts" "SECID246"
36598 .cindex "intermittently connected hosts"
36599 It has become quite common (because it is cheaper) for hosts to connect to the
36600 Internet periodically rather than remain connected all the time. The normal
36601 arrangement is that mail for such hosts accumulates on a system that is
36602 permanently connected.
36603
36604 Exim was designed for use on permanently connected hosts, and so it is not
36605 particularly well-suited to use in an intermittently connected environment.
36606 Nevertheless there are some features that can be used.
36607
36608
36609 .section "Exim on the upstream server host" "SECID247"
36610 It is tempting to arrange for incoming mail for the intermittently connected
36611 host to remain in Exim's queue until the client connects. However, this
36612 approach does not scale very well. Two different kinds of waiting message are
36613 being mixed up in the same queue &-- those that cannot be delivered because of
36614 some temporary problem, and those that are waiting for their destination host
36615 to connect. This makes it hard to manage the queue, as well as wasting
36616 resources, because each queue runner scans the entire queue.
36617
36618 A better approach is to separate off those messages that are waiting for an
36619 intermittently connected host. This can be done by delivering these messages
36620 into local files in batch SMTP, &"mailstore"&, or other envelope-preserving
36621 format, from where they are transmitted by other software when their
36622 destination connects. This makes it easy to collect all the mail for one host
36623 in a single directory, and to apply local timeout rules on a per-message basis
36624 if required.
36625
36626 On a very small scale, leaving the mail on Exim's queue can be made to work. If
36627 you are doing this, you should configure Exim with a long retry period for the
36628 intermittent host. For example:
36629 .code
36630 cheshire.wonderland.fict.example    *   F,5d,24h
36631 .endd
36632 This stops a lot of failed delivery attempts from occurring, but Exim remembers
36633 which messages it has queued up for that host. Once the intermittent host comes
36634 online, forcing delivery of one message (either by using the &%-M%& or &%-R%&
36635 options, or by using the ETRN SMTP command (see section &<<SECTETRN>>&)
36636 causes all the queued up messages to be delivered, often down a single SMTP
36637 connection. While the host remains connected, any new messages get delivered
36638 immediately.
36639
36640 If the connecting hosts do not have fixed IP addresses, that is, if a host is
36641 issued with a different IP address each time it connects, Exim's retry
36642 mechanisms on the holding host get confused, because the IP address is normally
36643 used as part of the key string for holding retry information. This can be
36644 avoided by unsetting &%retry_include_ip_address%& on the &(smtp)& transport.
36645 Since this has disadvantages for permanently connected hosts, it is best to
36646 arrange a separate transport for the intermittently connected ones.
36647
36648
36649
36650 .section "Exim on the intermittently connected client host" "SECID248"
36651 The value of &%smtp_accept_queue_per_connection%& should probably be
36652 increased, or even set to zero (that is, disabled) on the intermittently
36653 connected host, so that all incoming messages down a single connection get
36654 delivered immediately.
36655
36656 .cindex "SMTP" "passed connection"
36657 .cindex "SMTP" "multiple deliveries"
36658 .cindex "multiple SMTP deliveries"
36659 Mail waiting to be sent from an intermittently connected host will probably
36660 not have been routed, because without a connection DNS lookups are not
36661 possible. This means that if a normal queue run is done at connection time,
36662 each message is likely to be sent in a separate SMTP session. This can be
36663 avoided by starting the queue run with a command line option beginning with
36664 &%-qq%& instead of &%-q%&. In this case, the queue is scanned twice. In the
36665 first pass, routing is done but no deliveries take place. The second pass is a
36666 normal queue run; since all the messages have been previously routed, those
36667 destined for the same host are likely to get sent as multiple deliveries in a
36668 single SMTP connection.
36669
36670
36671
36672 . ////////////////////////////////////////////////////////////////////////////
36673 . ////////////////////////////////////////////////////////////////////////////
36674
36675 .chapter "Using Exim as a non-queueing client" "CHAPnonqueueing" &&&
36676          "Exim as a non-queueing client"
36677 .cindex "client, non-queueing"
36678 .cindex "smart host" "suppressing queueing"
36679 On a personal computer, it is a common requirement for all
36680 email to be sent to a &"smart host"&. There are plenty of MUAs that can be
36681 configured to operate that way, for all the popular operating systems.
36682 However, there are some MUAs for Unix-like systems that cannot be so
36683 configured: they submit messages using the command line interface of
36684 &_/usr/sbin/sendmail_&. Furthermore, utility programs such as &'cron'& submit
36685 messages this way.
36686
36687 If the personal computer runs continuously, there is no problem, because it can
36688 run a conventional MTA that handles delivery to the smart host, and deal with
36689 any delays via its queueing mechanism. However, if the computer does not run
36690 continuously or runs different operating systems at different times, queueing
36691 email is not desirable.
36692
36693 There is therefore a requirement for something that can provide the
36694 &_/usr/sbin/sendmail_& interface but deliver messages to a smart host without
36695 any queueing or retrying facilities. Furthermore, the delivery to the smart
36696 host should be synchronous, so that if it fails, the sending MUA is immediately
36697 informed. In other words, we want something that extends an MUA that submits
36698 to a local MTA via the command line so that it behaves like one that submits
36699 to a remote smart host using TCP/SMTP.
36700
36701 There are a number of applications (for example, there is one called &'ssmtp'&)
36702 that do this job. However, people have found them to be lacking in various
36703 ways. For instance, you might want to allow aliasing and forwarding to be done
36704 before sending a message to the smart host.
36705
36706 Exim already had the necessary infrastructure for doing this job. Just a few
36707 tweaks were needed to make it behave as required, though it is somewhat of an
36708 overkill to use a fully-featured MTA for this purpose.
36709
36710 .oindex "&%mua_wrapper%&"
36711 There is a Boolean global option called &%mua_wrapper%&, defaulting false.
36712 Setting &%mua_wrapper%& true causes Exim to run in a special mode where it
36713 assumes that it is being used to &"wrap"& a command-line MUA in the manner
36714 just described. As well as setting &%mua_wrapper%&, you also need to provide a
36715 compatible router and transport configuration. Typically there will be just one
36716 router and one transport, sending everything to a smart host.
36717
36718 When run in MUA wrapping mode, the behaviour of Exim changes in the
36719 following ways:
36720
36721 .ilist
36722 A daemon cannot be run, nor will Exim accept incoming messages from &'inetd'&.
36723 In other words, the only way to submit messages is via the command line.
36724 .next
36725 Each message is synchronously delivered as soon as it is received (&%-odi%& is
36726 assumed). All queueing options (&%queue_only%&, &%queue_smtp_domains%&,
36727 &%control%& in an ACL, etc.) are quietly ignored. The Exim reception process
36728 does not finish until the delivery attempt is complete. If the delivery is
36729 successful, a zero return code is given.
36730 .next
36731 Address redirection is permitted, but the final routing for all addresses must
36732 be to the same remote transport, and to the same list of hosts. Furthermore,
36733 the return address (envelope sender) must be the same for all recipients, as
36734 must any added or deleted header lines. In other words, it must be possible to
36735 deliver the message in a single SMTP transaction, however many recipients there
36736 are.
36737 .next
36738 If these conditions are not met, or if routing any address results in a
36739 failure or defer status, or if Exim is unable to deliver all the recipients
36740 successfully to one of the smart hosts, delivery of the entire message fails.
36741 .next
36742 Because no queueing is allowed, all failures are treated as permanent; there
36743 is no distinction between 4&'xx'& and 5&'xx'& SMTP response codes from the
36744 smart host. Furthermore, because only a single yes/no response can be given to
36745 the caller, it is not possible to deliver to some recipients and not others. If
36746 there is an error (temporary or permanent) for any recipient, all are failed.
36747 .next
36748 If more than one smart host is listed, Exim will try another host after a
36749 connection failure or a timeout, in the normal way. However, if this kind of
36750 failure happens for all the hosts, the delivery fails.
36751 .next
36752 When delivery fails, an error message is written to the standard error stream
36753 (as well as to Exim's log), and Exim exits to the caller with a return code
36754 value 1. The message is expunged from Exim's spool files. No bounce messages
36755 are ever generated.
36756 .next
36757 No retry data is maintained, and any retry rules are ignored.
36758 .next
36759 A number of Exim options are overridden: &%deliver_drop_privilege%& is forced
36760 true, &%max_rcpt%& in the &(smtp)& transport is forced to &"unlimited"&,
36761 &%remote_max_parallel%& is forced to one, and fallback hosts are ignored.
36762 .endlist
36763
36764 The overall effect is that Exim makes a single synchronous attempt to deliver
36765 the message, failing if there is any kind of problem. Because no local
36766 deliveries are done and no daemon can be run, Exim does not need root
36767 privilege. It should be possible to run it setuid to &'exim'& instead of setuid
36768 to &'root'&. See section &<<SECTrunexiwitpri>>& for a general discussion about
36769 the advantages and disadvantages of running without root privilege.
36770
36771
36772
36773
36774 . ////////////////////////////////////////////////////////////////////////////
36775 . ////////////////////////////////////////////////////////////////////////////
36776
36777 .chapter "Log files" "CHAPlog"
36778 .scindex IIDloggen "log" "general description"
36779 .cindex "log" "types of"
36780 Exim writes three different logs, referred to as the main log, the reject log,
36781 and the panic log:
36782
36783 .ilist
36784 .cindex "main log"
36785 The main log records the arrival of each message and each delivery in a single
36786 line in each case. The format is as compact as possible, in an attempt to keep
36787 down the size of log files. Two-character flag sequences make it easy to pick
36788 out these lines. A number of other events are recorded in the main log. Some of
36789 them are optional, in which case the &%log_selector%& option controls whether
36790 they are included or not. A Perl script called &'eximstats'&, which does simple
36791 analysis of main log files, is provided in the Exim distribution (see section
36792 &<<SECTmailstat>>&).
36793 .next
36794 .cindex "reject log"
36795 The reject log records information from messages that are rejected as a result
36796 of a configuration option (that is, for policy reasons).
36797 The first line of each rejection is a copy of the line that is also written to
36798 the main log. Then, if the message's header has been read at the time the log
36799 is written, its contents are written to this log. Only the original header
36800 lines are available; header lines added by ACLs are not logged. You can use the
36801 reject log to check that your policy controls are working correctly; on a busy
36802 host this may be easier than scanning the main log for rejection messages. You
36803 can suppress the writing of the reject log by setting &%write_rejectlog%&
36804 false.
36805 .next
36806 .cindex "panic log"
36807 .cindex "system log"
36808 When certain serious errors occur, Exim writes entries to its panic log. If the
36809 error is sufficiently disastrous, Exim bombs out afterwards. Panic log entries
36810 are usually written to the main log as well, but can get lost amid the mass of
36811 other entries. The panic log should be empty under normal circumstances. It is
36812 therefore a good idea to check it (or to have a &'cron'& script check it)
36813 regularly, in order to become aware of any problems. When Exim cannot open its
36814 panic log, it tries as a last resort to write to the system log (syslog). This
36815 is opened with LOG_PID+LOG_CONS and the facility code of LOG_MAIL. The
36816 message itself is written at priority LOG_CRIT.
36817 .endlist
36818
36819 Every log line starts with a timestamp, in the format shown in the following
36820 example. Note that many of the examples shown in this chapter are line-wrapped.
36821 In the log file, this would be all on one line:
36822 .code
36823 2001-09-16 16:09:47 SMTP connection from [127.0.0.1] closed
36824   by QUIT
36825 .endd
36826 By default, the timestamps are in the local timezone. There are two
36827 ways of changing this:
36828
36829 .ilist
36830 You can set the &%timezone%& option to a different time zone; in particular, if
36831 you set
36832 .code
36833 timezone = UTC
36834 .endd
36835 the timestamps will be in UTC (aka GMT).
36836 .next
36837 If you set &%log_timezone%& true, the time zone is added to the timestamp, for
36838 example:
36839 .code
36840 2003-04-25 11:17:07 +0100 Start queue run: pid=12762
36841 .endd
36842 .endlist
36843
36844 .cindex "log" "process ids in"
36845 .cindex "pid (process id)" "in log lines"
36846 Exim does not include its process id in log lines by default, but you can
36847 request that it does so by specifying the &`pid`& log selector (see section
36848 &<<SECTlogselector>>&). When this is set, the process id is output, in square
36849 brackets, immediately after the time and date.
36850
36851
36852
36853
36854 .section "Where the logs are written" "SECTwhelogwri"
36855 .cindex "log" "destination"
36856 .cindex "log" "to file"
36857 .cindex "log" "to syslog"
36858 .cindex "syslog"
36859 The logs may be written to local files, or to syslog, or both. However, it
36860 should be noted that many syslog implementations use UDP as a transport, and
36861 are therefore unreliable in the sense that messages are not guaranteed to
36862 arrive at the loghost, nor is the ordering of messages necessarily maintained.
36863 It has also been reported that on large log files (tens of megabytes) you may
36864 need to tweak syslog to prevent it syncing the file with each write &-- on
36865 Linux this has been seen to make syslog take 90% plus of CPU time.
36866
36867 The destination for Exim's logs is configured by setting LOG_FILE_PATH in
36868 &_Local/Makefile_& or by setting &%log_file_path%& in the runtime
36869 configuration. This latter string is expanded, so it can contain, for example,
36870 references to the host name:
36871 .code
36872 log_file_path = /var/log/$primary_hostname/exim_%slog
36873 .endd
36874 It is generally advisable, however, to set the string in &_Local/Makefile_&
36875 rather than at runtime, because then the setting is available right from the
36876 start of Exim's execution. Otherwise, if there's something it wants to log
36877 before it has read the configuration file (for example, an error in the
36878 configuration file) it will not use the path you want, and may not be able to
36879 log at all.
36880
36881 The value of LOG_FILE_PATH or &%log_file_path%& is a colon-separated
36882 list, currently limited to at most two items. This is one option where the
36883 facility for changing a list separator may not be used. The list must always be
36884 colon-separated. If an item in the list is &"syslog"& then syslog is used;
36885 otherwise the item must either be an absolute path, containing &`%s`& at the
36886 point where &"main"&, &"reject"&, or &"panic"& is to be inserted, or be empty,
36887 implying the use of a default path.
36888
36889 When Exim encounters an empty item in the list, it searches the list defined by
36890 LOG_FILE_PATH, and uses the first item it finds that is neither empty nor
36891 &"syslog"&. This means that an empty item in &%log_file_path%& can be used to
36892 mean &"use the path specified at build time"&. It no such item exists, log
36893 files are written in the &_log_& subdirectory of the spool directory. This is
36894 equivalent to the setting:
36895 .code
36896 log_file_path = $spool_directory/log/%slog
36897 .endd
36898 If you do not specify anything at build time or runtime,
36899 or if you unset the option at runtime (i.e. &`log_file_path = `&),
36900 that is where the logs are written.
36901
36902 A log file path may also contain &`%D`& or &`%M`& if datestamped log filenames
36903 are in use &-- see section &<<SECTdatlogfil>>& below.
36904
36905 Here are some examples of possible settings:
36906 .display
36907 &`LOG_FILE_PATH=syslog                    `& syslog only
36908 &`LOG_FILE_PATH=:syslog                   `& syslog and default path
36909 &`LOG_FILE_PATH=syslog : /usr/log/exim_%s `& syslog and specified path
36910 &`LOG_FILE_PATH=/usr/log/exim_%s          `& specified path only
36911 .endd
36912 If there are more than two paths in the list, the first is used and a panic
36913 error is logged.
36914
36915
36916
36917 .section "Logging to local files that are periodically &""cycled""&" "SECID285"
36918 .cindex "log" "cycling local files"
36919 .cindex "cycling logs"
36920 .cindex "&'exicyclog'&"
36921 .cindex "log" "local files; writing to"
36922 Some operating systems provide centralized and standardized methods for cycling
36923 log files. For those that do not, a utility script called &'exicyclog'& is
36924 provided (see section &<<SECTcyclogfil>>&). This renames and compresses the
36925 main and reject logs each time it is called. The maximum number of old logs to
36926 keep can be set. It is suggested this script is run as a daily &'cron'& job.
36927
36928 An Exim delivery process opens the main log when it first needs to write to it,
36929 and it keeps the file open in case subsequent entries are required &-- for
36930 example, if a number of different deliveries are being done for the same
36931 message. However, remote SMTP deliveries can take a long time, and this means
36932 that the file may be kept open long after it is renamed if &'exicyclog'& or
36933 something similar is being used to rename log files on a regular basis. To
36934 ensure that a switch of log files is noticed as soon as possible, Exim calls
36935 &[stat()]& on the main log's name before reusing an open file, and if the file
36936 does not exist, or its inode has changed, the old file is closed and Exim
36937 tries to open the main log from scratch. Thus, an old log file may remain open
36938 for quite some time, but no Exim processes should write to it once it has been
36939 renamed.
36940
36941
36942
36943 .section "Datestamped log files" "SECTdatlogfil"
36944 .cindex "log" "datestamped files"
36945 Instead of cycling the main and reject log files by renaming them
36946 periodically, some sites like to use files whose names contain a datestamp,
36947 for example, &_mainlog-20031225_&. The datestamp is in the form &_yyyymmdd_& or
36948 &_yyyymm_&. Exim has support for this way of working. It is enabled by setting
36949 the &%log_file_path%& option to a path that includes &`%D`& or &`%M`& at the
36950 point where the datestamp is required. For example:
36951 .code
36952 log_file_path = /var/spool/exim/log/%slog-%D
36953 log_file_path = /var/log/exim-%s-%D.log
36954 log_file_path = /var/spool/exim/log/%D-%slog
36955 log_file_path = /var/log/exim/%s.%M
36956 .endd
36957 As before, &`%s`& is replaced by &"main"& or &"reject"&; the following are
36958 examples of names generated by the above examples:
36959 .code
36960 /var/spool/exim/log/mainlog-20021225
36961 /var/log/exim-reject-20021225.log
36962 /var/spool/exim/log/20021225-mainlog
36963 /var/log/exim/main.200212
36964 .endd
36965 When this form of log file is specified, Exim automatically switches to new
36966 files at midnight. It does not make any attempt to compress old logs; you
36967 will need to write your own script if you require this. You should not
36968 run &'exicyclog'& with this form of logging.
36969
36970 The location of the panic log is also determined by &%log_file_path%&, but it
36971 is not datestamped, because rotation of the panic log does not make sense.
36972 When generating the name of the panic log, &`%D`& or &`%M`& are removed from
36973 the string. In addition, if it immediately follows a slash, a following
36974 non-alphanumeric character is removed; otherwise a preceding non-alphanumeric
36975 character is removed. Thus, the four examples above would give these panic
36976 log names:
36977 .code
36978 /var/spool/exim/log/paniclog
36979 /var/log/exim-panic.log
36980 /var/spool/exim/log/paniclog
36981 /var/log/exim/panic
36982 .endd
36983
36984
36985 .section "Logging to syslog" "SECID249"
36986 .cindex "log" "syslog; writing to"
36987 The use of syslog does not change what Exim logs or the format of its messages,
36988 except in one respect. If &%syslog_timestamp%& is set false, the timestamps on
36989 Exim's log lines are omitted when these lines are sent to syslog. Apart from
36990 that, the same strings are written to syslog as to log files. The syslog
36991 &"facility"& is set to LOG_MAIL, and the program name to &"exim"&
36992 by default, but you can change these by setting the &%syslog_facility%& and
36993 &%syslog_processname%& options, respectively. If Exim was compiled with
36994 SYSLOG_LOG_PID set in &_Local/Makefile_& (this is the default in
36995 &_src/EDITME_&), then, on systems that permit it (all except ULTRIX), the
36996 LOG_PID flag is set so that the &[syslog()]& call adds the pid as well as
36997 the time and host name to each line.
36998 The three log streams are mapped onto syslog priorities as follows:
36999
37000 .ilist
37001 &'mainlog'& is mapped to LOG_INFO
37002 .next
37003 &'rejectlog'& is mapped to LOG_NOTICE
37004 .next
37005 &'paniclog'& is mapped to LOG_ALERT
37006 .endlist
37007
37008 Many log lines are written to both &'mainlog'& and &'rejectlog'&, and some are
37009 written to both &'mainlog'& and &'paniclog'&, so there will be duplicates if
37010 these are routed by syslog to the same place. You can suppress this duplication
37011 by setting &%syslog_duplication%& false.
37012
37013 Exim's log lines can sometimes be very long, and some of its &'rejectlog'&
37014 entries contain multiple lines when headers are included. To cope with both
37015 these cases, entries written to syslog are split into separate &[syslog()]&
37016 calls at each internal newline, and also after a maximum of
37017 870 data characters. (This allows for a total syslog line length of 1024, when
37018 additions such as timestamps are added.) If you are running a syslog
37019 replacement that can handle lines longer than the 1024 characters allowed by
37020 RFC 3164, you should set
37021 .code
37022 SYSLOG_LONG_LINES=yes
37023 .endd
37024 in &_Local/Makefile_& before building Exim. That stops Exim from splitting long
37025 lines, but it still splits at internal newlines in &'reject'& log entries.
37026
37027 To make it easy to re-assemble split lines later, each component of a split
37028 entry starts with a string of the form [<&'n'&>/<&'m'&>] or [<&'n'&>\<&'m'&>]
37029 where <&'n'&> is the component number and <&'m'&> is the total number of
37030 components in the entry. The / delimiter is used when the line was split
37031 because it was too long; if it was split because of an internal newline, the \
37032 delimiter is used. For example, supposing the length limit to be 50 instead of
37033 870, the following would be the result of a typical rejection message to
37034 &'mainlog'& (LOG_INFO), each line in addition being preceded by the time, host
37035 name, and pid as added by syslog:
37036 .code
37037 [1/5] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected from
37038 [2/5]  [127.0.0.1] (ph10): syntax error in 'From' header
37039 [3/5]  when scanning for sender: missing or malformed lo
37040 [4/5] cal part in "<>" (envelope sender is <ph10@cam.exa
37041 [5/5] mple>)
37042 .endd
37043 The same error might cause the following lines to be written to &"rejectlog"&
37044 (LOG_NOTICE):
37045 .code
37046 [1/18] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected fro
37047 [2/18] m [127.0.0.1] (ph10): syntax error in 'From' head
37048 [3/18] er when scanning for sender: missing or malformed
37049 [4/18]  local part in "<>" (envelope sender is <ph10@cam
37050 [5\18] .example>)
37051 [6\18] Recipients: ph10@some.domain.cam.example
37052 [7\18] P Received: from [127.0.0.1] (ident=ph10)
37053 [8\18]        by xxxxx.cam.example with smtp (Exim 4.00)
37054 [9\18]        id 16RdAL-0006pc-00
37055 [10/18]        for ph10@cam.example; Mon, 16 Sep 2002 16:
37056 [11\18] 09:43 +0100
37057 [12\18] F From: <>
37058 [13\18]   Subject: this is a test header
37059 [18\18]   X-something: this is another header
37060 [15/18] I Message-Id: <E16RdAL-0006pc-00@xxxxx.cam.examp
37061 [16\18] le>
37062 [17\18] B Bcc:
37063 [18/18]   Date: Mon, 16 Sep 2002 16:09:43 +0100
37064 .endd
37065 Log lines that are neither too long nor contain newlines are written to syslog
37066 without modification.
37067
37068 If only syslog is being used, the Exim monitor is unable to provide a log tail
37069 display, unless syslog is routing &'mainlog'& to a file on the local host and
37070 the environment variable EXIMON_LOG_FILE_PATH is set to tell the monitor
37071 where it is.
37072
37073
37074
37075 .section "Log line flags" "SECID250"
37076 One line is written to the main log for each message received, and for each
37077 successful, unsuccessful, and delayed delivery. These lines can readily be
37078 picked out by the distinctive two-character flags that immediately follow the
37079 timestamp. The flags are:
37080 .display
37081 &`<=`&     message arrival
37082 &`(=`&     message fakereject
37083 &`=>`&     normal message delivery
37084 &`->`&     additional address in same delivery
37085 &`>>`&     cutthrough message delivery
37086 &`*>`&     delivery suppressed by &%-N%&
37087 &`**`&     delivery failed; address bounced
37088 &`==`&     delivery deferred; temporary problem
37089 .endd
37090
37091
37092 .section "Logging message reception" "SECID251"
37093 .cindex "log" "reception line"
37094 The format of the single-line entry in the main log that is written for every
37095 message received is shown in the basic example below, which is split over
37096 several lines in order to fit it on the page:
37097 .code
37098 2002-10-31 08:57:53 16ZCW1-0005MB-00 <= kryten@dwarf.fict.example
37099   H=mailer.fict.example [192.168.123.123] U=exim
37100   P=smtp S=5678 id=<incoming message id>
37101 .endd
37102 The address immediately following &"<="& is the envelope sender address. A
37103 bounce message is shown with the sender address &"<>"&, and if it is locally
37104 generated, this is followed by an item of the form
37105 .code
37106 R=<message id>
37107 .endd
37108 which is a reference to the message that caused the bounce to be sent.
37109
37110 .cindex "HELO"
37111 .cindex "EHLO"
37112 For messages from other hosts, the H and U fields identify the remote host and
37113 record the RFC 1413 identity of the user that sent the message, if one was
37114 received. The number given in square brackets is the IP address of the sending
37115 host. If there is a single, unparenthesized  host name in the H field, as
37116 above, it has been verified to correspond to the IP address (see the
37117 &%host_lookup%& option). If the name is in parentheses, it was the name quoted
37118 by the remote host in the SMTP HELO or EHLO command, and has not been
37119 verified. If verification yields a different name to that given for HELO or
37120 EHLO, the verified name appears first, followed by the HELO or EHLO
37121 name in parentheses.
37122
37123 Misconfigured hosts (and mail forgers) sometimes put an IP address, with or
37124 without brackets, in the HELO or EHLO command, leading to entries in
37125 the log containing text like these examples:
37126 .code
37127 H=(10.21.32.43) [192.168.8.34]
37128 H=([10.21.32.43]) [192.168.8.34]
37129 .endd
37130 This can be confusing. Only the final address in square brackets can be relied
37131 on.
37132
37133 For locally generated messages (that is, messages not received over TCP/IP),
37134 the H field is omitted, and the U field contains the login name of the caller
37135 of Exim.
37136
37137 .cindex "authentication" "logging"
37138 .cindex "AUTH" "logging"
37139 For all messages, the P field specifies the protocol used to receive the
37140 message. This is the value that is stored in &$received_protocol$&. In the case
37141 of incoming SMTP messages, the value indicates whether or not any SMTP
37142 extensions (ESMTP), encryption, or authentication were used. If the SMTP
37143 session was encrypted, there is an additional X field that records the cipher
37144 suite that was used.
37145
37146 .cindex log protocol
37147 The protocol is set to &"esmtpsa"& or &"esmtpa"& for messages received from
37148 hosts that have authenticated themselves using the SMTP AUTH command. The first
37149 value is used when the SMTP connection was encrypted (&"secure"&). In this case
37150 there is an additional item A= followed by the name of the authenticator that
37151 was used. If an authenticated identification was set up by the authenticator's
37152 &%server_set_id%& option, this is logged too, separated by a colon from the
37153 authenticator name.
37154
37155 .cindex "size" "of message"
37156 The id field records the existing message id, if present. The size of the
37157 received message is given by the S field. When the message is delivered,
37158 headers may be removed or added, so that the size of delivered copies of the
37159 message may not correspond with this value (and indeed may be different to each
37160 other).
37161
37162 The &%log_selector%& option can be used to request the logging of additional
37163 data when a message is received. See section &<<SECTlogselector>>& below.
37164
37165
37166
37167 .section "Logging deliveries" "SECID252"
37168 .cindex "log" "delivery line"
37169 The format of the single-line entry in the main log that is written for every
37170 delivery is shown in one of the examples below, for local and remote
37171 deliveries, respectively. Each example has been split into multiple lines in order
37172 to fit it on the page:
37173 .code
37174 2002-10-31 08:59:13 16ZCW1-0005MB-00 => marv
37175   <marv@hitch.fict.example> R=localuser T=local_delivery
37176 2002-10-31 09:00:10 16ZCW1-0005MB-00 =>
37177   monk@holistic.fict.example R=dnslookup T=remote_smtp
37178   H=holistic.fict.example [192.168.234.234]
37179 .endd
37180 For ordinary local deliveries, the original address is given in angle brackets
37181 after the final delivery address, which might be a pipe or a file. If
37182 intermediate address(es) exist between the original and the final address, the
37183 last of these is given in parentheses after the final address. The R and T
37184 fields record the router and transport that were used to process the address.
37185
37186 If SMTP AUTH was used for the delivery there is an additional item A=
37187 followed by the name of the authenticator that was used.
37188 If an authenticated identification was set up by the authenticator's &%client_set_id%&
37189 option, this is logged too, separated by a colon from the authenticator name.
37190
37191 If a shadow transport was run after a successful local delivery, the log line
37192 for the successful delivery has an item added on the end, of the form
37193 .display
37194 &`ST=<`&&'shadow transport name'&&`>`&
37195 .endd
37196 If the shadow transport did not succeed, the error message is put in
37197 parentheses afterwards.
37198
37199 .cindex "asterisk" "after IP address"
37200 When more than one address is included in a single delivery (for example, two
37201 SMTP RCPT commands in one transaction) the second and subsequent addresses are
37202 flagged with &`->`& instead of &`=>`&. When two or more messages are delivered
37203 down a single SMTP connection, an asterisk follows the IP address in the log
37204 lines for the second and subsequent messages.
37205 When two or more messages are delivered down a single TLS connection, the
37206 DNS and some TLS-related information logged for the first message delivered
37207 will not be present in the log lines for the second and subsequent messages.
37208 TLS cipher information is still available.
37209
37210 .cindex "delivery" "cutthrough; logging"
37211 .cindex "cutthrough" "logging"
37212 When delivery is done in cutthrough mode it is flagged with &`>>`& and the log
37213 line precedes the reception line, since cutthrough waits for a possible
37214 rejection from the destination in case it can reject the sourced item.
37215
37216 The generation of a reply message by a filter file gets logged as a
37217 &"delivery"& to the addressee, preceded by &">"&.
37218
37219 The &%log_selector%& option can be used to request the logging of additional
37220 data when a message is delivered. See section &<<SECTlogselector>>& below.
37221
37222
37223 .section "Discarded deliveries" "SECID253"
37224 .cindex "discarded messages"
37225 .cindex "message" "discarded"
37226 .cindex "delivery" "discarded; logging"
37227 When a message is discarded as a result of the command &"seen finish"& being
37228 obeyed in a filter file which generates no deliveries, a log entry of the form
37229 .code
37230 2002-12-10 00:50:49 16auJc-0001UB-00 => discarded
37231   <low.club@bridge.example> R=userforward
37232 .endd
37233 is written, to record why no deliveries are logged. When a message is discarded
37234 because it is aliased to &":blackhole:"& the log line is like this:
37235 .code
37236 1999-03-02 09:44:33 10HmaX-0005vi-00 => :blackhole:
37237   <hole@nowhere.example> R=blackhole_router
37238 .endd
37239
37240
37241 .section "Deferred deliveries" "SECID254"
37242 When a delivery is deferred, a line of the following form is logged:
37243 .code
37244 2002-12-19 16:20:23 16aiQz-0002Q5-00 == marvin@endrest.example
37245   R=dnslookup T=smtp defer (146): Connection refused
37246 .endd
37247 In the case of remote deliveries, the error is the one that was given for the
37248 last IP address that was tried. Details of individual SMTP failures are also
37249 written to the log, so the above line would be preceded by something like
37250 .code
37251 2002-12-19 16:20:23 16aiQz-0002Q5-00 Failed to connect to
37252   mail1.endrest.example [192.168.239.239]: Connection refused
37253 .endd
37254 When a deferred address is skipped because its retry time has not been reached,
37255 a message is written to the log, but this can be suppressed by setting an
37256 appropriate value in &%log_selector%&.
37257
37258
37259
37260 .section "Delivery failures" "SECID255"
37261 .cindex "delivery" "failure; logging"
37262 If a delivery fails because an address cannot be routed, a line of the
37263 following form is logged:
37264 .code
37265 1995-12-19 16:20:23 0tRiQz-0002Q5-00 ** jim@trek99.example
37266   <jim@trek99.example>: unknown mail domain
37267 .endd
37268 If a delivery fails at transport time, the router and transport are shown, and
37269 the response from the remote host is included, as in this example:
37270 .code
37271 2002-07-11 07:14:17 17SXDU-000189-00 ** ace400@pb.example
37272   R=dnslookup T=remote_smtp: SMTP error from remote mailer
37273   after pipelined RCPT TO:<ace400@pb.example>: host
37274   pbmail3.py.example [192.168.63.111]: 553 5.3.0
37275   <ace400@pb.example>...Addressee unknown
37276 .endd
37277 The word &"pipelined"& indicates that the SMTP PIPELINING extension was being
37278 used. See &%hosts_avoid_esmtp%& in the &(smtp)& transport for a way of
37279 disabling PIPELINING. The log lines for all forms of delivery failure are
37280 flagged with &`**`&.
37281
37282
37283
37284 .section "Fake deliveries" "SECID256"
37285 .cindex "delivery" "fake; logging"
37286 If a delivery does not actually take place because the &%-N%& option has been
37287 used to suppress it, a normal delivery line is written to the log, except that
37288 &"=>"& is replaced by &"*>"&.
37289
37290
37291
37292 .section "Completion" "SECID257"
37293 A line of the form
37294 .code
37295 2002-10-31 09:00:11 16ZCW1-0005MB-00 Completed
37296 .endd
37297 is written to the main log when a message is about to be removed from the spool
37298 at the end of its processing.
37299
37300
37301
37302
37303 .section "Summary of Fields in Log Lines" "SECID258"
37304 .cindex "log" "summary of fields"
37305 A summary of the field identifiers that are used in log lines is shown in
37306 the following table:
37307 .display
37308 &`A   `&        authenticator name (and optional id and sender)
37309 &`C   `&        SMTP confirmation on delivery
37310 &`    `&        command list for &"no mail in SMTP session"&
37311 &`CV  `&        certificate verification status
37312 &`D   `&        duration of &"no mail in SMTP session"&
37313 &`DKIM`&        domain verified in incoming message
37314 &`DN  `&        distinguished name from peer certificate
37315 &`DS  `&        DNSSEC secured lookups
37316 &`DT  `&        on &`=>`& lines: time taken for a delivery
37317 &`F   `&        sender address (on delivery lines)
37318 &`H   `&        host name and IP address
37319 &`I   `&        local interface used
37320 &`id  `&        message id (from header) for incoming message
37321 &`K   `&        CHUNKING extension used
37322 &`L   `&        on &`<=`& and &`=>`& lines: PIPELINING extension used
37323 &`M8S `&        8BITMIME status for incoming message
37324 &`P   `&        on &`<=`& lines: protocol used
37325 &`    `&        on &`=>`& and &`**`& lines: return path
37326 &`PRDR`&        PRDR extension used
37327 &`PRX `&        on &`<=`& and &`=>`& lines: proxy address
37328 &`Q   `&        alternate queue name
37329 &`QT  `&        on &`=>`& lines: time spent on queue so far
37330 &`    `&        on &"Completed"& lines: time spent on queue
37331 &`R   `&        on &`<=`& lines: reference for local bounce
37332 &`    `&        on &`=>`&  &`>>`& &`**`& and &`==`& lines: router name
37333 &`RT  `&        on &`<=`& lines: time taken for reception
37334 &`S   `&        size of message in bytes
37335 &`SNI `&        server name indication from TLS client hello
37336 &`ST  `&        shadow transport name
37337 &`T   `&        on &`<=`& lines: message subject (topic)
37338 &`TFO `&        connection took advantage of TCP Fast Open
37339 &`    `&        on &`=>`& &`**`& and &`==`& lines: transport name
37340 &`U   `&        local user or RFC 1413 identity
37341 &`X   `&        TLS cipher suite
37342 .endd
37343
37344
37345 .section "Other log entries" "SECID259"
37346 Various other types of log entry are written from time to time. Most should be
37347 self-explanatory. Among the more common are:
37348
37349 .ilist
37350 .cindex "retry" "time not reached"
37351 &'retry time not reached'&&~&~An address previously suffered a temporary error
37352 during routing or local delivery, and the time to retry has not yet arrived.
37353 This message is not written to an individual message log file unless it happens
37354 during the first delivery attempt.
37355 .next
37356 &'retry time not reached for any host'&&~&~An address previously suffered
37357 temporary errors during remote delivery, and the retry time has not yet arrived
37358 for any of the hosts to which it is routed.
37359 .next
37360 .cindex "spool directory" "file locked"
37361 &'spool file locked'&&~&~An attempt to deliver a message cannot proceed because
37362 some other Exim process is already working on the message. This can be quite
37363 common if queue running processes are started at frequent intervals. The
37364 &'exiwhat'& utility script can be used to find out what Exim processes are
37365 doing.
37366 .next
37367 .cindex "error" "ignored"
37368 &'error ignored'&&~&~There are several circumstances that give rise to this
37369 message:
37370 .olist
37371 Exim failed to deliver a bounce message whose age was greater than
37372 &%ignore_bounce_errors_after%&. The bounce was discarded.
37373 .next
37374 A filter file set up a delivery using the &"noerror"& option, and the delivery
37375 failed. The delivery was discarded.
37376 .next
37377 A delivery set up by a router configured with
37378 . ==== As this is a nested list, any displays it contains must be indented
37379 . ==== as otherwise they are too far to the left.
37380 .code
37381     errors_to = <>
37382 .endd
37383 failed. The delivery was discarded.
37384 .endlist olist
37385 .next
37386 .cindex DKIM "log line"
37387 &'DKIM: d='&&~&~Verbose results of a DKIM verification attempt, if enabled for
37388 logging and the message has a DKIM signature header.
37389 .endlist ilist
37390
37391
37392
37393
37394
37395 .section "Reducing or increasing what is logged" "SECTlogselector"
37396 .cindex "log" "selectors"
37397 By setting the &%log_selector%& global option, you can disable some of Exim's
37398 default logging, or you can request additional logging. The value of
37399 &%log_selector%& is made up of names preceded by plus or minus characters. For
37400 example:
37401 .code
37402 log_selector = +arguments -retry_defer
37403 .endd
37404 The list of optional log items is in the following table, with the default
37405 selection marked by asterisks:
37406 .display
37407 &` 8bitmime                   `&  received 8BITMIME status
37408 &`*acl_warn_skipped           `&  skipped &%warn%& statement in ACL
37409 &` address_rewrite            `&  address rewriting
37410 &` all_parents                `&  all parents in => lines
37411 &` arguments                  `&  command line arguments
37412 &`*connection_reject          `&  connection rejections
37413 &`*delay_delivery             `&  immediate delivery delayed
37414 &` deliver_time               `&  time taken to perform delivery
37415 &` delivery_size              `&  add &`S=`&&'nnn'& to => lines
37416 &`*dkim                       `&  DKIM verified domain on <= lines
37417 &` dkim_verbose               `&  separate full DKIM verification result line, per signature
37418 &`*dnslist_defer              `&  defers of DNS list (aka RBL) lookups
37419 &` dnssec                     `&  DNSSEC secured lookups
37420 &`*etrn                       `&  ETRN commands
37421 &`*host_lookup_failed         `&  as it says
37422 &` ident_timeout              `&  timeout for ident connection
37423 &` incoming_interface         `&  local interface on <= and => lines
37424 &` incoming_port              `&  remote port on <= lines
37425 &`*lost_incoming_connection   `&  as it says (includes timeouts)
37426 &` millisec                   `&  millisecond timestamps and RT,QT,DT,D times
37427 &`*msg_id                     `&  on <= lines, Message-ID: header value
37428 &` msg_id_created             `&  on <= lines, Message-ID: header value when one had to be added
37429 &` outgoing_interface         `&  local interface on => lines
37430 &` outgoing_port              `&  add remote port to => lines
37431 &`*queue_run                  `&  start and end queue runs
37432 &` queue_time                 `&  time on queue for one recipient
37433 &` queue_time_overall         `&  time on queue for whole message
37434 &` pid                        `&  Exim process id
37435 &` pipelining                 `&  PIPELINING use, on <= and => lines
37436 &` proxy                      `&  proxy address on <= and => lines
37437 &` receive_time               `&  time taken to receive message
37438 &` received_recipients        `&  recipients on <= lines
37439 &` received_sender            `&  sender on <= lines
37440 &`*rejected_header            `&  header contents on reject log
37441 &`*retry_defer                `&  &"retry time not reached"&
37442 &` return_path_on_delivery    `&  put return path on => and ** lines
37443 &` sender_on_delivery         `&  add sender to => lines
37444 &`*sender_verify_fail         `&  sender verification failures
37445 &`*size_reject                `&  rejection because too big
37446 &`*skip_delivery              `&  delivery skipped in a queue run
37447 &`*smtp_confirmation          `&  SMTP confirmation on => lines
37448 &` smtp_connection            `&  incoming SMTP connections
37449 &` smtp_incomplete_transaction`&  incomplete SMTP transactions
37450 &` smtp_mailauth              `&  AUTH argument to MAIL commands
37451 &` smtp_no_mail               `&  session with no MAIL commands
37452 &` smtp_protocol_error        `&  SMTP protocol errors
37453 &` smtp_syntax_error          `&  SMTP syntax errors
37454 &` subject                    `&  contents of &'Subject:'& on <= lines
37455 &`*tls_certificate_verified   `&  certificate verification status
37456 &`*tls_cipher                 `&  TLS cipher suite on <= and => lines
37457 &` tls_peerdn                 `&  TLS peer DN on <= and => lines
37458 &` tls_sni                    `&  TLS SNI on <= lines
37459 &` unknown_in_list            `&  DNS lookup failed in list match
37460
37461 &` all                        `&  all of the above
37462 .endd
37463 See also the &%slow_lookup_log%& main configuration option,
37464 section &<<SECID99>>&
37465
37466 More details on each of these items follows:
37467
37468 .ilist
37469 .cindex "8BITMIME"
37470 .cindex "log" "8BITMIME"
37471 &%8bitmime%&: This causes Exim to log any 8BITMIME status of received messages,
37472 which may help in tracking down interoperability issues with ancient MTAs
37473 that are not 8bit clean.  This is added to the &"<="& line, tagged with
37474 &`M8S=`& and a value of &`0`&, &`7`& or &`8`&, corresponding to "not given",
37475 &`7BIT`& and &`8BITMIME`& respectively.
37476 .next
37477 .cindex "&%warn%& ACL verb" "log when skipping"
37478 &%acl_warn_skipped%&: When an ACL &%warn%& statement is skipped because one of
37479 its conditions cannot be evaluated, a log line to this effect is written if
37480 this log selector is set.
37481 .next
37482 .cindex "log" "rewriting"
37483 .cindex "rewriting" "logging"
37484 &%address_rewrite%&: This applies both to global rewrites and per-transport
37485 rewrites, but not to rewrites in filters run as an unprivileged user (because
37486 such users cannot access the log).
37487 .next
37488 .cindex "log" "full parentage"
37489 &%all_parents%&: Normally only the original and final addresses are logged on
37490 delivery lines; with this selector, intermediate parents are given in
37491 parentheses between them.
37492 .next
37493 .cindex "log" "Exim arguments"
37494 .cindex "Exim arguments, logging"
37495 &%arguments%&: This causes Exim to write the arguments with which it was called
37496 to the main log, preceded by the current working directory. This is a debugging
37497 feature, added to make it easier to find out how certain MUAs call
37498 &_/usr/sbin/sendmail_&. The logging does not happen if Exim has given up root
37499 privilege because it was called with the &%-C%& or &%-D%& options. Arguments
37500 that are empty or that contain white space are quoted. Non-printing characters
37501 are shown as escape sequences. This facility cannot log unrecognized arguments,
37502 because the arguments are checked before the configuration file is read. The
37503 only way to log such cases is to interpose a script such as &_util/logargs.sh_&
37504 between the caller and Exim.
37505 .next
37506 .cindex "log" "connection rejections"
37507 &%connection_reject%&: A log entry is written whenever an incoming SMTP
37508 connection is rejected, for whatever reason.
37509 .next
37510 .cindex "log" "delayed delivery"
37511 .cindex "delayed delivery, logging"
37512 &%delay_delivery%&: A log entry is written whenever a delivery process is not
37513 started for an incoming message because the load is too high or too many
37514 messages were received on one connection. Logging does not occur if no delivery
37515 process is started because &%queue_only%& is set or &%-odq%& was used.
37516 .next
37517 .cindex "log" "delivery duration"
37518 &%deliver_time%&: For each delivery, the amount of real time it has taken to
37519 perform the actual delivery is logged as DT=<&'time'&>, for example, &`DT=1s`&.
37520 If millisecond logging is enabled, short times will be shown with greater
37521 precision, eg. &`DT=0.304s`&.
37522 .next
37523 .cindex "log" "message size on delivery"
37524 .cindex "size" "of message"
37525 &%delivery_size%&: For each delivery, the size of message delivered is added to
37526 the &"=>"& line, tagged with S=.
37527 .next
37528 .cindex log "DKIM verification"
37529 .cindex DKIM "verification logging"
37530 &%dkim%&: For message acceptance log lines, when an DKIM signature in the header
37531 verifies successfully a tag of DKIM is added, with one of the verified domains.
37532 .next
37533 .cindex log "DKIM verification"
37534 .cindex DKIM "verification logging"
37535 &%dkim_verbose%&: A log entry is written for each attempted DKIM verification.
37536 .next
37537 .cindex "log" "dnslist defer"
37538 .cindex "DNS list" "logging defer"
37539 .cindex "black list (DNS)"
37540 &%dnslist_defer%&: A log entry is written if an attempt to look up a host in a
37541 DNS black list suffers a temporary error.
37542 .next
37543 .cindex log dnssec
37544 .cindex dnssec logging
37545 &%dnssec%&: For message acceptance and (attempted) delivery log lines, when
37546 dns lookups gave secure results a tag of DS is added.
37547 For acceptance this covers the reverse and forward lookups for host name verification.
37548 It does not cover helo-name verification.
37549 For delivery this covers the SRV, MX, A and/or AAAA lookups.
37550 .next
37551 .cindex "log" "ETRN commands"
37552 .cindex "ETRN" "logging"
37553 &%etrn%&: Every valid ETRN command that is received is logged, before the ACL
37554 is run to determine whether or not it is actually accepted. An invalid ETRN
37555 command, or one received within a message transaction is not logged by this
37556 selector (see &%smtp_syntax_error%& and &%smtp_protocol_error%&).
37557 .next
37558 .cindex "log" "host lookup failure"
37559 &%host_lookup_failed%&: When a lookup of a host's IP addresses fails to find
37560 any addresses, or when a lookup of an IP address fails to find a host name, a
37561 log line is written. This logging does not apply to direct DNS lookups when
37562 routing email addresses, but it does apply to &"byname"& lookups.
37563 .next
37564 .cindex "log" "ident timeout"
37565 .cindex "RFC 1413" "logging timeout"
37566 &%ident_timeout%&: A log line is written whenever an attempt to connect to a
37567 client's ident port times out.
37568 .next
37569 .cindex "log" "incoming interface"
37570 .cindex "log" "local interface"
37571 .cindex "log" "local address and port"
37572 .cindex "TCP/IP" "logging local address and port"
37573 .cindex "interface" "logging"
37574 &%incoming_interface%&: The interface on which a message was received is added
37575 to the &"<="& line as an IP address in square brackets, tagged by I= and
37576 followed by a colon and the port number. The local interface and port are also
37577 added to other SMTP log lines, for example, &"SMTP connection from"&, to
37578 rejection lines, and (despite the name) to outgoing &"=>"& and &"->"& lines.
37579 The latter can be disabled by turning off the &%outgoing_interface%& option.
37580 .next
37581 .cindex log "incoming proxy address"
37582 .cindex proxy "logging proxy address"
37583 .cindex "TCP/IP" "logging proxy address"
37584 &%proxy%&: The internal (closest to the system running Exim) IP address
37585 of the proxy, tagged by PRX=, on the &"<="& line for a message accepted
37586 on a proxied connection
37587 or the &"=>"& line for a message delivered on a proxied connection.
37588 See &<<SECTproxyInbound>>& for more information.
37589 .next
37590 .cindex "log" "incoming remote port"
37591 .cindex "port" "logging remote"
37592 .cindex "TCP/IP" "logging incoming remote port"
37593 .vindex "&$sender_fullhost$&"
37594 .vindex "&$sender_rcvhost$&"
37595 &%incoming_port%&: The remote port number from which a message was received is
37596 added to log entries and &'Received:'& header lines, following the IP address
37597 in square brackets, and separated from it by a colon. This is implemented by
37598 changing the value that is put in the &$sender_fullhost$& and
37599 &$sender_rcvhost$& variables. Recording the remote port number has become more
37600 important with the widening use of NAT (see RFC 2505).
37601 .next
37602 .cindex "log" "dropped connection"
37603 &%lost_incoming_connection%&: A log line is written when an incoming SMTP
37604 connection is unexpectedly dropped.
37605 .next
37606 .cindex "log" "millisecond timestamps"
37607 .cindex millisecond logging
37608 .cindex timestamps "millisecond, in logs"
37609 &%millisec%&: Timestamps have a period and three decimal places of finer granularity
37610 appended to the seconds value.
37611 .next
37612 .new
37613 .cindex "log" "message id"
37614 &%msg_id%&: The value of the Message-ID: header.
37615 .next
37616 &%msg_id_created%&: The value of the Message-ID: header, when one had to be created.
37617 This will be either because the message is a bounce, or was submitted locally
37618 (submission mode) without one.
37619 The field identifier will have an asterix appended: &"id*="&.
37620 .wen
37621 .next
37622 .cindex "log" "outgoing interface"
37623 .cindex "log" "local interface"
37624 .cindex "log" "local address and port"
37625 .cindex "TCP/IP" "logging local address and port"
37626 .cindex "interface" "logging"
37627 &%outgoing_interface%&: If &%incoming_interface%& is turned on, then the
37628 interface on which a message was sent is added to delivery lines as an I= tag
37629 followed by IP address in square brackets. You can disable this by turning
37630 off the &%outgoing_interface%& option.
37631 .next
37632 .cindex "log" "outgoing remote port"
37633 .cindex "port" "logging outgoing remote"
37634 .cindex "TCP/IP" "logging outgoing remote port"
37635 &%outgoing_port%&: The remote port number is added to delivery log lines (those
37636 containing => tags) following the IP address.
37637 The local port is also added if &%incoming_interface%& and
37638 &%outgoing_interface%& are both enabled.
37639 This option is not included in the default setting, because for most ordinary
37640 configurations, the remote port number is always 25 (the SMTP port), and the
37641 local port is a random ephemeral port.
37642 .next
37643 .cindex "log" "process ids in"
37644 .cindex "pid (process id)" "in log lines"
37645 &%pid%&: The current process id is added to every log line, in square brackets,
37646 immediately after the time and date.
37647 .next
37648 .cindex log pipelining
37649 .cindex pipelining "logging outgoing"
37650 &%pipelining%&: A field is added to delivery and accept
37651 log lines when the ESMTP PIPELINING extension was used.
37652 The field is a single "L".
37653
37654 On accept lines, where PIPELINING was offered but not used by the client,
37655 the field has a minus appended.
37656
37657 .new
37658 .cindex "pipelining" "early connection"
37659 If Exim is built with the SUPPORT_PIPE_CONNECT build option
37660 accept "L" fields have a period appended if the feature was
37661 offered but not used, or an asterisk appended if used.
37662 Delivery "L" fields have an asterisk appended if used.
37663 .wen
37664
37665 .next
37666 .cindex "log" "queue run"
37667 .cindex "queue runner" "logging"
37668 &%queue_run%&: The start and end of every queue run are logged.
37669 .next
37670 .cindex "log" "queue time"
37671 &%queue_time%&: The amount of time the message has been in the queue on the
37672 local host is logged as QT=<&'time'&> on delivery (&`=>`&) lines, for example,
37673 &`QT=3m45s`&. The clock starts when Exim starts to receive the message, so it
37674 includes reception time as well as the delivery time for the current address.
37675 This means that it may be longer than the difference between the arrival and
37676 delivery log line times, because the arrival log line is not written until the
37677 message has been successfully received.
37678 If millisecond logging is enabled, short times will be shown with greater
37679 precision, eg. &`QT=1.578s`&.
37680 .next
37681 &%queue_time_overall%&: The amount of time the message has been in the queue on
37682 the local host is logged as QT=<&'time'&> on &"Completed"& lines, for
37683 example, &`QT=3m45s`&. The clock starts when Exim starts to receive the
37684 message, so it includes reception time as well as the total delivery time.
37685 .next
37686 .cindex "log" "receive duration"
37687 &%receive_time%&: For each message, the amount of real time it has taken to
37688 perform the reception is logged as RT=<&'time'&>, for example, &`RT=1s`&.
37689 If millisecond logging is enabled, short times will be shown with greater
37690 precision, eg. &`RT=0.204s`&.
37691 .next
37692 .cindex "log" "recipients"
37693 &%received_recipients%&: The recipients of a message are listed in the main log
37694 as soon as the message is received. The list appears at the end of the log line
37695 that is written when a message is received, preceded by the word &"for"&. The
37696 addresses are listed after they have been qualified, but before any rewriting
37697 has taken place.
37698 Recipients that were discarded by an ACL for MAIL or RCPT do not appear
37699 in the list.
37700 .next
37701 .cindex "log" "sender reception"
37702 &%received_sender%&: The unrewritten original sender of a message is added to
37703 the end of the log line that records the message's arrival, after the word
37704 &"from"& (before the recipients if &%received_recipients%& is also set).
37705 .next
37706 .cindex "log" "header lines for rejection"
37707 &%rejected_header%&: If a message's header has been received at the time a
37708 rejection is written to the reject log, the complete header is added to the
37709 log. Header logging can be turned off individually for messages that are
37710 rejected by the &[local_scan()]& function (see section &<<SECTapiforloc>>&).
37711 .next
37712 .cindex "log" "retry defer"
37713 &%retry_defer%&: A log line is written if a delivery is deferred because a
37714 retry time has not yet been reached. However, this &"retry time not reached"&
37715 message is always omitted from individual message logs after the first delivery
37716 attempt.
37717 .next
37718 .cindex "log" "return path"
37719 &%return_path_on_delivery%&: The return path that is being transmitted with
37720 the message is included in delivery and bounce lines, using the tag P=.
37721 This is omitted if no delivery actually happens, for example, if routing fails,
37722 or if delivery is to &_/dev/null_& or to &`:blackhole:`&.
37723 .next
37724 .cindex "log" "sender on delivery"
37725 &%sender_on_delivery%&: The message's sender address is added to every delivery
37726 and bounce line, tagged by F= (for &"from"&).
37727 This is the original sender that was received with the message; it is not
37728 necessarily the same as the outgoing return path.
37729 .next
37730 .cindex "log" "sender verify failure"
37731 &%sender_verify_fail%&: If this selector is unset, the separate log line that
37732 gives details of a sender verification failure is not written. Log lines for
37733 the rejection of SMTP commands contain just &"sender verify failed"&, so some
37734 detail is lost.
37735 .next
37736 .cindex "log" "size rejection"
37737 &%size_reject%&: A log line is written whenever a message is rejected because
37738 it is too big.
37739 .next
37740 .cindex "log" "frozen messages; skipped"
37741 .cindex "frozen messages" "logging skipping"
37742 &%skip_delivery%&: A log line is written whenever a message is skipped during a
37743 queue run because it is frozen or because another process is already delivering
37744 it.
37745 .cindex "&""spool file is locked""&"
37746 The message that is written is &"spool file is locked"&.
37747 .next
37748 .cindex "log" "smtp confirmation"
37749 .cindex "SMTP" "logging confirmation"
37750 .cindex "LMTP" "logging confirmation"
37751 &%smtp_confirmation%&: The response to the final &"."& in the SMTP or LMTP dialogue for
37752 outgoing messages is added to delivery log lines in the form &`C=`&<&'text'&>.
37753 A number of MTAs (including Exim) return an identifying string in this
37754 response.
37755 .next
37756 .cindex "log" "SMTP connections"
37757 .cindex "SMTP" "logging connections"
37758 &%smtp_connection%&: A log line is written whenever an incoming SMTP connection is
37759 established or closed, unless the connection is from a host that matches
37760 &%hosts_connection_nolog%&. (In contrast, &%lost_incoming_connection%& applies
37761 only when the closure is unexpected.) This applies to connections from local
37762 processes that use &%-bs%& as well as to TCP/IP connections. If a connection is
37763 dropped in the middle of a message, a log line is always written, whether or
37764 not this selector is set, but otherwise nothing is written at the start and end
37765 of connections unless this selector is enabled.
37766
37767 For TCP/IP connections to an Exim daemon, the current number of connections is
37768 included in the log message for each new connection, but note that the count is
37769 reset if the daemon is restarted.
37770 Also, because connections are closed (and the closure is logged) in
37771 subprocesses, the count may not include connections that have been closed but
37772 whose termination the daemon has not yet noticed. Thus, while it is possible to
37773 match up the opening and closing of connections in the log, the value of the
37774 logged counts may not be entirely accurate.
37775 .next
37776 .cindex "log" "SMTP transaction; incomplete"
37777 .cindex "SMTP" "logging incomplete transactions"
37778 &%smtp_incomplete_transaction%&: When a mail transaction is aborted by
37779 RSET, QUIT, loss of connection, or otherwise, the incident is logged,
37780 and the message sender plus any accepted recipients are included in the log
37781 line. This can provide evidence of dictionary attacks.
37782 .next
37783 .cindex "log" "non-MAIL SMTP sessions"
37784 .cindex "MAIL" "logging session without"
37785 &%smtp_no_mail%&: A line is written to the main log whenever an accepted SMTP
37786 connection terminates without having issued a MAIL command. This includes both
37787 the case when the connection is dropped, and the case when QUIT is used. It
37788 does not include cases where the connection is rejected right at the start (by
37789 an ACL, or because there are too many connections, or whatever). These cases
37790 already have their own log lines.
37791
37792 The log line that is written contains the identity of the client in the usual
37793 way, followed by D= and a time, which records the duration of the connection.
37794 If the connection was authenticated, this fact is logged exactly as it is for
37795 an incoming message, with an A= item. If the connection was encrypted, CV=,
37796 DN=, and X= items may appear as they do for an incoming message, controlled by
37797 the same logging options.
37798
37799 Finally, if any SMTP commands were issued during the connection, a C= item
37800 is added to the line, listing the commands that were used. For example,
37801 .code
37802 C=EHLO,QUIT
37803 .endd
37804 shows that the client issued QUIT straight after EHLO. If there were fewer
37805 than 20 commands, they are all listed. If there were more than 20 commands,
37806 the last 20 are listed, preceded by &"..."&. However, with the default
37807 setting of 10 for &%smtp_accept_max_nonmail%&, the connection will in any case
37808 have been aborted before 20 non-mail commands are processed.
37809 .next
37810 &%smtp_mailauth%&: A third subfield with the authenticated sender,
37811 colon-separated, is appended to the A= item for a message arrival or delivery
37812 log line, if an AUTH argument to the SMTP MAIL command (see &<<SECTauthparamail>>&)
37813 was accepted or used.
37814 .next
37815 .cindex "log" "SMTP protocol error"
37816 .cindex "SMTP" "logging protocol error"
37817 &%smtp_protocol_error%&: A log line is written for every SMTP protocol error
37818 encountered. Exim does not have perfect detection of all protocol errors
37819 because of transmission delays and the use of pipelining. If PIPELINING has
37820 been advertised to a client, an Exim server assumes that the client will use
37821 it, and therefore it does not count &"expected"& errors (for example, RCPT
37822 received after rejecting MAIL) as protocol errors.
37823 .next
37824 .cindex "SMTP" "logging syntax errors"
37825 .cindex "SMTP" "syntax errors; logging"
37826 .cindex "SMTP" "unknown command; logging"
37827 .cindex "log" "unknown SMTP command"
37828 .cindex "log" "SMTP syntax error"
37829 &%smtp_syntax_error%&: A log line is written for every SMTP syntax error
37830 encountered. An unrecognized command is treated as a syntax error. For an
37831 external connection, the host identity is given; for an internal connection
37832 using &%-bs%& the sender identification (normally the calling user) is given.
37833 .next
37834 .cindex "log" "subject"
37835 .cindex "subject, logging"
37836 &%subject%&: The subject of the message is added to the arrival log line,
37837 preceded by &"T="& (T for &"topic"&, since S is already used for &"size"&).
37838 Any MIME &"words"& in the subject are decoded. The &%print_topbitchars%& option
37839 specifies whether characters with values greater than 127 should be logged
37840 unchanged, or whether they should be rendered as escape sequences.
37841 .next
37842 .cindex "log" "certificate verification"
37843 .cindex log DANE
37844 .cindex DANE logging
37845 &%tls_certificate_verified%&: An extra item is added to <= and => log lines
37846 when TLS is in use. The item is &`CV=yes`& if the peer's certificate was
37847 verified
37848 using a CA trust anchor,
37849 &`CA=dane`& if using a DNS trust anchor,
37850 and &`CV=no`& if not.
37851 .next
37852 .cindex "log" "TLS cipher"
37853 .cindex "TLS" "logging cipher"
37854 &%tls_cipher%&: When a message is sent or received over an encrypted
37855 connection, the cipher suite used is added to the log line, preceded by X=.
37856 .next
37857 .cindex "log" "TLS peer DN"
37858 .cindex "TLS" "logging peer DN"
37859 &%tls_peerdn%&: When a message is sent or received over an encrypted
37860 connection, and a certificate is supplied by the remote host, the peer DN is
37861 added to the log line, preceded by DN=.
37862 .next
37863 .cindex "log" "TLS SNI"
37864 .cindex "TLS" "logging SNI"
37865 &%tls_sni%&: When a message is received over an encrypted connection, and
37866 the remote host provided the Server Name Indication extension, the SNI is
37867 added to the log line, preceded by SNI=.
37868 .next
37869 .cindex "log" "DNS failure in list"
37870 &%unknown_in_list%&: This setting causes a log entry to be written when the
37871 result of a list match is failure because a DNS lookup failed.
37872 .endlist
37873
37874
37875 .section "Message log" "SECID260"
37876 .cindex "message" "log file for"
37877 .cindex "log" "message log; description of"
37878 .cindex "&_msglog_& directory"
37879 .oindex "&%preserve_message_logs%&"
37880 In addition to the general log files, Exim writes a log file for each message
37881 that it handles. The names of these per-message logs are the message ids, and
37882 they are kept in the &_msglog_& sub-directory of the spool directory. Each
37883 message log contains copies of the log lines that apply to the message. This
37884 makes it easier to inspect the status of an individual message without having
37885 to search the main log. A message log is deleted when processing of the message
37886 is complete, unless &%preserve_message_logs%& is set, but this should be used
37887 only with great care because they can fill up your disk very quickly.
37888
37889 On a heavily loaded system, it may be desirable to disable the use of
37890 per-message logs, in order to reduce disk I/O. This can be done by setting the
37891 &%message_logs%& option false.
37892 .ecindex IIDloggen
37893
37894
37895
37896
37897 . ////////////////////////////////////////////////////////////////////////////
37898 . ////////////////////////////////////////////////////////////////////////////
37899
37900 .chapter "Exim utilities" "CHAPutils"
37901 .scindex IIDutils "utilities"
37902 A number of utility scripts and programs are supplied with Exim and are
37903 described in this chapter. There is also the Exim Monitor, which is covered in
37904 the next chapter. The utilities described here are:
37905
37906 .itable none 0 0 3  7* left  15* left  40* left
37907 .irow &<<SECTfinoutwha>>&     &'exiwhat'&       &&&
37908   "list what Exim processes are doing"
37909 .irow &<<SECTgreptheque>>&    &'exiqgrep'&      "grep the queue"
37910 .irow &<<SECTsumtheque>>&     &'exiqsumm'&      "summarize the queue"
37911 .irow &<<SECTextspeinf>>&     &'exigrep'&       "search the main log"
37912 .irow &<<SECTexipick>>&       &'exipick'&       "select messages on &&&
37913                                                 various criteria"
37914 .irow &<<SECTcyclogfil>>&     &'exicyclog'&     "cycle (rotate) log files"
37915 .irow &<<SECTmailstat>>&      &'eximstats'&     &&&
37916   "extract statistics from the log"
37917 .irow &<<SECTcheckaccess>>&   &'exim_checkaccess'& &&&
37918   "check address acceptance from given IP"
37919 .irow &<<SECTdbmbuild>>&      &'exim_dbmbuild'& "build a DBM file"
37920 .irow &<<SECTfinindret>>&     &'exinext'&       "extract retry information"
37921 .irow &<<SECThindatmai>>&     &'exim_dumpdb'&   "dump a hints database"
37922 .irow &<<SECThindatmai>>&     &'exim_tidydb'&   "clean up a hints database"
37923 .irow &<<SECThindatmai>>&     &'exim_fixdb'&    "patch a hints database"
37924 .irow &<<SECTmailboxmaint>>&  &'exim_lock'&     "lock a mailbox file"
37925 .endtable
37926
37927 Another utility that might be of use to sites with many MTAs is Tom Kistner's
37928 &'exilog'&. It provides log visualizations across multiple Exim servers. See
37929 &url(https://duncanthrax.net/exilog/) for details.
37930
37931
37932
37933
37934 .section "Finding out what Exim processes are doing (exiwhat)" "SECTfinoutwha"
37935 .cindex "&'exiwhat'&"
37936 .cindex "process, querying"
37937 .cindex "SIGUSR1"
37938 On operating systems that can restart a system call after receiving a signal
37939 (most modern OS), an Exim process responds to the SIGUSR1 signal by writing
37940 a line describing what it is doing to the file &_exim-process.info_& in the
37941 Exim spool directory. The &'exiwhat'& script sends the signal to all Exim
37942 processes it can find, having first emptied the file. It then waits for one
37943 second to allow the Exim processes to react before displaying the results. In
37944 order to run &'exiwhat'& successfully you have to have sufficient privilege to
37945 send the signal to the Exim processes, so it is normally run as root.
37946
37947 &*Warning*&: This is not an efficient process. It is intended for occasional
37948 use by system administrators. It is not sensible, for example, to set up a
37949 script that sends SIGUSR1 signals to Exim processes at short intervals.
37950
37951
37952 Unfortunately, the &'ps'& command that &'exiwhat'& uses to find Exim processes
37953 varies in different operating systems. Not only are different options used,
37954 but the format of the output is different. For this reason, there are some
37955 system configuration options that configure exactly how &'exiwhat'& works. If
37956 it doesn't seem to be working for you, check the following compile-time
37957 options:
37958 .display
37959 &`EXIWHAT_PS_CMD    `& the command for running &'ps'&
37960 &`EXIWHAT_PS_ARG    `& the argument for &'ps'&
37961 &`EXIWHAT_EGREP_ARG `& the argument for &'egrep'& to select from &'ps'& output
37962 &`EXIWHAT_KILL_ARG  `& the argument for the &'kill'& command
37963 .endd
37964 An example of typical output from &'exiwhat'& is
37965 .code
37966 164 daemon: -q1h, listening on port 25
37967 10483 running queue: waiting for 0tAycK-0002ij-00 (10492)
37968 10492 delivering 0tAycK-0002ij-00 to mail.ref.example
37969   [10.19.42.42] (editor@ref.example)
37970 10592 handling incoming call from [192.168.243.242]
37971 10628 accepting a local non-SMTP message
37972 .endd
37973 The first number in the output line is the process number. The third line has
37974 been split here, in order to fit it on the page.
37975
37976
37977
37978 .section "Selective queue listing (exiqgrep)" "SECTgreptheque"
37979 .cindex "&'exiqgrep'&"
37980 .cindex "queue" "grepping"
37981 This utility is a Perl script contributed by Matt Hubbard. It runs
37982 .code
37983 exim -bpu
37984 .endd
37985 or (in case &*-a*& switch is specified)
37986 .code
37987 exim -bp
37988 .endd
37989 The &*-C*& option is used to specify an alternate &_exim.conf_& which might
37990 contain alternate exim configuration the queue management might be using.
37991
37992 to obtain a queue listing, and then greps the output to select messages
37993 that match given criteria. The following selection options are available:
37994
37995 .vlist
37996 .vitem &*-f*&&~<&'regex'&>
37997 Match the sender address using a case-insensitive search. The field that is
37998 tested is enclosed in angle brackets, so you can test for bounce messages with
37999 .code
38000 exiqgrep -f '^<>$'
38001 .endd
38002 .vitem &*-r*&&~<&'regex'&>
38003 Match a recipient address using a case-insensitive search. The field that is
38004 tested is not enclosed in angle brackets.
38005
38006 .vitem &*-s*&&~<&'regex'&>
38007 Match against the size field.
38008
38009 .vitem &*-y*&&~<&'seconds'&>
38010 Match messages that are younger than the given time.
38011
38012 .vitem &*-o*&&~<&'seconds'&>
38013 Match messages that are older than the given time.
38014
38015 .vitem &*-z*&
38016 Match only frozen messages.
38017
38018 .vitem &*-x*&
38019 Match only non-frozen messages.
38020
38021 .new
38022 .vitem &*-G*&&~<&'queuename'&>
38023 Match only messages in the given queue.  Without this, the default queue is searched.
38024 .wen
38025 .endlist
38026
38027 The following options control the format of the output:
38028
38029 .vlist
38030 .vitem &*-c*&
38031 Display only the count of matching messages.
38032
38033 .vitem &*-l*&
38034 Long format &-- display the full message information as output by Exim. This is
38035 the default.
38036
38037 .vitem &*-i*&
38038 Display message ids only.
38039
38040 .vitem &*-b*&
38041 Brief format &-- one line per message.
38042
38043 .vitem &*-R*&
38044 Display messages in reverse order.
38045
38046 .vitem &*-a*&
38047 Include delivered recipients in queue listing.
38048 .endlist
38049
38050 There is one more option, &%-h%&, which outputs a list of options.
38051
38052
38053
38054 .section "Summarizing the queue (exiqsumm)" "SECTsumtheque"
38055 .cindex "&'exiqsumm'&"
38056 .cindex "queue" "summary"
38057 The &'exiqsumm'& utility is a Perl script which reads the output of &`exim
38058 -bp`& and produces a summary of the messages in the queue. Thus, you use it by
38059 running a command such as
38060 .code
38061 exim -bp | exiqsumm
38062 .endd
38063 The output consists of one line for each domain that has messages waiting for
38064 it, as in the following example:
38065 .code
38066 3   2322   74m   66m  msn.com.example
38067 .endd
38068 Each line lists the number of pending deliveries for a domain, their total
38069 volume, and the length of time that the oldest and the newest messages have
38070 been waiting. Note that the number of pending deliveries is greater than the
38071 number of messages when messages have more than one recipient.
38072
38073 A summary line is output at the end. By default the output is sorted on the
38074 domain name, but &'exiqsumm'& has the options &%-a%& and &%-c%&, which cause
38075 the output to be sorted by oldest message and by count of messages,
38076 respectively. There are also three options that split the messages for each
38077 domain into two or more subcounts: &%-b%& separates bounce messages, &%-f%&
38078 separates frozen messages, and &%-s%& separates messages according to their
38079 sender.
38080
38081 The output of &'exim -bp'& contains the original addresses in the message, so
38082 this also applies to the output from &'exiqsumm'&. No domains from addresses
38083 generated by aliasing or forwarding are included (unless the &%one_time%&
38084 option of the &(redirect)& router has been used to convert them into &"top
38085 level"& addresses).
38086
38087
38088
38089
38090 .section "Extracting specific information from the log (exigrep)" &&&
38091          "SECTextspeinf"
38092 .cindex "&'exigrep'&"
38093 .cindex "log" "extracts; grepping for"
38094 The &'exigrep'& utility is a Perl script that searches one or more main log
38095 files for entries that match a given pattern. When it finds a match, it
38096 extracts all the log entries for the relevant message, not just those that
38097 match the pattern. Thus, &'exigrep'& can extract complete log entries for a
38098 given message, or all mail for a given user, or for a given host, for example.
38099 The input files can be in Exim log format or syslog format.
38100 If a matching log line is not associated with a specific message, it is
38101 included in &'exigrep'&'s output without any additional lines. The usage is:
38102 .display
38103 &`exigrep [-t<`&&'n'&&`>] [-I] [-l] [-M] [-v] <`&&'pattern'&&`> [<`&&'log file'&&`>] ...`&
38104 .endd
38105 If no log filenames are given on the command line, the standard input is read.
38106
38107 The &%-t%& argument specifies a number of seconds. It adds an additional
38108 condition for message selection. Messages that are complete are shown only if
38109 they spent more than <&'n'&> seconds in the queue.
38110
38111 By default, &'exigrep'& does case-insensitive matching. The &%-I%& option
38112 makes it case-sensitive. This may give a performance improvement when searching
38113 large log files. Without &%-I%&, the Perl pattern matches use Perl's &`/i`&
38114 option; with &%-I%& they do not. In both cases it is possible to change the
38115 case sensitivity within the pattern by using &`(?i)`& or &`(?-i)`&.
38116
38117 The &%-l%& option means &"literal"&, that is, treat all characters in the
38118 pattern as standing for themselves. Otherwise the pattern must be a Perl
38119 regular expression.
38120
38121 The &%-v%& option inverts the matching condition. That is, a line is selected
38122 if it does &'not'& match the pattern.
38123
38124 The &%-M%& options means &"related messages"&. &'exigrep'& will show messages
38125 that are generated as a result/response to a message that &'exigrep'& matched
38126 normally.
38127
38128 Example of &%-M%&:
38129 user_a sends a message to user_b, which generates a bounce back to user_b. If
38130 &'exigrep'& is used to search for &"user_a"&, only the first message will be
38131 displayed.  But if &'exigrep'& is used to search for &"user_b"&, the first and
38132 the second (bounce) message will be displayed. Using &%-M%& with &'exigrep'&
38133 when searching for &"user_a"& will show both messages since the bounce is
38134 &"related"& to or a &"result"& of the first message that was found by the
38135 search term.
38136
38137 If the location of a &'zcat'& command is known from the definition of
38138 ZCAT_COMMAND in &_Local/Makefile_&, &'exigrep'& automatically passes any file
38139 whose name ends in COMPRESS_SUFFIX through &'zcat'& as it searches it.
38140 If the ZCAT_COMMAND is not executable, &'exigrep'& tries to use
38141 autodetection of some well known compression extensions.
38142
38143
38144 .section "Selecting messages by various criteria (exipick)" "SECTexipick"
38145 .cindex "&'exipick'&"
38146 John Jetmore's &'exipick'& utility is included in the Exim distribution. It
38147 lists messages from the queue according to a variety of criteria. For details
38148 of &'exipick'&'s facilities, run &'exipick'& with
38149 the &%--help%& option.
38150
38151
38152 .section "Cycling log files (exicyclog)" "SECTcyclogfil"
38153 .cindex "log" "cycling local files"
38154 .cindex "cycling logs"
38155 .cindex "&'exicyclog'&"
38156 The &'exicyclog'& script can be used to cycle (rotate) &'mainlog'& and
38157 &'rejectlog'& files. This is not necessary if only syslog is being used, or if
38158 you are using log files with datestamps in their names (see section
38159 &<<SECTdatlogfil>>&). Some operating systems have their own standard mechanisms
38160 for log cycling, and these can be used instead of &'exicyclog'& if preferred.
38161 There are two command line options for &'exicyclog'&:
38162 .ilist
38163 &%-k%& <&'count'&> specifies the number of log files to keep, overriding the
38164 default that is set when Exim is built. The default default is 10.
38165 .next
38166 &%-l%& <&'path'&> specifies the log file path, in the same format as Exim's
38167 &%log_file_path%& option (for example, &`/var/log/exim_%slog`&), again
38168 overriding the script's default, which is to find the setting from Exim's
38169 configuration.
38170 .endlist
38171
38172 Each time &'exicyclog'& is run the filenames get &"shuffled down"& by one. If
38173 the main log filename is &_mainlog_& (the default) then when &'exicyclog'& is
38174 run &_mainlog_& becomes &_mainlog.01_&, the previous &_mainlog.01_& becomes
38175 &_mainlog.02_& and so on, up to the limit that is set in the script or by the
38176 &%-k%& option. Log files whose numbers exceed the limit are discarded. Reject
38177 logs are handled similarly.
38178
38179 If the limit is greater than 99, the script uses 3-digit numbers such as
38180 &_mainlog.001_&, &_mainlog.002_&, etc. If you change from a number less than 99
38181 to one that is greater, or &'vice versa'&, you will have to fix the names of
38182 any existing log files.
38183
38184 If no &_mainlog_& file exists, the script does nothing. Files that &"drop off"&
38185 the end are deleted. All files with numbers greater than 01 are compressed,
38186 using a compression command which is configured by the COMPRESS_COMMAND
38187 setting in &_Local/Makefile_&. It is usual to run &'exicyclog'& daily from a
38188 root &%crontab%& entry of the form
38189 .code
38190 1 0 * * * su exim -c /usr/exim/bin/exicyclog
38191 .endd
38192 assuming you have used the name &"exim"& for the Exim user. You can run
38193 &'exicyclog'& as root if you wish, but there is no need.
38194
38195
38196
38197 .section "Mail statistics (eximstats)" "SECTmailstat"
38198 .cindex "statistics"
38199 .cindex "&'eximstats'&"
38200 A Perl script called &'eximstats'& is provided for extracting statistical
38201 information from log files. The output is either plain text, or HTML.
38202 . --- 2018-09-07: LogReport's Lire appears to be dead; website is a Yahoo Japan
38203 . --- 404 error and everything else points to that.
38204
38205 The &'eximstats'& script has been hacked about quite a bit over time. The
38206 latest version is the result of some extensive revision by Steve Campbell. A
38207 lot of information is given by default, but there are options for suppressing
38208 various parts of it. Following any options, the arguments to the script are a
38209 list of files, which should be main log files. For example:
38210 .code
38211 eximstats -nr /var/spool/exim/log/mainlog.01
38212 .endd
38213 By default, &'eximstats'& extracts information about the number and volume of
38214 messages received from or delivered to various hosts. The information is sorted
38215 both by message count and by volume, and the top fifty hosts in each category
38216 are listed on the standard output. Similar information, based on email
38217 addresses or domains instead of hosts can be requested by means of various
38218 options. For messages delivered and received locally, similar statistics are
38219 also produced per user.
38220
38221 The output also includes total counts and statistics about delivery errors, and
38222 histograms showing the number of messages received and deliveries made in each
38223 hour of the day. A delivery with more than one address in its envelope (for
38224 example, an SMTP transaction with more than one RCPT command) is counted
38225 as a single delivery by &'eximstats'&.
38226
38227 Though normally more deliveries than receipts are reported (as messages may
38228 have multiple recipients), it is possible for &'eximstats'& to report more
38229 messages received than delivered, even though the queue is empty at the start
38230 and end of the period in question. If an incoming message contains no valid
38231 recipients, no deliveries are recorded for it. A bounce message is handled as
38232 an entirely separate message.
38233
38234 &'eximstats'& always outputs a grand total summary giving the volume and number
38235 of messages received and deliveries made, and the number of hosts involved in
38236 each case. It also outputs the number of messages that were delayed (that is,
38237 not completely delivered at the first attempt), and the number that had at
38238 least one address that failed.
38239
38240 The remainder of the output is in sections that can be independently disabled
38241 or modified by various options. It consists of a summary of deliveries by
38242 transport, histograms of messages received and delivered per time interval
38243 (default per hour), information about the time messages spent in the queue,
38244 a list of relayed messages, lists of the top fifty sending hosts, local
38245 senders, destination hosts, and destination local users by count and by volume,
38246 and a list of delivery errors that occurred.
38247
38248 The relay information lists messages that were actually relayed, that is, they
38249 came from a remote host and were directly delivered to some other remote host,
38250 without being processed (for example, for aliasing or forwarding) locally.
38251
38252 There are quite a few options for &'eximstats'& to control exactly what it
38253 outputs. These are documented in the Perl script itself, and can be extracted
38254 by running the command &(perldoc)& on the script. For example:
38255 .code
38256 perldoc /usr/exim/bin/eximstats
38257 .endd
38258
38259 .section "Checking access policy (exim_checkaccess)" "SECTcheckaccess"
38260 .cindex "&'exim_checkaccess'&"
38261 .cindex "policy control" "checking access"
38262 .cindex "checking access"
38263 The &%-bh%& command line argument allows you to run a fake SMTP session with
38264 debugging output, in order to check what Exim is doing when it is applying
38265 policy controls to incoming SMTP mail. However, not everybody is sufficiently
38266 familiar with the SMTP protocol to be able to make full use of &%-bh%&, and
38267 sometimes you just want to answer the question &"Does this address have
38268 access?"& without bothering with any further details.
38269
38270 The &'exim_checkaccess'& utility is a &"packaged"& version of &%-bh%&. It takes
38271 two arguments, an IP address and an email address:
38272 .code
38273 exim_checkaccess 10.9.8.7 A.User@a.domain.example
38274 .endd
38275 The utility runs a call to Exim with the &%-bh%& option, to test whether the
38276 given email address would be accepted in a RCPT command in a TCP/IP
38277 connection from the host with the given IP address. The output of the utility
38278 is either the word &"accepted"&, or the SMTP error response, for example:
38279 .code
38280 Rejected:
38281 550 Relay not permitted
38282 .endd
38283 When running this test, the utility uses &`<>`& as the envelope sender address
38284 for the MAIL command, but you can change this by providing additional
38285 options. These are passed directly to the Exim command. For example, to specify
38286 that the test is to be run with the sender address &'himself@there.example'&
38287 you can use:
38288 .code
38289 exim_checkaccess 10.9.8.7 A.User@a.domain.example \
38290                  -f himself@there.example
38291 .endd
38292 Note that these additional Exim command line items must be given after the two
38293 mandatory arguments.
38294
38295 Because the &%exim_checkaccess%& uses &%-bh%&, it does not perform callouts
38296 while running its checks. You can run checks that include callouts by using
38297 &%-bhc%&, but this is not yet available in a &"packaged"& form.
38298
38299
38300
38301 .section "Making DBM files (exim_dbmbuild)" "SECTdbmbuild"
38302 .cindex "DBM" "building dbm files"
38303 .cindex "building DBM files"
38304 .cindex "&'exim_dbmbuild'&"
38305 .cindex "lower casing"
38306 .cindex "binary zero" "in lookup key"
38307 The &'exim_dbmbuild'& program reads an input file containing keys and data in
38308 the format used by the &(lsearch)& lookup (see section
38309 &<<SECTsinglekeylookups>>&). It writes a DBM file using the lower-cased alias
38310 names as keys and the remainder of the information as data. The lower-casing
38311 can be prevented by calling the program with the &%-nolc%& option.
38312
38313 A terminating zero is included as part of the key string. This is expected by
38314 the &(dbm)& lookup type. However, if the option &%-nozero%& is given,
38315 &'exim_dbmbuild'& creates files without terminating zeroes in either the key
38316 strings or the data strings. The &(dbmnz)& lookup type can be used with such
38317 files.
38318
38319 The program requires two arguments: the name of the input file (which can be a
38320 single hyphen to indicate the standard input), and the name of the output file.
38321 It creates the output under a temporary name, and then renames it if all went
38322 well.
38323
38324 .cindex "USE_DB"
38325 If the native DB interface is in use (USE_DB is set in a compile-time
38326 configuration file &-- this is common in free versions of Unix) the two
38327 filenames must be different, because in this mode the Berkeley DB functions
38328 create a single output file using exactly the name given. For example,
38329 .code
38330 exim_dbmbuild /etc/aliases /etc/aliases.db
38331 .endd
38332 reads the system alias file and creates a DBM version of it in
38333 &_/etc/aliases.db_&.
38334
38335 In systems that use the &'ndbm'& routines (mostly proprietary versions of
38336 Unix), two files are used, with the suffixes &_.dir_& and &_.pag_&. In this
38337 environment, the suffixes are added to the second argument of
38338 &'exim_dbmbuild'&, so it can be the same as the first. This is also the case
38339 when the Berkeley functions are used in compatibility mode (though this is not
38340 recommended), because in that case it adds a &_.db_& suffix to the filename.
38341
38342 If a duplicate key is encountered, the program outputs a warning, and when it
38343 finishes, its return code is 1 rather than zero, unless the &%-noduperr%&
38344 option is used. By default, only the first of a set of duplicates is used &--
38345 this makes it compatible with &(lsearch)& lookups. There is an option
38346 &%-lastdup%& which causes it to use the data for the last duplicate instead.
38347 There is also an option &%-nowarn%&, which stops it listing duplicate keys to
38348 &%stderr%&. For other errors, where it doesn't actually make a new file, the
38349 return code is 2.
38350
38351
38352
38353
38354 .section "Finding individual retry times (exinext)" "SECTfinindret"
38355 .cindex "retry" "times"
38356 .cindex "&'exinext'&"
38357 A utility called &'exinext'& (mostly a Perl script) provides the ability to
38358 fish specific information out of the retry database. Given a mail domain (or a
38359 complete address), it looks up the hosts for that domain, and outputs any retry
38360 information for the hosts or for the domain. At present, the retry information
38361 is obtained by running &'exim_dumpdb'& (see below) and post-processing the
38362 output. For example:
38363 .code
38364 $ exinext piglet@milne.fict.example
38365 kanga.milne.example:192.168.8.1 error 146: Connection refused
38366   first failed: 21-Feb-1996 14:57:34
38367   last tried:   21-Feb-1996 14:57:34
38368   next try at:  21-Feb-1996 15:02:34
38369 roo.milne.example:192.168.8.3 error 146: Connection refused
38370   first failed: 20-Jan-1996 13:12:08
38371   last tried:   21-Feb-1996 11:42:03
38372   next try at:  21-Feb-1996 19:42:03
38373   past final cutoff time
38374 .endd
38375 You can also give &'exinext'& a local part, without a domain, and it
38376 will give any retry information for that local part in your default domain.
38377 A message id can be used to obtain retry information pertaining to a specific
38378 message. This exists only when an attempt to deliver a message to a remote host
38379 suffers a message-specific error (see section &<<SECToutSMTPerr>>&).
38380 &'exinext'& is not particularly efficient, but then it is not expected to be
38381 run very often.
38382
38383 The &'exinext'& utility calls Exim to find out information such as the location
38384 of the spool directory. The utility has &%-C%& and &%-D%& options, which are
38385 passed on to the &'exim'& commands. The first specifies an alternate Exim
38386 configuration file, and the second sets macros for use within the configuration
38387 file. These features are mainly to help in testing, but might also be useful in
38388 environments where more than one configuration file is in use.
38389
38390
38391
38392 .section "Hints database maintenance" "SECThindatmai"
38393 .cindex "hints database" "maintenance"
38394 .cindex "maintaining Exim's hints database"
38395 Three utility programs are provided for maintaining the DBM files that Exim
38396 uses to contain its delivery hint information. Each program requires two
38397 arguments. The first specifies the name of Exim's spool directory, and the
38398 second is the name of the database it is to operate on. These are as follows:
38399
38400 .ilist
38401 &'retry'&: the database of retry information
38402 .next
38403 &'wait-'&<&'transport name'&>: databases of information about messages waiting
38404 for remote hosts
38405 .next
38406 &'callout'&: the callout cache
38407 .next
38408 &'ratelimit'&: the data for implementing the ratelimit ACL condition
38409 .next
38410 &'misc'&: other hints data
38411 .endlist
38412
38413 The &'misc'& database is used for
38414
38415 .ilist
38416 Serializing ETRN runs (when &%smtp_etrn_serialize%& is set)
38417 .next
38418 Serializing delivery to a specific host (when &%serialize_hosts%& is set in an
38419 &(smtp)& transport)
38420 .next
38421 Limiting the concurrency of specific transports (when &%max_parallel%& is set
38422 in a transport)
38423 .endlist
38424
38425
38426
38427 .section "exim_dumpdb" "SECID261"
38428 .cindex "&'exim_dumpdb'&"
38429 The entire contents of a database are written to the standard output by the
38430 &'exim_dumpdb'& program, which has no options or arguments other than the
38431 spool and database names. For example, to dump the retry database:
38432 .code
38433 exim_dumpdb /var/spool/exim retry
38434 .endd
38435 Two lines of output are produced for each entry:
38436 .code
38437 T:mail.ref.example:192.168.242.242 146 77 Connection refused
38438 31-Oct-1995 12:00:12 02-Nov-1995 12:21:39 02-Nov-1995 20:21:39 *
38439 .endd
38440 The first item on the first line is the key of the record. It starts with one
38441 of the letters R, or T, depending on whether it refers to a routing or
38442 transport retry. For a local delivery, the next part is the local address; for
38443 a remote delivery it is the name of the remote host, followed by its failing IP
38444 address (unless &%retry_include_ip_address%& is set false on the &(smtp)&
38445 transport). If the remote port is not the standard one (port 25), it is added
38446 to the IP address. Then there follows an error code, an additional error code,
38447 and a textual description of the error.
38448
38449 The three times on the second line are the time of first failure, the time of
38450 the last delivery attempt, and the computed time for the next attempt. The line
38451 ends with an asterisk if the cutoff time for the last retry rule has been
38452 exceeded.
38453
38454 Each output line from &'exim_dumpdb'& for the &'wait-xxx'& databases
38455 consists of a host name followed by a list of ids for messages that are or were
38456 waiting to be delivered to that host. If there are a very large number for any
38457 one host, continuation records, with a sequence number added to the host name,
38458 may be seen. The data in these records is often out of date, because a message
38459 may be routed to several alternative hosts, and Exim makes no effort to keep
38460 cross-references.
38461
38462
38463
38464 .section "exim_tidydb" "SECID262"
38465 .cindex "&'exim_tidydb'&"
38466 The &'exim_tidydb'& utility program is used to tidy up the contents of a hints
38467 database. If run with no options, it removes all records that are more than 30
38468 days old. The age is calculated from the date and time that the record was last
38469 updated. Note that, in the case of the retry database, it is &'not'& the time
38470 since the first delivery failure. Information about a host that has been down
38471 for more than 30 days will remain in the database, provided that the record is
38472 updated sufficiently often.
38473
38474 The cutoff date can be altered by means of the &%-t%& option, which must be
38475 followed by a time. For example, to remove all records older than a week from
38476 the retry database:
38477 .code
38478 exim_tidydb -t 7d /var/spool/exim retry
38479 .endd
38480 Both the &'wait-xxx'& and &'retry'& databases contain items that involve
38481 message ids. In the former these appear as data in records keyed by host &--
38482 they were messages that were waiting for that host &-- and in the latter they
38483 are the keys for retry information for messages that have suffered certain
38484 types of error. When &'exim_tidydb'& is run, a check is made to ensure that
38485 message ids in database records are those of messages that are still on the
38486 queue. Message ids for messages that no longer exist are removed from
38487 &'wait-xxx'& records, and if this leaves any records empty, they are deleted.
38488 For the &'retry'& database, records whose keys are non-existent message ids are
38489 removed. The &'exim_tidydb'& utility outputs comments on the standard output
38490 whenever it removes information from the database.
38491
38492 Certain records are automatically removed by Exim when they are no longer
38493 needed, but others are not. For example, if all the MX hosts for a domain are
38494 down, a retry record is created for each one. If the primary MX host comes back
38495 first, its record is removed when Exim successfully delivers to it, but the
38496 records for the others remain because Exim has not tried to use those hosts.
38497
38498 It is important, therefore, to run &'exim_tidydb'& periodically on all the
38499 hints databases. You should do this at a quiet time of day, because it requires
38500 a database to be locked (and therefore inaccessible to Exim) while it does its
38501 work. Removing records from a DBM file does not normally make the file smaller,
38502 but all the common DBM libraries are able to re-use the space that is released.
38503 After an initial phase of increasing in size, the databases normally reach a
38504 point at which they no longer get any bigger, as long as they are regularly
38505 tidied.
38506
38507 &*Warning*&: If you never run &'exim_tidydb'&, the space used by the hints
38508 databases is likely to keep on increasing.
38509
38510
38511
38512
38513 .section "exim_fixdb" "SECID263"
38514 .cindex "&'exim_fixdb'&"
38515 The &'exim_fixdb'& program is a utility for interactively modifying databases.
38516 Its main use is for testing Exim, but it might also be occasionally useful for
38517 getting round problems in a live system. It has no options, and its interface
38518 is somewhat crude. On entry, it prompts for input with a right angle-bracket. A
38519 key of a database record can then be entered, and the data for that record is
38520 displayed.
38521
38522 If &"d"& is typed at the next prompt, the entire record is deleted. For all
38523 except the &'retry'& database, that is the only operation that can be carried
38524 out. For the &'retry'& database, each field is output preceded by a number, and
38525 data for individual fields can be changed by typing the field number followed
38526 by new data, for example:
38527 .code
38528 > 4 951102:1000
38529 .endd
38530 resets the time of the next delivery attempt. Time values are given as a
38531 sequence of digit pairs for year, month, day, hour, and minute. Colons can be
38532 used as optional separators.
38533
38534
38535
38536
38537 .section "Mailbox maintenance (exim_lock)" "SECTmailboxmaint"
38538 .cindex "mailbox" "maintenance"
38539 .cindex "&'exim_lock'&"
38540 .cindex "locking mailboxes"
38541 The &'exim_lock'& utility locks a mailbox file using the same algorithm as
38542 Exim. For a discussion of locking issues, see section &<<SECTopappend>>&.
38543 &'Exim_lock'& can be used to prevent any modification of a mailbox by Exim or
38544 a user agent while investigating a problem. The utility requires the name of
38545 the file as its first argument. If the locking is successful, the second
38546 argument is run as a command (using C's &[system()]& function); if there is no
38547 second argument, the value of the SHELL environment variable is used; if this
38548 is unset or empty, &_/bin/sh_& is run. When the command finishes, the mailbox
38549 is unlocked and the utility ends. The following options are available:
38550
38551 .vlist
38552 .vitem &%-fcntl%&
38553 Use &[fcntl()]& locking on the open mailbox.
38554
38555 .vitem &%-flock%&
38556 Use &[flock()]& locking on the open mailbox, provided the operating system
38557 supports it.
38558
38559 .vitem &%-interval%&
38560 This must be followed by a number, which is a number of seconds; it sets the
38561 interval to sleep between retries (default 3).
38562
38563 .vitem &%-lockfile%&
38564 Create a lock file before opening the mailbox.
38565
38566 .vitem &%-mbx%&
38567 Lock the mailbox using MBX rules.
38568
38569 .vitem &%-q%&
38570 Suppress verification output.
38571
38572 .vitem &%-retries%&
38573 This must be followed by a number; it sets the number of times to try to get
38574 the lock (default 10).
38575
38576 .vitem &%-restore_time%&
38577 This option causes &%exim_lock%& to restore the modified and read times to the
38578 locked file before exiting. This allows you to access a locked mailbox (for
38579 example, to take a backup copy) without disturbing the times that the user
38580 subsequently sees.
38581
38582 .vitem &%-timeout%&
38583 This must be followed by a number, which is a number of seconds; it sets a
38584 timeout to be used with a blocking &[fcntl()]& lock. If it is not set (the
38585 default), a non-blocking call is used.
38586
38587 .vitem &%-v%&
38588 Generate verbose output.
38589 .endlist
38590
38591 If none of &%-fcntl%&, &%-flock%&, &%-lockfile%& or &%-mbx%& are given, the
38592 default is to create a lock file and also to use &[fcntl()]& locking on the
38593 mailbox, which is the same as Exim's default. The use of &%-flock%& or
38594 &%-fcntl%& requires that the file be writeable; the use of &%-lockfile%&
38595 requires that the directory containing the file be writeable. Locking by lock
38596 file does not last forever; Exim assumes that a lock file is expired if it is
38597 more than 30 minutes old.
38598
38599 The &%-mbx%& option can be used with either or both of &%-fcntl%& or
38600 &%-flock%&. It assumes &%-fcntl%& by default. MBX locking causes a shared lock
38601 to be taken out on the open mailbox, and an exclusive lock on the file
38602 &_/tmp/.n.m_& where &'n'& and &'m'& are the device number and inode
38603 number of the mailbox file. When the locking is released, if an exclusive lock
38604 can be obtained for the mailbox, the file in &_/tmp_& is deleted.
38605
38606 The default output contains verification of the locking that takes place. The
38607 &%-v%& option causes some additional information to be given. The &%-q%& option
38608 suppresses all output except error messages.
38609
38610 A command such as
38611 .code
38612 exim_lock /var/spool/mail/spqr
38613 .endd
38614 runs an interactive shell while the file is locked, whereas
38615 .display
38616 &`exim_lock -q /var/spool/mail/spqr <<End`&
38617 <&'some commands'&>
38618 &`End`&
38619 .endd
38620 runs a specific non-interactive sequence of commands while the file is locked,
38621 suppressing all verification output. A single command can be run by a command
38622 such as
38623 .code
38624 exim_lock -q /var/spool/mail/spqr \
38625   "cp /var/spool/mail/spqr /some/where"
38626 .endd
38627 Note that if a command is supplied, it must be entirely contained within the
38628 second argument &-- hence the quotes.
38629 .ecindex IIDutils
38630
38631
38632 . ////////////////////////////////////////////////////////////////////////////
38633 . ////////////////////////////////////////////////////////////////////////////
38634
38635 .chapter "The Exim monitor" "CHAPeximon"
38636 .scindex IIDeximon "Exim monitor" "description"
38637 .cindex "X-windows"
38638 .cindex "&'eximon'&"
38639 .cindex "Local/eximon.conf"
38640 .cindex "&_exim_monitor/EDITME_&"
38641 The Exim monitor is an application which displays in an X window information
38642 about the state of Exim's queue and what Exim is doing. An admin user can
38643 perform certain operations on messages from this GUI interface; however all
38644 such facilities are also available from the command line, and indeed, the
38645 monitor itself makes use of the command line to perform any actions requested.
38646
38647
38648
38649 .section "Running the monitor" "SECID264"
38650 The monitor is started by running the script called &'eximon'&. This is a shell
38651 script that sets up a number of environment variables, and then runs the
38652 binary called &_eximon.bin_&. The default appearance of the monitor window can
38653 be changed by editing the &_Local/eximon.conf_& file created by editing
38654 &_exim_monitor/EDITME_&. Comments in that file describe what the various
38655 parameters are for.
38656
38657 The parameters that get built into the &'eximon'& script can be overridden for
38658 a particular invocation by setting up environment variables of the same names,
38659 preceded by &`EXIMON_`&. For example, a shell command such as
38660 .code
38661 EXIMON_LOG_DEPTH=400 eximon
38662 .endd
38663 (in a Bourne-compatible shell) runs &'eximon'& with an overriding setting of
38664 the LOG_DEPTH parameter. If EXIMON_LOG_FILE_PATH is set in the environment, it
38665 overrides the Exim log file configuration. This makes it possible to have
38666 &'eximon'& tailing log data that is written to syslog, provided that MAIL.INFO
38667 syslog messages are routed to a file on the local host.
38668
38669 X resources can be used to change the appearance of the window in the normal
38670 way. For example, a resource setting of the form
38671 .code
38672 Eximon*background: gray94
38673 .endd
38674 changes the colour of the background to light grey rather than white. The
38675 stripcharts are drawn with both the data lines and the reference lines in
38676 black. This means that the reference lines are not visible when on top of the
38677 data. However, their colour can be changed by setting a resource called
38678 &"highlight"& (an odd name, but that's what the Athena stripchart widget uses).
38679 For example, if your X server is running Unix, you could set up lighter
38680 reference lines in the stripcharts by obeying
38681 .code
38682 xrdb -merge <<End
38683 Eximon*highlight: gray
38684 End
38685 .endd
38686 .cindex "admin user"
38687 In order to see the contents of messages in the queue, and to operate on them,
38688 &'eximon'& must either be run as root or by an admin user.
38689
38690 The command-line parameters of &'eximon'& are passed to &_eximon.bin_& and may
38691 contain X11 resource parameters interpreted by the X11 library.  In addition,
38692 if the first parameter starts with the string "gdb" then it is removed and the
38693 binary is invoked under gdb (the parameter is used as the gdb command-name, so
38694 versioned variants of gdb can be invoked).
38695
38696 The monitor's window is divided into three parts. The first contains one or
38697 more stripcharts and two action buttons, the second contains a &"tail"& of the
38698 main log file, and the third is a display of the queue of messages awaiting
38699 delivery, with two more action buttons. The following sections describe these
38700 different parts of the display.
38701
38702
38703
38704
38705 .section "The stripcharts" "SECID265"
38706 .cindex "stripchart"
38707 The first stripchart is always a count of messages in the queue. Its name can
38708 be configured by setting QUEUE_STRIPCHART_NAME in the
38709 &_Local/eximon.conf_& file. The remaining stripcharts are defined in the
38710 configuration script by regular expression matches on log file entries, making
38711 it possible to display, for example, counts of messages delivered to certain
38712 hosts or using certain transports. The supplied defaults display counts of
38713 received and delivered messages, and of local and SMTP deliveries. The default
38714 period between stripchart updates is one minute; this can be adjusted by a
38715 parameter in the &_Local/eximon.conf_& file.
38716
38717 The stripchart displays rescale themselves automatically as the value they are
38718 displaying changes. There are always 10 horizontal lines in each chart; the
38719 title string indicates the value of each division when it is greater than one.
38720 For example, &"x2"& means that each division represents a value of 2.
38721
38722 It is also possible to have a stripchart which shows the percentage fullness of
38723 a particular disk partition, which is useful when local deliveries are confined
38724 to a single partition.
38725
38726 .cindex "&%statvfs%& function"
38727 This relies on the availability of the &[statvfs()]& function or equivalent in
38728 the operating system. Most, but not all versions of Unix that support Exim have
38729 this. For this particular stripchart, the top of the chart always represents
38730 100%, and the scale is given as &"x10%"&. This chart is configured by setting
38731 SIZE_STRIPCHART and (optionally) SIZE_STRIPCHART_NAME in the
38732 &_Local/eximon.conf_& file.
38733
38734
38735
38736
38737 .section "Main action buttons" "SECID266"
38738 .cindex "size" "of monitor window"
38739 .cindex "Exim monitor" "window size"
38740 .cindex "window size"
38741 Below the stripcharts there is an action button for quitting the monitor. Next
38742 to this is another button marked &"Size"&. They are placed here so that
38743 shrinking the window to its default minimum size leaves just the queue count
38744 stripchart and these two buttons visible. Pressing the &"Size"& button causes
38745 the window to expand to its maximum size, unless it is already at the maximum,
38746 in which case it is reduced to its minimum.
38747
38748 When expanding to the maximum, if the window cannot be fully seen where it
38749 currently is, it is moved back to where it was the last time it was at full
38750 size. When it is expanding from its minimum size, the old position is
38751 remembered, and next time it is reduced to the minimum it is moved back there.
38752
38753 The idea is that you can keep a reduced window just showing one or two
38754 stripcharts at a convenient place on your screen, easily expand it to show
38755 the full window when required, and just as easily put it back to what it was.
38756 The idea is copied from what the &'twm'& window manager does for its
38757 &'f.fullzoom'& action. The minimum size of the window can be changed by setting
38758 the MIN_HEIGHT and MIN_WIDTH values in &_Local/eximon.conf_&.
38759
38760 Normally, the monitor starts up with the window at its full size, but it can be
38761 built so that it starts up with the window at its smallest size, by setting
38762 START_SMALL=yes in &_Local/eximon.conf_&.
38763
38764
38765
38766 .section "The log display" "SECID267"
38767 .cindex "log" "tail of; in monitor"
38768 The second section of the window is an area in which a display of the tail of
38769 the main log is maintained.
38770 To save space on the screen, the timestamp on each log line is shortened by
38771 removing the date and, if &%log_timezone%& is set, the timezone.
38772 The log tail is not available when the only destination for logging data is
38773 syslog, unless the syslog lines are routed to a local file whose name is passed
38774 to &'eximon'& via the EXIMON_LOG_FILE_PATH environment variable.
38775
38776 The log sub-window has a scroll bar at its lefthand side which can be used to
38777 move back to look at earlier text, and the up and down arrow keys also have a
38778 scrolling effect. The amount of log that is kept depends on the setting of
38779 LOG_BUFFER in &_Local/eximon.conf_&, which specifies the amount of memory
38780 to use. When this is full, the earlier 50% of data is discarded &-- this is
38781 much more efficient than throwing it away line by line. The sub-window also has
38782 a horizontal scroll bar for accessing the ends of long log lines. This is the
38783 only means of horizontal scrolling; the right and left arrow keys are not
38784 available. Text can be cut from this part of the window using the mouse in the
38785 normal way. The size of this subwindow is controlled by parameters in the
38786 configuration file &_Local/eximon.conf_&.
38787
38788 Searches of the text in the log window can be carried out by means of the ^R
38789 and ^S keystrokes, which default to a reverse and a forward search,
38790 respectively. The search covers only the text that is displayed in the window.
38791 It cannot go further back up the log.
38792
38793 The point from which the search starts is indicated by a caret marker. This is
38794 normally at the end of the text in the window, but can be positioned explicitly
38795 by pointing and clicking with the left mouse button, and is moved automatically
38796 by a successful search. If new text arrives in the window when it is scrolled
38797 back, the caret remains where it is, but if the window is not scrolled back,
38798 the caret is moved to the end of the new text.
38799
38800 Pressing ^R or ^S pops up a window into which the search text can be typed.
38801 There are buttons for selecting forward or reverse searching, for carrying out
38802 the search, and for cancelling. If the &"Search"& button is pressed, the search
38803 happens and the window remains so that further searches can be done. If the
38804 &"Return"& key is pressed, a single search is done and the window is closed. If
38805 ^C is typed the search is cancelled.
38806
38807 The searching facility is implemented using the facilities of the Athena text
38808 widget. By default this pops up a window containing both &"search"& and
38809 &"replace"& options. In order to suppress the unwanted &"replace"& portion for
38810 eximon, a modified version of the &%TextPop%& widget is distributed with Exim.
38811 However, the linkers in BSDI and HP-UX seem unable to handle an externally
38812 provided version of &%TextPop%& when the remaining parts of the text widget
38813 come from the standard libraries. The compile-time option EXIMON_TEXTPOP can be
38814 unset to cut out the modified &%TextPop%&, making it possible to build Eximon
38815 on these systems, at the expense of having unwanted items in the search popup
38816 window.
38817
38818
38819
38820 .section "The queue display" "SECID268"
38821 .cindex "queue" "display in monitor"
38822 The bottom section of the monitor window contains a list of all messages that
38823 are in the queue, which includes those currently being received or delivered,
38824 as well as those awaiting delivery. The size of this subwindow is controlled by
38825 parameters in the configuration file &_Local/eximon.conf_&, and the frequency
38826 at which it is updated is controlled by another parameter in the same file &--
38827 the default is 5 minutes, since queue scans can be quite expensive. However,
38828 there is an &"Update"& action button just above the display which can be used
38829 to force an update of the queue display at any time.
38830
38831 When a host is down for some time, a lot of pending mail can build up for it,
38832 and this can make it hard to deal with other messages in the queue. To help
38833 with this situation there is a button next to &"Update"& called &"Hide"&. If
38834 pressed, a dialogue box called &"Hide addresses ending with"& is put up. If you
38835 type anything in here and press &"Return"&, the text is added to a chain of
38836 such texts, and if every undelivered address in a message matches at least one
38837 of the texts, the message is not displayed.
38838
38839 If there is an address that does not match any of the texts, all the addresses
38840 are displayed as normal. The matching happens on the ends of addresses so, for
38841 example, &'cam.ac.uk'& specifies all addresses in Cambridge, while
38842 &'xxx@foo.com.example'& specifies just one specific address. When any hiding
38843 has been set up, a button called &"Unhide"& is displayed. If pressed, it
38844 cancels all hiding. Also, to ensure that hidden messages do not get forgotten,
38845 a hide request is automatically cancelled after one hour.
38846
38847 While the dialogue box is displayed, you can't press any buttons or do anything
38848 else to the monitor window. For this reason, if you want to cut text from the
38849 queue display to use in the dialogue box, you have to do the cutting before
38850 pressing the &"Hide"& button.
38851
38852 The queue display contains, for each unhidden queued message, the length of
38853 time it has been in the queue, the size of the message, the message id, the
38854 message sender, and the first undelivered recipient, all on one line. If it is
38855 a bounce message, the sender is shown as &"<>"&. If there is more than one
38856 recipient to which the message has not yet been delivered, subsequent ones are
38857 listed on additional lines, up to a maximum configured number, following which
38858 an ellipsis is displayed. Recipients that have already received the message are
38859 not shown.
38860
38861 .cindex "frozen messages" "display"
38862 If a message is frozen, an asterisk is displayed at the left-hand side.
38863
38864 The queue display has a vertical scroll bar, and can also be scrolled by means
38865 of the arrow keys. Text can be cut from it using the mouse in the normal way.
38866 The text searching facilities, as described above for the log window, are also
38867 available, but the caret is always moved to the end of the text when the queue
38868 display is updated.
38869
38870
38871
38872 .section "The queue menu" "SECID269"
38873 .cindex "queue" "menu in monitor"
38874 If the &%shift%& key is held down and the left button is clicked when the mouse
38875 pointer is over the text for any message, an action menu pops up, and the first
38876 line of the queue display for the message is highlighted. This does not affect
38877 any selected text.
38878
38879 If you want to use some other event for popping up the menu, you can set the
38880 MENU_EVENT parameter in &_Local/eximon.conf_& to change the default, or
38881 set EXIMON_MENU_EVENT in the environment before starting the monitor. The
38882 value set in this parameter is a standard X event description. For example, to
38883 run eximon using &%ctrl%& rather than &%shift%& you could use
38884 .code
38885 EXIMON_MENU_EVENT='Ctrl<Btn1Down>' eximon
38886 .endd
38887 The title of the menu is the message id, and it contains entries which act as
38888 follows:
38889
38890 .ilist
38891 &'message log'&: The contents of the message log for the message are displayed
38892 in a new text window.
38893 .next
38894 &'headers'&: Information from the spool file that contains the envelope
38895 information and headers is displayed in a new text window. See chapter
38896 &<<CHAPspool>>& for a description of the format of spool files.
38897 .next
38898 &'body'&: The contents of the spool file containing the body of the message are
38899 displayed in a new text window. There is a default limit of 20,000 bytes to the
38900 amount of data displayed. This can be changed by setting the BODY_MAX
38901 option at compile time, or the EXIMON_BODY_MAX option at runtime.
38902 .next
38903 &'deliver message'&: A call to Exim is made using the &%-M%& option to request
38904 delivery of the message. This causes an automatic thaw if the message is
38905 frozen. The &%-v%& option is also set, and the output from Exim is displayed in
38906 a new text window. The delivery is run in a separate process, to avoid holding
38907 up the monitor while the delivery proceeds.
38908 .next
38909 &'freeze message'&: A call to Exim is made using the &%-Mf%& option to request
38910 that the message be frozen.
38911 .next
38912 .cindex "thawing messages"
38913 .cindex "unfreezing messages"
38914 .cindex "frozen messages" "thawing"
38915 &'thaw message'&: A call to Exim is made using the &%-Mt%& option to request
38916 that the message be thawed.
38917 .next
38918 .cindex "delivery" "forcing failure"
38919 &'give up on msg'&: A call to Exim is made using the &%-Mg%& option to request
38920 that Exim gives up trying to deliver the message. A bounce message is generated
38921 for any remaining undelivered addresses.
38922 .next
38923 &'remove message'&: A call to Exim is made using the &%-Mrm%& option to request
38924 that the message be deleted from the system without generating a bounce
38925 message.
38926 .next
38927 &'add recipient'&: A dialog box is displayed into which a recipient address can
38928 be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
38929 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
38930 Otherwise it must be entered as a fully qualified address. Pressing RETURN
38931 causes a call to Exim to be made using the &%-Mar%& option to request that an
38932 additional recipient be added to the message, unless the entry box is empty, in
38933 which case no action is taken.
38934 .next
38935 &'mark delivered'&: A dialog box is displayed into which a recipient address
38936 can be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
38937 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
38938 Otherwise it must be entered as a fully qualified address. Pressing RETURN
38939 causes a call to Exim to be made using the &%-Mmd%& option to mark the given
38940 recipient address as already delivered, unless the entry box is empty, in which
38941 case no action is taken.
38942 .next
38943 &'mark all delivered'&: A call to Exim is made using the &%-Mmad%& option to
38944 mark all recipient addresses as already delivered.
38945 .next
38946 &'edit sender'&: A dialog box is displayed initialized with the current
38947 sender's address. Pressing RETURN causes a call to Exim to be made using the
38948 &%-Mes%& option to replace the sender address, unless the entry box is empty,
38949 in which case no action is taken. If you want to set an empty sender (as in
38950 bounce messages), you must specify it as &"<>"&. Otherwise, if the address is
38951 not qualified and the QUALIFY_DOMAIN parameter is set in &_Local/eximon.conf_&,
38952 the address is qualified with that domain.
38953 .endlist
38954
38955 When a delivery is forced, a window showing the &%-v%& output is displayed. In
38956 other cases when a call to Exim is made, if there is any output from Exim (in
38957 particular, if the command fails) a window containing the command and the
38958 output is displayed. Otherwise, the results of the action are normally apparent
38959 from the log and queue displays. However, if you set ACTION_OUTPUT=yes in
38960 &_Local/eximon.conf_&, a window showing the Exim command is always opened, even
38961 if no output is generated.
38962
38963 The queue display is automatically updated for actions such as freezing and
38964 thawing, unless ACTION_QUEUE_UPDATE=no has been set in
38965 &_Local/eximon.conf_&. In this case the &"Update"& button has to be used to
38966 force an update of the display after one of these actions.
38967
38968 In any text window that is displayed as result of a menu action, the normal
38969 cut-and-paste facility is available, and searching can be carried out using ^R
38970 and ^S, as described above for the log tail window.
38971 .ecindex IIDeximon
38972
38973
38974
38975
38976
38977 . ////////////////////////////////////////////////////////////////////////////
38978 . ////////////////////////////////////////////////////////////////////////////
38979
38980 .chapter "Security considerations" "CHAPsecurity"
38981 .scindex IIDsecurcon "security" "discussion of"
38982 This chapter discusses a number of issues concerned with security, some of
38983 which are also covered in other parts of this manual.
38984
38985 For reasons that this author does not understand, some people have promoted
38986 Exim as a &"particularly secure"& mailer. Perhaps it is because of the
38987 existence of this chapter in the documentation. However, the intent of the
38988 chapter is simply to describe the way Exim works in relation to certain
38989 security concerns, not to make any specific claims about the effectiveness of
38990 its security as compared with other MTAs.
38991
38992 What follows is a description of the way Exim is supposed to be. Best efforts
38993 have been made to try to ensure that the code agrees with the theory, but an
38994 absence of bugs can never be guaranteed. Any that are reported will get fixed
38995 as soon as possible.
38996
38997
38998 .section "Building a more &""hardened""& Exim" "SECID286"
38999 .cindex "security" "build-time features"
39000 There are a number of build-time options that can be set in &_Local/Makefile_&
39001 to create Exim binaries that are &"harder"& to attack, in particular by a rogue
39002 Exim administrator who does not have the root password, or by someone who has
39003 penetrated the Exim (but not the root) account. These options are as follows:
39004
39005 .ilist
39006 ALT_CONFIG_PREFIX can be set to a string that is required to match the
39007 start of any filenames used with the &%-C%& option. When it is set, these
39008 filenames are also not allowed to contain the sequence &"/../"&. (However, if
39009 the value of the &%-C%& option is identical to the value of CONFIGURE_FILE in
39010 &_Local/Makefile_&, Exim ignores &%-C%& and proceeds as usual.) There is no
39011 default setting for &%ALT_CONFIG_PREFIX%&.
39012
39013 If the permitted configuration files are confined to a directory to
39014 which only root has access, this guards against someone who has broken
39015 into the Exim account from running a privileged Exim with an arbitrary
39016 configuration file, and using it to break into other accounts.
39017 .next
39018
39019 If a non-trusted configuration file (i.e. not the default configuration file
39020 or one which is trusted by virtue of being listed in the TRUSTED_CONFIG_LIST
39021 file) is specified with &%-C%&, or if macros are given with &%-D%& (but see
39022 the next item), then root privilege is retained only if the caller of Exim is
39023 root. This locks out the possibility of testing a configuration using &%-C%&
39024 right through message reception and delivery, even if the caller is root. The
39025 reception works, but by that time, Exim is running as the Exim user, so when
39026 it re-execs to regain privilege for the delivery, the use of &%-C%& causes
39027 privilege to be lost. However, root can test reception and delivery using two
39028 separate commands.
39029
39030 .next
39031 The WHITELIST_D_MACROS build option declares some macros to be safe to override
39032 with &%-D%& if the real uid is one of root, the Exim run-time user or the
39033 CONFIGURE_OWNER, if defined.  The potential impact of this option is limited by
39034 requiring the run-time value supplied to &%-D%& to match a regex that errs on
39035 the restrictive side.  Requiring build-time selection of safe macros is onerous
39036 but this option is intended solely as a transition mechanism to permit
39037 previously-working configurations to continue to work after release 4.73.
39038 .next
39039 If DISABLE_D_OPTION is defined, the use of the &%-D%& command line option
39040 is disabled.
39041 .next
39042 FIXED_NEVER_USERS can be set to a colon-separated list of users that are
39043 never to be used for any deliveries. This is like the &%never_users%& runtime
39044 option, but it cannot be overridden; the runtime option adds additional users
39045 to the list. The default setting is &"root"&; this prevents a non-root user who
39046 is permitted to modify the runtime file from using Exim as a way to get root.
39047 .endlist
39048
39049
39050
39051 .section "Root privilege" "SECID270"
39052 .cindex "setuid"
39053 .cindex "root privilege"
39054 The Exim binary is normally setuid to root, which means that it gains root
39055 privilege (runs as root) when it starts execution. In some special cases (for
39056 example, when the daemon is not in use and there are no local deliveries), it
39057 may be possible to run Exim setuid to some user other than root. This is
39058 discussed in the next section. However, in most installations, root privilege
39059 is required for two things:
39060
39061 .ilist
39062 To set up a socket connected to the standard SMTP port (25) when initialising
39063 the listening daemon. If Exim is run from &'inetd'&, this privileged action is
39064 not required.
39065 .next
39066 To be able to change uid and gid in order to read users' &_.forward_& files and
39067 perform local deliveries as the receiving user or as specified in the
39068 configuration.
39069 .endlist
39070
39071 It is not necessary to be root to do any of the other things Exim does, such as
39072 receiving messages and delivering them externally over SMTP, and it is
39073 obviously more secure if Exim does not run as root except when necessary.
39074 For this reason, a user and group for Exim to use must be defined in
39075 &_Local/Makefile_&. These are known as &"the Exim user"& and &"the Exim
39076 group"&. Their values can be changed by the runtime configuration, though this
39077 is not recommended. Often a user called &'exim'& is used, but some sites use
39078 &'mail'& or another user name altogether.
39079
39080 Exim uses &[setuid()]& whenever it gives up root privilege. This is a permanent
39081 abdication; the process cannot regain root afterwards. Prior to release 4.00,
39082 &[seteuid()]& was used in some circumstances, but this is no longer the case.
39083
39084 After a new Exim process has interpreted its command line options, it changes
39085 uid and gid in the following cases:
39086
39087 .ilist
39088 .oindex "&%-C%&"
39089 .oindex "&%-D%&"
39090 If the &%-C%& option is used to specify an alternate configuration file, or if
39091 the &%-D%& option is used to define macro values for the configuration, and the
39092 calling process is not running as root, the uid and gid are changed to those of
39093 the calling process.
39094 However, if DISABLE_D_OPTION is defined in &_Local/Makefile_&, the &%-D%&
39095 option may not be used at all.
39096 If WHITELIST_D_MACROS is defined in &_Local/Makefile_&, then some macro values
39097 can be supplied if the calling process is running as root, the Exim run-time
39098 user or CONFIGURE_OWNER, if defined.
39099 .next
39100 .oindex "&%-be%&"
39101 .oindex "&%-bf%&"
39102 .oindex "&%-bF%&"
39103 If the expansion test option (&%-be%&) or one of the filter testing options
39104 (&%-bf%& or &%-bF%&) are used, the uid and gid are changed to those of the
39105 calling process.
39106 .next
39107 If the process is not a daemon process or a queue runner process or a delivery
39108 process or a process for testing address routing (started with &%-bt%&), the
39109 uid and gid are changed to the Exim user and group. This means that Exim always
39110 runs under its own uid and gid when receiving messages. This also applies when
39111 testing address verification
39112 .oindex "&%-bv%&"
39113 .oindex "&%-bh%&"
39114 (the &%-bv%& option) and testing incoming message policy controls (the &%-bh%&
39115 option).
39116 .next
39117 For a daemon, queue runner, delivery, or address testing process, the uid
39118 remains as root at this stage, but the gid is changed to the Exim group.
39119 .endlist
39120
39121 The processes that initially retain root privilege behave as follows:
39122
39123 .ilist
39124 A daemon process changes the gid to the Exim group and the uid to the Exim
39125 user after setting up one or more listening sockets. The &[initgroups()]&
39126 function is called, so that if the Exim user is in any additional groups, they
39127 will be used during message reception.
39128 .next
39129 A queue runner process retains root privilege throughout its execution. Its
39130 job is to fork a controlled sequence of delivery processes.
39131 .next
39132 A delivery process retains root privilege throughout most of its execution,
39133 but any actual deliveries (that is, the transports themselves) are run in
39134 subprocesses which always change to a non-root uid and gid. For local
39135 deliveries this is typically the uid and gid of the owner of the mailbox; for
39136 remote deliveries, the Exim uid and gid are used. Once all the delivery
39137 subprocesses have been run, a delivery process changes to the Exim uid and gid
39138 while doing post-delivery tidying up such as updating the retry database and
39139 generating bounce and warning messages.
39140
39141 While the recipient addresses in a message are being routed, the delivery
39142 process runs as root. However, if a user's filter file has to be processed,
39143 this is done in a subprocess that runs under the individual user's uid and
39144 gid. A system filter is run as root unless &%system_filter_user%& is set.
39145 .next
39146 A process that is testing addresses (the &%-bt%& option) runs as root so that
39147 the routing is done in the same environment as a message delivery.
39148 .endlist
39149
39150
39151
39152
39153 .section "Running Exim without privilege" "SECTrunexiwitpri"
39154 .cindex "privilege, running without"
39155 .cindex "unprivileged running"
39156 .cindex "root privilege" "running without"
39157 Some installations like to run Exim in an unprivileged state for more of its
39158 operation, for added security. Support for this mode of operation is provided
39159 by the global option &%deliver_drop_privilege%&. When this is set, the uid and
39160 gid are changed to the Exim user and group at the start of a delivery process
39161 (and also queue runner and address testing processes). This means that address
39162 routing is no longer run as root, and the deliveries themselves cannot change
39163 to any other uid.
39164
39165 .cindex SIGHUP
39166 .cindex "daemon" "restarting"
39167 Leaving the binary setuid to root, but setting &%deliver_drop_privilege%& means
39168 that the daemon can still be started in the usual way, and it can respond
39169 correctly to SIGHUP because the re-invocation regains root privilege.
39170
39171 An alternative approach is to make Exim setuid to the Exim user and also setgid
39172 to the Exim group. If you do this, the daemon must be started from a root
39173 process. (Calling Exim from a root process makes it behave in the way it does
39174 when it is setuid root.) However, the daemon cannot restart itself after a
39175 SIGHUP signal because it cannot regain privilege.
39176
39177 It is still useful to set &%deliver_drop_privilege%& in this case, because it
39178 stops Exim from trying to re-invoke itself to do a delivery after a message has
39179 been received. Such a re-invocation is a waste of resources because it has no
39180 effect.
39181
39182 If restarting the daemon is not an issue (for example, if &%mua_wrapper%& is
39183 set, or &'inetd'& is being used instead of a daemon), having the binary setuid
39184 to the Exim user seems a clean approach, but there is one complication:
39185
39186 In this style of operation, Exim is running with the real uid and gid set to
39187 those of the calling process, and the effective uid/gid set to Exim's values.
39188 Ideally, any association with the calling process' uid/gid should be dropped,
39189 that is, the real uid/gid should be reset to the effective values so as to
39190 discard any privileges that the caller may have. While some operating systems
39191 have a function that permits this action for a non-root effective uid, quite a
39192 number of them do not. Because of this lack of standardization, Exim does not
39193 address this problem at this time.
39194
39195 For this reason, the recommended approach for &"mostly unprivileged"& running
39196 is to keep the Exim binary setuid to root, and to set
39197 &%deliver_drop_privilege%&. This also has the advantage of allowing a daemon to
39198 be used in the most straightforward way.
39199
39200 If you configure Exim not to run delivery processes as root, there are a
39201 number of restrictions on what you can do:
39202
39203 .ilist
39204 You can deliver only as the Exim user/group. You should  explicitly use the
39205 &%user%& and &%group%& options to override routers or local transports that
39206 normally deliver as the recipient. This makes sure that configurations that
39207 work in this mode function the same way in normal mode. Any implicit or
39208 explicit specification of another user causes an error.
39209 .next
39210 Use of &_.forward_& files is severely restricted, such that it is usually
39211 not worthwhile to include them in the configuration.
39212 .next
39213 Users who wish to use &_.forward_& would have to make their home directory and
39214 the file itself accessible to the Exim user. Pipe and append-to-file entries,
39215 and their equivalents in Exim filters, cannot be used. While they could be
39216 enabled in the Exim user's name, that would be insecure and not very useful.
39217 .next
39218 Unless the local user mailboxes are all owned by the Exim user (possible in
39219 some POP3 or IMAP-only environments):
39220
39221 .olist
39222 They must be owned by the Exim group and be writeable by that group. This
39223 implies you must set &%mode%& in the appendfile configuration, as well as the
39224 mode of the mailbox files themselves.
39225 .next
39226 You must set &%no_check_owner%&, since most or all of the files will not be
39227 owned by the Exim user.
39228 .next
39229 You must set &%file_must_exist%&, because Exim cannot set the owner correctly
39230 on a newly created mailbox when unprivileged. This also implies that new
39231 mailboxes need to be created manually.
39232 .endlist olist
39233 .endlist ilist
39234
39235
39236 These restrictions severely restrict what can be done in local deliveries.
39237 However, there are no restrictions on remote deliveries. If you are running a
39238 gateway host that does no local deliveries, setting &%deliver_drop_privilege%&
39239 gives more security at essentially no cost.
39240
39241 If you are using the &%mua_wrapper%& facility (see chapter
39242 &<<CHAPnonqueueing>>&), &%deliver_drop_privilege%& is forced to be true.
39243
39244
39245
39246
39247 .section "Delivering to local files" "SECID271"
39248 Full details of the checks applied by &(appendfile)& before it writes to a file
39249 are given in chapter &<<CHAPappendfile>>&.
39250
39251
39252
39253 .section "Running local commands" "SECTsecconslocalcmds"
39254 .cindex "security" "local commands"
39255 .cindex "security" "command injection attacks"
39256 There are a number of ways in which an administrator can configure Exim to run
39257 commands based upon received, untrustworthy, data. Further, in some
39258 configurations a user who can control a &_.forward_& file can also arrange to
39259 run commands. Configuration to check includes, but is not limited to:
39260
39261 .ilist
39262 Use of &%use_shell%& in the pipe transport: various forms of shell command
39263 injection may be possible with this option present. It is dangerous and should
39264 be used only with considerable caution. Consider constraints which whitelist
39265 allowed characters in a variable which is to be used in a pipe transport that
39266 has &%use_shell%& enabled.
39267 .next
39268 A number of options such as &%forbid_filter_run%&, &%forbid_filter_perl%&,
39269 &%forbid_filter_dlfunc%& and so forth which restrict facilities available to
39270 &_.forward_& files in a redirect router. If Exim is running on a central mail
39271 hub to which ordinary users do not have shell access, but home directories are
39272 NFS mounted (for instance) then administrators should review the list of these
39273 forbid options available, and should bear in mind that the options that may
39274 need forbidding can change as new features are added between releases.
39275 .next
39276 The &%${run...}%& expansion item does not use a shell by default, but
39277 administrators can configure use of &_/bin/sh_& as part of the command.
39278 Such invocations should be viewed with prejudicial suspicion.
39279 .next
39280 Administrators who use embedded Perl are advised to explore how Perl's
39281 taint checking might apply to their usage.
39282 .next
39283 Use of &%${expand...}%& is somewhat analogous to shell's eval builtin and
39284 administrators are well advised to view its use with suspicion, in case (for
39285 instance) it allows a local-part to contain embedded Exim directives.
39286 .next
39287 Use of &%${match_local_part...}%& and friends becomes more dangerous if
39288 Exim was built with EXPAND_LISTMATCH_RHS defined: the second string in
39289 each can reference arbitrary lists and files, rather than just being a list
39290 of opaque strings.
39291 The EXPAND_LISTMATCH_RHS option was added and set false by default because of
39292 real-world security vulnerabilities caused by its use with untrustworthy data
39293 injected in, for SQL injection attacks.
39294 Consider the use of the &%inlisti%& expansion condition instead.
39295 .endlist
39296
39297
39298
39299
39300 .section "Trust in configuration data" "SECTsecconfdata"
39301 .cindex "security" "data sources"
39302 .cindex "security" "regular expressions"
39303 .cindex "regular expressions" "security"
39304 .cindex "PCRE" "security"
39305 If configuration data for Exim can come from untrustworthy sources, there
39306 are some issues to be aware of:
39307
39308 .ilist
39309 Use of &%${expand...}%& may provide a path for shell injection attacks.
39310 .next
39311 Letting untrusted data provide a regular expression is unwise.
39312 .next
39313 Using &%${match...}%& to apply a fixed regular expression against untrusted
39314 data may result in pathological behaviour within PCRE.  Be aware of what
39315 "backtracking" means and consider options for being more strict with a regular
39316 expression. Avenues to explore include limiting what can match (avoiding &`.`&
39317 when &`[a-z0-9]`& or other character class will do), use of atomic grouping and
39318 possessive quantifiers or just not using regular expressions against untrusted
39319 data.
39320 .next
39321 It can be important to correctly use &%${quote:...}%&,
39322 &%${quote_local_part:...}%& and &%${quote_%&<&'lookup-type'&>&%:...}%& expansion
39323 items to ensure that data is correctly constructed.
39324 .next
39325 Some lookups might return multiple results, even though normal usage is only
39326 expected to yield one result.
39327 .endlist
39328
39329
39330
39331
39332 .section "IPv4 source routing" "SECID272"
39333 .cindex "source routing" "in IP packets"
39334 .cindex "IP source routing"
39335 Many operating systems suppress IP source-routed packets in the kernel, but
39336 some cannot be made to do this, so Exim does its own check. It logs incoming
39337 IPv4 source-routed TCP calls, and then drops them. Things are all different in
39338 IPv6. No special checking is currently done.
39339
39340
39341
39342 .section "The VRFY, EXPN, and ETRN commands in SMTP" "SECID273"
39343 Support for these SMTP commands is disabled by default. If required, they can
39344 be enabled by defining suitable ACLs.
39345
39346
39347
39348
39349 .section "Privileged users" "SECID274"
39350 .cindex "trusted users"
39351 .cindex "admin user"
39352 .cindex "privileged user"
39353 .cindex "user" "trusted"
39354 .cindex "user" "admin"
39355 Exim recognizes two sets of users with special privileges. Trusted users are
39356 able to submit new messages to Exim locally, but supply their own sender
39357 addresses and information about a sending host. For other users submitting
39358 local messages, Exim sets up the sender address from the uid, and doesn't
39359 permit a remote host to be specified.
39360
39361 .oindex "&%-f%&"
39362 However, an untrusted user is permitted to use the &%-f%& command line option
39363 in the special form &%-f <>%& to indicate that a delivery failure for the
39364 message should not cause an error report. This affects the message's envelope,
39365 but it does not affect the &'Sender:'& header. Untrusted users may also be
39366 permitted to use specific forms of address with the &%-f%& option by setting
39367 the &%untrusted_set_sender%& option.
39368
39369 Trusted users are used to run processes that receive mail messages from some
39370 other mail domain and pass them on to Exim for delivery either locally, or over
39371 the Internet. Exim trusts a caller that is running as root, as the Exim user,
39372 as any user listed in the &%trusted_users%& configuration option, or under any
39373 group listed in the &%trusted_groups%& option.
39374
39375 Admin users are permitted to do things to the messages on Exim's queue. They
39376 can freeze or thaw messages, cause them to be returned to their senders, remove
39377 them entirely, or modify them in various ways. In addition, admin users can run
39378 the Exim monitor and see all the information it is capable of providing, which
39379 includes the contents of files on the spool.
39380
39381 .oindex "&%-M%&"
39382 .oindex "&%-q%&"
39383 By default, the use of the &%-M%& and &%-q%& options to cause Exim to attempt
39384 delivery of messages on its queue is restricted to admin users. This
39385 restriction can be relaxed by setting the &%no_prod_requires_admin%& option.
39386 Similarly, the use of &%-bp%& (and its variants) to list the contents of the
39387 queue is also restricted to admin users. This restriction can be relaxed by
39388 setting &%no_queue_list_requires_admin%&.
39389
39390 Exim recognizes an admin user if the calling process is running as root or as
39391 the Exim user or if any of the groups associated with the calling process is
39392 the Exim group. It is not necessary actually to be running under the Exim
39393 group. However, if admin users who are not root or the Exim user are to access
39394 the contents of files on the spool via the Exim monitor (which runs
39395 unprivileged), Exim must be built to allow group read access to its spool
39396 files.
39397
39398 By default, regular users are trusted to perform basic testing and
39399 introspection commands, as themselves.  This setting can be tightened by
39400 setting the &%commandline_checks_require_admin%& option.
39401 This affects most of the checking options,
39402 such as &%-be%& and anything else &%-b*%&.
39403
39404
39405 .section "Spool files" "SECID275"
39406 .cindex "spool directory" "files"
39407 Exim's spool directory and everything it contains is owned by the Exim user and
39408 set to the Exim group. The mode for spool files is defined in the
39409 &_Local/Makefile_& configuration file, and defaults to 0640. This means that
39410 any user who is a member of the Exim group can access these files.
39411
39412
39413
39414 .section "Use of argv[0]" "SECID276"
39415 Exim examines the last component of &%argv[0]%&, and if it matches one of a set
39416 of specific strings, Exim assumes certain options. For example, calling Exim
39417 with the last component of &%argv[0]%& set to &"rsmtp"& is exactly equivalent
39418 to calling it with the option &%-bS%&. There are no security implications in
39419 this.
39420
39421
39422
39423 .section "Use of %f formatting" "SECID277"
39424 The only use made of &"%f"& by Exim is in formatting load average values. These
39425 are actually stored in integer variables as 1000 times the load average.
39426 Consequently, their range is limited and so therefore is the length of the
39427 converted output.
39428
39429
39430
39431 .section "Embedded Exim path" "SECID278"
39432 Exim uses its own path name, which is embedded in the code, only when it needs
39433 to re-exec in order to regain root privilege. Therefore, it is not root when it
39434 does so. If some bug allowed the path to get overwritten, it would lead to an
39435 arbitrary program's being run as exim, not as root.
39436
39437
39438
39439 .section "Dynamic module directory" "SECTdynmoddir"
39440 Any dynamically loadable modules must be installed into the directory
39441 defined in &`LOOKUP_MODULE_DIR`& in &_Local/Makefile_& for Exim to permit
39442 loading it.
39443
39444
39445 .section "Use of sprintf()" "SECID279"
39446 .cindex "&[sprintf()]&"
39447 A large number of occurrences of &"sprintf"& in the code are actually calls to
39448 &'string_sprintf()'&, a function that returns the result in malloc'd store.
39449 The intermediate formatting is done into a large fixed buffer by a function
39450 that runs through the format string itself, and checks the length of each
39451 conversion before performing it, thus preventing buffer overruns.
39452
39453 The remaining uses of &[sprintf()]& happen in controlled circumstances where
39454 the output buffer is known to be sufficiently long to contain the converted
39455 string.
39456
39457
39458
39459 .section "Use of debug_printf() and log_write()" "SECID280"
39460 Arbitrary strings are passed to both these functions, but they do their
39461 formatting by calling the function &'string_vformat()'&, which runs through
39462 the format string itself, and checks the length of each conversion.
39463
39464
39465
39466 .section "Use of strcat() and strcpy()" "SECID281"
39467 These are used only in cases where the output buffer is known to be large
39468 enough to hold the result.
39469 .ecindex IIDsecurcon
39470
39471
39472
39473
39474 . ////////////////////////////////////////////////////////////////////////////
39475 . ////////////////////////////////////////////////////////////////////////////
39476
39477 .chapter "Format of spool files" "CHAPspool"
39478 .scindex IIDforspo1 "format" "spool files"
39479 .scindex IIDforspo2 "spool directory" "format of files"
39480 .scindex IIDforspo3 "spool files" "format of"
39481 .cindex "spool files" "editing"
39482 A message on Exim's queue consists of two files, whose names are the message id
39483 followed by -D and -H, respectively. The data portion of the message is kept in
39484 the -D file on its own. The message's envelope, status, and headers are all
39485 kept in the -H file, whose format is described in this chapter. Each of these
39486 two files contains the final component of its own name as its first line. This
39487 is insurance against disk crashes where the directory is lost but the files
39488 themselves are recoverable.
39489
39490 The file formats may be changed, or new formats added, at any release.
39491 Spool files are not intended as an interface to other programs
39492 and should not be used as such.
39493
39494 Some people are tempted into editing -D files in order to modify messages. You
39495 need to be extremely careful if you do this; it is not recommended and you are
39496 on your own if you do it. Here are some of the pitfalls:
39497
39498 .ilist
39499 You must ensure that Exim does not try to deliver the message while you are
39500 fiddling with it. The safest way is to take out a write lock on the -D file,
39501 which is what Exim itself does, using &[fcntl()]&. If you update the file in
39502 place, the lock will be retained. If you write a new file and rename it, the
39503 lock will be lost at the instant of rename.
39504 .next
39505 .vindex "&$body_linecount$&"
39506 If you change the number of lines in the file, the value of
39507 &$body_linecount$&, which is stored in the -H file, will be incorrect and can
39508 cause incomplete transmission of messages or undeliverable messages.
39509 .next
39510 If the message is in MIME format, you must take care not to break it.
39511 .next
39512 If the message is cryptographically signed, any change will invalidate the
39513 signature.
39514 .endlist
39515 All in all, modifying -D files is fraught with danger.
39516
39517 Files whose names end with -J may also be seen in the &_input_& directory (or
39518 its subdirectories when &%split_spool_directory%& is set). These are journal
39519 files, used to record addresses to which the message has been delivered during
39520 the course of a delivery attempt. If there are still undelivered recipients at
39521 the end, the -H file is updated, and the -J file is deleted. If, however, there
39522 is some kind of crash (for example, a power outage) before this happens, the -J
39523 file remains in existence. When Exim next processes the message, it notices the
39524 -J file and uses it to update the -H file before starting the next delivery
39525 attempt.
39526
39527 Files whose names end with -K or .eml may also be seen in the spool.
39528 These are temporaries used for DKIM or malware processing, when that is used.
39529 They should be tidied up by normal operations; any old ones are probably
39530 relics of crashes and can be removed.
39531
39532 .section "Format of the -H file" "SECID282"
39533 .cindex "uid (user id)" "in spool file"
39534 .cindex "gid (group id)" "in spool file"
39535 The second line of the -H file contains the login name for the uid of the
39536 process that called Exim to read the message, followed by the numerical uid and
39537 gid. For a locally generated message, this is normally the user who sent the
39538 message. For a message received over TCP/IP via the daemon, it is
39539 normally the Exim user.
39540
39541 The third line of the file contains the address of the message's sender as
39542 transmitted in the envelope, contained in angle brackets. The sender address is
39543 empty for bounce messages. For incoming SMTP mail, the sender address is given
39544 in the MAIL command. For locally generated mail, the sender address is
39545 created by Exim from the login name of the current user and the configured
39546 &%qualify_domain%&. However, this can be overridden by the &%-f%& option or a
39547 leading &"From&~"& line if the caller is trusted, or if the supplied address is
39548 &"<>"& or an address that matches &%untrusted_set_senders%&.
39549
39550 The fourth line contains two numbers. The first is the time that the message
39551 was received, in the conventional Unix form &-- the number of seconds since the
39552 start of the epoch. The second number is a count of the number of messages
39553 warning of delayed delivery that have been sent to the sender.
39554
39555 There follow a number of lines starting with a hyphen. These can appear in any
39556 order, and are omitted when not relevant:
39557
39558 .vlist
39559 .vitem "&%-acl%&&~<&'number'&>&~<&'length'&>"
39560 This item is obsolete, and is not generated from Exim release 4.61 onwards;
39561 &%-aclc%& and &%-aclm%& are used instead. However, &%-acl%& is still
39562 recognized, to provide backward compatibility. In the old format, a line of
39563 this form is present for every ACL variable that is not empty. The number
39564 identifies the variable; the &%acl_c%&&*x*& variables are numbered 0&--9 and
39565 the &%acl_m%&&*x*& variables are numbered 10&--19. The length is the length of
39566 the data string for the variable. The string itself starts at the beginning of
39567 the next line, and is followed by a newline character. It may contain internal
39568 newlines.
39569
39570 .vitem "&%-aclc%&&~<&'rest-of-name'&>&~<&'length'&>"
39571 A line of this form is present for every ACL connection variable that is
39572 defined. Note that there is a space between &%-aclc%& and the rest of the name.
39573 The length is the length of the data string for the variable. The string itself
39574 starts at the beginning of the next line, and is followed by a newline
39575 character. It may contain internal newlines.
39576
39577 .vitem "&%-aclm%&&~<&'rest-of-name'&>&~<&'length'&>"
39578 A line of this form is present for every ACL message variable that is defined.
39579 Note that there is a space between &%-aclm%& and the rest of the name. The
39580 length is the length of the data string for the variable. The string itself
39581 starts at the beginning of the next line, and is followed by a newline
39582 character. It may contain internal newlines.
39583
39584 .vitem "&%-active_hostname%&&~<&'hostname'&>"
39585 This is present if, when the message was received over SMTP, the value of
39586 &$smtp_active_hostname$& was different to the value of &$primary_hostname$&.
39587
39588 .vitem &%-allow_unqualified_recipient%&
39589 This is present if unqualified recipient addresses are permitted in header
39590 lines (to stop such addresses from being qualified if rewriting occurs at
39591 transport time). Local messages that were input using &%-bnq%& and remote
39592 messages from hosts that match &%recipient_unqualified_hosts%& set this flag.
39593
39594 .vitem &%-allow_unqualified_sender%&
39595 This is present if unqualified sender addresses are permitted in header lines
39596 (to stop such addresses from being qualified if rewriting occurs at transport
39597 time). Local messages that were input using &%-bnq%& and remote messages from
39598 hosts that match &%sender_unqualified_hosts%& set this flag.
39599
39600 .vitem "&%-auth_id%&&~<&'text'&>"
39601 The id information for a message received on an authenticated SMTP connection
39602 &-- the value of the &$authenticated_id$& variable.
39603
39604 .vitem "&%-auth_sender%&&~<&'address'&>"
39605 The address of an authenticated sender &-- the value of the
39606 &$authenticated_sender$& variable.
39607
39608 .vitem "&%-body_linecount%&&~<&'number'&>"
39609 This records the number of lines in the body of the message, and is
39610 present unless &%-spool_file_wireformat%& is.
39611
39612 .vitem "&%-body_zerocount%&&~<&'number'&>"
39613 This records the number of binary zero bytes in the body of the message, and is
39614 present if the number is greater than zero.
39615
39616 .vitem &%-deliver_firsttime%&
39617 This is written when a new message is first added to the spool. When the spool
39618 file is updated after a deferral, it is omitted.
39619
39620 .vitem "&%-frozen%&&~<&'time'&>"
39621 .cindex "frozen messages" "spool data"
39622 The message is frozen, and the freezing happened at <&'time'&>.
39623
39624 .vitem "&%-helo_name%&&~<&'text'&>"
39625 This records the host name as specified by a remote host in a HELO or EHLO
39626 command.
39627
39628 .vitem "&%-host_address%&&~<&'address'&>.<&'port'&>"
39629 This records the IP address of the host from which the message was received and
39630 the remote port number that was used. It is omitted for locally generated
39631 messages.
39632
39633 .vitem "&%-host_auth%&&~<&'text'&>"
39634 If the message was received on an authenticated SMTP connection, this records
39635 the name of the authenticator &-- the value of the
39636 &$sender_host_authenticated$& variable.
39637
39638 .vitem &%-host_lookup_failed%&
39639 This is present if an attempt to look up the sending host's name from its IP
39640 address failed. It corresponds to the &$host_lookup_failed$& variable.
39641
39642 .vitem "&%-host_name%&&~<&'text'&>"
39643 .cindex "reverse DNS lookup"
39644 .cindex "DNS" "reverse lookup"
39645 This records the name of the remote host from which the message was received,
39646 if the host name was looked up from the IP address when the message was being
39647 received. It is not present if no reverse lookup was done.
39648
39649 .vitem "&%-ident%&&~<&'text'&>"
39650 For locally submitted messages, this records the login of the originating user,
39651 unless it was a trusted user and the &%-oMt%& option was used to specify an
39652 ident value. For messages received over TCP/IP, this records the ident string
39653 supplied by the remote host, if any.
39654
39655 .vitem "&%-interface_address%&&~<&'address'&>.<&'port'&>"
39656 This records the IP address of the local interface and the port number through
39657 which a message was received from a remote host. It is omitted for locally
39658 generated messages.
39659
39660 .vitem &%-local%&
39661 The message is from a local sender.
39662
39663 .vitem &%-localerror%&
39664 The message is a locally-generated bounce message.
39665
39666 .vitem "&%-local_scan%&&~<&'string'&>"
39667 This records the data string that was returned by the &[local_scan()]& function
39668 when the message was received &-- the value of the &$local_scan_data$&
39669 variable. It is omitted if no data was returned.
39670
39671 .vitem &%-manual_thaw%&
39672 The message was frozen but has been thawed manually, that is, by an explicit
39673 Exim command rather than via the auto-thaw process.
39674
39675 .vitem &%-N%&
39676 A testing delivery process was started using the &%-N%& option to suppress any
39677 actual deliveries, but delivery was deferred. At any further delivery attempts,
39678 &%-N%& is assumed.
39679
39680 .vitem &%-received_protocol%&
39681 This records the value of the &$received_protocol$& variable, which contains
39682 the name of the protocol by which the message was received.
39683
39684 .vitem &%-sender_set_untrusted%&
39685 The envelope sender of this message was set by an untrusted local caller (used
39686 to ensure that the caller is displayed in queue listings).
39687
39688 .vitem "&%-spam_score_int%&&~<&'number'&>"
39689 If a message was scanned by SpamAssassin, this is present. It records the value
39690 of &$spam_score_int$&.
39691
39692 .vitem &%-spool_file_wireformat%&
39693 The -D file for this message is in wire-format (for ESMTP CHUNKING)
39694 rather than Unix-format.
39695 The line-ending is CRLF rather than newline.
39696 There is still, however, no leading-dot-stuffing.
39697
39698 .vitem &%-tls_certificate_verified%&
39699 A TLS certificate was received from the client that sent this message, and the
39700 certificate was verified by the server.
39701
39702 .vitem "&%-tls_cipher%&&~<&'cipher name'&>"
39703 When the message was received over an encrypted connection, this records the
39704 name of the cipher suite that was used.
39705
39706 .vitem "&%-tls_peerdn%&&~<&'peer DN'&>"
39707 When the message was received over an encrypted connection, and a certificate
39708 was received from the client, this records the Distinguished Name from that
39709 certificate.
39710 .endlist
39711
39712 .new
39713 Any of the above may have an extra hyphen prepended, to indicate the the
39714 corresponding data is untrusted.
39715 .wen
39716
39717 Following the options there is a list of those addresses to which the message
39718 is not to be delivered. This set of addresses is initialized from the command
39719 line when the &%-t%& option is used and &%extract_addresses_remove_arguments%&
39720 is set; otherwise it starts out empty. Whenever a successful delivery is made,
39721 the address is added to this set. The addresses are kept internally as a
39722 balanced binary tree, and it is a representation of that tree which is written
39723 to the spool file. If an address is expanded via an alias or forward file, the
39724 original address is added to the tree when deliveries to all its child
39725 addresses are complete.
39726
39727 If the tree is empty, there is a single line in the spool file containing just
39728 the text &"XX"&. Otherwise, each line consists of two letters, which are either
39729 Y or N, followed by an address. The address is the value for the node of the
39730 tree, and the letters indicate whether the node has a left branch and/or a
39731 right branch attached to it, respectively. If branches exist, they immediately
39732 follow. Here is an example of a three-node tree:
39733 .code
39734 YY darcy@austen.fict.example
39735 NN alice@wonderland.fict.example
39736 NN editor@thesaurus.ref.example
39737 .endd
39738 After the non-recipients tree, there is a list of the message's recipients.
39739 This is a simple list, preceded by a count. It includes all the original
39740 recipients of the message, including those to whom the message has already been
39741 delivered. In the simplest case, the list contains one address per line. For
39742 example:
39743 .code
39744 4
39745 editor@thesaurus.ref.example
39746 darcy@austen.fict.example
39747 rdo@foundation
39748 alice@wonderland.fict.example
39749 .endd
39750 However, when a child address has been added to the top-level addresses as a
39751 result of the use of the &%one_time%& option on a &(redirect)& router, each
39752 line is of the following form:
39753 .display
39754 <&'top-level address'&> <&'errors_to address'&> &&&
39755   <&'length'&>,<&'parent number'&>#<&'flag bits'&>
39756 .endd
39757 The 01 flag bit indicates the presence of the three other fields that follow
39758 the top-level address. Other bits may be used in future to support additional
39759 fields. The <&'parent number'&> is the offset in the recipients list of the
39760 original parent of the &"one time"& address. The first two fields are the
39761 envelope sender that is associated with this address and its length. If the
39762 length is zero, there is no special envelope sender (there are then two space
39763 characters in the line). A non-empty field can arise from a &(redirect)& router
39764 that has an &%errors_to%& setting.
39765
39766
39767 A blank line separates the envelope and status information from the headers
39768 which follow. A header may occupy several lines of the file, and to save effort
39769 when reading it in, each header is preceded by a number and an identifying
39770 character. The number is the number of characters in the header, including any
39771 embedded newlines and the terminating newline. The character is one of the
39772 following:
39773
39774 .table2 50pt
39775 .row <&'blank'&>         "header in which Exim has no special interest"
39776 .row &`B`&               "&'Bcc:'& header"
39777 .row &`C`&               "&'Cc:'& header"
39778 .row &`F`&               "&'From:'& header"
39779 .row &`I`&               "&'Message-id:'& header"
39780 .row &`P`&               "&'Received:'& header &-- P for &""postmark""&"
39781 .row &`R`&               "&'Reply-To:'& header"
39782 .row &`S`&               "&'Sender:'& header"
39783 .row &`T`&               "&'To:'& header"
39784 .row &`*`&               "replaced or deleted header"
39785 .endtable
39786
39787 Deleted or replaced (rewritten) headers remain in the spool file for debugging
39788 purposes. They are not transmitted when the message is delivered. Here is a
39789 typical set of headers:
39790 .code
39791 111P Received: by hobbit.fict.example with local (Exim 4.00)
39792 id 14y9EI-00026G-00; Fri, 11 May 2001 10:28:59 +0100
39793 049  Message-Id: <E14y9EI-00026G-00@hobbit.fict.example>
39794 038* X-rewrote-sender: bb@hobbit.fict.example
39795 042* From: Bilbo Baggins <bb@hobbit.fict.example>
39796 049F From: Bilbo Baggins <B.Baggins@hobbit.fict.example>
39797 099* To: alice@wonderland.fict.example, rdo@foundation,
39798 darcy@austen.fict.example, editor@thesaurus.ref.example
39799 104T To: alice@wonderland.fict.example, rdo@foundation.example,
39800 darcy@austen.fict.example, editor@thesaurus.ref.example
39801 038  Date: Fri, 11 May 2001 10:28:59 +0100
39802 .endd
39803 The asterisked headers indicate that the envelope sender, &'From:'& header, and
39804 &'To:'& header have been rewritten, the last one because routing expanded the
39805 unqualified domain &'foundation'&.
39806 .ecindex IIDforspo1
39807 .ecindex IIDforspo2
39808 .ecindex IIDforspo3
39809
39810 .section "Format of the -D file" "SECID282a"
39811 The data file is traditionally in Unix-standard format: lines are ended with
39812 an ASCII newline character.
39813 However, when the &%spool_wireformat%& main option is used some -D files
39814 can have an alternate format.
39815 This is flagged by a &%-spool_file_wireformat%& line in the corresponding -H file.
39816 The -D file lines (not including the first name-component line) are
39817 suitable for direct copying to the wire when transmitting using the
39818 ESMTP CHUNKING option, meaning lower processing overhead.
39819 Lines are terminated with an ASCII CRLF pair.
39820 There is no dot-stuffing (and no dot-termination).
39821
39822 . ////////////////////////////////////////////////////////////////////////////
39823 . ////////////////////////////////////////////////////////////////////////////
39824
39825 .chapter "DKIM, SPF and DMARC" "CHAPdkim" &&&
39826          "DKIM, SPF and DMARC Support"
39827
39828 .section "DKIM (DomainKeys Identified Mail)" SECDKIM
39829 .cindex "DKIM"
39830
39831 DKIM is a mechanism by which messages sent by some entity can be provably
39832 linked to a domain which that entity controls.  It permits reputation to
39833 be tracked on a per-domain basis, rather than merely upon source IP address.
39834 DKIM is documented in RFC 6376.
39835
39836 As DKIM relies on the message being unchanged in transit, messages handled
39837 by a mailing-list (which traditionally adds to the message) will not match
39838 any original DKIM signature.
39839
39840 DKIM support is compiled into Exim by default if TLS support is present.
39841 It can be disabled by setting DISABLE_DKIM=yes in &_Local/Makefile_&.
39842
39843 Exim's DKIM implementation allows for
39844 .olist
39845 Signing outgoing messages: This function is implemented in the SMTP transport.
39846 It can co-exist with all other Exim features
39847 (including transport filters)
39848 except cutthrough delivery.
39849 .next
39850 Verifying signatures in incoming messages: This is implemented by an additional
39851 ACL (acl_smtp_dkim), which can be called several times per message, with
39852 different signature contexts.
39853 .endlist
39854
39855 In typical Exim style, the verification implementation does not include any
39856 default "policy". Instead it enables you to build your own policy using
39857 Exim's standard controls.
39858
39859 Please note that verification of DKIM signatures in incoming mail is turned
39860 on by default for logging (in the <= line) purposes.
39861
39862 Additional log detail can be enabled using the &%dkim_verbose%& log_selector.
39863 When set, for each signature in incoming email,
39864 exim will log a line displaying the most important signature details, and the
39865 signature status. Here is an example (with line-breaks added for clarity):
39866 .code
39867 2009-09-09 10:22:28 1MlIRf-0003LU-U3 DKIM:
39868     d=facebookmail.com s=q1-2009b
39869     c=relaxed/relaxed a=rsa-sha1
39870     i=@facebookmail.com t=1252484542 [verification succeeded]
39871 .endd
39872
39873 You might want to turn off DKIM verification processing entirely for internal
39874 or relay mail sources. To do that, set the &%dkim_disable_verify%& ACL
39875 control modifier. This should typically be done in the RCPT ACL, at points
39876 where you accept mail from relay sources (internal hosts or authenticated
39877 senders).
39878
39879
39880 .section "Signing outgoing messages" "SECDKIMSIGN"
39881 .cindex "DKIM" "signing"
39882
39883 For signing to be usable you must have published a DKIM record in DNS.
39884 Note that RFC 8301 (which does not cover EC keys) says:
39885 .code
39886 rsa-sha1 MUST NOT be used for signing or verifying.
39887
39888 Signers MUST use RSA keys of at least 1024 bits for all keys.
39889 Signers SHOULD use RSA keys of at least 2048 bits.
39890 .endd
39891
39892 Note also that the key content (the 'p=' field)
39893 in the DNS record is different between RSA and EC keys;
39894 for the former it is the base64 of the ASN.1 for the RSA public key
39895 (equivalent to the private-key .pem with the header/trailer stripped)
39896 but for EC keys it is the base64 of the pure key; no ASN.1 wrapping.
39897
39898 Signing is enabled by setting private options on the SMTP transport.
39899 These options take (expandable) strings as arguments.
39900
39901 .option dkim_domain smtp string list&!! unset
39902 The domain(s) you want to sign with.
39903 After expansion, this can be a list.
39904 Each element in turn,
39905 .new
39906 lowercased,
39907 .wen
39908 is put into the &%$dkim_domain%& expansion variable
39909 while expanding the remaining signing options.
39910 If it is empty after expansion, DKIM signing is not done,
39911 and no error will result even if &%dkim_strict%& is set.
39912
39913 .option dkim_selector smtp string list&!! unset
39914 This sets the key selector string.
39915 After expansion, which can use &$dkim_domain$&, this can be a list.
39916 Each element in turn is put in the expansion
39917 variable &%$dkim_selector%& which may be used in the &%dkim_private_key%&
39918 option along with &%$dkim_domain%&.
39919 If the option is empty after expansion, DKIM signing is not done for this domain,
39920 and no error will result even if &%dkim_strict%& is set.
39921
39922 .option dkim_private_key smtp string&!! unset
39923 This sets the private key to use.
39924 You can use the &%$dkim_domain%& and
39925 &%$dkim_selector%& expansion variables to determine the private key to use.
39926 The result can either
39927 .ilist
39928 be a valid RSA private key in ASCII armor (.pem file), including line breaks
39929 .next
39930 with GnuTLS 3.6.0 or OpenSSL 1.1.1 or later,
39931 be a valid Ed25519 private key (same format as above)
39932 .next
39933 start with a slash, in which case it is treated as a file that contains
39934 the private key
39935 .next
39936 be "0", "false" or the empty string, in which case the message will not
39937 be signed. This case will not result in an error, even if &%dkim_strict%&
39938 is set.
39939 .endlist
39940
39941 To generate keys under OpenSSL:
39942 .code
39943 openssl genrsa -out dkim_rsa.private 2048
39944 openssl rsa -in dkim_rsa.private -out /dev/stdout -pubout -outform PEM
39945 .endd
39946 Take the base-64 lines from the output of the second command, concatenated,
39947 for the DNS TXT record.
39948 See section 3.6 of RFC6376 for the record specification.
39949
39950 Under GnuTLS:
39951 .code
39952 certtool --generate-privkey --rsa --bits=2048 --password='' -8 --outfile=dkim_rsa.private
39953 certtool --load-privkey=dkim_rsa.private --pubkey-info
39954 .endd
39955
39956 Note that RFC 8301 says:
39957 .code
39958 Signers MUST use RSA keys of at least 1024 bits for all keys.
39959 Signers SHOULD use RSA keys of at least 2048 bits.
39960 .endd
39961
39962 .new
39963 EC keys for DKIM are defined by RFC 8463.
39964 .wen
39965 They are considerably smaller than RSA keys for equivalent protection.
39966 As they are a recent development, users should consider dual-signing
39967 (by setting a list of selectors, and an expansion for this option)
39968 for some transition period.
39969 The "_CRYPTO_SIGN_ED25519" macro will be defined if support is present
39970 for EC keys.
39971
39972 OpenSSL 1.1.1 and GnuTLS 3.6.0 can create Ed25519 private keys:
39973 .code
39974 openssl genpkey -algorithm ed25519 -out dkim_ed25519.private
39975 certtool --generate-privkey --key-type=ed25519 --outfile=dkim_ed25519.private
39976 .endd
39977
39978 To produce the required public key value for a DNS record:
39979 .code
39980 openssl pkey -outform DER -pubout -in dkim_ed25519.private | tail -c +13 | base64
39981 certtool --load_privkey=dkim_ed25519.private --pubkey_info --outder | tail -c +13 | base64
39982 .endd
39983
39984 .new
39985 Exim also supports an alternate format
39986 of Ed25519 keys in DNS which was a candidate during development
39987 of the standard, but not adopted.
39988 A future release will probably drop that support.
39989 .wen
39990
39991 .option dkim_hash smtp string&!! sha256
39992 Can be set to any one of the supported hash methods, which are:
39993 .ilist
39994 &`sha1`& &-- should not be used, is old and insecure
39995 .next
39996 &`sha256`& &-- the default
39997 .next
39998 &`sha512`& &-- possibly more secure but less well supported
39999 .endlist
40000
40001 Note that RFC 8301 says:
40002 .code
40003 rsa-sha1 MUST NOT be used for signing or verifying.
40004 .endd
40005
40006 .option dkim_identity smtp string&!! unset
40007 If set after expansion, the value is used to set an "i=" tag in
40008 the signing header.  The DKIM standards restrict the permissible
40009 syntax of this optional tag to a mail address, with possibly-empty
40010 local part, an @, and a domain identical to or subdomain of the "d="
40011 tag value.  Note that Exim does not check the value.
40012
40013 .option dkim_canon smtp string&!! unset
40014 This option sets the canonicalization method used when signing a message.
40015 The DKIM RFC currently supports two methods: "simple" and "relaxed".
40016 The option defaults to "relaxed" when unset. Note: the current implementation
40017 only supports signing with the same canonicalization method for both headers and body.
40018
40019 .option dkim_strict smtp string&!! unset
40020 This  option  defines  how  Exim  behaves  when  signing a message that
40021 should be signed fails for some reason.  When the expansion evaluates to
40022 either "1" or "true", Exim will defer. Otherwise Exim will send the message
40023 unsigned. You can use the &%$dkim_domain%& and &%$dkim_selector%& expansion
40024 variables here.
40025
40026 .option dkim_sign_headers smtp string&!! "see below"
40027 If set, this option must expand to a colon-separated
40028 list of header names.
40029 Headers with these names, or the absence or such a header, will be included
40030 in the message signature.
40031 When unspecified, the header names listed in RFC4871 will be used,
40032 whether or not each header is present in the message.
40033 The default list is available for the expansion in the macro
40034 "_DKIM_SIGN_HEADERS".
40035
40036 If a name is repeated, multiple headers by that name (or the absence thereof)
40037 will be signed.  The textually later headers in the headers part of the
40038 message are signed first, if there are multiples.
40039
40040 A name can be prefixed with either an '=' or a '+' character.
40041 If an '=' prefix is used, all headers that are present with this name
40042 will be signed.
40043 If a '+' prefix if used, all headers that are present with this name
40044 will be signed, and one signature added for a missing header with the
40045 name will be appended.
40046
40047 .option dkim_timestamps smtp integer&!! unset
40048 This option controls the inclusion of timestamp information in the signature.
40049 If not set, no such information will be included.
40050 Otherwise, must be an unsigned number giving an offset in seconds from the current time
40051 for the expiry tag
40052 (eg. 1209600 for two weeks);
40053 both creation (t=) and expiry (x=) tags will be included.
40054
40055 RFC 6376 lists these tags as RECOMMENDED.
40056
40057
40058 .section "Verifying DKIM signatures in incoming mail" "SECDKIMVFY"
40059 .cindex "DKIM" "verification"
40060
40061 Verification of DKIM signatures in SMTP incoming email is done for all
40062 messages for which an ACL control &%dkim_disable_verify%& has not been set.
40063 .new
40064 .cindex DKIM "selecting signature algorithms"
40065 Individual classes of signature algorithm can be ignored by changing
40066 the main options &%dkim_verify_hashes%& or &%dkim_verify_keytypes%&.
40067 The &%dkim_verify_minimal%& option can be set to cease verification
40068 processing for a message once the first passing signature is found.
40069 .wen
40070
40071 .cindex authentication "expansion item"
40072 Performing verification sets up information used by the
40073 &%authresults%& expansion item.
40074
40075 .new
40076 For most purposes the default option settings suffice and the remainder
40077 of this section can be ignored.
40078 .wen
40079
40080 The results of verification are made available to the
40081 &%acl_smtp_dkim%& ACL, which can examine and modify them.
40082 A missing ACL definition defaults to accept.
40083 By default, the ACL is called once for each
40084 syntactically(!) correct signature in the incoming message.
40085 If any ACL call does not accept, the message is not accepted.
40086 If a cutthrough delivery was in progress for the message, that is
40087 summarily dropped (having wasted the transmission effort).
40088
40089 To evaluate the verification result in the ACL
40090 a large number of expansion variables
40091 containing the signature status and its details are set up during the
40092 runtime of the ACL.
40093
40094 Calling the ACL only for existing signatures is not sufficient to build
40095 more advanced policies. For that reason, the main option
40096 &%dkim_verify_signers%&, and an expansion variable
40097 &%$dkim_signers%& exist.
40098
40099 The main option &%dkim_verify_signers%& can be set to a colon-separated
40100 list of DKIM domains or identities for which the ACL &%acl_smtp_dkim%& is
40101 called. It is expanded when the message has been received. At this point,
40102 the expansion variable &%$dkim_signers%& already contains a colon-separated
40103 list of signer domains and identities for the message. When
40104 &%dkim_verify_signers%& is not specified in the main configuration,
40105 it defaults as:
40106 .code
40107 dkim_verify_signers = $dkim_signers
40108 .endd
40109 This leads to the default behaviour of calling &%acl_smtp_dkim%& for each
40110 DKIM signature in the message. Current DKIM verifiers may want to explicitly
40111 call the ACL for known domains or identities. This would be achieved as follows:
40112 .code
40113 dkim_verify_signers = paypal.com:ebay.com:$dkim_signers
40114 .endd
40115 This would result in &%acl_smtp_dkim%& always being called for "paypal.com"
40116 and "ebay.com", plus all domains and identities that have signatures in the message.
40117 You can also be more creative in constructing your policy. For example:
40118 .code
40119 dkim_verify_signers = $sender_address_domain:$dkim_signers
40120 .endd
40121
40122 If a domain or identity is listed several times in the (expanded) value of
40123 &%dkim_verify_signers%&, the ACL is only called once for that domain or identity.
40124
40125 .new
40126 Note that if the option is set using untrustworthy data
40127 (such as the From: header)
40128 care should be taken to force lowercase for domains
40129 and for the domain part if identities.
40130 The default setting can be regarded as trustworthy in this respect.
40131 .wen
40132
40133 If multiple signatures match a domain (or identity), the ACL is called once
40134 for each matching signature.
40135
40136
40137 Inside the DKIM ACL, the following expansion variables are
40138 available (from most to least important):
40139
40140
40141 .vlist
40142 .vitem &%$dkim_cur_signer%&
40143 The signer that is being evaluated in this ACL run. This can be a domain or
40144 an identity. This is one of the list items from the expanded main option
40145 &%dkim_verify_signers%& (see above).
40146
40147 .vitem &%$dkim_verify_status%&
40148 Within the DKIM ACL,
40149 a string describing the general status of the signature. One of
40150 .ilist
40151 &%none%&: There is no signature in the message for the current domain or
40152 identity (as reflected by &%$dkim_cur_signer%&).
40153 .next
40154 &%invalid%&: The signature could not be verified due to a processing error.
40155 More detail is available in &%$dkim_verify_reason%&.
40156 .next
40157 &%fail%&: Verification of the signature failed.  More detail is
40158 available in &%$dkim_verify_reason%&.
40159 .next
40160 &%pass%&: The signature passed verification. It is valid.
40161 .endlist
40162
40163 This variable can be overwritten using an ACL 'set' modifier.
40164 This might, for instance, be done to enforce a policy restriction on
40165 hash-method or key-size:
40166 .code
40167   warn condition       = ${if eq {$dkim_verify_status}{pass}}
40168        condition       = ${if eq {${length_3:$dkim_algo}}{rsa}}
40169        condition       = ${if or {{eq {$dkim_algo}{rsa-sha1}} \
40170                                   {< {$dkim_key_length}{1024}}}}
40171        logwrite        = NOTE: forcing DKIM verify fail (was pass)
40172        set dkim_verify_status = fail
40173        set dkim_verify_reason = hash too weak or key too short
40174 .endd
40175
40176 So long as a DKIM ACL is defined (it need do no more than accept),
40177 after all the DKIM ACL runs have completed, the value becomes a
40178 colon-separated list of the values after each run.
40179 This is maintained for the mime, prdr and data ACLs.
40180
40181 .vitem &%$dkim_verify_reason%&
40182 A string giving a little bit more detail when &%$dkim_verify_status%& is either
40183 "fail" or "invalid". One of
40184 .ilist
40185 &%pubkey_unavailable%& (when &%$dkim_verify_status%&="invalid"): The public
40186 key for the domain could not be retrieved. This may be a temporary problem.
40187 .next
40188 &%pubkey_syntax%& (when &%$dkim_verify_status%&="invalid"): The public key
40189 record for the domain is syntactically invalid.
40190 .next
40191 &%bodyhash_mismatch%& (when &%$dkim_verify_status%&="fail"): The calculated
40192 body hash does not match the one specified in the signature header. This
40193 means that the message body was modified in transit.
40194 .next
40195 &%signature_incorrect%& (when &%$dkim_verify_status%&="fail"): The signature
40196 could not be verified. This may mean that headers were modified,
40197 re-written or otherwise changed in a way which is incompatible with
40198 DKIM verification. It may of course also mean that the signature is forged.
40199 .endlist
40200
40201 This variable can be overwritten, with any value, using an ACL 'set' modifier.
40202
40203 .vitem &%$dkim_domain%&
40204 The signing domain. IMPORTANT: This variable is only populated if there is
40205 an actual signature in the message for the current domain or identity (as
40206 reflected by &%$dkim_cur_signer%&).
40207
40208 .vitem &%$dkim_identity%&
40209 The signing identity, if present. IMPORTANT: This variable is only populated
40210 if there is an actual signature in the message for the current domain or
40211 identity (as reflected by &%$dkim_cur_signer%&).
40212
40213 .vitem &%$dkim_selector%&
40214 The key record selector string.
40215
40216 .vitem &%$dkim_algo%&
40217 The algorithm used. One of 'rsa-sha1' or 'rsa-sha256'.
40218 If running under GnuTLS 3.6.0 or OpenSSL 1.1.1 or later,
40219 may also be 'ed25519-sha256'.
40220 The "_CRYPTO_SIGN_ED25519" macro will be defined if support is present
40221 for EC keys.
40222
40223 Note that RFC 8301 says:
40224 .code
40225 rsa-sha1 MUST NOT be used for signing or verifying.
40226
40227 DKIM signatures identified as having been signed with historic
40228 algorithms (currently, rsa-sha1) have permanently failed evaluation
40229 .endd
40230
40231 To enforce this you must either have a DKIM ACL which checks this variable
40232 and overwrites the &$dkim_verify_status$& variable as discussed above,
40233 .new
40234 or have set the main option &%dkim_verify_hashes%& to exclude
40235 processing of such signatures.
40236 .wen
40237
40238 .vitem &%$dkim_canon_body%&
40239 The body canonicalization method. One of 'relaxed' or 'simple'.
40240
40241 .vitem &%$dkim_canon_headers%&
40242 The header canonicalization method. One of 'relaxed' or 'simple'.
40243
40244 .vitem &%$dkim_copiedheaders%&
40245 A transcript of headers and their values which are included in the signature
40246 (copied from the 'z=' tag of the signature).
40247 Note that RFC6376 requires that verification fail if the From: header is
40248 not included in the signature.  Exim does not enforce this; sites wishing
40249 strict enforcement should code the check explicitly.
40250
40251 .vitem &%$dkim_bodylength%&
40252 The number of signed body bytes. If zero ("0"), the body is unsigned. If no
40253 limit was set by the signer, "9999999999999" is returned. This makes sure
40254 that this variable always expands to an integer value.
40255 &*Note:*& The presence of the signature tag specifying a signing body length
40256 is one possible route to spoofing of valid DKIM signatures.
40257 A paranoid implementation might wish to regard signature where this variable
40258 shows less than the "no limit" return as being invalid.
40259
40260 .vitem &%$dkim_created%&
40261 UNIX timestamp reflecting the date and time when the signature was created.
40262 When this was not specified by the signer, "0" is returned.
40263
40264 .vitem &%$dkim_expires%&
40265 UNIX timestamp reflecting the date and time when the signer wants the
40266 signature to be treated as "expired". When this was not specified by the
40267 signer, "9999999999999" is returned. This makes it possible to do useful
40268 integer size comparisons against this value.
40269 Note that Exim does not check this value.
40270
40271 .vitem &%$dkim_headernames%&
40272 A colon-separated list of names of headers included in the signature.
40273
40274 .vitem &%$dkim_key_testing%&
40275 "1" if the key record has the "testing" flag set, "0" if not.
40276
40277 .vitem &%$dkim_key_nosubdomains%&
40278 "1" if the key record forbids subdomaining, "0" otherwise.
40279
40280 .vitem &%$dkim_key_srvtype%&
40281 Service type (tag s=) from the key record. Defaults to "*" if not specified
40282 in the key record.
40283
40284 .vitem &%$dkim_key_granularity%&
40285 Key granularity (tag g=) from the key record. Defaults to "*" if not specified
40286 in the key record.
40287
40288 .vitem &%$dkim_key_notes%&
40289 Notes from the key record (tag n=).
40290
40291 .vitem &%$dkim_key_length%&
40292 Number of bits in the key.
40293
40294 Note that RFC 8301 says:
40295 .code
40296 Verifiers MUST NOT consider signatures using RSA keys of
40297 less than 1024 bits as valid signatures.
40298 .endd
40299
40300 To enforce this you must have a DKIM ACL which checks this variable
40301 and overwrites the &$dkim_verify_status$& variable as discussed above.
40302 As EC keys are much smaller, the check should only do this for RSA keys.
40303
40304 .endlist
40305
40306 In addition, two ACL conditions are provided:
40307
40308 .vlist
40309 .vitem &%dkim_signers%&
40310 ACL condition that checks a colon-separated list of domains or identities
40311 for a match against the domain or identity that the ACL is currently verifying
40312 (reflected by &%$dkim_cur_signer%&). This is typically used to restrict an ACL
40313 verb to a group of domains or identities. For example:
40314
40315 .code
40316 # Warn when Mail purportedly from GMail has no gmail signature
40317 warn log_message = GMail sender without gmail.com DKIM signature
40318      sender_domains = gmail.com
40319      dkim_signers = gmail.com
40320      dkim_status = none
40321 .endd
40322
40323 Note that the above does not check for a total lack of DKIM signing;
40324 for that check for empty &$h_DKIM-Signature:$& in the data ACL.
40325
40326 .vitem &%dkim_status%&
40327 ACL condition that checks a colon-separated list of possible DKIM verification
40328 results against the actual result of verification. This is typically used
40329 to restrict an ACL verb to a list of verification outcomes, for example:
40330
40331 .code
40332 deny message = Mail from Paypal with invalid/missing signature
40333      sender_domains = paypal.com:paypal.de
40334      dkim_signers = paypal.com:paypal.de
40335      dkim_status = none:invalid:fail
40336 .endd
40337
40338 The possible status keywords are: 'none','invalid','fail' and 'pass'. Please
40339 see the documentation of the &%$dkim_verify_status%& expansion variable above
40340 for more information of what they mean.
40341 .endlist
40342
40343
40344
40345
40346 .section "SPF (Sender Policy Framework)" SECSPF
40347 .cindex SPF verification
40348
40349 SPF is a mechanism whereby a domain may assert which IP addresses may transmit
40350 messages with its domain in the envelope from, documented by RFC 7208.
40351 For more information on SPF see &url(http://www.open-spf.org), a static copy of
40352 the &url(http://openspf.org).
40353 . --- 2019-10-28: still not https, open-spf.org is told to be a
40354 . --- web-archive copy of the now dead openspf.org site
40355 . --- See https://www.mail-archive.com/mailop@mailop.org/msg08019.html for a
40356 . --- discussion.
40357
40358 Messages sent by a system not authorised will fail checking of such assertions.
40359 This includes retransmissions done by traditional forwarders.
40360
40361 SPF verification support is built into Exim if SUPPORT_SPF=yes is set in
40362 &_Local/Makefile_&.  The support uses the &_libspf2_& library
40363 &url(https://www.libspf2.org/).
40364 There is no Exim involvement in the transmission of messages;
40365 publishing certain DNS records is all that is required.
40366
40367 For verification, an ACL condition and an expansion lookup are provided.
40368 .cindex authentication "expansion item"
40369 Performing verification sets up information used by the
40370 &%authresults%& expansion item.
40371
40372
40373 .cindex SPF "ACL condition"
40374 .cindex ACL "spf condition"
40375 The ACL condition "spf" can be used at or after the MAIL ACL.
40376 It takes as an argument a list of strings giving the outcome of the SPF check,
40377 and will succeed for any matching outcome.
40378 Valid strings are:
40379 .vlist
40380 .vitem &%pass%&
40381 The SPF check passed, the sending host is positively verified by SPF.
40382
40383 .vitem &%fail%&
40384 The SPF check failed, the sending host is NOT allowed to send mail for the
40385 domain in the envelope-from address.
40386
40387 .vitem &%softfail%&
40388 The SPF check failed, but the queried domain can't absolutely confirm that this
40389 is a forgery.
40390
40391 .vitem &%none%&
40392 The queried domain does not publish SPF records.
40393
40394 .vitem &%neutral%&
40395 The SPF check returned a "neutral" state.  This means the queried domain has
40396 published a SPF record, but wants to allow outside servers to send mail under
40397 its domain as well.  This should be treated like "none".
40398
40399 .vitem &%permerror%&
40400 This indicates a syntax error in the SPF record of the queried domain.
40401 You may deny messages when this occurs.
40402
40403 .vitem &%temperror%&
40404 This indicates a temporary error during all processing, including Exim's
40405 SPF processing.  You may defer messages when this occurs.
40406 .endlist
40407
40408 You can prefix each string with an exclamation mark to  invert
40409 its meaning,  for example  "!fail" will  match all  results but
40410 "fail".  The  string  list is  evaluated  left-to-right,  in a
40411 short-circuit fashion.
40412
40413 Example:
40414 .code
40415 deny spf = fail
40416      message = $sender_host_address is not allowed to send mail from \
40417                ${if def:sender_address_domain \
40418                     {$sender_address_domain}{$sender_helo_name}}.  \
40419                Please see http://www.open-spf.org/Why?scope=\
40420                ${if def:sender_address_domain {mfrom}{helo}};\
40421                identity=${if def:sender_address_domain \
40422                              {$sender_address}{$sender_helo_name}};\
40423                ip=$sender_host_address
40424 .endd
40425
40426 When the spf condition has run, it sets up several expansion
40427 variables:
40428
40429 .cindex SPF "verification variables"
40430 .vlist
40431 .vitem &$spf_header_comment$&
40432 .vindex &$spf_header_comment$&
40433   This contains a human-readable string describing the outcome
40434   of the SPF check. You can add it to a custom header or use
40435   it for logging purposes.
40436
40437 .vitem &$spf_received$&
40438 .vindex &$spf_received$&
40439   This contains a complete Received-SPF: header that can be
40440   added to the message. Please note that according to the SPF
40441   draft, this header must be added at the top of the header
40442   list. Please see section 10 on how you can do this.
40443
40444   Note: in case of "Best-guess" (see below), the convention is
40445   to put this string in a header called X-SPF-Guess: instead.
40446
40447 .vitem &$spf_result$&
40448 .vindex &$spf_result$&
40449   This contains the outcome of the SPF check in string form,
40450   one of pass, fail, softfail, none, neutral, permerror or
40451   temperror.
40452
40453 .vitem &$spf_result_guessed$&
40454 .vindex &$spf_result_guessed$&
40455   This boolean is true only if a best-guess operation was used
40456   and required in order to obtain a result.
40457
40458 .vitem &$spf_smtp_comment$&
40459 .vindex &$spf_smtp_comment$&
40460   This contains a string that can be used in a SMTP response
40461   to the calling party. Useful for "fail".
40462 .endlist
40463
40464
40465 .cindex SPF "ACL condition"
40466 .cindex ACL "spf_guess condition"
40467 .cindex SPF "best guess"
40468 In addition to SPF, you can also perform checks for so-called
40469 "Best-guess".  Strictly speaking, "Best-guess" is not standard
40470 SPF, but it is supported by the same framework that enables SPF
40471 capability.
40472 Refer to &url(http://www.open-spf.org/FAQ/Best_guess_record)
40473 for a description of what it means.
40474 . --- 2019-10-28: still not https:
40475
40476 To access this feature, simply use the spf_guess condition in place
40477 of the spf one.  For example:
40478
40479 .code
40480 deny spf_guess = fail
40481      message = $sender_host_address doesn't look trustworthy to me
40482 .endd
40483
40484 In case you decide to reject messages based on this check, you
40485 should note that although it uses the same framework, "Best-guess"
40486 is not SPF, and therefore you should not mention SPF at all in your
40487 reject message.
40488
40489 When the spf_guess condition has run, it sets up the same expansion
40490 variables as when spf condition is run, described above.
40491
40492 Additionally, since Best-guess is not standardized, you may redefine
40493 what "Best-guess" means to you by redefining the main configuration
40494 &%spf_guess%& option.
40495 For example, the following:
40496
40497 .code
40498 spf_guess = v=spf1 a/16 mx/16 ptr ?all
40499 .endd
40500
40501 would relax host matching rules to a broader network range.
40502
40503
40504 .cindex SPF "lookup expansion"
40505 .cindex lookup spf
40506 A lookup expansion is also available. It takes an email
40507 address as the key and an IP address
40508 .new
40509 (v4 or v6)
40510 .wen
40511 as the database:
40512
40513 .code
40514   ${lookup {username@domain} spf {ip.ip.ip.ip}}
40515 .endd
40516
40517 The lookup will return the same result strings as can appear in
40518 &$spf_result$& (pass,fail,softfail,neutral,none,err_perm,err_temp).
40519
40520
40521
40522
40523
40524 .new
40525 .section DMARC SECDMARC
40526 .cindex DMARC verification
40527
40528 DMARC combines feedback from SPF, DKIM, and header From: in order
40529 to attempt to provide better indicators of the authenticity of an
40530 email.  This document does not explain the fundamentals; you
40531 should read and understand how it works by visiting the website at
40532 &url(http://www.dmarc.org/).
40533
40534 If Exim is built with DMARC support,
40535 the libopendmarc library is used.
40536
40537 For building Exim yourself, obtain the library from
40538 &url(http://sourceforge.net/projects/opendmarc/)
40539 to obtain a copy, or find it in your favorite rpm package
40540 repository.  You will need to attend to the local/Makefile feature
40541 SUPPORT_DMARC and the associated LDFLAGS addition.
40542 This description assumes
40543 that headers will be in /usr/local/include, and that the libraries
40544 are in /usr/local/lib.
40545
40546 . subsection
40547
40548 There are three main-configuration options:
40549 .cindex DMARC "configuration options"
40550
40551 The &%dmarc_tld_file%& option
40552 .oindex &%dmarc_tld_file%&
40553 defines the location of a text file of valid
40554 top level domains the opendmarc library uses
40555 during domain parsing. Maintained by Mozilla,
40556 the most current version can be downloaded
40557 from a link at &url(https://publicsuffix.org/list/, currently pointing
40558 at https://publicsuffix.org/list/public_suffix_list.dat)
40559 See also util/renew-opendmarc-tlds.sh script.
40560 The default for the option is /etc/exim/opendmarc.tlds.
40561
40562
40563 The &%dmarc_history_file%& option, if set
40564 .oindex &%dmarc_history_file%&
40565 defines the location of a file to log results
40566 of dmarc verification on inbound emails. The
40567 contents are importable by the opendmarc tools
40568 which will manage the data, send out DMARC
40569 reports, and expire the data. Make sure the
40570 directory of this file is writable by the user
40571 exim runs as.
40572 The default is unset.
40573
40574 The &%dmarc_forensic_sender%& option
40575 .oindex &%dmarc_forensic_sender%&
40576 defines an alternate email address to use when sending a
40577 forensic report detailing alignment failures
40578 if a sender domain's dmarc record specifies it
40579 and you have configured Exim to send them.
40580 If set, this is expanded and used for the
40581 From: header line; the address is extracted
40582 from it and used for the envelope from.
40583 If not set (the default), the From: header is expanded from
40584 the dsn_from option, and <> is used for the
40585 envelope from.
40586
40587 . I wish we had subsections...
40588
40589 .cindex DMARC controls
40590 By default, the DMARC processing will run for any remote,
40591 non-authenticated user.  It makes sense to only verify DMARC
40592 status of messages coming from remote, untrusted sources.  You can
40593 use standard conditions such as hosts, senders, etc, to decide that
40594 DMARC verification should *not* be performed for them and disable
40595 DMARC with a control setting:
40596 .code
40597   control = dmarc_disable_verify
40598 .endd
40599 A DMARC record can also specify a "forensic address", which gives
40600 exim an email address to submit reports about failed alignment.
40601 Exim does not do this by default because in certain conditions it
40602 results in unintended information leakage (what lists a user might
40603 be subscribed to, etc).  You must configure exim to submit forensic
40604 reports to the owner of the domain.  If the DMARC record contains a
40605 forensic address and you specify the control statement below, then
40606 exim will send these forensic emails.  It's also advised that you
40607 configure a dmarc_forensic_sender because the default sender address
40608 construction might be inadequate.
40609 .code
40610   control = dmarc_enable_forensic
40611 .endd
40612 (AGAIN: You can choose not to send these forensic reports by simply
40613 not putting the dmarc_enable_forensic control line at any point in
40614 your exim config.  If you don't tell it to send them, it will not
40615 send them.)
40616
40617 There are no options to either control.  Both must appear before
40618 the DATA acl.
40619
40620 . subsection
40621
40622 DMARC checks cam be run on incoming SMTP  messages by using the
40623 "dmarc_status" ACL condition in the DATA ACL.  You are required to
40624 call the "spf" condition first in the ACLs, then the "dmarc_status"
40625 condition.  Putting this condition in the ACLs is required in order
40626 for a DMARC check to actually occur.  All of the variables are set
40627 up before the DATA ACL, but there is no actual DMARC check that
40628 occurs until a "dmarc_status" condition is encountered in the ACLs.
40629
40630 The dmarc_status condition takes a list of strings on its
40631 right-hand side.  These strings describe recommended action based
40632 on the DMARC check.  To understand what the policy recommendations
40633 mean, refer to the DMARC website above.  Valid strings are:
40634 .display
40635 &'accept      '& The DMARC check passed and the library recommends accepting the email.
40636 &'reject      '& The DMARC check failed and the library recommends rejecting the email.
40637 &'quarantine  '& The DMARC check failed and the library recommends keeping it for further inspection.
40638 &'none        '& The DMARC check passed and the library recommends no specific action, neutral.
40639 &'norecord    '& No policy section in the DMARC record for this sender domain.
40640 &'nofrom      '& Unable to determine the domain of the sender.
40641 &'temperror   '& Library error or dns error.
40642 &'off         '& The DMARC check was disabled for this email.
40643 .endd
40644 You can prefix each string with an exclamation mark to invert its
40645 meaning, for example "!accept" will match all results but
40646 "accept".  The string list is evaluated left-to-right in a
40647 short-circuit fashion.  When a string matches the outcome of the
40648 DMARC check, the condition succeeds.  If none of the listed
40649 strings matches the outcome of the DMARC check, the condition
40650 fails.
40651
40652 Of course, you can also use any other lookup method that Exim
40653 supports, including LDAP, Postgres, MySQL, etc, as long as the
40654 result is a list of colon-separated strings.
40655
40656 Performing the check sets up information used by the
40657 &%authresults%& expansion item.
40658
40659 Several expansion variables are set before the DATA ACL is
40660 processed, and you can use them in this ACL.  The following
40661 expansion variables are available:
40662
40663 &$dmarc_status$&
40664 .vindex &$dmarc_status$&
40665 .cindex DMARC result
40666 is a one word status indicating what the DMARC library
40667 thinks of the email.  It is a combination of the results of
40668 DMARC record lookup and the SPF/DKIM/DMARC processing results
40669 (if a DMARC record was found).  The actual policy declared
40670 in the DMARC record is in a separate expansion variable.
40671
40672 &$dmarc_status_text$&
40673 .vindex &$dmarc_status_text$&
40674 is a slightly longer, human readable status.
40675
40676 &$dmarc_used_domain$&
40677 .vindex &$dmarc_used_domain$&
40678 is the domain which DMARC used to look up the DMARC policy record.
40679
40680 &$dmarc_domain_policy$&
40681 .vindex &$dmarc_domain_policy$&
40682 is the policy declared in the DMARC record.  Valid values
40683 are "none", "reject" and "quarantine".  It is blank when there
40684 is any error, including no DMARC record.
40685
40686 . subsection
40687
40688 By default, Exim's DMARC configuration is intended to be
40689 non-intrusive and conservative.  To facilitate this, Exim will not
40690 create any type of logging files without explicit configuration by
40691 you, the admin.  Nor will Exim send out any emails/reports about
40692 DMARC issues without explicit configuration by you, the admin (other
40693 than typical bounce messages that may come about due to ACL
40694 processing or failure delivery issues).
40695
40696 In order to log statistics suitable to be imported by the opendmarc
40697 tools, you need to:
40698 .ilist
40699 Configure the global setting dmarc_history_file
40700 .next
40701 Configure cron jobs to call the appropriate opendmarc history
40702 import scripts and truncating the dmarc_history_file
40703 .endlist
40704
40705 In order to send forensic reports, you need to:
40706 .ilist
40707 Configure the global setting dmarc_forensic_sender
40708 .next
40709 Configure, somewhere before the DATA ACL, the control option to
40710 enable sending DMARC forensic reports
40711 .endlist
40712
40713 . subsection
40714
40715 Example usage:
40716 .code
40717 (RCPT ACL)
40718   warn    domains        = +local_domains
40719           hosts          = +local_hosts
40720           control        = dmarc_disable_verify
40721
40722   warn    !domains       = +screwed_up_dmarc_records
40723           control        = dmarc_enable_forensic
40724
40725   warn    condition      = (lookup if destined to mailing list)
40726           set acl_m_mailing_list = 1
40727
40728 (DATA ACL)
40729   warn    dmarc_status   = accept : none : off
40730           !authenticated = *
40731           log_message    = DMARC DEBUG: $dmarc_status $dmarc_used_domain
40732
40733   warn    dmarc_status   = !accept
40734           !authenticated = *
40735           log_message    = DMARC DEBUG: '$dmarc_status' for $dmarc_used_domain
40736
40737   warn    dmarc_status   = quarantine
40738           !authenticated = *
40739           set $acl_m_quarantine = 1
40740           # Do something in a transport with this flag variable
40741
40742   deny    condition      = ${if eq{$dmarc_domain_policy}{reject}}
40743           condition      = ${if eq{$acl_m_mailing_list}{1}}
40744           message        = Messages from $dmarc_used_domain break mailing lists
40745
40746   deny    dmarc_status   = reject
40747           !authenticated = *
40748           message        = Message from $dmarc_used_domain failed sender's DMARC policy, REJECT
40749
40750   warn    add_header     = :at_start:${authresults {$primary_hostname}}
40751 .endd
40752
40753 .wen
40754
40755
40756
40757
40758 . ////////////////////////////////////////////////////////////////////////////
40759 . ////////////////////////////////////////////////////////////////////////////
40760
40761 .chapter "Proxies" "CHAPproxies" &&&
40762          "Proxy support"
40763 .cindex "proxy support"
40764 .cindex "proxy" "access via"
40765
40766 A proxy is an intermediate system through which communication is passed.
40767 Proxies may provide a security, availability or load-distribution function.
40768
40769
40770 .section "Inbound proxies" SECTproxyInbound
40771 .cindex proxy inbound
40772 .cindex proxy "server side"
40773 .cindex proxy "Proxy protocol"
40774 .cindex "Proxy protocol" proxy
40775
40776 Exim has support for receiving inbound SMTP connections via a proxy
40777 that uses &"Proxy Protocol"& to speak to it.
40778 To include this support, include &"SUPPORT_PROXY=yes"&
40779 in Local/Makefile.
40780
40781 It was built on the HAProxy specification, found at
40782 &url(https://www.haproxy.org/download/1.8/doc/proxy-protocol.txt).
40783
40784 The purpose of this facility is so that an application load balancer,
40785 such as HAProxy, can sit in front of several Exim servers
40786 to distribute load.
40787 Exim uses the local protocol communication with the proxy to obtain
40788 the remote SMTP system IP address and port information.
40789 There is no logging if a host passes or
40790 fails Proxy Protocol negotiation, but it can easily be determined and
40791 recorded in an ACL (example is below).
40792
40793 Use of a proxy is enabled by setting the &%hosts_proxy%&
40794 main configuration option to a hostlist; connections from these
40795 hosts will use Proxy Protocol.
40796 Exim supports both version 1 and version 2 of the Proxy Protocol and
40797 automatically determines which version is in use.
40798
40799 The Proxy Protocol header is the first data received on a TCP connection
40800 and is inserted before any TLS-on-connect handshake from the client; Exim
40801 negotiates TLS between Exim-as-server and the remote client, not between
40802 Exim and the proxy server.
40803
40804 The following expansion variables are usable
40805 (&"internal"& and &"external"& here refer to the interfaces
40806 of the proxy):
40807 .display
40808 &'proxy_external_address   '& IP of host being proxied or IP of remote interface of proxy
40809 &'proxy_external_port      '& Port of host being proxied or Port on remote interface of proxy
40810 &'proxy_local_address      '& IP of proxy server inbound or IP of local interface of proxy
40811 &'proxy_local_port         '& Port of proxy server inbound or Port on local interface of proxy
40812 &'proxy_session            '& boolean: SMTP connection via proxy
40813 .endd
40814 If &$proxy_session$& is set but &$proxy_external_address$& is empty
40815 there was a protocol error.
40816 The variables &$sender_host_address$& and &$sender_host_port$&
40817 will have values for the actual client system, not the proxy.
40818
40819 Since the real connections are all coming from the proxy, and the
40820 per host connection tracking is done before Proxy Protocol is
40821 evaluated, &%smtp_accept_max_per_host%& must be set high enough to
40822 handle all of the parallel volume you expect per inbound proxy.
40823 With the option set so high, you lose the ability
40824 to protect your server from many connections from one IP.
40825 In order to prevent your server from overload, you
40826 need to add a per connection ratelimit to your connect ACL.
40827 A possible solution is:
40828 .display
40829   # Set max number of connections per host
40830   LIMIT   = 5
40831   # Or do some kind of IP lookup in a flat file or database
40832   # LIMIT = ${lookup{$sender_host_address}iplsearch{/etc/exim/proxy_limits}}
40833
40834   defer   message        = Too many connections from this IP right now
40835           ratelimit      = LIMIT / 5s / per_conn / strict
40836 .endd
40837
40838
40839
40840 .section "Outbound proxies" SECTproxySOCKS
40841 .cindex proxy outbound
40842 .cindex proxy "client side"
40843 .cindex proxy SOCKS
40844 .cindex SOCKS proxy
40845 Exim has support for sending outbound SMTP via a proxy
40846 using a protocol called SOCKS5 (defined by RFC1928).
40847 The support can be optionally included by defining SUPPORT_SOCKS=yes in
40848 Local/Makefile.
40849
40850 Use of a proxy is enabled by setting the &%socks_proxy%& option
40851 on an smtp transport.
40852 The option value is expanded and should then be a list
40853 (colon-separated by default) of proxy specifiers.
40854 Each proxy specifier is a list
40855 (space-separated by default) where the initial element
40856 is an IP address and any subsequent elements are options.
40857
40858 Options are a string <name>=<value>.
40859 The list of options is in the following table:
40860 .display
40861 &'auth   '& authentication method
40862 &'name   '& authentication username
40863 &'pass   '& authentication password
40864 &'port   '& tcp port
40865 &'tmo    '& connection timeout
40866 &'pri    '& priority
40867 &'weight '& selection bias
40868 .endd
40869
40870 More details on each of these options follows:
40871
40872 .ilist
40873 .cindex authentication "to proxy"
40874 .cindex proxy authentication
40875 &%auth%&: Either &"none"& (default) or &"name"&.
40876 Using &"name"& selects username/password authentication per RFC 1929
40877 for access to the proxy.
40878 Default is &"none"&.
40879 .next
40880 &%name%&: sets the username for the &"name"& authentication method.
40881 Default is empty.
40882 .next
40883 &%pass%&: sets the password for the &"name"& authentication method.
40884 Default is empty.
40885 .next
40886 &%port%&: the TCP port number to use for the connection to the proxy.
40887 Default is 1080.
40888 .next
40889 &%tmo%&: sets a connection timeout in seconds for this proxy.
40890 Default is 5.
40891 .next
40892 &%pri%&: specifies a priority for the proxy within the list,
40893 higher values being tried first.
40894 The default priority is 1.
40895 .next
40896 &%weight%&: specifies a selection bias.
40897 Within a priority set servers are queried in a random fashion,
40898 weighted by this value.
40899 The default value for selection bias is 1.
40900 .endlist
40901
40902 Proxies from the list are tried according to their priority
40903 and weight settings until one responds.  The timeout for the
40904 overall connection applies to the set of proxied attempts.
40905
40906 .section Logging SECTproxyLog
40907 To log the (local) IP of a proxy in the incoming or delivery logline,
40908 add &"+proxy"& to the &%log_selector%& option.
40909 This will add a component tagged with &"PRX="& to the line.
40910
40911 . ////////////////////////////////////////////////////////////////////////////
40912 . ////////////////////////////////////////////////////////////////////////////
40913
40914 .chapter "Internationalisation" "CHAPi18n" &&&
40915          "Internationalisation""
40916 .cindex internationalisation "email address"
40917 .cindex EAI
40918 .cindex i18n
40919 .cindex utf8 "mail name handling"
40920
40921 Exim has support for Internationalised mail names.
40922 To include this it must be built with SUPPORT_I18N and the libidn library.
40923 Standards supported are RFCs 2060, 5890, 6530 and 6533.
40924
40925 If Exim is built with SUPPORT_I18N_2008 (in addition to SUPPORT_I18N, not
40926 instead of it) then IDNA2008 is supported; this adds an extra library
40927 requirement, upon libidn2.
40928
40929 .section "MTA operations" SECTi18nMTA
40930 .cindex SMTPUTF8 "ESMTP option"
40931 The main configuration option &%smtputf8_advertise_hosts%& specifies
40932 a host list.  If this matches the sending host and
40933 accept_8bitmime is true (the default) then the ESMTP option
40934 SMTPUTF8 will be advertised.
40935
40936 If the sender specifies the SMTPUTF8 option on a MAIL command
40937 international handling for the message is enabled and
40938 the expansion variable &$message_smtputf8$& will have value TRUE.
40939
40940 The option &%allow_utf8_domains%& is set to true for this
40941 message. All DNS lookups are converted to a-label form
40942 whatever the setting of &%allow_utf8_domains%&
40943 when Exim is built with SUPPORT_I18N.
40944
40945 Both localparts and domain are maintained as the original
40946 UTF-8 form internally; any comparison or regular-expression use will
40947 require appropriate care.  Filenames created, eg. by
40948 the appendfile transport, will have UTF-8 names.
40949
40950 HELO names sent by the smtp transport will have any UTF-8
40951 components expanded to a-label form,
40952 and any certificate name checks will be done using the a-label
40953 form of the name.
40954
40955 .cindex log protocol
40956 .cindex SMTPUTF8 logging
40957 .cindex i18n logging
40958 Log lines and Received-by: header lines will acquire a "utf8"
40959 prefix on the protocol element, eg. utf8esmtp.
40960
40961 The following expansion operators can be used:
40962 .code
40963 ${utf8_domain_to_alabel:str}
40964 ${utf8_domain_from_alabel:str}
40965 ${utf8_localpart_to_alabel:str}
40966 ${utf8_localpart_from_alabel:str}
40967 .endd
40968
40969 .cindex utf8 "address downconversion"
40970 .cindex i18n "utf8 address downconversion"
40971 The RCPT ACL
40972 may use the following modifier:
40973 .display
40974 control = utf8_downconvert
40975 control = utf8_downconvert/<value>
40976 .endd
40977 This sets a flag requiring that addresses are converted to
40978 a-label form before smtp delivery, for use in a
40979 Message Submission Agent context.
40980 If a value is appended it may be:
40981 .display
40982 &`1  `& (default) mandatory downconversion
40983 &`0  `& no downconversion
40984 &`-1 `& if SMTPUTF8 not supported by destination host
40985 .endd
40986
40987 If mua_wrapper is set, the utf8_downconvert control
40988 is initially set to -1.
40989
40990 The smtp transport has an option &%utf8_downconvert%&.
40991 If set it must expand to one of the three values described above,
40992 and it overrides any previously set value.
40993
40994
40995 There is no explicit support for VRFY and EXPN.
40996 Configurations supporting these should inspect
40997 &$smtp_command_argument$& for an SMTPUTF8 argument.
40998
40999 There is no support for LMTP on Unix sockets.
41000 Using the "lmtp" protocol option on an smtp transport,
41001 for LMTP over TCP, should work as expected.
41002
41003 There is no support for DSN unitext handling,
41004 and no provision for converting logging from or to UTF-8.
41005
41006
41007
41008 .section "MDA operations" SECTi18nMDA
41009 To aid in constructing names suitable for IMAP folders
41010 the following expansion operator can be used:
41011 .code
41012 ${imapfolder {<string>} {<sep>} {<specials>}}
41013 .endd
41014
41015 The string is converted from the charset specified by
41016 the "headers charset" command (in a filter file)
41017 or &%headers_charset%& main configuration option (otherwise),
41018 to the
41019 modified UTF-7 encoding specified by RFC 2060,
41020 with the following exception: All occurrences of <sep>
41021 (which has to be a single character)
41022 are replaced with periods ("."), and all periods and slashes that are not
41023 <sep> and are not in the <specials> string are BASE64 encoded.
41024
41025 The third argument can be omitted, defaulting to an empty string.
41026 The second argument can be omitted, defaulting to "/".
41027
41028 This is the encoding used by Courier for Maildir names on disk, and followed
41029 by many other IMAP servers.
41030
41031 Examples:
41032 .display
41033 &`${imapfolder {Foo/Bar}}       `& yields &`Foo.Bar`&
41034 &`${imapfolder {Foo/Bar}{.}{/}} `& yields &`Foo&&AC8-Bar`&
41035 &`${imapfolder {Räksmörgås}}    `& yields &`R&&AOQ-ksm&&APY-rg&&AOU-s`&
41036 .endd
41037
41038 Note that the source charset setting is vital, and also that characters
41039 must be representable in UTF-16.
41040
41041
41042 . ////////////////////////////////////////////////////////////////////////////
41043 . ////////////////////////////////////////////////////////////////////////////
41044
41045 .chapter "Events" "CHAPevents" &&&
41046          "Events"
41047 .cindex events
41048
41049 The events mechanism in Exim can be used to intercept processing at a number
41050 of points.  It was originally invented to give a way to do customised logging
41051 actions (for example, to a database) but can also be used to modify some
41052 processing actions.
41053
41054 Most installations will never need to use Events.
41055 The support can be left out of a build by defining DISABLE_EVENT=yes
41056 in &_Local/Makefile_&.
41057
41058 There are two major classes of events: main and transport.
41059 The main configuration option &%event_action%& controls reception events;
41060 a transport option &%event_action%& controls delivery events.
41061
41062 Both options are a string which is expanded when the event fires.
41063 An example might look like:
41064 .cindex logging custom
41065 .code
41066 event_action = ${if eq {msg:delivery}{$event_name} \
41067 {${lookup pgsql {SELECT * FROM record_Delivery( \
41068     '${quote_pgsql:$sender_address_domain}',\
41069     '${quote_pgsql:${lc:$sender_address_local_part}}', \
41070     '${quote_pgsql:$domain}', \
41071     '${quote_pgsql:${lc:$local_part}}', \
41072     '${quote_pgsql:$host_address}', \
41073     '${quote_pgsql:${lc:$host}}', \
41074     '${quote_pgsql:$message_exim_id}')}} \
41075 } {}}
41076 .endd
41077
41078 Events have names which correspond to the point in process at which they fire.
41079 The name is placed in the variable &$event_name$& and the event action
41080 expansion must check this, as it will be called for every possible event type.
41081
41082 .new
41083 The current list of events is:
41084 .wen
41085 .display
41086 &`dane:fail              after    transport  `& per connection
41087 &`msg:complete           after    main       `& per message
41088 &`msg:delivery           after    transport  `& per recipient
41089 &`msg:rcpt:host:defer    after    transport  `& per recipient per host
41090 &`msg:rcpt:defer         after    transport  `& per recipient
41091 &`msg:host:defer         after    transport  `& per attempt
41092 &`msg:fail:delivery      after    transport  `& per recipient
41093 &`msg:fail:internal      after    main       `& per recipient
41094 &`tcp:connect            before   transport  `& per connection
41095 &`tcp:close              after    transport  `& per connection
41096 &`tls:cert               before   both       `& per certificate in verification chain
41097 &`smtp:connect           after    transport  `& per connection
41098 &`smtp:ehlo              after    transport  `& per connection
41099 .endd
41100 New event types may be added in future.
41101
41102 The event name is a colon-separated list, defining the type of
41103 event in a tree of possibilities.  It may be used as a list
41104 or just matched on as a whole.  There will be no spaces in the name.
41105
41106 The second column in the table above describes whether the event fires
41107 before or after the action is associates with.  Those which fire before
41108 can be used to affect that action (more on this below).
41109
41110 The third column in the table above says what section of the configuration
41111 should define the event action.
41112
41113 An additional variable, &$event_data$&, is filled with information varying
41114 with the event type:
41115 .display
41116 &`dane:fail            `& failure reason
41117 &`msg:delivery         `& smtp confirmation message
41118 &`msg:fail:internal    `& failure reason
41119 &`msg:fail:delivery    `& smtp error message
41120 &`msg:rcpt:host:defer  `& error string
41121 &`msg:rcpt:defer       `& error string
41122 &`msg:host:defer       `& error string
41123 &`tls:cert             `& verification chain depth
41124 &`smtp:connect         `& smtp banner
41125 &`smtp:ehlo            `& smtp ehlo response
41126 .endd
41127
41128 The :defer events populate one extra variable: &$event_defer_errno$&.
41129
41130 For complex operations an ACL expansion can be used in &%event_action%&
41131 however due to the multiple contexts that Exim operates in during
41132 the course of its processing:
41133 .ilist
41134 variables set in transport events will not be visible outside that
41135 transport call
41136 .next
41137 acl_m variables in a server context are lost on a new connection,
41138 and after smtp helo/ehlo/mail/starttls/rset commands
41139 .endlist
41140 Using an ACL expansion with the logwrite modifier can be
41141 a useful way of writing to the main log.
41142
41143 The expansion of the event_action option should normally
41144 return an empty string.  Should it return anything else the
41145 following will be forced:
41146 .display
41147 &`tcp:connect      `&  do not connect
41148 &`tls:cert         `&  refuse verification
41149 &`smtp:connect     `&  close connection
41150 .endd
41151 All other message types ignore the result string, and
41152 no other use is made of it.
41153
41154 For a tcp:connect event, if the connection is being made to a proxy
41155 then the address and port variables will be that of the proxy and not
41156 the target system.
41157
41158 For tls:cert events, if GnuTLS is in use this will trigger only per
41159 chain element received on the connection.
41160 For OpenSSL it will trigger for every chain element including those
41161 loaded locally.
41162
41163 . ////////////////////////////////////////////////////////////////////////////
41164 . ////////////////////////////////////////////////////////////////////////////
41165
41166 .chapter "Adding new drivers or lookup types" "CHID13" &&&
41167          "Adding drivers or lookups"
41168 .cindex "adding drivers"
41169 .cindex "new drivers, adding"
41170 .cindex "drivers" "adding new"
41171 The following actions have to be taken in order to add a new router, transport,
41172 authenticator, or lookup type to Exim:
41173
41174 .olist
41175 Choose a name for the driver or lookup type that does not conflict with any
41176 existing name; I will use &"newdriver"& in what follows.
41177 .next
41178 Add to &_src/EDITME_& the line:
41179 .display
41180 <&'type'&>&`_NEWDRIVER=yes`&
41181 .endd
41182 where <&'type'&> is ROUTER, TRANSPORT, AUTH, or LOOKUP. If the
41183 code is not to be included in the binary by default, comment this line out. You
41184 should also add any relevant comments about the driver or lookup type.
41185 .next
41186 Add to &_src/config.h.defaults_& the line:
41187 .code
41188 #define <type>_NEWDRIVER
41189 .endd
41190 .next
41191 Edit &_src/drtables.c_&, adding conditional code to pull in the private header
41192 and create a table entry as is done for all the other drivers and lookup types.
41193 .next
41194 Edit &_scripts/lookups-Makefile_& if this is a new lookup; there is a for-loop
41195 near the bottom, ranging the &`name_mod`& variable over a list of all lookups.
41196 Add your &`NEWDRIVER`& to that list.
41197 As long as the dynamic module would be named &_newdriver.so_&, you can use the
41198 simple form that most lookups have.
41199 .next
41200 Edit &_Makefile_& in the appropriate sub-directory (&_src/routers_&,
41201 &_src/transports_&, &_src/auths_&, or &_src/lookups_&); add a line for the new
41202 driver or lookup type and add it to the definition of OBJ.
41203 .next
41204 Edit &_OS/Makefile-Base_& adding a &_.o_& file for the predefined-macros, to the
41205 definition of OBJ_MACRO.  Add a set of line to do the compile also.
41206 .next
41207 Create &_newdriver.h_& and &_newdriver.c_& in the appropriate sub-directory of
41208 &_src_&.
41209 .next
41210 Edit &_scripts/MakeLinks_& and add commands to link the &_.h_& and &_.c_& files
41211 as for other drivers and lookups.
41212 .endlist
41213
41214 Then all you need to do is write the code! A good way to start is to make a
41215 proforma by copying an existing module of the same type, globally changing all
41216 occurrences of the name, and cutting out most of the code. Note that any
41217 options you create must be listed in alphabetical order, because the tables are
41218 searched using a binary chop procedure.
41219
41220 There is a &_README_& file in each of the sub-directories of &_src_& describing
41221 the interface that is expected.
41222
41223
41224
41225
41226 . ////////////////////////////////////////////////////////////////////////////
41227 . ////////////////////////////////////////////////////////////////////////////
41228
41229 . /////////////////////////////////////////////////////////////////////////////
41230 . These lines are processing instructions for the Simple DocBook Processor that
41231 . Philip Hazel has developed as a less cumbersome way of making PostScript and
41232 . PDFs than using xmlto and fop. They will be ignored by all other XML
41233 . processors.
41234 . /////////////////////////////////////////////////////////////////////////////
41235
41236 .literal xml
41237 <?sdop
41238   format="newpage"
41239   foot_right_recto="&chaptertitle;"
41240   foot_right_verso="&chaptertitle;"
41241 ?>
41242 .literal off
41243
41244 .makeindex "Options index"   "option"
41245 .makeindex "Variables index" "variable"
41246 .makeindex "Concept index"   "concept"
41247
41248
41249 . /////////////////////////////////////////////////////////////////////////////
41250 . /////////////////////////////////////////////////////////////////////////////