Docs: set message after conditions in ACL verb wherever possible
[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.93"
49 .include ./local_params
50
51 .set ACL "access control lists (ACLs)"
52 .set I   "&nbsp;&nbsp;&nbsp;&nbsp;"
53
54 .macro copyyear
55 2020
56 .endmacro
57
58 . /////////////////////////////////////////////////////////////////////////////
59 . Additional xfpt markup used by this document, over and above the default
60 . provided in the xfpt library.
61 . /////////////////////////////////////////////////////////////////////////////
62
63 . --- Override the &$ flag to automatically insert a $ with the variable name.
64
65 .flag &$  $&   "<varname>$"  "</varname>"
66
67 . --- Short flags for daggers in option headings. They will always be inside
68 . --- an italic string, but we want the daggers to be in Roman.
69
70 .flag &!!      "</emphasis>&dagger;<emphasis>"
71 .flag &!?      "</emphasis>&Dagger;<emphasis>"
72
73 . --- A macro for an Exim option definition heading, generating a one-line
74 . --- table with four columns. For cases when the option name is given with
75 . --- a space, so that it can be split, a fifth argument is used for the
76 . --- index entry.
77
78 .macro option
79 .arg 5
80 .oindex "&%$5%&"
81 .endarg
82 .arg -5
83 .oindex "&%$1%&"
84 .endarg
85 .itable all 0 0 4 8* left 6* center 6* center 6* right
86 .row "&%$1%&" "Use: &'$2'&" "Type: &'$3'&" "Default: &'$4'&"
87 .endtable
88 .endmacro
89
90 . --- A macro for the common 2-column tables. The width of the first column
91 . --- is suitable for the many tables at the start of the main options chapter;
92 . --- a small number of other 2-column tables override it.
93
94 .macro table2 196pt 254pt
95 .itable none 0 0 2 $1 left $2 left
96 .endmacro
97
98 . --- A macro that generates .row, but puts &I; at the start of the first
99 . --- argument, thus indenting it. Assume a minimum of two arguments, and
100 . --- allow up to four arguments, which is as many as we'll ever need.
101
102 .macro irow
103 .arg 4
104 .row "&I;$1" "$2" "$3" "$4"
105 .endarg
106 .arg -4
107 .arg 3
108 .row "&I;$1" "$2" "$3"
109 .endarg
110 .arg -3
111 .row "&I;$1" "$2"
112 .endarg
113 .endarg
114 .endmacro
115
116 . --- Macros for option, variable, and concept index entries. For a "range"
117 . --- style of entry, use .scindex for the start and .ecindex for the end. The
118 . --- first argument of .scindex and the only argument of .ecindex must be the
119 . --- ID that ties them together.
120
121 .macro cindex
122 &<indexterm role="concept">&
123 &<primary>&$1&</primary>&
124 .arg 2
125 &<secondary>&$2&</secondary>&
126 .endarg
127 &</indexterm>&
128 .endmacro
129
130 .macro scindex
131 &<indexterm role="concept" id="$1" class="startofrange">&
132 &<primary>&$2&</primary>&
133 .arg 3
134 &<secondary>&$3&</secondary>&
135 .endarg
136 &</indexterm>&
137 .endmacro
138
139 .macro ecindex
140 &<indexterm role="concept" startref="$1" class="endofrange"/>&
141 .endmacro
142
143 .macro oindex
144 &<indexterm role="option">&
145 &<primary>&$1&</primary>&
146 .arg 2
147 &<secondary>&$2&</secondary>&
148 .endarg
149 &</indexterm>&
150 .endmacro
151
152 .macro vindex
153 &<indexterm role="variable">&
154 &<primary>&$1&</primary>&
155 .arg 2
156 &<secondary>&$2&</secondary>&
157 .endarg
158 &</indexterm>&
159 .endmacro
160
161 .macro index
162 .echo "** Don't use .index; use .cindex or .oindex or .vindex"
163 .endmacro
164 . ////////////////////////////////////////////////////////////////////////////
165
166
167 . ////////////////////////////////////////////////////////////////////////////
168 . The <bookinfo> element is removed from the XML before processing for ASCII
169 . output formats.
170 . ////////////////////////////////////////////////////////////////////////////
171
172 .literal xml
173 <bookinfo>
174 <title>Specification of the Exim Mail Transfer Agent</title>
175 <titleabbrev>The Exim MTA</titleabbrev>
176 <date>
177 .fulldate
178 </date>
179 <author><firstname>Exim</firstname><surname>Maintainers</surname></author>
180 <authorinitials>EM</authorinitials>
181 <revhistory><revision>
182 .versiondatexml
183   <authorinitials>EM</authorinitials>
184 </revision></revhistory>
185 <copyright><year>
186 .copyyear
187            </year><holder>University of Cambridge</holder></copyright>
188 </bookinfo>
189 .literal off
190
191
192 . /////////////////////////////////////////////////////////////////////////////
193 . This chunk of literal XML implements index entries of the form "x, see y" and
194 . "x, see also y". However, the DocBook DTD doesn't allow <indexterm> entries
195 . at the top level, so we have to put the .chapter directive first.
196 . /////////////////////////////////////////////////////////////////////////////
197
198 .chapter "Introduction" "CHID1"
199 .literal xml
200
201 <indexterm role="variable">
202   <primary>$1, $2, etc.</primary>
203   <see><emphasis>numerical variables</emphasis></see>
204 </indexterm>
205 <indexterm role="concept">
206   <primary>address</primary>
207   <secondary>rewriting</secondary>
208   <see><emphasis>rewriting</emphasis></see>
209 </indexterm>
210 <indexterm role="concept">
211   <primary>Bounce Address Tag Validation</primary>
212   <see><emphasis>BATV</emphasis></see>
213 </indexterm>
214 <indexterm role="concept">
215   <primary>Client SMTP Authorization</primary>
216   <see><emphasis>CSA</emphasis></see>
217 </indexterm>
218 <indexterm role="concept">
219   <primary>CR character</primary>
220   <see><emphasis>carriage return</emphasis></see>
221 </indexterm>
222 <indexterm role="concept">
223   <primary>CRL</primary>
224   <see><emphasis>certificate revocation list</emphasis></see>
225 </indexterm>
226 <indexterm role="concept">
227   <primary>delivery</primary>
228   <secondary>failure report</secondary>
229   <see><emphasis>bounce message</emphasis></see>
230 </indexterm>
231 <indexterm role="concept">
232   <primary>dialup</primary>
233   <see><emphasis>intermittently connected hosts</emphasis></see>
234 </indexterm>
235 <indexterm role="concept">
236   <primary>exiscan</primary>
237   <see><emphasis>content scanning</emphasis></see>
238 </indexterm>
239 <indexterm role="concept">
240   <primary>failover</primary>
241   <see><emphasis>fallback</emphasis></see>
242 </indexterm>
243 <indexterm role="concept">
244   <primary>fallover</primary>
245   <see><emphasis>fallback</emphasis></see>
246 </indexterm>
247 <indexterm role="concept">
248   <primary>filter</primary>
249   <secondary>Sieve</secondary>
250   <see><emphasis>Sieve filter</emphasis></see>
251 </indexterm>
252 <indexterm role="concept">
253   <primary>ident</primary>
254   <see><emphasis>RFC 1413</emphasis></see>
255 </indexterm>
256 <indexterm role="concept">
257   <primary>LF character</primary>
258   <see><emphasis>linefeed</emphasis></see>
259 </indexterm>
260 <indexterm role="concept">
261   <primary>maximum</primary>
262   <seealso><emphasis>limit</emphasis></seealso>
263 </indexterm>
264 <indexterm role="concept">
265   <primary>monitor</primary>
266   <see><emphasis>Exim monitor</emphasis></see>
267 </indexterm>
268 <indexterm role="concept">
269   <primary>no_<emphasis>xxx</emphasis></primary>
270   <see>entry for xxx</see>
271 </indexterm>
272 <indexterm role="concept">
273   <primary>NUL</primary>
274   <see><emphasis>binary zero</emphasis></see>
275 </indexterm>
276 <indexterm role="concept">
277   <primary>passwd file</primary>
278   <see><emphasis>/etc/passwd</emphasis></see>
279 </indexterm>
280 <indexterm role="concept">
281   <primary>process id</primary>
282   <see><emphasis>pid</emphasis></see>
283 </indexterm>
284 <indexterm role="concept">
285   <primary>RBL</primary>
286   <see><emphasis>DNS list</emphasis></see>
287 </indexterm>
288 <indexterm role="concept">
289   <primary>redirection</primary>
290   <see><emphasis>address redirection</emphasis></see>
291 </indexterm>
292 <indexterm role="concept">
293   <primary>return path</primary>
294   <seealso><emphasis>envelope sender</emphasis></seealso>
295 </indexterm>
296 <indexterm role="concept">
297   <primary>scanning</primary>
298   <see><emphasis>content scanning</emphasis></see>
299 </indexterm>
300 <indexterm role="concept">
301   <primary>SSL</primary>
302   <see><emphasis>TLS</emphasis></see>
303 </indexterm>
304 <indexterm role="concept">
305   <primary>string</primary>
306   <secondary>expansion</secondary>
307   <see><emphasis>expansion</emphasis></see>
308 </indexterm>
309 <indexterm role="concept">
310   <primary>top bit</primary>
311   <see><emphasis>8-bit characters</emphasis></see>
312 </indexterm>
313 <indexterm role="concept">
314   <primary>variables</primary>
315   <see><emphasis>expansion, variables</emphasis></see>
316 </indexterm>
317 <indexterm role="concept">
318   <primary>zero, binary</primary>
319   <see><emphasis>binary zero</emphasis></see>
320 </indexterm>
321
322 .literal off
323
324
325 . /////////////////////////////////////////////////////////////////////////////
326 . This is the real start of the first chapter. See the comment above as to why
327 . we can't have the .chapter line here.
328 . chapter "Introduction"
329 . /////////////////////////////////////////////////////////////////////////////
330
331 Exim is a mail transfer agent (MTA) for hosts that are running Unix or
332 Unix-like operating systems. It was designed on the assumption that it would be
333 run on hosts that are permanently connected to the Internet. However, it can be
334 used on intermittently connected hosts with suitable configuration adjustments.
335
336 Configuration files currently exist for the following operating systems: AIX,
337 BSD/OS (aka BSDI), Darwin (Mac OS X), DGUX, Dragonfly, FreeBSD, GNU/Hurd,
338 GNU/Linux, HI-OSF (Hitachi), HI-UX, HP-UX, IRIX, MIPS RISCOS, NetBSD, OpenBSD,
339 OpenUNIX, QNX, SCO, SCO SVR4.2 (aka UNIX-SV), Solaris (aka SunOS5), SunOS4,
340 Tru64-Unix (formerly Digital UNIX, formerly DEC-OSF1), Ultrix, and UnixWare.
341 Some of these operating systems are no longer current and cannot easily be
342 tested, so the configuration files may no longer work in practice.
343
344 There are also configuration files for compiling Exim in the Cygwin environment
345 that can be installed on systems running Windows. However, this document does
346 not contain any information about running Exim in the Cygwin environment.
347
348 The terms and conditions for the use and distribution of Exim are contained in
349 the file &_NOTICE_&. Exim is distributed under the terms of the GNU General
350 Public Licence, a copy of which may be found in the file &_LICENCE_&.
351
352 The use, supply, or promotion of Exim for the purpose of sending bulk,
353 unsolicited electronic mail is incompatible with the basic aims of Exim,
354 which revolve around the free provision of a service that enhances the quality
355 of personal communications. The author of Exim regards indiscriminate
356 mass-mailing as an antisocial, irresponsible abuse of the Internet.
357
358 Exim owes a great deal to Smail 3 and its author, Ron Karr. Without the
359 experience of running and working on the Smail 3 code, I could never have
360 contemplated starting to write a new MTA. Many of the ideas and user interfaces
361 were originally taken from Smail 3, though the actual code of Exim is entirely
362 new, and has developed far beyond the initial concept.
363
364 Many people, both in Cambridge and around the world, have contributed to the
365 development and the testing of Exim, and to porting it to various operating
366 systems. I am grateful to them all. The distribution now contains a file called
367 &_ACKNOWLEDGMENTS_&, in which I have started recording the names of
368 contributors.
369
370
371 .section "Exim documentation" "SECID1"
372 . Keep this example change bar when updating the documentation!
373
374 .new
375 .cindex "documentation"
376 This edition of the Exim specification applies to version &version() of Exim.
377 Substantive changes from the &previousversion; edition are marked in some
378 renditions of this document; this paragraph is so marked if the rendition is
379 capable of showing a change indicator.
380 .wen
381
382 This document is very much a reference manual; it is not a tutorial. The reader
383 is expected to have some familiarity with the SMTP mail transfer protocol and
384 with general Unix system administration. Although there are some discussions
385 and examples in places, the information is mostly organized in a way that makes
386 it easy to look up, rather than in a natural order for sequential reading.
387 Furthermore, this manual aims to cover every aspect of Exim in detail, including
388 a number of rarely-used, special-purpose features that are unlikely to be of
389 very wide interest.
390
391 .cindex "books about Exim"
392 An &"easier"& discussion of Exim which provides more in-depth explanatory,
393 introductory, and tutorial material can be found in a book entitled &'The Exim
394 SMTP Mail Server'& (second edition, 2007), published by UIT Cambridge
395 (&url(https://www.uit.co.uk/exim-book/)).
396
397 The book also contains a chapter that gives a general introduction to SMTP and
398 Internet mail. Inevitably, however, the book is unlikely to be fully up-to-date
399 with the latest release of Exim. (Note that the earlier book about Exim,
400 published by O'Reilly, covers Exim 3, and many things have changed in Exim 4.)
401
402 .cindex "Debian" "information sources"
403 If you are using a Debian distribution of Exim, you will find information about
404 Debian-specific features in the file
405 &_/usr/share/doc/exim4-base/README.Debian_&.
406 The command &(man update-exim.conf)& is another source of Debian-specific
407 information.
408
409 .cindex "&_doc/NewStuff_&"
410 .cindex "&_doc/ChangeLog_&"
411 .cindex "change log"
412 As Exim develops, there may be features in newer versions that have not
413 yet made it into this document, which is updated only when the most significant
414 digit of the fractional part of the version number changes. Specifications of
415 new features that are not yet in this manual are placed in the file
416 &_doc/NewStuff_& in the Exim distribution.
417
418 Some features may be classified as &"experimental"&. These may change
419 incompatibly while they are developing, or even be withdrawn. For this reason,
420 they are not documented in this manual. Information about experimental features
421 can be found in the file &_doc/experimental.txt_&.
422
423 All changes to Exim (whether new features, bug fixes, or other kinds of
424 change) are noted briefly in the file called &_doc/ChangeLog_&.
425
426 .cindex "&_doc/spec.txt_&"
427 This specification itself is available as an ASCII file in &_doc/spec.txt_& so
428 that it can easily be searched with a text editor. Other files in the &_doc_&
429 directory are:
430
431 .table2 100pt
432 .row &_OptionLists.txt_&     "list of all options in alphabetical order"
433 .row &_dbm.discuss.txt_&     "discussion about DBM libraries"
434 .row &_exim.8_&              "a man page of Exim's command line options"
435 .row &_experimental.txt_&    "documentation of experimental features"
436 .row &_filter.txt_&          "specification of the filter language"
437 .row &_Exim3.upgrade_&       "upgrade notes from release 2 to release 3"
438 .row &_Exim4.upgrade_&       "upgrade notes from release 3 to release 4"
439 .row &_openssl.txt_&         "installing a current OpenSSL release"
440 .endtable
441
442 The main specification and the specification of the filtering language are also
443 available in other formats (HTML, PostScript, PDF, and Texinfo). Section
444 &<<SECTavail>>& below tells you how to get hold of these.
445
446
447
448 .section "FTP site and websites" "SECID2"
449 .cindex "website"
450 .cindex "FTP site"
451 The primary site for Exim source distributions is the &%exim.org%& FTP site,
452 available over HTTPS, HTTP and FTP.  These services, and the &%exim.org%&
453 website, are hosted at the University of Cambridge.
454
455 .cindex "wiki"
456 .cindex "FAQ"
457 As well as Exim distribution tar files, the Exim website contains a number of
458 differently formatted versions of the documentation. A recent addition to the
459 online information is the Exim wiki (&url(https://wiki.exim.org)),
460 which contains what used to be a separate FAQ, as well as various other
461 examples, tips, and know-how that have been contributed by Exim users.
462 The wiki site should always redirect to the correct place, which is currently
463 provided by GitHub, and is open to editing by anyone with a GitHub account.
464
465 .cindex Bugzilla
466 An Exim Bugzilla exists at &url(https://bugs.exim.org). You can use
467 this to report bugs, and also to add items to the wish list. Please search
468 first to check that you are not duplicating a previous entry.
469 Please do not ask for configuration help in the bug-tracker.
470
471
472 .section "Mailing lists" "SECID3"
473 .cindex "mailing lists" "for Exim users"
474 The following Exim mailing lists exist:
475
476 .table2 140pt
477 .row &'exim-announce@exim.org'&   "Moderated, low volume announcements list"
478 .row &'exim-users@exim.org'&      "General discussion list"
479 .row &'exim-dev@exim.org'&        "Discussion of bugs, enhancements, etc."
480 .row &'exim-cvs@exim.org'&        "Automated commit messages from the VCS"
481 .endtable
482
483 You can subscribe to these lists, change your existing subscriptions, and view
484 or search the archives via the mailing lists link on the Exim home page.
485 .cindex "Debian" "mailing list for"
486 If you are using a Debian distribution of Exim, you may wish to subscribe to
487 the Debian-specific mailing list &'pkg-exim4-users@lists.alioth.debian.org'&
488 via this web page:
489 .display
490 &url(https://alioth-lists.debian.net/cgi-bin/mailman/listinfo/pkg-exim4-users)
491 .endd
492 Please ask Debian-specific questions on that list and not on the general Exim
493 lists.
494
495 .section "Bug reports" "SECID5"
496 .cindex "bug reports"
497 .cindex "reporting bugs"
498 Reports of obvious bugs can be emailed to &'bugs@exim.org'& or reported
499 via the Bugzilla (&url(https://bugs.exim.org)). However, if you are unsure
500 whether some behaviour is a bug or not, the best thing to do is to post a
501 message to the &'exim-dev'& mailing list and have it discussed.
502
503
504
505 .section "Where to find the Exim distribution" "SECTavail"
506 .cindex "FTP site"
507 .cindex "HTTPS download site"
508 .cindex "distribution" "FTP site"
509 .cindex "distribution" "https site"
510 The master distribution site for the Exim distribution is
511 .display
512 &url(https://downloads.exim.org/)
513 .endd
514 The service is available over HTTPS, HTTP and FTP.
515 We encourage people to migrate to HTTPS.
516
517 The content served at &url(https://downloads.exim.org/) is identical to the
518 content served at &url(https://ftp.exim.org/pub/exim) and
519 &url(ftp://ftp.exim.org/pub/exim).
520
521 If accessing via a hostname containing &'ftp'&, then the file references that
522 follow are relative to the &_exim_& directories at these sites.
523 If accessing via the hostname &'downloads'& then the subdirectories described
524 here are top-level directories.
525
526 There are now quite a number of independent mirror sites around
527 the world. Those that I know about are listed in the file called &_Mirrors_&.
528
529 Within the top exim directory there are subdirectories called &_exim3_& (for
530 previous Exim 3 distributions), &_exim4_& (for the latest Exim 4
531 distributions), and &_Testing_& for testing versions. In the &_exim4_&
532 subdirectory, the current release can always be found in files called
533 .display
534 &_exim-n.nn.tar.xz_&
535 &_exim-n.nn.tar.gz_&
536 &_exim-n.nn.tar.bz2_&
537 .endd
538 where &'n.nn'& is the highest such version number in the directory. The three
539 files contain identical data; the only difference is the type of compression.
540 The &_.xz_& file is usually the smallest, while the &_.gz_& file is the
541 most portable to old systems.
542
543 .cindex "distribution" "signing details"
544 .cindex "distribution" "public key"
545 .cindex "public key for signed distribution"
546 The distributions will be PGP signed by an individual key of the Release
547 Coordinator.  This key will have a uid containing an email address in the
548 &'exim.org'& domain and will have signatures from other people, including
549 other Exim maintainers.  We expect that the key will be in the "strong set" of
550 PGP keys.  There should be a trust path to that key from the Exim Maintainer's
551 PGP keys, a version of which can be found in the release directory in the file
552 &_Exim-Maintainers-Keyring.asc_&.  All keys used will be available in public keyserver pools,
553 such as &'pool.sks-keyservers.net'&.
554
555 At the time of the last update, releases were being made by Jeremy Harris and signed
556 with key &'0xBCE58C8CE41F32DF'&.  Other recent keys used for signing are those
557 of Heiko Schlittermann, &'0x26101B62F69376CE'&,
558 and of Phil Pennock, &'0x4D1E900E14C1CC04'&.
559
560 The signatures for the tar bundles are in:
561 .display
562 &_exim-n.nn.tar.xz.asc_&
563 &_exim-n.nn.tar.gz.asc_&
564 &_exim-n.nn.tar.bz2.asc_&
565 .endd
566 For each released version, the log of changes is made available in a
567 separate file in the directory &_ChangeLogs_& so that it is possible to
568 find out what has changed without having to download the entire distribution.
569
570 .cindex "documentation" "available formats"
571 The main distribution contains ASCII versions of this specification and other
572 documentation; other formats of the documents are available in separate files
573 inside the &_exim4_& directory of the FTP site:
574 .display
575 &_exim-html-n.nn.tar.gz_&
576 &_exim-pdf-n.nn.tar.gz_&
577 &_exim-postscript-n.nn.tar.gz_&
578 &_exim-texinfo-n.nn.tar.gz_&
579 .endd
580 These tar files contain only the &_doc_& directory, not the complete
581 distribution, and are also available in &_.bz2_& and &_.xz_& forms.
582
583
584 .section "Limitations" "SECID6"
585 .ilist
586 .cindex "limitations of Exim"
587 .cindex "bang paths" "not handled by Exim"
588 Exim is designed for use as an Internet MTA, and therefore handles addresses in
589 RFC 2822 domain format only. It cannot handle UUCP &"bang paths"&, though
590 simple two-component bang paths can be converted by a straightforward rewriting
591 configuration. This restriction does not prevent Exim from being interfaced to
592 UUCP as a transport mechanism, provided that domain addresses are used.
593 .next
594 .cindex "domainless addresses"
595 .cindex "address" "without domain"
596 Exim insists that every address it handles has a domain attached. For incoming
597 local messages, domainless addresses are automatically qualified with a
598 configured domain value. Configuration options specify from which remote
599 systems unqualified addresses are acceptable. These are then qualified on
600 arrival.
601 .next
602 .cindex "transport" "external"
603 .cindex "external transports"
604 The only external transport mechanisms that are currently implemented are SMTP
605 and LMTP over a TCP/IP network (including support for IPv6). However, a pipe
606 transport is available, and there are facilities for writing messages to files
607 and pipes, optionally in &'batched SMTP'& format; these facilities can be used
608 to send messages to other transport mechanisms such as UUCP, provided they can
609 handle domain-style addresses. Batched SMTP input is also catered for.
610 .next
611 Exim is not designed for storing mail for dial-in hosts. When the volumes of
612 such mail are large, it is better to get the messages &"delivered"& into files
613 (that is, off Exim's queue) and subsequently passed on to the dial-in hosts by
614 other means.
615 .next
616 Although Exim does have basic facilities for scanning incoming messages, these
617 are not comprehensive enough to do full virus or spam scanning. Such operations
618 are best carried out using additional specialized software packages. If you
619 compile Exim with the content-scanning extension, straightforward interfaces to
620 a number of common scanners are provided.
621 .endlist
622
623
624 .section "Runtime configuration" "SECID7"
625 Exim's runtime configuration is held in a single text file that is divided
626 into a number of sections. The entries in this file consist of keywords and
627 values, in the style of Smail 3 configuration files. A default configuration
628 file which is suitable for simple online installations is provided in the
629 distribution, and is described in chapter &<<CHAPdefconfil>>& below.
630
631
632 .section "Calling interface" "SECID8"
633 .cindex "Sendmail compatibility" "command line interface"
634 Like many MTAs, Exim has adopted the Sendmail command line interface so that it
635 can be a straight replacement for &_/usr/lib/sendmail_& or
636 &_/usr/sbin/sendmail_& when sending mail, but you do not need to know anything
637 about Sendmail in order to run Exim. For actions other than sending messages,
638 Sendmail-compatible options also exist, but those that produce output (for
639 example, &%-bp%&, which lists the messages in the queue) do so in Exim's own
640 format. There are also some additional options that are compatible with Smail
641 3, and some further options that are new to Exim. Chapter &<<CHAPcommandline>>&
642 documents all Exim's command line options. This information is automatically
643 made into the man page that forms part of the Exim distribution.
644
645 Control of messages in the queue can be done via certain privileged command
646 line options. There is also an optional monitor program called &'eximon'&,
647 which displays current information in an X window, and which contains a menu
648 interface to Exim's command line administration options.
649
650
651
652 .section "Terminology" "SECID9"
653 .cindex "terminology definitions"
654 .cindex "body of message" "definition of"
655 The &'body'& of a message is the actual data that the sender wants to transmit.
656 It is the last part of a message and is separated from the &'header'& (see
657 below) by a blank line.
658
659 .cindex "bounce message" "definition of"
660 When a message cannot be delivered, it is normally returned to the sender in a
661 delivery failure message or a &"non-delivery report"& (NDR). The term
662 &'bounce'& is commonly used for this action, and the error reports are often
663 called &'bounce messages'&. This is a convenient shorthand for &"delivery
664 failure error report"&. Such messages have an empty sender address in the
665 message's &'envelope'& (see below) to ensure that they cannot themselves give
666 rise to further bounce messages.
667
668 The term &'default'& appears frequently in this manual. It is used to qualify a
669 value which is used in the absence of any setting in the configuration. It may
670 also qualify an action which is taken unless a configuration setting specifies
671 otherwise.
672
673 The term &'defer'& is used when the delivery of a message to a specific
674 destination cannot immediately take place for some reason (a remote host may be
675 down, or a user's local mailbox may be full). Such deliveries are &'deferred'&
676 until a later time.
677
678 The word &'domain'& is sometimes used to mean all but the first component of a
679 host's name. It is &'not'& used in that sense here, where it normally refers to
680 the part of an email address following the @ sign.
681
682 .cindex "envelope, definition of"
683 .cindex "sender" "definition of"
684 A message in transit has an associated &'envelope'&, as well as a header and a
685 body. The envelope contains a sender address (to which bounce messages should
686 be delivered), and any number of recipient addresses. References to the
687 sender or the recipients of a message usually mean the addresses in the
688 envelope. An MTA uses these addresses for delivery, and for returning bounce
689 messages, not the addresses that appear in the header lines.
690
691 .cindex "message" "header, definition of"
692 .cindex "header section" "definition of"
693 The &'header'& of a message is the first part of a message's text, consisting
694 of a number of lines, each of which has a name such as &'From:'&, &'To:'&,
695 &'Subject:'&, etc. Long header lines can be split over several text lines by
696 indenting the continuations. The header is separated from the body by a blank
697 line.
698
699 .cindex "local part" "definition of"
700 .cindex "domain" "definition of"
701 The term &'local part'&, which is taken from RFC 2822, is used to refer to the
702 part of an email address that precedes the @ sign. The part that follows the
703 @ sign is called the &'domain'& or &'mail domain'&.
704
705 .cindex "local delivery" "definition of"
706 .cindex "remote delivery, definition of"
707 The terms &'local delivery'& and &'remote delivery'& are used to distinguish
708 delivery to a file or a pipe on the local host from delivery by SMTP over
709 TCP/IP to another host. As far as Exim is concerned, all hosts other than the
710 host it is running on are &'remote'&.
711
712 .cindex "return path" "definition of"
713 &'Return path'& is another name that is used for the sender address in a
714 message's envelope.
715
716 .cindex "queue" "definition of"
717 The term &'queue'& is used to refer to the set of messages awaiting delivery
718 because this term is in widespread use in the context of MTAs. However, in
719 Exim's case, the reality is more like a pool than a queue, because there is
720 normally no ordering of waiting messages.
721
722 .cindex "queue runner" "definition of"
723 The term &'queue runner'& is used to describe a process that scans the queue
724 and attempts to deliver those messages whose retry times have come. This term
725 is used by other MTAs and also relates to the command &%runq%&, but in Exim
726 the waiting messages are normally processed in an unpredictable order.
727
728 .cindex "spool directory" "definition of"
729 The term &'spool directory'& is used for a directory in which Exim keeps the
730 messages in its queue &-- that is, those that it is in the process of
731 delivering. This should not be confused with the directory in which local
732 mailboxes are stored, which is called a &"spool directory"& by some people. In
733 the Exim documentation, &"spool"& is always used in the first sense.
734
735
736
737
738
739
740 . ////////////////////////////////////////////////////////////////////////////
741 . ////////////////////////////////////////////////////////////////////////////
742
743 .chapter "Incorporated code" "CHID2"
744 .cindex "incorporated code"
745 .cindex "regular expressions" "library"
746 .cindex "PCRE"
747 .cindex "OpenDMARC"
748 A number of pieces of external code are included in the Exim distribution.
749
750 .ilist
751 Regular expressions are supported in the main Exim program and in the
752 Exim monitor using the freely-distributable PCRE library, copyright
753 &copy; University of Cambridge. The source to PCRE is no longer shipped with
754 Exim, so you will need to use the version of PCRE shipped with your system,
755 or obtain and install the full version of the library from
756 &url(ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre).
757 .next
758 .cindex "cdb" "acknowledgment"
759 Support for the cdb (Constant DataBase) lookup method is provided by code
760 contributed by Nigel Metheringham of (at the time he contributed it) Planet
761 Online Ltd. The implementation is completely contained within the code of Exim.
762 It does not link against an external cdb library. The code contains the
763 following statements:
764
765 .blockquote
766 Copyright &copy; 1998 Nigel Metheringham, Planet Online Ltd
767
768 This program is free software; you can redistribute it and/or modify it under
769 the terms of the GNU General Public License as published by the Free Software
770 Foundation; either version 2 of the License, or (at your option) any later
771 version.
772 This code implements Dan Bernstein's Constant DataBase (cdb) spec. Information,
773 the spec and sample code for cdb can be obtained from
774 &url(https://cr.yp.to/cdb.html). This implementation borrows
775 some code from Dan Bernstein's implementation (which has no license
776 restrictions applied to it).
777 .endblockquote
778 .next
779 .cindex "SPA authentication"
780 .cindex "Samba project"
781 .cindex "Microsoft Secure Password Authentication"
782 Client support for Microsoft's &'Secure Password Authentication'& is provided
783 by code contributed by Marc Prud'hommeaux. Server support was contributed by
784 Tom Kistner. This includes code taken from the Samba project, which is released
785 under the Gnu GPL.
786 .next
787 .cindex "Cyrus"
788 .cindex "&'pwcheck'& daemon"
789 .cindex "&'pwauthd'& daemon"
790 Support for calling the Cyrus &'pwcheck'& and &'saslauthd'& daemons is provided
791 by code taken from the Cyrus-SASL library and adapted by Alexander S.
792 Sabourenkov. The permission notice appears below, in accordance with the
793 conditions expressed therein.
794
795 .blockquote
796 Copyright &copy; 2001 Carnegie Mellon University.  All rights reserved.
797
798 Redistribution and use in source and binary forms, with or without
799 modification, are permitted provided that the following conditions
800 are met:
801
802 .olist
803 Redistributions of source code must retain the above copyright
804 notice, this list of conditions and the following disclaimer.
805 .next
806 Redistributions in binary form must reproduce the above copyright
807 notice, this list of conditions and the following disclaimer in
808 the documentation and/or other materials provided with the
809 distribution.
810 .next
811 The name &"Carnegie Mellon University"& must not be used to
812 endorse or promote products derived from this software without
813 prior written permission. For permission or any other legal
814 details, please contact
815 .display
816               Office of Technology Transfer
817               Carnegie Mellon University
818               5000 Forbes Avenue
819               Pittsburgh, PA  15213-3890
820               (412) 268-4387, fax: (412) 268-7395
821               tech-transfer@andrew.cmu.edu
822 .endd
823 .next
824 Redistributions of any form whatsoever must retain the following
825 acknowledgment:
826
827 &"This product includes software developed by Computing Services
828 at Carnegie Mellon University (&url(https://www.cmu.edu/computing/)."&
829
830 CARNEGIE MELLON UNIVERSITY DISCLAIMS ALL WARRANTIES WITH REGARD TO
831 THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
832 AND FITNESS, IN NO EVENT SHALL CARNEGIE MELLON UNIVERSITY BE LIABLE
833 FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
834 WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN
835 AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING
836 OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
837 .endlist
838 .endblockquote
839
840 .next
841 .cindex "Exim monitor" "acknowledgment"
842 .cindex "X-windows"
843 .cindex "Athena"
844 The Exim Monitor program, which is an X-Window application, includes
845 modified versions of the Athena StripChart and TextPop widgets.
846 This code is copyright by DEC and MIT, and their permission notice appears
847 below, in accordance with the conditions expressed therein.
848
849 .blockquote
850 Copyright 1987, 1988 by Digital Equipment Corporation, Maynard, Massachusetts,
851 and the Massachusetts Institute of Technology, Cambridge, Massachusetts.
852
853 All Rights Reserved
854
855 Permission to use, copy, modify, and distribute this software and its
856 documentation for any purpose and without fee is hereby granted,
857 provided that the above copyright notice appear in all copies and that
858 both that copyright notice and this permission notice appear in
859 supporting documentation, and that the names of Digital or MIT not be
860 used in advertising or publicity pertaining to distribution of the
861 software without specific, written prior permission.
862
863 DIGITAL DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING
864 ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL
865 DIGITAL BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR
866 ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
867 WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION,
868 ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
869 SOFTWARE.
870 .endblockquote
871
872 .next
873 .cindex "opendmarc" "acknowledgment"
874 The DMARC implementation uses the OpenDMARC library which is Copyrighted by
875 The Trusted Domain Project. Portions of Exim source which use OpenDMARC
876 derived code are indicated in the respective source files. The full OpenDMARC
877 license is provided in the LICENSE.opendmarc file contained in the distributed
878 source code.
879
880 .next
881 Many people have contributed code fragments, some large, some small, that were
882 not covered by any specific license requirements. It is assumed that the
883 contributors are happy to see their code incorporated into Exim under the GPL.
884 .endlist
885
886
887
888
889
890 . ////////////////////////////////////////////////////////////////////////////
891 . ////////////////////////////////////////////////////////////////////////////
892
893 .chapter "How Exim receives and delivers mail" "CHID11" &&&
894          "Receiving and delivering mail"
895
896
897 .section "Overall philosophy" "SECID10"
898 .cindex "design philosophy"
899 Exim is designed to work efficiently on systems that are permanently connected
900 to the Internet and are handling a general mix of mail. In such circumstances,
901 most messages can be delivered immediately. Consequently, Exim does not
902 maintain independent queues of messages for specific domains or hosts, though
903 it does try to send several messages in a single SMTP connection after a host
904 has been down, and it also maintains per-host retry information.
905
906
907 .section "Policy control" "SECID11"
908 .cindex "policy control" "overview"
909 Policy controls are now an important feature of MTAs that are connected to the
910 Internet. Perhaps their most important job is to stop MTAs from being abused as
911 &"open relays"& by misguided individuals who send out vast amounts of
912 unsolicited junk and want to disguise its source. Exim provides flexible
913 facilities for specifying policy controls on incoming mail:
914
915 .ilist
916 .cindex "&ACL;" "introduction"
917 Exim 4 (unlike previous versions of Exim) implements policy controls on
918 incoming mail by means of &'Access Control Lists'& (ACLs). Each list is a
919 series of statements that may either grant or deny access. ACLs can be used at
920 several places in the SMTP dialogue while receiving a message from a remote
921 host. However, the most common places are after each RCPT command, and at the
922 very end of the message. The sysadmin can specify conditions for accepting or
923 rejecting individual recipients or the entire message, respectively, at these
924 two points (see chapter &<<CHAPACL>>&). Denial of access results in an SMTP
925 error code.
926 .next
927 An ACL is also available for locally generated, non-SMTP messages. In this
928 case, the only available actions are to accept or deny the entire message.
929 .next
930 When Exim is compiled with the content-scanning extension, facilities are
931 provided in the ACL mechanism for passing the message to external virus and/or
932 spam scanning software. The result of such a scan is passed back to the ACL,
933 which can then use it to decide what to do with the message.
934 .next
935 When a message has been received, either from a remote host or from the local
936 host, but before the final acknowledgment has been sent, a locally supplied C
937 function called &[local_scan()]& can be run to inspect the message and decide
938 whether to accept it or not (see chapter &<<CHAPlocalscan>>&). If the message
939 is accepted, the list of recipients can be modified by the function.
940 .next
941 Using the &[local_scan()]& mechanism is another way of calling external scanner
942 software. The &%SA-Exim%& add-on package works this way. It does not require
943 Exim to be compiled with the content-scanning extension.
944 .next
945 After a message has been accepted, a further checking mechanism is available in
946 the form of the &'system filter'& (see chapter &<<CHAPsystemfilter>>&). This
947 runs at the start of every delivery process.
948 .endlist
949
950
951
952 .section "User filters" "SECID12"
953 .cindex "filter" "introduction"
954 .cindex "Sieve filter"
955 In a conventional Exim configuration, users are able to run private filters by
956 setting up appropriate &_.forward_& files in their home directories. See
957 chapter &<<CHAPredirect>>& (about the &(redirect)& router) for the
958 configuration needed to support this, and the separate document entitled
959 &'Exim's interfaces to mail filtering'& for user details. Two different kinds
960 of filtering are available:
961
962 .ilist
963 Sieve filters are written in the standard filtering language that is defined
964 by RFC 3028.
965 .next
966 Exim filters are written in a syntax that is unique to Exim, but which is more
967 powerful than Sieve, which it pre-dates.
968 .endlist
969
970 User filters are run as part of the routing process, described below.
971
972
973
974 .section "Message identification" "SECTmessiden"
975 .cindex "message ids" "details of format"
976 .cindex "format" "of message id"
977 .cindex "id of message"
978 .cindex "base62"
979 .cindex "base36"
980 .cindex "Darwin"
981 .cindex "Cygwin"
982 Every message handled by Exim is given a &'message id'& which is sixteen
983 characters long. It is divided into three parts, separated by hyphens, for
984 example &`16VDhn-0001bo-D3`&. Each part is a sequence of letters and digits,
985 normally encoding numbers in base 62. However, in the Darwin operating
986 system (Mac OS X) and when Exim is compiled to run under Cygwin, base 36
987 (avoiding the use of lower case letters) is used instead, because the message
988 id is used to construct filenames, and the names of files in those systems are
989 not always case-sensitive.
990
991 .cindex "pid (process id)" "re-use of"
992 The detail of the contents of the message id have changed as Exim has evolved.
993 Earlier versions relied on the operating system not re-using a process id (pid)
994 within one second. On modern operating systems, this assumption can no longer
995 be made, so the algorithm had to be changed. To retain backward compatibility,
996 the format of the message id was retained, which is why the following rules are
997 somewhat eccentric:
998
999 .ilist
1000 The first six characters of the message id are the time at which the message
1001 started to be received, to a granularity of one second. That is, this field
1002 contains the number of seconds since the start of the epoch (the normal Unix
1003 way of representing the date and time of day).
1004 .next
1005 After the first hyphen, the next six characters are the id of the process that
1006 received the message.
1007 .next
1008 There are two different possibilities for the final two characters:
1009 .olist
1010 .oindex "&%localhost_number%&"
1011 If &%localhost_number%& is not set, this value is the fractional part of the
1012 time of reception, normally in units of 1/2000 of a second, but for systems
1013 that must use base 36 instead of base 62 (because of case-insensitive file
1014 systems), the units are 1/1000 of a second.
1015 .next
1016 If &%localhost_number%& is set, it is multiplied by 200 (100) and added to
1017 the fractional part of the time, which in this case is in units of 1/200
1018 (1/100) of a second.
1019 .endlist
1020 .endlist
1021
1022 After a message has been received, Exim waits for the clock to tick at the
1023 appropriate resolution before proceeding, so that if another message is
1024 received by the same process, or by another process with the same (re-used)
1025 pid, it is guaranteed that the time will be different. In most cases, the clock
1026 will already have ticked while the message was being received.
1027
1028
1029 .section "Receiving mail" "SECID13"
1030 .cindex "receiving mail"
1031 .cindex "message" "reception"
1032 The only way Exim can receive mail from another host is using SMTP over
1033 TCP/IP, in which case the sender and recipient addresses are transferred using
1034 SMTP commands. However, from a locally running process (such as a user's MUA),
1035 there are several possibilities:
1036
1037 .ilist
1038 If the process runs Exim with the &%-bm%& option, the message is read
1039 non-interactively (usually via a pipe), with the recipients taken from the
1040 command line, or from the body of the message if &%-t%& is also used.
1041 .next
1042 If the process runs Exim with the &%-bS%& option, the message is also read
1043 non-interactively, but in this case the recipients are listed at the start of
1044 the message in a series of SMTP RCPT commands, terminated by a DATA
1045 command. This is called &"batch SMTP"& format,
1046 but it isn't really SMTP. The SMTP commands are just another way of passing
1047 envelope addresses in a non-interactive submission.
1048 .next
1049 If the process runs Exim with the &%-bs%& option, the message is read
1050 interactively, using the SMTP protocol. A two-way pipe is normally used for
1051 passing data between the local process and the Exim process.
1052 This is &"real"& SMTP and is handled in the same way as SMTP over TCP/IP. For
1053 example, the ACLs for SMTP commands are used for this form of submission.
1054 .next
1055 A local process may also make a TCP/IP call to the host's loopback address
1056 (127.0.0.1) or any other of its IP addresses. When receiving messages, Exim
1057 does not treat the loopback address specially. It treats all such connections
1058 in the same way as connections from other hosts.
1059 .endlist
1060
1061
1062 .cindex "message sender, constructed by Exim"
1063 .cindex "sender" "constructed by Exim"
1064 In the three cases that do not involve TCP/IP, the sender address is
1065 constructed from the login name of the user that called Exim and a default
1066 qualification domain (which can be set by the &%qualify_domain%& configuration
1067 option). For local or batch SMTP, a sender address that is passed using the
1068 SMTP MAIL command is ignored. However, the system administrator may allow
1069 certain users (&"trusted users"&) to specify a different sender addresses
1070 unconditionally, or all users to specify certain forms of different sender
1071 address. The &%-f%& option or the SMTP MAIL command is used to specify these
1072 different addresses. See section &<<SECTtrustedadmin>>& for details of trusted
1073 users, and the &%untrusted_set_sender%& option for a way of allowing untrusted
1074 users to change sender addresses.
1075
1076 Messages received by either of the non-interactive mechanisms are subject to
1077 checking by the non-SMTP ACL if one is defined. Messages received using SMTP
1078 (either over TCP/IP or interacting with a local process) can be checked by a
1079 number of ACLs that operate at different times during the SMTP session. Either
1080 individual recipients or the entire message can be rejected if local policy
1081 requirements are not met. The &[local_scan()]& function (see chapter
1082 &<<CHAPlocalscan>>&) is run for all incoming messages.
1083
1084 Exim can be configured not to start a delivery process when a message is
1085 received; this can be unconditional, or depend on the number of incoming SMTP
1086 connections or the system load. In these situations, new messages wait on the
1087 queue until a queue runner process picks them up. However, in standard
1088 configurations under normal conditions, delivery is started as soon as a
1089 message is received.
1090
1091
1092
1093
1094
1095 .section "Handling an incoming message" "SECID14"
1096 .cindex "spool directory" "files that hold a message"
1097 .cindex "file" "how a message is held"
1098 When Exim accepts a message, it writes two files in its spool directory. The
1099 first contains the envelope information, the current status of the message, and
1100 the header lines, and the second contains the body of the message. The names of
1101 the two spool files consist of the message id, followed by &`-H`& for the
1102 file containing the envelope and header, and &`-D`& for the data file.
1103
1104 .cindex "spool directory" "&_input_& sub-directory"
1105 By default, all these message files are held in a single directory called
1106 &_input_& inside the general Exim spool directory. Some operating systems do
1107 not perform very well if the number of files in a directory gets large; to
1108 improve performance in such cases, the &%split_spool_directory%& option can be
1109 used. This causes Exim to split up the input files into 62 sub-directories
1110 whose names are single letters or digits. When this is done, the queue is
1111 processed one sub-directory at a time instead of all at once, which can improve
1112 overall performance even when there are not enough files in each directory to
1113 affect file system performance.
1114
1115 The envelope information consists of the address of the message's sender and
1116 the addresses of the recipients. This information is entirely separate from
1117 any addresses contained in the header lines. The status of the message includes
1118 a list of recipients who have already received the message. The format of the
1119 first spool file is described in chapter &<<CHAPspool>>&.
1120
1121 .cindex "rewriting" "addresses"
1122 Address rewriting that is specified in the rewrite section of the configuration
1123 (see chapter &<<CHAPrewrite>>&) is done once and for all on incoming addresses,
1124 both in the header lines and the envelope, at the time the message is accepted.
1125 If during the course of delivery additional addresses are generated (for
1126 example, via aliasing), these new addresses are rewritten as soon as they are
1127 generated. At the time a message is actually delivered (transported) further
1128 rewriting can take place; because this is a transport option, it can be
1129 different for different forms of delivery. It is also possible to specify the
1130 addition or removal of certain header lines at the time the message is
1131 delivered (see chapters &<<CHAProutergeneric>>& and
1132 &<<CHAPtransportgeneric>>&).
1133
1134
1135
1136 .section "Life of a message" "SECID15"
1137 .cindex "message" "life of"
1138 .cindex "message" "frozen"
1139 A message remains in the spool directory until it is completely delivered to
1140 its recipients or to an error address, or until it is deleted by an
1141 administrator or by the user who originally created it. In cases when delivery
1142 cannot proceed &-- for example when a message can neither be delivered to its
1143 recipients nor returned to its sender, the message is marked &"frozen"& on the
1144 spool, and no more deliveries are attempted.
1145
1146 .cindex "frozen messages" "thawing"
1147 .cindex "message" "thawing frozen"
1148 An administrator can &"thaw"& such messages when the problem has been
1149 corrected, and can also freeze individual messages by hand if necessary. In
1150 addition, an administrator can force a delivery error, causing a bounce message
1151 to be sent.
1152
1153 .oindex "&%timeout_frozen_after%&"
1154 .oindex "&%ignore_bounce_errors_after%&"
1155 There are options called &%ignore_bounce_errors_after%& and
1156 &%timeout_frozen_after%&, which discard frozen messages after a certain time.
1157 The first applies only to frozen bounces, the second to all frozen messages.
1158
1159 .cindex "message" "log file for"
1160 .cindex "log" "file for each message"
1161 While Exim is working on a message, it writes information about each delivery
1162 attempt to its main log file. This includes successful, unsuccessful, and
1163 delayed deliveries for each recipient (see chapter &<<CHAPlog>>&). The log
1164 lines are also written to a separate &'message log'& file for each message.
1165 These logs are solely for the benefit of the administrator and are normally
1166 deleted along with the spool files when processing of a message is complete.
1167 The use of individual message logs can be disabled by setting
1168 &%no_message_logs%&; this might give an improvement in performance on very busy
1169 systems.
1170
1171 .cindex "journal file"
1172 .cindex "file" "journal"
1173 All the information Exim itself needs to set up a delivery is kept in the first
1174 spool file, along with the header lines. When a successful delivery occurs, the
1175 address is immediately written at the end of a journal file, whose name is the
1176 message id followed by &`-J`&. At the end of a delivery run, if there are some
1177 addresses left to be tried again later, the first spool file (the &`-H`& file)
1178 is updated to indicate which these are, and the journal file is then deleted.
1179 Updating the spool file is done by writing a new file and renaming it, to
1180 minimize the possibility of data loss.
1181
1182 Should the system or Exim crash after a successful delivery but before
1183 the spool file has been updated, the journal is left lying around. The next
1184 time Exim attempts to deliver the message, it reads the journal file and
1185 updates the spool file before proceeding. This minimizes the chances of double
1186 deliveries caused by crashes.
1187
1188
1189
1190 .section "Processing an address for delivery" "SECTprocaddress"
1191 .cindex "drivers" "definition of"
1192 .cindex "router" "definition of"
1193 .cindex "transport" "definition of"
1194 The main delivery processing elements of Exim are called &'routers'& and
1195 &'transports'&, and collectively these are known as &'drivers'&. Code for a
1196 number of them is provided in the source distribution, and compile-time options
1197 specify which ones are included in the binary. Runtime options specify which
1198 ones are actually used for delivering messages.
1199
1200 .cindex "drivers" "instance definition"
1201 Each driver that is specified in the runtime configuration is an &'instance'&
1202 of that particular driver type. Multiple instances are allowed; for example,
1203 you can set up several different &(smtp)& transports, each with different
1204 option values that might specify different ports or different timeouts. Each
1205 instance has its own identifying name. In what follows we will normally use the
1206 instance name when discussing one particular instance (that is, one specific
1207 configuration of the driver), and the generic driver name when discussing
1208 the driver's features in general.
1209
1210 A &'router'& is a driver that operates on an address, either determining how
1211 its delivery should happen, by assigning it to a specific transport, or
1212 converting the address into one or more new addresses (for example, via an
1213 alias file). A router may also explicitly choose to fail an address, causing it
1214 to be bounced.
1215
1216 A &'transport'& is a driver that transmits a copy of the message from Exim's
1217 spool to some destination. There are two kinds of transport: for a &'local'&
1218 transport, the destination is a file or a pipe on the local host, whereas for a
1219 &'remote'& transport the destination is some other host. A message is passed
1220 to a specific transport as a result of successful routing. If a message has
1221 several recipients, it may be passed to a number of different transports.
1222
1223 .cindex "preconditions" "definition of"
1224 An address is processed by passing it to each configured router instance in
1225 turn, subject to certain preconditions, until a router accepts the address or
1226 specifies that it should be bounced. We will describe this process in more
1227 detail shortly. First, as a simple example, we consider how each recipient
1228 address in a message is processed in a small configuration of three routers.
1229
1230 To make this a more concrete example, it is described in terms of some actual
1231 routers, but remember, this is only an example. You can configure Exim's
1232 routers in many different ways, and there may be any number of routers in a
1233 configuration.
1234
1235 The first router that is specified in a configuration is often one that handles
1236 addresses in domains that are not recognized specifically by the local host.
1237 Typically these are addresses for arbitrary domains on the Internet. A precondition
1238 is set up which looks for the special domains known to the host (for example,
1239 its own domain name), and the router is run for addresses that do &'not'&
1240 match. Typically, this is a router that looks up domains in the DNS in order to
1241 find the hosts to which this address routes. If it succeeds, the address is
1242 assigned to a suitable SMTP transport; if it does not succeed, the router is
1243 configured to fail the address.
1244
1245 The second router is reached only when the domain is recognized as one that
1246 &"belongs"& to the local host. This router does redirection &-- also known as
1247 aliasing and forwarding. When it generates one or more new addresses from the
1248 original, each of them is routed independently from the start. Otherwise, the
1249 router may cause an address to fail, or it may simply decline to handle the
1250 address, in which case the address is passed to the next router.
1251
1252 The final router in many configurations is one that checks to see if the
1253 address belongs to a local mailbox. The precondition may involve a check to
1254 see if the local part is the name of a login account, or it may look up the
1255 local part in a file or a database. If its preconditions are not met, or if
1256 the router declines, we have reached the end of the routers. When this happens,
1257 the address is bounced.
1258
1259
1260
1261 .section "Processing an address for verification" "SECID16"
1262 .cindex "router" "for verification"
1263 .cindex "verifying address" "overview"
1264 As well as being used to decide how to deliver to an address, Exim's routers
1265 are also used for &'address verification'&. Verification can be requested as
1266 one of the checks to be performed in an ACL for incoming messages, on both
1267 sender and recipient addresses, and it can be tested using the &%-bv%& and
1268 &%-bvs%& command line options.
1269
1270 When an address is being verified, the routers are run in &"verify mode"&. This
1271 does not affect the way the routers work, but it is a state that can be
1272 detected. By this means, a router can be skipped or made to behave differently
1273 when verifying. A common example is a configuration in which the first router
1274 sends all messages to a message-scanning program unless they have been
1275 previously scanned. Thus, the first router accepts all addresses without any
1276 checking, making it useless for verifying. Normally, the &%no_verify%& option
1277 would be set for such a router, causing it to be skipped in verify mode.
1278
1279
1280
1281
1282 .section "Running an individual router" "SECTrunindrou"
1283 .cindex "router" "running details"
1284 .cindex "preconditions" "checking"
1285 .cindex "router" "result of running"
1286 As explained in the example above, a number of preconditions are checked before
1287 running a router. If any are not met, the router is skipped, and the address is
1288 passed to the next router. When all the preconditions on a router &'are'& met,
1289 the router is run. What happens next depends on the outcome, which is one of
1290 the following:
1291
1292 .ilist
1293 &'accept'&: The router accepts the address, and either assigns it to a
1294 transport or generates one or more &"child"& addresses. Processing the
1295 original address ceases
1296 .oindex "&%unseen%&"
1297 unless the &%unseen%& option is set on the router. This option
1298 can be used to set up multiple deliveries with different routing (for example,
1299 for keeping archive copies of messages). When &%unseen%& is set, the address is
1300 passed to the next router. Normally, however, an &'accept'& return marks the
1301 end of routing.
1302
1303 Any child addresses generated by the router are processed independently,
1304 starting with the first router by default. It is possible to change this by
1305 setting the &%redirect_router%& option to specify which router to start at for
1306 child addresses. Unlike &%pass_router%& (see below) the router specified by
1307 &%redirect_router%& may be anywhere in the router configuration.
1308 .next
1309 &'pass'&: The router recognizes the address, but cannot handle it itself. It
1310 requests that the address be passed to another router. By default, the address
1311 is passed to the next router, but this can be changed by setting the
1312 &%pass_router%& option. However, (unlike &%redirect_router%&) the named router
1313 must be below the current router (to avoid loops).
1314 .next
1315 &'decline'&: The router declines to accept the address because it does not
1316 recognize it at all. By default, the address is passed to the next router, but
1317 this can be prevented by setting the &%no_more%& option. When &%no_more%& is
1318 set, all the remaining routers are skipped. In effect, &%no_more%& converts
1319 &'decline'& into &'fail'&.
1320 .next
1321 &'fail'&: The router determines that the address should fail, and queues it for
1322 the generation of a bounce message. There is no further processing of the
1323 original address unless &%unseen%& is set on the router.
1324 .next
1325 &'defer'&: The router cannot handle the address at the present time. (A
1326 database may be offline, or a DNS lookup may have timed out.) No further
1327 processing of the address happens in this delivery attempt. It is tried again
1328 next time the message is considered for delivery.
1329 .next
1330 &'error'&: There is some error in the router (for example, a syntax error in
1331 its configuration). The action is as for defer.
1332 .endlist
1333
1334 If an address reaches the end of the routers without having been accepted by
1335 any of them, it is bounced as unrouteable. The default error message in this
1336 situation is &"unrouteable address"&, but you can set your own message by
1337 making use of the &%cannot_route_message%& option. This can be set for any
1338 router; the value from the last router that &"saw"& the address is used.
1339
1340 Sometimes while routing you want to fail a delivery when some conditions are
1341 met but others are not, instead of passing the address on for further routing.
1342 You can do this by having a second router that explicitly fails the delivery
1343 when the relevant conditions are met. The &(redirect)& router has a &"fail"&
1344 facility for this purpose.
1345
1346
1347 .section "Duplicate addresses" "SECID17"
1348 .cindex "case of local parts"
1349 .cindex "address duplicate, discarding"
1350 .cindex "duplicate addresses"
1351 Once routing is complete, Exim scans the addresses that are assigned to local
1352 and remote transports and discards any duplicates that it finds. During this
1353 check, local parts are treated case-sensitively. This happens only when
1354 actually delivering a message; when testing routers with &%-bt%&, all the
1355 routed addresses are shown.
1356
1357
1358
1359 .section "Router preconditions" "SECTrouprecon"
1360 .cindex "router" "preconditions, order of processing"
1361 .cindex "preconditions" "order of processing"
1362 The preconditions that are tested for each router are listed below, in the
1363 order in which they are tested. The individual configuration options are
1364 described in more detail in chapter &<<CHAProutergeneric>>&.
1365
1366 .ilist
1367 .cindex affix "router precondition"
1368 The &%local_part_prefix%& and &%local_part_suffix%& options can specify that
1369 the local parts handled by the router may or must have certain prefixes and/or
1370 suffixes. If a mandatory affix (prefix or suffix) is not present, the router is
1371 skipped. These conditions are tested first. When an affix is present, it is
1372 removed from the local part before further processing, including the evaluation
1373 of any other conditions.
1374 .next
1375 Routers can be designated for use only when not verifying an address, that is,
1376 only when routing it for delivery (or testing its delivery routing). If the
1377 &%verify%& option is set false, the router is skipped when Exim is verifying an
1378 address.
1379 Setting the &%verify%& option actually sets two options, &%verify_sender%& and
1380 &%verify_recipient%&, which independently control the use of the router for
1381 sender and recipient verification. You can set these options directly if
1382 you want a router to be used for only one type of verification.
1383 Note that cutthrough delivery is classed as a recipient verification for this purpose.
1384 .next
1385 If the &%address_test%& option is set false, the router is skipped when Exim is
1386 run with the &%-bt%& option to test an address routing. This can be helpful
1387 when the first router sends all new messages to a scanner of some sort; it
1388 makes it possible to use &%-bt%& to test subsequent delivery routing without
1389 having to simulate the effect of the scanner.
1390 .next
1391 Routers can be designated for use only when verifying an address, as
1392 opposed to routing it for delivery. The &%verify_only%& option controls this.
1393 Again, cutthrough delivery counts as a verification.
1394 .next
1395 Individual routers can be explicitly skipped when running the routers to
1396 check an address given in the SMTP EXPN command (see the &%expn%& option).
1397 .next
1398 If the &%domains%& option is set, the domain of the address must be in the set
1399 of domains that it defines.
1400 .next
1401 .vindex "&$local_part_prefix$&"
1402 .vindex "&$local_part_prefix_v$&"
1403 .vindex "&$local_part$&"
1404 .vindex "&$local_part_suffix$&"
1405 .vindex "&$local_part_suffix_v$&"
1406 .cindex affix "router precondition"
1407 If the &%local_parts%& option is set, the local part of the address must be in
1408 the set of local parts that it defines. If &%local_part_prefix%& or
1409 &%local_part_suffix%& is in use, the prefix or suffix is removed from the local
1410 part before this check. If you want to do precondition tests on local parts
1411 that include affixes, you can do so by using a &%condition%& option (see below)
1412 .new
1413 that uses the variables &$local_part$&, &$local_part_prefix$&,
1414 &$local_part_prefix_v$&, &$local_part_suffix$&
1415 and &$local_part_suffix_v$& as necessary.
1416 .wen
1417 .next
1418 .vindex "&$local_user_uid$&"
1419 .vindex "&$local_user_gid$&"
1420 .vindex "&$home$&"
1421 If the &%check_local_user%& option is set, the local part must be the name of
1422 an account on the local host. If this check succeeds, the uid and gid of the
1423 local user are placed in &$local_user_uid$& and &$local_user_gid$& and the
1424 user's home directory is placed in &$home$&; these values can be used in the
1425 remaining preconditions.
1426 .next
1427 If the &%router_home_directory%& option is set, it is expanded at this point,
1428 because it overrides the value of &$home$&. If this expansion were left till
1429 later, the value of &$home$& as set by &%check_local_user%& would be used in
1430 subsequent tests. Having two different values of &$home$& in the same router
1431 could lead to confusion.
1432 .next
1433 If the &%senders%& option is set, the envelope sender address must be in the
1434 set of addresses that it defines.
1435 .next
1436 If the &%require_files%& option is set, the existence or non-existence of
1437 specified files is tested.
1438 .next
1439 .cindex "customizing" "precondition"
1440 If the &%condition%& option is set, it is evaluated and tested. This option
1441 uses an expanded string to allow you to set up your own custom preconditions.
1442 Expanded strings are described in chapter &<<CHAPexpand>>&.
1443 .endlist
1444
1445
1446 Note that &%require_files%& comes near the end of the list, so you cannot use
1447 it to check for the existence of a file in which to lookup up a domain, local
1448 part, or sender. However, as these options are all expanded, you can use the
1449 &%exists%& expansion condition to make such tests within each condition. The
1450 &%require_files%& option is intended for checking files that the router may be
1451 going to use internally, or which are needed by a specific transport (for
1452 example, &_.procmailrc_&).
1453
1454
1455
1456 .section "Delivery in detail" "SECID18"
1457 .cindex "delivery" "in detail"
1458 When a message is to be delivered, the sequence of events is as follows:
1459
1460 .ilist
1461 If a system-wide filter file is specified, the message is passed to it. The
1462 filter may add recipients to the message, replace the recipients, discard the
1463 message, cause a new message to be generated, or cause the message delivery to
1464 fail. The format of the system filter file is the same as for Exim user filter
1465 files, described in the separate document entitled &'Exim's interfaces to mail
1466 filtering'&.
1467 .cindex "Sieve filter" "not available for system filter"
1468 (&*Note*&: Sieve cannot be used for system filter files.)
1469
1470 Some additional features are available in system filters &-- see chapter
1471 &<<CHAPsystemfilter>>& for details. Note that a message is passed to the system
1472 filter only once per delivery attempt, however many recipients it has. However,
1473 if there are several delivery attempts because one or more addresses could not
1474 be immediately delivered, the system filter is run each time. The filter
1475 condition &%first_delivery%& can be used to detect the first run of the system
1476 filter.
1477 .next
1478 Each recipient address is offered to each configured router, in turn, subject to
1479 its preconditions, until one is able to handle it. If no router can handle the
1480 address, that is, if they all decline, the address is failed. Because routers
1481 can be targeted at particular domains, several locally handled domains can be
1482 processed entirely independently of each other.
1483 .next
1484 .cindex "routing" "loops in"
1485 .cindex "loop" "while routing"
1486 A router that accepts an address may assign it to a local or a remote
1487 transport. However, the transport is not run at this time. Instead, the address
1488 is placed on a list for the particular transport, which will be run later.
1489 Alternatively, the router may generate one or more new addresses (typically
1490 from alias, forward, or filter files). New addresses are fed back into this
1491 process from the top, but in order to avoid loops, a router ignores any address
1492 which has an identically-named ancestor that was processed by itself.
1493 .next
1494 When all the routing has been done, addresses that have been successfully
1495 handled are passed to their assigned transports. When local transports are
1496 doing real local deliveries, they handle only one address at a time, but if a
1497 local transport is being used as a pseudo-remote transport (for example, to
1498 collect batched SMTP messages for transmission by some other means) multiple
1499 addresses can be handled. Remote transports can always handle more than one
1500 address at a time, but can be configured not to do so, or to restrict multiple
1501 addresses to the same domain.
1502 .next
1503 Each local delivery to a file or a pipe runs in a separate process under a
1504 non-privileged uid, and these deliveries are run one at a time. Remote
1505 deliveries also run in separate processes, normally under a uid that is private
1506 to Exim (&"the Exim user"&), but in this case, several remote deliveries can be
1507 run in parallel. The maximum number of simultaneous remote deliveries for any
1508 one message is set by the &%remote_max_parallel%& option.
1509 The order in which deliveries are done is not defined, except that all local
1510 deliveries happen before any remote deliveries.
1511 .next
1512 .cindex "queue runner"
1513 When it encounters a local delivery during a queue run, Exim checks its retry
1514 database to see if there has been a previous temporary delivery failure for the
1515 address before running the local transport. If there was a previous failure,
1516 Exim does not attempt a new delivery until the retry time for the address is
1517 reached. However, this happens only for delivery attempts that are part of a
1518 queue run. Local deliveries are always attempted when delivery immediately
1519 follows message reception, even if retry times are set for them. This makes for
1520 better behaviour if one particular message is causing problems (for example,
1521 causing quota overflow, or provoking an error in a filter file).
1522 .next
1523 .cindex "delivery" "retry in remote transports"
1524 Remote transports do their own retry handling, since an address may be
1525 deliverable to one of a number of hosts, each of which may have a different
1526 retry time. If there have been previous temporary failures and no host has
1527 reached its retry time, no delivery is attempted, whether in a queue run or
1528 not. See chapter &<<CHAPretry>>& for details of retry strategies.
1529 .next
1530 If there were any permanent errors, a bounce message is returned to an
1531 appropriate address (the sender in the common case), with details of the error
1532 for each failing address. Exim can be configured to send copies of bounce
1533 messages to other addresses.
1534 .next
1535 .cindex "delivery" "deferral"
1536 If one or more addresses suffered a temporary failure, the message is left on
1537 the queue, to be tried again later. Delivery of these addresses is said to be
1538 &'deferred'&.
1539 .next
1540 When all the recipient addresses have either been delivered or bounced,
1541 handling of the message is complete. The spool files and message log are
1542 deleted, though the message log can optionally be preserved if required.
1543 .endlist
1544
1545
1546
1547
1548 .section "Retry mechanism" "SECID19"
1549 .cindex "delivery" "retry mechanism"
1550 .cindex "retry" "description of mechanism"
1551 .cindex "queue runner"
1552 Exim's mechanism for retrying messages that fail to get delivered at the first
1553 attempt is the queue runner process. You must either run an Exim daemon that
1554 uses the &%-q%& option with a time interval to start queue runners at regular
1555 intervals or use some other means (such as &'cron'&) to start them. If you do
1556 not arrange for queue runners to be run, messages that fail temporarily at the
1557 first attempt will remain in your queue forever. A queue runner process works
1558 its way through the queue, one message at a time, trying each delivery that has
1559 passed its retry time.
1560 You can run several queue runners at once.
1561
1562 Exim uses a set of configured rules to determine when next to retry the failing
1563 address (see chapter &<<CHAPretry>>&). These rules also specify when Exim
1564 should give up trying to deliver to the address, at which point it generates a
1565 bounce message. If no retry rules are set for a particular host, address, and
1566 error combination, no retries are attempted, and temporary errors are treated
1567 as permanent.
1568
1569
1570
1571 .section "Temporary delivery failure" "SECID20"
1572 .cindex "delivery" "temporary failure"
1573 There are many reasons why a message may not be immediately deliverable to a
1574 particular address. Failure to connect to a remote machine (because it, or the
1575 connection to it, is down) is one of the most common. Temporary failures may be
1576 detected during routing as well as during the transport stage of delivery.
1577 Local deliveries may be delayed if NFS files are unavailable, or if a mailbox
1578 is on a file system where the user is over quota. Exim can be configured to
1579 impose its own quotas on local mailboxes; where system quotas are set they will
1580 also apply.
1581
1582 If a host is unreachable for a period of time, a number of messages may be
1583 waiting for it by the time it recovers, and sending them in a single SMTP
1584 connection is clearly beneficial. Whenever a delivery to a remote host is
1585 deferred,
1586 .cindex "hints database" "deferred deliveries"
1587 Exim makes a note in its hints database, and whenever a successful
1588 SMTP delivery has happened, it looks to see if any other messages are waiting
1589 for the same host. If any are found, they are sent over the same SMTP
1590 connection, subject to a configuration limit as to the maximum number in any
1591 one connection.
1592
1593
1594
1595 .section "Permanent delivery failure" "SECID21"
1596 .cindex "delivery" "permanent failure"
1597 .cindex "bounce message" "when generated"
1598 When a message cannot be delivered to some or all of its intended recipients, a
1599 bounce message is generated. Temporary delivery failures turn into permanent
1600 errors when their timeout expires. All the addresses that fail in a given
1601 delivery attempt are listed in a single message. If the original message has
1602 many recipients, it is possible for some addresses to fail in one delivery
1603 attempt and others to fail subsequently, giving rise to more than one bounce
1604 message. The wording of bounce messages can be customized by the administrator.
1605 See chapter &<<CHAPemsgcust>>& for details.
1606
1607 .cindex "&'X-Failed-Recipients:'& header line"
1608 Bounce messages contain an &'X-Failed-Recipients:'& header line that lists the
1609 failed addresses, for the benefit of programs that try to analyse such messages
1610 automatically.
1611
1612 .cindex "bounce message" "recipient of"
1613 A bounce message is normally sent to the sender of the original message, as
1614 obtained from the message's envelope. For incoming SMTP messages, this is the
1615 address given in the MAIL command. However, when an address is expanded via a
1616 forward or alias file, an alternative address can be specified for delivery
1617 failures of the generated addresses. For a mailing list expansion (see section
1618 &<<SECTmailinglists>>&) it is common to direct bounce messages to the manager
1619 of the list.
1620
1621
1622
1623 .section "Failures to deliver bounce messages" "SECID22"
1624 .cindex "bounce message" "failure to deliver"
1625 If a bounce message (either locally generated or received from a remote host)
1626 itself suffers a permanent delivery failure, the message is left in the queue,
1627 but it is frozen, awaiting the attention of an administrator. There are options
1628 that can be used to make Exim discard such failed messages, or to keep them
1629 for only a short time (see &%timeout_frozen_after%& and
1630 &%ignore_bounce_errors_after%&).
1631
1632
1633
1634
1635
1636 . ////////////////////////////////////////////////////////////////////////////
1637 . ////////////////////////////////////////////////////////////////////////////
1638
1639 .chapter "Building and installing Exim" "CHID3"
1640 .scindex IIDbuex "building Exim"
1641
1642 .section "Unpacking" "SECID23"
1643 Exim is distributed as a gzipped or bzipped tar file which, when unpacked,
1644 creates a directory with the name of the current release (for example,
1645 &_exim-&version()_&) into which the following files are placed:
1646
1647 .table2 140pt
1648 .irow &_ACKNOWLEDGMENTS_& "contains some acknowledgments"
1649 .irow &_CHANGES_&         "contains a reference to where changes are &&&
1650   documented"
1651 .irow &_LICENCE_&         "the GNU General Public Licence"
1652 .irow &_Makefile_&        "top-level make file"
1653 .irow &_NOTICE_&          "conditions for the use of Exim"
1654 .irow &_README_&          "list of files, directories and simple build &&&
1655   instructions"
1656 .endtable
1657
1658 Other files whose names begin with &_README_& may also be present. The
1659 following subdirectories are created:
1660
1661 .table2 140pt
1662 .irow &_Local_&           "an empty directory for local configuration files"
1663 .irow &_OS_&              "OS-specific files"
1664 .irow &_doc_&             "documentation files"
1665 .irow &_exim_monitor_&    "source files for the Exim monitor"
1666 .irow &_scripts_&         "scripts used in the build process"
1667 .irow &_src_&             "remaining source files"
1668 .irow &_util_&            "independent utilities"
1669 .endtable
1670
1671 The main utility programs are contained in the &_src_& directory and are built
1672 with the Exim binary. The &_util_& directory contains a few optional scripts
1673 that may be useful to some sites.
1674
1675
1676 .section "Multiple machine architectures and operating systems" "SECID24"
1677 .cindex "building Exim" "multiple OS/architectures"
1678 The building process for Exim is arranged to make it easy to build binaries for
1679 a number of different architectures and operating systems from the same set of
1680 source files. Compilation does not take place in the &_src_& directory.
1681 Instead, a &'build directory'& is created for each architecture and operating
1682 system.
1683 .cindex "symbolic link" "to build directory"
1684 Symbolic links to the sources are installed in this directory, which is where
1685 the actual building takes place. In most cases, Exim can discover the machine
1686 architecture and operating system for itself, but the defaults can be
1687 overridden if necessary.
1688 .cindex compiler requirements
1689 .cindex compiler version
1690 A C99-capable compiler will be required for the build.
1691
1692
1693 .section "PCRE library" "SECTpcre"
1694 .cindex "PCRE library"
1695 Exim no longer has an embedded PCRE library as the vast majority of
1696 modern systems include PCRE as a system library, although you may need to
1697 install the PCRE package or the PCRE development package for your operating
1698 system. If your system has a normal PCRE installation the Exim build
1699 process will need no further configuration. If the library or the
1700 headers are in an unusual location you will need to either set the PCRE_LIBS
1701 and INCLUDE directives appropriately,
1702 or set PCRE_CONFIG=yes to use the installed &(pcre-config)& command.
1703 If your operating system has no
1704 PCRE support then you will need to obtain and build the current PCRE
1705 from &url(ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre/).
1706 More information on PCRE is available at &url(https://www.pcre.org/).
1707
1708 .section "DBM libraries" "SECTdb"
1709 .cindex "DBM libraries" "discussion of"
1710 .cindex "hints database" "DBM files used for"
1711 Even if you do not use any DBM files in your configuration, Exim still needs a
1712 DBM library in order to operate, because it uses indexed files for its hints
1713 databases. Unfortunately, there are a number of DBM libraries in existence, and
1714 different operating systems often have different ones installed.
1715
1716 .cindex "Solaris" "DBM library for"
1717 .cindex "IRIX, DBM library for"
1718 .cindex "BSD, DBM library for"
1719 .cindex "Linux, DBM library for"
1720 If you are using Solaris, IRIX, one of the modern BSD systems, or a modern
1721 Linux distribution, the DBM configuration should happen automatically, and you
1722 may be able to ignore this section. Otherwise, you may have to learn more than
1723 you would like about DBM libraries from what follows.
1724
1725 .cindex "&'ndbm'& DBM library"
1726 Licensed versions of Unix normally contain a library of DBM functions operating
1727 via the &'ndbm'& interface, and this is what Exim expects by default. Free
1728 versions of Unix seem to vary in what they contain as standard. In particular,
1729 some early versions of Linux have no default DBM library, and different
1730 distributors have chosen to bundle different libraries with their packaged
1731 versions. However, the more recent releases seem to have standardized on the
1732 Berkeley DB library.
1733
1734 Different DBM libraries have different conventions for naming the files they
1735 use. When a program opens a file called &_dbmfile_&, there are several
1736 possibilities:
1737
1738 .olist
1739 A traditional &'ndbm'& implementation, such as that supplied as part of
1740 Solaris, operates on two files called &_dbmfile.dir_& and &_dbmfile.pag_&.
1741 .next
1742 .cindex "&'gdbm'& DBM library"
1743 The GNU library, &'gdbm'&, operates on a single file. If used via its &'ndbm'&
1744 compatibility interface it makes two different hard links to it with names
1745 &_dbmfile.dir_& and &_dbmfile.pag_&, but if used via its native interface, the
1746 filename is used unmodified.
1747 .next
1748 .cindex "Berkeley DB library"
1749 The Berkeley DB package, if called via its &'ndbm'& compatibility interface,
1750 operates on a single file called &_dbmfile.db_&, but otherwise looks to the
1751 programmer exactly the same as the traditional &'ndbm'& implementation.
1752 .next
1753 If the Berkeley package is used in its native mode, it operates on a single
1754 file called &_dbmfile_&; the programmer's interface is somewhat different to
1755 the traditional &'ndbm'& interface.
1756 .next
1757 To complicate things further, there are several very different versions of the
1758 Berkeley DB package. Version 1.85 was stable for a very long time, releases
1759 2.&'x'& and 3.&'x'& were current for a while, but the latest versions when Exim last revamped support were numbered 4.&'x'&.
1760 Maintenance of some of the earlier releases has ceased. All versions of
1761 Berkeley DB could be obtained from
1762 &url(http://www.sleepycat.com/), which is now a redirect to their new owner's
1763 page with far newer versions listed.
1764 It is probably wise to plan to move your storage configurations away from
1765 Berkeley DB format, as today there are smaller and simpler alternatives more
1766 suited to Exim's usage model.
1767 .next
1768 .cindex "&'tdb'& DBM library"
1769 Yet another DBM library, called &'tdb'&, is available from
1770 &url(https://sourceforge.net/projects/tdb/files/). It has its own interface, and also
1771 operates on a single file.
1772 .endlist
1773
1774 .cindex "USE_DB"
1775 .cindex "DBM libraries" "configuration for building"
1776 Exim and its utilities can be compiled to use any of these interfaces. In order
1777 to use any version of the Berkeley DB package in native mode, you must set
1778 USE_DB in an appropriate configuration file (typically
1779 &_Local/Makefile_&). For example:
1780 .code
1781 USE_DB=yes
1782 .endd
1783 Similarly, for gdbm you set USE_GDBM, and for tdb you set USE_TDB. An
1784 error is diagnosed if you set more than one of these.
1785
1786 At the lowest level, the build-time configuration sets none of these options,
1787 thereby assuming an interface of type (1). However, some operating system
1788 configuration files (for example, those for the BSD operating systems and
1789 Linux) assume type (4) by setting USE_DB as their default, and the
1790 configuration files for Cygwin set USE_GDBM. Anything you set in
1791 &_Local/Makefile_&, however, overrides these system defaults.
1792
1793 As well as setting USE_DB, USE_GDBM, or USE_TDB, it may also be
1794 necessary to set DBMLIB, to cause inclusion of the appropriate library, as
1795 in one of these lines:
1796 .code
1797 DBMLIB = -ldb
1798 DBMLIB = -ltdb
1799 .endd
1800 Settings like that will work if the DBM library is installed in the standard
1801 place. Sometimes it is not, and the library's header file may also not be in
1802 the default path. You may need to set INCLUDE to specify where the header
1803 file is, and to specify the path to the library more fully in DBMLIB, as in
1804 this example:
1805 .code
1806 INCLUDE=-I/usr/local/include/db-4.1
1807 DBMLIB=/usr/local/lib/db-4.1/libdb.a
1808 .endd
1809 There is further detailed discussion about the various DBM libraries in the
1810 file &_doc/dbm.discuss.txt_& in the Exim distribution.
1811
1812
1813
1814 .section "Pre-building configuration" "SECID25"
1815 .cindex "building Exim" "pre-building configuration"
1816 .cindex "configuration for building Exim"
1817 .cindex "&_Local/Makefile_&"
1818 .cindex "&_src/EDITME_&"
1819 Before building Exim, a local configuration file that specifies options
1820 independent of any operating system has to be created with the name
1821 &_Local/Makefile_&. A template for this file is supplied as the file
1822 &_src/EDITME_&, and it contains full descriptions of all the option settings
1823 therein. These descriptions are therefore not repeated here. If you are
1824 building Exim for the first time, the simplest thing to do is to copy
1825 &_src/EDITME_& to &_Local/Makefile_&, then read it and edit it appropriately.
1826
1827 There are three settings that you must supply, because Exim will not build
1828 without them. They are the location of the runtime configuration file
1829 (CONFIGURE_FILE), the directory in which Exim binaries will be installed
1830 (BIN_DIRECTORY), and the identity of the Exim user (EXIM_USER and
1831 maybe EXIM_GROUP as well). The value of CONFIGURE_FILE can in fact be
1832 a colon-separated list of filenames; Exim uses the first of them that exists.
1833
1834 There are a few other parameters that can be specified either at build time or
1835 at runtime, to enable the same binary to be used on a number of different
1836 machines. However, if the locations of Exim's spool directory and log file
1837 directory (if not within the spool directory) are fixed, it is recommended that
1838 you specify them in &_Local/Makefile_& instead of at runtime, so that errors
1839 detected early in Exim's execution (such as a malformed configuration file) can
1840 be logged.
1841
1842 .cindex "content scanning" "specifying at build time"
1843 Exim's interfaces for calling virus and spam scanning software directly from
1844 access control lists are not compiled by default. If you want to include these
1845 facilities, you need to set
1846 .code
1847 WITH_CONTENT_SCAN=yes
1848 .endd
1849 in your &_Local/Makefile_&. For details of the facilities themselves, see
1850 chapter &<<CHAPexiscan>>&.
1851
1852
1853 .cindex "&_Local/eximon.conf_&"
1854 .cindex "&_exim_monitor/EDITME_&"
1855 If you are going to build the Exim monitor, a similar configuration process is
1856 required. The file &_exim_monitor/EDITME_& must be edited appropriately for
1857 your installation and saved under the name &_Local/eximon.conf_&. If you are
1858 happy with the default settings described in &_exim_monitor/EDITME_&,
1859 &_Local/eximon.conf_& can be empty, but it must exist.
1860
1861 This is all the configuration that is needed in straightforward cases for known
1862 operating systems. However, the building process is set up so that it is easy
1863 to override options that are set by default or by operating-system-specific
1864 configuration files, for example, to change the C compiler, which
1865 defaults to &%gcc%&. See section &<<SECToverride>>& below for details of how to
1866 do this.
1867
1868
1869
1870 .section "Support for iconv()" "SECID26"
1871 .cindex "&[iconv()]& support"
1872 .cindex "RFC 2047"
1873 The contents of header lines in messages may be encoded according to the rules
1874 described RFC 2047. This makes it possible to transmit characters that are not
1875 in the ASCII character set, and to label them as being in a particular
1876 character set. When Exim is inspecting header lines by means of the &%$h_%&
1877 mechanism, it decodes them, and translates them into a specified character set
1878 (default is set at build time). The translation is possible only if the operating system
1879 supports the &[iconv()]& function.
1880
1881 However, some of the operating systems that supply &[iconv()]& do not support
1882 very many conversions. The GNU &%libiconv%& library (available from
1883 &url(https://www.gnu.org/software/libiconv/)) can be installed on such
1884 systems to remedy this deficiency, as well as on systems that do not supply
1885 &[iconv()]& at all. After installing &%libiconv%&, you should add
1886 .code
1887 HAVE_ICONV=yes
1888 .endd
1889 to your &_Local/Makefile_& and rebuild Exim.
1890
1891
1892
1893 .section "Including TLS/SSL encryption support" "SECTinctlsssl"
1894 .cindex "TLS" "including support for TLS"
1895 .cindex "encryption" "including support for"
1896 .cindex "OpenSSL" "building Exim with"
1897 .cindex "GnuTLS" "building Exim with"
1898 Exim is usually built to support encrypted SMTP connections, using the STARTTLS
1899 command as per RFC 2487. It can also support clients that expect to
1900 start a TLS session immediately on connection to a non-standard port (see the
1901 &%tls_on_connect_ports%& runtime option and the &%-tls-on-connect%& command
1902 line option).
1903
1904 If you want to build Exim with TLS support, you must first install either the
1905 OpenSSL or GnuTLS library. There is no cryptographic code in Exim itself for
1906 implementing SSL.
1907
1908 If you do not want TLS support you should set
1909 .code
1910 DISABLE_TLS=yes
1911 .endd
1912 in &_Local/Makefile_&.
1913
1914 If OpenSSL is installed, you should set
1915 .code
1916 USE_OPENSL=yes
1917 TLS_LIBS=-lssl -lcrypto
1918 .endd
1919 in &_Local/Makefile_&. You may also need to specify the locations of the
1920 OpenSSL library and include files. For example:
1921 .code
1922 USE_OPENSSL=yes
1923 TLS_LIBS=-L/usr/local/openssl/lib -lssl -lcrypto
1924 TLS_INCLUDE=-I/usr/local/openssl/include/
1925 .endd
1926 .cindex "pkg-config" "OpenSSL"
1927 If you have &'pkg-config'& available, then instead you can just use:
1928 .code
1929 USE_OPENSSL=yes
1930 USE_OPENSSL_PC=openssl
1931 .endd
1932 .cindex "USE_GNUTLS"
1933 If GnuTLS is installed, you should set
1934 .code
1935 USE_GNUTLS=yes
1936 TLS_LIBS=-lgnutls -ltasn1 -lgcrypt
1937 .endd
1938 in &_Local/Makefile_&, and again you may need to specify the locations of the
1939 library and include files. For example:
1940 .code
1941 USE_GNUTLS=yes
1942 TLS_LIBS=-L/usr/gnu/lib -lgnutls -ltasn1 -lgcrypt
1943 TLS_INCLUDE=-I/usr/gnu/include
1944 .endd
1945 .cindex "pkg-config" "GnuTLS"
1946 If you have &'pkg-config'& available, then instead you can just use:
1947 .code
1948 USE_GNUTLS=yes
1949 USE_GNUTLS_PC=gnutls
1950 .endd
1951
1952 You do not need to set TLS_INCLUDE if the relevant directory is already
1953 specified in INCLUDE. Details of how to configure Exim to make use of TLS are
1954 given in chapter &<<CHAPTLS>>&.
1955
1956
1957
1958
1959 .section "Use of tcpwrappers" "SECID27"
1960
1961 .cindex "tcpwrappers, building Exim to support"
1962 .cindex "USE_TCP_WRAPPERS"
1963 .cindex "TCP_WRAPPERS_DAEMON_NAME"
1964 .cindex "tcp_wrappers_daemon_name"
1965 Exim can be linked with the &'tcpwrappers'& library in order to check incoming
1966 SMTP calls using the &'tcpwrappers'& control files. This may be a convenient
1967 alternative to Exim's own checking facilities for installations that are
1968 already making use of &'tcpwrappers'& for other purposes. To do this, you
1969 should set USE_TCP_WRAPPERS in &_Local/Makefile_&, arrange for the file
1970 &_tcpd.h_& to be available at compile time, and also ensure that the library
1971 &_libwrap.a_& is available at link time, typically by including &%-lwrap%& in
1972 EXTRALIBS_EXIM. For example, if &'tcpwrappers'& is installed in &_/usr/local_&,
1973 you might have
1974 .code
1975 USE_TCP_WRAPPERS=yes
1976 CFLAGS=-O -I/usr/local/include
1977 EXTRALIBS_EXIM=-L/usr/local/lib -lwrap
1978 .endd
1979 in &_Local/Makefile_&. The daemon name to use in the &'tcpwrappers'& control
1980 files is &"exim"&. For example, the line
1981 .code
1982 exim : LOCAL  192.168.1.  .friendly.domain.example
1983 .endd
1984 in your &_/etc/hosts.allow_& file allows connections from the local host, from
1985 the subnet 192.168.1.0/24, and from all hosts in &'friendly.domain.example'&.
1986 All other connections are denied. The daemon name used by &'tcpwrappers'&
1987 can be changed at build time by setting TCP_WRAPPERS_DAEMON_NAME in
1988 &_Local/Makefile_&, or by setting tcp_wrappers_daemon_name in the
1989 configure file. Consult the &'tcpwrappers'& documentation for
1990 further details.
1991
1992
1993 .section "Including support for IPv6" "SECID28"
1994 .cindex "IPv6" "including support for"
1995 Exim contains code for use on systems that have IPv6 support. Setting
1996 &`HAVE_IPV6=YES`& in &_Local/Makefile_& causes the IPv6 code to be included;
1997 it may also be necessary to set IPV6_INCLUDE and IPV6_LIBS on systems
1998 where the IPv6 support is not fully integrated into the normal include and
1999 library files.
2000
2001 Two different types of DNS record for handling IPv6 addresses have been
2002 defined. AAAA records (analogous to A records for IPv4) are in use, and are
2003 currently seen as the mainstream. Another record type called A6 was proposed
2004 as better than AAAA because it had more flexibility. However, it was felt to be
2005 over-complex, and its status was reduced to &"experimental"&.
2006 Exim used to
2007 have a compile option for including A6 record support but this has now been
2008 withdrawn.
2009
2010
2011
2012 .section "Dynamically loaded lookup module support" "SECTdynamicmodules"
2013 .cindex "lookup modules"
2014 .cindex "dynamic modules"
2015 .cindex ".so building"
2016 On some platforms, Exim supports not compiling all lookup types directly into
2017 the main binary, instead putting some into external modules which can be loaded
2018 on demand.
2019 This permits packagers to build Exim with support for lookups with extensive
2020 library dependencies without requiring all users to install all of those
2021 dependencies.
2022 Most, but not all, lookup types can be built this way.
2023
2024 Set &`LOOKUP_MODULE_DIR`& to the directory into which the modules will be
2025 installed; Exim will only load modules from that directory, as a security
2026 measure.  You will need to set &`CFLAGS_DYNAMIC`& if not already defined
2027 for your OS; see &_OS/Makefile-Linux_& for an example.
2028 Some other requirements for adjusting &`EXTRALIBS`& may also be necessary,
2029 see &_src/EDITME_& for details.
2030
2031 Then, for each module to be loaded dynamically, define the relevant
2032 &`LOOKUP_`&<&'lookup_type'&> flags to have the value "2" instead of "yes".
2033 For example, this will build in lsearch but load sqlite and mysql support
2034 on demand:
2035 .code
2036 LOOKUP_LSEARCH=yes
2037 LOOKUP_SQLITE=2
2038 LOOKUP_MYSQL=2
2039 .endd
2040
2041
2042 .section "The building process" "SECID29"
2043 .cindex "build directory"
2044 Once &_Local/Makefile_& (and &_Local/eximon.conf_&, if required) have been
2045 created, run &'make'& at the top level. It determines the architecture and
2046 operating system types, and creates a build directory if one does not exist.
2047 For example, on a Sun system running Solaris 8, the directory
2048 &_build-SunOS5-5.8-sparc_& is created.
2049 .cindex "symbolic link" "to source files"
2050 Symbolic links to relevant source files are installed in the build directory.
2051
2052 If this is the first time &'make'& has been run, it calls a script that builds
2053 a make file inside the build directory, using the configuration files from the
2054 &_Local_& directory. The new make file is then passed to another instance of
2055 &'make'&. This does the real work, building a number of utility scripts, and
2056 then compiling and linking the binaries for the Exim monitor (if configured), a
2057 number of utility programs, and finally Exim itself. The command &`make
2058 makefile`& can be used to force a rebuild of the make file in the build
2059 directory, should this ever be necessary.
2060
2061 If you have problems building Exim, check for any comments there may be in the
2062 &_README_& file concerning your operating system, and also take a look at the
2063 FAQ, where some common problems are covered.
2064
2065
2066
2067 .section 'Output from &"make"&' "SECID283"
2068 The output produced by the &'make'& process for compile lines is often very
2069 unreadable, because these lines can be very long. For this reason, the normal
2070 output is suppressed by default, and instead output similar to that which
2071 appears when compiling the 2.6 Linux kernel is generated: just a short line for
2072 each module that is being compiled or linked. However, it is still possible to
2073 get the full output, by calling &'make'& like this:
2074 .code
2075 FULLECHO='' make -e
2076 .endd
2077 The value of FULLECHO defaults to &"@"&, the flag character that suppresses
2078 command reflection in &'make'&. When you ask for the full output, it is
2079 given in addition to the short output.
2080
2081
2082
2083 .section "Overriding build-time options for Exim" "SECToverride"
2084 .cindex "build-time options, overriding"
2085 The main make file that is created at the beginning of the building process
2086 consists of the concatenation of a number of files which set configuration
2087 values, followed by a fixed set of &'make'& instructions. If a value is set
2088 more than once, the last setting overrides any previous ones. This provides a
2089 convenient way of overriding defaults. The files that are concatenated are, in
2090 order:
2091 .display
2092 &_OS/Makefile-Default_&
2093 &_OS/Makefile-_&<&'ostype'&>
2094 &_Local/Makefile_&
2095 &_Local/Makefile-_&<&'ostype'&>
2096 &_Local/Makefile-_&<&'archtype'&>
2097 &_Local/Makefile-_&<&'ostype'&>-<&'archtype'&>
2098 &_OS/Makefile-Base_&
2099 .endd
2100 .cindex "&_Local/Makefile_&"
2101 .cindex "building Exim" "operating system type"
2102 .cindex "building Exim" "architecture type"
2103 where <&'ostype'&> is the operating system type and <&'archtype'&> is the
2104 architecture type. &_Local/Makefile_& is required to exist, and the building
2105 process fails if it is absent. The other three &_Local_& files are optional,
2106 and are often not needed.
2107
2108 The values used for <&'ostype'&> and <&'archtype'&> are obtained from scripts
2109 called &_scripts/os-type_& and &_scripts/arch-type_& respectively. If either of
2110 the environment variables EXIM_OSTYPE or EXIM_ARCHTYPE is set, their
2111 values are used, thereby providing a means of forcing particular settings.
2112 Otherwise, the scripts try to get values from the &%uname%& command. If this
2113 fails, the shell variables OSTYPE and ARCHTYPE are inspected. A number
2114 of &'ad hoc'& transformations are then applied, to produce the standard names
2115 that Exim expects. You can run these scripts directly from the shell in order
2116 to find out what values are being used on your system.
2117
2118
2119 &_OS/Makefile-Default_& contains comments about the variables that are set
2120 therein. Some (but not all) are mentioned below. If there is something that
2121 needs changing, review the contents of this file and the contents of the make
2122 file for your operating system (&_OS/Makefile-<ostype>_&) to see what the
2123 default values are.
2124
2125
2126 .cindex "building Exim" "overriding default settings"
2127 If you need to change any of the values that are set in &_OS/Makefile-Default_&
2128 or in &_OS/Makefile-<ostype>_&, or to add any new definitions, you do not
2129 need to change the original files. Instead, you should make the changes by
2130 putting the new values in an appropriate &_Local_& file. For example,
2131 .cindex "Tru64-Unix build-time settings"
2132 when building Exim in many releases of the Tru64-Unix (formerly Digital UNIX,
2133 formerly DEC-OSF1) operating system, it is necessary to specify that the C
2134 compiler is called &'cc'& rather than &'gcc'&. Also, the compiler must be
2135 called with the option &%-std1%&, to make it recognize some of the features of
2136 Standard C that Exim uses. (Most other compilers recognize Standard C by
2137 default.) To do this, you should create a file called &_Local/Makefile-OSF1_&
2138 containing the lines
2139 .code
2140 CC=cc
2141 CFLAGS=-std1
2142 .endd
2143 If you are compiling for just one operating system, it may be easier to put
2144 these lines directly into &_Local/Makefile_&.
2145
2146 Keeping all your local configuration settings separate from the distributed
2147 files makes it easy to transfer them to new versions of Exim simply by copying
2148 the contents of the &_Local_& directory.
2149
2150
2151 .cindex "NIS lookup type" "including support for"
2152 .cindex "NIS+ lookup type" "including support for"
2153 .cindex "LDAP" "including support for"
2154 .cindex "lookup" "inclusion in binary"
2155 Exim contains support for doing LDAP, NIS, NIS+, and other kinds of file
2156 lookup, but not all systems have these components installed, so the default is
2157 not to include the relevant code in the binary. All the different kinds of file
2158 and database lookup that Exim supports are implemented as separate code modules
2159 which are included only if the relevant compile-time options are set. In the
2160 case of LDAP, NIS, and NIS+, the settings for &_Local/Makefile_& are:
2161 .code
2162 LOOKUP_LDAP=yes
2163 LOOKUP_NIS=yes
2164 LOOKUP_NISPLUS=yes
2165 .endd
2166 and similar settings apply to the other lookup types. They are all listed in
2167 &_src/EDITME_&. In many cases the relevant include files and interface
2168 libraries need to be installed before compiling Exim.
2169 .cindex "cdb" "including support for"
2170 However, there are some optional lookup types (such as cdb) for which
2171 the code is entirely contained within Exim, and no external include
2172 files or libraries are required. When a lookup type is not included in the
2173 binary, attempts to configure Exim to use it cause runtime configuration
2174 errors.
2175
2176 .cindex "pkg-config" "lookups"
2177 .cindex "pkg-config" "authenticators"
2178 Many systems now use a tool called &'pkg-config'& to encapsulate information
2179 about how to compile against a library; Exim has some initial support for
2180 being able to use pkg-config for lookups and authenticators.  For any given
2181 makefile variable which starts &`LOOKUP_`& or &`AUTH_`&, you can add a new
2182 variable with the &`_PC`& suffix in the name and assign as the value the
2183 name of the package to be queried.  The results of querying via the
2184 &'pkg-config'& command will be added to the appropriate Makefile variables
2185 with &`+=`& directives, so your version of &'make'& will need to support that
2186 syntax.  For instance:
2187 .code
2188 LOOKUP_SQLITE=yes
2189 LOOKUP_SQLITE_PC=sqlite3
2190 AUTH_GSASL=yes
2191 AUTH_GSASL_PC=libgsasl
2192 AUTH_HEIMDAL_GSSAPI=yes
2193 AUTH_HEIMDAL_GSSAPI_PC=heimdal-gssapi
2194 .endd
2195
2196 .cindex "Perl" "including support for"
2197 Exim can be linked with an embedded Perl interpreter, allowing Perl
2198 subroutines to be called during string expansion. To enable this facility,
2199 .code
2200 EXIM_PERL=perl.o
2201 .endd
2202 must be defined in &_Local/Makefile_&. Details of this facility are given in
2203 chapter &<<CHAPperl>>&.
2204
2205 .cindex "X11 libraries, location of"
2206 The location of the X11 libraries is something that varies a lot between
2207 operating systems, and there may be different versions of X11 to cope
2208 with. Exim itself makes no use of X11, but if you are compiling the Exim
2209 monitor, the X11 libraries must be available.
2210 The following three variables are set in &_OS/Makefile-Default_&:
2211 .code
2212 X11=/usr/X11R6
2213 XINCLUDE=-I$(X11)/include
2214 XLFLAGS=-L$(X11)/lib
2215 .endd
2216 These are overridden in some of the operating-system configuration files. For
2217 example, in &_OS/Makefile-SunOS5_& there is
2218 .code
2219 X11=/usr/openwin
2220 XINCLUDE=-I$(X11)/include
2221 XLFLAGS=-L$(X11)/lib -R$(X11)/lib
2222 .endd
2223 If you need to override the default setting for your operating system, place a
2224 definition of all three of these variables into your
2225 &_Local/Makefile-<ostype>_& file.
2226
2227 .cindex "EXTRALIBS"
2228 If you need to add any extra libraries to the link steps, these can be put in a
2229 variable called EXTRALIBS, which appears in all the link commands, but by
2230 default is not defined. In contrast, EXTRALIBS_EXIM is used only on the
2231 command for linking the main Exim binary, and not for any associated utilities.
2232
2233 .cindex "DBM libraries" "configuration for building"
2234 There is also DBMLIB, which appears in the link commands for binaries that
2235 use DBM functions (see also section &<<SECTdb>>&). Finally, there is
2236 EXTRALIBS_EXIMON, which appears only in the link step for the Exim monitor
2237 binary, and which can be used, for example, to include additional X11
2238 libraries.
2239
2240 .cindex "configuration file" "editing"
2241 The make file copes with rebuilding Exim correctly if any of the configuration
2242 files are edited. However, if an optional configuration file is deleted, it is
2243 necessary to touch the associated non-optional file (that is,
2244 &_Local/Makefile_& or &_Local/eximon.conf_&) before rebuilding.
2245
2246
2247 .section "OS-specific header files" "SECID30"
2248 .cindex "&_os.h_&"
2249 .cindex "building Exim" "OS-specific C header files"
2250 The &_OS_& directory contains a number of files with names of the form
2251 &_os.h-<ostype>_&. These are system-specific C header files that should not
2252 normally need to be changed. There is a list of macro settings that are
2253 recognized in the file &_OS/os.configuring_&, which should be consulted if you
2254 are porting Exim to a new operating system.
2255
2256
2257
2258 .section "Overriding build-time options for the monitor" "SECID31"
2259 .cindex "building Eximon"
2260 A similar process is used for overriding things when building the Exim monitor,
2261 where the files that are involved are
2262 .display
2263 &_OS/eximon.conf-Default_&
2264 &_OS/eximon.conf-_&<&'ostype'&>
2265 &_Local/eximon.conf_&
2266 &_Local/eximon.conf-_&<&'ostype'&>
2267 &_Local/eximon.conf-_&<&'archtype'&>
2268 &_Local/eximon.conf-_&<&'ostype'&>-<&'archtype'&>
2269 .endd
2270 .cindex "&_Local/eximon.conf_&"
2271 As with Exim itself, the final three files need not exist, and in this case the
2272 &_OS/eximon.conf-<ostype>_& file is also optional. The default values in
2273 &_OS/eximon.conf-Default_& can be overridden dynamically by setting environment
2274 variables of the same name, preceded by EXIMON_. For example, setting
2275 EXIMON_LOG_DEPTH in the environment overrides the value of
2276 LOG_DEPTH at runtime.
2277 .ecindex IIDbuex
2278
2279
2280 .section "Installing Exim binaries and scripts" "SECID32"
2281 .cindex "installing Exim"
2282 .cindex "BIN_DIRECTORY"
2283 The command &`make install`& runs the &(exim_install)& script with no
2284 arguments. The script copies binaries and utility scripts into the directory
2285 whose name is specified by the BIN_DIRECTORY setting in &_Local/Makefile_&.
2286 .cindex "setuid" "installing Exim with"
2287 The install script copies files only if they are newer than the files they are
2288 going to replace. The Exim binary is required to be owned by root and have the
2289 &'setuid'& bit set, for normal configurations. Therefore, you must run &`make
2290 install`& as root so that it can set up the Exim binary in this way. However, in
2291 some special situations (for example, if a host is doing no local deliveries)
2292 it may be possible to run Exim without making the binary setuid root (see
2293 chapter &<<CHAPsecurity>>& for details).
2294
2295 .cindex "CONFIGURE_FILE"
2296 Exim's runtime configuration file is named by the CONFIGURE_FILE setting
2297 in &_Local/Makefile_&. If this names a single file, and the file does not
2298 exist, the default configuration file &_src/configure.default_& is copied there
2299 by the installation script. If a runtime configuration file already exists, it
2300 is left alone. If CONFIGURE_FILE is a colon-separated list, naming several
2301 alternative files, no default is installed.
2302
2303 .cindex "system aliases file"
2304 .cindex "&_/etc/aliases_&"
2305 One change is made to the default configuration file when it is installed: the
2306 default configuration contains a router that references a system aliases file.
2307 The path to this file is set to the value specified by
2308 SYSTEM_ALIASES_FILE in &_Local/Makefile_& (&_/etc/aliases_& by default).
2309 If the system aliases file does not exist, the installation script creates it,
2310 and outputs a comment to the user.
2311
2312 The created file contains no aliases, but it does contain comments about the
2313 aliases a site should normally have. Mail aliases have traditionally been
2314 kept in &_/etc/aliases_&. However, some operating systems are now using
2315 &_/etc/mail/aliases_&. You should check if yours is one of these, and change
2316 Exim's configuration if necessary.
2317
2318 The default configuration uses the local host's name as the only local domain,
2319 and is set up to do local deliveries into the shared directory &_/var/mail_&,
2320 running as the local user. System aliases and &_.forward_& files in users' home
2321 directories are supported, but no NIS or NIS+ support is configured. Domains
2322 other than the name of the local host are routed using the DNS, with delivery
2323 over SMTP.
2324
2325 It is possible to install Exim for special purposes (such as building a binary
2326 distribution) in a private part of the file system. You can do this by a
2327 command such as
2328 .code
2329 make DESTDIR=/some/directory/ install
2330 .endd
2331 This has the effect of pre-pending the specified directory to all the file
2332 paths, except the name of the system aliases file that appears in the default
2333 configuration. (If a default alias file is created, its name &'is'& modified.)
2334 For backwards compatibility, ROOT is used if DESTDIR is not set,
2335 but this usage is deprecated.
2336
2337 .cindex "installing Exim" "what is not installed"
2338 Running &'make install'& does not copy the Exim 4 conversion script
2339 &'convert4r4'&. You will probably run this only once if you are
2340 upgrading from Exim 3. None of the documentation files in the &_doc_&
2341 directory are copied, except for the info files when you have set
2342 INFO_DIRECTORY, as described in section &<<SECTinsinfdoc>>& below.
2343
2344 For the utility programs, old versions are renamed by adding the suffix &_.O_&
2345 to their names. The Exim binary itself, however, is handled differently. It is
2346 installed under a name that includes the version number and the compile number,
2347 for example, &_exim-&version()-1_&. The script then arranges for a symbolic link
2348 called &_exim_& to point to the binary. If you are updating a previous version
2349 of Exim, the script takes care to ensure that the name &_exim_& is never absent
2350 from the directory (as seen by other processes).
2351
2352 .cindex "installing Exim" "testing the script"
2353 If you want to see what the &'make install'& will do before running it for
2354 real, you can pass the &%-n%& option to the installation script by this
2355 command:
2356 .code
2357 make INSTALL_ARG=-n install
2358 .endd
2359 The contents of the variable INSTALL_ARG are passed to the installation
2360 script. You do not need to be root to run this test. Alternatively, you can run
2361 the installation script directly, but this must be from within the build
2362 directory. For example, from the top-level Exim directory you could use this
2363 command:
2364 .code
2365 (cd build-SunOS5-5.5.1-sparc; ../scripts/exim_install -n)
2366 .endd
2367 .cindex "installing Exim" "install script options"
2368 There are two other options that can be supplied to the installation script.
2369
2370 .ilist
2371 &%-no_chown%& bypasses the call to change the owner of the installed binary
2372 to root, and the call to make it a setuid binary.
2373 .next
2374 &%-no_symlink%& bypasses the setting up of the symbolic link &_exim_& to the
2375 installed binary.
2376 .endlist
2377
2378 INSTALL_ARG can be used to pass these options to the script. For example:
2379 .code
2380 make INSTALL_ARG=-no_symlink install
2381 .endd
2382 The installation script can also be given arguments specifying which files are
2383 to be copied. For example, to install just the Exim binary, and nothing else,
2384 without creating the symbolic link, you could use:
2385 .code
2386 make INSTALL_ARG='-no_symlink exim' install
2387 .endd
2388
2389
2390
2391 .section "Installing info documentation" "SECTinsinfdoc"
2392 .cindex "installing Exim" "&'info'& documentation"
2393 Not all systems use the GNU &'info'& system for documentation, and for this
2394 reason, the Texinfo source of Exim's documentation is not included in the main
2395 distribution. Instead it is available separately from the FTP site (see section
2396 &<<SECTavail>>&).
2397
2398 If you have defined INFO_DIRECTORY in &_Local/Makefile_& and the Texinfo
2399 source of the documentation is found in the source tree, running &`make
2400 install`& automatically builds the info files and installs them.
2401
2402
2403
2404 .section "Setting up the spool directory" "SECID33"
2405 .cindex "spool directory" "creating"
2406 When it starts up, Exim tries to create its spool directory if it does not
2407 exist. The Exim uid and gid are used for the owner and group of the spool
2408 directory. Sub-directories are automatically created in the spool directory as
2409 necessary.
2410
2411
2412
2413
2414 .section "Testing" "SECID34"
2415 .cindex "testing" "installation"
2416 Having installed Exim, you can check that the runtime configuration file is
2417 syntactically valid by running the following command, which assumes that the
2418 Exim binary directory is within your PATH environment variable:
2419 .code
2420 exim -bV
2421 .endd
2422 If there are any errors in the configuration file, Exim outputs error messages.
2423 Otherwise it outputs the version number and build date,
2424 the DBM library that is being used, and information about which drivers and
2425 other optional code modules are included in the binary.
2426 Some simple routing tests can be done by using the address testing option. For
2427 example,
2428 .display
2429 &`exim -bt`& <&'local username'&>
2430 .endd
2431 should verify that it recognizes a local mailbox, and
2432 .display
2433 &`exim -bt`& <&'remote address'&>
2434 .endd
2435 a remote one. Then try getting it to deliver mail, both locally and remotely.
2436 This can be done by passing messages directly to Exim, without going through a
2437 user agent. For example:
2438 .code
2439 exim -v postmaster@your.domain.example
2440 From: user@your.domain.example
2441 To: postmaster@your.domain.example
2442 Subject: Testing Exim
2443
2444 This is a test message.
2445 ^D
2446 .endd
2447 The &%-v%& option causes Exim to output some verification of what it is doing.
2448 In this case you should see copies of three log lines, one for the message's
2449 arrival, one for its delivery, and one containing &"Completed"&.
2450
2451 .cindex "delivery" "problems with"
2452 If you encounter problems, look at Exim's log files (&'mainlog'& and
2453 &'paniclog'&) to see if there is any relevant information there. Another source
2454 of information is running Exim with debugging turned on, by specifying the
2455 &%-d%& option. If a message is stuck on Exim's spool, you can force a delivery
2456 with debugging turned on by a command of the form
2457 .display
2458 &`exim -d -M`& <&'exim-message-id'&>
2459 .endd
2460 You must be root or an &"admin user"& in order to do this. The &%-d%& option
2461 produces rather a lot of output, but you can cut this down to specific areas.
2462 For example, if you use &%-d-all+route%& only the debugging information
2463 relevant to routing is included. (See the &%-d%& option in chapter
2464 &<<CHAPcommandline>>& for more details.)
2465
2466 .cindex '&"sticky"& bit'
2467 .cindex "lock files"
2468 One specific problem that has shown up on some sites is the inability to do
2469 local deliveries into a shared mailbox directory, because it does not have the
2470 &"sticky bit"& set on it. By default, Exim tries to create a lock file before
2471 writing to a mailbox file, and if it cannot create the lock file, the delivery
2472 is deferred. You can get round this either by setting the &"sticky bit"& on the
2473 directory, or by setting a specific group for local deliveries and allowing
2474 that group to create files in the directory (see the comments above the
2475 &(local_delivery)& transport in the default configuration file). Another
2476 approach is to configure Exim not to use lock files, but just to rely on
2477 &[fcntl()]& locking instead. However, you should do this only if all user
2478 agents also use &[fcntl()]& locking. For further discussion of locking issues,
2479 see chapter &<<CHAPappendfile>>&.
2480
2481 One thing that cannot be tested on a system that is already running an MTA is
2482 the receipt of incoming SMTP mail on the standard SMTP port. However, the
2483 &%-oX%& option can be used to run an Exim daemon that listens on some other
2484 port, or &'inetd'& can be used to do this. The &%-bh%& option and the
2485 &'exim_checkaccess'& utility can be used to check out policy controls on
2486 incoming SMTP mail.
2487
2488 Testing a new version on a system that is already running Exim can most easily
2489 be done by building a binary with a different CONFIGURE_FILE setting. From
2490 within the runtime configuration, all other file and directory names
2491 that Exim uses can be altered, in order to keep it entirely clear of the
2492 production version.
2493
2494
2495 .section "Replacing another MTA with Exim" "SECID35"
2496 .cindex "replacing another MTA"
2497 Building and installing Exim for the first time does not of itself put it in
2498 general use. The name by which the system's MTA is called by mail user agents
2499 is either &_/usr/sbin/sendmail_&, or &_/usr/lib/sendmail_& (depending on the
2500 operating system), and it is necessary to make this name point to the &'exim'&
2501 binary in order to get the user agents to pass messages to Exim. This is
2502 normally done by renaming any existing file and making &_/usr/sbin/sendmail_&
2503 or &_/usr/lib/sendmail_&
2504 .cindex "symbolic link" "to &'exim'& binary"
2505 a symbolic link to the &'exim'& binary. It is a good idea to remove any setuid
2506 privilege and executable status from the old MTA. It is then necessary to stop
2507 and restart the mailer daemon, if one is running.
2508
2509 .cindex "FreeBSD, MTA indirection"
2510 .cindex "&_/etc/mail/mailer.conf_&"
2511 Some operating systems have introduced alternative ways of switching MTAs. For
2512 example, if you are running FreeBSD, you need to edit the file
2513 &_/etc/mail/mailer.conf_& instead of setting up a symbolic link as just
2514 described. A typical example of the contents of this file for running Exim is
2515 as follows:
2516 .code
2517 sendmail            /usr/exim/bin/exim
2518 send-mail           /usr/exim/bin/exim
2519 mailq               /usr/exim/bin/exim -bp
2520 newaliases          /usr/bin/true
2521 .endd
2522 Once you have set up the symbolic link, or edited &_/etc/mail/mailer.conf_&,
2523 your Exim installation is &"live"&. Check it by sending a message from your
2524 favourite user agent.
2525
2526 You should consider what to tell your users about the change of MTA. Exim may
2527 have different capabilities to what was previously running, and there are
2528 various operational differences such as the text of messages produced by
2529 command line options and in bounce messages. If you allow your users to make
2530 use of Exim's filtering capabilities, you should make the document entitled
2531 &'Exim's interface to mail filtering'& available to them.
2532
2533
2534
2535 .section "Upgrading Exim" "SECID36"
2536 .cindex "upgrading Exim"
2537 If you are already running Exim on your host, building and installing a new
2538 version automatically makes it available to MUAs, or any other programs that
2539 call the MTA directly. However, if you are running an Exim daemon, you do need
2540 .cindex restart "on HUP signal"
2541 .cindex signal "HUP, to restart"
2542 to send it a HUP signal, to make it re-execute itself, and thereby pick up the
2543 new binary. You do not need to stop processing mail in order to install a new
2544 version of Exim. The install script does not modify an existing runtime
2545 configuration file.
2546
2547
2548
2549
2550 .section "Stopping the Exim daemon on Solaris" "SECID37"
2551 .cindex "Solaris" "stopping Exim on"
2552 The standard command for stopping the mailer daemon on Solaris is
2553 .code
2554 /etc/init.d/sendmail stop
2555 .endd
2556 If &_/usr/lib/sendmail_& has been turned into a symbolic link, this script
2557 fails to stop Exim because it uses the command &'ps -e'& and greps the output
2558 for the text &"sendmail"&; this is not present because the actual program name
2559 (that is, &"exim"&) is given by the &'ps'& command with these options. A
2560 solution is to replace the line that finds the process id with something like
2561 .code
2562 pid=`cat /var/spool/exim/exim-daemon.pid`
2563 .endd
2564 to obtain the daemon's pid directly from the file that Exim saves it in.
2565
2566 Note, however, that stopping the daemon does not &"stop Exim"&. Messages can
2567 still be received from local processes, and if automatic delivery is configured
2568 (the normal case), deliveries will still occur.
2569
2570
2571
2572
2573 . ////////////////////////////////////////////////////////////////////////////
2574 . ////////////////////////////////////////////////////////////////////////////
2575
2576 .chapter "The Exim command line" "CHAPcommandline"
2577 .scindex IIDclo1 "command line" "options"
2578 .scindex IIDclo2 "options" "command line"
2579 Exim's command line takes the standard Unix form of a sequence of options,
2580 each starting with a hyphen character, followed by a number of arguments. The
2581 options are compatible with the main options of Sendmail, and there are also
2582 some additional options, some of which are compatible with Smail 3. Certain
2583 combinations of options do not make sense, and provoke an error if used.
2584 The form of the arguments depends on which options are set.
2585
2586
2587 .section "Setting options by program name" "SECID38"
2588 .cindex "&'mailq'&"
2589 If Exim is called under the name &'mailq'&, it behaves as if the option &%-bp%&
2590 were present before any other options.
2591 The &%-bp%& option requests a listing of the contents of the mail queue on the
2592 standard output.
2593 This feature is for compatibility with some systems that contain a command of
2594 that name in one of the standard libraries, symbolically linked to
2595 &_/usr/sbin/sendmail_& or &_/usr/lib/sendmail_&.
2596
2597 .cindex "&'rsmtp'&"
2598 If Exim is called under the name &'rsmtp'& it behaves as if the option &%-bS%&
2599 were present before any other options, for compatibility with Smail. The
2600 &%-bS%& option is used for reading in a number of messages in batched SMTP
2601 format.
2602
2603 .cindex "&'rmail'&"
2604 If Exim is called under the name &'rmail'& it behaves as if the &%-i%& and
2605 &%-oee%& options were present before any other options, for compatibility with
2606 Smail. The name &'rmail'& is used as an interface by some UUCP systems.
2607
2608 .cindex "&'runq'&"
2609 .cindex "queue runner"
2610 If Exim is called under the name &'runq'& it behaves as if the option &%-q%&
2611 were present before any other options, for compatibility with Smail. The &%-q%&
2612 option causes a single queue runner process to be started.
2613
2614 .cindex "&'newaliases'&"
2615 .cindex "alias file" "building"
2616 .cindex "Sendmail compatibility" "calling Exim as &'newaliases'&"
2617 If Exim is called under the name &'newaliases'& it behaves as if the option
2618 &%-bi%& were present before any other options, for compatibility with Sendmail.
2619 This option is used for rebuilding Sendmail's alias file. Exim does not have
2620 the concept of a single alias file, but can be configured to run a given
2621 command if called with the &%-bi%& option.
2622
2623
2624 .section "Trusted and admin users" "SECTtrustedadmin"
2625 Some Exim options are available only to &'trusted users'& and others are
2626 available only to &'admin users'&. In the description below, the phrases &"Exim
2627 user"& and &"Exim group"& mean the user and group defined by EXIM_USER and
2628 EXIM_GROUP in &_Local/Makefile_& or set by the &%exim_user%& and
2629 &%exim_group%& options. These do not necessarily have to use the name &"exim"&.
2630
2631 .ilist
2632 .cindex "trusted users" "definition of"
2633 .cindex "user" "trusted definition of"
2634 The trusted users are root, the Exim user, any user listed in the
2635 &%trusted_users%& configuration option, and any user whose current group or any
2636 supplementary group is one of those listed in the &%trusted_groups%&
2637 configuration option. Note that the Exim group is not automatically trusted.
2638
2639 .cindex '&"From"& line'
2640 .cindex "envelope from"
2641 .cindex "envelope sender"
2642 Trusted users are always permitted to use the &%-f%& option or a leading
2643 &"From&~"& line to specify the envelope sender of a message that is passed to
2644 Exim through the local interface (see the &%-bm%& and &%-f%& options below).
2645 See the &%untrusted_set_sender%& option for a way of permitting non-trusted
2646 users to set envelope senders.
2647
2648 .cindex "&'From:'& header line"
2649 .cindex "&'Sender:'& header line"
2650 .cindex "header lines" "From:"
2651 .cindex "header lines" "Sender:"
2652 For a trusted user, there is never any check on the contents of the &'From:'&
2653 header line, and a &'Sender:'& line is never added. Furthermore, any existing
2654 &'Sender:'& line in incoming local (non-TCP/IP) messages is not removed.
2655
2656 Trusted users may also specify a host name, host address, interface address,
2657 protocol name, ident value, and authentication data when submitting a message
2658 locally. Thus, they are able to insert messages into Exim's queue locally that
2659 have the characteristics of messages received from a remote host. Untrusted
2660 users may in some circumstances use &%-f%&, but can never set the other values
2661 that are available to trusted users.
2662 .next
2663 .cindex "user" "admin definition of"
2664 .cindex "admin user" "definition of"
2665 The admin users are root, the Exim user, and any user that is a member of the
2666 Exim group or of any group listed in the &%admin_groups%& configuration option.
2667 The current group does not have to be one of these groups.
2668
2669 Admin users are permitted to list the queue, and to carry out certain
2670 operations on messages, for example, to force delivery failures. It is also
2671 necessary to be an admin user in order to see the full information provided by
2672 the Exim monitor, and full debugging output.
2673
2674 By default, the use of the &%-M%&, &%-q%&, &%-R%&, and &%-S%& options to cause
2675 Exim to attempt delivery of messages on its queue is restricted to admin users.
2676 However, this restriction can be relaxed by setting the &%prod_requires_admin%&
2677 option false (that is, specifying &%no_prod_requires_admin%&).
2678
2679 Similarly, the use of the &%-bp%& option to list all the messages in the queue
2680 is restricted to admin users unless &%queue_list_requires_admin%& is set
2681 false.
2682 .endlist
2683
2684
2685 &*Warning*&: If you configure your system so that admin users are able to
2686 edit Exim's configuration file, you are giving those users an easy way of
2687 getting root. There is further discussion of this issue at the start of chapter
2688 &<<CHAPconf>>&.
2689
2690
2691
2692
2693 .section "Command line options" "SECID39"
2694 Exim's command line options are described in alphabetical order below. If none
2695 of the options that specifies a specific action (such as starting the daemon or
2696 a queue runner, or testing an address, or receiving a message in a specific
2697 format, or listing the queue) are present, and there is at least one argument
2698 on the command line, &%-bm%& (accept a local message on the standard input,
2699 with the arguments specifying the recipients) is assumed. Otherwise, Exim
2700 outputs a brief message about itself and exits.
2701
2702 . ////////////////////////////////////////////////////////////////////////////
2703 . Insert a stylized XML comment here, to identify the start of the command line
2704 . options. This is for the benefit of the Perl script that automatically
2705 . creates a man page for the options.
2706 . ////////////////////////////////////////////////////////////////////////////
2707
2708 .literal xml
2709 <!-- === Start of command line options === -->
2710 .literal off
2711
2712
2713 .vlist
2714 .vitem &%--%&
2715 .oindex "--"
2716 .cindex "options" "command line; terminating"
2717 This is a pseudo-option whose only purpose is to terminate the options and
2718 therefore to cause subsequent command line items to be treated as arguments
2719 rather than options, even if they begin with hyphens.
2720
2721 .vitem &%--help%&
2722 .oindex "&%--help%&"
2723 This option causes Exim to output a few sentences stating what it is.
2724 The same output is generated if the Exim binary is called with no options and
2725 no arguments.
2726
2727 .vitem &%--version%&
2728 .oindex "&%--version%&"
2729 This option is an alias for &%-bV%& and causes version information to be
2730 displayed.
2731
2732 .vitem &%-Ac%& &&&
2733        &%-Am%&
2734 .oindex "&%-Ac%&"
2735 .oindex "&%-Am%&"
2736 These options are used by Sendmail for selecting configuration files and are
2737 ignored by Exim.
2738
2739 .vitem &%-B%&<&'type'&>
2740 .oindex "&%-B%&"
2741 .cindex "8-bit characters"
2742 .cindex "Sendmail compatibility" "8-bit characters"
2743 This is a Sendmail option for selecting 7 or 8 bit processing. Exim is 8-bit
2744 clean; it ignores this option.
2745
2746 .vitem &%-bd%&
2747 .oindex "&%-bd%&"
2748 .cindex "daemon"
2749 .cindex "SMTP" "listener"
2750 .cindex "queue runner"
2751 This option runs Exim as a daemon, awaiting incoming SMTP connections. Usually
2752 the &%-bd%& option is combined with the &%-q%&<&'time'&> option, to specify
2753 that the daemon should also initiate periodic queue runs.
2754
2755 The &%-bd%& option can be used only by an admin user. If either of the &%-d%&
2756 (debugging) or &%-v%& (verifying) options are set, the daemon does not
2757 disconnect from the controlling terminal. When running this way, it can be
2758 stopped by pressing ctrl-C.
2759
2760 By default, Exim listens for incoming connections to the standard SMTP port on
2761 all the host's running interfaces. However, it is possible to listen on other
2762 ports, on multiple ports, and only on specific interfaces. Chapter
2763 &<<CHAPinterfaces>>& contains a description of the options that control this.
2764
2765 When a listening daemon
2766 .cindex "daemon" "process id (pid)"
2767 .cindex "pid (process id)" "of daemon"
2768 is started without the use of &%-oX%& (that is, without overriding the normal
2769 configuration), it writes its process id to a file called &_exim-daemon.pid_&
2770 in Exim's spool directory. This location can be overridden by setting
2771 PID_FILE_PATH in &_Local/Makefile_&. The file is written while Exim is still
2772 running as root.
2773
2774 When &%-oX%& is used on the command line to start a listening daemon, the
2775 process id is not written to the normal pid file path. However, &%-oP%& can be
2776 used to specify a path on the command line if a pid file is required.
2777
2778 The SIGHUP signal
2779 .cindex "SIGHUP"
2780 .cindex restart "on HUP signal"
2781 .cindex signal "HUP, to restart"
2782 .cindex "daemon" "restarting"
2783 .cindex signal "to reload configuration"
2784 .cindex daemon "reload configuration"
2785 .cindex reload configuration
2786 can be used to cause the daemon to re-execute itself. This should be done
2787 whenever Exim's configuration file, or any file that is incorporated into it by
2788 means of the &%.include%& facility, is changed, and also whenever a new version
2789 of Exim is installed. It is not necessary to do this when other files that are
2790 referenced from the configuration (for example, alias files) are changed,
2791 because these are reread each time they are used.
2792
2793 .vitem &%-bdf%&
2794 .oindex "&%-bdf%&"
2795 This option has the same effect as &%-bd%& except that it never disconnects
2796 from the controlling terminal, even when no debugging is specified.
2797
2798 .vitem &%-be%&
2799 .oindex "&%-be%&"
2800 .cindex "testing" "string expansion"
2801 .cindex "expansion" "testing"
2802 Run Exim in expansion testing mode. Exim discards its root privilege, to
2803 prevent ordinary users from using this mode to read otherwise inaccessible
2804 files. If no arguments are given, Exim runs interactively, prompting for lines
2805 of data. Otherwise, it processes each argument in turn.
2806
2807 If Exim was built with USE_READLINE=yes in &_Local/Makefile_&, it tries
2808 to load the &%libreadline%& library dynamically whenever the &%-be%& option is
2809 used without command line arguments. If successful, it uses the &[readline()]&
2810 function, which provides extensive line-editing facilities, for reading the
2811 test data. A line history is supported.
2812
2813 Long expansion expressions can be split over several lines by using backslash
2814 continuations. As in Exim's runtime configuration, white space at the start of
2815 continuation lines is ignored. Each argument or data line is passed through the
2816 string expansion mechanism, and the result is output. Variable values from the
2817 configuration file (for example, &$qualify_domain$&) are available, but no
2818 message-specific values (such as &$message_exim_id$&) are set, because no message
2819 is being processed (but see &%-bem%& and &%-Mset%&).
2820
2821 &*Note*&: If you use this mechanism to test lookups, and you change the data
2822 files or databases you are using, you must exit and restart Exim before trying
2823 the same lookup again. Otherwise, because each Exim process caches the results
2824 of lookups, you will just get the same result as before.
2825
2826 Macro processing is done on lines before string-expansion: new macros can be
2827 defined and macros will be expanded.
2828 Because macros in the config file are often used for secrets, those are only
2829 available to admin users.
2830
2831 .vitem &%-bem%&&~<&'filename'&>
2832 .oindex "&%-bem%&"
2833 .cindex "testing" "string expansion"
2834 .cindex "expansion" "testing"
2835 This option operates like &%-be%& except that it must be followed by the name
2836 of a file. For example:
2837 .code
2838 exim -bem /tmp/testmessage
2839 .endd
2840 The file is read as a message (as if receiving a locally-submitted non-SMTP
2841 message) before any of the test expansions are done. Thus, message-specific
2842 variables such as &$message_size$& and &$header_from:$& are available. However,
2843 no &'Received:'& header is added to the message. If the &%-t%& option is set,
2844 recipients are read from the headers in the normal way, and are shown in the
2845 &$recipients$& variable. Note that recipients cannot be given on the command
2846 line, because further arguments are taken as strings to expand (just like
2847 &%-be%&).
2848
2849 .vitem &%-bF%&&~<&'filename'&>
2850 .oindex "&%-bF%&"
2851 .cindex "system filter" "testing"
2852 .cindex "testing" "system filter"
2853 This option is the same as &%-bf%& except that it assumes that the filter being
2854 tested is a system filter. The additional commands that are available only in
2855 system filters are recognized.
2856
2857 .vitem &%-bf%&&~<&'filename'&>
2858 .oindex "&%-bf%&"
2859 .cindex "filter" "testing"
2860 .cindex "testing" "filter file"
2861 .cindex "forward file" "testing"
2862 .cindex "testing" "forward file"
2863 .cindex "Sieve filter" "testing"
2864 This option runs Exim in user filter testing mode; the file is the filter file
2865 to be tested, and a test message must be supplied on the standard input. If
2866 there are no message-dependent tests in the filter, an empty file can be
2867 supplied.
2868
2869 If you want to test a system filter file, use &%-bF%& instead of &%-bf%&. You
2870 can use both &%-bF%& and &%-bf%& on the same command, in order to test a system
2871 filter and a user filter in the same run. For example:
2872 .code
2873 exim -bF /system/filter -bf /user/filter </test/message
2874 .endd
2875 This is helpful when the system filter adds header lines or sets filter
2876 variables that are used by the user filter.
2877
2878 If the test filter file does not begin with one of the special lines
2879 .code
2880 # Exim filter
2881 # Sieve filter
2882 .endd
2883 it is taken to be a normal &_.forward_& file, and is tested for validity under
2884 that interpretation. See sections &<<SECTitenonfilred>>& to
2885 &<<SECTspecitredli>>& for a description of the possible contents of non-filter
2886 redirection lists.
2887
2888 The result of an Exim command that uses &%-bf%&, provided no errors are
2889 detected, is a list of the actions that Exim would try to take if presented
2890 with the message for real. More details of filter testing are given in the
2891 separate document entitled &'Exim's interfaces to mail filtering'&.
2892
2893 When testing a filter file,
2894 .cindex "&""From""& line"
2895 .cindex "envelope from"
2896 .cindex "envelope sender"
2897 .oindex "&%-f%&" "for filter testing"
2898 the envelope sender can be set by the &%-f%& option,
2899 or by a &"From&~"& line at the start of the test message. Various parameters
2900 that would normally be taken from the envelope recipient address of the message
2901 can be set by means of additional command line options (see the next four
2902 options).
2903
2904 .vitem &%-bfd%&&~<&'domain'&>
2905 .oindex "&%-bfd%&"
2906 .vindex "&$qualify_domain$&"
2907 This sets the domain of the recipient address when a filter file is being
2908 tested by means of the &%-bf%& option. The default is the value of
2909 &$qualify_domain$&.
2910
2911 .vitem &%-bfl%&&~<&'local&~part'&>
2912 .oindex "&%-bfl%&"
2913 This sets the local part of the recipient address when a filter file is being
2914 tested by means of the &%-bf%& option. The default is the username of the
2915 process that calls Exim. A local part should be specified with any prefix or
2916 suffix stripped, because that is how it appears to the filter when a message is
2917 actually being delivered.
2918
2919 .vitem &%-bfp%&&~<&'prefix'&>
2920 .oindex "&%-bfp%&"
2921 .cindex affix "filter testing"
2922 This sets the prefix of the local part of the recipient address when a filter
2923 file is being tested by means of the &%-bf%& option. The default is an empty
2924 prefix.
2925
2926 .vitem &%-bfs%&&~<&'suffix'&>
2927 .oindex "&%-bfs%&"
2928 .cindex affix "filter testing"
2929 This sets the suffix of the local part of the recipient address when a filter
2930 file is being tested by means of the &%-bf%& option. The default is an empty
2931 suffix.
2932
2933 .vitem &%-bh%&&~<&'IP&~address'&>
2934 .oindex "&%-bh%&"
2935 .cindex "testing" "incoming SMTP"
2936 .cindex "SMTP" "testing incoming"
2937 .cindex "testing" "relay control"
2938 .cindex "relaying" "testing configuration"
2939 .cindex "policy control" "testing"
2940 .cindex "debugging" "&%-bh%& option"
2941 This option runs a fake SMTP session as if from the given IP address, using the
2942 standard input and output. The IP address may include a port number at the end,
2943 after a full stop. For example:
2944 .code
2945 exim -bh 10.9.8.7.1234
2946 exim -bh fe80::a00:20ff:fe86:a061.5678
2947 .endd
2948 When an IPv6 address is given, it is converted into canonical form. In the case
2949 of the second example above, the value of &$sender_host_address$& after
2950 conversion to the canonical form is
2951 &`fe80:0000:0000:0a00:20ff:fe86:a061.5678`&.
2952
2953 Comments as to what is going on are written to the standard error file. These
2954 include lines beginning with &"LOG"& for anything that would have been logged.
2955 This facility is provided for testing configuration options for incoming
2956 messages, to make sure they implement the required policy. For example, you can
2957 test your relay controls using &%-bh%&.
2958
2959 &*Warning 1*&:
2960 .cindex "RFC 1413"
2961 You can test features of the configuration that rely on ident (RFC 1413)
2962 information by using the &%-oMt%& option. However, Exim cannot actually perform
2963 an ident callout when testing using &%-bh%& because there is no incoming SMTP
2964 connection.
2965
2966 &*Warning 2*&: Address verification callouts (see section &<<SECTcallver>>&)
2967 are also skipped when testing using &%-bh%&. If you want these callouts to
2968 occur, use &%-bhc%& instead.
2969
2970 Messages supplied during the testing session are discarded, and nothing is
2971 written to any of the real log files. There may be pauses when DNS (and other)
2972 lookups are taking place, and of course these may time out. The &%-oMi%& option
2973 can be used to specify a specific IP interface and port if this is important,
2974 and &%-oMaa%& and &%-oMai%& can be used to set parameters as if the SMTP
2975 session were authenticated.
2976
2977 The &'exim_checkaccess'& utility is a &"packaged"& version of &%-bh%& whose
2978 output just states whether a given recipient address from a given host is
2979 acceptable or not. See section &<<SECTcheckaccess>>&.
2980
2981 Features such as authentication and encryption, where the client input is not
2982 plain text, cannot easily be tested with &%-bh%&. Instead, you should use a
2983 specialized SMTP test program such as
2984 &url(https://www.jetmore.org/john/code/swaks/,swaks).
2985
2986 .vitem &%-bhc%&&~<&'IP&~address'&>
2987 .oindex "&%-bhc%&"
2988 This option operates in the same way as &%-bh%&, except that address
2989 verification callouts are performed if required. This includes consulting and
2990 updating the callout cache database.
2991
2992 .vitem &%-bi%&
2993 .oindex "&%-bi%&"
2994 .cindex "alias file" "building"
2995 .cindex "building alias file"
2996 .cindex "Sendmail compatibility" "&%-bi%& option"
2997 Sendmail interprets the &%-bi%& option as a request to rebuild its alias file.
2998 Exim does not have the concept of a single alias file, and so it cannot mimic
2999 this behaviour. However, calls to &_/usr/lib/sendmail_& with the &%-bi%& option
3000 tend to appear in various scripts such as NIS make files, so the option must be
3001 recognized.
3002
3003 If &%-bi%& is encountered, the command specified by the &%bi_command%&
3004 configuration option is run, under the uid and gid of the caller of Exim. If
3005 the &%-oA%& option is used, its value is passed to the command as an argument.
3006 The command set by &%bi_command%& may not contain arguments. The command can
3007 use the &'exim_dbmbuild'& utility, or some other means, to rebuild alias files
3008 if this is required. If the &%bi_command%& option is not set, calling Exim with
3009 &%-bi%& is a no-op.
3010
3011 . // Keep :help first, then the rest in alphabetical order
3012 .vitem &%-bI:help%&
3013 .oindex "&%-bI:help%&"
3014 .cindex "querying exim information"
3015 We shall provide various options starting &`-bI:`& for querying Exim for
3016 information.  The output of many of these will be intended for machine
3017 consumption.  This one is not.  The &%-bI:help%& option asks Exim for a
3018 synopsis of supported options beginning &`-bI:`&.  Use of any of these
3019 options shall cause Exim to exit after producing the requested output.
3020
3021 .vitem &%-bI:dscp%&
3022 .oindex "&%-bI:dscp%&"
3023 .cindex "DSCP" "values"
3024 This option causes Exim to emit an alphabetically sorted list of all
3025 recognised DSCP names.
3026
3027 .vitem &%-bI:sieve%&
3028 .oindex "&%-bI:sieve%&"
3029 .cindex "Sieve filter" "capabilities"
3030 This option causes Exim to emit an alphabetically sorted list of all supported
3031 Sieve protocol extensions on stdout, one per line.  This is anticipated to be
3032 useful for ManageSieve (RFC 5804) implementations, in providing that protocol's
3033 &`SIEVE`& capability response line.  As the precise list may depend upon
3034 compile-time build options, which this option will adapt to, this is the only
3035 way to guarantee a correct response.
3036
3037 .vitem &%-bm%&
3038 .oindex "&%-bm%&"
3039 .cindex "local message reception"
3040 This option runs an Exim receiving process that accepts an incoming,
3041 locally-generated message on the standard input. The recipients are given as the
3042 command arguments (except when &%-t%& is also present &-- see below). Each
3043 argument can be a comma-separated list of RFC 2822 addresses. This is the
3044 default option for selecting the overall action of an Exim call; it is assumed
3045 if no other conflicting option is present.
3046
3047 If any addresses in the message are unqualified (have no domain), they are
3048 qualified by the values of the &%qualify_domain%& or &%qualify_recipient%&
3049 options, as appropriate. The &%-bnq%& option (see below) provides a way of
3050 suppressing this for special cases.
3051
3052 Policy checks on the contents of local messages can be enforced by means of
3053 the non-SMTP ACL. See chapter &<<CHAPACL>>& for details.
3054
3055 .cindex "return code" "for &%-bm%&"
3056 The return code is zero if the message is successfully accepted. Otherwise, the
3057 action is controlled by the &%-oe%&&'x'& option setting &-- see below.
3058
3059 The format
3060 .cindex "message" "format"
3061 .cindex "format" "message"
3062 .cindex "&""From""& line"
3063 .cindex "UUCP" "&""From""& line"
3064 .cindex "Sendmail compatibility" "&""From""& line"
3065 of the message must be as defined in RFC 2822, except that, for
3066 compatibility with Sendmail and Smail, a line in one of the forms
3067 .code
3068 From sender Fri Jan  5 12:55 GMT 1997
3069 From sender Fri, 5 Jan 97 12:55:01
3070 .endd
3071 (with the weekday optional, and possibly with additional text after the date)
3072 is permitted to appear at the start of the message. There appears to be no
3073 authoritative specification of the format of this line. Exim recognizes it by
3074 matching against the regular expression defined by the &%uucp_from_pattern%&
3075 option, which can be changed if necessary.
3076
3077 .oindex "&%-f%&" "overriding &""From""& line"
3078 The specified sender is treated as if it were given as the argument to the
3079 &%-f%& option, but if a &%-f%& option is also present, its argument is used in
3080 preference to the address taken from the message. The caller of Exim must be a
3081 trusted user for the sender of a message to be set in this way.
3082
3083 .vitem &%-bmalware%&&~<&'filename'&>
3084 .oindex "&%-bmalware%&"
3085 .cindex "testing", "malware"
3086 .cindex "malware scan test"
3087 This debugging option causes Exim to scan the given file or directory
3088 (depending on the used scanner interface),
3089 using the malware scanning framework.  The option of &%av_scanner%& influences
3090 this option, so if &%av_scanner%&'s value is dependent upon an expansion then
3091 the expansion should have defaults which apply to this invocation.  ACLs are
3092 not invoked, so if &%av_scanner%& references an ACL variable then that variable
3093 will never be populated and &%-bmalware%& will fail.
3094
3095 Exim will have changed working directory before resolving the filename, so
3096 using fully qualified pathnames is advisable.  Exim will be running as the Exim
3097 user when it tries to open the file, rather than as the invoking user.
3098 This option requires admin privileges.
3099
3100 The &%-bmalware%& option will not be extended to be more generally useful,
3101 there are better tools for file-scanning.  This option exists to help
3102 administrators verify their Exim and AV scanner configuration.
3103
3104 .vitem &%-bnq%&
3105 .oindex "&%-bnq%&"
3106 .cindex "address qualification, suppressing"
3107 By default, Exim automatically qualifies unqualified addresses (those
3108 without domains) that appear in messages that are submitted locally (that
3109 is, not over TCP/IP). This qualification applies both to addresses in
3110 envelopes, and addresses in header lines. Sender addresses are qualified using
3111 &%qualify_domain%&, and recipient addresses using &%qualify_recipient%& (which
3112 defaults to the value of &%qualify_domain%&).
3113
3114 Sometimes, qualification is not wanted. For example, if &%-bS%& (batch SMTP) is
3115 being used to re-submit messages that originally came from remote hosts after
3116 content scanning, you probably do not want to qualify unqualified addresses in
3117 header lines. (Such lines will be present only if you have not enabled a header
3118 syntax check in the appropriate ACL.)
3119
3120 The &%-bnq%& option suppresses all qualification of unqualified addresses in
3121 messages that originate on the local host. When this is used, unqualified
3122 addresses in the envelope provoke errors (causing message rejection) and
3123 unqualified addresses in header lines are left alone.
3124
3125
3126 .vitem &%-bP%&
3127 .oindex "&%-bP%&"
3128 .cindex "configuration options" "extracting"
3129 .cindex "options" "configuration &-- extracting"
3130 If this option is given with no arguments, it causes the values of all Exim's
3131 main configuration options to be written to the standard output. The values
3132 of one or more specific options can be requested by giving their names as
3133 arguments, for example:
3134 .code
3135 exim -bP qualify_domain hold_domains
3136 .endd
3137 .cindex "hiding configuration option values"
3138 .cindex "configuration options" "hiding value of"
3139 .cindex "options" "hiding value of"
3140 However, any option setting that is preceded by the word &"hide"& in the
3141 configuration file is not shown in full, except to an admin user. For other
3142 users, the output is as in this example:
3143 .code
3144 mysql_servers = <value not displayable>
3145 .endd
3146 If &%config%& is given as an argument, the config is
3147 output, as it was parsed, any include file resolved, any comment removed.
3148
3149 If &%config_file%& is given as an argument, the name of the runtime
3150 configuration file is output. (&%configure_file%& works too, for
3151 backward compatibility.)
3152 If a list of configuration files was supplied, the value that is output here
3153 is the name of the file that was actually used.
3154
3155 .cindex "options" "hiding name of"
3156 If the &%-n%& flag is given, then for most modes of &%-bP%& operation the
3157 name will not be output.
3158
3159 .cindex "daemon" "process id (pid)"
3160 .cindex "pid (process id)" "of daemon"
3161 If &%log_file_path%& or &%pid_file_path%& are given, the names of the
3162 directories where log files and daemon pid files are written are output,
3163 respectively. If these values are unset, log files are written in a
3164 sub-directory of the spool directory called &%log%&, and the pid file is
3165 written directly into the spool directory.
3166
3167 If &%-bP%& is followed by a name preceded by &`+`&, for example,
3168 .code
3169 exim -bP +local_domains
3170 .endd
3171 it searches for a matching named list of any type (domain, host, address, or
3172 local part) and outputs what it finds.
3173
3174 .cindex "options" "router &-- extracting"
3175 .cindex "options" "transport &-- extracting"
3176 .cindex "options" "authenticator &-- extracting"
3177 If one of the words &%router%&, &%transport%&, or &%authenticator%& is given,
3178 followed by the name of an appropriate driver instance, the option settings for
3179 that driver are output. For example:
3180 .code
3181 exim -bP transport local_delivery
3182 .endd
3183 The generic driver options are output first, followed by the driver's private
3184 options. A list of the names of drivers of a particular type can be obtained by
3185 using one of the words &%router_list%&, &%transport_list%&, or
3186 &%authenticator_list%&, and a complete list of all drivers with their option
3187 settings can be obtained by using &%routers%&, &%transports%&, or
3188 &%authenticators%&.
3189
3190 .cindex "environment"
3191 If &%environment%& is given as an argument, the set of environment
3192 variables is output, line by line. Using the &%-n%& flag suppresses the value of the
3193 variables.
3194
3195 .cindex "options" "macro &-- extracting"
3196 If invoked by an admin user, then &%macro%&, &%macro_list%& and &%macros%&
3197 are available, similarly to the drivers.  Because macros are sometimes used
3198 for storing passwords, this option is restricted.
3199 The output format is one item per line.
3200 For the "-bP macro <name>" form, if no such macro is found
3201 the exit status will be nonzero.
3202
3203 .vitem &%-bp%&
3204 .oindex "&%-bp%&"
3205 .cindex "queue" "listing messages in"
3206 .cindex "listing" "messages in the queue"
3207 This option requests a listing of the contents of the mail queue on the
3208 standard output. If the &%-bp%& option is followed by a list of message ids,
3209 just those messages are listed. By default, this option can be used only by an
3210 admin user. However, the &%queue_list_requires_admin%& option can be set false
3211 to allow any user to see the queue.
3212
3213 Each message in the queue is displayed as in the following example:
3214 .code
3215 25m  2.9K 0t5C6f-0000c8-00 <alice@wonderland.fict.example>
3216           red.king@looking-glass.fict.example
3217           <other addresses>
3218 .endd
3219 .cindex "message" "size in queue listing"
3220 .cindex "size" "of message"
3221 The first line contains the length of time the message has been in the queue
3222 (in this case 25 minutes), the size of the message (2.9K), the unique local
3223 identifier for the message, and the message sender, as contained in the
3224 envelope. For bounce messages, the sender address is empty, and appears as
3225 &"<>"&. If the message was submitted locally by an untrusted user who overrode
3226 the default sender address, the user's login name is shown in parentheses
3227 before the sender address.
3228
3229 .cindex "frozen messages" "in queue listing"
3230 If the message is frozen (attempts to deliver it are suspended) then the text
3231 &"*** frozen ***"& is displayed at the end of this line.
3232
3233 The recipients of the message (taken from the envelope, not the headers) are
3234 displayed on subsequent lines. Those addresses to which the message has already
3235 been delivered are marked with the letter D. If an original address gets
3236 expanded into several addresses via an alias or forward file, the original is
3237 displayed with a D only when deliveries for all of its child addresses are
3238 complete.
3239
3240
3241 .vitem &%-bpa%&
3242 .oindex "&%-bpa%&"
3243 This option operates like &%-bp%&, but in addition it shows delivered addresses
3244 that were generated from the original top level address(es) in each message by
3245 alias or forwarding operations. These addresses are flagged with &"+D"& instead
3246 of just &"D"&.
3247
3248
3249 .vitem &%-bpc%&
3250 .oindex "&%-bpc%&"
3251 .cindex "queue" "count of messages on"
3252 This option counts the number of messages in the queue, and writes the total
3253 to the standard output. It is restricted to admin users, unless
3254 &%queue_list_requires_admin%& is set false.
3255
3256
3257 .vitem &%-bpr%&
3258 .oindex "&%-bpr%&"
3259 This option operates like &%-bp%&, but the output is not sorted into
3260 chronological order of message arrival. This can speed it up when there are
3261 lots of messages in the queue, and is particularly useful if the output is
3262 going to be post-processed in a way that doesn't need the sorting.
3263
3264 .vitem &%-bpra%&
3265 .oindex "&%-bpra%&"
3266 This option is a combination of &%-bpr%& and &%-bpa%&.
3267
3268 .vitem &%-bpru%&
3269 .oindex "&%-bpru%&"
3270 This option is a combination of &%-bpr%& and &%-bpu%&.
3271
3272
3273 .vitem &%-bpu%&
3274 .oindex "&%-bpu%&"
3275 This option operates like &%-bp%& but shows only undelivered top-level
3276 addresses for each message displayed. Addresses generated by aliasing or
3277 forwarding are not shown, unless the message was deferred after processing by a
3278 router with the &%one_time%& option set.
3279
3280
3281 .vitem &%-brt%&
3282 .oindex "&%-brt%&"
3283 .cindex "testing" "retry configuration"
3284 .cindex "retry" "configuration testing"
3285 This option is for testing retry rules, and it must be followed by up to three
3286 arguments. It causes Exim to look for a retry rule that matches the values
3287 and to write it to the standard output. For example:
3288 .code
3289 exim -brt bach.comp.mus.example
3290 Retry rule: *.comp.mus.example  F,2h,15m; F,4d,30m;
3291 .endd
3292 See chapter &<<CHAPretry>>& for a description of Exim's retry rules. The first
3293 argument, which is required, can be a complete address in the form
3294 &'local_part@domain'&, or it can be just a domain name. If the second argument
3295 contains a dot, it is interpreted as an optional second domain name; if no
3296 retry rule is found for the first argument, the second is tried. This ties in
3297 with Exim's behaviour when looking for retry rules for remote hosts &-- if no
3298 rule is found that matches the host, one that matches the mail domain is
3299 sought. Finally, an argument that is the name of a specific delivery error, as
3300 used in setting up retry rules, can be given. For example:
3301 .code
3302 exim -brt haydn.comp.mus.example quota_3d
3303 Retry rule: *@haydn.comp.mus.example quota_3d  F,1h,15m
3304 .endd
3305
3306 .vitem &%-brw%&
3307 .oindex "&%-brw%&"
3308 .cindex "testing" "rewriting"
3309 .cindex "rewriting" "testing"
3310 This option is for testing address rewriting rules, and it must be followed by
3311 a single argument, consisting of either a local part without a domain, or a
3312 complete address with a fully qualified domain. Exim outputs how this address
3313 would be rewritten for each possible place it might appear. See chapter
3314 &<<CHAPrewrite>>& for further details.
3315
3316 .vitem &%-bS%&
3317 .oindex "&%-bS%&"
3318 .cindex "SMTP" "batched incoming"
3319 .cindex "batched SMTP input"
3320 This option is used for batched SMTP input, which is an alternative interface
3321 for non-interactive local message submission. A number of messages can be
3322 submitted in a single run. However, despite its name, this is not really SMTP
3323 input. Exim reads each message's envelope from SMTP commands on the standard
3324 input, but generates no responses. If the caller is trusted, or
3325 &%untrusted_set_sender%& is set, the senders in the SMTP MAIL commands are
3326 believed; otherwise the sender is always the caller of Exim.
3327
3328 The message itself is read from the standard input, in SMTP format (leading
3329 dots doubled), terminated by a line containing just a single dot. An error is
3330 provoked if the terminating dot is missing. A further message may then follow.
3331
3332 As for other local message submissions, the contents of incoming batch SMTP
3333 messages can be checked using the non-SMTP ACL (see chapter &<<CHAPACL>>&).
3334 Unqualified addresses are automatically qualified using &%qualify_domain%& and
3335 &%qualify_recipient%&, as appropriate, unless the &%-bnq%& option is used.
3336
3337 Some other SMTP commands are recognized in the input. HELO and EHLO act
3338 as RSET; VRFY, EXPN, ETRN, and HELP act as NOOP;
3339 QUIT quits, ignoring the rest of the standard input.
3340
3341 .cindex "return code" "for &%-bS%&"
3342 If any error is encountered, reports are written to the standard output and
3343 error streams, and Exim gives up immediately. The return code is 0 if no error
3344 was detected; it is 1 if one or more messages were accepted before the error
3345 was detected; otherwise it is 2.
3346
3347 More details of input using batched SMTP are given in section
3348 &<<SECTincomingbatchedSMTP>>&.
3349
3350 .vitem &%-bs%&
3351 .oindex "&%-bs%&"
3352 .cindex "SMTP" "local input"
3353 .cindex "local SMTP input"
3354 This option causes Exim to accept one or more messages by reading SMTP commands
3355 on the standard input, and producing SMTP replies on the standard output. SMTP
3356 policy controls, as defined in ACLs (see chapter &<<CHAPACL>>&) are applied.
3357 Some user agents use this interface as a way of passing locally-generated
3358 messages to the MTA.
3359
3360 In
3361 .cindex "sender" "source of"
3362 this usage, if the caller of Exim is trusted, or &%untrusted_set_sender%& is
3363 set, the senders of messages are taken from the SMTP MAIL commands.
3364 Otherwise the content of these commands is ignored and the sender is set up as
3365 the calling user. Unqualified addresses are automatically qualified using
3366 &%qualify_domain%& and &%qualify_recipient%&, as appropriate, unless the
3367 &%-bnq%& option is used.
3368
3369 .cindex "inetd"
3370 The
3371 &%-bs%& option is also used to run Exim from &'inetd'&, as an alternative to
3372 using a listening daemon. Exim can distinguish the two cases by checking
3373 whether the standard input is a TCP/IP socket. When Exim is called from
3374 &'inetd'&, the source of the mail is assumed to be remote, and the comments
3375 above concerning senders and qualification do not apply. In this situation,
3376 Exim behaves in exactly the same way as it does when receiving a message via
3377 the listening daemon.
3378
3379 .vitem &%-bt%&
3380 .oindex "&%-bt%&"
3381 .cindex "testing" "addresses"
3382 .cindex "address" "testing"
3383 This option runs Exim in address testing mode, in which each argument is taken
3384 as a recipient address to be tested for deliverability. The results are
3385 written to the standard output. If a test fails, and the caller is not an admin
3386 user, no details of the failure are output, because these might contain
3387 sensitive information such as usernames and passwords for database lookups.
3388
3389 If no arguments are given, Exim runs in an interactive manner, prompting with a
3390 right angle bracket for addresses to be tested.
3391
3392 Unlike the &%-be%& test option, you cannot arrange for Exim to use the
3393 &[readline()]& function, because it is running as &'root'& and there are
3394 security issues.
3395
3396 Each address is handled as if it were the recipient address of a message
3397 (compare the &%-bv%& option). It is passed to the routers and the result is
3398 written to the standard output. However, any router that has
3399 &%no_address_test%& set is bypassed. This can make &%-bt%& easier to use for
3400 genuine routing tests if your first router passes everything to a scanner
3401 program.
3402
3403 .cindex "return code" "for &%-bt%&"
3404 The return code is 2 if any address failed outright; it is 1 if no address
3405 failed outright but at least one could not be resolved for some reason. Return
3406 code 0 is given only when all addresses succeed.
3407
3408 .cindex "duplicate addresses"
3409 &*Note*&: When actually delivering a message, Exim removes duplicate recipient
3410 addresses after routing is complete, so that only one delivery takes place.
3411 This does not happen when testing with &%-bt%&; the full results of routing are
3412 always shown.
3413
3414 &*Warning*&: &%-bt%& can only do relatively simple testing. If any of the
3415 routers in the configuration makes any tests on the sender address of a
3416 message,
3417 .oindex "&%-f%&" "for address testing"
3418 you can use the &%-f%& option to set an appropriate sender when running
3419 &%-bt%& tests. Without it, the sender is assumed to be the calling user at the
3420 default qualifying domain. However, if you have set up (for example) routers
3421 whose behaviour depends on the contents of an incoming message, you cannot test
3422 those conditions using &%-bt%&. The &%-N%& option provides a possible way of
3423 doing such tests.
3424
3425 .vitem &%-bV%&
3426 .oindex "&%-bV%&"
3427 .cindex "version number of Exim"
3428 This option causes Exim to write the current version number, compilation
3429 number, and compilation date of the &'exim'& binary to the standard output.
3430 It also lists the DBM library that is being used, the optional modules (such as
3431 specific lookup types), the drivers that are included in the binary, and the
3432 name of the runtime configuration file that is in use.
3433
3434 As part of its operation, &%-bV%& causes Exim to read and syntax check its
3435 configuration file. However, this is a static check only. It cannot check
3436 values that are to be expanded. For example, although a misspelt ACL verb is
3437 detected, an error in the verb's arguments is not. You cannot rely on &%-bV%&
3438 alone to discover (for example) all the typos in the configuration; some
3439 realistic testing is needed. The &%-bh%& and &%-N%& options provide more
3440 dynamic testing facilities.
3441
3442 .vitem &%-bv%&
3443 .oindex "&%-bv%&"
3444 .cindex "verifying address" "using &%-bv%&"
3445 .cindex "address" "verification"
3446 This option runs Exim in address verification mode, in which each argument is
3447 taken as a recipient address to be verified by the routers. (This does
3448 not involve any verification callouts). During normal operation, verification
3449 happens mostly as a consequence processing a &%verify%& condition in an ACL
3450 (see chapter &<<CHAPACL>>&). If you want to test an entire ACL, possibly
3451 including callouts, see the &%-bh%& and &%-bhc%& options.
3452
3453 If verification fails, and the caller is not an admin user, no details of the
3454 failure are output, because these might contain sensitive information such as
3455 usernames and passwords for database lookups.
3456
3457 If no arguments are given, Exim runs in an interactive manner, prompting with a
3458 right angle bracket for addresses to be verified.
3459
3460 Unlike the &%-be%& test option, you cannot arrange for Exim to use the
3461 &[readline()]& function, because it is running as &'exim'& and there are
3462 security issues.
3463
3464 Verification differs from address testing (the &%-bt%& option) in that routers
3465 that have &%no_verify%& set are skipped, and if the address is accepted by a
3466 router that has &%fail_verify%& set, verification fails. The address is
3467 verified as a recipient if &%-bv%& is used; to test verification for a sender
3468 address, &%-bvs%& should be used.
3469
3470 If the &%-v%& option is not set, the output consists of a single line for each
3471 address, stating whether it was verified or not, and giving a reason in the
3472 latter case. Without &%-v%&, generating more than one address by redirection
3473 causes verification to end successfully, without considering the generated
3474 addresses. However, if just one address is generated, processing continues,
3475 and the generated address must verify successfully for the overall verification
3476 to succeed.
3477
3478 When &%-v%& is set, more details are given of how the address has been handled,
3479 and in the case of address redirection, all the generated addresses are also
3480 considered. Verification may succeed for some and fail for others.
3481
3482 The
3483 .cindex "return code" "for &%-bv%&"
3484 return code is 2 if any address failed outright; it is 1 if no address
3485 failed outright but at least one could not be resolved for some reason. Return
3486 code 0 is given only when all addresses succeed.
3487
3488 If any of the routers in the configuration makes any tests on the sender
3489 address of a message, you should use the &%-f%& option to set an appropriate
3490 sender when running &%-bv%& tests. Without it, the sender is assumed to be the
3491 calling user at the default qualifying domain.
3492
3493 .vitem &%-bvs%&
3494 .oindex "&%-bvs%&"
3495 This option acts like &%-bv%&, but verifies the address as a sender rather
3496 than a recipient address. This affects any rewriting and qualification that
3497 might happen.
3498
3499 .vitem &%-bw%&
3500 .oindex "&%-bw%&"
3501 .cindex "daemon"
3502 .cindex "inetd"
3503 .cindex "inetd" "wait mode"
3504 This option runs Exim as a daemon, awaiting incoming SMTP connections,
3505 similarly to the &%-bd%& option.  All port specifications on the command-line
3506 and in the configuration file are ignored.  Queue-running may not be specified.
3507
3508 In this mode, Exim expects to be passed a socket as fd 0 (stdin) which is
3509 listening for connections.  This permits the system to start up and have
3510 inetd (or equivalent) listen on the SMTP ports, starting an Exim daemon for
3511 each port only when the first connection is received.
3512
3513 If the option is given as &%-bw%&<&'time'&> then the time is a timeout, after
3514 which the daemon will exit, which should cause inetd to listen once more.
3515
3516 .vitem &%-C%&&~<&'filelist'&>
3517 .oindex "&%-C%&"
3518 .cindex "configuration file" "alternate"
3519 .cindex "CONFIGURE_FILE"
3520 .cindex "alternate configuration file"
3521 This option causes Exim to find the runtime configuration file from the given
3522 list instead of from the list specified by the CONFIGURE_FILE
3523 compile-time setting. Usually, the list will consist of just a single filename,
3524 but it can be a colon-separated list of names. In this case, the first
3525 file that exists is used. Failure to open an existing file stops Exim from
3526 proceeding any further along the list, and an error is generated.
3527
3528 When this option is used by a caller other than root, and the list is different
3529 from the compiled-in list, Exim gives up its root privilege immediately, and
3530 runs with the real and effective uid and gid set to those of the caller.
3531 However, if a TRUSTED_CONFIG_LIST file is defined in &_Local/Makefile_&, that
3532 file contains a list of full pathnames, one per line, for configuration files
3533 which are trusted. Root privilege is retained for any configuration file so
3534 listed, as long as the caller is the Exim user (or the user specified in the
3535 CONFIGURE_OWNER option, if any), and as long as the configuration file is
3536 not writeable by inappropriate users or groups.
3537
3538 Leaving TRUSTED_CONFIG_LIST unset precludes the possibility of testing a
3539 configuration using &%-C%& right through message reception and delivery,
3540 even if the caller is root. The reception works, but by that time, Exim is
3541 running as the Exim user, so when it re-executes to regain privilege for the
3542 delivery, the use of &%-C%& causes privilege to be lost. However, root can
3543 test reception and delivery using two separate commands (one to put a message
3544 in the queue, using &%-odq%&, and another to do the delivery, using &%-M%&).
3545
3546 If ALT_CONFIG_PREFIX is defined &_in Local/Makefile_&, it specifies a
3547 prefix string with which any file named in a &%-C%& command line option
3548 must start. In addition, the filename must not contain the sequence &`/../`&.
3549 However, if the value of the &%-C%& option is identical to the value of
3550 CONFIGURE_FILE in &_Local/Makefile_&, Exim ignores &%-C%& and proceeds as
3551 usual. There is no default setting for ALT_CONFIG_PREFIX; when it is
3552 unset, any filename can be used with &%-C%&.
3553
3554 ALT_CONFIG_PREFIX can be used to confine alternative configuration files
3555 to a directory to which only root has access. This prevents someone who has
3556 broken into the Exim account from running a privileged Exim with an arbitrary
3557 configuration file.
3558
3559 The &%-C%& facility is useful for ensuring that configuration files are
3560 syntactically correct, but cannot be used for test deliveries, unless the
3561 caller is privileged, or unless it is an exotic configuration that does not
3562 require privilege. No check is made on the owner or group of the files
3563 specified by this option.
3564
3565
3566 .vitem &%-D%&<&'macro'&>=<&'value'&>
3567 .oindex "&%-D%&"
3568 .cindex "macro" "setting on command line"
3569 This option can be used to override macro definitions in the configuration file
3570 (see section &<<SECTmacrodefs>>&). However, like &%-C%&, if it is used by an
3571 unprivileged caller, it causes Exim to give up its root privilege.
3572 If DISABLE_D_OPTION is defined in &_Local/Makefile_&, the use of &%-D%& is
3573 completely disabled, and its use causes an immediate error exit.
3574
3575 If WHITELIST_D_MACROS is defined in &_Local/Makefile_& then it should be a
3576 colon-separated list of macros which are considered safe and, if &%-D%& only
3577 supplies macros from this list, and the values are acceptable, then Exim will
3578 not give up root privilege if the caller is root, the Exim run-time user, or
3579 the CONFIGURE_OWNER, if set.  This is a transition mechanism and is expected
3580 to be removed in the future.  Acceptable values for the macros satisfy the
3581 regexp: &`^[A-Za-z0-9_/.-]*$`&
3582
3583 The entire option (including equals sign if present) must all be within one
3584 command line item. &%-D%& can be used to set the value of a macro to the empty
3585 string, in which case the equals sign is optional. These two commands are
3586 synonymous:
3587 .code
3588 exim -DABC  ...
3589 exim -DABC= ...
3590 .endd
3591 To include spaces in a macro definition item, quotes must be used. If you use
3592 quotes, spaces are permitted around the macro name and the equals sign. For
3593 example:
3594 .code
3595 exim '-D ABC = something' ...
3596 .endd
3597 &%-D%& may be repeated up to 10 times on a command line.
3598 Only macro names up to 22 letters long can be set.
3599
3600
3601 .vitem &%-d%&<&'debug&~options'&>
3602 .oindex "&%-d%&"
3603 .cindex "debugging" "list of selectors"
3604 .cindex "debugging" "&%-d%& option"
3605 This option causes debugging information to be written to the standard
3606 error stream. It is restricted to admin users because debugging output may show
3607 database queries that contain password information. Also, the details of users'
3608 filter files should be protected. If a non-admin user uses &%-d%&, Exim
3609 writes an error message to the standard error stream and exits with a non-zero
3610 return code.
3611
3612 When &%-d%& is used, &%-v%& is assumed. If &%-d%& is given on its own, a lot of
3613 standard debugging data is output. This can be reduced, or increased to include
3614 some more rarely needed information, by directly following &%-d%& with a string
3615 made up of names preceded by plus or minus characters. These add or remove sets
3616 of debugging data, respectively. For example, &%-d+filter%& adds filter
3617 debugging, whereas &%-d-all+filter%& selects only filter debugging. Note that
3618 no spaces are allowed in the debug setting. The available debugging categories
3619 are:
3620 .display
3621 &`acl            `& ACL interpretation
3622 &`auth           `& authenticators
3623 &`deliver        `& general delivery logic
3624 &`dns            `& DNS lookups (see also resolver)
3625 &`dnsbl          `& DNS black list (aka RBL) code
3626 &`exec           `& arguments for &[execv()]& calls
3627 &`expand         `& detailed debugging for string expansions
3628 &`filter         `& filter handling
3629 &`hints_lookup   `& hints data lookups
3630 &`host_lookup    `& all types of name-to-IP address handling
3631 &`ident          `& ident lookup
3632 &`interface      `& lists of local interfaces
3633 &`lists          `& matching things in lists
3634 &`load           `& system load checks
3635 &`local_scan     `& can be used by &[local_scan()]& (see chapter &&&
3636                     &<<CHAPlocalscan>>&)
3637 &`lookup         `& general lookup code and all lookups
3638 &`memory         `& memory handling
3639 &`noutf8         `& modifier: avoid UTF-8 line-drawing
3640 &`pid            `& modifier: add pid to debug output lines
3641 &`process_info   `& setting info for the process log
3642 &`queue_run      `& queue runs
3643 &`receive        `& general message reception logic
3644 &`resolver       `& turn on the DNS resolver's debugging output
3645 &`retry          `& retry handling
3646 &`rewrite        `& address rewriting
3647 &`route          `& address routing
3648 &`timestamp      `& modifier: add timestamp to debug output lines
3649 &`tls            `& TLS logic
3650 &`transport      `& transports
3651 &`uid            `& changes of uid/gid and looking up uid/gid
3652 &`verify         `& address verification logic
3653 &`all            `& almost all of the above (see below), and also &%-v%&
3654 .endd
3655 The &`all`& option excludes &`memory`& when used as &`+all`&, but includes it
3656 for &`-all`&. The reason for this is that &`+all`& is something that people
3657 tend to use when generating debug output for Exim maintainers. If &`+memory`&
3658 is included, an awful lot of output that is very rarely of interest is
3659 generated, so it now has to be explicitly requested. However, &`-all`& does
3660 turn everything off.
3661
3662 .cindex "resolver, debugging output"
3663 .cindex "DNS resolver, debugging output"
3664 The &`resolver`& option produces output only if the DNS resolver was compiled
3665 with DEBUG enabled. This is not the case in some operating systems. Also,
3666 unfortunately, debugging output from the DNS resolver is written to stdout
3667 rather than stderr.
3668
3669 The default (&%-d%& with no argument) omits &`expand`&, &`filter`&,
3670 &`interface`&, &`load`&, &`memory`&, &`pid`&, &`resolver`&, and &`timestamp`&.
3671 However, the &`pid`& selector is forced when debugging is turned on for a
3672 daemon, which then passes it on to any re-executed Exims. Exim also
3673 automatically adds the pid to debug lines when several remote deliveries are
3674 run in parallel.
3675
3676 The &`timestamp`& selector causes the current time to be inserted at the start
3677 of all debug output lines. This can be useful when trying to track down delays
3678 in processing.
3679
3680 .cindex debugging "UTF-8 in"
3681 .cindex UTF-8 "in debug output"
3682 The &`noutf8`& selector disables the use of
3683 UTF-8 line-drawing characters to group related information.
3684 When disabled. ascii-art is used instead.
3685 Using the &`+all`& option does not set this modifier,
3686
3687 If the &%debug_print%& option is set in any driver, it produces output whenever
3688 any debugging is selected, or if &%-v%& is used.
3689
3690 .vitem &%-dd%&<&'debug&~options'&>
3691 .oindex "&%-dd%&"
3692 This option behaves exactly like &%-d%& except when used on a command that
3693 starts a daemon process. In that case, debugging is turned off for the
3694 subprocesses that the daemon creates. Thus, it is useful for monitoring the
3695 behaviour of the daemon without creating as much output as full debugging does.
3696
3697 .vitem &%-dropcr%&
3698 .oindex "&%-dropcr%&"
3699 This is an obsolete option that is now a no-op. It used to affect the way Exim
3700 handled CR and LF characters in incoming messages. What happens now is
3701 described in section &<<SECTlineendings>>&.
3702
3703 .vitem &%-E%&
3704 .oindex "&%-E%&"
3705 .cindex "bounce message" "generating"
3706 This option specifies that an incoming message is a locally-generated delivery
3707 failure report. It is used internally by Exim when handling delivery failures
3708 and is not intended for external use. Its only effect is to stop Exim
3709 generating certain messages to the postmaster, as otherwise message cascades
3710 could occur in some situations. As part of the same option, a message id may
3711 follow the characters &%-E%&. If it does, the log entry for the receipt of the
3712 new message contains the id, following &"R="&, as a cross-reference.
3713
3714 .vitem &%-e%&&'x'&
3715 .oindex "&%-e%&&'x'&"
3716 There are a number of Sendmail options starting with &%-oe%& which seem to be
3717 called by various programs without the leading &%o%& in the option. For
3718 example, the &%vacation%& program uses &%-eq%&. Exim treats all options of the
3719 form &%-e%&&'x'& as synonymous with the corresponding &%-oe%&&'x'& options.
3720
3721 .vitem &%-F%&&~<&'string'&>
3722 .oindex "&%-F%&"
3723 .cindex "sender" "name"
3724 .cindex "name" "of sender"
3725 This option sets the sender's full name for use when a locally-generated
3726 message is being accepted. In the absence of this option, the user's &'gecos'&
3727 entry from the password data is used. As users are generally permitted to alter
3728 their &'gecos'& entries, no security considerations are involved. White space
3729 between &%-F%& and the <&'string'&> is optional.
3730
3731 .vitem &%-f%&&~<&'address'&>
3732 .oindex "&%-f%&"
3733 .cindex "sender" "address"
3734 .cindex "address" "sender"
3735 .cindex "trusted users"
3736 .cindex "envelope from"
3737 .cindex "envelope sender"
3738 .cindex "user" "trusted"
3739 This option sets the address of the envelope sender of a locally-generated
3740 message (also known as the return path). The option can normally be used only
3741 by a trusted user, but &%untrusted_set_sender%& can be set to allow untrusted
3742 users to use it.
3743
3744 Processes running as root or the Exim user are always trusted. Other
3745 trusted users are defined by the &%trusted_users%& or &%trusted_groups%&
3746 options. In the absence of &%-f%&, or if the caller is not trusted, the sender
3747 of a local message is set to the caller's login name at the default qualify
3748 domain.
3749
3750 There is one exception to the restriction on the use of &%-f%&: an empty sender
3751 can be specified by any user, trusted or not, to create a message that can
3752 never provoke a bounce. An empty sender can be specified either as an empty
3753 string, or as a pair of angle brackets with nothing between them, as in these
3754 examples of shell commands:
3755 .code
3756 exim -f '<>' user@domain
3757 exim -f "" user@domain
3758 .endd
3759 In addition, the use of &%-f%& is not restricted when testing a filter file
3760 with &%-bf%& or when testing or verifying addresses using the &%-bt%& or
3761 &%-bv%& options.
3762
3763 Allowing untrusted users to change the sender address does not of itself make
3764 it possible to send anonymous mail. Exim still checks that the &'From:'& header
3765 refers to the local user, and if it does not, it adds a &'Sender:'& header,
3766 though this can be overridden by setting &%no_local_from_check%&.
3767
3768 White
3769 .cindex "&""From""& line"
3770 space between &%-f%& and the <&'address'&> is optional (that is, they can be
3771 given as two arguments or one combined argument). The sender of a
3772 locally-generated message can also be set (when permitted) by an initial
3773 &"From&~"& line in the message &-- see the description of &%-bm%& above &-- but
3774 if &%-f%& is also present, it overrides &"From&~"&.
3775
3776 .vitem &%-G%&
3777 .oindex "&%-G%&"
3778 .cindex "submission fixups, suppressing (command-line)"
3779 This option is equivalent to an ACL applying:
3780 .code
3781 control = suppress_local_fixups
3782 .endd
3783 for every message received.  Note that Sendmail will complain about such
3784 bad formatting, where Exim silently just does not fix it up.  This may change
3785 in future.
3786
3787 As this affects audit information, the caller must be a trusted user to use
3788 this option.
3789
3790 .vitem &%-h%&&~<&'number'&>
3791 .oindex "&%-h%&"
3792 .cindex "Sendmail compatibility" "&%-h%& option ignored"
3793 This option is accepted for compatibility with Sendmail, but has no effect. (In
3794 Sendmail it overrides the &"hop count"& obtained by counting &'Received:'&
3795 headers.)
3796
3797 .vitem &%-i%&
3798 .oindex "&%-i%&"
3799 .cindex "Solaris" "&'mail'& command"
3800 .cindex "dot" "in incoming non-SMTP message"
3801 This option, which has the same effect as &%-oi%&, specifies that a dot on a
3802 line by itself should not terminate an incoming, non-SMTP message. I can find
3803 no documentation for this option in Solaris 2.4 Sendmail, but the &'mailx'&
3804 command in Solaris 2.4 uses it. See also &%-ti%&.
3805
3806 .vitem &%-L%&&~<&'tag'&>
3807 .oindex "&%-L%&"
3808 .cindex "syslog" "process name; set with flag"
3809 This option is equivalent to setting &%syslog_processname%& in the config
3810 file and setting &%log_file_path%& to &`syslog`&.
3811 Its use is restricted to administrators.  The configuration file has to be
3812 read and parsed, to determine access rights, before this is set and takes
3813 effect, so early configuration file errors will not honour this flag.
3814
3815 The tag should not be longer than 32 characters.
3816
3817 .vitem &%-M%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3818 .oindex "&%-M%&"
3819 .cindex "forcing delivery"
3820 .cindex "delivery" "forcing attempt"
3821 .cindex "frozen messages" "forcing delivery"
3822 This option requests Exim to run a delivery attempt on each message in turn. If
3823 any of the messages are frozen, they are automatically thawed before the
3824 delivery attempt. The settings of &%queue_domains%&, &%queue_smtp_domains%&,
3825 and &%hold_domains%& are ignored.
3826
3827 Retry
3828 .cindex "hints database" "overriding retry hints"
3829 hints for any of the addresses are overridden &-- Exim tries to deliver even if
3830 the normal retry time has not yet been reached. This option requires the caller
3831 to be an admin user. However, there is an option called &%prod_requires_admin%&
3832 which can be set false to relax this restriction (and also the same requirement
3833 for the &%-q%&, &%-R%&, and &%-S%& options).
3834
3835 The deliveries happen synchronously, that is, the original Exim process does
3836 not terminate until all the delivery attempts have finished. No output is
3837 produced unless there is a serious error. If you want to see what is happening,
3838 use the &%-v%& option as well, or inspect Exim's main log.
3839
3840 .vitem &%-Mar%&&~<&'message&~id'&>&~<&'address'&>&~<&'address'&>&~...
3841 .oindex "&%-Mar%&"
3842 .cindex "message" "adding recipients"
3843 .cindex "recipient" "adding"
3844 This option requests Exim to add the addresses to the list of recipients of the
3845 message (&"ar"& for &"add recipients"&). The first argument must be a message
3846 id, and the remaining ones must be email addresses. However, if the message is
3847 active (in the middle of a delivery attempt), it is not altered. This option
3848 can be used only by an admin user.
3849
3850 .vitem "&%-MC%&&~<&'transport'&>&~<&'hostname'&>&~<&'sequence&~number'&>&&&
3851         &~<&'message&~id'&>"
3852 .oindex "&%-MC%&"
3853 .cindex "SMTP" "passed connection"
3854 .cindex "SMTP" "multiple deliveries"
3855 .cindex "multiple SMTP deliveries"
3856 This option is not intended for use by external callers. It is used internally
3857 by Exim to invoke another instance of itself to deliver a waiting message using
3858 an existing SMTP connection, which is passed as the standard input. Details are
3859 given in chapter &<<CHAPSMTP>>&. This must be the final option, and the caller
3860 must be root or the Exim user in order to use it.
3861
3862 .vitem &%-MCA%&
3863 .oindex "&%-MCA%&"
3864 This option is not intended for use by external callers. It is used internally
3865 by Exim in conjunction with the &%-MC%& option. It signifies that the
3866 connection to the remote host has been authenticated.
3867
3868 .vitem &%-MCD%&
3869 .oindex "&%-MCD%&"
3870 This option is not intended for use by external callers. It is used internally
3871 by Exim in conjunction with the &%-MC%& option. It signifies that the
3872 remote host supports the ESMTP &_DSN_& extension.
3873
3874 .new
3875 .vitem &%-MCd%&
3876 .oindex "&%-MCd%&"
3877 This option is not intended for use by external callers. It is used internally
3878 by Exim in conjunction with the &%-d%& option
3879 to pass on an information string on the purpose of the process.
3880 .wen
3881
3882 .vitem &%-MCG%&&~<&'queue&~name'&>
3883 .oindex "&%-MCG%&"
3884 This option is not intended for use by external callers. It is used internally
3885 by Exim in conjunction with the &%-MC%& option. It signifies that an
3886 alternate queue is used, named by the following argument.
3887
3888 .vitem &%-MCK%&
3889 .oindex "&%-MCK%&"
3890 This option is not intended for use by external callers. It is used internally
3891 by Exim in conjunction with the &%-MC%& option. It signifies that a
3892 remote host supports the ESMTP &_CHUNKING_& extension.
3893
3894 .vitem &%-MCP%&
3895 .oindex "&%-MCP%&"
3896 This option is not intended for use by external callers. It is used internally
3897 by Exim in conjunction with the &%-MC%& option. It signifies that the server to
3898 which Exim is connected supports pipelining.
3899
3900 .vitem &%-MCQ%&&~<&'process&~id'&>&~<&'pipe&~fd'&>
3901 .oindex "&%-MCQ%&"
3902 This option is not intended for use by external callers. It is used internally
3903 by Exim in conjunction with the &%-MC%& option when the original delivery was
3904 started by a queue runner. It passes on the process id of the queue runner,
3905 together with the file descriptor number of an open pipe. Closure of the pipe
3906 signals the final completion of the sequence of processes that are passing
3907 messages through the same SMTP connection.
3908
3909 .vitem &%-MCS%&
3910 .oindex "&%-MCS%&"
3911 This option is not intended for use by external callers. It is used internally
3912 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3913 ESMTP SIZE option should be used on messages delivered down the existing
3914 connection.
3915
3916 .vitem &%-MCT%&
3917 .oindex "&%-MCT%&"
3918 This option is not intended for use by external callers. It is used internally
3919 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3920 host to which Exim is connected supports TLS encryption.
3921
3922 .vitem &%-MCt%&&~<&'IP&~address'&>&~<&'port'&>&~<&'cipher'&>
3923 .oindex "&%-MCt%&"
3924 This option is not intended for use by external callers. It is used internally
3925 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3926 connection is being proxied by a parent process for handling TLS encryption.
3927 The arguments give the local address and port being proxied, and the TLS cipher.
3928
3929 .vitem &%-Mc%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3930 .oindex "&%-Mc%&"
3931 .cindex "hints database" "not overridden by &%-Mc%&"
3932 .cindex "delivery" "manually started &-- not forced"
3933 This option requests Exim to run a delivery attempt on each message, in turn,
3934 but unlike the &%-M%& option, it does check for retry hints, and respects any
3935 that are found. This option is not very useful to external callers. It is
3936 provided mainly for internal use by Exim when it needs to re-invoke itself in
3937 order to regain root privilege for a delivery (see chapter &<<CHAPsecurity>>&).
3938 However, &%-Mc%& can be useful when testing, in order to run a delivery that
3939 respects retry times and other options such as &%hold_domains%& that are
3940 overridden when &%-M%& is used. Such a delivery does not count as a queue run.
3941 If you want to run a specific delivery as if in a queue run, you should use
3942 &%-q%& with a message id argument. A distinction between queue run deliveries
3943 and other deliveries is made in one or two places.
3944
3945 .vitem &%-Mes%&&~<&'message&~id'&>&~<&'address'&>
3946 .oindex "&%-Mes%&"
3947 .cindex "message" "changing sender"
3948 .cindex "sender" "changing"
3949 This option requests Exim to change the sender address in the message to the
3950 given address, which must be a fully qualified address or &"<>"& (&"es"& for
3951 &"edit sender"&). There must be exactly two arguments. The first argument must
3952 be a message id, and the second one an email address. However, if the message
3953 is active (in the middle of a delivery attempt), its status is not altered.
3954 This option can be used only by an admin user.
3955
3956 .vitem &%-Mf%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3957 .oindex "&%-Mf%&"
3958 .cindex "freezing messages"
3959 .cindex "message" "manually freezing"
3960 This option requests Exim to mark each listed message as &"frozen"&. This
3961 prevents any delivery attempts taking place until the message is &"thawed"&,
3962 either manually or as a result of the &%auto_thaw%& configuration option.
3963 However, if any of the messages are active (in the middle of a delivery
3964 attempt), their status is not altered. This option can be used only by an admin
3965 user.
3966
3967 .vitem &%-Mg%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3968 .oindex "&%-Mg%&"
3969 .cindex "giving up on messages"
3970 .cindex "message" "abandoning delivery attempts"
3971 .cindex "delivery" "abandoning further attempts"
3972 This option requests Exim to give up trying to deliver the listed messages,
3973 including any that are frozen. However, if any of the messages are active,
3974 their status is not altered. For non-bounce messages, a delivery error message
3975 is sent to the sender, containing the text &"cancelled by administrator"&.
3976 Bounce messages are just discarded. This option can be used only by an admin
3977 user.
3978
3979 .vitem &%-MG%&&~<&'queue&~name'&>&~<&'message&~id'&>&~<&'message&~id'&>&~...
3980 .oindex "&%-MG%&"
3981 .cindex queue named
3982 .cindex "named queues" "moving messages"
3983 .cindex "queue" "moving messages"
3984 This option requests that each listed message be moved from its current
3985 queue to the given named queue.
3986 The destination queue name argument is required, but can be an empty
3987 string to define the default queue.
3988 If the messages are not currently located in the default queue,
3989 a &%-qG<name>%& option will be required to define the source queue.
3990
3991 .vitem &%-Mmad%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3992 .oindex "&%-Mmad%&"
3993 .cindex "delivery" "cancelling all"
3994 This option requests Exim to mark all the recipient addresses in the messages
3995 as already delivered (&"mad"& for &"mark all delivered"&). However, if any
3996 message is active (in the middle of a delivery attempt), its status is not
3997 altered. This option can be used only by an admin user.
3998
3999 .vitem &%-Mmd%&&~<&'message&~id'&>&~<&'address'&>&~<&'address'&>&~...
4000 .oindex "&%-Mmd%&"
4001 .cindex "delivery" "cancelling by address"
4002 .cindex "recipient" "removing"
4003 .cindex "removing recipients"
4004 This option requests Exim to mark the given addresses as already delivered
4005 (&"md"& for &"mark delivered"&). The first argument must be a message id, and
4006 the remaining ones must be email addresses. These are matched to recipient
4007 addresses in the message in a case-sensitive manner. If the message is active
4008 (in the middle of a delivery attempt), its status is not altered. This option
4009 can be used only by an admin user.
4010
4011 .vitem &%-Mrm%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
4012 .oindex "&%-Mrm%&"
4013 .cindex "removing messages"
4014 .cindex "abandoning mail"
4015 .cindex "message" "manually discarding"
4016 This option requests Exim to remove the given messages from the queue. No
4017 bounce messages are sent; each message is simply forgotten. However, if any of
4018 the messages are active, their status is not altered. This option can be used
4019 only by an admin user or by the user who originally caused the message to be
4020 placed in the queue.
4021
4022 . .new
4023 . .vitem &%-MS%&
4024 . .oindex "&%-MS%&"
4025 . .cindex REQUIRETLS
4026 . This option is used to request REQUIRETLS processing on the message.
4027 . It is used internally by Exim in conjunction with -E when generating
4028 . a bounce message.
4029 . .wen
4030
4031 .vitem &%-Mset%&&~<&'message&~id'&>
4032 .oindex "&%-Mset%&"
4033 .cindex "testing" "string expansion"
4034 .cindex "expansion" "testing"
4035 This option is useful only in conjunction with &%-be%& (that is, when testing
4036 string expansions). Exim loads the given message from its spool before doing
4037 the test expansions, thus setting message-specific variables such as
4038 &$message_size$& and the header variables. The &$recipients$& variable is made
4039 available. This feature is provided to make it easier to test expansions that
4040 make use of these variables. However, this option can be used only by an admin
4041 user. See also &%-bem%&.
4042
4043 .vitem &%-Mt%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
4044 .oindex "&%-Mt%&"
4045 .cindex "thawing messages"
4046 .cindex "unfreezing messages"
4047 .cindex "frozen messages" "thawing"
4048 .cindex "message" "thawing frozen"
4049 This option requests Exim to &"thaw"& any of the listed messages that are
4050 &"frozen"&, so that delivery attempts can resume. However, if any of the
4051 messages are active, their status is not altered. This option can be used only
4052 by an admin user.
4053
4054 .vitem &%-Mvb%&&~<&'message&~id'&>
4055 .oindex "&%-Mvb%&"
4056 .cindex "listing" "message body"
4057 .cindex "message" "listing body of"
4058 This option causes the contents of the message body (-D) spool file to be
4059 written to the standard output. This option can be used only by an admin user.
4060
4061 .vitem &%-Mvc%&&~<&'message&~id'&>
4062 .oindex "&%-Mvc%&"
4063 .cindex "message" "listing in RFC 2822 format"
4064 .cindex "listing" "message in RFC 2822 format"
4065 This option causes a copy of the complete message (header lines plus body) to
4066 be written to the standard output in RFC 2822 format. This option can be used
4067 only by an admin user.
4068
4069 .vitem &%-Mvh%&&~<&'message&~id'&>
4070 .oindex "&%-Mvh%&"
4071 .cindex "listing" "message headers"
4072 .cindex "header lines" "listing"
4073 .cindex "message" "listing header lines"
4074 This option causes the contents of the message headers (-H) spool file to be
4075 written to the standard output. This option can be used only by an admin user.
4076
4077 .vitem &%-Mvl%&&~<&'message&~id'&>
4078 .oindex "&%-Mvl%&"
4079 .cindex "listing" "message log"
4080 .cindex "message" "listing message log"
4081 This option causes the contents of the message log spool file to be written to
4082 the standard output. This option can be used only by an admin user.
4083
4084 .vitem &%-m%&
4085 .oindex "&%-m%&"
4086 This is apparently a synonym for &%-om%& that is accepted by Sendmail, so Exim
4087 treats it that way too.
4088
4089 .vitem &%-N%&
4090 .oindex "&%-N%&"
4091 .cindex "debugging" "&%-N%& option"
4092 .cindex "debugging" "suppressing delivery"
4093 This is a debugging option that inhibits delivery of a message at the transport
4094 level. It implies &%-v%&. Exim goes through many of the motions of delivery &--
4095 it just doesn't actually transport the message, but instead behaves as if it
4096 had successfully done so. However, it does not make any updates to the retry
4097 database, and the log entries for deliveries are flagged with &"*>"& rather
4098 than &"=>"&.
4099
4100 Because &%-N%& discards any message to which it applies, only root or the Exim
4101 user are allowed to use it with &%-bd%&, &%-q%&, &%-R%& or &%-M%&. In other
4102 words, an ordinary user can use it only when supplying an incoming message to
4103 which it will apply. Although transportation never fails when &%-N%& is set, an
4104 address may be deferred because of a configuration problem on a transport, or a
4105 routing problem. Once &%-N%& has been used for a delivery attempt, it sticks to
4106 the message, and applies to any subsequent delivery attempts that may happen
4107 for that message.
4108
4109 .vitem &%-n%&
4110 .oindex "&%-n%&"
4111 This option is interpreted by Sendmail to mean &"no aliasing"&.
4112 For normal modes of operation, it is ignored by Exim.
4113 When combined with &%-bP%& it makes the output more terse (suppresses
4114 option names, environment values and config pretty printing).
4115
4116 .vitem &%-O%&&~<&'data'&>
4117 .oindex "&%-O%&"
4118 This option is interpreted by Sendmail to mean &`set option`&. It is ignored by
4119 Exim.
4120
4121 .vitem &%-oA%&&~<&'file&~name'&>
4122 .oindex "&%-oA%&"
4123 .cindex "Sendmail compatibility" "&%-oA%& option"
4124 This option is used by Sendmail in conjunction with &%-bi%& to specify an
4125 alternative alias filename. Exim handles &%-bi%& differently; see the
4126 description above.
4127
4128 .vitem &%-oB%&&~<&'n'&>
4129 .oindex "&%-oB%&"
4130 .cindex "SMTP" "passed connection"
4131 .cindex "SMTP" "multiple deliveries"
4132 .cindex "multiple SMTP deliveries"
4133 This is a debugging option which limits the maximum number of messages that can
4134 be delivered down one SMTP connection, overriding the value set in any &(smtp)&
4135 transport. If <&'n'&> is omitted, the limit is set to 1.
4136
4137 .vitem &%-odb%&
4138 .oindex "&%-odb%&"
4139 .cindex "background delivery"
4140 .cindex "delivery" "in the background"
4141 This option applies to all modes in which Exim accepts incoming messages,
4142 including the listening daemon. It requests &"background"& delivery of such
4143 messages, which means that the accepting process automatically starts a
4144 delivery process for each message received, but does not wait for the delivery
4145 processes to finish.
4146
4147 When all the messages have been received, the reception process exits,
4148 leaving the delivery processes to finish in their own time. The standard output
4149 and error streams are closed at the start of each delivery process.
4150 This is the default action if none of the &%-od%& options are present.
4151
4152 If one of the queueing options in the configuration file
4153 (&%queue_only%& or &%queue_only_file%&, for example) is in effect, &%-odb%&
4154 overrides it if &%queue_only_override%& is set true, which is the default
4155 setting. If &%queue_only_override%& is set false, &%-odb%& has no effect.
4156
4157 .vitem &%-odf%&
4158 .oindex "&%-odf%&"
4159 .cindex "foreground delivery"
4160 .cindex "delivery" "in the foreground"
4161 This option requests &"foreground"& (synchronous) delivery when Exim has
4162 accepted a locally-generated message. (For the daemon it is exactly the same as
4163 &%-odb%&.) A delivery process is automatically started to deliver the message,
4164 and Exim waits for it to complete before proceeding.
4165
4166 The original Exim reception process does not finish until the delivery
4167 process for the final message has ended. The standard error stream is left open
4168 during deliveries.
4169
4170 However, like &%-odb%&, this option has no effect if &%queue_only_override%& is
4171 false and one of the queueing options in the configuration file is in effect.
4172
4173 If there is a temporary delivery error during foreground delivery, the
4174 message is left in the queue for later delivery, and the original reception
4175 process exits. See chapter &<<CHAPnonqueueing>>& for a way of setting up a
4176 restricted configuration that never queues messages.
4177
4178
4179 .vitem &%-odi%&
4180 .oindex "&%-odi%&"
4181 This option is synonymous with &%-odf%&. It is provided for compatibility with
4182 Sendmail.
4183
4184 .vitem &%-odq%&
4185 .oindex "&%-odq%&"
4186 .cindex "non-immediate delivery"
4187 .cindex "delivery" "suppressing immediate"
4188 .cindex "queueing incoming messages"
4189 This option applies to all modes in which Exim accepts incoming messages,
4190 including the listening daemon. It specifies that the accepting process should
4191 not automatically start a delivery process for each message received. Messages
4192 are placed in the queue, and remain there until a subsequent queue runner
4193 process encounters them. There are several configuration options (such as
4194 &%queue_only%&) that can be used to queue incoming messages under certain
4195 conditions. This option overrides all of them and also &%-odqs%&. It always
4196 forces queueing.
4197
4198 .vitem &%-odqs%&
4199 .oindex "&%-odqs%&"
4200 .cindex "SMTP" "delaying delivery"
4201 .cindex "first pass routing"
4202 This option is a hybrid between &%-odb%&/&%-odi%& and &%-odq%&.
4203 However, like &%-odb%& and &%-odi%&, this option has no effect if
4204 &%queue_only_override%& is false and one of the queueing options in the
4205 configuration file is in effect.
4206
4207 When &%-odqs%& does operate, a delivery process is started for each incoming
4208 message, in the background by default, but in the foreground if &%-odi%& is
4209 also present. The recipient addresses are routed, and local deliveries are done
4210 in the normal way. However, if any SMTP deliveries are required, they are not
4211 done at this time, so the message remains in the queue until a subsequent queue
4212 runner process encounters it. Because routing was done, Exim knows which
4213 messages are waiting for which hosts, and so a number of messages for the same
4214 host can be sent in a single SMTP connection. The &%queue_smtp_domains%&
4215 configuration option has the same effect for specific domains. See also the
4216 &%-qq%& option.
4217
4218 .vitem &%-oee%&
4219 .oindex "&%-oee%&"
4220 .cindex "error" "reporting"
4221 If an error is detected while a non-SMTP message is being received (for
4222 example, a malformed address), the error is reported to the sender in a mail
4223 message.
4224
4225 .cindex "return code" "for &%-oee%&"
4226 Provided
4227 this error message is successfully sent, the Exim receiving process
4228 exits with a return code of zero. If not, the return code is 2 if the problem
4229 is that the original message has no recipients, or 1 for any other error.
4230 This is the default &%-oe%&&'x'& option if Exim is called as &'rmail'&.
4231
4232 .vitem &%-oem%&
4233 .oindex "&%-oem%&"
4234 .cindex "error" "reporting"
4235 .cindex "return code" "for &%-oem%&"
4236 This is the same as &%-oee%&, except that Exim always exits with a non-zero
4237 return code, whether or not the error message was successfully sent.
4238 This is the default &%-oe%&&'x'& option, unless Exim is called as &'rmail'&.
4239
4240 .vitem &%-oep%&
4241 .oindex "&%-oep%&"
4242 .cindex "error" "reporting"
4243 If an error is detected while a non-SMTP message is being received, the
4244 error is reported by writing a message to the standard error file (stderr).
4245 .cindex "return code" "for &%-oep%&"
4246 The return code is 1 for all errors.
4247
4248 .vitem &%-oeq%&
4249 .oindex "&%-oeq%&"
4250 .cindex "error" "reporting"
4251 This option is supported for compatibility with Sendmail, but has the same
4252 effect as &%-oep%&.
4253
4254 .vitem &%-oew%&
4255 .oindex "&%-oew%&"
4256 .cindex "error" "reporting"
4257 This option is supported for compatibility with Sendmail, but has the same
4258 effect as &%-oem%&.
4259
4260 .vitem &%-oi%&
4261 .oindex "&%-oi%&"
4262 .cindex "dot" "in incoming non-SMTP message"
4263 This option, which has the same effect as &%-i%&, specifies that a dot on a
4264 line by itself should not terminate an incoming, non-SMTP message. Otherwise, a
4265 single dot does terminate, though Exim does no special processing for other
4266 lines that start with a dot. This option is set by default if Exim is called as
4267 &'rmail'&. See also &%-ti%&.
4268
4269 .vitem &%-oitrue%&
4270 .oindex "&%-oitrue%&"
4271 This option is treated as synonymous with &%-oi%&.
4272
4273 .vitem &%-oMa%&&~<&'host&~address'&>
4274 .oindex "&%-oMa%&"
4275 .cindex "sender" "host address, specifying for local message"
4276 A number of options starting with &%-oM%& can be used to set values associated
4277 with remote hosts on locally-submitted messages (that is, messages not received
4278 over TCP/IP). These options can be used by any caller in conjunction with the
4279 &%-bh%&, &%-be%&, &%-bf%&, &%-bF%&, &%-bt%&, or &%-bv%& testing options. In
4280 other circumstances, they are ignored unless the caller is trusted.
4281
4282 The &%-oMa%& option sets the sender host address. This may include a port
4283 number at the end, after a full stop (period). For example:
4284 .code
4285 exim -bs -oMa 10.9.8.7.1234
4286 .endd
4287 An alternative syntax is to enclose the IP address in square brackets,
4288 followed by a colon and the port number:
4289 .code
4290 exim -bs -oMa [10.9.8.7]:1234
4291 .endd
4292 The IP address is placed in the &$sender_host_address$& variable, and the
4293 port, if present, in &$sender_host_port$&. If both &%-oMa%& and &%-bh%&
4294 are present on the command line, the sender host IP address is taken from
4295 whichever one is last.
4296
4297 .vitem &%-oMaa%&&~<&'name'&>
4298 .oindex "&%-oMaa%&"
4299 .cindex "authentication" "name, specifying for local message"
4300 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMaa%&
4301 option sets the value of &$sender_host_authenticated$& (the authenticator
4302 name). See chapter &<<CHAPSMTPAUTH>>& for a discussion of SMTP authentication.
4303 This option can be used with &%-bh%& and &%-bs%& to set up an
4304 authenticated SMTP session without actually using the SMTP AUTH command.
4305
4306 .vitem &%-oMai%&&~<&'string'&>
4307 .oindex "&%-oMai%&"
4308 .cindex "authentication" "id, specifying for local message"
4309 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMai%&
4310 option sets the value of &$authenticated_id$& (the id that was authenticated).
4311 This overrides the default value (the caller's login id, except with &%-bh%&,
4312 where there is no default) for messages from local sources. See chapter
4313 &<<CHAPSMTPAUTH>>& for a discussion of authenticated ids.
4314
4315 .vitem &%-oMas%&&~<&'address'&>
4316 .oindex "&%-oMas%&"
4317 .cindex "authentication" "sender, specifying for local message"
4318 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMas%&
4319 option sets the authenticated sender value in &$authenticated_sender$&. It
4320 overrides the sender address that is created from the caller's login id for
4321 messages from local sources, except when &%-bh%& is used, when there is no
4322 default. For both &%-bh%& and &%-bs%&, an authenticated sender that is
4323 specified on a MAIL command overrides this value. See chapter
4324 &<<CHAPSMTPAUTH>>& for a discussion of authenticated senders.
4325
4326 .vitem &%-oMi%&&~<&'interface&~address'&>
4327 .oindex "&%-oMi%&"
4328 .cindex "interface" "address, specifying for local message"
4329 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMi%&
4330 option sets the IP interface address value. A port number may be included,
4331 using the same syntax as for &%-oMa%&. The interface address is placed in
4332 &$received_ip_address$& and the port number, if present, in &$received_port$&.
4333
4334 .vitem &%-oMm%&&~<&'message&~reference'&>
4335 .oindex "&%-oMm%&"
4336 .cindex "message reference" "message reference, specifying for local message"
4337 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMm%&
4338 option sets the message reference, e.g. message-id, and is logged during
4339 delivery. This is useful when some kind of audit trail is required to tie
4340 messages together. The format of the message reference is checked and will
4341 abort if the format is invalid. The option will only be accepted if exim is
4342 running in trusted mode, not as any regular user.
4343
4344 The best example of a message reference is when Exim sends a bounce message.
4345 The message reference is the message-id of the original message for which Exim
4346 is sending the bounce.
4347
4348 .vitem &%-oMr%&&~<&'protocol&~name'&>
4349 .oindex "&%-oMr%&"
4350 .cindex "protocol, specifying for local message"
4351 .vindex "&$received_protocol$&"
4352 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMr%&
4353 option sets the received protocol value that is stored in
4354 &$received_protocol$&. However, it does not apply (and is ignored) when &%-bh%&
4355 or &%-bs%& is used. For &%-bh%&, the protocol is forced to one of the standard
4356 SMTP protocol names (see the description of &$received_protocol$& in section
4357 &<<SECTexpvar>>&). For &%-bs%&, the protocol is always &"local-"& followed by
4358 one of those same names. For &%-bS%& (batched SMTP) however, the protocol can
4359 be set by &%-oMr%&. Repeated use of this option is not supported.
4360
4361 .vitem &%-oMs%&&~<&'host&~name'&>
4362 .oindex "&%-oMs%&"
4363 .cindex "sender" "host name, specifying for local message"
4364 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMs%&
4365 option sets the sender host name in &$sender_host_name$&. When this option is
4366 present, Exim does not attempt to look up a host name from an IP address; it
4367 uses the name it is given.
4368
4369 .vitem &%-oMt%&&~<&'ident&~string'&>
4370 .oindex "&%-oMt%&"
4371 .cindex "sender" "ident string, specifying for local message"
4372 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMt%&
4373 option sets the sender ident value in &$sender_ident$&. The default setting for
4374 local callers is the login id of the calling process, except when &%-bh%& is
4375 used, when there is no default.
4376
4377 .vitem &%-om%&
4378 .oindex "&%-om%&"
4379 .cindex "Sendmail compatibility" "&%-om%& option ignored"
4380 In Sendmail, this option means &"me too"&, indicating that the sender of a
4381 message should receive a copy of the message if the sender appears in an alias
4382 expansion. Exim always does this, so the option does nothing.
4383
4384 .vitem &%-oo%&
4385 .oindex "&%-oo%&"
4386 .cindex "Sendmail compatibility" "&%-oo%& option ignored"
4387 This option is ignored. In Sendmail it specifies &"old style headers"&,
4388 whatever that means.
4389
4390 .vitem &%-oP%&&~<&'path'&>
4391 .oindex "&%-oP%&"
4392 .cindex "pid (process id)" "of daemon"
4393 .cindex "daemon" "process id (pid)"
4394 This option is useful only in conjunction with &%-bd%& or &%-q%& with a time
4395 value. The option specifies the file to which the process id of the daemon is
4396 written. When &%-oX%& is used with &%-bd%&, or when &%-q%& with a time is used
4397 without &%-bd%&, this is the only way of causing Exim to write a pid file,
4398 because in those cases, the normal pid file is not used.
4399
4400 .new
4401 .vitem &%-oPX%&
4402 .oindex "&%-oPX%&"
4403 .cindex "pid (process id)" "of daemon"
4404 .cindex "daemon" "process id (pid)"
4405 This option is not intended for general use.
4406 The daemon uses it when terminating due to a SIGTEM, possibly in
4407 combination with &%-oP%&&~<&'path'&>.
4408 It causes the pid file to be removed.
4409 .wen
4410
4411 .vitem &%-or%&&~<&'time'&>
4412 .oindex "&%-or%&"
4413 .cindex "timeout" "for non-SMTP input"
4414 This option sets a timeout value for incoming non-SMTP messages. If it is not
4415 set, Exim will wait forever for the standard input. The value can also be set
4416 by the &%receive_timeout%& option. The format used for specifying times is
4417 described in section &<<SECTtimeformat>>&.
4418
4419 .vitem &%-os%&&~<&'time'&>
4420 .oindex "&%-os%&"
4421 .cindex "timeout" "for SMTP input"
4422 .cindex "SMTP" "input timeout"
4423 This option sets a timeout value for incoming SMTP messages. The timeout
4424 applies to each SMTP command and block of data. The value can also be set by
4425 the &%smtp_receive_timeout%& option; it defaults to 5 minutes. The format used
4426 for specifying times is described in section &<<SECTtimeformat>>&.
4427
4428 .vitem &%-ov%&
4429 .oindex "&%-ov%&"
4430 This option has exactly the same effect as &%-v%&.
4431
4432 .vitem &%-oX%&&~<&'number&~or&~string'&>
4433 .oindex "&%-oX%&"
4434 .cindex "TCP/IP" "setting listening ports"
4435 .cindex "TCP/IP" "setting listening interfaces"
4436 .cindex "port" "receiving TCP/IP"
4437 This option is relevant only when the &%-bd%& (start listening daemon) option
4438 is also given. It controls which ports and interfaces the daemon uses. Details
4439 of the syntax, and how it interacts with configuration file options, are given
4440 in chapter &<<CHAPinterfaces>>&. When &%-oX%& is used to start a daemon, no pid
4441 file is written unless &%-oP%& is also present to specify a pid filename.
4442
4443 .vitem &%-pd%&
4444 .oindex "&%-pd%&"
4445 .cindex "Perl" "starting the interpreter"
4446 This option applies when an embedded Perl interpreter is linked with Exim (see
4447 chapter &<<CHAPperl>>&). It overrides the setting of the &%perl_at_start%&
4448 option, forcing the starting of the interpreter to be delayed until it is
4449 needed.
4450
4451 .vitem &%-ps%&
4452 .oindex "&%-ps%&"
4453 .cindex "Perl" "starting the interpreter"
4454 This option applies when an embedded Perl interpreter is linked with Exim (see
4455 chapter &<<CHAPperl>>&). It overrides the setting of the &%perl_at_start%&
4456 option, forcing the starting of the interpreter to occur as soon as Exim is
4457 started.
4458
4459 .vitem &%-p%&<&'rval'&>:<&'sval'&>
4460 .oindex "&%-p%&"
4461 For compatibility with Sendmail, this option is equivalent to
4462 .display
4463 &`-oMr`& <&'rval'&> &`-oMs`& <&'sval'&>
4464 .endd
4465 It sets the incoming protocol and host name (for trusted callers). The
4466 host name and its colon can be omitted when only the protocol is to be set.
4467 Note the Exim already has two private options, &%-pd%& and &%-ps%&, that refer
4468 to embedded Perl. It is therefore impossible to set a protocol value of &`d`&
4469 or &`s`& using this option (but that does not seem a real limitation).
4470 Repeated use of this option is not supported.
4471
4472 .vitem &%-q%&
4473 .oindex "&%-q%&"
4474 .cindex "queue runner" "starting manually"
4475 This option is normally restricted to admin users. However, there is a
4476 configuration option called &%prod_requires_admin%& which can be set false to
4477 relax this restriction (and also the same requirement for the &%-M%&, &%-R%&,
4478 and &%-S%& options).
4479
4480 .cindex "queue runner" "description of operation"
4481 If other commandline options do not specify an action,
4482 the &%-q%& option starts one queue runner process. This scans the queue of
4483 waiting messages, and runs a delivery process for each one in turn. It waits
4484 for each delivery process to finish before starting the next one. A delivery
4485 process may not actually do any deliveries if the retry times for the addresses
4486 have not been reached. Use &%-qf%& (see below) if you want to override this.
4487
4488 If
4489 .cindex "SMTP" "passed connection"
4490 .cindex "SMTP" "multiple deliveries"
4491 .cindex "multiple SMTP deliveries"
4492 the delivery process spawns other processes to deliver other messages down
4493 passed SMTP connections, the queue runner waits for these to finish before
4494 proceeding.
4495
4496 When all the queued messages have been considered, the original queue runner
4497 process terminates. In other words, a single pass is made over the waiting
4498 mail, one message at a time. Use &%-q%& with a time (see below) if you want
4499 this to be repeated periodically.
4500
4501 Exim processes the waiting messages in an unpredictable order. It isn't very
4502 random, but it is likely to be different each time, which is all that matters.
4503 If one particular message screws up a remote MTA, other messages to the same
4504 MTA have a chance of getting through if they get tried first.
4505
4506 It is possible to cause the messages to be processed in lexical message id
4507 order, which is essentially the order in which they arrived, by setting the
4508 &%queue_run_in_order%& option, but this is not recommended for normal use.
4509
4510 .vitem &%-q%&<&'qflags'&>
4511 The &%-q%& option may be followed by one or more flag letters that change its
4512 behaviour. They are all optional, but if more than one is present, they must
4513 appear in the correct order. Each flag is described in a separate item below.
4514
4515 .vitem &%-qq...%&
4516 .oindex "&%-qq%&"
4517 .cindex "queue" "double scanning"
4518 .cindex "queue" "routing"
4519 .cindex "routing" "whole queue before delivery"
4520 .cindex "first pass routing"
4521 An option starting with &%-qq%& requests a two-stage queue run. In the first
4522 stage, the queue is scanned as if the &%queue_smtp_domains%& option matched
4523 every domain. Addresses are routed, local deliveries happen, but no remote
4524 transports are run.
4525
4526 .new
4527 Performance will be best if the &%queue_run_in_order%& option is false.
4528 .wen
4529
4530 .cindex "hints database" "remembering routing"
4531 The hints database that remembers which messages are waiting for specific hosts
4532 is updated, as if delivery to those hosts had been deferred. After this is
4533 complete, a second, normal queue scan happens, with routing and delivery taking
4534 place as normal. Messages that are routed to the same host should mostly be
4535 delivered down a single SMTP
4536 .cindex "SMTP" "passed connection"
4537 .cindex "SMTP" "multiple deliveries"
4538 .cindex "multiple SMTP deliveries"
4539 connection because of the hints that were set up during the first queue scan.
4540 This option may be useful for hosts that are connected to the Internet
4541 intermittently.
4542
4543 .vitem &%-q[q]i...%&
4544 .oindex "&%-qi%&"
4545 .cindex "queue" "initial delivery"
4546 If the &'i'& flag is present, the queue runner runs delivery processes only for
4547 those messages that haven't previously been tried. (&'i'& stands for &"initial
4548 delivery"&.) This can be helpful if you are putting messages in the queue using
4549 &%-odq%& and want a queue runner just to process the new messages.
4550
4551 .vitem &%-q[q][i]f...%&
4552 .oindex "&%-qf%&"
4553 .cindex "queue" "forcing delivery"
4554 .cindex "delivery" "forcing in queue run"
4555 If one &'f'& flag is present, a delivery attempt is forced for each non-frozen
4556 message, whereas without &'f'& only those non-frozen addresses that have passed
4557 their retry times are tried.
4558
4559 .vitem &%-q[q][i]ff...%&
4560 .oindex "&%-qff%&"
4561 .cindex "frozen messages" "forcing delivery"
4562 If &'ff'& is present, a delivery attempt is forced for every message, whether
4563 frozen or not.
4564
4565 .vitem &%-q[q][i][f[f]]l%&
4566 .oindex "&%-ql%&"
4567 .cindex "queue" "local deliveries only"
4568 The &'l'& (the letter &"ell"&) flag specifies that only local deliveries are to
4569 be done. If a message requires any remote deliveries, it remains in the queue
4570 for later delivery.
4571
4572 .vitem &%-q[q][i][f[f]][l][G<name>[/<time>]]]%&
4573 .oindex "&%-qG%&"
4574 .cindex queue named
4575 .cindex "named queues"  "deliver from"
4576 .cindex "queue" "delivering specific messages"
4577 If the &'G'& flag and a name is present, the queue runner operates on the
4578 queue with the given name rather than the default queue.
4579 The name should not contain a &'/'& character.
4580 For a periodic queue run (see below)
4581 append to the name a slash and a time value.
4582
4583 If other commandline options specify an action, a &'-qG<name>'& option
4584 will specify a queue to operate on.
4585 For example:
4586 .code
4587 exim -bp -qGquarantine
4588 mailq -qGquarantine
4589 exim -qGoffpeak -Rf @special.domain.example
4590 .endd
4591
4592 .vitem &%-q%&<&'qflags'&>&~<&'start&~id'&>&~<&'end&~id'&>
4593 When scanning the queue, Exim can be made to skip over messages whose ids are
4594 lexically less than a given value by following the &%-q%& option with a
4595 starting message id. For example:
4596 .code
4597 exim -q 0t5C6f-0000c8-00
4598 .endd
4599 Messages that arrived earlier than &`0t5C6f-0000c8-00`& are not inspected. If a
4600 second message id is given, messages whose ids are lexically greater than it
4601 are also skipped. If the same id is given twice, for example,
4602 .code
4603 exim -q 0t5C6f-0000c8-00 0t5C6f-0000c8-00
4604 .endd
4605 just one delivery process is started, for that message. This differs from
4606 &%-M%& in that retry data is respected, and it also differs from &%-Mc%& in
4607 that it counts as a delivery from a queue run. Note that the selection
4608 mechanism does not affect the order in which the messages are scanned. There
4609 are also other ways of selecting specific sets of messages for delivery in a
4610 queue run &-- see &%-R%& and &%-S%&.
4611
4612 .vitem &%-q%&<&'qflags'&><&'time'&>
4613 .cindex "queue runner" "starting periodically"
4614 .cindex "periodic queue running"
4615 When a time value is present, the &%-q%& option causes Exim to run as a daemon,
4616 starting a queue runner process at intervals specified by the given time value
4617 (whose format is described in section &<<SECTtimeformat>>&). This form of the
4618 &%-q%& option is commonly combined with the &%-bd%& option, in which case a
4619 single daemon process handles both functions. A common way of starting up a
4620 combined daemon at system boot time is to use a command such as
4621 .code
4622 /usr/exim/bin/exim -bd -q30m
4623 .endd
4624 Such a daemon listens for incoming SMTP calls, and also starts a queue runner
4625 process every 30 minutes.
4626
4627 When a daemon is started by &%-q%& with a time value, but without &%-bd%&, no
4628 pid file is written unless one is explicitly requested by the &%-oP%& option.
4629
4630 .vitem &%-qR%&<&'rsflags'&>&~<&'string'&>
4631 .oindex "&%-qR%&"
4632 This option is synonymous with &%-R%&. It is provided for Sendmail
4633 compatibility.
4634
4635 .vitem &%-qS%&<&'rsflags'&>&~<&'string'&>
4636 .oindex "&%-qS%&"
4637 This option is synonymous with &%-S%&.
4638
4639 .vitem &%-R%&<&'rsflags'&>&~<&'string'&>
4640 .oindex "&%-R%&"
4641 .cindex "queue runner" "for specific recipients"
4642 .cindex "delivery" "to given domain"
4643 .cindex "domain" "delivery to"
4644 The <&'rsflags'&> may be empty, in which case the white space before the string
4645 is optional, unless the string is &'f'&, &'ff'&, &'r'&, &'rf'&, or &'rff'&,
4646 which are the possible values for <&'rsflags'&>. White space is required if
4647 <&'rsflags'&> is not empty.
4648
4649 This option is similar to &%-q%& with no time value, that is, it causes Exim to
4650 perform a single queue run, except that, when scanning the messages on the
4651 queue, Exim processes only those that have at least one undelivered recipient
4652 address containing the given string, which is checked in a case-independent
4653 way. If the <&'rsflags'&> start with &'r'&, <&'string'&> is interpreted as a
4654 regular expression; otherwise it is a literal string.
4655
4656 If you want to do periodic queue runs for messages with specific recipients,
4657 you can combine &%-R%& with &%-q%& and a time value. For example:
4658 .code
4659 exim -q25m -R @special.domain.example
4660 .endd
4661 This example does a queue run for messages with recipients in the given domain
4662 every 25 minutes. Any additional flags that are specified with &%-q%& are
4663 applied to each queue run.
4664
4665 Once a message is selected for delivery by this mechanism, all its addresses
4666 are processed. For the first selected message, Exim overrides any retry
4667 information and forces a delivery attempt for each undelivered address. This
4668 means that if delivery of any address in the first message is successful, any
4669 existing retry information is deleted, and so delivery attempts for that
4670 address in subsequently selected messages (which are processed without forcing)
4671 will run. However, if delivery of any address does not succeed, the retry
4672 information is updated, and in subsequently selected messages, the failing
4673 address will be skipped.
4674
4675 .cindex "frozen messages" "forcing delivery"
4676 If the <&'rsflags'&> contain &'f'& or &'ff'&, the delivery forcing applies to
4677 all selected messages, not just the first; frozen messages are included when
4678 &'ff'& is present.
4679
4680 The &%-R%& option makes it straightforward to initiate delivery of all messages
4681 to a given domain after a host has been down for some time. When the SMTP
4682 command ETRN is accepted by its ACL (see chapter &<<CHAPACL>>&), its default
4683 effect is to run Exim with the &%-R%& option, but it can be configured to run
4684 an arbitrary command instead.
4685
4686 .vitem &%-r%&
4687 .oindex "&%-r%&"
4688 This is a documented (for Sendmail) obsolete alternative name for &%-f%&.
4689
4690 .vitem &%-S%&<&'rsflags'&>&~<&'string'&>
4691 .oindex "&%-S%&"
4692 .cindex "delivery" "from given sender"
4693 .cindex "queue runner" "for specific senders"
4694 This option acts like &%-R%& except that it checks the string against each
4695 message's sender instead of against the recipients. If &%-R%& is also set, both
4696 conditions must be met for a message to be selected. If either of the options
4697 has &'f'& or &'ff'& in its flags, the associated action is taken.
4698
4699 .vitem &%-Tqt%&&~<&'times'&>
4700 .oindex "&%-Tqt%&"
4701 This is an option that is exclusively for use by the Exim testing suite. It is not
4702 recognized when Exim is run normally. It allows for the setting up of explicit
4703 &"queue times"& so that various warning/retry features can be tested.
4704
4705 .vitem &%-t%&
4706 .oindex "&%-t%&"
4707 .cindex "recipient" "extracting from header lines"
4708 .cindex "&'Bcc:'& header line"
4709 .cindex "&'Cc:'& header line"
4710 .cindex "&'To:'& header line"
4711 When Exim is receiving a locally-generated, non-SMTP message on its standard
4712 input, the &%-t%& option causes the recipients of the message to be obtained
4713 from the &'To:'&, &'Cc:'&, and &'Bcc:'& header lines in the message instead of
4714 from the command arguments. The addresses are extracted before any rewriting
4715 takes place and the &'Bcc:'& header line, if present, is then removed.
4716
4717 .cindex "Sendmail compatibility" "&%-t%& option"
4718 If the command has any arguments, they specify addresses to which the message
4719 is &'not'& to be delivered. That is, the argument addresses are removed from
4720 the recipients list obtained from the headers. This is compatible with Smail 3
4721 and in accordance with the documented behaviour of several versions of
4722 Sendmail, as described in man pages on a number of operating systems (e.g.
4723 Solaris 8, IRIX 6.5, HP-UX 11). However, some versions of Sendmail &'add'&
4724 argument addresses to those obtained from the headers, and the O'Reilly
4725 Sendmail book documents it that way. Exim can be made to add argument addresses
4726 instead of subtracting them by setting the option
4727 &%extract_addresses_remove_arguments%& false.
4728
4729 .cindex "&%Resent-%& header lines" "with &%-t%&"
4730 If there are any &%Resent-%& header lines in the message, Exim extracts
4731 recipients from all &'Resent-To:'&, &'Resent-Cc:'&, and &'Resent-Bcc:'& header
4732 lines instead of from &'To:'&, &'Cc:'&, and &'Bcc:'&. This is for compatibility
4733 with Sendmail and other MTAs. (Prior to release 4.20, Exim gave an error if
4734 &%-t%& was used in conjunction with &%Resent-%& header lines.)
4735
4736 RFC 2822 talks about different sets of &%Resent-%& header lines (for when a
4737 message is resent several times). The RFC also specifies that they should be
4738 added at the front of the message, and separated by &'Received:'& lines. It is
4739 not at all clear how &%-t%& should operate in the present of multiple sets,
4740 nor indeed exactly what constitutes a &"set"&.
4741 In practice, it seems that MUAs do not follow the RFC. The &%Resent-%& lines
4742 are often added at the end of the header, and if a message is resent more than
4743 once, it is common for the original set of &%Resent-%& headers to be renamed as
4744 &%X-Resent-%& when a new set is added. This removes any possible ambiguity.
4745
4746 .vitem &%-ti%&
4747 .oindex "&%-ti%&"
4748 This option is exactly equivalent to &%-t%& &%-i%&. It is provided for
4749 compatibility with Sendmail.
4750
4751 .vitem &%-tls-on-connect%&
4752 .oindex "&%-tls-on-connect%&"
4753 .cindex "TLS" "use without STARTTLS"
4754 .cindex "TLS" "automatic start"
4755 This option is available when Exim is compiled with TLS support. It forces all
4756 incoming SMTP connections to behave as if the incoming port is listed in the
4757 &%tls_on_connect_ports%& option. See section &<<SECTsupobssmt>>& and chapter
4758 &<<CHAPTLS>>& for further details.
4759
4760
4761 .vitem &%-U%&
4762 .oindex "&%-U%&"
4763 .cindex "Sendmail compatibility" "&%-U%& option ignored"
4764 Sendmail uses this option for &"initial message submission"&, and its
4765 documentation states that in future releases, it may complain about
4766 syntactically invalid messages rather than fixing them when this flag is not
4767 set. Exim ignores this option.
4768
4769 .vitem &%-v%&
4770 .oindex "&%-v%&"
4771 This option causes Exim to write information to the standard error stream,
4772 describing what it is doing. In particular, it shows the log lines for
4773 receiving and delivering a message, and if an SMTP connection is made, the SMTP
4774 dialogue is shown. Some of the log lines shown may not actually be written to
4775 the log if the setting of &%log_selector%& discards them. Any relevant
4776 selectors are shown with each log line. If none are shown, the logging is
4777 unconditional.
4778
4779 .vitem &%-x%&
4780 .oindex "&%-x%&"
4781 AIX uses &%-x%& for a private purpose (&"mail from a local mail program has
4782 National Language Support extended characters in the body of the mail item"&).
4783 It sets &%-x%& when calling the MTA from its &%mail%& command. Exim ignores
4784 this option.
4785
4786 .vitem &%-X%&&~<&'logfile'&>
4787 .oindex "&%-X%&"
4788 This option is interpreted by Sendmail to cause debug information to be sent
4789 to the named file.  It is ignored by Exim.
4790
4791 .vitem &%-z%&&~<&'log-line'&>
4792 .oindex "&%-z%&"
4793 This option writes its argument to Exim's logfile.
4794 Use is restricted to administrators; the intent is for operational notes.
4795 Quotes should be used to maintain a multi-word item as a single argument,
4796 under most shells.
4797 .endlist
4798
4799 .ecindex IIDclo1
4800 .ecindex IIDclo2
4801
4802
4803 . ////////////////////////////////////////////////////////////////////////////
4804 . Insert a stylized DocBook comment here, to identify the end of the command
4805 . line options. This is for the benefit of the Perl script that automatically
4806 . creates a man page for the options.
4807 . ////////////////////////////////////////////////////////////////////////////
4808
4809 .literal xml
4810 <!-- === End of command line options === -->
4811 .literal off
4812
4813
4814
4815
4816
4817 . ////////////////////////////////////////////////////////////////////////////
4818 . ////////////////////////////////////////////////////////////////////////////
4819
4820
4821 .chapter "The Exim runtime configuration file" "CHAPconf" &&&
4822          "The runtime configuration file"
4823
4824 .cindex "runtime configuration"
4825 .cindex "configuration file" "general description"
4826 .cindex "CONFIGURE_FILE"
4827 .cindex "configuration file" "errors in"
4828 .cindex "error" "in configuration file"
4829 .cindex "return code" "for bad configuration"
4830 Exim uses a single runtime configuration file that is read whenever an Exim
4831 binary is executed. Note that in normal operation, this happens frequently,
4832 because Exim is designed to operate in a distributed manner, without central
4833 control.
4834
4835 If a syntax error is detected while reading the configuration file, Exim
4836 writes a message on the standard error, and exits with a non-zero return code.
4837 The message is also written to the panic log. &*Note*&: Only simple syntax
4838 errors can be detected at this time. The values of any expanded options are
4839 not checked until the expansion happens, even when the expansion does not
4840 actually alter the string.
4841
4842 The name of the configuration file is compiled into the binary for security
4843 reasons, and is specified by the CONFIGURE_FILE compilation option. In
4844 most configurations, this specifies a single file. However, it is permitted to
4845 give a colon-separated list of filenames, in which case Exim uses the first
4846 existing file in the list.
4847
4848 .cindex "EXIM_USER"
4849 .cindex "EXIM_GROUP"
4850 .cindex "CONFIGURE_OWNER"
4851 .cindex "CONFIGURE_GROUP"
4852 .cindex "configuration file" "ownership"
4853 .cindex "ownership" "configuration file"
4854 The runtime configuration file must be owned by root or by the user that is
4855 specified at compile time by the CONFIGURE_OWNER option (if set). The
4856 configuration file must not be world-writeable, or group-writeable unless its
4857 group is the root group or the one specified at compile time by the
4858 CONFIGURE_GROUP option.
4859
4860 &*Warning*&: In a conventional configuration, where the Exim binary is setuid
4861 to root, anybody who is able to edit the runtime configuration file has an
4862 easy way to run commands as root. If you specify a user or group in the
4863 CONFIGURE_OWNER or CONFIGURE_GROUP options, then that user and/or any users
4864 who are members of that group will trivially be able to obtain root privileges.
4865
4866 Up to Exim version 4.72, the runtime configuration file was also permitted to
4867 be writeable by the Exim user and/or group. That has been changed in Exim 4.73
4868 since it offered a simple privilege escalation for any attacker who managed to
4869 compromise the Exim user account.
4870
4871 A default configuration file, which will work correctly in simple situations,
4872 is provided in the file &_src/configure.default_&. If CONFIGURE_FILE
4873 defines just one filename, the installation process copies the default
4874 configuration to a new file of that name if it did not previously exist. If
4875 CONFIGURE_FILE is a list, no default is automatically installed. Chapter
4876 &<<CHAPdefconfil>>& is a &"walk-through"& discussion of the default
4877 configuration.
4878
4879
4880
4881 .section "Using a different configuration file" "SECID40"
4882 .cindex "configuration file" "alternate"
4883 A one-off alternate configuration can be specified by the &%-C%& command line
4884 option, which may specify a single file or a list of files. However, when
4885 &%-C%& is used, Exim gives up its root privilege, unless called by root (or
4886 unless the argument for &%-C%& is identical to the built-in value from
4887 CONFIGURE_FILE), or is listed in the TRUSTED_CONFIG_LIST file and the caller
4888 is the Exim user or the user specified in the CONFIGURE_OWNER setting. &%-C%&
4889 is useful mainly for checking the syntax of configuration files before
4890 installing them. No owner or group checks are done on a configuration file
4891 specified by &%-C%&, if root privilege has been dropped.
4892
4893 Even the Exim user is not trusted to specify an arbitrary configuration file
4894 with the &%-C%& option to be used with root privileges, unless that file is
4895 listed in the TRUSTED_CONFIG_LIST file. This locks out the possibility of
4896 testing a configuration using &%-C%& right through message reception and
4897 delivery, even if the caller is root. The reception works, but by that time,
4898 Exim is running as the Exim user, so when it re-execs to regain privilege for
4899 the delivery, the use of &%-C%& causes privilege to be lost. However, root
4900 can test reception and delivery using two separate commands (one to put a
4901 message in the queue, using &%-odq%&, and another to do the delivery, using
4902 &%-M%&).
4903
4904 If ALT_CONFIG_PREFIX is defined &_in Local/Makefile_&, it specifies a
4905 prefix string with which any file named in a &%-C%& command line option must
4906 start. In addition, the filename must not contain the sequence &"&`/../`&"&.
4907 There is no default setting for ALT_CONFIG_PREFIX; when it is unset, any
4908 filename can be used with &%-C%&.
4909
4910 One-off changes to a configuration can be specified by the &%-D%& command line
4911 option, which defines and overrides values for macros used inside the
4912 configuration file. However, like &%-C%&, the use of this option by a
4913 non-privileged user causes Exim to discard its root privilege.
4914 If DISABLE_D_OPTION is defined in &_Local/Makefile_&, the use of &%-D%& is
4915 completely disabled, and its use causes an immediate error exit.
4916
4917 The WHITELIST_D_MACROS option in &_Local/Makefile_& permits the binary builder
4918 to declare certain macro names trusted, such that root privilege will not
4919 necessarily be discarded.
4920 WHITELIST_D_MACROS defines a colon-separated list of macros which are
4921 considered safe and, if &%-D%& only supplies macros from this list, and the
4922 values are acceptable, then Exim will not give up root privilege if the caller
4923 is root, the Exim run-time user, or the CONFIGURE_OWNER, if set.  This is a
4924 transition mechanism and is expected to be removed in the future.  Acceptable
4925 values for the macros satisfy the regexp: &`^[A-Za-z0-9_/.-]*$`&
4926
4927 Some sites may wish to use the same Exim binary on different machines that
4928 share a file system, but to use different configuration files on each machine.
4929 If CONFIGURE_FILE_USE_NODE is defined in &_Local/Makefile_&, Exim first
4930 looks for a file whose name is the configuration filename followed by a dot
4931 and the machine's node name, as obtained from the &[uname()]& function. If this
4932 file does not exist, the standard name is tried. This processing occurs for
4933 each filename in the list given by CONFIGURE_FILE or &%-C%&.
4934
4935 In some esoteric situations different versions of Exim may be run under
4936 different effective uids and the CONFIGURE_FILE_USE_EUID is defined to
4937 help with this. See the comments in &_src/EDITME_& for details.
4938
4939
4940
4941 .section "Configuration file format" "SECTconffilfor"
4942 .cindex "configuration file" "format of"
4943 .cindex "format" "configuration file"
4944 Exim's configuration file is divided into a number of different parts. General
4945 option settings must always appear at the start of the file. The other parts
4946 are all optional, and may appear in any order. Each part other than the first
4947 is introduced by the word &"begin"& followed by at least one literal
4948 space, and the name of the part. The optional parts are:
4949
4950 .ilist
4951 &'ACL'&: Access control lists for controlling incoming SMTP mail (see chapter
4952 &<<CHAPACL>>&).
4953 .next
4954 .cindex "AUTH" "configuration"
4955 &'authenticators'&: Configuration settings for the authenticator drivers. These
4956 are concerned with the SMTP AUTH command (see chapter &<<CHAPSMTPAUTH>>&).
4957 .next
4958 &'routers'&: Configuration settings for the router drivers. Routers process
4959 addresses and determine how the message is to be delivered (see chapters
4960 &<<CHAProutergeneric>>&&--&<<CHAPredirect>>&).
4961 .next
4962 &'transports'&: Configuration settings for the transport drivers. Transports
4963 define mechanisms for copying messages to destinations (see chapters
4964 &<<CHAPtransportgeneric>>&&--&<<CHAPsmtptrans>>&).
4965 .next
4966 &'retry'&: Retry rules, for use when a message cannot be delivered immediately.
4967 If there is no retry section, or if it is empty (that is, no retry rules are
4968 defined), Exim will not retry deliveries. In this situation, temporary errors
4969 are treated the same as permanent errors. Retry rules are discussed in chapter
4970 &<<CHAPretry>>&.
4971 .next
4972 &'rewrite'&: Global address rewriting rules, for use when a message arrives and
4973 when new addresses are generated during delivery. Rewriting is discussed in
4974 chapter &<<CHAPrewrite>>&.
4975 .next
4976 &'local_scan'&: Private options for the &[local_scan()]& function. If you
4977 want to use this feature, you must set
4978 .code
4979 LOCAL_SCAN_HAS_OPTIONS=yes
4980 .endd
4981 in &_Local/Makefile_& before building Exim. Details of the &[local_scan()]&
4982 facility are given in chapter &<<CHAPlocalscan>>&.
4983 .endlist
4984
4985 .cindex "configuration file" "leading white space in"
4986 .cindex "configuration file" "trailing white space in"
4987 .cindex "white space" "in configuration file"
4988 Leading and trailing white space in configuration lines is always ignored.
4989
4990 Blank lines in the file, and lines starting with a # character (ignoring
4991 leading white space) are treated as comments and are ignored. &*Note*&: A
4992 # character other than at the beginning of a line is not treated specially,
4993 and does not introduce a comment.
4994
4995 Any non-comment line can be continued by ending it with a backslash. Note that
4996 the general rule for white space means that trailing white space after the
4997 backslash and leading white space at the start of continuation
4998 lines is ignored. Comment lines beginning with # (but not empty lines) may
4999 appear in the middle of a sequence of continuation lines.
5000
5001 A convenient way to create a configuration file is to start from the
5002 default, which is supplied in &_src/configure.default_&, and add, delete, or
5003 change settings as required.
5004
5005 The ACLs, retry rules, and rewriting rules have their own syntax which is
5006 described in chapters &<<CHAPACL>>&, &<<CHAPretry>>&, and &<<CHAPrewrite>>&,
5007 respectively. The other parts of the configuration file have some syntactic
5008 items in common, and these are described below, from section &<<SECTcos>>&
5009 onwards. Before that, the inclusion, macro, and conditional facilities are
5010 described.
5011
5012
5013
5014 .section "File inclusions in the configuration file" "SECID41"
5015 .cindex "inclusions in configuration file"
5016 .cindex "configuration file" "including other files"
5017 .cindex "&`.include`& in configuration file"
5018 .cindex "&`.include_if_exists`& in configuration file"
5019 You can include other files inside Exim's runtime configuration file by
5020 using this syntax:
5021 .display
5022 &`.include`& <&'filename'&>
5023 &`.include_if_exists`& <&'filename'&>
5024 .endd
5025 on a line by itself. Double quotes round the filename are optional. If you use
5026 the first form, a configuration error occurs if the file does not exist; the
5027 second form does nothing for non-existent files.
5028 The first form allows a relative name. It is resolved relative to
5029 the directory of the including file. For the second form an absolute filename
5030 is required.
5031
5032 Includes may be nested to any depth, but remember that Exim reads its
5033 configuration file often, so it is a good idea to keep them to a minimum.
5034 If you change the contents of an included file, you must HUP the daemon,
5035 because an included file is read only when the configuration itself is read.
5036
5037 The processing of inclusions happens early, at a physical line level, so, like
5038 comment lines, an inclusion can be used in the middle of an option setting,
5039 for example:
5040 .code
5041 hosts_lookup = a.b.c \
5042                .include /some/file
5043 .endd
5044 Include processing happens after macro processing (see below). Its effect is to
5045 process the lines of the included file as if they occurred inline where the
5046 inclusion appears.
5047
5048
5049
5050 .section "Macros in the configuration file" "SECTmacrodefs"
5051 .cindex "macro" "description of"
5052 .cindex "configuration file" "macros"
5053 If a line in the main part of the configuration (that is, before the first
5054 &"begin"& line) begins with an upper case letter, it is taken as a macro
5055 definition, and must be of the form
5056 .display
5057 <&'name'&> = <&'rest of line'&>
5058 .endd
5059 The name must consist of letters, digits, and underscores, and need not all be
5060 in upper case, though that is recommended. The rest of the line, including any
5061 continuations, is the replacement text, and has leading and trailing white
5062 space removed. Quotes are not removed. The replacement text can never end with
5063 a backslash character, but this doesn't seem to be a serious limitation.
5064
5065 Macros may also be defined between router, transport, authenticator, or ACL
5066 definitions. They may not, however, be defined within an individual driver or
5067 ACL, or in the &%local_scan%&, retry, or rewrite sections of the configuration.
5068
5069 .section "Macro substitution" "SECID42"
5070 Once a macro is defined, all subsequent lines in the file (and any included
5071 files) are scanned for the macro name; if there are several macros, the line is
5072 scanned for each, in turn, in the order in which the macros are defined. The
5073 replacement text is not re-scanned for the current macro, though it is scanned
5074 for subsequently defined macros. For this reason, a macro name may not contain
5075 the name of a previously defined macro as a substring. You could, for example,
5076 define
5077 .display
5078 &`ABCD_XYZ = `&<&'something'&>
5079 &`ABCD = `&<&'something else'&>
5080 .endd
5081 but putting the definitions in the opposite order would provoke a configuration
5082 error. Macro expansion is applied to individual physical lines from the file,
5083 before checking for line continuation or file inclusion (see above). If a line
5084 consists solely of a macro name, and the expansion of the macro is empty, the
5085 line is ignored. A macro at the start of a line may turn the line into a
5086 comment line or a &`.include`& line.
5087
5088
5089 .section "Redefining macros" "SECID43"
5090 Once defined, the value of a macro can be redefined later in the configuration
5091 (or in an included file). Redefinition is specified by using &'=='& instead of
5092 &'='&. For example:
5093 .code
5094 MAC =  initial value
5095 ...
5096 MAC == updated value
5097 .endd
5098 Redefinition does not alter the order in which the macros are applied to the
5099 subsequent lines of the configuration file. It is still the same order in which
5100 the macros were originally defined. All that changes is the macro's value.
5101 Redefinition makes it possible to accumulate values. For example:
5102 .code
5103 MAC =  initial value
5104 ...
5105 MAC == MAC and something added
5106 .endd
5107 This can be helpful in situations where the configuration file is built
5108 from a number of other files.
5109
5110 .section "Overriding macro values" "SECID44"
5111 The values set for macros in the configuration file can be overridden by the
5112 &%-D%& command line option, but Exim gives up its root privilege when &%-D%& is
5113 used, unless called by root or the Exim user. A definition on the command line
5114 using the &%-D%& option causes all definitions and redefinitions within the
5115 file to be ignored.
5116
5117
5118
5119 .section "Example of macro usage" "SECID45"
5120 As an example of macro usage, consider a configuration where aliases are looked
5121 up in a MySQL database. It helps to keep the file less cluttered if long
5122 strings such as SQL statements are defined separately as macros, for example:
5123 .code
5124 ALIAS_QUERY = select mailbox from user where \
5125               login='${quote_mysql:$local_part}';
5126 .endd
5127 This can then be used in a &(redirect)& router setting like this:
5128 .code
5129 data = ${lookup mysql{ALIAS_QUERY}}
5130 .endd
5131 In earlier versions of Exim macros were sometimes used for domain, host, or
5132 address lists. In Exim 4 these are handled better by named lists &-- see
5133 section &<<SECTnamedlists>>&.
5134
5135
5136 .section "Builtin macros" "SECTbuiltinmacros"
5137 Exim defines some macros depending on facilities available, which may
5138 differ due to build-time definitions and from one release to another.
5139 All of these macros start with an underscore.
5140 They can be used to conditionally include parts of a configuration
5141 (see below).
5142
5143 The following classes of macros are defined:
5144 .display
5145 &` _HAVE_*                    `&  build-time defines
5146 &` _DRIVER_ROUTER_*           `&  router drivers
5147 &` _DRIVER_TRANSPORT_*        `&  transport drivers
5148 &` _DRIVER_AUTHENTICATOR_*    `&  authenticator drivers
5149 &` _LOG_*                     `&  log_selector values
5150 &` _OPT_MAIN_*                `&  main config options
5151 &` _OPT_ROUTERS_*             `&  generic router options
5152 &` _OPT_TRANSPORTS_*          `&  generic transport options
5153 &` _OPT_AUTHENTICATORS_*      `&  generic authenticator options
5154 &` _OPT_ROUTER_*_*            `&  private router options
5155 &` _OPT_TRANSPORT_*_*         `&  private transport options
5156 &` _OPT_AUTHENTICATOR_*_*     `&  private authenticator options
5157 .endd
5158
5159 Use an &"exim -bP macros"& command to get the list of macros.
5160
5161
5162 .section "Conditional skips in the configuration file" "SECID46"
5163 .cindex "configuration file" "conditional skips"
5164 .cindex "&`.ifdef`&"
5165 You can use the directives &`.ifdef`&, &`.ifndef`&, &`.elifdef`&,
5166 &`.elifndef`&, &`.else`&, and &`.endif`& to dynamically include or exclude
5167 portions of the configuration file. The processing happens whenever the file is
5168 read (that is, when an Exim binary starts to run).
5169
5170 The implementation is very simple. Instances of the first four directives must
5171 be followed by text that includes the names of one or macros. The condition
5172 that is tested is whether or not any macro substitution has taken place in the
5173 line. Thus:
5174 .code
5175 .ifdef AAA
5176 message_size_limit = 50M
5177 .else
5178 message_size_limit = 100M
5179 .endif
5180 .endd
5181 sets a message size limit of 50M if the macro &`AAA`& is defined
5182 (or &`A`& or &`AA`&), and 100M
5183 otherwise. If there is more than one macro named on the line, the condition
5184 is true if any of them are defined. That is, it is an &"or"& condition. To
5185 obtain an &"and"& condition, you need to use nested &`.ifdef`&s.
5186
5187 Although you can use a macro expansion to generate one of these directives,
5188 it is not very useful, because the condition &"there was a macro substitution
5189 in this line"& will always be true.
5190
5191 Text following &`.else`& and &`.endif`& is ignored, and can be used as comment
5192 to clarify complicated nestings.
5193
5194
5195
5196 .section "Common option syntax" "SECTcos"
5197 .cindex "common option syntax"
5198 .cindex "syntax of common options"
5199 .cindex "configuration file" "common option syntax"
5200 For the main set of options, driver options, and &[local_scan()]& options,
5201 each setting is on a line by itself, and starts with a name consisting of
5202 lower-case letters and underscores. Many options require a data value, and in
5203 these cases the name must be followed by an equals sign (with optional white
5204 space) and then the value. For example:
5205 .code
5206 qualify_domain = mydomain.example.com
5207 .endd
5208 .cindex "hiding configuration option values"
5209 .cindex "configuration options" "hiding value of"
5210 .cindex "options" "hiding value of"
5211 Some option settings may contain sensitive data, for example, passwords for
5212 accessing databases. To stop non-admin users from using the &%-bP%& command
5213 line option to read these values, you can precede the option settings with the
5214 word &"hide"&. For example:
5215 .code
5216 hide mysql_servers = localhost/users/admin/secret-password
5217 .endd
5218 For non-admin users, such options are displayed like this:
5219 .code
5220 mysql_servers = <value not displayable>
5221 .endd
5222 If &"hide"& is used on a driver option, it hides the value of that option on
5223 all instances of the same driver.
5224
5225 The following sections describe the syntax used for the different data types
5226 that are found in option settings.
5227
5228
5229 .section "Boolean options" "SECID47"
5230 .cindex "format" "boolean"
5231 .cindex "boolean configuration values"
5232 .oindex "&%no_%&&'xxx'&"
5233 .oindex "&%not_%&&'xxx'&"
5234 Options whose type is given as boolean are on/off switches. There are two
5235 different ways of specifying such options: with and without a data value. If
5236 the option name is specified on its own without data, the switch is turned on;
5237 if it is preceded by &"no_"& or &"not_"& the switch is turned off. However,
5238 boolean options may be followed by an equals sign and one of the words
5239 &"true"&, &"false"&, &"yes"&, or &"no"&, as an alternative syntax. For example,
5240 the following two settings have exactly the same effect:
5241 .code
5242 queue_only
5243 queue_only = true
5244 .endd
5245 The following two lines also have the same (opposite) effect:
5246 .code
5247 no_queue_only
5248 queue_only = false
5249 .endd
5250 You can use whichever syntax you prefer.
5251
5252
5253
5254
5255 .section "Integer values" "SECID48"
5256 .cindex "integer configuration values"
5257 .cindex "format" "integer"
5258 If an option's type is given as &"integer"&, the value can be given in decimal,
5259 hexadecimal, or octal. If it starts with a digit greater than zero, a decimal
5260 number is assumed. Otherwise, it is treated as an octal number unless it starts
5261 with the characters &"0x"&, in which case the remainder is interpreted as a
5262 hexadecimal number.
5263
5264 If an integer value is followed by the letter K, it is multiplied by 1024; if
5265 it is followed by the letter M, it is multiplied by 1024x1024;
5266 if by the letter G, 1024x1024x1024.
5267 When the values
5268 of integer option settings are output, values which are an exact multiple of
5269 1024 or 1024x1024 are sometimes, but not always, printed using the letters K
5270 and M. The printing style is independent of the actual input format that was
5271 used.
5272
5273
5274 .section "Octal integer values" "SECID49"
5275 .cindex "integer format"
5276 .cindex "format" "octal integer"
5277 If an option's type is given as &"octal integer"&, its value is always
5278 interpreted as an octal number, whether or not it starts with the digit zero.
5279 Such options are always output in octal.
5280
5281
5282 .section "Fixed point numbers" "SECID50"
5283 .cindex "fixed point configuration values"
5284 .cindex "format" "fixed point"
5285 If an option's type is given as &"fixed-point"&, its value must be a decimal
5286 integer, optionally followed by a decimal point and up to three further digits.
5287
5288
5289
5290 .section "Time intervals" "SECTtimeformat"
5291 .cindex "time interval" "specifying in configuration"
5292 .cindex "format" "time interval"
5293 A time interval is specified as a sequence of numbers, each followed by one of
5294 the following letters, with no intervening white space:
5295
5296 .table2 30pt
5297 .irow &%s%& seconds
5298 .irow &%m%& minutes
5299 .irow &%h%& hours
5300 .irow &%d%& days
5301 .irow &%w%& weeks
5302 .endtable
5303
5304 For example, &"3h50m"& specifies 3 hours and 50 minutes. The values of time
5305 intervals are output in the same format. Exim does not restrict the values; it
5306 is perfectly acceptable, for example, to specify &"90m"& instead of &"1h30m"&.
5307
5308
5309
5310 .section "String values" "SECTstrings"
5311 .cindex "string" "format of configuration values"
5312 .cindex "format" "string"
5313 If an option's type is specified as &"string"&, the value can be specified with
5314 or without double-quotes. If it does not start with a double-quote, the value
5315 consists of the remainder of the line plus any continuation lines, starting at
5316 the first character after any leading white space, with trailing white space
5317 removed, and with no interpretation of the characters in the string. Because
5318 Exim removes comment lines (those beginning with #) at an early stage, they can
5319 appear in the middle of a multi-line string. The following two settings are
5320 therefore equivalent:
5321 .code
5322 trusted_users = uucp:mail
5323 trusted_users = uucp:\
5324                 # This comment line is ignored
5325                 mail
5326 .endd
5327 .cindex "string" "quoted"
5328 .cindex "escape characters in quoted strings"
5329 If a string does start with a double-quote, it must end with a closing
5330 double-quote, and any backslash characters other than those used for line
5331 continuation are interpreted as escape characters, as follows:
5332
5333 .table2 100pt
5334 .irow &`\\`&                     "single backslash"
5335 .irow &`\n`&                     "newline"
5336 .irow &`\r`&                     "carriage return"
5337 .irow &`\t`&                     "tab"
5338 .irow "&`\`&<&'octal digits'&>"  "up to 3 octal digits specify one character"
5339 .irow "&`\x`&<&'hex digits'&>"   "up to 2 hexadecimal digits specify one &&&
5340                                    character"
5341 .endtable
5342
5343 If a backslash is followed by some other character, including a double-quote
5344 character, that character replaces the pair.
5345
5346 Quoting is necessary only if you want to make use of the backslash escapes to
5347 insert special characters, or if you need to specify a value with leading or
5348 trailing spaces. These cases are rare, so quoting is almost never needed in
5349 current versions of Exim. In versions of Exim before 3.14, quoting was required
5350 in order to continue lines, so you may come across older configuration files
5351 and examples that apparently quote unnecessarily.
5352
5353
5354 .section "Expanded strings" "SECID51"
5355 .cindex "expansion" "definition of"
5356 Some strings in the configuration file are subjected to &'string expansion'&,
5357 by which means various parts of the string may be changed according to the
5358 circumstances (see chapter &<<CHAPexpand>>&). The input syntax for such strings
5359 is as just described; in particular, the handling of backslashes in quoted
5360 strings is done as part of the input process, before expansion takes place.
5361 However, backslash is also an escape character for the expander, so any
5362 backslashes that are required for that reason must be doubled if they are
5363 within a quoted configuration string.
5364
5365
5366 .section "User and group names" "SECID52"
5367 .cindex "user name" "format of"
5368 .cindex "format" "user name"
5369 .cindex "groups" "name format"
5370 .cindex "format" "group name"
5371 User and group names are specified as strings, using the syntax described
5372 above, but the strings are interpreted specially. A user or group name must
5373 either consist entirely of digits, or be a name that can be looked up using the
5374 &[getpwnam()]& or &[getgrnam()]& function, as appropriate.
5375
5376
5377 .section "List construction" "SECTlistconstruct"
5378 .cindex "list" "syntax of in configuration"
5379 .cindex "format" "list item in configuration"
5380 .cindex "string" "list, definition of"
5381 The data for some configuration options is a list of items, with colon as the
5382 default separator. Many of these options are shown with type &"string list"& in
5383 the descriptions later in this document. Others are listed as &"domain list"&,
5384 &"host list"&, &"address list"&, or &"local part list"&. Syntactically, they
5385 are all the same; however, those other than &"string list"& are subject to
5386 particular kinds of interpretation, as described in chapter
5387 &<<CHAPdomhosaddlists>>&.
5388
5389 In all these cases, the entire list is treated as a single string as far as the
5390 input syntax is concerned. The &%trusted_users%& setting in section
5391 &<<SECTstrings>>& above is an example. If a colon is actually needed in an item
5392 in a list, it must be entered as two colons. Leading and trailing white space
5393 on each item in a list is ignored. This makes it possible to include items that
5394 start with a colon, and in particular, certain forms of IPv6 address. For
5395 example, the list
5396 .code
5397 local_interfaces = 127.0.0.1 : ::::1
5398 .endd
5399 contains two IP addresses, the IPv4 address 127.0.0.1 and the IPv6 address ::1.
5400
5401 &*Note*&: Although leading and trailing white space is ignored in individual
5402 list items, it is not ignored when parsing the list. The space after the first
5403 colon in the example above is necessary. If it were not there, the list would
5404 be interpreted as the two items 127.0.0.1:: and 1.
5405
5406 .section "Changing list separators" "SECTlistsepchange"
5407 .cindex "list separator" "changing"
5408 .cindex "IPv6" "addresses in lists"
5409 Doubling colons in IPv6 addresses is an unwelcome chore, so a mechanism was
5410 introduced to allow the separator character to be changed. If a list begins
5411 with a left angle bracket, followed by any punctuation character, that
5412 character is used instead of colon as the list separator. For example, the list
5413 above can be rewritten to use a semicolon separator like this:
5414 .code
5415 local_interfaces = <; 127.0.0.1 ; ::1
5416 .endd
5417 This facility applies to all lists, with the exception of the list in
5418 &%log_file_path%&. It is recommended that the use of non-colon separators be
5419 confined to circumstances where they really are needed.
5420
5421 .cindex "list separator" "newline as"
5422 .cindex "newline" "as list separator"
5423 It is also possible to use newline and other control characters (those with
5424 code values less than 32, plus DEL) as separators in lists. Such separators
5425 must be provided literally at the time the list is processed. For options that
5426 are string-expanded, you can write the separator using a normal escape
5427 sequence. This will be processed by the expander before the string is
5428 interpreted as a list. For example, if a newline-separated list of domains is
5429 generated by a lookup, you can process it directly by a line such as this:
5430 .code
5431 domains = <\n ${lookup mysql{.....}}
5432 .endd
5433 This avoids having to change the list separator in such data. You are unlikely
5434 to want to use a control character as a separator in an option that is not
5435 expanded, because the value is literal text. However, it can be done by giving
5436 the value in quotes. For example:
5437 .code
5438 local_interfaces = "<\n 127.0.0.1 \n ::1"
5439 .endd
5440 Unlike printing character separators, which can be included in list items by
5441 doubling, it is not possible to include a control character as data when it is
5442 set as the separator. Two such characters in succession are interpreted as
5443 enclosing an empty list item.
5444
5445
5446
5447 .section "Empty items in lists" "SECTempitelis"
5448 .cindex "list" "empty item in"
5449 An empty item at the end of a list is always ignored. In other words, trailing
5450 separator characters are ignored. Thus, the list in
5451 .code
5452 senders = user@domain :
5453 .endd
5454 contains only a single item. If you want to include an empty string as one item
5455 in a list, it must not be the last item. For example, this list contains three
5456 items, the second of which is empty:
5457 .code
5458 senders = user1@domain : : user2@domain
5459 .endd
5460 &*Note*&: There must be white space between the two colons, as otherwise they
5461 are interpreted as representing a single colon data character (and the list
5462 would then contain just one item). If you want to specify a list that contains
5463 just one, empty item, you can do it as in this example:
5464 .code
5465 senders = :
5466 .endd
5467 In this case, the first item is empty, and the second is discarded because it
5468 is at the end of the list.
5469
5470
5471
5472
5473 .section "Format of driver configurations" "SECTfordricon"
5474 .cindex "drivers" "configuration format"
5475 There are separate parts in the configuration for defining routers, transports,
5476 and authenticators. In each part, you are defining a number of driver
5477 instances, each with its own set of options. Each driver instance is defined by
5478 a sequence of lines like this:
5479 .display
5480 <&'instance name'&>:
5481   <&'option'&>
5482   ...
5483   <&'option'&>
5484 .endd
5485 In the following example, the instance name is &(localuser)&, and it is
5486 followed by three options settings:
5487 .code
5488 localuser:
5489   driver = accept
5490   check_local_user
5491   transport = local_delivery
5492 .endd
5493 For each driver instance, you specify which Exim code module it uses &-- by the
5494 setting of the &%driver%& option &-- and (optionally) some configuration
5495 settings. For example, in the case of transports, if you want a transport to
5496 deliver with SMTP you would use the &(smtp)& driver; if you want to deliver to
5497 a local file you would use the &(appendfile)& driver. Each of the drivers is
5498 described in detail in its own separate chapter later in this manual.
5499
5500 You can have several routers, transports, or authenticators that are based on
5501 the same underlying driver (each must have a different instance name).
5502
5503 The order in which routers are defined is important, because addresses are
5504 passed to individual routers one by one, in order. The order in which
5505 transports are defined does not matter at all. The order in which
5506 authenticators are defined is used only when Exim, as a client, is searching
5507 them to find one that matches an authentication mechanism offered by the
5508 server.
5509
5510 .cindex "generic options"
5511 .cindex "options" "generic &-- definition of"
5512 Within a driver instance definition, there are two kinds of option: &'generic'&
5513 and &'private'&. The generic options are those that apply to all drivers of the
5514 same type (that is, all routers, all transports or all authenticators). The
5515 &%driver%& option is a generic option that must appear in every definition.
5516 .cindex "private options"
5517 The private options are special for each driver, and none need appear, because
5518 they all have default values.
5519
5520 The options may appear in any order, except that the &%driver%& option must
5521 precede any private options, since these depend on the particular driver. For
5522 this reason, it is recommended that &%driver%& always be the first option.
5523
5524 Driver instance names, which are used for reference in log entries and
5525 elsewhere, can be any sequence of letters, digits, and underscores (starting
5526 with a letter) and must be unique among drivers of the same type. A router and
5527 a transport (for example) can each have the same name, but no two router
5528 instances can have the same name. The name of a driver instance should not be
5529 confused with the name of the underlying driver module. For example, the
5530 configuration lines:
5531 .code
5532 remote_smtp:
5533   driver = smtp
5534 .endd
5535 create an instance of the &(smtp)& transport driver whose name is
5536 &(remote_smtp)&. The same driver code can be used more than once, with
5537 different instance names and different option settings each time. A second
5538 instance of the &(smtp)& transport, with different options, might be defined
5539 thus:
5540 .code
5541 special_smtp:
5542   driver = smtp
5543   port = 1234
5544   command_timeout = 10s
5545 .endd
5546 The names &(remote_smtp)& and &(special_smtp)& would be used to reference
5547 these transport instances from routers, and these names would appear in log
5548 lines.
5549
5550 Comment lines may be present in the middle of driver specifications. The full
5551 list of option settings for any particular driver instance, including all the
5552 defaulted values, can be extracted by making use of the &%-bP%& command line
5553 option.
5554
5555
5556
5557
5558
5559
5560 . ////////////////////////////////////////////////////////////////////////////
5561 . ////////////////////////////////////////////////////////////////////////////
5562
5563 .chapter "The default configuration file" "CHAPdefconfil"
5564 .scindex IIDconfiwal "configuration file" "default &""walk through""&"
5565 .cindex "default" "configuration file &""walk through""&"
5566 The default configuration file supplied with Exim as &_src/configure.default_&
5567 is sufficient for a host with simple mail requirements. As an introduction to
5568 the way Exim is configured, this chapter &"walks through"& the default
5569 configuration, giving brief explanations of the settings. Detailed descriptions
5570 of the options are given in subsequent chapters. The default configuration file
5571 itself contains extensive comments about ways you might want to modify the
5572 initial settings. However, note that there are many options that are not
5573 mentioned at all in the default configuration.
5574
5575
5576
5577 .section "Macros" "SECTdefconfmacros"
5578 All macros should be defined before any options.
5579
5580 One macro is specified, but commented out, in the default configuration:
5581 .code
5582 # ROUTER_SMARTHOST=MAIL.HOSTNAME.FOR.CENTRAL.SERVER.EXAMPLE
5583 .endd
5584 If all off-site mail is expected to be delivered to a "smarthost", then set the
5585 hostname here and uncomment the macro.  This will affect which router is used
5586 later on.  If this is left commented out, then Exim will perform direct-to-MX
5587 deliveries using a &(dnslookup)& router.
5588
5589 In addition to macros defined here, Exim includes a number of built-in macros
5590 to enable configuration to be guarded by a binary built with support for a
5591 given feature.  See section &<<SECTbuiltinmacros>>& for more details.
5592
5593
5594 .section "Main configuration settings" "SECTdefconfmain"
5595 The main (global) configuration option settings section must always come first
5596 in the file, after the macros.
5597 The first thing you'll see in the file, after some initial comments, is the line
5598 .code
5599 # primary_hostname =
5600 .endd
5601 This is a commented-out setting of the &%primary_hostname%& option. Exim needs
5602 to know the official, fully qualified name of your host, and this is where you
5603 can specify it. However, in most cases you do not need to set this option. When
5604 it is unset, Exim uses the &[uname()]& system function to obtain the host name.
5605
5606 The first three non-comment configuration lines are as follows:
5607 .code
5608 domainlist local_domains    = @
5609 domainlist relay_to_domains =
5610 hostlist   relay_from_hosts = 127.0.0.1
5611 .endd
5612 These are not, in fact, option settings. They are definitions of two named
5613 domain lists and one named host list. Exim allows you to give names to lists of
5614 domains, hosts, and email addresses, in order to make it easier to manage the
5615 configuration file (see section &<<SECTnamedlists>>&).
5616
5617 The first line defines a domain list called &'local_domains'&; this is used
5618 later in the configuration to identify domains that are to be delivered
5619 on the local host.
5620
5621 .cindex "@ in a domain list"
5622 There is just one item in this list, the string &"@"&. This is a special form
5623 of entry which means &"the name of the local host"&. Thus, if the local host is
5624 called &'a.host.example'&, mail to &'any.user@a.host.example'& is expected to
5625 be delivered locally. Because the local host's name is referenced indirectly,
5626 the same configuration file can be used on different hosts.
5627
5628 The second line defines a domain list called &'relay_to_domains'&, but the
5629 list itself is empty. Later in the configuration we will come to the part that
5630 controls mail relaying through the local host; it allows relaying to any
5631 domains in this list. By default, therefore, no relaying on the basis of a mail
5632 domain is permitted.
5633
5634 The third line defines a host list called &'relay_from_hosts'&. This list is
5635 used later in the configuration to permit relaying from any host or IP address
5636 that matches the list. The default contains just the IP address of the IPv4
5637 loopback interface, which means that processes on the local host are able to
5638 submit mail for relaying by sending it over TCP/IP to that interface. No other
5639 hosts are permitted to submit messages for relaying.
5640
5641 Just to be sure there's no misunderstanding: at this point in the configuration
5642 we aren't actually setting up any controls. We are just defining some domains
5643 and hosts that will be used in the controls that are specified later.
5644
5645 The next two configuration lines are genuine option settings:
5646 .code
5647 acl_smtp_rcpt = acl_check_rcpt
5648 acl_smtp_data = acl_check_data
5649 .endd
5650 These options specify &'Access Control Lists'& (ACLs) that are to be used
5651 during an incoming SMTP session for every recipient of a message (every RCPT
5652 command), and after the contents of the message have been received,
5653 respectively. The names of the lists are &'acl_check_rcpt'& and
5654 &'acl_check_data'&, and we will come to their definitions below, in the ACL
5655 section of the configuration. The RCPT ACL controls which recipients are
5656 accepted for an incoming message &-- if a configuration does not provide an ACL
5657 to check recipients, no SMTP mail can be accepted. The DATA ACL allows the
5658 contents of a message to be checked.
5659
5660 Two commented-out option settings are next:
5661 .code
5662 # av_scanner = clamd:/tmp/clamd
5663 # spamd_address = 127.0.0.1 783
5664 .endd
5665 These are example settings that can be used when Exim is compiled with the
5666 content-scanning extension. The first specifies the interface to the virus
5667 scanner, and the second specifies the interface to SpamAssassin. Further
5668 details are given in chapter &<<CHAPexiscan>>&.
5669
5670 Three more commented-out option settings follow:
5671 .code
5672 # tls_advertise_hosts = *
5673 # tls_certificate = /etc/ssl/exim.crt
5674 # tls_privatekey = /etc/ssl/exim.pem
5675 .endd
5676 These are example settings that can be used when Exim is compiled with
5677 support for TLS (aka SSL) as described in section &<<SECTinctlsssl>>&. The
5678 first one specifies the list of clients that are allowed to use TLS when
5679 connecting to this server; in this case, the wildcard means all clients. The
5680 other options specify where Exim should find its TLS certificate and private
5681 key, which together prove the server's identity to any clients that connect.
5682 More details are given in chapter &<<CHAPTLS>>&.
5683
5684 Another two commented-out option settings follow:
5685 .code
5686 # daemon_smtp_ports = 25 : 465 : 587
5687 # tls_on_connect_ports = 465
5688 .endd
5689 .cindex "port" "465 and 587"
5690 .cindex "port" "for message submission"
5691 .cindex "message" "submission, ports for"
5692 .cindex "submissions protocol"
5693 .cindex "smtps protocol"
5694 .cindex "ssmtp protocol"
5695 .cindex "SMTP" "submissions protocol"
5696 .cindex "SMTP" "ssmtp protocol"
5697 .cindex "SMTP" "smtps protocol"
5698 These options provide better support for roaming users who wish to use this
5699 server for message submission. They are not much use unless you have turned on
5700 TLS (as described in the previous paragraph) and authentication (about which
5701 more in section &<<SECTdefconfauth>>&).
5702 Mail submission from mail clients (MUAs) should be separate from inbound mail
5703 to your domain (MX delivery) for various good reasons (eg, ability to impose
5704 much saner TLS protocol and ciphersuite requirements without unintended
5705 consequences).
5706 RFC 6409 (previously 4409) specifies use of port 587 for SMTP Submission,
5707 which uses STARTTLS, so this is the &"submission"& port.
5708 RFC 8314 specifies use of port 465 as the &"submissions"& protocol,
5709 which should be used in preference to 587.
5710 You should also consider deploying SRV records to help clients find
5711 these ports.
5712 Older names for &"submissions"& are &"smtps"& and &"ssmtp"&.
5713
5714 Two more commented-out options settings follow:
5715 .code
5716 # qualify_domain =
5717 # qualify_recipient =
5718 .endd
5719 The first of these specifies a domain that Exim uses when it constructs a
5720 complete email address from a local login name. This is often needed when Exim
5721 receives a message from a local process. If you do not set &%qualify_domain%&,
5722 the value of &%primary_hostname%& is used. If you set both of these options,
5723 you can have different qualification domains for sender and recipient
5724 addresses. If you set only the first one, its value is used in both cases.
5725
5726 .cindex "domain literal" "recognizing format"
5727 The following line must be uncommented if you want Exim to recognize
5728 addresses of the form &'user@[10.11.12.13]'& that is, with a &"domain literal"&
5729 (an IP address within square brackets) instead of a named domain.
5730 .code
5731 # allow_domain_literals
5732 .endd
5733 The RFCs still require this form, but many people think that in the modern
5734 Internet it makes little sense to permit mail to be sent to specific hosts by
5735 quoting their IP addresses. This ancient format has been used by people who
5736 try to abuse hosts by using them for unwanted relaying. However, some
5737 people believe there are circumstances (for example, messages addressed to
5738 &'postmaster'&) where domain literals are still useful.
5739
5740 The next configuration line is a kind of trigger guard:
5741 .code
5742 never_users = root
5743 .endd
5744 It specifies that no delivery must ever be run as the root user. The normal
5745 convention is to set up &'root'& as an alias for the system administrator. This
5746 setting is a guard against slips in the configuration.
5747 The list of users specified by &%never_users%& is not, however, the complete
5748 list; the build-time configuration in &_Local/Makefile_& has an option called
5749 FIXED_NEVER_USERS specifying a list that cannot be overridden. The
5750 contents of &%never_users%& are added to this list. By default
5751 FIXED_NEVER_USERS also specifies root.
5752
5753 When a remote host connects to Exim in order to send mail, the only information
5754 Exim has about the host's identity is its IP address. The next configuration
5755 line,
5756 .code
5757 host_lookup = *
5758 .endd
5759 specifies that Exim should do a reverse DNS lookup on all incoming connections,
5760 in order to get a host name. This improves the quality of the logging
5761 information, but if you feel it is too expensive, you can remove it entirely,
5762 or restrict the lookup to hosts on &"nearby"& networks.
5763 Note that it is not always possible to find a host name from an IP address,
5764 because not all DNS reverse zones are maintained, and sometimes DNS servers are
5765 unreachable.
5766
5767 The next two lines are concerned with &'ident'& callbacks, as defined by RFC
5768 1413 (hence their names):
5769 .code
5770 rfc1413_hosts = *
5771 rfc1413_query_timeout = 0s
5772 .endd
5773 These settings cause Exim to avoid ident callbacks for all incoming SMTP calls.
5774 Few hosts offer RFC1413 service these days; calls have to be
5775 terminated by a timeout and this needlessly delays the startup
5776 of an incoming SMTP connection.
5777 If you have hosts for which you trust RFC1413 and need this
5778 information, you can change this.
5779
5780 This line enables an efficiency SMTP option.  It is negotiated by clients
5781 and not expected to cause problems but can be disabled if needed.
5782 .code
5783 prdr_enable = true
5784 .endd
5785
5786 When Exim receives messages over SMTP connections, it expects all addresses to
5787 be fully qualified with a domain, as required by the SMTP definition. However,
5788 if you are running a server to which simple clients submit messages, you may
5789 find that they send unqualified addresses. The two commented-out options:
5790 .code
5791 # sender_unqualified_hosts =
5792 # recipient_unqualified_hosts =
5793 .endd
5794 show how you can specify hosts that are permitted to send unqualified sender
5795 and recipient addresses, respectively.
5796
5797 The &%log_selector%& option is used to increase the detail of logging
5798 over the default:
5799 .code
5800 log_selector = +smtp_protocol_error +smtp_syntax_error \
5801                +tls_certificate_verified
5802 .endd
5803
5804 The &%percent_hack_domains%& option is also commented out:
5805 .code
5806 # percent_hack_domains =
5807 .endd
5808 It provides a list of domains for which the &"percent hack"& is to operate.
5809 This is an almost obsolete form of explicit email routing. If you do not know
5810 anything about it, you can safely ignore this topic.
5811
5812 The next two settings in the main part of the default configuration are
5813 concerned with messages that have been &"frozen"& on Exim's queue. When a
5814 message is frozen, Exim no longer continues to try to deliver it. Freezing
5815 occurs when a bounce message encounters a permanent failure because the sender
5816 address of the original message that caused the bounce is invalid, so the
5817 bounce cannot be delivered. This is probably the most common case, but there
5818 are also other conditions that cause freezing, and frozen messages are not
5819 always bounce messages.
5820 .code
5821 ignore_bounce_errors_after = 2d
5822 timeout_frozen_after = 7d
5823 .endd
5824 The first of these options specifies that failing bounce messages are to be
5825 discarded after 2 days in the queue. The second specifies that any frozen
5826 message (whether a bounce message or not) is to be timed out (and discarded)
5827 after a week. In this configuration, the first setting ensures that no failing
5828 bounce message ever lasts a week.
5829
5830 Exim queues it's messages in a spool directory. If you expect to have
5831 large queues, you may consider using this option. It splits the spool
5832 directory into subdirectories to avoid file system degradation from
5833 many files in a single directory, resulting in better performance.
5834 Manual manipulation of queued messages becomes more complex (though fortunately
5835 not often needed).
5836 .code
5837 # split_spool_directory = true
5838 .endd
5839
5840 In an ideal world everybody follows the standards. For non-ASCII
5841 messages RFC 2047 is a standard, allowing a maximum line length of 76
5842 characters. Exim adheres that standard and won't process messages which
5843 violate this standard. (Even ${rfc2047:...} expansions will fail.)
5844 In particular, the Exim maintainers have had multiple reports of
5845 problems from Russian administrators of issues until they disable this
5846 check, because of some popular, yet buggy, mail composition software.
5847 .code
5848 # check_rfc2047_length = false
5849 .endd
5850
5851 If you need to be strictly RFC compliant you may wish to disable the
5852 8BITMIME advertisement. Use this, if you exchange mails with systems
5853 that are not 8-bit clean.
5854 .code
5855 # accept_8bitmime = false
5856 .endd
5857
5858 Libraries you use may depend on specific environment settings.  This
5859 imposes a security risk (e.g. PATH). There are two lists:
5860 &%keep_environment%& for the variables to import as they are, and
5861 &%add_environment%& for variables we want to set to a fixed value.
5862 Note that TZ is handled separately, by the $%timezone%$ runtime
5863 option and by the TIMEZONE_DEFAULT buildtime option.
5864 .code
5865 # keep_environment = ^LDAP
5866 # add_environment = PATH=/usr/bin::/bin
5867 .endd
5868
5869
5870 .section "ACL configuration" "SECID54"
5871 .cindex "default" "ACLs"
5872 .cindex "&ACL;" "default configuration"
5873 In the default configuration, the ACL section follows the main configuration.
5874 It starts with the line
5875 .code
5876 begin acl
5877 .endd
5878 and it contains the definitions of two ACLs, called &'acl_check_rcpt'& and
5879 &'acl_check_data'&, that were referenced in the settings of &%acl_smtp_rcpt%&
5880 and &%acl_smtp_data%& above.
5881
5882 .cindex "RCPT" "ACL for"
5883 The first ACL is used for every RCPT command in an incoming SMTP message. Each
5884 RCPT command specifies one of the message's recipients. The ACL statements
5885 are considered in order, until the recipient address is either accepted or
5886 rejected. The RCPT command is then accepted or rejected, according to the
5887 result of the ACL processing.
5888 .code
5889 acl_check_rcpt:
5890 .endd
5891 This line, consisting of a name terminated by a colon, marks the start of the
5892 ACL, and names it.
5893 .code
5894 accept  hosts = :
5895 .endd
5896 This ACL statement accepts the recipient if the sending host matches the list.
5897 But what does that strange list mean? It doesn't actually contain any host
5898 names or IP addresses. The presence of the colon puts an empty item in the
5899 list; Exim matches this only if the incoming message did not come from a remote
5900 host, because in that case, the remote hostname is empty. The colon is
5901 important. Without it, the list itself is empty, and can never match anything.
5902
5903 What this statement is doing is to accept unconditionally all recipients in
5904 messages that are submitted by SMTP from local processes using the standard
5905 input and output (that is, not using TCP/IP). A number of MUAs operate in this
5906 manner.
5907 .code
5908 deny    domains       = +local_domains
5909         local_parts   = ^[.] : ^.*[@%!/|]
5910         message       = Restricted characters in address
5911
5912 deny    domains       = !+local_domains
5913         local_parts   = ^[./|] : ^.*[@%!] : ^.*/\\.\\./
5914         message       = Restricted characters in address
5915 .endd
5916 These statements are concerned with local parts that contain any of the
5917 characters &"@"&, &"%"&, &"!"&, &"/"&, &"|"&, or dots in unusual places.
5918 Although these characters are entirely legal in local parts (in the case of
5919 &"@"& and leading dots, only if correctly quoted), they do not commonly occur
5920 in Internet mail addresses.
5921
5922 The first three have in the past been associated with explicitly routed
5923 addresses (percent is still sometimes used &-- see the &%percent_hack_domains%&
5924 option). Addresses containing these characters are regularly tried by spammers
5925 in an attempt to bypass relaying restrictions, and also by open relay testing
5926 programs. Unless you really need them it is safest to reject these characters
5927 at this early stage. This configuration is heavy-handed in rejecting these
5928 characters for all messages it accepts from remote hosts. This is a deliberate
5929 policy of being as safe as possible.
5930
5931 The first rule above is stricter, and is applied to messages that are addressed
5932 to one of the local domains handled by this host. This is implemented by the
5933 first condition, which restricts it to domains that are listed in the
5934 &'local_domains'& domain list. The &"+"& character is used to indicate a
5935 reference to a named list. In this configuration, there is just one domain in
5936 &'local_domains'&, but in general there may be many.
5937
5938 The second condition on the first statement uses two regular expressions to
5939 block local parts that begin with a dot or contain &"@"&, &"%"&, &"!"&, &"/"&,
5940 or &"|"&. If you have local accounts that include these characters, you will
5941 have to modify this rule.
5942
5943 Empty components (two dots in a row) are not valid in RFC 2822, but Exim
5944 allows them because they have been encountered in practice. (Consider the
5945 common convention of local parts constructed as
5946 &"&'first-initial.second-initial.family-name'&"& when applied to someone like
5947 the author of Exim, who has no second initial.) However, a local part starting
5948 with a dot or containing &"/../"& can cause trouble if it is used as part of a
5949 filename (for example, for a mailing list). This is also true for local parts
5950 that contain slashes. A pipe symbol can also be troublesome if the local part
5951 is incorporated unthinkingly into a shell command line.
5952
5953 The second rule above applies to all other domains, and is less strict. This
5954 allows your own users to send outgoing messages to sites that use slashes
5955 and vertical bars in their local parts. It blocks local parts that begin
5956 with a dot, slash, or vertical bar, but allows these characters within the
5957 local part. However, the sequence &"/../"& is barred. The use of &"@"&, &"%"&,
5958 and &"!"& is blocked, as before. The motivation here is to prevent your users
5959 (or your users' viruses) from mounting certain kinds of attack on remote sites.
5960 .code
5961 accept  local_parts   = postmaster
5962         domains       = +local_domains
5963 .endd
5964 This statement, which has two conditions, accepts an incoming address if the
5965 local part is &'postmaster'& and the domain is one of those listed in the
5966 &'local_domains'& domain list. The &"+"& character is used to indicate a
5967 reference to a named list. In this configuration, there is just one domain in
5968 &'local_domains'&, but in general there may be many.
5969
5970 The presence of this statement means that mail to postmaster is never blocked
5971 by any of the subsequent tests. This can be helpful while sorting out problems
5972 in cases where the subsequent tests are incorrectly denying access.
5973 .code
5974 require verify        = sender
5975 .endd
5976 This statement requires the sender address to be verified before any subsequent
5977 ACL statement can be used. If verification fails, the incoming recipient
5978 address is refused. Verification consists of trying to route the address, to
5979 see if a bounce message could be delivered to it. In the case of remote
5980 addresses, basic verification checks only the domain, but &'callouts'& can be
5981 used for more verification if required. Section &<<SECTaddressverification>>&
5982 discusses the details of address verification.
5983 .code
5984 accept  hosts         = +relay_from_hosts
5985         control       = submission
5986 .endd
5987 This statement accepts the address if the message is coming from one of the
5988 hosts that are defined as being allowed to relay through this host. Recipient
5989 verification is omitted here, because in many cases the clients are dumb MUAs
5990 that do not cope well with SMTP error responses. For the same reason, the
5991 second line specifies &"submission mode"& for messages that are accepted. This
5992 is described in detail in section &<<SECTsubmodnon>>&; it causes Exim to fix
5993 messages that are deficient in some way, for example, because they lack a
5994 &'Date:'& header line. If you are actually relaying out from MTAs, you should
5995 probably add recipient verification here, and disable submission mode.
5996 .code
5997 accept  authenticated = *
5998         control       = submission
5999 .endd
6000 This statement accepts the address if the client host has authenticated itself.
6001 Submission mode is again specified, on the grounds that such messages are most
6002 likely to come from MUAs. The default configuration does not define any
6003 authenticators, though it does include some nearly complete commented-out
6004 examples described in &<<SECTdefconfauth>>&. This means that no client can in
6005 fact authenticate until you complete the authenticator definitions.
6006 .code
6007 require message = relay not permitted
6008         domains = +local_domains : +relay_to_domains
6009 .endd
6010 This statement rejects the address if its domain is neither a local domain nor
6011 one of the domains for which this host is a relay.
6012 .code
6013 require verify = recipient
6014 .endd
6015 This statement requires the recipient address to be verified; if verification
6016 fails, the address is rejected.
6017 .code
6018 # deny    dnslists    = black.list.example
6019 #         message     = rejected because $sender_host_address \
6020 #                       is in a black list at $dnslist_domain\n\
6021 #                       $dnslist_text
6022 #
6023 # warn    dnslists    = black.list.example
6024 #         add_header  = X-Warning: $sender_host_address is in \
6025 #                       a black list at $dnslist_domain
6026 #         log_message = found in $dnslist_domain
6027 .endd
6028 These commented-out lines are examples of how you could configure Exim to check
6029 sending hosts against a DNS black list. The first statement rejects messages
6030 from blacklisted hosts, whereas the second just inserts a warning header
6031 line.
6032 .code
6033 # require verify = csa
6034 .endd
6035 This commented-out line is an example of how you could turn on client SMTP
6036 authorization (CSA) checking. Such checks do DNS lookups for special SRV
6037 records.
6038 .code
6039 accept
6040 .endd
6041 The final statement in the first ACL unconditionally accepts any recipient
6042 address that has successfully passed all the previous tests.
6043 .code
6044 acl_check_data:
6045 .endd
6046 This line marks the start of the second ACL, and names it. Most of the contents
6047 of this ACL are commented out:
6048 .code
6049 # deny    malware   = *
6050 #         message   = This message contains a virus \
6051 #                     ($malware_name).
6052 .endd
6053 These lines are examples of how to arrange for messages to be scanned for
6054 viruses when Exim has been compiled with the content-scanning extension, and a
6055 suitable virus scanner is installed. If the message is found to contain a
6056 virus, it is rejected with the given custom error message.
6057 .code
6058 # warn    spam      = nobody
6059 #         message   = X-Spam_score: $spam_score\n\
6060 #                     X-Spam_score_int: $spam_score_int\n\
6061 #                     X-Spam_bar: $spam_bar\n\
6062 #                     X-Spam_report: $spam_report
6063 .endd
6064 These lines are an example of how to arrange for messages to be scanned by
6065 SpamAssassin when Exim has been compiled with the content-scanning extension,
6066 and SpamAssassin has been installed. The SpamAssassin check is run with
6067 &`nobody`& as its user parameter, and the results are added to the message as a
6068 series of extra header line. In this case, the message is not rejected,
6069 whatever the spam score.
6070 .code
6071 accept
6072 .endd
6073 This final line in the DATA ACL accepts the message unconditionally.
6074
6075
6076 .section "Router configuration" "SECID55"
6077 .cindex "default" "routers"
6078 .cindex "routers" "default"
6079 The router configuration comes next in the default configuration, introduced
6080 by the line
6081 .code
6082 begin routers
6083 .endd
6084 Routers are the modules in Exim that make decisions about where to send
6085 messages. An address is passed to each router, in turn, until it is either
6086 accepted, or failed. This means that the order in which you define the routers
6087 matters. Each router is fully described in its own chapter later in this
6088 manual. Here we give only brief overviews.
6089 .code
6090 # domain_literal:
6091 #   driver = ipliteral
6092 #   domains = !+local_domains
6093 #   transport = remote_smtp
6094 .endd
6095 .cindex "domain literal" "default router"
6096 This router is commented out because the majority of sites do not want to
6097 support domain literal addresses (those of the form &'user@[10.9.8.7]'&). If
6098 you uncomment this router, you also need to uncomment the setting of
6099 &%allow_domain_literals%& in the main part of the configuration.
6100
6101 Which router is used next depends upon whether or not the ROUTER_SMARTHOST
6102 macro has been defined, per
6103 .code
6104 .ifdef ROUTER_SMARTHOST
6105 smarthost:
6106 #...
6107 .else
6108 dnslookup:
6109 #...
6110 .endif
6111 .endd
6112
6113 If ROUTER_SMARTHOST has been defined, either at the top of the file or on the
6114 command-line, then we route all non-local mail to that smarthost; otherwise, we'll
6115 perform DNS lookups for direct-to-MX lookup.  Any mail which is to a local domain will
6116 skip these routers because of the &%domains%& option.
6117
6118 .code
6119 smarthost:
6120   driver = manualroute
6121   domains = ! +local_domains
6122   transport = smarthost_smtp
6123   route_data = ROUTER_SMARTHOST
6124   ignore_target_hosts = <; 0.0.0.0 ; 127.0.0.0/8 ; ::1
6125   no_more
6126 .endd
6127 This router only handles mail which is not to any local domains; this is
6128 specified by the line
6129 .code
6130 domains = ! +local_domains
6131 .endd
6132 The &%domains%& option lists the domains to which this router applies, but the
6133 exclamation mark is a negation sign, so the router is used only for domains
6134 that are not in the domain list called &'local_domains'& (which was defined at
6135 the start of the configuration). The plus sign before &'local_domains'&
6136 indicates that it is referring to a named list. Addresses in other domains are
6137 passed on to the following routers.
6138
6139 The name of the router driver is &(manualroute)& because we are manually
6140 specifying how mail should be routed onwards, instead of using DNS MX.
6141 While the name of this router instance is arbitrary, the &%driver%& option must
6142 be one of the driver modules that is in the Exim binary.
6143
6144 With no pre-conditions other than &%domains%&, all mail for non-local domains
6145 will be handled by this router, and the &%no_more%& setting will ensure that no
6146 other routers will be used for messages matching the pre-conditions.  See
6147 &<<SECTrouprecon>>& for more on how the pre-conditions apply.  For messages which
6148 are handled by this router, we provide a hostname to deliver to in &%route_data%&
6149 and the macro supplies the value; the address is then queued for the
6150 &(smarthost_smtp)& transport.
6151
6152 .code
6153 dnslookup:
6154   driver = dnslookup
6155   domains = ! +local_domains
6156   transport = remote_smtp
6157   ignore_target_hosts = 0.0.0.0 : 127.0.0.0/8
6158   no_more
6159 .endd
6160 The &%domains%& option behaves as per smarthost, above.
6161
6162 The name of the router driver is &(dnslookup)&,
6163 and is specified by the &%driver%& option. Do not be confused by the fact that
6164 the name of this router instance is the same as the name of the driver. The
6165 instance name is arbitrary, but the name set in the &%driver%& option must be
6166 one of the driver modules that is in the Exim binary.
6167
6168 The &(dnslookup)& router routes addresses by looking up their domains in the
6169 DNS in order to obtain a list of hosts to which the address is routed. If the
6170 router succeeds, the address is queued for the &(remote_smtp)& transport, as
6171 specified by the &%transport%& option. If the router does not find the domain
6172 in the DNS, no further routers are tried because of the &%no_more%& setting, so
6173 the address fails and is bounced.
6174
6175 The &%ignore_target_hosts%& option specifies a list of IP addresses that are to
6176 be entirely ignored. This option is present because a number of cases have been
6177 encountered where MX records in the DNS point to host names
6178 whose IP addresses are 0.0.0.0 or are in the 127 subnet (typically 127.0.0.1).
6179 Completely ignoring these IP addresses causes Exim to fail to route the
6180 email address, so it bounces. Otherwise, Exim would log a routing problem, and
6181 continue to try to deliver the message periodically until the address timed
6182 out.
6183 .code
6184 system_aliases:
6185   driver = redirect
6186   allow_fail
6187   allow_defer
6188   data = ${lookup{$local_part}lsearch{/etc/aliases}}
6189 # user = exim
6190   file_transport = address_file
6191   pipe_transport = address_pipe
6192 .endd
6193 Control reaches this and subsequent routers only for addresses in the local
6194 domains. This router checks to see whether the local part is defined as an
6195 alias in the &_/etc/aliases_& file, and if so, redirects it according to the
6196 data that it looks up from that file. If no data is found for the local part,
6197 the value of the &%data%& option is empty, causing the address to be passed to
6198 the next router.
6199
6200 &_/etc/aliases_& is a conventional name for the system aliases file that is
6201 often used. That is why it is referenced by from the default configuration
6202 file. However, you can change this by setting SYSTEM_ALIASES_FILE in
6203 &_Local/Makefile_& before building Exim.
6204 .code
6205 userforward:
6206   driver = redirect
6207   check_local_user
6208 # local_part_suffix = +* : -*
6209 # local_part_suffix_optional
6210   file = $home/.forward
6211 # allow_filter
6212   no_verify
6213   no_expn
6214   check_ancestor
6215   file_transport = address_file
6216   pipe_transport = address_pipe
6217   reply_transport = address_reply
6218 .endd
6219 This is the most complicated router in the default configuration. It is another
6220 redirection router, but this time it is looking for forwarding data set up by
6221 individual users. The &%check_local_user%& setting specifies a check that the
6222 local part of the address is the login name of a local user. If it is not, the
6223 router is skipped. The two commented options that follow &%check_local_user%&,
6224 namely:
6225 .code
6226 # local_part_suffix = +* : -*
6227 # local_part_suffix_optional
6228 .endd
6229 .vindex "&$local_part_suffix$&"
6230 show how you can specify the recognition of local part suffixes. If the first
6231 is uncommented, a suffix beginning with either a plus or a minus sign, followed
6232 by any sequence of characters, is removed from the local part and placed in the
6233 variable &$local_part_suffix$&. The second suffix option specifies that the
6234 presence of a suffix in the local part is optional. When a suffix is present,
6235 the check for a local login uses the local part with the suffix removed.
6236
6237 When a local user account is found, the file called &_.forward_& in the user's
6238 home directory is consulted. If it does not exist, or is empty, the router
6239 declines. Otherwise, the contents of &_.forward_& are interpreted as
6240 redirection data (see chapter &<<CHAPredirect>>& for more details).
6241
6242 .cindex "Sieve filter" "enabling in default router"
6243 Traditional &_.forward_& files contain just a list of addresses, pipes, or
6244 files. Exim supports this by default. However, if &%allow_filter%& is set (it
6245 is commented out by default), the contents of the file are interpreted as a set
6246 of Exim or Sieve filtering instructions, provided the file begins with &"#Exim
6247 filter"& or &"#Sieve filter"&, respectively. User filtering is discussed in the
6248 separate document entitled &'Exim's interfaces to mail filtering'&.
6249
6250 The &%no_verify%& and &%no_expn%& options mean that this router is skipped when
6251 verifying addresses, or when running as a consequence of an SMTP EXPN command.
6252 There are two reasons for doing this:
6253
6254 .olist
6255 Whether or not a local user has a &_.forward_& file is not really relevant when
6256 checking an address for validity; it makes sense not to waste resources doing
6257 unnecessary work.
6258 .next
6259 More importantly, when Exim is verifying addresses or handling an EXPN
6260 command during an SMTP session, it is running as the Exim user, not as root.
6261 The group is the Exim group, and no additional groups are set up.
6262 It may therefore not be possible for Exim to read users' &_.forward_& files at
6263 this time.
6264 .endlist
6265
6266 The setting of &%check_ancestor%& prevents the router from generating a new
6267 address that is the same as any previous address that was redirected. (This
6268 works round a problem concerning a bad interaction between aliasing and
6269 forwarding &-- see section &<<SECTredlocmai>>&).
6270
6271 The final three option settings specify the transports that are to be used when
6272 forwarding generates a direct delivery to a file, or to a pipe, or sets up an
6273 auto-reply, respectively. For example, if a &_.forward_& file contains
6274 .code
6275 a.nother@elsewhere.example, /home/spqr/archive
6276 .endd
6277 the delivery to &_/home/spqr/archive_& is done by running the &%address_file%&
6278 transport.
6279 .code
6280 localuser:
6281   driver = accept
6282   check_local_user
6283 # local_part_suffix = +* : -*
6284 # local_part_suffix_optional
6285   transport = local_delivery
6286 .endd
6287 The final router sets up delivery into local mailboxes, provided that the local
6288 part is the name of a local login, by accepting the address and assigning it to
6289 the &(local_delivery)& transport. Otherwise, we have reached the end of the
6290 routers, so the address is bounced. The commented suffix settings fulfil the
6291 same purpose as they do for the &(userforward)& router.
6292
6293
6294 .section "Transport configuration" "SECID56"
6295 .cindex "default" "transports"
6296 .cindex "transports" "default"
6297 Transports define mechanisms for actually delivering messages. They operate
6298 only when referenced from routers, so the order in which they are defined does
6299 not matter. The transports section of the configuration starts with
6300 .code
6301 begin transports
6302 .endd
6303 Two remote transports and four local transports are defined.
6304 .code
6305 remote_smtp:
6306   driver = smtp
6307   message_size_limit = ${if > {$max_received_linelength}{998} {1}{0}}
6308 .ifdef _HAVE_PRDR
6309   hosts_try_prdr = *
6310 .endif
6311 .endd
6312 This transport is used for delivering messages over SMTP connections.
6313 The list of remote hosts comes from the router.
6314 The &%message_size_limit%& usage is a hack to avoid sending on messages
6315 with over-long lines.
6316
6317 The &%hosts_try_prdr%& option enables an efficiency SMTP option.  It is
6318 negotiated between client and server and not expected to cause problems
6319 but can be disabled if needed.  The built-in macro _HAVE_PRDR guards the
6320 use of the &%hosts_try_prdr%& configuration option.
6321
6322 The other remote transport is used when delivering to a specific smarthost
6323 with whom there must be some kind of existing relationship, instead of the
6324 usual federated system.
6325
6326 .code
6327 smarthost_smtp:
6328   driver = smtp
6329   message_size_limit = ${if > {$max_received_linelength}{998} {1}{0}}
6330   multi_domain
6331   #
6332 .ifdef _HAVE_TLS
6333   # Comment out any of these which you have to, then file a Support
6334   # request with your smarthost provider to get things fixed:
6335   hosts_require_tls = *
6336   tls_verify_hosts = *
6337   # As long as tls_verify_hosts is enabled, this won't matter, but if you
6338   # have to comment it out then this will at least log whether you succeed
6339   # or not:
6340   tls_try_verify_hosts = *
6341   #
6342   # The SNI name should match the name which we'll expect to verify;
6343   # many mail systems don't use SNI and this doesn't matter, but if it does,
6344   # we need to send a name which the remote site will recognize.
6345   # This _should_ be the name which the smarthost operators specified as
6346   # the hostname for sending your mail to.
6347   tls_sni = ROUTER_SMARTHOST
6348   #
6349 .ifdef _HAVE_OPENSSL
6350   tls_require_ciphers = HIGH:!aNULL:@STRENGTH
6351 .endif
6352 .ifdef _HAVE_GNUTLS
6353   tls_require_ciphers = SECURE192:-VERS-SSL3.0:-VERS-TLS1.0:-VERS-TLS1.1
6354 .endif
6355 .endif
6356 .ifdef _HAVE_PRDR
6357   hosts_try_prdr = *
6358 .endif
6359 .endd
6360 After the same &%message_size_limit%& hack, we then specify that this Transport
6361 can handle messages to multiple domains in one run.  The assumption here is
6362 that you're routing all non-local mail to the same place and that place is
6363 happy to take all messages from you as quickly as possible.
6364 All other options depend upon built-in macros; if Exim was built without TLS support
6365 then no other options are defined.
6366 If TLS is available, then we configure "stronger than default" TLS ciphersuites
6367 and versions using the &%tls_require_ciphers%& option, where the value to be
6368 used depends upon the library providing TLS.
6369 Beyond that, the options adopt the stance that you should have TLS support available
6370 from your smarthost on today's Internet, so we turn on requiring TLS for the
6371 mail to be delivered, and requiring that the certificate be valid, and match
6372 the expected hostname.  The &%tls_sni%& option can be used by service providers
6373 to select an appropriate certificate to present to you and here we re-use the
6374 ROUTER_SMARTHOST macro, because that is unaffected by CNAMEs present in DNS.
6375 You want to specify the hostname which you'll expect to validate for, and that
6376 should not be subject to insecure tampering via DNS results.
6377
6378 For the &%hosts_try_prdr%& option see the previous transport.
6379
6380 All other options are defaulted.
6381 .code
6382 local_delivery:
6383   driver = appendfile
6384   file = /var/mail/$local_part_data
6385   delivery_date_add
6386   envelope_to_add
6387   return_path_add
6388 # group = mail
6389 # mode = 0660
6390 .endd
6391 This &(appendfile)& transport is used for local delivery to user mailboxes in
6392 traditional BSD mailbox format.
6393
6394 .new
6395 We prefer to avoid using &$local_part$& directly to define the mailbox filename,
6396 as it is provided by a potential bad actor.
6397 Instead we use &$local_part_data$&,
6398 the result of looking up &$local_part$& in the user database
6399 (done by using &%check_local_user%& in the the router).
6400 .wen
6401
6402 By default &(appendfile)& runs under the uid and gid of the
6403 local user, which requires the sticky bit to be set on the &_/var/mail_&
6404 directory. Some systems use the alternative approach of running mail deliveries
6405 under a particular group instead of using the sticky bit. The commented options
6406 show how this can be done.
6407
6408 Exim adds three headers to the message as it delivers it: &'Delivery-date:'&,
6409 &'Envelope-to:'& and &'Return-path:'&. This action is requested by the three
6410 similarly-named options above.
6411 .code
6412 address_pipe:
6413   driver = pipe
6414   return_output
6415 .endd
6416 This transport is used for handling deliveries to pipes that are generated by
6417 redirection (aliasing or users' &_.forward_& files). The &%return_output%&
6418 option specifies that any output on stdout or stderr generated by the pipe is to
6419 be returned to the sender.
6420 .code
6421 address_file:
6422   driver = appendfile
6423   delivery_date_add
6424   envelope_to_add
6425   return_path_add
6426 .endd
6427 This transport is used for handling deliveries to files that are generated by
6428 redirection. The name of the file is not specified in this instance of
6429 &(appendfile)&, because it comes from the &(redirect)& router.
6430 .code
6431 address_reply:
6432   driver = autoreply
6433 .endd
6434 This transport is used for handling automatic replies generated by users'
6435 filter files.
6436
6437
6438
6439 .section "Default retry rule" "SECID57"
6440 .cindex "retry" "default rule"
6441 .cindex "default" "retry rule"
6442 The retry section of the configuration file contains rules which affect the way
6443 Exim retries deliveries that cannot be completed at the first attempt. It is
6444 introduced by the line
6445 .code
6446 begin retry
6447 .endd
6448 In the default configuration, there is just one rule, which applies to all
6449 errors:
6450 .code
6451 *   *   F,2h,15m; G,16h,1h,1.5; F,4d,6h
6452 .endd
6453 This causes any temporarily failing address to be retried every 15 minutes for
6454 2 hours, then at intervals starting at one hour and increasing by a factor of
6455 1.5 until 16 hours have passed, then every 6 hours up to 4 days. If an address
6456 is not delivered after 4 days of temporary failure, it is bounced. The time is
6457 measured from first failure, not from the time the message was received.
6458
6459 If the retry section is removed from the configuration, or is empty (that is,
6460 if no retry rules are defined), Exim will not retry deliveries. This turns
6461 temporary errors into permanent errors.
6462
6463
6464 .section "Rewriting configuration" "SECID58"
6465 The rewriting section of the configuration, introduced by
6466 .code
6467 begin rewrite
6468 .endd
6469 contains rules for rewriting addresses in messages as they arrive. There are no
6470 rewriting rules in the default configuration file.
6471
6472
6473
6474 .section "Authenticators configuration" "SECTdefconfauth"
6475 .cindex "AUTH" "configuration"
6476 The authenticators section of the configuration, introduced by
6477 .code
6478 begin authenticators
6479 .endd
6480 defines mechanisms for the use of the SMTP AUTH command. The default
6481 configuration file contains two commented-out example authenticators
6482 which support plaintext username/password authentication using the
6483 standard PLAIN mechanism and the traditional but non-standard LOGIN
6484 mechanism, with Exim acting as the server. PLAIN and LOGIN are enough
6485 to support most MUA software.
6486
6487 The example PLAIN authenticator looks like this:
6488 .code
6489 #PLAIN:
6490 #  driver                  = plaintext
6491 #  server_set_id           = $auth2
6492 #  server_prompts          = :
6493 #  server_condition        = Authentication is not yet configured
6494 #  server_advertise_condition = ${if def:tls_in_cipher }
6495 .endd
6496 And the example LOGIN authenticator looks like this:
6497 .code
6498 #LOGIN:
6499 #  driver                  = plaintext
6500 #  server_set_id           = $auth1
6501 #  server_prompts          = <| Username: | Password:
6502 #  server_condition        = Authentication is not yet configured
6503 #  server_advertise_condition = ${if def:tls_in_cipher }
6504 .endd
6505
6506 The &%server_set_id%& option makes Exim remember the authenticated username
6507 in &$authenticated_id$&, which can be used later in ACLs or routers. The
6508 &%server_prompts%& option configures the &(plaintext)& authenticator so
6509 that it implements the details of the specific authentication mechanism,
6510 i.e. PLAIN or LOGIN. The &%server_advertise_condition%& setting controls
6511 when Exim offers authentication to clients; in the examples, this is only
6512 when TLS or SSL has been started, so to enable the authenticators you also
6513 need to add support for TLS as described in section &<<SECTdefconfmain>>&.
6514
6515 The &%server_condition%& setting defines how to verify that the username and
6516 password are correct. In the examples it just produces an error message.
6517 To make the authenticators work, you can use a string expansion
6518 expression like one of the examples in chapter &<<CHAPplaintext>>&.
6519
6520 Beware that the sequence of the parameters to PLAIN and LOGIN differ; the
6521 usercode and password are in different positions.
6522 Chapter &<<CHAPplaintext>>& covers both.
6523
6524 .ecindex IIDconfiwal
6525
6526
6527
6528 . ////////////////////////////////////////////////////////////////////////////
6529 . ////////////////////////////////////////////////////////////////////////////
6530
6531 .chapter "Regular expressions" "CHAPregexp"
6532
6533 .cindex "regular expressions" "library"
6534 .cindex "PCRE"
6535 Exim supports the use of regular expressions in many of its options. It
6536 uses the PCRE regular expression library; this provides regular expression
6537 matching that is compatible with Perl 5. The syntax and semantics of
6538 regular expressions is discussed in
6539 online Perl manpages, in
6540 many Perl reference books, and also in
6541 Jeffrey Friedl's &'Mastering Regular Expressions'&, which is published by
6542 O'Reilly (see &url(http://www.oreilly.com/catalog/regex2/)).
6543 . --- the http: URL here redirects to another page with the ISBN in the URL
6544 . --- where trying to use https: just redirects back to http:, so sticking
6545 . --- to the old URL for now.  2018-09-07.
6546
6547 The documentation for the syntax and semantics of the regular expressions that
6548 are supported by PCRE is included in the PCRE distribution, and no further
6549 description is included here. The PCRE functions are called from Exim using
6550 the default option settings (that is, with no PCRE options set), except that
6551 the PCRE_CASELESS option is set when the matching is required to be
6552 case-insensitive.
6553
6554 In most cases, when a regular expression is required in an Exim configuration,
6555 it has to start with a circumflex, in order to distinguish it from plain text
6556 or an &"ends with"& wildcard. In this example of a configuration setting, the
6557 second item in the colon-separated list is a regular expression.
6558 .code
6559 domains = a.b.c : ^\\d{3} : *.y.z : ...
6560 .endd
6561 The doubling of the backslash is required because of string expansion that
6562 precedes interpretation &-- see section &<<SECTlittext>>& for more discussion
6563 of this issue, and a way of avoiding the need for doubling backslashes. The
6564 regular expression that is eventually used in this example contains just one
6565 backslash. The circumflex is included in the regular expression, and has the
6566 normal effect of &"anchoring"& it to the start of the string that is being
6567 matched.
6568
6569 There are, however, two cases where a circumflex is not required for the
6570 recognition of a regular expression: these are the &%match%& condition in a
6571 string expansion, and the &%matches%& condition in an Exim filter file. In
6572 these cases, the relevant string is always treated as a regular expression; if
6573 it does not start with a circumflex, the expression is not anchored, and can
6574 match anywhere in the subject string.
6575
6576 In all cases, if you want a regular expression to match at the end of a string,
6577 you must code the $ metacharacter to indicate this. For example:
6578 .code
6579 domains = ^\\d{3}\\.example
6580 .endd
6581 matches the domain &'123.example'&, but it also matches &'123.example.com'&.
6582 You need to use:
6583 .code
6584 domains = ^\\d{3}\\.example\$
6585 .endd
6586 if you want &'example'& to be the top-level domain. The backslash before the
6587 $ is needed because string expansion also interprets dollar characters.
6588
6589
6590
6591 . ////////////////////////////////////////////////////////////////////////////
6592 . ////////////////////////////////////////////////////////////////////////////
6593
6594 .chapter "File and database lookups" "CHAPfdlookup"
6595 .scindex IIDfidalo1 "file" "lookups"
6596 .scindex IIDfidalo2 "database" "lookups"
6597 .cindex "lookup" "description of"
6598 Exim can be configured to look up data in files or databases as it processes
6599 messages. Two different kinds of syntax are used:
6600
6601 .olist
6602 A string that is to be expanded may contain explicit lookup requests. These
6603 cause parts of the string to be replaced by data that is obtained from the
6604 lookup. Lookups of this type are conditional expansion items. Different results
6605 can be defined for the cases of lookup success and failure. See chapter
6606 &<<CHAPexpand>>&, where string expansions are described in detail.
6607 The key for the lookup is specified as part of the string expansion.
6608 .next
6609 Lists of domains, hosts, and email addresses can contain lookup requests as a
6610 way of avoiding excessively long linear lists. In this case, the data that is
6611 returned by the lookup is often (but not always) discarded; whether the lookup
6612 succeeds or fails is what really counts. These kinds of list are described in
6613 chapter &<<CHAPdomhosaddlists>>&.
6614 The key for the lookup is given by the context in which the list is expanded.
6615 .endlist
6616
6617 String expansions, lists, and lookups interact with each other in such a way
6618 that there is no order in which to describe any one of them that does not
6619 involve references to the others. Each of these three chapters makes more sense
6620 if you have read the other two first. If you are reading this for the first
6621 time, be aware that some of it will make a lot more sense after you have read
6622 chapters &<<CHAPdomhosaddlists>>& and &<<CHAPexpand>>&.
6623
6624 .section "Examples of different lookup syntax" "SECID60"
6625 It is easy to confuse the two different kinds of lookup, especially as the
6626 lists that may contain the second kind are always expanded before being
6627 processed as lists. Therefore, they may also contain lookups of the first kind.
6628 Be careful to distinguish between the following two examples:
6629 .code
6630 domains = ${lookup{$sender_host_address}lsearch{/some/file}}
6631 domains = lsearch;/some/file
6632 .endd
6633 The first uses a string expansion, the result of which must be a domain list.
6634 No strings have been specified for a successful or a failing lookup; the
6635 defaults in this case are the looked-up data and an empty string, respectively.
6636 The expansion takes place before the string is processed as a list, and the
6637 file that is searched could contain lines like this:
6638 .code
6639 192.168.3.4: domain1:domain2:...
6640 192.168.1.9: domain3:domain4:...
6641 .endd
6642 When the lookup succeeds, the result of the expansion is a list of domains (and
6643 possibly other types of item that are allowed in domain lists).
6644 .cindex "tainted data" "de-tainting"
6645 The result of the expansion is not tainted.
6646
6647 In the second example, the lookup is a single item in a domain list. It causes
6648 Exim to use a lookup to see if the domain that is being processed can be found
6649 in the file. The file could contains lines like this:
6650 .code
6651 domain1:
6652 domain2:
6653 .endd
6654 Any data that follows the keys is not relevant when checking that the domain
6655 matches the list item.
6656
6657 It is possible, though no doubt confusing, to use both kinds of lookup at once.
6658 Consider a file containing lines like this:
6659 .code
6660 192.168.5.6: lsearch;/another/file
6661 .endd
6662 If the value of &$sender_host_address$& is 192.168.5.6, expansion of the
6663 first &%domains%& setting above generates the second setting, which therefore
6664 causes a second lookup to occur.
6665
6666 The rest of this chapter describes the different lookup types that are
6667 available. Any of them can be used in any part of the configuration where a
6668 lookup is permitted.
6669
6670
6671 .section "Lookup types" "SECID61"
6672 .cindex "lookup" "types of"
6673 .cindex "single-key lookup" "definition of"
6674 Two different types of data lookup are implemented:
6675
6676 .ilist
6677 The &'single-key'& type requires the specification of a file in which to look,
6678 and a single key to search for. The key must be a non-empty string for the
6679 lookup to succeed. The lookup type determines how the file is searched.
6680 .new
6681 .cindex "tainted data" "single-key lookups"
6682 The file string may not be tainted
6683 .wen
6684 .next
6685 .cindex "query-style lookup" "definition of"
6686 The &'query-style'& type accepts a generalized database query. No particular
6687 key value is assumed by Exim for query-style lookups. You can use whichever
6688 Exim variables you need to construct the database query.
6689 .endlist
6690
6691 The code for each lookup type is in a separate source file that is included in
6692 the binary of Exim only if the corresponding compile-time option is set. The
6693 default settings in &_src/EDITME_& are:
6694 .code
6695 LOOKUP_DBM=yes
6696 LOOKUP_LSEARCH=yes
6697 .endd
6698 which means that only linear searching and DBM lookups are included by default.
6699 For some types of lookup (e.g. SQL databases), you need to install appropriate
6700 libraries and header files before building Exim.
6701
6702
6703
6704
6705 .section "Single-key lookup types" "SECTsinglekeylookups"
6706 .cindex "lookup" "single-key types"
6707 .cindex "single-key lookup" "list of types"
6708 The following single-key lookup types are implemented:
6709
6710 .ilist
6711 .cindex "cdb" "description of"
6712 .cindex "lookup" "cdb"
6713 .cindex "binary zero" "in lookup key"
6714 &(cdb)&: The given file is searched as a Constant DataBase file, using the key
6715 string without a terminating binary zero. The cdb format is designed for
6716 indexed files that are read frequently and never updated, except by total
6717 re-creation. As such, it is particularly suitable for large files containing
6718 aliases or other indexed data referenced by an MTA. Information about cdb and
6719 tools for building the files can be found in several places:
6720 .display
6721 &url(https://cr.yp.to/cdb.html)
6722 &url(https://www.corpit.ru/mjt/tinycdb.html)
6723 &url(https://packages.debian.org/stable/utils/freecdb)
6724 &url(https://github.com/philpennock/cdbtools) (in Go)
6725 .endd
6726 A cdb distribution is not needed in order to build Exim with cdb support,
6727 because the code for reading cdb files is included directly in Exim itself.
6728 However, no means of building or testing cdb files is provided with Exim, so
6729 you need to obtain a cdb distribution in order to do this.
6730 .next
6731 .cindex "DBM" "lookup type"
6732 .cindex "lookup" "dbm"
6733 .cindex "binary zero" "in lookup key"
6734 &(dbm)&: Calls to DBM library functions are used to extract data from the given
6735 DBM file by looking up the record with the given key. A terminating binary
6736 zero is included in the key that is passed to the DBM library. See section
6737 &<<SECTdb>>& for a discussion of DBM libraries.
6738
6739 .cindex "Berkeley DB library" "file format"
6740 For all versions of Berkeley DB, Exim uses the DB_HASH style of database
6741 when building DBM files using the &%exim_dbmbuild%& utility. However, when
6742 using Berkeley DB versions 3 or 4, it opens existing databases for reading with
6743 the DB_UNKNOWN option. This enables it to handle any of the types of database
6744 that the library supports, and can be useful for accessing DBM files created by
6745 other applications. (For earlier DB versions, DB_HASH is always used.)
6746 .next
6747 .cindex "lookup" "dbmjz"
6748 .cindex "lookup" "dbm &-- embedded NULs"
6749 .cindex "sasldb2"
6750 .cindex "dbmjz lookup type"
6751 &(dbmjz)&: This is the same as &(dbm)&, except that the lookup key is
6752 interpreted as an Exim list; the elements of the list are joined together with
6753 ASCII NUL characters to form the lookup key.  An example usage would be to
6754 authenticate incoming SMTP calls using the passwords from Cyrus SASL's
6755 &_/etc/sasldb2_& file with the &(gsasl)& authenticator or Exim's own
6756 &(cram_md5)& authenticator.
6757 .next
6758 .cindex "lookup" "dbmnz"
6759 .cindex "lookup" "dbm &-- terminating zero"
6760 .cindex "binary zero" "in lookup key"
6761 .cindex "Courier"
6762 .cindex "&_/etc/userdbshadow.dat_&"
6763 .cindex "dbmnz lookup type"
6764 &(dbmnz)&: This is the same as &(dbm)&, except that a terminating binary zero
6765 is not included in the key that is passed to the DBM library. You may need this
6766 if you want to look up data in files that are created by or shared with some
6767 other application that does not use terminating zeros. For example, you need to
6768 use &(dbmnz)& rather than &(dbm)& if you want to authenticate incoming SMTP
6769 calls using the passwords from Courier's &_/etc/userdbshadow.dat_& file. Exim's
6770 utility program for creating DBM files (&'exim_dbmbuild'&) includes the zeros
6771 by default, but has an option to omit them (see section &<<SECTdbmbuild>>&).
6772 .next
6773 .cindex "lookup" "dsearch"
6774 .cindex "dsearch lookup type"
6775 &(dsearch)&: The given file must be an
6776 .new
6777 absolute
6778 .wen
6779 directory path; this is searched for an entry
6780 whose name is the key by calling the &[lstat()]& function.
6781 The key may not
6782 contain any forward slash characters.
6783 If &[lstat()]& succeeds then so does the lookup.
6784 .new
6785 .cindex "tainted data" "dsearch result"
6786 The result is regarded as untainted.
6787
6788 Options for the lookup can be given by appending them after the word "dsearch",
6789 separated by a comma.  Options, if present, are a comma-separated list having
6790 each element starting with a tag name and an equals.
6791
6792 Two options are supported, for the return value and for filtering match
6793 candidates.
6794 The "ret" option requests an alternate result value of
6795 the entire path for the entry. Example:
6796 .code
6797 ${lookup {passwd} dsearch,ret=full {/etc}}
6798 .endd
6799 The default result is just the requested entry.
6800 The "filter" option requests that only directory entries of a given type
6801 are matched. The match value is one of "file", "dir" or "subdir" (the latter
6802 not matching "." or ".."). Example:
6803 .code
6804 ${lookup {passwd} dsearch,filter=file {/etc}}
6805 .endd
6806 The default matching is for any entry type, including directories
6807 and symlinks.
6808 .wen
6809
6810 An example of how this
6811 lookup can be used to support virtual domains is given in section
6812 &<<SECTvirtualdomains>>&.
6813 .next
6814 .cindex "lookup" "iplsearch"
6815 .cindex "iplsearch lookup type"
6816 &(iplsearch)&: The given file is a text file containing keys and data. A key is
6817 terminated by a colon or white space or the end of the line. The keys in the
6818 file must be IP addresses, or IP addresses with CIDR masks. Keys that involve
6819 IPv6 addresses must be enclosed in quotes to prevent the first internal colon
6820 being interpreted as a key terminator. For example:
6821 .code
6822 1.2.3.4:           data for 1.2.3.4
6823 192.168.0.0/16:    data for 192.168.0.0/16
6824 "abcd::cdab":      data for abcd::cdab
6825 "abcd:abcd::/32"   data for abcd:abcd::/32
6826 .endd
6827 The key for an &(iplsearch)& lookup must be an IP address (without a mask). The
6828 file is searched linearly, using the CIDR masks where present, until a matching
6829 key is found. The first key that matches is used; there is no attempt to find a
6830 &"best"& match. Apart from the way the keys are matched, the processing for
6831 &(iplsearch)& is the same as for &(lsearch)&.
6832
6833 &*Warning 1*&: Unlike most other single-key lookup types, a file of data for
6834 &(iplsearch)& can &'not'& be turned into a DBM or cdb file, because those
6835 lookup types support only literal keys.
6836
6837 &*Warning 2*&: In a host list, you must always use &(net-iplsearch)& so that
6838 the implicit key is the host's IP address rather than its name (see section
6839 &<<SECThoslispatsikey>>&).
6840
6841 &*Warning 3*&: Do not use an IPv4-mapped IPv6 address for a key; use the
6842 IPv4, in dotted-quad form. (Exim converts IPv4-mapped IPv6 addresses to this
6843 notation before executing the lookup.)
6844 .next
6845 .cindex lookup json
6846 .cindex json "lookup type"
6847 .cindex JSON expansions
6848 &(json)&: The given file is a text file with a JSON structure.
6849 An element of the structure is extracted, defined by the search key.
6850 The key is a list of subelement selectors
6851 (colon-separated by default but changeable in the usual way)
6852 which are applied in turn to select smaller and smaller portions
6853 of the JSON structure.
6854 If a selector is numeric, it must apply to a JSON array; the (zero-based)
6855 nunbered array element is selected.
6856 Otherwise it must apply to a JSON object; the named element is selected.
6857 The final resulting element can be a simple JSON type or a JSON object
6858 or array; for the latter two a string-representation of the JSON
6859 is returned.
6860 For elements of type string, the returned value is de-quoted.
6861 .next
6862 .cindex "linear search"
6863 .cindex "lookup" "lsearch"
6864 .cindex "lsearch lookup type"
6865 .cindex "case sensitivity" "in lsearch lookup"
6866 &(lsearch)&: The given file is a text file that is searched linearly for a
6867 line beginning with the search key, terminated by a colon or white space or the
6868 end of the line. The search is case-insensitive; that is, upper and lower case
6869 letters are treated as the same. The first occurrence of the key that is found
6870 in the file is used.
6871
6872 White space between the key and the colon is permitted. The remainder of the
6873 line, with leading and trailing white space removed, is the data. This can be
6874 continued onto subsequent lines by starting them with any amount of white
6875 space, but only a single space character is included in the data at such a
6876 junction. If the data begins with a colon, the key must be terminated by a
6877 colon, for example:
6878 .code
6879 baduser:  :fail:
6880 .endd
6881 Empty lines and lines beginning with # are ignored, even if they occur in the
6882 middle of an item. This is the traditional textual format of alias files. Note
6883 that the keys in an &(lsearch)& file are literal strings. There is no
6884 wildcarding of any kind.
6885
6886 .cindex "lookup" "lsearch &-- colons in keys"
6887 .cindex "white space" "in lsearch key"
6888 In most &(lsearch)& files, keys are not required to contain colons or #
6889 characters, or white space. However, if you need this feature, it is available.
6890 If a key begins with a doublequote character, it is terminated only by a
6891 matching quote (or end of line), and the normal escaping rules apply to its
6892 contents (see section &<<SECTstrings>>&). An optional colon is permitted after
6893 quoted keys (exactly as for unquoted keys). There is no special handling of
6894 quotes for the data part of an &(lsearch)& line.
6895
6896 .next
6897 .cindex "NIS lookup type"
6898 .cindex "lookup" "NIS"
6899 .cindex "binary zero" "in lookup key"
6900 &(nis)&: The given file is the name of a NIS map, and a NIS lookup is done with
6901 the given key, without a terminating binary zero. There is a variant called
6902 &(nis0)& which does include the terminating binary zero in the key. This is
6903 reportedly needed for Sun-style alias files. Exim does not recognize NIS
6904 aliases; the full map names must be used.
6905
6906 .next
6907 .cindex "wildlsearch lookup type"
6908 .cindex "lookup" "wildlsearch"
6909 .cindex "nwildlsearch lookup type"
6910 .cindex "lookup" "nwildlsearch"
6911 &(wildlsearch)& or &(nwildlsearch)&: These search a file linearly, like
6912 &(lsearch)&, but instead of being interpreted as a literal string, each key in
6913 the file may be wildcarded. The difference between these two lookup types is
6914 that for &(wildlsearch)&, each key in the file is string-expanded before being
6915 used, whereas for &(nwildlsearch)&, no expansion takes place.
6916
6917 .cindex "case sensitivity" "in (n)wildlsearch lookup"
6918 Like &(lsearch)&, the testing is done case-insensitively. However, keys in the
6919 file that are regular expressions can be made case-sensitive by the use of
6920 &`(-i)`& within the pattern. The following forms of wildcard are recognized:
6921
6922 . ==== As this is a nested list, any displays it contains must be indented
6923 . ==== as otherwise they are too far to the left.
6924
6925 .olist
6926 The string may begin with an asterisk to mean &"ends with"&. For example:
6927 .code
6928     *.a.b.c       data for anything.a.b.c
6929     *fish         data for anythingfish
6930 .endd
6931 .next
6932 The string may begin with a circumflex to indicate a regular expression. For
6933 example, for &(wildlsearch)&:
6934 .code
6935     ^\N\d+\.a\.b\N    data for <digits>.a.b
6936 .endd
6937 Note the use of &`\N`& to disable expansion of the contents of the regular
6938 expression. If you are using &(nwildlsearch)&, where the keys are not
6939 string-expanded, the equivalent entry is:
6940 .code
6941     ^\d+\.a\.b        data for <digits>.a.b
6942 .endd
6943 The case-insensitive flag is set at the start of compiling the regular
6944 expression, but it can be turned off by using &`(-i)`& at an appropriate point.
6945 For example, to make the entire pattern case-sensitive:
6946 .code
6947     ^(?-i)\d+\.a\.b        data for <digits>.a.b
6948 .endd
6949
6950 If the regular expression contains white space or colon characters, you must
6951 either quote it (see &(lsearch)& above), or represent these characters in other
6952 ways. For example, &`\s`& can be used for white space and &`\x3A`& for a
6953 colon. This may be easier than quoting, because if you quote, you have to
6954 escape all the backslashes inside the quotes.
6955
6956 &*Note*&: It is not possible to capture substrings in a regular expression
6957 match for later use, because the results of all lookups are cached. If a lookup
6958 is repeated, the result is taken from the cache, and no actual pattern matching
6959 takes place. The values of all the numeric variables are unset after a
6960 &((n)wildlsearch)& match.
6961
6962 .next
6963 Although I cannot see it being of much use, the general matching function that
6964 is used to implement &((n)wildlsearch)& means that the string may begin with a
6965 lookup name terminated by a semicolon, and followed by lookup data. For
6966 example:
6967 .code
6968     cdb;/some/file  data for keys that match the file
6969 .endd
6970 The data that is obtained from the nested lookup is discarded.
6971 .endlist olist
6972
6973 Keys that do not match any of these patterns are interpreted literally. The
6974 continuation rules for the data are the same as for &(lsearch)&, and keys may
6975 be followed by optional colons.
6976
6977 &*Warning*&: Unlike most other single-key lookup types, a file of data for
6978 &((n)wildlsearch)& can &'not'& be turned into a DBM or cdb file, because those
6979 lookup types support only literal keys.
6980
6981 .next
6982 .cindex "spf lookup type"
6983 .cindex "lookup" "spf"
6984 &(spf)&: If Exim is built with SPF support, manual lookups can be done
6985 (as opposed to the standard ACL condition method).
6986 For details see section &<<SECSPF>>&.
6987 .endlist ilist
6988
6989
6990 .section "Query-style lookup types" "SECTquerystylelookups"
6991 .cindex "lookup" "query-style types"
6992 .cindex "query-style lookup" "list of types"
6993 The supported query-style lookup types are listed below. Further details about
6994 many of them are given in later sections.
6995
6996 .ilist
6997 .cindex "DNS" "as a lookup type"
6998 .cindex "lookup" "DNS"
6999 &(dnsdb)&: This does a DNS search for one or more records whose domain names
7000 are given in the supplied query. The resulting data is the contents of the
7001 records. See section &<<SECTdnsdb>>&.
7002 .next
7003 .cindex "InterBase lookup type"
7004 .cindex "lookup" "InterBase"
7005 &(ibase)&: This does a lookup in an InterBase database.
7006 .next
7007 .cindex "LDAP" "lookup type"
7008 .cindex "lookup" "LDAP"
7009 &(ldap)&: This does an LDAP lookup using a query in the form of a URL, and
7010 returns attributes from a single entry. There is a variant called &(ldapm)&
7011 that permits values from multiple entries to be returned. A third variant
7012 called &(ldapdn)& returns the Distinguished Name of a single entry instead of
7013 any attribute values. See section &<<SECTldap>>&.
7014 .next
7015 .cindex "MySQL" "lookup type"
7016 .cindex "lookup" "MySQL"
7017 &(mysql)&: The format of the query is an SQL statement that is passed to a
7018 MySQL database. See section &<<SECTsql>>&.
7019 .next
7020 .cindex "NIS+ lookup type"
7021 .cindex "lookup" "NIS+"
7022 &(nisplus)&: This does a NIS+ lookup using a query that can specify the name of
7023 the field to be returned. See section &<<SECTnisplus>>&.
7024 .next
7025 .cindex "Oracle" "lookup type"
7026 .cindex "lookup" "Oracle"
7027 &(oracle)&: The format of the query is an SQL statement that is passed to an
7028 Oracle database. See section &<<SECTsql>>&.
7029 .next
7030 .cindex "lookup" "passwd"
7031 .cindex "passwd lookup type"
7032 .cindex "&_/etc/passwd_&"
7033 &(passwd)& is a query-style lookup with queries that are just user names. The
7034 lookup calls &[getpwnam()]& to interrogate the system password data, and on
7035 success, the result string is the same as you would get from an &(lsearch)&
7036 lookup on a traditional &_/etc/passwd file_&, though with &`*`& for the
7037 password value. For example:
7038 .code
7039 *:42:42:King Rat:/home/kr:/bin/bash
7040 .endd
7041 .next
7042 .cindex "PostgreSQL lookup type"
7043 .cindex "lookup" "PostgreSQL"
7044 &(pgsql)&: The format of the query is an SQL statement that is passed to a
7045 PostgreSQL database. See section &<<SECTsql>>&.
7046
7047 .next
7048 .cindex "Redis lookup type"
7049 .cindex lookup Redis
7050 &(redis)&: The format of the query is either a simple get or simple set,
7051 passed to a Redis database. See section &<<SECTsql>>&.
7052
7053 .next
7054 .cindex "sqlite lookup type"
7055 .cindex "lookup" "sqlite"
7056 &(sqlite)&: The format of the query is
7057 new
7058 an optional filename
7059 .wen
7060 followed by an SQL statement
7061 that is passed to an SQLite database. See section &<<SECTsqlite>>&.
7062
7063 .next
7064 &(testdb)&: This is a lookup type that is used for testing Exim. It is
7065 not likely to be useful in normal operation.
7066 .next
7067 .cindex "whoson lookup type"
7068 .cindex "lookup" "whoson"
7069 . --- still http:-only, 2018-09-07
7070 &(whoson)&: &'Whoson'& (&url(http://whoson.sourceforge.net)) is a protocol that
7071 allows a server to check whether a particular (dynamically allocated) IP
7072 address is currently allocated to a known (trusted) user and, optionally, to
7073 obtain the identity of the said user. For SMTP servers, &'Whoson'& was popular
7074 at one time for &"POP before SMTP"& authentication, but that approach has been
7075 superseded by SMTP authentication. In Exim, &'Whoson'& can be used to implement
7076 &"POP before SMTP"& checking using ACL statements such as
7077 .code
7078 require condition = \
7079   ${lookup whoson {$sender_host_address}{yes}{no}}
7080 .endd
7081 The query consists of a single IP address. The value returned is the name of
7082 the authenticated user, which is stored in the variable &$value$&. However, in
7083 this example, the data in &$value$& is not used; the result of the lookup is
7084 one of the fixed strings &"yes"& or &"no"&.
7085 .endlist
7086
7087
7088
7089 .section "Temporary errors in lookups" "SECID63"
7090 .cindex "lookup" "temporary error in"
7091 Lookup functions can return temporary error codes if the lookup cannot be
7092 completed. For example, an SQL or LDAP database might be unavailable. For this
7093 reason, it is not advisable to use a lookup that might do this for critical
7094 options such as a list of local domains.
7095
7096 When a lookup cannot be completed in a router or transport, delivery
7097 of the message (to the relevant address) is deferred, as for any other
7098 temporary error. In other circumstances Exim may assume the lookup has failed,
7099 or may give up altogether.
7100
7101
7102
7103 .section "Default values in single-key lookups" "SECTdefaultvaluelookups"
7104 .cindex "wildcard lookups"
7105 .cindex "lookup" "default values"
7106 .cindex "lookup" "wildcard"
7107 .cindex "lookup" "* added to type"
7108 .cindex "default" "in single-key lookups"
7109 In this context, a &"default value"& is a value specified by the administrator
7110 that is to be used if a lookup fails.
7111
7112 &*Note:*& This section applies only to single-key lookups. For query-style
7113 lookups, the facilities of the query language must be used. An attempt to
7114 specify a default for a query-style lookup provokes an error.
7115
7116 If &"*"& is added to a single-key lookup type (for example, &%lsearch*%&)
7117 and the initial lookup fails, the key &"*"& is looked up in the file to
7118 provide a default value. See also the section on partial matching below.
7119
7120 .cindex "*@ with single-key lookup"
7121 .cindex "lookup" "*@ added to type"
7122 .cindex "alias file" "per-domain default"
7123 Alternatively, if &"*@"& is added to a single-key lookup type (for example
7124 &%dbm*@%&) then, if the initial lookup fails and the key contains an @
7125 character, a second lookup is done with everything before the last @ replaced
7126 by *. This makes it possible to provide per-domain defaults in alias files
7127 that include the domains in the keys. If the second lookup fails (or doesn't
7128 take place because there is no @ in the key), &"*"& is looked up.
7129 For example, a &(redirect)& router might contain:
7130 .code
7131 data = ${lookup{$local_part@$domain}lsearch*@{/etc/mix-aliases}}
7132 .endd
7133 Suppose the address that is being processed is &'jane@eyre.example'&. Exim
7134 looks up these keys, in this order:
7135 .code
7136 jane@eyre.example
7137 *@eyre.example
7138 *
7139 .endd
7140 The data is taken from whichever key it finds first. &*Note*&: In an
7141 &(lsearch)& file, this does not mean the first of these keys in the file. A
7142 complete scan is done for each key, and only if it is not found at all does
7143 Exim move on to try the next key.
7144
7145
7146
7147 .section "Partial matching in single-key lookups" "SECTpartiallookup"
7148 .cindex "partial matching"
7149 .cindex "wildcard lookups"
7150 .cindex "lookup" "partial matching"
7151 .cindex "lookup" "wildcard"
7152 .cindex "asterisk" "in search type"
7153 The normal operation of a single-key lookup is to search the file for an exact
7154 match with the given key. However, in a number of situations where domains are
7155 being looked up, it is useful to be able to do partial matching. In this case,
7156 information in the file that has a key starting with &"*."& is matched by any
7157 domain that ends with the components that follow the full stop. For example, if
7158 a key in a DBM file is
7159 .code
7160 *.dates.fict.example
7161 .endd
7162 then when partial matching is enabled this is matched by (amongst others)
7163 &'2001.dates.fict.example'& and &'1984.dates.fict.example'&. It is also matched
7164 by &'dates.fict.example'&, if that does not appear as a separate key in the
7165 file.
7166
7167 &*Note*&: Partial matching is not available for query-style lookups. It is
7168 also not available for any lookup items in address lists (see section
7169 &<<SECTaddresslist>>&).
7170
7171 Partial matching is implemented by doing a series of separate lookups using
7172 keys constructed by modifying the original subject key. This means that it can
7173 be used with any of the single-key lookup types, provided that
7174 partial matching keys
7175 beginning with a special prefix (default &"*."&) are included in the data file.
7176 Keys in the file that do not begin with the prefix are matched only by
7177 unmodified subject keys when partial matching is in use.
7178
7179 Partial matching is requested by adding the string &"partial-"& to the front of
7180 the name of a single-key lookup type, for example, &%partial-dbm%&. When this
7181 is done, the subject key is first looked up unmodified; if that fails, &"*."&
7182 is added at the start of the subject key, and it is looked up again. If that
7183 fails, further lookups are tried with dot-separated components removed from the
7184 start of the subject key, one-by-one, and &"*."& added on the front of what
7185 remains.
7186
7187 A minimum number of two non-* components are required. This can be adjusted
7188 by including a number before the hyphen in the search type. For example,
7189 &%partial3-lsearch%& specifies a minimum of three non-* components in the
7190 modified keys. Omitting the number is equivalent to &"partial2-"&. If the
7191 subject key is &'2250.dates.fict.example'& then the following keys are looked
7192 up when the minimum number of non-* components is two:
7193 .code
7194 2250.dates.fict.example
7195 *.2250.dates.fict.example
7196 *.dates.fict.example
7197 *.fict.example
7198 .endd
7199 As soon as one key in the sequence is successfully looked up, the lookup
7200 finishes.
7201
7202 .cindex "lookup" "partial matching &-- changing prefix"
7203 .cindex "prefix" "for partial matching"
7204 The use of &"*."& as the partial matching prefix is a default that can be
7205 changed. The motivation for this feature is to allow Exim to operate with file
7206 formats that are used by other MTAs. A different prefix can be supplied in
7207 parentheses instead of the hyphen after &"partial"&. For example:
7208 .code
7209 domains = partial(.)lsearch;/some/file
7210 .endd
7211 In this example, if the domain is &'a.b.c'&, the sequence of lookups is
7212 &`a.b.c`&, &`.a.b.c`&, and &`.b.c`& (the default minimum of 2 non-wild
7213 components is unchanged). The prefix may consist of any punctuation characters
7214 other than a closing parenthesis. It may be empty, for example:
7215 .code
7216 domains = partial1()cdb;/some/file
7217 .endd
7218 For this example, if the domain is &'a.b.c'&, the sequence of lookups is
7219 &`a.b.c`&, &`b.c`&, and &`c`&.
7220
7221 If &"partial0"& is specified, what happens at the end (when the lookup with
7222 just one non-wild component has failed, and the original key is shortened right
7223 down to the null string) depends on the prefix:
7224
7225 .ilist
7226 If the prefix has zero length, the whole lookup fails.
7227 .next
7228 If the prefix has length 1, a lookup for just the prefix is done. For
7229 example, the final lookup for &"partial0(.)"& is for &`.`& alone.
7230 .next
7231 Otherwise, if the prefix ends in a dot, the dot is removed, and the
7232 remainder is looked up. With the default prefix, therefore, the final lookup is
7233 for &"*"& on its own.
7234 .next
7235 Otherwise, the whole prefix is looked up.
7236 .endlist
7237
7238
7239 If the search type ends in &"*"& or &"*@"& (see section
7240 &<<SECTdefaultvaluelookups>>& above), the search for an ultimate default that
7241 this implies happens after all partial lookups have failed. If &"partial0"& is
7242 specified, adding &"*"& to the search type has no effect with the default
7243 prefix, because the &"*"& key is already included in the sequence of partial
7244 lookups. However, there might be a use for lookup types such as
7245 &"partial0(.)lsearch*"&.
7246
7247 The use of &"*"& in lookup partial matching differs from its use as a wildcard
7248 in domain lists and the like. Partial matching works only in terms of
7249 dot-separated components; a key such as &`*fict.example`&
7250 in a database file is useless, because the asterisk in a partial matching
7251 subject key is always followed by a dot.
7252
7253
7254
7255
7256 .section "Lookup caching" "SECID64"
7257 .cindex "lookup" "caching"
7258 .cindex "caching" "lookup data"
7259 Exim caches all lookup results in order to avoid needless repetition of
7260 lookups. However, because (apart from the daemon) Exim operates as a collection
7261 of independent, short-lived processes, this caching applies only within a
7262 single Exim process. There is no inter-process lookup caching facility.
7263
7264 For single-key lookups, Exim keeps the relevant files open in case there is
7265 another lookup that needs them. In some types of configuration this can lead to
7266 many files being kept open for messages with many recipients. To avoid hitting
7267 the operating system limit on the number of simultaneously open files, Exim
7268 closes the least recently used file when it needs to open more files than its
7269 own internal limit, which can be changed via the &%lookup_open_max%& option.
7270
7271 The single-key lookup files are closed and the lookup caches are flushed at
7272 strategic points during delivery &-- for example, after all routing is
7273 complete.
7274
7275
7276
7277
7278 .section "Quoting lookup data" "SECID65"
7279 .cindex "lookup" "quoting"
7280 .cindex "quoting" "in lookups"
7281 When data from an incoming message is included in a query-style lookup, there
7282 is the possibility of special characters in the data messing up the syntax of
7283 the query. For example, a NIS+ query that contains
7284 .code
7285 [name=$local_part]
7286 .endd
7287 will be broken if the local part happens to contain a closing square bracket.
7288 For NIS+, data can be enclosed in double quotes like this:
7289 .code
7290 [name="$local_part"]
7291 .endd
7292 but this still leaves the problem of a double quote in the data. The rule for
7293 NIS+ is that double quotes must be doubled. Other lookup types have different
7294 rules, and to cope with the differing requirements, an expansion operator
7295 of the following form is provided:
7296 .code
7297 ${quote_<lookup-type>:<string>}
7298 .endd
7299 For example, the safest way to write the NIS+ query is
7300 .code
7301 [name="${quote_nisplus:$local_part}"]
7302 .endd
7303 See chapter &<<CHAPexpand>>& for full coverage of string expansions. The quote
7304 operator can be used for all lookup types, but has no effect for single-key
7305 lookups, since no quoting is ever needed in their key strings.
7306
7307
7308
7309
7310 .section "More about dnsdb" "SECTdnsdb"
7311 .cindex "dnsdb lookup"
7312 .cindex "lookup" "dnsdb"
7313 .cindex "DNS" "as a lookup type"
7314 The &(dnsdb)& lookup type uses the DNS as its database. A simple query consists
7315 of a record type and a domain name, separated by an equals sign. For example,
7316 an expansion string could contain:
7317 .code
7318 ${lookup dnsdb{mx=a.b.example}{$value}fail}
7319 .endd
7320 If the lookup succeeds, the result is placed in &$value$&, which in this case
7321 is used on its own as the result. If the lookup does not succeed, the
7322 &`fail`& keyword causes a &'forced expansion failure'& &-- see section
7323 &<<SECTforexpfai>>& for an explanation of what this means.
7324
7325 The supported DNS record types are A, CNAME, MX, NS, PTR, SOA, SPF, SRV, TLSA
7326 and TXT, and, when Exim is compiled with IPv6 support, AAAA.
7327 If no type is given, TXT is assumed.
7328
7329 For any record type, if multiple records are found, the data is returned as a
7330 concatenation, with newline as the default separator. The order, of course,
7331 depends on the DNS resolver. You can specify a different separator character
7332 between multiple records by putting a right angle-bracket followed immediately
7333 by the new separator at the start of the query. For example:
7334 .code
7335 ${lookup dnsdb{>: a=host1.example}}
7336 .endd
7337 It is permitted to specify a space as the separator character. Further
7338 white space is ignored.
7339 For lookup types that return multiple fields per record,
7340 an alternate field separator can be specified using a comma after the main
7341 separator character, followed immediately by the field separator.
7342
7343 .cindex "PTR record" "in &(dnsdb)& lookup"
7344 When the type is PTR,
7345 the data can be an IP address, written as normal; inversion and the addition of
7346 &%in-addr.arpa%& or &%ip6.arpa%& happens automatically. For example:
7347 .code
7348 ${lookup dnsdb{ptr=192.168.4.5}{$value}fail}
7349 .endd
7350 If the data for a PTR record is not a syntactically valid IP address, it is not
7351 altered and nothing is added.
7352
7353 .cindex "MX record" "in &(dnsdb)& lookup"
7354 .cindex "SRV record" "in &(dnsdb)& lookup"
7355 For an MX lookup, both the preference value and the host name are returned for
7356 each record, separated by a space. For an SRV lookup, the priority, weight,
7357 port, and host name are returned for each record, separated by spaces.
7358 The field separator can be modified as above.
7359
7360 .cindex "TXT record" "in &(dnsdb)& lookup"
7361 .cindex "SPF record" "in &(dnsdb)& lookup"
7362 For TXT records with multiple items of data, only the first item is returned,
7363 unless a field separator is specified.
7364 To concatenate items without a separator, use a semicolon instead.
7365 For SPF records the
7366 default behaviour is to concatenate multiple items without using a separator.
7367 .code
7368 ${lookup dnsdb{>\n,: txt=a.b.example}}
7369 ${lookup dnsdb{>\n; txt=a.b.example}}
7370 ${lookup dnsdb{spf=example.org}}
7371 .endd
7372 It is permitted to specify a space as the separator character. Further
7373 white space is ignored.
7374
7375 .cindex "SOA record" "in &(dnsdb)& lookup"
7376 For an SOA lookup, while no result is obtained the lookup is redone with
7377 successively more leading components dropped from the given domain.
7378 Only the primary-nameserver field is returned unless a field separator is
7379 specified.
7380 .code
7381 ${lookup dnsdb{>:,; soa=a.b.example.com}}
7382 .endd
7383
7384 .section "Dnsdb lookup modifiers" "SECTdnsdb_mod"
7385 .cindex "dnsdb modifiers"
7386 .cindex "modifiers" "dnsdb"
7387 .cindex "options" "dnsdb"
7388 Modifiers for &(dnsdb)& lookups are given by optional keywords,
7389 each followed by a comma,
7390 that may appear before the record type.
7391
7392 The &(dnsdb)& lookup fails only if all the DNS lookups fail. If there is a
7393 temporary DNS error for any of them, the behaviour is controlled by
7394 a defer-option modifier.
7395 The possible keywords are
7396 &"defer_strict"&, &"defer_never"&, and &"defer_lax"&.
7397 With &"strict"& behaviour, any temporary DNS error causes the
7398 whole lookup to defer. With &"never"& behaviour, a temporary DNS error is
7399 ignored, and the behaviour is as if the DNS lookup failed to find anything.
7400 With &"lax"& behaviour, all the queries are attempted, but a temporary DNS
7401 error causes the whole lookup to defer only if none of the other lookups
7402 succeed. The default is &"lax"&, so the following lookups are equivalent:
7403 .code
7404 ${lookup dnsdb{defer_lax,a=one.host.com:two.host.com}}
7405 ${lookup dnsdb{a=one.host.com:two.host.com}}
7406 .endd
7407 Thus, in the default case, as long as at least one of the DNS lookups
7408 yields some data, the lookup succeeds.
7409
7410 .cindex "DNSSEC" "dns lookup"
7411 Use of &(DNSSEC)& is controlled by a dnssec modifier.
7412 The possible keywords are
7413 &"dnssec_strict"&, &"dnssec_lax"&, and &"dnssec_never"&.
7414 With &"strict"& or &"lax"& DNSSEC information is requested
7415 with the lookup.
7416 With &"strict"& a response from the DNS resolver that
7417 is not labelled as authenticated data
7418 is treated as equivalent to a temporary DNS error.
7419 The default is &"lax"&.
7420
7421 See also the &$lookup_dnssec_authenticated$& variable.
7422
7423 .cindex timeout "dns lookup"
7424 .cindex "DNS" timeout
7425 Timeout for the dnsdb lookup can be controlled by a retrans modifier.
7426 The form is &"retrans_VAL"& where VAL is an Exim time specification
7427 (e.g. &"5s"&).
7428 The default value is set by the main configuration option &%dns_retrans%&.
7429
7430 Retries for the dnsdb lookup can be controlled by a retry modifier.
7431 The form if &"retry_VAL"& where VAL is an integer.
7432 The default count is set by the main configuration option &%dns_retry%&.
7433
7434 .cindex caching "of dns lookup"
7435 .cindex TTL "of dns lookup"
7436 .cindex DNS TTL
7437 Dnsdb lookup results are cached within a single process (and its children).
7438 The cache entry lifetime is limited to the smallest time-to-live (TTL)
7439 value of the set of returned DNS records.
7440
7441
7442 .section "Pseudo dnsdb record types" "SECID66"
7443 .cindex "MX record" "in &(dnsdb)& lookup"
7444 By default, both the preference value and the host name are returned for
7445 each MX record, separated by a space. If you want only host names, you can use
7446 the pseudo-type MXH:
7447 .code
7448 ${lookup dnsdb{mxh=a.b.example}}
7449 .endd
7450 In this case, the preference values are omitted, and just the host names are
7451 returned.
7452
7453 .cindex "name server for enclosing domain"
7454 Another pseudo-type is ZNS (for &"zone NS"&). It performs a lookup for NS
7455 records on the given domain, but if none are found, it removes the first
7456 component of the domain name, and tries again. This process continues until NS
7457 records are found or there are no more components left (or there is a DNS
7458 error). In other words, it may return the name servers for a top-level domain,
7459 but it never returns the root name servers. If there are no NS records for the
7460 top-level domain, the lookup fails. Consider these examples:
7461 .code
7462 ${lookup dnsdb{zns=xxx.quercite.com}}
7463 ${lookup dnsdb{zns=xxx.edu}}
7464 .endd
7465 Assuming that in each case there are no NS records for the full domain name,
7466 the first returns the name servers for &%quercite.com%&, and the second returns
7467 the name servers for &%edu%&.
7468
7469 You should be careful about how you use this lookup because, unless the
7470 top-level domain does not exist, the lookup always returns some host names. The
7471 sort of use to which this might be put is for seeing if the name servers for a
7472 given domain are on a blacklist. You can probably assume that the name servers
7473 for the high-level domains such as &%com%& or &%co.uk%& are not going to be on
7474 such a list.
7475
7476 .cindex "CSA" "in &(dnsdb)& lookup"
7477 A third pseudo-type is CSA (Client SMTP Authorization). This looks up SRV
7478 records according to the CSA rules, which are described in section
7479 &<<SECTverifyCSA>>&. Although &(dnsdb)& supports SRV lookups directly, this is
7480 not sufficient because of the extra parent domain search behaviour of CSA. The
7481 result of a successful lookup such as:
7482 .code
7483 ${lookup dnsdb {csa=$sender_helo_name}}
7484 .endd
7485 has two space-separated fields: an authorization code and a target host name.
7486 The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
7487 authorization required but absent, or &"?"& for unknown.
7488
7489 .cindex "A+" "in &(dnsdb)& lookup"
7490 The pseudo-type A+ performs an AAAA
7491 and then an A lookup.  All results are returned; defer processing
7492 (see below) is handled separately for each lookup.  Example:
7493 .code
7494 ${lookup dnsdb {>; a+=$sender_helo_name}}
7495 .endd
7496
7497
7498 .section "Multiple dnsdb lookups" "SECID67"
7499 In the previous sections, &(dnsdb)& lookups for a single domain are described.
7500 However, you can specify a list of domains or IP addresses in a single
7501 &(dnsdb)& lookup. The list is specified in the normal Exim way, with colon as
7502 the default separator, but with the ability to change this. For example:
7503 .code
7504 ${lookup dnsdb{one.domain.com:two.domain.com}}
7505 ${lookup dnsdb{a=one.host.com:two.host.com}}
7506 ${lookup dnsdb{ptr = <; 1.2.3.4 ; 4.5.6.8}}
7507 .endd
7508 In order to retain backwards compatibility, there is one special case: if
7509 the lookup type is PTR and no change of separator is specified, Exim looks
7510 to see if the rest of the string is precisely one IPv6 address. In this
7511 case, it does not treat it as a list.
7512
7513 The data from each lookup is concatenated, with newline separators by default,
7514 in the same way that multiple DNS records for a single item are handled. A
7515 different separator can be specified, as described above.
7516
7517
7518
7519
7520 .section "More about LDAP" "SECTldap"
7521 .cindex "LDAP" "lookup, more about"
7522 .cindex "lookup" "LDAP"
7523 .cindex "Solaris" "LDAP"
7524 The original LDAP implementation came from the University of Michigan; this has
7525 become &"Open LDAP"&, and there are now two different releases. Another
7526 implementation comes from Netscape, and Solaris 7 and subsequent releases
7527 contain inbuilt LDAP support. Unfortunately, though these are all compatible at
7528 the lookup function level, their error handling is different. For this reason
7529 it is necessary to set a compile-time variable when building Exim with LDAP, to
7530 indicate which LDAP library is in use. One of the following should appear in
7531 your &_Local/Makefile_&:
7532 .code
7533 LDAP_LIB_TYPE=UMICHIGAN
7534 LDAP_LIB_TYPE=OPENLDAP1
7535 LDAP_LIB_TYPE=OPENLDAP2
7536 LDAP_LIB_TYPE=NETSCAPE
7537 LDAP_LIB_TYPE=SOLARIS
7538 .endd
7539 If LDAP_LIB_TYPE is not set, Exim assumes &`OPENLDAP1`&, which has the
7540 same interface as the University of Michigan version.
7541
7542 There are three LDAP lookup types in Exim. These behave slightly differently in
7543 the way they handle the results of a query:
7544
7545 .ilist
7546 &(ldap)& requires the result to contain just one entry; if there are more, it
7547 gives an error.
7548 .next
7549 &(ldapdn)& also requires the result to contain just one entry, but it is the
7550 Distinguished Name that is returned rather than any attribute values.
7551 .next
7552 &(ldapm)& permits the result to contain more than one entry; the attributes
7553 from all of them are returned.
7554 .endlist
7555
7556
7557 For &(ldap)& and &(ldapm)&, if a query finds only entries with no attributes,
7558 Exim behaves as if the entry did not exist, and the lookup fails. The format of
7559 the data returned by a successful lookup is described in the next section.
7560 First we explain how LDAP queries are coded.
7561
7562
7563 .section "Format of LDAP queries" "SECTforldaque"
7564 .cindex "LDAP" "query format"
7565 An LDAP query takes the form of a URL as defined in RFC 2255. For example, in
7566 the configuration of a &(redirect)& router one might have this setting:
7567 .code
7568 data = ${lookup ldap \
7569   {ldap:///cn=$local_part,o=University%20of%20Cambridge,\
7570   c=UK?mailbox?base?}}
7571 .endd
7572 .cindex "LDAP" "with TLS"
7573 The URL may begin with &`ldap`& or &`ldaps`& if your LDAP library supports
7574 secure (encrypted) LDAP connections. The second of these ensures that an
7575 encrypted TLS connection is used.
7576
7577 With sufficiently modern LDAP libraries, Exim supports forcing TLS over regular
7578 LDAP connections, rather than the SSL-on-connect &`ldaps`&.
7579 See the &%ldap_start_tls%& option.
7580
7581 Starting with Exim 4.83, the initialization of LDAP with TLS is more tightly
7582 controlled. Every part of the TLS configuration can be configured by settings in
7583 &_exim.conf_&. Depending on the version of the client libraries installed on
7584 your system, some of the initialization may have required setting options in
7585 &_/etc/ldap.conf_& or &_~/.ldaprc_& to get TLS working with self-signed
7586 certificates. This revealed a nuance where the current UID that exim was
7587 running as could affect which config files it read. With Exim 4.83, these
7588 methods become optional, only taking effect if not specifically set in
7589 &_exim.conf_&.
7590
7591
7592 .section "LDAP quoting" "SECID68"
7593 .cindex "LDAP" "quoting"
7594 Two levels of quoting are required in LDAP queries, the first for LDAP itself
7595 and the second because the LDAP query is represented as a URL. Furthermore,
7596 within an LDAP query, two different kinds of quoting are required. For this
7597 reason, there are two different LDAP-specific quoting operators.
7598
7599 The &%quote_ldap%& operator is designed for use on strings that are part of
7600 filter specifications. Conceptually, it first does the following conversions on
7601 the string:
7602 .code
7603 *   =>   \2A
7604 (   =>   \28
7605 )   =>   \29
7606 \   =>   \5C
7607 .endd
7608 in accordance with RFC 2254. The resulting string is then quoted according
7609 to the rules for URLs, that is, all non-alphanumeric characters except
7610 .code
7611 ! $ ' - . _ ( ) * +
7612 .endd
7613 are converted to their hex values, preceded by a percent sign. For example:
7614 .code
7615 ${quote_ldap: a(bc)*, a<yz>; }
7616 .endd
7617 yields
7618 .code
7619 %20a%5C28bc%5C29%5C2A%2C%20a%3Cyz%3E%3B%20
7620 .endd
7621 Removing the URL quoting, this is (with a leading and a trailing space):
7622 .code
7623 a\28bc\29\2A, a<yz>;
7624 .endd
7625 The &%quote_ldap_dn%& operator is designed for use on strings that are part of
7626 base DN specifications in queries. Conceptually, it first converts the string
7627 by inserting a backslash in front of any of the following characters:
7628 .code
7629 , + " \ < > ;
7630 .endd
7631 It also inserts a backslash before any leading spaces or # characters, and
7632 before any trailing spaces. (These rules are in RFC 2253.) The resulting string
7633 is then quoted according to the rules for URLs. For example:
7634 .code
7635 ${quote_ldap_dn: a(bc)*, a<yz>; }
7636 .endd
7637 yields
7638 .code
7639 %5C%20a(bc)*%5C%2C%20a%5C%3Cyz%5C%3E%5C%3B%5C%20
7640 .endd
7641 Removing the URL quoting, this is (with a trailing space):
7642 .code
7643 \ a(bc)*\, a\<yz\>\;\
7644 .endd
7645 There are some further comments about quoting in the section on LDAP
7646 authentication below.
7647
7648
7649 .section "LDAP connections" "SECID69"
7650 .cindex "LDAP" "connections"
7651 The connection to an LDAP server may either be over TCP/IP, or, when OpenLDAP
7652 is in use, via a Unix domain socket. The example given above does not specify
7653 an LDAP server. A server that is reached by TCP/IP can be specified in a query
7654 by starting it with
7655 .code
7656 ldap://<hostname>:<port>/...
7657 .endd
7658 If the port (and preceding colon) are omitted, the standard LDAP port (389) is
7659 used. When no server is specified in a query, a list of default servers is
7660 taken from the &%ldap_default_servers%& configuration option. This supplies a
7661 colon-separated list of servers which are tried in turn until one successfully
7662 handles a query, or there is a serious error. Successful handling either
7663 returns the requested data, or indicates that it does not exist. Serious errors
7664 are syntactical, or multiple values when only a single value is expected.
7665 Errors which cause the next server to be tried are connection failures, bind
7666 failures, and timeouts.
7667
7668 For each server name in the list, a port number can be given. The standard way
7669 of specifying a host and port is to use a colon separator (RFC 1738). Because
7670 &%ldap_default_servers%& is a colon-separated list, such colons have to be
7671 doubled. For example
7672 .code
7673 ldap_default_servers = ldap1.example.com::145:ldap2.example.com
7674 .endd
7675 If &%ldap_default_servers%& is unset, a URL with no server name is passed
7676 to the LDAP library with no server name, and the library's default (normally
7677 the local host) is used.
7678
7679 If you are using the OpenLDAP library, you can connect to an LDAP server using
7680 a Unix domain socket instead of a TCP/IP connection. This is specified by using
7681 &`ldapi`& instead of &`ldap`& in LDAP queries. What follows here applies only
7682 to OpenLDAP. If Exim is compiled with a different LDAP library, this feature is
7683 not available.
7684
7685 For this type of connection, instead of a host name for the server, a pathname
7686 for the socket is required, and the port number is not relevant. The pathname
7687 can be specified either as an item in &%ldap_default_servers%&, or inline in
7688 the query. In the former case, you can have settings such as
7689 .code
7690 ldap_default_servers = /tmp/ldap.sock : backup.ldap.your.domain
7691 .endd
7692 When the pathname is given in the query, you have to escape the slashes as
7693 &`%2F`& to fit in with the LDAP URL syntax. For example:
7694 .code
7695 ${lookup ldap {ldapi://%2Ftmp%2Fldap.sock/o=...
7696 .endd
7697 When Exim processes an LDAP lookup and finds that the &"hostname"& is really
7698 a pathname, it uses the Unix domain socket code, even if the query actually
7699 specifies &`ldap`& or &`ldaps`&. In particular, no encryption is used for a
7700 socket connection. This behaviour means that you can use a setting of
7701 &%ldap_default_servers%& such as in the example above with traditional &`ldap`&
7702 or &`ldaps`& queries, and it will work. First, Exim tries a connection via
7703 the Unix domain socket; if that fails, it tries a TCP/IP connection to the
7704 backup host.
7705
7706 If an explicit &`ldapi`& type is given in a query when a host name is
7707 specified, an error is diagnosed. However, if there are more items in
7708 &%ldap_default_servers%&, they are tried. In other words:
7709
7710 .ilist
7711 Using a pathname with &`ldap`& or &`ldaps`& forces the use of the Unix domain
7712 interface.
7713 .next
7714 Using &`ldapi`& with a host name causes an error.
7715 .endlist
7716
7717
7718 Using &`ldapi`& with no host or path in the query, and no setting of
7719 &%ldap_default_servers%&, does whatever the library does by default.
7720
7721
7722
7723 .section "LDAP authentication and control information" "SECID70"
7724 .cindex "LDAP" "authentication"
7725 The LDAP URL syntax provides no way of passing authentication and other control
7726 information to the server. To make this possible, the URL in an LDAP query may
7727 be preceded by any number of <&'name'&>=<&'value'&> settings, separated by
7728 spaces. If a value contains spaces it must be enclosed in double quotes, and
7729 when double quotes are used, backslash is interpreted in the usual way inside
7730 them. The following names are recognized:
7731 .display
7732 &`DEREFERENCE`&  set the dereferencing parameter
7733 &`NETTIME    `&  set a timeout for a network operation
7734 &`USER       `&  set the DN, for authenticating the LDAP bind
7735 &`PASS       `&  set the password, likewise
7736 &`REFERRALS  `&  set the referrals parameter
7737 &`SERVERS    `&  set alternate server list for this query only
7738 &`SIZE       `&  set the limit for the number of entries returned
7739 &`TIME       `&  set the maximum waiting time for a query
7740 .endd
7741 The value of the DEREFERENCE parameter must be one of the words &"never"&,
7742 &"searching"&, &"finding"&, or &"always"&. The value of the REFERRALS parameter
7743 must be &"follow"& (the default) or &"nofollow"&. The latter stops the LDAP
7744 library from trying to follow referrals issued by the LDAP server.
7745
7746 .cindex LDAP timeout
7747 .cindex timeout "LDAP lookup"
7748 The name CONNECT is an obsolete name for NETTIME, retained for
7749 backwards compatibility. This timeout (specified as a number of seconds) is
7750 enforced from the client end for operations that can be carried out over a
7751 network. Specifically, it applies to network connections and calls to the
7752 &'ldap_result()'& function. If the value is greater than zero, it is used if
7753 LDAP_OPT_NETWORK_TIMEOUT is defined in the LDAP headers (OpenLDAP), or
7754 if LDAP_X_OPT_CONNECT_TIMEOUT is defined in the LDAP headers (Netscape
7755 SDK 4.1). A value of zero forces an explicit setting of &"no timeout"& for
7756 Netscape SDK; for OpenLDAP no action is taken.
7757
7758 The TIME parameter (also a number of seconds) is passed to the server to
7759 set a server-side limit on the time taken to complete a search.
7760
7761 The SERVERS parameter allows you to specify an alternate list of ldap servers
7762 to use for an individual lookup.  The global &%ldap_default_servers%& option provides a
7763 default list of ldap servers, and a single lookup can specify a single ldap
7764 server to use.  But when you need to do a lookup with a list of servers that is
7765 different than the default list (maybe different order, maybe a completely
7766 different set of servers), the SERVERS parameter allows you to specify this
7767 alternate list (colon-separated).
7768
7769 Here is an example of an LDAP query in an Exim lookup that uses some of these
7770 values. This is a single line, folded to fit on the page:
7771 .code
7772 ${lookup ldap
7773   {user="cn=manager,o=University of Cambridge,c=UK" pass=secret
7774   ldap:///o=University%20of%20Cambridge,c=UK?sn?sub?(cn=foo)}
7775   {$value}fail}
7776 .endd
7777 The encoding of spaces as &`%20`& is a URL thing which should not be done for
7778 any of the auxiliary data. Exim configuration settings that include lookups
7779 which contain password information should be preceded by &"hide"& to prevent
7780 non-admin users from using the &%-bP%& option to see their values.
7781
7782 The auxiliary data items may be given in any order. The default is no
7783 connection timeout (the system timeout is used), no user or password, no limit
7784 on the number of entries returned, and no time limit on queries.
7785
7786 When a DN is quoted in the USER= setting for LDAP authentication, Exim
7787 removes any URL quoting that it may contain before passing it LDAP. Apparently
7788 some libraries do this for themselves, but some do not. Removing the URL
7789 quoting has two advantages:
7790
7791 .ilist
7792 It makes it possible to use the same &%quote_ldap_dn%& expansion for USER=
7793 DNs as with DNs inside actual queries.
7794 .next
7795 It permits spaces inside USER= DNs.
7796 .endlist
7797
7798 For example, a setting such as
7799 .code
7800 USER=cn=${quote_ldap_dn:$1}
7801 .endd
7802 should work even if &$1$& contains spaces.
7803
7804 Expanded data for the PASS= value should be quoted using the &%quote%&
7805 expansion operator, rather than the LDAP quote operators. The only reason this
7806 field needs quoting is to ensure that it conforms to the Exim syntax, which
7807 does not allow unquoted spaces. For example:
7808 .code
7809 PASS=${quote:$3}
7810 .endd
7811 The LDAP authentication mechanism can be used to check passwords as part of
7812 SMTP authentication. See the &%ldapauth%& expansion string condition in chapter
7813 &<<CHAPexpand>>&.
7814
7815
7816
7817 .section "Format of data returned by LDAP" "SECID71"
7818 .cindex "LDAP" "returned data formats"
7819 The &(ldapdn)& lookup type returns the Distinguished Name from a single entry
7820 as a sequence of values, for example
7821 .code
7822 cn=manager,o=University of Cambridge,c=UK
7823 .endd
7824 The &(ldap)& lookup type generates an error if more than one entry matches the
7825 search filter, whereas &(ldapm)& permits this case, and inserts a newline in
7826 the result between the data from different entries. It is possible for multiple
7827 values to be returned for both &(ldap)& and &(ldapm)&, but in the former case
7828 you know that whatever values are returned all came from a single entry in the
7829 directory.
7830
7831 In the common case where you specify a single attribute in your LDAP query, the
7832 result is not quoted, and does not contain the attribute name. If the attribute
7833 has multiple values, they are separated by commas. Any comma that is
7834 part of an attribute's value is doubled.
7835
7836 If you specify multiple attributes, the result contains space-separated, quoted
7837 strings, each preceded by the attribute name and an equals sign. Within the
7838 quotes, the quote character, backslash, and newline are escaped with
7839 backslashes, and commas are used to separate multiple values for the attribute.
7840 Any commas in attribute values are doubled
7841 (permitting treatment of the values as a comma-separated list).
7842 Apart from the escaping, the string within quotes takes the same form as the
7843 output when a single attribute is requested. Specifying no attributes is the
7844 same as specifying all of an entry's attributes.
7845
7846 Here are some examples of the output format. The first line of each pair is an
7847 LDAP query, and the second is the data that is returned. The attribute called
7848 &%attr1%& has two values, one of them with an embedded comma, whereas
7849 &%attr2%& has only one value. Both attributes are derived from &%attr%&
7850 (they have SUP &%attr%& in their schema definitions).
7851
7852 .code
7853 ldap:///o=base?attr1?sub?(uid=fred)
7854 value1.1,value1,,2
7855
7856 ldap:///o=base?attr2?sub?(uid=fred)
7857 value two
7858
7859 ldap:///o=base?attr?sub?(uid=fred)
7860 value1.1,value1,,2,value two
7861
7862 ldap:///o=base?attr1,attr2?sub?(uid=fred)
7863 attr1="value1.1,value1,,2" attr2="value two"
7864
7865 ldap:///o=base??sub?(uid=fred)
7866 objectClass="top" attr1="value1.1,value1,,2" attr2="value two"
7867 .endd
7868 You can
7869 make use of Exim's &%-be%& option to run expansion tests and thereby check the
7870 results of LDAP lookups.
7871 The &%extract%& operator in string expansions can be used to pick out
7872 individual fields from data that consists of &'key'&=&'value'& pairs.
7873 The &%listextract%& operator should be used to pick out individual values
7874 of attributes, even when only a single value is expected.
7875 The doubling of embedded commas allows you to use the returned data as a
7876 comma separated list (using the "<," syntax for changing the input list separator).
7877
7878
7879
7880
7881 .section "More about NIS+" "SECTnisplus"
7882 .cindex "NIS+ lookup type"
7883 .cindex "lookup" "NIS+"
7884 NIS+ queries consist of a NIS+ &'indexed name'& followed by an optional colon
7885 and field name. If this is given, the result of a successful query is the
7886 contents of the named field; otherwise the result consists of a concatenation
7887 of &'field-name=field-value'& pairs, separated by spaces. Empty values and
7888 values containing spaces are quoted. For example, the query
7889 .code
7890 [name=mg1456],passwd.org_dir
7891 .endd
7892 might return the string
7893 .code
7894 name=mg1456 passwd="" uid=999 gid=999 gcos="Martin Guerre"
7895 home=/home/mg1456 shell=/bin/bash shadow=""
7896 .endd
7897 (split over two lines here to fit on the page), whereas
7898 .code
7899 [name=mg1456],passwd.org_dir:gcos
7900 .endd
7901 would just return
7902 .code
7903 Martin Guerre
7904 .endd
7905 with no quotes. A NIS+ lookup fails if NIS+ returns more than one table entry
7906 for the given indexed key. The effect of the &%quote_nisplus%& expansion
7907 operator is to double any quote characters within the text.
7908
7909
7910
7911 .section "SQL lookups" "SECTsql"
7912 .cindex "SQL lookup types"
7913 .cindex "MySQL" "lookup type"
7914 .cindex "PostgreSQL lookup type"
7915 .cindex "lookup" "MySQL"
7916 .cindex "lookup" "PostgreSQL"
7917 .cindex "Oracle" "lookup type"
7918 .cindex "lookup" "Oracle"
7919 .cindex "InterBase lookup type"
7920 .cindex "lookup" "InterBase"
7921 .cindex "Redis lookup type"
7922 .cindex lookup Redis
7923 Exim can support lookups in InterBase, MySQL, Oracle, PostgreSQL, Redis,
7924 and SQLite
7925 databases. Queries for these databases contain SQL statements, so an example
7926 might be
7927 .code
7928 ${lookup mysql{select mailbox from users where id='userx'}\
7929   {$value}fail}
7930 .endd
7931 If the result of the query contains more than one field, the data for each
7932 field in the row is returned, preceded by its name, so the result of
7933 .code
7934 ${lookup pgsql{select home,name from users where id='userx'}\
7935   {$value}}
7936 .endd
7937 might be
7938 .code
7939 home=/home/userx name="Mister X"
7940 .endd
7941 Empty values and values containing spaces are double quoted, with embedded
7942 quotes escaped by a backslash. If the result of the query contains just one
7943 field, the value is passed back verbatim, without a field name, for example:
7944 .code
7945 Mister X
7946 .endd
7947 If the result of the query yields more than one row, it is all concatenated,
7948 with a newline between the data for each row.
7949
7950
7951 .section "More about MySQL, PostgreSQL, Oracle, InterBase, and Redis" "SECID72"
7952 .cindex "MySQL" "lookup type"
7953 .cindex "PostgreSQL lookup type"
7954 .cindex "lookup" "MySQL"
7955 .cindex "lookup" "PostgreSQL"
7956 .cindex "Oracle" "lookup type"
7957 .cindex "lookup" "Oracle"
7958 .cindex "InterBase lookup type"
7959 .cindex "lookup" "InterBase"
7960 .cindex "Redis lookup type"
7961 .cindex lookup Redis
7962 If any MySQL, PostgreSQL, Oracle, InterBase or Redis lookups are used, the
7963 &%mysql_servers%&, &%pgsql_servers%&, &%oracle_servers%&, &%ibase_servers%&,
7964 or &%redis_servers%&
7965 option (as appropriate) must be set to a colon-separated list of server
7966 information.
7967 .oindex &%mysql_servers%&
7968 .oindex &%pgsql_servers%&
7969 .oindex &%oracle_servers%&
7970 .oindex &%ibase_servers%&
7971 .oindex &%redis_servers%&
7972 (For MySQL and PostgreSQL, the global option need not be set if all
7973 queries contain their own server information &-- see section
7974 &<<SECTspeserque>>&.)
7975 For all but Redis
7976 each item in the list is a slash-separated list of four
7977 items: host name, database name, user name, and password. In the case of
7978 Oracle, the host name field is used for the &"service name"&, and the database
7979 name field is not used and should be empty. For example:
7980 .code
7981 hide oracle_servers = oracle.plc.example//userx/abcdwxyz
7982 .endd
7983 Because password data is sensitive, you should always precede the setting with
7984 &"hide"&, to prevent non-admin users from obtaining the setting via the &%-bP%&
7985 option. Here is an example where two MySQL servers are listed:
7986 .code
7987 hide mysql_servers = localhost/users/root/secret:\
7988                      otherhost/users/root/othersecret
7989 .endd
7990 For MySQL and PostgreSQL, a host may be specified as <&'name'&>:<&'port'&> but
7991 because this is a colon-separated list, the colon has to be doubled. For each
7992 query, these parameter groups are tried in order until a connection is made and
7993 a query is successfully processed. The result of a query may be that no data is
7994 found, but that is still a successful query. In other words, the list of
7995 servers provides a backup facility, not a list of different places to look.
7996
7997 For Redis the global option need not be specified if all queries contain their
7998 own server information &-- see section &<<SECTspeserque>>&.
7999 If specified, the option must be set to a colon-separated list of server
8000 information.
8001 Each item in the list is a slash-separated list of three items:
8002 host, database number, and password.
8003 .olist
8004 The host is required and may be either an IPv4 address and optional
8005 port number (separated by a colon, which needs doubling due to the
8006 higher-level list), or a Unix socket pathname enclosed in parentheses
8007 .next
8008 The database number is optional; if present that number is selected in the backend
8009 .next
8010 The password is optional; if present it is used to authenticate to the backend
8011 .endlist
8012
8013 The &%quote_mysql%&, &%quote_pgsql%&, and &%quote_oracle%& expansion operators
8014 convert newline, tab, carriage return, and backspace to \n, \t, \r, and \b
8015 respectively, and the characters single-quote, double-quote, and backslash
8016 itself are escaped with backslashes.
8017
8018 The &%quote_redis%& expansion operator
8019 escapes whitespace and backslash characters with a backslash.
8020
8021 .section "Specifying the server in the query" "SECTspeserque"
8022 .new
8023 For MySQL, PostgreSQL and Redis lookups (but not currently for Oracle and InterBase),
8024 it is possible to specify a list of servers with an individual query. This is
8025 done by appending a comma-separated option to the query type:
8026 .display
8027 .endd
8028 &`,servers=`&&'server1:server2:server3:...'&
8029 .wen
8030 Each item in the list may take one of two forms:
8031 .olist
8032 If it contains no slashes it is assumed to be just a host name. The appropriate
8033 global option (&%mysql_servers%& or &%pgsql_servers%&) is searched for a host
8034 of the same name, and the remaining parameters (database, user, password) are
8035 taken from there.
8036 .next
8037 If it contains any slashes, it is taken as a complete parameter set.
8038 .endlist
8039 The list of servers is used in exactly the same way as the global list.
8040 Once a connection to a server has happened and a query has been
8041 successfully executed, processing of the lookup ceases.
8042
8043 This feature is intended for use in master/slave situations where updates
8044 are occurring and you want to update the master rather than a slave. If the
8045 master is in the list as a backup for reading, you might have a global setting
8046 like this:
8047 .code
8048 mysql_servers = slave1/db/name/pw:\
8049                 slave2/db/name/pw:\
8050                 master/db/name/pw
8051 .endd
8052 In an updating lookup, you could then write:
8053 .code
8054 ${lookup mysql,servers=master {UPDATE ...} }
8055 .endd
8056 That query would then be sent only to the master server. If, on the other hand,
8057 the master is not to be used for reading, and so is not present in the global
8058 option, you can still update it by a query of this form:
8059 .code
8060 ${lookup pgsql,servers=master/db/name/pw {UPDATE ...} }
8061 .endd
8062
8063 .new
8064 An older syntax places the servers speciification before the qury,
8065 semicolon separated:
8066 .code
8067 ${lookup mysql{servers=master; UPDATE ...} }
8068 .endd
8069 The new version avoids potential issues with tainted
8070 arguments in the query, for explicit expansion.
8071 &*Note*&: server specifications in list-style lookups are still problematic.
8072 .wen
8073
8074
8075 .section "Special MySQL features" "SECID73"
8076 For MySQL, an empty host name or the use of &"localhost"& in &%mysql_servers%&
8077 causes a connection to the server on the local host by means of a Unix domain
8078 socket. An alternate socket can be specified in parentheses.
8079 An option group name for MySQL option files can be specified in square brackets;
8080 the default value is &"exim"&.
8081 The full syntax of each item in &%mysql_servers%& is:
8082 .display
8083 <&'hostname'&>::<&'port'&>(<&'socket name'&>)[<&'option group'&>]/&&&
8084   <&'database'&>/<&'user'&>/<&'password'&>
8085 .endd
8086 Any of the four sub-parts of the first field can be omitted. For normal use on
8087 the local host it can be left blank or set to just &"localhost"&.
8088
8089 No database need be supplied &-- but if it is absent here, it must be given in
8090 the queries.
8091
8092 If a MySQL query is issued that does not request any data (an insert, update,
8093 or delete command), the result of the lookup is the number of rows affected.
8094
8095 &*Warning*&: This can be misleading. If an update does not actually change
8096 anything (for example, setting a field to the value it already has), the result
8097 is zero because no rows are affected.
8098
8099
8100 .section "Special PostgreSQL features" "SECID74"
8101 PostgreSQL lookups can also use Unix domain socket connections to the database.
8102 This is usually faster and costs less CPU time than a TCP/IP connection.
8103 However it can be used only if the mail server runs on the same machine as the
8104 database server. A configuration line for PostgreSQL via Unix domain sockets
8105 looks like this:
8106 .code
8107 hide pgsql_servers = (/tmp/.s.PGSQL.5432)/db/user/password : ...
8108 .endd
8109 In other words, instead of supplying a host name, a path to the socket is
8110 given. The path name is enclosed in parentheses so that its slashes aren't
8111 visually confused with the delimiters for the other server parameters.
8112
8113 If a PostgreSQL query is issued that does not request any data (an insert,
8114 update, or delete command), the result of the lookup is the number of rows
8115 affected.
8116
8117 .section "More about SQLite" "SECTsqlite"
8118 .cindex "lookup" "SQLite"
8119 .cindex "sqlite lookup type"
8120 SQLite is different to the other SQL lookups because a filename is required in
8121 addition to the SQL query. An SQLite database is a single file, and there is no
8122 daemon as in the other SQL databases.
8123
8124 .new
8125 .oindex &%sqlite_dbfile%&
8126 The preferred way of specifying the file is by using the
8127 &%sqlite_dbfile%& option, set to
8128 an absolute path.
8129 .wen
8130 A deprecated method is available, prefixing the query with the filename
8131 separated by white space.
8132 This means that the path name cannot contain white space.
8133 .cindex "tainted data" "sqlite file"
8134 It also means that the query cannot use any tainted values, as that taints
8135 the entire query including the filename - resulting in a refusal to open
8136 the file.
8137
8138 .new
8139 Here is a lookup expansion example:
8140 .code
8141 sqlite_dbfile = /some/thing/sqlitedb
8142 ...
8143 ${lookup sqlite {select name from aliases where id='userx';}}
8144 .endd
8145 In a list, the syntax is similar. For example:
8146 .code
8147 domainlist relay_to_domains = sqlite;\
8148    select * from relays where ip='$sender_host_address';
8149 .endd
8150 .wen
8151 The only character affected by the &%quote_sqlite%& operator is a single
8152 quote, which it doubles.
8153
8154 .cindex timeout SQLite
8155 .cindex sqlite "lookup timeout"
8156 The SQLite library handles multiple simultaneous accesses to the database
8157 internally. Multiple readers are permitted, but only one process can
8158 update at once. Attempts to access the database while it is being updated
8159 are rejected after a timeout period, during which the SQLite library
8160 waits for the lock to be released. In Exim, the default timeout is set
8161 to 5 seconds, but it can be changed by means of the &%sqlite_lock_timeout%&
8162 option.
8163
8164 .section "More about Redis" "SECTredis"
8165 .cindex "lookup" "Redis"
8166 .cindex "redis lookup type"
8167 Redis is a non-SQL database. Commands are simple get and set.
8168 Examples:
8169 .code
8170 ${lookup redis{set keyname ${quote_redis:objvalue plus}}}
8171 ${lookup redis{get keyname}}
8172 .endd
8173
8174 As of release 4.91, "lightweight" support for Redis Cluster is available.
8175 Requires &%redis_servers%& list to contain all the servers in the cluster, all
8176 of which must be reachable from the running exim instance. If the cluster has
8177 master/slave replication, the list must contain all the master and slave
8178 servers.
8179
8180 When the Redis Cluster returns a "MOVED" response to a query, Exim does not
8181 immediately follow the redirection but treats the response as a DEFER, moving on
8182 to the next server in the &%redis_servers%& list until the correct server is
8183 reached.
8184
8185 .ecindex IIDfidalo1
8186 .ecindex IIDfidalo2
8187
8188
8189 . ////////////////////////////////////////////////////////////////////////////
8190 . ////////////////////////////////////////////////////////////////////////////
8191
8192 .chapter "Domain, host, address, and local part lists" &&&
8193          "CHAPdomhosaddlists" &&&
8194          "Domain, host, and address lists"
8195 .scindex IIDdohoadli "lists of domains; hosts; etc."
8196 A number of Exim configuration options contain lists of domains, hosts,
8197 email addresses, or local parts. For example, the &%hold_domains%& option
8198 contains a list of domains whose delivery is currently suspended. These lists
8199 are also used as data in ACL statements (see chapter &<<CHAPACL>>&), and as
8200 arguments to expansion conditions such as &%match_domain%&.
8201
8202 Each item in one of these lists is a pattern to be matched against a domain,
8203 host, email address, or local part, respectively. In the sections below, the
8204 different types of pattern for each case are described, but first we cover some
8205 general facilities that apply to all four kinds of list.
8206
8207 Note that other parts of Exim use a &'string list'& which does not
8208 support all the complexity available in
8209 domain, host, address and local part lists.
8210
8211
8212
8213 .section "Expansion of lists" "SECTlistexpand"
8214 .cindex "expansion" "of lists"
8215 Each list is expanded as a single string before it is used.
8216
8217 &'Exception: the router headers_remove option, where list-item
8218 splitting is done before string-expansion.'&
8219
8220 The result of
8221 expansion must be a list, possibly containing empty items, which is split up
8222 into separate items for matching. By default, colon is the separator character,
8223 but this can be varied if necessary. See sections &<<SECTlistconstruct>>& and
8224 &<<SECTempitelis>>& for details of the list syntax; the second of these
8225 discusses the way to specify empty list items.
8226
8227
8228 If the string expansion is forced to fail, Exim behaves as if the item it is
8229 testing (domain, host, address, or local part) is not in the list. Other
8230 expansion failures cause temporary errors.
8231
8232 If an item in a list is a regular expression, backslashes, dollars and possibly
8233 other special characters in the expression must be protected against
8234 misinterpretation by the string expander. The easiest way to do this is to use
8235 the &`\N`& expansion feature to indicate that the contents of the regular
8236 expression should not be expanded. For example, in an ACL you might have:
8237 .code
8238 deny senders = \N^\d{8}\w@.*\.baddomain\.example$\N : \
8239                ${lookup{$domain}lsearch{/badsenders/bydomain}}
8240 .endd
8241 The first item is a regular expression that is protected from expansion by
8242 &`\N`&, whereas the second uses the expansion to obtain a list of unwanted
8243 senders based on the receiving domain.
8244
8245
8246
8247
8248 .section "Negated items in lists" "SECID76"
8249 .cindex "list" "negation"
8250 .cindex "negation" "in lists"
8251 Items in a list may be positive or negative. Negative items are indicated by a
8252 leading exclamation mark, which may be followed by optional white space. A list
8253 defines a set of items (domains, etc). When Exim processes one of these lists,
8254 it is trying to find out whether a domain, host, address, or local part
8255 (respectively) is in the set that is defined by the list. It works like this:
8256
8257 The list is scanned from left to right. If a positive item is matched, the
8258 subject that is being checked is in the set; if a negative item is matched, the
8259 subject is not in the set. If the end of the list is reached without the
8260 subject having matched any of the patterns, it is in the set if the last item
8261 was a negative one, but not if it was a positive one. For example, the list in
8262 .code
8263 domainlist relay_to_domains = !a.b.c : *.b.c
8264 .endd
8265 matches any domain ending in &'.b.c'& except for &'a.b.c'&. Domains that match
8266 neither &'a.b.c'& nor &'*.b.c'& do not match, because the last item in the
8267 list is positive. However, if the setting were
8268 .code
8269 domainlist relay_to_domains = !a.b.c
8270 .endd
8271 then all domains other than &'a.b.c'& would match because the last item in the
8272 list is negative. In other words, a list that ends with a negative item behaves
8273 as if it had an extra item &`:*`& on the end.
8274
8275 Another way of thinking about positive and negative items in lists is to read
8276 the connector as &"or"& after a positive item and as &"and"& after a negative
8277 item.
8278
8279
8280
8281 .section "File names in lists" "SECTfilnamlis"
8282 .cindex "list" "filename in"
8283 If an item in a domain, host, address, or local part list is an absolute
8284 filename (beginning with a slash character), each line of the file is read and
8285 processed as if it were an independent item in the list, except that further
8286 filenames are not allowed,
8287 and no expansion of the data from the file takes place.
8288 Empty lines in the file are ignored, and the file may also contain comment
8289 lines:
8290
8291 .ilist
8292 For domain and host lists, if a # character appears anywhere in a line of the
8293 file, it and all following characters are ignored.
8294 .next
8295 Because local parts may legitimately contain # characters, a comment in an
8296 address list or local part list file is recognized only if # is preceded by
8297 white space or the start of the line. For example:
8298 .code
8299 not#comment@x.y.z   # but this is a comment
8300 .endd
8301 .endlist
8302
8303 Putting a filename in a list has the same effect as inserting each line of the
8304 file as an item in the list (blank lines and comments excepted). However, there
8305 is one important difference: the file is read each time the list is processed,
8306 so if its contents vary over time, Exim's behaviour changes.
8307
8308 If a filename is preceded by an exclamation mark, the sense of any match
8309 within the file is inverted. For example, if
8310 .code
8311 hold_domains = !/etc/nohold-domains
8312 .endd
8313 and the file contains the lines
8314 .code
8315 !a.b.c
8316 *.b.c
8317 .endd
8318 then &'a.b.c'& is in the set of domains defined by &%hold_domains%&, whereas
8319 any domain matching &`*.b.c`& is not.
8320
8321
8322
8323 .section "An lsearch file is not an out-of-line list" "SECID77"
8324 As will be described in the sections that follow, lookups can be used in lists
8325 to provide indexed methods of checking list membership. There has been some
8326 confusion about the way &(lsearch)& lookups work in lists. Because
8327 an &(lsearch)& file contains plain text and is scanned sequentially, it is
8328 sometimes thought that it is allowed to contain wild cards and other kinds of
8329 non-constant pattern. This is not the case. The keys in an &(lsearch)& file are
8330 always fixed strings, just as for any other single-key lookup type.
8331
8332 If you want to use a file to contain wild-card patterns that form part of a
8333 list, just give the filename on its own, without a search type, as described
8334 in the previous section. You could also use the &(wildlsearch)& or
8335 &(nwildlsearch)&, but there is no advantage in doing this.
8336
8337
8338
8339
8340 .new
8341 .section "Results of list checking" SECTlistresults
8342 The primary result of doing a list check is a truth value.
8343 In some contexts additional information is stored
8344 about the list element that matched:
8345 .vlist
8346 .vitem hosts
8347 A &%hosts%& ACL condition
8348 will store a result in the &$host_data$& variable.
8349 .vitem local_parts
8350 A &%local_parts%& router option or &%local_parts%& ACL condition
8351 will store a result in the &$local_part_data$& variable.
8352 .vitem domains
8353 A &%domains%& router option or &%domains%& ACL condition
8354 .vitem senders
8355 A &%senders%& router option or &%senders%& ACL condition
8356 will store a result in the &$sender_data$& variable.
8357 .vitem recipients
8358 A &%recipients%& ACL condition
8359 will store a result in the &$recipient_data$& variable.
8360 .endlist
8361
8362 The detail of the additional information depends on the
8363 type of match and is given below as the &*value*& information.
8364 .wen
8365
8366
8367
8368
8369 .section "Named lists" "SECTnamedlists"
8370 .cindex "named lists"
8371 .cindex "list" "named"
8372 A list of domains, hosts, email addresses, or local parts can be given a name
8373 which is then used to refer to the list elsewhere in the configuration. This is
8374 particularly convenient if the same list is required in several different
8375 places. It also allows lists to be given meaningful names, which can improve
8376 the readability of the configuration. For example, it is conventional to define
8377 a domain list called &'local_domains'& for all the domains that are handled
8378 locally on a host, using a configuration line such as
8379 .code
8380 domainlist local_domains = localhost:my.dom.example
8381 .endd
8382 Named lists are referenced by giving their name preceded by a plus sign, so,
8383 for example, a router that is intended to handle local domains would be
8384 configured with the line
8385 .code
8386 domains = +local_domains
8387 .endd
8388 The first router in a configuration is often one that handles all domains
8389 except the local ones, using a configuration with a negated item like this:
8390 .code
8391 dnslookup:
8392   driver = dnslookup
8393   domains = ! +local_domains
8394   transport = remote_smtp
8395   no_more
8396 .endd
8397 The four kinds of named list are created by configuration lines starting with
8398 the words &%domainlist%&, &%hostlist%&, &%addresslist%&, or &%localpartlist%&,
8399 respectively. Then there follows the name that you are defining, followed by an
8400 equals sign and the list itself. For example:
8401 .code
8402 hostlist    relay_from_hosts = 192.168.23.0/24 : my.friend.example
8403 addresslist bad_senders = cdb;/etc/badsenders
8404 .endd
8405 A named list may refer to other named lists:
8406 .code
8407 domainlist  dom1 = first.example : second.example
8408 domainlist  dom2 = +dom1 : third.example
8409 domainlist  dom3 = fourth.example : +dom2 : fifth.example
8410 .endd
8411 &*Warning*&: If the last item in a referenced list is a negative one, the
8412 effect may not be what you intended, because the negation does not propagate
8413 out to the higher level. For example, consider:
8414 .code
8415 domainlist  dom1 = !a.b
8416 domainlist  dom2 = +dom1 : *.b
8417 .endd
8418 The second list specifies &"either in the &%dom1%& list or &'*.b'&"&. The first
8419 list specifies just &"not &'a.b'&"&, so the domain &'x.y'& matches it. That
8420 means it matches the second list as well. The effect is not the same as
8421 .code
8422 domainlist  dom2 = !a.b : *.b
8423 .endd
8424 where &'x.y'& does not match. It's best to avoid negation altogether in
8425 referenced lists if you can.
8426
8427 .new
8428 .cindex "hiding named list values"
8429 .cindex "named lists" "hiding value of"
8430 Some named list definitions may contain sensitive data, for example, passwords for
8431 accessing databases. To stop non-admin users from using the &%-bP%& command
8432 line option to read these values, you can precede the definition with the
8433 word &"hide"&. For example:
8434 .code
8435 hide domainlist filter_for_domains = ldap;PASS=secret ldap::/// ...
8436 .endd
8437 .wen
8438
8439
8440 Named lists may have a performance advantage. When Exim is routing an
8441 address or checking an incoming message, it caches the result of tests on named
8442 lists. So, if you have a setting such as
8443 .code
8444 domains = +local_domains
8445 .endd
8446 on several of your routers
8447 or in several ACL statements,
8448 the actual test is done only for the first one. However, the caching works only
8449 if there are no expansions within the list itself or any sublists that it
8450 references. In other words, caching happens only for lists that are known to be
8451 the same each time they are referenced.
8452
8453 By default, there may be up to 16 named lists of each type. This limit can be
8454 extended by changing a compile-time variable. The use of domain and host lists
8455 is recommended for concepts such as local domains, relay domains, and relay
8456 hosts. The default configuration is set up like this.
8457
8458
8459
8460 .section "Named lists compared with macros" "SECID78"
8461 .cindex "list" "named compared with macro"
8462 .cindex "macro" "compared with named list"
8463 At first sight, named lists might seem to be no different from macros in the
8464 configuration file. However, macros are just textual substitutions. If you
8465 write
8466 .code
8467 ALIST = host1 : host2
8468 auth_advertise_hosts = !ALIST
8469 .endd
8470 it probably won't do what you want, because that is exactly the same as
8471 .code
8472 auth_advertise_hosts = !host1 : host2
8473 .endd
8474 Notice that the second host name is not negated. However, if you use a host
8475 list, and write
8476 .code
8477 hostlist alist = host1 : host2
8478 auth_advertise_hosts = ! +alist
8479 .endd
8480 the negation applies to the whole list, and so that is equivalent to
8481 .code
8482 auth_advertise_hosts = !host1 : !host2
8483 .endd
8484
8485
8486 .section "Named list caching" "SECID79"
8487 .cindex "list" "caching of named"
8488 .cindex "caching" "named lists"
8489 While processing a message, Exim caches the result of checking a named list if
8490 it is sure that the list is the same each time. In practice, this means that
8491 the cache operates only if the list contains no $ characters, which guarantees
8492 that it will not change when it is expanded. Sometimes, however, you may have
8493 an expanded list that you know will be the same each time within a given
8494 message. For example:
8495 .code
8496 domainlist special_domains = \
8497            ${lookup{$sender_host_address}cdb{/some/file}}
8498 .endd
8499 This provides a list of domains that depends only on the sending host's IP
8500 address. If this domain list is referenced a number of times (for example,
8501 in several ACL lines, or in several routers) the result of the check is not
8502 cached by default, because Exim does not know that it is going to be the
8503 same list each time.
8504
8505 By appending &`_cache`& to &`domainlist`& you can tell Exim to go ahead and
8506 cache the result anyway. For example:
8507 .code
8508 domainlist_cache special_domains = ${lookup{...
8509 .endd
8510 If you do this, you should be absolutely sure that caching is going to do
8511 the right thing in all cases. When in doubt, leave it out.
8512
8513
8514
8515 .section "Domain lists" "SECTdomainlist"
8516 .cindex "domain list" "patterns for"
8517 .cindex "list" "domain list"
8518 Domain lists contain patterns that are to be matched against a mail domain.
8519 The following types of item may appear in domain lists:
8520
8521 .ilist
8522 .cindex "primary host name"
8523 .cindex "host name" "matched in domain list"
8524 .oindex "&%primary_hostname%&"
8525 .cindex "domain list" "matching primary host name"
8526 .cindex "@ in a domain list"
8527 If a pattern consists of a single @ character, it matches the local host name,
8528 as set by the &%primary_hostname%& option (or defaulted). This makes it
8529 possible to use the same configuration file on several different hosts that
8530 differ only in their names.
8531
8532 .new
8533 The value for a match will be the primary host name.
8534 .wen
8535
8536
8537 .next
8538 .cindex "@[] in a domain list"
8539 .cindex "domain list" "matching local IP interfaces"
8540 .cindex "domain literal"
8541 If a pattern consists of the string &`@[]`& it matches an IP address enclosed
8542 in square brackets (as in an email address that contains a domain literal), but
8543 only if that IP address is recognized as local for email routing purposes. The
8544 &%local_interfaces%& and &%extra_local_interfaces%& options can be used to
8545 control which of a host's several IP addresses are treated as local.
8546 In today's Internet, the use of domain literals is controversial;
8547 see the &%allow_domain_literals%& main option.
8548
8549 .new
8550 The value for a match will be the string &`@[]`&.
8551 .wen
8552
8553
8554 .next
8555 .cindex "@mx_any"
8556 .cindex "@mx_primary"
8557 .cindex "@mx_secondary"
8558 .cindex "domain list" "matching MX pointers to local host"
8559 If a pattern consists of the string &`@mx_any`& it matches any domain that
8560 has an MX record pointing to the local host or to any host that is listed in
8561 .oindex "&%hosts_treat_as_local%&"
8562 &%hosts_treat_as_local%&. The items &`@mx_primary`& and &`@mx_secondary`&
8563 are similar, except that the first matches only when a primary MX target is the
8564 local host, and the second only when no primary MX target is the local host,
8565 but a secondary MX target is. &"Primary"& means an MX record with the lowest
8566 preference value &-- there may of course be more than one of them.
8567
8568 The MX lookup that takes place when matching a pattern of this type is
8569 performed with the resolver options for widening names turned off. Thus, for
8570 example, a single-component domain will &'not'& be expanded by adding the
8571 resolver's default domain. See the &%qualify_single%& and &%search_parents%&
8572 options of the &(dnslookup)& router for a discussion of domain widening.
8573
8574 Sometimes you may want to ignore certain IP addresses when using one of these
8575 patterns. You can specify this by following the pattern with &`/ignore=`&<&'ip
8576 list'&>, where <&'ip list'&> is a list of IP addresses. These addresses are
8577 ignored when processing the pattern (compare the &%ignore_target_hosts%& option
8578 on a router). For example:
8579 .code
8580 domains = @mx_any/ignore=127.0.0.1
8581 .endd
8582 This example matches any domain that has an MX record pointing to one of
8583 the local host's IP addresses other than 127.0.0.1.
8584
8585 The list of IP addresses is in fact processed by the same code that processes
8586 host lists, so it may contain CIDR-coded network specifications and it may also
8587 contain negative items.
8588
8589 Because the list of IP addresses is a sublist within a domain list, you have to
8590 be careful about delimiters if there is more than one address. Like any other
8591 list, the default delimiter can be changed. Thus, you might have:
8592 .code
8593 domains = @mx_any/ignore=<;127.0.0.1;0.0.0.0 : \
8594           an.other.domain : ...
8595 .endd
8596 so that the sublist uses semicolons for delimiters. When IPv6 addresses are
8597 involved, it is easiest to change the delimiter for the main list as well:
8598 .code
8599 domains = <? @mx_any/ignore=<;127.0.0.1;::1 ? \
8600           an.other.domain ? ...
8601 .endd
8602 .new
8603 The value for a match will be the list element string (starting &`@mx_`&).
8604 .wen
8605
8606
8607 .next
8608 .cindex "asterisk" "in domain list"
8609 .cindex "domain list" "asterisk in"
8610 .cindex "domain list" "matching &""ends with""&"
8611 If a pattern starts with an asterisk, the remaining characters of the pattern
8612 are compared with the terminating characters of the domain. The use of &"*"& in
8613 domain lists differs from its use in partial matching lookups. In a domain
8614 list, the character following the asterisk need not be a dot, whereas partial
8615 matching works only in terms of dot-separated components. For example, a domain
8616 list item such as &`*key.ex`& matches &'donkey.ex'& as well as
8617 &'cipher.key.ex'&.
8618
8619 .new
8620 The value for a match will be the list element string (starting with the asterisk).
8621 Additionally, &$0$& will be set to the matched string
8622 and &$1$& to the variable portion which the asterisk matched.
8623 .wen
8624
8625 .next
8626 .cindex "regular expressions" "in domain list"
8627 .cindex "domain list" "matching regular expression"
8628 If a pattern starts with a circumflex character, it is treated as a regular
8629 expression, and matched against the domain using a regular expression matching
8630 function. The circumflex is treated as part of the regular expression.
8631 Email domains are case-independent, so this regular expression match is by
8632 default case-independent, but you can make it case-dependent by starting it
8633 with &`(?-i)`&. References to descriptions of the syntax of regular expressions
8634 are given in chapter &<<CHAPregexp>>&.
8635
8636 &*Warning*&: Because domain lists are expanded before being processed, you
8637 must escape any backslash and dollar characters in the regular expression, or
8638 use the special &`\N`& sequence (see chapter &<<CHAPexpand>>&) to specify that
8639 it is not to be expanded (unless you really do want to build a regular
8640 expression by expansion, of course).
8641
8642 .new
8643 The value for a match will be the list element string (starting with the circumflex).
8644 Additionally, &$0$& will be set to the string matching the regular expression,
8645 and &$1$& (onwards) to any submatches identified by parentheses.
8646 .wen
8647
8648
8649
8650 .next
8651 .cindex "lookup" "in domain list"
8652 .cindex "domain list" "matching by lookup"
8653 If a pattern starts with the name of a single-key lookup type followed by a
8654 semicolon (for example, &"dbm;"& or &"lsearch;"&), the remainder of the pattern
8655 must be a filename in a suitable format for the lookup type. For example, for
8656 &"cdb;"& it must be an absolute path:
8657 .code
8658 domains = cdb;/etc/mail/local_domains.cdb
8659 .endd
8660 The appropriate type of lookup is done on the file using the domain name as the
8661 key. In most cases, the value resulting from the lookup is not used; Exim is interested
8662 only in whether or not the key is present in the file. However, when a lookup
8663 is used for the &%domains%& option on a router
8664 or a &%domains%& condition in an ACL statement, the value is preserved in the
8665 &$domain_data$& variable and can be referred to in other router options or
8666 other statements in the same ACL.
8667 .cindex "tainted data" "de-tainting"
8668 The value will be untainted.
8669
8670
8671 .next
8672 Any of the single-key lookup type names may be preceded by
8673 &`partial`&<&'n'&>&`-`&, where the <&'n'&> is optional, for example,
8674 .code
8675 domains = partial-dbm;/partial/domains
8676 .endd
8677 This causes partial matching logic to be invoked; a description of how this
8678 works is given in section &<<SECTpartiallookup>>&.
8679
8680 .next
8681 .cindex "asterisk" "in lookup type"
8682 Any of the single-key lookup types may be followed by an asterisk. This causes
8683 a default lookup for a key consisting of a single asterisk to be done if the
8684 original lookup fails. This is not a useful feature when using a domain list to
8685 select particular domains (because any domain would match), but it might have
8686 value if the result of the lookup is being used via the &$domain_data$&
8687 expansion variable.
8688
8689 .next
8690 If the pattern starts with the name of a query-style lookup type followed by a
8691 semicolon (for example, &"nisplus;"& or &"ldap;"&), the remainder of the
8692 pattern must be an appropriate query for the lookup type, as described in
8693 chapter &<<CHAPfdlookup>>&. For example:
8694 .code
8695 hold_domains = mysql;select domain from holdlist \
8696   where domain = '${quote_mysql:$domain}';
8697 .endd
8698 In most cases, the value resulting from the lookup is not used (so for an SQL query, for
8699 example, it doesn't matter what field you select). Exim is interested only in
8700 whether or not the query succeeds. However, when a lookup is used for the
8701 &%domains%& option on a router, the value is preserved in the &$domain_data$&
8702 variable and can be referred to in other options.
8703 .cindex "tainted data" "de-tainting"
8704 The value will be untainted.
8705
8706 .next
8707 .new
8708 If the pattern starts with the name of a lookup type
8709 of either kind (single-key or query-style) it may be
8710 followed by a comma and options,
8711 The options are lookup-type specific and consist of a comma-separated list.
8712 Each item starts with a tag and and equals "=".
8713 .wen
8714
8715 .next
8716 .cindex "domain list" "matching literal domain name"
8717 If none of the above cases apply, a caseless textual comparison is made
8718 between the pattern and the domain.
8719
8720 The value for a match will be the list element string.
8721 .cindex "tainted data" "de-tainting"
8722 Note that this is commonly untainted
8723 (depending on the way the list was created).
8724 This is a useful way of obtaining an untainted equivalent to
8725 the domain, for later operations.
8726 .endlist
8727
8728
8729 Here is an example that uses several different kinds of pattern:
8730 .code
8731 domainlist funny_domains = \
8732   @ : \
8733   lib.unseen.edu : \
8734   *.foundation.fict.example : \
8735   \N^[1-2]\d{3}\.fict\.example$\N : \
8736   partial-dbm;/opt/data/penguin/book : \
8737   nis;domains.byname : \
8738   nisplus;[name=$domain,status=local],domains.org_dir
8739 .endd
8740 There are obvious processing trade-offs among the various matching modes. Using
8741 an asterisk is faster than a regular expression, and listing a few names
8742 explicitly probably is too. The use of a file or database lookup is expensive,
8743 but may be the only option if hundreds of names are required. Because the
8744 patterns are tested in order, it makes sense to put the most commonly matched
8745 patterns earlier.
8746
8747
8748
8749 .section "Host lists" "SECThostlist"
8750 .cindex "host list" "patterns in"
8751 .cindex "list" "host list"
8752 Host lists are used to control what remote hosts are allowed to do. For
8753 example, some hosts may be allowed to use the local host as a relay, and some
8754 may be permitted to use the SMTP ETRN command. Hosts can be identified in
8755 two different ways, by name or by IP address. In a host list, some types of
8756 pattern are matched to a host name, and some are matched to an IP address.
8757 You need to be particularly careful with this when single-key lookups are
8758 involved, to ensure that the right value is being used as the key.
8759
8760
8761 .section "Special host list patterns" "SECID80"
8762 .cindex "empty item in hosts list"
8763 .cindex "host list" "empty string in"
8764 If a host list item is the empty string, it matches only when no remote host is
8765 involved. This is the case when a message is being received from a local
8766 process using SMTP on the standard input, that is, when a TCP/IP connection is
8767 not used.
8768
8769 .cindex "asterisk" "in host list"
8770 The special pattern &"*"& in a host list matches any host or no host. Neither
8771 the IP address nor the name is actually inspected.
8772
8773
8774
8775 .section "Host list patterns that match by IP address" "SECThoslispatip"
8776 .cindex "host list" "matching IP addresses"
8777 If an IPv4 host calls an IPv6 host and the call is accepted on an IPv6 socket,
8778 the incoming address actually appears in the IPv6 host as
8779 &`::ffff:`&<&'v4address'&>. When such an address is tested against a host
8780 list, it is converted into a traditional IPv4 address first. (Not all operating
8781 systems accept IPv4 calls on IPv6 sockets, as there have been some security
8782 concerns.)
8783
8784 The following types of pattern in a host list check the remote host by
8785 inspecting its IP address:
8786
8787 .ilist
8788 If the pattern is a plain domain name (not a regular expression, not starting
8789 with *, not a lookup of any kind), Exim calls the operating system function
8790 to find the associated IP address(es). Exim uses the newer
8791 &[getipnodebyname()]& function when available, otherwise &[gethostbyname()]&.
8792 This typically causes a forward DNS lookup of the name. The result is compared
8793 with the IP address of the subject host.
8794
8795 If there is a temporary problem (such as a DNS timeout) with the host name
8796 lookup, a temporary error occurs. For example, if the list is being used in an
8797 ACL condition, the ACL gives a &"defer"& response, usually leading to a
8798 temporary SMTP error code. If no IP address can be found for the host name,
8799 what happens is described in section &<<SECTbehipnot>>& below.
8800
8801 .next
8802 .cindex "@ in a host list"
8803 If the pattern is &"@"&, the primary host name is substituted and used as a
8804 domain name, as just described.
8805
8806 .next
8807 If the pattern is an IP address, it is matched against the IP address of the
8808 subject host. IPv4 addresses are given in the normal &"dotted-quad"& notation.
8809 IPv6 addresses can be given in colon-separated format, but the colons have to
8810 be doubled so as not to be taken as item separators when the default list
8811 separator is used. IPv6 addresses are recognized even when Exim is compiled
8812 without IPv6 support. This means that if they appear in a host list on an
8813 IPv4-only host, Exim will not treat them as host names. They are just addresses
8814 that can never match a client host.
8815
8816 .next
8817 .cindex "@[] in a host list"
8818 If the pattern is &"@[]"&, it matches the IP address of any IP interface on
8819 the local host. For example, if the local host is an IPv4 host with one
8820 interface address 10.45.23.56, these two ACL statements have the same effect:
8821 .code
8822 accept hosts = 127.0.0.1 : 10.45.23.56
8823 accept hosts = @[]
8824 .endd
8825 .next
8826 .cindex "CIDR notation"
8827 If the pattern is an IP address followed by a slash and a mask length (for
8828 example 10.11.42.0/24), it is matched against the IP address of the subject
8829 host under the given mask. This allows, an entire network of hosts to be
8830 included (or excluded) by a single item. The mask uses CIDR notation; it
8831 specifies the number of address bits that must match, starting from the most
8832 significant end of the address.
8833
8834 &*Note*&: The mask is &'not'& a count of addresses, nor is it the high number
8835 of a range of addresses. It is the number of bits in the network portion of the
8836 address. The above example specifies a 24-bit netmask, so it matches all 256
8837 addresses in the 10.11.42.0 network. An item such as
8838 .code
8839 192.168.23.236/31
8840 .endd
8841 matches just two addresses, 192.168.23.236 and 192.168.23.237. A mask value of
8842 32 for an IPv4 address is the same as no mask at all; just a single address
8843 matches.
8844
8845 Here is another example which shows an IPv4 and an IPv6 network:
8846 .code
8847 recipient_unqualified_hosts = 192.168.0.0/16: \
8848                               3ffe::ffff::836f::::/48
8849 .endd
8850 The doubling of list separator characters applies only when these items
8851 appear inline in a host list. It is not required when indirecting via a file.
8852 For example:
8853 .code
8854 recipient_unqualified_hosts = /opt/exim/unqualnets
8855 .endd
8856 could make use of a file containing
8857 .code
8858 172.16.0.0/12
8859 3ffe:ffff:836f::/48
8860 .endd
8861 to have exactly the same effect as the previous example. When listing IPv6
8862 addresses inline, it is usually more convenient to use the facility for
8863 changing separator characters. This list contains the same two networks:
8864 .code
8865 recipient_unqualified_hosts = <; 172.16.0.0/12; \
8866                                  3ffe:ffff:836f::/48
8867 .endd
8868 The separator is changed to semicolon by the leading &"<;"& at the start of the
8869 list.
8870 .endlist
8871
8872
8873
8874 .section "Host list patterns for single-key lookups by host address" &&&
8875          "SECThoslispatsikey"
8876 .cindex "host list" "lookup of IP address"
8877 When a host is to be identified by a single-key lookup of its complete IP
8878 address, the pattern takes this form:
8879 .display
8880 &`net-<`&&'single-key-search-type'&&`>;<`&&'search-data'&&`>`&
8881 .endd
8882 For example:
8883 .code
8884 hosts_lookup = net-cdb;/hosts-by-ip.db
8885 .endd
8886 The text form of the IP address of the subject host is used as the lookup key.
8887 IPv6 addresses are converted to an unabbreviated form, using lower case
8888 letters, with dots as separators because colon is the key terminator in
8889 &(lsearch)& files. [Colons can in fact be used in keys in &(lsearch)& files by
8890 quoting the keys, but this is a facility that was added later.] The data
8891 returned by the lookup is not used.
8892
8893 .cindex "IP address" "masking"
8894 .cindex "host list" "masked IP address"
8895 Single-key lookups can also be performed using masked IP addresses, using
8896 patterns of this form:
8897 .display
8898 &`net<`&&'number'&&`>-<`&&'single-key-search-type'&&`>;<`&&'search-data'&&`>`&
8899 .endd
8900 For example:
8901 .code
8902 net24-dbm;/networks.db
8903 .endd
8904 The IP address of the subject host is masked using <&'number'&> as the mask
8905 length. A textual string is constructed from the masked value, followed by the
8906 mask, and this is used as the lookup key. For example, if the host's IP address
8907 is 192.168.34.6, the key that is looked up for the above example is
8908 &"192.168.34.0/24"&.
8909
8910 When an IPv6 address is converted to a string, dots are normally used instead
8911 of colons, so that keys in &(lsearch)& files need not contain colons (which
8912 terminate &(lsearch)& keys). This was implemented some time before the ability
8913 to quote keys was made available in &(lsearch)& files. However, the more
8914 recently implemented &(iplsearch)& files do require colons in IPv6 keys
8915 (notated using the quoting facility) so as to distinguish them from IPv4 keys.
8916 For this reason, when the lookup type is &(iplsearch)&, IPv6 addresses are
8917 converted using colons and not dots.
8918 In all cases except IPv4-mapped IPv6, full, unabbreviated IPv6
8919 addresses are always used.
8920 The latter are converted to IPv4 addresses, in dotted-quad form.
8921
8922 Ideally, it would be nice to tidy up this anomalous situation by changing to
8923 colons in all cases, given that quoting is now available for &(lsearch)&.
8924 However, this would be an incompatible change that might break some existing
8925 configurations.
8926
8927 &*Warning*&: Specifying &%net32-%& (for an IPv4 address) or &%net128-%& (for an
8928 IPv6 address) is not the same as specifying just &%net-%& without a number. In
8929 the former case the key strings include the mask value, whereas in the latter
8930 case the IP address is used on its own.
8931
8932
8933
8934 .section "Host list patterns that match by host name" "SECThoslispatnam"
8935 .cindex "host" "lookup failures"
8936 .cindex "unknown host name"
8937 .cindex "host list" "matching host name"
8938 There are several types of pattern that require Exim to know the name of the
8939 remote host. These are either wildcard patterns or lookups by name. (If a
8940 complete hostname is given without any wildcarding, it is used to find an IP
8941 address to match against, as described in section &<<SECThoslispatip>>&
8942 above.)
8943
8944 If the remote host name is not already known when Exim encounters one of these
8945 patterns, it has to be found from the IP address.
8946 Although many sites on the Internet are conscientious about maintaining reverse
8947 DNS data for their hosts, there are also many that do not do this.
8948 Consequently, a name cannot always be found, and this may lead to unwanted
8949 effects. Take care when configuring host lists with wildcarded name patterns.
8950 Consider what will happen if a name cannot be found.
8951
8952 Because of the problems of determining host names from IP addresses, matching
8953 against host names is not as common as matching against IP addresses.
8954
8955 By default, in order to find a host name, Exim first does a reverse DNS lookup;
8956 if no name is found in the DNS, the system function (&[gethostbyaddr()]& or
8957 &[getipnodebyaddr()]& if available) is tried. The order in which these lookups
8958 are done can be changed by setting the &%host_lookup_order%& option. For
8959 security, once Exim has found one or more names, it looks up the IP addresses
8960 for these names and compares them with the IP address that it started with.
8961 Only those names whose IP addresses match are accepted. Any other names are
8962 discarded. If no names are left, Exim behaves as if the host name cannot be
8963 found. In the most common case there is only one name and one IP address.
8964
8965 There are some options that control what happens if a host name cannot be
8966 found. These are described in section &<<SECTbehipnot>>& below.
8967
8968 .cindex "host" "alias for"
8969 .cindex "alias for host"
8970 As a result of aliasing, hosts may have more than one name. When processing any
8971 of the following types of pattern, all the host's names are checked:
8972
8973 .ilist
8974 .cindex "asterisk" "in host list"
8975 If a pattern starts with &"*"& the remainder of the item must match the end of
8976 the host name. For example, &`*.b.c`& matches all hosts whose names end in
8977 &'.b.c'&. This special simple form is provided because this is a very common
8978 requirement. Other kinds of wildcarding require the use of a regular
8979 expression.
8980 .next
8981 .cindex "regular expressions" "in host list"
8982 .cindex "host list" "regular expression in"
8983 If the item starts with &"^"& it is taken to be a regular expression which is
8984 matched against the host name. Host names are case-independent, so this regular
8985 expression match is by default case-independent, but you can make it
8986 case-dependent by starting it with &`(?-i)`&. References to descriptions of the
8987 syntax of regular expressions are given in chapter &<<CHAPregexp>>&. For
8988 example,
8989 .code
8990 ^(a|b)\.c\.d$
8991 .endd
8992 is a regular expression that matches either of the two hosts &'a.c.d'& or
8993 &'b.c.d'&. When a regular expression is used in a host list, you must take care
8994 that backslash and dollar characters are not misinterpreted as part of the
8995 string expansion. The simplest way to do this is to use &`\N`& to mark that
8996 part of the string as non-expandable. For example:
8997 .code
8998 sender_unqualified_hosts = \N^(a|b)\.c\.d$\N : ....
8999 .endd
9000 &*Warning*&: If you want to match a complete host name, you must include the
9001 &`$`& terminating metacharacter in the regular expression, as in the above
9002 example. Without it, a match at the start of the host name is all that is
9003 required.
9004 .endlist
9005
9006
9007
9008
9009 .section "Behaviour when an IP address or name cannot be found" "SECTbehipnot"
9010 .cindex "host" "lookup failures, permanent"
9011 While processing a host list, Exim may need to look up an IP address from a
9012 name (see section &<<SECThoslispatip>>&), or it may need to look up a host name
9013 from an IP address (see section &<<SECThoslispatnam>>&). In either case, the
9014 behaviour when it fails to find the information it is seeking is the same.
9015
9016 &*Note*&: This section applies to permanent lookup failures. It does &'not'&
9017 apply to temporary DNS errors, whose handling is described in the next section.
9018
9019 .cindex "&`+include_unknown`&"
9020 .cindex "&`+ignore_unknown`&"
9021 Exim parses a host list from left to right. If it encounters a permanent
9022 lookup failure in any item in the host list before it has found a match,
9023 Exim treats it as a failure and the default behavior is as if the host
9024 does not match the list. This may not always be what you want to happen.
9025 To change Exim's behaviour, the special items &`+include_unknown`& or
9026 &`+ignore_unknown`& may appear in the list (at top level &-- they are
9027 not recognized in an indirected file).
9028
9029 .ilist
9030 If any item that follows &`+include_unknown`& requires information that
9031 cannot found, Exim behaves as if the host does match the list. For example,
9032 .code
9033 host_reject_connection = +include_unknown:*.enemy.ex
9034 .endd
9035 rejects connections from any host whose name matches &`*.enemy.ex`&, and also
9036 any hosts whose name it cannot find.
9037
9038 .next
9039 If any item that follows &`+ignore_unknown`& requires information that cannot
9040 be found, Exim ignores that item and proceeds to the rest of the list. For
9041 example:
9042 .code
9043 accept hosts = +ignore_unknown : friend.example : \
9044                192.168.4.5
9045 .endd
9046 accepts from any host whose name is &'friend.example'& and from 192.168.4.5,
9047 whether or not its host name can be found. Without &`+ignore_unknown`&, if no
9048 name can be found for 192.168.4.5, it is rejected.
9049 .endlist
9050
9051 Both &`+include_unknown`& and &`+ignore_unknown`& may appear in the same
9052 list. The effect of each one lasts until the next, or until the end of the
9053 list.
9054
9055 .section "Mixing wildcarded host names and addresses in host lists" &&&
9056          "SECTmixwilhos"
9057 .cindex "host list" "mixing names and addresses in"
9058
9059 This section explains the host/ip processing logic with the same concepts
9060 as the previous section, but specifically addresses what happens when a
9061 wildcarded hostname is one of the items in the hostlist.
9062
9063 .ilist
9064 If you have name lookups or wildcarded host names and
9065 IP addresses in the same host list, you should normally put the IP
9066 addresses first. For example, in an ACL you could have:
9067 .code
9068 accept hosts = 10.9.8.7 : *.friend.example
9069 .endd
9070 The reason you normally would order it this way lies in the
9071 left-to-right way that Exim processes lists.  It can test IP addresses
9072 without doing any DNS lookups, but when it reaches an item that requires
9073 a host name, it fails if it cannot find a host name to compare with the
9074 pattern. If the above list is given in the opposite order, the
9075 &%accept%& statement fails for a host whose name cannot be found, even
9076 if its IP address is 10.9.8.7.
9077
9078 .next
9079 If you really do want to do the name check first, and still recognize the IP
9080 address, you can rewrite the ACL like this:
9081 .code
9082 accept hosts = *.friend.example
9083 accept hosts = 10.9.8.7
9084 .endd
9085 If the first &%accept%& fails, Exim goes on to try the second one. See chapter
9086 &<<CHAPACL>>& for details of ACLs. Alternatively, you can use
9087 &`+ignore_unknown`&, which was discussed in depth in the first example in
9088 this section.
9089 .endlist
9090
9091
9092 .section "Temporary DNS errors when looking up host information" &&&
9093          "SECTtemdnserr"
9094 .cindex "host" "lookup failures, temporary"
9095 .cindex "&`+include_defer`&"
9096 .cindex "&`+ignore_defer`&"
9097 A temporary DNS lookup failure normally causes a defer action (except when
9098 &%dns_again_means_nonexist%& converts it into a permanent error). However,
9099 host lists can include &`+ignore_defer`& and &`+include_defer`&, analogous to
9100 &`+ignore_unknown`& and &`+include_unknown`&, as described in the previous
9101 section. These options should be used with care, probably only in non-critical
9102 host lists such as whitelists.
9103
9104
9105
9106 .section "Host list patterns for single-key lookups by host name" &&&
9107          "SECThoslispatnamsk"
9108 .cindex "unknown host name"
9109 .cindex "host list" "matching host name"
9110 If a pattern is of the form
9111 .display
9112 <&'single-key-search-type'&>;<&'search-data'&>
9113 .endd
9114 for example
9115 .code
9116 dbm;/host/accept/list
9117 .endd
9118 a single-key lookup is performed, using the host name as its key. If the
9119 lookup succeeds, the host matches the item. The actual data that is looked up
9120 is not used.
9121
9122 &*Reminder*&: With this kind of pattern, you must have host &'names'& as
9123 keys in the file, not IP addresses. If you want to do lookups based on IP
9124 addresses, you must precede the search type with &"net-"& (see section
9125 &<<SECThoslispatsikey>>&). There is, however, no reason why you could not use
9126 two items in the same list, one doing an address lookup and one doing a name
9127 lookup, both using the same file.
9128
9129
9130
9131 .section "Host list patterns for query-style lookups" "SECID81"
9132 If a pattern is of the form
9133 .display
9134 <&'query-style-search-type'&>;<&'query'&>
9135 .endd
9136 the query is obeyed, and if it succeeds, the host matches the item. The actual
9137 data that is looked up is not used. The variables &$sender_host_address$& and
9138 &$sender_host_name$& can be used in the query. For example:
9139 .code
9140 hosts_lookup = pgsql;\
9141   select ip from hostlist where ip='$sender_host_address'
9142 .endd
9143 The value of &$sender_host_address$& for an IPv6 address contains colons. You
9144 can use the &%sg%& expansion item to change this if you need to. If you want to
9145 use masked IP addresses in database queries, you can use the &%mask%& expansion
9146 operator.
9147
9148 If the query contains a reference to &$sender_host_name$&, Exim automatically
9149 looks up the host name if it has not already done so. (See section
9150 &<<SECThoslispatnam>>& for comments on finding host names.)
9151
9152 Historical note: prior to release 4.30, Exim would always attempt to find a
9153 host name before running the query, unless the search type was preceded by
9154 &`net-`&. This is no longer the case. For backwards compatibility, &`net-`& is
9155 still recognized for query-style lookups, but its presence or absence has no
9156 effect. (Of course, for single-key lookups, &`net-`& &'is'& important.
9157 See section &<<SECThoslispatsikey>>&.)
9158
9159
9160
9161
9162
9163 .section "Address lists" "SECTaddresslist"
9164 .cindex "list" "address list"
9165 .cindex "address list" "empty item"
9166 .cindex "address list" "patterns"
9167 Address lists contain patterns that are matched against mail addresses. There
9168 is one special case to be considered: the sender address of a bounce message is
9169 always empty. You can test for this by providing an empty item in an address
9170 list. For example, you can set up a router to process bounce messages by
9171 using this option setting:
9172 .code
9173 senders = :
9174 .endd
9175 The presence of the colon creates an empty item. If you do not provide any
9176 data, the list is empty and matches nothing. The empty sender can also be
9177 detected by a regular expression that matches an empty string,
9178 and by a query-style lookup that succeeds when &$sender_address$& is empty.
9179
9180 Non-empty items in an address list can be straightforward email addresses. For
9181 example:
9182 .code
9183 senders = jbc@askone.example : hs@anacreon.example
9184 .endd
9185 A certain amount of wildcarding is permitted. If a pattern contains an @
9186 character, but is not a regular expression and does not begin with a
9187 semicolon-terminated lookup type (described below), the local part of the
9188 subject address is compared with the local part of the pattern, which may start
9189 with an asterisk. If the local parts match, the domain is checked in exactly
9190 the same way as for a pattern in a domain list. For example, the domain can be
9191 wildcarded, refer to a named list, or be a lookup:
9192 .code
9193 deny senders = *@*.spamming.site:\
9194                *@+hostile_domains:\
9195                bozo@partial-lsearch;/list/of/dodgy/sites:\
9196                *@dbm;/bad/domains.db
9197 .endd
9198 .cindex "local part" "starting with !"
9199 .cindex "address list" "local part starting with !"
9200 If a local part that begins with an exclamation mark is required, it has to be
9201 specified using a regular expression, because otherwise the exclamation mark is
9202 treated as a sign of negation, as is standard in lists.
9203
9204 If a non-empty pattern that is not a regular expression or a lookup does not
9205 contain an @ character, it is matched against the domain part of the subject
9206 address. The only two formats that are recognized this way are a literal
9207 domain, or a domain pattern that starts with *. In both these cases, the effect
9208 is the same as if &`*@`& preceded the pattern. For example:
9209 .code
9210 deny senders = enemy.domain : *.enemy.domain
9211 .endd
9212
9213 The following kinds of more complicated address list pattern can match any
9214 address, including the empty address that is characteristic of bounce message
9215 senders:
9216
9217 .ilist
9218 .cindex "regular expressions" "in address list"
9219 .cindex "address list" "regular expression in"
9220 If (after expansion) a pattern starts with &"^"&, a regular expression match is
9221 done against the complete address, with the pattern as the regular expression.
9222 You must take care that backslash and dollar characters are not misinterpreted
9223 as part of the string expansion. The simplest way to do this is to use &`\N`&
9224 to mark that part of the string as non-expandable. For example:
9225 .code
9226 deny senders = \N^.*this.*@example\.com$\N : \
9227                \N^\d{8}.+@spamhaus.example$\N : ...
9228 .endd
9229 The &`\N`& sequences are removed by the expansion, so these items do indeed
9230 start with &"^"& by the time they are being interpreted as address patterns.
9231
9232 .next
9233 .cindex "address list" "lookup for complete address"
9234 Complete addresses can be looked up by using a pattern that starts with a
9235 lookup type terminated by a semicolon, followed by the data for the lookup. For
9236 example:
9237 .code
9238 deny senders = cdb;/etc/blocked.senders : \
9239   mysql;select address from blocked where \
9240   address='${quote_mysql:$sender_address}'
9241 .endd
9242 Both query-style and single-key lookup types can be used. For a single-key
9243 lookup type, Exim uses the complete address as the key. However, empty keys are
9244 not supported for single-key lookups, so a match against the empty address
9245 always fails. This restriction does not apply to query-style lookups.
9246
9247 Partial matching for single-key lookups (section &<<SECTpartiallookup>>&)
9248 cannot be used, and is ignored if specified, with an entry being written to the
9249 panic log.
9250 .cindex "*@ with single-key lookup"
9251 However, you can configure lookup defaults, as described in section
9252 &<<SECTdefaultvaluelookups>>&, but this is useful only for the &"*@"& type of
9253 default. For example, with this lookup:
9254 .code
9255 accept senders = lsearch*@;/some/file
9256 .endd
9257 the file could contains lines like this:
9258 .code
9259 user1@domain1.example
9260 *@domain2.example
9261 .endd
9262 and for the sender address &'nimrod@jaeger.example'&, the sequence of keys
9263 that are tried is:
9264 .code
9265 nimrod@jaeger.example
9266 *@jaeger.example
9267 *
9268 .endd
9269 &*Warning 1*&: Do not include a line keyed by &"*"& in the file, because that
9270 would mean that every address matches, thus rendering the test useless.
9271
9272 &*Warning 2*&: Do not confuse these two kinds of item:
9273 .code
9274 deny recipients = dbm*@;/some/file
9275 deny recipients = *@dbm;/some/file
9276 .endd
9277 The first does a whole address lookup, with defaulting, as just described,
9278 because it starts with a lookup type. The second matches the local part and
9279 domain independently, as described in a bullet point below.
9280 .endlist
9281
9282
9283 The following kinds of address list pattern can match only non-empty addresses.
9284 If the subject address is empty, a match against any of these pattern types
9285 always fails.
9286
9287
9288 .ilist
9289 .cindex "@@ with single-key lookup"
9290 .cindex "address list" "@@ lookup type"
9291 .cindex "address list" "split local part and domain"
9292 If a pattern starts with &"@@"& followed by a single-key lookup item
9293 (for example, &`@@lsearch;/some/file`&), the address that is being checked is
9294 split into a local part and a domain. The domain is looked up in the file. If
9295 it is not found, there is no match. If it is found, the data that is looked up
9296 from the file is treated as a colon-separated list of local part patterns, each
9297 of which is matched against the subject local part in turn.
9298
9299 .cindex "asterisk" "in address list"
9300 The lookup may be a partial one, and/or one involving a search for a default
9301 keyed by &"*"& (see section &<<SECTdefaultvaluelookups>>&). The local part
9302 patterns that are looked up can be regular expressions or begin with &"*"&, or
9303 even be further lookups. They may also be independently negated. For example,
9304 with
9305 .code
9306 deny senders = @@dbm;/etc/reject-by-domain
9307 .endd
9308 the data from which the DBM file is built could contain lines like
9309 .code
9310 baddomain.com:  !postmaster : *
9311 .endd
9312 to reject all senders except &%postmaster%& from that domain.
9313
9314 .cindex "local part" "starting with !"
9315 If a local part that actually begins with an exclamation mark is required, it
9316 has to be specified using a regular expression. In &(lsearch)& files, an entry
9317 may be split over several lines by indenting the second and subsequent lines,
9318 but the separating colon must still be included at line breaks. White space
9319 surrounding the colons is ignored. For example:
9320 .code
9321 aol.com:  spammer1 : spammer2 : ^[0-9]+$ :
9322   spammer3 : spammer4
9323 .endd
9324 As in all colon-separated lists in Exim, a colon can be included in an item by
9325 doubling.
9326
9327 If the last item in the list starts with a right angle-bracket, the remainder
9328 of the item is taken as a new key to look up in order to obtain a continuation
9329 list of local parts. The new key can be any sequence of characters. Thus one
9330 might have entries like
9331 .code
9332 aol.com: spammer1 : spammer 2 : >*
9333 xyz.com: spammer3 : >*
9334 *:       ^\d{8}$
9335 .endd
9336 in a file that was searched with &%@@dbm*%&, to specify a match for 8-digit
9337 local parts for all domains, in addition to the specific local parts listed for
9338 each domain. Of course, using this feature costs another lookup each time a
9339 chain is followed, but the effort needed to maintain the data is reduced.
9340
9341 .cindex "loop" "in lookups"
9342 It is possible to construct loops using this facility, and in order to catch
9343 them, the chains may be no more than fifty items long.
9344
9345 .next
9346 The @@<&'lookup'&> style of item can also be used with a query-style
9347 lookup, but in this case, the chaining facility is not available. The lookup
9348 can only return a single list of local parts.
9349 .endlist
9350
9351 &*Warning*&: There is an important difference between the address list items
9352 in these two examples:
9353 .code
9354 senders = +my_list
9355 senders = *@+my_list
9356 .endd
9357 In the first one, &`my_list`& is a named address list, whereas in the second
9358 example it is a named domain list.
9359
9360
9361
9362
9363 .section "Case of letters in address lists" "SECTcasletadd"
9364 .cindex "case of local parts"
9365 .cindex "address list" "case forcing"
9366 .cindex "case forcing in address lists"
9367 Domains in email addresses are always handled caselessly, but for local parts
9368 case may be significant on some systems (see &%caseful_local_part%& for how
9369 Exim deals with this when routing addresses). However, RFC 2505 (&'Anti-Spam
9370 Recommendations for SMTP MTAs'&) suggests that matching of addresses to
9371 blocking lists should be done in a case-independent manner. Since most address
9372 lists in Exim are used for this kind of control, Exim attempts to do this by
9373 default.
9374
9375 The domain portion of an address is always lowercased before matching it to an
9376 address list. The local part is lowercased by default, and any string
9377 comparisons that take place are done caselessly. This means that the data in
9378 the address list itself, in files included as plain filenames, and in any file
9379 that is looked up using the &"@@"& mechanism, can be in any case. However, the
9380 keys in files that are looked up by a search type other than &(lsearch)& (which
9381 works caselessly) must be in lower case, because these lookups are not
9382 case-independent.
9383
9384 .cindex "&`+caseful`&"
9385 To allow for the possibility of caseful address list matching, if an item in
9386 an address list is the string &"+caseful"&, the original case of the local
9387 part is restored for any comparisons that follow, and string comparisons are no
9388 longer case-independent. This does not affect the domain, which remains in
9389 lower case. However, although independent matches on the domain alone are still
9390 performed caselessly, regular expressions that match against an entire address
9391 become case-sensitive after &"+caseful"& has been seen.
9392
9393
9394
9395 .section "Local part lists" "SECTlocparlis"
9396 .cindex "list" "local part list"
9397 .cindex "local part" "list"
9398 Case-sensitivity in local part lists is handled in the same way as for address
9399 lists, as just described. The &"+caseful"& item can be used if required. In a
9400 setting of the &%local_parts%& option in a router with &%caseful_local_part%&
9401 set false, the subject is lowercased and the matching is initially
9402 case-insensitive. In this case, &"+caseful"& will restore case-sensitive
9403 matching in the local part list, but not elsewhere in the router. If
9404 &%caseful_local_part%& is set true in a router, matching in the &%local_parts%&
9405 option is case-sensitive from the start.
9406
9407 If a local part list is indirected to a file (see section &<<SECTfilnamlis>>&),
9408 comments are handled in the same way as address lists &-- they are recognized
9409 only if the # is preceded by white space or the start of the line.
9410 Otherwise, local part lists are matched in the same way as domain lists, except
9411 that the special items that refer to the local host (&`@`&, &`@[]`&,
9412 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`&) are not recognized.
9413 Refer to section &<<SECTdomainlist>>& for details of the other available item
9414 types.
9415 .ecindex IIDdohoadli
9416
9417
9418
9419
9420 . ////////////////////////////////////////////////////////////////////////////
9421 . ////////////////////////////////////////////////////////////////////////////
9422
9423 .chapter "String expansions" "CHAPexpand"
9424 .scindex IIDstrexp "expansion" "of strings"
9425 Many strings in Exim's runtime configuration are expanded before use. Some of
9426 them are expanded every time they are used; others are expanded only once.
9427
9428 When a string is being expanded it is copied verbatim from left to right except
9429 .cindex expansion "string concatenation"
9430 when a dollar or backslash character is encountered. A dollar specifies the
9431 start of a portion of the string that is interpreted and replaced as described
9432 below in section &<<SECTexpansionitems>>& onwards. Backslash is used as an
9433 escape character, as described in the following section.
9434
9435 Whether a string is expanded depends upon the context.  Usually this is solely
9436 dependent upon the option for which a value is sought; in this documentation,
9437 options for which string expansion is performed are marked with &dagger; after
9438 the data type.  ACL rules always expand strings.  A couple of expansion
9439 conditions do not expand some of the brace-delimited branches, for security
9440 reasons,
9441 .cindex "tainted data" expansion
9442 .cindex expansion "tainted data"
9443 and expansion of data deriving from the sender (&"tainted data"&)
9444 is not permitted.
9445
9446
9447
9448 .section "Literal text in expanded strings" "SECTlittext"
9449 .cindex "expansion" "including literal text"
9450 An uninterpreted dollar can be included in an expanded string by putting a
9451 backslash in front of it. A backslash can be used to prevent any special
9452 character being treated specially in an expansion, including backslash itself.
9453 If the string appears in quotes in the configuration file, two backslashes are
9454 required because the quotes themselves cause interpretation of backslashes when
9455 the string is read in (see section &<<SECTstrings>>&).
9456
9457 .cindex "expansion" "non-expandable substrings"
9458 A portion of the string can specified as non-expandable by placing it between
9459 two occurrences of &`\N`&. This is particularly useful for protecting regular
9460 expressions, which often contain backslashes and dollar signs. For example:
9461 .code
9462 deny senders = \N^\d{8}[a-z]@some\.site\.example$\N
9463 .endd
9464 On encountering the first &`\N`&, the expander copies subsequent characters
9465 without interpretation until it reaches the next &`\N`& or the end of the
9466 string.
9467
9468
9469
9470 .section "Character escape sequences in expanded strings" "SECID82"
9471 .cindex "expansion" "escape sequences"
9472 A backslash followed by one of the letters &"n"&, &"r"&, or &"t"& in an
9473 expanded string is recognized as an escape sequence for the character newline,
9474 carriage return, or tab, respectively. A backslash followed by up to three
9475 octal digits is recognized as an octal encoding for a single character, and a
9476 backslash followed by &"x"& and up to two hexadecimal digits is a hexadecimal
9477 encoding.
9478
9479 These escape sequences are also recognized in quoted strings when they are read
9480 in. Their interpretation in expansions as well is useful for unquoted strings,
9481 and for other cases such as looked-up strings that are then expanded.
9482
9483
9484 .section "Testing string expansions" "SECID83"
9485 .cindex "expansion" "testing"
9486 .cindex "testing" "string expansion"
9487 .oindex "&%-be%&"
9488 Many expansions can be tested by calling Exim with the &%-be%& option. This
9489 takes the command arguments, or lines from the standard input if there are no
9490 arguments, runs them through the string expansion code, and writes the results
9491 to the standard output. Variables based on configuration values are set up, but
9492 since no message is being processed, variables such as &$local_part$& have no
9493 value. Nevertheless the &%-be%& option can be useful for checking out file and
9494 database lookups, and the use of expansion operators such as &%sg%&, &%substr%&
9495 and &%nhash%&.
9496
9497 Exim gives up its root privilege when it is called with the &%-be%& option, and
9498 instead runs under the uid and gid it was called with, to prevent users from
9499 using &%-be%& for reading files to which they do not have access.
9500
9501 .oindex "&%-bem%&"
9502 If you want to test expansions that include variables whose values are taken
9503 from a message, there are two other options that can be used. The &%-bem%&
9504 option is like &%-be%& except that it is followed by a filename. The file is
9505 read as a message before doing the test expansions. For example:
9506 .code
9507 exim -bem /tmp/test.message '$h_subject:'
9508 .endd
9509 The &%-Mset%& option is used in conjunction with &%-be%& and is followed by an
9510 Exim message identifier. For example:
9511 .code
9512 exim -be -Mset 1GrA8W-0004WS-LQ '$recipients'
9513 .endd
9514 This loads the message from Exim's spool before doing the test expansions, and
9515 is therefore restricted to admin users.
9516
9517
9518 .section "Forced expansion failure" "SECTforexpfai"
9519 .cindex "expansion" "forced failure"
9520 A number of expansions that are described in the following section have
9521 alternative &"true"& and &"false"& substrings, enclosed in brace characters
9522 (which are sometimes called &"curly brackets"&). Which of the two strings is
9523 used depends on some condition that is evaluated as part of the expansion. If,
9524 instead of a &"false"& substring, the word &"fail"& is used (not in braces),
9525 the entire string expansion fails in a way that can be detected by the code
9526 that requested the expansion. This is called &"forced expansion failure"&, and
9527 its consequences depend on the circumstances. In some cases it is no different
9528 from any other expansion failure, but in others a different action may be
9529 taken. Such variations are mentioned in the documentation of the option that is
9530 being expanded.
9531
9532
9533
9534
9535 .section "Expansion items" "SECTexpansionitems"
9536 The following items are recognized in expanded strings. White space may be used
9537 between sub-items that are keywords or substrings enclosed in braces inside an
9538 outer set of braces, to improve readability. &*Warning*&: Within braces,
9539 white space is significant.
9540
9541 .vlist
9542 .vitem &*$*&<&'variable&~name'&>&~or&~&*${*&<&'variable&~name'&>&*}*&
9543 .cindex "expansion" "variables"
9544 Substitute the contents of the named variable, for example:
9545 .code
9546 $local_part
9547 ${domain}
9548 .endd
9549 The second form can be used to separate the name from subsequent alphanumeric
9550 characters. This form (using braces) is available only for variables; it does
9551 &'not'& apply to message headers. The names of the variables are given in
9552 section &<<SECTexpvar>>& below. If the name of a non-existent variable is
9553 given, the expansion fails.
9554
9555 .vitem &*${*&<&'op'&>&*:*&<&'string'&>&*}*&
9556 .cindex "expansion" "operators"
9557 The string is first itself expanded, and then the operation specified by
9558 <&'op'&> is applied to it. For example:
9559 .code
9560 ${lc:$local_part}
9561 .endd
9562 The string starts with the first character after the colon, which may be
9563 leading white space. A list of operators is given in section &<<SECTexpop>>&
9564 below. The operator notation is used for simple expansion items that have just
9565 one argument, because it reduces the number of braces and therefore makes the
9566 string easier to understand.
9567
9568 .vitem &*$bheader_*&<&'header&~name'&>&*:*&&~or&~&*$bh_*&<&'header&~name'&>&*:*&
9569 This item inserts &"basic"& header lines. It is described with the &%header%&
9570 expansion item below.
9571
9572
9573 .vitem "&*${acl{*&<&'name'&>&*}{*&<&'arg'&>&*}...}*&"
9574 .cindex "expansion" "calling an acl"
9575 .cindex "&%acl%&" "call from expansion"
9576 The name and zero to nine argument strings are first expanded separately.  The expanded
9577 arguments are assigned to the variables &$acl_arg1$& to &$acl_arg9$& in order.
9578 Any unused are made empty.  The variable &$acl_narg$& is set to the number of
9579 arguments.  The named ACL (see chapter &<<CHAPACL>>&) is called
9580 and may use the variables; if another acl expansion is used the values
9581 are restored after it returns.  If the ACL sets
9582 a value using a "message =" modifier and returns accept or deny, the value becomes
9583 the result of the expansion.
9584 If no message is set and the ACL returns accept or deny
9585 the expansion result is an empty string.
9586 If the ACL returns defer the result is a forced-fail.  Otherwise the expansion fails.
9587
9588
9589 .vitem "&*${authresults{*&<&'authserv-id'&>&*}}*&"
9590 .cindex authentication "results header"
9591 .cindex headers "authentication-results:"
9592 .cindex authentication "expansion item"
9593 This item returns a string suitable for insertion as an
9594 &'Authentication-Results:'&
9595 header line.
9596 The given <&'authserv-id'&> is included in the result; typically this
9597 will be a domain name identifying the system performing the authentications.
9598 Methods that might be present in the result include:
9599 .code
9600 none
9601 iprev
9602 auth
9603 spf
9604 dkim
9605 .endd
9606
9607 Example use (as an ACL modifier):
9608 .code
9609       add_header = :at_start:${authresults {$primary_hostname}}
9610 .endd
9611 This is safe even if no authentication results are available.
9612
9613
9614 .vitem "&*${certextract{*&<&'field'&>&*}{*&<&'certificate'&>&*}&&&
9615        {*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9616 .cindex "expansion" "extracting certificate fields"
9617 .cindex "&%certextract%&" "certificate fields"
9618 .cindex "certificate" "extracting fields"
9619 The <&'certificate'&> must be a variable of type certificate.
9620 The field name is expanded and used to retrieve the relevant field from
9621 the certificate.  Supported fields are:
9622 .display
9623 &`version        `&
9624 &`serial_number  `&
9625 &`subject        `& RFC4514 DN
9626 &`issuer         `& RFC4514 DN
9627 &`notbefore      `& time
9628 &`notafter       `& time
9629 &`sig_algorithm  `&
9630 &`signature      `&
9631 &`subj_altname   `& tagged list
9632 &`ocsp_uri       `& list
9633 &`crl_uri        `& list
9634 .endd
9635 If the field is found,
9636 <&'string2'&> is expanded, and replaces the whole item;
9637 otherwise <&'string3'&> is used. During the expansion of <&'string2'&> the
9638 variable &$value$& contains the value that has been extracted. Afterwards, it
9639 is restored to any previous value it might have had.
9640
9641 If {<&'string3'&>} is omitted, the item is replaced by an empty string if the
9642 key is not found. If {<&'string2'&>} is also omitted, the value that was
9643 extracted is used.
9644
9645 Some field names take optional modifiers, appended and separated by commas.
9646
9647 The field selectors marked as "RFC4514" above
9648 output a Distinguished Name string which is
9649 not quite
9650 parseable by Exim as a comma-separated tagged list
9651 (the exceptions being elements containing commas).
9652 RDN elements of a single type may be selected by
9653 a modifier of the type label; if so the expansion
9654 result is a list (newline-separated by default).
9655 The separator may be changed by another modifier of
9656 a right angle-bracket followed immediately by the new separator.
9657 Recognised RDN type labels include "CN", "O", "OU" and "DC".
9658
9659 The field selectors marked as "time" above
9660 take an optional modifier of "int"
9661 for which the result is the number of seconds since epoch.
9662 Otherwise the result is a human-readable string
9663 in the timezone selected by the main "timezone" option.
9664
9665 The field selectors marked as "list" above return a list,
9666 newline-separated by default,
9667 (embedded separator characters in elements are doubled).
9668 The separator may be changed by a modifier of
9669 a right angle-bracket followed immediately by the new separator.
9670
9671 The field selectors marked as "tagged" above
9672 prefix each list element with a type string and an equals sign.
9673 Elements of only one type may be selected by a modifier
9674 which is one of "dns", "uri" or "mail";
9675 if so the element tags are omitted.
9676
9677 If not otherwise noted field values are presented in human-readable form.
9678
9679 .vitem "&*${dlfunc{*&<&'file'&>&*}{*&<&'function'&>&*}{*&<&'arg'&>&*}&&&
9680        {*&<&'arg'&>&*}...}*&"
9681 .cindex &%dlfunc%&
9682 This expansion dynamically loads and then calls a locally-written C function.
9683 This functionality is available only if Exim is compiled with
9684 .code
9685 EXPAND_DLFUNC=yes
9686 .endd
9687 set in &_Local/Makefile_&. Once loaded, Exim remembers the dynamically loaded
9688 object so that it doesn't reload the same object file in the same Exim process
9689 (but of course Exim does start new processes frequently).
9690
9691 There may be from zero to eight arguments to the function.
9692
9693 When compiling
9694 a local function that is to be called in this way,
9695 first &_DLFUNC_IMPL_& should be defined,
9696 and second &_local_scan.h_& should be included.
9697 The Exim variables and functions that are defined by that API
9698 are also available for dynamically loaded functions. The function itself
9699 must have the following type:
9700 .code
9701 int dlfunction(uschar **yield, int argc, uschar *argv[])
9702 .endd
9703 Where &`uschar`& is a typedef for &`unsigned char`& in &_local_scan.h_&. The
9704 function should return one of the following values:
9705
9706 &`OK`&: Success. The string that is placed in the variable &'yield'& is put
9707 into the expanded string that is being built.
9708
9709 &`FAIL`&: A non-forced expansion failure occurs, with the error message taken
9710 from &'yield'&, if it is set.
9711
9712 &`FAIL_FORCED`&: A forced expansion failure occurs, with the error message
9713 taken from &'yield'& if it is set.
9714
9715 &`ERROR`&: Same as &`FAIL`&, except that a panic log entry is written.
9716
9717 When compiling a function that is to be used in this way with gcc,
9718 you need to add &%-shared%& to the gcc command. Also, in the Exim build-time
9719 configuration, you must add &%-export-dynamic%& to EXTRALIBS.
9720
9721
9722 .vitem "&*${env{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&"
9723 .cindex "expansion" "extracting value from environment"
9724 .cindex "environment" "values from"
9725 The key is first expanded separately, and leading and trailing white space
9726 removed.
9727 This is then searched for as a name in the environment.
9728 If a variable is found then its value is placed in &$value$&
9729 and <&'string1'&> is expanded, otherwise <&'string2'&> is expanded.
9730
9731 Instead of {<&'string2'&>} the word &"fail"& (not in curly brackets) can
9732 appear, for example:
9733 .code
9734 ${env{USER}{$value} fail }
9735 .endd
9736 This forces an expansion failure (see section &<<SECTforexpfai>>&);
9737 {<&'string1'&>} must be present for &"fail"& to be recognized.
9738
9739 If {<&'string2'&>} is omitted an empty string is substituted on
9740 search failure.
9741 If {<&'string1'&>} is omitted the search result is substituted on
9742 search success.
9743
9744 The environment is adjusted by the &%keep_environment%& and
9745 &%add_environment%& main section options.
9746
9747
9748 .vitem "&*${extract{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}&&&
9749        {*&<&'string3'&>&*}}*&"
9750 .cindex "expansion" "extracting substrings by key"
9751 .cindex "&%extract%&" "substrings by key"
9752 The key and <&'string1'&> are first expanded separately. Leading and trailing
9753 white space is removed from the key (but not from any of the strings). The key
9754 must not be empty and must not consist entirely of digits.
9755 The expanded <&'string1'&> must be of the form:
9756 .display
9757 <&'key1'&> = <&'value1'&>  <&'key2'&> = <&'value2'&> ...
9758 .endd
9759 .vindex "&$value$&"
9760 where the equals signs and spaces (but not both) are optional. If any of the
9761 values contain white space, they must be enclosed in double quotes, and any
9762 values that are enclosed in double quotes are subject to escape processing as
9763 described in section &<<SECTstrings>>&. The expanded <&'string1'&> is searched
9764 for the value that corresponds to the key. The search is case-insensitive. If
9765 the key is found, <&'string2'&> is expanded, and replaces the whole item;
9766 otherwise <&'string3'&> is used. During the expansion of <&'string2'&> the
9767 variable &$value$& contains the value that has been extracted. Afterwards, it
9768 is restored to any previous value it might have had.
9769
9770 If {<&'string3'&>} is omitted, the item is replaced by an empty string if the
9771 key is not found. If {<&'string2'&>} is also omitted, the value that was
9772 extracted is used. Thus, for example, these two expansions are identical, and
9773 yield &"2001"&:
9774 .code
9775 ${extract{gid}{uid=1984 gid=2001}}
9776 ${extract{gid}{uid=1984 gid=2001}{$value}}
9777 .endd
9778 Instead of {<&'string3'&>} the word &"fail"& (not in curly brackets) can
9779 appear, for example:
9780 .code
9781 ${extract{Z}{A=... B=...}{$value} fail }
9782 .endd
9783 This forces an expansion failure (see section &<<SECTforexpfai>>&);
9784 {<&'string2'&>} must be present for &"fail"& to be recognized.
9785
9786 .vitem "&*${extract json{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}&&&
9787        {*&<&'string3'&>&*}}*&" &&&
9788        "&*${extract jsons{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}&&&
9789        {*&<&'string3'&>&*}}*&"
9790 .cindex "expansion" "extracting from JSON object"
9791 .cindex JSON expansions
9792 The key and <&'string1'&> are first expanded separately. Leading and trailing
9793 white space is removed from the key (but not from any of the strings). The key
9794 must not be empty and must not consist entirely of digits.
9795 The expanded <&'string1'&> must be of the form:
9796 .display
9797 { <&'"key1"'&> : <&'value1'&> ,  <&'"key2"'&> , <&'value2'&> ... }
9798 .endd
9799 .vindex "&$value$&"
9800 The braces, commas and colons, and the quoting of the member name are required;
9801 the spaces are optional.
9802 Matching of the key against the member names is done case-sensitively.
9803 For the &"json"& variant,
9804 if a returned value is a JSON string, it retains its leading and
9805 trailing quotes.
9806 For the &"jsons"& variant, which is intended for use with JSON strings, the
9807 leading and trailing quotes are removed from the returned value.
9808 . XXX should be a UTF-8 compare
9809
9810 The results of matching are handled as above.
9811
9812
9813 .vitem "&*${extract{*&<&'number'&>&*}{*&<&'separators'&>&*}&&&
9814         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9815 .cindex "expansion" "extracting substrings by number"
9816 .cindex "&%extract%&" "substrings by number"
9817 The <&'number'&> argument must consist entirely of decimal digits,
9818 apart from leading and trailing white space, which is ignored.
9819 This is what distinguishes this form of &%extract%& from the previous kind. It
9820 behaves in the same way, except that, instead of extracting a named field, it
9821 extracts from <&'string1'&> the field whose number is given as the first
9822 argument. You can use &$value$& in <&'string2'&> or &`fail`& instead of
9823 <&'string3'&> as before.
9824
9825 The fields in the string are separated by any one of the characters in the
9826 separator string. These may include space or tab characters.
9827 The first field is numbered one. If the number is negative, the fields are
9828 counted from the end of the string, with the rightmost one numbered -1. If the
9829 number given is zero, the entire string is returned. If the modulus of the
9830 number is greater than the number of fields in the string, the result is the
9831 expansion of <&'string3'&>, or the empty string if <&'string3'&> is not
9832 provided. For example:
9833 .code
9834 ${extract{2}{:}{x:42:99:& Mailer::/bin/bash}}
9835 .endd
9836 yields &"42"&, and
9837 .code
9838 ${extract{-4}{:}{x:42:99:& Mailer::/bin/bash}}
9839 .endd
9840 yields &"99"&. Two successive separators mean that the field between them is
9841 empty (for example, the fifth field above).
9842
9843
9844 .vitem "&*${extract json {*&<&'number'&>&*}}&&&
9845         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&" &&&
9846        "&*${extract jsons{*&<&'number'&>&*}}&&&
9847         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9848 .cindex "expansion" "extracting from JSON array"
9849 .cindex JSON expansions
9850 The <&'number'&> argument must consist entirely of decimal digits,
9851 apart from leading and trailing white space, which is ignored.
9852
9853 Field selection and result handling is as above;
9854 there is no choice of field separator.
9855 For the &"json"& variant,
9856 if a returned value is a JSON string, it retains its leading and
9857 trailing quotes.
9858 For the &"jsons"& variant, which is intended for use with JSON strings, the
9859 leading and trailing quotes are removed from the returned value.
9860
9861
9862 .vitem &*${filter{*&<&'string'&>&*}{*&<&'condition'&>&*}}*&
9863 .cindex "list" "selecting by condition"
9864 .cindex "expansion" "selecting from list by condition"
9865 .vindex "&$item$&"
9866 After expansion, <&'string'&> is interpreted as a list, colon-separated by
9867 default, but the separator can be changed in the usual way (&<<SECTlistsepchange>>&).
9868 For each item
9869 in this list, its value is place in &$item$&, and then the condition is
9870 evaluated. If the condition is true, &$item$& is added to the output as an
9871 item in a new list; if the condition is false, the item is discarded. The
9872 separator used for the output list is the same as the one used for the
9873 input, but a separator setting is not included in the output. For example:
9874 .code
9875 ${filter{a:b:c}{!eq{$item}{b}}}
9876 .endd
9877 yields &`a:c`&. At the end of the expansion, the value of &$item$& is restored
9878 to what it was before. See also the &%map%& and &%reduce%& expansion items.
9879
9880
9881 .vitem &*${hash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9882 .cindex "hash function" "textual"
9883 .cindex "expansion" "textual hash"
9884 This is a textual hashing function, and was the first to be implemented in
9885 early versions of Exim. In current releases, there are other hashing functions
9886 (numeric, MD5, and SHA-1), which are described below.
9887
9888 The first two strings, after expansion, must be numbers. Call them <&'m'&> and
9889 <&'n'&>. If you are using fixed values for these numbers, that is, if
9890 <&'string1'&> and <&'string2'&> do not change when they are expanded, you can
9891 use the simpler operator notation that avoids some of the braces:
9892 .code
9893 ${hash_<n>_<m>:<string>}
9894 .endd
9895 The second number is optional (in both notations). If <&'n'&> is greater than
9896 or equal to the length of the string, the expansion item returns the string.
9897 Otherwise it computes a new string of length <&'n'&> by applying a hashing
9898 function to the string. The new string consists of characters taken from the
9899 first <&'m'&> characters of the string
9900 .code
9901 abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQWRSTUVWXYZ0123456789
9902 .endd
9903 If <&'m'&> is not present the value 26 is used, so that only lower case
9904 letters appear. For example:
9905 .display
9906 &`$hash{3}{monty}}           `&   yields  &`jmg`&
9907 &`$hash{5}{monty}}           `&   yields  &`monty`&
9908 &`$hash{4}{62}{monty python}}`&   yields  &`fbWx`&
9909 .endd
9910
9911 .vitem "&*$header_*&<&'header&~name'&>&*:*&&~or&~&&&
9912         &*$h_*&<&'header&~name'&>&*:*&" &&&
9913        "&*$bheader_*&<&'header&~name'&>&*:*&&~or&~&&&
9914         &*$bh_*&<&'header&~name'&>&*:*&" &&&
9915        "&*$lheader_*&<&'header&~name'&>&*:*&&~or&~&&&
9916         &*$lh_*&<&'header&~name'&>&*:*&" &&&
9917        "&*$rheader_*&<&'header&~name'&>&*:*&&~or&~&&&
9918         &*$rh_*&<&'header&~name'&>&*:*&"
9919 .cindex "expansion" "header insertion"
9920 .vindex "&$header_$&"
9921 .vindex "&$bheader_$&"
9922 .vindex "&$lheader_$&"
9923 .vindex "&$rheader_$&"
9924 .cindex "header lines" "in expansion strings"
9925 .cindex "header lines" "character sets"
9926 .cindex "header lines" "decoding"
9927 Substitute the contents of the named message header line, for example
9928 .code
9929 $header_reply-to:
9930 .endd
9931 The newline that terminates a header line is not included in the expansion, but
9932 internal newlines (caused by splitting the header line over several physical
9933 lines) may be present.
9934
9935 The difference between the four pairs of expansions is in the way
9936 the data in the header line is interpreted.
9937
9938 .ilist
9939 .cindex "white space" "in header lines"
9940 &%rheader%& gives the original &"raw"& content of the header line, with no
9941 processing at all, and without the removal of leading and trailing white space.
9942
9943 .next
9944 .cindex "list" "of header lines"
9945 &%lheader%& gives a colon-separated list, one element per header when there
9946 are multiple headers with a given name.
9947 Any embedded colon characters within an element are doubled, so normal Exim
9948 list-processing facilities can be used.
9949 The terminating newline of each element is removed; in other respects
9950 the content is &"raw"&.
9951
9952 .next
9953 .cindex "base64 encoding" "in header lines"
9954 &%bheader%& removes leading and trailing white space, and then decodes base64
9955 or quoted-printable MIME &"words"& within the header text, but does no
9956 character set translation. If decoding of what looks superficially like a MIME
9957 &"word"& fails, the raw string is returned. If decoding
9958 .cindex "binary zero" "in header line"
9959 produces a binary zero character, it is replaced by a question mark &-- this is
9960 what Exim does for binary zeros that are actually received in header lines.
9961
9962 .next
9963 &%header%& tries to translate the string as decoded by &%bheader%& to a
9964 standard character set. This is an attempt to produce the same string as would
9965 be displayed on a user's MUA. If translation fails, the &%bheader%& string is
9966 returned. Translation is attempted only on operating systems that support the
9967 &[iconv()]& function. This is indicated by the compile-time macro HAVE_ICONV in
9968 a system Makefile or in &_Local/Makefile_&.
9969 .endlist ilist
9970
9971 In a filter file, the target character set for &%header%& can be specified by a
9972 command of the following form:
9973 .code
9974 headers charset "UTF-8"
9975 .endd
9976 This command affects all references to &$h_$& (or &$header_$&) expansions in
9977 subsequently obeyed filter commands. In the absence of this command, the target
9978 character set in a filter is taken from the setting of the &%headers_charset%&
9979 option in the runtime configuration. The value of this option defaults to the
9980 value of HEADERS_CHARSET in &_Local/Makefile_&. The ultimate default is
9981 ISO-8859-1.
9982
9983 Header names follow the syntax of RFC 2822, which states that they may contain
9984 any printing characters except space and colon. Consequently, curly brackets
9985 &'do not'& terminate header names, and should not be used to enclose them as
9986 if they were variables. Attempting to do so causes a syntax error.
9987
9988 Only header lines that are common to all copies of a message are visible to
9989 this mechanism. These are the original header lines that are received with the
9990 message, and any that are added by an ACL statement or by a system
9991 filter. Header lines that are added to a particular copy of a message by a
9992 router or transport are not accessible.
9993
9994 For incoming SMTP messages, no header lines are visible in
9995 ACLs that are obeyed before the data phase completes,
9996 because the header structure is not set up until the message is received.
9997 They are visible in DKIM, PRDR and DATA ACLs.
9998 Header lines that are added in a RCPT ACL (for example)
9999 are saved until the message's incoming header lines are available, at which
10000 point they are added.
10001 When any of the above ACLs ar
10002 running, however, header lines added by earlier ACLs are visible.
10003
10004 Upper case and lower case letters are synonymous in header names. If the
10005 following character is white space, the terminating colon may be omitted, but
10006 this is not recommended, because you may then forget it when it is needed. When
10007 white space terminates the header name, this white space is included in the
10008 expanded string.  If the message does not contain the given header, the
10009 expansion item is replaced by an empty string. (See the &%def%& condition in
10010 section &<<SECTexpcond>>& for a means of testing for the existence of a
10011 header.)
10012
10013 If there is more than one header with the same name, they are all concatenated
10014 to form the substitution string, up to a maximum length of 64K. Unless
10015 &%rheader%& is being used, leading and trailing white space is removed from
10016 each header before concatenation, and a completely empty header is ignored. A
10017 newline character is then inserted between non-empty headers, but there is no
10018 newline at the very end. For the &%header%& and &%bheader%& expansion, for
10019 those headers that contain lists of addresses, a comma is also inserted at the
10020 junctions between headers. This does not happen for the &%rheader%& expansion.
10021
10022 .new
10023 .cindex "tainted data"
10024 When the headers are from an incoming message,
10025 the result of expanding any of these variables is tainted.
10026 .wen
10027
10028
10029 .vitem &*${hmac{*&<&'hashname'&>&*}{*&<&'secret'&>&*}{*&<&'string'&>&*}}*&
10030 .cindex "expansion" "hmac hashing"
10031 .cindex &%hmac%&
10032 This function uses cryptographic hashing (either MD5 or SHA-1) to convert a
10033 shared secret and some text into a message authentication code, as specified in
10034 RFC 2104. This differs from &`${md5:secret_text...}`& or
10035 &`${sha1:secret_text...}`& in that the hmac step adds a signature to the
10036 cryptographic hash, allowing for authentication that is not possible with MD5
10037 or SHA-1 alone. The hash name must expand to either &`md5`& or &`sha1`& at
10038 present. For example:
10039 .code
10040 ${hmac{md5}{somesecret}{$primary_hostname $tod_log}}
10041 .endd
10042 For the hostname &'mail.example.com'& and time 2002-10-17 11:30:59, this
10043 produces:
10044 .code
10045 dd97e3ba5d1a61b5006108f8c8252953
10046 .endd
10047 As an example of how this might be used, you might put in the main part of
10048 an Exim configuration:
10049 .code
10050 SPAMSCAN_SECRET=cohgheeLei2thahw
10051 .endd
10052 In a router or a transport you could then have:
10053 .code
10054 headers_add = \
10055   X-Spam-Scanned: ${primary_hostname} ${message_exim_id} \
10056   ${hmac{md5}{SPAMSCAN_SECRET}\
10057   {${primary_hostname},${message_exim_id},$h_message-id:}}
10058 .endd
10059 Then given a message, you can check where it was scanned by looking at the
10060 &'X-Spam-Scanned:'& header line. If you know the secret, you can check that
10061 this header line is authentic by recomputing the authentication code from the
10062 host name, message ID and the &'Message-id:'& header line. This can be done
10063 using Exim's &%-be%& option, or by other means, for example, by using the
10064 &'hmac_md5_hex()'& function in Perl.
10065
10066
10067 .vitem &*${if&~*&<&'condition'&>&*&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
10068 .cindex "expansion" "conditional"
10069 .cindex "&%if%&, expansion item"
10070 If <&'condition'&> is true, <&'string1'&> is expanded and replaces the whole
10071 item; otherwise <&'string2'&> is used. The available conditions are described
10072 in section &<<SECTexpcond>>& below. For example:
10073 .code
10074 ${if eq {$local_part}{postmaster} {yes}{no} }
10075 .endd
10076 The second string need not be present; if it is not and the condition is not
10077 true, the item is replaced with nothing. Alternatively, the word &"fail"& may
10078 be present instead of the second string (without any curly brackets). In this
10079 case, the expansion is forced to fail if the condition is not true (see section
10080 &<<SECTforexpfai>>&).
10081
10082 If both strings are omitted, the result is the string &`true`& if the condition
10083 is true, and the empty string if the condition is false. This makes it less
10084 cumbersome to write custom ACL and router conditions. For example, instead of
10085 .code
10086 condition = ${if >{$acl_m4}{3}{true}{false}}
10087 .endd
10088 you can use
10089 .code
10090 condition = ${if >{$acl_m4}{3}}
10091 .endd
10092
10093
10094
10095 .vitem &*${imapfolder{*&<&'foldername'&>&*}}*&
10096 .cindex expansion "imap folder"
10097 .cindex "&%imapfolder%& expansion item"
10098 This item converts a (possibly multilevel, or with non-ASCII characters)
10099 folder specification to a Maildir name for filesystem use.
10100 For information on internationalisation support see &<<SECTi18nMDA>>&.
10101
10102
10103
10104 .vitem &*${length{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
10105 .cindex "expansion" "string truncation"
10106 .cindex "&%length%& expansion item"
10107 The &%length%& item is used to extract the initial portion of a string. Both
10108 strings are expanded, and the first one must yield a number, <&'n'&>, say. If
10109 you are using a fixed value for the number, that is, if <&'string1'&> does not
10110 change when expanded, you can use the simpler operator notation that avoids
10111 some of the braces:
10112 .code
10113 ${length_<n>:<string>}
10114 .endd
10115 The result of this item is either the first <&'n'&> bytes or the whole
10116 of <&'string2'&>, whichever is the shorter. Do not confuse &%length%& with
10117 &%strlen%&, which gives the length of a string.
10118 All measurement is done in bytes and is not UTF-8 aware.
10119
10120
10121 .vitem "&*${listextract{*&<&'number'&>&*}&&&
10122         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
10123 .cindex "expansion" "extracting list elements by number"
10124 .cindex "&%listextract%&" "extract list elements by number"
10125 .cindex "list" "extracting elements by number"
10126 The <&'number'&> argument must consist entirely of decimal digits,
10127 apart from an optional leading minus,
10128 and leading and trailing white space (which is ignored).
10129
10130 After expansion, <&'string1'&> is interpreted as a list, colon-separated by
10131 default, but the separator can be changed in the usual way (&<<SECTlistsepchange>>&).
10132
10133 The first field of the list is numbered one.
10134 If the number is negative, the fields are
10135 counted from the end of the list, with the rightmost one numbered -1.
10136 The numbered element of the list is extracted and placed in &$value$&,
10137 then <&'string2'&> is expanded as the result.
10138
10139 If the modulus of the
10140 number is zero or greater than the number of fields in the string,
10141 the result is the expansion of <&'string3'&>.
10142
10143 For example:
10144 .code
10145 ${listextract{2}{x:42:99}}
10146 .endd
10147 yields &"42"&, and
10148 .code
10149 ${listextract{-3}{<, x,42,99,& Mailer,,/bin/bash}{result: $value}}
10150 .endd
10151 yields &"result: 42"&.
10152
10153 If {<&'string3'&>} is omitted, an empty string is used for string3.
10154 If {<&'string2'&>} is also omitted, the value that was
10155 extracted is used.
10156 You can use &`fail`& instead of {<&'string3'&>} as in a string extract.
10157
10158
10159 .vitem "&*${lookup{*&<&'key'&>&*}&~*&<&'search&~type'&>&*&~&&&
10160         {*&<&'file'&>&*}&~{*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&"
10161 This is the first of one of two different types of lookup item, which are both
10162 described in the next item.
10163
10164 .vitem "&*${lookup&~*&<&'search&~type'&>&*&~{*&<&'query'&>&*}&~&&&
10165         {*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&"
10166 .cindex "expansion" "lookup in"
10167 .cindex "file" "lookups"
10168 .cindex "lookup" "in expanded string"
10169 The two forms of lookup item specify data lookups in files and databases, as
10170 discussed in chapter &<<CHAPfdlookup>>&. The first form is used for single-key
10171 lookups, and the second is used for query-style lookups. The <&'key'&>,
10172 <&'file'&>, and <&'query'&> strings are expanded before use.
10173
10174 If there is any white space in a lookup item which is part of a filter command,
10175 a retry or rewrite rule, a routing rule for the &(manualroute)& router, or any
10176 other place where white space is significant, the lookup item must be enclosed
10177 in double quotes. The use of data lookups in users' filter files may be locked
10178 out by the system administrator.
10179
10180 .vindex "&$value$&"
10181 If the lookup succeeds, <&'string1'&> is expanded and replaces the entire item.
10182 During its expansion, the variable &$value$& contains the data returned by the
10183 lookup. Afterwards it reverts to the value it had previously (at the outer
10184 level it is empty). If the lookup fails, <&'string2'&> is expanded and replaces
10185 the entire item. If {<&'string2'&>} is omitted, the replacement is the empty
10186 string on failure. If <&'string2'&> is provided, it can itself be a nested
10187 lookup, thus providing a mechanism for looking up a default value when the
10188 original lookup fails.
10189
10190 If a nested lookup is used as part of <&'string1'&>, &$value$& contains the
10191 data for the outer lookup while the parameters of the second lookup are
10192 expanded, and also while <&'string2'&> of the second lookup is expanded, should
10193 the second lookup fail. Instead of {<&'string2'&>} the word &"fail"& can
10194 appear, and in this case, if the lookup fails, the entire expansion is forced
10195 to fail (see section &<<SECTforexpfai>>&). If both {<&'string1'&>} and
10196 {<&'string2'&>} are omitted, the result is the looked up value in the case of a
10197 successful lookup, and nothing in the case of failure.
10198
10199 For single-key lookups, the string &"partial"& is permitted to precede the
10200 search type in order to do partial matching, and * or *@ may follow a search
10201 type to request default lookups if the key does not match (see sections
10202 &<<SECTdefaultvaluelookups>>& and &<<SECTpartiallookup>>& for details).
10203
10204 .cindex "numerical variables (&$1$& &$2$& etc)" "in lookup expansion"
10205 If a partial search is used, the variables &$1$& and &$2$& contain the wild
10206 and non-wild parts of the key during the expansion of the replacement text.
10207 They return to their previous values at the end of the lookup item.
10208
10209 This example looks up the postmaster alias in the conventional alias file:
10210 .code
10211 ${lookup {postmaster} lsearch {/etc/aliases} {$value}}
10212 .endd
10213 This example uses NIS+ to look up the full name of the user corresponding to
10214 the local part of an address, forcing the expansion to fail if it is not found:
10215 .code
10216 ${lookup nisplus {[name=$local_part],passwd.org_dir:gcos} \
10217   {$value}fail}
10218 .endd
10219
10220
10221 .vitem &*${map{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
10222 .cindex "expansion" "list creation"
10223 .vindex "&$item$&"
10224 After expansion, <&'string1'&> is interpreted as a list, colon-separated by
10225 default, but the separator can be changed in the usual way (&<<SECTlistsepchange>>&).
10226 For each item
10227 in this list, its value is place in &$item$&, and then <&'string2'&> is
10228 expanded and added to the output as an item in a new list. The separator used
10229 for the output list is the same as the one used for the input, but a separator
10230 setting is not included in the output. For example:
10231 .code
10232 ${map{a:b:c}{[$item]}} ${map{<- x-y-z}{($item)}}
10233 .endd
10234 expands to &`[a]:[b]:[c] (x)-(y)-(z)`&. At the end of the expansion, the
10235 value of &$item$& is restored to what it was before. See also the &%filter%&
10236 and &%reduce%& expansion items.
10237
10238 .vitem &*${nhash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
10239 .cindex "expansion" "numeric hash"
10240 .cindex "hash function" "numeric"
10241 The three strings are expanded; the first two must yield numbers. Call them
10242 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
10243 if <&'string1'&> and <&'string2'&> do not change when they are expanded, you
10244 can use the simpler operator notation that avoids some of the braces:
10245 .code
10246 ${nhash_<n>_<m>:<string>}
10247 .endd
10248 The second number is optional (in both notations). If there is only one number,
10249 the result is a number in the range 0&--<&'n'&>-1. Otherwise, the string is
10250 processed by a div/mod hash function that returns two numbers, separated by a
10251 slash, in the ranges 0 to <&'n'&>-1 and 0 to <&'m'&>-1, respectively. For
10252 example,
10253 .code
10254 ${nhash{8}{64}{supercalifragilisticexpialidocious}}
10255 .endd
10256 returns the string &"6/33"&.
10257
10258
10259
10260 .vitem &*${perl{*&<&'subroutine'&>&*}{*&<&'arg'&>&*}{*&<&'arg'&>&*}...}*&
10261 .cindex "Perl" "use in expanded string"
10262 .cindex "expansion" "calling Perl from"
10263 This item is available only if Exim has been built to include an embedded Perl
10264 interpreter. The subroutine name and the arguments are first separately
10265 expanded, and then the Perl subroutine is called with those arguments. No
10266 additional arguments need be given; the maximum number permitted, including the
10267 name of the subroutine, is nine.
10268
10269 The return value of the subroutine is inserted into the expanded string, unless
10270 the return value is &%undef%&. In that case, the expansion fails in the same
10271 way as an explicit &"fail"& on a lookup item. The return value is a scalar.
10272 Whatever you return is evaluated in a scalar context. For example, if you
10273 return the name of a Perl vector, the return value is the size of the vector,
10274 not its contents.
10275
10276 If the subroutine exits by calling Perl's &%die%& function, the expansion fails
10277 with the error message that was passed to &%die%&. More details of the embedded
10278 Perl facility are given in chapter &<<CHAPperl>>&.
10279
10280 The &(redirect)& router has an option called &%forbid_filter_perl%& which locks
10281 out the use of this expansion item in filter files.
10282
10283
10284 .vitem &*${prvs{*&<&'address'&>&*}{*&<&'secret'&>&*}{*&<&'keynumber'&>&*}}*&
10285 .cindex "&%prvs%& expansion item"
10286 The first argument is a complete email address and the second is secret
10287 keystring. The third argument, specifying a key number, is optional. If absent,
10288 it defaults to 0. The result of the expansion is a prvs-signed email address,
10289 to be typically used with the &%return_path%& option on an &(smtp)& transport
10290 as part of a bounce address tag validation (BATV) scheme. For more discussion
10291 and an example, see section &<<SECTverifyPRVS>>&.
10292
10293 .vitem "&*${prvscheck{*&<&'address'&>&*}{*&<&'secret'&>&*}&&&
10294         {*&<&'string'&>&*}}*&"
10295 .cindex "&%prvscheck%& expansion item"
10296 This expansion item is the complement of the &%prvs%& item. It is used for
10297 checking prvs-signed addresses. If the expansion of the first argument does not
10298 yield a syntactically valid prvs-signed address, the whole item expands to the
10299 empty string. When the first argument does expand to a syntactically valid
10300 prvs-signed address, the second argument is expanded, with the prvs-decoded
10301 version of the address and the key number extracted from the address in the
10302 variables &$prvscheck_address$& and &$prvscheck_keynum$&, respectively.
10303
10304 These two variables can be used in the expansion of the second argument to
10305 retrieve the secret. The validity of the prvs-signed address is then checked
10306 against the secret. The result is stored in the variable &$prvscheck_result$&,
10307 which is empty for failure or &"1"& for success.
10308
10309 The third argument is optional; if it is missing, it defaults to an empty
10310 string. This argument is now expanded. If the result is an empty string, the
10311 result of the expansion is the decoded version of the address. This is the case
10312 whether or not the signature was valid. Otherwise, the result of the expansion
10313 is the expansion of the third argument.
10314
10315 All three variables can be used in the expansion of the third argument.
10316 However, once the expansion is complete, only &$prvscheck_result$& remains set.
10317 For more discussion and an example, see section &<<SECTverifyPRVS>>&.
10318
10319 .vitem &*${readfile{*&<&'file&~name'&>&*}{*&<&'eol&~string'&>&*}}*&
10320 .cindex "expansion" "inserting an entire file"
10321 .cindex "file" "inserting into expansion"
10322 .cindex "&%readfile%& expansion item"
10323 The filename and end-of-line string are first expanded separately. The file is
10324 then read, and its contents replace the entire item. All newline characters in
10325 the file are replaced by the end-of-line string if it is present. Otherwise,
10326 newlines are left in the string.
10327 String expansion is not applied to the contents of the file. If you want this,
10328 you must wrap the item in an &%expand%& operator. If the file cannot be read,
10329 the string expansion fails.
10330
10331 The &(redirect)& router has an option called &%forbid_filter_readfile%& which
10332 locks out the use of this expansion item in filter files.
10333
10334
10335
10336 .vitem "&*${readsocket{*&<&'name'&>&*}{*&<&'request'&>&*}&&&
10337         {*&<&'options'&>&*}{*&<&'eol&~string'&>&*}{*&<&'fail&~string'&>&*}}*&"
10338 .cindex "expansion" "inserting from a socket"
10339 .cindex "socket, use of in expansion"
10340 .cindex "&%readsocket%& expansion item"
10341 This item inserts data from a Unix domain or TCP socket into the expanded
10342 string. The minimal way of using it uses just two arguments, as in these
10343 examples:
10344 .code
10345 ${readsocket{/socket/name}{request string}}
10346 ${readsocket{inet:some.host:1234}{request string}}
10347 .endd
10348 For a Unix domain socket, the first substring must be the path to the socket.
10349 For an Internet socket, the first substring must contain &`inet:`& followed by
10350 a host name or IP address, followed by a colon and a port, which can be a
10351 number or the name of a TCP port in &_/etc/services_&. An IP address may
10352 optionally be enclosed in square brackets. This is best for IPv6 addresses. For
10353 example:
10354 .code
10355 ${readsocket{inet:[::1]:1234}{request string}}
10356 .endd
10357 Only a single host name may be given, but if looking it up yields more than
10358 one IP address, they are each tried in turn until a connection is made. For
10359 both kinds of socket, Exim makes a connection, writes the request string
10360 unless it is an empty string; and no terminating NUL is ever sent)
10361 and reads from the socket until an end-of-file
10362 is read. A timeout of 5 seconds is applied. Additional, optional arguments
10363 extend what can be done. Firstly, you can vary the timeout. For example:
10364 .code
10365 ${readsocket{/socket/name}{request string}{3s}}
10366 .endd
10367
10368 The third argument is a list of options, of which the first element is the timeout
10369 and must be present if any options are given.
10370 Further elements are options of form &'name=value'&.
10371 Example:
10372 .code
10373 ${readsocket{/socket/name}{request string}{3s:shutdown=no}}
10374 .endd
10375
10376 .new
10377 The following option names are recognised:
10378 .ilist
10379 &*cache*&
10380 Defines if the result data can be cached for use by a later identical
10381 request in the same process.
10382 Values are &"yes"& or &"no"& (the default).
10383 If not, all cached results for this connection specification
10384 will be invalidated.
10385
10386 .next
10387 &*shutdown*&
10388 Defines whether or not a write-shutdown is done on the connection after
10389 sending the request. Values are &"yes"& (the default) or &"no"&
10390 (preferred, eg. by some webservers).
10391
10392 .next
10393 &*tls*&
10394 Controls the use of TLS on the connection.
10395 Values are &"yes"& or &"no"& (the default).
10396 If it is enabled, a shutdown as descripbed above is never done.
10397 .endlist
10398 .wen
10399
10400
10401 A fourth argument allows you to change any newlines that are in the data
10402 that is read, in the same way as for &%readfile%& (see above). This example
10403 turns them into spaces:
10404 .code
10405 ${readsocket{inet:127.0.0.1:3294}{request string}{3s}{ }}
10406 .endd
10407 As with all expansions, the substrings are expanded before the processing
10408 happens. Errors in these sub-expansions cause the expansion to fail. In
10409 addition, the following errors can occur:
10410
10411 .ilist
10412 Failure to create a socket file descriptor;
10413 .next
10414 Failure to connect the socket;
10415 .next
10416 Failure to write the request string;
10417 .next
10418 Timeout on reading from the socket.
10419 .endlist
10420
10421 By default, any of these errors causes the expansion to fail. However, if
10422 you supply a fifth substring, it is expanded and used when any of the above
10423 errors occurs. For example:
10424 .code
10425 ${readsocket{/socket/name}{request string}{3s}{\n}\
10426   {socket failure}}
10427 .endd
10428 You can test for the existence of a Unix domain socket by wrapping this
10429 expansion in &`${if exists`&, but there is a race condition between that test
10430 and the actual opening of the socket, so it is safer to use the fifth argument
10431 if you want to be absolutely sure of avoiding an expansion error for a
10432 non-existent Unix domain socket, or a failure to connect to an Internet socket.
10433
10434 The &(redirect)& router has an option called &%forbid_filter_readsocket%& which
10435 locks out the use of this expansion item in filter files.
10436
10437
10438 .vitem &*${reduce{*&<&'string1'&>}{<&'string2'&>&*}{*&<&'string3'&>&*}}*&
10439 .cindex "expansion" "reducing a list to a scalar"
10440 .cindex "list" "reducing to a scalar"
10441 .vindex "&$value$&"
10442 .vindex "&$item$&"
10443 This operation reduces a list to a single, scalar string. After expansion,
10444 <&'string1'&> is interpreted as a list, colon-separated by default, but the
10445 separator can be changed in the usual way (&<<SECTlistsepchange>>&).
10446 Then <&'string2'&> is expanded and
10447 assigned to the &$value$& variable. After this, each item in the <&'string1'&>
10448 list is assigned to &$item$&, in turn, and <&'string3'&> is expanded for each of
10449 them. The result of that expansion is assigned to &$value$& before the next
10450 iteration. When the end of the list is reached, the final value of &$value$& is
10451 added to the expansion output. The &%reduce%& expansion item can be used in a
10452 number of ways. For example, to add up a list of numbers:
10453 .code
10454 ${reduce {<, 1,2,3}{0}{${eval:$value+$item}}}
10455 .endd
10456 The result of that expansion would be &`6`&. The maximum of a list of numbers
10457 can be found:
10458 .code
10459 ${reduce {3:0:9:4:6}{0}{${if >{$item}{$value}{$item}{$value}}}}
10460 .endd
10461 At the end of a &*reduce*& expansion, the values of &$item$& and &$value$& are
10462 restored to what they were before. See also the &%filter%& and &%map%&
10463 expansion items.
10464
10465 .vitem &*$rheader_*&<&'header&~name'&>&*:*&&~or&~&*$rh_*&<&'header&~name'&>&*:*&
10466 This item inserts &"raw"& header lines. It is described with the &%header%&
10467 expansion item in section &<<SECTexpansionitems>>& above.
10468
10469 .vitem "&*${run{*&<&'command'&>&*&~*&<&'args'&>&*}{*&<&'string1'&>&*}&&&
10470         {*&<&'string2'&>&*}}*&"
10471 .cindex "expansion" "running a command"
10472 .cindex "&%run%& expansion item"
10473 The command and its arguments are first expanded as one string. The string is
10474 split apart into individual arguments by spaces, and then the command is run
10475 in a separate process, but under the same uid and gid.  As in other command
10476 executions from Exim, a shell is not used by default. If the command requires
10477 a shell, you must explicitly code it.
10478
10479 Since the arguments are split by spaces, when there is a variable expansion
10480 which has an empty result, it will cause the situation that the argument will
10481 simply be omitted when the program is actually executed by Exim. If the
10482 script/program requires a specific number of arguments and the expanded
10483 variable could possibly result in this empty expansion, the variable must be
10484 quoted. This is more difficult if the expanded variable itself could result
10485 in a string containing quotes, because it would interfere with the quotes
10486 around the command arguments. A possible guard against this is to wrap the
10487 variable in the &%sg%& operator to change any quote marks to some other
10488 character.
10489
10490 The standard input for the command exists, but is empty. The standard output
10491 and standard error are set to the same file descriptor.
10492 .cindex "return code" "from &%run%& expansion"
10493 .vindex "&$value$&"
10494 If the command succeeds (gives a zero return code) <&'string1'&> is expanded
10495 and replaces the entire item; during this expansion, the standard output/error
10496 from the command is in the variable &$value$&. If the command fails,
10497 <&'string2'&>, if present, is expanded and used. Once again, during the
10498 expansion, the standard output/error from the command is in the variable
10499 &$value$&.
10500
10501 If <&'string2'&> is absent, the result is empty. Alternatively, <&'string2'&>
10502 can be the word &"fail"& (not in braces) to force expansion failure if the
10503 command does not succeed. If both strings are omitted, the result is contents
10504 of the standard output/error on success, and nothing on failure.
10505
10506 .vindex "&$run_in_acl$&"
10507 The standard output/error of the command is put in the variable &$value$&.
10508 In this ACL example, the output of a command is logged for the admin to
10509 troubleshoot:
10510 .code
10511 warn  condition    = ${run{/usr/bin/id}{yes}{no}}
10512       log_message  = Output of id: $value
10513 .endd
10514 If the command requires shell idioms, such as the > redirect operator, the
10515 shell must be invoked directly, such as with:
10516 .code
10517 ${run{/bin/bash -c "/usr/bin/id >/tmp/id"}{yes}{yes}}
10518 .endd
10519
10520 .vindex "&$runrc$&"
10521 The return code from the command is put in the variable &$runrc$&, and this
10522 remains set afterwards, so in a filter file you can do things like this:
10523 .code
10524 if "${run{x y z}{}}$runrc" is 1 then ...
10525   elif $runrc is 2 then ...
10526   ...
10527 endif
10528 .endd
10529 If execution of the command fails (for example, the command does not exist),
10530 the return code is 127 &-- the same code that shells use for non-existent
10531 commands.
10532
10533 &*Warning*&: In a router or transport, you cannot assume the order in which
10534 option values are expanded, except for those preconditions whose order of
10535 testing is documented. Therefore, you cannot reliably expect to set &$runrc$&
10536 by the expansion of one option, and use it in another.
10537
10538 The &(redirect)& router has an option called &%forbid_filter_run%& which locks
10539 out the use of this expansion item in filter files.
10540
10541
10542 .vitem &*${sg{*&<&'subject'&>&*}{*&<&'regex'&>&*}{*&<&'replacement'&>&*}}*&
10543 .cindex "expansion" "string substitution"
10544 .cindex "&%sg%& expansion item"
10545 This item works like Perl's substitution operator (s) with the global (/g)
10546 option; hence its name. However, unlike the Perl equivalent, Exim does not
10547 modify the subject string; instead it returns the modified string for insertion
10548 into the overall expansion. The item takes three arguments: the subject string,
10549 a regular expression, and a substitution string. For example:
10550 .code
10551 ${sg{abcdefabcdef}{abc}{xyz}}
10552 .endd
10553 yields &"xyzdefxyzdef"&. Because all three arguments are expanded before use,
10554 if any $, } or \ characters are required in the regular expression or in the
10555 substitution string, they have to be escaped. For example:
10556 .code
10557 ${sg{abcdef}{^(...)(...)\$}{\$2\$1}}
10558 .endd
10559 yields &"defabc"&, and
10560 .code
10561 ${sg{1=A 4=D 3=C}{\N(\d+)=\N}{K\$1=}}
10562 .endd
10563 yields &"K1=A K4=D K3=C"&. Note the use of &`\N`& to protect the contents of
10564 the regular expression from string expansion.
10565
10566 The regular expression is compiled in 8-bit mode, working against bytes
10567 rather than any Unicode-aware character handling.
10568
10569
10570 .vitem &*${sort{*&<&'string'&>&*}{*&<&'comparator'&>&*}{*&<&'extractor'&>&*}}*&
10571 .cindex sorting "a list"
10572 .cindex list sorting
10573 .cindex expansion "list sorting"
10574 After expansion, <&'string'&> is interpreted as a list, colon-separated by
10575 default, but the separator can be changed in the usual way (&<<SECTlistsepchange>>&).
10576 The <&'comparator'&> argument is interpreted as the operator
10577 of a two-argument expansion condition.
10578 The numeric operators plus ge, gt, le, lt (and ~i variants) are supported.
10579 The comparison should return true when applied to two values
10580 if the first value should sort before the second value.
10581 The <&'extractor'&> expansion is applied repeatedly to elements of the list,
10582 the element being placed in &$item$&,
10583 to give values for comparison.
10584
10585 The item result is a sorted list,
10586 with the original list separator,
10587 of the list elements (in full) of the original.
10588
10589 Examples:
10590 .code
10591 ${sort{3:2:1:4}{<}{$item}}
10592 .endd
10593 sorts a list of numbers, and
10594 .code
10595 ${sort {${lookup dnsdb{>:,,mx=example.com}}} {<} {${listextract{1}{<,$item}}}}
10596 .endd
10597 will sort an MX lookup into priority order.
10598
10599
10600 .vitem &*${substr{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
10601 .cindex "&%substr%& expansion item"
10602 .cindex "substring extraction"
10603 .cindex "expansion" "substring extraction"
10604 The three strings are expanded; the first two must yield numbers. Call them
10605 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
10606 if <&'string1'&> and <&'string2'&> do not change when they are expanded, you
10607 can use the simpler operator notation that avoids some of the braces:
10608 .code
10609 ${substr_<n>_<m>:<string>}
10610 .endd
10611 The second number is optional (in both notations).
10612 If it is absent in the simpler format, the preceding underscore must also be
10613 omitted.
10614
10615 The &%substr%& item can be used to extract more general substrings than
10616 &%length%&. The first number, <&'n'&>, is a starting offset, and <&'m'&> is the
10617 length required. For example
10618 .code
10619 ${substr{3}{2}{$local_part}}
10620 .endd
10621 If the starting offset is greater than the string length the result is the
10622 null string; if the length plus starting offset is greater than the string
10623 length, the result is the right-hand part of the string, starting from the
10624 given offset. The first byte (character) in the string has offset zero.
10625
10626 The &%substr%& expansion item can take negative offset values to count
10627 from the right-hand end of its operand. The last byte (character) is offset -1,
10628 the second-last is offset -2, and so on. Thus, for example,
10629 .code
10630 ${substr{-5}{2}{1234567}}
10631 .endd
10632 yields &"34"&. If the absolute value of a negative offset is greater than the
10633 length of the string, the substring starts at the beginning of the string, and
10634 the length is reduced by the amount of overshoot. Thus, for example,
10635 .code
10636 ${substr{-5}{2}{12}}
10637 .endd
10638 yields an empty string, but
10639 .code
10640 ${substr{-3}{2}{12}}
10641 .endd
10642 yields &"1"&.
10643
10644 When the second number is omitted from &%substr%&, the remainder of the string
10645 is taken if the offset is positive. If it is negative, all bytes (characters) in the
10646 string preceding the offset point are taken. For example, an offset of -1 and
10647 no length, as in these semantically identical examples:
10648 .code
10649 ${substr_-1:abcde}
10650 ${substr{-1}{abcde}}
10651 .endd
10652 yields all but the last character of the string, that is, &"abcd"&.
10653
10654 All measurement is done in bytes and is not UTF-8 aware.
10655
10656
10657
10658 .vitem "&*${tr{*&<&'subject'&>&*}{*&<&'characters'&>&*}&&&
10659         {*&<&'replacements'&>&*}}*&"
10660 .cindex "expansion" "character translation"
10661 .cindex "&%tr%& expansion item"
10662 This item does single-character (in bytes) translation on its subject string. The second
10663 argument is a list of characters to be translated in the subject string. Each
10664 matching character is replaced by the corresponding character from the
10665 replacement list. For example
10666 .code
10667 ${tr{abcdea}{ac}{13}}
10668 .endd
10669 yields &`1b3de1`&. If there are duplicates in the second character string, the
10670 last occurrence is used. If the third string is shorter than the second, its
10671 last character is replicated. However, if it is empty, no translation takes
10672 place.
10673
10674 All character handling is done in bytes and is not UTF-8 aware.
10675
10676 .endlist
10677
10678
10679
10680 .section "Expansion operators" "SECTexpop"
10681 .cindex "expansion" "operators"
10682 For expansion items that perform transformations on a single argument string,
10683 the &"operator"& notation is used because it is simpler and uses fewer braces.
10684 The substring is first expanded before the operation is applied to it. The
10685 following operations can be performed:
10686
10687 .vlist
10688 .vitem &*${address:*&<&'string'&>&*}*&
10689 .cindex "expansion" "RFC 2822 address handling"
10690 .cindex "&%address%& expansion item"
10691 The string is interpreted as an RFC 2822 address, as it might appear in a
10692 header line, and the effective address is extracted from it. If the string does
10693 not parse successfully, the result is empty.
10694
10695 The parsing correctly handles SMTPUTF8 Unicode in the string.
10696
10697
10698 .vitem &*${addresses:*&<&'string'&>&*}*&
10699 .cindex "expansion" "RFC 2822 address handling"
10700 .cindex "&%addresses%& expansion item"
10701 The string (after expansion) is interpreted as a list of addresses in RFC
10702 2822 format, such as can be found in a &'To:'& or &'Cc:'& header line. The
10703 operative address (&'local-part@domain'&) is extracted from each item, and the
10704 result of the expansion is a colon-separated list, with appropriate
10705 doubling of colons should any happen to be present in the email addresses.
10706 Syntactically invalid RFC2822 address items are omitted from the output.
10707
10708 It is possible to specify a character other than colon for the output
10709 separator by starting the string with > followed by the new separator
10710 character. For example:
10711 .code
10712 ${addresses:>& Chief <ceo@up.stairs>, sec@base.ment (dogsbody)}
10713 .endd
10714 expands to &`ceo@up.stairs&&sec@base.ment`&. The string is expanded
10715 first, so if the expanded string starts with >, it may change the output
10716 separator unintentionally. This can be avoided by setting the output
10717 separator explicitly:
10718 .code
10719 ${addresses:>:$h_from:}
10720 .endd
10721
10722 Compare the &%address%& (singular)
10723 expansion item, which extracts the working address from a single RFC2822
10724 address. See the &%filter%&, &%map%&, and &%reduce%& items for ways of
10725 processing lists.
10726
10727 To clarify "list of addresses in RFC 2822 format" mentioned above, Exim follows
10728 a strict interpretation of header line formatting.  Exim parses the bare,
10729 unquoted portion of an email address and if it finds a comma, treats it as an
10730 email address separator. For the example header line:
10731 .code
10732 From: =?iso-8859-2?Q?Last=2C_First?= <user@example.com>
10733 .endd
10734 The first example below demonstrates that Q-encoded email addresses are parsed
10735 properly if it is given the raw header (in this example, &`$rheader_from:`&).
10736 It does not see the comma because it's still encoded as "=2C".  The second
10737 example below is passed the contents of &`$header_from:`&, meaning it gets
10738 de-mimed. Exim sees the decoded "," so it treats it as &*two*& email addresses.
10739 The third example shows that the presence of a comma is skipped when it is
10740 quoted.  The fourth example shows SMTPUTF8 handling.
10741 .code
10742 # exim -be '${addresses:From: \
10743 =?iso-8859-2?Q?Last=2C_First?= <user@example.com>}'
10744 user@example.com
10745 # exim -be '${addresses:From: Last, First <user@example.com>}'
10746 Last:user@example.com
10747 # exim -be '${addresses:From: "Last, First" <user@example.com>}'
10748 user@example.com
10749 # exim -be '${addresses:フィル <フィリップ@example.jp>}'
10750 フィリップ@example.jp
10751 .endd
10752
10753 .vitem &*${base32:*&<&'digits'&>&*}*&
10754 .cindex "&%base32%& expansion item"
10755 .cindex "expansion" "conversion to base 32"
10756 The string must consist entirely of decimal digits. The number is converted to
10757 base 32 and output as a (empty, for zero) string of characters.
10758 Only lowercase letters are used.
10759
10760 .vitem &*${base32d:*&<&'base-32&~digits'&>&*}*&
10761 .cindex "&%base32d%& expansion item"
10762 .cindex "expansion" "conversion to base 32"
10763 The string must consist entirely of base-32 digits.
10764 The number is converted to decimal and output as a string.
10765
10766 .vitem &*${base62:*&<&'digits'&>&*}*&
10767 .cindex "&%base62%& expansion item"
10768 .cindex "expansion" "conversion to base 62"
10769 The string must consist entirely of decimal digits. The number is converted to
10770 base 62 and output as a string of six characters, including leading zeros. In
10771 the few operating environments where Exim uses base 36 instead of base 62 for
10772 its message identifiers (because those systems do not have case-sensitive
10773 filenames), base 36 is used by this operator, despite its name. &*Note*&: Just
10774 to be absolutely clear: this is &'not'& base64 encoding.
10775
10776 .vitem &*${base62d:*&<&'base-62&~digits'&>&*}*&
10777 .cindex "&%base62d%& expansion item"
10778 .cindex "expansion" "conversion to base 62"
10779 The string must consist entirely of base-62 digits, or, in operating
10780 environments where Exim uses base 36 instead of base 62 for its message
10781 identifiers, base-36 digits. The number is converted to decimal and output as a
10782 string.
10783
10784 .vitem &*${base64:*&<&'string'&>&*}*&
10785 .cindex "expansion" "base64 encoding"
10786 .cindex "base64 encoding" "in string expansion"
10787 .cindex "&%base64%& expansion item"
10788 .cindex certificate "base64 of DER"
10789 This operator converts a string into one that is base64 encoded.
10790
10791 If the string is a single variable of type certificate,
10792 returns the base64 encoding of the DER form of the certificate.
10793
10794
10795 .vitem &*${base64d:*&<&'string'&>&*}*&
10796 .cindex "expansion" "base64 decoding"
10797 .cindex "base64 decoding" "in string expansion"
10798 .cindex "&%base64d%& expansion item"
10799 This operator converts a base64-encoded string into the un-coded form.
10800
10801
10802 .vitem &*${domain:*&<&'string'&>&*}*&
10803 .cindex "domain" "extraction"
10804 .cindex "expansion" "domain extraction"
10805 The string is interpreted as an RFC 2822 address and the domain is extracted
10806 from it. If the string does not parse successfully, the result is empty.
10807
10808
10809 .vitem &*${escape:*&<&'string'&>&*}*&
10810 .cindex "expansion" "escaping non-printing characters"
10811 .cindex "&%escape%& expansion item"
10812 If the string contains any non-printing characters, they are converted to
10813 escape sequences starting with a backslash. Whether characters with the most
10814 significant bit set (so-called &"8-bit characters"&) count as printing or not
10815 is controlled by the &%print_topbitchars%& option.
10816
10817 .vitem &*${escape8bit:*&<&'string'&>&*}*&
10818 .cindex "expansion" "escaping 8-bit characters"
10819 .cindex "&%escape8bit%& expansion item"
10820 If the string contains and characters with the most significant bit set,
10821 they are converted to escape sequences starting with a backslash.
10822 Backslashes and DEL characters are also converted.
10823
10824
10825 .vitem &*${eval:*&<&'string'&>&*}*&&~and&~&*${eval10:*&<&'string'&>&*}*&
10826 .cindex "expansion" "expression evaluation"
10827 .cindex "expansion" "arithmetic expression"
10828 .cindex "&%eval%& expansion item"
10829 These items supports simple arithmetic and bitwise logical operations in
10830 expansion strings. The string (after expansion) must be a conventional
10831 arithmetic expression, but it is limited to basic arithmetic operators, bitwise
10832 logical operators, and parentheses. All operations are carried out using
10833 integer arithmetic. The operator priorities are as follows (the same as in the
10834 C programming language):
10835 .table2 70pt 300pt
10836 .irow &'highest:'& "not (~), negate (-)"
10837 .irow ""   "multiply (*), divide (/), remainder (%)"
10838 .irow ""   "plus (+), minus (-)"
10839 .irow ""   "shift-left (<<), shift-right (>>)"
10840 .irow ""   "and (&&)"
10841 .irow ""   "xor (^)"
10842 .irow &'lowest:'&  "or (|)"
10843 .endtable
10844 Binary operators with the same priority are evaluated from left to right. White
10845 space is permitted before or after operators.
10846
10847 For &%eval%&, numbers may be decimal, octal (starting with &"0"&) or
10848 hexadecimal (starting with &"0x"&). For &%eval10%&, all numbers are taken as
10849 decimal, even if they start with a leading zero; hexadecimal numbers are not
10850 permitted. This can be useful when processing numbers extracted from dates or
10851 times, which often do have leading zeros.
10852
10853 A number may be followed by &"K"&, &"M"& or &"G"& to multiply it by 1024, 1024*1024
10854 or 1024*1024*1024,
10855 respectively. Negative numbers are supported. The result of the computation is
10856 a decimal representation of the answer (without &"K"&, &"M"& or &"G"&). For example:
10857
10858 .display
10859 &`${eval:1+1}            `&  yields 2
10860 &`${eval:1+2*3}          `&  yields 7
10861 &`${eval:(1+2)*3}        `&  yields 9
10862 &`${eval:2+42%5}         `&  yields 4
10863 &`${eval:0xc&amp;5}          `&  yields 4
10864 &`${eval:0xc|5}          `&  yields 13
10865 &`${eval:0xc^5}          `&  yields 9
10866 &`${eval:0xc>>1}         `&  yields 6
10867 &`${eval:0xc<<1}         `&  yields 24
10868 &`${eval:~255&amp;0x1234}    `&  yields 4608
10869 &`${eval:-(~255&amp;0x1234)} `&  yields -4608
10870 .endd
10871
10872 As a more realistic example, in an ACL you might have
10873 .code
10874 deny   condition =                    \
10875          ${if and {                   \
10876            {>{$rcpt_count}{10}}       \
10877            {                          \
10878            <                          \
10879              {$recipients_count}      \
10880              {${eval:$rcpt_count/2}}  \
10881            }                          \
10882          }{yes}{no}}
10883        message = Too many bad recipients
10884 .endd
10885 The condition is true if there have been more than 10 RCPT commands and
10886 fewer than half of them have resulted in a valid recipient.
10887
10888
10889 .vitem &*${expand:*&<&'string'&>&*}*&
10890 .cindex "expansion" "re-expansion of substring"
10891 The &%expand%& operator causes a string to be expanded for a second time. For
10892 example,
10893 .code
10894 ${expand:${lookup{$domain}dbm{/some/file}{$value}}}
10895 .endd
10896 first looks up a string in a file while expanding the operand for &%expand%&,
10897 and then re-expands what it has found.
10898
10899
10900 .vitem &*${from_utf8:*&<&'string'&>&*}*&
10901 .cindex "Unicode"
10902 .cindex "UTF-8" "conversion from"
10903 .cindex "expansion" "UTF-8 conversion"
10904 .cindex "&%from_utf8%& expansion item"
10905 The world is slowly moving towards Unicode, although there are no standards for
10906 email yet. However, other applications (including some databases) are starting
10907 to store data in Unicode, using UTF-8 encoding. This operator converts from a
10908 UTF-8 string to an ISO-8859-1 string. UTF-8 code values greater than 255 are
10909 converted to underscores. The input must be a valid UTF-8 string. If it is not,
10910 the result is an undefined sequence of bytes.
10911
10912 Unicode code points with values less than 256 are compatible with ASCII and
10913 ISO-8859-1 (also known as Latin-1).
10914 For example, character 169 is the copyright symbol in both cases, though the
10915 way it is encoded is different. In UTF-8, more than one byte is needed for
10916 characters with code values greater than 127, whereas ISO-8859-1 is a
10917 single-byte encoding (but thereby limited to 256 characters). This makes
10918 translation from UTF-8 to ISO-8859-1 straightforward.
10919
10920
10921 .vitem &*${hash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
10922 .cindex "hash function" "textual"
10923 .cindex "expansion" "textual hash"
10924 The &%hash%& operator is a simpler interface to the hashing function that can
10925 be used when the two parameters are fixed numbers (as opposed to strings that
10926 change when expanded). The effect is the same as
10927 .code
10928 ${hash{<n>}{<m>}{<string>}}
10929 .endd
10930 See the description of the general &%hash%& item above for details. The
10931 abbreviation &%h%& can be used when &%hash%& is used as an operator.
10932
10933
10934
10935 .vitem &*${hex2b64:*&<&'hexstring'&>&*}*&
10936 .cindex "base64 encoding" "conversion from hex"
10937 .cindex "expansion" "hex to base64"
10938 .cindex "&%hex2b64%& expansion item"
10939 This operator converts a hex string into one that is base64 encoded. This can
10940 be useful for processing the output of the various hashing functions.
10941
10942
10943
10944 .vitem &*${hexquote:*&<&'string'&>&*}*&
10945 .cindex "quoting" "hex-encoded unprintable characters"
10946 .cindex "&%hexquote%& expansion item"
10947 This operator converts non-printable characters in a string into a hex
10948 escape form. Byte values between 33 (!) and 126 (~) inclusive are left
10949 as is, and other byte values are converted to &`\xNN`&, for example, a
10950 byte value 127 is converted to &`\x7f`&.
10951
10952
10953 .vitem &*${ipv6denorm:*&<&'string'&>&*}*&
10954 .cindex "&%ipv6denorm%& expansion item"
10955 .cindex "IP address" normalisation
10956 This expands an IPv6 address to a full eight-element colon-separated set
10957 of hex digits including leading zeroes.
10958 A trailing ipv4-style dotted-decimal set is converted to hex.
10959 Pure IPv4 addresses are converted to IPv4-mapped IPv6.
10960
10961 .vitem &*${ipv6norm:*&<&'string'&>&*}*&
10962 .cindex "&%ipv6norm%& expansion item"
10963 .cindex "IP address" normalisation
10964 .cindex "IP address" "canonical form"
10965 This converts an IPv6 address to canonical form.
10966 Leading zeroes of groups are omitted, and the longest
10967 set of zero-valued groups is replaced with a double colon.
10968 A trailing ipv4-style dotted-decimal set is converted to hex.
10969 Pure IPv4 addresses are converted to IPv4-mapped IPv6.
10970
10971
10972 .vitem &*${lc:*&<&'string'&>&*}*&
10973 .cindex "case forcing in strings"
10974 .cindex "string" "case forcing"
10975 .cindex "lower casing"
10976 .cindex "expansion" "case forcing"
10977 .cindex "&%lc%& expansion item"
10978 This forces the letters in the string into lower-case, for example:
10979 .code
10980 ${lc:$local_part}
10981 .endd
10982 Case is defined per the system C locale.
10983
10984 .vitem &*${length_*&<&'number'&>&*:*&<&'string'&>&*}*&
10985 .cindex "expansion" "string truncation"
10986 .cindex "&%length%& expansion item"
10987 The &%length%& operator is a simpler interface to the &%length%& function that
10988 can be used when the parameter is a fixed number (as opposed to a string that
10989 changes when expanded). The effect is the same as
10990 .code
10991 ${length{<number>}{<string>}}
10992 .endd
10993 See the description of the general &%length%& item above for details. Note that
10994 &%length%& is not the same as &%strlen%&. The abbreviation &%l%& can be used
10995 when &%length%& is used as an operator.
10996 All measurement is done in bytes and is not UTF-8 aware.
10997
10998
10999 .vitem &*${listcount:*&<&'string'&>&*}*&
11000 .cindex "expansion" "list item count"
11001 .cindex "list" "item count"
11002 .cindex "list" "count of items"
11003 .cindex "&%listcount%& expansion item"
11004 The string is interpreted as a list and the number of items is returned.
11005
11006
11007 .vitem &*${listnamed:*&<&'name'&>&*}*&&~and&~&*${listnamed_*&<&'type'&>&*:*&<&'name'&>&*}*&
11008 .cindex "expansion" "named list"
11009 .cindex "&%listnamed%& expansion item"
11010 The name is interpreted as a named list and the content of the list is returned,
11011 expanding any referenced lists, re-quoting as needed for colon-separation.
11012 If the optional type is given it must be one of "a", "d", "h" or "l"
11013 and selects address-, domain-, host- or localpart- lists to search among respectively.
11014 Otherwise all types are searched in an undefined order and the first
11015 matching list is returned.
11016
11017
11018 .vitem &*${local_part:*&<&'string'&>&*}*&
11019 .cindex "expansion" "local part extraction"
11020 .cindex "&%local_part%& expansion item"
11021 The string is interpreted as an RFC 2822 address and the local part is
11022 extracted from it. If the string does not parse successfully, the result is
11023 empty.
11024 The parsing correctly handles SMTPUTF8 Unicode in the string.
11025
11026
11027 .vitem &*${mask:*&<&'IP&~address'&>&*/*&<&'bit&~count'&>&*}*&
11028 .cindex "masked IP address"
11029 .cindex "IP address" "masking"
11030 .cindex "CIDR notation"
11031 .cindex "expansion" "IP address masking"
11032 .cindex "&%mask%& expansion item"
11033 If the form of the string to be operated on is not an IP address followed by a
11034 slash and an integer (that is, a network address in CIDR notation), the
11035 expansion fails. Otherwise, this operator converts the IP address to binary,
11036 masks off the least significant bits according to the bit count, and converts
11037 the result back to text, with mask appended. For example,
11038 .code
11039 ${mask:10.111.131.206/28}
11040 .endd
11041 returns the string &"10.111.131.192/28"&. Since this operation is expected to
11042 be mostly used for looking up masked addresses in files, the result for an IPv6
11043 address uses dots to separate components instead of colons, because colon
11044 terminates a key string in lsearch files. So, for example,
11045 .code
11046 ${mask:3ffe:ffff:836f:0a00:000a:0800:200a:c031/99}
11047 .endd
11048 returns the string
11049 .code
11050 3ffe.ffff.836f.0a00.000a.0800.2000.0000/99
11051 .endd
11052 Letters in IPv6 addresses are always output in lower case.
11053
11054
11055 .vitem &*${md5:*&<&'string'&>&*}*&
11056 .cindex "MD5 hash"
11057 .cindex "expansion" "MD5 hash"
11058 .cindex certificate fingerprint
11059 .cindex "&%md5%& expansion item"
11060 The &%md5%& operator computes the MD5 hash value of the string, and returns it
11061 as a 32-digit hexadecimal number, in which any letters are in lower case.
11062
11063 If the string is a single variable of type certificate,
11064 returns the MD5 hash fingerprint of the certificate.
11065
11066
11067 .vitem &*${nhash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
11068 .cindex "expansion" "numeric hash"
11069 .cindex "hash function" "numeric"
11070 The &%nhash%& operator is a simpler interface to the numeric hashing function
11071 that can be used when the two parameters are fixed numbers (as opposed to
11072 strings that change when expanded). The effect is the same as
11073 .code
11074 ${nhash{<n>}{<m>}{<string>}}
11075 .endd
11076 See the description of the general &%nhash%& item above for details.
11077
11078
11079 .vitem &*${quote:*&<&'string'&>&*}*&
11080 .cindex "quoting" "in string expansions"
11081 .cindex "expansion" "quoting"
11082 .cindex "&%quote%& expansion item"
11083 The &%quote%& operator puts its argument into double quotes if it
11084 is an empty string or
11085 contains anything other than letters, digits, underscores, dots, and hyphens.
11086 Any occurrences of double quotes and backslashes are escaped with a backslash.
11087 Newlines and carriage returns are converted to &`\n`& and &`\r`&,
11088 respectively For example,
11089 .code
11090 ${quote:ab"*"cd}
11091 .endd
11092 becomes
11093 .code
11094 "ab\"*\"cd"
11095 .endd
11096 The place where this is useful is when the argument is a substitution from a
11097 variable or a message header.
11098
11099 .vitem &*${quote_local_part:*&<&'string'&>&*}*&
11100 .cindex "&%quote_local_part%& expansion item"
11101 This operator is like &%quote%&, except that it quotes the string only if
11102 required to do so by the rules of RFC 2822 for quoting local parts. For
11103 example, a plus sign would not cause quoting (but it would for &%quote%&).
11104 If you are creating a new email address from the contents of &$local_part$&
11105 (or any other unknown data), you should always use this operator.
11106
11107 This quoting determination is not SMTPUTF8-aware, thus quoting non-ASCII data
11108 will likely use the quoting form.
11109 Thus &'${quote_local_part:フィル}'& will always become &'"フィル"'&.
11110
11111
11112 .vitem &*${quote_*&<&'lookup-type'&>&*:*&<&'string'&>&*}*&
11113 .cindex "quoting" "lookup-specific"
11114 This operator applies lookup-specific quoting rules to the string. Each
11115 query-style lookup type has its own quoting rules which are described with
11116 the lookups in chapter &<<CHAPfdlookup>>&. For example,
11117 .code
11118 ${quote_ldap:two * two}
11119 .endd
11120 returns
11121 .code
11122 two%20%5C2A%20two
11123 .endd
11124 For single-key lookup types, no quoting is ever necessary and this operator
11125 yields an unchanged string.
11126
11127
11128 .vitem &*${randint:*&<&'n'&>&*}*&
11129 .cindex "random number"
11130 This operator returns a somewhat random number which is less than the
11131 supplied number and is at least 0.  The quality of this randomness depends
11132 on how Exim was built; the values are not suitable for keying material.
11133 If Exim is linked against OpenSSL then RAND_pseudo_bytes() is used.
11134 If Exim is linked against GnuTLS then gnutls_rnd(GNUTLS_RND_NONCE) is used,
11135 for versions of GnuTLS with that function.
11136 Otherwise, the implementation may be arc4random(), random() seeded by
11137 srandomdev() or srandom(), or a custom implementation even weaker than
11138 random().
11139
11140
11141 .vitem &*${reverse_ip:*&<&'ipaddr'&>&*}*&
11142 .cindex "expansion" "IP address"
11143 This operator reverses an IP address; for IPv4 addresses, the result is in
11144 dotted-quad decimal form, while for IPv6 addresses the result is in
11145 dotted-nibble hexadecimal form.  In both cases, this is the "natural" form
11146 for DNS.  For example,
11147 .code
11148 ${reverse_ip:192.0.2.4}
11149 ${reverse_ip:2001:0db8:c42:9:1:abcd:192.0.2.127}
11150 .endd
11151 returns
11152 .code
11153 4.2.0.192
11154 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
11155 .endd
11156
11157
11158 .vitem &*${rfc2047:*&<&'string'&>&*}*&
11159 .cindex "expansion" "RFC 2047"
11160 .cindex "RFC 2047" "expansion operator"
11161 .cindex "&%rfc2047%& expansion item"
11162 This operator encodes text according to the rules of RFC 2047. This is an
11163 encoding that is used in header lines to encode non-ASCII characters. It is
11164 assumed that the input string is in the encoding specified by the
11165 &%headers_charset%& option, which gets its default at build time. If the string
11166 contains only characters in the range 33&--126, and no instances of the
11167 characters
11168 .code
11169 ? = ( ) < > @ , ; : \ " . [ ] _
11170 .endd
11171 it is not modified. Otherwise, the result is the RFC 2047 encoding of the
11172 string, using as many &"encoded words"& as necessary to encode all the
11173 characters.
11174
11175
11176 .vitem &*${rfc2047d:*&<&'string'&>&*}*&
11177 .cindex "expansion" "RFC 2047"
11178 .cindex "RFC 2047" "decoding"
11179 .cindex "&%rfc2047d%& expansion item"
11180 This operator decodes strings that are encoded as per RFC 2047. Binary zero
11181 bytes are replaced by question marks. Characters are converted into the
11182 character set defined by &%headers_charset%&. Overlong RFC 2047 &"words"& are
11183 not recognized unless &%check_rfc2047_length%& is set false.
11184
11185 &*Note*&: If you use &%$header%&_&'xxx'&&*:*& (or &%$h%&_&'xxx'&&*:*&) to
11186 access a header line, RFC 2047 decoding is done automatically. You do not need
11187 to use this operator as well.
11188
11189
11190
11191 .vitem &*${rxquote:*&<&'string'&>&*}*&
11192 .cindex "quoting" "in regular expressions"
11193 .cindex "regular expressions" "quoting"
11194 .cindex "&%rxquote%& expansion item"
11195 The &%rxquote%& operator inserts a backslash before any non-alphanumeric
11196 characters in its argument. This is useful when substituting the values of
11197 variables or headers inside regular expressions.
11198
11199
11200 .vitem &*${sha1:*&<&'string'&>&*}*&
11201 .cindex "SHA-1 hash"
11202 .cindex "expansion" "SHA-1 hashing"
11203 .cindex certificate fingerprint
11204 .cindex "&%sha1%& expansion item"
11205 The &%sha1%& operator computes the SHA-1 hash value of the string, and returns
11206 it as a 40-digit hexadecimal number, in which any letters are in upper case.
11207
11208 If the string is a single variable of type certificate,
11209 returns the SHA-1 hash fingerprint of the certificate.
11210
11211
11212 .vitem &*${sha256:*&<&'string'&>&*}*& &&&
11213        &*${sha2:*&<&'string'&>&*}*& &&&
11214        &*${sha2_<n>:*&<&'string'&>&*}*&
11215 .cindex "SHA-256 hash"
11216 .cindex "SHA-2 hash"
11217 .cindex certificate fingerprint
11218 .cindex "expansion" "SHA-256 hashing"
11219 .cindex "&%sha256%& expansion item"
11220 .cindex "&%sha2%& expansion item"
11221 The &%sha256%& operator computes the SHA-256 hash value of the string
11222 and returns
11223 it as a 64-digit hexadecimal number, in which any letters are in upper case.
11224
11225 If the string is a single variable of type certificate,
11226 returns the SHA-256 hash fingerprint of the certificate.
11227
11228 The operator can also be spelled &%sha2%& and does the same as &%sha256%&
11229 (except for certificates, which are not supported).
11230 Finally, if an underbar
11231 and a number is appended it specifies the output length, selecting a
11232 member of the SHA-2 family of hash functions.
11233 Values of 256, 384 and 512 are accepted, with 256 being the default.
11234
11235
11236 .vitem &*${sha3:*&<&'string'&>&*}*& &&&
11237        &*${sha3_<n>:*&<&'string'&>&*}*&
11238 .cindex "SHA3 hash"
11239 .cindex "expansion" "SHA3 hashing"
11240 .cindex "&%sha3%& expansion item"
11241 The &%sha3%& operator computes the SHA3-256 hash value of the string
11242 and returns
11243 it as a 64-digit hexadecimal number, in which any letters are in upper case.
11244
11245 If a number is appended, separated by an underbar, it specifies
11246 the output length.  Values of 224, 256, 384 and 512 are accepted;
11247 with 256 being the default.
11248
11249 The &%sha3%& expansion item is only supported if Exim has been
11250 compiled with GnuTLS 3.5.0 or later,
11251 or OpenSSL 1.1.1 or later.
11252 The macro "_CRYPTO_HASH_SHA3" will be defined if it is supported.
11253
11254
11255 .vitem &*${stat:*&<&'string'&>&*}*&
11256 .cindex "expansion" "statting a file"
11257 .cindex "file" "extracting characteristics"
11258 .cindex "&%stat%& expansion item"
11259 The string, after expansion, must be a file path. A call to the &[stat()]&
11260 function is made for this path. If &[stat()]& fails, an error occurs and the
11261 expansion fails. If it succeeds, the data from the stat replaces the item, as a
11262 series of <&'name'&>=<&'value'&> pairs, where the values are all numerical,
11263 except for the value of &"smode"&. The names are: &"mode"& (giving the mode as
11264 a 4-digit octal number), &"smode"& (giving the mode in symbolic format as a
11265 10-character string, as for the &'ls'& command), &"inode"&, &"device"&,
11266 &"links"&, &"uid"&, &"gid"&, &"size"&, &"atime"&, &"mtime"&, and &"ctime"&. You
11267 can extract individual fields using the &%extract%& expansion item.
11268
11269 The use of the &%stat%& expansion in users' filter files can be locked out by
11270 the system administrator. &*Warning*&: The file size may be incorrect on 32-bit
11271 systems for files larger than 2GB.
11272
11273 .vitem &*${str2b64:*&<&'string'&>&*}*&
11274 .cindex "&%str2b64%& expansion item"
11275 Now deprecated, a synonym for the &%base64%& expansion operator.
11276
11277
11278
11279 .vitem &*${strlen:*&<&'string'&>&*}*&
11280 .cindex "expansion" "string length"
11281 .cindex "string" "length in expansion"
11282 .cindex "&%strlen%& expansion item"
11283 The item is replace by the length of the expanded string, expressed as a
11284 decimal number. &*Note*&: Do not confuse &%strlen%& with &%length%&.
11285 All measurement is done in bytes and is not UTF-8 aware.
11286
11287
11288 .vitem &*${substr_*&<&'start'&>&*_*&<&'length'&>&*:*&<&'string'&>&*}*&
11289 .cindex "&%substr%& expansion item"
11290 .cindex "substring extraction"
11291 .cindex "expansion" "substring expansion"
11292 The &%substr%& operator is a simpler interface to the &%substr%& function that
11293 can be used when the two parameters are fixed numbers (as opposed to strings
11294 that change when expanded). The effect is the same as
11295 .code
11296 ${substr{<start>}{<length>}{<string>}}
11297 .endd
11298 See the description of the general &%substr%& item above for details. The
11299 abbreviation &%s%& can be used when &%substr%& is used as an operator.
11300 All measurement is done in bytes and is not UTF-8 aware.
11301
11302 .vitem &*${time_eval:*&<&'string'&>&*}*&
11303 .cindex "&%time_eval%& expansion item"
11304 .cindex "time interval" "decoding"
11305 This item converts an Exim time interval such as &`2d4h5m`& into a number of
11306 seconds.
11307
11308 .vitem &*${time_interval:*&<&'string'&>&*}*&
11309 .cindex "&%time_interval%& expansion item"
11310 .cindex "time interval" "formatting"
11311 The argument (after sub-expansion) must be a sequence of decimal digits that
11312 represents an interval of time as a number of seconds. It is converted into a
11313 number of larger units and output in Exim's normal time format, for example,
11314 &`1w3d4h2m6s`&.
11315
11316 .vitem &*${uc:*&<&'string'&>&*}*&
11317 .cindex "case forcing in strings"
11318 .cindex "string" "case forcing"
11319 .cindex "upper casing"
11320 .cindex "expansion" "case forcing"
11321 .cindex "&%uc%& expansion item"
11322 This forces the letters in the string into upper-case.
11323 Case is defined per the system C locale.
11324
11325 .vitem &*${utf8clean:*&<&'string'&>&*}*&
11326 .cindex "correction of invalid utf-8 sequences in strings"
11327 .cindex "utf-8" "utf-8 sequences"
11328 .cindex "incorrect utf-8"
11329 .cindex "expansion" "utf-8 forcing"
11330 .cindex "&%utf8clean%& expansion item"
11331 This replaces any invalid utf-8 sequence in the string by the character &`?`&.
11332 In versions of Exim before 4.92, this did not correctly do so for a truncated
11333 final codepoint's encoding, and the character would be silently dropped.
11334 If you must handle detection of this scenario across both sets of Exim behavior,
11335 the complexity will depend upon the task.
11336 For instance, to detect if the first character is multibyte and a 1-byte
11337 extraction can be successfully used as a path component (as is common for
11338 dividing up delivery folders), you might use:
11339 .code
11340 condition = ${if inlist{${utf8clean:${length_1:$local_part}}}{:?}{yes}{no}}
11341 .endd
11342 (which will false-positive if the first character of the local part is a
11343 literal question mark).
11344
11345 .vitem "&*${utf8_domain_to_alabel:*&<&'string'&>&*}*&" &&&
11346        "&*${utf8_domain_from_alabel:*&<&'string'&>&*}*&" &&&
11347        "&*${utf8_localpart_to_alabel:*&<&'string'&>&*}*&" &&&
11348        "&*${utf8_localpart_from_alabel:*&<&'string'&>&*}*&"
11349 .cindex expansion UTF-8
11350 .cindex UTF-8 expansion
11351 .cindex EAI
11352 .cindex internationalisation
11353 .cindex "&%utf8_domain_to_alabel%& expansion item"
11354 .cindex "&%utf8_domain_from_alabel%& expansion item"
11355 .cindex "&%utf8_localpart_to_alabel%& expansion item"
11356 .cindex "&%utf8_localpart_from_alabel%& expansion item"
11357 These convert EAI mail name components between UTF-8 and a-label forms.
11358 For information on internationalisation support see &<<SECTi18nMTA>>&.
11359 .endlist
11360
11361
11362
11363
11364
11365
11366 .section "Expansion conditions" "SECTexpcond"
11367 .scindex IIDexpcond "expansion" "conditions"
11368 The following conditions are available for testing by the &%${if%& construct
11369 while expanding strings:
11370
11371 .vlist
11372 .vitem &*!*&<&'condition'&>
11373 .cindex "expansion" "negating a condition"
11374 .cindex "negation" "in expansion condition"
11375 Preceding any condition with an exclamation mark negates the result of the
11376 condition.
11377
11378 .vitem <&'symbolic&~operator'&>&~&*{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11379 .cindex "numeric comparison"
11380 .cindex "expansion" "numeric comparison"
11381 There are a number of symbolic operators for doing numeric comparisons. They
11382 are:
11383 .display
11384 &`=   `&   equal
11385 &`==  `&   equal
11386 &`>   `&   greater
11387 &`>=  `&   greater or equal
11388 &`<   `&   less
11389 &`<=  `&   less or equal
11390 .endd
11391 For example:
11392 .code
11393 ${if >{$message_size}{10M} ...
11394 .endd
11395 Note that the general negation operator provides for inequality testing. The
11396 two strings must take the form of optionally signed decimal integers,
11397 optionally followed by one of the letters &"K"&, &"M"& or &"G"& (in either upper or
11398 lower case), signifying multiplication by 1024, 1024*1024 or 1024*1024*1024, respectively.
11399 As a special case, the numerical value of an empty string is taken as
11400 zero.
11401
11402 In all cases, a relative comparator OP is testing if <&'string1'&> OP
11403 <&'string2'&>; the above example is checking if &$message_size$& is larger than
11404 10M, not if 10M is larger than &$message_size$&.
11405
11406
11407 .vitem &*acl&~{{*&<&'name'&>&*}{*&<&'arg1'&>&*}&&&
11408         {*&<&'arg2'&>&*}...}*&
11409 .cindex "expansion" "calling an acl"
11410 .cindex "&%acl%&" "expansion condition"
11411 The name and zero to nine argument strings are first expanded separately.  The expanded
11412 arguments are assigned to the variables &$acl_arg1$& to &$acl_arg9$& in order.
11413 Any unused are made empty.  The variable &$acl_narg$& is set to the number of
11414 arguments.  The named ACL (see chapter &<<CHAPACL>>&) is called
11415 and may use the variables; if another acl expansion is used the values
11416 are restored after it returns.  If the ACL sets
11417 a value using a "message =" modifier the variable $value becomes
11418 the result of the expansion, otherwise it is empty.
11419 If the ACL returns accept the condition is true; if deny, false.
11420 If the ACL returns defer the result is a forced-fail.
11421
11422 .vitem &*bool&~{*&<&'string'&>&*}*&
11423 .cindex "expansion" "boolean parsing"
11424 .cindex "&%bool%& expansion condition"
11425 This condition turns a string holding a true or false representation into
11426 a boolean state.  It parses &"true"&, &"false"&, &"yes"& and &"no"&
11427 (case-insensitively); also integer numbers map to true if non-zero,
11428 false if zero.
11429 An empty string is treated as false.
11430 Leading and trailing whitespace is ignored;
11431 thus a string consisting only of whitespace is false.
11432 All other string values will result in expansion failure.
11433
11434 When combined with ACL variables, this expansion condition will let you
11435 make decisions in one place and act on those decisions in another place.
11436 For example:
11437 .code
11438 ${if bool{$acl_m_privileged_sender} ...
11439 .endd
11440
11441
11442 .vitem &*bool_lax&~{*&<&'string'&>&*}*&
11443 .cindex "expansion" "boolean parsing"
11444 .cindex "&%bool_lax%& expansion condition"
11445 Like &%bool%&, this condition turns a string into a boolean state.  But
11446 where &%bool%& accepts a strict set of strings, &%bool_lax%& uses the same
11447 loose definition that the Router &%condition%& option uses.  The empty string
11448 and the values &"false"&, &"no"& and &"0"& map to false, all others map to
11449 true.  Leading and trailing whitespace is ignored.
11450
11451 Note that where &"bool{00}"& is false, &"bool_lax{00}"& is true.
11452
11453 .vitem &*crypteq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11454 .cindex "expansion" "encrypted comparison"
11455 .cindex "encrypted strings, comparing"
11456 .cindex "&%crypteq%& expansion condition"
11457 This condition is included in the Exim binary if it is built to support any
11458 authentication mechanisms (see chapter &<<CHAPSMTPAUTH>>&). Otherwise, it is
11459 necessary to define SUPPORT_CRYPTEQ in &_Local/Makefile_& to get &%crypteq%&
11460 included in the binary.
11461
11462 The &%crypteq%& condition has two arguments. The first is encrypted and
11463 compared against the second, which is already encrypted. The second string may
11464 be in the LDAP form for storing encrypted strings, which starts with the
11465 encryption type in curly brackets, followed by the data. If the second string
11466 does not begin with &"{"& it is assumed to be encrypted with &[crypt()]& or
11467 &[crypt16()]& (see below), since such strings cannot begin with &"{"&.
11468 Typically this will be a field from a password file. An example of an encrypted
11469 string in LDAP form is:
11470 .code
11471 {md5}CY9rzUYh03PK3k6DJie09g==
11472 .endd
11473 If such a string appears directly in an expansion, the curly brackets have to
11474 be quoted, because they are part of the expansion syntax. For example:
11475 .code
11476 ${if crypteq {test}{\{md5\}CY9rzUYh03PK3k6DJie09g==}{yes}{no}}
11477 .endd
11478 The following encryption types (whose names are matched case-independently) are
11479 supported:
11480
11481 .ilist
11482 .cindex "MD5 hash"
11483 .cindex "base64 encoding" "in encrypted password"
11484 &%{md5}%& computes the MD5 digest of the first string, and expresses this as
11485 printable characters to compare with the remainder of the second string. If the
11486 length of the comparison string is 24, Exim assumes that it is base64 encoded
11487 (as in the above example). If the length is 32, Exim assumes that it is a
11488 hexadecimal encoding of the MD5 digest. If the length not 24 or 32, the
11489 comparison fails.
11490
11491 .next
11492 .cindex "SHA-1 hash"
11493 &%{sha1}%& computes the SHA-1 digest of the first string, and expresses this as
11494 printable characters to compare with the remainder of the second string. If the
11495 length of the comparison string is 28, Exim assumes that it is base64 encoded.
11496 If the length is 40, Exim assumes that it is a hexadecimal encoding of the
11497 SHA-1 digest. If the length is not 28 or 40, the comparison fails.
11498
11499 .next
11500 .cindex "&[crypt()]&"
11501 &%{crypt}%& calls the &[crypt()]& function, which traditionally used to use
11502 only the first eight characters of the password. However, in modern operating
11503 systems this is no longer true, and in many cases the entire password is used,
11504 whatever its length.
11505
11506 .next
11507 .cindex "&[crypt16()]&"
11508 &%{crypt16}%& calls the &[crypt16()]& function, which was originally created to
11509 use up to 16 characters of the password in some operating systems. Again, in
11510 modern operating systems, more characters may be used.
11511 .endlist
11512 Exim has its own version of &[crypt16()]&, which is just a double call to
11513 &[crypt()]&. For operating systems that have their own version, setting
11514 HAVE_CRYPT16 in &_Local/Makefile_& when building Exim causes it to use the
11515 operating system version instead of its own. This option is set by default in
11516 the OS-dependent &_Makefile_& for those operating systems that are known to
11517 support &[crypt16()]&.
11518
11519 Some years after Exim's &[crypt16()]& was implemented, a user discovered that
11520 it was not using the same algorithm as some operating systems' versions. It
11521 turns out that as well as &[crypt16()]& there is a function called
11522 &[bigcrypt()]& in some operating systems. This may or may not use the same
11523 algorithm, and both of them may be different to Exim's built-in &[crypt16()]&.
11524
11525 However, since there is now a move away from the traditional &[crypt()]&
11526 functions towards using SHA1 and other algorithms, tidying up this area of
11527 Exim is seen as very low priority.
11528
11529 If you do not put a encryption type (in curly brackets) in a &%crypteq%&
11530 comparison, the default is usually either &`{crypt}`& or &`{crypt16}`&, as
11531 determined by the setting of DEFAULT_CRYPT in &_Local/Makefile_&. The default
11532 default is &`{crypt}`&. Whatever the default, you can always use either
11533 function by specifying it explicitly in curly brackets.
11534
11535 .vitem &*def:*&<&'variable&~name'&>
11536 .cindex "expansion" "checking for empty variable"
11537 .cindex "&%def%& expansion condition"
11538 The &%def%& condition must be followed by the name of one of the expansion
11539 variables defined in section &<<SECTexpvar>>&. The condition is true if the
11540 variable does not contain the empty string. For example:
11541 .code
11542 ${if def:sender_ident {from $sender_ident}}
11543 .endd
11544 Note that the variable name is given without a leading &%$%& character. If the
11545 variable does not exist, the expansion fails.
11546
11547 .vitem "&*def:header_*&<&'header&~name'&>&*:*&&~&~or&~&&&
11548         &~&*def:h_*&<&'header&~name'&>&*:*&"
11549 .cindex "expansion" "checking header line existence"
11550 This condition is true if a message is being processed and the named header
11551 exists in the message. For example,
11552 .code
11553 ${if def:header_reply-to:{$h_reply-to:}{$h_from:}}
11554 .endd
11555 &*Note*&: No &%$%& appears before &%header_%& or &%h_%& in the condition, and
11556 the header name must be terminated by a colon if white space does not follow.
11557
11558 .vitem &*eq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11559        &*eqi&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11560 .cindex "string" "comparison"
11561 .cindex "expansion" "string comparison"
11562 .cindex "&%eq%& expansion condition"
11563 .cindex "&%eqi%& expansion condition"
11564 The two substrings are first expanded. The condition is true if the two
11565 resulting strings are identical. For &%eq%& the comparison includes the case of
11566 letters, whereas for &%eqi%& the comparison is case-independent, where
11567 case is defined per the system C locale.
11568
11569 .vitem &*exists&~{*&<&'file&~name'&>&*}*&
11570 .cindex "expansion" "file existence test"
11571 .cindex "file" "existence test"
11572 .cindex "&%exists%&, expansion condition"
11573 The substring is first expanded and then interpreted as an absolute path. The
11574 condition is true if the named file (or directory) exists. The existence test
11575 is done by calling the &[stat()]& function. The use of the &%exists%& test in
11576 users' filter files may be locked out by the system administrator.
11577
11578 .vitem &*first_delivery*&
11579 .cindex "delivery" "first"
11580 .cindex "first delivery"
11581 .cindex "expansion" "first delivery test"
11582 .cindex "&%first_delivery%& expansion condition"
11583 This condition, which has no data, is true during a message's first delivery
11584 attempt. It is false during any subsequent delivery attempts.
11585
11586
11587 .vitem "&*forall{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&" &&&
11588        "&*forany{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&"
11589 .cindex "list" "iterative conditions"
11590 .cindex "expansion" "&*forall*& condition"
11591 .cindex "expansion" "&*forany*& condition"
11592 .vindex "&$item$&"
11593 These conditions iterate over a list. The first argument is expanded to form
11594 the list. By default, the list separator is a colon, but it can be changed by
11595 the normal method (&<<SECTlistsepchange>>&).
11596 The second argument is interpreted as a condition that is to
11597 be applied to each item in the list in turn. During the interpretation of the
11598 condition, the current list item is placed in a variable called &$item$&.
11599 .ilist
11600 For &*forany*&, interpretation stops if the condition is true for any item, and
11601 the result of the whole condition is true. If the condition is false for all
11602 items in the list, the overall condition is false.
11603 .next
11604 For &*forall*&, interpretation stops if the condition is false for any item,
11605 and the result of the whole condition is false. If the condition is true for
11606 all items in the list, the overall condition is true.
11607 .endlist
11608 Note that negation of &*forany*& means that the condition must be false for all
11609 items for the overall condition to succeed, and negation of &*forall*& means
11610 that the condition must be false for at least one item. In this example, the
11611 list separator is changed to a comma:
11612 .code
11613 ${if forany{<, $recipients}{match{$item}{^user3@}}{yes}{no}}
11614 .endd
11615 The value of &$item$& is saved and restored while &%forany%& or &%forall%& is
11616 being processed, to enable these expansion items to be nested.
11617
11618 To scan a named list, expand it with the &*listnamed*& operator.
11619
11620 .vitem "&*forall_json{*&<&'a JSON array'&>&*}{*&<&'a condition'&>&*}*&" &&&
11621        "&*forany_json{*&<&'a JSON array'&>&*}{*&<&'a condition'&>&*}*&" &&&
11622        "&*forall_jsons{*&<&'a JSON array'&>&*}{*&<&'a condition'&>&*}*&" &&&
11623        "&*forany_jsons{*&<&'a JSON array'&>&*}{*&<&'a condition'&>&*}*&"
11624 .cindex JSON "iterative conditions"
11625 .cindex JSON expansions
11626 .cindex expansion "&*forall_json*& condition"
11627 .cindex expansion "&*forany_json*& condition"
11628 .cindex expansion "&*forall_jsons*& condition"
11629 .cindex expansion "&*forany_jsons*& condition"
11630 As for the above, except that the first argument must, after expansion,
11631 be a JSON array.
11632 The array separator is not changeable.
11633 For the &"jsons"& variants the elements are expected to be JSON strings
11634 and have their quotes removed before the evaluation of the condition.
11635
11636
11637
11638 .vitem &*ge&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11639        &*gei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11640 .cindex "string" "comparison"
11641 .cindex "expansion" "string comparison"
11642 .cindex "&%ge%& expansion condition"
11643 .cindex "&%gei%& expansion condition"
11644 The two substrings are first expanded. The condition is true if the first
11645 string is lexically greater than or equal to the second string. For &%ge%& the
11646 comparison includes the case of letters, whereas for &%gei%& the comparison is
11647 case-independent.
11648 Case and collation order are defined per the system C locale.
11649
11650 .vitem &*gt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11651        &*gti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11652 .cindex "string" "comparison"
11653 .cindex "expansion" "string comparison"
11654 .cindex "&%gt%& expansion condition"
11655 .cindex "&%gti%& expansion condition"
11656 The two substrings are first expanded. The condition is true if the first
11657 string is lexically greater than the second string. For &%gt%& the comparison
11658 includes the case of letters, whereas for &%gti%& the comparison is
11659 case-independent.
11660 Case and collation order are defined per the system C locale.
11661
11662 .vitem &*inlist&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11663        &*inlisti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11664 .cindex "string" "comparison"
11665 .cindex "list" "iterative conditions"
11666 Both strings are expanded; the second string is treated as a list of simple
11667 strings; if the first string is a member of the second, then the condition
11668 is true.
11669 For the case-independent &%inlisti%& condition, case is defined per the system C locale.
11670
11671 These are simpler to use versions of the more powerful &*forany*& condition.
11672 Examples, and the &*forany*& equivalents:
11673 .code
11674 ${if inlist{needle}{foo:needle:bar}}
11675   ${if forany{foo:needle:bar}{eq{$item}{needle}}}
11676 ${if inlisti{Needle}{fOo:NeeDLE:bAr}}
11677   ${if forany{fOo:NeeDLE:bAr}{eqi{$item}{Needle}}}
11678 .endd
11679
11680 .vitem &*isip&~{*&<&'string'&>&*}*&  &&&
11681        &*isip4&~{*&<&'string'&>&*}*& &&&
11682        &*isip6&~{*&<&'string'&>&*}*&
11683 .cindex "IP address" "testing string format"
11684 .cindex "string" "testing for IP address"
11685 .cindex "&%isip%& expansion condition"
11686 .cindex "&%isip4%& expansion condition"
11687 .cindex "&%isip6%& expansion condition"
11688 The substring is first expanded, and then tested to see if it has the form of
11689 an IP address. Both IPv4 and IPv6 addresses are valid for &%isip%&, whereas
11690 &%isip4%& and &%isip6%& test specifically for IPv4 or IPv6 addresses.
11691
11692 For an IPv4 address, the test is for four dot-separated components, each of
11693 which consists of from one to three digits. For an IPv6 address, up to eight
11694 colon-separated components are permitted, each containing from one to four
11695 hexadecimal digits. There may be fewer than eight components if an empty
11696 component (adjacent colons) is present. Only one empty component is permitted.
11697
11698 &*Note*&: The checks used to be just on the form of the address; actual numerical
11699 values were not considered. Thus, for example, 999.999.999.999 passed the IPv4
11700 check.
11701 This is no longer the case.
11702
11703 The main use of these tests is to distinguish between IP addresses and
11704 host names, or between IPv4 and IPv6 addresses. For example, you could use
11705 .code
11706 ${if isip4{$sender_host_address}...
11707 .endd
11708 to test which IP version an incoming SMTP connection is using.
11709
11710 .vitem &*ldapauth&~{*&<&'ldap&~query'&>&*}*&
11711 .cindex "LDAP" "use for authentication"
11712 .cindex "expansion" "LDAP authentication test"
11713 .cindex "&%ldapauth%& expansion condition"
11714 This condition supports user authentication using LDAP. See section
11715 &<<SECTldap>>& for details of how to use LDAP in lookups and the syntax of
11716 queries. For this use, the query must contain a user name and password. The
11717 query itself is not used, and can be empty. The condition is true if the
11718 password is not empty, and the user name and password are accepted by the LDAP
11719 server. An empty password is rejected without calling LDAP because LDAP binds
11720 with an empty password are considered anonymous regardless of the username, and
11721 will succeed in most configurations. See chapter &<<CHAPSMTPAUTH>>& for details
11722 of SMTP authentication, and chapter &<<CHAPplaintext>>& for an example of how
11723 this can be used.
11724
11725
11726 .vitem &*le&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11727        &*lei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11728 .cindex "string" "comparison"
11729 .cindex "expansion" "string comparison"
11730 .cindex "&%le%& expansion condition"
11731 .cindex "&%lei%& expansion condition"
11732 The two substrings are first expanded. The condition is true if the first
11733 string is lexically less than or equal to the second string. For &%le%& the
11734 comparison includes the case of letters, whereas for &%lei%& the comparison is
11735 case-independent.
11736 Case and collation order are defined per the system C locale.
11737
11738 .vitem &*lt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11739        &*lti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11740 .cindex "string" "comparison"
11741 .cindex "expansion" "string comparison"
11742 .cindex "&%lt%& expansion condition"
11743 .cindex "&%lti%& expansion condition"
11744 The two substrings are first expanded. The condition is true if the first
11745 string is lexically less than the second string. For &%lt%& the comparison
11746 includes the case of letters, whereas for &%lti%& the comparison is
11747 case-independent.
11748 Case and collation order are defined per the system C locale.
11749
11750
11751 .vitem &*match&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11752 .cindex "expansion" "regular expression comparison"
11753 .cindex "regular expressions" "match in expanded string"
11754 .cindex "&%match%& expansion condition"
11755 The two substrings are first expanded. The second is then treated as a regular
11756 expression and applied to the first. Because of the pre-expansion, if the
11757 regular expression contains dollar, or backslash characters, they must be
11758 escaped. Care must also be taken if the regular expression contains braces
11759 (curly brackets). A closing brace must be escaped so that it is not taken as a
11760 premature termination of <&'string2'&>. The easiest approach is to use the
11761 &`\N`& feature to disable expansion of the regular expression.
11762 For example,
11763 .code
11764 ${if match {$local_part}{\N^\d{3}\N} ...
11765 .endd
11766 If the whole expansion string is in double quotes, further escaping of
11767 backslashes is also required.
11768
11769 The condition is true if the regular expression match succeeds.
11770 The regular expression is not required to begin with a circumflex
11771 metacharacter, but if there is no circumflex, the expression is not anchored,
11772 and it may match anywhere in the subject, not just at the start. If you want
11773 the pattern to match at the end of the subject, you must include the &`$`&
11774 metacharacter at an appropriate point.
11775 All character handling is done in bytes and is not UTF-8 aware,
11776 but we might change this in a future Exim release.
11777
11778 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%if%& expansion"
11779 At the start of an &%if%& expansion the values of the numeric variable
11780 substitutions &$1$& etc. are remembered. Obeying a &%match%& condition that
11781 succeeds causes them to be reset to the substrings of that condition and they
11782 will have these values during the expansion of the success string. At the end
11783 of the &%if%& expansion, the previous values are restored. After testing a
11784 combination of conditions using &%or%&, the subsequent values of the numeric
11785 variables are those of the condition that succeeded.
11786
11787 .vitem &*match_address&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11788 .cindex "&%match_address%& expansion condition"
11789 See &*match_local_part*&.
11790
11791 .vitem &*match_domain&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11792 .cindex "&%match_domain%& expansion condition"
11793 See &*match_local_part*&.
11794
11795 .vitem &*match_ip&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11796 .cindex "&%match_ip%& expansion condition"
11797 This condition matches an IP address to a list of IP address patterns. It must
11798 be followed by two argument strings. The first (after expansion) must be an IP
11799 address or an empty string. The second (not expanded) is a restricted host
11800 list that can match only an IP address, not a host name. For example:
11801 .code
11802 ${if match_ip{$sender_host_address}{1.2.3.4:5.6.7.8}{...}{...}}
11803 .endd
11804 The specific types of host list item that are permitted in the list are:
11805
11806 .ilist
11807 An IP address, optionally with a CIDR mask.
11808 .next
11809 A single asterisk, which matches any IP address.
11810 .next
11811 An empty item, which matches only if the IP address is empty. This could be
11812 useful for testing for a locally submitted message or one from specific hosts
11813 in a single test such as
11814 . ==== As this is a nested list, any displays it contains must be indented
11815 . ==== as otherwise they are too far to the left. This comment applies to
11816 . ==== the use of xmlto plus fop. There's no problem when formatting with
11817 . ==== sdop, with or without the extra indent.
11818 .code
11819   ${if match_ip{$sender_host_address}{:4.3.2.1:...}{...}{...}}
11820 .endd
11821 where the first item in the list is the empty string.
11822 .next
11823 The item @[] matches any of the local host's interface addresses.
11824 .next
11825 Single-key lookups are assumed to be like &"net-"& style lookups in host lists,
11826 even if &`net-`& is not specified. There is never any attempt to turn the IP
11827 address into a host name. The most common type of linear search for
11828 &*match_ip*& is likely to be &*iplsearch*&, in which the file can contain CIDR
11829 masks. For example:
11830 .code
11831   ${if match_ip{$sender_host_address}{iplsearch;/some/file}...
11832 .endd
11833 It is of course possible to use other kinds of lookup, and in such a case, you
11834 do need to specify the &`net-`& prefix if you want to specify a specific
11835 address mask, for example:
11836 .code
11837   ${if match_ip{$sender_host_address}{net24-dbm;/some/file}...
11838 .endd
11839 However, unless you are combining a &%match_ip%& condition with others, it is
11840 just as easy to use the fact that a lookup is itself a condition, and write:
11841 .code
11842   ${lookup{${mask:$sender_host_address/24}}dbm{/a/file}...
11843 .endd
11844 .endlist ilist
11845
11846 Note that <&'string2'&> is not itself subject to string expansion, unless
11847 Exim was built with the EXPAND_LISTMATCH_RHS option.
11848
11849 Consult section &<<SECThoslispatip>>& for further details of these patterns.
11850
11851 .vitem &*match_local_part&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11852 .cindex "domain list" "in expansion condition"
11853 .cindex "address list" "in expansion condition"
11854 .cindex "local part" "list, in expansion condition"
11855 .cindex "&%match_local_part%& expansion condition"
11856 This condition, together with &%match_address%& and &%match_domain%&, make it
11857 possible to test domain, address, and local part lists within expansions. Each
11858 condition requires two arguments: an item and a list to match. A trivial
11859 example is:
11860 .code
11861 ${if match_domain{a.b.c}{x.y.z:a.b.c:p.q.r}{yes}{no}}
11862 .endd
11863 In each case, the second argument may contain any of the allowable items for a
11864 list of the appropriate type. Also, because the second argument
11865 is a standard form of list, it is possible to refer to a named list.
11866 Thus, you can use conditions like this:
11867 .code
11868 ${if match_domain{$domain}{+local_domains}{...
11869 .endd
11870 .cindex "&`+caseful`&"
11871 For address lists, the matching starts off caselessly, but the &`+caseful`&
11872 item can be used, as in all address lists, to cause subsequent items to
11873 have their local parts matched casefully. Domains are always matched
11874 caselessly.
11875
11876 Note that <&'string2'&> is not itself subject to string expansion, unless
11877 Exim was built with the EXPAND_LISTMATCH_RHS option.
11878
11879 &*Note*&: Host lists are &'not'& supported in this way. This is because
11880 hosts have two identities: a name and an IP address, and it is not clear
11881 how to specify cleanly how such a test would work. However, IP addresses can be
11882 matched using &%match_ip%&.
11883
11884 .vitem &*pam&~{*&<&'string1'&>&*:*&<&'string2'&>&*:...}*&
11885 .cindex "PAM authentication"
11886 .cindex "AUTH" "with PAM"
11887 .cindex "Solaris" "PAM support"
11888 .cindex "expansion" "PAM authentication test"
11889 .cindex "&%pam%& expansion condition"
11890 &'Pluggable Authentication Modules'&
11891 (&url(https://mirrors.edge.kernel.org/pub/linux/libs/pam/)) are a facility that is
11892 available in the latest releases of Solaris and in some GNU/Linux
11893 distributions. The Exim support, which is intended for use in conjunction with
11894 the SMTP AUTH command, is available only if Exim is compiled with
11895 .code
11896 SUPPORT_PAM=yes
11897 .endd
11898 in &_Local/Makefile_&. You probably need to add &%-lpam%& to EXTRALIBS, and
11899 in some releases of GNU/Linux &%-ldl%& is also needed.
11900
11901 The argument string is first expanded, and the result must be a
11902 colon-separated list of strings. Leading and trailing white space is ignored.
11903 The PAM module is initialized with the service name &"exim"& and the user name
11904 taken from the first item in the colon-separated data string (<&'string1'&>).
11905 The remaining items in the data string are passed over in response to requests
11906 from the authentication function. In the simple case there will only be one
11907 request, for a password, so the data consists of just two strings.
11908
11909 There can be problems if any of the strings are permitted to contain colon
11910 characters. In the usual way, these have to be doubled to avoid being taken as
11911 separators. If the data is being inserted from a variable, the &%sg%& expansion
11912 item can be used to double any existing colons. For example, the configuration
11913 of a LOGIN authenticator might contain this setting:
11914 .code
11915 server_condition = ${if pam{$auth1:${sg{$auth2}{:}{::}}}}
11916 .endd
11917 For a PLAIN authenticator you could use:
11918 .code
11919 server_condition = ${if pam{$auth2:${sg{$auth3}{:}{::}}}}
11920 .endd
11921 In some operating systems, PAM authentication can be done only from a process
11922 running as root. Since Exim is running as the Exim user when receiving
11923 messages, this means that PAM cannot be used directly in those systems.
11924 . --- 2018-09-07: the pam_exim modified variant has gone, removed claims re using Exim via that
11925
11926
11927 .vitem &*pwcheck&~{*&<&'string1'&>&*:*&<&'string2'&>&*}*&
11928 .cindex "&'pwcheck'& daemon"
11929 .cindex "Cyrus"
11930 .cindex "expansion" "&'pwcheck'& authentication test"
11931 .cindex "&%pwcheck%& expansion condition"
11932 This condition supports user authentication using the Cyrus &'pwcheck'& daemon.
11933 This is one way of making it possible for passwords to be checked by a process
11934 that is not running as root. &*Note*&: The use of &'pwcheck'& is now
11935 deprecated. Its replacement is &'saslauthd'& (see below).
11936
11937 The pwcheck support is not included in Exim by default. You need to specify
11938 the location of the pwcheck daemon's socket in &_Local/Makefile_& before
11939 building Exim. For example:
11940 .code
11941 CYRUS_PWCHECK_SOCKET=/var/pwcheck/pwcheck
11942 .endd
11943 You do not need to install the full Cyrus software suite in order to use
11944 the pwcheck daemon. You can compile and install just the daemon alone
11945 from the Cyrus SASL library. Ensure that &'exim'& is the only user that has
11946 access to the &_/var/pwcheck_& directory.
11947
11948 The &%pwcheck%& condition takes one argument, which must be the user name and
11949 password, separated by a colon. For example, in a LOGIN authenticator
11950 configuration, you might have this:
11951 .code
11952 server_condition = ${if pwcheck{$auth1:$auth2}}
11953 .endd
11954 Again, for a PLAIN authenticator configuration, this would be:
11955 .code
11956 server_condition = ${if pwcheck{$auth2:$auth3}}
11957 .endd
11958 .vitem &*queue_running*&
11959 .cindex "queue runner" "detecting when delivering from"
11960 .cindex "expansion" "queue runner test"
11961 .cindex "&%queue_running%& expansion condition"
11962 This condition, which has no data, is true during delivery attempts that are
11963 initiated by queue runner processes, and false otherwise.
11964
11965
11966 .vitem &*radius&~{*&<&'authentication&~string'&>&*}*&
11967 .cindex "Radius"
11968 .cindex "expansion" "Radius authentication"
11969 .cindex "&%radius%& expansion condition"
11970 Radius authentication (RFC 2865) is supported in a similar way to PAM. You must
11971 set RADIUS_CONFIG_FILE in &_Local/Makefile_& to specify the location of
11972 the Radius client configuration file in order to build Exim with Radius
11973 support.
11974
11975 With just that one setting, Exim expects to be linked with the &%radiusclient%&
11976 library, using the original API. If you are using release 0.4.0 or later of
11977 this library, you need to set
11978 .code
11979 RADIUS_LIB_TYPE=RADIUSCLIENTNEW
11980 .endd
11981 in &_Local/Makefile_& when building Exim. You can also link Exim with the
11982 &%libradius%& library that comes with FreeBSD. To do this, set
11983 .code
11984 RADIUS_LIB_TYPE=RADLIB
11985 .endd
11986 in &_Local/Makefile_&, in addition to setting RADIUS_CONFIGURE_FILE.
11987 You may also have to supply a suitable setting in EXTRALIBS so that the
11988 Radius library can be found when Exim is linked.
11989
11990 The string specified by RADIUS_CONFIG_FILE is expanded and passed to the
11991 Radius client library, which calls the Radius server. The condition is true if
11992 the authentication is successful. For example:
11993 .code
11994 server_condition = ${if radius{<arguments>}}
11995 .endd
11996
11997
11998 .vitem "&*saslauthd&~{{*&<&'user'&>&*}{*&<&'password'&>&*}&&&
11999         {*&<&'service'&>&*}{*&<&'realm'&>&*}}*&"
12000 .cindex "&'saslauthd'& daemon"
12001 .cindex "Cyrus"
12002 .cindex "expansion" "&'saslauthd'& authentication test"
12003 .cindex "&%saslauthd%& expansion condition"
12004 This condition supports user authentication using the Cyrus &'saslauthd'&
12005 daemon. This replaces the older &'pwcheck'& daemon, which is now deprecated.
12006 Using this daemon is one way of making it possible for passwords to be checked
12007 by a process that is not running as root.
12008
12009 The saslauthd support is not included in Exim by default. You need to specify
12010 the location of the saslauthd daemon's socket in &_Local/Makefile_& before
12011 building Exim. For example:
12012 .code
12013 CYRUS_SASLAUTHD_SOCKET=/var/state/saslauthd/mux
12014 .endd
12015 You do not need to install the full Cyrus software suite in order to use
12016 the saslauthd daemon. You can compile and install just the daemon alone
12017 from the Cyrus SASL library.
12018
12019 Up to four arguments can be supplied to the &%saslauthd%& condition, but only
12020 two are mandatory. For example:
12021 .code
12022 server_condition = ${if saslauthd{{$auth1}{$auth2}}}
12023 .endd
12024 The service and the realm are optional (which is why the arguments are enclosed
12025 in their own set of braces). For details of the meaning of the service and
12026 realm, and how to run the daemon, consult the Cyrus documentation.
12027 .endlist vlist
12028
12029
12030
12031 .section "Combining expansion conditions" "SECID84"
12032 .cindex "expansion" "combining conditions"
12033 Several conditions can be tested at once by combining them using the &%and%&
12034 and &%or%& combination conditions. Note that &%and%& and &%or%& are complete
12035 conditions on their own, and precede their lists of sub-conditions. Each
12036 sub-condition must be enclosed in braces within the overall braces that contain
12037 the list. No repetition of &%if%& is used.
12038
12039
12040 .vlist
12041 .vitem &*or&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
12042 .cindex "&""or""& expansion condition"
12043 .cindex "expansion" "&""or""& of conditions"
12044 The sub-conditions are evaluated from left to right. The condition is true if
12045 any one of the sub-conditions is true.
12046 For example,
12047 .code
12048 ${if or {{eq{$local_part}{spqr}}{eq{$domain}{testing.com}}}...
12049 .endd
12050 When a true sub-condition is found, the following ones are parsed but not
12051 evaluated. If there are several &"match"& sub-conditions the values of the
12052 numeric variables afterwards are taken from the first one that succeeds.
12053
12054 .vitem &*and&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
12055 .cindex "&""and""& expansion condition"
12056 .cindex "expansion" "&""and""& of conditions"
12057 The sub-conditions are evaluated from left to right. The condition is true if
12058 all of the sub-conditions are true. If there are several &"match"&
12059 sub-conditions, the values of the numeric variables afterwards are taken from
12060 the last one. When a false sub-condition is found, the following ones are
12061 parsed but not evaluated.
12062 .endlist
12063 .ecindex IIDexpcond
12064
12065
12066
12067
12068 .section "Expansion variables" "SECTexpvar"
12069 .cindex "expansion" "variables, list of"
12070 This section contains an alphabetical list of all the expansion variables. Some
12071 of them are available only when Exim is compiled with specific options such as
12072 support for TLS or the content scanning extension.
12073
12074 .vlist
12075 .vitem "&$0$&, &$1$&, etc"
12076 .cindex "numerical variables (&$1$& &$2$& etc)"
12077 When a &%match%& expansion condition succeeds, these variables contain the
12078 captured substrings identified by the regular expression during subsequent
12079 processing of the success string of the containing &%if%& expansion item.
12080 In the expansion condition case
12081 they do not retain their values afterwards; in fact, their previous
12082 values are restored at the end of processing an &%if%& item. The numerical
12083 variables may also be set externally by some other matching process which
12084 precedes the expansion of the string. For example, the commands available in
12085 Exim filter files include an &%if%& command with its own regular expression
12086 matching condition.
12087
12088 .vitem "&$acl_arg1$&, &$acl_arg2$&, etc"
12089 Within an acl condition, expansion condition or expansion item
12090 any arguments are copied to these variables,
12091 any unused variables being made empty.
12092
12093 .vitem "&$acl_c...$&"
12094 Values can be placed in these variables by the &%set%& modifier in an ACL. They
12095 can be given any name that starts with &$acl_c$& and is at least six characters
12096 long, but the sixth character must be either a digit or an underscore. For
12097 example: &$acl_c5$&, &$acl_c_mycount$&. The values of the &$acl_c...$&
12098 variables persist throughout the lifetime of an SMTP connection. They can be
12099 used to pass information between ACLs and between different invocations of the
12100 same ACL. When a message is received, the values of these variables are saved
12101 with the message, and can be accessed by filters, routers, and transports
12102 during subsequent delivery.
12103
12104 .vitem "&$acl_m...$&"
12105 These variables are like the &$acl_c...$& variables, except that their values
12106 are reset after a message has been received. Thus, if several messages are
12107 received in one SMTP connection, &$acl_m...$& values are not passed on from one
12108 message to the next, as &$acl_c...$& values are. The &$acl_m...$& variables are
12109 also reset by MAIL, RSET, EHLO, HELO, and after starting a TLS session. When a
12110 message is received, the values of these variables are saved with the message,
12111 and can be accessed by filters, routers, and transports during subsequent
12112 delivery.
12113
12114 .vitem &$acl_narg$&
12115 Within an acl condition, expansion condition or expansion item
12116 this variable has the number of arguments.
12117
12118 .vitem &$acl_verify_message$&
12119 .vindex "&$acl_verify_message$&"
12120 After an address verification has failed, this variable contains the failure
12121 message. It retains its value for use in subsequent modifiers. The message can
12122 be preserved by coding like this:
12123 .code
12124 warn !verify = sender
12125      set acl_m0 = $acl_verify_message
12126 .endd
12127 You can use &$acl_verify_message$& during the expansion of the &%message%& or
12128 &%log_message%& modifiers, to include information about the verification
12129 failure.
12130
12131 .vitem &$address_data$&
12132 .vindex "&$address_data$&"
12133 This variable is set by means of the &%address_data%& option in routers. The
12134 value then remains with the address while it is processed by subsequent routers
12135 and eventually a transport. If the transport is handling multiple addresses,
12136 the value from the first address is used. See chapter &<<CHAProutergeneric>>&
12137 for more details. &*Note*&: The contents of &$address_data$& are visible in
12138 user filter files.
12139
12140 If &$address_data$& is set when the routers are called from an ACL to verify
12141 a recipient address, the final value is still in the variable for subsequent
12142 conditions and modifiers of the ACL statement. If routing the address caused it
12143 to be redirected to just one address, the child address is also routed as part
12144 of the verification, and in this case the final value of &$address_data$& is
12145 from the child's routing.
12146
12147 If &$address_data$& is set when the routers are called from an ACL to verify a
12148 sender address, the final value is also preserved, but this time in
12149 &$sender_address_data$&, to distinguish it from data from a recipient
12150 address.
12151
12152 In both cases (recipient and sender verification), the value does not persist
12153 after the end of the current ACL statement. If you want to preserve
12154 these values for longer, you can save them in ACL variables.
12155
12156 .vitem &$address_file$&
12157 .vindex "&$address_file$&"
12158 When, as a result of aliasing, forwarding, or filtering, a message is directed
12159 to a specific file, this variable holds the name of the file when the transport
12160 is running. At other times, the variable is empty. For example, using the
12161 default configuration, if user &%r2d2%& has a &_.forward_& file containing
12162 .code
12163 /home/r2d2/savemail
12164 .endd
12165 then when the &(address_file)& transport is running, &$address_file$&
12166 contains the text string &`/home/r2d2/savemail`&.
12167 .cindex "Sieve filter" "value of &$address_file$&"
12168 For Sieve filters, the value may be &"inbox"& or a relative folder name. It is
12169 then up to the transport configuration to generate an appropriate absolute path
12170 to the relevant file.
12171
12172 .vitem &$address_pipe$&
12173 .vindex "&$address_pipe$&"
12174 When, as a result of aliasing or forwarding, a message is directed to a pipe,
12175 this variable holds the pipe command when the transport is running.
12176
12177 .vitem "&$auth1$& &-- &$auth3$&"
12178 .vindex "&$auth1$&, &$auth2$&, etc"
12179 These variables are used in SMTP authenticators (see chapters
12180 &<<CHAPplaintext>>&&--&<<CHAPtlsauth>>&). Elsewhere, they are empty.
12181
12182 .vitem &$authenticated_id$&
12183 .cindex "authentication" "id"
12184 .vindex "&$authenticated_id$&"
12185 When a server successfully authenticates a client it may be configured to
12186 preserve some of the authentication information in the variable
12187 &$authenticated_id$& (see chapter &<<CHAPSMTPAUTH>>&). For example, a
12188 user/password authenticator configuration might preserve the user name for use
12189 in the routers. Note that this is not the same information that is saved in
12190 &$sender_host_authenticated$&.
12191
12192 When a message is submitted locally (that is, not over a TCP connection)
12193 the value of &$authenticated_id$& is normally the login name of the calling
12194 process. However, a trusted user can override this by means of the &%-oMai%&
12195 command line option.
12196 This second case also sets up information used by the
12197 &$authresults$& expansion item.
12198
12199 .vitem &$authenticated_fail_id$&
12200 .cindex "authentication" "fail" "id"
12201 .vindex "&$authenticated_fail_id$&"
12202 When an authentication attempt fails, the variable &$authenticated_fail_id$&
12203 will contain the failed authentication id. If more than one authentication
12204 id is attempted, it will contain only the last one. The variable is
12205 available for processing in the ACL's, generally the quit or notquit ACL.
12206 A message to a local recipient could still be accepted without requiring
12207 authentication, which means this variable could also be visible in all of
12208 the ACL's as well.
12209
12210
12211 .vitem &$authenticated_sender$&
12212 .cindex "sender" "authenticated"
12213 .cindex "authentication" "sender"
12214 .cindex "AUTH" "on MAIL command"
12215 .vindex "&$authenticated_sender$&"
12216 When acting as a server, Exim takes note of the AUTH= parameter on an incoming
12217 SMTP MAIL command if it believes the sender is sufficiently trusted, as
12218 described in section &<<SECTauthparamail>>&. Unless the data is the string
12219 &"<>"&, it is set as the authenticated sender of the message, and the value is
12220 available during delivery in the &$authenticated_sender$& variable. If the
12221 sender is not trusted, Exim accepts the syntax of AUTH=, but ignores the data.
12222
12223 .vindex "&$qualify_domain$&"
12224 When a message is submitted locally (that is, not over a TCP connection), the
12225 value of &$authenticated_sender$& is an address constructed from the login
12226 name of the calling process and &$qualify_domain$&, except that a trusted user
12227 can override this by means of the &%-oMas%& command line option.
12228
12229
12230 .vitem &$authentication_failed$&
12231 .cindex "authentication" "failure"
12232 .vindex "&$authentication_failed$&"
12233 This variable is set to &"1"& in an Exim server if a client issues an AUTH
12234 command that does not succeed. Otherwise it is set to &"0"&. This makes it
12235 possible to distinguish between &"did not try to authenticate"&
12236 (&$sender_host_authenticated$& is empty and &$authentication_failed$& is set to
12237 &"0"&) and &"tried to authenticate but failed"& (&$sender_host_authenticated$&
12238 is empty and &$authentication_failed$& is set to &"1"&). Failure includes any
12239 negative response to an AUTH command, including (for example) an attempt to use
12240 an undefined mechanism.
12241
12242 .vitem &$av_failed$&
12243 .cindex "content scanning" "AV scanner failure"
12244 This variable is available when Exim is compiled with the content-scanning
12245 extension. It is set to &"0"& by default, but will be set to &"1"& if any
12246 problem occurs with the virus scanner (specified by &%av_scanner%&) during
12247 the ACL malware condition.
12248
12249 .vitem &$body_linecount$&
12250 .cindex "message body" "line count"
12251 .cindex "body of message" "line count"
12252 .vindex "&$body_linecount$&"
12253 When a message is being received or delivered, this variable contains the
12254 number of lines in the message's body. See also &$message_linecount$&.
12255
12256 .vitem &$body_zerocount$&
12257 .cindex "message body" "binary zero count"
12258 .cindex "body of message" "binary zero count"
12259 .cindex "binary zero" "in message body"
12260 .vindex "&$body_zerocount$&"
12261 When a message is being received or delivered, this variable contains the
12262 number of binary zero bytes (ASCII NULs) in the message's body.
12263
12264 .vitem &$bounce_recipient$&
12265 .vindex "&$bounce_recipient$&"
12266 This is set to the recipient address of a bounce message while Exim is creating
12267 it. It is useful if a customized bounce message text file is in use (see
12268 chapter &<<CHAPemsgcust>>&).
12269
12270 .vitem &$bounce_return_size_limit$&
12271 .vindex "&$bounce_return_size_limit$&"
12272 This contains the value set in the &%bounce_return_size_limit%& option, rounded
12273 up to a multiple of 1000. It is useful when a customized error message text
12274 file is in use (see chapter &<<CHAPemsgcust>>&).
12275
12276 .vitem &$caller_gid$&
12277 .cindex "gid (group id)" "caller"
12278 .vindex "&$caller_gid$&"
12279 The real group id under which the process that called Exim was running. This is
12280 not the same as the group id of the originator of a message (see
12281 &$originator_gid$&). If Exim re-execs itself, this variable in the new
12282 incarnation normally contains the Exim gid.
12283
12284 .vitem &$caller_uid$&
12285 .cindex "uid (user id)" "caller"
12286 .vindex "&$caller_uid$&"
12287 The real user id under which the process that called Exim was running. This is
12288 not the same as the user id of the originator of a message (see
12289 &$originator_uid$&). If Exim re-execs itself, this variable in the new
12290 incarnation normally contains the Exim uid.
12291
12292 .vitem &$callout_address$&
12293 .vindex "&$callout_address$&"
12294 After a callout for verification, spamd or malware daemon service, the
12295 address that was connected to.
12296
12297 .vitem &$compile_number$&
12298 .vindex "&$compile_number$&"
12299 The building process for Exim keeps a count of the number
12300 of times it has been compiled. This serves to distinguish different
12301 compilations of the same version of Exim.
12302
12303 .vitem &$config_dir$&
12304 .vindex "&$config_dir$&"
12305 The directory name of the main configuration file. That is, the content of
12306 &$config_file$& with the last component stripped. The value does not
12307 contain the trailing slash. If &$config_file$& does not contain a slash,
12308 &$config_dir$& is ".".
12309
12310 .vitem &$config_file$&
12311 .vindex "&$config_file$&"
12312 The name of the main configuration file Exim is using.
12313
12314 .vitem &$dmarc_domain_policy$& &&&
12315        &$dmarc_status$& &&&
12316        &$dmarc_status_text$& &&&
12317        &$dmarc_used_domains$&
12318 Results of DMARC verification.
12319 For details see section &<<SECDMARC>>&.
12320
12321 .vitem &$dkim_verify_status$&
12322 Results of DKIM verification.
12323 For details see section &<<SECDKIMVFY>>&.
12324
12325 .vitem &$dkim_cur_signer$& &&&
12326        &$dkim_verify_reason$& &&&
12327        &$dkim_domain$& &&&
12328        &$dkim_identity$& &&&
12329        &$dkim_selector$& &&&
12330        &$dkim_algo$& &&&
12331        &$dkim_canon_body$& &&&
12332        &$dkim_canon_headers$& &&&
12333        &$dkim_copiedheaders$& &&&
12334        &$dkim_bodylength$& &&&
12335        &$dkim_created$& &&&
12336        &$dkim_expires$& &&&
12337        &$dkim_headernames$& &&&
12338        &$dkim_key_testing$& &&&
12339        &$dkim_key_nosubdomains$& &&&
12340        &$dkim_key_srvtype$& &&&
12341        &$dkim_key_granularity$& &&&
12342        &$dkim_key_notes$& &&&
12343        &$dkim_key_length$&
12344 These variables are only available within the DKIM ACL.
12345 For details see section &<<SECDKIMVFY>>&.
12346
12347 .vitem &$dkim_signers$&
12348 .vindex &$dkim_signers$&
12349 When a message has been received this variable contains
12350 a colon-separated list of signer domains and identities for the message.
12351 For details see section &<<SECDKIMVFY>>&.
12352
12353 .vitem &$dnslist_domain$& &&&
12354        &$dnslist_matched$& &&&
12355        &$dnslist_text$& &&&
12356        &$dnslist_value$&
12357 .vindex "&$dnslist_domain$&"
12358 .vindex "&$dnslist_matched$&"
12359 .vindex "&$dnslist_text$&"
12360 .vindex "&$dnslist_value$&"
12361 .cindex "black list (DNS)"
12362 When a DNS (black) list lookup succeeds, these variables are set to contain
12363 the following data from the lookup: the list's domain name, the key that was
12364 looked up, the contents of any associated TXT record, and the value from the
12365 main A record. See section &<<SECID204>>& for more details.
12366
12367 .vitem &$domain$&
12368 .vindex "&$domain$&"
12369 When an address is being routed, or delivered on its own, this variable
12370 contains the domain. Uppercase letters in the domain are converted into lower
12371 case for &$domain$&.
12372
12373 Global address rewriting happens when a message is received, so the value of
12374 &$domain$& during routing and delivery is the value after rewriting. &$domain$&
12375 is set during user filtering, but not during system filtering, because a
12376 message may have many recipients and the system filter is called just once.
12377
12378 When more than one address is being delivered at once (for example, several
12379 RCPT commands in one SMTP delivery), &$domain$& is set only if they all
12380 have the same domain. Transports can be restricted to handling only one domain
12381 at a time if the value of &$domain$& is required at transport time &-- this is
12382 the default for local transports. For further details of the environment in
12383 which local transports are run, see chapter &<<CHAPenvironment>>&.
12384
12385 .oindex "&%delay_warning_condition%&"
12386 At the end of a delivery, if all deferred addresses have the same domain, it is
12387 set in &$domain$& during the expansion of &%delay_warning_condition%&.
12388
12389 The &$domain$& variable is also used in some other circumstances:
12390
12391 .ilist
12392 When an ACL is running for a RCPT command, &$domain$& contains the domain of
12393 the recipient address. The domain of the &'sender'& address is in
12394 &$sender_address_domain$& at both MAIL time and at RCPT time. &$domain$& is not
12395 normally set during the running of the MAIL ACL. However, if the sender address
12396 is verified with a callout during the MAIL ACL, the sender domain is placed in
12397 &$domain$& during the expansions of &%hosts%&, &%interface%&, and &%port%& in
12398 the &(smtp)& transport.
12399
12400 .next
12401 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
12402 &$domain$& contains the domain portion of the address that is being rewritten;
12403 it can be used in the expansion of the replacement address, for example, to
12404 rewrite domains by file lookup.
12405
12406 .next
12407 With one important exception, whenever a domain list is being scanned,
12408 &$domain$& contains the subject domain. &*Exception*&: When a domain list in
12409 a &%sender_domains%& condition in an ACL is being processed, the subject domain
12410 is in &$sender_address_domain$& and not in &$domain$&. It works this way so
12411 that, in a RCPT ACL, the sender domain list can be dependent on the
12412 recipient domain (which is what is in &$domain$& at this time).
12413
12414 .next
12415 .cindex "ETRN" "value of &$domain$&"
12416 .oindex "&%smtp_etrn_command%&"
12417 When the &%smtp_etrn_command%& option is being expanded, &$domain$& contains
12418 the complete argument of the ETRN command (see section &<<SECTETRN>>&).
12419 .endlist
12420
12421 .new
12422 .cindex "tainted data"
12423 If the origin of the data is an incoming message,
12424 the result of expanding this variable is tainted.
12425 When un untainted version is needed, one should be obtained from
12426 looking up the value in a local (therefore trusted) database.
12427 Often &$domain_data$& is usable in this role.
12428 .wen
12429
12430
12431 .vitem &$domain_data$&
12432 .vindex "&$domain_data$&"
12433 When the &%domains%& option on a router matches a domain by
12434 means of a lookup, the data read by the lookup is available during the running
12435 of the router as &$domain_data$&. In addition, if the driver routes the
12436 address to a transport, the value is available in that transport. If the
12437 transport is handling multiple addresses, the value from the first address is
12438 used.
12439
12440 &$domain_data$& is also set when the &%domains%& condition in an ACL matches a
12441 domain by means of a lookup. The data read by the lookup is available during
12442 the rest of the ACL statement. In all other situations, this variable expands
12443 to nothing.
12444
12445 .vitem &$exim_gid$&
12446 .vindex "&$exim_gid$&"
12447 This variable contains the numerical value of the Exim group id.
12448
12449 .vitem &$exim_path$&
12450 .vindex "&$exim_path$&"
12451 This variable contains the path to the Exim binary.
12452
12453 .vitem &$exim_uid$&
12454 .vindex "&$exim_uid$&"
12455 This variable contains the numerical value of the Exim user id.
12456
12457 .vitem &$exim_version$&
12458 .vindex "&$exim_version$&"
12459 This variable contains the version string of the Exim build.
12460 The first character is a major version number, currently 4.
12461 Then after a dot, the next group of digits is a minor version number.
12462 There may be other characters following the minor version.
12463 This value may be overridden by the &%exim_version%& main config option.
12464
12465 .vitem &$header_$&<&'name'&>
12466 This is not strictly an expansion variable. It is expansion syntax for
12467 inserting the message header line with the given name. Note that the name must
12468 be terminated by colon or white space, because it may contain a wide variety of
12469 characters. Note also that braces must &'not'& be used.
12470 See the full description in section &<<SECTexpansionitems>>& above.
12471
12472 .vitem &$headers_added$&
12473 .vindex "&$headers_added$&"
12474 Within an ACL this variable contains the headers added so far by
12475 the ACL modifier add_header (section &<<SECTaddheadacl>>&).
12476 The headers are a newline-separated list.
12477
12478 .vitem &$home$&
12479 .vindex "&$home$&"
12480 When the &%check_local_user%& option is set for a router, the user's home
12481 directory is placed in &$home$& when the check succeeds. In particular, this
12482 means it is set during the running of users' filter files. A router may also
12483 explicitly set a home directory for use by a transport; this can be overridden
12484 by a setting on the transport itself.
12485
12486 When running a filter test via the &%-bf%& option, &$home$& is set to the value
12487 of the environment variable HOME, which is subject to the
12488 &%keep_environment%& and &%add_environment%& main config options.
12489
12490 .vitem &$host$&
12491 .vindex "&$host$&"
12492 If a router assigns an address to a transport (any transport), and passes a
12493 list of hosts with the address, the value of &$host$& when the transport starts
12494 to run is the name of the first host on the list. Note that this applies both
12495 to local and remote transports.
12496
12497 .cindex "transport" "filter"
12498 .cindex "filter" "transport filter"
12499 For the &(smtp)& transport, if there is more than one host, the value of
12500 &$host$& changes as the transport works its way through the list. In
12501 particular, when the &(smtp)& transport is expanding its options for encryption
12502 using TLS, or for specifying a transport filter (see chapter
12503 &<<CHAPtransportgeneric>>&), &$host$& contains the name of the host to which it
12504 is connected.
12505
12506 When used in the client part of an authenticator configuration (see chapter
12507 &<<CHAPSMTPAUTH>>&), &$host$& contains the name of the server to which the
12508 client is connected.
12509
12510
12511 .vitem &$host_address$&
12512 .vindex "&$host_address$&"
12513 This variable is set to the remote host's IP address whenever &$host$& is set
12514 for a remote connection. It is also set to the IP address that is being checked
12515 when the &%ignore_target_hosts%& option is being processed.
12516
12517 .vitem &$host_data$&
12518 .vindex "&$host_data$&"
12519 If a &%hosts%& condition in an ACL is satisfied by means of a lookup, the
12520 result of the lookup is made available in the &$host_data$& variable. This
12521 allows you, for example, to do things like this:
12522 .code
12523 deny  hosts = net-lsearch;/some/file
12524       message = $host_data
12525 .endd
12526 .vitem &$host_lookup_deferred$&
12527 .cindex "host name" "lookup, failure of"
12528 .vindex "&$host_lookup_deferred$&"
12529 This variable normally contains &"0"&, as does &$host_lookup_failed$&. When a
12530 message comes from a remote host and there is an attempt to look up the host's
12531 name from its IP address, and the attempt is not successful, one of these
12532 variables is set to &"1"&.
12533
12534 .ilist
12535 If the lookup receives a definite negative response (for example, a DNS lookup
12536 succeeded, but no records were found), &$host_lookup_failed$& is set to &"1"&.
12537
12538 .next
12539 If there is any kind of problem during the lookup, such that Exim cannot
12540 tell whether or not the host name is defined (for example, a timeout for a DNS
12541 lookup), &$host_lookup_deferred$& is set to &"1"&.
12542 .endlist ilist
12543
12544 Looking up a host's name from its IP address consists of more than just a
12545 single reverse lookup. Exim checks that a forward lookup of at least one of the
12546 names it receives from a reverse lookup yields the original IP address. If this
12547 is not the case, Exim does not accept the looked up name(s), and
12548 &$host_lookup_failed$& is set to &"1"&. Thus, being able to find a name from an
12549 IP address (for example, the existence of a PTR record in the DNS) is not
12550 sufficient on its own for the success of a host name lookup. If the reverse
12551 lookup succeeds, but there is a lookup problem such as a timeout when checking
12552 the result, the name is not accepted, and &$host_lookup_deferred$& is set to
12553 &"1"&. See also &$sender_host_name$&.
12554
12555 .cindex authentication "expansion item"
12556 Performing these checks sets up information used by the
12557 &%authresults%& expansion item.
12558
12559
12560 .vitem &$host_lookup_failed$&
12561 .vindex "&$host_lookup_failed$&"
12562 See &$host_lookup_deferred$&.
12563
12564 .vitem &$host_port$&
12565 .vindex "&$host_port$&"
12566 This variable is set to the remote host's TCP port whenever &$host$& is set
12567 for an outbound connection.
12568
12569 .vitem &$initial_cwd$&
12570 .vindex "&$initial_cwd$&
12571 This variable contains the full path name of the initial working
12572 directory of the current Exim process. This may differ from the current
12573 working directory, as Exim changes this to "/" during early startup, and
12574 to &$spool_directory$& later.
12575
12576 .vitem &$inode$&
12577 .vindex "&$inode$&"
12578 The only time this variable is set is while expanding the &%directory_file%&
12579 option in the &(appendfile)& transport. The variable contains the inode number
12580 of the temporary file which is about to be renamed. It can be used to construct
12581 a unique name for the file.
12582
12583 .vitem &$interface_address$&
12584 .vindex "&$interface_address$&"
12585 This is an obsolete name for &$received_ip_address$&.
12586
12587 .vitem &$interface_port$&
12588 .vindex "&$interface_port$&"
12589 This is an obsolete name for &$received_port$&.
12590
12591 .vitem &$item$&
12592 .vindex "&$item$&"
12593 This variable is used during the expansion of &*forall*& and &*forany*&
12594 conditions (see section &<<SECTexpcond>>&), and &*filter*&, &*map*&, and
12595 &*reduce*& items (see section &<<SECTexpcond>>&). In other circumstances, it is
12596 empty.
12597
12598 .vitem &$ldap_dn$&
12599 .vindex "&$ldap_dn$&"
12600 This variable, which is available only when Exim is compiled with LDAP support,
12601 contains the DN from the last entry in the most recently successful LDAP
12602 lookup.
12603
12604 .vitem &$load_average$&
12605 .vindex "&$load_average$&"
12606 This variable contains the system load average, multiplied by 1000 so that it
12607 is an integer. For example, if the load average is 0.21, the value of the
12608 variable is 210. The value is recomputed every time the variable is referenced.
12609
12610 .vitem &$local_part$&
12611 .vindex "&$local_part$&"
12612 When an address is being routed, or delivered on its own, this
12613 variable contains the local part. When a number of addresses are being
12614 delivered together (for example, multiple RCPT commands in an SMTP
12615 session), &$local_part$& is not set.
12616
12617 Global address rewriting happens when a message is received, so the value of
12618 &$local_part$& during routing and delivery is the value after rewriting.
12619 &$local_part$& is set during user filtering, but not during system filtering,
12620 because a message may have many recipients and the system filter is called just
12621 once.
12622
12623 .new
12624 .cindex "tainted data"
12625 If the origin of the data is an incoming message,
12626 the result of expanding this variable is tainted.
12627
12628 &*Warning*&: the content of this variable is usually provided by a potential
12629 attacker.
12630 Consider carefully the implications of using it unvalidated as a name
12631 for file access.
12632 This presents issues for users' &_.forward_& and filter files.
12633 For traditional full user accounts, use &%check_local_users%& and the
12634 &$local_part_data$& variable rather than this one.
12635 For virtual users, store a suitable pathname component in the database
12636 which is used for account name validation, and use that retrieved value
12637 rather than this variable.
12638 Often &$local_part_data$& is usable in this role.
12639 If needed, use a router &%address_data%& or &%set%& option for
12640 the retrieved data.
12641 .wen
12642
12643 When a message is being delivered to a file, pipe, or autoreply transport as a
12644 result of aliasing or forwarding, &$local_part$& is set to the local part of
12645 the parent address, not to the filename or command (see &$address_file$& and
12646 &$address_pipe$&).
12647
12648 When an ACL is running for a RCPT command, &$local_part$& contains the
12649 local part of the recipient address.
12650
12651 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
12652 &$local_part$& contains the local part of the address that is being rewritten;
12653 it can be used in the expansion of the replacement address, for example.
12654
12655 In all cases, all quoting is removed from the local part. For example, for both
12656 the addresses
12657 .code
12658 "abc:xyz"@test.example
12659 abc\:xyz@test.example
12660 .endd
12661 the value of &$local_part$& is
12662 .code
12663 abc:xyz
12664 .endd
12665 If you use &$local_part$& to create another address, you should always wrap it
12666 inside a quoting operator. For example, in a &(redirect)& router you could
12667 have:
12668 .code
12669 data = ${quote_local_part:$local_part}@new.domain.example
12670 .endd
12671 &*Note*&: The value of &$local_part$& is normally lower cased. If you want
12672 to process local parts in a case-dependent manner in a router, you can set the
12673 &%caseful_local_part%& option (see chapter &<<CHAProutergeneric>>&).
12674
12675 .vitem &$local_part_data$&
12676 .vindex "&$local_part_data$&"
12677 When the &%local_parts%& option on a router matches a local part by means of a
12678 lookup, the data read by the lookup is available during the running of the
12679 router as &$local_part_data$&. In addition, if the driver routes the address
12680 to a transport, the value is available in that transport. If the transport is
12681 handling multiple addresses, the value from the first address is used.
12682
12683 .new
12684 The &%check_local_user%& router option also sets this variable.
12685 .wen
12686
12687 &$local_part_data$& is also set when the &%local_parts%& condition in an ACL
12688 matches a local part by means of a lookup. The data read by the lookup is
12689 available during the rest of the ACL statement. In all other situations, this
12690 variable expands to nothing.
12691
12692 .vindex &$local_part_prefix$& &&&
12693         &$local_part_prefix_v$& &&&
12694         &$local_part_suffix$& &&&
12695         &$local_part_suffix_v$&
12696 .cindex affix variables
12697 If a local part prefix or suffix has been recognized, it is not included in the
12698 value of &$local_part$& during routing and subsequent delivery. The values of
12699 any prefix or suffix are in &$local_part_prefix$& and
12700 &$local_part_suffix$&, respectively.
12701 .new
12702 .cindex "tainted data"
12703 If the specification did not include a wildcard then
12704 the affix variable value is not tainted.
12705
12706 If the affix specification included a wildcard then the portion of
12707 the affix matched by the wildcard is in
12708 &$local_part_prefix_v$& or &$local_part_suffix_v$& as appropriate,
12709 and both the whole and varying values are tainted.
12710 .wen
12711
12712 .vitem &$local_scan_data$&
12713 .vindex "&$local_scan_data$&"
12714 This variable contains the text returned by the &[local_scan()]& function when
12715 a message is received. See chapter &<<CHAPlocalscan>>& for more details.
12716
12717 .vitem &$local_user_gid$&
12718 .vindex "&$local_user_gid$&"
12719 See &$local_user_uid$&.
12720
12721 .vitem &$local_user_uid$&
12722 .vindex "&$local_user_uid$&"
12723 This variable and &$local_user_gid$& are set to the uid and gid after the
12724 &%check_local_user%& router precondition succeeds. This means that their values
12725 are available for the remaining preconditions (&%senders%&, &%require_files%&,
12726 and &%condition%&), for the &%address_data%& expansion, and for any
12727 router-specific expansions. At all other times, the values in these variables
12728 are &`(uid_t)(-1)`& and &`(gid_t)(-1)`&, respectively.
12729
12730 .vitem &$localhost_number$&
12731 .vindex "&$localhost_number$&"
12732 This contains the expanded value of the
12733 &%localhost_number%& option. The expansion happens after the main options have
12734 been read.
12735
12736 .vitem &$log_inodes$&
12737 .vindex "&$log_inodes$&"
12738 The number of free inodes in the disk partition where Exim's
12739 log files are being written. The value is recalculated whenever the variable is
12740 referenced. If the relevant file system does not have the concept of inodes,
12741 the value of is -1. See also the &%check_log_inodes%& option.
12742
12743 .vitem &$log_space$&
12744 .vindex "&$log_space$&"
12745 The amount of free space (as a number of kilobytes) in the disk
12746 partition where Exim's log files are being written. The value is recalculated
12747 whenever the variable is referenced. If the operating system does not have the
12748 ability to find the amount of free space (only true for experimental systems),
12749 the space value is -1. See also the &%check_log_space%& option.
12750
12751
12752 .vitem &$lookup_dnssec_authenticated$&
12753 .vindex "&$lookup_dnssec_authenticated$&"
12754 This variable is set after a DNS lookup done by
12755 a dnsdb lookup expansion, dnslookup router or smtp transport.
12756 .cindex "DNS" "DNSSEC"
12757 It will be empty if &(DNSSEC)& was not requested,
12758 &"no"& if the result was not labelled as authenticated data
12759 and &"yes"& if it was.
12760 Results that are labelled as authoritative answer that match
12761 the &%dns_trust_aa%& configuration variable count also
12762 as authenticated data.
12763
12764 .vitem &$mailstore_basename$&
12765 .vindex "&$mailstore_basename$&"
12766 This variable is set only when doing deliveries in &"mailstore"& format in the
12767 &(appendfile)& transport. During the expansion of the &%mailstore_prefix%&,
12768 &%mailstore_suffix%&, &%message_prefix%&, and &%message_suffix%& options, it
12769 contains the basename of the files that are being written, that is, the name
12770 without the &".tmp"&, &".env"&, or &".msg"& suffix. At all other times, this
12771 variable is empty.
12772
12773 .vitem &$malware_name$&
12774 .vindex "&$malware_name$&"
12775 This variable is available when Exim is compiled with the
12776 content-scanning extension. It is set to the name of the virus that was found
12777 when the ACL &%malware%& condition is true (see section &<<SECTscanvirus>>&).
12778
12779 .vitem &$max_received_linelength$&
12780 .vindex "&$max_received_linelength$&"
12781 .cindex "maximum" "line length"
12782 .cindex "line length" "maximum"
12783 This variable contains the number of bytes in the longest line that was
12784 received as part of the message, not counting the line termination
12785 character(s).
12786 It is not valid if the &%spool_files_wireformat%& option is used.
12787
12788 .vitem &$message_age$&
12789 .cindex "message" "age of"
12790 .vindex "&$message_age$&"
12791 This variable is set at the start of a delivery attempt to contain the number
12792 of seconds since the message was received. It does not change during a single
12793 delivery attempt.
12794
12795 .vitem &$message_body$&
12796 .cindex "body of message" "expansion variable"
12797 .cindex "message body" "in expansion"
12798 .cindex "binary zero" "in message body"
12799 .vindex "&$message_body$&"
12800 .oindex "&%message_body_visible%&"
12801 This variable contains the initial portion of a message's body while it is
12802 being delivered, and is intended mainly for use in filter files. The maximum
12803 number of characters of the body that are put into the variable is set by the
12804 &%message_body_visible%& configuration option; the default is 500.
12805
12806 .oindex "&%message_body_newlines%&"
12807 By default, newlines are converted into spaces in &$message_body$&, to make it
12808 easier to search for phrases that might be split over a line break. However,
12809 this can be disabled by setting &%message_body_newlines%& to be true. Binary
12810 zeros are always converted into spaces.
12811
12812 .vitem &$message_body_end$&
12813 .cindex "body of message" "expansion variable"
12814 .cindex "message body" "in expansion"
12815 .vindex "&$message_body_end$&"
12816 This variable contains the final portion of a message's
12817 body while it is being delivered. The format and maximum size are as for
12818 &$message_body$&.
12819
12820 .vitem &$message_body_size$&
12821 .cindex "body of message" "size"
12822 .cindex "message body" "size"
12823 .vindex "&$message_body_size$&"
12824 When a message is being delivered, this variable contains the size of the body
12825 in bytes. The count starts from the character after the blank line that
12826 separates the body from the header. Newlines are included in the count. See
12827 also &$message_size$&, &$body_linecount$&, and &$body_zerocount$&.
12828
12829 If the spool file is wireformat
12830 (see the &%spool_files_wireformat%& main option)
12831 the CRLF line-terminators are included in the count.
12832
12833 .vitem &$message_exim_id$&
12834 .vindex "&$message_exim_id$&"
12835 When a message is being received or delivered, this variable contains the
12836 unique message id that is generated and used by Exim to identify the message.
12837 An id is not created for a message until after its header has been successfully
12838 received. &*Note*&: This is &'not'& the contents of the &'Message-ID:'& header
12839 line; it is the local id that Exim assigns to the message, for example:
12840 &`1BXTIK-0001yO-VA`&.
12841
12842 .vitem &$message_headers$&
12843 .vindex &$message_headers$&
12844 This variable contains a concatenation of all the header lines when a message
12845 is being processed, except for lines added by routers or transports. The header
12846 lines are separated by newline characters. Their contents are decoded in the
12847 same way as a header line that is inserted by &%bheader%&.
12848
12849 .vitem &$message_headers_raw$&
12850 .vindex &$message_headers_raw$&
12851 This variable is like &$message_headers$& except that no processing of the
12852 contents of header lines is done.
12853
12854 .vitem &$message_id$&
12855 This is an old name for &$message_exim_id$&. It is now deprecated.
12856
12857 .vitem &$message_linecount$&
12858 .vindex "&$message_linecount$&"
12859 This variable contains the total number of lines in the header and body of the
12860 message. Compare &$body_linecount$&, which is the count for the body only.
12861 During the DATA and content-scanning ACLs, &$message_linecount$& contains the
12862 number of lines received. Before delivery happens (that is, before filters,
12863 routers, and transports run) the count is increased to include the
12864 &'Received:'& header line that Exim standardly adds, and also any other header
12865 lines that are added by ACLs. The blank line that separates the message header
12866 from the body is not counted.
12867
12868 As with the special case of &$message_size$&, during the expansion of the
12869 appendfile transport's maildir_tag option in maildir format, the value of
12870 &$message_linecount$& is the precise size of the number of newlines in the
12871 file that has been written (minus one for the blank line between the
12872 header and the body).
12873
12874 Here is an example of the use of this variable in a DATA ACL:
12875 .code
12876 deny condition = \
12877       ${if <{250}{${eval:$message_linecount - $body_linecount}}}
12878      message   = Too many lines in message header
12879 .endd
12880 In the MAIL and RCPT ACLs, the value is zero because at that stage the
12881 message has not yet been received.
12882
12883 This variable is not valid if the &%spool_files_wireformat%& option is used.
12884
12885 .vitem &$message_size$&
12886 .cindex "size" "of message"
12887 .cindex "message" "size"
12888 .vindex "&$message_size$&"
12889 When a message is being processed, this variable contains its size in bytes. In
12890 most cases, the size includes those headers that were received with the
12891 message, but not those (such as &'Envelope-to:'&) that are added to individual
12892 deliveries as they are written. However, there is one special case: during the
12893 expansion of the &%maildir_tag%& option in the &(appendfile)& transport while
12894 doing a delivery in maildir format, the value of &$message_size$& is the
12895 precise size of the file that has been written. See also
12896 &$message_body_size$&, &$body_linecount$&, and &$body_zerocount$&.
12897
12898 .cindex "RCPT" "value of &$message_size$&"
12899 While running a per message ACL (mail/rcpt/predata), &$message_size$&
12900 contains the size supplied on the MAIL command, or -1 if no size was given. The
12901 value may not, of course, be truthful.
12902
12903 .vitem &$mime_$&&'xxx'&
12904 A number of variables whose names start with &$mime$& are
12905 available when Exim is compiled with the content-scanning extension. For
12906 details, see section &<<SECTscanmimepart>>&.
12907
12908 .vitem "&$n0$& &-- &$n9$&"
12909 These variables are counters that can be incremented by means
12910 of the &%add%& command in filter files.
12911
12912 .vitem &$original_domain$&
12913 .vindex "&$domain$&"
12914 .vindex "&$original_domain$&"
12915 When a top-level address is being processed for delivery, this contains the
12916 same value as &$domain$&. However, if a &"child"& address (for example,
12917 generated by an alias, forward, or filter file) is being processed, this
12918 variable contains the domain of the original address (lower cased). This
12919 differs from &$parent_domain$& only when there is more than one level of
12920 aliasing or forwarding. When more than one address is being delivered in a
12921 single transport run, &$original_domain$& is not set.
12922
12923 If a new address is created by means of a &%deliver%& command in a system
12924 filter, it is set up with an artificial &"parent"& address. This has the local
12925 part &'system-filter'& and the default qualify domain.
12926
12927 .vitem &$original_local_part$&
12928 .vindex "&$local_part$&"
12929 .vindex "&$original_local_part$&"
12930 When a top-level address is being processed for delivery, this contains the
12931 same value as &$local_part$&, unless a prefix or suffix was removed from the
12932 local part, because &$original_local_part$& always contains the full local
12933 part. When a &"child"& address (for example, generated by an alias, forward, or
12934 filter file) is being processed, this variable contains the full local part of
12935 the original address.
12936
12937 If the router that did the redirection processed the local part
12938 case-insensitively, the value in &$original_local_part$& is in lower case.
12939 This variable differs from &$parent_local_part$& only when there is more than
12940 one level of aliasing or forwarding. When more than one address is being
12941 delivered in a single transport run, &$original_local_part$& is not set.
12942
12943 If a new address is created by means of a &%deliver%& command in a system
12944 filter, it is set up with an artificial &"parent"& address. This has the local
12945 part &'system-filter'& and the default qualify domain.
12946
12947 .vitem &$originator_gid$&
12948 .cindex "gid (group id)" "of originating user"
12949 .cindex "sender" "gid"
12950 .vindex "&$caller_gid$&"
12951 .vindex "&$originator_gid$&"
12952 This variable contains the value of &$caller_gid$& that was set when the
12953 message was received. For messages received via the command line, this is the
12954 gid of the sending user. For messages received by SMTP over TCP/IP, this is
12955 normally the gid of the Exim user.
12956
12957 .vitem &$originator_uid$&
12958 .cindex "uid (user id)" "of originating user"
12959 .cindex "sender" "uid"
12960 .vindex "&$caller_uid$&"
12961 .vindex "&$originator_uid$&"
12962 The value of &$caller_uid$& that was set when the message was received. For
12963 messages received via the command line, this is the uid of the sending user.
12964 For messages received by SMTP over TCP/IP, this is normally the uid of the Exim
12965 user.
12966
12967 .vitem &$parent_domain$&
12968 .vindex "&$parent_domain$&"
12969 This variable is similar to &$original_domain$& (see
12970 above), except that it refers to the immediately preceding parent address.
12971
12972 .vitem &$parent_local_part$&
12973 .vindex "&$parent_local_part$&"
12974 This variable is similar to &$original_local_part$&
12975 (see above), except that it refers to the immediately preceding parent address.
12976
12977 .vitem &$pid$&
12978 .cindex "pid (process id)" "of current process"
12979 .vindex "&$pid$&"
12980 This variable contains the current process id.
12981
12982 .vitem &$pipe_addresses$&
12983 .cindex "filter" "transport filter"
12984 .cindex "transport" "filter"
12985 .vindex "&$pipe_addresses$&"
12986 This is not an expansion variable, but is mentioned here because the string
12987 &`$pipe_addresses`& is handled specially in the command specification for the
12988 &(pipe)& transport (chapter &<<CHAPpipetransport>>&) and in transport filters
12989 (described under &%transport_filter%& in chapter &<<CHAPtransportgeneric>>&).
12990 It cannot be used in general expansion strings, and provokes an &"unknown
12991 variable"& error if encountered.
12992
12993 .vitem &$primary_hostname$&
12994 .vindex "&$primary_hostname$&"
12995 This variable contains the value set by &%primary_hostname%& in the
12996 configuration file, or read by the &[uname()]& function. If &[uname()]& returns
12997 a single-component name, Exim calls &[gethostbyname()]& (or
12998 &[getipnodebyname()]& where available) in an attempt to acquire a fully
12999 qualified host name. See also &$smtp_active_hostname$&.
13000
13001
13002 .vitem &$proxy_external_address$& &&&
13003        &$proxy_external_port$& &&&
13004        &$proxy_local_address$& &&&
13005        &$proxy_local_port$& &&&
13006        &$proxy_session$&
13007 These variables are only available when built with Proxy Protocol
13008 or SOCKS5 support.
13009 For details see chapter &<<SECTproxyInbound>>&.
13010
13011 .vitem &$prdr_requested$&
13012 .cindex "PRDR" "variable for"
13013 This variable is set to &"yes"& if PRDR was requested by the client for the
13014 current message, otherwise &"no"&.
13015
13016 .vitem &$prvscheck_address$&
13017 This variable is used in conjunction with the &%prvscheck%& expansion item,
13018 which is described in sections &<<SECTexpansionitems>>& and
13019 &<<SECTverifyPRVS>>&.
13020
13021 .vitem &$prvscheck_keynum$&
13022 This variable is used in conjunction with the &%prvscheck%& expansion item,
13023 which is described in sections &<<SECTexpansionitems>>& and
13024 &<<SECTverifyPRVS>>&.
13025
13026 .vitem &$prvscheck_result$&
13027 This variable is used in conjunction with the &%prvscheck%& expansion item,
13028 which is described in sections &<<SECTexpansionitems>>& and
13029 &<<SECTverifyPRVS>>&.
13030
13031 .vitem &$qualify_domain$&
13032 .vindex "&$qualify_domain$&"
13033 The value set for the &%qualify_domain%& option in the configuration file.
13034
13035 .vitem &$qualify_recipient$&
13036 .vindex "&$qualify_recipient$&"
13037 The value set for the &%qualify_recipient%& option in the configuration file,
13038 or if not set, the value of &$qualify_domain$&.
13039
13040 .vitem &$queue_name$&
13041 .vindex &$queue_name$&
13042 .cindex "named queues" variable
13043 .cindex queues named
13044 The name of the spool queue in use; empty for the default queue.
13045
13046 .vitem &$queue_size$&
13047 .vindex "&$queue_size$&"
13048 .cindex "queue" "size of"
13049 .cindex "spool" "number of messages"
13050 This variable contains the number of messages queued.
13051 It is evaluated on demand, but no more often than once every minute.
13052
13053 .vitem &$r_...$&
13054 .vindex &$r_...$&
13055 .cindex router variables
13056 Values can be placed in these variables by the &%set%& option of a router.
13057 They can be given any name that starts with &$r_$&.
13058 The values persist for the address being handled through subsequent routers
13059 and the eventual transport.
13060
13061 .vitem &$rcpt_count$&
13062 .vindex "&$rcpt_count$&"
13063 When a message is being received by SMTP, this variable contains the number of
13064 RCPT commands received for the current message. If this variable is used in a
13065 RCPT ACL, its value includes the current command.
13066
13067 .vitem &$rcpt_defer_count$&
13068 .vindex "&$rcpt_defer_count$&"
13069 .cindex "4&'xx'& responses" "count of"
13070 When a message is being received by SMTP, this variable contains the number of
13071 RCPT commands in the current message that have previously been rejected with a
13072 temporary (4&'xx'&) response.
13073
13074 .vitem &$rcpt_fail_count$&
13075 .vindex "&$rcpt_fail_count$&"
13076 When a message is being received by SMTP, this variable contains the number of
13077 RCPT commands in the current message that have previously been rejected with a
13078 permanent (5&'xx'&) response.
13079
13080 .vitem &$received_count$&
13081 .vindex "&$received_count$&"
13082 This variable contains the number of &'Received:'& header lines in the message,
13083 including the one added by Exim (so its value is always greater than zero). It
13084 is available in the DATA ACL, the non-SMTP ACL, and while routing and
13085 delivering.
13086
13087 .vitem &$received_for$&
13088 .vindex "&$received_for$&"
13089 If there is only a single recipient address in an incoming message, this
13090 variable contains that address when the &'Received:'& header line is being
13091 built. The value is copied after recipient rewriting has happened, but before
13092 the &[local_scan()]& function is run.
13093
13094 .vitem &$received_ip_address$&
13095 .vindex "&$received_ip_address$&"
13096 As soon as an Exim server starts processing an incoming TCP/IP connection, this
13097 variable is set to the address of the local IP interface, and &$received_port$&
13098 is set to the local port number. (The remote IP address and port are in
13099 &$sender_host_address$& and &$sender_host_port$&.) When testing with &%-bh%&,
13100 the port value is -1 unless it has been set using the &%-oMi%& command line
13101 option.
13102
13103 As well as being useful in ACLs (including the &"connect"& ACL), these variable
13104 could be used, for example, to make the filename for a TLS certificate depend
13105 on which interface and/or port is being used for the incoming connection. The
13106 values of &$received_ip_address$& and &$received_port$& are saved with any
13107 messages that are received, thus making these variables available at delivery
13108 time.
13109 For outbound connections see &$sending_ip_address$&.
13110
13111 .vitem &$received_port$&
13112 .vindex "&$received_port$&"
13113 See &$received_ip_address$&.
13114
13115 .vitem &$received_protocol$&
13116 .vindex "&$received_protocol$&"
13117 When a message is being processed, this variable contains the name of the
13118 protocol by which it was received. Most of the names used by Exim are defined
13119 by RFCs 821, 2821, and 3848. They start with &"smtp"& (the client used HELO) or
13120 &"esmtp"& (the client used EHLO). This can be followed by &"s"& for secure
13121 (encrypted) and/or &"a"& for authenticated. Thus, for example, if the protocol
13122 is set to &"esmtpsa"&, the message was received over an encrypted SMTP
13123 connection and the client was successfully authenticated.
13124
13125 Exim uses the protocol name &"smtps"& for the case when encryption is
13126 automatically set up on connection without the use of STARTTLS (see
13127 &%tls_on_connect_ports%&), and the client uses HELO to initiate the
13128 encrypted SMTP session. The name &"smtps"& is also used for the rare situation
13129 where the client initially uses EHLO, sets up an encrypted connection using
13130 STARTTLS, and then uses HELO afterwards.
13131
13132 The &%-oMr%& option provides a way of specifying a custom protocol name for
13133 messages that are injected locally by trusted callers. This is commonly used to
13134 identify messages that are being re-injected after some kind of scanning.
13135
13136 .vitem &$received_time$&
13137 .vindex "&$received_time$&"
13138 This variable contains the date and time when the current message was received,
13139 as a number of seconds since the start of the Unix epoch.
13140
13141 .vitem &$recipient_data$&
13142 .vindex "&$recipient_data$&"
13143 This variable is set after an indexing lookup success in an ACL &%recipients%&
13144 condition. It contains the data from the lookup, and the value remains set
13145 until the next &%recipients%& test. Thus, you can do things like this:
13146 .display
13147 &`require recipients  = cdb*@;/some/file`&
13148 &`deny    `&&'some further test involving'& &`$recipient_data`&
13149 .endd
13150 &*Warning*&: This variable is set only when a lookup is used as an indexing
13151 method in the address list, using the semicolon syntax as in the example above.
13152 The variable is not set for a lookup that is used as part of the string
13153 expansion that all such lists undergo before being interpreted.
13154
13155 .vitem &$recipient_verify_failure$&
13156 .vindex "&$recipient_verify_failure$&"
13157 In an ACL, when a recipient verification fails, this variable contains
13158 information about the failure. It is set to one of the following words:
13159
13160 .ilist
13161 &"qualify"&: The address was unqualified (no domain), and the message
13162 was neither local nor came from an exempted host.
13163
13164 .next
13165 &"route"&: Routing failed.
13166
13167 .next
13168 &"mail"&: Routing succeeded, and a callout was attempted; rejection occurred at
13169 or before the MAIL command (that is, on initial connection, HELO, or
13170 MAIL).
13171
13172 .next
13173 &"recipient"&: The RCPT command in a callout was rejected.
13174 .next
13175
13176 &"postmaster"&: The postmaster check in a callout was rejected.
13177 .endlist
13178
13179 The main use of this variable is expected to be to distinguish between
13180 rejections of MAIL and rejections of RCPT.
13181
13182 .vitem &$recipients$&
13183 .vindex "&$recipients$&"
13184 This variable contains a list of envelope recipients for a message. A comma and
13185 a space separate the addresses in the replacement text. However, the variable
13186 is not generally available, to prevent exposure of Bcc recipients in
13187 unprivileged users' filter files. You can use &$recipients$& only in these
13188 cases:
13189
13190 .olist
13191 In a system filter file.
13192 .next
13193 In the ACLs associated with the DATA command and with non-SMTP messages, that
13194 is, the ACLs defined by &%acl_smtp_predata%&, &%acl_smtp_data%&,
13195 &%acl_smtp_mime%&, &%acl_not_smtp_start%&, &%acl_not_smtp%&, and
13196 &%acl_not_smtp_mime%&.
13197 .next
13198 From within a &[local_scan()]& function.
13199 .endlist
13200
13201
13202 .vitem &$recipients_count$&
13203 .vindex "&$recipients_count$&"
13204 When a message is being processed, this variable contains the number of
13205 envelope recipients that came with the message. Duplicates are not excluded
13206 from the count. While a message is being received over SMTP, the number
13207 increases for each accepted recipient. It can be referenced in an ACL.
13208
13209
13210 .vitem &$regex_match_string$&
13211 .vindex "&$regex_match_string$&"
13212 This variable is set to contain the matching regular expression after a
13213 &%regex%& ACL condition has matched (see section &<<SECTscanregex>>&).
13214
13215 .vitem "&$regex1$&, &$regex2$&, etc"
13216 .cindex "regex submatch variables (&$1regex$& &$2regex$& etc)"
13217 When a &%regex%& or &%mime_regex%& ACL condition succeeds,
13218 these variables contain the
13219 captured substrings identified by the regular expression.
13220
13221
13222 .vitem &$reply_address$&
13223 .vindex "&$reply_address$&"
13224 When a message is being processed, this variable contains the contents of the
13225 &'Reply-To:'& header line if one exists and it is not empty, or otherwise the
13226 contents of the &'From:'& header line. Apart from the removal of leading
13227 white space, the value is not processed in any way. In particular, no RFC 2047
13228 decoding or character code translation takes place.
13229
13230 .vitem &$return_path$&
13231 .vindex "&$return_path$&"
13232 When a message is being delivered, this variable contains the return path &--
13233 the sender field that will be sent as part of the envelope. It is not enclosed
13234 in <> characters. At the start of routing an address, &$return_path$& has the
13235 same value as &$sender_address$&, but if, for example, an incoming message to a
13236 mailing list has been expanded by a router which specifies a different address
13237 for bounce messages, &$return_path$& subsequently contains the new bounce
13238 address, whereas &$sender_address$& always contains the original sender address
13239 that was received with the message. In other words, &$sender_address$& contains
13240 the incoming envelope sender, and &$return_path$& contains the outgoing
13241 envelope sender.
13242
13243 .vitem &$return_size_limit$&
13244 .vindex "&$return_size_limit$&"
13245 This is an obsolete name for &$bounce_return_size_limit$&.
13246
13247 .vitem &$router_name$&
13248 .cindex "router" "name"
13249 .cindex "name" "of router"
13250 .vindex "&$router_name$&"
13251 During the running of a router this variable contains its name.
13252
13253 .vitem &$runrc$&
13254 .cindex "return code" "from &%run%& expansion"
13255 .vindex "&$runrc$&"
13256 This variable contains the return code from a command that is run by the
13257 &%${run...}%& expansion item. &*Warning*&: In a router or transport, you cannot
13258 assume the order in which option values are expanded, except for those
13259 preconditions whose order of testing is documented. Therefore, you cannot
13260 reliably expect to set &$runrc$& by the expansion of one option, and use it in
13261 another.
13262
13263 .vitem &$self_hostname$&
13264 .oindex "&%self%&" "value of host name"
13265 .vindex "&$self_hostname$&"
13266 When an address is routed to a supposedly remote host that turns out to be the
13267 local host, what happens is controlled by the &%self%& generic router option.
13268 One of its values causes the address to be passed to another router. When this
13269 happens, &$self_hostname$& is set to the name of the local host that the
13270 original router encountered. In other circumstances its contents are null.
13271
13272 .vitem &$sender_address$&
13273 .vindex "&$sender_address$&"
13274 When a message is being processed, this variable contains the sender's address
13275 that was received in the message's envelope. The case of letters in the address
13276 is retained, in both the local part and the domain. For bounce messages, the
13277 value of this variable is the empty string. See also &$return_path$&.
13278
13279 .vitem &$sender_address_data$&
13280 .vindex "&$address_data$&"
13281 .vindex "&$sender_address_data$&"
13282 If &$address_data$& is set when the routers are called from an ACL to verify a
13283 sender address, the final value is preserved in &$sender_address_data$&, to
13284 distinguish it from data from a recipient address. The value does not persist
13285 after the end of the current ACL statement. If you want to preserve it for
13286 longer, you can save it in an ACL variable.
13287
13288 .vitem &$sender_address_domain$&
13289 .vindex "&$sender_address_domain$&"
13290 The domain portion of &$sender_address$&.
13291
13292 .vitem &$sender_address_local_part$&
13293 .vindex "&$sender_address_local_part$&"
13294 The local part portion of &$sender_address$&.
13295
13296 .vitem &$sender_data$&
13297 .vindex "&$sender_data$&"
13298 This variable is set after a lookup success in an ACL &%senders%& condition or
13299 in a router &%senders%& option. It contains the data from the lookup, and the
13300 value remains set until the next &%senders%& test. Thus, you can do things like
13301 this:
13302 .display
13303 &`require senders      = cdb*@;/some/file`&
13304 &`deny    `&&'some further test involving'& &`$sender_data`&
13305 .endd
13306 &*Warning*&: This variable is set only when a lookup is used as an indexing
13307 method in the address list, using the semicolon syntax as in the example above.
13308 The variable is not set for a lookup that is used as part of the string
13309 expansion that all such lists undergo before being interpreted.
13310
13311 .vitem &$sender_fullhost$&
13312 .vindex "&$sender_fullhost$&"
13313 When a message is received from a remote host, this variable contains the host
13314 name and IP address in a single string. It ends with the IP address in square
13315 brackets, followed by a colon and a port number if the logging of ports is
13316 enabled. The format of the rest of the string depends on whether the host
13317 issued a HELO or EHLO SMTP command, and whether the host name was verified by
13318 looking up its IP address. (Looking up the IP address can be forced by the
13319 &%host_lookup%& option, independent of verification.) A plain host name at the
13320 start of the string is a verified host name; if this is not present,
13321 verification either failed or was not requested. A host name in parentheses is
13322 the argument of a HELO or EHLO command. This is omitted if it is identical to
13323 the verified host name or to the host's IP address in square brackets.
13324
13325 .vitem &$sender_helo_dnssec$&
13326 .vindex "&$sender_helo_dnssec$&"
13327 This boolean variable is true if a successful HELO verification was
13328 .cindex "DNS" "DNSSEC"
13329 done using DNS information the resolver library stated was authenticated data.
13330
13331 .vitem &$sender_helo_name$&
13332 .vindex "&$sender_helo_name$&"
13333 When a message is received from a remote host that has issued a HELO or EHLO
13334 command, the argument of that command is placed in this variable. It is also
13335 set if HELO or EHLO is used when a message is received using SMTP locally via
13336 the &%-bs%& or &%-bS%& options.
13337
13338 .vitem &$sender_host_address$&
13339 .vindex "&$sender_host_address$&"
13340 When a message is received from a remote host using SMTP,
13341 this variable contains that
13342 host's IP address. For locally non-SMTP submitted messages, it is empty.
13343
13344 .vitem &$sender_host_authenticated$&
13345 .vindex "&$sender_host_authenticated$&"
13346 This variable contains the name (not the public name) of the authenticator
13347 driver that successfully authenticated the client from which the message was
13348 received. It is empty if there was no successful authentication. See also
13349 &$authenticated_id$&.
13350
13351 .vitem &$sender_host_dnssec$&
13352 .vindex "&$sender_host_dnssec$&"
13353 If an attempt to populate &$sender_host_name$& has been made
13354 (by reference, &%hosts_lookup%& or
13355 otherwise) then this boolean will have been set true if, and only if, the
13356 resolver library states that both
13357 the reverse and forward DNS were authenticated data.  At all
13358 other times, this variable is false.
13359
13360 .cindex "DNS" "DNSSEC"
13361 It is likely that you will need to coerce DNSSEC support on in the resolver
13362 library, by setting:
13363 .code
13364 dns_dnssec_ok = 1
13365 .endd
13366
13367 .new
13368 In addition, on Linux with glibc 2.31 or newer the resolver library will
13369 default to stripping out a successful validation status.
13370 This will break a previously working Exim installation.
13371 Provided that you do trust the resolver (ie, is on localhost) you can tell
13372 glibc to pass through any successful validation with a new option in
13373 &_/etc/resolv.conf_&:
13374 .code
13375 options trust-ad
13376 .endd
13377 .wen
13378
13379 Exim does not perform DNSSEC validation itself, instead leaving that to a
13380 validating resolver (e.g. unbound, or bind with suitable configuration).
13381
13382 If you have changed &%host_lookup_order%& so that &`bydns`& is not the first
13383 mechanism in the list, then this variable will be false.
13384
13385 This requires that your system resolver library support EDNS0 (and that
13386 DNSSEC flags exist in the system headers).  If the resolver silently drops
13387 all EDNS0 options, then this will have no effect.  OpenBSD's asr resolver
13388 is known to currently ignore EDNS0, documented in CAVEATS of asr_run(3).
13389
13390
13391 .vitem &$sender_host_name$&
13392 .vindex "&$sender_host_name$&"
13393 When a message is received from a remote host, this variable contains the
13394 host's name as obtained by looking up its IP address. For messages received by
13395 other means, this variable is empty.
13396
13397 .vindex "&$host_lookup_failed$&"
13398 If the host name has not previously been looked up, a reference to
13399 &$sender_host_name$& triggers a lookup (for messages from remote hosts).
13400 A looked up name is accepted only if it leads back to the original IP address
13401 via a forward lookup. If either the reverse or the forward lookup fails to find
13402 any data, or if the forward lookup does not yield the original IP address,
13403 &$sender_host_name$& remains empty, and &$host_lookup_failed$& is set to &"1"&.
13404
13405 .vindex "&$host_lookup_deferred$&"
13406 However, if either of the lookups cannot be completed (for example, there is a
13407 DNS timeout), &$host_lookup_deferred$& is set to &"1"&, and
13408 &$host_lookup_failed$& remains set to &"0"&.
13409
13410 Once &$host_lookup_failed$& is set to &"1"&, Exim does not try to look up the
13411 host name again if there is a subsequent reference to &$sender_host_name$&
13412 in the same Exim process, but it does try again if &$host_lookup_deferred$&
13413 is set to &"1"&.
13414
13415 Exim does not automatically look up every calling host's name. If you want
13416 maximum efficiency, you should arrange your configuration so that it avoids
13417 these lookups altogether. The lookup happens only if one or more of the
13418 following are true:
13419
13420 .ilist
13421 A string containing &$sender_host_name$& is expanded.
13422 .next
13423 The calling host matches the list in &%host_lookup%&. In the default
13424 configuration, this option is set to *, so it must be changed if lookups are
13425 to be avoided. (In the code, the default for &%host_lookup%& is unset.)
13426 .next
13427 Exim needs the host name in order to test an item in a host list. The items
13428 that require this are described in sections &<<SECThoslispatnam>>& and
13429 &<<SECThoslispatnamsk>>&.
13430 .next
13431 The calling host matches &%helo_try_verify_hosts%& or &%helo_verify_hosts%&.
13432 In this case, the host name is required to compare with the name quoted in any
13433 EHLO or HELO commands that the client issues.
13434 .next
13435 The remote host issues a EHLO or HELO command that quotes one of the
13436 domains in &%helo_lookup_domains%&. The default value of this option is
13437 . ==== As this is a nested list, any displays it contains must be indented
13438 . ==== as otherwise they are too far to the left.
13439 .code
13440   helo_lookup_domains = @ : @[]
13441 .endd
13442 which causes a lookup if a remote host (incorrectly) gives the server's name or
13443 IP address in an EHLO or HELO command.
13444 .endlist
13445
13446
13447 .vitem &$sender_host_port$&
13448 .vindex "&$sender_host_port$&"
13449 When a message is received from a remote host, this variable contains the port
13450 number that was used on the remote host.
13451
13452 .vitem &$sender_ident$&
13453 .vindex "&$sender_ident$&"
13454 When a message is received from a remote host, this variable contains the
13455 identification received in response to an RFC 1413 request. When a message has
13456 been received locally, this variable contains the login name of the user that
13457 called Exim.
13458
13459 .vitem &$sender_rate_$&&'xxx'&
13460 A number of variables whose names begin &$sender_rate_$& are set as part of the
13461 &%ratelimit%& ACL condition. Details are given in section
13462 &<<SECTratelimiting>>&.
13463
13464 .vitem &$sender_rcvhost$&
13465 .cindex "DNS" "reverse lookup"
13466 .cindex "reverse DNS lookup"
13467 .vindex "&$sender_rcvhost$&"
13468 This is provided specifically for use in &'Received:'& headers. It starts with
13469 either the verified host name (as obtained from a reverse DNS lookup) or, if
13470 there is no verified host name, the IP address in square brackets. After that
13471 there may be text in parentheses. When the first item is a verified host name,
13472 the first thing in the parentheses is the IP address in square brackets,
13473 followed by a colon and a port number if port logging is enabled. When the
13474 first item is an IP address, the port is recorded as &"port=&'xxxx'&"& inside
13475 the parentheses.
13476
13477 There may also be items of the form &"helo=&'xxxx'&"& if HELO or EHLO
13478 was used and its argument was not identical to the real host name or IP
13479 address, and &"ident=&'xxxx'&"& if an RFC 1413 ident string is available. If
13480 all three items are present in the parentheses, a newline and tab are inserted
13481 into the string, to improve the formatting of the &'Received:'& header.
13482
13483 .vitem &$sender_verify_failure$&
13484 .vindex "&$sender_verify_failure$&"
13485 In an ACL, when a sender verification fails, this variable contains information
13486 about the failure. The details are the same as for
13487 &$recipient_verify_failure$&.
13488
13489 .vitem &$sending_ip_address$&
13490 .vindex "&$sending_ip_address$&"
13491 This variable is set whenever an outgoing SMTP connection to another host has
13492 been set up. It contains the IP address of the local interface that is being
13493 used. This is useful if a host that has more than one IP address wants to take
13494 on different personalities depending on which one is being used. For incoming
13495 connections, see &$received_ip_address$&.
13496
13497 .vitem &$sending_port$&
13498 .vindex "&$sending_port$&"
13499 This variable is set whenever an outgoing SMTP connection to another host has
13500 been set up. It contains the local port that is being used. For incoming
13501 connections, see &$received_port$&.
13502
13503 .vitem &$smtp_active_hostname$&
13504 .vindex "&$smtp_active_hostname$&"
13505 During an incoming SMTP session, this variable contains the value of the active
13506 host name, as specified by the &%smtp_active_hostname%& option. The value of
13507 &$smtp_active_hostname$& is saved with any message that is received, so its
13508 value can be consulted during routing and delivery.
13509
13510 .vitem &$smtp_command$&
13511 .vindex "&$smtp_command$&"
13512 During the processing of an incoming SMTP command, this variable contains the
13513 entire command. This makes it possible to distinguish between HELO and EHLO in
13514 the HELO ACL, and also to distinguish between commands such as these:
13515 .code
13516 MAIL FROM:<>
13517 MAIL FROM: <>
13518 .endd
13519 For a MAIL command, extra parameters such as SIZE can be inspected. For a RCPT
13520 command, the address in &$smtp_command$& is the original address before any
13521 rewriting, whereas the values in &$local_part$& and &$domain$& are taken from
13522 the address after SMTP-time rewriting.
13523
13524 .vitem &$smtp_command_argument$&
13525 .cindex "SMTP" "command, argument for"
13526 .vindex "&$smtp_command_argument$&"
13527 While an ACL is running to check an SMTP command, this variable contains the
13528 argument, that is, the text that follows the command name, with leading white
13529 space removed. Following the introduction of &$smtp_command$&, this variable is
13530 somewhat redundant, but is retained for backwards compatibility.
13531
13532 .vitem &$smtp_command_history$&
13533 .cindex SMTP "command history"
13534 .vindex "&$smtp_command_history$&"
13535 A comma-separated list (with no whitespace) of the most-recent SMTP commands
13536 received, in time-order left to right.  Only a limited number of commands
13537 are remembered.
13538
13539 .vitem &$smtp_count_at_connection_start$&
13540 .vindex "&$smtp_count_at_connection_start$&"
13541 This variable is set greater than zero only in processes spawned by the Exim
13542 daemon for handling incoming SMTP connections. The name is deliberately long,
13543 in order to emphasize what the contents are. When the daemon accepts a new
13544 connection, it increments this variable. A copy of the variable is passed to
13545 the child process that handles the connection, but its value is fixed, and
13546 never changes. It is only an approximation of how many incoming connections
13547 there actually are, because many other connections may come and go while a
13548 single connection is being processed. When a child process terminates, the
13549 daemon decrements its copy of the variable.
13550
13551 .vitem "&$sn0$& &-- &$sn9$&"
13552 These variables are copies of the values of the &$n0$& &-- &$n9$& accumulators
13553 that were current at the end of the system filter file. This allows a system
13554 filter file to set values that can be tested in users' filter files. For
13555 example, a system filter could set a value indicating how likely it is that a
13556 message is junk mail.
13557
13558 .vitem &$spam_$&&'xxx'&
13559 A number of variables whose names start with &$spam$& are available when Exim
13560 is compiled with the content-scanning extension. For details, see section
13561 &<<SECTscanspamass>>&.
13562
13563 .vitem &$spf_header_comment$& &&&
13564        &$spf_received$& &&&
13565        &$spf_result$& &&&
13566        &$spf_result_guessed$& &&&
13567        &$spf_smtp_comment$&
13568 These variables are only available if Exim is built with SPF support.
13569 For details see section &<<SECSPF>>&.
13570
13571 .vitem &$spool_directory$&
13572 .vindex "&$spool_directory$&"
13573 The name of Exim's spool directory.
13574
13575 .vitem &$spool_inodes$&
13576 .vindex "&$spool_inodes$&"
13577 The number of free inodes in the disk partition where Exim's spool files are
13578 being written. The value is recalculated whenever the variable is referenced.
13579 If the relevant file system does not have the concept of inodes, the value of
13580 is -1. See also the &%check_spool_inodes%& option.
13581
13582 .vitem &$spool_space$&
13583 .vindex "&$spool_space$&"
13584 The amount of free space (as a number of kilobytes) in the disk partition where
13585 Exim's spool files are being written. The value is recalculated whenever the
13586 variable is referenced. If the operating system does not have the ability to
13587 find the amount of free space (only true for experimental systems), the space
13588 value is -1. For example, to check in an ACL that there is at least 50
13589 megabytes free on the spool, you could write:
13590 .code
13591 condition = ${if > {$spool_space}{50000}}
13592 .endd
13593 See also the &%check_spool_space%& option.
13594
13595
13596 .vitem &$thisaddress$&
13597 .vindex "&$thisaddress$&"
13598 This variable is set only during the processing of the &%foranyaddress%&
13599 command in a filter file. Its use is explained in the description of that
13600 command, which can be found in the separate document entitled &'Exim's
13601 interfaces to mail filtering'&.
13602
13603 .vitem &$tls_in_bits$&
13604 .vindex "&$tls_in_bits$&"
13605 Contains an approximation of the TLS cipher's bit-strength
13606 on the inbound connection; the meaning of
13607 this depends upon the TLS implementation used.
13608 If TLS has not been negotiated, the value will be 0.
13609 The value of this is automatically fed into the Cyrus SASL authenticator
13610 when acting as a server, to specify the "external SSF" (a SASL term).
13611
13612 The deprecated &$tls_bits$& variable refers to the inbound side
13613 except when used in the context of an outbound SMTP delivery, when it refers to
13614 the outbound.
13615
13616 .vitem &$tls_out_bits$&
13617 .vindex "&$tls_out_bits$&"
13618 Contains an approximation of the TLS cipher's bit-strength
13619 on an outbound SMTP connection; the meaning of
13620 this depends upon the TLS implementation used.
13621 If TLS has not been negotiated, the value will be 0.
13622
13623 .vitem &$tls_in_ourcert$&
13624 .vindex "&$tls_in_ourcert$&"
13625 .cindex certificate variables
13626 This variable refers to the certificate presented to the peer of an
13627 inbound connection when the message was received.
13628 It is only useful as the argument of a
13629 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
13630 or a &%def%& condition.
13631
13632 &*Note*&: Under versions of OpenSSL preceding 1.1.1,
13633 when a list of more than one
13634 file is used for &%tls_certificate%&, this variable is not reliable.
13635 The macro "_TLS_BAD_MULTICERT_IN_OURCERT" will be defined for those versions.
13636
13637 .vitem &$tls_in_peercert$&
13638 .vindex "&$tls_in_peercert$&"
13639 This variable refers to the certificate presented by the peer of an
13640 inbound connection when the message was received.
13641 It is only useful as the argument of a
13642 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
13643 or a &%def%& condition.
13644 If certificate verification fails it may refer to a failing chain element
13645 which is not the leaf.
13646
13647 .vitem &$tls_out_ourcert$&
13648 .vindex "&$tls_out_ourcert$&"
13649 This variable refers to the certificate presented to the peer of an
13650 outbound connection.  It is only useful as the argument of a
13651 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
13652 or a &%def%& condition.
13653
13654 .vitem &$tls_out_peercert$&
13655 .vindex "&$tls_out_peercert$&"
13656 This variable refers to the certificate presented by the peer of an
13657 outbound connection.  It is only useful as the argument of a
13658 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
13659 or a &%def%& condition.
13660 If certificate verification fails it may refer to a failing chain element
13661 which is not the leaf.
13662
13663 .vitem &$tls_in_certificate_verified$&
13664 .vindex "&$tls_in_certificate_verified$&"
13665 This variable is set to &"1"& if a TLS certificate was verified when the
13666 message was received, and &"0"& otherwise.
13667
13668 The deprecated &$tls_certificate_verified$& variable refers to the inbound side
13669 except when used in the context of an outbound SMTP delivery, when it refers to
13670 the outbound.
13671
13672 .vitem &$tls_out_certificate_verified$&
13673 .vindex "&$tls_out_certificate_verified$&"
13674 This variable is set to &"1"& if a TLS certificate was verified when an
13675 outbound SMTP connection was made,
13676 and &"0"& otherwise.
13677
13678 .vitem &$tls_in_cipher$&
13679 .vindex "&$tls_in_cipher$&"
13680 .vindex "&$tls_cipher$&"
13681 When a message is received from a remote host over an encrypted SMTP
13682 connection, this variable is set to the cipher suite that was negotiated, for
13683 example DES-CBC3-SHA. In other circumstances, in particular, for message
13684 received over unencrypted connections, the variable is empty. Testing
13685 &$tls_in_cipher$& for emptiness is one way of distinguishing between encrypted and
13686 non-encrypted connections during ACL processing.
13687
13688 The deprecated &$tls_cipher$& variable is the same as &$tls_in_cipher$& during message reception,
13689 but in the context of an outward SMTP delivery taking place via the &(smtp)& transport
13690 becomes the same as &$tls_out_cipher$&.
13691
13692 .vitem &$tls_in_cipher_std$&
13693 .vindex "&$tls_in_cipher_std$&"
13694 As above, but returning the RFC standard name for the cipher suite.
13695
13696 .vitem &$tls_out_cipher$&
13697 .vindex "&$tls_out_cipher$&"
13698 This variable is
13699 cleared before any outgoing SMTP connection is made,
13700 and then set to the outgoing cipher suite if one is negotiated. See chapter
13701 &<<CHAPTLS>>& for details of TLS support and chapter &<<CHAPsmtptrans>>& for
13702 details of the &(smtp)& transport.
13703
13704 .vitem &$tls_out_cipher_std$&
13705 .vindex "&$tls_out_cipher_std$&"
13706 As above, but returning the RFC standard name for the cipher suite.
13707
13708 .vitem &$tls_out_dane$&
13709 .vindex &$tls_out_dane$&
13710 DANE active status.  See section &<<SECDANE>>&.
13711
13712 .vitem &$tls_in_ocsp$&
13713 .vindex "&$tls_in_ocsp$&"
13714 When a message is received from a remote client connection
13715 the result of any OCSP request from the client is encoded in this variable:
13716 .code
13717 0 OCSP proof was not requested (default value)
13718 1 No response to request
13719 2 Response not verified
13720 3 Verification failed
13721 4 Verification succeeded
13722 .endd
13723
13724 .vitem &$tls_out_ocsp$&
13725 .vindex "&$tls_out_ocsp$&"
13726 When a message is sent to a remote host connection
13727 the result of any OCSP request made is encoded in this variable.
13728 See &$tls_in_ocsp$& for values.
13729
13730 .vitem &$tls_in_peerdn$&
13731 .vindex "&$tls_in_peerdn$&"
13732 .vindex "&$tls_peerdn$&"
13733 .cindex certificate "extracting fields"
13734 When a message is received from a remote host over an encrypted SMTP
13735 connection, and Exim is configured to request a certificate from the client,
13736 the value of the Distinguished Name of the certificate is made available in the
13737 &$tls_in_peerdn$& during subsequent processing.
13738 If certificate verification fails it may refer to a failing chain element
13739 which is not the leaf.
13740
13741 The deprecated &$tls_peerdn$& variable refers to the inbound side
13742 except when used in the context of an outbound SMTP delivery, when it refers to
13743 the outbound.
13744
13745 .vitem &$tls_out_peerdn$&
13746 .vindex "&$tls_out_peerdn$&"
13747 When a message is being delivered to a remote host over an encrypted SMTP
13748 connection, and Exim is configured to request a certificate from the server,
13749 the value of the Distinguished Name of the certificate is made available in the
13750 &$tls_out_peerdn$& during subsequent processing.
13751 If certificate verification fails it may refer to a failing chain element
13752 which is not the leaf.
13753
13754 .vitem &$tls_in_sni$&
13755 .vindex "&$tls_in_sni$&"
13756 .vindex "&$tls_sni$&"
13757 .cindex "TLS" "Server Name Indication"
13758 When a TLS session is being established, if the client sends the Server
13759 Name Indication extension, the value will be placed in this variable.
13760 If the variable appears in &%tls_certificate%& then this option and
13761 some others, described in &<<SECTtlssni>>&,
13762 will be re-expanded early in the TLS session, to permit
13763 a different certificate to be presented (and optionally a different key to be
13764 used) to the client, based upon the value of the SNI extension.
13765
13766 The deprecated &$tls_sni$& variable refers to the inbound side
13767 except when used in the context of an outbound SMTP delivery, when it refers to
13768 the outbound.
13769
13770 .vitem &$tls_out_sni$&
13771 .vindex "&$tls_out_sni$&"
13772 .cindex "TLS" "Server Name Indication"
13773 During outbound
13774 SMTP deliveries, this variable reflects the value of the &%tls_sni%& option on
13775 the transport.
13776
13777 .vitem &$tls_out_tlsa_usage$&
13778 .vindex &$tls_out_tlsa_usage$&
13779 Bitfield of TLSA record types found.  See section &<<SECDANE>>&.
13780
13781 .vitem &$tls_in_ver$&
13782 .vindex "&$tls_in_ver$&"
13783 When a message is received from a remote host over an encrypted SMTP connection
13784 this variable is set to the protocol version, eg &'TLS1.2'&.
13785
13786 .vitem &$tls_out_ver$&
13787 .vindex "&$tls_out_ver$&"
13788 When a message is being delivered to a remote host over an encrypted SMTP connection
13789 this variable is set to the protocol version.
13790
13791
13792 .vitem &$tod_bsdinbox$&
13793 .vindex "&$tod_bsdinbox$&"
13794 The time of day and the date, in the format required for BSD-style mailbox
13795 files, for example: Thu Oct 17 17:14:09 1995.
13796
13797 .vitem &$tod_epoch$&
13798 .vindex "&$tod_epoch$&"
13799 The time and date as a number of seconds since the start of the Unix epoch.
13800
13801 .vitem &$tod_epoch_l$&
13802 .vindex "&$tod_epoch_l$&"
13803 The time and date as a number of microseconds since the start of the Unix epoch.
13804
13805 .vitem &$tod_full$&
13806 .vindex "&$tod_full$&"
13807 A full version of the time and date, for example: Wed, 16 Oct 1995 09:51:40
13808 +0100. The timezone is always given as a numerical offset from UTC, with
13809 positive values used for timezones that are ahead (east) of UTC, and negative
13810 values for those that are behind (west).
13811
13812 .vitem &$tod_log$&
13813 .vindex "&$tod_log$&"
13814 The time and date in the format used for writing Exim's log files, for example:
13815 1995-10-12 15:32:29, but without a timezone.
13816
13817 .vitem &$tod_logfile$&
13818 .vindex "&$tod_logfile$&"
13819 This variable contains the date in the format yyyymmdd. This is the format that
13820 is used for datestamping log files when &%log_file_path%& contains the &`%D`&
13821 flag.
13822
13823 .vitem &$tod_zone$&
13824 .vindex "&$tod_zone$&"
13825 This variable contains the numerical value of the local timezone, for example:
13826 -0500.
13827
13828 .vitem &$tod_zulu$&
13829 .vindex "&$tod_zulu$&"
13830 This variable contains the UTC date and time in &"Zulu"& format, as specified
13831 by ISO 8601, for example: 20030221154023Z.
13832
13833 .vitem &$transport_name$&
13834 .cindex "transport" "name"
13835 .cindex "name" "of transport"
13836 .vindex "&$transport_name$&"
13837 During the running of a transport, this variable contains its name.
13838
13839 .vitem &$value$&
13840 .vindex "&$value$&"
13841 This variable contains the result of an expansion lookup, extraction operation,
13842 or external command, as described above. It is also used during a
13843 &*reduce*& expansion.
13844
13845 .vitem &$verify_mode$&
13846 .vindex "&$verify_mode$&"
13847 While a router or transport is being run in verify mode or for cutthrough delivery,
13848 contains "S" for sender-verification or "R" for recipient-verification.
13849 Otherwise, empty.
13850
13851 .vitem &$version_number$&
13852 .vindex "&$version_number$&"
13853 The version number of Exim. Same as &$exim_version$&, may be overridden
13854 by the &%exim_version%& main config option.
13855
13856 .vitem &$warn_message_delay$&
13857 .vindex "&$warn_message_delay$&"
13858 This variable is set only during the creation of a message warning about a
13859 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
13860
13861 .vitem &$warn_message_recipients$&
13862 .vindex "&$warn_message_recipients$&"
13863 This variable is set only during the creation of a message warning about a
13864 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
13865 .endlist
13866 .ecindex IIDstrexp
13867
13868
13869
13870 . ////////////////////////////////////////////////////////////////////////////
13871 . ////////////////////////////////////////////////////////////////////////////
13872
13873 .chapter "Embedded Perl" "CHAPperl"
13874 .scindex IIDperl "Perl" "calling from Exim"
13875 Exim can be built to include an embedded Perl interpreter. When this is done,
13876 Perl subroutines can be called as part of the string expansion process. To make
13877 use of the Perl support, you need version 5.004 or later of Perl installed on
13878 your system. To include the embedded interpreter in the Exim binary, include
13879 the line
13880 .code
13881 EXIM_PERL = perl.o
13882 .endd
13883 in your &_Local/Makefile_& and then build Exim in the normal way.
13884
13885
13886 .section "Setting up so Perl can be used" "SECID85"
13887 .oindex "&%perl_startup%&"
13888 Access to Perl subroutines is via a global configuration option called
13889 &%perl_startup%& and an expansion string operator &%${perl ...}%&. If there is
13890 no &%perl_startup%& option in the Exim configuration file then no Perl
13891 interpreter is started and there is almost no overhead for Exim (since none of
13892 the Perl library will be paged in unless used). If there is a &%perl_startup%&
13893 option then the associated value is taken to be Perl code which is executed in
13894 a newly created Perl interpreter.
13895
13896 The value of &%perl_startup%& is not expanded in the Exim sense, so you do not
13897 need backslashes before any characters to escape special meanings. The option
13898 should usually be something like
13899 .code
13900 perl_startup = do '/etc/exim.pl'
13901 .endd
13902 where &_/etc/exim.pl_& is Perl code which defines any subroutines you want to
13903 use from Exim. Exim can be configured either to start up a Perl interpreter as
13904 soon as it is entered, or to wait until the first time it is needed. Starting
13905 the interpreter at the beginning ensures that it is done while Exim still has
13906 its setuid privilege, but can impose an unnecessary overhead if Perl is not in
13907 fact used in a particular run. Also, note that this does not mean that Exim is
13908 necessarily running as root when Perl is called at a later time. By default,
13909 the interpreter is started only when it is needed, but this can be changed in
13910 two ways:
13911
13912 .ilist
13913 .oindex "&%perl_at_start%&"
13914 Setting &%perl_at_start%& (a boolean option) in the configuration requests
13915 a startup when Exim is entered.
13916 .next
13917 The command line option &%-ps%& also requests a startup when Exim is entered,
13918 overriding the setting of &%perl_at_start%&.
13919 .endlist
13920
13921 There is also a command line option &%-pd%& (for delay) which suppresses the
13922 initial startup, even if &%perl_at_start%& is set.
13923
13924 .ilist
13925 .oindex "&%perl_taintmode%&"
13926 .cindex "Perl" "taintmode"
13927 To provide more security executing Perl code via the embedded Perl
13928 interpreter, the &%perl_taintmode%& option can be set. This enables the
13929 taint mode of the Perl interpreter. You are encouraged to set this
13930 option to a true value. To avoid breaking existing installations, it
13931 defaults to false.
13932
13933
13934 .section "Calling Perl subroutines" "SECID86"
13935 When the configuration file includes a &%perl_startup%& option you can make use
13936 of the string expansion item to call the Perl subroutines that are defined
13937 by the &%perl_startup%& code. The operator is used in any of the following
13938 forms:
13939 .code
13940 ${perl{foo}}
13941 ${perl{foo}{argument}}
13942 ${perl{foo}{argument1}{argument2} ... }
13943 .endd
13944 which calls the subroutine &%foo%& with the given arguments. A maximum of eight
13945 arguments may be passed. Passing more than this results in an expansion failure
13946 with an error message of the form
13947 .code
13948 Too many arguments passed to Perl subroutine "foo" (max is 8)
13949 .endd
13950 The return value of the Perl subroutine is evaluated in a scalar context before
13951 it is passed back to Exim to be inserted into the expanded string. If the
13952 return value is &'undef'&, the expansion is forced to fail in the same way as
13953 an explicit &"fail"& on an &%if%& or &%lookup%& item. If the subroutine aborts
13954 by obeying Perl's &%die%& function, the expansion fails with the error message
13955 that was passed to &%die%&.
13956
13957
13958 .section "Calling Exim functions from Perl" "SECID87"
13959 Within any Perl code called from Exim, the function &'Exim::expand_string()'&
13960 is available to call back into Exim's string expansion function. For example,
13961 the Perl code
13962 .code
13963 my $lp = Exim::expand_string('$local_part');
13964 .endd
13965 makes the current Exim &$local_part$& available in the Perl variable &$lp$&.
13966 Note those are single quotes and not double quotes to protect against
13967 &$local_part$& being interpolated as a Perl variable.
13968
13969 If the string expansion is forced to fail by a &"fail"& item, the result of
13970 &'Exim::expand_string()'& is &%undef%&. If there is a syntax error in the
13971 expansion string, the Perl call from the original expansion string fails with
13972 an appropriate error message, in the same way as if &%die%& were used.
13973
13974 .cindex "debugging" "from embedded Perl"
13975 .cindex "log" "writing from embedded Perl"
13976 Two other Exim functions are available for use from within Perl code.
13977 &'Exim::debug_write()'& writes a string to the standard error stream if Exim's
13978 debugging is enabled. If you want a newline at the end, you must supply it.
13979 &'Exim::log_write()'& writes a string to Exim's main log, adding a leading
13980 timestamp. In this case, you should not supply a terminating newline.
13981
13982
13983 .section "Use of standard output and error by Perl" "SECID88"
13984 .cindex "Perl" "standard output and error"
13985 You should not write to the standard error or output streams from within your
13986 Perl code, as it is not defined how these are set up. In versions of Exim
13987 before 4.50, it is possible for the standard output or error to refer to the
13988 SMTP connection during message reception via the daemon. Writing to this stream
13989 is certain to cause chaos. From Exim 4.50 onwards, the standard output and
13990 error streams are connected to &_/dev/null_& in the daemon. The chaos is
13991 avoided, but the output is lost.
13992
13993 .cindex "Perl" "use of &%warn%&"
13994 The Perl &%warn%& statement writes to the standard error stream by default.
13995 Calls to &%warn%& may be embedded in Perl modules that you use, but over which
13996 you have no control. When Exim starts up the Perl interpreter, it arranges for
13997 output from the &%warn%& statement to be written to the Exim main log. You can
13998 change this by including appropriate Perl magic somewhere in your Perl code.
13999 For example, to discard &%warn%& output completely, you need this:
14000 .code
14001 $SIG{__WARN__} = sub { };
14002 .endd
14003 Whenever a &%warn%& is obeyed, the anonymous subroutine is called. In this
14004 example, the code for the subroutine is empty, so it does nothing, but you can
14005 include any Perl code that you like. The text of the &%warn%& message is passed
14006 as the first subroutine argument.
14007 .ecindex IIDperl
14008
14009
14010 . ////////////////////////////////////////////////////////////////////////////
14011 . ////////////////////////////////////////////////////////////////////////////
14012
14013 .chapter "Starting the daemon and the use of network interfaces" &&&
14014          "CHAPinterfaces" &&&
14015          "Starting the daemon"
14016 .cindex "daemon" "starting"
14017 .cindex "interface" "listening"
14018 .cindex "network interface"
14019 .cindex "interface" "network"
14020 .cindex "IP address" "for listening"
14021 .cindex "daemon" "listening IP addresses"
14022 .cindex "TCP/IP" "setting listening interfaces"
14023 .cindex "TCP/IP" "setting listening ports"
14024 A host that is connected to a TCP/IP network may have one or more physical
14025 hardware network interfaces. Each of these interfaces may be configured as one
14026 or more &"logical"& interfaces, which are the entities that a program actually
14027 works with. Each of these logical interfaces is associated with an IP address.
14028 In addition, TCP/IP software supports &"loopback"& interfaces (127.0.0.1 in
14029 IPv4 and ::1 in IPv6), which do not use any physical hardware. Exim requires
14030 knowledge about the host's interfaces for use in three different circumstances:
14031
14032 .olist
14033 When a listening daemon is started, Exim needs to know which interfaces
14034 and ports to listen on.
14035 .next
14036 When Exim is routing an address, it needs to know which IP addresses
14037 are associated with local interfaces. This is required for the correct
14038 processing of MX lists by removing the local host and others with the
14039 same or higher priority values. Also, Exim needs to detect cases
14040 when an address is routed to an IP address that in fact belongs to the
14041 local host. Unless the &%self%& router option or the &%allow_localhost%&
14042 option of the smtp transport is set (as appropriate), this is treated
14043 as an error situation.
14044 .next
14045 When Exim connects to a remote host, it may need to know which interface to use
14046 for the outgoing connection.
14047 .endlist
14048
14049
14050 Exim's default behaviour is likely to be appropriate in the vast majority
14051 of cases. If your host has only one interface, and you want all its IP
14052 addresses to be treated in the same way, and you are using only the
14053 standard SMTP port, you should not need to take any special action. The
14054 rest of this chapter does not apply to you.
14055
14056 In a more complicated situation you may want to listen only on certain
14057 interfaces, or on different ports, and for this reason there are a number of
14058 options that can be used to influence Exim's behaviour. The rest of this
14059 chapter describes how they operate.
14060
14061 When a message is received over TCP/IP, the interface and port that were
14062 actually used are set in &$received_ip_address$& and &$received_port$&.
14063
14064
14065
14066 .section "Starting a listening daemon" "SECID89"
14067 When a listening daemon is started (by means of the &%-bd%& command line
14068 option), the interfaces and ports on which it listens are controlled by the
14069 following options:
14070
14071 .ilist
14072 &%daemon_smtp_ports%& contains a list of default ports
14073 or service names.
14074 (For backward compatibility, this option can also be specified in the singular.)
14075 .next
14076 &%local_interfaces%& contains list of interface IP addresses on which to
14077 listen. Each item may optionally also specify a port.
14078 .endlist
14079
14080 The default list separator in both cases is a colon, but this can be changed as
14081 described in section &<<SECTlistsepchange>>&. When IPv6 addresses are involved,
14082 it is usually best to change the separator to avoid having to double all the
14083 colons. For example:
14084 .code
14085 local_interfaces = <; 127.0.0.1 ; \
14086                       192.168.23.65 ; \
14087                       ::1 ; \
14088                       3ffe:ffff:836f::fe86:a061
14089 .endd
14090 There are two different formats for specifying a port along with an IP address
14091 in &%local_interfaces%&:
14092
14093 .olist
14094 The port is added onto the address with a dot separator. For example, to listen
14095 on port 1234 on two different IP addresses:
14096 .code
14097 local_interfaces = <; 192.168.23.65.1234 ; \
14098                       3ffe:ffff:836f::fe86:a061.1234
14099 .endd
14100 .next
14101 The IP address is enclosed in square brackets, and the port is added
14102 with a colon separator, for example:
14103 .code
14104 local_interfaces = <; [192.168.23.65]:1234 ; \
14105                       [3ffe:ffff:836f::fe86:a061]:1234
14106 .endd
14107 .endlist
14108
14109 When a port is not specified, the value of &%daemon_smtp_ports%& is used. The
14110 default setting contains just one port:
14111 .code
14112 daemon_smtp_ports = smtp
14113 .endd
14114 If more than one port is listed, each interface that does not have its own port
14115 specified listens on all of them. Ports that are listed in
14116 &%daemon_smtp_ports%& can be identified either by name (defined in
14117 &_/etc/services_&) or by number. However, when ports are given with individual
14118 IP addresses in &%local_interfaces%&, only numbers (not names) can be used.
14119
14120
14121
14122 .section "Special IP listening addresses" "SECID90"
14123 The addresses 0.0.0.0 and ::0 are treated specially. They are interpreted
14124 as &"all IPv4 interfaces"& and &"all IPv6 interfaces"&, respectively. In each
14125 case, Exim tells the TCP/IP stack to &"listen on all IPv&'x'& interfaces"&
14126 instead of setting up separate listening sockets for each interface. The
14127 default value of &%local_interfaces%& is
14128 .code
14129 local_interfaces = 0.0.0.0
14130 .endd
14131 when Exim is built without IPv6 support; otherwise it is:
14132 .code
14133 local_interfaces = <; ::0 ; 0.0.0.0
14134 .endd
14135 Thus, by default, Exim listens on all available interfaces, on the SMTP port.
14136
14137
14138
14139 .section "Overriding local_interfaces and daemon_smtp_ports" "SECID91"
14140 The &%-oX%& command line option can be used to override the values of
14141 &%daemon_smtp_ports%& and/or &%local_interfaces%& for a particular daemon
14142 instance. Another way of doing this would be to use macros and the &%-D%&
14143 option. However, &%-oX%& can be used by any admin user, whereas modification of
14144 the runtime configuration by &%-D%& is allowed only when the caller is root or
14145 exim.
14146
14147 The value of &%-oX%& is a list of items. The default colon separator can be
14148 changed in the usual way (&<<SECTlistsepchange>>&) if required.
14149 If there are any items that do not
14150 contain dots or colons (that is, are not IP addresses), the value of
14151 &%daemon_smtp_ports%& is replaced by the list of those items. If there are any
14152 items that do contain dots or colons, the value of &%local_interfaces%& is
14153 replaced by those items. Thus, for example,
14154 .code
14155 -oX 1225
14156 .endd
14157 overrides &%daemon_smtp_ports%&, but leaves &%local_interfaces%& unchanged,
14158 whereas
14159 .code
14160 -oX 192.168.34.5.1125
14161 .endd
14162 overrides &%local_interfaces%&, leaving &%daemon_smtp_ports%& unchanged.
14163 (However, since &%local_interfaces%& now contains no items without ports, the
14164 value of &%daemon_smtp_ports%& is no longer relevant in this example.)
14165
14166
14167
14168 .section "Support for the submissions (aka SSMTP or SMTPS) protocol" "SECTsupobssmt"
14169 .cindex "submissions protocol"
14170 .cindex "ssmtp protocol"
14171 .cindex "smtps protocol"
14172 .cindex "SMTP" "ssmtp protocol"
14173 .cindex "SMTP" "smtps protocol"
14174 Exim supports the use of TLS-on-connect, used by mail clients in the
14175 &"submissions"& protocol, historically also known as SMTPS or SSMTP.
14176 For some years, IETF Standards Track documents only blessed the
14177 STARTTLS-based Submission service (port 587) while common practice was to support
14178 the same feature set on port 465, but using TLS-on-connect.
14179 If your installation needs to provide service to mail clients
14180 (Mail User Agents, MUAs) then you should provide service on both the 587 and
14181 the 465 TCP ports.
14182
14183 If the &%tls_on_connect_ports%& option is set to a list of port numbers or
14184 service names, connections to those ports must first establish TLS, before
14185 proceeding to the application layer use of the SMTP protocol.
14186
14187 The common use of this option is expected to be
14188 .code
14189 tls_on_connect_ports = 465
14190 .endd
14191 per RFC 8314.
14192 There is also a command line option &%-tls-on-connect%&, which forces all ports
14193 to behave in this way when a daemon is started.
14194
14195 &*Warning*&: Setting &%tls_on_connect_ports%& does not of itself cause the
14196 daemon to listen on those ports. You must still specify them in
14197 &%daemon_smtp_ports%&, &%local_interfaces%&, or the &%-oX%& option. (This is
14198 because &%tls_on_connect_ports%& applies to &%inetd%& connections as well as to
14199 connections via the daemon.)
14200
14201
14202
14203
14204 .section "IPv6 address scopes" "SECID92"
14205 .cindex "IPv6" "address scopes"
14206 IPv6 addresses have &"scopes"&, and a host with multiple hardware interfaces
14207 can, in principle, have the same link-local IPv6 address on different
14208 interfaces. Thus, additional information is needed, over and above the IP
14209 address, to distinguish individual interfaces. A convention of using a
14210 percent sign followed by something (often the interface name) has been
14211 adopted in some cases, leading to addresses like this:
14212 .code
14213 fe80::202:b3ff:fe03:45c1%eth0
14214 .endd
14215 To accommodate this usage, a percent sign followed by an arbitrary string is
14216 allowed at the end of an IPv6 address. By default, Exim calls &[getaddrinfo()]&
14217 to convert a textual IPv6 address for actual use. This function recognizes the
14218 percent convention in operating systems that support it, and it processes the
14219 address appropriately. Unfortunately, some older libraries have problems with
14220 &[getaddrinfo()]&. If
14221 .code
14222 IPV6_USE_INET_PTON=yes
14223 .endd
14224 is set in &_Local/Makefile_& (or an OS-dependent Makefile) when Exim is built,
14225 Exim uses &'inet_pton()'& to convert a textual IPv6 address for actual use,
14226 instead of &[getaddrinfo()]&. (Before version 4.14, it always used this
14227 function.) Of course, this means that the additional functionality of
14228 &[getaddrinfo()]& &-- recognizing scoped addresses &-- is lost.
14229
14230 .section "Disabling IPv6" "SECID93"
14231 .cindex "IPv6" "disabling"
14232 Sometimes it happens that an Exim binary that was compiled with IPv6 support is
14233 run on a host whose kernel does not support IPv6. The binary will fall back to
14234 using IPv4, but it may waste resources looking up AAAA records, and trying to
14235 connect to IPv6 addresses, causing delays to mail delivery. If you set the
14236 .oindex "&%disable_ipv6%&"
14237 &%disable_ipv6%& option true, even if the Exim binary has IPv6 support, no IPv6
14238 activities take place. AAAA records are never looked up, and any IPv6 addresses
14239 that are listed in &%local_interfaces%&, data for the &(manualroute)& router,
14240 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
14241 to handle IPv6 literal addresses.
14242
14243 On the other hand, when IPv6 is in use, there may be times when you want to
14244 disable it for certain hosts or domains. You can use the &%dns_ipv4_lookup%&
14245 option to globally suppress the lookup of AAAA records for specified domains,
14246 and you can use the &%ignore_target_hosts%& generic router option to ignore
14247 IPv6 addresses in an individual router.
14248
14249
14250
14251 .section "Examples of starting a listening daemon" "SECID94"
14252 The default case in an IPv6 environment is
14253 .code
14254 daemon_smtp_ports = smtp
14255 local_interfaces = <; ::0 ; 0.0.0.0
14256 .endd
14257 This specifies listening on the smtp port on all IPv6 and IPv4 interfaces.
14258 Either one or two sockets may be used, depending on the characteristics of
14259 the TCP/IP stack. (This is complicated and messy; for more information,
14260 read the comments in the &_daemon.c_& source file.)
14261
14262 To specify listening on ports 25 and 26 on all interfaces:
14263 .code
14264 daemon_smtp_ports = 25 : 26
14265 .endd
14266 (leaving &%local_interfaces%& at the default setting) or, more explicitly:
14267 .code
14268 local_interfaces = <; ::0.25     ; ::0.26 \
14269                       0.0.0.0.25 ; 0.0.0.0.26
14270 .endd
14271 To listen on the default port on all IPv4 interfaces, and on port 26 on the
14272 IPv4 loopback address only:
14273 .code
14274 local_interfaces = 0.0.0.0 : 127.0.0.1.26
14275 .endd
14276 To specify listening on the default port on specific interfaces only:
14277 .code
14278 local_interfaces = 10.0.0.67 : 192.168.34.67
14279 .endd
14280 &*Warning*&: Such a setting excludes listening on the loopback interfaces.
14281
14282
14283
14284 .section "Recognizing the local host" "SECTreclocipadd"
14285 The &%local_interfaces%& option is also used when Exim needs to determine
14286 whether or not an IP address refers to the local host. That is, the IP
14287 addresses of all the interfaces on which a daemon is listening are always
14288 treated as local.
14289
14290 For this usage, port numbers in &%local_interfaces%& are ignored. If either of
14291 the items 0.0.0.0 or ::0 are encountered, Exim gets a complete list of
14292 available interfaces from the operating system, and extracts the relevant
14293 (that is, IPv4 or IPv6) addresses to use for checking.
14294
14295 Some systems set up large numbers of virtual interfaces in order to provide
14296 many virtual web servers. In this situation, you may want to listen for
14297 email on only a few of the available interfaces, but nevertheless treat all
14298 interfaces as local when routing. You can do this by setting
14299 &%extra_local_interfaces%& to a list of IP addresses, possibly including the
14300 &"all"& wildcard values. These addresses are recognized as local, but are not
14301 used for listening. Consider this example:
14302 .code
14303 local_interfaces = <; 127.0.0.1 ; ::1 ; \
14304                       192.168.53.235 ; \
14305                       3ffe:2101:12:1:a00:20ff:fe86:a061
14306
14307 extra_local_interfaces = <; ::0 ; 0.0.0.0
14308 .endd
14309 The daemon listens on the loopback interfaces and just one IPv4 and one IPv6
14310 address, but all available interface addresses are treated as local when
14311 Exim is routing.
14312
14313 In some environments the local host name may be in an MX list, but with an IP
14314 address that is not assigned to any local interface. In other cases it may be
14315 desirable to treat other host names as if they referred to the local host. Both
14316 these cases can be handled by setting the &%hosts_treat_as_local%& option.
14317 This contains host names rather than IP addresses. When a host is referenced
14318 during routing, either via an MX record or directly, it is treated as the local
14319 host if its name matches &%hosts_treat_as_local%&, or if any of its IP
14320 addresses match &%local_interfaces%& or &%extra_local_interfaces%&.
14321
14322
14323
14324 .section "Delivering to a remote host" "SECID95"
14325 Delivery to a remote host is handled by the smtp transport. By default, it
14326 allows the system's TCP/IP functions to choose which interface to use (if
14327 there is more than one) when connecting to a remote host. However, the
14328 &%interface%& option can be set to specify which interface is used. See the
14329 description of the smtp transport in chapter &<<CHAPsmtptrans>>& for more
14330 details.
14331
14332
14333
14334
14335 . ////////////////////////////////////////////////////////////////////////////
14336 . ////////////////////////////////////////////////////////////////////////////
14337
14338 .chapter "Main configuration" "CHAPmainconfig"
14339 .scindex IIDconfima "configuration file" "main section"
14340 .scindex IIDmaiconf "main configuration"
14341 The first part of the runtime configuration file contains three types of item:
14342
14343 .ilist
14344 Macro definitions: These lines start with an upper case letter. See section
14345 &<<SECTmacrodefs>>& for details of macro processing.
14346 .next
14347 Named list definitions: These lines start with one of the words &"domainlist"&,
14348 &"hostlist"&, &"addresslist"&, or &"localpartlist"&. Their use is described in
14349 section &<<SECTnamedlists>>&.
14350 .next
14351 Main configuration settings: Each setting occupies one line of the file
14352 (with possible continuations). If any setting is preceded by the word
14353 &"hide"&, the &%-bP%& command line option displays its value to admin users
14354 only. See section &<<SECTcos>>& for a description of the syntax of these option
14355 settings.
14356 .endlist
14357
14358 This chapter specifies all the main configuration options, along with their
14359 types and default values. For ease of finding a particular option, they appear
14360 in alphabetical order in section &<<SECTalomo>>& below. However, because there
14361 are now so many options, they are first listed briefly in functional groups, as
14362 an aid to finding the name of the option you are looking for. Some options are
14363 listed in more than one group.
14364
14365 .section "Miscellaneous" "SECID96"
14366 .table2
14367 .row &%bi_command%&                  "to run for &%-bi%& command line option"
14368 .row &%debug_store%&                 "do extra internal checks"
14369 .row &%disable_ipv6%&                "do no IPv6 processing"
14370 .row &%keep_malformed%&              "for broken files &-- should not happen"
14371 .row &%localhost_number%&            "for unique message ids in clusters"
14372 .row &%message_body_newlines%&       "retain newlines in &$message_body$&"
14373 .row &%message_body_visible%&        "how much to show in &$message_body$&"
14374 .row &%mua_wrapper%&                 "run in &""MUA wrapper""& mode"
14375 .row &%print_topbitchars%&           "top-bit characters are printing"
14376 .row &%spool_wireformat%&            "use wire-format spool data files when possible"
14377 .row &%timezone%&                    "force time zone"
14378 .endtable
14379
14380
14381 .section "Exim parameters" "SECID97"
14382 .table2
14383 .row &%exim_group%&                  "override compiled-in value"
14384 .row &%exim_path%&                   "override compiled-in value"
14385 .row &%exim_user%&                   "override compiled-in value"
14386 .row &%primary_hostname%&            "default from &[uname()]&"
14387 .row &%split_spool_directory%&       "use multiple directories"
14388 .row &%spool_directory%&             "override compiled-in value"
14389 .endtable
14390
14391
14392
14393 .section "Privilege controls" "SECID98"
14394 .table2
14395 .row &%admin_groups%&                "groups that are Exim admin users"
14396 .row &%commandline_checks_require_admin%& "require admin for various checks"
14397 .row &%deliver_drop_privilege%&      "drop root for delivery processes"
14398 .row &%local_from_check%&            "insert &'Sender:'& if necessary"
14399 .row &%local_from_prefix%&           "for testing &'From:'& for local sender"
14400 .row &%local_from_suffix%&           "for testing &'From:'& for local sender"
14401 .row &%local_sender_retain%&         "keep &'Sender:'& from untrusted user"
14402 .row &%never_users%&                 "do not run deliveries as these"
14403 .row &%prod_requires_admin%&         "forced delivery requires admin user"
14404 .row &%queue_list_requires_admin%&   "queue listing requires admin user"
14405 .row &%trusted_groups%&              "groups that are trusted"
14406 .row &%trusted_users%&               "users that are trusted"
14407 .endtable
14408
14409
14410
14411 .section "Logging" "SECID99"
14412 .table2
14413 .row &%event_action%&                "custom logging"
14414 .row &%hosts_connection_nolog%&      "exemption from connect logging"
14415 .row &%log_file_path%&               "override compiled-in value"
14416 .row &%log_selector%&                "set/unset optional logging"
14417 .row &%log_timezone%&                "add timezone to log lines"
14418 .row &%message_logs%&                "create per-message logs"
14419 .row &%preserve_message_logs%&       "after message completion"
14420 .row &%process_log_path%&            "for SIGUSR1 and &'exiwhat'&"
14421 .row &%slow_lookup_log%&             "control logging of slow DNS lookups"
14422 .row &%syslog_duplication%&          "controls duplicate log lines on syslog"
14423 .row &%syslog_facility%&             "set syslog &""facility""& field"
14424 .row &%syslog_pid%&                  "pid in syslog lines"
14425 .row &%syslog_processname%&          "set syslog &""ident""& field"
14426 .row &%syslog_timestamp%&            "timestamp syslog lines"
14427 .row &%write_rejectlog%&             "control use of message log"
14428 .endtable
14429
14430
14431
14432 .section "Frozen messages" "SECID100"
14433 .table2
14434 .row &%auto_thaw%&                   "sets time for retrying frozen messages"
14435 .row &%freeze_tell%&                 "send message when freezing"
14436 .row &%move_frozen_messages%&        "to another directory"
14437 .row &%timeout_frozen_after%&        "keep frozen messages only so long"
14438 .endtable
14439
14440
14441
14442 .section "Data lookups" "SECID101"
14443 .table2
14444 .row &%ibase_servers%&               "InterBase servers"
14445 .row &%ldap_ca_cert_dir%&            "dir of CA certs to verify LDAP server's"
14446 .row &%ldap_ca_cert_file%&           "file of CA certs to verify LDAP server's"
14447 .row &%ldap_cert_file%&              "client cert file for LDAP"
14448 .row &%ldap_cert_key%&               "client key file for LDAP"
14449 .row &%ldap_cipher_suite%&           "TLS negotiation preference control"
14450 .row &%ldap_default_servers%&        "used if no server in query"
14451 .row &%ldap_require_cert%&           "action to take without LDAP server cert"
14452 .row &%ldap_start_tls%&              "require TLS within LDAP"
14453 .row &%ldap_version%&                "set protocol version"
14454 .row &%lookup_open_max%&             "lookup files held open"
14455 .row &%mysql_servers%&               "default MySQL servers"
14456 .row &%oracle_servers%&              "Oracle servers"
14457 .row &%pgsql_servers%&               "default PostgreSQL servers"
14458 .row &%sqlite_lock_timeout%&         "as it says"
14459 .endtable
14460
14461
14462
14463 .section "Message ids" "SECID102"
14464 .table2
14465 .row &%message_id_header_domain%&    "used to build &'Message-ID:'& header"
14466 .row &%message_id_header_text%&      "ditto"
14467 .endtable
14468
14469
14470
14471 .section "Embedded Perl Startup" "SECID103"
14472 .table2
14473 .row &%perl_at_start%&               "always start the interpreter"
14474 .row &%perl_startup%&                "code to obey when starting Perl"
14475 .row &%perl_taintmode%&              "enable taint mode in Perl"
14476 .endtable
14477
14478
14479
14480 .section "Daemon" "SECID104"
14481 .table2
14482 .row &%daemon_smtp_ports%&           "default ports"
14483 .row &%daemon_startup_retries%&      "number of times to retry"
14484 .row &%daemon_startup_sleep%&        "time to sleep between tries"
14485 .row &%extra_local_interfaces%&      "not necessarily listened on"
14486 .row &%local_interfaces%&            "on which to listen, with optional ports"
14487 .row &%notifier_socket%&             "override compiled-in value"
14488 .row &%pid_file_path%&               "override compiled-in value"
14489 .row &%queue_run_max%&               "maximum simultaneous queue runners"
14490 .endtable
14491
14492
14493
14494 .section "Resource control" "SECID105"
14495 .table2
14496 .row &%check_log_inodes%&            "before accepting a message"
14497 .row &%check_log_space%&             "before accepting a message"
14498 .row &%check_spool_inodes%&          "before accepting a message"
14499 .row &%check_spool_space%&           "before accepting a message"
14500 .row &%deliver_queue_load_max%&      "no queue deliveries if load high"
14501 .row &%queue_only_load%&             "queue incoming if load high"
14502 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
14503 .row &%queue_run_max%&               "maximum simultaneous queue runners"
14504 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
14505 .row &%smtp_accept_max%&             "simultaneous incoming connections"
14506 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
14507 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
14508 .row &%smtp_accept_max_per_connection%& "messages per connection"
14509 .row &%smtp_accept_max_per_host%&    "connections from one host"
14510 .row &%smtp_accept_queue%&           "queue mail if more connections"
14511 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
14512                                            connection"
14513 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
14514 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
14515 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
14516 .row &%smtp_load_reserve%&           "SMTP from reserved hosts if load high"
14517 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
14518 .endtable
14519
14520
14521
14522 .section "Policy controls" "SECID106"
14523 .table2
14524 .row &%acl_not_smtp%&                "ACL for non-SMTP messages"
14525 .row &%acl_not_smtp_mime%&           "ACL for non-SMTP MIME parts"
14526 .row &%acl_not_smtp_start%&          "ACL for start of non-SMTP message"
14527 .row &%acl_smtp_auth%&               "ACL for AUTH"
14528 .row &%acl_smtp_connect%&            "ACL for connection"
14529 .row &%acl_smtp_data%&               "ACL for DATA"
14530 .row &%acl_smtp_data_prdr%&          "ACL for DATA, per-recipient"
14531 .row &%acl_smtp_dkim%&               "ACL for DKIM verification"
14532 .row &%acl_smtp_etrn%&               "ACL for ETRN"
14533 .row &%acl_smtp_expn%&               "ACL for EXPN"
14534 .row &%acl_smtp_helo%&               "ACL for EHLO or HELO"
14535 .row &%acl_smtp_mail%&               "ACL for MAIL"
14536 .row &%acl_smtp_mailauth%&           "ACL for AUTH on MAIL command"
14537 .row &%acl_smtp_mime%&               "ACL for MIME parts"
14538 .row &%acl_smtp_notquit%&            "ACL for non-QUIT terminations"
14539 .row &%acl_smtp_predata%&            "ACL for start of data"
14540 .row &%acl_smtp_quit%&               "ACL for QUIT"
14541 .row &%acl_smtp_rcpt%&               "ACL for RCPT"
14542 .row &%acl_smtp_starttls%&           "ACL for STARTTLS"
14543 .row &%acl_smtp_vrfy%&               "ACL for VRFY"
14544 .row &%av_scanner%&                  "specify virus scanner"
14545 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
14546                                       words""&"
14547 .row &%dns_cname_loops%&             "follow CNAMEs returned by resolver"
14548 .row &%dns_csa_search_limit%&        "control CSA parent search depth"
14549 .row &%dns_csa_use_reverse%&         "en/disable CSA IP reverse search"
14550 .row &%header_maxsize%&              "total size of message header"
14551 .row &%header_line_maxsize%&         "individual header line limit"
14552 .row &%helo_accept_junk_hosts%&      "allow syntactic junk from these hosts"
14553 .row &%helo_allow_chars%&            "allow illegal chars in HELO names"
14554 .row &%helo_lookup_domains%&         "lookup hostname for these HELO names"
14555 .row &%helo_try_verify_hosts%&       "HELO soft-checked for these hosts"
14556 .row &%helo_verify_hosts%&           "HELO hard-checked for these hosts"
14557 .row &%host_lookup%&                 "host name looked up for these hosts"
14558 .row &%host_lookup_order%&           "order of DNS and local name lookups"
14559 .row &%hosts_proxy%&                 "use proxy protocol for these hosts"
14560 .row &%host_reject_connection%&      "reject connection from these hosts"
14561 .row &%hosts_treat_as_local%&        "useful in some cluster configurations"
14562 .row &%local_scan_timeout%&          "timeout for &[local_scan()]&"
14563 .row &%message_size_limit%&          "for all messages"
14564 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
14565 .row &%spamd_address%&               "set interface to SpamAssassin"
14566 .row &%strict_acl_vars%&             "object to unset ACL variables"
14567 .endtable
14568
14569
14570
14571 .section "Callout cache" "SECID107"
14572 .table2
14573 .row &%callout_domain_negative_expire%& "timeout for negative domain cache &&&
14574                                          item"
14575 .row &%callout_domain_positive_expire%& "timeout for positive domain cache &&&
14576                                          item"
14577 .row &%callout_negative_expire%&     "timeout for negative address cache item"
14578 .row &%callout_positive_expire%&     "timeout for positive address cache item"
14579 .row &%callout_random_local_part%&   "string to use for &""random""& testing"
14580 .endtable
14581
14582
14583
14584 .section "TLS" "SECID108"
14585 .table2
14586 .row &%gnutls_compat_mode%&          "use GnuTLS compatibility mode"
14587 .row &%gnutls_allow_auto_pkcs11%&    "allow GnuTLS to autoload PKCS11 modules"
14588 .row &%openssl_options%&             "adjust OpenSSL compatibility options"
14589 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
14590 .row &%tls_certificate%&             "location of server certificate"
14591 .row &%tls_crl%&                     "certificate revocation list"
14592 .row &%tls_dh_max_bits%&             "clamp D-H bit count suggestion"
14593 .row &%tls_dhparam%&                 "DH parameters for server"
14594 .row &%tls_eccurve%&                 "EC curve selection for server"
14595 .row &%tls_ocsp_file%&               "location of server certificate status proof"
14596 .row &%tls_on_connect_ports%&        "specify SSMTP (SMTPS) ports"
14597 .row &%tls_privatekey%&              "location of server private key"
14598 .row &%tls_remember_esmtp%&          "don't reset after starting TLS"
14599 .row &%tls_require_ciphers%&         "specify acceptable ciphers"
14600 .row &%tls_try_verify_hosts%&        "try to verify client certificate"
14601 .row &%tls_verify_certificates%&     "expected client certificates"
14602 .row &%tls_verify_hosts%&            "insist on client certificate verify"
14603 .endtable
14604
14605
14606
14607 .section "Local user handling" "SECID109"
14608 .table2
14609 .row &%finduser_retries%&            "useful in NIS environments"
14610 .row &%gecos_name%&                  "used when creating &'Sender:'&"
14611 .row &%gecos_pattern%&               "ditto"
14612 .row &%max_username_length%&         "for systems that truncate"
14613 .row &%unknown_login%&               "used when no login name found"
14614 .row &%unknown_username%&            "ditto"
14615 .row &%uucp_from_pattern%&           "for recognizing &""From ""& lines"
14616 .row &%uucp_from_sender%&            "ditto"
14617 .endtable
14618
14619
14620
14621 .section "All incoming messages (SMTP and non-SMTP)" "SECID110"
14622 .table2
14623 .row &%header_maxsize%&              "total size of message header"
14624 .row &%header_line_maxsize%&         "individual header line limit"
14625 .row &%message_size_limit%&          "applies to all messages"
14626 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
14627 .row &%received_header_text%&        "expanded to make &'Received:'&"
14628 .row &%received_headers_max%&        "for mail loop detection"
14629 .row &%recipients_max%&              "limit per message"
14630 .row &%recipients_max_reject%&       "permanently reject excess recipients"
14631 .endtable
14632
14633
14634
14635
14636 .section "Non-SMTP incoming messages" "SECID111"
14637 .table2
14638 .row &%receive_timeout%&             "for non-SMTP messages"
14639 .endtable
14640
14641
14642
14643
14644
14645 .section "Incoming SMTP messages" "SECID112"
14646 See also the &'Policy controls'& section above.
14647
14648 .table2
14649 .row &%dkim_verify_hashes%&          "DKIM hash methods accepted for signatures"
14650 .row &%dkim_verify_keytypes%&        "DKIM key types accepted for signatures"
14651 .row &%dkim_verify_min_keysizes%&    "DKIM key sizes accepted for signatures"
14652 .row &%dkim_verify_signers%&         "DKIM domains for which DKIM ACL is run"
14653 .row &%host_lookup%&                 "host name looked up for these hosts"
14654 .row &%host_lookup_order%&           "order of DNS and local name lookups"
14655 .row &%recipient_unqualified_hosts%& "may send unqualified recipients"
14656 .row &%rfc1413_hosts%&               "make ident calls to these hosts"
14657 .row &%rfc1413_query_timeout%&       "zero disables ident calls"
14658 .row &%sender_unqualified_hosts%&    "may send unqualified senders"
14659 .row &%smtp_accept_keepalive%&       "some TCP/IP magic"
14660 .row &%smtp_accept_max%&             "simultaneous incoming connections"
14661 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
14662 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
14663 .row &%smtp_accept_max_per_connection%& "messages per connection"
14664 .row &%smtp_accept_max_per_host%&    "connections from one host"
14665 .row &%smtp_accept_queue%&           "queue mail if more connections"
14666 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
14667                                            connection"
14668 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
14669 .row &%smtp_active_hostname%&        "host name to use in messages"
14670 .row &%smtp_banner%&                 "text for welcome banner"
14671 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
14672 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
14673 .row &%smtp_enforce_sync%&           "of SMTP command/responses"
14674 .row &%smtp_etrn_command%&           "what to run for ETRN"
14675 .row &%smtp_etrn_serialize%&         "only one at once"
14676 .row &%smtp_load_reserve%&           "only reserve hosts if this load"
14677 .row &%smtp_max_unknown_commands%&   "before dropping connection"
14678 .row &%smtp_ratelimit_hosts%&        "apply ratelimiting to these hosts"
14679 .row &%smtp_ratelimit_mail%&         "ratelimit for MAIL commands"
14680 .row &%smtp_ratelimit_rcpt%&         "ratelimit for RCPT commands"
14681 .row &%smtp_receive_timeout%&        "per command or data line"
14682 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
14683 .row &%smtp_return_error_details%&   "give detail on rejections"
14684 .endtable
14685
14686
14687
14688 .section "SMTP extensions" "SECID113"
14689 .table2
14690 .row &%accept_8bitmime%&             "advertise 8BITMIME"
14691 .row &%auth_advertise_hosts%&        "advertise AUTH to these hosts"
14692 .row &%chunking_advertise_hosts%&    "advertise CHUNKING to these hosts"
14693 .row &%dsn_advertise_hosts%&         "advertise DSN extensions to these hosts"
14694 .row &%ignore_fromline_hosts%&       "allow &""From ""& from these hosts"
14695 .row &%ignore_fromline_local%&       "allow &""From ""& from local SMTP"
14696 .row &%pipelining_advertise_hosts%&  "advertise pipelining to these hosts"
14697 .row &%pipelining_connect_advertise_hosts%& "advertise pipelining to these hosts"
14698 .row &%prdr_enable%&                 "advertise PRDR to all hosts"
14699 .row &%smtputf8_advertise_hosts%&    "advertise SMTPUTF8 to these hosts"
14700 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
14701 .endtable
14702
14703
14704
14705 .section "Processing messages" "SECID114"
14706 .table2
14707 .row &%allow_domain_literals%&       "recognize domain literal syntax"
14708 .row &%allow_mx_to_ip%&              "allow MX to point to IP address"
14709 .row &%allow_utf8_domains%&          "in addresses"
14710 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
14711                                       words""&"
14712 .row &%delivery_date_remove%&        "from incoming messages"
14713 .row &%envelope_to_remove%&          "from incoming messages"
14714 .row &%extract_addresses_remove_arguments%& "affects &%-t%& processing"
14715 .row &%headers_charset%&             "default for translations"
14716 .row &%qualify_domain%&              "default for senders"
14717 .row &%qualify_recipient%&           "default for recipients"
14718 .row &%return_path_remove%&          "from incoming messages"
14719 .row &%strip_excess_angle_brackets%& "in addresses"
14720 .row &%strip_trailing_dot%&          "at end of addresses"
14721 .row &%untrusted_set_sender%&        "untrusted can set envelope sender"
14722 .endtable
14723
14724
14725
14726 .section "System filter" "SECID115"
14727 .table2
14728 .row &%system_filter%&               "locate system filter"
14729 .row &%system_filter_directory_transport%& "transport for delivery to a &&&
14730                                             directory"
14731 .row &%system_filter_file_transport%& "transport for delivery to a file"
14732 .row &%system_filter_group%&         "group for filter running"
14733 .row &%system_filter_pipe_transport%& "transport for delivery to a pipe"
14734 .row &%system_filter_reply_transport%& "transport for autoreply delivery"
14735 .row &%system_filter_user%&          "user for filter running"
14736 .endtable
14737
14738
14739
14740 .section "Routing and delivery" "SECID116"
14741 .table2
14742 .row &%disable_ipv6%&                "do no IPv6 processing"
14743 .row &%dns_again_means_nonexist%&    "for broken domains"
14744 .row &%dns_check_names_pattern%&     "pre-DNS syntax check"
14745 .row &%dns_dnssec_ok%&               "parameter for resolver"
14746 .row &%dns_ipv4_lookup%&             "only v4 lookup for these domains"
14747 .row &%dns_retrans%&                 "parameter for resolver"
14748 .row &%dns_retry%&                   "parameter for resolver"
14749 .row &%dns_trust_aa%&                "DNS zones trusted as authentic"
14750 .row &%dns_use_edns0%&               "parameter for resolver"
14751 .row &%hold_domains%&                "hold delivery for these domains"
14752 .row &%local_interfaces%&            "for routing checks"
14753 .row &%queue_domains%&               "no immediate delivery for these"
14754 .row &%queue_only%&                  "no immediate delivery at all"
14755 .row &%queue_only_file%&             "no immediate delivery if file exists"
14756 .row &%queue_only_load%&             "no immediate delivery if load is high"
14757 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
14758 .row &%queue_only_override%&         "allow command line to override"
14759 .row &%queue_run_in_order%&          "order of arrival"
14760 .row &%queue_run_max%&               "of simultaneous queue runners"
14761 .row &%queue_smtp_domains%&          "no immediate SMTP delivery for these"
14762 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
14763 .row &%remote_sort_domains%&         "order of remote deliveries"
14764 .row &%retry_data_expire%&           "timeout for retry data"
14765 .row &%retry_interval_max%&          "safety net for retry rules"
14766 .endtable
14767
14768
14769
14770 .section "Bounce and warning messages" "SECID117"
14771 .table2
14772 .row &%bounce_message_file%&         "content of bounce"
14773 .row &%bounce_message_text%&         "content of bounce"
14774 .row &%bounce_return_body%&          "include body if returning message"
14775 .row &%bounce_return_linesize_limit%& "limit on returned message line length"
14776 .row &%bounce_return_message%&       "include original message in bounce"
14777 .row &%bounce_return_size_limit%&    "limit on returned message"
14778 .row &%bounce_sender_authentication%& "send authenticated sender with bounce"
14779 .row &%dsn_from%&                    "set &'From:'& contents in bounces"
14780 .row &%errors_copy%&                 "copy bounce messages"
14781 .row &%errors_reply_to%&             "&'Reply-to:'& in bounces"
14782 .row &%delay_warning%&               "time schedule"
14783 .row &%delay_warning_condition%&     "condition for warning messages"
14784 .row &%ignore_bounce_errors_after%&  "discard undeliverable bounces"
14785 .row &%smtp_return_error_details%&   "give detail on rejections"
14786 .row &%warn_message_file%&           "content of warning message"
14787 .endtable
14788
14789
14790
14791 .section "Alphabetical list of main options" "SECTalomo"
14792 Those options that undergo string expansion before use are marked with
14793 &dagger;.
14794
14795 .option accept_8bitmime main boolean true
14796 .cindex "8BITMIME"
14797 .cindex "8-bit characters"
14798 .cindex "log" "selectors"
14799 .cindex "log" "8BITMIME"
14800 .cindex "ESMTP extensions" 8BITMIME
14801 This option causes Exim to send 8BITMIME in its response to an SMTP
14802 EHLO command, and to accept the BODY= parameter on MAIL commands.
14803 However, though Exim is 8-bit clean, it is not a protocol converter, and it
14804 takes no steps to do anything special with messages received by this route.
14805
14806 Historically Exim kept this option off by default, but the maintainers
14807 feel that in today's Internet, this causes more problems than it solves.
14808 It now defaults to true.
14809 A more detailed analysis of the issues is provided by Dan Bernstein:
14810 .display
14811 &url(https://cr.yp.to/smtp/8bitmime.html)
14812 .endd
14813
14814 To log received 8BITMIME status use
14815 .code
14816 log_selector = +8bitmime
14817 .endd
14818
14819 .option acl_not_smtp main string&!! unset
14820 .cindex "&ACL;" "for non-SMTP messages"
14821 .cindex "non-SMTP messages" "ACLs for"
14822 This option defines the ACL that is run when a non-SMTP message has been
14823 read and is on the point of being accepted. See chapter &<<CHAPACL>>& for
14824 further details.
14825
14826 .option acl_not_smtp_mime main string&!! unset
14827 This option defines the ACL that is run for individual MIME parts of non-SMTP
14828 messages. It operates in exactly the same way as &%acl_smtp_mime%& operates for
14829 SMTP messages.
14830
14831 .option acl_not_smtp_start main string&!! unset
14832 .cindex "&ACL;" "at start of non-SMTP message"
14833 .cindex "non-SMTP messages" "ACLs for"
14834 This option defines the ACL that is run before Exim starts reading a
14835 non-SMTP message. See chapter &<<CHAPACL>>& for further details.
14836
14837 .option acl_smtp_auth main string&!! unset
14838 .cindex "&ACL;" "setting up for SMTP commands"
14839 .cindex "AUTH" "ACL for"
14840 This option defines the ACL that is run when an SMTP AUTH command is
14841 received. See chapter &<<CHAPACL>>& for further details.
14842
14843 .option acl_smtp_connect main string&!! unset
14844 .cindex "&ACL;" "on SMTP connection"
14845 This option defines the ACL that is run when an SMTP connection is received.
14846 See chapter &<<CHAPACL>>& for further details.
14847
14848 .option acl_smtp_data main string&!! unset
14849 .cindex "DATA" "ACL for"
14850 This option defines the ACL that is run after an SMTP DATA command has been
14851 processed and the message itself has been received, but before the final
14852 acknowledgment is sent. See chapter &<<CHAPACL>>& for further details.
14853
14854 .option acl_smtp_data_prdr main string&!! accept
14855 .cindex "PRDR" "ACL for"
14856 .cindex "DATA" "PRDR ACL for"
14857 .cindex "&ACL;" "PRDR-related"
14858 .cindex "&ACL;" "per-user data processing"
14859 This option defines the ACL that,
14860 if the PRDR feature has been negotiated,
14861 is run for each recipient after an SMTP DATA command has been
14862 processed and the message itself has been received, but before the
14863 acknowledgment is sent. See chapter &<<CHAPACL>>& for further details.
14864
14865 .option acl_smtp_dkim main string&!! unset
14866 .cindex DKIM "ACL for"
14867 This option defines the ACL that is run for each DKIM signature
14868 (by default, or as specified in the dkim_verify_signers option)
14869 of a received message.
14870 See section &<<SECDKIMVFY>>& for further details.
14871
14872 .option acl_smtp_etrn main string&!! unset
14873 .cindex "ETRN" "ACL for"
14874 This option defines the ACL that is run when an SMTP ETRN command is
14875 received. See chapter &<<CHAPACL>>& for further details.
14876
14877 .option acl_smtp_expn main string&!! unset
14878 .cindex "EXPN" "ACL for"
14879 This option defines the ACL that is run when an SMTP EXPN command is
14880 received. See chapter &<<CHAPACL>>& for further details.
14881
14882 .option acl_smtp_helo main string&!! unset
14883 .cindex "EHLO" "ACL for"
14884 .cindex "HELO" "ACL for"
14885 This option defines the ACL that is run when an SMTP EHLO or HELO
14886 command is received. See chapter &<<CHAPACL>>& for further details.
14887
14888
14889 .option acl_smtp_mail main string&!! unset
14890 .cindex "MAIL" "ACL for"
14891 This option defines the ACL that is run when an SMTP MAIL command is
14892 received. See chapter &<<CHAPACL>>& for further details.
14893
14894 .option acl_smtp_mailauth main string&!! unset
14895 .cindex "AUTH" "on MAIL command"
14896 This option defines the ACL that is run when there is an AUTH parameter on
14897 a MAIL command. See chapter &<<CHAPACL>>& for details of ACLs, and chapter
14898 &<<CHAPSMTPAUTH>>& for details of authentication.
14899
14900 .option acl_smtp_mime main string&!! unset
14901 .cindex "MIME content scanning" "ACL for"
14902 This option is available when Exim is built with the content-scanning
14903 extension. It defines the ACL that is run for each MIME part in a message. See
14904 section &<<SECTscanmimepart>>& for details.
14905
14906 .option acl_smtp_notquit main string&!! unset
14907 .cindex "not-QUIT, ACL for"
14908 This option defines the ACL that is run when an SMTP session
14909 ends without a QUIT command being received.
14910 See chapter &<<CHAPACL>>& for further details.
14911
14912 .option acl_smtp_predata main string&!! unset
14913 This option defines the ACL that is run when an SMTP DATA command is
14914 received, before the message itself is received. See chapter &<<CHAPACL>>& for
14915 further details.
14916
14917 .option acl_smtp_quit main string&!! unset
14918 .cindex "QUIT, ACL for"
14919 This option defines the ACL that is run when an SMTP QUIT command is
14920 received. See chapter &<<CHAPACL>>& for further details.
14921
14922 .option acl_smtp_rcpt main string&!! unset
14923 .cindex "RCPT" "ACL for"
14924 This option defines the ACL that is run when an SMTP RCPT command is
14925 received. See chapter &<<CHAPACL>>& for further details.
14926
14927 .option acl_smtp_starttls main string&!! unset
14928 .cindex "STARTTLS, ACL for"
14929 This option defines the ACL that is run when an SMTP STARTTLS command is
14930 received. See chapter &<<CHAPACL>>& for further details.
14931
14932 .option acl_smtp_vrfy main string&!! unset
14933 .cindex "VRFY" "ACL for"
14934 This option defines the ACL that is run when an SMTP VRFY command is
14935 received. See chapter &<<CHAPACL>>& for further details.
14936
14937 .option add_environment main "string list" empty
14938 .cindex "environment" "set values"
14939 This option adds individual environment variables that the
14940 currently linked libraries and programs in child processes may use.
14941 Each list element should be of the form &"name=value"&.
14942
14943 See &<<SECTpipeenv>>& for the environment of &(pipe)& transports.
14944
14945 .option admin_groups main "string list&!!" unset
14946 .cindex "admin user"
14947 This option is expanded just once, at the start of Exim's processing. If the
14948 current group or any of the supplementary groups of an Exim caller is in this
14949 colon-separated list, the caller has admin privileges. If all your system
14950 programmers are in a specific group, for example, you can give them all Exim
14951 admin privileges by putting that group in &%admin_groups%&. However, this does
14952 not permit them to read Exim's spool files (whose group owner is the Exim gid).
14953 To permit this, you have to add individuals to the Exim group.
14954
14955 .option allow_domain_literals main boolean false
14956 .cindex "domain literal"
14957 If this option is set, the RFC 2822 domain literal format is permitted in
14958 email addresses. The option is not set by default, because the domain literal
14959 format is not normally required these days, and few people know about it. It
14960 has, however, been exploited by mail abusers.
14961
14962 Unfortunately, it seems that some DNS black list maintainers are using this
14963 format to report black listing to postmasters. If you want to accept messages
14964 addressed to your hosts by IP address, you need to set
14965 &%allow_domain_literals%& true, and also to add &`@[]`& to the list of local
14966 domains (defined in the named domain list &%local_domains%& in the default
14967 configuration). This &"magic string"& matches the domain literal form of all
14968 the local host's IP addresses.
14969
14970
14971 .option allow_mx_to_ip main boolean false
14972 .cindex "MX record" "pointing to IP address"
14973 It appears that more and more DNS zone administrators are breaking the rules
14974 and putting domain names that look like IP addresses on the right hand side of
14975 MX records. Exim follows the rules and rejects this, giving an error message
14976 that explains the misconfiguration. However, some other MTAs support this
14977 practice, so to avoid &"Why can't Exim do this?"& complaints,
14978 &%allow_mx_to_ip%& exists, in order to enable this heinous activity. It is not
14979 recommended, except when you have no other choice.
14980
14981 .option allow_utf8_domains main boolean false
14982 .cindex "domain" "UTF-8 characters in"
14983 .cindex "UTF-8" "in domain name"
14984 Lots of discussion is going on about internationalized domain names. One
14985 camp is strongly in favour of just using UTF-8 characters, and it seems
14986 that at least two other MTAs permit this.
14987 This option allows Exim users to experiment if they wish.
14988
14989 If it is set true, Exim's domain parsing function allows valid
14990 UTF-8 multicharacters to appear in domain name components, in addition to
14991 letters, digits, and hyphens.
14992
14993 If Exim is built with internationalization support
14994 and the SMTPUTF8 ESMTP option is in use (see chapter &<<CHAPi18n>>&)
14995 this option can be left as default.
14996 Without that,
14997 if you want to look up such domain names in the DNS, you must also
14998 adjust the value of &%dns_check_names_pattern%& to match the extended form. A
14999 suitable setting is:
15000 .code
15001 dns_check_names_pattern = (?i)^(?>(?(1)\.|())[a-z0-9\xc0-\xff]\
15002   (?>[-a-z0-9\x80-\xff]*[a-z0-9\x80-\xbf])?)+$
15003 .endd
15004 Alternatively, you can just disable this feature by setting
15005 .code
15006 dns_check_names_pattern =
15007 .endd
15008 That is, set the option to an empty string so that no check is done.
15009
15010
15011 .option auth_advertise_hosts main "host list&!!" *
15012 .cindex "authentication" "advertising"
15013 .cindex "AUTH" "advertising"
15014 .cindex "ESMTP extensions" AUTH
15015 If any server authentication mechanisms are configured, Exim advertises them in
15016 response to an EHLO command only if the calling host matches this list.
15017 Otherwise, Exim does not advertise AUTH.
15018 Exim does not accept AUTH commands from clients to which it has not
15019 advertised the availability of AUTH. The advertising of individual
15020 authentication mechanisms can be controlled by the use of the
15021 &%server_advertise_condition%& generic authenticator option on the individual
15022 authenticators. See chapter &<<CHAPSMTPAUTH>>& for further details.
15023
15024 Certain mail clients (for example, Netscape) require the user to provide a name
15025 and password for authentication if AUTH is advertised, even though it may
15026 not be needed (the host may accept messages from hosts on its local LAN without
15027 authentication, for example). The &%auth_advertise_hosts%& option can be used
15028 to make these clients more friendly by excluding them from the set of hosts to
15029 which Exim advertises AUTH.
15030
15031 .cindex "AUTH" "advertising when encrypted"
15032 If you want to advertise the availability of AUTH only when the connection
15033 is encrypted using TLS, you can make use of the fact that the value of this
15034 option is expanded, with a setting like this:
15035 .code
15036 auth_advertise_hosts = ${if eq{$tls_in_cipher}{}{}{*}}
15037 .endd
15038 .vindex "&$tls_in_cipher$&"
15039 If &$tls_in_cipher$& is empty, the session is not encrypted, and the result of
15040 the expansion is empty, thus matching no hosts. Otherwise, the result of the
15041 expansion is *, which matches all hosts.
15042
15043
15044 .option auto_thaw main time 0s
15045 .cindex "thawing messages"
15046 .cindex "unfreezing messages"
15047 If this option is set to a time greater than zero, a queue runner will try a
15048 new delivery attempt on any frozen message, other than a bounce message, if
15049 this much time has passed since it was frozen. This may result in the message
15050 being re-frozen if nothing has changed since the last attempt. It is a way of
15051 saying &"keep on trying, even though there are big problems"&.
15052
15053 &*Note*&: This is an old option, which predates &%timeout_frozen_after%& and
15054 &%ignore_bounce_errors_after%&. It is retained for compatibility, but it is not
15055 thought to be very useful any more, and its use should probably be avoided.
15056
15057
15058 .option av_scanner main string "see below"
15059 This option is available if Exim is built with the content-scanning extension.
15060 It specifies which anti-virus scanner to use. The default value is:
15061 .code
15062 sophie:/var/run/sophie
15063 .endd
15064 If the value of &%av_scanner%& starts with a dollar character, it is expanded
15065 before use. See section &<<SECTscanvirus>>& for further details.
15066
15067
15068 .option bi_command main string unset
15069 .oindex "&%-bi%&"
15070 This option supplies the name of a command that is run when Exim is called with
15071 the &%-bi%& option (see chapter &<<CHAPcommandline>>&). The string value is
15072 just the command name, it is not a complete command line. If an argument is
15073 required, it must come from the &%-oA%& command line option.
15074
15075
15076 .option bounce_message_file main string&!! unset
15077 .cindex "bounce message" "customizing"
15078 .cindex "customizing" "bounce message"
15079 This option defines a template file containing paragraphs of text to be used
15080 for constructing bounce messages.  Details of the file's contents are given in
15081 chapter &<<CHAPemsgcust>>&.
15082 .new
15083 .cindex bounce_message_file "tainted data"
15084 The option is expanded to give the file path, which must be
15085 absolute and untainted.
15086 .wen
15087 See also &%warn_message_file%&.
15088
15089
15090 .option bounce_message_text main string unset
15091 When this option is set, its contents are included in the default bounce
15092 message immediately after &"This message was created automatically by mail
15093 delivery software."& It is not used if &%bounce_message_file%& is set.
15094
15095 .option bounce_return_body main boolean true
15096 .cindex "bounce message" "including body"
15097 This option controls whether the body of an incoming message is included in a
15098 bounce message when &%bounce_return_message%& is true. The default setting
15099 causes the entire message, both header and body, to be returned (subject to the
15100 value of &%bounce_return_size_limit%&). If this option is false, only the
15101 message header is included. In the case of a non-SMTP message containing an
15102 error that is detected during reception, only those header lines preceding the
15103 point at which the error was detected are returned.
15104 .cindex "bounce message" "including original"
15105
15106 .option bounce_return_linesize_limit main integer 998
15107 .cindex "size" "of bounce lines, limit"
15108 .cindex "bounce message" "line length limit"
15109 .cindex "limit" "bounce message line length"
15110 This option sets a limit in bytes on the line length of messages
15111 that are returned to senders due to delivery problems,
15112 when &%bounce_return_message%& is true.
15113 The default value corresponds to RFC limits.
15114 If the message being returned has lines longer than this value it is
15115 treated as if the &%bounce_return_size_limit%& (below) restriction was exceeded.
15116
15117 The option also applies to bounces returned when an error is detected
15118 during reception of a message.
15119 In this case lines from the original are truncated.
15120
15121 The option does not apply to messages generated by an &(autoreply)& transport.
15122
15123
15124 .option bounce_return_message main boolean true
15125 If this option is set false, none of the original message is included in
15126 bounce messages generated by Exim. See also &%bounce_return_size_limit%& and
15127 &%bounce_return_body%&.
15128
15129
15130 .option bounce_return_size_limit main integer 100K
15131 .cindex "size" "of bounce, limit"
15132 .cindex "bounce message" "size limit"
15133 .cindex "limit" "bounce message size"
15134 This option sets a limit in bytes on the size of messages that are returned to
15135 senders as part of bounce messages when &%bounce_return_message%& is true. The
15136 limit should be less than the value of the global &%message_size_limit%& and of
15137 any &%message_size_limit%& settings on transports, to allow for the bounce text
15138 that Exim generates. If this option is set to zero there is no limit.
15139
15140 When the body of any message that is to be included in a bounce message is
15141 greater than the limit, it is truncated, and a comment pointing this out is
15142 added at the top. The actual cutoff may be greater than the value given, owing
15143 to the use of buffering for transferring the message in chunks (typically 8K in
15144 size). The idea is to save bandwidth on those undeliverable 15-megabyte
15145 messages.
15146
15147 .option bounce_sender_authentication main string unset
15148 .cindex "bounce message" "sender authentication"
15149 .cindex "authentication" "bounce message"
15150 .cindex "AUTH" "on bounce message"
15151 This option provides an authenticated sender address that is sent with any
15152 bounce messages generated by Exim that are sent over an authenticated SMTP
15153 connection. A typical setting might be:
15154 .code
15155 bounce_sender_authentication = mailer-daemon@my.domain.example
15156 .endd
15157 which would cause bounce messages to be sent using the SMTP command:
15158 .code
15159 MAIL FROM:<> AUTH=mailer-daemon@my.domain.example
15160 .endd
15161 The value of &%bounce_sender_authentication%& must always be a complete email
15162 address.
15163
15164 .option callout_domain_negative_expire main time 3h
15165 .cindex "caching" "callout timeouts"
15166 .cindex "callout" "caching timeouts"
15167 This option specifies the expiry time for negative callout cache data for a
15168 domain. See section &<<SECTcallver>>& for details of callout verification, and
15169 section &<<SECTcallvercache>>& for details of the caching.
15170
15171
15172 .option callout_domain_positive_expire main time 7d
15173 This option specifies the expiry time for positive callout cache data for a
15174 domain. See section &<<SECTcallver>>& for details of callout verification, and
15175 section &<<SECTcallvercache>>& for details of the caching.
15176
15177
15178 .option callout_negative_expire main time 2h
15179 This option specifies the expiry time for negative callout cache data for an
15180 address. See section &<<SECTcallver>>& for details of callout verification, and
15181 section &<<SECTcallvercache>>& for details of the caching.
15182
15183
15184 .option callout_positive_expire main time 24h
15185 This option specifies the expiry time for positive callout cache data for an
15186 address. See section &<<SECTcallver>>& for details of callout verification, and
15187 section &<<SECTcallvercache>>& for details of the caching.
15188
15189
15190 .option callout_random_local_part main string&!! "see below"
15191 This option defines the &"random"& local part that can be used as part of
15192 callout verification. The default value is
15193 .code
15194 $primary_hostname-$tod_epoch-testing
15195 .endd
15196 See section &<<CALLaddparcall>>& for details of how this value is used.
15197
15198
15199 .option check_log_inodes main integer 100
15200 See &%check_spool_space%& below.
15201
15202
15203 .option check_log_space main integer 10M
15204 See &%check_spool_space%& below.
15205
15206 .oindex "&%check_rfc2047_length%&"
15207 .cindex "RFC 2047" "disabling length check"
15208 .option check_rfc2047_length main boolean true
15209 RFC 2047 defines a way of encoding non-ASCII characters in headers using a
15210 system of &"encoded words"&. The RFC specifies a maximum length for an encoded
15211 word; strings to be encoded that exceed this length are supposed to use
15212 multiple encoded words. By default, Exim does not recognize encoded words that
15213 exceed the maximum length. However, it seems that some software, in violation
15214 of the RFC, generates overlong encoded words. If &%check_rfc2047_length%& is
15215 set false, Exim recognizes encoded words of any length.
15216
15217
15218 .option check_spool_inodes main integer 100
15219 See &%check_spool_space%& below.
15220
15221
15222 .option check_spool_space main integer 10M
15223 .cindex "checking disk space"
15224 .cindex "disk space, checking"
15225 .cindex "spool directory" "checking space"
15226 The four &%check_...%& options allow for checking of disk resources before a
15227 message is accepted.
15228
15229 .vindex "&$log_inodes$&"
15230 .vindex "&$log_space$&"
15231 .vindex "&$spool_inodes$&"
15232 .vindex "&$spool_space$&"
15233 When any of these options are nonzero, they apply to all incoming messages. If you
15234 want to apply different checks to different kinds of message, you can do so by
15235 testing the variables &$log_inodes$&, &$log_space$&, &$spool_inodes$&, and
15236 &$spool_space$& in an ACL with appropriate additional conditions.
15237
15238
15239 &%check_spool_space%& and &%check_spool_inodes%& check the spool partition if
15240 either value is greater than zero, for example:
15241 .code
15242 check_spool_space = 100M
15243 check_spool_inodes = 100
15244 .endd
15245 The spool partition is the one that contains the directory defined by
15246 SPOOL_DIRECTORY in &_Local/Makefile_&. It is used for holding messages in
15247 transit.
15248
15249 &%check_log_space%& and &%check_log_inodes%&  check the partition in which log
15250 files are written if either is greater than zero. These should be set only if
15251 &%log_file_path%& and &%spool_directory%& refer to different partitions.
15252
15253 If there is less space or fewer inodes than requested, Exim refuses to accept
15254 incoming mail. In the case of SMTP input this is done by giving a 452 temporary
15255 error response to the MAIL command. If ESMTP is in use and there was a
15256 SIZE parameter on the MAIL command, its value is added to the
15257 &%check_spool_space%& value, and the check is performed even if
15258 &%check_spool_space%& is zero, unless &%no_smtp_check_spool_space%& is set.
15259
15260 The values for &%check_spool_space%& and &%check_log_space%& are held as a
15261 number of kilobytes (though specified in bytes).
15262 If a non-multiple of 1024 is specified, it is rounded up.
15263
15264 For non-SMTP input and for batched SMTP input, the test is done at start-up; on
15265 failure a message is written to stderr and Exim exits with a non-zero code, as
15266 it obviously cannot send an error message of any kind.
15267
15268 There is a slight performance penalty for these checks.
15269 Versions of Exim preceding 4.88 had these disabled by default;
15270 high-rate installations confident they will never run out of resources
15271 may wish to deliberately disable them.
15272
15273 .option chunking_advertise_hosts main "host list&!!" *
15274 .cindex CHUNKING advertisement
15275 .cindex "RFC 3030" "CHUNKING"
15276 .cindex "ESMTP extensions" CHUNKING
15277 The CHUNKING extension (RFC3030) will be advertised in the EHLO message to
15278 these hosts.
15279 Hosts may use the BDAT command as an alternate to DATA.
15280
15281 .option commandline_checks_require_admin main boolean &`false`&
15282 .cindex "restricting access to features"
15283 This option restricts various basic checking features to require an
15284 administrative user.
15285 This affects most of the &%-b*%& options, such as &%-be%&.
15286
15287 .option debug_store main boolean &`false`&
15288 .cindex debugging "memory corruption"
15289 .cindex memory debugging
15290 This option, when true, enables extra checking in Exim's internal memory
15291 management.  For use when a memory corruption issue is being investigated,
15292 it should normally be left as default.
15293
15294 .option daemon_smtp_ports main string &`smtp`&
15295 .cindex "port" "for daemon"
15296 .cindex "TCP/IP" "setting listening ports"
15297 This option specifies one or more default SMTP ports on which the Exim daemon
15298 listens. See chapter &<<CHAPinterfaces>>& for details of how it is used. For
15299 backward compatibility, &%daemon_smtp_port%& (singular) is a synonym.
15300
15301 .option daemon_startup_retries main integer 9
15302 .cindex "daemon startup, retrying"
15303 This option, along with &%daemon_startup_sleep%&, controls the retrying done by
15304 the daemon at startup when it cannot immediately bind a listening socket
15305 (typically because the socket is already in use): &%daemon_startup_retries%&
15306 defines the number of retries after the first failure, and
15307 &%daemon_startup_sleep%& defines the length of time to wait between retries.
15308
15309 .option daemon_startup_sleep main time 30s
15310 See &%daemon_startup_retries%&.
15311
15312 .option delay_warning main "time list" 24h
15313 .cindex "warning of delay"
15314 .cindex "delay warning, specifying"
15315 .cindex "queue" "delay warning"
15316 When a message is delayed, Exim sends a warning message to the sender at
15317 intervals specified by this option. The data is a colon-separated list of times
15318 after which to send warning messages. If the value of the option is an empty
15319 string or a zero time, no warnings are sent. Up to 10 times may be given. If a
15320 message has been in the queue for longer than the last time, the last interval
15321 between the times is used to compute subsequent warning times. For example,
15322 with
15323 .code
15324 delay_warning = 4h:8h:24h
15325 .endd
15326 the first message is sent after 4 hours, the second after 8 hours, and
15327 the third one after 24 hours. After that, messages are sent every 16 hours,
15328 because that is the interval between the last two times on the list. If you set
15329 just one time, it specifies the repeat interval. For example, with:
15330 .code
15331 delay_warning = 6h
15332 .endd
15333 messages are repeated every six hours. To stop warnings after a given time, set
15334 a very large time at the end of the list. For example:
15335 .code
15336 delay_warning = 2h:12h:99d
15337 .endd
15338 Note that the option is only evaluated at the time a delivery attempt fails,
15339 which depends on retry and queue-runner configuration.
15340 Typically retries will be configured more frequently than warning messages.
15341
15342 .option delay_warning_condition main string&!! "see below"
15343 .vindex "&$domain$&"
15344 The string is expanded at the time a warning message might be sent. If all the
15345 deferred addresses have the same domain, it is set in &$domain$& during the
15346 expansion. Otherwise &$domain$& is empty. If the result of the expansion is a
15347 forced failure, an empty string, or a string matching any of &"0"&, &"no"& or
15348 &"false"& (the comparison being done caselessly) then the warning message is
15349 not sent. The default is:
15350 .code
15351 delay_warning_condition = ${if or {\
15352   { !eq{$h_list-id:$h_list-post:$h_list-subscribe:}{} }\
15353   { match{$h_precedence:}{(?i)bulk|list|junk} }\
15354   { match{$h_auto-submitted:}{(?i)auto-generated|auto-replied} }\
15355   } {no}{yes}}
15356 .endd
15357 This suppresses the sending of warnings for messages that contain &'List-ID:'&,
15358 &'List-Post:'&, or &'List-Subscribe:'& headers, or have &"bulk"&, &"list"& or
15359 &"junk"& in a &'Precedence:'& header, or have &"auto-generated"& or
15360 &"auto-replied"& in an &'Auto-Submitted:'& header.
15361
15362 .option deliver_drop_privilege main boolean false
15363 .cindex "unprivileged delivery"
15364 .cindex "delivery" "unprivileged"
15365 If this option is set true, Exim drops its root privilege at the start of a
15366 delivery process, and runs as the Exim user throughout. This severely restricts
15367 the kinds of local delivery that are possible, but is viable in certain types
15368 of configuration. There is a discussion about the use of root privilege in
15369 chapter &<<CHAPsecurity>>&.
15370
15371 .option deliver_queue_load_max main fixed-point unset
15372 .cindex "load average"
15373 .cindex "queue runner" "abandoning"
15374 When this option is set, a queue run is abandoned if the system load average
15375 becomes greater than the value of the option. The option has no effect on
15376 ancient operating systems on which Exim cannot determine the load average.
15377 See also &%queue_only_load%& and &%smtp_load_reserve%&.
15378
15379
15380 .option delivery_date_remove main boolean true
15381 .cindex "&'Delivery-date:'& header line"
15382 Exim's transports have an option for adding a &'Delivery-date:'& header to a
15383 message when it is delivered, in exactly the same way as &'Return-path:'& is
15384 handled. &'Delivery-date:'& records the actual time of delivery. Such headers
15385 should not be present in incoming messages, and this option causes them to be
15386 removed at the time the message is received, to avoid any problems that might
15387 occur when a delivered message is subsequently sent on to some other recipient.
15388
15389 .option disable_fsync main boolean false
15390 .cindex "&[fsync()]&, disabling"
15391 This option is available only if Exim was built with the compile-time option
15392 ENABLE_DISABLE_FSYNC. When this is not set, a reference to &%disable_fsync%& in
15393 a runtime configuration generates an &"unknown option"& error. You should not
15394 build Exim with ENABLE_DISABLE_FSYNC or set &%disable_fsync%& unless you
15395 really, really, really understand what you are doing. &'No pre-compiled
15396 distributions of Exim should ever make this option available.'&
15397
15398 When &%disable_fsync%& is set true, Exim no longer calls &[fsync()]& to force
15399 updated files' data to be written to disc before continuing. Unexpected events
15400 such as crashes and power outages may cause data to be lost or scrambled.
15401 Here be Dragons. &*Beware.*&
15402
15403
15404 .option disable_ipv6 main boolean false
15405 .cindex "IPv6" "disabling"
15406 If this option is set true, even if the Exim binary has IPv6 support, no IPv6
15407 activities take place. AAAA records are never looked up, and any IPv6 addresses
15408 that are listed in &%local_interfaces%&, data for the &%manualroute%& router,
15409 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
15410 to handle IPv6 literal addresses.
15411
15412
15413 .new
15414 .option dkim_verify_hashes main "string list" "sha256 : sha512"
15415 .cindex DKIM "selecting signature algorithms"
15416 This option gives a list of hash types which are acceptable in signatures,
15417 .wen
15418 and an order of processing.
15419 Signatures with algorithms not in the list will be ignored.
15420
15421 Acceptable values include:
15422 .code
15423 sha1
15424 sha256
15425 sha512
15426 .endd
15427
15428 Note that the acceptance of sha1 violates RFC 8301.
15429
15430 .option dkim_verify_keytypes main "string list" "ed25519 : rsa"
15431 This option gives a list of key types which are acceptable in signatures,
15432 and an order of processing.
15433 Signatures with algorithms not in the list will be ignored.
15434
15435
15436 .new
15437 .option dkim_verify_min_keysizes main "string list" "rsa=1024 ed25519=250"
15438 This option gives a list of key sizes which are acceptable in signatures.
15439 The list is keyed by the algorithm type for the key; the values are in bits.
15440 Signatures with keys smaller than given by this option will fail verification.
15441
15442 The default enforces the RFC 8301 minimum key size for RSA signatures.
15443 .wen
15444
15445 .option dkim_verify_minimal main boolean false
15446 If set to true, verification of signatures will terminate after the
15447 first success.
15448
15449 .option dkim_verify_signers main "domain list&!!" $dkim_signers
15450 .cindex DKIM "controlling calls to the ACL"
15451 This option gives a list of DKIM domains for which the DKIM ACL is run.
15452 It is expanded after the message is received; by default it runs
15453 the ACL once for each signature in the message.
15454 See section &<<SECDKIMVFY>>&.
15455
15456
15457 .option dns_again_means_nonexist main "domain list&!!" unset
15458 .cindex "DNS" "&""try again""& response; overriding"
15459 DNS lookups give a &"try again"& response for the DNS errors
15460 &"non-authoritative host not found"& and &"SERVERFAIL"&. This can cause Exim to
15461 keep trying to deliver a message, or to give repeated temporary errors to
15462 incoming mail. Sometimes the effect is caused by a badly set up name server and
15463 may persist for a long time. If a domain which exhibits this problem matches
15464 anything in &%dns_again_means_nonexist%&, it is treated as if it did not exist.
15465 This option should be used with care. You can make it apply to reverse lookups
15466 by a setting such as this:
15467 .code
15468 dns_again_means_nonexist = *.in-addr.arpa
15469 .endd
15470 This option applies to all DNS lookups that Exim does. It also applies when the
15471 &[gethostbyname()]& or &[getipnodebyname()]& functions give temporary errors,
15472 since these are most likely to be caused by DNS lookup problems. The
15473 &(dnslookup)& router has some options of its own for controlling what happens
15474 when lookups for MX or SRV records give temporary errors. These more specific
15475 options are applied after this global option.
15476
15477 .option dns_check_names_pattern main string "see below"
15478 .cindex "DNS" "pre-check of name syntax"
15479 When this option is set to a non-empty string, it causes Exim to check domain
15480 names for characters that are not allowed in host names before handing them to
15481 the DNS resolver, because some resolvers give temporary errors for names that
15482 contain unusual characters. If a domain name contains any unwanted characters,
15483 a &"not found"& result is forced, and the resolver is not called. The check is
15484 done by matching the domain name against a regular expression, which is the
15485 value of this option. The default pattern is
15486 .code
15487 dns_check_names_pattern = \
15488   (?i)^(?>(?(1)\.|())[^\W_](?>[a-z0-9/-]*[^\W_])?)+$
15489 .endd
15490 which permits only letters, digits, slashes, and hyphens in components, but
15491 they must start and end with a letter or digit. Slashes are not, in fact,
15492 permitted in host names, but they are found in certain NS records (which can be
15493 accessed in Exim by using a &%dnsdb%& lookup). If you set
15494 &%allow_utf8_domains%&, you must modify this pattern, or set the option to an
15495 empty string.
15496
15497 .option dns_csa_search_limit main integer 5
15498 This option controls the depth of parental searching for CSA SRV records in the
15499 DNS, as described in more detail in section &<<SECTverifyCSA>>&.
15500
15501 .option dns_csa_use_reverse main boolean true
15502 This option controls whether or not an IP address, given as a CSA domain, is
15503 reversed and looked up in the reverse DNS, as described in more detail in
15504 section &<<SECTverifyCSA>>&.
15505
15506 .option dns_cname_loops main integer 1
15507 .cindex DNS "CNAME following"
15508 This option controls the following of CNAME chains, needed if the resolver does
15509 not do it internally.
15510 As of 2018 most should, and the default can be left.
15511 If you have an ancient one, a value of 10 is likely needed.
15512
15513 The default value of one CNAME-follow is needed
15514 thanks to the observed return for an MX request,
15515 given no MX presence but a CNAME to an A, of the CNAME.
15516
15517
15518 .option dns_dnssec_ok main integer -1
15519 .cindex "DNS" "resolver options"
15520 .cindex "DNS" "DNSSEC"
15521 If this option is set to a non-negative number then Exim will initialise the
15522 DNS resolver library to either use or not use DNSSEC, overriding the system
15523 default. A value of 0 coerces DNSSEC off, a value of 1 coerces DNSSEC on.
15524
15525 If the resolver library does not support DNSSEC then this option has no effect.
15526
15527 .new
15528 On Linux with glibc 2.31 or newer this is insufficient, the resolver library
15529 will default to stripping out a successful validation status.
15530 This will break a previously working Exim installation.
15531 Provided that you do trust the resolver (ie, is on localhost) you can tell
15532 glibc to pass through any successful validation with a new option in
15533 &_/etc/resolv.conf_&:
15534 .code
15535 options trust-ad
15536 .endd
15537 .wen
15538
15539
15540 .option dns_ipv4_lookup main "domain list&!!" unset
15541 .cindex "IPv6" "DNS lookup for AAAA records"
15542 .cindex "DNS" "IPv6 lookup for AAAA records"
15543 .cindex DNS "IPv6 disabling"
15544 When Exim is compiled with IPv6 support and &%disable_ipv6%& is not set, it
15545 looks for IPv6 address records (AAAA records) as well as IPv4 address records
15546 (A records) when trying to find IP addresses for hosts, unless the host's
15547 domain matches this list.
15548
15549 This is a fudge to help with name servers that give big delays or otherwise do
15550 not work for the AAAA record type. In due course, when the world's name
15551 servers have all been upgraded, there should be no need for this option.
15552 Note that all lookups, including those done for verification, are affected;
15553 this will result in verify failure for IPv6 connections or ones using names
15554 only valid for IPv6 addresses.
15555
15556
15557 .option dns_retrans main time 0s
15558 .cindex "DNS" "resolver options"
15559 .cindex timeout "dns lookup"
15560 .cindex "DNS" timeout
15561 The options &%dns_retrans%& and &%dns_retry%& can be used to set the
15562 retransmission and retry parameters for DNS lookups. Values of zero (the
15563 defaults) leave the system default settings unchanged. The first value is the
15564 time between retries, and the second is the number of retries. It isn't
15565 totally clear exactly how these settings affect the total time a DNS lookup may
15566 take. I haven't found any documentation about timeouts on DNS lookups; these
15567 parameter values are available in the external resolver interface structure,
15568 but nowhere does it seem to describe how they are used or what you might want
15569 to set in them.
15570 See also the &%slow_lookup_log%& option.
15571
15572
15573 .option dns_retry main integer 0
15574 See &%dns_retrans%& above.
15575
15576
15577 .option dns_trust_aa main "domain list&!!" unset
15578 .cindex "DNS" "resolver options"
15579 .cindex "DNS" "DNSSEC"
15580 If this option is set then lookup results marked with the AA bit
15581 (Authoritative Answer) are trusted the same way as if they were
15582 DNSSEC-verified. The authority section's name of the answer must
15583 match with this expanded domain list.
15584
15585 Use this option only if you talk directly to a resolver that is
15586 authoritative for some zones and does not set the AD (Authentic Data)
15587 bit in the answer. Some DNS servers may have an configuration option to
15588 mark the answers from their own zones as verified (they set the AD bit).
15589 Others do not have this option. It is considered as poor practice using
15590 a resolver that is an authoritative server for some zones.
15591
15592 Use this option only if you really have to (e.g. if you want
15593 to use DANE for remote delivery to a server that is listed in the DNS
15594 zones that your resolver is authoritative for).
15595
15596 If the DNS answer packet has the AA bit set and contains resource record
15597 in the answer section, the name of the first NS record appearing in the
15598 authority section is compared against the list. If the answer packet is
15599 authoritative but the answer section is empty, the name of the first SOA
15600 record in the authoritative section is used instead.
15601
15602 .cindex "DNS" "resolver options"
15603 .option dns_use_edns0 main integer -1
15604 .cindex "DNS" "resolver options"
15605 .cindex "DNS" "EDNS0"
15606 .cindex "DNS" "OpenBSD
15607 If this option is set to a non-negative number then Exim will initialise the
15608 DNS resolver library to either use or not use EDNS0 extensions, overriding
15609 the system default. A value of 0 coerces EDNS0 off, a value of 1 coerces EDNS0
15610 on.
15611
15612 If the resolver library does not support EDNS0 then this option has no effect.
15613
15614 OpenBSD's asr resolver routines are known to ignore the EDNS0 option; this
15615 means that DNSSEC will not work with Exim on that platform either, unless Exim
15616 is linked against an alternative DNS client library.
15617
15618
15619 .option drop_cr main boolean false
15620 This is an obsolete option that is now a no-op. It used to affect the way Exim
15621 handled CR and LF characters in incoming messages. What happens now is
15622 described in section &<<SECTlineendings>>&.
15623
15624 .option dsn_advertise_hosts main "host list&!!" unset
15625 .cindex "bounce messages" "success"
15626 .cindex "DSN" "success"
15627 .cindex "Delivery Status Notification" "success"
15628 .cindex "ESMTP extensions" DSN
15629 DSN extensions (RFC3461) will be advertised in the EHLO message to,
15630 and accepted from, these hosts.
15631 Hosts may use the NOTIFY and ENVID options on RCPT TO commands,
15632 and RET and ORCPT options on MAIL FROM commands.
15633 A NOTIFY=SUCCESS option requests success-DSN messages.
15634 A NOTIFY= option with no argument requests that no delay or failure DSNs
15635 are sent.
15636 .new
15637 &*Note*&: Supplying success-DSN messages has been criticised
15638 on privacy grounds; it can leak details of internal forwarding.
15639 .wen
15640
15641 .option dsn_from main "string&!!" "see below"
15642 .cindex "&'From:'& header line" "in bounces"
15643 .cindex "bounce messages" "&'From:'& line, specifying"
15644 This option can be used to vary the contents of &'From:'& header lines in
15645 bounces and other automatically generated messages (&"Delivery Status
15646 Notifications"& &-- hence the name of the option). The default setting is:
15647 .code
15648 dsn_from = Mail Delivery System <Mailer-Daemon@$qualify_domain>
15649 .endd
15650 The value is expanded every time it is needed. If the expansion fails, a
15651 panic is logged, and the default value is used.
15652
15653 .option envelope_to_remove main boolean true
15654 .cindex "&'Envelope-to:'& header line"
15655 Exim's transports have an option for adding an &'Envelope-to:'& header to a
15656 message when it is delivered, in exactly the same way as &'Return-path:'& is
15657 handled. &'Envelope-to:'& records the original recipient address from the
15658 message's envelope that caused the delivery to happen. Such headers should not
15659 be present in incoming messages, and this option causes them to be removed at
15660 the time the message is received, to avoid any problems that might occur when a
15661 delivered message is subsequently sent on to some other recipient.
15662
15663
15664 .option errors_copy main "string list&!!" unset
15665 .cindex "bounce message" "copy to other address"
15666 .cindex "copy of bounce message"
15667 Setting this option causes Exim to send bcc copies of bounce messages that it
15668 generates to other addresses. &*Note*&: This does not apply to bounce messages
15669 coming from elsewhere. The value of the option is a colon-separated list of
15670 items. Each item consists of a pattern, terminated by white space, followed by
15671 a comma-separated list of email addresses. If a pattern contains spaces, it
15672 must be enclosed in double quotes.
15673
15674 Each pattern is processed in the same way as a single item in an address list
15675 (see section &<<SECTaddresslist>>&). When a pattern matches the recipient of
15676 the bounce message, the message is copied to the addresses on the list. The
15677 items are scanned in order, and once a matching one is found, no further items
15678 are examined. For example:
15679 .code
15680 errors_copy = spqr@mydomain   postmaster@mydomain.example :\
15681               rqps@mydomain   hostmaster@mydomain.example,\
15682                               postmaster@mydomain.example
15683 .endd
15684 .vindex "&$domain$&"
15685 .vindex "&$local_part$&"
15686 The address list is expanded before use. The expansion variables &$local_part$&
15687 and &$domain$& are set from the original recipient of the error message, and if
15688 there was any wildcard matching in the pattern, the expansion
15689 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%errors_copy%&"
15690 variables &$0$&, &$1$&, etc. are set in the normal way.
15691
15692
15693 .option errors_reply_to main string unset
15694 .cindex "bounce message" "&'Reply-to:'& in"
15695 By default, Exim's bounce and delivery warning messages contain the header line
15696 .display
15697 &`From: Mail Delivery System <Mailer-Daemon@`&&'qualify-domain'&&`>`&
15698 .endd
15699 .oindex &%quota_warn_message%&
15700 where &'qualify-domain'& is the value of the &%qualify_domain%& option.
15701 A warning message that is generated by the &%quota_warn_message%& option in an
15702 &(appendfile)& transport may contain its own &'From:'& header line that
15703 overrides the default.
15704
15705 Experience shows that people reply to bounce messages. If the
15706 &%errors_reply_to%& option is set, a &'Reply-To:'& header is added to bounce
15707 and warning messages. For example:
15708 .code
15709 errors_reply_to = postmaster@my.domain.example
15710 .endd
15711 The value of the option is not expanded. It must specify a valid RFC 2822
15712 address. However, if a warning message that is generated by the
15713 &%quota_warn_message%& option in an &(appendfile)& transport contain its
15714 own &'Reply-To:'& header line, the value of the &%errors_reply_to%& option is
15715 not used.
15716
15717
15718 .option event_action main string&!! unset
15719 .cindex events
15720 This option declares a string to be expanded for Exim's events mechanism.
15721 For details see chapter &<<CHAPevents>>&.
15722
15723
15724 .option exim_group main string "compile-time configured"
15725 .cindex "gid (group id)" "Exim's own"
15726 .cindex "Exim group"
15727 This option changes the gid under which Exim runs when it gives up root
15728 privilege. The default value is compiled into the binary. The value of this
15729 option is used only when &%exim_user%& is also set. Unless it consists entirely
15730 of digits, the string is looked up using &[getgrnam()]&, and failure causes a
15731 configuration error. See chapter &<<CHAPsecurity>>& for a discussion of
15732 security issues.
15733
15734
15735 .option exim_path main string "see below"
15736 .cindex "Exim binary, path name"
15737 This option specifies the path name of the Exim binary, which is used when Exim
15738 needs to re-exec itself. The default is set up to point to the file &'exim'& in
15739 the directory configured at compile time by the BIN_DIRECTORY setting. It
15740 is necessary to change &%exim_path%& if, exceptionally, Exim is run from some
15741 other place.
15742 &*Warning*&: Do not use a macro to define the value of this option, because
15743 you will break those Exim utilities that scan the configuration file to find
15744 where the binary is. (They then use the &%-bP%& option to extract option
15745 settings such as the value of &%spool_directory%&.)
15746
15747
15748 .option exim_user main string "compile-time configured"
15749 .cindex "uid (user id)" "Exim's own"
15750 .cindex "Exim user"
15751 This option changes the uid under which Exim runs when it gives up root
15752 privilege. The default value is compiled into the binary. Ownership of the run
15753 time configuration file and the use of the &%-C%& and &%-D%& command line
15754 options is checked against the values in the binary, not what is set here.
15755
15756 Unless it consists entirely of digits, the string is looked up using
15757 &[getpwnam()]&, and failure causes a configuration error. If &%exim_group%& is
15758 not also supplied, the gid is taken from the result of &[getpwnam()]& if it is
15759 used. See chapter &<<CHAPsecurity>>& for a discussion of security issues.
15760
15761
15762 .option exim_version main string "current version"
15763 .cindex "Exim version"
15764 .cindex customizing "version number"
15765 .cindex "version number of Exim" override
15766 This option overrides the &$version_number$&/&$exim_version$& that Exim reports in
15767 various places.  Use with care; this may fool stupid security scanners.
15768
15769
15770 .option extra_local_interfaces main "string list" unset
15771 This option defines network interfaces that are to be considered local when
15772 routing, but which are not used for listening by the daemon. See section
15773 &<<SECTreclocipadd>>& for details.
15774
15775
15776 . Allow this long option name to split; give it unsplit as a fifth argument
15777 . for the automatic .oindex that is generated by .option.
15778
15779 .option "extract_addresses_remove_arguments" main boolean true &&&
15780          extract_addresses_remove_arguments
15781 .oindex "&%-t%&"
15782 .cindex "command line" "addresses with &%-t%&"
15783 .cindex "Sendmail compatibility" "&%-t%& option"
15784 According to some Sendmail documentation (Sun, IRIX, HP-UX), if any addresses
15785 are present on the command line when the &%-t%& option is used to build an
15786 envelope from a message's &'To:'&, &'Cc:'& and &'Bcc:'& headers, the command
15787 line addresses are removed from the recipients list. This is also how Smail
15788 behaves. However, other Sendmail documentation (the O'Reilly book) states that
15789 command line addresses are added to those obtained from the header lines. When
15790 &%extract_addresses_remove_arguments%& is true (the default), Exim subtracts
15791 argument headers. If it is set false, Exim adds rather than removes argument
15792 addresses.
15793
15794
15795 .option finduser_retries main integer 0
15796 .cindex "NIS, retrying user lookups"
15797 On systems running NIS or other schemes in which user and group information is
15798 distributed from a remote system, there can be times when &[getpwnam()]& and
15799 related functions fail, even when given valid data, because things time out.
15800 Unfortunately these failures cannot be distinguished from genuine &"not found"&
15801 errors. If &%finduser_retries%& is set greater than zero, Exim will try that
15802 many extra times to find a user or a group, waiting for one second between
15803 retries.
15804
15805 .cindex "&_/etc/passwd_&" "multiple reading of"
15806 You should not set this option greater than zero if your user information is in
15807 a traditional &_/etc/passwd_& file, because it will cause Exim needlessly to
15808 search the file multiple times for non-existent users, and also cause delay.
15809
15810
15811
15812 .option freeze_tell main "string list, comma separated" unset
15813 .cindex "freezing messages" "sending a message when freezing"
15814 On encountering certain errors, or when configured to do so in a system filter,
15815 ACL, or special router, Exim freezes a message. This means that no further
15816 delivery attempts take place until an administrator thaws the message, or the
15817 &%auto_thaw%&, &%ignore_bounce_errors_after%&, or &%timeout_frozen_after%&
15818 feature cause it to be processed. If &%freeze_tell%& is set, Exim generates a
15819 warning message whenever it freezes something, unless the message it is
15820 freezing is a locally-generated bounce message. (Without this exception there
15821 is the possibility of looping.) The warning message is sent to the addresses
15822 supplied as the comma-separated value of this option. If several of the
15823 message's addresses cause freezing, only a single message is sent. If the
15824 freezing was automatic, the reason(s) for freezing can be found in the message
15825 log. If you configure freezing in a filter or ACL, you must arrange for any
15826 logging that you require.
15827
15828
15829 .option gecos_name main string&!! unset
15830 .cindex "HP-UX"
15831 .cindex "&""gecos""& field, parsing"
15832 Some operating systems, notably HP-UX, use the &"gecos"& field in the system
15833 password file to hold other information in addition to users' real names. Exim
15834 looks up this field for use when it is creating &'Sender:'& or &'From:'&
15835 headers. If either &%gecos_pattern%& or &%gecos_name%& are unset, the contents
15836 of the field are used unchanged, except that, if an ampersand is encountered,
15837 it is replaced by the user's login name with the first character forced to
15838 upper case, since this is a convention that is observed on many systems.
15839
15840 When these options are set, &%gecos_pattern%& is treated as a regular
15841 expression that is to be applied to the field (again with && replaced by the
15842 login name), and if it matches, &%gecos_name%& is expanded and used as the
15843 user's name.
15844
15845 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%gecos_name%&"
15846 Numeric variables such as &$1$&, &$2$&, etc. can be used in the expansion to
15847 pick up sub-fields that were matched by the pattern. In HP-UX, where the user's
15848 name terminates at the first comma, the following can be used:
15849 .code
15850 gecos_pattern = ([^,]*)
15851 gecos_name = $1
15852 .endd
15853
15854 .option gecos_pattern main string unset
15855 See &%gecos_name%& above.
15856
15857
15858 .option gnutls_compat_mode main boolean unset
15859 This option controls whether GnuTLS is used in compatibility mode in an Exim
15860 server. This reduces security slightly, but improves interworking with older
15861 implementations of TLS.
15862
15863
15864 .option gnutls_allow_auto_pkcs11 main boolean unset
15865 This option will let GnuTLS (2.12.0 or later) autoload PKCS11 modules with
15866 the p11-kit configuration files in &_/etc/pkcs11/modules/_&.
15867
15868 See
15869 &url(https://www.gnutls.org/manual/gnutls.html#Smart-cards-and-HSMs)
15870 for documentation.
15871
15872
15873
15874 .option headers_charset main string "see below"
15875 This option sets a default character set for translating from encoded MIME
15876 &"words"& in header lines, when referenced by an &$h_xxx$& expansion item. The
15877 default is the value of HEADERS_CHARSET in &_Local/Makefile_&. The
15878 ultimate default is ISO-8859-1. For more details see the description of header
15879 insertions in section &<<SECTexpansionitems>>&.
15880
15881
15882
15883 .option header_maxsize main integer "see below"
15884 .cindex "header section" "maximum size of"
15885 .cindex "limit" "size of message header section"
15886 This option controls the overall maximum size of a message's header
15887 section. The default is the value of HEADER_MAXSIZE in
15888 &_Local/Makefile_&; the default for that is 1M. Messages with larger header
15889 sections are rejected.
15890
15891
15892 .option header_line_maxsize main integer 0
15893 .cindex "header lines" "maximum size of"
15894 .cindex "limit" "size of one header line"
15895 This option limits the length of any individual header line in a message, after
15896 all the continuations have been joined together. Messages with individual
15897 header lines that are longer than the limit are rejected. The default value of
15898 zero means &"no limit"&.
15899
15900
15901
15902
15903 .option helo_accept_junk_hosts main "host list&!!" unset
15904 .cindex "HELO" "accepting junk data"
15905 .cindex "EHLO" "accepting junk data"
15906 Exim checks the syntax of HELO and EHLO commands for incoming SMTP
15907 mail, and gives an error response for invalid data. Unfortunately, there are
15908 some SMTP clients that send syntactic junk. They can be accommodated by setting
15909 this option. Note that this is a syntax check only. See &%helo_verify_hosts%&
15910 if you want to do semantic checking.
15911 See also &%helo_allow_chars%& for a way of extending the permitted character
15912 set.
15913
15914
15915 .option helo_allow_chars main string unset
15916 .cindex "HELO" "underscores in"
15917 .cindex "EHLO" "underscores in"
15918 .cindex "underscore in EHLO/HELO"
15919 This option can be set to a string of rogue characters that are permitted in
15920 all EHLO and HELO names in addition to the standard letters, digits,
15921 hyphens, and dots. If you really must allow underscores, you can set
15922 .code
15923 helo_allow_chars = _
15924 .endd
15925 Note that the value is one string, not a list.
15926
15927
15928 .option helo_lookup_domains main "domain list&!!" &`@:@[]`&
15929 .cindex "HELO" "forcing reverse lookup"
15930 .cindex "EHLO" "forcing reverse lookup"
15931 If the domain given by a client in a HELO or EHLO command matches this
15932 list, a reverse lookup is done in order to establish the host's true name. The
15933 default forces a lookup if the client host gives the server's name or any of
15934 its IP addresses (in brackets), something that broken clients have been seen to
15935 do.
15936
15937
15938 .option helo_try_verify_hosts main "host list&!!" unset
15939 .cindex "HELO verifying" "optional"
15940 .cindex "EHLO" "verifying, optional"
15941 By default, Exim just checks the syntax of HELO and EHLO commands (see
15942 &%helo_accept_junk_hosts%& and &%helo_allow_chars%&). However, some sites like
15943 to do more extensive checking of the data supplied by these commands. The ACL
15944 condition &`verify = helo`& is provided to make this possible.
15945 Formerly, it was necessary also to set this option (&%helo_try_verify_hosts%&)
15946 to force the check to occur. From release 4.53 onwards, this is no longer
15947 necessary. If the check has not been done before &`verify = helo`& is
15948 encountered, it is done at that time. Consequently, this option is obsolete.
15949 Its specification is retained here for backwards compatibility.
15950
15951 When an EHLO or HELO command is received, if the calling host matches
15952 &%helo_try_verify_hosts%&, Exim checks that the host name given in the HELO or
15953 EHLO command either:
15954
15955 .ilist
15956 is an IP literal matching the calling address of the host, or
15957 .next
15958 .cindex "DNS" "reverse lookup"
15959 .cindex "reverse DNS lookup"
15960 matches the host name that Exim obtains by doing a reverse lookup of the
15961 calling host address, or
15962 .next
15963 when looked up in DNS yields the calling host address.
15964 .endlist
15965
15966 However, the EHLO or HELO command is not rejected if any of the checks
15967 fail. Processing continues, but the result of the check is remembered, and can
15968 be detected later in an ACL by the &`verify = helo`& condition.
15969
15970 If DNS was used for successful verification, the variable
15971 .cindex "DNS" "DNSSEC"
15972 &$helo_verify_dnssec$& records the DNSSEC status of the lookups.
15973
15974 .option helo_verify_hosts main "host list&!!" unset
15975 .cindex "HELO verifying" "mandatory"
15976 .cindex "EHLO" "verifying, mandatory"
15977 Like &%helo_try_verify_hosts%&, this option is obsolete, and retained only for
15978 backwards compatibility. For hosts that match this option, Exim checks the host
15979 name given in the HELO or EHLO in the same way as for
15980 &%helo_try_verify_hosts%&. If the check fails, the HELO or EHLO command is
15981 rejected with a 550 error, and entries are written to the main and reject logs.
15982 If a MAIL command is received before EHLO or HELO, it is rejected with a 503
15983 error.
15984
15985 .option hold_domains main "domain list&!!" unset
15986 .cindex "domain" "delaying delivery"
15987 .cindex "delivery" "delaying certain domains"
15988 This option allows mail for particular domains to be held in the queue
15989 manually. The option is overridden if a message delivery is forced with the
15990 &%-M%&, &%-qf%&, &%-Rf%& or &%-Sf%& options, and also while testing or
15991 verifying addresses using &%-bt%& or &%-bv%&. Otherwise, if a domain matches an
15992 item in &%hold_domains%&, no routing or delivery for that address is done, and
15993 it is deferred every time the message is looked at.
15994
15995 This option is intended as a temporary operational measure for delaying the
15996 delivery of mail while some problem is being sorted out, or some new
15997 configuration tested. If you just want to delay the processing of some
15998 domains until a queue run occurs, you should use &%queue_domains%& or
15999 &%queue_smtp_domains%&, not &%hold_domains%&.
16000
16001 A setting of &%hold_domains%& does not override Exim's code for removing
16002 messages from the queue if they have been there longer than the longest retry
16003 time in any retry rule. If you want to hold messages for longer than the normal
16004 retry times, insert a dummy retry rule with a long retry time.
16005
16006
16007 .option host_lookup main "host list&!!" unset
16008 .cindex "host name" "lookup, forcing"
16009 Exim does not look up the name of a calling host from its IP address unless it
16010 is required to compare against some host list, or the host matches
16011 &%helo_try_verify_hosts%& or &%helo_verify_hosts%&, or the host matches this
16012 option (which normally contains IP addresses rather than host names). The
16013 default configuration file contains
16014 .code
16015 host_lookup = *
16016 .endd
16017 which causes a lookup to happen for all hosts. If the expense of these lookups
16018 is felt to be too great, the setting can be changed or removed.
16019
16020 After a successful reverse lookup, Exim does a forward lookup on the name it
16021 has obtained, to verify that it yields the IP address that it started with. If
16022 this check fails, Exim behaves as if the name lookup failed.
16023
16024 .vindex "&$host_lookup_failed$&"
16025 .vindex "&$sender_host_name$&"
16026 After any kind of failure, the host name (in &$sender_host_name$&) remains
16027 unset, and &$host_lookup_failed$& is set to the string &"1"&. See also
16028 &%dns_again_means_nonexist%&, &%helo_lookup_domains%&, and
16029 &`verify = reverse_host_lookup`& in ACLs.
16030
16031
16032 .option host_lookup_order main "string list" &`bydns:byaddr`&
16033 This option specifies the order of different lookup methods when Exim is trying
16034 to find a host name from an IP address. The default is to do a DNS lookup
16035 first, and then to try a local lookup (using &[gethostbyaddr()]& or equivalent)
16036 if that fails. You can change the order of these lookups, or omit one entirely,
16037 if you want.
16038
16039 &*Warning*&: The &"byaddr"& method does not always yield aliases when there are
16040 multiple PTR records in the DNS and the IP address is not listed in
16041 &_/etc/hosts_&. Different operating systems give different results in this
16042 case. That is why the default tries a DNS lookup first.
16043
16044
16045
16046 .option host_reject_connection main "host list&!!" unset
16047 .cindex "host" "rejecting connections from"
16048 If this option is set, incoming SMTP calls from the hosts listed are rejected
16049 as soon as the connection is made.
16050 This option is obsolete, and retained only for backward compatibility, because
16051 nowadays the ACL specified by &%acl_smtp_connect%& can also reject incoming
16052 connections immediately.
16053
16054 The ability to give an immediate rejection (either by this option or using an
16055 ACL) is provided for use in unusual cases. Many hosts will just try again,
16056 sometimes without much delay. Normally, it is better to use an ACL to reject
16057 incoming messages at a later stage, such as after RCPT commands. See
16058 chapter &<<CHAPACL>>&.
16059
16060
16061 .option hosts_connection_nolog main "host list&!!" unset
16062 .cindex "host" "not logging connections from"
16063 This option defines a list of hosts for which connection logging does not
16064 happen, even though the &%smtp_connection%& log selector is set. For example,
16065 you might want not to log SMTP connections from local processes, or from
16066 127.0.0.1, or from your local LAN. This option is consulted in the main loop of
16067 the daemon; you should therefore strive to restrict its value to a short inline
16068 list of IP addresses and networks. To disable logging SMTP connections from
16069 local processes, you must create a host list with an empty item. For example:
16070 .code
16071 hosts_connection_nolog = :
16072 .endd
16073 If the &%smtp_connection%& log selector is not set, this option has no effect.
16074
16075
16076
16077 .option hosts_proxy main "host list&!!" unset
16078 .cindex proxy "proxy protocol"
16079 This option enables use of Proxy Protocol proxies for incoming
16080 connections.  For details see section &<<SECTproxyInbound>>&.
16081
16082
16083 .option hosts_treat_as_local main "domain list&!!" unset
16084 .cindex "local host" "domains treated as"
16085 .cindex "host" "treated as local"
16086 If this option is set, any host names that match the domain list are treated as
16087 if they were the local host when Exim is scanning host lists obtained from MX
16088 records
16089 or other sources. Note that the value of this option is a domain list, not a
16090 host list, because it is always used to check host names, not IP addresses.
16091
16092 This option also applies when Exim is matching the special items
16093 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`& in a domain list (see
16094 section &<<SECTdomainlist>>&), and when checking the &%hosts%& option in the
16095 &(smtp)& transport for the local host (see the &%allow_localhost%& option in
16096 that transport). See also &%local_interfaces%&, &%extra_local_interfaces%&, and
16097 chapter &<<CHAPinterfaces>>&, which contains a discussion about local network
16098 interfaces and recognizing the local host.
16099
16100
16101 .option ibase_servers main "string list" unset
16102 .cindex "InterBase" "server list"
16103 This option provides a list of InterBase servers and associated connection data,
16104 to be used in conjunction with &(ibase)& lookups (see section &<<SECID72>>&).
16105 The option is available only if Exim has been built with InterBase support.
16106
16107
16108
16109 .option ignore_bounce_errors_after main time 10w
16110 .cindex "bounce message" "discarding"
16111 .cindex "discarding bounce message"
16112 This option affects the processing of bounce messages that cannot be delivered,
16113 that is, those that suffer a permanent delivery failure. (Bounce messages that
16114 suffer temporary delivery failures are of course retried in the usual way.)
16115
16116 After a permanent delivery failure, bounce messages are frozen,
16117 because there is no sender to whom they can be returned. When a frozen bounce
16118 message has been in the queue for more than the given time, it is unfrozen at
16119 the next queue run, and a further delivery is attempted. If delivery fails
16120 again, the bounce message is discarded. This makes it possible to keep failed
16121 bounce messages around for a shorter time than the normal maximum retry time
16122 for frozen messages. For example,
16123 .code
16124 ignore_bounce_errors_after = 12h
16125 .endd
16126 retries failed bounce message deliveries after 12 hours, discarding any further
16127 failures. If the value of this option is set to a zero time period, bounce
16128 failures are discarded immediately. Setting a very long time (as in the default
16129 value) has the effect of disabling this option. For ways of automatically
16130 dealing with other kinds of frozen message, see &%auto_thaw%& and
16131 &%timeout_frozen_after%&.
16132
16133
16134 .option ignore_fromline_hosts main "host list&!!" unset
16135 .cindex "&""From""& line"
16136 .cindex "UUCP" "&""From""& line"
16137 Some broken SMTP clients insist on sending a UUCP-like &"From&~"& line before
16138 the headers of a message. By default this is treated as the start of the
16139 message's body, which means that any following headers are not recognized as
16140 such. Exim can be made to ignore it by setting &%ignore_fromline_hosts%& to
16141 match those hosts that insist on sending it. If the sender is actually a local
16142 process rather than a remote host, and is using &%-bs%& to inject the messages,
16143 &%ignore_fromline_local%& must be set to achieve this effect.
16144
16145
16146 .option ignore_fromline_local main boolean false
16147 See &%ignore_fromline_hosts%& above.
16148
16149 .option keep_environment main "string list" unset
16150 .cindex "environment" "values from"
16151 This option contains a string list of environment variables to keep.
16152 You have to trust these variables or you have to be sure that
16153 these variables do not impose any security risk. Keep in mind that
16154 during the startup phase Exim is running with an effective UID 0 in most
16155 installations. As the default value is an empty list, the default
16156 environment for using libraries, running embedded Perl code, or running
16157 external binaries is empty, and does not not even contain PATH or HOME.
16158
16159 Actually the list is interpreted as a list of patterns
16160 (&<<SECTlistexpand>>&), except that it is not expanded first.
16161
16162 WARNING: Macro substitution is still done first, so having a macro
16163 FOO and having FOO_HOME in your &%keep_environment%& option may have
16164 unexpected results. You may work around this using a regular expression
16165 that does not match the macro name: ^[F]OO_HOME$.
16166
16167 Current versions of Exim issue a warning during startup if you do not mention
16168 &%keep_environment%& in your runtime configuration file and if your
16169 current environment is not empty. Future versions may not issue that warning
16170 anymore.
16171
16172 See the &%add_environment%& main config option for a way to set
16173 environment variables to a fixed value.  The environment for &(pipe)&
16174 transports is handled separately, see section &<<SECTpipeenv>>& for
16175 details.
16176
16177
16178 .option keep_malformed main time 4d
16179 This option specifies the length of time to keep messages whose spool files
16180 have been corrupted in some way. This should, of course, never happen. At the
16181 next attempt to deliver such a message, it gets removed. The incident is
16182 logged.
16183
16184
16185 .option ldap_ca_cert_dir main string unset
16186 .cindex "LDAP", "TLS CA certificate directory"
16187 .cindex certificate "directory for LDAP"
16188 This option indicates which directory contains CA certificates for verifying
16189 a TLS certificate presented by an LDAP server.
16190 While Exim does not provide a default value, your SSL library may.
16191 Analogous to &%tls_verify_certificates%& but as a client-side option for LDAP
16192 and constrained to be a directory.
16193
16194
16195 .option ldap_ca_cert_file main string unset
16196 .cindex "LDAP", "TLS CA certificate file"
16197 .cindex certificate "file for LDAP"
16198 This option indicates which file contains CA certificates for verifying
16199 a TLS certificate presented by an LDAP server.
16200 While Exim does not provide a default value, your SSL library may.
16201 Analogous to &%tls_verify_certificates%& but as a client-side option for LDAP
16202 and constrained to be a file.
16203
16204
16205 .option ldap_cert_file main string unset
16206 .cindex "LDAP" "TLS client certificate file"
16207 .cindex certificate "file for LDAP"
16208 This option indicates which file contains an TLS client certificate which
16209 Exim should present to the LDAP server during TLS negotiation.
16210 Should be used together with &%ldap_cert_key%&.
16211
16212
16213 .option ldap_cert_key main string unset
16214 .cindex "LDAP" "TLS client key file"
16215 .cindex certificate "key for LDAP"
16216 This option indicates which file contains the secret/private key to use
16217 to prove identity to the LDAP server during TLS negotiation.
16218 Should be used together with &%ldap_cert_file%&, which contains the
16219 identity to be proven.
16220
16221
16222 .option ldap_cipher_suite main string unset
16223 .cindex "LDAP" "TLS cipher suite"
16224 This controls the TLS cipher-suite negotiation during TLS negotiation with
16225 the LDAP server.  See &<<SECTreqciphssl>>& for more details of the format of
16226 cipher-suite options with OpenSSL (as used by LDAP client libraries).
16227
16228
16229 .option ldap_default_servers main "string list" unset
16230 .cindex "LDAP" "default servers"
16231 This option provides a list of LDAP servers which are tried in turn when an
16232 LDAP query does not contain a server. See section &<<SECTforldaque>>& for
16233 details of LDAP queries. This option is available only when Exim has been built
16234 with LDAP support.
16235
16236
16237 .option ldap_require_cert main string unset.
16238 .cindex "LDAP" "policy for LDAP server TLS cert presentation"
16239 This should be one of the values "hard", "demand", "allow", "try" or "never".
16240 A value other than one of these is interpreted as "never".
16241 See the entry "TLS_REQCERT" in your system man page for ldap.conf(5).
16242 Although Exim does not set a default, the LDAP library probably defaults
16243 to hard/demand.
16244
16245
16246 .option ldap_start_tls main boolean false
16247 .cindex "LDAP" "whether or not to negotiate TLS"
16248 If set, Exim will attempt to negotiate TLS with the LDAP server when
16249 connecting on a regular LDAP port.  This is the LDAP equivalent of SMTP's
16250 "STARTTLS".  This is distinct from using "ldaps", which is the LDAP form
16251 of SSL-on-connect.
16252 In the event of failure to negotiate TLS, the action taken is controlled
16253 by &%ldap_require_cert%&.
16254 This option is ignored for &`ldapi`& connections.
16255
16256
16257 .option ldap_version main integer unset
16258 .cindex "LDAP" "protocol version, forcing"
16259 This option can be used to force Exim to set a specific protocol version for
16260 LDAP. If it option is unset, it is shown by the &%-bP%& command line option as
16261 -1. When this is the case, the default is 3 if LDAP_VERSION3 is defined in
16262 the LDAP headers; otherwise it is 2. This option is available only when Exim
16263 has been built with LDAP support.
16264
16265
16266
16267 .option local_from_check main boolean true
16268 .cindex "&'Sender:'& header line" "disabling addition of"
16269 .cindex "&'From:'& header line" "disabling checking of"
16270 When a message is submitted locally (that is, not over a TCP/IP connection) by
16271 an untrusted user, Exim removes any existing &'Sender:'& header line, and
16272 checks that the &'From:'& header line matches the login of the calling user and
16273 the domain specified by &%qualify_domain%&.
16274
16275 &*Note*&: An unqualified address (no domain) in the &'From:'& header in a
16276 locally submitted message is automatically qualified by Exim, unless the
16277 &%-bnq%& command line option is used.
16278
16279 You can use &%local_from_prefix%& and &%local_from_suffix%& to permit affixes
16280 on the local part. If the &'From:'& header line does not match, Exim adds a
16281 &'Sender:'& header with an address constructed from the calling user's login
16282 and the default qualify domain.
16283
16284 If &%local_from_check%& is set false, the &'From:'& header check is disabled,
16285 and no &'Sender:'& header is ever added. If, in addition, you want to retain
16286 &'Sender:'& header lines supplied by untrusted users, you must also set
16287 &%local_sender_retain%& to be true.
16288
16289 .cindex "envelope from"
16290 .cindex "envelope sender"
16291 These options affect only the header lines in the message. The envelope sender
16292 is still forced to be the login id at the qualify domain unless
16293 &%untrusted_set_sender%& permits the user to supply an envelope sender.
16294
16295 For messages received over TCP/IP, an ACL can specify &"submission mode"& to
16296 request similar header line checking. See section &<<SECTthesenhea>>&, which
16297 has more details about &'Sender:'& processing.
16298
16299
16300
16301
16302 .option local_from_prefix main string unset
16303 When Exim checks the &'From:'& header line of locally submitted messages for
16304 matching the login id (see &%local_from_check%& above), it can be configured to
16305 ignore certain prefixes and suffixes in the local part of the address. This is
16306 done by setting &%local_from_prefix%& and/or &%local_from_suffix%& to
16307 appropriate lists, in the same form as the &%local_part_prefix%& and
16308 &%local_part_suffix%& router options (see chapter &<<CHAProutergeneric>>&). For
16309 example, if
16310 .code
16311 local_from_prefix = *-
16312 .endd
16313 is set, a &'From:'& line containing
16314 .code
16315 From: anything-user@your.domain.example
16316 .endd
16317 will not cause a &'Sender:'& header to be added if &'user@your.domain.example'&
16318 matches the actual sender address that is constructed from the login name and
16319 qualify domain.
16320
16321
16322 .option local_from_suffix main string unset
16323 See &%local_from_prefix%& above.
16324
16325
16326 .option local_interfaces main "string list" "see below"
16327 This option controls which network interfaces are used by the daemon for
16328 listening; they are also used to identify the local host when routing. Chapter
16329 &<<CHAPinterfaces>>& contains a full description of this option and the related
16330 options &%daemon_smtp_ports%&, &%extra_local_interfaces%&,
16331 &%hosts_treat_as_local%&, and &%tls_on_connect_ports%&. The default value for
16332 &%local_interfaces%& is
16333 .code
16334 local_interfaces = 0.0.0.0
16335 .endd
16336 when Exim is built without IPv6 support; otherwise it is
16337 .code
16338 local_interfaces = <; ::0 ; 0.0.0.0
16339 .endd
16340
16341 .option local_scan_timeout main time 5m
16342 .cindex "timeout" "for &[local_scan()]& function"
16343 .cindex "&[local_scan()]& function" "timeout"
16344 This timeout applies to the &[local_scan()]& function (see chapter
16345 &<<CHAPlocalscan>>&). Zero means &"no timeout"&. If the timeout is exceeded,
16346 the incoming message is rejected with a temporary error if it is an SMTP
16347 message. For a non-SMTP message, the message is dropped and Exim ends with a
16348 non-zero code. The incident is logged on the main and reject logs.
16349
16350
16351
16352 .option local_sender_retain main boolean false
16353 .cindex "&'Sender:'& header line" "retaining from local submission"
16354 When a message is submitted locally (that is, not over a TCP/IP connection) by
16355 an untrusted user, Exim removes any existing &'Sender:'& header line. If you
16356 do not want this to happen, you must set &%local_sender_retain%&, and you must
16357 also set &%local_from_check%& to be false (Exim will complain if you do not).
16358 See also the ACL modifier &`control = suppress_local_fixups`&. Section
16359 &<<SECTthesenhea>>& has more details about &'Sender:'& processing.
16360
16361
16362
16363
16364 .option localhost_number main string&!! unset
16365 .cindex "host" "locally unique number for"
16366 .cindex "message ids" "with multiple hosts"
16367 .vindex "&$localhost_number$&"
16368 Exim's message ids are normally unique only within the local host. If
16369 uniqueness among a set of hosts is required, each host must set a different
16370 value for the &%localhost_number%& option. The string is expanded immediately
16371 after reading the configuration file (so that a number can be computed from the
16372 host name, for example) and the result of the expansion must be a number in the
16373 range 0&--16 (or 0&--10 on operating systems with case-insensitive file
16374 systems). This is available in subsequent string expansions via the variable
16375 &$localhost_number$&. When &%localhost_number is set%&, the final two
16376 characters of the message id, instead of just being a fractional part of the
16377 time, are computed from the time and the local host number as described in
16378 section &<<SECTmessiden>>&.
16379
16380
16381
16382 .option log_file_path main "string list&!!" "set at compile time"
16383 .cindex "log" "file path for"
16384 This option sets the path which is used to determine the names of Exim's log
16385 files, or indicates that logging is to be to syslog, or both. It is expanded
16386 when Exim is entered, so it can, for example, contain a reference to the host
16387 name. If no specific path is set for the log files at compile or runtime,
16388 or if the option is unset at runtime (i.e.  &`log_file_path = `&)
16389 they are written in a sub-directory called &_log_& in Exim's spool directory.
16390 A path must start with a slash.
16391 To send to syslog, use the word &"syslog"&.
16392 Chapter &<<CHAPlog>>& contains further details about Exim's logging, and
16393 section &<<SECTwhelogwri>>& describes how the contents of &%log_file_path%& are
16394 used. If this string is fixed at your installation (contains no expansion
16395 variables) it is recommended that you do not set this option in the
16396 configuration file, but instead supply the path using LOG_FILE_PATH in
16397 &_Local/Makefile_& so that it is available to Exim for logging errors detected
16398 early on &-- in particular, failure to read the configuration file.
16399
16400
16401 .option log_selector main string unset
16402 .cindex "log" "selectors"
16403 This option can be used to reduce or increase the number of things that Exim
16404 writes to its log files. Its argument is made up of names preceded by plus or
16405 minus characters. For example:
16406 .code
16407 log_selector = +arguments -retry_defer
16408 .endd
16409 A list of possible names and what they control is given in the chapter on
16410 logging, in section &<<SECTlogselector>>&.
16411
16412
16413 .option log_timezone main boolean false
16414 .cindex "log" "timezone for entries"
16415 .vindex "&$tod_log$&"
16416 .vindex "&$tod_zone$&"
16417 By default, the timestamps on log lines are in local time without the
16418 timezone. This means that if your timezone changes twice a year, the timestamps
16419 in log lines are ambiguous for an hour when the clocks go back. One way of
16420 avoiding this problem is to set the timezone to UTC. An alternative is to set
16421 &%log_timezone%& true. This turns on the addition of the timezone offset to
16422 timestamps in log lines. Turning on this option can add quite a lot to the size
16423 of log files because each line is extended by 6 characters. Note that the
16424 &$tod_log$& variable contains the log timestamp without the zone, but there is
16425 another variable called &$tod_zone$& that contains just the timezone offset.
16426
16427
16428 .option lookup_open_max main integer 25
16429 .cindex "too many open files"
16430 .cindex "open files, too many"
16431 .cindex "file" "too many open"
16432 .cindex "lookup" "maximum open files"
16433 .cindex "limit" "open files for lookups"
16434 This option limits the number of simultaneously open files for single-key
16435 lookups that use regular files (that is, &(lsearch)&, &(dbm)&, and &(cdb)&).
16436 Exim normally keeps these files open during routing, because often the same
16437 file is required several times. If the limit is reached, Exim closes the least
16438 recently used file. Note that if you are using the &'ndbm'& library, it
16439 actually opens two files for each logical DBM database, though it still counts
16440 as one for the purposes of &%lookup_open_max%&. If you are getting &"too many
16441 open files"& errors with NDBM, you need to reduce the value of
16442 &%lookup_open_max%&.
16443
16444
16445 .option max_username_length main integer 0
16446 .cindex "length of login name"
16447 .cindex "user name" "maximum length"
16448 .cindex "limit" "user name length"
16449 Some operating systems are broken in that they truncate long arguments to
16450 &[getpwnam()]& to eight characters, instead of returning &"no such user"&. If
16451 this option is set greater than zero, any attempt to call &[getpwnam()]& with
16452 an argument that is longer behaves as if &[getpwnam()]& failed.
16453
16454
16455 .option message_body_newlines main bool false
16456 .cindex "message body" "newlines in variables"
16457 .cindex "newline" "in message body variables"
16458 .vindex "&$message_body$&"
16459 .vindex "&$message_body_end$&"
16460 By default, newlines in the message body are replaced by spaces when setting
16461 the &$message_body$& and &$message_body_end$& expansion variables. If this
16462 option is set true, this no longer happens.
16463
16464
16465 .option message_body_visible main integer 500
16466 .cindex "body of message" "visible size"
16467 .cindex "message body" "visible size"
16468 .vindex "&$message_body$&"
16469 .vindex "&$message_body_end$&"
16470 This option specifies how much of a message's body is to be included in the
16471 &$message_body$& and &$message_body_end$& expansion variables.
16472
16473
16474 .option message_id_header_domain main string&!! unset
16475 .cindex "&'Message-ID:'& header line"
16476 If this option is set, the string is expanded and used as the right hand side
16477 (domain) of the &'Message-ID:'& header that Exim creates if a
16478 locally-originated incoming message does not have one. &"Locally-originated"&
16479 means &"not received over TCP/IP."&
16480 Otherwise, the primary host name is used.
16481 Only letters, digits, dot and hyphen are accepted; any other characters are
16482 replaced by hyphens. If the expansion is forced to fail, or if the result is an
16483 empty string, the option is ignored.
16484
16485
16486 .option message_id_header_text main string&!! unset
16487 If this variable is set, the string is expanded and used to augment the text of
16488 the &'Message-id:'& header that Exim creates if a locally-originated incoming
16489 message does not have one. The text of this header is required by RFC 2822 to
16490 take the form of an address. By default, Exim uses its internal message id as
16491 the local part, and the primary host name as the domain. If this option is set,
16492 it is expanded, and provided the expansion is not forced to fail, and does not
16493 yield an empty string, the result is inserted into the header immediately
16494 before the @, separated from the internal message id by a dot. Any characters
16495 that are illegal in an address are automatically converted into hyphens. This
16496 means that variables such as &$tod_log$& can be used, because the spaces and
16497 colons will become hyphens.
16498
16499
16500 .option message_logs main boolean true
16501 .cindex "message logs" "disabling"
16502 .cindex "log" "message log; disabling"
16503 If this option is turned off, per-message log files are not created in the
16504 &_msglog_& spool sub-directory. This reduces the amount of disk I/O required by
16505 Exim, by reducing the number of files involved in handling a message from a
16506 minimum of four (header spool file, body spool file, delivery journal, and
16507 per-message log) to three. The other major I/O activity is Exim's main log,
16508 which is not affected by this option.
16509
16510
16511 .option message_size_limit main string&!! 50M
16512 .cindex "message" "size limit"
16513 .cindex "limit" "message size"
16514 .cindex "size" "of message, limit"
16515 This option limits the maximum size of message that Exim will process. The
16516 value is expanded for each incoming connection so, for example, it can be made
16517 to depend on the IP address of the remote host for messages arriving via
16518 TCP/IP. After expansion, the value must be a sequence of decimal digits,
16519 optionally followed by K or M.
16520
16521 .cindex "SIZE" "ESMTP extension, advertising"
16522 .cindex "ESMTP extensions" SIZE
16523 If nonzero the value will be advertised as a parameter to the ESMTP SIZE
16524 service extension keyword.
16525
16526 &*Note*&: This limit cannot be made to depend on a message's sender or any
16527 other properties of an individual message, because it has to be advertised in
16528 the server's response to EHLO. String expansion failure causes a temporary
16529 error. A value of zero means no limit, but its use is not recommended. See also
16530 &%bounce_return_size_limit%&.
16531
16532 Incoming SMTP messages are failed with a 552 error if the limit is
16533 exceeded; locally-generated messages either get a stderr message or a delivery
16534 failure message to the sender, depending on the &%-oe%& setting. Rejection of
16535 an oversized message is logged in both the main and the reject logs. See also
16536 the generic transport option &%message_size_limit%&, which limits the size of
16537 message that an individual transport can process.
16538
16539 If you use a virus-scanner and set this option to to a value larger than the
16540 maximum size that your virus-scanner is configured to support, you may get
16541 failures triggered by large mails.  The right size to configure for the
16542 virus-scanner depends upon what data is passed and the options in use but it's
16543 probably safest to just set it to a little larger than this value.  E.g., with a
16544 default Exim message size of 50M and a default ClamAV StreamMaxLength of 10M,
16545 some problems may result.
16546
16547 A value of 0 will disable size limit checking; Exim will still advertise the
16548 SIZE extension in an EHLO response, but without a limit, so as to permit
16549 SMTP clients to still indicate the message size along with the MAIL verb.
16550
16551
16552 .option move_frozen_messages main boolean false
16553 .cindex "frozen messages" "moving"
16554 This option, which is available only if Exim has been built with the setting
16555 .code
16556 SUPPORT_MOVE_FROZEN_MESSAGES=yes
16557 .endd
16558 in &_Local/Makefile_&, causes frozen messages and their message logs to be
16559 moved from the &_input_& and &_msglog_& directories on the spool to &_Finput_&
16560 and &_Fmsglog_&, respectively. There is currently no support in Exim or the
16561 standard utilities for handling such moved messages, and they do not show up in
16562 lists generated by &%-bp%& or by the Exim monitor.
16563
16564
16565 .option mua_wrapper main boolean false
16566 Setting this option true causes Exim to run in a very restrictive mode in which
16567 it passes messages synchronously to a smart host. Chapter &<<CHAPnonqueueing>>&
16568 contains a full description of this facility.
16569
16570
16571
16572 .option mysql_servers main "string list" unset
16573 .cindex "MySQL" "server list"
16574 This option provides a list of MySQL servers and associated connection data, to
16575 be used in conjunction with &(mysql)& lookups (see section &<<SECID72>>&). The
16576 option is available only if Exim has been built with MySQL support.
16577
16578
16579 .option never_users main "string list&!!" unset
16580 This option is expanded just once, at the start of Exim's processing. Local
16581 message deliveries are normally run in processes that are setuid to the
16582 recipient, and remote deliveries are normally run under Exim's own uid and gid.
16583 It is usually desirable to prevent any deliveries from running as root, as a
16584 safety precaution.
16585
16586 When Exim is built, an option called FIXED_NEVER_USERS can be set to a
16587 list of users that must not be used for local deliveries. This list is fixed in
16588 the binary and cannot be overridden by the configuration file. By default, it
16589 contains just the single user name &"root"&. The &%never_users%& runtime option
16590 can be used to add more users to the fixed list.
16591
16592 If a message is to be delivered as one of the users on the fixed list or the
16593 &%never_users%& list, an error occurs, and delivery is deferred. A common
16594 example is
16595 .code
16596 never_users = root:daemon:bin
16597 .endd
16598 Including root is redundant if it is also on the fixed list, but it does no
16599 harm. This option overrides the &%pipe_as_creator%& option of the &(pipe)&
16600 transport driver.
16601
16602
16603 .new
16604 .option notifier_socket main string "$spool_directory/exim_daemon_notify"
16605 This option gives the name for a unix-domain socket on which the daemon
16606 listens for work and information-requests.
16607 Only installations running multiple daemons sharing a spool directory
16608 should need to modify the default.
16609
16610 The option is expanded before use.
16611 If the platform supports Linux-style abstract socket names, the result
16612 is used with a nul byte prefixed.
16613 Otherwise, it should be a full path name and use a directory accessible
16614 to Exim.
16615
16616 If the Exim command line uses a &%-oX%& option and does not use &%-oP%&
16617 then a notifier socket is not created.
16618 .wen
16619
16620
16621 .option openssl_options main "string list" "+no_sslv2 +no_sslv3 +single_dh_use +no_ticket +no_renegotiation"
16622 .cindex "OpenSSL "compatibility options"
16623 This option allows an administrator to adjust the SSL options applied
16624 by OpenSSL to connections.  It is given as a space-separated list of items,
16625 each one to be +added or -subtracted from the current value.
16626
16627 This option is only available if Exim is built against OpenSSL.  The values
16628 available for this option vary according to the age of your OpenSSL install.
16629 The &"all"& value controls a subset of flags which are available, typically
16630 the bug workaround options.  The &'SSL_CTX_set_options'& man page will
16631 list the values known on your system and Exim should support all the
16632 &"bug workaround"& options and many of the &"modifying"& options.  The Exim
16633 names lose the leading &"SSL_OP_"& and are lower-cased.
16634
16635 Note that adjusting the options can have severe impact upon the security of
16636 SSL as used by Exim.  It is possible to disable safety checks and shoot
16637 yourself in the foot in various unpleasant ways.  This option should not be
16638 adjusted lightly.  An unrecognised item will be detected at startup, by
16639 invoking Exim with the &%-bV%& flag.
16640
16641 The option affects Exim operating both as a server and as a client.
16642
16643 Historical note: prior to release 4.80, Exim defaulted this value to
16644 "+dont_insert_empty_fragments", which may still be needed for compatibility
16645 with some clients, but which lowers security by increasing exposure to
16646 some now infamous attacks.
16647
16648 Examples:
16649 .code
16650 # Make both old MS and old Eudora happy:
16651 openssl_options = -all +microsoft_big_sslv3_buffer \
16652                        +dont_insert_empty_fragments
16653
16654 # Disable older protocol versions:
16655 openssl_options = +no_sslv2 +no_sslv3
16656 .endd
16657
16658 Possible options may include:
16659 .ilist
16660 &`all`&
16661 .next
16662 &`allow_unsafe_legacy_renegotiation`&
16663 .next
16664 &`cipher_server_preference`&
16665 .next
16666 &`dont_insert_empty_fragments`&
16667 .next
16668 &`ephemeral_rsa`&
16669 .next
16670 &`legacy_server_connect`&
16671 .next
16672 &`microsoft_big_sslv3_buffer`&
16673 .next
16674 &`microsoft_sess_id_bug`&
16675 .next
16676 &`msie_sslv2_rsa_padding`&
16677 .next
16678 &`netscape_challenge_bug`&
16679 .next
16680 &`netscape_reuse_cipher_change_bug`&
16681 .next
16682 &`no_compression`&
16683 .next
16684 &`no_session_resumption_on_renegotiation`&
16685 .next
16686 &`no_sslv2`&
16687 .next
16688 &`no_sslv3`&
16689 .next
16690 &`no_ticket`&
16691 .next
16692 &`no_tlsv1`&
16693 .next
16694 &`no_tlsv1_1`&
16695 .next
16696 &`no_tlsv1_2`&
16697 .next
16698 &`safari_ecdhe_ecdsa_bug`&
16699 .next
16700 &`single_dh_use`&
16701 .next
16702 &`single_ecdh_use`&
16703 .next
16704 &`ssleay_080_client_dh_bug`&
16705 .next
16706 &`sslref2_reuse_cert_type_bug`&
16707 .next
16708 &`tls_block_padding_bug`&
16709 .next
16710 &`tls_d5_bug`&
16711 .next
16712 &`tls_rollback_bug`&
16713 .endlist
16714
16715 As an aside, the &`safari_ecdhe_ecdsa_bug`& item is a misnomer and affects
16716 all clients connecting using the MacOS SecureTransport TLS facility prior
16717 to MacOS 10.8.4, including email clients.  If you see old MacOS clients failing
16718 to negotiate TLS then this option value might help, provided that your OpenSSL
16719 release is new enough to contain this work-around.  This may be a situation
16720 where you have to upgrade OpenSSL to get buggy clients working.
16721
16722
16723 .option oracle_servers main "string list" unset
16724 .cindex "Oracle" "server list"
16725 This option provides a list of Oracle servers and associated connection data,
16726 to be used in conjunction with &(oracle)& lookups (see section &<<SECID72>>&).
16727 The option is available only if Exim has been built with Oracle support.
16728
16729
16730 .option percent_hack_domains main "domain list&!!" unset
16731 .cindex "&""percent hack""&"
16732 .cindex "source routing" "in email address"
16733 .cindex "address" "source-routed"
16734 The &"percent hack"& is the convention whereby a local part containing a
16735 percent sign is re-interpreted as a new email address, with the percent
16736 replaced by @. This is sometimes called &"source routing"&, though that term is
16737 also applied to RFC 2822 addresses that begin with an @ character. If this
16738 option is set, Exim implements the percent facility for those domains listed,
16739 but no others. This happens before an incoming SMTP address is tested against
16740 an ACL.
16741
16742 &*Warning*&: The &"percent hack"& has often been abused by people who are
16743 trying to get round relaying restrictions. For this reason, it is best avoided
16744 if at all possible. Unfortunately, a number of less security-conscious MTAs
16745 implement it unconditionally. If you are running Exim on a gateway host, and
16746 routing mail through to internal MTAs without processing the local parts, it is
16747 a good idea to reject recipient addresses with percent characters in their
16748 local parts. Exim's default configuration does this.
16749
16750
16751 .option perl_at_start main boolean false
16752 .cindex "Perl"
16753 This option is available only when Exim is built with an embedded Perl
16754 interpreter. See chapter &<<CHAPperl>>& for details of its use.
16755
16756
16757 .option perl_startup main string unset
16758 .cindex "Perl"
16759 This option is available only when Exim is built with an embedded Perl
16760 interpreter. See chapter &<<CHAPperl>>& for details of its use.
16761
16762 .option perl_taintmode main boolean false
16763 .cindex "Perl"
16764 This option enables the taint mode of the embedded Perl interpreter.
16765
16766
16767 .option pgsql_servers main "string list" unset
16768 .cindex "PostgreSQL lookup type" "server list"
16769 This option provides a list of PostgreSQL servers and associated connection
16770 data, to be used in conjunction with &(pgsql)& lookups (see section
16771 &<<SECID72>>&). The option is available only if Exim has been built with
16772 PostgreSQL support.
16773
16774
16775 .option pid_file_path main string&!! "set at compile time"
16776 .cindex "daemon" "pid file path"
16777 .cindex "pid file, path for"
16778 This option sets the name of the file to which the Exim daemon writes its
16779 process id. The string is expanded, so it can contain, for example, references
16780 to the host name:
16781 .code
16782 pid_file_path = /var/log/$primary_hostname/exim.pid
16783 .endd
16784 If no path is set, the pid is written to the file &_exim-daemon.pid_& in Exim's
16785 spool directory.
16786 The value set by the option can be overridden by the &%-oP%& command line
16787 option. A pid file is not written if a &"non-standard"& daemon is run by means
16788 of the &%-oX%& option, unless a path is explicitly supplied by &%-oP%&.
16789
16790
16791 .option pipelining_advertise_hosts main "host list&!!" *
16792 .cindex "PIPELINING" "suppressing advertising"
16793 .cindex "ESMTP extensions" PIPELINING
16794 This option can be used to suppress the advertisement of the SMTP
16795 PIPELINING extension to specific hosts. See also the &*no_pipelining*&
16796 control in section &<<SECTcontrols>>&. When PIPELINING is not advertised and
16797 &%smtp_enforce_sync%& is true, an Exim server enforces strict synchronization
16798 for each SMTP command and response. When PIPELINING is advertised, Exim assumes
16799 that clients will use it; &"out of order"& commands that are &"expected"& do
16800 not count as protocol errors (see &%smtp_max_synprot_errors%&).
16801
16802 .option pipelining_connect_advertise_hosts main "host list&!!" *
16803 .cindex "pipelining" "early connection"
16804 .cindex "pipelining" PIPE_CONNECT
16805 .cindex "ESMTP extensions" X_PIPE_CONNECT
16806 If Exim is built with the SUPPORT_PIPE_CONNECT build option
16807 this option controls which hosts the facility is advertised to
16808 and from which pipeline early-connection (before MAIL) SMTP
16809 commands are acceptable.
16810 When used, the pipelining saves on roundtrip times.
16811
16812 See also the &%hosts_pipe_connect%& smtp transport option.
16813
16814 Currently the option name &"X_PIPE_CONNECT"& is used.
16815
16816
16817 .option prdr_enable main boolean false
16818 .cindex "PRDR" "enabling on server"
16819 .cindex "ESMTP extensions" PRDR
16820 This option can be used to enable the Per-Recipient Data Response extension
16821 to SMTP, defined by Eric Hall.
16822 If the option is set, PRDR is advertised by Exim when operating as a server.
16823 If the client requests PRDR, and more than one recipient, for a message
16824 an additional ACL is called for each recipient after the message content
16825 is received.  See section &<<SECTPRDRACL>>&.
16826
16827 .option preserve_message_logs main boolean false
16828 .cindex "message logs" "preserving"
16829 If this option is set, message log files are not deleted when messages are
16830 completed. Instead, they are moved to a sub-directory of the spool directory
16831 called &_msglog.OLD_&, where they remain available for statistical or debugging
16832 purposes. This is a dangerous option to set on systems with any appreciable
16833 volume of mail. Use with care!
16834
16835
16836 .option primary_hostname main string "see below"
16837 .cindex "name" "of local host"
16838 .cindex "host" "name of local"
16839 .cindex "local host" "name of"
16840 .vindex "&$primary_hostname$&"
16841 This specifies the name of the current host. It is used in the default EHLO or
16842 HELO command for outgoing SMTP messages (changeable via the &%helo_data%&
16843 option in the &(smtp)& transport), and as the default for &%qualify_domain%&.
16844 The value is also used by default in some SMTP response messages from an Exim
16845 server. This can be changed dynamically by setting &%smtp_active_hostname%&.
16846
16847 If &%primary_hostname%& is not set, Exim calls &[uname()]& to find the host
16848 name. If this fails, Exim panics and dies. If the name returned by &[uname()]&
16849 contains only one component, Exim passes it to &[gethostbyname()]& (or
16850 &[getipnodebyname()]& when available) in order to obtain the fully qualified
16851 version. The variable &$primary_hostname$& contains the host name, whether set
16852 explicitly by this option, or defaulted.
16853
16854
16855 .option print_topbitchars main boolean false
16856 .cindex "printing characters"
16857 .cindex "8-bit characters"
16858 By default, Exim considers only those characters whose codes lie in the range
16859 32&--126 to be printing characters. In a number of circumstances (for example,
16860 when writing log entries) non-printing characters are converted into escape
16861 sequences, primarily to avoid messing up the layout. If &%print_topbitchars%&
16862 is set, code values of 128 and above are also considered to be printing
16863 characters.
16864
16865 This option also affects the header syntax checks performed by the
16866 &(autoreply)& transport, and whether Exim uses RFC 2047 encoding of
16867 the user's full name when constructing From: and Sender: addresses (as
16868 described in section &<<SECTconstr>>&). Setting this option can cause
16869 Exim to generate eight bit message headers that do not conform to the
16870 standards.
16871
16872
16873 .option process_log_path main string unset
16874 .cindex "process log path"
16875 .cindex "log" "process log"
16876 .cindex "&'exiwhat'&"
16877 This option sets the name of the file to which an Exim process writes its
16878 &"process log"& when sent a USR1 signal. This is used by the &'exiwhat'&
16879 utility script. If this option is unset, the file called &_exim-process.info_&
16880 in Exim's spool directory is used. The ability to specify the name explicitly
16881 can be useful in environments where two different Exims are running, using
16882 different spool directories.
16883
16884
16885 .option prod_requires_admin main boolean true
16886 .cindex "restricting access to features"
16887 .oindex "&%-M%&"
16888 .oindex "&%-R%&"
16889 .oindex "&%-q%&"
16890 The &%-M%&, &%-R%&, and &%-q%& command-line options require the caller to be an
16891 admin user unless &%prod_requires_admin%& is set false. See also
16892 &%queue_list_requires_admin%& and &%commandline_checks_require_admin%&.
16893
16894
16895 .option qualify_domain main string "see below"
16896 .cindex "domain" "for qualifying addresses"
16897 .cindex "address" "qualification"
16898 This option specifies the domain name that is added to any envelope sender
16899 addresses that do not have a domain qualification. It also applies to
16900 recipient addresses if &%qualify_recipient%& is not set. Unqualified addresses
16901 are accepted by default only for locally-generated messages. Qualification is
16902 also applied to addresses in header lines such as &'From:'& and &'To:'& for
16903 locally-generated messages, unless the &%-bnq%& command line option is used.
16904
16905 Messages from external sources must always contain fully qualified addresses,
16906 unless the sending host matches &%sender_unqualified_hosts%& or
16907 &%recipient_unqualified_hosts%& (as appropriate), in which case incoming
16908 addresses are qualified with &%qualify_domain%& or &%qualify_recipient%& as
16909 necessary. Internally, Exim always works with fully qualified envelope
16910 addresses. If &%qualify_domain%& is not set, it defaults to the
16911 &%primary_hostname%& value.
16912
16913
16914 .option qualify_recipient main string "see below"
16915 This option allows you to specify a different domain for qualifying recipient
16916 addresses to the one that is used for senders. See &%qualify_domain%& above.
16917
16918
16919
16920 .option queue_domains main "domain list&!!" unset
16921 .cindex "domain" "specifying non-immediate delivery"
16922 .cindex "queueing incoming messages"
16923 .cindex "message" "queueing certain domains"
16924 This option lists domains for which immediate delivery is not required.
16925 A delivery process is started whenever a message is received, but only those
16926 domains that do not match are processed. All other deliveries wait until the
16927 next queue run. See also &%hold_domains%& and &%queue_smtp_domains%&.
16928
16929
16930 .option queue_list_requires_admin main boolean true
16931 .cindex "restricting access to features"
16932 .oindex "&%-bp%&"
16933 The &%-bp%& command-line option, which lists the messages that are on the
16934 queue, requires the caller to be an admin user unless
16935 &%queue_list_requires_admin%& is set false.
16936 See also &%prod_requires_admin%& and &%commandline_checks_require_admin%&.
16937
16938
16939 .option queue_only main boolean false
16940 .cindex "queueing incoming messages"
16941 .cindex "message" "queueing unconditionally"
16942 If &%queue_only%& is set, a delivery process is not automatically started
16943 whenever a message is received. Instead, the message waits in the queue for the
16944 next queue run. Even if &%queue_only%& is false, incoming messages may not get
16945 delivered immediately when certain conditions (such as heavy load) occur.
16946
16947 The &%-odq%& command line has the same effect as &%queue_only%&. The &%-odb%&
16948 and &%-odi%& command line options override &%queue_only%& unless
16949 &%queue_only_override%& is set false. See also &%queue_only_file%&,
16950 &%queue_only_load%&, and &%smtp_accept_queue%&.
16951
16952
16953 .option queue_only_file main string unset
16954 .cindex "queueing incoming messages"
16955 .cindex "message" "queueing by file existence"
16956 This option can be set to a colon-separated list of absolute path names, each
16957 one optionally preceded by &"smtp"&. When Exim is receiving a message,
16958 it tests for the existence of each listed path using a call to &[stat()]&. For
16959 each path that exists, the corresponding queueing option is set.
16960 For paths with no prefix, &%queue_only%& is set; for paths prefixed by
16961 &"smtp"&, &%queue_smtp_domains%& is set to match all domains. So, for example,
16962 .code
16963 queue_only_file = smtp/some/file
16964 .endd
16965 causes Exim to behave as if &%queue_smtp_domains%& were set to &"*"& whenever
16966 &_/some/file_& exists.
16967
16968
16969 .option queue_only_load main fixed-point unset
16970 .cindex "load average"
16971 .cindex "queueing incoming messages"
16972 .cindex "message" "queueing by load"
16973 If the system load average is higher than this value, incoming messages from
16974 all sources are queued, and no automatic deliveries are started. If this
16975 happens during local or remote SMTP input, all subsequent messages received on
16976 the same SMTP connection are queued by default, whatever happens to the load in
16977 the meantime, but this can be changed by setting &%queue_only_load_latch%&
16978 false.
16979
16980 Deliveries will subsequently be performed by queue runner processes. This
16981 option has no effect on ancient operating systems on which Exim cannot
16982 determine the load average. See also &%deliver_queue_load_max%& and
16983 &%smtp_load_reserve%&.
16984
16985
16986 .option queue_only_load_latch main boolean true
16987 .cindex "load average" "re-evaluating per message"
16988 When this option is true (the default), once one message has been queued
16989 because the load average is higher than the value set by &%queue_only_load%&,
16990 all subsequent messages received on the same SMTP connection are also queued.
16991 This is a deliberate choice; even though the load average may fall below the
16992 threshold, it doesn't seem right to deliver later messages on the same
16993 connection when not delivering earlier ones. However, there are special
16994 circumstances such as very long-lived connections from scanning appliances
16995 where this is not the best strategy. In such cases, &%queue_only_load_latch%&
16996 should be set false. This causes the value of the load average to be
16997 re-evaluated for each message.
16998
16999
17000 .option queue_only_override main boolean true
17001 .cindex "queueing incoming messages"
17002 When this option is true, the &%-od%&&'x'& command line options override the
17003 setting of &%queue_only%& or &%queue_only_file%& in the configuration file. If
17004 &%queue_only_override%& is set false, the &%-od%&&'x'& options cannot be used
17005 to override; they are accepted, but ignored.
17006
17007
17008 .option queue_run_in_order main boolean false
17009 .cindex "queue runner" "processing messages in order"
17010 If this option is set, queue runs happen in order of message arrival instead of
17011 in an arbitrary order. For this to happen, a complete list of the entire queue
17012 must be set up before the deliveries start. When the queue is all held in a
17013 single directory (the default), a single list is created for both the ordered
17014 and the non-ordered cases. However, if &%split_spool_directory%& is set, a
17015 single list is not created when &%queue_run_in_order%& is false. In this case,
17016 the sub-directories are processed one at a time (in a random order), and this
17017 avoids setting up one huge list for the whole queue. Thus, setting
17018 &%queue_run_in_order%& with &%split_spool_directory%& may degrade performance
17019 when the queue is large, because of the extra work in setting up the single,
17020 large list. In most situations, &%queue_run_in_order%& should not be set.
17021
17022
17023
17024 .option queue_run_max main integer&!! 5
17025 .cindex "queue runner" "maximum number of"
17026 This controls the maximum number of queue runner processes that an Exim daemon
17027 can run simultaneously. This does not mean that it starts them all at once,
17028 but rather that if the maximum number are still running when the time comes to
17029 start another one, it refrains from starting another one. This can happen with
17030 very large queues and/or very sluggish deliveries. This option does not,
17031 however, interlock with other processes, so additional queue runners can be
17032 started by other means, or by killing and restarting the daemon.
17033
17034 Setting this option to zero does not suppress queue runs; rather, it disables
17035 the limit, allowing any number of simultaneous queue runner processes to be
17036 run. If you do not want queue runs to occur, omit the &%-q%&&'xx'& setting on
17037 the daemon's command line.
17038
17039 .cindex queues named
17040 .cindex "named queues" "resource limit"
17041 To set limits for different named queues use
17042 an expansion depending on the &$queue_name$& variable.
17043
17044 .option queue_smtp_domains main "domain list&!!" unset
17045 .cindex "queueing incoming messages"
17046 .cindex "message" "queueing remote deliveries"
17047 .cindex "first pass routing"
17048 When this option is set, a delivery process is started whenever a message is
17049 received, routing is performed, and local deliveries take place.
17050 However, if any SMTP deliveries are required for domains that match
17051 &%queue_smtp_domains%&, they are not immediately delivered, but instead the
17052 message waits in the queue for the next queue run. Since routing of the message
17053 has taken place, Exim knows to which remote hosts it must be delivered, and so
17054 when the queue run happens, multiple messages for the same host are delivered
17055 over a single SMTP connection. The &%-odqs%& command line option causes all
17056 SMTP deliveries to be queued in this way, and is equivalent to setting
17057 &%queue_smtp_domains%& to &"*"&. See also &%hold_domains%& and
17058 &%queue_domains%&.
17059
17060
17061 .option receive_timeout main time 0s
17062 .cindex "timeout" "for non-SMTP input"
17063 This option sets the timeout for accepting a non-SMTP message, that is, the
17064 maximum time that Exim waits when reading a message on the standard input. If
17065 the value is zero, it will wait forever. This setting is overridden by the
17066 &%-or%& command line option. The timeout for incoming SMTP messages is
17067 controlled by &%smtp_receive_timeout%&.
17068
17069 .option received_header_text main string&!! "see below"
17070 .cindex "customizing" "&'Received:'& header"
17071 .cindex "&'Received:'& header line" "customizing"
17072 This string defines the contents of the &'Received:'& message header that is
17073 added to each message, except for the timestamp, which is automatically added
17074 on at the end (preceded by a semicolon). The string is expanded each time it is
17075 used. If the expansion yields an empty string, no &'Received:'& header line is
17076 added to the message. Otherwise, the string should start with the text
17077 &"Received:"& and conform to the RFC 2822 specification for &'Received:'&
17078 header lines.
17079 The default setting is:
17080
17081 .code
17082 received_header_text = Received: \
17083   ${if def:sender_rcvhost {from $sender_rcvhost\n\t}\
17084     {${if def:sender_ident \
17085       {from ${quote_local_part:$sender_ident} }}\
17086         ${if def:sender_helo_name {(helo=$sender_helo_name)\n\t}}}}\
17087   by $primary_hostname \
17088   ${if def:received_protocol {with $received_protocol }}\
17089   ${if def:tls_in_ver        { ($tls_in_ver)}}\
17090   ${if def:tls_in_cipher_std { tls $tls_in_cipher_std\n\t}}\
17091   (Exim $version_number)\n\t\
17092   ${if def:sender_address \
17093   {(envelope-from <$sender_address>)\n\t}}\
17094   id $message_exim_id\
17095   ${if def:received_for {\n\tfor $received_for}}
17096 .endd
17097
17098 The references to the TLS version and cipher are
17099 omitted when Exim is built without TLS
17100 support. The use of conditional expansions ensures that this works for both
17101 locally generated messages and messages received from remote hosts, giving
17102 header lines such as the following:
17103 .code
17104 Received: from scrooge.carol.example ([192.168.12.25] ident=root)
17105 by marley.carol.example with esmtp (Exim 4.00)
17106 (envelope-from <bob@carol.example>)
17107 id 16IOWa-00019l-00
17108 for chas@dickens.example; Tue, 25 Dec 2001 14:43:44 +0000
17109 Received: by scrooge.carol.example with local (Exim 4.00)
17110 id 16IOWW-000083-00; Tue, 25 Dec 2001 14:43:41 +0000
17111 .endd
17112 Until the body of the message has been received, the timestamp is the time when
17113 the message started to be received. Once the body has arrived, and all policy
17114 checks have taken place, the timestamp is updated to the time at which the
17115 message was accepted.
17116
17117
17118 .option received_headers_max main integer 30
17119 .cindex "loop" "prevention"
17120 .cindex "mail loop prevention"
17121 .cindex "&'Received:'& header line" "counting"
17122 When a message is to be delivered, the number of &'Received:'& headers is
17123 counted, and if it is greater than this parameter, a mail loop is assumed to
17124 have occurred, the delivery is abandoned, and an error message is generated.
17125 This applies to both local and remote deliveries.
17126
17127
17128 .option recipient_unqualified_hosts main "host list&!!" unset
17129 .cindex "unqualified addresses"
17130 .cindex "host" "unqualified addresses from"
17131 This option lists those hosts from which Exim is prepared to accept unqualified
17132 recipient addresses in message envelopes. The addresses are made fully
17133 qualified by the addition of the &%qualify_recipient%& value. This option also
17134 affects message header lines. Exim does not reject unqualified recipient
17135 addresses in headers, but it qualifies them only if the message came from a
17136 host that matches &%recipient_unqualified_hosts%&,
17137 or if the message was submitted locally (not using TCP/IP), and the &%-bnq%&
17138 option was not set.
17139
17140
17141 .option recipients_max main integer 0
17142 .cindex "limit" "number of recipients"
17143 .cindex "recipient" "maximum number"
17144 If this option is set greater than zero, it specifies the maximum number of
17145 original recipients for any message. Additional recipients that are generated
17146 by aliasing or forwarding do not count. SMTP messages get a 452 response for
17147 all recipients over the limit; earlier recipients are delivered as normal.
17148 Non-SMTP messages with too many recipients are failed, and no deliveries are
17149 done.
17150
17151 .cindex "RCPT" "maximum number of incoming"
17152 &*Note*&: The RFCs specify that an SMTP server should accept at least 100
17153 RCPT commands in a single message.
17154
17155
17156 .option recipients_max_reject main boolean false
17157 If this option is set true, Exim rejects SMTP messages containing too many
17158 recipients by giving 552 errors to the surplus RCPT commands, and a 554
17159 error to the eventual DATA command. Otherwise (the default) it gives a 452
17160 error to the surplus RCPT commands and accepts the message on behalf of the
17161 initial set of recipients. The remote server should then re-send the message
17162 for the remaining recipients at a later time.
17163
17164
17165 .option remote_max_parallel main integer 2
17166 .cindex "delivery" "parallelism for remote"
17167 This option controls parallel delivery of one message to a number of remote
17168 hosts. If the value is less than 2, parallel delivery is disabled, and Exim
17169 does all the remote deliveries for a message one by one. Otherwise, if a single
17170 message has to be delivered to more than one remote host, or if several copies
17171 have to be sent to the same remote host, up to &%remote_max_parallel%&
17172 deliveries are done simultaneously. If more than &%remote_max_parallel%&
17173 deliveries are required, the maximum number of processes are started, and as
17174 each one finishes, another is begun. The order of starting processes is the
17175 same as if sequential delivery were being done, and can be controlled by the
17176 &%remote_sort_domains%& option. If parallel delivery takes place while running
17177 with debugging turned on, the debugging output from each delivery process is
17178 tagged with its process id.
17179
17180 This option controls only the maximum number of parallel deliveries for one
17181 message in one Exim delivery process. Because Exim has no central queue
17182 manager, there is no way of controlling the total number of simultaneous
17183 deliveries if the configuration allows a delivery attempt as soon as a message
17184 is received.
17185
17186 .cindex "number of deliveries"
17187 .cindex "delivery" "maximum number of"
17188 If you want to control the total number of deliveries on the system, you
17189 need to set the &%queue_only%& option. This ensures that all incoming messages
17190 are added to the queue without starting a delivery process. Then set up an Exim
17191 daemon to start queue runner processes at appropriate intervals (probably
17192 fairly often, for example, every minute), and limit the total number of queue
17193 runners by setting the &%queue_run_max%& parameter. Because each queue runner
17194 delivers only one message at a time, the maximum number of deliveries that can
17195 then take place at once is &%queue_run_max%& multiplied by
17196 &%remote_max_parallel%&.
17197
17198 If it is purely remote deliveries you want to control, use
17199 &%queue_smtp_domains%& instead of &%queue_only%&. This has the added benefit of
17200 doing the SMTP routing before queueing, so that several messages for the same
17201 host will eventually get delivered down the same connection.
17202
17203
17204 .option remote_sort_domains main "domain list&!!" unset
17205 .cindex "sorting remote deliveries"
17206 .cindex "delivery" "sorting remote"
17207 When there are a number of remote deliveries for a message, they are sorted by
17208 domain into the order given by this list. For example,
17209 .code
17210 remote_sort_domains = *.cam.ac.uk:*.uk
17211 .endd
17212 would attempt to deliver to all addresses in the &'cam.ac.uk'& domain first,
17213 then to those in the &%uk%& domain, then to any others.
17214
17215
17216 .option retry_data_expire main time 7d
17217 .cindex "hints database" "data expiry"
17218 This option sets a &"use before"& time on retry information in Exim's hints
17219 database. Any older retry data is ignored. This means that, for example, once a
17220 host has not been tried for 7 days, Exim behaves as if it has no knowledge of
17221 past failures.
17222
17223
17224 .option retry_interval_max main time 24h
17225 .cindex "retry" "limit on interval"
17226 .cindex "limit" "on retry interval"
17227 Chapter &<<CHAPretry>>& describes Exim's mechanisms for controlling the
17228 intervals between delivery attempts for messages that cannot be delivered
17229 straight away. This option sets an overall limit to the length of time between
17230 retries. It cannot be set greater than 24 hours; any attempt to do so forces
17231 the default value.
17232
17233
17234 .option return_path_remove main boolean true
17235 .cindex "&'Return-path:'& header line" "removing"
17236 RFC 2821, section 4.4, states that an SMTP server must insert a
17237 &'Return-path:'& header line into a message when it makes a &"final delivery"&.
17238 The &'Return-path:'& header preserves the sender address as received in the
17239 MAIL command. This description implies that this header should not be present
17240 in an incoming message. If &%return_path_remove%& is true, any existing
17241 &'Return-path:'& headers are removed from messages at the time they are
17242 received. Exim's transports have options for adding &'Return-path:'& headers at
17243 the time of delivery. They are normally used only for final local deliveries.
17244
17245
17246 .option return_size_limit main integer 100K
17247 This option is an obsolete synonym for &%bounce_return_size_limit%&.
17248
17249
17250 .option rfc1413_hosts main "host list&!!" @[]
17251 .cindex "RFC 1413"
17252 .cindex "host" "for RFC 1413 calls"
17253 RFC 1413 identification calls are made to any client host which matches
17254 an item in the list.
17255 The default value specifies just this host, being any local interface
17256 for the system.
17257
17258 .option rfc1413_query_timeout main time 0s
17259 .cindex "RFC 1413" "query timeout"
17260 .cindex "timeout" "for RFC 1413 call"
17261 This sets the timeout on RFC 1413 identification calls. If it is set to zero,
17262 no RFC 1413 calls are ever made.
17263
17264
17265 .option sender_unqualified_hosts main "host list&!!" unset
17266 .cindex "unqualified addresses"
17267 .cindex "host" "unqualified addresses from"
17268 This option lists those hosts from which Exim is prepared to accept unqualified
17269 sender addresses. The addresses are made fully qualified by the addition of
17270 &%qualify_domain%&. This option also affects message header lines. Exim does
17271 not reject unqualified addresses in headers that contain sender addresses, but
17272 it qualifies them only if the message came from a host that matches
17273 &%sender_unqualified_hosts%&, or if the message was submitted locally (not
17274 using TCP/IP), and the &%-bnq%& option was not set.
17275
17276
17277 .option slow_lookup_log main integer 0
17278 .cindex "logging" "slow lookups"
17279 .cindex "dns" "logging slow lookups"
17280 This option controls logging of slow lookups.
17281 If the value is nonzero it is taken as a number of milliseconds
17282 and lookups taking longer than this are logged.
17283 Currently this applies only to DNS lookups.
17284
17285
17286
17287 .option smtp_accept_keepalive main boolean true
17288 .cindex "keepalive" "on incoming connection"
17289 This option controls the setting of the SO_KEEPALIVE option on incoming
17290 TCP/IP socket connections. When set, it causes the kernel to probe idle
17291 connections periodically, by sending packets with &"old"& sequence numbers. The
17292 other end of the connection should send an acknowledgment if the connection is
17293 still okay or a reset if the connection has been aborted. The reason for doing
17294 this is that it has the beneficial effect of freeing up certain types of
17295 connection that can get stuck when the remote host is disconnected without
17296 tidying up the TCP/IP call properly. The keepalive mechanism takes several
17297 hours to detect unreachable hosts.
17298
17299
17300
17301 .option smtp_accept_max main integer 20
17302 .cindex "limit" "incoming SMTP connections"
17303 .cindex "SMTP" "incoming connection count"
17304 .cindex "inetd"
17305 This option specifies the maximum number of simultaneous incoming SMTP calls
17306 that Exim will accept. It applies only to the listening daemon; there is no
17307 control (in Exim) when incoming SMTP is being handled by &'inetd'&. If the
17308 value is set to zero, no limit is applied. However, it is required to be
17309 non-zero if either &%smtp_accept_max_per_host%& or &%smtp_accept_queue%& is
17310 set. See also &%smtp_accept_reserve%& and &%smtp_load_reserve%&.
17311
17312 A new SMTP connection is immediately rejected if the &%smtp_accept_max%& limit
17313 has been reached. If not, Exim first checks &%smtp_accept_max_per_host%&. If
17314 that limit has not been reached for the client host, &%smtp_accept_reserve%&
17315 and &%smtp_load_reserve%& are then checked before accepting the connection.
17316
17317
17318 .option smtp_accept_max_nonmail main integer 10
17319 .cindex "limit" "non-mail SMTP commands"
17320 .cindex "SMTP" "limiting non-mail commands"
17321 Exim counts the number of &"non-mail"& commands in an SMTP session, and drops
17322 the connection if there are too many. This option defines &"too many"&. The
17323 check catches some denial-of-service attacks, repeated failing AUTHs, or a mad
17324 client looping sending EHLO, for example. The check is applied only if the
17325 client host matches &%smtp_accept_max_nonmail_hosts%&.
17326
17327 When a new message is expected, one occurrence of RSET is not counted. This
17328 allows a client to send one RSET between messages (this is not necessary,
17329 but some clients do it). Exim also allows one uncounted occurrence of HELO
17330 or EHLO, and one occurrence of STARTTLS between messages. After
17331 starting up a TLS session, another EHLO is expected, and so it too is not
17332 counted. The first occurrence of AUTH in a connection, or immediately
17333 following STARTTLS is not counted. Otherwise, all commands other than
17334 MAIL, RCPT, DATA, and QUIT are counted.
17335
17336
17337 .option smtp_accept_max_nonmail_hosts main "host list&!!" *
17338 You can control which hosts are subject to the &%smtp_accept_max_nonmail%&
17339 check by setting this option. The default value makes it apply to all hosts. By
17340 changing the value, you can exclude any badly-behaved hosts that you have to
17341 live with.
17342
17343
17344 . Allow this long option name to split; give it unsplit as a fifth argument
17345 . for the automatic .oindex that is generated by .option.
17346 . We insert " &~&~" which is both pretty nasty visually and results in
17347 . non-searchable text.  HowItWorks.txt mentions an option for inserting
17348 . zero-width-space, which would be nicer visually and results in (at least)
17349 . html that Firefox will split on when it's forced to reflow (rather than
17350 . inserting a horizontal scrollbar).  However, the text is still not
17351 . searchable.  NM changed this occurrence for bug 1197 to no longer allow
17352 . the option name to split.
17353
17354 .option "smtp_accept_max_per_connection" main integer 1000 &&&
17355          smtp_accept_max_per_connection
17356 .cindex "SMTP" "limiting incoming message count"
17357 .cindex "limit" "messages per SMTP connection"
17358 The value of this option limits the number of MAIL commands that Exim is
17359 prepared to accept over a single SMTP connection, whether or not each command
17360 results in the transfer of a message. After the limit is reached, a 421
17361 response is given to subsequent MAIL commands. This limit is a safety
17362 precaution against a client that goes mad (incidents of this type have been
17363 seen).
17364
17365
17366 .option smtp_accept_max_per_host main string&!! unset
17367 .cindex "limit" "SMTP connections from one host"
17368 .cindex "host" "limiting SMTP connections from"
17369 This option restricts the number of simultaneous IP connections from a single
17370 host (strictly, from a single IP address) to the Exim daemon. The option is
17371 expanded, to enable different limits to be applied to different hosts by
17372 reference to &$sender_host_address$&. Once the limit is reached, additional
17373 connection attempts from the same host are rejected with error code 421. This
17374 is entirely independent of &%smtp_accept_reserve%&. The option's default value
17375 of zero imposes no limit. If this option is set greater than zero, it is
17376 required that &%smtp_accept_max%& be non-zero.
17377
17378 &*Warning*&: When setting this option you should not use any expansion
17379 constructions that take an appreciable amount of time. The expansion and test
17380 happen in the main daemon loop, in order to reject additional connections
17381 without forking additional processes (otherwise a denial-of-service attack
17382 could cause a vast number or processes to be created). While the daemon is
17383 doing this processing, it cannot accept any other incoming connections.
17384
17385
17386
17387 .option smtp_accept_queue main integer 0
17388 .cindex "SMTP" "incoming connection count"
17389 .cindex "queueing incoming messages"
17390 .cindex "message" "queueing by SMTP connection count"
17391 If the number of simultaneous incoming SMTP connections being handled via the
17392 listening daemon exceeds this value, messages received by SMTP are just placed
17393 in the queue; no delivery processes are started automatically. The count is
17394 fixed at the start of an SMTP connection. It cannot be updated in the
17395 subprocess that receives messages, and so the queueing or not queueing applies
17396 to all messages received in the same connection.
17397
17398 A value of zero implies no limit, and clearly any non-zero value is useful only
17399 if it is less than the &%smtp_accept_max%& value (unless that is zero). See
17400 also &%queue_only%&, &%queue_only_load%&, &%queue_smtp_domains%&, and the
17401 various &%-od%&&'x'& command line options.
17402
17403
17404 . See the comment on smtp_accept_max_per_connection
17405
17406 .option "smtp_accept_queue_per_connection" main integer 10 &&&
17407          smtp_accept_queue_per_connection
17408 .cindex "queueing incoming messages"
17409 .cindex "message" "queueing by message count"
17410 This option limits the number of delivery processes that Exim starts
17411 automatically when receiving messages via SMTP, whether via the daemon or by
17412 the use of &%-bs%& or &%-bS%&. If the value of the option is greater than zero,
17413 and the number of messages received in a single SMTP session exceeds this
17414 number, subsequent messages are placed in the queue, but no delivery processes
17415 are started. This helps to limit the number of Exim processes when a server
17416 restarts after downtime and there is a lot of mail waiting for it on other
17417 systems. On large systems, the default should probably be increased, and on
17418 dial-in client systems it should probably be set to zero (that is, disabled).
17419
17420
17421 .option smtp_accept_reserve main integer 0
17422 .cindex "SMTP" "incoming call count"
17423 .cindex "host" "reserved"
17424 When &%smtp_accept_max%& is set greater than zero, this option specifies a
17425 number of SMTP connections that are reserved for connections from the hosts
17426 that are specified in &%smtp_reserve_hosts%&. The value set in
17427 &%smtp_accept_max%& includes this reserve pool. The specified hosts are not
17428 restricted to this number of connections; the option specifies a minimum number
17429 of connection slots for them, not a maximum. It is a guarantee that this group
17430 of hosts can always get at least &%smtp_accept_reserve%& connections. However,
17431 the limit specified by &%smtp_accept_max_per_host%& is still applied to each
17432 individual host.
17433
17434 For example, if &%smtp_accept_max%& is set to 50 and &%smtp_accept_reserve%& is
17435 set to 5, once there are 45 active connections (from any hosts), new
17436 connections are accepted only from hosts listed in &%smtp_reserve_hosts%&,
17437 provided the other criteria for acceptance are met.
17438
17439
17440 .option smtp_active_hostname main string&!! unset
17441 .cindex "host" "name in SMTP responses"
17442 .cindex "SMTP" "host name in responses"
17443 .vindex "&$primary_hostname$&"
17444 This option is provided for multi-homed servers that want to masquerade as
17445 several different hosts. At the start of an incoming SMTP connection, its value
17446 is expanded and used instead of the value of &$primary_hostname$& in SMTP
17447 responses. For example, it is used as domain name in the response to an
17448 incoming HELO or EHLO command.
17449
17450 .vindex "&$smtp_active_hostname$&"
17451 The active hostname is placed in the &$smtp_active_hostname$& variable, which
17452 is saved with any messages that are received. It is therefore available for use
17453 in routers and transports when the message is later delivered.
17454
17455 If this option is unset, or if its expansion is forced to fail, or if the
17456 expansion results in an empty string, the value of &$primary_hostname$& is
17457 used. Other expansion failures cause a message to be written to the main and
17458 panic logs, and the SMTP command receives a temporary error. Typically, the
17459 value of &%smtp_active_hostname%& depends on the incoming interface address.
17460 For example:
17461 .code
17462 smtp_active_hostname = ${if eq{$received_ip_address}{10.0.0.1}\
17463   {cox.mydomain}{box.mydomain}}
17464 .endd
17465
17466 Although &$smtp_active_hostname$& is primarily concerned with incoming
17467 messages, it is also used as the default for HELO commands in callout
17468 verification if there is no remote transport from which to obtain a
17469 &%helo_data%& value.
17470
17471 .option smtp_banner main string&!! "see below"
17472 .cindex "SMTP" "welcome banner"
17473 .cindex "banner for SMTP"
17474 .cindex "welcome banner for SMTP"
17475 .cindex "customizing" "SMTP banner"
17476 This string, which is expanded every time it is used, is output as the initial
17477 positive response to an SMTP connection. The default setting is:
17478 .code
17479 smtp_banner = $smtp_active_hostname ESMTP Exim \
17480   $version_number $tod_full
17481 .endd
17482 Failure to expand the string causes a panic error. If you want to create a
17483 multiline response to the initial SMTP connection, use &"\n"& in the string at
17484 appropriate points, but not at the end. Note that the 220 code is not included
17485 in this string. Exim adds it automatically (several times in the case of a
17486 multiline response).
17487
17488
17489 .option smtp_check_spool_space main boolean true
17490 .cindex "checking disk space"
17491 .cindex "disk space, checking"
17492 .cindex "spool directory" "checking space"
17493 When this option is set, if an incoming SMTP session encounters the SIZE
17494 option on a MAIL command, it checks that there is enough space in the
17495 spool directory's partition to accept a message of that size, while still
17496 leaving free the amount specified by &%check_spool_space%& (even if that value
17497 is zero). If there isn't enough space, a temporary error code is returned.
17498
17499
17500 .option smtp_connect_backlog main integer 20
17501 .cindex "connection backlog"
17502 .cindex "SMTP" "connection backlog"
17503 .cindex "backlog of connections"
17504 This option specifies a maximum number of waiting SMTP connections. Exim passes
17505 this value to the TCP/IP system when it sets up its listener. Once this number
17506 of connections are waiting for the daemon's attention, subsequent connection
17507 attempts are refused at the TCP/IP level. At least, that is what the manuals
17508 say; in some circumstances such connection attempts have been observed to time
17509 out instead. For large systems it is probably a good idea to increase the
17510 value (to 50, say). It also gives some protection against denial-of-service
17511 attacks by SYN flooding.
17512
17513
17514 .option smtp_enforce_sync main boolean true
17515 .cindex "SMTP" "synchronization checking"
17516 .cindex "synchronization checking in SMTP"
17517 The SMTP protocol specification requires the client to wait for a response from
17518 the server at certain points in the dialogue. Without PIPELINING these
17519 synchronization points are after every command; with PIPELINING they are
17520 fewer, but they still exist.
17521
17522 Some spamming sites send out a complete set of SMTP commands without waiting
17523 for any response. Exim protects against this by rejecting a message if the
17524 client has sent further input when it should not have. The error response &"554
17525 SMTP synchronization error"& is sent, and the connection is dropped. Testing
17526 for this error cannot be perfect because of transmission delays (unexpected
17527 input may be on its way but not yet received when Exim checks). However, it
17528 does detect many instances.
17529
17530 The check can be globally disabled by setting &%smtp_enforce_sync%& false.
17531 If you want to disable the check selectively (for example, only for certain
17532 hosts), you can do so by an appropriate use of a &%control%& modifier in an ACL
17533 (see section &<<SECTcontrols>>&). See also &%pipelining_advertise_hosts%&.
17534
17535
17536
17537 .option smtp_etrn_command main string&!! unset
17538 .cindex "ETRN" "command to be run"
17539 .cindex "ESMTP extensions" ETRN
17540 .vindex "&$domain$&"
17541 If this option is set, the given command is run whenever an SMTP ETRN
17542 command is received from a host that is permitted to issue such commands (see
17543 chapter &<<CHAPACL>>&). The string is split up into separate arguments which
17544 are independently expanded. The expansion variable &$domain$& is set to the
17545 argument of the ETRN command, and no syntax checking is done on it. For
17546 example:
17547 .code
17548 smtp_etrn_command = /etc/etrn_command $domain \
17549                     $sender_host_address
17550 .endd
17551 .new
17552 If the option is not set, the argument for the ETRN command must
17553 be a &'#'& followed by an address string.
17554 In this case an &'exim -R <string>'& command is used;
17555 if the ETRN ACL has set up a named-queue then &'-MCG <queue>'& is appended.
17556 .wen
17557
17558 A new process is created to run the command, but Exim does not wait for it to
17559 complete. Consequently, its status cannot be checked. If the command cannot be
17560 run, a line is written to the panic log, but the ETRN caller still receives
17561 a 250 success response. Exim is normally running under its own uid when
17562 receiving SMTP, so it is not possible for it to change the uid before running
17563 the command.
17564
17565
17566 .option smtp_etrn_serialize main boolean true
17567 .cindex "ETRN" "serializing"
17568 When this option is set, it prevents the simultaneous execution of more than
17569 one identical command as a result of ETRN in an SMTP connection. See
17570 section &<<SECTETRN>>& for details.
17571
17572
17573 .option smtp_load_reserve main fixed-point unset
17574 .cindex "load average"
17575 If the system load average ever gets higher than this, incoming SMTP calls are
17576 accepted only from those hosts that match an entry in &%smtp_reserve_hosts%&.
17577 If &%smtp_reserve_hosts%& is not set, no incoming SMTP calls are accepted when
17578 the load is over the limit. The option has no effect on ancient operating
17579 systems on which Exim cannot determine the load average. See also
17580 &%deliver_queue_load_max%& and &%queue_only_load%&.
17581
17582
17583
17584 .option smtp_max_synprot_errors main integer 3
17585 .cindex "SMTP" "limiting syntax and protocol errors"
17586 .cindex "limit" "SMTP syntax and protocol errors"
17587 Exim rejects SMTP commands that contain syntax or protocol errors. In
17588 particular, a syntactically invalid email address, as in this command:
17589 .code
17590 RCPT TO:<abc xyz@a.b.c>
17591 .endd
17592 causes immediate rejection of the command, before any other tests are done.
17593 (The ACL cannot be run if there is no valid address to set up for it.) An
17594 example of a protocol error is receiving RCPT before MAIL. If there are
17595 too many syntax or protocol errors in one SMTP session, the connection is
17596 dropped. The limit is set by this option.
17597
17598 .cindex "PIPELINING" "expected errors"
17599 When the PIPELINING extension to SMTP is in use, some protocol errors are
17600 &"expected"&, for instance, a RCPT command after a rejected MAIL command.
17601 Exim assumes that PIPELINING will be used if it advertises it (see
17602 &%pipelining_advertise_hosts%&), and in this situation, &"expected"& errors do
17603 not count towards the limit.
17604
17605
17606
17607 .option smtp_max_unknown_commands main integer 3
17608 .cindex "SMTP" "limiting unknown commands"
17609 .cindex "limit" "unknown SMTP commands"
17610 If there are too many unrecognized commands in an incoming SMTP session, an
17611 Exim server drops the connection. This is a defence against some kinds of abuse
17612 that subvert web
17613 clients
17614 into making connections to SMTP ports; in these circumstances, a number of
17615 non-SMTP command lines are sent first.
17616
17617
17618
17619 .option smtp_ratelimit_hosts main "host list&!!" unset
17620 .cindex "SMTP" "rate limiting"
17621 .cindex "limit" "rate of message arrival"
17622 .cindex "RCPT" "rate limiting"
17623 Some sites find it helpful to be able to limit the rate at which certain hosts
17624 can send them messages, and the rate at which an individual message can specify
17625 recipients.
17626
17627 Exim has two rate-limiting facilities. This section describes the older
17628 facility, which can limit rates within a single connection. The newer
17629 &%ratelimit%& ACL condition can limit rates across all connections. See section
17630 &<<SECTratelimiting>>& for details of the newer facility.
17631
17632 When a host matches &%smtp_ratelimit_hosts%&, the values of
17633 &%smtp_ratelimit_mail%& and &%smtp_ratelimit_rcpt%& are used to control the
17634 rate of acceptance of MAIL and RCPT commands in a single SMTP session,
17635 respectively. Each option, if set, must contain a set of four comma-separated
17636 values:
17637
17638 .ilist
17639 A threshold, before which there is no rate limiting.
17640 .next
17641 An initial time delay. Unlike other times in Exim, numbers with decimal
17642 fractional parts are allowed here.
17643 .next
17644 A factor by which to increase the delay each time.
17645 .next
17646 A maximum value for the delay. This should normally be less than 5 minutes,
17647 because after that time, the client is liable to timeout the SMTP command.
17648 .endlist
17649
17650 For example, these settings have been used successfully at the site which
17651 first suggested this feature, for controlling mail from their customers:
17652 .code
17653 smtp_ratelimit_mail = 2,0.5s,1.05,4m
17654 smtp_ratelimit_rcpt = 4,0.25s,1.015,4m
17655 .endd
17656 The first setting specifies delays that are applied to MAIL commands after
17657 two have been received over a single connection. The initial delay is 0.5
17658 seconds, increasing by a factor of 1.05 each time. The second setting applies
17659 delays to RCPT commands when more than four occur in a single message.
17660
17661
17662 .option smtp_ratelimit_mail main string unset
17663 See &%smtp_ratelimit_hosts%& above.
17664
17665
17666 .option smtp_ratelimit_rcpt main string unset
17667 See &%smtp_ratelimit_hosts%& above.
17668
17669
17670 .option smtp_receive_timeout main time&!! 5m
17671 .cindex "timeout" "for SMTP input"
17672 .cindex "SMTP" "input timeout"
17673 This sets a timeout value for SMTP reception. It applies to all forms of SMTP
17674 input, including batch SMTP. If a line of input (either an SMTP command or a
17675 data line) is not received within this time, the SMTP connection is dropped and
17676 the message is abandoned.
17677 A line is written to the log containing one of the following messages:
17678 .code
17679 SMTP command timeout on connection from...
17680 SMTP data timeout on connection from...
17681 .endd
17682 The former means that Exim was expecting to read an SMTP command; the latter
17683 means that it was in the DATA phase, reading the contents of a message.
17684
17685 If the first character of the option is a &"$"& the option is
17686 expanded before use and may depend on
17687 &$sender_host_name$&, &$sender_host_address$& and &$sender_host_port$&.
17688
17689
17690 .oindex "&%-os%&"
17691 The value set by this option can be overridden by the
17692 &%-os%& command-line option. A setting of zero time disables the timeout, but
17693 this should never be used for SMTP over TCP/IP. (It can be useful in some cases
17694 of local input using &%-bs%& or &%-bS%&.) For non-SMTP input, the reception
17695 timeout is controlled by &%receive_timeout%& and &%-or%&.
17696
17697
17698 .option smtp_reserve_hosts main "host list&!!" unset
17699 This option defines hosts for which SMTP connections are reserved; see
17700 &%smtp_accept_reserve%& and &%smtp_load_reserve%& above.
17701
17702
17703 .option smtp_return_error_details main boolean false
17704 .cindex "SMTP" "details policy failures"
17705 .cindex "policy control" "rejection, returning details"
17706 In the default state, Exim uses bland messages such as
17707 &"Administrative prohibition"& when it rejects SMTP commands for policy
17708 reasons. Many sysadmins like this because it gives away little information
17709 to spammers. However, some other sysadmins who are applying strict checking
17710 policies want to give out much fuller information about failures. Setting
17711 &%smtp_return_error_details%& true causes Exim to be more forthcoming. For
17712 example, instead of &"Administrative prohibition"&, it might give:
17713 .code
17714 550-Rejected after DATA: '>' missing at end of address:
17715 550 failing address in "From" header is: <user@dom.ain
17716 .endd
17717
17718
17719 .option smtputf8_advertise_hosts main "host list&!!" *
17720 .cindex "SMTPUTF8" "ESMTP extension, advertising"
17721 .cindex "ESMTP extensions" SMTPUTF8
17722 When Exim is built with support for internationalised mail names,
17723 the availability thereof is advertised in
17724 response to EHLO only to those client hosts that match this option. See
17725 chapter &<<CHAPi18n>>& for details of Exim's support for internationalisation.
17726
17727
17728 .option spamd_address main string "127.0.0.1 783"
17729 This option is available when Exim is compiled with the content-scanning
17730 extension. It specifies how Exim connects to SpamAssassin's &%spamd%& daemon.
17731 See section &<<SECTscanspamass>>& for more details.
17732
17733
17734
17735 .option spf_guess main string "v=spf1 a/24 mx/24 ptr ?all"
17736 This option is available when Exim is compiled with SPF support.
17737 See section &<<SECSPF>>& for more details.
17738
17739
17740
17741 .option split_spool_directory main boolean false
17742 .cindex "multiple spool directories"
17743 .cindex "spool directory" "split"
17744 .cindex "directories, multiple"
17745 If this option is set, it causes Exim to split its input directory into 62
17746 subdirectories, each with a single alphanumeric character as its name. The
17747 sixth character of the message id is used to allocate messages to
17748 subdirectories; this is the least significant base-62 digit of the time of
17749 arrival of the message.
17750
17751 Splitting up the spool in this way may provide better performance on systems
17752 where there are long mail queues, by reducing the number of files in any one
17753 directory. The msglog directory is also split up in a similar way to the input
17754 directory; however, if &%preserve_message_logs%& is set, all old msglog files
17755 are still placed in the single directory &_msglog.OLD_&.
17756
17757 It is not necessary to take any special action for existing messages when
17758 changing &%split_spool_directory%&. Exim notices messages that are in the
17759 &"wrong"& place, and continues to process them. If the option is turned off
17760 after a period of being on, the subdirectories will eventually empty and be
17761 automatically deleted.
17762
17763 When &%split_spool_directory%& is set, the behaviour of queue runner processes
17764 changes. Instead of creating a list of all messages in the queue, and then
17765 trying to deliver each one, in turn, it constructs a list of those in one
17766 sub-directory and tries to deliver them, before moving on to the next
17767 sub-directory. The sub-directories are processed in a random order. This
17768 spreads out the scanning of the input directories, and uses less memory. It is
17769 particularly beneficial when there are lots of messages in the queue. However,
17770 if &%queue_run_in_order%& is set, none of this new processing happens. The
17771 entire queue has to be scanned and sorted before any deliveries can start.
17772
17773
17774 .option spool_directory main string&!! "set at compile time"
17775 .cindex "spool directory" "path to"
17776 This defines the directory in which Exim keeps its spool, that is, the messages
17777 it is waiting to deliver. The default value is taken from the compile-time
17778 configuration setting, if there is one. If not, this option must be set. The
17779 string is expanded, so it can contain, for example, a reference to
17780 &$primary_hostname$&.
17781
17782 If the spool directory name is fixed on your installation, it is recommended
17783 that you set it at build time rather than from this option, particularly if the
17784 log files are being written to the spool directory (see &%log_file_path%&).
17785 Otherwise log files cannot be used for errors that are detected early on, such
17786 as failures in the configuration file.
17787
17788 By using this option to override the compiled-in path, it is possible to run
17789 tests of Exim without using the standard spool.
17790
17791 .option spool_wireformat main boolean false
17792 .cindex "spool directory" "file formats"
17793 If this option is set, Exim may for some messages use an alternative format
17794 for data-files in the spool which matches the wire format.
17795 Doing this permits more efficient message reception and transmission.
17796 Currently it is only done for messages received using the ESMTP CHUNKING
17797 option.
17798
17799 The following variables will not have useful values:
17800 .code
17801 $max_received_linelength
17802 $body_linecount
17803 $body_zerocount
17804 .endd
17805
17806 Users of the local_scan() API (see &<<CHAPlocalscan>>&),
17807 and any external programs which are passed a reference to a message data file
17808 (except via the &"regex"&, &"malware"& or &"spam"&) ACL conditions)
17809 will need to be aware of the different formats potentially available.
17810
17811 Using any of the ACL conditions noted will negate the reception benefit
17812 (as a Unix-mbox-format file is constructed for them).
17813 The transmission benefit is maintained.
17814
17815 .option sqlite_lock_timeout main time 5s
17816 .cindex "sqlite lookup type" "lock timeout"
17817 This option controls the timeout that the &(sqlite)& lookup uses when trying to
17818 access an SQLite database. See section &<<SECTsqlite>>& for more details.
17819
17820 .option strict_acl_vars main boolean false
17821 .cindex "&ACL;" "variables, handling unset"
17822 This option controls what happens if a syntactically valid but undefined ACL
17823 variable is referenced. If it is false (the default), an empty string
17824 is substituted; if it is true, an error is generated. See section
17825 &<<SECTaclvariables>>& for details of ACL variables.
17826
17827 .option strip_excess_angle_brackets main boolean false
17828 .cindex "angle brackets, excess"
17829 If this option is set, redundant pairs of angle brackets round &"route-addr"&
17830 items in addresses are stripped. For example, &'<<xxx@a.b.c.d>>'& is
17831 treated as &'<xxx@a.b.c.d>'&. If this is in the envelope and the message is
17832 passed on to another MTA, the excess angle brackets are not passed on. If this
17833 option is not set, multiple pairs of angle brackets cause a syntax error.
17834
17835
17836 .option strip_trailing_dot main boolean false
17837 .cindex "trailing dot on domain"
17838 .cindex "dot" "trailing on domain"
17839 If this option is set, a trailing dot at the end of a domain in an address is
17840 ignored. If this is in the envelope and the message is passed on to another
17841 MTA, the dot is not passed on. If this option is not set, a dot at the end of a
17842 domain causes a syntax error.
17843 However, addresses in header lines are checked only when an ACL requests header
17844 syntax checking.
17845
17846
17847 .option syslog_duplication main boolean true
17848 .cindex "syslog" "duplicate log lines; suppressing"
17849 When Exim is logging to syslog, it writes the log lines for its three
17850 separate logs at different syslog priorities so that they can in principle
17851 be separated on the logging hosts. Some installations do not require this
17852 separation, and in those cases, the duplication of certain log lines is a
17853 nuisance. If &%syslog_duplication%& is set false, only one copy of any
17854 particular log line is written to syslog. For lines that normally go to
17855 both the main log and the reject log, the reject log version (possibly
17856 containing message header lines) is written, at LOG_NOTICE priority.
17857 Lines that normally go to both the main and the panic log are written at
17858 the LOG_ALERT priority.
17859
17860
17861 .option syslog_facility main string unset
17862 .cindex "syslog" "facility; setting"
17863 This option sets the syslog &"facility"& name, used when Exim is logging to
17864 syslog. The value must be one of the strings &"mail"&, &"user"&, &"news"&,
17865 &"uucp"&, &"daemon"&, or &"local&'x'&"& where &'x'& is a digit between 0 and 7.
17866 If this option is unset, &"mail"& is used. See chapter &<<CHAPlog>>& for
17867 details of Exim's logging.
17868
17869
17870 .option syslog_pid main boolean true
17871 .cindex "syslog" "pid"
17872 If &%syslog_pid%& is set false, the PID on Exim's log lines are
17873 omitted when these lines are sent to syslog. (Syslog normally prefixes
17874 the log lines with the PID of the logging process automatically.) You need
17875 to enable the &`+pid`& log selector item, if you want Exim to write it's PID
17876 into the logs.) See chapter &<<CHAPlog>>& for details of Exim's logging.
17877
17878
17879
17880 .option syslog_processname main string &`exim`&
17881 .cindex "syslog" "process name; setting"
17882 This option sets the syslog &"ident"& name, used when Exim is logging to
17883 syslog. The value must be no longer than 32 characters. See chapter
17884 &<<CHAPlog>>& for details of Exim's logging.
17885
17886
17887
17888 .option syslog_timestamp main boolean true
17889 .cindex "syslog" "timestamps"
17890 If &%syslog_timestamp%& is set false, the timestamps on Exim's log lines are
17891 omitted when these lines are sent to syslog. See chapter &<<CHAPlog>>& for
17892 details of Exim's logging.
17893
17894
17895 .option system_filter main string&!! unset
17896 .cindex "filter" "system filter"
17897 .cindex "system filter" "specifying"
17898 .cindex "Sieve filter" "not available for system filter"
17899 This option specifies an Exim filter file that is applied to all messages at
17900 the start of each delivery attempt, before any routing is done. System filters
17901 must be Exim filters; they cannot be Sieve filters. If the system filter
17902 generates any deliveries to files or pipes, or any new mail messages, the
17903 appropriate &%system_filter_..._transport%& option(s) must be set, to define
17904 which transports are to be used. Details of this facility are given in chapter
17905 &<<CHAPsystemfilter>>&.
17906 A forced expansion failure results in no filter operation.
17907
17908
17909 .option system_filter_directory_transport main string&!! unset
17910 .vindex "&$address_file$&"
17911 This sets the name of the transport driver that is to be used when the
17912 &%save%& command in a system message filter specifies a path ending in &"/"&,
17913 implying delivery of each message into a separate file in some directory.
17914 During the delivery, the variable &$address_file$& contains the path name.
17915
17916
17917 .option system_filter_file_transport main string&!! unset
17918 .cindex "file" "transport for system filter"
17919 This sets the name of the transport driver that is to be used when the &%save%&
17920 command in a system message filter specifies a path not ending in &"/"&. During
17921 the delivery, the variable &$address_file$& contains the path name.
17922
17923 .option system_filter_group main string unset
17924 .cindex "gid (group id)" "system filter"
17925 This option is used only when &%system_filter_user%& is also set. It sets the
17926 gid under which the system filter is run, overriding any gid that is associated
17927 with the user. The value may be numerical or symbolic.
17928
17929 .option system_filter_pipe_transport main string&!! unset
17930 .cindex "&(pipe)& transport" "for system filter"
17931 .vindex "&$address_pipe$&"
17932 This specifies the transport driver that is to be used when a &%pipe%& command
17933 is used in a system filter. During the delivery, the variable &$address_pipe$&
17934 contains the pipe command.
17935
17936
17937 .option system_filter_reply_transport main string&!! unset
17938 .cindex "&(autoreply)& transport" "for system filter"
17939 This specifies the transport driver that is to be used when a &%mail%& command
17940 is used in a system filter.
17941
17942
17943 .option system_filter_user main string unset
17944 .cindex "uid (user id)" "system filter"
17945 If this option is set to root, the system filter is run in the main Exim
17946 delivery process, as root.  Otherwise, the system filter runs in a separate
17947 process, as the given user, defaulting to the Exim run-time user.
17948 Unless the string consists entirely of digits, it
17949 is looked up in the password data. Failure to find the named user causes a
17950 configuration error. The gid is either taken from the password data, or
17951 specified by &%system_filter_group%&. When the uid is specified numerically,
17952 &%system_filter_group%& is required to be set.
17953
17954 If the system filter generates any pipe, file, or reply deliveries, the uid
17955 under which the filter is run is used when transporting them, unless a
17956 transport option overrides.
17957
17958
17959 .option tcp_nodelay main boolean true
17960 .cindex "daemon" "TCP_NODELAY on sockets"
17961 .cindex "Nagle algorithm"
17962 .cindex "TCP_NODELAY on listening sockets"
17963 If this option is set false, it stops the Exim daemon setting the
17964 TCP_NODELAY option on its listening sockets. Setting TCP_NODELAY
17965 turns off the &"Nagle algorithm"&, which is a way of improving network
17966 performance in interactive (character-by-character) situations. Turning it off
17967 should improve Exim's performance a bit, so that is what happens by default.
17968 However, it appears that some broken clients cannot cope, and time out. Hence
17969 this option. It affects only those sockets that are set up for listening by the
17970 daemon. Sockets created by the smtp transport for delivering mail always set
17971 TCP_NODELAY.
17972
17973
17974 .option timeout_frozen_after main time 0s
17975 .cindex "frozen messages" "timing out"
17976 .cindex "timeout" "frozen messages"
17977 If &%timeout_frozen_after%& is set to a time greater than zero, a frozen
17978 message of any kind that has been in the queue for longer than the given time
17979 is automatically cancelled at the next queue run. If the frozen message is a
17980 bounce message, it is just discarded; otherwise, a bounce is sent to the
17981 sender, in a similar manner to cancellation by the &%-Mg%& command line option.
17982 If you want to timeout frozen bounce messages earlier than other kinds of
17983 frozen message, see &%ignore_bounce_errors_after%&.
17984
17985 &*Note:*& the default value of zero means no timeouts; with this setting,
17986 frozen messages remain in the queue forever (except for any frozen bounce
17987 messages that are released by &%ignore_bounce_errors_after%&).
17988
17989
17990 .option timezone main string unset
17991 .cindex "timezone, setting"
17992 .cindex "environment" "values from"
17993 The value of &%timezone%& is used to set the environment variable TZ while
17994 running Exim (if it is different on entry). This ensures that all timestamps
17995 created by Exim are in the required timezone. If you want all your timestamps
17996 to be in UTC (aka GMT) you should set
17997 .code
17998 timezone = UTC
17999 .endd
18000 The default value is taken from TIMEZONE_DEFAULT in &_Local/Makefile_&,
18001 or, if that is not set, from the value of the TZ environment variable when Exim
18002 is built. If &%timezone%& is set to the empty string, either at build or run
18003 time, any existing TZ variable is removed from the environment when Exim
18004 runs. This is appropriate behaviour for obtaining wall-clock time on some, but
18005 unfortunately not all, operating systems.
18006
18007
18008 .option tls_advertise_hosts main "host list&!!" *
18009 .cindex "TLS" "advertising"
18010 .cindex "encryption" "on SMTP connection"
18011 .cindex "SMTP" "encrypted connection"
18012 .cindex "ESMTP extensions" STARTTLS
18013 When Exim is built with support for TLS encrypted connections, the availability
18014 of the STARTTLS command to set up an encrypted session is advertised in
18015 response to EHLO only to those client hosts that match this option. See
18016 chapter &<<CHAPTLS>>& for details of Exim's support for TLS.
18017 Note that the default value requires that a certificate be supplied
18018 using the &%tls_certificate%& option.  If TLS support for incoming connections
18019 is not required the &%tls_advertise_hosts%& option should be set empty.
18020
18021
18022 .option tls_certificate main string list&!! unset
18023 .cindex "TLS" "server certificate; location of"
18024 .cindex "certificate" "server, location of"
18025 The value of this option is expanded, and must then be a list of absolute paths to
18026 files which contain the server's certificates (in PEM format).
18027 Commonly only one file is needed.
18028 The server's private key is also
18029 assumed to be in this file if &%tls_privatekey%& is unset. See chapter
18030 &<<CHAPTLS>>& for further details.
18031
18032 &*Note*&: The certificates defined by this option are used only when Exim is
18033 receiving incoming messages as a server. If you want to supply certificates for
18034 use when sending messages as a client, you must set the &%tls_certificate%&
18035 option in the relevant &(smtp)& transport.
18036
18037 &*Note*&: If you use filenames based on IP addresses, change the list
18038 separator in the usual way (&<<SECTlistsepchange>>&) to avoid confusion under IPv6.
18039
18040 &*Note*&: Under versions of OpenSSL preceding 1.1.1,
18041 when a list of more than one
18042 file is used, the &$tls_in_ourcert$& variable is unreliable.
18043 The macro "_TLS_BAD_MULTICERT_IN_OURCERT" will be defined for those versions.
18044
18045 If the option contains &$tls_out_sni$& and Exim is built against OpenSSL, then
18046 if the OpenSSL build supports TLS extensions and the TLS client sends the
18047 Server Name Indication extension, then this option and others documented in
18048 &<<SECTtlssni>>& will be re-expanded.
18049
18050 If this option is unset or empty a fresh self-signed certificate will be
18051 generated for every connection.
18052
18053 .option tls_crl main string&!! unset
18054 .cindex "TLS" "server certificate revocation list"
18055 .cindex "certificate" "revocation list for server"
18056 This option specifies a certificate revocation list. The expanded value must
18057 be the name of a file that contains CRLs in PEM format.
18058
18059 Under OpenSSL the option can specify a directory with CRL files.
18060
18061 &*Note:*& Under OpenSSL the option must, if given, supply a CRL
18062 for each signing element of the certificate chain (i.e. all but the leaf).
18063 For the file variant this can be multiple PEM blocks in the one file.
18064
18065 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
18066
18067
18068 .option tls_dh_max_bits main integer 2236
18069 .cindex "TLS" "D-H bit count"
18070 The number of bits used for Diffie-Hellman key-exchange may be suggested by
18071 the chosen TLS library.  That value might prove to be too high for
18072 interoperability.  This option provides a maximum clamp on the value
18073 suggested, trading off security for interoperability.
18074
18075 The value must be at least 1024.
18076
18077 The value 2236 was chosen because, at time of adding the option, it was the
18078 hard-coded maximum value supported by the NSS cryptographic library, as used
18079 by Thunderbird, while GnuTLS was suggesting 2432 bits as normal.
18080
18081 If you prefer more security and are willing to break some clients, raise this
18082 number.
18083
18084 Note that the value passed to GnuTLS for *generating* a new prime may be a
18085 little less than this figure, because GnuTLS is inexact and may produce a
18086 larger prime than requested.
18087
18088
18089 .option tls_dhparam main string&!! unset
18090 .cindex "TLS" "D-H parameters for server"
18091 The value of this option is expanded and indicates the source of DH parameters
18092 to be used by Exim.
18093
18094 This option is ignored for GnuTLS version 3.6.0 and later.
18095 The library manages parameter negotiation internally.
18096
18097 &*Note: The Exim Maintainers strongly recommend,
18098 for other TLS library versions,
18099 using a filename with site-generated
18100 local DH parameters*&, which has been supported across all versions of Exim.  The
18101 other specific constants available are a fallback so that even when
18102 "unconfigured", Exim can offer Perfect Forward Secrecy in older ciphersuites in TLS.
18103
18104 If &%tls_dhparam%& is a filename starting with a &`/`&,
18105 then it names a file from which DH
18106 parameters should be loaded.  If the file exists, it should hold a PEM-encoded
18107 PKCS#3 representation of the DH prime.  If the file does not exist, for
18108 OpenSSL it is an error.  For GnuTLS, Exim will attempt to create the file and
18109 fill it with a generated DH prime.  For OpenSSL, if the DH bit-count from
18110 loading the file is greater than &%tls_dh_max_bits%& then it will be ignored,
18111 and treated as though the &%tls_dhparam%& were set to "none".
18112
18113 If this option expands to the string "none", then no DH parameters will be
18114 loaded by Exim.
18115
18116 If this option expands to the string "historic" and Exim is using GnuTLS, then
18117 Exim will attempt to load a file from inside the spool directory.  If the file
18118 does not exist, Exim will attempt to create it.
18119 See section &<<SECTgnutlsparam>>& for further details.
18120
18121 If Exim is using OpenSSL and this option is empty or unset, then Exim will load
18122 a default DH prime; the default is Exim-specific but lacks verifiable provenance.
18123
18124 In older versions of Exim the default was the 2048 bit prime described in section
18125 2.2 of RFC 5114, "2048-bit MODP Group with 224-bit Prime Order Subgroup", which
18126 in IKE is assigned number 23.
18127
18128 Otherwise, the option must expand to the name used by Exim for any of a number
18129 of DH primes specified in RFC 2409, RFC 3526, RFC 5114, RFC 7919, or from other
18130 sources.  As names, Exim uses a standard specified name, else "ike" followed by
18131 the number used by IKE, or "default" which corresponds to
18132 &`exim.dev.20160529.3`&.
18133
18134 The available standard primes are:
18135 &`ffdhe2048`&, &`ffdhe3072`&, &`ffdhe4096`&, &`ffdhe6144`&, &`ffdhe8192`&,
18136 &`ike1`&, &`ike2`&, &`ike5`&,
18137 &`ike14`&, &`ike15`&, &`ike16`&, &`ike17`&, &`ike18`&,
18138 &`ike22`&, &`ike23`& and &`ike24`&.
18139
18140 The available additional primes are:
18141 &`exim.dev.20160529.1`&, &`exim.dev.20160529.2`& and &`exim.dev.20160529.3`&.
18142
18143 Some of these will be too small to be accepted by clients.
18144 Some may be too large to be accepted by clients.
18145 The open cryptographic community has suspicions about the integrity of some
18146 of the later IKE values, which led into RFC7919 providing new fixed constants
18147 (the "ffdhe" identifiers).
18148
18149 At this point, all of the "ike" values should be considered obsolete;
18150 they're still in Exim to avoid breaking unusual configurations, but are
18151 candidates for removal the next time we have backwards-incompatible changes.
18152
18153 The TLS protocol does not negotiate an acceptable size for this; clients tend
18154 to hard-drop connections if what is offered by the server is unacceptable,
18155 whether too large or too small, and there's no provision for the client to
18156 tell the server what these constraints are.  Thus, as a server operator, you
18157 need to make an educated guess as to what is most likely to work for your
18158 userbase.
18159
18160 Some known size constraints suggest that a bit-size in the range 2048 to 2236
18161 is most likely to maximise interoperability.  The upper bound comes from
18162 applications using the Mozilla Network Security Services (NSS) library, which
18163 used to set its &`DH_MAX_P_BITS`& upper-bound to 2236.  This affects many
18164 mail user agents (MUAs). The lower bound comes from Debian installs of Exim4
18165 prior to the 4.80 release, as Debian used to patch Exim to raise the minimum
18166 acceptable bound from 1024 to 2048.
18167
18168
18169 .option tls_eccurve main string&!! &`auto`&
18170 .cindex TLS "EC cryptography"
18171 This option selects a EC curve for use by Exim when used with OpenSSL.
18172 It has no effect when Exim is used with GnuTLS.
18173
18174 After expansion it must contain a valid EC curve parameter, such as
18175 &`prime256v1`&, &`secp384r1`&, or &`P-512`&. Consult your OpenSSL manual
18176 for valid selections.
18177
18178 For OpenSSL versions before (and not including) 1.0.2, the string
18179 &`auto`& selects &`prime256v1`&. For more recent OpenSSL versions
18180 &`auto`& tells the library to choose.
18181
18182 If the option expands to an empty string, no EC curves will be enabled.
18183
18184
18185 .option tls_ocsp_file main string&!! unset
18186 .cindex TLS "certificate status"
18187 .cindex TLS "OCSP proof file"
18188 This option
18189 must if set expand to the absolute path to a file which contains a current
18190 status proof for the server's certificate, as obtained from the
18191 Certificate Authority.
18192
18193 Usable for GnuTLS 3.4.4 or 3.3.17 or OpenSSL 1.1.0 (or later).
18194 The macro "_HAVE_TLS_OCSP" will be defined for those versions.
18195
18196 For OpenSSL 1.1.0 or later, and
18197 for GnuTLS 3.5.6 or later the expanded value of this option can be a list
18198 of files, to match a list given for the &%tls_certificate%& option.
18199 The ordering of the two lists must match.
18200 The macro "_HAVE_TLS_OCSP_LIST" will be defined for those versions.
18201
18202 The file(s) should be in DER format,
18203 except for GnuTLS 3.6.3 or later
18204 or for OpenSSL,
18205 when an optional filetype prefix can be used.
18206 The prefix must be one of "DER" or "PEM", followed by
18207 a single space.  If one is used it sets the format for subsequent
18208 files in the list; the initial format is DER.
18209 If multiple proofs are wanted, for multiple chain elements
18210 (this only works under TLS1.3)
18211 they must be coded as a combined OCSP response.
18212
18213 Although GnuTLS will accept PEM files with multiple separate
18214 PEM blobs (ie. separate OCSP responses), it sends them in the
18215 TLS Certificate record interleaved with the certificates of the chain;
18216 although a GnuTLS client is happy with that, an OpenSSL client is not.
18217
18218 .option tls_on_connect_ports main "string list" unset
18219 .cindex SSMTP
18220 .cindex SMTPS
18221 This option specifies a list of incoming SSMTP (aka SMTPS) ports that should
18222 operate the SSMTP (SMTPS) protocol, where a TLS session is immediately
18223 set up without waiting for the client to issue a STARTTLS command. For
18224 further details, see section &<<SECTsupobssmt>>&.
18225
18226
18227
18228 .option tls_privatekey main string list&!! unset
18229 .cindex "TLS" "server private key; location of"
18230 The value of this option is expanded, and must then be a list of absolute paths to
18231 files which contains the server's private keys.
18232 If this option is unset, or if
18233 the expansion is forced to fail, or the result is an empty string, the private
18234 key is assumed to be in the same file as the server's certificates. See chapter
18235 &<<CHAPTLS>>& for further details.
18236
18237 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
18238
18239
18240 .option tls_remember_esmtp main boolean false
18241 .cindex "TLS" "esmtp state; remembering"
18242 .cindex "TLS" "broken clients"
18243 If this option is set true, Exim violates the RFCs by remembering that it is in
18244 &"esmtp"& state after successfully negotiating a TLS session. This provides
18245 support for broken clients that fail to send a new EHLO after starting a
18246 TLS session.
18247
18248
18249 .option tls_require_ciphers main string&!! unset
18250 .cindex "TLS" "requiring specific ciphers"
18251 .cindex "cipher" "requiring specific"
18252 This option controls which ciphers can be used for incoming TLS connections.
18253 The &(smtp)& transport has an option of the same name for controlling outgoing
18254 connections. This option is expanded for each connection, so can be varied for
18255 different clients if required. The value of this option must be a list of
18256 permitted cipher suites. The OpenSSL and GnuTLS libraries handle cipher control
18257 in somewhat different ways. If GnuTLS is being used, the client controls the
18258 preference order of the available ciphers. Details are given in sections
18259 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
18260
18261
18262 .option tls_try_verify_hosts main "host list&!!" unset
18263 .cindex "TLS" "client certificate verification"
18264 .cindex "certificate" "verification of client"
18265 See &%tls_verify_hosts%& below.
18266
18267
18268 .option tls_verify_certificates main string&!! system
18269 .cindex "TLS" "client certificate verification"
18270 .cindex "certificate" "verification of client"
18271 The value of this option is expanded, and must then be either the
18272 word "system"
18273 or the absolute path to
18274 a file or directory containing permitted certificates for clients that
18275 match &%tls_verify_hosts%& or &%tls_try_verify_hosts%&.
18276
18277 The "system" value for the option will use a
18278 system default location compiled into the SSL library.
18279 This is not available for GnuTLS versions preceding 3.0.20,
18280 and will be taken as empty; an explicit location
18281 must be specified.
18282
18283 The use of a directory for the option value is not available for GnuTLS versions
18284 preceding 3.3.6 and a single file must be used.
18285
18286 With OpenSSL the certificates specified
18287 explicitly
18288 either by file or directory
18289 are added to those given by the system default location.
18290
18291 These certificates should be for the certificate authorities trusted, rather
18292 than the public cert of individual clients.  With both OpenSSL and GnuTLS, if
18293 the value is a file then the certificates are sent by Exim as a server to
18294 connecting clients, defining the list of accepted certificate authorities.
18295 Thus the values defined should be considered public data.  To avoid this,
18296 use the explicit directory version.
18297
18298 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
18299
18300 A forced expansion failure or setting to an empty string is equivalent to
18301 being unset.
18302
18303
18304 .option tls_verify_hosts main "host list&!!" unset
18305 .cindex "TLS" "client certificate verification"
18306 .cindex "certificate" "verification of client"
18307 This option, along with &%tls_try_verify_hosts%&, controls the checking of
18308 certificates from clients. The expected certificates are defined by
18309 &%tls_verify_certificates%&, which must be set. A configuration error occurs if
18310 either &%tls_verify_hosts%& or &%tls_try_verify_hosts%& is set and
18311 &%tls_verify_certificates%& is not set.
18312
18313 Any client that matches &%tls_verify_hosts%& is constrained by
18314 &%tls_verify_certificates%&. When the client initiates a TLS session, it must
18315 present one of the listed certificates. If it does not, the connection is
18316 aborted. &*Warning*&: Including a host in &%tls_verify_hosts%& does not require
18317 the host to use TLS. It can still send SMTP commands through unencrypted
18318 connections. Forcing a client to use TLS has to be done separately using an
18319 ACL to reject inappropriate commands when the connection is not encrypted.
18320
18321 A weaker form of checking is provided by &%tls_try_verify_hosts%&. If a client
18322 matches this option (but not &%tls_verify_hosts%&), Exim requests a
18323 certificate and checks it against &%tls_verify_certificates%&, but does not
18324 abort the connection if there is no certificate or if it does not match. This
18325 state can be detected in an ACL, which makes it possible to implement policies
18326 such as &"accept for relay only if a verified certificate has been received,
18327 but accept for local delivery if encrypted, even without a verified
18328 certificate"&.
18329
18330 Client hosts that match neither of these lists are not asked to present
18331 certificates.
18332
18333
18334 .option trusted_groups main "string list&!!" unset
18335 .cindex "trusted groups"
18336 .cindex "groups" "trusted"
18337 This option is expanded just once, at the start of Exim's processing. If this
18338 option is set, any process that is running in one of the listed groups, or
18339 which has one of them as a supplementary group, is trusted. The groups can be
18340 specified numerically or by name. See section &<<SECTtrustedadmin>>& for
18341 details of what trusted callers are permitted to do. If neither
18342 &%trusted_groups%& nor &%trusted_users%& is set, only root and the Exim user
18343 are trusted.
18344
18345 .option trusted_users main "string list&!!" unset
18346 .cindex "trusted users"
18347 .cindex "user" "trusted"
18348 This option is expanded just once, at the start of Exim's processing. If this
18349 option is set, any process that is running as one of the listed users is
18350 trusted. The users can be specified numerically or by name. See section
18351 &<<SECTtrustedadmin>>& for details of what trusted callers are permitted to do.
18352 If neither &%trusted_groups%& nor &%trusted_users%& is set, only root and the
18353 Exim user are trusted.
18354
18355 .option unknown_login main string&!! unset
18356 .cindex "uid (user id)" "unknown caller"
18357 .vindex "&$caller_uid$&"
18358 This is a specialized feature for use in unusual configurations. By default, if
18359 the uid of the caller of Exim cannot be looked up using &[getpwuid()]&, Exim
18360 gives up. The &%unknown_login%& option can be used to set a login name to be
18361 used in this circumstance. It is expanded, so values like &%user$caller_uid%&
18362 can be set. When &%unknown_login%& is used, the value of &%unknown_username%&
18363 is used for the user's real name (gecos field), unless this has been set by the
18364 &%-F%& option.
18365
18366 .option unknown_username main string unset
18367 See &%unknown_login%&.
18368
18369 .option untrusted_set_sender main "address list&!!" unset
18370 .cindex "trusted users"
18371 .cindex "sender" "setting by untrusted user"
18372 .cindex "untrusted user setting sender"
18373 .cindex "user" "untrusted setting sender"
18374 .cindex "envelope from"
18375 .cindex "envelope sender"
18376 When an untrusted user submits a message to Exim using the standard input, Exim
18377 normally creates an envelope sender address from the user's login and the
18378 default qualification domain. Data from the &%-f%& option (for setting envelope
18379 senders on non-SMTP messages) or the SMTP MAIL command (if &%-bs%& or &%-bS%&
18380 is used) is ignored.
18381
18382 However, untrusted users are permitted to set an empty envelope sender address,
18383 to declare that a message should never generate any bounces. For example:
18384 .code
18385 exim -f '<>' user@domain.example
18386 .endd
18387 .vindex "&$sender_ident$&"
18388 The &%untrusted_set_sender%& option allows you to permit untrusted users to set
18389 other envelope sender addresses in a controlled way. When it is set, untrusted
18390 users are allowed to set envelope sender addresses that match any of the
18391 patterns in the list. Like all address lists, the string is expanded. The
18392 identity of the user is in &$sender_ident$&, so you can, for example, restrict
18393 users to setting senders that start with their login ids
18394 followed by a hyphen
18395 by a setting like this:
18396 .code
18397 untrusted_set_sender = ^$sender_ident-
18398 .endd
18399 If you want to allow untrusted users to set envelope sender addresses without
18400 restriction, you can use
18401 .code
18402 untrusted_set_sender = *
18403 .endd
18404 The &%untrusted_set_sender%& option applies to all forms of local input, but
18405 only to the setting of the envelope sender. It does not permit untrusted users
18406 to use the other options which trusted user can use to override message
18407 parameters. Furthermore, it does not stop Exim from removing an existing
18408 &'Sender:'& header in the message, or from adding a &'Sender:'& header if
18409 necessary. See &%local_sender_retain%& and &%local_from_check%& for ways of
18410 overriding these actions. The handling of the &'Sender:'& header is also
18411 described in section &<<SECTthesenhea>>&.
18412
18413 The log line for a message's arrival shows the envelope sender following
18414 &"<="&. For local messages, the user's login always follows, after &"U="&. In
18415 &%-bp%& displays, and in the Exim monitor, if an untrusted user sets an
18416 envelope sender address, the user's login is shown in parentheses after the
18417 sender address.
18418
18419
18420 .option uucp_from_pattern main string "see below"
18421 .cindex "&""From""& line"
18422 .cindex "UUCP" "&""From""& line"
18423 Some applications that pass messages to an MTA via a command line interface use
18424 an initial line starting with &"From&~"& to pass the envelope sender. In
18425 particular, this is used by UUCP software. Exim recognizes such a line by means
18426 of a regular expression that is set in &%uucp_from_pattern%&. When the pattern
18427 matches, the sender address is constructed by expanding the contents of
18428 &%uucp_from_sender%&, provided that the caller of Exim is a trusted user. The
18429 default pattern recognizes lines in the following two forms:
18430 .code
18431 From ph10 Fri Jan  5 12:35 GMT 1996
18432 From ph10 Fri, 7 Jan 97 14:00:00 GMT
18433 .endd
18434 The pattern can be seen by running
18435 .code
18436 exim -bP uucp_from_pattern
18437 .endd
18438 It checks only up to the hours and minutes, and allows for a 2-digit or 4-digit
18439 year in the second case. The first word after &"From&~"& is matched in the
18440 regular expression by a parenthesized subpattern. The default value for
18441 &%uucp_from_sender%& is &"$1"&, which therefore just uses this first word
18442 (&"ph10"& in the example above) as the message's sender. See also
18443 &%ignore_fromline_hosts%&.
18444
18445
18446 .option uucp_from_sender main string&!! &`$1`&
18447 See &%uucp_from_pattern%& above.
18448
18449
18450 .option warn_message_file main string&!! unset
18451 .cindex "warning of delay" "customizing the message"
18452 .cindex "customizing" "warning message"
18453 This option defines a template file containing paragraphs of text to be used
18454 for constructing the warning message which is sent by Exim when a message has
18455 been in the queue for a specified amount of time, as specified by
18456 &%delay_warning%&. Details of the file's contents are given in chapter
18457 &<<CHAPemsgcust>>&.
18458 .new
18459 .cindex warn_message_file "tainted data"
18460 The option is expanded to give the file path, which must be
18461 absolute and untainted.
18462 .wen
18463 See also &%bounce_message_file%&.
18464
18465
18466 .option write_rejectlog main boolean true
18467 .cindex "reject log" "disabling"
18468 If this option is set false, Exim no longer writes anything to the reject log.
18469 See chapter &<<CHAPlog>>& for details of what Exim writes to its logs.
18470 .ecindex IIDconfima
18471 .ecindex IIDmaiconf
18472
18473
18474
18475
18476 . ////////////////////////////////////////////////////////////////////////////
18477 . ////////////////////////////////////////////////////////////////////////////
18478
18479 .chapter "Generic options for routers" "CHAProutergeneric"
18480 .scindex IIDgenoprou1 "options" "generic; for routers"
18481 .scindex IIDgenoprou2 "generic options" "router"
18482 This chapter describes the generic options that apply to all routers.
18483 Those that are preconditions are marked with &Dagger; in the &"use"& field.
18484
18485 For a general description of how a router operates, see sections
18486 &<<SECTrunindrou>>& and &<<SECTrouprecon>>&. The latter specifies the order in
18487 which the preconditions are tested. The order of expansion of the options that
18488 provide data for a transport is: &%errors_to%&, &%headers_add%&,
18489 &%headers_remove%&, &%transport%&.
18490
18491
18492
18493 .option address_data routers string&!! unset
18494 .cindex "router" "data attached to address"
18495 The string is expanded just before the router is run, that is, after all the
18496 precondition tests have succeeded. If the expansion is forced to fail, the
18497 router declines, the value of &%address_data%& remains unchanged, and the
18498 &%more%& option controls what happens next. Other expansion failures cause
18499 delivery of the address to be deferred.
18500
18501 .vindex "&$address_data$&"
18502 When the expansion succeeds, the value is retained with the address, and can be
18503 accessed using the variable &$address_data$& in the current router, subsequent
18504 routers, and the eventual transport.
18505
18506 &*Warning*&: If the current or any subsequent router is a &(redirect)& router
18507 that runs a user's filter file, the contents of &$address_data$& are accessible
18508 in the filter. This is not normally a problem, because such data is usually
18509 either not confidential or it &"belongs"& to the current user, but if you do
18510 put confidential data into &$address_data$& you need to remember this point.
18511
18512 Even if the router declines or passes, the value of &$address_data$& remains
18513 with the address, though it can be changed by another &%address_data%& setting
18514 on a subsequent router. If a router generates child addresses, the value of
18515 &$address_data$& propagates to them. This also applies to the special kind of
18516 &"child"& that is generated by a router with the &%unseen%& option.
18517
18518 The idea of &%address_data%& is that you can use it to look up a lot of data
18519 for the address once, and then pick out parts of the data later. For example,
18520 you could use a single LDAP lookup to return a string of the form
18521 .code
18522 uid=1234 gid=5678 mailbox=/mail/xyz forward=/home/xyz/.forward
18523 .endd
18524 In the transport you could pick out the mailbox by a setting such as
18525 .code
18526 file = ${extract{mailbox}{$address_data}}
18527 .endd
18528 This makes the configuration file less messy, and also reduces the number of
18529 lookups (though Exim does cache lookups).
18530
18531 See also the &%set%& option below.
18532
18533 .vindex "&$sender_address_data$&"
18534 .vindex "&$address_data$&"
18535 The &%address_data%& facility is also useful as a means of passing information
18536 from one router to another, and from a router to a transport. In addition, if
18537 &$address_data$& is set by a router when verifying a recipient address from an
18538 ACL, it remains available for use in the rest of the ACL statement. After
18539 verifying a sender, the value is transferred to &$sender_address_data$&.
18540
18541
18542
18543 .option address_test routers&!? boolean true
18544 .oindex "&%-bt%&"
18545 .cindex "router" "skipping when address testing"
18546 If this option is set false, the router is skipped when routing is being tested
18547 by means of the &%-bt%& command line option. This can be a convenience when
18548 your first router sends messages to an external scanner, because it saves you
18549 having to set the &"already scanned"& indicator when testing real address
18550 routing.
18551
18552
18553
18554 .option cannot_route_message routers string&!! unset
18555 .cindex "router" "customizing &""cannot route""& message"
18556 .cindex "customizing" "&""cannot route""& message"
18557 This option specifies a text message that is used when an address cannot be
18558 routed because Exim has run out of routers. The default message is
18559 &"Unrouteable address"&. This option is useful only on routers that have
18560 &%more%& set false, or on the very last router in a configuration, because the
18561 value that is used is taken from the last router that is considered. This
18562 includes a router that is skipped because its preconditions are not met, as
18563 well as a router that declines. For example, using the default configuration,
18564 you could put:
18565 .code
18566 cannot_route_message = Remote domain not found in DNS
18567 .endd
18568 on the first router, which is a &(dnslookup)& router with &%more%& set false,
18569 and
18570 .code
18571 cannot_route_message = Unknown local user
18572 .endd
18573 on the final router that checks for local users. If string expansion fails for
18574 this option, the default message is used. Unless the expansion failure was
18575 explicitly forced, a message about the failure is written to the main and panic
18576 logs, in addition to the normal message about the routing failure.
18577
18578
18579 .option caseful_local_part routers boolean false
18580 .cindex "case of local parts"
18581 .cindex "router" "case of local parts"
18582 By default, routers handle the local parts of addresses in a case-insensitive
18583 manner, though the actual case is preserved for transmission with the message.
18584 If you want the case of letters to be significant in a router, you must set
18585 this option true. For individual router options that contain address or local
18586 part lists (for example, &%local_parts%&), case-sensitive matching can be
18587 turned on by &"+caseful"& as a list item. See section &<<SECTcasletadd>>& for
18588 more details.
18589
18590 .vindex "&$local_part$&"
18591 .vindex "&$original_local_part$&"
18592 .vindex "&$parent_local_part$&"
18593 The value of the &$local_part$& variable is forced to lower case while a
18594 router is running unless &%caseful_local_part%& is set. When a router assigns
18595 an address to a transport, the value of &$local_part$& when the transport runs
18596 is the same as it was in the router. Similarly, when a router generates child
18597 addresses by aliasing or forwarding, the values of &$original_local_part$&
18598 and &$parent_local_part$& are those that were used by the redirecting router.
18599
18600 This option applies to the processing of an address by a router. When a
18601 recipient address is being processed in an ACL, there is a separate &%control%&
18602 modifier that can be used to specify case-sensitive processing within the ACL
18603 (see section &<<SECTcontrols>>&).
18604
18605
18606
18607 .option check_local_user routers&!? boolean false
18608 .cindex "local user, checking in router"
18609 .cindex "router" "checking for local user"
18610 .cindex "&_/etc/passwd_&"
18611 .vindex "&$home$&"
18612 When this option is true, Exim checks that the local part of the recipient
18613 address (with affixes removed if relevant) is the name of an account on the
18614 local system. The check is done by calling the &[getpwnam()]& function rather
18615 than trying to read &_/etc/passwd_& directly. This means that other methods of
18616 holding password data (such as NIS) are supported. If the local part is a local
18617 user, &$home$& is set from the password data, and can be tested in other
18618 preconditions that are evaluated after this one (the order of evaluation is
18619 given in section &<<SECTrouprecon>>&). However, the value of &$home$& can be
18620 overridden by &%router_home_directory%&. If the local part is not a local user,
18621 the router is skipped.
18622
18623 If you want to check that the local part is either the name of a local user
18624 or matches something else, you cannot combine &%check_local_user%& with a
18625 setting of &%local_parts%&, because that specifies the logical &'and'& of the
18626 two conditions. However, you can use a &(passwd)& lookup in a &%local_parts%&
18627 setting to achieve this. For example:
18628 .code
18629 local_parts = passwd;$local_part : lsearch;/etc/other/users
18630 .endd
18631 Note, however, that the side effects of &%check_local_user%& (such as setting
18632 up a home directory) do not occur when a &(passwd)& lookup is used in a
18633 &%local_parts%& (or any other) precondition.
18634
18635
18636
18637 .option condition routers&!? string&!! unset
18638 .cindex "router" "customized precondition"
18639 This option specifies a general precondition test that has to succeed for the
18640 router to be called. The &%condition%& option is the last precondition to be
18641 evaluated (see section &<<SECTrouprecon>>&). The string is expanded, and if the
18642 result is a forced failure, or an empty string, or one of the strings &"0"& or
18643 &"no"& or &"false"& (checked without regard to the case of the letters), the
18644 router is skipped, and the address is offered to the next one.
18645
18646 If the result is any other value, the router is run (as this is the last
18647 precondition to be evaluated, all the other preconditions must be true).
18648
18649 This option is unusual in that multiple &%condition%& options may be present.
18650 All &%condition%& options must succeed.
18651
18652 The &%condition%& option provides a means of applying custom conditions to the
18653 running of routers. Note that in the case of a simple conditional expansion,
18654 the default expansion values are exactly what is wanted. For example:
18655 .code
18656 condition = ${if >{$message_age}{600}}
18657 .endd
18658 Because of the default behaviour of the string expansion, this is equivalent to
18659 .code
18660 condition = ${if >{$message_age}{600}{true}{}}
18661 .endd
18662
18663 A multiple condition example, which succeeds:
18664 .code
18665 condition = ${if >{$message_age}{600}}
18666 condition = ${if !eq{${lc:$local_part}}{postmaster}}
18667 condition = foobar
18668 .endd
18669
18670 If the expansion fails (other than forced failure) delivery is deferred. Some
18671 of the other precondition options are common special cases that could in fact
18672 be specified using &%condition%&.
18673
18674 Historical note: We have &%condition%& on ACLs and on Routers.  Routers
18675 are far older, and use one set of semantics.  ACLs are newer and when
18676 they were created, the ACL &%condition%& process was given far stricter
18677 parse semantics.  The &%bool{}%& expansion condition uses the same rules as
18678 ACLs.  The &%bool_lax{}%& expansion condition uses the same rules as
18679 Routers.  More pointedly, the &%bool_lax{}%& was written to match the existing
18680 Router rules processing behavior.
18681
18682 This is best illustrated in an example:
18683 .code
18684 # If used in an ACL condition will fail with a syntax error, but
18685 # in a router condition any extra characters are treated as a string
18686
18687 $ exim -be '${if eq {${lc:GOOGLE.com}} {google.com}} {yes} {no}}'
18688 true {yes} {no}}
18689
18690 $ exim -be '${if eq {${lc:WHOIS.com}} {google.com}} {yes} {no}}'
18691  {yes} {no}}
18692 .endd
18693 In each example above, the &%if%& statement actually ends after
18694 &"{google.com}}"&.  Since no true or false braces were defined, the
18695 default &%if%& behavior is to return a boolean true or a null answer
18696 (which evaluates to false). The rest of the line is then treated as a
18697 string. So the first example resulted in the boolean answer &"true"&
18698 with the string &" {yes} {no}}"& appended to it. The second example
18699 resulted in the null output (indicating false) with the string
18700 &" {yes} {no}}"& appended to it.
18701
18702 In fact you can put excess forward braces in too.  In the router
18703 &%condition%&, Exim's parser only looks for &"{"& symbols when they
18704 mean something, like after a &"$"& or when required as part of a
18705 conditional.  But otherwise &"{"& and &"}"& are treated as ordinary
18706 string characters.
18707
18708 Thus, in a Router, the above expansion strings will both always evaluate
18709 true, as the result of expansion is a non-empty string which doesn't
18710 match an explicit false value.  This can be tricky to debug.  By
18711 contrast, in an ACL either of those strings will always result in an
18712 expansion error because the result doesn't look sufficiently boolean.
18713
18714
18715 .option debug_print routers string&!! unset
18716 .cindex "testing" "variables in drivers"
18717 If this option is set and debugging is enabled (see the &%-d%& command line
18718 option) or in address-testing mode (see the &%-bt%& command line option),
18719 the string is expanded and included in the debugging output.
18720 If expansion of the string fails, the error message is written to the debugging
18721 output, and Exim carries on processing.
18722 This option is provided to help with checking out the values of variables and
18723 so on when debugging router configurations. For example, if a &%condition%&
18724 option appears not to be working, &%debug_print%& can be used to output the
18725 variables it references. The output happens after checks for &%domains%&,
18726 &%local_parts%&, and &%check_local_user%& but before any other preconditions
18727 are tested. A newline is added to the text if it does not end with one.
18728 The variable &$router_name$& contains the name of the router.
18729
18730
18731
18732 .option disable_logging routers boolean false
18733 If this option is set true, nothing is logged for any routing errors
18734 or for any deliveries caused by this router. You should not set this option
18735 unless you really, really know what you are doing. See also the generic
18736 transport option of the same name.
18737
18738 .option dnssec_request_domains routers "domain list&!!" *
18739 .cindex "MX record" "security"
18740 .cindex "DNSSEC" "MX lookup"
18741 .cindex "security" "MX lookup"
18742 .cindex "DNS" "DNSSEC"
18743 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
18744 the dnssec request bit set.
18745 This applies to all of the SRV, MX, AAAA, A lookup sequence.
18746
18747 .option dnssec_require_domains routers "domain list&!!" unset
18748 .cindex "MX record" "security"
18749 .cindex "DNSSEC" "MX lookup"
18750 .cindex "security" "MX lookup"
18751 .cindex "DNS" "DNSSEC"
18752 DNS lookups for domains matching &%dnssec_require_domains%& will be done with
18753 the dnssec request bit set.  Any returns not having the Authenticated Data bit
18754 (AD bit) set will be ignored and logged as a host-lookup failure.
18755 This applies to all of the SRV, MX, AAAA, A lookup sequence.
18756
18757
18758 .option domains routers&!? "domain list&!!" unset
18759 .cindex "router" "restricting to specific domains"
18760 .vindex "&$domain_data$&"
18761 If this option is set, the router is skipped unless the current domain matches
18762 the list. If the match is achieved by means of a file lookup, the data that the
18763 lookup returned for the domain is placed in &$domain_data$& for use in string
18764 expansions of the driver's private options. See section &<<SECTrouprecon>>& for
18765 a list of the order in which preconditions are evaluated.
18766
18767
18768
18769 .option driver routers string unset
18770 This option must always be set. It specifies which of the available routers is
18771 to be used.
18772
18773
18774 .option dsn_lasthop routers boolean false
18775 .cindex "DSN" "success"
18776 .cindex "Delivery Status Notification" "success"
18777 If this option is set true, and extended DSN (RFC3461) processing is in effect,
18778 Exim will not pass on DSN requests to downstream DSN-aware hosts but will
18779 instead send a success DSN as if the next hop does not support DSN.
18780 Not effective on redirect routers.
18781
18782
18783
18784 .option errors_to routers string&!! unset
18785 .cindex "envelope from"
18786 .cindex "envelope sender"
18787 .cindex "router" "changing address for errors"
18788 If a router successfully handles an address, it may assign the address to a
18789 transport for delivery or it may generate child addresses. In both cases, if
18790 there is a delivery problem during later processing, the resulting bounce
18791 message is sent to the address that results from expanding this string,
18792 provided that the address verifies successfully. The &%errors_to%& option is
18793 expanded before &%headers_add%&, &%headers_remove%&, and &%transport%&.
18794
18795 The &%errors_to%& setting associated with an address can be overridden if it
18796 subsequently passes through other routers that have their own &%errors_to%&
18797 settings, or if the message is delivered by a transport with a &%return_path%&
18798 setting.
18799
18800 If &%errors_to%& is unset, or the expansion is forced to fail, or the result of
18801 the expansion fails to verify, the errors address associated with the incoming
18802 address is used. At top level, this is the envelope sender. A non-forced
18803 expansion failure causes delivery to be deferred.
18804
18805 If an address for which &%errors_to%& has been set ends up being delivered over
18806 SMTP, the envelope sender for that delivery is the &%errors_to%& value, so that
18807 any bounces that are generated by other MTAs on the delivery route are also
18808 sent there. You can set &%errors_to%& to the empty string by either of these
18809 settings:
18810 .code
18811 errors_to =
18812 errors_to = ""
18813 .endd
18814 An expansion item that yields an empty string has the same effect. If you do
18815 this, a locally detected delivery error for addresses processed by this router
18816 no longer gives rise to a bounce message; the error is discarded. If the
18817 address is delivered to a remote host, the return path is set to &`<>`&, unless
18818 overridden by the &%return_path%& option on the transport.
18819
18820 .vindex "&$address_data$&"
18821 If for some reason you want to discard local errors, but use a non-empty
18822 MAIL command for remote delivery, you can preserve the original return
18823 path in &$address_data$& in the router, and reinstate it in the transport by
18824 setting &%return_path%&.
18825
18826 The most common use of &%errors_to%& is to direct mailing list bounces to the
18827 manager of the list, as described in section &<<SECTmailinglists>>&, or to
18828 implement VERP (Variable Envelope Return Paths) (see section &<<SECTverp>>&).
18829
18830
18831
18832 .option expn routers&!? boolean true
18833 .cindex "address" "testing"
18834 .cindex "testing" "addresses"
18835 .cindex "EXPN" "router skipping"
18836 .cindex "router" "skipping for EXPN"
18837 If this option is turned off, the router is skipped when testing an address
18838 as a result of processing an SMTP EXPN command. You might, for example,
18839 want to turn it off on a router for users' &_.forward_& files, while leaving it
18840 on for the system alias file.
18841 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
18842 are evaluated.
18843
18844 The use of the SMTP EXPN command is controlled by an ACL (see chapter
18845 &<<CHAPACL>>&). When Exim is running an EXPN command, it is similar to testing
18846 an address with &%-bt%&. Compare VRFY, whose counterpart is &%-bv%&.
18847
18848
18849
18850 .option fail_verify routers boolean false
18851 .cindex "router" "forcing verification failure"
18852 Setting this option has the effect of setting both &%fail_verify_sender%& and
18853 &%fail_verify_recipient%& to the same value.
18854
18855
18856
18857 .option fail_verify_recipient routers boolean false
18858 If this option is true and an address is accepted by this router when
18859 verifying a recipient, verification fails.
18860
18861
18862
18863 .option fail_verify_sender routers boolean false
18864 If this option is true and an address is accepted by this router when
18865 verifying a sender, verification fails.
18866
18867
18868
18869 .option fallback_hosts routers "string list" unset
18870 .cindex "router" "fallback hosts"
18871 .cindex "fallback" "hosts specified on router"
18872 String expansion is not applied to this option. The argument must be a
18873 colon-separated list of host names or IP addresses. The list separator can be
18874 changed (see section &<<SECTlistsepchange>>&), and a port can be specified with
18875 each name or address. In fact, the format of each item is exactly the same as
18876 defined for the list of hosts in a &(manualroute)& router (see section
18877 &<<SECTformatonehostitem>>&).
18878
18879 If a router queues an address for a remote transport, this host list is
18880 associated with the address, and used instead of the transport's fallback host
18881 list. If &%hosts_randomize%& is set on the transport, the order of the list is
18882 randomized for each use. See the &%fallback_hosts%& option of the &(smtp)&
18883 transport for further details.
18884
18885
18886 .option group routers string&!! "see below"
18887 .cindex "gid (group id)" "local delivery"
18888 .cindex "local transports" "uid and gid"
18889 .cindex "transport" "local"
18890 .cindex "router" "setting group"
18891 When a router queues an address for a transport, and the transport does not
18892 specify a group, the group given here is used when running the delivery
18893 process.
18894 The group may be specified numerically or by name. If expansion fails, the
18895 error is logged and delivery is deferred.
18896 The default is unset, unless &%check_local_user%& is set, when the default
18897 is taken from the password information. See also &%initgroups%& and &%user%&
18898 and the discussion in chapter &<<CHAPenvironment>>&.
18899
18900
18901
18902 .option headers_add routers list&!! unset
18903 .cindex "header lines" "adding"
18904 .cindex "router" "adding header lines"
18905 This option specifies a list of text headers,
18906 newline-separated (by default, changeable in the usual way &<<SECTlistsepchange>>&),
18907 that is associated with any addresses that are accepted by the router.
18908 Each item is separately expanded, at routing time.  However, this
18909 option has no effect when an address is just being verified. The way in which
18910 the text is used to add header lines at transport time is described in section
18911 &<<SECTheadersaddrem>>&. New header lines are not actually added until the
18912 message is in the process of being transported. This means that references to
18913 header lines in string expansions in the transport's configuration do not
18914 &"see"& the added header lines.
18915
18916 The &%headers_add%& option is expanded after &%errors_to%&, but before
18917 &%headers_remove%& and &%transport%&. If an item is empty, or if
18918 an item expansion is forced to fail, the item has no effect. Other expansion
18919 failures are treated as configuration errors.
18920
18921 Unlike most options, &%headers_add%& can be specified multiple times
18922 for a router; all listed headers are added.
18923
18924 &*Warning 1*&: The &%headers_add%& option cannot be used for a &(redirect)&
18925 router that has the &%one_time%& option set.
18926
18927 .cindex "duplicate addresses"
18928 .oindex "&%unseen%&"
18929 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
18930 additions are deleted when the address is passed on to subsequent routers.
18931 For a &%redirect%& router, if a generated address is the same as the incoming
18932 address, this can lead to duplicate addresses with different header
18933 modifications. Exim does not do duplicate deliveries (except, in certain
18934 circumstances, to pipes -- see section &<<SECTdupaddr>>&), but it is undefined
18935 which of the duplicates is discarded, so this ambiguous situation should be
18936 avoided. The &%repeat_use%& option of the &%redirect%& router may be of help.
18937
18938
18939
18940 .option headers_remove routers list&!! unset
18941 .cindex "header lines" "removing"
18942 .cindex "router" "removing header lines"
18943 This option specifies a list of text headers,
18944 colon-separated (by default, changeable in the usual way &<<SECTlistsepchange>>&),
18945 that is associated with any addresses that are accepted by the router.
18946 However, the option has no effect when an address is just being verified.
18947 Each list item is separately expanded, at transport time.
18948 .new
18949 If an item ends in *, it will match any header with the given prefix.
18950 .wen
18951 The way in which
18952 the text is used to remove header lines at transport time is described in
18953 section &<<SECTheadersaddrem>>&. Header lines are not actually removed until
18954 the message is in the process of being transported. This means that references
18955 to header lines in string expansions in the transport's configuration still
18956 &"see"& the original header lines.
18957
18958 The &%headers_remove%& option is handled after &%errors_to%& and
18959 &%headers_add%&, but before &%transport%&. If an item expansion is forced to fail,
18960 the item has no effect. Other expansion failures are treated as configuration
18961 errors.
18962
18963 Unlike most options, &%headers_remove%& can be specified multiple times
18964 for a router; all listed headers are removed.
18965
18966 &*Warning 1*&: The &%headers_remove%& option cannot be used for a &(redirect)&
18967 router that has the &%one_time%& option set.
18968
18969 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
18970 removal requests are deleted when the address is passed on to subsequent
18971 routers, and this can lead to problems with duplicates -- see the similar
18972 warning for &%headers_add%& above.
18973
18974 &*Warning 3*&: Because of the separate expansion of the list items,
18975 items that contain a list separator must have it doubled.
18976 To avoid this, change the list separator (&<<SECTlistsepchange>>&).
18977
18978
18979
18980 .option ignore_target_hosts routers "host list&!!" unset
18981 .cindex "IP address" "discarding"
18982 .cindex "router" "discarding IP addresses"
18983 Although this option is a host list, it should normally contain IP address
18984 entries rather than names. If any host that is looked up by the router has an
18985 IP address that matches an item in this list, Exim behaves as if that IP
18986 address did not exist. This option allows you to cope with rogue DNS entries
18987 like
18988 .code
18989 remote.domain.example.  A  127.0.0.1
18990 .endd
18991 by setting
18992 .code
18993 ignore_target_hosts = 127.0.0.1
18994 .endd
18995 on the relevant router. If all the hosts found by a &(dnslookup)& router are
18996 discarded in this way, the router declines. In a conventional configuration, an
18997 attempt to mail to such a domain would normally provoke the &"unrouteable
18998 domain"& error, and an attempt to verify an address in the domain would fail.
18999 Similarly, if &%ignore_target_hosts%& is set on an &(ipliteral)& router, the
19000 router declines if presented with one of the listed addresses.
19001
19002 You can use this option to disable the use of IPv4 or IPv6 for mail delivery by
19003 means of the first or the second of the following settings, respectively:
19004 .code
19005 ignore_target_hosts = 0.0.0.0/0
19006 ignore_target_hosts = <; 0::0/0
19007 .endd
19008 The pattern in the first line matches all IPv4 addresses, whereas the pattern
19009 in the second line matches all IPv6 addresses.
19010
19011 This option may also be useful for ignoring link-local and site-local IPv6
19012 addresses. Because, like all host lists, the value of &%ignore_target_hosts%&
19013 is expanded before use as a list, it is possible to make it dependent on the
19014 domain that is being routed.
19015
19016 .vindex "&$host_address$&"
19017 During its expansion, &$host_address$& is set to the IP address that is being
19018 checked.
19019
19020 .option initgroups routers boolean false
19021 .cindex "additional groups"
19022 .cindex "groups" "additional"
19023 .cindex "local transports" "uid and gid"
19024 .cindex "transport" "local"
19025 If the router queues an address for a transport, and this option is true, and
19026 the uid supplied by the router is not overridden by the transport, the
19027 &[initgroups()]& function is called when running the transport to ensure that
19028 any additional groups associated with the uid are set up. See also &%group%&
19029 and &%user%& and the discussion in chapter &<<CHAPenvironment>>&.
19030
19031
19032
19033 .option local_part_prefix routers&!? "string list" unset
19034 .cindex affix "router precondition"
19035 .cindex "router" "prefix for local part"
19036 .cindex "prefix" "for local part, used in router"
19037 If this option is set, the router is skipped unless the local part starts with
19038 one of the given strings, or &%local_part_prefix_optional%& is true. See
19039 section &<<SECTrouprecon>>& for a list of the order in which preconditions are
19040 evaluated.
19041
19042 The list is scanned from left to right, and the first prefix that matches is
19043 used. A limited form of wildcard is available; if the prefix begins with an
19044 asterisk, it matches the longest possible sequence of arbitrary characters at
19045 the start of the local part. An asterisk should therefore always be followed by
19046 some character that does not occur in normal local parts.
19047 .cindex "multiple mailboxes"
19048 .cindex "mailbox" "multiple"
19049 Wildcarding can be used to set up multiple user mailboxes, as described in
19050 section &<<SECTmulbox>>&.
19051
19052 .vindex "&$local_part$&"
19053 .vindex "&$local_part_prefix$&"
19054 During the testing of the &%local_parts%& option, and while the router is
19055 running, the prefix is removed from the local part, and is available in the
19056 expansion variable &$local_part_prefix$&. When a message is being delivered, if
19057 the router accepts the address, this remains true during subsequent delivery by
19058 a transport. In particular, the local part that is transmitted in the RCPT
19059 command for LMTP, SMTP, and BSMTP deliveries has the prefix removed by default.
19060 This behaviour can be overridden by setting &%rcpt_include_affixes%& true on
19061 the relevant transport.
19062
19063 .new
19064 .vindex &$local_part_prefix_v$&
19065 If wildcarding (above) was used then the part of the prefix matching the
19066 wildcard is available in &$local_part_prefix_v$&.
19067 .wen
19068
19069 When an address is being verified, &%local_part_prefix%& affects only the
19070 behaviour of the router. If the callout feature of verification is in use, this
19071 means that the full address, including the prefix, will be used during the
19072 callout.
19073
19074 The prefix facility is commonly used to handle local parts of the form
19075 &%owner-something%&. Another common use is to support local parts of the form
19076 &%real-username%& to bypass a user's &_.forward_& file &-- helpful when trying
19077 to tell a user their forwarding is broken &-- by placing a router like this one
19078 immediately before the router that handles &_.forward_& files:
19079 .code
19080 real_localuser:
19081   driver = accept
19082   local_part_prefix = real-
19083   check_local_user
19084   transport = local_delivery
19085 .endd
19086 For security, it would probably be a good idea to restrict the use of this
19087 router to locally-generated messages, using a condition such as this:
19088 .code
19089   condition = ${if match {$sender_host_address}\
19090                          {\N^(|127\.0\.0\.1)$\N}}
19091 .endd
19092
19093 If both &%local_part_prefix%& and &%local_part_suffix%& are set for a router,
19094 both conditions must be met if not optional. Care must be taken if wildcards
19095 are used in both a prefix and a suffix on the same router. Different
19096 separator characters must be used to avoid ambiguity.
19097
19098
19099 .option local_part_prefix_optional routers boolean false
19100 See &%local_part_prefix%& above.
19101
19102
19103
19104 .option local_part_suffix routers&!? "string list" unset
19105 .cindex "router" "suffix for local part"
19106 .cindex "suffix for local part" "used in router"
19107 This option operates in the same way as &%local_part_prefix%&, except that the
19108 local part must end (rather than start) with the given string, the
19109 &%local_part_suffix_optional%& option determines whether the suffix is
19110 mandatory, and the wildcard * character, if present, must be the last
19111 character of the suffix. This option facility is commonly used to handle local
19112 parts of the form &%something-request%& and multiple user mailboxes of the form
19113 &%username-foo%&.
19114
19115
19116 .option local_part_suffix_optional routers boolean false
19117 See &%local_part_suffix%& above.
19118
19119
19120
19121 .option local_parts routers&!? "local part list&!!" unset
19122 .cindex "router" "restricting to specific local parts"
19123 .cindex "local part" "checking in router"
19124 The router is run only if the local part of the address matches the list.
19125 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
19126 are evaluated, and
19127 section &<<SECTlocparlis>>& for a discussion of local part lists. Because the
19128 string is expanded, it is possible to make it depend on the domain, for
19129 example:
19130 .code
19131 local_parts = dbm;/usr/local/specials/$domain
19132 .endd
19133 .vindex "&$local_part_data$&"
19134 If the match is achieved by a lookup, the data that the lookup returned
19135 for the local part is placed in the variable &$local_part_data$& for use in
19136 expansions of the router's private options. You might use this option, for
19137 example, if you have a large number of local virtual domains, and you want to
19138 send all postmaster mail to the same place without having to set up an alias in
19139 each virtual domain:
19140 .code
19141 postmaster:
19142   driver = redirect
19143   local_parts = postmaster
19144   data = postmaster@real.domain.example
19145 .endd
19146
19147
19148 .option log_as_local routers boolean "see below"
19149 .cindex "log" "delivery line"
19150 .cindex "delivery" "log line format"
19151 Exim has two logging styles for delivery, the idea being to make local
19152 deliveries stand out more visibly from remote ones. In the &"local"& style, the
19153 recipient address is given just as the local part, without a domain. The use of
19154 this style is controlled by this option. It defaults to true for the &(accept)&
19155 router, and false for all the others. This option applies only when a
19156 router assigns an address to a transport. It has no effect on routers that
19157 redirect addresses.
19158
19159
19160
19161 .option more routers boolean&!! true
19162 The result of string expansion for this option must be a valid boolean value,
19163 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
19164 result causes an error, and delivery is deferred. If the expansion is forced to
19165 fail, the default value for the option (true) is used. Other failures cause
19166 delivery to be deferred.
19167
19168 If this option is set false, and the router declines to handle the address, no
19169 further routers are tried, routing fails, and the address is bounced.
19170 .oindex "&%self%&"
19171 However, if the router explicitly passes an address to the following router by
19172 means of the setting
19173 .code
19174 self = pass
19175 .endd
19176 or otherwise, the setting of &%more%& is ignored. Also, the setting of &%more%&
19177 does not affect the behaviour if one of the precondition tests fails. In that
19178 case, the address is always passed to the next router.
19179
19180 Note that &%address_data%& is not considered to be a precondition. If its
19181 expansion is forced to fail, the router declines, and the value of &%more%&
19182 controls what happens next.
19183
19184
19185 .option pass_on_timeout routers boolean false
19186 .cindex "timeout" "of router"
19187 .cindex "router" "timeout"
19188 If a router times out during a host lookup, it normally causes deferral of the
19189 address. If &%pass_on_timeout%& is set, the address is passed on to the next
19190 router, overriding &%no_more%&. This may be helpful for systems that are
19191 intermittently connected to the Internet, or those that want to pass to a smart
19192 host any messages that cannot immediately be delivered.
19193
19194 There are occasional other temporary errors that can occur while doing DNS
19195 lookups. They are treated in the same way as a timeout, and this option
19196 applies to all of them.
19197
19198
19199
19200 .option pass_router routers string unset
19201 .cindex "router" "go to after &""pass""&"
19202 Routers that recognize the generic &%self%& option (&(dnslookup)&,
19203 &(ipliteral)&, and &(manualroute)&) are able to return &"pass"&, forcing
19204 routing to continue, and overriding a false setting of &%more%&. When one of
19205 these routers returns &"pass"&, the address is normally handed on to the next
19206 router in sequence. This can be changed by setting &%pass_router%& to the name
19207 of another router. However (unlike &%redirect_router%&) the named router must
19208 be below the current router, to avoid loops. Note that this option applies only
19209 to the special case of &"pass"&. It does not apply when a router returns
19210 &"decline"& because it cannot handle an address.
19211
19212
19213
19214 .option redirect_router routers string unset
19215 .cindex "router" "start at after redirection"
19216 Sometimes an administrator knows that it is pointless to reprocess addresses
19217 generated from alias or forward files with the same router again. For
19218 example, if an alias file translates real names into login ids there is no
19219 point searching the alias file a second time, especially if it is a large file.
19220
19221 The &%redirect_router%& option can be set to the name of any router instance.
19222 It causes the routing of any generated addresses to start at the named router
19223 instead of at the first router. This option has no effect if the router in
19224 which it is set does not generate new addresses.
19225
19226
19227
19228 .option require_files routers&!? "string list&!!" unset
19229 .cindex "file" "requiring for router"
19230 .cindex "router" "requiring file existence"
19231 This option provides a general mechanism for predicating the running of a
19232 router on the existence or non-existence of certain files or directories.
19233 Before running a router, as one of its precondition tests, Exim works its way
19234 through the &%require_files%& list, expanding each item separately.
19235
19236 Because the list is split before expansion, any colons in expansion items must
19237 be doubled, or the facility for using a different list separator must be used
19238 (&<<SECTlistsepchange>>&).
19239 If any expansion is forced to fail, the item is ignored. Other expansion
19240 failures cause routing of the address to be deferred.
19241
19242 If any expanded string is empty, it is ignored. Otherwise, except as described
19243 below, each string must be a fully qualified file path, optionally preceded by
19244 &"!"&. The paths are passed to the &[stat()]& function to test for the
19245 existence of the files or directories. The router is skipped if any paths not
19246 preceded by &"!"& do not exist, or if any paths preceded by &"!"& do exist.
19247
19248 .cindex "NFS"
19249 If &[stat()]& cannot determine whether a file exists or not, delivery of
19250 the message is deferred. This can happen when NFS-mounted filesystems are
19251 unavailable.
19252
19253 This option is checked after the &%domains%&, &%local_parts%&, and &%senders%&
19254 options, so you cannot use it to check for the existence of a file in which to
19255 look up a domain, local part, or sender. (See section &<<SECTrouprecon>>& for a
19256 full list of the order in which preconditions are evaluated.) However, as
19257 these options are all expanded, you can use the &%exists%& expansion condition
19258 to make such tests. The &%require_files%& option is intended for checking files
19259 that the router may be going to use internally, or which are needed by a
19260 transport (e.g., &_.procmailrc_&).
19261
19262 During delivery, the &[stat()]& function is run as root, but there is a
19263 facility for some checking of the accessibility of a file by another user.
19264 This is not a proper permissions check, but just a &"rough"& check that
19265 operates as follows:
19266
19267 If an item in a &%require_files%& list does not contain any forward slash
19268 characters, it is taken to be the user (and optional group, separated by a
19269 comma) to be checked for subsequent files in the list. If no group is specified
19270 but the user is specified symbolically, the gid associated with the uid is
19271 used. For example:
19272 .code
19273 require_files = mail:/some/file
19274 require_files = $local_part_data:$home/.procmailrc
19275 .endd
19276 If a user or group name in a &%require_files%& list does not exist, the
19277 &%require_files%& condition fails.
19278
19279 Exim performs the check by scanning along the components of the file path, and
19280 checking the access for the given uid and gid. It checks for &"x"& access on
19281 directories, and &"r"& access on the final file. Note that this means that file
19282 access control lists, if the operating system has them, are ignored.
19283
19284 &*Warning 1*&: When the router is being run to verify addresses for an
19285 incoming SMTP message, Exim is not running as root, but under its own uid. This
19286 may affect the result of a &%require_files%& check. In particular, &[stat()]&
19287 may yield the error EACCES (&"Permission denied"&). This means that the Exim
19288 user is not permitted to read one of the directories on the file's path.
19289
19290 &*Warning 2*&: Even when Exim is running as root while delivering a message,
19291 &[stat()]& can yield EACCES for a file in an NFS directory that is mounted
19292 without root access. In this case, if a check for access by a particular user
19293 is requested, Exim creates a subprocess that runs as that user, and tries the
19294 check again in that process.
19295
19296 The default action for handling an unresolved EACCES is to consider it to
19297 be caused by a configuration error, and routing is deferred because the
19298 existence or non-existence of the file cannot be determined. However, in some
19299 circumstances it may be desirable to treat this condition as if the file did
19300 not exist. If the filename (or the exclamation mark that precedes the filename
19301 for non-existence) is preceded by a plus sign, the EACCES error is treated
19302 as if the file did not exist. For example:
19303 .code
19304 require_files = +/some/file
19305 .endd
19306 If the router is not an essential part of verification (for example, it
19307 handles users' &_.forward_& files), another solution is to set the &%verify%&
19308 option false so that the router is skipped when verifying.
19309
19310
19311
19312 .option retry_use_local_part routers boolean "see below"
19313 .cindex "hints database" "retry keys"
19314 .cindex "local part" "in retry keys"
19315 When a delivery suffers a temporary routing failure, a retry record is created
19316 in Exim's hints database. For addresses whose routing depends only on the
19317 domain, the key for the retry record should not involve the local part, but for
19318 other addresses, both the domain and the local part should be included.
19319 Usually, remote routing is of the former kind, and local routing is of the
19320 latter kind.
19321
19322 This option controls whether the local part is used to form the key for retry
19323 hints for addresses that suffer temporary errors while being handled by this
19324 router. The default value is true for any router that has any of
19325 &%check_local_user%&,
19326 &%local_parts%&,
19327 &%condition%&,
19328 &%local_part_prefix%&,
19329 &%local_part_suffix%&,
19330 &%senders%& or
19331 &%require_files%&
19332 set, and false otherwise. Note that this option does not apply to hints keys
19333 for transport delays; they are controlled by a generic transport option of the
19334 same name.
19335
19336 Failing to set this option when it is needed
19337 (because a remote router handles only some of the local-parts for a domain)
19338 can result in incorrect error messages being generated.
19339
19340 The setting of &%retry_use_local_part%& applies only to the router on which it
19341 appears. If the router generates child addresses, they are routed
19342 independently; this setting does not become attached to them.
19343
19344
19345
19346 .option router_home_directory routers string&!! unset
19347 .cindex "router" "home directory for"
19348 .cindex "home directory" "for router"
19349 .vindex "&$home$&"
19350 This option sets a home directory for use while the router is running. (Compare
19351 &%transport_home_directory%&, which sets a home directory for later
19352 transporting.) In particular, if used on a &(redirect)& router, this option
19353 sets a value for &$home$& while a filter is running. The value is expanded;
19354 forced expansion failure causes the option to be ignored &-- other failures
19355 cause the router to defer.
19356
19357 Expansion of &%router_home_directory%& happens immediately after the
19358 &%check_local_user%& test (if configured), before any further expansions take
19359 place.
19360 (See section &<<SECTrouprecon>>& for a list of the order in which preconditions
19361 are evaluated.)
19362 While the router is running, &%router_home_directory%& overrides the value of
19363 &$home$& that came from &%check_local_user%&.
19364
19365 When a router accepts an address and assigns it to a local transport (including
19366 the cases when a &(redirect)& router generates a pipe, file, or autoreply
19367 delivery), the home directory setting for the transport is taken from the first
19368 of these values that is set:
19369
19370 .ilist
19371 The &%home_directory%& option on the transport;
19372 .next
19373 The &%transport_home_directory%& option on the router;
19374 .next
19375 The password data if &%check_local_user%& is set on the router;
19376 .next
19377 The &%router_home_directory%& option on the router.
19378 .endlist
19379
19380 In other words, &%router_home_directory%& overrides the password data for the
19381 router, but not for the transport.
19382
19383
19384
19385 .option self routers string freeze
19386 .cindex "MX record" "pointing to local host"
19387 .cindex "local host" "MX pointing to"
19388 This option applies to those routers that use a recipient address to find a
19389 list of remote hosts. Currently, these are the &(dnslookup)&, &(ipliteral)&,
19390 and &(manualroute)& routers.
19391 Certain configurations of the &(queryprogram)& router can also specify a list
19392 of remote hosts.
19393 Usually such routers are configured to send the message to a remote host via an
19394 &(smtp)& transport. The &%self%& option specifies what happens when the first
19395 host on the list turns out to be the local host.
19396 The way in which Exim checks for the local host is described in section
19397 &<<SECTreclocipadd>>&.
19398
19399 Normally this situation indicates either an error in Exim's configuration (for
19400 example, the router should be configured not to process this domain), or an
19401 error in the DNS (for example, the MX should not point to this host). For this
19402 reason, the default action is to log the incident, defer the address, and
19403 freeze the message. The following alternatives are provided for use in special
19404 cases:
19405
19406 .vlist
19407 .vitem &%defer%&
19408 Delivery of the message is tried again later, but the message is not frozen.
19409
19410 .vitem "&%reroute%&: <&'domain'&>"
19411 The domain is changed to the given domain, and the address is passed back to
19412 be reprocessed by the routers. No rewriting of headers takes place. This
19413 behaviour is essentially a redirection.
19414
19415 .vitem "&%reroute: rewrite:%& <&'domain'&>"
19416 The domain is changed to the given domain, and the address is passed back to be
19417 reprocessed by the routers. Any headers that contain the original domain are
19418 rewritten.
19419
19420 .vitem &%pass%&
19421 .oindex "&%more%&"
19422 .vindex "&$self_hostname$&"
19423 The router passes the address to the next router, or to the router named in the
19424 &%pass_router%& option if it is set. This overrides &%no_more%&. During
19425 subsequent routing and delivery, the variable &$self_hostname$& contains the
19426 name of the local host that the router encountered. This can be used to
19427 distinguish between different cases for hosts with multiple names. The
19428 combination
19429 .code
19430 self = pass
19431 no_more
19432 .endd
19433 ensures that only those addresses that routed to the local host are passed on.
19434 Without &%no_more%&, addresses that were declined for other reasons would also
19435 be passed to the next router.
19436
19437 .vitem &%fail%&
19438 Delivery fails and an error report is generated.
19439
19440 .vitem &%send%&
19441 .cindex "local host" "sending to"
19442 The anomaly is ignored and the address is queued for the transport. This
19443 setting should be used with extreme caution. For an &(smtp)& transport, it
19444 makes sense only in cases where the program that is listening on the SMTP port
19445 is not this version of Exim. That is, it must be some other MTA, or Exim with a
19446 different configuration file that handles the domain in another way.
19447 .endlist
19448
19449
19450
19451 .option senders routers&!? "address list&!!" unset
19452 .cindex "router" "checking senders"
19453 If this option is set, the router is skipped unless the message's sender
19454 address matches something on the list.
19455 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
19456 are evaluated.
19457
19458 There are issues concerning verification when the running of routers is
19459 dependent on the sender. When Exim is verifying the address in an &%errors_to%&
19460 setting, it sets the sender to the null string. When using the &%-bt%& option
19461 to check a configuration file, it is necessary also to use the &%-f%& option to
19462 set an appropriate sender. For incoming mail, the sender is unset when
19463 verifying the sender, but is available when verifying any recipients. If the
19464 SMTP VRFY command is enabled, it must be used after MAIL if the sender address
19465 matters.
19466
19467
19468 .option set routers "string list" unset
19469 .cindex router variables
19470 This option may be used multiple times on a router;
19471 because of this the list aspect is mostly irrelevant.
19472 The list separator is a semicolon but can be changed in the
19473 usual way.
19474
19475 Each list-element given must be of the form &"name = value"&
19476 and the names used must start with the string &"r_"&.
19477 Values containing a list-separator should have them doubled.
19478 When a router runs, the strings are evaluated in order,
19479 to create variables which are added to the set associated with
19480 the address.
19481 The variable is set with the expansion of the value.
19482 The variables can be used by the router options
19483 (not including any preconditions)
19484 and by the transport.
19485 Later definitions of a given named variable will override former ones.
19486 Variable use is via the usual &$r_...$& syntax.
19487
19488 This is similar to the &%address_data%& option, except that
19489 many independent variables can be used, with choice of naming.
19490
19491
19492 .option translate_ip_address routers string&!! unset
19493 .cindex "IP address" "translating"
19494 .cindex "packet radio"
19495 .cindex "router" "IP address translation"
19496 There exist some rare networking situations (for example, packet radio) where
19497 it is helpful to be able to translate IP addresses generated by normal routing
19498 mechanisms into other IP addresses, thus performing a kind of manual IP
19499 routing. This should be done only if the normal IP routing of the TCP/IP stack
19500 is inadequate or broken. Because this is an extremely uncommon requirement, the
19501 code to support this option is not included in the Exim binary unless
19502 SUPPORT_TRANSLATE_IP_ADDRESS=yes is set in &_Local/Makefile_&.
19503
19504 .vindex "&$host_address$&"
19505 The &%translate_ip_address%& string is expanded for every IP address generated
19506 by the router, with the generated address set in &$host_address$&. If the
19507 expansion is forced to fail, no action is taken.
19508 For any other expansion error, delivery of the message is deferred.
19509 If the result of the expansion is an IP address, that replaces the original
19510 address; otherwise the result is assumed to be a host name &-- this is looked
19511 up using &[gethostbyname()]& (or &[getipnodebyname()]& when available) to
19512 produce one or more replacement IP addresses. For example, to subvert all IP
19513 addresses in some specific networks, this could be added to a router:
19514 .code
19515 translate_ip_address = \
19516   ${lookup{${mask:$host_address/26}}lsearch{/some/file}\
19517     {$value}fail}}
19518 .endd
19519 The file would contain lines like
19520 .code
19521 10.2.3.128/26    some.host
19522 10.8.4.34/26     10.44.8.15
19523 .endd
19524 You should not make use of this facility unless you really understand what you
19525 are doing.
19526
19527
19528
19529 .option transport routers string&!! unset
19530 This option specifies the transport to be used when a router accepts an address
19531 and sets it up for delivery. A transport is never needed if a router is used
19532 only for verification. The value of the option is expanded at routing time,
19533 after the expansion of &%errors_to%&, &%headers_add%&, and &%headers_remove%&,
19534 and result must be the name of one of the configured transports. If it is not,
19535 delivery is deferred.
19536
19537 The &%transport%& option is not used by the &(redirect)& router, but it does
19538 have some private options that set up transports for pipe and file deliveries
19539 (see chapter &<<CHAPredirect>>&).
19540
19541
19542
19543 .option transport_current_directory routers string&!! unset
19544 .cindex "current directory for local transport"
19545 This option associates a current directory with any address that is routed
19546 to a local transport. This can happen either because a transport is
19547 explicitly configured for the router, or because it generates a delivery to a
19548 file or a pipe. During the delivery process (that is, at transport time), this
19549 option string is expanded and is set as the current directory, unless
19550 overridden by a setting on the transport.
19551 If the expansion fails for any reason, including forced failure, an error is
19552 logged, and delivery is deferred.
19553 See chapter &<<CHAPenvironment>>& for details of the local delivery
19554 environment.
19555
19556
19557
19558
19559 .option transport_home_directory routers string&!! "see below"
19560 .cindex "home directory" "for local transport"
19561 This option associates a home directory with any address that is routed to a
19562 local transport. This can happen either because a transport is explicitly
19563 configured for the router, or because it generates a delivery to a file or a
19564 pipe. During the delivery process (that is, at transport time), the option
19565 string is expanded and is set as the home directory, unless overridden by a
19566 setting of &%home_directory%& on the transport.
19567 If the expansion fails for any reason, including forced failure, an error is
19568 logged, and delivery is deferred.
19569
19570 If the transport does not specify a home directory, and
19571 &%transport_home_directory%& is not set for the router, the home directory for
19572 the transport is taken from the password data if &%check_local_user%& is set for
19573 the router. Otherwise it is taken from &%router_home_directory%& if that option
19574 is set; if not, no home directory is set for the transport.
19575
19576 See chapter &<<CHAPenvironment>>& for further details of the local delivery
19577 environment.
19578
19579
19580
19581
19582 .option unseen routers boolean&!! false
19583 .cindex "router" "carrying on after success"
19584 The result of string expansion for this option must be a valid boolean value,
19585 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
19586 result causes an error, and delivery is deferred. If the expansion is forced to
19587 fail, the default value for the option (false) is used. Other failures cause
19588 delivery to be deferred.
19589
19590 When this option is set true, routing does not cease if the router accepts the
19591 address. Instead, a copy of the incoming address is passed to the next router,
19592 overriding a false setting of &%more%&. There is little point in setting
19593 &%more%& false if &%unseen%& is always true, but it may be useful in cases when
19594 the value of &%unseen%& contains expansion items (and therefore, presumably, is
19595 sometimes true and sometimes false).
19596
19597 .cindex "copy of message (&%unseen%& option)"
19598 Setting the &%unseen%& option has a similar effect to the &%unseen%& command
19599 qualifier in filter files. It can be used to cause copies of messages to be
19600 delivered to some other destination, while also carrying out a normal delivery.
19601 In effect, the current address is made into a &"parent"& that has two children
19602 &-- one that is delivered as specified by this router, and a clone that goes on
19603 to be routed further. For this reason, &%unseen%& may not be combined with the
19604 &%one_time%& option in a &(redirect)& router.
19605
19606 &*Warning*&: Header lines added to the address (or specified for removal) by
19607 this router or by previous routers affect the &"unseen"& copy of the message
19608 only. The clone that continues to be processed by further routers starts with
19609 no added headers and none specified for removal. For a &%redirect%& router, if
19610 a generated address is the same as the incoming address, this can lead to
19611 duplicate addresses with different header modifications. Exim does not do
19612 duplicate deliveries (except, in certain circumstances, to pipes -- see section
19613 &<<SECTdupaddr>>&), but it is undefined which of the duplicates is discarded,
19614 so this ambiguous situation should be avoided. The &%repeat_use%& option of the
19615 &%redirect%& router may be of help.
19616
19617 Unlike the handling of header modifications, any data that was set by the
19618 &%address_data%& option in the current or previous routers &'is'& passed on to
19619 subsequent routers.
19620
19621
19622 .option user routers string&!! "see below"
19623 .cindex "uid (user id)" "local delivery"
19624 .cindex "local transports" "uid and gid"
19625 .cindex "transport" "local"
19626 .cindex "router" "user for filter processing"
19627 .cindex "filter" "user for processing"
19628 When a router queues an address for a transport, and the transport does not
19629 specify a user, the user given here is used when running the delivery process.
19630 The user may be specified numerically or by name. If expansion fails, the
19631 error is logged and delivery is deferred.
19632 This user is also used by the &(redirect)& router when running a filter file.
19633 The default is unset, except when &%check_local_user%& is set. In this case,
19634 the default is taken from the password information. If the user is specified as
19635 a name, and &%group%& is not set, the group associated with the user is used.
19636 See also &%initgroups%& and &%group%& and the discussion in chapter
19637 &<<CHAPenvironment>>&.
19638
19639
19640
19641 .option verify routers&!? boolean true
19642 Setting this option has the effect of setting &%verify_sender%& and
19643 &%verify_recipient%& to the same value.
19644
19645
19646 .option verify_only routers&!? boolean false
19647 .cindex "EXPN" "with &%verify_only%&"
19648 .oindex "&%-bv%&"
19649 .cindex "router" "used only when verifying"
19650 If this option is set, the router is used only when verifying an address,
19651 delivering in cutthrough mode or
19652 testing with the &%-bv%& option, not when actually doing a delivery, testing
19653 with the &%-bt%& option, or running the SMTP EXPN command. It can be further
19654 restricted to verifying only senders or recipients by means of
19655 &%verify_sender%& and &%verify_recipient%&.
19656
19657 &*Warning*&: When the router is being run to verify addresses for an incoming
19658 SMTP message, Exim is not running as root, but under its own uid. If the router
19659 accesses any files, you need to make sure that they are accessible to the Exim
19660 user or group.
19661
19662
19663 .option verify_recipient routers&!? boolean true
19664 If this option is false, the router is skipped when verifying recipient
19665 addresses,
19666 delivering in cutthrough mode
19667 or testing recipient verification using &%-bv%&.
19668 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
19669 are evaluated.
19670 See also the &$verify_mode$& variable.
19671
19672
19673 .option verify_sender routers&!? boolean true
19674 If this option is false, the router is skipped when verifying sender addresses
19675 or testing sender verification using &%-bvs%&.
19676 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
19677 are evaluated.
19678 See also the &$verify_mode$& variable.
19679 .ecindex IIDgenoprou1
19680 .ecindex IIDgenoprou2
19681
19682
19683
19684
19685
19686
19687 . ////////////////////////////////////////////////////////////////////////////
19688 . ////////////////////////////////////////////////////////////////////////////
19689
19690 .chapter "The accept router" "CHID4"
19691 .cindex "&(accept)& router"
19692 .cindex "routers" "&(accept)&"
19693 The &(accept)& router has no private options of its own. Unless it is being
19694 used purely for verification (see &%verify_only%&) a transport is required to
19695 be defined by the generic &%transport%& option. If the preconditions that are
19696 specified by generic options are met, the router accepts the address and queues
19697 it for the given transport. The most common use of this router is for setting
19698 up deliveries to local mailboxes. For example:
19699 .code
19700 localusers:
19701   driver = accept
19702   domains = mydomain.example
19703   check_local_user
19704   transport = local_delivery
19705 .endd
19706 The &%domains%& condition in this example checks the domain of the address, and
19707 &%check_local_user%& checks that the local part is the login of a local user.
19708 When both preconditions are met, the &(accept)& router runs, and queues the
19709 address for the &(local_delivery)& transport.
19710
19711
19712
19713
19714
19715
19716 . ////////////////////////////////////////////////////////////////////////////
19717 . ////////////////////////////////////////////////////////////////////////////
19718
19719 .chapter "The dnslookup router" "CHAPdnslookup"
19720 .scindex IIDdnsrou1 "&(dnslookup)& router"
19721 .scindex IIDdnsrou2 "routers" "&(dnslookup)&"
19722 The &(dnslookup)& router looks up the hosts that handle mail for the
19723 recipient's domain in the DNS. A transport must always be set for this router,
19724 unless &%verify_only%& is set.
19725
19726 If SRV support is configured (see &%check_srv%& below), Exim first searches for
19727 SRV records. If none are found, or if SRV support is not configured,
19728 MX records are looked up. If no MX records exist, address records are sought.
19729 However, &%mx_domains%& can be set to disable the direct use of address
19730 records.
19731
19732 MX records of equal priority are sorted by Exim into a random order. Exim then
19733 looks for address records for the host names obtained from MX or SRV records.
19734 When a host has more than one IP address, they are sorted into a random order,
19735 except that IPv6 addresses are sorted before IPv4 addresses. If all the
19736 IP addresses found are discarded by a setting of the &%ignore_target_hosts%&
19737 generic option, the router declines.
19738
19739 Unless they have the highest priority (lowest MX value), MX records that point
19740 to the local host, or to any host name that matches &%hosts_treat_as_local%&,
19741 are discarded, together with any other MX records of equal or lower priority.
19742
19743 .cindex "MX record" "pointing to local host"
19744 .cindex "local host" "MX pointing to"
19745 .oindex "&%self%&" "in &(dnslookup)& router"
19746 If the host pointed to by the highest priority MX record, or looked up as an
19747 address record, is the local host, or matches &%hosts_treat_as_local%&, what
19748 happens is controlled by the generic &%self%& option.
19749
19750
19751 .section "Problems with DNS lookups" "SECTprowitdnsloo"
19752 There have been problems with DNS servers when SRV records are looked up.
19753 Some misbehaving servers return a DNS error or timeout when a non-existent
19754 SRV record is sought. Similar problems have in the past been reported for
19755 MX records. The global &%dns_again_means_nonexist%& option can help with this
19756 problem, but it is heavy-handed because it is a global option.
19757
19758 For this reason, there are two options, &%srv_fail_domains%& and
19759 &%mx_fail_domains%&, that control what happens when a DNS lookup in a
19760 &(dnslookup)& router results in a DNS failure or a &"try again"& response. If
19761 an attempt to look up an SRV or MX record causes one of these results, and the
19762 domain matches the relevant list, Exim behaves as if the DNS had responded &"no
19763 such record"&. In the case of an SRV lookup, this means that the router
19764 proceeds to look for MX records; in the case of an MX lookup, it proceeds to
19765 look for A or AAAA records, unless the domain matches &%mx_domains%&, in which
19766 case routing fails.
19767
19768
19769 .section "Declining addresses by dnslookup" "SECTdnslookupdecline"
19770 .cindex "&(dnslookup)& router" "declines"
19771 There are a few cases where a &(dnslookup)& router will decline to accept
19772 an address; if such a router is expected to handle "all remaining non-local
19773 domains", then it is important to set &%no_more%&.
19774
19775 The router will defer rather than decline if the domain
19776 is found in the &%fail_defer_domains%& router option.
19777
19778 Reasons for a &(dnslookup)& router to decline currently include:
19779 .ilist
19780 The domain does not exist in DNS
19781 .next
19782 The domain exists but the MX record's host part is just "."; this is a common
19783 convention (borrowed from SRV) used to indicate that there is no such service
19784 for this domain and to not fall back to trying A/AAAA records.
19785 .next
19786 Ditto, but for SRV records, when &%check_srv%& is set on this router.
19787 .next
19788 MX record points to a non-existent host.
19789 .next
19790 MX record points to an IP address and the main section option
19791 &%allow_mx_to_ip%& is not set.
19792 .next
19793 MX records exist and point to valid hosts, but all hosts resolve only to
19794 addresses blocked by the &%ignore_target_hosts%& generic option on this router.
19795 .next
19796 The domain is not syntactically valid (see also &%allow_utf8_domains%& and
19797 &%dns_check_names_pattern%& for handling one variant of this)
19798 .next
19799 &%check_secondary_mx%& is set on this router but the local host can
19800 not be found in the MX records (see below)
19801 .endlist
19802
19803
19804
19805
19806 .section "Private options for dnslookup" "SECID118"
19807 .cindex "options" "&(dnslookup)& router"
19808 The private options for the &(dnslookup)& router are as follows:
19809
19810 .option check_secondary_mx dnslookup boolean false
19811 .cindex "MX record" "checking for secondary"
19812 If this option is set, the router declines unless the local host is found in
19813 (and removed from) the list of hosts obtained by MX lookup. This can be used to
19814 process domains for which the local host is a secondary mail exchanger
19815 differently to other domains. The way in which Exim decides whether a host is
19816 the local host is described in section &<<SECTreclocipadd>>&.
19817
19818
19819 .option check_srv dnslookup string&!! unset
19820 .cindex "SRV record" "enabling use of"
19821 The &(dnslookup)& router supports the use of SRV records (see RFC 2782) in
19822 addition to MX and address records. The support is disabled by default. To
19823 enable SRV support, set the &%check_srv%& option to the name of the service
19824 required. For example,
19825 .code
19826 check_srv = smtp
19827 .endd
19828 looks for SRV records that refer to the normal smtp service. The option is
19829 expanded, so the service name can vary from message to message or address
19830 to address. This might be helpful if SRV records are being used for a
19831 submission service. If the expansion is forced to fail, the &%check_srv%&
19832 option is ignored, and the router proceeds to look for MX records in the
19833 normal way.
19834
19835 When the expansion succeeds, the router searches first for SRV records for
19836 the given service (it assumes TCP protocol). A single SRV record with a
19837 host name that consists of just a single dot indicates &"no such service for
19838 this domain"&; if this is encountered, the router declines. If other kinds of
19839 SRV record are found, they are used to construct a host list for delivery
19840 according to the rules of RFC 2782. MX records are not sought in this case.
19841
19842 When no SRV records are found, MX records (and address records) are sought in
19843 the traditional way. In other words, SRV records take precedence over MX
19844 records, just as MX records take precedence over address records. Note that
19845 this behaviour is not sanctioned by RFC 2782, though a previous draft RFC
19846 defined it. It is apparently believed that MX records are sufficient for email
19847 and that SRV records should not be used for this purpose. However, SRV records
19848 have an additional &"weight"& feature which some people might find useful when
19849 trying to split an SMTP load between hosts of different power.
19850
19851 See section &<<SECTprowitdnsloo>>& above for a discussion of Exim's behaviour
19852 when there is a DNS lookup error.
19853
19854
19855
19856
19857 .option fail_defer_domains dnslookup "domain list&!!" unset
19858 .cindex "MX record" "not found"
19859 DNS lookups for domains matching &%fail_defer_domains%&
19860 which find no matching record will cause the router to defer
19861 rather than the default behaviour of decline.
19862 This maybe be useful for queueing messages for a newly created
19863 domain while the DNS configuration is not ready.
19864 However, it will result in any message with mistyped domains
19865 also being queued.
19866
19867
19868 .option ipv4_only "string&!!" unset
19869 .cindex IPv6 disabling
19870 .cindex DNS "IPv6 disabling"
19871 The string is expanded, and if the result is anything but a forced failure,
19872 or an empty string, or one of the strings “0” or “no” or “false”
19873 (checked without regard to the case of the letters),
19874 only A records are used.
19875
19876 .option ipv4_prefer "string&!!" unset
19877 .cindex IPv4 preference
19878 .cindex DNS "IPv4 preference"
19879 The string is expanded, and if the result is anything but a forced failure,
19880 or an empty string, or one of the strings “0” or “no” or “false”
19881 (checked without regard to the case of the letters),
19882 A records are sorted before AAAA records (inverting the default).
19883
19884 .option mx_domains dnslookup "domain list&!!" unset
19885 .cindex "MX record" "required to exist"
19886 .cindex "SRV record" "required to exist"
19887 A domain that matches &%mx_domains%& is required to have either an MX or an SRV
19888 record in order to be recognized. (The name of this option could be improved.)
19889 For example, if all the mail hosts in &'fict.example'& are known to have MX
19890 records, except for those in &'discworld.fict.example'&, you could use this
19891 setting:
19892 .code
19893 mx_domains = ! *.discworld.fict.example : *.fict.example
19894 .endd
19895 This specifies that messages addressed to a domain that matches the list but
19896 has no MX record should be bounced immediately instead of being routed using
19897 the address record.
19898
19899
19900 .option mx_fail_domains dnslookup "domain list&!!" unset
19901 If the DNS lookup for MX records for one of the domains in this list causes a
19902 DNS lookup error, Exim behaves as if no MX records were found. See section
19903 &<<SECTprowitdnsloo>>& for more discussion.
19904
19905
19906
19907
19908 .option qualify_single dnslookup boolean true
19909 .cindex "DNS" "resolver options"
19910 .cindex "DNS" "qualifying single-component names"
19911 When this option is true, the resolver option RES_DEFNAMES is set for DNS
19912 lookups. Typically, but not standardly, this causes the resolver to qualify
19913 single-component names with the default domain. For example, on a machine
19914 called &'dictionary.ref.example'&, the domain &'thesaurus'& would be changed to
19915 &'thesaurus.ref.example'& inside the resolver. For details of what your
19916 resolver actually does, consult your man pages for &'resolver'& and
19917 &'resolv.conf'&.
19918
19919
19920
19921 .option rewrite_headers dnslookup boolean true
19922 .cindex "rewriting" "header lines"
19923 .cindex "header lines" "rewriting"
19924 If the domain name in the address that is being processed is not fully
19925 qualified, it may be expanded to its full form by a DNS lookup. For example, if
19926 an address is specified as &'dormouse@teaparty'&, the domain might be
19927 expanded to &'teaparty.wonderland.fict.example'&. Domain expansion can also
19928 occur as a result of setting the &%widen_domains%& option. If
19929 &%rewrite_headers%& is true, all occurrences of the abbreviated domain name in
19930 any &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-to:'&, &'Sender:'&, and &'To:'&
19931 header lines of the message are rewritten with the full domain name.
19932
19933 This option should be turned off only when it is known that no message is
19934 ever going to be sent outside an environment where the abbreviation makes
19935 sense.
19936
19937 When an MX record is looked up in the DNS and matches a wildcard record, name
19938 servers normally return a record containing the name that has been looked up,
19939 making it impossible to detect whether a wildcard was present or not. However,
19940 some name servers have recently been seen to return the wildcard entry. If the
19941 name returned by a DNS lookup begins with an asterisk, it is not used for
19942 header rewriting.
19943
19944
19945 .option same_domain_copy_routing dnslookup boolean false
19946 .cindex "address" "copying routing"
19947 Addresses with the same domain are normally routed by the &(dnslookup)& router
19948 to the same list of hosts. However, this cannot be presumed, because the router
19949 options and preconditions may refer to the local part of the address. By
19950 default, therefore, Exim routes each address in a message independently. DNS
19951 servers run caches, so repeated DNS lookups are not normally expensive, and in
19952 any case, personal messages rarely have more than a few recipients.
19953
19954 If you are running mailing lists with large numbers of subscribers at the same
19955 domain, and you are using a &(dnslookup)& router which is independent of the
19956 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
19957 lookups for identical domains in one message. In this case, when &(dnslookup)&
19958 routes an address to a remote transport, any other unrouted addresses in the
19959 message that have the same domain are automatically given the same routing
19960 without processing them independently,
19961 provided the following conditions are met:
19962
19963 .ilist
19964 No router that processed the address specified &%headers_add%& or
19965 &%headers_remove%&.
19966 .next
19967 The router did not change the address in any way, for example, by &"widening"&
19968 the domain.
19969 .endlist
19970
19971
19972
19973
19974 .option search_parents dnslookup boolean false
19975 .cindex "DNS" "resolver options"
19976 When this option is true, the resolver option RES_DNSRCH is set for DNS
19977 lookups. This is different from the &%qualify_single%& option in that it
19978 applies to domains containing dots. Typically, but not standardly, it causes
19979 the resolver to search for the name in the current domain and in parent
19980 domains. For example, on a machine in the &'fict.example'& domain, if looking
19981 up &'teaparty.wonderland'& failed, the resolver would try
19982 &'teaparty.wonderland.fict.example'&. For details of what your resolver
19983 actually does, consult your man pages for &'resolver'& and &'resolv.conf'&.
19984
19985 Setting this option true can cause problems in domains that have a wildcard MX
19986 record, because any domain that does not have its own MX record matches the
19987 local wildcard.
19988
19989
19990
19991 .option srv_fail_domains dnslookup "domain list&!!" unset
19992 If the DNS lookup for SRV records for one of the domains in this list causes a
19993 DNS lookup error, Exim behaves as if no SRV records were found. See section
19994 &<<SECTprowitdnsloo>>& for more discussion.
19995
19996
19997
19998
19999 .option widen_domains dnslookup "string list" unset
20000 .cindex "domain" "partial; widening"
20001 If a DNS lookup fails and this option is set, each of its strings in turn is
20002 added onto the end of the domain, and the lookup is tried again. For example,
20003 if
20004 .code
20005 widen_domains = fict.example:ref.example
20006 .endd
20007 is set and a lookup of &'klingon.dictionary'& fails,
20008 &'klingon.dictionary.fict.example'& is looked up, and if this fails,
20009 &'klingon.dictionary.ref.example'& is tried. Note that the &%qualify_single%&
20010 and &%search_parents%& options can cause some widening to be undertaken inside
20011 the DNS resolver. &%widen_domains%& is not applied to sender addresses
20012 when verifying, unless &%rewrite_headers%& is false (not the default).
20013
20014
20015 .section "Effect of qualify_single and search_parents" "SECID119"
20016 When a domain from an envelope recipient is changed by the resolver as a result
20017 of the &%qualify_single%& or &%search_parents%& options, Exim rewrites the
20018 corresponding address in the message's header lines unless &%rewrite_headers%&
20019 is set false. Exim then re-routes the address, using the full domain.
20020
20021 These two options affect only the DNS lookup that takes place inside the router
20022 for the domain of the address that is being routed. They do not affect lookups
20023 such as that implied by
20024 .code
20025 domains = @mx_any
20026 .endd
20027 that may happen while processing a router precondition before the router is
20028 entered. No widening ever takes place for these lookups.
20029 .ecindex IIDdnsrou1
20030 .ecindex IIDdnsrou2
20031
20032
20033
20034
20035
20036
20037
20038
20039
20040 . ////////////////////////////////////////////////////////////////////////////
20041 . ////////////////////////////////////////////////////////////////////////////
20042
20043 .chapter "The ipliteral router" "CHID5"
20044 .cindex "&(ipliteral)& router"
20045 .cindex "domain literal" "routing"
20046 .cindex "routers" "&(ipliteral)&"
20047 This router has no private options. Unless it is being used purely for
20048 verification (see &%verify_only%&) a transport is required to be defined by the
20049 generic &%transport%& option. The router accepts the address if its domain part
20050 takes the form of an RFC 2822 domain literal. For example, the &(ipliteral)&
20051 router handles the address
20052 .code
20053 root@[192.168.1.1]
20054 .endd
20055 by setting up delivery to the host with that IP address. IPv4 domain literals
20056 consist of an IPv4 address enclosed in square brackets. IPv6 domain literals
20057 are similar, but the address is preceded by &`ipv6:`&. For example:
20058 .code
20059 postmaster@[ipv6:fe80::a00:20ff:fe86:a061.5678]
20060 .endd
20061 Exim allows &`ipv4:`& before IPv4 addresses, for consistency, and on the
20062 grounds that sooner or later somebody will try it.
20063
20064 .oindex "&%self%&" "in &(ipliteral)& router"
20065 If the IP address matches something in &%ignore_target_hosts%&, the router
20066 declines. If an IP literal turns out to refer to the local host, the generic
20067 &%self%& option determines what happens.
20068
20069 The RFCs require support for domain literals; however, their use is
20070 controversial in today's Internet. If you want to use this router, you must
20071 also set the main configuration option &%allow_domain_literals%&. Otherwise,
20072 Exim will not recognize the domain literal syntax in addresses.
20073
20074
20075
20076 . ////////////////////////////////////////////////////////////////////////////
20077 . ////////////////////////////////////////////////////////////////////////////
20078
20079 .chapter "The iplookup router" "CHID6"
20080 .cindex "&(iplookup)& router"
20081 .cindex "routers" "&(iplookup)&"
20082 The &(iplookup)& router was written to fulfil a specific requirement in
20083 Cambridge University (which in fact no longer exists). For this reason, it is
20084 not included in the binary of Exim by default. If you want to include it, you
20085 must set
20086 .code
20087 ROUTER_IPLOOKUP=yes
20088 .endd
20089 in your &_Local/Makefile_& configuration file.
20090
20091 The &(iplookup)& router routes an address by sending it over a TCP or UDP
20092 connection to one or more specific hosts. The host can then return the same or
20093 a different address &-- in effect rewriting the recipient address in the
20094 message's envelope. The new address is then passed on to subsequent routers. If
20095 this process fails, the address can be passed on to other routers, or delivery
20096 can be deferred. Since &(iplookup)& is just a rewriting router, a transport
20097 must not be specified for it.
20098
20099 .cindex "options" "&(iplookup)& router"
20100 .option hosts iplookup string unset
20101 This option must be supplied. Its value is a colon-separated list of host
20102 names. The hosts are looked up using &[gethostbyname()]&
20103 (or &[getipnodebyname()]& when available)
20104 and are tried in order until one responds to the query. If none respond, what
20105 happens is controlled by &%optional%&.
20106
20107
20108 .option optional iplookup boolean false
20109 If &%optional%& is true, if no response is obtained from any host, the address
20110 is passed to the next router, overriding &%no_more%&. If &%optional%& is false,
20111 delivery to the address is deferred.
20112
20113
20114 .option port iplookup integer 0
20115 .cindex "port" "&(iplookup)& router"
20116 This option must be supplied. It specifies the port number for the TCP or UDP
20117 call.
20118
20119
20120 .option protocol iplookup string udp
20121 This option can be set to &"udp"& or &"tcp"& to specify which of the two
20122 protocols is to be used.
20123
20124
20125 .option query iplookup string&!! "see below"
20126 This defines the content of the query that is sent to the remote hosts. The
20127 default value is:
20128 .code
20129 $local_part@$domain $local_part@$domain
20130 .endd
20131 The repetition serves as a way of checking that a response is to the correct
20132 query in the default case (see &%response_pattern%& below).
20133
20134
20135 .option reroute iplookup string&!! unset
20136 If this option is not set, the rerouted address is precisely the byte string
20137 returned by the remote host, up to the first white space, if any. If set, the
20138 string is expanded to form the rerouted address. It can include parts matched
20139 in the response by &%response_pattern%& by means of numeric variables such as
20140 &$1$&, &$2$&, etc. The variable &$0$& refers to the entire input string,
20141 whether or not a pattern is in use. In all cases, the rerouted address must end
20142 up in the form &'local_part@domain'&.
20143
20144
20145 .option response_pattern iplookup string unset
20146 This option can be set to a regular expression that is applied to the string
20147 returned from the remote host. If the pattern does not match the response, the
20148 router declines. If &%response_pattern%& is not set, no checking of the
20149 response is done, unless the query was defaulted, in which case there is a
20150 check that the text returned after the first white space is the original
20151 address. This checks that the answer that has been received is in response to
20152 the correct question. For example, if the response is just a new domain, the
20153 following could be used:
20154 .code
20155 response_pattern = ^([^@]+)$
20156 reroute = $local_part@$1
20157 .endd
20158
20159 .option timeout iplookup time 5s
20160 This specifies the amount of time to wait for a response from the remote
20161 machine. The same timeout is used for the &[connect()]& function for a TCP
20162 call. It does not apply to UDP.
20163
20164
20165
20166
20167 . ////////////////////////////////////////////////////////////////////////////
20168 . ////////////////////////////////////////////////////////////////////////////
20169
20170 .chapter "The manualroute router" "CHID7"
20171 .scindex IIDmanrou1 "&(manualroute)& router"
20172 .scindex IIDmanrou2 "routers" "&(manualroute)&"
20173 .cindex "domain" "manually routing"
20174 The &(manualroute)& router is so-called because it provides a way of manually
20175 routing an address according to its domain. It is mainly used when you want to
20176 route addresses to remote hosts according to your own rules, bypassing the
20177 normal DNS routing that looks up MX records. However, &(manualroute)& can also
20178 route to local transports, a facility that may be useful if you want to save
20179 messages for dial-in hosts in local files.
20180
20181 The &(manualroute)& router compares a list of domain patterns with the domain
20182 it is trying to route. If there is no match, the router declines. Each pattern
20183 has associated with it a list of hosts and some other optional data, which may
20184 include a transport. The combination of a pattern and its data is called a
20185 &"routing rule"&. For patterns that do not have an associated transport, the
20186 generic &%transport%& option must specify a transport, unless the router is
20187 being used purely for verification (see &%verify_only%&).
20188
20189 .vindex "&$host$&"
20190 In the case of verification, matching the domain pattern is sufficient for the
20191 router to accept the address. When actually routing an address for delivery,
20192 an address that matches a domain pattern is queued for the associated
20193 transport. If the transport is not a local one, a host list must be associated
20194 with the pattern; IP addresses are looked up for the hosts, and these are
20195 passed to the transport along with the mail address. For local transports, a
20196 host list is optional. If it is present, it is passed in &$host$& as a single
20197 text string.
20198
20199 The list of routing rules can be provided as an inline string in
20200 &%route_list%&, or the data can be obtained by looking up the domain in a file
20201 or database by setting &%route_data%&. Only one of these settings may appear in
20202 any one instance of &(manualroute)&. The format of routing rules is described
20203 below, following the list of private options.
20204
20205
20206 .section "Private options for manualroute" "SECTprioptman"
20207
20208 .cindex "options" "&(manualroute)& router"
20209 The private options for the &(manualroute)& router are as follows:
20210
20211 .option host_all_ignored manualroute string defer
20212 See &%host_find_failed%&.
20213
20214 .option host_find_failed manualroute string freeze
20215 This option controls what happens when &(manualroute)& tries to find an IP
20216 address for a host, and the host does not exist. The option can be set to one
20217 of the following values:
20218 .code
20219 decline
20220 defer
20221 fail
20222 freeze
20223 ignore
20224 pass
20225 .endd
20226 The default (&"freeze"&) assumes that this state is a serious configuration
20227 error. The difference between &"pass"& and &"decline"& is that the former
20228 forces the address to be passed to the next router (or the router defined by
20229 &%pass_router%&),
20230 .oindex "&%more%&"
20231 overriding &%no_more%&, whereas the latter passes the address to the next
20232 router only if &%more%& is true.
20233
20234 The value &"ignore"& causes Exim to completely ignore a host whose IP address
20235 cannot be found. If all the hosts in the list are ignored, the behaviour is
20236 controlled by the &%host_all_ignored%& option. This takes the same values
20237 as &%host_find_failed%&, except that it cannot be set to &"ignore"&.
20238
20239 The &%host_find_failed%& option applies only to a definite &"does not exist"&
20240 state; if a host lookup gets a temporary error, delivery is deferred unless the
20241 generic &%pass_on_timeout%& option is set.
20242
20243
20244 .option hosts_randomize manualroute boolean false
20245 .cindex "randomized host list"
20246 .cindex "host" "list of; randomized"
20247 If this option is set, the order of the items in a host list in a routing rule
20248 is randomized each time the list is used, unless an option in the routing rule
20249 overrides (see below). Randomizing the order of a host list can be used to do
20250 crude load sharing. However, if more than one mail address is routed by the
20251 same router to the same host list, the host lists are considered to be the same
20252 (even though they may be randomized into different orders) for the purpose of
20253 deciding whether to batch the deliveries into a single SMTP transaction.
20254
20255 When &%hosts_randomize%& is true, a host list may be split
20256 into groups whose order is separately randomized. This makes it possible to
20257 set up MX-like behaviour. The boundaries between groups are indicated by an
20258 item that is just &`+`& in the host list. For example:
20259 .code
20260 route_list = * host1:host2:host3:+:host4:host5
20261 .endd
20262 The order of the first three hosts and the order of the last two hosts is
20263 randomized for each use, but the first three always end up before the last two.
20264 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored. If a
20265 randomized host list is passed to an &(smtp)& transport that also has
20266 &%hosts_randomize set%&, the list is not re-randomized.
20267
20268
20269 .option route_data manualroute string&!! unset
20270 If this option is set, it must expand to yield the data part of a routing rule.
20271 Typically, the expansion string includes a lookup based on the domain. For
20272 example:
20273 .code
20274 route_data = ${lookup{$domain}dbm{/etc/routes}}
20275 .endd
20276 If the expansion is forced to fail, or the result is an empty string, the
20277 router declines. Other kinds of expansion failure cause delivery to be
20278 deferred.
20279
20280
20281 .option route_list manualroute "string list" unset
20282 This string is a list of routing rules, in the form defined below. Note that,
20283 unlike most string lists, the items are separated by semicolons. This is so
20284 that they may contain colon-separated host lists.
20285
20286
20287 .option same_domain_copy_routing manualroute boolean false
20288 .cindex "address" "copying routing"
20289 Addresses with the same domain are normally routed by the &(manualroute)&
20290 router to the same list of hosts. However, this cannot be presumed, because the
20291 router options and preconditions may refer to the local part of the address. By
20292 default, therefore, Exim routes each address in a message independently. DNS
20293 servers run caches, so repeated DNS lookups are not normally expensive, and in
20294 any case, personal messages rarely have more than a few recipients.
20295
20296 If you are running mailing lists with large numbers of subscribers at the same
20297 domain, and you are using a &(manualroute)& router which is independent of the
20298 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
20299 lookups for identical domains in one message. In this case, when
20300 &(manualroute)& routes an address to a remote transport, any other unrouted
20301 addresses in the message that have the same domain are automatically given the
20302 same routing without processing them independently. However, this is only done
20303 if &%headers_add%& and &%headers_remove%& are unset.
20304
20305
20306
20307
20308 .section "Routing rules in route_list" "SECID120"
20309 The value of &%route_list%& is a string consisting of a sequence of routing
20310 rules, separated by semicolons. If a semicolon is needed in a rule, it can be
20311 entered as two semicolons. Alternatively, the list separator can be changed as
20312 described (for colon-separated lists) in section &<<SECTlistconstruct>>&.
20313 Empty rules are ignored. The format of each rule is
20314 .display
20315 <&'domain pattern'&>  <&'list of hosts'&>  <&'options'&>
20316 .endd
20317 The following example contains two rules, each with a simple domain pattern and
20318 no options:
20319 .code
20320 route_list = \
20321   dict.ref.example  mail-1.ref.example:mail-2.ref.example ; \
20322   thes.ref.example  mail-3.ref.example:mail-4.ref.example
20323 .endd
20324 The three parts of a rule are separated by white space. The pattern and the
20325 list of hosts can be enclosed in quotes if necessary, and if they are, the
20326 usual quoting rules apply. Each rule in a &%route_list%& must start with a
20327 single domain pattern, which is the only mandatory item in the rule. The
20328 pattern is in the same format as one item in a domain list (see section
20329 &<<SECTdomainlist>>&),
20330 except that it may not be the name of an interpolated file.
20331 That is, it may be wildcarded, or a regular expression, or a file or database
20332 lookup (with semicolons doubled, because of the use of semicolon as a separator
20333 in a &%route_list%&).
20334
20335 The rules in &%route_list%& are searched in order until one of the patterns
20336 matches the domain that is being routed. The list of hosts and then options are
20337 then used as described below. If there is no match, the router declines. When
20338 &%route_list%& is set, &%route_data%& must not be set.
20339
20340
20341
20342 .section "Routing rules in route_data" "SECID121"
20343 The use of &%route_list%& is convenient when there are only a small number of
20344 routing rules. For larger numbers, it is easier to use a file or database to
20345 hold the routing information, and use the &%route_data%& option instead.
20346 The value of &%route_data%& is a list of hosts, followed by (optional) options.
20347 Most commonly, &%route_data%& is set as a string that contains an
20348 expansion lookup. For example, suppose we place two routing rules in a file
20349 like this:
20350 .code
20351 dict.ref.example:  mail-1.ref.example:mail-2.ref.example
20352 thes.ref.example:  mail-3.ref.example:mail-4.ref.example
20353 .endd
20354 This data can be accessed by setting
20355 .code
20356 route_data = ${lookup{$domain}lsearch{/the/file/name}}
20357 .endd
20358 Failure of the lookup results in an empty string, causing the router to
20359 decline. However, you do not have to use a lookup in &%route_data%&. The only
20360 requirement is that the result of expanding the string is a list of hosts,
20361 possibly followed by options, separated by white space. The list of hosts must
20362 be enclosed in quotes if it contains white space.
20363
20364
20365
20366
20367 .section "Format of the list of hosts" "SECID122"
20368 A list of hosts, whether obtained via &%route_data%& or &%route_list%&, is
20369 always separately expanded before use. If the expansion fails, the router
20370 declines. The result of the expansion must be a colon-separated list of names
20371 and/or IP addresses, optionally also including ports.
20372 If the list is written with spaces, it must be protected with quotes.
20373 The format of each item
20374 in the list is described in the next section. The list separator can be changed
20375 as described in section &<<SECTlistsepchange>>&.
20376
20377 If the list of hosts was obtained from a &%route_list%& item, the following
20378 variables are set during its expansion:
20379
20380 .ilist
20381 .cindex "numerical variables (&$1$& &$2$&  etc)" "in &(manualroute)& router"
20382 If the domain was matched against a regular expression, the numeric variables
20383 &$1$&, &$2$&, etc. may be set. For example:
20384 .code
20385 route_list = ^domain(\d+)   host-$1.text.example
20386 .endd
20387 .next
20388 &$0$& is always set to the entire domain.
20389 .next
20390 &$1$& is also set when partial matching is done in a file lookup.
20391
20392 .next
20393 .vindex "&$value$&"
20394 If the pattern that matched the domain was a lookup item, the data that was
20395 looked up is available in the expansion variable &$value$&. For example:
20396 .code
20397 route_list = lsearch;;/some/file.routes  $value
20398 .endd
20399 .endlist
20400
20401 Note the doubling of the semicolon in the pattern that is necessary because
20402 semicolon is the default route list separator.
20403
20404
20405
20406 .section "Format of one host item" "SECTformatonehostitem"
20407 Each item in the list of hosts can be either a host name or an IP address,
20408 optionally with an attached port number, or it can be a single "+"
20409 (see &%hosts_randomize%&).
20410 When no port is given, an IP address
20411 is not enclosed in brackets. When a port is specified, it overrides the port
20412 specification on the transport. The port is separated from the name or address
20413 by a colon. This leads to some complications:
20414
20415 .ilist
20416 Because colon is the default separator for the list of hosts, either
20417 the colon that specifies a port must be doubled, or the list separator must
20418 be changed. The following two examples have the same effect:
20419 .code
20420 route_list = * "host1.tld::1225 : host2.tld::1226"
20421 route_list = * "<+ host1.tld:1225 + host2.tld:1226"
20422 .endd
20423 .next
20424 When IPv6 addresses are involved, it gets worse, because they contain
20425 colons of their own. To make this case easier, it is permitted to
20426 enclose an IP address (either v4 or v6) in square brackets if a port
20427 number follows. For example:
20428 .code
20429 route_list = * "</ [10.1.1.1]:1225 / [::1]:1226"
20430 .endd
20431 .endlist
20432
20433 .section "How the list of hosts is used" "SECThostshowused"
20434 When an address is routed to an &(smtp)& transport by &(manualroute)&, each of
20435 the hosts is tried, in the order specified, when carrying out the SMTP
20436 delivery. However, the order can be changed by setting the &%hosts_randomize%&
20437 option, either on the router (see section &<<SECTprioptman>>& above), or on the
20438 transport.
20439
20440 Hosts may be listed by name or by IP address. An unadorned name in the list of
20441 hosts is interpreted as a host name. A name that is followed by &`/MX`& is
20442 interpreted as an indirection to a sublist of hosts obtained by looking up MX
20443 records in the DNS. For example:
20444 .code
20445 route_list = *  x.y.z:p.q.r/MX:e.f.g
20446 .endd
20447 If this feature is used with a port specifier, the port must come last. For
20448 example:
20449 .code
20450 route_list = *  dom1.tld/mx::1225
20451 .endd
20452 If the &%hosts_randomize%& option is set, the order of the items in the list is
20453 randomized before any lookups are done. Exim then scans the list; for any name
20454 that is not followed by &`/MX`& it looks up an IP address. If this turns out to
20455 be an interface on the local host and the item is not the first in the list,
20456 Exim discards it and any subsequent items. If it is the first item, what
20457 happens is controlled by the
20458 .oindex "&%self%&" "in &(manualroute)& router"
20459 &%self%& option of the router.
20460
20461 A name on the list that is followed by &`/MX`& is replaced with the list of
20462 hosts obtained by looking up MX records for the name. This is always a DNS
20463 lookup; the &%bydns%& and &%byname%& options (see section &<<SECThowoptused>>&
20464 below) are not relevant here. The order of these hosts is determined by the
20465 preference values in the MX records, according to the usual rules. Because
20466 randomizing happens before the MX lookup, it does not affect the order that is
20467 defined by MX preferences.
20468
20469 If the local host is present in the sublist obtained from MX records, but is
20470 not the most preferred host in that list, it and any equally or less
20471 preferred hosts are removed before the sublist is inserted into the main list.
20472
20473 If the local host is the most preferred host in the MX list, what happens
20474 depends on where in the original list of hosts the &`/MX`& item appears. If it
20475 is not the first item (that is, there are previous hosts in the main list),
20476 Exim discards this name and any subsequent items in the main list.
20477
20478 If the MX item is first in the list of hosts, and the local host is the
20479 most preferred host, what happens is controlled by the &%self%& option of the
20480 router.
20481
20482 DNS failures when lookup up the MX records are treated in the same way as DNS
20483 failures when looking up IP addresses: &%pass_on_timeout%& and
20484 &%host_find_failed%& are used when relevant.
20485
20486 The generic &%ignore_target_hosts%& option applies to all hosts in the list,
20487 whether obtained from an MX lookup or not.
20488
20489
20490
20491 .section "How the options are used" "SECThowoptused"
20492 The options are a sequence of words, space-separated.
20493 One of the words can be the name of a transport; this overrides the
20494 &%transport%& option on the router for this particular routing rule only. The
20495 other words (if present) control randomization of the list of hosts on a
20496 per-rule basis, and how the IP addresses of the hosts are to be found when
20497 routing to a remote transport. These options are as follows:
20498
20499 .ilist
20500 &%randomize%&: randomize the order of the hosts in this list, overriding the
20501 setting of &%hosts_randomize%& for this routing rule only.
20502 .next
20503 &%no_randomize%&: do not randomize the order of the hosts in this list,
20504 overriding the setting of &%hosts_randomize%& for this routing rule only.
20505 .next
20506 &%byname%&: use &[getipnodebyname()]& (&[gethostbyname()]& on older systems) to
20507 find IP addresses. This function may ultimately cause a DNS lookup, but it may
20508 also look in &_/etc/hosts_& or other sources of information.
20509 .next
20510 &%bydns%&: look up address records for the hosts directly in the DNS; fail if
20511 no address records are found. If there is a temporary DNS error (such as a
20512 timeout), delivery is deferred.
20513 .next
20514 &%ipv4_only%&: in direct DNS lookups, look up only A records.
20515 .next
20516 &%ipv4_prefer%&: in direct DNS lookups, sort A records before AAAA records.
20517 .endlist
20518
20519 For example:
20520 .code
20521 route_list = domain1  host1:host2:host3  randomize bydns;\
20522              domain2  host4:host5
20523 .endd
20524 If neither &%byname%& nor &%bydns%& is given, Exim behaves as follows: First, a
20525 DNS lookup is done. If this yields anything other than HOST_NOT_FOUND, that
20526 result is used. Otherwise, Exim goes on to try a call to &[getipnodebyname()]&
20527 or &[gethostbyname()]&, and the result of the lookup is the result of that
20528 call.
20529
20530 &*Warning*&: It has been discovered that on some systems, if a DNS lookup
20531 called via &[getipnodebyname()]& times out, HOST_NOT_FOUND is returned
20532 instead of TRY_AGAIN. That is why the default action is to try a DNS
20533 lookup first. Only if that gives a definite &"no such host"& is the local
20534 function called.
20535
20536 &*Compatibility*&: From Exim 4.85 until fixed for 4.90, there was an
20537 inadvertent constraint that a transport name as an option had to be the last
20538 option specified.
20539
20540
20541
20542 If no IP address for a host can be found, what happens is controlled by the
20543 &%host_find_failed%& option.
20544
20545 .vindex "&$host$&"
20546 When an address is routed to a local transport, IP addresses are not looked up.
20547 The host list is passed to the transport in the &$host$& variable.
20548
20549
20550
20551 .section "Manualroute examples" "SECID123"
20552 In some of the examples that follow, the presence of the &%remote_smtp%&
20553 transport, as defined in the default configuration file, is assumed:
20554
20555 .ilist
20556 .cindex "smart host" "example router"
20557 The &(manualroute)& router can be used to forward all external mail to a
20558 &'smart host'&. If you have set up, in the main part of the configuration, a
20559 named domain list that contains your local domains, for example:
20560 .code
20561 domainlist local_domains = my.domain.example
20562 .endd
20563 You can arrange for all other domains to be routed to a smart host by making
20564 your first router something like this:
20565 .code
20566 smart_route:
20567   driver = manualroute
20568   domains = !+local_domains
20569   transport = remote_smtp
20570   route_list = * smarthost.ref.example
20571 .endd
20572 This causes all non-local addresses to be sent to the single host
20573 &'smarthost.ref.example'&. If a colon-separated list of smart hosts is given,
20574 they are tried in order
20575 (but you can use &%hosts_randomize%& to vary the order each time).
20576 Another way of configuring the same thing is this:
20577 .code
20578 smart_route:
20579   driver = manualroute
20580   transport = remote_smtp
20581   route_list = !+local_domains  smarthost.ref.example
20582 .endd
20583 There is no difference in behaviour between these two routers as they stand.
20584 However, they behave differently if &%no_more%& is added to them. In the first
20585 example, the router is skipped if the domain does not match the &%domains%&
20586 precondition; the following router is always tried. If the router runs, it
20587 always matches the domain and so can never decline. Therefore, &%no_more%&
20588 would have no effect. In the second case, the router is never skipped; it
20589 always runs. However, if it doesn't match the domain, it declines. In this case
20590 &%no_more%& would prevent subsequent routers from running.
20591
20592 .next
20593 .cindex "mail hub example"
20594 A &'mail hub'& is a host which receives mail for a number of domains via MX
20595 records in the DNS and delivers it via its own private routing mechanism. Often
20596 the final destinations are behind a firewall, with the mail hub being the one
20597 machine that can connect to machines both inside and outside the firewall. The
20598 &(manualroute)& router is usually used on a mail hub to route incoming messages
20599 to the correct hosts. For a small number of domains, the routing can be inline,
20600 using the &%route_list%& option, but for a larger number a file or database
20601 lookup is easier to manage.
20602
20603 If the domain names are in fact the names of the machines to which the mail is
20604 to be sent by the mail hub, the configuration can be quite simple. For
20605 example:
20606 .code
20607 hub_route:
20608   driver = manualroute
20609   transport = remote_smtp
20610   route_list = *.rhodes.tvs.example  $domain
20611 .endd
20612 This configuration routes domains that match &`*.rhodes.tvs.example`& to hosts
20613 whose names are the same as the mail domains. A similar approach can be taken
20614 if the host name can be obtained from the domain name by a string manipulation
20615 that the expansion facilities can handle. Otherwise, a lookup based on the
20616 domain can be used to find the host:
20617 .code
20618 through_firewall:
20619   driver = manualroute
20620   transport = remote_smtp
20621   route_data = ${lookup {$domain} cdb {/internal/host/routes}}
20622 .endd
20623 The result of the lookup must be the name or IP address of the host (or
20624 hosts) to which the address is to be routed. If the lookup fails, the route
20625 data is empty, causing the router to decline. The address then passes to the
20626 next router.
20627
20628 .next
20629 .cindex "batched SMTP output example"
20630 .cindex "SMTP" "batched outgoing; example"
20631 You can use &(manualroute)& to deliver messages to pipes or files in batched
20632 SMTP format for onward transportation by some other means. This is one way of
20633 storing mail for a dial-up host when it is not connected. The route list entry
20634 can be as simple as a single domain name in a configuration like this:
20635 .code
20636 save_in_file:
20637   driver = manualroute
20638   transport = batchsmtp_appendfile
20639   route_list = saved.domain.example
20640 .endd
20641 though often a pattern is used to pick up more than one domain. If there are
20642 several domains or groups of domains with different transport requirements,
20643 different transports can be listed in the routing information:
20644 .code
20645 save_in_file:
20646   driver = manualroute
20647   route_list = \
20648     *.saved.domain1.example  $domain  batch_appendfile; \
20649     *.saved.domain2.example  \
20650       ${lookup{$domain}dbm{/domain2/hosts}{$value}fail} \
20651       batch_pipe
20652 .endd
20653 .vindex "&$domain$&"
20654 .vindex "&$host$&"
20655 The first of these just passes the domain in the &$host$& variable, which
20656 doesn't achieve much (since it is also in &$domain$&), but the second does a
20657 file lookup to find a value to pass, causing the router to decline to handle
20658 the address if the lookup fails.
20659
20660 .next
20661 .cindex "UUCP" "example of router for"
20662 Routing mail directly to UUCP software is a specific case of the use of
20663 &(manualroute)& in a gateway to another mail environment. This is an example of
20664 one way it can be done:
20665 .code
20666 # Transport
20667 uucp:
20668   driver = pipe
20669   user = nobody
20670   command = /usr/local/bin/uux -r - \
20671     ${substr_-5:$host}!rmail ${local_part}
20672   return_fail_output = true
20673
20674 # Router
20675 uucphost:
20676   transport = uucp
20677   driver = manualroute
20678   route_data = \
20679     ${lookup{$domain}lsearch{/usr/local/exim/uucphosts}}
20680 .endd
20681 The file &_/usr/local/exim/uucphosts_& contains entries like
20682 .code
20683 darksite.ethereal.example:           darksite.UUCP
20684 .endd
20685 It can be set up more simply without adding and removing &".UUCP"& but this way
20686 makes clear the distinction between the domain name
20687 &'darksite.ethereal.example'& and the UUCP host name &'darksite'&.
20688 .endlist
20689 .ecindex IIDmanrou1
20690 .ecindex IIDmanrou2
20691
20692
20693
20694
20695
20696
20697
20698
20699 . ////////////////////////////////////////////////////////////////////////////
20700 . ////////////////////////////////////////////////////////////////////////////
20701
20702 .chapter "The queryprogram router" "CHAPdriverlast"
20703 .scindex IIDquerou1 "&(queryprogram)& router"
20704 .scindex IIDquerou2 "routers" "&(queryprogram)&"
20705 .cindex "routing" "by external program"
20706 The &(queryprogram)& router routes an address by running an external command
20707 and acting on its output. This is an expensive way to route, and is intended
20708 mainly for use in lightly-loaded systems, or for performing experiments.
20709 However, if it is possible to use the precondition options (&%domains%&,
20710 &%local_parts%&, etc) to skip this router for most addresses, it could sensibly
20711 be used in special cases, even on a busy host. There are the following private
20712 options:
20713 .cindex "options" "&(queryprogram)& router"
20714
20715 .option command queryprogram string&!! unset
20716 This option must be set. It specifies the command that is to be run. The
20717 command is split up into a command name and arguments, and then each is
20718 expanded separately (exactly as for a &(pipe)& transport, described in chapter
20719 &<<CHAPpipetransport>>&).
20720
20721
20722 .option command_group queryprogram string unset
20723 .cindex "gid (group id)" "in &(queryprogram)& router"
20724 This option specifies a gid to be set when running the command while routing an
20725 address for deliver. It must be set if &%command_user%& specifies a numerical
20726 uid. If it begins with a digit, it is interpreted as the numerical value of the
20727 gid. Otherwise it is looked up using &[getgrnam()]&.
20728
20729
20730 .option command_user queryprogram string unset
20731 .cindex "uid (user id)" "for &(queryprogram)&"
20732 This option must be set. It specifies the uid which is set when running the
20733 command while routing an address for delivery. If the value begins with a digit,
20734 it is interpreted as the numerical value of the uid. Otherwise, it is looked up
20735 using &[getpwnam()]& to obtain a value for the uid and, if &%command_group%& is
20736 not set, a value for the gid also.
20737
20738 &*Warning:*& Changing uid and gid is possible only when Exim is running as
20739 root, which it does during a normal delivery in a conventional configuration.
20740 However, when an address is being verified during message reception, Exim is
20741 usually running as the Exim user, not as root. If the &(queryprogram)& router
20742 is called from a non-root process, Exim cannot change uid or gid before running
20743 the command. In this circumstance the command runs under the current uid and
20744 gid.
20745
20746
20747 .option current_directory queryprogram string /
20748 This option specifies an absolute path which is made the current directory
20749 before running the command.
20750
20751
20752 .option timeout queryprogram time 1h
20753 If the command does not complete within the timeout period, its process group
20754 is killed and the message is frozen. A value of zero time specifies no
20755 timeout.
20756
20757
20758 The standard output of the command is connected to a pipe, which is read when
20759 the command terminates. It should consist of a single line of output,
20760 containing up to five fields, separated by white space. The maximum length of
20761 the line is 1023 characters. Longer lines are silently truncated. The first
20762 field is one of the following words (case-insensitive):
20763
20764 .ilist
20765 &'Accept'&: routing succeeded; the remaining fields specify what to do (see
20766 below).
20767 .next
20768 &'Decline'&: the router declines; pass the address to the next router, unless
20769 &%no_more%& is set.
20770 .next
20771 &'Fail'&: routing failed; do not pass the address to any more routers. Any
20772 subsequent text on the line is an error message. If the router is run as part
20773 of address verification during an incoming SMTP message, the message is
20774 included in the SMTP response.
20775 .next
20776 &'Defer'&: routing could not be completed at this time; try again later. Any
20777 subsequent text on the line is an error message which is logged. It is not
20778 included in any SMTP response.
20779 .next
20780 &'Freeze'&: the same as &'defer'&, except that the message is frozen.
20781 .next
20782 &'Pass'&: pass the address to the next router (or the router specified by
20783 &%pass_router%&), overriding &%no_more%&.
20784 .next
20785 &'Redirect'&: the message is redirected. The remainder of the line is a list of
20786 new addresses, which are routed independently, starting with the first router,
20787 or the router specified by &%redirect_router%&, if set.
20788 .endlist
20789
20790 When the first word is &'accept'&, the remainder of the line consists of a
20791 number of keyed data values, as follows (split into two lines here, to fit on
20792 the page):
20793 .code
20794 ACCEPT TRANSPORT=<transport> HOSTS=<list of hosts>
20795 LOOKUP=byname|bydns DATA=<text>
20796 .endd
20797 The data items can be given in any order, and all are optional. If no transport
20798 is included, the transport specified by the generic &%transport%& option is
20799 used. The list of hosts and the lookup type are needed only if the transport is
20800 an &(smtp)& transport that does not itself supply a list of hosts.
20801
20802 The format of the list of hosts is the same as for the &(manualroute)& router.
20803 As well as host names and IP addresses with optional port numbers, as described
20804 in section &<<SECTformatonehostitem>>&, it may contain names followed by
20805 &`/MX`& to specify sublists of hosts that are obtained by looking up MX records
20806 (see section &<<SECThostshowused>>&).
20807
20808 If the lookup type is not specified, Exim behaves as follows when trying to
20809 find an IP address for each host: First, a DNS lookup is done. If this yields
20810 anything other than HOST_NOT_FOUND, that result is used. Otherwise, Exim
20811 goes on to try a call to &[getipnodebyname()]& or &[gethostbyname()]&, and the
20812 result of the lookup is the result of that call.
20813
20814 .vindex "&$address_data$&"
20815 If the DATA field is set, its value is placed in the &$address_data$&
20816 variable. For example, this return line
20817 .code
20818 accept hosts=x1.y.example:x2.y.example data="rule1"
20819 .endd
20820 routes the address to the default transport, passing a list of two hosts. When
20821 the transport runs, the string &"rule1"& is in &$address_data$&.
20822 .ecindex IIDquerou1
20823 .ecindex IIDquerou2
20824
20825
20826
20827
20828 . ////////////////////////////////////////////////////////////////////////////
20829 . ////////////////////////////////////////////////////////////////////////////
20830
20831 .chapter "The redirect router" "CHAPredirect"
20832 .scindex IIDredrou1 "&(redirect)& router"
20833 .scindex IIDredrou2 "routers" "&(redirect)&"
20834 .cindex "alias file" "in a &(redirect)& router"
20835 .cindex "address redirection" "&(redirect)& router"
20836 The &(redirect)& router handles several kinds of address redirection. Its most
20837 common uses are for resolving local part aliases from a central alias file
20838 (usually called &_/etc/aliases_&) and for handling users' personal &_.forward_&
20839 files, but it has many other potential uses. The incoming address can be
20840 redirected in several different ways:
20841
20842 .ilist
20843 It can be replaced by one or more new addresses which are themselves routed
20844 independently.
20845 .next
20846 It can be routed to be delivered to a given file or directory.
20847 .next
20848 It can be routed to be delivered to a specified pipe command.
20849 .next
20850 It can cause an automatic reply to be generated.
20851 .next
20852 It can be forced to fail, optionally with a custom error message.
20853 .next
20854 It can be temporarily deferred, optionally with a custom message.
20855 .next
20856 It can be discarded.
20857 .endlist
20858
20859 The generic &%transport%& option must not be set for &(redirect)& routers.
20860 However, there are some private options which define transports for delivery to
20861 files and pipes, and for generating autoreplies. See the &%file_transport%&,
20862 &%pipe_transport%& and &%reply_transport%& descriptions below.
20863
20864 If success DSNs have been requested
20865 .cindex "DSN" "success"
20866 .cindex "Delivery Status Notification" "success"
20867 redirection triggers one and the DSN options are not passed any further.
20868
20869
20870
20871 .section "Redirection data" "SECID124"
20872 The router operates by interpreting a text string which it obtains either by
20873 expanding the contents of the &%data%& option, or by reading the entire
20874 contents of a file whose name is given in the &%file%& option. These two
20875 options are mutually exclusive. The first is commonly used for handling system
20876 aliases, in a configuration like this:
20877 .code
20878 system_aliases:
20879   driver = redirect
20880   data = ${lookup{$local_part}lsearch{/etc/aliases}}
20881 .endd
20882 If the lookup fails, the expanded string in this example is empty. When the
20883 expansion of &%data%& results in an empty string, the router declines. A forced
20884 expansion failure also causes the router to decline; other expansion failures
20885 cause delivery to be deferred.
20886
20887 A configuration using &%file%& is commonly used for handling users'
20888 &_.forward_& files, like this:
20889 .code
20890 userforward:
20891   driver = redirect
20892   check_local_user
20893   file = $home/.forward
20894   no_verify
20895 .endd
20896 If the file does not exist, or causes no action to be taken (for example, it is
20897 empty or consists only of comments), the router declines. &*Warning*&: This
20898 is not the case when the file contains syntactically valid items that happen to
20899 yield empty addresses, for example, items containing only RFC 2822 address
20900 comments.
20901
20902 .new
20903 .cindex "tainted data" "in filenames"
20904 .cindex redirect "tainted data"
20905 Tainted data may not be used for a filename.
20906
20907 &*Warning*&: It is unwise to use &$local_part$& or &$domain$&
20908 directly for redirection,
20909 as they are provided by a potential attacker.
20910 In the examples above, &$local_part$& is used for looking up data held locally
20911 on the system, and not used directly (the second example derives &$home$& via
20912 the passsword file or database, using &$local_part$&).
20913 .wen
20914
20915
20916
20917 .section "Forward files and address verification" "SECID125"
20918 .cindex "address redirection" "while verifying"
20919 It is usual to set &%no_verify%& on &(redirect)& routers which handle users'
20920 &_.forward_& files, as in the example above. There are two reasons for this:
20921
20922 .ilist
20923 When Exim is receiving an incoming SMTP message from a remote host, it is
20924 running under the Exim uid, not as root. Exim is unable to change uid to read
20925 the file as the user, and it may not be able to read it as the Exim user. So in
20926 practice the router may not be able to operate.
20927 .next
20928 However, even when the router can operate, the existence of a &_.forward_& file
20929 is unimportant when verifying an address. What should be checked is whether the
20930 local part is a valid user name or not. Cutting out the redirection processing
20931 saves some resources.
20932 .endlist
20933
20934
20935
20936
20937
20938
20939 .section "Interpreting redirection data" "SECID126"
20940 .cindex "Sieve filter" "specifying in redirection data"
20941 .cindex "filter" "specifying in redirection data"
20942 The contents of the data string, whether obtained from &%data%& or &%file%&,
20943 can be interpreted in two different ways:
20944
20945 .ilist
20946 If the &%allow_filter%& option is set true, and the data begins with the text
20947 &"#Exim filter"& or &"#Sieve filter"&, it is interpreted as a list of
20948 &'filtering'& instructions in the form of an Exim or Sieve filter file,
20949 respectively. Details of the syntax and semantics of filter files are described
20950 in a separate document entitled &'Exim's interfaces to mail filtering'&; this
20951 document is intended for use by end users.
20952 .next
20953 Otherwise, the data must be a comma-separated list of redirection items, as
20954 described in the next section.
20955 .endlist
20956
20957 When a message is redirected to a file (a &"mail folder"&), the filename given
20958 in a non-filter redirection list must always be an absolute path. A filter may
20959 generate a relative path &-- how this is handled depends on the transport's
20960 configuration. See section &<<SECTfildiropt>>& for a discussion of this issue
20961 for the &(appendfile)& transport.
20962
20963
20964
20965 .section "Items in a non-filter redirection list" "SECTitenonfilred"
20966 .cindex "address redirection" "non-filter list items"
20967 When the redirection data is not an Exim or Sieve filter, for example, if it
20968 comes from a conventional alias or forward file, it consists of a list of
20969 addresses, filenames, pipe commands, or certain special items (see section
20970 &<<SECTspecitredli>>& below). The special items can be individually enabled or
20971 disabled by means of options whose names begin with &%allow_%& or &%forbid_%&,
20972 depending on their default values. The items in the list are separated by
20973 commas or newlines.
20974 If a comma is required in an item, the entire item must be enclosed in double
20975 quotes.
20976
20977 Lines starting with a # character are comments, and are ignored, and # may
20978 also appear following a comma, in which case everything between the # and the
20979 next newline character is ignored.
20980
20981 If an item is entirely enclosed in double quotes, these are removed. Otherwise
20982 double quotes are retained because some forms of mail address require their use
20983 (but never to enclose the entire address). In the following description,
20984 &"item"& refers to what remains after any surrounding double quotes have been
20985 removed.
20986
20987 .vindex "&$local_part$&"
20988 &*Warning*&: If you use an Exim expansion to construct a redirection address,
20989 and the expansion contains a reference to &$local_part$&, you should make use
20990 of the &%quote_local_part%& expansion operator, in case the local part contains
20991 special characters. For example, to redirect all mail for the domain
20992 &'obsolete.example'&, retaining the existing local part, you could use this
20993 setting:
20994 .code
20995 data = ${quote_local_part:$local_part}@newdomain.example
20996 .endd
20997
20998
20999 .section "Redirecting to a local mailbox" "SECTredlocmai"
21000 .cindex "routing" "loops in"
21001 .cindex "loop" "while routing, avoidance of"
21002 .cindex "address redirection" "to local mailbox"
21003 A redirection item may safely be the same as the address currently under
21004 consideration. This does not cause a routing loop, because a router is
21005 automatically skipped if any ancestor of the address that is being processed
21006 is the same as the current address and was processed by the current router.
21007 Such an address is therefore passed to the following routers, so it is handled
21008 as if there were no redirection. When making this loop-avoidance test, the
21009 complete local part, including any prefix or suffix, is used.
21010
21011 .cindex "address redirection" "local part without domain"
21012 Specifying the same local part without a domain is a common usage in personal
21013 filter files when the user wants to have messages delivered to the local
21014 mailbox and also forwarded elsewhere. For example, the user whose login is
21015 &'cleo'& might have a &_.forward_& file containing this:
21016 .code
21017 cleo, cleopatra@egypt.example
21018 .endd
21019 .cindex "backslash in alias file"
21020 .cindex "alias file" "backslash in"
21021 For compatibility with other MTAs, such unqualified local parts may be
21022 preceded by &"\"&, but this is not a requirement for loop prevention. However,
21023 it does make a difference if more than one domain is being handled
21024 synonymously.
21025
21026 If an item begins with &"\"& and the rest of the item parses as a valid RFC
21027 2822 address that does not include a domain, the item is qualified using the
21028 domain of the incoming address. In the absence of a leading &"\"&, unqualified
21029 addresses are qualified using the value in &%qualify_recipient%&, but you can
21030 force the incoming domain to be used by setting &%qualify_preserve_domain%&.
21031
21032 Care must be taken if there are alias names for local users.
21033 Consider an MTA handling a single local domain where the system alias file
21034 contains:
21035 .code
21036 Sam.Reman: spqr
21037 .endd
21038 Now suppose that Sam (whose login id is &'spqr'&) wants to save copies of
21039 messages in the local mailbox, and also forward copies elsewhere. He creates
21040 this forward file:
21041 .code
21042 Sam.Reman, spqr@reme.elsewhere.example
21043 .endd
21044 With these settings, an incoming message addressed to &'Sam.Reman'& fails. The
21045 &(redirect)& router for system aliases does not process &'Sam.Reman'& the
21046 second time round, because it has previously routed it,
21047 and the following routers presumably cannot handle the alias. The forward file
21048 should really contain
21049 .code
21050 spqr, spqr@reme.elsewhere.example
21051 .endd
21052 but because this is such a common error, the &%check_ancestor%& option (see
21053 below) exists to provide a way to get round it. This is normally set on a
21054 &(redirect)& router that is handling users' &_.forward_& files.
21055
21056
21057
21058 .section "Special items in redirection lists" "SECTspecitredli"
21059 In addition to addresses, the following types of item may appear in redirection
21060 lists (that is, in non-filter redirection data):
21061
21062 .ilist
21063 .cindex "pipe" "in redirection list"
21064 .cindex "address redirection" "to pipe"
21065 An item is treated as a pipe command if it begins with &"|"& and does not parse
21066 as a valid RFC 2822 address that includes a domain. A transport for running the
21067 command must be specified by the &%pipe_transport%& option.
21068 Normally, either the router or the transport specifies a user and a group under
21069 which to run the delivery. The default is to use the Exim user and group.
21070
21071 Single or double quotes can be used for enclosing the individual arguments of
21072 the pipe command; no interpretation of escapes is done for single quotes. If
21073 the command contains a comma character, it is necessary to put the whole item
21074 in double quotes, for example:
21075 .code
21076 "|/some/command ready,steady,go"
21077 .endd
21078 since items in redirection lists are terminated by commas. Do not, however,
21079 quote just the command. An item such as
21080 .code
21081 |"/some/command ready,steady,go"
21082 .endd
21083 is interpreted as a pipe with a rather strange command name, and no arguments.
21084
21085 Note that the above example assumes that the text comes from a lookup source
21086 of some sort, so that the quotes are part of the data.  If composing a
21087 redirect router with a &%data%& option directly specifying this command, the
21088 quotes will be used by the configuration parser to define the extent of one
21089 string, but will not be passed down into the redirect router itself.  There
21090 are two main approaches to get around this: escape quotes to be part of the
21091 data itself, or avoid using this mechanism and instead create a custom
21092 transport with the &%command%& option set and reference that transport from
21093 an &%accept%& router.
21094
21095 .next
21096 .cindex "file" "in redirection list"
21097 .cindex "address redirection" "to file"
21098 An item is interpreted as a path name if it begins with &"/"& and does not
21099 parse as a valid RFC 2822 address that includes a domain. For example,
21100 .code
21101 /home/world/minbari
21102 .endd
21103 is treated as a filename, but
21104 .code
21105 /s=molari/o=babylon/@x400gate.way
21106 .endd
21107 is treated as an address. For a filename, a transport must be specified using
21108 the &%file_transport%& option. However, if the generated path name ends with a
21109 forward slash character, it is interpreted as a directory name rather than a
21110 filename, and &%directory_transport%& is used instead.
21111
21112 Normally, either the router or the transport specifies a user and a group under
21113 which to run the delivery. The default is to use the Exim user and group.
21114
21115 .cindex "&_/dev/null_&"
21116 However, if a redirection item is the path &_/dev/null_&, delivery to it is
21117 bypassed at a high level, and the log entry shows &"**bypassed**"&
21118 instead of a transport name. In this case the user and group are not used.
21119
21120 .next
21121 .cindex "included address list"
21122 .cindex "address redirection" "included external list"
21123 If an item is of the form
21124 .code
21125 :include:<path name>
21126 .endd
21127 a list of further items is taken from the given file and included at that
21128 point. &*Note*&: Such a file can not be a filter file; it is just an
21129 out-of-line addition to the list. The items in the included list are separated
21130 by commas or newlines and are not subject to expansion. If this is the first
21131 item in an alias list in an &(lsearch)& file, a colon must be used to terminate
21132 the alias name. This example is incorrect:
21133 .code
21134 list1    :include:/opt/lists/list1
21135 .endd
21136 It must be given as
21137 .code
21138 list1:   :include:/opt/lists/list1
21139 .endd
21140 .new
21141 .cindex "tainted data" "in filenames"
21142 .cindex redirect "tainted data"
21143 Tainted data may not be used for a filename.
21144 .wen
21145 .next
21146 .cindex "address redirection" "to black hole"
21147 .cindex "delivery" "discard"
21148 .cindex "delivery" "blackhole"
21149 .cindex "black hole"
21150 .cindex "abandoning mail"
21151 Sometimes you want to throw away mail to a particular local part.  Making the
21152 &%data%& option expand to an empty string does not work, because that causes
21153 the router to decline. Instead, the alias item
21154 .code
21155 :blackhole:
21156 .endd
21157 can be used. It does what its name implies. No delivery is
21158 done, and no error message is generated. This has the same effect as specifying
21159 &_/dev/null_& as a destination, but it can be independently disabled.
21160
21161 &*Warning*&: If &':blackhole:'& appears anywhere in a redirection list, no
21162 delivery is done for the original local part, even if other redirection items
21163 are present. If you are generating a multi-item list (for example, by reading a
21164 database) and need the ability to provide a no-op item, you must use
21165 &_/dev/null_&.
21166
21167 .next
21168 .cindex "delivery" "forcing failure"
21169 .cindex "delivery" "forcing deferral"
21170 .cindex "failing delivery" "forcing"
21171 .cindex "deferred delivery, forcing"
21172 .cindex "customizing" "failure message"
21173 An attempt to deliver a particular address can be deferred or forced to fail by
21174 redirection items of the form
21175 .code
21176 :defer:
21177 :fail:
21178 .endd
21179 respectively. When a redirection list contains such an item, it applies
21180 to the entire redirection; any other items in the list are ignored. Any
21181 text following &':fail:'& or &':defer:'& is placed in the error text
21182 associated with the failure. For example, an alias file might contain:
21183 .code
21184 X.Employee:  :fail: Gone away, no forwarding address
21185 .endd
21186 In the case of an address that is being verified from an ACL or as the subject
21187 of a
21188 .cindex "VRFY" "error text, display of"
21189 VRFY command, the text is included in the SMTP error response by
21190 default.
21191 .cindex "EXPN" "error text, display of"
21192 The text is not included in the response to an EXPN command. In non-SMTP cases
21193 the text is included in the error message that Exim generates.
21194
21195 .cindex "SMTP" "error codes"
21196 By default, Exim sends a 451 SMTP code for a &':defer:'&, and 550 for
21197 &':fail:'&. However, if the message starts with three digits followed by a
21198 space, optionally followed by an extended code of the form &'n.n.n'&, also
21199 followed by a space, and the very first digit is the same as the default error
21200 code, the code from the message is used instead. If the very first digit is
21201 incorrect, a panic error is logged, and the default code is used. You can
21202 suppress the use of the supplied code in a redirect router by setting the
21203 &%forbid_smtp_code%& option true. In this case, any SMTP code is quietly
21204 ignored.
21205
21206 .vindex "&$acl_verify_message$&"
21207 In an ACL, an explicitly provided message overrides the default, but the
21208 default message is available in the variable &$acl_verify_message$& and can
21209 therefore be included in a custom message if this is desired.
21210
21211 Normally the error text is the rest of the redirection list &-- a comma does
21212 not terminate it &-- but a newline does act as a terminator. Newlines are not
21213 normally present in alias expansions. In &(lsearch)& lookups they are removed
21214 as part of the continuation process, but they may exist in other kinds of
21215 lookup and in &':include:'& files.
21216
21217 During routing for message delivery (as opposed to verification), a redirection
21218 containing &':fail:'& causes an immediate failure of the incoming address,
21219 whereas &':defer:'& causes the message to remain in the queue so that a
21220 subsequent delivery attempt can happen at a later time. If an address is
21221 deferred for too long, it will ultimately fail, because the normal retry
21222 rules still apply.
21223
21224 .next
21225 .cindex "alias file" "exception to default"
21226 Sometimes it is useful to use a single-key search type with a default (see
21227 chapter &<<CHAPfdlookup>>&) to look up aliases. However, there may be a need
21228 for exceptions to the default. These can be handled by aliasing them to
21229 &':unknown:'&. This differs from &':fail:'& in that it causes the &(redirect)&
21230 router to decline, whereas &':fail:'& forces routing to fail. A lookup which
21231 results in an empty redirection list has the same effect.
21232 .endlist
21233
21234
21235 .section "Duplicate addresses" "SECTdupaddr"
21236 .cindex "duplicate addresses"
21237 .cindex "address duplicate, discarding"
21238 .cindex "pipe" "duplicated"
21239 Exim removes duplicate addresses from the list to which it is delivering, so as
21240 to deliver just one copy to each address. This does not apply to deliveries
21241 routed to pipes by different immediate parent addresses, but an indirect
21242 aliasing scheme of the type
21243 .code
21244 pipe:       |/some/command $local_part
21245 localpart1: pipe
21246 localpart2: pipe
21247 .endd
21248 does not work with a message that is addressed to both local parts, because
21249 when the second is aliased to the intermediate local part &"pipe"& it gets
21250 discarded as being the same as a previously handled address. However, a scheme
21251 such as
21252 .code
21253 localpart1: |/some/command $local_part
21254 localpart2: |/some/command $local_part
21255 .endd
21256 does result in two different pipe deliveries, because the immediate parents of
21257 the pipes are distinct.
21258
21259
21260
21261 .section "Repeated redirection expansion" "SECID128"
21262 .cindex "repeated redirection expansion"
21263 .cindex "address redirection" "repeated for each delivery attempt"
21264 When a message cannot be delivered to all of its recipients immediately,
21265 leading to two or more delivery attempts, redirection expansion is carried out
21266 afresh each time for those addresses whose children were not all previously
21267 delivered. If redirection is being used as a mailing list, this can lead to new
21268 members of the list receiving copies of old messages. The &%one_time%& option
21269 can be used to avoid this.
21270
21271
21272 .section "Errors in redirection lists" "SECID129"
21273 .cindex "address redirection" "errors"
21274 If &%skip_syntax_errors%& is set, a malformed address that causes a parsing
21275 error is skipped, and an entry is written to the main log. This may be useful
21276 for mailing lists that are automatically managed. Otherwise, if an error is
21277 detected while generating the list of new addresses, the original address is
21278 deferred. See also &%syntax_errors_to%&.
21279
21280
21281
21282 .section "Private options for the redirect router" "SECID130"
21283
21284 .cindex "options" "&(redirect)& router"
21285 The private options for the &(redirect)& router are as follows:
21286
21287
21288 .option allow_defer redirect boolean false
21289 Setting this option allows the use of &':defer:'& in non-filter redirection
21290 data, or the &%defer%& command in an Exim filter file.
21291
21292
21293 .option allow_fail redirect boolean false
21294 .cindex "failing delivery" "from filter"
21295 If this option is true, the &':fail:'& item can be used in a redirection list,
21296 and the &%fail%& command may be used in an Exim filter file.
21297
21298
21299 .option allow_filter redirect boolean false
21300 .cindex "filter" "enabling use of"
21301 .cindex "Sieve filter" "enabling use of"
21302 Setting this option allows Exim to interpret redirection data that starts with
21303 &"#Exim filter"& or &"#Sieve filter"& as a set of filtering instructions. There
21304 are some features of Exim filter files that some administrators may wish to
21305 lock out; see the &%forbid_filter_%&&'xxx'& options below.
21306
21307 It is also possible to lock out Exim filters or Sieve filters while allowing
21308 the other type; see &%forbid_exim_filter%& and &%forbid_sieve_filter%&.
21309
21310
21311 The filter is run using the uid and gid set by the generic &%user%& and
21312 &%group%& options. These take their defaults from the password data if
21313 &%check_local_user%& is set, so in the normal case of users' personal filter
21314 files, the filter is run as the relevant user. When &%allow_filter%& is set
21315 true, Exim insists that either &%check_local_user%& or &%user%& is set.
21316
21317
21318
21319 .option allow_freeze redirect boolean false
21320 .cindex "freezing messages" "allowing in filter"
21321 Setting this option allows the use of the &%freeze%& command in an Exim filter.
21322 This command is more normally encountered in system filters, and is disabled by
21323 default for redirection filters because it isn't something you usually want to
21324 let ordinary users do.
21325
21326
21327
21328 .option check_ancestor redirect boolean false
21329 This option is concerned with handling generated addresses that are the same
21330 as some address in the list of redirection ancestors of the current address.
21331 Although it is turned off by default in the code, it is set in the default
21332 configuration file for handling users' &_.forward_& files. It is recommended
21333 for this use of the &(redirect)& router.
21334
21335 When &%check_ancestor%& is set, if a generated address (including the domain)
21336 is the same as any ancestor of the current address, it is replaced by a copy of
21337 the current address. This helps in the case where local part A is aliased to B,
21338 and B has a &_.forward_& file pointing back to A. For example, within a single
21339 domain, the local part &"Joe.Bloggs"& is aliased to &"jb"& and
21340 &_&~jb/.forward_& contains:
21341 .code
21342 \Joe.Bloggs, <other item(s)>
21343 .endd
21344 Without the &%check_ancestor%& setting, either local part (&"jb"& or
21345 &"joe.bloggs"&) gets processed once by each router and so ends up as it was
21346 originally. If &"jb"& is the real mailbox name, mail to &"jb"& gets delivered
21347 (having been turned into &"joe.bloggs"& by the &_.forward_& file and back to
21348 &"jb"& by the alias), but mail to &"joe.bloggs"& fails. Setting
21349 &%check_ancestor%& on the &(redirect)& router that handles the &_.forward_&
21350 file prevents it from turning &"jb"& back into &"joe.bloggs"& when that was the
21351 original address. See also the &%repeat_use%& option below.
21352
21353
21354 .option check_group redirect boolean "see below"
21355 When the &%file%& option is used, the group owner of the file is checked only
21356 when this option is set. The permitted groups are those listed in the
21357 &%owngroups%& option, together with the user's default group if
21358 &%check_local_user%& is set. If the file has the wrong group, routing is
21359 deferred. The default setting for this option is true if &%check_local_user%&
21360 is set and the &%modemask%& option permits the group write bit, or if the
21361 &%owngroups%& option is set. Otherwise it is false, and no group check occurs.
21362
21363
21364
21365 .option check_owner redirect boolean "see below"
21366 When the &%file%& option is used, the owner of the file is checked only when
21367 this option is set. If &%check_local_user%& is set, the local user is
21368 permitted; otherwise the owner must be one of those listed in the &%owners%&
21369 option. The default value for this option is true if &%check_local_user%& or
21370 &%owners%& is set. Otherwise the default is false, and no owner check occurs.
21371
21372
21373 .option data redirect string&!! unset
21374 This option is mutually exclusive with &%file%&. One or other of them must be
21375 set, but not both. The contents of &%data%& are expanded, and then used as the
21376 list of forwarding items, or as a set of filtering instructions. If the
21377 expansion is forced to fail, or the result is an empty string or a string that
21378 has no effect (consists entirely of comments), the router declines.
21379
21380 When filtering instructions are used, the string must begin with &"#Exim
21381 filter"&, and all comments in the string, including this initial one, must be
21382 terminated with newline characters. For example:
21383 .code
21384 data = #Exim filter\n\
21385        if $h_to: contains Exim then save $home/mail/exim endif
21386 .endd
21387 If you are reading the data from a database where newlines cannot be included,
21388 you can use the &${sg}$& expansion item to turn the escape string of your
21389 choice into a newline.
21390
21391
21392 .option directory_transport redirect string&!! unset
21393 A &(redirect)& router sets up a direct delivery to a directory when a path name
21394 ending with a slash is specified as a new &"address"&. The transport used is
21395 specified by this option, which, after expansion, must be the name of a
21396 configured transport. This should normally be an &(appendfile)& transport.
21397
21398
21399 .option file redirect string&!! unset
21400 This option specifies the name of a file that contains the redirection data. It
21401 is mutually exclusive with the &%data%& option. The string is expanded before
21402 use; if the expansion is forced to fail, the router declines. Other expansion
21403 failures cause delivery to be deferred. The result of a successful expansion
21404 must be an absolute path. The entire file is read and used as the redirection
21405 data. If the data is an empty string or a string that has no effect (consists
21406 entirely of comments), the router declines.
21407
21408 .cindex "NFS" "checking for file existence"
21409 If the attempt to open the file fails with a &"does not exist"& error, Exim
21410 runs a check on the containing directory,
21411 unless &%ignore_enotdir%& is true (see below).
21412 If the directory does not appear to exist, delivery is deferred. This can
21413 happen when users' &_.forward_& files are in NFS-mounted directories, and there
21414 is a mount problem. If the containing directory does exist, but the file does
21415 not, the router declines.
21416
21417
21418 .option file_transport redirect string&!! unset
21419 .vindex "&$address_file$&"
21420 A &(redirect)& router sets up a direct delivery to a file when a path name not
21421 ending in a slash is specified as a new &"address"&. The transport used is
21422 specified by this option, which, after expansion, must be the name of a
21423 configured transport. This should normally be an &(appendfile)& transport. When
21424 it is running, the filename is in &$address_file$&.
21425
21426
21427 .option filter_prepend_home redirect boolean true
21428 When this option is true, if a &(save)& command in an Exim filter specifies a
21429 relative path, and &$home$& is defined, it is automatically prepended to the
21430 relative path. If this option is set false, this action does not happen. The
21431 relative path is then passed to the transport unmodified.
21432
21433
21434 .option forbid_blackhole redirect boolean false
21435 .cindex "restricting access to features"
21436 .cindex "filter" "locking out certain features"
21437 If this option is true, the &':blackhole:'& item may not appear in a
21438 redirection list.
21439
21440
21441 .option forbid_exim_filter redirect boolean false
21442 .cindex "restricting access to features"
21443 .cindex "filter" "locking out certain features"
21444 If this option is set true, only Sieve filters are permitted when
21445 &%allow_filter%& is true.
21446
21447
21448
21449
21450 .option forbid_file redirect boolean false
21451 .cindex "restricting access to features"
21452 .cindex "delivery" "to file; forbidding"
21453 .cindex "filter" "locking out certain features"
21454 .cindex "Sieve filter" "forbidding delivery to a file"
21455 .cindex "Sieve filter" "&""keep""& facility; disabling"
21456 If this option is true, this router may not generate a new address that
21457 specifies delivery to a local file or directory, either from a filter or from a
21458 conventional forward file. This option is forced to be true if &%one_time%& is
21459 set. It applies to Sieve filters as well as to Exim filters, but if true, it
21460 locks out the Sieve's &"keep"& facility.
21461
21462
21463 .option forbid_filter_dlfunc redirect boolean false
21464 .cindex "restricting access to features"
21465 .cindex "filter" "locking out certain features"
21466 If this option is true, string expansions in Exim filters are not allowed to
21467 make use of the &%dlfunc%& expansion facility to run dynamically loaded
21468 functions.
21469
21470 .option forbid_filter_existstest redirect boolean false
21471 .cindex "restricting access to features"
21472 .cindex "filter" "locking out certain features"
21473 .cindex "expansion" "statting a file"
21474 If this option is true, string expansions in Exim filters are not allowed to
21475 make use of the &%exists%& condition or the &%stat%& expansion item.
21476
21477 .option forbid_filter_logwrite redirect boolean false
21478 .cindex "restricting access to features"
21479 .cindex "filter" "locking out certain features"
21480 If this option is true, use of the logging facility in Exim filters is not
21481 permitted. Logging is in any case available only if the filter is being run
21482 under some unprivileged uid (which is normally the case for ordinary users'
21483 &_.forward_& files).
21484
21485
21486 .option forbid_filter_lookup redirect boolean false
21487 .cindex "restricting access to features"
21488 .cindex "filter" "locking out certain features"
21489 If this option is true, string expansions in Exim filter files are not allowed
21490 to make use of &%lookup%& items.
21491
21492
21493 .option forbid_filter_perl redirect boolean false
21494 .cindex "restricting access to features"
21495 .cindex "filter" "locking out certain features"
21496 This option has an effect only if Exim is built with embedded Perl support. If
21497 it is true, string expansions in Exim filter files are not allowed to make use
21498 of the embedded Perl support.
21499
21500
21501 .option forbid_filter_readfile redirect boolean false
21502 .cindex "restricting access to features"
21503 .cindex "filter" "locking out certain features"
21504 If this option is true, string expansions in Exim filter files are not allowed
21505 to make use of &%readfile%& items.
21506
21507
21508 .option forbid_filter_readsocket redirect boolean false
21509 .cindex "restricting access to features"
21510 .cindex "filter" "locking out certain features"
21511 If this option is true, string expansions in Exim filter files are not allowed
21512 to make use of &%readsocket%& items.
21513
21514
21515 .option forbid_filter_reply redirect boolean false
21516 .cindex "restricting access to features"
21517 .cindex "filter" "locking out certain features"
21518 If this option is true, this router may not generate an automatic reply
21519 message. Automatic replies can be generated only from Exim or Sieve filter
21520 files, not from traditional forward files. This option is forced to be true if
21521 &%one_time%& is set.
21522
21523
21524 .option forbid_filter_run redirect boolean false
21525 .cindex "restricting access to features"
21526 .cindex "filter" "locking out certain features"
21527 If this option is true, string expansions in Exim filter files are not allowed
21528 to make use of &%run%& items.
21529
21530
21531 .option forbid_include redirect boolean false
21532 .cindex "restricting access to features"
21533 .cindex "filter" "locking out certain features"
21534 If this option is true, items of the form
21535 .code
21536 :include:<path name>
21537 .endd
21538 are not permitted in non-filter redirection lists.
21539
21540
21541 .option forbid_pipe redirect boolean false
21542 .cindex "restricting access to features"
21543 .cindex "filter" "locking out certain features"
21544 .cindex "delivery" "to pipe; forbidding"
21545 If this option is true, this router may not generate a new address which
21546 specifies delivery to a pipe, either from an Exim filter or from a conventional
21547 forward file. This option is forced to be true if &%one_time%& is set.
21548
21549
21550 .option forbid_sieve_filter redirect boolean false
21551 .cindex "restricting access to features"
21552 .cindex "filter" "locking out certain features"
21553 If this option is set true, only Exim filters are permitted when
21554 &%allow_filter%& is true.
21555
21556
21557 .cindex "SMTP" "error codes"
21558 .option forbid_smtp_code redirect boolean false
21559 If this option is set true, any SMTP error codes that are present at the start
21560 of messages specified for &`:defer:`& or &`:fail:`& are quietly ignored, and
21561 the default codes (451 and 550, respectively) are always used.
21562
21563
21564
21565
21566 .option hide_child_in_errmsg redirect boolean false
21567 .cindex "bounce message" "redirection details; suppressing"
21568 If this option is true, it prevents Exim from quoting a child address if it
21569 generates a bounce or delay message for it. Instead it says &"an address
21570 generated from <&'the top level address'&>"&. Of course, this applies only to
21571 bounces generated locally. If a message is forwarded to another host, &'its'&
21572 bounce may well quote the generated address.
21573
21574
21575 .option ignore_eacces redirect boolean false
21576 .cindex "EACCES"
21577 If this option is set and an attempt to open a redirection file yields the
21578 EACCES error (permission denied), the &(redirect)& router behaves as if the
21579 file did not exist.
21580
21581
21582 .option ignore_enotdir redirect boolean false
21583 .cindex "ENOTDIR"
21584 If this option is set and an attempt to open a redirection file yields the
21585 ENOTDIR error (something on the path is not a directory), the &(redirect)&
21586 router behaves as if the file did not exist.
21587
21588 Setting &%ignore_enotdir%& has another effect as well: When a &(redirect)&
21589 router that has the &%file%& option set discovers that the file does not exist
21590 (the ENOENT error), it tries to &[stat()]& the parent directory, as a check
21591 against unmounted NFS directories. If the parent can not be statted, delivery
21592 is deferred. However, it seems wrong to do this check when &%ignore_enotdir%&
21593 is set, because that option tells Exim to ignore &"something on the path is not
21594 a directory"& (the ENOTDIR error). This is a confusing area, because it seems
21595 that some operating systems give ENOENT where others give ENOTDIR.
21596
21597
21598
21599 .option include_directory redirect string unset
21600 If this option is set, the path names of any &':include:'& items in a
21601 redirection list must start with this directory.
21602
21603
21604 .option modemask redirect "octal integer" 022
21605 This specifies mode bits which must not be set for a file specified by the
21606 &%file%& option. If any of the forbidden bits are set, delivery is deferred.
21607
21608
21609 .option one_time redirect boolean false
21610 .cindex "one-time aliasing/forwarding expansion"
21611 .cindex "alias file" "one-time expansion"
21612 .cindex "forward file" "one-time expansion"
21613 .cindex "mailing lists" "one-time expansion"
21614 .cindex "address redirection" "one-time expansion"
21615 Sometimes the fact that Exim re-evaluates aliases and reprocesses redirection
21616 files each time it tries to deliver a message causes a problem when one or more
21617 of the generated addresses fails be delivered at the first attempt. The problem
21618 is not one of duplicate delivery &-- Exim is clever enough to handle that &--
21619 but of what happens when the redirection list changes during the time that the
21620 message is on Exim's queue. This is particularly true in the case of mailing
21621 lists, where new subscribers might receive copies of messages that were posted
21622 before they subscribed.
21623
21624 If &%one_time%& is set and any addresses generated by the router fail to
21625 deliver at the first attempt, the failing addresses are added to the message as
21626 &"top level"& addresses, and the parent address that generated them is marked
21627 &"delivered"&. Thus, redirection does not happen again at the next delivery
21628 attempt.
21629
21630 &*Warning 1*&: Any header line addition or removal that is specified by this
21631 router would be lost if delivery did not succeed at the first attempt. For this
21632 reason, the &%headers_add%& and &%headers_remove%& generic options are not
21633 permitted when &%one_time%& is set.
21634
21635 &*Warning 2*&: To ensure that the router generates only addresses (as opposed
21636 to pipe or file deliveries or auto-replies) &%forbid_file%&, &%forbid_pipe%&,
21637 and &%forbid_filter_reply%& are forced to be true when &%one_time%& is set.
21638
21639 &*Warning 3*&: The &%unseen%& generic router option may not be set with
21640 &%one_time%&.
21641
21642 The original top-level address is remembered with each of the generated
21643 addresses, and is output in any log messages. However, any intermediate parent
21644 addresses are not recorded. This makes a difference to the log only if
21645 &%all_parents%& log selector is set. It is expected that &%one_time%& will
21646 typically be used for mailing lists, where there is normally just one level of
21647 expansion.
21648
21649
21650 .option owners redirect "string list" unset
21651 .cindex "ownership" "alias file"
21652 .cindex "ownership" "forward file"
21653 .cindex "alias file" "ownership"
21654 .cindex "forward file" "ownership"
21655 This specifies a list of permitted owners for the file specified by &%file%&.
21656 This list is in addition to the local user when &%check_local_user%& is set.
21657 See &%check_owner%& above.
21658
21659
21660 .option owngroups redirect "string list" unset
21661 This specifies a list of permitted groups for the file specified by &%file%&.
21662 The list is in addition to the local user's primary group when
21663 &%check_local_user%& is set. See &%check_group%& above.
21664
21665
21666 .option pipe_transport redirect string&!! unset
21667 .vindex "&$address_pipe$&"
21668 A &(redirect)& router sets up a direct delivery to a pipe when a string
21669 starting with a vertical bar character is specified as a new &"address"&. The
21670 transport used is specified by this option, which, after expansion, must be the
21671 name of a configured transport. This should normally be a &(pipe)& transport.
21672 When the transport is run, the pipe command is in &$address_pipe$&.
21673
21674
21675 .option qualify_domain redirect string&!! unset
21676 .vindex "&$qualify_recipient$&"
21677 If this option is set, and an unqualified address (one without a domain) is
21678 generated, and that address would normally be qualified by the global setting
21679 in &%qualify_recipient%&, it is instead qualified with the domain specified by
21680 expanding this string. If the expansion fails, the router declines. If you want
21681 to revert to the default, you can have the expansion generate
21682 &$qualify_recipient$&.
21683
21684 This option applies to all unqualified addresses generated by Exim filters,
21685 but for traditional &_.forward_& files, it applies only to addresses that are
21686 not preceded by a backslash. Sieve filters cannot generate unqualified
21687 addresses.
21688
21689 .option qualify_preserve_domain redirect boolean false
21690 .cindex "domain" "in redirection; preserving"
21691 .cindex "preserving domain in redirection"
21692 .cindex "address redirection" "domain; preserving"
21693 If this option is set, the router's local &%qualify_domain%& option must not be
21694 set (a configuration error occurs if it is). If an unqualified address (one
21695 without a domain) is generated, it is qualified with the domain of the parent
21696 address (the immediately preceding ancestor) instead of the global
21697 &%qualify_recipient%& value. In the case of a traditional &_.forward_& file,
21698 this applies whether or not the address is preceded by a backslash.
21699
21700
21701 .option repeat_use redirect boolean true
21702 If this option is set false, the router is skipped for a child address that has
21703 any ancestor that was routed by this router. This test happens before any of
21704 the other preconditions are tested. Exim's default anti-looping rules skip
21705 only when the ancestor is the same as the current address. See also
21706 &%check_ancestor%& above and the generic &%redirect_router%& option.
21707
21708
21709 .option reply_transport redirect string&!! unset
21710 A &(redirect)& router sets up an automatic reply when a &%mail%& or
21711 &%vacation%& command is used in a filter file. The transport used is specified
21712 by this option, which, after expansion, must be the name of a configured
21713 transport. This should normally be an &(autoreply)& transport. Other transports
21714 are unlikely to do anything sensible or useful.
21715
21716
21717 .option rewrite redirect boolean true
21718 .cindex "address redirection" "disabling rewriting"
21719 If this option is set false, addresses generated by the router are not
21720 subject to address rewriting. Otherwise, they are treated like new addresses
21721 and are rewritten according to the global rewriting rules.
21722
21723
21724 .option sieve_subaddress redirect string&!! unset
21725 The value of this option is passed to a Sieve filter to specify the
21726 :subaddress part of an address.
21727
21728 .option sieve_useraddress redirect string&!! unset
21729 The value of this option is passed to a Sieve filter to specify the :user part
21730 of an address. However, if it is unset, the entire original local part
21731 (including any prefix or suffix) is used for :user.
21732
21733
21734 .option sieve_vacation_directory redirect string&!! unset
21735 .cindex "Sieve filter" "vacation directory"
21736 To enable the &"vacation"& extension for Sieve filters, you must set
21737 &%sieve_vacation_directory%& to the directory where vacation databases are held
21738 (do not put anything else in that directory), and ensure that the
21739 &%reply_transport%& option refers to an &(autoreply)& transport. Each user
21740 needs their own directory; Exim will create it if necessary.
21741
21742
21743
21744 .option skip_syntax_errors redirect boolean false
21745 .cindex "forward file" "broken"
21746 .cindex "address redirection" "broken files"
21747 .cindex "alias file" "broken"
21748 .cindex "broken alias or forward files"
21749 .cindex "ignoring faulty addresses"
21750 .cindex "skipping faulty addresses"
21751 .cindex "error" "skipping bad syntax"
21752 If &%skip_syntax_errors%& is set, syntactically malformed addresses in
21753 non-filter redirection data are skipped, and each failing address is logged. If
21754 &%syntax_errors_to%& is set, a message is sent to the address it defines,
21755 giving details of the failures. If &%syntax_errors_text%& is set, its contents
21756 are expanded and placed at the head of the error message generated by
21757 &%syntax_errors_to%&. Usually it is appropriate to set &%syntax_errors_to%& to
21758 be the same address as the generic &%errors_to%& option. The
21759 &%skip_syntax_errors%& option is often used when handling mailing lists.
21760
21761 If all the addresses in a redirection list are skipped because of syntax
21762 errors, the router declines to handle the original address, and it is passed to
21763 the following routers.
21764
21765 If &%skip_syntax_errors%& is set when an Exim filter is interpreted, any syntax
21766 error in the filter causes filtering to be abandoned without any action being
21767 taken. The incident is logged, and the router declines to handle the address,
21768 so it is passed to the following routers.
21769
21770 .cindex "Sieve filter" "syntax errors in"
21771 Syntax errors in a Sieve filter file cause the &"keep"& action to occur. This
21772 action is specified by RFC 3028. The values of &%skip_syntax_errors%&,
21773 &%syntax_errors_to%&, and &%syntax_errors_text%& are not used.
21774
21775 &%skip_syntax_errors%& can be used to specify that errors in users' forward
21776 lists or filter files should not prevent delivery. The &%syntax_errors_to%&
21777 option, used with an address that does not get redirected, can be used to
21778 notify users of these errors, by means of a router like this:
21779 .code
21780 userforward:
21781   driver = redirect
21782   allow_filter
21783   check_local_user
21784   file = $home/.forward
21785   file_transport = address_file
21786   pipe_transport = address_pipe
21787   reply_transport = address_reply
21788   no_verify
21789   skip_syntax_errors
21790   syntax_errors_to = real-$local_part@$domain
21791   syntax_errors_text = \
21792    This is an automatically generated message. An error has\n\
21793    been found in your .forward file. Details of the error are\n\
21794    reported below. While this error persists, you will receive\n\
21795    a copy of this message for every message that is addressed\n\
21796    to you. If your .forward file is a filter file, or if it is\n\
21797    a non-filter file containing no valid forwarding addresses,\n\
21798    a copy of each incoming message will be put in your normal\n\
21799    mailbox. If a non-filter file contains at least one valid\n\
21800    forwarding address, forwarding to the valid addresses will\n\
21801    happen, and those will be the only deliveries that occur.
21802 .endd
21803 You also need a router to ensure that local addresses that are prefixed by
21804 &`real-`& are recognized, but not forwarded or filtered. For example, you could
21805 put this immediately before the &(userforward)& router:
21806 .code
21807 real_localuser:
21808   driver = accept
21809   check_local_user
21810   local_part_prefix = real-
21811   transport = local_delivery
21812 .endd
21813 For security, it would probably be a good idea to restrict the use of this
21814 router to locally-generated messages, using a condition such as this:
21815 .code
21816   condition = ${if match {$sender_host_address}\
21817                          {\N^(|127\.0\.0\.1)$\N}}
21818 .endd
21819
21820
21821 .option syntax_errors_text redirect string&!! unset
21822 See &%skip_syntax_errors%& above.
21823
21824
21825 .option syntax_errors_to redirect string unset
21826 See &%skip_syntax_errors%& above.
21827 .ecindex IIDredrou1
21828 .ecindex IIDredrou2
21829
21830
21831
21832
21833
21834
21835 . ////////////////////////////////////////////////////////////////////////////
21836 . ////////////////////////////////////////////////////////////////////////////
21837
21838 .chapter "Environment for running local transports" "CHAPenvironment" &&&
21839          "Environment for local transports"
21840 .scindex IIDenvlotra1 "local transports" "environment for"
21841 .scindex IIDenvlotra2 "environment" "local transports"
21842 .scindex IIDenvlotra3 "transport" "local; environment for"
21843 Local transports handle deliveries to files and pipes. (The &(autoreply)&
21844 transport can be thought of as similar to a pipe.) Exim always runs transports
21845 in subprocesses, under specified uids and gids. Typical deliveries to local
21846 mailboxes run under the uid and gid of the local user.
21847
21848 Exim also sets a specific current directory while running the transport; for
21849 some transports a home directory setting is also relevant. The &(pipe)&
21850 transport is the only one that sets up environment variables; see section
21851 &<<SECTpipeenv>>& for details.
21852
21853 The values used for the uid, gid, and the directories may come from several
21854 different places. In many cases, the router that handles the address associates
21855 settings with that address as a result of its &%check_local_user%&, &%group%&,
21856 or &%user%& options. However, values may also be given in the transport's own
21857 configuration, and these override anything that comes from the router.
21858
21859
21860
21861 .section "Concurrent deliveries" "SECID131"
21862 .cindex "concurrent deliveries"
21863 .cindex "simultaneous deliveries"
21864 If two different messages for the same local recipient arrive more or less
21865 simultaneously, the two delivery processes are likely to run concurrently. When
21866 the &(appendfile)& transport is used to write to a file, Exim applies locking
21867 rules to stop concurrent processes from writing to the same file at the same
21868 time.
21869
21870 However, when you use a &(pipe)& transport, it is up to you to arrange any
21871 locking that is needed. Here is a silly example:
21872 .code
21873 my_transport:
21874   driver = pipe
21875   command = /bin/sh -c 'cat >>/some/file'
21876 .endd
21877 This is supposed to write the message at the end of the file. However, if two
21878 messages arrive at the same time, the file will be scrambled. You can use the
21879 &%exim_lock%& utility program (see section &<<SECTmailboxmaint>>&) to lock a
21880 file using the same algorithm that Exim itself uses.
21881
21882
21883
21884
21885 .section "Uids and gids" "SECTenvuidgid"
21886 .cindex "local transports" "uid and gid"
21887 .cindex "transport" "local; uid and gid"
21888 All transports have the options &%group%& and &%user%&. If &%group%& is set, it
21889 overrides any group that the router set in the address, even if &%user%& is not
21890 set for the transport. This makes it possible, for example, to run local mail
21891 delivery under the uid of the recipient (set by the router), but in a special
21892 group (set by the transport). For example:
21893 .code
21894 # Routers ...
21895 # User/group are set by check_local_user in this router
21896 local_users:
21897   driver = accept
21898   check_local_user
21899   transport = group_delivery
21900
21901 # Transports ...
21902 # This transport overrides the group
21903 group_delivery:
21904   driver = appendfile
21905   file = /var/spool/mail/$local_part_data
21906   group = mail
21907 .endd
21908 If &%user%& is set for a transport, its value overrides what is set in the
21909 address by the router. If &%user%& is non-numeric and &%group%& is not set, the
21910 gid associated with the user is used. If &%user%& is numeric, &%group%& must be
21911 set.
21912
21913 .oindex "&%initgroups%&"
21914 When the uid is taken from the transport's configuration, the &[initgroups()]&
21915 function is called for the groups associated with that uid if the
21916 &%initgroups%& option is set for the transport. When the uid is not specified
21917 by the transport, but is associated with the address by a router, the option
21918 for calling &[initgroups()]& is taken from the router configuration.
21919
21920 .cindex "&(pipe)& transport" "uid for"
21921 The &(pipe)& transport contains the special option &%pipe_as_creator%&. If this
21922 is set and &%user%& is not set, the uid of the process that called Exim to
21923 receive the message is used, and if &%group%& is not set, the corresponding
21924 original gid is also used.
21925
21926 This is the detailed preference order for obtaining a gid; the first of the
21927 following that is set is used:
21928
21929 .ilist
21930 A &%group%& setting of the transport;
21931 .next
21932 A &%group%& setting of the router;
21933 .next
21934 A gid associated with a user setting of the router, either as a result of
21935 &%check_local_user%& or an explicit non-numeric &%user%& setting;
21936 .next
21937 The group associated with a non-numeric &%user%& setting of the transport;
21938 .next
21939 In a &(pipe)& transport, the creator's gid if &%deliver_as_creator%& is set and
21940 the uid is the creator's uid;
21941 .next
21942 The Exim gid if the Exim uid is being used as a default.
21943 .endlist
21944
21945 If, for example, the user is specified numerically on the router and there are
21946 no group settings, no gid is available. In this situation, an error occurs.
21947 This is different for the uid, for which there always is an ultimate default.
21948 The first of the following that is set is used:
21949
21950 .ilist
21951 A &%user%& setting of the transport;
21952 .next
21953 In a &(pipe)& transport, the creator's uid if &%deliver_as_creator%& is set;
21954 .next
21955 A &%user%& setting of the router;
21956 .next
21957 A &%check_local_user%& setting of the router;
21958 .next
21959 The Exim uid.
21960 .endlist
21961
21962 Of course, an error will still occur if the uid that is chosen is on the
21963 &%never_users%& list.
21964
21965
21966
21967
21968
21969 .section "Current and home directories" "SECID132"
21970 .cindex "current directory for local transport"
21971 .cindex "home directory" "for local transport"
21972 .cindex "transport" "local; home directory for"
21973 .cindex "transport" "local; current directory for"
21974 Routers may set current and home directories for local transports by means of
21975 the &%transport_current_directory%& and &%transport_home_directory%& options.
21976 However, if the transport's &%current_directory%& or &%home_directory%& options
21977 are set, they override the router's values. In detail, the home directory
21978 for a local transport is taken from the first of these values that is set:
21979
21980 .ilist
21981 The &%home_directory%& option on the transport;
21982 .next
21983 The &%transport_home_directory%& option on the router;
21984 .next
21985 The password data if &%check_local_user%& is set on the router;
21986 .next
21987 The &%router_home_directory%& option on the router.
21988 .endlist
21989
21990 The current directory is taken from the first of these values that is set:
21991
21992 .ilist
21993 The &%current_directory%& option on the transport;
21994 .next
21995 The &%transport_current_directory%& option on the router.
21996 .endlist
21997
21998
21999 If neither the router nor the transport sets a current directory, Exim uses the
22000 value of the home directory, if it is set. Otherwise it sets the current
22001 directory to &_/_& before running a local transport.
22002
22003
22004
22005 .section "Expansion variables derived from the address" "SECID133"
22006 .vindex "&$domain$&"
22007 .vindex "&$local_part$&"
22008 .vindex "&$original_domain$&"
22009 Normally a local delivery is handling a single address, and in that case the
22010 variables such as &$domain$& and &$local_part$& are set during local
22011 deliveries. However, in some circumstances more than one address may be handled
22012 at once (for example, while writing batch SMTP for onward transmission by some
22013 other means). In this case, the variables associated with the local part are
22014 never set, &$domain$& is set only if all the addresses have the same domain,
22015 and &$original_domain$& is never set.
22016 .ecindex IIDenvlotra1
22017 .ecindex IIDenvlotra2
22018 .ecindex IIDenvlotra3
22019
22020
22021
22022
22023
22024
22025
22026 . ////////////////////////////////////////////////////////////////////////////
22027 . ////////////////////////////////////////////////////////////////////////////
22028
22029 .chapter "Generic options for transports" "CHAPtransportgeneric"
22030 .scindex IIDgenoptra1 "generic options" "transport"
22031 .scindex IIDgenoptra2 "options" "generic; for transports"
22032 .scindex IIDgenoptra3 "transport" "generic options for"
22033 The following generic options apply to all transports:
22034
22035
22036 .option body_only transports boolean false
22037 .cindex "transport" "body only"
22038 .cindex "message" "transporting body only"
22039 .cindex "body of message" "transporting"
22040 If this option is set, the message's headers are not transported. It is
22041 mutually exclusive with &%headers_only%&. If it is used with the &(appendfile)&
22042 or &(pipe)& transports, the settings of &%message_prefix%& and
22043 &%message_suffix%& should be checked, because this option does not
22044 automatically suppress them.
22045
22046
22047 .option current_directory transports string&!! unset
22048 .cindex "transport" "current directory for"
22049 This specifies the current directory that is to be set while running the
22050 transport, overriding any value that may have been set by the router.
22051 If the expansion fails for any reason, including forced failure, an error is
22052 logged, and delivery is deferred.
22053
22054
22055 .option disable_logging transports boolean false
22056 If this option is set true, nothing is logged for any
22057 deliveries by the transport or for any
22058 transport errors. You should not set this option unless you really, really know
22059 what you are doing.
22060
22061
22062 .option debug_print transports string&!! unset
22063 .cindex "testing" "variables in drivers"
22064 If this option is set and debugging is enabled (see the &%-d%& command line
22065 option), the string is expanded and included in the debugging output when the
22066 transport is run.
22067 If expansion of the string fails, the error message is written to the debugging
22068 output, and Exim carries on processing.
22069 This facility is provided to help with checking out the values of variables and
22070 so on when debugging driver configurations. For example, if a &%headers_add%&
22071 option is not working properly, &%debug_print%& could be used to output the
22072 variables it references. A newline is added to the text if it does not end with
22073 one.
22074 The variables &$transport_name$& and &$router_name$& contain the name of the
22075 transport and the router that called it.
22076
22077 .option delivery_date_add transports boolean false
22078 .cindex "&'Delivery-date:'& header line"
22079 If this option is true, a &'Delivery-date:'& header is added to the message.
22080 This gives the actual time the delivery was made. As this is not a standard
22081 header, Exim has a configuration option (&%delivery_date_remove%&) which
22082 requests its removal from incoming messages, so that delivered messages can
22083 safely be resent to other recipients.
22084
22085
22086 .option driver transports string unset
22087 This specifies which of the available transport drivers is to be used.
22088 There is no default, and this option must be set for every transport.
22089
22090
22091 .option envelope_to_add transports boolean false
22092 .cindex "&'Envelope-to:'& header line"
22093 If this option is true, an &'Envelope-to:'& header is added to the message.
22094 This gives the original address(es) in the incoming envelope that caused this
22095 delivery to happen. More than one address may be present if the transport is
22096 configured to handle several addresses at once, or if more than one original
22097 address was redirected to the same final address. As this is not a standard
22098 header, Exim has a configuration option (&%envelope_to_remove%&) which requests
22099 its removal from incoming messages, so that delivered messages can safely be
22100 resent to other recipients.
22101
22102
22103 .option event_action transports string&!! unset
22104 .cindex events
22105 This option declares a string to be expanded for Exim's events mechanism.
22106 For details see chapter &<<CHAPevents>>&.
22107
22108
22109 .option group transports string&!! "Exim group"
22110 .cindex "transport" "group; specifying"
22111 This option specifies a gid for running the transport process, overriding any
22112 value that the router supplies, and also overriding any value associated with
22113 &%user%& (see below).
22114
22115
22116 .option headers_add transports list&!! unset
22117 .cindex "header lines" "adding in transport"
22118 .cindex "transport" "header lines; adding"
22119 This option specifies a list of text headers,
22120 newline-separated (by default, changeable in the usual way &<<SECTlistsepchange>>&),
22121 which are (separately) expanded and added to the header
22122 portion of a message as it is transported, as described in section
22123 &<<SECTheadersaddrem>>&. Additional header lines can also be specified by
22124 routers. If the result of the expansion is an empty string, or if the expansion
22125 is forced to fail, no action is taken. Other expansion failures are treated as
22126 errors and cause the delivery to be deferred.
22127
22128 Unlike most options, &%headers_add%& can be specified multiple times
22129 for a transport; all listed headers are added.
22130
22131
22132 .option headers_only transports boolean false
22133 .cindex "transport" "header lines only"
22134 .cindex "message" "transporting headers only"
22135 .cindex "header lines" "transporting"
22136 If this option is set, the message's body is not transported. It is mutually
22137 exclusive with &%body_only%&. If it is used with the &(appendfile)& or &(pipe)&
22138 transports, the settings of &%message_prefix%& and &%message_suffix%& should be
22139 checked, since this option does not automatically suppress them.
22140
22141
22142 .option headers_remove transports list&!! unset
22143 .cindex "header lines" "removing"
22144 .cindex "transport" "header lines; removing"
22145 This option specifies a list of text headers,
22146 colon-separated (by default, changeable in the usual way &<<SECTlistsepchange>>&),
22147 to be removed from the message.
22148 However, the option has no effect when an address is just being verified.
22149 Each list item is separately expanded.
22150 If the result of the expansion is an empty string, or if the expansion
22151 is forced to fail, no action is taken. Other expansion failures are treated as
22152 errors and cause the delivery to be deferred.
22153 .new
22154 If an item ends in *, it will match any header with the given prefix.
22155 .wen
22156
22157 Matching headers are omitted from the message as it is transported, as described
22158 in section &<<SECTheadersaddrem>>&. Header removal can also be specified by
22159 routers.
22160
22161 Unlike most options, &%headers_remove%& can be specified multiple times
22162 for a transport; all listed headers are removed.
22163
22164 &*Warning*&: Because of the separate expansion of the list items,
22165 items that contain a list separator must have it doubled.
22166 To avoid this, change the list separator (&<<SECTlistsepchange>>&).
22167
22168
22169
22170 .option headers_rewrite transports string unset
22171 .cindex "transport" "header lines; rewriting"
22172 .cindex "rewriting" "at transport time"
22173 This option allows addresses in header lines to be rewritten at transport time,
22174 that is, as the message is being copied to its destination. The contents of the
22175 option are a colon-separated list of rewriting rules. Each rule is in exactly
22176 the same form as one of the general rewriting rules that are applied when a
22177 message is received. These are described in chapter &<<CHAPrewrite>>&. For
22178 example,
22179 .code
22180 headers_rewrite = a@b c@d f : \
22181                   x@y w@z
22182 .endd
22183 changes &'a@b'& into &'c@d'& in &'From:'& header lines, and &'x@y'& into
22184 &'w@z'& in all address-bearing header lines. The rules are applied to the
22185 header lines just before they are written out at transport time, so they affect
22186 only those copies of the message that pass through the transport. However, only
22187 the message's original header lines, and any that were added by a system
22188 filter, are rewritten. If a router or transport adds header lines, they are not
22189 affected by this option. These rewriting rules are &'not'& applied to the
22190 envelope. You can change the return path using &%return_path%&, but you cannot
22191 change envelope recipients at this time.
22192
22193
22194 .option home_directory transports string&!! unset
22195 .cindex "transport" "home directory for"
22196 .vindex "&$home$&"
22197 This option specifies a home directory setting for a local transport,
22198 overriding any value that may be set by the router. The home directory is
22199 placed in &$home$& while expanding the transport's private options. It is also
22200 used as the current directory if no current directory is set by the
22201 &%current_directory%& option on the transport or the
22202 &%transport_current_directory%& option on the router. If the expansion fails
22203 for any reason, including forced failure, an error is logged, and delivery is
22204 deferred.
22205
22206
22207 .option initgroups transports boolean false
22208 .cindex "additional groups"
22209 .cindex "groups" "additional"
22210 .cindex "transport" "group; additional"
22211 If this option is true and the uid for the delivery process is provided by the
22212 transport, the &[initgroups()]& function is called when running the transport
22213 to ensure that any additional groups associated with the uid are set up.
22214
22215
22216 .option max_parallel transports integer&!! unset
22217 .cindex limit "transport parallelism"
22218 .cindex transport "parallel processes"
22219 .cindex transport "concurrency limit"
22220 .cindex "delivery" "parallelism for transport"
22221 If this option is set and expands to an integer greater than zero
22222 it limits the number of concurrent runs of the transport.
22223 The control does not apply to shadow transports.
22224
22225 .cindex "hints database" "transport concurrency control"
22226 Exim implements this control by means of a hints database in which a record is
22227 incremented whenever a transport process is being created. The record
22228 is decremented and possibly removed when the process terminates.
22229 Obviously there is scope for
22230 records to get left lying around if there is a system or program crash. To
22231 guard against this, Exim ignores any records that are more than six hours old.
22232
22233 If you use this option, you should also arrange to delete the
22234 relevant hints database whenever your system reboots. The names of the files
22235 start with &_misc_& and they are kept in the &_spool/db_& directory. There
22236 may be one or two files, depending on the type of DBM in use. The same files
22237 are used for ETRN and smtp transport serialization.
22238
22239
22240 .option message_size_limit transports string&!! 0
22241 .cindex "limit" "message size per transport"
22242 .cindex "size" "of message, limit"
22243 .cindex "transport" "message size; limiting"
22244 This option controls the size of messages passed through the transport. It is
22245 expanded before use; the result of the expansion must be a sequence of decimal
22246 digits, optionally followed by K or M. If the expansion fails for any reason,
22247 including forced failure, or if the result is not of the required form,
22248 delivery is deferred. If the value is greater than zero and the size of a
22249 message exceeds this limit, the address is failed. If there is any chance that
22250 the resulting bounce message could be routed to the same transport, you should
22251 ensure that &%return_size_limit%& is less than the transport's
22252 &%message_size_limit%&, as otherwise the bounce message will fail to get
22253 delivered.
22254
22255
22256
22257 .option rcpt_include_affixes transports boolean false
22258 .cindex "prefix" "for local part, including in envelope"
22259 .cindex "suffix for local part" "including in envelope"
22260 .cindex "local part" "prefix"
22261 .cindex "local part" "suffix"
22262 When this option is false (the default), and an address that has had any
22263 affixes (prefixes or suffixes) removed from the local part is delivered by any
22264 form of SMTP or LMTP, the affixes are not included. For example, if a router
22265 that contains
22266 .code
22267 local_part_prefix = *-
22268 .endd
22269 routes the address &'abc-xyz@some.domain'& to an SMTP transport, the envelope
22270 is delivered with
22271 .code
22272 RCPT TO:<xyz@some.domain>
22273 .endd
22274 This is also the case when an ACL-time callout is being used to verify a
22275 recipient address. However, if &%rcpt_include_affixes%& is set true, the
22276 whole local part is included in the RCPT command. This option applies to BSMTP
22277 deliveries by the &(appendfile)& and &(pipe)& transports as well as to the
22278 &(lmtp)& and &(smtp)& transports.
22279
22280
22281 .option retry_use_local_part transports boolean "see below"
22282 .cindex "hints database" "retry keys"
22283 When a delivery suffers a temporary failure, a retry record is created
22284 in Exim's hints database. For remote deliveries, the key for the retry record
22285 is based on the name and/or IP address of the failing remote host. For local
22286 deliveries, the key is normally the entire address, including both the local
22287 part and the domain. This is suitable for most common cases of local delivery
22288 temporary failure &-- for example, exceeding a mailbox quota should delay only
22289 deliveries to that mailbox, not to the whole domain.
22290
22291 However, in some special cases you may want to treat a temporary local delivery
22292 as a failure associated with the domain, and not with a particular local part.
22293 (For example, if you are storing all mail for some domain in files.) You can do
22294 this by setting &%retry_use_local_part%& false.
22295
22296 For all the local transports, its default value is true. For remote transports,
22297 the default value is false for tidiness, but changing the value has no effect
22298 on a remote transport in the current implementation.
22299
22300
22301 .option return_path transports string&!! unset
22302 .cindex "envelope sender"
22303 .cindex "envelope from"
22304 .cindex "transport" "return path; changing"
22305 .cindex "return path" "changing in transport"
22306 If this option is set, the string is expanded at transport time and replaces
22307 the existing return path (envelope sender) value in the copy of the message
22308 that is being delivered. An empty return path is permitted. This feature is
22309 designed for remote deliveries, where the value of this option is used in the
22310 SMTP MAIL command. If you set &%return_path%& for a local transport, the
22311 only effect is to change the address that is placed in the &'Return-path:'&
22312 header line, if one is added to the message (see the next option).
22313
22314 &*Note:*& A changed return path is not logged unless you add
22315 &%return_path_on_delivery%& to the log selector.
22316
22317 .vindex "&$return_path$&"
22318 The expansion can refer to the existing value via &$return_path$&. This is
22319 either the message's envelope sender, or an address set by the
22320 &%errors_to%& option on a router. If the expansion is forced to fail, no
22321 replacement occurs; if it fails for another reason, delivery is deferred. This
22322 option can be used to support VERP (Variable Envelope Return Paths) &-- see
22323 section &<<SECTverp>>&.
22324
22325 &*Note*&: If a delivery error is detected locally, including the case when a
22326 remote server rejects a message at SMTP time, the bounce message is not sent to
22327 the value of this option. It is sent to the previously set errors address.
22328 This defaults to the incoming sender address, but can be changed by setting
22329 &%errors_to%& in a router.
22330
22331
22332
22333 .option return_path_add transports boolean false
22334 .cindex "&'Return-path:'& header line"
22335 If this option is true, a &'Return-path:'& header is added to the message.
22336 Although the return path is normally available in the prefix line of BSD
22337 mailboxes, this is commonly not displayed by MUAs, and so the user does not
22338 have easy access to it.
22339
22340 RFC 2821 states that the &'Return-path:'& header is added to a message &"when
22341 the delivery SMTP server makes the final delivery"&. This implies that this
22342 header should not be present in incoming messages. Exim has a configuration
22343 option, &%return_path_remove%&, which requests removal of this header from
22344 incoming messages, so that delivered messages can safely be resent to other
22345 recipients.
22346
22347
22348 .option shadow_condition transports string&!! unset
22349 See &%shadow_transport%& below.
22350
22351
22352 .option shadow_transport transports string unset
22353 .cindex "shadow transport"
22354 .cindex "transport" "shadow"
22355 A local transport may set the &%shadow_transport%& option to the name of
22356 another local transport. Shadow remote transports are not supported.
22357
22358 Whenever a delivery to the main transport succeeds, and either
22359 &%shadow_condition%& is unset, or its expansion does not result in the empty
22360 string or one of the strings &"0"& or &"no"& or &"false"&, the message is also
22361 passed to the shadow transport, with the same delivery address or addresses. If
22362 expansion fails, no action is taken except that non-forced expansion failures
22363 cause a log line to be written.
22364
22365 The result of the shadow transport is discarded and does not affect the
22366 subsequent processing of the message. Only a single level of shadowing is
22367 provided; the &%shadow_transport%& option is ignored on any transport when it
22368 is running as a shadow. Options concerned with output from pipes are also
22369 ignored. The log line for the successful delivery has an item added on the end,
22370 of the form
22371 .code
22372 ST=<shadow transport name>
22373 .endd
22374 If the shadow transport did not succeed, the error message is put in
22375 parentheses afterwards. Shadow transports can be used for a number of different
22376 purposes, including keeping more detailed log information than Exim normally
22377 provides, and implementing automatic acknowledgment policies based on message
22378 headers that some sites insist on.
22379
22380
22381 .option transport_filter transports string&!! unset
22382 .cindex "transport" "filter"
22383 .cindex "filter" "transport filter"
22384 This option sets up a filtering (in the Unix shell sense) process for messages
22385 at transport time. It should not be confused with mail filtering as set up by
22386 individual users or via a system filter.
22387 If unset, or expanding to an empty string, no filtering is done.
22388
22389 When the message is about to be written out, the command specified by
22390 &%transport_filter%& is started up in a separate, parallel process, and
22391 the entire message, including the header lines, is passed to it on its standard
22392 input (this in fact is done from a third process, to avoid deadlock). The
22393 command must be specified as an absolute path.
22394
22395 The lines of the message that are written to the transport filter are
22396 terminated by newline (&"\n"&). The message is passed to the filter before any
22397 SMTP-specific processing, such as turning &"\n"& into &"\r\n"& and escaping
22398 lines beginning with a dot, and also before any processing implied by the
22399 settings of &%check_string%& and &%escape_string%& in the &(appendfile)& or
22400 &(pipe)& transports.
22401
22402 The standard error for the filter process is set to the same destination as its
22403 standard output; this is read and written to the message's ultimate
22404 destination. The process that writes the message to the filter, the
22405 filter itself, and the original process that reads the result and delivers it
22406 are all run in parallel, like a shell pipeline.
22407
22408 The filter can perform any transformations it likes, but of course should take
22409 care not to break RFC 2822 syntax. Exim does not check the result, except to
22410 test for a final newline when SMTP is in use. All messages transmitted over
22411 SMTP must end with a newline, so Exim supplies one if it is missing.
22412
22413 .cindex "content scanning" "per user"
22414 A transport filter can be used to provide content-scanning on a per-user basis
22415 at delivery time if the only required effect of the scan is to modify the
22416 message. For example, a content scan could insert a new header line containing
22417 a spam score. This could be interpreted by a filter in the user's MUA. It is
22418 not possible to discard a message at this stage.
22419
22420 .cindex "SIZE" "ESMTP extension"
22421 A problem might arise if the filter increases the size of a message that is
22422 being sent down an SMTP connection. If the receiving SMTP server has indicated
22423 support for the SIZE parameter, Exim will have sent the size of the message
22424 at the start of the SMTP session. If what is actually sent is substantially
22425 more, the server might reject the message. This can be worked round by setting
22426 the &%size_addition%& option on the &(smtp)& transport, either to allow for
22427 additions to the message, or to disable the use of SIZE altogether.
22428
22429 .vindex "&$pipe_addresses$&"
22430 The value of the &%transport_filter%& option is the command string for starting
22431 the filter, which is run directly from Exim, not under a shell. The string is
22432 parsed by Exim in the same way as a command string for the &(pipe)& transport:
22433 Exim breaks it up into arguments and then expands each argument separately (see
22434 section &<<SECThowcommandrun>>&). Any kind of expansion failure causes delivery
22435 to be deferred. The special argument &$pipe_addresses$& is replaced by a number
22436 of arguments, one for each address that applies to this delivery. (This isn't
22437 an ideal name for this feature here, but as it was already implemented for the
22438 &(pipe)& transport, it seemed sensible not to change it.)
22439
22440 .vindex "&$host$&"
22441 .vindex "&$host_address$&"
22442 The expansion variables &$host$& and &$host_address$& are available when the
22443 transport is a remote one. They contain the name and IP address of the host to
22444 which the message is being sent. For example:
22445 .code
22446 transport_filter = /some/directory/transport-filter.pl \
22447   $host $host_address $sender_address $pipe_addresses
22448 .endd
22449
22450 Two problems arise if you want to use more complicated expansion items to
22451 generate transport filter commands, both of which due to the fact that the
22452 command is split up &'before'& expansion.
22453 .ilist
22454 If an expansion item contains white space, you must quote it, so that it is all
22455 part of the same command item. If the entire option setting is one such
22456 expansion item, you have to take care what kind of quoting you use. For
22457 example:
22458 .code
22459 transport_filter = '/bin/cmd${if eq{$host}{a.b.c}{1}{2}}'
22460 .endd
22461 This runs the command &(/bin/cmd1)& if the host name is &'a.b.c'&, and
22462 &(/bin/cmd2)& otherwise. If double quotes had been used, they would have been
22463 stripped by Exim when it read the option's value. When the value is used, if
22464 the single quotes were missing, the line would be split into two items,
22465 &`/bin/cmd${if`& and &`eq{$host}{a.b.c}{1}{2}`&, and an error would occur when
22466 Exim tried to expand the first one.
22467 .next
22468 Except for the special case of &$pipe_addresses$& that is mentioned above, an
22469 expansion cannot generate multiple arguments, or a command name followed by
22470 arguments. Consider this example:
22471 .code
22472 transport_filter = ${lookup{$host}lsearch{/a/file}\
22473                     {$value}{/bin/cat}}
22474 .endd
22475 The result of the lookup is interpreted as the name of the command, even
22476 if it contains white space. The simplest way round this is to use a shell:
22477 .code
22478 transport_filter = /bin/sh -c ${lookup{$host}lsearch{/a/file}\
22479                                {$value}{/bin/cat}}
22480 .endd
22481 .endlist
22482
22483 The filter process is run under the same uid and gid as the normal delivery.
22484 For remote deliveries this is the Exim uid/gid by default. The command should
22485 normally yield a zero return code. Transport filters are not supposed to fail.
22486 A non-zero code is taken to mean that the transport filter encountered some
22487 serious problem. Delivery of the message is deferred; the message remains on
22488 the queue and is tried again later. It is not possible to cause a message to be
22489 bounced from a transport filter.
22490
22491 If a transport filter is set on an autoreply transport, the original message is
22492 passed through the filter as it is being copied into the newly generated
22493 message, which happens if the &%return_message%& option is set.
22494
22495
22496 .option transport_filter_timeout transports time 5m
22497 .cindex "transport" "filter, timeout"
22498 When Exim is reading the output of a transport filter, it applies a timeout
22499 that can be set by this option. Exceeding the timeout is normally treated as a
22500 temporary delivery failure. However, if a transport filter is used with a
22501 &(pipe)& transport, a timeout in the transport filter is treated in the same
22502 way as a timeout in the pipe command itself. By default, a timeout is a hard
22503 error, but if the &(pipe)& transport's &%timeout_defer%& option is set true, it
22504 becomes a temporary error.
22505
22506
22507 .option user transports string&!! "Exim user"
22508 .cindex "uid (user id)" "local delivery"
22509 .cindex "transport" "user, specifying"
22510 This option specifies the user under whose uid the delivery process is to be
22511 run, overriding any uid that may have been set by the router. If the user is
22512 given as a name, the uid is looked up from the password data, and the
22513 associated group is taken as the value of the gid to be used if the &%group%&
22514 option is not set.
22515
22516 For deliveries that use local transports, a user and group are normally
22517 specified explicitly or implicitly (for example, as a result of
22518 &%check_local_user%&) by the router or transport.
22519
22520 .cindex "hints database" "access by remote transport"
22521 For remote transports, you should leave this option unset unless you really are
22522 sure you know what you are doing. When a remote transport is running, it needs
22523 to be able to access Exim's hints databases, because each host may have its own
22524 retry data.
22525 .ecindex IIDgenoptra1
22526 .ecindex IIDgenoptra2
22527 .ecindex IIDgenoptra3
22528
22529
22530
22531
22532
22533
22534 . ////////////////////////////////////////////////////////////////////////////
22535 . ////////////////////////////////////////////////////////////////////////////
22536
22537 .chapter "Address batching in local transports" "CHAPbatching" &&&
22538          "Address batching"
22539 .cindex "transport" "local; address batching in"
22540 The only remote transport (&(smtp)&) is normally configured to handle more than
22541 one address at a time, so that when several addresses are routed to the same
22542 remote host, just one copy of the message is sent. Local transports, however,
22543 normally handle one address at a time. That is, a separate instance of the
22544 transport is run for each address that is routed to the transport. A separate
22545 copy of the message is delivered each time.
22546
22547 .cindex "batched local delivery"
22548 .oindex "&%batch_max%&"
22549 .oindex "&%batch_id%&"
22550 In special cases, it may be desirable to handle several addresses at once in a
22551 local transport, for example:
22552
22553 .ilist
22554 In an &(appendfile)& transport, when storing messages in files for later
22555 delivery by some other means, a single copy of the message with multiple
22556 recipients saves space.
22557 .next
22558 In an &(lmtp)& transport, when delivering over &"local SMTP"& to some process,
22559 a single copy saves time, and is the normal way LMTP is expected to work.
22560 .next
22561 In a &(pipe)& transport, when passing the message
22562 to a scanner program or
22563 to some other delivery mechanism such as UUCP, multiple recipients may be
22564 acceptable.
22565 .endlist
22566
22567 These three local transports all have the same options for controlling multiple
22568 (&"batched"&) deliveries, namely &%batch_max%& and &%batch_id%&. To save
22569 repeating the information for each transport, these options are described here.
22570
22571 The &%batch_max%& option specifies the maximum number of addresses that can be
22572 delivered together in a single run of the transport. Its default value is one
22573 (no batching). When more than one address is routed to a transport that has a
22574 &%batch_max%& value greater than one, the addresses are delivered in a batch
22575 (that is, in a single run of the transport with multiple recipients), subject
22576 to certain conditions:
22577
22578 .ilist
22579 .vindex "&$local_part$&"
22580 If any of the transport's options contain a reference to &$local_part$&, no
22581 batching is possible.
22582 .next
22583 .vindex "&$domain$&"
22584 If any of the transport's options contain a reference to &$domain$&, only
22585 addresses with the same domain are batched.
22586 .next
22587 .cindex "customizing" "batching condition"
22588 If &%batch_id%& is set, it is expanded for each address, and only those
22589 addresses with the same expanded value are batched. This allows you to specify
22590 customized batching conditions. Failure of the expansion for any reason,
22591 including forced failure, disables batching, but it does not stop the delivery
22592 from taking place.
22593 .next
22594 Batched addresses must also have the same errors address (where to send
22595 delivery errors), the same header additions and removals, the same user and
22596 group for the transport, and if a host list is present, the first host must
22597 be the same.
22598 .endlist
22599
22600 In the case of the &(appendfile)& and &(pipe)& transports, batching applies
22601 both when the file or pipe command is specified in the transport, and when it
22602 is specified by a &(redirect)& router, but all the batched addresses must of
22603 course be routed to the same file or pipe command. These two transports have an
22604 option called &%use_bsmtp%&, which causes them to deliver the message in
22605 &"batched SMTP"& format, with the envelope represented as SMTP commands. The
22606 &%check_string%& and &%escape_string%& options are forced to the values
22607 .code
22608 check_string = "."
22609 escape_string = ".."
22610 .endd
22611 when batched SMTP is in use. A full description of the batch SMTP mechanism is
22612 given in section &<<SECTbatchSMTP>>&. The &(lmtp)& transport does not have a
22613 &%use_bsmtp%& option, because it always delivers using the SMTP protocol.
22614
22615 .cindex "&'Envelope-to:'& header line"
22616 If the generic &%envelope_to_add%& option is set for a batching transport, the
22617 &'Envelope-to:'& header that is added to the message contains all the addresses
22618 that are being processed together. If you are using a batching &(appendfile)&
22619 transport without &%use_bsmtp%&, the only way to preserve the recipient
22620 addresses is to set the &%envelope_to_add%& option.
22621
22622 .cindex "&(pipe)& transport" "with multiple addresses"
22623 .vindex "&$pipe_addresses$&"
22624 If you are using a &(pipe)& transport without BSMTP, and setting the
22625 transport's &%command%& option, you can include &$pipe_addresses$& as part of
22626 the command. This is not a true variable; it is a bit of magic that causes each
22627 of the recipient addresses to be inserted into the command as a separate
22628 argument. This provides a way of accessing all the addresses that are being
22629 delivered in the batch. &*Note:*& This is not possible for pipe commands that
22630 are specified by a &(redirect)& router.
22631
22632
22633
22634
22635 . ////////////////////////////////////////////////////////////////////////////
22636 . ////////////////////////////////////////////////////////////////////////////
22637
22638 .chapter "The appendfile transport" "CHAPappendfile"
22639 .scindex IIDapptra1 "&(appendfile)& transport"
22640 .scindex IIDapptra2 "transports" "&(appendfile)&"
22641 .cindex "directory creation"
22642 .cindex "creating directories"
22643 The &(appendfile)& transport delivers a message by appending it to an existing
22644 file, or by creating an entirely new file in a specified directory. Single
22645 files to which messages are appended can be in the traditional Unix mailbox
22646 format, or optionally in the MBX format supported by the Pine MUA and
22647 University of Washington IMAP daemon, &'inter alia'&. When each message is
22648 being delivered as a separate file, &"maildir"& format can optionally be used
22649 to give added protection against failures that happen part-way through the
22650 delivery. A third form of separate-file delivery known as &"mailstore"& is also
22651 supported. For all file formats, Exim attempts to create as many levels of
22652 directory as necessary, provided that &%create_directory%& is set.
22653
22654 The code for the optional formats is not included in the Exim binary by
22655 default. It is necessary to set SUPPORT_MBX, SUPPORT_MAILDIR and/or
22656 SUPPORT_MAILSTORE in &_Local/Makefile_& to have the appropriate code
22657 included.
22658
22659 .cindex "quota" "system"
22660 Exim recognizes system quota errors, and generates an appropriate message. Exim
22661 also supports its own quota control within the transport, for use when the
22662 system facility is unavailable or cannot be used for some reason.
22663
22664 If there is an error while appending to a file (for example, quota exceeded or
22665 partition filled), Exim attempts to reset the file's length and last
22666 modification time back to what they were before. If there is an error while
22667 creating an entirely new file, the new file is removed.
22668
22669 Before appending to a file, a number of security checks are made, and the
22670 file is locked. A detailed description is given below, after the list of
22671 private options.
22672
22673 The &(appendfile)& transport is most commonly used for local deliveries to
22674 users' mailboxes. However, it can also be used as a pseudo-remote transport for
22675 putting messages into files for remote delivery by some means other than Exim.
22676 &"Batch SMTP"& format is often used in this case (see the &%use_bsmtp%&
22677 option).
22678
22679
22680
22681 .section "The file and directory options" "SECTfildiropt"
22682 The &%file%& option specifies a single file, to which the message is appended;
22683 the &%directory%& option specifies a directory, in which a new file containing
22684 the message is created. Only one of these two options can be set, and for
22685 normal deliveries to mailboxes, one of them &'must'& be set.
22686
22687 .vindex "&$address_file$&"
22688 .vindex "&$local_part$&"
22689 However, &(appendfile)& is also used for delivering messages to files or
22690 directories whose names (or parts of names) are obtained from alias,
22691 forwarding, or filtering operations (for example, a &%save%& command in a
22692 user's Exim filter). When such a transport is running, &$local_part$& contains
22693 the local part that was aliased or forwarded, and &$address_file$& contains the
22694 name (or partial name) of the file or directory generated by the redirection
22695 operation. There are two cases:
22696
22697 .ilist
22698 If neither &%file%& nor &%directory%& is set, the redirection operation
22699 must specify an absolute path (one that begins with &`/`&). This is the most
22700 common case when users with local accounts use filtering to sort mail into
22701 different folders. See for example, the &(address_file)& transport in the
22702 default configuration. If the path ends with a slash, it is assumed to be the
22703 name of a directory. A delivery to a directory can also be forced by setting
22704 &%maildir_format%& or &%mailstore_format%&.
22705 .next
22706 If &%file%& or &%directory%& is set for a delivery from a redirection, it is
22707 used to determine the file or directory name for the delivery. Normally, the
22708 contents of &$address_file$& are used in some way in the string expansion.
22709 .endlist
22710 .new
22711 .cindex "tainted data" "in filenames"
22712 .cindex appendfile "tainted data"
22713 Tainted data may not be used for a file or directory name.
22714 This means that, for instance, &$local_part$& cannot be used directly
22715 as a component of a path.  It can however be used as the key for a lookup
22716 which returns a path (or component).
22717 .wen
22718
22719
22720 .cindex "Sieve filter" "configuring &(appendfile)&"
22721 .cindex "Sieve filter" "relative mailbox path handling"
22722 As an example of the second case, consider an environment where users do not
22723 have home directories. They may be permitted to use Exim filter commands of the
22724 form:
22725 .code
22726 save folder23
22727 .endd
22728 or Sieve filter commands of the form:
22729 .code
22730 require "fileinto";
22731 fileinto "folder23";
22732 .endd
22733 In this situation, the expansion of &%file%& or &%directory%& in the transport
22734 must transform the relative path into an appropriate absolute filename. In the
22735 case of Sieve filters, the name &'inbox'& must be handled. It is the name that
22736 is used as a result of a &"keep"& action in the filter. This example shows one
22737 way of handling this requirement:
22738 .code
22739 file = ${if eq{$address_file}{inbox} \
22740             {/var/mail/$local_part_data} \
22741             {${if eq{${substr_0_1:$address_file}}{/} \
22742                   {$address_file} \
22743                   {$home/mail/$address_file} \
22744             }} \
22745        }
22746 .endd
22747 With this setting of &%file%&, &'inbox'& refers to the standard mailbox
22748 location, absolute paths are used without change, and other folders are in the
22749 &_mail_& directory within the home directory.
22750
22751 &*Note 1*&: While processing an Exim filter, a relative path such as
22752 &_folder23_& is turned into an absolute path if a home directory is known to
22753 the router. In particular, this is the case if &%check_local_user%& is set. If
22754 you want to prevent this happening at routing time, you can set
22755 &%router_home_directory%& empty. This forces the router to pass the relative
22756 path to the transport.
22757
22758 &*Note 2*&: An absolute path in &$address_file$& is not treated specially;
22759 the &%file%& or &%directory%& option is still used if it is set.
22760
22761
22762
22763
22764 .section "Private options for appendfile" "SECID134"
22765 .cindex "options" "&(appendfile)& transport"
22766
22767
22768
22769 .option allow_fifo appendfile boolean false
22770 .cindex "fifo (named pipe)"
22771 .cindex "named pipe (fifo)"
22772 .cindex "pipe" "named (fifo)"
22773 Setting this option permits delivery to named pipes (FIFOs) as well as to
22774 regular files. If no process is reading the named pipe at delivery time, the
22775 delivery is deferred.
22776
22777
22778 .option allow_symlink appendfile boolean false
22779 .cindex "symbolic link" "to mailbox"
22780 .cindex "mailbox" "symbolic link"
22781 By default, &(appendfile)& will not deliver if the path name for the file is
22782 that of a symbolic link. Setting this option relaxes that constraint, but there
22783 are security issues involved in the use of symbolic links. Be sure you know
22784 what you are doing if you set this. Details of exactly what this option affects
22785 are included in the discussion which follows this list of options.
22786
22787
22788 .option batch_id appendfile string&!! unset
22789 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
22790 However, batching is automatically disabled for &(appendfile)& deliveries that
22791 happen as a result of forwarding or aliasing or other redirection directly to a
22792 file.
22793
22794
22795 .option batch_max appendfile integer 1
22796 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
22797
22798
22799 .option check_group appendfile boolean false
22800 When this option is set, the group owner of the file defined by the &%file%&
22801 option is checked to see that it is the same as the group under which the
22802 delivery process is running. The default setting is false because the default
22803 file mode is 0600, which means that the group is irrelevant.
22804
22805
22806 .option check_owner appendfile boolean true
22807 When this option is set, the owner of the file defined by the &%file%& option
22808 is checked to ensure that it is the same as the user under which the delivery
22809 process is running.
22810
22811
22812 .option check_string appendfile string "see below"
22813 .cindex "&""From""& line"
22814 As &(appendfile)& writes the message, the start of each line is tested for
22815 matching &%check_string%&, and if it does, the initial matching characters are
22816 replaced by the contents of &%escape_string%&. The value of &%check_string%& is
22817 a literal string, not a regular expression, and the case of any letters it
22818 contains is significant.
22819
22820 If &%use_bsmtp%& is set the values of &%check_string%& and &%escape_string%&
22821 are forced to &"."& and &".."& respectively, and any settings in the
22822 configuration are ignored. Otherwise, they default to &"From&~"& and
22823 &">From&~"& when the &%file%& option is set, and unset when any of the
22824 &%directory%&, &%maildir%&, or &%mailstore%& options are set.
22825
22826 The default settings, along with &%message_prefix%& and &%message_suffix%&, are
22827 suitable for traditional &"BSD"& mailboxes, where a line beginning with
22828 &"From&~"& indicates the start of a new message. All four options need changing
22829 if another format is used. For example, to deliver to mailboxes in MMDF format:
22830 .cindex "MMDF format mailbox"
22831 .cindex "mailbox" "MMDF format"
22832 .code
22833 check_string = "\1\1\1\1\n"
22834 escape_string = "\1\1\1\1 \n"
22835 message_prefix = "\1\1\1\1\n"
22836 message_suffix = "\1\1\1\1\n"
22837 .endd
22838 .option create_directory appendfile boolean true
22839 .cindex "directory creation"
22840 When this option is true, Exim attempts to create any missing superior
22841 directories for the file that it is about to write. A created directory's mode
22842 is given by the &%directory_mode%& option.
22843
22844 The group ownership of a newly created directory is highly dependent on the
22845 operating system (and possibly the file system) that is being used. For
22846 example, in Solaris, if the parent directory has the setgid bit set, its group
22847 is propagated to the child; if not, the currently set group is used. However,
22848 in FreeBSD, the parent's group is always used.
22849
22850
22851
22852 .option create_file appendfile string anywhere
22853 This option constrains the location of files and directories that are created
22854 by this transport. It applies to files defined by the &%file%& option and
22855 directories defined by the &%directory%& option. In the case of maildir
22856 delivery, it applies to the top level directory, not the maildir directories
22857 beneath.
22858
22859 The option must be set to one of the words &"anywhere"&, &"inhome"&, or
22860 &"belowhome"&. In the second and third cases, a home directory must have been
22861 set for the transport. This option is not useful when an explicit filename is
22862 given for normal mailbox deliveries. It is intended for the case when filenames
22863 are generated from users' &_.forward_& files. These are usually handled
22864 by an &(appendfile)& transport called &%address_file%&. See also
22865 &%file_must_exist%&.
22866
22867
22868 .option directory appendfile string&!! unset
22869 This option is mutually exclusive with the &%file%& option, but one of &%file%&
22870 or &%directory%& must be set, unless the delivery is the direct result of a
22871 redirection (see section &<<SECTfildiropt>>&).
22872
22873 When &%directory%& is set, the string is expanded, and the message is delivered
22874 into a new file or files in or below the given directory, instead of being
22875 appended to a single mailbox file. A number of different formats are provided
22876 (see &%maildir_format%& and &%mailstore_format%&), and see section
22877 &<<SECTopdir>>& for further details of this form of delivery.
22878
22879
22880 .option directory_file appendfile string&!! "see below"
22881 .cindex "base62"
22882 .vindex "&$inode$&"
22883 When &%directory%& is set, but neither &%maildir_format%& nor
22884 &%mailstore_format%& is set, &(appendfile)& delivers each message into a file
22885 whose name is obtained by expanding this string. The default value is:
22886 .code
22887 q${base62:$tod_epoch}-$inode
22888 .endd
22889 This generates a unique name from the current time, in base 62 form, and the
22890 inode of the file. The variable &$inode$& is available only when expanding this
22891 option.
22892
22893
22894 .option directory_mode appendfile "octal integer" 0700
22895 If &(appendfile)& creates any directories as a result of the
22896 &%create_directory%& option, their mode is specified by this option.
22897
22898
22899 .option escape_string appendfile string "see description"
22900 See &%check_string%& above.
22901
22902
22903 .option file appendfile string&!! unset
22904 This option is mutually exclusive with the &%directory%& option, but one of
22905 &%file%& or &%directory%& must be set, unless the delivery is the direct result
22906 of a redirection (see section &<<SECTfildiropt>>&). The &%file%& option
22907 specifies a single file, to which the message is appended. One or more of
22908 &%use_fcntl_lock%&, &%use_flock_lock%&, or &%use_lockfile%& must be set with
22909 &%file%&.
22910
22911 .cindex "NFS" "lock file"
22912 .cindex "locking files"
22913 .cindex "lock files"
22914 If you are using more than one host to deliver over NFS into the same
22915 mailboxes, you should always use lock files.
22916
22917 The string value is expanded for each delivery, and must yield an absolute
22918 path. The most common settings of this option are variations on one of these
22919 examples:
22920 .code
22921 file = /var/spool/mail/$local_part_data
22922 file = /home/$local_part_data/inbox
22923 file = $home/inbox
22924 .endd
22925 .cindex "&""sticky""& bit"
22926 In the first example, all deliveries are done into the same directory. If Exim
22927 is configured to use lock files (see &%use_lockfile%& below) it must be able to
22928 create a file in the directory, so the &"sticky"& bit must be turned on for
22929 deliveries to be possible, or alternatively the &%group%& option can be used to
22930 run the delivery under a group id which has write access to the directory.
22931
22932
22933
22934 .option file_format appendfile string unset
22935 .cindex "file" "mailbox; checking existing format"
22936 This option requests the transport to check the format of an existing file
22937 before adding to it. The check consists of matching a specific string at the
22938 start of the file. The value of the option consists of an even number of
22939 colon-separated strings. The first of each pair is the test string, and the
22940 second is the name of a transport. If the transport associated with a matched
22941 string is not the current transport, control is passed over to the other
22942 transport. For example, suppose the standard &(local_delivery)& transport has
22943 this added to it:
22944 .code
22945 file_format = "From       : local_delivery :\
22946                \1\1\1\1\n : local_mmdf_delivery"
22947 .endd
22948 Mailboxes that begin with &"From"& are still handled by this transport, but if
22949 a mailbox begins with four binary ones followed by a newline, control is passed
22950 to a transport called &%local_mmdf_delivery%&, which presumably is configured
22951 to do the delivery in MMDF format. If a mailbox does not exist or is empty, it
22952 is assumed to match the current transport. If the start of a mailbox doesn't
22953 match any string, or if the transport named for a given string is not defined,
22954 delivery is deferred.
22955
22956
22957 .option file_must_exist appendfile boolean false
22958 If this option is true, the file specified by the &%file%& option must exist.
22959 A temporary error occurs if it does not, causing delivery to be deferred.
22960 If this option is false, the file is created if it does not exist.
22961
22962
22963 .option lock_fcntl_timeout appendfile time 0s
22964 .cindex "timeout" "mailbox locking"
22965 .cindex "mailbox" "locking, blocking and non-blocking"
22966 .cindex "locking files"
22967 By default, the &(appendfile)& transport uses non-blocking calls to &[fcntl()]&
22968 when locking an open mailbox file. If the call fails, the delivery process
22969 sleeps for &%lock_interval%& and tries again, up to &%lock_retries%& times.
22970 Non-blocking calls are used so that the file is not kept open during the wait
22971 for the lock; the reason for this is to make it as safe as possible for
22972 deliveries over NFS in the case when processes might be accessing an NFS
22973 mailbox without using a lock file. This should not be done, but
22974 misunderstandings and hence misconfigurations are not unknown.
22975
22976 On a busy system, however, the performance of a non-blocking lock approach is
22977 not as good as using a blocking lock with a timeout. In this case, the waiting
22978 is done inside the system call, and Exim's delivery process acquires the lock
22979 and can proceed as soon as the previous lock holder releases it.
22980
22981 If &%lock_fcntl_timeout%& is set to a non-zero time, blocking locks, with that
22982 timeout, are used. There may still be some retrying: the maximum number of
22983 retries is
22984 .code
22985 (lock_retries * lock_interval) / lock_fcntl_timeout
22986 .endd
22987 rounded up to the next whole number. In other words, the total time during
22988 which &(appendfile)& is trying to get a lock is roughly the same, unless
22989 &%lock_fcntl_timeout%& is set very large.
22990
22991 You should consider setting this option if you are getting a lot of delayed
22992 local deliveries because of errors of the form
22993 .code
22994 failed to lock mailbox /some/file (fcntl)
22995 .endd
22996
22997 .option lock_flock_timeout appendfile time 0s
22998 This timeout applies to file locking when using &[flock()]& (see
22999 &%use_flock%&); the timeout operates in a similar manner to
23000 &%lock_fcntl_timeout%&.
23001
23002
23003 .option lock_interval appendfile time 3s
23004 This specifies the time to wait between attempts to lock the file. See below
23005 for details of locking.
23006
23007
23008 .option lock_retries appendfile integer 10
23009 This specifies the maximum number of attempts to lock the file. A value of zero
23010 is treated as 1. See below for details of locking.
23011
23012
23013 .option lockfile_mode appendfile "octal integer" 0600
23014 This specifies the mode of the created lock file, when a lock file is being
23015 used (see &%use_lockfile%& and &%use_mbx_lock%&).
23016
23017
23018 .option lockfile_timeout appendfile time 30m
23019 .cindex "timeout" "mailbox locking"
23020 When a lock file is being used (see &%use_lockfile%&), if a lock file already
23021 exists and is older than this value, it is assumed to have been left behind by
23022 accident, and Exim attempts to remove it.
23023
23024
23025 .option mailbox_filecount appendfile string&!! unset
23026 .cindex "mailbox" "specifying size of"
23027 .cindex "size" "of mailbox"
23028 If this option is set, it is expanded, and the result is taken as the current
23029 number of files in the mailbox. It must be a decimal number, optionally
23030 followed by K or M. This provides a way of obtaining this information from an
23031 external source that maintains the data.
23032
23033
23034 .option mailbox_size appendfile string&!! unset
23035 .cindex "mailbox" "specifying size of"
23036 .cindex "size" "of mailbox"
23037 If this option is set, it is expanded, and the result is taken as the current
23038 size the mailbox. It must be a decimal number, optionally followed by K or M.
23039 This provides a way of obtaining this information from an external source that
23040 maintains the data. This is likely to be helpful for maildir deliveries where
23041 it is computationally expensive to compute the size of a mailbox.
23042
23043
23044
23045 .option maildir_format appendfile boolean false
23046 .cindex "maildir format" "specifying"
23047 If this option is set with the &%directory%& option, the delivery is into a new
23048 file, in the &"maildir"& format that is used by other mail software. When the
23049 transport is activated directly from a &(redirect)& router (for example, the
23050 &(address_file)& transport in the default configuration), setting
23051 &%maildir_format%& causes the path received from the router to be treated as a
23052 directory, whether or not it ends with &`/`&. This option is available only if
23053 SUPPORT_MAILDIR is present in &_Local/Makefile_&. See section
23054 &<<SECTmaildirdelivery>>& below for further details.
23055
23056
23057 .option maildir_quota_directory_regex appendfile string "See below"
23058 .cindex "maildir format" "quota; directories included in"
23059 .cindex "quota" "maildir; directories included in"
23060 This option is relevant only when &%maildir_use_size_file%& is set. It defines
23061 a regular expression for specifying directories, relative to the quota
23062 directory (see &%quota_directory%&), that should be included in the quota
23063 calculation. The default value is:
23064 .code
23065 maildir_quota_directory_regex = ^(?:cur|new|\..*)$
23066 .endd
23067 This includes the &_cur_& and &_new_& directories, and any maildir++ folders
23068 (directories whose names begin with a dot). If you want to exclude the
23069 &_Trash_&
23070 folder from the count (as some sites do), you need to change this setting to
23071 .code
23072 maildir_quota_directory_regex = ^(?:cur|new|\.(?!Trash).*)$
23073 .endd
23074 This uses a negative lookahead in the regular expression to exclude the
23075 directory whose name is &_.Trash_&. When a directory is excluded from quota
23076 calculations, quota processing is bypassed for any messages that are delivered
23077 directly into that directory.
23078
23079
23080 .option maildir_retries appendfile integer 10
23081 This option specifies the number of times to retry when writing a file in
23082 &"maildir"& format. See section &<<SECTmaildirdelivery>>& below.
23083
23084
23085 .option maildir_tag appendfile string&!! unset
23086 This option applies only to deliveries in maildir format, and is described in
23087 section &<<SECTmaildirdelivery>>& below.
23088
23089
23090 .option maildir_use_size_file appendfile&!! boolean false
23091 .cindex "maildir format" "&_maildirsize_& file"
23092 The result of string expansion for this option must be a valid boolean value.
23093 If it is true, it enables support for &_maildirsize_& files. Exim
23094 creates a &_maildirsize_& file in a maildir if one does not exist, taking the
23095 quota from the &%quota%& option of the transport. If &%quota%& is unset, the
23096 value is zero. See &%maildir_quota_directory_regex%& above and section
23097 &<<SECTmaildirdelivery>>& below for further details.
23098
23099 .option maildirfolder_create_regex appendfile string unset
23100 .cindex "maildir format" "&_maildirfolder_& file"
23101 .cindex "&_maildirfolder_&, creating"
23102 The value of this option is a regular expression. If it is unset, it has no
23103 effect. Otherwise, before a maildir delivery takes place, the pattern is
23104 matched against the name of the maildir directory, that is, the directory
23105 containing the &_new_& and &_tmp_& subdirectories that will be used for the
23106 delivery. If there is a match, Exim checks for the existence of a file called
23107 &_maildirfolder_& in the directory, and creates it if it does not exist.
23108 See section &<<SECTmaildirdelivery>>& for more details.
23109
23110
23111 .option mailstore_format appendfile boolean false
23112 .cindex "mailstore format" "specifying"
23113 If this option is set with the &%directory%& option, the delivery is into two
23114 new files in  &"mailstore"& format. The option is available only if
23115 SUPPORT_MAILSTORE is present in &_Local/Makefile_&. See section &<<SECTopdir>>&
23116 below for further details.
23117
23118
23119 .option mailstore_prefix appendfile string&!! unset
23120 This option applies only to deliveries in mailstore format, and is described in
23121 section &<<SECTopdir>>& below.
23122
23123
23124 .option mailstore_suffix appendfile string&!! unset
23125 This option applies only to deliveries in mailstore format, and is described in
23126 section &<<SECTopdir>>& below.
23127
23128
23129 .option mbx_format appendfile boolean false
23130 .cindex "locking files"
23131 .cindex "file" "locking"
23132 .cindex "file" "MBX format"
23133 .cindex "MBX format, specifying"
23134 This option is available only if Exim has been compiled with SUPPORT_MBX
23135 set in &_Local/Makefile_&. If &%mbx_format%& is set with the &%file%& option,
23136 the message is appended to the mailbox file in MBX format instead of
23137 traditional Unix format. This format is supported by Pine4 and its associated
23138 IMAP and POP daemons, by means of the &'c-client'& library that they all use.
23139
23140 &*Note*&: The &%message_prefix%& and &%message_suffix%& options are not
23141 automatically changed by the use of &%mbx_format%&. They should normally be set
23142 empty when using MBX format, so this option almost always appears in this
23143 combination:
23144 .code
23145 mbx_format = true
23146 message_prefix =
23147 message_suffix =
23148 .endd
23149 If none of the locking options are mentioned in the configuration,
23150 &%use_mbx_lock%& is assumed and the other locking options default to false. It
23151 is possible to specify the other kinds of locking with &%mbx_format%&, but
23152 &%use_fcntl_lock%& and &%use_mbx_lock%& are mutually exclusive. MBX locking
23153 interworks with &'c-client'&, providing for shared access to the mailbox. It
23154 should not be used if any program that does not use this form of locking is
23155 going to access the mailbox, nor should it be used if the mailbox file is NFS
23156 mounted, because it works only when the mailbox is accessed from a single host.
23157
23158 If you set &%use_fcntl_lock%& with an MBX-format mailbox, you cannot use
23159 the standard version of &'c-client'&, because as long as it has a mailbox open
23160 (this means for the whole of a Pine or IMAP session), Exim will not be able to
23161 append messages to it.
23162
23163
23164 .option message_prefix appendfile string&!! "see below"
23165 .cindex "&""From""& line"
23166 The string specified here is expanded and output at the start of every message.
23167 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
23168 in which case it is:
23169 .code
23170 message_prefix = "From ${if def:return_path{$return_path}\
23171   {MAILER-DAEMON}} $tod_bsdinbox\n"
23172 .endd
23173 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
23174 &`\n`& to &`\r\n`& in &%message_prefix%&.
23175
23176 .option message_suffix appendfile string&!! "see below"
23177 The string specified here is expanded and output at the end of every message.
23178 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
23179 in which case it is a single newline character. The suffix can be suppressed by
23180 setting
23181 .code
23182 message_suffix =
23183 .endd
23184 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
23185 &`\n`& to &`\r\n`& in &%message_suffix%&.
23186
23187 .option mode appendfile "octal integer" 0600
23188 If the output file is created, it is given this mode. If it already exists and
23189 has wider permissions, they are reduced to this mode. If it has narrower
23190 permissions, an error occurs unless &%mode_fail_narrower%& is false. However,
23191 if the delivery is the result of a &%save%& command in a filter file specifying
23192 a particular mode, the mode of the output file is always forced to take that
23193 value, and this option is ignored.
23194
23195
23196 .option mode_fail_narrower appendfile boolean true
23197 This option applies in the case when an existing mailbox file has a narrower
23198 mode than that specified by the &%mode%& option. If &%mode_fail_narrower%& is
23199 true, the delivery is deferred (&"mailbox has the wrong mode"&); otherwise Exim
23200 continues with the delivery attempt, using the existing mode of the file.
23201
23202
23203 .option notify_comsat appendfile boolean false
23204 If this option is true, the &'comsat'& daemon is notified after every
23205 successful delivery to a user mailbox. This is the daemon that notifies logged
23206 on users about incoming mail.
23207
23208
23209 .option quota appendfile string&!! unset
23210 .cindex "quota" "imposed by Exim"
23211 This option imposes a limit on the size of the file to which Exim is appending,
23212 or to the total space used in the directory tree when the &%directory%& option
23213 is set. In the latter case, computation of the space used is expensive, because
23214 all the files in the directory (and any sub-directories) have to be
23215 individually inspected and their sizes summed. (See &%quota_size_regex%& and
23216 &%maildir_use_size_file%& for ways to avoid this in environments where users
23217 have no shell access to their mailboxes).
23218
23219 As there is no interlock against two simultaneous deliveries into a
23220 multi-file mailbox, it is possible for the quota to be overrun in this case.
23221 For single-file mailboxes, of course, an interlock is a necessity.
23222
23223 A file's size is taken as its &'used'& value. Because of blocking effects, this
23224 may be a lot less than the actual amount of disk space allocated to the file.
23225 If the sizes of a number of files are being added up, the rounding effect can
23226 become quite noticeable, especially on systems that have large block sizes.
23227 Nevertheless, it seems best to stick to the &'used'& figure, because this is
23228 the obvious value which users understand most easily.
23229
23230 The value of the option is expanded, and must then be a numerical value
23231 (decimal point allowed), optionally followed by one of the letters K, M, or G,
23232 for kilobytes, megabytes, or gigabytes, optionally followed by a slash
23233 and further option modifiers. If Exim is running on a system with
23234 large file support (Linux and FreeBSD have this), mailboxes larger than 2G can
23235 be handled.
23236
23237 The option modifier &%no_check%& can be used to force delivery even if the over
23238 quota condition is met. The quota gets updated as usual.
23239
23240 &*Note*&: A value of zero is interpreted as &"no quota"&.
23241
23242 The expansion happens while Exim is running as root, before it changes uid for
23243 the delivery. This means that files that are inaccessible to the end user can
23244 be used to hold quota values that are looked up in the expansion. When delivery
23245 fails because this quota is exceeded, the handling of the error is as for
23246 system quota failures.
23247
23248 By default, Exim's quota checking mimics system quotas, and restricts the
23249 mailbox to the specified maximum size, though the value is not accurate to the
23250 last byte, owing to separator lines and additional headers that may get added
23251 during message delivery. When a mailbox is nearly full, large messages may get
23252 refused even though small ones are accepted, because the size of the current
23253 message is added to the quota when the check is made. This behaviour can be
23254 changed by setting &%quota_is_inclusive%& false. When this is done, the check
23255 for exceeding the quota does not include the current message. Thus, deliveries
23256 continue until the quota has been exceeded; thereafter, no further messages are
23257 delivered. See also &%quota_warn_threshold%&.
23258
23259
23260 .option quota_directory appendfile string&!! unset
23261 This option defines the directory to check for quota purposes when delivering
23262 into individual files. The default is the delivery directory, or, if a file
23263 called &_maildirfolder_& exists in a maildir directory, the parent of the
23264 delivery directory.
23265
23266
23267 .option quota_filecount appendfile string&!! 0
23268 This option applies when the &%directory%& option is set. It limits the total
23269 number of files in the directory (compare the inode limit in system quotas). It
23270 can only be used if &%quota%& is also set. The value is expanded; an expansion
23271 failure causes delivery to be deferred. A value of zero is interpreted as
23272 &"no quota"&.
23273
23274 The option modifier &%no_check%& can be used to force delivery even if the over
23275 quota condition is met. The quota gets updated as usual.
23276
23277 .option quota_is_inclusive appendfile boolean true
23278 See &%quota%& above.
23279
23280
23281 .option quota_size_regex appendfile string unset
23282 This option applies when one of the delivery modes that writes a separate file
23283 for each message is being used. When Exim wants to find the size of one of
23284 these files in order to test the quota, it first checks &%quota_size_regex%&.
23285 If this is set to a regular expression that matches the filename, and it
23286 captures one string, that string is interpreted as a representation of the
23287 file's size. The value of &%quota_size_regex%& is not expanded.
23288
23289 This feature is useful only when users have no shell access to their mailboxes
23290 &-- otherwise they could defeat the quota simply by renaming the files. This
23291 facility can be used with maildir deliveries, by setting &%maildir_tag%& to add
23292 the file length to the filename. For example:
23293 .code
23294 maildir_tag = ,S=$message_size
23295 quota_size_regex = ,S=(\d+)
23296 .endd
23297 An alternative to &$message_size$& is &$message_linecount$&, which contains the
23298 number of lines in the message.
23299
23300 The regular expression should not assume that the length is at the end of the
23301 filename (even though &%maildir_tag%& puts it there) because maildir MUAs
23302 sometimes add other information onto the ends of message filenames.
23303
23304 Section &<<SECID136>>& contains further information.
23305
23306 This option should not be used when other message-handling software
23307 may duplicate messages by making hardlinks to the files.  When that is done Exim
23308 will count the message size once for each filename, in contrast with the actual
23309 disk usage.  When the option is not set, calculating total usage requires
23310 a system-call per file to get the size; the number of links is then available also
23311 as is used to adjust the effective size.
23312
23313
23314 .option quota_warn_message appendfile string&!! "see below"
23315 See below for the use of this option. If it is not set when
23316 &%quota_warn_threshold%& is set, it defaults to
23317 .code
23318 quota_warn_message = "\
23319   To: $local_part@$domain\n\
23320   Subject: Your mailbox\n\n\
23321   This message is automatically created \
23322   by mail delivery software.\n\n\
23323   The size of your mailbox has exceeded \
23324   a warning threshold that is\n\
23325   set by the system administrator.\n"
23326 .endd
23327
23328
23329 .option quota_warn_threshold appendfile string&!! 0
23330 .cindex "quota" "warning threshold"
23331 .cindex "mailbox" "size warning"
23332 .cindex "size" "of mailbox"
23333 This option is expanded in the same way as &%quota%& (see above). If the
23334 resulting value is greater than zero, and delivery of the message causes the
23335 size of the file or total space in the directory tree to cross the given
23336 threshold, a warning message is sent. If &%quota%& is also set, the threshold
23337 may be specified as a percentage of it by following the value with a percent
23338 sign. For example:
23339 .code
23340 quota = 10M
23341 quota_warn_threshold = 75%
23342 .endd
23343 If &%quota%& is not set, a setting of &%quota_warn_threshold%& that ends with a
23344 percent sign is ignored.
23345
23346 The warning message itself is specified by the &%quota_warn_message%& option,
23347 and it must start with a &'To:'& header line containing the recipient(s) of the
23348 warning message. These do not necessarily have to include the recipient(s) of
23349 the original message. A &'Subject:'& line should also normally be supplied. You
23350 can include any other header lines that you want. If you do not include a
23351 &'From:'& line, the default is:
23352 .code
23353 From: Mail Delivery System <mailer-daemon@$qualify_domain_sender>
23354 .endd
23355 .oindex &%errors_reply_to%&
23356 If you supply a &'Reply-To:'& line, it overrides the global &%errors_reply_to%&
23357 option.
23358
23359 The &%quota%& option does not have to be set in order to use this option; they
23360 are independent of one another except when the threshold is specified as a
23361 percentage.
23362
23363
23364 .option use_bsmtp appendfile boolean false
23365 .cindex "envelope from"
23366 .cindex "envelope sender"
23367 If this option is set true, &(appendfile)& writes messages in &"batch SMTP"&
23368 format, with the envelope sender and recipient(s) included as SMTP commands. If
23369 you want to include a leading HELO command with such messages, you can do
23370 so by setting the &%message_prefix%& option. See section &<<SECTbatchSMTP>>&
23371 for details of batch SMTP.
23372
23373
23374 .option use_crlf appendfile boolean false
23375 .cindex "carriage return"
23376 .cindex "linefeed"
23377 This option causes lines to be terminated with the two-character CRLF sequence
23378 (carriage return, linefeed) instead of just a linefeed character. In the case
23379 of batched SMTP, the byte sequence written to the file is then an exact image
23380 of what would be sent down a real SMTP connection.
23381
23382 &*Note:*& The contents of the &%message_prefix%& and &%message_suffix%& options
23383 (which are used to supply the traditional &"From&~"& and blank line separators
23384 in Berkeley-style mailboxes) are written verbatim, so must contain their own
23385 carriage return characters if these are needed. In cases where these options
23386 have non-empty defaults, the values end with a single linefeed, so they must be
23387 changed to end with &`\r\n`& if &%use_crlf%& is set.
23388
23389
23390 .option use_fcntl_lock appendfile boolean "see below"
23391 This option controls the use of the &[fcntl()]& function to lock a file for
23392 exclusive use when a message is being appended. It is set by default unless
23393 &%use_flock_lock%& is set. Otherwise, it should be turned off only if you know
23394 that all your MUAs use lock file locking. When both &%use_fcntl_lock%& and
23395 &%use_flock_lock%& are unset, &%use_lockfile%& must be set.
23396
23397
23398 .option use_flock_lock appendfile boolean false
23399 This option is provided to support the use of &[flock()]& for file locking, for
23400 the few situations where it is needed. Most modern operating systems support
23401 &[fcntl()]& and &[lockf()]& locking, and these two functions interwork with
23402 each other. Exim uses &[fcntl()]& locking by default.
23403
23404 This option is required only if you are using an operating system where
23405 &[flock()]& is used by programs that access mailboxes (typically MUAs), and
23406 where &[flock()]& does not correctly interwork with &[fcntl()]&. You can use
23407 both &[fcntl()]& and &[flock()]& locking simultaneously if you want.
23408
23409 .cindex "Solaris" "&[flock()]& support"
23410 Not all operating systems provide &[flock()]&. Some versions of Solaris do not
23411 have it (and some, I think, provide a not quite right version built on top of
23412 &[lockf()]&). If the OS does not have &[flock()]&, Exim will be built without
23413 the ability to use it, and any attempt to do so will cause a configuration
23414 error.
23415
23416 &*Warning*&: &[flock()]& locks do not work on NFS files (unless &[flock()]&
23417 is just being mapped onto &[fcntl()]& by the OS).
23418
23419
23420 .option use_lockfile appendfile boolean "see below"
23421 If this option is turned off, Exim does not attempt to create a lock file when
23422 appending to a mailbox file. In this situation, the only locking is by
23423 &[fcntl()]&. You should only turn &%use_lockfile%& off if you are absolutely
23424 sure that every MUA that is ever going to look at your users' mailboxes uses
23425 &[fcntl()]& rather than a lock file, and even then only when you are not
23426 delivering over NFS from more than one host.
23427
23428 .cindex "NFS" "lock file"
23429 In order to append to an NFS file safely from more than one host, it is
23430 necessary to take out a lock &'before'& opening the file, and the lock file
23431 achieves this. Otherwise, even with &[fcntl()]& locking, there is a risk of
23432 file corruption.
23433
23434 The &%use_lockfile%& option is set by default unless &%use_mbx_lock%& is set.
23435 It is not possible to turn both &%use_lockfile%& and &%use_fcntl_lock%& off,
23436 except when &%mbx_format%& is set.
23437
23438
23439 .option use_mbx_lock appendfile boolean "see below"
23440 This option is available only if Exim has been compiled with SUPPORT_MBX
23441 set in &_Local/Makefile_&. Setting the option specifies that special MBX
23442 locking rules be used. It is set by default if &%mbx_format%& is set and none
23443 of the locking options are mentioned in the configuration. The locking rules
23444 are the same as are used by the &'c-client'& library that underlies Pine and
23445 the IMAP4 and POP daemons that come with it (see the discussion below). The
23446 rules allow for shared access to the mailbox. However, this kind of locking
23447 does not work when the mailbox is NFS mounted.
23448
23449 You can set &%use_mbx_lock%& with either (or both) of &%use_fcntl_lock%& and
23450 &%use_flock_lock%& to control what kind of locking is used in implementing the
23451 MBX locking rules. The default is to use &[fcntl()]& if &%use_mbx_lock%& is set
23452 without &%use_fcntl_lock%& or &%use_flock_lock%&.
23453
23454
23455
23456
23457 .section "Operational details for appending" "SECTopappend"
23458 .cindex "appending to a file"
23459 .cindex "file" "appending"
23460 Before appending to a file, the following preparations are made:
23461
23462 .ilist
23463 If the name of the file is &_/dev/null_&, no action is taken, and a success
23464 return is given.
23465
23466 .next
23467 .cindex "directory creation"
23468 If any directories on the file's path are missing, Exim creates them if the
23469 &%create_directory%& option is set. A created directory's mode is given by the
23470 &%directory_mode%& option.
23471
23472 .next
23473 If &%file_format%& is set, the format of an existing file is checked. If this
23474 indicates that a different transport should be used, control is passed to that
23475 transport.
23476
23477 .next
23478 .cindex "file" "locking"
23479 .cindex "locking files"
23480 .cindex "NFS" "lock file"
23481 If &%use_lockfile%& is set, a lock file is built in a way that will work
23482 reliably over NFS, as follows:
23483
23484 .olist
23485 Create a &"hitching post"& file whose name is that of the lock file with the
23486 current time, primary host name, and process id added, by opening for writing
23487 as a new file. If this fails with an access error, delivery is deferred.
23488 .next
23489 Close the hitching post file, and hard link it to the lock filename.
23490 .next
23491 If the call to &[link()]& succeeds, creation of the lock file has succeeded.
23492 Unlink the hitching post name.
23493 .next
23494 Otherwise, use &[stat()]& to get information about the hitching post file, and
23495 then unlink hitching post name. If the number of links is exactly two, creation
23496 of the lock file succeeded but something (for example, an NFS server crash and
23497 restart) caused this fact not to be communicated to the &[link()]& call.
23498 .next
23499 If creation of the lock file failed, wait for &%lock_interval%& and try again,
23500 up to &%lock_retries%& times. However, since any program that writes to a
23501 mailbox should complete its task very quickly, it is reasonable to time out old
23502 lock files that are normally the result of user agent and system crashes. If an
23503 existing lock file is older than &%lockfile_timeout%& Exim attempts to unlink
23504 it before trying again.
23505 .endlist olist
23506
23507 .next
23508 A call is made to &[lstat()]& to discover whether the main file exists, and if
23509 so, what its characteristics are. If &[lstat()]& fails for any reason other
23510 than non-existence, delivery is deferred.
23511
23512 .next
23513 .cindex "symbolic link" "to mailbox"
23514 .cindex "mailbox" "symbolic link"
23515 If the file does exist and is a symbolic link, delivery is deferred, unless the
23516 &%allow_symlink%& option is set, in which case the ownership of the link is
23517 checked, and then &[stat()]& is called to find out about the real file, which
23518 is then subjected to the checks below. The check on the top-level link
23519 ownership prevents one user creating a link for another's mailbox in a sticky
23520 directory, though allowing symbolic links in this case is definitely not a good
23521 idea. If there is a chain of symbolic links, the intermediate ones are not
23522 checked.
23523
23524 .next
23525 If the file already exists but is not a regular file, or if the file's owner
23526 and group (if the group is being checked &-- see &%check_group%& above) are
23527 different from the user and group under which the delivery is running,
23528 delivery is deferred.
23529
23530 .next
23531 If the file's permissions are more generous than specified, they are reduced.
23532 If they are insufficient, delivery is deferred, unless &%mode_fail_narrower%&
23533 is set false, in which case the delivery is tried using the existing
23534 permissions.
23535
23536 .next
23537 The file's inode number is saved, and the file is then opened for appending.
23538 If this fails because the file has vanished, &(appendfile)& behaves as if it
23539 hadn't existed (see below). For any other failures, delivery is deferred.
23540
23541 .next
23542 If the file is opened successfully, check that the inode number hasn't
23543 changed, that it is still a regular file, and that the owner and permissions
23544 have not changed. If anything is wrong, defer delivery and freeze the message.
23545
23546 .next
23547 If the file did not exist originally, defer delivery if the &%file_must_exist%&
23548 option is set. Otherwise, check that the file is being created in a permitted
23549 directory if the &%create_file%& option is set (deferring on failure), and then
23550 open for writing as a new file, with the O_EXCL and O_CREAT options,
23551 except when dealing with a symbolic link (the &%allow_symlink%& option must be
23552 set). In this case, which can happen if the link points to a non-existent file,
23553 the file is opened for writing using O_CREAT but not O_EXCL, because
23554 that prevents link following.
23555
23556 .next
23557 .cindex "loop" "while file testing"
23558 If opening fails because the file exists, obey the tests given above for
23559 existing files. However, to avoid looping in a situation where the file is
23560 being continuously created and destroyed, the exists/not-exists loop is broken
23561 after 10 repetitions, and the message is then frozen.
23562
23563 .next
23564 If opening fails with any other error, defer delivery.
23565
23566 .next
23567 .cindex "file" "locking"
23568 .cindex "locking files"
23569 Once the file is open, unless both &%use_fcntl_lock%& and &%use_flock_lock%&
23570 are false, it is locked using &[fcntl()]& or &[flock()]& or both. If
23571 &%use_mbx_lock%& is false, an exclusive lock is requested in each case.
23572 However, if &%use_mbx_lock%& is true, Exim takes out a shared lock on the open
23573 file, and an exclusive lock on the file whose name is
23574 .code
23575 /tmp/.<device-number>.<inode-number>
23576 .endd
23577 using the device and inode numbers of the open mailbox file, in accordance with
23578 the MBX locking rules. This file is created with a mode that is specified by
23579 the &%lockfile_mode%& option.
23580
23581 If Exim fails to lock the file, there are two possible courses of action,
23582 depending on the value of the locking timeout. This is obtained from
23583 &%lock_fcntl_timeout%& or &%lock_flock_timeout%&, as appropriate.
23584
23585 If the timeout value is zero, the file is closed, Exim waits for
23586 &%lock_interval%&, and then goes back and re-opens the file as above and tries
23587 to lock it again. This happens up to &%lock_retries%& times, after which the
23588 delivery is deferred.
23589
23590 If the timeout has a value greater than zero, blocking calls to &[fcntl()]& or
23591 &[flock()]& are used (with the given timeout), so there has already been some
23592 waiting involved by the time locking fails. Nevertheless, Exim does not give up
23593 immediately. It retries up to
23594 .code
23595 (lock_retries * lock_interval) / <timeout>
23596 .endd
23597 times (rounded up).
23598 .endlist
23599
23600 At the end of delivery, Exim closes the file (which releases the &[fcntl()]&
23601 and/or &[flock()]& locks) and then deletes the lock file if one was created.
23602
23603
23604 .section "Operational details for delivery to a new file" "SECTopdir"
23605 .cindex "delivery" "to single file"
23606 .cindex "&""From""& line"
23607 When the &%directory%& option is set instead of &%file%&, each message is
23608 delivered into a newly-created file or set of files. When &(appendfile)& is
23609 activated directly from a &(redirect)& router, neither &%file%& nor
23610 &%directory%& is normally set, because the path for delivery is supplied by the
23611 router. (See for example, the &(address_file)& transport in the default
23612 configuration.) In this case, delivery is to a new file if either the path name
23613 ends in &`/`&, or the &%maildir_format%& or &%mailstore_format%& option is set.
23614
23615 No locking is required while writing the message to a new file, so the various
23616 locking options of the transport are ignored. The &"From"& line that by default
23617 separates messages in a single file is not normally needed, nor is the escaping
23618 of message lines that start with &"From"&, and there is no need to ensure a
23619 newline at the end of each message. Consequently, the default values for
23620 &%check_string%&, &%message_prefix%&, and &%message_suffix%& are all unset when
23621 any of &%directory%&, &%maildir_format%&, or &%mailstore_format%& is set.
23622
23623 If Exim is required to check a &%quota%& setting, it adds up the sizes of all
23624 the files in the delivery directory by default. However, you can specify a
23625 different directory by setting &%quota_directory%&. Also, for maildir
23626 deliveries (see below) the &_maildirfolder_& convention is honoured.
23627
23628
23629 .cindex "maildir format"
23630 .cindex "mailstore format"
23631 There are three different ways in which delivery to individual files can be
23632 done, controlled by the settings of the &%maildir_format%& and
23633 &%mailstore_format%& options. Note that code to support maildir or mailstore
23634 formats is not included in the binary unless SUPPORT_MAILDIR or
23635 SUPPORT_MAILSTORE, respectively, is set in &_Local/Makefile_&.
23636
23637 .cindex "directory creation"
23638 In all three cases an attempt is made to create the directory and any necessary
23639 sub-directories if they do not exist, provided that the &%create_directory%&
23640 option is set (the default). The location of a created directory can be
23641 constrained by setting &%create_file%&. A created directory's mode is given by
23642 the &%directory_mode%& option. If creation fails, or if the
23643 &%create_directory%& option is not set when creation is required, delivery is
23644 deferred.
23645
23646
23647
23648 .section "Maildir delivery" "SECTmaildirdelivery"
23649 .cindex "maildir format" "description of"
23650 If the &%maildir_format%& option is true, Exim delivers each message by writing
23651 it to a file whose name is &_tmp/<stime>.H<mtime>P<pid>.<host>_& in the
23652 directory that is defined by the &%directory%& option (the &"delivery
23653 directory"&). If the delivery is successful, the file is renamed into the
23654 &_new_& subdirectory.
23655
23656 In the filename, <&'stime'&> is the current time of day in seconds, and
23657 <&'mtime'&> is the microsecond fraction of the time. After a maildir delivery,
23658 Exim checks that the time-of-day clock has moved on by at least one microsecond
23659 before terminating the delivery process. This guarantees uniqueness for the
23660 filename. However, as a precaution, Exim calls &[stat()]& for the file before
23661 opening it. If any response other than ENOENT (does not exist) is given,
23662 Exim waits 2 seconds and tries again, up to &%maildir_retries%& times.
23663
23664 Before Exim carries out a maildir delivery, it ensures that subdirectories
23665 called &_new_&, &_cur_&, and &_tmp_& exist in the delivery directory. If they
23666 do not exist, Exim tries to create them and any superior directories in their
23667 path, subject to the &%create_directory%& and &%create_file%& options. If the
23668 &%maildirfolder_create_regex%& option is set, and the regular expression it
23669 contains matches the delivery directory, Exim also ensures that a file called
23670 &_maildirfolder_& exists in the delivery directory. If a missing directory or
23671 &_maildirfolder_& file cannot be created, delivery is deferred.
23672
23673 These features make it possible to use Exim to create all the necessary files
23674 and directories in a maildir mailbox, including subdirectories for maildir++
23675 folders. Consider this example:
23676 .code
23677 maildir_format = true
23678 directory = /var/mail/$local_part_data\
23679            ${if eq{$local_part_suffix}{}{}\
23680            {/.${substr_1:$local_part_suffix}}}
23681 maildirfolder_create_regex = /\.[^/]+$
23682 .endd
23683 If &$local_part_suffix$& is empty (there was no suffix for the local part),
23684 delivery is into a toplevel maildir with a name like &_/var/mail/pimbo_& (for
23685 the user called &'pimbo'&). The pattern in &%maildirfolder_create_regex%& does
23686 not match this name, so Exim will not look for or create the file
23687 &_/var/mail/pimbo/maildirfolder_&, though it will create
23688 &_/var/mail/pimbo/{cur,new,tmp}_& if necessary.
23689
23690 However, if &$local_part_suffix$& contains &`-eximusers`& (for example),
23691 delivery is into the maildir++ folder &_/var/mail/pimbo/.eximusers_&, which
23692 does match &%maildirfolder_create_regex%&. In this case, Exim will create
23693 &_/var/mail/pimbo/.eximusers/maildirfolder_& as well as the three maildir
23694 directories &_/var/mail/pimbo/.eximusers/{cur,new,tmp}_&.
23695
23696 &*Warning:*& Take care when setting &%maildirfolder_create_regex%& that it does
23697 not inadvertently match the toplevel maildir directory, because a
23698 &_maildirfolder_& file at top level would completely break quota calculations.
23699
23700 .cindex "quota" "in maildir delivery"
23701 .cindex "maildir++"
23702 If Exim is required to check a &%quota%& setting before a maildir delivery, and
23703 &%quota_directory%& is not set, it looks for a file called &_maildirfolder_& in
23704 the maildir directory (alongside &_new_&, &_cur_&, &_tmp_&). If this exists,
23705 Exim assumes the directory is a maildir++ folder directory, which is one level
23706 down from the user's top level mailbox directory. This causes it to start at
23707 the parent directory instead of the current directory when calculating the
23708 amount of space used.
23709
23710 One problem with delivering into a multi-file mailbox is that it is
23711 computationally expensive to compute the size of the mailbox for quota
23712 checking. Various approaches have been taken to reduce the amount of work
23713 needed. The next two sections describe two of them. A third alternative is to
23714 use some external process for maintaining the size data, and use the expansion
23715 of the &%mailbox_size%& option as a way of importing it into Exim.
23716
23717
23718
23719
23720 .section "Using tags to record message sizes" "SECID135"
23721 If &%maildir_tag%& is set, the string is expanded for each delivery.
23722 When the maildir file is renamed into the &_new_& sub-directory, the
23723 tag is added to its name. However, if adding the tag takes the length of the
23724 name to the point where the test &[stat()]& call fails with ENAMETOOLONG,
23725 the tag is dropped and the maildir file is created with no tag.
23726
23727
23728 .vindex "&$message_size$&"
23729 Tags can be used to encode the size of files in their names; see
23730 &%quota_size_regex%& above for an example. The expansion of &%maildir_tag%&
23731 happens after the message has been written. The value of the &$message_size$&
23732 variable is set to the number of bytes actually written. If the expansion is
23733 forced to fail, the tag is ignored, but a non-forced failure causes delivery to
23734 be deferred. The expanded tag may contain any printing characters except &"/"&.
23735 Non-printing characters in the string are ignored; if the resulting string is
23736 empty, it is ignored. If it starts with an alphanumeric character, a leading
23737 colon is inserted; this default has not proven to be the path that popular
23738 maildir implementations have chosen (but changing it in Exim would break
23739 backwards compatibility).
23740
23741 For one common implementation, you might set:
23742 .code
23743 maildir_tag = ,S=${message_size}
23744 .endd
23745 but you should check the documentation of the other software to be sure.
23746
23747 It is advisable to also set &%quota_size_regex%& when setting &%maildir_tag%&
23748 as this allows Exim to extract the size from your tag, instead of having to
23749 &[stat()]& each message file.
23750
23751
23752 .section "Using a maildirsize file" "SECID136"
23753 .cindex "quota" "in maildir delivery"
23754 .cindex "maildir format" "&_maildirsize_& file"
23755 If &%maildir_use_size_file%& is true, Exim implements the maildir++ rules for
23756 storing quota and message size information in a file called &_maildirsize_&
23757 within the toplevel maildir directory. If this file does not exist, Exim
23758 creates it, setting the quota from the &%quota%& option of the transport. If
23759 the maildir directory itself does not exist, it is created before any attempt
23760 to write a &_maildirsize_& file.
23761
23762 The &_maildirsize_& file is used to hold information about the sizes of
23763 messages in the maildir, thus speeding up quota calculations. The quota value
23764 in the file is just a cache; if the quota is changed in the transport, the new
23765 value overrides the cached value when the next message is delivered. The cache
23766 is maintained for the benefit of other programs that access the maildir and
23767 need to know the quota.
23768
23769 If the &%quota%& option in the transport is unset or zero, the &_maildirsize_&
23770 file is maintained (with a zero quota setting), but no quota is imposed.
23771
23772 A regular expression is available for controlling which directories in the
23773 maildir participate in quota calculations when a &_maildirsizefile_& is in use.
23774 See the description of the &%maildir_quota_directory_regex%& option above for
23775 details.
23776
23777
23778 .section "Mailstore delivery" "SECID137"
23779 .cindex "mailstore format" "description of"
23780 If the &%mailstore_format%& option is true, each message is written as two
23781 files in the given directory. A unique base name is constructed from the
23782 message id and the current delivery process, and the files that are written use
23783 this base name plus the suffixes &_.env_& and &_.msg_&. The &_.env_& file
23784 contains the message's envelope, and the &_.msg_& file contains the message
23785 itself. The base name is placed in the variable &$mailstore_basename$&.
23786
23787 During delivery, the envelope is first written to a file with the suffix
23788 &_.tmp_&. The &_.msg_& file is then written, and when it is complete, the
23789 &_.tmp_& file is renamed as the &_.env_& file. Programs that access messages in
23790 mailstore format should wait for the presence of both a &_.msg_& and a &_.env_&
23791 file before accessing either of them. An alternative approach is to wait for
23792 the absence of a &_.tmp_& file.
23793
23794 The envelope file starts with any text defined by the &%mailstore_prefix%&
23795 option, expanded and terminated by a newline if there isn't one. Then follows
23796 the sender address on one line, then all the recipient addresses, one per line.
23797 There can be more than one recipient only if the &%batch_max%& option is set
23798 greater than one. Finally, &%mailstore_suffix%& is expanded and the result
23799 appended to the file, followed by a newline if it does not end with one.
23800
23801 If expansion of &%mailstore_prefix%& or &%mailstore_suffix%& ends with a forced
23802 failure, it is ignored. Other expansion errors are treated as serious
23803 configuration errors, and delivery is deferred. The variable
23804 &$mailstore_basename$& is available for use during these expansions.
23805
23806
23807 .section "Non-special new file delivery" "SECID138"
23808 If neither &%maildir_format%& nor &%mailstore_format%& is set, a single new
23809 file is created directly in the named directory. For example, when delivering
23810 messages into files in batched SMTP format for later delivery to some host (see
23811 section &<<SECTbatchSMTP>>&), a setting such as
23812 .code
23813 directory = /var/bsmtp/$host
23814 .endd
23815 might be used. A message is written to a file with a temporary name, which is
23816 then renamed when the delivery is complete. The final name is obtained by
23817 expanding the contents of the &%directory_file%& option.
23818 .ecindex IIDapptra1
23819 .ecindex IIDapptra2
23820
23821
23822
23823
23824
23825
23826 . ////////////////////////////////////////////////////////////////////////////
23827 . ////////////////////////////////////////////////////////////////////////////
23828
23829 .chapter "The autoreply transport" "CHID8"
23830 .scindex IIDauttra1 "transports" "&(autoreply)&"
23831 .scindex IIDauttra2 "&(autoreply)& transport"
23832 The &(autoreply)& transport is not a true transport in that it does not cause
23833 the message to be transmitted. Instead, it generates a new mail message as an
23834 automatic reply to the incoming message. &'References:'& and
23835 &'Auto-Submitted:'& header lines are included. These are constructed according
23836 to the rules in RFCs 2822 and 3834, respectively.
23837
23838 If the router that passes the message to this transport does not have the
23839 &%unseen%& option set, the original message (for the current recipient) is not
23840 delivered anywhere. However, when the &%unseen%& option is set on the router
23841 that passes the message to this transport, routing of the address continues, so
23842 another router can set up a normal message delivery.
23843
23844
23845 The &(autoreply)& transport is usually run as the result of mail filtering, a
23846 &"vacation"& message being the standard example. However, it can also be run
23847 directly from a router like any other transport. To reduce the possibility of
23848 message cascades, messages created by the &(autoreply)& transport always have
23849 empty envelope sender addresses, like bounce messages.
23850
23851 The parameters of the message to be sent can be specified in the configuration
23852 by options described below. However, these are used only when the address
23853 passed to the transport does not contain its own reply information. When the
23854 transport is run as a consequence of a
23855 &%mail%&
23856 or &%vacation%& command in a filter file, the parameters of the message are
23857 supplied by the filter, and passed with the address. The transport's options
23858 that define the message are then ignored (so they are not usually set in this
23859 case). The message is specified entirely by the filter or by the transport; it
23860 is never built from a mixture of options. However, the &%file_optional%&,
23861 &%mode%&, and &%return_message%& options apply in all cases.
23862
23863 &(Autoreply)& is implemented as a local transport. When used as a result of a
23864 command in a user's filter file, &(autoreply)& normally runs under the uid and
23865 gid of the user, and with appropriate current and home directories (see chapter
23866 &<<CHAPenvironment>>&).
23867
23868 There is a subtle difference between routing a message to a &(pipe)& transport
23869 that generates some text to be returned to the sender, and routing it to an
23870 &(autoreply)& transport. This difference is noticeable only if more than one
23871 address from the same message is so handled. In the case of a pipe, the
23872 separate outputs from the different addresses are gathered up and returned to
23873 the sender in a single message, whereas if &(autoreply)& is used, a separate
23874 message is generated for each address that is passed to it.
23875
23876 Non-printing characters are not permitted in the header lines generated for the
23877 message that &(autoreply)& creates, with the exception of newlines that are
23878 immediately followed by white space. If any non-printing characters are found,
23879 the transport defers.
23880 Whether characters with the top bit set count as printing characters or not is
23881 controlled by the &%print_topbitchars%& global option.
23882
23883 If any of the generic options for manipulating headers (for example,
23884 &%headers_add%&) are set on an &(autoreply)& transport, they apply to the copy
23885 of the original message that is included in the generated message when
23886 &%return_message%& is set. They do not apply to the generated message itself.
23887
23888 .vindex "&$sender_address$&"
23889 If the &(autoreply)& transport receives return code 2 from Exim when it submits
23890 the message, indicating that there were no recipients, it does not treat this
23891 as an error. This means that autoreplies sent to &$sender_address$& when this
23892 is empty (because the incoming message is a bounce message) do not cause
23893 problems. They are just discarded.
23894
23895
23896
23897 .section "Private options for autoreply" "SECID139"
23898 .cindex "options" "&(autoreply)& transport"
23899
23900 .option bcc autoreply string&!! unset
23901 This specifies the addresses that are to receive &"blind carbon copies"& of the
23902 message when the message is specified by the transport.
23903
23904
23905 .option cc autoreply string&!! unset
23906 This specifies recipients of the message and the contents of the &'Cc:'& header
23907 when the message is specified by the transport.
23908
23909
23910 .option file autoreply string&!! unset
23911 The contents of the file are sent as the body of the message when the message
23912 is specified by the transport. If both &%file%& and &%text%& are set, the text
23913 string comes first.
23914
23915
23916 .option file_expand autoreply boolean false
23917 If this is set, the contents of the file named by the &%file%& option are
23918 subjected to string expansion as they are added to the message.
23919
23920
23921 .option file_optional autoreply boolean false
23922 If this option is true, no error is generated if the file named by the &%file%&
23923 option or passed with the address does not exist or cannot be read.
23924
23925
23926 .option from autoreply string&!! unset
23927 This specifies the contents of the &'From:'& header when the message is
23928 specified by the transport.
23929
23930
23931 .option headers autoreply string&!! unset
23932 This specifies additional RFC 2822 headers that are to be added to the message
23933 when the message is specified by the transport. Several can be given by using
23934 &"\n"& to separate them. There is no check on the format.
23935
23936
23937 .option log autoreply string&!! unset
23938 This option names a file in which a record of every message sent is logged when
23939 the message is specified by the transport.
23940
23941
23942 .option mode autoreply "octal integer" 0600
23943 If either the log file or the &"once"& file has to be created, this mode is
23944 used.
23945
23946
23947 .option never_mail autoreply "address list&!!" unset
23948 If any run of the transport creates a message with a recipient that matches any
23949 item in the list, that recipient is quietly discarded. If all recipients are
23950 discarded, no message is created. This applies both when the recipients are
23951 generated by a filter and when they are specified in the transport.
23952
23953
23954
23955 .option once autoreply string&!! unset
23956 This option names a file or DBM database in which a record of each &'To:'&
23957 recipient is kept when the message is specified by the transport. &*Note*&:
23958 This does not apply to &'Cc:'& or &'Bcc:'& recipients.
23959
23960 If &%once%& is unset, or is set to an empty string, the message is always sent.
23961 By default, if &%once%& is set to a non-empty filename, the message
23962 is not sent if a potential recipient is already listed in the database.
23963 However, if the &%once_repeat%& option specifies a time greater than zero, the
23964 message is sent if that much time has elapsed since a message was last sent to
23965 this recipient. A setting of zero time for &%once_repeat%& (the default)
23966 prevents a message from being sent a second time &-- in this case, zero means
23967 infinity.
23968
23969 If &%once_file_size%& is zero, a DBM database is used to remember recipients,
23970 and it is allowed to grow as large as necessary. If &%once_file_size%& is set
23971 greater than zero, it changes the way Exim implements the &%once%& option.
23972 Instead of using a DBM file to record every recipient it sends to, it uses a
23973 regular file, whose size will never get larger than the given value.
23974
23975 In the file, Exim keeps a linear list of recipient addresses and the times at
23976 which they were sent messages. If the file is full when a new address needs to
23977 be added, the oldest address is dropped. If &%once_repeat%& is not set, this
23978 means that a given recipient may receive multiple messages, but at
23979 unpredictable intervals that depend on the rate of turnover of addresses in the
23980 file. If &%once_repeat%& is set, it specifies a maximum time between repeats.
23981
23982
23983 .option once_file_size autoreply integer 0
23984 See &%once%& above.
23985
23986
23987 .option once_repeat autoreply time&!! 0s
23988 See &%once%& above.
23989 After expansion, the value of this option must be a valid time value.
23990
23991
23992 .option reply_to autoreply string&!! unset
23993 This specifies the contents of the &'Reply-To:'& header when the message is
23994 specified by the transport.
23995
23996
23997 .option return_message autoreply boolean false
23998 If this is set, a copy of the original message is returned with the new
23999 message, subject to the maximum size set in the &%return_size_limit%& global
24000 configuration option.
24001
24002
24003 .option subject autoreply string&!! unset
24004 This specifies the contents of the &'Subject:'& header when the message is
24005 specified by the transport. It is tempting to quote the original subject in
24006 automatic responses. For example:
24007 .code
24008 subject = Re: $h_subject:
24009 .endd
24010 There is a danger in doing this, however. It may allow a third party to
24011 subscribe your users to an opt-in mailing list, provided that the list accepts
24012 bounce messages as subscription confirmations. Well-managed lists require a
24013 non-bounce message to confirm a subscription, so the danger is relatively
24014 small.
24015
24016
24017
24018 .option text autoreply string&!! unset
24019 This specifies a single string to be used as the body of the message when the
24020 message is specified by the transport. If both &%text%& and &%file%& are set,
24021 the text comes first.
24022
24023
24024 .option to autoreply string&!! unset
24025 This specifies recipients of the message and the contents of the &'To:'& header
24026 when the message is specified by the transport.
24027 .ecindex IIDauttra1
24028 .ecindex IIDauttra2
24029
24030
24031
24032
24033 . ////////////////////////////////////////////////////////////////////////////
24034 . ////////////////////////////////////////////////////////////////////////////
24035
24036 .chapter "The lmtp transport" "CHAPLMTP"
24037 .cindex "transports" "&(lmtp)&"
24038 .cindex "&(lmtp)& transport"
24039 .cindex "LMTP" "over a pipe"
24040 .cindex "LMTP" "over a socket"
24041 The &(lmtp)& transport runs the LMTP protocol (RFC 2033) over a pipe to a
24042 specified command
24043 or by interacting with a Unix domain socket.
24044 This transport is something of a cross between the &(pipe)& and &(smtp)&
24045 transports. Exim also has support for using LMTP over TCP/IP; this is
24046 implemented as an option for the &(smtp)& transport. Because LMTP is expected
24047 to be of minority interest, the default build-time configure in &_src/EDITME_&
24048 has it commented out. You need to ensure that
24049 .code
24050 TRANSPORT_LMTP=yes
24051 .endd
24052 .cindex "options" "&(lmtp)& transport"
24053 is present in your &_Local/Makefile_& in order to have the &(lmtp)& transport
24054 included in the Exim binary. The private options of the &(lmtp)& transport are
24055 as follows:
24056
24057 .option batch_id lmtp string&!! unset
24058 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
24059
24060
24061 .option batch_max lmtp integer 1
24062 This limits the number of addresses that can be handled in a single delivery.
24063 Most LMTP servers can handle several addresses at once, so it is normally a
24064 good idea to increase this value. See the description of local delivery
24065 batching in chapter &<<CHAPbatching>>&.
24066
24067
24068 .option command lmtp string&!! unset
24069 This option must be set if &%socket%& is not set. The string is a command which
24070 is run in a separate process. It is split up into a command name and list of
24071 arguments, each of which is separately expanded (so expansion cannot change the
24072 number of arguments). The command is run directly, not via a shell. The message
24073 is passed to the new process using the standard input and output to operate the
24074 LMTP protocol.
24075
24076 .option ignore_quota lmtp boolean false
24077 .cindex "LMTP" "ignoring quota errors"
24078 If this option is set true, the string &`IGNOREQUOTA`& is added to RCPT
24079 commands, provided that the LMTP server has advertised support for IGNOREQUOTA
24080 in its response to the LHLO command.
24081
24082 .option socket lmtp string&!! unset
24083 This option must be set if &%command%& is not set. The result of expansion must
24084 be the name of a Unix domain socket. The transport connects to the socket and
24085 delivers the message to it using the LMTP protocol.
24086
24087
24088 .option timeout lmtp time 5m
24089 The transport is aborted if the created process or Unix domain socket does not
24090 respond to LMTP commands or message input within this timeout. Delivery
24091 is deferred, and will be tried again later. Here is an example of a typical
24092 LMTP transport:
24093 .code
24094 lmtp:
24095   driver = lmtp
24096   command = /some/local/lmtp/delivery/program
24097   batch_max = 20
24098   user = exim
24099 .endd
24100 This delivers up to 20 addresses at a time, in a mixture of domains if
24101 necessary, running as the user &'exim'&.
24102
24103
24104
24105 . ////////////////////////////////////////////////////////////////////////////
24106 . ////////////////////////////////////////////////////////////////////////////
24107
24108 .chapter "The pipe transport" "CHAPpipetransport"
24109 .scindex IIDpiptra1 "transports" "&(pipe)&"
24110 .scindex IIDpiptra2 "&(pipe)& transport"
24111 The &(pipe)& transport is used to deliver messages via a pipe to a command
24112 running in another process. One example is the use of &(pipe)& as a
24113 pseudo-remote transport for passing messages to some other delivery mechanism
24114 (such as UUCP). Another is the use by individual users to automatically process
24115 their incoming messages. The &(pipe)& transport can be used in one of the
24116 following ways:
24117
24118 .ilist
24119 .vindex "&$local_part$&"
24120 A router routes one address to a transport in the normal way, and the
24121 transport is configured as a &(pipe)& transport. In this case, &$local_part$&
24122 contains the local part of the address (as usual), and the command that is run
24123 is specified by the &%command%& option on the transport.
24124 .next
24125 .vindex "&$pipe_addresses$&"
24126 If the &%batch_max%& option is set greater than 1 (the default is 1), the
24127 transport can handle more than one address in a single run. In this case, when
24128 more than one address is routed to the transport, &$local_part$& is not set
24129 (because it is not unique). However, the pseudo-variable &$pipe_addresses$&
24130 (described in section &<<SECThowcommandrun>>& below) contains all the addresses
24131 that are routed to the transport.
24132 .next
24133 .vindex "&$address_pipe$&"
24134 A router redirects an address directly to a pipe command (for example, from an
24135 alias or forward file). In this case, &$address_pipe$& contains the text of the
24136 pipe command, and the &%command%& option on the transport is ignored unless
24137 &%force_command%& is set. If only one address is being transported
24138 (&%batch_max%& is not greater than one, or only one address was redirected to
24139 this pipe command), &$local_part$& contains the local part that was redirected.
24140 .endlist
24141
24142
24143 The &(pipe)& transport is a non-interactive delivery method. Exim can also
24144 deliver messages over pipes using the LMTP interactive protocol. This is
24145 implemented by the &(lmtp)& transport.
24146
24147 In the case when &(pipe)& is run as a consequence of an entry in a local user's
24148 &_.forward_& file, the command runs under the uid and gid of that user. In
24149 other cases, the uid and gid have to be specified explicitly, either on the
24150 transport or on the router that handles the address. Current and &"home"&
24151 directories are also controllable. See chapter &<<CHAPenvironment>>& for
24152 details of the local delivery environment and chapter &<<CHAPbatching>>&
24153 for a discussion of local delivery batching.
24154
24155 .new
24156 .cindex "tainted data" "in pipe command"
24157 .cindex pipe "tainted data"
24158 Tainted data may not be used for the command name.
24159 .wen
24160
24161
24162 .section "Concurrent delivery" "SECID140"
24163 If two messages arrive at almost the same time, and both are routed to a pipe
24164 delivery, the two pipe transports may be run concurrently. You must ensure that
24165 any pipe commands you set up are robust against this happening. If the commands
24166 write to a file, the &%exim_lock%& utility might be of use.
24167 Alternatively the &%max_parallel%& option could be used with a value
24168 of "1" to enforce serialization.
24169
24170
24171
24172
24173 .section "Returned status and data" "SECID141"
24174 .cindex "&(pipe)& transport" "returned data"
24175 If the command exits with a non-zero return code, the delivery is deemed to
24176 have failed, unless either the &%ignore_status%& option is set (in which case
24177 the return code is treated as zero), or the return code is one of those listed
24178 in the &%temp_errors%& option, which are interpreted as meaning &"try again
24179 later"&. In this case, delivery is deferred. Details of a permanent failure are
24180 logged, but are not included in the bounce message, which merely contains
24181 &"local delivery failed"&.
24182
24183 If the command exits on a signal and the &%freeze_signal%& option is set then
24184 the message will be frozen in the queue. If that option is not set, a bounce
24185 will be sent as normal.
24186
24187 If the return code is greater than 128 and the command being run is a shell
24188 script, it normally means that the script was terminated by a signal whose
24189 value is the return code minus 128. The &%freeze_signal%& option does not
24190 apply in this case.
24191
24192 If Exim is unable to run the command (that is, if &[execve()]& fails), the
24193 return code is set to 127. This is the value that a shell returns if it is
24194 asked to run a non-existent command. The wording for the log line suggests that
24195 a non-existent command may be the problem.
24196
24197 The &%return_output%& option can affect the result of a pipe delivery. If it is
24198 set and the command produces any output on its standard output or standard
24199 error streams, the command is considered to have failed, even if it gave a zero
24200 return code or if &%ignore_status%& is set. The output from the command is
24201 included as part of the bounce message. The &%return_fail_output%& option is
24202 similar, except that output is returned only when the command exits with a
24203 failure return code, that is, a value other than zero or a code that matches
24204 &%temp_errors%&.
24205
24206
24207
24208 .section "How the command is run" "SECThowcommandrun"
24209 .cindex "&(pipe)& transport" "path for command"
24210 The command line is (by default) broken down into a command name and arguments
24211 by the &(pipe)& transport itself. The &%allow_commands%& and
24212 &%restrict_to_path%& options can be used to restrict the commands that may be
24213 run.
24214
24215 .cindex "quoting" "in pipe command"
24216 Unquoted arguments are delimited by white space. If an argument appears in
24217 double quotes, backslash is interpreted as an escape character in the usual
24218 way. If an argument appears in single quotes, no escaping is done.
24219
24220 String expansion is applied to the command line except when it comes from a
24221 traditional &_.forward_& file (commands from a filter file are expanded). The
24222 expansion is applied to each argument in turn rather than to the whole line.
24223 For this reason, any string expansion item that contains white space must be
24224 quoted so as to be contained within a single argument. A setting such as
24225 .code
24226 command = /some/path ${if eq{$local_part}{postmaster}{xx}{yy}}
24227 .endd
24228 will not work, because the expansion item gets split between several
24229 arguments. You have to write
24230 .code
24231 command = /some/path "${if eq{$local_part}{postmaster}{xx}{yy}}"
24232 .endd
24233 to ensure that it is all in one argument. The expansion is done in this way,
24234 argument by argument, so that the number of arguments cannot be changed as a
24235 result of expansion, and quotes or backslashes in inserted variables do not
24236 interact with external quoting. However, this leads to problems if you want to
24237 generate multiple arguments (or the command name plus arguments) from a single
24238 expansion. In this situation, the simplest solution is to use a shell. For
24239 example:
24240 .code
24241 command = /bin/sh -c ${lookup{$local_part}lsearch{/some/file}}
24242 .endd
24243
24244 .cindex "transport" "filter"
24245 .cindex "filter" "transport filter"
24246 .vindex "&$pipe_addresses$&"
24247 Special handling takes place when an argument consists of precisely the text
24248 &`$pipe_addresses`& (no quotes).
24249 This is not a general expansion variable; the only
24250 place this string is recognized is when it appears as an argument for a pipe or
24251 transport filter command. It causes each address that is being handled to be
24252 inserted in the argument list at that point &'as a separate argument'&. This
24253 avoids any problems with spaces or shell metacharacters, and is of use when a
24254 &(pipe)& transport is handling groups of addresses in a batch.
24255
24256 If &%force_command%& is enabled on the transport, special handling takes place
24257 for an argument that consists of precisely the text &`$address_pipe`&.  It
24258 is handled similarly to &$pipe_addresses$& above.  It is expanded and each
24259 argument is inserted in the argument list at that point
24260 &'as a separate argument'&.  The &`$address_pipe`& item does not need to be
24261 the only item in the argument; in fact, if it were then &%force_command%&
24262 should behave as a no-op.  Rather, it should be used to adjust the command
24263 run while preserving the argument vector separation.
24264
24265 After splitting up into arguments and expansion, the resulting command is run
24266 in a subprocess directly from the transport, &'not'& under a shell. The
24267 message that is being delivered is supplied on the standard input, and the
24268 standard output and standard error are both connected to a single pipe that is
24269 read by Exim. The &%max_output%& option controls how much output the command
24270 may produce, and the &%return_output%& and &%return_fail_output%& options
24271 control what is done with it.
24272
24273 Not running the command under a shell (by default) lessens the security risks
24274 in cases when a command from a user's filter file is built out of data that was
24275 taken from an incoming message. If a shell is required, it can of course be
24276 explicitly specified as the command to be run. However, there are circumstances
24277 where existing commands (for example, in &_.forward_& files) expect to be run
24278 under a shell and cannot easily be modified. To allow for these cases, there is
24279 an option called &%use_shell%&, which changes the way the &(pipe)& transport
24280 works. Instead of breaking up the command line as just described, it expands it
24281 as a single string and passes the result to &_/bin/sh_&. The
24282 &%restrict_to_path%& option and the &$pipe_addresses$& facility cannot be used
24283 with &%use_shell%&, and the whole mechanism is inherently less secure.
24284
24285
24286
24287 .section "Environment variables" "SECTpipeenv"
24288 .cindex "&(pipe)& transport" "environment for command"
24289 .cindex "environment" "&(pipe)& transport"
24290 The environment variables listed below are set up when the command is invoked.
24291 This list is a compromise for maximum compatibility with other MTAs. Note that
24292 the &%environment%& option can be used to add additional variables to this
24293 environment. The environment for the &(pipe)& transport is not subject
24294 to the &%add_environment%& and &%keep_environment%& main config options.
24295 .display
24296 &`DOMAIN            `&   the domain of the address
24297 &`HOME              `&   the home directory, if set
24298 &`HOST              `&   the host name when called from a router (see below)
24299 &`LOCAL_PART        `&   see below
24300 &`LOCAL_PART_PREFIX `&   see below
24301 &`LOCAL_PART_SUFFIX `&   see below
24302 &`LOGNAME           `&   see below
24303 &`MESSAGE_ID        `&   Exim's local ID for the message
24304 &`PATH              `&   as specified by the &%path%& option below
24305 &`QUALIFY_DOMAIN    `&   the sender qualification domain
24306 &`RECIPIENT         `&   the complete recipient address
24307 &`SENDER            `&   the sender of the message (empty if a bounce)
24308 &`SHELL             `&   &`/bin/sh`&
24309 &`TZ                `&   the value of the &%timezone%& option, if set
24310 &`USER              `&   see below
24311 .endd
24312 When a &(pipe)& transport is called directly from (for example) an &(accept)&
24313 router, LOCAL_PART is set to the local part of the address. When it is
24314 called as a result of a forward or alias expansion, LOCAL_PART is set to
24315 the local part of the address that was expanded. In both cases, any affixes are
24316 removed from the local part, and made available in LOCAL_PART_PREFIX and
24317 LOCAL_PART_SUFFIX, respectively. LOGNAME and USER are set to the
24318 same value as LOCAL_PART for compatibility with other MTAs.
24319
24320 .cindex "HOST"
24321 HOST is set only when a &(pipe)& transport is called from a router that
24322 associates hosts with an address, typically when using &(pipe)& as a
24323 pseudo-remote transport. HOST is set to the first host name specified by
24324 the router.
24325
24326 .cindex "HOME"
24327 If the transport's generic &%home_directory%& option is set, its value is used
24328 for the HOME environment variable. Otherwise, a home directory may be set
24329 by the router's &%transport_home_directory%& option, which defaults to the
24330 user's home directory if &%check_local_user%& is set.
24331
24332
24333 .section "Private options for pipe" "SECID142"
24334 .cindex "options" "&(pipe)& transport"
24335
24336
24337
24338 .option allow_commands pipe "string list&!!" unset
24339 .cindex "&(pipe)& transport" "permitted commands"
24340 The string is expanded, and is then interpreted as a colon-separated list of
24341 permitted commands. If &%restrict_to_path%& is not set, the only commands
24342 permitted are those in the &%allow_commands%& list. They need not be absolute
24343 paths; the &%path%& option is still used for relative paths. If
24344 &%restrict_to_path%& is set with &%allow_commands%&, the command must either be
24345 in the &%allow_commands%& list, or a name without any slashes that is found on
24346 the path. In other words, if neither &%allow_commands%& nor
24347 &%restrict_to_path%& is set, there is no restriction on the command, but
24348 otherwise only commands that are permitted by one or the other are allowed. For
24349 example, if
24350 .code
24351 allow_commands = /usr/bin/vacation
24352 .endd
24353 and &%restrict_to_path%& is not set, the only permitted command is
24354 &_/usr/bin/vacation_&. The &%allow_commands%& option may not be set if
24355 &%use_shell%& is set.
24356
24357
24358 .option batch_id pipe string&!! unset
24359 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
24360
24361
24362 .option batch_max pipe integer 1
24363 This limits the number of addresses that can be handled in a single delivery.
24364 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
24365
24366
24367 .option check_string pipe string unset
24368 As &(pipe)& writes the message, the start of each line is tested for matching
24369 &%check_string%&, and if it does, the initial matching characters are replaced
24370 by the contents of &%escape_string%&, provided both are set. The value of
24371 &%check_string%& is a literal string, not a regular expression, and the case of
24372 any letters it contains is significant. When &%use_bsmtp%& is set, the contents
24373 of &%check_string%& and &%escape_string%& are forced to values that implement
24374 the SMTP escaping protocol. Any settings made in the configuration file are
24375 ignored.
24376
24377
24378 .option command pipe string&!! unset
24379 This option need not be set when &(pipe)& is being used to deliver to pipes
24380 obtained directly from address redirections. In other cases, the option must be
24381 set, to provide a command to be run. It need not yield an absolute path (see
24382 the &%path%& option below). The command is split up into separate arguments by
24383 Exim, and each argument is separately expanded, as described in section
24384 &<<SECThowcommandrun>>& above.
24385
24386
24387 .option environment pipe string&!! unset
24388 .cindex "&(pipe)& transport" "environment for command"
24389 .cindex "environment" "&(pipe)& transport"
24390 This option is used to add additional variables to the environment in which the
24391 command runs (see section &<<SECTpipeenv>>& for the default list). Its value is
24392 a string which is expanded, and then interpreted as a colon-separated list of
24393 environment settings of the form <&'name'&>=<&'value'&>.
24394
24395
24396 .option escape_string pipe string unset
24397 See &%check_string%& above.
24398
24399
24400 .option freeze_exec_fail pipe boolean false
24401 .cindex "exec failure"
24402 .cindex "failure of exec"
24403 .cindex "&(pipe)& transport" "failure of exec"
24404 Failure to exec the command in a pipe transport is by default treated like
24405 any other failure while running the command. However, if &%freeze_exec_fail%&
24406 is set, failure to exec is treated specially, and causes the message to be
24407 frozen, whatever the setting of &%ignore_status%&.
24408
24409
24410 .option freeze_signal pipe boolean false
24411 .cindex "signal exit"
24412 .cindex "&(pipe)& transport", "signal exit"
24413 Normally if the process run by a command in a pipe transport exits on a signal,
24414 a bounce message is sent. If &%freeze_signal%& is set, the message will be
24415 frozen in Exim's queue instead.
24416
24417
24418 .option force_command pipe boolean false
24419 .cindex "force command"
24420 .cindex "&(pipe)& transport", "force command"
24421 Normally when a router redirects an address directly to a pipe command
24422 the &%command%& option on the transport is ignored.  If &%force_command%&
24423 is set, the &%command%& option will used. This is especially
24424 useful for forcing a wrapper or additional argument to be added to the
24425 command. For example:
24426 .code
24427 command = /usr/bin/remote_exec myhost -- $address_pipe
24428 force_command
24429 .endd
24430
24431 Note that &$address_pipe$& is handled specially in &%command%& when
24432 &%force_command%& is set, expanding out to the original argument vector as
24433 separate items, similarly to a Unix shell &`"$@"`& construct.
24434
24435
24436 .option ignore_status pipe boolean false
24437 If this option is true, the status returned by the subprocess that is set up to
24438 run the command is ignored, and Exim behaves as if zero had been returned.
24439 Otherwise, a non-zero status or termination by signal causes an error return
24440 from the transport unless the status value is one of those listed in
24441 &%temp_errors%&; these cause the delivery to be deferred and tried again later.
24442
24443 &*Note*&: This option does not apply to timeouts, which do not return a status.
24444 See the &%timeout_defer%& option for how timeouts are handled.
24445
24446
24447 .option log_defer_output pipe boolean false
24448 .cindex "&(pipe)& transport" "logging output"
24449 If this option is set, and the status returned by the command is
24450 one of the codes listed in &%temp_errors%& (that is, delivery was deferred),
24451 and any output was produced on stdout or stderr, the first line of it is
24452 written to the main log.
24453
24454
24455 .option log_fail_output pipe boolean false
24456 If this option is set, and the command returns any output on stdout or
24457 stderr, and also ends with a return code that is neither zero nor one of
24458 the return codes listed in &%temp_errors%& (that is, the delivery
24459 failed), the first line of output is written to the main log. This
24460 option and &%log_output%& are mutually exclusive.  Only one of them may
24461 be set.
24462
24463
24464 .option log_output pipe boolean false
24465 If this option is set and the command returns any output on stdout or
24466 stderr, the first line of output is written to the main log, whatever
24467 the return code. This option and &%log_fail_output%& are mutually
24468 exclusive. Only one of them may be set.
24469
24470
24471 .option max_output pipe integer 20K
24472 This specifies the maximum amount of output that the command may produce on its
24473 standard output and standard error file combined. If the limit is exceeded, the
24474 process running the command is killed. This is intended as a safety measure to
24475 catch runaway processes. The limit is applied independently of the settings of
24476 the options that control what is done with such output (for example,
24477 &%return_output%&). Because of buffering effects, the amount of output may
24478 exceed the limit by a small amount before Exim notices.
24479
24480
24481 .option message_prefix pipe string&!! "see below"
24482 The string specified here is expanded and output at the start of every message.
24483 The default is unset if &%use_bsmtp%& is set. Otherwise it is
24484 .code
24485 message_prefix = \
24486   From ${if def:return_path{$return_path}{MAILER-DAEMON}}\
24487   ${tod_bsdinbox}\n
24488 .endd
24489 .cindex "Cyrus"
24490 .cindex "&%tmail%&"
24491 .cindex "&""From""& line"
24492 This is required by the commonly used &_/usr/bin/vacation_& program.
24493 However, it must &'not'& be present if delivery is to the Cyrus IMAP server,
24494 or to the &%tmail%& local delivery agent. The prefix can be suppressed by
24495 setting
24496 .code
24497 message_prefix =
24498 .endd
24499 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
24500 &`\n`& to &`\r\n`& in &%message_prefix%&.
24501
24502
24503 .option message_suffix pipe string&!! "see below"
24504 The string specified here is expanded and output at the end of every message.
24505 The default is unset if &%use_bsmtp%& is set. Otherwise it is a single newline.
24506 The suffix can be suppressed by setting
24507 .code
24508 message_suffix =
24509 .endd
24510 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
24511 &`\n`& to &`\r\n`& in &%message_suffix%&.
24512
24513
24514 .option path pipe string&!! "/bin:/usr/bin"
24515 This option is expanded and
24516 specifies the string that is set up in the PATH environment
24517 variable of the subprocess.
24518 If the &%command%& option does not yield an absolute path name, the command is
24519 sought in the PATH directories, in the usual way. &*Warning*&: This does not
24520 apply to a command specified as a transport filter.
24521
24522
24523 .option permit_coredump pipe boolean false
24524 Normally Exim inhibits core-dumps during delivery.  If you have a need to get
24525 a core-dump of a pipe command, enable this command.  This enables core-dumps
24526 during delivery and affects both the Exim binary and the pipe command run.
24527 It is recommended that this option remain off unless and until you have a need
24528 for it and that this only be enabled when needed, as the risk of excessive
24529 resource consumption can be quite high.  Note also that Exim is typically
24530 installed as a setuid binary and most operating systems will inhibit coredumps
24531 of these by default, so further OS-specific action may be required.
24532
24533
24534 .option pipe_as_creator pipe boolean false
24535 .cindex "uid (user id)" "local delivery"
24536 If the generic &%user%& option is not set and this option is true, the delivery
24537 process is run under the uid that was in force when Exim was originally called
24538 to accept the message. If the group id is not otherwise set (via the generic
24539 &%group%& option), the gid that was in force when Exim was originally called to
24540 accept the message is used.
24541
24542
24543 .option restrict_to_path pipe boolean false
24544 When this option is set, any command name not listed in &%allow_commands%& must
24545 contain no slashes. The command is searched for only in the directories listed
24546 in the &%path%& option. This option is intended for use in the case when a pipe
24547 command has been generated from a user's &_.forward_& file. This is usually
24548 handled by a &(pipe)& transport called &%address_pipe%&.
24549
24550
24551 .option return_fail_output pipe boolean false
24552 If this option is true, and the command produced any output and ended with a
24553 return code other than zero or one of the codes listed in &%temp_errors%& (that
24554 is, the delivery failed), the output is returned in the bounce message.
24555 However, if the message has a null sender (that is, it is itself a bounce
24556 message), output from the command is discarded. This option and
24557 &%return_output%& are mutually exclusive. Only one of them may be set.
24558
24559
24560
24561 .option return_output pipe boolean false
24562 If this option is true, and the command produced any output, the delivery is
24563 deemed to have failed whatever the return code from the command, and the output
24564 is returned in the bounce message. Otherwise, the output is just discarded.
24565 However, if the message has a null sender (that is, it is a bounce message),
24566 output from the command is always discarded, whatever the setting of this
24567 option. This option and &%return_fail_output%& are mutually exclusive. Only one
24568 of them may be set.
24569
24570
24571
24572 .option temp_errors pipe "string list" "see below"
24573 .cindex "&(pipe)& transport" "temporary failure"
24574 This option contains either a colon-separated list of numbers, or a single
24575 asterisk. If &%ignore_status%& is false
24576 and &%return_output%& is not set,
24577 and the command exits with a non-zero return code, the failure is treated as
24578 temporary and the delivery is deferred if the return code matches one of the
24579 numbers, or if the setting is a single asterisk. Otherwise, non-zero return
24580 codes are treated as permanent errors. The default setting contains the codes
24581 defined by EX_TEMPFAIL and EX_CANTCREAT in &_sysexits.h_&. If Exim is
24582 compiled on a system that does not define these macros, it assumes values of 75
24583 and 73, respectively.
24584
24585
24586 .option timeout pipe time 1h
24587 If the command fails to complete within this time, it is killed. This normally
24588 causes the delivery to fail (but see &%timeout_defer%&). A zero time interval
24589 specifies no timeout. In order to ensure that any subprocesses created by the
24590 command are also killed, Exim makes the initial process a process group leader,
24591 and kills the whole process group on a timeout. However, this can be defeated
24592 if one of the processes starts a new process group.
24593
24594 .option timeout_defer pipe boolean false
24595 A timeout in a &(pipe)& transport, either in the command that the transport
24596 runs, or in a transport filter that is associated with it, is by default
24597 treated as a hard error, and the delivery fails. However, if &%timeout_defer%&
24598 is set true, both kinds of timeout become temporary errors, causing the
24599 delivery to be deferred.
24600
24601 .option umask pipe "octal integer" 022
24602 This specifies the umask setting for the subprocess that runs the command.
24603
24604
24605 .option use_bsmtp pipe boolean false
24606 .cindex "envelope sender"
24607 If this option is set true, the &(pipe)& transport writes messages in &"batch
24608 SMTP"& format, with the envelope sender and recipient(s) included as SMTP
24609 commands. If you want to include a leading HELO command with such messages,
24610 you can do so by setting the &%message_prefix%& option. See section
24611 &<<SECTbatchSMTP>>& for details of batch SMTP.
24612
24613 .option use_classresources pipe boolean false
24614 .cindex "class resources (BSD)"
24615 This option is available only when Exim is running on FreeBSD, NetBSD, or
24616 BSD/OS. If it is set true, the &[setclassresources()]& function is used to set
24617 resource limits when a &(pipe)& transport is run to perform a delivery. The
24618 limits for the uid under which the pipe is to run are obtained from the login
24619 class database.
24620
24621
24622 .option use_crlf pipe boolean false
24623 .cindex "carriage return"
24624 .cindex "linefeed"
24625 This option causes lines to be terminated with the two-character CRLF sequence
24626 (carriage return, linefeed) instead of just a linefeed character. In the case
24627 of batched SMTP, the byte sequence written to the pipe is then an exact image
24628 of what would be sent down a real SMTP connection.
24629
24630 The contents of the &%message_prefix%& and &%message_suffix%& options are
24631 written verbatim, so must contain their own carriage return characters if these
24632 are needed. When &%use_bsmtp%& is not set, the default values for both
24633 &%message_prefix%& and &%message_suffix%& end with a single linefeed, so their
24634 values must be changed to end with &`\r\n`& if &%use_crlf%& is set.
24635
24636
24637 .option use_shell pipe boolean false
24638 .vindex "&$pipe_addresses$&"
24639 If this option is set, it causes the command to be passed to &_/bin/sh_&
24640 instead of being run directly from the transport, as described in section
24641 &<<SECThowcommandrun>>&. This is less secure, but is needed in some situations
24642 where the command is expected to be run under a shell and cannot easily be
24643 modified. The &%allow_commands%& and &%restrict_to_path%& options, and the
24644 &`$pipe_addresses`& facility are incompatible with &%use_shell%&. The
24645 command is expanded as a single string, and handed to &_/bin/sh_& as data for
24646 its &%-c%& option.
24647
24648
24649
24650 .section "Using an external local delivery agent" "SECID143"
24651 .cindex "local delivery" "using an external agent"
24652 .cindex "&'procmail'&"
24653 .cindex "external local delivery"
24654 .cindex "delivery" "&'procmail'&"
24655 .cindex "delivery" "by external agent"
24656 The &(pipe)& transport can be used to pass all messages that require local
24657 delivery to a separate local delivery agent such as &%procmail%&. When doing
24658 this, care must be taken to ensure that the pipe is run under an appropriate
24659 uid and gid. In some configurations one wants this to be a uid that is trusted
24660 by the delivery agent to supply the correct sender of the message. It may be
24661 necessary to recompile or reconfigure the delivery agent so that it trusts an
24662 appropriate user. The following is an example transport and router
24663 configuration for &%procmail%&:
24664 .code
24665 # transport
24666 procmail_pipe:
24667   driver = pipe
24668   command = /usr/local/bin/procmail -d $local_part_data
24669   return_path_add
24670   delivery_date_add
24671   envelope_to_add
24672   check_string = "From "
24673   escape_string = ">From "
24674   umask = 077
24675   user = $local_part_data
24676   group = mail
24677
24678 # router
24679 procmail:
24680   driver = accept
24681   check_local_user
24682   transport = procmail_pipe
24683 .endd
24684 In this example, the pipe is run as the local user, but with the group set to
24685 &'mail'&. An alternative is to run the pipe as a specific user such as &'mail'&
24686 or &'exim'&, but in this case you must arrange for &%procmail%& to trust that
24687 user to supply a correct sender address. If you do not specify either a
24688 &%group%& or a &%user%& option, the pipe command is run as the local user. The
24689 home directory is the user's home directory by default.
24690
24691 &*Note*&: The command that the pipe transport runs does &'not'& begin with
24692 .code
24693 IFS=" "
24694 .endd
24695 as shown in some &%procmail%& documentation, because Exim does not by default
24696 use a shell to run pipe commands.
24697
24698 .cindex "Cyrus"
24699 The next example shows a transport and a router for a system where local
24700 deliveries are handled by the Cyrus IMAP server.
24701 .code
24702 # transport
24703 local_delivery_cyrus:
24704   driver = pipe
24705   command = /usr/cyrus/bin/deliver \
24706             -m ${substr_1:$local_part_suffix} -- $local_part
24707   user = cyrus
24708   group = mail
24709   return_output
24710   log_output
24711   message_prefix =
24712   message_suffix =
24713
24714 # router
24715 local_user_cyrus:
24716   driver = accept
24717   check_local_user
24718   local_part_suffix = .*
24719   transport = local_delivery_cyrus
24720 .endd
24721 Note the unsetting of &%message_prefix%& and &%message_suffix%&, and the use of
24722 &%return_output%& to cause any text written by Cyrus to be returned to the
24723 sender.
24724 .ecindex IIDpiptra1
24725 .ecindex IIDpiptra2
24726
24727
24728 . ////////////////////////////////////////////////////////////////////////////
24729 . ////////////////////////////////////////////////////////////////////////////
24730
24731 .chapter "The smtp transport" "CHAPsmtptrans"
24732 .scindex IIDsmttra1 "transports" "&(smtp)&"
24733 .scindex IIDsmttra2 "&(smtp)& transport"
24734 The &(smtp)& transport delivers messages over TCP/IP connections using the SMTP
24735 or LMTP protocol. The list of hosts to try can either be taken from the address
24736 that is being processed (having been set up by the router), or specified
24737 explicitly for the transport. Timeout and retry processing (see chapter
24738 &<<CHAPretry>>&) is applied to each IP address independently.
24739
24740
24741 .section "Multiple messages on a single connection" "SECID144"
24742 The sending of multiple messages over a single TCP/IP connection can arise in
24743 two ways:
24744
24745 .ilist
24746 If a message contains more than &%max_rcpt%& (see below) addresses that are
24747 routed to the same host, more than one copy of the message has to be sent to
24748 that host. In this situation, multiple copies may be sent in a single run of
24749 the &(smtp)& transport over a single TCP/IP connection. (What Exim actually
24750 does when it has too many addresses to send in one message also depends on the
24751 value of the global &%remote_max_parallel%& option. Details are given in
24752 section &<<SECToutSMTPTCP>>&.)
24753 .next
24754 .cindex "hints database" "remembering routing"
24755 When a message has been successfully delivered over a TCP/IP connection, Exim
24756 looks in its hints database to see if there are any other messages awaiting a
24757 connection to the same host. If there are, a new delivery process is started
24758 for one of them, and the current TCP/IP connection is passed on to it. The new
24759 process may in turn send multiple copies and possibly create yet another
24760 process.
24761 .endlist
24762
24763
24764 For each copy sent over the same TCP/IP connection, a sequence counter is
24765 incremented, and if it ever gets to the value of &%connection_max_messages%&,
24766 no further messages are sent over that connection.
24767
24768
24769
24770 .section "Use of the $host and $host_address variables" "SECID145"
24771 .vindex "&$host$&"
24772 .vindex "&$host_address$&"
24773 At the start of a run of the &(smtp)& transport, the values of &$host$& and
24774 &$host_address$& are the name and IP address of the first host on the host list
24775 passed by the router. However, when the transport is about to connect to a
24776 specific host, and while it is connected to that host, &$host$& and
24777 &$host_address$& are set to the values for that host. These are the values
24778 that are in force when the &%helo_data%&, &%hosts_try_auth%&, &%interface%&,
24779 &%serialize_hosts%&, and the various TLS options are expanded.
24780
24781
24782 .section "Use of $tls_cipher and $tls_peerdn" "usecippeer"
24783 .vindex &$tls_bits$&
24784 .vindex &$tls_cipher$&
24785 .vindex &$tls_peerdn$&
24786 .vindex &$tls_sni$&
24787 At the start of a run of the &(smtp)& transport, the values of &$tls_bits$&,
24788 &$tls_cipher$&, &$tls_peerdn$& and &$tls_sni$&
24789 are the values that were set when the message was received.
24790 These are the values that are used for options that are expanded before any
24791 SMTP connections are made. Just before each connection is made, these four
24792 variables are emptied. If TLS is subsequently started, they are set to the
24793 appropriate values for the outgoing connection, and these are the values that
24794 are in force when any authenticators are run and when the
24795 &%authenticated_sender%& option is expanded.
24796
24797 These variables are deprecated in favour of &$tls_in_cipher$& et. al.
24798 and will be removed in a future release.
24799
24800
24801 .section "Private options for smtp" "SECID146"
24802 .cindex "options" "&(smtp)& transport"
24803 The private options of the &(smtp)& transport are as follows:
24804
24805
24806 .option address_retry_include_sender smtp boolean true
24807 .cindex "4&'xx'& responses" "retrying after"
24808 When an address is delayed because of a 4&'xx'& response to a RCPT command, it
24809 is the combination of sender and recipient that is delayed in subsequent queue
24810 runs until the retry time is reached. You can delay the recipient without
24811 reference to the sender (which is what earlier versions of Exim did), by
24812 setting &%address_retry_include_sender%& false. However, this can lead to
24813 problems with servers that regularly issue 4&'xx'& responses to RCPT commands.
24814
24815 .option allow_localhost smtp boolean false
24816 .cindex "local host" "sending to"
24817 .cindex "fallback" "hosts specified on transport"
24818 When a host specified in &%hosts%& or &%fallback_hosts%& (see below) turns out
24819 to be the local host, or is listed in &%hosts_treat_as_local%&, delivery is
24820 deferred by default. However, if &%allow_localhost%& is set, Exim goes on to do
24821 the delivery anyway. This should be used only in special cases when the
24822 configuration ensures that no looping will result (for example, a differently
24823 configured Exim is listening on the port to which the message is sent).
24824
24825
24826 .option authenticated_sender smtp string&!! unset
24827 .cindex "Cyrus"
24828 When Exim has authenticated as a client, or if &%authenticated_sender_force%&
24829 is true, this option sets a value for the AUTH= item on outgoing MAIL commands,
24830 overriding any existing authenticated sender value. If the string expansion is
24831 forced to fail, the option is ignored. Other expansion failures cause delivery
24832 to be deferred. If the result of expansion is an empty string, that is also
24833 ignored.
24834
24835 The expansion happens after the outgoing connection has been made and TLS
24836 started, if required. This means that the &$host$&, &$host_address$&,
24837 &$tls_out_cipher$&, and &$tls_out_peerdn$& variables are set according to the
24838 particular connection.
24839
24840 If the SMTP session is not authenticated, the expansion of
24841 &%authenticated_sender%& still happens (and can cause the delivery to be
24842 deferred if it fails), but no AUTH= item is added to MAIL commands
24843 unless &%authenticated_sender_force%& is true.
24844
24845 This option allows you to use the &(smtp)& transport in LMTP mode to
24846 deliver mail to Cyrus IMAP and provide the proper local part as the
24847 &"authenticated sender"&, via a setting such as:
24848 .code
24849 authenticated_sender = $local_part
24850 .endd
24851 This removes the need for IMAP subfolders to be assigned special ACLs to
24852 allow direct delivery to those subfolders.
24853
24854 Because of expected uses such as that just described for Cyrus (when no
24855 domain is involved), there is no checking on the syntax of the provided
24856 value.
24857
24858
24859 .option authenticated_sender_force smtp boolean false
24860 If this option is set true, the &%authenticated_sender%& option's value
24861 is used for the AUTH= item on outgoing MAIL commands, even if Exim has not
24862 authenticated as a client.
24863
24864
24865 .option command_timeout smtp time 5m
24866 This sets a timeout for receiving a response to an SMTP command that has been
24867 sent out. It is also used when waiting for the initial banner line from the
24868 remote host. Its value must not be zero.
24869
24870
24871 .option connect_timeout smtp time 5m
24872 This sets a timeout for the &[connect()]& function, which sets up a TCP/IP call
24873 to a remote host. A setting of zero allows the system timeout (typically
24874 several minutes) to act. To have any effect, the value of this option must be
24875 less than the system timeout. However, it has been observed that on some
24876 systems there is no system timeout, which is why the default value for this
24877 option is 5 minutes, a value recommended by RFC 1123.
24878
24879
24880 .option connection_max_messages smtp integer 500
24881 .cindex "SMTP" "passed connection"
24882 .cindex "SMTP" "multiple deliveries"
24883 .cindex "multiple SMTP deliveries"
24884 This controls the maximum number of separate message deliveries that are sent
24885 over a single TCP/IP connection. If the value is zero, there is no limit.
24886 For testing purposes, this value can be overridden by the &%-oB%& command line
24887 option.
24888
24889
24890 .option dane_require_tls_ciphers smtp string&!! unset
24891 .cindex "TLS" "requiring specific ciphers for DANE"
24892 .cindex "cipher" "requiring specific"
24893 .cindex DANE "TLS ciphers"
24894 This option may be used to override &%tls_require_ciphers%& for connections
24895 where DANE has been determined to be in effect.
24896 If not set, then &%tls_require_ciphers%& will be used.
24897 Normal SMTP delivery is not able to make strong demands of TLS cipher
24898 configuration, because delivery will fall back to plaintext.  Once DANE has
24899 been determined to be in effect, there is no plaintext fallback and making the
24900 TLS cipherlist configuration stronger will increase security, rather than
24901 counter-intuitively decreasing it.
24902 If the option expands to be empty or is forced to fail, then it will
24903 be treated as unset and &%tls_require_ciphers%& will be used instead.
24904
24905
24906 .option data_timeout smtp time 5m
24907 This sets a timeout for the transmission of each block in the data portion of
24908 the message. As a result, the overall timeout for a message depends on the size
24909 of the message. Its value must not be zero. See also &%final_timeout%&.
24910
24911
24912 .option dkim_canon smtp string&!! unset
24913 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
24914 .option dkim_domain smtp string list&!! unset
24915 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
24916 .option dkim_hash smtp string&!! sha256
24917 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
24918 .option dkim_identity smtp string&!! unset
24919 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
24920 .option dkim_private_key smtp string&!! unset
24921 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
24922 .option dkim_selector smtp string&!! unset
24923 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
24924 .option dkim_strict smtp string&!! unset
24925 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
24926 .option dkim_sign_headers smtp string&!! "per RFC"
24927 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
24928 .option dkim_timestamps smtp string&!! unset
24929 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
24930
24931
24932 .option delay_after_cutoff smtp boolean true
24933 .cindex "final cutoff" "retries, controlling"
24934 .cindex retry "final cutoff"
24935 This option controls what happens when all remote IP addresses for a given
24936 domain have been inaccessible for so long that they have passed their retry
24937 cutoff times.
24938
24939 In the default state, if the next retry time has not been reached for any of
24940 them, the address is bounced without trying any deliveries. In other words,
24941 Exim delays retrying an IP address after the final cutoff time until a new
24942 retry time is reached, and can therefore bounce an address without ever trying
24943 a delivery, when machines have been down for a long time. Some people are
24944 unhappy at this prospect, so...
24945
24946 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
24947 addresses are past their final cutoff time, Exim tries to deliver to those
24948 IP addresses that have not been tried since the message arrived. If there are
24949 none, of if they all fail, the address is bounced. In other words, it does not
24950 delay when a new message arrives, but immediately tries those expired IP
24951 addresses that haven't been tried since the message arrived. If there is a
24952 continuous stream of messages for the dead hosts, unsetting
24953 &%delay_after_cutoff%& means that there will be many more attempts to deliver
24954 to them.
24955
24956
24957 .option dns_qualify_single smtp boolean true
24958 If the &%hosts%& or &%fallback_hosts%& option is being used,
24959 and the &%gethostbyname%& option is false,
24960 the RES_DEFNAMES resolver option is set. See the &%qualify_single%& option
24961 in chapter &<<CHAPdnslookup>>& for more details.
24962
24963
24964 .option dns_search_parents smtp boolean false
24965 If the &%hosts%& or &%fallback_hosts%& option is being used, and the
24966 &%gethostbyname%& option is false, the RES_DNSRCH resolver option is set.
24967 See the &%search_parents%& option in chapter &<<CHAPdnslookup>>& for more
24968 details.
24969
24970
24971 .option dnssec_request_domains smtp "domain list&!!" *
24972 .cindex "MX record" "security"
24973 .cindex "DNSSEC" "MX lookup"
24974 .cindex "security" "MX lookup"
24975 .cindex "DNS" "DNSSEC"
24976 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
24977 the dnssec request bit set. Setting this transport option is only useful if the
24978 transport overrides or sets the host names. See the &%dnssec_request_domains%&
24979 router option.
24980
24981
24982
24983 .option dnssec_require_domains smtp "domain list&!!" unset
24984 .cindex "MX record" "security"
24985 .cindex "DNSSEC" "MX lookup"
24986 .cindex "security" "MX lookup"
24987 .cindex "DNS" "DNSSEC"
24988 DNS lookups for domains matching &%dnssec_require_domains%& will be done with
24989 the dnssec request bit set.  Setting this transport option is only
24990 useful if the transport overrides or sets the host names. See the
24991 &%dnssec_require_domains%& router option.
24992
24993
24994
24995 .option dscp smtp string&!! unset
24996 .cindex "DCSP" "outbound"
24997 This option causes the DSCP value associated with a socket to be set to one
24998 of a number of fixed strings or to numeric value.
24999 The &%-bI:dscp%& option may be used to ask Exim which names it knows of.
25000 Common values include &`throughput`&, &`mincost`&, and on newer systems
25001 &`ef`&, &`af41`&, etc.  Numeric values may be in the range 0 to 0x3F.
25002
25003 The outbound packets from Exim will be marked with this value in the header
25004 (for IPv4, the TOS field; for IPv6, the TCLASS field); there is no guarantee
25005 that these values will have any effect, not be stripped by networking
25006 equipment, or do much of anything without cooperation with your Network
25007 Engineer and those of all network operators between the source and destination.
25008
25009
25010 .option fallback_hosts smtp "string list" unset
25011 .cindex "fallback" "hosts specified on transport"
25012 String expansion is not applied to this option. The argument must be a
25013 colon-separated list of host names or IP addresses, optionally also including
25014 port numbers, though the separator can be changed, as described in section
25015 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
25016 item in a &%route_list%& setting for the &(manualroute)& router, as described
25017 in section &<<SECTformatonehostitem>>&.
25018
25019 Fallback hosts can also be specified on routers, which associate them with the
25020 addresses they process. As for the &%hosts%& option without &%hosts_override%&,
25021 &%fallback_hosts%& specified on the transport is used only if the address does
25022 not have its own associated fallback host list. Unlike &%hosts%&, a setting of
25023 &%fallback_hosts%& on an address is not overridden by &%hosts_override%&.
25024 However, &%hosts_randomize%& does apply to fallback host lists.
25025
25026 If Exim is unable to deliver to any of the hosts for a particular address, and
25027 the errors are not permanent rejections, the address is put on a separate
25028 transport queue with its host list replaced by the fallback hosts, unless the
25029 address was routed via MX records and the current host was in the original MX
25030 list. In that situation, the fallback host list is not used.
25031
25032 Once normal deliveries are complete, the fallback queue is delivered by
25033 re-running the same transports with the new host lists. If several failing
25034 addresses have the same fallback hosts (and &%max_rcpt%& permits it), a single
25035 copy of the message is sent.
25036
25037 The resolution of the host names on the fallback list is controlled by the
25038 &%gethostbyname%& option, as for the &%hosts%& option. Fallback hosts apply
25039 both to cases when the host list comes with the address and when it is taken
25040 from &%hosts%&. This option provides a &"use a smart host only if delivery
25041 fails"& facility.
25042
25043
25044 .option final_timeout smtp time 10m
25045 This is the timeout that applies while waiting for the response to the final
25046 line containing just &"."& that terminates a message. Its value must not be
25047 zero.
25048
25049 .option gethostbyname smtp boolean false
25050 If this option is true when the &%hosts%& and/or &%fallback_hosts%& options are
25051 being used, names are looked up using &[gethostbyname()]&
25052 (or &[getipnodebyname()]& when available)
25053 instead of using the DNS. Of course, that function may in fact use the DNS, but
25054 it may also consult other sources of information such as &_/etc/hosts_&.
25055
25056 .option gnutls_compat_mode smtp boolean unset
25057 This option controls whether GnuTLS is used in compatibility mode in an Exim
25058 server. This reduces security slightly, but improves interworking with older
25059 implementations of TLS.
25060
25061 .option helo_data smtp string&!! "see below"
25062 .cindex "HELO" "argument, setting"
25063 .cindex "EHLO" "argument, setting"
25064 .cindex "LHLO argument setting"
25065 The value of this option is expanded after a connection to a another host has
25066 been set up. The result is used as the argument for the EHLO, HELO, or LHLO
25067 command that starts the outgoing SMTP or LMTP session. The default value of the
25068 option is:
25069 .code
25070 $primary_hostname
25071 .endd
25072 During the expansion, the variables &$host$& and &$host_address$& are set to
25073 the identity of the remote host, and the variables &$sending_ip_address$& and
25074 &$sending_port$& are set to the local IP address and port number that are being
25075 used. These variables can be used to generate different values for different
25076 servers or different local IP addresses. For example, if you want the string
25077 that is used for &%helo_data%& to be obtained by a DNS lookup of the outgoing
25078 interface address, you could use this:
25079 .code
25080 helo_data = ${lookup dnsdb{ptr=$sending_ip_address}{$value}\
25081   {$primary_hostname}}
25082 .endd
25083 The use of &%helo_data%& applies both to sending messages and when doing
25084 callouts.
25085
25086 .option hosts smtp "string list&!!" unset
25087 Hosts are associated with an address by a router such as &(dnslookup)&, which
25088 finds the hosts by looking up the address domain in the DNS, or by
25089 &(manualroute)&, which has lists of hosts in its configuration. However,
25090 email addresses can be passed to the &(smtp)& transport by any router, and not
25091 all of them can provide an associated list of hosts.
25092
25093 The &%hosts%& option specifies a list of hosts to be used if the address being
25094 processed does not have any hosts associated with it. The hosts specified by
25095 &%hosts%& are also used, whether or not the address has its own hosts, if
25096 &%hosts_override%& is set.
25097
25098 The string is first expanded, before being interpreted as a colon-separated
25099 list of host names or IP addresses, possibly including port numbers. The
25100 separator may be changed to something other than colon, as described in section
25101 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
25102 item in a &%route_list%& setting for the &(manualroute)& router, as described
25103 in section &<<SECTformatonehostitem>>&. However, note that the &`/MX`& facility
25104 of the &(manualroute)& router is not available here.
25105
25106 If the expansion fails, delivery is deferred. Unless the failure was caused by
25107 the inability to complete a lookup, the error is logged to the panic log as
25108 well as the main log. Host names are looked up either by searching directly for
25109 address records in the DNS or by calling &[gethostbyname()]& (or
25110 &[getipnodebyname()]& when available), depending on the setting of the
25111 &%gethostbyname%& option. When Exim is compiled with IPv6 support, if a host
25112 that is looked up in the DNS has both IPv4 and IPv6 addresses, both types of
25113 address are used.
25114
25115 During delivery, the hosts are tried in order, subject to their retry status,
25116 unless &%hosts_randomize%& is set.
25117
25118
25119 .option hosts_avoid_esmtp smtp "host list&!!" unset
25120 .cindex "ESMTP, avoiding use of"
25121 .cindex "HELO" "forcing use of"
25122 .cindex "EHLO" "avoiding use of"
25123 .cindex "PIPELINING" "avoiding the use of"
25124 This option is for use with broken hosts that announce ESMTP facilities (for
25125 example, PIPELINING) and then fail to implement them properly. When a host
25126 matches &%hosts_avoid_esmtp%&, Exim sends HELO rather than EHLO at the
25127 start of the SMTP session. This means that it cannot use any of the ESMTP
25128 facilities such as AUTH, PIPELINING, SIZE, and STARTTLS.
25129
25130
25131 .option hosts_avoid_pipelining smtp "host list&!!" unset
25132 .cindex "PIPELINING" "avoiding the use of"
25133 .cindex "ESMTP extensions" PIPELINING
25134 Exim will not use the ESMTP PIPELINING extension when delivering to any host
25135 that matches this list, even if the server host advertises PIPELINING support.
25136
25137 .option hosts_pipe_connect smtp "host list&!!" unset
25138 .cindex "pipelining" "early connection"
25139 .cindex "pipelining" PIPE_CONNECT
25140 If Exim is built with the SUPPORT_PIPE_CONNECT build option
25141 this option controls which to hosts the facility watched for
25142 and recorded, and used for subsequent connections.
25143
25144 The retry hints database is used for the record,
25145 and records are subject to the &%retry_data_expire%& option.
25146 When used, the pipelining saves on roundtrip times.
25147 It also turns SMTP into a client-first protocol
25148 so combines well with TCP Fast Open.
25149
25150 See also the &%pipelining_connect_advertise_hosts%& main option.
25151
25152 Note:
25153 When the facility is used, the transport &%helo_data%& option
25154 will be expanded before the &$sending_ip_address$& variable
25155 is filled in.
25156 A check is made for the use of that variable, without the
25157 presence of a &"def:"& test on it, but suitably complex coding
25158 can avoid the check and produce unexpected results.
25159 You have been warned.
25160
25161
25162 .option hosts_avoid_tls smtp "host list&!!" unset
25163 .cindex "TLS" "avoiding for certain hosts"
25164 Exim will not try to start a TLS session when delivering to any host that
25165 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
25166
25167 .option hosts_verify_avoid_tls smtp "host list&!!" unset
25168 .cindex "TLS" "avoiding for certain hosts"
25169 Exim will not try to start a TLS session for a verify callout,
25170 or when delivering in cutthrough mode,
25171 to any host that matches this list.
25172
25173
25174 .option hosts_max_try smtp integer 5
25175 .cindex "host" "maximum number to try"
25176 .cindex "limit" "number of hosts tried"
25177 .cindex "limit" "number of MX tried"
25178 .cindex "MX record" "maximum tried"
25179 This option limits the number of IP addresses that are tried for any one
25180 delivery in cases where there are temporary delivery errors. Section
25181 &<<SECTvalhosmax>>& describes in detail how the value of this option is used.
25182
25183
25184 .option hosts_max_try_hardlimit smtp integer 50
25185 This is an additional check on the maximum number of IP addresses that Exim
25186 tries for any one delivery. Section &<<SECTvalhosmax>>& describes its use and
25187 why it exists.
25188
25189
25190
25191 .option hosts_nopass_tls smtp "host list&!!" unset
25192 .cindex "TLS" "passing connection"
25193 .cindex "multiple SMTP deliveries"
25194 .cindex "TLS" "multiple message deliveries"
25195 For any host that matches this list, a connection on which a TLS session has
25196 been started will not be passed to a new delivery process for sending another
25197 message on the same connection. See section &<<SECTmulmessam>>& for an
25198 explanation of when this might be needed.
25199
25200 .option hosts_noproxy_tls smtp "host list&!!" unset
25201 .cindex "TLS" "passing connection"
25202 .cindex "multiple SMTP deliveries"
25203 .cindex "TLS" "multiple message deliveries"
25204 For any host that matches this list, a TLS session which has
25205 been started will not be passed to a new delivery process for sending another
25206 message on the same session.
25207
25208 The traditional implementation closes down TLS and re-starts it in the new
25209 process, on the same open TCP connection, for each successive message
25210 sent.  If permitted by this option a pipe to to the new process is set up
25211 instead, and the original process maintains the TLS connection and proxies
25212 the SMTP connection from and to the new process and any subsequents.
25213 The new process has no access to TLS information, so cannot include it in
25214 logging.
25215
25216
25217
25218 .option hosts_override smtp boolean false
25219 If this option is set and the &%hosts%& option is also set, any hosts that are
25220 attached to the address are ignored, and instead the hosts specified by the
25221 &%hosts%& option are always used. This option does not apply to
25222 &%fallback_hosts%&.
25223
25224
25225 .option hosts_randomize smtp boolean false
25226 .cindex "randomized host list"
25227 .cindex "host" "list of; randomized"
25228 .cindex "fallback" "randomized hosts"
25229 If this option is set, and either the list of hosts is taken from the
25230 &%hosts%& or the &%fallback_hosts%& option, or the hosts supplied by the router
25231 were not obtained from MX records (this includes fallback hosts from the
25232 router), and were not randomized by the router, the order of trying the hosts
25233 is randomized each time the transport runs. Randomizing the order of a host
25234 list can be used to do crude load sharing.
25235
25236 When &%hosts_randomize%& is true, a host list may be split into groups whose
25237 order is separately randomized. This makes it possible to set up MX-like
25238 behaviour. The boundaries between groups are indicated by an item that is just
25239 &`+`& in the host list. For example:
25240 .code
25241 hosts = host1:host2:host3:+:host4:host5
25242 .endd
25243 The order of the first three hosts and the order of the last two hosts is
25244 randomized for each use, but the first three always end up before the last two.
25245 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored.
25246
25247 .option hosts_require_auth smtp "host list&!!" unset
25248 .cindex "authentication" "required by client"
25249 This option provides a list of servers for which authentication must succeed
25250 before Exim will try to transfer a message. If authentication fails for
25251 servers which are not in this list, Exim tries to send unauthenticated. If
25252 authentication fails for one of these servers, delivery is deferred. This
25253 temporary error is detectable in the retry rules, so it can be turned into a
25254 hard failure if required. See also &%hosts_try_auth%&, and chapter
25255 &<<CHAPSMTPAUTH>>& for details of authentication.
25256
25257
25258 .option hosts_request_ocsp smtp "host list&!!" *
25259 .cindex "TLS" "requiring for certain servers"
25260 Exim will request a Certificate Status on a
25261 TLS session for any host that matches this list.
25262 &%tls_verify_certificates%& should also be set for the transport.
25263
25264 .option hosts_require_dane smtp "host list&!!" unset
25265 .cindex DANE "transport options"
25266 .cindex DANE "requiring for certain servers"
25267 If built with DANE support, Exim  will require that a DNSSEC-validated
25268 TLSA record is present for any host matching the list,
25269 and that a DANE-verified TLS connection is made. See
25270 the &%dnssec_request_domains%& router and transport options.
25271 There will be no fallback to in-clear communication.
25272 See section &<<SECDANE>>&.
25273
25274 .option hosts_require_ocsp smtp "host list&!!" unset
25275 .cindex "TLS" "requiring for certain servers"
25276 Exim will request, and check for a valid Certificate Status being given, on a
25277 TLS session for any host that matches this list.
25278 &%tls_verify_certificates%& should also be set for the transport.
25279
25280 .option hosts_require_tls smtp "host list&!!" unset
25281 .cindex "TLS" "requiring for certain servers"
25282 Exim will insist on using a TLS session when delivering to any host that
25283 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
25284 &*Note*&: This option affects outgoing mail only. To insist on TLS for
25285 incoming messages, use an appropriate ACL.
25286
25287 .option hosts_try_auth smtp "host list&!!" unset
25288 .cindex "authentication" "optional in client"
25289 This option provides a list of servers to which, provided they announce
25290 authentication support, Exim will attempt to authenticate as a client when it
25291 connects. If authentication fails, Exim will try to transfer the message
25292 unauthenticated. See also &%hosts_require_auth%&, and chapter
25293 &<<CHAPSMTPAUTH>>& for details of authentication.
25294
25295 .option hosts_try_chunking smtp "host list&!!" *
25296 .cindex CHUNKING "enabling, in client"
25297 .cindex BDAT "SMTP command"
25298 .cindex "RFC 3030" "CHUNKING"
25299 This option provides a list of servers to which, provided they announce
25300 CHUNKING support, Exim will attempt to use BDAT commands rather than DATA.
25301 .new
25302 Unless DKIM signing is being done,
25303 .wen
25304 BDAT will not be used in conjunction with a transport filter.
25305
25306 .option hosts_try_dane smtp "host list&!!" *
25307 .cindex DANE "transport options"
25308 .cindex DANE "attempting for certain servers"
25309 If built with DANE support, Exim  will require that a DNSSEC-validated
25310 TLSA record is present for any host matching the list,
25311 and that a DANE-verified TLS connection is made. See
25312 the &%dnssec_request_domains%& router and transport options.
25313 There will be no fallback to in-clear communication.
25314 See section &<<SECDANE>>&.
25315
25316 .option hosts_try_fastopen smtp "host list&!!" *
25317 .cindex "fast open, TCP" "enabling, in client"
25318 .cindex "TCP Fast Open" "enabling, in client"
25319 .cindex "RFC 7413" "TCP Fast Open"
25320 This option provides a list of servers to which, provided
25321 the facility is supported by this system, Exim will attempt to
25322 perform a TCP Fast Open.
25323 No data is sent on the SYN segment but, if the remote server also
25324 supports the facility, it can send its SMTP banner immediately after
25325 the SYN,ACK segment.  This can save up to one round-trip time.
25326
25327 The facility is only active for previously-contacted servers,
25328 as the initiator must present a cookie in the SYN segment.
25329
25330 On (at least some) current Linux distributions the facility must be enabled
25331 in the kernel by the sysadmin before the support is usable.
25332 There is no option for control of the server side; if the system supports
25333 it it is always enabled.  Note that lengthy operations in the connect ACL,
25334 such as DNSBL lookups, will still delay the emission of the SMTP banner.
25335
25336 .option hosts_try_prdr smtp "host list&!!" *
25337 .cindex "PRDR" "enabling, optional in client"
25338 .cindex "ESMTP extensions" PRDR
25339 This option provides a list of servers to which, provided they announce
25340 PRDR support, Exim will attempt to negotiate PRDR
25341 for multi-recipient messages.
25342 The option can usually be left as default.
25343
25344 .option interface smtp "string list&!!" unset
25345 .cindex "bind IP address"
25346 .cindex "IP address" "binding"
25347 .vindex "&$host$&"
25348 .vindex "&$host_address$&"
25349 This option specifies which interface to bind to when making an outgoing SMTP
25350 call. The value is an IP address, not an interface name such as
25351 &`eth0`&. Do not confuse this with the interface address that was used when a
25352 message was received, which is in &$received_ip_address$&, formerly known as
25353 &$interface_address$&. The name was changed to minimize confusion with the
25354 outgoing interface address. There is no variable that contains an outgoing
25355 interface address because, unless it is set by this option, its value is
25356 unknown.
25357
25358 During the expansion of the &%interface%& option the variables &$host$& and
25359 &$host_address$& refer to the host to which a connection is about to be made
25360 during the expansion of the string. Forced expansion failure, or an empty
25361 string result causes the option to be ignored. Otherwise, after expansion, the
25362 string must be a list of IP addresses, colon-separated by default, but the
25363 separator can be changed in the usual way (&<<SECTlistsepchange>>&).
25364 For example:
25365 .code
25366 interface = <; 192.168.123.123 ; 3ffe:ffff:836f::fe86:a061
25367 .endd
25368 The first interface of the correct type (IPv4 or IPv6) is used for the outgoing
25369 connection. If none of them are the correct type, the option is ignored. If
25370 &%interface%& is not set, or is ignored, the system's IP functions choose which
25371 interface to use if the host has more than one.
25372
25373
25374 .option keepalive smtp boolean true
25375 .cindex "keepalive" "on outgoing connection"
25376 This option controls the setting of SO_KEEPALIVE on outgoing TCP/IP socket
25377 connections. When set, it causes the kernel to probe idle connections
25378 periodically, by sending packets with &"old"& sequence numbers. The other end
25379 of the connection should send a acknowledgment if the connection is still okay
25380 or a reset if the connection has been aborted. The reason for doing this is
25381 that it has the beneficial effect of freeing up certain types of connection
25382 that can get stuck when the remote host is disconnected without tidying up the
25383 TCP/IP call properly. The keepalive mechanism takes several hours to detect
25384 unreachable hosts.
25385
25386
25387 .option lmtp_ignore_quota smtp boolean false
25388 .cindex "LMTP" "ignoring quota errors"
25389 If this option is set true when the &%protocol%& option is set to &"lmtp"&, the
25390 string &`IGNOREQUOTA`& is added to RCPT commands, provided that the LMTP server
25391 has advertised support for IGNOREQUOTA in its response to the LHLO command.
25392
25393 .option max_rcpt smtp integer 100
25394 .cindex "RCPT" "maximum number of outgoing"
25395 This option limits the number of RCPT commands that are sent in a single
25396 SMTP message transaction. Each set of addresses is treated independently, and
25397 so can cause parallel connections to the same host if &%remote_max_parallel%&
25398 permits this.
25399
25400
25401 .option multi_domain smtp boolean&!! true
25402 .vindex "&$domain$&"
25403 When this option is set, the &(smtp)& transport can handle a number of
25404 addresses containing a mixture of different domains provided they all resolve
25405 to the same list of hosts. Turning the option off restricts the transport to
25406 handling only one domain at a time. This is useful if you want to use
25407 &$domain$& in an expansion for the transport, because it is set only when there
25408 is a single domain involved in a remote delivery.
25409
25410 It is expanded per-address and can depend on any of
25411 &$address_data$&, &$domain_data$&, &$local_part_data$&,
25412 &$host$&, &$host_address$& and &$host_port$&.
25413
25414 .option port smtp string&!! "see below"
25415 .cindex "port" "sending TCP/IP"
25416 .cindex "TCP/IP" "setting outgoing port"
25417 This option specifies the TCP/IP port on the server to which Exim connects.
25418 &*Note:*& Do not confuse this with the port that was used when a message was
25419 received, which is in &$received_port$&, formerly known as &$interface_port$&.
25420 The name was changed to minimize confusion with the outgoing port. There is no
25421 variable that contains an outgoing port.
25422
25423 If the value of this option begins with a digit it is taken as a port number;
25424 otherwise it is looked up using &[getservbyname()]&. The default value is
25425 normally &"smtp"&,
25426 but if &%protocol%& is set to &"lmtp"& the default is &"lmtp"&
25427 and if &%protocol%& is set to &"smtps"& the default is &"smtps"&.
25428 If the expansion fails, or if a port number cannot be found, delivery
25429 is deferred.
25430
25431 Note that at least one Linux distribution has been seen failing
25432 to put &"smtps"& in its &"/etc/services"& file, resulting is such deferrals.
25433
25434
25435
25436 .option protocol smtp string smtp
25437 .cindex "LMTP" "over TCP/IP"
25438 .cindex "ssmtp protocol" "outbound"
25439 .cindex "TLS" "SSL-on-connect outbound"
25440 .vindex "&$port$&"
25441 If this option is set to &"lmtp"& instead of &"smtp"&, the default value for
25442 the &%port%& option changes to &"lmtp"&, and the transport operates the LMTP
25443 protocol (RFC 2033) instead of SMTP. This protocol is sometimes used for local
25444 deliveries into closed message stores. Exim also has support for running LMTP
25445 over a pipe to a local process &-- see chapter &<<CHAPLMTP>>&.
25446
25447 If this option is set to &"smtps"&, the default value for the &%port%& option
25448 changes to &"smtps"&, and the transport initiates TLS immediately after
25449 connecting, as an outbound SSL-on-connect, instead of using STARTTLS to upgrade.
25450 The Internet standards bodies used to strongly discourage use of this mode,
25451 but as of RFC 8314 it is perferred over STARTTLS for message submission
25452 (as distinct from MTA-MTA communication).
25453
25454
25455 .option retry_include_ip_address smtp boolean&!! true
25456 Exim normally includes both the host name and the IP address in the key it
25457 constructs for indexing retry data after a temporary delivery failure. This
25458 means that when one of several IP addresses for a host is failing, it gets
25459 tried periodically (controlled by the retry rules), but use of the other IP
25460 addresses is not affected.
25461
25462 However, in some dialup environments hosts are assigned a different IP address
25463 each time they connect. In this situation the use of the IP address as part of
25464 the retry key leads to undesirable behaviour. Setting this option false causes
25465 Exim to use only the host name.
25466 Since it is expanded it can be made to depend on the host or domain.
25467
25468
25469 .option serialize_hosts smtp "host list&!!" unset
25470 .cindex "serializing connections"
25471 .cindex "host" "serializing connections"
25472 Because Exim operates in a distributed manner, if several messages for the same
25473 host arrive at around the same time, more than one simultaneous connection to
25474 the remote host can occur. This is not usually a problem except when there is a
25475 slow link between the hosts. In that situation it may be helpful to restrict
25476 Exim to one connection at a time. This can be done by setting
25477 &%serialize_hosts%& to match the relevant hosts.
25478
25479 .cindex "hints database" "serializing deliveries to a host"
25480 Exim implements serialization by means of a hints database in which a record is
25481 written whenever a process connects to one of the restricted hosts. The record
25482 is deleted when the connection is completed. Obviously there is scope for
25483 records to get left lying around if there is a system or program crash. To
25484 guard against this, Exim ignores any records that are more than six hours old.
25485
25486 If you set up this kind of serialization, you should also arrange to delete the
25487 relevant hints database whenever your system reboots. The names of the files
25488 start with &_misc_& and they are kept in the &_spool/db_& directory. There
25489 may be one or two files, depending on the type of DBM in use. The same files
25490 are used for ETRN serialization.
25491
25492 See also the &%max_parallel%& generic transport option.
25493
25494
25495 .option size_addition smtp integer 1024
25496 .cindex "SIZE" "ESMTP extension"
25497 .cindex "message" "size issue for transport filter"
25498 .cindex "size" "of message"
25499 .cindex "transport" "filter"
25500 .cindex "filter" "transport filter"
25501 If a remote SMTP server indicates that it supports the SIZE option of the
25502 MAIL command, Exim uses this to pass over the message size at the start of
25503 an SMTP transaction. It adds the value of &%size_addition%& to the value it
25504 sends, to allow for headers and other text that may be added during delivery by
25505 configuration options or in a transport filter. It may be necessary to increase
25506 this if a lot of text is added to messages.
25507
25508 Alternatively, if the value of &%size_addition%& is set negative, it disables
25509 the use of the SIZE option altogether.
25510
25511
25512 .option socks_proxy smtp string&!! unset
25513 .cindex proxy SOCKS
25514 This option enables use of SOCKS proxies for connections made by the
25515 transport.  For details see section &<<SECTproxySOCKS>>&.
25516
25517
25518 .option tls_certificate smtp string&!! unset
25519 .cindex "TLS" "client certificate, location of"
25520 .cindex "certificate" "client, location of"
25521 .vindex "&$host$&"
25522 .vindex "&$host_address$&"
25523 The value of this option must be the absolute path to a file which contains the
25524 client's certificate, for possible use when sending a message over an encrypted
25525 connection. The values of &$host$& and &$host_address$& are set to the name and
25526 address of the server during the expansion. See chapter &<<CHAPTLS>>& for
25527 details of TLS.
25528
25529 &*Note*&: This option must be set if you want Exim to be able to use a TLS
25530 certificate when sending messages as a client. The global option of the same
25531 name specifies the certificate for Exim as a server; it is not automatically
25532 assumed that the same certificate should be used when Exim is operating as a
25533 client.
25534
25535
25536 .option tls_crl smtp string&!! unset
25537 .cindex "TLS" "client certificate revocation list"
25538 .cindex "certificate" "revocation list for client"
25539 This option specifies a certificate revocation list. The expanded value must
25540 be the name of a file that contains a CRL in PEM format.
25541
25542
25543 .option tls_dh_min_bits smtp integer 1024
25544 .cindex "TLS" "Diffie-Hellman minimum acceptable size"
25545 When establishing a TLS session, if a ciphersuite which uses Diffie-Hellman
25546 key agreement is negotiated, the server will provide a large prime number
25547 for use.  This option establishes the minimum acceptable size of that number.
25548 If the parameter offered by the server is too small, then the TLS handshake
25549 will fail.
25550
25551 Only supported when using GnuTLS.
25552
25553
25554 .option tls_privatekey smtp string&!! unset
25555 .cindex "TLS" "client private key, location of"
25556 .vindex "&$host$&"
25557 .vindex "&$host_address$&"
25558 The value of this option must be the absolute path to a file which contains the
25559 client's private key. This is used when sending a message over an encrypted
25560 connection using a client certificate. The values of &$host$& and
25561 &$host_address$& are set to the name and address of the server during the
25562 expansion. If this option is unset, or the expansion is forced to fail, or the
25563 result is an empty string, the private key is assumed to be in the same file as
25564 the certificate. See chapter &<<CHAPTLS>>& for details of TLS.
25565
25566
25567 .option tls_require_ciphers smtp string&!! unset
25568 .cindex "TLS" "requiring specific ciphers"
25569 .cindex "cipher" "requiring specific"
25570 .vindex "&$host$&"
25571 .vindex "&$host_address$&"
25572 The value of this option must be a list of permitted cipher suites, for use
25573 when setting up an outgoing encrypted connection. (There is a global option of
25574 the same name for controlling incoming connections.) The values of &$host$& and
25575 &$host_address$& are set to the name and address of the server during the
25576 expansion. See chapter &<<CHAPTLS>>& for details of TLS; note that this option
25577 is used in different ways by OpenSSL and GnuTLS (see sections
25578 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&). For GnuTLS, the order of the
25579 ciphers is a preference order.
25580
25581
25582
25583 .option tls_sni smtp string&!! unset
25584 .cindex "TLS" "Server Name Indication"
25585 .vindex "&$tls_sni$&"
25586 If this option is set then it sets the $tls_out_sni variable and causes any
25587 TLS session to pass this value as the Server Name Indication extension to
25588 the remote side, which can be used by the remote side to select an appropriate
25589 certificate and private key for the session.
25590
25591 See &<<SECTtlssni>>& for more information.
25592
25593 Note that for OpenSSL, this feature requires a build of OpenSSL that supports
25594 TLS extensions.
25595
25596
25597
25598
25599 .option tls_tempfail_tryclear smtp boolean true
25600 .cindex "4&'xx'& responses" "to STARTTLS"
25601 When the server host is not in &%hosts_require_tls%&, and there is a problem in
25602 setting up a TLS session, this option determines whether or not Exim should try
25603 to deliver the message unencrypted. If it is set false, delivery to the
25604 current host is deferred; if there are other hosts, they are tried. If this
25605 option is set true, Exim attempts to deliver unencrypted after a 4&'xx'&
25606 response to STARTTLS. Also, if STARTTLS is accepted, but the subsequent
25607 TLS negotiation fails, Exim closes the current connection (because it is in an
25608 unknown state), opens a new one to the same host, and then tries the delivery
25609 in clear.
25610
25611
25612 .option tls_try_verify_hosts smtp "host list&!!" *
25613 .cindex "TLS" "server certificate verification"
25614 .cindex "certificate" "verification of server"
25615 This option gives a list of hosts for which, on encrypted connections,
25616 certificate verification will be tried but need not succeed.
25617 The &%tls_verify_certificates%& option must also be set.
25618 Note that unless the host is in this list
25619 TLS connections will be denied to hosts using self-signed certificates
25620 when &%tls_verify_certificates%& is matched.
25621 The &$tls_out_certificate_verified$& variable is set when
25622 certificate verification succeeds.
25623
25624
25625 .option tls_verify_cert_hostnames smtp "host list&!!" *
25626 .cindex "TLS" "server certificate hostname verification"
25627 .cindex "certificate" "verification of server"
25628 This option give a list of hosts for which,
25629 while verifying the server certificate,
25630 checks will be included on the host name
25631 (note that this will generally be the result of a DNS MX lookup)
25632 versus Subject and Subject-Alternate-Name fields.  Wildcard names are permitted
25633 limited to being the initial component of a 3-or-more component FQDN.
25634
25635 There is no equivalent checking on client certificates.
25636
25637
25638 .option tls_verify_certificates smtp string&!! system
25639 .cindex "TLS" "server certificate verification"
25640 .cindex "certificate" "verification of server"
25641 .vindex "&$host$&"
25642 .vindex "&$host_address$&"
25643 The value of this option must be either the
25644 word "system"
25645 or the absolute path to
25646 a file or directory containing permitted certificates for servers,
25647 for use when setting up an encrypted connection.
25648
25649 The "system" value for the option will use a location compiled into the SSL library.
25650 This is not available for GnuTLS versions preceding 3.0.20; a value of "system"
25651 is taken as empty and an explicit location
25652 must be specified.
25653
25654 The use of a directory for the option value is not available for GnuTLS versions
25655 preceding 3.3.6 and a single file must be used.
25656
25657 With OpenSSL the certificates specified
25658 explicitly
25659 either by file or directory
25660 are added to those given by the system default location.
25661
25662 The values of &$host$& and
25663 &$host_address$& are set to the name and address of the server during the
25664 expansion of this option. See chapter &<<CHAPTLS>>& for details of TLS.
25665
25666 For back-compatibility,
25667 if neither tls_verify_hosts nor tls_try_verify_hosts are set
25668 (a single-colon empty list counts as being set)
25669 and certificate verification fails the TLS connection is closed.
25670
25671
25672 .option tls_verify_hosts smtp "host list&!!" unset
25673 .cindex "TLS" "server certificate verification"
25674 .cindex "certificate" "verification of server"
25675 This option gives a list of hosts for which, on encrypted connections,
25676 certificate verification must succeed.
25677 The &%tls_verify_certificates%& option must also be set.
25678 If both this option and &%tls_try_verify_hosts%& are unset
25679 operation is as if this option selected all hosts.
25680
25681 .option utf8_downconvert smtp integer&!! -1
25682 .cindex utf8 "address downconversion"
25683 .cindex i18n "utf8 address downconversion"
25684 If built with internationalization support,
25685 this option controls conversion of UTF-8 in message envelope addresses
25686 to a-label form.
25687 If, after expansion, the value is 1, 0, or -1 then this value overrides
25688 any value previously set for the message.  Otherwise, any previously
25689 set value is used.  To permit use of a previous value,
25690 set this option to an empty string.
25691 For details on the values see section &<<SECTi18nMTA>>&.
25692
25693
25694
25695
25696 .section "How the limits for the number of hosts to try are used" &&&
25697          "SECTvalhosmax"
25698 .cindex "host" "maximum number to try"
25699 .cindex "limit" "hosts; maximum number tried"
25700 There are two options that are concerned with the number of hosts that are
25701 tried when an SMTP delivery takes place. They are &%hosts_max_try%& and
25702 &%hosts_max_try_hardlimit%&.
25703
25704
25705 The &%hosts_max_try%& option limits the number of hosts that are tried
25706 for a single delivery. However, despite the term &"host"& in its name, the
25707 option actually applies to each IP address independently. In other words, a
25708 multihomed host is treated as several independent hosts, just as it is for
25709 retrying.
25710
25711 Many of the larger ISPs have multiple MX records which often point to
25712 multihomed hosts. As a result, a list of a dozen or more IP addresses may be
25713 created as a result of routing one of these domains.
25714
25715 Trying every single IP address on such a long list does not seem sensible; if
25716 several at the top of the list fail, it is reasonable to assume there is some
25717 problem that is likely to affect all of them. Roughly speaking, the value of
25718 &%hosts_max_try%& is the maximum number that are tried before deferring the
25719 delivery. However, the logic cannot be quite that simple.
25720
25721 Firstly, IP addresses that are skipped because their retry times have not
25722 arrived do not count, and in addition, addresses that are past their retry
25723 limits are also not counted, even when they are tried. This means that when
25724 some IP addresses are past their retry limits, more than the value of
25725 &%hosts_max_retry%& may be tried. The reason for this behaviour is to ensure
25726 that all IP addresses are considered before timing out an email address (but
25727 see below for an exception).
25728
25729 Secondly, when the &%hosts_max_try%& limit is reached, Exim looks down the host
25730 list to see if there is a subsequent host with a different (higher valued) MX.
25731 If there is, that host is considered next, and the current IP address is used
25732 but not counted. This behaviour helps in the case of a domain with a retry rule
25733 that hardly ever delays any hosts, as is now explained:
25734
25735 Consider the case of a long list of hosts with one MX value, and a few with a
25736 higher MX value. If &%hosts_max_try%& is small (the default is 5) only a few
25737 hosts at the top of the list are tried at first. With the default retry rule,
25738 which specifies increasing retry times, the higher MX hosts are eventually
25739 tried when those at the top of the list are skipped because they have not
25740 reached their retry times.
25741
25742 However, it is common practice to put a fixed short retry time on domains for
25743 large ISPs, on the grounds that their servers are rarely down for very long.
25744 Unfortunately, these are exactly the domains that tend to resolve to long lists
25745 of hosts. The short retry time means that the lowest MX hosts are tried every
25746 time. The attempts may be in a different order because of random sorting, but
25747 without the special MX check, the higher MX hosts would never be tried until
25748 all the lower MX hosts had timed out (which might be several days), because
25749 there are always some lower MX hosts that have reached their retry times. With
25750 the special check, Exim considers at least one IP address from each MX value at
25751 every delivery attempt, even if the &%hosts_max_try%& limit has already been
25752 reached.
25753
25754 The above logic means that &%hosts_max_try%& is not a hard limit, and in
25755 particular, Exim normally eventually tries all the IP addresses before timing
25756 out an email address. When &%hosts_max_try%& was implemented, this seemed a
25757 reasonable thing to do. Recently, however, some lunatic DNS configurations have
25758 been set up with hundreds of IP addresses for some domains. It can
25759 take a very long time indeed for an address to time out in these cases.
25760
25761 The &%hosts_max_try_hardlimit%& option was added to help with this problem.
25762 Exim never tries more than this number of IP addresses; if it hits this limit
25763 and they are all timed out, the email address is bounced, even though not all
25764 possible IP addresses have been tried.
25765 .ecindex IIDsmttra1
25766 .ecindex IIDsmttra2
25767
25768
25769
25770
25771
25772 . ////////////////////////////////////////////////////////////////////////////
25773 . ////////////////////////////////////////////////////////////////////////////
25774
25775 .chapter "Address rewriting" "CHAPrewrite"
25776 .scindex IIDaddrew "rewriting" "addresses"
25777 There are some circumstances in which Exim automatically rewrites domains in
25778 addresses. The two most common are when an address is given without a domain
25779 (referred to as an &"unqualified address"&) or when an address contains an
25780 abbreviated domain that is expanded by DNS lookup.
25781
25782 Unqualified envelope addresses are accepted only for locally submitted
25783 messages, or for messages that are received from hosts matching
25784 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
25785 appropriate. Unqualified addresses in header lines are qualified if they are in
25786 locally submitted messages, or messages from hosts that are permitted to send
25787 unqualified envelope addresses. Otherwise, unqualified addresses in header
25788 lines are neither qualified nor rewritten.
25789
25790 One situation in which Exim does &'not'& automatically rewrite a domain is
25791 when it is the name of a CNAME record in the DNS. The older RFCs suggest that
25792 such a domain should be rewritten using the &"canonical"& name, and some MTAs
25793 do this. The new RFCs do not contain this suggestion.
25794
25795
25796 .section "Explicitly configured address rewriting" "SECID147"
25797 This chapter describes the rewriting rules that can be used in the
25798 main rewrite section of the configuration file, and also in the generic
25799 &%headers_rewrite%& option that can be set on any transport.
25800
25801 Some people believe that configured address rewriting is a Mortal Sin.
25802 Others believe that life is not possible without it. Exim provides the
25803 facility; you do not have to use it.
25804
25805 The main rewriting rules that appear in the &"rewrite"& section of the
25806 configuration file are applied to addresses in incoming messages, both envelope
25807 addresses and addresses in header lines. Each rule specifies the types of
25808 address to which it applies.
25809
25810 Whether or not addresses in header lines are rewritten depends on the origin of
25811 the headers and the type of rewriting. Global rewriting, that is, rewriting
25812 rules from the rewrite section of the configuration file, is applied only to
25813 those headers that were received with the message. Header lines that are added
25814 by ACLs or by a system filter or by individual routers or transports (which
25815 are specific to individual recipient addresses) are not rewritten by the global
25816 rules.
25817
25818 Rewriting at transport time, by means of the &%headers_rewrite%& option,
25819 applies all headers except those added by routers and transports. That is, as
25820 well as the headers that were received with the message, it also applies to
25821 headers that were added by an ACL or a system filter.
25822
25823
25824 In general, rewriting addresses from your own system or domain has some
25825 legitimacy. Rewriting other addresses should be done only with great care and
25826 in special circumstances. The author of Exim believes that rewriting should be
25827 used sparingly, and mainly for &"regularizing"& addresses in your own domains.
25828 Although it can sometimes be used as a routing tool, this is very strongly
25829 discouraged.
25830
25831 There are two commonly encountered circumstances where rewriting is used, as
25832 illustrated by these examples:
25833
25834 .ilist
25835 The company whose domain is &'hitch.fict.example'& has a number of hosts that
25836 exchange mail with each other behind a firewall, but there is only a single
25837 gateway to the outer world. The gateway rewrites &'*.hitch.fict.example'& as
25838 &'hitch.fict.example'& when sending mail off-site.
25839 .next
25840 A host rewrites the local parts of its own users so that, for example,
25841 &'fp42@hitch.fict.example'& becomes &'Ford.Prefect@hitch.fict.example'&.
25842 .endlist
25843
25844
25845
25846 .section "When does rewriting happen?" "SECID148"
25847 .cindex "rewriting" "timing of"
25848 .cindex "&ACL;" "rewriting addresses in"
25849 Configured address rewriting can take place at several different stages of a
25850 message's processing.
25851
25852 .vindex "&$sender_address$&"
25853 At the start of an ACL for MAIL, the sender address may have been rewritten
25854 by a special SMTP-time rewrite rule (see section &<<SECTrewriteS>>&), but no
25855 ordinary rewrite rules have yet been applied. If, however, the sender address
25856 is verified in the ACL, it is rewritten before verification, and remains
25857 rewritten thereafter. The subsequent value of &$sender_address$& is the
25858 rewritten address. This also applies if sender verification happens in a
25859 RCPT ACL. Otherwise, when the sender address is not verified, it is
25860 rewritten as soon as a message's header lines have been received.
25861
25862 .vindex "&$domain$&"
25863 .vindex "&$local_part$&"
25864 Similarly, at the start of an ACL for RCPT, the current recipient's address
25865 may have been rewritten by a special SMTP-time rewrite rule, but no ordinary
25866 rewrite rules have yet been applied to it. However, the behaviour is different
25867 from the sender address when a recipient is verified. The address is rewritten
25868 for the verification, but the rewriting is not remembered at this stage. The
25869 value of &$local_part$& and &$domain$& after verification are always the same
25870 as they were before (that is, they contain the unrewritten &-- except for
25871 SMTP-time rewriting &-- address).
25872
25873 As soon as a message's header lines have been received, all the envelope
25874 recipient addresses are permanently rewritten, and rewriting is also applied to
25875 the addresses in the header lines (if configured). This happens before adding
25876 any header lines that were specified in MAIL or RCPT ACLs, and
25877 .cindex "&[local_scan()]& function" "address rewriting; timing of"
25878 before the DATA ACL and &[local_scan()]& functions are run.
25879
25880 When an address is being routed, either for delivery or for verification,
25881 rewriting is applied immediately to child addresses that are generated by
25882 redirection, unless &%no_rewrite%& is set on the router.
25883
25884 .cindex "envelope from"
25885 .cindex "envelope sender" "rewriting at transport time"
25886 .cindex "rewriting" "at transport time"
25887 .cindex "header lines" "rewriting at transport time"
25888 At transport time, additional rewriting of addresses in header lines can be
25889 specified by setting the generic &%headers_rewrite%& option on a transport.
25890 This option contains rules that are identical in form to those in the rewrite
25891 section of the configuration file. They are applied to the original message
25892 header lines and any that were added by ACLs or a system filter. They are not
25893 applied to header lines that are added by routers or the transport.
25894
25895 The outgoing envelope sender can be rewritten by means of the &%return_path%&
25896 transport option. However, it is not possible to rewrite envelope recipients at
25897 transport time.
25898
25899
25900
25901
25902 .section "Testing the rewriting rules that apply on input" "SECID149"
25903 .cindex "rewriting" "testing"
25904 .cindex "testing" "rewriting"
25905 Exim's input rewriting configuration appears in a part of the runtime
25906 configuration file headed by &"begin rewrite"&. It can be tested by the
25907 &%-brw%& command line option. This takes an address (which can be a full RFC
25908 2822 address) as its argument. The output is a list of how the address would be
25909 transformed by the rewriting rules for each of the different places it might
25910 appear in an incoming message, that is, for each different header and for the
25911 envelope sender and recipient fields. For example,
25912 .code
25913 exim -brw ph10@exim.workshop.example
25914 .endd
25915 might produce the output
25916 .code
25917 sender: Philip.Hazel@exim.workshop.example
25918 from: Philip.Hazel@exim.workshop.example
25919 to: ph10@exim.workshop.example
25920 cc: ph10@exim.workshop.example
25921 bcc: ph10@exim.workshop.example
25922 reply-to: Philip.Hazel@exim.workshop.example
25923 env-from: Philip.Hazel@exim.workshop.example
25924 env-to: ph10@exim.workshop.example
25925 .endd
25926 which shows that rewriting has been set up for that address when used in any of
25927 the source fields, but not when it appears as a recipient address. At the
25928 present time, there is no equivalent way of testing rewriting rules that are
25929 set for a particular transport.
25930
25931
25932 .section "Rewriting rules" "SECID150"
25933 .cindex "rewriting" "rules"
25934 The rewrite section of the configuration file consists of lines of rewriting
25935 rules in the form
25936 .display
25937 <&'source pattern'&>  <&'replacement'&>  <&'flags'&>
25938 .endd
25939 Rewriting rules that are specified for the &%headers_rewrite%& generic
25940 transport option are given as a colon-separated list. Each item in the list
25941 takes the same form as a line in the main rewriting configuration (except that
25942 any colons must be doubled, of course).
25943
25944 The formats of source patterns and replacement strings are described below.
25945 Each is terminated by white space, unless enclosed in double quotes, in which
25946 case normal quoting conventions apply inside the quotes. The flags are single
25947 characters which may appear in any order. Spaces and tabs between them are
25948 ignored.
25949
25950 For each address that could potentially be rewritten, the rules are scanned in
25951 order, and replacements for the address from earlier rules can themselves be
25952 replaced by later rules (but see the &"q"& and &"R"& flags).
25953
25954 The order in which addresses are rewritten is undefined, may change between
25955 releases, and must not be relied on, with one exception: when a message is
25956 received, the envelope sender is always rewritten first, before any header
25957 lines are rewritten. For example, the replacement string for a rewrite of an
25958 address in &'To:'& must not assume that the message's address in &'From:'& has
25959 (or has not) already been rewritten. However, a rewrite of &'From:'& may assume
25960 that the envelope sender has already been rewritten.
25961
25962 .vindex "&$domain$&"
25963 .vindex "&$local_part$&"
25964 The variables &$local_part$& and &$domain$& can be used in the replacement
25965 string to refer to the address that is being rewritten. Note that lookup-driven
25966 rewriting can be done by a rule of the form
25967 .code
25968 *@*   ${lookup ...
25969 .endd
25970 where the lookup key uses &$1$& and &$2$& or &$local_part$& and &$domain$& to
25971 refer to the address that is being rewritten.
25972
25973
25974 .section "Rewriting patterns" "SECID151"
25975 .cindex "rewriting" "patterns"
25976 .cindex "address list" "in a rewriting pattern"
25977 The source pattern in a rewriting rule is any item which may appear in an
25978 address list (see section &<<SECTaddresslist>>&). It is in fact processed as a
25979 single-item address list, which means that it is expanded before being tested
25980 against the address. As always, if you use a regular expression as a pattern,
25981 you must take care to escape dollar and backslash characters, or use the &`\N`&
25982 facility to suppress string expansion within the regular expression.
25983
25984 Domains in patterns should be given in lower case. Local parts in patterns are
25985 case-sensitive. If you want to do case-insensitive matching of local parts, you
25986 can use a regular expression that starts with &`^(?i)`&.
25987
25988 .cindex "numerical variables (&$1$& &$2$& etc)" "in rewriting rules"
25989 After matching, the numerical variables &$1$&, &$2$&, etc. may be set,
25990 depending on the type of match which occurred. These can be used in the
25991 replacement string to insert portions of the incoming address. &$0$& always
25992 refers to the complete incoming address. When a regular expression is used, the
25993 numerical variables are set from its capturing subexpressions. For other types
25994 of pattern they are set as follows:
25995
25996 .ilist
25997 If a local part or domain starts with an asterisk, the numerical variables
25998 refer to the character strings matched by asterisks, with &$1$& associated with
25999 the first asterisk, and &$2$& with the second, if present. For example, if the
26000 pattern
26001 .code
26002 *queen@*.fict.example
26003 .endd
26004 is matched against the address &'hearts-queen@wonderland.fict.example'& then
26005 .code
26006 $0 = hearts-queen@wonderland.fict.example
26007 $1 = hearts-
26008 $2 = wonderland
26009 .endd
26010 Note that if the local part does not start with an asterisk, but the domain
26011 does, it is &$1$& that contains the wild part of the domain.
26012
26013 .next
26014 If the domain part of the pattern is a partial lookup, the wild and fixed parts
26015 of the domain are placed in the next available numerical variables. Suppose,
26016 for example, that the address &'foo@bar.baz.example'& is processed by a
26017 rewriting rule of the form
26018 .display
26019 &`*@partial-dbm;/some/dbm/file`&    <&'replacement string'&>
26020 .endd
26021 and the key in the file that matches the domain is &`*.baz.example`&. Then
26022 .code
26023 $1 = foo
26024 $2 = bar
26025 $3 = baz.example
26026 .endd
26027 If the address &'foo@baz.example'& is looked up, this matches the same
26028 wildcard file entry, and in this case &$2$& is set to the empty string, but
26029 &$3$& is still set to &'baz.example'&. If a non-wild key is matched in a
26030 partial lookup, &$2$& is again set to the empty string and &$3$& is set to the
26031 whole domain. For non-partial domain lookups, no numerical variables are set.
26032 .endlist
26033
26034
26035 .section "Rewriting replacements" "SECID152"
26036 .cindex "rewriting" "replacements"
26037 If the replacement string for a rule is a single asterisk, addresses that
26038 match the pattern and the flags are &'not'& rewritten, and no subsequent
26039 rewriting rules are scanned. For example,
26040 .code
26041 hatta@lookingglass.fict.example  *  f
26042 .endd
26043 specifies that &'hatta@lookingglass.fict.example'& is never to be rewritten in
26044 &'From:'& headers.
26045
26046 .vindex "&$domain$&"
26047 .vindex "&$local_part$&"
26048 If the replacement string is not a single asterisk, it is expanded, and must
26049 yield a fully qualified address. Within the expansion, the variables
26050 &$local_part$& and &$domain$& refer to the address that is being rewritten.
26051 Any letters they contain retain their original case &-- they are not lower
26052 cased. The numerical variables are set up according to the type of pattern that
26053 matched the address, as described above. If the expansion is forced to fail by
26054 the presence of &"fail"& in a conditional or lookup item, rewriting by the
26055 current rule is abandoned, but subsequent rules may take effect. Any other
26056 expansion failure causes the entire rewriting operation to be abandoned, and an
26057 entry written to the panic log.
26058
26059
26060
26061 .section "Rewriting flags" "SECID153"
26062 There are three different kinds of flag that may appear on rewriting rules:
26063
26064 .ilist
26065 Flags that specify which headers and envelope addresses to rewrite: E, F, T, b,
26066 c, f, h, r, s, t.
26067 .next
26068 A flag that specifies rewriting at SMTP time: S.
26069 .next
26070 Flags that control the rewriting process: Q, q, R, w.
26071 .endlist
26072
26073 For rules that are part of the &%headers_rewrite%& generic transport option,
26074 E, F, T, and S are not permitted.
26075
26076
26077
26078 .section "Flags specifying which headers and envelope addresses to rewrite" &&&
26079          "SECID154"
26080 .cindex "rewriting" "flags"
26081 If none of the following flag letters, nor the &"S"& flag (see section
26082 &<<SECTrewriteS>>&) are present, a main rewriting rule applies to all headers
26083 and to both the sender and recipient fields of the envelope, whereas a
26084 transport-time rewriting rule just applies to all headers. Otherwise, the
26085 rewriting rule is skipped unless the relevant addresses are being processed.
26086 .display
26087 &`E`&       rewrite all envelope fields
26088 &`F`&       rewrite the envelope From field
26089 &`T`&       rewrite the envelope To field
26090 &`b`&       rewrite the &'Bcc:'& header
26091 &`c`&       rewrite the &'Cc:'& header
26092 &`f`&       rewrite the &'From:'& header
26093 &`h`&       rewrite all headers
26094 &`r`&       rewrite the &'Reply-To:'& header
26095 &`s`&       rewrite the &'Sender:'& header
26096 &`t`&       rewrite the &'To:'& header
26097 .endd
26098 "All headers" means all of the headers listed above that can be selected
26099 individually, plus their &'Resent-'& versions. It does not include
26100 other headers such as &'Subject:'& etc.
26101
26102 You should be particularly careful about rewriting &'Sender:'& headers, and
26103 restrict this to special known cases in your own domains.
26104
26105
26106 .section "The SMTP-time rewriting flag" "SECTrewriteS"
26107 .cindex "SMTP" "rewriting malformed addresses"
26108 .cindex "RCPT" "rewriting argument of"
26109 .cindex "MAIL" "rewriting argument of"
26110 The rewrite flag &"S"& specifies a rewrite of incoming envelope addresses at
26111 SMTP time, as soon as an address is received in a MAIL or RCPT command, and
26112 before any other processing; even before syntax checking. The pattern is
26113 required to be a regular expression, and it is matched against the whole of the
26114 data for the command, including any surrounding angle brackets.
26115
26116 .vindex "&$domain$&"
26117 .vindex "&$local_part$&"
26118 This form of rewrite rule allows for the handling of addresses that are not
26119 compliant with RFCs 2821 and 2822 (for example, &"bang paths"& in batched SMTP
26120 input). Because the input is not required to be a syntactically valid address,
26121 the variables &$local_part$& and &$domain$& are not available during the
26122 expansion of the replacement string. The result of rewriting replaces the
26123 original address in the MAIL or RCPT command.
26124
26125
26126 .section "Flags controlling the rewriting process" "SECID155"
26127 There are four flags which control the way the rewriting process works. These
26128 take effect only when a rule is invoked, that is, when the address is of the
26129 correct type (matches the flags) and matches the pattern:
26130
26131 .ilist
26132 If the &"Q"& flag is set on a rule, the rewritten address is permitted to be an
26133 unqualified local part. It is qualified with &%qualify_recipient%&. In the
26134 absence of &"Q"& the rewritten address must always include a domain.
26135 .next
26136 If the &"q"& flag is set on a rule, no further rewriting rules are considered,
26137 even if no rewriting actually takes place because of a &"fail"& in the
26138 expansion. The &"q"& flag is not effective if the address is of the wrong type
26139 (does not match the flags) or does not match the pattern.
26140 .next
26141 The &"R"& flag causes a successful rewriting rule to be re-applied to the new
26142 address, up to ten times. It can be combined with the &"q"& flag, to stop
26143 rewriting once it fails to match (after at least one successful rewrite).
26144 .next
26145 .cindex "rewriting" "whole addresses"
26146 When an address in a header is rewritten, the rewriting normally applies only
26147 to the working part of the address, with any comments and RFC 2822 &"phrase"&
26148 left unchanged. For example, rewriting might change
26149 .code
26150 From: Ford Prefect <fp42@restaurant.hitch.fict.example>
26151 .endd
26152 into
26153 .code
26154 From: Ford Prefect <prefectf@hitch.fict.example>
26155 .endd
26156 .cindex "RFC 2047"
26157 Sometimes there is a need to replace the whole address item, and this can be
26158 done by adding the flag letter &"w"& to a rule. If this is set on a rule that
26159 causes an address in a header line to be rewritten, the entire address is
26160 replaced, not just the working part. The replacement must be a complete RFC
26161 2822 address, including the angle brackets if necessary. If text outside angle
26162 brackets contains a character whose value is greater than 126 or less than 32
26163 (except for tab), the text is encoded according to RFC 2047. The character set
26164 is taken from &%headers_charset%&, which gets its default at build time.
26165
26166 When the &"w"& flag is set on a rule that causes an envelope address to be
26167 rewritten, all but the working part of the replacement address is discarded.
26168 .endlist
26169
26170
26171 .section "Rewriting examples" "SECID156"
26172 Here is an example of the two common rewriting paradigms:
26173 .code
26174 *@*.hitch.fict.example  $1@hitch.fict.example
26175 *@hitch.fict.example    ${lookup{$1}dbm{/etc/realnames}\
26176                      {$value}fail}@hitch.fict.example bctfrF
26177 .endd
26178 Note the use of &"fail"& in the lookup expansion in the second rule, forcing
26179 the string expansion to fail if the lookup does not succeed. In this context it
26180 has the effect of leaving the original address unchanged, but Exim goes on to
26181 consider subsequent rewriting rules, if any, because the &"q"& flag is not
26182 present in that rule. An alternative to &"fail"& would be to supply &$1$&
26183 explicitly, which would cause the rewritten address to be the same as before,
26184 at the cost of a small bit of processing. Not supplying either of these is an
26185 error, since the rewritten address would then contain no local part.
26186
26187 The first example above replaces the domain with a superior, more general
26188 domain. This may not be desirable for certain local parts. If the rule
26189 .code
26190 root@*.hitch.fict.example  *
26191 .endd
26192 were inserted before the first rule, rewriting would be suppressed for the
26193 local part &'root'& at any domain ending in &'hitch.fict.example'&.
26194
26195 Rewriting can be made conditional on a number of tests, by making use of
26196 &${if$& in the expansion item. For example, to apply a rewriting rule only to
26197 messages that originate outside the local host:
26198 .code
26199 *@*.hitch.fict.example  "${if !eq {$sender_host_address}{}\
26200                          {$1@hitch.fict.example}fail}"
26201 .endd
26202 The replacement string is quoted in this example because it contains white
26203 space.
26204
26205 .cindex "rewriting" "bang paths"
26206 .cindex "bang paths" "rewriting"
26207 Exim does not handle addresses in the form of &"bang paths"&. If it sees such
26208 an address it treats it as an unqualified local part which it qualifies with
26209 the local qualification domain (if the source of the message is local or if the
26210 remote host is permitted to send unqualified addresses). Rewriting can
26211 sometimes be used to handle simple bang paths with a fixed number of
26212 components. For example, the rule
26213 .code
26214 \N^([^!]+)!(.*)@your.domain.example$\N   $2@$1
26215 .endd
26216 rewrites a two-component bang path &'host.name!user'& as the domain address
26217 &'user@host.name'&. However, there is a security implication in using this as
26218 a global rewriting rule for envelope addresses. It can provide a backdoor
26219 method for using your system as a relay, because the incoming addresses appear
26220 to be local. If the bang path addresses are received via SMTP, it is safer to
26221 use the &"S"& flag to rewrite them as they are received, so that relay checking
26222 can be done on the rewritten addresses.
26223 .ecindex IIDaddrew
26224
26225
26226
26227
26228
26229 . ////////////////////////////////////////////////////////////////////////////
26230 . ////////////////////////////////////////////////////////////////////////////
26231
26232 .chapter "Retry configuration" "CHAPretry"
26233 .scindex IIDretconf1 "retry" "configuration, description of"
26234 .scindex IIDregconf2 "configuration file" "retry section"
26235 The &"retry"& section of the runtime configuration file contains a list of
26236 retry rules that control how often Exim tries to deliver messages that cannot
26237 be delivered at the first attempt. If there are no retry rules (the section is
26238 empty or not present), there are no retries. In this situation, temporary
26239 errors are treated as permanent. The default configuration contains a single,
26240 general-purpose retry rule (see section &<<SECID57>>&). The &%-brt%& command
26241 line option can be used to test which retry rule will be used for a given
26242 address, domain and error.
26243
26244 The most common cause of retries is temporary failure to deliver to a remote
26245 host because the host is down, or inaccessible because of a network problem.
26246 Exim's retry processing in this case is applied on a per-host (strictly, per IP
26247 address) basis, not on a per-message basis. Thus, if one message has recently
26248 been delayed, delivery of a new message to the same host is not immediately
26249 tried, but waits for the host's retry time to arrive. If the &%retry_defer%&
26250 log selector is set, the message
26251 .cindex "retry" "time not reached"
26252 &"retry time not reached"& is written to the main log whenever a delivery is
26253 skipped for this reason. Section &<<SECToutSMTPerr>>& contains more details of
26254 the handling of errors during remote deliveries.
26255
26256 Retry processing applies to routing as well as to delivering, except as covered
26257 in the next paragraph. The retry rules do not distinguish between these
26258 actions. It is not possible, for example, to specify different behaviour for
26259 failures to route the domain &'snark.fict.example'& and failures to deliver to
26260 the host &'snark.fict.example'&. I didn't think anyone would ever need this
26261 added complication, so did not implement it. However, although they share the
26262 same retry rule, the actual retry times for routing and transporting a given
26263 domain are maintained independently.
26264
26265 When a delivery is not part of a queue run (typically an immediate delivery on
26266 receipt of a message), the routers are always run, and local deliveries are
26267 always attempted, even if retry times are set for them. This makes for better
26268 behaviour if one particular message is causing problems (for example, causing
26269 quota overflow, or provoking an error in a filter file). If such a delivery
26270 suffers a temporary failure, the retry data is updated as normal, and
26271 subsequent delivery attempts from queue runs occur only when the retry time for
26272 the local address is reached.
26273
26274 .section "Changing retry rules" "SECID157"
26275 If you change the retry rules in your configuration, you should consider
26276 whether or not to delete the retry data that is stored in Exim's spool area in
26277 files with names like &_db/retry_&. Deleting any of Exim's hints files is
26278 always safe; that is why they are called &"hints"&.
26279
26280 The hints retry data contains suggested retry times based on the previous
26281 rules. In the case of a long-running problem with a remote host, it might
26282 record the fact that the host has timed out. If your new rules increase the
26283 timeout time for such a host, you should definitely remove the old retry data
26284 and let Exim recreate it, based on the new rules. Otherwise Exim might bounce
26285 messages that it should now be retaining.
26286
26287
26288
26289 .section "Format of retry rules" "SECID158"
26290 .cindex "retry" "rules"
26291 Each retry rule occupies one line and consists of three or four parts,
26292 separated by white space: a pattern, an error name, an optional list of sender
26293 addresses, and a list of retry parameters. The pattern and sender lists must be
26294 enclosed in double quotes if they contain white space. The rules are searched
26295 in order until one is found where the pattern, error name, and sender list (if
26296 present) match the failing host or address, the error that occurred, and the
26297 message's sender, respectively.
26298
26299
26300 The pattern is any single item that may appear in an address list (see section
26301 &<<SECTaddresslist>>&). It is in fact processed as a one-item address list,
26302 which means that it is expanded before being tested against the address that
26303 has been delayed. A negated address list item is permitted. Address
26304 list processing treats a plain domain name as if it were preceded by &"*@"&,
26305 which makes it possible for many retry rules to start with just a domain. For
26306 example,
26307 .code
26308 lookingglass.fict.example        *  F,24h,30m;
26309 .endd
26310 provides a rule for any address in the &'lookingglass.fict.example'& domain,
26311 whereas
26312 .code
26313 alice@lookingglass.fict.example  *  F,24h,30m;
26314 .endd
26315 applies only to temporary failures involving the local part &%alice%&.
26316 In practice, almost all rules start with a domain name pattern without a local
26317 part.
26318
26319 .cindex "regular expressions" "in retry rules"
26320 &*Warning*&: If you use a regular expression in a retry rule pattern, it
26321 must match a complete address, not just a domain, because that is how regular
26322 expressions work in address lists.
26323 .display
26324 &`^\Nxyz\d+\.abc\.example$\N        *  G,1h,10m,2`&     &%Wrong%&
26325 &`^\N[^@]+@xyz\d+\.abc\.example$\N  *  G,1h,10m,2`&     &%Right%&
26326 .endd
26327
26328
26329 .section "Choosing which retry rule to use for address errors" "SECID159"
26330 When Exim is looking for a retry rule after a routing attempt has failed (for
26331 example, after a DNS timeout), each line in the retry configuration is tested
26332 against the complete address only if &%retry_use_local_part%& is set for the
26333 router. Otherwise, only the domain is used, except when matching against a
26334 regular expression, when the local part of the address is replaced with &"*"&.
26335 A domain on its own can match a domain pattern, or a pattern that starts with
26336 &"*@"&. By default, &%retry_use_local_part%& is true for routers where
26337 &%check_local_user%& is true, and false for other routers.
26338
26339 Similarly, when Exim is looking for a retry rule after a local delivery has
26340 failed (for example, after a mailbox full error), each line in the retry
26341 configuration is tested against the complete address only if
26342 &%retry_use_local_part%& is set for the transport (it defaults true for all
26343 local transports).
26344
26345 .cindex "4&'xx'& responses" "retry rules for"
26346 However, when Exim is looking for a retry rule after a remote delivery attempt
26347 suffers an address error (a 4&'xx'& SMTP response for a recipient address), the
26348 whole address is always used as the key when searching the retry rules. The
26349 rule that is found is used to create a retry time for the combination of the
26350 failing address and the message's sender. It is the combination of sender and
26351 recipient that is delayed in subsequent queue runs until its retry time is
26352 reached. You can delay the recipient without regard to the sender by setting
26353 &%address_retry_include_sender%& false in the &(smtp)& transport but this can
26354 lead to problems with servers that regularly issue 4&'xx'& responses to RCPT
26355 commands.
26356
26357
26358
26359 .section "Choosing which retry rule to use for host and message errors" &&&
26360          "SECID160"
26361 For a temporary error that is not related to an individual address (for
26362 example, a connection timeout), each line in the retry configuration is checked
26363 twice. First, the name of the remote host is used as a domain name (preceded by
26364 &"*@"& when matching a regular expression). If this does not match the line,
26365 the domain from the email address is tried in a similar fashion. For example,
26366 suppose the MX records for &'a.b.c.example'& are
26367 .code
26368 a.b.c.example  MX  5  x.y.z.example
26369                MX  6  p.q.r.example
26370                MX  7  m.n.o.example
26371 .endd
26372 and the retry rules are
26373 .code
26374 p.q.r.example    *      F,24h,30m;
26375 a.b.c.example    *      F,4d,45m;
26376 .endd
26377 and a delivery to the host &'x.y.z.example'& suffers a connection failure. The
26378 first rule matches neither the host nor the domain, so Exim looks at the second
26379 rule. This does not match the host, but it does match the domain, so it is used
26380 to calculate the retry time for the host &'x.y.z.example'&. Meanwhile, Exim
26381 tries to deliver to &'p.q.r.example'&. If this also suffers a host error, the
26382 first retry rule is used, because it matches the host.
26383
26384 In other words, temporary failures to deliver to host &'p.q.r.example'& use the
26385 first rule to determine retry times, but for all the other hosts for the domain
26386 &'a.b.c.example'&, the second rule is used. The second rule is also used if
26387 routing to &'a.b.c.example'& suffers a temporary failure.
26388
26389 &*Note*&: The host name is used when matching the patterns, not its IP address.
26390 However, if a message is routed directly to an IP address without the use of a
26391 host name, for example, if a &(manualroute)& router contains a setting such as:
26392 .code
26393 route_list = *.a.example  192.168.34.23
26394 .endd
26395 then the &"host name"& that is used when searching for a retry rule is the
26396 textual form of the IP address.
26397
26398 .section "Retry rules for specific errors" "SECID161"
26399 .cindex "retry" "specific errors; specifying"
26400 The second field in a retry rule is the name of a particular error, or an
26401 asterisk, which matches any error. The errors that can be tested for are:
26402
26403 .vlist
26404 .vitem &%auth_failed%&
26405 Authentication failed when trying to send to a host in the
26406 &%hosts_require_auth%& list in an &(smtp)& transport.
26407
26408 .vitem &%data_4xx%&
26409 A 4&'xx'& error was received for an outgoing DATA command, either immediately
26410 after the command, or after sending the message's data.
26411
26412 .vitem &%mail_4xx%&
26413 A 4&'xx'& error was received for an outgoing MAIL command.
26414
26415 .vitem &%rcpt_4xx%&
26416 A 4&'xx'& error was received for an outgoing RCPT command.
26417 .endlist
26418
26419 For the three 4&'xx'& errors, either the first or both of the x's can be given
26420 as specific digits, for example: &`mail_45x`& or &`rcpt_436`&. For example, to
26421 recognize 452 errors given to RCPT commands for addresses in a certain domain,
26422 and have retries every ten minutes with a one-hour timeout, you could set up a
26423 retry rule of this form:
26424 .code
26425 the.domain.name  rcpt_452   F,1h,10m
26426 .endd
26427 These errors apply to both outgoing SMTP (the &(smtp)& transport) and outgoing
26428 LMTP (either the &(lmtp)& transport, or the &(smtp)& transport in LMTP mode).
26429
26430 .vlist
26431 .vitem &%lost_connection%&
26432 A server unexpectedly closed the SMTP connection. There may, of course,
26433 legitimate reasons for this (host died, network died), but if it repeats a lot
26434 for the same host, it indicates something odd.
26435
26436 .vitem &%lookup%&
26437 A DNS lookup for a host failed.
26438 Note that a &%dnslookup%& router will need to have matched
26439 its &%fail_defer_domains%& option for this retry type to be usable.
26440 Also note that a &%manualroute%& router will probably need
26441 its &%host_find_failed%& option set to &%defer%&.
26442
26443 .vitem &%refused_MX%&
26444 A connection to a host obtained from an MX record was refused.
26445
26446 .vitem &%refused_A%&
26447 A connection to a host not obtained from an MX record was refused.
26448
26449 .vitem &%refused%&
26450 A connection was refused.
26451
26452 .vitem &%timeout_connect_MX%&
26453 A connection attempt to a host obtained from an MX record timed out.
26454
26455 .vitem &%timeout_connect_A%&
26456 A connection attempt to a host not obtained from an MX record timed out.
26457
26458 .vitem &%timeout_connect%&
26459 A connection attempt timed out.
26460
26461 .vitem &%timeout_MX%&
26462 There was a timeout while connecting or during an SMTP session with a host
26463 obtained from an MX record.
26464
26465 .vitem &%timeout_A%&
26466 There was a timeout while connecting or during an SMTP session with a host not
26467 obtained from an MX record.
26468
26469 .vitem &%timeout%&
26470 There was a timeout while connecting or during an SMTP session.
26471
26472 .vitem &%tls_required%&
26473 The server was required to use TLS (it matched &%hosts_require_tls%& in the
26474 &(smtp)& transport), but either did not offer TLS, or it responded with 4&'xx'&
26475 to STARTTLS, or there was a problem setting up the TLS connection.
26476
26477 .vitem &%quota%&
26478 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
26479 transport.
26480
26481 .vitem &%quota_%&<&'time'&>
26482 .cindex "quota" "error testing in retry rule"
26483 .cindex "retry" "quota error testing"
26484 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
26485 transport, and the mailbox has not been accessed for <&'time'&>. For example,
26486 &'quota_4d'& applies to a quota error when the mailbox has not been accessed
26487 for four days.
26488 .endlist
26489
26490 .cindex "mailbox" "time of last read"
26491 The idea of &%quota_%&<&'time'&> is to make it possible to have shorter
26492 timeouts when the mailbox is full and is not being read by its owner. Ideally,
26493 it should be based on the last time that the user accessed the mailbox.
26494 However, it is not always possible to determine this. Exim uses the following
26495 heuristic rules:
26496
26497 .ilist
26498 If the mailbox is a single file, the time of last access (the &"atime"&) is
26499 used. As no new messages are being delivered (because the mailbox is over
26500 quota), Exim does not access the file, so this is the time of last user access.
26501 .next
26502 .cindex "maildir format" "time of last read"
26503 For a maildir delivery, the time of last modification of the &_new_&
26504 subdirectory is used. As the mailbox is over quota, no new files are created in
26505 the &_new_& subdirectory, because no new messages are being delivered. Any
26506 change to the &_new_& subdirectory is therefore assumed to be the result of an
26507 MUA moving a new message to the &_cur_& directory when it is first read. The
26508 time that is used is therefore the last time that the user read a new message.
26509 .next
26510 For other kinds of multi-file mailbox, the time of last access cannot be
26511 obtained, so a retry rule that uses this type of error field is never matched.
26512 .endlist
26513
26514 The quota errors apply both to system-enforced quotas and to Exim's own quota
26515 mechanism in the &(appendfile)& transport. The &'quota'& error also applies
26516 when a local delivery is deferred because a partition is full (the ENOSPC
26517 error).
26518
26519
26520
26521 .section "Retry rules for specified senders" "SECID162"
26522 .cindex "retry" "rules; sender-specific"
26523 You can specify retry rules that apply only when the failing message has a
26524 specific sender. In particular, this can be used to define retry rules that
26525 apply only to bounce messages. The third item in a retry rule can be of this
26526 form:
26527 .display
26528 &`senders=`&<&'address list'&>
26529 .endd
26530 The retry timings themselves are then the fourth item. For example:
26531 .code
26532 *   rcpt_4xx   senders=:   F,1h,30m
26533 .endd
26534 matches recipient 4&'xx'& errors for bounce messages sent to any address at any
26535 host. If the address list contains white space, it must be enclosed in quotes.
26536 For example:
26537 .code
26538 a.domain  rcpt_452  senders="xb.dom : yc.dom"  G,8h,10m,1.5
26539 .endd
26540 &*Warning*&: This facility can be unhelpful if it is used for host errors
26541 (which do not depend on the recipient). The reason is that the sender is used
26542 only to match the retry rule. Once the rule has been found for a host error,
26543 its contents are used to set a retry time for the host, and this will apply to
26544 all messages, not just those with specific senders.
26545
26546 When testing retry rules using &%-brt%&, you can supply a sender using the
26547 &%-f%& command line option, like this:
26548 .code
26549 exim -f "" -brt user@dom.ain
26550 .endd
26551 If you do not set &%-f%& with &%-brt%&, a retry rule that contains a senders
26552 list is never matched.
26553
26554
26555
26556
26557
26558 .section "Retry parameters" "SECID163"
26559 .cindex "retry" "parameters in rules"
26560 The third (or fourth, if a senders list is present) field in a retry rule is a
26561 sequence of retry parameter sets, separated by semicolons. Each set consists of
26562 .display
26563 <&'letter'&>,<&'cutoff time'&>,<&'arguments'&>
26564 .endd
26565 The letter identifies the algorithm for computing a new retry time; the cutoff
26566 time is the time beyond which this algorithm no longer applies, and the
26567 arguments vary the algorithm's action. The cutoff time is measured from the
26568 time that the first failure for the domain (combined with the local part if
26569 relevant) was detected, not from the time the message was received.
26570
26571 .cindex "retry" "algorithms"
26572 .cindex "retry" "fixed intervals"
26573 .cindex "retry" "increasing intervals"
26574 .cindex "retry" "random intervals"
26575 The available algorithms are:
26576
26577 .ilist
26578 &'F'&: retry at fixed intervals. There is a single time parameter specifying
26579 the interval.
26580 .next
26581 &'G'&: retry at geometrically increasing intervals. The first argument
26582 specifies a starting value for the interval, and the second a multiplier, which
26583 is used to increase the size of the interval at each retry.
26584 .next
26585 &'H'&: retry at randomized intervals. The arguments are as for &'G'&. For each
26586 retry, the previous interval is multiplied by the factor in order to get a
26587 maximum for the next interval. The minimum interval is the first argument of
26588 the parameter, and an actual interval is chosen randomly between them. Such a
26589 rule has been found to be helpful in cluster configurations when all the
26590 members of the cluster restart at once, and may therefore synchronize their
26591 queue processing times.
26592 .endlist
26593
26594 When computing the next retry time, the algorithm definitions are scanned in
26595 order until one whose cutoff time has not yet passed is reached. This is then
26596 used to compute a new retry time that is later than the current time. In the
26597 case of fixed interval retries, this simply means adding the interval to the
26598 current time. For geometrically increasing intervals, retry intervals are
26599 computed from the rule's parameters until one that is greater than the previous
26600 interval is found. The main configuration variable
26601 .cindex "limit" "retry interval"
26602 .cindex "retry" "interval, maximum"
26603 .oindex "&%retry_interval_max%&"
26604 &%retry_interval_max%& limits the maximum interval between retries. It
26605 cannot be set greater than &`24h`&, which is its default value.
26606
26607 A single remote domain may have a number of hosts associated with it, and each
26608 host may have more than one IP address. Retry algorithms are selected on the
26609 basis of the domain name, but are applied to each IP address independently. If,
26610 for example, a host has two IP addresses and one is unusable, Exim will
26611 generate retry times for it and will not try to use it until its next retry
26612 time comes. Thus the good IP address is likely to be tried first most of the
26613 time.
26614
26615 .cindex "hints database" "use for retrying"
26616 Retry times are hints rather than promises. Exim does not make any attempt to
26617 run deliveries exactly at the computed times. Instead, a queue runner process
26618 starts delivery processes for delayed messages periodically, and these attempt
26619 new deliveries only for those addresses that have passed their next retry time.
26620 If a new message arrives for a deferred address, an immediate delivery attempt
26621 occurs only if the address has passed its retry time. In the absence of new
26622 messages, the minimum time between retries is the interval between queue runner
26623 processes. There is not much point in setting retry times of five minutes if
26624 your queue runners happen only once an hour, unless there are a significant
26625 number of incoming messages (which might be the case on a system that is
26626 sending everything to a smart host, for example).
26627
26628 The data in the retry hints database can be inspected by using the
26629 &'exim_dumpdb'& or &'exim_fixdb'& utility programs (see chapter
26630 &<<CHAPutils>>&). The latter utility can also be used to change the data. The
26631 &'exinext'& utility script can be used to find out what the next retry times
26632 are for the hosts associated with a particular mail domain, and also for local
26633 deliveries that have been deferred.
26634
26635
26636 .section "Retry rule examples" "SECID164"
26637 Here are some example retry rules:
26638 .code
26639 alice@wonderland.fict.example quota_5d  F,7d,3h
26640 wonderland.fict.example       quota_5d
26641 wonderland.fict.example       *         F,1h,15m; G,2d,1h,2;
26642 lookingglass.fict.example     *         F,24h,30m;
26643 *                 refused_A   F,2h,20m;
26644 *                 *           F,2h,15m; G,16h,1h,1.5; F,5d,8h
26645 .endd
26646 The first rule sets up special handling for mail to
26647 &'alice@wonderland.fict.example'& when there is an over-quota error and the
26648 mailbox has not been read for at least 5 days. Retries continue every three
26649 hours for 7 days. The second rule handles over-quota errors for all other local
26650 parts at &'wonderland.fict.example'&; the absence of a local part has the same
26651 effect as supplying &"*@"&. As no retry algorithms are supplied, messages that
26652 fail are bounced immediately if the mailbox has not been read for at least 5
26653 days.
26654
26655 The third rule handles all other errors at &'wonderland.fict.example'&; retries
26656 happen every 15 minutes for an hour, then with geometrically increasing
26657 intervals until two days have passed since a delivery first failed. After the
26658 first hour there is a delay of one hour, then two hours, then four hours, and
26659 so on (this is a rather extreme example).
26660
26661 The fourth rule controls retries for the domain &'lookingglass.fict.example'&.
26662 They happen every 30 minutes for 24 hours only. The remaining two rules handle
26663 all other domains, with special action for connection refusal from hosts that
26664 were not obtained from an MX record.
26665
26666 The final rule in a retry configuration should always have asterisks in the
26667 first two fields so as to provide a general catch-all for any addresses that do
26668 not have their own special handling. This example tries every 15 minutes for 2
26669 hours, then with intervals starting at one hour and increasing by a factor of
26670 1.5 up to 16 hours, then every 8 hours up to 5 days.
26671
26672
26673
26674 .section "Timeout of retry data" "SECID165"
26675 .cindex "timeout" "of retry data"
26676 .oindex "&%retry_data_expire%&"
26677 .cindex "hints database" "data expiry"
26678 .cindex "retry" "timeout of data"
26679 Exim timestamps the data that it writes to its retry hints database. When it
26680 consults the data during a delivery it ignores any that is older than the value
26681 set in &%retry_data_expire%& (default 7 days). If, for example, a host hasn't
26682 been tried for 7 days, Exim will try to deliver to it immediately a message
26683 arrives, and if that fails, it will calculate a retry time as if it were
26684 failing for the first time.
26685
26686 This improves the behaviour for messages routed to rarely-used hosts such as MX
26687 backups. If such a host was down at one time, and happens to be down again when
26688 Exim tries a month later, using the old retry data would imply that it had been
26689 down all the time, which is not a justified assumption.
26690
26691 If a host really is permanently dead, this behaviour causes a burst of retries
26692 every now and again, but only if messages routed to it are rare. If there is a
26693 message at least once every 7 days the retry data never expires.
26694
26695
26696
26697
26698 .section "Long-term failures" "SECID166"
26699 .cindex "delivery failure, long-term"
26700 .cindex "retry" "after long-term failure"
26701 Special processing happens when an email address has been failing for so long
26702 that the cutoff time for the last algorithm is reached. For example, using the
26703 default retry rule:
26704 .code
26705 * * F,2h,15m; G,16h,1h,1.5; F,4d,6h
26706 .endd
26707 the cutoff time is four days. Reaching the retry cutoff is independent of how
26708 long any specific message has been failing; it is the length of continuous
26709 failure for the recipient address that counts.
26710
26711 When the cutoff time is reached for a local delivery, or for all the IP
26712 addresses associated with a remote delivery, a subsequent delivery failure
26713 causes Exim to give up on the address, and a bounce message is generated.
26714 In order to cater for new messages that use the failing address, a next retry
26715 time is still computed from the final algorithm, and is used as follows:
26716
26717 For local deliveries, one delivery attempt is always made for any subsequent
26718 messages. If this delivery fails, the address fails immediately. The
26719 post-cutoff retry time is not used.
26720
26721 .cindex "final cutoff" "retries, controlling"
26722 .cindex retry "final cutoff"
26723 If the delivery is remote, there are two possibilities, controlled by the
26724 .oindex "&%delay_after_cutoff%&"
26725 &%delay_after_cutoff%& option of the &(smtp)& transport. The option is true by
26726 default. Until the post-cutoff retry time for one of the IP addresses,
26727 as set by the &%retry_data_expire%& option, is
26728 reached, the failing email address is bounced immediately, without a delivery
26729 attempt taking place. After that time, one new delivery attempt is made to
26730 those IP addresses that are past their retry times, and if that still fails,
26731 the address is bounced and new retry times are computed.
26732
26733 In other words, when all the hosts for a given email address have been failing
26734 for a long time, Exim bounces rather then defers until one of the hosts' retry
26735 times is reached. Then it tries once, and bounces if that attempt fails. This
26736 behaviour ensures that few resources are wasted in repeatedly trying to deliver
26737 to a broken destination, but if the host does recover, Exim will eventually
26738 notice.
26739
26740 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
26741 addresses are past their final cutoff time, Exim tries to deliver to those IP
26742 addresses that have not been tried since the message arrived. If there are
26743 no suitable IP addresses, or if they all fail, the address is bounced. In other
26744 words, it does not delay when a new message arrives, but tries the expired
26745 addresses immediately, unless they have been tried since the message arrived.
26746 If there is a continuous stream of messages for the failing domains, setting
26747 &%delay_after_cutoff%& false means that there will be many more attempts to
26748 deliver to permanently failing IP addresses than when &%delay_after_cutoff%& is
26749 true.
26750
26751 .section "Deliveries that work intermittently" "SECID167"
26752 .cindex "retry" "intermittently working deliveries"
26753 Some additional logic is needed to cope with cases where a host is
26754 intermittently available, or when a message has some attribute that prevents
26755 its delivery when others to the same address get through. In this situation,
26756 because some messages are successfully delivered, the &"retry clock"& for the
26757 host or address keeps getting reset by the successful deliveries, and so
26758 failing messages remain in the queue for ever because the cutoff time is never
26759 reached.
26760
26761 Two exceptional actions are applied to prevent this happening. The first
26762 applies to errors that are related to a message rather than a remote host.
26763 Section &<<SECToutSMTPerr>>& has a discussion of the different kinds of error;
26764 examples of message-related errors are 4&'xx'& responses to MAIL or DATA
26765 commands, and quota failures. For this type of error, if a message's arrival
26766 time is earlier than the &"first failed"& time for the error, the earlier time
26767 is used when scanning the retry rules to decide when to try next and when to
26768 time out the address.
26769
26770 The exceptional second action applies in all cases. If a message has been on
26771 the queue for longer than the cutoff time of any applicable retry rule for a
26772 given address, a delivery is attempted for that address, even if it is not yet
26773 time, and if this delivery fails, the address is timed out. A new retry time is
26774 not computed in this case, so that other messages for the same address are
26775 considered immediately.
26776 .ecindex IIDretconf1
26777 .ecindex IIDregconf2
26778
26779
26780
26781
26782
26783
26784 . ////////////////////////////////////////////////////////////////////////////
26785 . ////////////////////////////////////////////////////////////////////////////
26786
26787 .chapter "SMTP authentication" "CHAPSMTPAUTH"
26788 .scindex IIDauthconf1 "SMTP" "authentication configuration"
26789 .scindex IIDauthconf2 "authentication"
26790 The &"authenticators"& section of Exim's runtime configuration is concerned
26791 with SMTP authentication. This facility is an extension to the SMTP protocol,
26792 described in RFC 2554, which allows a client SMTP host to authenticate itself
26793 to a server. This is a common way for a server to recognize clients that are
26794 permitted to use it as a relay. SMTP authentication is not of relevance to the
26795 transfer of mail between servers that have no managerial connection with each
26796 other.
26797
26798 .cindex "AUTH" "description of"
26799 .cindex "ESMTP extensions" AUTH
26800 Very briefly, the way SMTP authentication works is as follows:
26801
26802 .ilist
26803 The server advertises a number of authentication &'mechanisms'& in response to
26804 the client's EHLO command.
26805 .next
26806 The client issues an AUTH command, naming a specific mechanism. The command
26807 may, optionally, contain some authentication data.
26808 .next
26809 The server may issue one or more &'challenges'&, to which the client must send
26810 appropriate responses. In simple authentication mechanisms, the challenges are
26811 just prompts for user names and passwords. The server does not have to issue
26812 any challenges &-- in some mechanisms the relevant data may all be transmitted
26813 with the AUTH command.
26814 .next
26815 The server either accepts or denies authentication.
26816 .next
26817 If authentication succeeds, the client may optionally make use of the AUTH
26818 option on the MAIL command to pass an authenticated sender in subsequent
26819 mail transactions. Authentication lasts for the remainder of the SMTP
26820 connection.
26821 .next
26822 If authentication fails, the client may give up, or it may try a different
26823 authentication mechanism, or it may try transferring mail over the
26824 unauthenticated connection.
26825 .endlist
26826
26827 If you are setting up a client, and want to know which authentication
26828 mechanisms the server supports, you can use Telnet to connect to port 25 (the
26829 SMTP port) on the server, and issue an EHLO command. The response to this
26830 includes the list of supported mechanisms. For example:
26831 .display
26832 &`$ `&&*&`telnet server.example 25`&*&
26833 &`Trying 192.168.34.25...`&
26834 &`Connected to server.example.`&
26835 &`Escape character is &#x0027;^]&#x0027;.`&
26836 &`220 server.example ESMTP Exim 4.20 ...`&
26837 &*&`ehlo client.example`&*&
26838 &`250-server.example Hello client.example [10.8.4.5]`&
26839 &`250-SIZE 52428800`&
26840 &`250-PIPELINING`&
26841 &`250-AUTH PLAIN`&
26842 &`250 HELP`&
26843 .endd
26844 The second-last line of this example output shows that the server supports
26845 authentication using the PLAIN mechanism. In Exim, the different authentication
26846 mechanisms are configured by specifying &'authenticator'& drivers. Like the
26847 routers and transports, which authenticators are included in the binary is
26848 controlled by build-time definitions. The following are currently available,
26849 included by setting
26850 .code
26851 AUTH_CRAM_MD5=yes
26852 AUTH_CYRUS_SASL=yes
26853 AUTH_DOVECOT=yes
26854 AUTH_EXTERNAL=yes
26855 AUTH_GSASL=yes
26856 AUTH_HEIMDAL_GSSAPI=yes
26857 AUTH_PLAINTEXT=yes
26858 AUTH_SPA=yes
26859 AUTH_TLS=yes
26860 .endd
26861 in &_Local/Makefile_&, respectively. The first of these supports the CRAM-MD5
26862 authentication mechanism (RFC 2195), and the second provides an interface to
26863 the Cyrus SASL authentication library.
26864 The third is an interface to Dovecot's authentication system, delegating the
26865 work via a socket interface.
26866 The fourth provides for negotiation of authentication done via non-SMTP means,
26867 as defined by RFC 4422 Appendix A.
26868 The fifth provides an interface to the GNU SASL authentication library, which
26869 provides mechanisms but typically not data sources.
26870 The sixth provides direct access to Heimdal GSSAPI, geared for Kerberos, but
26871 supporting setting a server keytab.
26872 The seventh can be configured to support
26873 the PLAIN authentication mechanism (RFC 2595) or the LOGIN mechanism, which is
26874 not formally documented, but used by several MUAs.
26875 The eighth authenticator
26876 supports Microsoft's &'Secure Password Authentication'& mechanism.
26877 The last is an Exim authenticator but not an SMTP one;
26878 instead it can use information from a TLS negotiation.
26879
26880 The authenticators are configured using the same syntax as other drivers (see
26881 section &<<SECTfordricon>>&). If no authenticators are required, no
26882 authentication section need be present in the configuration file. Each
26883 authenticator can in principle have both server and client functions. When Exim
26884 is receiving SMTP mail, it is acting as a server; when it is sending out
26885 messages over SMTP, it is acting as a client. Authenticator configuration
26886 options are provided for use in both these circumstances.
26887
26888 To make it clear which options apply to which situation, the prefixes
26889 &%server_%& and &%client_%& are used on option names that are specific to
26890 either the server or the client function, respectively. Server and client
26891 functions are disabled if none of their options are set. If an authenticator is
26892 to be used for both server and client functions, a single definition, using
26893 both sets of options, is required. For example:
26894 .code
26895 cram:
26896   driver = cram_md5
26897   public_name = CRAM-MD5
26898   server_secret = ${if eq{$auth1}{ph10}{secret1}fail}
26899   client_name = ph10
26900   client_secret = secret2
26901 .endd
26902 The &%server_%& option is used when Exim is acting as a server, and the
26903 &%client_%& options when it is acting as a client.
26904
26905 Descriptions of the individual authenticators are given in subsequent chapters.
26906 The remainder of this chapter covers the generic options for the
26907 authenticators, followed by general discussion of the way authentication works
26908 in Exim.
26909
26910 &*Beware:*& the meaning of &$auth1$&, &$auth2$&, ... varies on a per-driver and
26911 per-mechanism basis.  Please read carefully to determine which variables hold
26912 account labels such as usercodes and which hold passwords or other
26913 authenticating data.
26914
26915 Note that some mechanisms support two different identifiers for accounts: the
26916 &'authentication id'& and the &'authorization id'&.  The contractions &'authn'&
26917 and &'authz'& are commonly encountered.  The American spelling is standard here.
26918 Conceptually, authentication data such as passwords are tied to the identifier
26919 used to authenticate; servers may have rules to permit one user to act as a
26920 second user, so that after login the session is treated as though that second
26921 user had logged in.  That second user is the &'authorization id'&.  A robust
26922 configuration might confirm that the &'authz'& field is empty or matches the
26923 &'authn'& field.  Often this is just ignored.  The &'authn'& can be considered
26924 as verified data, the &'authz'& as an unverified request which the server might
26925 choose to honour.
26926
26927 A &'realm'& is a text string, typically a domain name, presented by a server
26928 to a client to help it select an account and credentials to use.  In some
26929 mechanisms, the client and server provably agree on the realm, but clients
26930 typically can not treat the realm as secure data to be blindly trusted.
26931
26932
26933
26934 .section "Generic options for authenticators" "SECID168"
26935 .cindex "authentication" "generic options"
26936 .cindex "options" "generic; for authenticators"
26937
26938 .option client_condition authenticators string&!! unset
26939 When Exim is authenticating as a client, it skips any authenticator whose
26940 &%client_condition%& expansion yields &"0"&, &"no"&, or &"false"&. This can be
26941 used, for example, to skip plain text authenticators when the connection is not
26942 encrypted by a setting such as:
26943 .code
26944 client_condition = ${if !eq{$tls_out_cipher}{}}
26945 .endd
26946
26947
26948 .option client_set_id authenticators string&!! unset
26949 When client authentication succeeds, this condition is expanded; the
26950 result is used in the log lines for outbound messages.
26951 Typically it will be the user name used for authentication.
26952
26953
26954 .option driver authenticators string unset
26955 This option must always be set. It specifies which of the available
26956 authenticators is to be used.
26957
26958
26959 .option public_name authenticators string unset
26960 This option specifies the name of the authentication mechanism that the driver
26961 implements, and by which it is known to the outside world. These names should
26962 contain only upper case letters, digits, underscores, and hyphens (RFC 2222),
26963 but Exim in fact matches them caselessly. If &%public_name%& is not set, it
26964 defaults to the driver's instance name.
26965
26966
26967 .option server_advertise_condition authenticators string&!! unset
26968 When a server is about to advertise an authentication mechanism, the condition
26969 is expanded. If it yields the empty string, &"0"&, &"no"&, or &"false"&, the
26970 mechanism is not advertised.
26971 If the expansion fails, the mechanism is not advertised. If the failure was not
26972 forced, and was not caused by a lookup defer, the incident is logged.
26973 See section &<<SECTauthexiser>>& below for further discussion.
26974
26975
26976 .option server_condition authenticators string&!! unset
26977 This option must be set for a &%plaintext%& server authenticator, where it
26978 is used directly to control authentication. See section &<<SECTplainserver>>&
26979 for details.
26980
26981 For the &(gsasl)& authenticator, this option is required for various
26982 mechanisms; see chapter &<<CHAPgsasl>>& for details.
26983
26984 For the other authenticators, &%server_condition%& can be used as an additional
26985 authentication or authorization mechanism that is applied after the other
26986 authenticator conditions succeed. If it is set, it is expanded when the
26987 authenticator would otherwise return a success code. If the expansion is forced
26988 to fail, authentication fails. Any other expansion failure causes a temporary
26989 error code to be returned. If the result of a successful expansion is an empty
26990 string, &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
26991 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds. For any
26992 other result, a temporary error code is returned, with the expanded string as
26993 the error text.
26994
26995
26996 .option server_debug_print authenticators string&!! unset
26997 If this option is set and authentication debugging is enabled (see the &%-d%&
26998 command line option), the string is expanded and included in the debugging
26999 output when the authenticator is run as a server. This can help with checking
27000 out the values of variables.
27001 If expansion of the string fails, the error message is written to the debugging
27002 output, and Exim carries on processing.
27003
27004
27005 .option server_set_id authenticators string&!! unset
27006 .vindex "&$authenticated_id$&"
27007 .vindex "&$authenticated_fail_id$&"
27008 When an Exim server successfully authenticates a client, this string is
27009 expanded using data from the authentication, and preserved for any incoming
27010 messages in the variable &$authenticated_id$&. It is also included in the log
27011 lines for incoming messages. For example, a user/password authenticator
27012 configuration might preserve the user name that was used to authenticate, and
27013 refer to it subsequently during delivery of the message.
27014 On a failing authentication the expansion result is instead saved in
27015 the &$authenticated_fail_id$& variable.
27016 If expansion fails, the option is ignored.
27017
27018
27019 .option server_mail_auth_condition authenticators string&!! unset
27020 This option allows a server to discard authenticated sender addresses supplied
27021 as part of MAIL commands in SMTP connections that are authenticated by the
27022 driver on which &%server_mail_auth_condition%& is set. The option is not used
27023 as part of the authentication process; instead its (unexpanded) value is
27024 remembered for later use.
27025 How it is used is described in the following section.
27026
27027
27028
27029
27030
27031 .section "The AUTH parameter on MAIL commands" "SECTauthparamail"
27032 .cindex "authentication" "sender; authenticated"
27033 .cindex "AUTH" "on MAIL command"
27034 When a client supplied an AUTH= item on a MAIL command, Exim applies
27035 the following checks before accepting it as the authenticated sender of the
27036 message:
27037
27038 .ilist
27039 If the connection is not using extended SMTP (that is, HELO was used rather
27040 than EHLO), the use of AUTH= is a syntax error.
27041 .next
27042 If the value of the AUTH= parameter is &"<>"&, it is ignored.
27043 .next
27044 .vindex "&$authenticated_sender$&"
27045 If &%acl_smtp_mailauth%& is defined, the ACL it specifies is run. While it is
27046 running, the value of &$authenticated_sender$& is set to the value obtained
27047 from the AUTH= parameter. If the ACL does not yield &"accept"&, the value of
27048 &$authenticated_sender$& is deleted. The &%acl_smtp_mailauth%& ACL may not
27049 return &"drop"& or &"discard"&. If it defers, a temporary error code (451) is
27050 given for the MAIL command.
27051 .next
27052 If &%acl_smtp_mailauth%& is not defined, the value of the AUTH= parameter
27053 is accepted and placed in &$authenticated_sender$& only if the client has
27054 authenticated.
27055 .next
27056 If the AUTH= value was accepted by either of the two previous rules, and
27057 the client has authenticated, and the authenticator has a setting for the
27058 &%server_mail_auth_condition%&, the condition is checked at this point. The
27059 valued that was saved from the authenticator is expanded. If the expansion
27060 fails, or yields an empty string, &"0"&, &"no"&, or &"false"&, the value of
27061 &$authenticated_sender$& is deleted. If the expansion yields any other value,
27062 the value of &$authenticated_sender$& is retained and passed on with the
27063 message.
27064 .endlist
27065
27066
27067 When &$authenticated_sender$& is set for a message, it is passed on to other
27068 hosts to which Exim authenticates as a client. Do not confuse this value with
27069 &$authenticated_id$&, which is a string obtained from the authentication
27070 process, and which is not usually a complete email address.
27071
27072 .vindex "&$sender_address$&"
27073 Whenever an AUTH= value is ignored, the incident is logged. The ACL for
27074 MAIL, if defined, is run after AUTH= is accepted or ignored. It can
27075 therefore make use of &$authenticated_sender$&. The converse is not true: the
27076 value of &$sender_address$& is not yet set up when the &%acl_smtp_mailauth%&
27077 ACL is run.
27078
27079
27080
27081 .section "Authentication on an Exim server" "SECTauthexiser"
27082 .cindex "authentication" "on an Exim server"
27083 When Exim receives an EHLO command, it advertises the public names of those
27084 authenticators that are configured as servers, subject to the following
27085 conditions:
27086
27087 .ilist
27088 The client host must match &%auth_advertise_hosts%& (default *).
27089 .next
27090 It the &%server_advertise_condition%& option is set, its expansion must not
27091 yield the empty string, &"0"&, &"no"&, or &"false"&.
27092 .endlist
27093
27094 The order in which the authenticators are defined controls the order in which
27095 the mechanisms are advertised.
27096
27097 Some mail clients (for example, some versions of Netscape) require the user to
27098 provide a name and password for authentication whenever AUTH is advertised,
27099 even though authentication may not in fact be needed (for example, Exim may be
27100 set up to allow unconditional relaying from the client by an IP address check).
27101 You can make such clients more friendly by not advertising AUTH to them.
27102 For example, if clients on the 10.9.8.0/24 network are permitted (by the ACL
27103 that runs for RCPT) to relay without authentication, you should set
27104 .code
27105 auth_advertise_hosts = ! 10.9.8.0/24
27106 .endd
27107 so that no authentication mechanisms are advertised to them.
27108
27109 The &%server_advertise_condition%& controls the advertisement of individual
27110 authentication mechanisms. For example, it can be used to restrict the
27111 advertisement of a particular mechanism to encrypted connections, by a setting
27112 such as:
27113 .code
27114 server_advertise_condition = ${if eq{$tls_in_cipher}{}{no}{yes}}
27115 .endd
27116 .vindex "&$tls_in_cipher$&"
27117 If the session is encrypted, &$tls_in_cipher$& is not empty, and so the expansion
27118 yields &"yes"&, which allows the advertisement to happen.
27119
27120 When an Exim server receives an AUTH command from a client, it rejects it
27121 immediately if AUTH was not advertised in response to an earlier EHLO
27122 command. This is the case if
27123
27124 .ilist
27125 The client host does not match &%auth_advertise_hosts%&; or
27126 .next
27127 No authenticators are configured with server options; or
27128 .next
27129 Expansion of &%server_advertise_condition%& blocked the advertising of all the
27130 server authenticators.
27131 .endlist
27132
27133
27134 Otherwise, Exim runs the ACL specified by &%acl_smtp_auth%& in order
27135 to decide whether to accept the command. If &%acl_smtp_auth%& is not set,
27136 AUTH is accepted from any client host.
27137
27138 If AUTH is not rejected by the ACL, Exim searches its configuration for a
27139 server authentication mechanism that was advertised in response to EHLO and
27140 that matches the one named in the AUTH command. If it finds one, it runs
27141 the appropriate authentication protocol, and authentication either succeeds or
27142 fails. If there is no matching advertised mechanism, the AUTH command is
27143 rejected with a 504 error.
27144
27145 .vindex "&$received_protocol$&"
27146 .vindex "&$sender_host_authenticated$&"
27147 When a message is received from an authenticated host, the value of
27148 &$received_protocol$& is set to &"esmtpa"& or &"esmtpsa"& instead of &"esmtp"&
27149 or &"esmtps"&, and &$sender_host_authenticated$& contains the name (not the
27150 public name) of the authenticator driver that successfully authenticated the
27151 client from which the message was received. This variable is empty if there was
27152 no successful authentication.
27153
27154 .cindex authentication "expansion item"
27155 Successful authentication sets up information used by the
27156 &%authresults%& expansion item.
27157
27158
27159
27160
27161 .section "Testing server authentication" "SECID169"
27162 .cindex "authentication" "testing a server"
27163 .cindex "AUTH" "testing a server"
27164 .cindex "base64 encoding" "creating authentication test data"
27165 Exim's &%-bh%& option can be useful for testing server authentication
27166 configurations. The data for the AUTH command has to be sent using base64
27167 encoding. A quick way to produce such data for testing is the following Perl
27168 script:
27169 .code
27170 use MIME::Base64;
27171 printf ("%s", encode_base64(eval "\"$ARGV[0]\""));
27172 .endd
27173 .cindex "binary zero" "in authentication data"
27174 This interprets its argument as a Perl string, and then encodes it. The
27175 interpretation as a Perl string allows binary zeros, which are required for
27176 some kinds of authentication, to be included in the data. For example, a
27177 command line to run this script on such data might be
27178 .code
27179 encode '\0user\0password'
27180 .endd
27181 Note the use of single quotes to prevent the shell interpreting the
27182 backslashes, so that they can be interpreted by Perl to specify characters
27183 whose code value is zero.
27184
27185 &*Warning 1*&: If either of the user or password strings starts with an octal
27186 digit, you must use three zeros instead of one after the leading backslash. If
27187 you do not, the octal digit that starts your string will be incorrectly
27188 interpreted as part of the code for the first character.
27189
27190 &*Warning 2*&: If there are characters in the strings that Perl interprets
27191 specially, you must use a Perl escape to prevent them being misinterpreted. For
27192 example, a command such as
27193 .code
27194 encode '\0user@domain.com\0pas$$word'
27195 .endd
27196 gives an incorrect answer because of the unescaped &"@"& and &"$"& characters.
27197
27198 If you have the &%mimencode%& command installed, another way to do produce
27199 base64-encoded strings is to run the command
27200 .code
27201 echo -e -n `\0user\0password' | mimencode
27202 .endd
27203 The &%-e%& option of &%echo%& enables the interpretation of backslash escapes
27204 in the argument, and the &%-n%& option specifies no newline at the end of its
27205 output. However, not all versions of &%echo%& recognize these options, so you
27206 should check your version before relying on this suggestion.
27207
27208
27209
27210 .section "Authentication by an Exim client" "SECID170"
27211 .cindex "authentication" "on an Exim client"
27212 The &(smtp)& transport has two options called &%hosts_require_auth%& and
27213 &%hosts_try_auth%&. When the &(smtp)& transport connects to a server that
27214 announces support for authentication, and the host matches an entry in either
27215 of these options, Exim (as a client) tries to authenticate as follows:
27216
27217 .ilist
27218 For each authenticator that is configured as a client, in the order in which
27219 they are defined in the configuration, it searches the authentication
27220 mechanisms announced by the server for one whose name matches the public name
27221 of the authenticator.
27222 .next
27223 .vindex "&$host$&"
27224 .vindex "&$host_address$&"
27225 When it finds one that matches, it runs the authenticator's client code. The
27226 variables &$host$& and &$host_address$& are available for any string expansions
27227 that the client might do. They are set to the server's name and IP address. If
27228 any expansion is forced to fail, the authentication attempt is abandoned, and
27229 Exim moves on to the next authenticator. Otherwise an expansion failure causes
27230 delivery to be deferred.
27231 .next
27232 If the result of the authentication attempt is a temporary error or a timeout,
27233 Exim abandons trying to send the message to the host for the moment. It will
27234 try again later. If there are any backup hosts available, they are tried in the
27235 usual way.
27236 .next
27237 If the response to authentication is a permanent error (5&'xx'& code), Exim
27238 carries on searching the list of authenticators and tries another one if
27239 possible. If all authentication attempts give permanent errors, or if there are
27240 no attempts because no mechanisms match (or option expansions force failure),
27241 what happens depends on whether the host matches &%hosts_require_auth%& or
27242 &%hosts_try_auth%&. In the first case, a temporary error is generated, and
27243 delivery is deferred. The error can be detected in the retry rules, and thereby
27244 turned into a permanent error if you wish. In the second case, Exim tries to
27245 deliver the message unauthenticated.
27246 .endlist
27247
27248 Note that the hostlist test for whether to do authentication can be
27249 confused if name-IP lookups change between the time the peer is decided
27250 upon and the time that the transport runs.  For example, with a manualroute
27251 router given a host name, and with DNS "round-robin" used by that name: if
27252 the local resolver cache times out between the router and the transport
27253 running, the transport may get an IP for the name for its authentication
27254 check which does not match the connection peer IP.
27255 No authentication will then be done, despite the names being identical.
27256
27257 For such cases use a separate transport which always authenticates.
27258
27259 .cindex "AUTH" "on MAIL command"
27260 When Exim has authenticated itself to a remote server, it adds the AUTH
27261 parameter to the MAIL commands it sends, if it has an authenticated sender for
27262 the message. If the message came from a remote host, the authenticated sender
27263 is the one that was receiving on an incoming MAIL command, provided that the
27264 incoming connection was authenticated and the &%server_mail_auth%& condition
27265 allowed the authenticated sender to be retained. If a local process calls Exim
27266 to send a message, the sender address that is built from the login name and
27267 &%qualify_domain%& is treated as authenticated. However, if the
27268 &%authenticated_sender%& option is set on the &(smtp)& transport, it overrides
27269 the authenticated sender that was received with the message.
27270 .ecindex IIDauthconf1
27271 .ecindex IIDauthconf2
27272
27273
27274
27275
27276
27277
27278 . ////////////////////////////////////////////////////////////////////////////
27279 . ////////////////////////////////////////////////////////////////////////////
27280
27281 .chapter "The plaintext authenticator" "CHAPplaintext"
27282 .scindex IIDplaiauth1 "&(plaintext)& authenticator"
27283 .scindex IIDplaiauth2 "authenticators" "&(plaintext)&"
27284 The &(plaintext)& authenticator can be configured to support the PLAIN and
27285 LOGIN authentication mechanisms, both of which transfer authentication data as
27286 plain (unencrypted) text (though base64 encoded). The use of plain text is a
27287 security risk; you are strongly advised to insist on the use of SMTP encryption
27288 (see chapter &<<CHAPTLS>>&) if you use the PLAIN or LOGIN mechanisms. If you do
27289 use unencrypted plain text, you should not use the same passwords for SMTP
27290 connections as you do for login accounts.
27291
27292 .section "Avoiding cleartext use" "SECTplain_TLS"
27293 The following generic option settings will disable &(plaintext)& authenticators when
27294 TLS is not being used:
27295 .code
27296   server_advertise_condition = ${if def:tls_in_cipher }
27297   client_condition =           ${if def:tls_out_cipher}
27298 .endd
27299
27300 &*Note*&: a plaintext SMTP AUTH done inside TLS is not vulnerable to casual snooping,
27301 but is still vulnerable to a Man In The Middle attack unless certificates
27302 (including their names) have been properly verified.
27303
27304 .section "Plaintext server options" "SECID171"
27305 .cindex "options" "&(plaintext)& authenticator (server)"
27306 When configured as a server, &(plaintext)& uses the following options:
27307
27308 .option server_condition authenticators string&!! unset
27309 This is actually a global authentication option, but it must be set in order to
27310 configure the &(plaintext)& driver as a server. Its use is described below.
27311
27312 .option server_prompts plaintext "string list&!!" unset
27313 The contents of this option, after expansion, must be a colon-separated list of
27314 prompt strings. If expansion fails, a temporary authentication rejection is
27315 given.
27316
27317 .section "Using plaintext in a server" "SECTplainserver"
27318 .cindex "AUTH" "in &(plaintext)& authenticator"
27319 .cindex "binary zero" "in &(plaintext)& authenticator"
27320 .cindex "numerical variables (&$1$& &$2$& etc)" &&&
27321         "in &(plaintext)& authenticator"
27322 .vindex "&$auth1$&, &$auth2$&, etc"
27323 .cindex "base64 encoding" "in &(plaintext)& authenticator"
27324
27325 When running as a server, &(plaintext)& performs the authentication test by
27326 expanding a string. The data sent by the client with the AUTH command, or in
27327 response to subsequent prompts, is base64 encoded, and so may contain any byte
27328 values when decoded. If any data is supplied with the command, it is treated as
27329 a list of strings, separated by NULs (binary zeros), the first three of which
27330 are placed in the expansion variables &$auth1$&, &$auth2$&, and &$auth3$&
27331 (neither LOGIN nor PLAIN uses more than three strings).
27332
27333 For compatibility with previous releases of Exim, the values are also placed in
27334 the expansion variables &$1$&, &$2$&, and &$3$&. However, the use of these
27335 variables for this purpose is now deprecated, as it can lead to confusion in
27336 string expansions that also use them for other things.
27337
27338 If there are more strings in &%server_prompts%& than the number of strings
27339 supplied with the AUTH command, the remaining prompts are used to obtain more
27340 data. Each response from the client may be a list of NUL-separated strings.
27341
27342 .vindex "&$authenticated_id$&"
27343 Once a sufficient number of data strings have been received,
27344 &%server_condition%& is expanded. If the expansion is forced to fail,
27345 authentication fails. Any other expansion failure causes a temporary error code
27346 to be returned. If the result of a successful expansion is an empty string,
27347 &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
27348 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds and the
27349 generic &%server_set_id%& option is expanded and saved in &$authenticated_id$&.
27350 For any other result, a temporary error code is returned, with the expanded
27351 string as the error text.
27352
27353 &*Warning*&: If you use a lookup in the expansion to find the user's
27354 password, be sure to make the authentication fail if the user is unknown.
27355 There are good and bad examples at the end of the next section.
27356
27357
27358
27359 .section "The PLAIN authentication mechanism" "SECID172"
27360 .cindex "PLAIN authentication mechanism"
27361 .cindex authentication PLAIN
27362 .cindex "binary zero" "in &(plaintext)& authenticator"
27363 The PLAIN authentication mechanism (RFC 2595) specifies that three strings be
27364 sent as one item of data (that is, one combined string containing two NUL
27365 separators). The data is sent either as part of the AUTH command, or
27366 subsequently in response to an empty prompt from the server.
27367
27368 The second and third strings are a user name and a corresponding password.
27369 Using a single fixed user name and password as an example, this could be
27370 configured as follows:
27371 .code
27372 fixed_plain:
27373   driver = plaintext
27374   public_name = PLAIN
27375   server_prompts = :
27376   server_condition = \
27377     ${if and {{eq{$auth2}{username}}{eq{$auth3}{mysecret}}}}
27378   server_set_id = $auth2
27379 .endd
27380 Note that the default result strings from &%if%& (&"true"& or an empty string)
27381 are exactly what we want here, so they need not be specified. Obviously, if the
27382 password contains expansion-significant characters such as dollar, backslash,
27383 or closing brace, they have to be escaped.
27384
27385 The &%server_prompts%& setting specifies a single, empty prompt (empty items at
27386 the end of a string list are ignored). If all the data comes as part of the
27387 AUTH command, as is commonly the case, the prompt is not used. This
27388 authenticator is advertised in the response to EHLO as
27389 .code
27390 250-AUTH PLAIN
27391 .endd
27392 and a client host can authenticate itself by sending the command
27393 .code
27394 AUTH PLAIN AHVzZXJuYW1lAG15c2VjcmV0
27395 .endd
27396 As this contains three strings (more than the number of prompts), no further
27397 data is required from the client. Alternatively, the client may just send
27398 .code
27399 AUTH PLAIN
27400 .endd
27401 to initiate authentication, in which case the server replies with an empty
27402 prompt. The client must respond with the combined data string.
27403
27404 The data string is base64 encoded, as required by the RFC. This example,
27405 when decoded, is <&'NUL'&>&`username`&<&'NUL'&>&`mysecret`&, where <&'NUL'&>
27406 represents a zero byte. This is split up into three strings, the first of which
27407 is empty. The &%server_condition%& option in the authenticator checks that the
27408 second two are &`username`& and &`mysecret`& respectively.
27409
27410 Having just one fixed user name and password, as in this example, is not very
27411 realistic, though for a small organization with only a handful of
27412 authenticating clients it could make sense.
27413
27414 A more sophisticated instance of this authenticator could use the user name in
27415 &$auth2$& to look up a password in a file or database, and maybe do an encrypted
27416 comparison (see &%crypteq%& in chapter &<<CHAPexpand>>&). Here is a example of
27417 this approach, where the passwords are looked up in a DBM file. &*Warning*&:
27418 This is an incorrect example:
27419 .code
27420 server_condition = \
27421   ${if eq{$auth3}{${lookup{$auth2}dbm{/etc/authpwd}}}}
27422 .endd
27423 The expansion uses the user name (&$auth2$&) as the key to look up a password,
27424 which it then compares to the supplied password (&$auth3$&). Why is this example
27425 incorrect? It works fine for existing users, but consider what happens if a
27426 non-existent user name is given. The lookup fails, but as no success/failure
27427 strings are given for the lookup, it yields an empty string. Thus, to defeat
27428 the authentication, all a client has to do is to supply a non-existent user
27429 name and an empty password. The correct way of writing this test is:
27430 .code
27431 server_condition = ${lookup{$auth2}dbm{/etc/authpwd}\
27432   {${if eq{$value}{$auth3}}} {false}}
27433 .endd
27434 In this case, if the lookup succeeds, the result is checked; if the lookup
27435 fails, &"false"& is returned and authentication fails. If &%crypteq%& is being
27436 used instead of &%eq%&, the first example is in fact safe, because &%crypteq%&
27437 always fails if its second argument is empty. However, the second way of
27438 writing the test makes the logic clearer.
27439
27440
27441 .section "The LOGIN authentication mechanism" "SECID173"
27442 .cindex "LOGIN authentication mechanism"
27443 .cindex authentication LOGIN
27444 The LOGIN authentication mechanism is not documented in any RFC, but is in use
27445 in a number of programs. No data is sent with the AUTH command. Instead, a
27446 user name and password are supplied separately, in response to prompts. The
27447 plaintext authenticator can be configured to support this as in this example:
27448 .code
27449 fixed_login:
27450   driver = plaintext
27451   public_name = LOGIN
27452   server_prompts = User Name : Password
27453   server_condition = \
27454     ${if and {{eq{$auth1}{username}}{eq{$auth2}{mysecret}}}}
27455   server_set_id = $auth1
27456 .endd
27457 Because of the way plaintext operates, this authenticator accepts data supplied
27458 with the AUTH command (in contravention of the specification of LOGIN), but
27459 if the client does not supply it (as is the case for LOGIN clients), the prompt
27460 strings are used to obtain two data items.
27461
27462 Some clients are very particular about the precise text of the prompts. For
27463 example, Outlook Express is reported to recognize only &"Username:"& and
27464 &"Password:"&. Here is an example of a LOGIN authenticator that uses those
27465 strings. It uses the &%ldapauth%& expansion condition to check the user
27466 name and password by binding to an LDAP server:
27467 .code
27468 login:
27469   driver = plaintext
27470   public_name = LOGIN
27471   server_prompts = Username:: : Password::
27472   server_condition = ${if and{{ \
27473     !eq{}{$auth1} }{ \
27474     ldapauth{\
27475       user="uid=${quote_ldap_dn:$auth1},ou=people,o=example.org" \
27476       pass=${quote:$auth2} \
27477       ldap://ldap.example.org/} }} }
27478   server_set_id = uid=$auth1,ou=people,o=example.org
27479 .endd
27480 We have to check that the username is not empty before using it, because LDAP
27481 does not permit empty DN components. We must also use the &%quote_ldap_dn%&
27482 operator to correctly quote the DN for authentication. However, the basic
27483 &%quote%& operator, rather than any of the LDAP quoting operators, is the
27484 correct one to use for the password, because quoting is needed only to make
27485 the password conform to the Exim syntax. At the LDAP level, the password is an
27486 uninterpreted string.
27487
27488
27489 .section "Support for different kinds of authentication" "SECID174"
27490 A number of string expansion features are provided for the purpose of
27491 interfacing to different ways of user authentication. These include checking
27492 traditionally encrypted passwords from &_/etc/passwd_& (or equivalent), PAM,
27493 Radius, &%ldapauth%&, &'pwcheck'&, and &'saslauthd'&. For details see section
27494 &<<SECTexpcond>>&.
27495
27496
27497
27498
27499 .section "Using plaintext in a client" "SECID175"
27500 .cindex "options" "&(plaintext)& authenticator (client)"
27501 The &(plaintext)& authenticator has two client options:
27502
27503 .option client_ignore_invalid_base64 plaintext boolean false
27504 If the client receives a server prompt that is not a valid base64 string,
27505 authentication is abandoned by default. However, if this option is set true,
27506 the error in the challenge is ignored and the client sends the response as
27507 usual.
27508
27509 .option client_send plaintext string&!! unset
27510 The string is a colon-separated list of authentication data strings. Each
27511 string is independently expanded before being sent to the server. The first
27512 string is sent with the AUTH command; any more strings are sent in response
27513 to prompts from the server. Before each string is expanded, the value of the
27514 most recent prompt is placed in the next &$auth$&<&'n'&> variable, starting
27515 with &$auth1$& for the first prompt. Up to three prompts are stored in this
27516 way. Thus, the prompt that is received in response to sending the first string
27517 (with the AUTH command) can be used in the expansion of the second string, and
27518 so on. If an invalid base64 string is received when
27519 &%client_ignore_invalid_base64%& is set, an empty string is put in the
27520 &$auth$&<&'n'&> variable.
27521
27522 &*Note*&: You cannot use expansion to create multiple strings, because
27523 splitting takes priority and happens first.
27524
27525 Because the PLAIN authentication mechanism requires NUL (binary zero) bytes in
27526 the data, further processing is applied to each string before it is sent. If
27527 there are any single circumflex characters in the string, they are converted to
27528 NULs. Should an actual circumflex be required as data, it must be doubled in
27529 the string.
27530
27531 This is an example of a client configuration that implements the PLAIN
27532 authentication mechanism with a fixed user name and password:
27533 .code
27534 fixed_plain:
27535   driver = plaintext
27536   public_name = PLAIN
27537   client_send = ^username^mysecret
27538 .endd
27539 The lack of colons means that the entire text is sent with the AUTH
27540 command, with the circumflex characters converted to NULs. A similar example
27541 that uses the LOGIN mechanism is:
27542 .code
27543 fixed_login:
27544   driver = plaintext
27545   public_name = LOGIN
27546   client_send = : username : mysecret
27547 .endd
27548 The initial colon means that the first string is empty, so no data is sent with
27549 the AUTH command itself. The remaining strings are sent in response to
27550 prompts.
27551 .ecindex IIDplaiauth1
27552 .ecindex IIDplaiauth2
27553
27554
27555
27556
27557 . ////////////////////////////////////////////////////////////////////////////
27558 . ////////////////////////////////////////////////////////////////////////////
27559
27560 .chapter "The cram_md5 authenticator" "CHID9"
27561 .scindex IIDcramauth1 "&(cram_md5)& authenticator"
27562 .scindex IIDcramauth2 "authenticators" "&(cram_md5)&"
27563 .cindex "CRAM-MD5 authentication mechanism"
27564 .cindex authentication CRAM-MD5
27565 The CRAM-MD5 authentication mechanism is described in RFC 2195. The server
27566 sends a challenge string to the client, and the response consists of a user
27567 name and the CRAM-MD5 digest of the challenge string combined with a secret
27568 string (password) which is known to both server and client. Thus, the secret
27569 is not sent over the network as plain text, which makes this authenticator more
27570 secure than &(plaintext)&. However, the downside is that the secret has to be
27571 available in plain text at either end.
27572
27573
27574 .section "Using cram_md5 as a server" "SECID176"
27575 .cindex "options" "&(cram_md5)& authenticator (server)"
27576 This authenticator has one server option, which must be set to configure the
27577 authenticator as a server:
27578
27579 .option server_secret cram_md5 string&!! unset
27580 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(cram_md5)& authenticator"
27581 When the server receives the client's response, the user name is placed in
27582 the expansion variable &$auth1$&, and &%server_secret%& is expanded to
27583 obtain the password for that user. The server then computes the CRAM-MD5 digest
27584 that the client should have sent, and checks that it received the correct
27585 string. If the expansion of &%server_secret%& is forced to fail, authentication
27586 fails. If the expansion fails for some other reason, a temporary error code is
27587 returned to the client.
27588
27589 For compatibility with previous releases of Exim, the user name is also placed
27590 in &$1$&. However, the use of this variables for this purpose is now
27591 deprecated, as it can lead to confusion in string expansions that also use
27592 numeric variables for other things.
27593
27594 For example, the following authenticator checks that the user name given by the
27595 client is &"ph10"&, and if so, uses &"secret"& as the password. For any other
27596 user name, authentication fails.
27597 .code
27598 fixed_cram:
27599   driver = cram_md5
27600   public_name = CRAM-MD5
27601   server_secret = ${if eq{$auth1}{ph10}{secret}fail}
27602   server_set_id = $auth1
27603 .endd
27604 .vindex "&$authenticated_id$&"
27605 If authentication succeeds, the setting of &%server_set_id%& preserves the user
27606 name in &$authenticated_id$&. A more typical configuration might look up the
27607 secret string in a file, using the user name as the key. For example:
27608 .code
27609 lookup_cram:
27610   driver = cram_md5
27611   public_name = CRAM-MD5
27612   server_secret = ${lookup{$auth1}lsearch{/etc/authpwd}\
27613                   {$value}fail}
27614   server_set_id = $auth1
27615 .endd
27616 Note that this expansion explicitly forces failure if the lookup fails
27617 because &$auth1$& contains an unknown user name.
27618
27619 As another example, if you wish to re-use a Cyrus SASL sasldb2 file without
27620 using the relevant libraries, you need to know the realm to specify in the
27621 lookup and then ask for the &"userPassword"& attribute for that user in that
27622 realm, with:
27623 .code
27624 cyrusless_crammd5:
27625   driver = cram_md5
27626   public_name = CRAM-MD5
27627   server_secret = ${lookup{$auth1:mail.example.org:userPassword}\
27628                   dbmjz{/etc/sasldb2}{$value}fail}
27629   server_set_id = $auth1
27630 .endd
27631
27632 .section "Using cram_md5 as a client" "SECID177"
27633 .cindex "options" "&(cram_md5)& authenticator (client)"
27634 When used as a client, the &(cram_md5)& authenticator has two options:
27635
27636
27637
27638 .option client_name cram_md5 string&!! "the primary host name"
27639 This string is expanded, and the result used as the user name data when
27640 computing the response to the server's challenge.
27641
27642
27643 .option client_secret cram_md5 string&!! unset
27644 This option must be set for the authenticator to work as a client. Its value is
27645 expanded and the result used as the secret string when computing the response.
27646
27647
27648 .vindex "&$host$&"
27649 .vindex "&$host_address$&"
27650 Different user names and secrets can be used for different servers by referring
27651 to &$host$& or &$host_address$& in the options. Forced failure of either
27652 expansion string is treated as an indication that this authenticator is not
27653 prepared to handle this case. Exim moves on to the next configured client
27654 authenticator. Any other expansion failure causes Exim to give up trying to
27655 send the message to the current server.
27656
27657 A simple example configuration of a &(cram_md5)& authenticator, using fixed
27658 strings, is:
27659 .code
27660 fixed_cram:
27661   driver = cram_md5
27662   public_name = CRAM-MD5
27663   client_name = ph10
27664   client_secret = secret
27665 .endd
27666 .ecindex IIDcramauth1
27667 .ecindex IIDcramauth2
27668
27669
27670
27671 . ////////////////////////////////////////////////////////////////////////////
27672 . ////////////////////////////////////////////////////////////////////////////
27673
27674 .chapter "The cyrus_sasl authenticator" "CHID10"
27675 .scindex IIDcyrauth1 "&(cyrus_sasl)& authenticator"
27676 .scindex IIDcyrauth2 "authenticators" "&(cyrus_sasl)&"
27677 .cindex "Cyrus" "SASL library"
27678 .cindex "Kerberos"
27679 The code for this authenticator was provided by Matthew Byng-Maddick while
27680 at A L Digital Ltd.
27681
27682 The &(cyrus_sasl)& authenticator provides server support for the Cyrus SASL
27683 library implementation of the RFC 2222 (&"Simple Authentication and Security
27684 Layer"&). This library supports a number of authentication mechanisms,
27685 including PLAIN and LOGIN, but also several others that Exim does not support
27686 directly. In particular, there is support for Kerberos authentication.
27687
27688 The &(cyrus_sasl)& authenticator provides a gatewaying mechanism directly to
27689 the Cyrus interface, so if your Cyrus library can do, for example, CRAM-MD5,
27690 then so can the &(cyrus_sasl)& authenticator. By default it uses the public
27691 name of the driver to determine which mechanism to support.
27692
27693 Where access to some kind of secret file is required, for example, in GSSAPI
27694 or CRAM-MD5, it is worth noting that the authenticator runs as the Exim
27695 user, and that the Cyrus SASL library has no way of escalating privileges
27696 by default. You may also find you need to set environment variables,
27697 depending on the driver you are using.
27698
27699 The application name provided by Exim is &"exim"&, so various SASL options may
27700 be set in &_exim.conf_& in your SASL directory. If you are using GSSAPI for
27701 Kerberos, note that because of limitations in the GSSAPI interface,
27702 changing the server keytab might need to be communicated down to the Kerberos
27703 layer independently. The mechanism for doing so is dependent upon the Kerberos
27704 implementation.
27705
27706 For example, for older releases of Heimdal, the environment variable KRB5_KTNAME
27707 may be set to point to an alternative keytab file. Exim will pass this
27708 variable through from its own inherited environment when started as root or the
27709 Exim user. The keytab file needs to be readable by the Exim user.
27710 With newer releases of Heimdal, a setuid Exim may cause Heimdal to discard the
27711 environment variable.  In practice, for those releases, the Cyrus authenticator
27712 is not a suitable interface for GSSAPI (Kerberos) support.  Instead, consider
27713 the &(heimdal_gssapi)& authenticator, described in chapter &<<CHAPheimdalgss>>&
27714
27715
27716 .section "Using cyrus_sasl as a server" "SECID178"
27717 The &(cyrus_sasl)& authenticator has four private options. It puts the username
27718 (on a successful authentication) into &$auth1$&. For compatibility with
27719 previous releases of Exim, the username is also placed in &$1$&. However, the
27720 use of this variable for this purpose is now deprecated, as it can lead to
27721 confusion in string expansions that also use numeric variables for other
27722 things.
27723
27724
27725 .option server_hostname cyrus_sasl string&!! "see below"
27726 This option selects the hostname that is used when communicating with the
27727 library. The default value is &`$primary_hostname`&. It is up to the underlying
27728 SASL plug-in what it does with this data.
27729
27730
27731 .option server_mech cyrus_sasl string "see below"
27732 This option selects the authentication mechanism this driver should use. The
27733 default is the value of the generic &%public_name%& option. This option allows
27734 you to use a different underlying mechanism from the advertised name. For
27735 example:
27736 .code
27737 sasl:
27738   driver = cyrus_sasl
27739   public_name = X-ANYTHING
27740   server_mech = CRAM-MD5
27741   server_set_id = $auth1
27742 .endd
27743
27744 .option server_realm cyrus_sasl string&!! unset
27745 This specifies the SASL realm that the server claims to be in.
27746
27747
27748 .option server_service cyrus_sasl string &`smtp`&
27749 This is the SASL service that the server claims to implement.
27750
27751
27752 For straightforward cases, you do not need to set any of the authenticator's
27753 private options. All you need to do is to specify an appropriate mechanism as
27754 the public name. Thus, if you have a SASL library that supports CRAM-MD5 and
27755 PLAIN, you could have two authenticators as follows:
27756 .code
27757 sasl_cram_md5:
27758   driver = cyrus_sasl
27759   public_name = CRAM-MD5
27760   server_set_id = $auth1
27761
27762 sasl_plain:
27763   driver = cyrus_sasl
27764   public_name = PLAIN
27765   server_set_id = $auth2
27766 .endd
27767 Cyrus SASL does implement the LOGIN authentication method, even though it is
27768 not a standard method. It is disabled by default in the source distribution,
27769 but it is present in many binary distributions.
27770 .ecindex IIDcyrauth1
27771 .ecindex IIDcyrauth2
27772
27773
27774
27775
27776 . ////////////////////////////////////////////////////////////////////////////
27777 . ////////////////////////////////////////////////////////////////////////////
27778 .chapter "The dovecot authenticator" "CHAPdovecot"
27779 .scindex IIDdcotauth1 "&(dovecot)& authenticator"
27780 .scindex IIDdcotauth2 "authenticators" "&(dovecot)&"
27781 This authenticator is an interface to the authentication facility of the
27782 Dovecot 2 POP/IMAP server, which can support a number of authentication methods.
27783 Note that Dovecot must be configured to use auth-client not auth-userdb.
27784 If you are using Dovecot to authenticate POP/IMAP clients, it might be helpful
27785 to use the same mechanisms for SMTP authentication. This is a server
27786 authenticator only. There is only one option:
27787
27788 .option server_socket dovecot string unset
27789
27790 This option must specify the UNIX socket that is the interface to Dovecot
27791 authentication. The &%public_name%& option must specify an authentication
27792 mechanism that Dovecot is configured to support. You can have several
27793 authenticators for different mechanisms. For example:
27794 .code
27795 dovecot_plain:
27796   driver = dovecot
27797   public_name = PLAIN
27798   server_socket = /var/run/dovecot/auth-client
27799   server_set_id = $auth1
27800
27801 dovecot_ntlm:
27802   driver = dovecot
27803   public_name = NTLM
27804   server_socket = /var/run/dovecot/auth-client
27805   server_set_id = $auth1
27806 .endd
27807 If the SMTP connection is encrypted, or if &$sender_host_address$& is equal to
27808 &$received_ip_address$& (that is, the connection is local), the &"secured"&
27809 option is passed in the Dovecot authentication command. If, for a TLS
27810 connection, a client certificate has been verified, the &"valid-client-cert"&
27811 option is passed. When authentication succeeds, the identity of the user
27812 who authenticated is placed in &$auth1$&.
27813
27814 .new
27815 The Dovecot configuration to match the above wil look
27816 something like:
27817 .code
27818 conf.d/10-master.conf :-
27819
27820 service auth {
27821 ...
27822 #SASL
27823   unix_listener auth-client {
27824     mode = 0660
27825     user = mail
27826   }
27827 ...
27828 }
27829
27830 conf.d/10-auth.conf :-
27831
27832 auth_mechanisms = plain login ntlm
27833 .endd
27834 .wen
27835
27836 .ecindex IIDdcotauth1
27837 .ecindex IIDdcotauth2
27838
27839
27840 . ////////////////////////////////////////////////////////////////////////////
27841 . ////////////////////////////////////////////////////////////////////////////
27842 .chapter "The gsasl authenticator" "CHAPgsasl"
27843 .scindex IIDgsaslauth1 "&(gsasl)& authenticator"
27844 .scindex IIDgsaslauth2 "authenticators" "&(gsasl)&"
27845 .cindex "authentication" "GNU SASL"
27846 .cindex "authentication" "SASL"
27847 .cindex "authentication" "EXTERNAL"
27848 .cindex "authentication" "ANONYMOUS"
27849 .cindex "authentication" "PLAIN"
27850 .cindex "authentication" "LOGIN"
27851 .cindex "authentication" "DIGEST-MD5"
27852 .cindex "authentication" "CRAM-MD5"
27853 .cindex "authentication" "SCRAM family"
27854 The &(gsasl)& authenticator provides integration for the GNU SASL
27855 library and the mechanisms it provides.  This is new as of the 4.80 release
27856 and there are a few areas where the library does not let Exim smoothly
27857 scale to handle future authentication mechanisms, so no guarantee can be
27858 made that any particular new authentication mechanism will be supported
27859 without code changes in Exim.
27860
27861 .new
27862 The library is expected to add support in an upcoming
27863 realease for the SCRAM-SHA-256 method.
27864 The macro _HAVE_AUTH_GSASL_SCRAM_SHA_256 will be defined
27865 when this happens.
27866
27867
27868 .option client_authz gsasl string&!! unset
27869 This option can be used to supply an &'authorization id'&
27870 which is different to the &'authentication_id'& provided
27871 by &%client_username%& option.
27872 If unset or (after expansion) empty it is not used,
27873 which is the common case.
27874
27875 .option client_channelbinding gsasl boolean false
27876 See &%server_channelbinding%& below.
27877
27878 .option client_password gsasl string&!! unset
27879 This option is exapanded before use, and should result in
27880 the password to be used, in clear.
27881
27882 .option client_username gsasl string&!! unset
27883 This option is exapanded before use, and should result in
27884 the account name to be used.
27885 .wen
27886
27887 .new
27888 .option client_spassword gsasl string&!! unset
27889 If a SCRAM mechanism is being used and this option is set
27890 it is used in preference to &%client_password%&.
27891 The value after expansion should be
27892 a 40 (for SHA-1) or 64 (for SHA-256) character string
27893 with the PBKDF2-prepared password, hex-encoded.
27894 Note that this value will depend on the salt and iteration-count
27895 supplied by the server.
27896 .wen
27897
27898
27899
27900 .option server_channelbinding gsasl boolean false
27901 Do not set this true and rely on the properties
27902 without consulting a cryptographic engineer.
27903
27904 Some authentication mechanisms are able to use external context at both ends
27905 of the session to bind the authentication to that context, and fail the
27906 authentication process if that context differs.  Specifically, some TLS
27907 ciphersuites can provide identifying information about the cryptographic
27908 context.
27909
27910 This should have meant that certificate identity and verification becomes a
27911 non-issue, as a man-in-the-middle attack will cause the correct client and
27912 server to see different identifiers and authentication will fail.
27913
27914 .new
27915 This is
27916 only usable by mechanisms which support "channel binding"; at time of
27917 writing, that's the SCRAM family.
27918 When using this feature the "-PLUS" variants of the method names need to be used.
27919 .wen
27920
27921 This defaults off to ensure smooth upgrade across Exim releases, in case
27922 this option causes some clients to start failing.  Some future release
27923 of Exim might have switched the default to be true.
27924
27925 However, Channel Binding in TLS has proven to be vulnerable in current versions.
27926 Do not plan to rely upon this feature for security, ever, without consulting
27927 with a subject matter expert (a cryptographic engineer).
27928
27929
27930 .option server_hostname gsasl string&!! "see below"
27931 This option selects the hostname that is used when communicating with the
27932 library. The default value is &`$primary_hostname`&.
27933 Some mechanisms will use this data.
27934
27935
27936 .option server_mech gsasl string "see below"
27937 This option selects the authentication mechanism this driver should use. The
27938 default is the value of the generic &%public_name%& option. This option allows
27939 you to use a different underlying mechanism from the advertised name. For
27940 example:
27941 .code
27942 sasl:
27943   driver = gsasl
27944   public_name = X-ANYTHING
27945   server_mech = CRAM-MD5
27946   server_set_id = $auth1
27947 .endd
27948
27949
27950 .option server_password gsasl string&!! unset
27951 Various mechanisms need access to the cleartext password on the server, so
27952 that proof-of-possession can be demonstrated on the wire, without sending
27953 the password itself.
27954
27955 The data available for lookup varies per mechanism.
27956 In all cases, &$auth1$& is set to the &'authentication id'&.
27957 The &$auth2$& variable will always be the &'authorization id'& (&'authz'&)
27958 if available, else the empty string.
27959 The &$auth3$& variable will always be the &'realm'& if available,
27960 else the empty string.
27961
27962 A forced failure will cause authentication to defer.
27963
27964 If using this option, it may make sense to set the &%server_condition%&
27965 option to be simply "true".
27966
27967
27968 .option server_realm gsasl string&!! unset
27969 This specifies the SASL realm that the server claims to be in.
27970 Some mechanisms will use this data.
27971
27972
27973 .option server_scram_iter gsasl string&!! 4096
27974 This option provides data for the SCRAM family of mechanisms.
27975 .new
27976 The &$auth1$&, &$auth2$& and &$auth3$& variables are available
27977 when this option is expanded.
27978
27979 The result of expansion should be a decimal number,
27980 and represents both a lower-bound on the security, and
27981 a compute cost factor imposed on the client
27982 (if it does not cache results, or the server changes
27983 either the iteration count or the salt).
27984 A minimum value of 4096 is required by the standards
27985 for all current SCRAM mechanism variants.
27986 .wen
27987
27988 .option server_scram_salt gsasl string&!! unset
27989 This option provides data for the SCRAM family of mechanisms.
27990 .new
27991 The &$auth1$&, &$auth2$& and &$auth3$& variables are available
27992 when this option is expanded.
27993 The value should be a base64-encoded string,
27994 of random data typically 4-to-16 bytes long.
27995 If unset or empty after expansion the library will provides a value for the
27996 protocol conversation.
27997 .wen
27998
27999
28000 .new
28001 .option server_key gsasl string&!! unset
28002 .option server_skey gsasl string&!! unset
28003 These options can be used for the SCRAM family of mechanisms
28004 to provide stored information related to a password,
28005 the storage of which is preferable to plaintext.
28006
28007 &%server_key%& is the value defined in the SCRAM standards as ServerKey;
28008 &%server_skey%& is StoredKey.
28009
28010 They are only available for version 1.9.0 (or later) of the gsasl library.
28011 When this is so, the macros
28012 _OPT_AUTHENTICATOR_GSASL_SERVER_KEY
28013 and _HAVE_AUTH_GSASL_SCRAM_S_KEY
28014 will be defined.
28015
28016 The &$authN$& variables are available when these options are expanded.
28017
28018 If set, the results of expansion should for each
28019 should be a 28 (for SHA-1) or 44 (for SHA-256) character string
28020 of base64-coded data, and will be used in preference to the
28021 &%server_password%& option.
28022 If unset or not of the right length, &%server_password%& will be used.
28023
28024 The libgsasl library release includes a utility &'gsasl'& which can be used
28025 to generate these values.
28026 .wen
28027
28028
28029 .option server_service gsasl string &`smtp`&
28030 This is the SASL service that the server claims to implement.
28031 Some mechanisms will use this data.
28032
28033
28034 .section "&(gsasl)& auth variables" "SECTgsaslauthvar"
28035 .vindex "&$auth1$&, &$auth2$&, etc"
28036 These may be set when evaluating specific options, as detailed above.
28037 They will also be set when evaluating &%server_condition%&.
28038
28039 Unless otherwise stated below, the &(gsasl)& integration will use the following
28040 meanings for these variables:
28041
28042 .ilist
28043 .vindex "&$auth1$&"
28044 &$auth1$&: the &'authentication id'&
28045 .next
28046 .vindex "&$auth2$&"
28047 &$auth2$&: the &'authorization id'&
28048 .next
28049 .vindex "&$auth3$&"
28050 &$auth3$&: the &'realm'&
28051 .endlist
28052
28053 On a per-mechanism basis:
28054
28055 .ilist
28056 .cindex "authentication" "EXTERNAL"
28057 EXTERNAL: only &$auth1$& is set, to the possibly empty &'authorization id'&;
28058 the &%server_condition%& option must be present.
28059 .next
28060 .cindex "authentication" "ANONYMOUS"
28061 ANONYMOUS: only &$auth1$& is set, to the possibly empty &'anonymous token'&;
28062 the &%server_condition%& option must be present.
28063 .next
28064 .cindex "authentication" "GSSAPI"
28065 GSSAPI: &$auth1$& will be set to the &'GSSAPI Display Name'&;
28066 &$auth2$& will be set to the &'authorization id'&,
28067 the &%server_condition%& option must be present.
28068 .endlist
28069
28070 An &'anonymous token'& is something passed along as an unauthenticated
28071 identifier; this is analogous to FTP anonymous authentication passing an
28072 email address, or software-identifier@, as the "password".
28073
28074
28075 An example showing the password having the realm specified in the callback
28076 and demonstrating a Cyrus SASL to GSASL migration approach is:
28077 .code
28078 gsasl_cyrusless_crammd5:
28079   driver = gsasl
28080   public_name = CRAM-MD5
28081   server_realm = imap.example.org
28082   server_password = ${lookup{$auth1:$auth3:userPassword}\
28083                     dbmjz{/etc/sasldb2}{$value}fail}
28084   server_set_id = ${quote:$auth1}
28085   server_condition = yes
28086 .endd
28087
28088
28089 . ////////////////////////////////////////////////////////////////////////////
28090 . ////////////////////////////////////////////////////////////////////////////
28091
28092 .chapter "The heimdal_gssapi authenticator" "CHAPheimdalgss"
28093 .scindex IIDheimdalgssauth1 "&(heimdal_gssapi)& authenticator"
28094 .scindex IIDheimdalgssauth2 "authenticators" "&(heimdal_gssapi)&"
28095 .cindex "authentication" "GSSAPI"
28096 .cindex "authentication" "Kerberos"
28097 The &(heimdal_gssapi)& authenticator provides server integration for the
28098 Heimdal GSSAPI/Kerberos library, permitting Exim to set a keytab pathname
28099 reliably.
28100
28101 .option server_hostname heimdal_gssapi string&!! "see below"
28102 This option selects the hostname that is used, with &%server_service%&,
28103 for constructing the GSS server name, as a &'GSS_C_NT_HOSTBASED_SERVICE'&
28104 identifier.  The default value is &`$primary_hostname`&.
28105
28106 .option server_keytab heimdal_gssapi string&!! unset
28107 If set, then Heimdal will not use the system default keytab (typically
28108 &_/etc/krb5.keytab_&) but instead the pathname given in this option.
28109 The value should be a pathname, with no &"file:"& prefix.
28110
28111 .option server_service heimdal_gssapi string&!! "smtp"
28112 This option specifies the service identifier used, in conjunction with
28113 &%server_hostname%&, for building the identifier for finding credentials
28114 from the keytab.
28115
28116
28117 .section "&(heimdal_gssapi)& auth variables" "SECTheimdalgssauthvar"
28118 Beware that these variables will typically include a realm, thus will appear
28119 to be roughly like an email address already.  The &'authzid'& in &$auth2$& is
28120 not verified, so a malicious client can set it to anything.
28121
28122 The &$auth1$& field should be safely trustable as a value from the Key
28123 Distribution Center.  Note that these are not quite email addresses.
28124 Each identifier is for a role, and so the left-hand-side may include a
28125 role suffix.  For instance, &"joe/admin@EXAMPLE.ORG"&.
28126
28127 .vindex "&$auth1$&, &$auth2$&, etc"
28128 .ilist
28129 .vindex "&$auth1$&"
28130 &$auth1$&: the &'authentication id'&, set to the GSS Display Name.
28131 .next
28132 .vindex "&$auth2$&"
28133 &$auth2$&: the &'authorization id'&, sent within SASL encapsulation after
28134 authentication.  If that was empty, this will also be set to the
28135 GSS Display Name.
28136 .endlist
28137
28138
28139 . ////////////////////////////////////////////////////////////////////////////
28140 . ////////////////////////////////////////////////////////////////////////////
28141
28142 .chapter "The spa authenticator" "CHAPspa"
28143 .scindex IIDspaauth1 "&(spa)& authenticator"
28144 .scindex IIDspaauth2 "authenticators" "&(spa)&"
28145 .cindex "authentication" "Microsoft Secure Password"
28146 .cindex "authentication" "NTLM"
28147 .cindex "Microsoft Secure Password Authentication"
28148 .cindex "NTLM authentication"
28149 The &(spa)& authenticator provides client support for Microsoft's &'Secure
28150 Password Authentication'& mechanism,
28151 which is also sometimes known as NTLM (NT LanMan). The code for client side of
28152 this authenticator was contributed by Marc Prud'hommeaux, and much of it is
28153 taken from the Samba project (&url(https://www.samba.org/)). The code for the
28154 server side was subsequently contributed by Tom Kistner. The mechanism works as
28155 follows:
28156
28157 .ilist
28158 After the AUTH command has been accepted, the client sends an SPA
28159 authentication request based on the user name and optional domain.
28160 .next
28161 The server sends back a challenge.
28162 .next
28163 The client builds a challenge response which makes use of the user's password
28164 and sends it to the server, which then accepts or rejects it.
28165 .endlist
28166
28167 Encryption is used to protect the password in transit.
28168
28169
28170
28171 .section "Using spa as a server" "SECID179"
28172 .cindex "options" "&(spa)& authenticator (server)"
28173 The &(spa)& authenticator has just one server option:
28174
28175 .option server_password spa string&!! unset
28176 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(spa)& authenticator"
28177 This option is expanded, and the result must be the cleartext password for the
28178 authenticating user, whose name is at this point in &$auth1$&. For
28179 compatibility with previous releases of Exim, the user name is also placed in
28180 &$1$&. However, the use of this variable for this purpose is now deprecated, as
28181 it can lead to confusion in string expansions that also use numeric variables
28182 for other things. For example:
28183 .code
28184 spa:
28185   driver = spa
28186   public_name = NTLM
28187   server_password = \
28188     ${lookup{$auth1}lsearch{/etc/exim/spa_clearpass}{$value}fail}
28189 .endd
28190 If the expansion is forced to fail, authentication fails. Any other expansion
28191 failure causes a temporary error code to be returned.
28192
28193
28194
28195
28196
28197 .section "Using spa as a client" "SECID180"
28198 .cindex "options" "&(spa)& authenticator (client)"
28199 The &(spa)& authenticator has the following client options:
28200
28201
28202
28203 .option client_domain spa string&!! unset
28204 This option specifies an optional domain for the authentication.
28205
28206
28207 .option client_password spa string&!! unset
28208 This option specifies the user's password, and must be set.
28209
28210
28211 .option client_username spa string&!! unset
28212 This option specifies the user name, and must be set. Here is an example of a
28213 configuration of this authenticator for use with the mail servers at
28214 &'msn.com'&:
28215 .code
28216 msn:
28217   driver = spa
28218   public_name = MSN
28219   client_username = msn/msn_username
28220   client_password = msn_plaintext_password
28221   client_domain = DOMAIN_OR_UNSET
28222 .endd
28223 .ecindex IIDspaauth1
28224 .ecindex IIDspaauth2
28225
28226
28227
28228
28229
28230 . ////////////////////////////////////////////////////////////////////////////
28231 . ////////////////////////////////////////////////////////////////////////////
28232
28233 .chapter "The external authenticator" "CHAPexternauth"
28234 .scindex IIDexternauth1 "&(external)& authenticator"
28235 .scindex IIDexternauth2 "authenticators" "&(external)&"
28236 .cindex "authentication" "Client Certificate"
28237 .cindex "authentication" "X509"
28238 .cindex "Certificate-based authentication"
28239 The &(external)& authenticator provides support for
28240 authentication based on non-SMTP information.
28241 The specification is in RFC 4422 Appendix A
28242 (&url(https://tools.ietf.org/html/rfc4422)).
28243 It is only a transport and negotiation mechanism;
28244 the process of authentication is entirely controlled
28245 by the server configuration.
28246
28247 The client presents an identity in-clear.
28248 It is probably wise for a server to only advertise,
28249 and for clients to only attempt,
28250 this authentication method on a secure (eg. under TLS) connection.
28251
28252 One possible use, compatible with the
28253 K-9 Mail Andoid client (&url(https://k9mail.github.io/)),
28254 is for using X509 client certificates.
28255
28256 It thus overlaps in function with the TLS authenticator
28257 (see &<<CHAPtlsauth>>&)
28258 but is a full SMTP SASL authenticator
28259 rather than being implicit for TLS-connection carried
28260 client certificates only.
28261
28262 The examples and discussion in this chapter assume that
28263 client-certificate authentication is being done.
28264
28265 The client must present a certificate,
28266 for which it must have been requested via the
28267 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& main options
28268 (see &<<CHAPTLS>>&).
28269 For authentication to be effective the certificate should be
28270 verifiable against a trust-anchor certificate known to the server.
28271
28272 .section "External options" "SECTexternsoptions"
28273 .cindex "options" "&(external)& authenticator (server)"
28274 The &(external)& authenticator has two server options:
28275
28276 .option server_param2 external string&!! unset
28277 .option server_param3 external string&!! unset
28278 .cindex "variables (&$auth1$& &$auth2$& etc)" "in &(external)& authenticator"
28279 These options are expanded before the &%server_condition%& option
28280 and the result are placed in &$auth2$& and &$auth3$& resectively.
28281 If the expansion is forced to fail, authentication fails. Any other expansion
28282 failure causes a temporary error code to be returned.
28283
28284 They can be used to clarify the coding of a complex &%server_condition%&.
28285
28286 .section "Using external in a server" "SECTexternserver"
28287 .cindex "AUTH" "in &(external)& authenticator"
28288 .cindex "numerical variables (&$1$& &$2$& etc)" &&&
28289         "in &(external)& authenticator"
28290 .vindex "&$auth1$&, &$auth2$&, etc"
28291 .cindex "base64 encoding" "in &(external)& authenticator"
28292
28293 When running as a server, &(external)& performs the authentication test by
28294 expanding a string. The data sent by the client with the AUTH command, or in
28295 response to subsequent prompts, is base64 encoded, and so may contain any byte
28296 values when decoded. The decoded value is treated as
28297 an identity for authentication and
28298 placed in the expansion variable &$auth1$&.
28299
28300 For compatibility with previous releases of Exim, the value is also placed in
28301 the expansion variable &$1$&. However, the use of this
28302 variable for this purpose is now deprecated, as it can lead to confusion in
28303 string expansions that also use them for other things.
28304
28305 .vindex "&$authenticated_id$&"
28306 Once an identity has been received,
28307 &%server_condition%& is expanded. If the expansion is forced to fail,
28308 authentication fails. Any other expansion failure causes a temporary error code
28309 to be returned. If the result of a successful expansion is an empty string,
28310 &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
28311 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds and the
28312 generic &%server_set_id%& option is expanded and saved in &$authenticated_id$&.
28313 For any other result, a temporary error code is returned, with the expanded
28314 string as the error text.
28315
28316 Example:
28317 .code
28318 ext_ccert_san_mail:
28319   driver =            external
28320   public_name =       EXTERNAL
28321
28322   server_advertise_condition = $tls_in_certificate_verified
28323   server_param2 =     ${certextract {subj_altname,mail,>:} \
28324                                     {$tls_in_peercert}}
28325   server_condition =  ${if forany {$auth2} \
28326                             {eq {$item}{$auth1}}}
28327   server_set_id =     $auth1
28328 .endd
28329 This accepts a client certificate that is verifiable against any
28330 of your configured trust-anchors
28331 (which usually means the full set of public CAs)
28332 and which has a mail-SAN matching the claimed identity sent by the client.
28333
28334 &*Note*&: up to TLS1.2, the client cert is on the wire in-clear, including the SAN.
28335 The account name is therefore guessable by an opponent.
28336 TLS 1.3 protects both server and client certificates, and is not vulnerable
28337 in this way.
28338
28339
28340 .section "Using external in a client" "SECTexternclient"
28341 .cindex "options" "&(external)& authenticator (client)"
28342 The &(external)& authenticator has one client option:
28343
28344 .option client_send external string&!! unset
28345 This option is expanded and sent with the AUTH command as the
28346 identity being asserted.
28347
28348 Example:
28349 .code
28350 ext_ccert:
28351   driver =      external
28352   public_name = EXTERNAL
28353
28354   client_condition = ${if !eq{$tls_out_cipher}{}}
28355   client_send = myaccount@smarthost.example.net
28356 .endd
28357
28358
28359 .ecindex IIDexternauth1
28360 .ecindex IIDexternauth2
28361
28362
28363
28364
28365
28366 . ////////////////////////////////////////////////////////////////////////////
28367 . ////////////////////////////////////////////////////////////////////////////
28368
28369 .chapter "The tls authenticator" "CHAPtlsauth"
28370 .scindex IIDtlsauth1 "&(tls)& authenticator"
28371 .scindex IIDtlsauth2 "authenticators" "&(tls)&"
28372 .cindex "authentication" "Client Certificate"
28373 .cindex "authentication" "X509"
28374 .cindex "Certificate-based authentication"
28375 The &(tls)& authenticator provides server support for
28376 authentication based on client certificates.
28377
28378 It is not an SMTP authentication mechanism and is not
28379 advertised by the server as part of the SMTP EHLO response.
28380 It is an Exim authenticator in the sense that it affects
28381 the protocol element of the log line, can be tested for
28382 by the &%authenticated%& ACL condition, and can set
28383 the &$authenticated_id$& variable.
28384
28385 The client must present a verifiable certificate,
28386 for which it must have been requested via the
28387 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& main options
28388 (see &<<CHAPTLS>>&).
28389
28390 If an authenticator of this type is configured it is
28391 run before any SMTP-level communication is done,
28392 and can authenticate the connection.
28393 If it does, SMTP authentication is not offered.
28394
28395 A maximum of one authenticator of this type may be present.
28396
28397
28398 .cindex "options" "&(tls)& authenticator (server)"
28399 The &(tls)& authenticator has three server options:
28400
28401 .option server_param1 tls string&!! unset
28402 .cindex "variables (&$auth1$& &$auth2$& etc)" "in &(tls)& authenticator"
28403 This option is expanded after the TLS negotiation and
28404 the result is placed in &$auth1$&.
28405 If the expansion is forced to fail, authentication fails. Any other expansion
28406 failure causes a temporary error code to be returned.
28407
28408 .option server_param2 tls string&!! unset
28409 .option server_param3 tls string&!! unset
28410 As above, for &$auth2$& and &$auth3$&.
28411
28412 &%server_param1%& may also be spelled &%server_param%&.
28413
28414
28415 Example:
28416 .code
28417 tls:
28418   driver = tls
28419   server_param1 =     ${certextract {subj_altname,mail,>:} \
28420                                     {$tls_in_peercert}}
28421   server_condition =  ${if and { {eq{$tls_in_certificate_verified}{1}} \
28422                                  {forany {$auth1} \
28423                             {!= {0} \
28424                                 {${lookup ldap{ldap:///\
28425                          mailname=${quote_ldap_dn:${lc:$item}},\
28426                          ou=users,LDAP_DC?mailid} {$value}{0} \
28427                        }    }  } }}}
28428   server_set_id =     ${if = {1}{${listcount:$auth1}} {$auth1}{}}
28429 .endd
28430 This accepts a client certificate that is verifiable against any
28431 of your configured trust-anchors
28432 (which usually means the full set of public CAs)
28433 and which has a SAN with a good account name.
28434
28435 Note that, up to TLS1.2, the client cert is on the wire in-clear, including the SAN,
28436 The account name is therefore guessable by an opponent.
28437 TLS 1.3 protects both server and client certificates, and is not vulnerable
28438 in this way.
28439 Likewise, a traditional plaintext SMTP AUTH done inside TLS is not.
28440
28441 . An alternative might use
28442 . .code
28443 .   server_param1 = ${sha256:$tls_in_peercert}
28444 . .endd
28445 . to require one of a set of specific certs that define a given account
28446 . (the verification is still required, but mostly irrelevant).
28447 . This would help for per-device use.
28448 .
28449 . However, for the future we really need support for checking a
28450 . user cert in LDAP - which probably wants a base-64 DER.
28451
28452 .ecindex IIDtlsauth1
28453 .ecindex IIDtlsauth2
28454
28455
28456 Note that because authentication is traditionally an SMTP operation,
28457 the &%authenticated%& ACL condition cannot be used in
28458 a connect- or helo-ACL.
28459
28460
28461
28462 . ////////////////////////////////////////////////////////////////////////////
28463 . ////////////////////////////////////////////////////////////////////////////
28464
28465 .chapter "Encrypted SMTP connections using TLS/SSL" "CHAPTLS" &&&
28466          "Encrypted SMTP connections"
28467 .scindex IIDencsmtp1 "encryption" "on SMTP connection"
28468 .scindex IIDencsmtp2 "SMTP" "encryption"
28469 .cindex "TLS" "on SMTP connection"
28470 .cindex "OpenSSL"
28471 .cindex "GnuTLS"
28472 Support for TLS (Transport Layer Security), formerly known as SSL (Secure
28473 Sockets Layer), is implemented by making use of the OpenSSL library or the
28474 GnuTLS library (Exim requires GnuTLS release 1.0 or later). There is no
28475 cryptographic code in the Exim distribution itself for implementing TLS. In
28476 order to use this feature you must install OpenSSL or GnuTLS, and then build a
28477 version of Exim that includes TLS support (see section &<<SECTinctlsssl>>&).
28478 You also need to understand the basic concepts of encryption at a managerial
28479 level, and in particular, the way that public keys, private keys, and
28480 certificates are used.
28481
28482 RFC 3207 defines how SMTP connections can make use of encryption. Once a
28483 connection is established, the client issues a STARTTLS command. If the
28484 server accepts this, the client and the server negotiate an encryption
28485 mechanism. If the negotiation succeeds, the data that subsequently passes
28486 between them is encrypted.
28487
28488 Exim's ACLs can detect whether the current SMTP session is encrypted or not,
28489 and if so, what cipher suite is in use, whether the client supplied a
28490 certificate, and whether or not that certificate was verified. This makes it
28491 possible for an Exim server to deny or accept certain commands based on the
28492 encryption state.
28493
28494 &*Warning*&: Certain types of firewall and certain anti-virus products can
28495 disrupt TLS connections. You need to turn off SMTP scanning for these products
28496 in order to get TLS to work.
28497
28498
28499
28500 .section "Support for the &""submissions""& (aka &""ssmtp""& and &""smtps""&) protocol" &&&
28501          "SECID284"
28502 .cindex "submissions protocol"
28503 .cindex "ssmtp protocol"
28504 .cindex "smtps protocol"
28505 .cindex "SMTP" "submissions protocol"
28506 .cindex "SMTP" "ssmtp protocol"
28507 .cindex "SMTP" "smtps protocol"
28508 The history of port numbers for TLS in SMTP is a little messy and has been
28509 contentious.  As of RFC 8314, the common practice of using the historically
28510 allocated port 465 for "email submission but with TLS immediately upon connect
28511 instead of using STARTTLS" is officially blessed by the IETF, and recommended
28512 by them in preference to STARTTLS.
28513
28514 The name originally assigned to the port was &"ssmtp"& or &"smtps"&, but as
28515 clarity emerged over the dual roles of SMTP, for MX delivery and Email
28516 Submission, nomenclature has shifted.  The modern name is now &"submissions"&.
28517
28518 This approach was, for a while, officially abandoned when encrypted SMTP was
28519 standardized, but many clients kept using it, even as the TCP port number was
28520 reassigned for other use.
28521 Thus you may encounter guidance claiming that you shouldn't enable use of
28522 this port.
28523 In practice, a number of mail-clients have only ever supported submissions,
28524 not submission with STARTTLS upgrade.
28525 Ideally, offer both submission (587) and submissions (465) service.
28526
28527 Exim supports TLS-on-connect by means of the &%tls_on_connect_ports%&
28528 global option. Its value must be a list of port numbers;
28529 the most common use is expected to be:
28530 .code
28531 tls_on_connect_ports = 465
28532 .endd
28533 The port numbers specified by this option apply to all SMTP connections, both
28534 via the daemon and via &'inetd'&. You still need to specify all the ports that
28535 the daemon uses (by setting &%daemon_smtp_ports%& or &%local_interfaces%& or
28536 the &%-oX%& command line option) because &%tls_on_connect_ports%& does not add
28537 an extra port &-- rather, it specifies different behaviour on a port that is
28538 defined elsewhere.
28539
28540 There is also a &%-tls-on-connect%& command line option. This overrides
28541 &%tls_on_connect_ports%&; it forces the TLS-only behaviour for all ports.
28542
28543
28544
28545
28546
28547
28548 .section "OpenSSL vs GnuTLS" "SECTopenvsgnu"
28549 .cindex "TLS" "OpenSSL &'vs'& GnuTLS"
28550 TLS is supported in Exim using either the OpenSSL or GnuTLS library.
28551 To build Exim to use OpenSSL you need to set
28552 .code
28553 USE_OPENSSL=yes
28554 .endd
28555 in Local/Makefile.
28556
28557 To build Exim to use GnuTLS, you need to set
28558 .code
28559 USE_GNUTLS=yes
28560 .endd
28561 in Local/Makefile.
28562
28563 You must also set TLS_LIBS and TLS_INCLUDE appropriately, so that the
28564 include files and libraries for GnuTLS can be found.
28565
28566 There are some differences in usage when using GnuTLS instead of OpenSSL:
28567
28568 .ilist
28569 The &%tls_verify_certificates%& option
28570 cannot be the path of a directory
28571 for GnuTLS versions before 3.3.6
28572 (for later versions, or OpenSSL, it can be either).
28573 .next
28574 The default value for &%tls_dhparam%& differs for historical reasons.
28575 .next
28576 .vindex "&$tls_in_peerdn$&"
28577 .vindex "&$tls_out_peerdn$&"
28578 Distinguished Name (DN) strings reported by the OpenSSL library use a slash for
28579 separating fields; GnuTLS uses commas, in accordance with RFC 2253. This
28580 affects the value of the &$tls_in_peerdn$& and &$tls_out_peerdn$& variables.
28581 .next
28582 OpenSSL identifies cipher suites using hyphens as separators, for example:
28583 DES-CBC3-SHA. GnuTLS historically used underscores, for example:
28584 RSA_ARCFOUR_SHA. What is more, OpenSSL complains if underscores are present
28585 in a cipher list. To make life simpler, Exim changes underscores to hyphens
28586 for OpenSSL and passes the string unchanged to GnuTLS (expecting the library
28587 to handle its own older variants) when processing lists of cipher suites in the
28588 &%tls_require_ciphers%& options (the global option and the &(smtp)& transport
28589 option).
28590 .next
28591 The &%tls_require_ciphers%& options operate differently, as described in the
28592 sections &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
28593 .next
28594 The &%tls_dh_min_bits%& SMTP transport option is only honoured by GnuTLS.
28595 When using OpenSSL, this option is ignored.
28596 (If an API is found to let OpenSSL be configured in this way,
28597 let the Exim Maintainers know and we'll likely use it).
28598 .next
28599 With GnuTLS, if an explicit list is used for the &%tls_privatekey%& main option
28600 main option, it must be ordered to match the &%tls_certificate%& list.
28601 .next
28602 Some other recently added features may only be available in one or the other.
28603 This should be documented with the feature.  If the documentation does not
28604 explicitly state that the feature is infeasible in the other TLS
28605 implementation, then patches are welcome.
28606 .endlist
28607
28608
28609 .section "GnuTLS parameter computation" "SECTgnutlsparam"
28610 This section only applies if &%tls_dhparam%& is set to &`historic`& or to
28611 an explicit path; if the latter, then the text about generation still applies,
28612 but not the chosen filename.
28613 By default, as of Exim 4.80 a hard-coded D-H prime is used.
28614 See the documentation of &%tls_dhparam%& for more information.
28615
28616 GnuTLS uses D-H parameters that may take a substantial amount of time
28617 to compute. It is unreasonable to re-compute them for every TLS session.
28618 Therefore, Exim keeps this data in a file in its spool directory, called
28619 &_gnutls-params-NNNN_& for some value of NNNN, corresponding to the number
28620 of bits requested.
28621 The file is owned by the Exim user and is readable only by
28622 its owner. Every Exim process that start up GnuTLS reads the D-H
28623 parameters from this file. If the file does not exist, the first Exim process
28624 that needs it computes the data and writes it to a temporary file which is
28625 renamed once it is complete. It does not matter if several Exim processes do
28626 this simultaneously (apart from wasting a few resources). Once a file is in
28627 place, new Exim processes immediately start using it.
28628
28629 For maximum security, the parameters that are stored in this file should be
28630 recalculated periodically, the frequency depending on your paranoia level.
28631 If you are avoiding using the fixed D-H primes published in RFCs, then you
28632 are concerned about some advanced attacks and will wish to do this; if you do
28633 not regenerate then you might as well stick to the standard primes.
28634
28635 Arranging this is easy in principle; just delete the file when you want new
28636 values to be computed. However, there may be a problem. The calculation of new
28637 parameters needs random numbers, and these are obtained from &_/dev/random_&.
28638 If the system is not very active, &_/dev/random_& may delay returning data
28639 until enough randomness (entropy) is available. This may cause Exim to hang for
28640 a substantial amount of time, causing timeouts on incoming connections.
28641
28642 The solution is to generate the parameters externally to Exim. They are stored
28643 in &_gnutls-params-N_& in PEM format, which means that they can be
28644 generated externally using the &(certtool)& command that is part of GnuTLS.
28645
28646 To replace the parameters with new ones, instead of deleting the file
28647 and letting Exim re-create it, you can generate new parameters using
28648 &(certtool)& and, when this has been done, replace Exim's cache file by
28649 renaming. The relevant commands are something like this:
28650 .code
28651 # ls
28652 [ look for file; assume gnutls-params-2236 is the most recent ]
28653 # rm -f new-params
28654 # touch new-params
28655 # chown exim:exim new-params
28656 # chmod 0600 new-params
28657 # certtool --generate-dh-params --bits 2236 >>new-params
28658 # openssl dhparam -noout -text -in new-params | head
28659 [ check the first line, make sure it's not more than 2236;
28660   if it is, then go back to the start ("rm") and repeat
28661   until the size generated is at most the size requested ]
28662 # chmod 0400 new-params
28663 # mv new-params gnutls-params-2236
28664 .endd
28665 If Exim never has to generate the parameters itself, the possibility of
28666 stalling is removed.
28667
28668 The filename changed in Exim 4.80, to gain the -bits suffix.  The value which
28669 Exim will choose depends upon the version of GnuTLS in use.  For older GnuTLS,
28670 the value remains hard-coded in Exim as 1024.  As of GnuTLS 2.12.x, there is
28671 a way for Exim to ask for the "normal" number of bits for D-H public-key usage,
28672 and Exim does so.  This attempt to remove Exim from TLS policy decisions
28673 failed, as GnuTLS 2.12 returns a value higher than the current hard-coded limit
28674 of the NSS library.  Thus Exim gains the &%tls_dh_max_bits%& global option,
28675 which applies to all D-H usage, client or server.  If the value returned by
28676 GnuTLS is greater than &%tls_dh_max_bits%& then the value will be clamped down
28677 to &%tls_dh_max_bits%&.  The default value has been set at the current NSS
28678 limit, which is still much higher than Exim historically used.
28679
28680 The filename and bits used will change as the GnuTLS maintainers change the
28681 value for their parameter &`GNUTLS_SEC_PARAM_NORMAL`&, as clamped by
28682 &%tls_dh_max_bits%&.  At the time of writing (mid 2012), GnuTLS 2.12 recommends
28683 2432 bits, while NSS is limited to 2236 bits.
28684
28685 In fact, the requested value will be *lower* than &%tls_dh_max_bits%&, to
28686 increase the chance of the generated prime actually being within acceptable
28687 bounds, as GnuTLS has been observed to overshoot.  Note the check step in the
28688 procedure above.  There is no sane procedure available to Exim to double-check
28689 the size of the generated prime, so it might still be too large.
28690
28691
28692 .section "Requiring specific ciphers in OpenSSL" "SECTreqciphssl"
28693 .cindex "TLS" "requiring specific ciphers (OpenSSL)"
28694 .oindex "&%tls_require_ciphers%&" "OpenSSL"
28695 There is a function in the OpenSSL library that can be passed a list of cipher
28696 suites before the cipher negotiation takes place. This specifies which ciphers
28697 are acceptable for TLS versions prior to 1.3.
28698 The list is colon separated and may contain names like
28699 DES-CBC3-SHA. Exim passes the expanded value of &%tls_require_ciphers%&
28700 directly to this function call.
28701 Many systems will install the OpenSSL manual-pages, so you may have
28702 &'ciphers(1)'& available to you.
28703 The following quotation from the OpenSSL
28704 documentation specifies what forms of item are allowed in the cipher string:
28705
28706 .ilist
28707 It can consist of a single cipher suite such as RC4-SHA.
28708 .next
28709 It can represent a list of cipher suites containing a certain algorithm,
28710 or cipher suites of a certain type. For example SHA1 represents all
28711 ciphers suites using the digest algorithm SHA1 and SSLv3 represents all
28712 SSL v3 algorithms.
28713 .next
28714 Lists of cipher suites can be combined in a single cipher string using
28715 the + character. This is used as a logical and operation. For example
28716 SHA1+DES represents all cipher suites containing the SHA1 and the DES
28717 algorithms.
28718 .endlist
28719
28720 Each cipher string can be optionally preceded by one of the characters &`!`&,
28721 &`-`& or &`+`&.
28722 .ilist
28723 If &`!`& is used, the ciphers are permanently deleted from the list. The
28724 ciphers deleted can never reappear in the list even if they are explicitly
28725 stated.
28726 .next
28727 If &`-`& is used, the ciphers are deleted from the list, but some or all
28728 of the ciphers can be added again by later options.
28729 .next
28730 If &`+`& is used, the ciphers are moved to the end of the list. This
28731 option does not add any new ciphers; it just moves matching existing ones.
28732 .endlist
28733
28734 If none of these characters is present, the string is interpreted as
28735 a list of ciphers to be appended to the current preference list. If the list
28736 includes any ciphers already present they will be ignored: that is, they will
28737 not be moved to the end of the list.
28738 .endlist
28739
28740 The OpenSSL &'ciphers(1)'& command may be used to test the results of a given
28741 string:
28742 .code
28743 # note single-quotes to get ! past any shell history expansion
28744 $ openssl ciphers 'HIGH:!MD5:!SHA1'
28745 .endd
28746
28747 This example will let the library defaults be permitted on the MX port, where
28748 there's probably no identity verification anyway, but ups the ante on the
28749 submission ports where the administrator might have some influence on the
28750 choice of clients used:
28751 .code
28752 # OpenSSL variant; see man ciphers(1)
28753 tls_require_ciphers = ${if =={$received_port}{25}\
28754                            {DEFAULT}\
28755                            {HIGH:!MD5:!SHA1}}
28756 .endd
28757
28758 This example will prefer ECDSA-authenticated ciphers over RSA ones:
28759 .code
28760 tls_require_ciphers = ECDSA:RSA:!COMPLEMENTOFDEFAULT
28761 .endd
28762
28763 For TLS version 1.3 the control available is less fine-grained
28764 and Exim does not provide access to it at present.
28765 The value of the &%tls_require_ciphers%& option is ignored when
28766 TLS version 1.3 is negotiated.
28767
28768 As of writing the library default cipher suite list for TLSv1.3 is
28769 .code
28770 TLS_AES_256_GCM_SHA384:TLS_CHACHA20_POLY1305_SHA256:TLS_AES_128_GCM_SHA256
28771 .endd
28772
28773
28774 .section "Requiring specific ciphers or other parameters in GnuTLS" &&&
28775          "SECTreqciphgnu"
28776 .cindex "GnuTLS" "specifying parameters for"
28777 .cindex "TLS" "specifying ciphers (GnuTLS)"
28778 .cindex "TLS" "specifying key exchange methods (GnuTLS)"
28779 .cindex "TLS" "specifying MAC algorithms (GnuTLS)"
28780 .cindex "TLS" "specifying protocols (GnuTLS)"
28781 .cindex "TLS" "specifying priority string (GnuTLS)"
28782 .oindex "&%tls_require_ciphers%&" "GnuTLS"
28783 The GnuTLS library allows the caller to provide a "priority string", documented
28784 as part of the &[gnutls_priority_init]& function.  This is very similar to the
28785 ciphersuite specification in OpenSSL.
28786
28787 The &%tls_require_ciphers%& option is treated as the GnuTLS priority string
28788 and controls both protocols and ciphers.
28789
28790 The &%tls_require_ciphers%& option is available both as an global option,
28791 controlling how Exim behaves as a server, and also as an option of the
28792 &(smtp)& transport, controlling how Exim behaves as a client.  In both cases
28793 the value is string expanded.  The resulting string is not an Exim list and
28794 the string is given to the GnuTLS library, so that Exim does not need to be
28795 aware of future feature enhancements of GnuTLS.
28796
28797 Documentation of the strings accepted may be found in the GnuTLS manual, under
28798 "Priority strings".  This is online as
28799 &url(https://www.gnutls.org/manual/html_node/Priority-Strings.html),
28800 but beware that this relates to GnuTLS 3, which may be newer than the version
28801 installed on your system.  If you are using GnuTLS 3,
28802 then the example code
28803 &url(https://www.gnutls.org/manual/gnutls.html#Listing-the-ciphersuites-in-a-priority-string)
28804 on that site can be used to test a given string.
28805
28806 For example:
28807 .code
28808 # Disable older versions of protocols
28809 tls_require_ciphers = NORMAL:%LATEST_RECORD_VERSION:-VERS-SSL3.0
28810 .endd
28811
28812 Prior to Exim 4.80, an older API of GnuTLS was used, and Exim supported three
28813 additional options, "&%gnutls_require_kx%&", "&%gnutls_require_mac%&" and
28814 "&%gnutls_require_protocols%&".  &%tls_require_ciphers%& was an Exim list.
28815
28816 This example will let the library defaults be permitted on the MX port, where
28817 there's probably no identity verification anyway, and lowers security further
28818 by increasing compatibility; but this ups the ante on the submission ports
28819 where the administrator might have some influence on the choice of clients
28820 used:
28821 .code
28822 # GnuTLS variant
28823 tls_require_ciphers = ${if =={$received_port}{25}\
28824                            {NORMAL:%COMPAT}\
28825                            {SECURE128}}
28826 .endd
28827
28828
28829 .section "Configuring an Exim server to use TLS" "SECID182"
28830 .cindex "TLS" "configuring an Exim server"
28831 .cindex "ESMTP extensions" STARTTLS
28832 When Exim has been built with TLS support, it advertises the availability of
28833 the STARTTLS command to client hosts that match &%tls_advertise_hosts%&,
28834 but not to any others. The default value of this option is *, which means
28835 that STARTTLS is always advertised.  Set it to blank to never advertise;
28836 this is reasonable for systems that want to use TLS only as a client.
28837
28838 If STARTTLS is to be used you
28839 need to set some other options in order to make TLS available.
28840
28841 If a client issues a STARTTLS command and there is some configuration
28842 problem in the server, the command is rejected with a 454 error. If the client
28843 persists in trying to issue SMTP commands, all except QUIT are rejected
28844 with the error
28845 .code
28846 554 Security failure
28847 .endd
28848 If a STARTTLS command is issued within an existing TLS session, it is
28849 rejected with a 554 error code.
28850
28851 To enable TLS operations on a server, the &%tls_advertise_hosts%& option
28852 must be set to match some hosts. The default is * which matches all hosts.
28853
28854 If this is all you do, TLS encryption will be enabled but not authentication -
28855 meaning that the peer has no assurance it is actually you he is talking to.
28856 You gain protection from a passive sniffer listening on the wire but not
28857 from someone able to intercept the communication.
28858
28859 Further protection requires some further configuration at the server end.
28860
28861 To make TLS work you need to set, in the server,
28862 .code
28863 tls_certificate = /some/file/name
28864 tls_privatekey = /some/file/name
28865 .endd
28866 These options are, in fact, expanded strings, so you can make them depend on
28867 the identity of the client that is connected if you wish. The first file
28868 contains the server's X509 certificate, and the second contains the private key
28869 that goes with it. These files need to be
28870 PEM format and readable by the Exim user, and must
28871 always be given as full path names.
28872 The key must not be password-protected.
28873 They can be the same file if both the
28874 certificate and the key are contained within it. If &%tls_privatekey%& is not
28875 set, or if its expansion is forced to fail or results in an empty string, this
28876 is assumed to be the case. The certificate file may also contain intermediate
28877 certificates that need to be sent to the client to enable it to authenticate
28878 the server's certificate.
28879
28880 For dual-stack (eg. RSA and ECDSA) configurations, these options can be
28881 colon-separated lists of file paths.  Ciphers using given authentication
28882 algorithms require the presence of a suitable certificate to supply the
28883 public-key.  The server selects among the certificates to present to the
28884 client depending on the selected cipher, hence the priority ordering for
28885 ciphers will affect which certificate is used.
28886
28887 If you do not understand about certificates and keys, please try to find a
28888 source of this background information, which is not Exim-specific. (There are a
28889 few comments below in section &<<SECTcerandall>>&.)
28890
28891 &*Note*&: These options do not apply when Exim is operating as a client &--
28892 they apply only in the case of a server. If you need to use a certificate in an
28893 Exim client, you must set the options of the same names in an &(smtp)&
28894 transport.
28895
28896 With just these options, an Exim server will be able to use TLS. It does not
28897 require the client to have a certificate (but see below for how to insist on
28898 this). There is one other option that may be needed in other situations. If
28899 .code
28900 tls_dhparam = /some/file/name
28901 .endd
28902 is set, the SSL library is initialized for the use of Diffie-Hellman ciphers
28903 with the parameters contained in the file.
28904 Set this to &`none`& to disable use of DH entirely, by making no prime
28905 available:
28906 .code
28907 tls_dhparam = none
28908 .endd
28909 This may also be set to a string identifying a standard prime to be used for
28910 DH; if it is set to &`default`& or, for OpenSSL, is unset, then the prime
28911 used is &`ike23`&.  There are a few standard primes available, see the
28912 documentation for &%tls_dhparam%& for the complete list.
28913
28914 See the command
28915 .code
28916 openssl dhparam
28917 .endd
28918 for a way of generating file data.
28919
28920 The strings supplied for these three options are expanded every time a client
28921 host connects. It is therefore possible to use different certificates and keys
28922 for different hosts, if you so wish, by making use of the client's IP address
28923 in &$sender_host_address$& to control the expansion. If a string expansion is
28924 forced to fail, Exim behaves as if the option is not set.
28925
28926 .cindex "cipher" "logging"
28927 .cindex "log" "TLS cipher"
28928 .vindex "&$tls_in_cipher$&"
28929 The variable &$tls_in_cipher$& is set to the cipher suite that was negotiated for
28930 an incoming TLS connection. It is included in the &'Received:'& header of an
28931 incoming message (by default &-- you can, of course, change this), and it is
28932 also included in the log line that records a message's arrival, keyed by
28933 &"X="&, unless the &%tls_cipher%& log selector is turned off. The &%encrypted%&
28934 condition can be used to test for specific cipher suites in ACLs.
28935
28936 Once TLS has been established, the ACLs that run for subsequent SMTP commands
28937 can check the name of the cipher suite and vary their actions accordingly. The
28938 cipher suite names vary, depending on which TLS library is being used. For
28939 example, OpenSSL uses the name DES-CBC3-SHA for the cipher suite which in other
28940 contexts is known as TLS_RSA_WITH_3DES_EDE_CBC_SHA. Check the OpenSSL or GnuTLS
28941 documentation for more details.
28942
28943 For outgoing SMTP deliveries, &$tls_out_cipher$& is used and logged
28944 (again depending on the &%tls_cipher%& log selector).
28945
28946
28947 .section "Requesting and verifying client certificates" "SECID183"
28948 .cindex "certificate" "verification of client"
28949 .cindex "TLS" "client certificate verification"
28950 If you want an Exim server to request a certificate when negotiating a TLS
28951 session with a client, you must set either &%tls_verify_hosts%& or
28952 &%tls_try_verify_hosts%&. You can, of course, set either of them to * to
28953 apply to all TLS connections. For any host that matches one of these options,
28954 Exim requests a certificate as part of the setup of the TLS session. The
28955 contents of the certificate are verified by comparing it with a list of
28956 expected trust-anchors or certificates.
28957 These may be the system default set (depending on library version),
28958 an explicit file or,
28959 depending on library version, a directory, identified by
28960 &%tls_verify_certificates%&.
28961
28962 A file can contain multiple certificates, concatenated end to end. If a
28963 directory is used
28964 (OpenSSL only),
28965 each certificate must be in a separate file, with a name (or a symbolic link)
28966 of the form <&'hash'&>.0, where <&'hash'&> is a hash value constructed from the
28967 certificate. You can compute the relevant hash by running the command
28968 .code
28969 openssl x509 -hash -noout -in /cert/file
28970 .endd
28971 where &_/cert/file_& contains a single certificate.
28972
28973 There is no checking of names of the client against the certificate
28974 Subject Name or Subject Alternate Names.
28975
28976 The difference between &%tls_verify_hosts%& and &%tls_try_verify_hosts%& is
28977 what happens if the client does not supply a certificate, or if the certificate
28978 does not match any of the certificates in the collection named by
28979 &%tls_verify_certificates%&. If the client matches &%tls_verify_hosts%&, the
28980 attempt to set up a TLS session is aborted, and the incoming connection is
28981 dropped. If the client matches &%tls_try_verify_hosts%&, the (encrypted) SMTP
28982 session continues. ACLs that run for subsequent SMTP commands can detect the
28983 fact that no certificate was verified, and vary their actions accordingly. For
28984 example, you can insist on a certificate before accepting a message for
28985 relaying, but not when the message is destined for local delivery.
28986
28987 .vindex "&$tls_in_peerdn$&"
28988 When a client supplies a certificate (whether it verifies or not), the value of
28989 the Distinguished Name of the certificate is made available in the variable
28990 &$tls_in_peerdn$& during subsequent processing of the message.
28991
28992 .cindex "log" "distinguished name"
28993 Because it is often a long text string, it is not included in the log line or
28994 &'Received:'& header by default. You can arrange for it to be logged, keyed by
28995 &"DN="&, by setting the &%tls_peerdn%& log selector, and you can use
28996 &%received_header_text%& to change the &'Received:'& header. When no
28997 certificate is supplied, &$tls_in_peerdn$& is empty.
28998
28999
29000 .section "Revoked certificates" "SECID184"
29001 .cindex "TLS" "revoked certificates"
29002 .cindex "revocation list"
29003 .cindex "certificate" "revocation list"
29004 .cindex "OCSP" "stapling"
29005 Certificate issuing authorities issue Certificate Revocation Lists (CRLs) when
29006 certificates are revoked. If you have such a list, you can pass it to an Exim
29007 server using the global option called &%tls_crl%& and to an Exim client using
29008 an identically named option for the &(smtp)& transport. In each case, the value
29009 of the option is expanded and must then be the name of a file that contains a
29010 CRL in PEM format.
29011 The downside is that clients have to periodically re-download a potentially huge
29012 file from every certificate authority they know of.
29013
29014 The way with most moving parts at query time is Online Certificate
29015 Status Protocol (OCSP), where the client verifies the certificate
29016 against an OCSP server run by the CA.  This lets the CA track all
29017 usage of the certs.  It requires running software with access to the
29018 private key of the CA, to sign the responses to the OCSP queries.  OCSP
29019 is based on HTTP and can be proxied accordingly.
29020
29021 The only widespread OCSP server implementation (known to this writer)
29022 comes as part of OpenSSL and aborts on an invalid request, such as
29023 connecting to the port and then disconnecting.  This requires
29024 re-entering the passphrase each time some random client does this.
29025
29026 The third way is OCSP Stapling; in this, the server using a certificate
29027 issued by the CA periodically requests an OCSP proof of validity from
29028 the OCSP server, then serves it up inline as part of the TLS
29029 negotiation.   This approach adds no extra round trips, does not let the
29030 CA track users, scales well with number of certs issued by the CA and is
29031 resilient to temporary OCSP server failures, as long as the server
29032 starts retrying to fetch an OCSP proof some time before its current
29033 proof expires.  The downside is that it requires server support.
29034
29035 Unless Exim is built with the support disabled,
29036 or with GnuTLS earlier than version 3.3.16 / 3.4.8
29037 support for OCSP stapling is included.
29038
29039 There is a global option called &%tls_ocsp_file%&.
29040 The file specified therein is expected to be in DER format, and contain
29041 an OCSP proof.  Exim will serve it as part of the TLS handshake.  This
29042 option will be re-expanded for SNI, if the &%tls_certificate%& option
29043 contains &`tls_in_sni`&, as per other TLS options.
29044
29045 Exim does not at this time implement any support for fetching a new OCSP
29046 proof.  The burden is on the administrator to handle this, outside of
29047 Exim.  The file specified should be replaced atomically, so that the
29048 contents are always valid.  Exim will expand the &%tls_ocsp_file%& option
29049 on each connection, so a new file will be handled transparently on the
29050 next connection.
29051
29052 When built with OpenSSL Exim will check for a valid next update timestamp
29053 in the OCSP proof; if not present, or if the proof has expired, it will be
29054 ignored.
29055
29056 For the client to be able to verify the stapled OCSP the server must
29057 also supply, in its stapled information, any intermediate
29058 certificates for the chain leading to the OCSP proof from the signer
29059 of the server certificate.  There may be zero or one such. These
29060 intermediate certificates should be added to the server OCSP stapling
29061 file named by &%tls_ocsp_file%&.
29062
29063 Note that the proof only covers the terminal server certificate,
29064 not any of the chain from CA to it.
29065
29066 There is no current way to staple a proof for a client certificate.
29067
29068 .code
29069   A helper script "ocsp_fetch.pl" for fetching a proof from a CA
29070   OCSP server is supplied.  The server URL may be included in the
29071   server certificate, if the CA is helpful.
29072
29073   One failure mode seen was the OCSP Signer cert expiring before the end
29074   of validity of the OCSP proof. The checking done by Exim/OpenSSL
29075   noted this as invalid overall, but the re-fetch script did not.
29076 .endd
29077
29078
29079
29080
29081 .section "Configuring an Exim client to use TLS" "SECTclientTLS"
29082 .cindex "cipher" "logging"
29083 .cindex "log" "TLS cipher"
29084 .cindex "log" "distinguished name"
29085 .cindex "TLS" "configuring an Exim client"
29086 The &%tls_cipher%& and &%tls_peerdn%& log selectors apply to outgoing SMTP
29087 deliveries as well as to incoming, the latter one causing logging of the
29088 server certificate's DN. The remaining client configuration for TLS is all
29089 within the &(smtp)& transport.
29090
29091 .cindex "ESMTP extensions" STARTTLS
29092 It is not necessary to set any options to have TLS work in the &(smtp)&
29093 transport. If Exim is built with TLS support, and TLS is advertised by a
29094 server, the &(smtp)& transport always tries to start a TLS session. However,
29095 this can be prevented by setting &%hosts_avoid_tls%& (an option of the
29096 transport) to a list of server hosts for which TLS should not be used.
29097
29098 If you do not want Exim to attempt to send messages unencrypted when an attempt
29099 to set up an encrypted connection fails in any way, you can set
29100 &%hosts_require_tls%& to a list of hosts for which encryption is mandatory. For
29101 those hosts, delivery is always deferred if an encrypted connection cannot be
29102 set up. If there are any other hosts for the address, they are tried in the
29103 usual way.
29104
29105 When the server host is not in &%hosts_require_tls%&, Exim may try to deliver
29106 the message unencrypted. It always does this if the response to STARTTLS is
29107 a 5&'xx'& code. For a temporary error code, or for a failure to negotiate a TLS
29108 session after a success response code, what happens is controlled by the
29109 &%tls_tempfail_tryclear%& option of the &(smtp)& transport. If it is false,
29110 delivery to this host is deferred, and other hosts (if available) are tried. If
29111 it is true, Exim attempts to deliver unencrypted after a 4&'xx'& response to
29112 STARTTLS, and if STARTTLS is accepted, but the subsequent TLS
29113 negotiation fails, Exim closes the current connection (because it is in an
29114 unknown state), opens a new one to the same host, and then tries the delivery
29115 unencrypted.
29116
29117 The &%tls_certificate%& and &%tls_privatekey%& options of the &(smtp)&
29118 transport provide the client with a certificate, which is passed to the server
29119 if it requests it. If the server is Exim, it will request a certificate only if
29120 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& matches the client.
29121
29122 &*Note*&: Do not use a certificate which has the OCSP-must-staple extension,
29123 for client use (they are usable for server use).
29124 As the TLS protocol has no means for the client to staple before TLS 1.3 it will result
29125 in failed connections.
29126
29127 If the &%tls_verify_certificates%& option is set on the &(smtp)& transport, it
29128 specifies a collection of expected server certificates.
29129 These may be
29130 the system default set (depending on library version),
29131 a file,
29132 or (depending on library version) a directory.
29133 The client verifies the server's certificate
29134 against this collection, taking into account any revoked certificates that are
29135 in the list defined by &%tls_crl%&.
29136 Failure to verify fails the TLS connection unless either of the
29137 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& options are set.
29138
29139 The &%tls_verify_hosts%& and &%tls_try_verify_hosts%& options restrict
29140 certificate verification to the listed servers.  Verification either must
29141 or need not succeed respectively.
29142
29143 The &%tls_verify_cert_hostnames%& option lists hosts for which additional
29144 checks are made: that the host name (the one in the DNS A record)
29145 is valid for the certificate.
29146 The option defaults to always checking.
29147
29148 The &(smtp)& transport has two OCSP-related options:
29149 &%hosts_require_ocsp%&; a host-list for which a Certificate Status
29150 is requested and required for the connection to proceed.  The default
29151 value is empty.
29152 &%hosts_request_ocsp%&; a host-list for which (additionally)
29153 a Certificate Status is requested (but not necessarily verified).  The default
29154 value is "*" meaning that requests are made unless configured
29155 otherwise.
29156
29157 The host(s) should also be in &%hosts_require_tls%&, and
29158 &%tls_verify_certificates%& configured for the transport,
29159 for OCSP to be relevant.
29160
29161 If
29162 &%tls_require_ciphers%& is set on the &(smtp)& transport, it must contain a
29163 list of permitted cipher suites. If either of these checks fails, delivery to
29164 the current host is abandoned, and the &(smtp)& transport tries to deliver to
29165 alternative hosts, if any.
29166
29167  &*Note*&:
29168 These options must be set in the &(smtp)& transport for Exim to use TLS when it
29169 is operating as a client. Exim does not assume that a server certificate (set
29170 by the global options of the same name) should also be used when operating as a
29171 client.
29172
29173 .vindex "&$host$&"
29174 .vindex "&$host_address$&"
29175 All the TLS options in the &(smtp)& transport are expanded before use, with
29176 &$host$& and &$host_address$& containing the name and address of the server to
29177 which the client is connected. Forced failure of an expansion causes Exim to
29178 behave as if the relevant option were unset.
29179
29180 .vindex &$tls_out_bits$&
29181 .vindex &$tls_out_cipher$&
29182 .vindex &$tls_out_peerdn$&
29183 .vindex &$tls_out_sni$&
29184 Before an SMTP connection is established, the
29185 &$tls_out_bits$&, &$tls_out_cipher$&, &$tls_out_peerdn$& and &$tls_out_sni$&
29186 variables are emptied. (Until the first connection, they contain the values
29187 that were set when the message was received.) If STARTTLS is subsequently
29188 successfully obeyed, these variables are set to the relevant values for the
29189 outgoing connection.
29190
29191
29192
29193 .section "Use of TLS Server Name Indication" "SECTtlssni"
29194 .cindex "TLS" "Server Name Indication"
29195 .vindex "&$tls_in_sni$&"
29196 .oindex "&%tls_in_sni%&"
29197 With TLS1.0 or above, there is an extension mechanism by which extra
29198 information can be included at various points in the protocol.  One of these
29199 extensions, documented in RFC 6066 (and before that RFC 4366) is
29200 &"Server Name Indication"&, commonly &"SNI"&.  This extension is sent by the
29201 client in the initial handshake, so that the server can examine the servername
29202 within and possibly choose to use different certificates and keys (and more)
29203 for this session.
29204
29205 This is analogous to HTTP's &"Host:"& header, and is the main mechanism by
29206 which HTTPS-enabled web-sites can be virtual-hosted, many sites to one IP
29207 address.
29208
29209 With SMTP to MX, there are the same problems here as in choosing the identity
29210 against which to validate a certificate: you can't rely on insecure DNS to
29211 provide the identity which you then cryptographically verify.  So this will
29212 be of limited use in that environment.
29213
29214 With SMTP to Submission, there is a well-defined hostname which clients are
29215 connecting to and can validate certificates against.  Thus clients &*can*&
29216 choose to include this information in the TLS negotiation.  If this becomes
29217 wide-spread, then hosters can choose to present different certificates to
29218 different clients.  Or even negotiate different cipher suites.
29219
29220 The &%tls_sni%& option on an SMTP transport is an expanded string; the result,
29221 if not empty, will be sent on a TLS session as part of the handshake.  There's
29222 nothing more to it.  Choosing a sensible value not derived insecurely is the
29223 only point of caution.  The &$tls_out_sni$& variable will be set to this string
29224 for the lifetime of the client connection (including during authentication).
29225
29226 Except during SMTP client sessions, if &$tls_in_sni$& is set then it is a string
29227 received from a client.
29228 It can be logged with the &%log_selector%& item &`+tls_sni`&.
29229
29230 If the string &`tls_in_sni`& appears in the main section's &%tls_certificate%&
29231 option (prior to expansion) then the following options will be re-expanded
29232 during TLS session handshake, to permit alternative values to be chosen:
29233
29234 .ilist
29235 &%tls_certificate%&
29236 .next
29237 &%tls_crl%&
29238 .next
29239 &%tls_privatekey%&
29240 .next
29241 &%tls_verify_certificates%&
29242 .next
29243 &%tls_ocsp_file%&
29244 .endlist
29245
29246 Great care should be taken to deal with matters of case, various injection
29247 attacks in the string (&`../`& or SQL), and ensuring that a valid filename
29248 can always be referenced; it is important to remember that &$tls_in_sni$& is
29249 arbitrary unverified data provided prior to authentication.
29250 Further, the initial certificate is loaded before SNI has arrived, so
29251 an expansion for &%tls_certificate%& must have a default which is used
29252 when &$tls_in_sni$& is empty.
29253
29254 The Exim developers are proceeding cautiously and so far no other TLS options
29255 are re-expanded.
29256
29257 When Exim is built against OpenSSL, OpenSSL must have been built with support
29258 for TLS Extensions.  This holds true for OpenSSL 1.0.0+ and 0.9.8+ with
29259 enable-tlsext in EXTRACONFIGURE.  If you invoke &(openssl s_client -h)& and
29260 see &`-servername`& in the output, then OpenSSL has support.
29261
29262 When Exim is built against GnuTLS, SNI support is available as of GnuTLS
29263 0.5.10.  (Its presence predates the current API which Exim uses, so if Exim
29264 built, then you have SNI support).
29265
29266
29267
29268 .section "Multiple messages on the same encrypted TCP/IP connection" &&&
29269          "SECTmulmessam"
29270 .cindex "multiple SMTP deliveries with TLS"
29271 .cindex "TLS" "multiple message deliveries"
29272 Exim sends multiple messages down the same TCP/IP connection by starting up
29273 an entirely new delivery process for each message, passing the socket from
29274 one process to the next. This implementation does not fit well with the use
29275 of TLS, because there is quite a lot of state information associated with a TLS
29276 connection, not just a socket identification. Passing all the state information
29277 to a new process is not feasible. Consequently, for sending using TLS Exim
29278 starts an additional proxy process for handling the encryption, piping the
29279 unencrypted data stream from and to the delivery processes.
29280
29281 An older mode of operation can be enabled on a per-host basis by the
29282 &%hosts_noproxy_tls%& option on the &(smtp)& transport.  If the host matches
29283 this list the proxy process described above is not used; instead Exim
29284 shuts down an existing TLS session being run by the delivery process
29285 before passing the socket to a new process. The new process may then
29286 try to start a new TLS session, and if successful, may try to re-authenticate
29287 if AUTH is in use, before sending the next message.
29288
29289 The RFC is not clear as to whether or not an SMTP session continues in clear
29290 after TLS has been shut down, or whether TLS may be restarted again later, as
29291 just described. However, if the server is Exim, this shutdown and
29292 reinitialization works. It is not known which (if any) other servers operate
29293 successfully if the client closes a TLS session and continues with unencrypted
29294 SMTP, but there are certainly some that do not work. For such servers, Exim
29295 should not pass the socket to another process, because the failure of the
29296 subsequent attempt to use it would cause Exim to record a temporary host error,
29297 and delay other deliveries to that host.
29298
29299 To test for this case, Exim sends an EHLO command to the server after
29300 closing down the TLS session. If this fails in any way, the connection is
29301 closed instead of being passed to a new delivery process, but no retry
29302 information is recorded.
29303
29304 There is also a manual override; you can set &%hosts_nopass_tls%& on the
29305 &(smtp)& transport to match those hosts for which Exim should not pass
29306 connections to new processes if TLS has been used.
29307
29308
29309
29310
29311 .section "Certificates and all that" "SECTcerandall"
29312 .cindex "certificate" "references to discussion"
29313 In order to understand fully how TLS works, you need to know about
29314 certificates, certificate signing, and certificate authorities.
29315 This is a large topic and an introductory guide is unsuitable for the Exim
29316 reference manual, so instead we provide pointers to existing documentation.
29317
29318 The Apache web-server was for a long time the canonical guide, so their
29319 documentation is a good place to start; their SSL module's Introduction
29320 document is currently at
29321 .display
29322 &url(https://httpd.apache.org/docs/current/ssl/ssl_intro.html)
29323 .endd
29324 and their FAQ is at
29325 .display
29326 &url(https://httpd.apache.org/docs/current/ssl/ssl_faq.html)
29327 .endd
29328
29329 Eric Rescorla's book, &'SSL and TLS'&, published by Addison-Wesley (ISBN
29330 0-201-61598-3) in 2001, contains both introductory and more in-depth
29331 descriptions.
29332 More recently Ivan Ristić's book &'Bulletproof SSL and TLS'&,
29333 published by Feisty Duck (ISBN 978-1907117046) in 2013 is good.
29334 Ivan is the author of the popular TLS testing tools at
29335 &url(https://www.ssllabs.com/).
29336
29337
29338 .section "Certificate chains" "SECID186"
29339 The file named by &%tls_certificate%& may contain more than one
29340 certificate. This is useful in the case where the certificate that is being
29341 sent is validated by an intermediate certificate which the other end does
29342 not have. Multiple certificates must be in the correct order in the file.
29343 First the host's certificate itself, then the first intermediate
29344 certificate to validate the issuer of the host certificate, then the next
29345 intermediate certificate to validate the issuer of the first intermediate
29346 certificate, and so on, until finally (optionally) the root certificate.
29347 The root certificate must already be trusted by the recipient for
29348 validation to succeed, of course, but if it's not preinstalled, sending the
29349 root certificate along with the rest makes it available for the user to
29350 install if the receiving end is a client MUA that can interact with a user.
29351
29352 Note that certificates using MD5 are unlikely to work on today's Internet;
29353 even if your libraries allow loading them for use in Exim when acting as a
29354 server, increasingly clients will not accept such certificates.  The error
29355 diagnostics in such a case can be frustratingly vague.
29356
29357
29358
29359 .section "Self-signed certificates" "SECID187"
29360 .cindex "certificate" "self-signed"
29361 You can create a self-signed certificate using the &'req'& command provided
29362 with OpenSSL, like this:
29363 . ==== Do not shorten the duration here without reading and considering
29364 . ==== the text below.  Please leave it at 9999 days.
29365 .code
29366 openssl req -x509 -newkey rsa:1024 -keyout file1 -out file2 \
29367             -days 9999 -nodes
29368 .endd
29369 &_file1_& and &_file2_& can be the same file; the key and the certificate are
29370 delimited and so can be identified independently. The &%-days%& option
29371 specifies a period for which the certificate is valid. The &%-nodes%& option is
29372 important: if you do not set it, the key is encrypted with a passphrase
29373 that you are prompted for, and any use that is made of the key causes more
29374 prompting for the passphrase. This is not helpful if you are going to use
29375 this certificate and key in an MTA, where prompting is not possible.
29376
29377 . ==== I expect to still be working 26 years from now.  The less technical
29378 . ==== debt I create, in terms of storing up trouble for my later years, the
29379 . ==== happier I will be then.  We really have reached the point where we
29380 . ==== should start, at the very least, provoking thought and making folks
29381 . ==== pause before proceeding, instead of leaving all the fixes until two
29382 . ==== years before 2^31 seconds after the 1970 Unix epoch.
29383 . ==== -pdp, 2012
29384 NB: we are now past the point where 9999 days takes us past the 32-bit Unix
29385 epoch.  If your system uses unsigned time_t (most do) and is 32-bit, then
29386 the above command might produce a date in the past.  Think carefully about
29387 the lifetime of the systems you're deploying, and either reduce the duration
29388 of the certificate or reconsider your platform deployment.  (At time of
29389 writing, reducing the duration is the most likely choice, but the inexorable
29390 progression of time takes us steadily towards an era where this will not
29391 be a sensible resolution).
29392
29393 A self-signed certificate made in this way is sufficient for testing, and
29394 may be adequate for all your requirements if you are mainly interested in
29395 encrypting transfers, and not in secure identification.
29396
29397 However, many clients require that the certificate presented by the server be a
29398 user (also called &"leaf"& or &"site"&) certificate, and not a self-signed
29399 certificate. In this situation, the self-signed certificate described above
29400 must be installed on the client host as a trusted root &'certification
29401 authority'& (CA), and the certificate used by Exim must be a user certificate
29402 signed with that self-signed certificate.
29403
29404 For information on creating self-signed CA certificates and using them to sign
29405 user certificates, see the &'General implementation overview'& chapter of the
29406 Open-source PKI book, available online at
29407 &url(https://sourceforge.net/projects/ospkibook/).
29408 .ecindex IIDencsmtp1
29409 .ecindex IIDencsmtp2
29410
29411
29412
29413 .section DANE "SECDANE"
29414 .cindex DANE
29415 DNS-based Authentication of Named Entities, as applied to SMTP over TLS, provides assurance to a client that
29416 it is actually talking to the server it wants to rather than some attacker operating a Man In The Middle (MITM)
29417 operation.  The latter can terminate the TLS connection you make, and make another one to the server (so both
29418 you and the server still think you have an encrypted connection) and, if one of the "well known" set of
29419 Certificate Authorities has been suborned - something which *has* been seen already (2014), a verifiable
29420 certificate (if you're using normal root CAs, eg. the Mozilla set, as your trust anchors).
29421
29422 What DANE does is replace the CAs with the DNS as the trust anchor.  The assurance is limited to a) the possibility
29423 that the DNS has been suborned, b) mistakes made by the admins of the target server.   The attack surface presented
29424 by (a) is thought to be smaller than that of the set of root CAs.
29425
29426 It also allows the server to declare (implicitly) that connections to it should use TLS.  An MITM could simply
29427 fail to pass on a server's STARTTLS.
29428
29429 DANE scales better than having to maintain (and side-channel communicate) copies of server certificates
29430 for every possible target server.  It also scales (slightly) better than having to maintain on an SMTP
29431 client a copy of the standard CAs bundle.  It also means not having to pay a CA for certificates.
29432
29433 DANE requires a server operator to do three things: 1) run DNSSEC.  This provides assurance to clients
29434 that DNS lookups they do for the server have not been tampered with.  The domain MX record applying
29435 to this server, its A record, its TLSA record and any associated CNAME records must all be covered by
29436 DNSSEC.
29437 2) add TLSA DNS records.  These say what the server certificate for a TLS connection should be.
29438 3) offer a server certificate, or certificate chain, in TLS connections which is is anchored by one of the TLSA records.
29439
29440 There are no changes to Exim specific to server-side operation of DANE.
29441 Support for client-side operation of DANE can be included at compile time by defining SUPPORT_DANE=yes
29442 in &_Local/Makefile_&.
29443 If it has been included, the macro "_HAVE_DANE" will be defined.
29444
29445 A TLSA record consist of 4 fields, the "Certificate Usage", the
29446 "Selector", the "Matching type", and the "Certificate Association Data".
29447 For a detailed description of the TLSA record see
29448 &url(https://tools.ietf.org/html/rfc7671#page-5,RFC 7671).
29449
29450 The TLSA record for the server may have "Certificate Usage" (1st) field of DANE-TA(2) or DANE-EE(3).
29451 These are the "Trust Anchor" and "End Entity" variants.
29452 The latter specifies the End Entity directly, i.e. the certificate involved is that of the server
29453 (and if only DANE-EE is used then it should be the sole one transmitted during the TLS handshake);
29454 this is appropriate for a single system, using a self-signed certificate.
29455 DANE-TA usage is effectively declaring a specific CA to be used; this might be a private CA or a public,
29456 well-known one.
29457 A private CA at simplest is just a self-signed certificate (with certain
29458 attributes) which is used to sign server certificates, but running one securely
29459 does require careful arrangement.
29460 With DANE-TA, as implemented in Exim and commonly in other MTAs,
29461 the server TLS handshake must transmit the entire certificate chain from CA to server-certificate.
29462 DANE-TA is commonly used for several services and/or servers, each having a TLSA query-domain CNAME record,
29463 all of which point to a single TLSA record.
29464 DANE-TA and DANE-EE can both be used together.
29465
29466 Our recommendation is to use DANE with a certificate from a public CA,
29467 because this enables a variety of strategies for remote clients to verify
29468 your certificate.
29469 You can then publish information both via DANE and another technology,
29470 "MTA-STS", described below.
29471
29472 When you use DANE-TA to publish trust anchor information, you ask entities
29473 outside your administrative control to trust the Certificate Authority for
29474 connections to you.
29475 If using a private CA then you should expect others to still apply the
29476 technical criteria they'd use for a public CA to your certificates.
29477 In particular, you should probably try to follow current best practices for CA
29478 operation around hash algorithms and key sizes.
29479 Do not expect other organizations to lower their security expectations just
29480 because a particular profile might be reasonable for your own internal use.
29481
29482 When this text was last updated, this in practice means to avoid use of SHA-1
29483 and MD5; if using RSA to use key sizes of at least 2048 bits (and no larger
29484 than 4096, for interoperability); to use keyUsage fields correctly; to use
29485 random serial numbers.
29486 The list of requirements is subject to change as best practices evolve.
29487 If you're not already using a private CA, or it doesn't meet these
29488 requirements, then we encourage you to avoid all these issues and use a public
29489 CA such as &url(https://letsencrypt.org/,Let's Encrypt) instead.
29490
29491 The TLSA record should have a "Selector" (2nd) field of SPKI(1) and
29492 a "Matching Type" (3rd) field of SHA2-512(2).
29493
29494 For the "Certificate Authority Data" (4th) field, commands like
29495
29496 .code
29497   openssl x509 -pubkey -noout <certificate.pem \
29498   | openssl rsa -outform der -pubin 2>/dev/null \
29499   | openssl sha512 \
29500   | awk '{print $2}'
29501 .endd
29502
29503 are workable to create a hash of the certificate's public key.
29504
29505 An example TLSA record for DANE-EE(3), SPKI(1), and SHA-512 (2) looks like
29506
29507 .code
29508   _25._tcp.mail.example.com. TLSA 3 1 2 8BA8A336E...
29509 .endd
29510
29511 At the time of writing, &url(https://www.huque.com/bin/gen_tlsa)
29512 is useful for quickly generating TLSA records.
29513
29514
29515 For use with the DANE-TA model, server certificates must have a correct name (SubjectName or SubjectAltName).
29516
29517 The Certificate issued by the CA published in the DANE-TA model should be
29518 issued using a strong hash algorithm.
29519 Exim, and importantly various other MTAs sending to you, will not
29520 re-enable hash algorithms which have been disabled by default in TLS
29521 libraries.
29522 This means no MD5 and no SHA-1.  SHA2-256 is the minimum for reliable
29523 interoperability (and probably the maximum too, in 2018).
29524
29525 The use of OCSP-stapling should be considered, allowing for fast revocation of certificates (which would otherwise
29526 be limited by the DNS TTL on the TLSA records).  However, this is likely to only be usable with DANE-TA.  NOTE: the
29527 default of requesting OCSP for all hosts is modified iff DANE is in use, to:
29528
29529 .code
29530   hosts_request_ocsp = ${if or { {= {0}{$tls_out_tlsa_usage}} \
29531                                  {= {4}{$tls_out_tlsa_usage}} } \
29532                          {*}{}}
29533 .endd
29534
29535 The (new) variable &$tls_out_tlsa_usage$& is a bitfield with numbered bits set for TLSA record usage codes.
29536 The zero above means DANE was not in use, the four means that only DANE-TA usage TLSA records were
29537 found. If the definition of &%hosts_request_ocsp%& includes the
29538 string "tls_out_tlsa_usage", they are re-expanded in time to
29539 control the OCSP request.
29540
29541 This modification of hosts_request_ocsp is only done if it has the default value of "*".  Admins who change it, and
29542 those who use &%hosts_require_ocsp%&, should consider the interaction with DANE in their OCSP settings.
29543
29544
29545 For client-side DANE there are three new smtp transport options, &%hosts_try_dane%&, &%hosts_require_dane%&
29546 and &%dane_require_tls_ciphers%&.
29547 The &"require"& variant will result in failure if the target host is not
29548 DNSSEC-secured. To get DNSSEC-secured hostname resolution, use
29549 the &%dnssec_request_domains%& router or transport option.
29550
29551 DANE will only be usable if the target host has DNSSEC-secured MX, A and TLSA records.
29552
29553 A TLSA lookup will be done if either of the above options match and the host-lookup succeeded using dnssec.
29554 If a TLSA lookup is done and succeeds, a DANE-verified TLS connection
29555 will be required for the host.  If it does not, the host will not
29556 be used; there is no fallback to non-DANE or non-TLS.
29557
29558 If DANE is requested and usable, then the TLS cipher list configuration
29559 prefers to use the option &%dane_require_tls_ciphers%& and falls
29560 back to &%tls_require_ciphers%& only if that is unset.
29561 This lets you configure "decent crypto" for DANE and "better than nothing
29562 crypto" as the default.  Note though that while GnuTLS lets the string control
29563 which versions of TLS/SSL will be negotiated, OpenSSL does not and you're
29564 limited to ciphersuite constraints.
29565
29566 If DANE is requested and useable (see above) the following transport options are ignored:
29567 .code
29568   hosts_require_tls
29569   tls_verify_hosts
29570   tls_try_verify_hosts
29571   tls_verify_certificates
29572   tls_crl
29573   tls_verify_cert_hostnames
29574 .endd
29575
29576 If DANE is not usable, whether requested or not, and CA-anchored
29577 verification evaluation is wanted, the above variables should be set appropriately.
29578
29579 The router and transport option &%dnssec_request_domains%& must not be
29580 set to &"never"&, and &%dnssec_require_domains%& is ignored.
29581
29582 If verification was successful using DANE then the "CV" item in the delivery log line will show as "CV=dane".
29583
29584 There is a new variable &$tls_out_dane$& which will have "yes" if
29585 verification succeeded using DANE and "no" otherwise (only useful
29586 in combination with events; see &<<CHAPevents>>&),
29587 and a new variable &$tls_out_tlsa_usage$& (detailed above).
29588
29589 .cindex DANE reporting
29590 An event (see &<<CHAPevents>>&) of type "dane:fail" will be raised on failures
29591 to achieve DANE-verified connection, if one was either requested and offered, or
29592 required.  This is intended to support TLS-reporting as defined in
29593 &url(https://tools.ietf.org/html/draft-ietf-uta-smtp-tlsrpt-17).
29594 The &$event_data$& will be one of the Result Types defined in
29595 Section 4.3 of that document.
29596
29597 Under GnuTLS, DANE is only supported from version 3.0.0 onwards.
29598
29599 DANE is specified in published RFCs and decouples certificate authority trust
29600 selection from a "race to the bottom" of "you must trust everything for mail
29601 to get through".  There is an alternative technology called MTA-STS, which
29602 instead publishes MX trust anchor information on an HTTPS website.  At the
29603 time this text was last updated, MTA-STS was still a draft, not yet an RFC.
29604 Exim has no support for MTA-STS as a client, but Exim mail server operators
29605 can choose to publish information describing their TLS configuration using
29606 MTA-STS to let those clients who do use that protocol derive trust
29607 information.
29608
29609 The MTA-STS design requires a certificate from a public Certificate Authority
29610 which is recognized by clients sending to you.
29611 That selection of which CAs are trusted by others is outside your control.
29612
29613 The most interoperable course of action is probably to use
29614 &url(https://letsencrypt.org/,Let's Encrypt), with automated certificate
29615 renewal; to publish the anchor information in DNSSEC-secured DNS via TLSA
29616 records for DANE clients (such as Exim and Postfix) and to publish anchor
29617 information for MTA-STS as well.  This is what is done for the &'exim.org'&
29618 domain itself (with caveats around occasionally broken MTA-STS because of
29619 incompatible specification changes prior to reaching RFC status).
29620
29621
29622
29623 . ////////////////////////////////////////////////////////////////////////////
29624 . ////////////////////////////////////////////////////////////////////////////
29625
29626 .chapter "Access control lists" "CHAPACL"
29627 .scindex IIDacl "&ACL;" "description"
29628 .cindex "control of incoming mail"
29629 .cindex "message" "controlling incoming"
29630 .cindex "policy control" "access control lists"
29631 Access Control Lists (ACLs) are defined in a separate section of the runtime
29632 configuration file, headed by &"begin acl"&. Each ACL definition starts with a
29633 name, terminated by a colon. Here is a complete ACL section that contains just
29634 one very small ACL:
29635 .code
29636 begin acl
29637 small_acl:
29638   accept   hosts = one.host.only
29639 .endd
29640 You can have as many lists as you like in the ACL section, and the order in
29641 which they appear does not matter. The lists are self-terminating.
29642
29643 The majority of ACLs are used to control Exim's behaviour when it receives
29644 certain SMTP commands. This applies both to incoming TCP/IP connections, and
29645 when a local process submits a message using SMTP by specifying the &%-bs%&
29646 option. The most common use is for controlling which recipients are accepted
29647 in incoming messages. In addition, you can define an ACL that is used to check
29648 local non-SMTP messages. The default configuration file contains an example of
29649 a realistic ACL for checking RCPT commands. This is discussed in chapter
29650 &<<CHAPdefconfil>>&.
29651
29652
29653 .section "Testing ACLs" "SECID188"
29654 The &%-bh%& command line option provides a way of testing your ACL
29655 configuration locally by running a fake SMTP session with which you interact.
29656
29657
29658 .section "Specifying when ACLs are used" "SECID189"
29659 .cindex "&ACL;" "options for specifying"
29660 In order to cause an ACL to be used, you have to name it in one of the relevant
29661 options in the main part of the configuration. These options are:
29662 .cindex "AUTH" "ACL for"
29663 .cindex "DATA" "ACLs for"
29664 .cindex "ETRN" "ACL for"
29665 .cindex "EXPN" "ACL for"
29666 .cindex "HELO" "ACL for"
29667 .cindex "EHLO" "ACL for"
29668 .cindex "DKIM" "ACL for"
29669 .cindex "MAIL" "ACL for"
29670 .cindex "QUIT, ACL for"
29671 .cindex "RCPT" "ACL for"
29672 .cindex "STARTTLS, ACL for"
29673 .cindex "VRFY" "ACL for"
29674 .cindex "SMTP" "connection, ACL for"
29675 .cindex "non-SMTP messages" "ACLs for"
29676 .cindex "MIME content scanning" "ACL for"
29677 .cindex "PRDR" "ACL for"
29678
29679 .table2 140pt
29680 .irow &%acl_not_smtp%&         "ACL for non-SMTP messages"
29681 .irow &%acl_not_smtp_mime%&    "ACL for non-SMTP MIME parts"
29682 .irow &%acl_not_smtp_start%&   "ACL at start of non-SMTP message"
29683 .irow &%acl_smtp_auth%&        "ACL for AUTH"
29684 .irow &%acl_smtp_connect%&     "ACL for start of SMTP connection"
29685 .irow &%acl_smtp_data%&        "ACL after DATA is complete"
29686 .irow &%acl_smtp_data_prdr%&   "ACL for each recipient, after DATA is complete"
29687 .irow &%acl_smtp_dkim%&        "ACL for each DKIM signer"
29688 .irow &%acl_smtp_etrn%&        "ACL for ETRN"
29689 .irow &%acl_smtp_expn%&        "ACL for EXPN"
29690 .irow &%acl_smtp_helo%&        "ACL for HELO or EHLO"
29691 .irow &%acl_smtp_mail%&        "ACL for MAIL"
29692 .irow &%acl_smtp_mailauth%&    "ACL for the AUTH parameter of MAIL"
29693 .irow &%acl_smtp_mime%&        "ACL for content-scanning MIME parts"
29694 .irow &%acl_smtp_notquit%&     "ACL for non-QUIT terminations"
29695 .irow &%acl_smtp_predata%&     "ACL at start of DATA command"
29696 .irow &%acl_smtp_quit%&        "ACL for QUIT"
29697 .irow &%acl_smtp_rcpt%&        "ACL for RCPT"
29698 .irow &%acl_smtp_starttls%&    "ACL for STARTTLS"
29699 .irow &%acl_smtp_vrfy%&        "ACL for VRFY"
29700 .endtable
29701
29702 For example, if you set
29703 .code
29704 acl_smtp_rcpt = small_acl
29705 .endd
29706 the little ACL defined above is used whenever Exim receives a RCPT command
29707 in an SMTP dialogue. The majority of policy tests on incoming messages can be
29708 done when RCPT commands arrive. A rejection of RCPT should cause the
29709 sending MTA to give up on the recipient address contained in the RCPT
29710 command, whereas rejection at other times may cause the client MTA to keep on
29711 trying to deliver the message. It is therefore recommended that you do as much
29712 testing as possible at RCPT time.
29713
29714
29715 .section "The non-SMTP ACLs" "SECID190"
29716 .cindex "non-SMTP messages" "ACLs for"
29717 The non-SMTP ACLs apply to all non-interactive incoming messages, that is, they
29718 apply to batched SMTP as well as to non-SMTP messages. (Batched SMTP is not
29719 really SMTP.) Many of the ACL conditions (for example, host tests, and tests on
29720 the state of the SMTP connection such as encryption and authentication) are not
29721 relevant and are forbidden in these ACLs. However, the sender and recipients
29722 are known, so the &%senders%& and &%sender_domains%& conditions and the
29723 &$sender_address$& and &$recipients$& variables can be used. Variables such as
29724 &$authenticated_sender$& are also available. You can specify added header lines
29725 in any of these ACLs.
29726
29727 The &%acl_not_smtp_start%& ACL is run right at the start of receiving a
29728 non-SMTP message, before any of the message has been read. (This is the
29729 analogue of the &%acl_smtp_predata%& ACL for SMTP input.) In the case of
29730 batched SMTP input, it runs after the DATA command has been reached. The
29731 result of this ACL is ignored; it cannot be used to reject a message. If you
29732 really need to, you could set a value in an ACL variable here and reject based
29733 on that in the &%acl_not_smtp%& ACL. However, this ACL can be used to set
29734 controls, and in particular, it can be used to set
29735 .code
29736 control = suppress_local_fixups
29737 .endd
29738 This cannot be used in the other non-SMTP ACLs because by the time they are
29739 run, it is too late.
29740
29741 The &%acl_not_smtp_mime%& ACL is available only when Exim is compiled with the
29742 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
29743
29744 The &%acl_not_smtp%& ACL is run just before the &[local_scan()]& function. Any
29745 kind of rejection is treated as permanent, because there is no way of sending a
29746 temporary error for these kinds of message.
29747
29748
29749 .section "The SMTP connect ACL" "SECID191"
29750 .cindex "SMTP" "connection, ACL for"
29751 .oindex &%smtp_banner%&
29752 The ACL test specified by &%acl_smtp_connect%& happens at the start of an SMTP
29753 session, after the test specified by &%host_reject_connection%& (which is now
29754 an anomaly) and any TCP Wrappers testing (if configured). If the connection is
29755 accepted by an &%accept%& verb that has a &%message%& modifier, the contents of
29756 the message override the banner message that is otherwise specified by the
29757 &%smtp_banner%& option.
29758
29759
29760 .section "The EHLO/HELO ACL" "SECID192"
29761 .cindex "EHLO" "ACL for"
29762 .cindex "HELO" "ACL for"
29763 The ACL test specified by &%acl_smtp_helo%& happens when the client issues an
29764 EHLO or HELO command, after the tests specified by &%helo_accept_junk_hosts%&,
29765 &%helo_allow_chars%&, &%helo_verify_hosts%&, and &%helo_try_verify_hosts%&.
29766 Note that a client may issue more than one EHLO or HELO command in an SMTP
29767 session, and indeed is required to issue a new EHLO or HELO after successfully
29768 setting up encryption following a STARTTLS command.
29769
29770 Note also that a deny neither forces the client to go away nor means that
29771 mail will be refused on the connection.  Consider checking for
29772 &$sender_helo_name$& being defined in a MAIL or RCPT ACL to do that.
29773
29774 If the command is accepted by an &%accept%& verb that has a &%message%&
29775 modifier, the message may not contain more than one line (it will be truncated
29776 at the first newline and a panic logged if it does). Such a message cannot
29777 affect the EHLO options that are listed on the second and subsequent lines of
29778 an EHLO response.
29779
29780
29781 .section "The DATA ACLs" "SECID193"
29782 .cindex "DATA" "ACLs for"
29783 Two ACLs are associated with the DATA command, because it is two-stage
29784 command, with two responses being sent to the client.
29785 When the DATA command is received, the ACL defined by &%acl_smtp_predata%&
29786 is obeyed. This gives you control after all the RCPT commands, but before
29787 the message itself is received. It offers the opportunity to give a negative
29788 response to the DATA command before the data is transmitted. Header lines
29789 added by MAIL or RCPT ACLs are not visible at this time, but any that
29790 are defined here are visible when the &%acl_smtp_data%& ACL is run.
29791
29792 You cannot test the contents of the message, for example, to verify addresses
29793 in the headers, at RCPT time or when the DATA command is received. Such
29794 tests have to appear in the ACL that is run after the message itself has been
29795 received, before the final response to the DATA command is sent. This is
29796 the ACL specified by &%acl_smtp_data%&, which is the second ACL that is
29797 associated with the DATA command.
29798
29799 .cindex CHUNKING "BDAT command"
29800 .cindex BDAT "SMTP command"
29801 .cindex "RFC 3030" CHUNKING
29802 If CHUNKING was advertised and a BDAT command sequence is received,
29803 the &%acl_smtp_predata%& ACL is not run.
29804 . XXX why not?  It should be possible, for the first BDAT.
29805 The &%acl_smtp_data%& is run after the last BDAT command and all of
29806 the data specified is received.
29807
29808 For both of these ACLs, it is not possible to reject individual recipients. An
29809 error response rejects the entire message. Unfortunately, it is known that some
29810 MTAs do not treat hard (5&'xx'&) responses to the DATA command (either
29811 before or after the data) correctly &-- they keep the message on their queues
29812 and try again later, but that is their problem, though it does waste some of
29813 your resources.
29814
29815 The &%acl_smtp_data%& ACL is run after
29816 the &%acl_smtp_data_prdr%&,
29817 the &%acl_smtp_dkim%&
29818 and the &%acl_smtp_mime%& ACLs.
29819
29820 .section "The SMTP DKIM ACL" "SECTDKIMACL"
29821 The &%acl_smtp_dkim%& ACL is available only when Exim is compiled with DKIM support
29822 enabled (which is the default).
29823
29824 The ACL test specified by &%acl_smtp_dkim%& happens after a message has been
29825 received, and is executed for each DKIM signature found in a message.  If not
29826 otherwise specified, the default action is to accept.
29827
29828 This ACL is evaluated before &%acl_smtp_mime%& and &%acl_smtp_data%&.
29829
29830 For details on the operation of DKIM, see section &<<SECDKIM>>&.
29831
29832
29833 .section "The SMTP MIME ACL" "SECID194"
29834 The &%acl_smtp_mime%& option is available only when Exim is compiled with the
29835 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
29836
29837 This ACL is evaluated after &%acl_smtp_dkim%& but before &%acl_smtp_data%&.
29838
29839
29840 .section "The SMTP PRDR ACL" "SECTPRDRACL"
29841 .cindex "PRDR" "ACL for"
29842 .oindex "&%prdr_enable%&"
29843 The &%acl_smtp_data_prdr%& ACL is available only when Exim is compiled
29844 with PRDR support enabled (which is the default).
29845 It becomes active only when the PRDR feature is negotiated between
29846 client and server for a message, and more than one recipient
29847 has been accepted.
29848
29849 The ACL test specified by &%acl_smtp_data_prdr%& happens after a message
29850 has been received, and is executed once for each recipient of the message
29851 with &$local_part$& and &$domain$& valid.
29852 The test may accept, defer or deny for individual recipients.
29853 The &%acl_smtp_data%& will still be called after this ACL and
29854 can reject the message overall, even if this ACL has accepted it
29855 for some or all recipients.
29856
29857 PRDR may be used to support per-user content filtering.  Without it
29858 one must defer any recipient after the first that has a different
29859 content-filter configuration.  With PRDR, the RCPT-time check
29860 .cindex "PRDR" "variable for"
29861 for this can be disabled when the variable &$prdr_requested$&
29862 is &"yes"&.
29863 Any required difference in behaviour of the main DATA-time
29864 ACL should however depend on the PRDR-time ACL having run, as Exim
29865 will avoid doing so in some situations (e.g. single-recipient mails).
29866
29867 See also the &%prdr_enable%& global option
29868 and the &%hosts_try_prdr%& smtp transport option.
29869
29870 This ACL is evaluated after &%acl_smtp_dkim%& but before &%acl_smtp_data%&.
29871 If the ACL is not defined, processing completes as if
29872 the feature was not requested by the client.
29873
29874 .section "The QUIT ACL" "SECTQUITACL"
29875 .cindex "QUIT, ACL for"
29876 The ACL for the SMTP QUIT command is anomalous, in that the outcome of the ACL
29877 does not affect the response code to QUIT, which is always 221. Thus, the ACL
29878 does not in fact control any access.
29879 For this reason, it may only accept
29880 or warn as its final result.
29881
29882 This ACL can be used for tasks such as custom logging at the end of an SMTP
29883 session. For example, you can use ACL variables in other ACLs to count
29884 messages, recipients, etc., and log the totals at QUIT time using one or
29885 more &%logwrite%& modifiers on a &%warn%& verb.
29886
29887 &*Warning*&: Only the &$acl_c$&&'x'& variables can be used for this, because
29888 the &$acl_m$&&'x'& variables are reset at the end of each incoming message.
29889
29890 You do not need to have a final &%accept%&, but if you do, you can use a
29891 &%message%& modifier to specify custom text that is sent as part of the 221
29892 response to QUIT.
29893
29894 This ACL is run only for a &"normal"& QUIT. For certain kinds of disastrous
29895 failure (for example, failure to open a log file, or when Exim is bombing out
29896 because it has detected an unrecoverable error), all SMTP commands from the
29897 client are given temporary error responses until QUIT is received or the
29898 connection is closed. In these special cases, the QUIT ACL does not run.
29899
29900
29901 .section "The not-QUIT ACL" "SECTNOTQUITACL"
29902 .vindex &$acl_smtp_notquit$&
29903 The not-QUIT ACL, specified by &%acl_smtp_notquit%&, is run in most cases when
29904 an SMTP session ends without sending QUIT. However, when Exim itself is in bad
29905 trouble, such as being unable to write to its log files, this ACL is not run,
29906 because it might try to do things (such as write to log files) that make the
29907 situation even worse.
29908
29909 Like the QUIT ACL, this ACL is provided to make it possible to do customized
29910 logging or to gather statistics, and its outcome is ignored. The &%delay%&
29911 modifier is forbidden in this ACL, and the only permitted verbs are &%accept%&
29912 and &%warn%&.
29913
29914 .vindex &$smtp_notquit_reason$&
29915 When the not-QUIT ACL is running, the variable &$smtp_notquit_reason$& is set
29916 to a string that indicates the reason for the termination of the SMTP
29917 connection. The possible values are:
29918 .table2
29919 .irow &`acl-drop`&                 "Another ACL issued a &%drop%& command"
29920 .irow &`bad-commands`&             "Too many unknown or non-mail commands"
29921 .irow &`command-timeout`&          "Timeout while reading SMTP commands"
29922 .irow &`connection-lost`&          "The SMTP connection has been lost"
29923 .irow &`data-timeout`&             "Timeout while reading message data"
29924 .irow &`local-scan-error`&         "The &[local_scan()]& function crashed"
29925 .irow &`local-scan-timeout`&       "The &[local_scan()]& function timed out"
29926 .irow &`signal-exit`&              "SIGTERM or SIGINT"
29927 .irow &`synchronization-error`&    "SMTP synchronization error"
29928 .irow &`tls-failed`&               "TLS failed to start"
29929 .endtable
29930 In most cases when an SMTP connection is closed without having received QUIT,
29931 Exim sends an SMTP response message before actually closing the connection.
29932 With the exception of the &`acl-drop`& case, the default message can be
29933 overridden by the &%message%& modifier in the not-QUIT ACL. In the case of a
29934 &%drop%& verb in another ACL, it is the message from the other ACL that is
29935 used.
29936
29937
29938 .section "Finding an ACL to use" "SECID195"
29939 .cindex "&ACL;" "finding which to use"
29940 The value of an &%acl_smtp_%&&'xxx'& option is expanded before use, so
29941 you can use different ACLs in different circumstances. For example,
29942 .code
29943 acl_smtp_rcpt = ${if ={25}{$interface_port} \
29944                      {acl_check_rcpt} {acl_check_rcpt_submit} }
29945 .endd
29946 In the default configuration file there are some example settings for
29947 providing an RFC 4409 message &"submission"& service on port 587 and
29948 an RFC 8314 &"submissions"& service on port 465. You can use a string
29949 expansion like this to choose an ACL for MUAs on these ports which is
29950 more appropriate for this purpose than the default ACL on port 25.
29951
29952 The expanded string does not have to be the name of an ACL in the
29953 configuration file; there are other possibilities. Having expanded the
29954 string, Exim searches for an ACL as follows:
29955
29956 .ilist
29957 If the string begins with a slash, Exim uses it as a filename, and reads its
29958 contents as an ACL. The lines are processed in the same way as lines in the
29959 Exim configuration file. In particular, continuation lines are supported, blank
29960 lines are ignored, as are lines whose first non-whitespace character is &"#"&.
29961 If the file does not exist or cannot be read, an error occurs (typically
29962 causing a temporary failure of whatever caused the ACL to be run). For example:
29963 .code
29964 acl_smtp_data = /etc/acls/\
29965   ${lookup{$sender_host_address}lsearch\
29966   {/etc/acllist}{$value}{default}}
29967 .endd
29968 This looks up an ACL file to use on the basis of the host's IP address, falling
29969 back to a default if the lookup fails. If an ACL is successfully read from a
29970 file, it is retained in memory for the duration of the Exim process, so that it
29971 can be re-used without having to re-read the file.
29972 .next
29973 If the string does not start with a slash, and does not contain any spaces,
29974 Exim searches the ACL section of the configuration for an ACL whose name
29975 matches the string.
29976 .next
29977 If no named ACL is found, or if the string contains spaces, Exim parses
29978 the string as an inline ACL. This can save typing in cases where you just
29979 want to have something like
29980 .code
29981 acl_smtp_vrfy = accept
29982 .endd
29983 in order to allow free use of the VRFY command. Such a string may contain
29984 newlines; it is processed in the same way as an ACL that is read from a file.
29985 .endlist
29986
29987
29988
29989
29990 .section "ACL return codes" "SECID196"
29991 .cindex "&ACL;" "return codes"
29992 Except for the QUIT ACL, which does not affect the SMTP return code (see
29993 section &<<SECTQUITACL>>& above), the result of running an ACL is either
29994 &"accept"& or &"deny"&, or, if some test cannot be completed (for example, if a
29995 database is down), &"defer"&. These results cause 2&'xx'&, 5&'xx'&, and 4&'xx'&
29996 return codes, respectively, to be used in the SMTP dialogue. A fourth return,
29997 &"error"&, occurs when there is an error such as invalid syntax in the ACL.
29998 This also causes a 4&'xx'& return code.
29999
30000 For the non-SMTP ACL, &"defer"& and &"error"& are treated in the same way as
30001 &"deny"&, because there is no mechanism for passing temporary errors to the
30002 submitters of non-SMTP messages.
30003
30004
30005 ACLs that are relevant to message reception may also return &"discard"&. This
30006 has the effect of &"accept"&, but causes either the entire message or an
30007 individual recipient address to be discarded. In other words, it is a
30008 blackholing facility. Use it with care.
30009
30010 If the ACL for MAIL returns &"discard"&, all recipients are discarded, and no
30011 ACL is run for subsequent RCPT commands. The effect of &"discard"& in a
30012 RCPT ACL is to discard just the one recipient address. If there are no
30013 recipients left when the message's data is received, the DATA ACL is not
30014 run. A &"discard"& return from the DATA or the non-SMTP ACL discards all the
30015 remaining recipients. The &"discard"& return is not permitted for the
30016 &%acl_smtp_predata%& ACL.
30017
30018 If the ACL for VRFY returns &"accept"&, a recipient verify (without callout)
30019 is done on the address and the result determines the SMTP response.
30020
30021
30022 .cindex "&[local_scan()]& function" "when all recipients discarded"
30023 The &[local_scan()]& function is always run, even if there are no remaining
30024 recipients; it may create new recipients.
30025
30026
30027
30028 .section "Unset ACL options" "SECID197"
30029 .cindex "&ACL;" "unset options"
30030 The default actions when any of the &%acl_%&&'xxx'& options are unset are not
30031 all the same. &*Note*&: These defaults apply only when the relevant ACL is
30032 not defined at all. For any defined ACL, the default action when control
30033 reaches the end of the ACL statements is &"deny"&.
30034
30035 For &%acl_smtp_quit%& and &%acl_not_smtp_start%& there is no default because
30036 these two are ACLs that are used only for their side effects. They cannot be
30037 used to accept or reject anything.
30038
30039 For &%acl_not_smtp%&, &%acl_smtp_auth%&, &%acl_smtp_connect%&,
30040 &%acl_smtp_data%&, &%acl_smtp_helo%&, &%acl_smtp_mail%&, &%acl_smtp_mailauth%&,
30041 &%acl_smtp_mime%&, &%acl_smtp_predata%&, and &%acl_smtp_starttls%&, the action
30042 when the ACL is not defined is &"accept"&.
30043
30044 For the others (&%acl_smtp_etrn%&, &%acl_smtp_expn%&, &%acl_smtp_rcpt%&, and
30045 &%acl_smtp_vrfy%&), the action when the ACL is not defined is &"deny"&.
30046 This means that &%acl_smtp_rcpt%& must be defined in order to receive any
30047 messages over an SMTP connection. For an example, see the ACL in the default
30048 configuration file.
30049
30050
30051
30052
30053 .section "Data for message ACLs" "SECID198"
30054 .cindex "&ACL;" "data for message ACL"
30055 .vindex &$domain$&
30056 .vindex &$local_part$&
30057 .vindex &$sender_address$&
30058 .vindex &$sender_host_address$&
30059 .vindex &$smtp_command$&
30060 When a MAIL or RCPT ACL, or either of the DATA ACLs, is running, the variables
30061 that contain information about the host and the message's sender (for example,
30062 &$sender_host_address$& and &$sender_address$&) are set, and can be used in ACL
30063 statements. In the case of RCPT (but not MAIL or DATA), &$domain$& and
30064 &$local_part$& are set from the argument address. The entire SMTP command
30065 is available in &$smtp_command$&.
30066
30067 When an ACL for the AUTH parameter of MAIL is running, the variables that
30068 contain information about the host are set, but &$sender_address$& is not yet
30069 set. Section &<<SECTauthparamail>>& contains a discussion of this parameter and
30070 how it is used.
30071
30072 .vindex "&$message_size$&"
30073 The &$message_size$& variable is set to the value of the SIZE parameter on
30074 the MAIL command at MAIL, RCPT and pre-data time, or to -1 if
30075 that parameter is not given. The value is updated to the true message size by
30076 the time the final DATA ACL is run (after the message data has been
30077 received).
30078
30079 .vindex "&$rcpt_count$&"
30080 .vindex "&$recipients_count$&"
30081 The &$rcpt_count$& variable increases by one for each RCPT command received.
30082 The &$recipients_count$& variable increases by one each time a RCPT command is
30083 accepted, so while an ACL for RCPT is being processed, it contains the number
30084 of previously accepted recipients. At DATA time (for both the DATA ACLs),
30085 &$rcpt_count$& contains the total number of RCPT commands, and
30086 &$recipients_count$& contains the total number of accepted recipients.
30087
30088
30089
30090
30091
30092 .section "Data for non-message ACLs" "SECTdatfornon"
30093 .cindex "&ACL;" "data for non-message ACL"
30094 .vindex &$smtp_command_argument$&
30095 .vindex &$smtp_command$&
30096 When an ACL is being run for AUTH, EHLO, ETRN, EXPN, HELO, STARTTLS, or VRFY,
30097 the remainder of the SMTP command line is placed in &$smtp_command_argument$&,
30098 and the entire SMTP command is available in &$smtp_command$&.
30099 These variables can be tested using a &%condition%& condition. For example,
30100 here is an ACL for use with AUTH, which insists that either the session is
30101 encrypted, or the CRAM-MD5 authentication method is used. In other words, it
30102 does not permit authentication methods that use cleartext passwords on
30103 unencrypted connections.
30104 .code
30105 acl_check_auth:
30106   accept encrypted = *
30107   accept condition = ${if eq{${uc:$smtp_command_argument}}\
30108                      {CRAM-MD5}}
30109   deny   message   = TLS encryption or CRAM-MD5 required
30110 .endd
30111 (Another way of applying this restriction is to arrange for the authenticators
30112 that use cleartext passwords not to be advertised when the connection is not
30113 encrypted. You can use the generic &%server_advertise_condition%& authenticator
30114 option to do this.)
30115
30116
30117
30118 .section "Format of an ACL" "SECID199"
30119 .cindex "&ACL;" "format of"
30120 .cindex "&ACL;" "verbs, definition of"
30121 An individual ACL consists of a number of statements. Each statement starts
30122 with a verb, optionally followed by a number of conditions and &"modifiers"&.
30123 Modifiers can change the way the verb operates, define error and log messages,
30124 set variables, insert delays, and vary the processing of accepted messages.
30125
30126 If all the conditions are met, the verb is obeyed. The same condition may be
30127 used (with different arguments) more than once in the same statement. This
30128 provides a means of specifying an &"and"& conjunction between conditions. For
30129 example:
30130 .code
30131 deny  dnslists = list1.example
30132       dnslists = list2.example
30133 .endd
30134 If there are no conditions, the verb is always obeyed. Exim stops evaluating
30135 the conditions and modifiers when it reaches a condition that fails. What
30136 happens then depends on the verb (and in one case, on a special modifier). Not
30137 all the conditions make sense at every testing point. For example, you cannot
30138 test a sender address in the ACL that is run for a VRFY command.
30139
30140
30141 .section "ACL verbs" "SECID200"
30142 The ACL verbs are as follows:
30143
30144 .ilist
30145 .cindex "&%accept%& ACL verb"
30146 &%accept%&: If all the conditions are met, the ACL returns &"accept"&. If any
30147 of the conditions are not met, what happens depends on whether &%endpass%&
30148 appears among the conditions (for syntax see below). If the failing condition
30149 is before &%endpass%&, control is passed to the next ACL statement; if it is
30150 after &%endpass%&, the ACL returns &"deny"&. Consider this statement, used to
30151 check a RCPT command:
30152 .code
30153 accept domains = +local_domains
30154        endpass
30155        verify = recipient
30156 .endd
30157 If the recipient domain does not match the &%domains%& condition, control
30158 passes to the next statement. If it does match, the recipient is verified, and
30159 the command is accepted if verification succeeds. However, if verification
30160 fails, the ACL yields &"deny"&, because the failing condition is after
30161 &%endpass%&.
30162
30163 The &%endpass%& feature has turned out to be confusing to many people, so its
30164 use is not recommended nowadays. It is always possible to rewrite an ACL so
30165 that &%endpass%& is not needed, and it is no longer used in the default
30166 configuration.
30167
30168 .cindex "&%message%& ACL modifier" "with &%accept%&"
30169 If a &%message%& modifier appears on an &%accept%& statement, its action
30170 depends on whether or not &%endpass%& is present. In the absence of &%endpass%&
30171 (when an &%accept%& verb either accepts or passes control to the next
30172 statement), &%message%& can be used to vary the message that is sent when an
30173 SMTP command is accepted. For example, in a RCPT ACL you could have:
30174 .display
30175 &`accept  `&<&'some conditions'&>
30176 &`        message = OK, I will allow you through today`&
30177 .endd
30178 You can specify an SMTP response code, optionally followed by an &"extended
30179 response code"& at the start of the message, but the first digit must be the
30180 same as would be sent by default, which is 2 for an &%accept%& verb.
30181
30182 If &%endpass%& is present in an &%accept%& statement, &%message%& specifies
30183 an error message that is used when access is denied. This behaviour is retained
30184 for backward compatibility, but current &"best practice"& is to avoid the use
30185 of &%endpass%&.
30186
30187
30188 .next
30189 .cindex "&%defer%& ACL verb"
30190 &%defer%&: If all the conditions are true, the ACL returns &"defer"& which, in
30191 an SMTP session, causes a 4&'xx'& response to be given. For a non-SMTP ACL,
30192 &%defer%& is the same as &%deny%&, because there is no way of sending a
30193 temporary error. For a RCPT command, &%defer%& is much the same as using a
30194 &(redirect)& router and &`:defer:`& while verifying, but the &%defer%& verb can
30195 be used in any ACL, and even for a recipient it might be a simpler approach.
30196
30197
30198 .next
30199 .cindex "&%deny%& ACL verb"
30200 &%deny%&: If all the conditions are met, the ACL returns &"deny"&. If any of
30201 the conditions are not met, control is passed to the next ACL statement. For
30202 example,
30203 .code
30204 deny dnslists = blackholes.mail-abuse.org
30205 .endd
30206 rejects commands from hosts that are on a DNS black list.
30207
30208
30209 .next
30210 .cindex "&%discard%& ACL verb"
30211 &%discard%&: This verb behaves like &%accept%&, except that it returns
30212 &"discard"& from the ACL instead of &"accept"&. It is permitted only on ACLs
30213 that are concerned with receiving messages. When all the conditions are true,
30214 the sending entity receives a &"success"& response. However, &%discard%& causes
30215 recipients to be discarded. If it is used in an ACL for RCPT, just the one
30216 recipient is discarded; if used for MAIL, DATA or in the non-SMTP ACL, all the
30217 message's recipients are discarded. Recipients that are discarded before DATA
30218 do not appear in the log line when the &%received_recipients%& log selector is set.
30219
30220 If the &%log_message%& modifier is set when &%discard%& operates,
30221 its contents are added to the line that is automatically written to the log.
30222 The &%message%& modifier operates exactly as it does for &%accept%&.
30223
30224
30225 .next
30226 .cindex "&%drop%& ACL verb"
30227 &%drop%&: This verb behaves like &%deny%&, except that an SMTP connection is
30228 forcibly closed after the 5&'xx'& error message has been sent. For example:
30229 .code
30230 drop   condition = ${if > {$rcpt_count}{20}}
30231        message   = I don't take more than 20 RCPTs
30232 .endd
30233 There is no difference between &%deny%& and &%drop%& for the connect-time ACL.
30234 The connection is always dropped after sending a 550 response.
30235
30236 .next
30237 .cindex "&%require%& ACL verb"
30238 &%require%&: If all the conditions are met, control is passed to the next ACL
30239 statement. If any of the conditions are not met, the ACL returns &"deny"&. For
30240 example, when checking a RCPT command,
30241 .code
30242 require message = Sender did not verify
30243         verify  = sender
30244 .endd
30245 passes control to subsequent statements only if the message's sender can be
30246 verified. Otherwise, it rejects the command. Note the positioning of the
30247 &%message%& modifier, before the &%verify%& condition. The reason for this is
30248 discussed in section &<<SECTcondmodproc>>&.
30249
30250 .next
30251 .cindex "&%warn%& ACL verb"
30252 &%warn%&: If all the conditions are true, a line specified by the
30253 &%log_message%& modifier is written to Exim's main log. Control always passes
30254 to the next ACL statement. If any condition is false, the log line is not
30255 written. If an identical log line is requested several times in the same
30256 message, only one copy is actually written to the log. If you want to force
30257 duplicates to be written, use the &%logwrite%& modifier instead.
30258
30259 If &%log_message%& is not present, a &%warn%& verb just checks its conditions
30260 and obeys any &"immediate"& modifiers (such as &%control%&, &%set%&,
30261 &%logwrite%&, &%add_header%&, and &%remove_header%&) that appear before the
30262 first failing condition. There is more about adding header lines in section
30263 &<<SECTaddheadacl>>&.
30264
30265 If any condition on a &%warn%& statement cannot be completed (that is, there is
30266 some sort of defer), the log line specified by &%log_message%& is not written.
30267 This does not include the case of a forced failure from a lookup, which
30268 is considered to be a successful completion. After a defer, no further
30269 conditions or modifiers in the &%warn%& statement are processed. The incident
30270 is logged, and the ACL continues to be processed, from the next statement
30271 onwards.
30272
30273
30274 .vindex "&$acl_verify_message$&"
30275 When one of the &%warn%& conditions is an address verification that fails, the
30276 text of the verification failure message is in &$acl_verify_message$&. If you
30277 want this logged, you must set it up explicitly. For example:
30278 .code
30279 warn   !verify = sender
30280        log_message = sender verify failed: $acl_verify_message
30281 .endd
30282 .endlist
30283
30284 At the end of each ACL there is an implicit unconditional &%deny%&.
30285
30286 As you can see from the examples above, the conditions and modifiers are
30287 written one to a line, with the first one on the same line as the verb, and
30288 subsequent ones on following lines. If you have a very long condition, you can
30289 continue it onto several physical lines by the usual backslash continuation
30290 mechanism. It is conventional to align the conditions vertically.
30291
30292
30293
30294 .section "ACL variables" "SECTaclvariables"
30295 .cindex "&ACL;" "variables"
30296 There are some special variables that can be set during ACL processing. They
30297 can be used to pass information between different ACLs, different invocations
30298 of the same ACL in the same SMTP connection, and between ACLs and the routers,
30299 transports, and filters that are used to deliver a message. The names of these
30300 variables must begin with &$acl_c$& or &$acl_m$&, followed either by a digit or
30301 an underscore, but the remainder of the name can be any sequence of
30302 alphanumeric characters and underscores that you choose. There is no limit on
30303 the number of ACL variables. The two sets act as follows:
30304 .ilist
30305 The values of those variables whose names begin with &$acl_c$& persist
30306 throughout an SMTP connection. They are never reset. Thus, a value that is set
30307 while receiving one message is still available when receiving the next message
30308 on the same SMTP connection.
30309 .next
30310 The values of those variables whose names begin with &$acl_m$& persist only
30311 while a message is being received. They are reset afterwards. They are also
30312 reset by MAIL, RSET, EHLO, HELO, and after starting up a TLS session.
30313 .endlist
30314
30315 When a message is accepted, the current values of all the ACL variables are
30316 preserved with the message and are subsequently made available at delivery
30317 time. The ACL variables are set by a modifier called &%set%&. For example:
30318 .code
30319 accept hosts = whatever
30320        set acl_m4 = some value
30321 accept authenticated = *
30322        set acl_c_auth = yes
30323 .endd
30324 &*Note*&: A leading dollar sign is not used when naming a variable that is to
30325 be set. If you want to set a variable without taking any action, you can use a
30326 &%warn%& verb without any other modifiers or conditions.
30327
30328 .oindex &%strict_acl_vars%&
30329 What happens if a syntactically valid but undefined ACL variable is
30330 referenced depends on the setting of the &%strict_acl_vars%& option. If it is
30331 false (the default), an empty string is substituted; if it is true, an
30332 error is generated.
30333
30334 Versions of Exim before 4.64 have a limited set of numbered variables, but
30335 their names are compatible, so there is no problem with upgrading.
30336
30337
30338 .section "Condition and modifier processing" "SECTcondmodproc"
30339 .cindex "&ACL;" "conditions; processing"
30340 .cindex "&ACL;" "modifiers; processing"
30341 An exclamation mark preceding a condition negates its result. For example:
30342 .code
30343 deny   domains = *.dom.example
30344       !verify  = recipient
30345 .endd
30346 causes the ACL to return &"deny"& if the recipient domain ends in
30347 &'dom.example'& and the recipient address cannot be verified. Sometimes
30348 negation can be used on the right-hand side of a condition. For example, these
30349 two statements are equivalent:
30350 .code
30351 deny  hosts = !192.168.3.4
30352 deny !hosts =  192.168.3.4
30353 .endd
30354 However, for many conditions (&%verify%& being a good example), only left-hand
30355 side negation of the whole condition is possible.
30356
30357 The arguments of conditions and modifiers are expanded. A forced failure
30358 of an expansion causes a condition to be ignored, that is, it behaves as if the
30359 condition is true. Consider these two statements:
30360 .code
30361 accept  senders = ${lookup{$host_name}lsearch\
30362                   {/some/file}{$value}fail}
30363 accept  senders = ${lookup{$host_name}lsearch\
30364                   {/some/file}{$value}{}}
30365 .endd
30366 Each attempts to look up a list of acceptable senders. If the lookup succeeds,
30367 the returned list is searched, but if the lookup fails the behaviour is
30368 different in the two cases. The &%fail%& in the first statement causes the
30369 condition to be ignored, leaving no further conditions. The &%accept%& verb
30370 therefore succeeds. The second statement, however, generates an empty list when
30371 the lookup fails. No sender can match an empty list, so the condition fails,
30372 and therefore the &%accept%& also fails.
30373
30374 ACL modifiers appear mixed in with conditions in ACL statements. Some of them
30375 specify actions that are taken as the conditions for a statement are checked;
30376 others specify text for messages that are used when access is denied or a
30377 warning is generated. The &%control%& modifier affects the way an incoming
30378 message is handled.
30379
30380 The positioning of the modifiers in an ACL statement is important, because the
30381 processing of a verb ceases as soon as its outcome is known. Only those
30382 modifiers that have already been encountered will take effect. For example,
30383 consider this use of the &%message%& modifier:
30384 .code
30385 require message = Can't verify sender
30386         verify  = sender
30387         message = Can't verify recipient
30388         verify  = recipient
30389         message = This message cannot be used
30390 .endd
30391 If sender verification fails, Exim knows that the result of the statement is
30392 &"deny"&, so it goes no further. The first &%message%& modifier has been seen,
30393 so its text is used as the error message. If sender verification succeeds, but
30394 recipient verification fails, the second message is used. If recipient
30395 verification succeeds, the third message becomes &"current"&, but is never used
30396 because there are no more conditions to cause failure.
30397
30398 For the &%deny%& verb, on the other hand, it is always the last &%message%&
30399 modifier that is used, because all the conditions must be true for rejection to
30400 happen. Specifying more than one &%message%& modifier does not make sense, and
30401 the message can even be specified after all the conditions. For example:
30402 .code
30403 deny   hosts = ...
30404       !senders = *@my.domain.example
30405        message = Invalid sender from client host
30406 .endd
30407 The &"deny"& result does not happen until the end of the statement is reached,
30408 by which time Exim has set up the message.
30409
30410
30411
30412 .section "ACL modifiers" "SECTACLmodi"
30413 .cindex "&ACL;" "modifiers; list of"
30414 The ACL modifiers are as follows:
30415
30416 .vlist
30417 .vitem &*add_header*&&~=&~<&'text'&>
30418 This modifier specifies one or more header lines that are to be added to an
30419 incoming message, assuming, of course, that the message is ultimately
30420 accepted. For details, see section &<<SECTaddheadacl>>&.
30421
30422 .vitem &*continue*&&~=&~<&'text'&>
30423 .cindex "&%continue%& ACL modifier"
30424 .cindex "database" "updating in ACL"
30425 This modifier does nothing of itself, and processing of the ACL always
30426 continues with the next condition or modifier. The value of &%continue%& is in
30427 the side effects of expanding its argument. Typically this could be used to
30428 update a database. It is really just a syntactic tidiness, to avoid having to
30429 write rather ugly lines like this:
30430 .display
30431 &`condition = ${if eq{0}{`&<&'some expansion'&>&`}{true}{true}}`&
30432 .endd
30433 Instead, all you need is
30434 .display
30435 &`continue = `&<&'some expansion'&>
30436 .endd
30437
30438 .vitem &*control*&&~=&~<&'text'&>
30439 .cindex "&%control%& ACL modifier"
30440 This modifier affects the subsequent processing of the SMTP connection or of an
30441 incoming message that is accepted. The effect of the first type of control
30442 lasts for the duration of the connection, whereas the effect of the second type
30443 lasts only until the current message has been received. The message-specific
30444 controls always apply to the whole message, not to individual recipients,
30445 even if the &%control%& modifier appears in a RCPT ACL.
30446
30447 As there are now quite a few controls that can be applied, they are described
30448 separately in section &<<SECTcontrols>>&. The &%control%& modifier can be used
30449 in several different ways. For example:
30450
30451 . ==== As this is a nested list, any displays it contains must be indented
30452 . ==== as otherwise they are too far to the left. That comment applies only
30453 . ==== when xmlto and fop are used; formatting with sdop gets it right either
30454 . ==== way.
30455
30456 .ilist
30457 It can be at the end of an &%accept%& statement:
30458 .code
30459     accept  ...some conditions
30460             control = queue
30461 .endd
30462 In this case, the control is applied when this statement yields &"accept"&, in
30463 other words, when the conditions are all true.
30464
30465 .next
30466 It can be in the middle of an &%accept%& statement:
30467 .code
30468     accept  ...some conditions...
30469             control = queue
30470             ...some more conditions...
30471 .endd
30472 If the first set of conditions are true, the control is applied, even if the
30473 statement does not accept because one of the second set of conditions is false.
30474 In this case, some subsequent statement must yield &"accept"& for the control
30475 to be relevant.
30476
30477 .next
30478 It can be used with &%warn%& to apply the control, leaving the
30479 decision about accepting or denying to a subsequent verb. For
30480 example:
30481 .code
30482     warn    ...some conditions...
30483             control = freeze
30484     accept  ...
30485 .endd
30486 This example of &%warn%& does not contain &%message%&, &%log_message%&, or
30487 &%logwrite%&, so it does not add anything to the message and does not write a
30488 log entry.
30489
30490 .next
30491 If you want to apply a control unconditionally, you can use it with a
30492 &%require%& verb. For example:
30493 .code
30494     require  control = no_multiline_responses
30495 .endd
30496 .endlist
30497
30498 .vitem &*delay*&&~=&~<&'time'&>
30499 .cindex "&%delay%& ACL modifier"
30500 .oindex "&%-bh%&"
30501 This modifier may appear in any ACL except notquit. It causes Exim to wait for
30502 the time interval before proceeding. However, when testing Exim using the
30503 &%-bh%& option, the delay is not actually imposed (an appropriate message is
30504 output instead). The time is given in the usual Exim notation, and the delay
30505 happens as soon as the modifier is processed. In an SMTP session, pending
30506 output is flushed before the delay is imposed.
30507
30508 Like &%control%&, &%delay%& can be used with &%accept%& or &%deny%&, for
30509 example:
30510 .code
30511 deny    ...some conditions...
30512         delay = 30s
30513 .endd
30514 The delay happens if all the conditions are true, before the statement returns
30515 &"deny"&. Compare this with:
30516 .code
30517 deny    delay = 30s
30518         ...some conditions...
30519 .endd
30520 which waits for 30s before processing the conditions. The &%delay%& modifier
30521 can also be used with &%warn%& and together with &%control%&:
30522 .code
30523 warn    ...some conditions...
30524         delay = 2m
30525         control = freeze
30526 accept  ...
30527 .endd
30528
30529 If &%delay%& is encountered when the SMTP PIPELINING extension is in use,
30530 responses to several commands are no longer buffered and sent in one packet (as
30531 they would normally be) because all output is flushed before imposing the
30532 delay. This optimization is disabled so that a number of small delays do not
30533 appear to the client as one large aggregated delay that might provoke an
30534 unwanted timeout. You can, however, disable output flushing for &%delay%& by
30535 using a &%control%& modifier to set &%no_delay_flush%&.
30536
30537
30538 .vitem &*endpass*&
30539 .cindex "&%endpass%& ACL modifier"
30540 This modifier, which has no argument, is recognized only in &%accept%& and
30541 &%discard%& statements. It marks the boundary between the conditions whose
30542 failure causes control to pass to the next statement, and the conditions whose
30543 failure causes the ACL to return &"deny"&. This concept has proved to be
30544 confusing to some people, so the use of &%endpass%& is no longer recommended as
30545 &"best practice"&. See the description of &%accept%& above for more details.
30546
30547
30548 .vitem &*log_message*&&~=&~<&'text'&>
30549 .cindex "&%log_message%& ACL modifier"
30550 This modifier sets up a message that is used as part of the log message if the
30551 ACL denies access or a &%warn%& statement's conditions are true. For example:
30552 .code
30553 require log_message = wrong cipher suite $tls_in_cipher
30554         encrypted   = DES-CBC3-SHA
30555 .endd
30556 &%log_message%& is also used when recipients are discarded by &%discard%&. For
30557 example:
30558 .display
30559 &`discard `&<&'some conditions'&>
30560 &`        log_message = Discarded $local_part@$domain because...`&
30561 .endd
30562 When access is denied, &%log_message%& adds to any underlying error message
30563 that may exist because of a condition failure. For example, while verifying a
30564 recipient address, a &':fail:'& redirection might have already set up a
30565 message.
30566
30567 The message may be defined before the conditions to which it applies, because
30568 the string expansion does not happen until Exim decides that access is to be
30569 denied. This means that any variables that are set by the condition are
30570 available for inclusion in the message. For example, the &$dnslist_$&<&'xxx'&>
30571 variables are set after a DNS black list lookup succeeds. If the expansion of
30572 &%log_message%& fails, or if the result is an empty string, the modifier is
30573 ignored.
30574
30575 .vindex "&$acl_verify_message$&"
30576 If you want to use a &%warn%& statement to log the result of an address
30577 verification, you can use &$acl_verify_message$& to include the verification
30578 error message.
30579
30580 If &%log_message%& is used with a &%warn%& statement, &"Warning:"& is added to
30581 the start of the logged message. If the same warning log message is requested
30582 more than once while receiving  a single email message, only one copy is
30583 actually logged. If you want to log multiple copies, use &%logwrite%& instead
30584 of &%log_message%&. In the absence of &%log_message%& and &%logwrite%&, nothing
30585 is logged for a successful &%warn%& statement.
30586
30587 If &%log_message%& is not present and there is no underlying error message (for
30588 example, from the failure of address verification), but &%message%& is present,
30589 the &%message%& text is used for logging rejections. However, if any text for
30590 logging contains newlines, only the first line is logged. In the absence of
30591 both &%log_message%& and &%message%&, a default built-in message is used for
30592 logging rejections.
30593
30594
30595 .vitem "&*log_reject_target*&&~=&~<&'log name list'&>"
30596 .cindex "&%log_reject_target%& ACL modifier"
30597 .cindex "logging in ACL" "specifying which log"
30598 This modifier makes it possible to specify which logs are used for messages
30599 about ACL rejections. Its argument is a colon-separated list of words that can
30600 be &"main"&, &"reject"&, or &"panic"&. The default is &`main:reject`&. The list
30601 may be empty, in which case a rejection is not logged at all. For example, this
30602 ACL fragment writes no logging information when access is denied:
30603 .display
30604 &`deny `&<&'some conditions'&>
30605 &`     log_reject_target =`&
30606 .endd
30607 This modifier can be used in SMTP and non-SMTP ACLs. It applies to both
30608 permanent and temporary rejections. Its effect lasts for the rest of the
30609 current ACL.
30610
30611
30612 .vitem &*logwrite*&&~=&~<&'text'&>
30613 .cindex "&%logwrite%& ACL modifier"
30614 .cindex "logging in ACL" "immediate"
30615 This modifier writes a message to a log file as soon as it is encountered when
30616 processing an ACL. (Compare &%log_message%&, which, except in the case of
30617 &%warn%& and &%discard%&, is used only if the ACL statement denies
30618 access.) The &%logwrite%& modifier can be used to log special incidents in
30619 ACLs. For example:
30620 .display
30621 &`accept `&<&'some special conditions'&>
30622 &`       control  = freeze`&
30623 &`       logwrite = froze message because ...`&
30624 .endd
30625 By default, the message is written to the main log. However, it may begin
30626 with a colon, followed by a comma-separated list of log names, and then
30627 another colon, to specify exactly which logs are to be written. For
30628 example:
30629 .code
30630 logwrite = :main,reject: text for main and reject logs
30631 logwrite = :panic: text for panic log only
30632 .endd
30633
30634
30635 .vitem &*message*&&~=&~<&'text'&>
30636 .cindex "&%message%& ACL modifier"
30637 This modifier sets up a text string that is expanded and used as a response
30638 message when an ACL statement terminates the ACL with an &"accept"&, &"deny"&,
30639 or &"defer"& response. (In the case of the &%accept%& and &%discard%& verbs,
30640 there is some complication if &%endpass%& is involved; see the description of
30641 &%accept%& for details.)
30642
30643 The expansion of the message happens at the time Exim decides that the ACL is
30644 to end, not at the time it processes &%message%&. If the expansion fails, or
30645 generates an empty string, the modifier is ignored. Here is an example where
30646 &%message%& must be specified first, because the ACL ends with a rejection if
30647 the &%hosts%& condition fails:
30648 .code
30649 require  message = Host not recognized
30650          hosts = 10.0.0.0/8
30651 .endd
30652 (Once a condition has failed, no further conditions or modifiers are
30653 processed.)
30654
30655 .cindex "SMTP" "error codes"
30656 .oindex "&%smtp_banner%&
30657 For ACLs that are triggered by SMTP commands, the message is returned as part
30658 of the SMTP response. The use of &%message%& with &%accept%& (or &%discard%&)
30659 is meaningful only for SMTP, as no message is returned when a non-SMTP message
30660 is accepted. In the case of the connect ACL, accepting with a message modifier
30661 overrides the value of &%smtp_banner%&. For the EHLO/HELO ACL, a customized
30662 accept message may not contain more than one line (otherwise it will be
30663 truncated at the first newline and a panic logged), and it cannot affect the
30664 EHLO options.
30665
30666 When SMTP is involved, the message may begin with an overriding response code,
30667 consisting of three digits optionally followed by an &"extended response code"&
30668 of the form &'n.n.n'&, each code being followed by a space. For example:
30669 .code
30670 deny  message = 599 1.2.3 Host not welcome
30671       hosts = 192.168.34.0/24
30672 .endd
30673 The first digit of the supplied response code must be the same as would be sent
30674 by default. A panic occurs if it is not. Exim uses a 550 code when it denies
30675 access, but for the predata ACL, note that the default success code is 354, not
30676 2&'xx'&.
30677
30678 Notwithstanding the previous paragraph, for the QUIT ACL, unlike the others,
30679 the message modifier cannot override the 221 response code.
30680
30681 The text in a &%message%& modifier is literal; any quotes are taken as
30682 literals, but because the string is expanded, backslash escapes are processed
30683 anyway. If the message contains newlines, this gives rise to a multi-line SMTP
30684 response.
30685
30686 .vindex "&$acl_verify_message$&"
30687 For ACLs that are called by an &%acl =%& ACL condition, the message is
30688 stored in &$acl_verify_message$&, from which the calling ACL may use it.
30689
30690 If &%message%& is used on a statement that verifies an address, the message
30691 specified overrides any message that is generated by the verification process.
30692 However, the original message is available in the variable
30693 &$acl_verify_message$&, so you can incorporate it into your message if you
30694 wish. In particular, if you want the text from &%:fail:%& items in &(redirect)&
30695 routers to be passed back as part of the SMTP response, you should either not
30696 use a &%message%& modifier, or make use of &$acl_verify_message$&.
30697
30698 For compatibility with previous releases of Exim, a &%message%& modifier that
30699 is used with a &%warn%& verb behaves in a similar way to the &%add_header%&
30700 modifier, but this usage is now deprecated. However, &%message%& acts only when
30701 all the conditions are true, wherever it appears in an ACL command, whereas
30702 &%add_header%& acts as soon as it is encountered. If &%message%& is used with
30703 &%warn%& in an ACL that is not concerned with receiving a message, it has no
30704 effect.
30705
30706
30707 .vitem &*queue*&&~=&~<&'text'&>
30708 .cindex "&%queue%& ACL modifier"
30709 .cindex "named queues" "selecting in ACL"
30710 This modifier specifies the use of a named queue for spool files
30711 for the message.
30712 It can only be used before the message is received (i.e. not in
30713 the DATA ACL).
30714 This could be used, for example, for known high-volume burst sources
30715 of traffic, or for quarantine of messages.
30716 Separate queue-runner processes will be needed for named queues.
30717 If the text after expansion is empty, the default queue is used.
30718
30719
30720 .vitem &*remove_header*&&~=&~<&'text'&>
30721 This modifier specifies one or more header names in a colon-separated list
30722  that are to be removed from an incoming message, assuming, of course, that
30723 the message is ultimately accepted. For details, see section &<<SECTremoveheadacl>>&.
30724
30725
30726 .vitem &*set*&&~<&'acl_name'&>&~=&~<&'value'&>
30727 .cindex "&%set%& ACL modifier"
30728 This modifier puts a value into one of the ACL variables (see section
30729 &<<SECTaclvariables>>&).
30730
30731
30732 .vitem &*udpsend*&&~=&~<&'parameters'&>
30733 .cindex "UDP communications"
30734 This modifier sends a UDP packet, for purposes such as statistics
30735 collection or behaviour monitoring. The parameters are expanded, and
30736 the result of the expansion must be a colon-separated list consisting
30737 of a destination server, port number, and the packet contents. The
30738 server can be specified as a host name or IPv4 or IPv6 address. The
30739 separator can be changed with the usual angle bracket syntax. For
30740 example, you might want to collect information on which hosts connect
30741 when:
30742 .code
30743 udpsend = <; 2001:dB8::dead:beef ; 1234 ;\
30744              $tod_zulu $sender_host_address
30745 .endd
30746 .endlist
30747
30748
30749
30750
30751 .section "Use of the control modifier" "SECTcontrols"
30752 .cindex "&%control%& ACL modifier"
30753 The &%control%& modifier supports the following settings:
30754
30755 .vlist
30756 .vitem &*control&~=&~allow_auth_unadvertised*&
30757 This modifier allows a client host to use the SMTP AUTH command even when it
30758 has not been advertised in response to EHLO. Furthermore, because there are
30759 apparently some really broken clients that do this, Exim will accept AUTH after
30760 HELO (rather than EHLO) when this control is set. It should be used only if you
30761 really need it, and you should limit its use to those broken clients that do
30762 not work without it. For example:
30763 .code
30764 warn hosts   = 192.168.34.25
30765      control = allow_auth_unadvertised
30766 .endd
30767 Normally, when an Exim server receives an AUTH command, it checks the name of
30768 the authentication mechanism that is given in the command to ensure that it
30769 matches an advertised mechanism. When this control is set, the check that a
30770 mechanism has been advertised is bypassed. Any configured mechanism can be used
30771 by the client. This control is permitted only in the connection and HELO ACLs.
30772
30773
30774 .vitem &*control&~=&~caseful_local_part*& &&&
30775        &*control&~=&~caselower_local_part*&
30776 .cindex "&ACL;" "case of local part in"
30777 .cindex "case of local parts"
30778 .vindex "&$local_part$&"
30779 These two controls are permitted only in the ACL specified by &%acl_smtp_rcpt%&
30780 (that is, during RCPT processing). By default, the contents of &$local_part$&
30781 are lower cased before ACL processing. If &"caseful_local_part"& is specified,
30782 any uppercase letters in the original local part are restored in &$local_part$&
30783 for the rest of the ACL, or until a control that sets &"caselower_local_part"&
30784 is encountered.
30785
30786 These controls affect only the current recipient. Moreover, they apply only to
30787 local part handling that takes place directly in the ACL (for example, as a key
30788 in lookups). If a test to verify the recipient is obeyed, the case-related
30789 handling of the local part during the verification is controlled by the router
30790 configuration (see the &%caseful_local_part%& generic router option).
30791
30792 This facility could be used, for example, to add a spam score to local parts
30793 containing upper case letters. For example, using &$acl_m4$& to accumulate the
30794 spam score:
30795 .code
30796 warn  control = caseful_local_part
30797       set acl_m4 = ${eval:\
30798                      $acl_m4 + \
30799                      ${if match{$local_part}{[A-Z]}{1}{0}}\
30800                     }
30801       control = caselower_local_part
30802 .endd
30803 Notice that we put back the lower cased version afterwards, assuming that
30804 is what is wanted for subsequent tests.
30805
30806
30807 .vitem &*control&~=&~cutthrough_delivery/*&<&'options'&>
30808 .cindex "&ACL;" "cutthrough routing"
30809 .cindex "cutthrough" "requesting"
30810 This option requests delivery be attempted while the item is being received.
30811
30812 The option is usable in the RCPT ACL.
30813 If enabled for a message received via smtp and routed to an smtp transport,
30814 and only one transport, interface, destination host and port combination
30815 is used for all recipients of the message,
30816 then the delivery connection is made while the receiving connection is open
30817 and data is copied from one to the other.
30818
30819 An attempt to set this option for any recipient but the first
30820 for a mail will be quietly ignored.
30821 If a recipient-verify callout
30822 (with use_sender)
30823 connection is subsequently
30824 requested in the same ACL it is held open and used for
30825 any subsequent recipients and the data,
30826 otherwise one is made after the initial RCPT ACL completes.
30827
30828 Note that routers are used in verify mode,
30829 and cannot depend on content of received headers.
30830 Note also that headers cannot be
30831 modified by any of the post-data ACLs (DATA, MIME and DKIM).
30832 Headers may be modified by routers (subject to the above) and transports.
30833 The &'Received-By:'& header is generated as soon as the body reception starts,
30834 rather than the traditional time after the full message is received;
30835 this will affect the timestamp.
30836
30837 All the usual ACLs are called; if one results in the message being
30838 rejected, all effort spent in delivery (including the costs on
30839 the ultimate destination) will be wasted.
30840 Note that in the case of data-time ACLs this includes the entire
30841 message body.
30842
30843 Cutthrough delivery is not supported via transport-filters or when DKIM signing
30844 of outgoing messages is done, because it sends data to the ultimate destination
30845 before the entire message has been received from the source.
30846 It is not supported for messages received with the SMTP PRDR
30847 or CHUNKING
30848 options in use.
30849
30850 Should the ultimate destination system positively accept or reject the mail,
30851 a corresponding indication is given to the source system and nothing is queued.
30852 If the item is successfully delivered in cutthrough mode
30853 the delivery log lines are tagged with ">>" rather than "=>" and appear
30854 before the acceptance "<=" line.
30855
30856 If there is a temporary error the item is queued for later delivery in the
30857 usual fashion.
30858 This behaviour can be adjusted by appending the option &*defer=*&<&'value'&>
30859 to the control; the default value is &"spool"& and the alternate value
30860 &"pass"& copies an SMTP defer response from the target back to the initiator
30861 and does not queue the message.
30862 Note that this is independent of any recipient verify conditions in the ACL.
30863
30864 Delivery in this mode avoids the generation of a bounce mail to a
30865 (possibly faked)
30866 sender when the destination system is doing content-scan based rejection.
30867
30868
30869 .vitem &*control&~=&~debug/*&<&'options'&>
30870 .cindex "&ACL;" "enabling debug logging"
30871 .cindex "debugging" "enabling from an ACL"
30872 This control turns on debug logging, almost as though Exim had been invoked
30873 with &`-d`&, with the output going to a new logfile in the usual logs directory,
30874 by default called &'debuglog'&.
30875 The filename can be adjusted with the &'tag'& option, which
30876 may access any variables already defined.  The logging may be adjusted with
30877 the &'opts'& option, which takes the same values as the &`-d`& command-line
30878 option.
30879 Logging started this way may be stopped, and the file removed,
30880 with the &'kill'& option.
30881 Some examples (which depend on variables that don't exist in all
30882 contexts):
30883 .code
30884       control = debug
30885       control = debug/tag=.$sender_host_address
30886       control = debug/opts=+expand+acl
30887       control = debug/tag=.$message_exim_id/opts=+expand
30888       control = debug/kill
30889 .endd
30890
30891
30892 .vitem &*control&~=&~dkim_disable_verify*&
30893 .cindex "disable DKIM verify"
30894 .cindex "DKIM" "disable verify"
30895 This control turns off DKIM verification processing entirely.  For details on
30896 the operation and configuration of DKIM, see section &<<SECDKIM>>&.
30897
30898
30899 .vitem &*control&~=&~dmarc_disable_verify*&
30900 .cindex "disable DMARC verify"
30901 .cindex "DMARC" "disable verify"
30902 This control turns off DMARC verification processing entirely.  For details on
30903 the operation and configuration of DMARC, see section &<<SECDMARC>>&.
30904
30905
30906 .vitem &*control&~=&~dscp/*&<&'value'&>
30907 .cindex "&ACL;" "setting DSCP value"
30908 .cindex "DSCP" "inbound"
30909 This option causes the DSCP value associated with the socket for the inbound
30910 connection to be adjusted to a given value, given as one of a number of fixed
30911 strings or to numeric value.
30912 The &%-bI:dscp%& option may be used to ask Exim which names it knows of.
30913 Common values include &`throughput`&, &`mincost`&, and on newer systems
30914 &`ef`&, &`af41`&, etc.  Numeric values may be in the range 0 to 0x3F.
30915
30916 The outbound packets from Exim will be marked with this value in the header
30917 (for IPv4, the TOS field; for IPv6, the TCLASS field); there is no guarantee
30918 that these values will have any effect, not be stripped by networking
30919 equipment, or do much of anything without cooperation with your Network
30920 Engineer and those of all network operators between the source and destination.
30921
30922
30923 .vitem &*control&~=&~enforce_sync*& &&&
30924        &*control&~=&~no_enforce_sync*&
30925 .cindex "SMTP" "synchronization checking"
30926 .cindex "synchronization checking in SMTP"
30927 These controls make it possible to be selective about when SMTP synchronization
30928 is enforced. The global option &%smtp_enforce_sync%& specifies the initial
30929 state of the switch (it is true by default). See the description of this option
30930 in chapter &<<CHAPmainconfig>>& for details of SMTP synchronization checking.
30931
30932 The effect of these two controls lasts for the remainder of the SMTP
30933 connection. They can appear in any ACL except the one for the non-SMTP
30934 messages. The most straightforward place to put them is in the ACL defined by
30935 &%acl_smtp_connect%&, which is run at the start of an incoming SMTP connection,
30936 before the first synchronization check. The expected use is to turn off the
30937 synchronization checks for badly-behaved hosts that you nevertheless need to
30938 work with.
30939
30940
30941 .vitem &*control&~=&~fakedefer/*&<&'message'&>
30942 .cindex "fake defer"
30943 .cindex "defer, fake"
30944 This control works in exactly the same way as &%fakereject%& (described below)
30945 except that it causes an SMTP 450 response after the message data instead of a
30946 550 response. You must take care when using &%fakedefer%& because it causes the
30947 messages to be duplicated when the sender retries. Therefore, you should not
30948 use &%fakedefer%& if the message is to be delivered normally.
30949
30950 .vitem &*control&~=&~fakereject/*&<&'message'&>
30951 .cindex "fake rejection"
30952 .cindex "rejection, fake"
30953 This control is permitted only for the MAIL, RCPT, and DATA ACLs, in other
30954 words, only when an SMTP message is being received. If Exim accepts the
30955 message, instead the final 250 response, a 550 rejection message is sent.
30956 However, Exim proceeds to deliver the message as normal. The control applies
30957 only to the current message, not to any subsequent ones that may be received in
30958 the same SMTP connection.
30959
30960 The text for the 550 response is taken from the &%control%& modifier. If no
30961 message is supplied, the following is used:
30962 .code
30963 550-Your message has been rejected but is being
30964 550-kept for evaluation.
30965 550-If it was a legitimate message, it may still be
30966 550 delivered to the target recipient(s).
30967 .endd
30968 This facility should be used with extreme caution.
30969
30970 .vitem &*control&~=&~freeze*&
30971 .cindex "frozen messages" "forcing in ACL"
30972 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
30973 other words, only when a message is being received. If the message is accepted,
30974 it is placed on Exim's queue and frozen. The control applies only to the
30975 current message, not to any subsequent ones that may be received in the same
30976 SMTP connection.
30977
30978 This modifier can optionally be followed by &`/no_tell`&. If the global option
30979 &%freeze_tell%& is set, it is ignored for the current message (that is, nobody
30980 is told about the freezing), provided all the &*control=freeze*& modifiers that
30981 are obeyed for the current message have the &`/no_tell`& option.
30982
30983 .vitem &*control&~=&~no_delay_flush*&
30984 .cindex "SMTP" "output flushing, disabling for delay"
30985 Exim normally flushes SMTP output before implementing a delay in an ACL, to
30986 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
30987 use. This control, as long as it is encountered before the &%delay%& modifier,
30988 disables such output flushing.
30989
30990 .vitem &*control&~=&~no_callout_flush*&
30991 .cindex "SMTP" "output flushing, disabling for callout"
30992 Exim normally flushes SMTP output before performing a callout in an ACL, to
30993 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
30994 use. This control, as long as it is encountered before the &%verify%& condition
30995 that causes the callout, disables such output flushing.
30996
30997 .vitem &*control&~=&~no_mbox_unspool*&
30998 This control is available when Exim is compiled with the content scanning
30999 extension. Content scanning may require a copy of the current message, or parts
31000 of it, to be written in &"mbox format"& to a spool file, for passing to a virus
31001 or spam scanner. Normally, such copies are deleted when they are no longer
31002 needed. If this control is set, the copies are not deleted. The control applies
31003 only to the current message, not to any subsequent ones that may be received in
31004 the same SMTP connection. It is provided for debugging purposes and is unlikely
31005 to be useful in production.
31006
31007 .vitem &*control&~=&~no_multiline_responses*&
31008 .cindex "multiline responses, suppressing"
31009 This control is permitted for any ACL except the one for non-SMTP messages.
31010 It seems that there are broken clients in use that cannot handle multiline
31011 SMTP responses, despite the fact that RFC 821 defined them over 20 years ago.
31012
31013 If this control is set, multiline SMTP responses from ACL rejections are
31014 suppressed. One way of doing this would have been to put out these responses as
31015 one long line. However, RFC 2821 specifies a maximum of 512 bytes per response
31016 (&"use multiline responses for more"& it says &-- ha!), and some of the
31017 responses might get close to that. So this facility, which is after all only a
31018 sop to broken clients, is implemented by doing two very easy things:
31019
31020 .ilist
31021 Extra information that is normally output as part of a rejection caused by
31022 sender verification failure is omitted. Only the final line (typically &"sender
31023 verification failed"&) is sent.
31024 .next
31025 If a &%message%& modifier supplies a multiline response, only the first
31026 line is output.
31027 .endlist
31028
31029 The setting of the switch can, of course, be made conditional on the
31030 calling host. Its effect lasts until the end of the SMTP connection.
31031
31032 .vitem &*control&~=&~no_pipelining*&
31033 .cindex "PIPELINING" "suppressing advertising"
31034 .cindex "ESMTP extensions" PIPELINING
31035 This control turns off the advertising of the PIPELINING extension to SMTP in
31036 the current session. To be useful, it must be obeyed before Exim sends its
31037 response to an EHLO command. Therefore, it should normally appear in an ACL
31038 controlled by &%acl_smtp_connect%& or &%acl_smtp_helo%&. See also
31039 &%pipelining_advertise_hosts%&.
31040
31041 .new
31042 .vitem &*control&~=&~queue/*&<&'options'&>* &&&
31043        &*control&~=&~queue_only*&
31044 .oindex "&%queue%&"
31045 .oindex "&%queue_only%&"
31046 .cindex "queueing incoming messages"
31047 .cindex queueing "forcing in ACL"
31048 .cindex "first pass routing"
31049 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
31050 other words, only when a message is being received. If the message is accepted,
31051 it is placed on Exim's queue and left there for delivery by a subsequent queue
31052 runner.
31053 If used with no options set,
31054 no immediate delivery process is started. In other words, it has the
31055 effect as the &%queue_only%& global option or &'-odq'& command-line option.
31056
31057 If the &'first_pass_route'& option is given then
31058 the behaviour is like the command-line &'-oqds'& option;
31059 a delivery process is started which stops short of making
31060 any SMTP delivery.  The benefit is that the hints database will be updated for
31061 the message being waiting for a specific host, and a later queue run will be
31062 able to send all such messages on a single connection.
31063
31064 The control only applies to the current message, not to any subsequent ones that
31065  may be received in the same SMTP connection.
31066 .wen
31067
31068 .vitem &*control&~=&~submission/*&<&'options'&>
31069 .cindex "message" "submission"
31070 .cindex "submission mode"
31071 This control is permitted only for the MAIL, RCPT, and start of data ACLs (the
31072 latter is the one defined by &%acl_smtp_predata%&). Setting it tells Exim that
31073 the current message is a submission from a local MUA. In this case, Exim
31074 operates in &"submission mode"&, and applies certain fixups to the message if
31075 necessary. For example, it adds a &'Date:'& header line if one is not present.
31076 This control is not permitted in the &%acl_smtp_data%& ACL, because that is too
31077 late (the message has already been created).
31078
31079 Chapter &<<CHAPmsgproc>>& describes the processing that Exim applies to
31080 messages. Section &<<SECTsubmodnon>>& covers the processing that happens in
31081 submission mode; the available options for this control are described there.
31082 The control applies only to the current message, not to any subsequent ones
31083 that may be received in the same SMTP connection.
31084
31085 .vitem &*control&~=&~suppress_local_fixups*&
31086 .cindex "submission fixups, suppressing"
31087 This control applies to locally submitted (non TCP/IP) messages, and is the
31088 complement of &`control = submission`&. It disables the fixups that are
31089 normally applied to locally-submitted messages. Specifically:
31090
31091 .ilist
31092 Any &'Sender:'& header line is left alone (in this respect, it is a
31093 dynamic version of &%local_sender_retain%&).
31094 .next
31095 No &'Message-ID:'&, &'From:'&, or &'Date:'& header lines are added.
31096 .next
31097 There is no check that &'From:'& corresponds to the actual sender.
31098 .endlist ilist
31099
31100 This control may be useful when a remotely-originated message is accepted,
31101 passed to some scanning program, and then re-submitted for delivery. It can be
31102 used only in the &%acl_smtp_mail%&, &%acl_smtp_rcpt%&, &%acl_smtp_predata%&,
31103 and &%acl_not_smtp_start%& ACLs, because it has to be set before the message's
31104 data is read.
31105
31106 &*Note:*& This control applies only to the current message, not to any others
31107 that are being submitted at the same time using &%-bs%& or &%-bS%&.
31108
31109 .vitem &*control&~=&~utf8_downconvert*&
31110 This control enables conversion of UTF-8 in message envelope addresses
31111 to a-label form.
31112 For details see section &<<SECTi18nMTA>>&.
31113 .endlist vlist
31114
31115
31116 .section "Summary of message fixup control" "SECTsummesfix"
31117 All four possibilities for message fixups can be specified:
31118
31119 .ilist
31120 Locally submitted, fixups applied: the default.
31121 .next
31122 Locally submitted, no fixups applied: use
31123 &`control = suppress_local_fixups`&.
31124 .next
31125 Remotely submitted, no fixups applied: the default.
31126 .next
31127 Remotely submitted, fixups applied: use &`control = submission`&.
31128 .endlist
31129
31130
31131
31132 .section "Adding header lines in ACLs" "SECTaddheadacl"
31133 .cindex "header lines" "adding in an ACL"
31134 .cindex "header lines" "position of added lines"
31135 .cindex "&%add_header%& ACL modifier"
31136 The &%add_header%& modifier can be used to add one or more extra header lines
31137 to an incoming message, as in this example:
31138 .code
31139 warn dnslists = sbl.spamhaus.org : \
31140                 dialup.mail-abuse.org
31141      add_header = X-blacklisted-at: $dnslist_domain
31142 .endd
31143 The &%add_header%& modifier is permitted in the MAIL, RCPT, PREDATA, DATA,
31144 MIME, DKIM, and non-SMTP ACLs (in other words, those that are concerned with
31145 receiving a message). The message must ultimately be accepted for
31146 &%add_header%& to have any significant effect. You can use &%add_header%& with
31147 any ACL verb, including &%deny%& (though this is potentially useful only in a
31148 RCPT ACL).
31149
31150 Headers will not be added to the message if the modifier is used in
31151 DATA, MIME or DKIM ACLs for a message delivered by cutthrough routing.
31152
31153 Leading and trailing newlines are removed from
31154 the data for the &%add_header%& modifier; if it then
31155 contains one or more newlines that
31156 are not followed by a space or a tab, it is assumed to contain multiple header
31157 lines. Each one is checked for valid syntax; &`X-ACL-Warn:`& is added to the
31158 front of any line that is not a valid header line.
31159
31160 Added header lines are accumulated during the MAIL, RCPT, and predata ACLs.
31161 They are added to the message before processing the DATA and MIME ACLs.
31162 However, if an identical header line is requested more than once, only one copy
31163 is actually added to the message. Further header lines may be accumulated
31164 during the DATA and MIME ACLs, after which they are added to the message, again
31165 with duplicates suppressed. Thus, it is possible to add two identical header
31166 lines to an SMTP message, but only if one is added before DATA and one after.
31167 In the case of non-SMTP messages, new headers are accumulated during the
31168 non-SMTP ACLs, and are added to the message after all the ACLs have run. If a
31169 message is rejected after DATA or by the non-SMTP ACL, all added header lines
31170 are included in the entry that is written to the reject log.
31171
31172 .cindex "header lines" "added; visibility of"
31173 Header lines are not visible in string expansions
31174 of message headers
31175 until they are added to the
31176 message. It follows that header lines defined in the MAIL, RCPT, and predata
31177 ACLs are not visible until the DATA ACL and MIME ACLs are run. Similarly,
31178 header lines that are added by the DATA or MIME ACLs are not visible in those
31179 ACLs. Because of this restriction, you cannot use header lines as a way of
31180 passing data between (for example) the MAIL and RCPT ACLs. If you want to do
31181 this, you can use ACL variables, as described in section
31182 &<<SECTaclvariables>>&.
31183
31184 The list of headers yet to be added is given by the &%$headers_added%& variable.
31185
31186 The &%add_header%& modifier acts immediately as it is encountered during the
31187 processing of an ACL. Notice the difference between these two cases:
31188 .display
31189 &`accept add_header = ADDED: some text`&
31190 &`       `&<&'some condition'&>
31191
31192 &`accept `&<&'some condition'&>
31193 &`       add_header = ADDED: some text`&
31194 .endd
31195 In the first case, the header line is always added, whether or not the
31196 condition is true. In the second case, the header line is added only if the
31197 condition is true. Multiple occurrences of &%add_header%& may occur in the same
31198 ACL statement. All those that are encountered before a condition fails are
31199 honoured.
31200
31201 .cindex "&%warn%& ACL verb"
31202 For compatibility with previous versions of Exim, a &%message%& modifier for a
31203 &%warn%& verb acts in the same way as &%add_header%&, except that it takes
31204 effect only if all the conditions are true, even if it appears before some of
31205 them. Furthermore, only the last occurrence of &%message%& is honoured. This
31206 usage of &%message%& is now deprecated. If both &%add_header%& and &%message%&
31207 are present on a &%warn%& verb, both are processed according to their
31208 specifications.
31209
31210 By default, new header lines are added to a message at the end of the existing
31211 header lines. However, you can specify that any particular header line should
31212 be added right at the start (before all the &'Received:'& lines), immediately
31213 after the first block of &'Received:'& lines, or immediately before any line
31214 that is not a &'Received:'& or &'Resent-something:'& header.
31215
31216 This is done by specifying &":at_start:"&, &":after_received:"&, or
31217 &":at_start_rfc:"& (or, for completeness, &":at_end:"&) before the text of the
31218 header line, respectively. (Header text cannot start with a colon, as there has
31219 to be a header name first.) For example:
31220 .code
31221 warn add_header = \
31222        :after_received:X-My-Header: something or other...
31223 .endd
31224 If more than one header line is supplied in a single &%add_header%& modifier,
31225 each one is treated independently and can therefore be placed differently. If
31226 you add more than one line at the start, or after the Received: block, they end
31227 up in reverse order.
31228
31229 &*Warning*&: This facility currently applies only to header lines that are
31230 added in an ACL. It does NOT work for header lines that are added in a
31231 system filter or in a router or transport.
31232
31233
31234
31235 .section "Removing header lines in ACLs" "SECTremoveheadacl"
31236 .cindex "header lines" "removing in an ACL"
31237 .cindex "header lines" "position of removed lines"
31238 .cindex "&%remove_header%& ACL modifier"
31239 The &%remove_header%& modifier can be used to remove one or more header lines
31240 from an incoming message, as in this example:
31241 .code
31242 warn   message        = Remove internal headers
31243        remove_header  = x-route-mail1 : x-route-mail2
31244 .endd
31245 The &%remove_header%& modifier is permitted in the MAIL, RCPT, PREDATA, DATA,
31246 MIME, DKIM, and non-SMTP ACLs (in other words, those that are concerned with
31247 receiving a message). The message must ultimately be accepted for
31248 &%remove_header%& to have any significant effect. You can use &%remove_header%&
31249 with any ACL verb, including &%deny%&, though this is really not useful for
31250 any verb that doesn't result in a delivered message.
31251
31252 Headers will not be removed from the message if the modifier is used in
31253 DATA, MIME or DKIM ACLs for a message delivered by cutthrough routing.
31254
31255 More than one header can be removed at the same time by using a colon separated
31256 list of header names. The header matching is case insensitive. Wildcards are
31257 not permitted, nor is list expansion performed, so you cannot use hostlists to
31258 create a list of headers, however both connection and message variable expansion
31259 are performed (&%$acl_c_*%& and &%$acl_m_*%&), illustrated in this example:
31260 .code
31261 warn   hosts           = +internal_hosts
31262        set acl_c_ihdrs = x-route-mail1 : x-route-mail2
31263 warn   message         = Remove internal headers
31264        remove_header   = $acl_c_ihdrs
31265 .endd
31266 Header names for removal are accumulated during the MAIL, RCPT, and predata ACLs.
31267 Matching header lines are removed from the message before processing the DATA and MIME ACLs.
31268 If multiple header lines match, all are removed.
31269 There is no harm in attempting to remove the same header twice nor in removing
31270 a non-existent header. Further header lines to be removed may be accumulated
31271 during the DATA and MIME ACLs, after which they are removed from the message,
31272 if present. In the case of non-SMTP messages, headers to be removed are
31273 accumulated during the non-SMTP ACLs, and are removed from the message after
31274 all the ACLs have run. If a message is rejected after DATA or by the non-SMTP
31275 ACL, there really is no effect because there is no logging of what headers
31276 would have been removed.
31277
31278 .cindex "header lines" "removed; visibility of"
31279 Header lines are not visible in string expansions until the DATA phase when it
31280 is received. Any header lines removed in the MAIL, RCPT, and predata ACLs are
31281 not visible in the DATA ACL and MIME ACLs. Similarly, header lines that are
31282 removed by the DATA or MIME ACLs are still visible in those ACLs. Because of
31283 this restriction, you cannot use header lines as a way of controlling data
31284 passed between (for example) the MAIL and RCPT ACLs. If you want to do this,
31285 you should instead use ACL variables, as described in section
31286 &<<SECTaclvariables>>&.
31287
31288 The &%remove_header%& modifier acts immediately as it is encountered during the
31289 processing of an ACL. Notice the difference between these two cases:
31290 .display
31291 &`accept remove_header = X-Internal`&
31292 &`       `&<&'some condition'&>
31293
31294 &`accept `&<&'some condition'&>
31295 &`       remove_header = X-Internal`&
31296 .endd
31297 In the first case, the header line is always removed, whether or not the
31298 condition is true. In the second case, the header line is removed only if the
31299 condition is true. Multiple occurrences of &%remove_header%& may occur in the
31300 same ACL statement. All those that are encountered before a condition fails
31301 are honoured.
31302
31303 &*Warning*&: This facility currently applies only to header lines that are
31304 present during ACL processing. It does NOT remove header lines that are added
31305 in a system filter or in a router or transport.
31306
31307
31308
31309
31310 .section "ACL conditions" "SECTaclconditions"
31311 .cindex "&ACL;" "conditions; list of"
31312 Some of the conditions listed in this section are available only when Exim is
31313 compiled with the content-scanning extension. They are included here briefly
31314 for completeness. More detailed descriptions can be found in the discussion on
31315 content scanning in chapter &<<CHAPexiscan>>&.
31316
31317 Not all conditions are relevant in all circumstances. For example, testing
31318 senders and recipients does not make sense in an ACL that is being run as the
31319 result of the arrival of an ETRN command, and checks on message headers can be
31320 done only in the ACLs specified by &%acl_smtp_data%& and &%acl_not_smtp%&. You
31321 can use the same condition (with different parameters) more than once in the
31322 same ACL statement. This provides a way of specifying an &"and"& conjunction.
31323 The conditions are as follows:
31324
31325
31326 .vlist
31327 .vitem &*acl&~=&~*&<&'name&~of&~acl&~or&~ACL&~string&~or&~file&~name&~'&>
31328 .cindex "&ACL;" "nested"
31329 .cindex "&ACL;" "indirect"
31330 .cindex "&ACL;" "arguments"
31331 .cindex "&%acl%& ACL condition"
31332 The possible values of the argument are the same as for the
31333 &%acl_smtp_%&&'xxx'& options. The named or inline ACL is run. If it returns
31334 &"accept"& the condition is true; if it returns &"deny"& the condition is
31335 false. If it returns &"defer"&, the current ACL returns &"defer"& unless the
31336 condition is on a &%warn%& verb. In that case, a &"defer"& return makes the
31337 condition false. This means that further processing of the &%warn%& verb
31338 ceases, but processing of the ACL continues.
31339
31340 If the argument is a named ACL, up to nine space-separated optional values
31341 can be appended; they appear within the called ACL in $acl_arg1 to $acl_arg9,
31342 and $acl_narg is set to the count of values.
31343 Previous values of these variables are restored after the call returns.
31344 The name and values are expanded separately.
31345 Note that spaces in complex expansions which are used as arguments
31346 will act as argument separators.
31347
31348 If the nested &%acl%& returns &"drop"& and the outer condition denies access,
31349 the connection is dropped. If it returns &"discard"&, the verb must be
31350 &%accept%& or &%discard%&, and the action is taken immediately &-- no further
31351 conditions are tested.
31352
31353 ACLs may be nested up to 20 deep; the limit exists purely to catch runaway
31354 loops. This condition allows you to use different ACLs in different
31355 circumstances. For example, different ACLs can be used to handle RCPT commands
31356 for different local users or different local domains.
31357
31358 .vitem &*authenticated&~=&~*&<&'string&~list'&>
31359 .cindex "&%authenticated%& ACL condition"
31360 .cindex "authentication" "ACL checking"
31361 .cindex "&ACL;" "testing for authentication"
31362 If the SMTP connection is not authenticated, the condition is false. Otherwise,
31363 the name of the authenticator is tested against the list. To test for
31364 authentication by any authenticator, you can set
31365 .code
31366 authenticated = *
31367 .endd
31368
31369 .vitem &*condition&~=&~*&<&'string'&>
31370 .cindex "&%condition%& ACL condition"
31371 .cindex "customizing" "ACL condition"
31372 .cindex "&ACL;" "customized test"
31373 .cindex "&ACL;" "testing, customized"
31374 This feature allows you to make up custom conditions. If the result of
31375 expanding the string is an empty string, the number zero, or one of the strings
31376 &"no"& or &"false"&, the condition is false. If the result is any non-zero
31377 number, or one of the strings &"yes"& or &"true"&, the condition is true. For
31378 any other value, some error is assumed to have occurred, and the ACL returns
31379 &"defer"&. However, if the expansion is forced to fail, the condition is
31380 ignored. The effect is to treat it as true, whether it is positive or
31381 negative.
31382
31383 .vitem &*decode&~=&~*&<&'location'&>
31384 .cindex "&%decode%& ACL condition"
31385 This condition is available only when Exim is compiled with the
31386 content-scanning extension, and it is allowed only in the ACL defined by
31387 &%acl_smtp_mime%&. It causes the current MIME part to be decoded into a file.
31388 If all goes well, the condition is true. It is false only if there are
31389 problems such as a syntax error or a memory shortage. For more details, see
31390 chapter &<<CHAPexiscan>>&.
31391
31392 .vitem &*dnslists&~=&~*&<&'list&~of&~domain&~names&~and&~other&~data'&>
31393 .cindex "&%dnslists%& ACL condition"
31394 .cindex "DNS list" "in ACL"
31395 .cindex "black list (DNS)"
31396 .cindex "&ACL;" "testing a DNS list"
31397 This condition checks for entries in DNS black lists. These are also known as
31398 &"RBL lists"&, after the original Realtime Blackhole List, but note that the
31399 use of the lists at &'mail-abuse.org'& now carries a charge. There are too many
31400 different variants of this condition to describe briefly here. See sections
31401 &<<SECTmorednslists>>&&--&<<SECTmorednslistslast>>& for details.
31402
31403 .vitem &*domains&~=&~*&<&'domain&~list'&>
31404 .cindex "&%domains%& ACL condition"
31405 .cindex "domain" "ACL checking"
31406 .cindex "&ACL;" "testing a recipient domain"
31407 .vindex "&$domain_data$&"
31408 This condition is relevant only after a RCPT command. It checks that the domain
31409 of the recipient address is in the domain list. If percent-hack processing is
31410 enabled, it is done before this test is done. If the check succeeds with a
31411 lookup, the result of the lookup is placed in &$domain_data$& until the next
31412 &%domains%& test.
31413
31414 &*Note carefully*& (because many people seem to fall foul of this): you cannot
31415 use &%domains%& in a DATA ACL.
31416
31417
31418 .vitem &*encrypted&~=&~*&<&'string&~list'&>
31419 .cindex "&%encrypted%& ACL condition"
31420 .cindex "encryption" "checking in an ACL"
31421 .cindex "&ACL;" "testing for encryption"
31422 If the SMTP connection is not encrypted, the condition is false. Otherwise, the
31423 name of the cipher suite in use is tested against the list. To test for
31424 encryption without testing for any specific cipher suite(s), set
31425 .code
31426 encrypted = *
31427 .endd
31428
31429
31430 .vitem &*hosts&~=&~*&<&'host&~list'&>
31431 .cindex "&%hosts%& ACL condition"
31432 .cindex "host" "ACL checking"
31433 .cindex "&ACL;" "testing the client host"
31434 This condition tests that the calling host matches the host list. If you have
31435 name lookups or wildcarded host names and IP addresses in the same host list,
31436 you should normally put the IP addresses first. For example, you could have:
31437 .code
31438 accept hosts = 10.9.8.7 : dbm;/etc/friendly/hosts
31439 .endd
31440 The lookup in this example uses the host name for its key. This is implied by
31441 the lookup type &"dbm"&. (For a host address lookup you would use &"net-dbm"&
31442 and it wouldn't matter which way round you had these two items.)
31443
31444 The reason for the problem with host names lies in the left-to-right way that
31445 Exim processes lists. It can test IP addresses without doing any DNS lookups,
31446 but when it reaches an item that requires a host name, it fails if it cannot
31447 find a host name to compare with the pattern. If the above list is given in the
31448 opposite order, the &%accept%& statement fails for a host whose name cannot be
31449 found, even if its IP address is 10.9.8.7.
31450
31451 If you really do want to do the name check first, and still recognize the IP
31452 address even if the name lookup fails, you can rewrite the ACL like this:
31453 .code
31454 accept hosts = dbm;/etc/friendly/hosts
31455 accept hosts = 10.9.8.7
31456 .endd
31457 The default action on failing to find the host name is to assume that the host
31458 is not in the list, so the first &%accept%& statement fails. The second
31459 statement can then check the IP address.
31460
31461 .vindex "&$host_data$&"
31462 If a &%hosts%& condition is satisfied by means of a lookup, the result
31463 of the lookup is made available in the &$host_data$& variable. This
31464 allows you, for example, to set up a statement like this:
31465 .code
31466 deny  hosts = net-lsearch;/some/file
31467       message = $host_data
31468 .endd
31469 which gives a custom error message for each denied host.
31470
31471 .vitem &*local_parts&~=&~*&<&'local&~part&~list'&>
31472 .cindex "&%local_parts%& ACL condition"
31473 .cindex "local part" "ACL checking"
31474 .cindex "&ACL;" "testing a local part"
31475 .vindex "&$local_part_data$&"
31476 This condition is relevant only after a RCPT command. It checks that the local
31477 part of the recipient address is in the list. If percent-hack processing is
31478 enabled, it is done before this test. If the check succeeds with a lookup, the
31479 result of the lookup is placed in &$local_part_data$&, which remains set until
31480 the next &%local_parts%& test.
31481
31482 .vitem &*malware&~=&~*&<&'option'&>
31483 .cindex "&%malware%& ACL condition"
31484 .cindex "&ACL;" "virus scanning"
31485 .cindex "&ACL;" "scanning for viruses"
31486 This condition is available only when Exim is compiled with the
31487 content-scanning extension
31488 and only after a DATA command.
31489 It causes the incoming message to be scanned for
31490 viruses. For details, see chapter &<<CHAPexiscan>>&.
31491
31492 .vitem &*mime_regex&~=&~*&<&'list&~of&~regular&~expressions'&>
31493 .cindex "&%mime_regex%& ACL condition"
31494 .cindex "&ACL;" "testing by regex matching"
31495 This condition is available only when Exim is compiled with the
31496 content-scanning extension, and it is allowed only in the ACL defined by
31497 &%acl_smtp_mime%&. It causes the current MIME part to be scanned for a match
31498 with any of the regular expressions. For details, see chapter
31499 &<<CHAPexiscan>>&.
31500
31501 .vitem &*ratelimit&~=&~*&<&'parameters'&>
31502 .cindex "rate limiting"
31503 This condition can be used to limit the rate at which a user or host submits
31504 messages. Details are given in section &<<SECTratelimiting>>&.
31505
31506 .vitem &*recipients&~=&~*&<&'address&~list'&>
31507 .cindex "&%recipients%& ACL condition"
31508 .cindex "recipient" "ACL checking"
31509 .cindex "&ACL;" "testing a recipient"
31510 This condition is relevant only after a RCPT command. It checks the entire
31511 recipient address against a list of recipients.
31512
31513 .vitem &*regex&~=&~*&<&'list&~of&~regular&~expressions'&>
31514 .cindex "&%regex%& ACL condition"
31515 .cindex "&ACL;" "testing by regex matching"
31516 This condition is available only when Exim is compiled with the
31517 content-scanning extension, and is available only in the DATA, MIME, and
31518 non-SMTP ACLs. It causes the incoming message to be scanned for a match with
31519 any of the regular expressions. For details, see chapter &<<CHAPexiscan>>&.
31520
31521 .vitem &*sender_domains&~=&~*&<&'domain&~list'&>
31522 .cindex "&%sender_domains%& ACL condition"
31523 .cindex "sender" "ACL checking"
31524 .cindex "&ACL;" "testing a sender domain"
31525 .vindex "&$domain$&"
31526 .vindex "&$sender_address_domain$&"
31527 This condition tests the domain of the sender of the message against the given
31528 domain list. &*Note*&: The domain of the sender address is in
31529 &$sender_address_domain$&. It is &'not'& put in &$domain$& during the testing
31530 of this condition. This is an exception to the general rule for testing domain
31531 lists. It is done this way so that, if this condition is used in an ACL for a
31532 RCPT command, the recipient's domain (which is in &$domain$&) can be used to
31533 influence the sender checking.
31534
31535 &*Warning*&: It is a bad idea to use this condition on its own as a control on
31536 relaying, because sender addresses are easily, and commonly, forged.
31537
31538 .vitem &*senders&~=&~*&<&'address&~list'&>
31539 .cindex "&%senders%& ACL condition"
31540 .cindex "sender" "ACL checking"
31541 .cindex "&ACL;" "testing a sender"
31542 This condition tests the sender of the message against the given list. To test
31543 for a bounce message, which has an empty sender, set
31544 .code
31545 senders = :
31546 .endd
31547 &*Warning*&: It is a bad idea to use this condition on its own as a control on
31548 relaying, because sender addresses are easily, and commonly, forged.
31549
31550 .vitem &*spam&~=&~*&<&'username'&>
31551 .cindex "&%spam%& ACL condition"
31552 .cindex "&ACL;" "scanning for spam"
31553 This condition is available only when Exim is compiled with the
31554 content-scanning extension. It causes the incoming message to be scanned by
31555 SpamAssassin. For details, see chapter &<<CHAPexiscan>>&.
31556
31557 .vitem &*verify&~=&~certificate*&
31558 .cindex "&%verify%& ACL condition"
31559 .cindex "TLS" "client certificate verification"
31560 .cindex "certificate" "verification of client"
31561 .cindex "&ACL;" "certificate verification"
31562 .cindex "&ACL;" "testing a TLS certificate"
31563 This condition is true in an SMTP session if the session is encrypted, and a
31564 certificate was received from the client, and the certificate was verified. The
31565 server requests a certificate only if the client matches &%tls_verify_hosts%&
31566 or &%tls_try_verify_hosts%& (see chapter &<<CHAPTLS>>&).
31567
31568 .vitem &*verify&~=&~csa*&
31569 .cindex "CSA verification"
31570 This condition checks whether the sending host (the client) is authorized to
31571 send email. Details of how this works are given in section
31572 &<<SECTverifyCSA>>&.
31573
31574 .vitem &*verify&~=&~header_names_ascii*&
31575 .cindex "&%verify%& ACL condition"
31576 .cindex "&ACL;" "verifying header names only ASCII"
31577 .cindex "header lines" "verifying header names only ASCII"
31578 .cindex "verifying" "header names only ASCII"
31579 This condition is relevant only in an ACL that is run after a message has been
31580 received, that is, in an ACL specified by &%acl_smtp_data%& or
31581 &%acl_not_smtp%&.  It checks all header names (not the content) to make sure
31582 there are no non-ASCII characters, also excluding control characters.  The
31583 allowable characters are decimal ASCII values 33 through 126.
31584
31585 Exim itself will handle headers with non-ASCII characters, but it can cause
31586 problems for downstream applications, so this option will allow their
31587 detection and rejection in the DATA ACL's.
31588
31589 .vitem &*verify&~=&~header_sender/*&<&'options'&>
31590 .cindex "&%verify%& ACL condition"
31591 .cindex "&ACL;" "verifying sender in the header"
31592 .cindex "header lines" "verifying the sender in"
31593 .cindex "sender" "verifying in header"
31594 .cindex "verifying" "sender in header"
31595 This condition is relevant only in an ACL that is run after a message has been
31596 received, that is, in an ACL specified by &%acl_smtp_data%& or
31597 &%acl_not_smtp%&. It checks that there is a verifiable address in at least one
31598 of the &'Sender:'&, &'Reply-To:'&, or &'From:'& header lines. Such an address
31599 is loosely thought of as a &"sender"& address (hence the name of the test).
31600 However, an address that appears in one of these headers need not be an address
31601 that accepts bounce messages; only sender addresses in envelopes are required
31602 to accept bounces. Therefore, if you use the callout option on this check, you
31603 might want to arrange for a non-empty address in the MAIL command.
31604
31605 Details of address verification and the options are given later, starting at
31606 section &<<SECTaddressverification>>& (callouts are described in section
31607 &<<SECTcallver>>&). You can combine this condition with the &%senders%&
31608 condition to restrict it to bounce messages only:
31609 .code
31610 deny    senders = :
31611        !verify  = header_sender
31612         message = A valid sender header is required for bounces
31613 .endd
31614
31615 .vitem &*verify&~=&~header_syntax*&
31616 .cindex "&%verify%& ACL condition"
31617 .cindex "&ACL;" "verifying header syntax"
31618 .cindex "header lines" "verifying syntax"
31619 .cindex "verifying" "header syntax"
31620 This condition is relevant only in an ACL that is run after a message has been
31621 received, that is, in an ACL specified by &%acl_smtp_data%& or
31622 &%acl_not_smtp%&. It checks the syntax of all header lines that can contain
31623 lists of addresses (&'Sender:'&, &'From:'&, &'Reply-To:'&, &'To:'&, &'Cc:'&,
31624 and &'Bcc:'&), returning true if there are no problems.
31625 Unqualified addresses (local parts without domains) are
31626 permitted only in locally generated messages and from hosts that match
31627 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
31628 appropriate.
31629
31630 Note that this condition is a syntax check only. However, a common spamming
31631 ploy used to be to send syntactically invalid headers such as
31632 .code
31633 To: @
31634 .endd
31635 and this condition can be used to reject such messages, though they are not as
31636 common as they used to be.
31637
31638 .vitem &*verify&~=&~helo*&
31639 .cindex "&%verify%& ACL condition"
31640 .cindex "&ACL;" "verifying HELO/EHLO"
31641 .cindex "HELO" "verifying"
31642 .cindex "EHLO" "verifying"
31643 .cindex "verifying" "EHLO"
31644 .cindex "verifying" "HELO"
31645 This condition is true if a HELO or EHLO command has been received from the
31646 client host, and its contents have been verified. If there has been no previous
31647 attempt to verify the HELO/EHLO contents, it is carried out when this
31648 condition is encountered. See the description of the &%helo_verify_hosts%& and
31649 &%helo_try_verify_hosts%& options for details of how to request verification
31650 independently of this condition, and for detail of the verification.
31651
31652 For SMTP input that does not come over TCP/IP (the &%-bs%& command line
31653 option), this condition is always true.
31654
31655
31656 .vitem &*verify&~=&~not_blind/*&<&'options'&>
31657 .cindex "verifying" "not blind"
31658 .cindex "bcc recipients, verifying none"
31659 This condition checks that there are no blind (bcc) recipients in the message.
31660 Every envelope recipient must appear either in a &'To:'& header line or in a
31661 &'Cc:'& header line for this condition to be true. Local parts are checked
31662 case-sensitively; domains are checked case-insensitively. If &'Resent-To:'& or
31663 &'Resent-Cc:'& header lines exist, they are also checked. This condition can be
31664 used only in a DATA or non-SMTP ACL.
31665
31666 There is one possible option, &`case_insensitive`&.  If this is present then
31667 local parts are checked case-insensitively.
31668
31669 There are, of course, many legitimate messages that make use of blind (bcc)
31670 recipients. This check should not be used on its own for blocking messages.
31671
31672
31673 .vitem &*verify&~=&~recipient/*&<&'options'&>
31674 .cindex "&%verify%& ACL condition"
31675 .cindex "&ACL;" "verifying recipient"
31676 .cindex "recipient" "verifying"
31677 .cindex "verifying" "recipient"
31678 .vindex "&$address_data$&"
31679 This condition is relevant only after a RCPT command. It verifies the current
31680 recipient. Details of address verification are given later, starting at section
31681 &<<SECTaddressverification>>&. After a recipient has been verified, the value
31682 of &$address_data$& is the last value that was set while routing the address.
31683 This applies even if the verification fails. When an address that is being
31684 verified is redirected to a single address, verification continues with the new
31685 address, and in that case, the subsequent value of &$address_data$& is the
31686 value for the child address.
31687
31688 .vitem &*verify&~=&~reverse_host_lookup/*&<&'options'&>
31689 .cindex "&%verify%& ACL condition"
31690 .cindex "&ACL;" "verifying host reverse lookup"
31691 .cindex "host" "verifying reverse lookup"
31692 This condition ensures that a verified host name has been looked up from the IP
31693 address of the client host. (This may have happened already if the host name
31694 was needed for checking a host list, or if the host matched &%host_lookup%&.)
31695 Verification ensures that the host name obtained from a reverse DNS lookup, or
31696 one of its aliases, does, when it is itself looked up in the DNS, yield the
31697 original IP address.
31698
31699 There is one possible option, &`defer_ok`&.  If this is present and a
31700 DNS operation returns a temporary error, the verify condition succeeds.
31701
31702 If this condition is used for a locally generated message (that is, when there
31703 is no client host involved), it always succeeds.
31704
31705 .vitem &*verify&~=&~sender/*&<&'options'&>
31706 .cindex "&%verify%& ACL condition"
31707 .cindex "&ACL;" "verifying sender"
31708 .cindex "sender" "verifying"
31709 .cindex "verifying" "sender"
31710 This condition is relevant only after a MAIL or RCPT command, or after a
31711 message has been received (the &%acl_smtp_data%& or &%acl_not_smtp%& ACLs). If
31712 the message's sender is empty (that is, this is a bounce message), the
31713 condition is true. Otherwise, the sender address is verified.
31714
31715 .vindex "&$address_data$&"
31716 .vindex "&$sender_address_data$&"
31717 If there is data in the &$address_data$& variable at the end of routing, its
31718 value is placed in &$sender_address_data$& at the end of verification. This
31719 value can be used in subsequent conditions and modifiers in the same ACL
31720 statement. It does not persist after the end of the current statement. If you
31721 want to preserve the value for longer, you can save it in an ACL variable.
31722
31723 Details of verification are given later, starting at section
31724 &<<SECTaddressverification>>&. Exim caches the result of sender verification,
31725 to avoid doing it more than once per message.
31726
31727 .vitem &*verify&~=&~sender=*&<&'address'&>&*/*&<&'options'&>
31728 .cindex "&%verify%& ACL condition"
31729 This is a variation of the previous option, in which a modified address is
31730 verified as a sender.
31731
31732 Note that '/' is legal in local-parts; if the address may have such
31733 (eg. is generated from the received message)
31734 they must be protected from the options parsing by doubling:
31735 .code
31736 verify = sender=${sg{${address:$h_sender:}}{/}{//}}
31737 .endd
31738 .endlist
31739
31740
31741
31742 .section "Using DNS lists" "SECTmorednslists"
31743 .cindex "DNS list" "in ACL"
31744 .cindex "black list (DNS)"
31745 .cindex "&ACL;" "testing a DNS list"
31746 In its simplest form, the &%dnslists%& condition tests whether the calling host
31747 is on at least one of a number of DNS lists by looking up the inverted IP
31748 address in one or more DNS domains. (Note that DNS list domains are not mail
31749 domains, so the &`+`& syntax for named lists doesn't work - it is used for
31750 special options instead.) For example, if the calling host's IP
31751 address is 192.168.62.43, and the ACL statement is
31752 .code
31753 deny dnslists = blackholes.mail-abuse.org : \
31754                 dialups.mail-abuse.org
31755 .endd
31756 the following records are looked up:
31757 .code
31758 43.62.168.192.blackholes.mail-abuse.org
31759 43.62.168.192.dialups.mail-abuse.org
31760 .endd
31761 As soon as Exim finds an existing DNS record, processing of the list stops.
31762 Thus, multiple entries on the list provide an &"or"& conjunction. If you want
31763 to test that a host is on more than one list (an &"and"& conjunction), you can
31764 use two separate conditions:
31765 .code
31766 deny dnslists = blackholes.mail-abuse.org
31767      dnslists = dialups.mail-abuse.org
31768 .endd
31769 If a DNS lookup times out or otherwise fails to give a decisive answer, Exim
31770 behaves as if the host does not match the list item, that is, as if the DNS
31771 record does not exist. If there are further items in the DNS list, they are
31772 processed.
31773
31774 This is usually the required action when &%dnslists%& is used with &%deny%&
31775 (which is the most common usage), because it prevents a DNS failure from
31776 blocking mail. However, you can change this behaviour by putting one of the
31777 following special items in the list:
31778 .display
31779 &`+include_unknown `&   behave as if the item is on the list
31780 &`+exclude_unknown `&   behave as if the item is not on the list (default)
31781 &`+defer_unknown   `&   give a temporary error
31782 .endd
31783 .cindex "&`+include_unknown`&"
31784 .cindex "&`+exclude_unknown`&"
31785 .cindex "&`+defer_unknown`&"
31786 Each of these applies to any subsequent items on the list. For example:
31787 .code
31788 deny dnslists = +defer_unknown : foo.bar.example
31789 .endd
31790 Testing the list of domains stops as soon as a match is found. If you want to
31791 warn for one list and block for another, you can use two different statements:
31792 .code
31793 deny  dnslists = blackholes.mail-abuse.org
31794 warn  dnslists = dialups.mail-abuse.org
31795       message  = X-Warn: sending host is on dialups list
31796 .endd
31797 .cindex caching "of dns lookup"
31798 .cindex DNS TTL
31799 DNS list lookups are cached by Exim for the duration of the SMTP session
31800 (but limited by the DNS return TTL value),
31801 so a lookup based on the IP address is done at most once for any incoming
31802 connection (assuming long-enough TTL).
31803 Exim does not share information between multiple incoming
31804 connections (but your local name server cache should be active).
31805
31806 There are a number of DNS lists to choose from, some commercial, some free,
31807 or free for small deployments.  An overview can be found at
31808 &url(https://en.wikipedia.org/wiki/Comparison_of_DNS_blacklists).
31809
31810
31811
31812 .section "Specifying the IP address for a DNS list lookup" "SECID201"
31813 .cindex "DNS list" "keyed by explicit IP address"
31814 By default, the IP address that is used in a DNS list lookup is the IP address
31815 of the calling host. However, you can specify another IP address by listing it
31816 after the domain name, introduced by a slash. For example:
31817 .code
31818 deny dnslists = black.list.tld/192.168.1.2
31819 .endd
31820 This feature is not very helpful with explicit IP addresses; it is intended for
31821 use with IP addresses that are looked up, for example, the IP addresses of the
31822 MX hosts or nameservers of an email sender address. For an example, see section
31823 &<<SECTmulkeyfor>>& below.
31824
31825
31826
31827
31828 .section "DNS lists keyed on domain names" "SECID202"
31829 .cindex "DNS list" "keyed by domain name"
31830 There are some lists that are keyed on domain names rather than inverted IP
31831 addresses (see, e.g., the &'domain based zones'& link at
31832 &url(http://www.rfc-ignorant.org/)). No reversing of components is used
31833 with these lists. You can change the name that is looked up in a DNS list by
31834 listing it after the domain name, introduced by a slash. For example,
31835 .code
31836 deny  dnslists = dsn.rfc-ignorant.org/$sender_address_domain
31837       message  = Sender's domain is listed at $dnslist_domain
31838 .endd
31839 This particular example is useful only in ACLs that are obeyed after the
31840 RCPT or DATA commands, when a sender address is available. If (for
31841 example) the message's sender is &'user@tld.example'& the name that is looked
31842 up by this example is
31843 .code
31844 tld.example.dsn.rfc-ignorant.org
31845 .endd
31846 A single &%dnslists%& condition can contain entries for both names and IP
31847 addresses. For example:
31848 .code
31849 deny dnslists = sbl.spamhaus.org : \
31850                 dsn.rfc-ignorant.org/$sender_address_domain
31851 .endd
31852 The first item checks the sending host's IP address; the second checks a domain
31853 name. The whole condition is true if either of the DNS lookups succeeds.
31854
31855
31856
31857
31858 .section "Multiple explicit keys for a DNS list" "SECTmulkeyfor"
31859 .cindex "DNS list" "multiple keys for"
31860 The syntax described above for looking up explicitly-defined values (either
31861 names or IP addresses) in a DNS blacklist is a simplification. After the domain
31862 name for the DNS list, what follows the slash can in fact be a list of items.
31863 As with all lists in Exim, the default separator is a colon. However, because
31864 this is a sublist within the list of DNS blacklist domains, it is necessary
31865 either to double the separators like this:
31866 .code
31867 dnslists = black.list.tld/name.1::name.2
31868 .endd
31869 or to change the separator character, like this:
31870 .code
31871 dnslists = black.list.tld/<;name.1;name.2
31872 .endd
31873 If an item in the list is an IP address, it is inverted before the DNS
31874 blacklist domain is appended. If it is not an IP address, no inversion
31875 occurs. Consider this condition:
31876 .code
31877 dnslists = black.list.tld/<;192.168.1.2;a.domain
31878 .endd
31879 The DNS lookups that occur are:
31880 .code
31881 2.1.168.192.black.list.tld
31882 a.domain.black.list.tld
31883 .endd
31884 Once a DNS record has been found (that matches a specific IP return
31885 address, if specified &-- see section &<<SECTaddmatcon>>&), no further lookups
31886 are done. If there is a temporary DNS error, the rest of the sublist of domains
31887 or IP addresses is tried. A temporary error for the whole dnslists item occurs
31888 only if no other DNS lookup in this sublist succeeds. In other words, a
31889 successful lookup for any of the items in the sublist overrides a temporary
31890 error for a previous item.
31891
31892 The ability to supply a list of items after the slash is in some sense just a
31893 syntactic convenience. These two examples have the same effect:
31894 .code
31895 dnslists = black.list.tld/a.domain : black.list.tld/b.domain
31896 dnslists = black.list.tld/a.domain::b.domain
31897 .endd
31898 However, when the data for the list is obtained from a lookup, the second form
31899 is usually much more convenient. Consider this example:
31900 .code
31901 deny dnslists = sbl.spamhaus.org/<|${lookup dnsdb {>|a=<|\
31902                                    ${lookup dnsdb {>|mxh=\
31903                                    $sender_address_domain} }} }
31904      message  = The mail servers for the domain \
31905                 $sender_address_domain \
31906                 are listed at $dnslist_domain ($dnslist_value); \
31907                 see $dnslist_text.
31908 .endd
31909 Note the use of &`>|`& in the dnsdb lookup to specify the separator for
31910 multiple DNS records. The inner dnsdb lookup produces a list of MX hosts
31911 and the outer dnsdb lookup finds the IP addresses for these hosts. The result
31912 of expanding the condition might be something like this:
31913 .code
31914 dnslists = sbl.spamhaus.org/<|192.168.2.3|192.168.5.6|...
31915 .endd
31916 Thus, this example checks whether or not the IP addresses of the sender
31917 domain's mail servers are on the Spamhaus black list.
31918
31919 The key that was used for a successful DNS list lookup is put into the variable
31920 &$dnslist_matched$& (see section &<<SECID204>>&).
31921
31922
31923
31924
31925 .section "Data returned by DNS lists" "SECID203"
31926 .cindex "DNS list" "data returned from"
31927 DNS lists are constructed using address records in the DNS. The original RBL
31928 just used the address 127.0.0.1 on the right hand side of each record, but the
31929 RBL+ list and some other lists use a number of values with different meanings.
31930 The values used on the RBL+ list are:
31931 .display
31932 127.1.0.1  RBL
31933 127.1.0.2  DUL
31934 127.1.0.3  DUL and RBL
31935 127.1.0.4  RSS
31936 127.1.0.5  RSS and RBL
31937 127.1.0.6  RSS and DUL
31938 127.1.0.7  RSS and DUL and RBL
31939 .endd
31940 Section &<<SECTaddmatcon>>& below describes how you can distinguish between
31941 different values. Some DNS lists may return more than one address record;
31942 see section &<<SECThanmuldnsrec>>& for details of how they are checked.
31943
31944
31945 .section "Variables set from DNS lists" "SECID204"
31946 .cindex "expansion" "variables, set from DNS list"
31947 .cindex "DNS list" "variables set from"
31948 .vindex "&$dnslist_domain$&"
31949 .vindex "&$dnslist_matched$&"
31950 .vindex "&$dnslist_text$&"
31951 .vindex "&$dnslist_value$&"
31952 When an entry is found in a DNS list, the variable &$dnslist_domain$& contains
31953 the name of the overall domain that matched (for example,
31954 &`spamhaus.example`&), &$dnslist_matched$& contains the key within that domain
31955 (for example, &`192.168.5.3`&), and &$dnslist_value$& contains the data from
31956 the DNS record. When the key is an IP address, it is not reversed in
31957 &$dnslist_matched$& (though it is, of course, in the actual lookup). In simple
31958 cases, for example:
31959 .code
31960 deny dnslists = spamhaus.example
31961 .endd
31962 the key is also available in another variable (in this case,
31963 &$sender_host_address$&). In more complicated cases, however, this is not true.
31964 For example, using a data lookup (as described in section &<<SECTmulkeyfor>>&)
31965 might generate a dnslists lookup like this:
31966 .code
31967 deny dnslists = spamhaus.example/<|192.168.1.2|192.168.6.7|...
31968 .endd
31969 If this condition succeeds, the value in &$dnslist_matched$& might be
31970 &`192.168.6.7`& (for example).
31971
31972 If more than one address record is returned by the DNS lookup, all the IP
31973 addresses are included in &$dnslist_value$&, separated by commas and spaces.
31974 The variable &$dnslist_text$& contains the contents of any associated TXT
31975 record. For lists such as RBL+ the TXT record for a merged entry is often not
31976 very meaningful. See section &<<SECTmordetinf>>& for a way of obtaining more
31977 information.
31978
31979 You can use the DNS list variables in &%message%& or &%log_message%& modifiers
31980 &-- even if these appear before the condition in the ACL, they are not
31981 expanded until after it has failed. For example:
31982 .code
31983 deny    hosts = !+local_networks
31984         message = $sender_host_address is listed \
31985                   at $dnslist_domain
31986         dnslists = rbl-plus.mail-abuse.example
31987 .endd
31988
31989
31990
31991 .section "Additional matching conditions for DNS lists" "SECTaddmatcon"
31992 .cindex "DNS list" "matching specific returned data"
31993 You can add an equals sign and an IP address after a &%dnslists%& domain name
31994 in order to restrict its action to DNS records with a matching right hand side.
31995 For example,
31996 .code
31997 deny dnslists = rblplus.mail-abuse.org=127.0.0.2
31998 .endd
31999 rejects only those hosts that yield 127.0.0.2. Without this additional data,
32000 any address record is considered to be a match. For the moment, we assume
32001 that the DNS lookup returns just one record. Section &<<SECThanmuldnsrec>>&
32002 describes how multiple records are handled.
32003
32004 More than one IP address may be given for checking, using a comma as a
32005 separator. These are alternatives &-- if any one of them matches, the
32006 &%dnslists%& condition is true. For example:
32007 .code
32008 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
32009 .endd
32010 If you want to specify a constraining address list and also specify names or IP
32011 addresses to be looked up, the constraining address list must be specified
32012 first. For example:
32013 .code
32014 deny dnslists = dsn.rfc-ignorant.org\
32015                 =127.0.0.2/$sender_address_domain
32016 .endd
32017
32018 If the character &`&&`& is used instead of &`=`&, the comparison for each
32019 listed IP address is done by a bitwise &"and"& instead of by an equality test.
32020 In other words, the listed addresses are used as bit masks. The comparison is
32021 true if all the bits in the mask are present in the address that is being
32022 tested. For example:
32023 .code
32024 dnslists = a.b.c&0.0.0.3
32025 .endd
32026 matches if the address is &'x.x.x.'&3, &'x.x.x.'&7, &'x.x.x.'&11, etc. If you
32027 want to test whether one bit or another bit is present (as opposed to both
32028 being present), you must use multiple values. For example:
32029 .code
32030 dnslists = a.b.c&0.0.0.1,0.0.0.2
32031 .endd
32032 matches if the final component of the address is an odd number or two times
32033 an odd number.
32034
32035
32036
32037 .section "Negated DNS matching conditions" "SECID205"
32038 You can supply a negative list of IP addresses as part of a &%dnslists%&
32039 condition. Whereas
32040 .code
32041 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
32042 .endd
32043 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
32044 IP address yielded by the list is either 127.0.0.2 or 127.0.0.3"&,
32045 .code
32046 deny  dnslists = a.b.c!=127.0.0.2,127.0.0.3
32047 .endd
32048 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
32049 IP address yielded by the list is not 127.0.0.2 and not 127.0.0.3"&. In other
32050 words, the result of the test is inverted if an exclamation mark appears before
32051 the &`=`& (or the &`&&`&) sign.
32052
32053 &*Note*&: This kind of negation is not the same as negation in a domain,
32054 host, or address list (which is why the syntax is different).
32055
32056 If you are using just one list, the negation syntax does not gain you much. The
32057 previous example is precisely equivalent to
32058 .code
32059 deny  dnslists = a.b.c
32060      !dnslists = a.b.c=127.0.0.2,127.0.0.3
32061 .endd
32062 However, if you are using multiple lists, the negation syntax is clearer.
32063 Consider this example:
32064 .code
32065 deny  dnslists = sbl.spamhaus.org : \
32066                  list.dsbl.org : \
32067                  dnsbl.njabl.org!=127.0.0.3 : \
32068                  relays.ordb.org
32069 .endd
32070 Using only positive lists, this would have to be:
32071 .code
32072 deny  dnslists = sbl.spamhaus.org : \
32073                  list.dsbl.org
32074 deny  dnslists = dnsbl.njabl.org
32075      !dnslists = dnsbl.njabl.org=127.0.0.3
32076 deny  dnslists = relays.ordb.org
32077 .endd
32078 which is less clear, and harder to maintain.
32079
32080
32081
32082
32083 .section "Handling multiple DNS records from a DNS list" "SECThanmuldnsrec"
32084 A DNS lookup for a &%dnslists%& condition may return more than one DNS record,
32085 thereby providing more than one IP address. When an item in a &%dnslists%& list
32086 is followed by &`=`& or &`&&`& and a list of IP addresses, in order to restrict
32087 the match to specific results from the DNS lookup, there are two ways in which
32088 the checking can be handled. For example, consider the condition:
32089 .code
32090 dnslists = a.b.c=127.0.0.1
32091 .endd
32092 What happens if the DNS lookup for the incoming IP address yields both
32093 127.0.0.1 and 127.0.0.2 by means of two separate DNS records? Is the
32094 condition true because at least one given value was found, or is it false
32095 because at least one of the found values was not listed? And how does this
32096 affect negated conditions? Both possibilities are provided for with the help of
32097 additional separators &`==`& and &`=&&`&.
32098
32099 .ilist
32100 If &`=`& or &`&&`& is used, the condition is true if any one of the looked up
32101 IP addresses matches one of the listed addresses. For the example above, the
32102 condition is true because 127.0.0.1 matches.
32103 .next
32104 If &`==`& or &`=&&`& is used, the condition is true only if every one of the
32105 looked up IP addresses matches one of the listed addresses. If the condition is
32106 changed to:
32107 .code
32108 dnslists = a.b.c==127.0.0.1
32109 .endd
32110 and the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
32111 false because 127.0.0.2 is not listed. You would need to have:
32112 .code
32113 dnslists = a.b.c==127.0.0.1,127.0.0.2
32114 .endd
32115 for the condition to be true.
32116 .endlist
32117
32118 When &`!`& is used to negate IP address matching, it inverts the result, giving
32119 the precise opposite of the behaviour above. Thus:
32120 .ilist
32121 If &`!=`& or &`!&&`& is used, the condition is true if none of the looked up IP
32122 addresses matches one of the listed addresses. Consider:
32123 .code
32124 dnslists = a.b.c!&0.0.0.1
32125 .endd
32126 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
32127 false because 127.0.0.1 matches.
32128 .next
32129 If &`!==`& or &`!=&&`& is used, the condition is true if there is at least one
32130 looked up IP address that does not match. Consider:
32131 .code
32132 dnslists = a.b.c!=&0.0.0.1
32133 .endd
32134 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
32135 true, because 127.0.0.2 does not match. You would need to have:
32136 .code
32137 dnslists = a.b.c!=&0.0.0.1,0.0.0.2
32138 .endd
32139 for the condition to be false.
32140 .endlist
32141 When the DNS lookup yields only a single IP address, there is no difference
32142 between &`=`& and &`==`& and between &`&&`& and &`=&&`&.
32143
32144
32145
32146
32147 .section "Detailed information from merged DNS lists" "SECTmordetinf"
32148 .cindex "DNS list" "information from merged"
32149 When the facility for restricting the matching IP values in a DNS list is used,
32150 the text from the TXT record that is set in &$dnslist_text$& may not reflect
32151 the true reason for rejection. This happens when lists are merged and the IP
32152 address in the A record is used to distinguish them; unfortunately there is
32153 only one TXT record. One way round this is not to use merged lists, but that
32154 can be inefficient because it requires multiple DNS lookups where one would do
32155 in the vast majority of cases when the host of interest is not on any of the
32156 lists.
32157
32158 A less inefficient way of solving this problem is available. If
32159 two domain names, comma-separated, are given, the second is used first to
32160 do an initial check, making use of any IP value restrictions that are set.
32161 If there is a match, the first domain is used, without any IP value
32162 restrictions, to get the TXT record. As a byproduct of this, there is also
32163 a check that the IP being tested is indeed on the first list. The first
32164 domain is the one that is put in &$dnslist_domain$&. For example:
32165 .code
32166 deny   dnslists = \
32167          sbl.spamhaus.org,sbl-xbl.spamhaus.org=127.0.0.2 : \
32168          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
32169        message  = \
32170          rejected because $sender_host_address is blacklisted \
32171          at $dnslist_domain\n$dnslist_text
32172 .endd
32173 For the first blacklist item, this starts by doing a lookup in
32174 &'sbl-xbl.spamhaus.org'& and testing for a 127.0.0.2 return. If there is a
32175 match, it then looks in &'sbl.spamhaus.org'&, without checking the return
32176 value, and as long as something is found, it looks for the corresponding TXT
32177 record. If there is no match in &'sbl-xbl.spamhaus.org'&, nothing more is done.
32178 The second blacklist item is processed similarly.
32179
32180 If you are interested in more than one merged list, the same list must be
32181 given several times, but because the results of the DNS lookups are cached,
32182 the DNS calls themselves are not repeated. For example:
32183 .code
32184 deny dnslists = \
32185          http.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.2 : \
32186          socks.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.3 : \
32187          misc.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.4 : \
32188          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
32189 .endd
32190 In this case there is one lookup in &'dnsbl.sorbs.net'&, and if none of the IP
32191 values matches (or if no record is found), this is the only lookup that is
32192 done. Only if there is a match is one of the more specific lists consulted.
32193
32194
32195
32196 .section "DNS lists and IPv6" "SECTmorednslistslast"
32197 .cindex "IPv6" "DNS black lists"
32198 .cindex "DNS list" "IPv6 usage"
32199 If Exim is asked to do a dnslist lookup for an IPv6 address, it inverts it
32200 nibble by nibble. For example, if the calling host's IP address is
32201 3ffe:ffff:836f:0a00:000a:0800:200a:c031, Exim might look up
32202 .code
32203 1.3.0.c.a.0.0.2.0.0.8.0.a.0.0.0.0.0.a.0.f.6.3.8.
32204   f.f.f.f.e.f.f.3.blackholes.mail-abuse.org
32205 .endd
32206 (split over two lines here to fit on the page). Unfortunately, some of the DNS
32207 lists contain wildcard records, intended for IPv4, that interact badly with
32208 IPv6. For example, the DNS entry
32209 .code
32210 *.3.some.list.example.    A    127.0.0.1
32211 .endd
32212 is probably intended to put the entire 3.0.0.0/8 IPv4 network on the list.
32213 Unfortunately, it also matches the entire 3::/4 IPv6 network.
32214
32215 You can exclude IPv6 addresses from DNS lookups by making use of a suitable
32216 &%condition%& condition, as in this example:
32217 .code
32218 deny   condition = ${if isip4{$sender_host_address}}
32219        dnslists  = some.list.example
32220 .endd
32221
32222 If an explicit key is being used for a DNS lookup and it may be an IPv6
32223 address you should specify alternate list separators for both the outer
32224 (DNS list name) list and inner (lookup keys) list:
32225 .code
32226        dnslists = <; dnsbl.example.com/<|$acl_m_addrslist
32227 .endd
32228
32229 .section "Rate limiting incoming messages" "SECTratelimiting"
32230 .cindex "rate limiting" "client sending"
32231 .cindex "limiting client sending rates"
32232 .oindex "&%smtp_ratelimit_*%&"
32233 The &%ratelimit%& ACL condition can be used to measure and control the rate at
32234 which clients can send email. This is more powerful than the
32235 &%smtp_ratelimit_*%& options, because those options control the rate of
32236 commands in a single SMTP session only, whereas the &%ratelimit%& condition
32237 works across all connections (concurrent and sequential) from the same client
32238 host. The syntax of the &%ratelimit%& condition is:
32239 .display
32240 &`ratelimit =`& <&'m'&> &`/`& <&'p'&> &`/`& <&'options'&> &`/`& <&'key'&>
32241 .endd
32242 If the average client sending rate is less than &'m'& messages per time
32243 period &'p'& then the condition is false; otherwise it is true.
32244
32245 As a side-effect, the &%ratelimit%& condition sets the expansion variable
32246 &$sender_rate$& to the client's computed rate, &$sender_rate_limit$& to the
32247 configured value of &'m'&, and &$sender_rate_period$& to the configured value
32248 of &'p'&.
32249
32250 The parameter &'p'& is the smoothing time constant, in the form of an Exim
32251 time interval, for example, &`8h`& for eight hours. A larger time constant
32252 means that it takes Exim longer to forget a client's past behaviour. The
32253 parameter &'m'& is the maximum number of messages that a client is permitted to
32254 send in each time interval. It also specifies the number of messages permitted
32255 in a fast burst. By increasing both &'m'& and &'p'& but keeping &'m/p'&
32256 constant, you can allow a client to send more messages in a burst without
32257 changing its long-term sending rate limit. Conversely, if &'m'& and &'p'& are
32258 both small, messages must be sent at an even rate.
32259
32260 There is a script in &_util/ratelimit.pl_& which extracts sending rates from
32261 log files, to assist with choosing appropriate settings for &'m'& and &'p'&
32262 when deploying the &%ratelimit%& ACL condition. The script prints usage
32263 instructions when it is run with no arguments.
32264
32265 The key is used to look up the data for calculating the client's average
32266 sending rate. This data is stored in Exim's spool directory, alongside the
32267 retry and other hints databases. The default key is &$sender_host_address$&,
32268 which means Exim computes the sending rate of each client host IP address.
32269 By changing the key you can change how Exim identifies clients for the purpose
32270 of ratelimiting. For example, to limit the sending rate of each authenticated
32271 user, independent of the computer they are sending from, set the key to
32272 &$authenticated_id$&. You must ensure that the lookup key is meaningful; for
32273 example, &$authenticated_id$& is only meaningful if the client has
32274 authenticated (which you can check with the &%authenticated%& ACL condition).
32275
32276 The lookup key does not have to identify clients: If you want to limit the
32277 rate at which a recipient receives messages, you can use the key
32278 &`$local_part@$domain`& with the &%per_rcpt%& option (see below) in a RCPT
32279 ACL.
32280
32281 Each &%ratelimit%& condition can have up to four options. A &%per_*%& option
32282 specifies what Exim measures the rate of, for example, messages or recipients
32283 or bytes. You can adjust the measurement using the &%unique=%& and/or
32284 &%count=%& options. You can also control when Exim updates the recorded rate
32285 using a &%strict%&, &%leaky%&, or &%readonly%& option. The options are
32286 separated by a slash, like the other parameters. They may appear in any order.
32287
32288 Internally, Exim appends the smoothing constant &'p'& onto the lookup key with
32289 any options that alter the meaning of the stored data. The limit &'m'& is not
32290 stored, so you can alter the configured maximum rate and Exim will still
32291 remember clients' past behaviour. If you change the &%per_*%& mode or add or
32292 remove the &%unique=%& option, the lookup key changes so Exim will forget past
32293 behaviour. The lookup key is not affected by changes to the update mode and
32294 the &%count=%& option.
32295
32296
32297 .section "Ratelimit options for what is being measured" "ratoptmea"
32298 .cindex "rate limiting" "per_* options"
32299 The &%per_conn%& option limits the client's connection rate. It is not
32300 normally used in the &%acl_not_smtp%&, &%acl_not_smtp_mime%&, or
32301 &%acl_not_smtp_start%& ACLs.
32302
32303 The &%per_mail%& option limits the client's rate of sending messages. This is
32304 the default if none of the &%per_*%& options is specified. It can be used in
32305 &%acl_smtp_mail%&, &%acl_smtp_rcpt%&, &%acl_smtp_predata%&, &%acl_smtp_mime%&,
32306 &%acl_smtp_data%&, or &%acl_not_smtp%&.
32307
32308 The &%per_byte%& option limits the sender's email bandwidth. It can be used in
32309 the same ACLs as the &%per_mail%& option, though it is best to use this option
32310 in the &%acl_smtp_mime%&, &%acl_smtp_data%& or &%acl_not_smtp%& ACLs; if it is
32311 used in an earlier ACL, Exim relies on the SIZE parameter given by the client
32312 in its MAIL command, which may be inaccurate or completely missing. You can
32313 follow the limit &'m'& in the configuration with K, M, or G to specify limits
32314 in kilobytes, megabytes, or gigabytes, respectively.
32315
32316 The &%per_rcpt%& option causes Exim to limit the rate at which recipients are
32317 accepted. It can be used in the &%acl_smtp_rcpt%&, &%acl_smtp_predata%&,
32318 &%acl_smtp_mime%&, &%acl_smtp_data%&, or &%acl_smtp_rcpt%& ACLs. In
32319 &%acl_smtp_rcpt%& the rate is updated one recipient at a time; in the other
32320 ACLs the rate is updated with the total (accepted) recipient count in one go. Note that
32321 in either case the rate limiting engine will see a message with many
32322 recipients as a large high-speed burst.
32323
32324 The &%per_addr%& option is like the &%per_rcpt%& option, except it counts the
32325 number of different recipients that the client has sent messages to in the
32326 last time period. That is, if the client repeatedly sends messages to the same
32327 recipient, its measured rate is not increased. This option can only be used in
32328 &%acl_smtp_rcpt%&.
32329
32330 The &%per_cmd%& option causes Exim to recompute the rate every time the
32331 condition is processed. This can be used to limit the rate of any SMTP
32332 command. If it is used in multiple ACLs it can limit the aggregate rate of
32333 multiple different commands.
32334
32335 The &%count=%& option can be used to alter how much Exim adds to the client's
32336 measured rate. For example, the &%per_byte%& option is equivalent to
32337 &`per_mail/count=$message_size`&. If there is no &%count=%& option, Exim
32338 increases the measured rate by one (except for the &%per_rcpt%& option in ACLs
32339 other than &%acl_smtp_rcpt%&). The count does not have to be an integer.
32340
32341 The &%unique=%& option is described in section &<<ratoptuniq>>& below.
32342
32343
32344 .section "Ratelimit update modes" "ratoptupd"
32345 .cindex "rate limiting" "reading data without updating"
32346 You can specify one of three options with the &%ratelimit%& condition to
32347 control when its database is updated. This section describes the &%readonly%&
32348 mode, and the next section describes the &%strict%& and &%leaky%& modes.
32349
32350 If the &%ratelimit%& condition is used in &%readonly%& mode, Exim looks up a
32351 previously-computed rate to check against the limit.
32352
32353 For example, you can test the client's sending rate and deny it access (when
32354 it is too fast) in the connect ACL. If the client passes this check then it
32355 can go on to send a message, in which case its recorded rate will be updated
32356 in the MAIL ACL. Subsequent connections from the same client will check this
32357 new rate.
32358 .code
32359 acl_check_connect:
32360  deny ratelimit = 100 / 5m / readonly
32361       log_message = RATE CHECK: $sender_rate/$sender_rate_period \
32362                   (max $sender_rate_limit)
32363 # ...
32364 acl_check_mail:
32365  warn ratelimit = 100 / 5m / strict
32366       log_message = RATE UPDATE: $sender_rate/$sender_rate_period \
32367                   (max $sender_rate_limit)
32368 .endd
32369
32370 If Exim encounters multiple &%ratelimit%& conditions with the same key when
32371 processing a message then it may increase the client's measured rate more than
32372 it should. For example, this will happen if you check the &%per_rcpt%& option
32373 in both &%acl_smtp_rcpt%& and &%acl_smtp_data%&. However it's OK to check the
32374 same &%ratelimit%& condition multiple times in the same ACL. You can avoid any
32375 multiple update problems by using the &%readonly%& option on later ratelimit
32376 checks.
32377
32378 The &%per_*%& options described above do not make sense in some ACLs. If you
32379 use a &%per_*%& option in an ACL where it is not normally permitted then the
32380 update mode defaults to &%readonly%& and you cannot specify the &%strict%& or
32381 &%leaky%& modes. In other ACLs the default update mode is &%leaky%& (see the
32382 next section) so you must specify the &%readonly%& option explicitly.
32383
32384
32385 .section "Ratelimit options for handling fast clients" "ratoptfast"
32386 .cindex "rate limiting" "strict and leaky modes"
32387 If a client's average rate is greater than the maximum, the rate limiting
32388 engine can react in two possible ways, depending on the presence of the
32389 &%strict%& or &%leaky%& update modes. This is independent of the other
32390 counter-measures (such as rejecting the message) that may be specified by the
32391 rest of the ACL.
32392
32393 The &%leaky%& (default) option means that the client's recorded rate is not
32394 updated if it is above the limit. The effect of this is that Exim measures the
32395 client's average rate of successfully sent email,
32396 up to the given limit.
32397 This is appropriate if the countermeasure when the condition is true
32398 consists of refusing the message, and
32399 is generally the better choice if you have clients that retry automatically.
32400 If the action when true is anything more complex then this option is
32401 likely not what is wanted.
32402
32403 The &%strict%& option means that the client's recorded rate is always
32404 updated. The effect of this is that Exim measures the client's average rate
32405 of attempts to send email, which can be much higher than the maximum it is
32406 actually allowed. If the client is over the limit it may be subjected to
32407 counter-measures by the ACL. It must slow down and allow sufficient time to
32408 pass that its computed rate falls below the maximum before it can send email
32409 again. The time (the number of smoothing periods) it must wait and not
32410 attempt to send mail can be calculated with this formula:
32411 .code
32412         ln(peakrate/maxrate)
32413 .endd
32414
32415
32416 .section "Limiting the rate of different events" "ratoptuniq"
32417 .cindex "rate limiting" "counting unique events"
32418 The &%ratelimit%& &%unique=%& option controls a mechanism for counting the
32419 rate of different events. For example, the &%per_addr%& option uses this
32420 mechanism to count the number of different recipients that the client has
32421 sent messages to in the last time period; it is equivalent to
32422 &`per_rcpt/unique=$local_part@$domain`&. You could use this feature to
32423 measure the rate that a client uses different sender addresses with the
32424 options &`per_mail/unique=$sender_address`&.
32425
32426 For each &%ratelimit%& key Exim stores the set of &%unique=%& values that it
32427 has seen for that key. The whole set is thrown away when it is older than the
32428 rate smoothing period &'p'&, so each different event is counted at most once
32429 per period. In the &%leaky%& update mode, an event that causes the client to
32430 go over the limit is not added to the set, in the same way that the client's
32431 recorded rate is not updated in the same situation.
32432
32433 When you combine the &%unique=%& and &%readonly%& options, the specific
32434 &%unique=%& value is ignored, and Exim just retrieves the client's stored
32435 rate.
32436
32437 The &%unique=%& mechanism needs more space in the ratelimit database than the
32438 other &%ratelimit%& options in order to store the event set. The number of
32439 unique values is potentially as large as the rate limit, so the extra space
32440 required increases with larger limits.
32441
32442 The uniqueification is not perfect: there is a small probability that Exim
32443 will think a new event has happened before. If the sender's rate is less than
32444 the limit, Exim should be more than 99.9% correct. However in &%strict%& mode
32445 the measured rate can go above the limit, in which case Exim may under-count
32446 events by a significant margin. Fortunately, if the rate is high enough (2.7
32447 times the limit) that the false positive rate goes above 9%, then Exim will
32448 throw away the over-full event set before the measured rate falls below the
32449 limit. Therefore the only harm should be that exceptionally high sending rates
32450 are logged incorrectly; any countermeasures you configure will be as effective
32451 as intended.
32452
32453
32454 .section "Using rate limiting" "useratlim"
32455 Exim's other ACL facilities are used to define what counter-measures are taken
32456 when the rate limit is exceeded. This might be anything from logging a warning
32457 (for example, while measuring existing sending rates in order to define
32458 policy), through time delays to slow down fast senders, up to rejecting the
32459 message. For example:
32460 .code
32461 # Log all senders' rates
32462 warn ratelimit = 0 / 1h / strict
32463      log_message = Sender rate $sender_rate / $sender_rate_period
32464
32465 # Slow down fast senders; note the need to truncate $sender_rate
32466 # at the decimal point.
32467 warn ratelimit = 100 / 1h / per_rcpt / strict
32468      delay     = ${eval: ${sg{$sender_rate}{[.].*}{}} - \
32469                    $sender_rate_limit }s
32470
32471 # Keep authenticated users under control
32472 deny authenticated = *
32473      ratelimit = 100 / 1d / strict / $authenticated_id
32474
32475 # System-wide rate limit
32476 defer ratelimit = 10 / 1s / $primary_hostname
32477       message = Sorry, too busy. Try again later.
32478
32479 # Restrict incoming rate from each host, with a default
32480 # set using a macro and special cases looked up in a table.
32481 defer ratelimit = ${lookup {$sender_host_address} \
32482                    cdb {DB/ratelimits.cdb} \
32483                    {$value} {RATELIMIT} }
32484       message = Sender rate exceeds $sender_rate_limit \
32485                messages per $sender_rate_period
32486 .endd
32487 &*Warning*&: If you have a busy server with a lot of &%ratelimit%& tests,
32488 especially with the &%per_rcpt%& option, you may suffer from a performance
32489 bottleneck caused by locking on the ratelimit hints database. Apart from
32490 making your ACLs less complicated, you can reduce the problem by using a
32491 RAM disk for Exim's hints directory (usually &_/var/spool/exim/db/_&). However
32492 this means that Exim will lose its hints data after a reboot (including retry
32493 hints, the callout cache, and ratelimit data).
32494
32495
32496
32497 .section "Address verification" "SECTaddressverification"
32498 .cindex "verifying address" "options for"
32499 .cindex "policy control" "address verification"
32500 Several of the &%verify%& conditions described in section
32501 &<<SECTaclconditions>>& cause addresses to be verified. Section
32502 &<<SECTsenaddver>>& discusses the reporting of sender verification failures.
32503 The verification conditions can be followed by options that modify the
32504 verification process. The options are separated from the keyword and from each
32505 other by slashes, and some of them contain parameters. For example:
32506 .code
32507 verify = sender/callout
32508 verify = recipient/defer_ok/callout=10s,defer_ok
32509 .endd
32510 The first stage of address verification, which always happens, is to run the
32511 address through the routers, in &"verify mode"&. Routers can detect the
32512 difference between verification and routing for delivery, and their actions can
32513 be varied by a number of generic options such as &%verify%& and &%verify_only%&
32514 (see chapter &<<CHAProutergeneric>>&). If routing fails, verification fails.
32515 The available options are as follows:
32516
32517 .ilist
32518 If the &%callout%& option is specified, successful routing to one or more
32519 remote hosts is followed by a &"callout"& to those hosts as an additional
32520 check. Callouts and their sub-options are discussed in the next section.
32521 .next
32522 If there is a defer error while doing verification routing, the ACL
32523 normally returns &"defer"&. However, if you include &%defer_ok%& in the
32524 options, the condition is forced to be true instead. Note that this is a main
32525 verification option as well as a suboption for callouts.
32526 .next
32527 The &%no_details%& option is covered in section &<<SECTsenaddver>>&, which
32528 discusses the reporting of sender address verification failures.
32529 .next
32530 The &%success_on_redirect%& option causes verification always to succeed
32531 immediately after a successful redirection. By default, if a redirection
32532 generates just one address, that address is also verified. See further
32533 discussion in section &<<SECTredirwhilveri>>&.
32534 .endlist
32535
32536 .cindex "verifying address" "differentiating failures"
32537 .vindex "&$recipient_verify_failure$&"
32538 .vindex "&$sender_verify_failure$&"
32539 .vindex "&$acl_verify_message$&"
32540 After an address verification failure, &$acl_verify_message$& contains the
32541 error message that is associated with the failure. It can be preserved by
32542 coding like this:
32543 .code
32544 warn  !verify = sender
32545        set acl_m0 = $acl_verify_message
32546 .endd
32547 If you are writing your own custom rejection message or log message when
32548 denying access, you can use this variable to include information about the
32549 verification failure.
32550
32551 In addition, &$sender_verify_failure$& or &$recipient_verify_failure$& (as
32552 appropriate) contains one of the following words:
32553
32554 .ilist
32555 &%qualify%&: The address was unqualified (no domain), and the message
32556 was neither local nor came from an exempted host.
32557 .next
32558 &%route%&: Routing failed.
32559 .next
32560 &%mail%&: Routing succeeded, and a callout was attempted; rejection
32561 occurred at or before the MAIL command (that is, on initial
32562 connection, HELO, or MAIL).
32563 .next
32564 &%recipient%&: The RCPT command in a callout was rejected.
32565 .next
32566 &%postmaster%&: The postmaster check in a callout was rejected.
32567 .endlist
32568
32569 The main use of these variables is expected to be to distinguish between
32570 rejections of MAIL and rejections of RCPT in callouts.
32571
32572 The above variables may also be set after a &*successful*&
32573 address verification to:
32574
32575 .ilist
32576 &%random%&: A random local-part callout succeeded
32577 .endlist
32578
32579
32580
32581
32582 .section "Callout verification" "SECTcallver"
32583 .cindex "verifying address" "by callout"
32584 .cindex "callout" "verification"
32585 .cindex "SMTP" "callout verification"
32586 For non-local addresses, routing verifies the domain, but is unable to do any
32587 checking of the local part. There are situations where some means of verifying
32588 the local part is desirable. One way this can be done is to make an SMTP
32589 &'callback'& to a delivery host for the sender address or a &'callforward'& to
32590 a subsequent host for a recipient address, to see if the host accepts the
32591 address. We use the term &'callout'& to cover both cases. Note that for a
32592 sender address, the callback is not to the client host that is trying to
32593 deliver the message, but to one of the hosts that accepts incoming mail for the
32594 sender's domain.
32595
32596 Exim does not do callouts by default. If you want them to happen, you must
32597 request them by setting appropriate options on the &%verify%& condition, as
32598 described below. This facility should be used with care, because it can add a
32599 lot of resource usage to the cost of verifying an address. However, Exim does
32600 cache the results of callouts, which helps to reduce the cost. Details of
32601 caching are in section &<<SECTcallvercache>>&.
32602
32603 Recipient callouts are usually used only between hosts that are controlled by
32604 the same administration. For example, a corporate gateway host could use
32605 callouts to check for valid recipients on an internal mailserver. A successful
32606 callout does not guarantee that a real delivery to the address would succeed;
32607 on the other hand, a failing callout does guarantee that a delivery would fail.
32608
32609 If the &%callout%& option is present on a condition that verifies an address, a
32610 second stage of verification occurs if the address is successfully routed to
32611 one or more remote hosts. The usual case is routing by a &(dnslookup)& or a
32612 &(manualroute)& router, where the router specifies the hosts. However, if a
32613 router that does not set up hosts routes to an &(smtp)& transport with a
32614 &%hosts%& setting, the transport's hosts are used. If an &(smtp)& transport has
32615 &%hosts_override%& set, its hosts are always used, whether or not the router
32616 supplies a host list.
32617 Callouts are only supported on &(smtp)& transports.
32618
32619 The port that is used is taken from the transport, if it is specified and is a
32620 remote transport. (For routers that do verification only, no transport need be
32621 specified.) Otherwise, the default SMTP port is used. If a remote transport
32622 specifies an outgoing interface, this is used; otherwise the interface is not
32623 specified. Likewise, the text that is used for the HELO command is taken from
32624 the transport's &%helo_data%& option; if there is no transport, the value of
32625 &$smtp_active_hostname$& is used.
32626
32627 For a sender callout check, Exim makes SMTP connections to the remote hosts, to
32628 test whether a bounce message could be delivered to the sender address. The
32629 following SMTP commands are sent:
32630 .display
32631 &`HELO `&<&'local host name'&>
32632 &`MAIL FROM:<>`&
32633 &`RCPT TO:`&<&'the address to be tested'&>
32634 &`QUIT`&
32635 .endd
32636 LHLO is used instead of HELO if the transport's &%protocol%& option is
32637 set to &"lmtp"&.
32638
32639 The callout may use EHLO, AUTH and/or STARTTLS given appropriate option
32640 settings.
32641
32642 A recipient callout check is similar. By default, it also uses an empty address
32643 for the sender. This default is chosen because most hosts do not make use of
32644 the sender address when verifying a recipient. Using the same address means
32645 that a single cache entry can be used for each recipient. Some sites, however,
32646 do make use of the sender address when verifying. These are catered for by the
32647 &%use_sender%& and &%use_postmaster%& options, described in the next section.
32648
32649 If the response to the RCPT command is a 2&'xx'& code, the verification
32650 succeeds. If it is 5&'xx'&, the verification fails. For any other condition,
32651 Exim tries the next host, if any. If there is a problem with all the remote
32652 hosts, the ACL yields &"defer"&, unless the &%defer_ok%& parameter of the
32653 &%callout%& option is given, in which case the condition is forced to succeed.
32654
32655 .cindex "SMTP" "output flushing, disabling for callout"
32656 A callout may take a little time. For this reason, Exim normally flushes SMTP
32657 output before performing a callout in an ACL, to avoid unexpected timeouts in
32658 clients when the SMTP PIPELINING extension is in use. The flushing can be
32659 disabled by using a &%control%& modifier to set &%no_callout_flush%&.
32660
32661
32662
32663
32664 .section "Additional parameters for callouts" "CALLaddparcall"
32665 .cindex "callout" "additional parameters for"
32666 The &%callout%& option can be followed by an equals sign and a number of
32667 optional parameters, separated by commas. For example:
32668 .code
32669 verify = recipient/callout=10s,defer_ok
32670 .endd
32671 The old syntax, which had &%callout_defer_ok%& and &%check_postmaster%& as
32672 separate verify options, is retained for backwards compatibility, but is now
32673 deprecated. The additional parameters for &%callout%& are as follows:
32674
32675
32676 .vlist
32677 .vitem <&'a&~time&~interval'&>
32678 .cindex "callout" "timeout, specifying"
32679 This specifies the timeout that applies for the callout attempt to each host.
32680 For example:
32681 .code
32682 verify = sender/callout=5s
32683 .endd
32684 The default is 30 seconds. The timeout is used for each response from the
32685 remote host. It is also used for the initial connection, unless overridden by
32686 the &%connect%& parameter.
32687
32688
32689 .vitem &*connect&~=&~*&<&'time&~interval'&>
32690 .cindex "callout" "connection timeout, specifying"
32691 This parameter makes it possible to set a different (usually smaller) timeout
32692 for making the SMTP connection. For example:
32693 .code
32694 verify = sender/callout=5s,connect=1s
32695 .endd
32696 If not specified, this timeout defaults to the general timeout value.
32697
32698 .vitem &*defer_ok*&
32699 .cindex "callout" "defer, action on"
32700 When this parameter is present, failure to contact any host, or any other kind
32701 of temporary error, is treated as success by the ACL. However, the cache is not
32702 updated in this circumstance.
32703
32704 .vitem &*fullpostmaster*&
32705 .cindex "callout" "full postmaster check"
32706 This operates like the &%postmaster%& option (see below), but if the check for
32707 &'postmaster@domain'& fails, it tries just &'postmaster'&, without a domain, in
32708 accordance with the specification in RFC 2821. The RFC states that the
32709 unqualified address &'postmaster'& should be accepted.
32710
32711
32712 .vitem &*mailfrom&~=&~*&<&'email&~address'&>
32713 .cindex "callout" "sender when verifying header"
32714 When verifying addresses in header lines using the &%header_sender%&
32715 verification option, Exim behaves by default as if the addresses are envelope
32716 sender addresses from a message. Callout verification therefore tests to see
32717 whether a bounce message could be delivered, by using an empty address in the
32718 MAIL command. However, it is arguable that these addresses might never be used
32719 as envelope senders, and could therefore justifiably reject bounce messages
32720 (empty senders). The &%mailfrom%& callout parameter allows you to specify what
32721 address to use in the MAIL command. For example:
32722 .code
32723 require  verify = header_sender/callout=mailfrom=abcd@x.y.z
32724 .endd
32725 This parameter is available only for the &%header_sender%& verification option.
32726
32727
32728 .vitem &*maxwait&~=&~*&<&'time&~interval'&>
32729 .cindex "callout" "overall timeout, specifying"
32730 This parameter sets an overall timeout for performing a callout verification.
32731 For example:
32732 .code
32733 verify = sender/callout=5s,maxwait=30s
32734 .endd
32735 This timeout defaults to four times the callout timeout for individual SMTP
32736 commands. The overall timeout applies when there is more than one host that can
32737 be tried. The timeout is checked before trying the next host. This prevents
32738 very long delays if there are a large number of hosts and all are timing out
32739 (for example, when network connections are timing out).
32740
32741
32742 .vitem &*no_cache*&
32743 .cindex "callout" "cache, suppressing"
32744 .cindex "caching callout, suppressing"
32745 When this parameter is given, the callout cache is neither read nor updated.
32746
32747 .vitem &*postmaster*&
32748 .cindex "callout" "postmaster; checking"
32749 When this parameter is set, a successful callout check is followed by a similar
32750 check for the local part &'postmaster'& at the same domain. If this address is
32751 rejected, the callout fails (but see &%fullpostmaster%& above). The result of
32752 the postmaster check is recorded in a cache record; if it is a failure, this is
32753 used to fail subsequent callouts for the domain without a connection being
32754 made, until the cache record expires.
32755
32756 .vitem &*postmaster_mailfrom&~=&~*&<&'email&~address'&>
32757 The postmaster check uses an empty sender in the MAIL command by default.
32758 You can use this parameter to do a postmaster check using a different address.
32759 For example:
32760 .code
32761 require  verify = sender/callout=postmaster_mailfrom=abc@x.y.z
32762 .endd
32763 If both &%postmaster%& and &%postmaster_mailfrom%& are present, the rightmost
32764 one overrides. The &%postmaster%& parameter is equivalent to this example:
32765 .code
32766 require  verify = sender/callout=postmaster_mailfrom=
32767 .endd
32768 &*Warning*&: The caching arrangements for postmaster checking do not take
32769 account of the sender address. It is assumed that either the empty address or
32770 a fixed non-empty address will be used. All that Exim remembers is that the
32771 postmaster check for the domain succeeded or failed.
32772
32773
32774 .vitem &*random*&
32775 .cindex "callout" "&""random""& check"
32776 When this parameter is set, before doing the normal callout check, Exim does a
32777 check for a &"random"& local part at the same domain. The local part is not
32778 really random &-- it is defined by the expansion of the option
32779 &%callout_random_local_part%&, which defaults to
32780 .code
32781 $primary_hostname-$tod_epoch-testing
32782 .endd
32783 The idea here is to try to determine whether the remote host accepts all local
32784 parts without checking. If it does, there is no point in doing callouts for
32785 specific local parts. If the &"random"& check succeeds, the result is saved in
32786 a cache record, and used to force the current and subsequent callout checks to
32787 succeed without a connection being made, until the cache record expires.
32788
32789 .vitem &*use_postmaster*&
32790 .cindex "callout" "sender for recipient check"
32791 This parameter applies to recipient callouts only. For example:
32792 .code
32793 deny  !verify = recipient/callout=use_postmaster
32794 .endd
32795 .vindex "&$qualify_domain$&"
32796 It causes a non-empty postmaster address to be used in the MAIL command when
32797 performing the callout for the recipient, and also for a &"random"& check if
32798 that is configured. The local part of the address is &`postmaster`& and the
32799 domain is the contents of &$qualify_domain$&.
32800
32801 .vitem &*use_sender*&
32802 This option applies to recipient callouts only. For example:
32803 .code
32804 require  verify = recipient/callout=use_sender
32805 .endd
32806 It causes the message's actual sender address to be used in the MAIL
32807 command when performing the callout, instead of an empty address. There is no
32808 need to use this option unless you know that the called hosts make use of the
32809 sender when checking recipients. If used indiscriminately, it reduces the
32810 usefulness of callout caching.
32811
32812 .vitem &*hold*&
32813 This option applies to recipient callouts only. For example:
32814 .code
32815 require  verify = recipient/callout=use_sender,hold
32816 .endd
32817 It causes the connection to be held open and used for any further recipients
32818 and for eventual delivery (should that be done quickly).
32819 Doing this saves on TCP and SMTP startup costs, and TLS costs also
32820 when that is used for the connections.
32821 The advantage is only gained if there are no callout cache hits
32822 (which could be enforced by the no_cache option),
32823 if the use_sender option is used,
32824 if neither the random nor the use_postmaster option is used,
32825 and if no other callouts intervene.
32826 .endlist
32827
32828 If you use any of the parameters that set a non-empty sender for the MAIL
32829 command (&%mailfrom%&, &%postmaster_mailfrom%&, &%use_postmaster%&, or
32830 &%use_sender%&), you should think about possible loops. Recipient checking is
32831 usually done between two hosts that are under the same management, and the host
32832 that receives the callouts is not normally configured to do callouts itself.
32833 Therefore, it is normally safe to use &%use_postmaster%& or &%use_sender%& in
32834 these circumstances.
32835
32836 However, if you use a non-empty sender address for a callout to an arbitrary
32837 host, there is the likelihood that the remote host will itself initiate a
32838 callout check back to your host. As it is checking what appears to be a message
32839 sender, it is likely to use an empty address in MAIL, thus avoiding a
32840 callout loop. However, to be on the safe side it would be best to set up your
32841 own ACLs so that they do not do sender verification checks when the recipient
32842 is the address you use for header sender or postmaster callout checking.
32843
32844 Another issue to think about when using non-empty senders for callouts is
32845 caching. When you set &%mailfrom%& or &%use_sender%&, the cache record is keyed
32846 by the sender/recipient combination; thus, for any given recipient, many more
32847 actual callouts are performed than when an empty sender or postmaster is used.
32848
32849
32850
32851
32852 .section "Callout caching" "SECTcallvercache"
32853 .cindex "hints database" "callout cache"
32854 .cindex "callout" "cache, description of"
32855 .cindex "caching" "callout"
32856 Exim caches the results of callouts in order to reduce the amount of resources
32857 used, unless you specify the &%no_cache%& parameter with the &%callout%&
32858 option. A hints database called &"callout"& is used for the cache. Two
32859 different record types are used: one records the result of a callout check for
32860 a specific address, and the other records information that applies to the
32861 entire domain (for example, that it accepts the local part &'postmaster'&).
32862
32863 When an original callout fails, a detailed SMTP error message is given about
32864 the failure. However, for subsequent failures use the cache data, this message
32865 is not available.
32866
32867 The expiry times for negative and positive address cache records are
32868 independent, and can be set by the global options &%callout_negative_expire%&
32869 (default 2h) and &%callout_positive_expire%& (default 24h), respectively.
32870
32871 If a host gives a negative response to an SMTP connection, or rejects any
32872 commands up to and including
32873 .code
32874 MAIL FROM:<>
32875 .endd
32876 (but not including the MAIL command with a non-empty address),
32877 any callout attempt is bound to fail. Exim remembers such failures in a
32878 domain cache record, which it uses to fail callouts for the domain without
32879 making new connections, until the domain record times out. There are two
32880 separate expiry times for domain cache records:
32881 &%callout_domain_negative_expire%& (default 3h) and
32882 &%callout_domain_positive_expire%& (default 7d).
32883
32884 Domain records expire when the negative expiry time is reached if callouts
32885 cannot be made for the domain, or if the postmaster check failed.
32886 Otherwise, they expire when the positive expiry time is reached. This
32887 ensures that, for example, a host that stops accepting &"random"& local parts
32888 will eventually be noticed.
32889
32890 The callout caching mechanism is based on the domain of the address that is
32891 being tested. If the domain routes to several hosts, it is assumed that their
32892 behaviour will be the same.
32893
32894
32895
32896 .section "Sender address verification reporting" "SECTsenaddver"
32897 .cindex "verifying" "suppressing error details"
32898 See section &<<SECTaddressverification>>& for a general discussion of
32899 verification. When sender verification fails in an ACL, the details of the
32900 failure are given as additional output lines before the 550 response to the
32901 relevant SMTP command (RCPT or DATA). For example, if sender callout is in use,
32902 you might see:
32903 .code
32904 MAIL FROM:<xyz@abc.example>
32905 250 OK
32906 RCPT TO:<pqr@def.example>
32907 550-Verification failed for <xyz@abc.example>
32908 550-Called:   192.168.34.43
32909 550-Sent:     RCPT TO:<xyz@abc.example>
32910 550-Response: 550 Unknown local part xyz in <xyz@abc.example>
32911 550 Sender verification failed
32912 .endd
32913 If more than one RCPT command fails in the same way, the details are given
32914 only for the first of them. However, some administrators do not want to send
32915 out this much information. You can suppress the details by adding
32916 &`/no_details`& to the ACL statement that requests sender verification. For
32917 example:
32918 .code
32919 verify = sender/no_details
32920 .endd
32921
32922 .section "Redirection while verifying" "SECTredirwhilveri"
32923 .cindex "verifying" "redirection while"
32924 .cindex "address redirection" "while verifying"
32925 A dilemma arises when a local address is redirected by aliasing or forwarding
32926 during verification: should the generated addresses themselves be verified,
32927 or should the successful expansion of the original address be enough to verify
32928 it? By default, Exim takes the following pragmatic approach:
32929
32930 .ilist
32931 When an incoming address is redirected to just one child address, verification
32932 continues with the child address, and if that fails to verify, the original
32933 verification also fails.
32934 .next
32935 When an incoming address is redirected to more than one child address,
32936 verification does not continue. A success result is returned.
32937 .endlist
32938
32939 This seems the most reasonable behaviour for the common use of aliasing as a
32940 way of redirecting different local parts to the same mailbox. It means, for
32941 example, that a pair of alias entries of the form
32942 .code
32943 A.Wol:   aw123
32944 aw123:   :fail: Gone away, no forwarding address
32945 .endd
32946 work as expected, with both local parts causing verification failure. When a
32947 redirection generates more than one address, the behaviour is more like a
32948 mailing list, where the existence of the alias itself is sufficient for
32949 verification to succeed.
32950
32951 It is possible, however, to change the default behaviour so that all successful
32952 redirections count as successful verifications, however many new addresses are
32953 generated. This is specified by the &%success_on_redirect%& verification
32954 option. For example:
32955 .code
32956 require verify = recipient/success_on_redirect/callout=10s
32957 .endd
32958 In this example, verification succeeds if a router generates a new address, and
32959 the callout does not occur, because no address was routed to a remote host.
32960
32961 When verification is being tested via the &%-bv%& option, the treatment of
32962 redirections is as just described, unless the &%-v%& or any debugging option is
32963 also specified. In that case, full verification is done for every generated
32964 address and a report is output for each of them.
32965
32966
32967
32968 .section "Client SMTP authorization (CSA)" "SECTverifyCSA"
32969 .cindex "CSA" "verifying"
32970 Client SMTP Authorization is a system that allows a site to advertise
32971 which machines are and are not permitted to send email. This is done by placing
32972 special SRV records in the DNS; these are looked up using the client's HELO
32973 domain. At the time of writing, CSA is still an Internet Draft. Client SMTP
32974 Authorization checks in Exim are performed by the ACL condition:
32975 .code
32976 verify = csa
32977 .endd
32978 This fails if the client is not authorized. If there is a DNS problem, or if no
32979 valid CSA SRV record is found, or if the client is authorized, the condition
32980 succeeds. These three cases can be distinguished using the expansion variable
32981 &$csa_status$&, which can take one of the values &"fail"&, &"defer"&,
32982 &"unknown"&, or &"ok"&. The condition does not itself defer because that would
32983 be likely to cause problems for legitimate email.
32984
32985 The error messages produced by the CSA code include slightly more
32986 detail. If &$csa_status$& is &"defer"&, this may be because of problems
32987 looking up the CSA SRV record, or problems looking up the CSA target
32988 address record. There are four reasons for &$csa_status$& being &"fail"&:
32989
32990 .ilist
32991 The client's host name is explicitly not authorized.
32992 .next
32993 The client's IP address does not match any of the CSA target IP addresses.
32994 .next
32995 The client's host name is authorized but it has no valid target IP addresses
32996 (for example, the target's addresses are IPv6 and the client is using IPv4).
32997 .next
32998 The client's host name has no CSA SRV record but a parent domain has asserted
32999 that all subdomains must be explicitly authorized.
33000 .endlist
33001
33002 The &%csa%& verification condition can take an argument which is the domain to
33003 use for the DNS query. The default is:
33004 .code
33005 verify = csa/$sender_helo_name
33006 .endd
33007 This implementation includes an extension to CSA. If the query domain
33008 is an address literal such as [192.0.2.95], or if it is a bare IP
33009 address, Exim searches for CSA SRV records in the reverse DNS as if
33010 the HELO domain was (for example) &'95.2.0.192.in-addr.arpa'&. Therefore it is
33011 meaningful to say:
33012 .code
33013 verify = csa/$sender_host_address
33014 .endd
33015 In fact, this is the check that Exim performs if the client does not say HELO.
33016 This extension can be turned off by setting the main configuration option
33017 &%dns_csa_use_reverse%& to be false.
33018
33019 If a CSA SRV record is not found for the domain itself, a search
33020 is performed through its parent domains for a record which might be
33021 making assertions about subdomains. The maximum depth of this search is limited
33022 using the main configuration option &%dns_csa_search_limit%&, which is 5 by
33023 default. Exim does not look for CSA SRV records in a top level domain, so the
33024 default settings handle HELO domains as long as seven
33025 (&'hostname.five.four.three.two.one.com'&). This encompasses the vast majority
33026 of legitimate HELO domains.
33027
33028 The &'dnsdb'& lookup also has support for CSA. Although &'dnsdb'& also supports
33029 direct SRV lookups, this is not sufficient because of the extra parent domain
33030 search behaviour of CSA, and (as with PTR lookups) &'dnsdb'& also turns IP
33031 addresses into lookups in the reverse DNS space. The result of a successful
33032 lookup such as:
33033 .code
33034 ${lookup dnsdb {csa=$sender_helo_name}}
33035 .endd
33036 has two space-separated fields: an authorization code and a target host name.
33037 The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
33038 authorization required but absent, or &"?"& for unknown.
33039
33040
33041
33042
33043 .section "Bounce address tag validation" "SECTverifyPRVS"
33044 .cindex "BATV, verifying"
33045 Bounce address tag validation (BATV) is a scheme whereby the envelope senders
33046 of outgoing messages have a cryptographic, timestamped &"tag"& added to them.
33047 Genuine incoming bounce messages should therefore always be addressed to
33048 recipients that have a valid tag. This scheme is a way of detecting unwanted
33049 bounce messages caused by sender address forgeries (often called &"collateral
33050 spam"&), because the recipients of such messages do not include valid tags.
33051
33052 There are two expansion items to help with the implementation of the BATV
33053 &"prvs"& (private signature) scheme in an Exim configuration. This scheme signs
33054 the original envelope sender address by using a simple key to add a hash of the
33055 address and some time-based randomizing information. The &%prvs%& expansion
33056 item creates a signed address, and the &%prvscheck%& expansion item checks one.
33057 The syntax of these expansion items is described in section
33058 &<<SECTexpansionitems>>&.
33059 The validity period on signed addresses is seven days.
33060
33061 As an example, suppose the secret per-address keys are stored in an MySQL
33062 database. A query to look up the key for an address could be defined as a macro
33063 like this:
33064 .code
33065 PRVSCHECK_SQL = ${lookup mysql{SELECT secret FROM batv_prvs \
33066                 WHERE sender='${quote_mysql:$prvscheck_address}'\
33067                 }{$value}}
33068 .endd
33069 Suppose also that the senders who make use of BATV are defined by an address
33070 list called &%batv_senders%&. Then, in the ACL for RCPT commands, you could
33071 use this:
33072 .code
33073 # Bounces: drop unsigned addresses for BATV senders
33074 deny senders = :
33075      recipients = +batv_senders
33076      message = This address does not send an unsigned reverse path
33077
33078 # Bounces: In case of prvs-signed address, check signature.
33079 deny senders = :
33080      condition  = ${prvscheck {$local_part@$domain}\
33081                   {PRVSCHECK_SQL}{1}}
33082      !condition = $prvscheck_result
33083      message = Invalid reverse path signature.
33084 .endd
33085 The first statement rejects recipients for bounce messages that are addressed
33086 to plain BATV sender addresses, because it is known that BATV senders do not
33087 send out messages with plain sender addresses. The second statement rejects
33088 recipients that are prvs-signed, but with invalid signatures (either because
33089 the key is wrong, or the signature has timed out).
33090
33091 A non-prvs-signed address is not rejected by the second statement, because the
33092 &%prvscheck%& expansion yields an empty string if its first argument is not a
33093 prvs-signed address, thus causing the &%condition%& condition to be false. If
33094 the first argument is a syntactically valid prvs-signed address, the yield is
33095 the third string (in this case &"1"&), whether or not the cryptographic and
33096 timeout checks succeed. The &$prvscheck_result$& variable contains the result
33097 of the checks (empty for failure, &"1"& for success).
33098
33099 There is one more issue you must consider when implementing prvs-signing:
33100 you have to ensure that the routers accept prvs-signed addresses and
33101 deliver them correctly. The easiest way to handle this is to use a &(redirect)&
33102 router to remove the signature with a configuration along these lines:
33103 .code
33104 batv_redirect:
33105   driver = redirect
33106   data = ${prvscheck {$local_part@$domain}{PRVSCHECK_SQL}}
33107 .endd
33108 This works because, if the third argument of &%prvscheck%& is empty, the result
33109 of the expansion of a prvs-signed address is the decoded value of the original
33110 address. This router should probably be the first of your routers that handles
33111 local addresses.
33112
33113 To create BATV-signed addresses in the first place, a transport of this form
33114 can be used:
33115 .code
33116 external_smtp_batv:
33117   driver = smtp
33118   return_path = ${prvs {$return_path} \
33119                        {${lookup mysql{SELECT \
33120                        secret FROM batv_prvs WHERE \
33121                        sender='${quote_mysql:$sender_address}'} \
33122                        {$value}fail}}}
33123 .endd
33124 If no key can be found for the existing return path, no signing takes place.
33125
33126
33127
33128 .section "Using an ACL to control relaying" "SECTrelaycontrol"
33129 .cindex "&ACL;" "relay control"
33130 .cindex "relaying" "control by ACL"
33131 .cindex "policy control" "relay control"
33132 An MTA is said to &'relay'& a message if it receives it from some host and
33133 delivers it directly to another host as a result of a remote address contained
33134 within it. Redirecting a local address via an alias or forward file and then
33135 passing the message on to another host is not relaying,
33136 .cindex "&""percent hack""&"
33137 but a redirection as a result of the &"percent hack"& is.
33138
33139 Two kinds of relaying exist, which are termed &"incoming"& and &"outgoing"&.
33140 A host which is acting as a gateway or an MX backup is concerned with incoming
33141 relaying from arbitrary hosts to a specific set of domains. On the other hand,
33142 a host which is acting as a smart host for a number of clients is concerned
33143 with outgoing relaying from those clients to the Internet at large. Often the
33144 same host is fulfilling both functions,
33145 . ///
33146 . as illustrated in the diagram below,
33147 . ///
33148 but in principle these two kinds of relaying are entirely independent. What is
33149 not wanted is the transmission of mail from arbitrary remote hosts through your
33150 system to arbitrary domains.
33151
33152
33153 You can implement relay control by means of suitable statements in the ACL that
33154 runs for each RCPT command. For convenience, it is often easiest to use
33155 Exim's named list facility to define the domains and hosts involved. For
33156 example, suppose you want to do the following:
33157
33158 .ilist
33159 Deliver a number of domains to mailboxes on the local host (or process them
33160 locally in some other way). Let's say these are &'my.dom1.example'& and
33161 &'my.dom2.example'&.
33162 .next
33163 Relay mail for a number of other domains for which you are the secondary MX.
33164 These might be &'friend1.example'& and &'friend2.example'&.
33165 .next
33166 Relay mail from the hosts on your local LAN, to whatever domains are involved.
33167 Suppose your LAN is 192.168.45.0/24.
33168 .endlist
33169
33170
33171 In the main part of the configuration, you put the following definitions:
33172 .code
33173 domainlist local_domains    = my.dom1.example : my.dom2.example
33174 domainlist relay_to_domains = friend1.example : friend2.example
33175 hostlist   relay_from_hosts = 192.168.45.0/24
33176 .endd
33177 Now you can use these definitions in the ACL that is run for every RCPT
33178 command:
33179 .code
33180 acl_check_rcpt:
33181   accept domains = +local_domains : +relay_to_domains
33182   accept hosts   = +relay_from_hosts
33183 .endd
33184 The first statement accepts any RCPT command that contains an address in
33185 the local or relay domains. For any other domain, control passes to the second
33186 statement, which accepts the command only if it comes from one of the relay
33187 hosts. In practice, you will probably want to make your ACL more sophisticated
33188 than this, for example, by including sender and recipient verification. The
33189 default configuration includes a more comprehensive example, which is described
33190 in chapter &<<CHAPdefconfil>>&.
33191
33192
33193
33194 .section "Checking a relay configuration" "SECTcheralcon"
33195 .cindex "relaying" "checking control of"
33196 You can check the relay characteristics of your configuration in the same way
33197 that you can test any ACL behaviour for an incoming SMTP connection, by using
33198 the &%-bh%& option to run a fake SMTP session with which you interact.
33199 .ecindex IIDacl
33200
33201
33202
33203 . ////////////////////////////////////////////////////////////////////////////
33204 . ////////////////////////////////////////////////////////////////////////////
33205
33206 .chapter "Content scanning at ACL time" "CHAPexiscan"
33207 .scindex IIDcosca "content scanning" "at ACL time"
33208 The extension of Exim to include content scanning at ACL time, formerly known
33209 as &"exiscan"&, was originally implemented as a patch by Tom Kistner. The code
33210 was integrated into the main source for Exim release 4.50, and Tom continues to
33211 maintain it. Most of the wording of this chapter is taken from Tom's
33212 specification.
33213
33214 It is also possible to scan the content of messages at other times. The
33215 &[local_scan()]& function (see chapter &<<CHAPlocalscan>>&) allows for content
33216 scanning after all the ACLs have run. A transport filter can be used to scan
33217 messages at delivery time (see the &%transport_filter%& option, described in
33218 chapter &<<CHAPtransportgeneric>>&).
33219
33220 If you want to include the ACL-time content-scanning features when you compile
33221 Exim, you need to arrange for WITH_CONTENT_SCAN to be defined in your
33222 &_Local/Makefile_&. When you do that, the Exim binary is built with:
33223
33224 .ilist
33225 Two additional ACLs (&%acl_smtp_mime%& and &%acl_not_smtp_mime%&) that are run
33226 for all MIME parts for SMTP and non-SMTP messages, respectively.
33227 .next
33228 Additional ACL conditions and modifiers: &%decode%&, &%malware%&,
33229 &%mime_regex%&, &%regex%&, and &%spam%&. These can be used in the ACL that is
33230 run at the end of message reception (the &%acl_smtp_data%& ACL).
33231 .next
33232 An additional control feature (&"no_mbox_unspool"&) that saves spooled copies
33233 of messages, or parts of messages, for debugging purposes.
33234 .next
33235 Additional expansion variables that are set in the new ACL and by the new
33236 conditions.
33237 .next
33238 Two new main configuration options: &%av_scanner%& and &%spamd_address%&.
33239 .endlist
33240
33241 Content-scanning is continually evolving, and new features are still being
33242 added. While such features are still unstable and liable to incompatible
33243 changes, they are made available in Exim by setting options whose names begin
33244 EXPERIMENTAL_ in &_Local/Makefile_&. Such features are not documented in
33245 this manual. You can find out about them by reading the file called
33246 &_doc/experimental.txt_&.
33247
33248 All the content-scanning facilities work on a MBOX copy of the message that is
33249 temporarily created in a file called:
33250 .display
33251 <&'spool_directory'&>&`/scan/`&<&'message_id'&>/<&'message_id'&>&`.eml`&
33252 .endd
33253 The &_.eml_& extension is a friendly hint to virus scanners that they can
33254 expect an MBOX-like structure inside that file. The file is created when the
33255 first content scanning facility is called. Subsequent calls to content
33256 scanning conditions open the same file again. The directory is recursively
33257 removed when the &%acl_smtp_data%& ACL has finished running, unless
33258 .code
33259 control = no_mbox_unspool
33260 .endd
33261 has been encountered. When the MIME ACL decodes files, they are put into the
33262 same directory by default.
33263
33264
33265
33266 .section "Scanning for viruses" "SECTscanvirus"
33267 .cindex "virus scanning"
33268 .cindex "content scanning" "for viruses"
33269 .cindex "content scanning" "the &%malware%& condition"
33270 The &%malware%& ACL condition lets you connect virus scanner software to Exim.
33271 It supports a &"generic"& interface to scanners called via the shell, and
33272 specialized interfaces for &"daemon"& type virus scanners, which are resident
33273 in memory and thus are much faster.
33274
33275 Since message data needs to have arrived,
33276 the condition may be only called in ACL defined by
33277 &%acl_smtp_data%&,
33278 &%acl_smtp_data_prdr%&,
33279 &%acl_smtp_mime%& or
33280 &%acl_smtp_dkim%&
33281
33282 A timeout of 2 minutes is applied to a scanner call (by default);
33283 if it expires then a defer action is taken.
33284
33285 .oindex "&%av_scanner%&"
33286 You can set the &%av_scanner%& option in the main part of the configuration
33287 to specify which scanner to use, together with any additional options that
33288 are needed. The basic syntax is as follows:
33289 .display
33290 &`av_scanner = <`&&'scanner-type'&&`>:<`&&'option1'&&`>:<`&&'option2'&&`>:[...]`&
33291 .endd
33292 If you do not set &%av_scanner%&, it defaults to
33293 .code
33294 av_scanner = sophie:/var/run/sophie
33295 .endd
33296 If the value of &%av_scanner%& starts with a dollar character, it is expanded
33297 before use.
33298 The usual list-parsing of the content (see &<<SECTlistconstruct>>&) applies.
33299 The following scanner types are supported in this release,
33300 though individual ones can be included or not at build time:
33301
33302 .vlist
33303 .vitem &%avast%&
33304 .cindex "virus scanners" "avast"
33305 This is the scanner daemon of Avast. It has been tested with Avast Core
33306 Security (currently at version 2.2.0).
33307 You can get a trial version at &url(https://www.avast.com) or for Linux
33308 at &url(https://www.avast.com/linux-server-antivirus).
33309 This scanner type takes one option,
33310 which can be either a full path to a UNIX socket,
33311 or host and port specifiers separated by white space.
33312 The host may be a name or an IP address; the port is either a
33313 single number or a pair of numbers with a dash between.
33314 A list of options may follow. These options are interpreted on the
33315 Exim's side of the malware scanner, or are given on separate lines to
33316 the daemon as options before the main scan command.
33317
33318 .cindex &`pass_unscanned`& "avast"
33319 If &`pass_unscanned`&
33320 is set, any files the Avast scanner can't scan (e.g.
33321 decompression bombs, or invalid archives) are considered clean. Use with
33322 care.
33323
33324 For example:
33325 .code
33326 av_scanner = avast:/var/run/avast/scan.sock:FLAGS -fullfiles:SENSITIVITY -pup
33327 av_scanner = avast:/var/run/avast/scan.sock:pass_unscanned:FLAGS -fullfiles:SENSITIVITY -pup
33328 av_scanner = avast:192.168.2.22 5036
33329 .endd
33330 If you omit the argument, the default path
33331 &_/var/run/avast/scan.sock_&
33332 is used.
33333 If you use a remote host,
33334 you need to make Exim's spool directory available to it,
33335 as the scanner is passed a file path, not file contents.
33336 For information about available commands and their options you may use
33337 .code
33338 $ socat UNIX:/var/run/avast/scan.sock STDIO:
33339     FLAGS
33340     SENSITIVITY
33341     PACK
33342 .endd
33343
33344 If the scanner returns a temporary failure (e.g. license issues, or
33345 permission problems), the message is deferred and a paniclog entry is
33346 written.  The usual &`defer_ok`& option is available.
33347
33348 .vitem &%aveserver%&
33349 .cindex "virus scanners" "Kaspersky"
33350 This is the scanner daemon of Kaspersky Version 5. You can get a trial version
33351 at &url(https://www.kaspersky.com/). This scanner type takes one option,
33352 which is the path to the daemon's UNIX socket. The default is shown in this
33353 example:
33354 .code
33355 av_scanner = aveserver:/var/run/aveserver
33356 .endd
33357
33358
33359 .vitem &%clamd%&
33360 .cindex "virus scanners" "clamd"
33361 This daemon-type scanner is GPL and free. You can get it at
33362 &url(https://www.clamav.net/). Some older versions of clamd do not seem to
33363 unpack MIME containers, so it used to be recommended to unpack MIME attachments
33364 in the MIME ACL. This is no longer believed to be necessary.
33365
33366 The options are a list of server specifiers, which may be
33367 a UNIX socket specification,
33368 a TCP socket specification,
33369 or a (global) option.
33370
33371 A socket specification consists of a space-separated list.
33372 For a Unix socket the first element is a full path for the socket,
33373 for a TCP socket the first element is the IP address
33374 and the second a port number,
33375 Any further elements are per-server (non-global) options.
33376 These per-server options are supported:
33377 .code
33378 retry=<timespec>        Retry on connect fail
33379 .endd
33380
33381 The &`retry`& option specifies a time after which a single retry for
33382 a failed connect is made.  The default is to not retry.
33383
33384 If a Unix socket file is specified, only one server is supported.
33385
33386 Examples:
33387 .code
33388 av_scanner = clamd:/opt/clamd/socket
33389 av_scanner = clamd:192.0.2.3 1234
33390 av_scanner = clamd:192.0.2.3 1234:local
33391 av_scanner = clamd:192.0.2.3 1234 retry=10s
33392 av_scanner = clamd:192.0.2.3 1234 : 192.0.2.4 1234
33393 .endd
33394 If the value of av_scanner points to a UNIX socket file or contains the
33395 &`local`&
33396 option, then the ClamAV interface will pass a filename containing the data
33397 to be scanned, which should normally result in less I/O happening and be
33398 more efficient.  Normally in the TCP case, the data is streamed to ClamAV as
33399 Exim does not assume that there is a common filesystem with the remote host.
33400
33401 The final example shows that multiple TCP targets can be specified.  Exim will
33402 randomly use one for each incoming email (i.e. it load balances them).  Note
33403 that only TCP targets may be used if specifying a list of scanners; a UNIX
33404 socket cannot be mixed in with TCP targets.  If one of the servers becomes
33405 unavailable, Exim will try the remaining one(s) until it finds one that works.
33406 When a clamd server becomes unreachable, Exim will log a message.  Exim does
33407 not keep track of scanner state between multiple messages, and the scanner
33408 selection is random, so the message will get logged in the mainlog for each
33409 email that the down scanner gets chosen first (message wrapped to be readable):
33410 .code
33411 2013-10-09 14:30:39 1VTumd-0000Y8-BQ malware acl condition:
33412    clamd: connection to localhost, port 3310 failed
33413    (Connection refused)
33414 .endd
33415
33416 If the option is unset, the default is &_/tmp/clamd_&. Thanks to David Saez for
33417 contributing the code for this scanner.
33418
33419 .vitem &%cmdline%&
33420 .cindex "virus scanners" "command line interface"
33421 This is the keyword for the generic command line scanner interface. It can be
33422 used to attach virus scanners that are invoked from the shell. This scanner
33423 type takes 3 mandatory options:
33424
33425 .olist
33426 The full path and name of the scanner binary, with all command line options,
33427 and a placeholder (&`%s`&) for the directory to scan.
33428
33429 .next
33430 A regular expression to match against the STDOUT and STDERR output of the
33431 virus scanner. If the expression matches, a virus was found. You must make
33432 absolutely sure that this expression matches on &"virus found"&. This is called
33433 the &"trigger"& expression.
33434
33435 .next
33436 Another regular expression, containing exactly one pair of parentheses, to
33437 match the name of the virus found in the scanners output. This is called the
33438 &"name"& expression.
33439 .endlist olist
33440
33441 For example, Sophos Sweep reports a virus on a line like this:
33442 .code
33443 Virus 'W32/Magistr-B' found in file ./those.bat
33444 .endd
33445 For the trigger expression, we can match the phrase &"found in file"&. For the
33446 name expression, we want to extract the W32/Magistr-B string, so we can match
33447 for the single quotes left and right of it. Altogether, this makes the
33448 configuration setting:
33449 .code
33450 av_scanner = cmdline:\
33451              /path/to/sweep -ss -all -rec -archive %s:\
33452              found in file:'(.+)'
33453 .endd
33454 .vitem &%drweb%&
33455 .cindex "virus scanners" "DrWeb"
33456 The DrWeb daemon scanner (&url(https://www.sald.ru/)) interface
33457 takes one option,
33458 either a full path to a UNIX socket,
33459 or host and port specifiers separated by white space.
33460 The host may be a name or an IP address; the port is either a
33461 single number or a pair of numbers with a dash between.
33462 For example:
33463 .code
33464 av_scanner = drweb:/var/run/drwebd.sock
33465 av_scanner = drweb:192.168.2.20 31337
33466 .endd
33467 If you omit the argument, the default path &_/usr/local/drweb/run/drwebd.sock_&
33468 is used. Thanks to Alex Miller for contributing the code for this scanner.
33469
33470 .vitem &%f-protd%&
33471 .cindex "virus scanners" "f-protd"
33472 The f-protd scanner is accessed via HTTP over TCP.
33473 One argument is taken, being a space-separated hostname and port number
33474 (or port-range).
33475 For example:
33476 .code
33477 av_scanner = f-protd:localhost 10200-10204
33478 .endd
33479 If you omit the argument, the default values shown above are used.
33480
33481 .vitem &%f-prot6d%&
33482 .cindex "virus scanners" "f-prot6d"
33483 The f-prot6d scanner is accessed using the FPSCAND protocol over TCP.
33484 One argument is taken, being a space-separated hostname and port number.
33485 For example:
33486 .code
33487 av_scanner = f-prot6d:localhost 10200
33488 .endd
33489 If you omit the argument, the default values show above are used.
33490
33491 .vitem &%fsecure%&
33492 .cindex "virus scanners" "F-Secure"
33493 The F-Secure daemon scanner (&url(https://www.f-secure.com/)) takes one
33494 argument which is the path to a UNIX socket. For example:
33495 .code
33496 av_scanner = fsecure:/path/to/.fsav
33497 .endd
33498 If no argument is given, the default is &_/var/run/.fsav_&. Thanks to Johan
33499 Thelmen for contributing the code for this scanner.
33500
33501 .vitem &%kavdaemon%&
33502 .cindex "virus scanners" "Kaspersky"
33503 This is the scanner daemon of Kaspersky Version 4. This version of the
33504 Kaspersky scanner is outdated. Please upgrade (see &%aveserver%& above). This
33505 scanner type takes one option, which is the path to the daemon's UNIX socket.
33506 For example:
33507 .code
33508 av_scanner = kavdaemon:/opt/AVP/AvpCtl
33509 .endd
33510 The default path is &_/var/run/AvpCtl_&.
33511
33512 .vitem &%mksd%&
33513 .cindex "virus scanners" "mksd"
33514 This was a daemon type scanner that is aimed mainly at Polish users,
33515 though some documentation was available in English.
33516 The history can be shown at &url(https://en.wikipedia.org/wiki/Mks_vir)
33517 and this appears to be a candidate for removal from Exim, unless
33518 we are informed of other virus scanners which use the same protocol
33519 to integrate.
33520 The only option for this scanner type is
33521 the maximum number of processes used simultaneously to scan the attachments,
33522 provided that mksd has
33523 been run with at least the same number of child processes. For example:
33524 .code
33525 av_scanner = mksd:2
33526 .endd
33527 You can safely omit this option (the default value is 1).
33528
33529 .vitem &%sock%&
33530 .cindex "virus scanners" "simple socket-connected"
33531 This is a general-purpose way of talking to simple scanner daemons
33532 running on the local machine.
33533 There are four options:
33534 an address (which may be an IP address and port, or the path of a Unix socket),
33535 a commandline to send (may include a single %s which will be replaced with
33536 the path to the mail file to be scanned),
33537 an RE to trigger on from the returned data,
33538 and an RE to extract malware_name from the returned data.
33539 For example:
33540 .code
33541 av_scanner = sock:127.0.0.1 6001:%s:(SPAM|VIRUS):(.*)$
33542 .endd
33543 Note that surrounding whitespace is stripped from each option, meaning
33544 there is no way to specify a trailing newline.
33545 The socket specifier and both regular-expressions are required.
33546 Default for the commandline is &_%s\n_& (note this does have a trailing newline);
33547 specify an empty element to get this.
33548
33549 .vitem &%sophie%&
33550 .cindex "virus scanners" "Sophos and Sophie"
33551 Sophie is a daemon that uses Sophos' &%libsavi%& library to scan for viruses.
33552 You can get Sophie at &url(http://sophie.sourceforge.net/). The only option
33553 for this scanner type is the path to the UNIX socket that Sophie uses for
33554 client communication. For example:
33555 .code
33556 av_scanner = sophie:/tmp/sophie
33557 .endd
33558 The default path is &_/var/run/sophie_&, so if you are using this, you can omit
33559 the option.
33560 .endlist
33561
33562 When &%av_scanner%& is correctly set, you can use the &%malware%& condition in
33563 the DATA ACL. &*Note*&: You cannot use the &%malware%& condition in the MIME
33564 ACL.
33565
33566 The &%av_scanner%& option is expanded each time &%malware%& is called. This
33567 makes it possible to use different scanners. See further below for an example.
33568 The &%malware%& condition caches its results, so when you use it multiple times
33569 for the same message, the actual scanning process is only carried out once.
33570 However, using expandable items in &%av_scanner%& disables this caching, in
33571 which case each use of the &%malware%& condition causes a new scan of the
33572 message.
33573
33574 The &%malware%& condition takes a right-hand argument that is expanded before
33575 use and taken as a list, slash-separated by default.
33576 The first element can then be one of
33577
33578 .ilist
33579 &"true"&, &"*"&, or &"1"&, in which case the message is scanned for viruses.
33580 The condition succeeds if a virus was found, and fail otherwise. This is the
33581 recommended usage.
33582 .next
33583 &"false"& or &"0"& or an empty string, in which case no scanning is done and
33584 the condition fails immediately.
33585 .next
33586 A regular expression, in which case the message is scanned for viruses. The
33587 condition succeeds if a virus is found and its name matches the regular
33588 expression. This allows you to take special actions on certain types of virus.
33589 Note that &"/"& characters in the RE must be doubled due to the list-processing,
33590 unless the separator is changed (in the usual way &<<SECTlistsepchange>>&).
33591 .endlist
33592
33593 You can append a &`defer_ok`& element to the &%malware%& argument list to accept
33594 messages even if there is a problem with the virus scanner.
33595 Otherwise, such a problem causes the ACL to defer.
33596
33597 You can append a &`tmo=<val>`& element to the &%malware%& argument list to
33598 specify a non-default timeout.  The default is two minutes.
33599 For example:
33600 .code
33601 malware = * / defer_ok / tmo=10s
33602 .endd
33603 A timeout causes the ACL to defer.
33604
33605 .vindex "&$callout_address$&"
33606 When a connection is made to the scanner the expansion variable &$callout_address$&
33607 is set to record the actual address used.
33608
33609 .vindex "&$malware_name$&"
33610 When a virus is found, the condition sets up an expansion variable called
33611 &$malware_name$& that contains the name of the virus. You can use it in a
33612 &%message%& modifier that specifies the error returned to the sender, and/or in
33613 logging data.
33614
33615 Beware the interaction of Exim's &%message_size_limit%& with any size limits
33616 imposed by your anti-virus scanner.
33617
33618 Here is a very simple scanning example:
33619 .code
33620 deny malware = *
33621      message = This message contains malware ($malware_name)
33622 .endd
33623 The next example accepts messages when there is a problem with the scanner:
33624 .code
33625 deny malware = */defer_ok
33626      message = This message contains malware ($malware_name)
33627 .endd
33628 The next example shows how to use an ACL variable to scan with both sophie and
33629 aveserver. It assumes you have set:
33630 .code
33631 av_scanner = $acl_m0
33632 .endd
33633 in the main Exim configuration.
33634 .code
33635 deny set acl_m0 = sophie
33636      malware = *
33637      message = This message contains malware ($malware_name)
33638
33639 deny set acl_m0 = aveserver
33640      malware = *
33641      message = This message contains malware ($malware_name)
33642 .endd
33643
33644
33645 .section "Scanning with SpamAssassin and Rspamd" "SECTscanspamass"
33646 .cindex "content scanning" "for spam"
33647 .cindex "spam scanning"
33648 .cindex "SpamAssassin"
33649 .cindex "Rspamd"
33650 The &%spam%& ACL condition calls SpamAssassin's &%spamd%& daemon to get a spam
33651 score and a report for the message.
33652 Support is also provided for Rspamd.
33653
33654 For more information about installation and configuration of SpamAssassin or
33655 Rspamd refer to their respective websites at
33656 &url(https://spamassassin.apache.org/) and &url(https://www.rspamd.com/)
33657
33658 SpamAssassin can be installed with CPAN by running:
33659 .code
33660 perl -MCPAN -e 'install Mail::SpamAssassin'
33661 .endd
33662 SpamAssassin has its own set of configuration files. Please review its
33663 documentation to see how you can tweak it. The default installation should work
33664 nicely, however.
33665
33666 .oindex "&%spamd_address%&"
33667 By default, SpamAssassin listens on 127.0.0.1, TCP port 783 and if you
33668 intend to use an instance running on the local host you do not need to set
33669 &%spamd_address%&. If you intend to use another host or port for SpamAssassin,
33670 you must set the &%spamd_address%& option in the global part of the Exim
33671 configuration as follows (example):
33672 .code
33673 spamd_address = 192.168.99.45 783
33674 .endd
33675 The SpamAssassin protocol relies on a TCP half-close from the client.
33676 If your SpamAssassin client side is running a Linux system with an
33677 iptables firewall, consider setting
33678 &%net.netfilter.nf_conntrack_tcp_timeout_close_wait%& to at least the
33679 timeout, Exim uses when waiting for a response from the SpamAssassin
33680 server (currently defaulting to 120s).  With a lower value the Linux
33681 connection tracking may consider your half-closed connection as dead too
33682 soon.
33683
33684
33685 To use Rspamd (which by default listens on all local addresses
33686 on TCP port 11333)
33687 you should add &%variant=rspamd%& after the address/port pair, for example:
33688 .code
33689 spamd_address = 127.0.0.1 11333 variant=rspamd
33690 .endd
33691
33692 As of version 2.60, &%SpamAssassin%& also supports communication over UNIX
33693 sockets. If you want to us these, supply &%spamd_address%& with an absolute
33694 filename instead of an address/port pair:
33695 .code
33696 spamd_address = /var/run/spamd_socket
33697 .endd
33698 You can have multiple &%spamd%& servers to improve scalability. These can
33699 reside on other hardware reachable over the network. To specify multiple
33700 &%spamd%& servers, put multiple address/port pairs in the &%spamd_address%&
33701 option, separated with colons (the separator can be changed in the usual way &<<SECTlistsepchange>>&):
33702 .code
33703 spamd_address = 192.168.2.10 783 : \
33704                 192.168.2.11 783 : \
33705                 192.168.2.12 783
33706 .endd
33707 Up to 32 &%spamd%& servers are supported.
33708 When a server fails to respond to the connection attempt, all other
33709 servers are tried until one succeeds. If no server responds, the &%spam%&
33710 condition defers.
33711
33712 Unix and TCP socket specifications may be mixed in any order.
33713 Each element of the list is a list itself, space-separated by default
33714 and changeable in the usual way (&<<SECTlistsepchange>>&);
33715 take care to not double the separator.
33716
33717 For TCP socket specifications a host name or IP (v4 or v6, but
33718 subject to list-separator quoting rules) address can be used,
33719 and the port can be one or a dash-separated pair.
33720 In the latter case, the range is tried in strict order.
33721
33722 Elements after the first for Unix sockets, or second for TCP socket,
33723 are options.
33724 The supported options are:
33725 .code
33726 pri=<priority>      Selection priority
33727 weight=<value>      Selection bias
33728 time=<start>-<end>  Use only between these times of day
33729 retry=<timespec>    Retry on connect fail
33730 tmo=<timespec>      Connection time limit
33731 variant=rspamd      Use Rspamd rather than SpamAssassin protocol
33732 .endd
33733
33734 The &`pri`& option specifies a priority for the server within the list,
33735 higher values being tried first.
33736 The default priority is 1.
33737
33738 The &`weight`& option specifies a selection bias.
33739 Within a priority set
33740 servers are queried in a random fashion, weighted by this value.
33741 The default value for selection bias is 1.
33742
33743 Time specifications for the &`time`& option are <hour>.<minute>.<second>
33744 in the local time zone; each element being one or more digits.
33745 Either the seconds or both minutes and seconds, plus the leading &`.`&
33746 characters, may be omitted and will be taken as zero.
33747
33748 Timeout specifications for the &`retry`& and &`tmo`& options
33749 are the usual Exim time interval standard, e.g. &`20s`& or &`1m`&.
33750
33751 The &`tmo`& option specifies an overall timeout for communication.
33752 The default value is two minutes.
33753
33754 The &`retry`& option specifies a time after which a single retry for
33755 a failed connect is made.
33756 The default is to not retry.
33757
33758 The &%spamd_address%& variable is expanded before use if it starts with
33759 a dollar sign. In this case, the expansion may return a string that is
33760 used as the list so that multiple spamd servers can be the result of an
33761 expansion.
33762
33763 .vindex "&$callout_address$&"
33764 When a connection is made to the server the expansion variable &$callout_address$&
33765 is set to record the actual address used.
33766
33767 .section "Calling SpamAssassin from an Exim ACL" "SECID206"
33768 Here is a simple example of the use of the &%spam%& condition in a DATA ACL:
33769 .code
33770 deny spam = joe
33771      message = This message was classified as SPAM
33772 .endd
33773 The right-hand side of the &%spam%& condition specifies a name. This is
33774 relevant if you have set up multiple SpamAssassin profiles. If you do not want
33775 to scan using a specific profile, but rather use the SpamAssassin system-wide
33776 default profile, you can scan for an unknown name, or simply use &"nobody"&.
33777 Rspamd does not use this setting. However, you must put something on the
33778 right-hand side.
33779
33780 The name allows you to use per-domain or per-user antispam profiles in
33781 principle, but this is not straightforward in practice, because a message may
33782 have multiple recipients, not necessarily all in the same domain. Because the
33783 &%spam%& condition has to be called from a DATA-time ACL in order to be able to
33784 read the contents of the message, the variables &$local_part$& and &$domain$&
33785 are not set.
33786 Careful enforcement of single-recipient messages
33787 (e.g. by responding with defer in the recipient ACL for all recipients
33788 after the first),
33789 or the use of PRDR,
33790 .cindex "PRDR" "use for per-user SpamAssassin profiles"
33791 are needed to use this feature.
33792
33793 The right-hand side of the &%spam%& condition is expanded before being used, so
33794 you can put lookups or conditions there. When the right-hand side evaluates to
33795 &"0"& or &"false"&, no scanning is done and the condition fails immediately.
33796
33797
33798 Scanning with SpamAssassin uses a lot of resources. If you scan every message,
33799 large ones may cause significant performance degradation. As most spam messages
33800 are quite small, it is recommended that you do not scan the big ones. For
33801 example:
33802 .code
33803 deny condition = ${if < {$message_size}{10K}}
33804      spam = nobody
33805      message = This message was classified as SPAM
33806 .endd
33807
33808 The &%spam%& condition returns true if the threshold specified in the user's
33809 SpamAssassin profile has been matched or exceeded. If you want to use the
33810 &%spam%& condition for its side effects (see the variables below), you can make
33811 it always return &"true"& by appending &`:true`& to the username.
33812
33813 .cindex "spam scanning" "returned variables"
33814 When the &%spam%& condition is run, it sets up a number of expansion
33815 variables.
33816 Except for &$spam_report$&,
33817 these variables are saved with the received message so are
33818 available for use at delivery time.
33819
33820 .vlist
33821 .vitem &$spam_score$&
33822 The spam score of the message, for example, &"3.4"& or &"30.5"&. This is useful
33823 for inclusion in log or reject messages.
33824
33825 .vitem &$spam_score_int$&
33826 The spam score of the message, multiplied by ten, as an integer value. For
33827 example &"34"& or &"305"&. It may appear to disagree with &$spam_score$&
33828 because &$spam_score$& is rounded and &$spam_score_int$& is truncated.
33829 The integer value is useful for numeric comparisons in conditions.
33830
33831 .vitem &$spam_bar$&
33832 A string consisting of a number of &"+"& or &"-"& characters, representing the
33833 integer part of the spam score value. A spam score of 4.4 would have a
33834 &$spam_bar$& value of &"++++"&. This is useful for inclusion in warning
33835 headers, since MUAs can match on such strings. The maximum length of the
33836 spam bar is 50 characters.
33837
33838 .vitem &$spam_report$&
33839 A multiline text table, containing the full SpamAssassin report for the
33840 message. Useful for inclusion in headers or reject messages.
33841 This variable is only usable in a DATA-time ACL.
33842 Beware that SpamAssassin may return non-ASCII characters, especially
33843 when running in country-specific locales, which are not legal
33844 unencoded in headers.
33845
33846 .vitem &$spam_action$&
33847 For SpamAssassin either 'reject' or 'no action' depending on the
33848 spam score versus threshold.
33849 For Rspamd, the recommended action.
33850
33851 .endlist
33852
33853 The &%spam%& condition caches its results unless expansion in
33854 spamd_address was used. If you call it again with the same user name, it
33855 does not scan again, but rather returns the same values as before.
33856
33857 The &%spam%& condition returns DEFER if there is any error while running
33858 the message through SpamAssassin or if the expansion of spamd_address
33859 failed. If you want to treat DEFER as FAIL (to pass on to the next ACL
33860 statement block), append &`/defer_ok`& to the right-hand side of the
33861 spam condition, like this:
33862 .code
33863 deny spam    = joe/defer_ok
33864      message = This message was classified as SPAM
33865 .endd
33866 This causes messages to be accepted even if there is a problem with &%spamd%&.
33867
33868 Here is a longer, commented example of the use of the &%spam%&
33869 condition:
33870 .code
33871 # put headers in all messages (no matter if spam or not)
33872 warn  spam = nobody:true
33873       add_header = X-Spam-Score: $spam_score ($spam_bar)
33874       add_header = X-Spam-Report: $spam_report
33875
33876 # add second subject line with *SPAM* marker when message
33877 # is over threshold
33878 warn  spam = nobody
33879       add_header = Subject: *SPAM* $h_Subject:
33880
33881 # reject spam at high scores (> 12)
33882 deny  spam = nobody:true
33883       condition = ${if >{$spam_score_int}{120}{1}{0}}
33884       message = This message scored $spam_score spam points.
33885 .endd
33886
33887
33888
33889 .section "Scanning MIME parts" "SECTscanmimepart"
33890 .cindex "content scanning" "MIME parts"
33891 .cindex "MIME content scanning"
33892 .oindex "&%acl_smtp_mime%&"
33893 .oindex "&%acl_not_smtp_mime%&"
33894 The &%acl_smtp_mime%& global option specifies an ACL that is called once for
33895 each MIME part of an SMTP message, including multipart types, in the sequence
33896 of their position in the message. Similarly, the &%acl_not_smtp_mime%& option
33897 specifies an ACL that is used for the MIME parts of non-SMTP messages. These
33898 options may both refer to the same ACL if you want the same processing in both
33899 cases.
33900
33901 These ACLs are called (possibly many times) just before the &%acl_smtp_data%&
33902 ACL in the case of an SMTP message, or just before the &%acl_not_smtp%& ACL in
33903 the case of a non-SMTP message. However, a MIME ACL is called only if the
33904 message contains a &'Content-Type:'& header line. When a call to a MIME
33905 ACL does not yield &"accept"&, ACL processing is aborted and the appropriate
33906 result code is sent to the client. In the case of an SMTP message, the
33907 &%acl_smtp_data%& ACL is not called when this happens.
33908
33909 You cannot use the &%malware%& or &%spam%& conditions in a MIME ACL; these can
33910 only be used in the DATA or non-SMTP ACLs. However, you can use the &%regex%&
33911 condition to match against the raw MIME part. You can also use the
33912 &%mime_regex%& condition to match against the decoded MIME part (see section
33913 &<<SECTscanregex>>&).
33914
33915 At the start of a MIME ACL, a number of variables are set from the header
33916 information for the relevant MIME part. These are described below. The contents
33917 of the MIME part are not by default decoded into a disk file except for MIME
33918 parts whose content-type is &"message/rfc822"&. If you want to decode a MIME
33919 part into a disk file, you can use the &%decode%& condition. The general
33920 syntax is:
33921 .display
33922 &`decode = [/`&<&'path'&>&`/]`&<&'filename'&>
33923 .endd
33924 The right hand side is expanded before use. After expansion,
33925 the value can be:
33926
33927 .olist
33928 &"0"& or &"false"&, in which case no decoding is done.
33929 .next
33930 The string &"default"&. In that case, the file is put in the temporary
33931 &"default"& directory <&'spool_directory'&>&_/scan/_&<&'message_id'&>&_/_& with
33932 a sequential filename consisting of the message id and a sequence number. The
33933 full path and name is available in &$mime_decoded_filename$& after decoding.
33934 .next
33935 A full path name starting with a slash. If the full name is an existing
33936 directory, it is used as a replacement for the default directory. The filename
33937 is then sequentially assigned. If the path does not exist, it is used as
33938 the full path and filename.
33939 .next
33940 If the string does not start with a slash, it is used as the
33941 filename, and the default path is then used.
33942 .endlist
33943 The &%decode%& condition normally succeeds. It is only false for syntax
33944 errors or unusual circumstances such as memory shortages. You can easily decode
33945 a file with its original, proposed filename using
33946 .code
33947 decode = $mime_filename
33948 .endd
33949 However, you should keep in mind that &$mime_filename$& might contain
33950 anything. If you place files outside of the default path, they are not
33951 automatically unlinked.
33952
33953 For RFC822 attachments (these are messages attached to messages, with a
33954 content-type of &"message/rfc822"&), the ACL is called again in the same manner
33955 as for the primary message, only that the &$mime_is_rfc822$& expansion
33956 variable is set (see below). Attached messages are always decoded to disk
33957 before being checked, and the files are unlinked once the check is done.
33958
33959 The MIME ACL supports the &%regex%& and &%mime_regex%& conditions. These can be
33960 used to match regular expressions against raw and decoded MIME parts,
33961 respectively. They are described in section &<<SECTscanregex>>&.
33962
33963 .cindex "MIME content scanning" "returned variables"
33964 The following list describes all expansion variables that are
33965 available in the MIME ACL:
33966
33967 .vlist
33968 .vitem &$mime_anomaly_level$& &&&
33969        &$mime_anomaly_text$&
33970 .vindex &$mime_anomaly_level$&
33971 .vindex &$mime_anomaly_text$&
33972 If there are problems decoding, these variables contain information on
33973 the detected issue.
33974
33975 .vitem &$mime_boundary$&
33976 .vindex &$mime_boundary$&
33977 If the current part is a multipart (see &$mime_is_multipart$& below), it should
33978 have a boundary string, which is stored in this variable. If the current part
33979 has no boundary parameter in the &'Content-Type:'& header, this variable
33980 contains the empty string.
33981
33982 .vitem &$mime_charset$&
33983 .vindex &$mime_charset$&
33984 This variable contains the character set identifier, if one was found in the
33985 &'Content-Type:'& header. Examples for charset identifiers are:
33986 .code
33987 us-ascii
33988 gb2312 (Chinese)
33989 iso-8859-1
33990 .endd
33991 Please note that this value is not normalized, so you should do matches
33992 case-insensitively.
33993
33994 .vitem &$mime_content_description$&
33995 .vindex &$mime_content_description$&
33996 This variable contains the normalized content of the &'Content-Description:'&
33997 header. It can contain a human-readable description of the parts content. Some
33998 implementations repeat the filename for attachments here, but they are usually
33999 only used for display purposes.
34000
34001 .vitem &$mime_content_disposition$&
34002 .vindex &$mime_content_disposition$&
34003 This variable contains the normalized content of the &'Content-Disposition:'&
34004 header. You can expect strings like &"attachment"& or &"inline"& here.
34005
34006 .vitem &$mime_content_id$&
34007 .vindex &$mime_content_id$&
34008 This variable contains the normalized content of the &'Content-ID:'& header.
34009 This is a unique ID that can be used to reference a part from another part.
34010
34011 .vitem &$mime_content_size$&
34012 .vindex &$mime_content_size$&
34013 This variable is set only after the &%decode%& modifier (see above) has been
34014 successfully run. It contains the size of the decoded part in kilobytes. The
34015 size is always rounded up to full kilobytes, so only a completely empty part
34016 has a &$mime_content_size$& of zero.
34017
34018 .vitem &$mime_content_transfer_encoding$&
34019 .vindex &$mime_content_transfer_encoding$&
34020 This variable contains the normalized content of the
34021 &'Content-transfer-encoding:'& header. This is a symbolic name for an encoding
34022 type. Typical values are &"base64"& and &"quoted-printable"&.
34023
34024 .vitem &$mime_content_type$&
34025 .vindex &$mime_content_type$&
34026 If the MIME part has a &'Content-Type:'& header, this variable contains its
34027 value, lowercased, and without any options (like &"name"& or &"charset"&). Here
34028 are some examples of popular MIME types, as they may appear in this variable:
34029 .code
34030 text/plain
34031 text/html
34032 application/octet-stream
34033 image/jpeg
34034 audio/midi
34035 .endd
34036 If the MIME part has no &'Content-Type:'& header, this variable contains the
34037 empty string.
34038
34039 .vitem &$mime_decoded_filename$&
34040 .vindex &$mime_decoded_filename$&
34041 This variable is set only after the &%decode%& modifier (see above) has been
34042 successfully run. It contains the full path and filename of the file
34043 containing the decoded data.
34044 .endlist
34045
34046 .cindex "RFC 2047"
34047 .vlist
34048 .vitem &$mime_filename$&
34049 .vindex &$mime_filename$&
34050 This is perhaps the most important of the MIME variables. It contains a
34051 proposed filename for an attachment, if one was found in either the
34052 &'Content-Type:'& or &'Content-Disposition:'& headers. The filename will be
34053 RFC2047
34054 or RFC2231
34055 decoded, but no additional sanity checks are done.
34056  If no filename was
34057 found, this variable contains the empty string.
34058
34059 .vitem &$mime_is_coverletter$&
34060 .vindex &$mime_is_coverletter$&
34061 This variable attempts to differentiate the &"cover letter"& of an e-mail from
34062 attached data. It can be used to clamp down on flashy or unnecessarily encoded
34063 content in the cover letter, while not restricting attachments at all.
34064
34065 The variable contains 1 (true) for a MIME part believed to be part of the
34066 cover letter, and 0 (false) for an attachment. At present, the algorithm is as
34067 follows:
34068
34069 .olist
34070 The outermost MIME part of a message is always a cover letter.
34071
34072 .next
34073 If a multipart/alternative or multipart/related MIME part is a cover letter,
34074 so are all MIME subparts within that multipart.
34075
34076 .next
34077 If any other multipart is a cover letter, the first subpart is a cover letter,
34078 and the rest are attachments.
34079
34080 .next
34081 All parts contained within an attachment multipart are attachments.
34082 .endlist olist
34083
34084 As an example, the following will ban &"HTML mail"& (including that sent with
34085 alternative plain text), while allowing HTML files to be attached. HTML
34086 coverletter mail attached to non-HTML coverletter mail will also be allowed:
34087 .code
34088 deny !condition = $mime_is_rfc822
34089      condition = $mime_is_coverletter
34090      condition = ${if eq{$mime_content_type}{text/html}{1}{0}}
34091      message = HTML mail is not accepted here
34092 .endd
34093
34094 .vitem &$mime_is_multipart$&
34095 .vindex &$mime_is_multipart$&
34096 This variable has the value 1 (true) when the current part has the main type
34097 &"multipart"&, for example, &"multipart/alternative"& or &"multipart/mixed"&.
34098 Since multipart entities only serve as containers for other parts, you may not
34099 want to carry out specific actions on them.
34100
34101 .vitem &$mime_is_rfc822$&
34102 .vindex &$mime_is_rfc822$&
34103 This variable has the value 1 (true) if the current part is not a part of the
34104 checked message itself, but part of an attached message. Attached message
34105 decoding is fully recursive.
34106
34107 .vitem &$mime_part_count$&
34108 .vindex &$mime_part_count$&
34109 This variable is a counter that is raised for each processed MIME part. It
34110 starts at zero for the very first part (which is usually a multipart). The
34111 counter is per-message, so it is reset when processing RFC822 attachments (see
34112 &$mime_is_rfc822$&). The counter stays set after &%acl_smtp_mime%& is
34113 complete, so you can use it in the DATA ACL to determine the number of MIME
34114 parts of a message. For non-MIME messages, this variable contains the value -1.
34115 .endlist
34116
34117
34118
34119 .section "Scanning with regular expressions" "SECTscanregex"
34120 .cindex "content scanning" "with regular expressions"
34121 .cindex "regular expressions" "content scanning with"
34122 You can specify your own custom regular expression matches on the full body of
34123 the message, or on individual MIME parts.
34124
34125 The &%regex%& condition takes one or more regular expressions as arguments and
34126 matches them against the full message (when called in the DATA ACL) or a raw
34127 MIME part (when called in the MIME ACL). The &%regex%& condition matches
34128 linewise, with a maximum line length of 32K characters. That means you cannot
34129 have multiline matches with the &%regex%& condition.
34130
34131 The &%mime_regex%& condition can be called only in the MIME ACL. It matches up
34132 to 32K of decoded content (the whole content at once, not linewise). If the
34133 part has not been decoded with the &%decode%& modifier earlier in the ACL, it
34134 is decoded automatically when &%mime_regex%& is executed (using default path
34135 and filename values). If the decoded data is larger than  32K, only the first
34136 32K characters are checked.
34137
34138 The regular expressions are passed as a colon-separated list. To include a
34139 literal colon, you must double it. Since the whole right-hand side string is
34140 expanded before being used, you must also escape dollar signs and backslashes
34141 with more backslashes, or use the &`\N`& facility to disable expansion.
34142 Here is a simple example that contains two regular expressions:
34143 .code
34144 deny regex = [Mm]ortgage : URGENT BUSINESS PROPOSAL
34145      message = contains blacklisted regex ($regex_match_string)
34146 .endd
34147 The conditions returns true if any one of the regular expressions matches. The
34148 &$regex_match_string$& expansion variable is then set up and contains the
34149 matching regular expression.
34150 The expansion variables &$regex1$& &$regex2$& etc
34151 are set to any substrings captured by the regular expression.
34152
34153 &*Warning*&: With large messages, these conditions can be fairly
34154 CPU-intensive.
34155
34156 .ecindex IIDcosca
34157
34158
34159
34160
34161 . ////////////////////////////////////////////////////////////////////////////
34162 . ////////////////////////////////////////////////////////////////////////////
34163
34164 .chapter "Adding a local scan function to Exim" "CHAPlocalscan" &&&
34165          "Local scan function"
34166 .scindex IIDlosca "&[local_scan()]& function" "description of"
34167 .cindex "customizing" "input scan using C function"
34168 .cindex "policy control" "by local scan function"
34169 In these days of email worms, viruses, and ever-increasing spam, some sites
34170 want to apply a lot of checking to messages before accepting them.
34171
34172 The content scanning extension (chapter &<<CHAPexiscan>>&) has facilities for
34173 passing messages to external virus and spam scanning software. You can also do
34174 a certain amount in Exim itself through string expansions and the &%condition%&
34175 condition in the ACL that runs after the SMTP DATA command or the ACL for
34176 non-SMTP messages (see chapter &<<CHAPACL>>&), but this has its limitations.
34177
34178 To allow for further customization to a site's own requirements, there is the
34179 possibility of linking Exim with a private message scanning function, written
34180 in C. If you want to run code that is written in something other than C, you
34181 can of course use a little C stub to call it.
34182
34183 The local scan function is run once for every incoming message, at the point
34184 when Exim is just about to accept the message.
34185 It can therefore be used to control non-SMTP messages from local processes as
34186 well as messages arriving via SMTP.
34187
34188 Exim applies a timeout to calls of the local scan function, and there is an
34189 option called &%local_scan_timeout%& for setting it. The default is 5 minutes.
34190 Zero means &"no timeout"&.
34191 Exim also sets up signal handlers for SIGSEGV, SIGILL, SIGFPE, and SIGBUS
34192 before calling the local scan function, so that the most common types of crash
34193 are caught. If the timeout is exceeded or one of those signals is caught, the
34194 incoming message is rejected with a temporary error if it is an SMTP message.
34195 For a non-SMTP message, the message is dropped and Exim ends with a non-zero
34196 code. The incident is logged on the main and reject logs.
34197
34198
34199
34200 .section "Building Exim to use a local scan function" "SECID207"
34201 .cindex "&[local_scan()]& function" "building Exim to use"
34202 To make use of the local scan function feature, you must tell Exim where your
34203 function is before building Exim, by setting
34204 both HAVE_LOCAL_SCAN and
34205 LOCAL_SCAN_SOURCE in your
34206 &_Local/Makefile_&. A recommended place to put it is in the &_Local_&
34207 directory, so you might set
34208 .code
34209 HAVE_LOCAL_SCAN=yes
34210 LOCAL_SCAN_SOURCE=Local/local_scan.c
34211 .endd
34212 for example. The function must be called &[local_scan()]&;
34213 .new
34214 the source file(s) for it should first #define LOCAL_SCAN
34215 and then #include "local_scan.h".
34216 .wen
34217 It is called by
34218 Exim after it has received a message, when the success return code is about to
34219 be sent. This is after all the ACLs have been run. The return code from your
34220 function controls whether the message is actually accepted or not. There is a
34221 commented template function (that just accepts the message) in the file
34222 _src/local_scan.c_.
34223
34224 If you want to make use of Exim's runtime configuration file to set options
34225 for your &[local_scan()]& function, you must also set
34226 .code
34227 LOCAL_SCAN_HAS_OPTIONS=yes
34228 .endd
34229 in &_Local/Makefile_& (see section &<<SECTconoptloc>>& below).
34230
34231
34232
34233
34234 .section "API for local_scan()" "SECTapiforloc"
34235 .cindex "&[local_scan()]& function" "API description"
34236 .cindex &%dlfunc%& "API description"
34237 You must include this line near the start of your code:
34238 .code
34239 #define LOCAL_SCAN
34240 #include "local_scan.h"
34241 .endd
34242 This header file defines a number of variables and other values, and the
34243 prototype for the function itself. Exim is coded to use unsigned char values
34244 almost exclusively, and one of the things this header defines is a shorthand
34245 for &`unsigned char`& called &`uschar`&.
34246 It also makes available the following macro definitions, to simplify casting character
34247 strings and pointers to character strings:
34248 .code
34249 #define CS   (char *)
34250 #define CCS  (const char *)
34251 #define CSS  (char **)
34252 #define US   (unsigned char *)
34253 #define CUS  (const unsigned char *)
34254 #define USS  (unsigned char **)
34255 .endd
34256 The function prototype for &[local_scan()]& is:
34257 .code
34258 extern int local_scan(int fd, uschar **return_text);
34259 .endd
34260 The arguments are as follows:
34261
34262 .ilist
34263 &%fd%& is a file descriptor for the file that contains the body of the message
34264 (the -D file). The file is open for reading and writing, but updating it is not
34265 recommended. &*Warning*&: You must &'not'& close this file descriptor.
34266
34267 The descriptor is positioned at character 19 of the file, which is the first
34268 character of the body itself, because the first 19 characters are the message
34269 id followed by &`-D`& and a newline. If you rewind the file, you should use the
34270 macro SPOOL_DATA_START_OFFSET to reset to the start of the data, just in
34271 case this changes in some future version.
34272 .next
34273 &%return_text%& is an address which you can use to return a pointer to a text
34274 string at the end of the function. The value it points to on entry is NULL.
34275 .endlist
34276
34277 The function must return an &%int%& value which is one of the following macros:
34278
34279 .vlist
34280 .vitem &`LOCAL_SCAN_ACCEPT`&
34281 .vindex "&$local_scan_data$&"
34282 The message is accepted. If you pass back a string of text, it is saved with
34283 the message, and made available in the variable &$local_scan_data$&. No
34284 newlines are permitted (if there are any, they are turned into spaces) and the
34285 maximum length of text is 1000 characters.
34286
34287 .vitem &`LOCAL_SCAN_ACCEPT_FREEZE`&
34288 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
34289 queued without immediate delivery, and is frozen.
34290
34291 .vitem &`LOCAL_SCAN_ACCEPT_QUEUE`&
34292 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
34293 queued without immediate delivery.
34294
34295 .vitem &`LOCAL_SCAN_REJECT`&
34296 The message is rejected; the returned text is used as an error message which is
34297 passed back to the sender and which is also logged. Newlines are permitted &--
34298 they cause a multiline response for SMTP rejections, but are converted to
34299 &`\n`& in log lines. If no message is given, &"Administrative prohibition"& is
34300 used.
34301
34302 .vitem &`LOCAL_SCAN_TEMPREJECT`&
34303 The message is temporarily rejected; the returned text is used as an error
34304 message as for LOCAL_SCAN_REJECT. If no message is given, &"Temporary local
34305 problem"& is used.
34306
34307 .vitem &`LOCAL_SCAN_REJECT_NOLOGHDR`&
34308 This behaves as LOCAL_SCAN_REJECT, except that the header of the rejected
34309 message is not written to the reject log. It has the effect of unsetting the
34310 &%rejected_header%& log selector for just this rejection. If
34311 &%rejected_header%& is already unset (see the discussion of the
34312 &%log_selection%& option in section &<<SECTlogselector>>&), this code is the
34313 same as LOCAL_SCAN_REJECT.
34314
34315 .vitem &`LOCAL_SCAN_TEMPREJECT_NOLOGHDR`&
34316 This code is a variation of LOCAL_SCAN_TEMPREJECT in the same way that
34317 LOCAL_SCAN_REJECT_NOLOGHDR is a variation of LOCAL_SCAN_REJECT.
34318 .endlist
34319
34320 If the message is not being received by interactive SMTP, rejections are
34321 reported by writing to &%stderr%& or by sending an email, as configured by the
34322 &%-oe%& command line options.
34323
34324
34325
34326 .section "Configuration options for local_scan()" "SECTconoptloc"
34327 .cindex "&[local_scan()]& function" "configuration options"
34328 It is possible to have option settings in the main configuration file
34329 that set values in static variables in the &[local_scan()]& module. If you
34330 want to do this, you must have the line
34331 .code
34332 LOCAL_SCAN_HAS_OPTIONS=yes
34333 .endd
34334 in your &_Local/Makefile_& when you build Exim. (This line is in
34335 &_OS/Makefile-Default_&, commented out). Then, in the &[local_scan()]& source
34336 file, you must define static variables to hold the option values, and a table
34337 to define them.
34338
34339 The table must be a vector called &%local_scan_options%&, of type
34340 &`optionlist`&. Each entry is a triplet, consisting of a name, an option type,
34341 and a pointer to the variable that holds the value. The entries must appear in
34342 alphabetical order. Following &%local_scan_options%& you must also define a
34343 variable called &%local_scan_options_count%& that contains the number of
34344 entries in the table. Here is a short example, showing two kinds of option:
34345 .code
34346 static int my_integer_option = 42;
34347 static uschar *my_string_option = US"a default string";
34348
34349 optionlist local_scan_options[] = {
34350   { "my_integer", opt_int,       &my_integer_option },
34351   { "my_string",  opt_stringptr, &my_string_option }
34352 };
34353
34354 int local_scan_options_count =
34355   sizeof(local_scan_options)/sizeof(optionlist);
34356 .endd
34357 The values of the variables can now be changed from Exim's runtime
34358 configuration file by including a local scan section as in this example:
34359 .code
34360 begin local_scan
34361 my_integer = 99
34362 my_string = some string of text...
34363 .endd
34364 The available types of option data are as follows:
34365
34366 .vlist
34367 .vitem &*opt_bool*&
34368 This specifies a boolean (true/false) option. The address should point to a
34369 variable of type &`BOOL`&, which will be set to TRUE or FALSE, which are macros
34370 that are defined as &"1"& and &"0"&, respectively. If you want to detect
34371 whether such a variable has been set at all, you can initialize it to
34372 TRUE_UNSET. (BOOL variables are integers underneath, so can hold more than two
34373 values.)
34374
34375 .vitem &*opt_fixed*&
34376 This specifies a fixed point number, such as is used for load averages.
34377 The address should point to a variable of type &`int`&. The value is stored
34378 multiplied by 1000, so, for example, 1.4142 is truncated and stored as 1414.
34379
34380 .vitem &*opt_int*&
34381 This specifies an integer; the address should point to a variable of type
34382 &`int`&. The value may be specified in any of the integer formats accepted by
34383 Exim.
34384
34385 .vitem &*opt_mkint*&
34386 This is the same as &%opt_int%&, except that when such a value is output in a
34387 &%-bP%& listing, if it is an exact number of kilobytes or megabytes, it is
34388 printed with the suffix K or M.
34389
34390 .vitem &*opt_octint*&
34391 This also specifies an integer, but the value is always interpreted as an
34392 octal integer, whether or not it starts with the digit zero, and it is
34393 always output in octal.
34394
34395 .vitem &*opt_stringptr*&
34396 This specifies a string value; the address must be a pointer to a
34397 variable that points to a string (for example, of type &`uschar *`&).
34398
34399 .vitem &*opt_time*&
34400 This specifies a time interval value. The address must point to a variable of
34401 type &`int`&. The value that is placed there is a number of seconds.
34402 .endlist
34403
34404 If the &%-bP%& command line option is followed by &`local_scan`&, Exim prints
34405 out the values of all the &[local_scan()]& options.
34406
34407
34408
34409 .section "Available Exim variables" "SECID208"
34410 .cindex "&[local_scan()]& function" "available Exim variables"
34411 The header &_local_scan.h_& gives you access to a number of C variables. These
34412 are the only ones that are guaranteed to be maintained from release to release.
34413 Note, however, that you can obtain the value of any Exim expansion variable,
34414 including &$recipients$&, by calling &'expand_string()'&. The exported
34415 C variables are as follows:
34416
34417 .vlist
34418 .vitem &*int&~body_linecount*&
34419 This variable contains the number of lines in the message's body.
34420 It is not valid if the &%spool_files_wireformat%& option is used.
34421
34422 .vitem &*int&~body_zerocount*&
34423 This variable contains the number of binary zero bytes in the message's body.
34424 It is not valid if the &%spool_files_wireformat%& option is used.
34425
34426 .vitem &*unsigned&~int&~debug_selector*&
34427 This variable is set to zero when no debugging is taking place. Otherwise, it
34428 is a bitmap of debugging selectors. Two bits are identified for use in
34429 &[local_scan()]&; they are defined as macros:
34430
34431 .ilist
34432 The &`D_v`& bit is set when &%-v%& was present on the command line. This is a
34433 testing option that is not privileged &-- any caller may set it. All the
34434 other selector bits can be set only by admin users.
34435
34436 .next
34437 The &`D_local_scan`& bit is provided for use by &[local_scan()]&; it is set
34438 by the &`+local_scan`& debug selector. It is not included in the default set
34439 of debugging bits.
34440 .endlist ilist
34441
34442 Thus, to write to the debugging output only when &`+local_scan`& has been
34443 selected, you should use code like this:
34444 .code
34445 if ((debug_selector & D_local_scan) != 0)
34446   debug_printf("xxx", ...);
34447 .endd
34448 .vitem &*uschar&~*expand_string_message*&
34449 After a failing call to &'expand_string()'& (returned value NULL), the
34450 variable &%expand_string_message%& contains the error message, zero-terminated.
34451
34452 .vitem &*header_line&~*header_list*&
34453 A pointer to a chain of header lines. The &%header_line%& structure is
34454 discussed below.
34455
34456 .vitem &*header_line&~*header_last*&
34457 A pointer to the last of the header lines.
34458
34459 .vitem &*uschar&~*headers_charset*&
34460 The value of the &%headers_charset%& configuration option.
34461
34462 .vitem &*BOOL&~host_checking*&
34463 This variable is TRUE during a host checking session that is initiated by the
34464 &%-bh%& command line option.
34465
34466 .vitem &*uschar&~*interface_address*&
34467 The IP address of the interface that received the message, as a string. This
34468 is NULL for locally submitted messages.
34469
34470 .vitem &*int&~interface_port*&
34471 The port on which this message was received. When testing with the &%-bh%&
34472 command line option, the value of this variable is -1 unless a port has been
34473 specified via the &%-oMi%& option.
34474
34475 .vitem &*uschar&~*message_id*&
34476 This variable contains Exim's message id for the incoming message (the value of
34477 &$message_exim_id$&) as a zero-terminated string.
34478
34479 .vitem &*uschar&~*received_protocol*&
34480 The name of the protocol by which the message was received.
34481
34482 .vitem &*int&~recipients_count*&
34483 The number of accepted recipients.
34484
34485 .vitem &*recipient_item&~*recipients_list*&
34486 .cindex "recipient" "adding in local scan"
34487 .cindex "recipient" "removing in local scan"
34488 The list of accepted recipients, held in a vector of length
34489 &%recipients_count%&. The &%recipient_item%& structure is discussed below. You
34490 can add additional recipients by calling &'receive_add_recipient()'& (see
34491 below). You can delete recipients by removing them from the vector and
34492 adjusting the value in &%recipients_count%&. In particular, by setting
34493 &%recipients_count%& to zero you remove all recipients. If you then return the
34494 value &`LOCAL_SCAN_ACCEPT`&, the message is accepted, but immediately
34495 blackholed. To replace the recipients, you can set &%recipients_count%& to zero
34496 and then call &'receive_add_recipient()'& as often as needed.
34497
34498 .vitem &*uschar&~*sender_address*&
34499 The envelope sender address. For bounce messages this is the empty string.
34500
34501 .vitem &*uschar&~*sender_host_address*&
34502 The IP address of the sending host, as a string. This is NULL for
34503 locally-submitted messages.
34504
34505 .vitem &*uschar&~*sender_host_authenticated*&
34506 The name of the authentication mechanism that was used, or NULL if the message
34507 was not received over an authenticated SMTP connection.
34508
34509 .vitem &*uschar&~*sender_host_name*&
34510 The name of the sending host, if known.
34511
34512 .vitem &*int&~sender_host_port*&
34513 The port on the sending host.
34514
34515 .vitem &*BOOL&~smtp_input*&
34516 This variable is TRUE for all SMTP input, including BSMTP.
34517
34518 .vitem &*BOOL&~smtp_batched_input*&
34519 This variable is TRUE for BSMTP input.
34520
34521 .vitem &*int&~store_pool*&
34522 The contents of this variable control which pool of memory is used for new
34523 requests. See section &<<SECTmemhanloc>>& for details.
34524 .endlist
34525
34526
34527 .section "Structure of header lines" "SECID209"
34528 The &%header_line%& structure contains the members listed below.
34529 You can add additional header lines by calling the &'header_add()'& function
34530 (see below). You can cause header lines to be ignored (deleted) by setting
34531 their type to *.
34532
34533
34534 .vlist
34535 .vitem &*struct&~header_line&~*next*&
34536 A pointer to the next header line, or NULL for the last line.
34537
34538 .vitem &*int&~type*&
34539 A code identifying certain headers that Exim recognizes. The codes are printing
34540 characters, and are documented in chapter &<<CHAPspool>>& of this manual.
34541 Notice in particular that any header line whose type is * is not transmitted
34542 with the message. This flagging is used for header lines that have been
34543 rewritten, or are to be removed (for example, &'Envelope-sender:'& header
34544 lines.) Effectively, * means &"deleted"&.
34545
34546 .vitem &*int&~slen*&
34547 The number of characters in the header line, including the terminating and any
34548 internal newlines.
34549
34550 .vitem &*uschar&~*text*&
34551 A pointer to the text of the header. It always ends with a newline, followed by
34552 a zero byte. Internal newlines are preserved.
34553 .endlist
34554
34555
34556
34557 .section "Structure of recipient items" "SECID210"
34558 The &%recipient_item%& structure contains these members:
34559
34560 .vlist
34561 .vitem &*uschar&~*address*&
34562 This is a pointer to the recipient address as it was received.
34563
34564 .vitem &*int&~pno*&
34565 This is used in later Exim processing when top level addresses are created by
34566 the &%one_time%& option. It is not relevant at the time &[local_scan()]& is run
34567 and must always contain -1 at this stage.
34568
34569 .vitem &*uschar&~*errors_to*&
34570 If this value is not NULL, bounce messages caused by failing to deliver to the
34571 recipient are sent to the address it contains. In other words, it overrides the
34572 envelope sender for this one recipient. (Compare the &%errors_to%& generic
34573 router option.) If a &[local_scan()]& function sets an &%errors_to%& field to
34574 an unqualified address, Exim qualifies it using the domain from
34575 &%qualify_recipient%&. When &[local_scan()]& is called, the &%errors_to%& field
34576 is NULL for all recipients.
34577 .endlist
34578
34579
34580
34581 .section "Available Exim functions" "SECID211"
34582 .cindex "&[local_scan()]& function" "available Exim functions"
34583 The header &_local_scan.h_& gives you access to a number of Exim functions.
34584 These are the only ones that are guaranteed to be maintained from release to
34585 release:
34586
34587 .vlist
34588 .vitem "&*pid_t&~child_open(uschar&~**argv,&~uschar&~**envp,&~int&~newumask,&&&
34589        &~int&~*infdptr,&~int&~*outfdptr, &~&~BOOL&~make_leader)*&"
34590
34591 This function creates a child process that runs the command specified by
34592 &%argv%&. The environment for the process is specified by &%envp%&, which can
34593 be NULL if no environment variables are to be passed. A new umask is supplied
34594 for the process in &%newumask%&.
34595
34596 Pipes to the standard input and output of the new process are set up
34597 and returned to the caller via the &%infdptr%& and &%outfdptr%& arguments. The
34598 standard error is cloned to the standard output. If there are any file
34599 descriptors &"in the way"& in the new process, they are closed. If the final
34600 argument is TRUE, the new process is made into a process group leader.
34601
34602 The function returns the pid of the new process, or -1 if things go wrong.
34603
34604 .vitem &*int&~child_close(pid_t&~pid,&~int&~timeout)*&
34605 This function waits for a child process to terminate, or for a timeout (in
34606 seconds) to expire. A timeout value of zero means wait as long as it takes. The
34607 return value is as follows:
34608
34609 .ilist
34610 >= 0
34611
34612 The process terminated by a normal exit and the value is the process
34613 ending status.
34614
34615 .next
34616 < 0 and > &--256
34617
34618 The process was terminated by a signal and the value is the negation of the
34619 signal number.
34620
34621 .next
34622 &--256
34623
34624 The process timed out.
34625 .next
34626 &--257
34627
34628 The was some other error in wait(); &%errno%& is still set.
34629 .endlist
34630
34631 .vitem &*pid_t&~child_open_exim(int&~*fd)*&
34632 This function provide you with a means of submitting a new message to
34633 Exim. (Of course, you can also call &_/usr/sbin/sendmail_& yourself if you
34634 want, but this packages it all up for you.) The function creates a pipe,
34635 forks a subprocess that is running
34636 .code
34637 exim -t -oem -oi -f <>
34638 .endd
34639 and returns to you (via the &`int *`& argument) a file descriptor for the pipe
34640 that is connected to the standard input. The yield of the function is the PID
34641 of the subprocess. You can then write a message to the file descriptor, with
34642 recipients in &'To:'&, &'Cc:'&, and/or &'Bcc:'& header lines.
34643
34644 When you have finished, call &'child_close()'& to wait for the process to
34645 finish and to collect its ending status. A timeout value of zero is usually
34646 fine in this circumstance. Unless you have made a mistake with the recipient
34647 addresses, you should get a return code of zero.
34648
34649
34650 .vitem &*pid_t&~child_open_exim2(int&~*fd,&~uschar&~*sender,&~uschar&~&&&
34651        *sender_authentication)*&
34652 This function is a more sophisticated version of &'child_open()'&. The command
34653 that it runs is:
34654 .display
34655 &`exim -t -oem -oi -f `&&'sender'&&` -oMas `&&'sender_authentication'&
34656 .endd
34657 The third argument may be NULL, in which case the &%-oMas%& option is omitted.
34658
34659
34660 .vitem &*void&~debug_printf(char&~*,&~...)*&
34661 This is Exim's debugging function, with arguments as for &'(printf()'&. The
34662 output is written to the standard error stream. If no debugging is selected,
34663 calls to &'debug_printf()'& have no effect. Normally, you should make calls
34664 conditional on the &`local_scan`& debug selector by coding like this:
34665 .code
34666 if ((debug_selector & D_local_scan) != 0)
34667   debug_printf("xxx", ...);
34668 .endd
34669
34670 .vitem &*uschar&~*expand_string(uschar&~*string)*&
34671 This is an interface to Exim's string expansion code. The return value is the
34672 expanded string, or NULL if there was an expansion failure.
34673 The C variable &%expand_string_message%& contains an error message after an
34674 expansion failure. If expansion does not change the string, the return value is
34675 the pointer to the input string. Otherwise, the return value points to a new
34676 block of memory that was obtained by a call to &'store_get()'&. See section
34677 &<<SECTmemhanloc>>& below for a discussion of memory handling.
34678
34679 .vitem &*void&~header_add(int&~type,&~char&~*format,&~...)*&
34680 This function allows you to an add additional header line at the end of the
34681 existing ones. The first argument is the type, and should normally be a space
34682 character. The second argument is a format string and any number of
34683 substitution arguments as for &[sprintf()]&. You may include internal newlines
34684 if you want, and you must ensure that the string ends with a newline.
34685
34686 .vitem "&*void&~header_add_at_position(BOOL&~after,&~uschar&~*name,&~&&&
34687         BOOL&~topnot,&~int&~type,&~char&~*format, &~&~...)*&"
34688 This function adds a new header line at a specified point in the header
34689 chain. The header itself is specified as for &'header_add()'&.
34690
34691 If &%name%& is NULL, the new header is added at the end of the chain if
34692 &%after%& is true, or at the start if &%after%& is false. If &%name%& is not
34693 NULL, the header lines are searched for the first non-deleted header that
34694 matches the name. If one is found, the new header is added before it if
34695 &%after%& is false. If &%after%& is true, the new header is added after the
34696 found header and any adjacent subsequent ones with the same name (even if
34697 marked &"deleted"&). If no matching non-deleted header is found, the &%topnot%&
34698 option controls where the header is added. If it is true, addition is at the
34699 top; otherwise at the bottom. Thus, to add a header after all the &'Received:'&
34700 headers, or at the top if there are no &'Received:'& headers, you could use
34701 .code
34702 header_add_at_position(TRUE, US"Received", TRUE,
34703   ' ', "X-xxx: ...");
34704 .endd
34705 Normally, there is always at least one non-deleted &'Received:'& header, but
34706 there may not be if &%received_header_text%& expands to an empty string.
34707
34708
34709 .vitem &*void&~header_remove(int&~occurrence,&~uschar&~*name)*&
34710 This function removes header lines. If &%occurrence%& is zero or negative, all
34711 occurrences of the header are removed. If occurrence is greater than zero, that
34712 particular instance of the header is removed. If no header(s) can be found that
34713 match the specification, the function does nothing.
34714
34715
34716 .vitem "&*BOOL&~header_testname(header_line&~*hdr,&~uschar&~*name,&~&&&
34717         int&~length,&~BOOL&~notdel)*&"
34718 This function tests whether the given header has the given name. It is not just
34719 a string comparison, because white space is permitted between the name and the
34720 colon. If the &%notdel%& argument is true, a false return is forced for all
34721 &"deleted"& headers; otherwise they are not treated specially. For example:
34722 .code
34723 if (header_testname(h, US"X-Spam", 6, TRUE)) ...
34724 .endd
34725 .vitem &*uschar&~*lss_b64encode(uschar&~*cleartext,&~int&~length)*&
34726 .cindex "base64 encoding" "functions for &[local_scan()]& use"
34727 This function base64-encodes a string, which is passed by address and length.
34728 The text may contain bytes of any value, including zero. The result is passed
34729 back in dynamic memory that is obtained by calling &'store_get()'&. It is
34730 zero-terminated.
34731
34732 .vitem &*int&~lss_b64decode(uschar&~*codetext,&~uschar&~**cleartext)*&
34733 This function decodes a base64-encoded string. Its arguments are a
34734 zero-terminated base64-encoded string and the address of a variable that is set
34735 to point to the result, which is in dynamic memory. The length of the decoded
34736 string is the yield of the function. If the input is invalid base64 data, the
34737 yield is -1. A zero byte is added to the end of the output string to make it
34738 easy to interpret as a C string (assuming it contains no zeros of its own). The
34739 added zero byte is not included in the returned count.
34740
34741 .vitem &*int&~lss_match_domain(uschar&~*domain,&~uschar&~*list)*&
34742 This function checks for a match in a domain list. Domains are always
34743 matched caselessly. The return value is one of the following:
34744 .display
34745 &`OK     `& match succeeded
34746 &`FAIL   `& match failed
34747 &`DEFER  `& match deferred
34748 .endd
34749 DEFER is usually caused by some kind of lookup defer, such as the
34750 inability to contact a database.
34751
34752 .vitem "&*int&~lss_match_local_part(uschar&~*localpart,&~uschar&~*list,&~&&&
34753         BOOL&~caseless)*&"
34754 This function checks for a match in a local part list. The third argument
34755 controls case-sensitivity. The return values are as for
34756 &'lss_match_domain()'&.
34757
34758 .vitem "&*int&~lss_match_address(uschar&~*address,&~uschar&~*list,&~&&&
34759         BOOL&~caseless)*&"
34760 This function checks for a match in an address list. The third argument
34761 controls the case-sensitivity of the local part match. The domain is always
34762 matched caselessly. The return values are as for &'lss_match_domain()'&.
34763
34764 .vitem "&*int&~lss_match_host(uschar&~*host_name,&~uschar&~*host_address,&~&&&
34765         uschar&~*list)*&"
34766 This function checks for a match in a host list. The most common usage is
34767 expected to be
34768 .code
34769 lss_match_host(sender_host_name, sender_host_address, ...)
34770 .endd
34771 .vindex "&$sender_host_address$&"
34772 An empty address field matches an empty item in the host list. If the host name
34773 is NULL, the name corresponding to &$sender_host_address$& is automatically
34774 looked up if a host name is required to match an item in the list. The return
34775 values are as for &'lss_match_domain()'&, but in addition, &'lss_match_host()'&
34776 returns ERROR in the case when it had to look up a host name, but the lookup
34777 failed.
34778
34779 .vitem "&*void&~log_write(unsigned&~int&~selector,&~int&~which,&~char&~&&&
34780         *format,&~...)*&"
34781 This function writes to Exim's log files. The first argument should be zero (it
34782 is concerned with &%log_selector%&). The second argument can be &`LOG_MAIN`& or
34783 &`LOG_REJECT`& or &`LOG_PANIC`& or the inclusive &"or"& of any combination of
34784 them. It specifies to which log or logs the message is written. The remaining
34785 arguments are a format and relevant insertion arguments. The string should not
34786 contain any newlines, not even at the end.
34787
34788
34789 .vitem &*void&~receive_add_recipient(uschar&~*address,&~int&~pno)*&
34790 This function adds an additional recipient to the message. The first argument
34791 is the recipient address. If it is unqualified (has no domain), it is qualified
34792 with the &%qualify_recipient%& domain. The second argument must always be -1.
34793
34794 This function does not allow you to specify a private &%errors_to%& address (as
34795 described with the structure of &%recipient_item%& above), because it pre-dates
34796 the addition of that field to the structure. However, it is easy to add such a
34797 value afterwards. For example:
34798 .code
34799  receive_add_recipient(US"monitor@mydom.example", -1);
34800  recipients_list[recipients_count-1].errors_to =
34801    US"postmaster@mydom.example";
34802 .endd
34803
34804 .vitem &*BOOL&~receive_remove_recipient(uschar&~*recipient)*&
34805 This is a convenience function to remove a named recipient from the list of
34806 recipients. It returns true if a recipient was removed, and false if no
34807 matching recipient could be found. The argument must be a complete email
34808 address.
34809 .endlist
34810
34811
34812 .cindex "RFC 2047"
34813 .vlist
34814 .vitem "&*uschar&~rfc2047_decode(uschar&~*string,&~BOOL&~lencheck,&&&
34815   &~uschar&~*target,&~int&~zeroval,&~int&~*lenptr, &~&~uschar&~**error)*&"
34816 This function decodes strings that are encoded according to RFC 2047. Typically
34817 these are the contents of header lines. First, each &"encoded word"& is decoded
34818 from the Q or B encoding into a byte-string. Then, if provided with the name of
34819 a charset encoding, and if the &[iconv()]& function is available, an attempt is
34820 made  to translate the result to the named character set. If this fails, the
34821 binary string is returned with an error message.
34822
34823 The first argument is the string to be decoded. If &%lencheck%& is TRUE, the
34824 maximum MIME word length is enforced. The third argument is the target
34825 encoding, or NULL if no translation is wanted.
34826
34827 .cindex "binary zero" "in RFC 2047 decoding"
34828 .cindex "RFC 2047" "binary zero in"
34829 If a binary zero is encountered in the decoded string, it is replaced by the
34830 contents of the &%zeroval%& argument. For use with Exim headers, the value must
34831 not be 0 because header lines are handled as zero-terminated strings.
34832
34833 The function returns the result of processing the string, zero-terminated; if
34834 &%lenptr%& is not NULL, the length of the result is set in the variable to
34835 which it points. When &%zeroval%& is 0, &%lenptr%& should not be NULL.
34836
34837 If an error is encountered, the function returns NULL and uses the &%error%&
34838 argument to return an error message. The variable pointed to by &%error%& is
34839 set to NULL if there is no error; it may be set non-NULL even when the function
34840 returns a non-NULL value if decoding was successful, but there was a problem
34841 with translation.
34842
34843
34844 .vitem &*int&~smtp_fflush(void)*&
34845 This function is used in conjunction with &'smtp_printf()'&, as described
34846 below.
34847
34848 .vitem &*void&~smtp_printf(char&~*,BOOL,&~...)*&
34849 The arguments of this function are almost like &[printf()]&; it writes to the SMTP
34850 output stream. You should use this function only when there is an SMTP output
34851 stream, that is, when the incoming message is being received via interactive
34852 SMTP. This is the case when &%smtp_input%& is TRUE and &%smtp_batched_input%&
34853 is FALSE. If you want to test for an incoming message from another host (as
34854 opposed to a local process that used the &%-bs%& command line option), you can
34855 test the value of &%sender_host_address%&, which is non-NULL when a remote host
34856 is involved.
34857
34858 If an SMTP TLS connection is established, &'smtp_printf()'& uses the TLS
34859 output function, so it can be used for all forms of SMTP connection.
34860
34861 The second argument is used to request that the data be buffered
34862 (when TRUE) or flushed (along with any previously buffered, when FALSE).
34863 This is advisory only, but likely to save on system-calls and packets
34864 sent when a sequence of calls to the function are made.
34865
34866 The argument was added in Exim version 4.90 - changing the API/ABI.
34867 Nobody noticed until 4.93 was imminent, at which point the
34868 ABI version number was incremented.
34869
34870 Strings that are written by &'smtp_printf()'& from within &[local_scan()]&
34871 must start with an appropriate response code: 550 if you are going to return
34872 LOCAL_SCAN_REJECT, 451 if you are going to return
34873 LOCAL_SCAN_TEMPREJECT, and 250 otherwise. Because you are writing the
34874 initial lines of a multi-line response, the code must be followed by a hyphen
34875 to indicate that the line is not the final response line. You must also ensure
34876 that the lines you write terminate with CRLF. For example:
34877 .code
34878 smtp_printf("550-this is some extra info\r\n");
34879 return LOCAL_SCAN_REJECT;
34880 .endd
34881 Note that you can also create multi-line responses by including newlines in
34882 the data returned via the &%return_text%& argument. The added value of using
34883 &'smtp_printf()'& is that, for instance, you could introduce delays between
34884 multiple output lines.
34885
34886 The &'smtp_printf()'& function does not return any error indication, because it
34887 does not
34888 guarantee a flush of
34889 pending output, and therefore does not test
34890 the state of the stream. (In the main code of Exim, flushing and error
34891 detection is done when Exim is ready for the next SMTP input command.) If
34892 you want to flush the output and check for an error (for example, the
34893 dropping of a TCP/IP connection), you can call &'smtp_fflush()'&, which has no
34894 arguments. It flushes the output stream, and returns a non-zero value if there
34895 is an error.
34896
34897 .new
34898 .vitem &*void&~*store_get(int,BOOL)*&
34899 This function accesses Exim's internal store (memory) manager. It gets a new
34900 chunk of memory whose size is given by the first argument.
34901 The second argument should be given as TRUE if the memory will be used for
34902 data possibly coming from an attacker (eg. the message content),
34903 FALSE if it is locally-sourced.
34904 Exim bombs out if it ever
34905 runs out of memory. See the next section for a discussion of memory handling.
34906 .wen
34907
34908 .vitem &*void&~*store_get_perm(int,BOOL)*&
34909 This function is like &'store_get()'&, but it always gets memory from the
34910 permanent pool. See the next section for a discussion of memory handling.
34911
34912 .vitem &*uschar&~*string_copy(uschar&~*string)*&
34913 See below.
34914
34915 .vitem &*uschar&~*string_copyn(uschar&~*string,&~int&~length)*&
34916 See below.
34917
34918 .vitem &*uschar&~*string_sprintf(char&~*format,&~...)*&
34919 These three functions create strings using Exim's dynamic memory facilities.
34920 The first makes a copy of an entire string. The second copies up to a maximum
34921 number of characters, indicated by the second argument. The third uses a format
34922 and insertion arguments to create a new string. In each case, the result is a
34923 pointer to a new string in the current memory pool. See the next section for
34924 more discussion.
34925 .endlist
34926
34927
34928
34929 .section "More about Exim's memory handling" "SECTmemhanloc"
34930 .cindex "&[local_scan()]& function" "memory handling"
34931 No function is provided for freeing memory, because that is never needed.
34932 The dynamic memory that Exim uses when receiving a message is automatically
34933 recycled if another message is received by the same process (this applies only
34934 to incoming SMTP connections &-- other input methods can supply only one
34935 message at a time). After receiving the last message, a reception process
34936 terminates.
34937
34938 Because it is recycled, the normal dynamic memory cannot be used for holding
34939 data that must be preserved over a number of incoming messages on the same SMTP
34940 connection. However, Exim in fact uses two pools of dynamic memory; the second
34941 one is not recycled, and can be used for this purpose.
34942
34943 If you want to allocate memory that remains available for subsequent messages
34944 in the same SMTP connection, you should set
34945 .code
34946 store_pool = POOL_PERM
34947 .endd
34948 before calling the function that does the allocation. There is no need to
34949 restore the value if you do not need to; however, if you do want to revert to
34950 the normal pool, you can either restore the previous value of &%store_pool%& or
34951 set it explicitly to POOL_MAIN.
34952
34953 The pool setting applies to all functions that get dynamic memory, including
34954 &'expand_string()'&, &'store_get()'&, and the &'string_xxx()'& functions.
34955 There is also a convenience function called &'store_get_perm()'& that gets a
34956 block of memory from the permanent pool while preserving the value of
34957 &%store_pool%&.
34958 .ecindex IIDlosca
34959
34960
34961
34962
34963 . ////////////////////////////////////////////////////////////////////////////
34964 . ////////////////////////////////////////////////////////////////////////////
34965
34966 .chapter "System-wide message filtering" "CHAPsystemfilter"
34967 .scindex IIDsysfil1 "filter" "system filter"
34968 .scindex IIDsysfil2 "filtering all mail"
34969 .scindex IIDsysfil3 "system filter"
34970 The previous chapters (on ACLs and the local scan function) describe checks
34971 that can be applied to messages before they are accepted by a host. There is
34972 also a mechanism for checking messages once they have been received, but before
34973 they are delivered. This is called the &'system filter'&.
34974
34975 The system filter operates in a similar manner to users' filter files, but it
34976 is run just once per message (however many recipients the message has).
34977 It should not normally be used as a substitute for routing, because &%deliver%&
34978 commands in a system router provide new envelope recipient addresses.
34979 The system filter must be an Exim filter. It cannot be a Sieve filter.
34980
34981 The system filter is run at the start of a delivery attempt, before any routing
34982 is done. If a message fails to be completely delivered at the first attempt,
34983 the system filter is run again at the start of every retry.
34984 If you want your filter to do something only once per message, you can make use
34985 of the &%first_delivery%& condition in an &%if%& command in the filter to
34986 prevent it happening on retries.
34987
34988 .vindex "&$domain$&"
34989 .vindex "&$local_part$&"
34990 &*Warning*&: Because the system filter runs just once, variables that are
34991 specific to individual recipient addresses, such as &$local_part$& and
34992 &$domain$&, are not set, and the &"personal"& condition is not meaningful. If
34993 you want to run a centrally-specified filter for each recipient address
34994 independently, you can do so by setting up a suitable &(redirect)& router, as
34995 described in section &<<SECTperaddfil>>& below.
34996
34997
34998 .section "Specifying a system filter" "SECID212"
34999 .cindex "uid (user id)" "system filter"
35000 .cindex "gid (group id)" "system filter"
35001 The name of the file that contains the system filter must be specified by
35002 setting &%system_filter%&. If you want the filter to run under a uid and gid
35003 other than root, you must also set &%system_filter_user%& and
35004 &%system_filter_group%& as appropriate. For example:
35005 .code
35006 system_filter = /etc/mail/exim.filter
35007 system_filter_user = exim
35008 .endd
35009 If a system filter generates any deliveries directly to files or pipes (via the
35010 &%save%& or &%pipe%& commands), transports to handle these deliveries must be
35011 specified by setting &%system_filter_file_transport%& and
35012 &%system_filter_pipe_transport%&, respectively. Similarly,
35013 &%system_filter_reply_transport%& must be set to handle any messages generated
35014 by the &%reply%& command.
35015
35016
35017 .section "Testing a system filter" "SECID213"
35018 You can run simple tests of a system filter in the same way as for a user
35019 filter, but you should use &%-bF%& rather than &%-bf%&, so that features that
35020 are permitted only in system filters are recognized.
35021
35022 If you want to test the combined effect of a system filter and a user filter,
35023 you can use both &%-bF%& and &%-bf%& on the same command line.
35024
35025
35026
35027 .section "Contents of a system filter" "SECID214"
35028 The language used to specify system filters is the same as for users' filter
35029 files. It is described in the separate end-user document &'Exim's interface to
35030 mail filtering'&. However, there are some additional features that are
35031 available only in system filters; these are described in subsequent sections.
35032 If they are encountered in a user's filter file or when testing with &%-bf%&,
35033 they cause errors.
35034
35035 .cindex "frozen messages" "manual thaw; testing in filter"
35036 There are two special conditions which, though available in users' filter
35037 files, are designed for use in system filters. The condition &%first_delivery%&
35038 is true only for the first attempt at delivering a message, and
35039 &%manually_thawed%& is true only if the message has been frozen, and
35040 subsequently thawed by an admin user. An explicit forced delivery counts as a
35041 manual thaw, but thawing as a result of the &%auto_thaw%& setting does not.
35042
35043 &*Warning*&: If a system filter uses the &%first_delivery%& condition to
35044 specify an &"unseen"& (non-significant) delivery, and that delivery does not
35045 succeed, it will not be tried again.
35046 If you want Exim to retry an unseen delivery until it succeeds, you should
35047 arrange to set it up every time the filter runs.
35048
35049 When a system filter finishes running, the values of the variables &$n0$& &--
35050 &$n9$& are copied into &$sn0$& &-- &$sn9$& and are thereby made available to
35051 users' filter files. Thus a system filter can, for example, set up &"scores"&
35052 to which users' filter files can refer.
35053
35054
35055
35056 .section "Additional variable for system filters" "SECID215"
35057 .vindex "&$recipients$&"
35058 The expansion variable &$recipients$&, containing a list of all the recipients
35059 of the message (separated by commas and white space), is available in system
35060 filters. It is not available in users' filters for privacy reasons.
35061
35062
35063
35064 .section "Defer, freeze, and fail commands for system filters" "SECID216"
35065 .cindex "freezing messages"
35066 .cindex "message" "freezing"
35067 .cindex "message" "forced failure"
35068 .cindex "&%fail%&" "in system filter"
35069 .cindex "&%freeze%& in system filter"
35070 .cindex "&%defer%& in system filter"
35071 There are three extra commands (&%defer%&, &%freeze%& and &%fail%&) which are
35072 always available in system filters, but are not normally enabled in users'
35073 filters. (See the &%allow_defer%&, &%allow_freeze%& and &%allow_fail%& options
35074 for the &(redirect)& router.) These commands can optionally be followed by the
35075 word &%text%& and a string containing an error message, for example:
35076 .code
35077 fail text "this message looks like spam to me"
35078 .endd
35079 The keyword &%text%& is optional if the next character is a double quote.
35080
35081 The &%defer%& command defers delivery of the original recipients of the
35082 message. The &%fail%& command causes all the original recipients to be failed,
35083 and a bounce message to be created. The &%freeze%& command suspends all
35084 delivery attempts for the original recipients. In all cases, any new deliveries
35085 that are specified by the filter are attempted as normal after the filter has
35086 run.
35087
35088 The &%freeze%& command is ignored if the message has been manually unfrozen and
35089 not manually frozen since. This means that automatic freezing by a system
35090 filter can be used as a way of checking out suspicious messages. If a message
35091 is found to be all right, manually unfreezing it allows it to be delivered.
35092
35093 .cindex "log" "&%fail%& command log line"
35094 .cindex "&%fail%&" "log line; reducing"
35095 The text given with a fail command is used as part of the bounce message as
35096 well as being written to the log. If the message is quite long, this can fill
35097 up a lot of log space when such failures are common. To reduce the size of the
35098 log message, Exim interprets the text in a special way if it starts with the
35099 two characters &`<<`& and contains &`>>`& later. The text between these two
35100 strings is written to the log, and the rest of the text is used in the bounce
35101 message. For example:
35102 .code
35103 fail "<<filter test 1>>Your message is rejected \
35104      because it contains attachments that we are \
35105      not prepared to receive."
35106 .endd
35107
35108 .cindex "loop" "caused by &%fail%&"
35109 Take great care with the &%fail%& command when basing the decision to fail on
35110 the contents of the message, because the bounce message will of course include
35111 the contents of the original message and will therefore trigger the &%fail%&
35112 command again (causing a mail loop) unless steps are taken to prevent this.
35113 Testing the &%error_message%& condition is one way to prevent this. You could
35114 use, for example
35115 .code
35116 if $message_body contains "this is spam" and not error_message
35117 then fail text "spam is not wanted here" endif
35118 .endd
35119 though of course that might let through unwanted bounce messages. The
35120 alternative is clever checking of the body and/or headers to detect bounces
35121 generated by the filter.
35122
35123 The interpretation of a system filter file ceases after a
35124 &%defer%&,
35125 &%freeze%&, or &%fail%& command is obeyed. However, any deliveries that were
35126 set up earlier in the filter file are honoured, so you can use a sequence such
35127 as
35128 .code
35129 mail ...
35130 freeze
35131 .endd
35132 to send a specified message when the system filter is freezing (or deferring or
35133 failing) a message. The normal deliveries for the message do not, of course,
35134 take place.
35135
35136
35137
35138 .section "Adding and removing headers in a system filter" "SECTaddremheasys"
35139 .cindex "header lines" "adding; in system filter"
35140 .cindex "header lines" "removing; in system filter"
35141 .cindex "filter" "header lines; adding/removing"
35142 Two filter commands that are available only in system filters are:
35143 .code
35144 headers add <string>
35145 headers remove <string>
35146 .endd
35147 The argument for the &%headers add%& is a string that is expanded and then
35148 added to the end of the message's headers. It is the responsibility of the
35149 filter maintainer to make sure it conforms to RFC 2822 syntax. Leading white
35150 space is ignored, and if the string is otherwise empty, or if the expansion is
35151 forced to fail, the command has no effect.
35152
35153 You can use &"\n"& within the string, followed by white space, to specify
35154 continued header lines. More than one header may be added in one command by
35155 including &"\n"& within the string without any following white space. For
35156 example:
35157 .code
35158 headers add "X-header-1: ....\n  \
35159              continuation of X-header-1 ...\n\
35160              X-header-2: ...."
35161 .endd
35162 Note that the header line continuation white space after the first newline must
35163 be placed before the backslash that continues the input string, because white
35164 space after input continuations is ignored.
35165
35166 The argument for &%headers remove%& is a colon-separated list of header names.
35167 This command applies only to those headers that are stored with the message;
35168 those that are added at delivery time (such as &'Envelope-To:'& and
35169 &'Return-Path:'&) cannot be removed by this means. If there is more than one
35170 header with the same name, they are all removed.
35171
35172 The &%headers%& command in a system filter makes an immediate change to the set
35173 of header lines that was received with the message (with possible additions
35174 from ACL processing). Subsequent commands in the system filter operate on the
35175 modified set, which also forms the basis for subsequent message delivery.
35176 Unless further modified during routing or transporting, this set of headers is
35177 used for all recipients of the message.
35178
35179 During routing and transporting, the variables that refer to the contents of
35180 header lines refer only to those lines that are in this set. Thus, header lines
35181 that are added by a system filter are visible to users' filter files and to all
35182 routers and transports. This contrasts with the manipulation of header lines by
35183 routers and transports, which is not immediate, but which instead is saved up
35184 until the message is actually being written (see section
35185 &<<SECTheadersaddrem>>&).
35186
35187 If the message is not delivered at the first attempt, header lines that were
35188 added by the system filter are stored with the message, and so are still
35189 present at the next delivery attempt. Header lines that were removed are still
35190 present, but marked &"deleted"& so that they are not transported with the
35191 message. For this reason, it is usual to make the &%headers%& command
35192 conditional on &%first_delivery%& so that the set of header lines is not
35193 modified more than once.
35194
35195 Because header modification in a system filter acts immediately, you have to
35196 use an indirect approach if you want to modify the contents of a header line.
35197 For example:
35198 .code
35199 headers add "Old-Subject: $h_subject:"
35200 headers remove "Subject"
35201 headers add "Subject: new subject (was: $h_old-subject:)"
35202 headers remove "Old-Subject"
35203 .endd
35204
35205
35206
35207 .section "Setting an errors address in a system filter" "SECID217"
35208 .cindex "envelope from"
35209 .cindex "envelope sender"
35210 In a system filter, if a &%deliver%& command is followed by
35211 .code
35212 errors_to <some address>
35213 .endd
35214 in order to change the envelope sender (and hence the error reporting) for that
35215 delivery, any address may be specified. (In a user filter, only the current
35216 user's address can be set.) For example, if some mail is being monitored, you
35217 might use
35218 .code
35219 unseen deliver monitor@spying.example errors_to root@local.example
35220 .endd
35221 to take a copy which would not be sent back to the normal error reporting
35222 address if its delivery failed.
35223
35224
35225
35226 .section "Per-address filtering" "SECTperaddfil"
35227 .vindex "&$domain$&"
35228 .vindex "&$local_part$&"
35229 In contrast to the system filter, which is run just once per message for each
35230 delivery attempt, it is also possible to set up a system-wide filtering
35231 operation that runs once for each recipient address. In this case, variables
35232 such as &$local_part$& and &$domain$& can be used, and indeed, the choice of
35233 filter file could be made dependent on them. This is an example of a router
35234 which implements such a filter:
35235 .code
35236 central_filter:
35237   check_local_user
35238   driver = redirect
35239   domains = +local_domains
35240   file = /central/filters/$local_part_data
35241   no_verify
35242   allow_filter
35243   allow_freeze
35244 .endd
35245 The filter is run in a separate process under its own uid. Therefore, either
35246 &%check_local_user%& must be set (as above), in which case the filter is run as
35247 the local user, or the &%user%& option must be used to specify which user to
35248 use. If both are set, &%user%& overrides.
35249
35250 Care should be taken to ensure that none of the commands in the filter file
35251 specify a significant delivery if the message is to go on to be delivered to
35252 its intended recipient. The router will not then claim to have dealt with the
35253 address, so it will be passed on to subsequent routers to be delivered in the
35254 normal way.
35255 .ecindex IIDsysfil1
35256 .ecindex IIDsysfil2
35257 .ecindex IIDsysfil3
35258
35259
35260
35261
35262
35263
35264 . ////////////////////////////////////////////////////////////////////////////
35265 . ////////////////////////////////////////////////////////////////////////////
35266
35267 .chapter "Message processing" "CHAPmsgproc"
35268 .scindex IIDmesproc "message" "general processing"
35269 Exim performs various transformations on the sender and recipient addresses of
35270 all messages that it handles, and also on the messages' header lines. Some of
35271 these are optional and configurable, while others always take place. All of
35272 this processing, except rewriting as a result of routing, and the addition or
35273 removal of header lines while delivering, happens when a message is received,
35274 before it is placed on Exim's queue.
35275
35276 Some of the automatic processing takes place by default only for
35277 &"locally-originated"& messages. This adjective is used to describe messages
35278 that are not received over TCP/IP, but instead are passed to an Exim process on
35279 its standard input. This includes the interactive &"local SMTP"& case that is
35280 set up by the &%-bs%& command line option.
35281
35282 &*Note*&: Messages received over TCP/IP on the loopback interface (127.0.0.1
35283 or ::1) are not considered to be locally-originated. Exim does not treat the
35284 loopback interface specially in any way.
35285
35286 If you want the loopback interface to be treated specially, you must ensure
35287 that there are appropriate entries in your ACLs.
35288
35289
35290
35291
35292 .section "Submission mode for non-local messages" "SECTsubmodnon"
35293 .cindex "message" "submission"
35294 .cindex "submission mode"
35295 Processing that happens automatically for locally-originated messages (unless
35296 &%suppress_local_fixups%& is set) can also be requested for messages that are
35297 received over TCP/IP. The term &"submission mode"& is used to describe this
35298 state. Submission mode is set by the modifier
35299 .code
35300 control = submission
35301 .endd
35302 in a MAIL, RCPT, or pre-data ACL for an incoming message (see sections
35303 &<<SECTACLmodi>>& and &<<SECTcontrols>>&). This makes Exim treat the message as
35304 a local submission, and is normally used when the source of the message is
35305 known to be an MUA running on a client host (as opposed to an MTA). For
35306 example, to set submission mode for messages originating on the IPv4 loopback
35307 interface, you could include the following in the MAIL ACL:
35308 .code
35309 warn  hosts = 127.0.0.1
35310       control = submission
35311 .endd
35312 .cindex "&%sender_retain%& submission option"
35313 There are some options that can be used when setting submission mode. A slash
35314 is used to separate options. For example:
35315 .code
35316 control = submission/sender_retain
35317 .endd
35318 Specifying &%sender_retain%& has the effect of setting &%local_sender_retain%&
35319 true and &%local_from_check%& false for the current incoming message. The first
35320 of these allows an existing &'Sender:'& header in the message to remain, and
35321 the second suppresses the check to ensure that &'From:'& matches the
35322 authenticated sender. With this setting, Exim still fixes up messages by adding
35323 &'Date:'& and &'Message-ID:'& header lines if they are missing, but makes no
35324 attempt to check sender authenticity in header lines.
35325
35326 When &%sender_retain%& is not set, a submission mode setting may specify a
35327 domain to be used when generating a &'From:'& or &'Sender:'& header line. For
35328 example:
35329 .code
35330 control = submission/domain=some.domain
35331 .endd
35332 The domain may be empty. How this value is used is described in sections
35333 &<<SECTthefrohea>>& and &<<SECTthesenhea>>&. There is also a &%name%& option
35334 that allows you to specify the user's full name for inclusion in a created
35335 &'Sender:'& or &'From:'& header line. For example:
35336 .code
35337 accept authenticated = *
35338        control = submission/domain=wonderland.example/\
35339                             name=${lookup {$authenticated_id} \
35340                                    lsearch {/etc/exim/namelist}}
35341 .endd
35342 Because the name may contain any characters, including slashes, the &%name%&
35343 option must be given last. The remainder of the string is used as the name. For
35344 the example above, if &_/etc/exim/namelist_& contains:
35345 .code
35346 bigegg:  Humpty Dumpty
35347 .endd
35348 then when the sender has authenticated as &'bigegg'&, the generated &'Sender:'&
35349 line would be:
35350 .code
35351 Sender: Humpty Dumpty <bigegg@wonderland.example>
35352 .endd
35353 .cindex "return path" "in submission mode"
35354 By default, submission mode forces the return path to the same address as is
35355 used to create the &'Sender:'& header. However, if &%sender_retain%& is
35356 specified, the return path is also left unchanged.
35357
35358 &*Note*&: The changes caused by submission mode take effect after the predata
35359 ACL. This means that any sender checks performed before the fix-ups use the
35360 untrusted sender address specified by the user, not the trusted sender address
35361 specified by submission mode. Although this might be slightly unexpected, it
35362 does mean that you can configure ACL checks to spot that a user is trying to
35363 spoof another's address.
35364
35365 .section "Line endings" "SECTlineendings"
35366 .cindex "line endings"
35367 .cindex "carriage return"
35368 .cindex "linefeed"
35369 RFC 2821 specifies that CRLF (two characters: carriage-return, followed by
35370 linefeed) is the line ending for messages transmitted over the Internet using
35371 SMTP over TCP/IP. However, within individual operating systems, different
35372 conventions are used. For example, Unix-like systems use just LF, but others
35373 use CRLF or just CR.
35374
35375 Exim was designed for Unix-like systems, and internally, it stores messages
35376 using the system's convention of a single LF as a line terminator. When
35377 receiving a message, all line endings are translated to this standard format.
35378 Originally, it was thought that programs that passed messages directly to an
35379 MTA within an operating system would use that system's convention. Experience
35380 has shown that this is not the case; for example, there are Unix applications
35381 that use CRLF in this circumstance. For this reason, and for compatibility with
35382 other MTAs, the way Exim handles line endings for all messages is now as
35383 follows:
35384
35385 .ilist
35386 LF not preceded by CR is treated as a line ending.
35387 .next
35388 CR is treated as a line ending; if it is immediately followed by LF, the LF
35389 is ignored.
35390 .next
35391 The sequence &"CR, dot, CR"& does not terminate an incoming SMTP message,
35392 nor a local message in the state where a line containing only a dot is a
35393 terminator.
35394 .next
35395 If a bare CR is encountered within a header line, an extra space is added after
35396 the line terminator so as not to end the header line. The reasoning behind this
35397 is that bare CRs in header lines are most likely either to be mistakes, or
35398 people trying to play silly games.
35399 .next
35400 If the first header line received in a message ends with CRLF, a subsequent
35401 bare LF in a header line is treated in the same way as a bare CR in a header
35402 line.
35403 .endlist
35404
35405
35406
35407
35408
35409 .section "Unqualified addresses" "SECID218"
35410 .cindex "unqualified addresses"
35411 .cindex "address" "qualification"
35412 By default, Exim expects every envelope address it receives from an external
35413 host to be fully qualified. Unqualified addresses cause negative responses to
35414 SMTP commands. However, because SMTP is used as a means of transporting
35415 messages from MUAs running on personal workstations, there is sometimes a
35416 requirement to accept unqualified addresses from specific hosts or IP networks.
35417
35418 Exim has two options that separately control which hosts may send unqualified
35419 sender or recipient addresses in SMTP commands, namely
35420 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&. In both
35421 cases, if an unqualified address is accepted, it is qualified by adding the
35422 value of &%qualify_domain%& or &%qualify_recipient%&, as appropriate.
35423
35424 .oindex "&%qualify_domain%&"
35425 .oindex "&%qualify_recipient%&"
35426 Unqualified addresses in header lines are automatically qualified for messages
35427 that are locally originated, unless the &%-bnq%& option is given on the command
35428 line. For messages received over SMTP, unqualified addresses in header lines
35429 are qualified only if unqualified addresses are permitted in SMTP commands. In
35430 other words, such qualification is also controlled by
35431 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&,
35432
35433
35434
35435
35436 .section "The UUCP From line" "SECID219"
35437 .cindex "&""From""& line"
35438 .cindex "UUCP" "&""From""& line"
35439 .cindex "sender" "address"
35440 .oindex "&%uucp_from_pattern%&"
35441 .oindex "&%uucp_from_sender%&"
35442 .cindex "envelope from"
35443 .cindex "envelope sender"
35444 .cindex "Sendmail compatibility" "&""From""& line"
35445 Messages that have come from UUCP (and some other applications) often begin
35446 with a line containing the envelope sender and a timestamp, following the word
35447 &"From"&. Examples of two common formats are:
35448 .code
35449 From a.oakley@berlin.mus Fri Jan  5 12:35 GMT 1996
35450 From f.butler@berlin.mus Fri, 7 Jan 97 14:00:00 GMT
35451 .endd
35452 This line precedes the RFC 2822 header lines. For compatibility with Sendmail,
35453 Exim recognizes such lines at the start of messages that are submitted to it
35454 via the command line (that is, on the standard input). It does not recognize
35455 such lines in incoming SMTP messages, unless the sending host matches
35456 &%ignore_fromline_hosts%& or the &%-bs%& option was used for a local message
35457 and &%ignore_fromline_local%& is set. The recognition is controlled by a
35458 regular expression that is defined by the &%uucp_from_pattern%& option, whose
35459 default value matches the two common cases shown above and puts the address
35460 that follows &"From"& into &$1$&.
35461
35462 .cindex "numerical variables (&$1$& &$2$& etc)" "in &""From ""& line handling"
35463 When the caller of Exim for a non-SMTP message that contains a &"From"& line is
35464 a trusted user, the message's sender address is constructed by expanding the
35465 contents of &%uucp_sender_address%&, whose default value is &"$1"&. This is
35466 then parsed as an RFC 2822 address. If there is no domain, the local part is
35467 qualified with &%qualify_domain%& unless it is the empty string. However, if
35468 the command line &%-f%& option is used, it overrides the &"From"& line.
35469
35470 If the caller of Exim is not trusted, the &"From"& line is recognized, but the
35471 sender address is not changed. This is also the case for incoming SMTP messages
35472 that are permitted to contain &"From"& lines.
35473
35474 Only one &"From"& line is recognized. If there is more than one, the second is
35475 treated as a data line that starts the body of the message, as it is not valid
35476 as a header line. This also happens if a &"From"& line is present in an
35477 incoming SMTP message from a source that is not permitted to send them.
35478
35479
35480
35481 .section "Resent- header lines" "SECID220"
35482 .cindex "&%Resent-%& header lines"
35483 .cindex "header lines" "Resent-"
35484 RFC 2822 makes provision for sets of header lines starting with the string
35485 &`Resent-`& to be added to a message when it is resent by the original
35486 recipient to somebody else. These headers are &'Resent-Date:'&,
35487 &'Resent-From:'&, &'Resent-Sender:'&, &'Resent-To:'&, &'Resent-Cc:'&,
35488 &'Resent-Bcc:'& and &'Resent-Message-ID:'&. The RFC says:
35489
35490 .blockquote
35491 &'Resent fields are strictly informational. They MUST NOT be used in the normal
35492 processing of replies or other such automatic actions on messages.'&
35493 .endblockquote
35494
35495 This leaves things a bit vague as far as other processing actions such as
35496 address rewriting are concerned. Exim treats &%Resent-%& header lines as
35497 follows:
35498
35499 .ilist
35500 A &'Resent-From:'& line that just contains the login id of the submitting user
35501 is automatically rewritten in the same way as &'From:'& (see below).
35502 .next
35503 If there's a rewriting rule for a particular header line, it is also applied to
35504 &%Resent-%& header lines of the same type. For example, a rule that rewrites
35505 &'From:'& also rewrites &'Resent-From:'&.
35506 .next
35507 For local messages, if &'Sender:'& is removed on input, &'Resent-Sender:'& is
35508 also removed.
35509 .next
35510 For a locally-submitted message,
35511 if there are any &%Resent-%& header lines but no &'Resent-Date:'&,
35512 &'Resent-From:'&, or &'Resent-Message-Id:'&, they are added as necessary. It is
35513 the contents of &'Resent-Message-Id:'& (rather than &'Message-Id:'&) which are
35514 included in log lines in this case.
35515 .next
35516 The logic for adding &'Sender:'& is duplicated for &'Resent-Sender:'& when any
35517 &%Resent-%& header lines are present.
35518 .endlist
35519
35520
35521
35522
35523 .section "The Auto-Submitted: header line" "SECID221"
35524 Whenever Exim generates an autoreply, a bounce, or a delay warning message, it
35525 includes the header line:
35526 .code
35527 Auto-Submitted: auto-replied
35528 .endd
35529
35530 .section "The Bcc: header line" "SECID222"
35531 .cindex "&'Bcc:'& header line"
35532 If Exim is called with the &%-t%& option, to take recipient addresses from a
35533 message's header, it removes any &'Bcc:'& header line that may exist (after
35534 extracting its addresses). If &%-t%& is not present on the command line, any
35535 existing &'Bcc:'& is not removed.
35536
35537
35538 .section "The Date: header line" "SECID223"
35539 .cindex "&'Date:'& header line"
35540 .cindex "header lines" "Date:"
35541 If a locally-generated or submission-mode message has no &'Date:'& header line,
35542 Exim adds one, using the current date and time, unless the
35543 &%suppress_local_fixups%& control has been specified.
35544
35545 .section "The Delivery-date: header line" "SECID224"
35546 .cindex "&'Delivery-date:'& header line"
35547 .oindex "&%delivery_date_remove%&"
35548 &'Delivery-date:'& header lines are not part of the standard RFC 2822 header
35549 set. Exim can be configured to add them to the final delivery of messages. (See
35550 the generic &%delivery_date_add%& transport option.) They should not be present
35551 in messages in transit. If the &%delivery_date_remove%& configuration option is
35552 set (the default), Exim removes &'Delivery-date:'& header lines from incoming
35553 messages.
35554
35555
35556 .section "The Envelope-to: header line" "SECID225"
35557 .cindex "&'Envelope-to:'& header line"
35558 .cindex "header lines" "Envelope-to:"
35559 .oindex "&%envelope_to_remove%&"
35560 &'Envelope-to:'& header lines are not part of the standard RFC 2822 header set.
35561 Exim can be configured to add them to the final delivery of messages. (See the
35562 generic &%envelope_to_add%& transport option.) They should not be present in
35563 messages in transit. If the &%envelope_to_remove%& configuration option is set
35564 (the default), Exim removes &'Envelope-to:'& header lines from incoming
35565 messages.
35566
35567
35568 .section "The From: header line" "SECTthefrohea"
35569 .cindex "&'From:'& header line"
35570 .cindex "header lines" "From:"
35571 .cindex "Sendmail compatibility" "&""From""& line"
35572 .cindex "message" "submission"
35573 .cindex "submission mode"
35574 If a submission-mode message does not contain a &'From:'& header line, Exim
35575 adds one if either of the following conditions is true:
35576
35577 .ilist
35578 The envelope sender address is not empty (that is, this is not a bounce
35579 message). The added header line copies the envelope sender address.
35580 .next
35581 .vindex "&$authenticated_id$&"
35582 The SMTP session is authenticated and &$authenticated_id$& is not empty.
35583 .olist
35584 .vindex "&$qualify_domain$&"
35585 If no domain is specified by the submission control, the local part is
35586 &$authenticated_id$& and the domain is &$qualify_domain$&.
35587 .next
35588 If a non-empty domain is specified by the submission control, the local
35589 part is &$authenticated_id$&, and the domain is the specified domain.
35590 .next
35591 If an empty domain is specified by the submission control,
35592 &$authenticated_id$& is assumed to be the complete address.
35593 .endlist
35594 .endlist
35595
35596 A non-empty envelope sender takes precedence.
35597
35598 If a locally-generated incoming message does not contain a &'From:'& header
35599 line, and the &%suppress_local_fixups%& control is not set, Exim adds one
35600 containing the sender's address. The calling user's login name and full name
35601 are used to construct the address, as described in section &<<SECTconstr>>&.
35602 They are obtained from the password data by calling &[getpwuid()]& (but see the
35603 &%unknown_login%& configuration option). The address is qualified with
35604 &%qualify_domain%&.
35605
35606 For compatibility with Sendmail, if an incoming, non-SMTP message has a
35607 &'From:'& header line containing just the unqualified login name of the calling
35608 user, this is replaced by an address containing the user's login name and full
35609 name as described in section &<<SECTconstr>>&.
35610
35611
35612 .section "The Message-ID: header line" "SECID226"
35613 .cindex "&'Message-ID:'& header line"
35614 .cindex "header lines" "Message-ID:"
35615 .cindex "message" "submission"
35616 .oindex "&%message_id_header_text%&"
35617 If a locally-generated or submission-mode incoming message does not contain a
35618 &'Message-ID:'& or &'Resent-Message-ID:'& header line, and the
35619 &%suppress_local_fixups%& control is not set, Exim adds a suitable header line
35620 to the message. If there are any &'Resent-:'& headers in the message, it
35621 creates &'Resent-Message-ID:'&. The id is constructed from Exim's internal
35622 message id, preceded by the letter E to ensure it starts with a letter, and
35623 followed by @ and the primary host name. Additional information can be included
35624 in this header line by setting the &%message_id_header_text%& and/or
35625 &%message_id_header_domain%& options.
35626
35627
35628 .section "The Received: header line" "SECID227"
35629 .cindex "&'Received:'& header line"
35630 .cindex "header lines" "Received:"
35631 A &'Received:'& header line is added at the start of every message. The
35632 contents are defined by the &%received_header_text%& configuration option, and
35633 Exim automatically adds a semicolon and a timestamp to the configured string.
35634
35635 The &'Received:'& header is generated as soon as the message's header lines
35636 have been received. At this stage, the timestamp in the &'Received:'& header
35637 line is the time that the message started to be received. This is the value
35638 that is seen by the DATA ACL and by the &[local_scan()]& function.
35639
35640 Once a message is accepted, the timestamp in the &'Received:'& header line is
35641 changed to the time of acceptance, which is (apart from a small delay while the
35642 -H spool file is written) the earliest time at which delivery could start.
35643
35644
35645 .section "The References: header line" "SECID228"
35646 .cindex "&'References:'& header line"
35647 .cindex "header lines" "References:"
35648 Messages created by the &(autoreply)& transport include a &'References:'&
35649 header line. This is constructed according to the rules that are described in
35650 section 3.64 of RFC 2822 (which states that replies should contain such a
35651 header line), and section 3.14 of RFC 3834 (which states that automatic
35652 responses are not different in this respect). However, because some mail
35653 processing software does not cope well with very long header lines, no more
35654 than 12 message IDs are copied from the &'References:'& header line in the
35655 incoming message. If there are more than 12, the first one and then the final
35656 11 are copied, before adding the message ID of the incoming message.
35657
35658
35659
35660 .section "The Return-path: header line" "SECID229"
35661 .cindex "&'Return-path:'& header line"
35662 .cindex "header lines" "Return-path:"
35663 .oindex "&%return_path_remove%&"
35664 &'Return-path:'& header lines are defined as something an MTA may insert when
35665 it does the final delivery of messages. (See the generic &%return_path_add%&
35666 transport option.) Therefore, they should not be present in messages in
35667 transit. If the &%return_path_remove%& configuration option is set (the
35668 default), Exim removes &'Return-path:'& header lines from incoming messages.
35669
35670
35671
35672 .section "The Sender: header line" "SECTthesenhea"
35673 .cindex "&'Sender:'& header line"
35674 .cindex "message" "submission"
35675 .cindex "header lines" "Sender:"
35676 For a locally-originated message from an untrusted user, Exim may remove an
35677 existing &'Sender:'& header line, and it may add a new one. You can modify
35678 these actions by setting the &%local_sender_retain%& option true, the
35679 &%local_from_check%& option false, or by using the &%suppress_local_fixups%&
35680 control setting.
35681
35682 When a local message is received from an untrusted user and
35683 &%local_from_check%& is true (the default), and the &%suppress_local_fixups%&
35684 control has not been set, a check is made to see if the address given in the
35685 &'From:'& header line is the correct (local) sender of the message. The address
35686 that is expected has the login name as the local part and the value of
35687 &%qualify_domain%& as the domain. Prefixes and suffixes for the local part can
35688 be permitted by setting &%local_from_prefix%& and &%local_from_suffix%&
35689 appropriately. If &'From:'& does not contain the correct sender, a &'Sender:'&
35690 line is added to the message.
35691
35692 If you set &%local_from_check%& false, this checking does not occur. However,
35693 the removal of an existing &'Sender:'& line still happens, unless you also set
35694 &%local_sender_retain%& to be true. It is not possible to set both of these
35695 options true at the same time.
35696
35697 .cindex "submission mode"
35698 By default, no processing of &'Sender:'& header lines is done for messages
35699 received over TCP/IP or for messages submitted by trusted users. However, when
35700 a message is received over TCP/IP in submission mode, and &%sender_retain%& is
35701 not specified on the submission control, the following processing takes place:
35702
35703 .vindex "&$authenticated_id$&"
35704 First, any existing &'Sender:'& lines are removed. Then, if the SMTP session is
35705 authenticated, and &$authenticated_id$& is not empty, a sender address is
35706 created as follows:
35707
35708 .ilist
35709 .vindex "&$qualify_domain$&"
35710 If no domain is specified by the submission control, the local part is
35711 &$authenticated_id$& and the domain is &$qualify_domain$&.
35712 .next
35713 If a non-empty domain is specified by the submission control, the local part
35714 is &$authenticated_id$&, and the domain is the specified domain.
35715 .next
35716 If an empty domain is specified by the submission control,
35717 &$authenticated_id$& is assumed to be the complete address.
35718 .endlist
35719
35720 This address is compared with the address in the &'From:'& header line. If they
35721 are different, a &'Sender:'& header line containing the created address is
35722 added. Prefixes and suffixes for the local part in &'From:'& can be permitted
35723 by setting &%local_from_prefix%& and &%local_from_suffix%& appropriately.
35724
35725 .cindex "return path" "created from &'Sender:'&"
35726 &*Note*&: Whenever a &'Sender:'& header line is created, the return path for
35727 the message (the envelope sender address) is changed to be the same address,
35728 except in the case of submission mode when &%sender_retain%& is specified.
35729
35730
35731
35732 .section "Adding and removing header lines in routers and transports" &&&
35733          "SECTheadersaddrem"
35734 .cindex "header lines" "adding; in router or transport"
35735 .cindex "header lines" "removing; in router or transport"
35736 When a message is delivered, the addition and removal of header lines can be
35737 specified in a system filter, or on any of the routers and transports that
35738 process the message. Section &<<SECTaddremheasys>>& contains details about
35739 modifying headers in a system filter. Header lines can also be added in an ACL
35740 as a message is received (see section &<<SECTaddheadacl>>&).
35741
35742 In contrast to what happens in a system filter, header modifications that are
35743 specified on routers and transports apply only to the particular recipient
35744 addresses that are being processed by those routers and transports. These
35745 changes do not actually take place until a copy of the message is being
35746 transported. Therefore, they do not affect the basic set of header lines, and
35747 they do not affect the values of the variables that refer to header lines.
35748
35749 &*Note*&: In particular, this means that any expansions in the configuration of
35750 the transport cannot refer to the modified header lines, because such
35751 expansions all occur before the message is actually transported.
35752
35753 For both routers and transports, the argument of a &%headers_add%&
35754 option must be in the form of one or more RFC 2822 header lines, separated by
35755 newlines (coded as &"\n"&). For example:
35756 .code
35757 headers_add = X-added-header: added by $primary_hostname\n\
35758               X-added-second: another added header line
35759 .endd
35760 Exim does not check the syntax of these added header lines.
35761
35762 Multiple &%headers_add%& options for a single router or transport can be
35763 specified; the values will append to a single list of header lines.
35764 Each header-line is separately expanded.
35765
35766 The argument of a &%headers_remove%& option must consist of a colon-separated
35767 list of header names. This is confusing, because header names themselves are
35768 often terminated by colons. In this case, the colons are the list separators,
35769 not part of the names. For example:
35770 .code
35771 headers_remove = return-receipt-to:acknowledge-to
35772 .endd
35773
35774 Multiple &%headers_remove%& options for a single router or transport can be
35775 specified; the arguments will append to a single header-names list.
35776 Each item is separately expanded.
35777 Note that colons in complex expansions which are used to
35778 form all or part of a &%headers_remove%& list
35779 will act as list separators.
35780
35781 When &%headers_add%& or &%headers_remove%& is specified on a router,
35782 items are expanded at routing time,
35783 and then associated with all addresses that are
35784 accepted by that router, and also with any new addresses that it generates. If
35785 an address passes through several routers as a result of aliasing or
35786 forwarding, the changes are cumulative.
35787
35788 .oindex "&%unseen%&"
35789 However, this does not apply to multiple routers that result from the use of
35790 the &%unseen%& option. Any header modifications that were specified by the
35791 &"unseen"& router or its predecessors apply only to the &"unseen"& delivery.
35792
35793 Addresses that end up with different &%headers_add%& or &%headers_remove%&
35794 settings cannot be delivered together in a batch, so a transport is always
35795 dealing with a set of addresses that have the same header-processing
35796 requirements.
35797
35798 The transport starts by writing the original set of header lines that arrived
35799 with the message, possibly modified by the system filter. As it writes out
35800 these lines, it consults the list of header names that were attached to the
35801 recipient address(es) by &%headers_remove%& options in routers, and it also
35802 consults the transport's own &%headers_remove%& option. Header lines whose
35803 names are on either of these lists are not written out. If there are multiple
35804 instances of any listed header, they are all skipped.
35805
35806 After the remaining original header lines have been written, new header
35807 lines that were specified by routers' &%headers_add%& options are written, in
35808 the order in which they were attached to the address. These are followed by any
35809 header lines specified by the transport's &%headers_add%& option.
35810
35811 This way of handling header line modifications in routers and transports has
35812 the following consequences:
35813
35814 .ilist
35815 The original set of header lines, possibly modified by the system filter,
35816 remains &"visible"&, in the sense that the &$header_$&&'xxx'& variables refer
35817 to it, at all times.
35818 .next
35819 Header lines that are added by a router's
35820 &%headers_add%& option are not accessible by means of the &$header_$&&'xxx'&
35821 expansion syntax in subsequent routers or the transport.
35822 .next
35823 Conversely, header lines that are specified for removal by &%headers_remove%&
35824 in a router remain visible to subsequent routers and the transport.
35825 .next
35826 Headers added to an address by &%headers_add%& in a router cannot be removed by
35827 a later router or by a transport.
35828 .next
35829 An added header can refer to the contents of an original header that is to be
35830 removed, even it has the same name as the added header. For example:
35831 .code
35832 headers_remove = subject
35833 headers_add = Subject: new subject (was: $h_subject:)
35834 .endd
35835 .endlist
35836
35837 &*Warning*&: The &%headers_add%& and &%headers_remove%& options cannot be used
35838 for a &(redirect)& router that has the &%one_time%& option set.
35839
35840
35841
35842
35843
35844 .section "Constructed addresses" "SECTconstr"
35845 .cindex "address" "constructed"
35846 .cindex "constructed address"
35847 When Exim constructs a sender address for a locally-generated message, it uses
35848 the form
35849 .display
35850 <&'user name'&>&~&~<&'login'&&`@`&&'qualify_domain'&>
35851 .endd
35852 For example:
35853 .code
35854 Zaphod Beeblebrox <zaphod@end.univ.example>
35855 .endd
35856 The user name is obtained from the &%-F%& command line option if set, or
35857 otherwise by looking up the calling user by &[getpwuid()]& and extracting the
35858 &"gecos"& field from the password entry. If the &"gecos"& field contains an
35859 ampersand character, this is replaced by the login name with the first letter
35860 upper cased, as is conventional in a number of operating systems. See the
35861 &%gecos_name%& option for a way to tailor the handling of the &"gecos"& field.
35862 The &%unknown_username%& option can be used to specify user names in cases when
35863 there is no password file entry.
35864
35865 .cindex "RFC 2047"
35866 In all cases, the user name is made to conform to RFC 2822 by quoting all or
35867 parts of it if necessary. In addition, if it contains any non-printing
35868 characters, it is encoded as described in RFC 2047, which defines a way of
35869 including non-ASCII characters in header lines. The value of the
35870 &%headers_charset%& option specifies the name of the encoding that is used (the
35871 characters are assumed to be in this encoding). The setting of
35872 &%print_topbitchars%& controls whether characters with the top bit set (that
35873 is, with codes greater than 127) count as printing characters or not.
35874
35875
35876
35877 .section "Case of local parts" "SECID230"
35878 .cindex "case of local parts"
35879 .cindex "local part" "case of"
35880 RFC 2822 states that the case of letters in the local parts of addresses cannot
35881 be assumed to be non-significant. Exim preserves the case of local parts of
35882 addresses, but by default it uses a lower-cased form when it is routing,
35883 because on most Unix systems, usernames are in lower case and case-insensitive
35884 routing is required. However, any particular router can be made to use the
35885 original case for local parts by setting the &%caseful_local_part%& generic
35886 router option.
35887
35888 .cindex "mixed-case login names"
35889 If you must have mixed-case user names on your system, the best way to proceed,
35890 assuming you want case-independent handling of incoming email, is to set up
35891 your first router to convert incoming local parts in your domains to the
35892 correct case by means of a file lookup. For example:
35893 .code
35894 correct_case:
35895   driver = redirect
35896   domains = +local_domains
35897   data = ${lookup{$local_part}cdb\
35898               {/etc/usercased.cdb}{$value}fail}\
35899               @$domain
35900 .endd
35901 For this router, the local part is forced to lower case by the default action
35902 (&%caseful_local_part%& is not set). The lower-cased local part is used to look
35903 up a new local part in the correct case. If you then set &%caseful_local_part%&
35904 on any subsequent routers which process your domains, they will operate on
35905 local parts with the correct case in a case-sensitive manner.
35906
35907
35908
35909 .section "Dots in local parts" "SECID231"
35910 .cindex "dot" "in local part"
35911 .cindex "local part" "dots in"
35912 RFC 2822 forbids empty components in local parts. That is, an unquoted local
35913 part may not begin or end with a dot, nor have two consecutive dots in the
35914 middle. However, it seems that many MTAs do not enforce this, so Exim permits
35915 empty components for compatibility.
35916
35917
35918
35919 .section "Rewriting addresses" "SECID232"
35920 .cindex "rewriting" "addresses"
35921 Rewriting of sender and recipient addresses, and addresses in headers, can
35922 happen automatically, or as the result of configuration options, as described
35923 in chapter &<<CHAPrewrite>>&. The headers that may be affected by this are
35924 &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-To:'&, &'Sender:'&, and &'To:'&.
35925
35926 Automatic rewriting includes qualification, as mentioned above. The other case
35927 in which it can happen is when an incomplete non-local domain is given. The
35928 routing process may cause this to be expanded into the full domain name. For
35929 example, a header such as
35930 .code
35931 To: hare@teaparty
35932 .endd
35933 might get rewritten as
35934 .code
35935 To: hare@teaparty.wonderland.fict.example
35936 .endd
35937 Rewriting as a result of routing is the one kind of message processing that
35938 does not happen at input time, as it cannot be done until the address has
35939 been routed.
35940
35941 Strictly, one should not do &'any'& deliveries of a message until all its
35942 addresses have been routed, in case any of the headers get changed as a
35943 result of routing. However, doing this in practice would hold up many
35944 deliveries for unreasonable amounts of time, just because one address could not
35945 immediately be routed. Exim therefore does not delay other deliveries when
35946 routing of one or more addresses is deferred.
35947 .ecindex IIDmesproc
35948
35949
35950
35951 . ////////////////////////////////////////////////////////////////////////////
35952 . ////////////////////////////////////////////////////////////////////////////
35953
35954 .chapter "SMTP processing" "CHAPSMTP"
35955 .scindex IIDsmtpproc1 "SMTP" "processing details"
35956 .scindex IIDsmtpproc2 "LMTP" "processing details"
35957 Exim supports a number of different ways of using the SMTP protocol, and its
35958 LMTP variant, which is an interactive protocol for transferring messages into a
35959 closed mail store application. This chapter contains details of how SMTP is
35960 processed. For incoming mail, the following are available:
35961
35962 .ilist
35963 SMTP over TCP/IP (Exim daemon or &'inetd'&);
35964 .next
35965 SMTP over the standard input and output (the &%-bs%& option);
35966 .next
35967 Batched SMTP on the standard input (the &%-bS%& option).
35968 .endlist
35969
35970 For mail delivery, the following are available:
35971
35972 .ilist
35973 SMTP over TCP/IP (the &(smtp)& transport);
35974 .next
35975 LMTP over TCP/IP (the &(smtp)& transport with the &%protocol%& option set to
35976 &"lmtp"&);
35977 .next
35978 LMTP over a pipe to a process running in the local host (the &(lmtp)&
35979 transport);
35980 .next
35981 Batched SMTP to a file or pipe (the &(appendfile)& and &(pipe)& transports with
35982 the &%use_bsmtp%& option set).
35983 .endlist
35984
35985 &'Batched SMTP'& is the name for a process in which batches of messages are
35986 stored in or read from files (or pipes), in a format in which SMTP commands are
35987 used to contain the envelope information.
35988
35989
35990
35991 .section "Outgoing SMTP and LMTP over TCP/IP" "SECToutSMTPTCP"
35992 .cindex "SMTP" "outgoing over TCP/IP"
35993 .cindex "outgoing SMTP over TCP/IP"
35994 .cindex "LMTP" "over TCP/IP"
35995 .cindex "outgoing LMTP over TCP/IP"
35996 .cindex "EHLO"
35997 .cindex "HELO"
35998 .cindex "SIZE" "option on MAIL command"
35999 Outgoing SMTP and LMTP over TCP/IP is implemented by the &(smtp)& transport.
36000 The &%protocol%& option selects which protocol is to be used, but the actual
36001 processing is the same in both cases.
36002
36003 .cindex "ESMTP extensions" SIZE
36004 If, in response to its EHLO command, Exim is told that the SIZE
36005 extension is supported, it adds SIZE=<&'n'&> to each subsequent MAIL
36006 command. The value of <&'n'&> is the message size plus the value of the
36007 &%size_addition%& option (default 1024) to allow for additions to the message
36008 such as per-transport header lines, or changes made in a
36009 .cindex "transport" "filter"
36010 .cindex "filter" "transport filter"
36011 transport filter. If &%size_addition%& is set negative, the use of SIZE is
36012 suppressed.
36013
36014 If the remote server advertises support for PIPELINING, Exim uses the
36015 pipelining extension to SMTP (RFC 2197) to reduce the number of TCP/IP packets
36016 required for the transaction.
36017
36018 If the remote server advertises support for the STARTTLS command, and Exim
36019 was built to support TLS encryption, it tries to start a TLS session unless the
36020 server matches &%hosts_avoid_tls%&. See chapter &<<CHAPTLS>>& for more details.
36021 Either a match in that or &%hosts_verify_avoid_tls%& apply when the transport
36022 is called for verification.
36023
36024 If the remote server advertises support for the AUTH command, Exim scans
36025 the authenticators configuration for any suitable client settings, as described
36026 in chapter &<<CHAPSMTPAUTH>>&.
36027
36028 .cindex "carriage return"
36029 .cindex "linefeed"
36030 Responses from the remote host are supposed to be terminated by CR followed by
36031 LF. However, there are known to be hosts that do not send CR characters, so in
36032 order to be able to interwork with such hosts, Exim treats LF on its own as a
36033 line terminator.
36034
36035 If a message contains a number of different addresses, all those with the same
36036 characteristics (for example, the same envelope sender) that resolve to the
36037 same set of hosts, in the same order, are sent in a single SMTP transaction,
36038 even if they are for different domains, unless there are more than the setting
36039 of the &%max_rcpt%&s option in the &(smtp)& transport allows, in which case
36040 they are split into groups containing no more than &%max_rcpt%&s addresses
36041 each. If &%remote_max_parallel%& is greater than one, such groups may be sent
36042 in parallel sessions. The order of hosts with identical MX values is not
36043 significant when checking whether addresses can be batched in this way.
36044
36045 When the &(smtp)& transport suffers a temporary failure that is not
36046 message-related, Exim updates its transport-specific database, which contains
36047 records indexed by host name that remember which messages are waiting for each
36048 particular host. It also updates the retry database with new retry times.
36049
36050 .cindex "hints database" "retry keys"
36051 Exim's retry hints are based on host name plus IP address, so if one address of
36052 a multi-homed host is broken, it will soon be skipped most of the time.
36053 See the next section for more detail about error handling.
36054
36055 .cindex "SMTP" "passed connection"
36056 .cindex "SMTP" "batching over TCP/IP"
36057 When a message is successfully delivered over a TCP/IP SMTP connection, Exim
36058 looks in the hints database for the transport to see if there are any queued
36059 messages waiting for the host to which it is connected. If it finds one, it
36060 creates a new Exim process using the &%-MC%& option (which can only be used by
36061 a process running as root or the Exim user) and passes the TCP/IP socket to it
36062 so that it can deliver another message using the same socket. The new process
36063 does only those deliveries that are routed to the connected host, and may in
36064 turn pass the socket on to a third process, and so on.
36065
36066 The &%connection_max_messages%& option of the &(smtp)& transport can be used to
36067 limit the number of messages sent down a single TCP/IP connection.
36068
36069 .cindex "asterisk" "after IP address"
36070 The second and subsequent messages delivered down an existing connection are
36071 identified in the main log by the addition of an asterisk after the closing
36072 square bracket of the IP address.
36073
36074
36075
36076
36077 .section "Errors in outgoing SMTP" "SECToutSMTPerr"
36078 .cindex "error" "in outgoing SMTP"
36079 .cindex "SMTP" "errors in outgoing"
36080 .cindex "host" "error"
36081 Three different kinds of error are recognized for outgoing SMTP: host errors,
36082 message errors, and recipient errors.
36083
36084 .vlist
36085 .vitem "&*Host errors*&"
36086 A host error is not associated with a particular message or with a
36087 particular recipient of a message. The host errors are:
36088
36089 .ilist
36090 Connection refused or timed out,
36091 .next
36092 Any error response code on connection,
36093 .next
36094 Any error response code to EHLO or HELO,
36095 .next
36096 Loss of connection at any time, except after &"."&,
36097 .next
36098 I/O errors at any time,
36099 .next
36100 Timeouts during the session, other than in response to MAIL, RCPT or
36101 the &"."& at the end of the data.
36102 .endlist ilist
36103
36104 For a host error, a permanent error response on connection, or in response to
36105 EHLO, causes all addresses routed to the host to be failed. Any other host
36106 error causes all addresses to be deferred, and retry data to be created for the
36107 host. It is not tried again, for any message, until its retry time arrives. If
36108 the current set of addresses are not all delivered in this run (to some
36109 alternative host), the message is added to the list of those waiting for this
36110 host, so if it is still undelivered when a subsequent successful delivery is
36111 made to the host, it will be sent down the same SMTP connection.
36112
36113 .vitem "&*Message errors*&"
36114 .cindex "message" "error"
36115 A message error is associated with a particular message when sent to a
36116 particular host, but not with a particular recipient of the message. The
36117 message errors are:
36118
36119 .ilist
36120 Any error response code to MAIL, DATA, or the &"."& that terminates
36121 the data,
36122 .next
36123 Timeout after MAIL,
36124 .next
36125 Timeout or loss of connection after the &"."& that terminates the data. A
36126 timeout after the DATA command itself is treated as a host error, as is loss of
36127 connection at any other time.
36128 .endlist ilist
36129
36130 For a message error, a permanent error response (5&'xx'&) causes all addresses
36131 to be failed, and a delivery error report to be returned to the sender. A
36132 temporary error response (4&'xx'&), or one of the timeouts, causes all
36133 addresses to be deferred. Retry data is not created for the host, but instead,
36134 a retry record for the combination of host plus message id is created. The
36135 message is not added to the list of those waiting for this host. This ensures
36136 that the failing message will not be sent to this host again until the retry
36137 time arrives. However, other messages that are routed to the host are not
36138 affected, so if it is some property of the message that is causing the error,
36139 it will not stop the delivery of other mail.
36140
36141 If the remote host specified support for the SIZE parameter in its response
36142 to EHLO, Exim adds SIZE=&'nnn'& to the MAIL command, so an
36143 over-large message will cause a message error because the error arrives as a
36144 response to MAIL.
36145
36146 .vitem "&*Recipient errors*&"
36147 .cindex "recipient" "error"
36148 A recipient error is associated with a particular recipient of a message. The
36149 recipient errors are:
36150
36151 .ilist
36152 Any error response to RCPT,
36153 .next
36154 Timeout after RCPT.
36155 .endlist
36156
36157 For a recipient error, a permanent error response (5&'xx'&) causes the
36158 recipient address to be failed, and a bounce message to be returned to the
36159 sender. A temporary error response (4&'xx'&) or a timeout causes the failing
36160 address to be deferred, and routing retry data to be created for it. This is
36161 used to delay processing of the address in subsequent queue runs, until its
36162 routing retry time arrives. This applies to all messages, but because it
36163 operates only in queue runs, one attempt will be made to deliver a new message
36164 to the failing address before the delay starts to operate. This ensures that,
36165 if the failure is really related to the message rather than the recipient
36166 (&"message too big for this recipient"& is a possible example), other messages
36167 have a chance of getting delivered. If a delivery to the address does succeed,
36168 the retry information gets cleared, so all stuck messages get tried again, and
36169 the retry clock is reset.
36170
36171 The message is not added to the list of those waiting for this host. Use of the
36172 host for other messages is unaffected, and except in the case of a timeout,
36173 other recipients are processed independently, and may be successfully delivered
36174 in the current SMTP session. After a timeout it is of course impossible to
36175 proceed with the session, so all addresses get deferred. However, those other
36176 than the one that failed do not suffer any subsequent retry delays. Therefore,
36177 if one recipient is causing trouble, the others have a chance of getting
36178 through when a subsequent delivery attempt occurs before the failing
36179 recipient's retry time.
36180 .endlist
36181
36182 In all cases, if there are other hosts (or IP addresses) available for the
36183 current set of addresses (for example, from multiple MX records), they are
36184 tried in this run for any undelivered addresses, subject of course to their
36185 own retry data. In other words, recipient error retry data does not take effect
36186 until the next delivery attempt.
36187
36188 Some hosts have been observed to give temporary error responses to every
36189 MAIL command at certain times (&"insufficient space"& has been seen). It
36190 would be nice if such circumstances could be recognized, and defer data for the
36191 host itself created, but this is not possible within the current Exim design.
36192 What actually happens is that retry data for every (host, message) combination
36193 is created.
36194
36195 The reason that timeouts after MAIL and RCPT are treated specially is that
36196 these can sometimes arise as a result of the remote host's verification
36197 procedures. Exim makes this assumption, and treats them as if a temporary error
36198 response had been received. A timeout after &"."& is treated specially because
36199 it is known that some broken implementations fail to recognize the end of the
36200 message if the last character of the last line is a binary zero. Thus, it is
36201 helpful to treat this case as a message error.
36202
36203 Timeouts at other times are treated as host errors, assuming a problem with the
36204 host, or the connection to it. If a timeout after MAIL, RCPT,
36205 or &"."& is really a connection problem, the assumption is that at the next try
36206 the timeout is likely to occur at some other point in the dialogue, causing it
36207 then to be treated as a host error.
36208
36209 There is experimental evidence that some MTAs drop the connection after the
36210 terminating &"."& if they do not like the contents of the message for some
36211 reason, in contravention of the RFC, which indicates that a 5&'xx'& response
36212 should be given. That is why Exim treats this case as a message rather than a
36213 host error, in order not to delay other messages to the same host.
36214
36215
36216
36217
36218 .section "Incoming SMTP messages over TCP/IP" "SECID233"
36219 .cindex "SMTP" "incoming over TCP/IP"
36220 .cindex "incoming SMTP over TCP/IP"
36221 .cindex "inetd"
36222 .cindex "daemon"
36223 Incoming SMTP messages can be accepted in one of two ways: by running a
36224 listening daemon, or by using &'inetd'&. In the latter case, the entry in
36225 &_/etc/inetd.conf_& should be like this:
36226 .code
36227 smtp stream tcp nowait exim /opt/exim/bin/exim in.exim -bs
36228 .endd
36229 Exim distinguishes between this case and the case of a locally running user
36230 agent using the &%-bs%& option by checking whether or not the standard input is
36231 a socket. When it is, either the port must be privileged (less than 1024), or
36232 the caller must be root or the Exim user. If any other user passes a socket
36233 with an unprivileged port number, Exim prints a message on the standard error
36234 stream and exits with an error code.
36235
36236 By default, Exim does not make a log entry when a remote host connects or
36237 disconnects (either via the daemon or &'inetd'&), unless the disconnection is
36238 unexpected. It can be made to write such log entries by setting the
36239 &%smtp_connection%& log selector.
36240
36241 .cindex "carriage return"
36242 .cindex "linefeed"
36243 Commands from the remote host are supposed to be terminated by CR followed by
36244 LF. However, there are known to be hosts that do not send CR characters. In
36245 order to be able to interwork with such hosts, Exim treats LF on its own as a
36246 line terminator.
36247 Furthermore, because common code is used for receiving messages from all
36248 sources, a CR on its own is also interpreted as a line terminator. However, the
36249 sequence &"CR, dot, CR"& does not terminate incoming SMTP data.
36250
36251 .cindex "EHLO" "invalid data"
36252 .cindex "HELO" "invalid data"
36253 One area that sometimes gives rise to problems concerns the EHLO or
36254 HELO commands. Some clients send syntactically invalid versions of these
36255 commands, which Exim rejects by default. (This is nothing to do with verifying
36256 the data that is sent, so &%helo_verify_hosts%& is not relevant.) You can tell
36257 Exim not to apply a syntax check by setting &%helo_accept_junk_hosts%& to
36258 match the broken hosts that send invalid commands.
36259
36260 .cindex "SIZE option on MAIL command"
36261 .cindex "MAIL" "SIZE option"
36262 The amount of disk space available is checked whenever SIZE is received on
36263 a MAIL command, independently of whether &%message_size_limit%& or
36264 &%check_spool_space%& is configured, unless &%smtp_check_spool_space%& is set
36265 false. A temporary error is given if there is not enough space. If
36266 &%check_spool_space%& is set, the check is for that amount of space plus the
36267 value given with SIZE, that is, it checks that the addition of the incoming
36268 message will not reduce the space below the threshold.
36269
36270 When a message is successfully received, Exim includes the local message id in
36271 its response to the final &"."& that terminates the data. If the remote host
36272 logs this text it can help with tracing what has happened to a message.
36273
36274 The Exim daemon can limit the number of simultaneous incoming connections it is
36275 prepared to handle (see the &%smtp_accept_max%& option). It can also limit the
36276 number of simultaneous incoming connections from a single remote host (see the
36277 &%smtp_accept_max_per_host%& option). Additional connection attempts are
36278 rejected using the SMTP temporary error code 421.
36279
36280 The Exim daemon does not rely on the SIGCHLD signal to detect when a
36281 subprocess has finished, as this can get lost at busy times. Instead, it looks
36282 for completed subprocesses every time it wakes up. Provided there are other
36283 things happening (new incoming calls, starts of queue runs), completed
36284 processes will be noticed and tidied away. On very quiet systems you may
36285 sometimes see a &"defunct"& Exim process hanging about. This is not a problem;
36286 it will be noticed when the daemon next wakes up.
36287
36288 When running as a daemon, Exim can reserve some SMTP slots for specific hosts,
36289 and can also be set up to reject SMTP calls from non-reserved hosts at times of
36290 high system load &-- for details see the &%smtp_accept_reserve%&,
36291 &%smtp_load_reserve%&, and &%smtp_reserve_hosts%& options. The load check
36292 applies in both the daemon and &'inetd'& cases.
36293
36294 Exim normally starts a delivery process for each message received, though this
36295 can be varied by means of the &%-odq%& command line option and the
36296 &%queue_only%&, &%queue_only_file%&, and &%queue_only_load%& options. The
36297 number of simultaneously running delivery processes started in this way from
36298 SMTP input can be limited by the &%smtp_accept_queue%& and
36299 &%smtp_accept_queue_per_connection%& options. When either limit is reached,
36300 subsequently received messages are just put on the input queue without starting
36301 a delivery process.
36302
36303 The controls that involve counts of incoming SMTP calls (&%smtp_accept_max%&,
36304 &%smtp_accept_queue%&, &%smtp_accept_reserve%&) are not available when Exim is
36305 started up from the &'inetd'& daemon, because in that case each connection is
36306 handled by an entirely independent Exim process. Control by load average is,
36307 however, available with &'inetd'&.
36308
36309 Exim can be configured to verify addresses in incoming SMTP commands as they
36310 are received. See chapter &<<CHAPACL>>& for details. It can also be configured
36311 to rewrite addresses at this time &-- before any syntax checking is done. See
36312 section &<<SECTrewriteS>>&.
36313
36314 Exim can also be configured to limit the rate at which a client host submits
36315 MAIL and RCPT commands in a single SMTP session. See the
36316 &%smtp_ratelimit_hosts%& option.
36317
36318
36319
36320 .section "Unrecognized SMTP commands" "SECID234"
36321 .cindex "SMTP" "unrecognized commands"
36322 If Exim receives more than &%smtp_max_unknown_commands%& unrecognized SMTP
36323 commands during a single SMTP connection, it drops the connection after sending
36324 the error response to the last command. The default value for
36325 &%smtp_max_unknown_commands%& is 3. This is a defence against some kinds of
36326 abuse that subvert web servers into making connections to SMTP ports; in these
36327 circumstances, a number of non-SMTP lines are sent first.
36328
36329
36330 .section "Syntax and protocol errors in SMTP commands" "SECID235"
36331 .cindex "SMTP" "syntax errors"
36332 .cindex "SMTP" "protocol errors"
36333 A syntax error is detected if an SMTP command is recognized, but there is
36334 something syntactically wrong with its data, for example, a malformed email
36335 address in a RCPT command. Protocol errors include invalid command
36336 sequencing such as RCPT before MAIL. If Exim receives more than
36337 &%smtp_max_synprot_errors%& such commands during a single SMTP connection, it
36338 drops the connection after sending the error response to the last command. The
36339 default value for &%smtp_max_synprot_errors%& is 3. This is a defence against
36340 broken clients that loop sending bad commands (yes, it has been seen).
36341
36342
36343
36344 .section "Use of non-mail SMTP commands" "SECID236"
36345 .cindex "SMTP" "non-mail commands"
36346 The &"non-mail"& SMTP commands are those other than MAIL, RCPT, and
36347 DATA. Exim counts such commands, and drops the connection if there are too
36348 many of them in a single SMTP session. This action catches some
36349 denial-of-service attempts and things like repeated failing AUTHs, or a mad
36350 client looping sending EHLO. The global option &%smtp_accept_max_nonmail%&
36351 defines what &"too many"& means. Its default value is 10.
36352
36353 When a new message is expected, one occurrence of RSET is not counted. This
36354 allows a client to send one RSET between messages (this is not necessary,
36355 but some clients do it). Exim also allows one uncounted occurrence of HELO
36356 or EHLO, and one occurrence of STARTTLS between messages. After
36357 starting up a TLS session, another EHLO is expected, and so it too is not
36358 counted.
36359
36360 The first occurrence of AUTH in a connection, or immediately following
36361 STARTTLS is also not counted. Otherwise, all commands other than MAIL,
36362 RCPT, DATA, and QUIT are counted.
36363
36364 You can control which hosts are subject to the limit set by
36365 &%smtp_accept_max_nonmail%& by setting
36366 &%smtp_accept_max_nonmail_hosts%&. The default value is &`*`&, which makes
36367 the limit apply to all hosts. This option means that you can exclude any
36368 specific badly-behaved hosts that you have to live with.
36369
36370
36371
36372
36373 .section "The VRFY and EXPN commands" "SECID237"
36374 When Exim receives a VRFY or EXPN command on a TCP/IP connection, it
36375 runs the ACL specified by &%acl_smtp_vrfy%& or &%acl_smtp_expn%& (as
36376 appropriate) in order to decide whether the command should be accepted or not.
36377
36378 .cindex "VRFY" "processing"
36379 When no ACL is defined for VRFY, or if it rejects without
36380 setting an explicit response code, the command is accepted
36381 (with a 252 SMTP response code)
36382 in order to support awkward clients that do a VRFY before every RCPT.
36383 When VRFY is accepted, it runs exactly the same code as when Exim is
36384 called with the &%-bv%& option, and returns 250/451/550
36385 SMTP response codes.
36386
36387 .cindex "EXPN" "processing"
36388 If no ACL for EXPN is defined, the command is rejected.
36389 When EXPN is accepted, a single-level expansion of the address is done.
36390 EXPN is treated as an &"address test"& (similar to the &%-bt%& option) rather
36391 than a verification (the &%-bv%& option). If an unqualified local part is given
36392 as the argument to EXPN, it is qualified with &%qualify_domain%&. Rejections
36393 of VRFY and EXPN commands are logged on the main and reject logs, and
36394 VRFY verification failures are logged on the main log for consistency with
36395 RCPT failures.
36396
36397
36398
36399 .section "The ETRN command" "SECTETRN"
36400 .cindex "ETRN" "processing"
36401 .cindex "ESMTP extensions" ETRN
36402 RFC 1985 describes an ESMTP command called ETRN that is designed to
36403 overcome the security problems of the TURN command (which has fallen into
36404 disuse). When Exim receives an ETRN command on a TCP/IP connection, it runs
36405 the ACL specified by &%acl_smtp_etrn%& in order to decide whether the command
36406 should be accepted or not. If no ACL is defined, the command is rejected.
36407
36408 The ETRN command is concerned with &"releasing"& messages that are awaiting
36409 delivery to certain hosts. As Exim does not organize its message queue by host,
36410 the only form of ETRN that is supported by default is the one where the
36411 text starts with the &"#"& prefix, in which case the remainder of the text is
36412 specific to the SMTP server. A valid ETRN command causes a run of Exim with
36413 the &%-R%& option to happen, with the remainder of the ETRN text as its
36414 argument. For example,
36415 .code
36416 ETRN #brigadoon
36417 .endd
36418 runs the command
36419 .code
36420 exim -R brigadoon
36421 .endd
36422 which causes a delivery attempt on all messages with undelivered addresses
36423 containing the text &"brigadoon"&. When &%smtp_etrn_serialize%& is set (the
36424 default), Exim prevents the simultaneous execution of more than one queue run
36425 for the same argument string as a result of an ETRN command. This stops
36426 a misbehaving client from starting more than one queue runner at once.
36427
36428 .cindex "hints database" "ETRN serialization"
36429 Exim implements the serialization by means of a hints database in which a
36430 record is written whenever a process is started by ETRN, and deleted when
36431 the process completes. However, Exim does not keep the SMTP session waiting for
36432 the ETRN process to complete. Once ETRN is accepted, the client is sent
36433 a &"success"& return code. Obviously there is scope for hints records to get
36434 left lying around if there is a system or program crash. To guard against this,
36435 Exim ignores any records that are more than six hours old.
36436
36437 .oindex "&%smtp_etrn_command%&"
36438 For more control over what ETRN does, the &%smtp_etrn_command%& option can
36439 used. This specifies a command that is run whenever ETRN is received,
36440 whatever the form of its argument. For
36441 example:
36442 .code
36443 smtp_etrn_command = /etc/etrn_command $domain \
36444                     $sender_host_address
36445 .endd
36446 .vindex "&$domain$&"
36447 The string is split up into arguments which are independently expanded. The
36448 expansion variable &$domain$& is set to the argument of the ETRN command,
36449 and no syntax checking is done on the contents of this argument. Exim does not
36450 wait for the command to complete, so its status code is not checked. Exim runs
36451 under its own uid and gid when receiving incoming SMTP, so it is not possible
36452 for it to change them before running the command.
36453
36454
36455
36456 .section "Incoming local SMTP" "SECID238"
36457 .cindex "SMTP" "local incoming"
36458 Some user agents use SMTP to pass messages to their local MTA using the
36459 standard input and output, as opposed to passing the envelope on the command
36460 line and writing the message to the standard input. This is supported by the
36461 &%-bs%& option. This form of SMTP is handled in the same way as incoming
36462 messages over TCP/IP (including the use of ACLs), except that the envelope
36463 sender given in a MAIL command is ignored unless the caller is trusted. In
36464 an ACL you can detect this form of SMTP input by testing for an empty host
36465 identification. It is common to have this as the first line in the ACL that
36466 runs for RCPT commands:
36467 .code
36468 accept hosts = :
36469 .endd
36470 This accepts SMTP messages from local processes without doing any other tests.
36471
36472
36473
36474 .section "Outgoing batched SMTP" "SECTbatchSMTP"
36475 .cindex "SMTP" "batched outgoing"
36476 .cindex "batched SMTP output"
36477 Both the &(appendfile)& and &(pipe)& transports can be used for handling
36478 batched SMTP. Each has an option called &%use_bsmtp%& which causes messages to
36479 be output in BSMTP format. No SMTP responses are possible for this form of
36480 delivery. All it is doing is using SMTP commands as a way of transmitting the
36481 envelope along with the message.
36482
36483 The message is written to the file or pipe preceded by the SMTP commands
36484 MAIL and RCPT, and followed by a line containing a single dot. Lines in
36485 the message that start with a dot have an extra dot added. The SMTP command
36486 HELO is not normally used. If it is required, the &%message_prefix%& option
36487 can be used to specify it.
36488
36489 Because &(appendfile)& and &(pipe)& are both local transports, they accept only
36490 one recipient address at a time by default. However, you can arrange for them
36491 to handle several addresses at once by setting the &%batch_max%& option. When
36492 this is done for BSMTP, messages may contain multiple RCPT commands. See
36493 chapter &<<CHAPbatching>>& for more details.
36494
36495 .vindex "&$host$&"
36496 When one or more addresses are routed to a BSMTP transport by a router that
36497 sets up a host list, the name of the first host on the list is available to the
36498 transport in the variable &$host$&. Here is an example of such a transport and
36499 router:
36500 .code
36501 begin routers
36502 route_append:
36503   driver = manualroute
36504   transport = smtp_appendfile
36505   route_list = domain.example  batch.host.example
36506
36507 begin transports
36508 smtp_appendfile:
36509   driver = appendfile
36510   directory = /var/bsmtp/$host
36511   batch_max = 1000
36512   use_bsmtp
36513   user = exim
36514 .endd
36515 This causes messages addressed to &'domain.example'& to be written in BSMTP
36516 format to &_/var/bsmtp/batch.host.example_&, with only a single copy of each
36517 message (unless there are more than 1000 recipients).
36518
36519
36520
36521 .section "Incoming batched SMTP" "SECTincomingbatchedSMTP"
36522 .cindex "SMTP" "batched incoming"
36523 .cindex "batched SMTP input"
36524 The &%-bS%& command line option causes Exim to accept one or more messages by
36525 reading SMTP on the standard input, but to generate no responses. If the caller
36526 is trusted, the senders in the MAIL commands are believed; otherwise the
36527 sender is always the caller of Exim. Unqualified senders and receivers are not
36528 rejected (there seems little point) but instead just get qualified. HELO
36529 and EHLO act as RSET; VRFY, EXPN, ETRN and  HELP, act
36530 as NOOP; QUIT quits.
36531
36532 Minimal policy checking is done for BSMTP input. Only the non-SMTP
36533 ACL is run in the same way as for non-SMTP local input.
36534
36535 If an error is detected while reading a message, including a missing &"."& at
36536 the end, Exim gives up immediately. It writes details of the error to the
36537 standard output in a stylized way that the calling program should be able to
36538 make some use of automatically, for example:
36539 .code
36540 554 Unexpected end of file
36541 Transaction started in line 10
36542 Error detected in line 14
36543 .endd
36544 It writes a more verbose version, for human consumption, to the standard error
36545 file, for example:
36546 .code
36547 An error was detected while processing a file of BSMTP input.
36548 The error message was:
36549
36550 501 '>' missing at end of address
36551
36552 The SMTP transaction started in line 10.
36553 The error was detected in line 12.
36554 The SMTP command at fault was:
36555
36556 rcpt to:<malformed@in.com.plete
36557
36558 1 previous message was successfully processed.
36559 The rest of the batch was abandoned.
36560 .endd
36561 The return code from Exim is zero only if there were no errors. It is 1 if some
36562 messages were accepted before an error was detected, and 2 if no messages were
36563 accepted.
36564 .ecindex IIDsmtpproc1
36565 .ecindex IIDsmtpproc2
36566
36567
36568
36569 . ////////////////////////////////////////////////////////////////////////////
36570 . ////////////////////////////////////////////////////////////////////////////
36571
36572 .chapter "Customizing bounce and warning messages" "CHAPemsgcust" &&&
36573          "Customizing messages"
36574 When a message fails to be delivered, or remains in the queue for more than a
36575 configured amount of time, Exim sends a message to the original sender, or
36576 to an alternative configured address. The text of these messages is built into
36577 the code of Exim, but it is possible to change it, either by adding a single
36578 string, or by replacing each of the paragraphs by text supplied in a file.
36579
36580 The &'From:'& and &'To:'& header lines are automatically generated; you can
36581 cause a &'Reply-To:'& line to be added by setting the &%errors_reply_to%&
36582 option. Exim also adds the line
36583 .code
36584 Auto-Submitted: auto-generated
36585 .endd
36586 to all warning and bounce messages,
36587
36588
36589 .section "Customizing bounce messages" "SECID239"
36590 .cindex "customizing" "bounce message"
36591 .cindex "bounce message" "customizing"
36592 If &%bounce_message_text%& is set, its contents are included in the default
36593 message immediately after &"This message was created automatically by mail
36594 delivery software."& The string is not expanded. It is not used if
36595 &%bounce_message_file%& is set.
36596
36597 When &%bounce_message_file%& is set, it must point to a template file for
36598 constructing error messages. The file consists of a series of text items,
36599 separated by lines consisting of exactly four asterisks. If the file cannot be
36600 opened, default text is used and a message is written to the main and panic
36601 logs. If any text item in the file is empty, default text is used for that
36602 item.
36603
36604 .vindex "&$bounce_recipient$&"
36605 .vindex "&$bounce_return_size_limit$&"
36606 Each item of text that is read from the file is expanded, and there are two
36607 expansion variables which can be of use here: &$bounce_recipient$& is set to
36608 the recipient of an error message while it is being created, and
36609 &$bounce_return_size_limit$& contains the value of the &%return_size_limit%&
36610 option, rounded to a whole number.
36611
36612 The items must appear in the file in the following order:
36613
36614 .ilist
36615 The first item is included in the headers, and should include at least a
36616 &'Subject:'& header. Exim does not check the syntax of these headers.
36617 .next
36618 The second item forms the start of the error message. After it, Exim lists the
36619 failing addresses with their error messages.
36620 .next
36621 The third item is used to introduce any text from pipe transports that is to be
36622 returned to the sender. It is omitted if there is no such text.
36623 .next
36624 The fourth, fifth and sixth items will be ignored and may be empty.
36625 The fields exist for back-compatibility
36626 .endlist
36627
36628 The default state (&%bounce_message_file%& unset) is equivalent to the
36629 following file, in which the sixth item is empty. The &'Subject:'& and some
36630 other lines have been split in order to fit them on the page:
36631 .code
36632 Subject: Mail delivery failed
36633   ${if eq{$sender_address}{$bounce_recipient}
36634   {: returning message to sender}}
36635 ****
36636 This message was created automatically by mail delivery software.
36637
36638 A message ${if eq{$sender_address}{$bounce_recipient}
36639   {that you sent }{sent by
36640
36641 <$sender_address>
36642
36643 }}could not be delivered to all of its recipients.
36644 This is a permanent error. The following address(es) failed:
36645 ****
36646 The following text was generated during the delivery attempt(s):
36647 ****
36648 ------ This is a copy of the message, including all the headers.
36649   ------
36650 ****
36651 ------ The body of the message is $message_size characters long;
36652   only the first
36653 ------ $bounce_return_size_limit or so are included here.
36654 ****
36655 .endd
36656 .section "Customizing warning messages" "SECTcustwarn"
36657 .cindex "customizing" "warning message"
36658 .cindex "warning of delay" "customizing the message"
36659 The option &%warn_message_file%& can be pointed at a template file for use when
36660 warnings about message delays are created. In this case there are only three
36661 text sections:
36662
36663 .ilist
36664 The first item is included in the headers, and should include at least a
36665 &'Subject:'& header. Exim does not check the syntax of these headers.
36666 .next
36667 The second item forms the start of the warning message. After it, Exim lists
36668 the delayed addresses.
36669 .next
36670 The third item then ends the message.
36671 .endlist
36672
36673 The default state is equivalent to the following file, except that some lines
36674 have been split here, in order to fit them on the page:
36675 .code
36676 Subject: Warning: message $message_exim_id delayed
36677   $warn_message_delay
36678 ****
36679 This message was created automatically by mail delivery software.
36680
36681 A message ${if eq{$sender_address}{$warn_message_recipients}
36682 {that you sent }{sent by
36683
36684 <$sender_address>
36685
36686 }}has not been delivered to all of its recipients after
36687 more than $warn_message_delay in the queue on $primary_hostname.
36688
36689 The message identifier is:     $message_exim_id
36690 The subject of the message is: $h_subject
36691 The date of the message is:    $h_date
36692
36693 The following address(es) have not yet been delivered:
36694 ****
36695 No action is required on your part. Delivery attempts will
36696 continue for some time, and this warning may be repeated at
36697 intervals if the message remains undelivered. Eventually the
36698 mail delivery software will give up, and when that happens,
36699 the message will be returned to you.
36700 .endd
36701 .vindex "&$warn_message_delay$&"
36702 .vindex "&$warn_message_recipients$&"
36703 However, in the default state the subject and date lines are omitted if no
36704 appropriate headers exist. During the expansion of this file,
36705 &$warn_message_delay$& is set to the delay time in one of the forms &"<&'n'&>
36706 minutes"& or &"<&'n'&> hours"&, and &$warn_message_recipients$& contains a list
36707 of recipients for the warning message. There may be more than one if there are
36708 multiple addresses with different &%errors_to%& settings on the routers that
36709 handled them.
36710
36711
36712
36713
36714 . ////////////////////////////////////////////////////////////////////////////
36715 . ////////////////////////////////////////////////////////////////////////////
36716
36717 .chapter "Some common configuration settings" "CHAPcomconreq"
36718 This chapter discusses some configuration settings that seem to be fairly
36719 common. More examples and discussion can be found in the Exim book.
36720
36721
36722
36723 .section "Sending mail to a smart host" "SECID240"
36724 .cindex "smart host" "example router"
36725 If you want to send all mail for non-local domains to a &"smart host"&, you
36726 should replace the default &(dnslookup)& router with a router which does the
36727 routing explicitly:
36728 .code
36729 send_to_smart_host:
36730   driver = manualroute
36731   route_list = !+local_domains smart.host.name
36732   transport = remote_smtp
36733 .endd
36734 You can use the smart host's IP address instead of the name if you wish.
36735 If you are using Exim only to submit messages to a smart host, and not for
36736 receiving incoming messages, you can arrange for it to do the submission
36737 synchronously by setting the &%mua_wrapper%& option (see chapter
36738 &<<CHAPnonqueueing>>&).
36739
36740
36741
36742
36743 .section "Using Exim to handle mailing lists" "SECTmailinglists"
36744 .cindex "mailing lists"
36745 Exim can be used to run simple mailing lists, but for large and/or complicated
36746 requirements, the use of additional specialized mailing list software such as
36747 Majordomo or Mailman is recommended.
36748
36749 The &(redirect)& router can be used to handle mailing lists where each list
36750 is maintained in a separate file, which can therefore be managed by an
36751 independent manager. The &%domains%& router option can be used to run these
36752 lists in a separate domain from normal mail. For example:
36753 .code
36754 lists:
36755   driver = redirect
36756   domains = lists.example
36757   file = ${lookup {$local_part} dsearch,ret=full {/usr/lists}}
36758   forbid_pipe
36759   forbid_file
36760   errors_to = ${quote_local_part:$local_part-request}@lists.example
36761   no_more
36762 .endd
36763 This router is skipped for domains other than &'lists.example'&. For addresses
36764 in that domain, it looks for a file that matches the local part. If there is no
36765 such file, the router declines, but because &%no_more%& is set, no subsequent
36766 routers are tried, and so the whole delivery fails.
36767
36768 The &%forbid_pipe%& and &%forbid_file%& options prevent a local part from being
36769 expanded into a filename or a pipe delivery, which is usually inappropriate in
36770 a mailing list.
36771
36772 .oindex "&%errors_to%&"
36773 The &%errors_to%& option specifies that any delivery errors caused by addresses
36774 taken from a mailing list are to be sent to the given address rather than the
36775 original sender of the message. However, before acting on this, Exim verifies
36776 the error address, and ignores it if verification fails.
36777
36778 For example, using the configuration above, mail sent to
36779 &'dicts@lists.example'& is passed on to those addresses contained in
36780 &_/usr/lists/dicts_&, with error reports directed to
36781 &'dicts-request@lists.example'&, provided that this address can be verified.
36782 There could be a file called &_/usr/lists/dicts-request_& containing
36783 the address(es) of this particular list's manager(s), but other approaches,
36784 such as setting up an earlier router (possibly using the &%local_part_prefix%&
36785 or &%local_part_suffix%& options) to handle addresses of the form
36786 &%owner-%&&'xxx'& or &%xxx-%&&'request'&, are also possible.
36787
36788
36789
36790 .section "Syntax errors in mailing lists" "SECID241"
36791 .cindex "mailing lists" "syntax errors in"
36792 If an entry in redirection data contains a syntax error, Exim normally defers
36793 delivery of the original address. That means that a syntax error in a mailing
36794 list holds up all deliveries to the list. This may not be appropriate when a
36795 list is being maintained automatically from data supplied by users, and the
36796 addresses are not rigorously checked.
36797
36798 If the &%skip_syntax_errors%& option is set, the &(redirect)& router just skips
36799 entries that fail to parse, noting the incident in the log. If in addition
36800 &%syntax_errors_to%& is set to a verifiable address, a message is sent to it
36801 whenever a broken address is skipped. It is usually appropriate to set
36802 &%syntax_errors_to%& to the same address as &%errors_to%&.
36803
36804
36805
36806 .section "Re-expansion of mailing lists" "SECID242"
36807 .cindex "mailing lists" "re-expansion of"
36808 Exim remembers every individual address to which a message has been delivered,
36809 in order to avoid duplication, but it normally stores only the original
36810 recipient addresses with a message. If all the deliveries to a mailing list
36811 cannot be done at the first attempt, the mailing list is re-expanded when the
36812 delivery is next tried. This means that alterations to the list are taken into
36813 account at each delivery attempt, so addresses that have been added to
36814 the list since the message arrived will therefore receive a copy of the
36815 message, even though it pre-dates their subscription.
36816
36817 If this behaviour is felt to be undesirable, the &%one_time%& option can be set
36818 on the &(redirect)& router. If this is done, any addresses generated by the
36819 router that fail to deliver at the first attempt are added to the message as
36820 &"top level"& addresses, and the parent address that generated them is marked
36821 &"delivered"&. Thus, expansion of the mailing list does not happen again at the
36822 subsequent delivery attempts. The disadvantage of this is that if any of the
36823 failing addresses are incorrect, correcting them in the file has no effect on
36824 pre-existing messages.
36825
36826 The original top-level address is remembered with each of the generated
36827 addresses, and is output in any log messages. However, any intermediate parent
36828 addresses are not recorded. This makes a difference to the log only if the
36829 &%all_parents%& selector is set, but for mailing lists there is normally only
36830 one level of expansion anyway.
36831
36832
36833
36834 .section "Closed mailing lists" "SECID243"
36835 .cindex "mailing lists" "closed"
36836 The examples so far have assumed open mailing lists, to which anybody may
36837 send mail. It is also possible to set up closed lists, where mail is accepted
36838 from specified senders only. This is done by making use of the generic
36839 &%senders%& option to restrict the router that handles the list.
36840
36841 The following example uses the same file as a list of recipients and as a list
36842 of permitted senders. It requires three routers:
36843 .code
36844 lists_request:
36845   driver = redirect
36846   domains = lists.example
36847   local_part_suffix = -request
36848   local_parts = ${lookup {$local_part} dsearch,filter=file {/usr/lists}}
36849   file = /usr/lists/${local_part_data}-request
36850   no_more
36851
36852 lists_post:
36853   driver = redirect
36854   domains = lists.example
36855   senders = ${if exists {/usr/lists/$local_part}\
36856              {lsearch;/usr/lists/$local_part}{*}}
36857   file = ${lookup {$local_part} dsearch,ret=full {/usr/lists}}
36858   forbid_pipe
36859   forbid_file
36860   errors_to = ${quote_local_part:$local_part-request}@lists.example
36861   no_more
36862
36863 lists_closed:
36864   driver = redirect
36865   domains = lists.example
36866   allow_fail
36867   data = :fail: $local_part@lists.example is a closed mailing list
36868 .endd
36869 All three routers have the same &%domains%& setting, so for any other domains,
36870 they are all skipped. The first router runs only if the local part ends in
36871 &%-request%&. It handles messages to the list manager(s) by means of an open
36872 mailing list.
36873
36874 The second router runs only if the &%senders%& precondition is satisfied. It
36875 checks for the existence of a list that corresponds to the local part, and then
36876 checks that the sender is on the list by means of a linear search. It is
36877 necessary to check for the existence of the file before trying to search it,
36878 because otherwise Exim thinks there is a configuration error. If the file does
36879 not exist, the expansion of &%senders%& is *, which matches all senders. This
36880 means that the router runs, but because there is no list, declines, and
36881 &%no_more%& ensures that no further routers are run. The address fails with an
36882 &"unrouteable address"& error.
36883
36884 The third router runs only if the second router is skipped, which happens when
36885 a mailing list exists, but the sender is not on it. This router forcibly fails
36886 the address, giving a suitable error message.
36887
36888
36889
36890
36891 .section "Variable Envelope Return Paths (VERP)" "SECTverp"
36892 .cindex "VERP"
36893 .cindex "Variable Envelope Return Paths"
36894 .cindex "envelope from"
36895 .cindex "envelope sender"
36896 Variable Envelope Return Paths &-- see &url(https://cr.yp.to/proto/verp.txt) &--
36897 are a way of helping mailing list administrators discover which subscription
36898 address is the cause of a particular delivery failure. The idea is to encode
36899 the original recipient address in the outgoing envelope sender address, so that
36900 if the message is forwarded by another host and then subsequently bounces, the
36901 original recipient can be extracted from the recipient address of the bounce.
36902
36903 .oindex &%errors_to%&
36904 .oindex &%return_path%&
36905 Envelope sender addresses can be modified by Exim using two different
36906 facilities: the &%errors_to%& option on a router (as shown in previous mailing
36907 list examples), or the &%return_path%& option on a transport. The second of
36908 these is effective only if the message is successfully delivered to another
36909 host; it is not used for errors detected on the local host (see the description
36910 of &%return_path%& in chapter &<<CHAPtransportgeneric>>&). Here is an example
36911 of the use of &%return_path%& to implement VERP on an &(smtp)& transport:
36912 .code
36913 verp_smtp:
36914   driver = smtp
36915   max_rcpt = 1
36916   return_path = \
36917     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
36918       {${quote_local_part:$1-request+$local_part=$domain}@your.dom.example}fail}
36919 .endd
36920 This has the effect of rewriting the return path (envelope sender) on outgoing
36921 SMTP messages, if the local part of the original return path ends in
36922 &"-request"&, and the domain is &'your.dom.example'&. The rewriting inserts the
36923 local part and domain of the recipient into the return path. Suppose, for
36924 example, that a message whose return path has been set to
36925 &'somelist-request@your.dom.example'& is sent to
36926 &'subscriber@other.dom.example'&. In the transport, the return path is
36927 rewritten as
36928 .code
36929 somelist-request+subscriber=other.dom.example@your.dom.example
36930 .endd
36931 .vindex "&$local_part$&"
36932 For this to work, you must tell Exim to send multiple copies of messages that
36933 have more than one recipient, so that each copy has just one recipient. This is
36934 achieved by setting &%max_rcpt%& to 1. Without this, a single copy of a message
36935 might be sent to several different recipients in the same domain, in which case
36936 &$local_part$& is not available in the transport, because it is not unique.
36937
36938 Unless your host is doing nothing but mailing list deliveries, you should
36939 probably use a separate transport for the VERP deliveries, so as not to use
36940 extra resources in making one-per-recipient copies for other deliveries. This
36941 can easily be done by expanding the &%transport%& option in the router:
36942 .code
36943 dnslookup:
36944   driver = dnslookup
36945   domains = ! +local_domains
36946   transport = \
36947     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
36948       {verp_smtp}{remote_smtp}}
36949   no_more
36950 .endd
36951 If you want to change the return path using &%errors_to%& in a router instead
36952 of using &%return_path%& in the transport, you need to set &%errors_to%& on all
36953 routers that handle mailing list addresses. This will ensure that all delivery
36954 errors, including those detected on the local host, are sent to the VERP
36955 address.
36956
36957 On a host that does no local deliveries and has no manual routing, only the
36958 &(dnslookup)& router needs to be changed. A special transport is not needed for
36959 SMTP deliveries. Every mailing list recipient has its own return path value,
36960 and so Exim must hand them to the transport one at a time. Here is an example
36961 of a &(dnslookup)& router that implements VERP:
36962 .code
36963 verp_dnslookup:
36964   driver = dnslookup
36965   domains = ! +local_domains
36966   transport = remote_smtp
36967   errors_to = \
36968     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}}
36969      {${quote_local_part:$1-request+$local_part=$domain}@your.dom.example}fail}
36970   no_more
36971 .endd
36972 Before you start sending out messages with VERPed return paths, you must also
36973 configure Exim to accept the bounce messages that come back to those paths.
36974 Typically this is done by setting a &%local_part_suffix%& option for a
36975 router, and using this to route the messages to wherever you want to handle
36976 them.
36977
36978 The overhead incurred in using VERP depends very much on the size of the
36979 message, the number of recipient addresses that resolve to the same remote
36980 host, and the speed of the connection over which the message is being sent. If
36981 a lot of addresses resolve to the same host and the connection is slow, sending
36982 a separate copy of the message for each address may take substantially longer
36983 than sending a single copy with many recipients (for which VERP cannot be
36984 used).
36985
36986
36987
36988
36989
36990
36991 .section "Virtual domains" "SECTvirtualdomains"
36992 .cindex "virtual domains"
36993 .cindex "domain" "virtual"
36994 The phrase &'virtual domain'& is unfortunately used with two rather different
36995 meanings:
36996
36997 .ilist
36998 A domain for which there are no real mailboxes; all valid local parts are
36999 aliases for other email addresses. Common examples are organizational
37000 top-level domains and &"vanity"& domains.
37001 .next
37002 One of a number of independent domains that are all handled by the same host,
37003 with mailboxes on that host, but where the mailbox owners do not necessarily
37004 have login accounts on that host.
37005 .endlist
37006
37007 The first usage is probably more common, and does seem more &"virtual"& than
37008 the second. This kind of domain can be handled in Exim with a straightforward
37009 aliasing router. One approach is to create a separate alias file for each
37010 virtual domain. Exim can test for the existence of the alias file to determine
37011 whether the domain exists. The &(dsearch)& lookup type is useful here, leading
37012 to a router of this form:
37013 .code
37014 virtual:
37015   driver = redirect
37016   domains = dsearch;/etc/mail/virtual
37017   data = ${lookup{$local_part}lsearch{/etc/mail/virtual/$domain_data}}
37018   no_more
37019 .endd
37020 .new
37021 The &%domains%& option specifies that the router is to be skipped, unless there
37022 is a file in the &_/etc/mail/virtual_& directory whose name is the same as the
37023 domain that is being processed.
37024 The &(dsearch)& lookup used results in an untainted version of &$domain$&
37025 being placed into the &$domain_data$& variable.
37026 .wen
37027
37028 When the router runs, it looks up the local
37029 part in the file to find a new address (or list of addresses). The &%no_more%&
37030 setting ensures that if the lookup fails (leading to &%data%& being an empty
37031 string), Exim gives up on the address without trying any subsequent routers.
37032
37033 This one router can handle all the virtual domains because the alias filenames
37034 follow a fixed pattern. Permissions can be arranged so that appropriate people
37035 can edit the different alias files. A successful aliasing operation results in
37036 a new envelope recipient address, which is then routed from scratch.
37037
37038 The other kind of &"virtual"& domain can also be handled in a straightforward
37039 way. One approach is to create a file for each domain containing a list of
37040 valid local parts, and use it in a router like this:
37041 .code
37042 my_domains:
37043   driver = accept
37044   domains = dsearch;/etc/mail/domains
37045   local_parts = lsearch;/etc/mail/domains/$domain
37046   transport = my_mailboxes
37047 .endd
37048 The address is accepted if there is a file for the domain, and the local part
37049 can be found in the file. The &%domains%& option is used to check for the
37050 file's existence because &%domains%& is tested before the &%local_parts%&
37051 option (see section &<<SECTrouprecon>>&). You cannot use &%require_files%&,
37052 because that option is tested after &%local_parts%&. The transport is as
37053 follows:
37054 .code
37055 my_mailboxes:
37056   driver = appendfile
37057   file = /var/mail/$domain/$local_part_data
37058   user = mail
37059 .endd
37060 This uses a directory of mailboxes for each domain. The &%user%& setting is
37061 required, to specify which uid is to be used for writing to the mailboxes.
37062
37063 The configuration shown here is just one example of how you might support this
37064 requirement. There are many other ways this kind of configuration can be set
37065 up, for example, by using a database instead of separate files to hold all the
37066 information about the domains.
37067
37068
37069
37070 .section "Multiple user mailboxes" "SECTmulbox"
37071 .cindex "multiple mailboxes"
37072 .cindex "mailbox" "multiple"
37073 .cindex "local part" "prefix"
37074 .cindex "local part" "suffix"
37075 Heavy email users often want to operate with multiple mailboxes, into which
37076 incoming mail is automatically sorted. A popular way of handling this is to
37077 allow users to use multiple sender addresses, so that replies can easily be
37078 identified. Users are permitted to add prefixes or suffixes to their local
37079 parts for this purpose. The wildcard facility of the generic router options
37080 &%local_part_prefix%& and &%local_part_suffix%& can be used for this. For
37081 example, consider this router:
37082 .code
37083 userforward:
37084   driver = redirect
37085   check_local_user
37086   file = $home/.forward
37087   local_part_suffix = -*
37088   local_part_suffix_optional
37089   allow_filter
37090 .endd
37091 .vindex "&$local_part_suffix$&"
37092 It runs a user's &_.forward_& file for all local parts of the form
37093 &'username-*'&. Within the filter file the user can distinguish different
37094 cases by testing the variable &$local_part_suffix$&. For example:
37095 .code
37096 if $local_part_suffix contains -special then
37097 save /home/$local_part/Mail/special
37098 endif
37099 .endd
37100 If the filter file does not exist, or does not deal with such addresses, they
37101 fall through to subsequent routers, and, assuming no subsequent use of the
37102 &%local_part_suffix%& option is made, they presumably fail. Thus, users have
37103 control over which suffixes are valid.
37104
37105 Alternatively, a suffix can be used to trigger the use of a different
37106 &_.forward_& file &-- which is the way a similar facility is implemented in
37107 another MTA:
37108 .code
37109 userforward:
37110   driver = redirect
37111   check_local_user
37112   local_part_suffix = -*
37113   local_part_suffix_optional
37114   file = ${lookup {.forward$local_part_suffix} dsearch,ret=full {$home} {$value}fail}
37115   allow_filter
37116 .endd
37117 If there is no suffix, &_.forward_& is used; if the suffix is &'-special'&, for
37118 example, &_.forward-special_& is used. Once again, if the appropriate file
37119 does not exist, or does not deal with the address, it is passed on to
37120 subsequent routers, which could, if required, look for an unqualified
37121 &_.forward_& file to use as a default.
37122
37123
37124
37125 .section "Simplified vacation processing" "SECID244"
37126 .cindex "vacation processing"
37127 The traditional way of running the &'vacation'& program is for a user to set up
37128 a pipe command in a &_.forward_& file
37129 (see section &<<SECTspecitredli>>& for syntax details).
37130 This is prone to error by inexperienced users. There are two features of Exim
37131 that can be used to make this process simpler for users:
37132
37133 .ilist
37134 A local part prefix such as &"vacation-"& can be specified on a router which
37135 can cause the message to be delivered directly to the &'vacation'& program, or
37136 alternatively can use Exim's &(autoreply)& transport. The contents of a user's
37137 &_.forward_& file are then much simpler. For example:
37138 .code
37139 spqr, vacation-spqr
37140 .endd
37141 .next
37142 The &%require_files%& generic router option can be used to trigger a
37143 vacation delivery by checking for the existence of a certain file in the
37144 user's home directory. The &%unseen%& generic option should also be used, to
37145 ensure that the original delivery also proceeds. In this case, all the user has
37146 to do is to create a file called, say, &_.vacation_&, containing a vacation
37147 message.
37148 .endlist
37149
37150 Another advantage of both these methods is that they both work even when the
37151 use of arbitrary pipes by users is locked out.
37152
37153
37154
37155 .section "Taking copies of mail" "SECID245"
37156 .cindex "message" "copying every"
37157 Some installations have policies that require archive copies of all messages to
37158 be made. A single copy of each message can easily be taken by an appropriate
37159 command in a system filter, which could, for example, use a different file for
37160 each day's messages.
37161
37162 There is also a shadow transport mechanism that can be used to take copies of
37163 messages that are successfully delivered by local transports, one copy per
37164 delivery. This could be used, &'inter alia'&, to implement automatic
37165 notification of delivery by sites that insist on doing such things.
37166
37167
37168
37169 .section "Intermittently connected hosts" "SECID246"
37170 .cindex "intermittently connected hosts"
37171 It has become quite common (because it is cheaper) for hosts to connect to the
37172 Internet periodically rather than remain connected all the time. The normal
37173 arrangement is that mail for such hosts accumulates on a system that is
37174 permanently connected.
37175
37176 Exim was designed for use on permanently connected hosts, and so it is not
37177 particularly well-suited to use in an intermittently connected environment.
37178 Nevertheless there are some features that can be used.
37179
37180
37181 .section "Exim on the upstream server host" "SECID247"
37182 It is tempting to arrange for incoming mail for the intermittently connected
37183 host to remain in Exim's queue until the client connects. However, this
37184 approach does not scale very well. Two different kinds of waiting message are
37185 being mixed up in the same queue &-- those that cannot be delivered because of
37186 some temporary problem, and those that are waiting for their destination host
37187 to connect. This makes it hard to manage the queue, as well as wasting
37188 resources, because each queue runner scans the entire queue.
37189
37190 A better approach is to separate off those messages that are waiting for an
37191 intermittently connected host. This can be done by delivering these messages
37192 into local files in batch SMTP, &"mailstore"&, or other envelope-preserving
37193 format, from where they are transmitted by other software when their
37194 destination connects. This makes it easy to collect all the mail for one host
37195 in a single directory, and to apply local timeout rules on a per-message basis
37196 if required.
37197
37198 On a very small scale, leaving the mail on Exim's queue can be made to work. If
37199 you are doing this, you should configure Exim with a long retry period for the
37200 intermittent host. For example:
37201 .code
37202 cheshire.wonderland.fict.example    *   F,5d,24h
37203 .endd
37204 This stops a lot of failed delivery attempts from occurring, but Exim remembers
37205 which messages it has queued up for that host. Once the intermittent host comes
37206 online, forcing delivery of one message (either by using the &%-M%& or &%-R%&
37207 options, or by using the ETRN SMTP command (see section &<<SECTETRN>>&)
37208 causes all the queued up messages to be delivered, often down a single SMTP
37209 connection. While the host remains connected, any new messages get delivered
37210 immediately.
37211
37212 If the connecting hosts do not have fixed IP addresses, that is, if a host is
37213 issued with a different IP address each time it connects, Exim's retry
37214 mechanisms on the holding host get confused, because the IP address is normally
37215 used as part of the key string for holding retry information. This can be
37216 avoided by unsetting &%retry_include_ip_address%& on the &(smtp)& transport.
37217 Since this has disadvantages for permanently connected hosts, it is best to
37218 arrange a separate transport for the intermittently connected ones.
37219
37220
37221
37222 .section "Exim on the intermittently connected client host" "SECID248"
37223 The value of &%smtp_accept_queue_per_connection%& should probably be
37224 increased, or even set to zero (that is, disabled) on the intermittently
37225 connected host, so that all incoming messages down a single connection get
37226 delivered immediately.
37227
37228 .cindex "SMTP" "passed connection"
37229 .cindex "SMTP" "multiple deliveries"
37230 .cindex "multiple SMTP deliveries"
37231 .cindex "first pass routing"
37232 Mail waiting to be sent from an intermittently connected host will probably
37233 not have been routed, because without a connection DNS lookups are not
37234 possible. This means that if a normal queue run is done at connection time,
37235 each message is likely to be sent in a separate SMTP session. This can be
37236 avoided by starting the queue run with a command line option beginning with
37237 &%-qq%& instead of &%-q%&. In this case, the queue is scanned twice. In the
37238 first pass, routing is done but no deliveries take place. The second pass is a
37239 normal queue run; since all the messages have been previously routed, those
37240 destined for the same host are likely to get sent as multiple deliveries in a
37241 single SMTP connection.
37242
37243
37244
37245 . ////////////////////////////////////////////////////////////////////////////
37246 . ////////////////////////////////////////////////////////////////////////////
37247
37248 .chapter "Using Exim as a non-queueing client" "CHAPnonqueueing" &&&
37249          "Exim as a non-queueing client"
37250 .cindex "client, non-queueing"
37251 .cindex "smart host" "suppressing queueing"
37252 On a personal computer, it is a common requirement for all
37253 email to be sent to a &"smart host"&. There are plenty of MUAs that can be
37254 configured to operate that way, for all the popular operating systems.
37255 However, there are some MUAs for Unix-like systems that cannot be so
37256 configured: they submit messages using the command line interface of
37257 &_/usr/sbin/sendmail_&. Furthermore, utility programs such as &'cron'& submit
37258 messages this way.
37259
37260 If the personal computer runs continuously, there is no problem, because it can
37261 run a conventional MTA that handles delivery to the smart host, and deal with
37262 any delays via its queueing mechanism. However, if the computer does not run
37263 continuously or runs different operating systems at different times, queueing
37264 email is not desirable.
37265
37266 There is therefore a requirement for something that can provide the
37267 &_/usr/sbin/sendmail_& interface but deliver messages to a smart host without
37268 any queueing or retrying facilities. Furthermore, the delivery to the smart
37269 host should be synchronous, so that if it fails, the sending MUA is immediately
37270 informed. In other words, we want something that extends an MUA that submits
37271 to a local MTA via the command line so that it behaves like one that submits
37272 to a remote smart host using TCP/SMTP.
37273
37274 There are a number of applications (for example, there is one called &'ssmtp'&)
37275 that do this job. However, people have found them to be lacking in various
37276 ways. For instance, you might want to allow aliasing and forwarding to be done
37277 before sending a message to the smart host.
37278
37279 Exim already had the necessary infrastructure for doing this job. Just a few
37280 tweaks were needed to make it behave as required, though it is somewhat of an
37281 overkill to use a fully-featured MTA for this purpose.
37282
37283 .oindex "&%mua_wrapper%&"
37284 There is a Boolean global option called &%mua_wrapper%&, defaulting false.
37285 Setting &%mua_wrapper%& true causes Exim to run in a special mode where it
37286 assumes that it is being used to &"wrap"& a command-line MUA in the manner
37287 just described. As well as setting &%mua_wrapper%&, you also need to provide a
37288 compatible router and transport configuration. Typically there will be just one
37289 router and one transport, sending everything to a smart host.
37290
37291 When run in MUA wrapping mode, the behaviour of Exim changes in the
37292 following ways:
37293
37294 .ilist
37295 A daemon cannot be run, nor will Exim accept incoming messages from &'inetd'&.
37296 In other words, the only way to submit messages is via the command line.
37297 .next
37298 Each message is synchronously delivered as soon as it is received (&%-odi%& is
37299 assumed). All queueing options (&%queue_only%&, &%queue_smtp_domains%&,
37300 &%control%& in an ACL, etc.) are quietly ignored. The Exim reception process
37301 does not finish until the delivery attempt is complete. If the delivery is
37302 successful, a zero return code is given.
37303 .next
37304 Address redirection is permitted, but the final routing for all addresses must
37305 be to the same remote transport, and to the same list of hosts. Furthermore,
37306 the return address (envelope sender) must be the same for all recipients, as
37307 must any added or deleted header lines. In other words, it must be possible to
37308 deliver the message in a single SMTP transaction, however many recipients there
37309 are.
37310 .next
37311 If these conditions are not met, or if routing any address results in a
37312 failure or defer status, or if Exim is unable to deliver all the recipients
37313 successfully to one of the smart hosts, delivery of the entire message fails.
37314 .next
37315 Because no queueing is allowed, all failures are treated as permanent; there
37316 is no distinction between 4&'xx'& and 5&'xx'& SMTP response codes from the
37317 smart host. Furthermore, because only a single yes/no response can be given to
37318 the caller, it is not possible to deliver to some recipients and not others. If
37319 there is an error (temporary or permanent) for any recipient, all are failed.
37320 .next
37321 If more than one smart host is listed, Exim will try another host after a
37322 connection failure or a timeout, in the normal way. However, if this kind of
37323 failure happens for all the hosts, the delivery fails.
37324 .next
37325 When delivery fails, an error message is written to the standard error stream
37326 (as well as to Exim's log), and Exim exits to the caller with a return code
37327 value 1. The message is expunged from Exim's spool files. No bounce messages
37328 are ever generated.
37329 .next
37330 No retry data is maintained, and any retry rules are ignored.
37331 .next
37332 A number of Exim options are overridden: &%deliver_drop_privilege%& is forced
37333 true, &%max_rcpt%& in the &(smtp)& transport is forced to &"unlimited"&,
37334 &%remote_max_parallel%& is forced to one, and fallback hosts are ignored.
37335 .endlist
37336
37337 The overall effect is that Exim makes a single synchronous attempt to deliver
37338 the message, failing if there is any kind of problem. Because no local
37339 deliveries are done and no daemon can be run, Exim does not need root
37340 privilege. It should be possible to run it setuid to &'exim'& instead of setuid
37341 to &'root'&. See section &<<SECTrunexiwitpri>>& for a general discussion about
37342 the advantages and disadvantages of running without root privilege.
37343
37344
37345
37346
37347 . ////////////////////////////////////////////////////////////////////////////
37348 . ////////////////////////////////////////////////////////////////////////////
37349
37350 .chapter "Log files" "CHAPlog"
37351 .scindex IIDloggen "log" "general description"
37352 .cindex "log" "types of"
37353 Exim writes three different logs, referred to as the main log, the reject log,
37354 and the panic log:
37355
37356 .ilist
37357 .cindex "main log"
37358 The main log records the arrival of each message and each delivery in a single
37359 line in each case. The format is as compact as possible, in an attempt to keep
37360 down the size of log files. Two-character flag sequences make it easy to pick
37361 out these lines. A number of other events are recorded in the main log. Some of
37362 them are optional, in which case the &%log_selector%& option controls whether
37363 they are included or not. A Perl script called &'eximstats'&, which does simple
37364 analysis of main log files, is provided in the Exim distribution (see section
37365 &<<SECTmailstat>>&).
37366 .next
37367 .cindex "reject log"
37368 The reject log records information from messages that are rejected as a result
37369 of a configuration option (that is, for policy reasons).
37370 The first line of each rejection is a copy of the line that is also written to
37371 the main log. Then, if the message's header has been read at the time the log
37372 is written, its contents are written to this log. Only the original header
37373 lines are available; header lines added by ACLs are not logged. You can use the
37374 reject log to check that your policy controls are working correctly; on a busy
37375 host this may be easier than scanning the main log for rejection messages. You
37376 can suppress the writing of the reject log by setting &%write_rejectlog%&
37377 false.
37378 .next
37379 .cindex "panic log"
37380 .cindex "system log"
37381 When certain serious errors occur, Exim writes entries to its panic log. If the
37382 error is sufficiently disastrous, Exim bombs out afterwards. Panic log entries
37383 are usually written to the main log as well, but can get lost amid the mass of
37384 other entries. The panic log should be empty under normal circumstances. It is
37385 therefore a good idea to check it (or to have a &'cron'& script check it)
37386 regularly, in order to become aware of any problems. When Exim cannot open its
37387 panic log, it tries as a last resort to write to the system log (syslog). This
37388 is opened with LOG_PID+LOG_CONS and the facility code of LOG_MAIL. The
37389 message itself is written at priority LOG_CRIT.
37390 .endlist
37391
37392 Every log line starts with a timestamp, in the format shown in the following
37393 example. Note that many of the examples shown in this chapter are line-wrapped.
37394 In the log file, this would be all on one line:
37395 .code
37396 2001-09-16 16:09:47 SMTP connection from [127.0.0.1] closed
37397   by QUIT
37398 .endd
37399 By default, the timestamps are in the local timezone. There are two
37400 ways of changing this:
37401
37402 .ilist
37403 You can set the &%timezone%& option to a different time zone; in particular, if
37404 you set
37405 .code
37406 timezone = UTC
37407 .endd
37408 the timestamps will be in UTC (aka GMT).
37409 .next
37410 If you set &%log_timezone%& true, the time zone is added to the timestamp, for
37411 example:
37412 .code
37413 2003-04-25 11:17:07 +0100 Start queue run: pid=12762
37414 .endd
37415 .endlist
37416
37417 .cindex "log" "process ids in"
37418 .cindex "pid (process id)" "in log lines"
37419 Exim does not include its process id in log lines by default, but you can
37420 request that it does so by specifying the &`pid`& log selector (see section
37421 &<<SECTlogselector>>&). When this is set, the process id is output, in square
37422 brackets, immediately after the time and date.
37423
37424
37425
37426
37427 .section "Where the logs are written" "SECTwhelogwri"
37428 .cindex "log" "destination"
37429 .cindex "log" "to file"
37430 .cindex "log" "to syslog"
37431 .cindex "syslog"
37432 The logs may be written to local files, or to syslog, or both. However, it
37433 should be noted that many syslog implementations use UDP as a transport, and
37434 are therefore unreliable in the sense that messages are not guaranteed to
37435 arrive at the loghost, nor is the ordering of messages necessarily maintained.
37436 It has also been reported that on large log files (tens of megabytes) you may
37437 need to tweak syslog to prevent it syncing the file with each write &-- on
37438 Linux this has been seen to make syslog take 90% plus of CPU time.
37439
37440 The destination for Exim's logs is configured by setting LOG_FILE_PATH in
37441 &_Local/Makefile_& or by setting &%log_file_path%& in the runtime
37442 configuration. This latter string is expanded, so it can contain, for example,
37443 references to the host name:
37444 .code
37445 log_file_path = /var/log/$primary_hostname/exim_%slog
37446 .endd
37447 It is generally advisable, however, to set the string in &_Local/Makefile_&
37448 rather than at runtime, because then the setting is available right from the
37449 start of Exim's execution. Otherwise, if there's something it wants to log
37450 before it has read the configuration file (for example, an error in the
37451 configuration file) it will not use the path you want, and may not be able to
37452 log at all.
37453
37454 The value of LOG_FILE_PATH or &%log_file_path%& is a colon-separated
37455 list, currently limited to at most two items. This is one option where the
37456 facility for changing a list separator may not be used. The list must always be
37457 colon-separated. If an item in the list is &"syslog"& then syslog is used;
37458 otherwise the item must either be an absolute path, containing &`%s`& at the
37459 point where &"main"&, &"reject"&, or &"panic"& is to be inserted, or be empty,
37460 implying the use of a default path.
37461
37462 When Exim encounters an empty item in the list, it searches the list defined by
37463 LOG_FILE_PATH, and uses the first item it finds that is neither empty nor
37464 &"syslog"&. This means that an empty item in &%log_file_path%& can be used to
37465 mean &"use the path specified at build time"&. It no such item exists, log
37466 files are written in the &_log_& subdirectory of the spool directory. This is
37467 equivalent to the setting:
37468 .code
37469 log_file_path = $spool_directory/log/%slog
37470 .endd
37471 If you do not specify anything at build time or runtime,
37472 or if you unset the option at runtime (i.e. &`log_file_path = `&),
37473 that is where the logs are written.
37474
37475 A log file path may also contain &`%D`& or &`%M`& if datestamped log filenames
37476 are in use &-- see section &<<SECTdatlogfil>>& below.
37477
37478 Here are some examples of possible settings:
37479 .display
37480 &`LOG_FILE_PATH=syslog                    `& syslog only
37481 &`LOG_FILE_PATH=:syslog                   `& syslog and default path
37482 &`LOG_FILE_PATH=syslog : /usr/log/exim_%s `& syslog and specified path
37483 &`LOG_FILE_PATH=/usr/log/exim_%s          `& specified path only
37484 .endd
37485 If there are more than two paths in the list, the first is used and a panic
37486 error is logged.
37487
37488
37489
37490 .section "Logging to local files that are periodically &""cycled""&" "SECID285"
37491 .cindex "log" "cycling local files"
37492 .cindex "cycling logs"
37493 .cindex "&'exicyclog'&"
37494 .cindex "log" "local files; writing to"
37495 Some operating systems provide centralized and standardized methods for cycling
37496 log files. For those that do not, a utility script called &'exicyclog'& is
37497 provided (see section &<<SECTcyclogfil>>&). This renames and compresses the
37498 main and reject logs each time it is called. The maximum number of old logs to
37499 keep can be set. It is suggested this script is run as a daily &'cron'& job.
37500
37501 An Exim delivery process opens the main log when it first needs to write to it,
37502 and it keeps the file open in case subsequent entries are required &-- for
37503 example, if a number of different deliveries are being done for the same
37504 message. However, remote SMTP deliveries can take a long time, and this means
37505 that the file may be kept open long after it is renamed if &'exicyclog'& or
37506 something similar is being used to rename log files on a regular basis. To
37507 ensure that a switch of log files is noticed as soon as possible, Exim calls
37508 &[stat()]& on the main log's name before reusing an open file, and if the file
37509 does not exist, or its inode has changed, the old file is closed and Exim
37510 tries to open the main log from scratch. Thus, an old log file may remain open
37511 for quite some time, but no Exim processes should write to it once it has been
37512 renamed.
37513
37514
37515
37516 .section "Datestamped log files" "SECTdatlogfil"
37517 .cindex "log" "datestamped files"
37518 Instead of cycling the main and reject log files by renaming them
37519 periodically, some sites like to use files whose names contain a datestamp,
37520 for example, &_mainlog-20031225_&. The datestamp is in the form &_yyyymmdd_& or
37521 &_yyyymm_&. Exim has support for this way of working. It is enabled by setting
37522 the &%log_file_path%& option to a path that includes &`%D`& or &`%M`& at the
37523 point where the datestamp is required. For example:
37524 .code
37525 log_file_path = /var/spool/exim/log/%slog-%D
37526 log_file_path = /var/log/exim-%s-%D.log
37527 log_file_path = /var/spool/exim/log/%D-%slog
37528 log_file_path = /var/log/exim/%s.%M
37529 .endd
37530 As before, &`%s`& is replaced by &"main"& or &"reject"&; the following are
37531 examples of names generated by the above examples:
37532 .code
37533 /var/spool/exim/log/mainlog-20021225
37534 /var/log/exim-reject-20021225.log
37535 /var/spool/exim/log/20021225-mainlog
37536 /var/log/exim/main.200212
37537 .endd
37538 When this form of log file is specified, Exim automatically switches to new
37539 files at midnight. It does not make any attempt to compress old logs; you
37540 will need to write your own script if you require this. You should not
37541 run &'exicyclog'& with this form of logging.
37542
37543 The location of the panic log is also determined by &%log_file_path%&, but it
37544 is not datestamped, because rotation of the panic log does not make sense.
37545 When generating the name of the panic log, &`%D`& or &`%M`& are removed from
37546 the string. In addition, if it immediately follows a slash, a following
37547 non-alphanumeric character is removed; otherwise a preceding non-alphanumeric
37548 character is removed. Thus, the four examples above would give these panic
37549 log names:
37550 .code
37551 /var/spool/exim/log/paniclog
37552 /var/log/exim-panic.log
37553 /var/spool/exim/log/paniclog
37554 /var/log/exim/panic
37555 .endd
37556
37557
37558 .section "Logging to syslog" "SECID249"
37559 .cindex "log" "syslog; writing to"
37560 The use of syslog does not change what Exim logs or the format of its messages,
37561 except in one respect. If &%syslog_timestamp%& is set false, the timestamps on
37562 Exim's log lines are omitted when these lines are sent to syslog. Apart from
37563 that, the same strings are written to syslog as to log files. The syslog
37564 &"facility"& is set to LOG_MAIL, and the program name to &"exim"&
37565 by default, but you can change these by setting the &%syslog_facility%& and
37566 &%syslog_processname%& options, respectively. If Exim was compiled with
37567 SYSLOG_LOG_PID set in &_Local/Makefile_& (this is the default in
37568 &_src/EDITME_&), then, on systems that permit it (all except ULTRIX), the
37569 LOG_PID flag is set so that the &[syslog()]& call adds the pid as well as
37570 the time and host name to each line.
37571 The three log streams are mapped onto syslog priorities as follows:
37572
37573 .ilist
37574 &'mainlog'& is mapped to LOG_INFO
37575 .next
37576 &'rejectlog'& is mapped to LOG_NOTICE
37577 .next
37578 &'paniclog'& is mapped to LOG_ALERT
37579 .endlist
37580
37581 Many log lines are written to both &'mainlog'& and &'rejectlog'&, and some are
37582 written to both &'mainlog'& and &'paniclog'&, so there will be duplicates if
37583 these are routed by syslog to the same place. You can suppress this duplication
37584 by setting &%syslog_duplication%& false.
37585
37586 Exim's log lines can sometimes be very long, and some of its &'rejectlog'&
37587 entries contain multiple lines when headers are included. To cope with both
37588 these cases, entries written to syslog are split into separate &[syslog()]&
37589 calls at each internal newline, and also after a maximum of
37590 870 data characters. (This allows for a total syslog line length of 1024, when
37591 additions such as timestamps are added.) If you are running a syslog
37592 replacement that can handle lines longer than the 1024 characters allowed by
37593 RFC 3164, you should set
37594 .code
37595 SYSLOG_LONG_LINES=yes
37596 .endd
37597 in &_Local/Makefile_& before building Exim. That stops Exim from splitting long
37598 lines, but it still splits at internal newlines in &'reject'& log entries.
37599
37600 To make it easy to re-assemble split lines later, each component of a split
37601 entry starts with a string of the form [<&'n'&>/<&'m'&>] or [<&'n'&>\<&'m'&>]
37602 where <&'n'&> is the component number and <&'m'&> is the total number of
37603 components in the entry. The / delimiter is used when the line was split
37604 because it was too long; if it was split because of an internal newline, the \
37605 delimiter is used. For example, supposing the length limit to be 50 instead of
37606 870, the following would be the result of a typical rejection message to
37607 &'mainlog'& (LOG_INFO), each line in addition being preceded by the time, host
37608 name, and pid as added by syslog:
37609 .code
37610 [1/5] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected from
37611 [2/5]  [127.0.0.1] (ph10): syntax error in 'From' header
37612 [3/5]  when scanning for sender: missing or malformed lo
37613 [4/5] cal part in "<>" (envelope sender is <ph10@cam.exa
37614 [5/5] mple>)
37615 .endd
37616 The same error might cause the following lines to be written to &"rejectlog"&
37617 (LOG_NOTICE):
37618 .code
37619 [1/18] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected fro
37620 [2/18] m [127.0.0.1] (ph10): syntax error in 'From' head
37621 [3/18] er when scanning for sender: missing or malformed
37622 [4/18]  local part in "<>" (envelope sender is <ph10@cam
37623 [5\18] .example>)
37624 [6\18] Recipients: ph10@some.domain.cam.example
37625 [7\18] P Received: from [127.0.0.1] (ident=ph10)
37626 [8\18]        by xxxxx.cam.example with smtp (Exim 4.00)
37627 [9\18]        id 16RdAL-0006pc-00
37628 [10/18]        for ph10@cam.example; Mon, 16 Sep 2002 16:
37629 [11\18] 09:43 +0100
37630 [12\18] F From: <>
37631 [13\18]   Subject: this is a test header
37632 [18\18]   X-something: this is another header
37633 [15/18] I Message-Id: <E16RdAL-0006pc-00@xxxxx.cam.examp
37634 [16\18] le>
37635 [17\18] B Bcc:
37636 [18/18]   Date: Mon, 16 Sep 2002 16:09:43 +0100
37637 .endd
37638 Log lines that are neither too long nor contain newlines are written to syslog
37639 without modification.
37640
37641 If only syslog is being used, the Exim monitor is unable to provide a log tail
37642 display, unless syslog is routing &'mainlog'& to a file on the local host and
37643 the environment variable EXIMON_LOG_FILE_PATH is set to tell the monitor
37644 where it is.
37645
37646
37647
37648 .section "Log line flags" "SECID250"
37649 One line is written to the main log for each message received, and for each
37650 successful, unsuccessful, and delayed delivery. These lines can readily be
37651 picked out by the distinctive two-character flags that immediately follow the
37652 timestamp. The flags are:
37653 .display
37654 &`<=`&     message arrival
37655 &`(=`&     message fakereject
37656 &`=>`&     normal message delivery
37657 &`->`&     additional address in same delivery
37658 &`>>`&     cutthrough message delivery
37659 &`*>`&     delivery suppressed by &%-N%&
37660 &`**`&     delivery failed; address bounced
37661 &`==`&     delivery deferred; temporary problem
37662 .endd
37663
37664
37665 .section "Logging message reception" "SECID251"
37666 .cindex "log" "reception line"
37667 The format of the single-line entry in the main log that is written for every
37668 message received is shown in the basic example below, which is split over
37669 several lines in order to fit it on the page:
37670 .code
37671 2002-10-31 08:57:53 16ZCW1-0005MB-00 <= kryten@dwarf.fict.example
37672   H=mailer.fict.example [192.168.123.123] U=exim
37673   P=smtp S=5678 id=<incoming message id>
37674 .endd
37675 The address immediately following &"<="& is the envelope sender address. A
37676 bounce message is shown with the sender address &"<>"&, and if it is locally
37677 generated, this is followed by an item of the form
37678 .code
37679 R=<message id>
37680 .endd
37681 which is a reference to the message that caused the bounce to be sent.
37682
37683 .cindex "HELO"
37684 .cindex "EHLO"
37685 For messages from other hosts, the H and U fields identify the remote host and
37686 record the RFC 1413 identity of the user that sent the message, if one was
37687 received. The number given in square brackets is the IP address of the sending
37688 host. If there is a single, unparenthesized  host name in the H field, as
37689 above, it has been verified to correspond to the IP address (see the
37690 &%host_lookup%& option). If the name is in parentheses, it was the name quoted
37691 by the remote host in the SMTP HELO or EHLO command, and has not been
37692 verified. If verification yields a different name to that given for HELO or
37693 EHLO, the verified name appears first, followed by the HELO or EHLO
37694 name in parentheses.
37695
37696 Misconfigured hosts (and mail forgers) sometimes put an IP address, with or
37697 without brackets, in the HELO or EHLO command, leading to entries in
37698 the log containing text like these examples:
37699 .code
37700 H=(10.21.32.43) [192.168.8.34]
37701 H=([10.21.32.43]) [192.168.8.34]
37702 .endd
37703 This can be confusing. Only the final address in square brackets can be relied
37704 on.
37705
37706 For locally generated messages (that is, messages not received over TCP/IP),
37707 the H field is omitted, and the U field contains the login name of the caller
37708 of Exim.
37709
37710 .cindex "authentication" "logging"
37711 .cindex "AUTH" "logging"
37712 For all messages, the P field specifies the protocol used to receive the
37713 message. This is the value that is stored in &$received_protocol$&. In the case
37714 of incoming SMTP messages, the value indicates whether or not any SMTP
37715 extensions (ESMTP), encryption, or authentication were used. If the SMTP
37716 session was encrypted, there is an additional X field that records the cipher
37717 suite that was used.
37718
37719 .cindex log protocol
37720 The protocol is set to &"esmtpsa"& or &"esmtpa"& for messages received from
37721 hosts that have authenticated themselves using the SMTP AUTH command. The first
37722 value is used when the SMTP connection was encrypted (&"secure"&). In this case
37723 there is an additional item A= followed by the name of the authenticator that
37724 was used. If an authenticated identification was set up by the authenticator's
37725 &%server_set_id%& option, this is logged too, separated by a colon from the
37726 authenticator name.
37727
37728 .cindex "size" "of message"
37729 The id field records the existing message id, if present. The size of the
37730 received message is given by the S field. When the message is delivered,
37731 headers may be removed or added, so that the size of delivered copies of the
37732 message may not correspond with this value (and indeed may be different to each
37733 other).
37734
37735 The &%log_selector%& option can be used to request the logging of additional
37736 data when a message is received. See section &<<SECTlogselector>>& below.
37737
37738
37739
37740 .section "Logging deliveries" "SECID252"
37741 .cindex "log" "delivery line"
37742 The format of the single-line entry in the main log that is written for every
37743 delivery is shown in one of the examples below, for local and remote
37744 deliveries, respectively. Each example has been split into multiple lines in order
37745 to fit it on the page:
37746 .code
37747 2002-10-31 08:59:13 16ZCW1-0005MB-00 => marv
37748   <marv@hitch.fict.example> R=localuser T=local_delivery
37749 2002-10-31 09:00:10 16ZCW1-0005MB-00 =>
37750   monk@holistic.fict.example R=dnslookup T=remote_smtp
37751   H=holistic.fict.example [192.168.234.234]
37752 .endd
37753 For ordinary local deliveries, the original address is given in angle brackets
37754 after the final delivery address, which might be a pipe or a file. If
37755 intermediate address(es) exist between the original and the final address, the
37756 last of these is given in parentheses after the final address. The R and T
37757 fields record the router and transport that were used to process the address.
37758
37759 If SMTP AUTH was used for the delivery there is an additional item A=
37760 followed by the name of the authenticator that was used.
37761 If an authenticated identification was set up by the authenticator's &%client_set_id%&
37762 option, this is logged too, separated by a colon from the authenticator name.
37763
37764 If a shadow transport was run after a successful local delivery, the log line
37765 for the successful delivery has an item added on the end, of the form
37766 .display
37767 &`ST=<`&&'shadow transport name'&&`>`&
37768 .endd
37769 If the shadow transport did not succeed, the error message is put in
37770 parentheses afterwards.
37771
37772 .cindex "asterisk" "after IP address"
37773 When more than one address is included in a single delivery (for example, two
37774 SMTP RCPT commands in one transaction) the second and subsequent addresses are
37775 flagged with &`->`& instead of &`=>`&. When two or more messages are delivered
37776 down a single SMTP connection, an asterisk follows the IP address in the log
37777 lines for the second and subsequent messages.
37778 When two or more messages are delivered down a single TLS connection, the
37779 DNS and some TLS-related information logged for the first message delivered
37780 will not be present in the log lines for the second and subsequent messages.
37781 TLS cipher information is still available.
37782
37783 .cindex "delivery" "cutthrough; logging"
37784 .cindex "cutthrough" "logging"
37785 When delivery is done in cutthrough mode it is flagged with &`>>`& and the log
37786 line precedes the reception line, since cutthrough waits for a possible
37787 rejection from the destination in case it can reject the sourced item.
37788
37789 The generation of a reply message by a filter file gets logged as a
37790 &"delivery"& to the addressee, preceded by &">"&.
37791
37792 The &%log_selector%& option can be used to request the logging of additional
37793 data when a message is delivered. See section &<<SECTlogselector>>& below.
37794
37795
37796 .section "Discarded deliveries" "SECID253"
37797 .cindex "discarded messages"
37798 .cindex "message" "discarded"
37799 .cindex "delivery" "discarded; logging"
37800 When a message is discarded as a result of the command &"seen finish"& being
37801 obeyed in a filter file which generates no deliveries, a log entry of the form
37802 .code
37803 2002-12-10 00:50:49 16auJc-0001UB-00 => discarded
37804   <low.club@bridge.example> R=userforward
37805 .endd
37806 is written, to record why no deliveries are logged. When a message is discarded
37807 because it is aliased to &":blackhole:"& the log line is like this:
37808 .code
37809 1999-03-02 09:44:33 10HmaX-0005vi-00 => :blackhole:
37810   <hole@nowhere.example> R=blackhole_router
37811 .endd
37812
37813
37814 .section "Deferred deliveries" "SECID254"
37815 When a delivery is deferred, a line of the following form is logged:
37816 .code
37817 2002-12-19 16:20:23 16aiQz-0002Q5-00 == marvin@endrest.example
37818   R=dnslookup T=smtp defer (146): Connection refused
37819 .endd
37820 In the case of remote deliveries, the error is the one that was given for the
37821 last IP address that was tried. Details of individual SMTP failures are also
37822 written to the log, so the above line would be preceded by something like
37823 .code
37824 2002-12-19 16:20:23 16aiQz-0002Q5-00 Failed to connect to
37825   mail1.endrest.example [192.168.239.239]: Connection refused
37826 .endd
37827 When a deferred address is skipped because its retry time has not been reached,
37828 a message is written to the log, but this can be suppressed by setting an
37829 appropriate value in &%log_selector%&.
37830
37831
37832
37833 .section "Delivery failures" "SECID255"
37834 .cindex "delivery" "failure; logging"
37835 If a delivery fails because an address cannot be routed, a line of the
37836 following form is logged:
37837 .code
37838 1995-12-19 16:20:23 0tRiQz-0002Q5-00 ** jim@trek99.example
37839   <jim@trek99.example>: unknown mail domain
37840 .endd
37841 If a delivery fails at transport time, the router and transport are shown, and
37842 the response from the remote host is included, as in this example:
37843 .code
37844 2002-07-11 07:14:17 17SXDU-000189-00 ** ace400@pb.example
37845   R=dnslookup T=remote_smtp: SMTP error from remote mailer
37846   after pipelined RCPT TO:<ace400@pb.example>: host
37847   pbmail3.py.example [192.168.63.111]: 553 5.3.0
37848   <ace400@pb.example>...Addressee unknown
37849 .endd
37850 The word &"pipelined"& indicates that the SMTP PIPELINING extension was being
37851 used. See &%hosts_avoid_esmtp%& in the &(smtp)& transport for a way of
37852 disabling PIPELINING. The log lines for all forms of delivery failure are
37853 flagged with &`**`&.
37854
37855
37856
37857 .section "Fake deliveries" "SECID256"
37858 .cindex "delivery" "fake; logging"
37859 If a delivery does not actually take place because the &%-N%& option has been
37860 used to suppress it, a normal delivery line is written to the log, except that
37861 &"=>"& is replaced by &"*>"&.
37862
37863
37864
37865 .section "Completion" "SECID257"
37866 A line of the form
37867 .code
37868 2002-10-31 09:00:11 16ZCW1-0005MB-00 Completed
37869 .endd
37870 is written to the main log when a message is about to be removed from the spool
37871 at the end of its processing.
37872
37873
37874
37875
37876 .section "Summary of Fields in Log Lines" "SECID258"
37877 .cindex "log" "summary of fields"
37878 A summary of the field identifiers that are used in log lines is shown in
37879 the following table:
37880 .display
37881 &`A   `&        authenticator name (and optional id and sender)
37882 &`C   `&        SMTP confirmation on delivery
37883 &`    `&        command list for &"no mail in SMTP session"&
37884 &`CV  `&        certificate verification status
37885 &`D   `&        duration of &"no mail in SMTP session"&
37886 &`DKIM`&        domain verified in incoming message
37887 &`DN  `&        distinguished name from peer certificate
37888 &`DS  `&        DNSSEC secured lookups
37889 &`DT  `&        on &`=>`&, &'=='& and &'**'& lines: time taken for, or to attempt, a delivery
37890 &`F   `&        sender address (on delivery lines)
37891 &`H   `&        host name and IP address
37892 &`I   `&        local interface used
37893 &`id  `&        message id (from header) for incoming message
37894 &`K   `&        CHUNKING extension used
37895 &`L   `&        on &`<=`& and &`=>`& lines: PIPELINING extension used
37896 &`M8S `&        8BITMIME status for incoming message
37897 &`P   `&        on &`<=`& lines: protocol used
37898 &`    `&        on &`=>`& and &`**`& lines: return path
37899 &`PRDR`&        PRDR extension used
37900 &`PRX `&        on &`<=`& and &`=>`& lines: proxy address
37901 &`Q   `&        alternate queue name
37902 &`QT  `&        on &`=>`& lines: time spent on queue so far
37903 &`    `&        on &"Completed"& lines: time spent on queue
37904 &`R   `&        on &`<=`& lines: reference for local bounce
37905 &`    `&        on &`=>`&  &`>>`& &`**`& and &`==`& lines: router name
37906 &`RT  `&        on &`<=`& lines: time taken for reception
37907 &`S   `&        size of message in bytes
37908 &`SNI `&        server name indication from TLS client hello
37909 &`ST  `&        shadow transport name
37910 &`T   `&        on &`<=`& lines: message subject (topic)
37911 &`TFO `&        connection took advantage of TCP Fast Open
37912 &`    `&        on &`=>`& &`**`& and &`==`& lines: transport name
37913 &`U   `&        local user or RFC 1413 identity
37914 &`X   `&        TLS cipher suite
37915 .endd
37916
37917
37918 .section "Other log entries" "SECID259"
37919 Various other types of log entry are written from time to time. Most should be
37920 self-explanatory. Among the more common are:
37921
37922 .ilist
37923 .cindex "retry" "time not reached"
37924 &'retry time not reached'&&~&~An address previously suffered a temporary error
37925 during routing or local delivery, and the time to retry has not yet arrived.
37926 This message is not written to an individual message log file unless it happens
37927 during the first delivery attempt.
37928 .next
37929 &'retry time not reached for any host'&&~&~An address previously suffered
37930 temporary errors during remote delivery, and the retry time has not yet arrived
37931 for any of the hosts to which it is routed.
37932 .next
37933 .cindex "spool directory" "file locked"
37934 &'spool file locked'&&~&~An attempt to deliver a message cannot proceed because
37935 some other Exim process is already working on the message. This can be quite
37936 common if queue running processes are started at frequent intervals. The
37937 &'exiwhat'& utility script can be used to find out what Exim processes are
37938 doing.
37939 .next
37940 .cindex "error" "ignored"
37941 &'error ignored'&&~&~There are several circumstances that give rise to this
37942 message:
37943 .olist
37944 Exim failed to deliver a bounce message whose age was greater than
37945 &%ignore_bounce_errors_after%&. The bounce was discarded.
37946 .next
37947 A filter file set up a delivery using the &"noerror"& option, and the delivery
37948 failed. The delivery was discarded.
37949 .next
37950 A delivery set up by a router configured with
37951 . ==== As this is a nested list, any displays it contains must be indented
37952 . ==== as otherwise they are too far to the left.
37953 .code
37954     errors_to = <>
37955 .endd
37956 failed. The delivery was discarded.
37957 .endlist olist
37958 .next
37959 .cindex DKIM "log line"
37960 &'DKIM: d='&&~&~Verbose results of a DKIM verification attempt, if enabled for
37961 logging and the message has a DKIM signature header.
37962 .endlist ilist
37963
37964
37965
37966
37967
37968 .section "Reducing or increasing what is logged" "SECTlogselector"
37969 .cindex "log" "selectors"
37970 By setting the &%log_selector%& global option, you can disable some of Exim's
37971 default logging, or you can request additional logging. The value of
37972 &%log_selector%& is made up of names preceded by plus or minus characters. For
37973 example:
37974 .code
37975 log_selector = +arguments -retry_defer
37976 .endd
37977 The list of optional log items is in the following table, with the default
37978 selection marked by asterisks:
37979 .display
37980 &` 8bitmime                   `&  received 8BITMIME status
37981 &`*acl_warn_skipped           `&  skipped &%warn%& statement in ACL
37982 &` address_rewrite            `&  address rewriting
37983 &` all_parents                `&  all parents in => lines
37984 &` arguments                  `&  command line arguments
37985 &`*connection_reject          `&  connection rejections
37986 &`*delay_delivery             `&  immediate delivery delayed
37987 &` deliver_time               `&  time taken to attempt delivery
37988 &` delivery_size              `&  add &`S=`&&'nnn'& to => lines
37989 &`*dkim                       `&  DKIM verified domain on <= lines
37990 &` dkim_verbose               `&  separate full DKIM verification result line, per signature
37991 &`*dnslist_defer              `&  defers of DNS list (aka RBL) lookups
37992 &` dnssec                     `&  DNSSEC secured lookups
37993 &`*etrn                       `&  ETRN commands
37994 &`*host_lookup_failed         `&  as it says
37995 &` ident_timeout              `&  timeout for ident connection
37996 &` incoming_interface         `&  local interface on <= and => lines
37997 &` incoming_port              `&  remote port on <= lines
37998 &`*lost_incoming_connection   `&  as it says (includes timeouts)
37999 &` millisec                   `&  millisecond timestamps and RT,QT,DT,D times
38000 &`*msg_id                     `&  on <= lines, Message-ID: header value
38001 &` msg_id_created             `&  on <= lines, Message-ID: header value when one had to be added
38002 &` outgoing_interface         `&  local interface on => lines
38003 &` outgoing_port              `&  add remote port to => lines
38004 &`*queue_run                  `&  start and end queue runs
38005 &` queue_time                 `&  time on queue for one recipient
38006 &` queue_time_overall         `&  time on queue for whole message
38007 &` pid                        `&  Exim process id
38008 &` pipelining                 `&  PIPELINING use, on <= and => lines
38009 &` proxy                      `&  proxy address on <= and => lines
38010 &` receive_time               `&  time taken to receive message
38011 &` received_recipients        `&  recipients on <= lines
38012 &` received_sender            `&  sender on <= lines
38013 &`*rejected_header            `&  header contents on reject log
38014 &`*retry_defer                `&  &"retry time not reached"&
38015 &` return_path_on_delivery    `&  put return path on => and ** lines
38016 &` sender_on_delivery         `&  add sender to => lines
38017 &`*sender_verify_fail         `&  sender verification failures
38018 &`*size_reject                `&  rejection because too big
38019 &`*skip_delivery              `&  delivery skipped in a queue run
38020 &`*smtp_confirmation          `&  SMTP confirmation on => lines
38021 &` smtp_connection            `&  incoming SMTP connections
38022 &` smtp_incomplete_transaction`&  incomplete SMTP transactions
38023 &` smtp_mailauth              `&  AUTH argument to MAIL commands
38024 &` smtp_no_mail               `&  session with no MAIL commands
38025 &` smtp_protocol_error        `&  SMTP protocol errors
38026 &` smtp_syntax_error          `&  SMTP syntax errors
38027 &` subject                    `&  contents of &'Subject:'& on <= lines
38028 &`*tls_certificate_verified   `&  certificate verification status
38029 &`*tls_cipher                 `&  TLS cipher suite on <= and => lines
38030 &` tls_peerdn                 `&  TLS peer DN on <= and => lines
38031 &` tls_sni                    `&  TLS SNI on <= lines
38032 &` unknown_in_list            `&  DNS lookup failed in list match
38033
38034 &` all                        `&  all of the above
38035 .endd
38036 See also the &%slow_lookup_log%& main configuration option,
38037 section &<<SECID99>>&
38038
38039 More details on each of these items follows:
38040
38041 .ilist
38042 .cindex "8BITMIME"
38043 .cindex "log" "8BITMIME"
38044 &%8bitmime%&: This causes Exim to log any 8BITMIME status of received messages,
38045 which may help in tracking down interoperability issues with ancient MTAs
38046 that are not 8bit clean.  This is added to the &"<="& line, tagged with
38047 &`M8S=`& and a value of &`0`&, &`7`& or &`8`&, corresponding to "not given",
38048 &`7BIT`& and &`8BITMIME`& respectively.
38049 .next
38050 .cindex "&%warn%& ACL verb" "log when skipping"
38051 &%acl_warn_skipped%&: When an ACL &%warn%& statement is skipped because one of
38052 its conditions cannot be evaluated, a log line to this effect is written if
38053 this log selector is set.
38054 .next
38055 .cindex "log" "rewriting"
38056 .cindex "rewriting" "logging"
38057 &%address_rewrite%&: This applies both to global rewrites and per-transport
38058 rewrites, but not to rewrites in filters run as an unprivileged user (because
38059 such users cannot access the log).
38060 .next
38061 .cindex "log" "full parentage"
38062 &%all_parents%&: Normally only the original and final addresses are logged on
38063 delivery lines; with this selector, intermediate parents are given in
38064 parentheses between them.
38065 .next
38066 .cindex "log" "Exim arguments"
38067 .cindex "Exim arguments, logging"
38068 &%arguments%&: This causes Exim to write the arguments with which it was called
38069 to the main log, preceded by the current working directory. This is a debugging
38070 feature, added to make it easier to find out how certain MUAs call
38071 &_/usr/sbin/sendmail_&. The logging does not happen if Exim has given up root
38072 privilege because it was called with the &%-C%& or &%-D%& options. Arguments
38073 that are empty or that contain white space are quoted. Non-printing characters
38074 are shown as escape sequences. This facility cannot log unrecognized arguments,
38075 because the arguments are checked before the configuration file is read. The
38076 only way to log such cases is to interpose a script such as &_util/logargs.sh_&
38077 between the caller and Exim.
38078 .next
38079 .cindex "log" "connection rejections"
38080 &%connection_reject%&: A log entry is written whenever an incoming SMTP
38081 connection is rejected, for whatever reason.
38082 .next
38083 .cindex "log" "delayed delivery"
38084 .cindex "delayed delivery, logging"
38085 &%delay_delivery%&: A log entry is written whenever a delivery process is not
38086 started for an incoming message because the load is too high or too many
38087 messages were received on one connection. Logging does not occur if no delivery
38088 process is started because &%queue_only%& is set or &%-odq%& was used.
38089 .next
38090 .cindex "log" "delivery duration"
38091 &%deliver_time%&: For each delivery, the amount of real time it has taken to
38092 perform the actual delivery is logged as DT=<&'time'&>, for example, &`DT=1s`&.
38093 If millisecond logging is enabled, short times will be shown with greater
38094 precision, eg. &`DT=0.304s`&.
38095 .next
38096 .cindex "log" "message size on delivery"
38097 .cindex "size" "of message"
38098 &%delivery_size%&: For each delivery, the size of message delivered is added to
38099 the &"=>"& line, tagged with S=.
38100 .next
38101 .cindex log "DKIM verification"
38102 .cindex DKIM "verification logging"
38103 &%dkim%&: For message acceptance log lines, when an DKIM signature in the header
38104 verifies successfully a tag of DKIM is added, with one of the verified domains.
38105 .next
38106 .cindex log "DKIM verification"
38107 .cindex DKIM "verification logging"
38108 &%dkim_verbose%&: A log entry is written for each attempted DKIM verification.
38109 .next
38110 .cindex "log" "dnslist defer"
38111 .cindex "DNS list" "logging defer"
38112 .cindex "black list (DNS)"
38113 &%dnslist_defer%&: A log entry is written if an attempt to look up a host in a
38114 DNS black list suffers a temporary error.
38115 .next
38116 .cindex log dnssec
38117 .cindex dnssec logging
38118 &%dnssec%&: For message acceptance and (attempted) delivery log lines, when
38119 dns lookups gave secure results a tag of DS is added.
38120 For acceptance this covers the reverse and forward lookups for host name verification.
38121 It does not cover helo-name verification.
38122 For delivery this covers the SRV, MX, A and/or AAAA lookups.
38123 .next
38124 .cindex "log" "ETRN commands"
38125 .cindex "ETRN" "logging"
38126 &%etrn%&: Every valid ETRN command that is received is logged, before the ACL
38127 is run to determine whether or not it is actually accepted. An invalid ETRN
38128 command, or one received within a message transaction is not logged by this
38129 selector (see &%smtp_syntax_error%& and &%smtp_protocol_error%&).
38130 .next
38131 .cindex "log" "host lookup failure"
38132 &%host_lookup_failed%&: When a lookup of a host's IP addresses fails to find
38133 any addresses, or when a lookup of an IP address fails to find a host name, a
38134 log line is written. This logging does not apply to direct DNS lookups when
38135 routing email addresses, but it does apply to &"byname"& lookups.
38136 .next
38137 .cindex "log" "ident timeout"
38138 .cindex "RFC 1413" "logging timeout"
38139 &%ident_timeout%&: A log line is written whenever an attempt to connect to a
38140 client's ident port times out.
38141 .next
38142 .cindex "log" "incoming interface"
38143 .cindex "log" "local interface"
38144 .cindex "log" "local address and port"
38145 .cindex "TCP/IP" "logging local address and port"
38146 .cindex "interface" "logging"
38147 &%incoming_interface%&: The interface on which a message was received is added
38148 to the &"<="& line as an IP address in square brackets, tagged by I= and
38149 followed by a colon and the port number. The local interface and port are also
38150 added to other SMTP log lines, for example, &"SMTP connection from"&, to
38151 rejection lines, and (despite the name) to outgoing &"=>"& and &"->"& lines.
38152 The latter can be disabled by turning off the &%outgoing_interface%& option.
38153 .next
38154 .cindex log "incoming proxy address"
38155 .cindex proxy "logging proxy address"
38156 .cindex "TCP/IP" "logging proxy address"
38157 &%proxy%&: The internal (closest to the system running Exim) IP address
38158 of the proxy, tagged by PRX=, on the &"<="& line for a message accepted
38159 on a proxied connection
38160 or the &"=>"& line for a message delivered on a proxied connection.
38161 See &<<SECTproxyInbound>>& for more information.
38162 .next
38163 .cindex "log" "incoming remote port"
38164 .cindex "port" "logging remote"
38165 .cindex "TCP/IP" "logging incoming remote port"
38166 .vindex "&$sender_fullhost$&"
38167 .vindex "&$sender_rcvhost$&"
38168 &%incoming_port%&: The remote port number from which a message was received is
38169 added to log entries and &'Received:'& header lines, following the IP address
38170 in square brackets, and separated from it by a colon. This is implemented by
38171 changing the value that is put in the &$sender_fullhost$& and
38172 &$sender_rcvhost$& variables. Recording the remote port number has become more
38173 important with the widening use of NAT (see RFC 2505).
38174 .next
38175 .cindex "log" "dropped connection"
38176 &%lost_incoming_connection%&: A log line is written when an incoming SMTP
38177 connection is unexpectedly dropped.
38178 .next
38179 .cindex "log" "millisecond timestamps"
38180 .cindex millisecond logging
38181 .cindex timestamps "millisecond, in logs"
38182 &%millisec%&: Timestamps have a period and three decimal places of finer granularity
38183 appended to the seconds value.
38184 .next
38185 .cindex "log" "message id"
38186 &%msg_id%&: The value of the Message-ID: header.
38187 .next
38188 &%msg_id_created%&: The value of the Message-ID: header, when one had to be created.
38189 This will be either because the message is a bounce, or was submitted locally
38190 (submission mode) without one.
38191 The field identifier will have an asterix appended: &"id*="&.
38192 .next
38193 .cindex "log" "outgoing interface"
38194 .cindex "log" "local interface"
38195 .cindex "log" "local address and port"
38196 .cindex "TCP/IP" "logging local address and port"
38197 .cindex "interface" "logging"
38198 &%outgoing_interface%&: If &%incoming_interface%& is turned on, then the
38199 interface on which a message was sent is added to delivery lines as an I= tag
38200 followed by IP address in square brackets. You can disable this by turning
38201 off the &%outgoing_interface%& option.
38202 .next
38203 .cindex "log" "outgoing remote port"
38204 .cindex "port" "logging outgoing remote"
38205 .cindex "TCP/IP" "logging outgoing remote port"
38206 &%outgoing_port%&: The remote port number is added to delivery log lines (those
38207 containing => tags) following the IP address.
38208 The local port is also added if &%incoming_interface%& and
38209 &%outgoing_interface%& are both enabled.
38210 This option is not included in the default setting, because for most ordinary
38211 configurations, the remote port number is always 25 (the SMTP port), and the
38212 local port is a random ephemeral port.
38213 .next
38214 .cindex "log" "process ids in"
38215 .cindex "pid (process id)" "in log lines"
38216 &%pid%&: The current process id is added to every log line, in square brackets,
38217 immediately after the time and date.
38218 .next
38219 .cindex log pipelining
38220 .cindex pipelining "logging outgoing"
38221 &%pipelining%&: A field is added to delivery and accept
38222 log lines when the ESMTP PIPELINING extension was used.
38223 The field is a single "L".
38224
38225 On accept lines, where PIPELINING was offered but not used by the client,
38226 the field has a minus appended.
38227
38228 .cindex "pipelining" "early connection"
38229 If Exim is built with the SUPPORT_PIPE_CONNECT build option
38230 accept "L" fields have a period appended if the feature was
38231 offered but not used, or an asterisk appended if used.
38232 Delivery "L" fields have an asterisk appended if used.
38233
38234 .next
38235 .cindex "log" "queue run"
38236 .cindex "queue runner" "logging"
38237 &%queue_run%&: The start and end of every queue run are logged.
38238 .next
38239 .cindex "log" "queue time"
38240 &%queue_time%&: The amount of time the message has been in the queue on the
38241 local host is logged as QT=<&'time'&> on delivery (&`=>`&) lines, for example,
38242 &`QT=3m45s`&. The clock starts when Exim starts to receive the message, so it
38243 includes reception time as well as the delivery time for the current address.
38244 This means that it may be longer than the difference between the arrival and
38245 delivery log line times, because the arrival log line is not written until the
38246 message has been successfully received.
38247 If millisecond logging is enabled, short times will be shown with greater
38248 precision, eg. &`QT=1.578s`&.
38249 .next
38250 &%queue_time_overall%&: The amount of time the message has been in the queue on
38251 the local host is logged as QT=<&'time'&> on &"Completed"& lines, for
38252 example, &`QT=3m45s`&. The clock starts when Exim starts to receive the
38253 message, so it includes reception time as well as the total delivery time.
38254 .next
38255 .cindex "log" "receive duration"
38256 &%receive_time%&: For each message, the amount of real time it has taken to
38257 perform the reception is logged as RT=<&'time'&>, for example, &`RT=1s`&.
38258 If millisecond logging is enabled, short times will be shown with greater
38259 precision, eg. &`RT=0.204s`&.
38260 .next
38261 .cindex "log" "recipients"
38262 &%received_recipients%&: The recipients of a message are listed in the main log
38263 as soon as the message is received. The list appears at the end of the log line
38264 that is written when a message is received, preceded by the word &"for"&. The
38265 addresses are listed after they have been qualified, but before any rewriting
38266 has taken place.
38267 Recipients that were discarded by an ACL for MAIL or RCPT do not appear
38268 in the list.
38269 .next
38270 .cindex "log" "sender reception"
38271 &%received_sender%&: The unrewritten original sender of a message is added to
38272 the end of the log line that records the message's arrival, after the word
38273 &"from"& (before the recipients if &%received_recipients%& is also set).
38274 .next
38275 .cindex "log" "header lines for rejection"
38276 &%rejected_header%&: If a message's header has been received at the time a
38277 rejection is written to the reject log, the complete header is added to the
38278 log. Header logging can be turned off individually for messages that are
38279 rejected by the &[local_scan()]& function (see section &<<SECTapiforloc>>&).
38280 .next
38281 .cindex "log" "retry defer"
38282 &%retry_defer%&: A log line is written if a delivery is deferred because a
38283 retry time has not yet been reached. However, this &"retry time not reached"&
38284 message is always omitted from individual message logs after the first delivery
38285 attempt.
38286 .next
38287 .cindex "log" "return path"
38288 &%return_path_on_delivery%&: The return path that is being transmitted with
38289 the message is included in delivery and bounce lines, using the tag P=.
38290 This is omitted if no delivery actually happens, for example, if routing fails,
38291 or if delivery is to &_/dev/null_& or to &`:blackhole:`&.
38292 .next
38293 .cindex "log" "sender on delivery"
38294 &%sender_on_delivery%&: The message's sender address is added to every delivery
38295 and bounce line, tagged by F= (for &"from"&).
38296 This is the original sender that was received with the message; it is not
38297 necessarily the same as the outgoing return path.
38298 .next
38299 .cindex "log" "sender verify failure"
38300 &%sender_verify_fail%&: If this selector is unset, the separate log line that
38301 gives details of a sender verification failure is not written. Log lines for
38302 the rejection of SMTP commands contain just &"sender verify failed"&, so some
38303 detail is lost.
38304 .next
38305 .cindex "log" "size rejection"
38306 &%size_reject%&: A log line is written whenever a message is rejected because
38307 it is too big.
38308 .next
38309 .cindex "log" "frozen messages; skipped"
38310 .cindex "frozen messages" "logging skipping"
38311 &%skip_delivery%&: A log line is written whenever a message is skipped during a
38312 queue run because it is frozen or because another process is already delivering
38313 it.
38314 .cindex "&""spool file is locked""&"
38315 The message that is written is &"spool file is locked"&.
38316 .next
38317 .cindex "log" "smtp confirmation"
38318 .cindex "SMTP" "logging confirmation"
38319 .cindex "LMTP" "logging confirmation"
38320 &%smtp_confirmation%&: The response to the final &"."& in the SMTP or LMTP dialogue for
38321 outgoing messages is added to delivery log lines in the form &`C=`&<&'text'&>.
38322 A number of MTAs (including Exim) return an identifying string in this
38323 response.
38324 .next
38325 .cindex "log" "SMTP connections"
38326 .cindex "SMTP" "logging connections"
38327 &%smtp_connection%&: A log line is written whenever an incoming SMTP connection is
38328 established or closed, unless the connection is from a host that matches
38329 &%hosts_connection_nolog%&. (In contrast, &%lost_incoming_connection%& applies
38330 only when the closure is unexpected.) This applies to connections from local
38331 processes that use &%-bs%& as well as to TCP/IP connections. If a connection is
38332 dropped in the middle of a message, a log line is always written, whether or
38333 not this selector is set, but otherwise nothing is written at the start and end
38334 of connections unless this selector is enabled.
38335
38336 For TCP/IP connections to an Exim daemon, the current number of connections is
38337 included in the log message for each new connection, but note that the count is
38338 reset if the daemon is restarted.
38339 Also, because connections are closed (and the closure is logged) in
38340 subprocesses, the count may not include connections that have been closed but
38341 whose termination the daemon has not yet noticed. Thus, while it is possible to
38342 match up the opening and closing of connections in the log, the value of the
38343 logged counts may not be entirely accurate.
38344 .next
38345 .cindex "log" "SMTP transaction; incomplete"
38346 .cindex "SMTP" "logging incomplete transactions"
38347 &%smtp_incomplete_transaction%&: When a mail transaction is aborted by
38348 RSET, QUIT, loss of connection, or otherwise, the incident is logged,
38349 and the message sender plus any accepted recipients are included in the log
38350 line. This can provide evidence of dictionary attacks.
38351 .next
38352 .cindex "log" "non-MAIL SMTP sessions"
38353 .cindex "MAIL" "logging session without"
38354 &%smtp_no_mail%&: A line is written to the main log whenever an accepted SMTP
38355 connection terminates without having issued a MAIL command. This includes both
38356 the case when the connection is dropped, and the case when QUIT is used. It
38357 does not include cases where the connection is rejected right at the start (by
38358 an ACL, or because there are too many connections, or whatever). These cases
38359 already have their own log lines.
38360
38361 The log line that is written contains the identity of the client in the usual
38362 way, followed by D= and a time, which records the duration of the connection.
38363 If the connection was authenticated, this fact is logged exactly as it is for
38364 an incoming message, with an A= item. If the connection was encrypted, CV=,
38365 DN=, and X= items may appear as they do for an incoming message, controlled by
38366 the same logging options.
38367
38368 Finally, if any SMTP commands were issued during the connection, a C= item
38369 is added to the line, listing the commands that were used. For example,
38370 .code
38371 C=EHLO,QUIT
38372 .endd
38373 shows that the client issued QUIT straight after EHLO. If there were fewer
38374 than 20 commands, they are all listed. If there were more than 20 commands,
38375 the last 20 are listed, preceded by &"..."&. However, with the default
38376 setting of 10 for &%smtp_accept_max_nonmail%&, the connection will in any case
38377 have been aborted before 20 non-mail commands are processed.
38378 .next
38379 &%smtp_mailauth%&: A third subfield with the authenticated sender,
38380 colon-separated, is appended to the A= item for a message arrival or delivery
38381 log line, if an AUTH argument to the SMTP MAIL command (see &<<SECTauthparamail>>&)
38382 was accepted or used.
38383 .next
38384 .cindex "log" "SMTP protocol error"
38385 .cindex "SMTP" "logging protocol error"
38386 &%smtp_protocol_error%&: A log line is written for every SMTP protocol error
38387 encountered. Exim does not have perfect detection of all protocol errors
38388 because of transmission delays and the use of pipelining. If PIPELINING has
38389 been advertised to a client, an Exim server assumes that the client will use
38390 it, and therefore it does not count &"expected"& errors (for example, RCPT
38391 received after rejecting MAIL) as protocol errors.
38392 .next
38393 .cindex "SMTP" "logging syntax errors"
38394 .cindex "SMTP" "syntax errors; logging"
38395 .cindex "SMTP" "unknown command; logging"
38396 .cindex "log" "unknown SMTP command"
38397 .cindex "log" "SMTP syntax error"
38398 &%smtp_syntax_error%&: A log line is written for every SMTP syntax error
38399 encountered. An unrecognized command is treated as a syntax error. For an
38400 external connection, the host identity is given; for an internal connection
38401 using &%-bs%& the sender identification (normally the calling user) is given.
38402 .next
38403 .cindex "log" "subject"
38404 .cindex "subject, logging"
38405 &%subject%&: The subject of the message is added to the arrival log line,
38406 preceded by &"T="& (T for &"topic"&, since S is already used for &"size"&).
38407 Any MIME &"words"& in the subject are decoded. The &%print_topbitchars%& option
38408 specifies whether characters with values greater than 127 should be logged
38409 unchanged, or whether they should be rendered as escape sequences.
38410 .next
38411 .cindex "log" "certificate verification"
38412 .cindex log DANE
38413 .cindex DANE logging
38414 &%tls_certificate_verified%&: An extra item is added to <= and => log lines
38415 when TLS is in use. The item is &`CV=yes`& if the peer's certificate was
38416 verified
38417 using a CA trust anchor,
38418 &`CA=dane`& if using a DNS trust anchor,
38419 and &`CV=no`& if not.
38420 .next
38421 .cindex "log" "TLS cipher"
38422 .cindex "TLS" "logging cipher"
38423 &%tls_cipher%&: When a message is sent or received over an encrypted
38424 connection, the cipher suite used is added to the log line, preceded by X=.
38425 .next
38426 .cindex "log" "TLS peer DN"
38427 .cindex "TLS" "logging peer DN"
38428 &%tls_peerdn%&: When a message is sent or received over an encrypted
38429 connection, and a certificate is supplied by the remote host, the peer DN is
38430 added to the log line, preceded by DN=.
38431 .next
38432 .cindex "log" "TLS SNI"
38433 .cindex "TLS" "logging SNI"
38434 &%tls_sni%&: When a message is received over an encrypted connection, and
38435 the remote host provided the Server Name Indication extension, the SNI is
38436 added to the log line, preceded by SNI=.
38437 .next
38438 .cindex "log" "DNS failure in list"
38439 &%unknown_in_list%&: This setting causes a log entry to be written when the
38440 result of a list match is failure because a DNS lookup failed.
38441 .endlist
38442
38443
38444 .section "Message log" "SECID260"
38445 .cindex "message" "log file for"
38446 .cindex "log" "message log; description of"
38447 .cindex "&_msglog_& directory"
38448 .oindex "&%preserve_message_logs%&"
38449 In addition to the general log files, Exim writes a log file for each message
38450 that it handles. The names of these per-message logs are the message ids, and
38451 they are kept in the &_msglog_& sub-directory of the spool directory. Each
38452 message log contains copies of the log lines that apply to the message. This
38453 makes it easier to inspect the status of an individual message without having
38454 to search the main log. A message log is deleted when processing of the message
38455 is complete, unless &%preserve_message_logs%& is set, but this should be used
38456 only with great care because they can fill up your disk very quickly.
38457
38458 On a heavily loaded system, it may be desirable to disable the use of
38459 per-message logs, in order to reduce disk I/O. This can be done by setting the
38460 &%message_logs%& option false.
38461 .ecindex IIDloggen
38462
38463
38464
38465
38466 . ////////////////////////////////////////////////////////////////////////////
38467 . ////////////////////////////////////////////////////////////////////////////
38468
38469 .chapter "Exim utilities" "CHAPutils"
38470 .scindex IIDutils "utilities"
38471 A number of utility scripts and programs are supplied with Exim and are
38472 described in this chapter. There is also the Exim Monitor, which is covered in
38473 the next chapter. The utilities described here are:
38474
38475 .itable none 0 0 3  7* left  15* left  40* left
38476 .irow &<<SECTfinoutwha>>&     &'exiwhat'&       &&&
38477   "list what Exim processes are doing"
38478 .irow &<<SECTgreptheque>>&    &'exiqgrep'&      "grep the queue"
38479 .irow &<<SECTsumtheque>>&     &'exiqsumm'&      "summarize the queue"
38480 .irow &<<SECTextspeinf>>&     &'exigrep'&       "search the main log"
38481 .irow &<<SECTexipick>>&       &'exipick'&       "select messages on &&&
38482                                                 various criteria"
38483 .irow &<<SECTcyclogfil>>&     &'exicyclog'&     "cycle (rotate) log files"
38484 .irow &<<SECTmailstat>>&      &'eximstats'&     &&&
38485   "extract statistics from the log"
38486 .irow &<<SECTcheckaccess>>&   &'exim_checkaccess'& &&&
38487   "check address acceptance from given IP"
38488 .irow &<<SECTdbmbuild>>&      &'exim_dbmbuild'& "build a DBM file"
38489 .irow &<<SECTfinindret>>&     &'exinext'&       "extract retry information"
38490 .irow &<<SECThindatmai>>&     &'exim_dumpdb'&   "dump a hints database"
38491 .irow &<<SECThindatmai>>&     &'exim_tidydb'&   "clean up a hints database"
38492 .irow &<<SECThindatmai>>&     &'exim_fixdb'&    "patch a hints database"
38493 .irow &<<SECTmailboxmaint>>&  &'exim_lock'&     "lock a mailbox file"
38494 .endtable
38495
38496 Another utility that might be of use to sites with many MTAs is Tom Kistner's
38497 &'exilog'&. It provides log visualizations across multiple Exim servers. See
38498 &url(https://duncanthrax.net/exilog/) for details.
38499
38500
38501
38502
38503 .section "Finding out what Exim processes are doing (exiwhat)" "SECTfinoutwha"
38504 .cindex "&'exiwhat'&"
38505 .cindex "process, querying"
38506 .cindex "SIGUSR1"
38507 On operating systems that can restart a system call after receiving a signal
38508 (most modern OS), an Exim process responds to the SIGUSR1 signal by writing
38509 a line describing what it is doing to the file &_exim-process.info_& in the
38510 Exim spool directory. The &'exiwhat'& script sends the signal to all Exim
38511 processes it can find, having first emptied the file. It then waits for one
38512 second to allow the Exim processes to react before displaying the results. In
38513 order to run &'exiwhat'& successfully you have to have sufficient privilege to
38514 send the signal to the Exim processes, so it is normally run as root.
38515
38516 &*Warning*&: This is not an efficient process. It is intended for occasional
38517 use by system administrators. It is not sensible, for example, to set up a
38518 script that sends SIGUSR1 signals to Exim processes at short intervals.
38519
38520
38521 Unfortunately, the &'ps'& command that &'exiwhat'& uses to find Exim processes
38522 varies in different operating systems. Not only are different options used,
38523 but the format of the output is different. For this reason, there are some
38524 system configuration options that configure exactly how &'exiwhat'& works. If
38525 it doesn't seem to be working for you, check the following compile-time
38526 options:
38527 .display
38528 &`EXIWHAT_PS_CMD    `& the command for running &'ps'&
38529 &`EXIWHAT_PS_ARG    `& the argument for &'ps'&
38530 &`EXIWHAT_EGREP_ARG `& the argument for &'egrep'& to select from &'ps'& output
38531 &`EXIWHAT_KILL_ARG  `& the argument for the &'kill'& command
38532 .endd
38533 An example of typical output from &'exiwhat'& is
38534 .code
38535 164 daemon: -q1h, listening on port 25
38536 10483 running queue: waiting for 0tAycK-0002ij-00 (10492)
38537 10492 delivering 0tAycK-0002ij-00 to mail.ref.example
38538   [10.19.42.42] (editor@ref.example)
38539 10592 handling incoming call from [192.168.243.242]
38540 10628 accepting a local non-SMTP message
38541 .endd
38542 The first number in the output line is the process number. The third line has
38543 been split here, in order to fit it on the page.
38544
38545
38546
38547 .section "Selective queue listing (exiqgrep)" "SECTgreptheque"
38548 .cindex "&'exiqgrep'&"
38549 .cindex "queue" "grepping"
38550 This utility is a Perl script contributed by Matt Hubbard. It runs
38551 .code
38552 exim -bpu
38553 .endd
38554 or (in case &*-a*& switch is specified)
38555 .code
38556 exim -bp
38557 .endd
38558 The &*-C*& option is used to specify an alternate &_exim.conf_& which might
38559 contain alternate exim configuration the queue management might be using.
38560
38561 to obtain a queue listing, and then greps the output to select messages
38562 that match given criteria. The following selection options are available:
38563
38564 .vlist
38565 .vitem &*-f*&&~<&'regex'&>
38566 Match the sender address using a case-insensitive search. The field that is
38567 tested is enclosed in angle brackets, so you can test for bounce messages with
38568 .code
38569 exiqgrep -f '^<>$'
38570 .endd
38571 .vitem &*-r*&&~<&'regex'&>
38572 Match a recipient address using a case-insensitive search. The field that is
38573 tested is not enclosed in angle brackets.
38574
38575 .vitem &*-s*&&~<&'regex'&>
38576 Match against the size field.
38577
38578 .vitem &*-y*&&~<&'seconds'&>
38579 Match messages that are younger than the given time.
38580
38581 .vitem &*-o*&&~<&'seconds'&>
38582 Match messages that are older than the given time.
38583
38584 .vitem &*-z*&
38585 Match only frozen messages.
38586
38587 .vitem &*-x*&
38588 Match only non-frozen messages.
38589
38590 .vitem &*-G*&&~<&'queuename'&>
38591 Match only messages in the given queue.  Without this, the default queue is searched.
38592 .endlist
38593
38594 The following options control the format of the output:
38595
38596 .vlist
38597 .vitem &*-c*&
38598 Display only the count of matching messages.
38599
38600 .vitem &*-l*&
38601 Long format &-- display the full message information as output by Exim. This is
38602 the default.
38603
38604 .vitem &*-i*&
38605 Display message ids only.
38606
38607 .vitem &*-b*&
38608 Brief format &-- one line per message.
38609
38610 .vitem &*-R*&
38611 Display messages in reverse order.
38612
38613 .vitem &*-a*&
38614 Include delivered recipients in queue listing.
38615 .endlist
38616
38617 There is one more option, &%-h%&, which outputs a list of options.
38618
38619
38620
38621 .section "Summarizing the queue (exiqsumm)" "SECTsumtheque"
38622 .cindex "&'exiqsumm'&"
38623 .cindex "queue" "summary"
38624 The &'exiqsumm'& utility is a Perl script which reads the output of &`exim
38625 -bp`& and produces a summary of the messages in the queue. Thus, you use it by
38626 running a command such as
38627 .code
38628 exim -bp | exiqsumm
38629 .endd
38630 The output consists of one line for each domain that has messages waiting for
38631 it, as in the following example:
38632 .code
38633 3   2322   74m   66m  msn.com.example
38634 .endd
38635 Each line lists the number of pending deliveries for a domain, their total
38636 volume, and the length of time that the oldest and the newest messages have
38637 been waiting. Note that the number of pending deliveries is greater than the
38638 number of messages when messages have more than one recipient.
38639
38640 A summary line is output at the end. By default the output is sorted on the
38641 domain name, but &'exiqsumm'& has the options &%-a%& and &%-c%&, which cause
38642 the output to be sorted by oldest message and by count of messages,
38643 respectively. There are also three options that split the messages for each
38644 domain into two or more subcounts: &%-b%& separates bounce messages, &%-f%&
38645 separates frozen messages, and &%-s%& separates messages according to their
38646 sender.
38647
38648 The output of &'exim -bp'& contains the original addresses in the message, so
38649 this also applies to the output from &'exiqsumm'&. No domains from addresses
38650 generated by aliasing or forwarding are included (unless the &%one_time%&
38651 option of the &(redirect)& router has been used to convert them into &"top
38652 level"& addresses).
38653
38654
38655
38656
38657 .section "Extracting specific information from the log (exigrep)" &&&
38658          "SECTextspeinf"
38659 .cindex "&'exigrep'&"
38660 .cindex "log" "extracts; grepping for"
38661 The &'exigrep'& utility is a Perl script that searches one or more main log
38662 files for entries that match a given pattern. When it finds a match, it
38663 extracts all the log entries for the relevant message, not just those that
38664 match the pattern. Thus, &'exigrep'& can extract complete log entries for a
38665 given message, or all mail for a given user, or for a given host, for example.
38666 The input files can be in Exim log format or syslog format.
38667 If a matching log line is not associated with a specific message, it is
38668 included in &'exigrep'&'s output without any additional lines. The usage is:
38669 .display
38670 &`exigrep [-t<`&&'n'&&`>] [-I] [-l] [-M] [-v] <`&&'pattern'&&`> [<`&&'log file'&&`>] ...`&
38671 .endd
38672 If no log filenames are given on the command line, the standard input is read.
38673
38674 The &%-t%& argument specifies a number of seconds. It adds an additional
38675 condition for message selection. Messages that are complete are shown only if
38676 they spent more than <&'n'&> seconds in the queue.
38677
38678 By default, &'exigrep'& does case-insensitive matching. The &%-I%& option
38679 makes it case-sensitive. This may give a performance improvement when searching
38680 large log files. Without &%-I%&, the Perl pattern matches use Perl's &`/i`&
38681 option; with &%-I%& they do not. In both cases it is possible to change the
38682 case sensitivity within the pattern by using &`(?i)`& or &`(?-i)`&.
38683
38684 The &%-l%& option means &"literal"&, that is, treat all characters in the
38685 pattern as standing for themselves. Otherwise the pattern must be a Perl
38686 regular expression.
38687
38688 The &%-v%& option inverts the matching condition. That is, a line is selected
38689 if it does &'not'& match the pattern.
38690
38691 The &%-M%& options means &"related messages"&. &'exigrep'& will show messages
38692 that are generated as a result/response to a message that &'exigrep'& matched
38693 normally.
38694
38695 Example of &%-M%&:
38696 user_a sends a message to user_b, which generates a bounce back to user_b. If
38697 &'exigrep'& is used to search for &"user_a"&, only the first message will be
38698 displayed.  But if &'exigrep'& is used to search for &"user_b"&, the first and
38699 the second (bounce) message will be displayed. Using &%-M%& with &'exigrep'&
38700 when searching for &"user_a"& will show both messages since the bounce is
38701 &"related"& to or a &"result"& of the first message that was found by the
38702 search term.
38703
38704 If the location of a &'zcat'& command is known from the definition of
38705 ZCAT_COMMAND in &_Local/Makefile_&, &'exigrep'& automatically passes any file
38706 whose name ends in COMPRESS_SUFFIX through &'zcat'& as it searches it.
38707 If the ZCAT_COMMAND is not executable, &'exigrep'& tries to use
38708 autodetection of some well known compression extensions.
38709
38710
38711 .section "Selecting messages by various criteria (exipick)" "SECTexipick"
38712 .cindex "&'exipick'&"
38713 John Jetmore's &'exipick'& utility is included in the Exim distribution. It
38714 lists messages from the queue according to a variety of criteria. For details
38715 of &'exipick'&'s facilities, run &'exipick'& with
38716 the &%--help%& option.
38717
38718
38719 .section "Cycling log files (exicyclog)" "SECTcyclogfil"
38720 .cindex "log" "cycling local files"
38721 .cindex "cycling logs"
38722 .cindex "&'exicyclog'&"
38723 The &'exicyclog'& script can be used to cycle (rotate) &'mainlog'& and
38724 &'rejectlog'& files. This is not necessary if only syslog is being used, or if
38725 you are using log files with datestamps in their names (see section
38726 &<<SECTdatlogfil>>&). Some operating systems have their own standard mechanisms
38727 for log cycling, and these can be used instead of &'exicyclog'& if preferred.
38728 There are two command line options for &'exicyclog'&:
38729 .ilist
38730 &%-k%& <&'count'&> specifies the number of log files to keep, overriding the
38731 default that is set when Exim is built. The default default is 10.
38732 .next
38733 &%-l%& <&'path'&> specifies the log file path, in the same format as Exim's
38734 &%log_file_path%& option (for example, &`/var/log/exim_%slog`&), again
38735 overriding the script's default, which is to find the setting from Exim's
38736 configuration.
38737 .endlist
38738
38739 Each time &'exicyclog'& is run the filenames get &"shuffled down"& by one. If
38740 the main log filename is &_mainlog_& (the default) then when &'exicyclog'& is
38741 run &_mainlog_& becomes &_mainlog.01_&, the previous &_mainlog.01_& becomes
38742 &_mainlog.02_& and so on, up to the limit that is set in the script or by the
38743 &%-k%& option. Log files whose numbers exceed the limit are discarded. Reject
38744 logs are handled similarly.
38745
38746 If the limit is greater than 99, the script uses 3-digit numbers such as
38747 &_mainlog.001_&, &_mainlog.002_&, etc. If you change from a number less than 99
38748 to one that is greater, or &'vice versa'&, you will have to fix the names of
38749 any existing log files.
38750
38751 If no &_mainlog_& file exists, the script does nothing. Files that &"drop off"&
38752 the end are deleted. All files with numbers greater than 01 are compressed,
38753 using a compression command which is configured by the COMPRESS_COMMAND
38754 setting in &_Local/Makefile_&. It is usual to run &'exicyclog'& daily from a
38755 root &%crontab%& entry of the form
38756 .code
38757 1 0 * * * su exim -c /usr/exim/bin/exicyclog
38758 .endd
38759 assuming you have used the name &"exim"& for the Exim user. You can run
38760 &'exicyclog'& as root if you wish, but there is no need.
38761
38762
38763
38764 .section "Mail statistics (eximstats)" "SECTmailstat"
38765 .cindex "statistics"
38766 .cindex "&'eximstats'&"
38767 A Perl script called &'eximstats'& is provided for extracting statistical
38768 information from log files. The output is either plain text, or HTML.
38769 . --- 2018-09-07: LogReport's Lire appears to be dead; website is a Yahoo Japan
38770 . --- 404 error and everything else points to that.
38771
38772 The &'eximstats'& script has been hacked about quite a bit over time. The
38773 latest version is the result of some extensive revision by Steve Campbell. A
38774 lot of information is given by default, but there are options for suppressing
38775 various parts of it. Following any options, the arguments to the script are a
38776 list of files, which should be main log files. For example:
38777 .code
38778 eximstats -nr /var/spool/exim/log/mainlog.01
38779 .endd
38780 By default, &'eximstats'& extracts information about the number and volume of
38781 messages received from or delivered to various hosts. The information is sorted
38782 both by message count and by volume, and the top fifty hosts in each category
38783 are listed on the standard output. Similar information, based on email
38784 addresses or domains instead of hosts can be requested by means of various
38785 options. For messages delivered and received locally, similar statistics are
38786 also produced per user.
38787
38788 The output also includes total counts and statistics about delivery errors, and
38789 histograms showing the number of messages received and deliveries made in each
38790 hour of the day. A delivery with more than one address in its envelope (for
38791 example, an SMTP transaction with more than one RCPT command) is counted
38792 as a single delivery by &'eximstats'&.
38793
38794 Though normally more deliveries than receipts are reported (as messages may
38795 have multiple recipients), it is possible for &'eximstats'& to report more
38796 messages received than delivered, even though the queue is empty at the start
38797 and end of the period in question. If an incoming message contains no valid
38798 recipients, no deliveries are recorded for it. A bounce message is handled as
38799 an entirely separate message.
38800
38801 &'eximstats'& always outputs a grand total summary giving the volume and number
38802 of messages received and deliveries made, and the number of hosts involved in
38803 each case. It also outputs the number of messages that were delayed (that is,
38804 not completely delivered at the first attempt), and the number that had at
38805 least one address that failed.
38806
38807 The remainder of the output is in sections that can be independently disabled
38808 or modified by various options. It consists of a summary of deliveries by
38809 transport, histograms of messages received and delivered per time interval
38810 (default per hour), information about the time messages spent in the queue,
38811 a list of relayed messages, lists of the top fifty sending hosts, local
38812 senders, destination hosts, and destination local users by count and by volume,
38813 and a list of delivery errors that occurred.
38814
38815 The relay information lists messages that were actually relayed, that is, they
38816 came from a remote host and were directly delivered to some other remote host,
38817 without being processed (for example, for aliasing or forwarding) locally.
38818
38819 There are quite a few options for &'eximstats'& to control exactly what it
38820 outputs. These are documented in the Perl script itself, and can be extracted
38821 by running the command &(perldoc)& on the script. For example:
38822 .code
38823 perldoc /usr/exim/bin/eximstats
38824 .endd
38825
38826 .section "Checking access policy (exim_checkaccess)" "SECTcheckaccess"
38827 .cindex "&'exim_checkaccess'&"
38828 .cindex "policy control" "checking access"
38829 .cindex "checking access"
38830 The &%-bh%& command line argument allows you to run a fake SMTP session with
38831 debugging output, in order to check what Exim is doing when it is applying
38832 policy controls to incoming SMTP mail. However, not everybody is sufficiently
38833 familiar with the SMTP protocol to be able to make full use of &%-bh%&, and
38834 sometimes you just want to answer the question &"Does this address have
38835 access?"& without bothering with any further details.
38836
38837 The &'exim_checkaccess'& utility is a &"packaged"& version of &%-bh%&. It takes
38838 two arguments, an IP address and an email address:
38839 .code
38840 exim_checkaccess 10.9.8.7 A.User@a.domain.example
38841 .endd
38842 The utility runs a call to Exim with the &%-bh%& option, to test whether the
38843 given email address would be accepted in a RCPT command in a TCP/IP
38844 connection from the host with the given IP address. The output of the utility
38845 is either the word &"accepted"&, or the SMTP error response, for example:
38846 .code
38847 Rejected:
38848 550 Relay not permitted
38849 .endd
38850 When running this test, the utility uses &`<>`& as the envelope sender address
38851 for the MAIL command, but you can change this by providing additional
38852 options. These are passed directly to the Exim command. For example, to specify
38853 that the test is to be run with the sender address &'himself@there.example'&
38854 you can use:
38855 .code
38856 exim_checkaccess 10.9.8.7 A.User@a.domain.example \
38857                  -f himself@there.example
38858 .endd
38859 Note that these additional Exim command line items must be given after the two
38860 mandatory arguments.
38861
38862 Because the &%exim_checkaccess%& uses &%-bh%&, it does not perform callouts
38863 while running its checks. You can run checks that include callouts by using
38864 &%-bhc%&, but this is not yet available in a &"packaged"& form.
38865
38866
38867
38868 .section "Making DBM files (exim_dbmbuild)" "SECTdbmbuild"
38869 .cindex "DBM" "building dbm files"
38870 .cindex "building DBM files"
38871 .cindex "&'exim_dbmbuild'&"
38872 .cindex "lower casing"
38873 .cindex "binary zero" "in lookup key"
38874 The &'exim_dbmbuild'& program reads an input file containing keys and data in
38875 the format used by the &(lsearch)& lookup (see section
38876 &<<SECTsinglekeylookups>>&). It writes a DBM file using the lower-cased alias
38877 names as keys and the remainder of the information as data. The lower-casing
38878 can be prevented by calling the program with the &%-nolc%& option.
38879
38880 A terminating zero is included as part of the key string. This is expected by
38881 the &(dbm)& lookup type. However, if the option &%-nozero%& is given,
38882 &'exim_dbmbuild'& creates files without terminating zeroes in either the key
38883 strings or the data strings. The &(dbmnz)& lookup type can be used with such
38884 files.
38885
38886 The program requires two arguments: the name of the input file (which can be a
38887 single hyphen to indicate the standard input), and the name of the output file.
38888 It creates the output under a temporary name, and then renames it if all went
38889 well.
38890
38891 .cindex "USE_DB"
38892 If the native DB interface is in use (USE_DB is set in a compile-time
38893 configuration file &-- this is common in free versions of Unix) the two
38894 filenames must be different, because in this mode the Berkeley DB functions
38895 create a single output file using exactly the name given. For example,
38896 .code
38897 exim_dbmbuild /etc/aliases /etc/aliases.db
38898 .endd
38899 reads the system alias file and creates a DBM version of it in
38900 &_/etc/aliases.db_&.
38901
38902 In systems that use the &'ndbm'& routines (mostly proprietary versions of
38903 Unix), two files are used, with the suffixes &_.dir_& and &_.pag_&. In this
38904 environment, the suffixes are added to the second argument of
38905 &'exim_dbmbuild'&, so it can be the same as the first. This is also the case
38906 when the Berkeley functions are used in compatibility mode (though this is not
38907 recommended), because in that case it adds a &_.db_& suffix to the filename.
38908
38909 If a duplicate key is encountered, the program outputs a warning, and when it
38910 finishes, its return code is 1 rather than zero, unless the &%-noduperr%&
38911 option is used. By default, only the first of a set of duplicates is used &--
38912 this makes it compatible with &(lsearch)& lookups. There is an option
38913 &%-lastdup%& which causes it to use the data for the last duplicate instead.
38914 There is also an option &%-nowarn%&, which stops it listing duplicate keys to
38915 &%stderr%&. For other errors, where it doesn't actually make a new file, the
38916 return code is 2.
38917
38918
38919
38920
38921 .section "Finding individual retry times (exinext)" "SECTfinindret"
38922 .cindex "retry" "times"
38923 .cindex "&'exinext'&"
38924 A utility called &'exinext'& (mostly a Perl script) provides the ability to
38925 fish specific information out of the retry database. Given a mail domain (or a
38926 complete address), it looks up the hosts for that domain, and outputs any retry
38927 information for the hosts or for the domain. At present, the retry information
38928 is obtained by running &'exim_dumpdb'& (see below) and post-processing the
38929 output. For example:
38930 .code
38931 $ exinext piglet@milne.fict.example
38932 kanga.milne.example:192.168.8.1 error 146: Connection refused
38933   first failed: 21-Feb-1996 14:57:34
38934   last tried:   21-Feb-1996 14:57:34
38935   next try at:  21-Feb-1996 15:02:34
38936 roo.milne.example:192.168.8.3 error 146: Connection refused
38937   first failed: 20-Jan-1996 13:12:08
38938   last tried:   21-Feb-1996 11:42:03
38939   next try at:  21-Feb-1996 19:42:03
38940   past final cutoff time
38941 .endd
38942 You can also give &'exinext'& a local part, without a domain, and it
38943 will give any retry information for that local part in your default domain.
38944 A message id can be used to obtain retry information pertaining to a specific
38945 message. This exists only when an attempt to deliver a message to a remote host
38946 suffers a message-specific error (see section &<<SECToutSMTPerr>>&).
38947 &'exinext'& is not particularly efficient, but then it is not expected to be
38948 run very often.
38949
38950 The &'exinext'& utility calls Exim to find out information such as the location
38951 of the spool directory. The utility has &%-C%& and &%-D%& options, which are
38952 passed on to the &'exim'& commands. The first specifies an alternate Exim
38953 configuration file, and the second sets macros for use within the configuration
38954 file. These features are mainly to help in testing, but might also be useful in
38955 environments where more than one configuration file is in use.
38956
38957
38958
38959 .section "Hints database maintenance" "SECThindatmai"
38960 .cindex "hints database" "maintenance"
38961 .cindex "maintaining Exim's hints database"
38962 Three utility programs are provided for maintaining the DBM files that Exim
38963 uses to contain its delivery hint information. Each program requires two
38964 arguments. The first specifies the name of Exim's spool directory, and the
38965 second is the name of the database it is to operate on. These are as follows:
38966
38967 .ilist
38968 &'retry'&: the database of retry information
38969 .next
38970 &'wait-'&<&'transport name'&>: databases of information about messages waiting
38971 for remote hosts
38972 .next
38973 &'callout'&: the callout cache
38974 .next
38975 &'ratelimit'&: the data for implementing the ratelimit ACL condition
38976 .next
38977 &'misc'&: other hints data
38978 .endlist
38979
38980 The &'misc'& database is used for
38981
38982 .ilist
38983 Serializing ETRN runs (when &%smtp_etrn_serialize%& is set)
38984 .next
38985 Serializing delivery to a specific host (when &%serialize_hosts%& is set in an
38986 &(smtp)& transport)
38987 .next
38988 Limiting the concurrency of specific transports (when &%max_parallel%& is set
38989 in a transport)
38990 .endlist
38991
38992
38993
38994 .section "exim_dumpdb" "SECID261"
38995 .cindex "&'exim_dumpdb'&"
38996 The entire contents of a database are written to the standard output by the
38997 &'exim_dumpdb'& program, which has no options or arguments other than the
38998 spool and database names. For example, to dump the retry database:
38999 .code
39000 exim_dumpdb /var/spool/exim retry
39001 .endd
39002 Two lines of output are produced for each entry:
39003 .code
39004 T:mail.ref.example:192.168.242.242 146 77 Connection refused
39005 31-Oct-1995 12:00:12 02-Nov-1995 12:21:39 02-Nov-1995 20:21:39 *
39006 .endd
39007 The first item on the first line is the key of the record. It starts with one
39008 of the letters R, or T, depending on whether it refers to a routing or
39009 transport retry. For a local delivery, the next part is the local address; for
39010 a remote delivery it is the name of the remote host, followed by its failing IP
39011 address (unless &%retry_include_ip_address%& is set false on the &(smtp)&
39012 transport). If the remote port is not the standard one (port 25), it is added
39013 to the IP address. Then there follows an error code, an additional error code,
39014 and a textual description of the error.
39015
39016 The three times on the second line are the time of first failure, the time of
39017 the last delivery attempt, and the computed time for the next attempt. The line
39018 ends with an asterisk if the cutoff time for the last retry rule has been
39019 exceeded.
39020
39021 Each output line from &'exim_dumpdb'& for the &'wait-xxx'& databases
39022 consists of a host name followed by a list of ids for messages that are or were
39023 waiting to be delivered to that host. If there are a very large number for any
39024 one host, continuation records, with a sequence number added to the host name,
39025 may be seen. The data in these records is often out of date, because a message
39026 may be routed to several alternative hosts, and Exim makes no effort to keep
39027 cross-references.
39028
39029
39030
39031 .section "exim_tidydb" "SECID262"
39032 .cindex "&'exim_tidydb'&"
39033 The &'exim_tidydb'& utility program is used to tidy up the contents of a hints
39034 database. If run with no options, it removes all records that are more than 30
39035 days old. The age is calculated from the date and time that the record was last
39036 updated. Note that, in the case of the retry database, it is &'not'& the time
39037 since the first delivery failure. Information about a host that has been down
39038 for more than 30 days will remain in the database, provided that the record is
39039 updated sufficiently often.
39040
39041 The cutoff date can be altered by means of the &%-t%& option, which must be
39042 followed by a time. For example, to remove all records older than a week from
39043 the retry database:
39044 .code
39045 exim_tidydb -t 7d /var/spool/exim retry
39046 .endd
39047 Both the &'wait-xxx'& and &'retry'& databases contain items that involve
39048 message ids. In the former these appear as data in records keyed by host &--
39049 they were messages that were waiting for that host &-- and in the latter they
39050 are the keys for retry information for messages that have suffered certain
39051 types of error. When &'exim_tidydb'& is run, a check is made to ensure that
39052 message ids in database records are those of messages that are still on the
39053 queue. Message ids for messages that no longer exist are removed from
39054 &'wait-xxx'& records, and if this leaves any records empty, they are deleted.
39055 For the &'retry'& database, records whose keys are non-existent message ids are
39056 removed. The &'exim_tidydb'& utility outputs comments on the standard output
39057 whenever it removes information from the database.
39058
39059 Certain records are automatically removed by Exim when they are no longer
39060 needed, but others are not. For example, if all the MX hosts for a domain are
39061 down, a retry record is created for each one. If the primary MX host comes back
39062 first, its record is removed when Exim successfully delivers to it, but the
39063 records for the others remain because Exim has not tried to use those hosts.
39064
39065 It is important, therefore, to run &'exim_tidydb'& periodically on all the
39066 hints databases. You should do this at a quiet time of day, because it requires
39067 a database to be locked (and therefore inaccessible to Exim) while it does its
39068 work. Removing records from a DBM file does not normally make the file smaller,
39069 but all the common DBM libraries are able to re-use the space that is released.
39070 After an initial phase of increasing in size, the databases normally reach a
39071 point at which they no longer get any bigger, as long as they are regularly
39072 tidied.
39073
39074 &*Warning*&: If you never run &'exim_tidydb'&, the space used by the hints
39075 databases is likely to keep on increasing.
39076
39077
39078
39079
39080 .section "exim_fixdb" "SECID263"
39081 .cindex "&'exim_fixdb'&"
39082 The &'exim_fixdb'& program is a utility for interactively modifying databases.
39083 Its main use is for testing Exim, but it might also be occasionally useful for
39084 getting round problems in a live system. It has no options, and its interface
39085 is somewhat crude. On entry, it prompts for input with a right angle-bracket. A
39086 key of a database record can then be entered, and the data for that record is
39087 displayed.
39088
39089 If &"d"& is typed at the next prompt, the entire record is deleted. For all
39090 except the &'retry'& database, that is the only operation that can be carried
39091 out. For the &'retry'& database, each field is output preceded by a number, and
39092 data for individual fields can be changed by typing the field number followed
39093 by new data, for example:
39094 .code
39095 > 4 951102:1000
39096 .endd
39097 resets the time of the next delivery attempt. Time values are given as a
39098 sequence of digit pairs for year, month, day, hour, and minute. Colons can be
39099 used as optional separators.
39100
39101
39102
39103
39104 .section "Mailbox maintenance (exim_lock)" "SECTmailboxmaint"
39105 .cindex "mailbox" "maintenance"
39106 .cindex "&'exim_lock'&"
39107 .cindex "locking mailboxes"
39108 The &'exim_lock'& utility locks a mailbox file using the same algorithm as
39109 Exim. For a discussion of locking issues, see section &<<SECTopappend>>&.
39110 &'Exim_lock'& can be used to prevent any modification of a mailbox by Exim or
39111 a user agent while investigating a problem. The utility requires the name of
39112 the file as its first argument. If the locking is successful, the second
39113 argument is run as a command (using C's &[system()]& function); if there is no
39114 second argument, the value of the SHELL environment variable is used; if this
39115 is unset or empty, &_/bin/sh_& is run. When the command finishes, the mailbox
39116 is unlocked and the utility ends. The following options are available:
39117
39118 .vlist
39119 .vitem &%-fcntl%&
39120 Use &[fcntl()]& locking on the open mailbox.
39121
39122 .vitem &%-flock%&
39123 Use &[flock()]& locking on the open mailbox, provided the operating system
39124 supports it.
39125
39126 .vitem &%-interval%&
39127 This must be followed by a number, which is a number of seconds; it sets the
39128 interval to sleep between retries (default 3).
39129
39130 .vitem &%-lockfile%&
39131 Create a lock file before opening the mailbox.
39132
39133 .vitem &%-mbx%&
39134 Lock the mailbox using MBX rules.
39135
39136 .vitem &%-q%&
39137 Suppress verification output.
39138
39139 .vitem &%-retries%&
39140 This must be followed by a number; it sets the number of times to try to get
39141 the lock (default 10).
39142
39143 .vitem &%-restore_time%&
39144 This option causes &%exim_lock%& to restore the modified and read times to the
39145 locked file before exiting. This allows you to access a locked mailbox (for
39146 example, to take a backup copy) without disturbing the times that the user
39147 subsequently sees.
39148
39149 .vitem &%-timeout%&
39150 This must be followed by a number, which is a number of seconds; it sets a
39151 timeout to be used with a blocking &[fcntl()]& lock. If it is not set (the
39152 default), a non-blocking call is used.
39153
39154 .vitem &%-v%&
39155 Generate verbose output.
39156 .endlist
39157
39158 If none of &%-fcntl%&, &%-flock%&, &%-lockfile%& or &%-mbx%& are given, the
39159 default is to create a lock file and also to use &[fcntl()]& locking on the
39160 mailbox, which is the same as Exim's default. The use of &%-flock%& or
39161 &%-fcntl%& requires that the file be writeable; the use of &%-lockfile%&
39162 requires that the directory containing the file be writeable. Locking by lock
39163 file does not last forever; Exim assumes that a lock file is expired if it is
39164 more than 30 minutes old.
39165
39166 The &%-mbx%& option can be used with either or both of &%-fcntl%& or
39167 &%-flock%&. It assumes &%-fcntl%& by default. MBX locking causes a shared lock
39168 to be taken out on the open mailbox, and an exclusive lock on the file
39169 &_/tmp/.n.m_& where &'n'& and &'m'& are the device number and inode
39170 number of the mailbox file. When the locking is released, if an exclusive lock
39171 can be obtained for the mailbox, the file in &_/tmp_& is deleted.
39172
39173 The default output contains verification of the locking that takes place. The
39174 &%-v%& option causes some additional information to be given. The &%-q%& option
39175 suppresses all output except error messages.
39176
39177 A command such as
39178 .code
39179 exim_lock /var/spool/mail/spqr
39180 .endd
39181 runs an interactive shell while the file is locked, whereas
39182 .display
39183 &`exim_lock -q /var/spool/mail/spqr <<End`&
39184 <&'some commands'&>
39185 &`End`&
39186 .endd
39187 runs a specific non-interactive sequence of commands while the file is locked,
39188 suppressing all verification output. A single command can be run by a command
39189 such as
39190 .code
39191 exim_lock -q /var/spool/mail/spqr \
39192   "cp /var/spool/mail/spqr /some/where"
39193 .endd
39194 Note that if a command is supplied, it must be entirely contained within the
39195 second argument &-- hence the quotes.
39196 .ecindex IIDutils
39197
39198
39199 . ////////////////////////////////////////////////////////////////////////////
39200 . ////////////////////////////////////////////////////////////////////////////
39201
39202 .chapter "The Exim monitor" "CHAPeximon"
39203 .scindex IIDeximon "Exim monitor" "description"
39204 .cindex "X-windows"
39205 .cindex "&'eximon'&"
39206 .cindex "Local/eximon.conf"
39207 .cindex "&_exim_monitor/EDITME_&"
39208 The Exim monitor is an application which displays in an X window information
39209 about the state of Exim's queue and what Exim is doing. An admin user can
39210 perform certain operations on messages from this GUI interface; however all
39211 such facilities are also available from the command line, and indeed, the
39212 monitor itself makes use of the command line to perform any actions requested.
39213
39214
39215
39216 .section "Running the monitor" "SECID264"
39217 The monitor is started by running the script called &'eximon'&. This is a shell
39218 script that sets up a number of environment variables, and then runs the
39219 binary called &_eximon.bin_&. The default appearance of the monitor window can
39220 be changed by editing the &_Local/eximon.conf_& file created by editing
39221 &_exim_monitor/EDITME_&. Comments in that file describe what the various
39222 parameters are for.
39223
39224 The parameters that get built into the &'eximon'& script can be overridden for
39225 a particular invocation by setting up environment variables of the same names,
39226 preceded by &`EXIMON_`&. For example, a shell command such as
39227 .code
39228 EXIMON_LOG_DEPTH=400 eximon
39229 .endd
39230 (in a Bourne-compatible shell) runs &'eximon'& with an overriding setting of
39231 the LOG_DEPTH parameter. If EXIMON_LOG_FILE_PATH is set in the environment, it
39232 overrides the Exim log file configuration. This makes it possible to have
39233 &'eximon'& tailing log data that is written to syslog, provided that MAIL.INFO
39234 syslog messages are routed to a file on the local host.
39235
39236 X resources can be used to change the appearance of the window in the normal
39237 way. For example, a resource setting of the form
39238 .code
39239 Eximon*background: gray94
39240 .endd
39241 changes the colour of the background to light grey rather than white. The
39242 stripcharts are drawn with both the data lines and the reference lines in
39243 black. This means that the reference lines are not visible when on top of the
39244 data. However, their colour can be changed by setting a resource called
39245 &"highlight"& (an odd name, but that's what the Athena stripchart widget uses).
39246 For example, if your X server is running Unix, you could set up lighter
39247 reference lines in the stripcharts by obeying
39248 .code
39249 xrdb -merge <<End
39250 Eximon*highlight: gray
39251 End
39252 .endd
39253 .cindex "admin user"
39254 In order to see the contents of messages in the queue, and to operate on them,
39255 &'eximon'& must either be run as root or by an admin user.
39256
39257 The command-line parameters of &'eximon'& are passed to &_eximon.bin_& and may
39258 contain X11 resource parameters interpreted by the X11 library.  In addition,
39259 if the first parameter starts with the string "gdb" then it is removed and the
39260 binary is invoked under gdb (the parameter is used as the gdb command-name, so
39261 versioned variants of gdb can be invoked).
39262
39263 The monitor's window is divided into three parts. The first contains one or
39264 more stripcharts and two action buttons, the second contains a &"tail"& of the
39265 main log file, and the third is a display of the queue of messages awaiting
39266 delivery, with two more action buttons. The following sections describe these
39267 different parts of the display.
39268
39269
39270
39271
39272 .section "The stripcharts" "SECID265"
39273 .cindex "stripchart"
39274 The first stripchart is always a count of messages in the queue. Its name can
39275 be configured by setting QUEUE_STRIPCHART_NAME in the
39276 &_Local/eximon.conf_& file. The remaining stripcharts are defined in the
39277 configuration script by regular expression matches on log file entries, making
39278 it possible to display, for example, counts of messages delivered to certain
39279 hosts or using certain transports. The supplied defaults display counts of
39280 received and delivered messages, and of local and SMTP deliveries. The default
39281 period between stripchart updates is one minute; this can be adjusted by a
39282 parameter in the &_Local/eximon.conf_& file.
39283
39284 The stripchart displays rescale themselves automatically as the value they are
39285 displaying changes. There are always 10 horizontal lines in each chart; the
39286 title string indicates the value of each division when it is greater than one.
39287 For example, &"x2"& means that each division represents a value of 2.
39288
39289 It is also possible to have a stripchart which shows the percentage fullness of
39290 a particular disk partition, which is useful when local deliveries are confined
39291 to a single partition.
39292
39293 .cindex "&%statvfs%& function"
39294 This relies on the availability of the &[statvfs()]& function or equivalent in
39295 the operating system. Most, but not all versions of Unix that support Exim have
39296 this. For this particular stripchart, the top of the chart always represents
39297 100%, and the scale is given as &"x10%"&. This chart is configured by setting
39298 SIZE_STRIPCHART and (optionally) SIZE_STRIPCHART_NAME in the
39299 &_Local/eximon.conf_& file.
39300
39301
39302
39303
39304 .section "Main action buttons" "SECID266"
39305 .cindex "size" "of monitor window"
39306 .cindex "Exim monitor" "window size"
39307 .cindex "window size"
39308 Below the stripcharts there is an action button for quitting the monitor. Next
39309 to this is another button marked &"Size"&. They are placed here so that
39310 shrinking the window to its default minimum size leaves just the queue count
39311 stripchart and these two buttons visible. Pressing the &"Size"& button causes
39312 the window to expand to its maximum size, unless it is already at the maximum,
39313 in which case it is reduced to its minimum.
39314
39315 When expanding to the maximum, if the window cannot be fully seen where it
39316 currently is, it is moved back to where it was the last time it was at full
39317 size. When it is expanding from its minimum size, the old position is
39318 remembered, and next time it is reduced to the minimum it is moved back there.
39319
39320 The idea is that you can keep a reduced window just showing one or two
39321 stripcharts at a convenient place on your screen, easily expand it to show
39322 the full window when required, and just as easily put it back to what it was.
39323 The idea is copied from what the &'twm'& window manager does for its
39324 &'f.fullzoom'& action. The minimum size of the window can be changed by setting
39325 the MIN_HEIGHT and MIN_WIDTH values in &_Local/eximon.conf_&.
39326
39327 Normally, the monitor starts up with the window at its full size, but it can be
39328 built so that it starts up with the window at its smallest size, by setting
39329 START_SMALL=yes in &_Local/eximon.conf_&.
39330
39331
39332
39333 .section "The log display" "SECID267"
39334 .cindex "log" "tail of; in monitor"
39335 The second section of the window is an area in which a display of the tail of
39336 the main log is maintained.
39337 To save space on the screen, the timestamp on each log line is shortened by
39338 removing the date and, if &%log_timezone%& is set, the timezone.
39339 The log tail is not available when the only destination for logging data is
39340 syslog, unless the syslog lines are routed to a local file whose name is passed
39341 to &'eximon'& via the EXIMON_LOG_FILE_PATH environment variable.
39342
39343 The log sub-window has a scroll bar at its lefthand side which can be used to
39344 move back to look at earlier text, and the up and down arrow keys also have a
39345 scrolling effect. The amount of log that is kept depends on the setting of
39346 LOG_BUFFER in &_Local/eximon.conf_&, which specifies the amount of memory
39347 to use. When this is full, the earlier 50% of data is discarded &-- this is
39348 much more efficient than throwing it away line by line. The sub-window also has
39349 a horizontal scroll bar for accessing the ends of long log lines. This is the
39350 only means of horizontal scrolling; the right and left arrow keys are not
39351 available. Text can be cut from this part of the window using the mouse in the
39352 normal way. The size of this subwindow is controlled by parameters in the
39353 configuration file &_Local/eximon.conf_&.
39354
39355 Searches of the text in the log window can be carried out by means of the ^R
39356 and ^S keystrokes, which default to a reverse and a forward search,
39357 respectively. The search covers only the text that is displayed in the window.
39358 It cannot go further back up the log.
39359
39360 The point from which the search starts is indicated by a caret marker. This is
39361 normally at the end of the text in the window, but can be positioned explicitly
39362 by pointing and clicking with the left mouse button, and is moved automatically
39363 by a successful search. If new text arrives in the window when it is scrolled
39364 back, the caret remains where it is, but if the window is not scrolled back,
39365 the caret is moved to the end of the new text.
39366
39367 Pressing ^R or ^S pops up a window into which the search text can be typed.
39368 There are buttons for selecting forward or reverse searching, for carrying out
39369 the search, and for cancelling. If the &"Search"& button is pressed, the search
39370 happens and the window remains so that further searches can be done. If the
39371 &"Return"& key is pressed, a single search is done and the window is closed. If
39372 ^C is typed the search is cancelled.
39373
39374 The searching facility is implemented using the facilities of the Athena text
39375 widget. By default this pops up a window containing both &"search"& and
39376 &"replace"& options. In order to suppress the unwanted &"replace"& portion for
39377 eximon, a modified version of the &%TextPop%& widget is distributed with Exim.
39378 However, the linkers in BSDI and HP-UX seem unable to handle an externally
39379 provided version of &%TextPop%& when the remaining parts of the text widget
39380 come from the standard libraries. The compile-time option EXIMON_TEXTPOP can be
39381 unset to cut out the modified &%TextPop%&, making it possible to build Eximon
39382 on these systems, at the expense of having unwanted items in the search popup
39383 window.
39384
39385
39386
39387 .section "The queue display" "SECID268"
39388 .cindex "queue" "display in monitor"
39389 The bottom section of the monitor window contains a list of all messages that
39390 are in the queue, which includes those currently being received or delivered,
39391 as well as those awaiting delivery. The size of this subwindow is controlled by
39392 parameters in the configuration file &_Local/eximon.conf_&, and the frequency
39393 at which it is updated is controlled by another parameter in the same file &--
39394 the default is 5 minutes, since queue scans can be quite expensive. However,
39395 there is an &"Update"& action button just above the display which can be used
39396 to force an update of the queue display at any time.
39397
39398 When a host is down for some time, a lot of pending mail can build up for it,
39399 and this can make it hard to deal with other messages in the queue. To help
39400 with this situation there is a button next to &"Update"& called &"Hide"&. If
39401 pressed, a dialogue box called &"Hide addresses ending with"& is put up. If you
39402 type anything in here and press &"Return"&, the text is added to a chain of
39403 such texts, and if every undelivered address in a message matches at least one
39404 of the texts, the message is not displayed.
39405
39406 If there is an address that does not match any of the texts, all the addresses
39407 are displayed as normal. The matching happens on the ends of addresses so, for
39408 example, &'cam.ac.uk'& specifies all addresses in Cambridge, while
39409 &'xxx@foo.com.example'& specifies just one specific address. When any hiding
39410 has been set up, a button called &"Unhide"& is displayed. If pressed, it
39411 cancels all hiding. Also, to ensure that hidden messages do not get forgotten,
39412 a hide request is automatically cancelled after one hour.
39413
39414 While the dialogue box is displayed, you can't press any buttons or do anything
39415 else to the monitor window. For this reason, if you want to cut text from the
39416 queue display to use in the dialogue box, you have to do the cutting before
39417 pressing the &"Hide"& button.
39418
39419 The queue display contains, for each unhidden queued message, the length of
39420 time it has been in the queue, the size of the message, the message id, the
39421 message sender, and the first undelivered recipient, all on one line. If it is
39422 a bounce message, the sender is shown as &"<>"&. If there is more than one
39423 recipient to which the message has not yet been delivered, subsequent ones are
39424 listed on additional lines, up to a maximum configured number, following which
39425 an ellipsis is displayed. Recipients that have already received the message are
39426 not shown.
39427
39428 .cindex "frozen messages" "display"
39429 If a message is frozen, an asterisk is displayed at the left-hand side.
39430
39431 The queue display has a vertical scroll bar, and can also be scrolled by means
39432 of the arrow keys. Text can be cut from it using the mouse in the normal way.
39433 The text searching facilities, as described above for the log window, are also
39434 available, but the caret is always moved to the end of the text when the queue
39435 display is updated.
39436
39437
39438
39439 .section "The queue menu" "SECID269"
39440 .cindex "queue" "menu in monitor"
39441 If the &%shift%& key is held down and the left button is clicked when the mouse
39442 pointer is over the text for any message, an action menu pops up, and the first
39443 line of the queue display for the message is highlighted. This does not affect
39444 any selected text.
39445
39446 If you want to use some other event for popping up the menu, you can set the
39447 MENU_EVENT parameter in &_Local/eximon.conf_& to change the default, or
39448 set EXIMON_MENU_EVENT in the environment before starting the monitor. The
39449 value set in this parameter is a standard X event description. For example, to
39450 run eximon using &%ctrl%& rather than &%shift%& you could use
39451 .code
39452 EXIMON_MENU_EVENT='Ctrl<Btn1Down>' eximon
39453 .endd
39454 The title of the menu is the message id, and it contains entries which act as
39455 follows:
39456
39457 .ilist
39458 &'message log'&: The contents of the message log for the message are displayed
39459 in a new text window.
39460 .next
39461 &'headers'&: Information from the spool file that contains the envelope
39462 information and headers is displayed in a new text window. See chapter
39463 &<<CHAPspool>>& for a description of the format of spool files.
39464 .next
39465 &'body'&: The contents of the spool file containing the body of the message are
39466 displayed in a new text window. There is a default limit of 20,000 bytes to the
39467 amount of data displayed. This can be changed by setting the BODY_MAX
39468 option at compile time, or the EXIMON_BODY_MAX option at runtime.
39469 .next
39470 &'deliver message'&: A call to Exim is made using the &%-M%& option to request
39471 delivery of the message. This causes an automatic thaw if the message is
39472 frozen. The &%-v%& option is also set, and the output from Exim is displayed in
39473 a new text window. The delivery is run in a separate process, to avoid holding
39474 up the monitor while the delivery proceeds.
39475 .next
39476 &'freeze message'&: A call to Exim is made using the &%-Mf%& option to request
39477 that the message be frozen.
39478 .next
39479 .cindex "thawing messages"
39480 .cindex "unfreezing messages"
39481 .cindex "frozen messages" "thawing"
39482 &'thaw message'&: A call to Exim is made using the &%-Mt%& option to request
39483 that the message be thawed.
39484 .next
39485 .cindex "delivery" "forcing failure"
39486 &'give up on msg'&: A call to Exim is made using the &%-Mg%& option to request
39487 that Exim gives up trying to deliver the message. A bounce message is generated
39488 for any remaining undelivered addresses.
39489 .next
39490 &'remove message'&: A call to Exim is made using the &%-Mrm%& option to request
39491 that the message be deleted from the system without generating a bounce
39492 message.
39493 .next
39494 &'add recipient'&: A dialog box is displayed into which a recipient address can
39495 be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
39496 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
39497 Otherwise it must be entered as a fully qualified address. Pressing RETURN
39498 causes a call to Exim to be made using the &%-Mar%& option to request that an
39499 additional recipient be added to the message, unless the entry box is empty, in
39500 which case no action is taken.
39501 .next
39502 &'mark delivered'&: A dialog box is displayed into which a recipient address
39503 can be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
39504 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
39505 Otherwise it must be entered as a fully qualified address. Pressing RETURN
39506 causes a call to Exim to be made using the &%-Mmd%& option to mark the given
39507 recipient address as already delivered, unless the entry box is empty, in which
39508 case no action is taken.
39509 .next
39510 &'mark all delivered'&: A call to Exim is made using the &%-Mmad%& option to
39511 mark all recipient addresses as already delivered.
39512 .next
39513 &'edit sender'&: A dialog box is displayed initialized with the current
39514 sender's address. Pressing RETURN causes a call to Exim to be made using the
39515 &%-Mes%& option to replace the sender address, unless the entry box is empty,
39516 in which case no action is taken. If you want to set an empty sender (as in
39517 bounce messages), you must specify it as &"<>"&. Otherwise, if the address is
39518 not qualified and the QUALIFY_DOMAIN parameter is set in &_Local/eximon.conf_&,
39519 the address is qualified with that domain.
39520 .endlist
39521
39522 When a delivery is forced, a window showing the &%-v%& output is displayed. In
39523 other cases when a call to Exim is made, if there is any output from Exim (in
39524 particular, if the command fails) a window containing the command and the
39525 output is displayed. Otherwise, the results of the action are normally apparent
39526 from the log and queue displays. However, if you set ACTION_OUTPUT=yes in
39527 &_Local/eximon.conf_&, a window showing the Exim command is always opened, even
39528 if no output is generated.
39529
39530 The queue display is automatically updated for actions such as freezing and
39531 thawing, unless ACTION_QUEUE_UPDATE=no has been set in
39532 &_Local/eximon.conf_&. In this case the &"Update"& button has to be used to
39533 force an update of the display after one of these actions.
39534
39535 In any text window that is displayed as result of a menu action, the normal
39536 cut-and-paste facility is available, and searching can be carried out using ^R
39537 and ^S, as described above for the log tail window.
39538 .ecindex IIDeximon
39539
39540
39541
39542
39543
39544 . ////////////////////////////////////////////////////////////////////////////
39545 . ////////////////////////////////////////////////////////////////////////////
39546
39547 .chapter "Security considerations" "CHAPsecurity"
39548 .scindex IIDsecurcon "security" "discussion of"
39549 This chapter discusses a number of issues concerned with security, some of
39550 which are also covered in other parts of this manual.
39551
39552 For reasons that this author does not understand, some people have promoted
39553 Exim as a &"particularly secure"& mailer. Perhaps it is because of the
39554 existence of this chapter in the documentation. However, the intent of the
39555 chapter is simply to describe the way Exim works in relation to certain
39556 security concerns, not to make any specific claims about the effectiveness of
39557 its security as compared with other MTAs.
39558
39559 What follows is a description of the way Exim is supposed to be. Best efforts
39560 have been made to try to ensure that the code agrees with the theory, but an
39561 absence of bugs can never be guaranteed. Any that are reported will get fixed
39562 as soon as possible.
39563
39564
39565 .section "Building a more &""hardened""& Exim" "SECID286"
39566 .cindex "security" "build-time features"
39567 There are a number of build-time options that can be set in &_Local/Makefile_&
39568 to create Exim binaries that are &"harder"& to attack, in particular by a rogue
39569 Exim administrator who does not have the root password, or by someone who has
39570 penetrated the Exim (but not the root) account. These options are as follows:
39571
39572 .ilist
39573 ALT_CONFIG_PREFIX can be set to a string that is required to match the
39574 start of any filenames used with the &%-C%& option. When it is set, these
39575 filenames are also not allowed to contain the sequence &"/../"&. (However, if
39576 the value of the &%-C%& option is identical to the value of CONFIGURE_FILE in
39577 &_Local/Makefile_&, Exim ignores &%-C%& and proceeds as usual.) There is no
39578 default setting for &%ALT_CONFIG_PREFIX%&.
39579
39580 If the permitted configuration files are confined to a directory to
39581 which only root has access, this guards against someone who has broken
39582 into the Exim account from running a privileged Exim with an arbitrary
39583 configuration file, and using it to break into other accounts.
39584 .next
39585
39586 If a non-trusted configuration file (i.e. not the default configuration file
39587 or one which is trusted by virtue of being listed in the TRUSTED_CONFIG_LIST
39588 file) is specified with &%-C%&, or if macros are given with &%-D%& (but see
39589 the next item), then root privilege is retained only if the caller of Exim is
39590 root. This locks out the possibility of testing a configuration using &%-C%&
39591 right through message reception and delivery, even if the caller is root. The
39592 reception works, but by that time, Exim is running as the Exim user, so when
39593 it re-execs to regain privilege for the delivery, the use of &%-C%& causes
39594 privilege to be lost. However, root can test reception and delivery using two
39595 separate commands.
39596
39597 .next
39598 The WHITELIST_D_MACROS build option declares some macros to be safe to override
39599 with &%-D%& if the real uid is one of root, the Exim run-time user or the
39600 CONFIGURE_OWNER, if defined.  The potential impact of this option is limited by
39601 requiring the run-time value supplied to &%-D%& to match a regex that errs on
39602 the restrictive side.  Requiring build-time selection of safe macros is onerous
39603 but this option is intended solely as a transition mechanism to permit
39604 previously-working configurations to continue to work after release 4.73.
39605 .next
39606 If DISABLE_D_OPTION is defined, the use of the &%-D%& command line option
39607 is disabled.
39608 .next
39609 FIXED_NEVER_USERS can be set to a colon-separated list of users that are
39610 never to be used for any deliveries. This is like the &%never_users%& runtime
39611 option, but it cannot be overridden; the runtime option adds additional users
39612 to the list. The default setting is &"root"&; this prevents a non-root user who
39613 is permitted to modify the runtime file from using Exim as a way to get root.
39614 .endlist
39615
39616
39617
39618 .section "Root privilege" "SECID270"
39619 .cindex "setuid"
39620 .cindex "root privilege"
39621 The Exim binary is normally setuid to root, which means that it gains root
39622 privilege (runs as root) when it starts execution. In some special cases (for
39623 example, when the daemon is not in use and there are no local deliveries), it
39624 may be possible to run Exim setuid to some user other than root. This is
39625 discussed in the next section. However, in most installations, root privilege
39626 is required for two things:
39627
39628 .ilist
39629 To set up a socket connected to the standard SMTP port (25) when initialising
39630 the listening daemon. If Exim is run from &'inetd'&, this privileged action is
39631 not required.
39632 .next
39633 To be able to change uid and gid in order to read users' &_.forward_& files and
39634 perform local deliveries as the receiving user or as specified in the
39635 configuration.
39636 .endlist
39637
39638 It is not necessary to be root to do any of the other things Exim does, such as
39639 receiving messages and delivering them externally over SMTP, and it is
39640 obviously more secure if Exim does not run as root except when necessary.
39641 For this reason, a user and group for Exim to use must be defined in
39642 &_Local/Makefile_&. These are known as &"the Exim user"& and &"the Exim
39643 group"&. Their values can be changed by the runtime configuration, though this
39644 is not recommended. Often a user called &'exim'& is used, but some sites use
39645 &'mail'& or another user name altogether.
39646
39647 Exim uses &[setuid()]& whenever it gives up root privilege. This is a permanent
39648 abdication; the process cannot regain root afterwards. Prior to release 4.00,
39649 &[seteuid()]& was used in some circumstances, but this is no longer the case.
39650
39651 After a new Exim process has interpreted its command line options, it changes
39652 uid and gid in the following cases:
39653
39654 .ilist
39655 .oindex "&%-C%&"
39656 .oindex "&%-D%&"
39657 If the &%-C%& option is used to specify an alternate configuration file, or if
39658 the &%-D%& option is used to define macro values for the configuration, and the
39659 calling process is not running as root, the uid and gid are changed to those of
39660 the calling process.
39661 However, if DISABLE_D_OPTION is defined in &_Local/Makefile_&, the &%-D%&
39662 option may not be used at all.
39663 If WHITELIST_D_MACROS is defined in &_Local/Makefile_&, then some macro values
39664 can be supplied if the calling process is running as root, the Exim run-time
39665 user or CONFIGURE_OWNER, if defined.
39666 .next
39667 .oindex "&%-be%&"
39668 .oindex "&%-bf%&"
39669 .oindex "&%-bF%&"
39670 If the expansion test option (&%-be%&) or one of the filter testing options
39671 (&%-bf%& or &%-bF%&) are used, the uid and gid are changed to those of the
39672 calling process.
39673 .next
39674 If the process is not a daemon process or a queue runner process or a delivery
39675 process or a process for testing address routing (started with &%-bt%&), the
39676 uid and gid are changed to the Exim user and group. This means that Exim always
39677 runs under its own uid and gid when receiving messages. This also applies when
39678 testing address verification
39679 .oindex "&%-bv%&"
39680 .oindex "&%-bh%&"
39681 (the &%-bv%& option) and testing incoming message policy controls (the &%-bh%&
39682 option).
39683 .next
39684 For a daemon, queue runner, delivery, or address testing process, the uid
39685 remains as root at this stage, but the gid is changed to the Exim group.
39686 .endlist
39687
39688 The processes that initially retain root privilege behave as follows:
39689
39690 .ilist
39691 A daemon process changes the gid to the Exim group and the uid to the Exim
39692 user after setting up one or more listening sockets. The &[initgroups()]&
39693 function is called, so that if the Exim user is in any additional groups, they
39694 will be used during message reception.
39695 .next
39696 A queue runner process retains root privilege throughout its execution. Its
39697 job is to fork a controlled sequence of delivery processes.
39698 .next
39699 A delivery process retains root privilege throughout most of its execution,
39700 but any actual deliveries (that is, the transports themselves) are run in
39701 subprocesses which always change to a non-root uid and gid. For local
39702 deliveries this is typically the uid and gid of the owner of the mailbox; for
39703 remote deliveries, the Exim uid and gid are used. Once all the delivery
39704 subprocesses have been run, a delivery process changes to the Exim uid and gid
39705 while doing post-delivery tidying up such as updating the retry database and
39706 generating bounce and warning messages.
39707
39708 While the recipient addresses in a message are being routed, the delivery
39709 process runs as root. However, if a user's filter file has to be processed,
39710 this is done in a subprocess that runs under the individual user's uid and
39711 gid. A system filter is run as root unless &%system_filter_user%& is set.
39712 .next
39713 A process that is testing addresses (the &%-bt%& option) runs as root so that
39714 the routing is done in the same environment as a message delivery.
39715 .endlist
39716
39717
39718
39719
39720 .section "Running Exim without privilege" "SECTrunexiwitpri"
39721 .cindex "privilege, running without"
39722 .cindex "unprivileged running"
39723 .cindex "root privilege" "running without"
39724 Some installations like to run Exim in an unprivileged state for more of its
39725 operation, for added security. Support for this mode of operation is provided
39726 by the global option &%deliver_drop_privilege%&. When this is set, the uid and
39727 gid are changed to the Exim user and group at the start of a delivery process
39728 (and also queue runner and address testing processes). This means that address
39729 routing is no longer run as root, and the deliveries themselves cannot change
39730 to any other uid.
39731
39732 .cindex SIGHUP
39733 .cindex "daemon" "restarting"
39734 Leaving the binary setuid to root, but setting &%deliver_drop_privilege%& means
39735 that the daemon can still be started in the usual way, and it can respond
39736 correctly to SIGHUP because the re-invocation regains root privilege.
39737
39738 An alternative approach is to make Exim setuid to the Exim user and also setgid
39739 to the Exim group. If you do this, the daemon must be started from a root
39740 process. (Calling Exim from a root process makes it behave in the way it does
39741 when it is setuid root.) However, the daemon cannot restart itself after a
39742 SIGHUP signal because it cannot regain privilege.
39743
39744 It is still useful to set &%deliver_drop_privilege%& in this case, because it
39745 stops Exim from trying to re-invoke itself to do a delivery after a message has
39746 been received. Such a re-invocation is a waste of resources because it has no
39747 effect.
39748
39749 If restarting the daemon is not an issue (for example, if &%mua_wrapper%& is
39750 set, or &'inetd'& is being used instead of a daemon), having the binary setuid
39751 to the Exim user seems a clean approach, but there is one complication:
39752
39753 In this style of operation, Exim is running with the real uid and gid set to
39754 those of the calling process, and the effective uid/gid set to Exim's values.
39755 Ideally, any association with the calling process' uid/gid should be dropped,
39756 that is, the real uid/gid should be reset to the effective values so as to
39757 discard any privileges that the caller may have. While some operating systems
39758 have a function that permits this action for a non-root effective uid, quite a
39759 number of them do not. Because of this lack of standardization, Exim does not
39760 address this problem at this time.
39761
39762 For this reason, the recommended approach for &"mostly unprivileged"& running
39763 is to keep the Exim binary setuid to root, and to set
39764 &%deliver_drop_privilege%&. This also has the advantage of allowing a daemon to
39765 be used in the most straightforward way.
39766
39767 If you configure Exim not to run delivery processes as root, there are a
39768 number of restrictions on what you can do:
39769
39770 .ilist
39771 You can deliver only as the Exim user/group. You should  explicitly use the
39772 &%user%& and &%group%& options to override routers or local transports that
39773 normally deliver as the recipient. This makes sure that configurations that
39774 work in this mode function the same way in normal mode. Any implicit or
39775 explicit specification of another user causes an error.
39776 .next
39777 Use of &_.forward_& files is severely restricted, such that it is usually
39778 not worthwhile to include them in the configuration.
39779 .next
39780 Users who wish to use &_.forward_& would have to make their home directory and
39781 the file itself accessible to the Exim user. Pipe and append-to-file entries,
39782 and their equivalents in Exim filters, cannot be used. While they could be
39783 enabled in the Exim user's name, that would be insecure and not very useful.
39784 .next
39785 Unless the local user mailboxes are all owned by the Exim user (possible in
39786 some POP3 or IMAP-only environments):
39787
39788 .olist
39789 They must be owned by the Exim group and be writeable by that group. This
39790 implies you must set &%mode%& in the appendfile configuration, as well as the
39791 mode of the mailbox files themselves.
39792 .next
39793 You must set &%no_check_owner%&, since most or all of the files will not be
39794 owned by the Exim user.
39795 .next
39796 You must set &%file_must_exist%&, because Exim cannot set the owner correctly
39797 on a newly created mailbox when unprivileged. This also implies that new
39798 mailboxes need to be created manually.
39799 .endlist olist
39800 .endlist ilist
39801
39802
39803 These restrictions severely restrict what can be done in local deliveries.
39804 However, there are no restrictions on remote deliveries. If you are running a
39805 gateway host that does no local deliveries, setting &%deliver_drop_privilege%&
39806 gives more security at essentially no cost.
39807
39808 If you are using the &%mua_wrapper%& facility (see chapter
39809 &<<CHAPnonqueueing>>&), &%deliver_drop_privilege%& is forced to be true.
39810
39811
39812
39813
39814 .section "Delivering to local files" "SECID271"
39815 Full details of the checks applied by &(appendfile)& before it writes to a file
39816 are given in chapter &<<CHAPappendfile>>&.
39817
39818
39819
39820 .section "Running local commands" "SECTsecconslocalcmds"
39821 .cindex "security" "local commands"
39822 .cindex "security" "command injection attacks"
39823 There are a number of ways in which an administrator can configure Exim to run
39824 commands based upon received, untrustworthy, data. Further, in some
39825 configurations a user who can control a &_.forward_& file can also arrange to
39826 run commands. Configuration to check includes, but is not limited to:
39827
39828 .ilist
39829 Use of &%use_shell%& in the pipe transport: various forms of shell command
39830 injection may be possible with this option present. It is dangerous and should
39831 be used only with considerable caution. Consider constraints which whitelist
39832 allowed characters in a variable which is to be used in a pipe transport that
39833 has &%use_shell%& enabled.
39834 .next
39835 A number of options such as &%forbid_filter_run%&, &%forbid_filter_perl%&,
39836 &%forbid_filter_dlfunc%& and so forth which restrict facilities available to
39837 &_.forward_& files in a redirect router. If Exim is running on a central mail
39838 hub to which ordinary users do not have shell access, but home directories are
39839 NFS mounted (for instance) then administrators should review the list of these
39840 forbid options available, and should bear in mind that the options that may
39841 need forbidding can change as new features are added between releases.
39842 .next
39843 The &%${run...}%& expansion item does not use a shell by default, but
39844 administrators can configure use of &_/bin/sh_& as part of the command.
39845 Such invocations should be viewed with prejudicial suspicion.
39846 .next
39847 Administrators who use embedded Perl are advised to explore how Perl's
39848 taint checking might apply to their usage.
39849 .next
39850 Use of &%${expand...}%& is somewhat analogous to shell's eval builtin and
39851 administrators are well advised to view its use with suspicion, in case (for
39852 instance) it allows a local-part to contain embedded Exim directives.
39853 .next
39854 Use of &%${match_local_part...}%& and friends becomes more dangerous if
39855 Exim was built with EXPAND_LISTMATCH_RHS defined: the second string in
39856 each can reference arbitrary lists and files, rather than just being a list
39857 of opaque strings.
39858 The EXPAND_LISTMATCH_RHS option was added and set false by default because of
39859 real-world security vulnerabilities caused by its use with untrustworthy data
39860 injected in, for SQL injection attacks.
39861 Consider the use of the &%inlisti%& expansion condition instead.
39862 .endlist
39863
39864
39865
39866
39867 .section "Trust in configuration data" "SECTsecconfdata"
39868 .cindex "security" "data sources"
39869 .cindex "security" "regular expressions"
39870 .cindex "regular expressions" "security"
39871 .cindex "PCRE" "security"
39872 If configuration data for Exim can come from untrustworthy sources, there
39873 are some issues to be aware of:
39874
39875 .ilist
39876 Use of &%${expand...}%& may provide a path for shell injection attacks.
39877 .next
39878 Letting untrusted data provide a regular expression is unwise.
39879 .next
39880 Using &%${match...}%& to apply a fixed regular expression against untrusted
39881 data may result in pathological behaviour within PCRE.  Be aware of what
39882 "backtracking" means and consider options for being more strict with a regular
39883 expression. Avenues to explore include limiting what can match (avoiding &`.`&
39884 when &`[a-z0-9]`& or other character class will do), use of atomic grouping and
39885 possessive quantifiers or just not using regular expressions against untrusted
39886 data.
39887 .next
39888 It can be important to correctly use &%${quote:...}%&,
39889 &%${quote_local_part:...}%& and &%${quote_%&<&'lookup-type'&>&%:...}%& expansion
39890 items to ensure that data is correctly constructed.
39891 .next
39892 Some lookups might return multiple results, even though normal usage is only
39893 expected to yield one result.
39894 .endlist
39895
39896
39897
39898
39899 .section "IPv4 source routing" "SECID272"
39900 .cindex "source routing" "in IP packets"
39901 .cindex "IP source routing"
39902 Many operating systems suppress IP source-routed packets in the kernel, but
39903 some cannot be made to do this, so Exim does its own check. It logs incoming
39904 IPv4 source-routed TCP calls, and then drops them. Things are all different in
39905 IPv6. No special checking is currently done.
39906
39907
39908
39909 .section "The VRFY, EXPN, and ETRN commands in SMTP" "SECID273"
39910 Support for these SMTP commands is disabled by default. If required, they can
39911 be enabled by defining suitable ACLs.
39912
39913
39914
39915
39916 .section "Privileged users" "SECID274"
39917 .cindex "trusted users"
39918 .cindex "admin user"
39919 .cindex "privileged user"
39920 .cindex "user" "trusted"
39921 .cindex "user" "admin"
39922 Exim recognizes two sets of users with special privileges. Trusted users are
39923 able to submit new messages to Exim locally, but supply their own sender
39924 addresses and information about a sending host. For other users submitting
39925 local messages, Exim sets up the sender address from the uid, and doesn't
39926 permit a remote host to be specified.
39927
39928 .oindex "&%-f%&"
39929 However, an untrusted user is permitted to use the &%-f%& command line option
39930 in the special form &%-f <>%& to indicate that a delivery failure for the
39931 message should not cause an error report. This affects the message's envelope,
39932 but it does not affect the &'Sender:'& header. Untrusted users may also be
39933 permitted to use specific forms of address with the &%-f%& option by setting
39934 the &%untrusted_set_sender%& option.
39935
39936 Trusted users are used to run processes that receive mail messages from some
39937 other mail domain and pass them on to Exim for delivery either locally, or over
39938 the Internet. Exim trusts a caller that is running as root, as the Exim user,
39939 as any user listed in the &%trusted_users%& configuration option, or under any
39940 group listed in the &%trusted_groups%& option.
39941
39942 Admin users are permitted to do things to the messages on Exim's queue. They
39943 can freeze or thaw messages, cause them to be returned to their senders, remove
39944 them entirely, or modify them in various ways. In addition, admin users can run
39945 the Exim monitor and see all the information it is capable of providing, which
39946 includes the contents of files on the spool.
39947
39948 .oindex "&%-M%&"
39949 .oindex "&%-q%&"
39950 By default, the use of the &%-M%& and &%-q%& options to cause Exim to attempt
39951 delivery of messages on its queue is restricted to admin users. This
39952 restriction can be relaxed by setting the &%no_prod_requires_admin%& option.
39953 Similarly, the use of &%-bp%& (and its variants) to list the contents of the
39954 queue is also restricted to admin users. This restriction can be relaxed by
39955 setting &%no_queue_list_requires_admin%&.
39956
39957 Exim recognizes an admin user if the calling process is running as root or as
39958 the Exim user or if any of the groups associated with the calling process is
39959 the Exim group. It is not necessary actually to be running under the Exim
39960 group. However, if admin users who are not root or the Exim user are to access
39961 the contents of files on the spool via the Exim monitor (which runs
39962 unprivileged), Exim must be built to allow group read access to its spool
39963 files.
39964
39965 By default, regular users are trusted to perform basic testing and
39966 introspection commands, as themselves.  This setting can be tightened by
39967 setting the &%commandline_checks_require_admin%& option.
39968 This affects most of the checking options,
39969 such as &%-be%& and anything else &%-b*%&.
39970
39971
39972 .section "Spool files" "SECID275"
39973 .cindex "spool directory" "files"
39974 Exim's spool directory and everything it contains is owned by the Exim user and
39975 set to the Exim group. The mode for spool files is defined in the
39976 &_Local/Makefile_& configuration file, and defaults to 0640. This means that
39977 any user who is a member of the Exim group can access these files.
39978
39979
39980
39981 .section "Use of argv[0]" "SECID276"
39982 Exim examines the last component of &%argv[0]%&, and if it matches one of a set
39983 of specific strings, Exim assumes certain options. For example, calling Exim
39984 with the last component of &%argv[0]%& set to &"rsmtp"& is exactly equivalent
39985 to calling it with the option &%-bS%&. There are no security implications in
39986 this.
39987
39988
39989
39990 .section "Use of %f formatting" "SECID277"
39991 The only use made of &"%f"& by Exim is in formatting load average values. These
39992 are actually stored in integer variables as 1000 times the load average.
39993 Consequently, their range is limited and so therefore is the length of the
39994 converted output.
39995
39996
39997
39998 .section "Embedded Exim path" "SECID278"
39999 Exim uses its own path name, which is embedded in the code, only when it needs
40000 to re-exec in order to regain root privilege. Therefore, it is not root when it
40001 does so. If some bug allowed the path to get overwritten, it would lead to an
40002 arbitrary program's being run as exim, not as root.
40003
40004
40005
40006 .section "Dynamic module directory" "SECTdynmoddir"
40007 Any dynamically loadable modules must be installed into the directory
40008 defined in &`LOOKUP_MODULE_DIR`& in &_Local/Makefile_& for Exim to permit
40009 loading it.
40010
40011
40012 .section "Use of sprintf()" "SECID279"
40013 .cindex "&[sprintf()]&"
40014 A large number of occurrences of &"sprintf"& in the code are actually calls to
40015 &'string_sprintf()'&, a function that returns the result in malloc'd store.
40016 The intermediate formatting is done into a large fixed buffer by a function
40017 that runs through the format string itself, and checks the length of each
40018 conversion before performing it, thus preventing buffer overruns.
40019
40020 The remaining uses of &[sprintf()]& happen in controlled circumstances where
40021 the output buffer is known to be sufficiently long to contain the converted
40022 string.
40023
40024
40025
40026 .section "Use of debug_printf() and log_write()" "SECID280"
40027 Arbitrary strings are passed to both these functions, but they do their
40028 formatting by calling the function &'string_vformat()'&, which runs through
40029 the format string itself, and checks the length of each conversion.
40030
40031
40032
40033 .section "Use of strcat() and strcpy()" "SECID281"
40034 These are used only in cases where the output buffer is known to be large
40035 enough to hold the result.
40036 .ecindex IIDsecurcon
40037
40038
40039
40040
40041 . ////////////////////////////////////////////////////////////////////////////
40042 . ////////////////////////////////////////////////////////////////////////////
40043
40044 .chapter "Format of spool files" "CHAPspool"
40045 .scindex IIDforspo1 "format" "spool files"
40046 .scindex IIDforspo2 "spool directory" "format of files"
40047 .scindex IIDforspo3 "spool files" "format of"
40048 .cindex "spool files" "editing"
40049 A message on Exim's queue consists of two files, whose names are the message id
40050 followed by -D and -H, respectively. The data portion of the message is kept in
40051 the -D file on its own. The message's envelope, status, and headers are all
40052 kept in the -H file, whose format is described in this chapter. Each of these
40053 two files contains the final component of its own name as its first line. This
40054 is insurance against disk crashes where the directory is lost but the files
40055 themselves are recoverable.
40056
40057 The file formats may be changed, or new formats added, at any release.
40058 Spool files are not intended as an interface to other programs
40059 and should not be used as such.
40060
40061 Some people are tempted into editing -D files in order to modify messages. You
40062 need to be extremely careful if you do this; it is not recommended and you are
40063 on your own if you do it. Here are some of the pitfalls:
40064
40065 .ilist
40066 You must ensure that Exim does not try to deliver the message while you are
40067 fiddling with it. The safest way is to take out a write lock on the -D file,
40068 which is what Exim itself does, using &[fcntl()]&. If you update the file in
40069 place, the lock will be retained. If you write a new file and rename it, the
40070 lock will be lost at the instant of rename.
40071 .next
40072 .vindex "&$body_linecount$&"
40073 If you change the number of lines in the file, the value of
40074 &$body_linecount$&, which is stored in the -H file, will be incorrect and can
40075 cause incomplete transmission of messages or undeliverable messages.
40076 .next
40077 If the message is in MIME format, you must take care not to break it.
40078 .next
40079 If the message is cryptographically signed, any change will invalidate the
40080 signature.
40081 .endlist
40082 All in all, modifying -D files is fraught with danger.
40083
40084 Files whose names end with -J may also be seen in the &_input_& directory (or
40085 its subdirectories when &%split_spool_directory%& is set). These are journal
40086 files, used to record addresses to which the message has been delivered during
40087 the course of a delivery attempt. If there are still undelivered recipients at
40088 the end, the -H file is updated, and the -J file is deleted. If, however, there
40089 is some kind of crash (for example, a power outage) before this happens, the -J
40090 file remains in existence. When Exim next processes the message, it notices the
40091 -J file and uses it to update the -H file before starting the next delivery
40092 attempt.
40093
40094 Files whose names end with -K or .eml may also be seen in the spool.
40095 These are temporaries used for DKIM or malware processing, when that is used.
40096 They should be tidied up by normal operations; any old ones are probably
40097 relics of crashes and can be removed.
40098
40099 .section "Format of the -H file" "SECID282"
40100 .cindex "uid (user id)" "in spool file"
40101 .cindex "gid (group id)" "in spool file"
40102 The second line of the -H file contains the login name for the uid of the
40103 process that called Exim to read the message, followed by the numerical uid and
40104 gid. For a locally generated message, this is normally the user who sent the
40105 message. For a message received over TCP/IP via the daemon, it is
40106 normally the Exim user.
40107
40108 The third line of the file contains the address of the message's sender as
40109 transmitted in the envelope, contained in angle brackets. The sender address is
40110 empty for bounce messages. For incoming SMTP mail, the sender address is given
40111 in the MAIL command. For locally generated mail, the sender address is
40112 created by Exim from the login name of the current user and the configured
40113 &%qualify_domain%&. However, this can be overridden by the &%-f%& option or a
40114 leading &"From&~"& line if the caller is trusted, or if the supplied address is
40115 &"<>"& or an address that matches &%untrusted_set_senders%&.
40116
40117 The fourth line contains two numbers. The first is the time that the message
40118 was received, in the conventional Unix form &-- the number of seconds since the
40119 start of the epoch. The second number is a count of the number of messages
40120 warning of delayed delivery that have been sent to the sender.
40121
40122 There follow a number of lines starting with a hyphen. These can appear in any
40123 order, and are omitted when not relevant:
40124
40125 .vlist
40126 .vitem "&%-acl%&&~<&'number'&>&~<&'length'&>"
40127 This item is obsolete, and is not generated from Exim release 4.61 onwards;
40128 &%-aclc%& and &%-aclm%& are used instead. However, &%-acl%& is still
40129 recognized, to provide backward compatibility. In the old format, a line of
40130 this form is present for every ACL variable that is not empty. The number
40131 identifies the variable; the &%acl_c%&&*x*& variables are numbered 0&--9 and
40132 the &%acl_m%&&*x*& variables are numbered 10&--19. The length is the length of
40133 the data string for the variable. The string itself starts at the beginning of
40134 the next line, and is followed by a newline character. It may contain internal
40135 newlines.
40136
40137 .vitem "&%-aclc%&&~<&'rest-of-name'&>&~<&'length'&>"
40138 A line of this form is present for every ACL connection variable that is
40139 defined. Note that there is a space between &%-aclc%& and the rest of the name.
40140 The length is the length of the data string for the variable. The string itself
40141 starts at the beginning of the next line, and is followed by a newline
40142 character. It may contain internal newlines.
40143
40144 .vitem "&%-aclm%&&~<&'rest-of-name'&>&~<&'length'&>"
40145 A line of this form is present for every ACL message variable that is defined.
40146 Note that there is a space between &%-aclm%& and the rest of the name. The
40147 length is the length of the data string for the variable. The string itself
40148 starts at the beginning of the next line, and is followed by a newline
40149 character. It may contain internal newlines.
40150
40151 .vitem "&%-active_hostname%&&~<&'hostname'&>"
40152 This is present if, when the message was received over SMTP, the value of
40153 &$smtp_active_hostname$& was different to the value of &$primary_hostname$&.
40154
40155 .vitem &%-allow_unqualified_recipient%&
40156 This is present if unqualified recipient addresses are permitted in header
40157 lines (to stop such addresses from being qualified if rewriting occurs at
40158 transport time). Local messages that were input using &%-bnq%& and remote
40159 messages from hosts that match &%recipient_unqualified_hosts%& set this flag.
40160
40161 .vitem &%-allow_unqualified_sender%&
40162 This is present if unqualified sender addresses are permitted in header lines
40163 (to stop such addresses from being qualified if rewriting occurs at transport
40164 time). Local messages that were input using &%-bnq%& and remote messages from
40165 hosts that match &%sender_unqualified_hosts%& set this flag.
40166
40167 .vitem "&%-auth_id%&&~<&'text'&>"
40168 The id information for a message received on an authenticated SMTP connection
40169 &-- the value of the &$authenticated_id$& variable.
40170
40171 .vitem "&%-auth_sender%&&~<&'address'&>"
40172 The address of an authenticated sender &-- the value of the
40173 &$authenticated_sender$& variable.
40174
40175 .vitem "&%-body_linecount%&&~<&'number'&>"
40176 This records the number of lines in the body of the message, and is
40177 present unless &%-spool_file_wireformat%& is.
40178
40179 .vitem "&%-body_zerocount%&&~<&'number'&>"
40180 This records the number of binary zero bytes in the body of the message, and is
40181 present if the number is greater than zero.
40182
40183 .vitem &%-deliver_firsttime%&
40184 This is written when a new message is first added to the spool. When the spool
40185 file is updated after a deferral, it is omitted.
40186
40187 .vitem "&%-frozen%&&~<&'time'&>"
40188 .cindex "frozen messages" "spool data"
40189 The message is frozen, and the freezing happened at <&'time'&>.
40190
40191 .vitem "&%-helo_name%&&~<&'text'&>"
40192 This records the host name as specified by a remote host in a HELO or EHLO
40193 command.
40194
40195 .vitem "&%-host_address%&&~<&'address'&>.<&'port'&>"
40196 This records the IP address of the host from which the message was received and
40197 the remote port number that was used. It is omitted for locally generated
40198 messages.
40199
40200 .vitem "&%-host_auth%&&~<&'text'&>"
40201 If the message was received on an authenticated SMTP connection, this records
40202 the name of the authenticator &-- the value of the
40203 &$sender_host_authenticated$& variable.
40204
40205 .vitem &%-host_lookup_failed%&
40206 This is present if an attempt to look up the sending host's name from its IP
40207 address failed. It corresponds to the &$host_lookup_failed$& variable.
40208
40209 .vitem "&%-host_name%&&~<&'text'&>"
40210 .cindex "reverse DNS lookup"
40211 .cindex "DNS" "reverse lookup"
40212 This records the name of the remote host from which the message was received,
40213 if the host name was looked up from the IP address when the message was being
40214 received. It is not present if no reverse lookup was done.
40215
40216 .vitem "&%-ident%&&~<&'text'&>"
40217 For locally submitted messages, this records the login of the originating user,
40218 unless it was a trusted user and the &%-oMt%& option was used to specify an
40219 ident value. For messages received over TCP/IP, this records the ident string
40220 supplied by the remote host, if any.
40221
40222 .vitem "&%-interface_address%&&~<&'address'&>.<&'port'&>"
40223 This records the IP address of the local interface and the port number through
40224 which a message was received from a remote host. It is omitted for locally
40225 generated messages.
40226
40227 .vitem &%-local%&
40228 The message is from a local sender.
40229
40230 .vitem &%-localerror%&
40231 The message is a locally-generated bounce message.
40232
40233 .vitem "&%-local_scan%&&~<&'string'&>"
40234 This records the data string that was returned by the &[local_scan()]& function
40235 when the message was received &-- the value of the &$local_scan_data$&
40236 variable. It is omitted if no data was returned.
40237
40238 .vitem &%-manual_thaw%&
40239 The message was frozen but has been thawed manually, that is, by an explicit
40240 Exim command rather than via the auto-thaw process.
40241
40242 .vitem &%-N%&
40243 A testing delivery process was started using the &%-N%& option to suppress any
40244 actual deliveries, but delivery was deferred. At any further delivery attempts,
40245 &%-N%& is assumed.
40246
40247 .vitem &%-received_protocol%&
40248 This records the value of the &$received_protocol$& variable, which contains
40249 the name of the protocol by which the message was received.
40250
40251 .vitem &%-sender_set_untrusted%&
40252 The envelope sender of this message was set by an untrusted local caller (used
40253 to ensure that the caller is displayed in queue listings).
40254
40255 .vitem "&%-spam_score_int%&&~<&'number'&>"
40256 If a message was scanned by SpamAssassin, this is present. It records the value
40257 of &$spam_score_int$&.
40258
40259 .vitem &%-spool_file_wireformat%&
40260 The -D file for this message is in wire-format (for ESMTP CHUNKING)
40261 rather than Unix-format.
40262 The line-ending is CRLF rather than newline.
40263 There is still, however, no leading-dot-stuffing.
40264
40265 .vitem &%-tls_certificate_verified%&
40266 A TLS certificate was received from the client that sent this message, and the
40267 certificate was verified by the server.
40268
40269 .vitem "&%-tls_cipher%&&~<&'cipher name'&>"
40270 When the message was received over an encrypted connection, this records the
40271 name of the cipher suite that was used.
40272
40273 .vitem "&%-tls_peerdn%&&~<&'peer DN'&>"
40274 When the message was received over an encrypted connection, and a certificate
40275 was received from the client, this records the Distinguished Name from that
40276 certificate.
40277 .endlist
40278
40279 Any of the above may have an extra hyphen prepended, to indicate the the
40280 corresponding data is untrusted.
40281
40282 Following the options there is a list of those addresses to which the message
40283 is not to be delivered. This set of addresses is initialized from the command
40284 line when the &%-t%& option is used and &%extract_addresses_remove_arguments%&
40285 is set; otherwise it starts out empty. Whenever a successful delivery is made,
40286 the address is added to this set. The addresses are kept internally as a
40287 balanced binary tree, and it is a representation of that tree which is written
40288 to the spool file. If an address is expanded via an alias or forward file, the
40289 original address is added to the tree when deliveries to all its child
40290 addresses are complete.
40291
40292 If the tree is empty, there is a single line in the spool file containing just
40293 the text &"XX"&. Otherwise, each line consists of two letters, which are either
40294 Y or N, followed by an address. The address is the value for the node of the
40295 tree, and the letters indicate whether the node has a left branch and/or a
40296 right branch attached to it, respectively. If branches exist, they immediately
40297 follow. Here is an example of a three-node tree:
40298 .code
40299 YY darcy@austen.fict.example
40300 NN alice@wonderland.fict.example
40301 NN editor@thesaurus.ref.example
40302 .endd
40303 After the non-recipients tree, there is a list of the message's recipients.
40304 This is a simple list, preceded by a count. It includes all the original
40305 recipients of the message, including those to whom the message has already been
40306 delivered. In the simplest case, the list contains one address per line. For
40307 example:
40308 .code
40309 4
40310 editor@thesaurus.ref.example
40311 darcy@austen.fict.example
40312 rdo@foundation
40313 alice@wonderland.fict.example
40314 .endd
40315 However, when a child address has been added to the top-level addresses as a
40316 result of the use of the &%one_time%& option on a &(redirect)& router, each
40317 line is of the following form:
40318 .display
40319 <&'top-level address'&> <&'errors_to address'&> &&&
40320   <&'length'&>,<&'parent number'&>#<&'flag bits'&>
40321 .endd
40322 The 01 flag bit indicates the presence of the three other fields that follow
40323 the top-level address. Other bits may be used in future to support additional
40324 fields. The <&'parent number'&> is the offset in the recipients list of the
40325 original parent of the &"one time"& address. The first two fields are the
40326 envelope sender that is associated with this address and its length. If the
40327 length is zero, there is no special envelope sender (there are then two space
40328 characters in the line). A non-empty field can arise from a &(redirect)& router
40329 that has an &%errors_to%& setting.
40330
40331
40332 A blank line separates the envelope and status information from the headers
40333 which follow. A header may occupy several lines of the file, and to save effort
40334 when reading it in, each header is preceded by a number and an identifying
40335 character. The number is the number of characters in the header, including any
40336 embedded newlines and the terminating newline. The character is one of the
40337 following:
40338
40339 .table2 50pt
40340 .row <&'blank'&>         "header in which Exim has no special interest"
40341 .row &`B`&               "&'Bcc:'& header"
40342 .row &`C`&               "&'Cc:'& header"
40343 .row &`F`&               "&'From:'& header"
40344 .row &`I`&               "&'Message-id:'& header"
40345 .row &`P`&               "&'Received:'& header &-- P for &""postmark""&"
40346 .row &`R`&               "&'Reply-To:'& header"
40347 .row &`S`&               "&'Sender:'& header"
40348 .row &`T`&               "&'To:'& header"
40349 .row &`*`&               "replaced or deleted header"
40350 .endtable
40351
40352 Deleted or replaced (rewritten) headers remain in the spool file for debugging
40353 purposes. They are not transmitted when the message is delivered. Here is a
40354 typical set of headers:
40355 .code
40356 111P Received: by hobbit.fict.example with local (Exim 4.00)
40357 id 14y9EI-00026G-00; Fri, 11 May 2001 10:28:59 +0100
40358 049  Message-Id: <E14y9EI-00026G-00@hobbit.fict.example>
40359 038* X-rewrote-sender: bb@hobbit.fict.example
40360 042* From: Bilbo Baggins <bb@hobbit.fict.example>
40361 049F From: Bilbo Baggins <B.Baggins@hobbit.fict.example>
40362 099* To: alice@wonderland.fict.example, rdo@foundation,
40363 darcy@austen.fict.example, editor@thesaurus.ref.example
40364 104T To: alice@wonderland.fict.example, rdo@foundation.example,
40365 darcy@austen.fict.example, editor@thesaurus.ref.example
40366 038  Date: Fri, 11 May 2001 10:28:59 +0100
40367 .endd
40368 The asterisked headers indicate that the envelope sender, &'From:'& header, and
40369 &'To:'& header have been rewritten, the last one because routing expanded the
40370 unqualified domain &'foundation'&.
40371 .ecindex IIDforspo1
40372 .ecindex IIDforspo2
40373 .ecindex IIDforspo3
40374
40375 .section "Format of the -D file" "SECID282a"
40376 The data file is traditionally in Unix-standard format: lines are ended with
40377 an ASCII newline character.
40378 However, when the &%spool_wireformat%& main option is used some -D files
40379 can have an alternate format.
40380 This is flagged by a &%-spool_file_wireformat%& line in the corresponding -H file.
40381 The -D file lines (not including the first name-component line) are
40382 suitable for direct copying to the wire when transmitting using the
40383 ESMTP CHUNKING option, meaning lower processing overhead.
40384 Lines are terminated with an ASCII CRLF pair.
40385 There is no dot-stuffing (and no dot-termination).
40386
40387 . ////////////////////////////////////////////////////////////////////////////
40388 . ////////////////////////////////////////////////////////////////////////////
40389
40390 .chapter "DKIM, SPF and DMARC" "CHAPdkim" &&&
40391          "DKIM, SPF and DMARC Support"
40392
40393 .section "DKIM (DomainKeys Identified Mail)" SECDKIM
40394 .cindex "DKIM"
40395
40396 DKIM is a mechanism by which messages sent by some entity can be provably
40397 linked to a domain which that entity controls.  It permits reputation to
40398 be tracked on a per-domain basis, rather than merely upon source IP address.
40399 DKIM is documented in RFC 6376.
40400
40401 As DKIM relies on the message being unchanged in transit, messages handled
40402 by a mailing-list (which traditionally adds to the message) will not match
40403 any original DKIM signature.
40404
40405 DKIM support is compiled into Exim by default if TLS support is present.
40406 It can be disabled by setting DISABLE_DKIM=yes in &_Local/Makefile_&.
40407
40408 Exim's DKIM implementation allows for
40409 .olist
40410 Signing outgoing messages: This function is implemented in the SMTP transport.
40411 It can co-exist with all other Exim features
40412 (including transport filters)
40413 except cutthrough delivery.
40414 .next
40415 Verifying signatures in incoming messages: This is implemented by an additional
40416 ACL (acl_smtp_dkim), which can be called several times per message, with
40417 different signature contexts.
40418 .endlist
40419
40420 In typical Exim style, the verification implementation does not include any
40421 default "policy". Instead it enables you to build your own policy using
40422 Exim's standard controls.
40423
40424 Please note that verification of DKIM signatures in incoming mail is turned
40425 on by default for logging (in the <= line) purposes.
40426
40427 Additional log detail can be enabled using the &%dkim_verbose%& log_selector.
40428 When set, for each signature in incoming email,
40429 exim will log a line displaying the most important signature details, and the
40430 signature status. Here is an example (with line-breaks added for clarity):
40431 .code
40432 2009-09-09 10:22:28 1MlIRf-0003LU-U3 DKIM:
40433     d=facebookmail.com s=q1-2009b
40434     c=relaxed/relaxed a=rsa-sha1
40435     i=@facebookmail.com t=1252484542 [verification succeeded]
40436 .endd
40437
40438 You might want to turn off DKIM verification processing entirely for internal
40439 or relay mail sources. To do that, set the &%dkim_disable_verify%& ACL
40440 control modifier. This should typically be done in the RCPT ACL, at points
40441 where you accept mail from relay sources (internal hosts or authenticated
40442 senders).
40443
40444
40445 .section "Signing outgoing messages" "SECDKIMSIGN"
40446 .cindex "DKIM" "signing"
40447
40448 For signing to be usable you must have published a DKIM record in DNS.
40449 Note that RFC 8301 (which does not cover EC keys) says:
40450 .code
40451 rsa-sha1 MUST NOT be used for signing or verifying.
40452
40453 Signers MUST use RSA keys of at least 1024 bits for all keys.
40454 Signers SHOULD use RSA keys of at least 2048 bits.
40455 .endd
40456
40457 Note also that the key content (the 'p=' field)
40458 in the DNS record is different between RSA and EC keys;
40459 for the former it is the base64 of the ASN.1 for the RSA public key
40460 (equivalent to the private-key .pem with the header/trailer stripped)
40461 but for EC keys it is the base64 of the pure key; no ASN.1 wrapping.
40462
40463 Signing is enabled by setting private options on the SMTP transport.
40464 These options take (expandable) strings as arguments.
40465
40466 .option dkim_domain smtp string list&!! unset
40467 The domain(s) you want to sign with.
40468 After expansion, this can be a list.
40469 Each element in turn,
40470 lowercased,
40471 is put into the &%$dkim_domain%& expansion variable
40472 while expanding the remaining signing options.
40473 If it is empty after expansion, DKIM signing is not done,
40474 and no error will result even if &%dkim_strict%& is set.
40475
40476 .option dkim_selector smtp string list&!! unset
40477 This sets the key selector string.
40478 After expansion, which can use &$dkim_domain$&, this can be a list.
40479 Each element in turn is put in the expansion
40480 variable &%$dkim_selector%& which may be used in the &%dkim_private_key%&
40481 option along with &%$dkim_domain%&.
40482 If the option is empty after expansion, DKIM signing is not done for this domain,
40483 and no error will result even if &%dkim_strict%& is set.
40484
40485 .option dkim_private_key smtp string&!! unset
40486 This sets the private key to use.
40487 You can use the &%$dkim_domain%& and
40488 &%$dkim_selector%& expansion variables to determine the private key to use.
40489 The result can either
40490 .ilist
40491 be a valid RSA private key in ASCII armor (.pem file), including line breaks
40492 .next
40493 with GnuTLS 3.6.0 or OpenSSL 1.1.1 or later,
40494 be a valid Ed25519 private key (same format as above)
40495 .next
40496 start with a slash, in which case it is treated as a file that contains
40497 the private key
40498 .next
40499 be "0", "false" or the empty string, in which case the message will not
40500 be signed. This case will not result in an error, even if &%dkim_strict%&
40501 is set.
40502 .endlist
40503
40504 To generate keys under OpenSSL:
40505 .code
40506 openssl genrsa -out dkim_rsa.private 2048
40507 openssl rsa -in dkim_rsa.private -out /dev/stdout -pubout -outform PEM
40508 .endd
40509 The result file from the first command should be retained, and
40510 this option set to use it.
40511 Take the base-64 lines from the output of the second command, concatenated,
40512 for the DNS TXT record.
40513 See section 3.6 of RFC6376 for the record specification.
40514
40515 Under GnuTLS:
40516 .code
40517 certtool --generate-privkey --rsa --bits=2048 --password='' -8 --outfile=dkim_rsa.private
40518 certtool --load-privkey=dkim_rsa.private --pubkey-info
40519 .endd
40520
40521 Note that RFC 8301 says:
40522 .code
40523 Signers MUST use RSA keys of at least 1024 bits for all keys.
40524 Signers SHOULD use RSA keys of at least 2048 bits.
40525 .endd
40526
40527 EC keys for DKIM are defined by RFC 8463.
40528 They are considerably smaller than RSA keys for equivalent protection.
40529 As they are a recent development, users should consider dual-signing
40530 (by setting a list of selectors, and an expansion for this option)
40531 for some transition period.
40532 The "_CRYPTO_SIGN_ED25519" macro will be defined if support is present
40533 for EC keys.
40534
40535 OpenSSL 1.1.1 and GnuTLS 3.6.0 can create Ed25519 private keys:
40536 .code
40537 openssl genpkey -algorithm ed25519 -out dkim_ed25519.private
40538 certtool --generate-privkey --key-type=ed25519 --outfile=dkim_ed25519.private
40539 .endd
40540
40541 To produce the required public key value for a DNS record:
40542 .code
40543 openssl pkey -outform DER -pubout -in dkim_ed25519.private | tail -c +13 | base64
40544 certtool --load_privkey=dkim_ed25519.private --pubkey_info --outder | tail -c +13 | base64
40545 .endd
40546
40547 Exim also supports an alternate format
40548 of Ed25519 keys in DNS which was a candidate during development
40549 of the standard, but not adopted.
40550 A future release will probably drop that support.
40551
40552 .option dkim_hash smtp string&!! sha256
40553 Can be set to any one of the supported hash methods, which are:
40554 .ilist
40555 &`sha1`& &-- should not be used, is old and insecure
40556 .next
40557 &`sha256`& &-- the default
40558 .next
40559 &`sha512`& &-- possibly more secure but less well supported
40560 .endlist
40561
40562 Note that RFC 8301 says:
40563 .code
40564 rsa-sha1 MUST NOT be used for signing or verifying.
40565 .endd
40566
40567 .option dkim_identity smtp string&!! unset
40568 If set after expansion, the value is used to set an "i=" tag in
40569 the signing header.  The DKIM standards restrict the permissible
40570 syntax of this optional tag to a mail address, with possibly-empty
40571 local part, an @, and a domain identical to or subdomain of the "d="
40572 tag value.  Note that Exim does not check the value.
40573
40574 .option dkim_canon smtp string&!! unset
40575 This option sets the canonicalization method used when signing a message.
40576 The DKIM RFC currently supports two methods: "simple" and "relaxed".
40577 The option defaults to "relaxed" when unset. Note: the current implementation
40578 only supports signing with the same canonicalization method for both headers and body.
40579
40580 .option dkim_strict smtp string&!! unset
40581 This  option  defines  how  Exim  behaves  when  signing a message that
40582 should be signed fails for some reason.  When the expansion evaluates to
40583 either &"1"& or &"true"&, Exim will defer. Otherwise Exim will send the message
40584 unsigned. You can use the &%$dkim_domain%& and &%$dkim_selector%& expansion
40585 variables here.
40586
40587 .option dkim_sign_headers smtp string&!! "see below"
40588 If set, this option must expand to a colon-separated
40589 list of header names.
40590 Headers with these names, or the absence or such a header, will be included
40591 in the message signature.
40592 When unspecified, the header names listed in RFC4871 will be used,
40593 whether or not each header is present in the message.
40594 The default list is available for the expansion in the macro
40595 &"_DKIM_SIGN_HEADERS"&
40596 .new
40597 and an oversigning variant is in &"_DKIM_OVERSIGN_HEADERS"&.
40598 .wen
40599
40600 If a name is repeated, multiple headers by that name (or the absence thereof)
40601 will be signed.  The textually later headers in the headers part of the
40602 message are signed first, if there are multiples.
40603
40604 A name can be prefixed with either an &"="& or a &"+"& character.
40605 If an &"="& prefix is used, all headers that are present with this name
40606 will be signed.
40607 If a &"+"& prefix if used, all headers that are present with this name
40608 will be signed, and one signature added for a missing header with the
40609 name will be appended.
40610
40611 .option dkim_timestamps smtp integer&!! unset
40612 This option controls the inclusion of timestamp information in the signature.
40613 If not set, no such information will be included.
40614 Otherwise, must be an unsigned number giving an offset in seconds from the current time
40615 for the expiry tag
40616 (eg. 1209600 for two weeks);
40617 both creation (t=) and expiry (x=) tags will be included.
40618
40619 RFC 6376 lists these tags as RECOMMENDED.
40620
40621
40622 .section "Verifying DKIM signatures in incoming mail" "SECDKIMVFY"
40623 .cindex "DKIM" "verification"
40624
40625 Verification of DKIM signatures in SMTP incoming email is done for all
40626 messages for which an ACL control &%dkim_disable_verify%& has not been set.
40627 .cindex DKIM "selecting signature algorithms"
40628 Individual classes of signature algorithm can be ignored by changing
40629 the main options &%dkim_verify_hashes%& or &%dkim_verify_keytypes%&.
40630 The &%dkim_verify_minimal%& option can be set to cease verification
40631 processing for a message once the first passing signature is found.
40632
40633 .cindex authentication "expansion item"
40634 Performing verification sets up information used by the
40635 &%authresults%& expansion item.
40636
40637 For most purposes the default option settings suffice and the remainder
40638 of this section can be ignored.
40639
40640 The results of verification are made available to the
40641 &%acl_smtp_dkim%& ACL, which can examine and modify them.
40642 A missing ACL definition defaults to accept.
40643 By default, the ACL is called once for each
40644 syntactically(!) correct signature in the incoming message.
40645 If any ACL call does not accept, the message is not accepted.
40646 If a cutthrough delivery was in progress for the message, that is
40647 summarily dropped (having wasted the transmission effort).
40648
40649 To evaluate the verification result in the ACL
40650 a large number of expansion variables
40651 containing the signature status and its details are set up during the
40652 runtime of the ACL.
40653
40654 Calling the ACL only for existing signatures is not sufficient to build
40655 more advanced policies. For that reason, the main option
40656 &%dkim_verify_signers%&, and an expansion variable
40657 &%$dkim_signers%& exist.
40658
40659 The main option &%dkim_verify_signers%& can be set to a colon-separated
40660 list of DKIM domains or identities for which the ACL &%acl_smtp_dkim%& is
40661 called. It is expanded when the message has been received. At this point,
40662 the expansion variable &%$dkim_signers%& already contains a colon-separated
40663 list of signer domains and identities for the message. When
40664 &%dkim_verify_signers%& is not specified in the main configuration,
40665 it defaults as:
40666 .code
40667 dkim_verify_signers = $dkim_signers
40668 .endd
40669 This leads to the default behaviour of calling &%acl_smtp_dkim%& for each
40670 DKIM signature in the message. Current DKIM verifiers may want to explicitly
40671 call the ACL for known domains or identities. This would be achieved as follows:
40672 .code
40673 dkim_verify_signers = paypal.com:ebay.com:$dkim_signers
40674 .endd
40675 This would result in &%acl_smtp_dkim%& always being called for "paypal.com"
40676 and "ebay.com", plus all domains and identities that have signatures in the message.
40677 You can also be more creative in constructing your policy. For example:
40678 .code
40679 dkim_verify_signers = $sender_address_domain:$dkim_signers
40680 .endd
40681
40682 If a domain or identity is listed several times in the (expanded) value of
40683 &%dkim_verify_signers%&, the ACL is only called once for that domain or identity.
40684
40685 Note that if the option is set using untrustworthy data
40686 (such as the From: header)
40687 care should be taken to force lowercase for domains
40688 and for the domain part if identities.
40689 The default setting can be regarded as trustworthy in this respect.
40690
40691 If multiple signatures match a domain (or identity), the ACL is called once
40692 for each matching signature.
40693
40694
40695 Inside the DKIM ACL, the following expansion variables are
40696 available (from most to least important):
40697
40698
40699 .vlist
40700 .vitem &%$dkim_cur_signer%&
40701 The signer that is being evaluated in this ACL run. This can be a domain or
40702 an identity. This is one of the list items from the expanded main option
40703 &%dkim_verify_signers%& (see above).
40704
40705 .vitem &%$dkim_verify_status%&
40706 Within the DKIM ACL,
40707 a string describing the general status of the signature. One of
40708 .ilist
40709 &%none%&: There is no signature in the message for the current domain or
40710 identity (as reflected by &%$dkim_cur_signer%&).
40711 .next
40712 &%invalid%&: The signature could not be verified due to a processing error.
40713 More detail is available in &%$dkim_verify_reason%&.
40714 .next
40715 &%fail%&: Verification of the signature failed.  More detail is
40716 available in &%$dkim_verify_reason%&.
40717 .next
40718 &%pass%&: The signature passed verification. It is valid.
40719 .endlist
40720
40721 This variable can be overwritten using an ACL 'set' modifier.
40722 This might, for instance, be done to enforce a policy restriction on
40723 hash-method or key-size:
40724 .code
40725   warn condition       = ${if eq {$dkim_verify_status}{pass}}
40726        condition       = ${if eq {${length_3:$dkim_algo}}{rsa}}
40727        condition       = ${if or {{eq {$dkim_algo}{rsa-sha1}} \
40728                                   {< {$dkim_key_length}{1024}}}}
40729        logwrite        = NOTE: forcing DKIM verify fail (was pass)
40730        set dkim_verify_status = fail
40731        set dkim_verify_reason = hash too weak or key too short
40732 .endd
40733
40734 So long as a DKIM ACL is defined (it need do no more than accept),
40735 after all the DKIM ACL runs have completed, the value becomes a
40736 colon-separated list of the values after each run.
40737 This is maintained for the mime, prdr and data ACLs.
40738
40739 .vitem &%$dkim_verify_reason%&
40740 A string giving a little bit more detail when &%$dkim_verify_status%& is either
40741 "fail" or "invalid". One of
40742 .ilist
40743 &%pubkey_unavailable%& (when &%$dkim_verify_status%&="invalid"): The public
40744 key for the domain could not be retrieved. This may be a temporary problem.
40745 .next
40746 &%pubkey_syntax%& (when &%$dkim_verify_status%&="invalid"): The public key
40747 record for the domain is syntactically invalid.
40748 .next
40749 &%bodyhash_mismatch%& (when &%$dkim_verify_status%&="fail"): The calculated
40750 body hash does not match the one specified in the signature header. This
40751 means that the message body was modified in transit.
40752 .next
40753 &%signature_incorrect%& (when &%$dkim_verify_status%&="fail"): The signature
40754 could not be verified. This may mean that headers were modified,
40755 re-written or otherwise changed in a way which is incompatible with
40756 DKIM verification. It may of course also mean that the signature is forged.
40757 .endlist
40758
40759 This variable can be overwritten, with any value, using an ACL 'set' modifier.
40760
40761 .vitem &%$dkim_domain%&
40762 The signing domain. IMPORTANT: This variable is only populated if there is
40763 an actual signature in the message for the current domain or identity (as
40764 reflected by &%$dkim_cur_signer%&).
40765
40766 .vitem &%$dkim_identity%&
40767 The signing identity, if present. IMPORTANT: This variable is only populated
40768 if there is an actual signature in the message for the current domain or
40769 identity (as reflected by &%$dkim_cur_signer%&).
40770
40771 .vitem &%$dkim_selector%&
40772 The key record selector string.
40773
40774 .vitem &%$dkim_algo%&
40775 The algorithm used. One of 'rsa-sha1' or 'rsa-sha256'.
40776 If running under GnuTLS 3.6.0 or OpenSSL 1.1.1 or later,
40777 may also be 'ed25519-sha256'.
40778 The "_CRYPTO_SIGN_ED25519" macro will be defined if support is present
40779 for EC keys.
40780
40781 Note that RFC 8301 says:
40782 .code
40783 rsa-sha1 MUST NOT be used for signing or verifying.
40784
40785 DKIM signatures identified as having been signed with historic
40786 algorithms (currently, rsa-sha1) have permanently failed evaluation
40787 .endd
40788
40789 To enforce this you must either have a DKIM ACL which checks this variable
40790 and overwrites the &$dkim_verify_status$& variable as discussed above,
40791 or have set the main option &%dkim_verify_hashes%& to exclude
40792 processing of such signatures.
40793
40794 .vitem &%$dkim_canon_body%&
40795 The body canonicalization method. One of 'relaxed' or 'simple'.
40796
40797 .vitem &%$dkim_canon_headers%&
40798 The header canonicalization method. One of 'relaxed' or 'simple'.
40799
40800 .vitem &%$dkim_copiedheaders%&
40801 A transcript of headers and their values which are included in the signature
40802 (copied from the 'z=' tag of the signature).
40803 Note that RFC6376 requires that verification fail if the From: header is
40804 not included in the signature.  Exim does not enforce this; sites wishing
40805 strict enforcement should code the check explicitly.
40806
40807 .vitem &%$dkim_bodylength%&
40808 The number of signed body bytes. If zero ("0"), the body is unsigned. If no
40809 limit was set by the signer, "9999999999999" is returned. This makes sure
40810 that this variable always expands to an integer value.
40811 &*Note:*& The presence of the signature tag specifying a signing body length
40812 is one possible route to spoofing of valid DKIM signatures.
40813 A paranoid implementation might wish to regard signature where this variable
40814 shows less than the "no limit" return as being invalid.
40815
40816 .vitem &%$dkim_created%&
40817 UNIX timestamp reflecting the date and time when the signature was created.
40818 When this was not specified by the signer, "0" is returned.
40819
40820 .vitem &%$dkim_expires%&
40821 UNIX timestamp reflecting the date and time when the signer wants the
40822 signature to be treated as "expired". When this was not specified by the
40823 signer, "9999999999999" is returned. This makes it possible to do useful
40824 integer size comparisons against this value.
40825 Note that Exim does not check this value.
40826
40827 .vitem &%$dkim_headernames%&
40828 A colon-separated list of names of headers included in the signature.
40829
40830 .vitem &%$dkim_key_testing%&
40831 "1" if the key record has the "testing" flag set, "0" if not.
40832
40833 .vitem &%$dkim_key_nosubdomains%&
40834 "1" if the key record forbids subdomaining, "0" otherwise.
40835
40836 .vitem &%$dkim_key_srvtype%&
40837 Service type (tag s=) from the key record. Defaults to "*" if not specified
40838 in the key record.
40839
40840 .vitem &%$dkim_key_granularity%&
40841 Key granularity (tag g=) from the key record. Defaults to "*" if not specified
40842 in the key record.
40843
40844 .vitem &%$dkim_key_notes%&
40845 Notes from the key record (tag n=).
40846
40847 .vitem &%$dkim_key_length%&
40848 Number of bits in the key.
40849 .new
40850 Valid only once the key is loaded, which is at the time the header signature
40851 is verified, which is after the body hash is.
40852 .wen
40853
40854 Note that RFC 8301 says:
40855 .code
40856 Verifiers MUST NOT consider signatures using RSA keys of
40857 less than 1024 bits as valid signatures.
40858 .endd
40859
40860 This is enforced by the default setting for the &%dkim_verify_min_keysizes%&
40861 option.
40862
40863 .endlist
40864
40865 In addition, two ACL conditions are provided:
40866
40867 .vlist
40868 .vitem &%dkim_signers%&
40869 ACL condition that checks a colon-separated list of domains or identities
40870 for a match against the domain or identity that the ACL is currently verifying
40871 (reflected by &%$dkim_cur_signer%&). This is typically used to restrict an ACL
40872 verb to a group of domains or identities. For example:
40873
40874 .code
40875 # Warn when Mail purportedly from GMail has no gmail signature
40876 warn sender_domains = gmail.com
40877      dkim_signers = gmail.com
40878      dkim_status = none
40879      log_message = GMail sender without gmail.com DKIM signature
40880 .endd
40881
40882 Note that the above does not check for a total lack of DKIM signing;
40883 for that check for empty &$h_DKIM-Signature:$& in the data ACL.
40884
40885 .vitem &%dkim_status%&
40886 ACL condition that checks a colon-separated list of possible DKIM verification
40887 results against the actual result of verification. This is typically used
40888 to restrict an ACL verb to a list of verification outcomes, for example:
40889
40890 .code
40891 deny sender_domains = paypal.com:paypal.de
40892      dkim_signers = paypal.com:paypal.de
40893      dkim_status = none:invalid:fail
40894      message = Mail from Paypal with invalid/missing signature
40895 .endd
40896
40897 The possible status keywords are: 'none','invalid','fail' and 'pass'. Please
40898 see the documentation of the &%$dkim_verify_status%& expansion variable above
40899 for more information of what they mean.
40900 .endlist
40901
40902
40903
40904
40905 .section "SPF (Sender Policy Framework)" SECSPF
40906 .cindex SPF verification
40907
40908 SPF is a mechanism whereby a domain may assert which IP addresses may transmit
40909 messages with its domain in the envelope from, documented by RFC 7208.
40910 For more information on SPF see &url(http://www.open-spf.org), a static copy of
40911 the &url(http://openspf.org).
40912 . --- 2019-10-28: still not https, open-spf.org is told to be a
40913 . --- web-archive copy of the now dead openspf.org site
40914 . --- See https://www.mail-archive.com/mailop@mailop.org/msg08019.html for a
40915 . --- discussion.
40916
40917 Messages sent by a system not authorised will fail checking of such assertions.
40918 This includes retransmissions done by traditional forwarders.
40919
40920 SPF verification support is built into Exim if SUPPORT_SPF=yes is set in
40921 &_Local/Makefile_&.  The support uses the &_libspf2_& library
40922 &url(https://www.libspf2.org/).
40923 There is no Exim involvement in the transmission of messages;
40924 publishing certain DNS records is all that is required.
40925
40926 For verification, an ACL condition and an expansion lookup are provided.
40927 .cindex authentication "expansion item"
40928 Performing verification sets up information used by the
40929 &%authresults%& expansion item.
40930
40931
40932 .cindex SPF "ACL condition"
40933 .cindex ACL "spf condition"
40934 The ACL condition "spf" can be used at or after the MAIL ACL.
40935 It takes as an argument a list of strings giving the outcome of the SPF check,
40936 and will succeed for any matching outcome.
40937 Valid strings are:
40938 .vlist
40939 .vitem &%pass%&
40940 The SPF check passed, the sending host is positively verified by SPF.
40941
40942 .vitem &%fail%&
40943 The SPF check failed, the sending host is NOT allowed to send mail for the
40944 domain in the envelope-from address.
40945
40946 .vitem &%softfail%&
40947 The SPF check failed, but the queried domain can't absolutely confirm that this
40948 is a forgery.
40949
40950 .vitem &%none%&
40951 The queried domain does not publish SPF records.
40952
40953 .vitem &%neutral%&
40954 The SPF check returned a "neutral" state.  This means the queried domain has
40955 published a SPF record, but wants to allow outside servers to send mail under
40956 its domain as well.  This should be treated like "none".
40957
40958 .vitem &%permerror%&
40959 This indicates a syntax error in the SPF record of the queried domain.
40960 You may deny messages when this occurs.
40961
40962 .vitem &%temperror%&
40963 This indicates a temporary error during all processing, including Exim's
40964 SPF processing.  You may defer messages when this occurs.
40965 .endlist
40966
40967 You can prefix each string with an exclamation mark to  invert
40968 its meaning,  for example  "!fail" will  match all  results but
40969 "fail".  The  string  list is  evaluated  left-to-right,  in a
40970 short-circuit fashion.
40971
40972 Example:
40973 .code
40974 deny spf = fail
40975      message = $sender_host_address is not allowed to send mail from \
40976                ${if def:sender_address_domain \
40977                     {$sender_address_domain}{$sender_helo_name}}.  \
40978                Please see http://www.open-spf.org/Why?scope=\
40979                ${if def:sender_address_domain {mfrom}{helo}};\
40980                identity=${if def:sender_address_domain \
40981                              {$sender_address}{$sender_helo_name}};\
40982                ip=$sender_host_address
40983 .endd
40984
40985 When the spf condition has run, it sets up several expansion
40986 variables:
40987
40988 .cindex SPF "verification variables"
40989 .vlist
40990 .vitem &$spf_header_comment$&
40991 .vindex &$spf_header_comment$&
40992   This contains a human-readable string describing the outcome
40993   of the SPF check. You can add it to a custom header or use
40994   it for logging purposes.
40995
40996 .vitem &$spf_received$&
40997 .vindex &$spf_received$&
40998   This contains a complete Received-SPF: header that can be
40999   added to the message. Please note that according to the SPF
41000   draft, this header must be added at the top of the header
41001   list. Please see section 10 on how you can do this.
41002
41003   Note: in case of "Best-guess" (see below), the convention is
41004   to put this string in a header called X-SPF-Guess: instead.
41005
41006 .vitem &$spf_result$&
41007 .vindex &$spf_result$&
41008   This contains the outcome of the SPF check in string form,
41009   one of pass, fail, softfail, none, neutral, permerror or
41010   temperror.
41011
41012 .vitem &$spf_result_guessed$&
41013 .vindex &$spf_result_guessed$&
41014   This boolean is true only if a best-guess operation was used
41015   and required in order to obtain a result.
41016
41017 .vitem &$spf_smtp_comment$&
41018 .vindex &$spf_smtp_comment$&
41019   This contains a string that can be used in a SMTP response
41020   to the calling party. Useful for "fail".
41021 .endlist
41022
41023
41024 .cindex SPF "ACL condition"
41025 .cindex ACL "spf_guess condition"
41026 .cindex SPF "best guess"
41027 In addition to SPF, you can also perform checks for so-called
41028 "Best-guess".  Strictly speaking, "Best-guess" is not standard
41029 SPF, but it is supported by the same framework that enables SPF
41030 capability.
41031 Refer to &url(http://www.open-spf.org/FAQ/Best_guess_record)
41032 for a description of what it means.
41033 . --- 2019-10-28: still not https:
41034
41035 To access this feature, simply use the spf_guess condition in place
41036 of the spf one.  For example:
41037
41038 .code
41039 deny spf_guess = fail
41040      message = $sender_host_address doesn't look trustworthy to me
41041 .endd
41042
41043 In case you decide to reject messages based on this check, you
41044 should note that although it uses the same framework, "Best-guess"
41045 is not SPF, and therefore you should not mention SPF at all in your
41046 reject message.
41047
41048 When the spf_guess condition has run, it sets up the same expansion
41049 variables as when spf condition is run, described above.
41050
41051 Additionally, since Best-guess is not standardized, you may redefine
41052 what "Best-guess" means to you by redefining the main configuration
41053 &%spf_guess%& option.
41054 For example, the following:
41055
41056 .code
41057 spf_guess = v=spf1 a/16 mx/16 ptr ?all
41058 .endd
41059
41060 would relax host matching rules to a broader network range.
41061
41062
41063 .cindex SPF "lookup expansion"
41064 .cindex lookup spf
41065 A lookup expansion is also available. It takes an email
41066 address as the key and an IP address
41067 (v4 or v6)
41068 as the database:
41069
41070 .code
41071   ${lookup {username@domain} spf {ip.ip.ip.ip}}
41072 .endd
41073
41074 The lookup will return the same result strings as can appear in
41075 &$spf_result$& (pass,fail,softfail,neutral,none,err_perm,err_temp).
41076
41077
41078
41079
41080
41081 .section DMARC SECDMARC
41082 .cindex DMARC verification
41083
41084 DMARC combines feedback from SPF, DKIM, and header From: in order
41085 to attempt to provide better indicators of the authenticity of an
41086 email.  This document does not explain the fundamentals; you
41087 should read and understand how it works by visiting the website at
41088 &url(http://www.dmarc.org/).
41089
41090 If Exim is built with DMARC support,
41091 the libopendmarc library is used.
41092
41093 For building Exim yourself, obtain the library from
41094 &url(http://sourceforge.net/projects/opendmarc/)
41095 to obtain a copy, or find it in your favorite package
41096 repository.  You will need to attend to the local/Makefile feature
41097 SUPPORT_DMARC and the associated LDFLAGS addition.
41098 This description assumes
41099 that headers will be in /usr/local/include, and that the libraries
41100 are in /usr/local/lib.
41101
41102 . subsection
41103
41104 There are three main-configuration options:
41105 .cindex DMARC "configuration options"
41106
41107 The &%dmarc_tld_file%& option
41108 .oindex &%dmarc_tld_file%&
41109 defines the location of a text file of valid
41110 top level domains the opendmarc library uses
41111 during domain parsing. Maintained by Mozilla,
41112 the most current version can be downloaded
41113 from a link at &url(https://publicsuffix.org/list/public_suffix_list.dat).
41114 See also the util/renew-opendmarc-tlds.sh script.
41115 .new
41116 The default for the option is unset.
41117 If not set, DMARC processing is disabled.
41118 .wen
41119
41120
41121 The &%dmarc_history_file%& option, if set
41122 .oindex &%dmarc_history_file%&
41123 defines the location of a file to log results
41124 of dmarc verification on inbound emails. The
41125 contents are importable by the opendmarc tools
41126 which will manage the data, send out DMARC
41127 reports, and expire the data. Make sure the
41128 directory of this file is writable by the user
41129 exim runs as.
41130 The default is unset.
41131
41132 The &%dmarc_forensic_sender%& option
41133 .oindex &%dmarc_forensic_sender%&
41134 defines an alternate email address to use when sending a
41135 forensic report detailing alignment failures
41136 if a sender domain's dmarc record specifies it
41137 and you have configured Exim to send them.
41138 If set, this is expanded and used for the
41139 From: header line; the address is extracted
41140 from it and used for the envelope from.
41141 If not set (the default), the From: header is expanded from
41142 the dsn_from option, and <> is used for the
41143 envelope from.
41144
41145 . I wish we had subsections...
41146
41147 .cindex DMARC controls
41148 By default, the DMARC processing will run for any remote,
41149 non-authenticated user.  It makes sense to only verify DMARC
41150 status of messages coming from remote, untrusted sources.  You can
41151 use standard conditions such as hosts, senders, etc, to decide that
41152 DMARC verification should *not* be performed for them and disable
41153 DMARC with an ACL control modifier:
41154 .code
41155   control = dmarc_disable_verify
41156 .endd
41157 A DMARC record can also specify a "forensic address", which gives
41158 exim an email address to submit reports about failed alignment.
41159 Exim does not do this by default because in certain conditions it
41160 results in unintended information leakage (what lists a user might
41161 be subscribed to, etc).  You must configure exim to submit forensic
41162 reports to the owner of the domain.  If the DMARC record contains a
41163 forensic address and you specify the control statement below, then
41164 exim will send these forensic emails.  It is also advised that you
41165 configure a &%dmarc_forensic_sender%& because the default sender address
41166 construction might be inadequate.
41167 .code
41168   control = dmarc_enable_forensic
41169 .endd
41170 (AGAIN: You can choose not to send these forensic reports by simply
41171 not putting the dmarc_enable_forensic control line at any point in
41172 your exim config.  If you don't tell exim to send them, it will not
41173 send them.)
41174
41175 There are no options to either control.  Both must appear before
41176 the DATA acl.
41177
41178 . subsection
41179
41180 DMARC checks cam be run on incoming SMTP  messages by using the
41181 &"dmarc_status"& ACL condition in the DATA ACL.  You are required to
41182 call the &"spf"& condition first in the ACLs, then the &"dmarc_status"&
41183 condition.  Putting this condition in the ACLs is required in order
41184 for a DMARC check to actually occur.  All of the variables are set
41185 up before the DATA ACL, but there is no actual DMARC check that
41186 occurs until a &"dmarc_status"& condition is encountered in the ACLs.
41187
41188 The &"dmarc_status"& condition takes a list of strings on its
41189 right-hand side.  These strings describe recommended action based
41190 on the DMARC check.  To understand what the policy recommendations
41191 mean, refer to the DMARC website above.  Valid strings are:
41192 .display
41193 &'accept      '& The DMARC check passed and the library recommends accepting the email.
41194 &'reject      '& The DMARC check failed and the library recommends rejecting the email.
41195 &'quarantine  '& The DMARC check failed and the library recommends keeping it for further inspection.
41196 &'none        '& The DMARC check passed and the library recommends no specific action, neutral.
41197 &'norecord    '& No policy section in the DMARC record for this sender domain.
41198 &'nofrom      '& Unable to determine the domain of the sender.
41199 &'temperror   '& Library error or dns error.
41200 &'off         '& The DMARC check was disabled for this email.
41201 .endd
41202 You can prefix each string with an exclamation mark to invert its
41203 meaning, for example "!accept" will match all results but
41204 "accept".  The string list is evaluated left-to-right in a
41205 short-circuit fashion.  When a string matches the outcome of the
41206 DMARC check, the condition succeeds.  If none of the listed
41207 strings matches the outcome of the DMARC check, the condition
41208 fails.
41209
41210 Of course, you can also use any other lookup method that Exim
41211 supports, including LDAP, Postgres, MySQL, etc, as long as the
41212 result is a list of colon-separated strings.
41213
41214 Performing the check sets up information used by the
41215 &%authresults%& expansion item.
41216
41217 Several expansion variables are set before the DATA ACL is
41218 processed, and you can use them in this ACL.  The following
41219 expansion variables are available:
41220
41221 .vlist
41222 .vitem &$dmarc_status$&
41223 .vindex &$dmarc_status$&
41224 .cindex DMARC result
41225 A one word status indicating what the DMARC library
41226 thinks of the email.  It is a combination of the results of
41227 DMARC record lookup and the SPF/DKIM/DMARC processing results
41228 (if a DMARC record was found).  The actual policy declared
41229 in the DMARC record is in a separate expansion variable.
41230
41231 .vitem &$dmarc_status_text$&
41232 .vindex &$dmarc_status_text$&
41233 Slightly longer, human readable status.
41234
41235 .vitem &$dmarc_used_domain$&
41236 .vindex &$dmarc_used_domain$&
41237 The domain which DMARC used to look up the DMARC policy record.
41238
41239 .vitem &$dmarc_domain_policy$&
41240 .vindex &$dmarc_domain_policy$&
41241 The policy declared in the DMARC record.  Valid values
41242 are "none", "reject" and "quarantine".  It is blank when there
41243 is any error, including no DMARC record.
41244 .endlist
41245
41246 . subsection
41247
41248 By default, Exim's DMARC configuration is intended to be
41249 non-intrusive and conservative.  To facilitate this, Exim will not
41250 create any type of logging files without explicit configuration by
41251 you, the admin.  Nor will Exim send out any emails/reports about
41252 DMARC issues without explicit configuration by you, the admin (other
41253 than typical bounce messages that may come about due to ACL
41254 processing or failure delivery issues).
41255
41256 In order to log statistics suitable to be imported by the opendmarc
41257 tools, you need to:
41258 .ilist
41259 Configure the global option &%dmarc_history_file%&
41260 .next
41261 Configure cron jobs to call the appropriate opendmarc history
41262 import scripts and truncating the dmarc_history_file
41263 .endlist
41264
41265 In order to send forensic reports, you need to:
41266 .ilist
41267 Configure the global option &%dmarc_forensic_sender%&
41268 .next
41269 Configure, somewhere before the DATA ACL, the control option to
41270 enable sending DMARC forensic reports
41271 .endlist
41272
41273 . subsection
41274
41275 Example usage:
41276 .code
41277 (RCPT ACL)
41278   warn    domains        = +local_domains
41279           hosts          = +local_hosts
41280           control        = dmarc_disable_verify
41281
41282   warn    !domains       = +screwed_up_dmarc_records
41283           control        = dmarc_enable_forensic
41284
41285   warn    condition      = (lookup if destined to mailing list)
41286           set acl_m_mailing_list = 1
41287
41288 (DATA ACL)
41289   warn    dmarc_status   = accept : none : off
41290           !authenticated = *
41291           log_message    = DMARC DEBUG: $dmarc_status $dmarc_used_domain
41292
41293   warn    dmarc_status   = !accept
41294           !authenticated = *
41295           log_message    = DMARC DEBUG: '$dmarc_status' for $dmarc_used_domain
41296
41297   warn    dmarc_status   = quarantine
41298           !authenticated = *
41299           set $acl_m_quarantine = 1
41300           # Do something in a transport with this flag variable
41301
41302   deny    condition      = ${if eq{$dmarc_domain_policy}{reject}}
41303           condition      = ${if eq{$acl_m_mailing_list}{1}}
41304           message        = Messages from $dmarc_used_domain break mailing lists
41305
41306   deny    dmarc_status   = reject
41307           !authenticated = *
41308           message        = Message from $dmarc_used_domain failed sender's DMARC policy, REJECT
41309
41310   warn    add_header     = :at_start:${authresults {$primary_hostname}}
41311 .endd
41312
41313
41314
41315
41316
41317 . ////////////////////////////////////////////////////////////////////////////
41318 . ////////////////////////////////////////////////////////////////////////////
41319
41320 .chapter "Proxies" "CHAPproxies" &&&
41321          "Proxy support"
41322 .cindex "proxy support"
41323 .cindex "proxy" "access via"
41324
41325 A proxy is an intermediate system through which communication is passed.
41326 Proxies may provide a security, availability or load-distribution function.
41327
41328
41329 .section "Inbound proxies" SECTproxyInbound
41330 .cindex proxy inbound
41331 .cindex proxy "server side"
41332 .cindex proxy "Proxy protocol"
41333 .cindex "Proxy protocol" proxy
41334
41335 Exim has support for receiving inbound SMTP connections via a proxy
41336 that uses &"Proxy Protocol"& to speak to it.
41337 To include this support, include &"SUPPORT_PROXY=yes"&
41338 in Local/Makefile.
41339
41340 It was built on the HAProxy specification, found at
41341 &url(https://www.haproxy.org/download/1.8/doc/proxy-protocol.txt).
41342
41343 The purpose of this facility is so that an application load balancer,
41344 such as HAProxy, can sit in front of several Exim servers
41345 to distribute load.
41346 Exim uses the local protocol communication with the proxy to obtain
41347 the remote SMTP system IP address and port information.
41348 There is no logging if a host passes or
41349 fails Proxy Protocol negotiation, but it can easily be determined and
41350 recorded in an ACL (example is below).
41351
41352 Use of a proxy is enabled by setting the &%hosts_proxy%&
41353 main configuration option to a hostlist; connections from these
41354 hosts will use Proxy Protocol.
41355 Exim supports both version 1 and version 2 of the Proxy Protocol and
41356 automatically determines which version is in use.
41357
41358 The Proxy Protocol header is the first data received on a TCP connection
41359 and is inserted before any TLS-on-connect handshake from the client; Exim
41360 negotiates TLS between Exim-as-server and the remote client, not between
41361 Exim and the proxy server.
41362
41363 The following expansion variables are usable
41364 (&"internal"& and &"external"& here refer to the interfaces
41365 of the proxy):
41366 .display
41367 &'proxy_external_address   '& IP of host being proxied or IP of remote interface of proxy
41368 &'proxy_external_port      '& Port of host being proxied or Port on remote interface of proxy
41369 &'proxy_local_address      '& IP of proxy server inbound or IP of local interface of proxy
41370 &'proxy_local_port         '& Port of proxy server inbound or Port on local interface of proxy
41371 &'proxy_session            '& boolean: SMTP connection via proxy
41372 .endd
41373 If &$proxy_session$& is set but &$proxy_external_address$& is empty
41374 there was a protocol error.
41375 The variables &$sender_host_address$& and &$sender_host_port$&
41376 will have values for the actual client system, not the proxy.
41377
41378 Since the real connections are all coming from the proxy, and the
41379 per host connection tracking is done before Proxy Protocol is
41380 evaluated, &%smtp_accept_max_per_host%& must be set high enough to
41381 handle all of the parallel volume you expect per inbound proxy.
41382 With the option set so high, you lose the ability
41383 to protect your server from many connections from one IP.
41384 In order to prevent your server from overload, you
41385 need to add a per connection ratelimit to your connect ACL.
41386 A possible solution is:
41387 .display
41388   # Set max number of connections per host
41389   LIMIT   = 5
41390   # Or do some kind of IP lookup in a flat file or database
41391   # LIMIT = ${lookup{$sender_host_address}iplsearch{/etc/exim/proxy_limits}}
41392
41393   defer   ratelimit      = LIMIT / 5s / per_conn / strict
41394           message        = Too many connections from this IP right now
41395 .endd
41396
41397
41398
41399 .section "Outbound proxies" SECTproxySOCKS
41400 .cindex proxy outbound
41401 .cindex proxy "client side"
41402 .cindex proxy SOCKS
41403 .cindex SOCKS proxy
41404 Exim has support for sending outbound SMTP via a proxy
41405 using a protocol called SOCKS5 (defined by RFC1928).
41406 The support can be optionally included by defining SUPPORT_SOCKS=yes in
41407 Local/Makefile.
41408
41409 Use of a proxy is enabled by setting the &%socks_proxy%& option
41410 on an smtp transport.
41411 The option value is expanded and should then be a list
41412 (colon-separated by default) of proxy specifiers.
41413 Each proxy specifier is a list
41414 (space-separated by default) where the initial element
41415 is an IP address and any subsequent elements are options.
41416
41417 Options are a string <name>=<value>.
41418 The list of options is in the following table:
41419 .display
41420 &'auth   '& authentication method
41421 &'name   '& authentication username
41422 &'pass   '& authentication password
41423 &'port   '& tcp port
41424 &'tmo    '& connection timeout
41425 &'pri    '& priority
41426 &'weight '& selection bias
41427 .endd
41428
41429 More details on each of these options follows:
41430
41431 .ilist
41432 .cindex authentication "to proxy"
41433 .cindex proxy authentication
41434 &%auth%&: Either &"none"& (default) or &"name"&.
41435 Using &"name"& selects username/password authentication per RFC 1929
41436 for access to the proxy.
41437 Default is &"none"&.
41438 .next
41439 &%name%&: sets the username for the &"name"& authentication method.
41440 Default is empty.
41441 .next
41442 &%pass%&: sets the password for the &"name"& authentication method.
41443 Default is empty.
41444 .next
41445 &%port%&: the TCP port number to use for the connection to the proxy.
41446 Default is 1080.
41447 .next
41448 &%tmo%&: sets a connection timeout in seconds for this proxy.
41449 Default is 5.
41450 .next
41451 &%pri%&: specifies a priority for the proxy within the list,
41452 higher values being tried first.
41453 The default priority is 1.
41454 .next
41455 &%weight%&: specifies a selection bias.
41456 Within a priority set servers are queried in a random fashion,
41457 weighted by this value.
41458 The default value for selection bias is 1.
41459 .endlist
41460
41461 Proxies from the list are tried according to their priority
41462 and weight settings until one responds.  The timeout for the
41463 overall connection applies to the set of proxied attempts.
41464
41465 .section Logging SECTproxyLog
41466 To log the (local) IP of a proxy in the incoming or delivery logline,
41467 add &"+proxy"& to the &%log_selector%& option.
41468 This will add a component tagged with &"PRX="& to the line.
41469
41470 . ////////////////////////////////////////////////////////////////////////////
41471 . ////////////////////////////////////////////////////////////////////////////
41472
41473 .chapter "Internationalisation" "CHAPi18n" &&&
41474          "Internationalisation""
41475 .cindex internationalisation "email address"
41476 .cindex EAI
41477 .cindex i18n
41478 .cindex utf8 "mail name handling"
41479
41480 Exim has support for Internationalised mail names.
41481 To include this it must be built with SUPPORT_I18N and the libidn library.
41482 Standards supported are RFCs 2060, 5890, 6530 and 6533.
41483
41484 If Exim is built with SUPPORT_I18N_2008 (in addition to SUPPORT_I18N, not
41485 instead of it) then IDNA2008 is supported; this adds an extra library
41486 requirement, upon libidn2.
41487
41488 .section "MTA operations" SECTi18nMTA
41489 .cindex SMTPUTF8 "ESMTP option"
41490 .cindex "ESMTP extensions" SMTPUTF8
41491 The main configuration option &%smtputf8_advertise_hosts%& specifies
41492 a host list.  If this matches the sending host and
41493 accept_8bitmime is true (the default) then the ESMTP option
41494 SMTPUTF8 will be advertised.
41495
41496 If the sender specifies the SMTPUTF8 option on a MAIL command
41497 international handling for the message is enabled and
41498 the expansion variable &$message_smtputf8$& will have value TRUE.
41499
41500 The option &%allow_utf8_domains%& is set to true for this
41501 message. All DNS lookups are converted to a-label form
41502 whatever the setting of &%allow_utf8_domains%&
41503 when Exim is built with SUPPORT_I18N.
41504
41505 Both localparts and domain are maintained as the original
41506 UTF-8 form internally; any comparison or regular-expression use will
41507 require appropriate care.  Filenames created, eg. by
41508 the appendfile transport, will have UTF-8 names.
41509
41510 HELO names sent by the smtp transport will have any UTF-8
41511 components expanded to a-label form,
41512 and any certificate name checks will be done using the a-label
41513 form of the name.
41514
41515 .cindex log protocol
41516 .cindex SMTPUTF8 logging
41517 .cindex i18n logging
41518 Log lines and Received-by: header lines will acquire a "utf8"
41519 prefix on the protocol element, eg. utf8esmtp.
41520
41521 The following expansion operators can be used:
41522 .code
41523 ${utf8_domain_to_alabel:str}
41524 ${utf8_domain_from_alabel:str}
41525 ${utf8_localpart_to_alabel:str}
41526 ${utf8_localpart_from_alabel:str}
41527 .endd
41528
41529 .cindex utf8 "address downconversion"
41530 .cindex i18n "utf8 address downconversion"
41531 The RCPT ACL
41532 may use the following modifier:
41533 .display
41534 control = utf8_downconvert
41535 control = utf8_downconvert/<value>
41536 .endd
41537 This sets a flag requiring that envelope addresses are converted to
41538 a-label form before smtp delivery.
41539 This is usually for use in a Message Submission Agent context,
41540 but could be used for any message.
41541
41542 If a value is appended it may be:
41543 .display
41544 &`1  `& mandatory downconversion
41545 &`0  `& no downconversion
41546 &`-1 `& if SMTPUTF8 not supported by destination host
41547 .endd
41548 If no value is given, 1 is used.
41549
41550 If mua_wrapper is set, the utf8_downconvert control
41551 is initially set to -1.
41552
41553 The smtp transport has an option &%utf8_downconvert%&.
41554 If set it must expand to one of the three values described above,
41555 or an empty string.
41556 If non-empty it overrides value previously set
41557 (due to mua_wrapper or by an ACL control).
41558
41559
41560 There is no explicit support for VRFY and EXPN.
41561 Configurations supporting these should inspect
41562 &$smtp_command_argument$& for an SMTPUTF8 argument.
41563
41564 There is no support for LMTP on Unix sockets.
41565 Using the "lmtp" protocol option on an smtp transport,
41566 for LMTP over TCP, should work as expected.
41567
41568 There is no support for DSN unitext handling,
41569 and no provision for converting logging from or to UTF-8.
41570
41571
41572
41573 .section "MDA operations" SECTi18nMDA
41574 To aid in constructing names suitable for IMAP folders
41575 the following expansion operator can be used:
41576 .code
41577 ${imapfolder {<string>} {<sep>} {<specials>}}
41578 .endd
41579
41580 The string is converted from the charset specified by
41581 the "headers charset" command (in a filter file)
41582 or &%headers_charset%& main configuration option (otherwise),
41583 to the
41584 modified UTF-7 encoding specified by RFC 2060,
41585 with the following exception: All occurrences of <sep>
41586 (which has to be a single character)
41587 are replaced with periods ("."), and all periods and slashes that are not
41588 <sep> and are not in the <specials> string are BASE64 encoded.
41589
41590 The third argument can be omitted, defaulting to an empty string.
41591 The second argument can be omitted, defaulting to "/".
41592
41593 This is the encoding used by Courier for Maildir names on disk, and followed
41594 by many other IMAP servers.
41595
41596 Examples:
41597 .display
41598 &`${imapfolder {Foo/Bar}}       `& yields &`Foo.Bar`&
41599 &`${imapfolder {Foo/Bar}{.}{/}} `& yields &`Foo&&AC8-Bar`&
41600 &`${imapfolder {Räksmörgås}}    `& yields &`R&&AOQ-ksm&&APY-rg&&AOU-s`&
41601 .endd
41602
41603 Note that the source charset setting is vital, and also that characters
41604 must be representable in UTF-16.
41605
41606
41607 . ////////////////////////////////////////////////////////////////////////////
41608 . ////////////////////////////////////////////////////////////////////////////
41609
41610 .chapter "Events" "CHAPevents" &&&
41611          "Events"
41612 .cindex events
41613
41614 The events mechanism in Exim can be used to intercept processing at a number
41615 of points.  It was originally invented to give a way to do customised logging
41616 actions (for example, to a database) but can also be used to modify some
41617 processing actions.
41618
41619 Most installations will never need to use Events.
41620 The support can be left out of a build by defining DISABLE_EVENT=yes
41621 in &_Local/Makefile_&.
41622
41623 There are two major classes of events: main and transport.
41624 The main configuration option &%event_action%& controls reception events;
41625 a transport option &%event_action%& controls delivery events.
41626
41627 Both options are a string which is expanded when the event fires.
41628 An example might look like:
41629 .cindex logging custom
41630 .code
41631 event_action = ${if eq {msg:delivery}{$event_name} \
41632 {${lookup pgsql {SELECT * FROM record_Delivery( \
41633     '${quote_pgsql:$sender_address_domain}',\
41634     '${quote_pgsql:${lc:$sender_address_local_part}}', \
41635     '${quote_pgsql:$domain}', \
41636     '${quote_pgsql:${lc:$local_part}}', \
41637     '${quote_pgsql:$host_address}', \
41638     '${quote_pgsql:${lc:$host}}', \
41639     '${quote_pgsql:$message_exim_id}')}} \
41640 } {}}
41641 .endd
41642
41643 Events have names which correspond to the point in process at which they fire.
41644 The name is placed in the variable &$event_name$& and the event action
41645 expansion must check this, as it will be called for every possible event type.
41646
41647 .new
41648 The current list of events is:
41649 .wen
41650 .display
41651 &`dane:fail              after    transport  `& per connection
41652 &`msg:complete           after    main       `& per message
41653 &`msg:defer              after    transport  `& per message per delivery try
41654 &`msg:delivery           after    transport  `& per recipient
41655 &`msg:rcpt:host:defer    after    transport  `& per recipient per host
41656 &`msg:rcpt:defer         after    transport  `& per recipient
41657 &`msg:host:defer         after    transport  `& per host per delivery try; host errors
41658 &`msg:fail:delivery      after    transport  `& per recipient
41659 &`msg:fail:internal      after    main       `& per recipient
41660 &`tcp:connect            before   transport  `& per connection
41661 &`tcp:close              after    transport  `& per connection
41662 &`tls:cert               before   both       `& per certificate in verification chain
41663 &`smtp:connect           after    transport  `& per connection
41664 &`smtp:ehlo              after    transport  `& per connection
41665 .endd
41666 New event types may be added in future.
41667
41668 The event name is a colon-separated list, defining the type of
41669 event in a tree of possibilities.  It may be used as a list
41670 or just matched on as a whole.  There will be no spaces in the name.
41671
41672 The second column in the table above describes whether the event fires
41673 before or after the action is associates with.  Those which fire before
41674 can be used to affect that action (more on this below).
41675
41676 The third column in the table above says what section of the configuration
41677 should define the event action.
41678
41679 An additional variable, &$event_data$&, is filled with information varying
41680 with the event type:
41681 .display
41682 &`dane:fail            `& failure reason
41683 &`msg:defer            `& error string
41684 &`msg:delivery         `& smtp confirmation message
41685 &`msg:fail:internal    `& failure reason
41686 &`msg:fail:delivery    `& smtp error message
41687 &`msg:host:defer       `& error string
41688 &`msg:rcpt:host:defer  `& error string
41689 &`msg:rcpt:defer       `& error string
41690 &`tls:cert             `& verification chain depth
41691 &`smtp:connect         `& smtp banner
41692 &`smtp:ehlo            `& smtp ehlo response
41693 .endd
41694
41695 The :defer events populate one extra variable: &$event_defer_errno$&.
41696
41697 For complex operations an ACL expansion can be used in &%event_action%&
41698 however due to the multiple contexts that Exim operates in during
41699 the course of its processing:
41700 .ilist
41701 variables set in transport events will not be visible outside that
41702 transport call
41703 .next
41704 acl_m variables in a server context are lost on a new connection,
41705 and after smtp helo/ehlo/mail/starttls/rset commands
41706 .endlist
41707 Using an ACL expansion with the logwrite modifier can be
41708 a useful way of writing to the main log.
41709
41710 The expansion of the event_action option should normally
41711 return an empty string.  Should it return anything else the
41712 following will be forced:
41713 .display
41714 &`tcp:connect      `&  do not connect
41715 &`tls:cert         `&  refuse verification
41716 &`smtp:connect     `&  close connection
41717 .endd
41718 All other message types ignore the result string, and
41719 no other use is made of it.
41720
41721 For a tcp:connect event, if the connection is being made to a proxy
41722 then the address and port variables will be that of the proxy and not
41723 the target system.
41724
41725 For tls:cert events, if GnuTLS is in use this will trigger only per
41726 chain element received on the connection.
41727 For OpenSSL it will trigger for every chain element including those
41728 loaded locally.
41729
41730 . ////////////////////////////////////////////////////////////////////////////
41731 . ////////////////////////////////////////////////////////////////////////////
41732
41733 .chapter "Adding new drivers or lookup types" "CHID13" &&&
41734          "Adding drivers or lookups"
41735 .cindex "adding drivers"
41736 .cindex "new drivers, adding"
41737 .cindex "drivers" "adding new"
41738 The following actions have to be taken in order to add a new router, transport,
41739 authenticator, or lookup type to Exim:
41740
41741 .olist
41742 Choose a name for the driver or lookup type that does not conflict with any
41743 existing name; I will use &"newdriver"& in what follows.
41744 .next
41745 Add to &_src/EDITME_& the line:
41746 .display
41747 <&'type'&>&`_NEWDRIVER=yes`&
41748 .endd
41749 where <&'type'&> is ROUTER, TRANSPORT, AUTH, or LOOKUP. If the
41750 code is not to be included in the binary by default, comment this line out. You
41751 should also add any relevant comments about the driver or lookup type.
41752 .next
41753 Add to &_src/config.h.defaults_& the line:
41754 .code
41755 #define <type>_NEWDRIVER
41756 .endd
41757 .next
41758 Edit &_src/drtables.c_&, adding conditional code to pull in the private header
41759 and create a table entry as is done for all the other drivers and lookup types.
41760 .next
41761 Edit &_scripts/lookups-Makefile_& if this is a new lookup; there is a for-loop
41762 near the bottom, ranging the &`name_mod`& variable over a list of all lookups.
41763 Add your &`NEWDRIVER`& to that list.
41764 As long as the dynamic module would be named &_newdriver.so_&, you can use the
41765 simple form that most lookups have.
41766 .next
41767 Edit &_Makefile_& in the appropriate sub-directory (&_src/routers_&,
41768 &_src/transports_&, &_src/auths_&, or &_src/lookups_&); add a line for the new
41769 driver or lookup type and add it to the definition of OBJ.
41770 .next
41771 Edit &_OS/Makefile-Base_& adding a &_.o_& file for the predefined-macros, to the
41772 definition of OBJ_MACRO.  Add a set of line to do the compile also.
41773 .next
41774 Create &_newdriver.h_& and &_newdriver.c_& in the appropriate sub-directory of
41775 &_src_&.
41776 .next
41777 Edit &_scripts/MakeLinks_& and add commands to link the &_.h_& and &_.c_& files
41778 as for other drivers and lookups.
41779 .endlist
41780
41781 Then all you need to do is write the code! A good way to start is to make a
41782 proforma by copying an existing module of the same type, globally changing all
41783 occurrences of the name, and cutting out most of the code. Note that any
41784 options you create must be listed in alphabetical order, because the tables are
41785 searched using a binary chop procedure.
41786
41787 There is a &_README_& file in each of the sub-directories of &_src_& describing
41788 the interface that is expected.
41789
41790
41791
41792
41793 . ////////////////////////////////////////////////////////////////////////////
41794 . ////////////////////////////////////////////////////////////////////////////
41795
41796 . /////////////////////////////////////////////////////////////////////////////
41797 . These lines are processing instructions for the Simple DocBook Processor that
41798 . Philip Hazel has developed as a less cumbersome way of making PostScript and
41799 . PDFs than using xmlto and fop. They will be ignored by all other XML
41800 . processors.
41801 . /////////////////////////////////////////////////////////////////////////////
41802
41803 .literal xml
41804 <?sdop
41805   format="newpage"
41806   foot_right_recto="&chaptertitle;"
41807   foot_right_verso="&chaptertitle;"
41808 ?>
41809 .literal off
41810
41811 .makeindex "Options index"   "option"
41812 .makeindex "Variables index" "variable"
41813 .makeindex "Concept index"   "concept"
41814
41815
41816 . /////////////////////////////////////////////////////////////////////////////
41817 . /////////////////////////////////////////////////////////////////////////////